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