Renesas RA6M2 / RA6M3 / RA6M4 Ethernet MAC driver. More...

#include "core/nic.h"

Data Structures
struct	Ra6EthTxDmaDesc
	Transmit DMA descriptor. More...

struct	Ra6EthRxDmaDesc
	Receive DMA descriptor. More...

Macros
#define	RA6_ETH_TX_BUFFER_COUNT 3

#define	RA6_ETH_TX_BUFFER_SIZE 1536

#define	RA6_ETH_RX_BUFFER_COUNT 6

#define	RA6_ETH_RX_BUFFER_SIZE 1536

#define	RA6_ETH_IRQ_PRIORITY_GROUPING 3

#define	RA6_ETH_IRQ_GROUP_PRIORITY 12

#define	RA6_ETH_IRQ_SUB_PRIORITY 0

#define	RA6_ETH_RAM_SECTION ".ns_buffer"

#define	R_ETHERC_EDMAC ((R_ETHERC_EDMAC_Type *) R_ETHERC_EDMAC_BASE)

#define	R_MSTP_MSTPCRB_MSTPB15_Msk (R_MSTP_MSTPCRB_MSTPB_Msk << 15)

#define	EDMAC_TD0_TACT 0x80000000

#define	EDMAC_TD0_TDLE 0x40000000

#define	EDMAC_TD0_TFP_SOF 0x20000000

#define	EDMAC_TD0_TFP_EOF 0x10000000

#define	EDMAC_TD0_TFE 0x08000000

#define	EDMAC_TD0_TWBI 0x04000000

#define	EDMAC_TD0_TFS_MASK 0x0000010F

#define	EDMAC_TD0_TFS_TABT 0x00000100

#define	EDMAC_TD0_TFS_CND 0x00000008

#define	EDMAC_TD0_TFS_DLC 0x00000004

#define	EDMAC_TD0_TFS_CD 0x00000002

#define	EDMAC_TD0_TFS_TRO 0x00000001

#define	EDMAC_TD1_TBL 0xFFFF0000

#define	EDMAC_TD2_TBA 0xFFFFFFFF

#define	EDMAC_RD0_RACT 0x80000000

#define	EDMAC_RD0_RDLE 0x40000000

#define	EDMAC_RD0_RFP_SOF 0x20000000

#define	EDMAC_RD0_RFP_EOF 0x10000000

#define	EDMAC_RD0_RFE 0x08000000

#define	EDMAC_RD0_RFS_MASK 0x0000039F

#define	EDMAC_RD0_RFS_RFOF 0x00000200

#define	EDMAC_RD0_RFS_RABT 0x00000100

#define	EDMAC_RD0_RFS_RMAF 0x00000080

#define	EDMAC_RD0_RFS_RRF 0x00000010

#define	EDMAC_RD0_RFS_RTLF 0x00000008

#define	EDMAC_RD0_RFS_RTSF 0x00000004

#define	EDMAC_RD0_RFS_PRE 0x00000002

#define	EDMAC_RD0_RFS_CERF 0x00000001

#define	EDMAC_RD1_RBL 0xFFFF0000

#define	EDMAC_RD1_RFL 0x0000FFFF

#define	EDMAC_RD2_RBA 0xFFFFFFFF

Functions
error_t	ra6EthInit (NetInterface *interface)
	RA6 Ethernet MAC initialization. More...

void	ra6EthInitGpio (NetInterface *interface)
	GPIO configuration. More...

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

void	ra6EthTick (NetInterface *interface)
	RA6 Ethernet MAC timer handler. More...

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

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

void	ra6EthEventHandler (NetInterface *interface)
	RA6 Ethernet MAC event handler. More...

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

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

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

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

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

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

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

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

Variables
const NicDriver	ra6EthDriver
	RA6 Ethernet MAC driver. More...

Detailed Description

Renesas RA6M2 / RA6M3 / RA6M4 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.4

Definition in file ra6_eth_driver.h.

Macro Definition Documentation

◆ EDMAC_RD0_RACT

#define EDMAC_RD0_RACT 0x80000000

Definition at line 118 of file ra6_eth_driver.h.

