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/init.h>
  17#include <linux/blkdev.h>
  18#include <scsi/scsi_host.h>
  19#include <linux/ata.h>
  20#include <linux/libata.h>
  21#include <linux/platform_device.h>
  22#include <linux/ata_platform.h>
  23
  24#define DRV_NAME "pata_platform"
  25#define DRV_VERSION "1.2"
  26
  27static int pio_mask = 1;
  28
  29/*
  30 * Provide our own set_mode() as we don't want to change anything that has
  31 * already been configured..
  32 */
  33static int pata_platform_set_mode(struct ata_link *link, struct ata_device **unused)
  34{
  35        struct ata_device *dev;
  36
  37        ata_for_each_dev(dev, link, ENABLED) {
  38                /* We don't really care */
  39                dev->pio_mode = dev->xfer_mode = XFER_PIO_0;
  40                dev->xfer_shift = ATA_SHIFT_PIO;
  41                dev->flags |= ATA_DFLAG_PIO;
  42                ata_dev_printk(dev, KERN_INFO, "configured for PIO\n");
  43        }
  44        return 0;
  45}
  46
  47static struct scsi_host_template pata_platform_sht = {
  48        ATA_PIO_SHT(DRV_NAME),
  49};
  50
  51static struct ata_port_operations pata_platform_port_ops = {
  52        .inherits               = &ata_sff_port_ops,
  53        .sff_data_xfer          = ata_sff_data_xfer_noirq,
  54        .cable_detect           = ata_cable_unknown,
  55        .set_mode               = pata_platform_set_mode,
  56};
  57
  58static void pata_platform_setup_port(struct ata_ioports *ioaddr,
  59                                     unsigned int shift)
  60{
  61        /* Fixup the port shift for platforms that need it */
  62        ioaddr->data_addr       = ioaddr->cmd_addr + (ATA_REG_DATA    << shift);
  63        ioaddr->error_addr      = ioaddr->cmd_addr + (ATA_REG_ERR     << shift);
  64        ioaddr->feature_addr    = ioaddr->cmd_addr + (ATA_REG_FEATURE << shift);
  65        ioaddr->nsect_addr      = ioaddr->cmd_addr + (ATA_REG_NSECT   << shift);
  66        ioaddr->lbal_addr       = ioaddr->cmd_addr + (ATA_REG_LBAL    << shift);
  67        ioaddr->lbam_addr       = ioaddr->cmd_addr + (ATA_REG_LBAM    << shift);
  68        ioaddr->lbah_addr       = ioaddr->cmd_addr + (ATA_REG_LBAH    << shift);
  69        ioaddr->device_addr     = ioaddr->cmd_addr + (ATA_REG_DEVICE  << shift);
  70        ioaddr->status_addr     = ioaddr->cmd_addr + (ATA_REG_STATUS  << shift);
  71        ioaddr->command_addr    = ioaddr->cmd_addr + (ATA_REG_CMD     << shift);
  72}
  73
  74/**
  75 *      __pata_platform_probe           -       attach a platform interface
  76 *      @dev: device
  77 *      @io_res: Resource representing I/O base
  78 *      @ctl_res: Resource representing CTL base
  79 *      @irq_res: Resource representing IRQ and its flags
  80 *      @ioport_shift: I/O port shift
  81 *      @__pio_mask: PIO mask
  82 *
  83 *      Register a platform bus IDE interface. Such interfaces are PIO and we
  84 *      assume do not support IRQ sharing.
  85 *
  86 *      Platform devices are expected to contain at least 2 resources per port:
  87 *
  88 *              - I/O Base (IORESOURCE_IO or IORESOURCE_MEM)
  89 *              - CTL Base (IORESOURCE_IO or IORESOURCE_MEM)
  90 *
  91 *      and optionally:
  92 *
  93 *              - IRQ      (IORESOURCE_IRQ)
  94 *
  95 *      If the base resources are both mem types, the ioremap() is handled
  96 *      here. For IORESOURCE_IO, it's assumed that there's no remapping
  97 *      necessary.
  98 *
  99 *      If no IRQ resource is present, PIO polling mode is used instead.
 100 */
 101int __devinit __pata_platform_probe(struct device *dev,
 102                                    struct resource *io_res,
 103                                    struct resource *ctl_res,
 104                                    struct resource *irq_res,
 105                                    unsigned int ioport_shift,
 106                                    int __pio_mask)
 107{
 108        struct ata_host *host;
 109        struct ata_port *ap;
 110        unsigned int mmio;
 111        int irq = 0;
 112        int irq_flags = 0;
 113
 114        /*
 115         * Check for MMIO
 116         */
 117        mmio = (( io_res->flags == IORESOURCE_MEM) &&
 118                (ctl_res->flags == IORESOURCE_MEM));
 119
 120        /*
 121         * And the IRQ
 122         */
 123        if (irq_res && irq_res->start > 0) {
 124                irq = irq_res->start;
 125                irq_flags = irq_res->flags;
 126        }
 127
 128        /*
 129         * Now that that's out of the way, wire up the port..
 130         */
 131        host = ata_host_alloc(dev, 1);
 132        if (!host)
 133                return -ENOMEM;
 134        ap = host->ports[0];
 135
 136        ap->ops = &pata_platform_port_ops;
 137        ap->pio_mask = __pio_mask;
 138        ap->flags |= ATA_FLAG_SLAVE_POSS;
 139
 140        /*
 141         * Use polling mode if there's no IRQ
 142         */
 143        if (!irq) {
 144                ap->flags |= ATA_FLAG_PIO_POLLING;
 145                ata_port_desc(ap, "no IRQ, using PIO polling");
 146        }
 147
 148        /*
 149         * Handle the MMIO case
 150         */
 151        if (mmio) {
 152                ap->ioaddr.cmd_addr = devm_ioremap(dev, io_res->start,
 153                                resource_size(io_res));
 154                ap->ioaddr.ctl_addr = devm_ioremap(dev, ctl_res->start,
 155                                resource_size(ctl_res));
 156        } else {
 157                ap->ioaddr.cmd_addr = devm_ioport_map(dev, io_res->start,
 158                                resource_size(io_res));
 159                ap->ioaddr.ctl_addr = devm_ioport_map(dev, ctl_res->start,
 160                                resource_size(ctl_res));
 161        }
 162        if (!ap->ioaddr.cmd_addr || !ap->ioaddr.ctl_addr) {
 163                dev_err(dev, "failed to map IO/CTL base\n");
 164                return -ENOMEM;
 165        }
 166
 167        ap->ioaddr.altstatus_addr = ap->ioaddr.ctl_addr;
 168
 169        pata_platform_setup_port(&ap->ioaddr, ioport_shift);
 170
 171        ata_port_desc(ap, "%s cmd 0x%llx ctl 0x%llx", mmio ? "mmio" : "ioport",
 172                      (unsigned long long)io_res->start,
 173                      (unsigned long long)ctl_res->start);
 174
 175        /* activate */
 176        return ata_host_activate(host, irq, irq ? ata_sff_interrupt : NULL,
 177                                 irq_flags, &pata_platform_sht);
 178}
 179EXPORT_SYMBOL_GPL(__pata_platform_probe);
 180
 181/**
 182 *      __pata_platform_remove          -       unplug a platform interface
 183 *      @dev: device
 184 *
 185 *      A platform bus ATA device has been unplugged. Perform the needed
 186 *      cleanup. Also called on module unload for any active devices.
 187 */
 188int __pata_platform_remove(struct device *dev)
 189{
 190        struct ata_host *host = dev_get_drvdata(dev);
 191
 192        ata_host_detach(host);
 193
 194        return 0;
 195}
 196EXPORT_SYMBOL_GPL(__pata_platform_remove);
 197
 198static int __devinit pata_platform_probe(struct platform_device *pdev)
 199{
 200        struct resource *io_res;
 201        struct resource *ctl_res;
 202        struct resource *irq_res;
 203        struct pata_platform_info *pp_info = pdev->dev.platform_data;
 204
 205        /*
 206         * Simple resource validation ..
 207         */
 208        if ((pdev->num_resources != 3) && (pdev->num_resources != 2)) {
 209                dev_err(&pdev->dev, "invalid number of resources\n");
 210                return -EINVAL;
 211        }
 212
 213        /*
 214         * Get the I/O base first
 215         */
 216        io_res = platform_get_resource(pdev, IORESOURCE_IO, 0);
 217        if (io_res == NULL) {
 218                io_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 219                if (unlikely(io_res == NULL))
 220                        return -EINVAL;
 221        }
 222
 223        /*
 224         * Then the CTL base
 225         */
 226        ctl_res = platform_get_resource(pdev, IORESOURCE_IO, 1);
 227        if (ctl_res == NULL) {
 228                ctl_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
 229                if (unlikely(ctl_res == NULL))
 230                        return -EINVAL;
 231        }
 232
 233        /*
 234         * And the IRQ
 235         */
 236        irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
 237        if (irq_res)
 238                irq_res->flags = pp_info ? pp_info->irq_flags : 0;
 239
 240        return __pata_platform_probe(&pdev->dev, io_res, ctl_res, irq_res,
 241                                     pp_info ? pp_info->ioport_shift : 0,
 242                                     pio_mask);
 243}
 244
 245static int __devexit pata_platform_remove(struct platform_device *pdev)
 246{
 247        return __pata_platform_remove(&pdev->dev);
 248}
 249
 250static struct platform_driver pata_platform_driver = {
 251        .probe          = pata_platform_probe,
 252        .remove         = __devexit_p(pata_platform_remove),
 253        .driver = {
 254                .name           = DRV_NAME,
 255                .owner          = THIS_MODULE,
 256        },
 257};
 258
 259static int __init pata_platform_init(void)
 260{
 261        return platform_driver_register(&pata_platform_driver);
 262}
 263
 264static void __exit pata_platform_exit(void)
 265{
 266        platform_driver_unregister(&pata_platform_driver);
 267}
 268module_init(pata_platform_init);
 269module_exit(pata_platform_exit);
 270
 271module_param(pio_mask, int, 0);
 272
 273MODULE_AUTHOR("Paul Mundt");
 274MODULE_DESCRIPTION("low-level driver for platform device ATA");
 275MODULE_LICENSE("GPL");
 276MODULE_VERSION(DRV_VERSION);
 277MODULE_ALIAS("platform:" DRV_NAME);
 278