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