gd32f307_eth_driver.h
Go to the documentation of this file.
1 /**
2  * @file gd32f307_eth_driver.h
3  * @brief GD32F307 Ethernet MAC controller
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2019 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 1.9.6
29  **/
30 
31 #ifndef _GD32F307_ETH_DRIVER_H
32 #define _GD32F307_ETH_DRIVER_H
33 
34 //Dependencies
35 #include "core/nic.h"
36 
37 //Number of TX buffers
38 #ifndef GD32F307_ETH_TX_BUFFER_COUNT
39  #define GD32F307_ETH_TX_BUFFER_COUNT 3
40 #elif (GD32F307_ETH_TX_BUFFER_COUNT < 1)
41  #error GD32F307_ETH_TX_BUFFER_COUNT parameter is not valid
42 #endif
43 
44 //TX buffer size
45 #ifndef GD32F307_ETH_TX_BUFFER_SIZE
46  #define GD32F307_ETH_TX_BUFFER_SIZE 1536
47 #elif (GD32F307_ETH_TX_BUFFER_SIZE != 1536)
48  #error GD32F307_ETH_TX_BUFFER_SIZE parameter is not valid
49 #endif
50 
51 //Number of RX buffers
52 #ifndef GD32F307_ETH_RX_BUFFER_COUNT
53  #define GD32F307_ETH_RX_BUFFER_COUNT 6
54 #elif (GD32F307_ETH_RX_BUFFER_COUNT < 1)
55  #error GD32F307_ETH_RX_BUFFER_COUNT parameter is not valid
56 #endif
57 
58 //RX buffer size
59 #ifndef GD32F307_ETH_RX_BUFFER_SIZE
60  #define GD32F307_ETH_RX_BUFFER_SIZE 1536
61 #elif (GD32F307_ETH_RX_BUFFER_SIZE != 1536)
62  #error GD32F307_ETH_RX_BUFFER_SIZE parameter is not valid
63 #endif
64 
65 //Interrupt priority grouping
66 #ifndef GD32F307_ETH_IRQ_PRIORITY_GROUPING
67  #define GD32F307_ETH_IRQ_PRIORITY_GROUPING 3
68 #elif (GD32F307_ETH_IRQ_PRIORITY_GROUPING < 0)
69  #error GD32F307_ETH_IRQ_PRIORITY_GROUPING parameter is not valid
70 #endif
71 
72 //Ethernet interrupt group priority
73 #ifndef GD32F307_ETH_IRQ_GROUP_PRIORITY
74  #define GD32F307_ETH_IRQ_GROUP_PRIORITY 12
75 #elif (GD32F307_ETH_IRQ_GROUP_PRIORITY < 0)
76  #error GD32F307_ETH_IRQ_GROUP_PRIORITY parameter is not valid
77 #endif
78 
79 //Ethernet interrupt subpriority
80 #ifndef GD32F307_ETH_IRQ_SUB_PRIORITY
81  #define GD32F307_ETH_IRQ_SUB_PRIORITY 0
82 #elif (GD32F307_ETH_IRQ_SUB_PRIORITY < 0)
83  #error GD32F307_ETH_IRQ_SUB_PRIORITY parameter is not valid
84 #endif
85 
86 //C++ guard
87 #ifdef __cplusplus
88 extern "C" {
89 #endif
90 
91 
92 /**
93  * @brief Enhanced TX DMA descriptor
94  **/
95 
96 typedef struct
97 {
98  uint32_t tdes0;
99  uint32_t tdes1;
100  uint32_t tdes2;
101  uint32_t tdes3;
102  uint32_t tdes4;
103  uint32_t tdes5;
104  uint32_t tdes6;
105  uint32_t tdes7;
107 
108 
109 /**
110  * @brief Enhanced RX DMA descriptor
111  **/
112 
113 typedef struct
114 {
115  uint32_t rdes0;
116  uint32_t rdes1;
117  uint32_t rdes2;
118  uint32_t rdes3;
119  uint32_t rdes4;
120  uint32_t rdes5;
121  uint32_t rdes6;
122  uint32_t rdes7;
124 
125 
126 //GD32F307 Ethernet MAC driver
127 extern const NicDriver gd32f307EthDriver;
128 
129 //GD32F307 Ethernet MAC related functions
131 void gd32f307EthInitGpio(NetInterface *interface);
132 void gd32f307EthInitDmaDesc(NetInterface *interface);
133 
134 void gd32f307EthTick(NetInterface *interface);
135 
136 void gd32f307EthEnableIrq(NetInterface *interface);
137 void gd32f307EthDisableIrq(NetInterface *interface);
138 void gd32f307EthEventHandler(NetInterface *interface);
139 
141  const NetBuffer *buffer, size_t offset);
142 
144 
147 
148 void gd32f307EthWritePhyReg(uint8_t opcode, uint8_t phyAddr,
149  uint8_t regAddr, uint16_t data);
150 
151 uint16_t gd32f307EthReadPhyReg(uint8_t opcode, uint8_t phyAddr,
152  uint8_t regAddr);
153 
154 uint32_t gd32f307EthCalcCrc(const void *data, size_t length);
155 
156 //C++ guard
157 #ifdef __cplusplus
158 }
159 #endif
160 
161 #endif
void gd32f307EthWritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
uint8_t length
Definition: dtls_misc.h:149
uint8_t opcode
Definition: dns_common.h:172
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:88
error_t gd32f307EthInit(NetInterface *interface)
GD32F307 Ethernet MAC initialization.
error_t gd32f307EthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
error_t gd32f307EthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
error_t
Error codes.
Definition: error.h:42
#define NetInterface
Definition: net.h:36
void gd32f307EthTick(NetInterface *interface)
GD32F307 Ethernet MAC timer handler.
uint16_t gd32f307EthReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
error_t gd32f307EthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset)
Send a packet.
Enhanced TX DMA descriptor.
uint16_t regAddr
void gd32f307EthEventHandler(NetInterface *interface)
GD32F307 Ethernet MAC event handler.
uint32_t gd32f307EthCalcCrc(const void *data, size_t length)
CRC calculation.
Network interface controller abstraction layer.
void gd32f307EthInitDmaDesc(NetInterface *interface)
Initialize DMA descriptor lists.
void gd32f307EthEnableIrq(NetInterface *interface)
Enable interrupts.
Enhanced RX DMA descriptor.
uint8_t data[]
Definition: dtls_misc.h:176
void gd32f307EthDisableIrq(NetInterface *interface)
Disable interrupts.
NIC driver.
Definition: nic.h:179
error_t gd32f307EthReceivePacket(NetInterface *interface)
Receive a packet.
const NicDriver gd32f307EthDriver
GD32F307 Ethernet MAC driver.
void gd32f307EthInitGpio(NetInterface *interface)