◆ EDMAC_RD0_RDLE

#define EDMAC_RD0_RDLE 0x40000000

Definition at line 119 of file ra6_eth_driver.h.

◆ EDMAC_RD0_RFE

#define EDMAC_RD0_RFE 0x08000000

Definition at line 122 of file ra6_eth_driver.h.

◆ EDMAC_RD0_RFP_EOF

#define EDMAC_RD0_RFP_EOF 0x10000000

Definition at line 121 of file ra6_eth_driver.h.

◆ EDMAC_RD0_RFP_SOF

#define EDMAC_RD0_RFP_SOF 0x20000000

Definition at line 120 of file ra6_eth_driver.h.

◆ EDMAC_RD0_RFS_CERF

#define EDMAC_RD0_RFS_CERF 0x00000001

Definition at line 131 of file ra6_eth_driver.h.

◆ EDMAC_RD0_RFS_MASK

#define EDMAC_RD0_RFS_MASK 0x0000039F

Definition at line 123 of file ra6_eth_driver.h.

◆ EDMAC_RD0_RFS_PRE

#define EDMAC_RD0_RFS_PRE 0x00000002

Definition at line 130 of file ra6_eth_driver.h.

◆ EDMAC_RD0_RFS_RABT

#define EDMAC_RD0_RFS_RABT 0x00000100

Definition at line 125 of file ra6_eth_driver.h.

◆ EDMAC_RD0_RFS_RFOF

#define EDMAC_RD0_RFS_RFOF 0x00000200

Definition at line 124 of file ra6_eth_driver.h.

◆ EDMAC_RD0_RFS_RMAF

#define EDMAC_RD0_RFS_RMAF 0x00000080

Definition at line 126 of file ra6_eth_driver.h.

◆ EDMAC_RD0_RFS_RRF

#define EDMAC_RD0_RFS_RRF 0x00000010

Definition at line 127 of file ra6_eth_driver.h.

◆ EDMAC_RD0_RFS_RTLF

#define EDMAC_RD0_RFS_RTLF 0x00000008

Definition at line 128 of file ra6_eth_driver.h.

◆ EDMAC_RD0_RFS_RTSF

#define EDMAC_RD0_RFS_RTSF 0x00000004

Definition at line 129 of file ra6_eth_driver.h.

◆ EDMAC_RD1_RBL

#define EDMAC_RD1_RBL 0xFFFF0000

Definition at line 132 of file ra6_eth_driver.h.

◆ EDMAC_RD1_RFL

#define EDMAC_RD1_RFL 0x0000FFFF

Definition at line 133 of file ra6_eth_driver.h.

◆ EDMAC_RD2_RBA

#define EDMAC_RD2_RBA 0xFFFFFFFF

Definition at line 134 of file ra6_eth_driver.h.

◆ EDMAC_TD0_TACT

#define EDMAC_TD0_TACT 0x80000000

Definition at line 102 of file ra6_eth_driver.h.

◆ EDMAC_TD0_TDLE

#define EDMAC_TD0_TDLE 0x40000000

Definition at line 103 of file ra6_eth_driver.h.

◆ EDMAC_TD0_TFE

#define EDMAC_TD0_TFE 0x08000000

Definition at line 106 of file ra6_eth_driver.h.

◆ EDMAC_TD0_TFP_EOF

#define EDMAC_TD0_TFP_EOF 0x10000000

Definition at line 105 of file ra6_eth_driver.h.

◆ EDMAC_TD0_TFP_SOF

#define EDMAC_TD0_TFP_SOF 0x20000000

Definition at line 104 of file ra6_eth_driver.h.

◆ EDMAC_TD0_TFS_CD

#define EDMAC_TD0_TFS_CD 0x00000002

Definition at line 112 of file ra6_eth_driver.h.

◆ EDMAC_TD0_TFS_CND

#define EDMAC_TD0_TFS_CND 0x00000008

Definition at line 110 of file ra6_eth_driver.h.

◆ EDMAC_TD0_TFS_DLC

#define EDMAC_TD0_TFS_DLC 0x00000004

