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 int 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_probe(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 = kzalloc(sizeof(local_info_t), GFP_KERNEL);
 150     if (!local) return -ENOMEM;
 151
 152     local->p_dev = link;
 153     link->priv = local;
 154
 155     local->cardnr = -1;
 156
 157     /* Interrupt setup */
 158     link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED;
 159     link->irq.IRQInfo1 = IRQ_LEVEL_ID|IRQ_SHARE_ID;
 160     link->irq.Handler = NULL;
 161
 162     /*
 163       General socket configuration defaults can go here.  In this
 164       client, we assume very little, and rely on the CIS for almost
 165       everything.  In most clients, many details (i.e., number, sizes,
 166       and attributes of IO windows) are fixed by the nature of the
 167       device, and can be hard-wired here.
 168     */
 169     link->io.NumPorts1 = 8;
 170     link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 171     link->io.IOAddrLines = 3;
 172
 173     link->conf.Attributes = CONF_ENABLE_IRQ;
 174     link->conf.IntType = INT_MEMORY_AND_IO;
 175
 176     return elsa_cs_config(link);
 177 } /* elsa_cs_attach */
 178
 179 /*======================================================================
 180
 181     This deletes a driver "instance".  The device is de-registered
 182     with Card Services.  If it has been released, all local data
 183     structures are freed.  Otherwise, the structures will be freed
 184     when the device is released.
 185
 186 ======================================================================*/
 187
 188 static void elsa_cs_detach(struct pcmcia_device *link)
 189 {
 190         local_info_t *info = link->priv;
 191
 192         DEBUG(0, "elsa_cs_detach(0x%p)\n", link);
 193
 194         info->busy = 1;
 195         elsa_cs_release(link);
 196
 197         kfree(info);
 198 } /* elsa_cs_detach */
 199
 200 /*======================================================================
 201
 202     elsa_cs_config() is scheduled to run after a CARD_INSERTION event
 203     is received, to configure the PCMCIA socket, and to make the
 204     device available to the system.
 205
 206 ======================================================================*/
 207 static int get_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 208                      cisparse_t *parse)
 209 {
 210     int i = pcmcia_get_tuple_data(handle, tuple);
 211     if (i != CS_SUCCESS) return i;
 212     return pcmcia_parse_tuple(handle, tuple, parse);
 213 }
 214
 215 static int first_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 216                      cisparse_t *parse)
 217 {
 218     int i = pcmcia_get_first_tuple(handle, tuple);
 219     if (i != CS_SUCCESS) return i;
 220     return get_tuple(handle, tuple, parse);
 221 }
 222
 223 static int next_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 224                      cisparse_t *parse)
 225 {
 226     int i = pcmcia_get_next_tuple(handle, tuple);
 227     if (i != CS_SUCCESS) return i;
 228     return get_tuple(handle, tuple, parse);
 229 }
 230
 231 static int elsa_cs_config(struct pcmcia_device *link)
 232 {
 233     tuple_t tuple;
 234     cisparse_t parse;
 235     local_info_t *dev;
 236     int i, j, last_fn;
 237     u_short buf[128];
 238     cistpl_cftable_entry_t *cf = &parse.cftable_entry;
 239     IsdnCard_t icard;
 240
 241     DEBUG(0, "elsa_config(0x%p)\n", link);
 242     dev = link->priv;
 243
 244     tuple.TupleData = (cisdata_t *)buf;
 245     tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
 246     tuple.Attributes = 0;
 247     tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
 248     i = first_tuple(link, &tuple, &parse);
 249     while (i == CS_SUCCESS) {
 250         if ( (cf->io.nwin > 0) && cf->io.win[0].base) {
 251             printk(KERN_INFO "(elsa_cs: looks like the 96 model)\n");
 252             link->conf.ConfigIndex = cf->index;
 253             link->io.BasePort1 = cf->io.win[0].base;
 254             i = pcmcia_request_io(link, &link->io);
 255             if (i == CS_SUCCESS) break;
 256         } else {
 257           printk(KERN_INFO "(elsa_cs: looks like the 97 model)\n");
 258           link->conf.ConfigIndex = cf->index;
 259           for (i = 0, j = 0x2f0; j > 0x100; j -= 0x10) {
 260             link->io.BasePort1 = j;
 261             i = pcmcia_request_io(link, &link->io);
 262             if (i == CS_SUCCESS) break;
 263           }
 264           break;
 265         }
 266         i = next_tuple(link, &tuple, &parse);
 267     }
 268
 269     if (i != CS_SUCCESS) {
 270         last_fn = RequestIO;
 271         goto cs_failed;
 272     }
 273
 274     i = pcmcia_request_irq(link, &link->irq);
 275     if (i != CS_SUCCESS) {
 276         link->irq.AssignedIRQ = 0;
 277         last_fn = RequestIRQ;
 278         goto cs_failed;
 279     }
 280
 281     i = pcmcia_request_configuration(link, &link->conf);
 282     if (i != CS_SUCCESS) {
 283       last_fn = RequestConfiguration;
 284       goto cs_failed;
 285     }
 286
 287     /* At this point, the dev_node_t structure(s) should be
 288        initialized and arranged in a linked list at link->dev. *//*  */
 289     sprintf(dev->node.dev_name, "elsa");
 290     dev->node.major = dev->node.minor = 0x0;
 291
 292     link->dev_node = &dev->node;
 293
 294     /* Finally, report what we've done */
 295     printk(KERN_INFO "%s: index 0x%02x: ",
 296            dev->node.dev_name, link->conf.ConfigIndex);
 297     if (link->conf.Attributes & CONF_ENABLE_IRQ)
 298         printk(", irq %d", link->irq.AssignedIRQ);
 299     if (link->io.NumPorts1)
 300         printk(", io 0x%04x-0x%04x", link->io.BasePort1,
 301                link->io.BasePort1+link->io.NumPorts1-1);
 302     if (link->io.NumPorts2)
 303         printk(" & 0x%04x-0x%04x", link->io.BasePort2,
 304                link->io.BasePort2+link->io.NumPorts2-1);
 305     printk("\n");
 306
 307     icard.para[0] = link->irq.AssignedIRQ;
 308     icard.para[1] = link->io.BasePort1;
 309     icard.protocol = protocol;
 310     icard.typ = ISDN_CTYPE_ELSA_PCMCIA;
 311
 312     i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard);
 313     if (i < 0) {
 314         printk(KERN_ERR "elsa_cs: failed to initialize Elsa PCMCIA %d at i/o %#x\n",
 315                 i, link->io.BasePort1);
 316         elsa_cs_release(link);
 317     } else
 318         ((local_info_t*)link->priv)->cardnr = i;
 319
 320     return 0;
 321 cs_failed:
 322     cs_error(link, last_fn, i);
 323     elsa_cs_release(link);
 324     return -ENODEV;
 325 } /* elsa_cs_config */
 326
 327 /*======================================================================
 328
 329     After a card is removed, elsa_cs_release() will unregister the net
 330     device, and release the PCMCIA configuration.  If the device is
 331     still open, this will be postponed until it is closed.
 332
 333 ======================================================================*/
 334
 335 static void elsa_cs_release(struct pcmcia_device *link)
 336 {
 337     local_info_t *local = link->priv;
 338
 339     DEBUG(0, "elsa_cs_release(0x%p)\n", link);
 340
 341     if (local) {
 342         if (local->cardnr >= 0) {
 343             /* no unregister function with hisax */
 344             HiSax_closecard(local->cardnr);
 345         }
 346     }
 347
 348     pcmcia_disable_device(link);
 349 } /* elsa_cs_release */
 350
 351 static int elsa_suspend(struct pcmcia_device *link)
 352 {
 353         local_info_t *dev = link->priv;
 354
 355         dev->busy = 1;
 356
 357         return 0;
 358 }
 359
 360 static int elsa_resume(struct pcmcia_device *link)
 361 {
 362         local_info_t *dev = link->priv;
 363
 364         dev->busy = 0;
 365
 366         return 0;
 367 }
 368
 369 static struct pcmcia_device_id elsa_ids[] = {
 370         PCMCIA_DEVICE_PROD_ID12("ELSA AG (Aachen, Germany)", "MicroLink ISDN/MC ", 0x983de2c4, 0x333ba257),
 371         PCMCIA_DEVICE_PROD_ID12("ELSA GmbH, Aachen", "MicroLink ISDN/MC ", 0x639e5718, 0x333ba257),
 372         PCMCIA_DEVICE_NULL
 373 };
 374 MODULE_DEVICE_TABLE(pcmcia, elsa_ids);
 375
 376 static struct pcmcia_driver elsa_cs_driver = {
 377         .owner          = THIS_MODULE,
 378         .drv            = {
 379                 .name   = "elsa_cs",
 380         },
 381         .probe          = elsa_cs_probe,
 382         .remove         = elsa_cs_detach,
 383         .id_table       = elsa_ids,
 384         .suspend        = elsa_suspend,
 385         .resume         = elsa_resume,
 386 };
 387
 388 static int __init init_elsa_cs(void)
 389 {
 390         return pcmcia_register_driver(&elsa_cs_driver);
 391 }
 392
 393 static void __exit exit_elsa_cs(void)
 394 {
 395         pcmcia_unregister_driver(&elsa_cs_driver);
 396 }
 397
 398 module_init(init_elsa_cs);
 399 module_exit(exit_elsa_cs);