Macros | Functions | Variables
stm32mp1xx_eth_driver.c File Reference

STM32MP1 Gigabit Ethernet MAC driver. More...

#include "stm32mp1xx.h"
#include "stm32mp1xx_hal.h"
#include "core/net.h"
#include "drivers/mac/stm32mp1xx_eth_driver.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t stm32mp1xxEthInit (NetInterface *interface)
 STM32MP1 Ethernet MAC initialization. More...
 
__weak_func void stm32mp1xxEthInitGpio (NetInterface *interface)
 GPIO configuration. More...
 
void stm32mp1xxEthInitDmaDesc (NetInterface *interface)
 Initialize DMA descriptor lists. More...
 
void stm32mp1xxEthTick (NetInterface *interface)
 STM32MP1 Ethernet MAC timer handler. More...
 
void stm32mp1xxEthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void stm32mp1xxEthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void ETH1_IRQHandler (void)
 STM32MP1 Ethernet MAC interrupt service routine. More...
 
void stm32mp1xxEthEventHandler (NetInterface *interface)
 STM32MP1 Ethernet MAC event handler. More...
 
error_t stm32mp1xxEthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
 
error_t stm32mp1xxEthReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t stm32mp1xxEthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t stm32mp1xxEthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void stm32mp1xxEthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t stm32mp1xxEthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 
uint32_t stm32mp1xxEthCalcCrc (const void *data, size_t length)
 CRC calculation. More...
 

Variables

const NicDriver stm32mp1xxEthDriver
 STM32MP1 Ethernet MAC driver. More...
 

Detailed Description

STM32MP1 Gigabit Ethernet MAC driver.

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

Definition in file stm32mp1xx_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file stm32mp1xx_eth_driver.c.

Function Documentation

◆ ETH1_IRQHandler()

void ETH1_IRQHandler ( void  )

STM32MP1 Ethernet MAC interrupt service routine.

Definition at line 516 of file stm32mp1xx_eth_driver.c.

◆ stm32mp1xxEthCalcCrc()

uint32_t stm32mp1xxEthCalcCrc ( const void *  data,
size_t  length 
)

CRC calculation.

Parameters
[in]dataPointer to the data over which to calculate the CRC
[in]lengthNumber of bytes to process
Returns
Resulting CRC value

Definition at line 1018 of file stm32mp1xx_eth_driver.c.

◆ stm32mp1xxEthDisableIrq()

