drivers/net/pcmcia/ibmtr_cs.c

   1 /*======================================================================
   2
   3     A PCMCIA token-ring driver for IBM-based cards
   4
   5     This driver supports the IBM PCMCIA Token-Ring Card.
   6     Written by Steve Kipisz, kipisz@vnet.ibm.com or
   7                              bungy@ibm.net
   8
   9     Written 1995,1996.
  10
  11     This code is based on pcnet_cs.c from David Hinds.
  12
  13     V2.2.0 February 1999 - Mike Phillips phillim@amtrak.com
  14
  15     Linux V2.2.x presented significant changes to the underlying
  16     ibmtr.c code.  Mainly the code became a lot more organized and
  17     modular.
  18
  19     This caused the old PCMCIA Token Ring driver to give up and go
  20     home early. Instead of just patching the old code to make it
  21     work, the PCMCIA code has been streamlined, updated and possibly
  22     improved.
  23
  24     This code now only contains code required for the Card Services.
  25     All we do here is set the card up enough so that the real ibmtr.c
  26     driver can find it and work with it properly.
  27
  28     i.e. We set up the io port, irq, mmio memory and shared ram
  29     memory.  This enables ibmtr_probe in ibmtr.c to find the card and
  30     configure it as though it was a normal ISA and/or PnP card.
  31
  32     CHANGES
  33
  34     v2.2.5 April 1999 Mike Phillips (phillim@amtrak.com)
  35     Obscure bug fix, required changed to ibmtr.c not ibmtr_cs.c
  36
  37     v2.2.7 May 1999 Mike Phillips (phillim@amtrak.com)
  38     Updated to version 2.2.7 to match the first version of the kernel
  39     that the modification to ibmtr.c were incorporated into.
  40
  41     v2.2.17 July 2000 Burt Silverman (burts@us.ibm.com)
  42     Address translation feature of PCMCIA controller is usable so
  43     memory windows can be placed in High memory (meaning above
  44     0xFFFFF.)
  45
  46 ======================================================================*/
  47
  48 #include <linux/kernel.h>
  49 #include <linux/init.h>
  50 #include <linux/ptrace.h>
  51 #include <linux/slab.h>
  52 #include <linux/string.h>
  53 #include <linux/timer.h>
  54 #include <linux/module.h>
  55 #include <linux/ethtool.h>
  56 #include <linux/netdevice.h>
  57 #include <linux/trdevice.h>
  58 #include <linux/ibmtr.h>
  59
  60 #include <pcmcia/cistpl.h>
  61 #include <pcmcia/ds.h>
  62
  63 #include <asm/uaccess.h>
  64 #include <asm/io.h>
  65 #include <asm/system.h>
  66
  67 #define PCMCIA
  68 #include "../tokenring/ibmtr.c"
  69
  70
  71 /*====================================================================*/
  72
  73 /* Parameters that can be set with 'insmod' */
  74
  75 /* MMIO base address */
  76 static u_long mmiobase = 0xce000;
  77
  78 /* SRAM base address */
  79 static u_long srambase = 0xd0000;
  80
  81 /* SRAM size 8,16,32,64 */
  82 static u_long sramsize = 64;
  83
  84 /* Ringspeed 4,16 */
  85 static int ringspeed = 16;
  86
  87 module_param(mmiobase, ulong, 0);
  88 module_param(srambase, ulong, 0);
  89 module_param(sramsize, ulong, 0);
  90 module_param(ringspeed, int, 0);
  91 MODULE_LICENSE("GPL");
  92
  93 /*====================================================================*/
  94
  95 static int ibmtr_config(struct pcmcia_device *link);
  96 static void ibmtr_hw_setup(struct net_device *dev, u_int mmiobase);
  97 static void ibmtr_release(struct pcmcia_device *link);
  98 static void ibmtr_detach(struct pcmcia_device *p_dev);
  99
 100 /*====================================================================*/
 101
 102 typedef struct ibmtr_dev_t {
 103         struct pcmcia_device    *p_dev;
 104         struct net_device       *dev;
 105         struct tok_info         *ti;
 106 } ibmtr_dev_t;
 107
 108 static void netdev_get_drvinfo(struct net_device *dev,
 109                                struct ethtool_drvinfo *info)
 110 {
 111         strcpy(info->driver, "ibmtr_cs");
 112 }
 113
 114 static const struct ethtool_ops netdev_ethtool_ops = {
 115         .get_drvinfo            = netdev_get_drvinfo,
 116 };
 117
 118 static irqreturn_t ibmtr_interrupt(int irq, void *dev_id) {
 119         ibmtr_dev_t *info = dev_id;
 120         struct net_device *dev = info->dev;
 121         return tok_interrupt(irq, dev);
 122 };
 123
 124 /*======================================================================
 125
 126     ibmtr_attach() creates an "instance" of the driver, allocating
 127     local data structures for one device.  The device is registered
 128     with Card Services.
 129
 130 ======================================================================*/
 131
 132 static int __devinit ibmtr_attach(struct pcmcia_device *link)
 133 {
 134     ibmtr_dev_t *info;
 135     struct net_device *dev;
 136
 137     dev_dbg(&link->dev, "ibmtr_attach()\n");
 138
 139     /* Create new token-ring device */
 140     info = kzalloc(sizeof(*info), GFP_KERNEL);
 141     if (!info) return -ENOMEM;
 142     dev = alloc_trdev(sizeof(struct tok_info));
 143     if (!dev) {
 144         kfree(info);
 145         return -ENOMEM;
 146     }
 147
 148     info->p_dev = link;
 149     link->priv = info;
 150     info->ti = netdev_priv(dev);
 151
 152     link->resource[0]->flags |= IO_DATA_PATH_WIDTH_8;
 153     link->resource[0]->end = 4;
 154     link->config_flags |= CONF_ENABLE_IRQ;
 155     link->config_regs = PRESENT_OPTION;
 156
 157     info->dev = dev;
 158
 159     SET_ETHTOOL_OPS(dev, &netdev_ethtool_ops);
 160
 161     return ibmtr_config(link);
 162 } /* ibmtr_attach */
 163
 164 /*======================================================================
 165
 166     This deletes a driver "instance".  The device is de-registered
 167     with Card Services.  If it has been released, all local data
 168     structures are freed.  Otherwise, the structures will be freed
 169     when the device is released.
 170
 171 ======================================================================*/
 172
 173 static void ibmtr_detach(struct pcmcia_device *link)
 174 {
 175     struct ibmtr_dev_t *info = link->priv;
 176     struct net_device *dev = info->dev;
 177      struct tok_info *ti = netdev_priv(dev);
 178
 179     dev_dbg(&link->dev, "ibmtr_detach\n");
 180
 181     /*
 182      * When the card removal interrupt hits tok_interrupt(),
 183      * bail out early, so we don't crash the machine
 184      */
 185     ti->sram_phys |= 1;
 186
 187     unregister_netdev(dev);
 188
 189     del_timer_sync(&(ti->tr_timer));
 190
 191     ibmtr_release(link);
 192
 193     free_netdev(dev);
 194     kfree(info);
 195 } /* ibmtr_detach */
 196
 197 /*======================================================================
 198
 199     ibmtr_config() is scheduled to run after a CARD_INSERTION event
 200     is received, to configure the PCMCIA socket, and to make the
 201     token-ring device available to the system.
 202
 203 ======================================================================*/
 204
 205 static int __devinit ibmtr_config(struct pcmcia_device *link)
 206 {
 207     ibmtr_dev_t *info = link->priv;
 208     struct net_device *dev = info->dev;
 209     struct tok_info *ti = netdev_priv(dev);
 210     int i, ret;
 211
 212     dev_dbg(&link->dev, "ibmtr_config\n");
 213
 214     link->io_lines = 16;
 215     link->config_index = 0x61;
 216
 217     /* Determine if this is PRIMARY or ALTERNATE. */
 218
 219     /* Try PRIMARY card at 0xA20-0xA23 */
 220     link->resource[0]->start = 0xA20;
 221     i = pcmcia_request_io(link);
 222     if (i != 0) {
 223         /* Couldn't get 0xA20-0xA23.  Try ALTERNATE at 0xA24-0xA27. */
 224         link->resource[0]->start = 0xA24;
 225         ret = pcmcia_request_io(link);
 226         if (ret)
 227                 goto failed;
 228     }
 229     dev->base_addr = link->resource[0]->start;
 230
 231     ret = pcmcia_request_exclusive_irq(link, ibmtr_interrupt);
 232     if (ret)
 233             goto failed;
 234     dev->irq = link->irq;
 235     ti->irq = link->irq;
 236     ti->global_int_enable=GLOBAL_INT_ENABLE+((dev->irq==9) ? 2 : dev->irq);
 237
 238     /* Allocate the MMIO memory window */
 239     link->resource[2]->flags |= WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM|WIN_ENABLE;
 240     link->resource[2]->flags |= WIN_USE_WAIT;
 241     link->resource[2]->start = 0;
 242     link->resource[2]->end = 0x2000;
 243     ret = pcmcia_request_window(link, link->resource[2], 250);
 244     if (ret)
 245             goto failed;
 246
 247     ret = pcmcia_map_mem_page(link, link->resource[2], mmiobase);
 248     if (ret)
 249             goto failed;
 250     ti->mmio = ioremap(link->resource[2]->start,
 251                     resource_size(link->resource[2]));
 252
 253     /* Allocate the SRAM memory window */
 254     link->resource[3]->flags = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM|WIN_ENABLE;
 255     link->resource[3]->flags |= WIN_USE_WAIT;
 256     link->resource[3]->start = 0;
 257     link->resource[3]->end = sramsize * 1024;
 258     ret = pcmcia_request_window(link, link->resource[3], 250);
 259     if (ret)
 260             goto failed;
 261
 262     ret = pcmcia_map_mem_page(link, link->resource[3], srambase);
 263     if (ret)
 264             goto failed;
 265
 266     ti->sram_base = srambase >> 12;
 267     ti->sram_virt = ioremap(link->resource[3]->start,
 268                     resource_size(link->resource[3]));
 269     ti->sram_phys = link->resource[3]->start;
 270
 271     ret = pcmcia_enable_device(link);
 272     if (ret)
 273             goto failed;
 274
 275     /*  Set up the Token-Ring Controller Configuration Register and
 276         turn on the card.  Check the "Local Area Network Credit Card
 277         Adapters Technical Reference"  SC30-3585 for this info.  */
 278     ibmtr_hw_setup(dev, mmiobase);
 279
 280     SET_NETDEV_DEV(dev, &link->dev);
 281
 282     i = ibmtr_probe_card(dev);
 283     if (i != 0) {
 284         printk(KERN_NOTICE "ibmtr_cs: register_netdev() failed\n");
 285         goto failed;
 286     }
 287
 288     printk(KERN_INFO
 289            "%s: port %#3lx, irq %d,  mmio %#5lx, sram %#5lx, hwaddr=%pM\n",
 290            dev->name, dev->base_addr, dev->irq,
 291            (u_long)ti->mmio, (u_long)(ti->sram_base << 12),
 292            dev->dev_addr);
 293     return 0;
 294
 295 failed:
 296     ibmtr_release(link);
 297     return -ENODEV;
 298 } /* ibmtr_config */
 299
 300 /*======================================================================
 301
 302     After a card is removed, ibmtr_release() will unregister the net
 303     device, and release the PCMCIA configuration.  If the device is
 304     still open, this will be postponed until it is closed.
 305
 306 ======================================================================*/
 307
 308 static void ibmtr_release(struct pcmcia_device *link)
 309 {
 310         ibmtr_dev_t *info = link->priv;
 311         struct net_device *dev = info->dev;
 312
 313         dev_dbg(&link->dev, "ibmtr_release\n");
 314
 315         if (link->resource[2]->end) {
 316                 struct tok_info *ti = netdev_priv(dev);
 317                 iounmap(ti->mmio);
 318         }
 319         pcmcia_disable_device(link);
 320 }
 321
 322 static int ibmtr_suspend(struct pcmcia_device *link)
 323 {
 324         ibmtr_dev_t *info = link->priv;
 325         struct net_device *dev = info->dev;
 326
 327         if (link->open)
 328                 netif_device_detach(dev);
 329
 330         return 0;
 331 }
 332
 333 static int __devinit ibmtr_resume(struct pcmcia_device *link)
 334 {
 335         ibmtr_dev_t *info = link->priv;
 336         struct net_device *dev = info->dev;
 337
 338         if (link->open) {
 339                 ibmtr_probe(dev);       /* really? */
 340                 netif_device_attach(dev);
 341         }
 342
 343         return 0;
 344 }
 345
 346
 347 /*====================================================================*/
 348
 349 static void ibmtr_hw_setup(struct net_device *dev, u_int mmiobase)
 350 {
 351     int i;
 352
 353     /* Bizarre IBM behavior, there are 16 bits of information we
 354        need to set, but the card only allows us to send 4 bits at a
 355        time.  For each byte sent to base_addr, bits 7-4 tell the
 356        card which part of the 16 bits we are setting, bits 3-0 contain
 357        the actual information */
 358
 359     /* First nibble provides 4 bits of mmio */
 360     i = (mmiobase >> 16) & 0x0F;
 361     outb(i, dev->base_addr);
 362
 363     /* Second nibble provides 3 bits of mmio */
 364     i = 0x10 | ((mmiobase >> 12) & 0x0E);
 365     outb(i, dev->base_addr);
 366
 367     /* Third nibble, hard-coded values */
 368     i = 0x26;
 369     outb(i, dev->base_addr);
 370
 371     /* Fourth nibble sets shared ram page size */
 372
 373     /* 8 = 00, 16 = 01, 32 = 10, 64 = 11 */
 374     i = (sramsize >> 4) & 0x07;
 375     i = ((i == 4) ? 3 : i) << 2;
 376     i |= 0x30;
 377
 378     if (ringspeed == 16)
 379         i |= 2;
 380     if (dev->base_addr == 0xA24)
 381         i |= 1;
 382     outb(i, dev->base_addr);
 383
 384     /* 0x40 will release the card for use */
 385     outb(0x40, dev->base_addr);
 386 }
 387
 388 static struct pcmcia_device_id ibmtr_ids[] = {
 389         PCMCIA_DEVICE_PROD_ID12("3Com", "TokenLink Velocity PC Card", 0x41240e5b, 0x82c3734e),
 390         PCMCIA_DEVICE_PROD_ID12("IBM", "TOKEN RING", 0xb569a6e5, 0xbf8eed47),
 391         PCMCIA_DEVICE_NULL,
 392 };
 393 MODULE_DEVICE_TABLE(pcmcia, ibmtr_ids);
 394
 395 static struct pcmcia_driver ibmtr_cs_driver = {
 396         .owner          = THIS_MODULE,
 397         .name           = "ibmtr_cs",
 398         .probe          = ibmtr_attach,
 399         .remove         = ibmtr_detach,
 400         .id_table       = ibmtr_ids,
 401         .suspend        = ibmtr_suspend,
 402         .resume         = ibmtr_resume,
 403 };
 404
 405 static int __init init_ibmtr_cs(void)
 406 {
 407         return pcmcia_register_driver(&ibmtr_cs_driver);
 408 }
 409
 410 static void __exit exit_ibmtr_cs(void)
 411 {
 412         pcmcia_unregister_driver(&ibmtr_cs_driver);
 413 }
 414
 415 module_init(init_ibmtr_cs);
 416 module_exit(exit_ibmtr_cs);