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 /*
  76  * MAC address configuration (please change this in your project!).
  77  *
  78  * TODO: make this paramater user-configurable from the Wizard.
  79  */
  80 const uint8_t mac_addr[] = { 0x00, 0x23, 0x54, 0x6a, 0x77, 0x55 };
  81
  82 /* Silent Doxygen bug... */
  83 #ifndef __doxygen__
  84 /*
  85  * NOTE: this buffer should be declared as 'volatile' because it is read by the
  86  * hardware. However, this is accessed only via memcpy() that should guarantee
  87  * coherency when copying from/to buffers.
  88  */
  89 static uint8_t tx_buf[EMAC_TX_BUFFERS * EMAC_TX_BUFSIZ] ALIGNED(8);
  90 static volatile BufDescriptor tx_buf_tab[EMAC_TX_DESCRIPTORS] ALIGNED(8);
  91
  92 /*
  93  * NOTE: this buffer should be declared as 'volatile' because it is wrote by
  94  * the hardware. However, this is accessed only via memcpy() that should
  95  * guarantee coherency when copying from/to buffers.
  96  */
  97 static uint8_t rx_buf[EMAC_RX_BUFFERS * EMAC_RX_BUFSIZ] ALIGNED(8);
  98 static volatile BufDescriptor rx_buf_tab[EMAC_RX_DESCRIPTORS] ALIGNED(8);
  99 #endif
 100
 101 static int tx_buf_idx;
 102 static int tx_buf_offset;
 103 static int rx_buf_idx;
 104
 105 static Event recv_wait, send_wait;
 106
 107 static DECLARE_ISR(emac_irqHandler)
 108 {
 109         /* Read interrupt status and disable interrupts. */
 110         uint32_t isr = EMAC_ISR;
 111
 112         kprintf("irq: %x\n", isr);
 113
 114         /* Receiver interrupt */
 115         if ((isr & EMAC_RX_INTS))
 116         {
 117                 kprintf("emac: rx %x\n", isr);
 118                 if (isr & BV(EMAC_RCOMP))
 119                         event_do(&recv_wait);
 120                 EMAC_RSR = EMAC_RX_INTS;
 121         }
 122         /* Transmitter interrupt */
 123         if (isr & EMAC_TX_INTS)
 124         {
 125                 if (isr & BV(EMAC_TCOMP))
 126                 {
 127                         kprintf("emac: tcomp\n");
 128                         event_do(&send_wait);
 129                 }
 130                 if (isr & BV(EMAC_RLEX))
 131                         kprintf("emac: rlex\n");
 132                 EMAC_TSR = EMAC_TX_INTS;
 133         }
 134         //AIC_EOICR = 0;
 135 }
 136
 137 /*
 138  * \brief Read contents of PHY register.
 139  *
 140  * \param reg PHY register number.
 141  *
 142  * \return Contents of the specified register.
 143  */
 144 static uint16_t phy_hw_read(reg8_t reg)
 145 {
 146         // PHY read command.
 147         EMAC_MAN = EMAC_SOF | EMAC_RW_READ | (NIC_PHY_ADDR << EMAC_PHYA_SHIFT)
 148                         | ((reg  << EMAC_REGA_SHIFT) & EMAC_REGA) | EMAC_CODE;
 149
 150         // Wait until PHY logic completed.
 151         while (!(EMAC_NSR & BV(EMAC_IDLE)))
 152                 cpu_relax();
 153
 154         // Get data from PHY maintenance register.
 155         return (uint16_t)(EMAC_MAN & EMAC_DATA);
 156 }
 157
 158 /*
 159  * \brief Write value to PHY register.
 160  *
 161  * \param reg PHY register number.
 162  * \param val Value to write.
 163  */
 164 static void phy_hw_write(reg8_t reg, uint16_t val)
 165 {
 166         // PHY write command.
 167         EMAC_MAN = EMAC_SOF | EMAC_RW_WRITE | (NIC_PHY_ADDR << EMAC_PHYA_SHIFT)
 168                         | ((reg  << EMAC_REGA_SHIFT) & EMAC_REGA) | EMAC_CODE | val;
 169
 170         // Wait until PHY logic completed.
 171         while (!(EMAC_NSR & BV(EMAC_IDLE)))
 172                 cpu_relax();
 173 }
 174
 175 static int emac_reset(void)
 176 {
 177         uint16_t phy_cr;
 178
 179         // Enable devices
 180         //PMC_PCER = BV(PIOA_ID);
 181         //PMC_PCER = BV(PIOB_ID);
 182         //PMC_PCER = BV(EMAC_ID);
 183         // TOOD: Implement in sam7x
 184         pmc_periphEnable(PIOA_ID);
 185         pmc_periphEnable(PIOB_ID);
 186         pmc_periphEnable(EMAC_ID);
 187
 188         // Disable TESTMODE
 189         PIOB_PUDR = BV(PHY_RXDV_TESTMODE_BIT);
 190 #if CPU_ARM_AT91
 191         // Disable RMII
 192         PIOB_PUDR = BV(PHY_COL_RMII_BIT);
 193
 194         // Disable PHY power down.
 195         PIOB_PER  = BV(PHY_PWRDN_BIT);
 196         PIOB_OER  = BV(PHY_PWRDN_BIT);
 197         PIOB_CODR = BV(PHY_PWRDN_BIT);
 198 #endif
 199
 200         // Toggle external hardware reset pin.
 201         RSTC_MR = RSTC_KEY | (1 << RSTC_ERSTL_SHIFT) | BV(RSTC_URSTEN);
 202         RSTC_CR = RSTC_KEY | BV(RSTC_EXTRST);
 203
 204         while ((RSTC_SR & BV(RSTC_NRSTL)) == 0)
 205                 cpu_relax();
 206
 207         // Configure MII ports.
 208 #if CPU_ARM_AT91
 209         PIOB_ASR = PHY_MII_PINS;
 210         PIOB_BSR = 0;
 211         PIOB_PDR = PHY_MII_PINS;
 212         // Enable receive and transmit clocks.
 213         EMAC_USRIO = BV(EMAC_CLKEN);
 214 #else
 215         PIO_PERIPH_SEL(PIOB_BASE, PHY_MII_PINS, PIO_PERIPH_A);
 216         PIOB_PDR = PHY_MII_PINS;
 217         // Enable receive, transmit clocks and RMII mode.
 218         EMAC_USRIO = BV(EMAC_CLKEN) | BV(EMAC_RMII);
 219 #endif
 220
 221         // Enable management port.
 222         EMAC_NCR |= BV(EMAC_MPE);
 223         EMAC_NCFGR |= EMAC_CLK_HCLK_32;
 224
 225         // Set local MAC address.
 226         EMAC_SA1L = (mac_addr[3] << 24) | (mac_addr[2] << 16) |
 227                                 (mac_addr[1] << 8) | mac_addr[0];
 228         EMAC_SA1H = (mac_addr[5] << 8) | mac_addr[4];
 229
 230         // Wait for PHY ready
 231         timer_delay(255);
 232
 233         // Clear MII isolate.
 234         phy_hw_read(NIC_PHY_BMCR);
 235         phy_cr = phy_hw_read(NIC_PHY_BMCR);
 236
 237         phy_cr &= ~NIC_PHY_BMCR_ISOLATE;
 238         phy_hw_write(NIC_PHY_BMCR, phy_cr);
 239
 240         phy_cr = phy_hw_read(NIC_PHY_BMCR);
 241
 242         LOG_INFO("%s: PHY ID %#04x %#04x\n",
 243                 __func__,
 244                 phy_hw_read(NIC_PHY_ID1), phy_hw_read(NIC_PHY_ID2));
 245
 246         // Wait for auto negotiation completed.
 247         phy_hw_read(NIC_PHY_BMSR);
 248         for (;;)
 249         {
 250                 if (phy_hw_read(NIC_PHY_BMSR) & NIC_PHY_BMSR_ANCOMPL)
 251                         break;
 252                 cpu_relax();
 253         }
 254
 255         // Disable management port.
 256         EMAC_NCR &= ~BV(EMAC_MPE);
 257
 258         return 0;
 259 }
 260
 261 static int emac_start(void)
 262 {
 263         uint32_t addr;
 264         int i;
 265
 266         for (i = 0; i < EMAC_RX_DESCRIPTORS; i++)
 267         {
 268                 addr = (uint32_t)(rx_buf + (i * EMAC_RX_BUFSIZ));
 269                 rx_buf_tab[i].addr = addr & BUF_ADDRMASK;
 270         }
 271         rx_buf_tab[EMAC_RX_DESCRIPTORS - 1].addr |= RXBUF_WRAP;
 272
 273         for (i = 0; i < EMAC_TX_DESCRIPTORS; i++)
 274         {
 275                 addr = (uint32_t)(tx_buf + (i * EMAC_TX_BUFSIZ));
 276                 tx_buf_tab[i].addr = addr & BUF_ADDRMASK;
 277                 tx_buf_tab[i].stat = TXS_USED;
 278         }
 279         tx_buf_tab[EMAC_TX_DESCRIPTORS - 1].stat = TXS_USED | TXS_WRAP;
 280
 281         /* Tell the EMAC where to find the descriptors. */
 282         EMAC_RBQP = (uint32_t)rx_buf_tab;
 283         EMAC_TBQP = (uint32_t)tx_buf_tab;
 284
 285         /* Clear receiver status. */
 286         EMAC_RSR = BV(EMAC_OVR) | BV(EMAC_REC) | BV(EMAC_BNA);
 287
 288         /* Copy all frames and discard FCS. */
 289         EMAC_NCFGR |= BV(EMAC_CAF) | BV(EMAC_DRFCS);
 290
 291         /* Enable receiver, transmitter and statistics. */
 292         EMAC_NCR |= BV(EMAC_TE) | BV(EMAC_RE) | BV(EMAC_WESTAT);
 293
 294         return 0;
 295 }
 296
 297 ssize_t eth_putFrame(const uint8_t *buf, size_t len)
 298 {
 299         size_t wr_len;
 300
 301         if (UNLIKELY(!len))
 302                 return -1;
 303         ASSERT(len <= sizeof(tx_buf));
 304
 305         /* Check if the transmit buffer is available */
 306         while (!(tx_buf_tab[tx_buf_idx].stat & TXS_USED))
 307                 event_wait(&send_wait);
 308
 309         /* Copy the data into the buffer and prepare descriptor */
 310         wr_len = MIN(len, (size_t)EMAC_TX_BUFSIZ - tx_buf_offset);
 311         memcpy((uint8_t *)tx_buf_tab[tx_buf_idx].addr + tx_buf_offset,
 312                         buf, wr_len);
 313         tx_buf_offset += wr_len;
 314
 315         return wr_len;
 316 }
 317
 318 void eth_sendFrame(void)
 319 {
 320         tx_buf_tab[tx_buf_idx].stat = (tx_buf_offset & TXS_LENGTH_FRAME) |
 321                 TXS_LAST_BUFF |
 322                 ((tx_buf_idx == EMAC_TX_DESCRIPTORS - 1) ?  TXS_WRAP : 0);
 323         EMAC_NCR |= BV(EMAC_TSTART);
 324
 325         tx_buf_offset = 0;
 326         if (++tx_buf_idx >= EMAC_TX_DESCRIPTORS)
 327                 tx_buf_idx = 0;
 328 }
 329
 330 ssize_t eth_send(const uint8_t *buf, size_t len)
 331  {
 332         if (UNLIKELY(!len))
 333                 return -1;
 334
 335         len = eth_putFrame(buf, len);
 336         eth_sendFrame();
 337
 338         return len;
 339 }
 340
 341 static void eth_buf_realign(int idx)
 342 {
 343         /* Empty buffer found. Realign. */
 344         do {
 345                 rx_buf_tab[rx_buf_idx].addr &= ~RXBUF_OWNERSHIP;
 346                 if (++rx_buf_idx >= EMAC_RX_BUFFERS)
 347                         rx_buf_idx = 0;
 348         } while (idx != rx_buf_idx);
 349 }
 350
 351 static size_t __eth_getFrameLen(void)
 352 {
 353         int idx, n = EMAC_RX_BUFFERS;
 354
 355 skip:
 356         /* Skip empty buffers */
 357         while ((n > 0) && !(rx_buf_tab[rx_buf_idx].addr & RXBUF_OWNERSHIP))
 358         {
 359                 if (++rx_buf_idx >= EMAC_RX_BUFFERS)
 360                         rx_buf_idx = 0;
 361                 n--;
 362         }
 363         if (UNLIKELY(!n))
 364         {
 365                 LOG_INFO("no frame found\n");
 366                 return 0;
 367         }
 368         /* Search the start of frame and cleanup fragments */
 369         while ((n > 0) && (rx_buf_tab[rx_buf_idx].addr & RXBUF_OWNERSHIP) &&
 370                         !(rx_buf_tab[rx_buf_idx].stat & RXS_SOF))
 371         {
 372                 rx_buf_tab[rx_buf_idx].addr &= ~RXBUF_OWNERSHIP;
 373                 if (++rx_buf_idx >= EMAC_RX_BUFFERS)
 374                         rx_buf_idx = 0;
 375                 n--;
 376         }
 377         if (UNLIKELY(!n))
 378         {
 379                 LOG_INFO("no SOF found\n");
 380                 return 0;
 381         }
 382         /* Search end of frame to evaluate the total frame size */
 383         idx = rx_buf_idx;
 384 restart:
 385         while (n > 0)
 386         {
 387                 if (UNLIKELY(!(rx_buf_tab[idx].addr & RXBUF_OWNERSHIP)))
 388                 {
 389                         /* Empty buffer found. Realign. */
 390                         eth_buf_realign(idx);
 391                         goto skip;
 392                 }
 393                 if (rx_buf_tab[idx].stat & RXS_EOF)
 394                         return rx_buf_tab[idx].stat & RXS_LENGTH_FRAME;
 395                 if (UNLIKELY((idx != rx_buf_idx) &&
 396                                 (rx_buf_tab[idx].stat & RXS_SOF)))
 397                 {
 398                         /* Another start of frame found. Realign. */
 399                         eth_buf_realign(idx);
 400                         goto restart;
 401                 }
 402                 if (++idx >= EMAC_RX_BUFFERS)
 403                         idx = 0;
 404                 n--;
 405         }
 406         LOG_INFO("no EOF found\n");
 407         return 0;
 408 }
 409
 410 size_t eth_getFrameLen(void)
 411 {
 412         size_t len;
 413
 414         /* Check if there is at least one available frame in the buffer */
 415         while (1)
 416         {
 417                 len = __eth_getFrameLen();
 418                 if (LIKELY(len))
 419                         break;
 420                 /* Wait for RX interrupt */
 421                 event_wait(&recv_wait);
 422         }
 423         return len;
 424 }
 425
 426 ssize_t eth_getFrame(uint8_t *buf, size_t len)
 427 {
 428         uint8_t *addr;
 429         size_t rd_len = 0;
 430
 431         if (UNLIKELY(!len))
 432                 return -1;
 433         ASSERT(len <= sizeof(rx_buf));
 434
 435         /* Copy data from the RX buffer */
 436         addr = (uint8_t *)(rx_buf_tab[rx_buf_idx].addr & BUF_ADDRMASK);
 437         if (addr + len > &rx_buf[countof(rx_buf)])
 438         {
 439                 size_t count = &rx_buf[countof(rx_buf)] - addr;
 440
 441                 memcpy(buf, addr, count);
 442                 memcpy(buf + count, rx_buf, len - count);
 443         }
 444         else
 445         {
 446                 memcpy(buf, addr, len);
 447         }
 448         /* Update descriptors */
 449         while (rd_len < len)
 450         {
 451                 if (len - rd_len >= EMAC_RX_BUFSIZ)
 452                         rd_len += EMAC_RX_BUFSIZ;
 453                 else
 454                         rd_len += len - rd_len;
 455                 if (UNLIKELY(!(rx_buf_tab[rx_buf_idx].addr & RXBUF_OWNERSHIP)))
 456                 {
 457                         LOG_INFO("bad frame found\n");
 458                         return 0;
 459                 }
 460                 rx_buf_tab[rx_buf_idx].addr &= ~RXBUF_OWNERSHIP;
 461                 if (++rx_buf_idx >= EMAC_RX_DESCRIPTORS)
 462                         rx_buf_idx = 0;
 463         }
 464
 465         return rd_len;
 466 }
 467
 468 ssize_t eth_recv(uint8_t *buf, size_t len)
 469 {
 470         if (UNLIKELY(!len))
 471                 return -1;
 472         len = MIN(len, eth_getFrameLen());
 473         return len ? eth_getFrame(buf, len) : 0;
 474 }
 475
 476 int eth_init()
 477 {
 478         cpu_flags_t flags;
 479
 480         emac_reset();
 481         emac_start();
 482
 483         event_initGeneric(&recv_wait);
 484         event_initGeneric(&send_wait);
 485
 486         // Register interrupt vector
 487         IRQ_SAVE_DISABLE(flags);
 488
 489         /* Disable all emac interrupts */
 490         EMAC_IDR = 0xFFFFFFFF;
 491
 492 #if CPU_ARM_AT91
 493         // TODO: define sysirq_set...
 494         /* Set the vector. */
 495         AIC_SVR(EMAC_ID) = emac_irqHandler;
 496         /* Initialize to edge triggered with defined priority. */
 497         AIC_SMR(EMAC_ID) = AIC_SRCTYPE_INT_EDGE_TRIGGERED;
 498         /* Clear pending interrupt */
 499         AIC_ICCR = BV(EMAC_ID);
 500         /* Enable the system IRQ */
 501         AIC_IECR = BV(EMAC_ID);
 502 #else
 503         sysirq_setHandler(INT_EMAC, emac_irqHandler);
 504 #endif
 505
 506         /* Enable interrupts */
 507         EMAC_IER = EMAC_RX_INTS | EMAC_TX_INTS;
 508
 509         IRQ_RESTORE(flags);
 510
 511         return 0;
 512 }