PolarFire SoC Gigabit Ethernet MAC driver (MAC1 instance) More...

#include <limits.h>
#include "mpfs_hal/common/mss_plic.h"
#include "mpfs_hal/common/mss_sysreg.h"
#include "drivers/mss/mss_ethernet_mac/mss_ethernet_registers.h"
#include "drivers/mss/mss_ethernet_mac/mss_ethernet_mac_regs.h"
#include "core/net.h"
#include "drivers/mac/mpfsxxx_eth2_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	mpfsxxxEth2Init (NetInterface *interface)
	MPFSxxx Ethernet MAC initialization. More...

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

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

void	mpfsxxxEth2Tick (NetInterface *interface)
	MPFSxxx Ethernet MAC timer handler. More...

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

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

uint8_t	mac1_int_plic_IRQHandler (void)
	MPFSxxx Ethernet MAC interrupt service routine. More...

void	mpfsxxxEth2EventHandler (NetInterface *interface)
	MPFSxxx Ethernet MAC event handler. More...

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

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

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

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

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

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

Variables
const NicDriver	mpfsxxxEth2Driver
	MPFSxxx Ethernet MAC driver (MAC1 instance) More...

Detailed Description

PolarFire SoC Gigabit Ethernet MAC driver (MAC1 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.4.4

Definition in file mpfsxxx_eth2_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file mpfsxxx_eth2_driver.c.

Function Documentation

◆ mac1_int_plic_IRQHandler()

uint8_t mac1_int_plic_IRQHandler ( void )

MPFSxxx Ethernet MAC interrupt service routine.

Definition at line 461 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2DisableIrq()

void mpfsxxxEth2DisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 434 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2EnableIrq()

void mpfsxxxEth2EnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 406 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2EventHandler()

void mpfsxxxEth2EventHandler ( NetInterface * interface )

MPFSxxx Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 525 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2Init()

error_t mpfsxxxEth2Init ( NetInterface * interface )

MPFSxxx Ethernet MAC initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 110 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2InitBufferDesc()

void mpfsxxxEth2InitBufferDesc ( NetInterface * interface )

Initialize buffer descriptors.

Parameters

[in] interface Underlying network interface

Definition at line 257 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2InitGpio()

__weak_func void mpfsxxxEth2InitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 244 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2ReadPhyReg()

uint16_t mpfsxxxEth2ReadPhyReg	(	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 1012 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2ReceivePacket()

error_t mpfsxxxEth2ReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 629 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2SendPacket()

error_t mpfsxxxEth2SendPacket	(	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 562 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2Tick()

void mpfsxxxEth2Tick ( NetInterface * interface )

MPFSxxx 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 381 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2UpdateMacAddrFilter()

error_t mpfsxxxEth2UpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 761 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2UpdateMacConfig()

error_t mpfsxxxEth2UpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 919 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2WritePhyReg()

void mpfsxxxEth2WritePhyReg	(	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 971 of file mpfsxxx_eth2_driver.c.

Variable Documentation

◆ mpfsxxxEth2Driver

const NicDriver mpfsxxxEth2Driver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   mpfsxxxEth2Init,
   mpfsxxxEth2Tick,
   mpfsxxxEth2EnableIrq,
   mpfsxxxEth2DisableIrq,
   mpfsxxxEth2EventHandler,
   mpfsxxxEth2SendPacket,
   mpfsxxxEth2UpdateMacAddrFilter,
   mpfsxxxEth2UpdateMacConfig,
   mpfsxxxEth2WritePhyReg,
   mpfsxxxEth2ReadPhyReg,
   TRUE,
   TRUE,
   TRUE,
   FALSE
}

MPFSxxx Ethernet MAC driver (MAC1 instance)

Definition at line 83 of file mpfsxxx_eth2_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ mac1_int_plic_IRQHandler()

◆ mpfsxxxEth2DisableIrq()

◆ mpfsxxxEth2EnableIrq()

◆ mpfsxxxEth2EventHandler()

◆ mpfsxxxEth2Init()

◆ mpfsxxxEth2InitBufferDesc()

◆ mpfsxxxEth2InitGpio()

◆ mpfsxxxEth2ReadPhyReg()

◆ mpfsxxxEth2ReceivePacket()

◆ mpfsxxxEth2SendPacket()

◆ mpfsxxxEth2Tick()

◆ mpfsxxxEth2UpdateMacAddrFilter()

◆ mpfsxxxEth2UpdateMacConfig()

◆ mpfsxxxEth2WritePhyReg()

Variable Documentation

◆ mpfsxxxEth2Driver