gd32f4xx_eth_driver.h

Go to the documentation of this file.

 
#ifndef _GD32F4XX_ETH_DRIVER_H
#define _GD32F4XX_ETH_DRIVER_H
 
//Dependencies
#include "core/nic.h"
 
//Number of TX buffers
#ifndef GD32F4XX_ETH_TX_BUFFER_COUNT
   #define GD32F4XX_ETH_TX_BUFFER_COUNT 3
#elif (GD32F4XX_ETH_TX_BUFFER_COUNT < 1)
   #error GD32F4XX_ETH_TX_BUFFER_COUNT parameter is not valid
#endif
 
//TX buffer size
#ifndef GD32F4XX_ETH_TX_BUFFER_SIZE
   #define GD32F4XX_ETH_TX_BUFFER_SIZE 1536
#elif (GD32F4XX_ETH_TX_BUFFER_SIZE != 1536)
   #error GD32F4XX_ETH_TX_BUFFER_SIZE parameter is not valid
#endif
 
//Number of RX buffers
#ifndef GD32F4XX_ETH_RX_BUFFER_COUNT
   #define GD32F4XX_ETH_RX_BUFFER_COUNT 6
#elif (GD32F4XX_ETH_RX_BUFFER_COUNT < 1)
   #error GD32F4XX_ETH_RX_BUFFER_COUNT parameter is not valid
#endif
 
//RX buffer size
#ifndef GD32F4XX_ETH_RX_BUFFER_SIZE
   #define GD32F4XX_ETH_RX_BUFFER_SIZE 1536
#elif (GD32F4XX_ETH_RX_BUFFER_SIZE != 1536)
   #error GD32F4XX_ETH_RX_BUFFER_SIZE parameter is not valid
#endif
 
//Interrupt priority grouping
#ifndef GD32F4XX_ETH_IRQ_PRIORITY_GROUPING
   #define GD32F4XX_ETH_IRQ_PRIORITY_GROUPING 3
#elif (GD32F4XX_ETH_IRQ_PRIORITY_GROUPING < 0)
   #error GD32F4XX_ETH_IRQ_PRIORITY_GROUPING parameter is not valid
#endif
 
//Ethernet interrupt group priority
#ifndef GD32F4XX_ETH_IRQ_GROUP_PRIORITY
   #define GD32F4XX_ETH_IRQ_GROUP_PRIORITY 12
#elif (GD32F4XX_ETH_IRQ_GROUP_PRIORITY < 0)
   #error GD32F4XX_ETH_IRQ_GROUP_PRIORITY parameter is not valid
#endif
 
//Ethernet interrupt subpriority
#ifndef GD32F4XX_ETH_IRQ_SUB_PRIORITY
   #define GD32F4XX_ETH_IRQ_SUB_PRIORITY 0
#elif (GD32F4XX_ETH_IRQ_SUB_PRIORITY < 0)
   #error GD32F4XX_ETH_IRQ_SUB_PRIORITY parameter is not valid
#endif
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef struct
{
   uint32_t tdes0;
   uint32_t tdes1;
   uint32_t tdes2;
   uint32_t tdes3;
   uint32_t tdes4;
   uint32_t tdes5;
   uint32_t tdes6;
   uint32_t tdes7;
} Gd32f4xxTxDmaDesc;
 
 
typedef struct
{
   uint32_t rdes0;
   uint32_t rdes1;
   uint32_t rdes2;
   uint32_t rdes3;
   uint32_t rdes4;
   uint32_t rdes5;
   uint32_t rdes6;
   uint32_t rdes7;
} Gd32f4xxRxDmaDesc;
 
 
//GD32F4XX Ethernet MAC driver
extern const NicDriver gd32f4xxEthDriver;
 
//GD32F4XX Ethernet MAC related functions
error_t gd32f4xxEthInit(NetInterface *interface);
void gd32f4xxEthInitGpio(NetInterface *interface);
void gd32f4xxEthInitDmaDesc(NetInterface *interface);
 
void gd32f4xxEthTick(NetInterface *interface);
 
void gd32f4xxEthEnableIrq(NetInterface *interface);
void gd32f4xxEthDisableIrq(NetInterface *interface);
void gd32f4xxEthEventHandler(NetInterface *interface);
 
error_t gd32f4xxEthSendPacket(NetInterface *interface,
   const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary);
 
error_t gd32f4xxEthReceivePacket(NetInterface *interface);
 
error_t gd32f4xxEthUpdateMacAddrFilter(NetInterface *interface);
error_t gd32f4xxEthUpdateMacConfig(NetInterface *interface);
 
void gd32f4xxEthWritePhyReg(uint8_t opcode, uint8_t phyAddr,
   uint8_t regAddr, uint16_t data);
 
uint16_t gd32f4xxEthReadPhyReg(uint8_t opcode, uint8_t phyAddr,
   uint8_t regAddr);
 
uint32_t gd32f4xxEthCalcCrc(const void *data, size_t length);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif