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/sched.h>
  42 #include <linux/ptrace.h>
  43 #include <linux/slab.h>
  44 #include <linux/string.h>
  45 #include <linux/timer.h>
  46 #include <linux/ioport.h>
  47 #include <asm/io.h>
  48 #include <asm/system.h>
  49
  50 #include <pcmcia/cs_types.h>
  51 #include <pcmcia/cs.h>
  52 #include <pcmcia/cistpl.h>
  53 #include <pcmcia/cisreg.h>
  54 #include <pcmcia/ds.h>
  55 #include "hisax_cfg.h"
  56
  57 MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Sedlbauer cards");
  58 MODULE_AUTHOR("Marcus Niemann");
  59 MODULE_LICENSE("Dual MPL/GPL");
  60
  61 /*
  62    All the PCMCIA modules use PCMCIA_DEBUG to control debugging.  If
  63    you do not define PCMCIA_DEBUG at all, all the debug code will be
  64    left out.  If you compile with PCMCIA_DEBUG=0, the debug code will
  65    be present but disabled -- but it can then be enabled for specific
  66    modules at load time with a 'pc_debug=#' option to insmod.
  67 */
  68
  69 #ifdef PCMCIA_DEBUG
  70 static int pc_debug = PCMCIA_DEBUG;
  71 module_param(pc_debug, int, 0);
  72 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args);
  73 static char *version =
  74 "sedlbauer_cs.c 1.1a 2001/01/28 15:04:04 (M.Niemann)";
  75 #else
  76 #define DEBUG(n, args...)
  77 #endif
  78
  79
  80 /*====================================================================*/
  81
  82 /* Parameters that can be set with 'insmod' */
  83
  84 static int protocol = 2;        /* EURO-ISDN Default */
  85 module_param(protocol, int, 0);
  86
  87 /*====================================================================*/
  88
  89 /*
  90    The event() function is this driver's Card Services event handler.
  91    It will be called by Card Services when an appropriate card status
  92    event is received.  The config() and release() entry points are
  93    used to configure or release a socket, in response to card
  94    insertion and ejection events.  They are invoked from the sedlbauer
  95    event handler.
  96 */
  97
  98 static int sedlbauer_config(struct pcmcia_device *link);
  99 static void sedlbauer_release(struct pcmcia_device *link);
 100
 101 /*
 102    The attach() and detach() entry points are used to create and destroy
 103    "instances" of the driver, where each instance represents everything
 104    needed to manage one actual PCMCIA card.
 105 */
 106
 107 static void sedlbauer_detach(struct pcmcia_device *p_dev);
 108
 109 /*
 110    You'll also need to prototype all the functions that will actually
 111    be used to talk to your device.  See 'memory_cs' for a good example
 112    of a fully self-sufficient driver; the other drivers rely more or
 113    less on other parts of the kernel.
 114 */
 115
 116 /*
 117    A driver needs to provide a dev_node_t structure for each device
 118    on a card.  In some cases, there is only one device per card (for
 119    example, ethernet cards, modems).  In other cases, there may be
 120    many actual or logical devices (SCSI adapters, memory cards with
 121    multiple partitions).  The dev_node_t structures need to be kept
 122    in a linked list starting at the 'dev' field of a struct pcmcia_device
 123    structure.  We allocate them in the card's private data structure,
 124    because they generally shouldn't be allocated dynamically.
 125
 126    In this case, we also provide a flag to indicate if a device is
 127    "stopped" due to a power management event, or card ejection.  The
 128    device IO routines can use a flag like this to throttle IO to a
 129    card that is not ready to accept it.
 130 */
 131
 132 typedef struct local_info_t {
 133         struct pcmcia_device    *p_dev;
 134     dev_node_t          node;
 135     int                 stop;
 136     int                 cardnr;
 137 } local_info_t;
 138
 139 /*======================================================================
 140
 141     sedlbauer_attach() creates an "instance" of the driver, allocating
 142     local data structures for one device.  The device is registered
 143     with Card Services.
 144
 145     The dev_link structure is initialized, but we don't actually
 146     configure the card at this point -- we wait until we receive a
 147     card insertion event.
 148
 149 ======================================================================*/
 150
 151 static int sedlbauer_probe(struct pcmcia_device *link)
 152 {
 153     local_info_t *local;
 154
 155     DEBUG(0, "sedlbauer_attach()\n");
 156
 157     /* Allocate space for private device-specific data */
 158     local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
 159     if (!local) return -ENOMEM;
 160     local->cardnr = -1;
 161
 162     local->p_dev = link;
 163     link->priv = local;
 164
 165     /* Interrupt setup */
 166     link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED;
 167     link->irq.IRQInfo1 = IRQ_LEVEL_ID;
 168     link->irq.Handler = NULL;
 169
 170     /*
 171       General socket configuration defaults can go here.  In this
 172       client, we assume very little, and rely on the CIS for almost
 173       everything.  In most clients, many details (i.e., number, sizes,
 174       and attributes of IO windows) are fixed by the nature of the
 175       device, and can be hard-wired here.
 176     */
 177
 178     /* from old sedl_cs
 179     */
 180     /* The io structure describes IO port mapping */
 181     link->io.NumPorts1 = 8;
 182     link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 183     link->io.IOAddrLines = 3;
 184
 185     link->conf.Attributes = 0;
 186     link->conf.IntType = INT_MEMORY_AND_IO;
 187
 188     return sedlbauer_config(link);
 189 } /* sedlbauer_attach */
 190
 191 /*======================================================================
 192
 193     This deletes a driver "instance".  The device is de-registered
 194     with Card Services.  If it has been released, all local data
 195     structures are freed.  Otherwise, the structures will be freed
 196     when the device is released.
 197
 198 ======================================================================*/
 199
 200 static void sedlbauer_detach(struct pcmcia_device *link)
 201 {
 202         DEBUG(0, "sedlbauer_detach(0x%p)\n", link);
 203
 204         ((local_info_t *)link->priv)->stop = 1;
 205         sedlbauer_release(link);
 206
 207         /* This points to the parent local_info_t struct */
 208         kfree(link->priv);
 209 } /* sedlbauer_detach */
 210
 211 /*======================================================================
 212
 213     sedlbauer_config() is scheduled to run after a CARD_INSERTION event
 214     is received, to configure the PCMCIA socket, and to make the
 215     device available to the system.
 216
 217 ======================================================================*/
 218 #define CS_CHECK(fn, ret) \
 219 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
 220
 221 static int sedlbauer_config(struct pcmcia_device *link)
 222 {
 223     local_info_t *dev = link->priv;
 224     tuple_t tuple;
 225     cisparse_t parse;
 226     int last_fn, last_ret;
 227     u8 buf[64];
 228     config_info_t conf;
 229     win_req_t req;
 230     memreq_t map;
 231     IsdnCard_t  icard;
 232
 233     DEBUG(0, "sedlbauer_config(0x%p)\n", link);
 234
 235     tuple.Attributes = 0;
 236     tuple.TupleData = buf;
 237     tuple.TupleDataMax = sizeof(buf);
 238     tuple.TupleOffset = 0;
 239
 240     CS_CHECK(GetConfigurationInfo, pcmcia_get_configuration_info(link, &conf));
 241
 242     /*
 243       In this loop, we scan the CIS for configuration table entries,
 244       each of which describes a valid card configuration, including
 245       voltage, IO window, memory window, and interrupt settings.
 246
 247       We make no assumptions about the card to be configured: we use
 248       just the information available in the CIS.  In an ideal world,
 249       this would work for any PCMCIA card, but it requires a complete
 250       and accurate CIS.  In practice, a driver usually "knows" most of
 251       these things without consulting the CIS, and most client drivers
 252       will only use the CIS to fill in implementation-defined details.
 253     */
 254     tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
 255     CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
 256     while (1) {
 257         cistpl_cftable_entry_t dflt = { 0 };
 258         cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
 259         if (pcmcia_get_tuple_data(link, &tuple) != 0 ||
 260                 pcmcia_parse_tuple(link, &tuple, &parse) != 0)
 261             goto next_entry;
 262
 263         if (cfg->flags & CISTPL_CFTABLE_DEFAULT) dflt = *cfg;
 264         if (cfg->index == 0) goto next_entry;
 265         link->conf.ConfigIndex = cfg->index;
 266
 267         /* Does this card need audio output? */
 268         if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
 269             link->conf.Attributes |= CONF_ENABLE_SPKR;
 270             link->conf.Status = CCSR_AUDIO_ENA;
 271         }
 272
 273         /* Use power settings for Vcc and Vpp if present */
 274         /*  Note that the CIS values need to be rescaled */
 275         if (cfg->vcc.present & (1<<CISTPL_POWER_VNOM)) {
 276             if (conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM]/10000)
 277                 goto next_entry;
 278         } else if (dflt.vcc.present & (1<<CISTPL_POWER_VNOM)) {
 279             if (conf.Vcc != dflt.vcc.param[CISTPL_POWER_VNOM]/10000)
 280                 goto next_entry;
 281         }
 282
 283         if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
 284             link->conf.Vpp =
 285                 cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
 286         else if (dflt.vpp1.present & (1<<CISTPL_POWER_VNOM))
 287             link->conf.Vpp =
 288                 dflt.vpp1.param[CISTPL_POWER_VNOM]/10000;
 289
 290         /* Do we need to allocate an interrupt? */
 291         if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
 292             link->conf.Attributes |= CONF_ENABLE_IRQ;
 293
 294         /* IO window settings */
 295         link->io.NumPorts1 = link->io.NumPorts2 = 0;
 296         if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
 297             cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
 298             link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 299             if (!(io->flags & CISTPL_IO_8BIT))
 300                 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
 301             if (!(io->flags & CISTPL_IO_16BIT))
 302                 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 303 /* new in dummy.cs 2001/01/28 MN
 304             link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
 305 */
 306             link->io.BasePort1 = io->win[0].base;
 307             link->io.NumPorts1 = io->win[0].len;
 308             if (io->nwin > 1) {
 309                 link->io.Attributes2 = link->io.Attributes1;
 310                 link->io.BasePort2 = io->win[1].base;
 311                 link->io.NumPorts2 = io->win[1].len;
 312             }
 313             /* This reserves IO space but doesn't actually enable it */
 314             if (pcmcia_request_io(link, &link->io) != 0)
 315                 goto next_entry;
 316         }
 317
 318         /*
 319           Now set up a common memory window, if needed.  There is room
 320           in the struct pcmcia_device structure for one memory window handle,
 321           but if the base addresses need to be saved, or if multiple
 322           windows are needed, the info should go in the private data
 323           structure for this device.
 324
 325           Note that the memory window base is a physical address, and
 326           needs to be mapped to virtual space with ioremap() before it
 327           is used.
 328         */
 329         if ((cfg->mem.nwin > 0) || (dflt.mem.nwin > 0)) {
 330             cistpl_mem_t *mem =
 331                 (cfg->mem.nwin) ? &cfg->mem : &dflt.mem;
 332             req.Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM;
 333             req.Attributes |= WIN_ENABLE;
 334             req.Base = mem->win[0].host_addr;
 335             req.Size = mem->win[0].len;
 336 /* new in dummy.cs 2001/01/28 MN
 337             if (req.Size < 0x1000)
 338                 req.Size = 0x1000;
 339 */
 340             req.AccessSpeed = 0;
 341             if (pcmcia_request_window(&link, &req, &link->win) != 0)
 342                 goto next_entry;
 343             map.Page = 0; map.CardOffset = mem->win[0].card_addr;
 344             if (pcmcia_map_mem_page(link->win, &map) != 0)
 345                 goto next_entry;
 346         }
 347         /* If we got this far, we're cool! */
 348         break;
 349
 350     next_entry:
 351         CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(link, &tuple));
 352     }
 353
 354     /*
 355        Allocate an interrupt line.  Note that this does not assign a
 356        handler to the interrupt, unless the 'Handler' member of the
 357        irq structure is initialized.
 358     */
 359     if (link->conf.Attributes & CONF_ENABLE_IRQ)
 360         CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));
 361
 362     /*
 363        This actually configures the PCMCIA socket -- setting up
 364        the I/O windows and the interrupt mapping, and putting the
 365        card and host interface into "Memory and IO" mode.
 366     */
 367     CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link, &link->conf));
 368
 369     /*
 370       At this point, the dev_node_t structure(s) need to be
 371       initialized and arranged in a linked list at link->dev.
 372     */
 373     sprintf(dev->node.dev_name, "sedlbauer");
 374     dev->node.major = dev->node.minor = 0;
 375     link->dev_node = &dev->node;
 376
 377     /* Finally, report what we've done */
 378     printk(KERN_INFO "%s: index 0x%02x:",
 379            dev->node.dev_name, link->conf.ConfigIndex);
 380     if (link->conf.Vpp)
 381         printk(", Vpp %d.%d", link->conf.Vpp/10, link->conf.Vpp%10);
 382     if (link->conf.Attributes & CONF_ENABLE_IRQ)
 383         printk(", irq %d", link->irq.AssignedIRQ);
 384     if (link->io.NumPorts1)
 385         printk(", io 0x%04x-0x%04x", link->io.BasePort1,
 386                link->io.BasePort1+link->io.NumPorts1-1);
 387     if (link->io.NumPorts2)
 388         printk(" & 0x%04x-0x%04x", link->io.BasePort2,
 389                link->io.BasePort2+link->io.NumPorts2-1);
 390     if (link->win)
 391         printk(", mem 0x%06lx-0x%06lx", req.Base,
 392                req.Base+req.Size-1);
 393     printk("\n");
 394
 395     icard.para[0] = link->irq.AssignedIRQ;
 396     icard.para[1] = link->io.BasePort1;
 397     icard.protocol = protocol;
 398     icard.typ = ISDN_CTYPE_SEDLBAUER_PCMCIA;
 399
 400     last_ret = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->stop), &icard);
 401     if (last_ret < 0) {
 402         printk(KERN_ERR "sedlbauer_cs: failed to initialize SEDLBAUER PCMCIA %d at i/o %#x\n",
 403                 last_ret, link->io.BasePort1);
 404         sedlbauer_release(link);
 405         return -ENODEV;
 406     } else
 407         ((local_info_t*)link->priv)->cardnr = last_ret;
 408
 409     return 0;
 410
 411 cs_failed:
 412     cs_error(link, last_fn, last_ret);
 413     sedlbauer_release(link);
 414     return -ENODEV;
 415
 416 } /* sedlbauer_config */
 417
 418 /*======================================================================
 419
 420     After a card is removed, sedlbauer_release() will unregister the
 421     device, and release the PCMCIA configuration.  If the device is
 422     still open, this will be postponed until it is closed.
 423
 424 ======================================================================*/
 425
 426 static void sedlbauer_release(struct pcmcia_device *link)
 427 {
 428     local_info_t *local = link->priv;
 429     DEBUG(0, "sedlbauer_release(0x%p)\n", link);
 430
 431     if (local) {
 432         if (local->cardnr >= 0) {
 433             /* no unregister function with hisax */
 434             HiSax_closecard(local->cardnr);
 435         }
 436     }
 437
 438     pcmcia_disable_device(link);
 439 } /* sedlbauer_release */
 440
 441 static int sedlbauer_suspend(struct pcmcia_device *link)
 442 {
 443         local_info_t *dev = link->priv;
 444
 445         dev->stop = 1;
 446
 447         return 0;
 448 }
 449
 450 static int sedlbauer_resume(struct pcmcia_device *link)
 451 {
 452         local_info_t *dev = link->priv;
 453
 454         dev->stop = 0;
 455
 456         return 0;
 457 }
 458
 459
 460 static struct pcmcia_device_id sedlbauer_ids[] = {
 461         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "speed star II", "V 3.1", 0x81fb79f5, 0xf3612e1d, 0x6b95c78a),
 462         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D67", 0x81fb79f5, 0xe4e9bc12, 0x397b7e90),
 463         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D98", 0x81fb79f5, 0xe4e9bc12, 0x2e5c7fce),
 464         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (C) 93-94 VK", 0x81fb79f5, 0xe4e9bc12, 0x8db143fe),
 465         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (c) 93-95 VK", 0x81fb79f5, 0xe4e9bc12, 0xb391ab4c),
 466         PCMCIA_DEVICE_PROD_ID12("HST High Soft Tech GmbH", "Saphir II B", 0xd79e0b84, 0x21d083ae),
 467 /*      PCMCIA_DEVICE_PROD_ID1234("SEDLBAUER", 0x81fb79f5), */ /* too generic*/
 468         PCMCIA_DEVICE_NULL
 469 };
 470 MODULE_DEVICE_TABLE(pcmcia, sedlbauer_ids);
 471
 472 static struct pcmcia_driver sedlbauer_driver = {
 473         .owner          = THIS_MODULE,
 474         .drv            = {
 475                 .name   = "sedlbauer_cs",
 476         },
 477         .probe          = sedlbauer_probe,
 478         .remove         = sedlbauer_detach,
 479         .id_table       = sedlbauer_ids,
 480         .suspend        = sedlbauer_suspend,
 481         .resume         = sedlbauer_resume,
 482 };
 483
 484 static int __init init_sedlbauer_cs(void)
 485 {
 486         return pcmcia_register_driver(&sedlbauer_driver);
 487 }
 488
 489 static void __exit exit_sedlbauer_cs(void)
 490 {
 491         pcmcia_unregister_driver(&sedlbauer_driver);
 492 }
 493
 494 module_init(init_sedlbauer_cs);
 495 module_exit(exit_sedlbauer_cs);