drivers/isdn/hisax/teles_cs.c

   1 /* $Id: teles_cs.c,v 1.1.2.2 2004/01/25 15:07:06 keil Exp $ */
   2 /*======================================================================
   3
   4     A teles S0 PCMCIA client driver
   5
   6     Based on skeleton by David Hinds, dhinds@allegro.stanford.edu
   7     Written by Christof Petig, christof.petig@wtal.de
   8
   9     Also inspired by ELSA PCMCIA driver
  10     by Klaus Lichtenwalder <Lichtenwalder@ACM.org>
  11
  12     Extentions to new hisax_pcmcia by Karsten Keil
  13
  14     minor changes to be compatible with kernel 2.4.x
  15     by Jan.Schubert@GMX.li
  16
  17 ======================================================================*/
  18
  19 #include <linux/kernel.h>
  20 #include <linux/module.h>
  21 #include <linux/init.h>
  22 #include <linux/sched.h>
  23 #include <linux/ptrace.h>
  24 #include <linux/slab.h>
  25 #include <linux/string.h>
  26 #include <linux/timer.h>
  27 #include <linux/ioport.h>
  28 #include <asm/io.h>
  29 #include <asm/system.h>
  30
  31 #include <pcmcia/cs_types.h>
  32 #include <pcmcia/cs.h>
  33 #include <pcmcia/cistpl.h>
  34 #include <pcmcia/cisreg.h>
  35 #include <pcmcia/ds.h>
  36 #include "hisax_cfg.h"
  37
  38 MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Teles PCMCIA cards");
  39 MODULE_AUTHOR("Christof Petig, christof.petig@wtal.de, Karsten Keil, kkeil@suse.de");
  40 MODULE_LICENSE("GPL");
  41
  42 /*
  43    All the PCMCIA modules use PCMCIA_DEBUG to control debugging.  If
  44    you do not define PCMCIA_DEBUG at all, all the debug code will be
  45    left out.  If you compile with PCMCIA_DEBUG=0, the debug code will
  46    be present but disabled -- but it can then be enabled for specific
  47    modules at load time with a 'pc_debug=#' option to insmod.
  48 */
  49
  50 #ifdef PCMCIA_DEBUG
  51 static int pc_debug = PCMCIA_DEBUG;
  52 module_param(pc_debug, int, 0);
  53 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args);
  54 static char *version =
  55 "teles_cs.c 2.10 2002/07/30 22:23:34 kkeil";
  56 #else
  57 #define DEBUG(n, args...)
  58 #endif
  59
  60 /*====================================================================*/
  61
  62 /* Parameters that can be set with 'insmod' */
  63
  64 static int protocol = 2;        /* EURO-ISDN Default */
  65 module_param(protocol, int, 0);
  66
  67 /*====================================================================*/
  68
  69 /*
  70    The event() function is this driver's Card Services event handler.
  71    It will be called by Card Services when an appropriate card status
  72    event is received.  The config() and release() entry points are
  73    used to configure or release a socket, in response to card insertion
  74    and ejection events.  They are invoked from the teles_cs event
  75    handler.
  76 */
  77
  78 static int teles_cs_config(struct pcmcia_device *link);
  79 static void teles_cs_release(struct pcmcia_device *link);
  80
  81 /*
  82    The attach() and detach() entry points are used to create and destroy
  83    "instances" of the driver, where each instance represents everything
  84    needed to manage one actual PCMCIA card.
  85 */
  86
  87 static void teles_detach(struct pcmcia_device *p_dev);
  88
  89 /*
  90    A linked list of "instances" of the teles_cs device.  Each actual
  91    PCMCIA card corresponds to one device instance, and is described
  92    by one struct pcmcia_device structure (defined in ds.h).
  93
  94    You may not want to use a linked list for this -- for example, the
  95    memory card driver uses an array of struct pcmcia_device pointers, where minor
  96    device numbers are used to derive the corresponding array index.
  97 */
  98
  99 /*
 100    A driver needs to provide a dev_node_t structure for each device
 101    on a card.  In some cases, there is only one device per card (for
 102    example, ethernet cards, modems).  In other cases, there may be
 103    many actual or logical devices (SCSI adapters, memory cards with
 104    multiple partitions).  The dev_node_t structures need to be kept
 105    in a linked list starting at the 'dev' field of a struct pcmcia_device
 106    structure.  We allocate them in the card's private data structure,
 107    because they generally shouldn't be allocated dynamically.
 108    In this case, we also provide a flag to indicate if a device is
 109    "stopped" due to a power management event, or card ejection.  The
 110    device IO routines can use a flag like this to throttle IO to a
 111    card that is not ready to accept it.
 112 */
 113
 114 typedef struct local_info_t {
 115         struct pcmcia_device    *p_dev;
 116     dev_node_t          node;
 117     int                 busy;
 118     int                 cardnr;
 119 } local_info_t;
 120
 121 /*======================================================================
 122
 123     teles_attach() creates an "instance" of the driver, allocatingx
 124     local data structures for one device.  The device is registered
 125     with Card Services.
 126
 127     The dev_link structure is initialized, but we don't actually
 128     configure the card at this point -- we wait until we receive a
 129     card insertion event.
 130
 131 ======================================================================*/
 132
 133 static int teles_probe(struct pcmcia_device *link)
 134 {
 135     local_info_t *local;
 136
 137     DEBUG(0, "teles_attach()\n");
 138
 139     /* Allocate space for private device-specific data */
 140     local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
 141     if (!local) return -ENOMEM;
 142     memset(local, 0, sizeof(local_info_t));
 143     local->cardnr = -1;
 144
 145     local->p_dev = link;
 146     link->priv = local;
 147
 148     /* Interrupt setup */
 149     link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED;
 150     link->irq.IRQInfo1 = IRQ_LEVEL_ID|IRQ_SHARE_ID;
 151     link->irq.Handler = NULL;
 152
 153     /*
 154       General socket configuration defaults can go here.  In this
 155       client, we assume very little, and rely on the CIS for almost
 156       everything.  In most clients, many details (i.e., number, sizes,
 157       and attributes of IO windows) are fixed by the nature of the
 158       device, and can be hard-wired here.
 159     */
 160     link->io.NumPorts1 = 96;
 161     link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 162     link->io.IOAddrLines = 5;
 163
 164     link->conf.Attributes = CONF_ENABLE_IRQ;
 165     link->conf.IntType = INT_MEMORY_AND_IO;
 166
 167     return teles_cs_config(link);
 168 } /* teles_attach */
 169
 170 /*======================================================================
 171
 172     This deletes a driver "instance".  The device is de-registered
 173     with Card Services.  If it has been released, all local data
 174     structures are freed.  Otherwise, the structures will be freed
 175     when the device is released.
 176
 177 ======================================================================*/
 178
 179 static void teles_detach(struct pcmcia_device *link)
 180 {
 181         local_info_t *info = link->priv;
 182
 183         DEBUG(0, "teles_detach(0x%p)\n", link);
 184
 185         info->busy = 1;
 186         teles_cs_release(link);
 187
 188         kfree(info);
 189 } /* teles_detach */
 190
 191 /*======================================================================
 192
 193     teles_cs_config() is scheduled to run after a CARD_INSERTION event
 194     is received, to configure the PCMCIA socket, and to make the
 195     device available to the system.
 196
 197 ======================================================================*/
 198 static int get_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 199                      cisparse_t *parse)
 200 {
 201     int i = pcmcia_get_tuple_data(handle, tuple);
 202     if (i != CS_SUCCESS) return i;
 203     return pcmcia_parse_tuple(handle, tuple, parse);
 204 }
 205
 206 static int first_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 207                      cisparse_t *parse)
 208 {
 209     int i = pcmcia_get_first_tuple(handle, tuple);
 210     if (i != CS_SUCCESS) return i;
 211     return get_tuple(handle, tuple, parse);
 212 }
 213
 214 static int next_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 215                      cisparse_t *parse)
 216 {
 217     int i = pcmcia_get_next_tuple(handle, tuple);
 218     if (i != CS_SUCCESS) return i;
 219     return get_tuple(handle, tuple, parse);
 220 }
 221
 222 static int teles_cs_config(struct pcmcia_device *link)
 223 {
 224     tuple_t tuple;
 225     cisparse_t parse;
 226     local_info_t *dev;
 227     int i, j, last_fn;
 228     u_short buf[128];
 229     cistpl_cftable_entry_t *cf = &parse.cftable_entry;
 230     IsdnCard_t icard;
 231
 232     DEBUG(0, "teles_config(0x%p)\n", link);
 233     dev = link->priv;
 234
 235     tuple.TupleData = (cisdata_t *)buf;
 236     tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
 237     tuple.Attributes = 0;
 238     tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
 239     i = first_tuple(link, &tuple, &parse);
 240     while (i == CS_SUCCESS) {
 241         if ( (cf->io.nwin > 0) && cf->io.win[0].base) {
 242             printk(KERN_INFO "(teles_cs: looks like the 96 model)\n");
 243             link->conf.ConfigIndex = cf->index;
 244             link->io.BasePort1 = cf->io.win[0].base;
 245             i = pcmcia_request_io(link, &link->io);
 246             if (i == CS_SUCCESS) break;
 247         } else {
 248           printk(KERN_INFO "(teles_cs: looks like the 97 model)\n");
 249           link->conf.ConfigIndex = cf->index;
 250           for (i = 0, j = 0x2f0; j > 0x100; j -= 0x10) {
 251             link->io.BasePort1 = j;
 252             i = pcmcia_request_io(link, &link->io);
 253             if (i == CS_SUCCESS) break;
 254           }
 255           break;
 256         }
 257         i = next_tuple(link, &tuple, &parse);
 258     }
 259
 260     if (i != CS_SUCCESS) {
 261         last_fn = RequestIO;
 262         goto cs_failed;
 263     }
 264
 265     i = pcmcia_request_irq(link, &link->irq);
 266     if (i != CS_SUCCESS) {
 267         link->irq.AssignedIRQ = 0;
 268         last_fn = RequestIRQ;
 269         goto cs_failed;
 270     }
 271
 272     i = pcmcia_request_configuration(link, &link->conf);
 273     if (i != CS_SUCCESS) {
 274       last_fn = RequestConfiguration;
 275       goto cs_failed;
 276     }
 277
 278     /* At this point, the dev_node_t structure(s) should be
 279        initialized and arranged in a linked list at link->dev. *//*  */
 280     sprintf(dev->node.dev_name, "teles");
 281     dev->node.major = dev->node.minor = 0x0;
 282
 283     link->dev_node = &dev->node;
 284
 285     /* Finally, report what we've done */
 286     printk(KERN_INFO "%s: index 0x%02x:",
 287            dev->node.dev_name, link->conf.ConfigIndex);
 288     if (link->conf.Attributes & CONF_ENABLE_IRQ)
 289         printk(", irq %d", link->irq.AssignedIRQ);
 290     if (link->io.NumPorts1)
 291         printk(", io 0x%04x-0x%04x", link->io.BasePort1,
 292                link->io.BasePort1+link->io.NumPorts1-1);
 293     if (link->io.NumPorts2)
 294         printk(" & 0x%04x-0x%04x", link->io.BasePort2,
 295                link->io.BasePort2+link->io.NumPorts2-1);
 296     printk("\n");
 297
 298     icard.para[0] = link->irq.AssignedIRQ;
 299     icard.para[1] = link->io.BasePort1;
 300     icard.protocol = protocol;
 301     icard.typ = ISDN_CTYPE_TELESPCMCIA;
 302
 303     i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard);
 304     if (i < 0) {
 305         printk(KERN_ERR "teles_cs: failed to initialize Teles PCMCIA %d at i/o %#x\n",
 306                 i, link->io.BasePort1);
 307         teles_cs_release(link);
 308         return -ENODEV;
 309     }
 310
 311     ((local_info_t*)link->priv)->cardnr = i;
 312     return 0;
 313
 314 cs_failed:
 315     cs_error(link, last_fn, i);
 316     teles_cs_release(link);
 317     return -ENODEV;
 318 } /* teles_cs_config */
 319
 320 /*======================================================================
 321
 322     After a card is removed, teles_cs_release() will unregister the net
 323     device, and release the PCMCIA configuration.  If the device is
 324     still open, this will be postponed until it is closed.
 325
 326 ======================================================================*/
 327
 328 static void teles_cs_release(struct pcmcia_device *link)
 329 {
 330     local_info_t *local = link->priv;
 331
 332     DEBUG(0, "teles_cs_release(0x%p)\n", link);
 333
 334     if (local) {
 335         if (local->cardnr >= 0) {
 336             /* no unregister function with hisax */
 337             HiSax_closecard(local->cardnr);
 338         }
 339     }
 340
 341     pcmcia_disable_device(link);
 342 } /* teles_cs_release */
 343
 344 static int teles_suspend(struct pcmcia_device *link)
 345 {
 346         local_info_t *dev = link->priv;
 347
 348         dev->busy = 1;
 349
 350         return 0;
 351 }
 352
 353 static int teles_resume(struct pcmcia_device *link)
 354 {
 355         local_info_t *dev = link->priv;
 356
 357         dev->busy = 0;
 358
 359         return 0;
 360 }
 361
 362
 363 static struct pcmcia_device_id teles_ids[] = {
 364         PCMCIA_DEVICE_PROD_ID12("TELES", "S0/PC", 0x67b50eae, 0xe9e70119),
 365         PCMCIA_DEVICE_NULL,
 366 };
 367 MODULE_DEVICE_TABLE(pcmcia, teles_ids);
 368
 369 static struct pcmcia_driver teles_cs_driver = {
 370         .owner          = THIS_MODULE,
 371         .drv            = {
 372                 .name   = "teles_cs",
 373         },
 374         .probe          = teles_probe,
 375         .remove         = teles_detach,
 376         .id_table       = teles_ids,
 377         .suspend        = teles_suspend,
 378         .resume         = teles_resume,
 379 };
 380
 381 static int __init init_teles_cs(void)
 382 {
 383         return pcmcia_register_driver(&teles_cs_driver);
 384 }
 385
 386 static void __exit exit_teles_cs(void)
 387 {
 388         pcmcia_unregister_driver(&teles_cs_driver);
 389 }
 390
 391 module_init(init_teles_cs);
 392 module_exit(exit_teles_cs);