rx62n_eth_driver.h File Reference

Renesas RX62N Ethernet MAC controller. More...

#include "core/nic.h"

Go to the source code of this file.

Data Structures

struct  Rx62nTxDmaDesc
 Transmit DMA descriptor. More...
 
struct  Rx62nRxDmaDesc
 Receive DMA descriptor. More...
 

Macros

#define RX62N_ETH_TX_BUFFER_COUNT   3
 
#define RX62N_ETH_TX_BUFFER_SIZE   1536
 
#define RX62N_ETH_RX_BUFFER_COUNT   6
 
#define RX62N_ETH_RX_BUFFER_SIZE   1536
 
#define RX62N_ETH_IRQ_PRIORITY   2
 
#define EDMAC_EESR_TWB   0x40000000
 
#define EDMAC_EESR_TABT   0x04000000
 
#define EDMAC_EESR_RABT   0x02000000
 
#define EDMAC_EESR_RFCOF   0x01000000
 
#define EDMAC_EESR_ADE   0x00800000
 
#define EDMAC_EESR_ECI   0x00400000
 
#define EDMAC_EESR_TC   0x00200000
 
#define EDMAC_EESR_TDE   0x00100000
 
#define EDMAC_EESR_TFUF   0x00080000
 
#define EDMAC_EESR_FR   0x00040000
 
#define EDMAC_EESR_RDE   0x00020000
 
#define EDMAC_EESR_RFOF   0x00010000
 
#define EDMAC_EESR_CND   0x00000800
 
#define EDMAC_EESR_DLC   0x00000400
 
#define EDMAC_EESR_CD   0x00000200
 
#define EDMAC_EESR_TRO   0x00000100
 
#define EDMAC_EESR_RMAF   0x00000080
 
#define EDMAC_EESR_RRF   0x00000010
 
#define EDMAC_EESR_RTLF   0x00000008
 
#define EDMAC_EESR_RTSF   0x00000004
 
#define EDMAC_EESR_PRE   0x00000002
 
#define EDMAC_EESR_CERF   0x00000001
 
#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
 
#define SMI_SYNC   0xFFFFFFFF
 
#define SMI_START   0x00000001
 
#define SMI_WRITE   0x00000001
 
#define SMI_READ   0x00000002
 
#define SMI_TA   0x00000002
 

Functions

error_t rx62nEthInit (NetInterface *interface)
 RX62N Ethernet MAC initialization. More...
 
void rx62nEthInitGpio (NetInterface *interface)
 
void rx62nEthInitDmaDesc (NetInterface *interface)
 Initialize DMA descriptor lists. More...
 
void rx62nEthTick (NetInterface *interface)
 RX62N Ethernet MAC timer handler. More...
 
void rx62nEthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void rx62nEthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void rx62nEthEventHandler (NetInterface *interface)
 RX62N Ethernet MAC event handler. More...
 
error_t rx62nEthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset)
 Send a packet. More...
 
