git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/portable/NetworkInterface/M487/m480_eth.h

   1 /**************************************************************************//**\r
   2  * @copyright (C) 2019 Nuvoton Technology Corp. All rights reserved.\r
   3  * \r
   4  * Redistribution and use in source and binary forms, with or without modification,\r
   5  * are permitted provided that the following conditions are met:\r
   6  *   1. Redistributions of source code must retain the above copyright notice,\r
   7  *      this list of conditions and the following disclaimer.\r
   8  *   2. Redistributions in binary form must reproduce the above copyright notice,\r
   9  *      this list of conditions and the following disclaimer in the documentation\r
  10  *      and/or other materials provided with the distribution.\r
  11  *   3. Neither the name of Nuvoton Technology Corp. nor the names of its contributors\r
  12  *      may be used to endorse or promote products derived from this software\r
  13  *      without specific prior written permission.\r
  14  * \r
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"\r
  16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
  18  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\r
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\r
  21  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\r
  22  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\r
  23  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\r
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  25 *****************************************************************************/\r
  26 #include "M480.h"\r
  27 #ifndef  _M480_ETH_\r
  28 #define  _M480_ETH_\r
  29 \r
  30 /* Generic MII registers. */\r
  31 \r
  32 #define MII_BMCR            0x00        /* Basic mode control register */\r
  33 #define MII_BMSR            0x01        /* Basic mode status register  */\r
  34 #define MII_PHYSID1         0x02        /* PHYS ID 1                   */\r
  35 #define MII_PHYSID2         0x03        /* PHYS ID 2                   */\r
  36 #define MII_ADVERTISE       0x04        /* Advertisement control reg   */\r
  37 #define MII_LPA             0x05        /* Link partner ability reg    */\r
  38 #define MII_EXPANSION       0x06        /* Expansion register          */\r
  39 #define MII_DCOUNTER        0x12        /* Disconnect counter          */\r
  40 #define MII_FCSCOUNTER      0x13        /* False carrier counter       */\r
  41 #define MII_NWAYTEST        0x14        /* N-way auto-neg test reg     */\r
  42 #define MII_RERRCOUNTER     0x15        /* Receive error counter       */\r
  43 #define MII_SREVISION       0x16        /* Silicon revision            */\r
  44 #define MII_RESV1           0x17        /* Reserved...                 */\r
  45 #define MII_LBRERROR        0x18        /* Lpback, rx, bypass error    */\r
  46 #define MII_PHYADDR         0x19        /* PHY address                 */\r
  47 #define MII_RESV2           0x1a        /* Reserved...                 */\r
  48 #define MII_TPISTATUS       0x1b        /* TPI status for 10mbps       */\r
  49 #define MII_NCONFIG         0x1c        /* Network interface config    */\r
  50 \r
  51 /* Basic mode control register. */\r
  52 #define BMCR_RESV               0x007f  /* Unused...                   */\r
  53 #define BMCR_CTST               0x0080  /* Collision test              */\r
  54 #define BMCR_FULLDPLX           0x0100  /* Full duplex                 */\r
  55 #define BMCR_ANRESTART          0x0200  /* Auto negotiation restart    */\r
  56 #define BMCR_ISOLATE            0x0400  /* Disconnect DP83840 from MII */\r
  57 #define BMCR_PDOWN              0x0800  /* Powerdown the DP83840       */\r
  58 #define BMCR_ANENABLE           0x1000  /* Enable auto negotiation     */\r
  59 #define BMCR_SPEED100           0x2000  /* Select 100Mbps              */\r
  60 #define BMCR_LOOPBACK           0x4000  /* TXD loopback bits           */\r
  61 #define BMCR_RESET              0x8000  /* Reset the DP83840           */\r
  62 \r
  63 /* Basic mode status register. */\r
  64 #define BMSR_ERCAP              0x0001  /* Ext-reg capability          */\r
  65 #define BMSR_JCD                0x0002  /* Jabber detected             */\r
  66 #define BMSR_LSTATUS            0x0004  /* Link status                 */\r
  67 #define BMSR_ANEGCAPABLE        0x0008  /* Able to do auto-negotiation */\r
  68 #define BMSR_RFAULT             0x0010  /* Remote fault detected       */\r
  69 #define BMSR_ANEGCOMPLETE       0x0020  /* Auto-negotiation complete   */\r
  70 #define BMSR_RESV               0x07c0  /* Unused...                   */\r
  71 #define BMSR_10HALF             0x0800  /* Can do 10mbps, half-duplex  */\r
  72 #define BMSR_10FULL             0x1000  /* Can do 10mbps, full-duplex  */\r
  73 #define BMSR_100HALF            0x2000  /* Can do 100mbps, half-duplex */\r
  74 #define BMSR_100FULL            0x4000  /* Can do 100mbps, full-duplex */\r
  75 #define BMSR_100BASE4           0x8000  /* Can do 100mbps, 4k packets  */\r
  76 \r
  77 /* Advertisement control register. */\r
  78 #define ADVERTISE_SLCT          0x001f  /* Selector bits               */\r
  79 #define ADVERTISE_CSMA          0x0001  /* Only selector supported     */\r
  80 #define ADVERTISE_10HALF        0x0020  /* Try for 10mbps half-duplex  */\r
  81 #define ADVERTISE_10FULL        0x0040  /* Try for 10mbps full-duplex  */\r
  82 #define ADVERTISE_100HALF       0x0080  /* Try for 100mbps half-duplex */\r
  83 #define ADVERTISE_100FULL       0x0100  /* Try for 100mbps full-duplex */\r
  84 #define ADVERTISE_100BASE4      0x0200  /* Try for 100mbps 4k packets  */\r
  85 #define ADVERTISE_RESV          0x1c00  /* Unused...                   */\r
  86 #define ADVERTISE_RFAULT        0x2000  /* Say we can detect faults    */\r
  87 #define ADVERTISE_LPACK         0x4000  /* Ack link partners response  */\r
  88 #define ADVERTISE_NPAGE         0x8000  /* Next page bit               */\r
  89 \r
  90 #define RX_DESCRIPTOR_NUM       4 //8    // Max Number of Rx Frame Descriptors\r
  91 #define TX_DESCRIPTOR_NUM       2 //4    // Max number of Tx Frame Descriptors\r
  92 \r
  93 #define PACKET_BUFFER_SIZE      1520\r
  94 \r
  95 #define CONFIG_PHY_ADDR     1\r
  96 \r
  97 \r
  98 // Frame Descriptor's Owner bit\r
  99 #define OWNERSHIP_EMAC 0x80000000  // 1 = EMAC\r
 100 //#define OWNERSHIP_CPU 0x7fffffff  // 0 = CPU\r
 101 \r
 102 \r
 103 \r
 104 // Rx Frame Descriptor Status\r
 105 #define RXFD_RXGD    0x00100000  // Receiving Good Packet Received\r
 106 #define RXFD_RTSAS   0x00800000  // RX Time Stamp Available \r
 107 \r
 108 \r
 109 // Tx Frame Descriptor's Control bits\r
 110 #define TXFD_TTSEN    0x08    // Tx Time Stamp Enable\r
 111 #define TXFD_INTEN    0x04    // Interrupt Enable\r
 112 #define TXFD_CRCAPP   0x02    // Append CRC\r
 113 #define TXFD_PADEN    0x01    // Padding Enable\r
 114 \r
 115 // Tx Frame Descriptor Status\r
 116 #define TXFD_TXCP    0x00080000  // Transmission Completion\r
 117 #define TXFD_TTSAS   0x08000000  // TX Time Stamp Available\r
 118 \r
 119 // Tx/Rx buffer descriptor structure\r
 120 struct eth_descriptor;\r
 121 struct eth_descriptor {\r
 122     uint32_t  status1;\r
 123     uint8_t *buf;\r
 124     uint32_t  status2;\r
 125     struct eth_descriptor *next;\r
 126 #ifdef TIME_STAMPING\r
 127     uint32_t backup1;\r
 128     uint32_t backup2;\r
 129     uint32_t reserved1;\r
 130     uint32_t reserved2;\r
 131 #endif\r
 132 };\r
 133 \r
 134 #ifdef TIME_STAMPING\r
 135 \r
 136 #define ETH_TS_ENABLE() do{EMAC->TSCTL = EMAC_TSCTL_TSEN_Msk;}while(0)\r
 137 #define ETH_TS_START() do{EMAC->TSCTL |= (EMAC_TSCTL_TSMODE_Msk | EMAC_TSCTL_TSIEN_Msk);}while(0)\r
 138 s32_t ETH_settime(u32_t sec, u32_t nsec);\r
 139 s32_t ETH_gettime(u32_t *sec, u32_t *nsec);\r
 140 s32_t ETH_updatetime(u32_t neg, u32_t sec, u32_t nsec);\r
 141 s32_t ETH_adjtimex(int ppm);\r
 142 void ETH_setinc(void);\r
 143 \r
 144 #endif\r
 145 \r
 146 #ifdef NU_TRACE\r
 147 #define NU_DEBUGF(x) { printf x; }\r
 148 #else\r
 149 #define NU_DEBUGF(x)\r
 150 #endif\r
 151 \r
 152 void numaker_set_mac_addr(uint8_t *addr);\r
 153 int numaker_eth_init(uint8_t *mac_addr);\r
 154 uint8_t *numaker_eth_get_tx_buf(void);\r
 155 void numaker_eth_trigger_tx(uint16_t length, void *p);\r
 156 int numaker_eth_get_rx_buf(uint16_t *len, uint8_t **buf);\r
 157 void numaker_eth_rx_next(void);\r
 158 void numaker_eth_trigger_rx(void);\r
 159 int numaker_eth_link_ok(void);\r
 160 void numaker_mac_address(uint8_t *mac);\r
 161 void numaker_eth_enable_interrupts(void);\r
 162 void numaker_eth_disable_interrupts(void);\r
 163 \r
 164 #endif  /* _M480_ETH_ */\r