drivers/ata/pata_mpc52xx.c

   1 /*
   2  * drivers/ata/pata_mpc52xx.c
   3  *
   4  * libata driver for the Freescale MPC52xx on-chip IDE interface
   5  *
   6  * Copyright (C) 2006 Sylvain Munaut <tnt@246tNt.com>
   7  * Copyright (C) 2003 Mipsys - Benjamin Herrenschmidt
   8  *
   9  * This file is licensed under the terms of the GNU General Public License
  10  * version 2. This program is licensed "as is" without any warranty of any
  11  * kind, whether express or implied.
  12  */
  13
  14 #include <linux/kernel.h>
  15 #include <linux/module.h>
  16 #include <linux/slab.h>
  17 #include <linux/delay.h>
  18 #include <linux/libata.h>
  19
  20 #include <asm/types.h>
  21 #include <asm/prom.h>
  22 #include <asm/of_platform.h>
  23 #include <asm/mpc52xx.h>
  24
  25
  26 #define DRV_NAME        "mpc52xx_ata"
  27 #define DRV_VERSION     "0.1.0"
  28
  29
  30 /* Private structures used by the driver */
  31 struct mpc52xx_ata_timings {
  32         u32     pio1;
  33         u32     pio2;
  34 };
  35
  36 struct mpc52xx_ata_priv {
  37         unsigned int                    ipb_period;
  38         struct mpc52xx_ata __iomem *    ata_regs;
  39         int                             ata_irq;
  40         struct mpc52xx_ata_timings      timings[2];
  41         int                             csel;
  42 };
  43
  44
  45 /* ATAPI-4 PIO specs (in ns) */
  46 static const int ataspec_t0[5]    = {600, 383, 240, 180, 120};
  47 static const int ataspec_t1[5]    = { 70,  50,  30,  30,  25};
  48 static const int ataspec_t2_8[5]  = {290, 290, 290,  80,  70};
  49 static const int ataspec_t2_16[5] = {165, 125, 100,  80,  70};
  50 static const int ataspec_t2i[5]   = {  0,   0,   0,  70,  25};
  51 static const int ataspec_t4[5]    = { 30,  20,  15,  10,  10};
  52 static const int ataspec_ta[5]    = { 35,  35,  35,  35,  35};
  53
  54 #define CALC_CLKCYC(c,v) ((((v)+(c)-1)/(c)))
  55
  56
  57 /* Bit definitions inside the registers */
  58 #define MPC52xx_ATA_HOSTCONF_SMR        0x80000000UL /* State machine reset */
  59 #define MPC52xx_ATA_HOSTCONF_FR         0x40000000UL /* FIFO Reset */
  60 #define MPC52xx_ATA_HOSTCONF_IE         0x02000000UL /* Enable interrupt in PIO */
  61 #define MPC52xx_ATA_HOSTCONF_IORDY      0x01000000UL /* Drive supports IORDY protocol */
  62
  63 #define MPC52xx_ATA_HOSTSTAT_TIP        0x80000000UL /* Transaction in progress */
  64 #define MPC52xx_ATA_HOSTSTAT_UREP       0x40000000UL /* UDMA Read Extended Pause */
  65 #define MPC52xx_ATA_HOSTSTAT_RERR       0x02000000UL /* Read Error */
  66 #define MPC52xx_ATA_HOSTSTAT_WERR       0x01000000UL /* Write Error */
  67
  68 #define MPC52xx_ATA_FIFOSTAT_EMPTY      0x01 /* FIFO Empty */
  69
  70 #define MPC52xx_ATA_DMAMODE_WRITE       0x01 /* Write DMA */
  71 #define MPC52xx_ATA_DMAMODE_READ        0x02 /* Read DMA */
  72 #define MPC52xx_ATA_DMAMODE_UDMA        0x04 /* UDMA enabled */
  73 #define MPC52xx_ATA_DMAMODE_IE          0x08 /* Enable drive interrupt to CPU in DMA mode */
  74 #define MPC52xx_ATA_DMAMODE_FE          0x10 /* FIFO Flush enable in Rx mode */
  75 #define MPC52xx_ATA_DMAMODE_FR          0x20 /* FIFO Reset */
  76 #define MPC52xx_ATA_DMAMODE_HUT         0x40 /* Host UDMA burst terminate */
  77
  78
  79 /* Structure of the hardware registers */
  80 struct mpc52xx_ata {
  81
  82         /* Host interface registers */
  83         u32 config;             /* ATA + 0x00 Host configuration */
  84         u32 host_status;        /* ATA + 0x04 Host controller status */
  85         u32 pio1;               /* ATA + 0x08 PIO Timing 1 */
  86         u32 pio2;               /* ATA + 0x0c PIO Timing 2 */
  87         u32 mdma1;              /* ATA + 0x10 MDMA Timing 1 */
  88         u32 mdma2;              /* ATA + 0x14 MDMA Timing 2 */
  89         u32 udma1;              /* ATA + 0x18 UDMA Timing 1 */
  90         u32 udma2;              /* ATA + 0x1c UDMA Timing 2 */
  91         u32 udma3;              /* ATA + 0x20 UDMA Timing 3 */
  92         u32 udma4;              /* ATA + 0x24 UDMA Timing 4 */
  93         u32 udma5;              /* ATA + 0x28 UDMA Timing 5 */
  94         u32 share_cnt;          /* ATA + 0x2c ATA share counter */
  95         u32 reserved0[3];
  96
  97         /* FIFO registers */
  98         u32 fifo_data;          /* ATA + 0x3c */
  99         u8  fifo_status_frame;  /* ATA + 0x40 */
 100         u8  fifo_status;        /* ATA + 0x41 */
 101         u16 reserved7[1];
 102         u8  fifo_control;       /* ATA + 0x44 */
 103         u8  reserved8[5];
 104         u16 fifo_alarm;         /* ATA + 0x4a */
 105         u16 reserved9;
 106         u16 fifo_rdp;           /* ATA + 0x4e */
 107         u16 reserved10;
 108         u16 fifo_wrp;           /* ATA + 0x52 */
 109         u16 reserved11;
 110         u16 fifo_lfrdp;         /* ATA + 0x56 */
 111         u16 reserved12;
 112         u16 fifo_lfwrp;         /* ATA + 0x5a */
 113
 114         /* Drive TaskFile registers */
 115         u8  tf_control;         /* ATA + 0x5c TASKFILE Control/Alt Status */
 116         u8  reserved13[3];
 117         u16 tf_data;            /* ATA + 0x60 TASKFILE Data */
 118         u16 reserved14;
 119         u8  tf_features;        /* ATA + 0x64 TASKFILE Features/Error */
 120         u8  reserved15[3];
 121         u8  tf_sec_count;       /* ATA + 0x68 TASKFILE Sector Count */
 122         u8  reserved16[3];
 123         u8  tf_sec_num;         /* ATA + 0x6c TASKFILE Sector Number */
 124         u8  reserved17[3];
 125         u8  tf_cyl_low;         /* ATA + 0x70 TASKFILE Cylinder Low */
 126         u8  reserved18[3];
 127         u8  tf_cyl_high;        /* ATA + 0x74 TASKFILE Cylinder High */
 128         u8  reserved19[3];
 129         u8  tf_dev_head;        /* ATA + 0x78 TASKFILE Device/Head */
 130         u8  reserved20[3];
 131         u8  tf_command;         /* ATA + 0x7c TASKFILE Command/Status */
 132         u8  dma_mode;           /* ATA + 0x7d ATA Host DMA Mode configuration */
 133         u8  reserved21[2];
 134 };
 135
 136
 137 /* ======================================================================== */
 138 /* Aux fns                                                                  */
 139 /* ======================================================================== */
 140
 141
 142 /* MPC52xx low level hw control */
 143
 144 static int
 145 mpc52xx_ata_compute_pio_timings(struct mpc52xx_ata_priv *priv, int dev, int pio)
 146 {
 147         struct mpc52xx_ata_timings *timing = &priv->timings[dev];
 148         unsigned int ipb_period = priv->ipb_period;
 149         unsigned int t0, t1, t2_8, t2_16, t2i, t4, ta;
 150
 151         if ((pio<0) || (pio>4))
 152                 return -EINVAL;
 153
 154         t0      = CALC_CLKCYC(ipb_period, 1000 * ataspec_t0[pio]);
 155         t1      = CALC_CLKCYC(ipb_period, 1000 * ataspec_t1[pio]);
 156         t2_8    = CALC_CLKCYC(ipb_period, 1000 * ataspec_t2_8[pio]);
 157         t2_16   = CALC_CLKCYC(ipb_period, 1000 * ataspec_t2_16[pio]);
 158         t2i     = CALC_CLKCYC(ipb_period, 1000 * ataspec_t2i[pio]);
 159         t4      = CALC_CLKCYC(ipb_period, 1000 * ataspec_t4[pio]);
 160         ta      = CALC_CLKCYC(ipb_period, 1000 * ataspec_ta[pio]);
 161
 162         timing->pio1 = (t0 << 24) | (t2_8 << 16) | (t2_16 << 8) | (t2i);
 163         timing->pio2 = (t4 << 24) | (t1 << 16) | (ta << 8);
 164
 165         return 0;
 166 }
 167
 168 static void
 169 mpc52xx_ata_apply_timings(struct mpc52xx_ata_priv *priv, int device)
 170 {
 171         struct mpc52xx_ata __iomem *regs = priv->ata_regs;
 172         struct mpc52xx_ata_timings *timing = &priv->timings[device];
 173
 174         out_be32(&regs->pio1,  timing->pio1);
 175         out_be32(&regs->pio2,  timing->pio2);
 176         out_be32(&regs->mdma1, 0);
 177         out_be32(&regs->mdma2, 0);
 178         out_be32(&regs->udma1, 0);
 179         out_be32(&regs->udma2, 0);
 180         out_be32(&regs->udma3, 0);
 181         out_be32(&regs->udma4, 0);
 182         out_be32(&regs->udma5, 0);
 183
 184         priv->csel = device;
 185 }
 186
 187 static int
 188 mpc52xx_ata_hw_init(struct mpc52xx_ata_priv *priv)
 189 {
 190         struct mpc52xx_ata __iomem *regs = priv->ata_regs;
 191         int tslot;
 192
 193         /* Clear share_cnt (all sample code do this ...) */
 194         out_be32(&regs->share_cnt, 0);
 195
 196         /* Configure and reset host */
 197         out_be32(&regs->config,
 198                         MPC52xx_ATA_HOSTCONF_IE |
 199                         MPC52xx_ATA_HOSTCONF_IORDY |
 200                         MPC52xx_ATA_HOSTCONF_SMR |
 201                         MPC52xx_ATA_HOSTCONF_FR);
 202
 203         udelay(10);
 204
 205         out_be32(&regs->config,
 206                         MPC52xx_ATA_HOSTCONF_IE |
 207                         MPC52xx_ATA_HOSTCONF_IORDY);
 208
 209         /* Set the time slot to 1us */
 210         tslot = CALC_CLKCYC(priv->ipb_period, 1000000);
 211         out_be32(&regs->share_cnt, tslot << 16 );
 212
 213         /* Init timings to PIO0 */
 214         memset(priv->timings, 0x00, 2*sizeof(struct mpc52xx_ata_timings));
 215
 216         mpc52xx_ata_compute_pio_timings(priv, 0, 0);
 217         mpc52xx_ata_compute_pio_timings(priv, 1, 0);
 218
 219         mpc52xx_ata_apply_timings(priv, 0);
 220
 221         return 0;
 222 }
 223
 224
 225 /* ======================================================================== */
 226 /* libata driver                                                            */
 227 /* ======================================================================== */
 228
 229 static void
 230 mpc52xx_ata_set_piomode(struct ata_port *ap, struct ata_device *adev)
 231 {
 232         struct mpc52xx_ata_priv *priv = ap->host->private_data;
 233         int pio, rv;
 234
 235         pio = adev->pio_mode - XFER_PIO_0;
 236
 237         rv = mpc52xx_ata_compute_pio_timings(priv, adev->devno, pio);
 238
 239         if (rv) {
 240                 printk(KERN_ERR DRV_NAME
 241                         ": Trying to select invalid PIO mode %d\n", pio);
 242                 return;
 243         }
 244
 245         mpc52xx_ata_apply_timings(priv, adev->devno);
 246 }
 247 static void
 248 mpc52xx_ata_dev_select(struct ata_port *ap, unsigned int device)
 249 {
 250         struct mpc52xx_ata_priv *priv = ap->host->private_data;
 251
 252         if (device != priv->csel)
 253                 mpc52xx_ata_apply_timings(priv, device);
 254
 255         ata_std_dev_select(ap,device);
 256 }
 257
 258 static void
 259 mpc52xx_ata_error_handler(struct ata_port *ap)
 260 {
 261         ata_bmdma_drive_eh(ap, ata_std_prereset, ata_std_softreset, NULL,
 262                         ata_std_postreset);
 263 }
 264
 265
 266
 267 static struct scsi_host_template mpc52xx_ata_sht = {
 268         .module                 = THIS_MODULE,
 269         .name                   = DRV_NAME,
 270         .ioctl                  = ata_scsi_ioctl,
 271         .queuecommand           = ata_scsi_queuecmd,
 272         .can_queue              = ATA_DEF_QUEUE,
 273         .this_id                = ATA_SHT_THIS_ID,
 274         .sg_tablesize           = LIBATA_MAX_PRD,
 275         .max_sectors            = ATA_MAX_SECTORS,
 276         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
 277         .emulated               = ATA_SHT_EMULATED,
 278         .use_clustering         = ATA_SHT_USE_CLUSTERING,
 279         .proc_name              = DRV_NAME,
 280         .dma_boundary           = ATA_DMA_BOUNDARY,
 281         .slave_configure        = ata_scsi_slave_config,
 282         .bios_param             = ata_std_bios_param,
 283 };
 284
 285 static struct ata_port_operations mpc52xx_ata_port_ops = {
 286         .port_disable           = ata_port_disable,
 287         .set_piomode            = mpc52xx_ata_set_piomode,
 288         .dev_select             = mpc52xx_ata_dev_select,
 289         .tf_load                = ata_tf_load,
 290         .tf_read                = ata_tf_read,
 291         .check_status           = ata_check_status,
 292         .exec_command           = ata_exec_command,
 293         .freeze                 = ata_bmdma_freeze,
 294         .thaw                   = ata_bmdma_thaw,
 295         .error_handler          = mpc52xx_ata_error_handler,
 296         .qc_prep                = ata_qc_prep,
 297         .qc_issue               = ata_qc_issue_prot,
 298         .data_xfer              = ata_data_xfer,
 299         .irq_handler            = ata_interrupt,
 300         .irq_clear              = ata_bmdma_irq_clear,
 301         .port_start             = ata_port_start,
 302 };
 303
 304 static struct ata_probe_ent mpc52xx_ata_probe_ent = {
 305         .port_ops       = &mpc52xx_ata_port_ops,
 306         .sht            = &mpc52xx_ata_sht,
 307         .n_ports        = 1,
 308         .pio_mask       = 0x1f,         /* Up to PIO4 */
 309         .mwdma_mask     = 0x00,         /* No MWDMA   */
 310         .udma_mask      = 0x00,         /* No UDMA    */
 311         .port_flags     = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
 312         .irq_flags      = 0,
 313 };
 314
 315 static int __devinit
 316 mpc52xx_ata_init_one(struct device *dev, struct mpc52xx_ata_priv *priv)
 317 {
 318         struct ata_probe_ent *ae = &mpc52xx_ata_probe_ent;
 319         struct ata_ioports *aio = &ae->port[0];
 320         int rv;
 321
 322         INIT_LIST_HEAD(&ae->node);
 323         ae->dev = dev;
 324         ae->irq = priv->ata_irq;
 325
 326         aio->cmd_addr           = 0;    /* Don't have a classic reg block */
 327         aio->altstatus_addr     = &priv->ata_regs->tf_control;
 328         aio->ctl_addr           = &priv->ata_regs->tf_control;
 329         aio->data_addr          = &priv->ata_regs->tf_data;
 330         aio->error_addr         = &priv->ata_regs->tf_features;
 331         aio->feature_addr       = &priv->ata_regs->tf_features;
 332         aio->nsect_addr         = &priv->ata_regs->tf_sec_count;
 333         aio->lbal_addr          = &priv->ata_regs->tf_sec_num;
 334         aio->lbam_addr          = &priv->ata_regs->tf_cyl_low;
 335         aio->lbah_addr          = &priv->ata_regs->tf_cyl_high;
 336         aio->device_addr        = &priv->ata_regs->tf_dev_head;
 337         aio->status_addr        = &priv->ata_regs->tf_command;
 338         aio->command_addr       = &priv->ata_regs->tf_command;
 339
 340         ae->private_data = priv;
 341
 342         rv = ata_device_add(ae);
 343
 344         return rv ? 0 : -EINVAL;
 345 }
 346
 347 static struct mpc52xx_ata_priv *
 348 mpc52xx_ata_remove_one(struct device *dev)
 349 {
 350         struct ata_host *host = dev_get_drvdata(dev);
 351         struct mpc52xx_ata_priv *priv = host->private_data;
 352
 353         ata_host_detach(host);
 354
 355         return priv;
 356 }
 357
 358
 359 /* ======================================================================== */
 360 /* OF Platform driver                                                       */
 361 /* ======================================================================== */
 362
 363 static int __devinit
 364 mpc52xx_ata_probe(struct of_device *op, const struct of_device_id *match)
 365 {
 366         unsigned int ipb_freq;
 367         struct resource res_mem;
 368         int ata_irq = NO_IRQ;
 369         struct mpc52xx_ata __iomem *ata_regs;
 370         struct mpc52xx_ata_priv *priv;
 371         int rv;
 372
 373         /* Get ipb frequency */
 374         ipb_freq = mpc52xx_find_ipb_freq(op->node);
 375         if (!ipb_freq) {
 376                 printk(KERN_ERR DRV_NAME ": "
 377                         "Unable to find IPB Bus frequency\n" );
 378                 return -ENODEV;
 379         }
 380
 381         /* Get IRQ and register */
 382         rv = of_address_to_resource(op->node, 0, &res_mem);
 383         if (rv) {
 384                 printk(KERN_ERR DRV_NAME ": "
 385                         "Error while parsing device node resource\n" );
 386                 return rv;
 387         }
 388
 389         ata_irq = irq_of_parse_and_map(op->node, 0);
 390         if (ata_irq == NO_IRQ) {
 391                 printk(KERN_ERR DRV_NAME ": "
 392                         "Error while mapping the irq\n");
 393                 return -EINVAL;
 394         }
 395
 396         /* Request mem region */
 397         if (!devm_request_mem_region(&op->dev, res_mem.start,
 398                                      sizeof(struct mpc52xx_ata), DRV_NAME)) {
 399                 printk(KERN_ERR DRV_NAME ": "
 400                         "Error while requesting mem region\n");
 401                 rv = -EBUSY;
 402                 goto err;
 403         }
 404
 405         /* Remap registers */
 406         ata_regs = devm_ioremap(&op->dev, res_mem.start,
 407                                 sizeof(struct mpc52xx_ata));
 408         if (!ata_regs) {
 409                 printk(KERN_ERR DRV_NAME ": "
 410                         "Error while mapping register set\n");
 411                 rv = -ENOMEM;
 412                 goto err;
 413         }
 414
 415         /* Prepare our private structure */
 416         priv = devm_kzalloc(&op->dev, sizeof(struct mpc52xx_ata_priv),
 417                             GFP_ATOMIC);
 418         if (!priv) {
 419                 printk(KERN_ERR DRV_NAME ": "
 420                         "Error while allocating private structure\n");
 421                 rv = -ENOMEM;
 422                 goto err;
 423         }
 424
 425         priv->ipb_period = 1000000000 / (ipb_freq / 1000);
 426         priv->ata_regs = ata_regs;
 427         priv->ata_irq = ata_irq;
 428         priv->csel = -1;
 429
 430         /* Init the hw */
 431         rv = mpc52xx_ata_hw_init(priv);
 432         if (rv) {
 433                 printk(KERN_ERR DRV_NAME ": Error during HW init\n");
 434                 goto err;
 435         }
 436
 437         /* Register ourselves to libata */
 438         rv = mpc52xx_ata_init_one(&op->dev, priv);
 439         if (rv) {
 440                 printk(KERN_ERR DRV_NAME ": "
 441                         "Error while registering to ATA layer\n");
 442                 return rv;
 443         }
 444
 445         /* Done */
 446         return 0;
 447
 448         /* Error path */
 449 err:
 450         irq_dispose_mapping(ata_irq);
 451         return rv;
 452 }
 453
 454 static int
 455 mpc52xx_ata_remove(struct of_device *op)
 456 {
 457         struct mpc52xx_ata_priv *priv;
 458
 459         priv = mpc52xx_ata_remove_one(&op->dev);
 460         irq_dispose_mapping(priv->ata_irq);
 461
 462         return 0;
 463 }
 464
 465
 466 #ifdef CONFIG_PM
 467
 468 static int
 469 mpc52xx_ata_suspend(struct of_device *op, pm_message_t state)
 470 {
 471         return 0;       /* FIXME : What to do here ? */
 472 }
 473
 474 static int
 475 mpc52xx_ata_resume(struct of_device *op)
 476 {
 477         return 0;       /* FIXME : What to do here ? */
 478 }
 479
 480 #endif
 481
 482
 483 static struct of_device_id mpc52xx_ata_of_match[] = {
 484         {
 485                 .compatible = "mpc5200-ata",
 486         },
 487         {
 488                 .compatible = "mpc52xx-ata",
 489         },
 490         {},
 491 };
 492
 493
 494 static struct of_platform_driver mpc52xx_ata_of_platform_driver = {
 495         .owner          = THIS_MODULE,
 496         .name           = DRV_NAME,
 497         .match_table    = mpc52xx_ata_of_match,
 498         .probe          = mpc52xx_ata_probe,
 499         .remove         = mpc52xx_ata_remove,
 500 #ifdef CONFIG_PM
 501         .suspend        = mpc52xx_ata_suspend,
 502         .resume         = mpc52xx_ata_resume,
 503 #endif
 504         .driver         = {
 505                 .name   = DRV_NAME,
 506                 .owner  = THIS_MODULE,
 507         },
 508 };
 509
 510
 511 /* ======================================================================== */
 512 /* Module                                                                   */
 513 /* ======================================================================== */
 514
 515 static int __init
 516 mpc52xx_ata_init(void)
 517 {
 518         printk(KERN_INFO "ata: MPC52xx IDE/ATA libata driver\n");
 519         return of_register_platform_driver(&mpc52xx_ata_of_platform_driver);
 520 }
 521
 522 static void __exit
 523 mpc52xx_ata_exit(void)
 524 {
 525         of_unregister_platform_driver(&mpc52xx_ata_of_platform_driver);
 526 }
 527
 528 module_init(mpc52xx_ata_init);
 529 module_exit(mpc52xx_ata_exit);
 530
 531 MODULE_AUTHOR("Sylvain Munaut <tnt@246tNt.com>");
 532 MODULE_DESCRIPTION("Freescale MPC52xx IDE/ATA libata driver");
 533 MODULE_LICENSE("GPL");
 534 MODULE_DEVICE_TABLE(of, mpc52xx_ata_of_match);
 535 MODULE_VERSION(DRV_VERSION);
 536