error_t rx62nEthReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t rx62nEthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t rx62nEthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void rx62nEthWritePhyReg (uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t rx62nEthReadPhyReg (uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 
void rx62nEthWriteSmi (uint32_t data, uint_t length)
 SMI write operation. More...
 
uint32_t rx62nEthReadSmi (uint_t length)
 SMI read operation. More...
 

Variables

const NicDriver rx62nEthDriver
 RX62N Ethernet MAC driver. More...
 

Detailed Description

Renesas RX62N Ethernet MAC controller.

License

Copyright (C) 2010-2018 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
1.9.0

Definition in file rx62n_eth_driver.h.

Macro Definition Documentation

◆ EDMAC_EESR_ADE

#define EDMAC_EESR_ADE   0x00800000

Definition at line 75 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_CD

#define EDMAC_EESR_CD   0x00000200

Definition at line 85 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_CERF

#define EDMAC_EESR_CERF   0x00000001

Definition at line 92 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_CND

#define EDMAC_EESR_CND   0x00000800

Definition at line 83 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_DLC

#define EDMAC_EESR_DLC   0x00000400

Definition at line 84 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_ECI

#define EDMAC_EESR_ECI   0x00400000

Definition at line 76 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_FR

#define EDMAC_EESR_FR   0x00040000

Definition at line 80 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_PRE

#define EDMAC_EESR_PRE   0x00000002

Definition at line 91 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_RABT

#define EDMAC_EESR_RABT   0x02000000

Definition at line 73 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_RDE

#define EDMAC_EESR_RDE   0x00020000

Definition at line 81 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_RFCOF

#define EDMAC_EESR_RFCOF   0x01000000

Definition at line 74 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_RFOF

#define EDMAC_EESR_RFOF   0x00010000

Definition at line 82 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_RMAF

#define EDMAC_EESR_RMAF   0x00000080

Definition at line 87 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_RRF

#define EDMAC_EESR_RRF   0x00000010

Definition at line 88 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_RTLF

#define EDMAC_EESR_RTLF   0x00000008

Definition at line 89 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_RTSF

#define EDMAC_EESR_RTSF   0x00000004

Definition at line 90 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_TABT

#define EDMAC_EESR_TABT   0x04000000

Definition at line 72 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_TC

#define EDMAC_EESR_TC   0x00200000

Definition at line 77 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_TDE

#define EDMAC_EESR_TDE   0x00100000

Definition at line 78 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_TFUF

#define EDMAC_EESR_TFUF   0x00080000

Definition at line 79 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_TRO

#define EDMAC_EESR_TRO   0x00000100

Definition at line 86 of file rx62n_eth_driver.h.

◆ EDMAC_EESR_TWB

#define EDMAC_EESR_TWB   0x40000000

Definition at line 71 of file rx62n_eth_driver.h.

◆ EDMAC_RD0_RACT

#define EDMAC_RD0_RACT   0x80000000

Definition at line 111 of file rx62n_eth_driver.h.

◆ EDMAC_RD0_RDLE

#define EDMAC_RD0_RDLE   0x40000000

Definition at line 112 of file rx62n_eth_driver.h.

◆ EDMAC_RD0_RFE

#define EDMAC_RD0_RFE   0x08000000

Definition at line 115 of file rx62n_eth_driver.h.

◆ EDMAC_RD0_RFP_EOF

#define EDMAC_RD0_RFP_EOF   0x10000000

Definition at line 114 of file rx62n_eth_driver.h.

◆ EDMAC_RD0_RFP_SOF

#define EDMAC_RD0_RFP_SOF   0x20000000

Definition at line 113 of file rx62n_eth_driver.h.

◆ EDMAC_RD0_RFS_CERF

#define EDMAC_RD0_RFS_CERF   0x00000001

Definition at line 124 of file rx62n_eth_driver.h.

◆ EDMAC_RD0_RFS_MASK

#define EDMAC_RD0_RFS_MASK   0x0000039F

Definition at line 116 of file rx62n_eth_driver.h.

◆ EDMAC_RD0_RFS_PRE

#define EDMAC_RD0_RFS_PRE   0x00000002

Definition at line 123 of file rx62n_eth_driver.h.

◆ EDMAC_RD0_RFS_RABT

#define EDMAC_RD0_RFS_RABT   0x00000100

Definition at line 118 of file rx62n_eth_driver.h.

◆ EDMAC_RD0_RFS_RFOF

#define EDMAC_RD0_RFS_RFOF   0x00000200

Definition at line 117 of file rx62n_eth_driver.h.

◆ EDMAC_RD0_RFS_RMAF

#define EDMAC_RD0_RFS_RMAF   0x00000080

Definition at line 119 of file rx62n_eth_driver.h.

◆ EDMAC_RD0_RFS_RRF

#define EDMAC_RD0_RFS_RRF   0x00000010

Definition at line 120 of file rx62n_eth_driver.h.

◆ EDMAC_RD0_RFS_RTLF

#define EDMAC_RD0_RFS_RTLF   0x00000008

Definition at line 121 of file rx62n_eth_driver.h.

◆ EDMAC_RD0_RFS_RTSF

#define EDMAC_RD0_RFS_RTSF   0x00000004

Definition at line 122 of file rx62n_eth_driver.h.

◆ EDMAC_RD1_RBL

#define EDMAC_RD1_RBL   0xFFFF0000

Definition at line 125 of file rx62n_eth_driver.h.

◆ EDMAC_RD1_RFL

#define EDMAC_RD1_RFL   0x0000FFFF

Definition at line 126 of file rx62n_eth_driver.h.

◆ EDMAC_RD2_RBA

#define EDMAC_RD2_RBA   0xFFFFFFFF

Definition at line 127 of file rx62n_eth_driver.h.

◆ EDMAC_TD0_TACT

#define EDMAC_TD0_TACT   0x80000000

Definition at line 95 of file rx62n_eth_driver.h.

◆ EDMAC_TD0_TDLE

#define EDMAC_TD0_TDLE   0x40000000

Definition at line 96 of file rx62n_eth_driver.h.

◆ EDMAC_TD0_TFE

#define EDMAC_TD0_TFE   0x08000000

Definition at line 99 of file rx62n_eth_driver.h.

◆ EDMAC_TD0_TFP_EOF

#define EDMAC_TD0_TFP_EOF   0x10000000

Definition at line 98 of file rx62n_eth_driver.h.

◆ EDMAC_TD0_TFP_SOF

#define EDMAC_TD0_TFP_SOF   0x20000000

Definition at line 97 of file rx62n_eth_driver.h.

◆ EDMAC_TD0_TFS_CD

#define EDMAC_TD0_TFS_CD   0x00000002

Definition at line 105 of file rx62n_eth_driver.h.

◆ EDMAC_TD0_TFS_CND

#define EDMAC_TD0_TFS_CND   0x00000008

Definition at line 103 of file rx62n_eth_driver.h.

◆ EDMAC_TD0_TFS_DLC

#define EDMAC_TD0_TFS_DLC   0x00000004

Definition at line 104 of file rx62n_eth_driver.h.

◆ EDMAC_TD0_TFS_MASK

#define EDMAC_TD0_TFS_MASK   0x0000010F

Definition at line 101 of file rx62n_eth_driver.h.

◆ EDMAC_TD0_TFS_TABT

#define EDMAC_TD0_TFS_TABT   0x00000100

Definition at line 102 of file rx62n_eth_driver.h.

◆ EDMAC_TD0_TFS_TRO

#define EDMAC_TD0_TFS_TRO   0x00000001

Definition at line 106 of file rx62n_eth_driver.h.

◆ EDMAC_TD0_TWBI

#define EDMAC_TD0_TWBI   0x04000000

Definition at line 100 of file rx62n_eth_driver.h.

◆ EDMAC_TD1_TBL

#define EDMAC_TD1_TBL   0xFFFF0000

Definition at line 107 of file rx62n_eth_driver.h.

◆ EDMAC_TD2_TBA

#define EDMAC_TD2_TBA   0xFFFFFFFF

Definition at line 108 of file rx62n_eth_driver.h.

◆ RX62N_ETH_IRQ_PRIORITY

#define RX62N_ETH_IRQ_PRIORITY   2

Definition at line 65 of file rx62n_eth_driver.h.

◆ RX62N_ETH_RX_BUFFER_COUNT

#define RX62N_ETH_RX_BUFFER_COUNT   6

Definition at line 51 of file rx62n_eth_driver.h.

◆ RX62N_ETH_RX_BUFFER_SIZE

#define RX62N_ETH_RX_BUFFER_SIZE   1536

Definition at line 58 of file rx62n_eth_driver.h.

◆ RX62N_ETH_TX_BUFFER_COUNT

#define RX62N_ETH_TX_BUFFER_COUNT   3

Definition at line 37 of file rx62n_eth_driver.h.

◆ RX62N_ETH_TX_BUFFER_SIZE

#define RX62N_ETH_TX_BUFFER_SIZE   1536

Definition at line 44 of file rx62n_eth_driver.h.

◆ SMI_READ

#define SMI_READ   0x00000002

Definition at line 133 of file rx62n_eth_driver.h.

◆ SMI_START

#define SMI_START   0x00000001

Definition at line 131 of file rx62n_eth_driver.h.

◆ SMI_SYNC

#define SMI_SYNC   0xFFFFFFFF

Definition at line 130 of file rx62n_eth_driver.h.

◆ SMI_TA

#define SMI_TA   0x00000002

Definition at line 134 of file rx62n_eth_driver.h.

◆ SMI_WRITE

#define SMI_WRITE   0x00000001

Definition at line 132 of file rx62n_eth_driver.h.

Function Documentation

◆ rx62nEthDisableIrq()

void rx62nEthDisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 334 of file rx62n_eth_driver.c.

◆ rx62nEthEnableIrq()

void rx62nEthEnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 320 of file rx62n_eth_driver.c.

◆ rx62nEthEventHandler()

void rx62nEthEventHandler ( NetInterface interface)

RX62N Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 398 of file rx62n_eth_driver.c.

◆ rx62nEthInit()

error_t rx62nEthInit ( NetInterface interface)

RX62N Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 113 of file rx62n_eth_driver.c.

◆ rx62nEthInitDmaDesc()

void rx62nEthInitDmaDesc ( NetInterface interface)

Initialize DMA descriptor lists.

Parameters
[in]interfaceUnderlying network interface

Definition at line 252 of file rx62n_eth_driver.c.

◆ rx62nEthInitGpio()

void rx62nEthInitGpio ( NetInterface interface)

◆ rx62nEthReadPhyReg()

uint16_t rx62nEthReadPhyReg ( uint8_t  phyAddr,
uint8_t  regAddr 
)

Read PHY register.

Parameters
[in]phyAddrPHY address
[in]regAddrRegister address
Returns
Register value

Definition at line 665 of file rx62n_eth_driver.c.

◆ rx62nEthReadSmi()

uint32_t rx62nEthReadSmi ( 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 733 of file rx62n_eth_driver.c.

◆ rx62nEthReceivePacket()

error_t rx62nEthReceivePacket ( NetInterface interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 498 of file rx62n_eth_driver.c.

◆ rx62nEthSendPacket()

error_t rx62nEthSendPacket ( NetInterface interface,
const NetBuffer buffer,
size_t  offset 
)

Send a packet.

Parameters
[in]interfaceUnderlying network interface
[in]bufferMulti-part buffer containing the data to send
[in]offsetOffset to the first data byte
Returns
Error code

Definition at line 432 of file rx62n_eth_driver.c.

◆ rx62nEthTick()

void rx62nEthTick ( NetInterface interface)

RX62N 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 308 of file rx62n_eth_driver.c.

◆ rx62nEthUpdateMacAddrFilter()

error_t rx62nEthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 572 of file rx62n_eth_driver.c.

◆ rx62nEthUpdateMacConfig()

error_t rx62nEthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 611 of file rx62n_eth_driver.c.

◆ rx62nEthWritePhyReg()

void rx62nEthWritePhyReg ( uint8_t  phyAddr,
uint8_t  regAddr,
uint16_t  data 
)

Write PHY register.

Parameters
[in]phyAddrPHY address
[in]regAddrRegister address
[in]dataRegister value

Definition at line 637 of file rx62n_eth_driver.c.

◆ rx62nEthWriteSmi()

void rx62nEthWriteSmi ( 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 697 of file rx62n_eth_driver.c.

Variable Documentation

◆ rx62nEthDriver

const NicDriver rx62nEthDriver

RX62N Ethernet MAC driver.

Definition at line 86 of file rx62n_eth_driver.c.