void stm32mp1xxEthDisableIrq ( NetInterface *  interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 489 of file stm32mp1xx_eth_driver.c.

◆ stm32mp1xxEthEnableIrq()

void stm32mp1xxEthEnableIrq ( NetInterface *  interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 461 of file stm32mp1xx_eth_driver.c.

◆ stm32mp1xxEthEventHandler()

void stm32mp1xxEthEventHandler ( NetInterface *  interface)

STM32MP1 Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 569 of file stm32mp1xx_eth_driver.c.

◆ stm32mp1xxEthInit()

error_t stm32mp1xxEthInit ( NetInterface *  interface)

STM32MP1 Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 115 of file stm32mp1xx_eth_driver.c.

◆ stm32mp1xxEthInitDmaDesc()

void stm32mp1xxEthInitDmaDesc ( NetInterface *  interface)

Initialize DMA descriptor lists.

Parameters
[in]interfaceUnderlying network interface

Definition at line 385 of file stm32mp1xx_eth_driver.c.

◆ stm32mp1xxEthInitGpio()

__weak_func void stm32mp1xxEthInitGpio ( NetInterface *  interface)

GPIO configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 254 of file stm32mp1xx_eth_driver.c.

◆ stm32mp1xxEthReadPhyReg()

uint16_t stm32mp1xxEthReadPhyReg ( 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 972 of file stm32mp1xx_eth_driver.c.

◆ stm32mp1xxEthReceivePacket()

error_t stm32mp1xxEthReceivePacket ( NetInterface *  interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 659 of file stm32mp1xx_eth_driver.c.

◆ stm32mp1xxEthSendPacket()

error_t stm32mp1xxEthSendPacket ( 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 594 of file stm32mp1xx_eth_driver.c.

◆ stm32mp1xxEthTick()

void stm32mp1xxEthTick ( NetInterface *  interface)

STM32MP1 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 436 of file stm32mp1xx_eth_driver.c.

◆ stm32mp1xxEthUpdateMacAddrFilter()

error_t stm32mp1xxEthUpdateMacAddrFilter ( NetInterface *  interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 734 of file stm32mp1xx_eth_driver.c.

◆ stm32mp1xxEthUpdateMacConfig()

error_t stm32mp1xxEthUpdateMacConfig ( NetInterface *  interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 878 of file stm32mp1xx_eth_driver.c.

◆ stm32mp1xxEthWritePhyReg()

void stm32mp1xxEthWritePhyReg ( 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 930 of file stm32mp1xx_eth_driver.c.

Variable Documentation

◆ stm32mp1xxEthDriver

const NicDriver stm32mp1xxEthDriver
Initial value:
=
{
NIC_TYPE_ETHERNET,
ETH_MTU,
stm32mp1xxEthInit,
stm32mp1xxEthTick,
stm32mp1xxEthEnableIrq,
stm32mp1xxEthDisableIrq,
stm32mp1xxEthEventHandler,
stm32mp1xxEthSendPacket,
stm32mp1xxEthUpdateMacAddrFilter,
stm32mp1xxEthUpdateMacConfig,
stm32mp1xxEthWritePhyReg,
stm32mp1xxEthReadPhyReg,
TRUE,
TRUE,
TRUE,
FALSE
}

STM32MP1 Ethernet MAC driver.

Definition at line 88 of file stm32mp1xx_eth_driver.c.

TRUE
#define TRUE
Definition: os_port.h:50
stm32mp1xxEthInit
error_t stm32mp1xxEthInit(NetInterface *interface)
STM32MP1 Ethernet MAC initialization.
Definition: stm32mp1xx_eth_driver.c:115
FALSE
#define FALSE
Definition: os_port.h:46
stm32mp1xxEthUpdateMacAddrFilter
error_t stm32mp1xxEthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
Definition: stm32mp1xx_eth_driver.c:734
stm32mp1xxEthWritePhyReg
void stm32mp1xxEthWritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
Definition: stm32mp1xx_eth_driver.c:930
stm32mp1xxEthEventHandler
void stm32mp1xxEthEventHandler(NetInterface *interface)
STM32MP1 Ethernet MAC event handler.
Definition: stm32mp1xx_eth_driver.c:569
stm32mp1xxEthSendPacket
error_t stm32mp1xxEthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
Definition: stm32mp1xx_eth_driver.c:594
stm32mp1xxEthEnableIrq
void stm32mp1xxEthEnableIrq(NetInterface *interface)
Enable interrupts.
Definition: stm32mp1xx_eth_driver.c:461
ETH_MTU
#define ETH_MTU
Definition: ethernet.h:116
stm32mp1xxEthReadPhyReg
uint16_t stm32mp1xxEthReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
Definition: stm32mp1xx_eth_driver.c:972
stm32mp1xxEthDisableIrq
void stm32mp1xxEthDisableIrq(NetInterface *interface)
Disable interrupts.
Definition: stm32mp1xx_eth_driver.c:489
stm32mp1xxEthUpdateMacConfig
error_t stm32mp1xxEthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
Definition: stm32mp1xx_eth_driver.c:878
stm32mp1xxEthTick
void stm32mp1xxEthTick(NetInterface *interface)
STM32MP1 Ethernet MAC timer handler.
Definition: stm32mp1xx_eth_driver.c:436
NIC_TYPE_ETHERNET
@ NIC_TYPE_ETHERNET
Ethernet interface.
Definition: nic.h:83