drivers/ata/pata_pcmcia.c

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  *   pata_pcmcia.c - PCMCIA PATA controller driver.
0004  *   Copyright 2005-2006 Red Hat Inc, all rights reserved.
0005  *   PCMCIA ident update Copyright 2006 Marcin Juszkiewicz
0006  *                      <openembedded@hrw.one.pl>
0007  *
0008  *   Heavily based upon ide-cs.c
0009  *   The initial developer of the original code is David A. Hinds
0010  *   <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
0011  *   are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
0012  */
0013
0014 #include <linux/kernel.h>
0015 #include <linux/module.h>
0016 #include <linux/blkdev.h>
0017 #include <linux/delay.h>
0018 #include <linux/slab.h>
0019 #include <scsi/scsi_host.h>
0020 #include <linux/ata.h>
0021 #include <linux/libata.h>
0022
0023 #include <pcmcia/cistpl.h>
0024 #include <pcmcia/ds.h>
0025 #include <pcmcia/cisreg.h>
0026 #include <pcmcia/ciscode.h>
0027
0028
0029 #define DRV_NAME "pata_pcmcia"
0030 #define DRV_VERSION "0.3.5"
0031
0032 /**
0033  *  pcmcia_set_mode -   PCMCIA specific mode setup
0034  *  @link: link
0035  *  @r_failed_dev: Return pointer for failed device
0036  *
0037  *  Perform the tuning and setup of the devices and timings, which
0038  *  for PCMCIA is the same as any other controller. We wrap it however
0039  *  as we need to spot hardware with incorrect or missing master/slave
0040  *  decode, which alas is embarrassingly common in the PC world
0041  */
0042
0043 static int pcmcia_set_mode(struct ata_link *link, struct ata_device **r_failed_dev)
0044 {
0045     struct ata_device *master = &link->device[0];
0046     struct ata_device *slave = &link->device[1];
0047
0048     if (!ata_dev_enabled(master) || !ata_dev_enabled(slave))
0049         return ata_do_set_mode(link, r_failed_dev);
0050
0051     if (memcmp(master->id + ATA_ID_FW_REV,  slave->id + ATA_ID_FW_REV,
0052                ATA_ID_FW_REV_LEN + ATA_ID_PROD_LEN) == 0) {
0053         /* Suspicious match, but could be two cards from
0054            the same vendor - check serial */
0055         if (memcmp(master->id + ATA_ID_SERNO, slave->id + ATA_ID_SERNO,
0056                ATA_ID_SERNO_LEN) == 0 && master->id[ATA_ID_SERNO] >> 8) {
0057             ata_dev_warn(slave, "is a ghost device, ignoring\n");
0058             ata_dev_disable(slave);
0059         }
0060     }
0061     return ata_do_set_mode(link, r_failed_dev);
0062 }
0063
0064 /**
0065  *  pcmcia_set_mode_8bit    -   PCMCIA specific mode setup
0066  *  @link: link
0067  *  @r_failed_dev: Return pointer for failed device
0068  *
0069  *  For the simple emulated 8bit stuff the less we do the better.
0070  */
0071
0072 static int pcmcia_set_mode_8bit(struct ata_link *link,
0073                 struct ata_device **r_failed_dev)
0074 {
0075     return 0;
0076 }
0077
0078 /**
0079  *  ata_data_xfer_8bit   -  Transfer data by 8bit PIO
0080  *  @qc: queued command
0081  *  @buf: data buffer
0082  *  @buflen: buffer length
0083  *  @rw: read/write
0084  *
0085  *  Transfer data from/to the device data register by 8 bit PIO.
0086  *
0087  *  LOCKING:
0088  *  Inherited from caller.
0089  */
0090
0091 static unsigned int ata_data_xfer_8bit(struct ata_queued_cmd *qc,
0092                 unsigned char *buf, unsigned int buflen, int rw)
0093 {
0094     struct ata_port *ap = qc->dev->link->ap;
0095
0096     if (rw == READ)
0097         ioread8_rep(ap->ioaddr.data_addr, buf, buflen);
0098     else
0099         iowrite8_rep(ap->ioaddr.data_addr, buf, buflen);
0100
0101     return buflen;
0102 }
0103
0104 /**
0105  *  pcmcia_8bit_drain_fifo - Stock FIFO drain logic for SFF controllers
0106  *  @qc: command
0107  *
0108  *  Drain the FIFO and device of any stuck data following a command
0109  *  failing to complete. In some cases this is necessary before a
0110  *  reset will recover the device.
0111  *
0112  */
0113
0114 static void pcmcia_8bit_drain_fifo(struct ata_queued_cmd *qc)
0115 {
0116     int count;
0117     struct ata_port *ap;
0118
0119     /* We only need to flush incoming data when a command was running */
0120     if (qc == NULL || qc->dma_dir == DMA_TO_DEVICE)
0121         return;
0122
0123     ap = qc->ap;
0124
0125     /* Drain up to 64K of data before we give up this recovery method */
0126     for (count = 0; (ap->ops->sff_check_status(ap) & ATA_DRQ)
0127                             && count++ < 65536;)
0128         ioread8(ap->ioaddr.data_addr);
0129
0130     if (count)
0131         ata_port_warn(ap, "drained %d bytes to clear DRQ\n", count);
0132
0133 }
0134
0135 static struct scsi_host_template pcmcia_sht = {
0136     ATA_PIO_SHT(DRV_NAME),
0137 };
0138
0139 static struct ata_port_operations pcmcia_port_ops = {
0140     .inherits   = &ata_sff_port_ops,
0141     .sff_data_xfer  = ata_sff_data_xfer32,
0142     .cable_detect   = ata_cable_40wire,
0143     .set_mode   = pcmcia_set_mode,
0144 };
0145
0146 static struct ata_port_operations pcmcia_8bit_port_ops = {
0147     .inherits   = &ata_sff_port_ops,
0148     .sff_data_xfer  = ata_data_xfer_8bit,
0149     .cable_detect   = ata_cable_40wire,
0150     .set_mode   = pcmcia_set_mode_8bit,
0151     .sff_drain_fifo = pcmcia_8bit_drain_fifo,
0152 };
0153
0154
0155 static int pcmcia_check_one_config(struct pcmcia_device *pdev, void *priv_data)
0156 {
0157     int *is_kme = priv_data;
0158
0159     if ((pdev->resource[0]->flags & IO_DATA_PATH_WIDTH)
0160         != IO_DATA_PATH_WIDTH_8) {
0161         pdev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
0162         pdev->resource[0]->flags |= IO_DATA_PATH_WIDTH_AUTO;
0163     }
0164     pdev->resource[1]->flags &= ~IO_DATA_PATH_WIDTH;
0165     pdev->resource[1]->flags |= IO_DATA_PATH_WIDTH_8;
0166
0167     if (pdev->resource[1]->end) {
0168         pdev->resource[0]->end = 8;
0169         pdev->resource[1]->end = (*is_kme) ? 2 : 1;
0170     } else {
0171         if (pdev->resource[0]->end < 16)
0172             return -ENODEV;
0173     }
0174
0175     return pcmcia_request_io(pdev);
0176 }
0177
0178 /**
0179  *  pcmcia_init_one     -   attach a PCMCIA interface
0180  *  @pdev: pcmcia device
0181  *
0182  *  Register a PCMCIA IDE interface. Such interfaces are PIO 0 and
0183  *  shared IRQ.
0184  */
0185
0186 static int pcmcia_init_one(struct pcmcia_device *pdev)
0187 {
0188     struct ata_host *host;
0189     struct ata_port *ap;
0190     int is_kme = 0, ret = -ENOMEM, p;
0191     unsigned long io_base, ctl_base;
0192     void __iomem *io_addr, *ctl_addr;
0193     int n_ports = 1;
0194     struct ata_port_operations *ops = &pcmcia_port_ops;
0195
0196     /* Set up attributes in order to probe card and get resources */
0197     pdev->config_flags |= CONF_ENABLE_IRQ | CONF_AUTO_SET_IO |
0198         CONF_AUTO_SET_VPP | CONF_AUTO_CHECK_VCC;
0199
0200     /* See if we have a manufacturer identifier. Use it to set is_kme for
0201        vendor quirks */
0202     is_kme = ((pdev->manf_id == MANFID_KME) &&
0203           ((pdev->card_id == PRODID_KME_KXLC005_A) ||
0204            (pdev->card_id == PRODID_KME_KXLC005_B)));
0205
0206     if (pcmcia_loop_config(pdev, pcmcia_check_one_config, &is_kme)) {
0207         pdev->config_flags &= ~CONF_AUTO_CHECK_VCC;
0208         if (pcmcia_loop_config(pdev, pcmcia_check_one_config, &is_kme))
0209             goto failed; /* No suitable config found */
0210     }
0211     io_base = pdev->resource[0]->start;
0212     if (pdev->resource[1]->end)
0213         ctl_base = pdev->resource[1]->start;
0214     else
0215         ctl_base = pdev->resource[0]->start + 0x0e;
0216
0217     if (!pdev->irq)
0218         goto failed;
0219
0220     ret = pcmcia_enable_device(pdev);
0221     if (ret)
0222         goto failed;
0223
0224     /* iomap */
0225     ret = -ENOMEM;
0226     io_addr = devm_ioport_map(&pdev->dev, io_base, 8);
0227     ctl_addr = devm_ioport_map(&pdev->dev, ctl_base, 1);
0228     if (!io_addr || !ctl_addr)
0229         goto failed;
0230
0231     /* Success. Disable the IRQ nIEN line, do quirks */
0232     iowrite8(0x02, ctl_addr);
0233     if (is_kme)
0234         iowrite8(0x81, ctl_addr + 0x01);
0235
0236     /* FIXME: Could be more ports at base + 0x10 but we only deal with
0237        one right now */
0238     if (resource_size(pdev->resource[0]) >= 0x20)
0239         n_ports = 2;
0240
0241     if (pdev->manf_id == 0x0097 && pdev->card_id == 0x1620)
0242         ops = &pcmcia_8bit_port_ops;
0243     /*
0244      *  Having done the PCMCIA plumbing the ATA side is relatively
0245      *  sane.
0246      */
0247     ret = -ENOMEM;
0248     host = ata_host_alloc(&pdev->dev, n_ports);
0249     if (!host)
0250         goto failed;
0251
0252     for (p = 0; p < n_ports; p++) {
0253         ap = host->ports[p];
0254
0255         ap->ops = ops;
0256         ap->pio_mask = ATA_PIO0;    /* ISA so PIO 0 cycles */
0257         ap->flags |= ATA_FLAG_SLAVE_POSS;
0258         ap->ioaddr.cmd_addr = io_addr + 0x10 * p;
0259         ap->ioaddr.altstatus_addr = ctl_addr + 0x10 * p;
0260         ap->ioaddr.ctl_addr = ctl_addr + 0x10 * p;
0261         ata_sff_std_ports(&ap->ioaddr);
0262
0263         ata_port_desc(ap, "cmd 0x%lx ctl 0x%lx", io_base, ctl_base);
0264     }
0265
0266     /* activate */
0267     ret = ata_host_activate(host, pdev->irq, ata_sff_interrupt,
0268                 IRQF_SHARED, &pcmcia_sht);
0269     if (ret)
0270         goto failed;
0271
0272     pdev->priv = host;
0273     return 0;
0274
0275 failed:
0276     pcmcia_disable_device(pdev);
0277     return ret;
0278 }
0279
0280 /**
0281  *  pcmcia_remove_one   -   unplug an pcmcia interface
0282  *  @pdev: pcmcia device
0283  *
0284  *  A PCMCIA ATA device has been unplugged. Perform the needed
0285  *  cleanup. Also called on module unload for any active devices.
0286  */
0287
0288 static void pcmcia_remove_one(struct pcmcia_device *pdev)
0289 {
0290     struct ata_host *host = pdev->priv;
0291
0292     if (host)
0293         ata_host_detach(host);
0294
0295     pcmcia_disable_device(pdev);
0296 }
0297
0298 static const struct pcmcia_device_id pcmcia_devices[] = {
0299     PCMCIA_DEVICE_FUNC_ID(4),
0300     PCMCIA_DEVICE_MANF_CARD(0x0000, 0x0000),    /* Corsair */
0301     PCMCIA_DEVICE_MANF_CARD(0x0007, 0x0000),    /* Hitachi */
0302     PCMCIA_DEVICE_MANF_CARD(0x000a, 0x0000),    /* I-O Data CFA */
0303     PCMCIA_DEVICE_MANF_CARD(0x001c, 0x0001),    /* Mitsubishi CFA */
0304     PCMCIA_DEVICE_MANF_CARD(0x0032, 0x0704),
0305     PCMCIA_DEVICE_MANF_CARD(0x0032, 0x2904),
0306     PCMCIA_DEVICE_MANF_CARD(0x0045, 0x0401),    /* SanDisk CFA */
0307     PCMCIA_DEVICE_MANF_CARD(0x004f, 0x0000),    /* Kingston */
0308     PCMCIA_DEVICE_MANF_CARD(0x0097, 0x1620),    /* TI emulated */
0309     PCMCIA_DEVICE_MANF_CARD(0x0098, 0x0000),    /* Toshiba */
0310     PCMCIA_DEVICE_MANF_CARD(0x00a4, 0x002d),
0311     PCMCIA_DEVICE_MANF_CARD(0x00ce, 0x0000),    /* Samsung */
0312     PCMCIA_DEVICE_MANF_CARD(0x00f1, 0x0101),    /* SanDisk High (>8G) CFA */
0313     PCMCIA_DEVICE_MANF_CARD(0x0319, 0x0000),    /* Hitachi */
0314     PCMCIA_DEVICE_MANF_CARD(0x2080, 0x0001),
0315     PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0100),    /* Viking CFA */
0316     PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0200),    /* Lexar, Viking CFA */
0317     PCMCIA_DEVICE_PROD_ID123("Caravelle", "PSC-IDE ", "PSC000", 0x8c36137c, 0xd0693ab8, 0x2768a9f0),
0318     PCMCIA_DEVICE_PROD_ID123("CDROM", "IDE", "MCD-601p", 0x1b9179ca, 0xede88951, 0x0d902f74),
0319     PCMCIA_DEVICE_PROD_ID123("PCMCIA", "IDE CARD", "F1", 0x281f1c5d, 0x1907960c, 0xf7fde8b9),
0320     PCMCIA_DEVICE_PROD_ID12("ARGOSY", "CD-ROM", 0x78f308dc, 0x66536591),
0321     PCMCIA_DEVICE_PROD_ID12("ARGOSY", "PnPIDE", 0x78f308dc, 0x0c694728),
0322     PCMCIA_DEVICE_PROD_ID12("CNF   ", "CD-ROM", 0x46d7db81, 0x66536591),
0323     PCMCIA_DEVICE_PROD_ID12("CNF CD-M", "CD-ROM", 0x7d93b852, 0x66536591),
0324     PCMCIA_DEVICE_PROD_ID12("Creative Technology Ltd.", "PCMCIA CD-ROM Interface Card", 0xff8c8a45, 0xfe8020c4),
0325     PCMCIA_DEVICE_PROD_ID12("Digital Equipment Corporation.", "Digital Mobile Media CD-ROM", 0x17692a66, 0xef1dcbde),
0326     PCMCIA_DEVICE_PROD_ID12("EXP", "CD+GAME", 0x6f58c983, 0x63c13aaf),
0327     PCMCIA_DEVICE_PROD_ID12("EXP   ", "CD-ROM", 0x0a5c52fd, 0x66536591),
0328     PCMCIA_DEVICE_PROD_ID12("EXP   ", "PnPIDE", 0x0a5c52fd, 0x0c694728),
0329     PCMCIA_DEVICE_PROD_ID12("FREECOM", "PCCARD-IDE", 0x5714cbf7, 0x48e0ab8e),
0330     PCMCIA_DEVICE_PROD_ID12("HITACHI", "FLASH", 0xf4f43949, 0x9eb86aae),
0331     PCMCIA_DEVICE_PROD_ID12("HITACHI", "microdrive", 0xf4f43949, 0xa6d76178),
0332     PCMCIA_DEVICE_PROD_ID12("Hyperstone", "Model1", 0x3d5b9ef5, 0xca6ab420),
0333     PCMCIA_DEVICE_PROD_ID12("IBM", "microdrive", 0xb569a6e5, 0xa6d76178),
0334     PCMCIA_DEVICE_PROD_ID12("IBM", "IBM17JSSFP20", 0xb569a6e5, 0xf2508753),
0335     PCMCIA_DEVICE_PROD_ID12("KINGSTON", "CF CARD 1GB", 0x2e6d1829, 0x55d5bffb),
0336     PCMCIA_DEVICE_PROD_ID12("KINGSTON", "CF CARD 4GB", 0x2e6d1829, 0x531e7d10),
0337     PCMCIA_DEVICE_PROD_ID12("KINGSTON", "CF8GB", 0x2e6d1829, 0xacbe682e),
0338     PCMCIA_DEVICE_PROD_ID12("IO DATA", "CBIDE2      ", 0x547e66dc, 0x8671043b),
0339     PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDE", 0x547e66dc, 0x5c5ab149),
0340     PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDEII", 0x547e66dc, 0xb3662674),
0341     PCMCIA_DEVICE_PROD_ID12("LOOKMEET", "CBIDE2      ", 0xe37be2b5, 0x8671043b),
0342     PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF300", 0x7ed2ad87, 0x7e9e78ee),
0343     PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF500", 0x7ed2ad87, 0x7a13045c),
0344     PCMCIA_DEVICE_PROD_ID2("NinjaATA-", 0xebe0bd79),
0345     PCMCIA_DEVICE_PROD_ID12("PCMCIA", "CD-ROM", 0x281f1c5d, 0x66536591),
0346     PCMCIA_DEVICE_PROD_ID12("PCMCIA", "PnPIDE", 0x281f1c5d, 0x0c694728),
0347     PCMCIA_DEVICE_PROD_ID12("SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", 0x4a3f0ba0, 0x322560e1),
0348     PCMCIA_DEVICE_PROD_ID12("SEAGATE", "ST1", 0x87c1b330, 0xe1f30883),
0349     PCMCIA_DEVICE_PROD_ID12("SAMSUNG", "04/05/06", 0x43d74cb4, 0x6a22777d),
0350     PCMCIA_DEVICE_PROD_ID12("SMI VENDOR", "SMI PRODUCT", 0x30896c92, 0x703cc5f6),
0351     PCMCIA_DEVICE_PROD_ID12("TOSHIBA", "MK2001MPL", 0xb4585a1a, 0x3489e003),
0352     PCMCIA_DEVICE_PROD_ID1("TRANSCEND    512M   ", 0xd0909443),
0353     PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS1GCF45", 0x709b1bf1, 0xf68b6f32),
0354     PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS1GCF80", 0x709b1bf1, 0x2a54d4b1),
0355     PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS2GCF120", 0x709b1bf1, 0x969aa4f2),
0356     PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS4GCF120", 0x709b1bf1, 0xf54a91c8),
0357     PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS4GCF133", 0x709b1bf1, 0x7558f133),
0358     PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS8GCF133", 0x709b1bf1, 0xb2f89b47),
0359     PCMCIA_DEVICE_PROD_ID12("WIT", "IDE16", 0x244e5994, 0x3e232852),
0360     PCMCIA_DEVICE_PROD_ID12("WEIDA", "TWTTI", 0xcc7cf69c, 0x212bb918),
0361     PCMCIA_DEVICE_PROD_ID1("STI Flash", 0xe4a13209),
0362     PCMCIA_DEVICE_PROD_ID12("STI", "Flash 5.0", 0xbf2df18d, 0x8cb57a0e),
0363     PCMCIA_MFC_DEVICE_PROD_ID12(1, "SanDisk", "ConnectPlus", 0x7a954bd9, 0x74be00c6),
0364     PCMCIA_DEVICE_PROD_ID2("Flash Card", 0x5a362506),
0365     PCMCIA_DEVICE_NULL,
0366 };
0367
0368 MODULE_DEVICE_TABLE(pcmcia, pcmcia_devices);
0369
0370 static struct pcmcia_driver pcmcia_driver = {
0371     .owner      = THIS_MODULE,
0372     .name       = DRV_NAME,
0373     .id_table   = pcmcia_devices,
0374     .probe      = pcmcia_init_one,
0375     .remove     = pcmcia_remove_one,
0376 };
0377 module_pcmcia_driver(pcmcia_driver);
0378
0379 MODULE_AUTHOR("Alan Cox");
0380 MODULE_DESCRIPTION("low-level driver for PCMCIA ATA");
0381 MODULE_LICENSE("GPL");
0382 MODULE_VERSION(DRV_VERSION);