sama5d2_eth_driver.h File Reference

SAMA5D2 Ethernet MAC driver. More...

Go to the source code of this file.

Data Structures

struct  Sama5d2TxBufferDesc
 Transmit buffer descriptor. More...
struct  Sama5d2RxBufferDesc
 Receive buffer descriptor. More...


#define SAMA5D2_ETH_TX_BUFFER_SIZE   1536
#define SAMA5D2_ETH_RX_BUFFER_SIZE   128
#define SAMA5D2_ETH_RAM_SECTION   ".region_ddr_nocache"
#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 sama5d2EthInit (NetInterface *interface)
 SAMA5D2 Ethernet MAC initialization. More...
void sama5d2EthInitGpio (NetInterface *interface)
void sama5d2EthInitBufferDesc (NetInterface *interface)
 Initialize buffer descriptors. More...
void sama5d2EthTick (NetInterface *interface)
 SAMA5D2 Ethernet MAC timer handler. More...
void sama5d2EthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
void sama5d2EthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
void sama5d2EthIrqHandler (void)
 SAMA5D2 Ethernet MAC interrupt service routine. More...
void sama5d2EthEventHandler (NetInterface *interface)
 SAMA5D2 Ethernet MAC event handler. More...
error_t sama5d2EthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
error_t sama5d2EthReceivePacket (NetInterface *interface)
 Receive a packet. More...
error_t sama5d2EthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
error_t sama5d2EthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
void sama5d2EthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
uint16_t sama5d2EthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...


const NicDriver sama5d2EthDriver
 SAMA5D2 Ethernet MAC driver. More...

Detailed Description

SAMA5D2 Ethernet MAC driver.


SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2020 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 sama5d2_eth_driver.h.

Macro Definition Documentation



Definition at line 101 of file sama5d2_eth_driver.h.


#define GMAC_RX_BAD_FCS   0x00002000

Definition at line 120 of file sama5d2_eth_driver.h.


#define GMAC_RX_BROADCAST   0x80000000

Definition at line 104 of file sama5d2_eth_driver.h.


#define GMAC_RX_CFI   0x00010000

Definition at line 116 of file sama5d2_eth_driver.h.


#define GMAC_RX_CHECKSUM_VALID   0x00C00000

Definition at line 112 of file sama5d2_eth_driver.h.


#define GMAC_RX_EOF   0x00008000

Definition at line 117 of file sama5d2_eth_driver.h.


#define GMAC_RX_LENGTH   0x00001FFF

Definition at line 121 of file sama5d2_eth_driver.h.


#define GMAC_RX_LENGTH_MSB   0x00002000

Definition at line 119 of file sama5d2_eth_driver.h.


#define GMAC_RX_MULTICAST_HASH   0x40000000

Definition at line 105 of file sama5d2_eth_driver.h.


#define GMAC_RX_OWNERSHIP   0x00000001

Definition at line 103 of file sama5d2_eth_driver.h.


#define GMAC_RX_PRIORITY_TAG   0x00100000

Definition at line 114 of file sama5d2_eth_driver.h.


#define GMAC_RX_SAR   0x08000000

Definition at line 107 of file sama5d2_eth_driver.h.


#define GMAC_RX_SAR_MASK   0x06000000

Definition at line 108 of file sama5d2_eth_driver.h.


#define GMAC_RX_SNAP   0x01000000

Definition at line 110 of file sama5d2_eth_driver.h.


#define GMAC_RX_SOF   0x00004000

Definition at line 118 of file sama5d2_eth_driver.h.


#define GMAC_RX_TYPE_ID   0x01000000

Definition at line 109 of file sama5d2_eth_driver.h.


#define GMAC_RX_TYPE_ID_MASK   0x00C00000

Definition at line 111 of file sama5d2_eth_driver.h.


#define GMAC_RX_UNICAST_HASH   0x20000000

Definition at line 106 of file sama5d2_eth_driver.h.


#define GMAC_RX_VLAN_PRIORITY   0x000E0000

Definition at line 115 of file sama5d2_eth_driver.h.


#define GMAC_RX_VLAN_TAG   0x00200000

Definition at line 113 of file sama5d2_eth_driver.h.


#define GMAC_RX_WRAP   0x00000002

Definition at line 102 of file sama5d2_eth_driver.h.


#define GMAC_TX_AHB_ERROR   0x08000000

Definition at line 93 of file sama5d2_eth_driver.h.


#define GMAC_TX_CHECKSUM_ERROR   0x00700000

Definition at line 95 of file sama5d2_eth_driver.h.


#define GMAC_TX_LAST   0x00008000

Definition at line 97 of file sama5d2_eth_driver.h.


#define GMAC_TX_LATE_COL_ERROR   0x04000000

Definition at line 94 of file sama5d2_eth_driver.h.


#define GMAC_TX_LENGTH   0x00003FFF

Definition at line 98 of file sama5d2_eth_driver.h.


#define GMAC_TX_NO_CRC   0x00010000

Definition at line 96 of file sama5d2_eth_driver.h.


#define GMAC_TX_RLE_ERROR   0x20000000

