Diff: cyclone_tcp/drivers/sam3x_eth.h

Revision:

0:8918a71cdbe9

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/cyclone_tcp/drivers/sam3x_eth.h	Sat Feb 04 18:15:49 2017 +0000
@@ -0,0 +1,167 @@
+/**
+ * @file sam3x_eth.h
+ * @brief SAM3X Ethernet MAC controller
+ *
+ * @section License
+ *
+ * Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.
+ *
+ * This file is part of CycloneTCP Open.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * @author Oryx Embedded SARL (www.oryx-embedded.com)
+ * @version 1.7.6
+ **/
+
+#ifndef _SAM3X_ETH_H
+#define _SAM3X_ETH_H
+
+//Number of TX buffers
+#ifndef SAM3X_ETH_TX_BUFFER_COUNT
+   #define SAM3X_ETH_TX_BUFFER_COUNT 2
+#elif (SAM3X_ETH_TX_BUFFER_COUNT < 1)
+   #error SAM3X_ETH_TX_BUFFER_COUNT parameter is not valid
+#endif
+
+//TX buffer size
+#ifndef SAM3X_ETH_TX_BUFFER_SIZE
+   #define SAM3X_ETH_TX_BUFFER_SIZE 1536
+#elif (SAM3X_ETH_TX_BUFFER_SIZE != 1536)
+   #error SAM3X_ETH_TX_BUFFER_SIZE parameter is not valid
+#endif
+
+//Number of RX buffers
+#ifndef SAM3X_ETH_RX_BUFFER_COUNT
+   #define SAM3X_ETH_RX_BUFFER_COUNT 48
+#elif (SAM3X_ETH_RX_BUFFER_COUNT < 12)
+   #error SAM3X_ETH_RX_BUFFER_COUNT parameter is not valid
+#endif
+
+//RX buffer size
+#ifndef SAM3X_ETH_RX_BUFFER_SIZE
+   #define SAM3X_ETH_RX_BUFFER_SIZE 128
+#elif (SAM3X_ETH_RX_BUFFER_SIZE != 128)
+   #error SAM3X_ETH_RX_BUFFER_SIZE parameter is not valid
+#endif
+
+//Interrupt priority grouping
+#ifndef SAM3X_ETH_IRQ_PRIORITY_GROUPING
+   #define SAM3X_ETH_IRQ_PRIORITY_GROUPING 3
+#elif (SAM3X_ETH_IRQ_PRIORITY_GROUPING < 0)
+   #error SAM3X_ETH_IRQ_PRIORITY_GROUPING parameter is not valid
+#endif
+
+//Ethernet interrupt group priority
+#ifndef SAM3X_ETH_IRQ_GROUP_PRIORITY
+   #define SAM3X_ETH_IRQ_GROUP_PRIORITY 12
+#elif (SAM3X_ETH_IRQ_GROUP_PRIORITY < 0)
+   #error SAM3X_ETH_IRQ_GROUP_PRIORITY parameter is not valid
+#endif
+
+//Ethernet interrupt subpriority
+#ifndef SAM3X_ETH_IRQ_SUB_PRIORITY
+   #define SAM3X_ETH_IRQ_SUB_PRIORITY 0
+#elif (SAM3X_ETH_IRQ_SUB_PRIORITY < 0)
+   #error SAM3X_ETH_IRQ_SUB_PRIORITY parameter is not valid
+#endif
+
+//RMII signals
+#define EMAC_RMII_MASK (PIO_PB9A_EMDIO | PIO_PB8A_EMDC | \
+   PIO_PB7A_ERXER | PIO_PB6A_ERX1 | PIO_PB5A_ERX0 | PIO_PB4A_ERXDV | \
+   PIO_PB3A_ETX1 | PIO_PB2A_ETX0 | PIO_PB1A_ETXEN | PIO_PB0A_ETXCK)
+
+//TX buffer descriptor flags
+#define EMAC_TX_USED           0x80000000
+#define EMAC_TX_WRAP           0x40000000
+#define EMAC_TX_ERROR          0x20000000
+#define EMAC_TX_UNDERRUN       0x10000000
+#define EMAC_TX_EXHAUSTED      0x08000000
+#define EMAC_TX_NO_CRC         0x00010000
+#define EMAC_TX_LAST           0x00008000
+#define EMAC_TX_LENGTH         0x000007FF
+
+//RX buffer descriptor flags
+#define EMAC_RX_ADDRESS        0xFFFFFFFC
+#define EMAC_RX_WRAP           0x00000002
+#define EMAC_RX_OWNERSHIP      0x00000001
+#define EMAC_RX_BROADCAST      0x80000000
+#define EMAC_RX_MULTICAST_HASH 0x40000000
+#define EMAC_RX_UNICAST_HASH   0x20000000
+#define EMAC_RX_EXT_ADDR       0x10000000
+#define EMAC_RX_SAR1           0x04000000
+#define EMAC_RX_SAR2           0x02000000
+#define EMAC_RX_SAR3           0x01000000
+#define EMAC_RX_SAR4           0x00800000
+#define EMAC_RX_TYPE_ID        0x00400000
+#define EMAC_RX_VLAN_TAG       0x00200000
+#define EMAC_RX_PRIORITY_TAG   0x00100000
+#define EMAC_RX_VLAN_PRIORITY  0x000E0000
+#define EMAC_RX_CFI            0x00010000
+#define EMAC_RX_EOF            0x00008000
+#define EMAC_RX_SOF            0x00004000
+#define EMAC_RX_OFFSET         0x00003000
+#define EMAC_RX_LENGTH         0x00000FFF
+
+
+/**
+ * @brief Transmit buffer descriptor
+ **/
+
+typedef struct
+{
+   uint32_t address;
+   uint32_t status;
+} Sam3xTxBufferDesc;
+
+
+/**
+ * @brief Receive buffer descriptor
+ **/
+
+typedef struct
+{
+   uint32_t address;
+   uint32_t status;
+} Sam3xRxBufferDesc;
+
+
+//SAM3X Ethernet MAC driver
+extern const NicDriver sam3xEthDriver;
+
+//SAM3X Ethernet MAC related functions
+error_t sam3xEthInit(NetInterface *interface);
+void sam3xEthInitGpio(NetInterface *interface);
+void sam3xEthInitBufferDesc(NetInterface *interface);
+
+void sam3xEthTick(NetInterface *interface);
+
+void sam3xEthEnableIrq(NetInterface *interface);
+void sam3xEthDisableIrq(NetInterface *interface);
+void sam3xEthEventHandler(NetInterface *interface);
+
+error_t sam3xEthSendPacket(NetInterface *interface,
+   const NetBuffer *buffer, size_t offset);
+
+error_t sam3xEthReceivePacket(NetInterface *interface);
+
+error_t sam3xEthSetMulticastFilter(NetInterface *interface);
+error_t sam3xEthUpdateMacConfig(NetInterface *interface);
+
+void sam3xEthWritePhyReg(uint8_t phyAddr, uint8_t regAddr, uint16_t data);
+uint16_t sam3xEthReadPhyReg(uint8_t phyAddr, uint8_t regAddr);
+
+#endif
+