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...
 

Macros

#define SAMV71_ETH_TX_BUFFER_COUNT   4
 
#define SAMV71_ETH_TX_BUFFER_SIZE   1536
 
#define SAMV71_ETH_RX_BUFFER_COUNT   96
 
#define SAMV71_ETH_RX_BUFFER_SIZE   128
 
#define SAMV71_ETH_DUMMY_BUFFER_COUNT   2
 
#define SAMV71_ETH_DUMMY_BUFFER_SIZE   128
 
#define SAMV71_ETH_IRQ_PRIORITY_GROUPING   4
 
#define SAMV71_ETH_IRQ_GROUP_PRIORITY   6
 
#define SAMV71_ETH_IRQ_SUB_PRIORITY   0
 
#define PIO_PD9A_GMDIO   PIO_PD9A_GMAC_GMDIO
 
#define PIO_PD8A_GMDC   PIO_PD8A_GMAC_GMDC
 
#define PIO_PD7A_GRXER   PIO_PD7A_GMAC_GRXER
 
#define PIO_PD6A_GRX1   PIO_PD6A_GMAC_GRX1
 
#define PIO_PD5A_GRX0   PIO_PD5A_GMAC_GRX0
 
#define PIO_PD4A_GRXDV   PIO_PD4A_GMAC_GRXDV
 
#define PIO_PD3A_GTX1   PIO_PD3A_GMAC_GTX1
 
#define PIO_PD2A_GTX0   PIO_PD2A_GMAC_GTX0
 
#define PIO_PD1A_GTXEN   PIO_PD1A_GMAC_GTXEN
 
#define PIO_PD0A_GTXCK   PIO_PD0A_GMAC_GTXCK
 
#define GMAC_SA   GmacSa
 
#define GMAC_RMII_MASK
 
#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 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 opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t samv71EthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 

Variables

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

Detailed Description

SAMV71 Ethernet MAC controller.

License

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

Copyright (C) 2010-2019 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.6

Definition in file samv71_eth_driver.h.

Macro Definition Documentation

◆ GMAC_RMII_MASK

#define GMAC_RMII_MASK
Value:

Definition at line 113 of file samv71_eth_driver.h.

◆ GMAC_RX_ADDRESS

#define GMAC_RX_ADDRESS   0xFFFFFFFC

Definition at line 130 of file samv71_eth_driver.h.

◆ GMAC_RX_BAD_FCS

#define GMAC_RX_BAD_FCS   0x00002000

Definition at line 149 of file samv71_eth_driver.h.

◆ GMAC_RX_BROADCAST

#define GMAC_RX_BROADCAST   0x80000000

Definition at line 133 of file samv71_eth_driver.h.

◆ GMAC_RX_CFI

#define GMAC_RX_CFI   0x00010000

Definition at line 145 of file samv71_eth_driver.h.

◆ GMAC_RX_CHECKSUM_VALID

#define GMAC_RX_CHECKSUM_VALID   0x00C00000

Definition at line 141 of file samv71_eth_driver.h.

◆ GMAC_RX_EOF

#define GMAC_RX_EOF   0x00008000

Definition at line 146 of file samv71_eth_driver.h.

◆ GMAC_RX_LENGTH

#define GMAC_RX_LENGTH   0x00001FFF

Definition at line 150 of file samv71_eth_driver.h.

◆ GMAC_RX_LENGTH_MSB

#define GMAC_RX_LENGTH_MSB   0x00002000

Definition at line 148 of file samv71_eth_driver.h.

◆ GMAC_RX_MULTICAST_HASH

#define GMAC_RX_MULTICAST_HASH   0x40000000

Definition at line 134 of file samv71_eth_driver.h.

◆ GMAC_RX_OWNERSHIP

#define GMAC_RX_OWNERSHIP   0x00000001

Definition at line 132 of file samv71_eth_driver.h.

◆ GMAC_RX_PRIORITY_TAG

#define GMAC_RX_PRIORITY_TAG   0x00100000

Definition at line 143 of file samv71_eth_driver.h.

◆ GMAC_RX_SAR

#define GMAC_RX_SAR   0x08000000

Definition at line 136 of file samv71_eth_driver.h.

◆ GMAC_RX_SAR_MASK

#define GMAC_RX_SAR_MASK   0x06000000

Definition at line 137 of file samv71_eth_driver.h.

◆ GMAC_RX_SNAP

#define GMAC_RX_SNAP   0x01000000

Definition at line 139 of file samv71_eth_driver.h.