Definition at line 91 of file sama5d2_eth_driver.h.


#define GMAC_TX_UNDERRUN_ERROR   0x10000000

Definition at line 92 of file sama5d2_eth_driver.h.


#define GMAC_TX_USED   0x80000000

Definition at line 89 of file sama5d2_eth_driver.h.


#define GMAC_TX_WRAP   0x40000000

Definition at line 90 of file sama5d2_eth_driver.h.



Definition at line 64 of file sama5d2_eth_driver.h.



Definition at line 71 of file sama5d2_eth_driver.h.



Definition at line 78 of file sama5d2_eth_driver.h.


#define SAMA5D2_ETH_RAM_SECTION   ".region_ddr_nocache"

Definition at line 85 of file sama5d2_eth_driver.h.



Definition at line 50 of file sama5d2_eth_driver.h.


#define SAMA5D2_ETH_RX_BUFFER_SIZE   128

Definition at line 57 of file sama5d2_eth_driver.h.



Definition at line 36 of file sama5d2_eth_driver.h.


#define SAMA5D2_ETH_TX_BUFFER_SIZE   1536

Definition at line 43 of file sama5d2_eth_driver.h.

Function Documentation

◆ sama5d2EthDisableIrq()

void sama5d2EthDisableIrq ( NetInterface interface)

Disable interrupts.

[in]interfaceUnderlying network interface

Definition at line 427 of file sama5d2_eth_driver.c.

◆ sama5d2EthEnableIrq()

void sama5d2EthEnableIrq ( NetInterface interface)

Enable interrupts.

[in]interfaceUnderlying network interface

Definition at line 399 of file sama5d2_eth_driver.c.

◆ sama5d2EthEventHandler()

void sama5d2EthEventHandler ( NetInterface interface)

SAMA5D2 Ethernet MAC event handler.

[in]interfaceUnderlying network interface

Definition at line 512 of file sama5d2_eth_driver.c.

◆ sama5d2EthInit()

error_t sama5d2EthInit ( NetInterface interface)

SAMA5D2 Ethernet MAC initialization.

[in]interfaceUnderlying network interface
Error code

Definition at line 151 of file sama5d2_eth_driver.c.

◆ sama5d2EthInitBufferDesc()

void sama5d2EthInitBufferDesc ( NetInterface interface)

Initialize buffer descriptors.

[in]interfaceUnderlying network interface

Definition at line 288 of file sama5d2_eth_driver.c.

◆ sama5d2EthInitGpio()

void sama5d2EthInitGpio ( NetInterface interface)

◆ sama5d2EthIrqHandler()

void sama5d2EthIrqHandler ( void  )

SAMA5D2 Ethernet MAC interrupt service routine.

Definition at line 454 of file sama5d2_eth_driver.c.

◆ sama5d2EthReadPhyReg()

uint16_t sama5d2EthReadPhyReg ( uint8_t  opcode,
uint8_t  phyAddr,
uint8_t  regAddr 

Read PHY register.

[in]opcodeAccess type (2 bits)
[in]phyAddrPHY address (5 bits)
[in]regAddrRegister address (5 bits)
Register value

Definition at line 957 of file sama5d2_eth_driver.c.

◆ sama5d2EthReceivePacket()

error_t sama5d2EthReceivePacket ( NetInterface interface)

Receive a packet.

[in]interfaceUnderlying network interface
Error code

Definition at line 618 of file sama5d2_eth_driver.c.

◆ sama5d2EthSendPacket()

error_t sama5d2EthSendPacket ( NetInterface interface,
const NetBuffer buffer,
size_t  offset,
NetTxAncillary ancillary 

Send a packet.

[in]interfaceUnderlying network interface
[in]bufferMulti-part buffer containing the data to send
[in]offsetOffset to the first data byte
[in]ancillaryAdditional options passed to the stack along with the packet
Error code

Definition at line 548 of file sama5d2_eth_driver.c.

◆ sama5d2EthTick()

void sama5d2EthTick ( NetInterface interface)

SAMA5D2 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 374 of file sama5d2_eth_driver.c.

◆ sama5d2EthUpdateMacAddrFilter()

error_t sama5d2EthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

[in]interfaceUnderlying network interface
Error code

Definition at line 749 of file sama5d2_eth_driver.c.

◆ sama5d2EthUpdateMacConfig()

error_t sama5d2EthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

[in]interfaceUnderlying network interface
Error code

Definition at line 875 of file sama5d2_eth_driver.c.

◆ sama5d2EthWritePhyReg()

void sama5d2EthWritePhyReg ( uint8_t  opcode,
uint8_t  phyAddr,
uint8_t  regAddr,
uint16_t  data 

Write PHY register.

[in]opcodeAccess type (2 bits)
[in]phyAddrPHY address (5 bits)
[in]regAddrRegister address (5 bits)
[in]dataRegister value

Definition at line 918 of file sama5d2_eth_driver.c.

Variable Documentation

◆ sama5d2EthDriver

const NicDriver sama5d2EthDriver

SAMA5D2 Ethernet MAC driver.

Definition at line 124 of file sama5d2_eth_driver.c.