Macros | Functions | Variables
mk6x_eth_driver.c File Reference

NXP Kinetis K60/K64/K65/K66 Ethernet MAC driver. More...

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

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t mk6xEthInit (NetInterface *interface)
 Kinetis K6x Ethernet MAC initialization. More...
 
__weak_func void mk6xEthInitGpio (NetInterface *interface)
 GPIO configuration. More...
 
void mk6xEthInitBufferDesc (NetInterface *interface)
 Initialize buffer descriptors. More...
 
void mk6xEthTick (NetInterface *interface)
 Kinetis K6x Ethernet MAC timer handler. More...
 
void mk6xEthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void mk6xEthDisableIrq (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 mk6xEthEventHandler (NetInterface *interface)
 Kinetis K6x Ethernet MAC event handler. More...
 
error_t mk6xEthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
 
error_t mk6xEthReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t mk6xEthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t mk6xEthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void mk6xEthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t mk6xEthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 
uint32_t mk6xEthCalcCrc (const void *data, size_t length)
 CRC calculation. More...
 

Variables

const NicDriver mk6xEthDriver
 Kinetis K6x Ethernet MAC driver. More...
 

Detailed Description

NXP Kinetis K60/K64/K65/K66 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 mk6x_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file mk6x_eth_driver.c.

Function Documentation

◆ ENET_Error_IRQHandler()

void ENET_Error_IRQHandler ( void  )

Ethernet MAC error interrupt.

Definition at line 611 of file mk6x_eth_driver.c.

◆ ENET_Receive_IRQHandler()

void ENET_Receive_IRQHandler ( void  )

Ethernet MAC receive interrupt.

Definition at line 580 of file mk6x_eth_driver.c.

◆ ENET_Transmit_IRQHandler()

void ENET_Transmit_IRQHandler ( void  )

Ethernet MAC transmit interrupt.

Definition at line 544 of file mk6x_eth_driver.c.

◆ mk6xEthCalcCrc()

uint32_t mk6xEthCalcCrc ( 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 1083 of file mk6x_eth_driver.c.

◆ mk6xEthDisableIrq()

void mk6xEthDisableIrq ( NetInterface *  interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 515 of file mk6x_eth_driver.c.

◆ mk6xEthEnableIrq()

void mk6xEthEnableIrq ( NetInterface *  interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 485 of file mk6x_eth_driver.c.

◆ mk6xEthEventHandler()

void mk6xEthEventHandler ( NetInterface *  interface)

Kinetis K6x Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 643 of file mk6x_eth_driver.c.

◆ mk6xEthInit()

error_t mk6xEthInit ( NetInterface *  interface)

Kinetis K6x Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 114 of file mk6x_eth_driver.c.

◆ mk6xEthInitBufferDesc()

void mk6xEthInitBufferDesc ( NetInterface *  interface)

Initialize buffer descriptors.

Parameters
[in]interfaceUnderlying network interface

Definition at line 397 of file mk6x_eth_driver.c.

◆ mk6xEthInitGpio()

__weak_func void mk6xEthInitGpio ( NetInterface *  interface)

GPIO configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 247 of file mk6x_eth_driver.c.

◆ mk6xEthReadPhyReg()

uint16_t mk6xEthReadPhyReg ( 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 1036 of file mk6x_eth_driver.c.

◆ mk6xEthReceivePacket()

error_t mk6xEthReceivePacket ( NetInterface *  interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 770 of file mk6x_eth_driver.c.

◆ mk6xEthSendPacket()

error_t mk6xEthSendPacket ( 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 698 of file mk6x_eth_driver.c.

◆ mk6xEthTick()

void mk6xEthTick ( NetInterface *  interface)

Kinetis K6x 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 460 of file mk6x_eth_driver.c.

◆ mk6xEthUpdateMacAddrFilter()

error_t mk6xEthUpdateMacAddrFilter ( NetInterface *  interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 851 of file mk6x_eth_driver.c.

◆ mk6xEthUpdateMacConfig()

error_t mk6xEthUpdateMacConfig ( NetInterface *  interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 940 of file mk6x_eth_driver.c.

◆ mk6xEthWritePhyReg()

void mk6xEthWritePhyReg ( 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 994 of file mk6x_eth_driver.c.

Variable Documentation

◆ mk6xEthDriver

const NicDriver mk6xEthDriver
Initial value:
=
{
NIC_TYPE_ETHERNET,
ETH_MTU,
mk6xEthInit,
mk6xEthTick,
mk6xEthEnableIrq,
mk6xEthDisableIrq,
mk6xEthEventHandler,
mk6xEthSendPacket,
mk6xEthUpdateMacAddrFilter,
mk6xEthUpdateMacConfig,
mk6xEthWritePhyReg,
mk6xEthReadPhyReg,
TRUE,
TRUE,
TRUE,
FALSE
}

Kinetis K6x Ethernet MAC driver.

Definition at line 87 of file mk6x_eth_driver.c.

mk6xEthReadPhyReg
uint16_t mk6xEthReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
Definition: mk6x_eth_driver.c:1036
mk6xEthWritePhyReg
void mk6xEthWritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
Definition: mk6x_eth_driver.c:994
mk6xEthEventHandler
void mk6xEthEventHandler(NetInterface *interface)
Kinetis K6x Ethernet MAC event handler.
Definition: mk6x_eth_driver.c:643
TRUE
#define TRUE
Definition: os_port.h:50
mk6xEthInit
error_t mk6xEthInit(NetInterface *interface)
Kinetis K6x Ethernet MAC initialization.
Definition: mk6x_eth_driver.c:114
mk6xEthEnableIrq
void mk6xEthEnableIrq(NetInterface *interface)
Enable interrupts.
Definition: mk6x_eth_driver.c:485
mk6xEthTick
void mk6xEthTick(NetInterface *interface)
Kinetis K6x Ethernet MAC timer handler.
Definition: mk6x_eth_driver.c:460
mk6xEthUpdateMacAddrFilter
error_t mk6xEthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
Definition: mk6x_eth_driver.c:851
FALSE
#define FALSE
Definition: os_port.h:46
mk6xEthDisableIrq
void mk6xEthDisableIrq(NetInterface *interface)
Disable interrupts.
Definition: mk6x_eth_driver.c:515
ETH_MTU
#define ETH_MTU
Definition: ethernet.h:116
mk6xEthSendPacket
error_t mk6xEthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
Definition: mk6x_eth_driver.c:698
mk6xEthUpdateMacConfig
error_t mk6xEthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
Definition: mk6x_eth_driver.c:940
NIC_TYPE_ETHERNET
@ NIC_TYPE_ETHERNET
Ethernet interface.
Definition: nic.h:83