NXP MCX E31B 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/mcxe31b_eth_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	mcxe31bEthInit (NetInterface *interface)
	MCX E31B Ethernet MAC initialization. More...

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

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

void	mcxe31bEthTick (NetInterface *interface)
	MCX E31B Ethernet MAC timer handler. More...

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

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

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

void	mcxe31bEthEventHandler (NetInterface *interface)
	MCX E31B Ethernet MAC event handler. More...

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

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

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

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

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

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

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

Variables
const NicDriver	mcxe31bEthDriver
	MCX E31B Ethernet MAC driver. More...

Detailed Description

NXP MCX E31B 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.0

Definition in file mcxe31b_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file mcxe31b_eth_driver.c.

Function Documentation

◆ EMAC_0_IRQHandler()

void EMAC_0_IRQHandler ( void )

MCX E31B Ethernet MAC interrupt service routine.

Definition at line 450 of file mcxe31b_eth_driver.c.

◆ mcxe31bEthCalcCrc()

uint32_t mcxe31bEthCalcCrc	(	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 mcxe31b_eth_driver.c.

◆ mcxe31bEthDisableIrq()

void mcxe31bEthDisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 423 of file mcxe31b_eth_driver.c.

◆ mcxe31bEthEnableIrq()

void mcxe31bEthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 395 of file mcxe31b_eth_driver.c.

◆ mcxe31bEthEventHandler()

void mcxe31bEthEventHandler ( NetInterface * interface )

MCX E31B Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 503 of file mcxe31b_eth_driver.c.

◆ mcxe31bEthInit()

error_t mcxe31bEthInit ( NetInterface * interface )

MCX E31B Ethernet MAC initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 121 of file mcxe31b_eth_driver.c.

◆ mcxe31bEthInitDmaDesc()

void mcxe31bEthInitDmaDesc ( NetInterface * interface )

Initialize DMA descriptor lists.

Parameters

[in] interface Underlying network interface

Definition at line 313 of file mcxe31b_eth_driver.c.

◆ mcxe31bEthInitGpio()

__weak_func void mcxe31bEthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 256 of file mcxe31b_eth_driver.c.

◆ mcxe31bEthReadPhyReg()

uint16_t mcxe31bEthReadPhyReg	(	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 mcxe31b_eth_driver.c.

◆ mcxe31bEthReceivePacket()

error_t mcxe31bEthReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 595 of file mcxe31b_eth_driver.c.

◆ mcxe31bEthSendPacket()

error_t mcxe31bEthSendPacket	(	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 mcxe31b_eth_driver.c.

◆ mcxe31bEthTick()

void mcxe31bEthTick ( NetInterface * interface )

MCX E31B 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 mcxe31b_eth_driver.c.

◆ mcxe31bEthUpdateMacAddrFilter()

error_t mcxe31bEthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 672 of file mcxe31b_eth_driver.c.

◆ mcxe31bEthUpdateMacConfig()

error_t mcxe31bEthUpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 803 of file mcxe31b_eth_driver.c.

◆ mcxe31bEthWritePhyReg()

void mcxe31bEthWritePhyReg	(	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 mcxe31b_eth_driver.c.

Variable Documentation

◆ mcxe31bEthDriver

const NicDriver mcxe31bEthDriver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   mcxe31bEthInit,
   mcxe31bEthTick,
   mcxe31bEthEnableIrq,
   mcxe31bEthDisableIrq,
   mcxe31bEthEventHandler,
   mcxe31bEthSendPacket,
   mcxe31bEthUpdateMacAddrFilter,
   mcxe31bEthUpdateMacConfig,
   mcxe31bEthWritePhyReg,
   mcxe31bEthReadPhyReg,
   TRUE,
   TRUE,
   TRUE,
   FALSE
}

MCX E31B Ethernet MAC driver.

Definition at line 94 of file mcxe31b_eth_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ EMAC_0_IRQHandler()

◆ mcxe31bEthCalcCrc()

◆ mcxe31bEthDisableIrq()

◆ mcxe31bEthEnableIrq()

◆ mcxe31bEthEventHandler()

◆ mcxe31bEthInit()

◆ mcxe31bEthInitDmaDesc()

◆ mcxe31bEthInitGpio()

◆ mcxe31bEthReadPhyReg()

◆ mcxe31bEthReceivePacket()

◆ mcxe31bEthSendPacket()

◆ mcxe31bEthTick()

◆ mcxe31bEthUpdateMacAddrFilter()

◆ mcxe31bEthUpdateMacConfig()

◆ mcxe31bEthWritePhyReg()

Variable Documentation

◆ mcxe31bEthDriver