drivers/ata/ahci.c

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