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/ptrace.h>
  42 #include <linux/slab.h>
  43 #include <linux/string.h>
  44 #include <linux/timer.h>
  45 #include <linux/ioport.h>
  46 #include <asm/io.h>
  47 #include <asm/system.h>
  48
  49 #include <pcmcia/cs_types.h>
  50 #include <pcmcia/cs.h>
  51 #include <pcmcia/cistpl.h>
  52 #include <pcmcia/cisreg.h>
  53 #include <pcmcia/ds.h>
  54 #include "hisax_cfg.h"
  55
  56 MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Elsa PCM cards");
  57 MODULE_AUTHOR("Klaus Lichtenwalder");
  58 MODULE_LICENSE("Dual MPL/GPL");
  59
  60
  61 /*====================================================================*/
  62
  63 /* Parameters that can be set with 'insmod' */
  64
  65 static int protocol = 2;        /* EURO-ISDN Default */
  66 module_param(protocol, int, 0);
  67
  68 /*====================================================================*/
  69
  70 /*
  71    The event() function is this driver's Card Services event handler.
  72    It will be called by Card Services when an appropriate card status
  73    event is received.  The config() and release() entry points are
  74    used to configure or release a socket, in response to card insertion
  75    and ejection events.  They are invoked from the elsa_cs event
  76    handler.
  77 */
  78
  79 static int elsa_cs_config(struct pcmcia_device *link) __devinit ;
  80 static void elsa_cs_release(struct pcmcia_device *link);
  81
  82 /*
  83    The attach() and detach() entry points are used to create and destroy
  84    "instances" of the driver, where each instance represents everything
  85    needed to manage one actual PCMCIA card.
  86 */
  87
  88 static void elsa_cs_detach(struct pcmcia_device *p_dev) __devexit;
  89
  90 /*
  91    A driver needs to provide a dev_node_t structure for each device
  92    on a card.  In some cases, there is only one device per card (for
  93    example, ethernet cards, modems).  In other cases, there may be
  94    many actual or logical devices (SCSI adapters, memory cards with
  95    multiple partitions).  The dev_node_t structures need to be kept
  96    in a linked list starting at the 'dev' field of a struct pcmcia_device
  97    structure.  We allocate them in the card's private data structure,
  98    because they generally shouldn't be allocated dynamically.
  99    In this case, we also provide a flag to indicate if a device is
 100    "stopped" due to a power management event, or card ejection.  The
 101    device IO routines can use a flag like this to throttle IO to a
 102    card that is not ready to accept it.
 103 */
 104
 105 typedef struct local_info_t {
 106         struct pcmcia_device    *p_dev;
 107     dev_node_t          node;
 108     int                 busy;
 109     int                 cardnr;
 110 } local_info_t;
 111
 112 /*======================================================================
 113
 114     elsa_cs_attach() creates an "instance" of the driver, allocatingx
 115     local data structures for one device.  The device is registered
 116     with Card Services.
 117
 118     The dev_link structure is initialized, but we don't actually
 119     configure the card at this point -- we wait until we receive a
 120     card insertion event.
 121
 122 ======================================================================*/
 123
 124 static int __devinit elsa_cs_probe(struct pcmcia_device *link)
 125 {
 126     local_info_t *local;
 127
 128     dev_dbg(&link->dev, "elsa_cs_attach()\n");
 129
 130     /* Allocate space for private device-specific data */
 131     local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
 132     if (!local) return -ENOMEM;
 133
 134     local->p_dev = link;
 135     link->priv = local;
 136
 137     local->cardnr = -1;
 138
 139     /* Interrupt setup */
 140     link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
 141     link->irq.Handler = NULL;
 142
 143     /*
 144       General socket configuration defaults can go here.  In this
 145       client, we assume very little, and rely on the CIS for almost
 146       everything.  In most clients, many details (i.e., number, sizes,
 147       and attributes of IO windows) are fixed by the nature of the
 148       device, and can be hard-wired here.
 149     */
 150     link->io.NumPorts1 = 8;
 151     link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 152     link->io.IOAddrLines = 3;
 153
 154     link->conf.Attributes = CONF_ENABLE_IRQ;
 155     link->conf.IntType = INT_MEMORY_AND_IO;
 156
 157     return elsa_cs_config(link);
 158 } /* elsa_cs_attach */
 159
 160 /*======================================================================
 161
 162     This deletes a driver "instance".  The device is de-registered
 163     with Card Services.  If it has been released, all local data
 164     structures are freed.  Otherwise, the structures will be freed
 165     when the device is released.
 166
 167 ======================================================================*/
 168
 169 static void __devexit elsa_cs_detach(struct pcmcia_device *link)
 170 {
 171         local_info_t *info = link->priv;
 172
 173         dev_dbg(&link->dev, "elsa_cs_detach(0x%p)\n", link);
 174
 175         info->busy = 1;
 176         elsa_cs_release(link);
 177
 178         kfree(info);
 179 } /* elsa_cs_detach */
 180
 181 /*======================================================================
 182
 183     elsa_cs_config() is scheduled to run after a CARD_INSERTION event
 184     is received, to configure the PCMCIA socket, and to make the
 185     device available to the system.
 186
 187 ======================================================================*/
 188
 189 static int elsa_cs_configcheck(struct pcmcia_device *p_dev,
 190                                cistpl_cftable_entry_t *cf,
 191                                cistpl_cftable_entry_t *dflt,
 192                                unsigned int vcc,
 193                                void *priv_data)
 194 {
 195         int j;
 196
 197         if ((cf->io.nwin > 0) && cf->io.win[0].base) {
 198                 printk(KERN_INFO "(elsa_cs: looks like the 96 model)\n");
 199                 p_dev->io.BasePort1 = cf->io.win[0].base;
 200                 if (!pcmcia_request_io(p_dev, &p_dev->io))
 201                         return 0;
 202         } else {
 203                 printk(KERN_INFO "(elsa_cs: looks like the 97 model)\n");
 204                 for (j = 0x2f0; j > 0x100; j -= 0x10) {
 205                         p_dev->io.BasePort1 = j;
 206                         if (!pcmcia_request_io(p_dev, &p_dev->io))
 207                                 return 0;
 208                 }
 209         }
 210         return -ENODEV;
 211 }
 212
 213 static int __devinit elsa_cs_config(struct pcmcia_device *link)
 214 {
 215     local_info_t *dev;
 216     int i;
 217     IsdnCard_t icard;
 218
 219     dev_dbg(&link->dev, "elsa_config(0x%p)\n", link);
 220     dev = link->priv;
 221
 222     i = pcmcia_loop_config(link, elsa_cs_configcheck, NULL);
 223     if (i != 0)
 224         goto failed;
 225
 226     i = pcmcia_request_irq(link, &link->irq);
 227     if (i != 0) {
 228         link->irq.AssignedIRQ = 0;
 229         goto failed;
 230     }
 231
 232     i = pcmcia_request_configuration(link, &link->conf);
 233     if (i != 0)
 234         goto failed;
 235
 236     /* At this point, the dev_node_t structure(s) should be
 237        initialized and arranged in a linked list at link->dev. *//*  */
 238     sprintf(dev->node.dev_name, "elsa");
 239     dev->node.major = dev->node.minor = 0x0;
 240
 241     link->dev_node = &dev->node;
 242
 243     /* Finally, report what we've done */
 244     printk(KERN_INFO "%s: index 0x%02x: ",
 245            dev->node.dev_name, link->conf.ConfigIndex);
 246     if (link->conf.Attributes & CONF_ENABLE_IRQ)
 247         printk(", irq %d", link->irq.AssignedIRQ);
 248     if (link->io.NumPorts1)
 249         printk(", io 0x%04x-0x%04x", link->io.BasePort1,
 250                link->io.BasePort1+link->io.NumPorts1-1);
 251     if (link->io.NumPorts2)
 252         printk(" & 0x%04x-0x%04x", link->io.BasePort2,
 253                link->io.BasePort2+link->io.NumPorts2-1);
 254     printk("\n");
 255
 256     icard.para[0] = link->irq.AssignedIRQ;
 257     icard.para[1] = link->io.BasePort1;
 258     icard.protocol = protocol;
 259     icard.typ = ISDN_CTYPE_ELSA_PCMCIA;
 260
 261     i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard);
 262     if (i < 0) {
 263         printk(KERN_ERR "elsa_cs: failed to initialize Elsa PCMCIA %d at i/o %#x\n",
 264                 i, link->io.BasePort1);
 265         elsa_cs_release(link);
 266     } else
 267         ((local_info_t*)link->priv)->cardnr = i;
 268
 269     return 0;
 270 failed:
 271     elsa_cs_release(link);
 272     return -ENODEV;
 273 } /* elsa_cs_config */
 274
 275 /*======================================================================
 276
 277     After a card is removed, elsa_cs_release() will unregister the net
 278     device, and release the PCMCIA configuration.  If the device is
 279     still open, this will be postponed until it is closed.
 280
 281 ======================================================================*/
 282
 283 static void elsa_cs_release(struct pcmcia_device *link)
 284 {
 285     local_info_t *local = link->priv;
 286
 287     dev_dbg(&link->dev, "elsa_cs_release(0x%p)\n", link);
 288
 289     if (local) {
 290         if (local->cardnr >= 0) {
 291             /* no unregister function with hisax */
 292             HiSax_closecard(local->cardnr);
 293         }
 294     }
 295
 296     pcmcia_disable_device(link);
 297 } /* elsa_cs_release */
 298
 299 static int elsa_suspend(struct pcmcia_device *link)
 300 {
 301         local_info_t *dev = link->priv;
 302
 303         dev->busy = 1;
 304
 305         return 0;
 306 }
 307
 308 static int elsa_resume(struct pcmcia_device *link)
 309 {
 310         local_info_t *dev = link->priv;
 311
 312         dev->busy = 0;
 313
 314         return 0;
 315 }
 316
 317 static struct pcmcia_device_id elsa_ids[] = {
 318         PCMCIA_DEVICE_PROD_ID12("ELSA AG (Aachen, Germany)", "MicroLink ISDN/MC ", 0x983de2c4, 0x333ba257),
 319         PCMCIA_DEVICE_PROD_ID12("ELSA GmbH, Aachen", "MicroLink ISDN/MC ", 0x639e5718, 0x333ba257),
 320         PCMCIA_DEVICE_NULL
 321 };
 322 MODULE_DEVICE_TABLE(pcmcia, elsa_ids);
 323
 324 static struct pcmcia_driver elsa_cs_driver = {
 325         .owner          = THIS_MODULE,
 326         .drv            = {
 327                 .name   = "elsa_cs",
 328         },
 329         .probe          = elsa_cs_probe,
 330         .remove         = __devexit_p(elsa_cs_detach),
 331         .id_table       = elsa_ids,
 332         .suspend        = elsa_suspend,
 333         .resume         = elsa_resume,
 334 };
 335
 336 static int __init init_elsa_cs(void)
 337 {
 338         return pcmcia_register_driver(&elsa_cs_driver);
 339 }
 340
 341 static void __exit exit_elsa_cs(void)
 342 {
 343         pcmcia_unregister_driver(&elsa_cs_driver);
 344 }
 345
 346 module_init(init_elsa_cs);
 347 module_exit(exit_elsa_cs);