powerpc/mpc5xxx: Use of_get_next_parent to simplify code
[linux/fpc-iii.git] / drivers / ata / sata_rcar.c
blob8804127b108c0f8e613f2583968f6b661a46be84
1 /*
2 * Renesas R-Car SATA driver
4 * Author: Vladimir Barinov <source@cogentembedded.com>
5 * Copyright (C) 2013-2015 Cogent Embedded, Inc.
6 * Copyright (C) 2013-2015 Renesas Solutions Corp.
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/ata.h>
17 #include <linux/libata.h>
18 #include <linux/of_device.h>
19 #include <linux/platform_device.h>
20 #include <linux/clk.h>
21 #include <linux/err.h>
23 #define DRV_NAME "sata_rcar"
25 /* SH-Navi2G/ATAPI-ATA compatible task registers */
26 #define DATA_REG 0x100
27 #define SDEVCON_REG 0x138
29 /* SH-Navi2G/ATAPI module compatible control registers */
30 #define ATAPI_CONTROL1_REG 0x180
31 #define ATAPI_STATUS_REG 0x184
32 #define ATAPI_INT_ENABLE_REG 0x188
33 #define ATAPI_DTB_ADR_REG 0x198
34 #define ATAPI_DMA_START_ADR_REG 0x19C
35 #define ATAPI_DMA_TRANS_CNT_REG 0x1A0
36 #define ATAPI_CONTROL2_REG 0x1A4
37 #define ATAPI_SIG_ST_REG 0x1B0
38 #define ATAPI_BYTE_SWAP_REG 0x1BC
40 /* ATAPI control 1 register (ATAPI_CONTROL1) bits */
41 #define ATAPI_CONTROL1_ISM BIT(16)
42 #define ATAPI_CONTROL1_DTA32M BIT(11)
43 #define ATAPI_CONTROL1_RESET BIT(7)
44 #define ATAPI_CONTROL1_DESE BIT(3)
45 #define ATAPI_CONTROL1_RW BIT(2)
46 #define ATAPI_CONTROL1_STOP BIT(1)
47 #define ATAPI_CONTROL1_START BIT(0)
49 /* ATAPI status register (ATAPI_STATUS) bits */
50 #define ATAPI_STATUS_SATAINT BIT(11)
51 #define ATAPI_STATUS_DNEND BIT(6)
52 #define ATAPI_STATUS_DEVTRM BIT(5)
53 #define ATAPI_STATUS_DEVINT BIT(4)
54 #define ATAPI_STATUS_ERR BIT(2)
55 #define ATAPI_STATUS_NEND BIT(1)
56 #define ATAPI_STATUS_ACT BIT(0)
58 /* Interrupt enable register (ATAPI_INT_ENABLE) bits */
59 #define ATAPI_INT_ENABLE_SATAINT BIT(11)
60 #define ATAPI_INT_ENABLE_DNEND BIT(6)
61 #define ATAPI_INT_ENABLE_DEVTRM BIT(5)
62 #define ATAPI_INT_ENABLE_DEVINT BIT(4)
63 #define ATAPI_INT_ENABLE_ERR BIT(2)
64 #define ATAPI_INT_ENABLE_NEND BIT(1)
65 #define ATAPI_INT_ENABLE_ACT BIT(0)
67 /* Access control registers for physical layer control register */
68 #define SATAPHYADDR_REG 0x200
69 #define SATAPHYWDATA_REG 0x204
70 #define SATAPHYACCEN_REG 0x208
71 #define SATAPHYRESET_REG 0x20C
72 #define SATAPHYRDATA_REG 0x210
73 #define SATAPHYACK_REG 0x214
75 /* Physical layer control address command register (SATAPHYADDR) bits */
76 #define SATAPHYADDR_PHYRATEMODE BIT(10)
77 #define SATAPHYADDR_PHYCMD_READ BIT(9)
78 #define SATAPHYADDR_PHYCMD_WRITE BIT(8)
80 /* Physical layer control enable register (SATAPHYACCEN) bits */
81 #define SATAPHYACCEN_PHYLANE BIT(0)
83 /* Physical layer control reset register (SATAPHYRESET) bits */
84 #define SATAPHYRESET_PHYRST BIT(1)
85 #define SATAPHYRESET_PHYSRES BIT(0)
87 /* Physical layer control acknowledge register (SATAPHYACK) bits */
88 #define SATAPHYACK_PHYACK BIT(0)
90 /* Serial-ATA HOST control registers */
91 #define BISTCONF_REG 0x102C
92 #define SDATA_REG 0x1100
93 #define SSDEVCON_REG 0x1204
95 #define SCRSSTS_REG 0x1400
96 #define SCRSERR_REG 0x1404
97 #define SCRSCON_REG 0x1408
98 #define SCRSACT_REG 0x140C
100 #define SATAINTSTAT_REG 0x1508
101 #define SATAINTMASK_REG 0x150C
103 /* SATA INT status register (SATAINTSTAT) bits */
104 #define SATAINTSTAT_SERR BIT(3)
105 #define SATAINTSTAT_ATA BIT(0)
107 /* SATA INT mask register (SATAINTSTAT) bits */
108 #define SATAINTMASK_SERRMSK BIT(3)
109 #define SATAINTMASK_ERRMSK BIT(2)
110 #define SATAINTMASK_ERRCRTMSK BIT(1)
111 #define SATAINTMASK_ATAMSK BIT(0)
113 #define SATA_RCAR_INT_MASK (SATAINTMASK_SERRMSK | \
114 SATAINTMASK_ATAMSK)
116 /* Physical Layer Control Registers */
117 #define SATAPCTLR1_REG 0x43
118 #define SATAPCTLR2_REG 0x52
119 #define SATAPCTLR3_REG 0x5A
120 #define SATAPCTLR4_REG 0x60
122 /* Descriptor table word 0 bit (when DTA32M = 1) */
123 #define SATA_RCAR_DTEND BIT(0)
125 #define SATA_RCAR_DMA_BOUNDARY 0x1FFFFFFEUL
127 /* Gen2 Physical Layer Control Registers */
128 #define RCAR_GEN2_PHY_CTL1_REG 0x1704
129 #define RCAR_GEN2_PHY_CTL1 0x34180002
130 #define RCAR_GEN2_PHY_CTL1_SS 0xC180 /* Spread Spectrum */
132 #define RCAR_GEN2_PHY_CTL2_REG 0x170C
133 #define RCAR_GEN2_PHY_CTL2 0x00002303
135 #define RCAR_GEN2_PHY_CTL3_REG 0x171C
136 #define RCAR_GEN2_PHY_CTL3 0x000B0194
138 #define RCAR_GEN2_PHY_CTL4_REG 0x1724
139 #define RCAR_GEN2_PHY_CTL4 0x00030994
141 #define RCAR_GEN2_PHY_CTL5_REG 0x1740
142 #define RCAR_GEN2_PHY_CTL5 0x03004001
143 #define RCAR_GEN2_PHY_CTL5_DC BIT(1) /* DC connection */
144 #define RCAR_GEN2_PHY_CTL5_TR BIT(2) /* Termination Resistor */
146 enum sata_rcar_type {
147 RCAR_GEN1_SATA,
148 RCAR_GEN2_SATA,
149 RCAR_R8A7790_ES1_SATA,
152 struct sata_rcar_priv {
153 void __iomem *base;
154 struct clk *clk;
155 enum sata_rcar_type type;
158 static void sata_rcar_gen1_phy_preinit(struct sata_rcar_priv *priv)
160 void __iomem *base = priv->base;
162 /* idle state */
163 iowrite32(0, base + SATAPHYADDR_REG);
164 /* reset */
165 iowrite32(SATAPHYRESET_PHYRST, base + SATAPHYRESET_REG);
166 udelay(10);
167 /* deassert reset */
168 iowrite32(0, base + SATAPHYRESET_REG);
171 static void sata_rcar_gen1_phy_write(struct sata_rcar_priv *priv, u16 reg,
172 u32 val, int group)
174 void __iomem *base = priv->base;
175 int timeout;
177 /* deassert reset */
178 iowrite32(0, base + SATAPHYRESET_REG);
179 /* lane 1 */
180 iowrite32(SATAPHYACCEN_PHYLANE, base + SATAPHYACCEN_REG);
181 /* write phy register value */
182 iowrite32(val, base + SATAPHYWDATA_REG);
183 /* set register group */
184 if (group)
185 reg |= SATAPHYADDR_PHYRATEMODE;
186 /* write command */
187 iowrite32(SATAPHYADDR_PHYCMD_WRITE | reg, base + SATAPHYADDR_REG);
188 /* wait for ack */
189 for (timeout = 0; timeout < 100; timeout++) {
190 val = ioread32(base + SATAPHYACK_REG);
191 if (val & SATAPHYACK_PHYACK)
192 break;
194 if (timeout >= 100)
195 pr_err("%s timeout\n", __func__);
196 /* idle state */
197 iowrite32(0, base + SATAPHYADDR_REG);
200 static void sata_rcar_gen1_phy_init(struct sata_rcar_priv *priv)
202 sata_rcar_gen1_phy_preinit(priv);
203 sata_rcar_gen1_phy_write(priv, SATAPCTLR1_REG, 0x00200188, 0);
204 sata_rcar_gen1_phy_write(priv, SATAPCTLR1_REG, 0x00200188, 1);
205 sata_rcar_gen1_phy_write(priv, SATAPCTLR3_REG, 0x0000A061, 0);
206 sata_rcar_gen1_phy_write(priv, SATAPCTLR2_REG, 0x20000000, 0);
207 sata_rcar_gen1_phy_write(priv, SATAPCTLR2_REG, 0x20000000, 1);
208 sata_rcar_gen1_phy_write(priv, SATAPCTLR4_REG, 0x28E80000, 0);
211 static void sata_rcar_gen2_phy_init(struct sata_rcar_priv *priv)
213 void __iomem *base = priv->base;
215 iowrite32(RCAR_GEN2_PHY_CTL1, base + RCAR_GEN2_PHY_CTL1_REG);
216 iowrite32(RCAR_GEN2_PHY_CTL2, base + RCAR_GEN2_PHY_CTL2_REG);
217 iowrite32(RCAR_GEN2_PHY_CTL3, base + RCAR_GEN2_PHY_CTL3_REG);
218 iowrite32(RCAR_GEN2_PHY_CTL4, base + RCAR_GEN2_PHY_CTL4_REG);
219 iowrite32(RCAR_GEN2_PHY_CTL5 | RCAR_GEN2_PHY_CTL5_DC |
220 RCAR_GEN2_PHY_CTL5_TR, base + RCAR_GEN2_PHY_CTL5_REG);
223 static void sata_rcar_freeze(struct ata_port *ap)
225 struct sata_rcar_priv *priv = ap->host->private_data;
227 /* mask */
228 iowrite32(0x7ff, priv->base + SATAINTMASK_REG);
230 ata_sff_freeze(ap);
233 static void sata_rcar_thaw(struct ata_port *ap)
235 struct sata_rcar_priv *priv = ap->host->private_data;
236 void __iomem *base = priv->base;
238 /* ack */
239 iowrite32(~(u32)SATA_RCAR_INT_MASK, base + SATAINTSTAT_REG);
241 ata_sff_thaw(ap);
243 /* unmask */
244 iowrite32(0x7ff & ~SATA_RCAR_INT_MASK, base + SATAINTMASK_REG);
247 static void sata_rcar_ioread16_rep(void __iomem *reg, void *buffer, int count)
249 u16 *ptr = buffer;
251 while (count--) {
252 u16 data = ioread32(reg);
254 *ptr++ = data;
258 static void sata_rcar_iowrite16_rep(void __iomem *reg, void *buffer, int count)
260 const u16 *ptr = buffer;
262 while (count--)
263 iowrite32(*ptr++, reg);
266 static u8 sata_rcar_check_status(struct ata_port *ap)
268 return ioread32(ap->ioaddr.status_addr);
271 static u8 sata_rcar_check_altstatus(struct ata_port *ap)
273 return ioread32(ap->ioaddr.altstatus_addr);
276 static void sata_rcar_set_devctl(struct ata_port *ap, u8 ctl)
278 iowrite32(ctl, ap->ioaddr.ctl_addr);
281 static void sata_rcar_dev_select(struct ata_port *ap, unsigned int device)
283 iowrite32(ATA_DEVICE_OBS, ap->ioaddr.device_addr);
284 ata_sff_pause(ap); /* needed; also flushes, for mmio */
287 static unsigned int sata_rcar_ata_devchk(struct ata_port *ap,
288 unsigned int device)
290 struct ata_ioports *ioaddr = &ap->ioaddr;
291 u8 nsect, lbal;
293 sata_rcar_dev_select(ap, device);
295 iowrite32(0x55, ioaddr->nsect_addr);
296 iowrite32(0xaa, ioaddr->lbal_addr);
298 iowrite32(0xaa, ioaddr->nsect_addr);
299 iowrite32(0x55, ioaddr->lbal_addr);
301 iowrite32(0x55, ioaddr->nsect_addr);
302 iowrite32(0xaa, ioaddr->lbal_addr);
304 nsect = ioread32(ioaddr->nsect_addr);
305 lbal = ioread32(ioaddr->lbal_addr);
307 if (nsect == 0x55 && lbal == 0xaa)
308 return 1; /* found a device */
310 return 0; /* nothing found */
313 static int sata_rcar_wait_after_reset(struct ata_link *link,
314 unsigned long deadline)
316 struct ata_port *ap = link->ap;
318 ata_msleep(ap, ATA_WAIT_AFTER_RESET);
320 return ata_sff_wait_ready(link, deadline);
323 static int sata_rcar_bus_softreset(struct ata_port *ap, unsigned long deadline)
325 struct ata_ioports *ioaddr = &ap->ioaddr;
327 DPRINTK("ata%u: bus reset via SRST\n", ap->print_id);
329 /* software reset. causes dev0 to be selected */
330 iowrite32(ap->ctl, ioaddr->ctl_addr);
331 udelay(20);
332 iowrite32(ap->ctl | ATA_SRST, ioaddr->ctl_addr);
333 udelay(20);
334 iowrite32(ap->ctl, ioaddr->ctl_addr);
335 ap->last_ctl = ap->ctl;
337 /* wait the port to become ready */
338 return sata_rcar_wait_after_reset(&ap->link, deadline);
341 static int sata_rcar_softreset(struct ata_link *link, unsigned int *classes,
342 unsigned long deadline)
344 struct ata_port *ap = link->ap;
345 unsigned int devmask = 0;
346 int rc;
347 u8 err;
349 /* determine if device 0 is present */
350 if (sata_rcar_ata_devchk(ap, 0))
351 devmask |= 1 << 0;
353 /* issue bus reset */
354 DPRINTK("about to softreset, devmask=%x\n", devmask);
355 rc = sata_rcar_bus_softreset(ap, deadline);
356 /* if link is occupied, -ENODEV too is an error */
357 if (rc && (rc != -ENODEV || sata_scr_valid(link))) {
358 ata_link_err(link, "SRST failed (errno=%d)\n", rc);
359 return rc;
362 /* determine by signature whether we have ATA or ATAPI devices */
363 classes[0] = ata_sff_dev_classify(&link->device[0], devmask, &err);
365 DPRINTK("classes[0]=%u\n", classes[0]);
366 return 0;
369 static void sata_rcar_tf_load(struct ata_port *ap,
370 const struct ata_taskfile *tf)
372 struct ata_ioports *ioaddr = &ap->ioaddr;
373 unsigned int is_addr = tf->flags & ATA_TFLAG_ISADDR;
375 if (tf->ctl != ap->last_ctl) {
376 iowrite32(tf->ctl, ioaddr->ctl_addr);
377 ap->last_ctl = tf->ctl;
378 ata_wait_idle(ap);
381 if (is_addr && (tf->flags & ATA_TFLAG_LBA48)) {
382 iowrite32(tf->hob_feature, ioaddr->feature_addr);
383 iowrite32(tf->hob_nsect, ioaddr->nsect_addr);
384 iowrite32(tf->hob_lbal, ioaddr->lbal_addr);
385 iowrite32(tf->hob_lbam, ioaddr->lbam_addr);
386 iowrite32(tf->hob_lbah, ioaddr->lbah_addr);
387 VPRINTK("hob: feat 0x%X nsect 0x%X, lba 0x%X 0x%X 0x%X\n",
388 tf->hob_feature,
389 tf->hob_nsect,
390 tf->hob_lbal,
391 tf->hob_lbam,
392 tf->hob_lbah);
395 if (is_addr) {
396 iowrite32(tf->feature, ioaddr->feature_addr);
397 iowrite32(tf->nsect, ioaddr->nsect_addr);
398 iowrite32(tf->lbal, ioaddr->lbal_addr);
399 iowrite32(tf->lbam, ioaddr->lbam_addr);
400 iowrite32(tf->lbah, ioaddr->lbah_addr);
401 VPRINTK("feat 0x%X nsect 0x%X lba 0x%X 0x%X 0x%X\n",
402 tf->feature,
403 tf->nsect,
404 tf->lbal,
405 tf->lbam,
406 tf->lbah);
409 if (tf->flags & ATA_TFLAG_DEVICE) {
410 iowrite32(tf->device, ioaddr->device_addr);
411 VPRINTK("device 0x%X\n", tf->device);
414 ata_wait_idle(ap);
417 static void sata_rcar_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
419 struct ata_ioports *ioaddr = &ap->ioaddr;
421 tf->command = sata_rcar_check_status(ap);
422 tf->feature = ioread32(ioaddr->error_addr);
423 tf->nsect = ioread32(ioaddr->nsect_addr);
424 tf->lbal = ioread32(ioaddr->lbal_addr);
425 tf->lbam = ioread32(ioaddr->lbam_addr);
426 tf->lbah = ioread32(ioaddr->lbah_addr);
427 tf->device = ioread32(ioaddr->device_addr);
429 if (tf->flags & ATA_TFLAG_LBA48) {
430 iowrite32(tf->ctl | ATA_HOB, ioaddr->ctl_addr);
431 tf->hob_feature = ioread32(ioaddr->error_addr);
432 tf->hob_nsect = ioread32(ioaddr->nsect_addr);
433 tf->hob_lbal = ioread32(ioaddr->lbal_addr);
434 tf->hob_lbam = ioread32(ioaddr->lbam_addr);
435 tf->hob_lbah = ioread32(ioaddr->lbah_addr);
436 iowrite32(tf->ctl, ioaddr->ctl_addr);
437 ap->last_ctl = tf->ctl;
441 static void sata_rcar_exec_command(struct ata_port *ap,
442 const struct ata_taskfile *tf)
444 DPRINTK("ata%u: cmd 0x%X\n", ap->print_id, tf->command);
446 iowrite32(tf->command, ap->ioaddr.command_addr);
447 ata_sff_pause(ap);
450 static unsigned int sata_rcar_data_xfer(struct ata_device *dev,
451 unsigned char *buf,
452 unsigned int buflen, int rw)
454 struct ata_port *ap = dev->link->ap;
455 void __iomem *data_addr = ap->ioaddr.data_addr;
456 unsigned int words = buflen >> 1;
458 /* Transfer multiple of 2 bytes */
459 if (rw == READ)
460 sata_rcar_ioread16_rep(data_addr, buf, words);
461 else
462 sata_rcar_iowrite16_rep(data_addr, buf, words);
464 /* Transfer trailing byte, if any. */
465 if (unlikely(buflen & 0x01)) {
466 unsigned char pad[2] = { };
468 /* Point buf to the tail of buffer */
469 buf += buflen - 1;
472 * Use io*16_rep() accessors here as well to avoid pointlessly
473 * swapping bytes to and from on the big endian machines...
475 if (rw == READ) {
476 sata_rcar_ioread16_rep(data_addr, pad, 1);
477 *buf = pad[0];
478 } else {
479 pad[0] = *buf;
480 sata_rcar_iowrite16_rep(data_addr, pad, 1);
482 words++;
485 return words << 1;
488 static void sata_rcar_drain_fifo(struct ata_queued_cmd *qc)
490 int count;
491 struct ata_port *ap;
493 /* We only need to flush incoming data when a command was running */
494 if (qc == NULL || qc->dma_dir == DMA_TO_DEVICE)
495 return;
497 ap = qc->ap;
498 /* Drain up to 64K of data before we give up this recovery method */
499 for (count = 0; (ap->ops->sff_check_status(ap) & ATA_DRQ) &&
500 count < 65536; count += 2)
501 ioread32(ap->ioaddr.data_addr);
503 /* Can become DEBUG later */
504 if (count)
505 ata_port_dbg(ap, "drained %d bytes to clear DRQ\n", count);
508 static int sata_rcar_scr_read(struct ata_link *link, unsigned int sc_reg,
509 u32 *val)
511 if (sc_reg > SCR_ACTIVE)
512 return -EINVAL;
514 *val = ioread32(link->ap->ioaddr.scr_addr + (sc_reg << 2));
515 return 0;
518 static int sata_rcar_scr_write(struct ata_link *link, unsigned int sc_reg,
519 u32 val)
521 if (sc_reg > SCR_ACTIVE)
522 return -EINVAL;
524 iowrite32(val, link->ap->ioaddr.scr_addr + (sc_reg << 2));
525 return 0;
528 static void sata_rcar_bmdma_fill_sg(struct ata_queued_cmd *qc)
530 struct ata_port *ap = qc->ap;
531 struct ata_bmdma_prd *prd = ap->bmdma_prd;
532 struct scatterlist *sg;
533 unsigned int si;
535 for_each_sg(qc->sg, sg, qc->n_elem, si) {
536 u32 addr, sg_len;
539 * Note: h/w doesn't support 64-bit, so we unconditionally
540 * truncate dma_addr_t to u32.
542 addr = (u32)sg_dma_address(sg);
543 sg_len = sg_dma_len(sg);
545 prd[si].addr = cpu_to_le32(addr);
546 prd[si].flags_len = cpu_to_le32(sg_len);
547 VPRINTK("PRD[%u] = (0x%X, 0x%X)\n", si, addr, sg_len);
550 /* end-of-table flag */
551 prd[si - 1].addr |= cpu_to_le32(SATA_RCAR_DTEND);
554 static void sata_rcar_qc_prep(struct ata_queued_cmd *qc)
556 if (!(qc->flags & ATA_QCFLAG_DMAMAP))
557 return;
559 sata_rcar_bmdma_fill_sg(qc);
562 static void sata_rcar_bmdma_setup(struct ata_queued_cmd *qc)
564 struct ata_port *ap = qc->ap;
565 unsigned int rw = qc->tf.flags & ATA_TFLAG_WRITE;
566 struct sata_rcar_priv *priv = ap->host->private_data;
567 void __iomem *base = priv->base;
568 u32 dmactl;
570 /* load PRD table addr. */
571 mb(); /* make sure PRD table writes are visible to controller */
572 iowrite32(ap->bmdma_prd_dma, base + ATAPI_DTB_ADR_REG);
574 /* specify data direction, triple-check start bit is clear */
575 dmactl = ioread32(base + ATAPI_CONTROL1_REG);
576 dmactl &= ~(ATAPI_CONTROL1_RW | ATAPI_CONTROL1_STOP);
577 if (dmactl & ATAPI_CONTROL1_START) {
578 dmactl &= ~ATAPI_CONTROL1_START;
579 dmactl |= ATAPI_CONTROL1_STOP;
581 if (!rw)
582 dmactl |= ATAPI_CONTROL1_RW;
583 iowrite32(dmactl, base + ATAPI_CONTROL1_REG);
585 /* issue r/w command */
586 ap->ops->sff_exec_command(ap, &qc->tf);
589 static void sata_rcar_bmdma_start(struct ata_queued_cmd *qc)
591 struct ata_port *ap = qc->ap;
592 struct sata_rcar_priv *priv = ap->host->private_data;
593 void __iomem *base = priv->base;
594 u32 dmactl;
596 /* start host DMA transaction */
597 dmactl = ioread32(base + ATAPI_CONTROL1_REG);
598 dmactl &= ~ATAPI_CONTROL1_STOP;
599 dmactl |= ATAPI_CONTROL1_START;
600 iowrite32(dmactl, base + ATAPI_CONTROL1_REG);
603 static void sata_rcar_bmdma_stop(struct ata_queued_cmd *qc)
605 struct ata_port *ap = qc->ap;
606 struct sata_rcar_priv *priv = ap->host->private_data;
607 void __iomem *base = priv->base;
608 u32 dmactl;
610 /* force termination of DMA transfer if active */
611 dmactl = ioread32(base + ATAPI_CONTROL1_REG);
612 if (dmactl & ATAPI_CONTROL1_START) {
613 dmactl &= ~ATAPI_CONTROL1_START;
614 dmactl |= ATAPI_CONTROL1_STOP;
615 iowrite32(dmactl, base + ATAPI_CONTROL1_REG);
618 /* one-PIO-cycle guaranteed wait, per spec, for HDMA1:0 transition */
619 ata_sff_dma_pause(ap);
622 static u8 sata_rcar_bmdma_status(struct ata_port *ap)
624 struct sata_rcar_priv *priv = ap->host->private_data;
625 u8 host_stat = 0;
626 u32 status;
628 status = ioread32(priv->base + ATAPI_STATUS_REG);
629 if (status & ATAPI_STATUS_DEVINT)
630 host_stat |= ATA_DMA_INTR;
631 if (status & ATAPI_STATUS_ACT)
632 host_stat |= ATA_DMA_ACTIVE;
634 return host_stat;
637 static struct scsi_host_template sata_rcar_sht = {
638 ATA_BASE_SHT(DRV_NAME),
640 * This controller allows transfer chunks up to 512MB which cross 64KB
641 * boundaries, therefore the DMA limits are more relaxed than standard
642 * ATA SFF.
644 .sg_tablesize = ATA_MAX_PRD,
645 .dma_boundary = SATA_RCAR_DMA_BOUNDARY,
648 static struct ata_port_operations sata_rcar_port_ops = {
649 .inherits = &ata_bmdma_port_ops,
651 .freeze = sata_rcar_freeze,
652 .thaw = sata_rcar_thaw,
653 .softreset = sata_rcar_softreset,
655 .scr_read = sata_rcar_scr_read,
656 .scr_write = sata_rcar_scr_write,
658 .sff_dev_select = sata_rcar_dev_select,
659 .sff_set_devctl = sata_rcar_set_devctl,
660 .sff_check_status = sata_rcar_check_status,
661 .sff_check_altstatus = sata_rcar_check_altstatus,
662 .sff_tf_load = sata_rcar_tf_load,
663 .sff_tf_read = sata_rcar_tf_read,
664 .sff_exec_command = sata_rcar_exec_command,
665 .sff_data_xfer = sata_rcar_data_xfer,
666 .sff_drain_fifo = sata_rcar_drain_fifo,
668 .qc_prep = sata_rcar_qc_prep,
670 .bmdma_setup = sata_rcar_bmdma_setup,
671 .bmdma_start = sata_rcar_bmdma_start,
672 .bmdma_stop = sata_rcar_bmdma_stop,
673 .bmdma_status = sata_rcar_bmdma_status,
676 static void sata_rcar_serr_interrupt(struct ata_port *ap)
678 struct sata_rcar_priv *priv = ap->host->private_data;
679 struct ata_eh_info *ehi = &ap->link.eh_info;
680 int freeze = 0;
681 u32 serror;
683 serror = ioread32(priv->base + SCRSERR_REG);
684 if (!serror)
685 return;
687 DPRINTK("SError @host_intr: 0x%x\n", serror);
689 /* first, analyze and record host port events */
690 ata_ehi_clear_desc(ehi);
692 if (serror & (SERR_DEV_XCHG | SERR_PHYRDY_CHG)) {
693 /* Setup a soft-reset EH action */
694 ata_ehi_hotplugged(ehi);
695 ata_ehi_push_desc(ehi, "%s", "hotplug");
697 freeze = serror & SERR_COMM_WAKE ? 0 : 1;
700 /* freeze or abort */
701 if (freeze)
702 ata_port_freeze(ap);
703 else
704 ata_port_abort(ap);
707 static void sata_rcar_ata_interrupt(struct ata_port *ap)
709 struct ata_queued_cmd *qc;
710 int handled = 0;
712 qc = ata_qc_from_tag(ap, ap->link.active_tag);
713 if (qc)
714 handled |= ata_bmdma_port_intr(ap, qc);
716 /* be sure to clear ATA interrupt */
717 if (!handled)
718 sata_rcar_check_status(ap);
721 static irqreturn_t sata_rcar_interrupt(int irq, void *dev_instance)
723 struct ata_host *host = dev_instance;
724 struct sata_rcar_priv *priv = host->private_data;
725 void __iomem *base = priv->base;
726 unsigned int handled = 0;
727 struct ata_port *ap;
728 u32 sataintstat;
729 unsigned long flags;
731 spin_lock_irqsave(&host->lock, flags);
733 sataintstat = ioread32(base + SATAINTSTAT_REG);
734 sataintstat &= SATA_RCAR_INT_MASK;
735 if (!sataintstat)
736 goto done;
737 /* ack */
738 iowrite32(~sataintstat & 0x7ff, base + SATAINTSTAT_REG);
740 ap = host->ports[0];
742 if (sataintstat & SATAINTSTAT_ATA)
743 sata_rcar_ata_interrupt(ap);
745 if (sataintstat & SATAINTSTAT_SERR)
746 sata_rcar_serr_interrupt(ap);
748 handled = 1;
749 done:
750 spin_unlock_irqrestore(&host->lock, flags);
752 return IRQ_RETVAL(handled);
755 static void sata_rcar_setup_port(struct ata_host *host)
757 struct ata_port *ap = host->ports[0];
758 struct ata_ioports *ioaddr = &ap->ioaddr;
759 struct sata_rcar_priv *priv = host->private_data;
760 void __iomem *base = priv->base;
762 ap->ops = &sata_rcar_port_ops;
763 ap->pio_mask = ATA_PIO4;
764 ap->udma_mask = ATA_UDMA6;
765 ap->flags |= ATA_FLAG_SATA;
767 if (priv->type == RCAR_R8A7790_ES1_SATA)
768 ap->flags |= ATA_FLAG_NO_DIPM;
770 ioaddr->cmd_addr = base + SDATA_REG;
771 ioaddr->ctl_addr = base + SSDEVCON_REG;
772 ioaddr->scr_addr = base + SCRSSTS_REG;
773 ioaddr->altstatus_addr = ioaddr->ctl_addr;
775 ioaddr->data_addr = ioaddr->cmd_addr + (ATA_REG_DATA << 2);
776 ioaddr->error_addr = ioaddr->cmd_addr + (ATA_REG_ERR << 2);
777 ioaddr->feature_addr = ioaddr->cmd_addr + (ATA_REG_FEATURE << 2);
778 ioaddr->nsect_addr = ioaddr->cmd_addr + (ATA_REG_NSECT << 2);
779 ioaddr->lbal_addr = ioaddr->cmd_addr + (ATA_REG_LBAL << 2);
780 ioaddr->lbam_addr = ioaddr->cmd_addr + (ATA_REG_LBAM << 2);
781 ioaddr->lbah_addr = ioaddr->cmd_addr + (ATA_REG_LBAH << 2);
782 ioaddr->device_addr = ioaddr->cmd_addr + (ATA_REG_DEVICE << 2);
783 ioaddr->status_addr = ioaddr->cmd_addr + (ATA_REG_STATUS << 2);
784 ioaddr->command_addr = ioaddr->cmd_addr + (ATA_REG_CMD << 2);
787 static void sata_rcar_init_controller(struct ata_host *host)
789 struct sata_rcar_priv *priv = host->private_data;
790 void __iomem *base = priv->base;
791 u32 val;
793 /* reset and setup phy */
794 switch (priv->type) {
795 case RCAR_GEN1_SATA:
796 sata_rcar_gen1_phy_init(priv);
797 break;
798 case RCAR_GEN2_SATA:
799 case RCAR_R8A7790_ES1_SATA:
800 sata_rcar_gen2_phy_init(priv);
801 break;
802 default:
803 dev_warn(host->dev, "SATA phy is not initialized\n");
804 break;
807 /* SATA-IP reset state */
808 val = ioread32(base + ATAPI_CONTROL1_REG);
809 val |= ATAPI_CONTROL1_RESET;
810 iowrite32(val, base + ATAPI_CONTROL1_REG);
812 /* ISM mode, PRD mode, DTEND flag at bit 0 */
813 val = ioread32(base + ATAPI_CONTROL1_REG);
814 val |= ATAPI_CONTROL1_ISM;
815 val |= ATAPI_CONTROL1_DESE;
816 val |= ATAPI_CONTROL1_DTA32M;
817 iowrite32(val, base + ATAPI_CONTROL1_REG);
819 /* Release the SATA-IP from the reset state */
820 val = ioread32(base + ATAPI_CONTROL1_REG);
821 val &= ~ATAPI_CONTROL1_RESET;
822 iowrite32(val, base + ATAPI_CONTROL1_REG);
824 /* ack and mask */
825 iowrite32(0, base + SATAINTSTAT_REG);
826 iowrite32(0x7ff, base + SATAINTMASK_REG);
827 /* enable interrupts */
828 iowrite32(ATAPI_INT_ENABLE_SATAINT, base + ATAPI_INT_ENABLE_REG);
831 static struct of_device_id sata_rcar_match[] = {
833 /* Deprecated by "renesas,sata-r8a7779" */
834 .compatible = "renesas,rcar-sata",
835 .data = (void *)RCAR_GEN1_SATA,
838 .compatible = "renesas,sata-r8a7779",
839 .data = (void *)RCAR_GEN1_SATA,
842 .compatible = "renesas,sata-r8a7790",
843 .data = (void *)RCAR_GEN2_SATA
846 .compatible = "renesas,sata-r8a7790-es1",
847 .data = (void *)RCAR_R8A7790_ES1_SATA
850 .compatible = "renesas,sata-r8a7791",
851 .data = (void *)RCAR_GEN2_SATA
854 .compatible = "renesas,sata-r8a7793",
855 .data = (void *)RCAR_GEN2_SATA
857 { },
859 MODULE_DEVICE_TABLE(of, sata_rcar_match);
861 static const struct platform_device_id sata_rcar_id_table[] = {
862 { "sata_rcar", RCAR_GEN1_SATA }, /* Deprecated by "sata-r8a7779" */
863 { "sata-r8a7779", RCAR_GEN1_SATA },
864 { },
866 MODULE_DEVICE_TABLE(platform, sata_rcar_id_table);
868 static int sata_rcar_probe(struct platform_device *pdev)
870 const struct of_device_id *of_id;
871 struct ata_host *host;
872 struct sata_rcar_priv *priv;
873 struct resource *mem;
874 int irq;
875 int ret = 0;
877 irq = platform_get_irq(pdev, 0);
878 if (irq <= 0)
879 return -EINVAL;
881 priv = devm_kzalloc(&pdev->dev, sizeof(struct sata_rcar_priv),
882 GFP_KERNEL);
883 if (!priv)
884 return -ENOMEM;
886 of_id = of_match_device(sata_rcar_match, &pdev->dev);
887 if (of_id)
888 priv->type = (enum sata_rcar_type)of_id->data;
889 else
890 priv->type = platform_get_device_id(pdev)->driver_data;
892 priv->clk = devm_clk_get(&pdev->dev, NULL);
893 if (IS_ERR(priv->clk)) {
894 dev_err(&pdev->dev, "failed to get access to sata clock\n");
895 return PTR_ERR(priv->clk);
897 clk_prepare_enable(priv->clk);
899 host = ata_host_alloc(&pdev->dev, 1);
900 if (!host) {
901 dev_err(&pdev->dev, "ata_host_alloc failed\n");
902 ret = -ENOMEM;
903 goto cleanup;
906 host->private_data = priv;
908 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
909 priv->base = devm_ioremap_resource(&pdev->dev, mem);
910 if (IS_ERR(priv->base)) {
911 ret = PTR_ERR(priv->base);
912 goto cleanup;
915 /* setup port */
916 sata_rcar_setup_port(host);
918 /* initialize host controller */
919 sata_rcar_init_controller(host);
921 ret = ata_host_activate(host, irq, sata_rcar_interrupt, 0,
922 &sata_rcar_sht);
923 if (!ret)
924 return 0;
926 cleanup:
927 clk_disable_unprepare(priv->clk);
929 return ret;
932 static int sata_rcar_remove(struct platform_device *pdev)
934 struct ata_host *host = platform_get_drvdata(pdev);
935 struct sata_rcar_priv *priv = host->private_data;
936 void __iomem *base = priv->base;
938 ata_host_detach(host);
940 /* disable interrupts */
941 iowrite32(0, base + ATAPI_INT_ENABLE_REG);
942 /* ack and mask */
943 iowrite32(0, base + SATAINTSTAT_REG);
944 iowrite32(0x7ff, base + SATAINTMASK_REG);
946 clk_disable_unprepare(priv->clk);
948 return 0;
951 #ifdef CONFIG_PM_SLEEP
952 static int sata_rcar_suspend(struct device *dev)
954 struct ata_host *host = dev_get_drvdata(dev);
955 struct sata_rcar_priv *priv = host->private_data;
956 void __iomem *base = priv->base;
957 int ret;
959 ret = ata_host_suspend(host, PMSG_SUSPEND);
960 if (!ret) {
961 /* disable interrupts */
962 iowrite32(0, base + ATAPI_INT_ENABLE_REG);
963 /* mask */
964 iowrite32(0x7ff, base + SATAINTMASK_REG);
966 clk_disable_unprepare(priv->clk);
969 return ret;
972 static int sata_rcar_resume(struct device *dev)
974 struct ata_host *host = dev_get_drvdata(dev);
975 struct sata_rcar_priv *priv = host->private_data;
976 void __iomem *base = priv->base;
978 clk_prepare_enable(priv->clk);
980 /* ack and mask */
981 iowrite32(0, base + SATAINTSTAT_REG);
982 iowrite32(0x7ff, base + SATAINTMASK_REG);
983 /* enable interrupts */
984 iowrite32(ATAPI_INT_ENABLE_SATAINT, base + ATAPI_INT_ENABLE_REG);
986 ata_host_resume(host);
988 return 0;
991 static int sata_rcar_restore(struct device *dev)
993 struct ata_host *host = dev_get_drvdata(dev);
994 struct sata_rcar_priv *priv = host->private_data;
996 clk_prepare_enable(priv->clk);
998 sata_rcar_setup_port(host);
1000 /* initialize host controller */
1001 sata_rcar_init_controller(host);
1003 ata_host_resume(host);
1005 return 0;
1008 static const struct dev_pm_ops sata_rcar_pm_ops = {
1009 .suspend = sata_rcar_suspend,
1010 .resume = sata_rcar_resume,
1011 .freeze = sata_rcar_suspend,
1012 .thaw = sata_rcar_resume,
1013 .poweroff = sata_rcar_suspend,
1014 .restore = sata_rcar_restore,
1016 #endif
1018 static struct platform_driver sata_rcar_driver = {
1019 .probe = sata_rcar_probe,
1020 .remove = sata_rcar_remove,
1021 .id_table = sata_rcar_id_table,
1022 .driver = {
1023 .name = DRV_NAME,
1024 .of_match_table = sata_rcar_match,
1025 #ifdef CONFIG_PM_SLEEP
1026 .pm = &sata_rcar_pm_ops,
1027 #endif
1031 module_platform_driver(sata_rcar_driver);
1033 MODULE_LICENSE("GPL");
1034 MODULE_AUTHOR("Vladimir Barinov");
1035 MODULE_DESCRIPTION("Renesas R-Car SATA controller low level driver");