Data Structures | Macros | Functions | Variables
rza2_eth2_driver.h File Reference

RZ/A2 Ethernet MAC driver (ETHERC1 instance) More...

#include "core/nic.h"

Go to the source code of this file.

Data Structures

struct  Rza2Eth2TxDmaDesc
 Transmit DMA descriptor. More...
 
struct  Rza2Eth2RxDmaDesc
 Receive DMA descriptor. More...
 

Macros

#define RZA2_ETH2_TX_BUFFER_COUNT   8
 
#define RZA2_ETH2_TX_BUFFER_SIZE   1536
 
#define RZA2_ETH2_RX_BUFFER_COUNT   8
 
#define RZA2_ETH2_RX_BUFFER_SIZE   1536
 
#define RZA2_ETH2_IRQ_PRIORITY   25
 
#define RZA2_ETH2_RAM_SECTION   ".BSS_DMAC_SAMPLE_INTERNAL_RAM"
 
#define RZA2_ETH2_GET_PHYSICAL_ADDR(addr)   ((uint32_t) (addr) - 0x02000000U)
 
#define EDMAC_EDMR_DL_16   0x00000000
 
#define EDMAC_EDMR_DL_32   0x00000010
 
#define EDMAC_EDMR_DL_64   0x00000020
 
#define EDMAC_FDR_TFD_2048   0x00000700
 
#define EDMAC_FDR_RFD_4096   0x0000000F
 
#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 rza2Eth2Init (NetInterface *interface)
 RZ/A2 Ethernet MAC initialization. More...
 
void rza2Eth2InitGpio (NetInterface *interface)
 GPIO configuration. More...
 
void rza2Eth2InitDmaDesc (NetInterface *interface)
 Initialize DMA descriptor lists. More...
 
void rza2Eth2Tick (NetInterface *interface)
 RZ/A2 Ethernet MAC timer handler. More...
 
void rza2Eth2EnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void rza2Eth2DisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void rza2Eth2IrqHandler (uint32_t intSense)
 RZ/A2 Ethernet MAC interrupt service routine. More...
 
void rza2Eth2EventHandler (NetInterface *interface)
 RZ/A2 Ethernet MAC event handler. More...
 
error_t rza2Eth2SendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
 
error_t rza2Eth2ReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t rza2Eth2UpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t rza2Eth2UpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void rza2Eth2WritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t rza2Eth2ReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 
void rza2Eth2WriteSmi (uint32_t data, uint_t length)
 SMI write operation. More...
 
uint32_t rza2Eth2ReadSmi (uint_t length)
 SMI read operation. More...
 

Variables

const NicDriver rza2Eth2Driver
 RZ/A2 Ethernet MAC driver (ETHERC1 instance) More...
 

Detailed Description

