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