Sergey Pastor / 1

Webserver+3d print

Dependents:   Nucleo

cyclone_tcp/drivers/sam3x_eth.h@0:8918a71cdbe9, 2017-02-04 (annotated)

Committer:
Sergunb
Date:
Sat Feb 04 18:15:49 2017 +0000
Revision:
0:8918a71cdbe9
nothing else

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Sergunb 0:8918a71cdbe9 1 /**
Sergunb 0:8918a71cdbe9 2 * @file sam3x_eth.h
Sergunb 0:8918a71cdbe9 3 * @brief SAM3X Ethernet MAC controller
Sergunb 0:8918a71cdbe9 4 *
Sergunb 0:8918a71cdbe9 5 * @section License
Sergunb 0:8918a71cdbe9 6 *
Sergunb 0:8918a71cdbe9 7 * Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.
Sergunb 0:8918a71cdbe9 8 *
Sergunb 0:8918a71cdbe9 9 * This file is part of CycloneTCP Open.
Sergunb 0:8918a71cdbe9 10 *
Sergunb 0:8918a71cdbe9 11 * This program is free software; you can redistribute it and/or
Sergunb 0:8918a71cdbe9 12 * modify it under the terms of the GNU General Public License
Sergunb 0:8918a71cdbe9 13 * as published by the Free Software Foundation; either version 2
Sergunb 0:8918a71cdbe9 14 * of the License, or (at your option) any later version.
Sergunb 0:8918a71cdbe9 15 *
Sergunb 0:8918a71cdbe9 16 * This program is distributed in the hope that it will be useful,
Sergunb 0:8918a71cdbe9 17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Sergunb 0:8918a71cdbe9 18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Sergunb 0:8918a71cdbe9 19 * GNU General Public License for more details.
Sergunb 0:8918a71cdbe9 20 *
Sergunb 0:8918a71cdbe9 21 * You should have received a copy of the GNU General Public License
Sergunb 0:8918a71cdbe9 22 * along with this program; if not, write to the Free Software Foundation,
Sergunb 0:8918a71cdbe9 23 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Sergunb 0:8918a71cdbe9 24 *
Sergunb 0:8918a71cdbe9 25 * @author Oryx Embedded SARL (www.oryx-embedded.com)
Sergunb 0:8918a71cdbe9 26 * @version 1.7.6
Sergunb 0:8918a71cdbe9 27 **/
Sergunb 0:8918a71cdbe9 28
Sergunb 0:8918a71cdbe9 29 #ifndef _SAM3X_ETH_H
Sergunb 0:8918a71cdbe9 30 #define _SAM3X_ETH_H
Sergunb 0:8918a71cdbe9 31
Sergunb 0:8918a71cdbe9 32 //Number of TX buffers
Sergunb 0:8918a71cdbe9 33 #ifndef SAM3X_ETH_TX_BUFFER_COUNT
Sergunb 0:8918a71cdbe9 34 #define SAM3X_ETH_TX_BUFFER_COUNT 2
Sergunb 0:8918a71cdbe9 35 #elif (SAM3X_ETH_TX_BUFFER_COUNT < 1)
Sergunb 0:8918a71cdbe9 36 #error SAM3X_ETH_TX_BUFFER_COUNT parameter is not valid
Sergunb 0:8918a71cdbe9 37 #endif
Sergunb 0:8918a71cdbe9 38
Sergunb 0:8918a71cdbe9 39 //TX buffer size
Sergunb 0:8918a71cdbe9 40 #ifndef SAM3X_ETH_TX_BUFFER_SIZE
Sergunb 0:8918a71cdbe9 41 #define SAM3X_ETH_TX_BUFFER_SIZE 1536
Sergunb 0:8918a71cdbe9 42 #elif (SAM3X_ETH_TX_BUFFER_SIZE != 1536)
Sergunb 0:8918a71cdbe9 43 #error SAM3X_ETH_TX_BUFFER_SIZE parameter is not valid
Sergunb 0:8918a71cdbe9 44 #endif
Sergunb 0:8918a71cdbe9 45
Sergunb 0:8918a71cdbe9 46 //Number of RX buffers
Sergunb 0:8918a71cdbe9 47 #ifndef SAM3X_ETH_RX_BUFFER_COUNT
Sergunb 0:8918a71cdbe9 48 #define SAM3X_ETH_RX_BUFFER_COUNT 48
Sergunb 0:8918a71cdbe9 49 #elif (SAM3X_ETH_RX_BUFFER_COUNT < 12)
Sergunb 0:8918a71cdbe9 50 #error SAM3X_ETH_RX_BUFFER_COUNT parameter is not valid
Sergunb 0:8918a71cdbe9 51 #endif
Sergunb 0:8918a71cdbe9 52
Sergunb 0:8918a71cdbe9 53 //RX buffer size
Sergunb 0:8918a71cdbe9 54 #ifndef SAM3X_ETH_RX_BUFFER_SIZE
Sergunb 0:8918a71cdbe9 55 #define SAM3X_ETH_RX_BUFFER_SIZE 128
Sergunb 0:8918a71cdbe9 56 #elif (SAM3X_ETH_RX_BUFFER_SIZE != 128)
Sergunb 0:8918a71cdbe9 57 #error SAM3X_ETH_RX_BUFFER_SIZE parameter is not valid
Sergunb 0:8918a71cdbe9 58 #endif
Sergunb 0:8918a71cdbe9 59
Sergunb 0:8918a71cdbe9 60 //Interrupt priority grouping
Sergunb 0:8918a71cdbe9 61 #ifndef SAM3X_ETH_IRQ_PRIORITY_GROUPING
Sergunb 0:8918a71cdbe9 62 #define SAM3X_ETH_IRQ_PRIORITY_GROUPING 3
Sergunb 0:8918a71cdbe9 63 #elif (SAM3X_ETH_IRQ_PRIORITY_GROUPING < 0)
Sergunb 0:8918a71cdbe9 64 #error SAM3X_ETH_IRQ_PRIORITY_GROUPING parameter is not valid
Sergunb 0:8918a71cdbe9 65 #endif
Sergunb 0:8918a71cdbe9 66
Sergunb 0:8918a71cdbe9 67 //Ethernet interrupt group priority
Sergunb 0:8918a71cdbe9 68 #ifndef SAM3X_ETH_IRQ_GROUP_PRIORITY
Sergunb 0:8918a71cdbe9 69 #define SAM3X_ETH_IRQ_GROUP_PRIORITY 12
Sergunb 0:8918a71cdbe9 70 #elif (SAM3X_ETH_IRQ_GROUP_PRIORITY < 0)
Sergunb 0:8918a71cdbe9 71 #error SAM3X_ETH_IRQ_GROUP_PRIORITY parameter is not valid
Sergunb 0:8918a71cdbe9 72 #endif
Sergunb 0:8918a71cdbe9 73
Sergunb 0:8918a71cdbe9 74 //Ethernet interrupt subpriority
Sergunb 0:8918a71cdbe9 75 #ifndef SAM3X_ETH_IRQ_SUB_PRIORITY
Sergunb 0:8918a71cdbe9 76 #define SAM3X_ETH_IRQ_SUB_PRIORITY 0
Sergunb 0:8918a71cdbe9 77 #elif (SAM3X_ETH_IRQ_SUB_PRIORITY < 0)
Sergunb 0:8918a71cdbe9 78 #error SAM3X_ETH_IRQ_SUB_PRIORITY parameter is not valid
Sergunb 0:8918a71cdbe9 79 #endif
Sergunb 0:8918a71cdbe9 80
Sergunb 0:8918a71cdbe9 81 //RMII signals
Sergunb 0:8918a71cdbe9 82 #define EMAC_RMII_MASK (PIO_PB9A_EMDIO | PIO_PB8A_EMDC | \
Sergunb 0:8918a71cdbe9 83 PIO_PB7A_ERXER | PIO_PB6A_ERX1 | PIO_PB5A_ERX0 | PIO_PB4A_ERXDV | \
Sergunb 0:8918a71cdbe9 84 PIO_PB3A_ETX1 | PIO_PB2A_ETX0 | PIO_PB1A_ETXEN | PIO_PB0A_ETXCK)
Sergunb 0:8918a71cdbe9 85
Sergunb 0:8918a71cdbe9 86 //TX buffer descriptor flags
Sergunb 0:8918a71cdbe9 87 #define EMAC_TX_USED 0x80000000
Sergunb 0:8918a71cdbe9 88 #define EMAC_TX_WRAP 0x40000000
Sergunb 0:8918a71cdbe9 89 #define EMAC_TX_ERROR 0x20000000
Sergunb 0:8918a71cdbe9 90 #define EMAC_TX_UNDERRUN 0x10000000
Sergunb 0:8918a71cdbe9 91 #define EMAC_TX_EXHAUSTED 0x08000000
Sergunb 0:8918a71cdbe9 92 #define EMAC_TX_NO_CRC 0x00010000
Sergunb 0:8918a71cdbe9 93 #define EMAC_TX_LAST 0x00008000
Sergunb 0:8918a71cdbe9 94 #define EMAC_TX_LENGTH 0x000007FF
Sergunb 0:8918a71cdbe9 95
Sergunb 0:8918a71cdbe9 96 //RX buffer descriptor flags
Sergunb 0:8918a71cdbe9 97 #define EMAC_RX_ADDRESS 0xFFFFFFFC
Sergunb 0:8918a71cdbe9 98 #define EMAC_RX_WRAP 0x00000002
Sergunb 0:8918a71cdbe9 99 #define EMAC_RX_OWNERSHIP 0x00000001
Sergunb 0:8918a71cdbe9 100 #define EMAC_RX_BROADCAST 0x80000000
Sergunb 0:8918a71cdbe9 101 #define EMAC_RX_MULTICAST_HASH 0x40000000
Sergunb 0:8918a71cdbe9 102 #define EMAC_RX_UNICAST_HASH 0x20000000
Sergunb 0:8918a71cdbe9 103 #define EMAC_RX_EXT_ADDR 0x10000000
Sergunb 0:8918a71cdbe9 104 #define EMAC_RX_SAR1 0x04000000
Sergunb 0:8918a71cdbe9 105 #define EMAC_RX_SAR2 0x02000000
Sergunb 0:8918a71cdbe9 106 #define EMAC_RX_SAR3 0x01000000
Sergunb 0:8918a71cdbe9 107 #define EMAC_RX_SAR4 0x00800000
Sergunb 0:8918a71cdbe9 108 #define EMAC_RX_TYPE_ID 0x00400000
Sergunb 0:8918a71cdbe9 109 #define EMAC_RX_VLAN_TAG 0x00200000
Sergunb 0:8918a71cdbe9 110 #define EMAC_RX_PRIORITY_TAG 0x00100000
Sergunb 0:8918a71cdbe9 111 #define EMAC_RX_VLAN_PRIORITY 0x000E0000
Sergunb 0:8918a71cdbe9 112 #define EMAC_RX_CFI 0x00010000
Sergunb 0:8918a71cdbe9 113 #define EMAC_RX_EOF 0x00008000
Sergunb 0:8918a71cdbe9 114 #define EMAC_RX_SOF 0x00004000
Sergunb 0:8918a71cdbe9 115 #define EMAC_RX_OFFSET 0x00003000
Sergunb 0:8918a71cdbe9 116 #define EMAC_RX_LENGTH 0x00000FFF
Sergunb 0:8918a71cdbe9 117
Sergunb 0:8918a71cdbe9 118
Sergunb 0:8918a71cdbe9 119 /**
Sergunb 0:8918a71cdbe9 120 * @brief Transmit buffer descriptor
Sergunb 0:8918a71cdbe9 121 **/
Sergunb 0:8918a71cdbe9 122
Sergunb 0:8918a71cdbe9 123 typedef struct
Sergunb 0:8918a71cdbe9 124 {
Sergunb 0:8918a71cdbe9 125 uint32_t address;
Sergunb 0:8918a71cdbe9 126 uint32_t status;
Sergunb 0:8918a71cdbe9 127 } Sam3xTxBufferDesc;
Sergunb 0:8918a71cdbe9 128
Sergunb 0:8918a71cdbe9 129
Sergunb 0:8918a71cdbe9 130 /**
Sergunb 0:8918a71cdbe9 131 * @brief Receive buffer descriptor
Sergunb 0:8918a71cdbe9 132 **/
Sergunb 0:8918a71cdbe9 133
Sergunb 0:8918a71cdbe9 134 typedef struct
Sergunb 0:8918a71cdbe9 135 {
Sergunb 0:8918a71cdbe9 136 uint32_t address;
Sergunb 0:8918a71cdbe9 137 uint32_t status;
Sergunb 0:8918a71cdbe9 138 } Sam3xRxBufferDesc;
Sergunb 0:8918a71cdbe9 139
Sergunb 0:8918a71cdbe9 140
Sergunb 0:8918a71cdbe9 141 //SAM3X Ethernet MAC driver
Sergunb 0:8918a71cdbe9 142 extern const NicDriver sam3xEthDriver;
Sergunb 0:8918a71cdbe9 143
Sergunb 0:8918a71cdbe9 144 //SAM3X Ethernet MAC related functions
Sergunb 0:8918a71cdbe9 145 error_t sam3xEthInit(NetInterface *interface);
Sergunb 0:8918a71cdbe9 146 void sam3xEthInitGpio(NetInterface *interface);
Sergunb 0:8918a71cdbe9 147 void sam3xEthInitBufferDesc(NetInterface *interface);
Sergunb 0:8918a71cdbe9 148
Sergunb 0:8918a71cdbe9 149 void sam3xEthTick(NetInterface *interface);
Sergunb 0:8918a71cdbe9 150
Sergunb 0:8918a71cdbe9 151 void sam3xEthEnableIrq(NetInterface *interface);
Sergunb 0:8918a71cdbe9 152 void sam3xEthDisableIrq(NetInterface *interface);
Sergunb 0:8918a71cdbe9 153 void sam3xEthEventHandler(NetInterface *interface);
Sergunb 0:8918a71cdbe9 154
Sergunb 0:8918a71cdbe9 155 error_t sam3xEthSendPacket(NetInterface *interface,
Sergunb 0:8918a71cdbe9 156 const NetBuffer *buffer, size_t offset);
Sergunb 0:8918a71cdbe9 157
Sergunb 0:8918a71cdbe9 158 error_t sam3xEthReceivePacket(NetInterface *interface);
Sergunb 0:8918a71cdbe9 159
Sergunb 0:8918a71cdbe9 160 error_t sam3xEthSetMulticastFilter(NetInterface *interface);
Sergunb 0:8918a71cdbe9 161 error_t sam3xEthUpdateMacConfig(NetInterface *interface);
Sergunb 0:8918a71cdbe9 162
Sergunb 0:8918a71cdbe9 163 void sam3xEthWritePhyReg(uint8_t phyAddr, uint8_t regAddr, uint16_t data);
Sergunb 0:8918a71cdbe9 164 uint16_t sam3xEthReadPhyReg(uint8_t phyAddr, uint8_t regAddr);
Sergunb 0:8918a71cdbe9 165
Sergunb 0:8918a71cdbe9 166 #endif
Sergunb 0:8918a71cdbe9 167