Macros | Functions | Variables
mimxrt1020_eth_driver.c File Reference

NXP i.MX RT1020 Ethernet MAC driver. More...

#include "fsl_device_registers.h"
#include "fsl_gpio.h"
#include "fsl_iomuxc.h"
#include "core/net.h"
#include "drivers/mac/mimxrt1020_eth_driver.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t mimxrt1020EthInit (NetInterface *interface)
 i.MX RT1020 Ethernet MAC initialization More...
 
__weak_func void mimxrt1020EthInitGpio (NetInterface *interface)
 GPIO configuration. More...
 
void mimxrt1020EthInitBufferDesc (NetInterface *interface)
 Initialize buffer descriptors. More...
 
void mimxrt1020EthTick (NetInterface *interface)
 i.MX RT1020 Ethernet MAC timer handler More...
 
void mimxrt1020EthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void mimxrt1020EthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void ENET_IRQHandler (void)
 Ethernet MAC interrupt. More...
 
void mimxrt1020EthEventHandler (NetInterface *interface)
 i.MX RT1020 Ethernet MAC event handler More...
 
error_t mimxrt1020EthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
 
error_t mimxrt1020EthReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t mimxrt1020EthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t mimxrt1020EthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void mimxrt1020EthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t mimxrt1020EthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 
uint32_t mimxrt1020EthCalcCrc (const void *data, size_t length)
 CRC calculation. More...
 

Variables

const NicDriver mimxrt1020EthDriver
 i.MX RT1020 Ethernet MAC driver More...
 

Detailed Description

NXP i.MX RT1020 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 mimxrt1020_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file mimxrt1020_eth_driver.c.

Function Documentation

◆ ENET_IRQHandler()

void ENET_IRQHandler ( void  )

Ethernet MAC interrupt.

Definition at line 596 of file mimxrt1020_eth_driver.c.

◆ mimxrt1020EthCalcCrc()

uint32_t mimxrt1020EthCalcCrc ( 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 1101 of file mimxrt1020_eth_driver.c.

◆ mimxrt1020EthDisableIrq()

void mimxrt1020EthDisableIrq ( NetInterface *  interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 569 of file mimxrt1020_eth_driver.c.

◆ mimxrt1020EthEnableIrq()

void mimxrt1020EthEnableIrq ( NetInterface *  interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 541 of file mimxrt1020_eth_driver.c.

◆ mimxrt1020EthEventHandler()

void mimxrt1020EthEventHandler ( NetInterface *  interface)

i.MX RT1020 Ethernet MAC event handler

Parameters
[in]interfaceUnderlying network interface

Definition at line 660 of file mimxrt1020_eth_driver.c.

◆ mimxrt1020EthInit()

error_t mimxrt1020EthInit ( NetInterface *  interface)

i.MX RT1020 Ethernet MAC initialization

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 120 of file mimxrt1020_eth_driver.c.

◆ mimxrt1020EthInitBufferDesc()

void mimxrt1020EthInitBufferDesc ( NetInterface *  interface)

Initialize buffer descriptors.

Parameters
[in]interfaceUnderlying network interface

Definition at line 455 of file mimxrt1020_eth_driver.c.

◆ mimxrt1020EthInitGpio()

__weak_func void mimxrt1020EthInitGpio ( NetInterface *  interface)

GPIO configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 240 of file mimxrt1020_eth_driver.c.

◆ mimxrt1020EthReadPhyReg()

uint16_t mimxrt1020EthReadPhyReg ( 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 1054 of file mimxrt1020_eth_driver.c.

◆ mimxrt1020EthReceivePacket()

error_t mimxrt1020EthReceivePacket ( NetInterface *  interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 788 of file mimxrt1020_eth_driver.c.

◆ mimxrt1020EthSendPacket()

error_t mimxrt1020EthSendPacket ( 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 715 of file mimxrt1020_eth_driver.c.

◆ mimxrt1020EthTick()

void mimxrt1020EthTick ( NetInterface *  interface)

i.MX RT1020 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 516 of file mimxrt1020_eth_driver.c.

◆ mimxrt1020EthUpdateMacAddrFilter()

error_t mimxrt1020EthUpdateMacAddrFilter ( NetInterface *  interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 869 of file mimxrt1020_eth_driver.c.

◆ mimxrt1020EthUpdateMacConfig()

error_t mimxrt1020EthUpdateMacConfig ( NetInterface *  interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 958 of file mimxrt1020_eth_driver.c.

◆ mimxrt1020EthWritePhyReg()

void mimxrt1020EthWritePhyReg ( 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 1012 of file mimxrt1020_eth_driver.c.

Variable Documentation

◆ mimxrt1020EthDriver

const NicDriver mimxrt1020EthDriver
Initial value:
=
{
NIC_TYPE_ETHERNET,
ETH_MTU,
mimxrt1020EthInit,
mimxrt1020EthTick,
mimxrt1020EthEnableIrq,
mimxrt1020EthDisableIrq,
mimxrt1020EthEventHandler,
mimxrt1020EthSendPacket,
mimxrt1020EthUpdateMacAddrFilter,
mimxrt1020EthUpdateMacConfig,
mimxrt1020EthWritePhyReg,
mimxrt1020EthReadPhyReg,
TRUE,
TRUE,
TRUE,
FALSE
}

i.MX RT1020 Ethernet MAC driver

Definition at line 93 of file mimxrt1020_eth_driver.c.

TRUE
#define TRUE
Definition: os_port.h:50
mimxrt1020EthTick
void mimxrt1020EthTick(NetInterface *interface)
i.MX RT1020 Ethernet MAC timer handler
Definition: mimxrt1020_eth_driver.c:516
mimxrt1020EthEnableIrq
void mimxrt1020EthEnableIrq(NetInterface *interface)
Enable interrupts.
Definition: mimxrt1020_eth_driver.c:541
mimxrt1020EthInit
error_t mimxrt1020EthInit(NetInterface *interface)
i.MX RT1020 Ethernet MAC initialization
Definition: mimxrt1020_eth_driver.c:120
FALSE
#define FALSE
Definition: os_port.h:46
mimxrt1020EthUpdateMacAddrFilter
error_t mimxrt1020EthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
Definition: mimxrt1020_eth_driver.c:869
mimxrt1020EthSendPacket
error_t mimxrt1020EthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
Definition: mimxrt1020_eth_driver.c:715
mimxrt1020EthEventHandler
void mimxrt1020EthEventHandler(NetInterface *interface)
i.MX RT1020 Ethernet MAC event handler
Definition: mimxrt1020_eth_driver.c:660
mimxrt1020EthDisableIrq
void mimxrt1020EthDisableIrq(NetInterface *interface)
Disable interrupts.
Definition: mimxrt1020_eth_driver.c:569
mimxrt1020EthReadPhyReg
uint16_t mimxrt1020EthReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
Definition: mimxrt1020_eth_driver.c:1054
ETH_MTU
#define ETH_MTU
Definition: ethernet.h:116
mimxrt1020EthWritePhyReg
void mimxrt1020EthWritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
Definition: mimxrt1020_eth_driver.c:1012
mimxrt1020EthUpdateMacConfig
error_t mimxrt1020EthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
Definition: mimxrt1020_eth_driver.c:958
NIC_TYPE_ETHERNET
@ NIC_TYPE_ETHERNET
Ethernet interface.
Definition: nic.h:83