sama5d2_eth_driver.h File Reference

SAMA5D2 Ethernet MAC controller. More...

Go to the source code of this file.

Data Structures

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

Macros

#define SAMA5D2_ETH_TX_BUFFER_COUNT   4
 
#define SAMA5D2_ETH_TX_BUFFER_SIZE   1536
 
#define SAMA5D2_ETH_RX_BUFFER_COUNT   96
 
#define SAMA5D2_ETH_RX_BUFFER_SIZE   128
 
#define SAMA5D2_ETH_DUMMY_BUFFER_COUNT   2
 
#define SAMA5D2_ETH_DUMMY_BUFFER_SIZE   128
 
#define SAMA5D2_ETH_IRQ_PRIORITY   0
 
#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_ADDRESS   0xFFFFFFFC
 
#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
 

Functions

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)
 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 phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t sama5d2EthReadPhyReg (uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 

Variables

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

Detailed Description

SAMA5D2 Ethernet MAC controller.

License

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.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
1.9.0

Definition in file sama5d2_eth_driver.h.

Macro Definition Documentation

◆ GMAC_RX_ADDRESS

#define GMAC_RX_ADDRESS   0xFFFFFFFC

Definition at line 94 of file sama5d2_eth_driver.h.

◆ GMAC_RX_BAD_FCS

#define GMAC_RX_BAD_FCS   0x00002000

Definition at line 113 of file sama5d2_eth_driver.h.

◆ GMAC_RX_BROADCAST

#define GMAC_RX_BROADCAST   0x80000000

Definition at line 97 of file sama5d2_eth_driver.h.

◆ GMAC_RX_CFI

#define GMAC_RX_CFI   0x00010000

Definition at line 109 of file sama5d2_eth_driver.h.

◆ GMAC_RX_CHECKSUM_VALID

#define GMAC_RX_CHECKSUM_VALID   0x00C00000

Definition at line 105 of file sama5d2_eth_driver.h.

◆ GMAC_RX_EOF

#define GMAC_RX_EOF   0x00008000

Definition at line 110 of file sama5d2_eth_driver.h.

◆ GMAC_RX_LENGTH

#define GMAC_RX_LENGTH   0x00001FFF

Definition at line 114 of file sama5d2_eth_driver.h.

◆ GMAC_RX_LENGTH_MSB

#define GMAC_RX_LENGTH_MSB   0x00002000

Definition at line 112 of file sama5d2_eth_driver.h.

◆ GMAC_RX_MULTICAST_HASH

#define GMAC_RX_MULTICAST_HASH   0x40000000

Definition at line 98 of file sama5d2_eth_driver.h.

◆ GMAC_RX_OWNERSHIP

#define GMAC_RX_OWNERSHIP   0x00000001

Definition at line 96 of file sama5d2_eth_driver.h.

◆ GMAC_RX_PRIORITY_TAG

#define GMAC_RX_PRIORITY_TAG   0x00100000

Definition at line 107 of file sama5d2_eth_driver.h.

◆ GMAC_RX_SAR

#define GMAC_RX_SAR   0x08000000

Definition at line 100 of file sama5d2_eth_driver.h.

◆ GMAC_RX_SAR_MASK

#define GMAC_RX_SAR_MASK   0x06000000

Definition at line 101 of file sama5d2_eth_driver.h.

◆ GMAC_RX_SNAP

#define GMAC_RX_SNAP   0x01000000

Definition at line 103 of file sama5d2_eth_driver.h.

◆ GMAC_RX_SOF

#define GMAC_RX_SOF   0x00004000

Definition at line 111 of file sama5d2_eth_driver.h.

◆ GMAC_RX_TYPE_ID

#define GMAC_RX_TYPE_ID   0x01000000

Definition at line 102 of file sama5d2_eth_driver.h.

◆ GMAC_RX_TYPE_ID_MASK

#define GMAC_RX_TYPE_ID_MASK   0x00C00000

Definition at line 104 of file sama5d2_eth_driver.h.

◆ GMAC_RX_UNICAST_HASH

#define GMAC_RX_UNICAST_HASH   0x20000000

Definition at line 99 of file sama5d2_eth_driver.h.

◆ GMAC_RX_VLAN_PRIORITY

#define GMAC_RX_VLAN_PRIORITY   0x000E0000

Definition at line 108 of file sama5d2_eth_driver.h.

◆ GMAC_RX_VLAN_TAG

#define GMAC_RX_VLAN_TAG   0x00200000

Definition at line 106 of file sama5d2_eth_driver.h.

◆ GMAC_RX_WRAP

#define GMAC_RX_WRAP   0x00000002

Definition at line 95 of file sama5d2_eth_driver.h.

◆ GMAC_TX_AHB_ERROR

#define GMAC_TX_AHB_ERROR   0x08000000

Definition at line 86 of file sama5d2_eth_driver.h.

◆ GMAC_TX_CHECKSUM_ERROR

#define GMAC_TX_CHECKSUM_ERROR   0x00700000

Definition at line 88 of file sama5d2_eth_driver.h.

◆ GMAC_TX_LAST

#define GMAC_TX_LAST   0x00008000

Definition at line 90 of file sama5d2_eth_driver.h.

◆ GMAC_TX_LATE_COL_ERROR

#define GMAC_TX_LATE_COL_ERROR   0x04000000

Definition at line 87 of file sama5d2_eth_driver.h.

◆ GMAC_TX_LENGTH

#define GMAC_TX_LENGTH   0x00003FFF

Definition at line 91 of file sama5d2_eth_driver.h.

◆ GMAC_TX_NO_CRC

#define GMAC_TX_NO_CRC   0x00010000

Definition at line 89 of file sama5d2_eth_driver.h.

◆ GMAC_TX_RLE_ERROR

#define GMAC_TX_RLE_ERROR   0x20000000

Definition at line 84 of file sama5d2_eth_driver.h.

◆ GMAC_TX_UNDERRUN_ERROR

#define GMAC_TX_UNDERRUN_ERROR   0x10000000

Definition at line 85 of file sama5d2_eth_driver.h.

◆ GMAC_TX_USED

#define GMAC_TX_USED   0x80000000

Definition at line 82 of file sama5d2_eth_driver.h.

◆ GMAC_TX_WRAP

#define GMAC_TX_WRAP   0x40000000

Definition at line 83 of file sama5d2_eth_driver.h.

◆ SAMA5D2_ETH_DUMMY_BUFFER_COUNT

#define SAMA5D2_ETH_DUMMY_BUFFER_COUNT   2

Definition at line 62 of file sama5d2_eth_driver.h.

◆ SAMA5D2_ETH_DUMMY_BUFFER_SIZE

#define SAMA5D2_ETH_DUMMY_BUFFER_SIZE   128

Definition at line 69 of file sama5d2_eth_driver.h.

◆ SAMA5D2_ETH_IRQ_PRIORITY

#define SAMA5D2_ETH_IRQ_PRIORITY   0

Definition at line 76 of file sama5d2_eth_driver.h.

◆ SAMA5D2_ETH_RX_BUFFER_COUNT

#define SAMA5D2_ETH_RX_BUFFER_COUNT   96

Definition at line 48 of file sama5d2_eth_driver.h.

◆ SAMA5D2_ETH_RX_BUFFER_SIZE

#define SAMA5D2_ETH_RX_BUFFER_SIZE   128

Definition at line 55 of file sama5d2_eth_driver.h.

◆ SAMA5D2_ETH_TX_BUFFER_COUNT

#define SAMA5D2_ETH_TX_BUFFER_COUNT   4

Definition at line 34 of file sama5d2_eth_driver.h.

◆ SAMA5D2_ETH_TX_BUFFER_SIZE

#define SAMA5D2_ETH_TX_BUFFER_SIZE   1536

Definition at line 41 of file sama5d2_eth_driver.h.

Function Documentation

◆ sama5d2EthDisableIrq()

void sama5d2EthDisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 373 of file sama5d2_eth_driver.c.

◆ sama5d2EthEnableIrq()

void sama5d2EthEnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 359 of file sama5d2_eth_driver.c.

◆ sama5d2EthEventHandler()

void sama5d2EthEventHandler ( NetInterface interface)

SAMA5D2 Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 444 of file sama5d2_eth_driver.c.

◆ sama5d2EthInit()

error_t sama5d2EthInit ( NetInterface interface)

SAMA5D2 Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 149 of file sama5d2_eth_driver.c.

◆ sama5d2EthInitBufferDesc()

void sama5d2EthInitBufferDesc ( NetInterface interface)

Initialize buffer descriptors.

Parameters
[in]interfaceUnderlying network interface

Definition at line 261 of file sama5d2_eth_driver.c.

◆ sama5d2EthInitGpio()

void sama5d2EthInitGpio ( NetInterface interface)

◆ sama5d2EthIrqHandler()

void sama5d2EthIrqHandler ( void  )

SAMA5D2 Ethernet MAC interrupt service routine.

Definition at line 386 of file sama5d2_eth_driver.c.

◆ sama5d2EthReadPhyReg()

uint16_t sama5d2EthReadPhyReg ( uint8_t  phyAddr,
uint8_t  regAddr 
)

Read PHY register.

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

Definition at line 784 of file sama5d2_eth_driver.c.

◆ sama5d2EthReceivePacket()

error_t sama5d2EthReceivePacket ( NetInterface interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 546 of file sama5d2_eth_driver.c.

◆ sama5d2EthSendPacket()

error_t sama5d2EthSendPacket ( NetInterface interface,
const NetBuffer buffer,
size_t  offset 
)

Send a packet.

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

Definition at line 478 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

Parameters
[in]interfaceUnderlying network interface

Definition at line 347 of file sama5d2_eth_driver.c.

◆ sama5d2EthUpdateMacAddrFilter()

error_t sama5d2EthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 660 of file sama5d2_eth_driver.c.

◆ sama5d2EthUpdateMacConfig()

error_t sama5d2EthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 723 of file sama5d2_eth_driver.c.

◆ sama5d2EthWritePhyReg()

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

Write PHY register.

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

Definition at line 757 of file sama5d2_eth_driver.c.

Variable Documentation

◆ sama5d2EthDriver

const NicDriver sama5d2EthDriver

SAMA5D2 Ethernet MAC driver.

Definition at line 122 of file sama5d2_eth_driver.c.