samv71_eth_driver.h File Reference

SAMV71 Ethernet MAC controller. More...

Go to the source code of this file.

Data Structures

struct  Samv71TxBufferDesc
 Transmit buffer descriptor. More...
struct  Samv71RxBufferDesc
 Receive buffer descriptor. More...


#define SAMV71_ETH_TX_BUFFER_SIZE   1536
#define SAMV71_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 samv71EthInit (NetInterface *interface)
 SAMV71 Ethernet MAC initialization. More...
void samv71EthInitGpio (NetInterface *interface)
void samv71EthInitBufferDesc (NetInterface *interface)
 Initialize buffer descriptors. More...
void samv71EthTick (NetInterface *interface)
 SAMV71 Ethernet MAC timer handler. More...
void samv71EthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
void samv71EthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
void samv71EthEventHandler (NetInterface *interface)
 SAMV71 Ethernet MAC event handler. More...
error_t samv71EthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset)
 Send a packet. More...
error_t samv71EthReceivePacket (NetInterface *interface)
 Receive a packet. More...
error_t samv71EthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
error_t samv71EthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
void samv71EthWritePhyReg (uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
uint16_t samv71EthReadPhyReg (uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...


const NicDriver samv71EthDriver
 SAMV71 Ethernet MAC driver. More...

Detailed Description

SAMV71 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 samv71_eth_driver.h.

Macro Definition Documentation


#define PIO_PD6A_GRX1

Definition at line 96 of file samv71_eth_driver.h.



Definition at line 113 of file samv71_eth_driver.h.


#define GMAC_RX_BAD_FCS   0x00002000

Definition at line 132 of file samv71_eth_driver.h.


#define GMAC_RX_BROADCAST   0x80000000

Definition at line 116 of file samv71_eth_driver.h.


#define GMAC_RX_CFI   0x00010000

Definition at line 128 of file samv71_eth_driver.h.


#define GMAC_RX_CHECKSUM_VALID   0x00C00000

Definition at line 124 of file samv71_eth_driver.h.


#define GMAC_RX_EOF   0x00008000

Definition at line 129 of file samv71_eth_driver.h.


#define GMAC_RX_LENGTH   0x00001FFF

Definition at line 133 of file samv71_eth_driver.h.


#define GMAC_RX_LENGTH_MSB   0x00002000

Definition at line 131 of file samv71_eth_driver.h.


#define GMAC_RX_MULTICAST_HASH   0x40000000

Definition at line 117 of file samv71_eth_driver.h.


#define GMAC_RX_OWNERSHIP   0x00000001

Definition at line 115 of file samv71_eth_driver.h.


#define GMAC_RX_PRIORITY_TAG   0x00100000

Definition at line 126 of file samv71_eth_driver.h.


#define GMAC_RX_SAR   0x08000000

Definition at line 119 of file samv71_eth_driver.h.


#define GMAC_RX_SAR_MASK   0x06000000

Definition at line 120 of file samv71_eth_driver.h.


#define GMAC_RX_SNAP   0x01000000

Definition at line 122 of file samv71_eth_driver.h.


#define GMAC_RX_SOF   0x00004000

Definition at line 130 of file samv71_eth_driver.h.


#define GMAC_RX_TYPE_ID   0x01000000

Definition at line 121 of file samv71_eth_driver.h.


#define GMAC_RX_TYPE_ID_MASK   0x00C00000

Definition at line 123 of file samv71_eth_driver.h.


#define GMAC_RX_UNICAST_HASH   0x20000000

Definition at line 118 of file samv71_eth_driver.h.


#define GMAC_RX_VLAN_PRIORITY   0x000E0000

Definition at line 127 of file samv71_eth_driver.h.


#define GMAC_RX_VLAN_TAG   0x00200000

Definition at line 125 of file samv71_eth_driver.h.


#define GMAC_RX_WRAP   0x00000002

Definition at line 114 of file samv71_eth_driver.h.


#define GMAC_TX_AHB_ERROR   0x08000000

Definition at line 105 of file samv71_eth_driver.h.


#define GMAC_TX_CHECKSUM_ERROR   0x00700000

Definition at line 107 of file samv71_eth_driver.h.


#define GMAC_TX_LAST   0x00008000

Definition at line 109 of file samv71_eth_driver.h.


#define GMAC_TX_LATE_COL_ERROR   0x04000000

Definition at line 106 of file samv71_eth_driver.h.


#define GMAC_TX_LENGTH   0x00003FFF

Definition at line 110 of file samv71_eth_driver.h.


#define GMAC_TX_NO_CRC   0x00010000

Definition at line 108 of file samv71_eth_driver.h.


#define GMAC_TX_RLE_ERROR   0x20000000

Definition at line 103 of file samv71_eth_driver.h.


#define GMAC_TX_UNDERRUN_ERROR   0x10000000

Definition at line 104 of file samv71_eth_driver.h.


#define GMAC_TX_USED   0x80000000

Definition at line 101 of file samv71_eth_driver.h.


#define GMAC_TX_WRAP   0x40000000

Definition at line 102 of file samv71_eth_driver.h.



Definition at line 62 of file samv71_eth_driver.h.



Definition at line 69 of file samv71_eth_driver.h.



Definition at line 83 of file samv71_eth_driver.h.



Definition at line 76 of file samv71_eth_driver.h.



Definition at line 90 of file samv71_eth_driver.h.



Definition at line 48 of file samv71_eth_driver.h.


#define SAMV71_ETH_RX_BUFFER_SIZE   128

Definition at line 55 of file samv71_eth_driver.h.



Definition at line 34 of file samv71_eth_driver.h.


#define SAMV71_ETH_TX_BUFFER_SIZE   1536

Definition at line 41 of file samv71_eth_driver.h.

Function Documentation

◆ samv71EthDisableIrq()

void samv71EthDisableIrq ( NetInterface interface)

Disable interrupts.

[in]interfaceUnderlying network interface

Definition at line 403 of file samv71_eth_driver.c.

◆ samv71EthEnableIrq()

void samv71EthEnableIrq ( NetInterface interface)

Enable interrupts.

[in]interfaceUnderlying network interface

Definition at line 389 of file samv71_eth_driver.c.

◆ samv71EthEventHandler()

void samv71EthEventHandler ( NetInterface interface)

SAMV71 Ethernet MAC event handler.

[in]interfaceUnderlying network interface

Definition at line 474 of file samv71_eth_driver.c.

◆ samv71EthInit()

error_t samv71EthInit ( NetInterface interface)

SAMV71 Ethernet MAC initialization.

[in]interfaceUnderlying network interface
Error code

Definition at line 147 of file samv71_eth_driver.c.

◆ samv71EthInitBufferDesc()

void samv71EthInitBufferDesc ( NetInterface interface)

Initialize buffer descriptors.

[in]interfaceUnderlying network interface

Definition at line 285 of file samv71_eth_driver.c.

◆ samv71EthInitGpio()

void samv71EthInitGpio ( NetInterface interface)

◆ samv71EthReadPhyReg()

uint16_t samv71EthReadPhyReg ( uint8_t  phyAddr,
uint8_t  regAddr 

Read PHY register.

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

Definition at line 816 of file samv71_eth_driver.c.

◆ samv71EthReceivePacket()

error_t samv71EthReceivePacket ( NetInterface interface)

Receive a packet.

[in]interfaceUnderlying network interface
Error code

Definition at line 578 of file samv71_eth_driver.c.

◆ samv71EthSendPacket()

error_t samv71EthSendPacket ( 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 508 of file samv71_eth_driver.c.

◆ samv71EthTick()

void samv71EthTick ( NetInterface interface)

SAMV71 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 377 of file samv71_eth_driver.c.

◆ samv71EthUpdateMacAddrFilter()

error_t samv71EthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

[in]interfaceUnderlying network interface
Error code

Definition at line 692 of file samv71_eth_driver.c.

◆ samv71EthUpdateMacConfig()

error_t samv71EthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

[in]interfaceUnderlying network interface
Error code

Definition at line 755 of file samv71_eth_driver.c.

◆ samv71EthWritePhyReg()

void samv71EthWritePhyReg ( uint8_t  phyAddr,
uint8_t  regAddr,
uint16_t  data 

Write PHY register.

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

Definition at line 789 of file samv71_eth_driver.c.

Variable Documentation

◆ samv71EthDriver

const NicDriver samv71EthDriver

SAMV71 Ethernet MAC driver.

Definition at line 120 of file samv71_eth_driver.c.