◆ GMAC_RX_SOF

#define GMAC_RX_SOF   0x00004000

Definition at line 147 of file samv71_eth_driver.h.

◆ GMAC_RX_TYPE_ID

#define GMAC_RX_TYPE_ID   0x01000000

Definition at line 138 of file samv71_eth_driver.h.

◆ GMAC_RX_TYPE_ID_MASK

#define GMAC_RX_TYPE_ID_MASK   0x00C00000

Definition at line 140 of file samv71_eth_driver.h.

◆ GMAC_RX_UNICAST_HASH

#define GMAC_RX_UNICAST_HASH   0x20000000

Definition at line 135 of file samv71_eth_driver.h.

◆ GMAC_RX_VLAN_PRIORITY

#define GMAC_RX_VLAN_PRIORITY   0x000E0000

Definition at line 144 of file samv71_eth_driver.h.

◆ GMAC_RX_VLAN_TAG

#define GMAC_RX_VLAN_TAG   0x00200000

Definition at line 142 of file samv71_eth_driver.h.

◆ GMAC_RX_WRAP

#define GMAC_RX_WRAP   0x00000002

Definition at line 131 of file samv71_eth_driver.h.

◆ GMAC_SA

#define GMAC_SA   GmacSa

Definition at line 109 of file samv71_eth_driver.h.

◆ GMAC_TX_AHB_ERROR

#define GMAC_TX_AHB_ERROR   0x08000000

Definition at line 122 of file samv71_eth_driver.h.

◆ GMAC_TX_CHECKSUM_ERROR

#define GMAC_TX_CHECKSUM_ERROR   0x00700000

Definition at line 124 of file samv71_eth_driver.h.

◆ GMAC_TX_LAST

#define GMAC_TX_LAST   0x00008000

Definition at line 126 of file samv71_eth_driver.h.

◆ GMAC_TX_LATE_COL_ERROR

#define GMAC_TX_LATE_COL_ERROR   0x04000000

Definition at line 123 of file samv71_eth_driver.h.

◆ GMAC_TX_LENGTH

#define GMAC_TX_LENGTH   0x00003FFF

Definition at line 127 of file samv71_eth_driver.h.

◆ GMAC_TX_NO_CRC

#define GMAC_TX_NO_CRC   0x00010000

Definition at line 125 of file samv71_eth_driver.h.

◆ GMAC_TX_RLE_ERROR

#define GMAC_TX_RLE_ERROR   0x20000000

Definition at line 120 of file samv71_eth_driver.h.

◆ GMAC_TX_UNDERRUN_ERROR

#define GMAC_TX_UNDERRUN_ERROR   0x10000000

Definition at line 121 of file samv71_eth_driver.h.

◆ GMAC_TX_USED

#define GMAC_TX_USED   0x80000000

Definition at line 118 of file samv71_eth_driver.h.

◆ GMAC_TX_WRAP

#define GMAC_TX_WRAP   0x40000000

Definition at line 119 of file samv71_eth_driver.h.

◆ PIO_PD0A_GTXCK

#define PIO_PD0A_GTXCK   PIO_PD0A_GMAC_GTXCK

Definition at line 108 of file samv71_eth_driver.h.

◆ PIO_PD1A_GTXEN

#define PIO_PD1A_GTXEN   PIO_PD1A_GMAC_GTXEN

Definition at line 107 of file samv71_eth_driver.h.

◆ PIO_PD2A_GTX0

#define PIO_PD2A_GTX0   PIO_PD2A_GMAC_GTX0

Definition at line 106 of file samv71_eth_driver.h.

◆ PIO_PD3A_GTX1

#define PIO_PD3A_GTX1   PIO_PD3A_GMAC_GTX1

Definition at line 105 of file samv71_eth_driver.h.

◆ PIO_PD4A_GRXDV

#define PIO_PD4A_GRXDV   PIO_PD4A_GMAC_GRXDV

Definition at line 104 of file samv71_eth_driver.h.

◆ PIO_PD5A_GRX0

#define PIO_PD5A_GRX0   PIO_PD5A_GMAC_GRX0

Definition at line 103 of file samv71_eth_driver.h.

◆ PIO_PD6A_GRX1

#define PIO_PD6A_GRX1   PIO_PD6A_GMAC_GRX1

Definition at line 102 of file samv71_eth_driver.h.

◆ PIO_PD7A_GRXER

#define PIO_PD7A_GRXER   PIO_PD7A_GMAC_GRXER

