bertos/cpu/cortex-m3/drv/eth_sam3.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,2011 Develer S.r.l. (http://www.develer.com/)
  30   * All Rights Reserved.
  31   * -->
  32   *
  33   * \brief EMAC driver for AT91SAM family with Davicom 9161A phy.
  34   *
  35   * \author Daniele Basile <asterix@develer.com>
  36   * \author Andrea Righi <arighi@develer.com>
  37   * \author Stefano Fedrigo <aleph@develer.com>
  38   */
  39
  40 #include "cfg/cfg_eth.h"
  41
  42 #define LOG_LEVEL  ETH_LOG_LEVEL
  43 #define LOG_FORMAT ETH_LOG_FORMAT
  44
  45 #include <cfg/log.h>
  46
  47 #include <cfg/debug.h>
  48 #include <cfg/log.h>
  49 #include <cfg/macros.h>
  50 #include <cfg/compiler.h>
  51
  52 // TODO: unify includes
  53 //#include <io/at91sam7.h>
  54 //#include <io/arm.h>
  55 //#include <io/include.h>
  56 #include <io/sam3.h>
  57 #include <drv/irq_cm3.h>
  58
  59 #include <cpu/power.h>
  60 #include <cpu/types.h>
  61 #include <cpu/irq.h>
  62
  63 #include <drv/timer.h>
  64 #include <drv/eth.h>
  65
  66 #include <mware/event.h>
  67
  68 #include <string.h>
  69
  70 #include "eth_sam3.h"
  71
  72 #define EMAC_RX_INTS    (BV(EMAC_RCOMP) | BV(EMAC_ROVR) | BV(EMAC_RXUBR))
  73 #define EMAC_TX_INTS    (BV(EMAC_TCOMP) | BV(EMAC_TXUBR) | BV(EMAC_RLEX))
  74
  75 /* Silent Doxygen bug... */
  76 #ifndef __doxygen__
  77 /*
  78  * NOTE: this buffer should be declared as 'volatile' because it is read by the
  79  * hardware. However, this is accessed only via memcpy() that should guarantee
  80  * coherency when copying from/to buffers.
  81  */
  82 static uint8_t tx_buf[EMAC_TX_BUFFERS * EMAC_TX_BUFSIZ] ALIGNED(8);
  83 static volatile BufDescriptor tx_buf_tab[EMAC_TX_DESCRIPTORS] ALIGNED(8);
  84
  85 /*
  86  * NOTE: this buffer should be declared as 'volatile' because it is wrote by
  87  * the hardware. However, this is accessed only via memcpy() that should
  88  * guarantee coherency when copying from/to buffers.
  89  */
  90 static uint8_t rx_buf[EMAC_RX_BUFFERS * EMAC_RX_BUFSIZ] ALIGNED(8);
  91 static volatile BufDescriptor rx_buf_tab[EMAC_RX_DESCRIPTORS] ALIGNED(8);
  92 #endif
  93
  94 static int tx_buf_idx;
  95 static int tx_buf_offset;
  96 static int rx_buf_idx;
  97
  98 static Event recv_wait, send_wait;
  99
 100 static DECLARE_ISR(emac_irqHandler)
 101 {
 102         /* Read interrupt status and disable interrupts. */
 103         uint32_t isr = EMAC_ISR;
 104
 105         /* Receiver interrupt */
 106         if ((isr & EMAC_RX_INTS))
 107         {
 108                 if (isr & BV(EMAC_RCOMP))
 109                         event_do(&recv_wait);
 110                 EMAC_RSR = EMAC_RX_INTS;
 111         }
 112         /* Transmitter interrupt */
 113         if (isr & EMAC_TX_INTS)
 114         {
 115                 if (isr & BV(EMAC_TCOMP))
 116                         event_do(&send_wait);
 117                 EMAC_TSR = EMAC_TX_INTS;
 118         }
 119         //AIC_EOICR = 0;
 120 }
 121
 122 /*
 123  * \brief Read contents of PHY register.
 124  *
 125  * \param reg PHY register number.
 126  *
 127  * \return Contents of the specified register.
 128  */
 129 static uint16_t phy_hw_read(uint8_t phy_addr, reg8_t reg)
 130 {
 131         // PHY read command.
 132         EMAC_MAN = EMAC_SOF | EMAC_RW_READ
 133                 | ((phy_addr << EMAC_PHYA_SHIFT) & EMAC_PHYA)
 134                 | ((reg  << EMAC_REGA_SHIFT) & EMAC_REGA)
 135                 | EMAC_CODE;
 136
 137         // Wait until PHY logic completed.
 138         while (!(EMAC_NSR & BV(EMAC_IDLE)))
 139                 cpu_relax();
 140
 141         // Get data from PHY maintenance register.
 142         return (uint16_t)(EMAC_MAN & EMAC_DATA);
 143 }
 144
 145 #if 0
 146 /*
 147  * \brief Write value to PHY register.
 148  *
 149  * \param reg PHY register number.
 150  * \param val Value to write.
 151  */
 152 static void phy_hw_write(uint8_t phy_addr, reg8_t reg, uint16_t val)
 153 {
 154         // PHY write command.
 155         EMAC_MAN = EMAC_SOF | EMAC_RW_WRITE
 156                 | ((phy_addr << EMAC_PHYA_SHIFT) & EMAC_PHYA)
 157                 | ((reg  << EMAC_REGA_SHIFT) & EMAC_REGA)
 158                 | EMAC_CODE | val;
 159
 160         // Wait until PHY logic completed.
 161         while (!(EMAC_NSR & BV(EMAC_IDLE)))
 162                 cpu_relax();
 163 }
 164 #endif
 165
 166 /*
 167  * Check link speed and duplex as negotiated by the PHY
 168  * and configure CPU EMAC accordingly.
 169  * Requires active PHY maintenance mode.
 170  */
 171 static void emac_autoNegotiation(void)
 172 {
 173         uint16_t reg;
 174         time_t start;
 175
 176         // Wait for auto-negotation to complete
 177         start = timer_clock();
 178         do {
 179                 reg = phy_hw_read(NIC_PHY_ADDR, NIC_PHY_BMSR);
 180                 if (timer_clock() - start > 2000)
 181                 {
 182                         kprintf("eth error: auto-negotiation timeout\n");
 183                         return;
 184                 }
 185         }
 186         while (!(reg & NIC_PHY_BMSR_ANCOMPL));
 187
 188         reg = phy_hw_read(NIC_PHY_ADDR, NIC_PHY_ANLPAR);
 189
 190         if ((reg & NIC_PHY_ANLPAR_TX_FDX) || (reg & NIC_PHY_ANLPAR_TX_HDX))
 191         {
 192                 LOG_INFO("eth: 100BASE-TX\n");
 193                 EMAC_NCFGR |= BV(EMAC_SPD);
 194         }
 195         else
 196         {
 197                 LOG_INFO("eth: 10BASE-T\n");
 198                 EMAC_NCFGR &= ~BV(EMAC_SPD);
 199         }
 200
 201         if ((reg & NIC_PHY_ANLPAR_TX_FDX) || (reg & NIC_PHY_ANLPAR_10_FDX))
 202         {
 203                 LOG_INFO("eth: full duplex\n");
 204                 EMAC_NCFGR |= BV(EMAC_FD);
 205         }
 206         else
 207         {
 208                 LOG_INFO("eth: half duplex\n");
 209                 EMAC_NCFGR &= ~BV(EMAC_FD);
 210         }
 211 }
 212
 213
 214 static int emac_reset(void)
 215 {
 216 #if CPU_ARM_AT91
 217         // Enable devices
 218         PMC_PCER = BV(PIOA_ID);
 219         PMC_PCER = BV(PIOB_ID);
 220         PMC_PCER = BV(EMAC_ID);
 221
 222         // Disable TESTMODE and RMII
 223         PIOB_PUDR = BV(PHY_RXDV_TESTMODE_BIT);
 224         PIOB_PUDR = BV(PHY_COL_RMII_BIT);
 225
 226         // Disable PHY power down.
 227         PIOB_PER  = BV(PHY_PWRDN_BIT);
 228         PIOB_OER  = BV(PHY_PWRDN_BIT);
 229         PIOB_CODR = BV(PHY_PWRDN_BIT);
 230 #else
 231         pmc_periphEnable(PIOA_ID);
 232         pmc_periphEnable(PIOB_ID);
 233         pmc_periphEnable(PIOC_ID);
 234         pmc_periphEnable(PIOD_ID);
 235         pmc_periphEnable(EMAC_ID);
 236
 237         // Disable TESTMODE
 238         PIOB_PUDR = BV(PHY_RXDV_TESTMODE_BIT);
 239 #endif
 240
 241         // Toggle external hardware reset pin.
 242         RSTC_MR = RSTC_KEY | (1 << RSTC_ERSTL_SHIFT) | BV(RSTC_URSTEN);
 243         RSTC_CR = RSTC_KEY | BV(RSTC_EXTRST);
 244
 245         while ((RSTC_SR & BV(RSTC_NRSTL)) == 0)
 246                 cpu_relax();
 247
 248         // Configure MII ports.
 249 #if CPU_ARM_AT91
 250         PIOB_ASR = PHY_MII_PINS;
 251         PIOB_BSR = 0;
 252         PIOB_PDR = PHY_MII_PINS;
 253
 254         // Enable receive and transmit clocks.
 255         EMAC_USRIO = BV(EMAC_CLKEN);
 256 #else
 257         PIO_PERIPH_SEL(PIOB_BASE, PHY_MII_PINS_PORTB, PIO_PERIPH_A);
 258         PIOB_PDR = PHY_MII_PINS_PORTB;
 259
 260         // Enable receive, transmit clocks and RMII mode.
 261         EMAC_USRIO = BV(EMAC_CLKEN) | BV(EMAC_RMII);
 262 #endif
 263
 264         // Enable management port.
 265         EMAC_NCR |= BV(EMAC_MPE);
 266         EMAC_NCFGR |= EMAC_CLK_HCLK_64;
 267
 268         // Set local MAC address.
 269         EMAC_SA1L = (mac_addr[3] << 24) | (mac_addr[2] << 16) |
 270                                 (mac_addr[1] << 8) | mac_addr[0];
 271         EMAC_SA1H = (mac_addr[5] << 8) | mac_addr[4];
 272
 273         emac_autoNegotiation();
 274
 275         // Disable management port.
 276         EMAC_NCR &= ~BV(EMAC_MPE);
 277
 278         return 0;
 279 }
 280
 281
 282 static int emac_start(void)
 283 {
 284         uint32_t addr;
 285         int i;
 286
 287         for (i = 0; i < EMAC_RX_DESCRIPTORS; i++)
 288         {
 289                 addr = (uint32_t)(rx_buf + (i * EMAC_RX_BUFSIZ));
 290                 rx_buf_tab[i].addr = addr & BUF_ADDRMASK;
 291         }
 292         rx_buf_tab[EMAC_RX_DESCRIPTORS - 1].addr |= RXBUF_WRAP;
 293
 294         for (i = 0; i < EMAC_TX_DESCRIPTORS; i++)
 295         {
 296                 addr = (uint32_t)(tx_buf + (i * EMAC_TX_BUFSIZ));
 297                 tx_buf_tab[i].addr = addr & BUF_ADDRMASK;
 298                 tx_buf_tab[i].stat = TXS_USED;
 299         }
 300         tx_buf_tab[EMAC_TX_DESCRIPTORS - 1].stat = TXS_USED | TXS_WRAP;
 301
 302         /* Tell the EMAC where to find the descriptors. */
 303         EMAC_RBQP = (uint32_t)rx_buf_tab;
 304         EMAC_TBQP = (uint32_t)tx_buf_tab;
 305
 306         /* Clear receiver status. */
 307         EMAC_RSR = BV(EMAC_OVR) | BV(EMAC_REC) | BV(EMAC_BNA);
 308
 309         /* Copy all frames and discard FCS. */
 310         EMAC_NCFGR |= BV(EMAC_CAF) | BV(EMAC_DRFCS);
 311
 312         /* Enable receiver, transmitter and statistics. */
 313         EMAC_NCR |= BV(EMAC_TE) | BV(EMAC_RE) | BV(EMAC_WESTAT);
 314
 315         return 0;
 316 }
 317
 318 ssize_t eth_putFrame(const uint8_t *buf, size_t len)
 319 {
 320         size_t wr_len;
 321
 322         if (UNLIKELY(!len))
 323                 return -1;
 324         ASSERT(len <= sizeof(tx_buf));
 325
 326         /* Check if the transmit buffer is available */
 327         while (!(tx_buf_tab[tx_buf_idx].stat & TXS_USED))
 328                 event_wait(&send_wait);
 329
 330         /* Copy the data into the buffer and prepare descriptor */
 331         wr_len = MIN(len, (size_t)EMAC_TX_BUFSIZ - tx_buf_offset);
 332         memcpy((uint8_t *)tx_buf_tab[tx_buf_idx].addr + tx_buf_offset,
 333                         buf, wr_len);
 334         tx_buf_offset += wr_len;
 335
 336         return wr_len;
 337 }
 338
 339 void eth_sendFrame(void)
 340 {
 341         tx_buf_tab[tx_buf_idx].stat = (tx_buf_offset & TXS_LENGTH_FRAME) |
 342                 TXS_LAST_BUFF |
 343                 ((tx_buf_idx == EMAC_TX_DESCRIPTORS - 1) ?  TXS_WRAP : 0);
 344         EMAC_NCR |= BV(EMAC_TSTART);
 345
 346         tx_buf_offset = 0;
 347         if (++tx_buf_idx >= EMAC_TX_DESCRIPTORS)
 348                 tx_buf_idx = 0;
 349 }
 350
 351 ssize_t eth_send(const uint8_t *buf, size_t len)
 352  {
 353         if (UNLIKELY(!len))
 354                 return -1;
 355
 356         len = eth_putFrame(buf, len);
 357         eth_sendFrame();
 358
 359         return len;
 360 }
 361
 362 static void eth_buf_realign(int idx)
 363 {
 364         /* Empty buffer found. Realign. */
 365         do {
 366                 rx_buf_tab[rx_buf_idx].addr &= ~RXBUF_OWNERSHIP;
 367                 if (++rx_buf_idx >= EMAC_RX_BUFFERS)
 368                         rx_buf_idx = 0;
 369         } while (idx != rx_buf_idx);
 370 }
 371
 372 static size_t __eth_getFrameLen(void)
 373 {
 374         int idx, n = EMAC_RX_BUFFERS;
 375
 376 skip:
 377         /* Skip empty buffers */
 378         while ((n > 0) && !(rx_buf_tab[rx_buf_idx].addr & RXBUF_OWNERSHIP))
 379         {
 380                 if (++rx_buf_idx >= EMAC_RX_BUFFERS)
 381                         rx_buf_idx = 0;
 382                 n--;
 383         }
 384         if (UNLIKELY(!n))
 385         {
 386                 LOG_INFO("no frame found\n");
 387                 return 0;
 388         }
 389         /* Search the start of frame and cleanup fragments */
 390         while ((n > 0) && (rx_buf_tab[rx_buf_idx].addr & RXBUF_OWNERSHIP) &&
 391                         !(rx_buf_tab[rx_buf_idx].stat & RXS_SOF))
 392         {
 393                 rx_buf_tab[rx_buf_idx].addr &= ~RXBUF_OWNERSHIP;
 394                 if (++rx_buf_idx >= EMAC_RX_BUFFERS)
 395                         rx_buf_idx = 0;
 396                 n--;
 397         }
 398         if (UNLIKELY(!n))
 399         {
 400                 LOG_INFO("no SOF found\n");
 401                 return 0;
 402         }
 403         /* Search end of frame to evaluate the total frame size */
 404         idx = rx_buf_idx;
 405 restart:
 406         while (n > 0)
 407         {
 408                 if (UNLIKELY(!(rx_buf_tab[idx].addr & RXBUF_OWNERSHIP)))
 409                 {
 410                         /* Empty buffer found. Realign. */
 411                         eth_buf_realign(idx);
 412                         goto skip;
 413                 }
 414                 if (rx_buf_tab[idx].stat & RXS_EOF)
 415                         return rx_buf_tab[idx].stat & RXS_LENGTH_FRAME;
 416                 if (UNLIKELY((idx != rx_buf_idx) &&
 417                                 (rx_buf_tab[idx].stat & RXS_SOF)))
 418                 {
 419                         /* Another start of frame found. Realign. */
 420                         eth_buf_realign(idx);
 421                         goto restart;
 422                 }
 423                 if (++idx >= EMAC_RX_BUFFERS)
 424                         idx = 0;
 425                 n--;
 426         }
 427         LOG_INFO("no EOF found\n");
 428         return 0;
 429 }
 430
 431 size_t eth_getFrameLen(void)
 432 {
 433         size_t len;
 434
 435         /* Check if there is at least one available frame in the buffer */
 436         while (1)
 437         {
 438                 len = __eth_getFrameLen();
 439                 if (LIKELY(len))
 440                         break;
 441                 /* Wait for RX interrupt */
 442                 event_wait(&recv_wait);
 443         }
 444         return len;
 445 }
 446
 447 ssize_t eth_getFrame(uint8_t *buf, size_t len)
 448 {
 449         uint8_t *addr;
 450         size_t rd_len = 0;
 451
 452         if (UNLIKELY(!len))
 453                 return -1;
 454         ASSERT(len <= sizeof(rx_buf));
 455
 456         /* Copy data from the RX buffer */
 457         addr = (uint8_t *)(rx_buf_tab[rx_buf_idx].addr & BUF_ADDRMASK);
 458         if (addr + len > &rx_buf[countof(rx_buf)])
 459         {
 460                 size_t count = &rx_buf[countof(rx_buf)] - addr;
 461
 462                 memcpy(buf, addr, count);
 463                 memcpy(buf + count, rx_buf, len - count);
 464         }
 465         else
 466         {
 467                 memcpy(buf, addr, len);
 468         }
 469         /* Update descriptors */
 470         while (rd_len < len)
 471         {
 472                 if (len - rd_len >= EMAC_RX_BUFSIZ)
 473                         rd_len += EMAC_RX_BUFSIZ;
 474                 else
 475                         rd_len += len - rd_len;
 476                 if (UNLIKELY(!(rx_buf_tab[rx_buf_idx].addr & RXBUF_OWNERSHIP)))
 477                 {
 478                         LOG_INFO("bad frame found\n");
 479                         return 0;
 480                 }
 481                 rx_buf_tab[rx_buf_idx].addr &= ~RXBUF_OWNERSHIP;
 482                 if (++rx_buf_idx >= EMAC_RX_DESCRIPTORS)
 483                         rx_buf_idx = 0;
 484         }
 485
 486         return rd_len;
 487 }
 488
 489 ssize_t eth_recv(uint8_t *buf, size_t len)
 490 {
 491         if (UNLIKELY(!len))
 492                 return -1;
 493         len = MIN(len, eth_getFrameLen());
 494         return len ? eth_getFrame(buf, len) : 0;
 495 }
 496
 497 int eth_init()
 498 {
 499         cpu_flags_t flags;
 500
 501         emac_reset();
 502         emac_start();
 503
 504         event_initGeneric(&recv_wait);
 505         event_initGeneric(&send_wait);
 506
 507         // Register interrupt vector
 508         IRQ_SAVE_DISABLE(flags);
 509
 510         /* Disable all emac interrupts */
 511         EMAC_IDR = 0xFFFFFFFF;
 512
 513 #if CPU_ARM_AT91
 514         // TODO: define sysirq_set...
 515         /* Set the vector. */
 516         AIC_SVR(EMAC_ID) = emac_irqHandler;
 517         /* Initialize to edge triggered with defined priority. */
 518         AIC_SMR(EMAC_ID) = AIC_SRCTYPE_INT_EDGE_TRIGGERED;
 519         /* Clear pending interrupt */
 520         AIC_ICCR = BV(EMAC_ID);
 521         /* Enable the system IRQ */
 522         AIC_IECR = BV(EMAC_ID);
 523 #else
 524         sysirq_setHandler(INT_EMAC, emac_irqHandler);
 525 #endif
 526
 527         /* Enable interrupts */
 528         EMAC_IER = EMAC_RX_INTS | EMAC_TX_INTS;
 529
 530         IRQ_RESTORE(flags);
 531
 532         return 0;
 533 }