src/ahci.c

   1 // Low level AHCI disk access
   2 //
   3 // Copyright (C) 2010 Gerd Hoffmann <kraxel@redhat.com>
   4 //
   5 // This file may be distributed under the terms of the GNU LGPLv3 license.
   6
   7 #include "types.h" // u8
   8 #include "ioport.h" // inb
   9 #include "util.h" // dprintf
  10 #include "biosvar.h" // GET_EBDA
  11 #include "pci.h" // foreachpci
  12 #include "pci_ids.h" // PCI_CLASS_STORAGE_OTHER
  13 #include "pci_regs.h" // PCI_INTERRUPT_LINE
  14 #include "boot.h" // add_bcv_hd
  15 #include "disk.h" // struct ata_s
  16 #include "ata.h" // ATA_CB_STAT
  17 #include "ahci.h" // CDB_CMD_READ_10
  18 #include "blockcmd.h" // CDB_CMD_READ_10
  19
  20 #define AHCI_MAX_RETRIES 5
  21
  22 /****************************************************************
  23  * these bits must run in both 16bit and 32bit modes
  24  ****************************************************************/
  25
  26 // prepare sata command fis
  27 static void sata_prep_simple(struct sata_cmd_fis *fis, u8 command)
  28 {
  29     memset_fl(fis, 0, sizeof(*fis));
  30     SET_FLATPTR(fis->command, command);
  31 }
  32
  33 static void sata_prep_readwrite(struct sata_cmd_fis *fis,
  34                                 struct disk_op_s *op, int iswrite)
  35 {
  36     u64 lba = op->lba;
  37     u8 command;
  38
  39     memset_fl(fis, 0, sizeof(*fis));
  40
  41     if (op->count >= (1<<8) || lba + op->count >= (1<<28)) {
  42         SET_FLATPTR(fis->sector_count2, op->count >> 8);
  43         SET_FLATPTR(fis->lba_low2,      lba >> 24);
  44         SET_FLATPTR(fis->lba_mid2,      lba >> 32);
  45         SET_FLATPTR(fis->lba_high2,     lba >> 40);
  46         lba &= 0xffffff;
  47         command = (iswrite ? ATA_CMD_WRITE_DMA_EXT
  48                    : ATA_CMD_READ_DMA_EXT);
  49     } else {
  50         command = (iswrite ? ATA_CMD_WRITE_DMA
  51                    : ATA_CMD_READ_DMA);
  52     }
  53     SET_FLATPTR(fis->command,      command);
  54     SET_FLATPTR(fis->sector_count, op->count);
  55     SET_FLATPTR(fis->lba_low,      lba);
  56     SET_FLATPTR(fis->lba_mid,      lba >> 8);
  57     SET_FLATPTR(fis->lba_high,     lba >> 16);
  58     SET_FLATPTR(fis->device,       ((lba >> 24) & 0xf) | ATA_CB_DH_LBA);
  59 }
  60
  61 static void sata_prep_atapi(struct sata_cmd_fis *fis, u16 blocksize)
  62 {
  63     memset_fl(fis, 0, sizeof(*fis));
  64     SET_FLATPTR(fis->command,  ATA_CMD_PACKET);
  65     SET_FLATPTR(fis->lba_mid,  blocksize);
  66     SET_FLATPTR(fis->lba_high, blocksize >> 8);
  67 }
  68
  69 // ahci register access helpers
  70 static u32 ahci_ctrl_readl(struct ahci_ctrl_s *ctrl, u32 reg)
  71 {
  72     u32 addr = GET_GLOBALFLAT(ctrl->iobase) + reg;
  73     return pci_readl(addr);
  74 }
  75
  76 static void ahci_ctrl_writel(struct ahci_ctrl_s *ctrl, u32 reg, u32 val)
  77 {
  78     u32 addr = GET_GLOBALFLAT(ctrl->iobase) + reg;
  79     pci_writel(addr, val);
  80 }
  81
  82 static u32 ahci_port_to_ctrl(u32 pnr, u32 port_reg)
  83 {
  84     u32 ctrl_reg = 0x100;
  85     ctrl_reg += pnr * 0x80;
  86     ctrl_reg += port_reg;
  87     return ctrl_reg;
  88 }
  89
  90 static u32 ahci_port_readl(struct ahci_ctrl_s *ctrl, u32 pnr, u32 reg)
  91 {
  92     u32 ctrl_reg = ahci_port_to_ctrl(pnr, reg);
  93     return ahci_ctrl_readl(ctrl, ctrl_reg);
  94 }
  95
  96 static void ahci_port_writel(struct ahci_ctrl_s *ctrl, u32 pnr, u32 reg, u32 val)
  97 {
  98     u32 ctrl_reg = ahci_port_to_ctrl(pnr, reg);
  99     ahci_ctrl_writel(ctrl, ctrl_reg, val);
 100 }
 101
 102 // submit ahci command + wait for result
 103 static int ahci_command(struct ahci_port_s *port, int iswrite, int isatapi,
 104                         void *buffer, u32 bsize)
 105 {
 106     u32 val, status, success, flags;
 107     struct ahci_ctrl_s *ctrl = GET_GLOBAL(port->ctrl);
 108     struct ahci_cmd_s  *cmd  = GET_GLOBAL(port->cmd);
 109     struct ahci_fis_s  *fis  = GET_GLOBAL(port->fis);
 110     struct ahci_list_s *list = GET_GLOBAL(port->list);
 111     u32 pnr                  = GET_GLOBAL(port->pnr);
 112
 113     SET_FLATPTR(cmd->fis.reg,       0x27);
 114     SET_FLATPTR(cmd->fis.pmp_type,  (1 << 7)); /* cmd fis */
 115     SET_FLATPTR(cmd->prdt[0].base,  ((u32)buffer));
 116     SET_FLATPTR(cmd->prdt[0].baseu, 0);
 117     SET_FLATPTR(cmd->prdt[0].flags, bsize-1);
 118
 119     val = ahci_port_readl(ctrl, pnr, PORT_CMD);
 120     ahci_port_writel(ctrl, pnr, PORT_CMD, val | PORT_CMD_START);
 121
 122     if (ahci_port_readl(ctrl, pnr, PORT_CMD_ISSUE))
 123         return -1;
 124
 125     flags = ((1 << 16) | /* one prd entry */
 126              (1 << 10) | /* clear busy on ok */
 127              (iswrite ? (1 << 6) : 0) |
 128              (isatapi ? (1 << 5) : 0) |
 129              (4 << 0)); /* fis length (dwords) */
 130     SET_FLATPTR(list[0].flags, flags);
 131     SET_FLATPTR(list[0].bytes,  bsize);
 132     SET_FLATPTR(list[0].base,   ((u32)(cmd)));
 133     SET_FLATPTR(list[0].baseu,  0);
 134
 135     dprintf(2, "AHCI/%d: send cmd ...\n", pnr);
 136     SET_FLATPTR(fis->rfis[2], 0);
 137     ahci_port_writel(ctrl, pnr, PORT_SCR_ACT, 1);
 138     ahci_port_writel(ctrl, pnr, PORT_CMD_ISSUE, 1);
 139     while (ahci_port_readl(ctrl, pnr, PORT_CMD_ISSUE)) {
 140         yield();
 141     }
 142     while ((status = GET_FLATPTR(fis->rfis[2])) == 0) {
 143         yield();
 144     }
 145
 146     success = (0x00 == (status & (ATA_CB_STAT_BSY | ATA_CB_STAT_DF |
 147                                   ATA_CB_STAT_DRQ | ATA_CB_STAT_ERR)) &&
 148                ATA_CB_STAT_RDY == (status & (ATA_CB_STAT_RDY)));
 149     dprintf(2, "AHCI/%d: ... finished, status 0x%x, %s\n", pnr,
 150             status, success ? "OK" : "ERROR");
 151     return success ? 0 : -1;
 152 }
 153
 154 #define CDROM_CDB_SIZE 12
 155
 156 int ahci_cmd_data(struct disk_op_s *op, void *cdbcmd, u16 blocksize)
 157 {
 158     struct ahci_port_s *port = container_of(
 159         op->drive_g, struct ahci_port_s, drive);
 160     struct ahci_cmd_s *cmd = GET_GLOBAL(port->cmd);
 161     u8 *atapi = cdbcmd;
 162     int i, rc;
 163
 164     sata_prep_atapi(&cmd->fis, blocksize);
 165     for (i = 0; i < CDROM_CDB_SIZE; i++) {
 166         SET_FLATPTR(cmd->atapi[i], atapi[i]);
 167     }
 168     rc = ahci_command(port, 0, 1, op->buf_fl,
 169                       op->count * blocksize);
 170     if (rc < 0)
 171         return DISK_RET_EBADTRACK;
 172     return DISK_RET_SUCCESS;
 173 }
 174
 175 // read/write count blocks from a harddrive.
 176 static int
 177 ahci_disk_readwrite(struct disk_op_s *op, int iswrite)
 178 {
 179     struct ahci_port_s *port = container_of(
 180         op->drive_g, struct ahci_port_s, drive);
 181     struct ahci_cmd_s *cmd = GET_GLOBAL(port->cmd);
 182     int rc;
 183
 184     sata_prep_readwrite(&cmd->fis, op, iswrite);
 185     rc = ahci_command(port, iswrite, 0, op->buf_fl,
 186                       op->count * DISK_SECTOR_SIZE);
 187     dprintf(2, "ahci disk %s, lba %6x, count %3x, buf %p, rc %d\n",
 188             iswrite ? "write" : "read", (u32)op->lba, op->count, op->buf_fl, rc);
 189     if (rc < 0)
 190         return DISK_RET_EBADTRACK;
 191     return DISK_RET_SUCCESS;
 192 }
 193
 194 // command demuxer
 195 int process_ahci_op(struct disk_op_s *op)
 196 {
 197     struct ahci_port_s *port;
 198     u32 atapi;
 199
 200     if (!CONFIG_AHCI)
 201         return 0;
 202
 203     port = container_of(op->drive_g, struct ahci_port_s, drive);
 204     atapi = GET_GLOBAL(port->atapi);
 205
 206     if (atapi) {
 207         switch (op->command) {
 208         case CMD_READ:
 209             return cdb_read(op);
 210         case CMD_WRITE:
 211         case CMD_FORMAT:
 212             return DISK_RET_EWRITEPROTECT;
 213         case CMD_RESET:
 214             /* FIXME: what should we do here? */
 215         case CMD_VERIFY:
 216         case CMD_SEEK:
 217             return DISK_RET_SUCCESS;
 218         default:
 219             dprintf(1, "AHCI: unknown cdrom command %d\n", op->command);
 220             op->count = 0;
 221             return DISK_RET_EPARAM;
 222         }
 223     } else {
 224         switch (op->command) {
 225         case CMD_READ:
 226             return ahci_disk_readwrite(op, 0);
 227         case CMD_WRITE:
 228             return ahci_disk_readwrite(op, 1);
 229         case CMD_RESET:
 230             /* FIXME: what should we do here? */
 231         case CMD_FORMAT:
 232         case CMD_VERIFY:
 233         case CMD_SEEK:
 234             return DISK_RET_SUCCESS;
 235         default:
 236             dprintf(1, "AHCI: unknown disk command %d\n", op->command);
 237             op->count = 0;
 238             return DISK_RET_EPARAM;
 239         }
 240     }
 241 }
 242
 243 /****************************************************************
 244  * everything below is pure 32bit code
 245  ****************************************************************/
 246
 247 static void
 248 ahci_port_reset(struct ahci_ctrl_s *ctrl, u32 pnr)
 249 {
 250     u32 val, count = 0;
 251
 252     /* disable FIS + CMD */
 253     val = ahci_port_readl(ctrl, pnr, PORT_CMD);
 254     while (val & (PORT_CMD_FIS_RX | PORT_CMD_START |
 255                   PORT_CMD_FIS_ON | PORT_CMD_LIST_ON) &&
 256            count < AHCI_MAX_RETRIES) {
 257         val &= ~(PORT_CMD_FIS_RX | PORT_CMD_START);
 258         ahci_port_writel(ctrl, pnr, PORT_CMD, val);
 259         ndelay(500);
 260         val = ahci_port_readl(ctrl, pnr, PORT_CMD);
 261         count++;
 262     }
 263
 264     /* clear status */
 265     val = ahci_port_readl(ctrl, pnr, PORT_SCR_ERR);
 266     if (val)
 267         ahci_port_writel(ctrl, pnr, PORT_SCR_ERR, val);
 268
 269     /* disable + clear IRQs */
 270     ahci_port_writel(ctrl, pnr, PORT_IRQ_MASK, val);
 271     val = ahci_port_readl(ctrl, pnr, PORT_IRQ_STAT);
 272     if (val)
 273         ahci_port_writel(ctrl, pnr, PORT_IRQ_STAT, val);
 274 }
 275
 276 static int
 277 ahci_port_probe(struct ahci_ctrl_s *ctrl, u32 pnr)
 278 {
 279     u32 val, count = 0;
 280
 281     val = ahci_port_readl(ctrl, pnr, PORT_TFDATA);
 282     while (val & ((1 << 7) /* BSY */ |
 283                   (1 << 3) /* DRQ */)) {
 284         ndelay(500);
 285         val = ahci_port_readl(ctrl, pnr, PORT_TFDATA);
 286         count++;
 287         if (count >= AHCI_MAX_RETRIES)
 288             return -1;
 289     }
 290
 291     val = ahci_port_readl(ctrl, pnr, PORT_SCR_STAT);
 292     if ((val & 0x07) != 0x03)
 293         return -1;
 294     return 0;
 295 }
 296
 297 #define MAXMODEL 40
 298
 299 static struct ahci_port_s*
 300 ahci_port_init(struct ahci_ctrl_s *ctrl, u32 pnr)
 301 {
 302     struct ahci_port_s *port = malloc_fseg(sizeof(*port));
 303     char model[MAXMODEL+1];
 304     u16 buffer[256];
 305     u32 val;
 306     int rc;
 307
 308     if (!port) {
 309         warn_noalloc();
 310         return NULL;
 311     }
 312     port->pnr = pnr;
 313     port->ctrl = ctrl;
 314     port->list = memalign_low(1024, 1024);
 315     port->fis = memalign_low(256, 256);
 316     port->cmd = memalign_low(256, 256);
 317     if (port->list == NULL || port->fis == NULL || port->cmd == NULL) {
 318         warn_noalloc();
 319         return NULL;
 320     }
 321     memset(port->list, 0, 1024);
 322     memset(port->fis, 0, 256);
 323     memset(port->cmd, 0, 256);
 324
 325     ahci_port_writel(ctrl, pnr, PORT_LST_ADDR, (u32)port->list);
 326     ahci_port_writel(ctrl, pnr, PORT_FIS_ADDR, (u32)port->fis);
 327     val = ahci_port_readl(ctrl, pnr, PORT_CMD);
 328     ahci_port_writel(ctrl, pnr, PORT_CMD, val | PORT_CMD_FIS_RX);
 329
 330     sata_prep_simple(&port->cmd->fis, ATA_CMD_IDENTIFY_PACKET_DEVICE);
 331     rc = ahci_command(port, 0, 0, buffer, sizeof(buffer));
 332     if (rc == 0) {
 333         port->atapi = 1;
 334     } else {
 335         port->atapi = 0;
 336         sata_prep_simple(&port->cmd->fis, ATA_CMD_IDENTIFY_DEVICE);
 337         rc = ahci_command(port, 0, 0, buffer, sizeof(buffer));
 338         if (rc < 0)
 339             goto err;
 340     }
 341
 342     port->drive.type = DTYPE_AHCI;
 343     port->drive.removable = (buffer[0] & 0x80) ? 1 : 0;
 344     port->drive.desc = malloc_tmp(MAXDESCSIZE);
 345     if (!port->drive.desc) {
 346         warn_noalloc();
 347         return NULL;
 348     }
 349
 350     if (!port->atapi) {
 351         // found disk (ata)
 352         port->drive.blksize = DISK_SECTOR_SIZE;
 353         port->drive.pchs.cylinders = buffer[1];
 354         port->drive.pchs.heads = buffer[3];
 355         port->drive.pchs.spt = buffer[6];
 356
 357         u64 sectors;
 358         if (buffer[83] & (1 << 10)) // word 83 - lba48 support
 359             sectors = *(u64*)&buffer[100]; // word 100-103
 360         else
 361             sectors = *(u32*)&buffer[60]; // word 60 and word 61
 362         port->drive.sectors = sectors;
 363         u64 adjsize = sectors >> 11;
 364         char adjprefix = 'M';
 365         if (adjsize >= (1 << 16)) {
 366             adjsize >>= 10;
 367             adjprefix = 'G';
 368         }
 369         snprintf(port->drive.desc, MAXDESCSIZE
 370                  , "AHCI/%d: %s ATA-%d Hard-Disk (%u %ciBytes)"
 371                  , port->pnr
 372                  , ata_extract_model(model, MAXMODEL, buffer)
 373                  , ata_extract_version(buffer)
 374                  , (u32)adjsize, adjprefix);
 375
 376         // Setup disk geometry translation.
 377         setup_translation(&port->drive);
 378         // Register with bcv system.
 379         add_bcv_internal(&port->drive);
 380     } else {
 381         // found cdrom (atapi)
 382         port->drive.blksize = CDROM_SECTOR_SIZE;
 383         port->drive.sectors = (u64)-1;
 384         u8 iscd = ((buffer[0] >> 8) & 0x1f) == 0x05;
 385         snprintf(port->drive.desc, MAXDESCSIZE, "AHCI/%d: %s ATAPI-%d %s"
 386                  , port->pnr
 387                  , ata_extract_model(model, MAXMODEL, buffer)
 388                  , ata_extract_version(buffer)
 389                  , (iscd ? "DVD/CD" : "Device"));
 390
 391         // fill cdidmap
 392         if (iscd)
 393             map_cd_drive(&port->drive);
 394     }
 395     dprintf(1, "%s\n", port->drive.desc);
 396
 397     return port;
 398
 399 err:
 400     dprintf(1, "AHCI/%d: init failure, reset\n", port->pnr);
 401     ahci_port_reset(ctrl, pnr);
 402     return NULL;
 403 }
 404
 405 // Detect any drives attached to a given controller.
 406 static void
 407 ahci_detect(void *data)
 408 {
 409     struct ahci_ctrl_s *ctrl = data;
 410     struct ahci_port_s *port;
 411     u32 pnr, max;
 412     int rc;
 413
 414     max = ctrl->caps & 0x1f;
 415     for (pnr = 0; pnr < max; pnr++) {
 416         if (!(ctrl->ports & (1 << pnr)))
 417             continue;
 418         dprintf(2, "AHCI/%d: probing\n", pnr);
 419         ahci_port_reset(ctrl, pnr);
 420         rc = ahci_port_probe(ctrl, pnr);
 421         dprintf(1, "AHCI/%d: link %s\n", pnr, rc == 0 ? "up" : "down");
 422         if (rc != 0)
 423             continue;
 424         port = ahci_port_init(ctrl, pnr);
 425     }
 426 }
 427
 428 // Initialize an ata controller and detect its drives.
 429 static void
 430 ahci_init_controller(int bdf)
 431 {
 432     struct ahci_ctrl_s *ctrl = malloc_fseg(sizeof(*ctrl));
 433     u32 val;
 434
 435     if (!ctrl) {
 436         warn_noalloc();
 437         return;
 438     }
 439     ctrl->pci_bdf = bdf;
 440     ctrl->iobase = pci_config_readl(bdf, PCI_BASE_ADDRESS_5);
 441     ctrl->irq = pci_config_readb(bdf, PCI_INTERRUPT_LINE);
 442     dprintf(1, "AHCI controller at %02x.%x, iobase %x, irq %d\n",
 443             bdf >> 3, bdf & 7, ctrl->iobase, ctrl->irq);
 444
 445     val = ahci_ctrl_readl(ctrl, HOST_CTL);
 446     ahci_ctrl_writel(ctrl, HOST_CTL, val | HOST_CTL_AHCI_EN);
 447
 448     ctrl->caps = ahci_ctrl_readl(ctrl, HOST_CAP);
 449     ctrl->ports = ahci_ctrl_readl(ctrl, HOST_PORTS_IMPL);
 450     dprintf(2, "AHCI: cap 0x%x, ports_impl 0x%x\n",
 451             ctrl->caps, ctrl->ports);
 452
 453     run_thread(ahci_detect, ctrl);
 454 }
 455
 456 // Locate and init ahci controllers.
 457 static void
 458 ahci_init(void)
 459 {
 460     // Scan PCI bus for ATA adapters
 461     int bdf, max;
 462     foreachpci(bdf, max) {
 463         if (pci_config_readw(bdf, PCI_CLASS_DEVICE) != PCI_CLASS_STORAGE_SATA)
 464             continue;
 465         if (pci_config_readb(bdf, PCI_CLASS_PROG) != 1 /* AHCI rev 1 */)
 466             continue;
 467         ahci_init_controller(bdf);
 468     }
 469 }
 470
 471 void
 472 ahci_setup(void)
 473 {
 474     ASSERT32FLAT();
 475     if (!CONFIG_AHCI)
 476         return;
 477
 478     dprintf(3, "init ahci\n");
 479     ahci_init();
 480 }