SAMV71 Ethernet MAC driver. More...

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	SAMV71_ETH_RAM_SECTION ".ram_no_cache"

#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)
	GPIO configuration. More...

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, NetTxAncillary *ancillary)
	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 driver.

License

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

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: 2.4.4

Definition in file samv71_eth_driver.h.

Macro Definition Documentation

◆ GMAC_RMII_MASK

#define GMAC_RMII_MASK

Value:

   (PIO_PD9A_GMAC_GMDIO | PIO_PD8A_GMAC_GMDC | \
   PIO_PD7A_GMAC_GRXER | PIO_PD6A_GMAC_GRX1 | PIO_PD5A_GMAC_GRX0 | \
   PIO_PD4A_GMAC_GRXDV | PIO_PD3A_GMAC_GTX1 | PIO_PD2A_GMAC_GTX0 | \
   PIO_PD1A_GMAC_GTXEN | PIO_PD0A_GMAC_GTXCK)

Definition at line 103 of file samv71_eth_driver.h.

◆ GMAC_RX_ADDRESS

#define GMAC_RX_ADDRESS 0xFFFFFFFC

Definition at line 121 of file samv71_eth_driver.h.

◆ GMAC_RX_BAD_FCS

#define GMAC_RX_BAD_FCS 0x00002000

Definition at line 140 of file samv71_eth_driver.h.

◆ GMAC_RX_BROADCAST

#define GMAC_RX_BROADCAST 0x80000000

Definition at line 124 of file samv71_eth_driver.h.

◆ GMAC_RX_CFI

#define GMAC_RX_CFI 0x00010000

Definition at line 136 of file samv71_eth_driver.h.

◆ GMAC_RX_CHECKSUM_VALID

#define GMAC_RX_CHECKSUM_VALID 0x00C00000

Definition at line 132 of file samv71_eth_driver.h.

◆ GMAC_RX_EOF

#define GMAC_RX_EOF 0x00008000

Definition at line 137 of file samv71_eth_driver.h.

◆ GMAC_RX_LENGTH

#define GMAC_RX_LENGTH 0x00001FFF

Definition at line 141 of file samv71_eth_driver.h.

◆ GMAC_RX_LENGTH_MSB

#define GMAC_RX_LENGTH_MSB 0x00002000

Definition at line 139 of file samv71_eth_driver.h.

◆ GMAC_RX_MULTICAST_HASH

#define GMAC_RX_MULTICAST_HASH 0x40000000

Definition at line 125 of file samv71_eth_driver.h.

◆ GMAC_RX_OWNERSHIP

#define GMAC_RX_OWNERSHIP 0x00000001

Definition at line 123 of file samv71_eth_driver.h.

◆ GMAC_RX_PRIORITY_TAG

#define GMAC_RX_PRIORITY_TAG 0x00100000

Definition at line 134 of file samv71_eth_driver.h.

◆ GMAC_RX_SAR

#define GMAC_RX_SAR 0x08000000

Definition at line 127 of file samv71_eth_driver.h.

◆ GMAC_RX_SAR_MASK

#define GMAC_RX_SAR_MASK 0x06000000

Definition at line 128 of file samv71_eth_driver.h.

◆ GMAC_RX_SNAP

#define GMAC_RX_SNAP 0x01000000

Definition at line 130 of file samv71_eth_driver.h.

◆ GMAC_RX_SOF

#define GMAC_RX_SOF 0x00004000

Definition at line 138 of file samv71_eth_driver.h.

◆ GMAC_RX_TYPE_ID

#define GMAC_RX_TYPE_ID 0x01000000

Definition at line 129 of file samv71_eth_driver.h.

◆ GMAC_RX_TYPE_ID_MASK

#define GMAC_RX_TYPE_ID_MASK 0x00C00000

Definition at line 131 of file samv71_eth_driver.h.

◆ GMAC_RX_UNICAST_HASH

#define GMAC_RX_UNICAST_HASH 0x20000000

Definition at line 126 of file samv71_eth_driver.h.

◆ GMAC_RX_VLAN_PRIORITY

#define GMAC_RX_VLAN_PRIORITY 0x000E0000

Definition at line 135 of file samv71_eth_driver.h.

◆ GMAC_RX_VLAN_TAG

#define GMAC_RX_VLAN_TAG 0x00200000

Definition at line 133 of file samv71_eth_driver.h.

◆ GMAC_RX_WRAP

#define GMAC_RX_WRAP 0x00000002

Definition at line 122 of file samv71_eth_driver.h.

◆ GMAC_TX_AHB_ERROR

#define GMAC_TX_AHB_ERROR 0x08000000

Definition at line 113 of file samv71_eth_driver.h.

◆ GMAC_TX_CHECKSUM_ERROR

#define GMAC_TX_CHECKSUM_ERROR 0x00700000

Definition at line 115 of file samv71_eth_driver.h.

◆ GMAC_TX_LAST

#define GMAC_TX_LAST 0x00008000

Definition at line 117 of file samv71_eth_driver.h.

◆ GMAC_TX_LATE_COL_ERROR

#define GMAC_TX_LATE_COL_ERROR 0x04000000

Definition at line 114 of file samv71_eth_driver.h.

◆ GMAC_TX_LENGTH

#define GMAC_TX_LENGTH 0x00003FFF

Definition at line 118 of file samv71_eth_driver.h.

◆ GMAC_TX_NO_CRC

#define GMAC_TX_NO_CRC 0x00010000

Definition at line 116 of file samv71_eth_driver.h.

◆ GMAC_TX_RLE_ERROR

#define GMAC_TX_RLE_ERROR 0x20000000

Definition at line 111 of file samv71_eth_driver.h.

