sam3x_eth_driver.h File Reference

SAM3X Ethernet MAC driver. More...

#include "core/nic.h"

Go to the source code of this file.

Data Structures
struct	Sam3xTxBufferDesc
	Transmit buffer descriptor. More...
struct	Sam3xRxBufferDesc
	Receive buffer descriptor. More...

Macros
#define	SAM3X_ETH_TX_BUFFER_COUNT   2
#define	SAM3X_ETH_TX_BUFFER_SIZE   1536
#define	SAM3X_ETH_RX_BUFFER_COUNT   48
#define	SAM3X_ETH_RX_BUFFER_SIZE   128
#define	SAM3X_ETH_IRQ_PRIORITY_GROUPING   3
#define	SAM3X_ETH_IRQ_GROUP_PRIORITY   12
#define	SAM3X_ETH_IRQ_SUB_PRIORITY   0
#define	EMAC_TX_USED   0x80000000
#define	EMAC_TX_WRAP   0x40000000
#define	EMAC_TX_ERROR   0x20000000
#define	EMAC_TX_UNDERRUN   0x10000000
#define	EMAC_TX_EXHAUSTED   0x08000000
#define	EMAC_TX_NO_CRC   0x00010000
#define	EMAC_TX_LAST   0x00008000
#define	EMAC_TX_LENGTH   0x000007FF
#define	EMAC_RX_ADDRESS   0xFFFFFFFC
#define	EMAC_RX_WRAP   0x00000002
#define	EMAC_RX_OWNERSHIP   0x00000001
#define	EMAC_RX_BROADCAST   0x80000000
#define	EMAC_RX_MULTICAST_HASH   0x40000000
#define	EMAC_RX_UNICAST_HASH   0x20000000
#define	EMAC_RX_EXT_ADDR   0x10000000
#define	EMAC_RX_SAR1   0x04000000
#define	EMAC_RX_SAR2   0x02000000
#define	EMAC_RX_SAR3   0x01000000
#define	EMAC_RX_SAR4   0x00800000
#define	EMAC_RX_TYPE_ID   0x00400000
#define	EMAC_RX_VLAN_TAG   0x00200000
#define	EMAC_RX_PRIORITY_TAG   0x00100000
#define	EMAC_RX_VLAN_PRIORITY   0x000E0000
#define	EMAC_RX_CFI   0x00010000
#define	EMAC_RX_EOF   0x00008000
#define	EMAC_RX_SOF   0x00004000
#define	EMAC_RX_OFFSET   0x00003000
#define	EMAC_RX_LENGTH   0x00000FFF

Functions
error_t	sam3xEthInit (NetInterface *interface)
	SAM3X Ethernet MAC initialization. More...
void	sam3xEthInitGpio (NetInterface *interface)
	GPIO configuration. More...
void	sam3xEthInitBufferDesc (NetInterface *interface)
	Initialize buffer descriptors. More...
void	sam3xEthTick (NetInterface *interface)
	SAM3X Ethernet MAC timer handler. More...
void	sam3xEthEnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	sam3xEthDisableIrq (NetInterface *interface)
	Disable interrupts. More...
void	sam3xEthEventHandler (NetInterface *interface)
	SAM3X Ethernet MAC event handler. More...
error_t	sam3xEthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
	Send a packet. More...
error_t	sam3xEthReceivePacket (NetInterface *interface)
	Receive a packet. More...
error_t	sam3xEthUpdateMacAddrFilter (NetInterface *interface)
	Configure MAC address filtering. More...
error_t	sam3xEthUpdateMacConfig (NetInterface *interface)
	Adjust MAC configuration parameters for proper operation. More...
void	sam3xEthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
	Write PHY register. More...
uint16_t	sam3xEthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
	Read PHY register. More...

Variables
const NicDriver	sam3xEthDriver
	SAM3X Ethernet MAC driver. More...

Detailed Description

SAM3X Ethernet MAC driver.

License

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

Copyright (C) 2010-2025 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

2.5.4

Definition in file sam3x_eth_driver.h.

Macro Definition Documentation

EMAC_RX_ADDRESS

