LXR linux/drivers/ata/pata

   1/*
   2 *   pata_pcmcia.c - PCMCIA PATA controller driver.
   3 *   Copyright 2005-2006 Red Hat Inc, 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.3.3"
  46
  47/*
  48 *      Private data structure to glue stuff together
  49 */
  50
  51struct ata_pcmcia_info {
  52        struct pcmcia_device *pdev;
  53        int             ndev;
  54        dev_node_t      node;
  55};
  56
  57/**
  58 *      pcmcia_set_mode -       PCMCIA specific mode setup
  59 *      @link: link
  60 *      @r_failed_dev: Return pointer for failed device
  61 *
  62 *      Perform the tuning and setup of the devices and timings, which
  63 *      for PCMCIA is the same as any other controller. We wrap it however
  64 *      as we need to spot hardware with incorrect or missing master/slave
  65 *      decode, which alas is embarrassingly common in the PC world
  66 */
  67
  68static int pcmcia_set_mode(struct ata_link *link, struct ata_device **r_failed_dev)
  69{
  70        struct ata_device *master = &link->device[0];
  71        struct ata_device *slave = &link->device[1];
  72
  73        if (!ata_dev_enabled(master) || !ata_dev_enabled(slave))
  74                return ata_do_set_mode(link, r_failed_dev);
  75
  76        if (memcmp(master->id + ATA_ID_FW_REV,  slave->id + ATA_ID_FW_REV,
  77                           ATA_ID_FW_REV_LEN + ATA_ID_PROD_LEN) == 0) {
  78                /* Suspicious match, but could be two cards from
  79                   the same vendor - check serial */
  80                if (memcmp(master->id + ATA_ID_SERNO, slave->id + ATA_ID_SERNO,
  81                           ATA_ID_SERNO_LEN) == 0 && master->id[ATA_ID_SERNO] >> 8) {
  82                        ata_dev_printk(slave, KERN_WARNING, "is a ghost device, ignoring.\n");
  83                        ata_dev_disable(slave);
  84                }
  85        }
  86        return ata_do_set_mode(link, r_failed_dev);
  87}
  88
  89/**
  90 *      pcmcia_set_mode_8bit    -       PCMCIA specific mode setup
  91 *      @link: link
  92 *      @r_failed_dev: Return pointer for failed device
  93 *
  94 *      For the simple emulated 8bit stuff the less we do the better.
  95 */
  96
  97static int pcmcia_set_mode_8bit(struct ata_link *link,
  98                                struct ata_device **r_failed_dev)
  99{
 100        return 0;
 101}
 102
 103/**
 104 *      ata_data_xfer_8bit       -      Transfer data by 8bit PIO
 105 *      @dev: device to target
 106 *      @buf: data buffer
 107 *      @buflen: buffer length
 108 *      @rw: read/write
 109 *
 110 *      Transfer data from/to the device data register by 8 bit PIO.
 111 *
 112 *      LOCKING:
 113 *      Inherited from caller.
 114 */
 115
 116static unsigned int ata_data_xfer_8bit(struct ata_device *dev,
 117                                unsigned char *buf, unsigned int buflen, int rw)
 118{
 119        struct ata_port *ap = dev->link->ap;
 120
 121        if (rw == READ)
 122                ioread8_rep(ap->ioaddr.data_addr, buf, buflen);
 123        else
 124                iowrite8_rep(ap->ioaddr.data_addr, buf, buflen);
 125
 126        return buflen;
 127}
 128
 129
 130static struct scsi_host_template pcmcia_sht = {
 131        ATA_PIO_SHT(DRV_NAME),
 132};
 133
 134static struct ata_port_operations pcmcia_port_ops = {
 135        .inherits       = &ata_sff_port_ops,
 136        .sff_data_xfer  = ata_sff_data_xfer_noirq,
 137        .cable_detect   = ata_cable_40wire,
 138        .set_mode       = pcmcia_set_mode,
 139};
 140
 141static struct ata_port_operations pcmcia_8bit_port_ops = {
 142        .inherits       = &ata_sff_port_ops,
 143        .sff_data_xfer  = ata_data_xfer_8bit,
 144        .cable_detect   = ata_cable_40wire,
 145        .set_mode       = pcmcia_set_mode_8bit,
 146};
 147
 148#define CS_CHECK(fn, ret) \
 149do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
 150
 151
 152struct pcmcia_config_check {
 153        unsigned long ctl_base;
 154        int skip_vcc;
 155        int is_kme;
 156};
 157
 158static int pcmcia_check_one_config(struct pcmcia_device *pdev,
 159                                   cistpl_cftable_entry_t *cfg,
 160                                   cistpl_cftable_entry_t *dflt,
 161                                   unsigned int vcc,
 162                                   void *priv_data)
 163{
 164        struct pcmcia_config_check *stk = priv_data;
 165
 166        /* Check for matching Vcc, unless we're desperate */
 167        if (!stk->skip_vcc) {
 168                if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
 169                        if (vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000)
 170                                return -ENODEV;
 171                } else if (dflt->vcc.present & (1 << CISTPL_POWER_VNOM)) {
 172                        if (vcc != dflt->vcc.param[CISTPL_POWER_VNOM] / 10000)
 173                                return -ENODEV;
 174                }
 175        }
 176
 177        if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
 178                pdev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
 179        else if (dflt->vpp1.present & (1 << CISTPL_POWER_VNOM))
 180                pdev->conf.Vpp = dflt->vpp1.param[CISTPL_POWER_VNOM] / 10000;
 181
 182        if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
 183                cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
 184                pdev->io.BasePort1 = io->win[0].base;
 185                pdev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
 186                if (!(io->flags & CISTPL_IO_16BIT))
 187                        pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 188                if (io->nwin == 2) {
 189                        pdev->io.NumPorts1 = 8;
 190                        pdev->io.BasePort2 = io->win[1].base;
 191                        pdev->io.NumPorts2 = (stk->is_kme) ? 2 : 1;
 192                        if (pcmcia_request_io(pdev, &pdev->io) != 0)
 193                                return -ENODEV;
 194                        stk->ctl_base = pdev->io.BasePort2;
 195                } else if ((io->nwin == 1) && (io->win[0].len >= 16)) {
 196                        pdev->io.NumPorts1 = io->win[0].len;
 197                        pdev->io.NumPorts2 = 0;
 198                        if (pcmcia_request_io(pdev, &pdev->io) != 0)
 199                                return -ENODEV;
 200                        stk->ctl_base = pdev->io.BasePort1 + 0x0e;
 201                } else
 202                        return -ENODEV;
 203                /* If we've got this far, we're done */
 204                return 0;
 205        }
 206        return -ENODEV;
 207}
 208
 209/**
 210 *      pcmcia_init_one         -       attach a PCMCIA interface
 211 *      @pdev: pcmcia device
 212 *
 213 *      Register a PCMCIA IDE interface. Such interfaces are PIO 0 and
 214 *      shared IRQ.
 215 */
 216
 217static int pcmcia_init_one(struct pcmcia_device *pdev)
 218{
 219        struct ata_host *host;
 220        struct ata_port *ap;
 221        struct ata_pcmcia_info *info;
 222        struct pcmcia_config_check *stk = NULL;
 223        int last_ret = 0, last_fn = 0, is_kme = 0, ret = -ENOMEM, p;
 224        unsigned long io_base, ctl_base;
 225        void __iomem *io_addr, *ctl_addr;
 226        int n_ports = 1;
 227        struct ata_port_operations *ops = &pcmcia_port_ops;
 228
 229        info = kzalloc(sizeof(*info), GFP_KERNEL);
 230        if (info == NULL)
 231                return -ENOMEM;
 232
 233        /* Glue stuff together. FIXME: We may be able to get rid of info with care */
 234        info->pdev = pdev;
 235        pdev->priv = info;
 236
 237        /* Set up attributes in order to probe card and get resources */
 238        pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 239        pdev->io.Attributes2 = IO_DATA_PATH_WIDTH_8;
 240        pdev->io.IOAddrLines = 3;
 241        pdev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
 242        pdev->irq.IRQInfo1 = IRQ_LEVEL_ID;
 243        pdev->conf.Attributes = CONF_ENABLE_IRQ;
 244        pdev->conf.IntType = INT_MEMORY_AND_IO;
 245
 246        /* See if we have a manufacturer identifier. Use it to set is_kme for
 247           vendor quirks */
 248        is_kme = ((pdev->manf_id == MANFID_KME) &&
 249                  ((pdev->card_id == PRODID_KME_KXLC005_A) ||
 250                   (pdev->card_id == PRODID_KME_KXLC005_B)));
 251
 252        /* Allocate resoure probing structures */
 253
 254        stk = kzalloc(sizeof(*stk), GFP_KERNEL);
 255        if (!stk)
 256                goto out1;
 257        stk->is_kme = is_kme;
 258        stk->skip_vcc = io_base = ctl_base = 0;
 259
 260        if (pcmcia_loop_config(pdev, pcmcia_check_one_config, stk)) {
 261                stk->skip_vcc = 1;
 262                if (pcmcia_loop_config(pdev, pcmcia_check_one_config, stk))
 263                        goto failed; /* No suitable config found */
 264        }
 265        io_base = pdev->io.BasePort1;
 266        ctl_base = stk->ctl_base;
 267        CS_CHECK(RequestIRQ, pcmcia_request_irq(pdev, &pdev->irq));
 268        CS_CHECK(RequestConfiguration, pcmcia_request_configuration(pdev, &pdev->conf));
 269
 270        /* iomap */
 271        ret = -ENOMEM;
 272        io_addr = devm_ioport_map(&pdev->dev, io_base, 8);
 273        ctl_addr = devm_ioport_map(&pdev->dev, ctl_base, 1);
 274        if (!io_addr || !ctl_addr)
 275                goto failed;
 276
 277        /* Success. Disable the IRQ nIEN line, do quirks */
 278        iowrite8(0x02, ctl_addr);
 279        if (is_kme)
 280                iowrite8(0x81, ctl_addr + 0x01);
 281
 282        /* FIXME: Could be more ports at base + 0x10 but we only deal with
 283           one right now */
 284        if (pdev->io.NumPorts1 >= 0x20)
 285                n_ports = 2;
 286
 287        if (pdev->manf_id == 0x0097 && pdev->card_id == 0x1620)
 288                ops = &pcmcia_8bit_port_ops;
 289        /*
 290         *      Having done the PCMCIA plumbing the ATA side is relatively
 291         *      sane.
 292         */
 293        ret = -ENOMEM;
 294        host = ata_host_alloc(&pdev->dev, n_ports);
 295        if (!host)
 296                goto failed;
 297
 298        for (p = 0; p < n_ports; p++) {
 299                ap = host->ports[p];
 300
 301                ap->ops = ops;
 302                ap->pio_mask = 1;               /* ISA so PIO 0 cycles */
 303                ap->flags |= ATA_FLAG_SLAVE_POSS;
 304                ap->ioaddr.cmd_addr = io_addr + 0x10 * p;
 305                ap->ioaddr.altstatus_addr = ctl_addr + 0x10 * p;
 306                ap->ioaddr.ctl_addr = ctl_addr + 0x10 * p;
 307                ata_sff_std_ports(&ap->ioaddr);
 308
 309                ata_port_desc(ap, "cmd 0x%lx ctl 0x%lx", io_base, ctl_base);
 310        }
 311
 312        /* activate */
 313        ret = ata_host_activate(host, pdev->irq.AssignedIRQ, ata_sff_interrupt,
 314                                IRQF_SHARED, &pcmcia_sht);
 315        if (ret)
 316                goto failed;
 317
 318        info->ndev = 1;
 319        kfree(stk);
 320        return 0;
 321
 322cs_failed:
 323        cs_error(pdev, last_fn, last_ret);
 324failed:
 325        kfree(stk);
 326        info->ndev = 0;
 327        pcmcia_disable_device(pdev);
 328out1:
 329        kfree(info);
 330        return ret;
 331}
 332
 333/**
 334 *      pcmcia_remove_one       -       unplug an pcmcia interface
 335 *      @pdev: pcmcia device
 336 *
 337 *      A PCMCIA ATA device has been unplugged. Perform the needed
 338 *      cleanup. Also called on module unload for any active devices.
 339 */
 340
 341static void pcmcia_remove_one(struct pcmcia_device *pdev)
 342{
 343        struct ata_pcmcia_info *info = pdev->priv;
 344        struct device *dev = &pdev->dev;
 345
 346        if (info != NULL) {
 347                /* If we have attached the device to the ATA layer, detach it */
 348                if (info->ndev) {
 349                        struct ata_host *host = dev_get_drvdata(dev);
 350                        ata_host_detach(host);
 351                }
 352                info->ndev = 0;
 353                pdev->priv = NULL;
 354        }
 355        pcmcia_disable_device(pdev);
 356        kfree(info);
 357}
 358
 359static struct pcmcia_device_id pcmcia_devices[] = {
 360        PCMCIA_DEVICE_FUNC_ID(4),
 361        PCMCIA_DEVICE_MANF_CARD(0x0000, 0x0000),        /* Corsair */
 362        PCMCIA_DEVICE_MANF_CARD(0x0007, 0x0000),        /* Hitachi */
 363        PCMCIA_DEVICE_MANF_CARD(0x000a, 0x0000),        /* I-O Data CFA */
 364        PCMCIA_DEVICE_MANF_CARD(0x001c, 0x0001),        /* Mitsubishi CFA */
 365        PCMCIA_DEVICE_MANF_CARD(0x0032, 0x0704),
 366        PCMCIA_DEVICE_MANF_CARD(0x0032, 0x2904),
 367        PCMCIA_DEVICE_MANF_CARD(0x0045, 0x0401),        /* SanDisk CFA */
 368        PCMCIA_DEVICE_MANF_CARD(0x004f, 0x0000),        /* Kingston */
 369        PCMCIA_DEVICE_MANF_CARD(0x0097, 0x1620),        /* TI emulated */
 370        PCMCIA_DEVICE_MANF_CARD(0x0098, 0x0000),        /* Toshiba */
 371        PCMCIA_DEVICE_MANF_CARD(0x00a4, 0x002d),
 372        PCMCIA_DEVICE_MANF_CARD(0x00ce, 0x0000),        /* Samsung */
 373        PCMCIA_DEVICE_MANF_CARD(0x0319, 0x0000),        /* Hitachi */
 374        PCMCIA_DEVICE_MANF_CARD(0x2080, 0x0001),
 375        PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0100),        /* Viking CFA */
 376        PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0200),        /* Lexar, Viking CFA */
 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("Hyperstone", "Model1", 0x3d5b9ef5, 0xca6ab420),
 392        PCMCIA_DEVICE_PROD_ID12("IBM", "microdrive", 0xb569a6e5, 0xa6d76178),
 393        PCMCIA_DEVICE_PROD_ID12("IBM", "IBM17JSSFP20", 0xb569a6e5, 0xf2508753),
 394        PCMCIA_DEVICE_PROD_ID12("KINGSTON", "CF8GB", 0x2e6d1829, 0xacbe682e),
 395        PCMCIA_DEVICE_PROD_ID12("IO DATA", "CBIDE2      ", 0x547e66dc, 0x8671043b),
 396        PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDE", 0x547e66dc, 0x5c5ab149),
 397        PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDEII", 0x547e66dc, 0xb3662674),
 398        PCMCIA_DEVICE_PROD_ID12("LOOKMEET", "CBIDE2      ", 0xe37be2b5, 0x8671043b),
 399        PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF300", 0x7ed2ad87, 0x7e9e78ee),
 400        PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF500", 0x7ed2ad87, 0x7a13045c),
 401        PCMCIA_DEVICE_PROD_ID2("NinjaATA-", 0xebe0bd79),
 402        PCMCIA_DEVICE_PROD_ID12("PCMCIA", "CD-ROM", 0x281f1c5d, 0x66536591),
 403        PCMCIA_DEVICE_PROD_ID12("PCMCIA", "PnPIDE", 0x281f1c5d, 0x0c694728),
 404        PCMCIA_DEVICE_PROD_ID12("SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", 0x4a3f0ba0, 0x322560e1),
 405        PCMCIA_DEVICE_PROD_ID12("SEAGATE", "ST1", 0x87c1b330, 0xe1f30883),
 406        PCMCIA_DEVICE_PROD_ID12("SAMSUNG", "04/05/06", 0x43d74cb4, 0x6a22777d),
 407        PCMCIA_DEVICE_PROD_ID12("SMI VENDOR", "SMI PRODUCT", 0x30896c92, 0x703cc5f6),
 408        PCMCIA_DEVICE_PROD_ID12("TOSHIBA", "MK2001MPL", 0xb4585a1a, 0x3489e003),
 409        PCMCIA_DEVICE_PROD_ID1("TRANSCEND    512M   ", 0xd0909443),
 410        PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS1GCF45", 0x709b1bf1, 0xf68b6f32),
 411        PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS1GCF80", 0x709b1bf1, 0x2a54d4b1),
 412        PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS2GCF120", 0x709b1bf1, 0x969aa4f2),
 413        PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS4GCF120", 0x709b1bf1, 0xf54a91c8),
 414        PCMCIA_DEVICE_PROD_ID12("WIT", "IDE16", 0x244e5994, 0x3e232852),
 415        PCMCIA_DEVICE_PROD_ID12("WEIDA", "TWTTI", 0xcc7cf69c, 0x212bb918),
 416        PCMCIA_DEVICE_PROD_ID1("STI Flash", 0xe4a13209),
 417        PCMCIA_DEVICE_PROD_ID12("STI", "Flash 5.0", 0xbf2df18d, 0x8cb57a0e),
 418        PCMCIA_MFC_DEVICE_PROD_ID12(1, "SanDisk", "ConnectPlus", 0x7a954bd9, 0x74be00c6),
 419        PCMCIA_DEVICE_PROD_ID2("Flash Card", 0x5a362506),
 420        PCMCIA_DEVICE_NULL,
 421};
 422
 423MODULE_DEVICE_TABLE(pcmcia, pcmcia_devices);
 424
 425static struct pcmcia_driver pcmcia_driver = {
 426        .owner          = THIS_MODULE,
 427        .drv = {
 428                .name           = DRV_NAME,
 429        },
 430        .id_table       = pcmcia_devices,
 431        .probe          = pcmcia_init_one,
 432        .remove         = pcmcia_remove_one,
 433};
 434
 435static int __init pcmcia_init(void)
 436{
 437        return pcmcia_register_driver(&pcmcia_driver);
 438}
 439
 440static void __exit pcmcia_exit(void)
 441{
 442        pcmcia_unregister_driver(&pcmcia_driver);
 443}
 444
 445MODULE_AUTHOR("Alan Cox");
 446MODULE_DESCRIPTION("low-level driver for PCMCIA ATA");
 447MODULE_LICENSE("GPL");
 448MODULE_VERSION(DRV_VERSION);
 449
 450module_init(pcmcia_init);
 451module_exit(pcmcia_exit);
 452