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     /*
 140       General socket configuration defaults can go here.  In this
 141       client, we assume very little, and rely on the CIS for almost
 142       everything.  In most clients, many details (i.e., number, sizes,
 143       and attributes of IO windows) are fixed by the nature of the
 144       device, and can be hard-wired here.
 145     */
 146     link->io.NumPorts1 = 8;
 147     link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 148     link->io.IOAddrLines = 3;
 149
 150     link->conf.Attributes = CONF_ENABLE_IRQ;
 151     link->conf.IntType = INT_MEMORY_AND_IO;
 152
 153     return elsa_cs_config(link);
 154 } /* elsa_cs_attach */
 155
 156 /*======================================================================
 157
 158     This deletes a driver "instance".  The device is de-registered
 159     with Card Services.  If it has been released, all local data
 160     structures are freed.  Otherwise, the structures will be freed
 161     when the device is released.
 162
 163 ======================================================================*/
 164
 165 static void __devexit elsa_cs_detach(struct pcmcia_device *link)
 166 {
 167         local_info_t *info = link->priv;
 168
 169         dev_dbg(&link->dev, "elsa_cs_detach(0x%p)\n", link);
 170
 171         info->busy = 1;
 172         elsa_cs_release(link);
 173
 174         kfree(info);
 175 } /* elsa_cs_detach */
 176
 177 /*======================================================================
 178
 179     elsa_cs_config() is scheduled to run after a CARD_INSERTION event
 180     is received, to configure the PCMCIA socket, and to make the
 181     device available to the system.
 182
 183 ======================================================================*/
 184
 185 static int elsa_cs_configcheck(struct pcmcia_device *p_dev,
 186                                cistpl_cftable_entry_t *cf,
 187                                cistpl_cftable_entry_t *dflt,
 188                                unsigned int vcc,
 189                                void *priv_data)
 190 {
 191         int j;
 192
 193         if ((cf->io.nwin > 0) && cf->io.win[0].base) {
 194                 printk(KERN_INFO "(elsa_cs: looks like the 96 model)\n");
 195                 p_dev->io.BasePort1 = cf->io.win[0].base;
 196                 if (!pcmcia_request_io(p_dev, &p_dev->io))
 197                         return 0;
 198         } else {
 199                 printk(KERN_INFO "(elsa_cs: looks like the 97 model)\n");
 200                 for (j = 0x2f0; j > 0x100; j -= 0x10) {
 201                         p_dev->io.BasePort1 = j;
 202                         if (!pcmcia_request_io(p_dev, &p_dev->io))
 203                                 return 0;
 204                 }
 205         }
 206         return -ENODEV;
 207 }
 208
 209 static int __devinit elsa_cs_config(struct pcmcia_device *link)
 210 {
 211     local_info_t *dev;
 212     int i;
 213     IsdnCard_t icard;
 214
 215     dev_dbg(&link->dev, "elsa_config(0x%p)\n", link);
 216     dev = link->priv;
 217
 218     i = pcmcia_loop_config(link, elsa_cs_configcheck, NULL);
 219     if (i != 0)
 220         goto failed;
 221
 222     if (!link->irq)
 223         goto failed;
 224
 225     i = pcmcia_request_configuration(link, &link->conf);
 226     if (i != 0)
 227         goto failed;
 228
 229     /* At this point, the dev_node_t structure(s) should be
 230        initialized and arranged in a linked list at link->dev. *//*  */
 231     sprintf(dev->node.dev_name, "elsa");
 232     dev->node.major = dev->node.minor = 0x0;
 233
 234     link->dev_node = &dev->node;
 235
 236     /* Finally, report what we've done */
 237     printk(KERN_INFO "%s: index 0x%02x: ",
 238            dev->node.dev_name, link->conf.ConfigIndex);
 239     if (link->conf.Attributes & CONF_ENABLE_IRQ)
 240         printk(", irq %d", link->irq);
 241     if (link->io.NumPorts1)
 242         printk(", io 0x%04x-0x%04x", link->io.BasePort1,
 243                link->io.BasePort1+link->io.NumPorts1-1);
 244     if (link->io.NumPorts2)
 245         printk(" & 0x%04x-0x%04x", link->io.BasePort2,
 246                link->io.BasePort2+link->io.NumPorts2-1);
 247     printk("\n");
 248
 249     icard.para[0] = link->irq;
 250     icard.para[1] = link->io.BasePort1;
 251     icard.protocol = protocol;
 252     icard.typ = ISDN_CTYPE_ELSA_PCMCIA;
 253
 254     i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard);
 255     if (i < 0) {
 256         printk(KERN_ERR "elsa_cs: failed to initialize Elsa PCMCIA %d at i/o %#x\n",
 257                 i, link->io.BasePort1);
 258         elsa_cs_release(link);
 259     } else
 260         ((local_info_t*)link->priv)->cardnr = i;
 261
 262     return 0;
 263 failed:
 264     elsa_cs_release(link);
 265     return -ENODEV;
 266 } /* elsa_cs_config */
 267
 268 /*======================================================================
 269
 270     After a card is removed, elsa_cs_release() will unregister the net
 271     device, and release the PCMCIA configuration.  If the device is
 272     still open, this will be postponed until it is closed.
 273
 274 ======================================================================*/
 275
 276 static void elsa_cs_release(struct pcmcia_device *link)
 277 {
 278     local_info_t *local = link->priv;
 279
 280     dev_dbg(&link->dev, "elsa_cs_release(0x%p)\n", link);
 281
 282     if (local) {
 283         if (local->cardnr >= 0) {
 284             /* no unregister function with hisax */
 285             HiSax_closecard(local->cardnr);
 286         }
 287     }
 288
 289     pcmcia_disable_device(link);
 290 } /* elsa_cs_release */
 291
 292 static int elsa_suspend(struct pcmcia_device *link)
 293 {
 294         local_info_t *dev = link->priv;
 295
 296         dev->busy = 1;
 297
 298         return 0;
 299 }
 300
 301 static int elsa_resume(struct pcmcia_device *link)
 302 {
 303         local_info_t *dev = link->priv;
 304
 305         dev->busy = 0;
 306
 307         return 0;
 308 }
 309
 310 static struct pcmcia_device_id elsa_ids[] = {
 311         PCMCIA_DEVICE_PROD_ID12("ELSA AG (Aachen, Germany)", "MicroLink ISDN/MC ", 0x983de2c4, 0x333ba257),
 312         PCMCIA_DEVICE_PROD_ID12("ELSA GmbH, Aachen", "MicroLink ISDN/MC ", 0x639e5718, 0x333ba257),
 313         PCMCIA_DEVICE_NULL
 314 };
 315 MODULE_DEVICE_TABLE(pcmcia, elsa_ids);
 316
 317 static struct pcmcia_driver elsa_cs_driver = {
 318         .owner          = THIS_MODULE,
 319         .drv            = {
 320                 .name   = "elsa_cs",
 321         },
 322         .probe          = elsa_cs_probe,
 323         .remove         = __devexit_p(elsa_cs_detach),
 324         .id_table       = elsa_ids,
 325         .suspend        = elsa_suspend,
 326         .resume         = elsa_resume,
 327 };
 328
 329 static int __init init_elsa_cs(void)
 330 {
 331         return pcmcia_register_driver(&elsa_cs_driver);
 332 }
 333
 334 static void __exit exit_elsa_cs(void)
 335 {
 336         pcmcia_unregister_driver(&elsa_cs_driver);
 337 }
 338
 339 module_init(init_elsa_cs);
 340 module_exit(exit_elsa_cs);