#define EMAC_RX_ADDRESS   0xFFFFFFFC

Definition at line 97 of file sam3x_eth_driver.h.

EMAC_RX_BROADCAST

#define EMAC_RX_BROADCAST   0x80000000

Definition at line 100 of file sam3x_eth_driver.h.

EMAC_RX_CFI

#define EMAC_RX_CFI   0x00010000

Definition at line 112 of file sam3x_eth_driver.h.

EMAC_RX_EOF

#define EMAC_RX_EOF   0x00008000

Definition at line 113 of file sam3x_eth_driver.h.

EMAC_RX_EXT_ADDR

#define EMAC_RX_EXT_ADDR   0x10000000

Definition at line 103 of file sam3x_eth_driver.h.

EMAC_RX_LENGTH

#define EMAC_RX_LENGTH   0x00000FFF

Definition at line 116 of file sam3x_eth_driver.h.

EMAC_RX_MULTICAST_HASH

#define EMAC_RX_MULTICAST_HASH   0x40000000

Definition at line 101 of file sam3x_eth_driver.h.

EMAC_RX_OFFSET

#define EMAC_RX_OFFSET   0x00003000

Definition at line 115 of file sam3x_eth_driver.h.

EMAC_RX_OWNERSHIP

#define EMAC_RX_OWNERSHIP   0x00000001

Definition at line 99 of file sam3x_eth_driver.h.

EMAC_RX_PRIORITY_TAG

#define EMAC_RX_PRIORITY_TAG   0x00100000

Definition at line 110 of file sam3x_eth_driver.h.

EMAC_RX_SAR1

#define EMAC_RX_SAR1   0x04000000

Definition at line 104 of file sam3x_eth_driver.h.

EMAC_RX_SAR2

#define EMAC_RX_SAR2   0x02000000

Definition at line 105 of file sam3x_eth_driver.h.

EMAC_RX_SAR3

#define EMAC_RX_SAR3   0x01000000

Definition at line 106 of file sam3x_eth_driver.h.

EMAC_RX_SAR4

#define EMAC_RX_SAR4   0x00800000

Definition at line 107 of file sam3x_eth_driver.h.

EMAC_RX_SOF

#define EMAC_RX_SOF   0x00004000

Definition at line 114 of file sam3x_eth_driver.h.

EMAC_RX_TYPE_ID

#define EMAC_RX_TYPE_ID   0x00400000

Definition at line 108 of file sam3x_eth_driver.h.

EMAC_RX_UNICAST_HASH

#define EMAC_RX_UNICAST_HASH   0x20000000

Definition at line 102 of file sam3x_eth_driver.h.

EMAC_RX_VLAN_PRIORITY

#define EMAC_RX_VLAN_PRIORITY   0x000E0000

Definition at line 111 of file sam3x_eth_driver.h.

EMAC_RX_VLAN_TAG

#define EMAC_RX_VLAN_TAG   0x00200000

Definition at line 109 of file sam3x_eth_driver.h.

EMAC_RX_WRAP

#define EMAC_RX_WRAP   0x00000002

Definition at line 98 of file sam3x_eth_driver.h.

EMAC_TX_ERROR

#define EMAC_TX_ERROR   0x20000000

Definition at line 89 of file sam3x_eth_driver.h.

EMAC_TX_EXHAUSTED

#define EMAC_TX_EXHAUSTED   0x08000000

Definition at line 91 of file sam3x_eth_driver.h.

EMAC_TX_LAST

#define EMAC_TX_LAST   0x00008000

Definition at line 93 of file sam3x_eth_driver.h.

EMAC_TX_LENGTH

#define EMAC_TX_LENGTH   0x000007FF

Definition at line 94 of file sam3x_eth_driver.h.

EMAC_TX_NO_CRC

#define EMAC_TX_NO_CRC   0x00010000

Definition at line 92 of file sam3x_eth_driver.h.

EMAC_TX_UNDERRUN

#define EMAC_TX_UNDERRUN   0x10000000

Definition at line 90 of file sam3x_eth_driver.h.

EMAC_TX_USED

