NXP MCX E31 Ethernet MAC driver. More...

#include "fsl_device_registers.h"
#include "fsl_clock.h"
#include "fsl_memory.h"
#include "fsl_siul2.h"
#include "core/net.h"
#include "drivers/mac/mcxe31_eth_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	mcxe31EthInit (NetInterface *interface)
	MCX E31 Ethernet MAC initialization. More...

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

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

void	mcxe31EthTick (NetInterface *interface)
	MCX E31 Ethernet MAC timer handler. More...

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

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

void	EMAC_0_IRQHandler (void)
	MCX E31 Ethernet MAC interrupt service routine. More...

void	mcxe31EthEventHandler (NetInterface *interface)
	MCX E31 Ethernet MAC event handler. More...

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

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

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

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

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

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

uint32_t	mcxe31EthCalcCrc (const void *data, size_t length)
	CRC calculation. More...

Variables
const NicDriver	mcxe31EthDriver
	MCX E31 Ethernet MAC driver. More...

Detailed Description

NXP MCX E31 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 mcxe31_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file mcxe31_eth_driver.c.

Function Documentation

◆ EMAC_0_IRQHandler()

void EMAC_0_IRQHandler ( void )

MCX E31 Ethernet MAC interrupt service routine.

Definition at line 450 of file mcxe31_eth_driver.c.

◆ mcxe31EthCalcCrc()

uint32_t mcxe31EthCalcCrc	(	const void *	data,
		size_t	length
	)

CRC calculation.

Parameters

[in]	data	Pointer to the data over which to calculate the CRC
[in]	length	Number of bytes to process

Returns: Resulting CRC value

Definition at line 938 of file mcxe31_eth_driver.c.

◆ mcxe31EthDisableIrq()

void mcxe31EthDisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 423 of file mcxe31_eth_driver.c.

◆ mcxe31EthEnableIrq()

void mcxe31EthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 395 of file mcxe31_eth_driver.c.

◆ mcxe31EthEventHandler()

void mcxe31EthEventHandler ( NetInterface * interface )

MCX E31 Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 503 of file mcxe31_eth_driver.c.

◆ mcxe31EthInit()

error_t mcxe31EthInit ( NetInterface * interface )

MCX E31 Ethernet MAC initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 121 of file mcxe31_eth_driver.c.

◆ mcxe31EthInitDmaDesc()

void mcxe31EthInitDmaDesc ( NetInterface * interface )

Initialize DMA descriptor lists.

Parameters

[in] interface Underlying network interface

Definition at line 313 of file mcxe31_eth_driver.c.

◆ mcxe31EthInitGpio()

__weak_func void mcxe31EthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 256 of file mcxe31_eth_driver.c.

◆ mcxe31EthReadPhyReg()

uint16_t mcxe31EthReadPhyReg	(	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 889 of file mcxe31_eth_driver.c.

◆ mcxe31EthReceivePacket()

error_t mcxe31EthReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 595 of file mcxe31_eth_driver.c.

◆ mcxe31EthSendPacket()

error_t mcxe31EthSendPacket	(	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 528 of file mcxe31_eth_driver.c.

◆ mcxe31EthTick()

void mcxe31EthTick ( NetInterface * interface )

MCX E31 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 370 of file mcxe31_eth_driver.c.

◆ mcxe31EthUpdateMacAddrFilter()

error_t mcxe31EthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 672 of file mcxe31_eth_driver.c.

◆ mcxe31EthUpdateMacConfig()

error_t mcxe31EthUpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 803 of file mcxe31_eth_driver.c.

◆ mcxe31EthWritePhyReg()

void mcxe31EthWritePhyReg	(	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 846 of file mcxe31_eth_driver.c.

Variable Documentation

◆ mcxe31EthDriver

const NicDriver mcxe31EthDriver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   mcxe31EthInit,
   mcxe31EthTick,
   mcxe31EthEnableIrq,
   mcxe31EthDisableIrq,
   mcxe31EthEventHandler,
   mcxe31EthSendPacket,
   mcxe31EthUpdateMacAddrFilter,
   mcxe31EthUpdateMacConfig,
   mcxe31EthWritePhyReg,
   mcxe31EthReadPhyReg,
   TRUE,
   TRUE,
   TRUE,
   FALSE
}

MCX E31 Ethernet MAC driver.

Definition at line 94 of file mcxe31_eth_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ EMAC_0_IRQHandler()

◆ mcxe31EthCalcCrc()

◆ mcxe31EthDisableIrq()

◆ mcxe31EthEnableIrq()

◆ mcxe31EthEventHandler()

◆ mcxe31EthInit()

◆ mcxe31EthInitDmaDesc()

◆ mcxe31EthInitGpio()

◆ mcxe31EthReadPhyReg()

◆ mcxe31EthReceivePacket()

◆ mcxe31EthSendPacket()

◆ mcxe31EthTick()

◆ mcxe31EthUpdateMacAddrFilter()

◆ mcxe31EthUpdateMacConfig()

◆ mcxe31EthWritePhyReg()

Variable Documentation

◆ mcxe31EthDriver