SAMA5D3 Gigabit Ethernet MAC driver (GMAC instance) More...

#include <limits.h>
#include "sama5d3x.h"
#include "core/net.h"
#include "drivers/mac/sama5d3_geth_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	sama5d3GigabitEthInit (NetInterface *interface)
	SAMA5D3 Ethernet MAC initialization. More...

__weak_func void	sama5d3GigabitEthInitGpio (NetInterface *interface)
	GPIO configuration. More...

void	sama5d3GigabitEthInitBufferDesc (NetInterface *interface)
	Initialize buffer descriptors. More...

void	sama5d3GigabitEthTick (NetInterface *interface)
	SAMA5D3 Ethernet MAC timer handler. More...

void	sama5d3GigabitEthEnableIrq (NetInterface *interface)
	Enable interrupts. More...

void	sama5d3GigabitEthDisableIrq (NetInterface *interface)
	Disable interrupts. More...

void	sama5d3GigabitEthIrqHandler (void)
	SAMA5D3 Ethernet MAC interrupt service routine. More...

void	sama5d3GigabitEthEventHandler (NetInterface *interface)
	SAMA5D3 Ethernet MAC event handler. More...

error_t	sama5d3GigabitEthSendPacket (NetInterface interface, const NetBuffer buffer, size_t offset, NetTxAncillary *ancillary)
	Send a packet. More...

error_t	sama5d3GigabitEthReceivePacket (NetInterface *interface)
	Receive a packet. More...

error_t	sama5d3GigabitEthUpdateMacAddrFilter (NetInterface *interface)
	Configure MAC address filtering. More...

error_t	sama5d3GigabitEthUpdateMacConfig (NetInterface *interface)
	Adjust MAC configuration parameters for proper operation. More...

void	sama5d3GigabitEthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
	Write PHY register. More...

uint16_t	sama5d3GigabitEthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
	Read PHY register. More...

Variables
const NicDriver	sama5d3GigabitEthDriver
	SAMA5D3 Ethernet MAC driver (GMAC instance) More...

Detailed Description

SAMA5D3 Gigabit Ethernet MAC driver (GMAC instance)

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

Definition in file sama5d3_geth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file sama5d3_geth_driver.c.

Function Documentation

◆ sama5d3GigabitEthDisableIrq()

void sama5d3GigabitEthDisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 360 of file sama5d3_geth_driver.c.

◆ sama5d3GigabitEthEnableIrq()

void sama5d3GigabitEthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 331 of file sama5d3_geth_driver.c.

◆ sama5d3GigabitEthEventHandler()

void sama5d3GigabitEthEventHandler ( NetInterface * interface )

SAMA5D3 Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 446 of file sama5d3_geth_driver.c.

◆ sama5d3GigabitEthInit()

error_t sama5d3GigabitEthInit ( NetInterface * interface )

SAMA5D3 Ethernet MAC initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 119 of file sama5d3_geth_driver.c.

◆ sama5d3GigabitEthInitBufferDesc()

void sama5d3GigabitEthInitBufferDesc ( NetInterface * interface )

Initialize buffer descriptors.

Parameters

[in] interface Underlying network interface

Definition at line 253 of file sama5d3_geth_driver.c.

◆ sama5d3GigabitEthInitGpio()

__weak_func void sama5d3GigabitEthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 225 of file sama5d3_geth_driver.c.

◆ sama5d3GigabitEthIrqHandler()

void sama5d3GigabitEthIrqHandler ( void )

SAMA5D3 Ethernet MAC interrupt service routine.

Definition at line 388 of file sama5d3_geth_driver.c.

◆ sama5d3GigabitEthReadPhyReg()

uint16_t sama5d3GigabitEthReadPhyReg	(	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 930 of file sama5d3_geth_driver.c.

◆ sama5d3GigabitEthReceivePacket()

error_t sama5d3GigabitEthReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 549 of file sama5d3_geth_driver.c.

◆ sama5d3GigabitEthSendPacket()

error_t sama5d3GigabitEthSendPacket	(	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 482 of file sama5d3_geth_driver.c.

◆ sama5d3GigabitEthTick()

void sama5d3GigabitEthTick ( NetInterface * interface )

SAMA5D3 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 306 of file sama5d3_geth_driver.c.

◆ sama5d3GigabitEthUpdateMacAddrFilter()

error_t sama5d3GigabitEthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 681 of file sama5d3_geth_driver.c.

◆ sama5d3GigabitEthUpdateMacConfig()

error_t sama5d3GigabitEthUpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 839 of file sama5d3_geth_driver.c.

◆ sama5d3GigabitEthWritePhyReg()

void sama5d3GigabitEthWritePhyReg	(	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 891 of file sama5d3_geth_driver.c.

Variable Documentation

◆ sama5d3GigabitEthDriver

const NicDriver sama5d3GigabitEthDriver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   sama5d3GigabitEthInit,
   sama5d3GigabitEthTick,
   sama5d3GigabitEthEnableIrq,
   sama5d3GigabitEthDisableIrq,
   sama5d3GigabitEthEventHandler,
   sama5d3GigabitEthSendPacket,
   sama5d3GigabitEthUpdateMacAddrFilter,
   sama5d3GigabitEthUpdateMacConfig,
   sama5d3GigabitEthWritePhyReg,
   sama5d3GigabitEthReadPhyReg,
   TRUE,
   TRUE,
   TRUE,
   FALSE
}

SAMA5D3 Ethernet MAC driver (GMAC instance)

Definition at line 92 of file sama5d3_geth_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ sama5d3GigabitEthDisableIrq()

◆ sama5d3GigabitEthEnableIrq()

◆ sama5d3GigabitEthEventHandler()

◆ sama5d3GigabitEthInit()

◆ sama5d3GigabitEthInitBufferDesc()

◆ sama5d3GigabitEthInitGpio()

◆ sama5d3GigabitEthIrqHandler()

◆ sama5d3GigabitEthReadPhyReg()

◆ sama5d3GigabitEthReceivePacket()

◆ sama5d3GigabitEthSendPacket()

◆ sama5d3GigabitEthTick()

◆ sama5d3GigabitEthUpdateMacAddrFilter()

◆ sama5d3GigabitEthUpdateMacConfig()

◆ sama5d3GigabitEthWritePhyReg()

Variable Documentation

◆ sama5d3GigabitEthDriver