sam4e_eth_driver.h File Reference

SAM4E Ethernet MAC driver. More...

Go to the source code of this file.

Data Structures

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


#define SAM4E_ETH_TX_BUFFER_SIZE   1536
#define SAM4E_ETH_RX_BUFFER_SIZE   128
#define PIO_PD6A_GRX1   PIO_PD6A_GRX0
#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 sam4eEthInit (NetInterface *interface)
 SAM4E Ethernet MAC initialization. More...
void sam4eEthInitGpio (NetInterface *interface)
void sam4eEthInitBufferDesc (NetInterface *interface)
 Initialize buffer descriptors. More...
void sam4eEthTick (NetInterface *interface)
 SAM4E Ethernet MAC timer handler. More...
void sam4eEthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
void sam4eEthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
void sam4eEthEventHandler (NetInterface *interface)
 SAM4E Ethernet MAC event handler. More...
error_t sam4eEthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
error_t sam4eEthReceivePacket (NetInterface *interface)
 Receive a packet. More...
error_t sam4eEthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
error_t sam4eEthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
void sam4eEthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
uint16_t sam4eEthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...


const NicDriver sam4eEthDriver
 SAM4E Ethernet MAC driver. More...

Detailed Description

SAM4E 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 sam4e_eth_driver.h.

Macro Definition Documentation