Definition at line 111 of file ra6_eth_driver.h.

◆ EDMAC_TD0_TFS_MASK

#define EDMAC_TD0_TFS_MASK 0x0000010F

Definition at line 108 of file ra6_eth_driver.h.

◆ EDMAC_TD0_TFS_TABT

#define EDMAC_TD0_TFS_TABT 0x00000100

Definition at line 109 of file ra6_eth_driver.h.

◆ EDMAC_TD0_TFS_TRO

#define EDMAC_TD0_TFS_TRO 0x00000001

Definition at line 113 of file ra6_eth_driver.h.

◆ EDMAC_TD0_TWBI

#define EDMAC_TD0_TWBI 0x04000000

Definition at line 107 of file ra6_eth_driver.h.

◆ EDMAC_TD1_TBL

#define EDMAC_TD1_TBL 0xFFFF0000

Definition at line 114 of file ra6_eth_driver.h.

◆ EDMAC_TD2_TBA

#define EDMAC_TD2_TBA 0xFFFFFFFF

Definition at line 115 of file ra6_eth_driver.h.

◆ R_ETHERC_EDMAC

#define R_ETHERC_EDMAC ((R_ETHERC_EDMAC_Type *) R_ETHERC_EDMAC_BASE)

Definition at line 93 of file ra6_eth_driver.h.

◆ R_MSTP_MSTPCRB_MSTPB15_Msk

#define R_MSTP_MSTPCRB_MSTPB15_Msk (R_MSTP_MSTPCRB_MSTPB_Msk << 15)

Definition at line 98 of file ra6_eth_driver.h.

◆ RA6_ETH_IRQ_GROUP_PRIORITY

#define RA6_ETH_IRQ_GROUP_PRIORITY 12

Definition at line 74 of file ra6_eth_driver.h.

◆ RA6_ETH_IRQ_PRIORITY_GROUPING

#define RA6_ETH_IRQ_PRIORITY_GROUPING 3

Definition at line 67 of file ra6_eth_driver.h.

◆ RA6_ETH_IRQ_SUB_PRIORITY

#define RA6_ETH_IRQ_SUB_PRIORITY 0

Definition at line 81 of file ra6_eth_driver.h.

◆ RA6_ETH_RAM_SECTION

#define RA6_ETH_RAM_SECTION ".ns_buffer"

Definition at line 88 of file ra6_eth_driver.h.

◆ RA6_ETH_RX_BUFFER_COUNT

#define RA6_ETH_RX_BUFFER_COUNT 6

Definition at line 53 of file ra6_eth_driver.h.

◆ RA6_ETH_RX_BUFFER_SIZE

#define RA6_ETH_RX_BUFFER_SIZE 1536

Definition at line 60 of file ra6_eth_driver.h.

◆ RA6_ETH_TX_BUFFER_COUNT

#define RA6_ETH_TX_BUFFER_COUNT 3

Definition at line 39 of file ra6_eth_driver.h.

◆ RA6_ETH_TX_BUFFER_SIZE

#define RA6_ETH_TX_BUFFER_SIZE 1536

Definition at line 46 of file ra6_eth_driver.h.

Function Documentation

◆ ra6EthDisableIrq()

void ra6EthDisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 584 of file ra6_eth_driver.c.

◆ ra6EthEnableIrq()

void ra6EthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 556 of file ra6_eth_driver.c.

◆ ra6EthEventHandler()

void ra6EthEventHandler ( NetInterface * interface )

RA6 Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 664 of file ra6_eth_driver.c.

◆ ra6EthInit()

error_t ra6EthInit ( NetInterface * interface )

RA6 Ethernet MAC initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 118 of file ra6_eth_driver.c.

◆ ra6EthInitDmaDesc()

void ra6EthInitDmaDesc ( NetInterface * interface )

Initialize DMA descriptor lists.

Parameters

[in] interface Underlying network interface

Definition at line 475 of file ra6_eth_driver.c.

◆ ra6EthInitGpio()

void ra6EthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 232 of file ra6_eth_driver.c.

◆ ra6EthReadPhyReg()

