drivers/isdn/hardware/avm/avm_cs.c

   1 /* $Id: avm_cs.c,v 1.4.6.3 2001/09/23 22:24:33 kai Exp $
   2  *
   3  * A PCMCIA client driver for AVM B1/M1/M2
   4  *
   5  * Copyright 1999 by Carsten Paeth <calle@calle.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 #include <linux/kernel.h>
  14 #include <linux/init.h>
  15 #include <linux/sched.h>
  16 #include <linux/ptrace.h>
  17 #include <linux/slab.h>
  18 #include <linux/string.h>
  19 #include <linux/tty.h>
  20 #include <linux/serial.h>
  21 #include <linux/major.h>
  22 #include <asm/io.h>
  23 #include <asm/system.h>
  24
  25 #include <pcmcia/cs_types.h>
  26 #include <pcmcia/cs.h>
  27 #include <pcmcia/cistpl.h>
  28 #include <pcmcia/ciscode.h>
  29 #include <pcmcia/ds.h>
  30 #include <pcmcia/cisreg.h>
  31
  32 #include <linux/skbuff.h>
  33 #include <linux/capi.h>
  34 #include <linux/b1lli.h>
  35 #include <linux/b1pcmcia.h>
  36
  37 /*====================================================================*/
  38
  39 MODULE_DESCRIPTION("CAPI4Linux: PCMCIA client driver for AVM B1/M1/M2");
  40 MODULE_AUTHOR("Carsten Paeth");
  41 MODULE_LICENSE("GPL");
  42
  43 /*====================================================================*/
  44
  45 /*
  46    The event() function is this driver's Card Services event handler.
  47    It will be called by Card Services when an appropriate card status
  48    event is received.  The config() and release() entry points are
  49    used to configure or release a socket, in response to card insertion
  50    and ejection events.  They are invoked from the skeleton event
  51    handler.
  52 */
  53
  54 static int avmcs_config(struct pcmcia_device *link);
  55 static void avmcs_release(struct pcmcia_device *link);
  56
  57 /*
  58    The attach() and detach() entry points are used to create and destroy
  59    "instances" of the driver, where each instance represents everything
  60    needed to manage one actual PCMCIA card.
  61 */
  62
  63 static void avmcs_detach(struct pcmcia_device *p_dev);
  64
  65 /*
  66    A linked list of "instances" of the skeleton device.  Each actual
  67    PCMCIA card corresponds to one device instance, and is described
  68    by one struct pcmcia_device structure (defined in ds.h).
  69
  70    You may not want to use a linked list for this -- for example, the
  71    memory card driver uses an array of struct pcmcia_device pointers, where minor
  72    device numbers are used to derive the corresponding array index.
  73 */
  74
  75 /*
  76    A driver needs to provide a dev_node_t structure for each device
  77    on a card.  In some cases, there is only one device per card (for
  78    example, ethernet cards, modems).  In other cases, there may be
  79    many actual or logical devices (SCSI adapters, memory cards with
  80    multiple partitions).  The dev_node_t structures need to be kept
  81    in a linked list starting at the 'dev' field of a struct pcmcia_device
  82    structure.  We allocate them in the card's private data structure,
  83    because they generally can't be allocated dynamically.
  84 */
  85
  86 typedef struct local_info_t {
  87     dev_node_t  node;
  88 } local_info_t;
  89
  90 /*======================================================================
  91
  92     avmcs_attach() creates an "instance" of the driver, allocating
  93     local data structures for one device.  The device is registered
  94     with Card Services.
  95
  96     The dev_link structure is initialized, but we don't actually
  97     configure the card at this point -- we wait until we receive a
  98     card insertion event.
  99
 100 ======================================================================*/
 101
 102 static int avmcs_probe(struct pcmcia_device *p_dev)
 103 {
 104     local_info_t *local;
 105
 106     /* The io structure describes IO port mapping */
 107     p_dev->io.NumPorts1 = 16;
 108     p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 109     p_dev->io.NumPorts2 = 0;
 110
 111     /* Interrupt setup */
 112     p_dev->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
 113     p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED;
 114
 115     p_dev->irq.IRQInfo1 = IRQ_LEVEL_ID;
 116
 117     /* General socket configuration */
 118     p_dev->conf.Attributes = CONF_ENABLE_IRQ;
 119     p_dev->conf.IntType = INT_MEMORY_AND_IO;
 120     p_dev->conf.ConfigIndex = 1;
 121     p_dev->conf.Present = PRESENT_OPTION;
 122
 123     /* Allocate space for private device-specific data */
 124     local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
 125     if (!local)
 126         goto err;
 127     memset(local, 0, sizeof(local_info_t));
 128     p_dev->priv = local;
 129
 130     return avmcs_config(p_dev);
 131
 132  err:
 133     return -ENOMEM;
 134 } /* avmcs_attach */
 135
 136 /*======================================================================
 137
 138     This deletes a driver "instance".  The device is de-registered
 139     with Card Services.  If it has been released, all local data
 140     structures are freed.  Otherwise, the structures will be freed
 141     when the device is released.
 142
 143 ======================================================================*/
 144
 145 static void avmcs_detach(struct pcmcia_device *link)
 146 {
 147         avmcs_release(link);
 148         kfree(link->priv);
 149 } /* avmcs_detach */
 150
 151 /*======================================================================
 152
 153     avmcs_config() is scheduled to run after a CARD_INSERTION event
 154     is received, to configure the PCMCIA socket, and to make the
 155     ethernet device available to the system.
 156
 157 ======================================================================*/
 158
 159 static int get_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 160                      cisparse_t *parse)
 161 {
 162     int i = pcmcia_get_tuple_data(handle, tuple);
 163     if (i != CS_SUCCESS) return i;
 164     return pcmcia_parse_tuple(handle, tuple, parse);
 165 }
 166
 167 static int first_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 168                      cisparse_t *parse)
 169 {
 170     int i = pcmcia_get_first_tuple(handle, tuple);
 171     if (i != CS_SUCCESS) return i;
 172     return get_tuple(handle, tuple, parse);
 173 }
 174
 175 static int next_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 176                      cisparse_t *parse)
 177 {
 178     int i = pcmcia_get_next_tuple(handle, tuple);
 179     if (i != CS_SUCCESS) return i;
 180     return get_tuple(handle, tuple, parse);
 181 }
 182
 183 static int avmcs_config(struct pcmcia_device *link)
 184 {
 185     tuple_t tuple;
 186     cisparse_t parse;
 187     cistpl_cftable_entry_t *cf = &parse.cftable_entry;
 188     local_info_t *dev;
 189     int i;
 190     u_char buf[64];
 191     char devname[128];
 192     int cardtype;
 193     int (*addcard)(unsigned int port, unsigned irq);
 194
 195     dev = link->priv;
 196
 197     /*
 198        This reads the card's CONFIG tuple to find its configuration
 199        registers.
 200     */
 201     do {
 202         tuple.DesiredTuple = CISTPL_CONFIG;
 203         i = pcmcia_get_first_tuple(link, &tuple);
 204         if (i != CS_SUCCESS) break;
 205         tuple.TupleData = buf;
 206         tuple.TupleDataMax = 64;
 207         tuple.TupleOffset = 0;
 208         i = pcmcia_get_tuple_data(link, &tuple);
 209         if (i != CS_SUCCESS) break;
 210         i = pcmcia_parse_tuple(link, &tuple, &parse);
 211         if (i != CS_SUCCESS) break;
 212         link->conf.ConfigBase = parse.config.base;
 213     } while (0);
 214     if (i != CS_SUCCESS) {
 215         cs_error(link, ParseTuple, i);
 216         return -ENODEV;
 217     }
 218
 219     do {
 220         devname[0] = 0;
 221         if (link->prod_id[1])
 222                 strlcpy(devname, link->prod_id[1], sizeof(devname));
 223
 224         /*
 225          * find IO port
 226          */
 227         tuple.TupleData = (cisdata_t *)buf;
 228         tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
 229         tuple.Attributes = 0;
 230         tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
 231         i = first_tuple(link, &tuple, &parse);
 232         while (i == CS_SUCCESS) {
 233             if (cf->io.nwin > 0) {
 234                 link->conf.ConfigIndex = cf->index;
 235                 link->io.BasePort1 = cf->io.win[0].base;
 236                 link->io.NumPorts1 = cf->io.win[0].len;
 237                 link->io.NumPorts2 = 0;
 238                 printk(KERN_INFO "avm_cs: testing i/o %#x-%#x\n",
 239                         link->io.BasePort1,
 240                         link->io.BasePort1+link->io.NumPorts1-1);
 241                 i = pcmcia_request_io(link, &link->io);
 242                 if (i == CS_SUCCESS) goto found_port;
 243             }
 244             i = next_tuple(link, &tuple, &parse);
 245         }
 246
 247 found_port:
 248         if (i != CS_SUCCESS) {
 249             cs_error(link, RequestIO, i);
 250             break;
 251         }
 252
 253         /*
 254          * allocate an interrupt line
 255          */
 256         i = pcmcia_request_irq(link, &link->irq);
 257         if (i != CS_SUCCESS) {
 258             cs_error(link, RequestIRQ, i);
 259             /* undo */
 260             pcmcia_disable_device(link);
 261             break;
 262         }
 263
 264         /*
 265          * configure the PCMCIA socket
 266           */
 267         i = pcmcia_request_configuration(link, &link->conf);
 268         if (i != CS_SUCCESS) {
 269             cs_error(link, RequestConfiguration, i);
 270             pcmcia_disable_device(link);
 271             break;
 272         }
 273
 274     } while (0);
 275
 276     /* At this point, the dev_node_t structure(s) should be
 277        initialized and arranged in a linked list at link->dev. */
 278
 279     if (devname[0]) {
 280         char *s = strrchr(devname, ' ');
 281         if (!s)
 282            s = devname;
 283         else s++;
 284         strcpy(dev->node.dev_name, s);
 285         if (strcmp("M1", s) == 0) {
 286            cardtype = AVM_CARDTYPE_M1;
 287         } else if (strcmp("M2", s) == 0) {
 288            cardtype = AVM_CARDTYPE_M2;
 289         } else {
 290            cardtype = AVM_CARDTYPE_B1;
 291         }
 292     } else {
 293         strcpy(dev->node.dev_name, "b1");
 294         cardtype = AVM_CARDTYPE_B1;
 295     }
 296
 297     dev->node.major = 64;
 298     dev->node.minor = 0;
 299     link->dev_node = &dev->node;
 300
 301     /* If any step failed, release any partially configured state */
 302     if (i != 0) {
 303         avmcs_release(link);
 304         return -ENODEV;
 305     }
 306
 307
 308     switch (cardtype) {
 309         case AVM_CARDTYPE_M1: addcard = b1pcmcia_addcard_m1; break;
 310         case AVM_CARDTYPE_M2: addcard = b1pcmcia_addcard_m2; break;
 311         default:
 312         case AVM_CARDTYPE_B1: addcard = b1pcmcia_addcard_b1; break;
 313     }
 314     if ((i = (*addcard)(link->io.BasePort1, link->irq.AssignedIRQ)) < 0) {
 315         printk(KERN_ERR "avm_cs: failed to add AVM-%s-Controller at i/o %#x, irq %d\n",
 316                 dev->node.dev_name, link->io.BasePort1, link->irq.AssignedIRQ);
 317         avmcs_release(link);
 318         return -ENODEV;
 319     }
 320     dev->node.minor = i;
 321     return 0;
 322
 323 } /* avmcs_config */
 324
 325 /*======================================================================
 326
 327     After a card is removed, avmcs_release() will unregister the net
 328     device, and release the PCMCIA configuration.  If the device is
 329     still open, this will be postponed until it is closed.
 330
 331 ======================================================================*/
 332
 333 static void avmcs_release(struct pcmcia_device *link)
 334 {
 335         b1pcmcia_delcard(link->io.BasePort1, link->irq.AssignedIRQ);
 336         pcmcia_disable_device(link);
 337 } /* avmcs_release */
 338
 339
 340 static struct pcmcia_device_id avmcs_ids[] = {
 341         PCMCIA_DEVICE_PROD_ID12("AVM", "ISDN-Controller B1", 0x95d42008, 0x845dc335),
 342         PCMCIA_DEVICE_PROD_ID12("AVM", "Mobile ISDN-Controller M1", 0x95d42008, 0x81e10430),
 343         PCMCIA_DEVICE_PROD_ID12("AVM", "Mobile ISDN-Controller M2", 0x95d42008, 0x18e8558a),
 344         PCMCIA_DEVICE_NULL
 345 };
 346 MODULE_DEVICE_TABLE(pcmcia, avmcs_ids);
 347
 348 static struct pcmcia_driver avmcs_driver = {
 349         .owner  = THIS_MODULE,
 350         .drv    = {
 351                 .name   = "avm_cs",
 352         },
 353         .probe = avmcs_probe,
 354         .remove = avmcs_detach,
 355         .id_table = avmcs_ids,
 356 };
 357
 358 static int __init avmcs_init(void)
 359 {
 360         return pcmcia_register_driver(&avmcs_driver);
 361 }
 362
 363 static void __exit avmcs_exit(void)
 364 {
 365         pcmcia_unregister_driver(&avmcs_driver);
 366 }
 367
 368 module_init(avmcs_init);
 369 module_exit(avmcs_exit);