mpc5777_eth_driver.h File Reference

NXP MPC5777 Ethernet MAC driver. More...

Go to the source code of this file.

Macros
#define	MPC5777_ETH_TX_BUFFER_COUNT   3
#define	MPC5777_ETH_TX_BUFFER_SIZE   1536
#define	MPC5777_ETH_RX_BUFFER_COUNT   6
#define	MPC5777_ETH_RX_BUFFER_SIZE   1536
#define	MPC5777_ETH_IRQ_PRIORITY   10
#define	FEC_TBD0_R   0x80000000
#define	FEC_TBD0_TO1   0x40000000
#define	FEC_TBD0_W   0x20000000
#define	FEC_TBD0_TO2   0x10000000
#define	FEC_TBD0_L   0x08000000
#define	FEC_TBD0_TC   0x04000000
#define	FEC_TBD0_DATA_LENGTH   0x0000FFFF
#define	FEC_TBD1_DATA_POINTER   0xFFFFFFFF
#define	FEC_RBD0_E   0x80000000
#define	FEC_RBD0_RO1   0x40000000
#define	FEC_RBD0_W   0x20000000
#define	FEC_RBD0_RO2   0x10000000
#define	FEC_RBD0_L   0x08000000
#define	FEC_RBD0_M   0x01000000
#define	FEC_RBD0_BC   0x00800000
#define	FEC_RBD0_MC   0x00400000
#define	FEC_RBD0_LG   0x00200000
#define	FEC_RBD0_NO   0x00100000
#define	FEC_RBD0_CR   0x00040000
#define	FEC_RBD0_OV   0x00020000
#define	FEC_RBD0_TR   0x00010000
#define	FEC_RBD0_DATA_LENGTH   0x0000FFFF
#define	FEC_RBD1_DATA_POINTER   0xFFFFFFFF

Functions
error_t	mpc5777EthInit (NetInterface *interface)
	MPC5777 Ethernet MAC initialization. More...
void	mpc5777EthInitGpio (NetInterface *interface)
	GPIO configuration. More...
void	mpc5777EthInitBufferDesc (NetInterface *interface)
	Initialize buffer descriptors. More...
void	mpc5777EthTick (NetInterface *interface)
	MPC5777 Ethernet MAC timer handler. More...
void	mpc5777EthEnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	mpc5777EthDisableIrq (NetInterface *interface)
	Disable interrupts. More...
void	mpc5777EthEventHandler (NetInterface *interface)
	MPC5777 Ethernet MAC event handler. More...
error_t	mpc5777EthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
	Send a packet. More...
error_t	mpc5777EthReceivePacket (NetInterface *interface)
	Receive a packet. More...
error_t	mpc5777EthUpdateMacAddrFilter (NetInterface *interface)
	Configure MAC address filtering. More...
error_t	mpc5777EthUpdateMacConfig (NetInterface *interface)
	Adjust MAC configuration parameters for proper operation. More...
void	mpc5777EthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
	Write PHY register. More...
uint16_t	mpc5777EthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
	Read PHY register. More...
uint32_t	mpc5777EthCalcCrc (const void *data, size_t length)
	CRC calculation. More...

Variables
const NicDriver	mpc5777EthDriver
	MPC5777 Ethernet MAC driver. More...

Detailed Description

NXP MPC5777 Ethernet MAC driver.

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

Macro Definition Documentation

FEC_RBD0_BC

#define FEC_RBD0_BC   0x00800000

Definition at line 86 of file mpc5777_eth_driver.h.

FEC_RBD0_CR

#define FEC_RBD0_CR   0x00040000

Definition at line 90 of file mpc5777_eth_driver.h.

FEC_RBD0_DATA_LENGTH

#define FEC_RBD0_DATA_LENGTH   0x0000FFFF

Definition at line 93 of file mpc5777_eth_driver.h.

FEC_RBD0_E

#define FEC_RBD0_E   0x80000000

Definition at line 80 of file mpc5777_eth_driver.h.

FEC_RBD0_L

#define FEC_RBD0_L   0x08000000

Definition at line 84 of file mpc5777_eth_driver.h.

FEC_RBD0_LG

#define FEC_RBD0_LG   0x00200000

Definition at line 88 of file mpc5777_eth_driver.h.

FEC_RBD0_M

#define FEC_RBD0_M   0x01000000

Definition at line 85 of file mpc5777_eth_driver.h.

FEC_RBD0_MC

#define FEC_RBD0_MC   0x00400000

Definition at line 87 of file mpc5777_eth_driver.h.

FEC_RBD0_NO

#define FEC_RBD0_NO   0x00100000

Definition at line 89 of file mpc5777_eth_driver.h.

FEC_RBD0_OV

#define FEC_RBD0_OV   0x00020000

Definition at line 91 of file mpc5777_eth_driver.h.

FEC_RBD0_RO1

#define FEC_RBD0_RO1   0x40000000

Definition at line 81 of file mpc5777_eth_driver.h.

FEC_RBD0_RO2

#define FEC_RBD0_RO2   0x10000000

Definition at line 83 of file mpc5777_eth_driver.h.

FEC_RBD0_TR

#define FEC_RBD0_TR   0x00010000

Definition at line 92 of file mpc5777_eth_driver.h.