(PIO_PD16A_GTX3 | \

Definition at line 89 of file sam4e_eth_driver.h.



Definition at line 108 of file sam4e_eth_driver.h.


#define GMAC_RX_BAD_FCS   0x00002000

Definition at line 127 of file sam4e_eth_driver.h.


#define GMAC_RX_BROADCAST   0x80000000

Definition at line 111 of file sam4e_eth_driver.h.


#define GMAC_RX_CFI   0x00010000

Definition at line 123 of file sam4e_eth_driver.h.


#define GMAC_RX_CHECKSUM_VALID   0x00C00000

Definition at line 119 of file sam4e_eth_driver.h.


#define GMAC_RX_EOF   0x00008000

Definition at line 124 of file sam4e_eth_driver.h.


#define GMAC_RX_LENGTH   0x00001FFF

Definition at line 128 of file sam4e_eth_driver.h.


#define GMAC_RX_LENGTH_MSB   0x00002000

Definition at line 126 of file sam4e_eth_driver.h.


#define GMAC_RX_MULTICAST_HASH   0x40000000

Definition at line 112 of file sam4e_eth_driver.h.


#define GMAC_RX_OWNERSHIP   0x00000001

Definition at line 110 of file sam4e_eth_driver.h.


#define GMAC_RX_PRIORITY_TAG   0x00100000

Definition at line 121 of file sam4e_eth_driver.h.


#define GMAC_RX_SAR   0x08000000

Definition at line 114 of file sam4e_eth_driver.h.


#define GMAC_RX_SAR_MASK   0x06000000

Definition at line 115 of file sam4e_eth_driver.h.


#define GMAC_RX_SNAP   0x01000000

Definition at line 117 of file sam4e_eth_driver.h.


#define GMAC_RX_SOF   0x00004000

Definition at line 125 of file sam4e_eth_driver.h.


#define GMAC_RX_TYPE_ID   0x01000000

Definition at line 116 of file sam4e_eth_driver.h.


#define GMAC_RX_TYPE_ID_MASK   0x00C00000

Definition at line 118 of file sam4e_eth_driver.h.


#define GMAC_RX_UNICAST_HASH   0x20000000

Definition at line 113 of file sam4e_eth_driver.h.


#define GMAC_RX_VLAN_PRIORITY   0x000E0000

Definition at line 122 of file sam4e_eth_driver.h.


#define GMAC_RX_VLAN_TAG   0x00200000

Definition at line 120 of file sam4e_eth_driver.h.


#define GMAC_RX_WRAP   0x00000002

Definition at line 109 of file sam4e_eth_driver.h.


#define GMAC_TX_AHB_ERROR   0x08000000

Definition at line 100 of file sam4e_eth_driver.h.


#define GMAC_TX_CHECKSUM_ERROR   0x00700000

Definition at line 102 of file sam4e_eth_driver.h.


#define GMAC_TX_LAST   0x00008000

Definition at line 104 of file sam4e_eth_driver.h.


#define GMAC_TX_LATE_COL_ERROR   0x04000000

Definition at line 101 of file sam4e_eth_driver.h.


#define GMAC_TX_LENGTH   0x00003FFF

Definition at line 105 of file sam4e_eth_driver.h.


#define GMAC_TX_NO_CRC   0x00010000

Definition at line 103 of file sam4e_eth_driver.h.


#define GMAC_TX_RLE_ERROR   0x20000000

Definition at line 98 of file sam4e_eth_driver.h.


#define GMAC_TX_UNDERRUN_ERROR   0x10000000

Definition at line 99 of file sam4e_eth_driver.h.


#define GMAC_TX_USED   0x80000000

Definition at line 96 of file sam4e_eth_driver.h.


#define GMAC_TX_WRAP   0x40000000

Definition at line 97 of file sam4e_eth_driver.h.


#define PIO_PD6A_GRX1   PIO_PD6A_GRX0

Definition at line 85 of file sam4e_eth_driver.h.



Definition at line 71 of file sam4e_eth_driver.h.



Definition at line 64 of file sam4e_eth_driver.h.



Definition at line 78 of file sam4e_eth_driver.h.



Definition at line 50 of file sam4e_eth_driver.h.


#define SAM4E_ETH_RX_BUFFER_SIZE   128

Definition at line 57 of file sam4e_eth_driver.h.



Definition at line 36 of file sam4e_eth_driver.h.


#define SAM4E_ETH_TX_BUFFER_SIZE   1536

Definition at line 43 of file sam4e_eth_driver.h.

Function Documentation

◆ sam4eEthDisableIrq()

void sam4eEthDisableIrq ( NetInterface interface)

Disable interrupts.

[in]interfaceUnderlying network interface

Definition at line 356 of file sam4e_eth_driver.c.

◆ sam4eEthEnableIrq()

void sam4eEthEnableIrq ( NetInterface interface)

Enable interrupts.

[in]interfaceUnderlying network interface

Definition at line 328 of file sam4e_eth_driver.c.

◆ sam4eEthEventHandler()

void sam4eEthEventHandler ( NetInterface interface)

SAM4E Ethernet MAC event handler.

[in]interfaceUnderlying network interface

Definition at line 436 of file sam4e_eth_driver.c.

◆ sam4eEthInit()

error_t sam4eEthInit ( NetInterface interface)

SAM4E Ethernet MAC initialization.

[in]interfaceUnderlying network interface
Error code

Definition at line 115 of file sam4e_eth_driver.c.

◆ sam4eEthInitBufferDesc()

void sam4eEthInitBufferDesc ( NetInterface interface)

Initialize buffer descriptors.

[in]interfaceUnderlying network interface

Definition at line 250 of file sam4e_eth_driver.c.

◆ sam4eEthInitGpio()

void sam4eEthInitGpio ( NetInterface interface)

◆ sam4eEthReadPhyReg()

uint16_t sam4eEthReadPhyReg ( 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 878 of file sam4e_eth_driver.c.

◆ sam4eEthReceivePacket()

error_t sam4eEthReceivePacket ( NetInterface interface)

Receive a packet.

[in]interfaceUnderlying network interface
Error code

Definition at line 539 of file sam4e_eth_driver.c.

◆ sam4eEthSendPacket()

error_t sam4eEthSendPacket ( 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 472 of file sam4e_eth_driver.c.

◆ sam4eEthTick()

void sam4eEthTick ( NetInterface interface)

SAM4E 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 303 of file sam4e_eth_driver.c.

◆ sam4eEthUpdateMacAddrFilter()

error_t sam4eEthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

[in]interfaceUnderlying network interface
Error code

Definition at line 670 of file sam4e_eth_driver.c.

◆ sam4eEthUpdateMacConfig()

error_t sam4eEthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

[in]interfaceUnderlying network interface
Error code

Definition at line 796 of file sam4e_eth_driver.c.

◆ sam4eEthWritePhyReg()

void sam4eEthWritePhyReg ( 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 839 of file sam4e_eth_driver.c.

Variable Documentation

◆ sam4eEthDriver

const NicDriver sam4eEthDriver

SAM4E Ethernet MAC driver.

Definition at line 88 of file sam4e_eth_driver.c.

#define PIO_PD4A_GRXDV
#define PIO_PD5A_GRX0
#define PIO_PD8A_GMDC
#define PIO_PD6A_GRX1
#define PIO_PD1A_GTXEN
#define PIO_PD2A_GTX0
#define PIO_PD9A_GMDIO
#define PIO_PD0A_GTXCK