Renesas Synergy S5D9 Ethernet MAC driver. More...

#include "bsp_irq_cfg.h"
#include "s5d9.h"
#include "core/net.h"
#include "drivers/mac/s5d9_eth_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	s5d9EthInit (NetInterface *interface)
	S5D9 Ethernet MAC initialization. More...

__weak_func void	s5d9EthInitGpio (NetInterface *interface)
	GPIO configuration. More...

void	s5d9EthInitDmaDesc (NetInterface *interface)
	Initialize DMA descriptor lists. More...

void	s5d9EthTick (NetInterface *interface)
	S5D9 Ethernet MAC timer handler. More...

void	s5d9EthEnableIrq (NetInterface *interface)
	Enable interrupts. More...

void	s5d9EthDisableIrq (NetInterface *interface)
	Disable interrupts. More...

void	EDMAC0_EINT_IRQHandler (void)
	S5D9 Ethernet MAC interrupt service routine. More...

void	s5d9EthEventHandler (NetInterface *interface)
	S5D9 Ethernet MAC event handler. More...

error_t	s5d9EthSendPacket (NetInterface interface, const NetBuffer buffer, size_t offset, NetTxAncillary *ancillary)
	Send a packet. More...

error_t	s5d9EthReceivePacket (NetInterface *interface)
	Receive a packet. More...

error_t	s5d9EthUpdateMacAddrFilter (NetInterface *interface)
	Configure MAC address filtering. More...

error_t	s5d9EthUpdateMacConfig (NetInterface *interface)
	Adjust MAC configuration parameters for proper operation. More...

void	s5d9EthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
	Write PHY register. More...

uint16_t	s5d9EthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
	Read PHY register. More...

void	s5d9EthWriteSmi (uint32_t data, uint_t length)
	SMI write operation. More...

uint32_t	s5d9EthReadSmi (uint_t length)
	SMI read operation. More...

Variables
const NicDriver	s5d9EthDriver
	S5D9 Ethernet MAC driver. More...

Detailed Description

Renesas Synergy S5D9 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.5.4

Definition in file s5d9_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file s5d9_eth_driver.c.

Function Documentation

◆ EDMAC0_EINT_IRQHandler()

void EDMAC0_EINT_IRQHandler ( void )

S5D9 Ethernet MAC interrupt service routine.

Definition at line 436 of file s5d9_eth_driver.c.

◆ s5d9EthDisableIrq()

void s5d9EthDisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 409 of file s5d9_eth_driver.c.

◆ s5d9EthEnableIrq()

void s5d9EthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 381 of file s5d9_eth_driver.c.

◆ s5d9EthEventHandler()

void s5d9EthEventHandler ( NetInterface * interface )

S5D9 Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 489 of file s5d9_eth_driver.c.

◆ s5d9EthInit()

error_t s5d9EthInit ( NetInterface * interface )

S5D9 Ethernet MAC initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 115 of file s5d9_eth_driver.c.

◆ s5d9EthInitDmaDesc()

void s5d9EthInitDmaDesc ( NetInterface * interface )

Initialize DMA descriptor lists.

Parameters

[in] interface Underlying network interface

Definition at line 300 of file s5d9_eth_driver.c.

◆ s5d9EthInitGpio()

__weak_func void s5d9EthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 220 of file s5d9_eth_driver.c.

◆ s5d9EthReadPhyReg()

uint16_t s5d9EthReadPhyReg	(	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 798 of file s5d9_eth_driver.c.

◆ s5d9EthReadSmi()

uint32_t s5d9EthReadSmi ( uint_t length )

SMI read operation.

Parameters

[in] length Number of bits to be read

Returns: Data resulting from the MDIO read operation

Definition at line 871 of file s5d9_eth_driver.c.

◆ s5d9EthReceivePacket()

error_t s5d9EthReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 582 of file s5d9_eth_driver.c.

◆ s5d9EthSendPacket()

error_t s5d9EthSendPacket	(	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 514 of file s5d9_eth_driver.c.

◆ s5d9EthTick()

void s5d9EthTick ( NetInterface * interface )

S5D9 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 356 of file s5d9_eth_driver.c.

◆ s5d9EthUpdateMacAddrFilter()

error_t s5d9EthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 660 of file s5d9_eth_driver.c.

◆ s5d9EthUpdateMacConfig()

error_t s5d9EthUpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 725 of file s5d9_eth_driver.c.

◆ s5d9EthWritePhyReg()

void s5d9EthWritePhyReg	(	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 768 of file s5d9_eth_driver.c.

◆ s5d9EthWriteSmi()

void s5d9EthWriteSmi	(	uint32_t	data,
		uint_t	length
	)

SMI write operation.

Parameters

[in]	data	Raw data to be written
[in]	length	Number of bits to be written

Definition at line 831 of file s5d9_eth_driver.c.

Variable Documentation

◆ s5d9EthDriver

const NicDriver s5d9EthDriver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   s5d9EthInit,
   s5d9EthTick,
   s5d9EthEnableIrq,
   s5d9EthDisableIrq,
   s5d9EthEventHandler,
   s5d9EthSendPacket,
   s5d9EthUpdateMacAddrFilter,
   s5d9EthUpdateMacConfig,
   s5d9EthWritePhyReg,
   s5d9EthReadPhyReg,
   TRUE,
   TRUE,
   TRUE,
   TRUE
}

S5D9 Ethernet MAC driver.

Definition at line 88 of file s5d9_eth_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ EDMAC0_EINT_IRQHandler()

◆ s5d9EthDisableIrq()

◆ s5d9EthEnableIrq()

◆ s5d9EthEventHandler()

◆ s5d9EthInit()

◆ s5d9EthInitDmaDesc()

◆ s5d9EthInitGpio()

◆ s5d9EthReadPhyReg()

◆ s5d9EthReadSmi()

◆ s5d9EthReceivePacket()

◆ s5d9EthSendPacket()

◆ s5d9EthTick()

◆ s5d9EthUpdateMacAddrFilter()

◆ s5d9EthUpdateMacConfig()

◆ s5d9EthWritePhyReg()

◆ s5d9EthWriteSmi()

Variable Documentation

◆ s5d9EthDriver