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"

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

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.0

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] interface Underlying network interface

Definition at line 452 of file esp32_eth_driver.c.

◆ esp32EthEnableIrq()

void esp32EthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 424 of file esp32_eth_driver.c.

◆ esp32EthEventHandler()

void esp32EthEventHandler ( NetInterface * interface )

ESP32 Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 537 of file esp32_eth_driver.c.

◆ esp32EthInit()

error_t esp32EthInit ( NetInterface * interface )

ESP32 Ethernet MAC initialization.

Parameters

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

Definition at line 330 of file esp32_eth_driver.c.

◆ esp32EthInitGpio()

__weak_func void esp32EthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying 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] arg Unused 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]	opcode	Access type (2 bits)
[in]	phyAddr	PHY address (5 bits)
[in]	regAddr	Register 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] interface Underlying 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]	interface	Underlying network interface
[in]	buffer	Multi-part buffer containing the data to send
[in]	offset	Offset to the first data byte
[in]	ancillary	Additional 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] interface Underlying network interface

Definition at line 399 of file esp32_eth_driver.c.

◆ esp32EthUpdateMacAddrFilter()

error_t esp32EthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying 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] interface Underlying 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]	opcode	Access type (2 bits)
[in]	phyAddr	PHY address (5 bits)
[in]	regAddr	Register address (5 bits)
[in]	data	Register value

Definition at line 842 of file esp32_eth_driver.c.

Variable Documentation

◆ esp32EthDriver

const NicDriver esp32EthDriver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   esp32EthInit,
   esp32EthTick,
   esp32EthEnableIrq,
   esp32EthDisableIrq,
   esp32EthEventHandler,
   esp32EthSendPacket,
   esp32EthUpdateMacAddrFilter,
   esp32EthUpdateMacConfig,
   esp32EthWritePhyReg,
   esp32EthReadPhyReg,
   TRUE,
   TRUE,
   TRUE,
   FALSE
}

ESP32 Ethernet MAC driver.

Definition at line 70 of file esp32_eth_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ esp32EthDisableIrq()

◆ esp32EthEnableIrq()

◆ esp32EthEventHandler()

◆ esp32EthInit()

◆ esp32EthInitDmaDesc()

◆ esp32EthInitGpio()

◆ esp32EthIrqHandler()

◆ esp32EthReadPhyReg()

◆ esp32EthReceivePacket()

◆ esp32EthSendPacket()

◆ esp32EthTick()

◆ esp32EthUpdateMacAddrFilter()

◆ esp32EthUpdateMacConfig()

◆ esp32EthWritePhyReg()

Variable Documentation

◆ esp32EthDriver