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/cs_types.h>
  51 #include <pcmcia/cs.h>
  52 #include <pcmcia/cistpl.h>
  53 #include <pcmcia/cisreg.h>
  54 #include <pcmcia/ds.h>
  55 #include "hisax_cfg.h"
  56
  57 MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Elsa PCM cards");
  58 MODULE_AUTHOR("Klaus Lichtenwalder");
  59 MODULE_LICENSE("Dual MPL/GPL");
  60
  61 /*
  62    All the PCMCIA modules use PCMCIA_DEBUG to control debugging.  If
  63    you do not define PCMCIA_DEBUG at all, all the debug code will be
  64    left out.  If you compile with PCMCIA_DEBUG=0, the debug code will
  65    be present but disabled -- but it can then be enabled for specific
  66    modules at load time with a 'pc_debug=#' option to insmod.
  67 */
  68
  69 #ifdef PCMCIA_DEBUG
  70 static int pc_debug = PCMCIA_DEBUG;
  71 module_param(pc_debug, int, 0);
  72 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args);
  73 static char *version =
  74 "elsa_cs.c $Revision: 1.2.2.4 $ $Date: 2004/01/25 15:07:06 $ (K.Lichtenwalder)";
  75 #else
  76 #define DEBUG(n, args...)
  77 #endif
  78
  79 /*====================================================================*/
  80
  81 /* Parameters that can be set with 'insmod' */
  82
  83 static int protocol = 2;        /* EURO-ISDN Default */
  84 module_param(protocol, int, 0);
  85
  86 /*====================================================================*/
  87
  88 /*
  89    The event() function is this driver's Card Services event handler.
  90    It will be called by Card Services when an appropriate card status
  91    event is received.  The config() and release() entry points are
  92    used to configure or release a socket, in response to card insertion
  93    and ejection events.  They are invoked from the elsa_cs event
  94    handler.
  95 */
  96
  97 static void elsa_cs_config(struct pcmcia_device *link);
  98 static void elsa_cs_release(struct pcmcia_device *link);
  99
 100 /*
 101    The attach() and detach() entry points are used to create and destroy
 102    "instances" of the driver, where each instance represents everything
 103    needed to manage one actual PCMCIA card.
 104 */
 105
 106 static void elsa_cs_detach(struct pcmcia_device *p_dev);
 107
 108 /*
 109    A driver needs to provide a dev_node_t structure for each device
 110    on a card.  In some cases, there is only one device per card (for
 111    example, ethernet cards, modems).  In other cases, there may be
 112    many actual or logical devices (SCSI adapters, memory cards with
 113    multiple partitions).  The dev_node_t structures need to be kept
 114    in a linked list starting at the 'dev' field of a struct pcmcia_device
 115    structure.  We allocate them in the card's private data structure,
 116    because they generally shouldn't be allocated dynamically.
 117    In this case, we also provide a flag to indicate if a device is
 118    "stopped" due to a power management event, or card ejection.  The
 119    device IO routines can use a flag like this to throttle IO to a
 120    card that is not ready to accept it.
 121 */
 122
 123 typedef struct local_info_t {
 124         struct pcmcia_device    *p_dev;
 125     dev_node_t          node;
 126     int                 busy;
 127     int                 cardnr;
 128 } local_info_t;
 129
 130 /*======================================================================
 131
 132     elsa_cs_attach() creates an "instance" of the driver, allocatingx
 133     local data structures for one device.  The device is registered
 134     with Card Services.
 135
 136     The dev_link structure is initialized, but we don't actually
 137     configure the card at this point -- we wait until we receive a
 138     card insertion event.
 139
 140 ======================================================================*/
 141
 142 static int elsa_cs_attach(struct pcmcia_device *link)
 143 {
 144     local_info_t *local;
 145
 146     DEBUG(0, "elsa_cs_attach()\n");
 147
 148     /* Allocate space for private device-specific data */
 149     local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
 150     if (!local) return -ENOMEM;
 151     memset(local, 0, sizeof(local_info_t));
 152
 153     local->p_dev = link;
 154     link->priv = local;
 155
 156     local->cardnr = -1;
 157
 158     /* Interrupt setup */
 159     link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED;
 160     link->irq.IRQInfo1 = IRQ_LEVEL_ID|IRQ_SHARE_ID;
 161     link->irq.Handler = NULL;
 162
 163     /*
 164       General socket configuration defaults can go here.  In this
 165       client, we assume very little, and rely on the CIS for almost
 166       everything.  In most clients, many details (i.e., number, sizes,
 167       and attributes of IO windows) are fixed by the nature of the
 168       device, and can be hard-wired here.
 169     */
 170     link->io.NumPorts1 = 8;
 171     link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 172     link->io.IOAddrLines = 3;
 173
 174     link->conf.Attributes = CONF_ENABLE_IRQ;
 175     link->conf.IntType = INT_MEMORY_AND_IO;
 176
 177     link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
 178     elsa_cs_config(link);
 179
 180     return 0;
 181 } /* elsa_cs_attach */
 182
 183 /*======================================================================
 184
 185     This deletes a driver "instance".  The device is de-registered
 186     with Card Services.  If it has been released, all local data
 187     structures are freed.  Otherwise, the structures will be freed
 188     when the device is released.
 189
 190 ======================================================================*/
 191
 192 static void elsa_cs_detach(struct pcmcia_device *link)
 193 {
 194     local_info_t *info = link->priv;
 195
 196     DEBUG(0, "elsa_cs_detach(0x%p)\n", link);
 197
 198     if (link->state & DEV_CONFIG) {
 199             info->busy = 1;
 200             elsa_cs_release(link);
 201     }
 202
 203     kfree(info);
 204
 205 } /* elsa_cs_detach */
 206
 207 /*======================================================================
 208
 209     elsa_cs_config() is scheduled to run after a CARD_INSERTION event
 210     is received, to configure the PCMCIA socket, and to make the
 211     device available to the system.
 212
 213 ======================================================================*/
 214 static int get_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 215                      cisparse_t *parse)
 216 {
 217     int i = pcmcia_get_tuple_data(handle, tuple);
 218     if (i != CS_SUCCESS) return i;
 219     return pcmcia_parse_tuple(handle, tuple, parse);
 220 }
 221
 222 static int first_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 223                      cisparse_t *parse)
 224 {
 225     int i = pcmcia_get_first_tuple(handle, tuple);
 226     if (i != CS_SUCCESS) return i;
 227     return get_tuple(handle, tuple, parse);
 228 }
 229
 230 static int next_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 231                      cisparse_t *parse)
 232 {
 233     int i = pcmcia_get_next_tuple(handle, tuple);
 234     if (i != CS_SUCCESS) return i;
 235     return get_tuple(handle, tuple, parse);
 236 }
 237
 238 static void elsa_cs_config(struct pcmcia_device *link)
 239 {
 240     tuple_t tuple;
 241     cisparse_t parse;
 242     local_info_t *dev;
 243     int i, j, last_fn;
 244     u_short buf[128];
 245     cistpl_cftable_entry_t *cf = &parse.cftable_entry;
 246     IsdnCard_t icard;
 247
 248     DEBUG(0, "elsa_config(0x%p)\n", link);
 249     dev = link->priv;
 250
 251     /*
 252        This reads the card's CONFIG tuple to find its configuration
 253        registers.
 254     */
 255     tuple.DesiredTuple = CISTPL_CONFIG;
 256     tuple.TupleData = (cisdata_t *)buf;
 257     tuple.TupleDataMax = 255;
 258     tuple.TupleOffset = 0;
 259     tuple.Attributes = 0;
 260     i = first_tuple(link, &tuple, &parse);
 261     if (i != CS_SUCCESS) {
 262         last_fn = ParseTuple;
 263         goto cs_failed;
 264     }
 265     link->conf.ConfigBase = parse.config.base;
 266     link->conf.Present = parse.config.rmask[0];
 267
 268     /* Configure card */
 269     link->state |= DEV_CONFIG;
 270
 271     tuple.TupleData = (cisdata_t *)buf;
 272     tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
 273     tuple.Attributes = 0;
 274     tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
 275     i = first_tuple(link, &tuple, &parse);
 276     while (i == CS_SUCCESS) {
 277         if ( (cf->io.nwin > 0) && cf->io.win[0].base) {
 278             printk(KERN_INFO "(elsa_cs: looks like the 96 model)\n");
 279             link->conf.ConfigIndex = cf->index;
 280             link->io.BasePort1 = cf->io.win[0].base;
 281             i = pcmcia_request_io(link, &link->io);
 282             if (i == CS_SUCCESS) break;
 283         } else {
 284           printk(KERN_INFO "(elsa_cs: looks like the 97 model)\n");
 285           link->conf.ConfigIndex = cf->index;
 286           for (i = 0, j = 0x2f0; j > 0x100; j -= 0x10) {
 287             link->io.BasePort1 = j;
 288             i = pcmcia_request_io(link, &link->io);
 289             if (i == CS_SUCCESS) break;
 290           }
 291           break;
 292         }
 293         i = next_tuple(link, &tuple, &parse);
 294     }
 295
 296     if (i != CS_SUCCESS) {
 297         last_fn = RequestIO;
 298         goto cs_failed;
 299     }
 300
 301     i = pcmcia_request_irq(link, &link->irq);
 302     if (i != CS_SUCCESS) {
 303         link->irq.AssignedIRQ = 0;
 304         last_fn = RequestIRQ;
 305         goto cs_failed;
 306     }
 307
 308     i = pcmcia_request_configuration(link, &link->conf);
 309     if (i != CS_SUCCESS) {
 310       last_fn = RequestConfiguration;
 311       goto cs_failed;
 312     }
 313
 314     /* At this point, the dev_node_t structure(s) should be
 315        initialized and arranged in a linked list at link->dev. *//*  */
 316     sprintf(dev->node.dev_name, "elsa");
 317     dev->node.major = dev->node.minor = 0x0;
 318
 319     link->dev_node = &dev->node;
 320
 321     /* Finally, report what we've done */
 322     printk(KERN_INFO "%s: index 0x%02x: ",
 323            dev->node.dev_name, link->conf.ConfigIndex);
 324     if (link->conf.Attributes & CONF_ENABLE_IRQ)
 325         printk(", irq %d", link->irq.AssignedIRQ);
 326     if (link->io.NumPorts1)
 327         printk(", io 0x%04x-0x%04x", link->io.BasePort1,
 328                link->io.BasePort1+link->io.NumPorts1-1);
 329     if (link->io.NumPorts2)
 330         printk(" & 0x%04x-0x%04x", link->io.BasePort2,
 331                link->io.BasePort2+link->io.NumPorts2-1);
 332     printk("\n");
 333
 334     link->state &= ~DEV_CONFIG_PENDING;
 335
 336     icard.para[0] = link->irq.AssignedIRQ;
 337     icard.para[1] = link->io.BasePort1;
 338     icard.protocol = protocol;
 339     icard.typ = ISDN_CTYPE_ELSA_PCMCIA;
 340
 341     i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard);
 342     if (i < 0) {
 343         printk(KERN_ERR "elsa_cs: failed to initialize Elsa PCMCIA %d at i/o %#x\n",
 344                 i, link->io.BasePort1);
 345         elsa_cs_release(link);
 346     } else
 347         ((local_info_t*)link->priv)->cardnr = i;
 348
 349     return;
 350 cs_failed:
 351     cs_error(link, last_fn, i);
 352     elsa_cs_release(link);
 353 } /* elsa_cs_config */
 354
 355 /*======================================================================
 356
 357     After a card is removed, elsa_cs_release() will unregister the net
 358     device, and release the PCMCIA configuration.  If the device is
 359     still open, this will be postponed until it is closed.
 360
 361 ======================================================================*/
 362
 363 static void elsa_cs_release(struct pcmcia_device *link)
 364 {
 365     local_info_t *local = link->priv;
 366
 367     DEBUG(0, "elsa_cs_release(0x%p)\n", link);
 368
 369     if (local) {
 370         if (local->cardnr >= 0) {
 371             /* no unregister function with hisax */
 372             HiSax_closecard(local->cardnr);
 373         }
 374     }
 375
 376     pcmcia_disable_device(link);
 377 } /* elsa_cs_release */
 378
 379 static int elsa_suspend(struct pcmcia_device *link)
 380 {
 381         local_info_t *dev = link->priv;
 382
 383         dev->busy = 1;
 384
 385         return 0;
 386 }
 387
 388 static int elsa_resume(struct pcmcia_device *link)
 389 {
 390         local_info_t *dev = link->priv;
 391
 392         dev->busy = 0;
 393
 394         return 0;
 395 }
 396
 397 static struct pcmcia_device_id elsa_ids[] = {
 398         PCMCIA_DEVICE_PROD_ID12("ELSA AG (Aachen, Germany)", "MicroLink ISDN/MC ", 0x983de2c4, 0x333ba257),
 399         PCMCIA_DEVICE_PROD_ID12("ELSA GmbH, Aachen", "MicroLink ISDN/MC ", 0x639e5718, 0x333ba257),
 400         PCMCIA_DEVICE_NULL
 401 };
 402 MODULE_DEVICE_TABLE(pcmcia, elsa_ids);
 403
 404 static struct pcmcia_driver elsa_cs_driver = {
 405         .owner          = THIS_MODULE,
 406         .drv            = {
 407                 .name   = "elsa_cs",
 408         },
 409         .probe          = elsa_cs_attach,
 410         .remove         = elsa_cs_detach,
 411         .id_table       = elsa_ids,
 412         .suspend        = elsa_suspend,
 413         .resume         = elsa_resume,
 414 };
 415
 416 static int __init init_elsa_cs(void)
 417 {
 418         return pcmcia_register_driver(&elsa_cs_driver);
 419 }
 420
 421 static void __exit exit_elsa_cs(void)
 422 {
 423         pcmcia_unregister_driver(&elsa_cs_driver);
 424 }
 425
 426 module_init(init_elsa_cs);
 427 module_exit(exit_elsa_cs);