efm32gg11_eth_driver.h
Go to the documentation of this file.
1 /**
2  * @file efm32gg11_eth_driver.h
3  * @brief EFM32 Giant Gecko 11 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.2
29  **/
30 
31 #ifndef _EFM32GG11_ETH_DRIVER_H
32 #define _EFM32GG11_ETH_DRIVER_H
33 
34 //Number of TX buffers
35 #ifndef EFM32GG11_ETH_TX_BUFFER_COUNT
36  #define EFM32GG11_ETH_TX_BUFFER_COUNT 2
37 #elif (EFM32GG11_ETH_TX_BUFFER_COUNT < 1)
38  #error EFM32GG11_ETH_TX_BUFFER_COUNT parameter is not valid
39 #endif
40 
41 //TX buffer size
42 #ifndef EFM32GG11_ETH_TX_BUFFER_SIZE
43  #define EFM32GG11_ETH_TX_BUFFER_SIZE 1536
44 #elif (EFM32GG11_ETH_TX_BUFFER_SIZE != 1536)
45  #error EFM32GG11_ETH_TX_BUFFER_SIZE parameter is not valid
46 #endif
47 
48 //Number of RX buffers
49 #ifndef EFM32GG11_ETH_RX_BUFFER_COUNT
50  #define EFM32GG11_ETH_RX_BUFFER_COUNT 48
51 #elif (EFM32GG11_ETH_RX_BUFFER_COUNT < 12)
52  #error EFM32GG11_ETH_RX_BUFFER_COUNT parameter is not valid
53 #endif
54 
55 //RX buffer size
56 #ifndef EFM32GG11_ETH_RX_BUFFER_SIZE
57  #define EFM32GG11_ETH_RX_BUFFER_SIZE 128
58 #elif (EFM32GG11_ETH_RX_BUFFER_SIZE != 128)
59  #error EFM32GG11_ETH_RX_BUFFER_SIZE parameter is not valid
60 #endif
61 
62 //Interrupt priority grouping
63 #ifndef EFM32GG11_ETH_IRQ_PRIORITY_GROUPING
64  #define EFM32GG11_ETH_IRQ_PRIORITY_GROUPING 4
65 #elif (EFM32GG11_ETH_IRQ_PRIORITY_GROUPING < 0)
66  #error EFM32GG11_ETH_IRQ_PRIORITY_GROUPING parameter is not valid
67 #endif
68 
69 //Ethernet interrupt group priority
70 #ifndef EFM32GG11_ETH_IRQ_GROUP_PRIORITY
71  #define EFM32GG11_ETH_IRQ_GROUP_PRIORITY 6
72 #elif (EFM32GG11_ETH_IRQ_GROUP_PRIORITY < 0)
73  #error EFM32GG11_ETH_IRQ_GROUP_PRIORITY parameter is not valid
74 #endif
75 
76 //Ethernet interrupt subpriority
77 #ifndef EFM32GG11_ETH_IRQ_SUB_PRIORITY
78  #define EFM32GG11_ETH_IRQ_SUB_PRIORITY 0
79 #elif (EFM32GG11_ETH_IRQ_SUB_PRIORITY < 0)
80  #error EFM32GG11_ETH_IRQ_SUB_PRIORITY parameter is not valid
81 #endif
82 
83 //TX buffer descriptor flags
84 #define ETH_TX_USED 0x80000000
85 #define ETH_TX_WRAP 0x40000000
86 #define ETH_TX_ERROR 0x20000000
87 #define ETH_TX_UNDERRUN 0x10000000
88 #define ETH_TX_EXHAUSTED 0x08000000
89 #define ETH_TX_NO_CRC 0x00010000
90 #define ETH_TX_LAST 0x00008000
91 #define ETH_TX_LENGTH 0x000007FF
92 
93 //RX buffer descriptor flags
94 #define ETH_RX_ADDRESS 0xFFFFFFFC
95 #define ETH_RX_WRAP 0x00000002
96 #define ETH_RX_OWNERSHIP 0x00000001
97 #define ETH_RX_BROADCAST 0x80000000
98 #define ETH_RX_MULTICAST_HASH 0x40000000
99 #define ETH_RX_UNICAST_HASH 0x20000000
100 #define ETH_RX_EXT_ADDR 0x10000000
101 #define ETH_RX_SAR1 0x04000000
102 #define ETH_RX_SAR2 0x02000000
103 #define ETH_RX_SAR3 0x01000000
104 #define ETH_RX_SAR4 0x00800000
105 #define ETH_RX_TYPE_ID 0x00400000
106 #define ETH_RX_VLAN_TAG 0x00200000
107 #define ETH_RX_PRIORITY_TAG 0x00100000
108 #define ETH_RX_VLAN_PRIORITY 0x000E0000
109 #define ETH_RX_CFI 0x00010000
110 #define ETH_RX_EOF 0x00008000
111 #define ETH_RX_SOF 0x00004000
112 #define ETH_RX_OFFSET 0x00003000
113 #define ETH_RX_LENGTH 0x00000FFF
114 
115 //C++ guard
116 #ifdef __cplusplus
117  extern "C" {
118 #endif
119 
120 
121 /**
122  * @brief Transmit buffer descriptor
123  **/
124 
125 typedef struct
126 {
127  uint32_t address;
128  uint32_t status;
130 
131 
132 /**
133  * @brief Receive buffer descriptor
134  **/
135 
136 typedef struct
137 {
138  uint32_t address;
139  uint32_t status;
141 
142 
143 //EFM32GG11 Ethernet MAC driver
144 extern const NicDriver efm32gg11EthDriver;
145 
146 //EFM32GG11 Ethernet MAC related functions
148 void efm32gg11EthInitGpio(NetInterface *interface);
150 
151 void efm32gg11EthTick(NetInterface *interface);
152 
153 void efm32gg11EthEnableIrq(NetInterface *interface);
154 void efm32gg11EthDisableIrq(NetInterface *interface);
155 void efm32gg11EthEventHandler(NetInterface *interface);
156 
158  const NetBuffer *buffer, size_t offset);
159 
161 
164 
165 void efm32gg11EthWritePhyReg(uint8_t phyAddr, uint8_t regAddr, uint16_t data);
166 uint16_t efm32gg11EthReadPhyReg(uint8_t phyAddr, uint8_t regAddr);
167 
168 //C++ guard
169 #ifdef __cplusplus
170  }
171 #endif
172 
173 #endif
void efm32gg11EthEnableIrq(NetInterface *interface)
Enable interrupts.
error_t efm32gg11EthInit(NetInterface *interface)
EFM32GG11 Ethernet MAC initialization.
uint16_t efm32gg11EthReadPhyReg(uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
error_t efm32gg11EthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
error_t efm32gg11EthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset)
Send a packet.
Transmit buffer descriptor.
void efm32gg11EthInitGpio(NetInterface *interface)
NIC driver.
Definition: nic.h:164
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:88
Receive buffer descriptor.
uint16_t regAddr
const NicDriver efm32gg11EthDriver
EFM32GG11 Ethernet MAC driver.
error_t
Error codes.
Definition: error.h:42
uint8_t data[]
Definition: dtls_misc.h:169
#define NetInterface
Definition: net.h:36
void efm32gg11EthDisableIrq(NetInterface *interface)
Disable interrupts.
error_t efm32gg11EthReceivePacket(NetInterface *interface)
Receive a packet.
void efm32gg11EthTick(NetInterface *interface)
EFM32GG11 Ethernet MAC timer handler.
void efm32gg11EthWritePhyReg(uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
error_t efm32gg11EthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
void efm32gg11EthEventHandler(NetInterface *interface)
EFM32GG11 Ethernet MAC event handler.
void efm32gg11EthInitBufferDesc(NetInterface *interface)
Initialize buffer descriptors.