Macros | Functions | Variables
mkv5x_eth_driver.h File Reference

NXP Kinetis KV5x Ethernet MAC driver. More...

Go to the source code of this file.

Macros

#define MKV5X_ETH_TX_BUFFER_COUNT   2
 
#define MKV5X_ETH_TX_BUFFER_SIZE   1536
 
#define MKV5X_ETH_RX_BUFFER_COUNT   4
 
#define MKV5X_ETH_RX_BUFFER_SIZE   1536
 
#define MKV5X_ETH_IRQ_PRIORITY_GROUPING   3
 
#define MKV5X_ETH_IRQ_GROUP_PRIORITY   12
 
#define MKV5X_ETH_IRQ_SUB_PRIORITY   0
 
#define MKV5X_ETH_RAM_SECTION   ".ram_no_cache"
 
#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 mkv5xEthInit (NetInterface *interface)
 Kinetis KV5x Ethernet MAC initialization. More...
 
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 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

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

Macro Definition Documentation

◆ ENET_RBD0_BC

#define ENET_RBD0_BC   0x00800000

Definition at line 118 of file mkv5x_eth_driver.h.

◆ ENET_RBD0_CR

#define ENET_RBD0_CR   0x00040000

Definition at line 122 of file mkv5x_eth_driver.h.

◆ ENET_RBD0_DATA_LENGTH

#define ENET_RBD0_DATA_LENGTH   0x0000FFFF

Definition at line 125 of file mkv5x_eth_driver.h.

◆ ENET_RBD0_E

#define ENET_RBD0_E   0x80000000

Definition at line 112 of file mkv5x_eth_driver.h.

◆ ENET_RBD0_L

#define ENET_RBD0_L   0x08000000

Definition at line 116 of file mkv5x_eth_driver.h.

◆ ENET_RBD0_LG

#define ENET_RBD0_LG   0x00200000

Definition at line 120 of file mkv5x_eth_driver.h.

◆ ENET_RBD0_M

#define ENET_RBD0_M   0x01000000

Definition at line 117 of file mkv5x_eth_driver.h.

◆ ENET_RBD0_MC

#define ENET_RBD0_MC   0x00400000

Definition at line 119 of file mkv5x_eth_driver.h.

◆ ENET_RBD0_NO

#define ENET_RBD0_NO   0x00100000

Definition at line 121 of file mkv5x_eth_driver.h.

◆ ENET_RBD0_OV

#define ENET_RBD0_OV   0x00020000

Definition at line 123 of file mkv5x_eth_driver.h.

◆ ENET_RBD0_RO1

#define ENET_RBD0_RO1   0x40000000

Definition at line 113 of file mkv5x_eth_driver.h.

◆ ENET_RBD0_RO2

#define ENET_RBD0_RO2   0x10000000

Definition at line 115 of file mkv5x_eth_driver.h.

◆ ENET_RBD0_TR

#define ENET_RBD0_TR   0x00010000

Definition at line 124 of file mkv5x_eth_driver.h.

◆ ENET_RBD0_W

#define ENET_RBD0_W   0x20000000

Definition at line 114 of file mkv5x_eth_driver.h.

◆ ENET_RBD1_DATA_POINTER

#define ENET_RBD1_DATA_POINTER   0xFFFFFFFF

Definition at line 126 of file mkv5x_eth_driver.h.

◆ ENET_RBD2_CE

#define ENET_RBD2_CE   0x02000000

Definition at line 129 of file mkv5x_eth_driver.h.

◆ ENET_RBD2_FRAG

#define ENET_RBD2_FRAG   0x00000001

Definition at line 137 of file mkv5x_eth_driver.h.

◆ ENET_RBD2_ICE

#define ENET_RBD2_ICE   0x00000020

Definition at line 133 of file mkv5x_eth_driver.h.

◆ ENET_RBD2_INT

#define ENET_RBD2_INT   0x00800000

Definition at line 131 of file mkv5x_eth_driver.h.

◆ ENET_RBD2_IPV6

#define ENET_RBD2_IPV6   0x00000002

Definition at line 136 of file mkv5x_eth_driver.h.

◆ ENET_RBD2_ME

#define ENET_RBD2_ME   0x80000000

Definition at line 127 of file mkv5x_eth_driver.h.

◆ ENET_RBD2_PCR

