s32k1_eth_driver.c File Reference

NXP S32K1 Ethernet MAC driver. More...

#include "fsl_device_registers.h"
#include "core/net.h"
#include "drivers/mac/s32k1_eth_driver.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t s32k1EthInit (NetInterface *interface)
 S32K1 Ethernet MAC initialization. More...
 
__weak_func void s32k1EthInitGpio (NetInterface *interface)
 GPIO configuration. More...
 
void s32k1EthInitBufferDesc (NetInterface *interface)
 Initialize buffer descriptors. More...
 
void s32k1EthTick (NetInterface *interface)
 S32K1 Ethernet MAC timer handler. More...
 
void s32k1EthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void s32k1EthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void ENET_TX_IRQHandler (void)
 Ethernet MAC transmit interrupt. More...
 
void ENET_RX_IRQHandler (void)
 Ethernet MAC receive interrupt. More...
 
void ENET_ERR_IRQHandler (void)
 Ethernet MAC error interrupt. More...
 
void s32k1EthEventHandler (NetInterface *interface)
 S32K1 Ethernet MAC event handler. More...
 
error_t s32k1EthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
 
error_t s32k1EthReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t s32k1EthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t s32k1EthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void s32k1EthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t s32k1EthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 
uint32_t s32k1EthCalcCrc (const void *data, size_t length)
 CRC calculation. More...
 

Variables

const NicDriver s32k1EthDriver
 S32K1 Ethernet MAC driver. More...
 

Detailed Description

NXP S32K1 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 s32k1_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file s32k1_eth_driver.c.

Function Documentation

◆ ENET_ERR_IRQHandler()

void ENET_ERR_IRQHandler ( void  )

Ethernet MAC error interrupt.

Definition at line 511 of file s32k1_eth_driver.c.

◆ ENET_RX_IRQHandler()

void ENET_RX_IRQHandler ( void  )

Ethernet MAC receive interrupt.

Definition at line 480 of file s32k1_eth_driver.c.

◆ ENET_TX_IRQHandler()

void ENET_TX_IRQHandler ( void  )

Ethernet MAC transmit interrupt.

Definition at line 444 of file s32k1_eth_driver.c.

◆ s32k1EthCalcCrc()

uint32_t s32k1EthCalcCrc ( 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 981 of file s32k1_eth_driver.c.

◆ s32k1EthDisableIrq()

void s32k1EthDisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 415 of file s32k1_eth_driver.c.

◆ s32k1EthEnableIrq()

void s32k1EthEnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 385 of file s32k1_eth_driver.c.

◆ s32k1EthEventHandler()

void s32k1EthEventHandler ( NetInterface interface)

S32K1 Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 543 of file s32k1_eth_driver.c.

◆ s32k1EthInit()

error_t s32k1EthInit ( NetInterface interface)

S32K1 Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 114 of file s32k1_eth_driver.c.

◆ s32k1EthInitBufferDesc()

void s32k1EthInitBufferDesc ( NetInterface interface)

Initialize buffer descriptors.

Parameters
[in]interfaceUnderlying network interface

Definition at line 299 of file s32k1_eth_driver.c.

◆ s32k1EthInitGpio()

__weak_func void s32k1EthInitGpio ( NetInterface interface)

GPIO configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 249 of file s32k1_eth_driver.c.

◆ s32k1EthReadPhyReg()

uint16_t s32k1EthReadPhyReg ( 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 934 of file s32k1_eth_driver.c.

◆ s32k1EthReceivePacket()

error_t s32k1EthReceivePacket ( NetInterface interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 668 of file s32k1_eth_driver.c.

◆ s32k1EthSendPacket()

error_t s32k1EthSendPacket ( 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 598 of file s32k1_eth_driver.c.

◆ s32k1EthTick()

void s32k1EthTick ( NetInterface interface)

S32K1 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 360 of file s32k1_eth_driver.c.

◆ s32k1EthUpdateMacAddrFilter()

error_t s32k1EthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 749 of file s32k1_eth_driver.c.

◆ s32k1EthUpdateMacConfig()

error_t s32k1EthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 838 of file s32k1_eth_driver.c.

◆ s32k1EthWritePhyReg()

void s32k1EthWritePhyReg ( 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 892 of file s32k1_eth_driver.c.

Variable Documentation

◆ s32k1EthDriver

#define TRUE
Definition: os_port.h:50
uint16_t s32k1EthReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
void s32k1EthTick(NetInterface *interface)
S32K1 Ethernet MAC timer handler.
error_t s32k1EthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
#define FALSE
Definition: os_port.h:46
void s32k1EthEnableIrq(NetInterface *interface)
Enable interrupts.
void s32k1EthDisableIrq(NetInterface *interface)
Disable interrupts.
void s32k1EthEventHandler(NetInterface *interface)
S32K1 Ethernet MAC event handler.
error_t s32k1EthInit(NetInterface *interface)
S32K1 Ethernet MAC initialization.
#define ETH_MTU
Definition: ethernet.h:116
void s32k1EthWritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
error_t s32k1EthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
error_t s32k1EthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
@ NIC_TYPE_ETHERNET
Ethernet interface.
Definition: nic.h:83