mcimx6ul_eth2_driver.h File Reference

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

Go to the source code of this file.

Macros
#define	MCIMX6UL_ETH2_TX_BUFFER_COUNT   8
#define	MCIMX6UL_ETH2_TX_BUFFER_SIZE   1536
#define	MCIMX6UL_ETH2_RX_BUFFER_COUNT   8
#define	MCIMX6UL_ETH2_RX_BUFFER_SIZE   1536
#define	MCIMX6UL_ETH2_IRQ_PRIORITY   21
#define	MCIMX6UL_ETH2_RAM_SECTION   "NonCacheable"
#define	ENET_TBD0_R   0x80000000
#define	ENET_TBD0_TO1   0x40000000
#define	ENET_TBD0_W   0x20000000
#define	ENET_TBD0_TO2   0x10000000
#define	ENET_TBD0_L   0x08000000
#define	ENET_TBD0_TC   0x04000000
#define	ENET_TBD0_DATA_LENGTH   0x0000FFFF
#define	ENET_TBD1_DATA_POINTER   0xFFFFFFFF
#define	ENET_TBD2_INT   0x40000000
#define	ENET_TBD2_TS   0x20000000
#define	ENET_TBD2_PINS   0x10000000
#define	ENET_TBD2_IINS   0x08000000
#define	ENET_TBD2_TXE   0x00008000
#define	ENET_TBD2_UE   0x00002000
#define	ENET_TBD2_EE   0x00001000
#define	ENET_TBD2_FE   0x00000800
#define	ENET_TBD2_LCE   0x00000400
#define	ENET_TBD2_OE   0x00000200
#define	ENET_TBD2_TSE   0x00000100
#define	ENET_TBD4_BDU   0x80000000
#define	ENET_TBD5_TIMESTAMP   0xFFFFFFFF
#define	ENET_RBD0_E   0x80000000
#define	ENET_RBD0_RO1   0x40000000
#define	ENET_RBD0_W   0x20000000
#define	ENET_RBD0_RO2   0x10000000
#define	ENET_RBD0_L   0x08000000
#define	ENET_RBD0_M   0x01000000
#define	ENET_RBD0_BC   0x00800000
#define	ENET_RBD0_MC   0x00400000
#define	ENET_RBD0_LG   0x00200000
#define	ENET_RBD0_NO   0x00100000
#define	ENET_RBD0_CR   0x00040000
#define	ENET_RBD0_OV   0x00020000
#define	ENET_RBD0_TR   0x00010000
#define	ENET_RBD0_DATA_LENGTH   0x0000FFFF
#define	ENET_RBD1_DATA_POINTER   0xFFFFFFFF
#define	ENET_RBD2_ME   0x80000000
#define	ENET_RBD2_PE   0x04000000
#define	ENET_RBD2_CE   0x02000000
#define	ENET_RBD2_UC   0x01000000
#define	ENET_RBD2_INT   0x00800000
#define	ENET_RBD2_VPCP   0x0000E000
#define	ENET_RBD2_ICE   0x00000020
#define	ENET_RBD2_PCR   0x00000010
#define	ENET_RBD2_VLAN   0x00000004
#define	ENET_RBD2_IPV6   0x00000002
#define	ENET_RBD2_FRAG   0x00000001
#define	ENET_RBD3_HEADER_LENGTH   0xF8000000
#define	ENET_RBD3_PROTOCOL_TYPE   0x00FF0000
#define	ENET_RBD3_PAYLOAD_CHECKSUM   0x0000FFFF
#define	ENET_RBD4_BDU   0x80000000
#define	ENET_RBD5_TIMESTAMP   0xFFFFFFFF

Functions
error_t	mcimx6ulEth2Init (NetInterface *interface)
	i.MX6UL Ethernet MAC initialization More...
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	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

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 mcimx6ul_eth2_driver.h.

Macro Definition Documentation

ENET_RBD0_BC

#define ENET_RBD0_BC   0x00800000

Definition at line 104 of file mcimx6ul_eth2_driver.h.

ENET_RBD0_CR

#define ENET_RBD0_CR   0x00040000

Definition at line 108 of file mcimx6ul_eth2_driver.h.

ENET_RBD0_DATA_LENGTH

#define ENET_RBD0_DATA_LENGTH   0x0000FFFF

Definition at line 111 of file mcimx6ul_eth2_driver.h.

ENET_RBD0_E

#define ENET_RBD0_E   0x80000000

Definition at line 98 of file mcimx6ul_eth2_driver.h.

ENET_RBD0_L

#define ENET_RBD0_L   0x08000000

