mpc57xx_eth_driver.h
Go to the documentation of this file.
1 /**
2  * @file mpc57xx_eth_driver.h
3  * @brief Freescale MPC57xx 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 _MPC57XX_ETH_DRIVER_H
30 #define _MPC57XX_ETH_DRIVER_H
31 
32 //Number of TX buffers
33 #ifndef MPC57XX_ETH_TX_BUFFER_COUNT
34  #define MPC57XX_ETH_TX_BUFFER_COUNT 3
35 #elif (MPC57XX_ETH_TX_BUFFER_COUNT < 1)
36  #error MPC57XX_ETH_TX_BUFFER_COUNT parameter is not valid
37 #endif
38 
39 //TX buffer size
40 #ifndef MPC57XX_ETH_TX_BUFFER_SIZE
41  #define MPC57XX_ETH_TX_BUFFER_SIZE 1536
42 #elif (MPC57XX_ETH_TX_BUFFER_SIZE != 1536)
43  #error MPC57XX_ETH_TX_BUFFER_SIZE parameter is not valid
44 #endif
45 
46 //Number of RX buffers
47 #ifndef MPC57XX_ETH_RX_BUFFER_COUNT
48  #define MPC57XX_ETH_RX_BUFFER_COUNT 6
49 #elif (MPC57XX_ETH_RX_BUFFER_COUNT < 1)
50  #error MPC57XX_ETH_RX_BUFFER_COUNT parameter is not valid
51 #endif
52 
53 //RX buffer size
54 #ifndef MPC57XX_ETH_RX_BUFFER_SIZE
55  #define MPC57XX_ETH_RX_BUFFER_SIZE 1536
56 #elif (MPC57XX_ETH_RX_BUFFER_SIZE != 1536)
57  #error MPC57XX_ETH_RX_BUFFER_SIZE parameter is not valid
58 #endif
59 
60 //Ethernet interrupt priority
61 #ifndef MPC57XX_ETH_IRQ_PRIORITY
62  #define MPC57XX_ETH_IRQ_PRIORITY 10
63 #elif (MPC57XX_ETH_IRQ_PRIORITY < 0)
64  #error MPC57XX_ETH_IRQ_PRIORITY parameter is not valid
65 #endif
66 
67 //Enhanced transmit buffer descriptor
68 #define ENET_TBD0_R 0x80000000
69 #define ENET_TBD0_TO1 0x40000000
70 #define ENET_TBD0_W 0x20000000
71 #define ENET_TBD0_TO2 0x10000000
72 #define ENET_TBD0_L 0x08000000
73 #define ENET_TBD0_TC 0x04000000
74 #define ENET_TBD0_DATA_LENGTH 0x0000FFFF
75 #define ENET_TBD1_DATA_POINTER 0xFFFFFFFF
76 #define ENET_TBD2_INT 0x40000000
77 #define ENET_TBD2_TS 0x20000000
78 #define ENET_TBD2_PINS 0x10000000
79 #define ENET_TBD2_IINS 0x08000000
80 #define ENET_TBD2_TXE 0x00008000
81 #define ENET_TBD2_UE 0x00002000
82 #define ENET_TBD2_EE 0x00001000
83 #define ENET_TBD2_FE 0x00000800
84 #define ENET_TBD2_LCE 0x00000400
85 #define ENET_TBD2_OE 0x00000200
86 #define ENET_TBD2_TSE 0x00000100
87 #define ENET_TBD4_BDU 0x80000000
88 #define ENET_TBD5_TIMESTAMP 0xFFFFFFFF
89 
90 //Enhanced receive buffer descriptor
91 #define ENET_RBD0_E 0x80000000
92 #define ENET_RBD0_RO1 0x40000000
93 #define ENET_RBD0_W 0x20000000
94 #define ENET_RBD0_RO2 0x10000000
95 #define ENET_RBD0_L 0x08000000
96 #define ENET_RBD0_M 0x01000000
97 #define ENET_RBD0_BC 0x00800000
98 #define ENET_RBD0_MC 0x00400000
99 #define ENET_RBD0_LG 0x00200000
100 #define ENET_RBD0_NO 0x00100000
101 #define ENET_RBD0_CR 0x00040000
102 #define ENET_RBD0_OV 0x00020000
103 #define ENET_RBD0_TR 0x00010000
104 #define ENET_RBD0_DATA_LENGTH 0x0000FFFF
105 #define ENET_RBD1_DATA_POINTER 0xFFFFFFFF
106 #define ENET_RBD2_ME 0x80000000
107 #define ENET_RBD2_PE 0x04000000
108 #define ENET_RBD2_CE 0x02000000
109 #define ENET_RBD2_UC 0x01000000
110 #define ENET_RBD2_INT 0x00800000
111 #define ENET_RBD2_VPCP 0x0000E000
112 #define ENET_RBD2_ICE 0x00000020
113 #define ENET_RBD2_PCR 0x00000010
114 #define ENET_RBD2_VLAN 0x00000004
115 #define ENET_RBD2_IPV6 0x00000002
116 #define ENET_RBD2_FRAG 0x00000001
117 #define ENET_RBD3_HEADER_LENGTH 0xF8000000
118 #define ENET_RBD3_PROTOCOL_TYPE 0x00FF0000
119 #define ENET_RBD3_PAYLOAD_CHECKSUM 0x0000FFFF
120 #define ENET_RBD4_BDU 0x80000000
121 #define ENET_RBD5_TIMESTAMP 0xFFFFFFFF
122 
123 //C++ guard
124 #ifdef __cplusplus
125  extern "C" {
126 #endif
127 
128 //MPC57xx Ethernet MAC driver
129 extern const NicDriver mpc57xxEthDriver;
130 
131 //MPC57xx Ethernet MAC related functions
133 void mpc57xxEthInitGpio(NetInterface *interface);
134 void mpc57xxEthInitBufferDesc(NetInterface *interface);
135 
136 void mpc57xxEthTick(NetInterface *interface);
137 
138 void mpc57xxEthEnableIrq(NetInterface *interface);
139 void mpc57xxEthDisableIrq(NetInterface *interface);
140 void mpc57xxEthEventHandler(NetInterface *interface);
141 
143  const NetBuffer *buffer, size_t offset);
144 
146 
149 
150 void mpc57xxEthWritePhyReg(uint8_t phyAddr, uint8_t regAddr, uint16_t data);
151 uint16_t mpc57xxEthReadPhyReg(uint8_t phyAddr, uint8_t regAddr);
152 
153 uint32_t mpc57xxEthCalcCrc(const void *data, size_t length);
154 
155 //C++ guard
156 #ifdef __cplusplus
157  }
158 #endif
159 
160 #endif
void mpc57xxEthEnableIrq(NetInterface *interface)
Enable interrupts.
error_t mpc57xxEthReceivePacket(NetInterface *interface)
Receive a packet.
error_t mpc57xxEthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
const NicDriver mpc57xxEthDriver
MPC57xx Ethernet MAC driver.
error_t mpc57xxEthInit(NetInterface *interface)
MPC57xx Ethernet MAC initialization.
uint16_t mpc57xxEthReadPhyReg(uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
void mpc57xxEthWritePhyReg(uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
void mpc57xxEthEventHandler(NetInterface *interface)
MPC57xx Ethernet MAC event handler.
NIC driver.
Definition: nic.h:161
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:86
uint16_t regAddr
error_t
Error codes.
Definition: error.h:40
void mpc57xxEthDisableIrq(NetInterface *interface)
Disable interrupts.
error_t mpc57xxEthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
uint8_t data[]
Definition: dtls_misc.h:167
#define NetInterface
Definition: net.h:34
void mpc57xxEthTick(NetInterface *interface)
MPC57xx Ethernet MAC timer handler.
error_t mpc57xxEthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset)
Send a packet.
uint32_t mpc57xxEthCalcCrc(const void *data, size_t length)
CRC calculation.
void mpc57xxEthInitBufferDesc(NetInterface *interface)
Initialize buffer descriptors.
uint8_t length
Definition: dtls_misc.h:140
void mpc57xxEthInitGpio(NetInterface *interface)