bertos/cpu/arm/drv/eth_at91.c

   1 /**
   2   * \file
   3   * <!--
   4   * This file is part of BeRTOS.
   5   *
   6   * Bertos is free software; you can redistribute it and/or modify
   7   * it under the terms of the GNU General Public License as published by
   8   * the Free Software Foundation; either version 2 of the License, or
   9   * (at your option) any later version.
  10   *
  11   * This program is distributed in the hope that it will be useful,
  12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   * GNU General Public License for more details.
  15   *
  16   * You should have received a copy of the GNU General Public License
  17   * along with this program; if not, write to the Free Software
  18   * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19   *
  20   * As a special exception, you may use this file as part of a free software
  21   * library without restriction.  Specifically, if other files instantiate
  22   * templates or use macros or inline functions from this file, or you compile
  23   * this file and link it with other files to produce an executable, this
  24   * file does not by itself cause the resulting executable to be covered by
  25   * the GNU General Public License.  This exception does not however
  26   * invalidate any other reasons why the executable file might be covered by
  27   * the GNU General Public License.
  28   *
  29   * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
  30   * All Rights Reserved.
  31   * -->
  32   *
  33   * \brief EMAC driver for AT91SAM7X Family.
  34   *
  35   * \author Daniele Basile <asterix@develer.com>
  36   * \author Andrea Righi <arighi@develer.com>
  37   */
  38
  39 #include "cfg/cfg_eth.h"
  40
  41 #define LOG_LEVEL  ETH_LOG_LEVEL
  42 #define LOG_FORMAT ETH_LOG_FORMAT
  43
  44 #include <cfg/log.h>
  45
  46 #include <cfg/debug.h>
  47 #include <cfg/log.h>
  48 #include <cfg/macros.h>
  49 #include <cfg/compiler.h>
  50
  51 #include <io/at91sam7.h>
  52 #include <io/arm.h>
  53
  54 #include <cpu/power.h>
  55 #include <cpu/types.h>
  56 #include <cpu/irq.h>
  57
  58 #include <drv/timer.h>
  59 #include <drv/eth.h>
  60
  61 #include <mware/event.h>
  62
  63 #include <string.h>
  64
  65 #include "eth_at91.h"
  66
  67 #define EMAC_RX_INTS    (BV(EMAC_RCOMP) | BV(EMAC_ROVR) | BV(EMAC_RXUBR))
  68 #define EMAC_TX_INTS    (BV(EMAC_TCOMP) | BV(EMAC_TXUBR) | BV(EMAC_RLEX))
  69
  70 /* Silent Doxygen bug... */
  71 #ifndef __doxygen__
  72 /*
  73  * NOTE: this buffer should be declared as 'volatile' because it is read by the
  74  * hardware. However, this is accessed only via memcpy() that should guarantee
  75  * coherency when copying from/to buffers.
  76  */
  77 static uint8_t tx_buf[EMAC_TX_BUFFERS * EMAC_TX_BUFSIZ] ALIGNED(8);
  78 static volatile BufDescriptor tx_buf_tab[EMAC_TX_DESCRIPTORS] ALIGNED(8);
  79
  80 /*
  81  * NOTE: this buffer should be declared as 'volatile' because it is wrote by
  82  * the hardware. However, this is accessed only via memcpy() that should
  83  * guarantee coherency when copying from/to buffers.
  84  */
  85 static uint8_t rx_buf[EMAC_RX_BUFFERS * EMAC_RX_BUFSIZ] ALIGNED(8);
  86 static volatile BufDescriptor rx_buf_tab[EMAC_RX_DESCRIPTORS] ALIGNED(8);
  87 #endif
  88
  89 static int tx_buf_idx;
  90 static int tx_buf_offset;
  91 static int rx_buf_idx;
  92
  93 static Event recv_wait, send_wait;
  94
  95 static DECLARE_ISR(emac_irqHandler)
  96 {
  97         /* Read interrupt status and disable interrupts. */
  98         uint32_t isr = EMAC_ISR;
  99
 100         /* Receiver interrupt */
 101         if ((isr & EMAC_RX_INTS))
 102         {
 103                 if (isr & BV(EMAC_RCOMP))
 104                         event_do(&recv_wait);
 105                 EMAC_RSR = EMAC_RX_INTS;
 106         }
 107         /* Transmitter interrupt */
 108         if (isr & EMAC_TX_INTS)
 109         {
 110                 if (isr & BV(EMAC_TCOMP))
 111                         event_do(&send_wait);
 112                 EMAC_TSR = EMAC_TX_INTS;
 113         }
 114         AIC_EOICR = 0;
 115 }
 116
 117 /*
 118  * \brief Read contents of PHY register.
 119  *
 120  * \param reg PHY register number.
 121  *
 122  * \return Contents of the specified register.
 123  */
 124 static uint16_t phy_hw_read(reg8_t reg)
 125 {
 126         // PHY read command.
 127         EMAC_MAN = EMAC_SOF | EMAC_RW_READ | (NIC_PHY_ADDR << EMAC_PHYA_SHIFT)
 128                         | ((reg  << EMAC_REGA_SHIFT) & EMAC_REGA) | EMAC_CODE;
 129
 130         // Wait until PHY logic completed.
 131         while (!(EMAC_NSR & BV(EMAC_IDLE)))
 132                 cpu_relax();
 133
 134         // Get data from PHY maintenance register.
 135         return (uint16_t)(EMAC_MAN & EMAC_DATA);
 136 }
 137
 138 /*
 139  * \brief Write value to PHY register.
 140  *
 141  * \param reg PHY register number.
 142  * \param val Value to write.
 143  */
 144 static void phy_hw_write(reg8_t reg, uint16_t val)
 145 {
 146         // PHY write command.
 147         EMAC_MAN = EMAC_SOF | EMAC_RW_WRITE | (NIC_PHY_ADDR << EMAC_PHYA_SHIFT)
 148                         | ((reg  << EMAC_REGA_SHIFT) & EMAC_REGA) | EMAC_CODE | val;
 149
 150         // Wait until PHY logic completed.
 151         while (!(EMAC_NSR & BV(EMAC_IDLE)))
 152                 cpu_relax();
 153 }
 154
 155 static int emac_reset(void)
 156 {
 157         uint16_t phy_cr;
 158
 159         // Enable devices
 160         PMC_PCER = BV(PIOA_ID);
 161         PMC_PCER = BV(PIOB_ID);
 162         PMC_PCER = BV(EMAC_ID);
 163
 164         // Disable RMII and TESTMODE by disabling pull-ups.
 165         PIOB_PUDR = BV(PHY_COL_RMII_BIT) | BV(PHY_RXDV_TESTMODE_BIT);
 166
 167         // Disable PHY power down.
 168         PIOB_PER  = BV(PHY_PWRDN_BIT);
 169         PIOB_OER  = BV(PHY_PWRDN_BIT);
 170         PIOB_CODR = BV(PHY_PWRDN_BIT);
 171
 172         // Toggle external hardware reset pin.
 173         RSTC_MR = RSTC_KEY | (1 << RSTC_ERSTL_SHIFT) | BV(RSTC_URSTEN);
 174         RSTC_CR = RSTC_KEY | BV(RSTC_EXTRST);
 175
 176         while ((RSTC_SR & BV(RSTC_NRSTL)) == 0)
 177                 cpu_relax();
 178
 179         // Configure MII port.
 180         PIOB_ASR = PHY_MII_PINS;
 181         PIOB_BSR = 0;
 182         PIOB_PDR = PHY_MII_PINS;
 183
 184         // Enable receive and transmit clocks.
 185         EMAC_USRIO = BV(EMAC_CLKEN);
 186
 187         // Enable management port.
 188         EMAC_NCR |= BV(EMAC_MPE);
 189         EMAC_NCFGR |= EMAC_CLK_HCLK_32;
 190
 191         // Set local MAC address.
 192         EMAC_SA1L = (mac_addr[3] << 24) | (mac_addr[2] << 16) |
 193                                 (mac_addr[1] << 8) | mac_addr[0];
 194         EMAC_SA1H = (mac_addr[5] << 8) | mac_addr[4];
 195
 196         // Wait for PHY ready
 197         timer_delay(255);
 198
 199         // Clear MII isolate.
 200         phy_hw_read(NIC_PHY_BMCR);
 201         phy_cr = phy_hw_read(NIC_PHY_BMCR);
 202
 203         phy_cr &= ~NIC_PHY_BMCR_ISOLATE;
 204         phy_hw_write(NIC_PHY_BMCR, phy_cr);
 205
 206         phy_cr = phy_hw_read(NIC_PHY_BMCR);
 207
 208         LOG_INFO("%s: PHY ID %#04x %#04x\n",
 209                 __func__,
 210                 phy_hw_read(NIC_PHY_ID1), phy_hw_read(NIC_PHY_ID2));
 211
 212         // Wait for auto negotiation completed.
 213         phy_hw_read(NIC_PHY_BMSR);
 214         for (;;)
 215         {
 216                 if (phy_hw_read(NIC_PHY_BMSR) & NIC_PHY_BMSR_ANCOMPL)
 217                         break;
 218                 cpu_relax();
 219         }
 220
 221         // Disable management port.
 222         EMAC_NCR &= ~BV(EMAC_MPE);
 223
 224         return 0;
 225 }
 226
 227 static int emac_start(void)
 228 {
 229         uint32_t addr;
 230         int i;
 231
 232         for (i = 0; i < EMAC_RX_DESCRIPTORS; i++)
 233         {
 234                 addr = (uint32_t)(rx_buf + (i * EMAC_RX_BUFSIZ));
 235                 rx_buf_tab[i].addr = addr & BUF_ADDRMASK;
 236         }
 237         rx_buf_tab[EMAC_RX_DESCRIPTORS - 1].addr |= RXBUF_WRAP;
 238
 239         for (i = 0; i < EMAC_TX_DESCRIPTORS; i++)
 240         {
 241                 addr = (uint32_t)(tx_buf + (i * EMAC_TX_BUFSIZ));
 242                 tx_buf_tab[i].addr = addr & BUF_ADDRMASK;
 243                 tx_buf_tab[i].stat = TXS_USED;
 244         }
 245         tx_buf_tab[EMAC_TX_DESCRIPTORS - 1].stat = TXS_USED | TXS_WRAP;
 246
 247         /* Tell the EMAC where to find the descriptors. */
 248         EMAC_RBQP = (uint32_t)rx_buf_tab;
 249         EMAC_TBQP = (uint32_t)tx_buf_tab;
 250
 251         /* Clear receiver status. */
 252         EMAC_RSR = BV(EMAC_OVR) | BV(EMAC_REC) | BV(EMAC_BNA);
 253
 254         /* Copy all frames and discard FCS. */
 255         EMAC_NCFGR |= BV(EMAC_CAF) | BV(EMAC_DRFCS);
 256
 257         /* Enable receiver, transmitter and statistics. */
 258         EMAC_NCR |= BV(EMAC_TE) | BV(EMAC_RE) | BV(EMAC_WESTAT);
 259
 260         return 0;
 261 }
 262
 263 ssize_t eth_putFrame(const uint8_t *buf, size_t len)
 264 {
 265         size_t wr_len;
 266
 267         if (UNLIKELY(!len))
 268                 return -1;
 269         ASSERT(len <= sizeof(tx_buf));
 270
 271         /* Check if the transmit buffer is available */
 272         while (!(tx_buf_tab[tx_buf_idx].stat & TXS_USED))
 273                 event_wait(&send_wait);
 274
 275         /* Copy the data into the buffer and prepare descriptor */
 276         wr_len = MIN(len, (size_t)EMAC_TX_BUFSIZ - tx_buf_offset);
 277         memcpy((uint8_t *)tx_buf_tab[tx_buf_idx].addr + tx_buf_offset,
 278                                 buf, wr_len);
 279         tx_buf_offset += wr_len;
 280
 281         return wr_len;
 282 }
 283
 284 void eth_sendFrame(void)
 285 {
 286         tx_buf_tab[tx_buf_idx].stat = (tx_buf_offset & TXS_LENGTH_FRAME) |
 287                         TXS_LAST_BUFF |
 288                         ((tx_buf_idx == EMAC_TX_DESCRIPTORS - 1) ?  TXS_WRAP : 0);
 289         EMAC_NCR |= BV(EMAC_TSTART);
 290
 291         tx_buf_offset = 0;
 292         if (++tx_buf_idx >= EMAC_TX_DESCRIPTORS)
 293                 tx_buf_idx = 0;
 294 }
 295
 296 ssize_t eth_send(const uint8_t *buf, size_t len)
 297  {
 298         if (UNLIKELY(!len))
 299                 return -1;
 300
 301         len = eth_putFrame(buf, len);
 302         eth_sendFrame();
 303
 304         return len;
 305 }
 306
 307 static void eth_buf_realign(int idx)
 308 {
 309         /* Empty buffer found. Realign. */
 310         do {
 311                 rx_buf_tab[rx_buf_idx].addr &= ~RXBUF_OWNERSHIP;
 312                 if (++rx_buf_idx >= EMAC_RX_BUFFERS)
 313                         rx_buf_idx = 0;
 314         } while (idx != rx_buf_idx);
 315 }
 316
 317 static size_t __eth_getFrameLen(void)
 318 {
 319         int idx, n = EMAC_RX_BUFFERS;
 320
 321 skip:
 322         /* Skip empty buffers */
 323         while ((n > 0) && !(rx_buf_tab[rx_buf_idx].addr & RXBUF_OWNERSHIP))
 324         {
 325                 if (++rx_buf_idx >= EMAC_RX_BUFFERS)
 326                         rx_buf_idx = 0;
 327                 n--;
 328         }
 329         if (UNLIKELY(!n))
 330         {
 331                 LOG_INFO("no frame found\n");
 332                 return 0;
 333         }
 334         /* Search the start of frame and cleanup fragments */
 335         while ((n > 0) && (rx_buf_tab[rx_buf_idx].addr & RXBUF_OWNERSHIP) &&
 336                         !(rx_buf_tab[rx_buf_idx].stat & RXS_SOF))
 337         {
 338                 rx_buf_tab[rx_buf_idx].addr &= ~RXBUF_OWNERSHIP;
 339                 if (++rx_buf_idx >= EMAC_RX_BUFFERS)
 340                         rx_buf_idx = 0;
 341                 n--;
 342         }
 343         if (UNLIKELY(!n))
 344         {
 345                 LOG_INFO("no SOF found\n");
 346                 return 0;
 347         }
 348         /* Search end of frame to evaluate the total frame size */
 349         idx = rx_buf_idx;
 350 restart:
 351         while (n > 0)
 352         {
 353                 if (UNLIKELY(!(rx_buf_tab[idx].addr & RXBUF_OWNERSHIP)))
 354                 {
 355                         /* Empty buffer found. Realign. */
 356                         eth_buf_realign(idx);
 357                         goto skip;
 358                 }
 359                 if (rx_buf_tab[idx].stat & RXS_EOF)
 360                         return rx_buf_tab[idx].stat & RXS_LENGTH_FRAME;
 361                 if (UNLIKELY((idx != rx_buf_idx) &&
 362                                 (rx_buf_tab[idx].stat & RXS_SOF)))
 363                 {
 364                         /* Another start of frame found. Realign. */
 365                         eth_buf_realign(idx);
 366                         goto restart;
 367                 }
 368                 if (++idx >= EMAC_RX_BUFFERS)
 369                         idx = 0;
 370                 n--;
 371         }
 372         LOG_INFO("no EOF found\n");
 373         return 0;
 374 }
 375
 376 size_t eth_getFrameLen(void)
 377 {
 378         size_t len;
 379
 380         /* Check if there is at least one available frame in the buffer */
 381         while (1)
 382         {
 383                 len = __eth_getFrameLen();
 384                 if (LIKELY(len))
 385                         break;
 386                 /* Wait for RX interrupt */
 387                 event_wait(&recv_wait);
 388         }
 389         return len;
 390 }
 391
 392 ssize_t eth_getFrame(uint8_t *buf, size_t len)
 393 {
 394         uint8_t *addr;
 395         size_t rd_len = 0;
 396
 397         if (UNLIKELY(!len))
 398                 return -1;
 399         ASSERT(len <= sizeof(rx_buf));
 400
 401         /* Copy data from the RX buffer */
 402         addr = (uint8_t *)(rx_buf_tab[rx_buf_idx].addr & BUF_ADDRMASK);
 403         if (addr + len > &rx_buf[countof(rx_buf)])
 404         {
 405                 size_t count = &rx_buf[countof(rx_buf)] - addr;
 406
 407                 memcpy(buf, addr, count);
 408                 memcpy(buf + count, rx_buf, len - count);
 409         }
 410         else
 411         {
 412                 memcpy(buf, addr, len);
 413         }
 414         /* Update descriptors */
 415         while (rd_len < len)
 416         {
 417                 if (len - rd_len >= EMAC_RX_BUFSIZ)
 418                         rd_len += EMAC_RX_BUFSIZ;
 419                 else
 420                         rd_len += len - rd_len;
 421                 if (UNLIKELY(!(rx_buf_tab[rx_buf_idx].addr & RXBUF_OWNERSHIP)))
 422                 {
 423                         LOG_INFO("bad frame found\n");
 424                         return 0;
 425                 }
 426                 rx_buf_tab[rx_buf_idx].addr &= ~RXBUF_OWNERSHIP;
 427                 if (++rx_buf_idx >= EMAC_RX_DESCRIPTORS)
 428                         rx_buf_idx = 0;
 429         }
 430
 431         return rd_len;
 432 }
 433
 434 ssize_t eth_recv(uint8_t *buf, size_t len)
 435 {
 436         if (UNLIKELY(!len))
 437                 return -1;
 438         len = MIN(len, eth_getFrameLen());
 439         return len ? eth_getFrame(buf, len) : 0;
 440 }
 441
 442 int eth_init()
 443 {
 444         cpu_flags_t flags;
 445
 446         emac_reset();
 447         emac_start();
 448
 449         event_initGeneric(&recv_wait);
 450         event_initGeneric(&send_wait);
 451
 452         // Register interrupt vector
 453         IRQ_SAVE_DISABLE(flags);
 454
 455         /* Disable all emac interrupts */
 456         EMAC_IDR = 0xFFFFFFFF;
 457
 458         /* Set the vector. */
 459         AIC_SVR(EMAC_ID) = emac_irqHandler;
 460         /* Initialize to edge triggered with defined priority. */
 461         AIC_SMR(EMAC_ID) = AIC_SRCTYPE_INT_EDGE_TRIGGERED;
 462         /* Clear pending interrupt */
 463         AIC_ICCR = BV(EMAC_ID);
 464         /* Enable the system IRQ */
 465         AIC_IECR = BV(EMAC_ID);
 466
 467         /* Enable interrupts */
 468         EMAC_IER = EMAC_RX_INTS | EMAC_TX_INTS;
 469
 470         IRQ_RESTORE(flags);
 471
 472         return 0;
 473 }