Definition at line 102 of file mcimx6ul_eth2_driver.h.

ENET_RBD0_LG

#define ENET_RBD0_LG   0x00200000

Definition at line 106 of file mcimx6ul_eth2_driver.h.

ENET_RBD0_M

#define ENET_RBD0_M   0x01000000

Definition at line 103 of file mcimx6ul_eth2_driver.h.

ENET_RBD0_MC

#define ENET_RBD0_MC   0x00400000

Definition at line 105 of file mcimx6ul_eth2_driver.h.

ENET_RBD0_NO

#define ENET_RBD0_NO   0x00100000

Definition at line 107 of file mcimx6ul_eth2_driver.h.

ENET_RBD0_OV

#define ENET_RBD0_OV   0x00020000

Definition at line 109 of file mcimx6ul_eth2_driver.h.

ENET_RBD0_RO1

#define ENET_RBD0_RO1   0x40000000

Definition at line 99 of file mcimx6ul_eth2_driver.h.

ENET_RBD0_RO2

#define ENET_RBD0_RO2   0x10000000

Definition at line 101 of file mcimx6ul_eth2_driver.h.

ENET_RBD0_TR

#define ENET_RBD0_TR   0x00010000

Definition at line 110 of file mcimx6ul_eth2_driver.h.

ENET_RBD0_W

#define ENET_RBD0_W   0x20000000

Definition at line 100 of file mcimx6ul_eth2_driver.h.

ENET_RBD1_DATA_POINTER

#define ENET_RBD1_DATA_POINTER   0xFFFFFFFF

Definition at line 112 of file mcimx6ul_eth2_driver.h.

ENET_RBD2_CE

#define ENET_RBD2_CE   0x02000000

Definition at line 115 of file mcimx6ul_eth2_driver.h.

ENET_RBD2_FRAG

#define ENET_RBD2_FRAG   0x00000001

Definition at line 123 of file mcimx6ul_eth2_driver.h.

ENET_RBD2_ICE

#define ENET_RBD2_ICE   0x00000020

Definition at line 119 of file mcimx6ul_eth2_driver.h.

ENET_RBD2_INT

#define ENET_RBD2_INT   0x00800000

Definition at line 117 of file mcimx6ul_eth2_driver.h.

ENET_RBD2_IPV6

#define ENET_RBD2_IPV6   0x00000002

Definition at line 122 of file mcimx6ul_eth2_driver.h.

ENET_RBD2_ME

#define ENET_RBD2_ME   0x80000000

Definition at line 113 of file mcimx6ul_eth2_driver.h.

ENET_RBD2_PCR

#define ENET_RBD2_PCR   0x00000010

Definition at line 120 of file mcimx6ul_eth2_driver.h.

ENET_RBD2_PE

#define ENET_RBD2_PE   0x04000000

Definition at line 114 of file mcimx6ul_eth2_driver.h.

ENET_RBD2_UC

#define ENET_RBD2_UC   0x01000000

Definition at line 116 of file mcimx6ul_eth2_driver.h.

ENET_RBD2_VLAN

#define ENET_RBD2_VLAN   0x00000004

Definition at line 121 of file mcimx6ul_eth2_driver.h.

ENET_RBD2_VPCP

#define ENET_RBD2_VPCP   0x0000E000

Definition at line 118 of file mcimx6ul_eth2_driver.h.

ENET_RBD3_HEADER_LENGTH

#define ENET_RBD3_HEADER_LENGTH   0xF8000000

Definition at line 124 of file mcimx6ul_eth2_driver.h.

ENET_RBD3_PAYLOAD_CHECKSUM

#define ENET_RBD3_PAYLOAD_CHECKSUM   0x0000FFFF

Definition at line 126 of file mcimx6ul_eth2_driver.h.

ENET_RBD3_PROTOCOL_TYPE

#define ENET_RBD3_PROTOCOL_TYPE   0x00FF0000

Definition at line 125 of file mcimx6ul_eth2_driver.h.

ENET_RBD4_BDU

#define ENET_RBD4_BDU   0x80000000

Definition at line 127 of file mcimx6ul_eth2_driver.h.

ENET_RBD5_TIMESTAMP

#define ENET_RBD5_TIMESTAMP   0xFFFFFFFF

Definition at line 128 of file mcimx6ul_eth2_driver.h.

ENET_TBD0_DATA_LENGTH

#define ENET_TBD0_DATA_LENGTH   0x0000FFFF

Definition at line 81 of file mcimx6ul_eth2_driver.h.

ENET_TBD0_L

#define ENET_TBD0_L   0x08000000

