SmartFusion (A2FxxxM3) Ethernet MAC driver. More...

#include "core/nic.h"

Data Structures
struct	A2fxxxm3TxDmaDesc
	Transmit DMA descriptor. More...

struct	A2fxxxm3RxDmaDesc
	Receive DMA descriptor. More...

struct	A2fxxxm3HashTableSetupFrame
	Hash table setup frame. More...

Macros
#define	A2FXXXM3_ETH_TX_BUFFER_COUNT 2

#define	A2FXXXM3_ETH_TX_BUFFER_SIZE 1536

#define	A2FXXXM3_ETH_RX_BUFFER_COUNT 4

#define	A2FXXXM3_ETH_RX_BUFFER_SIZE 1536

#define	A2FXXXM3_ETH_IRQ_PRIORITY_GROUPING 2

#define	A2FXXXM3_ETH_IRQ_GROUP_PRIORITY 24

#define	A2FXXXM3_ETH_IRQ_SUB_PRIORITY 0

#define	CSR9_MDEN_MASK CSR9_MII_MASK

Functions
error_t	a2fxxxm3EthInit (NetInterface *interface)
	A2FxxxM3 Ethernet MAC initialization. More...

void	a2fxxxm3EthInitDmaDesc (NetInterface *interface)
	Initialize DMA descriptor lists. More...

void	a2fxxxm3EthTick (NetInterface *interface)
	A2FxxxM3 Ethernet MAC timer handler. More...

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

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

void	a2fxxxm3EthEventHandler (NetInterface *interface)
	A2FxxxM3 Ethernet MAC event handler. More...

error_t	a2fxxxm3EthSendSetup (NetInterface *interface)
	Send a setup frame. More...

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

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

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

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

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

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

void	a2fxxxm3EthWriteSmi (uint32_t data, uint_t length)
	SMI write operation. More...

uint32_t	a2fxxxm3EthReadSmi (uint_t length)
	SMI read operation. More...

uint32_t	a2fxxxm3EthCalcCrc (const void *data, size_t length)
	CRC calculation. More...

Variables
const NicDriver	a2fxxxm3EthDriver
	A2FxxxM3 Ethernet MAC driver. More...

Detailed Description

SmartFusion (A2FxxxM3) 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 a2fxxxm3_eth_driver.h.

Macro Definition Documentation

◆ A2FXXXM3_ETH_IRQ_GROUP_PRIORITY

#define A2FXXXM3_ETH_IRQ_GROUP_PRIORITY 24

Definition at line 74 of file a2fxxxm3_eth_driver.h.

◆ A2FXXXM3_ETH_IRQ_PRIORITY_GROUPING

#define A2FXXXM3_ETH_IRQ_PRIORITY_GROUPING 2

Definition at line 67 of file a2fxxxm3_eth_driver.h.

◆ A2FXXXM3_ETH_IRQ_SUB_PRIORITY

#define A2FXXXM3_ETH_IRQ_SUB_PRIORITY 0

Definition at line 81 of file a2fxxxm3_eth_driver.h.

◆ A2FXXXM3_ETH_RX_BUFFER_COUNT

#define A2FXXXM3_ETH_RX_BUFFER_COUNT 4

Definition at line 53 of file a2fxxxm3_eth_driver.h.

◆ A2FXXXM3_ETH_RX_BUFFER_SIZE

#define A2FXXXM3_ETH_RX_BUFFER_SIZE 1536

Definition at line 60 of file a2fxxxm3_eth_driver.h.

◆ A2FXXXM3_ETH_TX_BUFFER_COUNT

#define A2FXXXM3_ETH_TX_BUFFER_COUNT 2

Definition at line 39 of file a2fxxxm3_eth_driver.h.

◆ A2FXXXM3_ETH_TX_BUFFER_SIZE

#define A2FXXXM3_ETH_TX_BUFFER_SIZE 1536

Definition at line 46 of file a2fxxxm3_eth_driver.h.

◆ CSR9_MDEN_MASK

#define CSR9_MDEN_MASK CSR9_MII_MASK

Definition at line 88 of file a2fxxxm3_eth_driver.h.

Function Documentation

◆ a2fxxxm3EthCalcCrc()

uint32_t a2fxxxm3EthCalcCrc	(	const void *	data,
		size_t	length
	)

CRC calculation.

Parameters

[in]	data	Pointer to the data over which to calculate the CRC
[in]	length	Number of bytes to process

Returns: Resulting CRC value

Definition at line 811 of file a2fxxxm3_eth_driver.c.

◆ a2fxxxm3EthDisableIrq()

void a2fxxxm3EthDisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 305 of file a2fxxxm3_eth_driver.c.

