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