drivers/isdn/hisax/avma1_cs.c

   1 /*
   2  * PCMCIA client driver for AVM A1 / Fritz!PCMCIA
   3  *
   4  * Author       Carsten Paeth
   5  * Copyright    1998-2001 by Carsten Paeth <calle@calle.in-berlin.de>
   6  *
   7  * This software may be used and distributed according to the terms
   8  * of the GNU General Public License, incorporated herein by reference.
   9  *
  10  */
  11
  12 #include <linux/module.h>
  13
  14
  15 #include <linux/kernel.h>
  16 #include <linux/init.h>
  17 #include <linux/sched.h>
  18 #include <linux/ptrace.h>
  19 #include <linux/slab.h>
  20 #include <linux/string.h>
  21 #include <asm/io.h>
  22 #include <asm/system.h>
  23
  24 #include <pcmcia/cs_types.h>
  25 #include <pcmcia/cs.h>
  26 #include <pcmcia/cistpl.h>
  27 #include <pcmcia/ds.h>
  28 #include "hisax_cfg.h"
  29
  30 MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for AVM A1/Fritz!PCMCIA cards");
  31 MODULE_AUTHOR("Carsten Paeth");
  32 MODULE_LICENSE("GPL");
  33
  34 /*
  35    All the PCMCIA modules use PCMCIA_DEBUG to control debugging.  If
  36    you do not define PCMCIA_DEBUG at all, all the debug code will be
  37    left out.  If you compile with PCMCIA_DEBUG=0, the debug code will
  38    be present but disabled -- but it can then be enabled for specific
  39    modules at load time with a 'pc_debug=#' option to insmod.
  40 */
  41 #ifdef PCMCIA_DEBUG
  42 static int pc_debug = PCMCIA_DEBUG;
  43 module_param(pc_debug, int, 0);
  44 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args);
  45 static char *version =
  46 "avma1_cs.c 1.00 1998/01/23 10:00:00 (Carsten Paeth)";
  47 #else
  48 #define DEBUG(n, args...)
  49 #endif
  50
  51 /*====================================================================*/
  52
  53 /* Parameters that can be set with 'insmod' */
  54
  55 static int isdnprot = 2;
  56
  57 module_param(isdnprot, int, 0);
  58
  59 /*====================================================================*/
  60
  61 /*
  62    The event() function is this driver's Card Services event handler.
  63    It will be called by Card Services when an appropriate card status
  64    event is received.  The config() and release() entry points are
  65    used to configure or release a socket, in response to card insertion
  66    and ejection events.  They are invoked from the skeleton event
  67    handler.
  68 */
  69
  70 static int avma1cs_config(struct pcmcia_device *link);
  71 static void avma1cs_release(struct pcmcia_device *link);
  72
  73 /*
  74    The attach() and detach() entry points are used to create and destroy
  75    "instances" of the driver, where each instance represents everything
  76    needed to manage one actual PCMCIA card.
  77 */
  78
  79 static void avma1cs_detach(struct pcmcia_device *p_dev);
  80
  81
  82 /*
  83    A linked list of "instances" of the skeleton device.  Each actual
  84    PCMCIA card corresponds to one device instance, and is described
  85    by one struct pcmcia_device structure (defined in ds.h).
  86
  87    You may not want to use a linked list for this -- for example, the
  88    memory card driver uses an array of struct pcmcia_device pointers, where minor
  89    device numbers are used to derive the corresponding array index.
  90 */
  91
  92 /*
  93    A driver needs to provide a dev_node_t structure for each device
  94    on a card.  In some cases, there is only one device per card (for
  95    example, ethernet cards, modems).  In other cases, there may be
  96    many actual or logical devices (SCSI adapters, memory cards with
  97    multiple partitions).  The dev_node_t structures need to be kept
  98    in a linked list starting at the 'dev' field of a struct pcmcia_device
  99    structure.  We allocate them in the card's private data structure,
 100    because they generally can't be allocated dynamically.
 101 */
 102
 103 typedef struct local_info_t {
 104     dev_node_t  node;
 105 } local_info_t;
 106
 107 /*======================================================================
 108
 109     avma1cs_attach() creates an "instance" of the driver, allocating
 110     local data structures for one device.  The device is registered
 111     with Card Services.
 112
 113     The dev_link structure is initialized, but we don't actually
 114     configure the card at this point -- we wait until we receive a
 115     card insertion event.
 116
 117 ======================================================================*/
 118
 119 static int avma1cs_probe(struct pcmcia_device *p_dev)
 120 {
 121     local_info_t *local;
 122
 123     DEBUG(0, "avma1cs_attach()\n");
 124
 125     /* Allocate space for private device-specific data */
 126     local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
 127     if (!local)
 128         return -ENOMEM;
 129
 130     memset(local, 0, sizeof(local_info_t));
 131     p_dev->priv = local;
 132
 133     /* The io structure describes IO port mapping */
 134     p_dev->io.NumPorts1 = 16;
 135     p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 136     p_dev->io.NumPorts2 = 16;
 137     p_dev->io.Attributes2 = IO_DATA_PATH_WIDTH_16;
 138     p_dev->io.IOAddrLines = 5;
 139
 140     /* Interrupt setup */
 141     p_dev->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
 142     p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED;
 143
 144     p_dev->irq.IRQInfo1 = IRQ_LEVEL_ID;
 145
 146     /* General socket configuration */
 147     p_dev->conf.Attributes = CONF_ENABLE_IRQ;
 148     p_dev->conf.IntType = INT_MEMORY_AND_IO;
 149     p_dev->conf.ConfigIndex = 1;
 150     p_dev->conf.Present = PRESENT_OPTION;
 151
 152     p_dev->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
 153     return avma1cs_config(p_dev);
 154 } /* avma1cs_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 avma1cs_detach(struct pcmcia_device *link)
 166 {
 167     DEBUG(0, "avma1cs_detach(0x%p)\n", link);
 168
 169     if (link->state & DEV_CONFIG)
 170             avma1cs_release(link);
 171
 172     kfree(link->priv);
 173 } /* avma1cs_detach */
 174
 175 /*======================================================================
 176
 177     avma1cs_config() is scheduled to run after a CARD_INSERTION event
 178     is received, to configure the PCMCIA socket, and to make the
 179     ethernet device available to the system.
 180
 181 ======================================================================*/
 182
 183 static int get_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 184                      cisparse_t *parse)
 185 {
 186     int i = pcmcia_get_tuple_data(handle, tuple);
 187     if (i != CS_SUCCESS) return i;
 188     return pcmcia_parse_tuple(handle, tuple, parse);
 189 }
 190
 191 static int first_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 192                      cisparse_t *parse)
 193 {
 194     int i = pcmcia_get_first_tuple(handle, tuple);
 195     if (i != CS_SUCCESS) return i;
 196     return get_tuple(handle, tuple, parse);
 197 }
 198
 199 static int next_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 200                      cisparse_t *parse)
 201 {
 202     int i = pcmcia_get_next_tuple(handle, tuple);
 203     if (i != CS_SUCCESS) return i;
 204     return get_tuple(handle, tuple, parse);
 205 }
 206
 207 static int avma1cs_config(struct pcmcia_device *link)
 208 {
 209     tuple_t tuple;
 210     cisparse_t parse;
 211     cistpl_cftable_entry_t *cf = &parse.cftable_entry;
 212     local_info_t *dev;
 213     int i;
 214     u_char buf[64];
 215     char devname[128];
 216     IsdnCard_t  icard;
 217     int busy = 0;
 218
 219     dev = link->priv;
 220
 221     DEBUG(0, "avma1cs_config(0x%p)\n", link);
 222
 223     /*
 224        This reads the card's CONFIG tuple to find its configuration
 225        registers.
 226     */
 227     do {
 228         tuple.DesiredTuple = CISTPL_CONFIG;
 229         i = pcmcia_get_first_tuple(link, &tuple);
 230         if (i != CS_SUCCESS) break;
 231         tuple.TupleData = buf;
 232         tuple.TupleDataMax = 64;
 233         tuple.TupleOffset = 0;
 234         i = pcmcia_get_tuple_data(link, &tuple);
 235         if (i != CS_SUCCESS) break;
 236         i = pcmcia_parse_tuple(link, &tuple, &parse);
 237         if (i != CS_SUCCESS) break;
 238         link->conf.ConfigBase = parse.config.base;
 239     } while (0);
 240     if (i != CS_SUCCESS) {
 241         cs_error(link, ParseTuple, i);
 242         link->state &= ~DEV_CONFIG_PENDING;
 243         return -ENODEV;
 244     }
 245
 246     /* Configure card */
 247     link->state |= DEV_CONFIG;
 248
 249     do {
 250
 251         tuple.Attributes = 0;
 252         tuple.TupleData = buf;
 253         tuple.TupleDataMax = 254;
 254         tuple.TupleOffset = 0;
 255         tuple.DesiredTuple = CISTPL_VERS_1;
 256
 257         devname[0] = 0;
 258         if( !first_tuple(link, &tuple, &parse) && parse.version_1.ns > 1 ) {
 259             strlcpy(devname,parse.version_1.str + parse.version_1.ofs[1],
 260                         sizeof(devname));
 261         }
 262         /*
 263          * find IO port
 264          */
 265         tuple.TupleData = (cisdata_t *)buf;
 266         tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
 267         tuple.Attributes = 0;
 268         tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
 269         i = first_tuple(link, &tuple, &parse);
 270         while (i == CS_SUCCESS) {
 271             if (cf->io.nwin > 0) {
 272                 link->conf.ConfigIndex = cf->index;
 273                 link->io.BasePort1 = cf->io.win[0].base;
 274                 link->io.NumPorts1 = cf->io.win[0].len;
 275                 link->io.NumPorts2 = 0;
 276                 printk(KERN_INFO "avma1_cs: testing i/o %#x-%#x\n",
 277                         link->io.BasePort1,
 278                         link->io.BasePort1+link->io.NumPorts1 - 1);
 279                 i = pcmcia_request_io(link, &link->io);
 280                 if (i == CS_SUCCESS) goto found_port;
 281             }
 282             i = next_tuple(link, &tuple, &parse);
 283         }
 284
 285 found_port:
 286         if (i != CS_SUCCESS) {
 287             cs_error(link, RequestIO, i);
 288             break;
 289         }
 290
 291         /*
 292          * allocate an interrupt line
 293          */
 294         i = pcmcia_request_irq(link, &link->irq);
 295         if (i != CS_SUCCESS) {
 296             cs_error(link, RequestIRQ, i);
 297             /* undo */
 298             pcmcia_disable_device(link);
 299             break;
 300         }
 301
 302         /*
 303          * configure the PCMCIA socket
 304          */
 305         i = pcmcia_request_configuration(link, &link->conf);
 306         if (i != CS_SUCCESS) {
 307             cs_error(link, RequestConfiguration, i);
 308             pcmcia_disable_device(link);
 309             break;
 310         }
 311
 312     } while (0);
 313
 314     /* At this point, the dev_node_t structure(s) should be
 315        initialized and arranged in a linked list at link->dev. */
 316
 317     strcpy(dev->node.dev_name, "A1");
 318     dev->node.major = 45;
 319     dev->node.minor = 0;
 320     link->dev_node = &dev->node;
 321
 322     link->state &= ~DEV_CONFIG_PENDING;
 323     /* If any step failed, release any partially configured state */
 324     if (i != 0) {
 325         avma1cs_release(link);
 326         return -ENODEV;
 327     }
 328
 329     printk(KERN_NOTICE "avma1_cs: checking at i/o %#x, irq %d\n",
 330                                 link->io.BasePort1, link->irq.AssignedIRQ);
 331
 332     icard.para[0] = link->irq.AssignedIRQ;
 333     icard.para[1] = link->io.BasePort1;
 334     icard.protocol = isdnprot;
 335     icard.typ = ISDN_CTYPE_A1_PCMCIA;
 336
 337     i = hisax_init_pcmcia(link, &busy, &icard);
 338     if (i < 0) {
 339         printk(KERN_ERR "avma1_cs: failed to initialize AVM A1 PCMCIA %d at i/o %#x\n", i, link->io.BasePort1);
 340         avma1cs_release(link);
 341         return -ENODEV;
 342     }
 343     dev->node.minor = i;
 344
 345     return 0;
 346 } /* avma1cs_config */
 347
 348 /*======================================================================
 349
 350     After a card is removed, avma1cs_release() will unregister the net
 351     device, and release the PCMCIA configuration.  If the device is
 352     still open, this will be postponed until it is closed.
 353
 354 ======================================================================*/
 355
 356 static void avma1cs_release(struct pcmcia_device *link)
 357 {
 358         local_info_t *local = link->priv;
 359
 360         DEBUG(0, "avma1cs_release(0x%p)\n", link);
 361
 362         /* now unregister function with hisax */
 363         HiSax_closecard(local->node.minor);
 364
 365         pcmcia_disable_device(link);
 366 } /* avma1cs_release */
 367
 368
 369 static struct pcmcia_device_id avma1cs_ids[] = {
 370         PCMCIA_DEVICE_PROD_ID12("AVM", "ISDN A", 0x95d42008, 0xadc9d4bb),
 371         PCMCIA_DEVICE_PROD_ID12("ISDN", "CARD", 0x8d9761c8, 0x01c5aa7b),
 372         PCMCIA_DEVICE_NULL
 373 };
 374 MODULE_DEVICE_TABLE(pcmcia, avma1cs_ids);
 375
 376 static struct pcmcia_driver avma1cs_driver = {
 377         .owner          = THIS_MODULE,
 378         .drv            = {
 379                 .name   = "avma1_cs",
 380         },
 381         .probe          = avma1cs_probe,
 382         .remove         = avma1cs_detach,
 383         .id_table       = avma1cs_ids,
 384 };
 385
 386 /*====================================================================*/
 387
 388 static int __init init_avma1_cs(void)
 389 {
 390         return(pcmcia_register_driver(&avma1cs_driver));
 391 }
 392
 393 static void __exit exit_avma1_cs(void)
 394 {
 395         pcmcia_unregister_driver(&avma1cs_driver);
 396 }
 397
 398 module_init(init_avma1_cs);
 399 module_exit(exit_avma1_cs);