drivers/ata/pata_pcmcia.c

   1 /*
   2  *   pata_pcmcia.c - PCMCIA PATA controller driver.
   3  *   Copyright 2005-2006 Red Hat Inc <alan@redhat.com>, all rights reserved.
   4  *   PCMCIA ident update Copyright 2006 Marcin Juszkiewicz
   5  *                                              <openembedded@hrw.one.pl>
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License as published by
   9  *  the Free Software Foundation; either version 2, or (at your option)
  10  *  any later version.
  11  *
  12  *  This program is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License
  18  *  along with this program; see the file COPYING.  If not, write to
  19  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  *   Heavily based upon ide-cs.c
  22  *   The initial developer of the original code is David A. Hinds
  23  *   <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
  24  *   are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
  25  */
  26
  27 #include <linux/kernel.h>
  28 #include <linux/module.h>
  29 #include <linux/init.h>
  30 #include <linux/blkdev.h>
  31 #include <linux/delay.h>
  32 #include <scsi/scsi_host.h>
  33 #include <linux/ata.h>
  34 #include <linux/libata.h>
  35
  36 #include <pcmcia/cs_types.h>
  37 #include <pcmcia/cs.h>
  38 #include <pcmcia/cistpl.h>
  39 #include <pcmcia/ds.h>
  40 #include <pcmcia/cisreg.h>
  41 #include <pcmcia/ciscode.h>
  42
  43
  44 #define DRV_NAME "pata_pcmcia"
  45 #define DRV_VERSION "0.2.9"
  46
  47 /*
  48  *      Private data structure to glue stuff together
  49  */
  50
  51 struct ata_pcmcia_info {
  52         struct pcmcia_device *pdev;
  53         int             ndev;
  54         dev_node_t      node;
  55 };
  56
  57 static struct scsi_host_template pcmcia_sht = {
  58         .module                 = THIS_MODULE,
  59         .name                   = DRV_NAME,
  60         .ioctl                  = ata_scsi_ioctl,
  61         .queuecommand           = ata_scsi_queuecmd,
  62         .can_queue              = ATA_DEF_QUEUE,
  63         .this_id                = ATA_SHT_THIS_ID,
  64         .sg_tablesize           = LIBATA_MAX_PRD,
  65         .max_sectors            = ATA_MAX_SECTORS,
  66         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
  67         .emulated               = ATA_SHT_EMULATED,
  68         .use_clustering         = ATA_SHT_USE_CLUSTERING,
  69         .proc_name              = DRV_NAME,
  70         .dma_boundary           = ATA_DMA_BOUNDARY,
  71         .slave_configure        = ata_scsi_slave_config,
  72         .bios_param             = ata_std_bios_param,
  73 };
  74
  75 static struct ata_port_operations pcmcia_port_ops = {
  76         .port_disable   = ata_port_disable,
  77         .tf_load        = ata_tf_load,
  78         .tf_read        = ata_tf_read,
  79         .check_status   = ata_check_status,
  80         .exec_command   = ata_exec_command,
  81         .dev_select     = ata_std_dev_select,
  82
  83         .freeze         = ata_bmdma_freeze,
  84         .thaw           = ata_bmdma_thaw,
  85         .error_handler  = ata_bmdma_error_handler,
  86         .post_internal_cmd = ata_bmdma_post_internal_cmd,
  87
  88         .qc_prep        = ata_qc_prep,
  89         .qc_issue       = ata_qc_issue_prot,
  90         .eng_timeout    = ata_eng_timeout,
  91         .data_xfer      = ata_pio_data_xfer_noirq,
  92
  93         .irq_handler    = ata_interrupt,
  94         .irq_clear      = ata_bmdma_irq_clear,
  95
  96         .port_start     = ata_port_start,
  97         .port_stop      = ata_port_stop,
  98         .host_stop      = ata_host_stop
  99 };
 100
 101 #define CS_CHECK(fn, ret) \
 102 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
 103
 104 /**
 105  *      pcmcia_init_one         -       attach a PCMCIA interface
 106  *      @pdev: pcmcia device
 107  *
 108  *      Register a PCMCIA IDE interface. Such interfaces are PIO 0 and
 109  *      shared IRQ.
 110  */
 111
 112 static int pcmcia_init_one(struct pcmcia_device *pdev)
 113 {
 114         struct ata_probe_ent ae;
 115         struct ata_pcmcia_info *info;
 116         tuple_t tuple;
 117         struct {
 118                 unsigned short buf[128];
 119                 cisparse_t parse;
 120                 config_info_t conf;
 121                 cistpl_cftable_entry_t dflt;
 122         } *stk = NULL;
 123         cistpl_cftable_entry_t *cfg;
 124         int pass, last_ret = 0, last_fn = 0, is_kme = 0, ret = -ENOMEM;
 125         unsigned long io_base, ctl_base;
 126
 127         info = kzalloc(sizeof(*info), GFP_KERNEL);
 128         if (info == NULL)
 129                 return -ENOMEM;
 130
 131         /* Glue stuff together. FIXME: We may be able to get rid of info with care */
 132         info->pdev = pdev;
 133         pdev->priv = info;
 134
 135         /* Set up attributes in order to probe card and get resources */
 136         pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 137         pdev->io.Attributes2 = IO_DATA_PATH_WIDTH_8;
 138         pdev->io.IOAddrLines = 3;
 139         pdev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
 140         pdev->irq.IRQInfo1 = IRQ_LEVEL_ID;
 141         pdev->conf.Attributes = CONF_ENABLE_IRQ;
 142         pdev->conf.IntType = INT_MEMORY_AND_IO;
 143
 144         /* Allocate resoure probing structures */
 145
 146         stk = kzalloc(sizeof(*stk), GFP_KERNEL);
 147         if (!stk)
 148                 goto out1;
 149
 150         cfg = &stk->parse.cftable_entry;
 151
 152         /* Tuples we are walking */
 153         tuple.TupleData = (cisdata_t *)&stk->buf;
 154         tuple.TupleOffset = 0;
 155         tuple.TupleDataMax = 255;
 156         tuple.Attributes = 0;
 157         tuple.DesiredTuple = CISTPL_CONFIG;
 158
 159         CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(pdev, &tuple));
 160         CS_CHECK(GetTupleData, pcmcia_get_tuple_data(pdev, &tuple));
 161         CS_CHECK(ParseTuple, pcmcia_parse_tuple(pdev, &tuple, &stk->parse));
 162         pdev->conf.ConfigBase = stk->parse.config.base;
 163         pdev->conf.Present = stk->parse.config.rmask[0];
 164
 165         /* See if we have a manufacturer identifier. Use it to set is_kme for
 166            vendor quirks */
 167         tuple.DesiredTuple = CISTPL_MANFID;
 168         if (!pcmcia_get_first_tuple(pdev, &tuple) && !pcmcia_get_tuple_data(pdev, &tuple) && !pcmcia_parse_tuple(pdev, &tuple, &stk->parse))
 169                         is_kme = ((stk->parse.manfid.manf == MANFID_KME) && ((stk->parse.manfid.card == PRODID_KME_KXLC005_A) || (stk->parse.manfid.card == PRODID_KME_KXLC005_B)));
 170
 171         /* Not sure if this is right... look up the current Vcc */
 172         CS_CHECK(GetConfigurationInfo, pcmcia_get_configuration_info(pdev, &stk->conf));
 173 /*      link->conf.Vcc = stk->conf.Vcc; */
 174
 175         pass = io_base = ctl_base = 0;
 176         tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
 177         tuple.Attributes = 0;
 178         CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(pdev, &tuple));
 179
 180         /* Now munch the resources looking for a suitable set */
 181         while (1) {
 182                 if (pcmcia_get_tuple_data(pdev, &tuple) != 0)
 183                         goto next_entry;
 184                 if (pcmcia_parse_tuple(pdev, &tuple, &stk->parse) != 0)
 185                         goto next_entry;
 186                 /* Check for matching Vcc, unless we're desperate */
 187                 if (!pass) {
 188                         if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
 189                                 if (stk->conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000)
 190                                         goto next_entry;
 191                         } else if (stk->dflt.vcc.present & (1 << CISTPL_POWER_VNOM)) {
 192                                 if (stk->conf.Vcc != stk->dflt.vcc.param[CISTPL_POWER_VNOM] / 10000)
 193                                         goto next_entry;
 194                         }
 195                 }
 196
 197                 if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
 198                         pdev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
 199                 else if (stk->dflt.vpp1.present & (1 << CISTPL_POWER_VNOM))
 200                         pdev->conf.Vpp = stk->dflt.vpp1.param[CISTPL_POWER_VNOM] / 10000;
 201
 202                 if ((cfg->io.nwin > 0) || (stk->dflt.io.nwin > 0)) {
 203                         cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &stk->dflt.io;
 204                         pdev->conf.ConfigIndex = cfg->index;
 205                         pdev->io.BasePort1 = io->win[0].base;
 206                         pdev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
 207                         if (!(io->flags & CISTPL_IO_16BIT))
 208                                 pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 209                         if (io->nwin == 2) {
 210                                 pdev->io.NumPorts1 = 8;
 211                                 pdev->io.BasePort2 = io->win[1].base;
 212                                 pdev->io.NumPorts2 = (is_kme) ? 2 : 1;
 213                                 if (pcmcia_request_io(pdev, &pdev->io) != 0)
 214                                         goto next_entry;
 215                                 io_base = pdev->io.BasePort1;
 216                                 ctl_base = pdev->io.BasePort2;
 217                         } else if ((io->nwin == 1) && (io->win[0].len >= 16)) {
 218                                 pdev->io.NumPorts1 = io->win[0].len;
 219                                 pdev->io.NumPorts2 = 0;
 220                                 if (pcmcia_request_io(pdev, &pdev->io) != 0)
 221                                         goto next_entry;
 222                                 io_base = pdev->io.BasePort1;
 223                                 ctl_base = pdev->io.BasePort1 + 0x0e;
 224                         } else goto next_entry;
 225                         /* If we've got this far, we're done */
 226                         break;
 227                 }
 228 next_entry:
 229                 if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
 230                         memcpy(&stk->dflt, cfg, sizeof(stk->dflt));
 231                 if (pass) {
 232                         CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(pdev, &tuple));
 233                 } else if (pcmcia_get_next_tuple(pdev, &tuple) != 0) {
 234                         CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(pdev, &tuple));
 235                         memset(&stk->dflt, 0, sizeof(stk->dflt));
 236                         pass++;
 237                 }
 238         }
 239
 240         CS_CHECK(RequestIRQ, pcmcia_request_irq(pdev, &pdev->irq));
 241         CS_CHECK(RequestConfiguration, pcmcia_request_configuration(pdev, &pdev->conf));
 242
 243         /* Success. Disable the IRQ nIEN line, do quirks */
 244         outb(0x02, ctl_base);
 245         if (is_kme)
 246                 outb(0x81, ctl_base + 0x01);
 247
 248         /* FIXME: Could be more ports at base + 0x10 but we only deal with
 249            one right now */
 250         if (pdev->io.NumPorts1 >= 0x20)
 251                 printk(KERN_WARNING DRV_NAME ": second channel not yet supported.\n");
 252
 253         /*
 254          *      Having done the PCMCIA plumbing the ATA side is relatively
 255          *      sane.
 256          */
 257
 258         memset(&ae, 0, sizeof(struct ata_probe_ent));
 259         INIT_LIST_HEAD(&ae.node);
 260         ae.dev = &pdev->dev;
 261         ae.port_ops = &pcmcia_port_ops;
 262         ae.sht = &pcmcia_sht;
 263         ae.n_ports = 1;
 264         ae.pio_mask = 1;                /* ISA so PIO 0 cycles */
 265         ae.irq = pdev->irq.AssignedIRQ;
 266         ae.irq_flags = SA_SHIRQ;
 267         ae.port_flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST;
 268         ae.port[0].cmd_addr = io_base;
 269         ae.port[0].altstatus_addr = ctl_base;
 270         ae.port[0].ctl_addr = ctl_base;
 271         ata_std_ports(&ae.port[0]);
 272
 273         if (ata_device_add(&ae) == 0)
 274                 goto failed;
 275
 276         info->ndev = 1;
 277         kfree(stk);
 278         return 0;
 279
 280 cs_failed:
 281         cs_error(pdev, last_fn, last_ret);
 282 failed:
 283         kfree(stk);
 284         info->ndev = 0;
 285         pcmcia_disable_device(pdev);
 286 out1:
 287         kfree(info);
 288         return ret;
 289 }
 290
 291 /**
 292  *      pcmcia_remove_one       -       unplug an pcmcia interface
 293  *      @pdev: pcmcia device
 294  *
 295  *      A PCMCIA ATA device has been unplugged. Perform the needed
 296  *      cleanup. Also called on module unload for any active devices.
 297  */
 298
 299 static void pcmcia_remove_one(struct pcmcia_device *pdev)
 300 {
 301         struct ata_pcmcia_info *info = pdev->priv;
 302         struct device *dev = &pdev->dev;
 303
 304         if (info != NULL) {
 305                 /* If we have attached the device to the ATA layer, detach it */
 306                 if (info->ndev) {
 307                         struct ata_host *host = dev_get_drvdata(dev);
 308                         ata_host_remove(host);
 309                         dev_set_drvdata(dev, NULL);
 310                 }
 311                 info->ndev = 0;
 312                 pdev->priv = NULL;
 313         }
 314         pcmcia_disable_device(pdev);
 315         kfree(info);
 316 }
 317
 318 static struct pcmcia_device_id pcmcia_devices[] = {
 319         PCMCIA_DEVICE_FUNC_ID(4),
 320         PCMCIA_DEVICE_MANF_CARD(0x0007, 0x0000),        /* Hitachi */
 321         PCMCIA_DEVICE_MANF_CARD(0x0032, 0x0704),
 322         PCMCIA_DEVICE_MANF_CARD(0x0045, 0x0401),
 323         PCMCIA_DEVICE_MANF_CARD(0x0098, 0x0000),        /* Toshiba */
 324         PCMCIA_DEVICE_MANF_CARD(0x00a4, 0x002d),
 325         PCMCIA_DEVICE_MANF_CARD(0x00ce, 0x0000),        /* Samsung */
 326         PCMCIA_DEVICE_MANF_CARD(0x0319, 0x0000),        /* Hitachi */
 327         PCMCIA_DEVICE_MANF_CARD(0x2080, 0x0001),
 328         PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0200),        /* Lexar */
 329         PCMCIA_DEVICE_PROD_ID123("Caravelle", "PSC-IDE ", "PSC000", 0x8c36137c, 0xd0693ab8, 0x2768a9f0),
 330         PCMCIA_DEVICE_PROD_ID123("CDROM", "IDE", "MCD-601p", 0x1b9179ca, 0xede88951, 0x0d902f74),
 331         PCMCIA_DEVICE_PROD_ID123("PCMCIA", "IDE CARD", "F1", 0x281f1c5d, 0x1907960c, 0xf7fde8b9),
 332         PCMCIA_DEVICE_PROD_ID12("ARGOSY", "CD-ROM", 0x78f308dc, 0x66536591),
 333         PCMCIA_DEVICE_PROD_ID12("ARGOSY", "PnPIDE", 0x78f308dc, 0x0c694728),
 334         PCMCIA_DEVICE_PROD_ID12("CNF CD-M", "CD-ROM", 0x7d93b852, 0x66536591),
 335         PCMCIA_DEVICE_PROD_ID12("Creative Technology Ltd.", "PCMCIA CD-ROM Interface Card", 0xff8c8a45, 0xfe8020c4),
 336         PCMCIA_DEVICE_PROD_ID12("Digital Equipment Corporation.", "Digital Mobile Media CD-ROM", 0x17692a66, 0xef1dcbde),
 337         PCMCIA_DEVICE_PROD_ID12("EXP", "CD+GAME", 0x6f58c983, 0x63c13aaf),
 338         PCMCIA_DEVICE_PROD_ID12("EXP   ", "CD-ROM", 0x0a5c52fd, 0x66536591),
 339         PCMCIA_DEVICE_PROD_ID12("EXP   ", "PnPIDE", 0x0a5c52fd, 0x0c694728),
 340         PCMCIA_DEVICE_PROD_ID12("FREECOM", "PCCARD-IDE", 0x5714cbf7, 0x48e0ab8e),
 341         PCMCIA_DEVICE_PROD_ID12("HITACHI", "FLASH", 0xf4f43949, 0x9eb86aae),
 342         PCMCIA_DEVICE_PROD_ID12("HITACHI", "microdrive", 0xf4f43949, 0xa6d76178),
 343         PCMCIA_DEVICE_PROD_ID12("IBM", "microdrive", 0xb569a6e5, 0xa6d76178),
 344         PCMCIA_DEVICE_PROD_ID12("IBM", "IBM17JSSFP20", 0xb569a6e5, 0xf2508753),
 345         PCMCIA_DEVICE_PROD_ID12("IO DATA", "CBIDE2      ", 0x547e66dc, 0x8671043b),
 346         PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDE", 0x547e66dc, 0x5c5ab149),
 347         PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDEII", 0x547e66dc, 0xb3662674),
 348         PCMCIA_DEVICE_PROD_ID12("LOOKMEET", "CBIDE2      ", 0xe37be2b5, 0x8671043b),
 349         PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF500", 0x7ed2ad87, 0x7a13045c),
 350         PCMCIA_DEVICE_PROD_ID2("NinjaATA-", 0xebe0bd79),
 351         PCMCIA_DEVICE_PROD_ID12("PCMCIA", "CD-ROM", 0x281f1c5d, 0x66536591),
 352         PCMCIA_DEVICE_PROD_ID12("PCMCIA", "PnPIDE", 0x281f1c5d, 0x0c694728),
 353         PCMCIA_DEVICE_PROD_ID12("SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", 0x4a3f0ba0, 0x322560e1),
 354         PCMCIA_DEVICE_PROD_ID12("SEAGATE", "ST1", 0x87c1b330, 0xe1f30883),
 355         PCMCIA_DEVICE_PROD_ID12("SAMSUNG", "04/05/06", 0x43d74cb4, 0x6a22777d),
 356         PCMCIA_DEVICE_PROD_ID12("SMI VENDOR", "SMI PRODUCT", 0x30896c92, 0x703cc5f6),
 357         PCMCIA_DEVICE_PROD_ID12("TOSHIBA", "MK2001MPL", 0xb4585a1a, 0x3489e003),
 358         PCMCIA_DEVICE_PROD_ID12("WIT", "IDE16", 0x244e5994, 0x3e232852),
 359         PCMCIA_DEVICE_PROD_ID1("STI Flash", 0xe4a13209),
 360         PCMCIA_DEVICE_PROD_ID12("STI", "Flash 5.0", 0xbf2df18d, 0x8cb57a0e),
 361         PCMCIA_MFC_DEVICE_PROD_ID12(1, "SanDisk", "ConnectPlus", 0x7a954bd9, 0x74be00c6),
 362         PCMCIA_DEVICE_NULL,
 363 };
 364
 365 MODULE_DEVICE_TABLE(pcmcia, pcmcia_devices);
 366
 367 static struct pcmcia_driver pcmcia_driver = {
 368         .owner          = THIS_MODULE,
 369         .drv = {
 370                 .name           = DRV_NAME,
 371         },
 372         .id_table       = pcmcia_devices,
 373         .probe          = pcmcia_init_one,
 374         .remove         = pcmcia_remove_one,
 375 };
 376
 377 static int __init pcmcia_init(void)
 378 {
 379         return pcmcia_register_driver(&pcmcia_driver);
 380 }
 381
 382 static void __exit pcmcia_exit(void)
 383 {
 384         pcmcia_unregister_driver(&pcmcia_driver);
 385 }
 386
 387 MODULE_AUTHOR("Alan Cox");
 388 MODULE_DESCRIPTION("low-level driver for PCMCIA ATA");
 389 MODULE_LICENSE("GPL");
 390 MODULE_VERSION(DRV_VERSION);
 391
 392 module_init(pcmcia_init);
 393 module_exit(pcmcia_exit);