sam7x_eth_driver.h
Go to the documentation of this file.
1 /**
2  * @file sam7x_eth_driver.h
3  * @brief AT91SAM7X Ethernet MAC controller
4  *
5  * @section License
6  *
7  * Copyright (C) 2010-2018 Oryx Embedded SARL. All rights reserved.
8  *
9  * This file is part of CycloneTCP Open.
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24  *
25  * @author Oryx Embedded SARL (www.oryx-embedded.com)
26  * @version 1.9.0
27  **/
28 
29 #ifndef _SAM7X_ETH_DRIVER_H
30 #define _SAM7X_ETH_DRIVER_H
31 
32 //Number of TX buffers
33 #ifndef SAM7X_ETH_TX_BUFFER_COUNT
34  #define SAM7X_ETH_TX_BUFFER_COUNT 2
35 #elif (SAM7X_ETH_TX_BUFFER_COUNT < 1)
36  #error SAM7X_ETH_TX_BUFFER_COUNT parameter is not valid
37 #endif
38 
39 //TX buffer size
40 #ifndef SAM7X_ETH_TX_BUFFER_SIZE
41  #define SAM7X_ETH_TX_BUFFER_SIZE 1536
42 #elif (SAM7X_ETH_TX_BUFFER_SIZE != 1536)
43  #error SAM7X_ETH_TX_BUFFER_SIZE parameter is not valid
44 #endif
45 
46 //Number of RX buffers
47 #ifndef SAM7X_ETH_RX_BUFFER_COUNT
48  #define SAM7X_ETH_RX_BUFFER_COUNT 48
49 #elif (SAM7X_ETH_RX_BUFFER_COUNT < 12)
50  #error SAM7X_ETH_RX_BUFFER_COUNT parameter is not valid
51 #endif
52 
53 //RX buffer size
54 #ifndef SAM7X_ETH_RX_BUFFER_SIZE
55  #define SAM7X_ETH_RX_BUFFER_SIZE 128
56 #elif (SAM7X_ETH_RX_BUFFER_SIZE != 128)
57  #error SAM7X_ETH_RX_BUFFER_SIZE parameter is not valid
58 #endif
59 
60 //MII signals
61 #define AT91C_EMAC_MII_MASK (AT91C_PB17_ERXCK | AT91C_PB16_ECOL | \
62  AT91C_PB15_ERXDV_ECRSDV | AT91C_PB14_ERX3 | AT91C_PB13_ERX2 | AT91C_PB12_ETXER | \
63  AT91C_PB11_ETX3 | AT91C_PB10_ETX2 | AT91C_PB9_EMDIO | AT91C_PB8_EMDC | \
64  AT91C_PB7_ERXER | AT91C_PB6_ERX1 | AT91C_PB5_ERX0 | AT91C_PB4_ECRS | \
65  AT91C_PB3_ETX1 | AT91C_PB2_ETX0 | AT91C_PB1_ETXEN | AT91C_PB0_ETXCK_EREFCK)
66 
67 //PHY maintenance register (EMAC_MAN)
68 #define AT91C_EMAC_SOF_01 (1 << 30)
69 #define AT91C_EMAC_RW_01 (1 << 28)
70 #define AT91C_EMAC_RW_10 (2 << 28)
71 #define AT91C_EMAC_CODE_10 (2 << 16)
72 
73 //TX buffer descriptor flags
74 #define AT91C_EMAC_TX_USED 0x80000000
75 #define AT91C_EMAC_TX_WRAP 0x40000000
76 #define AT91C_EMAC_TX_ERROR 0x20000000
77 #define AT91C_EMAC_TX_UNDERRUN 0x10000000
78 #define AT91C_EMAC_TX_EXHAUSTED 0x08000000
79 #define AT91C_EMAC_TX_NO_CRC 0x00010000
80 #define AT91C_EMAC_TX_LAST 0x00008000
81 #define AT91C_EMAC_TX_LENGTH 0x000007FF
82 
83 //RX buffer descriptor flags
84 #define AT91C_EMAC_RX_ADDRESS 0xFFFFFFFC
85 #define AT91C_EMAC_RX_WRAP 0x00000002
86 #define AT91C_EMAC_RX_OWNERSHIP 0x00000001
87 #define AT91C_EMAC_RX_BROADCAST 0x80000000
88 #define AT91C_EMAC_RX_MULTICAST_HASH 0x40000000
89 #define AT91C_EMAC_RX_UNICAST_HASH 0x20000000
90 #define AT91C_EMAC_RX_EXT_ADDR 0x10000000
91 #define AT91C_EMAC_RX_SAR1 0x04000000
92 #define AT91C_EMAC_RX_SAR2 0x02000000
93 #define AT91C_EMAC_RX_SAR3 0x01000000
94 #define AT91C_EMAC_RX_SAR4 0x00800000
95 #define AT91C_EMAC_RX_TYPE_ID 0x00400000
96 #define AT91C_EMAC_RX_VLAN_TAG 0x00200000
97 #define AT91C_EMAC_RX_PRIORITY_TAG 0x00100000
98 #define AT91C_EMAC_RX_VLAN_PRIORITY 0x000E0000
99 #define AT91C_EMAC_RX_CFI 0x00010000
100 #define AT91C_EMAC_RX_EOF 0x00008000
101 #define AT91C_EMAC_RX_SOF 0x00004000
102 #define AT91C_EMAC_RX_OFFSET 0x00003000
103 #define AT91C_EMAC_RX_LENGTH 0x00000FFF
104 
105 //C++ guard
106 #ifdef __cplusplus
107  extern "C" {
108 #endif
109 
110 
111 /**
112  * @brief Transmit buffer descriptor
113  **/
114 
115 typedef struct
116 {
117  uint32_t address;
118  uint32_t status;
120 
121 
122 /**
123  * @brief Receive buffer descriptor
124  **/
125 
126 typedef struct
127 {
128  uint32_t address;
129  uint32_t status;
131 
132 
133 //SAM7X Ethernet MAC driver
134 extern const NicDriver sam7xEthDriver;
135 
136 //SAM7X Ethernet MAC related functions
137 error_t sam7xEthInit(NetInterface *interface);
138 void sam7xEthInitGpio(NetInterface *interface);
139 void sam7xEthInitBufferDesc(NetInterface *interface);
140 
141 void sam7xEthTick(NetInterface *interface);
142 
143 void sam7xEthEnableIrq(NetInterface *interface);
144 void sam7xEthDisableIrq(NetInterface *interface);
145 void sam7xEthIrqHandler(void);
146 void sam7xEthEventHandler(NetInterface *interface);
147 
149  const NetBuffer *buffer, size_t offset);
150 
152 
155 
156 void sam7xEthWritePhyReg(uint8_t phyAddr, uint8_t regAddr, uint16_t data);
157 uint16_t sam7xEthReadPhyReg(uint8_t phyAddr, uint8_t regAddr);
158 
159 //Wrapper for the interrupt service routine
160 void emacIrqWrapper(void);
161 
162 //C++ guard
163 #ifdef __cplusplus
164  }
165 #endif
166 
167 #endif
void sam7xEthWritePhyReg(uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
error_t sam7xEthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
error_t sam7xEthReceivePacket(NetInterface *interface)
Receive a packet.
Transmit buffer descriptor.
error_t sam7xEthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
Receive buffer descriptor.
void sam7xEthEventHandler(NetInterface *interface)
SAM7X Ethernet MAC event handler.
void sam7xEthInitGpio(NetInterface *interface)
uint16_t sam7xEthReadPhyReg(uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
void sam7xEthEnableIrq(NetInterface *interface)
Enable interrupts.
void emacIrqWrapper(void)
NIC driver.
Definition: nic.h:161
void sam7xEthInitBufferDesc(NetInterface *interface)
Initialize buffer descriptors.
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:86
uint16_t regAddr
error_t
Error codes.
Definition: error.h:40
error_t sam7xEthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset)
Send a packet.
uint8_t data[]
Definition: dtls_misc.h:167
#define NetInterface
Definition: net.h:34
void sam7xEthIrqHandler(void)
SAM7X Ethernet MAC interrupt service routine.
void sam7xEthTick(NetInterface *interface)
SAM7X Ethernet MAC timer handler.
const NicDriver sam7xEthDriver
SAM7X Ethernet MAC driver.
void sam7xEthDisableIrq(NetInterface *interface)
Disable interrupts.
error_t sam7xEthInit(NetInterface *interface)
SAM7X Ethernet MAC initialization.