Macros | Functions | Variables
mpfsxxx_eth2_driver.c File Reference

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

#include <limits.h>
#include "mpfs_hal/mss_plic.h"
#include "mpfs_hal/mss_sysreg.h"
#include "drivers/mss_mac/mac_registers.h"
#include "drivers/mss_mac/pse_mac_regs.h"
#include "core/net.h"
#include "drivers/mac/mpfsxxx_eth2_driver.h"
#include "debug.h"

Go to the source code of this file.

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

Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.

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

◆ mpfsxxxEth2DisableIrq()

void mpfsxxxEth2DisableIrq ( NetInterface *  interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 435 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2EnableIrq()

void mpfsxxxEth2EnableIrq ( NetInterface *  interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 407 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2EventHandler()

void mpfsxxxEth2EventHandler ( NetInterface *  interface)

MPFSxxx Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 524 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2Init()

error_t mpfsxxxEth2Init ( NetInterface *  interface)

MPFSxxx Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying 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]interfaceUnderlying network interface

Definition at line 258 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2InitGpio()

__weak_func void mpfsxxxEth2InitGpio ( NetInterface *  interface)

GPIO configuration.

Parameters
[in]interfaceUnderlying 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]opcodeAccess type (2 bits)
[in]phyAddrPHY address (5 bits)
[in]regAddrRegister address (5 bits)
Returns
Register value

Definition at line 1011 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2ReceivePacket()

error_t mpfsxxxEth2ReceivePacket ( NetInterface *  interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 628 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]interfaceUnderlying network interface
[in]bufferMulti-part buffer containing the data to send
[in]offsetOffset to the first data byte
[in]ancillaryAdditional options passed to the stack along with the packet
Returns
Error code

Definition at line 561 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]interfaceUnderlying network interface

Definition at line 382 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2UpdateMacAddrFilter()

error_t mpfsxxxEth2UpdateMacAddrFilter ( NetInterface *  interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 760 of file mpfsxxx_eth2_driver.c.

◆ mpfsxxxEth2UpdateMacConfig()

error_t mpfsxxxEth2UpdateMacConfig ( NetInterface *  interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 918 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]opcodeAccess type (2 bits)
[in]phyAddrPHY address (5 bits)
[in]regAddrRegister address (5 bits)
[in]dataRegister value

Definition at line 970 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
}
ETH_MTU
#define ETH_MTU
Definition: ethernet.h:116
mpfsxxxEth2Tick
void mpfsxxxEth2Tick(NetInterface *interface)
MPFSxxx Ethernet MAC timer handler.
Definition: mpfsxxx_eth2_driver.c:382
mpfsxxxEth2Init
error_t mpfsxxxEth2Init(NetInterface *interface)
MPFSxxx Ethernet MAC initialization.
Definition: mpfsxxx_eth2_driver.c:110
mpfsxxxEth2EventHandler
void mpfsxxxEth2EventHandler(NetInterface *interface)
MPFSxxx Ethernet MAC event handler.
Definition: mpfsxxx_eth2_driver.c:524
mpfsxxxEth2UpdateMacAddrFilter
error_t mpfsxxxEth2UpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
Definition: mpfsxxx_eth2_driver.c:760
mpfsxxxEth2DisableIrq
void mpfsxxxEth2DisableIrq(NetInterface *interface)
Disable interrupts.
Definition: mpfsxxx_eth2_driver.c:435
mpfsxxxEth2SendPacket
error_t mpfsxxxEth2SendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
Definition: mpfsxxx_eth2_driver.c:561
mpfsxxxEth2UpdateMacConfig
error_t mpfsxxxEth2UpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
Definition: mpfsxxx_eth2_driver.c:918
mpfsxxxEth2EnableIrq
void mpfsxxxEth2EnableIrq(NetInterface *interface)
Enable interrupts.
Definition: mpfsxxx_eth2_driver.c:407
mpfsxxxEth2ReadPhyReg
uint16_t mpfsxxxEth2ReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
Definition: mpfsxxx_eth2_driver.c:1011
mpfsxxxEth2WritePhyReg
void mpfsxxxEth2WritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
Definition: mpfsxxx_eth2_driver.c:970
NIC_TYPE_ETHERNET
@ NIC_TYPE_ETHERNET
Ethernet interface.
Definition: nic.h:83
TRUE
#define TRUE
Definition: os_port.h:50
FALSE
#define FALSE
Definition: os_port.h:46

MPFSxxx Ethernet MAC driver (MAC1 instance)

Definition at line 83 of file mpfsxxx_eth2_driver.c.