ata: ahci: Fix usage on big-endian platforms
[platform/kernel/u-boot.git] / drivers / ata / ahci.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Copyright (C) Freescale Semiconductor, Inc. 2006.
4  * Author: Jason Jin<Jason.jin@freescale.com>
5  *         Zhang Wei<wei.zhang@freescale.com>
6  *
7  * with the reference on libata and ahci drvier in kernel
8  *
9  * This driver provides a SCSI interface to SATA.
10  */
11 #include <common.h>
12 #include <blk.h>
13 #include <cpu_func.h>
14 #include <log.h>
15 #include <linux/bitops.h>
16 #include <linux/delay.h>
17
18 #include <command.h>
19 #include <dm.h>
20 #include <pci.h>
21 #include <asm/processor.h>
22 #include <linux/errno.h>
23 #include <asm/io.h>
24 #include <malloc.h>
25 #include <memalign.h>
26 #include <pci.h>
27 #include <scsi.h>
28 #include <libata.h>
29 #include <linux/ctype.h>
30 #include <ahci.h>
31 #include <dm/device-internal.h>
32 #include <dm/lists.h>
33
34 static int ata_io_flush(struct ahci_uc_priv *uc_priv, u8 port);
35
36 #ifndef CONFIG_DM_SCSI
37 struct ahci_uc_priv *probe_ent = NULL;
38 #endif
39
40 #define writel_with_flush(a,b)  do { writel(a,b); readl(b); } while (0)
41
42 /*
43  * Some controllers limit number of blocks they can read/write at once.
44  * Contemporary SSD devices work much faster if the read/write size is aligned
45  * to a power of 2.  Let's set default to 128 and allowing to be overwritten if
46  * needed.
47  */
48 #ifndef MAX_SATA_BLOCKS_READ_WRITE
49 #define MAX_SATA_BLOCKS_READ_WRITE      0x80
50 #endif
51
52 /* Maximum timeouts for each event */
53 #define WAIT_MS_SPINUP  20000
54 #define WAIT_MS_DATAIO  10000
55 #define WAIT_MS_FLUSH   5000
56 #define WAIT_MS_LINKUP  200
57
58 #define AHCI_CAP_S64A BIT(31)
59
60 __weak void __iomem *ahci_port_base(void __iomem *base, u32 port)
61 {
62         return base + 0x100 + (port * 0x80);
63 }
64
65 #define msleep(a) udelay(a * 1000)
66
67 static void ahci_dcache_flush_range(unsigned long begin, unsigned long len)
68 {
69         const unsigned long start = begin;
70         const unsigned long end = start + len;
71
72         debug("%s: flush dcache: [%#lx, %#lx)\n", __func__, start, end);
73         flush_dcache_range(start, end);
74 }
75
76 /*
77  * SATA controller DMAs to physical RAM.  Ensure data from the
78  * controller is invalidated from dcache; next access comes from
79  * physical RAM.
80  */
81 static void ahci_dcache_invalidate_range(unsigned long begin, unsigned long len)
82 {
83         const unsigned long start = begin;
84         const unsigned long end = start + len;
85
86         debug("%s: invalidate dcache: [%#lx, %#lx)\n", __func__, start, end);
87         invalidate_dcache_range(start, end);
88 }
89
90 /*
91  * Ensure data for SATA controller is flushed out of dcache and
92  * written to physical memory.
93  */
94 static void ahci_dcache_flush_sata_cmd(struct ahci_ioports *pp)
95 {
96         ahci_dcache_flush_range((unsigned long)pp->cmd_slot,
97                                 AHCI_PORT_PRIV_DMA_SZ);
98 }
99
100 static int waiting_for_cmd_completed(void __iomem *offset,
101                                      int timeout_msec,
102                                      u32 sign)
103 {
104         int i;
105         u32 status;
106
107         for (i = 0; ((status = readl(offset)) & sign) && i < timeout_msec; i++)
108                 msleep(1);
109
110         return (i < timeout_msec) ? 0 : -1;
111 }
112
113 int __weak ahci_link_up(struct ahci_uc_priv *uc_priv, u8 port)
114 {
115         u32 tmp;
116         int j = 0;
117         void __iomem *port_mmio = uc_priv->port[port].port_mmio;
118
119         /*
120          * Bring up SATA link.
121          * SATA link bringup time is usually less than 1 ms; only very
122          * rarely has it taken between 1-2 ms. Never seen it above 2 ms.
123          */
124         while (j < WAIT_MS_LINKUP) {
125                 tmp = readl(port_mmio + PORT_SCR_STAT);
126                 tmp &= PORT_SCR_STAT_DET_MASK;
127                 if (tmp == PORT_SCR_STAT_DET_PHYRDY)
128                         return 0;
129                 udelay(1000);
130                 j++;
131         }
132         return 1;
133 }
134
135 #ifdef CONFIG_SUNXI_AHCI
136 /* The sunxi AHCI controller requires this undocumented setup */
137 static void sunxi_dma_init(void __iomem *port_mmio)
138 {
139         clrsetbits_le32(port_mmio + PORT_P0DMACR, 0x0000ff00, 0x00004400);
140 }
141 #endif
142
143 int ahci_reset(void __iomem *base)
144 {
145         int i = 1000;
146         u32 __iomem *host_ctl_reg = base + HOST_CTL;
147         u32 tmp = readl(host_ctl_reg); /* global controller reset */
148
149         if ((tmp & HOST_RESET) == 0)
150                 writel_with_flush(tmp | HOST_RESET, host_ctl_reg);
151
152         /*
153          * reset must complete within 1 second, or
154          * the hardware should be considered fried.
155          */
156         do {
157                 udelay(1000);
158                 tmp = readl(host_ctl_reg);
159                 i--;
160         } while ((i > 0) && (tmp & HOST_RESET));
161
162         if (i == 0) {
163                 printf("controller reset failed (0x%x)\n", tmp);
164                 return -1;
165         }
166
167         return 0;
168 }
169
170 static int ahci_host_init(struct ahci_uc_priv *uc_priv)
171 {
172 #if !defined(CONFIG_SCSI_AHCI_PLAT) && !defined(CONFIG_DM_SCSI)
173 # ifdef CONFIG_DM_PCI
174         struct udevice *dev = uc_priv->dev;
175         struct pci_child_plat *pplat = dev_get_parent_plat(dev);
176 # else
177         pci_dev_t pdev = uc_priv->dev;
178         unsigned short vendor;
179 # endif
180         u16 tmp16;
181 #endif
182         void __iomem *mmio = uc_priv->mmio_base;
183         u32 tmp, cap_save, cmd;
184         int i, j, ret;
185         void __iomem *port_mmio;
186         u32 port_map;
187
188         debug("ahci_host_init: start\n");
189
190         cap_save = readl(mmio + HOST_CAP);
191         cap_save &= ((1 << 28) | (1 << 17));
192         cap_save |= (1 << 27);  /* Staggered Spin-up. Not needed. */
193
194         ret = ahci_reset(uc_priv->mmio_base);
195         if (ret)
196                 return ret;
197
198         writel_with_flush(HOST_AHCI_EN, mmio + HOST_CTL);
199         writel(cap_save, mmio + HOST_CAP);
200         writel_with_flush(0xf, mmio + HOST_PORTS_IMPL);
201
202 #if !defined(CONFIG_SCSI_AHCI_PLAT) && !defined(CONFIG_DM_SCSI)
203 # ifdef CONFIG_DM_PCI
204         if (pplat->vendor == PCI_VENDOR_ID_INTEL) {
205                 u16 tmp16;
206
207                 dm_pci_read_config16(dev, 0x92, &tmp16);
208                 dm_pci_write_config16(dev, 0x92, tmp16 | 0xf);
209         }
210 # else
211         pci_read_config_word(pdev, PCI_VENDOR_ID, &vendor);
212
213         if (vendor == PCI_VENDOR_ID_INTEL) {
214                 u16 tmp16;
215                 pci_read_config_word(pdev, 0x92, &tmp16);
216                 tmp16 |= 0xf;
217                 pci_write_config_word(pdev, 0x92, tmp16);
218         }
219 # endif
220 #endif
221         uc_priv->cap = readl(mmio + HOST_CAP);
222         uc_priv->port_map = readl(mmio + HOST_PORTS_IMPL);
223         port_map = uc_priv->port_map;
224         uc_priv->n_ports = (uc_priv->cap & 0x1f) + 1;
225
226         debug("cap 0x%x  port_map 0x%x  n_ports %d\n",
227               uc_priv->cap, uc_priv->port_map, uc_priv->n_ports);
228
229 #if !defined(CONFIG_DM_SCSI)
230         if (uc_priv->n_ports > CONFIG_SYS_SCSI_MAX_SCSI_ID)
231                 uc_priv->n_ports = CONFIG_SYS_SCSI_MAX_SCSI_ID;
232 #endif
233
234         for (i = 0; i < uc_priv->n_ports; i++) {
235                 if (!(port_map & (1 << i)))
236                         continue;
237                 uc_priv->port[i].port_mmio = ahci_port_base(mmio, i);
238                 port_mmio = (u8 *)uc_priv->port[i].port_mmio;
239
240                 /* make sure port is not active */
241                 tmp = readl(port_mmio + PORT_CMD);
242                 if (tmp & (PORT_CMD_LIST_ON | PORT_CMD_FIS_ON |
243                            PORT_CMD_FIS_RX | PORT_CMD_START)) {
244                         debug("Port %d is active. Deactivating.\n", i);
245                         tmp &= ~(PORT_CMD_LIST_ON | PORT_CMD_FIS_ON |
246                                  PORT_CMD_FIS_RX | PORT_CMD_START);
247                         writel_with_flush(tmp, port_mmio + PORT_CMD);
248
249                         /* spec says 500 msecs for each bit, so
250                          * this is slightly incorrect.
251                          */
252                         msleep(500);
253                 }
254
255 #ifdef CONFIG_SUNXI_AHCI
256                 sunxi_dma_init(port_mmio);
257 #endif
258
259                 /* Add the spinup command to whatever mode bits may
260                  * already be on in the command register.
261                  */
262                 cmd = readl(port_mmio + PORT_CMD);
263                 cmd |= PORT_CMD_SPIN_UP;
264                 writel_with_flush(cmd, port_mmio + PORT_CMD);
265
266                 /* Bring up SATA link. */
267                 ret = ahci_link_up(uc_priv, i);
268                 if (ret) {
269                         printf("SATA link %d timeout.\n", i);
270                         continue;
271                 } else {
272                         debug("SATA link ok.\n");
273                 }
274
275                 /* Clear error status */
276                 tmp = readl(port_mmio + PORT_SCR_ERR);
277                 if (tmp)
278                         writel(tmp, port_mmio + PORT_SCR_ERR);
279
280                 debug("Spinning up device on SATA port %d... ", i);
281
282                 j = 0;
283                 while (j < WAIT_MS_SPINUP) {
284                         tmp = readl(port_mmio + PORT_TFDATA);
285                         if (!(tmp & (ATA_BUSY | ATA_DRQ)))
286                                 break;
287                         udelay(1000);
288                         tmp = readl(port_mmio + PORT_SCR_STAT);
289                         tmp &= PORT_SCR_STAT_DET_MASK;
290                         if (tmp == PORT_SCR_STAT_DET_PHYRDY)
291                                 break;
292                         j++;
293                 }
294
295                 tmp = readl(port_mmio + PORT_SCR_STAT) & PORT_SCR_STAT_DET_MASK;
296                 if (tmp == PORT_SCR_STAT_DET_COMINIT) {
297                         debug("SATA link %d down (COMINIT received), retrying...\n", i);
298                         i--;
299                         continue;
300                 }
301
302                 printf("Target spinup took %d ms.\n", j);
303                 if (j == WAIT_MS_SPINUP)
304                         debug("timeout.\n");
305                 else
306                         debug("ok.\n");
307
308                 tmp = readl(port_mmio + PORT_SCR_ERR);
309                 debug("PORT_SCR_ERR 0x%x\n", tmp);
310                 writel(tmp, port_mmio + PORT_SCR_ERR);
311
312                 /* ack any pending irq events for this port */
313                 tmp = readl(port_mmio + PORT_IRQ_STAT);
314                 debug("PORT_IRQ_STAT 0x%x\n", tmp);
315                 if (tmp)
316                         writel(tmp, port_mmio + PORT_IRQ_STAT);
317
318                 writel(1 << i, mmio + HOST_IRQ_STAT);
319
320                 /* register linkup ports */
321                 tmp = readl(port_mmio + PORT_SCR_STAT);
322                 debug("SATA port %d status: 0x%x\n", i, tmp);
323                 if ((tmp & PORT_SCR_STAT_DET_MASK) == PORT_SCR_STAT_DET_PHYRDY)
324                         uc_priv->link_port_map |= (0x01 << i);
325         }
326
327         tmp = readl(mmio + HOST_CTL);
328         debug("HOST_CTL 0x%x\n", tmp);
329         writel(tmp | HOST_IRQ_EN, mmio + HOST_CTL);
330         tmp = readl(mmio + HOST_CTL);
331         debug("HOST_CTL 0x%x\n", tmp);
332 #if !defined(CONFIG_DM_SCSI)
333 #ifndef CONFIG_SCSI_AHCI_PLAT
334 # ifdef CONFIG_DM_PCI
335         dm_pci_read_config16(dev, PCI_COMMAND, &tmp16);
336         tmp |= PCI_COMMAND_MASTER;
337         dm_pci_write_config16(dev, PCI_COMMAND, tmp16);
338 # else
339         pci_read_config_word(pdev, PCI_COMMAND, &tmp16);
340         tmp |= PCI_COMMAND_MASTER;
341         pci_write_config_word(pdev, PCI_COMMAND, tmp16);
342 # endif
343 #endif
344 #endif
345         return 0;
346 }
347
348
349 static void ahci_print_info(struct ahci_uc_priv *uc_priv)
350 {
351 #if !defined(CONFIG_SCSI_AHCI_PLAT) && !defined(CONFIG_DM_SCSI)
352 # if defined(CONFIG_DM_PCI)
353         struct udevice *dev = uc_priv->dev;
354 # else
355         pci_dev_t pdev = uc_priv->dev;
356 # endif
357         u16 cc;
358 #endif
359         void __iomem *mmio = uc_priv->mmio_base;
360         u32 vers, cap, cap2, impl, speed;
361         const char *speed_s;
362         const char *scc_s;
363
364         vers = readl(mmio + HOST_VERSION);
365         cap = uc_priv->cap;
366         cap2 = readl(mmio + HOST_CAP2);
367         impl = uc_priv->port_map;
368
369         speed = (cap >> 20) & 0xf;
370         if (speed == 1)
371                 speed_s = "1.5";
372         else if (speed == 2)
373                 speed_s = "3";
374         else if (speed == 3)
375                 speed_s = "6";
376         else
377                 speed_s = "?";
378
379 #if defined(CONFIG_SCSI_AHCI_PLAT) || defined(CONFIG_DM_SCSI)
380         scc_s = "SATA";
381 #else
382 # ifdef CONFIG_DM_PCI
383         dm_pci_read_config16(dev, 0x0a, &cc);
384 # else
385         pci_read_config_word(pdev, 0x0a, &cc);
386 # endif
387         if (cc == 0x0101)
388                 scc_s = "IDE";
389         else if (cc == 0x0106)
390                 scc_s = "SATA";
391         else if (cc == 0x0104)
392                 scc_s = "RAID";
393         else
394                 scc_s = "unknown";
395 #endif
396         printf("AHCI %02x%02x.%02x%02x "
397                "%u slots %u ports %s Gbps 0x%x impl %s mode\n",
398                (vers >> 24) & 0xff,
399                (vers >> 16) & 0xff,
400                (vers >> 8) & 0xff,
401                vers & 0xff,
402                ((cap >> 8) & 0x1f) + 1, (cap & 0x1f) + 1, speed_s, impl, scc_s);
403
404         printf("flags: "
405                "%s%s%s%s%s%s%s"
406                "%s%s%s%s%s%s%s"
407                "%s%s%s%s%s%s\n",
408                cap & (1 << 31) ? "64bit " : "",
409                cap & (1 << 30) ? "ncq " : "",
410                cap & (1 << 28) ? "ilck " : "",
411                cap & (1 << 27) ? "stag " : "",
412                cap & (1 << 26) ? "pm " : "",
413                cap & (1 << 25) ? "led " : "",
414                cap & (1 << 24) ? "clo " : "",
415                cap & (1 << 19) ? "nz " : "",
416                cap & (1 << 18) ? "only " : "",
417                cap & (1 << 17) ? "pmp " : "",
418                cap & (1 << 16) ? "fbss " : "",
419                cap & (1 << 15) ? "pio " : "",
420                cap & (1 << 14) ? "slum " : "",
421                cap & (1 << 13) ? "part " : "",
422                cap & (1 << 7) ? "ccc " : "",
423                cap & (1 << 6) ? "ems " : "",
424                cap & (1 << 5) ? "sxs " : "",
425                cap2 & (1 << 2) ? "apst " : "",
426                cap2 & (1 << 1) ? "nvmp " : "",
427                cap2 & (1 << 0) ? "boh " : "");
428 }
429
430 #if defined(CONFIG_DM_SCSI) || !defined(CONFIG_SCSI_AHCI_PLAT)
431 # if defined(CONFIG_DM_PCI) || defined(CONFIG_DM_SCSI)
432 static int ahci_init_one(struct ahci_uc_priv *uc_priv, struct udevice *dev)
433 # else
434 static int ahci_init_one(struct ahci_uc_priv *uc_priv, pci_dev_t dev)
435 # endif
436 {
437 #if !defined(CONFIG_DM_SCSI)
438         u16 vendor;
439 #endif
440         int rc;
441
442         uc_priv->dev = dev;
443
444         uc_priv->host_flags = ATA_FLAG_SATA
445                                 | ATA_FLAG_NO_LEGACY
446                                 | ATA_FLAG_MMIO
447                                 | ATA_FLAG_PIO_DMA
448                                 | ATA_FLAG_NO_ATAPI;
449         uc_priv->pio_mask = 0x1f;
450         uc_priv->udma_mask = 0x7f;      /*Fixme,assume to support UDMA6 */
451
452 #if !defined(CONFIG_DM_SCSI)
453 #ifdef CONFIG_DM_PCI
454         uc_priv->mmio_base = dm_pci_map_bar(dev, PCI_BASE_ADDRESS_5,
455                                               PCI_REGION_MEM);
456
457         /* Take from kernel:
458          * JMicron-specific fixup:
459          * make sure we're in AHCI mode
460          */
461         dm_pci_read_config16(dev, PCI_VENDOR_ID, &vendor);
462         if (vendor == 0x197b)
463                 dm_pci_write_config8(dev, 0x41, 0xa1);
464 #else
465         uc_priv->mmio_base = pci_map_bar(dev, PCI_BASE_ADDRESS_5,
466                                            PCI_REGION_MEM);
467
468         /* Take from kernel:
469          * JMicron-specific fixup:
470          * make sure we're in AHCI mode
471          */
472         pci_read_config_word(dev, PCI_VENDOR_ID, &vendor);
473         if (vendor == 0x197b)
474                 pci_write_config_byte(dev, 0x41, 0xa1);
475 #endif
476 #else
477         struct scsi_plat *plat = dev_get_uclass_plat(dev);
478         uc_priv->mmio_base = (void *)plat->base;
479 #endif
480
481         debug("ahci mmio_base=0x%p\n", uc_priv->mmio_base);
482         /* initialize adapter */
483         rc = ahci_host_init(uc_priv);
484         if (rc)
485                 goto err_out;
486
487         ahci_print_info(uc_priv);
488
489         return 0;
490
491       err_out:
492         return rc;
493 }
494 #endif
495
496 #define MAX_DATA_BYTE_COUNT  (4*1024*1024)
497
498 static int ahci_fill_sg(struct ahci_uc_priv *uc_priv, u8 port,
499                         unsigned char *buf, int buf_len)
500 {
501         struct ahci_ioports *pp = &(uc_priv->port[port]);
502         struct ahci_sg *ahci_sg = pp->cmd_tbl_sg;
503         phys_addr_t pa = virt_to_phys(buf);
504         u32 sg_count;
505         int i;
506
507         sg_count = ((buf_len - 1) / MAX_DATA_BYTE_COUNT) + 1;
508         if (sg_count > AHCI_MAX_SG) {
509                 printf("Error:Too much sg!\n");
510                 return -1;
511         }
512
513         for (i = 0; i < sg_count; i++) {
514                 ahci_sg->addr = cpu_to_le32(lower_32_bits(pa));
515                 ahci_sg->addr_hi = cpu_to_le32(upper_32_bits(pa));
516                 if (ahci_sg->addr_hi && !(uc_priv->cap & AHCI_CAP_S64A)) {
517                         printf("Error: DMA address too high\n");
518                         return -1;
519                 }
520                 ahci_sg->flags_size = cpu_to_le32(0x3fffff &
521                                           (buf_len < MAX_DATA_BYTE_COUNT ?
522                                            (buf_len - 1) :
523                                            (MAX_DATA_BYTE_COUNT - 1)));
524                 ahci_sg++;
525                 buf_len -= MAX_DATA_BYTE_COUNT;
526                 pa += MAX_DATA_BYTE_COUNT;
527         }
528
529         return sg_count;
530 }
531
532 static void ahci_fill_cmd_slot(struct ahci_ioports *pp, u32 opts)
533 {
534         phys_addr_t pa = virt_to_phys((void *)pp->cmd_tbl);
535
536         pp->cmd_slot->opts = cpu_to_le32(opts);
537         pp->cmd_slot->status = 0;
538         pp->cmd_slot->tbl_addr = cpu_to_le32(lower_32_bits(pa));
539 #ifdef CONFIG_PHYS_64BIT
540         pp->cmd_slot->tbl_addr_hi = cpu_to_le32(upper_32_bits(pa));
541 #endif
542 }
543
544 static int wait_spinup(void __iomem *port_mmio)
545 {
546         ulong start;
547         u32 tf_data;
548
549         start = get_timer(0);
550         do {
551                 tf_data = readl(port_mmio + PORT_TFDATA);
552                 if (!(tf_data & ATA_BUSY))
553                         return 0;
554         } while (get_timer(start) < WAIT_MS_SPINUP);
555
556         return -ETIMEDOUT;
557 }
558
559 static int ahci_port_start(struct ahci_uc_priv *uc_priv, u8 port)
560 {
561         struct ahci_ioports *pp = &(uc_priv->port[port]);
562         void __iomem *port_mmio = pp->port_mmio;
563         u64 dma_addr;
564         u32 port_status;
565         void __iomem *mem;
566
567         debug("Enter start port: %d\n", port);
568         port_status = readl(port_mmio + PORT_SCR_STAT);
569         debug("Port %d status: %x\n", port, port_status);
570         if ((port_status & 0xf) != 0x03) {
571                 printf("No Link on this port!\n");
572                 return -1;
573         }
574
575         mem = memalign(2048, AHCI_PORT_PRIV_DMA_SZ);
576         if (!mem) {
577                 free(pp);
578                 printf("%s: No mem for table!\n", __func__);
579                 return -ENOMEM;
580         }
581         memset(mem, 0, AHCI_PORT_PRIV_DMA_SZ);
582
583         /*
584          * First item in chunk of DMA memory: 32-slot command table,
585          * 32 bytes each in size
586          */
587         pp->cmd_slot =
588                 (struct ahci_cmd_hdr *)(uintptr_t)virt_to_phys((void *)mem);
589         debug("cmd_slot = %p\n", pp->cmd_slot);
590         mem += (AHCI_CMD_SLOT_SZ + 224);
591
592         /*
593          * Second item: Received-FIS area
594          */
595         pp->rx_fis = virt_to_phys((void *)mem);
596         mem += AHCI_RX_FIS_SZ;
597
598         /*
599          * Third item: data area for storing a single command
600          * and its scatter-gather table
601          */
602         pp->cmd_tbl = virt_to_phys((void *)mem);
603         debug("cmd_tbl_dma = %lx\n", pp->cmd_tbl);
604
605         mem += AHCI_CMD_TBL_HDR;
606         pp->cmd_tbl_sg =
607                         (struct ahci_sg *)(uintptr_t)virt_to_phys((void *)mem);
608
609         dma_addr = (ulong)pp->cmd_slot;
610         writel_with_flush(dma_addr, port_mmio + PORT_LST_ADDR);
611         writel_with_flush(dma_addr >> 32, port_mmio + PORT_LST_ADDR_HI);
612         dma_addr = (ulong)pp->rx_fis;
613         writel_with_flush(dma_addr, port_mmio + PORT_FIS_ADDR);
614         writel_with_flush(dma_addr >> 32, port_mmio + PORT_FIS_ADDR_HI);
615
616 #ifdef CONFIG_SUNXI_AHCI
617         sunxi_dma_init(port_mmio);
618 #endif
619
620         writel_with_flush(PORT_CMD_ICC_ACTIVE | PORT_CMD_FIS_RX |
621                           PORT_CMD_POWER_ON | PORT_CMD_SPIN_UP |
622                           PORT_CMD_START, port_mmio + PORT_CMD);
623
624         debug("Exit start port %d\n", port);
625
626         /*
627          * Make sure interface is not busy based on error and status
628          * information from task file data register before proceeding
629          */
630         return wait_spinup(port_mmio);
631 }
632
633
634 static int ahci_device_data_io(struct ahci_uc_priv *uc_priv, u8 port, u8 *fis,
635                                int fis_len, u8 *buf, int buf_len, u8 is_write)
636 {
637
638         struct ahci_ioports *pp = &(uc_priv->port[port]);
639         void __iomem *port_mmio = pp->port_mmio;
640         u32 opts;
641         u32 port_status;
642         int sg_count;
643
644         debug("Enter %s: for port %d\n", __func__, port);
645
646         if (port > uc_priv->n_ports) {
647                 printf("Invalid port number %d\n", port);
648                 return -1;
649         }
650
651         port_status = readl(port_mmio + PORT_SCR_STAT);
652         if ((port_status & 0xf) != 0x03) {
653                 debug("No Link on port %d!\n", port);
654                 return -1;
655         }
656
657         memcpy((unsigned char *)pp->cmd_tbl, fis, fis_len);
658
659         sg_count = ahci_fill_sg(uc_priv, port, buf, buf_len);
660         opts = (fis_len >> 2) | (sg_count << 16) | (is_write << 6);
661         ahci_fill_cmd_slot(pp, opts);
662
663         ahci_dcache_flush_sata_cmd(pp);
664         ahci_dcache_flush_range((unsigned long)buf, (unsigned long)buf_len);
665
666         writel_with_flush(1, port_mmio + PORT_CMD_ISSUE);
667
668         if (waiting_for_cmd_completed(port_mmio + PORT_CMD_ISSUE,
669                                 WAIT_MS_DATAIO, 0x1)) {
670                 printf("timeout exit!\n");
671                 return -1;
672         }
673
674         ahci_dcache_invalidate_range((unsigned long)buf,
675                                      (unsigned long)buf_len);
676         debug("%s: %d byte transferred.\n", __func__,
677               le32_to_cpu(pp->cmd_slot->status));
678
679         return 0;
680 }
681
682 static char *ata_id_strcpy(u16 *target, u16 *src, int len)
683 {
684         int i;
685         for (i = 0; i < len / 2; i++)
686                 target[i] = swab16(src[i]);
687         return (char *)target;
688 }
689
690 /*
691  * SCSI INQUIRY command operation.
692  */
693 static int ata_scsiop_inquiry(struct ahci_uc_priv *uc_priv,
694                               struct scsi_cmd *pccb)
695 {
696         static const u8 hdr[] = {
697                 0,
698                 0,
699                 0x5,            /* claim SPC-3 version compatibility */
700                 2,
701                 95 - 4,
702         };
703         u8 fis[20];
704         u16 *idbuf;
705         ALLOC_CACHE_ALIGN_BUFFER(u16, tmpid, ATA_ID_WORDS);
706         u8 port;
707
708         /* Clean ccb data buffer */
709         memset(pccb->pdata, 0, pccb->datalen);
710
711         memcpy(pccb->pdata, hdr, sizeof(hdr));
712
713         if (pccb->datalen <= 35)
714                 return 0;
715
716         memset(fis, 0, sizeof(fis));
717         /* Construct the FIS */
718         fis[0] = 0x27;          /* Host to device FIS. */
719         fis[1] = 1 << 7;        /* Command FIS. */
720         fis[2] = ATA_CMD_ID_ATA; /* Command byte. */
721
722         /* Read id from sata */
723         port = pccb->target;
724
725         if (ahci_device_data_io(uc_priv, port, (u8 *)&fis, sizeof(fis),
726                                 (u8 *)tmpid, ATA_ID_WORDS * 2, 0)) {
727                 debug("scsi_ahci: SCSI inquiry command failure.\n");
728                 return -EIO;
729         }
730
731         if (!uc_priv->ataid[port]) {
732                 uc_priv->ataid[port] = malloc(ATA_ID_WORDS * 2);
733                 if (!uc_priv->ataid[port]) {
734                         printf("%s: No memory for ataid[port]\n", __func__);
735                         return -ENOMEM;
736                 }
737         }
738
739         idbuf = uc_priv->ataid[port];
740
741         memcpy(idbuf, tmpid, ATA_ID_WORDS * 2);
742         ata_swap_buf_le16(idbuf, ATA_ID_WORDS);
743
744         memcpy(&pccb->pdata[8], "ATA     ", 8);
745         ata_id_strcpy((u16 *)&pccb->pdata[16], &idbuf[ATA_ID_PROD], 16);
746         ata_id_strcpy((u16 *)&pccb->pdata[32], &idbuf[ATA_ID_FW_REV], 4);
747
748 #ifdef DEBUG
749         ata_dump_id(idbuf);
750 #endif
751         return 0;
752 }
753
754
755 /*
756  * SCSI READ10/WRITE10 command operation.
757  */
758 static int ata_scsiop_read_write(struct ahci_uc_priv *uc_priv,
759                                  struct scsi_cmd *pccb, u8 is_write)
760 {
761         lbaint_t lba = 0;
762         u16 blocks = 0;
763         u8 fis[20];
764         u8 *user_buffer = pccb->pdata;
765         u32 user_buffer_size = pccb->datalen;
766
767         /* Retrieve the base LBA number from the ccb structure. */
768         if (pccb->cmd[0] == SCSI_READ16) {
769                 memcpy(&lba, pccb->cmd + 2, 8);
770                 lba = be64_to_cpu(lba);
771         } else {
772                 u32 temp;
773                 memcpy(&temp, pccb->cmd + 2, 4);
774                 lba = be32_to_cpu(temp);
775         }
776
777         /*
778          * Retrieve the base LBA number and the block count from
779          * the ccb structure.
780          *
781          * For 10-byte and 16-byte SCSI R/W commands, transfer
782          * length 0 means transfer 0 block of data.
783          * However, for ATA R/W commands, sector count 0 means
784          * 256 or 65536 sectors, not 0 sectors as in SCSI.
785          *
786          * WARNING: one or two older ATA drives treat 0 as 0...
787          */
788         if (pccb->cmd[0] == SCSI_READ16)
789                 blocks = (((u16)pccb->cmd[13]) << 8) | ((u16) pccb->cmd[14]);
790         else
791                 blocks = (((u16)pccb->cmd[7]) << 8) | ((u16) pccb->cmd[8]);
792
793         debug("scsi_ahci: %s %u blocks starting from lba 0x" LBAFU "\n",
794               is_write ?  "write" : "read", blocks, lba);
795
796         /* Preset the FIS */
797         memset(fis, 0, sizeof(fis));
798         fis[0] = 0x27;           /* Host to device FIS. */
799         fis[1] = 1 << 7;         /* Command FIS. */
800         /* Command byte (read/write). */
801         fis[2] = is_write ? ATA_CMD_WRITE_EXT : ATA_CMD_READ_EXT;
802
803         while (blocks) {
804                 u16 now_blocks; /* number of blocks per iteration */
805                 u32 transfer_size; /* number of bytes per iteration */
806
807                 now_blocks = min((u16)MAX_SATA_BLOCKS_READ_WRITE, blocks);
808
809                 transfer_size = ATA_SECT_SIZE * now_blocks;
810                 if (transfer_size > user_buffer_size) {
811                         printf("scsi_ahci: Error: buffer too small.\n");
812                         return -EIO;
813                 }
814
815                 /*
816                  * LBA48 SATA command but only use 32bit address range within
817                  * that (unless we've enabled 64bit LBA support). The next
818                  * smaller command range (28bit) is too small.
819                  */
820                 fis[4] = (lba >> 0) & 0xff;
821                 fis[5] = (lba >> 8) & 0xff;
822                 fis[6] = (lba >> 16) & 0xff;
823                 fis[7] = 1 << 6; /* device reg: set LBA mode */
824                 fis[8] = ((lba >> 24) & 0xff);
825 #ifdef CONFIG_SYS_64BIT_LBA
826                 if (pccb->cmd[0] == SCSI_READ16) {
827                         fis[9] = ((lba >> 32) & 0xff);
828                         fis[10] = ((lba >> 40) & 0xff);
829                 }
830 #endif
831
832                 fis[3] = 0xe0; /* features */
833
834                 /* Block (sector) count */
835                 fis[12] = (now_blocks >> 0) & 0xff;
836                 fis[13] = (now_blocks >> 8) & 0xff;
837
838                 /* Read/Write from ahci */
839                 if (ahci_device_data_io(uc_priv, pccb->target, (u8 *)&fis,
840                                         sizeof(fis), user_buffer, transfer_size,
841                                         is_write)) {
842                         debug("scsi_ahci: SCSI %s10 command failure.\n",
843                               is_write ? "WRITE" : "READ");
844                         return -EIO;
845                 }
846
847                 /* If this transaction is a write, do a following flush.
848                  * Writes in u-boot are so rare, and the logic to know when is
849                  * the last write and do a flush only there is sufficiently
850                  * difficult. Just do a flush after every write. This incurs,
851                  * usually, one extra flush when the rare writes do happen.
852                  */
853                 if (is_write) {
854                         if (-EIO == ata_io_flush(uc_priv, pccb->target))
855                                 return -EIO;
856                 }
857                 user_buffer += transfer_size;
858                 user_buffer_size -= transfer_size;
859                 blocks -= now_blocks;
860                 lba += now_blocks;
861         }
862
863         return 0;
864 }
865
866
867 /*
868  * SCSI READ CAPACITY10 command operation.
869  */
870 static int ata_scsiop_read_capacity10(struct ahci_uc_priv *uc_priv,
871                                       struct scsi_cmd *pccb)
872 {
873         u32 cap;
874         u64 cap64;
875         u32 block_size;
876
877         if (!uc_priv->ataid[pccb->target]) {
878                 printf("scsi_ahci: SCSI READ CAPACITY10 command failure. "
879                        "\tNo ATA info!\n"
880                        "\tPlease run SCSI command INQUIRY first!\n");
881                 return -EPERM;
882         }
883
884         cap64 = ata_id_n_sectors(uc_priv->ataid[pccb->target]);
885         if (cap64 > 0x100000000ULL)
886                 cap64 = 0xffffffff;
887
888         cap = cpu_to_be32(cap64);
889         memcpy(pccb->pdata, &cap, sizeof(cap));
890
891         block_size = cpu_to_be32((u32)512);
892         memcpy(&pccb->pdata[4], &block_size, 4);
893
894         return 0;
895 }
896
897
898 /*
899  * SCSI READ CAPACITY16 command operation.
900  */
901 static int ata_scsiop_read_capacity16(struct ahci_uc_priv *uc_priv,
902                                       struct scsi_cmd *pccb)
903 {
904         u64 cap;
905         u64 block_size;
906
907         if (!uc_priv->ataid[pccb->target]) {
908                 printf("scsi_ahci: SCSI READ CAPACITY16 command failure. "
909                        "\tNo ATA info!\n"
910                        "\tPlease run SCSI command INQUIRY first!\n");
911                 return -EPERM;
912         }
913
914         cap = ata_id_n_sectors(uc_priv->ataid[pccb->target]);
915         cap = cpu_to_be64(cap);
916         memcpy(pccb->pdata, &cap, sizeof(cap));
917
918         block_size = cpu_to_be64((u64)512);
919         memcpy(&pccb->pdata[8], &block_size, 8);
920
921         return 0;
922 }
923
924
925 /*
926  * SCSI TEST UNIT READY command operation.
927  */
928 static int ata_scsiop_test_unit_ready(struct ahci_uc_priv *uc_priv,
929                                       struct scsi_cmd *pccb)
930 {
931         return (uc_priv->ataid[pccb->target]) ? 0 : -EPERM;
932 }
933
934
935 static int ahci_scsi_exec(struct udevice *dev, struct scsi_cmd *pccb)
936 {
937         struct ahci_uc_priv *uc_priv;
938 #ifdef CONFIG_DM_SCSI
939         uc_priv = dev_get_uclass_priv(dev->parent);
940 #else
941         uc_priv = probe_ent;
942 #endif
943         int ret;
944
945         switch (pccb->cmd[0]) {
946         case SCSI_READ16:
947         case SCSI_READ10:
948                 ret = ata_scsiop_read_write(uc_priv, pccb, 0);
949                 break;
950         case SCSI_WRITE10:
951                 ret = ata_scsiop_read_write(uc_priv, pccb, 1);
952                 break;
953         case SCSI_RD_CAPAC10:
954                 ret = ata_scsiop_read_capacity10(uc_priv, pccb);
955                 break;
956         case SCSI_RD_CAPAC16:
957                 ret = ata_scsiop_read_capacity16(uc_priv, pccb);
958                 break;
959         case SCSI_TST_U_RDY:
960                 ret = ata_scsiop_test_unit_ready(uc_priv, pccb);
961                 break;
962         case SCSI_INQUIRY:
963                 ret = ata_scsiop_inquiry(uc_priv, pccb);
964                 break;
965         default:
966                 printf("Unsupport SCSI command 0x%02x\n", pccb->cmd[0]);
967                 return -ENOTSUPP;
968         }
969
970         if (ret) {
971                 debug("SCSI command 0x%02x ret errno %d\n", pccb->cmd[0], ret);
972                 return ret;
973         }
974         return 0;
975
976 }
977
978 static int ahci_start_ports(struct ahci_uc_priv *uc_priv)
979 {
980         u32 linkmap;
981         int i;
982
983         linkmap = uc_priv->link_port_map;
984
985         for (i = 0; i < uc_priv->n_ports; i++) {
986                 if (((linkmap >> i) & 0x01)) {
987                         if (ahci_port_start(uc_priv, (u8) i)) {
988                                 printf("Can not start port %d\n", i);
989                                 continue;
990                         }
991                 }
992         }
993
994         return 0;
995 }
996
997 #ifndef CONFIG_DM_SCSI
998 void scsi_low_level_init(int busdevfunc)
999 {
1000         struct ahci_uc_priv *uc_priv;
1001
1002 #ifndef CONFIG_SCSI_AHCI_PLAT
1003         probe_ent = calloc(1, sizeof(struct ahci_uc_priv));
1004         if (!probe_ent) {
1005                 printf("%s: No memory for uc_priv\n", __func__);
1006                 return;
1007         }
1008         uc_priv = probe_ent;
1009 # if defined(CONFIG_DM_PCI)
1010         struct udevice *dev;
1011         int ret;
1012
1013         ret = dm_pci_bus_find_bdf(busdevfunc, &dev);
1014         if (ret)
1015                 return;
1016         ahci_init_one(uc_priv, dev);
1017 # else
1018         ahci_init_one(uc_priv, busdevfunc);
1019 # endif
1020 #else
1021         uc_priv = probe_ent;
1022 #endif
1023
1024         ahci_start_ports(uc_priv);
1025 }
1026 #endif
1027
1028 #ifndef CONFIG_SCSI_AHCI_PLAT
1029 # if defined(CONFIG_DM_PCI) || defined(CONFIG_DM_SCSI)
1030 int ahci_init_one_dm(struct udevice *dev)
1031 {
1032         struct ahci_uc_priv *uc_priv = dev_get_uclass_priv(dev);
1033
1034         return ahci_init_one(uc_priv, dev);
1035 }
1036 #endif
1037 #endif
1038
1039 int ahci_start_ports_dm(struct udevice *dev)
1040 {
1041         struct ahci_uc_priv *uc_priv = dev_get_uclass_priv(dev);
1042
1043         return ahci_start_ports(uc_priv);
1044 }
1045
1046 #ifdef CONFIG_SCSI_AHCI_PLAT
1047 static int ahci_init_common(struct ahci_uc_priv *uc_priv, void __iomem *base)
1048 {
1049         int rc;
1050
1051         uc_priv->host_flags = ATA_FLAG_SATA
1052                                 | ATA_FLAG_NO_LEGACY
1053                                 | ATA_FLAG_MMIO
1054                                 | ATA_FLAG_PIO_DMA
1055                                 | ATA_FLAG_NO_ATAPI;
1056         uc_priv->pio_mask = 0x1f;
1057         uc_priv->udma_mask = 0x7f;      /*Fixme,assume to support UDMA6 */
1058
1059         uc_priv->mmio_base = base;
1060
1061         /* initialize adapter */
1062         rc = ahci_host_init(uc_priv);
1063         if (rc)
1064                 goto err_out;
1065
1066         ahci_print_info(uc_priv);
1067
1068         rc = ahci_start_ports(uc_priv);
1069
1070 err_out:
1071         return rc;
1072 }
1073
1074 #ifndef CONFIG_DM_SCSI
1075 int ahci_init(void __iomem *base)
1076 {
1077         struct ahci_uc_priv *uc_priv;
1078
1079         probe_ent = malloc(sizeof(struct ahci_uc_priv));
1080         if (!probe_ent) {
1081                 printf("%s: No memory for uc_priv\n", __func__);
1082                 return -ENOMEM;
1083         }
1084
1085         uc_priv = probe_ent;
1086         memset(uc_priv, 0, sizeof(struct ahci_uc_priv));
1087
1088         return ahci_init_common(uc_priv, base);
1089 }
1090 #endif
1091
1092 int ahci_init_dm(struct udevice *dev, void __iomem *base)
1093 {
1094         struct ahci_uc_priv *uc_priv = dev_get_uclass_priv(dev);
1095
1096         return ahci_init_common(uc_priv, base);
1097 }
1098
1099 void __weak scsi_init(void)
1100 {
1101 }
1102
1103 #endif /* CONFIG_SCSI_AHCI_PLAT */
1104
1105 /*
1106  * In the general case of generic rotating media it makes sense to have a
1107  * flush capability. It probably even makes sense in the case of SSDs because
1108  * one cannot always know for sure what kind of internal cache/flush mechanism
1109  * is embodied therein. At first it was planned to invoke this after the last
1110  * write to disk and before rebooting. In practice, knowing, a priori, which
1111  * is the last write is difficult. Because writing to the disk in u-boot is
1112  * very rare, this flush command will be invoked after every block write.
1113  */
1114 static int ata_io_flush(struct ahci_uc_priv *uc_priv, u8 port)
1115 {
1116         u8 fis[20];
1117         struct ahci_ioports *pp = &(uc_priv->port[port]);
1118         void __iomem *port_mmio = pp->port_mmio;
1119         u32 cmd_fis_len = 5;    /* five dwords */
1120
1121         /* Preset the FIS */
1122         memset(fis, 0, 20);
1123         fis[0] = 0x27;           /* Host to device FIS. */
1124         fis[1] = 1 << 7;         /* Command FIS. */
1125         fis[2] = ATA_CMD_FLUSH_EXT;
1126
1127         memcpy((unsigned char *)pp->cmd_tbl, fis, 20);
1128         ahci_fill_cmd_slot(pp, cmd_fis_len);
1129         ahci_dcache_flush_sata_cmd(pp);
1130         writel_with_flush(1, port_mmio + PORT_CMD_ISSUE);
1131
1132         if (waiting_for_cmd_completed(port_mmio + PORT_CMD_ISSUE,
1133                         WAIT_MS_FLUSH, 0x1)) {
1134                 debug("scsi_ahci: flush command timeout on port %d.\n", port);
1135                 return -EIO;
1136         }
1137
1138         return 0;
1139 }
1140
1141 static int ahci_scsi_bus_reset(struct udevice *dev)
1142 {
1143         /* Not implemented */
1144
1145         return 0;
1146 }
1147
1148 #ifdef CONFIG_DM_SCSI
1149 int ahci_bind_scsi(struct udevice *ahci_dev, struct udevice **devp)
1150 {
1151         struct udevice *dev;
1152         int ret;
1153
1154         ret = device_bind_driver(ahci_dev, "ahci_scsi", "ahci_scsi", &dev);
1155         if (ret)
1156                 return ret;
1157         *devp = dev;
1158
1159         return 0;
1160 }
1161
1162 int ahci_probe_scsi(struct udevice *ahci_dev, ulong base)
1163 {
1164         struct ahci_uc_priv *uc_priv;
1165         struct scsi_plat *uc_plat;
1166         struct udevice *dev;
1167         int ret;
1168
1169         device_find_first_child(ahci_dev, &dev);
1170         if (!dev)
1171                 return -ENODEV;
1172         uc_plat = dev_get_uclass_plat(dev);
1173         uc_plat->base = base;
1174         uc_plat->max_lun = 1;
1175         uc_plat->max_id = 2;
1176
1177         uc_priv = dev_get_uclass_priv(ahci_dev);
1178         ret = ahci_init_one(uc_priv, dev);
1179         if (ret)
1180                 return ret;
1181         ret = ahci_start_ports(uc_priv);
1182         if (ret)
1183                 return ret;
1184
1185         /*
1186          * scsi_scan_dev() scans devices up-to the number of max_id.
1187          * Update max_id if the number of detected ports exceeds max_id.
1188          * This allows SCSI to scan all detected ports.
1189          */
1190         uc_plat->max_id = max_t(unsigned long, uc_priv->n_ports,
1191                                 uc_plat->max_id);
1192         /* If port count is less than max_id, update max_id */
1193         if (uc_priv->n_ports < uc_plat->max_id)
1194                 uc_plat->max_id = uc_priv->n_ports;
1195
1196         return 0;
1197 }
1198
1199 #ifdef CONFIG_DM_PCI
1200 int ahci_probe_scsi_pci(struct udevice *ahci_dev)
1201 {
1202         ulong base;
1203         u16 vendor, device;
1204
1205         base = (ulong)dm_pci_map_bar(ahci_dev, PCI_BASE_ADDRESS_5,
1206                                      PCI_REGION_MEM);
1207
1208         /*
1209          * Note:
1210          * Right now, we have only one quirk here, which is not enough to
1211          * introduce a new Kconfig option to select this. Once we have more
1212          * quirks in this AHCI code, we should add a Kconfig option for
1213          * this though.
1214          */
1215         dm_pci_read_config16(ahci_dev, PCI_VENDOR_ID, &vendor);
1216         dm_pci_read_config16(ahci_dev, PCI_DEVICE_ID, &device);
1217
1218         if (vendor == PCI_VENDOR_ID_CAVIUM &&
1219             device == PCI_DEVICE_ID_CAVIUM_SATA)
1220                 base = (uintptr_t)dm_pci_map_bar(ahci_dev, PCI_BASE_ADDRESS_0,
1221                                                  PCI_REGION_MEM);
1222         return ahci_probe_scsi(ahci_dev, base);
1223 }
1224 #endif
1225
1226 struct scsi_ops scsi_ops = {
1227         .exec           = ahci_scsi_exec,
1228         .bus_reset      = ahci_scsi_bus_reset,
1229 };
1230
1231 U_BOOT_DRIVER(ahci_scsi) = {
1232         .name           = "ahci_scsi",
1233         .id             = UCLASS_SCSI,
1234         .ops            = &scsi_ops,
1235 };
1236 #else
1237 int scsi_exec(struct udevice *dev, struct scsi_cmd *pccb)
1238 {
1239         return ahci_scsi_exec(dev, pccb);
1240 }
1241
1242 __weak int scsi_bus_reset(struct udevice *dev)
1243 {
1244         return ahci_scsi_bus_reset(dev);
1245
1246         return 0;
1247 }
1248 #endif