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