drivers/ide/legacy/ide-cs.c

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