samv71_eth_driver.h
Go to the documentation of this file.
1 /**
2  * @file samv71_eth_driver.h
3  * @brief SAMV71 Ethernet MAC driver
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2021 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 2.0.2
29  **/
30 
31 #ifndef _SAMV71_ETH_DRIVER_H
32 #define _SAMV71_ETH_DRIVER_H
33 
34 //Number of TX buffers
35 #ifndef SAMV71_ETH_TX_BUFFER_COUNT
36  #define SAMV71_ETH_TX_BUFFER_COUNT 4
37 #elif (SAMV71_ETH_TX_BUFFER_COUNT < 1)
38  #error SAMV71_ETH_TX_BUFFER_COUNT parameter is not valid
39 #endif
40 
41 //TX buffer size
42 #ifndef SAMV71_ETH_TX_BUFFER_SIZE
43  #define SAMV71_ETH_TX_BUFFER_SIZE 1536
44 #elif (SAMV71_ETH_TX_BUFFER_SIZE != 1536)
45  #error SAMV71_ETH_TX_BUFFER_SIZE parameter is not valid
46 #endif
47 
48 //Number of RX buffers
49 #ifndef SAMV71_ETH_RX_BUFFER_COUNT
50  #define SAMV71_ETH_RX_BUFFER_COUNT 96
51 #elif (SAMV71_ETH_RX_BUFFER_COUNT < 12)
52  #error SAMV71_ETH_RX_BUFFER_COUNT parameter is not valid
53 #endif
54 
55 //RX buffer size
56 #ifndef SAMV71_ETH_RX_BUFFER_SIZE
57  #define SAMV71_ETH_RX_BUFFER_SIZE 128
58 #elif (SAMV71_ETH_RX_BUFFER_SIZE != 128)
59  #error SAMV71_ETH_RX_BUFFER_SIZE parameter is not valid
60 #endif
61 
62 //Number of dummy buffers
63 #ifndef SAMV71_ETH_DUMMY_BUFFER_COUNT
64  #define SAMV71_ETH_DUMMY_BUFFER_COUNT 2
65 #elif (SAMV71_ETH_DUMMY_BUFFER_COUNT < 1)
66  #error SAMV71_ETH_DUMMY_BUFFER_COUNT parameter is not valid
67 #endif
68 
69 //Dummy buffer size
70 #ifndef SAMV71_ETH_DUMMY_BUFFER_SIZE
71  #define SAMV71_ETH_DUMMY_BUFFER_SIZE 128
72 #elif (SAMV71_ETH_DUMMY_BUFFER_SIZE != 128)
73  #error SAMV71_ETH_DUMMY_BUFFER_SIZE parameter is not valid
74 #endif
75 
76 //Interrupt priority grouping
77 #ifndef SAMV71_ETH_IRQ_PRIORITY_GROUPING
78  #define SAMV71_ETH_IRQ_PRIORITY_GROUPING 4
79 #elif (SAMV71_ETH_IRQ_PRIORITY_GROUPING < 0)
80  #error SAMV71_ETH_IRQ_PRIORITY_GROUPING parameter is not valid
81 #endif
82 
83 //Ethernet interrupt group priority
84 #ifndef SAMV71_ETH_IRQ_GROUP_PRIORITY
85  #define SAMV71_ETH_IRQ_GROUP_PRIORITY 6
86 #elif (SAMV71_ETH_IRQ_GROUP_PRIORITY < 0)
87  #error SAMV71_ETH_IRQ_GROUP_PRIORITY parameter is not valid
88 #endif
89 
90 //Ethernet interrupt subpriority
91 #ifndef SAMV71_ETH_IRQ_SUB_PRIORITY
92  #define SAMV71_ETH_IRQ_SUB_PRIORITY 0
93 #elif (SAMV71_ETH_IRQ_SUB_PRIORITY < 0)
94  #error SAMV71_ETH_IRQ_SUB_PRIORITY parameter is not valid
95 #endif
96 
97 //Name of the section where to place DMA buffers
98 #ifndef SAMV71_ETH_RAM_SECTION
99  #define SAMV71_ETH_RAM_SECTION ".ram_no_cache"
100 #endif
101 
102 //Backward compatibility
103 #ifndef PIO_PD9A_GMDIO
104  #define PIO_PD9A_GMDIO PIO_PD9A_GMAC_GMDIO
105  #define PIO_PD8A_GMDC PIO_PD8A_GMAC_GMDC
106  #define PIO_PD7A_GRXER PIO_PD7A_GMAC_GRXER
107  #define PIO_PD6A_GRX1 PIO_PD6A_GMAC_GRX1
108  #define PIO_PD5A_GRX0 PIO_PD5A_GMAC_GRX0
109  #define PIO_PD4A_GRXDV PIO_PD4A_GMAC_GRXDV
110  #define PIO_PD3A_GTX1 PIO_PD3A_GMAC_GTX1
111  #define PIO_PD2A_GTX0 PIO_PD2A_GMAC_GTX0
112  #define PIO_PD1A_GTXEN PIO_PD1A_GMAC_GTXEN
113  #define PIO_PD0A_GTXCK PIO_PD0A_GMAC_GTXCK
114  #define GMAC_SA GmacSa
115 #endif
116 
117 //RMII signals
118 #define GMAC_RMII_MASK (PIO_PD9A_GMDIO | PIO_PD8A_GMDC | \
119  PIO_PD7A_GRXER | PIO_PD6A_GRX1 | PIO_PD5A_GRX0 | PIO_PD4A_GRXDV | \
120  PIO_PD3A_GTX1 | PIO_PD2A_GTX0 | PIO_PD1A_GTXEN | PIO_PD0A_GTXCK)
121 
122 //TX buffer descriptor flags
123 #define GMAC_TX_USED 0x80000000
124 #define GMAC_TX_WRAP 0x40000000
125 #define GMAC_TX_RLE_ERROR 0x20000000
126 #define GMAC_TX_UNDERRUN_ERROR 0x10000000
127 #define GMAC_TX_AHB_ERROR 0x08000000
128 #define GMAC_TX_LATE_COL_ERROR 0x04000000
129 #define GMAC_TX_CHECKSUM_ERROR 0x00700000
130 #define GMAC_TX_NO_CRC 0x00010000
131 #define GMAC_TX_LAST 0x00008000
132 #define GMAC_TX_LENGTH 0x00003FFF
133 
134 //RX buffer descriptor flags
135 #define GMAC_RX_ADDRESS 0xFFFFFFFC
136 #define GMAC_RX_WRAP 0x00000002
137 #define GMAC_RX_OWNERSHIP 0x00000001
138 #define GMAC_RX_BROADCAST 0x80000000
139 #define GMAC_RX_MULTICAST_HASH 0x40000000
140 #define GMAC_RX_UNICAST_HASH 0x20000000
141 #define GMAC_RX_SAR 0x08000000
142 #define GMAC_RX_SAR_MASK 0x06000000
143 #define GMAC_RX_TYPE_ID 0x01000000
144 #define GMAC_RX_SNAP 0x01000000
145 #define GMAC_RX_TYPE_ID_MASK 0x00C00000
146 #define GMAC_RX_CHECKSUM_VALID 0x00C00000
147 #define GMAC_RX_VLAN_TAG 0x00200000
148 #define GMAC_RX_PRIORITY_TAG 0x00100000
149 #define GMAC_RX_VLAN_PRIORITY 0x000E0000
150 #define GMAC_RX_CFI 0x00010000
151 #define GMAC_RX_EOF 0x00008000
152 #define GMAC_RX_SOF 0x00004000
153 #define GMAC_RX_LENGTH_MSB 0x00002000
154 #define GMAC_RX_BAD_FCS 0x00002000
155 #define GMAC_RX_LENGTH 0x00001FFF
156 
157 //C++ guard
158 #ifdef __cplusplus
159 extern "C" {
160 #endif
161 
162 
163 /**
164  * @brief Transmit buffer descriptor
165  **/
166 
167 typedef struct
168 {
169  uint32_t address;
170  uint32_t status;
172 
173 
174 /**
175  * @brief Receive buffer descriptor
176  **/
177 
178 typedef struct
179 {
180  uint32_t address;
181  uint32_t status;
183 
184 
185 //SAMV71 Ethernet MAC driver
186 extern const NicDriver samv71EthDriver;
187 
188 //SAMV71 Ethernet MAC related functions
191 void samv71EthInitBufferDesc(NetInterface *interface);
192 
193 void samv71EthTick(NetInterface *interface);
194 
195 void samv71EthEnableIrq(NetInterface *interface);
196 void samv71EthDisableIrq(NetInterface *interface);
197 void samv71EthEventHandler(NetInterface *interface);
198 
200  const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary);
201 
203 
206 
207 void samv71EthWritePhyReg(uint8_t opcode, uint8_t phyAddr,
208  uint8_t regAddr, uint16_t data);
209 
210 uint16_t samv71EthReadPhyReg(uint8_t opcode, uint8_t phyAddr,
211  uint8_t regAddr);
212 
213 //C++ guard
214 #ifdef __cplusplus
215 }
216 #endif
217 
218 #endif
uint8_t opcode
Definition: dns_common.h:172
uint8_t data[]
Definition: ethernet.h:210
void samv71EthInitBufferDesc(NetInterface *interface)
Initialize buffer descriptors.
error_t samv71EthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:89
error_t samv71EthReceivePacket(NetInterface *interface)
Receive a packet.
void samv71EthInitGpio(NetInterface *interface)
error_t samv71EthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
const NicDriver samv71EthDriver
SAMV71 Ethernet MAC driver.
error_t
Error codes.
Definition: error.h:43
void samv71EthDisableIrq(NetInterface *interface)
Disable interrupts.
#define NetInterface
Definition: net.h:36
Transmit buffer descriptor.
#define NetTxAncillary
Definition: net_misc.h:36
Receive buffer descriptor.
void samv71EthTick(NetInterface *interface)
SAMV71 Ethernet MAC timer handler.
void samv71EthEnableIrq(NetInterface *interface)
Enable interrupts.
uint16_t regAddr
void samv71EthWritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
uint16_t samv71EthReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
void samv71EthEventHandler(NetInterface *interface)
SAMV71 Ethernet MAC event handler.
error_t samv71EthInit(NetInterface *interface)
SAMV71 Ethernet MAC initialization.
NIC driver.
Definition: nic.h:258
error_t samv71EthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.