RZ/A2 Ethernet MAC driver (ETHERC1 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.0

Definition in file rza2_eth2_driver.h.

Macro Definition Documentation

◆ EDMAC_EDMR_DL_16

#define EDMAC_EDMR_DL_16   0x00000000

Definition at line 83 of file rza2_eth2_driver.h.

◆ EDMAC_EDMR_DL_32

#define EDMAC_EDMR_DL_32   0x00000010

Definition at line 84 of file rza2_eth2_driver.h.

◆ EDMAC_EDMR_DL_64

#define EDMAC_EDMR_DL_64   0x00000020

Definition at line 85 of file rza2_eth2_driver.h.

◆ EDMAC_FDR_RFD_4096

#define EDMAC_FDR_RFD_4096   0x0000000F

Definition at line 89 of file rza2_eth2_driver.h.

◆ EDMAC_FDR_TFD_2048

#define EDMAC_FDR_TFD_2048   0x00000700

Definition at line 88 of file rza2_eth2_driver.h.

◆ EDMAC_RD0_RACT

#define EDMAC_RD0_RACT   0x80000000

Definition at line 108 of file rza2_eth2_driver.h.

◆ EDMAC_RD0_RDLE

#define EDMAC_RD0_RDLE   0x40000000

Definition at line 109 of file rza2_eth2_driver.h.

◆ EDMAC_RD0_RFE

#define EDMAC_RD0_RFE   0x08000000

Definition at line 112 of file rza2_eth2_driver.h.

◆ EDMAC_RD0_RFP_EOF

#define EDMAC_RD0_RFP_EOF   0x10000000

Definition at line 111 of file rza2_eth2_driver.h.

◆ EDMAC_RD0_RFP_SOF

#define EDMAC_RD0_RFP_SOF   0x20000000

Definition at line 110 of file rza2_eth2_driver.h.

◆ EDMAC_RD0_RFS_CERF

#define EDMAC_RD0_RFS_CERF   0x00000001

Definition at line 121 of file rza2_eth2_driver.h.

◆ EDMAC_RD0_RFS_MASK

#define EDMAC_RD0_RFS_MASK   0x0000039F

Definition at line 113 of file rza2_eth2_driver.h.

◆ EDMAC_RD0_RFS_PRE

#define EDMAC_RD0_RFS_PRE   0x00000002

Definition at line 120 of file rza2_eth2_driver.h.

◆ EDMAC_RD0_RFS_RABT

#define EDMAC_RD0_RFS_RABT   0x00000100

Definition at line 115 of file rza2_eth2_driver.h.

◆ EDMAC_RD0_RFS_RFOF

#define EDMAC_RD0_RFS_RFOF   0x00000200

Definition at line 114 of file rza2_eth2_driver.h.

◆ EDMAC_RD0_RFS_RMAF

#define EDMAC_RD0_RFS_RMAF   0x00000080

Definition at line 116 of file rza2_eth2_driver.h.

◆ EDMAC_RD0_RFS_RRF

#define EDMAC_RD0_RFS_RRF   0x00000010

Definition at line 117 of file rza2_eth2_driver.h.

◆ EDMAC_RD0_RFS_RTLF

#define EDMAC_RD0_RFS_RTLF   0x00000008

Definition at line 118 of file rza2_eth2_driver.h.

◆ EDMAC_RD0_RFS_RTSF

#define EDMAC_RD0_RFS_RTSF   0x00000004

Definition at line 119 of file rza2_eth2_driver.h.

◆ EDMAC_RD1_RBL

#define EDMAC_RD1_RBL   0xFFFF0000

Definition at line 122 of file rza2_eth2_driver.h.

◆ EDMAC_RD1_RFL

#define EDMAC_RD1_RFL   0x0000FFFF

Definition at line 123 of file rza2_eth2_driver.h.

◆ EDMAC_RD2_RBA

#define EDMAC_RD2_RBA   0xFFFFFFFF

Definition at line 124 of file rza2_eth2_driver.h.

◆ EDMAC_TD0_TACT

#define EDMAC_TD0_TACT   0x80000000

Definition at line 92 of file rza2_eth2_driver.h.

◆ EDMAC_TD0_TDLE

#define EDMAC_TD0_TDLE   0x40000000

Definition at line 93 of file rza2_eth2_driver.h.

◆ EDMAC_TD0_TFE

#define EDMAC_TD0_TFE   0x08000000

Definition at line 96 of file rza2_eth2_driver.h.

◆ EDMAC_TD0_TFP_EOF

#define EDMAC_TD0_TFP_EOF   0x10000000

Definition at line 95 of file rza2_eth2_driver.h.

◆ EDMAC_TD0_TFP_SOF

#define EDMAC_TD0_TFP_SOF   0x20000000

Definition at line 94 of file rza2_eth2_driver.h.

◆ EDMAC_TD0_TFS_CD

#define EDMAC_TD0_TFS_CD   0x00000002

Definition at line 102 of file rza2_eth2_driver.h.

◆ EDMAC_TD0_TFS_CND

#define EDMAC_TD0_TFS_CND   0x00000008

Definition at line 100 of file rza2_eth2_driver.h.

◆ EDMAC_TD0_TFS_DLC

#define EDMAC_TD0_TFS_DLC   0x00000004

Definition at line 101 of file rza2_eth2_driver.h.

◆ EDMAC_TD0_TFS_MASK

#define EDMAC_TD0_TFS_MASK   0x0000010F

Definition at line 98 of file rza2_eth2_driver.h.

◆ EDMAC_TD0_TFS_TABT

#define EDMAC_TD0_TFS_TABT   0x00000100

Definition at line 99 of file rza2_eth2_driver.h.

◆ EDMAC_TD0_TFS_TRO

#define EDMAC_TD0_TFS_TRO   0x00000001

Definition at line 103 of file rza2_eth2_driver.h.

◆ EDMAC_TD0_TWBI

#define EDMAC_TD0_TWBI   0x04000000

Definition at line 97 of file rza2_eth2_driver.h.

◆ EDMAC_TD1_TBL

#define EDMAC_TD1_TBL   0xFFFF0000

Definition at line 104 of file rza2_eth2_driver.h.

◆ EDMAC_TD2_TBA

#define EDMAC_TD2_TBA   0xFFFFFFFF

Definition at line 105 of file rza2_eth2_driver.h.

◆ RZA2_ETH2_GET_PHYSICAL_ADDR

#define RZA2_ETH2_GET_PHYSICAL_ADDR (   addr)    ((uint32_t) (addr) - 0x02000000U)

Definition at line 79 of file rza2_eth2_driver.h.

◆ RZA2_ETH2_IRQ_PRIORITY

#define RZA2_ETH2_IRQ_PRIORITY   25

Definition at line 67 of file rza2_eth2_driver.h.

◆ RZA2_ETH2_RAM_SECTION

#define RZA2_ETH2_RAM_SECTION   ".BSS_DMAC_SAMPLE_INTERNAL_RAM"

Definition at line 74 of file rza2_eth2_driver.h.

◆ RZA2_ETH2_RX_BUFFER_COUNT

#define RZA2_ETH2_RX_BUFFER_COUNT   8

Definition at line 53 of file rza2_eth2_driver.h.

◆ RZA2_ETH2_RX_BUFFER_SIZE

#define RZA2_ETH2_RX_BUFFER_SIZE   1536

Definition at line 60 of file rza2_eth2_driver.h.

◆ RZA2_ETH2_TX_BUFFER_COUNT

#define RZA2_ETH2_TX_BUFFER_COUNT   8

Definition at line 39 of file rza2_eth2_driver.h.

◆ RZA2_ETH2_TX_BUFFER_SIZE

#define RZA2_ETH2_TX_BUFFER_SIZE   1536

Definition at line 46 of file rza2_eth2_driver.h.

Function Documentation

◆ rza2Eth2DisableIrq()

void rza2Eth2DisableIrq ( NetInterface *  interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 464 of file rza2_eth2_driver.c.

◆ rza2Eth2EnableIrq()

void rza2Eth2EnableIrq ( NetInterface *  interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 436 of file rza2_eth2_driver.c.

◆ rza2Eth2EventHandler()

void rza2Eth2EventHandler ( NetInterface *  interface)

RZ/A2 Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 542 of file rza2_eth2_driver.c.

◆ rza2Eth2Init()

error_t rza2Eth2Init ( NetInterface *  interface)

RZ/A2 Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 123 of file rza2_eth2_driver.c.

◆ rza2Eth2InitDmaDesc()

void rza2Eth2InitDmaDesc ( NetInterface *  interface)

Initialize DMA descriptor lists.

Parameters
[in]interfaceUnderlying network interface

Definition at line 355 of file rza2_eth2_driver.c.

◆ rza2Eth2InitGpio()

void rza2Eth2InitGpio ( NetInterface *  interface)

GPIO configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 224 of file rza2_eth2_driver.c.

◆ rza2Eth2IrqHandler()

void rza2Eth2IrqHandler ( uint32_t  intSense)

RZ/A2 Ethernet MAC interrupt service routine.

Parameters
[in]intSenseUnused parameter

Definition at line 492 of file rza2_eth2_driver.c.

◆ rza2Eth2ReadPhyReg()

uint16_t rza2Eth2ReadPhyReg ( 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 855 of file rza2_eth2_driver.c.

◆ rza2Eth2ReadSmi()

uint32_t rza2Eth2ReadSmi ( uint_t  length)

SMI read operation.

Parameters
[in]lengthNumber of bits to be read
Returns
Data resulting from the MDIO read operation

Definition at line 928 of file rza2_eth2_driver.c.

◆ rza2Eth2ReceivePacket()

error_t rza2Eth2ReceivePacket ( NetInterface *  interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 635 of file rza2_eth2_driver.c.

◆ rza2Eth2SendPacket()

error_t rza2Eth2SendPacket ( 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 567 of file rza2_eth2_driver.c.

◆ rza2Eth2Tick()

void rza2Eth2Tick ( NetInterface *  interface)

RZ/A2 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 411 of file rza2_eth2_driver.c.

◆ rza2Eth2UpdateMacAddrFilter()

error_t rza2Eth2UpdateMacAddrFilter ( NetInterface *  interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 717 of file rza2_eth2_driver.c.

◆ rza2Eth2UpdateMacConfig()

error_t rza2Eth2UpdateMacConfig ( NetInterface *  interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 782 of file rza2_eth2_driver.c.

◆ rza2Eth2WritePhyReg()

void rza2Eth2WritePhyReg ( 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 825 of file rza2_eth2_driver.c.

◆ rza2Eth2WriteSmi()

void rza2Eth2WriteSmi ( uint32_t  data,
uint_t  length 
)

SMI write operation.

Parameters
[in]dataRaw data to be written
[in]lengthNumber of bits to be written

Definition at line 888 of file rza2_eth2_driver.c.

Variable Documentation

◆ rza2Eth2Driver

const NicDriver rza2Eth2Driver
extern

RZ/A2 Ethernet MAC driver (ETHERC1 instance)

Definition at line 96 of file rza2_eth2_driver.c.