Definition at line 79 of file mcimx6ul_eth2_driver.h.

ENET_TBD0_R

#define ENET_TBD0_R   0x80000000

Definition at line 75 of file mcimx6ul_eth2_driver.h.

ENET_TBD0_TC

#define ENET_TBD0_TC   0x04000000

Definition at line 80 of file mcimx6ul_eth2_driver.h.

ENET_TBD0_TO1

#define ENET_TBD0_TO1   0x40000000

Definition at line 76 of file mcimx6ul_eth2_driver.h.

ENET_TBD0_TO2

#define ENET_TBD0_TO2   0x10000000

Definition at line 78 of file mcimx6ul_eth2_driver.h.

ENET_TBD0_W

#define ENET_TBD0_W   0x20000000

Definition at line 77 of file mcimx6ul_eth2_driver.h.

ENET_TBD1_DATA_POINTER

#define ENET_TBD1_DATA_POINTER   0xFFFFFFFF

Definition at line 82 of file mcimx6ul_eth2_driver.h.

ENET_TBD2_EE

#define ENET_TBD2_EE   0x00001000

Definition at line 89 of file mcimx6ul_eth2_driver.h.

ENET_TBD2_FE

#define ENET_TBD2_FE   0x00000800

Definition at line 90 of file mcimx6ul_eth2_driver.h.

ENET_TBD2_IINS

#define ENET_TBD2_IINS   0x08000000

Definition at line 86 of file mcimx6ul_eth2_driver.h.

ENET_TBD2_INT

#define ENET_TBD2_INT   0x40000000

Definition at line 83 of file mcimx6ul_eth2_driver.h.

ENET_TBD2_LCE

#define ENET_TBD2_LCE   0x00000400

Definition at line 91 of file mcimx6ul_eth2_driver.h.

ENET_TBD2_OE

#define ENET_TBD2_OE   0x00000200

Definition at line 92 of file mcimx6ul_eth2_driver.h.

ENET_TBD2_PINS

#define ENET_TBD2_PINS   0x10000000

Definition at line 85 of file mcimx6ul_eth2_driver.h.

ENET_TBD2_TS

#define ENET_TBD2_TS   0x20000000

Definition at line 84 of file mcimx6ul_eth2_driver.h.

ENET_TBD2_TSE

#define ENET_TBD2_TSE   0x00000100

Definition at line 93 of file mcimx6ul_eth2_driver.h.

ENET_TBD2_TXE

#define ENET_TBD2_TXE   0x00008000

Definition at line 87 of file mcimx6ul_eth2_driver.h.

ENET_TBD2_UE

#define ENET_TBD2_UE   0x00002000

Definition at line 88 of file mcimx6ul_eth2_driver.h.

ENET_TBD4_BDU

#define ENET_TBD4_BDU   0x80000000

Definition at line 94 of file mcimx6ul_eth2_driver.h.

ENET_TBD5_TIMESTAMP

#define ENET_TBD5_TIMESTAMP   0xFFFFFFFF

Definition at line 95 of file mcimx6ul_eth2_driver.h.

MCIMX6UL_ETH2_IRQ_PRIORITY

#define MCIMX6UL_ETH2_IRQ_PRIORITY   21

Definition at line 64 of file mcimx6ul_eth2_driver.h.

MCIMX6UL_ETH2_RAM_SECTION

#define MCIMX6UL_ETH2_RAM_SECTION   "NonCacheable"

Definition at line 71 of file mcimx6ul_eth2_driver.h.

MCIMX6UL_ETH2_RX_BUFFER_COUNT

#define MCIMX6UL_ETH2_RX_BUFFER_COUNT   8

Definition at line 50 of file mcimx6ul_eth2_driver.h.

MCIMX6UL_ETH2_RX_BUFFER_SIZE

#define MCIMX6UL_ETH2_RX_BUFFER_SIZE   1536

Definition at line 57 of file mcimx6ul_eth2_driver.h.

MCIMX6UL_ETH2_TX_BUFFER_COUNT

#define MCIMX6UL_ETH2_TX_BUFFER_COUNT   8

Definition at line 36 of file mcimx6ul_eth2_driver.h.

MCIMX6UL_ETH2_TX_BUFFER_SIZE

#define MCIMX6UL_ETH2_TX_BUFFER_SIZE   1536

Definition at line 43 of file mcimx6ul_eth2_driver.h.

Function Documentation

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()

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

extern

i.MX6UL Ethernet MAC driver (ENET2 instance)

Definition at line 93 of file mcimx6ul_eth2_driver.c.