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     link->conf.IntType = INT_MEMORY_AND_IO;
 137
 138     return sedlbauer_config(link);
 139 } /* sedlbauer_attach */
 140
 141 /*======================================================================
 142
 143     This deletes a driver "instance".  The device is de-registered
 144     with Card Services.  If it has been released, all local data
 145     structures are freed.  Otherwise, the structures will be freed
 146     when the device is released.
 147
 148 ======================================================================*/
 149
 150 static void __devexit sedlbauer_detach(struct pcmcia_device *link)
 151 {
 152         dev_dbg(&link->dev, "sedlbauer_detach(0x%p)\n", link);
 153
 154         ((local_info_t *)link->priv)->stop = 1;
 155         sedlbauer_release(link);
 156
 157         /* This points to the parent local_info_t struct */
 158         kfree(link->priv);
 159 } /* sedlbauer_detach */
 160
 161 /*======================================================================
 162
 163     sedlbauer_config() is scheduled to run after a CARD_INSERTION event
 164     is received, to configure the PCMCIA socket, and to make the
 165     device available to the system.
 166
 167 ======================================================================*/
 168 static int sedlbauer_config_check(struct pcmcia_device *p_dev,
 169                                   cistpl_cftable_entry_t *cfg,
 170                                   cistpl_cftable_entry_t *dflt,
 171                                   unsigned int vcc,
 172                                   void *priv_data)
 173 {
 174         if (cfg->index == 0)
 175                 return -ENODEV;
 176
 177         /* Does this card need audio output? */
 178         if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
 179                 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
 180                 p_dev->conf.Status = CCSR_AUDIO_ENA;
 181         }
 182
 183         /* Use power settings for Vcc and Vpp if present */
 184         /*  Note that the CIS values need to be rescaled */
 185         if (cfg->vcc.present & (1<<CISTPL_POWER_VNOM)) {
 186                 if (vcc != cfg->vcc.param[CISTPL_POWER_VNOM]/10000)
 187                         return -ENODEV;
 188         } else if (dflt->vcc.present & (1<<CISTPL_POWER_VNOM)) {
 189                 if (vcc != dflt->vcc.param[CISTPL_POWER_VNOM]/10000)
 190                         return -ENODEV;
 191         }
 192
 193         if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
 194                 p_dev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
 195         else if (dflt->vpp1.present & (1<<CISTPL_POWER_VNOM))
 196                 p_dev->conf.Vpp = dflt->vpp1.param[CISTPL_POWER_VNOM]/10000;
 197
 198         p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
 199
 200         /* IO window settings */
 201         p_dev->resource[0]->end = p_dev->resource[1]->end = 0;
 202         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
 203                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
 204                 p_dev->resource[0]->start = io->win[0].base;
 205                 p_dev->resource[0]->end = io->win[0].len;
 206                 p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
 207                 p_dev->resource[0]->flags |=
 208                                         pcmcia_io_cfg_data_width(io->flags);
 209                 if (io->nwin > 1) {
 210                         p_dev->resource[1]->flags = p_dev->resource[0]->flags;
 211                         p_dev->resource[1]->start = io->win[1].base;
 212                         p_dev->resource[1]->end = io->win[1].len;
 213                 }
 214                 /* This reserves IO space but doesn't actually enable it */
 215                 p_dev->io_lines = 3;
 216                 if (pcmcia_request_io(p_dev) != 0)
 217                         return -ENODEV;
 218         }
 219
 220         return 0;
 221 }
 222
 223
 224
 225 static int __devinit sedlbauer_config(struct pcmcia_device *link)
 226 {
 227     int ret;
 228     IsdnCard_t  icard;
 229
 230     dev_dbg(&link->dev, "sedlbauer_config(0x%p)\n", link);
 231
 232     /*
 233       In this loop, we scan the CIS for configuration table entries,
 234       each of which describes a valid card configuration, including
 235       voltage, IO window, memory window, and interrupt settings.
 236
 237       We make no assumptions about the card to be configured: we use
 238       just the information available in the CIS.  In an ideal world,
 239       this would work for any PCMCIA card, but it requires a complete
 240       and accurate CIS.  In practice, a driver usually "knows" most of
 241       these things without consulting the CIS, and most client drivers
 242       will only use the CIS to fill in implementation-defined details.
 243     */
 244     ret = pcmcia_loop_config(link, sedlbauer_config_check, NULL);
 245     if (ret)
 246             goto failed;
 247
 248     /*
 249        This actually configures the PCMCIA socket -- setting up
 250        the I/O windows and the interrupt mapping, and putting the
 251        card and host interface into "Memory and IO" mode.
 252     */
 253     ret = pcmcia_request_configuration(link, &link->conf);
 254     if (ret)
 255             goto failed;
 256
 257     /* Finally, report what we've done */
 258     dev_info(&link->dev, "index 0x%02x:",
 259            link->conf.ConfigIndex);
 260     if (link->conf.Vpp)
 261         printk(", Vpp %d.%d", link->conf.Vpp/10, link->conf.Vpp%10);
 262     if (link->conf.Attributes & CONF_ENABLE_IRQ)
 263         printk(", irq %d", link->irq);
 264     if (link->resource[0])
 265         printk(" & %pR", link->resource[0]);
 266     if (link->resource[1])
 267         printk(" & %pR", link->resource[1]);
 268     printk("\n");
 269
 270     icard.para[0] = link->irq;
 271     icard.para[1] = link->resource[0]->start;
 272     icard.protocol = protocol;
 273     icard.typ = ISDN_CTYPE_SEDLBAUER_PCMCIA;
 274
 275     ret = hisax_init_pcmcia(link,
 276                             &(((local_info_t *)link->priv)->stop), &icard);
 277     if (ret < 0) {
 278         printk(KERN_ERR "sedlbauer_cs: failed to initialize SEDLBAUER PCMCIA %d with %pR\n",
 279                 ret, link->resource[0]);
 280         sedlbauer_release(link);
 281         return -ENODEV;
 282     } else
 283         ((local_info_t *)link->priv)->cardnr = ret;
 284
 285     return 0;
 286
 287 failed:
 288     sedlbauer_release(link);
 289     return -ENODEV;
 290
 291 } /* sedlbauer_config */
 292
 293 /*======================================================================
 294
 295     After a card is removed, sedlbauer_release() will unregister the
 296     device, and release the PCMCIA configuration.  If the device is
 297     still open, this will be postponed until it is closed.
 298
 299 ======================================================================*/
 300
 301 static void sedlbauer_release(struct pcmcia_device *link)
 302 {
 303     local_info_t *local = link->priv;
 304     dev_dbg(&link->dev, "sedlbauer_release(0x%p)\n", link);
 305
 306     if (local) {
 307         if (local->cardnr >= 0) {
 308             /* no unregister function with hisax */
 309             HiSax_closecard(local->cardnr);
 310         }
 311     }
 312
 313     pcmcia_disable_device(link);
 314 } /* sedlbauer_release */
 315
 316 static int sedlbauer_suspend(struct pcmcia_device *link)
 317 {
 318         local_info_t *dev = link->priv;
 319
 320         dev->stop = 1;
 321
 322         return 0;
 323 }
 324
 325 static int sedlbauer_resume(struct pcmcia_device *link)
 326 {
 327         local_info_t *dev = link->priv;
 328
 329         dev->stop = 0;
 330
 331         return 0;
 332 }
 333
 334
 335 static struct pcmcia_device_id sedlbauer_ids[] = {
 336         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "speed star II", "V 3.1", 0x81fb79f5, 0xf3612e1d, 0x6b95c78a),
 337         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D67", 0x81fb79f5, 0xe4e9bc12, 0x397b7e90),
 338         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D98", 0x81fb79f5, 0xe4e9bc12, 0x2e5c7fce),
 339         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (C) 93-94 VK", 0x81fb79f5, 0xe4e9bc12, 0x8db143fe),
 340         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (c) 93-95 VK", 0x81fb79f5, 0xe4e9bc12, 0xb391ab4c),
 341         PCMCIA_DEVICE_PROD_ID12("HST High Soft Tech GmbH", "Saphir II B", 0xd79e0b84, 0x21d083ae),
 342 /*      PCMCIA_DEVICE_PROD_ID1234("SEDLBAUER", 0x81fb79f5), */ /* too generic*/
 343         PCMCIA_DEVICE_NULL
 344 };
 345 MODULE_DEVICE_TABLE(pcmcia, sedlbauer_ids);
 346
 347 static struct pcmcia_driver sedlbauer_driver = {
 348         .owner          = THIS_MODULE,
 349         .drv            = {
 350                 .name   = "sedlbauer_cs",
 351         },
 352         .probe          = sedlbauer_probe,
 353         .remove         = __devexit_p(sedlbauer_detach),
 354         .id_table       = sedlbauer_ids,
 355         .suspend        = sedlbauer_suspend,
 356         .resume         = sedlbauer_resume,
 357 };
 358
 359 static int __init init_sedlbauer_cs(void)
 360 {
 361         return pcmcia_register_driver(&sedlbauer_driver);
 362 }
 363
 364 static void __exit exit_sedlbauer_cs(void)
 365 {
 366         pcmcia_unregister_driver(&sedlbauer_driver);
 367 }
 368
 369 module_init(init_sedlbauer_cs);
 370 module_exit(exit_sedlbauer_cs);