drivers/ide/at91_ide.c

   1 /*
   2  * IDE host driver for AT91 (SAM9, CAP9, AT572D940HF) Static Memory Controller
   3  * with Compact Flash True IDE logic
   4  *
   5  * Copyright (c) 2008, 2009 Kelvatek Ltd.
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  */
  22
  23 #include <linux/version.h>
  24 #include <linux/kernel.h>
  25 #include <linux/module.h>
  26 #include <linux/clk.h>
  27 #include <linux/err.h>
  28 #include <linux/ide.h>
  29 #include <linux/platform_device.h>
  30
  31 #include <mach/board.h>
  32 #include <mach/gpio.h>
  33 #include <mach/at91sam9263.h>
  34 #include <mach/at91sam9_smc.h>
  35 #include <mach/at91sam9263_matrix.h>
  36
  37 #define DRV_NAME "at91_ide"
  38
  39 #define perr(fmt, args...) pr_err(DRV_NAME ": " fmt, ##args)
  40 #define pdbg(fmt, args...) pr_debug("%s " fmt, __func__, ##args)
  41
  42 /*
  43  * Access to IDE device is possible through EBI Static Memory Controller
  44  * with Compact Flash logic. For details see EBI and SMC datasheet sections
  45  * of any microcontroller from AT91SAM9 family.
  46  *
  47  * Within SMC chip select address space, lines A[23:21] distinguish Compact
  48  * Flash modes (I/O, common memory, attribute memory, True IDE). IDE modes are:
  49  *   0x00c0000 - True IDE
  50  *   0x00e0000 - Alternate True IDE (Alt Status Register)
  51  *
  52  * On True IDE mode Task File and Data Register are mapped at the same address.
  53  * To distinguish access between these two different bus data width is used:
  54  * 8Bit for Task File, 16Bit for Data I/O.
  55  *
  56  * After initialization we do 8/16 bit flipping (changes in SMC MODE register)
  57  * only inside IDE callback routines which are serialized by IDE layer,
  58  * so no additional locking needed.
  59  */
  60
  61 #define TASK_FILE       0x00c00000
  62 #define ALT_MODE        0x00e00000
  63 #define REGS_SIZE       8
  64
  65 #define enter_16bit(cs, mode) do {                                      \
  66         mode = at91_sys_read(AT91_SMC_MODE(cs));                        \
  67         at91_sys_write(AT91_SMC_MODE(cs), mode | AT91_SMC_DBW_16);      \
  68 } while (0)
  69
  70 #define leave_16bit(cs, mode) at91_sys_write(AT91_SMC_MODE(cs), mode);
  71
  72 static void set_smc_timings(const u8 chipselect, const u16 cycle,
  73                             const u16 setup, const u16 pulse,
  74                             const u16 data_float, int use_iordy)
  75 {
  76         unsigned long mode = AT91_SMC_READMODE | AT91_SMC_WRITEMODE |
  77                              AT91_SMC_BAT_SELECT;
  78
  79         /* disable or enable waiting for IORDY signal */
  80         if (use_iordy)
  81                 mode |= AT91_SMC_EXNWMODE_READY;
  82
  83         /* add data float cycles if needed */
  84         if (data_float)
  85                 mode |= AT91_SMC_TDF_(data_float);
  86
  87         at91_sys_write(AT91_SMC_MODE(chipselect), mode);
  88
  89         /* setup timings in SMC */
  90         at91_sys_write(AT91_SMC_SETUP(chipselect), AT91_SMC_NWESETUP_(setup) |
  91                                                    AT91_SMC_NCS_WRSETUP_(0) |
  92                                                    AT91_SMC_NRDSETUP_(setup) |
  93                                                    AT91_SMC_NCS_RDSETUP_(0));
  94         at91_sys_write(AT91_SMC_PULSE(chipselect), AT91_SMC_NWEPULSE_(pulse) |
  95                                                    AT91_SMC_NCS_WRPULSE_(cycle) |
  96                                                    AT91_SMC_NRDPULSE_(pulse) |
  97                                                    AT91_SMC_NCS_RDPULSE_(cycle));
  98         at91_sys_write(AT91_SMC_CYCLE(chipselect), AT91_SMC_NWECYCLE_(cycle) |
  99                                                    AT91_SMC_NRDCYCLE_(cycle));
 100 }
 101
 102 static unsigned int calc_mck_cycles(unsigned int ns, unsigned int mck_hz)
 103 {
 104         u64 tmp = ns;
 105
 106         tmp *= mck_hz;
 107         tmp += 1000*1000*1000 - 1; /* round up */
 108         do_div(tmp, 1000*1000*1000);
 109         return (unsigned int) tmp;
 110 }
 111
 112 static void apply_timings(const u8 chipselect, const u8 pio,
 113                           const struct ide_timing *timing, int use_iordy)
 114 {
 115         unsigned int t0, t1, t2, t6z;
 116         unsigned int cycle, setup, pulse, data_float;
 117         unsigned int mck_hz;
 118         struct clk *mck;
 119
 120         /* see table 22 of Compact Flash standard 4.1 for the meaning,
 121          * we do not stretch active (t2) time, so setup (t1) + hold time (th)
 122          * assure at least minimal recovery (t2i) time */
 123         t0 = timing->cyc8b;
 124         t1 = timing->setup;
 125         t2 = timing->act8b;
 126         t6z = (pio < 5) ? 30 : 20;
 127
 128         pdbg("t0=%u t1=%u t2=%u t6z=%u\n", t0, t1, t2, t6z);
 129
 130         mck = clk_get(NULL, "mck");
 131         BUG_ON(IS_ERR(mck));
 132         mck_hz = clk_get_rate(mck);
 133         pdbg("mck_hz=%u\n", mck_hz);
 134
 135         cycle = calc_mck_cycles(t0, mck_hz);
 136         setup = calc_mck_cycles(t1, mck_hz);
 137         pulse = calc_mck_cycles(t2, mck_hz);
 138         data_float = calc_mck_cycles(t6z, mck_hz);
 139
 140         pdbg("cycle=%u setup=%u pulse=%u data_float=%u\n",
 141              cycle, setup, pulse, data_float);
 142
 143         set_smc_timings(chipselect, cycle, setup, pulse, data_float, use_iordy);
 144 }
 145
 146 static void at91_ide_input_data(ide_drive_t *drive, struct ide_cmd *cmd,
 147                                 void *buf, unsigned int len)
 148 {
 149         ide_hwif_t *hwif = drive->hwif;
 150         struct ide_io_ports *io_ports = &hwif->io_ports;
 151         u8 chipselect = hwif->select_data;
 152         unsigned long mode;
 153
 154         pdbg("cs %u buf %p len %d\n", chipselect, buf, len);
 155
 156         len++;
 157
 158         enter_16bit(chipselect, mode);
 159         readsw((void __iomem *)io_ports->data_addr, buf, len / 2);
 160         leave_16bit(chipselect, mode);
 161 }
 162
 163 static void at91_ide_output_data(ide_drive_t *drive, struct ide_cmd *cmd,
 164                                  void *buf, unsigned int len)
 165 {
 166         ide_hwif_t *hwif = drive->hwif;
 167         struct ide_io_ports *io_ports = &hwif->io_ports;
 168         u8 chipselect = hwif->select_data;
 169         unsigned long mode;
 170
 171         pdbg("cs %u buf %p len %d\n", chipselect,  buf, len);
 172
 173         enter_16bit(chipselect, mode);
 174         writesw((void __iomem *)io_ports->data_addr, buf, len / 2);
 175         leave_16bit(chipselect, mode);
 176 }
 177
 178 static u8 ide_mm_inb(unsigned long port)
 179 {
 180         return readb((void __iomem *) port);
 181 }
 182
 183 static void ide_mm_outb(u8 value, unsigned long port)
 184 {
 185         writeb(value, (void __iomem *) port);
 186 }
 187
 188 static void at91_ide_tf_load(ide_drive_t *drive, struct ide_cmd *cmd)
 189 {
 190         ide_hwif_t *hwif = drive->hwif;
 191         struct ide_io_ports *io_ports = &hwif->io_ports;
 192         struct ide_taskfile *tf = &cmd->tf;
 193         u8 HIHI = (cmd->tf_flags & IDE_TFLAG_LBA48) ? 0xE0 : 0xEF;
 194
 195         if (cmd->ftf_flags & IDE_FTFLAG_FLAGGED)
 196                 HIHI = 0xFF;
 197
 198         if (cmd->tf_flags & IDE_TFLAG_OUT_HOB_FEATURE)
 199                 ide_mm_outb(tf->hob_feature, io_ports->feature_addr);
 200         if (cmd->tf_flags & IDE_TFLAG_OUT_HOB_NSECT)
 201                 ide_mm_outb(tf->hob_nsect, io_ports->nsect_addr);
 202         if (cmd->tf_flags & IDE_TFLAG_OUT_HOB_LBAL)
 203                 ide_mm_outb(tf->hob_lbal, io_ports->lbal_addr);
 204         if (cmd->tf_flags & IDE_TFLAG_OUT_HOB_LBAM)
 205                 ide_mm_outb(tf->hob_lbam, io_ports->lbam_addr);
 206         if (cmd->tf_flags & IDE_TFLAG_OUT_HOB_LBAH)
 207                 ide_mm_outb(tf->hob_lbah, io_ports->lbah_addr);
 208
 209         if (cmd->tf_flags & IDE_TFLAG_OUT_FEATURE)
 210                 ide_mm_outb(tf->feature, io_ports->feature_addr);
 211         if (cmd->tf_flags & IDE_TFLAG_OUT_NSECT)
 212                 ide_mm_outb(tf->nsect, io_ports->nsect_addr);
 213         if (cmd->tf_flags & IDE_TFLAG_OUT_LBAL)
 214                 ide_mm_outb(tf->lbal, io_ports->lbal_addr);
 215         if (cmd->tf_flags & IDE_TFLAG_OUT_LBAM)
 216                 ide_mm_outb(tf->lbam, io_ports->lbam_addr);
 217         if (cmd->tf_flags & IDE_TFLAG_OUT_LBAH)
 218                 ide_mm_outb(tf->lbah, io_ports->lbah_addr);
 219
 220         if (cmd->tf_flags & IDE_TFLAG_OUT_DEVICE)
 221                 ide_mm_outb((tf->device & HIHI) | drive->select, io_ports->device_addr);
 222 }
 223
 224 static void at91_ide_tf_read(ide_drive_t *drive, struct ide_cmd *cmd)
 225 {
 226         ide_hwif_t *hwif = drive->hwif;
 227         struct ide_io_ports *io_ports = &hwif->io_ports;
 228         struct ide_taskfile *tf = &cmd->tf;
 229
 230         /* be sure we're looking at the low order bits */
 231         ide_mm_outb(ATA_DEVCTL_OBS, io_ports->ctl_addr);
 232
 233         if (cmd->tf_flags & IDE_TFLAG_IN_ERROR)
 234                 tf->error  = ide_mm_inb(io_ports->feature_addr);
 235         if (cmd->tf_flags & IDE_TFLAG_IN_NSECT)
 236                 tf->nsect  = ide_mm_inb(io_ports->nsect_addr);
 237         if (cmd->tf_flags & IDE_TFLAG_IN_LBAL)
 238                 tf->lbal   = ide_mm_inb(io_ports->lbal_addr);
 239         if (cmd->tf_flags & IDE_TFLAG_IN_LBAM)
 240                 tf->lbam   = ide_mm_inb(io_ports->lbam_addr);
 241         if (cmd->tf_flags & IDE_TFLAG_IN_LBAH)
 242                 tf->lbah   = ide_mm_inb(io_ports->lbah_addr);
 243         if (cmd->tf_flags & IDE_TFLAG_IN_DEVICE)
 244                 tf->device = ide_mm_inb(io_ports->device_addr);
 245
 246         if (cmd->tf_flags & IDE_TFLAG_LBA48) {
 247                 ide_mm_outb(ATA_HOB | ATA_DEVCTL_OBS, io_ports->ctl_addr);
 248
 249                 if (cmd->tf_flags & IDE_TFLAG_IN_HOB_ERROR)
 250                         tf->hob_error = ide_mm_inb(io_ports->feature_addr);
 251                 if (cmd->tf_flags & IDE_TFLAG_IN_HOB_NSECT)
 252                         tf->hob_nsect = ide_mm_inb(io_ports->nsect_addr);
 253                 if (cmd->tf_flags & IDE_TFLAG_IN_HOB_LBAL)
 254                         tf->hob_lbal  = ide_mm_inb(io_ports->lbal_addr);
 255                 if (cmd->tf_flags & IDE_TFLAG_IN_HOB_LBAM)
 256                         tf->hob_lbam  = ide_mm_inb(io_ports->lbam_addr);
 257                 if (cmd->tf_flags & IDE_TFLAG_IN_HOB_LBAH)
 258                         tf->hob_lbah  = ide_mm_inb(io_ports->lbah_addr);
 259         }
 260 }
 261
 262 static void at91_ide_set_pio_mode(ide_drive_t *drive, const u8 pio)
 263 {
 264         struct ide_timing *timing;
 265         u8 chipselect = drive->hwif->select_data;
 266         int use_iordy = 0;
 267
 268         pdbg("chipselect %u pio %u\n", chipselect, pio);
 269
 270         timing = ide_timing_find_mode(XFER_PIO_0 + pio);
 271         BUG_ON(!timing);
 272
 273         if ((pio > 2 || ata_id_has_iordy(drive->id)) &&
 274             !(ata_id_is_cfa(drive->id) && pio > 4))
 275                 use_iordy = 1;
 276
 277         apply_timings(chipselect, pio, timing, use_iordy);
 278 }
 279
 280 static const struct ide_tp_ops at91_ide_tp_ops = {
 281         .exec_command   = ide_exec_command,
 282         .read_status    = ide_read_status,
 283         .read_altstatus = ide_read_altstatus,
 284         .write_devctl   = ide_write_devctl,
 285
 286         .dev_select     = ide_dev_select,
 287         .tf_load        = at91_ide_tf_load,
 288         .tf_read        = at91_ide_tf_read,
 289
 290         .input_data     = at91_ide_input_data,
 291         .output_data    = at91_ide_output_data,
 292 };
 293
 294 static const struct ide_port_ops at91_ide_port_ops = {
 295         .set_pio_mode   = at91_ide_set_pio_mode,
 296 };
 297
 298 static const struct ide_port_info at91_ide_port_info __initdata = {
 299         .port_ops       = &at91_ide_port_ops,
 300         .tp_ops         = &at91_ide_tp_ops,
 301         .host_flags     = IDE_HFLAG_MMIO | IDE_HFLAG_NO_DMA | IDE_HFLAG_SINGLE |
 302                           IDE_HFLAG_NO_IO_32BIT | IDE_HFLAG_UNMASK_IRQS,
 303         .pio_mask       = ATA_PIO5,
 304 };
 305
 306 /*
 307  * If interrupt is delivered through GPIO, IRQ are triggered on falling
 308  * and rising edge of signal. Whereas IDE device request interrupt on high
 309  * level (rising edge in our case). This mean we have fake interrupts, so
 310  * we need to check interrupt pin and exit instantly from ISR when line
 311  * is on low level.
 312  */
 313
 314 irqreturn_t at91_irq_handler(int irq, void *dev_id)
 315 {
 316         int ntries = 8;
 317         int pin_val1, pin_val2;
 318
 319         /* additional deglitch, line can be noisy in badly designed PCB */
 320         do {
 321                 pin_val1 = at91_get_gpio_value(irq);
 322                 pin_val2 = at91_get_gpio_value(irq);
 323         } while (pin_val1 != pin_val2 && --ntries > 0);
 324
 325         if (pin_val1 == 0 || ntries <= 0)
 326                 return IRQ_HANDLED;
 327
 328         return ide_intr(irq, dev_id);
 329 }
 330
 331 static int __init at91_ide_probe(struct platform_device *pdev)
 332 {
 333         int ret;
 334         hw_regs_t hw;
 335         hw_regs_t *hws[] = { &hw, NULL, NULL, NULL };
 336         struct ide_host *host;
 337         struct resource *res;
 338         unsigned long tf_base = 0, ctl_base = 0;
 339         struct at91_cf_data *board = pdev->dev.platform_data;
 340
 341         if (!board)
 342                 return -ENODEV;
 343
 344         if (board->det_pin && at91_get_gpio_value(board->det_pin) != 0) {
 345                 perr("no device detected\n");
 346                 return -ENODEV;
 347         }
 348
 349         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 350         if (!res) {
 351                 perr("can't get memory resource\n");
 352                 return -ENODEV;
 353         }
 354
 355         if (!devm_request_mem_region(&pdev->dev, res->start + TASK_FILE,
 356                                      REGS_SIZE, "ide") ||
 357             !devm_request_mem_region(&pdev->dev, res->start + ALT_MODE,
 358                                      REGS_SIZE, "alt")) {
 359                 perr("memory resources in use\n");
 360                 return -EBUSY;
 361         }
 362
 363         pdbg("chipselect %u irq %u res %08lx\n", board->chipselect,
 364              board->irq_pin, (unsigned long) res->start);
 365
 366         tf_base = (unsigned long) devm_ioremap(&pdev->dev, res->start + TASK_FILE,
 367                                                REGS_SIZE);
 368         ctl_base = (unsigned long) devm_ioremap(&pdev->dev, res->start + ALT_MODE,
 369                                                 REGS_SIZE);
 370         if (!tf_base || !ctl_base) {
 371                 perr("can't map memory regions\n");
 372                 return -EBUSY;
 373         }
 374
 375         memset(&hw, 0, sizeof(hw));
 376
 377         if (board->flags & AT91_IDE_SWAP_A0_A2) {
 378                 /* workaround for stupid hardware bug */
 379                 hw.io_ports.data_addr   = tf_base + 0;
 380                 hw.io_ports.error_addr  = tf_base + 4;
 381                 hw.io_ports.nsect_addr  = tf_base + 2;
 382                 hw.io_ports.lbal_addr   = tf_base + 6;
 383                 hw.io_ports.lbam_addr   = tf_base + 1;
 384                 hw.io_ports.lbah_addr   = tf_base + 5;
 385                 hw.io_ports.device_addr = tf_base + 3;
 386                 hw.io_ports.command_addr = tf_base + 7;
 387                 hw.io_ports.ctl_addr    = ctl_base + 3;
 388         } else
 389                 ide_std_init_ports(&hw, tf_base, ctl_base + 6);
 390
 391         hw.irq = board->irq_pin;
 392         hw.chipset = ide_generic;
 393         hw.dev = &pdev->dev;
 394
 395         host = ide_host_alloc(&at91_ide_port_info, hws);
 396         if (!host) {
 397                 perr("failed to allocate ide host\n");
 398                 return -ENOMEM;
 399         }
 400
 401         /* setup Static Memory Controller - PIO 0 as default */
 402         apply_timings(board->chipselect, 0, ide_timing_find_mode(XFER_PIO_0), 0);
 403
 404         /* with GPIO interrupt we have to do quirks in handler */
 405         if (board->irq_pin >= PIN_BASE)
 406                 host->irq_handler = at91_irq_handler;
 407
 408         host->ports[0]->select_data = board->chipselect;
 409
 410         ret = ide_host_register(host, &at91_ide_port_info, hws);
 411         if (ret) {
 412                 perr("failed to register ide host\n");
 413                 goto err_free_host;
 414         }
 415         platform_set_drvdata(pdev, host);
 416         return 0;
 417
 418 err_free_host:
 419         ide_host_free(host);
 420         return ret;
 421 }
 422
 423 static int __exit at91_ide_remove(struct platform_device *pdev)
 424 {
 425         struct ide_host *host = platform_get_drvdata(pdev);
 426
 427         ide_host_remove(host);
 428         return 0;
 429 }
 430
 431 static struct platform_driver at91_ide_driver = {
 432         .driver = {
 433                 .name = DRV_NAME,
 434                 .owner = THIS_MODULE,
 435         },
 436         .remove = __exit_p(at91_ide_remove),
 437 };
 438
 439 static int __init at91_ide_init(void)
 440 {
 441         return platform_driver_probe(&at91_ide_driver, at91_ide_probe);
 442 }
 443
 444 static void __exit at91_ide_exit(void)
 445 {
 446         platform_driver_unregister(&at91_ide_driver);
 447 }
 448
 449 module_init(at91_ide_init);
 450 module_exit(at91_ide_exit);
 451
 452 MODULE_LICENSE("GPL");
 453 MODULE_AUTHOR("Stanislaw Gruszka <stf_xl@wp.pl>");
 454