esp32_eth_driver.c File Reference

ESP32 Ethernet MAC driver. More...

#include "esp_intr_alloc.h"
#include "soc/dport_reg.h"
#include "soc/dport_access.h"
#include "soc/io_mux_reg.h"
#include "soc/gpio_sig_map.h"
#include "driver/gpio.h"
#include "rom/gpio.h"
#include "esp_private/periph_ctrl.h"
#include "core/net.h"
#include "drivers/mac/esp32_eth_driver.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t esp32EthInit (NetInterface *interface)
 ESP32 Ethernet MAC initialization. More...
 
__weak_func void esp32EthInitGpio (NetInterface *interface)
 GPIO configuration. More...
 
void esp32EthInitDmaDesc (NetInterface *interface)
 Initialize DMA descriptor lists. More...
 
void esp32EthTick (NetInterface *interface)
 ESP32 Ethernet MAC timer handler. More...
 
void esp32EthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void esp32EthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void IRAM_ATTR esp32EthIrqHandler (void *arg)
 ESP32 Ethernet MAC interrupt service routine. More...
 
void esp32EthEventHandler (NetInterface *interface)
 ESP32 Ethernet MAC event handler. More...
 
error_t esp32EthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
 
error_t esp32EthReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t esp32EthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t esp32EthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void esp32EthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t esp32EthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 

Variables

const NicDriver esp32EthDriver
 ESP32 Ethernet MAC driver. More...
 

Detailed Description

ESP32 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 esp32_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file esp32_eth_driver.c.

Function Documentation

◆ esp32EthDisableIrq()

void esp32EthDisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 452 of file esp32_eth_driver.c.

◆ esp32EthEnableIrq()

void esp32EthEnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 424 of file esp32_eth_driver.c.

◆ esp32EthEventHandler()

void esp32EthEventHandler ( NetInterface interface)

ESP32 Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 537 of file esp32_eth_driver.c.

◆ esp32EthInit()

error_t esp32EthInit ( NetInterface interface)

ESP32 Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 97 of file esp32_eth_driver.c.

◆ esp32EthInitDmaDesc()

void esp32EthInitDmaDesc ( NetInterface interface)

Initialize DMA descriptor lists.

Parameters
[in]interfaceUnderlying network interface

Definition at line 330 of file esp32_eth_driver.c.

◆ esp32EthInitGpio()

__weak_func void esp32EthInitGpio ( NetInterface interface)

GPIO configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 208 of file esp32_eth_driver.c.

◆ esp32EthIrqHandler()

void IRAM_ATTR esp32EthIrqHandler ( void *  arg)

ESP32 Ethernet MAC interrupt service routine.

Parameters
[in]argUnused parameter

Definition at line 480 of file esp32_eth_driver.c.

◆ esp32EthReadPhyReg()

uint16_t esp32EthReadPhyReg ( 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 884 of file esp32_eth_driver.c.

◆ esp32EthReceivePacket()

error_t esp32EthReceivePacket ( NetInterface interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 621 of file esp32_eth_driver.c.

◆ esp32EthSendPacket()

error_t esp32EthSendPacket ( 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 562 of file esp32_eth_driver.c.

◆ esp32EthTick()

void esp32EthTick ( NetInterface interface)

ESP32 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 399 of file esp32_eth_driver.c.

◆ esp32EthUpdateMacAddrFilter()

error_t esp32EthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 691 of file esp32_eth_driver.c.

◆ esp32EthUpdateMacConfig()

error_t esp32EthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 799 of file esp32_eth_driver.c.

◆ esp32EthWritePhyReg()

void esp32EthWritePhyReg ( 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 842 of file esp32_eth_driver.c.

Variable Documentation

◆ esp32EthDriver

#define TRUE
Definition: os_port.h:50
error_t esp32EthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
void esp32EthEventHandler(NetInterface *interface)
ESP32 Ethernet MAC event handler.
#define FALSE
Definition: os_port.h:46
error_t esp32EthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
error_t esp32EthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
uint16_t esp32EthReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
void esp32EthTick(NetInterface *interface)
ESP32 Ethernet MAC timer handler.
#define ETH_MTU
Definition: ethernet.h:116
void esp32EthWritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
void esp32EthDisableIrq(NetInterface *interface)
Disable interrupts.
error_t esp32EthInit(NetInterface *interface)
ESP32 Ethernet MAC initialization.
@ NIC_TYPE_ETHERNET
Ethernet interface.
Definition: nic.h:83
void esp32EthEnableIrq(NetInterface *interface)
Enable interrupts.