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/cs_types.h>
  61 #include <pcmcia/cs.h>
  62 #include <pcmcia/cistpl.h>
  63 #include <pcmcia/ds.h>
  64
  65 #include <asm/uaccess.h>
  66 #include <asm/io.h>
  67 #include <asm/system.h>
  68
  69 #define PCMCIA
  70 #include "../tokenring/ibmtr.c"
  71
  72
  73 /*====================================================================*/
  74
  75 /* Parameters that can be set with 'insmod' */
  76
  77 /* MMIO base address */
  78 static u_long mmiobase = 0xce000;
  79
  80 /* SRAM base address */
  81 static u_long srambase = 0xd0000;
  82
  83 /* SRAM size 8,16,32,64 */
  84 static u_long sramsize = 64;
  85
  86 /* Ringspeed 4,16 */
  87 static int ringspeed = 16;
  88
  89 module_param(mmiobase, ulong, 0);
  90 module_param(srambase, ulong, 0);
  91 module_param(sramsize, ulong, 0);
  92 module_param(ringspeed, int, 0);
  93 MODULE_LICENSE("GPL");
  94
  95 /*====================================================================*/
  96
  97 static int ibmtr_config(struct pcmcia_device *link);
  98 static void ibmtr_hw_setup(struct net_device *dev, u_int mmiobase);
  99 static void ibmtr_release(struct pcmcia_device *link);
 100 static void ibmtr_detach(struct pcmcia_device *p_dev);
 101
 102 /*====================================================================*/
 103
 104 typedef struct ibmtr_dev_t {
 105         struct pcmcia_device    *p_dev;
 106     struct net_device   *dev;
 107     dev_node_t          node;
 108     window_handle_t     sram_win_handle;
 109     struct tok_info     *ti;
 110 } ibmtr_dev_t;
 111
 112 static void netdev_get_drvinfo(struct net_device *dev,
 113                                struct ethtool_drvinfo *info)
 114 {
 115         strcpy(info->driver, "ibmtr_cs");
 116 }
 117
 118 static const struct ethtool_ops netdev_ethtool_ops = {
 119         .get_drvinfo            = netdev_get_drvinfo,
 120 };
 121
 122 static irqreturn_t ibmtr_interrupt(int irq, void *dev_id) {
 123         ibmtr_dev_t *info = dev_id;
 124         struct net_device *dev = info->dev;
 125         return tok_interrupt(irq, dev);
 126 };
 127
 128 /*======================================================================
 129
 130     ibmtr_attach() creates an "instance" of the driver, allocating
 131     local data structures for one device.  The device is registered
 132     with Card Services.
 133
 134 ======================================================================*/
 135
 136 static int __devinit ibmtr_attach(struct pcmcia_device *link)
 137 {
 138     ibmtr_dev_t *info;
 139     struct net_device *dev;
 140
 141     dev_dbg(&link->dev, "ibmtr_attach()\n");
 142
 143     /* Create new token-ring device */
 144     info = kzalloc(sizeof(*info), GFP_KERNEL);
 145     if (!info) return -ENOMEM;
 146     dev = alloc_trdev(sizeof(struct tok_info));
 147     if (!dev) {
 148         kfree(info);
 149         return -ENOMEM;
 150     }
 151
 152     info->p_dev = link;
 153     link->priv = info;
 154     info->ti = netdev_priv(dev);
 155
 156     link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 157     link->io.NumPorts1 = 4;
 158     link->io.IOAddrLines = 16;
 159     link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
 160     link->irq.Handler = ibmtr_interrupt;
 161     link->conf.Attributes = CONF_ENABLE_IRQ;
 162     link->conf.IntType = INT_MEMORY_AND_IO;
 163     link->conf.Present = PRESENT_OPTION;
 164
 165     info->dev = dev;
 166
 167     SET_ETHTOOL_OPS(dev, &netdev_ethtool_ops);
 168
 169     return ibmtr_config(link);
 170 } /* ibmtr_attach */
 171
 172 /*======================================================================
 173
 174     This deletes a driver "instance".  The device is de-registered
 175     with Card Services.  If it has been released, all local data
 176     structures are freed.  Otherwise, the structures will be freed
 177     when the device is released.
 178
 179 ======================================================================*/
 180
 181 static void ibmtr_detach(struct pcmcia_device *link)
 182 {
 183     struct ibmtr_dev_t *info = link->priv;
 184     struct net_device *dev = info->dev;
 185      struct tok_info *ti = netdev_priv(dev);
 186
 187     dev_dbg(&link->dev, "ibmtr_detach\n");
 188
 189     /*
 190      * When the card removal interrupt hits tok_interrupt(),
 191      * bail out early, so we don't crash the machine
 192      */
 193     ti->sram_phys |= 1;
 194
 195     if (link->dev_node)
 196         unregister_netdev(dev);
 197
 198     del_timer_sync(&(ti->tr_timer));
 199
 200     ibmtr_release(link);
 201
 202     free_netdev(dev);
 203     kfree(info);
 204 } /* ibmtr_detach */
 205
 206 /*======================================================================
 207
 208     ibmtr_config() is scheduled to run after a CARD_INSERTION event
 209     is received, to configure the PCMCIA socket, and to make the
 210     token-ring device available to the system.
 211
 212 ======================================================================*/
 213
 214 static int __devinit ibmtr_config(struct pcmcia_device *link)
 215 {
 216     ibmtr_dev_t *info = link->priv;
 217     struct net_device *dev = info->dev;
 218     struct tok_info *ti = netdev_priv(dev);
 219     win_req_t req;
 220     memreq_t mem;
 221     int i, ret;
 222
 223     dev_dbg(&link->dev, "ibmtr_config\n");
 224
 225     link->conf.ConfigIndex = 0x61;
 226
 227     /* Determine if this is PRIMARY or ALTERNATE. */
 228
 229     /* Try PRIMARY card at 0xA20-0xA23 */
 230     link->io.BasePort1 = 0xA20;
 231     i = pcmcia_request_io(link, &link->io);
 232     if (i != 0) {
 233         /* Couldn't get 0xA20-0xA23.  Try ALTERNATE at 0xA24-0xA27. */
 234         link->io.BasePort1 = 0xA24;
 235         ret = pcmcia_request_io(link, &link->io);
 236         if (ret)
 237                 goto failed;
 238     }
 239     dev->base_addr = link->io.BasePort1;
 240
 241     ret = pcmcia_request_irq(link, &link->irq);
 242     if (ret)
 243             goto failed;
 244     dev->irq = link->irq.AssignedIRQ;
 245     ti->irq = link->irq.AssignedIRQ;
 246     ti->global_int_enable=GLOBAL_INT_ENABLE+((dev->irq==9) ? 2 : dev->irq);
 247
 248     /* Allocate the MMIO memory window */
 249     req.Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM|WIN_ENABLE;
 250     req.Attributes |= WIN_USE_WAIT;
 251     req.Base = 0;
 252     req.Size = 0x2000;
 253     req.AccessSpeed = 250;
 254     ret = pcmcia_request_window(link, &req, &link->win);
 255     if (ret)
 256             goto failed;
 257
 258     mem.CardOffset = mmiobase;
 259     mem.Page = 0;
 260     ret = pcmcia_map_mem_page(link, link->win, &mem);
 261     if (ret)
 262             goto failed;
 263     ti->mmio = ioremap(req.Base, req.Size);
 264
 265     /* Allocate the SRAM memory window */
 266     req.Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM|WIN_ENABLE;
 267     req.Attributes |= WIN_USE_WAIT;
 268     req.Base = 0;
 269     req.Size = sramsize * 1024;
 270     req.AccessSpeed = 250;
 271     ret = pcmcia_request_window(link, &req, &info->sram_win_handle);
 272     if (ret)
 273             goto failed;
 274
 275     mem.CardOffset = srambase;
 276     mem.Page = 0;
 277     ret = pcmcia_map_mem_page(link, info->sram_win_handle, &mem);
 278     if (ret)
 279             goto failed;
 280
 281     ti->sram_base = mem.CardOffset >> 12;
 282     ti->sram_virt = ioremap(req.Base, req.Size);
 283     ti->sram_phys = req.Base;
 284
 285     ret = pcmcia_request_configuration(link, &link->conf);
 286     if (ret)
 287             goto failed;
 288
 289     /*  Set up the Token-Ring Controller Configuration Register and
 290         turn on the card.  Check the "Local Area Network Credit Card
 291         Adapters Technical Reference"  SC30-3585 for this info.  */
 292     ibmtr_hw_setup(dev, mmiobase);
 293
 294     link->dev_node = &info->node;
 295     SET_NETDEV_DEV(dev, &link->dev);
 296
 297     i = ibmtr_probe_card(dev);
 298     if (i != 0) {
 299         printk(KERN_NOTICE "ibmtr_cs: register_netdev() failed\n");
 300         link->dev_node = NULL;
 301         goto failed;
 302     }
 303
 304     strcpy(info->node.dev_name, dev->name);
 305
 306     printk(KERN_INFO
 307            "%s: port %#3lx, irq %d,  mmio %#5lx, sram %#5lx, hwaddr=%pM\n",
 308            dev->name, dev->base_addr, dev->irq,
 309            (u_long)ti->mmio, (u_long)(ti->sram_base << 12),
 310            dev->dev_addr);
 311     return 0;
 312
 313 failed:
 314     ibmtr_release(link);
 315     return -ENODEV;
 316 } /* ibmtr_config */
 317
 318 /*======================================================================
 319
 320     After a card is removed, ibmtr_release() will unregister the net
 321     device, and release the PCMCIA configuration.  If the device is
 322     still open, this will be postponed until it is closed.
 323
 324 ======================================================================*/
 325
 326 static void ibmtr_release(struct pcmcia_device *link)
 327 {
 328         ibmtr_dev_t *info = link->priv;
 329         struct net_device *dev = info->dev;
 330
 331         dev_dbg(&link->dev, "ibmtr_release\n");
 332
 333         if (link->win) {
 334                 struct tok_info *ti = netdev_priv(dev);
 335                 iounmap(ti->mmio);
 336                 pcmcia_release_window(link, info->sram_win_handle);
 337         }
 338         pcmcia_disable_device(link);
 339 }
 340
 341 static int ibmtr_suspend(struct pcmcia_device *link)
 342 {
 343         ibmtr_dev_t *info = link->priv;
 344         struct net_device *dev = info->dev;
 345
 346         if (link->open)
 347                 netif_device_detach(dev);
 348
 349         return 0;
 350 }
 351
 352 static int __devinit ibmtr_resume(struct pcmcia_device *link)
 353 {
 354         ibmtr_dev_t *info = link->priv;
 355         struct net_device *dev = info->dev;
 356
 357         if (link->open) {
 358                 ibmtr_probe(dev);       /* really? */
 359                 netif_device_attach(dev);
 360         }
 361
 362         return 0;
 363 }
 364
 365
 366 /*====================================================================*/
 367
 368 static void ibmtr_hw_setup(struct net_device *dev, u_int mmiobase)
 369 {
 370     int i;
 371
 372     /* Bizarre IBM behavior, there are 16 bits of information we
 373        need to set, but the card only allows us to send 4 bits at a
 374        time.  For each byte sent to base_addr, bits 7-4 tell the
 375        card which part of the 16 bits we are setting, bits 3-0 contain
 376        the actual information */
 377
 378     /* First nibble provides 4 bits of mmio */
 379     i = (mmiobase >> 16) & 0x0F;
 380     outb(i, dev->base_addr);
 381
 382     /* Second nibble provides 3 bits of mmio */
 383     i = 0x10 | ((mmiobase >> 12) & 0x0E);
 384     outb(i, dev->base_addr);
 385
 386     /* Third nibble, hard-coded values */
 387     i = 0x26;
 388     outb(i, dev->base_addr);
 389
 390     /* Fourth nibble sets shared ram page size */
 391
 392     /* 8 = 00, 16 = 01, 32 = 10, 64 = 11 */
 393     i = (sramsize >> 4) & 0x07;
 394     i = ((i == 4) ? 3 : i) << 2;
 395     i |= 0x30;
 396
 397     if (ringspeed == 16)
 398         i |= 2;
 399     if (dev->base_addr == 0xA24)
 400         i |= 1;
 401     outb(i, dev->base_addr);
 402
 403     /* 0x40 will release the card for use */
 404     outb(0x40, dev->base_addr);
 405
 406     return;
 407 }
 408
 409 static struct pcmcia_device_id ibmtr_ids[] = {
 410         PCMCIA_DEVICE_PROD_ID12("3Com", "TokenLink Velocity PC Card", 0x41240e5b, 0x82c3734e),
 411         PCMCIA_DEVICE_PROD_ID12("IBM", "TOKEN RING", 0xb569a6e5, 0xbf8eed47),
 412         PCMCIA_DEVICE_NULL,
 413 };
 414 MODULE_DEVICE_TABLE(pcmcia, ibmtr_ids);
 415
 416 static struct pcmcia_driver ibmtr_cs_driver = {
 417         .owner          = THIS_MODULE,
 418         .drv            = {
 419                 .name   = "ibmtr_cs",
 420         },
 421         .probe          = ibmtr_attach,
 422         .remove         = ibmtr_detach,
 423         .id_table       = ibmtr_ids,
 424         .suspend        = ibmtr_suspend,
 425         .resume         = ibmtr_resume,
 426 };
 427
 428 static int __init init_ibmtr_cs(void)
 429 {
 430         return pcmcia_register_driver(&ibmtr_cs_driver);
 431 }
 432
 433 static void __exit exit_ibmtr_cs(void)
 434 {
 435         pcmcia_unregister_driver(&ibmtr_cs_driver);
 436 }
 437
 438 module_init(init_ibmtr_cs);
 439 module_exit(exit_ibmtr_cs);