lpc546xx_eth_driver.h File Reference

LPC54608/LPC54618/LPC54628 Ethernet MAC controller. More...

#include "core/nic.h"

Go to the source code of this file.

Data Structures

struct  Lpc546xxTxDmaDesc
 Transmit descriptor. More...
 
struct  Lpc546xxRxDmaDesc
 Receive descriptor. More...
 

Macros

#define LPC546XX_ETH_TX_BUFFER_COUNT   3
 
#define LPC546XX_ETH_TX_BUFFER_SIZE   1536
 
#define LPC546XX_ETH_RX_BUFFER_COUNT   6
 
#define LPC546XX_ETH_RX_BUFFER_SIZE   1536
 
#define LPC546XX_ETH_IRQ_PRIORITY_GROUPING   4
 
#define LPC546XX_ETH_IRQ_GROUP_PRIORITY   6
 
#define LPC546XX_ETH_IRQ_SUB_PRIORITY   0
 
#define ENET_TDES0_BUF1AP   0xFFFFFFFF
 
#define ENET_TDES1_BUF2AP   0xFFFFFFFF
 
#define ENET_TDES2_IOC   0x80000000
 
#define ENET_TDES2_TTSE   0x40000000
 
#define ENET_TDES2_B2L   0x3FFF0000
 
#define ENET_TDES2_B1L   0x00003FFF
 
#define ENET_TDES3_OWN   0x80000000
 
#define ENET_TDES3_CTXT   0x40000000
 
#define ENET_TDES3_FD   0x20000000
 
#define ENET_TDES3_LD   0x10000000
 
#define ENET_TDES3_CPC   0x0C000000
 
#define ENET_TDES3_SLOTNUM   0x00780000
 
#define ENET_TDES3_CIC   0x00030000
 
#define ENET_TDES3_FL   0x00007FFF
 
#define ENET_TDES0_TTSL   0xFFFFFFFF
 
#define ENET_TDES1_TTSH   0xFFFFFFFF
 
#define ENET_TDES3_OWN   0x80000000
 
#define ENET_TDES3_CTXT   0x40000000
 
#define ENET_TDES3_FD   0x20000000
 
#define ENET_TDES3_LD   0x10000000
 
#define ENET_TDES3_TTSS   0x00020000
 
#define ENET_TDES3_ES   0x00008000
 
#define ENET_TDES3_JT   0x00004000
 
#define ENET_TDES3_FF   0x00002000
 
#define ENET_TDES3_PCE   0x00001000
 
#define ENET_TDES3_LOC   0x00000800
 
#define ENET_TDES3_NC   0x00000400
 
#define ENET_TDES3_LC   0x00000200
 
#define ENET_TDES3_EC   0x00000100
 
#define ENET_TDES3_CC   0x000000F0
 
#define ENET_TDES3_ED   0x00000008
 
#define ENET_TDES3_UF   0x00000004
 
#define ENET_TDES3_DB   0x00000002
 
#define ENET_TDES3_IHE   0x00000001
 
#define ENET_RDES0_BUF1AP   0xFFFFFFFF
 
#define ENET_RDES2_BUF2AP   0xFFFFFFFF
 
#define ENET_RDES3_OWN   0x80000000
 
#define ENET_RDES3_IOC   0x40000000
 
#define ENET_RDES3_BUF2V   0x02000000
 
#define ENET_RDES3_BUF1V   0x01000000
 
#define ENET_RDES1_OPC   0xFFFF0000
 
#define ENET_RDES1_TD   0x00008000
 
#define ENET_RDES1_TSA   0x00004000
 
#define ENET_RDES1_PV   0x00002000
 
#define ENET_RDES1_PFT   0x00001000
 
#define ENET_RDES1_PMT   0x00000F00
 
#define ENET_RDES1_IPCE   0x00000080
 
#define ENET_RDES1_IPCB   0x00000040
 
#define ENET_RDES1_IPV6   0x00000020
 
#define ENET_RDES1_IPV4   0x00000010
 
#define ENET_RDES1_IPHE   0x00000008
 
#define ENET_RDES1_PT   0x00000007
 
#define ENET_RDES2_MADRM   0x07F80000
 
#define ENET_RDES2_DAF   0x00020000
 
#define ENET_RDES2_SAF   0x00010000
 
#define ENET_RDES3_OWN   0x80000000
 
#define ENET_RDES3_CTXT   0x40000000
 
#define ENET_RDES3_FD   0x20000000
 
#define ENET_RDES3_LD   0x10000000
 
#define ENET_RDES3_RS2V   0x08000000
 
#define ENET_RDES3_RS1V   0x04000000
 
