AM64x Ethernet MAC driver. More...

#include <hw_include/csl_cpswitch.h>
#include <kernel/dpl/AddrTranslateP.h>
#include <drivers/pinmux.h>
#include <drivers/udma/udma_priv.h>
#include <networking/enet/utils/include/enet_apputils.h>
#include <networking/enet/utils/include/enet_appmemutils.h>
#include <networking/enet/utils/include/enet_appmemutils_cfg.h>
#include "core/net.h"
#include "drivers/mac/am64x_eth_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

#define	MDIO_INPUT_CLK 250000000

#define	MDIO_OUTPUT_CLK 1000000

Functions
error_t	am64xEthInitPort1 (NetInterface *interface)
	AM64x Ethernet MAC initialization (port 1) More...

error_t	am64xEthInitPort2 (NetInterface *interface)
	AM64x Ethernet MAC initialization (port 2) More...

void	am64xEthInitInstance (NetInterface *interface)
	Initialize CPSW instance. More...

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

void	am64xEthTick (NetInterface *interface)
	AM64x Ethernet MAC timer handler. More...

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

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

void	am64xEthRxIrqHandler (void *arg)
	AM64x Ethernet MAC receive interrupt. More...

void	am64xEthEventHandler (NetInterface *interface)
	AM64x Ethernet MAC event handler. More...

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

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

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

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

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

void	am64xEthWriteEntry (uint_t index, const Am64xAleEntry *entry)
	Write an ALE table entry. More...

void	am64xEthReadEntry (uint_t index, Am64xAleEntry *entry)
	Read an ALE table entry. More...

uint_t	am64xEthFindFreeEntry (void)
	Find a free entry in the ALE table. More...

uint_t	am64xEthFindVlanEntry (uint_t vlanId)
	Search the ALE table for the specified VLAN entry. More...

uint_t	am64xEthFindVlanAddrEntry (uint_t vlanId, MacAddr *macAddr)
	Search the ALE table for the specified VLAN/address entry. More...

error_t	am64xEthAddVlanEntry (uint_t port, uint_t vlanId)
	Add a VLAN entry in the ALE table. More...

error_t	am64xEthAddVlanAddrEntry (uint_t port, uint_t vlanId, MacAddr *macAddr)
	Add a VLAN/address entry in the ALE table. More...

error_t	am64xEthDeleteVlanAddrEntry (uint_t port, uint_t vlanId, MacAddr *macAddr)
	Remove a VLAN/address entry from the ALE table. More...

Variables
const NicDriver	am64xEthPort1Driver
	AM64x Ethernet MAC driver (port1) More...

const NicDriver	am64xEthPort2Driver
	AM64x Ethernet MAC driver (port2) More...

Detailed Description

AM64x 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.0

Definition in file am64x_eth_driver.c.

Macro Definition Documentation

◆ MDIO_INPUT_CLK

#define MDIO_INPUT_CLK 250000000

Definition at line 47 of file am64x_eth_driver.c.

◆ MDIO_OUTPUT_CLK

#define MDIO_OUTPUT_CLK 1000000

Definition at line 49 of file am64x_eth_driver.c.

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file am64x_eth_driver.c.

Function Documentation

◆ am64xEthAddVlanAddrEntry()

error_t am64xEthAddVlanAddrEntry	(	uint_t	port,
		uint_t	vlanId,
		MacAddr *	macAddr
	)

Add a VLAN/address entry in the ALE table.

Parameters

[in]	port	Port number
[in]	vlanId	VLAN identifier
[in]	macAddr	MAC address

Returns: Error code

Definition at line 1405 of file am64x_eth_driver.c.

◆ am64xEthAddVlanEntry()

error_t am64xEthAddVlanEntry	(	uint_t	port,
		uint_t	vlanId
	)

Add a VLAN entry in the ALE table.

Parameters

[in]	port	Port number
[in]	vlanId	VLAN identifier

Returns: Error code

Definition at line 1345 of file am64x_eth_driver.c.

◆ am64xEthDeleteVlanAddrEntry()

error_t am64xEthDeleteVlanAddrEntry	(	uint_t	port,
		uint_t	vlanId,
		MacAddr *	macAddr
	)

Remove a VLAN/address entry from the ALE table.

Parameters

[in]	port	Port number
[in]	vlanId	VLAN identifier
[in]	macAddr	MAC address

Returns: Error code

Definition at line 1476 of file am64x_eth_driver.c.

◆ am64xEthDisableIrq()

void am64xEthDisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 712 of file am64x_eth_driver.c.

◆ am64xEthEnableIrq()

void am64xEthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 687 of file am64x_eth_driver.c.

◆ am64xEthEventHandler()

void am64xEthEventHandler ( NetInterface * interface )

AM64x Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 759 of file am64x_eth_driver.c.

◆ am64xEthFindFreeEntry()

uint_t am64xEthFindFreeEntry ( void )

Find a free entry in the ALE table.

Returns: Index of the first free entry

Definition at line 1218 of file am64x_eth_driver.c.

◆ am64xEthFindVlanAddrEntry()

uint_t am64xEthFindVlanAddrEntry	(	uint_t	vlanId,
		MacAddr *	macAddr
	)

Search the ALE table for the specified VLAN/address entry.

Parameters

[in]	vlanId	VLAN identifier
[in]	macAddr	MAC address

