drivers/isdn/hisax/elsa_cs.c

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