pic32ck_eth_driver.h
Go to the documentation of this file.
1 /**
2  * @file pic32ck_eth_driver.h
3  * @brief PIC32CK GC01/SG01 Ethernet MAC driver
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 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.4.4
29  **/
30 
31 #ifndef _PIC32CK_ETH_DRIVER_H
32 #define _PIC32CK_ETH_DRIVER_H
33 
34 //Number of TX buffers
35 #ifndef PIC32CK_ETH_TX_BUFFER_COUNT
36  #define PIC32CK_ETH_TX_BUFFER_COUNT 3
37 #elif (PIC32CK_ETH_TX_BUFFER_COUNT < 1)
38  #error PIC32CK_ETH_TX_BUFFER_COUNT parameter is not valid
39 #endif
40 
41 //TX buffer size
42 #ifndef PIC32CK_ETH_TX_BUFFER_SIZE
43  #define PIC32CK_ETH_TX_BUFFER_SIZE 1536
44 #elif (PIC32CK_ETH_TX_BUFFER_SIZE != 1536)
45  #error PIC32CK_ETH_TX_BUFFER_SIZE parameter is not valid
46 #endif
47 
48 //Number of RX buffers
49 #ifndef PIC32CK_ETH_RX_BUFFER_COUNT
50  #define PIC32CK_ETH_RX_BUFFER_COUNT 72
51 #elif (PIC32CK_ETH_RX_BUFFER_COUNT < 12)
52  #error PIC32CK_ETH_RX_BUFFER_COUNT parameter is not valid
53 #endif
54 
55 //RX buffer size
56 #ifndef PIC32CK_ETH_RX_BUFFER_SIZE
57  #define PIC32CK_ETH_RX_BUFFER_SIZE 128
58 #elif (PIC32CK_ETH_RX_BUFFER_SIZE != 128)
59  #error PIC32CK_ETH_RX_BUFFER_SIZE parameter is not valid
60 #endif
61 
62 //Interrupt priority grouping
63 #ifndef PIC32CK_ETH_IRQ_PRIORITY_GROUPING
64  #define PIC32CK_ETH_IRQ_PRIORITY_GROUPING 4
65 #elif (PIC32CK_ETH_IRQ_PRIORITY_GROUPING < 0)
66  #error PIC32CK_ETH_IRQ_PRIORITY_GROUPING parameter is not valid
67 #endif
68 
69 //Ethernet interrupt group priority
70 #ifndef PIC32CK_ETH_IRQ_GROUP_PRIORITY
71  #define PIC32CK_ETH_IRQ_GROUP_PRIORITY 6
72 #elif (PIC32CK_ETH_IRQ_GROUP_PRIORITY < 0)
73  #error PIC32CK_ETH_IRQ_GROUP_PRIORITY parameter is not valid
74 #endif
75 
76 //Ethernet interrupt subpriority
77 #ifndef PIC32CK_ETH_IRQ_SUB_PRIORITY
78  #define PIC32CK_ETH_IRQ_SUB_PRIORITY 0
79 #elif (PIC32CK_ETH_IRQ_SUB_PRIORITY < 0)
80  #error PIC32CK_ETH_IRQ_SUB_PRIORITY parameter is not valid
81 #endif
82 
83 //ETH_UR register
84 #ifndef ETH_UR_MII_Msk
85  #define ETH_UR_MII_Msk 0x00000001
86 #endif
87 
88 //TX buffer descriptor flags
89 #define ETH_TX_USED 0x80000000
90 #define ETH_TX_WRAP 0x40000000
91 #define ETH_TX_RLE_ERROR 0x20000000
92 #define ETH_TX_UNDERRUN_ERROR 0x10000000
93 #define ETH_TX_AHB_ERROR 0x08000000
94 #define ETH_TX_LATE_COL_ERROR 0x04000000
95 #define ETH_TX_CHECKSUM_ERROR 0x00700000
96 #define ETH_TX_NO_CRC 0x00010000
97 #define ETH_TX_LAST 0x00008000
98 #define ETH_TX_LENGTH 0x00003FFF
99 
100 //RX buffer descriptor flags
101 #define ETH_RX_ADDRESS 0xFFFFFFFC
102 #define ETH_RX_WRAP 0x00000002
103 #define ETH_RX_OWNERSHIP 0x00000001
104 #define ETH_RX_BROADCAST 0x80000000
105 #define ETH_RX_MULTICAST_HASH 0x40000000
106 #define ETH_RX_UNICAST_HASH 0x20000000
107 #define ETH_RX_SAR 0x08000000
108 #define ETH_RX_SAR_MASK 0x06000000
109 #define ETH_RX_TYPE_ID 0x01000000
110 #define ETH_RX_SNAP 0x01000000
111 #define ETH_RX_TYPE_ID_MASK 0x00C00000
112 #define ETH_RX_CHECKSUM_VALID 0x00C00000
113 #define ETH_RX_VLAN_TAG 0x00200000
114 #define ETH_RX_PRIORITY_TAG 0x00100000
115 #define ETH_RX_VLAN_PRIORITY 0x000E0000
116 #define ETH_RX_CFI 0x00010000
117 #define ETH_RX_EOF 0x00008000
118 #define ETH_RX_SOF 0x00004000
119 #define ETH_RX_LENGTH_MSB 0x00002000
120 #define ETH_RX_BAD_FCS 0x00002000
121 #define ETH_RX_LENGTH 0x00001FFF
122 
123 //C++ guard
124 #ifdef __cplusplus
125 extern "C" {
126 #endif
127 
128 
129 /**
130  * @brief Transmit buffer descriptor
131  **/
132 
133 typedef struct
134 {
135  uint32_t address;
136  uint32_t status;
138 
139 
140 /**
141  * @brief Receive buffer descriptor
142  **/
143 
144 typedef struct
145 {
146  uint32_t address;
147  uint32_t status;
149 
150 
151 //PIC32CK Ethernet MAC driver
152 extern const NicDriver pic32ckEthDriver;
153 
154 //PIC32CK Ethernet MAC related functions
156 void pic32ckEthInitGpio(NetInterface *interface);
157 void pic32ckEthInitBufferDesc(NetInterface *interface);
158 
159 void pic32ckEthTick(NetInterface *interface);
160 
161 void pic32ckEthEnableIrq(NetInterface *interface);
162 void pic32ckEthDisableIrq(NetInterface *interface);
163 void pic32ckEthEventHandler(NetInterface *interface);
164 
166  const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary);
167 
169 
172 
173 void pic32ckEthWritePhyReg(uint8_t opcode, uint8_t phyAddr,
174  uint8_t regAddr, uint16_t data);
175 
176 uint16_t pic32ckEthReadPhyReg(uint8_t opcode, uint8_t phyAddr,
177  uint8_t regAddr);
178 
179 //C++ guard
180 #ifdef __cplusplus
181 }
182 #endif
183 
184 #endif
void pic32ckEthDisableIrq(NetInterface *interface)
Disable interrupts.
error_t pic32ckEthInit(NetInterface *interface)
PIC32CK Ethernet MAC initialization.
uint8_t opcode
Definition: dns_common.h:188
error_t pic32ckEthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
error_t pic32ckEthReceivePacket(NetInterface *interface)
Receive a packet.
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:89
uint8_t data[]
Definition: ethernet.h:222
void pic32ckEthEventHandler(NetInterface *interface)
PIC32CK Ethernet MAC event handler.
error_t pic32ckEthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
void pic32ckEthTick(NetInterface *interface)
PIC32CK Ethernet MAC timer handler.
void pic32ckEthEnableIrq(NetInterface *interface)
Enable interrupts.
error_t
Error codes.
Definition: error.h:43
#define NetInterface
Definition: net.h:36
void pic32ckEthInitBufferDesc(NetInterface *interface)
Initialize buffer descriptors.
#define NetTxAncillary
Definition: net_misc.h:36
void pic32ckEthInitGpio(NetInterface *interface)
GPIO configuration.
Receive buffer descriptor.
Transmit buffer descriptor.
void pic32ckEthWritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
uint16_t regAddr
uint16_t pic32ckEthReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
error_t pic32ckEthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
const NicDriver pic32ckEthDriver
PIC32CK Ethernet MAC driver.
NIC driver.
Definition: nic.h:286