Returns: Index of the matching entry

Definition at line 1294 of file am64x_eth_driver.c.

◆ am64xEthFindVlanEntry()

uint_t am64xEthFindVlanEntry ( uint_t vlanId )

Search the ALE table for the specified VLAN entry.

Parameters

[in] vlanId VLAN identifier

Returns: Index of the matching entry

Definition at line 1252 of file am64x_eth_driver.c.

◆ am64xEthInitGpio()

__weak_func void am64xEthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 581 of file am64x_eth_driver.c.

◆ am64xEthInitInstance()

void am64xEthInitInstance ( NetInterface * interface )

Initialize CPSW instance.

Parameters

[in] interface Underlying network interface

Definition at line 309 of file am64x_eth_driver.c.

◆ am64xEthInitPort1()

error_t am64xEthInitPort1 ( NetInterface * interface )

AM64x Ethernet MAC initialization (port 1)

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 123 of file am64x_eth_driver.c.

◆ am64xEthInitPort2()

error_t am64xEthInitPort2 ( NetInterface * interface )

AM64x Ethernet MAC initialization (port 2)

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 226 of file am64x_eth_driver.c.

◆ am64xEthReadEntry()

void am64xEthReadEntry	(	uint_t	index,
		Am64xAleEntry *	entry
	)

Read an ALE table entry.

Parameters

[in]	index	Entry index
[out]	entry	Pointer to the ALE table entry

Definition at line 1196 of file am64x_eth_driver.c.

◆ am64xEthReadPhyReg()

uint16_t am64xEthReadPhyReg	(	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 1119 of file am64x_eth_driver.c.

◆ am64xEthRxIrqHandler()

void am64xEthRxIrqHandler ( void * arg )

AM64x Ethernet MAC receive interrupt.

Parameters

[in] arg Unused parameter

Definition at line 737 of file am64x_eth_driver.c.

◆ am64xEthSendPacket()

error_t am64xEthSendPacket	(	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 844 of file am64x_eth_driver.c.

◆ am64xEthTick()

void am64xEthTick ( NetInterface * interface )

AM64x 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 662 of file am64x_eth_driver.c.

◆ am64xEthUpdateMacAddrFilter()

error_t am64xEthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 940 of file am64x_eth_driver.c.

◆ am64xEthUpdateMacConfig()

error_t am64xEthUpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 998 of file am64x_eth_driver.c.

◆ am64xEthWriteEntry()

void am64xEthWriteEntry	(	uint_t	index,
		const Am64xAleEntry *	entry
	)

Write an ALE table entry.

Parameters

[in]	index	Entry index
[in]	entry	Pointer to the ALE table entry

Definition at line 1173 of file am64x_eth_driver.c.

◆ am64xEthWritePhyReg()

void am64xEthWritePhyReg	(	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 1068 of file am64x_eth_driver.c.

Variable Documentation

◆ am64xEthPort1Driver

const NicDriver am64xEthPort1Driver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   am64xEthInitPort1,
   am64xEthTick,
   am64xEthEnableIrq,
   am64xEthDisableIrq,
   am64xEthEventHandler,
   am64xEthSendPacket,
   am64xEthUpdateMacAddrFilter,
   am64xEthUpdateMacConfig,
   am64xEthWritePhyReg,
   am64xEthReadPhyReg,
   FALSE,
   TRUE,
   TRUE,
   FALSE
}

AM64x Ethernet MAC driver (port1)

Definition at line 71 of file am64x_eth_driver.c.

◆ am64xEthPort2Driver

const NicDriver am64xEthPort2Driver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   am64xEthInitPort2,
   am64xEthTick,
   am64xEthEnableIrq,
   am64xEthDisableIrq,
   am64xEthEventHandler,
   am64xEthSendPacket,
   am64xEthUpdateMacAddrFilter,
   am64xEthUpdateMacConfig,
   am64xEthWritePhyReg,
   am64xEthReadPhyReg,
   FALSE,
   TRUE,
   TRUE,
   FALSE
}

AM64x Ethernet MAC driver (port2)

Definition at line 96 of file am64x_eth_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ MDIO_INPUT_CLK

◆ MDIO_OUTPUT_CLK

◆ TRACE_LEVEL

Function Documentation

◆ am64xEthAddVlanAddrEntry()

◆ am64xEthAddVlanEntry()

◆ am64xEthDeleteVlanAddrEntry()

◆ am64xEthDisableIrq()

◆ am64xEthEnableIrq()

◆ am64xEthEventHandler()

◆ am64xEthFindFreeEntry()

◆ am64xEthFindVlanAddrEntry()

◆ am64xEthFindVlanEntry()

◆ am64xEthInitGpio()

◆ am64xEthInitInstance()

◆ am64xEthInitPort1()

◆ am64xEthInitPort2()

◆ am64xEthReadEntry()

◆ am64xEthReadPhyReg()

◆ am64xEthRxIrqHandler()

◆ am64xEthSendPacket()

◆ am64xEthTick()

◆ am64xEthUpdateMacAddrFilter()

◆ am64xEthUpdateMacConfig()

◆ am64xEthWriteEntry()

◆ am64xEthWritePhyReg()

Variable Documentation

◆ am64xEthPort1Driver

◆ am64xEthPort2Driver