drivers/net/wan/pc300too.c

   1 /*
   2  * Cyclades PC300 synchronous serial card driver for Linux
   3  *
   4  * Copyright (C) 2000-2007 Krzysztof Halasa <khc@pm.waw.pl>
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of version 2 of the GNU General Public License
   8  * as published by the Free Software Foundation.
   9  *
  10  * For information see <http://www.kernel.org/pub/linux/utils/net/hdlc/>.
  11  *
  12  * Sources of information:
  13  *    Hitachi HD64572 SCA-II User's Manual
  14  *    Cyclades PC300 Linux driver
  15  *
  16  * This driver currently supports only PC300/RSV (V.24/V.35) and
  17  * PC300/X21 cards.
  18  */
  19
  20 #include <linux/module.h>
  21 #include <linux/kernel.h>
  22 #include <linux/slab.h>
  23 #include <linux/sched.h>
  24 #include <linux/types.h>
  25 #include <linux/fcntl.h>
  26 #include <linux/in.h>
  27 #include <linux/string.h>
  28 #include <linux/errno.h>
  29 #include <linux/init.h>
  30 #include <linux/ioport.h>
  31 #include <linux/moduleparam.h>
  32 #include <linux/netdevice.h>
  33 #include <linux/hdlc.h>
  34 #include <linux/pci.h>
  35 #include <linux/delay.h>
  36 #include <asm/io.h>
  37
  38 #include "hd64572.h"
  39
  40 static const char* version = "Cyclades PC300 driver version: 1.17";
  41 static const char* devname = "PC300";
  42
  43 #undef DEBUG_PKT
  44 #define DEBUG_RINGS
  45
  46 #define PC300_PLX_SIZE          0x80    /* PLX control window size (128 B) */
  47 #define PC300_SCA_SIZE          0x400   /* SCA window size (1 KB) */
  48 #define MAX_TX_BUFFERS          10
  49
  50 static int pci_clock_freq = 33000000;
  51 static int use_crystal_clock = 0;
  52 static unsigned int CLOCK_BASE;
  53
  54 /* Masks to access the init_ctrl PLX register */
  55 #define PC300_CLKSEL_MASK        (0x00000004UL)
  56 #define PC300_CHMEDIA_MASK(port) (0x00000020UL << ((port) * 3))
  57 #define PC300_CTYPE_MASK         (0x00000800UL)
  58
  59
  60 enum { PC300_RSV = 1, PC300_X21, PC300_TE }; /* card types */
  61
  62 /*
  63  *      PLX PCI9050-1 local configuration and shared runtime registers.
  64  *      This structure can be used to access 9050 registers (memory mapped).
  65  */
  66 typedef struct {
  67         u32 loc_addr_range[4];  /* 00-0Ch : Local Address Ranges */
  68         u32 loc_rom_range;      /* 10h : Local ROM Range */
  69         u32 loc_addr_base[4];   /* 14-20h : Local Address Base Addrs */
  70         u32 loc_rom_base;       /* 24h : Local ROM Base */
  71         u32 loc_bus_descr[4];   /* 28-34h : Local Bus Descriptors */
  72         u32 rom_bus_descr;      /* 38h : ROM Bus Descriptor */
  73         u32 cs_base[4];         /* 3C-48h : Chip Select Base Addrs */
  74         u32 intr_ctrl_stat;     /* 4Ch : Interrupt Control/Status */
  75         u32 init_ctrl;          /* 50h : EEPROM ctrl, Init Ctrl, etc */
  76 }plx9050;
  77
  78
  79
  80 typedef struct port_s {
  81         struct napi_struct napi;
  82         struct net_device *dev;
  83         struct card_s *card;
  84         spinlock_t lock;        /* TX lock */
  85         sync_serial_settings settings;
  86         int rxpart;             /* partial frame received, next frame invalid*/
  87         unsigned short encoding;
  88         unsigned short parity;
  89         unsigned int iface;
  90         u16 rxin;               /* rx ring buffer 'in' pointer */
  91         u16 txin;               /* tx ring buffer 'in' and 'last' pointers */
  92         u16 txlast;
  93         u8 rxs, txs, tmc;       /* SCA registers */
  94         u8 phy_node;            /* physical port # - 0 or 1 */
  95 }port_t;
  96
  97
  98
  99 typedef struct card_s {
 100         int type;               /* RSV, X21, etc. */
 101         int n_ports;            /* 1 or 2 ports */
 102         u8 __iomem *rambase;    /* buffer memory base (virtual) */
 103         u8 __iomem *scabase;    /* SCA memory base (virtual) */
 104         plx9050 __iomem *plxbase; /* PLX registers memory base (virtual) */
 105         u32 init_ctrl_value;    /* Saved value - 9050 bug workaround */
 106         u16 rx_ring_buffers;    /* number of buffers in a ring */
 107         u16 tx_ring_buffers;
 108         u16 buff_offset;        /* offset of first buffer of first channel */
 109         u8 irq;                 /* interrupt request level */
 110
 111         port_t ports[2];
 112 }card_t;
 113
 114
 115 #define sca_in(reg, card)            readb(card->scabase + (reg))
 116 #define sca_out(value, reg, card)    writeb(value, card->scabase + (reg))
 117 #define sca_inw(reg, card)           readw(card->scabase + (reg))
 118 #define sca_outw(value, reg, card)   writew(value, card->scabase + (reg))
 119 #define sca_inl(reg, card)           readl(card->scabase + (reg))
 120 #define sca_outl(value, reg, card)   writel(value, card->scabase + (reg))
 121
 122 #define port_to_card(port)           (port->card)
 123 #define log_node(port)               (port->phy_node)
 124 #define phy_node(port)               (port->phy_node)
 125 #define winbase(card)                (card->rambase)
 126 #define get_port(card, port)         ((port) < (card)->n_ports ? \
 127                                          (&(card)->ports[port]) : (NULL))
 128
 129 #include "hd64572.c"
 130
 131
 132 static void pc300_set_iface(port_t *port)
 133 {
 134         card_t *card = port->card;
 135         u32 __iomem * init_ctrl = &card->plxbase->init_ctrl;
 136         u16 msci = get_msci(port);
 137         u8 rxs = port->rxs & CLK_BRG_MASK;
 138         u8 txs = port->txs & CLK_BRG_MASK;
 139
 140         sca_out(EXS_TES1, (phy_node(port) ? MSCI1_OFFSET : MSCI0_OFFSET) + EXS,
 141                 port_to_card(port));
 142         switch(port->settings.clock_type) {
 143         case CLOCK_INT:
 144                 rxs |= CLK_BRG; /* BRG output */
 145                 txs |= CLK_PIN_OUT | CLK_TX_RXCLK; /* RX clock */
 146                 break;
 147
 148         case CLOCK_TXINT:
 149                 rxs |= CLK_LINE; /* RXC input */
 150                 txs |= CLK_PIN_OUT | CLK_BRG; /* BRG output */
 151                 break;
 152
 153         case CLOCK_TXFROMRX:
 154                 rxs |= CLK_LINE; /* RXC input */
 155                 txs |= CLK_PIN_OUT | CLK_TX_RXCLK; /* RX clock */
 156                 break;
 157
 158         default:                /* EXTernal clock */
 159                 rxs |= CLK_LINE; /* RXC input */
 160                 txs |= CLK_PIN_OUT | CLK_LINE; /* TXC input */
 161                 break;
 162         }
 163
 164         port->rxs = rxs;
 165         port->txs = txs;
 166         sca_out(rxs, msci + RXS, card);
 167         sca_out(txs, msci + TXS, card);
 168         sca_set_port(port);
 169
 170         if (port->card->type == PC300_RSV) {
 171                 if (port->iface == IF_IFACE_V35)
 172                         writel(card->init_ctrl_value |
 173                                PC300_CHMEDIA_MASK(port->phy_node), init_ctrl);
 174                 else
 175                         writel(card->init_ctrl_value &
 176                                ~PC300_CHMEDIA_MASK(port->phy_node), init_ctrl);
 177         }
 178 }
 179
 180
 181
 182 static int pc300_open(struct net_device *dev)
 183 {
 184         port_t *port = dev_to_port(dev);
 185
 186         int result = hdlc_open(dev);
 187         if (result)
 188                 return result;
 189
 190         sca_open(dev);
 191         pc300_set_iface(port);
 192         return 0;
 193 }
 194
 195
 196
 197 static int pc300_close(struct net_device *dev)
 198 {
 199         sca_close(dev);
 200         hdlc_close(dev);
 201         return 0;
 202 }
 203
 204
 205
 206 static int pc300_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
 207 {
 208         const size_t size = sizeof(sync_serial_settings);
 209         sync_serial_settings new_line;
 210         sync_serial_settings __user *line = ifr->ifr_settings.ifs_ifsu.sync;
 211         int new_type;
 212         port_t *port = dev_to_port(dev);
 213
 214 #ifdef DEBUG_RINGS
 215         if (cmd == SIOCDEVPRIVATE) {
 216                 sca_dump_rings(dev);
 217                 return 0;
 218         }
 219 #endif
 220         if (cmd != SIOCWANDEV)
 221                 return hdlc_ioctl(dev, ifr, cmd);
 222
 223         if (ifr->ifr_settings.type == IF_GET_IFACE) {
 224                 ifr->ifr_settings.type = port->iface;
 225                 if (ifr->ifr_settings.size < size) {
 226                         ifr->ifr_settings.size = size; /* data size wanted */
 227                         return -ENOBUFS;
 228                 }
 229                 if (copy_to_user(line, &port->settings, size))
 230                         return -EFAULT;
 231                 return 0;
 232
 233         }
 234
 235         if (port->card->type == PC300_X21 &&
 236             (ifr->ifr_settings.type == IF_IFACE_SYNC_SERIAL ||
 237              ifr->ifr_settings.type == IF_IFACE_X21))
 238                 new_type = IF_IFACE_X21;
 239
 240         else if (port->card->type == PC300_RSV &&
 241                  (ifr->ifr_settings.type == IF_IFACE_SYNC_SERIAL ||
 242                   ifr->ifr_settings.type == IF_IFACE_V35))
 243                 new_type = IF_IFACE_V35;
 244
 245         else if (port->card->type == PC300_RSV &&
 246                  ifr->ifr_settings.type == IF_IFACE_V24)
 247                 new_type = IF_IFACE_V24;
 248
 249         else
 250                 return hdlc_ioctl(dev, ifr, cmd);
 251
 252         if (!capable(CAP_NET_ADMIN))
 253                 return -EPERM;
 254
 255         if (copy_from_user(&new_line, line, size))
 256                 return -EFAULT;
 257
 258         if (new_line.clock_type != CLOCK_EXT &&
 259             new_line.clock_type != CLOCK_TXFROMRX &&
 260             new_line.clock_type != CLOCK_INT &&
 261             new_line.clock_type != CLOCK_TXINT)
 262                 return -EINVAL; /* No such clock setting */
 263
 264         if (new_line.loopback != 0 && new_line.loopback != 1)
 265                 return -EINVAL;
 266
 267         memcpy(&port->settings, &new_line, size); /* Update settings */
 268         port->iface = new_type;
 269         pc300_set_iface(port);
 270         return 0;
 271 }
 272
 273
 274
 275 static void pc300_pci_remove_one(struct pci_dev *pdev)
 276 {
 277         int i;
 278         card_t *card = pci_get_drvdata(pdev);
 279
 280         for (i = 0; i < 2; i++)
 281                 if (card->ports[i].card) {
 282                         struct net_device *dev = port_to_dev(&card->ports[i]);
 283                         unregister_hdlc_device(dev);
 284                 }
 285
 286         if (card->irq)
 287                 free_irq(card->irq, card);
 288
 289         if (card->rambase)
 290                 iounmap(card->rambase);
 291         if (card->scabase)
 292                 iounmap(card->scabase);
 293         if (card->plxbase)
 294                 iounmap(card->plxbase);
 295
 296         pci_release_regions(pdev);
 297         pci_disable_device(pdev);
 298         pci_set_drvdata(pdev, NULL);
 299         if (card->ports[0].dev)
 300                 free_netdev(card->ports[0].dev);
 301         if (card->ports[1].dev)
 302                 free_netdev(card->ports[1].dev);
 303         kfree(card);
 304 }
 305
 306
 307
 308 static int __devinit pc300_pci_init_one(struct pci_dev *pdev,
 309                                         const struct pci_device_id *ent)
 310 {
 311         card_t *card;
 312         u32 __iomem *p;
 313         int i;
 314         u32 ramsize;
 315         u32 ramphys;            /* buffer memory base */
 316         u32 scaphys;            /* SCA memory base */
 317         u32 plxphys;            /* PLX registers memory base */
 318
 319 #ifndef MODULE
 320         static int printed_version;
 321         if (!printed_version++)
 322                 printk(KERN_INFO "%s\n", version);
 323 #endif
 324
 325         i = pci_enable_device(pdev);
 326         if (i)
 327                 return i;
 328
 329         i = pci_request_regions(pdev, "PC300");
 330         if (i) {
 331                 pci_disable_device(pdev);
 332                 return i;
 333         }
 334
 335         card = kzalloc(sizeof(card_t), GFP_KERNEL);
 336         if (card == NULL) {
 337                 printk(KERN_ERR "pc300: unable to allocate memory\n");
 338                 pci_release_regions(pdev);
 339                 pci_disable_device(pdev);
 340                 return -ENOBUFS;
 341         }
 342         pci_set_drvdata(pdev, card);
 343
 344         if (pdev->device == PCI_DEVICE_ID_PC300_TE_1 ||
 345             pdev->device == PCI_DEVICE_ID_PC300_TE_2)
 346                 card->type = PC300_TE; /* not fully supported */
 347         else if (card->init_ctrl_value & PC300_CTYPE_MASK)
 348                 card->type = PC300_X21;
 349         else
 350                 card->type = PC300_RSV;
 351
 352         if (pdev->device == PCI_DEVICE_ID_PC300_RX_1 ||
 353             pdev->device == PCI_DEVICE_ID_PC300_TE_1)
 354                 card->n_ports = 1;
 355         else
 356                 card->n_ports = 2;
 357
 358         for (i = 0; i < card->n_ports; i++)
 359                 if (!(card->ports[i].dev = alloc_hdlcdev(&card->ports[i]))) {
 360                         printk(KERN_ERR "pc300: unable to allocate memory\n");
 361                         pc300_pci_remove_one(pdev);
 362                         return -ENOMEM;
 363                 }
 364
 365         if (pci_resource_len(pdev, 0) != PC300_PLX_SIZE ||
 366             pci_resource_len(pdev, 2) != PC300_SCA_SIZE ||
 367             pci_resource_len(pdev, 3) < 16384) {
 368                 printk(KERN_ERR "pc300: invalid card EEPROM parameters\n");
 369                 pc300_pci_remove_one(pdev);
 370                 return -EFAULT;
 371         }
 372
 373         plxphys = pci_resource_start(pdev,0) & PCI_BASE_ADDRESS_MEM_MASK;
 374         card->plxbase = ioremap(plxphys, PC300_PLX_SIZE);
 375
 376         scaphys = pci_resource_start(pdev,2) & PCI_BASE_ADDRESS_MEM_MASK;
 377         card->scabase = ioremap(scaphys, PC300_SCA_SIZE);
 378
 379         ramphys = pci_resource_start(pdev,3) & PCI_BASE_ADDRESS_MEM_MASK;
 380         card->rambase = pci_ioremap_bar(pdev, 3);
 381
 382         if (card->plxbase == NULL ||
 383             card->scabase == NULL ||
 384             card->rambase == NULL) {
 385                 printk(KERN_ERR "pc300: ioremap() failed\n");
 386                 pc300_pci_remove_one(pdev);
 387         }
 388
 389         /* PLX PCI 9050 workaround for local configuration register read bug */
 390         pci_write_config_dword(pdev, PCI_BASE_ADDRESS_0, scaphys);
 391         card->init_ctrl_value = readl(&((plx9050 __iomem *)card->scabase)->init_ctrl);
 392         pci_write_config_dword(pdev, PCI_BASE_ADDRESS_0, plxphys);
 393
 394         /* Reset PLX */
 395         p = &card->plxbase->init_ctrl;
 396         writel(card->init_ctrl_value | 0x40000000, p);
 397         readl(p);               /* Flush the write - do not use sca_flush */
 398         udelay(1);
 399
 400         writel(card->init_ctrl_value, p);
 401         readl(p);               /* Flush the write - do not use sca_flush */
 402         udelay(1);
 403
 404         /* Reload Config. Registers from EEPROM */
 405         writel(card->init_ctrl_value | 0x20000000, p);
 406         readl(p);               /* Flush the write - do not use sca_flush */
 407         udelay(1);
 408
 409         writel(card->init_ctrl_value, p);
 410         readl(p);               /* Flush the write - do not use sca_flush */
 411         udelay(1);
 412
 413         ramsize = sca_detect_ram(card, card->rambase,
 414                                  pci_resource_len(pdev, 3));
 415
 416         if (use_crystal_clock)
 417                 card->init_ctrl_value &= ~PC300_CLKSEL_MASK;
 418         else
 419                 card->init_ctrl_value |= PC300_CLKSEL_MASK;
 420
 421         writel(card->init_ctrl_value, &card->plxbase->init_ctrl);
 422         /* number of TX + RX buffers for one port */
 423         i = ramsize / (card->n_ports * (sizeof(pkt_desc) + HDLC_MAX_MRU));
 424         card->tx_ring_buffers = min(i / 2, MAX_TX_BUFFERS);
 425         card->rx_ring_buffers = i - card->tx_ring_buffers;
 426
 427         card->buff_offset = card->n_ports * sizeof(pkt_desc) *
 428                 (card->tx_ring_buffers + card->rx_ring_buffers);
 429
 430         printk(KERN_INFO "pc300: PC300/%s, %u KB RAM at 0x%x, IRQ%u, "
 431                "using %u TX + %u RX packets rings\n",
 432                card->type == PC300_X21 ? "X21" :
 433                card->type == PC300_TE ? "TE" : "RSV",
 434                ramsize / 1024, ramphys, pdev->irq,
 435                card->tx_ring_buffers, card->rx_ring_buffers);
 436
 437         if (card->tx_ring_buffers < 1) {
 438                 printk(KERN_ERR "pc300: RAM test failed\n");
 439                 pc300_pci_remove_one(pdev);
 440                 return -EFAULT;
 441         }
 442
 443         /* Enable interrupts on the PCI bridge, LINTi1 active low */
 444         writew(0x0041, &card->plxbase->intr_ctrl_stat);
 445
 446         /* Allocate IRQ */
 447         if (request_irq(pdev->irq, sca_intr, IRQF_SHARED, devname, card)) {
 448                 printk(KERN_WARNING "pc300: could not allocate IRQ%d.\n",
 449                        pdev->irq);
 450                 pc300_pci_remove_one(pdev);
 451                 return -EBUSY;
 452         }
 453         card->irq = pdev->irq;
 454
 455         sca_init(card, 0);
 456
 457         // COTE not set - allows better TX DMA settings
 458         // sca_out(sca_in(PCR, card) | PCR_COTE, PCR, card);
 459
 460         sca_out(0x10, BTCR, card);
 461
 462         for (i = 0; i < card->n_ports; i++) {
 463                 port_t *port = &card->ports[i];
 464                 struct net_device *dev = port_to_dev(port);
 465                 hdlc_device *hdlc = dev_to_hdlc(dev);
 466                 port->phy_node = i;
 467
 468                 spin_lock_init(&port->lock);
 469                 dev->irq = card->irq;
 470                 dev->mem_start = ramphys;
 471                 dev->mem_end = ramphys + ramsize - 1;
 472                 dev->tx_queue_len = 50;
 473                 dev->do_ioctl = pc300_ioctl;
 474                 dev->open = pc300_open;
 475                 dev->stop = pc300_close;
 476                 hdlc->attach = sca_attach;
 477                 hdlc->xmit = sca_xmit;
 478                 port->settings.clock_type = CLOCK_EXT;
 479                 port->card = card;
 480                 if (card->type == PC300_X21)
 481                         port->iface = IF_IFACE_X21;
 482                 else
 483                         port->iface = IF_IFACE_V35;
 484
 485                 sca_init_port(port);
 486                 if (register_hdlc_device(dev)) {
 487                         printk(KERN_ERR "pc300: unable to register hdlc "
 488                                "device\n");
 489                         port->card = NULL;
 490                         pc300_pci_remove_one(pdev);
 491                         return -ENOBUFS;
 492                 }
 493
 494                 printk(KERN_INFO "%s: PC300 node %d\n",
 495                        dev->name, port->phy_node);
 496         }
 497         return 0;
 498 }
 499
 500
 501
 502 static struct pci_device_id pc300_pci_tbl[] __devinitdata = {
 503         { PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_PC300_RX_1, PCI_ANY_ID,
 504           PCI_ANY_ID, 0, 0, 0 },
 505         { PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_PC300_RX_2, PCI_ANY_ID,
 506           PCI_ANY_ID, 0, 0, 0 },
 507         { PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_PC300_TE_1, PCI_ANY_ID,
 508           PCI_ANY_ID, 0, 0, 0 },
 509         { PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_PC300_TE_2, PCI_ANY_ID,
 510           PCI_ANY_ID, 0, 0, 0 },
 511         { 0, }
 512 };
 513
 514
 515 static struct pci_driver pc300_pci_driver = {
 516         .name =          "PC300",
 517         .id_table =      pc300_pci_tbl,
 518         .probe =         pc300_pci_init_one,
 519         .remove =        pc300_pci_remove_one,
 520 };
 521
 522
 523 static int __init pc300_init_module(void)
 524 {
 525 #ifdef MODULE
 526         printk(KERN_INFO "%s\n", version);
 527 #endif
 528         if (pci_clock_freq < 1000000 || pci_clock_freq > 80000000) {
 529                 printk(KERN_ERR "pc300: Invalid PCI clock frequency\n");
 530                 return -EINVAL;
 531         }
 532         if (use_crystal_clock != 0 && use_crystal_clock != 1) {
 533                 printk(KERN_ERR "pc300: Invalid 'use_crystal_clock' value\n");
 534                 return -EINVAL;
 535         }
 536
 537         CLOCK_BASE = use_crystal_clock ? 24576000 : pci_clock_freq;
 538
 539         return pci_register_driver(&pc300_pci_driver);
 540 }
 541
 542
 543
 544 static void __exit pc300_cleanup_module(void)
 545 {
 546         pci_unregister_driver(&pc300_pci_driver);
 547 }
 548
 549 MODULE_AUTHOR("Krzysztof Halasa <khc@pm.waw.pl>");
 550 MODULE_DESCRIPTION("Cyclades PC300 serial port driver");
 551 MODULE_LICENSE("GPL v2");
 552 MODULE_DEVICE_TABLE(pci, pc300_pci_tbl);
 553 module_param(pci_clock_freq, int, 0444);
 554 MODULE_PARM_DESC(pci_clock_freq, "System PCI clock frequency in Hz");
 555 module_param(use_crystal_clock, int, 0444);
 556 MODULE_PARM_DESC(use_crystal_clock,
 557                  "Use 24.576 MHz clock instead of PCI clock");
 558 module_init(pc300_init_module);
 559 module_exit(pc300_cleanup_module);