sam9263_eth_driver.h File Reference

AT91SAM9263 Ethernet MAC driver. More...

Go to the source code of this file.

Data Structures

struct  Sam9263TxBufferDesc
 Transmit buffer descriptor. More...
struct  Sam9263RxBufferDesc
 Receive buffer descriptor. More...


#define SAM9263_ETH_TX_BUFFER_COUNT   3
#define SAM9263_ETH_TX_BUFFER_SIZE   1536
#define SAM9263_ETH_RX_BUFFER_COUNT   72
#define SAM9263_ETH_RX_BUFFER_SIZE   128
#define AT91C_EMAC_SOF_01   (1 << 30)
#define AT91C_EMAC_RW_01   (1 << 28)
#define AT91C_EMAC_RW_10   (2 << 28)
#define AT91C_EMAC_CODE_10   (2 << 16)
#define AT91C_EMAC_TX_USED   0x80000000
#define AT91C_EMAC_TX_WRAP   0x40000000
#define AT91C_EMAC_TX_ERROR   0x20000000
#define AT91C_EMAC_TX_UNDERRUN   0x10000000
#define AT91C_EMAC_TX_EXHAUSTED   0x08000000
#define AT91C_EMAC_TX_NO_CRC   0x00010000
#define AT91C_EMAC_TX_LAST   0x00008000
#define AT91C_EMAC_TX_LENGTH   0x000007FF
#define AT91C_EMAC_RX_WRAP   0x00000002
#define AT91C_EMAC_RX_OWNERSHIP   0x00000001
#define AT91C_EMAC_RX_BROADCAST   0x80000000
#define AT91C_EMAC_RX_MULTICAST_HASH   0x40000000
#define AT91C_EMAC_RX_UNICAST_HASH   0x20000000
#define AT91C_EMAC_RX_EXT_ADDR   0x10000000
#define AT91C_EMAC_RX_SAR1   0x04000000
#define AT91C_EMAC_RX_SAR2   0x02000000
#define AT91C_EMAC_RX_SAR3   0x01000000
#define AT91C_EMAC_RX_SAR4   0x00800000
#define AT91C_EMAC_RX_TYPE_ID   0x00400000
#define AT91C_EMAC_RX_VLAN_TAG   0x00200000
#define AT91C_EMAC_RX_PRIORITY_TAG   0x00100000
#define AT91C_EMAC_RX_VLAN_PRIORITY   0x000E0000
#define AT91C_EMAC_RX_CFI   0x00010000
#define AT91C_EMAC_RX_EOF   0x00008000
#define AT91C_EMAC_RX_SOF   0x00004000
#define AT91C_EMAC_RX_OFFSET   0x00003000
#define AT91C_EMAC_RX_LENGTH   0x00000FFF


error_t sam9263EthInit (NetInterface *interface)
 SAM9263 Ethernet MAC initialization. More...
void sam9263EthInitGpio (NetInterface *interface)
void sam9263EthInitBufferDesc (NetInterface *interface)
 Initialize buffer descriptors. More...
void sam9263EthTick (NetInterface *interface)
 SAM9263 Ethernet MAC timer handler. More...
void sam9263EthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
void sam9263EthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
void sam9263EthIrqHandler (void)
 SAM9263 Ethernet MAC interrupt service routine. More...
void sam9263EthEventHandler (NetInterface *interface)
 SAM9263 Ethernet MAC event handler. More...
error_t sam9263EthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
error_t sam9263EthReceivePacket (NetInterface *interface)
 Receive a packet. More...
error_t sam9263EthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
error_t sam9263EthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
void sam9263EthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
uint16_t sam9263EthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
void emacIrqWrapper (void)


const NicDriver sam9263EthDriver
 SAM9263 Ethernet MAC driver. More...

Detailed Description

AT91SAM9263 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 sam9263_eth_driver.h.

Macro Definition Documentation



Definition at line 63 of file sam9263_eth_driver.h.


#define AT91C_EMAC_CODE_10   (2 << 16)

Definition at line 76 of file sam9263_eth_driver.h.



Definition at line 66 of file sam9263_eth_driver.h.


(AT91C_PE30_EMDIO | \
AT91C_PE29_EMDC | AT91C_PE28_ETXEN | AT91C_PE27_ERXER | AT91C_PE26_ERX1 | \
AT91C_PE25_ERX0 | AT91C_PE24_ETX1 | AT91C_PE23_ETX0 | AT91C_PE21_ETXCK)

Definition at line 68 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RW_01

#define AT91C_EMAC_RW_01   (1 << 28)

Definition at line 74 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RW_10

#define AT91C_EMAC_RW_10   (2 << 28)

Definition at line 75 of file sam9263_eth_driver.h.



Definition at line 89 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_BROADCAST   0x80000000

Definition at line 92 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_CFI   0x00010000

Definition at line 104 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_EOF   0x00008000

Definition at line 105 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_EXT_ADDR   0x10000000

Definition at line 95 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_LENGTH   0x00000FFF

Definition at line 108 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_MULTICAST_HASH   0x40000000

Definition at line 93 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_OFFSET   0x00003000

Definition at line 107 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_OWNERSHIP   0x00000001

Definition at line 91 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_PRIORITY_TAG   0x00100000

Definition at line 102 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_SAR1   0x04000000

