GigaDevice GD32F3 Ethernet MAC driver. More...

#include "core/nic.h"

Data Structures
struct	Gd32f3xxTxDmaDesc
	Enhanced TX DMA descriptor. More...

struct	Gd32f3xxRxDmaDesc
	Enhanced RX DMA descriptor. More...

Macros
#define	GD32F3XX_ETH_TX_BUFFER_COUNT 3

#define	GD32F3XX_ETH_TX_BUFFER_SIZE 1536

#define	GD32F3XX_ETH_RX_BUFFER_COUNT 6

#define	GD32F3XX_ETH_RX_BUFFER_SIZE 1536

#define	GD32F3XX_ETH_IRQ_PRIORITY_GROUPING 3

#define	GD32F3XX_ETH_IRQ_GROUP_PRIORITY 12

#define	GD32F3XX_ETH_IRQ_SUB_PRIORITY 0

Functions
error_t	gd32f3xxEthInit (NetInterface *interface)
	GD32F3XX Ethernet MAC initialization. More...

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

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 gd32f3xx_eth_driver.h.

Macro Definition Documentation

◆ GD32F3XX_ETH_IRQ_GROUP_PRIORITY

#define GD32F3XX_ETH_IRQ_GROUP_PRIORITY 12

Definition at line 74 of file gd32f3xx_eth_driver.h.

◆ GD32F3XX_ETH_IRQ_PRIORITY_GROUPING

#define GD32F3XX_ETH_IRQ_PRIORITY_GROUPING 3

Definition at line 67 of file gd32f3xx_eth_driver.h.

◆ GD32F3XX_ETH_IRQ_SUB_PRIORITY

#define GD32F3XX_ETH_IRQ_SUB_PRIORITY 0

Definition at line 81 of file gd32f3xx_eth_driver.h.

◆ GD32F3XX_ETH_RX_BUFFER_COUNT

#define GD32F3XX_ETH_RX_BUFFER_COUNT 6

Definition at line 53 of file gd32f3xx_eth_driver.h.

◆ GD32F3XX_ETH_RX_BUFFER_SIZE

#define GD32F3XX_ETH_RX_BUFFER_SIZE 1536

Definition at line 60 of file gd32f3xx_eth_driver.h.

◆ GD32F3XX_ETH_TX_BUFFER_COUNT

#define GD32F3XX_ETH_TX_BUFFER_COUNT 3

Definition at line 39 of file gd32f3xx_eth_driver.h.

◆ GD32F3XX_ETH_TX_BUFFER_SIZE

#define GD32F3XX_ETH_TX_BUFFER_SIZE 1536

Definition at line 46 of file gd32f3xx_eth_driver.h.

Function Documentation

◆ gd32f3xxEthCalcCrc()

uint32_t gd32f3xxEthCalcCrc	(	const void *	data,
		size_t	length
	)

CRC calculation.

Parameters

[in]	data	Pointer to the data over which to calculate the CRC
[in]	length	Number 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] interface Underlying network interface

Definition at line 417 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthEnableIrq()

void gd32f3xxEthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 389 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthEventHandler()

void gd32f3xxEthEventHandler ( NetInterface * interface )

GD32F3XX Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 497 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthInit()

error_t gd32f3xxEthInit ( NetInterface * interface )

GD32F3XX Ethernet MAC initialization.

Parameters

[in] interface Underlying 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] interface Underlying network interface

Definition at line 295 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthInitGpio()

void gd32f3xxEthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying 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]	opcode	Access type (2 bits)
[in]	phyAddr	PHY address (5 bits)
[in]	regAddr	Register 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] interface Underlying 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]	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 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] interface Underlying network interface

Definition at line 364 of file gd32f3xx_eth_driver.c.

◆ gd32f3xxEthUpdateMacAddrFilter()

error_t gd32f3xxEthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying 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] interface Underlying 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]	opcode	Access type (2 bits)
[in]	phyAddr	PHY address (5 bits)
[in]	regAddr	Register address (5 bits)
[in]	data	Register value

Definition at line 816 of file gd32f3xx_eth_driver.c.

Variable Documentation

◆ gd32f3xxEthDriver

const NicDriver gd32f3xxEthDriver

extern

GD32F3XX Ethernet MAC driver.

Definition at line 87 of file gd32f3xx_eth_driver.c.

Data Structures

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ GD32F3XX_ETH_IRQ_GROUP_PRIORITY

◆ GD32F3XX_ETH_IRQ_PRIORITY_GROUPING

◆ GD32F3XX_ETH_IRQ_SUB_PRIORITY

◆ GD32F3XX_ETH_RX_BUFFER_COUNT

◆ GD32F3XX_ETH_RX_BUFFER_SIZE

◆ GD32F3XX_ETH_TX_BUFFER_COUNT

◆ GD32F3XX_ETH_TX_BUFFER_SIZE

Function Documentation

◆ gd32f3xxEthCalcCrc()

◆ gd32f3xxEthDisableIrq()

◆ gd32f3xxEthEnableIrq()

◆ gd32f3xxEthEventHandler()

◆ gd32f3xxEthInit()

◆ gd32f3xxEthInitDmaDesc()

◆ gd32f3xxEthInitGpio()

◆ gd32f3xxEthReadPhyReg()

◆ gd32f3xxEthReceivePacket()

◆ gd32f3xxEthSendPacket()

◆ gd32f3xxEthTick()

◆ gd32f3xxEthUpdateMacAddrFilter()

◆ gd32f3xxEthUpdateMacConfig()

◆ gd32f3xxEthWritePhyReg()

Variable Documentation

◆ gd32f3xxEthDriver