#define ENET_RDES3_RS0V   0x02000000
 
#define ENET_RDES3_CE   0x01000000
 
#define ENET_RDES3_GP   0x00800000
 
#define ENET_RDES3_RWT   0x00400000
 
#define ENET_RDES3_OE   0x00200000
 
#define ENET_RDES3_RE   0x00100000
 
#define ENET_RDES3_DE   0x00080000
 
#define ENET_RDES3_LT   0x00070000
 
#define ENET_RDES3_ES   0x00008000
 
#define ENET_RDES3_PL   0x00007FFF
 

Functions

error_t lpc546xxEthInit (NetInterface *interface)
 LPC546xx Ethernet MAC initialization. More...
 
void lpc546xxEthInitGpio (NetInterface *interface)
 
void lpc546xxEthInitDmaDesc (NetInterface *interface)
 Initialize DMA descriptor lists. More...
 
void lpc546xxEthTick (NetInterface *interface)
 LPC546xx Ethernet MAC timer handler. More...
 
void lpc546xxEthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void lpc546xxEthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void lpc546xxEthEventHandler (NetInterface *interface)
 LPC546xx Ethernet MAC event handler. More...
 
error_t lpc546xxEthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset)
 Send a packet. More...
 
error_t lpc546xxEthReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t lpc546xxEthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t lpc546xxEthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void lpc546xxEthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t lpc546xxEthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 

Variables

const NicDriver lpc546xxEthDriver
 LPC546xx Ethernet MAC driver. More...
 

Detailed Description

LPC54608/LPC54618/LPC54628 Ethernet MAC controller.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2019 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.6

Definition in file lpc546xx_eth_driver.h.

Macro Definition Documentation

◆ ENET_RDES0_BUF1AP

#define ENET_RDES0_BUF1AP   0xFFFFFFFF

Definition at line 125 of file lpc546xx_eth_driver.h.

◆ ENET_RDES1_IPCB

#define ENET_RDES1_IPCB   0x00000040

Definition at line 140 of file lpc546xx_eth_driver.h.

◆ ENET_RDES1_IPCE

#define ENET_RDES1_IPCE   0x00000080

Definition at line 139 of file lpc546xx_eth_driver.h.

◆ ENET_RDES1_IPHE

#define ENET_RDES1_IPHE   0x00000008

Definition at line 143 of file lpc546xx_eth_driver.h.

◆ ENET_RDES1_IPV4

#define ENET_RDES1_IPV4   0x00000010

Definition at line 142 of file lpc546xx_eth_driver.h.

◆ ENET_RDES1_IPV6

#define ENET_RDES1_IPV6   0x00000020

Definition at line 141 of file lpc546xx_eth_driver.h.

◆ ENET_RDES1_OPC

#define ENET_RDES1_OPC   0xFFFF0000

Definition at line 133 of file lpc546xx_eth_driver.h.

◆ ENET_RDES1_PFT

#define ENET_RDES1_PFT   0x00001000

Definition at line 137 of file lpc546xx_eth_driver.h.

◆ ENET_RDES1_PMT

#define ENET_RDES1_PMT   0x00000F00

Definition at line 138 of file lpc546xx_eth_driver.h.

◆ ENET_RDES1_PT

#define ENET_RDES1_PT   0x00000007

Definition at line 144 of file lpc546xx_eth_driver.h.

◆ ENET_RDES1_PV

#define ENET_RDES1_PV   0x00002000

Definition at line 136 of file lpc546xx_eth_driver.h.

◆ ENET_RDES1_TD

#define ENET_RDES1_TD   0x00008000

Definition at line 134 of file lpc546xx_eth_driver.h.

◆ ENET_RDES1_TSA

#define ENET_RDES1_TSA   0x00004000

Definition at line 135 of file lpc546xx_eth_driver.h.

◆ ENET_RDES2_BUF2AP

#define ENET_RDES2_BUF2AP   0xFFFFFFFF

Definition at line 126 of file lpc546xx_eth_driver.h.

◆ ENET_RDES2_DAF

#define ENET_RDES2_DAF   0x00020000

Definition at line 146 of file lpc546xx_eth_driver.h.

◆ ENET_RDES2_MADRM

#define ENET_RDES2_MADRM   0x07F80000

Definition at line 145 of file lpc546xx_eth_driver.h.

◆ ENET_RDES2_SAF

#define ENET_RDES2_SAF   0x00010000

Definition at line 147 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_BUF1V

#define ENET_RDES3_BUF1V   0x01000000

Definition at line 130 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_BUF2V

#define ENET_RDES3_BUF2V   0x02000000

Definition at line 129 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_CE

#define ENET_RDES3_CE   0x01000000

