same54_eth_driver.h File Reference

SAME54 Ethernet MAC controller. More...

Go to the source code of this file.

Data Structures

struct  Sam4eTxBufferDesc
 Transmit buffer descriptor. More...
struct  Sam4eRxBufferDesc
 Receive buffer descriptor. More...


#define SAME54_ETH_TX_BUFFER_SIZE   1536
#define SAME54_ETH_RX_BUFFER_SIZE   128
#define GMAC_TX_USED   0x80000000
#define GMAC_TX_WRAP   0x40000000
#define GMAC_TX_RLE_ERROR   0x20000000
#define GMAC_TX_UNDERRUN_ERROR   0x10000000
#define GMAC_TX_AHB_ERROR   0x08000000
#define GMAC_TX_LATE_COL_ERROR   0x04000000
#define GMAC_TX_CHECKSUM_ERROR   0x00700000
#define GMAC_TX_NO_CRC   0x00010000
#define GMAC_TX_LAST   0x00008000
#define GMAC_TX_LENGTH   0x00003FFF
#define GMAC_RX_WRAP   0x00000002
#define GMAC_RX_OWNERSHIP   0x00000001
#define GMAC_RX_BROADCAST   0x80000000
#define GMAC_RX_MULTICAST_HASH   0x40000000
#define GMAC_RX_UNICAST_HASH   0x20000000
#define GMAC_RX_SAR   0x08000000
#define GMAC_RX_SAR_MASK   0x06000000
#define GMAC_RX_TYPE_ID   0x01000000
#define GMAC_RX_SNAP   0x01000000
#define GMAC_RX_TYPE_ID_MASK   0x00C00000
#define GMAC_RX_CHECKSUM_VALID   0x00C00000
#define GMAC_RX_VLAN_TAG   0x00200000
#define GMAC_RX_PRIORITY_TAG   0x00100000
#define GMAC_RX_VLAN_PRIORITY   0x000E0000
#define GMAC_RX_CFI   0x00010000
#define GMAC_RX_EOF   0x00008000
#define GMAC_RX_SOF   0x00004000
#define GMAC_RX_LENGTH_MSB   0x00002000
#define GMAC_RX_BAD_FCS   0x00002000
#define GMAC_RX_LENGTH   0x00001FFF


error_t same54EthInit (NetInterface *interface)
 SAME54 Ethernet MAC initialization. More...
void same54EthInitGpio (NetInterface *interface)
void same54EthInitBufferDesc (NetInterface *interface)
 Initialize buffer descriptors. More...
void same54EthTick (NetInterface *interface)
 SAME54 Ethernet MAC timer handler. More...
void same54EthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
void same54EthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
void same54EthEventHandler (NetInterface *interface)
 SAME54 Ethernet MAC event handler. More...
error_t same54EthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset)
 Send a packet. More...
error_t same54EthReceivePacket (NetInterface *interface)
 Receive a packet. More...
