NXP MCX N54 Ethernet MAC driver. More...

#include "fsl_device_registers.h"
#include "fsl_clock.h"
#include "fsl_gpio.h"
#include "fsl_port.h"
#include "fsl_reset.h"
#include "core/net.h"
#include "drivers/mac/mcxn54_eth_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	mcxn54EthInit (NetInterface *interface)
	MCX N54 Ethernet MAC initialization. More...

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

void	mcxn54EthInitDmaDesc (NetInterface *interface)
	Initialize DMA descriptor lists. More...

void	mcxn54EthTick (NetInterface *interface)
	MCX N54 Ethernet MAC timer handler. More...

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

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

void	ETHERNET_IRQHandler (void)
	MCX N54 Ethernet MAC interrupt service routine. More...

void	mcxn54EthEventHandler (NetInterface *interface)
	MCX N54 Ethernet MAC event handler. More...

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

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

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

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

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

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

Variables
const NicDriver	mcxn54EthDriver
	MCX N54 Ethernet MAC driver. More...

Detailed Description

NXP MCX N54 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.6.4

Definition in file mcxn54_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file mcxn54_eth_driver.c.

Function Documentation

◆ ETHERNET_IRQHandler()

void ETHERNET_IRQHandler ( void )

MCX N54 Ethernet MAC interrupt service routine.

Definition at line 443 of file mcxn54_eth_driver.c.

◆ mcxn54EthDisableIrq()

void mcxn54EthDisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 416 of file mcxn54_eth_driver.c.

◆ mcxn54EthEnableIrq()

void mcxn54EthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 388 of file mcxn54_eth_driver.c.

◆ mcxn54EthEventHandler()

void mcxn54EthEventHandler ( NetInterface * interface )

MCX N54 Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 496 of file mcxn54_eth_driver.c.

◆ mcxn54EthInit()

error_t mcxn54EthInit ( NetInterface * interface )

MCX N54 Ethernet MAC initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 118 of file mcxn54_eth_driver.c.

◆ mcxn54EthInitDmaDesc()

void mcxn54EthInitDmaDesc ( NetInterface * interface )

Initialize DMA descriptor lists.

Parameters

[in] interface Underlying network interface

Definition at line 312 of file mcxn54_eth_driver.c.

◆ mcxn54EthInitGpio()

__weak_func void mcxn54EthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 259 of file mcxn54_eth_driver.c.

◆ mcxn54EthReadPhyReg()

uint16_t mcxn54EthReadPhyReg	(	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 794 of file mcxn54_eth_driver.c.

◆ mcxn54EthReceivePacket()

error_t mcxn54EthReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 583 of file mcxn54_eth_driver.c.

◆ mcxn54EthSendPacket()

error_t mcxn54EthSendPacket	(	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 521 of file mcxn54_eth_driver.c.

◆ mcxn54EthTick()

void mcxn54EthTick ( NetInterface * interface )

MCX N54 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 363 of file mcxn54_eth_driver.c.

◆ mcxn54EthUpdateMacAddrFilter()

error_t mcxn54EthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 658 of file mcxn54_eth_driver.c.

◆ mcxn54EthUpdateMacConfig()

error_t mcxn54EthUpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 708 of file mcxn54_eth_driver.c.

◆ mcxn54EthWritePhyReg()

void mcxn54EthWritePhyReg	(	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 751 of file mcxn54_eth_driver.c.

Variable Documentation

◆ mcxn54EthDriver

const NicDriver mcxn54EthDriver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   mcxn54EthInit,
   mcxn54EthTick,
   mcxn54EthEnableIrq,
   mcxn54EthDisableIrq,
   mcxn54EthEventHandler,
   mcxn54EthSendPacket,
   mcxn54EthUpdateMacAddrFilter,
   mcxn54EthUpdateMacConfig,
   mcxn54EthWritePhyReg,
   mcxn54EthReadPhyReg,
   TRUE,
   TRUE,
   TRUE,
   FALSE
}

MCX N54 Ethernet MAC driver.

Definition at line 91 of file mcxn54_eth_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ETHERNET_IRQHandler()

◆ mcxn54EthDisableIrq()

◆ mcxn54EthEnableIrq()

◆ mcxn54EthEventHandler()

◆ mcxn54EthInit()

◆ mcxn54EthInitDmaDesc()

◆ mcxn54EthInitGpio()

◆ mcxn54EthReadPhyReg()

◆ mcxn54EthReceivePacket()

◆ mcxn54EthSendPacket()

◆ mcxn54EthTick()

◆ mcxn54EthUpdateMacAddrFilter()

◆ mcxn54EthUpdateMacConfig()

◆ mcxn54EthWritePhyReg()

Variable Documentation

◆ mcxn54EthDriver