drivers/ata/pata_platform.c

   1 /*
   2  * Generic platform device PATA driver
   3  *
   4  * Copyright (C) 2006  Paul Mundt
   5  *
   6  * Based on pata_pcmcia:
   7  *
   8  *   Copyright 2005-2006 Red Hat Inc <alan@redhat.com>, 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/pata_platform.h>
  23
  24 #define DRV_NAME "pata_platform"
  25 #define DRV_VERSION "0.1.2"
  26
  27 static 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  */
  33 static int pata_platform_set_mode(struct ata_port *ap,
  34                                 struct ata_device **r_failed_dev)
  35 {
  36         int i;
  37
  38         for (i = 0; i < ATA_MAX_DEVICES; i++) {
  39                 struct ata_device *dev = &ap->device[i];
  40
  41                 if (ata_dev_enabled(dev)) {
  42                         /* We don't really care */
  43                         dev->pio_mode = dev->xfer_mode = XFER_PIO_0;
  44                         dev->xfer_shift = ATA_SHIFT_PIO;
  45                         dev->flags |= ATA_DFLAG_PIO;
  46                 }
  47         }
  48         return 0;
  49 }
  50
  51 static void pata_platform_host_stop(struct ata_host *host)
  52 {
  53         int i;
  54
  55         /*
  56          * Unmap the bases for MMIO
  57          */
  58         for (i = 0; i < host->n_ports; i++) {
  59                 struct ata_port *ap = host->ports[i];
  60
  61                 if (ap->flags & ATA_FLAG_MMIO) {
  62                         iounmap((void __iomem *)ap->ioaddr.ctl_addr);
  63                         iounmap((void __iomem *)ap->ioaddr.cmd_addr);
  64                 }
  65         }
  66 }
  67
  68 static struct scsi_host_template pata_platform_sht = {
  69         .module                 = THIS_MODULE,
  70         .name                   = DRV_NAME,
  71         .ioctl                  = ata_scsi_ioctl,
  72         .queuecommand           = ata_scsi_queuecmd,
  73         .can_queue              = ATA_DEF_QUEUE,
  74         .this_id                = ATA_SHT_THIS_ID,
  75         .sg_tablesize           = LIBATA_MAX_PRD,
  76         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
  77         .emulated               = ATA_SHT_EMULATED,
  78         .use_clustering         = ATA_SHT_USE_CLUSTERING,
  79         .proc_name              = DRV_NAME,
  80         .dma_boundary           = ATA_DMA_BOUNDARY,
  81         .slave_configure        = ata_scsi_slave_config,
  82         .slave_destroy          = ata_scsi_slave_destroy,
  83         .bios_param             = ata_std_bios_param,
  84 };
  85
  86 static struct ata_port_operations pata_platform_port_ops = {
  87         .set_mode               = pata_platform_set_mode,
  88
  89         .port_disable           = ata_port_disable,
  90         .tf_load                = ata_tf_load,
  91         .tf_read                = ata_tf_read,
  92         .check_status           = ata_check_status,
  93         .exec_command           = ata_exec_command,
  94         .dev_select             = ata_std_dev_select,
  95
  96         .freeze                 = ata_bmdma_freeze,
  97         .thaw                   = ata_bmdma_thaw,
  98         .error_handler          = ata_bmdma_error_handler,
  99         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
 100
 101         .qc_prep                = ata_qc_prep,
 102         .qc_issue               = ata_qc_issue_prot,
 103
 104         .data_xfer              = ata_pio_data_xfer_noirq,
 105
 106         .irq_handler            = ata_interrupt,
 107         .irq_clear              = ata_bmdma_irq_clear,
 108
 109         .port_start             = ata_port_start,
 110         .port_stop              = ata_port_stop,
 111         .host_stop              = pata_platform_host_stop
 112 };
 113
 114 static void pata_platform_setup_port(struct ata_ioports *ioaddr,
 115                                      struct pata_platform_info *info)
 116 {
 117         unsigned int shift = 0;
 118
 119         /* Fixup the port shift for platforms that need it */
 120         if (info && info->ioport_shift)
 121                 shift = info->ioport_shift;
 122
 123         ioaddr->data_addr       = ioaddr->cmd_addr + (ATA_REG_DATA    << shift);
 124         ioaddr->error_addr      = ioaddr->cmd_addr + (ATA_REG_ERR     << shift);
 125         ioaddr->feature_addr    = ioaddr->cmd_addr + (ATA_REG_FEATURE << shift);
 126         ioaddr->nsect_addr      = ioaddr->cmd_addr + (ATA_REG_NSECT   << shift);
 127         ioaddr->lbal_addr       = ioaddr->cmd_addr + (ATA_REG_LBAL    << shift);
 128         ioaddr->lbam_addr       = ioaddr->cmd_addr + (ATA_REG_LBAM    << shift);
 129         ioaddr->lbah_addr       = ioaddr->cmd_addr + (ATA_REG_LBAH    << shift);
 130         ioaddr->device_addr     = ioaddr->cmd_addr + (ATA_REG_DEVICE  << shift);
 131         ioaddr->status_addr     = ioaddr->cmd_addr + (ATA_REG_STATUS  << shift);
 132         ioaddr->command_addr    = ioaddr->cmd_addr + (ATA_REG_CMD     << shift);
 133 }
 134
 135 /**
 136  *      pata_platform_probe             -       attach a platform interface
 137  *      @pdev: platform device
 138  *
 139  *      Register a platform bus IDE interface. Such interfaces are PIO and we
 140  *      assume do not support IRQ sharing.
 141  *
 142  *      Platform devices are expected to contain 3 resources per port:
 143  *
 144  *              - I/O Base (IORESOURCE_IO or IORESOURCE_MEM)
 145  *              - CTL Base (IORESOURCE_IO or IORESOURCE_MEM)
 146  *              - IRQ      (IORESOURCE_IRQ)
 147  *
 148  *      If the base resources are both mem types, the ioremap() is handled
 149  *      here. For IORESOURCE_IO, it's assumed that there's no remapping
 150  *      necessary.
 151  */
 152 static int __devinit pata_platform_probe(struct platform_device *pdev)
 153 {
 154         struct resource *io_res, *ctl_res;
 155         struct ata_probe_ent ae;
 156         unsigned int mmio;
 157         int ret;
 158
 159         /*
 160          * Simple resource validation ..
 161          */
 162         if (unlikely(pdev->num_resources != 3)) {
 163                 dev_err(&pdev->dev, "invalid number of resources\n");
 164                 return -EINVAL;
 165         }
 166
 167         /*
 168          * Get the I/O base first
 169          */
 170         io_res = platform_get_resource(pdev, IORESOURCE_IO, 0);
 171         if (io_res == NULL) {
 172                 io_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 173                 if (unlikely(io_res == NULL))
 174                         return -EINVAL;
 175         }
 176
 177         /*
 178          * Then the CTL base
 179          */
 180         ctl_res = platform_get_resource(pdev, IORESOURCE_IO, 1);
 181         if (ctl_res == NULL) {
 182                 ctl_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
 183                 if (unlikely(ctl_res == NULL))
 184                         return -EINVAL;
 185         }
 186
 187         /*
 188          * Check for MMIO
 189          */
 190         mmio = (( io_res->flags == IORESOURCE_MEM) &&
 191                 (ctl_res->flags == IORESOURCE_MEM));
 192
 193         /*
 194          * Now that that's out of the way, wire up the port..
 195          */
 196         memset(&ae, 0, sizeof(struct ata_probe_ent));
 197         INIT_LIST_HEAD(&ae.node);
 198         ae.dev = &pdev->dev;
 199         ae.port_ops = &pata_platform_port_ops;
 200         ae.sht = &pata_platform_sht;
 201         ae.n_ports = 1;
 202         ae.pio_mask = pio_mask;
 203         ae.irq = platform_get_irq(pdev, 0);
 204         ae.irq_flags = 0;
 205         ae.port_flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST;
 206
 207         /*
 208          * Handle the MMIO case
 209          */
 210         if (mmio) {
 211                 ae.port_flags |= ATA_FLAG_MMIO;
 212
 213                 ae.port[0].cmd_addr = (unsigned long)ioremap(io_res->start,
 214                                 io_res->end - io_res->start + 1);
 215                 if (unlikely(!ae.port[0].cmd_addr)) {
 216                         dev_err(&pdev->dev, "failed to remap IO base\n");
 217                         return -ENXIO;
 218                 }
 219
 220                 ae.port[0].ctl_addr = (unsigned long)ioremap(ctl_res->start,
 221                                 ctl_res->end - ctl_res->start + 1);
 222                 if (unlikely(!ae.port[0].ctl_addr)) {
 223                         dev_err(&pdev->dev, "failed to remap CTL base\n");
 224                         ret = -ENXIO;
 225                         goto bad_remap;
 226                 }
 227         } else {
 228                 ae.port[0].cmd_addr = io_res->start;
 229                 ae.port[0].ctl_addr = ctl_res->start;
 230         }
 231
 232         ae.port[0].altstatus_addr = ae.port[0].ctl_addr;
 233
 234         pata_platform_setup_port(&ae.port[0], pdev->dev.platform_data);
 235
 236         if (unlikely(ata_device_add(&ae) == 0)) {
 237                 ret = -ENODEV;
 238                 goto add_failed;
 239         }
 240
 241         return 0;
 242
 243 add_failed:
 244         if (ae.port[0].ctl_addr && mmio)
 245                 iounmap((void __iomem *)ae.port[0].ctl_addr);
 246 bad_remap:
 247         if (ae.port[0].cmd_addr && mmio)
 248                 iounmap((void __iomem *)ae.port[0].cmd_addr);
 249
 250         return ret;
 251 }
 252
 253 /**
 254  *      pata_platform_remove    -       unplug a platform interface
 255  *      @pdev: platform device
 256  *
 257  *      A platform bus ATA device has been unplugged. Perform the needed
 258  *      cleanup. Also called on module unload for any active devices.
 259  */
 260 static int __devexit pata_platform_remove(struct platform_device *pdev)
 261 {
 262         struct device *dev = &pdev->dev;
 263         struct ata_host *host = dev_get_drvdata(dev);
 264
 265         ata_host_remove(host);
 266         dev_set_drvdata(dev, NULL);
 267
 268         return 0;
 269 }
 270
 271 static struct platform_driver pata_platform_driver = {
 272         .probe          = pata_platform_probe,
 273         .remove         = __devexit_p(pata_platform_remove),
 274         .driver = {
 275                 .name           = DRV_NAME,
 276                 .owner          = THIS_MODULE,
 277         },
 278 };
 279
 280 static int __init pata_platform_init(void)
 281 {
 282         return platform_driver_register(&pata_platform_driver);
 283 }
 284
 285 static void __exit pata_platform_exit(void)
 286 {
 287         platform_driver_unregister(&pata_platform_driver);
 288 }
 289 module_init(pata_platform_init);
 290 module_exit(pata_platform_exit);
 291
 292 module_param(pio_mask, int, 0);
 293
 294 MODULE_AUTHOR("Paul Mundt");
 295 MODULE_DESCRIPTION("low-level driver for platform device ATA");
 296 MODULE_LICENSE("GPL");
 297 MODULE_VERSION(DRV_VERSION);