drivers/ata/pata_rb500_cf.c

   1 /*
   2  *  A low-level PATA driver to handle a Compact Flash connected on the
   3  *  Mikrotik's RouterBoard 532 board.
   4  *
   5  *  Copyright (C) 2007 Gabor Juhos <juhosg at openwrt.org>
   6  *  Copyright (C) 2008 Florian Fainelli <florian@openwrt.org>
   7  *
   8  *  This file was based on: drivers/ata/pata_ixp4xx_cf.c
   9  *      Copyright (C) 2006-07 Tower Technologies
  10  *      Author: Alessandro Zummo <a.zummo@towertech.it>
  11  *
  12  *  Also was based on the driver for Linux 2.4.xx published by Mikrotik for
  13  *  their RouterBoard 1xx and 5xx series devices. The original Mikrotik code
  14  *  seems not to have a license.
  15  *
  16  *  This program is free software; you can redistribute it and/or modify
  17  *  it under the terms of the GNU General Public License version 2 as
  18  *  published by the Free Software Foundation.
  19  *
  20  */
  21
  22 #include <linux/kernel.h>
  23 #include <linux/module.h>
  24 #include <linux/platform_device.h>
  25
  26 #include <linux/io.h>
  27 #include <linux/interrupt.h>
  28 #include <linux/irq.h>
  29
  30 #include <linux/libata.h>
  31 #include <scsi/scsi_host.h>
  32
  33 #include <asm/gpio.h>
  34
  35 #define DRV_NAME        "pata-rb500-cf"
  36 #define DRV_VERSION     "0.1.0"
  37 #define DRV_DESC        "PATA driver for RouterBOARD 532 Compact Flash"
  38
  39 #define RB500_CF_MAXPORTS       1
  40 #define RB500_CF_IO_DELAY       400
  41
  42 #define RB500_CF_REG_CMD        0x0800
  43 #define RB500_CF_REG_CTRL       0x080E
  44 #define RB500_CF_REG_DATA       0x0C00
  45
  46 struct rb500_cf_info {
  47         void __iomem    *iobase;
  48         unsigned int    gpio_line;
  49         int             frozen;
  50         unsigned int    irq;
  51 };
  52
  53 /* ------------------------------------------------------------------------ */
  54
  55 static inline void rb500_pata_finish_io(struct ata_port *ap)
  56 {
  57         struct ata_host *ah = ap->host;
  58         struct rb500_cf_info *info = ah->private_data;
  59
  60         ata_altstatus(ap);
  61         ndelay(RB500_CF_IO_DELAY);
  62
  63         set_irq_type(info->irq, IRQ_TYPE_LEVEL_HIGH);
  64 }
  65
  66 static void rb500_pata_exec_command(struct ata_port *ap,
  67                                 const struct ata_taskfile *tf)
  68 {
  69         writeb(tf->command, ap->ioaddr.command_addr);
  70         rb500_pata_finish_io(ap);
  71 }
  72
  73 static void rb500_pata_data_xfer(struct ata_device *adev, unsigned char *buf,
  74                                 unsigned int buflen, int write_data)
  75 {
  76         struct ata_port *ap = adev->link->ap;
  77         void __iomem *ioaddr = ap->ioaddr.data_addr;
  78
  79         if (write_data) {
  80                 for (; buflen > 0; buflen--, buf++)
  81                         writeb(*buf, ioaddr);
  82         } else {
  83                 for (; buflen > 0; buflen--, buf++)
  84                         *buf = readb(ioaddr);
  85         }
  86
  87         rb500_pata_finish_io(adev->link->ap);
  88 }
  89
  90 static void rb500_pata_freeze(struct ata_port *ap)
  91 {
  92         struct rb500_cf_info *info = ap->host->private_data;
  93
  94         info->frozen = 1;
  95 }
  96
  97 static void rb500_pata_thaw(struct ata_port *ap)
  98 {
  99         struct rb500_cf_info *info = ap->host->private_data;
 100
 101         info->frozen = 0;
 102 }
 103
 104 static irqreturn_t rb500_pata_irq_handler(int irq, void *dev_instance)
 105 {
 106         struct ata_host *ah = dev_instance;
 107         struct rb500_cf_info *info = ah->private_data;
 108
 109         if (gpio_get_value(info->gpio_line)) {
 110                 set_irq_type(info->irq, IRQ_TYPE_LEVEL_LOW);
 111                 if (!info->frozen)
 112                         ata_interrupt(info->irq, dev_instance);
 113         } else {
 114                 set_irq_type(info->irq, IRQ_TYPE_LEVEL_HIGH);
 115         }
 116
 117         return IRQ_HANDLED;
 118 }
 119
 120 static void rb500_pata_irq_clear(struct ata_port *ap)
 121 {
 122 }
 123
 124 static int rb500_pata_port_start(struct ata_port *ap)
 125 {
 126         return 0;
 127 }
 128
 129 static struct ata_port_operations rb500_pata_port_ops = {
 130         .tf_load                = ata_tf_load,
 131         .tf_read                = ata_tf_read,
 132
 133         .exec_command           = rb500_pata_exec_command,
 134         .check_status           = ata_check_status,
 135         .dev_select             = ata_std_dev_select,
 136
 137         .data_xfer              = rb500_pata_data_xfer,
 138
 139         .qc_prep                = ata_qc_prep,
 140         .qc_issue               = ata_qc_issue_prot,
 141
 142         .freeze                 = rb500_pata_freeze,
 143         .thaw                   = rb500_pata_thaw,
 144         .error_handler          = ata_bmdma_error_handler,
 145
 146         .irq_handler            = rb500_pata_irq_handler,
 147         .irq_clear              = rb500_pata_irq_clear,
 148         .irq_on                 = ata_irq_on,
 149
 150         .port_start             = rb500_pata_port_start,
 151 };
 152
 153 /* ------------------------------------------------------------------------ */
 154
 155 static struct scsi_host_template rb500_pata_sht = {
 156         .module                 = THIS_MODULE,
 157         .name                   = DRV_NAME,
 158         .ioctl                  = ata_scsi_ioctl,
 159         .queuecommand           = ata_scsi_queuecmd,
 160         .slave_configure        = ata_scsi_slave_config,
 161         .slave_destroy          = ata_scsi_slave_destroy,
 162         .bios_param             = ata_std_bios_param,
 163         .proc_name              = DRV_NAME,
 164
 165         .can_queue              = ATA_DEF_QUEUE,
 166         .this_id                = ATA_SHT_THIS_ID,
 167         .sg_tablesize           = LIBATA_MAX_PRD,
 168         .dma_boundary           = ATA_DMA_BOUNDARY,
 169         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
 170         .emulated               = ATA_SHT_EMULATED,
 171         .use_clustering         = ATA_SHT_USE_CLUSTERING,
 172 };
 173
 174 /* ------------------------------------------------------------------------ */
 175
 176 static void rb500_pata_setup_ports(struct ata_host *ah)
 177 {
 178         struct rb500_cf_info *info = ah->private_data;
 179         struct ata_port *ap;
 180
 181         ap = ah->ports[0];
 182
 183         ap->ops         = &rb500_pata_port_ops;
 184         ap->pio_mask    = 0x1f; /* PIO4 */
 185         ap->flags       = ATA_FLAG_NO_LEGACY | ATA_FLAG_MMIO;
 186
 187         ap->ioaddr.cmd_addr     = info->iobase + RB500_CF_REG_CMD;
 188         ap->ioaddr.ctl_addr     = info->iobase + RB500_CF_REG_CTRL;
 189         ap->ioaddr.altstatus_addr = info->iobase + RB500_CF_REG_CTRL;
 190
 191         ata_std_ports(&ap->ioaddr);
 192
 193         ap->ioaddr.data_addr    = info->iobase + RB500_CF_REG_DATA;
 194 }
 195
 196 static __devinit int rb500_pata_driver_probe(struct platform_device *pdev)
 197 {
 198         unsigned int irq;
 199         int gpio;
 200         struct resource *res;
 201         struct ata_host *ah;
 202         struct rb500_cf_info *info;
 203         int ret;
 204
 205         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 206         if (!res) {
 207                 dev_err(&pdev->dev, "no IOMEM resource found\n");
 208                 return -EINVAL;
 209         }
 210
 211         irq = platform_get_irq(pdev, 0);
 212         if (irq <= 0) {
 213                 dev_err(&pdev->dev, "no IRQ resource found\n");
 214                 return -ENOENT;
 215         }
 216
 217         gpio = irq_to_gpio(irq);
 218         if (gpio < 0) {
 219                 dev_err(&pdev->dev, "no GPIO found for irq%d\n", irq);
 220                 return -ENOENT;
 221         }
 222
 223         ret = gpio_request(gpio, DRV_NAME);
 224         if (ret) {
 225                 dev_err(&pdev->dev, "GPIO request failed\n");
 226                 return ret;
 227         }
 228
 229         /* allocate host */
 230         ah = ata_host_alloc(&pdev->dev, RB500_CF_MAXPORTS);
 231         if (!ah)
 232                 return -ENOMEM;
 233
 234         platform_set_drvdata(pdev, ah);
 235
 236         info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
 237         if (!info)
 238                 return -ENOMEM;
 239
 240         ah->private_data = info;
 241         info->gpio_line = gpio;
 242         info->irq = irq;
 243
 244         info->iobase = devm_ioremap_nocache(&pdev->dev, res->start,
 245                                 res->end - res->start + 1);
 246         if (!info->iobase)
 247                 return -ENOMEM;
 248
 249         ret = gpio_direction_input(gpio);
 250         if (ret) {
 251                 dev_err(&pdev->dev, "unable to set GPIO direction, err=%d\n",
 252                                 ret);
 253                 goto err_free_gpio;
 254         }
 255
 256         rb500_pata_setup_ports(ah);
 257
 258         ret = ata_host_activate(ah, irq, rb500_pata_irq_handler,
 259                                 IRQF_TRIGGER_LOW, &rb500_pata_sht);
 260         if (ret)
 261                 goto err_free_gpio;
 262
 263         return 0;
 264
 265 err_free_gpio:
 266         gpio_free(gpio);
 267
 268         return ret;
 269 }
 270
 271 static __devexit int rb500_pata_driver_remove(struct platform_device *pdev)
 272 {
 273         struct ata_host *ah = platform_get_drvdata(pdev);
 274         struct rb500_cf_info *info = ah->private_data;
 275
 276         ata_host_detach(ah);
 277         gpio_free(info->gpio_line);
 278
 279         return 0;
 280 }
 281
 282 static struct platform_driver rb500_pata_platform_driver = {
 283         .probe          = rb500_pata_driver_probe,
 284         .remove         = __devexit_p(rb500_pata_driver_remove),
 285         .driver  = {
 286                 .name   = DRV_NAME,
 287                 .owner  = THIS_MODULE,
 288         },
 289 };
 290
 291 /* ------------------------------------------------------------------------ */
 292
 293 #define DRV_INFO DRV_DESC " version " DRV_VERSION
 294
 295 static int __init rb500_pata_module_init(void)
 296 {
 297         printk(KERN_INFO DRV_INFO "\n");
 298
 299         return platform_driver_register(&rb500_pata_platform_driver);
 300 }
 301
 302 static void __exit rb500_pata_module_exit(void)
 303 {
 304         platform_driver_unregister(&rb500_pata_platform_driver);
 305 }
 306
 307 MODULE_AUTHOR("Gabor Juhos <juhosg at openwrt.org>");
 308 MODULE_AUTHOR("Florian Fainelli <florian@openwrt.org>");
 309 MODULE_DESCRIPTION(DRV_DESC);
 310 MODULE_VERSION(DRV_VERSION);
 311 MODULE_LICENSE("GPL");
 312
 313 module_init(rb500_pata_module_init);
 314 module_exit(rb500_pata_module_exit);