error_t same54EthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
error_t same54EthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
void same54EthWritePhyReg (uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
uint16_t same54EthReadPhyReg (uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...


const NicDriver same54EthDriver
 SAME54 Ethernet MAC driver. More...

Detailed Description

SAME54 Ethernet MAC controller.


Copyright (C) 2010-2018 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Oryx Embedded SARL (

Definition in file same54_eth_driver.h.

Macro Definition Documentation



Definition at line 94 of file same54_eth_driver.h.


#define GMAC_RX_BAD_FCS   0x00002000

Definition at line 113 of file same54_eth_driver.h.


#define GMAC_RX_BROADCAST   0x80000000

Definition at line 97 of file same54_eth_driver.h.


#define GMAC_RX_CFI   0x00010000

Definition at line 109 of file same54_eth_driver.h.


#define GMAC_RX_CHECKSUM_VALID   0x00C00000

Definition at line 105 of file same54_eth_driver.h.


#define GMAC_RX_EOF   0x00008000

Definition at line 110 of file same54_eth_driver.h.


#define GMAC_RX_LENGTH   0x00001FFF

Definition at line 114 of file same54_eth_driver.h.


#define GMAC_RX_LENGTH_MSB   0x00002000

Definition at line 112 of file same54_eth_driver.h.


#define GMAC_RX_MULTICAST_HASH   0x40000000

Definition at line 98 of file same54_eth_driver.h.


#define GMAC_RX_OWNERSHIP   0x00000001

Definition at line 96 of file same54_eth_driver.h.


#define GMAC_RX_PRIORITY_TAG   0x00100000

Definition at line 107 of file same54_eth_driver.h.


#define GMAC_RX_SAR   0x08000000

Definition at line 100 of file same54_eth_driver.h.


#define GMAC_RX_SAR_MASK   0x06000000

Definition at line 101 of file same54_eth_driver.h.


#define GMAC_RX_SNAP   0x01000000

Definition at line 103 of file same54_eth_driver.h.


#define GMAC_RX_SOF   0x00004000

Definition at line 111 of file same54_eth_driver.h.


#define GMAC_RX_TYPE_ID   0x01000000

Definition at line 102 of file same54_eth_driver.h.


#define GMAC_RX_TYPE_ID_MASK   0x00C00000

Definition at line 104 of file same54_eth_driver.h.


#define GMAC_RX_UNICAST_HASH   0x20000000

Definition at line 99 of file same54_eth_driver.h.


#define GMAC_RX_VLAN_PRIORITY   0x000E0000

Definition at line 108 of file same54_eth_driver.h.


#define GMAC_RX_VLAN_TAG   0x00200000

Definition at line 106 of file same54_eth_driver.h.


#define GMAC_RX_WRAP   0x00000002

Definition at line 95 of file same54_eth_driver.h.


#define GMAC_TX_AHB_ERROR   0x08000000

Definition at line 86 of file same54_eth_driver.h.


#define GMAC_TX_CHECKSUM_ERROR   0x00700000

Definition at line 88 of file same54_eth_driver.h.


#define GMAC_TX_LAST   0x00008000

Definition at line 90 of file same54_eth_driver.h.


#define GMAC_TX_LATE_COL_ERROR   0x04000000

Definition at line 87 of file same54_eth_driver.h.


#define GMAC_TX_LENGTH   0x00003FFF

Definition at line 91 of file same54_eth_driver.h.


#define GMAC_TX_NO_CRC   0x00010000

Definition at line 89 of file same54_eth_driver.h.


#define GMAC_TX_RLE_ERROR   0x20000000

Definition at line 84 of file same54_eth_driver.h.


#define GMAC_TX_UNDERRUN_ERROR   0x10000000

Definition at line 85 of file same54_eth_driver.h.


#define GMAC_TX_USED   0x80000000

Definition at line 82 of file same54_eth_driver.h.


#define GMAC_TX_WRAP   0x40000000

Definition at line 83 of file same54_eth_driver.h.



Definition at line 69 of file same54_eth_driver.h.



Definition at line 62 of file same54_eth_driver.h.



Definition at line 76 of file same54_eth_driver.h.



Definition at line 48 of file same54_eth_driver.h.


#define SAME54_ETH_RX_BUFFER_SIZE   128

Definition at line 55 of file same54_eth_driver.h.



Definition at line 34 of file same54_eth_driver.h.


#define SAME54_ETH_TX_BUFFER_SIZE   1536

Definition at line 41 of file same54_eth_driver.h.

Function Documentation

◆ same54EthDisableIrq()

void same54EthDisableIrq ( NetInterface interface)

Disable interrupts.

[in]interfaceUnderlying network interface

Definition at line 347 of file same54_eth_driver.c.

◆ same54EthEnableIrq()

void same54EthEnableIrq ( NetInterface interface)

Enable interrupts.

[in]interfaceUnderlying network interface

Definition at line 333 of file same54_eth_driver.c.

◆ same54EthEventHandler()

void same54EthEventHandler ( NetInterface interface)

SAME54 Ethernet MAC event handler.

[in]interfaceUnderlying network interface

Definition at line 413 of file same54_eth_driver.c.

◆ same54EthInit()

error_t same54EthInit ( NetInterface interface)

SAME54 Ethernet MAC initialization.

[in]interfaceUnderlying network interface
Error code

Definition at line 113 of file same54_eth_driver.c.

◆ same54EthInitBufferDesc()

void same54EthInitBufferDesc ( NetInterface interface)

Initialize buffer descriptors.

[in]interfaceUnderlying network interface

Definition at line 268 of file same54_eth_driver.c.

◆ same54EthInitGpio()

void same54EthInitGpio ( NetInterface interface)

◆ same54EthReadPhyReg()

uint16_t same54EthReadPhyReg ( uint8_t  phyAddr,
uint8_t  regAddr 

Read PHY register.

[in]phyAddrPHY address
[in]regAddrRegister address
Register value

Definition at line 750 of file same54_eth_driver.c.

◆ same54EthReceivePacket()

error_t same54EthReceivePacket ( NetInterface interface)

Receive a packet.

[in]interfaceUnderlying network interface
Error code

Definition at line 512 of file same54_eth_driver.c.

◆ same54EthSendPacket()

error_t same54EthSendPacket ( NetInterface interface,
const NetBuffer buffer,
size_t  offset 

Send a packet.

[in]interfaceUnderlying network interface
[in]bufferMulti-part buffer containing the data to send
[in]offsetOffset to the first data byte
Error code

Definition at line 447 of file same54_eth_driver.c.

◆ same54EthTick()

void same54EthTick ( NetInterface interface)

SAME54 Ethernet MAC timer handler.

This routine is periodically called by the TCP/IP stack to handle periodic operations such as polling the link state

[in]interfaceUnderlying network interface

Definition at line 321 of file same54_eth_driver.c.

◆ same54EthUpdateMacAddrFilter()

error_t same54EthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

[in]interfaceUnderlying network interface
Error code

Definition at line 626 of file same54_eth_driver.c.

◆ same54EthUpdateMacConfig()

error_t same54EthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

[in]interfaceUnderlying network interface
Error code

Definition at line 689 of file same54_eth_driver.c.

◆ same54EthWritePhyReg()

void same54EthWritePhyReg ( uint8_t  phyAddr,
uint8_t  regAddr,
uint16_t  data 

Write PHY register.

[in]phyAddrPHY address
[in]regAddrRegister address
[in]dataRegister value

Definition at line 723 of file same54_eth_driver.c.

Variable Documentation

◆ same54EthDriver

const NicDriver same54EthDriver

SAME54 Ethernet MAC driver.

Definition at line 86 of file same54_eth_driver.c.