FEC_RBD0_W

#define FEC_RBD0_W   0x20000000

Definition at line 82 of file mpc5777_eth_driver.h.

FEC_RBD1_DATA_POINTER

#define FEC_RBD1_DATA_POINTER   0xFFFFFFFF

Definition at line 94 of file mpc5777_eth_driver.h.

FEC_TBD0_DATA_LENGTH

#define FEC_TBD0_DATA_LENGTH   0x0000FFFF

Definition at line 76 of file mpc5777_eth_driver.h.

FEC_TBD0_L

#define FEC_TBD0_L   0x08000000

Definition at line 74 of file mpc5777_eth_driver.h.

FEC_TBD0_R

#define FEC_TBD0_R   0x80000000

Definition at line 70 of file mpc5777_eth_driver.h.

FEC_TBD0_TC

#define FEC_TBD0_TC   0x04000000

Definition at line 75 of file mpc5777_eth_driver.h.

FEC_TBD0_TO1

#define FEC_TBD0_TO1   0x40000000

Definition at line 71 of file mpc5777_eth_driver.h.

FEC_TBD0_TO2

#define FEC_TBD0_TO2   0x10000000

Definition at line 73 of file mpc5777_eth_driver.h.

FEC_TBD0_W

#define FEC_TBD0_W   0x20000000

Definition at line 72 of file mpc5777_eth_driver.h.

FEC_TBD1_DATA_POINTER

#define FEC_TBD1_DATA_POINTER   0xFFFFFFFF

Definition at line 77 of file mpc5777_eth_driver.h.

MPC5777_ETH_IRQ_PRIORITY

#define MPC5777_ETH_IRQ_PRIORITY   10

Definition at line 64 of file mpc5777_eth_driver.h.

MPC5777_ETH_RX_BUFFER_COUNT

#define MPC5777_ETH_RX_BUFFER_COUNT   6

Definition at line 50 of file mpc5777_eth_driver.h.

MPC5777_ETH_RX_BUFFER_SIZE

#define MPC5777_ETH_RX_BUFFER_SIZE   1536

Definition at line 57 of file mpc5777_eth_driver.h.

MPC5777_ETH_TX_BUFFER_COUNT

#define MPC5777_ETH_TX_BUFFER_COUNT   3

Definition at line 36 of file mpc5777_eth_driver.h.

MPC5777_ETH_TX_BUFFER_SIZE

#define MPC5777_ETH_TX_BUFFER_SIZE   1536

Definition at line 43 of file mpc5777_eth_driver.h.

Function Documentation

mpc5777EthCalcCrc()

uint32_t mpc5777EthCalcCrc	(	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 890 of file mpc5777_eth_driver.c.

mpc5777EthDisableIrq()

void mpc5777EthDisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 324 of file mpc5777_eth_driver.c.

mpc5777EthEnableIrq()

void mpc5777EthEnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 294 of file mpc5777_eth_driver.c.

mpc5777EthEventHandler()

void mpc5777EthEventHandler

(

NetInterface *

interface

)

MPC5777 Ethernet MAC event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 452 of file mpc5777_eth_driver.c.

mpc5777EthInit()

error_t mpc5777EthInit

(

NetInterface *

interface

)

MPC5777 Ethernet MAC initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 94 of file mpc5777_eth_driver.c.

mpc5777EthInitBufferDesc()

void mpc5777EthInitBufferDesc

(

NetInterface *

interface

)

Initialize buffer descriptors.

Parameters

[in]

interface

Underlying network interface

Definition at line 212 of file mpc5777_eth_driver.c.

mpc5777EthInitGpio()

void mpc5777EthInitGpio

(

NetInterface *

interface

)

GPIO configuration.

Parameters

[in]

interface

Underlying network interface

Definition at line 202 of file mpc5777_eth_driver.c.

mpc5777EthReadPhyReg()

uint16_t mpc5777EthReadPhyReg	(	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 843 of file mpc5777_eth_driver.c.

mpc5777EthReceivePacket()

error_t mpc5777EthReceivePacket

(

NetInterface *

interface

)

Receive a packet.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 577 of file mpc5777_eth_driver.c.

mpc5777EthSendPacket()

error_t mpc5777EthSendPacket	(	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 507 of file mpc5777_eth_driver.c.

mpc5777EthTick()

void mpc5777EthTick

(

NetInterface *

interface

)

MPC5777 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 269 of file mpc5777_eth_driver.c.

mpc5777EthUpdateMacAddrFilter()

error_t mpc5777EthUpdateMacAddrFilter

(

NetInterface *

interface

)

Configure MAC address filtering.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 658 of file mpc5777_eth_driver.c.

mpc5777EthUpdateMacConfig()

error_t mpc5777EthUpdateMacConfig

(

NetInterface *

interface

)

Adjust MAC configuration parameters for proper operation.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 747 of file mpc5777_eth_driver.c.

mpc5777EthWritePhyReg()

void mpc5777EthWritePhyReg	(	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 801 of file mpc5777_eth_driver.c.

Variable Documentation

mpc5777EthDriver

const NicDriver mpc5777EthDriver

extern

MPC5777 Ethernet MAC driver.

Definition at line 67 of file mpc5777_eth_driver.c.