Definition at line 155 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_CTXT

#define ENET_RDES3_CTXT   0x40000000

Definition at line 149 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_DE

#define ENET_RDES3_DE   0x00080000

Definition at line 160 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_ES

#define ENET_RDES3_ES   0x00008000

Definition at line 162 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_FD

#define ENET_RDES3_FD   0x20000000

Definition at line 150 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_GP

#define ENET_RDES3_GP   0x00800000

Definition at line 156 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_IOC

#define ENET_RDES3_IOC   0x40000000

Definition at line 128 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_LD

#define ENET_RDES3_LD   0x10000000

Definition at line 151 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_LT

#define ENET_RDES3_LT   0x00070000

Definition at line 161 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_OE

#define ENET_RDES3_OE   0x00200000

Definition at line 158 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_OWN [1/2]

#define ENET_RDES3_OWN   0x80000000

Definition at line 148 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_OWN [2/2]

#define ENET_RDES3_OWN   0x80000000

Definition at line 148 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_PL

#define ENET_RDES3_PL   0x00007FFF

Definition at line 163 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_RE

#define ENET_RDES3_RE   0x00100000

Definition at line 159 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_RS0V

#define ENET_RDES3_RS0V   0x02000000

Definition at line 154 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_RS1V

#define ENET_RDES3_RS1V   0x04000000

Definition at line 153 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_RS2V

#define ENET_RDES3_RS2V   0x08000000

Definition at line 152 of file lpc546xx_eth_driver.h.

◆ ENET_RDES3_RWT

#define ENET_RDES3_RWT   0x00400000

Definition at line 157 of file lpc546xx_eth_driver.h.

◆ ENET_TDES0_BUF1AP

#define ENET_TDES0_BUF1AP   0xFFFFFFFF

Definition at line 87 of file lpc546xx_eth_driver.h.

◆ ENET_TDES0_TTSL

#define ENET_TDES0_TTSL   0xFFFFFFFF

Definition at line 103 of file lpc546xx_eth_driver.h.

◆ ENET_TDES1_BUF2AP

#define ENET_TDES1_BUF2AP   0xFFFFFFFF

Definition at line 88 of file lpc546xx_eth_driver.h.

◆ ENET_TDES1_TTSH

#define ENET_TDES1_TTSH   0xFFFFFFFF

Definition at line 104 of file lpc546xx_eth_driver.h.

◆ ENET_TDES2_B1L

#define ENET_TDES2_B1L   0x00003FFF

Definition at line 92 of file lpc546xx_eth_driver.h.

◆ ENET_TDES2_B2L

#define ENET_TDES2_B2L   0x3FFF0000

Definition at line 91 of file lpc546xx_eth_driver.h.

◆ ENET_TDES2_IOC

#define ENET_TDES2_IOC   0x80000000

Definition at line 89 of file lpc546xx_eth_driver.h.

◆ ENET_TDES2_TTSE

#define ENET_TDES2_TTSE   0x40000000

Definition at line 90 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_CC

#define ENET_TDES3_CC   0x000000F0

Definition at line 118 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_CIC

#define ENET_TDES3_CIC   0x00030000

Definition at line 99 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_CPC

#define ENET_TDES3_CPC   0x0C000000

Definition at line 97 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_CTXT [1/2]

#define ENET_TDES3_CTXT   0x40000000

Definition at line 106 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_CTXT [2/2]

#define ENET_TDES3_CTXT   0x40000000

Definition at line 106 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_DB

#define ENET_TDES3_DB   0x00000002

Definition at line 121 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_EC

#define ENET_TDES3_EC   0x00000100

Definition at line 117 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_ED

#define ENET_TDES3_ED   0x00000008

Definition at line 119 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_ES

#define ENET_TDES3_ES   0x00008000

Definition at line 110 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_FD [1/2]

#define ENET_TDES3_FD   0x20000000

Definition at line 107 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_FD [2/2]

#define ENET_TDES3_FD   0x20000000

Definition at line 107 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_FF

#define ENET_TDES3_FF   0x00002000

Definition at line 112 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_FL

#define ENET_TDES3_FL   0x00007FFF

Definition at line 100 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_IHE

#define ENET_TDES3_IHE   0x00000001

Definition at line 122 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_JT

#define ENET_TDES3_JT   0x00004000

Definition at line 111 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_LC

#define ENET_TDES3_LC   0x00000200

Definition at line 116 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_LD [1/2]

#define ENET_TDES3_LD   0x10000000

Definition at line 108 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_LD [2/2]

#define ENET_TDES3_LD   0x10000000

Definition at line 108 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_LOC

