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