NXP Kinetis KV5x Ethernet MAC driver. More...

#include "fsl_device_registers.h"
#include "core/net.h"
#include "drivers/mac/mkv5x_eth_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	mkv5xEthInit (NetInterface *interface)
	Kinetis KV5x Ethernet MAC initialization. More...

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

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

void	mkv5xEthTick (NetInterface *interface)
	Kinetis KV5x Ethernet MAC timer handler. More...

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

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

void	ENET_Transmit_IRQHandler (void)
	Ethernet MAC transmit interrupt. More...

void	ENET_Receive_IRQHandler (void)
	Ethernet MAC receive interrupt. More...

void	ENET_Error_IRQHandler (void)
	Ethernet MAC error interrupt. More...

void	mkv5xEthEventHandler (NetInterface *interface)
	Kinetis KV5x Ethernet MAC event handler. More...

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

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

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

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

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

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

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

Variables
const NicDriver	mkv5xEthDriver
	Kinetis KV5x Ethernet MAC driver. More...

Detailed Description

NXP Kinetis KV5x 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.5.4

Definition in file mkv5x_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file mkv5x_eth_driver.c.

Function Documentation

◆ ENET_Error_IRQHandler()

void ENET_Error_IRQHandler ( void )

Ethernet MAC error interrupt.

Definition at line 511 of file mkv5x_eth_driver.c.

◆ ENET_Receive_IRQHandler()

void ENET_Receive_IRQHandler ( void )

Ethernet MAC receive interrupt.

Definition at line 480 of file mkv5x_eth_driver.c.

◆ ENET_Transmit_IRQHandler()

void ENET_Transmit_IRQHandler ( void )

Ethernet MAC transmit interrupt.

Definition at line 444 of file mkv5x_eth_driver.c.

◆ mkv5xEthCalcCrc()

uint32_t mkv5xEthCalcCrc	(	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 984 of file mkv5x_eth_driver.c.

◆ mkv5xEthDisableIrq()

void mkv5xEthDisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 415 of file mkv5x_eth_driver.c.

◆ mkv5xEthEnableIrq()

void mkv5xEthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 385 of file mkv5x_eth_driver.c.

◆ mkv5xEthEventHandler()

void mkv5xEthEventHandler ( NetInterface * interface )

Kinetis KV5x Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 543 of file mkv5x_eth_driver.c.

◆ mkv5xEthInit()

error_t mkv5xEthInit ( NetInterface * interface )

Kinetis KV5x Ethernet MAC initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 118 of file mkv5x_eth_driver.c.

◆ mkv5xEthInitBufferDesc()

void mkv5xEthInitBufferDesc ( NetInterface * interface )

Initialize buffer descriptors.

Parameters

[in] interface Underlying network interface

Definition at line 299 of file mkv5x_eth_driver.c.

◆ mkv5xEthInitGpio()

__weak_func void mkv5xEthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 249 of file mkv5x_eth_driver.c.

◆ mkv5xEthReadPhyReg()

uint16_t mkv5xEthReadPhyReg	(	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 937 of file mkv5x_eth_driver.c.

◆ mkv5xEthReceivePacket()

error_t mkv5xEthReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 671 of file mkv5x_eth_driver.c.

◆ mkv5xEthSendPacket()

error_t mkv5xEthSendPacket	(	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 598 of file mkv5x_eth_driver.c.

◆ mkv5xEthTick()

void mkv5xEthTick ( NetInterface * interface )

Kinetis KV5x 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 360 of file mkv5x_eth_driver.c.

◆ mkv5xEthUpdateMacAddrFilter()

error_t mkv5xEthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 752 of file mkv5x_eth_driver.c.

◆ mkv5xEthUpdateMacConfig()

error_t mkv5xEthUpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 841 of file mkv5x_eth_driver.c.

◆ mkv5xEthWritePhyReg()

void mkv5xEthWritePhyReg	(	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 895 of file mkv5x_eth_driver.c.

Variable Documentation

◆ mkv5xEthDriver

const NicDriver mkv5xEthDriver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   mkv5xEthInit,
   mkv5xEthTick,
   mkv5xEthEnableIrq,
   mkv5xEthDisableIrq,
   mkv5xEthEventHandler,
   mkv5xEthSendPacket,
   mkv5xEthUpdateMacAddrFilter,
   mkv5xEthUpdateMacConfig,
   mkv5xEthWritePhyReg,
   mkv5xEthReadPhyReg,
   TRUE,
   TRUE,
   TRUE,
   FALSE
}

Kinetis KV5x Ethernet MAC driver.

Definition at line 91 of file mkv5x_eth_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ENET_Error_IRQHandler()

◆ ENET_Receive_IRQHandler()

◆ ENET_Transmit_IRQHandler()

◆ mkv5xEthCalcCrc()

◆ mkv5xEthDisableIrq()

◆ mkv5xEthEnableIrq()

◆ mkv5xEthEventHandler()

◆ mkv5xEthInit()

◆ mkv5xEthInitBufferDesc()

◆ mkv5xEthInitGpio()

◆ mkv5xEthReadPhyReg()

◆ mkv5xEthReceivePacket()

◆ mkv5xEthSendPacket()

◆ mkv5xEthTick()

◆ mkv5xEthUpdateMacAddrFilter()

◆ mkv5xEthUpdateMacConfig()

◆ mkv5xEthWritePhyReg()

Variable Documentation

◆ mkv5xEthDriver