◆ a2fxxxm3EthEnableIrq()

void a2fxxxm3EthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 277 of file a2fxxxm3_eth_driver.c.

◆ a2fxxxm3EthEventHandler()

void a2fxxxm3EthEventHandler ( NetInterface * interface )

A2FxxxM3 Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 385 of file a2fxxxm3_eth_driver.c.

◆ a2fxxxm3EthInit()

error_t a2fxxxm3EthInit ( NetInterface * interface )

A2FxxxM3 Ethernet MAC initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 116 of file a2fxxxm3_eth_driver.c.

◆ a2fxxxm3EthInitDmaDesc()

void a2fxxxm3EthInitDmaDesc ( NetInterface * interface )

Initialize DMA descriptor lists.

Parameters

[in] interface Underlying network interface

Definition at line 196 of file a2fxxxm3_eth_driver.c.

◆ a2fxxxm3EthReadPhyReg()

uint16_t a2fxxxm3EthReadPhyReg	(	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 699 of file a2fxxxm3_eth_driver.c.

◆ a2fxxxm3EthReadSmi()

uint32_t a2fxxxm3EthReadSmi ( uint_t length )

SMI read operation.

Parameters

[in] length Number of bits to be read

Returns: Data resulting from the MDIO read operation

Definition at line 772 of file a2fxxxm3_eth_driver.c.

◆ a2fxxxm3EthReceivePacket()

error_t a2fxxxm3EthReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 512 of file a2fxxxm3_eth_driver.c.

◆ a2fxxxm3EthSendPacket()

error_t a2fxxxm3EthSendPacket	(	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 455 of file a2fxxxm3_eth_driver.c.

◆ a2fxxxm3EthSendSetup()

error_t a2fxxxm3EthSendSetup ( NetInterface * interface )

Send a setup frame.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 406 of file a2fxxxm3_eth_driver.c.

◆ a2fxxxm3EthTick()

void a2fxxxm3EthTick ( NetInterface * interface )

A2FxxxM3 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 252 of file a2fxxxm3_eth_driver.c.

◆ a2fxxxm3EthUpdateMacAddrFilter()

error_t a2fxxxm3EthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 580 of file a2fxxxm3_eth_driver.c.

◆ a2fxxxm3EthUpdateMacConfig()

error_t a2fxxxm3EthUpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 623 of file a2fxxxm3_eth_driver.c.

◆ a2fxxxm3EthWritePhyReg()

void a2fxxxm3EthWritePhyReg	(	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 669 of file a2fxxxm3_eth_driver.c.

◆ a2fxxxm3EthWriteSmi()

void a2fxxxm3EthWriteSmi	(	uint32_t	data,
		uint_t	length
	)

SMI write operation.

Parameters

[in]	data	Raw data to be written
[in]	length	Number of bits to be written

Definition at line 732 of file a2fxxxm3_eth_driver.c.

Variable Documentation

◆ a2fxxxm3EthDriver

const NicDriver a2fxxxm3EthDriver

extern

A2FxxxM3 Ethernet MAC driver.

Definition at line 89 of file a2fxxxm3_eth_driver.c.

Data Structures

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ A2FXXXM3_ETH_IRQ_GROUP_PRIORITY

◆ A2FXXXM3_ETH_IRQ_PRIORITY_GROUPING

◆ A2FXXXM3_ETH_IRQ_SUB_PRIORITY

◆ A2FXXXM3_ETH_RX_BUFFER_COUNT

◆ A2FXXXM3_ETH_RX_BUFFER_SIZE

◆ A2FXXXM3_ETH_TX_BUFFER_COUNT

◆ A2FXXXM3_ETH_TX_BUFFER_SIZE

◆ CSR9_MDEN_MASK

Function Documentation

◆ a2fxxxm3EthCalcCrc()

◆ a2fxxxm3EthDisableIrq()

◆ a2fxxxm3EthEnableIrq()

◆ a2fxxxm3EthEventHandler()

◆ a2fxxxm3EthInit()

◆ a2fxxxm3EthInitDmaDesc()

◆ a2fxxxm3EthReadPhyReg()

◆ a2fxxxm3EthReadSmi()

◆ a2fxxxm3EthReceivePacket()

◆ a2fxxxm3EthSendPacket()

◆ a2fxxxm3EthSendSetup()

◆ a2fxxxm3EthTick()

◆ a2fxxxm3EthUpdateMacAddrFilter()

◆ a2fxxxm3EthUpdateMacConfig()

◆ a2fxxxm3EthWritePhyReg()

◆ a2fxxxm3EthWriteSmi()

Variable Documentation

◆ a2fxxxm3EthDriver