LXR linux/drivers/ata/pata

   1/*
   2 * Generic platform device PATA driver
   3 *
   4 * Copyright (C) 2006 - 2007  Paul Mundt
   5 *
   6 * Based on pata_pcmcia:
   7 *
   8 *   Copyright 2005-2006 Red Hat Inc, all rights reserved.
   9 *
  10 * This file is subject to the terms and conditions of the GNU General Public
  11 * License.  See the file "COPYING" in the main directory of this archive
  12 * for more details.
  13 */
  14#include <linux/kernel.h>
  15#include <linux/module.h>
  16#include <linux/blkdev.h>
  17#include <scsi/scsi_host.h>
  18#include <linux/ata.h>
  19#include <linux/libata.h>
  20#include <linux/platform_device.h>
  21#include <linux/ata_platform.h>
  22
  23#define DRV_NAME "pata_platform"
  24#define DRV_VERSION "1.2"
  25
  26static int pio_mask = 1;
  27module_param(pio_mask, int, 0);
  28MODULE_PARM_DESC(pio_mask, "PIO modes supported, mode 0 only by default");
  29
  30/*
  31 * Provide our own set_mode() as we don't want to change anything that has
  32 * already been configured..
  33 */
  34static int pata_platform_set_mode(struct ata_link *link, struct ata_device **unused)
  35{
  36        struct ata_device *dev;
  37
  38        ata_for_each_dev(dev, link, ENABLED) {
  39                /* We don't really care */
  40                dev->pio_mode = dev->xfer_mode = XFER_PIO_0;
  41                dev->xfer_shift = ATA_SHIFT_PIO;
  42                dev->flags |= ATA_DFLAG_PIO;
  43                ata_dev_info(dev, "configured for PIO\n");
  44        }
  45        return 0;
  46}
  47
  48static struct scsi_host_template pata_platform_sht = {
  49        ATA_PIO_SHT(DRV_NAME),
  50};
  51
  52static void pata_platform_setup_port(struct ata_ioports *ioaddr,
  53                                     unsigned int shift)
  54{
  55        /* Fixup the port shift for platforms that need it */
  56        ioaddr->data_addr       = ioaddr->cmd_addr + (ATA_REG_DATA    << shift);
  57        ioaddr->error_addr      = ioaddr->cmd_addr + (ATA_REG_ERR     << shift);
  58        ioaddr->feature_addr    = ioaddr->cmd_addr + (ATA_REG_FEATURE << shift);
  59        ioaddr->nsect_addr      = ioaddr->cmd_addr + (ATA_REG_NSECT   << shift);
  60        ioaddr->lbal_addr       = ioaddr->cmd_addr + (ATA_REG_LBAL    << shift);
  61        ioaddr->lbam_addr       = ioaddr->cmd_addr + (ATA_REG_LBAM    << shift);
  62        ioaddr->lbah_addr       = ioaddr->cmd_addr + (ATA_REG_LBAH    << shift);
  63        ioaddr->device_addr     = ioaddr->cmd_addr + (ATA_REG_DEVICE  << shift);
  64        ioaddr->status_addr     = ioaddr->cmd_addr + (ATA_REG_STATUS  << shift);
  65        ioaddr->command_addr    = ioaddr->cmd_addr + (ATA_REG_CMD     << shift);
  66}
  67
  68/**
  69 *      __pata_platform_probe           -       attach a platform interface
  70 *      @dev: device
  71 *      @io_res: Resource representing I/O base
  72 *      @ctl_res: Resource representing CTL base
  73 *      @irq_res: Resource representing IRQ and its flags
  74 *      @ioport_shift: I/O port shift
  75 *      @__pio_mask: PIO mask
  76 *      @sht: scsi_host_template to use when registering
  77 *      @use16bit: Flag to indicate 16-bit IO instead of 32-bit
  78 *
  79 *      Register a platform bus IDE interface. Such interfaces are PIO and we
  80 *      assume do not support IRQ sharing.
  81 *
  82 *      Platform devices are expected to contain at least 2 resources per port:
  83 *
  84 *              - I/O Base (IORESOURCE_IO or IORESOURCE_MEM)
  85 *              - CTL Base (IORESOURCE_IO or IORESOURCE_MEM)
  86 *
  87 *      and optionally:
  88 *
  89 *              - IRQ      (IORESOURCE_IRQ)
  90 *
  91 *      If the base resources are both mem types, the ioremap() is handled
  92 *      here. For IORESOURCE_IO, it's assumed that there's no remapping
  93 *      necessary.
  94 *
  95 *      If no IRQ resource is present, PIO polling mode is used instead.
  96 */
  97int __pata_platform_probe(struct device *dev, struct resource *io_res,
  98                          struct resource *ctl_res, struct resource *irq_res,
  99                          unsigned int ioport_shift, int __pio_mask,
 100                          struct scsi_host_template *sht, bool use16bit)
 101{
 102        struct ata_host *host;
 103        struct ata_port *ap;
 104        unsigned int mmio;
 105        int irq = 0;
 106        int irq_flags = 0;
 107
 108        /*
 109         * Check for MMIO
 110         */
 111        mmio = (( io_res->flags == IORESOURCE_MEM) &&
 112                (ctl_res->flags == IORESOURCE_MEM));
 113
 114        /*
 115         * And the IRQ
 116         */
 117        if (irq_res && irq_res->start > 0) {
 118                irq = irq_res->start;
 119                irq_flags = (irq_res->flags & IRQF_TRIGGER_MASK) | IRQF_SHARED;
 120        }
 121
 122        /*
 123         * Now that that's out of the way, wire up the port..
 124         */
 125        host = ata_host_alloc(dev, 1);
 126        if (!host)
 127                return -ENOMEM;
 128        ap = host->ports[0];
 129
 130        ap->ops = devm_kzalloc(dev, sizeof(*ap->ops), GFP_KERNEL);
 131        ap->ops->inherits = &ata_sff_port_ops;
 132        ap->ops->cable_detect = ata_cable_unknown;
 133        ap->ops->set_mode = pata_platform_set_mode;
 134        if (use16bit)
 135                ap->ops->sff_data_xfer = ata_sff_data_xfer;
 136        else
 137                ap->ops->sff_data_xfer = ata_sff_data_xfer32;
 138
 139        ap->pio_mask = __pio_mask;
 140        ap->flags |= ATA_FLAG_SLAVE_POSS;
 141
 142        /*
 143         * Use polling mode if there's no IRQ
 144         */
 145        if (!irq) {
 146                ap->flags |= ATA_FLAG_PIO_POLLING;
 147                ata_port_desc(ap, "no IRQ, using PIO polling");
 148        }
 149
 150        /*
 151         * Handle the MMIO case
 152         */
 153        if (mmio) {
 154                ap->ioaddr.cmd_addr = devm_ioremap(dev, io_res->start,
 155                                resource_size(io_res));
 156                ap->ioaddr.ctl_addr = devm_ioremap(dev, ctl_res->start,
 157                                resource_size(ctl_res));
 158        } else {
 159                ap->ioaddr.cmd_addr = devm_ioport_map(dev, io_res->start,
 160                                resource_size(io_res));
 161                ap->ioaddr.ctl_addr = devm_ioport_map(dev, ctl_res->start,
 162                                resource_size(ctl_res));
 163        }
 164        if (!ap->ioaddr.cmd_addr || !ap->ioaddr.ctl_addr) {
 165                dev_err(dev, "failed to map IO/CTL base\n");
 166                return -ENOMEM;
 167        }
 168
 169        ap->ioaddr.altstatus_addr = ap->ioaddr.ctl_addr;
 170
 171        pata_platform_setup_port(&ap->ioaddr, ioport_shift);
 172
 173        ata_port_desc(ap, "%s cmd 0x%llx ctl 0x%llx", mmio ? "mmio" : "ioport",
 174                      (unsigned long long)io_res->start,
 175                      (unsigned long long)ctl_res->start);
 176
 177        /* activate */
 178        return ata_host_activate(host, irq, irq ? ata_sff_interrupt : NULL,
 179                                 irq_flags, sht);
 180}
 181EXPORT_SYMBOL_GPL(__pata_platform_probe);
 182
 183static int pata_platform_probe(struct platform_device *pdev)
 184{
 185        struct resource *io_res;
 186        struct resource *ctl_res;
 187        struct resource *irq_res;
 188        struct pata_platform_info *pp_info = dev_get_platdata(&pdev->dev);
 189
 190        /*
 191         * Simple resource validation ..
 192         */
 193        if ((pdev->num_resources != 3) && (pdev->num_resources != 2)) {
 194                dev_err(&pdev->dev, "invalid number of resources\n");
 195                return -EINVAL;
 196        }
 197
 198        /*
 199         * Get the I/O base first
 200         */
 201        io_res = platform_get_resource(pdev, IORESOURCE_IO, 0);
 202        if (io_res == NULL) {
 203                io_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 204                if (unlikely(io_res == NULL))
 205                        return -EINVAL;
 206        }
 207
 208        /*
 209         * Then the CTL base
 210         */
 211        ctl_res = platform_get_resource(pdev, IORESOURCE_IO, 1);
 212        if (ctl_res == NULL) {
 213                ctl_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
 214                if (unlikely(ctl_res == NULL))
 215                        return -EINVAL;
 216        }
 217
 218        /*
 219         * And the IRQ
 220         */
 221        irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
 222
 223        return __pata_platform_probe(&pdev->dev, io_res, ctl_res, irq_res,
 224                                     pp_info ? pp_info->ioport_shift : 0,
 225                                     pio_mask, &pata_platform_sht, false);
 226}
 227
 228static struct platform_driver pata_platform_driver = {
 229        .probe          = pata_platform_probe,
 230        .remove         = ata_platform_remove_one,
 231        .driver = {
 232                .name           = DRV_NAME,
 233        },
 234};
 235
 236module_platform_driver(pata_platform_driver);
 237
 238MODULE_AUTHOR("Paul Mundt");
 239MODULE_DESCRIPTION("low-level driver for platform device ATA");
 240MODULE_LICENSE("GPL");
 241MODULE_VERSION(DRV_VERSION);
 242MODULE_ALIAS("platform:" DRV_NAME);
 243