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 = kzalloc(sizeof(local_info_t), GFP_KERNEL);
 125     if (!local)
 126         goto err;
 127     p_dev->priv = local;
 128
 129     return avmcs_config(p_dev);
 130
 131  err:
 132     return -ENOMEM;
 133 } /* avmcs_attach */
 134
 135 /*======================================================================
 136
 137     This deletes a driver "instance".  The device is de-registered
 138     with Card Services.  If it has been released, all local data
 139     structures are freed.  Otherwise, the structures will be freed
 140     when the device is released.
 141
 142 ======================================================================*/
 143
 144 static void avmcs_detach(struct pcmcia_device *link)
 145 {
 146         avmcs_release(link);
 147         kfree(link->priv);
 148 } /* avmcs_detach */
 149
 150 /*======================================================================
 151
 152     avmcs_config() is scheduled to run after a CARD_INSERTION event
 153     is received, to configure the PCMCIA socket, and to make the
 154     ethernet device available to the system.
 155
 156 ======================================================================*/
 157
 158 static int get_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 159                      cisparse_t *parse)
 160 {
 161     int i = pcmcia_get_tuple_data(handle, tuple);
 162     if (i != CS_SUCCESS) return i;
 163     return pcmcia_parse_tuple(handle, tuple, parse);
 164 }
 165
 166 static int first_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 167                      cisparse_t *parse)
 168 {
 169     int i = pcmcia_get_first_tuple(handle, tuple);
 170     if (i != CS_SUCCESS) return i;
 171     return get_tuple(handle, tuple, parse);
 172 }
 173
 174 static int next_tuple(struct pcmcia_device *handle, tuple_t *tuple,
 175                      cisparse_t *parse)
 176 {
 177     int i = pcmcia_get_next_tuple(handle, tuple);
 178     if (i != CS_SUCCESS) return i;
 179     return get_tuple(handle, tuple, parse);
 180 }
 181
 182 static int avmcs_config(struct pcmcia_device *link)
 183 {
 184     tuple_t tuple;
 185     cisparse_t parse;
 186     cistpl_cftable_entry_t *cf = &parse.cftable_entry;
 187     local_info_t *dev;
 188     int i;
 189     u_char buf[64];
 190     char devname[128];
 191     int cardtype;
 192     int (*addcard)(unsigned int port, unsigned irq);
 193
 194     dev = link->priv;
 195
 196     do {
 197         devname[0] = 0;
 198         if (link->prod_id[1])
 199                 strlcpy(devname, link->prod_id[1], sizeof(devname));
 200
 201         /*
 202          * find IO port
 203          */
 204         tuple.TupleData = (cisdata_t *)buf;
 205         tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
 206         tuple.Attributes = 0;
 207         tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
 208         i = first_tuple(link, &tuple, &parse);
 209         while (i == CS_SUCCESS) {
 210             if (cf->io.nwin > 0) {
 211                 link->conf.ConfigIndex = cf->index;
 212                 link->io.BasePort1 = cf->io.win[0].base;
 213                 link->io.NumPorts1 = cf->io.win[0].len;
 214                 link->io.NumPorts2 = 0;
 215                 printk(KERN_INFO "avm_cs: testing i/o %#x-%#x\n",
 216                         link->io.BasePort1,
 217                         link->io.BasePort1+link->io.NumPorts1-1);
 218                 i = pcmcia_request_io(link, &link->io);
 219                 if (i == CS_SUCCESS) goto found_port;
 220             }
 221             i = next_tuple(link, &tuple, &parse);
 222         }
 223
 224 found_port:
 225         if (i != CS_SUCCESS) {
 226             cs_error(link, RequestIO, i);
 227             break;
 228         }
 229
 230         /*
 231          * allocate an interrupt line
 232          */
 233         i = pcmcia_request_irq(link, &link->irq);
 234         if (i != CS_SUCCESS) {
 235             cs_error(link, RequestIRQ, i);
 236             /* undo */
 237             pcmcia_disable_device(link);
 238             break;
 239         }
 240
 241         /*
 242          * configure the PCMCIA socket
 243           */
 244         i = pcmcia_request_configuration(link, &link->conf);
 245         if (i != CS_SUCCESS) {
 246             cs_error(link, RequestConfiguration, i);
 247             pcmcia_disable_device(link);
 248             break;
 249         }
 250
 251     } while (0);
 252
 253     /* At this point, the dev_node_t structure(s) should be
 254        initialized and arranged in a linked list at link->dev. */
 255
 256     if (devname[0]) {
 257         char *s = strrchr(devname, ' ');
 258         if (!s)
 259            s = devname;
 260         else s++;
 261         strcpy(dev->node.dev_name, s);
 262         if (strcmp("M1", s) == 0) {
 263            cardtype = AVM_CARDTYPE_M1;
 264         } else if (strcmp("M2", s) == 0) {
 265            cardtype = AVM_CARDTYPE_M2;
 266         } else {
 267            cardtype = AVM_CARDTYPE_B1;
 268         }
 269     } else {
 270         strcpy(dev->node.dev_name, "b1");
 271         cardtype = AVM_CARDTYPE_B1;
 272     }
 273
 274     dev->node.major = 64;
 275     dev->node.minor = 0;
 276     link->dev_node = &dev->node;
 277
 278     /* If any step failed, release any partially configured state */
 279     if (i != 0) {
 280         avmcs_release(link);
 281         return -ENODEV;
 282     }
 283
 284
 285     switch (cardtype) {
 286         case AVM_CARDTYPE_M1: addcard = b1pcmcia_addcard_m1; break;
 287         case AVM_CARDTYPE_M2: addcard = b1pcmcia_addcard_m2; break;
 288         default:
 289         case AVM_CARDTYPE_B1: addcard = b1pcmcia_addcard_b1; break;
 290     }
 291     if ((i = (*addcard)(link->io.BasePort1, link->irq.AssignedIRQ)) < 0) {
 292         printk(KERN_ERR "avm_cs: failed to add AVM-%s-Controller at i/o %#x, irq %d\n",
 293                 dev->node.dev_name, link->io.BasePort1, link->irq.AssignedIRQ);
 294         avmcs_release(link);
 295         return -ENODEV;
 296     }
 297     dev->node.minor = i;
 298     return 0;
 299
 300 } /* avmcs_config */
 301
 302 /*======================================================================
 303
 304     After a card is removed, avmcs_release() will unregister the net
 305     device, and release the PCMCIA configuration.  If the device is
 306     still open, this will be postponed until it is closed.
 307
 308 ======================================================================*/
 309
 310 static void avmcs_release(struct pcmcia_device *link)
 311 {
 312         b1pcmcia_delcard(link->io.BasePort1, link->irq.AssignedIRQ);
 313         pcmcia_disable_device(link);
 314 } /* avmcs_release */
 315
 316
 317 static struct pcmcia_device_id avmcs_ids[] = {
 318         PCMCIA_DEVICE_PROD_ID12("AVM", "ISDN-Controller B1", 0x95d42008, 0x845dc335),
 319         PCMCIA_DEVICE_PROD_ID12("AVM", "Mobile ISDN-Controller M1", 0x95d42008, 0x81e10430),
 320         PCMCIA_DEVICE_PROD_ID12("AVM", "Mobile ISDN-Controller M2", 0x95d42008, 0x18e8558a),
 321         PCMCIA_DEVICE_NULL
 322 };
 323 MODULE_DEVICE_TABLE(pcmcia, avmcs_ids);
 324
 325 static struct pcmcia_driver avmcs_driver = {
 326         .owner  = THIS_MODULE,
 327         .drv    = {
 328                 .name   = "avm_cs",
 329         },
 330         .probe = avmcs_probe,
 331         .remove = avmcs_detach,
 332         .id_table = avmcs_ids,
 333 };
 334
 335 static int __init avmcs_init(void)
 336 {
 337         return pcmcia_register_driver(&avmcs_driver);
 338 }
 339
 340 static void __exit avmcs_exit(void)
 341 {
 342         pcmcia_unregister_driver(&avmcs_driver);
 343 }
 344
 345 module_init(avmcs_init);
 346 module_exit(avmcs_exit);