drivers/ata/pata_platform.c

   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 <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/ata_platform.h>
  23
  24 #define DRV_NAME "pata_platform"
  25 #define DRV_VERSION "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_link *link, struct ata_device **unused)
  34 {
  35         struct ata_device *dev;
  36
  37         ata_link_for_each_dev(dev, link) {
  38                 if (ata_dev_enabled(dev)) {
  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_printk(dev, KERN_INFO, "configured for PIO\n");
  44                 }
  45         }
  46         return 0;
  47 }
  48
  49 static int ata_dummy_ret0(struct ata_port *ap)  { return 0; }
  50
  51 static struct scsi_host_template pata_platform_sht = {
  52         .module                 = THIS_MODULE,
  53         .name                   = DRV_NAME,
  54         .ioctl                  = ata_scsi_ioctl,
  55         .queuecommand           = ata_scsi_queuecmd,
  56         .can_queue              = ATA_DEF_QUEUE,
  57         .this_id                = ATA_SHT_THIS_ID,
  58         .sg_tablesize           = LIBATA_MAX_PRD,
  59         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
  60         .emulated               = ATA_SHT_EMULATED,
  61         .use_clustering         = ATA_SHT_USE_CLUSTERING,
  62         .proc_name              = DRV_NAME,
  63         .dma_boundary           = ATA_DMA_BOUNDARY,
  64         .slave_configure        = ata_scsi_slave_config,
  65         .slave_destroy          = ata_scsi_slave_destroy,
  66         .bios_param             = ata_std_bios_param,
  67 };
  68
  69 static struct ata_port_operations pata_platform_port_ops = {
  70         .set_mode               = pata_platform_set_mode,
  71
  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         .cable_detect           = ata_cable_unknown,
  83
  84         .qc_prep                = ata_qc_prep,
  85         .qc_issue               = ata_qc_issue_prot,
  86
  87         .data_xfer              = ata_data_xfer_noirq,
  88
  89         .irq_clear              = ata_bmdma_irq_clear,
  90         .irq_on                 = ata_irq_on,
  91
  92         .port_start             = ata_dummy_ret0,
  93 };
  94
  95 static void pata_platform_setup_port(struct ata_ioports *ioaddr,
  96                                      unsigned int shift)
  97 {
  98         /* Fixup the port shift for platforms that need it */
  99         ioaddr->data_addr       = ioaddr->cmd_addr + (ATA_REG_DATA    << shift);
 100         ioaddr->error_addr      = ioaddr->cmd_addr + (ATA_REG_ERR     << shift);
 101         ioaddr->feature_addr    = ioaddr->cmd_addr + (ATA_REG_FEATURE << shift);
 102         ioaddr->nsect_addr      = ioaddr->cmd_addr + (ATA_REG_NSECT   << shift);
 103         ioaddr->lbal_addr       = ioaddr->cmd_addr + (ATA_REG_LBAL    << shift);
 104         ioaddr->lbam_addr       = ioaddr->cmd_addr + (ATA_REG_LBAM    << shift);
 105         ioaddr->lbah_addr       = ioaddr->cmd_addr + (ATA_REG_LBAH    << shift);
 106         ioaddr->device_addr     = ioaddr->cmd_addr + (ATA_REG_DEVICE  << shift);
 107         ioaddr->status_addr     = ioaddr->cmd_addr + (ATA_REG_STATUS  << shift);
 108         ioaddr->command_addr    = ioaddr->cmd_addr + (ATA_REG_CMD     << shift);
 109 }
 110
 111 /**
 112  *      __pata_platform_probe           -       attach a platform interface
 113  *      @dev: device
 114  *      @io_res: Resource representing I/O base
 115  *      @ctl_res: Resource representing CTL base
 116  *      @irq_res: Resource representing IRQ and its flags
 117  *      @ioport_shift: I/O port shift
 118  *      @__pio_mask: PIO mask
 119  *
 120  *      Register a platform bus IDE interface. Such interfaces are PIO and we
 121  *      assume do not support IRQ sharing.
 122  *
 123  *      Platform devices are expected to contain at least 2 resources per port:
 124  *
 125  *              - I/O Base (IORESOURCE_IO or IORESOURCE_MEM)
 126  *              - CTL Base (IORESOURCE_IO or IORESOURCE_MEM)
 127  *
 128  *      and optionally:
 129  *
 130  *              - IRQ      (IORESOURCE_IRQ)
 131  *
 132  *      If the base resources are both mem types, the ioremap() is handled
 133  *      here. For IORESOURCE_IO, it's assumed that there's no remapping
 134  *      necessary.
 135  *
 136  *      If no IRQ resource is present, PIO polling mode is used instead.
 137  */
 138 int __devinit __pata_platform_probe(struct device *dev,
 139                                     struct resource *io_res,
 140                                     struct resource *ctl_res,
 141                                     struct resource *irq_res,
 142                                     unsigned int ioport_shift,
 143                                     int __pio_mask)
 144 {
 145         struct ata_host *host;
 146         struct ata_port *ap;
 147         unsigned int mmio;
 148         int irq = 0;
 149         int irq_flags = 0;
 150
 151         /*
 152          * Check for MMIO
 153          */
 154         mmio = (( io_res->flags == IORESOURCE_MEM) &&
 155                 (ctl_res->flags == IORESOURCE_MEM));
 156
 157         /*
 158          * And the IRQ
 159          */
 160         if (irq_res && irq_res->start > 0) {
 161                 irq = irq_res->start;
 162                 irq_flags = irq_res->flags;
 163         }
 164
 165         /*
 166          * Now that that's out of the way, wire up the port..
 167          */
 168         host = ata_host_alloc(dev, 1);
 169         if (!host)
 170                 return -ENOMEM;
 171         ap = host->ports[0];
 172
 173         ap->ops = &pata_platform_port_ops;
 174         ap->pio_mask = __pio_mask;
 175         ap->flags |= ATA_FLAG_SLAVE_POSS;
 176
 177         /*
 178          * Use polling mode if there's no IRQ
 179          */
 180         if (!irq) {
 181                 ap->flags |= ATA_FLAG_PIO_POLLING;
 182                 ata_port_desc(ap, "no IRQ, using PIO polling");
 183         }
 184
 185         /*
 186          * Handle the MMIO case
 187          */
 188         if (mmio) {
 189                 ap->ioaddr.cmd_addr = devm_ioremap(dev, io_res->start,
 190                                 io_res->end - io_res->start + 1);
 191                 ap->ioaddr.ctl_addr = devm_ioremap(dev, ctl_res->start,
 192                                 ctl_res->end - ctl_res->start + 1);
 193         } else {
 194                 ap->ioaddr.cmd_addr = devm_ioport_map(dev, io_res->start,
 195                                 io_res->end - io_res->start + 1);
 196                 ap->ioaddr.ctl_addr = devm_ioport_map(dev, ctl_res->start,
 197                                 ctl_res->end - ctl_res->start + 1);
 198         }
 199         if (!ap->ioaddr.cmd_addr || !ap->ioaddr.ctl_addr) {
 200                 dev_err(dev, "failed to map IO/CTL base\n");
 201                 return -ENOMEM;
 202         }
 203
 204         ap->ioaddr.altstatus_addr = ap->ioaddr.ctl_addr;
 205
 206         pata_platform_setup_port(&ap->ioaddr, ioport_shift);
 207
 208         ata_port_desc(ap, "%s cmd 0x%llx ctl 0x%llx", mmio ? "mmio" : "ioport",
 209                       (unsigned long long)io_res->start,
 210                       (unsigned long long)ctl_res->start);
 211
 212         /* activate */
 213         return ata_host_activate(host, irq, irq ? ata_interrupt : NULL,
 214                                  irq_flags, &pata_platform_sht);
 215 }
 216 EXPORT_SYMBOL_GPL(__pata_platform_probe);
 217
 218 /**
 219  *      __pata_platform_remove          -       unplug a platform interface
 220  *      @dev: device
 221  *
 222  *      A platform bus ATA device has been unplugged. Perform the needed
 223  *      cleanup. Also called on module unload for any active devices.
 224  */
 225 int __devexit __pata_platform_remove(struct device *dev)
 226 {
 227         struct ata_host *host = dev_get_drvdata(dev);
 228
 229         ata_host_detach(host);
 230
 231         return 0;
 232 }
 233 EXPORT_SYMBOL_GPL(__pata_platform_remove);
 234
 235 static int __devinit pata_platform_probe(struct platform_device *pdev)
 236 {
 237         struct resource *io_res;
 238         struct resource *ctl_res;
 239         struct resource *irq_res;
 240         struct pata_platform_info *pp_info = pdev->dev.platform_data;
 241
 242         /*
 243          * Simple resource validation ..
 244          */
 245         if ((pdev->num_resources != 3) && (pdev->num_resources != 2)) {
 246                 dev_err(&pdev->dev, "invalid number of resources\n");
 247                 return -EINVAL;
 248         }
 249
 250         /*
 251          * Get the I/O base first
 252          */
 253         io_res = platform_get_resource(pdev, IORESOURCE_IO, 0);
 254         if (io_res == NULL) {
 255                 io_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 256                 if (unlikely(io_res == NULL))
 257                         return -EINVAL;
 258         }
 259
 260         /*
 261          * Then the CTL base
 262          */
 263         ctl_res = platform_get_resource(pdev, IORESOURCE_IO, 1);
 264         if (ctl_res == NULL) {
 265                 ctl_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
 266                 if (unlikely(ctl_res == NULL))
 267                         return -EINVAL;
 268         }
 269
 270         /*
 271          * And the IRQ
 272          */
 273         irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
 274         if (irq_res)
 275                 irq_res->flags = pp_info ? pp_info->irq_flags : 0;
 276
 277         return __pata_platform_probe(&pdev->dev, io_res, ctl_res, irq_res,
 278                                      pp_info ? pp_info->ioport_shift : 0,
 279                                      pio_mask);
 280 }
 281
 282 static int __devexit pata_platform_remove(struct platform_device *pdev)
 283 {
 284         return __pata_platform_remove(&pdev->dev);
 285 }
 286
 287 static struct platform_driver pata_platform_driver = {
 288         .probe          = pata_platform_probe,
 289         .remove         = __devexit_p(pata_platform_remove),
 290         .driver = {
 291                 .name           = DRV_NAME,
 292                 .owner          = THIS_MODULE,
 293         },
 294 };
 295
 296 static int __init pata_platform_init(void)
 297 {
 298         return platform_driver_register(&pata_platform_driver);
 299 }
 300
 301 static void __exit pata_platform_exit(void)
 302 {
 303         platform_driver_unregister(&pata_platform_driver);
 304 }
 305 module_init(pata_platform_init);
 306 module_exit(pata_platform_exit);
 307
 308 module_param(pio_mask, int, 0);
 309
 310 MODULE_AUTHOR("Paul Mundt");
 311 MODULE_DESCRIPTION("low-level driver for platform device ATA");
 312 MODULE_LICENSE("GPL");
 313 MODULE_VERSION(DRV_VERSION);