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