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