xref: /openbmc/linux/drivers/ata/sata_rcar.c (revision 2cf1c348)
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Renesas R-Car SATA driver
4  *
5  * Author: Vladimir Barinov <source@cogentembedded.com>
6  * Copyright (C) 2013-2015 Cogent Embedded, Inc.
7  * Copyright (C) 2013-2015 Renesas Solutions Corp.
8  */
9 
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/ata.h>
13 #include <linux/libata.h>
14 #include <linux/of_device.h>
15 #include <linux/platform_device.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/err.h>
18 
19 #define DRV_NAME "sata_rcar"
20 
21 /* SH-Navi2G/ATAPI-ATA compatible task registers */
22 #define DATA_REG			0x100
23 #define SDEVCON_REG			0x138
24 
25 /* SH-Navi2G/ATAPI module compatible control registers */
26 #define ATAPI_CONTROL1_REG		0x180
27 #define ATAPI_STATUS_REG		0x184
28 #define ATAPI_INT_ENABLE_REG		0x188
29 #define ATAPI_DTB_ADR_REG		0x198
30 #define ATAPI_DMA_START_ADR_REG		0x19C
31 #define ATAPI_DMA_TRANS_CNT_REG		0x1A0
32 #define ATAPI_CONTROL2_REG		0x1A4
33 #define ATAPI_SIG_ST_REG		0x1B0
34 #define ATAPI_BYTE_SWAP_REG		0x1BC
35 
36 /* ATAPI control 1 register (ATAPI_CONTROL1) bits */
37 #define ATAPI_CONTROL1_ISM		BIT(16)
38 #define ATAPI_CONTROL1_DTA32M		BIT(11)
39 #define ATAPI_CONTROL1_RESET		BIT(7)
40 #define ATAPI_CONTROL1_DESE		BIT(3)
41 #define ATAPI_CONTROL1_RW		BIT(2)
42 #define ATAPI_CONTROL1_STOP		BIT(1)
43 #define ATAPI_CONTROL1_START		BIT(0)
44 
45 /* ATAPI status register (ATAPI_STATUS) bits */
46 #define ATAPI_STATUS_SATAINT		BIT(11)
47 #define ATAPI_STATUS_DNEND		BIT(6)
48 #define ATAPI_STATUS_DEVTRM		BIT(5)
49 #define ATAPI_STATUS_DEVINT		BIT(4)
50 #define ATAPI_STATUS_ERR		BIT(2)
51 #define ATAPI_STATUS_NEND		BIT(1)
52 #define ATAPI_STATUS_ACT		BIT(0)
53 
54 /* Interrupt enable register (ATAPI_INT_ENABLE) bits */
55 #define ATAPI_INT_ENABLE_SATAINT	BIT(11)
56 #define ATAPI_INT_ENABLE_DNEND		BIT(6)
57 #define ATAPI_INT_ENABLE_DEVTRM		BIT(5)
58 #define ATAPI_INT_ENABLE_DEVINT		BIT(4)
59 #define ATAPI_INT_ENABLE_ERR		BIT(2)
60 #define ATAPI_INT_ENABLE_NEND		BIT(1)
61 #define ATAPI_INT_ENABLE_ACT		BIT(0)
62 
63 /* Access control registers for physical layer control register */
64 #define SATAPHYADDR_REG			0x200
65 #define SATAPHYWDATA_REG		0x204
66 #define SATAPHYACCEN_REG		0x208
67 #define SATAPHYRESET_REG		0x20C
68 #define SATAPHYRDATA_REG		0x210
69 #define SATAPHYACK_REG			0x214
70 
71 /* Physical layer control address command register (SATAPHYADDR) bits */
72 #define SATAPHYADDR_PHYRATEMODE		BIT(10)
73 #define SATAPHYADDR_PHYCMD_READ		BIT(9)
74 #define SATAPHYADDR_PHYCMD_WRITE	BIT(8)
75 
76 /* Physical layer control enable register (SATAPHYACCEN) bits */
77 #define SATAPHYACCEN_PHYLANE		BIT(0)
78 
79 /* Physical layer control reset register (SATAPHYRESET) bits */
80 #define SATAPHYRESET_PHYRST		BIT(1)
81 #define SATAPHYRESET_PHYSRES		BIT(0)
82 
83 /* Physical layer control acknowledge register (SATAPHYACK) bits */
84 #define SATAPHYACK_PHYACK		BIT(0)
85 
86 /* Serial-ATA HOST control registers */
87 #define BISTCONF_REG			0x102C
88 #define SDATA_REG			0x1100
89 #define SSDEVCON_REG			0x1204
90 
91 #define SCRSSTS_REG			0x1400
92 #define SCRSERR_REG			0x1404
93 #define SCRSCON_REG			0x1408
94 #define SCRSACT_REG			0x140C
95 
96 #define SATAINTSTAT_REG			0x1508
97 #define SATAINTMASK_REG			0x150C
98 
99 /* SATA INT status register (SATAINTSTAT) bits */
100 #define SATAINTSTAT_SERR		BIT(3)
101 #define SATAINTSTAT_ATA			BIT(0)
102 
103 /* SATA INT mask register (SATAINTSTAT) bits */
104 #define SATAINTMASK_SERRMSK		BIT(3)
105 #define SATAINTMASK_ERRMSK		BIT(2)
106 #define SATAINTMASK_ERRCRTMSK		BIT(1)
107 #define SATAINTMASK_ATAMSK		BIT(0)
108 #define SATAINTMASK_ALL_GEN1		0x7ff
109 #define SATAINTMASK_ALL_GEN2		0xfff
110 
111 #define SATA_RCAR_INT_MASK		(SATAINTMASK_SERRMSK | \
112 					 SATAINTMASK_ATAMSK)
113 
114 /* Physical Layer Control Registers */
115 #define SATAPCTLR1_REG			0x43
116 #define SATAPCTLR2_REG			0x52
117 #define SATAPCTLR3_REG			0x5A
118 #define SATAPCTLR4_REG			0x60
119 
120 /* Descriptor table word 0 bit (when DTA32M = 1) */
121 #define SATA_RCAR_DTEND			BIT(0)
122 
123 #define SATA_RCAR_DMA_BOUNDARY		0x1FFFFFFFUL
124 
125 /* Gen2 Physical Layer Control Registers */
126 #define RCAR_GEN2_PHY_CTL1_REG		0x1704
127 #define RCAR_GEN2_PHY_CTL1		0x34180002
128 #define RCAR_GEN2_PHY_CTL1_SS		0xC180	/* Spread Spectrum */
129 
130 #define RCAR_GEN2_PHY_CTL2_REG		0x170C
131 #define RCAR_GEN2_PHY_CTL2		0x00002303
132 
133 #define RCAR_GEN2_PHY_CTL3_REG		0x171C
134 #define RCAR_GEN2_PHY_CTL3		0x000B0194
135 
136 #define RCAR_GEN2_PHY_CTL4_REG		0x1724
137 #define RCAR_GEN2_PHY_CTL4		0x00030994
138 
139 #define RCAR_GEN2_PHY_CTL5_REG		0x1740
140 #define RCAR_GEN2_PHY_CTL5		0x03004001
141 #define RCAR_GEN2_PHY_CTL5_DC		BIT(1)	/* DC connection */
142 #define RCAR_GEN2_PHY_CTL5_TR		BIT(2)	/* Termination Resistor */
143 
144 enum sata_rcar_type {
145 	RCAR_GEN1_SATA,
146 	RCAR_GEN2_SATA,
147 	RCAR_GEN3_SATA,
148 	RCAR_R8A7790_ES1_SATA,
149 };
150 
151 struct sata_rcar_priv {
152 	void __iomem *base;
153 	u32 sataint_mask;
154 	enum sata_rcar_type type;
155 };
156 
157 static void sata_rcar_gen1_phy_preinit(struct sata_rcar_priv *priv)
158 {
159 	void __iomem *base = priv->base;
160 
161 	/* idle state */
162 	iowrite32(0, base + SATAPHYADDR_REG);
163 	/* reset */
164 	iowrite32(SATAPHYRESET_PHYRST, base + SATAPHYRESET_REG);
165 	udelay(10);
166 	/* deassert reset */
167 	iowrite32(0, base + SATAPHYRESET_REG);
168 }
169 
170 static void sata_rcar_gen1_phy_write(struct sata_rcar_priv *priv, u16 reg,
171 				     u32 val, int group)
172 {
173 	void __iomem *base = priv->base;
174 	int timeout;
175 
176 	/* deassert reset */
177 	iowrite32(0, base + SATAPHYRESET_REG);
178 	/* lane 1 */
179 	iowrite32(SATAPHYACCEN_PHYLANE, base + SATAPHYACCEN_REG);
180 	/* write phy register value */
181 	iowrite32(val, base + SATAPHYWDATA_REG);
182 	/* set register group */
183 	if (group)
184 		reg |= SATAPHYADDR_PHYRATEMODE;
185 	/* write command */
186 	iowrite32(SATAPHYADDR_PHYCMD_WRITE | reg, base + SATAPHYADDR_REG);
187 	/* wait for ack */
188 	for (timeout = 0; timeout < 100; timeout++) {
189 		val = ioread32(base + SATAPHYACK_REG);
190 		if (val & SATAPHYACK_PHYACK)
191 			break;
192 	}
193 	if (timeout >= 100)
194 		pr_err("%s timeout\n", __func__);
195 	/* idle state */
196 	iowrite32(0, base + SATAPHYADDR_REG);
197 }
198 
199 static void sata_rcar_gen1_phy_init(struct sata_rcar_priv *priv)
200 {
201 	sata_rcar_gen1_phy_preinit(priv);
202 	sata_rcar_gen1_phy_write(priv, SATAPCTLR1_REG, 0x00200188, 0);
203 	sata_rcar_gen1_phy_write(priv, SATAPCTLR1_REG, 0x00200188, 1);
204 	sata_rcar_gen1_phy_write(priv, SATAPCTLR3_REG, 0x0000A061, 0);
205 	sata_rcar_gen1_phy_write(priv, SATAPCTLR2_REG, 0x20000000, 0);
206 	sata_rcar_gen1_phy_write(priv, SATAPCTLR2_REG, 0x20000000, 1);
207 	sata_rcar_gen1_phy_write(priv, SATAPCTLR4_REG, 0x28E80000, 0);
208 }
209 
210 static void sata_rcar_gen2_phy_init(struct sata_rcar_priv *priv)
211 {
212 	void __iomem *base = priv->base;
213 
214 	iowrite32(RCAR_GEN2_PHY_CTL1, base + RCAR_GEN2_PHY_CTL1_REG);
215 	iowrite32(RCAR_GEN2_PHY_CTL2, base + RCAR_GEN2_PHY_CTL2_REG);
216 	iowrite32(RCAR_GEN2_PHY_CTL3, base + RCAR_GEN2_PHY_CTL3_REG);
217 	iowrite32(RCAR_GEN2_PHY_CTL4, base + RCAR_GEN2_PHY_CTL4_REG);
218 	iowrite32(RCAR_GEN2_PHY_CTL5 | RCAR_GEN2_PHY_CTL5_DC |
219 		  RCAR_GEN2_PHY_CTL5_TR, base + RCAR_GEN2_PHY_CTL5_REG);
220 }
221 
222 static void sata_rcar_freeze(struct ata_port *ap)
223 {
224 	struct sata_rcar_priv *priv = ap->host->private_data;
225 
226 	/* mask */
227 	iowrite32(priv->sataint_mask, priv->base + SATAINTMASK_REG);
228 
229 	ata_sff_freeze(ap);
230 }
231 
232 static void sata_rcar_thaw(struct ata_port *ap)
233 {
234 	struct sata_rcar_priv *priv = ap->host->private_data;
235 	void __iomem *base = priv->base;
236 
237 	/* ack */
238 	iowrite32(~(u32)SATA_RCAR_INT_MASK, base + SATAINTSTAT_REG);
239 
240 	ata_sff_thaw(ap);
241 
242 	/* unmask */
243 	iowrite32(priv->sataint_mask & ~SATA_RCAR_INT_MASK, base + SATAINTMASK_REG);
244 }
245 
246 static void sata_rcar_ioread16_rep(void __iomem *reg, void *buffer, int count)
247 {
248 	u16 *ptr = buffer;
249 
250 	while (count--) {
251 		u16 data = ioread32(reg);
252 
253 		*ptr++ = data;
254 	}
255 }
256 
257 static void sata_rcar_iowrite16_rep(void __iomem *reg, void *buffer, int count)
258 {
259 	const u16 *ptr = buffer;
260 
261 	while (count--)
262 		iowrite32(*ptr++, reg);
263 }
264 
265 static u8 sata_rcar_check_status(struct ata_port *ap)
266 {
267 	return ioread32(ap->ioaddr.status_addr);
268 }
269 
270 static u8 sata_rcar_check_altstatus(struct ata_port *ap)
271 {
272 	return ioread32(ap->ioaddr.altstatus_addr);
273 }
274 
275 static void sata_rcar_set_devctl(struct ata_port *ap, u8 ctl)
276 {
277 	iowrite32(ctl, ap->ioaddr.ctl_addr);
278 }
279 
280 static void sata_rcar_dev_select(struct ata_port *ap, unsigned int device)
281 {
282 	iowrite32(ATA_DEVICE_OBS, ap->ioaddr.device_addr);
283 	ata_sff_pause(ap);	/* needed; also flushes, for mmio */
284 }
285 
286 static unsigned int sata_rcar_ata_devchk(struct ata_port *ap,
287 					 unsigned int device)
288 {
289 	struct ata_ioports *ioaddr = &ap->ioaddr;
290 	u8 nsect, lbal;
291 
292 	sata_rcar_dev_select(ap, device);
293 
294 	iowrite32(0x55, ioaddr->nsect_addr);
295 	iowrite32(0xaa, ioaddr->lbal_addr);
296 
297 	iowrite32(0xaa, ioaddr->nsect_addr);
298 	iowrite32(0x55, ioaddr->lbal_addr);
299 
300 	iowrite32(0x55, ioaddr->nsect_addr);
301 	iowrite32(0xaa, ioaddr->lbal_addr);
302 
303 	nsect = ioread32(ioaddr->nsect_addr);
304 	lbal  = ioread32(ioaddr->lbal_addr);
305 
306 	if (nsect == 0x55 && lbal == 0xaa)
307 		return 1;	/* found a device */
308 
309 	return 0;		/* nothing found */
310 }
311 
312 static int sata_rcar_wait_after_reset(struct ata_link *link,
313 				      unsigned long deadline)
314 {
315 	struct ata_port *ap = link->ap;
316 
317 	ata_msleep(ap, ATA_WAIT_AFTER_RESET);
318 
319 	return ata_sff_wait_ready(link, deadline);
320 }
321 
322 static int sata_rcar_bus_softreset(struct ata_port *ap, unsigned long deadline)
323 {
324 	struct ata_ioports *ioaddr = &ap->ioaddr;
325 
326 	/* software reset.  causes dev0 to be selected */
327 	iowrite32(ap->ctl, ioaddr->ctl_addr);
328 	udelay(20);
329 	iowrite32(ap->ctl | ATA_SRST, ioaddr->ctl_addr);
330 	udelay(20);
331 	iowrite32(ap->ctl, ioaddr->ctl_addr);
332 	ap->last_ctl = ap->ctl;
333 
334 	/* wait the port to become ready */
335 	return sata_rcar_wait_after_reset(&ap->link, deadline);
336 }
337 
338 static int sata_rcar_softreset(struct ata_link *link, unsigned int *classes,
339 			       unsigned long deadline)
340 {
341 	struct ata_port *ap = link->ap;
342 	unsigned int devmask = 0;
343 	int rc;
344 	u8 err;
345 
346 	/* determine if device 0 is present */
347 	if (sata_rcar_ata_devchk(ap, 0))
348 		devmask |= 1 << 0;
349 
350 	/* issue bus reset */
351 	rc = sata_rcar_bus_softreset(ap, deadline);
352 	/* if link is occupied, -ENODEV too is an error */
353 	if (rc && (rc != -ENODEV || sata_scr_valid(link))) {
354 		ata_link_err(link, "SRST failed (errno=%d)\n", rc);
355 		return rc;
356 	}
357 
358 	/* determine by signature whether we have ATA or ATAPI devices */
359 	classes[0] = ata_sff_dev_classify(&link->device[0], devmask, &err);
360 
361 	return 0;
362 }
363 
364 static void sata_rcar_tf_load(struct ata_port *ap,
365 			      const struct ata_taskfile *tf)
366 {
367 	struct ata_ioports *ioaddr = &ap->ioaddr;
368 	unsigned int is_addr = tf->flags & ATA_TFLAG_ISADDR;
369 
370 	if (tf->ctl != ap->last_ctl) {
371 		iowrite32(tf->ctl, ioaddr->ctl_addr);
372 		ap->last_ctl = tf->ctl;
373 		ata_wait_idle(ap);
374 	}
375 
376 	if (is_addr && (tf->flags & ATA_TFLAG_LBA48)) {
377 		iowrite32(tf->hob_feature, ioaddr->feature_addr);
378 		iowrite32(tf->hob_nsect, ioaddr->nsect_addr);
379 		iowrite32(tf->hob_lbal, ioaddr->lbal_addr);
380 		iowrite32(tf->hob_lbam, ioaddr->lbam_addr);
381 		iowrite32(tf->hob_lbah, ioaddr->lbah_addr);
382 	}
383 
384 	if (is_addr) {
385 		iowrite32(tf->feature, ioaddr->feature_addr);
386 		iowrite32(tf->nsect, ioaddr->nsect_addr);
387 		iowrite32(tf->lbal, ioaddr->lbal_addr);
388 		iowrite32(tf->lbam, ioaddr->lbam_addr);
389 		iowrite32(tf->lbah, ioaddr->lbah_addr);
390 	}
391 
392 	if (tf->flags & ATA_TFLAG_DEVICE)
393 		iowrite32(tf->device, ioaddr->device_addr);
394 
395 	ata_wait_idle(ap);
396 }
397 
398 static void sata_rcar_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
399 {
400 	struct ata_ioports *ioaddr = &ap->ioaddr;
401 
402 	tf->command = sata_rcar_check_status(ap);
403 	tf->feature = ioread32(ioaddr->error_addr);
404 	tf->nsect = ioread32(ioaddr->nsect_addr);
405 	tf->lbal = ioread32(ioaddr->lbal_addr);
406 	tf->lbam = ioread32(ioaddr->lbam_addr);
407 	tf->lbah = ioread32(ioaddr->lbah_addr);
408 	tf->device = ioread32(ioaddr->device_addr);
409 
410 	if (tf->flags & ATA_TFLAG_LBA48) {
411 		iowrite32(tf->ctl | ATA_HOB, ioaddr->ctl_addr);
412 		tf->hob_feature = ioread32(ioaddr->error_addr);
413 		tf->hob_nsect = ioread32(ioaddr->nsect_addr);
414 		tf->hob_lbal = ioread32(ioaddr->lbal_addr);
415 		tf->hob_lbam = ioread32(ioaddr->lbam_addr);
416 		tf->hob_lbah = ioread32(ioaddr->lbah_addr);
417 		iowrite32(tf->ctl, ioaddr->ctl_addr);
418 		ap->last_ctl = tf->ctl;
419 	}
420 }
421 
422 static void sata_rcar_exec_command(struct ata_port *ap,
423 				   const struct ata_taskfile *tf)
424 {
425 	iowrite32(tf->command, ap->ioaddr.command_addr);
426 	ata_sff_pause(ap);
427 }
428 
429 static unsigned int sata_rcar_data_xfer(struct ata_queued_cmd *qc,
430 					      unsigned char *buf,
431 					      unsigned int buflen, int rw)
432 {
433 	struct ata_port *ap = qc->dev->link->ap;
434 	void __iomem *data_addr = ap->ioaddr.data_addr;
435 	unsigned int words = buflen >> 1;
436 
437 	/* Transfer multiple of 2 bytes */
438 	if (rw == READ)
439 		sata_rcar_ioread16_rep(data_addr, buf, words);
440 	else
441 		sata_rcar_iowrite16_rep(data_addr, buf, words);
442 
443 	/* Transfer trailing byte, if any. */
444 	if (unlikely(buflen & 0x01)) {
445 		unsigned char pad[2] = { };
446 
447 		/* Point buf to the tail of buffer */
448 		buf += buflen - 1;
449 
450 		/*
451 		 * Use io*16_rep() accessors here as well to avoid pointlessly
452 		 * swapping bytes to and from on the big endian machines...
453 		 */
454 		if (rw == READ) {
455 			sata_rcar_ioread16_rep(data_addr, pad, 1);
456 			*buf = pad[0];
457 		} else {
458 			pad[0] = *buf;
459 			sata_rcar_iowrite16_rep(data_addr, pad, 1);
460 		}
461 		words++;
462 	}
463 
464 	return words << 1;
465 }
466 
467 static void sata_rcar_drain_fifo(struct ata_queued_cmd *qc)
468 {
469 	int count;
470 	struct ata_port *ap;
471 
472 	/* We only need to flush incoming data when a command was running */
473 	if (qc == NULL || qc->dma_dir == DMA_TO_DEVICE)
474 		return;
475 
476 	ap = qc->ap;
477 	/* Drain up to 64K of data before we give up this recovery method */
478 	for (count = 0; (ap->ops->sff_check_status(ap) & ATA_DRQ) &&
479 			count < 65536; count += 2)
480 		ioread32(ap->ioaddr.data_addr);
481 
482 	if (count)
483 		ata_port_dbg(ap, "drained %d bytes to clear DRQ\n", count);
484 }
485 
486 static int sata_rcar_scr_read(struct ata_link *link, unsigned int sc_reg,
487 			      u32 *val)
488 {
489 	if (sc_reg > SCR_ACTIVE)
490 		return -EINVAL;
491 
492 	*val = ioread32(link->ap->ioaddr.scr_addr + (sc_reg << 2));
493 	return 0;
494 }
495 
496 static int sata_rcar_scr_write(struct ata_link *link, unsigned int sc_reg,
497 			       u32 val)
498 {
499 	if (sc_reg > SCR_ACTIVE)
500 		return -EINVAL;
501 
502 	iowrite32(val, link->ap->ioaddr.scr_addr + (sc_reg << 2));
503 	return 0;
504 }
505 
506 static void sata_rcar_bmdma_fill_sg(struct ata_queued_cmd *qc)
507 {
508 	struct ata_port *ap = qc->ap;
509 	struct ata_bmdma_prd *prd = ap->bmdma_prd;
510 	struct scatterlist *sg;
511 	unsigned int si;
512 
513 	for_each_sg(qc->sg, sg, qc->n_elem, si) {
514 		u32 addr, sg_len;
515 
516 		/*
517 		 * Note: h/w doesn't support 64-bit, so we unconditionally
518 		 * truncate dma_addr_t to u32.
519 		 */
520 		addr = (u32)sg_dma_address(sg);
521 		sg_len = sg_dma_len(sg);
522 
523 		prd[si].addr = cpu_to_le32(addr);
524 		prd[si].flags_len = cpu_to_le32(sg_len);
525 	}
526 
527 	/* end-of-table flag */
528 	prd[si - 1].addr |= cpu_to_le32(SATA_RCAR_DTEND);
529 }
530 
531 static enum ata_completion_errors sata_rcar_qc_prep(struct ata_queued_cmd *qc)
532 {
533 	if (!(qc->flags & ATA_QCFLAG_DMAMAP))
534 		return AC_ERR_OK;
535 
536 	sata_rcar_bmdma_fill_sg(qc);
537 
538 	return AC_ERR_OK;
539 }
540 
541 static void sata_rcar_bmdma_setup(struct ata_queued_cmd *qc)
542 {
543 	struct ata_port *ap = qc->ap;
544 	unsigned int rw = qc->tf.flags & ATA_TFLAG_WRITE;
545 	struct sata_rcar_priv *priv = ap->host->private_data;
546 	void __iomem *base = priv->base;
547 	u32 dmactl;
548 
549 	/* load PRD table addr. */
550 	mb();   /* make sure PRD table writes are visible to controller */
551 	iowrite32(ap->bmdma_prd_dma, base + ATAPI_DTB_ADR_REG);
552 
553 	/* specify data direction, triple-check start bit is clear */
554 	dmactl = ioread32(base + ATAPI_CONTROL1_REG);
555 	dmactl &= ~(ATAPI_CONTROL1_RW | ATAPI_CONTROL1_STOP);
556 	if (dmactl & ATAPI_CONTROL1_START) {
557 		dmactl &= ~ATAPI_CONTROL1_START;
558 		dmactl |= ATAPI_CONTROL1_STOP;
559 	}
560 	if (!rw)
561 		dmactl |= ATAPI_CONTROL1_RW;
562 	iowrite32(dmactl, base + ATAPI_CONTROL1_REG);
563 
564 	/* issue r/w command */
565 	ap->ops->sff_exec_command(ap, &qc->tf);
566 }
567 
568 static void sata_rcar_bmdma_start(struct ata_queued_cmd *qc)
569 {
570 	struct ata_port *ap = qc->ap;
571 	struct sata_rcar_priv *priv = ap->host->private_data;
572 	void __iomem *base = priv->base;
573 	u32 dmactl;
574 
575 	/* start host DMA transaction */
576 	dmactl = ioread32(base + ATAPI_CONTROL1_REG);
577 	dmactl &= ~ATAPI_CONTROL1_STOP;
578 	dmactl |= ATAPI_CONTROL1_START;
579 	iowrite32(dmactl, base + ATAPI_CONTROL1_REG);
580 }
581 
582 static void sata_rcar_bmdma_stop(struct ata_queued_cmd *qc)
583 {
584 	struct ata_port *ap = qc->ap;
585 	struct sata_rcar_priv *priv = ap->host->private_data;
586 	void __iomem *base = priv->base;
587 	u32 dmactl;
588 
589 	/* force termination of DMA transfer if active */
590 	dmactl = ioread32(base + ATAPI_CONTROL1_REG);
591 	if (dmactl & ATAPI_CONTROL1_START) {
592 		dmactl &= ~ATAPI_CONTROL1_START;
593 		dmactl |= ATAPI_CONTROL1_STOP;
594 		iowrite32(dmactl, base + ATAPI_CONTROL1_REG);
595 	}
596 
597 	/* one-PIO-cycle guaranteed wait, per spec, for HDMA1:0 transition */
598 	ata_sff_dma_pause(ap);
599 }
600 
601 static u8 sata_rcar_bmdma_status(struct ata_port *ap)
602 {
603 	struct sata_rcar_priv *priv = ap->host->private_data;
604 	u8 host_stat = 0;
605 	u32 status;
606 
607 	status = ioread32(priv->base + ATAPI_STATUS_REG);
608 	if (status & ATAPI_STATUS_DEVINT)
609 		host_stat |= ATA_DMA_INTR;
610 	if (status & ATAPI_STATUS_ACT)
611 		host_stat |= ATA_DMA_ACTIVE;
612 
613 	return host_stat;
614 }
615 
616 static struct scsi_host_template sata_rcar_sht = {
617 	ATA_BASE_SHT(DRV_NAME),
618 	/*
619 	 * This controller allows transfer chunks up to 512MB which cross 64KB
620 	 * boundaries, therefore the DMA limits are more relaxed than standard
621 	 * ATA SFF.
622 	 */
623 	.sg_tablesize		= ATA_MAX_PRD,
624 	.dma_boundary		= SATA_RCAR_DMA_BOUNDARY,
625 };
626 
627 static struct ata_port_operations sata_rcar_port_ops = {
628 	.inherits		= &ata_bmdma_port_ops,
629 
630 	.freeze			= sata_rcar_freeze,
631 	.thaw			= sata_rcar_thaw,
632 	.softreset		= sata_rcar_softreset,
633 
634 	.scr_read		= sata_rcar_scr_read,
635 	.scr_write		= sata_rcar_scr_write,
636 
637 	.sff_dev_select		= sata_rcar_dev_select,
638 	.sff_set_devctl		= sata_rcar_set_devctl,
639 	.sff_check_status	= sata_rcar_check_status,
640 	.sff_check_altstatus	= sata_rcar_check_altstatus,
641 	.sff_tf_load		= sata_rcar_tf_load,
642 	.sff_tf_read		= sata_rcar_tf_read,
643 	.sff_exec_command	= sata_rcar_exec_command,
644 	.sff_data_xfer		= sata_rcar_data_xfer,
645 	.sff_drain_fifo		= sata_rcar_drain_fifo,
646 
647 	.qc_prep		= sata_rcar_qc_prep,
648 
649 	.bmdma_setup		= sata_rcar_bmdma_setup,
650 	.bmdma_start		= sata_rcar_bmdma_start,
651 	.bmdma_stop		= sata_rcar_bmdma_stop,
652 	.bmdma_status		= sata_rcar_bmdma_status,
653 };
654 
655 static void sata_rcar_serr_interrupt(struct ata_port *ap)
656 {
657 	struct sata_rcar_priv *priv = ap->host->private_data;
658 	struct ata_eh_info *ehi = &ap->link.eh_info;
659 	int freeze = 0;
660 	u32 serror;
661 
662 	serror = ioread32(priv->base + SCRSERR_REG);
663 	if (!serror)
664 		return;
665 
666 	ata_port_dbg(ap, "SError @host_intr: 0x%x\n", serror);
667 
668 	/* first, analyze and record host port events */
669 	ata_ehi_clear_desc(ehi);
670 
671 	if (serror & (SERR_DEV_XCHG | SERR_PHYRDY_CHG)) {
672 		/* Setup a soft-reset EH action */
673 		ata_ehi_hotplugged(ehi);
674 		ata_ehi_push_desc(ehi, "%s", "hotplug");
675 
676 		freeze = serror & SERR_COMM_WAKE ? 0 : 1;
677 	}
678 
679 	/* freeze or abort */
680 	if (freeze)
681 		ata_port_freeze(ap);
682 	else
683 		ata_port_abort(ap);
684 }
685 
686 static void sata_rcar_ata_interrupt(struct ata_port *ap)
687 {
688 	struct ata_queued_cmd *qc;
689 	int handled = 0;
690 
691 	qc = ata_qc_from_tag(ap, ap->link.active_tag);
692 	if (qc)
693 		handled |= ata_bmdma_port_intr(ap, qc);
694 
695 	/* be sure to clear ATA interrupt */
696 	if (!handled)
697 		sata_rcar_check_status(ap);
698 }
699 
700 static irqreturn_t sata_rcar_interrupt(int irq, void *dev_instance)
701 {
702 	struct ata_host *host = dev_instance;
703 	struct sata_rcar_priv *priv = host->private_data;
704 	void __iomem *base = priv->base;
705 	unsigned int handled = 0;
706 	struct ata_port *ap;
707 	u32 sataintstat;
708 	unsigned long flags;
709 
710 	spin_lock_irqsave(&host->lock, flags);
711 
712 	sataintstat = ioread32(base + SATAINTSTAT_REG);
713 	sataintstat &= SATA_RCAR_INT_MASK;
714 	if (!sataintstat)
715 		goto done;
716 	/* ack */
717 	iowrite32(~sataintstat & priv->sataint_mask, base + SATAINTSTAT_REG);
718 
719 	ap = host->ports[0];
720 
721 	if (sataintstat & SATAINTSTAT_ATA)
722 		sata_rcar_ata_interrupt(ap);
723 
724 	if (sataintstat & SATAINTSTAT_SERR)
725 		sata_rcar_serr_interrupt(ap);
726 
727 	handled = 1;
728 done:
729 	spin_unlock_irqrestore(&host->lock, flags);
730 
731 	return IRQ_RETVAL(handled);
732 }
733 
734 static void sata_rcar_setup_port(struct ata_host *host)
735 {
736 	struct ata_port *ap = host->ports[0];
737 	struct ata_ioports *ioaddr = &ap->ioaddr;
738 	struct sata_rcar_priv *priv = host->private_data;
739 	void __iomem *base = priv->base;
740 
741 	ap->ops		= &sata_rcar_port_ops;
742 	ap->pio_mask	= ATA_PIO4;
743 	ap->udma_mask	= ATA_UDMA6;
744 	ap->flags	|= ATA_FLAG_SATA;
745 
746 	if (priv->type == RCAR_R8A7790_ES1_SATA)
747 		ap->flags	|= ATA_FLAG_NO_DIPM;
748 
749 	ioaddr->cmd_addr = base + SDATA_REG;
750 	ioaddr->ctl_addr = base + SSDEVCON_REG;
751 	ioaddr->scr_addr = base + SCRSSTS_REG;
752 	ioaddr->altstatus_addr = ioaddr->ctl_addr;
753 
754 	ioaddr->data_addr	= ioaddr->cmd_addr + (ATA_REG_DATA << 2);
755 	ioaddr->error_addr	= ioaddr->cmd_addr + (ATA_REG_ERR << 2);
756 	ioaddr->feature_addr	= ioaddr->cmd_addr + (ATA_REG_FEATURE << 2);
757 	ioaddr->nsect_addr	= ioaddr->cmd_addr + (ATA_REG_NSECT << 2);
758 	ioaddr->lbal_addr	= ioaddr->cmd_addr + (ATA_REG_LBAL << 2);
759 	ioaddr->lbam_addr	= ioaddr->cmd_addr + (ATA_REG_LBAM << 2);
760 	ioaddr->lbah_addr	= ioaddr->cmd_addr + (ATA_REG_LBAH << 2);
761 	ioaddr->device_addr	= ioaddr->cmd_addr + (ATA_REG_DEVICE << 2);
762 	ioaddr->status_addr	= ioaddr->cmd_addr + (ATA_REG_STATUS << 2);
763 	ioaddr->command_addr	= ioaddr->cmd_addr + (ATA_REG_CMD << 2);
764 }
765 
766 static void sata_rcar_init_module(struct sata_rcar_priv *priv)
767 {
768 	void __iomem *base = priv->base;
769 	u32 val;
770 
771 	/* SATA-IP reset state */
772 	val = ioread32(base + ATAPI_CONTROL1_REG);
773 	val |= ATAPI_CONTROL1_RESET;
774 	iowrite32(val, base + ATAPI_CONTROL1_REG);
775 
776 	/* ISM mode, PRD mode, DTEND flag at bit 0 */
777 	val = ioread32(base + ATAPI_CONTROL1_REG);
778 	val |= ATAPI_CONTROL1_ISM;
779 	val |= ATAPI_CONTROL1_DESE;
780 	val |= ATAPI_CONTROL1_DTA32M;
781 	iowrite32(val, base + ATAPI_CONTROL1_REG);
782 
783 	/* Release the SATA-IP from the reset state */
784 	val = ioread32(base + ATAPI_CONTROL1_REG);
785 	val &= ~ATAPI_CONTROL1_RESET;
786 	iowrite32(val, base + ATAPI_CONTROL1_REG);
787 
788 	/* ack and mask */
789 	iowrite32(0, base + SATAINTSTAT_REG);
790 	iowrite32(priv->sataint_mask, base + SATAINTMASK_REG);
791 
792 	/* enable interrupts */
793 	iowrite32(ATAPI_INT_ENABLE_SATAINT, base + ATAPI_INT_ENABLE_REG);
794 }
795 
796 static void sata_rcar_init_controller(struct ata_host *host)
797 {
798 	struct sata_rcar_priv *priv = host->private_data;
799 
800 	priv->sataint_mask = SATAINTMASK_ALL_GEN2;
801 
802 	/* reset and setup phy */
803 	switch (priv->type) {
804 	case RCAR_GEN1_SATA:
805 		priv->sataint_mask = SATAINTMASK_ALL_GEN1;
806 		sata_rcar_gen1_phy_init(priv);
807 		break;
808 	case RCAR_GEN2_SATA:
809 	case RCAR_R8A7790_ES1_SATA:
810 		sata_rcar_gen2_phy_init(priv);
811 		break;
812 	case RCAR_GEN3_SATA:
813 		break;
814 	default:
815 		dev_warn(host->dev, "SATA phy is not initialized\n");
816 		break;
817 	}
818 
819 	sata_rcar_init_module(priv);
820 }
821 
822 static const struct of_device_id sata_rcar_match[] = {
823 	{
824 		/* Deprecated by "renesas,sata-r8a7779" */
825 		.compatible = "renesas,rcar-sata",
826 		.data = (void *)RCAR_GEN1_SATA,
827 	},
828 	{
829 		.compatible = "renesas,sata-r8a7779",
830 		.data = (void *)RCAR_GEN1_SATA,
831 	},
832 	{
833 		.compatible = "renesas,sata-r8a7790",
834 		.data = (void *)RCAR_GEN2_SATA
835 	},
836 	{
837 		.compatible = "renesas,sata-r8a7790-es1",
838 		.data = (void *)RCAR_R8A7790_ES1_SATA
839 	},
840 	{
841 		.compatible = "renesas,sata-r8a7791",
842 		.data = (void *)RCAR_GEN2_SATA
843 	},
844 	{
845 		.compatible = "renesas,sata-r8a7793",
846 		.data = (void *)RCAR_GEN2_SATA
847 	},
848 	{
849 		.compatible = "renesas,sata-r8a7795",
850 		.data = (void *)RCAR_GEN3_SATA
851 	},
852 	{
853 		.compatible = "renesas,rcar-gen2-sata",
854 		.data = (void *)RCAR_GEN2_SATA
855 	},
856 	{
857 		.compatible = "renesas,rcar-gen3-sata",
858 		.data = (void *)RCAR_GEN3_SATA
859 	},
860 	{ },
861 };
862 MODULE_DEVICE_TABLE(of, sata_rcar_match);
863 
864 static int sata_rcar_probe(struct platform_device *pdev)
865 {
866 	struct device *dev = &pdev->dev;
867 	struct ata_host *host;
868 	struct sata_rcar_priv *priv;
869 	struct resource *mem;
870 	int irq;
871 	int ret = 0;
872 
873 	irq = platform_get_irq(pdev, 0);
874 	if (irq < 0)
875 		return irq;
876 	if (!irq)
877 		return -EINVAL;
878 
879 	priv = devm_kzalloc(dev, sizeof(struct sata_rcar_priv), GFP_KERNEL);
880 	if (!priv)
881 		return -ENOMEM;
882 
883 	priv->type = (enum sata_rcar_type)of_device_get_match_data(dev);
884 
885 	pm_runtime_enable(dev);
886 	ret = pm_runtime_get_sync(dev);
887 	if (ret < 0)
888 		goto err_pm_put;
889 
890 	host = ata_host_alloc(dev, 1);
891 	if (!host) {
892 		ret = -ENOMEM;
893 		goto err_pm_put;
894 	}
895 
896 	host->private_data = priv;
897 
898 	mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
899 	priv->base = devm_ioremap_resource(dev, mem);
900 	if (IS_ERR(priv->base)) {
901 		ret = PTR_ERR(priv->base);
902 		goto err_pm_put;
903 	}
904 
905 	/* setup port */
906 	sata_rcar_setup_port(host);
907 
908 	/* initialize host controller */
909 	sata_rcar_init_controller(host);
910 
911 	ret = ata_host_activate(host, irq, sata_rcar_interrupt, 0,
912 				&sata_rcar_sht);
913 	if (!ret)
914 		return 0;
915 
916 err_pm_put:
917 	pm_runtime_put(dev);
918 	pm_runtime_disable(dev);
919 	return ret;
920 }
921 
922 static int sata_rcar_remove(struct platform_device *pdev)
923 {
924 	struct ata_host *host = platform_get_drvdata(pdev);
925 	struct sata_rcar_priv *priv = host->private_data;
926 	void __iomem *base = priv->base;
927 
928 	ata_host_detach(host);
929 
930 	/* disable interrupts */
931 	iowrite32(0, base + ATAPI_INT_ENABLE_REG);
932 	/* ack and mask */
933 	iowrite32(0, base + SATAINTSTAT_REG);
934 	iowrite32(priv->sataint_mask, base + SATAINTMASK_REG);
935 
936 	pm_runtime_put(&pdev->dev);
937 	pm_runtime_disable(&pdev->dev);
938 
939 	return 0;
940 }
941 
942 #ifdef CONFIG_PM_SLEEP
943 static int sata_rcar_suspend(struct device *dev)
944 {
945 	struct ata_host *host = dev_get_drvdata(dev);
946 	struct sata_rcar_priv *priv = host->private_data;
947 	void __iomem *base = priv->base;
948 	int ret;
949 
950 	ret = ata_host_suspend(host, PMSG_SUSPEND);
951 	if (!ret) {
952 		/* disable interrupts */
953 		iowrite32(0, base + ATAPI_INT_ENABLE_REG);
954 		/* mask */
955 		iowrite32(priv->sataint_mask, base + SATAINTMASK_REG);
956 
957 		pm_runtime_put(dev);
958 	}
959 
960 	return ret;
961 }
962 
963 static int sata_rcar_resume(struct device *dev)
964 {
965 	struct ata_host *host = dev_get_drvdata(dev);
966 	struct sata_rcar_priv *priv = host->private_data;
967 	void __iomem *base = priv->base;
968 	int ret;
969 
970 	ret = pm_runtime_get_sync(dev);
971 	if (ret < 0) {
972 		pm_runtime_put(dev);
973 		return ret;
974 	}
975 
976 	if (priv->type == RCAR_GEN3_SATA) {
977 		sata_rcar_init_module(priv);
978 	} else {
979 		/* ack and mask */
980 		iowrite32(0, base + SATAINTSTAT_REG);
981 		iowrite32(priv->sataint_mask, base + SATAINTMASK_REG);
982 
983 		/* enable interrupts */
984 		iowrite32(ATAPI_INT_ENABLE_SATAINT,
985 			  base + ATAPI_INT_ENABLE_REG);
986 	}
987 
988 	ata_host_resume(host);
989 
990 	return 0;
991 }
992 
993 static int sata_rcar_restore(struct device *dev)
994 {
995 	struct ata_host *host = dev_get_drvdata(dev);
996 	int ret;
997 
998 	ret = pm_runtime_get_sync(dev);
999 	if (ret < 0) {
1000 		pm_runtime_put(dev);
1001 		return ret;
1002 	}
1003 
1004 	sata_rcar_setup_port(host);
1005 
1006 	/* initialize host controller */
1007 	sata_rcar_init_controller(host);
1008 
1009 	ata_host_resume(host);
1010 
1011 	return 0;
1012 }
1013 
1014 static const struct dev_pm_ops sata_rcar_pm_ops = {
1015 	.suspend	= sata_rcar_suspend,
1016 	.resume		= sata_rcar_resume,
1017 	.freeze		= sata_rcar_suspend,
1018 	.thaw		= sata_rcar_resume,
1019 	.poweroff	= sata_rcar_suspend,
1020 	.restore	= sata_rcar_restore,
1021 };
1022 #endif
1023 
1024 static struct platform_driver sata_rcar_driver = {
1025 	.probe		= sata_rcar_probe,
1026 	.remove		= sata_rcar_remove,
1027 	.driver = {
1028 		.name		= DRV_NAME,
1029 		.of_match_table	= sata_rcar_match,
1030 #ifdef CONFIG_PM_SLEEP
1031 		.pm		= &sata_rcar_pm_ops,
1032 #endif
1033 	},
1034 };
1035 
1036 module_platform_driver(sata_rcar_driver);
1037 
1038 MODULE_LICENSE("GPL");
1039 MODULE_AUTHOR("Vladimir Barinov");
1040 MODULE_DESCRIPTION("Renesas R-Car SATA controller low level driver");
1041