Definition at line 101 of file samv71_eth_driver.h.

◆ PIO_PD8A_GMDC

#define PIO_PD8A_GMDC   PIO_PD8A_GMAC_GMDC

Definition at line 100 of file samv71_eth_driver.h.

◆ PIO_PD9A_GMDIO

#define PIO_PD9A_GMDIO   PIO_PD9A_GMAC_GMDIO

Definition at line 99 of file samv71_eth_driver.h.

◆ SAMV71_ETH_DUMMY_BUFFER_COUNT

#define SAMV71_ETH_DUMMY_BUFFER_COUNT   2

Definition at line 64 of file samv71_eth_driver.h.

◆ SAMV71_ETH_DUMMY_BUFFER_SIZE

#define SAMV71_ETH_DUMMY_BUFFER_SIZE   128

Definition at line 71 of file samv71_eth_driver.h.

◆ SAMV71_ETH_IRQ_GROUP_PRIORITY

#define SAMV71_ETH_IRQ_GROUP_PRIORITY   6

Definition at line 85 of file samv71_eth_driver.h.

◆ SAMV71_ETH_IRQ_PRIORITY_GROUPING

#define SAMV71_ETH_IRQ_PRIORITY_GROUPING   4

Definition at line 78 of file samv71_eth_driver.h.

◆ SAMV71_ETH_IRQ_SUB_PRIORITY

#define SAMV71_ETH_IRQ_SUB_PRIORITY   0

Definition at line 92 of file samv71_eth_driver.h.

◆ SAMV71_ETH_RX_BUFFER_COUNT

#define SAMV71_ETH_RX_BUFFER_COUNT   96

Definition at line 50 of file samv71_eth_driver.h.

◆ SAMV71_ETH_RX_BUFFER_SIZE

#define SAMV71_ETH_RX_BUFFER_SIZE   128

Definition at line 57 of file samv71_eth_driver.h.

◆ SAMV71_ETH_TX_BUFFER_COUNT

#define SAMV71_ETH_TX_BUFFER_COUNT   4

Definition at line 36 of file samv71_eth_driver.h.

◆ SAMV71_ETH_TX_BUFFER_SIZE

#define SAMV71_ETH_TX_BUFFER_SIZE   1536

Definition at line 43 of file samv71_eth_driver.h.

Function Documentation

◆ samv71EthDisableIrq()

void samv71EthDisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 411 of file samv71_eth_driver.c.

◆ samv71EthEnableIrq()

void samv71EthEnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 397 of file samv71_eth_driver.c.

◆ samv71EthEventHandler()

void samv71EthEventHandler ( NetInterface interface)

SAMV71 Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 482 of file samv71_eth_driver.c.

◆ samv71EthInit()

error_t samv71EthInit ( NetInterface interface)

SAMV71 Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 149 of file samv71_eth_driver.c.

◆ samv71EthInitBufferDesc()

void samv71EthInitBufferDesc ( NetInterface interface)

Initialize buffer descriptors.

Parameters
[in]interfaceUnderlying network interface

Definition at line 293 of file samv71_eth_driver.c.

◆ samv71EthInitGpio()

void samv71EthInitGpio ( NetInterface interface)

◆ samv71EthReadPhyReg()

uint16_t samv71EthReadPhyReg ( uint8_t  opcode,
uint8_t  phyAddr,
uint8_t  regAddr 
)

Read PHY register.

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

Definition at line 928 of file samv71_eth_driver.c.

◆ samv71EthReceivePacket()

error_t samv71EthReceivePacket ( NetInterface interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 586 of file samv71_eth_driver.c.

◆ samv71EthSendPacket()

error_t samv71EthSendPacket ( 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 516 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

Parameters
[in]interfaceUnderlying network interface

Definition at line 385 of file samv71_eth_driver.c.

◆ samv71EthUpdateMacAddrFilter()

error_t samv71EthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 700 of file samv71_eth_driver.c.

◆ samv71EthUpdateMacConfig()

error_t samv71EthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 854 of file samv71_eth_driver.c.

◆ samv71EthWritePhyReg()

void samv71EthWritePhyReg ( uint8_t  opcode,
uint8_t  phyAddr,
uint8_t  regAddr,
uint16_t  data 
)

Write PHY register.

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

Definition at line 889 of file samv71_eth_driver.c.

Variable Documentation

◆ samv71EthDriver

const NicDriver samv71EthDriver

SAMV71 Ethernet MAC driver.

Definition at line 122 of file samv71_eth_driver.c.

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