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