◆ GMAC_TX_UNDERRUN_ERROR

#define GMAC_TX_UNDERRUN_ERROR 0x10000000

Definition at line 112 of file samv71_eth_driver.h.

◆ GMAC_TX_USED

#define GMAC_TX_USED 0x80000000

Definition at line 109 of file samv71_eth_driver.h.

◆ GMAC_TX_WRAP

#define GMAC_TX_WRAP 0x40000000

Definition at line 110 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_RAM_SECTION

#define SAMV71_ETH_RAM_SECTION ".ram_no_cache"

Definition at line 99 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] interface Underlying network interface

Definition at line 463 of file samv71_eth_driver.c.

◆ samv71EthEnableIrq()

void samv71EthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 435 of file samv71_eth_driver.c.

◆ samv71EthEventHandler()

void samv71EthEventHandler ( NetInterface * interface )

SAMV71 Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 551 of file samv71_eth_driver.c.

◆ samv71EthInit()

error_t samv71EthInit ( NetInterface * interface )

SAMV71 Ethernet MAC initialization.

Parameters

[in] interface Underlying 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] interface Underlying network interface

Definition at line 318 of file samv71_eth_driver.c.

◆ samv71EthInitGpio()

void samv71EthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 280 of file samv71_eth_driver.c.

◆ samv71EthReadPhyReg()

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

Read PHY register.

Parameters

[in]	opcode	Access type (2 bits)
[in]	phyAddr	PHY address (5 bits)
[in]	regAddr	Register address (5 bits)

Returns: Register value

Definition at line 1030 of file samv71_eth_driver.c.

◆ samv71EthReceivePacket()

error_t samv71EthReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 658 of file samv71_eth_driver.c.

◆ samv71EthSendPacket()

error_t samv71EthSendPacket	(	NetInterface *	interface,
		const NetBuffer *	buffer,
		size_t	offset,
		NetTxAncillary *	ancillary
	)

Send a packet.

Parameters

[in]	interface	Underlying network interface
[in]	buffer	Multi-part buffer containing the data to send
[in]	offset	Offset to the first data byte
[in]	ancillary	Additional options passed to the stack along with the packet

Returns: Error code

Definition at line 588 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] interface Underlying network interface

Definition at line 410 of file samv71_eth_driver.c.

◆ samv71EthUpdateMacAddrFilter()

error_t samv71EthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 790 of file samv71_eth_driver.c.

◆ samv71EthUpdateMacConfig()

error_t samv71EthUpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 948 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]	opcode	Access type (2 bits)
[in]	phyAddr	PHY address (5 bits)
[in]	regAddr	Register address (5 bits)
[in]	data	Register value

Definition at line 991 of file samv71_eth_driver.c.

Variable Documentation

◆ samv71EthDriver

const NicDriver samv71EthDriver

extern

SAMV71 Ethernet MAC driver.

Definition at line 122 of file samv71_eth_driver.c.

Data Structures

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ GMAC_RMII_MASK

◆ GMAC_RX_ADDRESS

◆ GMAC_RX_BAD_FCS

◆ GMAC_RX_BROADCAST

◆ GMAC_RX_CFI

◆ GMAC_RX_CHECKSUM_VALID

◆ GMAC_RX_EOF

◆ GMAC_RX_LENGTH

◆ GMAC_RX_LENGTH_MSB

◆ GMAC_RX_MULTICAST_HASH

◆ GMAC_RX_OWNERSHIP

◆ GMAC_RX_PRIORITY_TAG

◆ GMAC_RX_SAR

◆ GMAC_RX_SAR_MASK

◆ GMAC_RX_SNAP

◆ GMAC_RX_SOF

◆ GMAC_RX_TYPE_ID

◆ GMAC_RX_TYPE_ID_MASK

◆ GMAC_RX_UNICAST_HASH

◆ GMAC_RX_VLAN_PRIORITY

◆ GMAC_RX_VLAN_TAG

◆ GMAC_RX_WRAP

◆ GMAC_TX_AHB_ERROR

◆ GMAC_TX_CHECKSUM_ERROR

◆ GMAC_TX_LAST

◆ GMAC_TX_LATE_COL_ERROR

◆ GMAC_TX_LENGTH

◆ GMAC_TX_NO_CRC

◆ GMAC_TX_RLE_ERROR

◆ GMAC_TX_UNDERRUN_ERROR

◆ GMAC_TX_USED

◆ GMAC_TX_WRAP

◆ SAMV71_ETH_DUMMY_BUFFER_COUNT

◆ SAMV71_ETH_DUMMY_BUFFER_SIZE

◆ SAMV71_ETH_IRQ_GROUP_PRIORITY

◆ SAMV71_ETH_IRQ_PRIORITY_GROUPING

◆ SAMV71_ETH_IRQ_SUB_PRIORITY

◆ SAMV71_ETH_RAM_SECTION

◆ SAMV71_ETH_RX_BUFFER_COUNT

◆ SAMV71_ETH_RX_BUFFER_SIZE

◆ SAMV71_ETH_TX_BUFFER_COUNT

◆ SAMV71_ETH_TX_BUFFER_SIZE

Function Documentation

◆ samv71EthDisableIrq()

◆ samv71EthEnableIrq()

◆ samv71EthEventHandler()

◆ samv71EthInit()

◆ samv71EthInitBufferDesc()

◆ samv71EthInitGpio()

◆ samv71EthReadPhyReg()

◆ samv71EthReceivePacket()

◆ samv71EthSendPacket()

◆ samv71EthTick()

◆ samv71EthUpdateMacAddrFilter()

◆ samv71EthUpdateMacConfig()

◆ samv71EthWritePhyReg()

Variable Documentation

◆ samv71EthDriver