drivers/ide/legacy/ide-cs.c

   1 /*======================================================================
   2
   3     A driver for PCMCIA IDE/ATA disk cards
   4
   5     ide-cs.c 1.3 2002/10/26 05:45:31
   6
   7     The contents of this file are subject to the Mozilla Public
   8     License Version 1.1 (the "License"); you may not use this file
   9     except in compliance with the License. You may obtain a copy of
  10     the License at http://www.mozilla.org/MPL/
  11
  12     Software distributed under the License is distributed on an "AS
  13     IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  14     implied. See the License for the specific language governing
  15     rights and limitations under the License.
  16
  17     The initial developer of the original code is David A. Hinds
  18     <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
  19     are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
  20
  21     Alternatively, the contents of this file may be used under the
  22     terms of the GNU General Public License version 2 (the "GPL"), in
  23     which case the provisions of the GPL are applicable instead of the
  24     above.  If you wish to allow the use of your version of this file
  25     only under the terms of the GPL and not to allow others to use
  26     your version of this file under the MPL, indicate your decision
  27     by deleting the provisions above and replace them with the notice
  28     and other provisions required by the GPL.  If you do not delete
  29     the provisions above, a recipient may use your version of this
  30     file under either the MPL or the GPL.
  31
  32 ======================================================================*/
  33
  34 #include <linux/module.h>
  35 #include <linux/kernel.h>
  36 #include <linux/init.h>
  37 #include <linux/sched.h>
  38 #include <linux/ptrace.h>
  39 #include <linux/slab.h>
  40 #include <linux/string.h>
  41 #include <linux/timer.h>
  42 #include <linux/ioport.h>
  43 #include <linux/ide.h>
  44 #include <linux/hdreg.h>
  45 #include <linux/major.h>
  46 #include <linux/delay.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/ds.h>
  54 #include <pcmcia/cisreg.h>
  55 #include <pcmcia/ciscode.h>
  56
  57 /*====================================================================*/
  58
  59 /* Module parameters */
  60
  61 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
  62 MODULE_DESCRIPTION("PCMCIA ATA/IDE card driver");
  63 MODULE_LICENSE("Dual MPL/GPL");
  64
  65 #define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0)
  66
  67 #ifdef PCMCIA_DEBUG
  68 INT_MODULE_PARM(pc_debug, PCMCIA_DEBUG);
  69 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)
  70 static char *version =
  71 "ide-cs.c 1.3 2002/10/26 05:45:31 (David Hinds)";
  72 #else
  73 #define DEBUG(n, args...)
  74 #endif
  75
  76 /*====================================================================*/
  77
  78 static const char ide_major[] = {
  79     IDE0_MAJOR, IDE1_MAJOR, IDE2_MAJOR, IDE3_MAJOR,
  80     IDE4_MAJOR, IDE5_MAJOR
  81 };
  82
  83 typedef struct ide_info_t {
  84         struct pcmcia_device    *p_dev;
  85     int         ndev;
  86     dev_node_t  node;
  87     int         hd;
  88 } ide_info_t;
  89
  90 static void ide_release(struct pcmcia_device *);
  91 static int ide_config(struct pcmcia_device *);
  92
  93 static void ide_detach(struct pcmcia_device *p_dev);
  94
  95
  96
  97
  98 /*======================================================================
  99
 100     ide_attach() creates an "instance" of the driver, allocating
 101     local data structures for one device.  The device is registered
 102     with Card Services.
 103
 104 ======================================================================*/
 105
 106 static int ide_probe(struct pcmcia_device *link)
 107 {
 108     ide_info_t *info;
 109
 110     DEBUG(0, "ide_attach()\n");
 111
 112     /* Create new ide device */
 113     info = kzalloc(sizeof(*info), GFP_KERNEL);
 114     if (!info)
 115         return -ENOMEM;
 116
 117     info->p_dev = link;
 118     link->priv = info;
 119
 120     link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 121     link->io.Attributes2 = IO_DATA_PATH_WIDTH_8;
 122     link->io.IOAddrLines = 3;
 123     link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
 124     link->irq.IRQInfo1 = IRQ_LEVEL_ID;
 125     link->conf.Attributes = CONF_ENABLE_IRQ;
 126     link->conf.IntType = INT_MEMORY_AND_IO;
 127
 128     return ide_config(link);
 129 } /* ide_attach */
 130
 131 /*======================================================================
 132
 133     This deletes a driver "instance".  The device is de-registered
 134     with Card Services.  If it has been released, all local data
 135     structures are freed.  Otherwise, the structures will be freed
 136     when the device is released.
 137
 138 ======================================================================*/
 139
 140 static void ide_detach(struct pcmcia_device *link)
 141 {
 142     DEBUG(0, "ide_detach(0x%p)\n", link);
 143
 144     ide_release(link);
 145
 146     kfree(link->priv);
 147 } /* ide_detach */
 148
 149 static int idecs_register(unsigned long io, unsigned long ctl, unsigned long irq, struct pcmcia_device *handle)
 150 {
 151     hw_regs_t hw;
 152     memset(&hw, 0, sizeof(hw));
 153     ide_init_hwif_ports(&hw, io, ctl, NULL);
 154     hw.irq = irq;
 155     hw.chipset = ide_pci;
 156     hw.dev = &handle->dev;
 157     return ide_register_hw_with_fixup(&hw, NULL, ide_undecoded_slave);
 158 }
 159
 160 /*======================================================================
 161
 162     ide_config() is scheduled to run after a CARD_INSERTION event
 163     is received, to configure the PCMCIA socket, and to make the
 164     ide device available to the system.
 165
 166 ======================================================================*/
 167
 168 #define CS_CHECK(fn, ret) \
 169 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
 170
 171 static int ide_config(struct pcmcia_device *link)
 172 {
 173     ide_info_t *info = link->priv;
 174     tuple_t tuple;
 175     struct {
 176         u_short         buf[128];
 177         cisparse_t      parse;
 178         config_info_t   conf;
 179         cistpl_cftable_entry_t dflt;
 180     } *stk = NULL;
 181     cistpl_cftable_entry_t *cfg;
 182     int i, pass, last_ret = 0, last_fn = 0, hd, is_kme = 0;
 183     unsigned long io_base, ctl_base;
 184
 185     DEBUG(0, "ide_config(0x%p)\n", link);
 186
 187     stk = kzalloc(sizeof(*stk), GFP_KERNEL);
 188     if (!stk) goto err_mem;
 189     cfg = &stk->parse.cftable_entry;
 190
 191     tuple.TupleData = (cisdata_t *)&stk->buf;
 192     tuple.TupleOffset = 0;
 193     tuple.TupleDataMax = 255;
 194     tuple.Attributes = 0;
 195     tuple.DesiredTuple = CISTPL_CONFIG;
 196     CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
 197     CS_CHECK(GetTupleData, pcmcia_get_tuple_data(link, &tuple));
 198     CS_CHECK(ParseTuple, pcmcia_parse_tuple(link, &tuple, &stk->parse));
 199     link->conf.ConfigBase = stk->parse.config.base;
 200     link->conf.Present = stk->parse.config.rmask[0];
 201
 202     is_kme = ((link->manf_id == MANFID_KME) &&
 203               ((link->card_id == PRODID_KME_KXLC005_A) ||
 204                (link->card_id == PRODID_KME_KXLC005_B)));
 205
 206     /* Not sure if this is right... look up the current Vcc */
 207     CS_CHECK(GetConfigurationInfo, pcmcia_get_configuration_info(link, &stk->conf));
 208
 209     pass = io_base = ctl_base = 0;
 210     tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
 211     tuple.Attributes = 0;
 212     CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
 213     while (1) {
 214         if (pcmcia_get_tuple_data(link, &tuple) != 0) goto next_entry;
 215         if (pcmcia_parse_tuple(link, &tuple, &stk->parse) != 0) goto next_entry;
 216
 217         /* Check for matching Vcc, unless we're desperate */
 218         if (!pass) {
 219             if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
 220                 if (stk->conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000)
 221                     goto next_entry;
 222             } else if (stk->dflt.vcc.present & (1 << CISTPL_POWER_VNOM)) {
 223                 if (stk->conf.Vcc != stk->dflt.vcc.param[CISTPL_POWER_VNOM] / 10000)
 224                     goto next_entry;
 225             }
 226         }
 227
 228         if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
 229             link->conf.Vpp =
 230                 cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
 231         else if (stk->dflt.vpp1.present & (1 << CISTPL_POWER_VNOM))
 232             link->conf.Vpp =
 233                 stk->dflt.vpp1.param[CISTPL_POWER_VNOM] / 10000;
 234
 235         if ((cfg->io.nwin > 0) || (stk->dflt.io.nwin > 0)) {
 236             cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &stk->dflt.io;
 237             link->conf.ConfigIndex = cfg->index;
 238             link->io.BasePort1 = io->win[0].base;
 239             link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
 240             if (!(io->flags & CISTPL_IO_16BIT))
 241                 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 242             if (io->nwin == 2) {
 243                 link->io.NumPorts1 = 8;
 244                 link->io.BasePort2 = io->win[1].base;
 245                 link->io.NumPorts2 = (is_kme) ? 2 : 1;
 246                 if (pcmcia_request_io(link, &link->io) != 0)
 247                         goto next_entry;
 248                 io_base = link->io.BasePort1;
 249                 ctl_base = link->io.BasePort2;
 250             } else if ((io->nwin == 1) && (io->win[0].len >= 16)) {
 251                 link->io.NumPorts1 = io->win[0].len;
 252                 link->io.NumPorts2 = 0;
 253                 if (pcmcia_request_io(link, &link->io) != 0)
 254                         goto next_entry;
 255                 io_base = link->io.BasePort1;
 256                 ctl_base = link->io.BasePort1 + 0x0e;
 257             } else goto next_entry;
 258             /* If we've got this far, we're done */
 259             break;
 260         }
 261
 262     next_entry:
 263         if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
 264             memcpy(&stk->dflt, cfg, sizeof(stk->dflt));
 265         if (pass) {
 266             CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(link, &tuple));
 267         } else if (pcmcia_get_next_tuple(link, &tuple) != 0) {
 268             CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
 269             memset(&stk->dflt, 0, sizeof(stk->dflt));
 270             pass++;
 271         }
 272     }
 273
 274     CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));
 275     CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link, &link->conf));
 276
 277     /* disable drive interrupts during IDE probe */
 278     outb(0x02, ctl_base);
 279
 280     /* special setup for KXLC005 card */
 281     if (is_kme)
 282         outb(0x81, ctl_base+1);
 283
 284     /* retry registration in case device is still spinning up */
 285     for (hd = -1, i = 0; i < 10; i++) {
 286         hd = idecs_register(io_base, ctl_base, link->irq.AssignedIRQ, link);
 287         if (hd >= 0) break;
 288         if (link->io.NumPorts1 == 0x20) {
 289             outb(0x02, ctl_base + 0x10);
 290             hd = idecs_register(io_base + 0x10, ctl_base + 0x10,
 291                                 link->irq.AssignedIRQ, link);
 292             if (hd >= 0) {
 293                 io_base += 0x10;
 294                 ctl_base += 0x10;
 295                 break;
 296             }
 297         }
 298         msleep(100);
 299     }
 300
 301     if (hd < 0) {
 302         printk(KERN_NOTICE "ide-cs: ide_register() at 0x%3lx & 0x%3lx"
 303                ", irq %u failed\n", io_base, ctl_base,
 304                link->irq.AssignedIRQ);
 305         goto failed;
 306     }
 307
 308     info->ndev = 1;
 309     sprintf(info->node.dev_name, "hd%c", 'a' + (hd * 2));
 310     info->node.major = ide_major[hd];
 311     info->node.minor = 0;
 312     info->hd = hd;
 313     link->dev_node = &info->node;
 314     printk(KERN_INFO "ide-cs: %s: Vpp = %d.%d\n",
 315            info->node.dev_name, link->conf.Vpp / 10, link->conf.Vpp % 10);
 316
 317     kfree(stk);
 318     return 0;
 319
 320 err_mem:
 321     printk(KERN_NOTICE "ide-cs: ide_config failed memory allocation\n");
 322     goto failed;
 323
 324 cs_failed:
 325     cs_error(link, last_fn, last_ret);
 326 failed:
 327     kfree(stk);
 328     ide_release(link);
 329     return -ENODEV;
 330 } /* ide_config */
 331
 332 /*======================================================================
 333
 334     After a card is removed, ide_release() will unregister the net
 335     device, and release the PCMCIA configuration.  If the device is
 336     still open, this will be postponed until it is closed.
 337
 338 ======================================================================*/
 339
 340 void ide_release(struct pcmcia_device *link)
 341 {
 342     ide_info_t *info = link->priv;
 343
 344     DEBUG(0, "ide_release(0x%p)\n", link);
 345
 346     if (info->ndev) {
 347         /* FIXME: if this fails we need to queue the cleanup somehow
 348            -- need to investigate the required PCMCIA magic */
 349         ide_unregister(info->hd);
 350     }
 351     info->ndev = 0;
 352
 353     pcmcia_disable_device(link);
 354 } /* ide_release */
 355
 356
 357 /*======================================================================
 358
 359     The card status event handler.  Mostly, this schedules other
 360     stuff to run after an event is received.  A CARD_REMOVAL event
 361     also sets some flags to discourage the ide drivers from
 362     talking to the ports.
 363
 364 ======================================================================*/
 365
 366 static struct pcmcia_device_id ide_ids[] = {
 367         PCMCIA_DEVICE_FUNC_ID(4),
 368         PCMCIA_DEVICE_MANF_CARD(0x0007, 0x0000),        /* Hitachi */
 369         PCMCIA_DEVICE_MANF_CARD(0x0032, 0x0704),
 370         PCMCIA_DEVICE_MANF_CARD(0x0045, 0x0401),
 371         PCMCIA_DEVICE_MANF_CARD(0x0098, 0x0000),        /* Toshiba */
 372         PCMCIA_DEVICE_MANF_CARD(0x00a4, 0x002d),
 373         PCMCIA_DEVICE_MANF_CARD(0x00ce, 0x0000),        /* Samsung */
 374         PCMCIA_DEVICE_MANF_CARD(0x0319, 0x0000),        /* Hitachi */
 375         PCMCIA_DEVICE_MANF_CARD(0x2080, 0x0001),
 376         PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0200),        /* Lexar */
 377         PCMCIA_DEVICE_PROD_ID123("Caravelle", "PSC-IDE ", "PSC000", 0x8c36137c, 0xd0693ab8, 0x2768a9f0),
 378         PCMCIA_DEVICE_PROD_ID123("CDROM", "IDE", "MCD-601p", 0x1b9179ca, 0xede88951, 0x0d902f74),
 379         PCMCIA_DEVICE_PROD_ID123("PCMCIA", "IDE CARD", "F1", 0x281f1c5d, 0x1907960c, 0xf7fde8b9),
 380         PCMCIA_DEVICE_PROD_ID12("ARGOSY", "CD-ROM", 0x78f308dc, 0x66536591),
 381         PCMCIA_DEVICE_PROD_ID12("ARGOSY", "PnPIDE", 0x78f308dc, 0x0c694728),
 382         PCMCIA_DEVICE_PROD_ID12("CNF CD-M", "CD-ROM", 0x7d93b852, 0x66536591),
 383         PCMCIA_DEVICE_PROD_ID12("Creative Technology Ltd.", "PCMCIA CD-ROM Interface Card", 0xff8c8a45, 0xfe8020c4),
 384         PCMCIA_DEVICE_PROD_ID12("Digital Equipment Corporation.", "Digital Mobile Media CD-ROM", 0x17692a66, 0xef1dcbde),
 385         PCMCIA_DEVICE_PROD_ID12("EXP", "CD+GAME", 0x6f58c983, 0x63c13aaf),
 386         PCMCIA_DEVICE_PROD_ID12("EXP   ", "CD-ROM", 0x0a5c52fd, 0x66536591),
 387         PCMCIA_DEVICE_PROD_ID12("EXP   ", "PnPIDE", 0x0a5c52fd, 0x0c694728),
 388         PCMCIA_DEVICE_PROD_ID12("FREECOM", "PCCARD-IDE", 0x5714cbf7, 0x48e0ab8e),
 389         PCMCIA_DEVICE_PROD_ID12("HITACHI", "FLASH", 0xf4f43949, 0x9eb86aae),
 390         PCMCIA_DEVICE_PROD_ID12("HITACHI", "microdrive", 0xf4f43949, 0xa6d76178),
 391         PCMCIA_DEVICE_PROD_ID12("IBM", "microdrive", 0xb569a6e5, 0xa6d76178),
 392         PCMCIA_DEVICE_PROD_ID12("IBM", "IBM17JSSFP20", 0xb569a6e5, 0xf2508753),
 393         PCMCIA_DEVICE_PROD_ID12("IO DATA", "CBIDE2      ", 0x547e66dc, 0x8671043b),
 394         PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDE", 0x547e66dc, 0x5c5ab149),
 395         PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDEII", 0x547e66dc, 0xb3662674),
 396         PCMCIA_DEVICE_PROD_ID12("LOOKMEET", "CBIDE2      ", 0xe37be2b5, 0x8671043b),
 397         PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF500", 0x7ed2ad87, 0x7a13045c),
 398         PCMCIA_DEVICE_PROD_ID2("NinjaATA-", 0xebe0bd79),
 399         PCMCIA_DEVICE_PROD_ID12("PCMCIA", "CD-ROM", 0x281f1c5d, 0x66536591),
 400         PCMCIA_DEVICE_PROD_ID12("PCMCIA", "PnPIDE", 0x281f1c5d, 0x0c694728),
 401         PCMCIA_DEVICE_PROD_ID12("SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", 0x4a3f0ba0, 0x322560e1),
 402         PCMCIA_DEVICE_PROD_ID12("SEAGATE", "ST1", 0x87c1b330, 0xe1f30883),
 403         PCMCIA_DEVICE_PROD_ID12("SAMSUNG", "04/05/06", 0x43d74cb4, 0x6a22777d),
 404         PCMCIA_DEVICE_PROD_ID12("SMI VENDOR", "SMI PRODUCT", 0x30896c92, 0x703cc5f6),
 405         PCMCIA_DEVICE_PROD_ID12("TOSHIBA", "MK2001MPL", 0xb4585a1a, 0x3489e003),
 406         PCMCIA_DEVICE_PROD_ID1("TRANSCEND    512M   ", 0xd0909443),
 407         PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS1GCF80", 0x709b1bf1, 0x2a54d4b1),
 408         PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS4GCF120", 0x709b1bf1, 0xf54a91c8),
 409         PCMCIA_DEVICE_PROD_ID12("WIT", "IDE16", 0x244e5994, 0x3e232852),
 410         PCMCIA_DEVICE_PROD_ID12("WEIDA", "TWTTI", 0xcc7cf69c, 0x212bb918),
 411         PCMCIA_DEVICE_PROD_ID1("STI Flash", 0xe4a13209),
 412         PCMCIA_DEVICE_PROD_ID12("STI", "Flash 5.0", 0xbf2df18d, 0x8cb57a0e),
 413         PCMCIA_MFC_DEVICE_PROD_ID12(1, "SanDisk", "ConnectPlus", 0x7a954bd9, 0x74be00c6),
 414         PCMCIA_DEVICE_NULL,
 415 };
 416 MODULE_DEVICE_TABLE(pcmcia, ide_ids);
 417
 418 static struct pcmcia_driver ide_cs_driver = {
 419         .owner          = THIS_MODULE,
 420         .drv            = {
 421                 .name   = "ide-cs",
 422         },
 423         .probe          = ide_probe,
 424         .remove         = ide_detach,
 425         .id_table       = ide_ids,
 426 };
 427
 428 static int __init init_ide_cs(void)
 429 {
 430         return pcmcia_register_driver(&ide_cs_driver);
 431 }
 432
 433 static void __exit exit_ide_cs(void)
 434 {
 435         pcmcia_unregister_driver(&ide_cs_driver);
 436 }
 437
 438 late_initcall(init_ide_cs);
 439 module_exit(exit_ide_cs);