#define EMAC_TX_USED   0x80000000

Definition at line 87 of file sam3x_eth_driver.h.

EMAC_TX_WRAP

#define EMAC_TX_WRAP   0x40000000

Definition at line 88 of file sam3x_eth_driver.h.

SAM3X_ETH_IRQ_GROUP_PRIORITY

#define SAM3X_ETH_IRQ_GROUP_PRIORITY   12

Definition at line 74 of file sam3x_eth_driver.h.

SAM3X_ETH_IRQ_PRIORITY_GROUPING

#define SAM3X_ETH_IRQ_PRIORITY_GROUPING   3

Definition at line 67 of file sam3x_eth_driver.h.

SAM3X_ETH_IRQ_SUB_PRIORITY

#define SAM3X_ETH_IRQ_SUB_PRIORITY   0

Definition at line 81 of file sam3x_eth_driver.h.

SAM3X_ETH_RX_BUFFER_COUNT

#define SAM3X_ETH_RX_BUFFER_COUNT   48

Definition at line 53 of file sam3x_eth_driver.h.

SAM3X_ETH_RX_BUFFER_SIZE

#define SAM3X_ETH_RX_BUFFER_SIZE   128

Definition at line 60 of file sam3x_eth_driver.h.

SAM3X_ETH_TX_BUFFER_COUNT

#define SAM3X_ETH_TX_BUFFER_COUNT   2

Definition at line 39 of file sam3x_eth_driver.h.

SAM3X_ETH_TX_BUFFER_SIZE

#define SAM3X_ETH_TX_BUFFER_SIZE   1536

Definition at line 46 of file sam3x_eth_driver.h.

Function Documentation

sam3xEthDisableIrq()

void sam3xEthDisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 363 of file sam3x_eth_driver.c.

sam3xEthEnableIrq()

void sam3xEthEnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 335 of file sam3x_eth_driver.c.

sam3xEthEventHandler()

void sam3xEthEventHandler

(

NetInterface *

interface

)

SAM3X Ethernet MAC event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 444 of file sam3x_eth_driver.c.

sam3xEthInit()

error_t sam3xEthInit

(

NetInterface *

interface

)

SAM3X Ethernet MAC initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 115 of file sam3x_eth_driver.c.

sam3xEthInitBufferDesc()

void sam3xEthInitBufferDesc

(

NetInterface *

interface

)

Initialize buffer descriptors.

Parameters

[in]

interface

Underlying network interface

Definition at line 257 of file sam3x_eth_driver.c.

sam3xEthInitGpio()

void sam3xEthInitGpio

(

NetInterface *

interface

)

GPIO configuration.

Parameters

[in]

interface

Underlying network interface

Definition at line 223 of file sam3x_eth_driver.c.

sam3xEthReadPhyReg()

uint16_t sam3xEthReadPhyReg	(	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 887 of file sam3x_eth_driver.c.

sam3xEthReceivePacket()

error_t sam3xEthReceivePacket

(

NetInterface *

interface

)

Receive a packet.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 547 of file sam3x_eth_driver.c.

sam3xEthSendPacket()

error_t sam3xEthSendPacket	(	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 480 of file sam3x_eth_driver.c.

sam3xEthTick()

void sam3xEthTick

(

NetInterface *

interface

)

SAM3X 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 310 of file sam3x_eth_driver.c.

sam3xEthUpdateMacAddrFilter()

error_t sam3xEthUpdateMacAddrFilter

(

NetInterface *

interface

)

Configure MAC address filtering.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 679 of file sam3x_eth_driver.c.

sam3xEthUpdateMacConfig()

error_t sam3xEthUpdateMacConfig

(

NetInterface *

interface

)

Adjust MAC configuration parameters for proper operation.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 805 of file sam3x_eth_driver.c.

sam3xEthWritePhyReg()

void sam3xEthWritePhyReg	(	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 848 of file sam3x_eth_driver.c.

Variable Documentation

sam3xEthDriver

const NicDriver sam3xEthDriver

extern

SAM3X Ethernet MAC driver.

Definition at line 88 of file sam3x_eth_driver.c.