#define ENET_RBD2_PCR   0x00000010

Definition at line 134 of file mkv5x_eth_driver.h.

◆ ENET_RBD2_PE

#define ENET_RBD2_PE   0x04000000

Definition at line 128 of file mkv5x_eth_driver.h.

◆ ENET_RBD2_UC

#define ENET_RBD2_UC   0x01000000

Definition at line 130 of file mkv5x_eth_driver.h.

◆ ENET_RBD2_VLAN

#define ENET_RBD2_VLAN   0x00000004

Definition at line 135 of file mkv5x_eth_driver.h.

◆ ENET_RBD2_VPCP

#define ENET_RBD2_VPCP   0x0000E000

Definition at line 132 of file mkv5x_eth_driver.h.

◆ ENET_RBD3_HEADER_LENGTH

#define ENET_RBD3_HEADER_LENGTH   0xF8000000

Definition at line 138 of file mkv5x_eth_driver.h.

◆ ENET_RBD3_PAYLOAD_CHECKSUM

#define ENET_RBD3_PAYLOAD_CHECKSUM   0x0000FFFF

Definition at line 140 of file mkv5x_eth_driver.h.

◆ ENET_RBD3_PROTOCOL_TYPE

#define ENET_RBD3_PROTOCOL_TYPE   0x00FF0000

Definition at line 139 of file mkv5x_eth_driver.h.

◆ ENET_RBD4_BDU

#define ENET_RBD4_BDU   0x80000000

Definition at line 141 of file mkv5x_eth_driver.h.

◆ ENET_RBD5_TIMESTAMP

#define ENET_RBD5_TIMESTAMP   0xFFFFFFFF

Definition at line 142 of file mkv5x_eth_driver.h.

◆ ENET_TBD0_DATA_LENGTH

#define ENET_TBD0_DATA_LENGTH   0x0000FFFF

Definition at line 95 of file mkv5x_eth_driver.h.

◆ ENET_TBD0_L

#define ENET_TBD0_L   0x08000000

Definition at line 93 of file mkv5x_eth_driver.h.

◆ ENET_TBD0_R

#define ENET_TBD0_R   0x80000000

Definition at line 89 of file mkv5x_eth_driver.h.

◆ ENET_TBD0_TC

#define ENET_TBD0_TC   0x04000000

Definition at line 94 of file mkv5x_eth_driver.h.

◆ ENET_TBD0_TO1

#define ENET_TBD0_TO1   0x40000000

Definition at line 90 of file mkv5x_eth_driver.h.

◆ ENET_TBD0_TO2

#define ENET_TBD0_TO2   0x10000000

Definition at line 92 of file mkv5x_eth_driver.h.

◆ ENET_TBD0_W

#define ENET_TBD0_W   0x20000000

Definition at line 91 of file mkv5x_eth_driver.h.

◆ ENET_TBD1_DATA_POINTER

#define ENET_TBD1_DATA_POINTER   0xFFFFFFFF

Definition at line 96 of file mkv5x_eth_driver.h.

◆ ENET_TBD2_EE

#define ENET_TBD2_EE   0x00001000

Definition at line 103 of file mkv5x_eth_driver.h.

◆ ENET_TBD2_FE

#define ENET_TBD2_FE   0x00000800

Definition at line 104 of file mkv5x_eth_driver.h.

◆ ENET_TBD2_IINS

#define ENET_TBD2_IINS   0x08000000

Definition at line 100 of file mkv5x_eth_driver.h.

◆ ENET_TBD2_INT

#define ENET_TBD2_INT   0x40000000

Definition at line 97 of file mkv5x_eth_driver.h.

◆ ENET_TBD2_LCE

#define ENET_TBD2_LCE   0x00000400

Definition at line 105 of file mkv5x_eth_driver.h.

◆ ENET_TBD2_OE

#define ENET_TBD2_OE   0x00000200

Definition at line 106 of file mkv5x_eth_driver.h.

◆ ENET_TBD2_PINS

#define ENET_TBD2_PINS   0x10000000

Definition at line 99 of file mkv5x_eth_driver.h.

◆ ENET_TBD2_TS

#define ENET_TBD2_TS   0x20000000

Definition at line 98 of file mkv5x_eth_driver.h.

◆ ENET_TBD2_TSE

