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/version.h>
  32 #include <pcmcia/cs_types.h>
  33 #include <pcmcia/cs.h>
  34 #include <pcmcia/cistpl.h>
  35 #include <pcmcia/cisreg.h>
  36 #include <pcmcia/ds.h>
  37 #include "hisax_cfg.h"
  38
  39 MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Teles PCMCIA cards");
  40 MODULE_AUTHOR("Christof Petig, christof.petig@wtal.de, Karsten Keil, kkeil@suse.de");
  41 MODULE_LICENSE("GPL");
  42
  43 /*
  44    All the PCMCIA modules use PCMCIA_DEBUG to control debugging.  If
  45    you do not define PCMCIA_DEBUG at all, all the debug code will be
  46    left out.  If you compile with PCMCIA_DEBUG=0, the debug code will
  47    be present but disabled -- but it can then be enabled for specific
  48    modules at load time with a 'pc_debug=#' option to insmod.
  49 */
  50
  51 #ifdef PCMCIA_DEBUG
  52 static int pc_debug = PCMCIA_DEBUG;
  53 MODULE_PARM(pc_debug, "i");
  54 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args);
  55 static char *version =
  56 "teles_cs.c 2.10 2002/07/30 22:23:34 kkeil";
  57 #else
  58 #define DEBUG(n, args...)
  59 #endif
  60
  61 /*====================================================================*/
  62
  63 /* Parameters that can be set with 'insmod' */
  64
  65 /* Bit map of interrupts to choose from, the old way */
  66 /* This means pick from 15, 14, 12, 11, 10, 9, 7, 5, 4, 3 */
  67 static u_long irq_mask = 0xdeb8;
  68
  69 /* Newer, simpler way of listing specific interrupts */
  70 static int irq_list[4] = { -1 };
  71
  72 MODULE_PARM(irq_mask, "i");
  73 MODULE_PARM(irq_list, "1-4i");
  74
  75 static int protocol = 2;        /* EURO-ISDN Default */
  76 MODULE_PARM(protocol, "i");
  77
  78 /*====================================================================*/
  79
  80 /*
  81    The event() function is this driver's Card Services event handler.
  82    It will be called by Card Services when an appropriate card status
  83    event is received.  The config() and release() entry points are
  84    used to configure or release a socket, in response to card insertion
  85    and ejection events.  They are invoked from the teles_cs event
  86    handler.
  87 */
  88
  89 static void teles_cs_config(dev_link_t *link);
  90 static void teles_cs_release(dev_link_t *link);
  91 static int teles_cs_event(event_t event, int priority,
  92                           event_callback_args_t *args);
  93
  94 /*
  95    The attach() and detach() entry points are used to create and destroy
  96    "instances" of the driver, where each instance represents everything
  97    needed to manage one actual PCMCIA card.
  98 */
  99
 100 static dev_link_t *teles_attach(void);
 101 static void teles_detach(dev_link_t *);
 102
 103 /*
 104    The dev_info variable is the "key" that is used to match up this
 105    device driver with appropriate cards, through the card configuration
 106    database.
 107 */
 108
 109 static dev_info_t dev_info = "teles_cs";
 110
 111 /*
 112    A linked list of "instances" of the teles_cs device.  Each actual
 113    PCMCIA card corresponds to one device instance, and is described
 114    by one dev_link_t structure (defined in ds.h).
 115
 116    You may not want to use a linked list for this -- for example, the
 117    memory card driver uses an array of dev_link_t pointers, where minor
 118    device numbers are used to derive the corresponding array index.
 119 */
 120
 121 static dev_link_t *dev_list = NULL;
 122
 123 /*
 124    A dev_link_t structure has fields for most things that are needed
 125    to keep track of a socket, but there will usually be some device
 126    specific information that also needs to be kept track of.  The
 127    'priv' pointer in a dev_link_t structure can be used to point to
 128    a device-specific private data structure, like this.
 129
 130    To simplify the data structure handling, we actually include the
 131    dev_link_t structure in the device's private data structure.
 132
 133    A driver needs to provide a dev_node_t structure for each device
 134    on a card.  In some cases, there is only one device per card (for
 135    example, ethernet cards, modems).  In other cases, there may be
 136    many actual or logical devices (SCSI adapters, memory cards with
 137    multiple partitions).  The dev_node_t structures need to be kept
 138    in a linked list starting at the 'dev' field of a dev_link_t
 139    structure.  We allocate them in the card's private data structure,
 140    because they generally shouldn't be allocated dynamically.
 141    In this case, we also provide a flag to indicate if a device is
 142    "stopped" due to a power management event, or card ejection.  The
 143    device IO routines can use a flag like this to throttle IO to a
 144    card that is not ready to accept it.
 145 */
 146
 147 typedef struct local_info_t {
 148     dev_link_t          link;
 149     dev_node_t          node;
 150     int                 busy;
 151     int                 cardnr;
 152 } local_info_t;
 153
 154 /*======================================================================
 155
 156     teles_attach() creates an "instance" of the driver, allocatingx
 157     local data structures for one device.  The device is registered
 158     with Card Services.
 159
 160     The dev_link structure is initialized, but we don't actually
 161     configure the card at this point -- we wait until we receive a
 162     card insertion event.
 163
 164 ======================================================================*/
 165
 166 static dev_link_t *teles_attach(void)
 167 {
 168     client_reg_t client_reg;
 169     dev_link_t *link;
 170     local_info_t *local;
 171     int ret, i;
 172
 173     DEBUG(0, "teles_attach()\n");
 174
 175     /* Allocate space for private device-specific data */
 176     local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
 177     if (!local) return NULL;
 178     memset(local, 0, sizeof(local_info_t));
 179     local->cardnr = -1;
 180     link = &local->link; link->priv = local;
 181
 182     /* Interrupt setup */
 183     link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED;
 184     link->irq.IRQInfo1 = IRQ_INFO2_VALID|IRQ_LEVEL_ID|IRQ_SHARE_ID;
 185     if (irq_list[0] == -1)
 186         link->irq.IRQInfo2 = irq_mask;
 187     else
 188         for (i = 0; i < 4; i++)
 189             link->irq.IRQInfo2 |= 1 << irq_list[i];
 190     link->irq.Handler = NULL;
 191
 192     /*
 193       General socket configuration defaults can go here.  In this
 194       client, we assume very little, and rely on the CIS for almost
 195       everything.  In most clients, many details (i.e., number, sizes,
 196       and attributes of IO windows) are fixed by the nature of the
 197       device, and can be hard-wired here.
 198     */
 199     link->io.NumPorts1 = 96;
 200     link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 201     link->io.IOAddrLines = 5;
 202
 203     link->conf.Attributes = CONF_ENABLE_IRQ;
 204     link->conf.Vcc = 50;
 205     link->conf.IntType = INT_MEMORY_AND_IO;
 206
 207     /* Register with Card Services */
 208     link->next = dev_list;
 209     dev_list = link;
 210     client_reg.dev_info = &dev_info;
 211     client_reg.Attributes = INFO_IO_CLIENT | INFO_CARD_SHARE;
 212     client_reg.EventMask =
 213         CS_EVENT_CARD_INSERTION | CS_EVENT_CARD_REMOVAL |
 214         CS_EVENT_RESET_PHYSICAL | CS_EVENT_CARD_RESET |
 215         CS_EVENT_PM_SUSPEND | CS_EVENT_PM_RESUME;
 216     client_reg.event_handler = &teles_cs_event;
 217     client_reg.Version = 0x0210;
 218     client_reg.event_callback_args.client_data = link;
 219     ret = pcmcia_register_client(&link->handle, &client_reg);
 220     if (ret != CS_SUCCESS) {
 221         cs_error(link->handle, RegisterClient, ret);
 222         teles_detach(link);
 223         return NULL;
 224     }
 225
 226     return link;
 227 } /* teles_attach */
 228
 229 /*======================================================================
 230
 231     This deletes a driver "instance".  The device is de-registered
 232     with Card Services.  If it has been released, all local data
 233     structures are freed.  Otherwise, the structures will be freed
 234     when the device is released.
 235
 236 ======================================================================*/
 237
 238 static void teles_detach(dev_link_t *link)
 239 {
 240     dev_link_t **linkp;
 241     local_info_t *info = link->priv;
 242     int ret;
 243
 244     DEBUG(0, "teles_detach(0x%p)\n", link);
 245
 246     /* Locate device structure */
 247     for (linkp = &dev_list; *linkp; linkp = &(*linkp)->next)
 248         if (*linkp == link) break;
 249     if (*linkp == NULL)
 250         return;
 251
 252     if (link->state & DEV_CONFIG)
 253         teles_cs_release(link);
 254
 255     /*
 256        If the device is currently configured and active, we won't
 257        actually delete it yet.  Instead, it is marked so that when
 258        the release() function is called, that will trigger a proper
 259        detach().
 260     */
 261     if (link->state & DEV_CONFIG) {
 262       DEBUG(0, "teles_cs: detach postponed, '%s' "
 263                "still locked\n", link->dev->dev_name);
 264         link->state |= DEV_STALE_LINK;
 265         return;
 266     }
 267
 268     /* Break the link with Card Services */
 269     if (link->handle) {
 270         ret = pcmcia_deregister_client(link->handle);
 271         if (ret != CS_SUCCESS)
 272             cs_error(link->handle, DeregisterClient, ret);
 273     }
 274
 275     /* Unlink device structure and free it */
 276     *linkp = link->next;
 277     kfree(info);
 278
 279 } /* teles_detach */
 280
 281 /*======================================================================
 282
 283     teles_cs_config() is scheduled to run after a CARD_INSERTION event
 284     is received, to configure the PCMCIA socket, and to make the
 285     device available to the system.
 286
 287 ======================================================================*/
 288 static int get_tuple(client_handle_t handle, tuple_t *tuple,
 289                      cisparse_t *parse)
 290 {
 291     int i = pcmcia_get_tuple_data(handle, tuple);
 292     if (i != CS_SUCCESS) return i;
 293     return pcmcia_parse_tuple(handle, tuple, parse);
 294 }
 295
 296 static int first_tuple(client_handle_t handle, tuple_t *tuple,
 297                      cisparse_t *parse)
 298 {
 299     int i = pcmcia_get_first_tuple(handle, tuple);
 300     if (i != CS_SUCCESS) return i;
 301     return get_tuple(handle, tuple, parse);
 302 }
 303
 304 static int next_tuple(client_handle_t handle, tuple_t *tuple,
 305                      cisparse_t *parse)
 306 {
 307     int i = pcmcia_get_next_tuple(handle, tuple);
 308     if (i != CS_SUCCESS) return i;
 309     return get_tuple(handle, tuple, parse);
 310 }
 311
 312 static void teles_cs_config(dev_link_t *link)
 313 {
 314     client_handle_t handle;
 315     tuple_t tuple;
 316     cisparse_t parse;
 317     local_info_t *dev;
 318     int i, j, last_fn;
 319     u_short buf[128];
 320     cistpl_cftable_entry_t *cf = &parse.cftable_entry;
 321     IsdnCard_t icard;
 322
 323     DEBUG(0, "teles_config(0x%p)\n", link);
 324     handle = link->handle;
 325     dev = link->priv;
 326
 327     /*
 328        This reads the card's CONFIG tuple to find its configuration
 329        registers.
 330     */
 331     tuple.DesiredTuple = CISTPL_CONFIG;
 332     tuple.TupleData = (cisdata_t *)buf;
 333     tuple.TupleDataMax = 255;
 334     tuple.TupleOffset = 0;
 335     tuple.Attributes = 0;
 336     i = first_tuple(handle, &tuple, &parse);
 337     if (i != CS_SUCCESS) {
 338         last_fn = ParseTuple;
 339         goto cs_failed;
 340     }
 341     link->conf.ConfigBase = parse.config.base;
 342     link->conf.Present = parse.config.rmask[0];
 343
 344     /* Configure card */
 345     link->state |= DEV_CONFIG;
 346
 347     tuple.TupleData = (cisdata_t *)buf;
 348     tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
 349     tuple.Attributes = 0;
 350     tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
 351     i = first_tuple(handle, &tuple, &parse);
 352     while (i == CS_SUCCESS) {
 353         if ( (cf->io.nwin > 0) && cf->io.win[0].base) {
 354             printk(KERN_INFO "(teles_cs: looks like the 96 model)\n");
 355             link->conf.ConfigIndex = cf->index;
 356             link->io.BasePort1 = cf->io.win[0].base;
 357             i = pcmcia_request_io(link->handle, &link->io);
 358             if (i == CS_SUCCESS) break;
 359         } else {
 360           printk(KERN_INFO "(teles_cs: looks like the 97 model)\n");
 361           link->conf.ConfigIndex = cf->index;
 362           for (i = 0, j = 0x2f0; j > 0x100; j -= 0x10) {
 363             link->io.BasePort1 = j;
 364             i = pcmcia_request_io(link->handle, &link->io);
 365             if (i == CS_SUCCESS) break;
 366           }
 367           break;
 368         }
 369         i = next_tuple(handle, &tuple, &parse);
 370     }
 371
 372     if (i != CS_SUCCESS) {
 373         last_fn = RequestIO;
 374         goto cs_failed;
 375     }
 376
 377     i = pcmcia_request_irq(link->handle, &link->irq);
 378     if (i != CS_SUCCESS) {
 379         link->irq.AssignedIRQ = 0;
 380         last_fn = RequestIRQ;
 381         goto cs_failed;
 382     }
 383
 384     i = pcmcia_request_configuration(link->handle, &link->conf);
 385     if (i != CS_SUCCESS) {
 386       last_fn = RequestConfiguration;
 387       goto cs_failed;
 388     }
 389
 390     /* At this point, the dev_node_t structure(s) should be
 391        initialized and arranged in a linked list at link->dev. *//*  */
 392     sprintf(dev->node.dev_name, "teles");
 393     dev->node.major = dev->node.minor = 0x0;
 394
 395     link->dev = &dev->node;
 396
 397     /* Finally, report what we've done */
 398     printk(KERN_INFO "%s: index 0x%02x: Vcc %d.%d",
 399            dev->node.dev_name, link->conf.ConfigIndex,
 400            link->conf.Vcc/10, link->conf.Vcc%10);
 401     if (link->conf.Vpp1)
 402         printk(", Vpp %d.%d", link->conf.Vpp1/10, link->conf.Vpp1%10);
 403     if (link->conf.Attributes & CONF_ENABLE_IRQ)
 404         printk(", irq %d", link->irq.AssignedIRQ);
 405     if (link->io.NumPorts1)
 406         printk(", io 0x%04x-0x%04x", link->io.BasePort1,
 407                link->io.BasePort1+link->io.NumPorts1-1);
 408     if (link->io.NumPorts2)
 409         printk(" & 0x%04x-0x%04x", link->io.BasePort2,
 410                link->io.BasePort2+link->io.NumPorts2-1);
 411     printk("\n");
 412
 413     link->state &= ~DEV_CONFIG_PENDING;
 414
 415     icard.para[0] = link->irq.AssignedIRQ;
 416     icard.para[1] = link->io.BasePort1;
 417     icard.protocol = protocol;
 418     icard.typ = ISDN_CTYPE_TELESPCMCIA;
 419
 420     i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard);
 421     if (i < 0) {
 422         printk(KERN_ERR "teles_cs: failed to initialize Teles PCMCIA %d at i/o %#x\n",
 423                 i, link->io.BasePort1);
 424         teles_cs_release(link);
 425     } else
 426         ((local_info_t*)link->priv)->cardnr = i;
 427
 428     return;
 429 cs_failed:
 430     cs_error(link->handle, last_fn, i);
 431     teles_cs_release(link);
 432 } /* teles_cs_config */
 433
 434 /*======================================================================
 435
 436     After a card is removed, teles_cs_release() will unregister the net
 437     device, and release the PCMCIA configuration.  If the device is
 438     still open, this will be postponed until it is closed.
 439
 440 ======================================================================*/
 441
 442 static void teles_cs_release(dev_link_t *link)
 443 {
 444     local_info_t *local = link->priv;
 445
 446     DEBUG(0, "teles_cs_release(0x%p)\n", link);
 447
 448     if (local) {
 449         if (local->cardnr >= 0) {
 450             /* no unregister function with hisax */
 451             HiSax_closecard(local->cardnr);
 452         }
 453     }
 454     /* Unlink the device chain */
 455     link->dev = NULL;
 456
 457     /* Don't bother checking to see if these succeed or not */
 458     if (link->win)
 459         pcmcia_release_window(link->win);
 460     pcmcia_release_configuration(link->handle);
 461     pcmcia_release_io(link->handle, &link->io);
 462     pcmcia_release_irq(link->handle, &link->irq);
 463     link->state &= ~DEV_CONFIG;
 464
 465     if (link->state & DEV_STALE_LINK)
 466         teles_detach(link);
 467
 468 } /* teles_cs_release */
 469
 470 /*======================================================================
 471
 472     The card status event handler.  Mostly, this schedules other
 473     stuff to run after an event is received.  A CARD_REMOVAL event
 474     also sets some flags to discourage the net drivers from trying
 475     to talk to the card any more.
 476
 477     When a CARD_REMOVAL event is received, we immediately set a flag
 478     to block future accesses to this device.  All the functions that
 479     actually access the device should check this flag to make sure
 480     the card is still present.
 481
 482 ======================================================================*/
 483
 484 static int teles_cs_event(event_t event, int priority,
 485                           event_callback_args_t *args)
 486 {
 487     dev_link_t *link = args->client_data;
 488     local_info_t *dev = link->priv;
 489
 490     DEBUG(1, "teles_cs_event(%d)\n", event);
 491
 492     switch (event) {
 493     case CS_EVENT_CARD_REMOVAL:
 494         link->state &= ~DEV_PRESENT;
 495         if (link->state & DEV_CONFIG) {
 496             ((local_info_t*)link->priv)->busy = 1;
 497             teles_cs_release(link);
 498         }
 499         break;
 500     case CS_EVENT_CARD_INSERTION:
 501         link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
 502         teles_cs_config(link);
 503         break;
 504     case CS_EVENT_PM_SUSPEND:
 505         link->state |= DEV_SUSPEND;
 506         /* Fall through... */
 507     case CS_EVENT_RESET_PHYSICAL:
 508         /* Mark the device as stopped, to block IO until later */
 509         dev->busy = 1;
 510         if (link->state & DEV_CONFIG)
 511             pcmcia_release_configuration(link->handle);
 512         break;
 513     case CS_EVENT_PM_RESUME:
 514         link->state &= ~DEV_SUSPEND;
 515         /* Fall through... */
 516     case CS_EVENT_CARD_RESET:
 517         if (link->state & DEV_CONFIG)
 518             pcmcia_request_configuration(link->handle, &link->conf);
 519         dev->busy = 0;
 520         break;
 521     }
 522     return 0;
 523 } /* teles_cs_event */
 524
 525 static struct pcmcia_driver teles_cs_driver = {
 526         .owner          = THIS_MODULE,
 527         .drv            = {
 528                 .name   = "teles_cs",
 529         },
 530         .attach         = teles_attach,
 531         .detach         = teles_detach,
 532 };
 533
 534 static int __init init_teles_cs(void)
 535 {
 536         return pcmcia_register_driver(&teles_cs_driver);
 537 }
 538
 539 static void __exit exit_teles_cs(void)
 540 {
 541         pcmcia_unregister_driver(&teles_cs_driver);
 542
 543         /* XXX: this really needs to move into generic code.. */
 544         while (dev_list != NULL)
 545                 teles_detach(dev_list);
 546 }
 547
 548 module_init(init_teles_cs);
 549 module_exit(exit_teles_cs);