CMSIS: Cortex Microcontroller Software Interface Standard (Ethernet Device)

#define EthDev_ADDR_SIZE         6
#define EthDev_MTU_SIZE       1514

This two defines are used from the Ethernet Device Driver.

EthDev_ADDR_SIZE
Ethernet Address size in bytes.

EthDev_MTU_SIZE
Maximum Transmission Unit size.

typedef enum {
  EthDev_MODE_AUTO              = 0,
  EthDev_MODE_10M_FULL          = 1,
  EthDev_MODE_10M_HALF          = 2,
  EthDev_MODE_100M_FULL         = 3,
  EthDev_MODE_100M_HALF         = 4,
  EthDev_MODE_1000M_FULL        = 5,
  EthDev_MODE_1000M_HALF        = 6,
} EthDev_MODE;

Link Mode values and explanation.

EthDev_MODE_AUTO
Ethernet link speed and link duplex depend on autonegothiation.

EthDev_MODE_10M_FULL
Use 10.0 Mbps link speed with full duplex.

EthDev_MODE_10M_HALF
Use 10.0 Mbps link speed with half duplex.

EthDev_MODE_100M_FULL
Use 100.0 Mbps link speed with full duplex.

EthDev_MODE_100M_HALF
Use 100.0 Mbps link speed with half duplex.

EthDev_MODE_1000M_FULL
Use 1000.0 Mbps link speed with full duplex.

EthDev_MODE_1000M_HALF
Use 1000.0 Mbps link speed with half duplex.

typedef enum {
  EthDev_LINK_DOWN              = 0,
  EthDev_LINK_UP                = 1,
} EthDev_LINK;

Link State values and explanation.

EthDev_LINK_DOWN
Ethernet link is not established.

EthDev_LINK_UP
Ethernet link is established.

typedef enum {
  EthDev_SPEED_10M              = 0,
  EthDev_SPEED_100M             = 1,
  EthDev_SPEED_1000M            = 2,
} EthDev_SPEED;

Link Speed values and explanation.

EthDev_SPEED_10M
10.0 Mbps link speed.

EthDev_SPEED_100M
100.0 Mbps link speed.

EthDev_SPEED_1000M
1000.0 Mbps link speed.

typedef enum {
  EthDev_DUPLEX_HALF            = 0,
  EthDev_DUPLEX_FULL            = 1,
} EthDev_DUPLEX;

Link Duplex values and explanation.

EthDev_DUPLEX_HALF
Link half duplex.

EthDev_DUPLEX_FULL
Link full duplex.

typedef struct {
  EthDev_LINK   Link   : 1;
  EthDev_DUPLEX Duplex : 1;
  EthDev_SPEED  Speed  : 2;
} EthDev_STATUS;

Link Status attributes and explanation.

Link
Valid values are:

• EthDev_LINK_DOWN
• EthDev_LINK_Up

Duplex
Valid values are:

• EthDev_DUPLEX_HALF
• EthDev_DUPLEX_Full

Speed
Valid values are:

• EthDev_SPEED_10M
• EthDev_SPEED_100M
• EthDev_SPEED_1000M

typedef struct {
   EthDev_MODE   Mode;
   unsigned char HwAddr[EthDev_ADDR_SIZE];
   void         *(*RxFrame)      (int size);
   void          (*RxFrameReady) (int size);

   int           (*Init)       (void);
   int           (*UnInit)     (void);
   int           (*SetMCFilter)(int NumHwAddr, unsigned char *pHwAddr);
   int           (*TxFrame)    (void *pData, int size);
   void          (*Lock)       (void);
   void          (*UnLock)     (void);
   EthDev_STATUS (*LinkChk)    (void);
} EthDev_IOB;

This structure is used to hold configuration values and function pointer to access the device specific Ethernet Device Driver. The configuration values are preset with default values.

Mode
Selects the mode in which the Ethernet link is established.
Valid values are:

• EthDev_MODE_AUTO (default)
• EthDev_MODE_10M_FULL
• EthDev_MODE_10M_HALF
• EthDev_MODE_100M_FULL
• EthDev_MODE_100M_HALF
• EthDev_MODE_1000M_FULL
• EthDev_MODE_1000M_HALF

EthHwAddr
Contains the 6 byte MAC address. Default value is "0,0,0,0,0,0". If EthHwAddr address is 00:00:00:00:00:00, then the driver shall use it's own MAC which is stored in HW (e.g. EEPROM). After this MAC is used, the Init function shall copy the used MAC to this entry to provide the application the MAC address for the Ethernet Device. If EthHwAddr is not 0, then this MAC shall be used.

void *(*RxFrame) (int size)
Callback function. Called when a frame is received. This function pointer must be set before the Init function is called.

void (*RxFrame) (int size)
Callback function. Called after the frame is copied to the application buffer. This function pointer is optional. In case of NULL the function is omitted.

int (*Init) (void)
Function pointer to Init function.

int (*UnInit) (void)
Function pointer to UnInit function.

int (*SetMCFilter) (int NumHwAddr, unsigned char *pHwAddr)
Function pointer to set Multicast filter function.

int (*EthDev_FrameTx) (void *pData, int size)
Function pointer to frame transmit function.

void (*Lock) (void)
Function pointer to device lock function.

void (*UnLock) (void)
Function pointer to device unlock function.

static int EthDev_Init (void);

• Success (0)
• Failed (-1)

static int EthDev_UnInit (void);

• Success (0)
• Failed (-1)

static int EthDev_SetMCFilter (int NumHwAddr, unsigned char *pHwAddr);

NumHwAddr
Number of passed Multicast addresses.

pHwAddr
Pointer to the Multicast addresses.

• Success (0)
• Failed (-1)

static int EthDev_TxFrame (void *pData, int size);

pData
Pointer to the data to send.

size
Number of bytes to send.

• Success (0)
• Failed (-1)

static void EthDev_Lock (void);

static void EthDev_UnLock (void);

static EthDev_STATUS EthDev_LinkChk (void);

void *RxFrame (int size);

size
Size of the received frame.

void RxFrameReady (int size);

size
Size of the copied frame.