#define ENET_TBD2_TSE   0x00000100

Definition at line 107 of file mkv5x_eth_driver.h.

◆ ENET_TBD2_TXE

#define ENET_TBD2_TXE   0x00008000

Definition at line 101 of file mkv5x_eth_driver.h.

◆ ENET_TBD2_UE

#define ENET_TBD2_UE   0x00002000

Definition at line 102 of file mkv5x_eth_driver.h.

◆ ENET_TBD4_BDU

#define ENET_TBD4_BDU   0x80000000

Definition at line 108 of file mkv5x_eth_driver.h.

◆ ENET_TBD5_TIMESTAMP

#define ENET_TBD5_TIMESTAMP   0xFFFFFFFF

Definition at line 109 of file mkv5x_eth_driver.h.

◆ MKV5X_ETH_IRQ_GROUP_PRIORITY

#define MKV5X_ETH_IRQ_GROUP_PRIORITY   12

Definition at line 71 of file mkv5x_eth_driver.h.

◆ MKV5X_ETH_IRQ_PRIORITY_GROUPING

#define MKV5X_ETH_IRQ_PRIORITY_GROUPING   3

Definition at line 64 of file mkv5x_eth_driver.h.

◆ MKV5X_ETH_IRQ_SUB_PRIORITY

#define MKV5X_ETH_IRQ_SUB_PRIORITY   0

Definition at line 78 of file mkv5x_eth_driver.h.

◆ MKV5X_ETH_RAM_SECTION

#define MKV5X_ETH_RAM_SECTION   ".ram_no_cache"

Definition at line 85 of file mkv5x_eth_driver.h.

◆ MKV5X_ETH_RX_BUFFER_COUNT

#define MKV5X_ETH_RX_BUFFER_COUNT   4

Definition at line 50 of file mkv5x_eth_driver.h.

◆ MKV5X_ETH_RX_BUFFER_SIZE

#define MKV5X_ETH_RX_BUFFER_SIZE   1536

Definition at line 57 of file mkv5x_eth_driver.h.

◆ MKV5X_ETH_TX_BUFFER_COUNT

#define MKV5X_ETH_TX_BUFFER_COUNT   2

Definition at line 36 of file mkv5x_eth_driver.h.

◆ MKV5X_ETH_TX_BUFFER_SIZE

#define MKV5X_ETH_TX_BUFFER_SIZE   1536

Definition at line 43 of file mkv5x_eth_driver.h.

Function Documentation

◆ mkv5xEthCalcCrc()

uint32_t mkv5xEthCalcCrc ( const void *  data,
size_t  length 
)

CRC calculation.

Parameters
[in]dataPointer to the data over which to calculate the CRC
[in]lengthNumber 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]interfaceUnderlying network interface

Definition at line 415 of file mkv5x_eth_driver.c.

◆ mkv5xEthEnableIrq()

void mkv5xEthEnableIrq ( NetInterface *  interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying 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]interfaceUnderlying 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]interfaceUnderlying 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]interfaceUnderlying network interface

Definition at line 299 of file mkv5x_eth_driver.c.

◆ mkv5xEthInitGpio()

void mkv5xEthInitGpio ( NetInterface *  interface)

GPIO configuration.

Parameters
[in]interfaceUnderlying 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]opcodeAccess type (2 bits)
[in]phyAddrPHY address (5 bits)
[in]regAddrRegister 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]interfaceUnderlying 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]interfaceUnderlying network interface
[in]bufferMulti-part buffer containing the data to send
[in]offsetOffset to the first data byte
[in]ancillaryAdditional 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]interfaceUnderlying network interface

Definition at line 360 of file mkv5x_eth_driver.c.

◆ mkv5xEthUpdateMacAddrFilter()

error_t mkv5xEthUpdateMacAddrFilter ( NetInterface *  interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying 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]interfaceUnderlying 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]opcodeAccess type (2 bits)
[in]phyAddrPHY address (5 bits)
[in]regAddrRegister address (5 bits)
[in]dataRegister value

Definition at line 895 of file mkv5x_eth_driver.c.

Variable Documentation

◆ mkv5xEthDriver

const NicDriver mkv5xEthDriver
extern

Kinetis KV5x Ethernet MAC driver.

Definition at line 91 of file mkv5x_eth_driver.c.