pic32mx_eth.h

00001 /**
00002  * @file pic32mx_eth.h
00003  * @brief PIC32MX Ethernet MAC controller
00004  *
00005  * @section License
00006  *
00007  * Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.
00008  *
00009  * This file is part of CycloneTCP Open.
00010  *
00011  * This program is free software; you can redistribute it and/or
00012  * modify it under the terms of the GNU General Public License
00013  * as published by the Free Software Foundation; either version 2
00014  * of the License, or (at your option) any later version.
00015  *
00016  * This program is distributed in the hope that it will be useful,
00017  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  * GNU General Public License for more details.
00020  *
00021  * You should have received a copy of the GNU General Public License
00022  * along with this program; if not, write to the Free Software Foundation,
00023  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
00024  *
00025  * @author Oryx Embedded SARL (www.oryx-embedded.com)
00026  * @version 1.7.6
00027  **/
00028 
00029 #ifndef _PIC32MX_ETH_H
00030 #define _PIC32MX_ETH_H
00031 
00032 //Dependencies
00033 #include "core/nic.h"
00034 
00035 //Number of TX buffers
00036 #ifndef PIC32MX_ETH_TX_BUFFER_COUNT
00037    #define PIC32MX_ETH_TX_BUFFER_COUNT 2
00038 #elif (PIC32MX_ETH_TX_BUFFER_COUNT < 1)
00039    #error PIC32MX_ETH_TX_BUFFER_COUNT parameter is not valid
00040 #endif
00041 
00042 //TX buffer size
00043 #ifndef PIC32MX_ETH_TX_BUFFER_SIZE
00044    #define PIC32MX_ETH_TX_BUFFER_SIZE 1536
00045 #elif (PIC32MX_ETH_TX_BUFFER_SIZE != 1536)
00046    #error PIC32MX_ETH_TX_BUFFER_SIZE parameter is not valid
00047 #endif
00048 
00049 //Number of RX buffers
00050 #ifndef PIC32MX_ETH_RX_BUFFER_COUNT
00051    #define PIC32MX_ETH_RX_BUFFER_COUNT 4
00052 #elif (PIC32MX_ETH_RX_BUFFER_COUNT < 1)
00053    #error PIC32MX_ETH_RX_BUFFER_COUNT parameter is not valid
00054 #endif
00055 
00056 //RX buffer size
00057 #ifndef PIC32MX_ETH_RX_BUFFER_SIZE
00058    #define PIC32MX_ETH_RX_BUFFER_SIZE 1536
00059 #elif (PIC32MX_ETH_RX_BUFFER_SIZE != 1536)
00060    #error PIC32MX_ETH_RX_BUFFER_SIZE parameter is not valid
00061 #endif
00062 
00063 //Ethernet interrupt priority
00064 #ifndef PIC32MX_ETH_IRQ_PRIORITY
00065    #define PIC32MX_ETH_IRQ_PRIORITY 2
00066 #elif (PIC32MX_ETH_IRQ_PRIORITY < 0)
00067    #error PIC32MX_ETH_IRQ_PRIORITY parameter is not valid
00068 #endif
00069 
00070 //Ethernet interrupt subpriority
00071 #ifndef PIC32MX_ETH_IRQ_SUB_PRIORITY
00072    #define PIC32MX_ETH_IRQ_SUB_PRIORITY 0
00073 #elif (PIC32MX_ETH_IRQ_SUB_PRIORITY < 0)
00074    #error PIC32MX_ETH_IRQ_SUB_PRIORITY parameter is not valid
00075 #endif
00076 
00077 //EMAC1MCFG register
00078 #define _EMAC1MCFG_CLKSEL_DIV4  (0 << _EMAC1MCFG_CLKSEL_POSITION)
00079 #define _EMAC1MCFG_CLKSEL_DIV6  (2 << _EMAC1MCFG_CLKSEL_POSITION)
00080 #define _EMAC1MCFG_CLKSEL_DIV8  (3 << _EMAC1MCFG_CLKSEL_POSITION)
00081 #define _EMAC1MCFG_CLKSEL_DIV10 (4 << _EMAC1MCFG_CLKSEL_POSITION)
00082 #define _EMAC1MCFG_CLKSEL_DIV14 (5 << _EMAC1MCFG_CLKSEL_POSITION)
00083 #define _EMAC1MCFG_CLKSEL_DIV20 (6 << _EMAC1MCFG_CLKSEL_POSITION)
00084 #define _EMAC1MCFG_CLKSEL_DIV28 (7 << _EMAC1MCFG_CLKSEL_POSITION)
00085 #define _EMAC1MCFG_CLKSEL_DIV40 (8 << _EMAC1MCFG_CLKSEL_POSITION)
00086 
00087 //Transmit buffer descriptor flags
00088 #define ETH_TX_CTRL_SOP                   0x80000000
00089 #define ETH_TX_CTRL_EOP                   0x40000000
00090 #define ETH_TX_CTRL_BYTE_COUNT            0x07FF0000
00091 #define ETH_TX_CTRL_NPV                   0x00000100
00092 #define ETH_TX_CTRL_EOWN                  0x00000080
00093 #define ETH_TX_STATUS1_VLAN               0x00080000
00094 #define ETH_TX_STATUS1_BACKPRESSURE       0x00040000
00095 #define ETH_TX_STATUS1_PAUSE              0x00020000
00096 #define ETH_TX_STATUS1_CONTROL            0x00010000
00097 #define ETH_TX_STATUS1_TOTAL_BYTES        0x0000FFFF
00098 #define ETH_TX_STATUS2_UNDERRUN           0x80000000
00099 #define ETH_TX_STATUS2_GIANT              0x40000000
00100 #define ETH_TX_STATUS2_LATE_COL           0x20000000
00101 #define ETH_TX_STATUS2_MAX_COL            0x10000000
00102 #define ETH_TX_STATUS2_EXCESSIVE_DEFER    0x08000000
00103 #define ETH_TX_STATUS2_PACKET_DEFER       0x04000000
00104 #define ETH_TX_STATUS2_BROADCAST          0x02000000
00105 #define ETH_TX_STATUS2_MULTICAST          0x01000000
00106 #define ETH_TX_STATUS2_DONE               0x00800000
00107 #define ETH_TX_STATUS2_LEN_OUT_OF_RANGE   0x00400000
00108 #define ETH_TX_STATUS2_LEN_CHECK_ERROR    0x00200000
00109 #define ETH_TX_STATUS2_CRC_ERROR          0x00100000
00110 #define ETH_TX_STATUS2_COL_COUNT          0x000F0000
00111 #define ETH_TX_STATUS2_BYTE_COUNT         0x0000FFFF
00112 
00113 //Receive buffer descriptor flags
00114 #define ETH_RX_CTRL_SOP                   0x80000000
00115 #define ETH_RX_CTRL_EOP                   0x40000000
00116 #define ETH_RX_CTRL_BYTE_COUNT            0x07FF0000
00117 #define ETH_RX_CTRL_NPV                   0x00000100
00118 #define ETH_RX_CTRL_EOWN                  0x00000080
00119 #define ETH_RX_STATUS1_MULTICAST_MATCH    0x80000000
00120 #define ETH_RX_STATUS1_BROADCAST_MATCH    0x40000000
00121 #define ETH_RX_STATUS1_UNICAST_MATCH      0x20000000
00122 #define ETH_RX_STATUS1_PATTERN_MATCH      0x10000000
00123 #define ETH_RX_STATUS1_MAGIC_PACKET_MATCH 0x08000000
00124 #define ETH_RX_STATUS1_HASH_TABLE_MATCH   0x04000000
00125 #define ETH_RX_STATUS1_NOT_MATCH          0x02000000
00126 #define ETH_RX_STATUS1_RUNT_PACKET        0x01000000
00127 #define ETH_RX_STATUS1_PACKET_CHECKSUM    0x0000FFFF
00128 #define ETH_RX_STATUS2_VLAN               0x40000000
00129 #define ETH_RX_STATUS2_UNKNOWN_OP_CODE    0x20000000
00130 #define ETH_RX_STATUS2_PAUSE              0x10000000
00131 #define ETH_RX_STATUS2_CONTROL            0x08000000
00132 #define ETH_RX_STATUS2_DRIBBLE_NIBBLE     0x04000000
00133 #define ETH_RX_STATUS2_BROADCAST          0x02000000
00134 #define ETH_RX_STATUS2_MULTICAST          0x01000000
00135 #define ETH_RX_STATUS2_OK                 0x00800000
00136 #define ETH_RX_STATUS2_LEN_OUT_OF_RANGE   0x00400000
00137 #define ETH_RX_STATUS2_LEN_CHECK_ERROR    0x00200000
00138 #define ETH_RX_STATUS2_CRC_ERROR          0x00100000
00139 #define ETH_RX_STATUS2_CODE_VIOLATION     0x00080000
00140 #define ETH_RX_STATUS2_CARRIER_EVENT      0x00040000
00141 #define ETH_RX_STATUS2_RXDV_EVENT         0x00020000
00142 #define ETH_RX_STATUS2_LONG_EVENT         0x00010000
00143 #define ETH_RX_STATUS2_BYTE_COUNT         0x0000FFFF
00144 
00145 
00146 /**
00147  * @brief TX buffer descriptor
00148  **/
00149 
00150 typedef struct
00151 {
00152    uint32_t control;
00153    uint32_t address;
00154    uint32_t status1;
00155    uint32_t status2;
00156    uint32_t next;
00157 } Pic32mxTxBufferDesc;
00158 
00159 
00160 /**
00161  * @brief RX buffer descriptor
00162  **/
00163 
00164 typedef struct
00165 {
00166    uint32_t control;
00167    uint32_t address;
00168    uint32_t status1;
00169    uint32_t status2;
00170    uint32_t next;
00171 } Pic32mxRxBufferDesc;
00172 
00173 
00174 //PIC32MX Ethernet MAC driver
00175 extern const NicDriver pic32mxEthDriver;
00176 
00177 //PIC32MX Ethernet MAC related functions
00178 error_t pic32mxEthInit(NetInterface *interface);
00179 void pic32mxEthInitGpio(NetInterface *interface);
00180 void pic32mxEthInitBufferDesc(NetInterface *interface);
00181 
00182 void pic32mxEthTick(NetInterface *interface);
00183 
00184 void pic32mxEthEnableIrq(NetInterface *interface);
00185 void pic32mxEthDisableIrq(NetInterface *interface);
00186 void pic32mxEthIrqHandler(void);
00187 void pic32mxEthEventHandler(NetInterface *interface);
00188 
00189 error_t pic32mxEthSendPacket(NetInterface *interface,
00190    const NetBuffer *buffer, size_t offset);
00191 
00192 error_t pic32mxEthReceivePacket(NetInterface *interface);
00193 
00194 error_t pic32mxEthSetMulticastFilter(NetInterface *interface);
00195 error_t pic32mxEthUpdateMacConfig(NetInterface *interface);
00196 
00197 void pic32mxEthWritePhyReg(uint8_t phyAddr, uint8_t regAddr, uint16_t data);
00198 uint16_t pic32mxEthReadPhyReg(uint8_t phyAddr, uint8_t regAddr);
00199 
00200 uint32_t pic32mxEthCalcCrc(const void *data, size_t length);
00201 
00202 #endif
00203