2 * libqos AHCI functions
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 #include "qemu/osdep.h"
28 #include "libqos/ahci.h"
29 #include "libqos/pci-pc.h"
31 #include "qemu-common.h"
32 #include "qemu/host-utils.h"
34 #include "hw/pci/pci_ids.h"
35 #include "hw/pci/pci_regs.h"
37 typedef struct AHCICommandProp {
38 uint8_t cmd; /* Command Code */
39 bool data; /* Data transfer command? */
48 uint64_t size; /* Static transfer size, for commands like IDENTIFY. */
49 uint32_t interrupts; /* Expected interrupts for this command. */
52 AHCICommandProp ahci_command_properties[] = {
53 { .cmd = CMD_READ_PIO, .data = true, .pio = true,
54 .lba28 = true, .read = true },
55 { .cmd = CMD_WRITE_PIO, .data = true, .pio = true,
56 .lba28 = true, .write = true },
57 { .cmd = CMD_READ_PIO_EXT, .data = true, .pio = true,
58 .lba48 = true, .read = true },
59 { .cmd = CMD_WRITE_PIO_EXT, .data = true, .pio = true,
60 .lba48 = true, .write = true },
61 { .cmd = CMD_READ_DMA, .data = true, .dma = true,
62 .lba28 = true, .read = true },
63 { .cmd = CMD_WRITE_DMA, .data = true, .dma = true,
64 .lba28 = true, .write = true },
65 { .cmd = CMD_READ_DMA_EXT, .data = true, .dma = true,
66 .lba48 = true, .read = true },
67 { .cmd = CMD_WRITE_DMA_EXT, .data = true, .dma = true,
68 .lba48 = true, .write = true },
69 { .cmd = CMD_IDENTIFY, .data = true, .pio = true,
70 .size = 512, .read = true },
71 { .cmd = READ_FPDMA_QUEUED, .data = true, .dma = true,
72 .lba48 = true, .read = true, .ncq = true },
73 { .cmd = WRITE_FPDMA_QUEUED, .data = true, .dma = true,
74 .lba48 = true, .write = true, .ncq = true },
75 { .cmd = CMD_READ_MAX, .lba28 = true },
76 { .cmd = CMD_READ_MAX_EXT, .lba48 = true },
77 { .cmd = CMD_FLUSH_CACHE, .data = false },
78 { .cmd = CMD_PACKET, .data = true, .size = 16,
79 .atapi = true, .pio = true },
80 { .cmd = CMD_PACKET_ID, .data = true, .pio = true,
81 .size = 512, .read = true }
85 /* Test Management Data */
93 AHCICommandProp *props;
94 /* Data to be transferred to the guest */
95 AHCICommandHeader header;
97 unsigned char *atapi_cmd;
101 * Allocate space in the guest using information in the AHCIQState object.
103 uint64_t ahci_alloc(AHCIQState *ahci, size_t bytes)
106 g_assert(ahci->parent);
107 return qmalloc(ahci->parent, bytes);
110 void ahci_free(AHCIQState *ahci, uint64_t addr)
113 g_assert(ahci->parent);
114 qfree(ahci->parent, addr);
117 bool is_atapi(AHCIQState *ahci, uint8_t port)
119 return ahci_px_rreg(ahci, port, AHCI_PX_SIG) == AHCI_SIGNATURE_CDROM;
123 * Locate, verify, and return a handle to the AHCI device.
125 QPCIDevice *get_ahci_device(uint32_t *fingerprint)
128 uint32_t ahci_fingerprint;
131 pcibus = qpci_init_pc(NULL);
133 /* Find the AHCI PCI device and verify it's the right one. */
134 ahci = qpci_device_find(pcibus, QPCI_DEVFN(0x1F, 0x02));
135 g_assert(ahci != NULL);
137 ahci_fingerprint = qpci_config_readl(ahci, PCI_VENDOR_ID);
139 switch (ahci_fingerprint) {
140 case AHCI_INTEL_ICH9:
143 /* Unknown device. */
144 g_assert_not_reached();
148 *fingerprint = ahci_fingerprint;
153 void free_ahci_device(QPCIDevice *dev)
155 QPCIBus *pcibus = dev ? dev->bus : NULL;
157 /* libqos doesn't have a function for this, so free it manually */
159 qpci_free_pc(pcibus);
162 /* Free all memory in-use by the AHCI device. */
163 void ahci_clean_mem(AHCIQState *ahci)
167 for (port = 0; port < 32; ++port) {
168 if (ahci->port[port].fb) {
169 ahci_free(ahci, ahci->port[port].fb);
170 ahci->port[port].fb = 0;
172 if (ahci->port[port].clb) {
173 for (slot = 0; slot < 32; slot++) {
174 ahci_destroy_command(ahci, port, slot);
176 ahci_free(ahci, ahci->port[port].clb);
177 ahci->port[port].clb = 0;
182 /*** Logical Device Initialization ***/
185 * Start the PCI device and sanity-check default operation.
187 void ahci_pci_enable(AHCIQState *ahci)
191 start_ahci_device(ahci);
193 switch (ahci->fingerprint) {
194 case AHCI_INTEL_ICH9:
195 /* ICH9 has a register at PCI 0x92 that
196 * acts as a master port enabler mask. */
197 reg = qpci_config_readb(ahci->dev, 0x92);
199 qpci_config_writeb(ahci->dev, 0x92, reg);
200 /* 0...0111111b -- bit significant, ports 0-5 enabled. */
201 ASSERT_BIT_SET(qpci_config_readb(ahci->dev, 0x92), 0x3F);
208 * Map BAR5/ABAR, and engage the PCI device.
210 void start_ahci_device(AHCIQState *ahci)
212 /* Map AHCI's ABAR (BAR5) */
213 ahci->hba_bar = qpci_iomap(ahci->dev, 5, &ahci->barsize);
215 /* turns on pci.cmd.iose, pci.cmd.mse and pci.cmd.bme */
216 qpci_device_enable(ahci->dev);
220 * Test and initialize the AHCI's HBA memory areas.
221 * Initialize and start any ports with devices attached.
222 * Bring the HBA into the idle state.
224 void ahci_hba_enable(AHCIQState *ahci)
226 /* Bits of interest in this section:
227 * GHC.AE Global Host Control / AHCI Enable
228 * PxCMD.ST Port Command: Start
229 * PxCMD.SUD "Spin Up Device"
230 * PxCMD.POD "Power On Device"
231 * PxCMD.FRE "FIS Receive Enable"
232 * PxCMD.FR "FIS Receive Running"
233 * PxCMD.CR "Command List Running"
235 uint32_t reg, ports_impl;
237 uint8_t num_cmd_slots;
239 g_assert(ahci != NULL);
241 /* Set GHC.AE to 1 */
242 ahci_set(ahci, AHCI_GHC, AHCI_GHC_AE);
243 reg = ahci_rreg(ahci, AHCI_GHC);
244 ASSERT_BIT_SET(reg, AHCI_GHC_AE);
246 /* Cache CAP and CAP2. */
247 ahci->cap = ahci_rreg(ahci, AHCI_CAP);
248 ahci->cap2 = ahci_rreg(ahci, AHCI_CAP2);
250 /* Read CAP.NCS, how many command slots do we have? */
251 num_cmd_slots = ((ahci->cap & AHCI_CAP_NCS) >> ctzl(AHCI_CAP_NCS)) + 1;
252 g_test_message("Number of Command Slots: %u", num_cmd_slots);
254 /* Determine which ports are implemented. */
255 ports_impl = ahci_rreg(ahci, AHCI_PI);
257 for (i = 0; ports_impl; ports_impl >>= 1, ++i) {
258 if (!(ports_impl & 0x01)) {
262 g_test_message("Initializing port %u", i);
264 reg = ahci_px_rreg(ahci, i, AHCI_PX_CMD);
265 if (BITCLR(reg, AHCI_PX_CMD_ST | AHCI_PX_CMD_CR |
266 AHCI_PX_CMD_FRE | AHCI_PX_CMD_FR)) {
267 g_test_message("port is idle");
269 g_test_message("port needs to be idled");
270 ahci_px_clr(ahci, i, AHCI_PX_CMD,
271 (AHCI_PX_CMD_ST | AHCI_PX_CMD_FRE));
272 /* The port has 500ms to disengage. */
274 reg = ahci_px_rreg(ahci, i, AHCI_PX_CMD);
275 ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_CR);
276 ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_FR);
277 g_test_message("port is now idle");
278 /* The spec does allow for possibly needing a PORT RESET
279 * or HBA reset if we fail to idle the port. */
282 /* Allocate Memory for the Command List Buffer & FIS Buffer */
283 /* PxCLB space ... 0x20 per command, as in 4.2.2 p 36 */
284 ahci->port[i].clb = ahci_alloc(ahci, num_cmd_slots * 0x20);
285 qmemset(ahci->port[i].clb, 0x00, num_cmd_slots * 0x20);
286 g_test_message("CLB: 0x%08" PRIx64, ahci->port[i].clb);
287 ahci_px_wreg(ahci, i, AHCI_PX_CLB, ahci->port[i].clb);
288 g_assert_cmphex(ahci->port[i].clb, ==,
289 ahci_px_rreg(ahci, i, AHCI_PX_CLB));
291 /* PxFB space ... 0x100, as in 4.2.1 p 35 */
292 ahci->port[i].fb = ahci_alloc(ahci, 0x100);
293 qmemset(ahci->port[i].fb, 0x00, 0x100);
294 g_test_message("FB: 0x%08" PRIx64, ahci->port[i].fb);
295 ahci_px_wreg(ahci, i, AHCI_PX_FB, ahci->port[i].fb);
296 g_assert_cmphex(ahci->port[i].fb, ==,
297 ahci_px_rreg(ahci, i, AHCI_PX_FB));
299 /* Clear PxSERR, PxIS, then IS.IPS[x] by writing '1's. */
300 ahci_px_wreg(ahci, i, AHCI_PX_SERR, 0xFFFFFFFF);
301 ahci_px_wreg(ahci, i, AHCI_PX_IS, 0xFFFFFFFF);
302 ahci_wreg(ahci, AHCI_IS, (1 << i));
304 /* Verify Interrupts Cleared */
305 reg = ahci_px_rreg(ahci, i, AHCI_PX_SERR);
306 g_assert_cmphex(reg, ==, 0);
308 reg = ahci_px_rreg(ahci, i, AHCI_PX_IS);
309 g_assert_cmphex(reg, ==, 0);
311 reg = ahci_rreg(ahci, AHCI_IS);
312 ASSERT_BIT_CLEAR(reg, (1 << i));
314 /* Enable All Interrupts: */
315 ahci_px_wreg(ahci, i, AHCI_PX_IE, 0xFFFFFFFF);
316 reg = ahci_px_rreg(ahci, i, AHCI_PX_IE);
317 g_assert_cmphex(reg, ==, ~((uint32_t)AHCI_PX_IE_RESERVED));
319 /* Enable the FIS Receive Engine. */
320 ahci_px_set(ahci, i, AHCI_PX_CMD, AHCI_PX_CMD_FRE);
321 reg = ahci_px_rreg(ahci, i, AHCI_PX_CMD);
322 ASSERT_BIT_SET(reg, AHCI_PX_CMD_FR);
324 /* AHCI 1.3 spec: if !STS.BSY, !STS.DRQ and PxSSTS.DET indicates
325 * physical presence, a device is present and may be started. However,
326 * PxSERR.DIAG.X /may/ need to be cleared a priori. */
327 reg = ahci_px_rreg(ahci, i, AHCI_PX_SERR);
328 if (BITSET(reg, AHCI_PX_SERR_DIAG_X)) {
329 ahci_px_set(ahci, i, AHCI_PX_SERR, AHCI_PX_SERR_DIAG_X);
332 reg = ahci_px_rreg(ahci, i, AHCI_PX_TFD);
333 if (BITCLR(reg, AHCI_PX_TFD_STS_BSY | AHCI_PX_TFD_STS_DRQ)) {
334 reg = ahci_px_rreg(ahci, i, AHCI_PX_SSTS);
335 if ((reg & AHCI_PX_SSTS_DET) == SSTS_DET_ESTABLISHED) {
336 /* Device Found: set PxCMD.ST := 1 */
337 ahci_px_set(ahci, i, AHCI_PX_CMD, AHCI_PX_CMD_ST);
338 ASSERT_BIT_SET(ahci_px_rreg(ahci, i, AHCI_PX_CMD),
340 g_test_message("Started Device %u", i);
341 } else if ((reg & AHCI_PX_SSTS_DET)) {
342 /* Device present, but in some unknown state. */
343 g_assert_not_reached();
349 ahci_set(ahci, AHCI_GHC, AHCI_GHC_IE);
350 reg = ahci_rreg(ahci, AHCI_GHC);
351 ASSERT_BIT_SET(reg, AHCI_GHC_IE);
353 ahci->enabled = true;
354 /* TODO: The device should now be idling and waiting for commands.
355 * In the future, a small test-case to inspect the Register D2H FIS
356 * and clear the initial interrupts might be good. */
360 * Pick the first implemented and running port
362 unsigned ahci_port_select(AHCIQState *ahci)
367 ports = ahci_rreg(ahci, AHCI_PI);
368 for (i = 0; i < 32; ports >>= 1, ++i) {
373 if (!(ports & 0x01)) {
377 reg = ahci_px_rreg(ahci, i, AHCI_PX_CMD);
378 if (BITSET(reg, AHCI_PX_CMD_ST)) {
387 * Clear a port's interrupts and status information prior to a test.
389 void ahci_port_clear(AHCIQState *ahci, uint8_t port)
393 /* Clear out this port's interrupts (ignore the init register d2h fis) */
394 reg = ahci_px_rreg(ahci, port, AHCI_PX_IS);
395 ahci_px_wreg(ahci, port, AHCI_PX_IS, reg);
396 g_assert_cmphex(ahci_px_rreg(ahci, port, AHCI_PX_IS), ==, 0);
398 /* Wipe the FIS-Receive Buffer */
399 qmemset(ahci->port[port].fb, 0x00, 0x100);
403 * Check a port for errors.
405 void ahci_port_check_error(AHCIQState *ahci, uint8_t port)
409 /* The upper 9 bits of the IS register all indicate errors. */
410 reg = ahci_px_rreg(ahci, port, AHCI_PX_IS);
412 g_assert_cmphex(reg, ==, 0);
414 /* The Sata Error Register should be empty. */
415 reg = ahci_px_rreg(ahci, port, AHCI_PX_SERR);
416 g_assert_cmphex(reg, ==, 0);
418 /* The TFD also has two error sections. */
419 reg = ahci_px_rreg(ahci, port, AHCI_PX_TFD);
420 ASSERT_BIT_CLEAR(reg, AHCI_PX_TFD_STS_ERR);
421 ASSERT_BIT_CLEAR(reg, AHCI_PX_TFD_ERR);
424 void ahci_port_check_interrupts(AHCIQState *ahci, uint8_t port,
429 /* Check for expected interrupts */
430 reg = ahci_px_rreg(ahci, port, AHCI_PX_IS);
431 ASSERT_BIT_SET(reg, intr_mask);
433 /* Clear expected interrupts and assert all interrupts now cleared. */
434 ahci_px_wreg(ahci, port, AHCI_PX_IS, intr_mask);
435 g_assert_cmphex(ahci_px_rreg(ahci, port, AHCI_PX_IS), ==, 0);
438 void ahci_port_check_nonbusy(AHCIQState *ahci, uint8_t port, uint8_t slot)
442 /* Assert that the command slot is no longer busy (NCQ) */
443 reg = ahci_px_rreg(ahci, port, AHCI_PX_SACT);
444 ASSERT_BIT_CLEAR(reg, (1 << slot));
447 reg = ahci_px_rreg(ahci, port, AHCI_PX_CI);
448 ASSERT_BIT_CLEAR(reg, (1 << slot));
450 /* And assert that we are generally not busy. */
451 reg = ahci_px_rreg(ahci, port, AHCI_PX_TFD);
452 ASSERT_BIT_CLEAR(reg, AHCI_PX_TFD_STS_BSY);
453 ASSERT_BIT_CLEAR(reg, AHCI_PX_TFD_STS_DRQ);
456 void ahci_port_check_d2h_sanity(AHCIQState *ahci, uint8_t port, uint8_t slot)
458 RegD2HFIS *d2h = g_malloc0(0x20);
461 memread(ahci->port[port].fb + 0x40, d2h, 0x20);
462 g_assert_cmphex(d2h->fis_type, ==, 0x34);
464 reg = ahci_px_rreg(ahci, port, AHCI_PX_TFD);
465 g_assert_cmphex((reg & AHCI_PX_TFD_ERR) >> 8, ==, d2h->error);
466 g_assert_cmphex((reg & AHCI_PX_TFD_STS), ==, d2h->status);
471 void ahci_port_check_pio_sanity(AHCIQState *ahci, uint8_t port,
472 uint8_t slot, size_t buffsize)
474 PIOSetupFIS *pio = g_malloc0(0x20);
476 /* We cannot check the Status or E_Status registers, because
477 * the status may have again changed between the PIO Setup FIS
478 * and the conclusion of the command with the D2H Register FIS. */
479 memread(ahci->port[port].fb + 0x20, pio, 0x20);
480 g_assert_cmphex(pio->fis_type, ==, 0x5f);
482 /* BUG: PIO Setup FIS as utilized by QEMU tries to fit the entire
483 * transfer size in a uint16_t field. The maximum transfer size can
484 * eclipse this; the field is meant to convey the size of data per
485 * each Data FIS, not the entire operation as a whole. For now,
486 * we will sanity check the broken case where applicable. */
487 if (buffsize <= UINT16_MAX) {
488 g_assert_cmphex(le16_to_cpu(pio->tx_count), ==, buffsize);
494 void ahci_port_check_cmd_sanity(AHCIQState *ahci, AHCICommand *cmd)
496 AHCICommandHeader cmdh;
498 ahci_get_command_header(ahci, cmd->port, cmd->slot, &cmdh);
499 /* Physical Region Descriptor Byte Count is not required to work for NCQ. */
500 if (!cmd->props->ncq) {
501 g_assert_cmphex(cmd->xbytes, ==, cmdh.prdbc);
505 /* Get the command in #slot of port #port. */
506 void ahci_get_command_header(AHCIQState *ahci, uint8_t port,
507 uint8_t slot, AHCICommandHeader *cmd)
509 uint64_t ba = ahci->port[port].clb;
510 ba += slot * sizeof(AHCICommandHeader);
511 memread(ba, cmd, sizeof(AHCICommandHeader));
513 cmd->flags = le16_to_cpu(cmd->flags);
514 cmd->prdtl = le16_to_cpu(cmd->prdtl);
515 cmd->prdbc = le32_to_cpu(cmd->prdbc);
516 cmd->ctba = le64_to_cpu(cmd->ctba);
519 /* Set the command in #slot of port #port. */
520 void ahci_set_command_header(AHCIQState *ahci, uint8_t port,
521 uint8_t slot, AHCICommandHeader *cmd)
523 AHCICommandHeader tmp = { .flags = 0 };
524 uint64_t ba = ahci->port[port].clb;
525 ba += slot * sizeof(AHCICommandHeader);
527 tmp.flags = cpu_to_le16(cmd->flags);
528 tmp.prdtl = cpu_to_le16(cmd->prdtl);
529 tmp.prdbc = cpu_to_le32(cmd->prdbc);
530 tmp.ctba = cpu_to_le64(cmd->ctba);
532 memwrite(ba, &tmp, sizeof(AHCICommandHeader));
535 void ahci_destroy_command(AHCIQState *ahci, uint8_t port, uint8_t slot)
537 AHCICommandHeader cmd;
539 /* Obtain the Nth Command Header */
540 ahci_get_command_header(ahci, port, slot, &cmd);
542 /* No address in it, so just return -- it's empty. */
547 ahci_free(ahci, cmd.ctba);
550 /* NULL the header. */
551 memset(&cmd, 0x00, sizeof(cmd));
552 ahci_set_command_header(ahci, port, slot, &cmd);
553 ahci->port[port].ctba[slot] = 0;
554 ahci->port[port].prdtl[slot] = 0;
557 void ahci_write_fis(AHCIQState *ahci, AHCICommand *cmd)
559 RegH2DFIS tmp = cmd->fis;
560 uint64_t addr = cmd->header.ctba;
562 /* NCQ commands use exclusively 8 bit fields and needs no adjustment.
563 * Only the count field needs to be adjusted for non-NCQ commands.
564 * The auxiliary FIS fields are defined per-command and are not currently
565 * implemented in libqos/ahci.o, but may or may not need to be flipped. */
566 if (!cmd->props->ncq) {
567 tmp.count = cpu_to_le16(tmp.count);
570 memwrite(addr, &tmp, sizeof(tmp));
573 unsigned ahci_pick_cmd(AHCIQState *ahci, uint8_t port)
579 reg = ahci_px_rreg(ahci, port, AHCI_PX_CI);
581 /* Pick the least recently used command slot that's available */
582 for (i = 0; i < 32; ++i) {
583 j = ((ahci->port[port].next + i) % 32);
584 if (reg & (1 << j)) {
587 ahci_destroy_command(ahci, port, j);
588 ahci->port[port].next = (j + 1) % 32;
592 g_test_message("All command slots were busy.");
593 g_assert_not_reached();
596 inline unsigned size_to_prdtl(unsigned bytes, unsigned bytes_per_prd)
598 /* Each PRD can describe up to 4MiB */
599 g_assert_cmphex(bytes_per_prd, <=, 4096 * 1024);
600 g_assert_cmphex(bytes_per_prd & 0x01, ==, 0x00);
601 return (bytes + bytes_per_prd - 1) / bytes_per_prd;
604 const AHCIOpts default_opts = { .size = 0 };
607 * ahci_exec: execute a given command on a specific
610 * @ahci: The device to send the command to
611 * @port: The port number of the SATA device we wish
612 * to have execute this command
613 * @op: The S/ATA command to execute, or if opts.atapi
614 * is true, the SCSI command code.
615 * @opts: Optional arguments to modify execution behavior.
617 void ahci_exec(AHCIQState *ahci, uint8_t port,
618 uint8_t op, const AHCIOpts *opts_in)
624 opts = g_memdup((opts_in == NULL ? &default_opts : opts_in),
627 /* No guest buffer provided, create one. */
628 if (opts->size && !opts->buffer) {
629 opts->buffer = ahci_alloc(ahci, opts->size);
630 g_assert(opts->buffer);
631 qmemset(opts->buffer, 0x00, opts->size);
634 /* Command creation */
636 cmd = ahci_atapi_command_create(op);
637 if (opts->atapi_dma) {
638 ahci_command_enable_atapi_dma(cmd);
641 cmd = ahci_command_create(op);
643 ahci_command_adjust(cmd, opts->lba, opts->buffer,
644 opts->size, opts->prd_size);
647 rc = opts->pre_cb(ahci, cmd, opts);
648 g_assert_cmpint(rc, ==, 0);
651 /* Write command to memory and issue it */
652 ahci_command_commit(ahci, cmd, port);
653 ahci_command_issue_async(ahci, cmd);
655 qmp_eventwait("STOP");
658 rc = opts->mid_cb(ahci, cmd, opts);
659 g_assert_cmpint(rc, ==, 0);
662 qmp_async("{'execute':'cont' }");
663 qmp_eventwait("RESUME");
666 /* Wait for command to complete and verify sanity */
667 ahci_command_wait(ahci, cmd);
668 ahci_command_verify(ahci, cmd);
670 rc = opts->post_cb(ahci, cmd, opts);
671 g_assert_cmpint(rc, ==, 0);
673 ahci_command_free(cmd);
674 if (opts->buffer != opts_in->buffer) {
675 ahci_free(ahci, opts->buffer);
680 /* Issue a command, expecting it to fail and STOP the VM */
681 AHCICommand *ahci_guest_io_halt(AHCIQState *ahci, uint8_t port,
682 uint8_t ide_cmd, uint64_t buffer,
683 size_t bufsize, uint64_t sector)
687 cmd = ahci_command_create(ide_cmd);
688 ahci_command_adjust(cmd, sector, buffer, bufsize, 0);
689 ahci_command_commit(ahci, cmd, port);
690 ahci_command_issue_async(ahci, cmd);
691 qmp_eventwait("STOP");
696 /* Resume a previously failed command and verify/finalize */
697 void ahci_guest_io_resume(AHCIQState *ahci, AHCICommand *cmd)
699 /* Complete the command */
700 qmp_async("{'execute':'cont' }");
701 qmp_eventwait("RESUME");
702 ahci_command_wait(ahci, cmd);
703 ahci_command_verify(ahci, cmd);
704 ahci_command_free(cmd);
707 /* Given a guest buffer address, perform an IO operation */
708 void ahci_guest_io(AHCIQState *ahci, uint8_t port, uint8_t ide_cmd,
709 uint64_t buffer, size_t bufsize, uint64_t sector)
712 cmd = ahci_command_create(ide_cmd);
713 ahci_command_set_buffer(cmd, buffer);
714 ahci_command_set_size(cmd, bufsize);
716 ahci_command_set_offset(cmd, sector);
718 ahci_command_commit(ahci, cmd, port);
719 ahci_command_issue(ahci, cmd);
720 ahci_command_verify(ahci, cmd);
721 ahci_command_free(cmd);
724 static AHCICommandProp *ahci_command_find(uint8_t command_name)
728 for (i = 0; i < ARRAY_SIZE(ahci_command_properties); i++) {
729 if (ahci_command_properties[i].cmd == command_name) {
730 return &ahci_command_properties[i];
737 /* Given a HOST buffer, create a buffer address and perform an IO operation. */
738 void ahci_io(AHCIQState *ahci, uint8_t port, uint8_t ide_cmd,
739 void *buffer, size_t bufsize, uint64_t sector)
742 AHCICommandProp *props;
744 props = ahci_command_find(ide_cmd);
746 ptr = ahci_alloc(ahci, bufsize);
747 g_assert(!bufsize || ptr);
748 qmemset(ptr, 0x00, bufsize);
750 if (bufsize && props->write) {
751 bufwrite(ptr, buffer, bufsize);
754 ahci_guest_io(ahci, port, ide_cmd, ptr, bufsize, sector);
756 if (bufsize && props->read) {
757 bufread(ptr, buffer, bufsize);
760 ahci_free(ahci, ptr);
764 * Initializes a basic command header in memory.
765 * We assume that this is for an ATA command using RegH2DFIS.
767 static void command_header_init(AHCICommand *cmd)
769 AHCICommandHeader *hdr = &cmd->header;
770 AHCICommandProp *props = cmd->props;
772 hdr->flags = 5; /* RegH2DFIS is 5 DW long. Must be < 32 */
773 hdr->flags |= CMDH_CLR_BSY; /* Clear the BSY bit when done */
775 hdr->flags |= CMDH_WRITE;
778 hdr->flags |= CMDH_ATAPI;
780 /* Other flags: PREFETCH, RESET, and BIST */
781 hdr->prdtl = size_to_prdtl(cmd->xbytes, cmd->prd_size);
786 static void command_table_init(AHCICommand *cmd)
788 RegH2DFIS *fis = &(cmd->fis);
789 uint16_t sect_count = (cmd->xbytes / AHCI_SECTOR_SIZE);
791 fis->fis_type = REG_H2D_FIS;
792 fis->flags = REG_H2D_FIS_CMD; /* "Command" bit */
793 fis->command = cmd->name;
795 if (cmd->props->ncq) {
796 NCQFIS *ncqfis = (NCQFIS *)fis;
797 /* NCQ is weird and re-uses FIS frames for unrelated data.
798 * See SATA 3.2, 13.6.4.1 READ FPDMA QUEUED for an example. */
799 ncqfis->sector_low = sect_count & 0xFF;
800 ncqfis->sector_hi = (sect_count >> 8) & 0xFF;
801 ncqfis->device = NCQ_DEVICE_MAGIC;
802 /* Force Unit Access is bit 7 in the device register */
803 ncqfis->tag = 0; /* bits 3-7 are the NCQ tag */
804 ncqfis->prio = 0; /* bits 6,7 are a prio tag */
805 /* RARC bit is bit 0 of TAG field */
807 fis->feature_low = 0x00;
808 fis->feature_high = 0x00;
809 if (cmd->props->lba28 || cmd->props->lba48) {
810 fis->device = ATA_DEVICE_LBA;
812 fis->count = (cmd->xbytes / AHCI_SECTOR_SIZE);
816 memset(fis->aux, 0x00, ARRAY_SIZE(fis->aux));
819 void ahci_command_enable_atapi_dma(AHCICommand *cmd)
821 RegH2DFIS *fis = &(cmd->fis);
822 g_assert(cmd->props->atapi);
823 fis->feature_low |= 0x01;
824 cmd->interrupts &= ~AHCI_PX_IS_PSS;
825 cmd->props->dma = true;
826 cmd->props->pio = false;
827 /* BUG: We expect the DMA Setup interrupt for DMA commands */
828 /* cmd->interrupts |= AHCI_PX_IS_DSS; */
831 AHCICommand *ahci_command_create(uint8_t command_name)
833 AHCICommandProp *props = ahci_command_find(command_name);
837 cmd = g_malloc0(sizeof(AHCICommand));
838 g_assert(!(props->dma && props->pio));
839 g_assert(!(props->lba28 && props->lba48));
840 g_assert(!(props->read && props->write));
841 g_assert(!props->size || props->data);
842 g_assert(!props->ncq || props->lba48);
844 /* Defaults and book-keeping */
845 cmd->props = g_memdup(props, sizeof(AHCICommandProp));
846 cmd->name = command_name;
847 cmd->xbytes = props->size;
848 cmd->prd_size = 4096;
849 cmd->buffer = 0xabad1dea;
851 if (!cmd->props->ncq) {
852 cmd->interrupts = AHCI_PX_IS_DHRS;
854 /* BUG: We expect the DPS interrupt for data commands */
855 /* cmd->interrupts |= props->data ? AHCI_PX_IS_DPS : 0; */
856 /* BUG: We expect the DMA Setup interrupt for DMA commands */
857 /* cmd->interrupts |= props->dma ? AHCI_PX_IS_DSS : 0; */
858 cmd->interrupts |= props->pio ? AHCI_PX_IS_PSS : 0;
859 cmd->interrupts |= props->ncq ? AHCI_PX_IS_SDBS : 0;
861 command_header_init(cmd);
862 command_table_init(cmd);
867 AHCICommand *ahci_atapi_command_create(uint8_t scsi_cmd)
869 AHCICommand *cmd = ahci_command_create(CMD_PACKET);
870 cmd->atapi_cmd = g_malloc0(16);
871 cmd->atapi_cmd[0] = scsi_cmd;
872 /* ATAPI needs a PIO transfer chunk size set inside of the LBA registers.
873 * The block/sector size is a natural default. */
874 cmd->fis.lba_lo[1] = ATAPI_SECTOR_SIZE >> 8 & 0xFF;
875 cmd->fis.lba_lo[2] = ATAPI_SECTOR_SIZE & 0xFF;
880 void ahci_command_free(AHCICommand *cmd)
882 g_free(cmd->atapi_cmd);
887 void ahci_command_set_flags(AHCICommand *cmd, uint16_t cmdh_flags)
889 cmd->header.flags |= cmdh_flags;
892 void ahci_command_clr_flags(AHCICommand *cmd, uint16_t cmdh_flags)
894 cmd->header.flags &= ~cmdh_flags;
897 static void ahci_atapi_command_set_offset(AHCICommand *cmd, uint64_t lba)
899 unsigned char *cbd = cmd->atapi_cmd;
903 case CMD_ATAPI_READ_10:
904 g_assert_cmpuint(lba, <=, UINT32_MAX);
905 stl_be_p(&cbd[2], lba);
908 /* SCSI doesn't have uniform packet formats,
909 * so you have to add support for it manually. Sorry! */
910 g_assert_not_reached();
914 void ahci_command_set_offset(AHCICommand *cmd, uint64_t lba_sect)
916 RegH2DFIS *fis = &(cmd->fis);
918 if (cmd->props->atapi) {
919 ahci_atapi_command_set_offset(cmd, lba_sect);
921 } else if (!cmd->props->data && !lba_sect) {
922 /* Not meaningful, ignore. */
924 } else if (cmd->props->lba28) {
925 g_assert_cmphex(lba_sect, <=, 0xFFFFFFF);
926 } else if (cmd->props->lba48 || cmd->props->ncq) {
927 g_assert_cmphex(lba_sect, <=, 0xFFFFFFFFFFFF);
929 /* Can't set offset if we don't know the format. */
930 g_assert_not_reached();
933 /* LBA28 uses the low nibble of the device/control register for LBA24:27 */
934 fis->lba_lo[0] = (lba_sect & 0xFF);
935 fis->lba_lo[1] = (lba_sect >> 8) & 0xFF;
936 fis->lba_lo[2] = (lba_sect >> 16) & 0xFF;
937 if (cmd->props->lba28) {
938 fis->device = (fis->device & 0xF0) | ((lba_sect >> 24) & 0x0F);
940 fis->lba_hi[0] = (lba_sect >> 24) & 0xFF;
941 fis->lba_hi[1] = (lba_sect >> 32) & 0xFF;
942 fis->lba_hi[2] = (lba_sect >> 40) & 0xFF;
945 void ahci_command_set_buffer(AHCICommand *cmd, uint64_t buffer)
947 cmd->buffer = buffer;
950 static void ahci_atapi_set_size(AHCICommand *cmd, uint64_t xbytes)
952 unsigned char *cbd = cmd->atapi_cmd;
953 uint64_t nsectors = xbytes / 2048;
957 case CMD_ATAPI_READ_10:
958 g_assert_cmpuint(nsectors, <=, UINT16_MAX);
959 stw_be_p(&cbd[7], nsectors);
962 /* SCSI doesn't have uniform packet formats,
963 * so you have to add support for it manually. Sorry! */
964 g_assert_not_reached();
968 void ahci_command_set_sizes(AHCICommand *cmd, uint64_t xbytes,
973 /* Each PRD can describe up to 4MiB, and must not be odd. */
974 g_assert_cmphex(prd_size, <=, 4096 * 1024);
975 g_assert_cmphex(prd_size & 0x01, ==, 0x00);
977 cmd->prd_size = prd_size;
979 cmd->xbytes = xbytes;
980 sect_count = (cmd->xbytes / AHCI_SECTOR_SIZE);
982 if (cmd->props->ncq) {
983 NCQFIS *nfis = (NCQFIS *)&(cmd->fis);
984 nfis->sector_low = sect_count & 0xFF;
985 nfis->sector_hi = (sect_count >> 8) & 0xFF;
986 } else if (cmd->props->atapi) {
987 ahci_atapi_set_size(cmd, xbytes);
989 cmd->fis.count = sect_count;
991 cmd->header.prdtl = size_to_prdtl(cmd->xbytes, cmd->prd_size);
994 void ahci_command_set_size(AHCICommand *cmd, uint64_t xbytes)
996 ahci_command_set_sizes(cmd, xbytes, cmd->prd_size);
999 void ahci_command_set_prd_size(AHCICommand *cmd, unsigned prd_size)
1001 ahci_command_set_sizes(cmd, cmd->xbytes, prd_size);
1004 void ahci_command_adjust(AHCICommand *cmd, uint64_t offset, uint64_t buffer,
1005 uint64_t xbytes, unsigned prd_size)
1007 ahci_command_set_sizes(cmd, xbytes, prd_size);
1008 ahci_command_set_buffer(cmd, buffer);
1009 ahci_command_set_offset(cmd, offset);
1012 void ahci_command_commit(AHCIQState *ahci, AHCICommand *cmd, uint8_t port)
1015 uint64_t table_size, table_ptr, remaining;
1018 /* This command is now tied to this port/command slot */
1020 cmd->slot = ahci_pick_cmd(ahci, port);
1022 if (cmd->props->ncq) {
1023 NCQFIS *nfis = (NCQFIS *)&cmd->fis;
1024 nfis->tag = (cmd->slot << 3) & 0xFC;
1027 /* Create a buffer for the command table */
1028 prdtl = size_to_prdtl(cmd->xbytes, cmd->prd_size);
1029 table_size = CMD_TBL_SIZ(prdtl);
1030 table_ptr = ahci_alloc(ahci, table_size);
1031 g_assert(table_ptr);
1032 /* AHCI 1.3: Must be aligned to 0x80 */
1033 g_assert((table_ptr & 0x7F) == 0x00);
1034 cmd->header.ctba = table_ptr;
1036 /* Commit the command header (part of the Command List Buffer) */
1037 ahci_set_command_header(ahci, port, cmd->slot, &(cmd->header));
1038 /* Now, write the command table (FIS, ACMD, and PRDT) -- FIS first, */
1039 ahci_write_fis(ahci, cmd);
1040 /* Then ATAPI CMD, if needed */
1041 if (cmd->props->atapi) {
1042 memwrite(table_ptr + 0x40, cmd->atapi_cmd, 16);
1045 /* Construct and write the PRDs to the command table */
1046 g_assert_cmphex(prdtl, ==, cmd->header.prdtl);
1047 remaining = cmd->xbytes;
1048 for (i = 0; i < prdtl; ++i) {
1049 prd.dba = cpu_to_le64(cmd->buffer + (cmd->prd_size * i));
1051 if (remaining > cmd->prd_size) {
1052 /* Note that byte count is 0-based. */
1053 prd.dbc = cpu_to_le32(cmd->prd_size - 1);
1054 remaining -= cmd->prd_size;
1056 /* Again, dbc is 0-based. */
1057 prd.dbc = cpu_to_le32(remaining - 1);
1060 prd.dbc |= cpu_to_le32(0x80000000); /* Request DPS Interrupt */
1062 /* Commit the PRD entry to the Command Table */
1063 memwrite(table_ptr + 0x80 + (i * sizeof(PRD)),
1067 /* Bookmark the PRDTL and CTBA values */
1068 ahci->port[port].ctba[cmd->slot] = table_ptr;
1069 ahci->port[port].prdtl[cmd->slot] = prdtl;
1072 void ahci_command_issue_async(AHCIQState *ahci, AHCICommand *cmd)
1074 if (cmd->props->ncq) {
1075 ahci_px_wreg(ahci, cmd->port, AHCI_PX_SACT, (1 << cmd->slot));
1078 ahci_px_wreg(ahci, cmd->port, AHCI_PX_CI, (1 << cmd->slot));
1081 void ahci_command_wait(AHCIQState *ahci, AHCICommand *cmd)
1083 /* We can't rely on STS_BSY until the command has started processing.
1084 * Therefore, we also use the Command Issue bit as indication of
1085 * a command in-flight. */
1087 #define RSET(REG, MASK) (BITSET(ahci_px_rreg(ahci, cmd->port, (REG)), (MASK)))
1089 while (RSET(AHCI_PX_TFD, AHCI_PX_TFD_STS_BSY) ||
1090 RSET(AHCI_PX_CI, 1 << cmd->slot) ||
1091 (cmd->props->ncq && RSET(AHCI_PX_SACT, 1 << cmd->slot))) {
1097 void ahci_command_issue(AHCIQState *ahci, AHCICommand *cmd)
1099 ahci_command_issue_async(ahci, cmd);
1100 ahci_command_wait(ahci, cmd);
1103 void ahci_command_verify(AHCIQState *ahci, AHCICommand *cmd)
1105 uint8_t slot = cmd->slot;
1106 uint8_t port = cmd->port;
1108 ahci_port_check_error(ahci, port);
1109 ahci_port_check_interrupts(ahci, port, cmd->interrupts);
1110 ahci_port_check_nonbusy(ahci, port, slot);
1111 ahci_port_check_cmd_sanity(ahci, cmd);
1112 if (cmd->interrupts & AHCI_PX_IS_DHRS) {
1113 ahci_port_check_d2h_sanity(ahci, port, slot);
1115 if (cmd->props->pio) {
1116 ahci_port_check_pio_sanity(ahci, port, slot, cmd->xbytes);
1120 uint8_t ahci_command_slot(AHCICommand *cmd)