uint16_t ra6EthReadPhyReg	(	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 973 of file ra6_eth_driver.c.

◆ ra6EthReadSmi()

uint32_t ra6EthReadSmi ( 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 1046 of file ra6_eth_driver.c.

◆ ra6EthReceivePacket()

error_t ra6EthReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 757 of file ra6_eth_driver.c.

◆ ra6EthSendPacket()

error_t ra6EthSendPacket	(	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 689 of file ra6_eth_driver.c.

◆ ra6EthTick()

void ra6EthTick ( NetInterface * interface )

RA6 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 531 of file ra6_eth_driver.c.

◆ ra6EthUpdateMacAddrFilter()

error_t ra6EthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 835 of file ra6_eth_driver.c.

◆ ra6EthUpdateMacConfig()

error_t ra6EthUpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 900 of file ra6_eth_driver.c.

◆ ra6EthWritePhyReg()

void ra6EthWritePhyReg	(	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 943 of file ra6_eth_driver.c.

◆ ra6EthWriteSmi()

void ra6EthWriteSmi	(	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 1006 of file ra6_eth_driver.c.

Variable Documentation

◆ ra6EthDriver

const NicDriver ra6EthDriver

extern

RA6 Ethernet MAC driver.

Definition at line 91 of file ra6_eth_driver.c.

Data Structures

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ EDMAC_RD0_RACT

◆ EDMAC_RD0_RDLE

◆ EDMAC_RD0_RFE

◆ EDMAC_RD0_RFP_EOF

◆ EDMAC_RD0_RFP_SOF

◆ EDMAC_RD0_RFS_CERF

◆ EDMAC_RD0_RFS_MASK

◆ EDMAC_RD0_RFS_PRE

◆ EDMAC_RD0_RFS_RABT

◆ EDMAC_RD0_RFS_RFOF

◆ EDMAC_RD0_RFS_RMAF

◆ EDMAC_RD0_RFS_RRF

◆ EDMAC_RD0_RFS_RTLF

◆ EDMAC_RD0_RFS_RTSF

◆ EDMAC_RD1_RBL

◆ EDMAC_RD1_RFL

◆ EDMAC_RD2_RBA

◆ EDMAC_TD0_TACT

◆ EDMAC_TD0_TDLE

◆ EDMAC_TD0_TFE

◆ EDMAC_TD0_TFP_EOF

◆ EDMAC_TD0_TFP_SOF

◆ EDMAC_TD0_TFS_CD

◆ EDMAC_TD0_TFS_CND

◆ EDMAC_TD0_TFS_DLC

◆ EDMAC_TD0_TFS_MASK

◆ EDMAC_TD0_TFS_TABT

◆ EDMAC_TD0_TFS_TRO

◆ EDMAC_TD0_TWBI

◆ EDMAC_TD1_TBL

◆ EDMAC_TD2_TBA

◆ R_ETHERC_EDMAC

◆ R_MSTP_MSTPCRB_MSTPB15_Msk

◆ RA6_ETH_IRQ_GROUP_PRIORITY

◆ RA6_ETH_IRQ_PRIORITY_GROUPING

◆ RA6_ETH_IRQ_SUB_PRIORITY

◆ RA6_ETH_RAM_SECTION

◆ RA6_ETH_RX_BUFFER_COUNT

◆ RA6_ETH_RX_BUFFER_SIZE

◆ RA6_ETH_TX_BUFFER_COUNT

◆ RA6_ETH_TX_BUFFER_SIZE

Function Documentation

◆ ra6EthDisableIrq()

◆ ra6EthEnableIrq()

◆ ra6EthEventHandler()

◆ ra6EthInit()

◆ ra6EthInitDmaDesc()

◆ ra6EthInitGpio()

◆ ra6EthReadPhyReg()

◆ ra6EthReadSmi()

◆ ra6EthReceivePacket()

◆ ra6EthSendPacket()

◆ ra6EthTick()

◆ ra6EthUpdateMacAddrFilter()

◆ ra6EthUpdateMacConfig()

◆ ra6EthWritePhyReg()

◆ ra6EthWriteSmi()

Variable Documentation

◆ ra6EthDriver