Definition at line 96 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_SAR2   0x02000000

Definition at line 97 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_SAR3   0x01000000

Definition at line 98 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_SAR4   0x00800000

Definition at line 99 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_SOF   0x00004000

Definition at line 106 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_TYPE_ID   0x00400000

Definition at line 100 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_UNICAST_HASH   0x20000000

Definition at line 94 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_VLAN_PRIORITY   0x000E0000

Definition at line 103 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_VLAN_TAG   0x00200000

Definition at line 101 of file sam9263_eth_driver.h.


#define AT91C_EMAC_RX_WRAP   0x00000002

Definition at line 90 of file sam9263_eth_driver.h.


#define AT91C_EMAC_SOF_01   (1 << 30)

Definition at line 73 of file sam9263_eth_driver.h.


#define AT91C_EMAC_TX_ERROR   0x20000000

Definition at line 81 of file sam9263_eth_driver.h.


#define AT91C_EMAC_TX_EXHAUSTED   0x08000000

Definition at line 83 of file sam9263_eth_driver.h.


#define AT91C_EMAC_TX_LAST   0x00008000

Definition at line 85 of file sam9263_eth_driver.h.


#define AT91C_EMAC_TX_LENGTH   0x000007FF

Definition at line 86 of file sam9263_eth_driver.h.


#define AT91C_EMAC_TX_NO_CRC   0x00010000

Definition at line 84 of file sam9263_eth_driver.h.


#define AT91C_EMAC_TX_UNDERRUN   0x10000000

Definition at line 82 of file sam9263_eth_driver.h.


#define AT91C_EMAC_TX_USED   0x80000000

Definition at line 79 of file sam9263_eth_driver.h.


#define AT91C_EMAC_TX_WRAP   0x40000000

Definition at line 80 of file sam9263_eth_driver.h.


#define SAM9263_ETH_RX_BUFFER_COUNT   72

Definition at line 50 of file sam9263_eth_driver.h.


#define SAM9263_ETH_RX_BUFFER_SIZE   128

Definition at line 57 of file sam9263_eth_driver.h.


#define SAM9263_ETH_TX_BUFFER_COUNT   3

Definition at line 36 of file sam9263_eth_driver.h.


#define SAM9263_ETH_TX_BUFFER_SIZE   1536

Definition at line 43 of file sam9263_eth_driver.h.

Function Documentation

◆ emacIrqWrapper()

void emacIrqWrapper ( void  )

◆ sam9263EthDisableIrq()

void sam9263EthDisableIrq ( NetInterface interface)

Disable interrupts.

[in]interfaceUnderlying network interface

Definition at line 359 of file sam9263_eth_driver.c.

◆ sam9263EthEnableIrq()

void sam9263EthEnableIrq ( NetInterface interface)

Enable interrupts.

[in]interfaceUnderlying network interface

Definition at line 331 of file sam9263_eth_driver.c.

◆ sam9263EthEventHandler()

void sam9263EthEventHandler ( NetInterface interface)

SAM9263 Ethernet MAC event handler.

[in]interfaceUnderlying network interface

Definition at line 442 of file sam9263_eth_driver.c.

◆ sam9263EthInit()

error_t sam9263EthInit ( NetInterface interface)

SAM9263 Ethernet MAC initialization.

[in]interfaceUnderlying network interface
Error code

Definition at line 115 of file sam9263_eth_driver.c.

◆ sam9263EthInitBufferDesc()

void sam9263EthInitBufferDesc ( NetInterface interface)

Initialize buffer descriptors.

[in]interfaceUnderlying network interface

Definition at line 253 of file sam9263_eth_driver.c.

◆ sam9263EthInitGpio()

void sam9263EthInitGpio ( NetInterface interface)

◆ sam9263EthIrqHandler()

void sam9263EthIrqHandler ( void  )

SAM9263 Ethernet MAC interrupt service routine.

Definition at line 386 of file sam9263_eth_driver.c.

◆ sam9263EthReadPhyReg()

uint16_t sam9263EthReadPhyReg ( 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 884 of file sam9263_eth_driver.c.

◆ sam9263EthReceivePacket()

error_t sam9263EthReceivePacket ( NetInterface interface)

Receive a packet.

[in]interfaceUnderlying network interface
Error code

Definition at line 545 of file sam9263_eth_driver.c.

◆ sam9263EthSendPacket()

error_t sam9263EthSendPacket ( 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 478 of file sam9263_eth_driver.c.

◆ sam9263EthTick()

void sam9263EthTick ( NetInterface interface)

SAM9263 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 306 of file sam9263_eth_driver.c.

◆ sam9263EthUpdateMacAddrFilter()

error_t sam9263EthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

[in]interfaceUnderlying network interface
Error code

Definition at line 676 of file sam9263_eth_driver.c.

◆ sam9263EthUpdateMacConfig()

error_t sam9263EthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

[in]interfaceUnderlying network interface
Error code

Definition at line 802 of file sam9263_eth_driver.c.

◆ sam9263EthWritePhyReg()

void sam9263EthWritePhyReg ( 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 845 of file sam9263_eth_driver.c.

Variable Documentation

◆ sam9263EthDriver

const NicDriver sam9263EthDriver

SAM9263 Ethernet MAC driver.

Definition at line 88 of file sam9263_eth_driver.c.