SAM3X Ethernet MAC driver. More...

#include <limits.h>
#include "sam3xa.h"
#include "core/net.h"
#include "drivers/mac/sam3x_eth_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	sam3xEthInit (NetInterface *interface)
	SAM3X Ethernet MAC initialization. More...

__weak_func 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	EMAC_Handler (void)
	SAM3X Ethernet MAC interrupt service routine. 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

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

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file sam3x_eth_driver.c.

Function Documentation

◆ EMAC_Handler()

void EMAC_Handler ( void )

SAM3X Ethernet MAC interrupt service routine.

Definition at line 383 of file sam3x_eth_driver.c.

◆ sam3xEthDisableIrq()

void sam3xEthDisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 356 of file sam3x_eth_driver.c.

◆ sam3xEthEnableIrq()

void sam3xEthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 328 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 437 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 250 of file sam3x_eth_driver.c.

◆ sam3xEthInitGpio()

__weak_func 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 880 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 540 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 473 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 303 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 672 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 798 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 841 of file sam3x_eth_driver.c.

Variable Documentation

◆ sam3xEthDriver

const NicDriver sam3xEthDriver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   sam3xEthInit,
   sam3xEthTick,
   sam3xEthEnableIrq,
   sam3xEthDisableIrq,
   sam3xEthEventHandler,
   sam3xEthSendPacket,
   sam3xEthUpdateMacAddrFilter,
   sam3xEthUpdateMacConfig,
   sam3xEthWritePhyReg,
   sam3xEthReadPhyReg,
   TRUE,
   TRUE,
   TRUE,
   FALSE
}

SAM3X Ethernet MAC driver.

Definition at line 88 of file sam3x_eth_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ EMAC_Handler()

◆ sam3xEthDisableIrq()

◆ sam3xEthEnableIrq()

◆ sam3xEthEventHandler()

◆ sam3xEthInit()

◆ sam3xEthInitBufferDesc()

◆ sam3xEthInitGpio()

◆ sam3xEthReadPhyReg()

◆ sam3xEthReceivePacket()

◆ sam3xEthSendPacket()

◆ sam3xEthTick()

◆ sam3xEthUpdateMacAddrFilter()

◆ sam3xEthUpdateMacConfig()

◆ sam3xEthWritePhyReg()

Variable Documentation

◆ sam3xEthDriver