drivers/isdn/hisax/sedlbauer_cs.c

   1 /*======================================================================
   2
   3     A Sedlbauer PCMCIA client driver
   4
   5     This driver is for the Sedlbauer Speed Star and Speed Star II,
   6     which are ISDN PCMCIA Cards.
   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 Marcus Niemann
  23     <maniemann@users.sourceforge.net>. 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/kernel.h>
  39 #include <linux/module.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.h>
  50 #include <pcmcia/cistpl.h>
  51 #include <pcmcia/cisreg.h>
  52 #include <pcmcia/ds.h>
  53 #include "hisax_cfg.h"
  54
  55 MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Sedlbauer cards");
  56 MODULE_AUTHOR("Marcus Niemann");
  57 MODULE_LICENSE("Dual MPL/GPL");
  58
  59
  60 /*====================================================================*/
  61
  62 /* Parameters that can be set with 'insmod' */
  63
  64 static int protocol = 2;        /* EURO-ISDN Default */
  65 module_param(protocol, int, 0);
  66
  67 /*====================================================================*/
  68
  69 /*
  70    The event() function is this driver's Card Services event handler.
  71    It will be called by Card Services when an appropriate card status
  72    event is received.  The config() and release() entry points are
  73    used to configure or release a socket, in response to card
  74    insertion and ejection events.  They are invoked from the sedlbauer
  75    event handler.
  76 */
  77
  78 static int sedlbauer_config(struct pcmcia_device *link) __devinit ;
  79 static void sedlbauer_release(struct pcmcia_device *link);
  80
  81 /*
  82    The attach() and detach() entry points are used to create and destroy
  83    "instances" of the driver, where each instance represents everything
  84    needed to manage one actual PCMCIA card.
  85 */
  86
  87 static void sedlbauer_detach(struct pcmcia_device *p_dev) __devexit;
  88
  89 typedef struct local_info_t {
  90         struct pcmcia_device    *p_dev;
  91     int                 stop;
  92     int                 cardnr;
  93 } local_info_t;
  94
  95 /*======================================================================
  96
  97     sedlbauer_attach() creates an "instance" of the driver, allocating
  98     local data structures for one device.  The device is registered
  99     with Card Services.
 100
 101     The dev_link structure is initialized, but we don't actually
 102     configure the card at this point -- we wait until we receive a
 103     card insertion event.
 104
 105 ======================================================================*/
 106
 107 static int __devinit sedlbauer_probe(struct pcmcia_device *link)
 108 {
 109     local_info_t *local;
 110
 111     dev_dbg(&link->dev, "sedlbauer_attach()\n");
 112
 113     /* Allocate space for private device-specific data */
 114     local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
 115     if (!local) return -ENOMEM;
 116     local->cardnr = -1;
 117
 118     local->p_dev = link;
 119     link->priv = local;
 120
 121     /*
 122       General socket configuration defaults can go here.  In this
 123       client, we assume very little, and rely on the CIS for almost
 124       everything.  In most clients, many details (i.e., number, sizes,
 125       and attributes of IO windows) are fixed by the nature of the
 126       device, and can be hard-wired here.
 127     */
 128
 129     /* from old sedl_cs
 130     */
 131     /* The io structure describes IO port mapping */
 132     link->resource[0]->end = 8;
 133     link->resource[0]->flags |= IO_DATA_PATH_WIDTH_8;
 134
 135     link->conf.Attributes = 0;
 136
 137     return sedlbauer_config(link);
 138 } /* sedlbauer_attach */
 139
 140 /*======================================================================
 141
 142     This deletes a driver "instance".  The device is de-registered
 143     with Card Services.  If it has been released, all local data
 144     structures are freed.  Otherwise, the structures will be freed
 145     when the device is released.
 146
 147 ======================================================================*/
 148
 149 static void __devexit sedlbauer_detach(struct pcmcia_device *link)
 150 {
 151         dev_dbg(&link->dev, "sedlbauer_detach(0x%p)\n", link);
 152
 153         ((local_info_t *)link->priv)->stop = 1;
 154         sedlbauer_release(link);
 155
 156         /* This points to the parent local_info_t struct */
 157         kfree(link->priv);
 158 } /* sedlbauer_detach */
 159
 160 /*======================================================================
 161
 162     sedlbauer_config() is scheduled to run after a CARD_INSERTION event
 163     is received, to configure the PCMCIA socket, and to make the
 164     device available to the system.
 165
 166 ======================================================================*/
 167 static int sedlbauer_config_check(struct pcmcia_device *p_dev,
 168                                   cistpl_cftable_entry_t *cfg,
 169                                   cistpl_cftable_entry_t *dflt,
 170                                   unsigned int vcc,
 171                                   void *priv_data)
 172 {
 173         if (cfg->index == 0)
 174                 return -ENODEV;
 175
 176         /* Does this card need audio output? */
 177         if (cfg->flags & CISTPL_CFTABLE_AUDIO)
 178                 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
 179
 180         /* Use power settings for Vcc and Vpp if present */
 181         /*  Note that the CIS values need to be rescaled */
 182         if (cfg->vcc.present & (1<<CISTPL_POWER_VNOM)) {
 183                 if (vcc != cfg->vcc.param[CISTPL_POWER_VNOM]/10000)
 184                         return -ENODEV;
 185         } else if (dflt->vcc.present & (1<<CISTPL_POWER_VNOM)) {
 186                 if (vcc != dflt->vcc.param[CISTPL_POWER_VNOM]/10000)
 187                         return -ENODEV;
 188         }
 189
 190         if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
 191                 p_dev->vpp = cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
 192         else if (dflt->vpp1.present & (1<<CISTPL_POWER_VNOM))
 193                 p_dev->vpp = dflt->vpp1.param[CISTPL_POWER_VNOM]/10000;
 194
 195         p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
 196
 197         /* IO window settings */
 198         p_dev->resource[0]->end = p_dev->resource[1]->end = 0;
 199         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
 200                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
 201                 p_dev->resource[0]->start = io->win[0].base;
 202                 p_dev->resource[0]->end = io->win[0].len;
 203                 p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
 204                 p_dev->resource[0]->flags |=
 205                                         pcmcia_io_cfg_data_width(io->flags);
 206                 if (io->nwin > 1) {
 207                         p_dev->resource[1]->flags = p_dev->resource[0]->flags;
 208                         p_dev->resource[1]->start = io->win[1].base;
 209                         p_dev->resource[1]->end = io->win[1].len;
 210                 }
 211                 /* This reserves IO space but doesn't actually enable it */
 212                 p_dev->io_lines = 3;
 213                 if (pcmcia_request_io(p_dev) != 0)
 214                         return -ENODEV;
 215         }
 216
 217         return 0;
 218 }
 219
 220
 221
 222 static int __devinit sedlbauer_config(struct pcmcia_device *link)
 223 {
 224     int ret;
 225     IsdnCard_t  icard;
 226
 227     dev_dbg(&link->dev, "sedlbauer_config(0x%p)\n", link);
 228
 229     /*
 230       In this loop, we scan the CIS for configuration table entries,
 231       each of which describes a valid card configuration, including
 232       voltage, IO window, memory window, and interrupt settings.
 233
 234       We make no assumptions about the card to be configured: we use
 235       just the information available in the CIS.  In an ideal world,
 236       this would work for any PCMCIA card, but it requires a complete
 237       and accurate CIS.  In practice, a driver usually "knows" most of
 238       these things without consulting the CIS, and most client drivers
 239       will only use the CIS to fill in implementation-defined details.
 240     */
 241     ret = pcmcia_loop_config(link, sedlbauer_config_check, NULL);
 242     if (ret)
 243             goto failed;
 244
 245     /*
 246        This actually configures the PCMCIA socket -- setting up
 247        the I/O windows and the interrupt mapping, and putting the
 248        card and host interface into "Memory and IO" mode.
 249     */
 250     ret = pcmcia_request_configuration(link, &link->conf);
 251     if (ret)
 252             goto failed;
 253
 254     /* Finally, report what we've done */
 255     dev_info(&link->dev, "index 0x%02x:",
 256            link->conf.ConfigIndex);
 257     if (link->vpp)
 258         printk(", Vpp %d.%d", link->vpp/10, link->vpp%10);
 259     if (link->conf.Attributes & CONF_ENABLE_IRQ)
 260         printk(", irq %d", link->irq);
 261     if (link->resource[0])
 262         printk(" & %pR", link->resource[0]);
 263     if (link->resource[1])
 264         printk(" & %pR", link->resource[1]);
 265     printk("\n");
 266
 267     icard.para[0] = link->irq;
 268     icard.para[1] = link->resource[0]->start;
 269     icard.protocol = protocol;
 270     icard.typ = ISDN_CTYPE_SEDLBAUER_PCMCIA;
 271
 272     ret = hisax_init_pcmcia(link,
 273                             &(((local_info_t *)link->priv)->stop), &icard);
 274     if (ret < 0) {
 275         printk(KERN_ERR "sedlbauer_cs: failed to initialize SEDLBAUER PCMCIA %d with %pR\n",
 276                 ret, link->resource[0]);
 277         sedlbauer_release(link);
 278         return -ENODEV;
 279     } else
 280         ((local_info_t *)link->priv)->cardnr = ret;
 281
 282     return 0;
 283
 284 failed:
 285     sedlbauer_release(link);
 286     return -ENODEV;
 287
 288 } /* sedlbauer_config */
 289
 290 /*======================================================================
 291
 292     After a card is removed, sedlbauer_release() will unregister the
 293     device, and release the PCMCIA configuration.  If the device is
 294     still open, this will be postponed until it is closed.
 295
 296 ======================================================================*/
 297
 298 static void sedlbauer_release(struct pcmcia_device *link)
 299 {
 300     local_info_t *local = link->priv;
 301     dev_dbg(&link->dev, "sedlbauer_release(0x%p)\n", link);
 302
 303     if (local) {
 304         if (local->cardnr >= 0) {
 305             /* no unregister function with hisax */
 306             HiSax_closecard(local->cardnr);
 307         }
 308     }
 309
 310     pcmcia_disable_device(link);
 311 } /* sedlbauer_release */
 312
 313 static int sedlbauer_suspend(struct pcmcia_device *link)
 314 {
 315         local_info_t *dev = link->priv;
 316
 317         dev->stop = 1;
 318
 319         return 0;
 320 }
 321
 322 static int sedlbauer_resume(struct pcmcia_device *link)
 323 {
 324         local_info_t *dev = link->priv;
 325
 326         dev->stop = 0;
 327
 328         return 0;
 329 }
 330
 331
 332 static struct pcmcia_device_id sedlbauer_ids[] = {
 333         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "speed star II", "V 3.1", 0x81fb79f5, 0xf3612e1d, 0x6b95c78a),
 334         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D67", 0x81fb79f5, 0xe4e9bc12, 0x397b7e90),
 335         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D98", 0x81fb79f5, 0xe4e9bc12, 0x2e5c7fce),
 336         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (C) 93-94 VK", 0x81fb79f5, 0xe4e9bc12, 0x8db143fe),
 337         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (c) 93-95 VK", 0x81fb79f5, 0xe4e9bc12, 0xb391ab4c),
 338         PCMCIA_DEVICE_PROD_ID12("HST High Soft Tech GmbH", "Saphir II B", 0xd79e0b84, 0x21d083ae),
 339 /*      PCMCIA_DEVICE_PROD_ID1234("SEDLBAUER", 0x81fb79f5), */ /* too generic*/
 340         PCMCIA_DEVICE_NULL
 341 };
 342 MODULE_DEVICE_TABLE(pcmcia, sedlbauer_ids);
 343
 344 static struct pcmcia_driver sedlbauer_driver = {
 345         .owner          = THIS_MODULE,
 346         .drv            = {
 347                 .name   = "sedlbauer_cs",
 348         },
 349         .probe          = sedlbauer_probe,
 350         .remove         = __devexit_p(sedlbauer_detach),
 351         .id_table       = sedlbauer_ids,
 352         .suspend        = sedlbauer_suspend,
 353         .resume         = sedlbauer_resume,
 354 };
 355
 356 static int __init init_sedlbauer_cs(void)
 357 {
 358         return pcmcia_register_driver(&sedlbauer_driver);
 359 }
 360
 361 static void __exit exit_sedlbauer_cs(void)
 362 {
 363         pcmcia_unregister_driver(&sedlbauer_driver);
 364 }
 365
 366 module_init(init_sedlbauer_cs);
 367 module_exit(exit_sedlbauer_cs);