Macros | Functions | Variables
mimxrt1170_eth3_driver.c File Reference

NXP i.MX RT1170 Gigabit Ethernet MAC driver (ENET_QOS instance) More...

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

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t mimxrt1170Eth3Init (NetInterface *interface)
 i.MX RT1170 Ethernet MAC initialization More...
 
__weak_func void mimxrt1170Eth3InitGpio (NetInterface *interface)
 GPIO configuration. More...
 
void mimxrt1170Eth3InitDmaDesc (NetInterface *interface)
 Initialize buffer descriptors. More...
 
void mimxrt1170Eth3Tick (NetInterface *interface)
 i.MX RT1170 Ethernet MAC timer handler More...
 
void mimxrt1170Eth3EnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void mimxrt1170Eth3DisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void ENET_QOS_IRQHandler (void)
 Ethernet MAC interrupt. More...
 
void mimxrt1170Eth3EventHandler (NetInterface *interface)
 i.MX RT1170 Ethernet MAC event handler More...
 
error_t mimxrt1170Eth3SendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
 
error_t mimxrt1170Eth3ReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t mimxrt1170Eth3UpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t mimxrt1170Eth3UpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void mimxrt1170Eth3WritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t mimxrt1170Eth3ReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 

Variables

const NicDriver mimxrt1170Eth3Driver
 i.MX RT1170 Ethernet MAC driver (ENET_QOS instance) More...
 

Detailed Description

NXP i.MX RT1170 Gigabit Ethernet MAC driver (ENET_QOS instance)

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 mimxrt1170_eth3_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file mimxrt1170_eth3_driver.c.

Function Documentation

◆ ENET_QOS_IRQHandler()

void ENET_QOS_IRQHandler ( void  )

Ethernet MAC interrupt.

Definition at line 635 of file mimxrt1170_eth3_driver.c.

◆ mimxrt1170Eth3DisableIrq()

void mimxrt1170Eth3DisableIrq ( NetInterface *  interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 608 of file mimxrt1170_eth3_driver.c.

◆ mimxrt1170Eth3EnableIrq()

void mimxrt1170Eth3EnableIrq ( NetInterface *  interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 580 of file mimxrt1170_eth3_driver.c.

◆ mimxrt1170Eth3EventHandler()

void mimxrt1170Eth3EventHandler ( NetInterface *  interface)

i.MX RT1170 Ethernet MAC event handler

Parameters
[in]interfaceUnderlying network interface

Definition at line 688 of file mimxrt1170_eth3_driver.c.

◆ mimxrt1170Eth3Init()

error_t mimxrt1170Eth3Init ( NetInterface *  interface)

i.MX RT1170 Ethernet MAC initialization

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 120 of file mimxrt1170_eth3_driver.c.

◆ mimxrt1170Eth3InitDmaDesc()

void mimxrt1170Eth3InitDmaDesc ( NetInterface *  interface)

Initialize buffer descriptors.

Parameters
[in]interfaceUnderlying network interface

Definition at line 504 of file mimxrt1170_eth3_driver.c.

◆ mimxrt1170Eth3InitGpio()

__weak_func void mimxrt1170Eth3InitGpio ( NetInterface *  interface)

GPIO configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 254 of file mimxrt1170_eth3_driver.c.

◆ mimxrt1170Eth3ReadPhyReg()

uint16_t mimxrt1170Eth3ReadPhyReg ( 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 1007 of file mimxrt1170_eth3_driver.c.

◆ mimxrt1170Eth3ReceivePacket()

error_t mimxrt1170Eth3ReceivePacket ( NetInterface *  interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 778 of file mimxrt1170_eth3_driver.c.

◆ mimxrt1170Eth3SendPacket()

error_t mimxrt1170Eth3SendPacket ( 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 713 of file mimxrt1170_eth3_driver.c.

◆ mimxrt1170Eth3Tick()

void mimxrt1170Eth3Tick ( NetInterface *  interface)

i.MX RT1170 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 555 of file mimxrt1170_eth3_driver.c.

◆ mimxrt1170Eth3UpdateMacAddrFilter()

error_t mimxrt1170Eth3UpdateMacAddrFilter ( NetInterface *  interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 853 of file mimxrt1170_eth3_driver.c.

◆ mimxrt1170Eth3UpdateMacConfig()

error_t mimxrt1170Eth3UpdateMacConfig ( NetInterface *  interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 910 of file mimxrt1170_eth3_driver.c.

◆ mimxrt1170Eth3WritePhyReg()

void mimxrt1170Eth3WritePhyReg ( 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 962 of file mimxrt1170_eth3_driver.c.

Variable Documentation

◆ mimxrt1170Eth3Driver

const NicDriver mimxrt1170Eth3Driver
Initial value:
=
{
NIC_TYPE_ETHERNET,
ETH_MTU,
mimxrt1170Eth3Init,
mimxrt1170Eth3Tick,
mimxrt1170Eth3EnableIrq,
mimxrt1170Eth3DisableIrq,
mimxrt1170Eth3EventHandler,
mimxrt1170Eth3SendPacket,
mimxrt1170Eth3UpdateMacAddrFilter,
mimxrt1170Eth3UpdateMacConfig,
mimxrt1170Eth3WritePhyReg,
mimxrt1170Eth3ReadPhyReg,
TRUE,
TRUE,
TRUE,
FALSE
}

i.MX RT1170 Ethernet MAC driver (ENET_QOS instance)

Definition at line 93 of file mimxrt1170_eth3_driver.c.

mimxrt1170Eth3DisableIrq
void mimxrt1170Eth3DisableIrq(NetInterface *interface)
Disable interrupts.
Definition: mimxrt1170_eth3_driver.c:608
TRUE
#define TRUE
Definition: os_port.h:50
mimxrt1170Eth3Tick
void mimxrt1170Eth3Tick(NetInterface *interface)
i.MX RT1170 Ethernet MAC timer handler
Definition: mimxrt1170_eth3_driver.c:555
FALSE
#define FALSE
Definition: os_port.h:46
mimxrt1170Eth3SendPacket
error_t mimxrt1170Eth3SendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
Definition: mimxrt1170_eth3_driver.c:713
mimxrt1170Eth3WritePhyReg
void mimxrt1170Eth3WritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
Definition: mimxrt1170_eth3_driver.c:962
mimxrt1170Eth3ReadPhyReg
uint16_t mimxrt1170Eth3ReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
Definition: mimxrt1170_eth3_driver.c:1007
mimxrt1170Eth3UpdateMacConfig
error_t mimxrt1170Eth3UpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
Definition: mimxrt1170_eth3_driver.c:910
ETH_MTU
#define ETH_MTU
Definition: ethernet.h:116
mimxrt1170Eth3UpdateMacAddrFilter
error_t mimxrt1170Eth3UpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
Definition: mimxrt1170_eth3_driver.c:853
mimxrt1170Eth3Init
error_t mimxrt1170Eth3Init(NetInterface *interface)
i.MX RT1170 Ethernet MAC initialization
Definition: mimxrt1170_eth3_driver.c:120
mimxrt1170Eth3EnableIrq
void mimxrt1170Eth3EnableIrq(NetInterface *interface)
Enable interrupts.
Definition: mimxrt1170_eth3_driver.c:580
mimxrt1170Eth3EventHandler
void mimxrt1170Eth3EventHandler(NetInterface *interface)
i.MX RT1170 Ethernet MAC event handler
Definition: mimxrt1170_eth3_driver.c:688
NIC_TYPE_ETHERNET
@ NIC_TYPE_ETHERNET
Ethernet interface.
Definition: nic.h:83