drivers/net/smc911x.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * SMSC LAN9[12]1[567] Network driver
   4  *
   5  * (c) 2007 Pengutronix, Sascha Hauer <s.hauer@pengutronix.de>
   6  */
   7
   8 #include <common.h>
   9 #include <command.h>
  10 #include <malloc.h>
  11 #include <net.h>
  12 #include <miiphy.h>
  13 #include <linux/types.h>
  14
  15 #include "smc911x.h"
  16
  17 struct chip_id {
  18         u16 id;
  19         char *name;
  20 };
  21
  22 static const struct chip_id chip_ids[] =  {
  23         { CHIP_89218, "LAN89218" },
  24         { CHIP_9115, "LAN9115" },
  25         { CHIP_9116, "LAN9116" },
  26         { CHIP_9117, "LAN9117" },
  27         { CHIP_9118, "LAN9118" },
  28         { CHIP_9211, "LAN9211" },
  29         { CHIP_9215, "LAN9215" },
  30         { CHIP_9216, "LAN9216" },
  31         { CHIP_9217, "LAN9217" },
  32         { CHIP_9218, "LAN9218" },
  33         { CHIP_9220, "LAN9220" },
  34         { CHIP_9221, "LAN9221" },
  35         { 0, NULL },
  36 };
  37
  38 #define DRIVERNAME "smc911x"
  39
  40 #if defined (CONFIG_SMC911X_32_BIT) && \
  41         defined (CONFIG_SMC911X_16_BIT)
  42 #error "SMC911X: Only one of CONFIG_SMC911X_32_BIT and \
  43         CONFIG_SMC911X_16_BIT shall be set"
  44 #endif
  45
  46 #if defined (CONFIG_SMC911X_32_BIT)
  47 static inline u32 __smc911x_reg_read(struct eth_device *dev, u32 offset)
  48 {
  49         return *(volatile u32*)(dev->iobase + offset);
  50 }
  51 u32 smc911x_reg_read(struct eth_device *dev, u32 offset)
  52         __attribute__((weak, alias("__smc911x_reg_read")));
  53
  54 static inline void __smc911x_reg_write(struct eth_device *dev,
  55                                         u32 offset, u32 val)
  56 {
  57         *(volatile u32*)(dev->iobase + offset) = val;
  58 }
  59 void smc911x_reg_write(struct eth_device *dev, u32 offset, u32 val)
  60         __attribute__((weak, alias("__smc911x_reg_write")));
  61 #elif defined (CONFIG_SMC911X_16_BIT)
  62 static inline u32 smc911x_reg_read(struct eth_device *dev, u32 offset)
  63 {
  64         volatile u16 *addr_16 = (u16 *)(dev->iobase + offset);
  65         return ((*addr_16 & 0x0000ffff) | (*(addr_16 + 1) << 16));
  66 }
  67 static inline void smc911x_reg_write(struct eth_device *dev,
  68                                         u32 offset, u32 val)
  69 {
  70         *(volatile u16 *)(dev->iobase + offset) = (u16)val;
  71         *(volatile u16 *)(dev->iobase + offset + 2) = (u16)(val >> 16);
  72 }
  73 #else
  74 #error "SMC911X: undefined bus width"
  75 #endif /* CONFIG_SMC911X_16_BIT */
  76
  77 static u32 smc911x_get_mac_csr(struct eth_device *dev, u8 reg)
  78 {
  79         while (smc911x_reg_read(dev, MAC_CSR_CMD) & MAC_CSR_CMD_CSR_BUSY)
  80                 ;
  81         smc911x_reg_write(dev, MAC_CSR_CMD,
  82                         MAC_CSR_CMD_CSR_BUSY | MAC_CSR_CMD_R_NOT_W | reg);
  83         while (smc911x_reg_read(dev, MAC_CSR_CMD) & MAC_CSR_CMD_CSR_BUSY)
  84                 ;
  85
  86         return smc911x_reg_read(dev, MAC_CSR_DATA);
  87 }
  88
  89 static void smc911x_set_mac_csr(struct eth_device *dev, u8 reg, u32 data)
  90 {
  91         while (smc911x_reg_read(dev, MAC_CSR_CMD) & MAC_CSR_CMD_CSR_BUSY)
  92                 ;
  93         smc911x_reg_write(dev, MAC_CSR_DATA, data);
  94         smc911x_reg_write(dev, MAC_CSR_CMD, MAC_CSR_CMD_CSR_BUSY | reg);
  95         while (smc911x_reg_read(dev, MAC_CSR_CMD) & MAC_CSR_CMD_CSR_BUSY)
  96                 ;
  97 }
  98
  99 static int smc911x_detect_chip(struct eth_device *dev)
 100 {
 101         unsigned long val, i;
 102
 103         val = smc911x_reg_read(dev, BYTE_TEST);
 104         if (val == 0xffffffff) {
 105                 /* Special case -- no chip present */
 106                 return -1;
 107         } else if (val != 0x87654321) {
 108                 printf(DRIVERNAME ": Invalid chip endian 0x%08lx\n", val);
 109                 return -1;
 110         }
 111
 112         val = smc911x_reg_read(dev, ID_REV) >> 16;
 113         for (i = 0; chip_ids[i].id != 0; i++) {
 114                 if (chip_ids[i].id == val) break;
 115         }
 116         if (!chip_ids[i].id) {
 117                 printf(DRIVERNAME ": Unknown chip ID %04lx\n", val);
 118                 return -1;
 119         }
 120
 121         dev->priv = (void *)&chip_ids[i];
 122
 123         return 0;
 124 }
 125
 126 static void smc911x_reset(struct eth_device *dev)
 127 {
 128         int timeout;
 129
 130         /*
 131          *  Take out of PM setting first
 132          *  Device is already wake up if PMT_CTRL_READY bit is set
 133          */
 134         if ((smc911x_reg_read(dev, PMT_CTRL) & PMT_CTRL_READY) == 0) {
 135                 /* Write to the bytetest will take out of powerdown */
 136                 smc911x_reg_write(dev, BYTE_TEST, 0x0);
 137
 138                 timeout = 10;
 139
 140                 while (timeout-- &&
 141                         !(smc911x_reg_read(dev, PMT_CTRL) & PMT_CTRL_READY))
 142                         udelay(10);
 143                 if (timeout < 0) {
 144                         printf(DRIVERNAME
 145                                 ": timeout waiting for PM restore\n");
 146                         return;
 147                 }
 148         }
 149
 150         /* Disable interrupts */
 151         smc911x_reg_write(dev, INT_EN, 0);
 152
 153         smc911x_reg_write(dev, HW_CFG, HW_CFG_SRST);
 154
 155         timeout = 1000;
 156         while (timeout-- && smc911x_reg_read(dev, E2P_CMD) & E2P_CMD_EPC_BUSY)
 157                 udelay(10);
 158
 159         if (timeout < 0) {
 160                 printf(DRIVERNAME ": reset timeout\n");
 161                 return;
 162         }
 163
 164         /* Reset the FIFO level and flow control settings */
 165         smc911x_set_mac_csr(dev, FLOW, FLOW_FCPT | FLOW_FCEN);
 166         smc911x_reg_write(dev, AFC_CFG, 0x0050287F);
 167
 168         /* Set to LED outputs */
 169         smc911x_reg_write(dev, GPIO_CFG, 0x70070000);
 170 }
 171
 172 static void smc911x_handle_mac_address(struct eth_device *dev)
 173 {
 174         unsigned long addrh, addrl;
 175         uchar *m = dev->enetaddr;
 176
 177         addrl = m[0] | (m[1] << 8) | (m[2] << 16) | (m[3] << 24);
 178         addrh = m[4] | (m[5] << 8);
 179         smc911x_set_mac_csr(dev, ADDRL, addrl);
 180         smc911x_set_mac_csr(dev, ADDRH, addrh);
 181
 182         printf(DRIVERNAME ": MAC %pM\n", m);
 183 }
 184
 185 static int smc911x_eth_phy_read(struct eth_device *dev,
 186                                 u8 phy, u8 reg, u16 *val)
 187 {
 188         while (smc911x_get_mac_csr(dev, MII_ACC) & MII_ACC_MII_BUSY)
 189                 ;
 190
 191         smc911x_set_mac_csr(dev, MII_ACC, phy << 11 | reg << 6 |
 192                                 MII_ACC_MII_BUSY);
 193
 194         while (smc911x_get_mac_csr(dev, MII_ACC) & MII_ACC_MII_BUSY)
 195                 ;
 196
 197         *val = smc911x_get_mac_csr(dev, MII_DATA);
 198
 199         return 0;
 200 }
 201
 202 static int smc911x_eth_phy_write(struct eth_device *dev,
 203                                 u8 phy, u8 reg, u16  val)
 204 {
 205         while (smc911x_get_mac_csr(dev, MII_ACC) & MII_ACC_MII_BUSY)
 206                 ;
 207
 208         smc911x_set_mac_csr(dev, MII_DATA, val);
 209         smc911x_set_mac_csr(dev, MII_ACC,
 210                 phy << 11 | reg << 6 | MII_ACC_MII_BUSY | MII_ACC_MII_WRITE);
 211
 212         while (smc911x_get_mac_csr(dev, MII_ACC) & MII_ACC_MII_BUSY)
 213                 ;
 214         return 0;
 215 }
 216
 217 static int smc911x_phy_reset(struct eth_device *dev)
 218 {
 219         u32 reg;
 220
 221         reg = smc911x_reg_read(dev, PMT_CTRL);
 222         reg &= ~0xfffff030;
 223         reg |= PMT_CTRL_PHY_RST;
 224         smc911x_reg_write(dev, PMT_CTRL, reg);
 225
 226         mdelay(100);
 227
 228         return 0;
 229 }
 230
 231 static void smc911x_phy_configure(struct eth_device *dev)
 232 {
 233         int timeout;
 234         u16 status;
 235
 236         smc911x_phy_reset(dev);
 237
 238         smc911x_eth_phy_write(dev, 1, MII_BMCR, BMCR_RESET);
 239         mdelay(1);
 240         smc911x_eth_phy_write(dev, 1, MII_ADVERTISE, 0x01e1);
 241         smc911x_eth_phy_write(dev, 1, MII_BMCR, BMCR_ANENABLE |
 242                                 BMCR_ANRESTART);
 243
 244         timeout = 5000;
 245         do {
 246                 mdelay(1);
 247                 if ((timeout--) == 0)
 248                         goto err_out;
 249
 250                 if (smc911x_eth_phy_read(dev, 1, MII_BMSR, &status) != 0)
 251                         goto err_out;
 252         } while (!(status & BMSR_LSTATUS));
 253
 254         printf(DRIVERNAME ": phy initialized\n");
 255
 256         return;
 257
 258 err_out:
 259         printf(DRIVERNAME ": autonegotiation timed out\n");
 260 }
 261
 262 static void smc911x_enable(struct eth_device *dev)
 263 {
 264         /* Enable TX */
 265         smc911x_reg_write(dev, HW_CFG, 8 << 16 | HW_CFG_SF);
 266
 267         smc911x_reg_write(dev, GPT_CFG, GPT_CFG_TIMER_EN | 10000);
 268
 269         smc911x_reg_write(dev, TX_CFG, TX_CFG_TX_ON);
 270
 271         /* no padding to start of packets */
 272         smc911x_reg_write(dev, RX_CFG, 0);
 273
 274         smc911x_set_mac_csr(dev, MAC_CR, MAC_CR_TXEN | MAC_CR_RXEN |
 275                                 MAC_CR_HBDIS);
 276 }
 277
 278 static int smc911x_init(struct eth_device *dev, bd_t * bd)
 279 {
 280         struct chip_id *id = dev->priv;
 281
 282         printf(DRIVERNAME ": detected %s controller\n", id->name);
 283
 284         smc911x_reset(dev);
 285
 286         /* Configure the PHY, initialize the link state */
 287         smc911x_phy_configure(dev);
 288
 289         smc911x_handle_mac_address(dev);
 290
 291         /* Turn on Tx + Rx */
 292         smc911x_enable(dev);
 293
 294         return 0;
 295 }
 296
 297 static int smc911x_send(struct eth_device *dev, void *packet, int length)
 298 {
 299         u32 *data = (u32*)packet;
 300         u32 tmplen;
 301         u32 status;
 302
 303         smc911x_reg_write(dev, TX_DATA_FIFO, TX_CMD_A_INT_FIRST_SEG |
 304                                 TX_CMD_A_INT_LAST_SEG | length);
 305         smc911x_reg_write(dev, TX_DATA_FIFO, length);
 306
 307         tmplen = (length + 3) / 4;
 308
 309         while (tmplen--)
 310                 smc911x_reg_write(dev, TX_DATA_FIFO, *data++);
 311
 312         /* wait for transmission */
 313         while (!((smc911x_reg_read(dev, TX_FIFO_INF) &
 314                                         TX_FIFO_INF_TSUSED) >> 16));
 315
 316         /* get status. Ignore 'no carrier' error, it has no meaning for
 317          * full duplex operation
 318          */
 319         status = smc911x_reg_read(dev, TX_STATUS_FIFO) &
 320                         (TX_STS_LOC | TX_STS_LATE_COLL | TX_STS_MANY_COLL |
 321                         TX_STS_MANY_DEFER | TX_STS_UNDERRUN);
 322
 323         if (!status)
 324                 return 0;
 325
 326         printf(DRIVERNAME ": failed to send packet: %s%s%s%s%s\n",
 327                 status & TX_STS_LOC ? "TX_STS_LOC " : "",
 328                 status & TX_STS_LATE_COLL ? "TX_STS_LATE_COLL " : "",
 329                 status & TX_STS_MANY_COLL ? "TX_STS_MANY_COLL " : "",
 330                 status & TX_STS_MANY_DEFER ? "TX_STS_MANY_DEFER " : "",
 331                 status & TX_STS_UNDERRUN ? "TX_STS_UNDERRUN" : "");
 332
 333         return -1;
 334 }
 335
 336 static void smc911x_halt(struct eth_device *dev)
 337 {
 338         smc911x_reset(dev);
 339         smc911x_handle_mac_address(dev);
 340 }
 341
 342 static int smc911x_recv(struct eth_device *dev)
 343 {
 344         u32 *data = (u32 *)net_rx_packets[0];
 345         u32 pktlen, tmplen;
 346         u32 status;
 347
 348         if ((smc911x_reg_read(dev, RX_FIFO_INF) & RX_FIFO_INF_RXSUSED) >> 16) {
 349                 status = smc911x_reg_read(dev, RX_STATUS_FIFO);
 350                 pktlen = (status & RX_STS_PKT_LEN) >> 16;
 351
 352                 smc911x_reg_write(dev, RX_CFG, 0);
 353
 354                 tmplen = (pktlen + 3) / 4;
 355                 while (tmplen--)
 356                         *data++ = smc911x_reg_read(dev, RX_DATA_FIFO);
 357
 358                 if (status & RX_STS_ES)
 359                         printf(DRIVERNAME
 360                                 ": dropped bad packet. Status: 0x%08x\n",
 361                                 status);
 362                 else
 363                         net_process_received_packet(net_rx_packets[0], pktlen);
 364         }
 365
 366         return 0;
 367 }
 368
 369 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
 370 /* wrapper for smc911x_eth_phy_read */
 371 static int smc911x_miiphy_read(struct mii_dev *bus, int phy, int devad,
 372                                int reg)
 373 {
 374         struct eth_device *dev = eth_get_dev_by_name(bus->name);
 375         u16 val = 0;
 376         int ret;
 377
 378         if (!dev)
 379                 return -ENODEV;
 380
 381         ret = smc911x_eth_phy_read(dev, phy, reg, &val);
 382         if (ret < 0)
 383                 return ret;
 384
 385         return val;
 386 }
 387 /* wrapper for smc911x_eth_phy_write */
 388 static int smc911x_miiphy_write(struct mii_dev *bus, int phy, int devad,
 389                                 int reg, u16 val)
 390 {
 391         struct eth_device *dev = eth_get_dev_by_name(bus->name);
 392
 393         if (!dev)
 394                 return -ENODEV;
 395
 396         return smc911x_eth_phy_write(dev, phy, reg, val);
 397 }
 398
 399 static int smc911x_initialize_mii(struct eth_device *dev)
 400 {
 401         struct mii_dev *mdiodev = mdio_alloc();
 402         int ret;
 403
 404         if (!mdiodev)
 405                 return -ENOMEM;
 406
 407         strncpy(mdiodev->name, dev->name, MDIO_NAME_LEN);
 408         mdiodev->read = smc911x_miiphy_read;
 409         mdiodev->write = smc911x_miiphy_write;
 410
 411         ret = mdio_register(mdiodev);
 412         if (ret < 0) {
 413                 mdio_free(mdiodev);
 414                 return ret;
 415         }
 416
 417         return 0;
 418 }
 419 #else
 420 static int smc911x_initialize_mii(struct eth_device *dev)
 421 {
 422         return 0;
 423 }
 424 #endif
 425
 426 int smc911x_initialize(u8 dev_num, int base_addr)
 427 {
 428         unsigned long addrl, addrh;
 429         struct eth_device *dev;
 430         int ret;
 431
 432         dev = calloc(1, sizeof(*dev));
 433         if (!dev)
 434                 return -ENOMEM;
 435
 436         dev->iobase = base_addr;
 437
 438         /* Try to detect chip. Will fail if not present. */
 439         ret = smc911x_detect_chip(dev);
 440         if (ret) {
 441                 ret = 0;        /* Card not detected is not an error */
 442                 goto err_detect;
 443         }
 444
 445         addrh = smc911x_get_mac_csr(dev, ADDRH);
 446         addrl = smc911x_get_mac_csr(dev, ADDRL);
 447         if (!(addrl == 0xffffffff && addrh == 0x0000ffff)) {
 448                 /* address is obtained from optional eeprom */
 449                 dev->enetaddr[0] = addrl;
 450                 dev->enetaddr[1] = addrl >>  8;
 451                 dev->enetaddr[2] = addrl >> 16;
 452                 dev->enetaddr[3] = addrl >> 24;
 453                 dev->enetaddr[4] = addrh;
 454                 dev->enetaddr[5] = addrh >> 8;
 455         }
 456
 457         dev->init = smc911x_init;
 458         dev->halt = smc911x_halt;
 459         dev->send = smc911x_send;
 460         dev->recv = smc911x_recv;
 461         sprintf(dev->name, "%s-%hu", DRIVERNAME, dev_num);
 462
 463         eth_register(dev);
 464
 465         ret = smc911x_initialize_mii(dev);
 466         if (ret)
 467                 goto err_mii;
 468
 469         return 1;
 470
 471 err_mii:
 472         eth_unregister(dev);
 473 err_detect:
 474         free(dev);
 475         return ret;
 476 }