M480 BSP V3.05.006
The Board Support Package for M480 Series
emac.h
Go to the documentation of this file.
1/**************************************************************************/
9#ifndef __EMAC_H__
10#define __EMAC_H__
11
12#ifdef __cplusplus
13extern "C"
14{
15#endif
16
17#include <stdint.h>
18
31#define EMAC_PHY_ADDR 1UL
32#define EMAC_RX_DESC_SIZE 4UL
33#define EMAC_TX_DESC_SIZE 4UL
34#define EMAC_CAMENTRY_NB 16UL
35#define EMAC_MAX_PKT_SIZE 1524UL
37#define EMAC_LINK_DOWN 0UL
38#define EMAC_LINK_100F 1UL
39#define EMAC_LINK_100H 2UL
40#define EMAC_LINK_10F 3UL
41#define EMAC_LINK_10H 4UL
43#define EMAC_TIMEOUT_ERR (-1L)
44#define EMAC_BUS_ERR (-2L) /* end of group EMAC_EXPORTED_CONSTANTS */
47
48extern int32_t g_EMAC_i32ErrCode;
49
61#define EMAC_ENABLE_TX() (EMAC->CTL |= EMAC_CTL_TXON_Msk)
62
63
70#define EMAC_ENABLE_RX() do{EMAC->CTL |= EMAC_CTL_RXON_Msk; EMAC->RXST = 0;}while(0)
71
78#define EMAC_DISABLE_TX() (EMAC->CTL &= ~EMAC_CTL_TXON_Msk)
79
80
87#define EMAC_DISABLE_RX() (EMAC->CTL &= ~EMAC_CTL_RXON_Msk)
88
95#define EMAC_ENABLE_MAGIC_PKT_WAKEUP() (EMAC->CTL |= EMAC_CTL_WOLEN_Msk)
96
103#define EMAC_DISABLE_MAGIC_PKT_WAKEUP() (EMAC->CTL &= ~EMAC_CTL_WOLEN_Msk)
104
111#define EMAC_ENABLE_RECV_BCASTPKT() (EMAC->CAMCTL |= EMAC_CAMCTL_ABP_Msk)
112
119#define EMAC_DISABLE_RECV_BCASTPKT() (EMAC->CAMCTL &= ~EMAC_CAMCTL_ABP_Msk)
120
127#define EMAC_ENABLE_RECV_MCASTPKT() (EMAC->CAMCTL |= EMAC_CAMCTL_AMP_Msk)
128
135#define EMAC_DISABLE_RECV_MCASTPKT() (EMAC->CAMCTL &= ~EMAC_CAMCTL_AMP_Msk)
136
145#define EMAC_GET_ALARM_FLAG() (EMAC->INTSTS & EMAC_INTSTS_TSALMIF_Msk ? 1 : 0)
146
153#define EMAC_CLR_ALARM_FLAG() (EMAC->INTSTS = EMAC_INTSTS_TSALMIF_Msk)
154
160#define EMAC_TRIGGER_RX() do{EMAC->RXST = 0UL;}while(0)
161
167#define EMAC_TRIGGER_TX() do{EMAC->TXST = 0UL;}while(0)
168
204#define EMAC_ENABLE_INT(emac, u32eIntSel) ((emac)->INTEN |= (u32eIntSel))
205
241#define EMAC_DISABLE_INT(emac, u32eIntSel) ((emac)->INTEN &= ~ (u32eIntSel))
242
278#define EMAC_GET_INT_FLAG(emac, u32eIntTypeFlag) (((emac)->INTSTS & (u32eIntTypeFlag))?1:0)
279
316#define EMAC_CLEAR_INT_FLAG(emac, u32eIntTypeFlag) ((emac)->INTSTS |= (u32eIntTypeFlag))
317
318void EMAC_Open(uint8_t *pu8MacAddr);
319int32_t EMAC_Close(void);
320void EMAC_SetMacAddr(uint8_t *pu8MacAddr);
321void EMAC_EnableCamEntry(uint32_t u32Entry, uint8_t pu8MacAddr[]);
322void EMAC_DisableCamEntry(uint32_t u32Entry);
323
324uint32_t EMAC_RecvPkt(uint8_t *pu8Data, uint32_t *pu32Size);
325uint32_t EMAC_RecvPktTS(uint8_t *pu8Data, uint32_t *pu32Size, uint32_t *pu32Sec, uint32_t *pu32Nsec);
326void EMAC_RecvPktDone(void);
327
328uint32_t EMAC_SendPkt(uint8_t *pu8Data, uint32_t u32Size);
329uint32_t EMAC_SendPktDone(void);
330uint32_t EMAC_SendPktDoneTS(uint32_t *pu32Sec, uint32_t *pu32Nsec);
331
332void EMAC_EnableTS(uint32_t u32Sec, uint32_t u32Nsec);
333void EMAC_DisableTS(void);
334void EMAC_GetTime(uint32_t *pu32Sec, uint32_t *pu32Nsec);
335void EMAC_SetTime(uint32_t u32Sec, uint32_t u32Nsec);
336void EMAC_UpdateTime(uint32_t u32Neg, uint32_t u32Sec, uint32_t u32Nsec);
337void EMAC_EnableAlarm(uint32_t u32Sec, uint32_t u32Nsec);
338void EMAC_DisableAlarm(void);
339
340uint32_t EMAC_CheckLinkStatus(void);
341
342int32_t EMAC_PhyInit(void);
343int32_t EMAC_FillCamEntry(uint8_t pu8MacAddr[]);
344uint8_t *EMAC_ClaimFreeTXBuf(void);
345uint32_t EMAC_GetAvailRXBufSize(void);
346uint32_t EMAC_SendPktWoCopy(uint32_t u32Size);
348 /* end of group EMAC_EXPORTED_FUNCTIONS */
350 /* end of group EMAC_Driver */
352 /* end of group Standard_Driver */
354
355#ifdef __cplusplus
356}
357#endif
358
359#endif /* __NU_EMAC_H__ */
int32_t g_EMAC_i32ErrCode
Definition: emac.c:22
uint32_t EMAC_CheckLinkStatus(void)
Check Ethernet link status.
Definition: emac.c:1011
void EMAC_SetTime(uint32_t u32Sec, uint32_t u32Nsec)
Set current time stamp.
Definition: emac.c:942
uint32_t EMAC_GetAvailRXBufSize(void)
Get data length of avaiable RX buffer.
Definition: emac.c:1164
void EMAC_DisableTS(void)
Disable IEEE1588 time stamp function.
Definition: emac.c:918
void EMAC_DisableAlarm(void)
Disable alarm function.
Definition: emac.c:972
uint32_t EMAC_SendPktDoneTS(uint32_t *pu32Sec, uint32_t *pu32Nsec)
Clean up process after a packet is sent, and get the time stamp while packet is sent.
Definition: emac.c:815
uint8_t * EMAC_ClaimFreeTXBuf(void)
Get avaiable TX buffer address.
Definition: emac.c:1144
void EMAC_RecvPktDoneWoRxTrigger(void)
Clean up process after a packet is received.
Definition: emac.c:1196
void EMAC_RecvPktDone(void)
Clean up process after a packet is received.
Definition: emac.c:657
void EMAC_DisableCamEntry(uint32_t u32Entry)
Disable a specified CAM entry.
Definition: emac.c:509
uint32_t EMAC_SendPktDone(void)
Clean up process after packet(s) are sent.
Definition: emac.c:731
void EMAC_SetMacAddr(uint8_t *pu8MacAddr)
Set the device MAC address.
Definition: emac.c:473
uint32_t EMAC_RecvPktTS(uint8_t *pu8Data, uint32_t *pu32Size, uint32_t *pu32Sec, uint32_t *pu32Nsec)
Receive an Ethernet packet and the time stamp while it's received.
Definition: emac.c:591
int32_t EMAC_PhyInit(void)
void EMAC_Open(uint8_t *pu8MacAddr)
Initialize EMAC interface, including descriptors, MAC address, and PHY.
Definition: emac.c:414
void EMAC_GetTime(uint32_t *pu32Sec, uint32_t *pu32Nsec)
Get current time stamp.
Definition: emac.c:929
uint32_t EMAC_RecvPkt(uint8_t *pu8Data, uint32_t *pu32Size)
Receive an Ethernet packet.
Definition: emac.c:525
uint32_t EMAC_SendPkt(uint8_t *pu8Data, uint32_t u32Size)
Send an Ethernet packet.
Definition: emac.c:689
int32_t EMAC_FillCamEntry(uint8_t pu8MacAddr[])
Fill a MAC address to list and enable.
Definition: emac.c:1057
void EMAC_EnableCamEntry(uint32_t u32Entry, uint8_t pu8MacAddr[])
Fill a CAM entry for MAC address comparison.
Definition: emac.c:485
void EMAC_UpdateTime(uint32_t u32Neg, uint32_t u32Sec, uint32_t u32Nsec)
Add a offset to current time.
Definition: emac.c:986
void EMAC_EnableAlarm(uint32_t u32Sec, uint32_t u32Nsec)
Enable alarm function and set alarm time.
Definition: emac.c:958
int32_t EMAC_Close(void)
This function stop all receive and transmit activity and disable MAC interface.
Definition: emac.c:455
void EMAC_EnableTS(uint32_t u32Sec, uint32_t u32Nsec)
Enable IEEE1588 time stamp function and set current time.
Definition: emac.c:890
uint32_t EMAC_SendPktWoCopy(uint32_t u32Size)
Send an Ethernet packet.
Definition: emac.c:1108