#define ENET_TDES3_LOC   0x00000800

Definition at line 114 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_NC

#define ENET_TDES3_NC   0x00000400

Definition at line 115 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_OWN [1/2]

#define ENET_TDES3_OWN   0x80000000

Definition at line 105 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_OWN [2/2]

#define ENET_TDES3_OWN   0x80000000

Definition at line 105 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_PCE

#define ENET_TDES3_PCE   0x00001000

Definition at line 113 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_SLOTNUM

#define ENET_TDES3_SLOTNUM   0x00780000

Definition at line 98 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_TTSS

#define ENET_TDES3_TTSS   0x00020000

Definition at line 109 of file lpc546xx_eth_driver.h.

◆ ENET_TDES3_UF

#define ENET_TDES3_UF   0x00000004

Definition at line 120 of file lpc546xx_eth_driver.h.

◆ LPC546XX_ETH_IRQ_GROUP_PRIORITY

#define LPC546XX_ETH_IRQ_GROUP_PRIORITY   6

Definition at line 74 of file lpc546xx_eth_driver.h.

◆ LPC546XX_ETH_IRQ_PRIORITY_GROUPING

#define LPC546XX_ETH_IRQ_PRIORITY_GROUPING   4

Definition at line 67 of file lpc546xx_eth_driver.h.

◆ LPC546XX_ETH_IRQ_SUB_PRIORITY

#define LPC546XX_ETH_IRQ_SUB_PRIORITY   0

Definition at line 81 of file lpc546xx_eth_driver.h.

◆ LPC546XX_ETH_RX_BUFFER_COUNT

#define LPC546XX_ETH_RX_BUFFER_COUNT   6

Definition at line 53 of file lpc546xx_eth_driver.h.

◆ LPC546XX_ETH_RX_BUFFER_SIZE

#define LPC546XX_ETH_RX_BUFFER_SIZE   1536

Definition at line 60 of file lpc546xx_eth_driver.h.

◆ LPC546XX_ETH_TX_BUFFER_COUNT

#define LPC546XX_ETH_TX_BUFFER_COUNT   3

Definition at line 39 of file lpc546xx_eth_driver.h.

◆ LPC546XX_ETH_TX_BUFFER_SIZE

#define LPC546XX_ETH_TX_BUFFER_SIZE   1536

Definition at line 46 of file lpc546xx_eth_driver.h.

Function Documentation

◆ lpc546xxEthDisableIrq()

void lpc546xxEthDisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 380 of file lpc546xx_eth_driver.c.

◆ lpc546xxEthEnableIrq()

void lpc546xxEthEnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 366 of file lpc546xx_eth_driver.c.

◆ lpc546xxEthEventHandler()

void lpc546xxEthEventHandler ( NetInterface interface)

LPC546xx Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 446 of file lpc546xx_eth_driver.c.

◆ lpc546xxEthInit()

error_t lpc546xxEthInit ( NetInterface interface)

LPC546xx Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 119 of file lpc546xx_eth_driver.c.

◆ lpc546xxEthInitDmaDesc()

void lpc546xxEthInitDmaDesc ( NetInterface interface)

Initialize DMA descriptor lists.

Parameters
[in]interfaceUnderlying network interface

Definition at line 303 of file lpc546xx_eth_driver.c.

◆ lpc546xxEthInitGpio()

void lpc546xxEthInitGpio ( NetInterface interface)

◆ lpc546xxEthReadPhyReg()

uint16_t lpc546xxEthReadPhyReg ( 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 730 of file lpc546xx_eth_driver.c.

◆ lpc546xxEthReceivePacket()

error_t lpc546xxEthReceivePacket ( NetInterface interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 538 of file lpc546xx_eth_driver.c.

◆ lpc546xxEthSendPacket()

error_t lpc546xxEthSendPacket ( 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 480 of file lpc546xx_eth_driver.c.

◆ lpc546xxEthTick()

void lpc546xxEthTick ( NetInterface interface)

LPC546xx 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 354 of file lpc546xx_eth_driver.c.

◆ lpc546xxEthUpdateMacAddrFilter()

error_t lpc546xxEthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 607 of file lpc546xx_eth_driver.c.

◆ lpc546xxEthUpdateMacConfig()

error_t lpc546xxEthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 653 of file lpc546xx_eth_driver.c.

◆ lpc546xxEthWritePhyReg()

void lpc546xxEthWritePhyReg ( 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 688 of file lpc546xx_eth_driver.c.

Variable Documentation

◆ lpc546xxEthDriver

const NicDriver lpc546xxEthDriver

LPC546xx Ethernet MAC driver.

Definition at line 92 of file lpc546xx_eth_driver.c.