ahci: Add some MMIO debug printfs
[qemu/kevin.git] / hw / ide / ahci.c
blob721918991c8beb94a2d3dc03f2edbbd160c24019
1 /*
2 * QEMU AHCI Emulation
4 * Copyright (c) 2010 qiaochong@loongson.cn
5 * Copyright (c) 2010 Roland Elek <elek.roland@gmail.com>
6 * Copyright (c) 2010 Sebastian Herbszt <herbszt@gmx.de>
7 * Copyright (c) 2010 Alexander Graf <agraf@suse.de>
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
24 #include <hw/hw.h>
25 #include <hw/pci/msi.h>
26 #include <hw/i386/pc.h>
27 #include <hw/pci/pci.h>
29 #include "qemu/error-report.h"
30 #include "sysemu/block-backend.h"
31 #include "sysemu/dma.h"
32 #include "internal.h"
33 #include <hw/ide/pci.h>
34 #include <hw/ide/ahci.h>
36 #define DEBUG_AHCI 0
38 #define DPRINTF(port, fmt, ...) \
39 do { \
40 if (DEBUG_AHCI) { \
41 fprintf(stderr, "ahci: %s: [%d] ", __func__, port); \
42 fprintf(stderr, fmt, ## __VA_ARGS__); \
43 } \
44 } while (0)
46 static void check_cmd(AHCIState *s, int port);
47 static int handle_cmd(AHCIState *s, int port, uint8_t slot);
48 static void ahci_reset_port(AHCIState *s, int port);
49 static bool ahci_write_fis_d2h(AHCIDevice *ad);
50 static void ahci_init_d2h(AHCIDevice *ad);
51 static int ahci_dma_prepare_buf(IDEDMA *dma, int32_t limit);
52 static bool ahci_map_clb_address(AHCIDevice *ad);
53 static bool ahci_map_fis_address(AHCIDevice *ad);
54 static void ahci_unmap_clb_address(AHCIDevice *ad);
55 static void ahci_unmap_fis_address(AHCIDevice *ad);
58 static uint32_t ahci_port_read(AHCIState *s, int port, int offset)
60 uint32_t val;
61 AHCIPortRegs *pr;
62 pr = &s->dev[port].port_regs;
64 switch (offset) {
65 case PORT_LST_ADDR:
66 val = pr->lst_addr;
67 break;
68 case PORT_LST_ADDR_HI:
69 val = pr->lst_addr_hi;
70 break;
71 case PORT_FIS_ADDR:
72 val = pr->fis_addr;
73 break;
74 case PORT_FIS_ADDR_HI:
75 val = pr->fis_addr_hi;
76 break;
77 case PORT_IRQ_STAT:
78 val = pr->irq_stat;
79 break;
80 case PORT_IRQ_MASK:
81 val = pr->irq_mask;
82 break;
83 case PORT_CMD:
84 val = pr->cmd;
85 break;
86 case PORT_TFDATA:
87 val = pr->tfdata;
88 break;
89 case PORT_SIG:
90 val = pr->sig;
91 break;
92 case PORT_SCR_STAT:
93 if (s->dev[port].port.ifs[0].blk) {
94 val = SATA_SCR_SSTATUS_DET_DEV_PRESENT_PHY_UP |
95 SATA_SCR_SSTATUS_SPD_GEN1 | SATA_SCR_SSTATUS_IPM_ACTIVE;
96 } else {
97 val = SATA_SCR_SSTATUS_DET_NODEV;
99 break;
100 case PORT_SCR_CTL:
101 val = pr->scr_ctl;
102 break;
103 case PORT_SCR_ERR:
104 val = pr->scr_err;
105 break;
106 case PORT_SCR_ACT:
107 val = pr->scr_act;
108 break;
109 case PORT_CMD_ISSUE:
110 val = pr->cmd_issue;
111 break;
112 case PORT_RESERVED:
113 default:
114 val = 0;
116 DPRINTF(port, "offset: 0x%x val: 0x%x\n", offset, val);
117 return val;
121 static void ahci_irq_raise(AHCIState *s, AHCIDevice *dev)
123 DeviceState *dev_state = s->container;
124 PCIDevice *pci_dev = (PCIDevice *) object_dynamic_cast(OBJECT(dev_state),
125 TYPE_PCI_DEVICE);
127 DPRINTF(0, "raise irq\n");
129 if (pci_dev && msi_enabled(pci_dev)) {
130 msi_notify(pci_dev, 0);
131 } else {
132 qemu_irq_raise(s->irq);
136 static void ahci_irq_lower(AHCIState *s, AHCIDevice *dev)
138 DeviceState *dev_state = s->container;
139 PCIDevice *pci_dev = (PCIDevice *) object_dynamic_cast(OBJECT(dev_state),
140 TYPE_PCI_DEVICE);
142 DPRINTF(0, "lower irq\n");
144 if (!pci_dev || !msi_enabled(pci_dev)) {
145 qemu_irq_lower(s->irq);
149 static void ahci_check_irq(AHCIState *s)
151 int i;
153 DPRINTF(-1, "check irq %#x\n", s->control_regs.irqstatus);
155 s->control_regs.irqstatus = 0;
156 for (i = 0; i < s->ports; i++) {
157 AHCIPortRegs *pr = &s->dev[i].port_regs;
158 if (pr->irq_stat & pr->irq_mask) {
159 s->control_regs.irqstatus |= (1 << i);
163 if (s->control_regs.irqstatus &&
164 (s->control_regs.ghc & HOST_CTL_IRQ_EN)) {
165 ahci_irq_raise(s, NULL);
166 } else {
167 ahci_irq_lower(s, NULL);
171 static void ahci_trigger_irq(AHCIState *s, AHCIDevice *d,
172 int irq_type)
174 DPRINTF(d->port_no, "trigger irq %#x -> %x\n",
175 irq_type, d->port_regs.irq_mask & irq_type);
177 d->port_regs.irq_stat |= irq_type;
178 ahci_check_irq(s);
181 static void map_page(AddressSpace *as, uint8_t **ptr, uint64_t addr,
182 uint32_t wanted)
184 hwaddr len = wanted;
186 if (*ptr) {
187 dma_memory_unmap(as, *ptr, len, DMA_DIRECTION_FROM_DEVICE, len);
190 *ptr = dma_memory_map(as, addr, &len, DMA_DIRECTION_FROM_DEVICE);
191 if (len < wanted) {
192 dma_memory_unmap(as, *ptr, len, DMA_DIRECTION_FROM_DEVICE, len);
193 *ptr = NULL;
198 * Check the cmd register to see if we should start or stop
199 * the DMA or FIS RX engines.
201 * @ad: Device to engage.
202 * @allow_stop: Allow device to transition from started to stopped?
203 * 'no' is useful for migration post_load, which does not expect a transition.
205 * @return 0 on success, -1 on error.
207 static int ahci_cond_start_engines(AHCIDevice *ad, bool allow_stop)
209 AHCIPortRegs *pr = &ad->port_regs;
211 if (pr->cmd & PORT_CMD_START) {
212 if (ahci_map_clb_address(ad)) {
213 pr->cmd |= PORT_CMD_LIST_ON;
214 } else {
215 error_report("AHCI: Failed to start DMA engine: "
216 "bad command list buffer address");
217 return -1;
219 } else if (pr->cmd & PORT_CMD_LIST_ON) {
220 if (allow_stop) {
221 ahci_unmap_clb_address(ad);
222 pr->cmd = pr->cmd & ~(PORT_CMD_LIST_ON);
223 } else {
224 error_report("AHCI: DMA engine should be off, "
225 "but appears to still be running");
226 return -1;
230 if (pr->cmd & PORT_CMD_FIS_RX) {
231 if (ahci_map_fis_address(ad)) {
232 pr->cmd |= PORT_CMD_FIS_ON;
233 } else {
234 error_report("AHCI: Failed to start FIS receive engine: "
235 "bad FIS receive buffer address");
236 return -1;
238 } else if (pr->cmd & PORT_CMD_FIS_ON) {
239 if (allow_stop) {
240 ahci_unmap_fis_address(ad);
241 pr->cmd = pr->cmd & ~(PORT_CMD_FIS_ON);
242 } else {
243 error_report("AHCI: FIS receive engine should be off, "
244 "but appears to still be running");
245 return -1;
249 return 0;
252 static void ahci_port_write(AHCIState *s, int port, int offset, uint32_t val)
254 AHCIPortRegs *pr = &s->dev[port].port_regs;
256 DPRINTF(port, "offset: 0x%x val: 0x%x\n", offset, val);
257 switch (offset) {
258 case PORT_LST_ADDR:
259 pr->lst_addr = val;
260 break;
261 case PORT_LST_ADDR_HI:
262 pr->lst_addr_hi = val;
263 break;
264 case PORT_FIS_ADDR:
265 pr->fis_addr = val;
266 break;
267 case PORT_FIS_ADDR_HI:
268 pr->fis_addr_hi = val;
269 break;
270 case PORT_IRQ_STAT:
271 pr->irq_stat &= ~val;
272 ahci_check_irq(s);
273 break;
274 case PORT_IRQ_MASK:
275 pr->irq_mask = val & 0xfdc000ff;
276 ahci_check_irq(s);
277 break;
278 case PORT_CMD:
279 /* Block any Read-only fields from being set;
280 * including LIST_ON and FIS_ON.
281 * The spec requires to set ICC bits to zero after the ICC change
282 * is done. We don't support ICC state changes, therefore always
283 * force the ICC bits to zero.
285 pr->cmd = (pr->cmd & PORT_CMD_RO_MASK) |
286 (val & ~(PORT_CMD_RO_MASK|PORT_CMD_ICC_MASK));
288 /* Check FIS RX and CLB engines, allow transition to false: */
289 ahci_cond_start_engines(&s->dev[port], true);
291 /* XXX usually the FIS would be pending on the bus here and
292 issuing deferred until the OS enables FIS receival.
293 Instead, we only submit it once - which works in most
294 cases, but is a hack. */
295 if ((pr->cmd & PORT_CMD_FIS_ON) &&
296 !s->dev[port].init_d2h_sent) {
297 ahci_init_d2h(&s->dev[port]);
300 check_cmd(s, port);
301 break;
302 case PORT_TFDATA:
303 /* Read Only. */
304 break;
305 case PORT_SIG:
306 /* Read Only */
307 break;
308 case PORT_SCR_STAT:
309 /* Read Only */
310 break;
311 case PORT_SCR_CTL:
312 if (((pr->scr_ctl & AHCI_SCR_SCTL_DET) == 1) &&
313 ((val & AHCI_SCR_SCTL_DET) == 0)) {
314 ahci_reset_port(s, port);
316 pr->scr_ctl = val;
317 break;
318 case PORT_SCR_ERR:
319 pr->scr_err &= ~val;
320 break;
321 case PORT_SCR_ACT:
322 /* RW1 */
323 pr->scr_act |= val;
324 break;
325 case PORT_CMD_ISSUE:
326 pr->cmd_issue |= val;
327 check_cmd(s, port);
328 break;
329 default:
330 break;
334 static uint64_t ahci_mem_read_32(void *opaque, hwaddr addr)
336 AHCIState *s = opaque;
337 uint32_t val = 0;
339 if (addr < AHCI_GENERIC_HOST_CONTROL_REGS_MAX_ADDR) {
340 switch (addr) {
341 case HOST_CAP:
342 val = s->control_regs.cap;
343 break;
344 case HOST_CTL:
345 val = s->control_regs.ghc;
346 break;
347 case HOST_IRQ_STAT:
348 val = s->control_regs.irqstatus;
349 break;
350 case HOST_PORTS_IMPL:
351 val = s->control_regs.impl;
352 break;
353 case HOST_VERSION:
354 val = s->control_regs.version;
355 break;
358 DPRINTF(-1, "(addr 0x%08X), val 0x%08X\n", (unsigned) addr, val);
359 } else if ((addr >= AHCI_PORT_REGS_START_ADDR) &&
360 (addr < (AHCI_PORT_REGS_START_ADDR +
361 (s->ports * AHCI_PORT_ADDR_OFFSET_LEN)))) {
362 val = ahci_port_read(s, (addr - AHCI_PORT_REGS_START_ADDR) >> 7,
363 addr & AHCI_PORT_ADDR_OFFSET_MASK);
366 return val;
371 * AHCI 1.3 section 3 ("HBA Memory Registers")
372 * Support unaligned 8/16/32 bit reads, and 64 bit aligned reads.
373 * Caller is responsible for masking unwanted higher order bytes.
375 static uint64_t ahci_mem_read(void *opaque, hwaddr addr, unsigned size)
377 hwaddr aligned = addr & ~0x3;
378 int ofst = addr - aligned;
379 uint64_t lo = ahci_mem_read_32(opaque, aligned);
380 uint64_t hi;
381 uint64_t val;
383 /* if < 8 byte read does not cross 4 byte boundary */
384 if (ofst + size <= 4) {
385 val = lo >> (ofst * 8);
386 } else {
387 g_assert_cmpint(size, >, 1);
389 /* If the 64bit read is unaligned, we will produce undefined
390 * results. AHCI does not support unaligned 64bit reads. */
391 hi = ahci_mem_read_32(opaque, aligned + 4);
392 val = (hi << 32 | lo) >> (ofst * 8);
395 DPRINTF(-1, "addr=0x%" HWADDR_PRIx " val=0x%" PRIx64 ", size=%d\n",
396 addr, val, size);
397 return val;
401 static void ahci_mem_write(void *opaque, hwaddr addr,
402 uint64_t val, unsigned size)
404 AHCIState *s = opaque;
406 DPRINTF(-1, "addr=0x%" HWADDR_PRIx " val=0x%" PRIx64 ", size=%d\n",
407 addr, val, size);
409 /* Only aligned reads are allowed on AHCI */
410 if (addr & 3) {
411 fprintf(stderr, "ahci: Mis-aligned write to addr 0x"
412 TARGET_FMT_plx "\n", addr);
413 return;
416 if (addr < AHCI_GENERIC_HOST_CONTROL_REGS_MAX_ADDR) {
417 DPRINTF(-1, "(addr 0x%08X), val 0x%08"PRIX64"\n", (unsigned) addr, val);
419 switch (addr) {
420 case HOST_CAP: /* R/WO, RO */
421 /* FIXME handle R/WO */
422 break;
423 case HOST_CTL: /* R/W */
424 if (val & HOST_CTL_RESET) {
425 DPRINTF(-1, "HBA Reset\n");
426 ahci_reset(s);
427 } else {
428 s->control_regs.ghc = (val & 0x3) | HOST_CTL_AHCI_EN;
429 ahci_check_irq(s);
431 break;
432 case HOST_IRQ_STAT: /* R/WC, RO */
433 s->control_regs.irqstatus &= ~val;
434 ahci_check_irq(s);
435 break;
436 case HOST_PORTS_IMPL: /* R/WO, RO */
437 /* FIXME handle R/WO */
438 break;
439 case HOST_VERSION: /* RO */
440 /* FIXME report write? */
441 break;
442 default:
443 DPRINTF(-1, "write to unknown register 0x%x\n", (unsigned)addr);
445 } else if ((addr >= AHCI_PORT_REGS_START_ADDR) &&
446 (addr < (AHCI_PORT_REGS_START_ADDR +
447 (s->ports * AHCI_PORT_ADDR_OFFSET_LEN)))) {
448 ahci_port_write(s, (addr - AHCI_PORT_REGS_START_ADDR) >> 7,
449 addr & AHCI_PORT_ADDR_OFFSET_MASK, val);
454 static const MemoryRegionOps ahci_mem_ops = {
455 .read = ahci_mem_read,
456 .write = ahci_mem_write,
457 .endianness = DEVICE_LITTLE_ENDIAN,
460 static uint64_t ahci_idp_read(void *opaque, hwaddr addr,
461 unsigned size)
463 AHCIState *s = opaque;
465 if (addr == s->idp_offset) {
466 /* index register */
467 return s->idp_index;
468 } else if (addr == s->idp_offset + 4) {
469 /* data register - do memory read at location selected by index */
470 return ahci_mem_read(opaque, s->idp_index, size);
471 } else {
472 return 0;
476 static void ahci_idp_write(void *opaque, hwaddr addr,
477 uint64_t val, unsigned size)
479 AHCIState *s = opaque;
481 if (addr == s->idp_offset) {
482 /* index register - mask off reserved bits */
483 s->idp_index = (uint32_t)val & ((AHCI_MEM_BAR_SIZE - 1) & ~3);
484 } else if (addr == s->idp_offset + 4) {
485 /* data register - do memory write at location selected by index */
486 ahci_mem_write(opaque, s->idp_index, val, size);
490 static const MemoryRegionOps ahci_idp_ops = {
491 .read = ahci_idp_read,
492 .write = ahci_idp_write,
493 .endianness = DEVICE_LITTLE_ENDIAN,
497 static void ahci_reg_init(AHCIState *s)
499 int i;
501 s->control_regs.cap = (s->ports - 1) |
502 (AHCI_NUM_COMMAND_SLOTS << 8) |
503 (AHCI_SUPPORTED_SPEED_GEN1 << AHCI_SUPPORTED_SPEED) |
504 HOST_CAP_NCQ | HOST_CAP_AHCI;
506 s->control_regs.impl = (1 << s->ports) - 1;
508 s->control_regs.version = AHCI_VERSION_1_0;
510 for (i = 0; i < s->ports; i++) {
511 s->dev[i].port_state = STATE_RUN;
515 static void check_cmd(AHCIState *s, int port)
517 AHCIPortRegs *pr = &s->dev[port].port_regs;
518 uint8_t slot;
520 if ((pr->cmd & PORT_CMD_START) && pr->cmd_issue) {
521 for (slot = 0; (slot < 32) && pr->cmd_issue; slot++) {
522 if ((pr->cmd_issue & (1U << slot)) &&
523 !handle_cmd(s, port, slot)) {
524 pr->cmd_issue &= ~(1U << slot);
530 static void ahci_check_cmd_bh(void *opaque)
532 AHCIDevice *ad = opaque;
534 qemu_bh_delete(ad->check_bh);
535 ad->check_bh = NULL;
537 if ((ad->busy_slot != -1) &&
538 !(ad->port.ifs[0].status & (BUSY_STAT|DRQ_STAT))) {
539 /* no longer busy */
540 ad->port_regs.cmd_issue &= ~(1 << ad->busy_slot);
541 ad->busy_slot = -1;
544 check_cmd(ad->hba, ad->port_no);
547 static void ahci_init_d2h(AHCIDevice *ad)
549 IDEState *ide_state = &ad->port.ifs[0];
550 AHCIPortRegs *pr = &ad->port_regs;
552 if (ad->init_d2h_sent) {
553 return;
556 if (ahci_write_fis_d2h(ad)) {
557 ad->init_d2h_sent = true;
558 /* We're emulating receiving the first Reg H2D Fis from the device;
559 * Update the SIG register, but otherwise proceed as normal. */
560 pr->sig = ((uint32_t)ide_state->hcyl << 24) |
561 (ide_state->lcyl << 16) |
562 (ide_state->sector << 8) |
563 (ide_state->nsector & 0xFF);
567 static void ahci_set_signature(AHCIDevice *ad, uint32_t sig)
569 IDEState *s = &ad->port.ifs[0];
570 s->hcyl = sig >> 24 & 0xFF;
571 s->lcyl = sig >> 16 & 0xFF;
572 s->sector = sig >> 8 & 0xFF;
573 s->nsector = sig & 0xFF;
575 DPRINTF(ad->port_no, "set hcyl:lcyl:sect:nsect = 0x%08x\n", sig);
578 static void ahci_reset_port(AHCIState *s, int port)
580 AHCIDevice *d = &s->dev[port];
581 AHCIPortRegs *pr = &d->port_regs;
582 IDEState *ide_state = &d->port.ifs[0];
583 int i;
585 DPRINTF(port, "reset port\n");
587 ide_bus_reset(&d->port);
588 ide_state->ncq_queues = AHCI_MAX_CMDS;
590 pr->scr_stat = 0;
591 pr->scr_err = 0;
592 pr->scr_act = 0;
593 pr->tfdata = 0x7F;
594 pr->sig = 0xFFFFFFFF;
595 d->busy_slot = -1;
596 d->init_d2h_sent = false;
598 ide_state = &s->dev[port].port.ifs[0];
599 if (!ide_state->blk) {
600 return;
603 /* reset ncq queue */
604 for (i = 0; i < AHCI_MAX_CMDS; i++) {
605 NCQTransferState *ncq_tfs = &s->dev[port].ncq_tfs[i];
606 ncq_tfs->halt = false;
607 if (!ncq_tfs->used) {
608 continue;
611 if (ncq_tfs->aiocb) {
612 blk_aio_cancel(ncq_tfs->aiocb);
613 ncq_tfs->aiocb = NULL;
616 /* Maybe we just finished the request thanks to blk_aio_cancel() */
617 if (!ncq_tfs->used) {
618 continue;
621 qemu_sglist_destroy(&ncq_tfs->sglist);
622 ncq_tfs->used = 0;
625 s->dev[port].port_state = STATE_RUN;
626 if (ide_state->drive_kind == IDE_CD) {
627 ahci_set_signature(d, SATA_SIGNATURE_CDROM);\
628 ide_state->status = SEEK_STAT | WRERR_STAT | READY_STAT;
629 } else {
630 ahci_set_signature(d, SATA_SIGNATURE_DISK);
631 ide_state->status = SEEK_STAT | WRERR_STAT;
634 ide_state->error = 1;
635 ahci_init_d2h(d);
638 static void debug_print_fis(uint8_t *fis, int cmd_len)
640 #if DEBUG_AHCI
641 int i;
643 fprintf(stderr, "fis:");
644 for (i = 0; i < cmd_len; i++) {
645 if ((i & 0xf) == 0) {
646 fprintf(stderr, "\n%02x:",i);
648 fprintf(stderr, "%02x ",fis[i]);
650 fprintf(stderr, "\n");
651 #endif
654 static bool ahci_map_fis_address(AHCIDevice *ad)
656 AHCIPortRegs *pr = &ad->port_regs;
657 map_page(ad->hba->as, &ad->res_fis,
658 ((uint64_t)pr->fis_addr_hi << 32) | pr->fis_addr, 256);
659 return ad->res_fis != NULL;
662 static void ahci_unmap_fis_address(AHCIDevice *ad)
664 dma_memory_unmap(ad->hba->as, ad->res_fis, 256,
665 DMA_DIRECTION_FROM_DEVICE, 256);
666 ad->res_fis = NULL;
669 static bool ahci_map_clb_address(AHCIDevice *ad)
671 AHCIPortRegs *pr = &ad->port_regs;
672 ad->cur_cmd = NULL;
673 map_page(ad->hba->as, &ad->lst,
674 ((uint64_t)pr->lst_addr_hi << 32) | pr->lst_addr, 1024);
675 return ad->lst != NULL;
678 static void ahci_unmap_clb_address(AHCIDevice *ad)
680 dma_memory_unmap(ad->hba->as, ad->lst, 1024,
681 DMA_DIRECTION_FROM_DEVICE, 1024);
682 ad->lst = NULL;
685 static void ahci_write_fis_sdb(AHCIState *s, NCQTransferState *ncq_tfs)
687 AHCIDevice *ad = ncq_tfs->drive;
688 AHCIPortRegs *pr = &ad->port_regs;
689 IDEState *ide_state;
690 SDBFIS *sdb_fis;
692 if (!ad->res_fis ||
693 !(pr->cmd & PORT_CMD_FIS_RX)) {
694 return;
697 sdb_fis = (SDBFIS *)&ad->res_fis[RES_FIS_SDBFIS];
698 ide_state = &ad->port.ifs[0];
700 sdb_fis->type = SATA_FIS_TYPE_SDB;
701 /* Interrupt pending & Notification bit */
702 sdb_fis->flags = 0x40; /* Interrupt bit, always 1 for NCQ */
703 sdb_fis->status = ide_state->status & 0x77;
704 sdb_fis->error = ide_state->error;
705 /* update SAct field in SDB_FIS */
706 sdb_fis->payload = cpu_to_le32(ad->finished);
708 /* Update shadow registers (except BSY 0x80 and DRQ 0x08) */
709 pr->tfdata = (ad->port.ifs[0].error << 8) |
710 (ad->port.ifs[0].status & 0x77) |
711 (pr->tfdata & 0x88);
712 pr->scr_act &= ~ad->finished;
713 ad->finished = 0;
715 /* Trigger IRQ if interrupt bit is set (which currently, it always is) */
716 if (sdb_fis->flags & 0x40) {
717 ahci_trigger_irq(s, ad, PORT_IRQ_SDB_FIS);
721 static void ahci_write_fis_pio(AHCIDevice *ad, uint16_t len)
723 AHCIPortRegs *pr = &ad->port_regs;
724 uint8_t *pio_fis;
725 IDEState *s = &ad->port.ifs[0];
727 if (!ad->res_fis || !(pr->cmd & PORT_CMD_FIS_RX)) {
728 return;
731 pio_fis = &ad->res_fis[RES_FIS_PSFIS];
733 pio_fis[0] = SATA_FIS_TYPE_PIO_SETUP;
734 pio_fis[1] = (ad->hba->control_regs.irqstatus ? (1 << 6) : 0);
735 pio_fis[2] = s->status;
736 pio_fis[3] = s->error;
738 pio_fis[4] = s->sector;
739 pio_fis[5] = s->lcyl;
740 pio_fis[6] = s->hcyl;
741 pio_fis[7] = s->select;
742 pio_fis[8] = s->hob_sector;
743 pio_fis[9] = s->hob_lcyl;
744 pio_fis[10] = s->hob_hcyl;
745 pio_fis[11] = 0;
746 pio_fis[12] = s->nsector & 0xFF;
747 pio_fis[13] = (s->nsector >> 8) & 0xFF;
748 pio_fis[14] = 0;
749 pio_fis[15] = s->status;
750 pio_fis[16] = len & 255;
751 pio_fis[17] = len >> 8;
752 pio_fis[18] = 0;
753 pio_fis[19] = 0;
755 /* Update shadow registers: */
756 pr->tfdata = (ad->port.ifs[0].error << 8) |
757 ad->port.ifs[0].status;
759 if (pio_fis[2] & ERR_STAT) {
760 ahci_trigger_irq(ad->hba, ad, PORT_IRQ_TF_ERR);
763 ahci_trigger_irq(ad->hba, ad, PORT_IRQ_PIOS_FIS);
766 static bool ahci_write_fis_d2h(AHCIDevice *ad)
768 AHCIPortRegs *pr = &ad->port_regs;
769 uint8_t *d2h_fis;
770 int i;
771 IDEState *s = &ad->port.ifs[0];
773 if (!ad->res_fis || !(pr->cmd & PORT_CMD_FIS_RX)) {
774 return false;
777 d2h_fis = &ad->res_fis[RES_FIS_RFIS];
779 d2h_fis[0] = SATA_FIS_TYPE_REGISTER_D2H;
780 d2h_fis[1] = (ad->hba->control_regs.irqstatus ? (1 << 6) : 0);
781 d2h_fis[2] = s->status;
782 d2h_fis[3] = s->error;
784 d2h_fis[4] = s->sector;
785 d2h_fis[5] = s->lcyl;
786 d2h_fis[6] = s->hcyl;
787 d2h_fis[7] = s->select;
788 d2h_fis[8] = s->hob_sector;
789 d2h_fis[9] = s->hob_lcyl;
790 d2h_fis[10] = s->hob_hcyl;
791 d2h_fis[11] = 0;
792 d2h_fis[12] = s->nsector & 0xFF;
793 d2h_fis[13] = (s->nsector >> 8) & 0xFF;
794 for (i = 14; i < 20; i++) {
795 d2h_fis[i] = 0;
798 /* Update shadow registers: */
799 pr->tfdata = (ad->port.ifs[0].error << 8) |
800 ad->port.ifs[0].status;
802 if (d2h_fis[2] & ERR_STAT) {
803 ahci_trigger_irq(ad->hba, ad, PORT_IRQ_TF_ERR);
806 ahci_trigger_irq(ad->hba, ad, PORT_IRQ_D2H_REG_FIS);
807 return true;
810 static int prdt_tbl_entry_size(const AHCI_SG *tbl)
812 /* flags_size is zero-based */
813 return (le32_to_cpu(tbl->flags_size) & AHCI_PRDT_SIZE_MASK) + 1;
817 * Fetch entries in a guest-provided PRDT and convert it into a QEMU SGlist.
818 * @ad: The AHCIDevice for whom we are building the SGList.
819 * @sglist: The SGList target to add PRD entries to.
820 * @cmd: The AHCI Command Header that describes where the PRDT is.
821 * @limit: The remaining size of the S/ATA transaction, in bytes.
822 * @offset: The number of bytes already transferred, in bytes.
824 * The AHCI PRDT can describe up to 256GiB. S/ATA only support transactions of
825 * up to 32MiB as of ATA8-ACS3 rev 1b, assuming a 512 byte sector size. We stop
826 * building the sglist from the PRDT as soon as we hit @limit bytes,
827 * which is <= INT32_MAX/2GiB.
829 static int ahci_populate_sglist(AHCIDevice *ad, QEMUSGList *sglist,
830 AHCICmdHdr *cmd, int64_t limit, uint64_t offset)
832 uint16_t opts = le16_to_cpu(cmd->opts);
833 uint16_t prdtl = le16_to_cpu(cmd->prdtl);
834 uint64_t cfis_addr = le64_to_cpu(cmd->tbl_addr);
835 uint64_t prdt_addr = cfis_addr + 0x80;
836 dma_addr_t prdt_len = (prdtl * sizeof(AHCI_SG));
837 dma_addr_t real_prdt_len = prdt_len;
838 uint8_t *prdt;
839 int i;
840 int r = 0;
841 uint64_t sum = 0;
842 int off_idx = -1;
843 int64_t off_pos = -1;
844 int tbl_entry_size;
845 IDEBus *bus = &ad->port;
846 BusState *qbus = BUS(bus);
848 if (!prdtl) {
849 DPRINTF(ad->port_no, "no sg list given by guest: 0x%08x\n", opts);
850 return -1;
853 /* map PRDT */
854 if (!(prdt = dma_memory_map(ad->hba->as, prdt_addr, &prdt_len,
855 DMA_DIRECTION_TO_DEVICE))){
856 DPRINTF(ad->port_no, "map failed\n");
857 return -1;
860 if (prdt_len < real_prdt_len) {
861 DPRINTF(ad->port_no, "mapped less than expected\n");
862 r = -1;
863 goto out;
866 /* Get entries in the PRDT, init a qemu sglist accordingly */
867 if (prdtl > 0) {
868 AHCI_SG *tbl = (AHCI_SG *)prdt;
869 sum = 0;
870 for (i = 0; i < prdtl; i++) {
871 tbl_entry_size = prdt_tbl_entry_size(&tbl[i]);
872 if (offset < (sum + tbl_entry_size)) {
873 off_idx = i;
874 off_pos = offset - sum;
875 break;
877 sum += tbl_entry_size;
879 if ((off_idx == -1) || (off_pos < 0) || (off_pos > tbl_entry_size)) {
880 DPRINTF(ad->port_no, "%s: Incorrect offset! "
881 "off_idx: %d, off_pos: %"PRId64"\n",
882 __func__, off_idx, off_pos);
883 r = -1;
884 goto out;
887 qemu_sglist_init(sglist, qbus->parent, (prdtl - off_idx),
888 ad->hba->as);
889 qemu_sglist_add(sglist, le64_to_cpu(tbl[off_idx].addr) + off_pos,
890 MIN(prdt_tbl_entry_size(&tbl[off_idx]) - off_pos,
891 limit));
893 for (i = off_idx + 1; i < prdtl && sglist->size < limit; i++) {
894 qemu_sglist_add(sglist, le64_to_cpu(tbl[i].addr),
895 MIN(prdt_tbl_entry_size(&tbl[i]),
896 limit - sglist->size));
900 out:
901 dma_memory_unmap(ad->hba->as, prdt, prdt_len,
902 DMA_DIRECTION_TO_DEVICE, prdt_len);
903 return r;
906 static void ncq_err(NCQTransferState *ncq_tfs)
908 IDEState *ide_state = &ncq_tfs->drive->port.ifs[0];
910 ide_state->error = ABRT_ERR;
911 ide_state->status = READY_STAT | ERR_STAT;
912 ncq_tfs->drive->port_regs.scr_err |= (1 << ncq_tfs->tag);
915 static void ncq_finish(NCQTransferState *ncq_tfs)
917 /* If we didn't error out, set our finished bit. Errored commands
918 * do not get a bit set for the SDB FIS ACT register, nor do they
919 * clear the outstanding bit in scr_act (PxSACT). */
920 if (!(ncq_tfs->drive->port_regs.scr_err & (1 << ncq_tfs->tag))) {
921 ncq_tfs->drive->finished |= (1 << ncq_tfs->tag);
924 ahci_write_fis_sdb(ncq_tfs->drive->hba, ncq_tfs);
926 DPRINTF(ncq_tfs->drive->port_no, "NCQ transfer tag %d finished\n",
927 ncq_tfs->tag);
929 block_acct_done(blk_get_stats(ncq_tfs->drive->port.ifs[0].blk),
930 &ncq_tfs->acct);
931 qemu_sglist_destroy(&ncq_tfs->sglist);
932 ncq_tfs->used = 0;
935 static void ncq_cb(void *opaque, int ret)
937 NCQTransferState *ncq_tfs = (NCQTransferState *)opaque;
938 IDEState *ide_state = &ncq_tfs->drive->port.ifs[0];
940 if (ret == -ECANCELED) {
941 return;
944 if (ret < 0) {
945 bool is_read = ncq_tfs->cmd == READ_FPDMA_QUEUED;
946 BlockErrorAction action = blk_get_error_action(ide_state->blk,
947 is_read, -ret);
948 if (action == BLOCK_ERROR_ACTION_STOP) {
949 ncq_tfs->halt = true;
950 ide_state->bus->error_status = IDE_RETRY_HBA;
951 } else if (action == BLOCK_ERROR_ACTION_REPORT) {
952 ncq_err(ncq_tfs);
954 blk_error_action(ide_state->blk, action, is_read, -ret);
955 } else {
956 ide_state->status = READY_STAT | SEEK_STAT;
959 if (!ncq_tfs->halt) {
960 ncq_finish(ncq_tfs);
964 static int is_ncq(uint8_t ata_cmd)
966 /* Based on SATA 3.2 section 13.6.3.2 */
967 switch (ata_cmd) {
968 case READ_FPDMA_QUEUED:
969 case WRITE_FPDMA_QUEUED:
970 case NCQ_NON_DATA:
971 case RECEIVE_FPDMA_QUEUED:
972 case SEND_FPDMA_QUEUED:
973 return 1;
974 default:
975 return 0;
979 static void execute_ncq_command(NCQTransferState *ncq_tfs)
981 AHCIDevice *ad = ncq_tfs->drive;
982 IDEState *ide_state = &ad->port.ifs[0];
983 int port = ad->port_no;
985 g_assert(is_ncq(ncq_tfs->cmd));
986 ncq_tfs->halt = false;
988 switch (ncq_tfs->cmd) {
989 case READ_FPDMA_QUEUED:
990 DPRINTF(port, "NCQ reading %d sectors from LBA %"PRId64", tag %d\n",
991 ncq_tfs->sector_count, ncq_tfs->lba, ncq_tfs->tag);
993 DPRINTF(port, "tag %d aio read %"PRId64"\n",
994 ncq_tfs->tag, ncq_tfs->lba);
996 dma_acct_start(ide_state->blk, &ncq_tfs->acct,
997 &ncq_tfs->sglist, BLOCK_ACCT_READ);
998 ncq_tfs->aiocb = dma_blk_read(ide_state->blk, &ncq_tfs->sglist,
999 ncq_tfs->lba, ncq_cb, ncq_tfs);
1000 break;
1001 case WRITE_FPDMA_QUEUED:
1002 DPRINTF(port, "NCQ writing %d sectors to LBA %"PRId64", tag %d\n",
1003 ncq_tfs->sector_count, ncq_tfs->lba, ncq_tfs->tag);
1005 DPRINTF(port, "tag %d aio write %"PRId64"\n",
1006 ncq_tfs->tag, ncq_tfs->lba);
1008 dma_acct_start(ide_state->blk, &ncq_tfs->acct,
1009 &ncq_tfs->sglist, BLOCK_ACCT_WRITE);
1010 ncq_tfs->aiocb = dma_blk_write(ide_state->blk, &ncq_tfs->sglist,
1011 ncq_tfs->lba, ncq_cb, ncq_tfs);
1012 break;
1013 default:
1014 DPRINTF(port, "error: unsupported NCQ command (0x%02x) received\n",
1015 ncq_tfs->cmd);
1016 qemu_sglist_destroy(&ncq_tfs->sglist);
1017 ncq_err(ncq_tfs);
1022 static void process_ncq_command(AHCIState *s, int port, uint8_t *cmd_fis,
1023 uint8_t slot)
1025 AHCIDevice *ad = &s->dev[port];
1026 IDEState *ide_state = &ad->port.ifs[0];
1027 NCQFrame *ncq_fis = (NCQFrame*)cmd_fis;
1028 uint8_t tag = ncq_fis->tag >> 3;
1029 NCQTransferState *ncq_tfs = &ad->ncq_tfs[tag];
1030 size_t size;
1032 g_assert(is_ncq(ncq_fis->command));
1033 if (ncq_tfs->used) {
1034 /* error - already in use */
1035 fprintf(stderr, "%s: tag %d already used\n", __FUNCTION__, tag);
1036 return;
1039 ncq_tfs->used = 1;
1040 ncq_tfs->drive = ad;
1041 ncq_tfs->slot = slot;
1042 ncq_tfs->cmdh = &((AHCICmdHdr *)ad->lst)[slot];
1043 ncq_tfs->cmd = ncq_fis->command;
1044 ncq_tfs->lba = ((uint64_t)ncq_fis->lba5 << 40) |
1045 ((uint64_t)ncq_fis->lba4 << 32) |
1046 ((uint64_t)ncq_fis->lba3 << 24) |
1047 ((uint64_t)ncq_fis->lba2 << 16) |
1048 ((uint64_t)ncq_fis->lba1 << 8) |
1049 (uint64_t)ncq_fis->lba0;
1050 ncq_tfs->tag = tag;
1052 /* Sanity-check the NCQ packet */
1053 if (tag != slot) {
1054 DPRINTF(port, "Warn: NCQ slot (%d) did not match the given tag (%d)\n",
1055 slot, tag);
1058 if (ncq_fis->aux0 || ncq_fis->aux1 || ncq_fis->aux2 || ncq_fis->aux3) {
1059 DPRINTF(port, "Warn: Attempt to use NCQ auxiliary fields.\n");
1061 if (ncq_fis->prio || ncq_fis->icc) {
1062 DPRINTF(port, "Warn: Unsupported attempt to use PRIO/ICC fields\n");
1064 if (ncq_fis->fua & NCQ_FIS_FUA_MASK) {
1065 DPRINTF(port, "Warn: Unsupported attempt to use Force Unit Access\n");
1067 if (ncq_fis->tag & NCQ_FIS_RARC_MASK) {
1068 DPRINTF(port, "Warn: Unsupported attempt to use Rebuild Assist\n");
1071 ncq_tfs->sector_count = ((ncq_fis->sector_count_high << 8) |
1072 ncq_fis->sector_count_low);
1073 if (!ncq_tfs->sector_count) {
1074 ncq_tfs->sector_count = 0x10000;
1076 size = ncq_tfs->sector_count * 512;
1077 ahci_populate_sglist(ad, &ncq_tfs->sglist, ncq_tfs->cmdh, size, 0);
1079 if (ncq_tfs->sglist.size < size) {
1080 error_report("ahci: PRDT length for NCQ command (0x%zx) "
1081 "is smaller than the requested size (0x%zx)",
1082 ncq_tfs->sglist.size, size);
1083 qemu_sglist_destroy(&ncq_tfs->sglist);
1084 ncq_err(ncq_tfs);
1085 ahci_trigger_irq(ad->hba, ad, PORT_IRQ_OVERFLOW);
1086 return;
1087 } else if (ncq_tfs->sglist.size != size) {
1088 DPRINTF(port, "Warn: PRDTL (0x%zx)"
1089 " does not match requested size (0x%zx)",
1090 ncq_tfs->sglist.size, size);
1093 DPRINTF(port, "NCQ transfer LBA from %"PRId64" to %"PRId64", "
1094 "drive max %"PRId64"\n",
1095 ncq_tfs->lba, ncq_tfs->lba + ncq_tfs->sector_count - 1,
1096 ide_state->nb_sectors - 1);
1098 execute_ncq_command(ncq_tfs);
1101 static AHCICmdHdr *get_cmd_header(AHCIState *s, uint8_t port, uint8_t slot)
1103 if (port >= s->ports || slot >= AHCI_MAX_CMDS) {
1104 return NULL;
1107 return s->dev[port].lst ? &((AHCICmdHdr *)s->dev[port].lst)[slot] : NULL;
1110 static void handle_reg_h2d_fis(AHCIState *s, int port,
1111 uint8_t slot, uint8_t *cmd_fis)
1113 IDEState *ide_state = &s->dev[port].port.ifs[0];
1114 AHCICmdHdr *cmd = get_cmd_header(s, port, slot);
1115 uint16_t opts = le16_to_cpu(cmd->opts);
1117 if (cmd_fis[1] & 0x0F) {
1118 DPRINTF(port, "Port Multiplier not supported."
1119 " cmd_fis[0]=%02x cmd_fis[1]=%02x cmd_fis[2]=%02x\n",
1120 cmd_fis[0], cmd_fis[1], cmd_fis[2]);
1121 return;
1124 if (cmd_fis[1] & 0x70) {
1125 DPRINTF(port, "Reserved flags set in H2D Register FIS."
1126 " cmd_fis[0]=%02x cmd_fis[1]=%02x cmd_fis[2]=%02x\n",
1127 cmd_fis[0], cmd_fis[1], cmd_fis[2]);
1128 return;
1131 if (!(cmd_fis[1] & SATA_FIS_REG_H2D_UPDATE_COMMAND_REGISTER)) {
1132 switch (s->dev[port].port_state) {
1133 case STATE_RUN:
1134 if (cmd_fis[15] & ATA_SRST) {
1135 s->dev[port].port_state = STATE_RESET;
1137 break;
1138 case STATE_RESET:
1139 if (!(cmd_fis[15] & ATA_SRST)) {
1140 ahci_reset_port(s, port);
1142 break;
1144 return;
1147 /* Check for NCQ command */
1148 if (is_ncq(cmd_fis[2])) {
1149 process_ncq_command(s, port, cmd_fis, slot);
1150 return;
1153 /* Decompose the FIS:
1154 * AHCI does not interpret FIS packets, it only forwards them.
1155 * SATA 1.0 describes how to decode LBA28 and CHS FIS packets.
1156 * Later specifications, e.g, SATA 3.2, describe LBA48 FIS packets.
1158 * ATA4 describes sector number for LBA28/CHS commands.
1159 * ATA6 describes sector number for LBA48 commands.
1160 * ATA8 deprecates CHS fully, describing only LBA28/48.
1162 * We dutifully convert the FIS into IDE registers, and allow the
1163 * core layer to interpret them as needed. */
1164 ide_state->feature = cmd_fis[3];
1165 ide_state->sector = cmd_fis[4]; /* LBA 7:0 */
1166 ide_state->lcyl = cmd_fis[5]; /* LBA 15:8 */
1167 ide_state->hcyl = cmd_fis[6]; /* LBA 23:16 */
1168 ide_state->select = cmd_fis[7]; /* LBA 27:24 (LBA28) */
1169 ide_state->hob_sector = cmd_fis[8]; /* LBA 31:24 */
1170 ide_state->hob_lcyl = cmd_fis[9]; /* LBA 39:32 */
1171 ide_state->hob_hcyl = cmd_fis[10]; /* LBA 47:40 */
1172 ide_state->hob_feature = cmd_fis[11];
1173 ide_state->nsector = (int64_t)((cmd_fis[13] << 8) | cmd_fis[12]);
1174 /* 14, 16, 17, 18, 19: Reserved (SATA 1.0) */
1175 /* 15: Only valid when UPDATE_COMMAND not set. */
1177 /* Copy the ACMD field (ATAPI packet, if any) from the AHCI command
1178 * table to ide_state->io_buffer */
1179 if (opts & AHCI_CMD_ATAPI) {
1180 memcpy(ide_state->io_buffer, &cmd_fis[AHCI_COMMAND_TABLE_ACMD], 0x10);
1181 debug_print_fis(ide_state->io_buffer, 0x10);
1182 s->dev[port].done_atapi_packet = false;
1183 /* XXX send PIO setup FIS */
1186 ide_state->error = 0;
1188 /* Reset transferred byte counter */
1189 cmd->status = 0;
1191 /* We're ready to process the command in FIS byte 2. */
1192 ide_exec_cmd(&s->dev[port].port, cmd_fis[2]);
1195 static int handle_cmd(AHCIState *s, int port, uint8_t slot)
1197 IDEState *ide_state;
1198 uint64_t tbl_addr;
1199 AHCICmdHdr *cmd;
1200 uint8_t *cmd_fis;
1201 dma_addr_t cmd_len;
1203 if (s->dev[port].port.ifs[0].status & (BUSY_STAT|DRQ_STAT)) {
1204 /* Engine currently busy, try again later */
1205 DPRINTF(port, "engine busy\n");
1206 return -1;
1209 if (!s->dev[port].lst) {
1210 DPRINTF(port, "error: lst not given but cmd handled");
1211 return -1;
1213 cmd = get_cmd_header(s, port, slot);
1214 /* remember current slot handle for later */
1215 s->dev[port].cur_cmd = cmd;
1217 /* The device we are working for */
1218 ide_state = &s->dev[port].port.ifs[0];
1219 if (!ide_state->blk) {
1220 DPRINTF(port, "error: guest accessed unused port");
1221 return -1;
1224 tbl_addr = le64_to_cpu(cmd->tbl_addr);
1225 cmd_len = 0x80;
1226 cmd_fis = dma_memory_map(s->as, tbl_addr, &cmd_len,
1227 DMA_DIRECTION_FROM_DEVICE);
1228 if (!cmd_fis) {
1229 DPRINTF(port, "error: guest passed us an invalid cmd fis\n");
1230 return -1;
1231 } else if (cmd_len != 0x80) {
1232 ahci_trigger_irq(s, &s->dev[port], PORT_IRQ_HBUS_ERR);
1233 DPRINTF(port, "error: dma_memory_map failed: "
1234 "(len(%02"PRIx64") != 0x80)\n",
1235 cmd_len);
1236 goto out;
1238 debug_print_fis(cmd_fis, 0x80);
1240 switch (cmd_fis[0]) {
1241 case SATA_FIS_TYPE_REGISTER_H2D:
1242 handle_reg_h2d_fis(s, port, slot, cmd_fis);
1243 break;
1244 default:
1245 DPRINTF(port, "unknown command cmd_fis[0]=%02x cmd_fis[1]=%02x "
1246 "cmd_fis[2]=%02x\n", cmd_fis[0], cmd_fis[1],
1247 cmd_fis[2]);
1248 break;
1251 out:
1252 dma_memory_unmap(s->as, cmd_fis, cmd_len, DMA_DIRECTION_FROM_DEVICE,
1253 cmd_len);
1255 if (s->dev[port].port.ifs[0].status & (BUSY_STAT|DRQ_STAT)) {
1256 /* async command, complete later */
1257 s->dev[port].busy_slot = slot;
1258 return -1;
1261 /* done handling the command */
1262 return 0;
1265 /* DMA dev <-> ram */
1266 static void ahci_start_transfer(IDEDMA *dma)
1268 AHCIDevice *ad = DO_UPCAST(AHCIDevice, dma, dma);
1269 IDEState *s = &ad->port.ifs[0];
1270 uint32_t size = (uint32_t)(s->data_end - s->data_ptr);
1271 /* write == ram -> device */
1272 uint16_t opts = le16_to_cpu(ad->cur_cmd->opts);
1273 int is_write = opts & AHCI_CMD_WRITE;
1274 int is_atapi = opts & AHCI_CMD_ATAPI;
1275 int has_sglist = 0;
1277 if (is_atapi && !ad->done_atapi_packet) {
1278 /* already prepopulated iobuffer */
1279 ad->done_atapi_packet = true;
1280 size = 0;
1281 goto out;
1284 if (ahci_dma_prepare_buf(dma, size)) {
1285 has_sglist = 1;
1288 DPRINTF(ad->port_no, "%sing %d bytes on %s w/%s sglist\n",
1289 is_write ? "writ" : "read", size, is_atapi ? "atapi" : "ata",
1290 has_sglist ? "" : "o");
1292 if (has_sglist && size) {
1293 if (is_write) {
1294 dma_buf_write(s->data_ptr, size, &s->sg);
1295 } else {
1296 dma_buf_read(s->data_ptr, size, &s->sg);
1300 out:
1301 /* declare that we processed everything */
1302 s->data_ptr = s->data_end;
1304 /* Update number of transferred bytes, destroy sglist */
1305 dma_buf_commit(s, size);
1307 s->end_transfer_func(s);
1309 if (!(s->status & DRQ_STAT)) {
1310 /* done with PIO send/receive */
1311 ahci_write_fis_pio(ad, le32_to_cpu(ad->cur_cmd->status));
1315 static void ahci_start_dma(IDEDMA *dma, IDEState *s,
1316 BlockCompletionFunc *dma_cb)
1318 AHCIDevice *ad = DO_UPCAST(AHCIDevice, dma, dma);
1319 DPRINTF(ad->port_no, "\n");
1320 s->io_buffer_offset = 0;
1321 dma_cb(s, 0);
1324 static void ahci_restart_dma(IDEDMA *dma)
1326 /* Nothing to do, ahci_start_dma already resets s->io_buffer_offset. */
1330 * IDE/PIO restarts are handled by the core layer, but NCQ commands
1331 * need an extra kick from the AHCI HBA.
1333 static void ahci_restart(IDEDMA *dma)
1335 AHCIDevice *ad = DO_UPCAST(AHCIDevice, dma, dma);
1336 int i;
1338 for (i = 0; i < AHCI_MAX_CMDS; i++) {
1339 NCQTransferState *ncq_tfs = &ad->ncq_tfs[i];
1340 if (ncq_tfs->halt) {
1341 execute_ncq_command(ncq_tfs);
1347 * Called in DMA and PIO R/W chains to read the PRDT.
1348 * Not shared with NCQ pathways.
1350 static int32_t ahci_dma_prepare_buf(IDEDMA *dma, int32_t limit)
1352 AHCIDevice *ad = DO_UPCAST(AHCIDevice, dma, dma);
1353 IDEState *s = &ad->port.ifs[0];
1355 if (ahci_populate_sglist(ad, &s->sg, ad->cur_cmd,
1356 limit, s->io_buffer_offset) == -1) {
1357 DPRINTF(ad->port_no, "ahci_dma_prepare_buf failed.\n");
1358 return -1;
1360 s->io_buffer_size = s->sg.size;
1362 DPRINTF(ad->port_no, "len=%#x\n", s->io_buffer_size);
1363 return s->io_buffer_size;
1367 * Updates the command header with a bytes-read value.
1368 * Called via dma_buf_commit, for both DMA and PIO paths.
1369 * sglist destruction is handled within dma_buf_commit.
1371 static void ahci_commit_buf(IDEDMA *dma, uint32_t tx_bytes)
1373 AHCIDevice *ad = DO_UPCAST(AHCIDevice, dma, dma);
1375 tx_bytes += le32_to_cpu(ad->cur_cmd->status);
1376 ad->cur_cmd->status = cpu_to_le32(tx_bytes);
1379 static int ahci_dma_rw_buf(IDEDMA *dma, int is_write)
1381 AHCIDevice *ad = DO_UPCAST(AHCIDevice, dma, dma);
1382 IDEState *s = &ad->port.ifs[0];
1383 uint8_t *p = s->io_buffer + s->io_buffer_index;
1384 int l = s->io_buffer_size - s->io_buffer_index;
1386 if (ahci_populate_sglist(ad, &s->sg, ad->cur_cmd, l, s->io_buffer_offset)) {
1387 return 0;
1390 if (is_write) {
1391 dma_buf_read(p, l, &s->sg);
1392 } else {
1393 dma_buf_write(p, l, &s->sg);
1396 /* free sglist, update byte count */
1397 dma_buf_commit(s, l);
1399 s->io_buffer_index += l;
1401 DPRINTF(ad->port_no, "len=%#x\n", l);
1403 return 1;
1406 static void ahci_cmd_done(IDEDMA *dma)
1408 AHCIDevice *ad = DO_UPCAST(AHCIDevice, dma, dma);
1410 DPRINTF(ad->port_no, "cmd done\n");
1412 /* update d2h status */
1413 ahci_write_fis_d2h(ad);
1415 if (!ad->check_bh) {
1416 /* maybe we still have something to process, check later */
1417 ad->check_bh = qemu_bh_new(ahci_check_cmd_bh, ad);
1418 qemu_bh_schedule(ad->check_bh);
1422 static void ahci_irq_set(void *opaque, int n, int level)
1426 static const IDEDMAOps ahci_dma_ops = {
1427 .start_dma = ahci_start_dma,
1428 .restart = ahci_restart,
1429 .restart_dma = ahci_restart_dma,
1430 .start_transfer = ahci_start_transfer,
1431 .prepare_buf = ahci_dma_prepare_buf,
1432 .commit_buf = ahci_commit_buf,
1433 .rw_buf = ahci_dma_rw_buf,
1434 .cmd_done = ahci_cmd_done,
1437 void ahci_init(AHCIState *s, DeviceState *qdev, AddressSpace *as, int ports)
1439 qemu_irq *irqs;
1440 int i;
1442 s->as = as;
1443 s->ports = ports;
1444 s->dev = g_new0(AHCIDevice, ports);
1445 s->container = qdev;
1446 ahci_reg_init(s);
1447 /* XXX BAR size should be 1k, but that breaks, so bump it to 4k for now */
1448 memory_region_init_io(&s->mem, OBJECT(qdev), &ahci_mem_ops, s,
1449 "ahci", AHCI_MEM_BAR_SIZE);
1450 memory_region_init_io(&s->idp, OBJECT(qdev), &ahci_idp_ops, s,
1451 "ahci-idp", 32);
1453 irqs = qemu_allocate_irqs(ahci_irq_set, s, s->ports);
1455 for (i = 0; i < s->ports; i++) {
1456 AHCIDevice *ad = &s->dev[i];
1458 ide_bus_new(&ad->port, sizeof(ad->port), qdev, i, 1);
1459 ide_init2(&ad->port, irqs[i]);
1461 ad->hba = s;
1462 ad->port_no = i;
1463 ad->port.dma = &ad->dma;
1464 ad->port.dma->ops = &ahci_dma_ops;
1465 ide_register_restart_cb(&ad->port);
1469 void ahci_uninit(AHCIState *s)
1471 g_free(s->dev);
1474 void ahci_reset(AHCIState *s)
1476 AHCIPortRegs *pr;
1477 int i;
1479 s->control_regs.irqstatus = 0;
1480 /* AHCI Enable (AE)
1481 * The implementation of this bit is dependent upon the value of the
1482 * CAP.SAM bit. If CAP.SAM is '0', then GHC.AE shall be read-write and
1483 * shall have a reset value of '0'. If CAP.SAM is '1', then AE shall be
1484 * read-only and shall have a reset value of '1'.
1486 * We set HOST_CAP_AHCI so we must enable AHCI at reset.
1488 s->control_regs.ghc = HOST_CTL_AHCI_EN;
1490 for (i = 0; i < s->ports; i++) {
1491 pr = &s->dev[i].port_regs;
1492 pr->irq_stat = 0;
1493 pr->irq_mask = 0;
1494 pr->scr_ctl = 0;
1495 pr->cmd = PORT_CMD_SPIN_UP | PORT_CMD_POWER_ON;
1496 ahci_reset_port(s, i);
1500 static const VMStateDescription vmstate_ncq_tfs = {
1501 .name = "ncq state",
1502 .version_id = 1,
1503 .fields = (VMStateField[]) {
1504 VMSTATE_UINT32(sector_count, NCQTransferState),
1505 VMSTATE_UINT64(lba, NCQTransferState),
1506 VMSTATE_UINT8(tag, NCQTransferState),
1507 VMSTATE_UINT8(cmd, NCQTransferState),
1508 VMSTATE_UINT8(slot, NCQTransferState),
1509 VMSTATE_BOOL(used, NCQTransferState),
1510 VMSTATE_BOOL(halt, NCQTransferState),
1511 VMSTATE_END_OF_LIST()
1515 static const VMStateDescription vmstate_ahci_device = {
1516 .name = "ahci port",
1517 .version_id = 1,
1518 .fields = (VMStateField[]) {
1519 VMSTATE_IDE_BUS(port, AHCIDevice),
1520 VMSTATE_IDE_DRIVE(port.ifs[0], AHCIDevice),
1521 VMSTATE_UINT32(port_state, AHCIDevice),
1522 VMSTATE_UINT32(finished, AHCIDevice),
1523 VMSTATE_UINT32(port_regs.lst_addr, AHCIDevice),
1524 VMSTATE_UINT32(port_regs.lst_addr_hi, AHCIDevice),
1525 VMSTATE_UINT32(port_regs.fis_addr, AHCIDevice),
1526 VMSTATE_UINT32(port_regs.fis_addr_hi, AHCIDevice),
1527 VMSTATE_UINT32(port_regs.irq_stat, AHCIDevice),
1528 VMSTATE_UINT32(port_regs.irq_mask, AHCIDevice),
1529 VMSTATE_UINT32(port_regs.cmd, AHCIDevice),
1530 VMSTATE_UINT32(port_regs.tfdata, AHCIDevice),
1531 VMSTATE_UINT32(port_regs.sig, AHCIDevice),
1532 VMSTATE_UINT32(port_regs.scr_stat, AHCIDevice),
1533 VMSTATE_UINT32(port_regs.scr_ctl, AHCIDevice),
1534 VMSTATE_UINT32(port_regs.scr_err, AHCIDevice),
1535 VMSTATE_UINT32(port_regs.scr_act, AHCIDevice),
1536 VMSTATE_UINT32(port_regs.cmd_issue, AHCIDevice),
1537 VMSTATE_BOOL(done_atapi_packet, AHCIDevice),
1538 VMSTATE_INT32(busy_slot, AHCIDevice),
1539 VMSTATE_BOOL(init_d2h_sent, AHCIDevice),
1540 VMSTATE_STRUCT_ARRAY(ncq_tfs, AHCIDevice, AHCI_MAX_CMDS,
1541 1, vmstate_ncq_tfs, NCQTransferState),
1542 VMSTATE_END_OF_LIST()
1546 static int ahci_state_post_load(void *opaque, int version_id)
1548 int i, j;
1549 struct AHCIDevice *ad;
1550 NCQTransferState *ncq_tfs;
1551 AHCIState *s = opaque;
1553 for (i = 0; i < s->ports; i++) {
1554 ad = &s->dev[i];
1556 /* Only remap the CLB address if appropriate, disallowing a state
1557 * transition from 'on' to 'off' it should be consistent here. */
1558 if (ahci_cond_start_engines(ad, false) != 0) {
1559 return -1;
1562 for (j = 0; j < AHCI_MAX_CMDS; j++) {
1563 ncq_tfs = &ad->ncq_tfs[j];
1564 ncq_tfs->drive = ad;
1566 if (ncq_tfs->used != ncq_tfs->halt) {
1567 return -1;
1569 if (!ncq_tfs->halt) {
1570 continue;
1572 if (!is_ncq(ncq_tfs->cmd)) {
1573 return -1;
1575 if (ncq_tfs->slot != ncq_tfs->tag) {
1576 return -1;
1578 /* If ncq_tfs->halt is justly set, the engine should be engaged,
1579 * and the command list buffer should be mapped. */
1580 ncq_tfs->cmdh = get_cmd_header(s, i, ncq_tfs->slot);
1581 if (!ncq_tfs->cmdh) {
1582 return -1;
1584 ahci_populate_sglist(ncq_tfs->drive, &ncq_tfs->sglist,
1585 ncq_tfs->cmdh, ncq_tfs->sector_count * 512,
1587 if (ncq_tfs->sector_count != ncq_tfs->sglist.size >> 9) {
1588 return -1;
1594 * If an error is present, ad->busy_slot will be valid and not -1.
1595 * In this case, an operation is waiting to resume and will re-check
1596 * for additional AHCI commands to execute upon completion.
1598 * In the case where no error was present, busy_slot will be -1,
1599 * and we should check to see if there are additional commands waiting.
1601 if (ad->busy_slot == -1) {
1602 check_cmd(s, i);
1603 } else {
1604 /* We are in the middle of a command, and may need to access
1605 * the command header in guest memory again. */
1606 if (ad->busy_slot < 0 || ad->busy_slot >= AHCI_MAX_CMDS) {
1607 return -1;
1609 ad->cur_cmd = get_cmd_header(s, i, ad->busy_slot);
1613 return 0;
1616 const VMStateDescription vmstate_ahci = {
1617 .name = "ahci",
1618 .version_id = 1,
1619 .post_load = ahci_state_post_load,
1620 .fields = (VMStateField[]) {
1621 VMSTATE_STRUCT_VARRAY_POINTER_INT32(dev, AHCIState, ports,
1622 vmstate_ahci_device, AHCIDevice),
1623 VMSTATE_UINT32(control_regs.cap, AHCIState),
1624 VMSTATE_UINT32(control_regs.ghc, AHCIState),
1625 VMSTATE_UINT32(control_regs.irqstatus, AHCIState),
1626 VMSTATE_UINT32(control_regs.impl, AHCIState),
1627 VMSTATE_UINT32(control_regs.version, AHCIState),
1628 VMSTATE_UINT32(idp_index, AHCIState),
1629 VMSTATE_INT32_EQUAL(ports, AHCIState),
1630 VMSTATE_END_OF_LIST()
1634 static const VMStateDescription vmstate_sysbus_ahci = {
1635 .name = "sysbus-ahci",
1636 .fields = (VMStateField[]) {
1637 VMSTATE_AHCI(ahci, SysbusAHCIState),
1638 VMSTATE_END_OF_LIST()
1642 static void sysbus_ahci_reset(DeviceState *dev)
1644 SysbusAHCIState *s = SYSBUS_AHCI(dev);
1646 ahci_reset(&s->ahci);
1649 static void sysbus_ahci_realize(DeviceState *dev, Error **errp)
1651 SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
1652 SysbusAHCIState *s = SYSBUS_AHCI(dev);
1654 ahci_init(&s->ahci, dev, &address_space_memory, s->num_ports);
1656 sysbus_init_mmio(sbd, &s->ahci.mem);
1657 sysbus_init_irq(sbd, &s->ahci.irq);
1660 static Property sysbus_ahci_properties[] = {
1661 DEFINE_PROP_UINT32("num-ports", SysbusAHCIState, num_ports, 1),
1662 DEFINE_PROP_END_OF_LIST(),
1665 static void sysbus_ahci_class_init(ObjectClass *klass, void *data)
1667 DeviceClass *dc = DEVICE_CLASS(klass);
1669 dc->realize = sysbus_ahci_realize;
1670 dc->vmsd = &vmstate_sysbus_ahci;
1671 dc->props = sysbus_ahci_properties;
1672 dc->reset = sysbus_ahci_reset;
1673 set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
1676 static const TypeInfo sysbus_ahci_info = {
1677 .name = TYPE_SYSBUS_AHCI,
1678 .parent = TYPE_SYS_BUS_DEVICE,
1679 .instance_size = sizeof(SysbusAHCIState),
1680 .class_init = sysbus_ahci_class_init,
1683 static void sysbus_ahci_register_types(void)
1685 type_register_static(&sysbus_ahci_info);
1688 type_init(sysbus_ahci_register_types)
1690 void ahci_ide_create_devs(PCIDevice *dev, DriveInfo **hd)
1692 AHCIPCIState *d = ICH_AHCI(dev);
1693 AHCIState *ahci = &d->ahci;
1694 int i;
1696 for (i = 0; i < ahci->ports; i++) {
1697 if (hd[i] == NULL) {
1698 continue;
1700 ide_create_drive(&ahci->dev[i].port, 0, hd[i]);