sama5d3_eth_driver.h
Go to the documentation of this file.
1 /**
2  * @file sama5d3_eth_driver.h
3  * @brief SAMA5D3 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 _SAMA5D3_ETH_DRIVER_H
32 #define _SAMA5D3_ETH_DRIVER_H
33 
34 //Number of TX buffers
35 #ifndef SAMA5D3_ETH_TX_BUFFER_COUNT
36  #define SAMA5D3_ETH_TX_BUFFER_COUNT 4
37 #elif (SAMA5D3_ETH_TX_BUFFER_COUNT < 1)
38  #error SAMA5D3_ETH_TX_BUFFER_COUNT parameter is not valid
39 #endif
40 
41 //TX buffer size
42 #ifndef SAMA5D3_ETH_TX_BUFFER_SIZE
43  #define SAMA5D3_ETH_TX_BUFFER_SIZE 1536
44 #elif (SAMA5D3_ETH_TX_BUFFER_SIZE != 1536)
45  #error SAMA5D3_ETH_TX_BUFFER_SIZE parameter is not valid
46 #endif
47 
48 //Number of RX buffers
49 #ifndef SAMA5D3_ETH_RX_BUFFER_COUNT
50  #define SAMA5D3_ETH_RX_BUFFER_COUNT 96
51 #elif (SAMA5D3_ETH_RX_BUFFER_COUNT < 12)
52  #error SAMA5D3_ETH_RX_BUFFER_COUNT parameter is not valid
53 #endif
54 
55 //RX buffer size
56 #ifndef SAMA5D3_ETH_RX_BUFFER_SIZE
57  #define SAMA5D3_ETH_RX_BUFFER_SIZE 128
58 #elif (SAMA5D3_ETH_RX_BUFFER_SIZE != 128)
59  #error SAMA5D3_ETH_RX_BUFFER_SIZE parameter is not valid
60 #endif
61 
62 //Ethernet interrupt priority
63 #ifndef SAMA5D3_ETH_IRQ_PRIORITY
64  #define SAMA5D3_ETH_IRQ_PRIORITY 0
65 #elif (SAMA5D3_ETH_IRQ_PRIORITY < 0)
66  #error SAMA5D3_ETH_IRQ_PRIORITY parameter is not valid
67 #endif
68 
69 //RMII signals
70 #define EMAC_RMII_MASK (PIO_PC9A_EMDIO | PIO_PC8A_EMDC | \
71  PIO_PC7A_EREFCK | PIO_PC6A_ERXER | PIO_PC5A_ECRSDV | PIO_PC4A_ETXEN | \
72  PIO_PC3A_ERX1 | PIO_PC2A_ERX0 | PIO_PC1A_ETX1 | PIO_PC0A_ETX0)
73 
74 //TX buffer descriptor flags
75 #define EMAC_TX_USED 0x80000000
76 #define EMAC_TX_WRAP 0x40000000
77 #define EMAC_TX_ERROR 0x20000000
78 #define EMAC_TX_UNDERRUN 0x10000000
79 #define EMAC_TX_EXHAUSTED 0x08000000
80 #define EMAC_TX_NO_CRC 0x00010000
81 #define EMAC_TX_LAST 0x00008000
82 #define EMAC_TX_LENGTH 0x000007FF
83 
84 //RX buffer descriptor flags
85 #define EMAC_RX_ADDRESS 0xFFFFFFFC
86 #define EMAC_RX_WRAP 0x00000002
87 #define EMAC_RX_OWNERSHIP 0x00000001
88 #define EMAC_RX_BROADCAST 0x80000000
89 #define EMAC_RX_MULTICAST_HASH 0x40000000
90 #define EMAC_RX_UNICAST_HASH 0x20000000
91 #define EMAC_RX_EXT_ADDR 0x10000000
92 #define EMAC_RX_SAR1 0x04000000
93 #define EMAC_RX_SAR2 0x02000000
94 #define EMAC_RX_SAR3 0x01000000
95 #define EMAC_RX_SAR4 0x00800000
96 #define EMAC_RX_TYPE_ID 0x00400000
97 #define EMAC_RX_VLAN_TAG 0x00200000
98 #define EMAC_RX_PRIORITY_TAG 0x00100000
99 #define EMAC_RX_VLAN_PRIORITY 0x000E0000
100 #define EMAC_RX_CFI 0x00010000
101 #define EMAC_RX_EOF 0x00008000
102 #define EMAC_RX_SOF 0x00004000
103 #define EMAC_RX_OFFSET 0x00003000
104 #define EMAC_RX_LENGTH 0x00000FFF
105 
106 //C++ guard
107 #ifdef __cplusplus
108 extern "C" {
109 #endif
110 
111 
112 /**
113  * @brief Transmit buffer descriptor
114  **/
115 
116 typedef struct
117 {
118  uint32_t address;
119  uint32_t status;
121 
122 
123 /**
124  * @brief Receive buffer descriptor
125  **/
126 
127 typedef struct
128 {
129  uint32_t address;
130  uint32_t status;
132 
133 
134 //SAMA5D3 Ethernet MAC driver
135 extern const NicDriver sama5d3EthDriver;
136 
137 //SAMA5D3 Ethernet MAC related functions
139 void sama5d3EthInitGpio(NetInterface *interface);
140 void sama5d3EthInitBufferDesc(NetInterface *interface);
141 
142 void sama5d3EthTick(NetInterface *interface);
143 
144 void sama5d3EthEnableIrq(NetInterface *interface);
145 void sama5d3EthDisableIrq(NetInterface *interface);
146 void sama5d3EthIrqHandler(void);
147 void sama5d3EthEventHandler(NetInterface *interface);
148 
150  const NetBuffer *buffer, size_t offset);
151 
153 
156 
157 void sama5d3EthWritePhyReg(uint8_t opcode, uint8_t phyAddr,
158  uint8_t regAddr, uint16_t data);
159 
160 uint16_t sama5d3EthReadPhyReg(uint8_t opcode, uint8_t phyAddr,
161  uint8_t regAddr);
162 
163 //C++ guard
164 #ifdef __cplusplus
165 }
166 #endif
167 
168 #endif
error_t sama5d3EthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
uint8_t opcode
Definition: dns_common.h:172
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:88
error_t sama5d3EthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset)
Send a packet.
void sama5d3EthEventHandler(NetInterface *interface)
SAMA5D3 Ethernet MAC event handler.
void sama5d3EthDisableIrq(NetInterface *interface)
Disable interrupts.
error_t sama5d3EthReceivePacket(NetInterface *interface)
Receive a packet.
error_t
Error codes.
Definition: error.h:42
void sama5d3EthIrqHandler(void)
SAMA5D3 Ethernet MAC interrupt service routine.
#define NetInterface
Definition: net.h:36
uint16_t sama5d3EthReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
void sama5d3EthTick(NetInterface *interface)
SAMA5D3 Ethernet MAC timer handler.
void sama5d3EthWritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
uint16_t regAddr
error_t sama5d3EthInit(NetInterface *interface)
SAMA5D3 Ethernet MAC initialization.
void sama5d3EthInitBufferDesc(NetInterface *interface)
Initialize buffer descriptors.
error_t sama5d3EthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
void sama5d3EthEnableIrq(NetInterface *interface)
Enable interrupts.
void sama5d3EthInitGpio(NetInterface *interface)
Transmit buffer descriptor.
uint8_t data[]
Definition: dtls_misc.h:176
const NicDriver sama5d3EthDriver
SAMA5D3 Ethernet MAC driver.
NIC driver.
Definition: nic.h:179
Receive buffer descriptor.