gmacd.h

Go to the documentation of this file.

/* ---------------------------------------------------------------------------- */
/*                  Atmel Microcontroller Software Support                      */
/*                       SAM Software Package License                           */
/* ---------------------------------------------------------------------------- */
/* Copyright (c) 2015, Atmel Corporation                                        */
/*                                                                              */
/* All rights reserved.                                                         */
/*                                                                              */
/* Redistribution and use in source and binary forms, with or without           */
/* modification, are permitted provided that the following condition is met:    */
/*                                                                              */
/* - Redistributions of source code must retain the above copyright notice,     */
/* this list of conditions and the disclaimer below.                            */
/*                                                                              */
/* Atmel's name may not be used to endorse or promote products derived from     */
/* this software without specific prior written permission.                     */
/*                                                                              */
/* DISCLAIMER:  THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR   */
/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE   */
/* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,      */
/* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
/* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,  */
/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    */
/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING         */
/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
/* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                           */
/* ---------------------------------------------------------------------------- */

#ifndef _GMACD_H_
#define _GMACD_H_

/*---------------------------------------------------------------------------
 *         Headers
 *---------------------------------------------------------------------------*/

#include "chip.h"


/*---------------------------------------------------------------------------
 *         Definitions
 *---------------------------------------------------------------------------*/
#define GMACD_OK                0   
#define GMACD_TX_BUSY           1   
#define GMACD_RX_NULL           1   
#define GMACD_SIZE_TOO_SMALL    2

#define GMACD_PARAM             3

#define GMACD_NOT_INITIALIZED   4

/* Should be a power of 2.
   - Buffer Length to store the timestamps of 1588 event messages
*/
#define EFRS_BUFFER_LEN (1u)

/*---------------------------------------------------------------------------
*             Types
*---------------------------------------------------------------------------*/
typedef enum ptpMsgType_t {
    SYNC_MSG_TYPE = 0,
    DELAY_REQ_MSG_TYPE = 1,
    PDELAY_REQ_TYPE = 2,
    PDELAY_RESP_TYPE = 3,
    FOLLOW_UP_MSG_TYPE = 8,
    DELAY_RESP_MSG_TYPE = 9
} ptpMsgType;



typedef void (*fGmacdTransferCallback)(uint32_t status);
typedef void (*fGmacdWakeupCallback)(void);
typedef void (*fGmacdTxPtpEvtCallBack) (ptpMsgType msg, uint32_t sec, \
                                        uint32_t nanosec, uint16_t seqId);

typedef struct _GmacSG {
    uint32_t size;
    void *pBuffer;
} sGmacSG;

typedef struct _GmacSGList {
    uint32_t len;
    sGmacSG  *sg;
} sGmacSGList;

typedef struct _GmacQueueDriver {
    uint8_t *pTxBuffer;
    uint8_t *pRxBuffer;

    sGmacRxDescriptor *pRxD;
    sGmacTxDescriptor *pTxD;

    fGmacdTransferCallback fRxCb;
    fGmacdWakeupCallback fWakupCb;
    fGmacdTransferCallback *fTxCbList;

    fGmacdTxPtpEvtCallBack fTxPtpEvtCb;

    uint16_t wRxListSize;
    uint16_t wRxI;

    uint16_t wTxListSize;
    uint16_t wTxHead;
    uint16_t wTxTail;

    uint8_t  bWakeupThreshold;

    uint16_t wTxBufferSize;
    uint16_t wRxBufferSize;

} sGmacQd;

typedef struct _GmacDriver {

    Gmac        *pHw;
    uint8_t bId;
    sGmacQd     queueList[NUM_GMAC_QUEUES];
} sGmacd;

typedef struct _GmacInit {
    uint32_t bIsGem: 1;
    uint32_t reserved: 31;

    uint8_t bDmaBurstLength;

    uint8_t *pRxBuffer;
    sGmacRxDescriptor *pRxD;
    uint16_t wRxBufferSize;     
    uint16_t wRxSize;           
    uint8_t *pTxBuffer;
    sGmacTxDescriptor *pTxD;
    uint16_t wTxBufferSize;
    uint16_t wTxSize;

    fGmacdTransferCallback *pTxCb;      
} sGmacInit;
/*---------------------------------------------------------------------------
 *         GMAC Exported functions
 *---------------------------------------------------------------------------*/

extern void GMACD_Handler(sGmacd *pGmacd , gmacQueList_t queIdx);

extern void GMACD_Init(sGmacd *pGmacd,
                       Gmac *pHw,
                       uint8_t bID,
                       uint8_t enableCAF,
                       uint8_t enableNBC);

extern uint8_t GMACD_InitTransfer(sGmacd *pGmacd,
                                  const sGmacInit *pInit, gmacQueList_t queIdx);

extern void GMACD_Reset(sGmacd *pGmacd);

extern uint8_t GMACD_SendSG(sGmacd *pGmacd,
                            const sGmacSGList *sgl,
                            fGmacdTransferCallback fTxCb,
                            gmacQueList_t queIdx);

extern uint8_t GMACD_Send(sGmacd *pGmacd,
                          void *pBuffer,
                          uint32_t size,
                          fGmacdTransferCallback fTxCb,
                          gmacQueList_t queIdx);

extern  uint32_t GMACD_TxLoad(sGmacd *pGmacd, gmacQueList_t queIdx);

extern  uint8_t GMACD_Poll(sGmacd *pGmacd,
                           uint8_t *pFrame,
                           uint32_t frameSize,
                           uint32_t *pRcvSize,
                           gmacQueList_t queIdx);

extern void GMACD_SetRxCallback(sGmacd *pGmacd, fGmacdTransferCallback
                                fRxCb, gmacQueList_t queIdx);

extern uint8_t GMACD_SetTxWakeupCallback(sGmacd *pGmacd,
        fGmacdWakeupCallback fWakeup,
        uint8_t bThreshold,
        gmacQueList_t queIdx);

extern void GMACD_TxPtpEvtMsgCBRegister (sGmacd *pGmacd,
        fGmacdTxPtpEvtCallBack pTxPtpEvtCb,
        gmacQueList_t queIdx);

#endif // #ifndef _GMACD_H_