NXP i.MX6UL Ethernet MAC driver (ENET2 instance) More...

#include "fsl_device_registers.h"
#include "fsl_gpio.h"
#include "fsl_iomuxc.h"
#include "core/net.h"
#include "drivers/mac/mcimx6ul_eth2_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	mcimx6ulEth2Init (NetInterface *interface)
	i.MX6UL Ethernet MAC initialization More...

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

void	mcimx6ulEth2InitBufferDesc (NetInterface *interface)
	Initialize buffer descriptors. More...

void	mcimx6ulEth2Tick (NetInterface *interface)
	i.MX6UL Ethernet MAC timer handler More...

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

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

void	ENET2_DriverIRQHandler (uint32_t giccIar, void *userParam)
	Ethernet MAC interrupt (ENET2 instance) More...

void	mcimx6ulEth2EventHandler (NetInterface *interface)
	i.MX6UL Ethernet MAC event handler More...

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

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

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

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

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

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

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

Variables
const NicDriver	mcimx6ulEth2Driver
	i.MX6UL Ethernet MAC driver (ENET2 instance) More...

Detailed Description

NXP i.MX6UL Ethernet MAC driver (ENET2 instance)

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

Definition in file mcimx6ul_eth2_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file mcimx6ul_eth2_driver.c.

Function Documentation

◆ ENET2_DriverIRQHandler()

void ENET2_DriverIRQHandler	(	uint32_t	giccIar,
		void *	userParam
	)

Ethernet MAC interrupt (ENET2 instance)

Parameters

[in]	giccIar	Value of the GICC_IAR register
[in]	userParam	User parameter

Definition at line 548 of file mcimx6ul_eth2_driver.c.

◆ mcimx6ulEth2CalcCrc()

uint32_t mcimx6ulEth2CalcCrc	(	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 1059 of file mcimx6ul_eth2_driver.c.

◆ mcimx6ulEth2DisableIrq()

void mcimx6ulEth2DisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 519 of file mcimx6ul_eth2_driver.c.

◆ mcimx6ulEth2EnableIrq()

void mcimx6ulEth2EnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 491 of file mcimx6ul_eth2_driver.c.

◆ mcimx6ulEth2EventHandler()

void mcimx6ulEth2EventHandler ( NetInterface * interface )

i.MX6UL Ethernet MAC event handler

Parameters

[in] interface Underlying network interface

Definition at line 612 of file mcimx6ul_eth2_driver.c.

◆ mcimx6ulEth2Init()

error_t mcimx6ulEth2Init ( NetInterface * interface )

i.MX6UL Ethernet MAC initialization

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 120 of file mcimx6ul_eth2_driver.c.

◆ mcimx6ulEth2InitBufferDesc()

void mcimx6ulEth2InitBufferDesc ( NetInterface * interface )

Initialize buffer descriptors.

Parameters

[in] interface Underlying network interface

Definition at line 405 of file mcimx6ul_eth2_driver.c.

◆ mcimx6ulEth2InitGpio()

__weak_func void mcimx6ulEth2InitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 236 of file mcimx6ul_eth2_driver.c.

◆ mcimx6ulEth2ReadPhyReg()

uint16_t mcimx6ulEth2ReadPhyReg	(	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 1012 of file mcimx6ul_eth2_driver.c.

◆ mcimx6ulEth2ReceivePacket()

error_t mcimx6ulEth2ReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 742 of file mcimx6ul_eth2_driver.c.

◆ mcimx6ulEth2SendPacket()

error_t mcimx6ulEth2SendPacket	(	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 667 of file mcimx6ul_eth2_driver.c.

◆ mcimx6ulEth2Tick()

void mcimx6ulEth2Tick ( NetInterface * interface )

i.MX6UL 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 466 of file mcimx6ul_eth2_driver.c.

◆ mcimx6ulEth2UpdateMacAddrFilter()

error_t mcimx6ulEth2UpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 827 of file mcimx6ul_eth2_driver.c.

◆ mcimx6ulEth2UpdateMacConfig()

error_t mcimx6ulEth2UpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 916 of file mcimx6ul_eth2_driver.c.

◆ mcimx6ulEth2WritePhyReg()

void mcimx6ulEth2WritePhyReg	(	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 970 of file mcimx6ul_eth2_driver.c.

Variable Documentation

◆ mcimx6ulEth2Driver

const NicDriver mcimx6ulEth2Driver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   mcimx6ulEth2Init,
   mcimx6ulEth2Tick,
   mcimx6ulEth2EnableIrq,
   mcimx6ulEth2DisableIrq,
   mcimx6ulEth2EventHandler,
   mcimx6ulEth2SendPacket,
   mcimx6ulEth2UpdateMacAddrFilter,
   mcimx6ulEth2UpdateMacConfig,
   mcimx6ulEth2WritePhyReg,
   mcimx6ulEth2ReadPhyReg,
   TRUE,
   TRUE,
   TRUE,
   FALSE
}

i.MX6UL Ethernet MAC driver (ENET2 instance)

Definition at line 93 of file mcimx6ul_eth2_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ENET2_DriverIRQHandler()

◆ mcimx6ulEth2CalcCrc()

◆ mcimx6ulEth2DisableIrq()

◆ mcimx6ulEth2EnableIrq()

◆ mcimx6ulEth2EventHandler()

◆ mcimx6ulEth2Init()

◆ mcimx6ulEth2InitBufferDesc()

◆ mcimx6ulEth2InitGpio()

◆ mcimx6ulEth2ReadPhyReg()

◆ mcimx6ulEth2ReceivePacket()

◆ mcimx6ulEth2SendPacket()

◆ mcimx6ulEth2Tick()

◆ mcimx6ulEth2UpdateMacAddrFilter()

◆ mcimx6ulEth2UpdateMacConfig()

◆ mcimx6ulEth2WritePhyReg()

Variable Documentation

◆ mcimx6ulEth2Driver