Macros | Functions | Variables
gd32f3xx_eth_driver.c File Reference

GigaDevice GD32F3 Ethernet MAC driver. More...

#include "gd32f30x.h"
#include "core/net.h"
#include "drivers/mac/gd32f3xx_eth_driver.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t gd32f3xxEthInit (NetInterface *interface)
 GD32F3XX Ethernet MAC initialization. More...
 
__weak_func void gd32f3xxEthInitGpio (NetInterface *interface)
 GPIO configuration. More...
 
void gd32f3xxEthInitDmaDesc (NetInterface *interface)
 Initialize DMA descriptor lists. More...
 
void gd32f3xxEthTick (NetInterface *interface)
 GD32F3XX Ethernet MAC timer handler. More...
 
void gd32f3xxEthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void gd32f3xxEthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void ENET_IRQHandler (void)
 GD32F3XX Ethernet MAC interrupt service routine. More...
 
void gd32f3xxEthEventHandler (NetInterface *interface)
 GD32F3XX Ethernet MAC event handler. More...
 
error_t gd32f3xxEthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
 
error_t gd32f3xxEthReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t gd32f3xxEthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t gd32f3xxEthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void gd32f3xxEthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t gd32f3xxEthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 
uint32_t gd32f3xxEthCalcCrc (const void *data, size_t length)
 CRC calculation. More...
 

Variables

const NicDriver gd32f3xxEthDriver
 GD32F3XX Ethernet MAC driver. More...
 

Detailed Description

GigaDevice GD32F3 Ethernet MAC driver.

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.4

Definition in file gd32f3xx_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file gd32f3xx_eth_driver.c.

Function Documentation

◆ ENET_IRQHandler()

void ENET_IRQHandler ( void  )

GD32F3XX Ethernet MAC interrupt service routine.

Definition at line 444 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthCalcCrc()

uint32_t gd32f3xxEthCalcCrc ( const void *  data,
size_t  length 
)

CRC calculation.

Parameters
[in]dataPointer to the data over which to calculate the CRC
[in]lengthNumber of bytes to process
Returns
Resulting CRC value

Definition at line 904 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthDisableIrq()

void gd32f3xxEthDisableIrq ( NetInterface *  interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 417 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthEnableIrq()

void gd32f3xxEthEnableIrq ( NetInterface *  interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 389 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthEventHandler()

void gd32f3xxEthEventHandler ( NetInterface *  interface)

GD32F3XX Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 497 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthInit()

error_t gd32f3xxEthInit ( NetInterface *  interface)

GD32F3XX Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 114 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthInitDmaDesc()

void gd32f3xxEthInitDmaDesc ( NetInterface *  interface)

Initialize DMA descriptor lists.

Parameters
[in]interfaceUnderlying network interface

Definition at line 295 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthInitGpio()

__weak_func void gd32f3xxEthInitGpio ( NetInterface *  interface)

GPIO configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 242 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthReadPhyReg()

uint16_t gd32f3xxEthReadPhyReg ( 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 858 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthReceivePacket()

error_t gd32f3xxEthReceivePacket ( NetInterface *  interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 581 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthSendPacket()

error_t gd32f3xxEthSendPacket ( 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 522 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthTick()

void gd32f3xxEthTick ( NetInterface *  interface)

GD32F3XX 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 364 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthUpdateMacAddrFilter()

error_t gd32f3xxEthUpdateMacAddrFilter ( NetInterface *  interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 651 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthUpdateMacConfig()

error_t gd32f3xxEthUpdateMacConfig ( NetInterface *  interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 773 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthWritePhyReg()

void gd32f3xxEthWritePhyReg ( 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 816 of file gd32f3xx_eth_driver.c.

Variable Documentation

◆ gd32f3xxEthDriver

const NicDriver gd32f3xxEthDriver
Initial value:
=
{
NIC_TYPE_ETHERNET,
ETH_MTU,
gd32f3xxEthInit,
gd32f3xxEthTick,
gd32f3xxEthEnableIrq,
gd32f3xxEthDisableIrq,
gd32f3xxEthEventHandler,
gd32f3xxEthSendPacket,
gd32f3xxEthUpdateMacAddrFilter,
gd32f3xxEthUpdateMacConfig,
gd32f3xxEthWritePhyReg,
gd32f3xxEthReadPhyReg,
TRUE,
TRUE,
TRUE,
FALSE
}

GD32F3XX Ethernet MAC driver.

Definition at line 87 of file gd32f3xx_eth_driver.c.

gd32f3xxEthUpdateMacAddrFilter
error_t gd32f3xxEthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
Definition: gd32f3xx_eth_driver.c:651
TRUE
#define TRUE
Definition: os_port.h:50
gd32f3xxEthUpdateMacConfig
error_t gd32f3xxEthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
Definition: gd32f3xx_eth_driver.c:773
gd32f3xxEthTick
void gd32f3xxEthTick(NetInterface *interface)
GD32F3XX Ethernet MAC timer handler.
Definition: gd32f3xx_eth_driver.c:364
gd32f3xxEthInit
error_t gd32f3xxEthInit(NetInterface *interface)
GD32F3XX Ethernet MAC initialization.
Definition: gd32f3xx_eth_driver.c:114
FALSE
#define FALSE
Definition: os_port.h:46
gd32f3xxEthDisableIrq
void gd32f3xxEthDisableIrq(NetInterface *interface)
Disable interrupts.
Definition: gd32f3xx_eth_driver.c:417
gd32f3xxEthReadPhyReg
uint16_t gd32f3xxEthReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
Definition: gd32f3xx_eth_driver.c:858
gd32f3xxEthEnableIrq
void gd32f3xxEthEnableIrq(NetInterface *interface)
Enable interrupts.
Definition: gd32f3xx_eth_driver.c:389
gd32f3xxEthWritePhyReg
void gd32f3xxEthWritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
Definition: gd32f3xx_eth_driver.c:816
ETH_MTU
#define ETH_MTU
Definition: ethernet.h:116
gd32f3xxEthSendPacket
error_t gd32f3xxEthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
Definition: gd32f3xx_eth_driver.c:522
gd32f3xxEthEventHandler
void gd32f3xxEthEventHandler(NetInterface *interface)
GD32F3XX Ethernet MAC event handler.
Definition: gd32f3xx_eth_driver.c:497
NIC_TYPE_ETHERNET
@ NIC_TYPE_ETHERNET
Ethernet interface.
Definition: nic.h:83