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 void avma1cs_config(dev_link_t *link);
  71 static void avma1cs_release(dev_link_t *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 dev_link_t 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 dev_link_t 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 dev_link_t
  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_attach(struct pcmcia_device *p_dev)
 120 {
 121     dev_link_t *link;
 122     local_info_t *local;
 123
 124     DEBUG(0, "avma1cs_attach()\n");
 125
 126     /* Initialize the dev_link_t structure */
 127     link = kmalloc(sizeof(struct dev_link_t), GFP_KERNEL);
 128     if (!link)
 129         return -ENOMEM;
 130     memset(link, 0, sizeof(struct dev_link_t));
 131
 132     /* Allocate space for private device-specific data */
 133     local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
 134     if (!local) {
 135         kfree(link);
 136         return -ENOMEM;
 137     }
 138     memset(local, 0, sizeof(local_info_t));
 139     link->priv = local;
 140
 141     /* The io structure describes IO port mapping */
 142     link->io.NumPorts1 = 16;
 143     link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 144     link->io.NumPorts2 = 16;
 145     link->io.Attributes2 = IO_DATA_PATH_WIDTH_16;
 146     link->io.IOAddrLines = 5;
 147
 148     /* Interrupt setup */
 149     link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
 150     link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED;
 151
 152     link->irq.IRQInfo1 = IRQ_LEVEL_ID;
 153
 154     /* General socket configuration */
 155     link->conf.Attributes = CONF_ENABLE_IRQ;
 156     link->conf.IntType = INT_MEMORY_AND_IO;
 157     link->conf.ConfigIndex = 1;
 158     link->conf.Present = PRESENT_OPTION;
 159
 160     link->handle = p_dev;
 161     p_dev->instance = link;
 162
 163     link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
 164     avma1cs_config(link);
 165
 166     return 0;
 167 } /* avma1cs_attach */
 168
 169 /*======================================================================
 170
 171     This deletes a driver "instance".  The device is de-registered
 172     with Card Services.  If it has been released, all local data
 173     structures are freed.  Otherwise, the structures will be freed
 174     when the device is released.
 175
 176 ======================================================================*/
 177
 178 static void avma1cs_detach(struct pcmcia_device *p_dev)
 179 {
 180     dev_link_t *link = dev_to_instance(p_dev);
 181
 182     DEBUG(0, "avma1cs_detach(0x%p)\n", link);
 183
 184     if (link->state & DEV_CONFIG)
 185             avma1cs_release(link);
 186
 187     kfree(link->priv);
 188     kfree(link);
 189 } /* avma1cs_detach */
 190
 191 /*======================================================================
 192
 193     avma1cs_config() is scheduled to run after a CARD_INSERTION event
 194     is received, to configure the PCMCIA socket, and to make the
 195     ethernet device available to the system.
 196
 197 ======================================================================*/
 198
 199 static int get_tuple(client_handle_t handle, tuple_t *tuple,
 200                      cisparse_t *parse)
 201 {
 202     int i = pcmcia_get_tuple_data(handle, tuple);
 203     if (i != CS_SUCCESS) return i;
 204     return pcmcia_parse_tuple(handle, tuple, parse);
 205 }
 206
 207 static int first_tuple(client_handle_t handle, tuple_t *tuple,
 208                      cisparse_t *parse)
 209 {
 210     int i = pcmcia_get_first_tuple(handle, tuple);
 211     if (i != CS_SUCCESS) return i;
 212     return get_tuple(handle, tuple, parse);
 213 }
 214
 215 static int next_tuple(client_handle_t handle, tuple_t *tuple,
 216                      cisparse_t *parse)
 217 {
 218     int i = pcmcia_get_next_tuple(handle, tuple);
 219     if (i != CS_SUCCESS) return i;
 220     return get_tuple(handle, tuple, parse);
 221 }
 222
 223 static void avma1cs_config(dev_link_t *link)
 224 {
 225     client_handle_t handle;
 226     tuple_t tuple;
 227     cisparse_t parse;
 228     cistpl_cftable_entry_t *cf = &parse.cftable_entry;
 229     local_info_t *dev;
 230     int i;
 231     u_char buf[64];
 232     char devname[128];
 233     IsdnCard_t  icard;
 234     int busy = 0;
 235
 236     handle = link->handle;
 237     dev = link->priv;
 238
 239     DEBUG(0, "avma1cs_config(0x%p)\n", link);
 240
 241     /*
 242        This reads the card's CONFIG tuple to find its configuration
 243        registers.
 244     */
 245     do {
 246         tuple.DesiredTuple = CISTPL_CONFIG;
 247         i = pcmcia_get_first_tuple(handle, &tuple);
 248         if (i != CS_SUCCESS) break;
 249         tuple.TupleData = buf;
 250         tuple.TupleDataMax = 64;
 251         tuple.TupleOffset = 0;
 252         i = pcmcia_get_tuple_data(handle, &tuple);
 253         if (i != CS_SUCCESS) break;
 254         i = pcmcia_parse_tuple(handle, &tuple, &parse);
 255         if (i != CS_SUCCESS) break;
 256         link->conf.ConfigBase = parse.config.base;
 257     } while (0);
 258     if (i != CS_SUCCESS) {
 259         cs_error(link->handle, ParseTuple, i);
 260         link->state &= ~DEV_CONFIG_PENDING;
 261         return;
 262     }
 263
 264     /* Configure card */
 265     link->state |= DEV_CONFIG;
 266
 267     do {
 268
 269         tuple.Attributes = 0;
 270         tuple.TupleData = buf;
 271         tuple.TupleDataMax = 254;
 272         tuple.TupleOffset = 0;
 273         tuple.DesiredTuple = CISTPL_VERS_1;
 274
 275         devname[0] = 0;
 276         if( !first_tuple(handle, &tuple, &parse) && parse.version_1.ns > 1 ) {
 277             strlcpy(devname,parse.version_1.str + parse.version_1.ofs[1],
 278                         sizeof(devname));
 279         }
 280         /*
 281          * find IO port
 282          */
 283         tuple.TupleData = (cisdata_t *)buf;
 284         tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
 285         tuple.Attributes = 0;
 286         tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
 287         i = first_tuple(handle, &tuple, &parse);
 288         while (i == CS_SUCCESS) {
 289             if (cf->io.nwin > 0) {
 290                 link->conf.ConfigIndex = cf->index;
 291                 link->io.BasePort1 = cf->io.win[0].base;
 292                 link->io.NumPorts1 = cf->io.win[0].len;
 293                 link->io.NumPorts2 = 0;
 294                 printk(KERN_INFO "avma1_cs: testing i/o %#x-%#x\n",
 295                         link->io.BasePort1,
 296                         link->io.BasePort1+link->io.NumPorts1 - 1);
 297                 i = pcmcia_request_io(link->handle, &link->io);
 298                 if (i == CS_SUCCESS) goto found_port;
 299             }
 300             i = next_tuple(handle, &tuple, &parse);
 301         }
 302
 303 found_port:
 304         if (i != CS_SUCCESS) {
 305             cs_error(link->handle, RequestIO, i);
 306             break;
 307         }
 308
 309         /*
 310          * allocate an interrupt line
 311          */
 312         i = pcmcia_request_irq(link->handle, &link->irq);
 313         if (i != CS_SUCCESS) {
 314             cs_error(link->handle, RequestIRQ, i);
 315             /* undo */
 316             pcmcia_disable_device(link->handle);
 317             break;
 318         }
 319
 320         /*
 321          * configure the PCMCIA socket
 322          */
 323         i = pcmcia_request_configuration(link->handle, &link->conf);
 324         if (i != CS_SUCCESS) {
 325             cs_error(link->handle, RequestConfiguration, i);
 326             pcmcia_disable_device(link->handle);
 327             break;
 328         }
 329
 330     } while (0);
 331
 332     /* At this point, the dev_node_t structure(s) should be
 333        initialized and arranged in a linked list at link->dev. */
 334
 335     strcpy(dev->node.dev_name, "A1");
 336     dev->node.major = 45;
 337     dev->node.minor = 0;
 338     link->dev = &dev->node;
 339
 340     link->state &= ~DEV_CONFIG_PENDING;
 341     /* If any step failed, release any partially configured state */
 342     if (i != 0) {
 343         avma1cs_release(link);
 344         return;
 345     }
 346
 347     printk(KERN_NOTICE "avma1_cs: checking at i/o %#x, irq %d\n",
 348                                 link->io.BasePort1, link->irq.AssignedIRQ);
 349
 350     icard.para[0] = link->irq.AssignedIRQ;
 351     icard.para[1] = link->io.BasePort1;
 352     icard.protocol = isdnprot;
 353     icard.typ = ISDN_CTYPE_A1_PCMCIA;
 354
 355     i = hisax_init_pcmcia(link, &busy, &icard);
 356     if (i < 0) {
 357         printk(KERN_ERR "avma1_cs: failed to initialize AVM A1 PCMCIA %d at i/o %#x\n", i, link->io.BasePort1);
 358         avma1cs_release(link);
 359         return;
 360     }
 361     dev->node.minor = i;
 362
 363 } /* avma1cs_config */
 364
 365 /*======================================================================
 366
 367     After a card is removed, avma1cs_release() will unregister the net
 368     device, and release the PCMCIA configuration.  If the device is
 369     still open, this will be postponed until it is closed.
 370
 371 ======================================================================*/
 372
 373 static void avma1cs_release(dev_link_t *link)
 374 {
 375         local_info_t *local = link->priv;
 376
 377         DEBUG(0, "avma1cs_release(0x%p)\n", link);
 378
 379         /* now unregister function with hisax */
 380         HiSax_closecard(local->node.minor);
 381
 382         pcmcia_disable_device(link->handle);
 383 } /* avma1cs_release */
 384
 385
 386 static struct pcmcia_device_id avma1cs_ids[] = {
 387         PCMCIA_DEVICE_PROD_ID12("AVM", "ISDN A", 0x95d42008, 0xadc9d4bb),
 388         PCMCIA_DEVICE_PROD_ID12("ISDN", "CARD", 0x8d9761c8, 0x01c5aa7b),
 389         PCMCIA_DEVICE_NULL
 390 };
 391 MODULE_DEVICE_TABLE(pcmcia, avma1cs_ids);
 392
 393 static struct pcmcia_driver avma1cs_driver = {
 394         .owner          = THIS_MODULE,
 395         .drv            = {
 396                 .name   = "avma1_cs",
 397         },
 398         .probe          = avma1cs_attach,
 399         .remove         = avma1cs_detach,
 400         .id_table       = avma1cs_ids,
 401 };
 402
 403 /*====================================================================*/
 404
 405 static int __init init_avma1_cs(void)
 406 {
 407         return(pcmcia_register_driver(&avma1cs_driver));
 408 }
 409
 410 static void __exit exit_avma1_cs(void)
 411 {
 412         pcmcia_unregister_driver(&avma1cs_driver);
 413 }
 414
 415 module_init(init_avma1_cs);
 416 module_exit(exit_avma1_cs);