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
 132     return sedlbauer_config(link);
 133 } /* sedlbauer_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 __devexit sedlbauer_detach(struct pcmcia_device *link)
 145 {
 146         dev_dbg(&link->dev, "sedlbauer_detach(0x%p)\n", link);
 147
 148         ((local_info_t *)link->priv)->stop = 1;
 149         sedlbauer_release(link);
 150
 151         /* This points to the parent local_info_t struct */
 152         kfree(link->priv);
 153 } /* sedlbauer_detach */
 154
 155 /*======================================================================
 156
 157     sedlbauer_config() is scheduled to run after a CARD_INSERTION event
 158     is received, to configure the PCMCIA socket, and to make the
 159     device available to the system.
 160
 161 ======================================================================*/
 162 static int sedlbauer_config_check(struct pcmcia_device *p_dev, void *priv_data)
 163 {
 164         if (p_dev->config_index == 0)
 165                 return -EINVAL;
 166
 167         p_dev->io_lines = 3;
 168         return pcmcia_request_io(p_dev);
 169 }
 170
 171
 172
 173 static int __devinit sedlbauer_config(struct pcmcia_device *link)
 174 {
 175     int ret;
 176     IsdnCard_t  icard;
 177
 178     dev_dbg(&link->dev, "sedlbauer_config(0x%p)\n", link);
 179
 180     link->config_flags |= CONF_ENABLE_IRQ | CONF_AUTO_CHECK_VCC |
 181             CONF_AUTO_SET_VPP | CONF_AUTO_AUDIO | CONF_AUTO_SET_IO;
 182
 183     /*
 184       In this loop, we scan the CIS for configuration table entries,
 185       each of which describes a valid card configuration, including
 186       voltage, IO window, memory window, and interrupt settings.
 187
 188       We make no assumptions about the card to be configured: we use
 189       just the information available in the CIS.  In an ideal world,
 190       this would work for any PCMCIA card, but it requires a complete
 191       and accurate CIS.  In practice, a driver usually "knows" most of
 192       these things without consulting the CIS, and most client drivers
 193       will only use the CIS to fill in implementation-defined details.
 194     */
 195     ret = pcmcia_loop_config(link, sedlbauer_config_check, NULL);
 196     if (ret)
 197             goto failed;
 198
 199     /*
 200        This actually configures the PCMCIA socket -- setting up
 201        the I/O windows and the interrupt mapping, and putting the
 202        card and host interface into "Memory and IO" mode.
 203     */
 204     ret = pcmcia_enable_device(link);
 205     if (ret)
 206             goto failed;
 207
 208     icard.para[0] = link->irq;
 209     icard.para[1] = link->resource[0]->start;
 210     icard.protocol = protocol;
 211     icard.typ = ISDN_CTYPE_SEDLBAUER_PCMCIA;
 212
 213     ret = hisax_init_pcmcia(link,
 214                             &(((local_info_t *)link->priv)->stop), &icard);
 215     if (ret < 0) {
 216         printk(KERN_ERR "sedlbauer_cs: failed to initialize SEDLBAUER PCMCIA %d with %pR\n",
 217                 ret, link->resource[0]);
 218         sedlbauer_release(link);
 219         return -ENODEV;
 220     } else
 221         ((local_info_t *)link->priv)->cardnr = ret;
 222
 223     return 0;
 224
 225 failed:
 226     sedlbauer_release(link);
 227     return -ENODEV;
 228
 229 } /* sedlbauer_config */
 230
 231 /*======================================================================
 232
 233     After a card is removed, sedlbauer_release() will unregister the
 234     device, and release the PCMCIA configuration.  If the device is
 235     still open, this will be postponed until it is closed.
 236
 237 ======================================================================*/
 238
 239 static void sedlbauer_release(struct pcmcia_device *link)
 240 {
 241     local_info_t *local = link->priv;
 242     dev_dbg(&link->dev, "sedlbauer_release(0x%p)\n", link);
 243
 244     if (local) {
 245         if (local->cardnr >= 0) {
 246             /* no unregister function with hisax */
 247             HiSax_closecard(local->cardnr);
 248         }
 249     }
 250
 251     pcmcia_disable_device(link);
 252 } /* sedlbauer_release */
 253
 254 static int sedlbauer_suspend(struct pcmcia_device *link)
 255 {
 256         local_info_t *dev = link->priv;
 257
 258         dev->stop = 1;
 259
 260         return 0;
 261 }
 262
 263 static int sedlbauer_resume(struct pcmcia_device *link)
 264 {
 265         local_info_t *dev = link->priv;
 266
 267         dev->stop = 0;
 268
 269         return 0;
 270 }
 271
 272
 273 static struct pcmcia_device_id sedlbauer_ids[] = {
 274         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "speed star II", "V 3.1", 0x81fb79f5, 0xf3612e1d, 0x6b95c78a),
 275         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D67", 0x81fb79f5, 0xe4e9bc12, 0x397b7e90),
 276         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D98", 0x81fb79f5, 0xe4e9bc12, 0x2e5c7fce),
 277         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (C) 93-94 VK", 0x81fb79f5, 0xe4e9bc12, 0x8db143fe),
 278         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (c) 93-95 VK", 0x81fb79f5, 0xe4e9bc12, 0xb391ab4c),
 279         PCMCIA_DEVICE_PROD_ID12("HST High Soft Tech GmbH", "Saphir II B", 0xd79e0b84, 0x21d083ae),
 280 /*      PCMCIA_DEVICE_PROD_ID1234("SEDLBAUER", 0x81fb79f5), */ /* too generic*/
 281         PCMCIA_DEVICE_NULL
 282 };
 283 MODULE_DEVICE_TABLE(pcmcia, sedlbauer_ids);
 284
 285 static struct pcmcia_driver sedlbauer_driver = {
 286         .owner          = THIS_MODULE,
 287         .name           = "sedlbauer_cs",
 288         .probe          = sedlbauer_probe,
 289         .remove         = __devexit_p(sedlbauer_detach),
 290         .id_table       = sedlbauer_ids,
 291         .suspend        = sedlbauer_suspend,
 292         .resume         = sedlbauer_resume,
 293 };
 294
 295 static int __init init_sedlbauer_cs(void)
 296 {
 297         return pcmcia_register_driver(&sedlbauer_driver);
 298 }
 299
 300 static void __exit exit_sedlbauer_cs(void)
 301 {
 302         pcmcia_unregister_driver(&sedlbauer_driver);
 303 }
 304
 305 module_init(init_sedlbauer_cs);
 306 module_exit(exit_sedlbauer_cs);