2 * Copyright (c) 2013 Zhixiang Yu <zcore@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/linker_set.h>
36 #include <sys/ioctl.h>
39 #include <sys/endian.h>
51 #include <pthread_np.h>
59 #define MAX_PORTS 6 /* Intel ICH8 AHCI supports 6 ports */
61 #define PxSIG_ATA 0x00000101 /* ATA drive */
62 #define PxSIG_ATAPI 0xeb140101 /* ATAPI drive */
65 FIS_TYPE_REGH2D = 0x27, /* Register FIS - host to device */
66 FIS_TYPE_REGD2H = 0x34, /* Register FIS - device to host */
67 FIS_TYPE_DMAACT = 0x39, /* DMA activate FIS - device to host */
68 FIS_TYPE_DMASETUP = 0x41, /* DMA setup FIS - bidirectional */
69 FIS_TYPE_DATA = 0x46, /* Data FIS - bidirectional */
70 FIS_TYPE_BIST = 0x58, /* BIST activate FIS - bidirectional */
71 FIS_TYPE_PIOSETUP = 0x5F, /* PIO setup FIS - device to host */
72 FIS_TYPE_SETDEVBITS = 0xA1, /* Set dev bits FIS - device to host */
78 #define TEST_UNIT_READY 0x00
79 #define REQUEST_SENSE 0x03
81 #define START_STOP_UNIT 0x1B
82 #define PREVENT_ALLOW 0x1E
83 #define READ_CAPACITY 0x25
85 #define POSITION_TO_ELEMENT 0x2B
87 #define GET_EVENT_STATUS_NOTIFICATION 0x4A
88 #define MODE_SENSE_10 0x5A
93 * SCSI mode page codes
95 #define MODEPAGE_RW_ERROR_RECOVERY 0x01
96 #define MODEPAGE_CD_CAPABILITIES 0x2A
101 #define ATA_SF_ENAB_SATA_SF 0x10
102 #define ATA_SATA_SF_AN 0x05
103 #define ATA_SF_DIS_SATA_SF 0x90
110 #define DPRINTF(format, arg...) do{fprintf(dbg, format, ##arg);fflush(dbg);}while(0)
112 #define DPRINTF(format, arg...)
114 #define WPRINTF(format, arg...) printf(format, ##arg)
117 struct blockif_req io_req;
118 struct ahci_port *io_pr;
119 STAILQ_ENTRY(ahci_ioreq) io_flist;
120 TAILQ_ENTRY(ahci_ioreq) io_blist;
129 struct blockif_ctxt *bctx;
130 struct pci_ahci_softc *pr_sc;
162 struct ahci_ioreq *ioreq;
164 STAILQ_HEAD(ahci_fhead, ahci_ioreq) iofhd;
165 TAILQ_HEAD(ahci_bhead, ahci_ioreq) iobhd;
168 struct ahci_cmd_hdr {
173 uint32_t reserved[4];
176 struct ahci_prdt_entry {
179 #define DBCMASK 0x3fffff
183 struct pci_ahci_softc {
184 struct pci_devinst *asc_pi;
199 struct ahci_port port[MAX_PORTS];
201 #define ahci_ctx(sc) ((sc)->asc_pi->pi_vmctx)
203 static inline void lba_to_msf(uint8_t *buf, int lba)
206 buf[0] = (lba / 75) / 60;
207 buf[1] = (lba / 75) % 60;
212 * generate HBA intr depending on whether or not ports within
213 * the controller have an interrupt pending.
216 ahci_generate_intr(struct pci_ahci_softc *sc)
218 struct pci_devinst *pi;
223 for (i = 0; i < sc->ports; i++) {
224 struct ahci_port *pr;
230 DPRINTF("%s %x\n", __func__, sc->is);
232 if (sc->is && (sc->ghc & AHCI_GHC_IE)) {
233 if (pci_msi_enabled(pi)) {
235 * Generate an MSI interrupt on every edge
237 pci_generate_msi(pi, 0);
238 } else if (!sc->lintr) {
240 * Only generate a pin-based interrupt if one wasn't
244 pci_lintr_assert(pi);
246 } else if (sc->lintr) {
248 * No interrupts: deassert pin-based signal if it had
251 pci_lintr_deassert(pi);
257 ahci_write_fis(struct ahci_port *p, enum sata_fis_type ft, uint8_t *fis)
259 int offset, len, irq;
261 if (p->rfis == NULL || !(p->cmd & AHCI_P_CMD_FRE))
265 case FIS_TYPE_REGD2H:
270 case FIS_TYPE_SETDEVBITS:
275 case FIS_TYPE_PIOSETUP:
281 WPRINTF("unsupported fis type %d\n", ft);
284 memcpy(p->rfis + offset, fis, len);
287 ahci_generate_intr(p->pr_sc);
292 ahci_write_fis_piosetup(struct ahci_port *p)
296 memset(fis, 0, sizeof(fis));
297 fis[0] = FIS_TYPE_PIOSETUP;
298 ahci_write_fis(p, FIS_TYPE_PIOSETUP, fis);
302 ahci_write_fis_sdb(struct ahci_port *p, int slot, uint32_t tfd)
307 error = (tfd >> 8) & 0xff;
308 memset(fis, 0, sizeof(fis));
311 *(uint32_t *)(fis + 4) = (1 << slot);
312 if (fis[2] & ATA_S_ERROR)
313 p->is |= AHCI_P_IX_TFE;
315 ahci_write_fis(p, FIS_TYPE_SETDEVBITS, fis);
319 ahci_write_fis_d2h(struct ahci_port *p, int slot, uint8_t *cfis, uint32_t tfd)
324 error = (tfd >> 8) & 0xff;
325 memset(fis, 0, sizeof(fis));
326 fis[0] = FIS_TYPE_REGD2H;
340 if (fis[2] & ATA_S_ERROR)
341 p->is |= AHCI_P_IX_TFE;
343 p->ci &= ~(1 << slot);
345 ahci_write_fis(p, FIS_TYPE_REGD2H, fis);
349 ahci_write_reset_fis_d2h(struct ahci_port *p)
353 memset(fis, 0, sizeof(fis));
354 fis[0] = FIS_TYPE_REGD2H;
362 ahci_write_fis(p, FIS_TYPE_REGD2H, fis);
366 ahci_check_stopped(struct ahci_port *p)
369 * If we are no longer processing the command list and nothing
370 * is in-flight, clear the running bit, the current command
371 * slot, the command issue and active bits.
373 if (!(p->cmd & AHCI_P_CMD_ST)) {
374 if (p->pending == 0) {
375 p->cmd &= ~(AHCI_P_CMD_CR | AHCI_P_CMD_CCS_MASK);
383 ahci_port_stop(struct ahci_port *p)
385 struct ahci_ioreq *aior;
391 assert(pthread_mutex_isowned_np(&p->pr_sc->mtx));
393 TAILQ_FOREACH(aior, &p->iobhd, io_blist) {
395 * Try to cancel the outstanding blockif request.
397 error = blockif_cancel(p->bctx, &aior->io_req);
403 if (cfis[2] == ATA_WRITE_FPDMA_QUEUED ||
404 cfis[2] == ATA_READ_FPDMA_QUEUED)
408 p->sact &= ~(1 << slot);
410 p->ci &= ~(1 << slot);
413 * This command is now done.
415 p->pending &= ~(1 << slot);
418 * Delete the blockif request from the busy list
420 TAILQ_REMOVE(&p->iobhd, aior, io_blist);
423 * Move the blockif request back to the free list
425 STAILQ_INSERT_TAIL(&p->iofhd, aior, io_flist);
428 ahci_check_stopped(p);
432 ahci_port_reset(struct ahci_port *pr)
437 pr->xfermode = ATA_UDMA6;
438 pr->mult_sectors = 128;
441 pr->ssts = ATA_SS_DET_NO_DEVICE;
442 pr->sig = 0xFFFFFFFF;
446 pr->ssts = ATA_SS_DET_PHY_ONLINE | ATA_SS_SPD_GEN2 |
448 pr->tfd = (1 << 8) | ATA_S_DSC | ATA_S_DMA;
451 pr->tfd |= ATA_S_READY;
453 pr->sig = PxSIG_ATAPI;
454 ahci_write_reset_fis_d2h(pr);
458 ahci_reset(struct pci_ahci_softc *sc)
462 sc->ghc = AHCI_GHC_AE;
466 pci_lintr_deassert(sc->asc_pi);
470 for (i = 0; i < sc->ports; i++) {
473 ahci_port_reset(&sc->port[i]);
478 ata_string(uint8_t *dest, const char *src, int len)
482 for (i = 0; i < len; i++) {
484 dest[i ^ 1] = *src++;
491 atapi_string(uint8_t *dest, const char *src, int len)
495 for (i = 0; i < len; i++) {
504 ahci_handle_dma(struct ahci_port *p, int slot, uint8_t *cfis, uint32_t done,
507 struct ahci_ioreq *aior;
508 struct blockif_req *breq;
509 struct pci_ahci_softc *sc;
510 struct ahci_prdt_entry *prdt;
511 struct ahci_cmd_hdr *hdr;
514 int i, err, iovcnt, ncq, readop;
517 prdt = (struct ahci_prdt_entry *)(cfis + 0x80);
518 hdr = (struct ahci_cmd_hdr *)(p->cmd_lst + slot * AHCI_CL_SIZE);
523 if (cfis[2] == ATA_WRITE_DMA || cfis[2] == ATA_WRITE_DMA48 ||
524 cfis[2] == ATA_WRITE_FPDMA_QUEUED)
527 if (cfis[2] == ATA_WRITE_FPDMA_QUEUED ||
528 cfis[2] == ATA_READ_FPDMA_QUEUED) {
529 lba = ((uint64_t)cfis[10] << 40) |
530 ((uint64_t)cfis[9] << 32) |
531 ((uint64_t)cfis[8] << 24) |
532 ((uint64_t)cfis[6] << 16) |
533 ((uint64_t)cfis[5] << 8) |
535 len = cfis[11] << 8 | cfis[3];
539 } else if (cfis[2] == ATA_READ_DMA48 || cfis[2] == ATA_WRITE_DMA48) {
540 lba = ((uint64_t)cfis[10] << 40) |
541 ((uint64_t)cfis[9] << 32) |
542 ((uint64_t)cfis[8] << 24) |
543 ((uint64_t)cfis[6] << 16) |
544 ((uint64_t)cfis[5] << 8) |
546 len = cfis[13] << 8 | cfis[12];
550 lba = ((cfis[7] & 0xf) << 24) | (cfis[6] << 16) |
551 (cfis[5] << 8) | cfis[4];
556 lba *= blockif_sectsz(p->bctx);
557 len *= blockif_sectsz(p->bctx);
560 * Pull request off free list
562 aior = STAILQ_FIRST(&p->iofhd);
563 assert(aior != NULL);
564 STAILQ_REMOVE_HEAD(&p->iofhd, io_flist);
569 breq = &aior->io_req;
570 breq->br_offset = lba + done;
571 iovcnt = hdr->prdtl - seek;
572 if (iovcnt > BLOCKIF_IOV_MAX) {
573 aior->prdtl = iovcnt - BLOCKIF_IOV_MAX;
574 iovcnt = BLOCKIF_IOV_MAX;
577 breq->br_iovcnt = iovcnt;
580 * Mark this command in-flight.
582 p->pending |= 1 << slot;
585 * Stuff request onto busy list
587 TAILQ_INSERT_HEAD(&p->iobhd, aior, io_blist);
590 * Build up the iovec based on the prdt
592 for (i = 0; i < iovcnt; i++) {
595 dbcsz = (prdt->dbc & DBCMASK) + 1;
596 breq->br_iov[i].iov_base = paddr_guest2host(ahci_ctx(sc),
598 breq->br_iov[i].iov_len = dbcsz;
603 err = blockif_read(p->bctx, breq);
605 err = blockif_write(p->bctx, breq);
609 p->ci &= ~(1 << slot);
613 ahci_handle_flush(struct ahci_port *p, int slot, uint8_t *cfis)
615 struct ahci_ioreq *aior;
616 struct blockif_req *breq;
620 * Pull request off free list
622 aior = STAILQ_FIRST(&p->iofhd);
623 assert(aior != NULL);
624 STAILQ_REMOVE_HEAD(&p->iofhd, io_flist);
630 breq = &aior->io_req;
633 * Mark this command in-flight.
635 p->pending |= 1 << slot;
638 * Stuff request onto busy list
640 TAILQ_INSERT_HEAD(&p->iobhd, aior, io_blist);
642 err = blockif_flush(p->bctx, breq);
647 write_prdt(struct ahci_port *p, int slot, uint8_t *cfis,
650 struct ahci_cmd_hdr *hdr;
651 struct ahci_prdt_entry *prdt;
655 hdr = (struct ahci_cmd_hdr *)(p->cmd_lst + slot * AHCI_CL_SIZE);
658 prdt = (struct ahci_prdt_entry *)(cfis + 0x80);
659 for (i = 0; i < hdr->prdtl && len; i++) {
664 dbcsz = (prdt->dbc & DBCMASK) + 1;
665 ptr = paddr_guest2host(ahci_ctx(p->pr_sc), prdt->dba, dbcsz);
666 sublen = len < dbcsz ? len : dbcsz;
667 memcpy(ptr, from, sublen);
672 hdr->prdbc = size - len;
676 handle_identify(struct ahci_port *p, int slot, uint8_t *cfis)
678 struct ahci_cmd_hdr *hdr;
680 hdr = (struct ahci_cmd_hdr *)(p->cmd_lst + slot * AHCI_CL_SIZE);
681 if (p->atapi || hdr->prdtl == 0) {
682 p->tfd = (ATA_E_ABORT << 8) | ATA_S_READY | ATA_S_ERROR;
683 p->is |= AHCI_P_IX_TFE;
690 sectors = blockif_size(p->bctx) / blockif_sectsz(p->bctx);
691 blockif_chs(p->bctx, &cyl, &heads, &sech);
692 memset(buf, 0, sizeof(buf));
697 /* TODO emulate different serial? */
698 ata_string((uint8_t *)(buf+10), "123456", 20);
699 ata_string((uint8_t *)(buf+23), "001", 8);
700 ata_string((uint8_t *)(buf+27), "BHYVE SATA DISK", 40);
701 buf[47] = (0x8000 | 128);
703 buf[49] = (1 << 8 | 1 << 9 | 1 << 11);
705 buf[53] = (1 << 1 | 1 << 2);
707 buf[59] = (0x100 | p->mult_sectors);
709 buf[61] = (sectors >> 16);
711 if (p->xfermode & ATA_WDMA0)
712 buf[63] |= (1 << ((p->xfermode & 7) + 8));
719 buf[76] = (1 << 8 | 1 << 2);
722 buf[82] = (1 << 5 | 1 << 14);
723 buf[83] = (1 << 10 | 1 << 12 | 1 << 13 | 1 << 14);
725 buf[85] = (1 << 5 | 1 << 14);
726 buf[86] = (1 << 10 | 1 << 12 | 1 << 13);
729 if (p->xfermode & ATA_UDMA0)
730 buf[88] |= (1 << ((p->xfermode & 7) + 8));
731 buf[93] = (1 | 1 <<14);
733 buf[101] = (sectors >> 16);
734 buf[102] = (sectors >> 32);
735 buf[103] = (sectors >> 48);
736 ahci_write_fis_piosetup(p);
737 write_prdt(p, slot, cfis, (void *)buf, sizeof(buf));
738 p->tfd = ATA_S_DSC | ATA_S_READY;
739 p->is |= AHCI_P_IX_DP;
740 p->ci &= ~(1 << slot);
742 ahci_generate_intr(p->pr_sc);
746 handle_atapi_identify(struct ahci_port *p, int slot, uint8_t *cfis)
749 p->tfd = (ATA_E_ABORT << 8) | ATA_S_READY | ATA_S_ERROR;
750 p->is |= AHCI_P_IX_TFE;
754 memset(buf, 0, sizeof(buf));
755 buf[0] = (2 << 14 | 5 << 8 | 1 << 7 | 2 << 5);
756 /* TODO emulate different serial? */
757 ata_string((uint8_t *)(buf+10), "123456", 20);
758 ata_string((uint8_t *)(buf+23), "001", 8);
759 ata_string((uint8_t *)(buf+27), "BHYVE SATA DVD ROM", 40);
760 buf[49] = (1 << 9 | 1 << 8);
761 buf[50] = (1 << 14 | 1);
762 buf[53] = (1 << 2 | 1 << 1);
770 buf[76] = (1 << 2 | 1 << 1);
772 buf[80] = (0x1f << 4);
778 buf[88] = (1 << 14 | 0x7f);
779 ahci_write_fis_piosetup(p);
780 write_prdt(p, slot, cfis, (void *)buf, sizeof(buf));
781 p->tfd = ATA_S_DSC | ATA_S_READY;
782 p->is |= AHCI_P_IX_DHR;
783 p->ci &= ~(1 << slot);
785 ahci_generate_intr(p->pr_sc);
789 atapi_inquiry(struct ahci_port *p, int slot, uint8_t *cfis)
805 atapi_string(buf + 8, "BHYVE", 8);
806 atapi_string(buf + 16, "BHYVE DVD-ROM", 16);
807 atapi_string(buf + 32, "001", 4);
812 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
813 write_prdt(p, slot, cfis, buf, len);
814 ahci_write_fis_d2h(p, slot, cfis, ATA_S_READY | ATA_S_DSC);
818 atapi_read_capacity(struct ahci_port *p, int slot, uint8_t *cfis)
823 sectors = blockif_size(p->bctx) / 2048;
824 be32enc(buf, sectors - 1);
825 be32enc(buf + 4, 2048);
826 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
827 write_prdt(p, slot, cfis, buf, sizeof(buf));
828 ahci_write_fis_d2h(p, slot, cfis, ATA_S_READY | ATA_S_DSC);
832 atapi_read_toc(struct ahci_port *p, int slot, uint8_t *cfis)
840 len = be16dec(acmd + 7);
841 format = acmd[9] >> 6;
847 uint8_t start_track, buf[20], *bp;
849 msf = (acmd[1] >> 1) & 1;
850 start_track = acmd[6];
851 if (start_track > 1 && start_track != 0xaa) {
853 p->sense_key = ATA_SENSE_ILLEGAL_REQUEST;
855 tfd = (p->sense_key << 12) | ATA_S_READY | ATA_S_ERROR;
856 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
857 ahci_write_fis_d2h(p, slot, cfis, tfd);
863 if (start_track <= 1) {
883 sectors = blockif_size(p->bctx) / blockif_sectsz(p->bctx);
887 lba_to_msf(bp, sectors);
890 be32enc(bp, sectors);
894 be16enc(buf, size - 2);
897 write_prdt(p, slot, cfis, buf, len);
898 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
899 ahci_write_fis_d2h(p, slot, cfis, ATA_S_READY | ATA_S_DSC);
906 memset(buf, 0, sizeof(buf));
910 if (len > sizeof(buf))
912 write_prdt(p, slot, cfis, buf, len);
913 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
914 ahci_write_fis_d2h(p, slot, cfis, ATA_S_READY | ATA_S_DSC);
921 uint8_t start_track, *bp, buf[50];
923 msf = (acmd[1] >> 1) & 1;
924 start_track = acmd[6];
960 sectors = blockif_size(p->bctx) / blockif_sectsz(p->bctx);
964 lba_to_msf(bp, sectors);
967 be32enc(bp, sectors);
990 be16enc(buf, size - 2);
993 write_prdt(p, slot, cfis, buf, len);
994 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
995 ahci_write_fis_d2h(p, slot, cfis, ATA_S_READY | ATA_S_DSC);
1002 p->sense_key = ATA_SENSE_ILLEGAL_REQUEST;
1004 tfd = (p->sense_key << 12) | ATA_S_READY | ATA_S_ERROR;
1005 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
1006 ahci_write_fis_d2h(p, slot, cfis, tfd);
1013 atapi_read(struct ahci_port *p, int slot, uint8_t *cfis,
1014 uint32_t done, int seek)
1016 struct ahci_ioreq *aior;
1017 struct ahci_cmd_hdr *hdr;
1018 struct ahci_prdt_entry *prdt;
1019 struct blockif_req *breq;
1020 struct pci_ahci_softc *sc;
1028 hdr = (struct ahci_cmd_hdr *)(p->cmd_lst + slot * AHCI_CL_SIZE);
1029 prdt = (struct ahci_prdt_entry *)(cfis + 0x80);
1032 lba = be32dec(acmd + 2);
1033 if (acmd[0] == READ_10)
1034 len = be16dec(acmd + 7);
1036 len = be32dec(acmd + 6);
1038 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
1039 ahci_write_fis_d2h(p, slot, cfis, ATA_S_READY | ATA_S_DSC);
1045 * Pull request off free list
1047 aior = STAILQ_FIRST(&p->iofhd);
1048 assert(aior != NULL);
1049 STAILQ_REMOVE_HEAD(&p->iofhd, io_flist);
1054 breq = &aior->io_req;
1055 breq->br_offset = lba + done;
1056 iovcnt = hdr->prdtl - seek;
1057 if (iovcnt > BLOCKIF_IOV_MAX) {
1058 aior->prdtl = iovcnt - BLOCKIF_IOV_MAX;
1059 iovcnt = BLOCKIF_IOV_MAX;
1062 breq->br_iovcnt = iovcnt;
1065 * Mark this command in-flight.
1067 p->pending |= 1 << slot;
1070 * Stuff request onto busy list
1072 TAILQ_INSERT_HEAD(&p->iobhd, aior, io_blist);
1075 * Build up the iovec based on the prdt
1077 for (i = 0; i < iovcnt; i++) {
1080 dbcsz = (prdt->dbc & DBCMASK) + 1;
1081 breq->br_iov[i].iov_base = paddr_guest2host(ahci_ctx(sc),
1083 breq->br_iov[i].iov_len = dbcsz;
1084 aior->done += dbcsz;
1087 err = blockif_read(p->bctx, breq);
1092 atapi_request_sense(struct ahci_port *p, int slot, uint8_t *cfis)
1100 if (len > sizeof(buf))
1102 memset(buf, 0, len);
1103 buf[0] = 0x70 | (1 << 7);
1104 buf[2] = p->sense_key;
1107 write_prdt(p, slot, cfis, buf, len);
1108 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
1109 ahci_write_fis_d2h(p, slot, cfis, ATA_S_READY | ATA_S_DSC);
1113 atapi_start_stop_unit(struct ahci_port *p, int slot, uint8_t *cfis)
1115 uint8_t *acmd = cfis + 0x40;
1118 switch (acmd[4] & 3) {
1122 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
1123 tfd = ATA_S_READY | ATA_S_DSC;
1126 /* TODO eject media */
1127 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
1128 p->sense_key = ATA_SENSE_ILLEGAL_REQUEST;
1130 tfd = (p->sense_key << 12) | ATA_S_READY | ATA_S_ERROR;
1133 ahci_write_fis_d2h(p, slot, cfis, tfd);
1137 atapi_mode_sense(struct ahci_port *p, int slot, uint8_t *cfis)
1145 len = be16dec(acmd + 7);
1147 code = acmd[2] & 0x3f;
1152 case MODEPAGE_RW_ERROR_RECOVERY:
1156 if (len > sizeof(buf))
1159 memset(buf, 0, sizeof(buf));
1160 be16enc(buf, 16 - 2);
1165 write_prdt(p, slot, cfis, buf, len);
1166 tfd = ATA_S_READY | ATA_S_DSC;
1169 case MODEPAGE_CD_CAPABILITIES:
1173 if (len > sizeof(buf))
1176 memset(buf, 0, sizeof(buf));
1177 be16enc(buf, 30 - 2);
1183 be16enc(&buf[18], 2);
1184 be16enc(&buf[20], 512);
1185 write_prdt(p, slot, cfis, buf, len);
1186 tfd = ATA_S_READY | ATA_S_DSC;
1195 p->sense_key = ATA_SENSE_ILLEGAL_REQUEST;
1197 tfd = (p->sense_key << 12) | ATA_S_READY | ATA_S_ERROR;
1202 p->sense_key = ATA_SENSE_ILLEGAL_REQUEST;
1204 tfd = (p->sense_key << 12) | ATA_S_READY | ATA_S_ERROR;
1207 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
1208 ahci_write_fis_d2h(p, slot, cfis, tfd);
1212 atapi_get_event_status_notification(struct ahci_port *p, int slot,
1220 /* we don't support asynchronous operation */
1221 if (!(acmd[1] & 1)) {
1222 p->sense_key = ATA_SENSE_ILLEGAL_REQUEST;
1224 tfd = (p->sense_key << 12) | ATA_S_READY | ATA_S_ERROR;
1229 len = be16dec(acmd + 7);
1230 if (len > sizeof(buf))
1233 memset(buf, 0, sizeof(buf));
1234 be16enc(buf, 8 - 2);
1238 write_prdt(p, slot, cfis, buf, len);
1239 tfd = ATA_S_READY | ATA_S_DSC;
1241 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
1242 ahci_write_fis_d2h(p, slot, cfis, tfd);
1246 handle_packet_cmd(struct ahci_port *p, int slot, uint8_t *cfis)
1256 for (i = 0; i < 16; i++)
1257 DPRINTF("%02x ", acmd[i]);
1263 case TEST_UNIT_READY:
1264 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
1265 ahci_write_fis_d2h(p, slot, cfis, ATA_S_READY | ATA_S_DSC);
1268 atapi_inquiry(p, slot, cfis);
1271 atapi_read_capacity(p, slot, cfis);
1275 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
1276 ahci_write_fis_d2h(p, slot, cfis, ATA_S_READY | ATA_S_DSC);
1279 atapi_read_toc(p, slot, cfis);
1283 atapi_read(p, slot, cfis, 0, 0);
1286 atapi_request_sense(p, slot, cfis);
1288 case START_STOP_UNIT:
1289 atapi_start_stop_unit(p, slot, cfis);
1292 atapi_mode_sense(p, slot, cfis);
1294 case GET_EVENT_STATUS_NOTIFICATION:
1295 atapi_get_event_status_notification(p, slot, cfis);
1298 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
1299 p->sense_key = ATA_SENSE_ILLEGAL_REQUEST;
1301 ahci_write_fis_d2h(p, slot, cfis, (p->sense_key << 12) |
1302 ATA_S_READY | ATA_S_ERROR);
1308 ahci_handle_cmd(struct ahci_port *p, int slot, uint8_t *cfis)
1312 case ATA_ATA_IDENTIFY:
1313 handle_identify(p, slot, cfis);
1315 case ATA_SETFEATURES:
1318 case ATA_SF_ENAB_SATA_SF:
1320 case ATA_SATA_SF_AN:
1321 p->tfd = ATA_S_DSC | ATA_S_READY;
1324 p->tfd = ATA_S_ERROR | ATA_S_READY;
1325 p->tfd |= (ATA_ERROR_ABORT << 8);
1329 case ATA_SF_ENAB_WCACHE:
1330 case ATA_SF_DIS_WCACHE:
1331 case ATA_SF_ENAB_RCACHE:
1332 case ATA_SF_DIS_RCACHE:
1333 p->tfd = ATA_S_DSC | ATA_S_READY;
1335 case ATA_SF_SETXFER:
1337 switch (cfis[12] & 0xf8) {
1343 p->xfermode = (cfis[12] & 0x7);
1346 p->tfd = ATA_S_DSC | ATA_S_READY;
1350 p->tfd = ATA_S_ERROR | ATA_S_READY;
1351 p->tfd |= (ATA_ERROR_ABORT << 8);
1354 ahci_write_fis_d2h(p, slot, cfis, p->tfd);
1358 if (cfis[12] != 0 &&
1359 (cfis[12] > 128 || (cfis[12] & (cfis[12] - 1)))) {
1360 p->tfd = ATA_S_ERROR | ATA_S_READY;
1361 p->tfd |= (ATA_ERROR_ABORT << 8);
1363 p->mult_sectors = cfis[12];
1364 p->tfd = ATA_S_DSC | ATA_S_READY;
1366 p->is |= AHCI_P_IX_DP;
1367 p->ci &= ~(1 << slot);
1368 ahci_generate_intr(p->pr_sc);
1372 case ATA_READ_DMA48:
1373 case ATA_WRITE_DMA48:
1374 case ATA_READ_FPDMA_QUEUED:
1375 case ATA_WRITE_FPDMA_QUEUED:
1376 ahci_handle_dma(p, slot, cfis, 0, 0);
1378 case ATA_FLUSHCACHE:
1379 case ATA_FLUSHCACHE48:
1380 ahci_handle_flush(p, slot, cfis);
1382 case ATA_STANDBY_CMD:
1385 case ATA_STANDBY_IMMEDIATE:
1386 case ATA_IDLE_IMMEDIATE:
1388 ahci_write_fis_d2h(p, slot, cfis, ATA_S_READY | ATA_S_DSC);
1390 case ATA_ATAPI_IDENTIFY:
1391 handle_atapi_identify(p, slot, cfis);
1393 case ATA_PACKET_CMD:
1395 p->tfd = (ATA_E_ABORT << 8) | ATA_S_READY | ATA_S_ERROR;
1396 p->is |= AHCI_P_IX_TFE;
1397 ahci_generate_intr(p->pr_sc);
1399 handle_packet_cmd(p, slot, cfis);
1402 WPRINTF("Unsupported cmd:%02x\n", cfis[2]);
1403 p->tfd = (ATA_E_ABORT << 8) | ATA_S_READY | ATA_S_ERROR;
1404 p->is |= AHCI_P_IX_TFE;
1405 ahci_generate_intr(p->pr_sc);
1411 ahci_handle_slot(struct ahci_port *p, int slot)
1413 struct ahci_cmd_hdr *hdr;
1414 struct ahci_prdt_entry *prdt;
1415 struct pci_ahci_softc *sc;
1420 hdr = (struct ahci_cmd_hdr *)(p->cmd_lst + slot * AHCI_CL_SIZE);
1421 cfl = (hdr->flags & 0x1f) * 4;
1422 cfis = paddr_guest2host(ahci_ctx(sc), hdr->ctba,
1423 0x80 + hdr->prdtl * sizeof(struct ahci_prdt_entry));
1424 prdt = (struct ahci_prdt_entry *)(cfis + 0x80);
1428 for (i = 0; i < cfl; i++) {
1431 DPRINTF("%02x ", cfis[i]);
1435 for (i = 0; i < hdr->prdtl; i++) {
1436 DPRINTF("%d@%08"PRIx64"\n", prdt->dbc & 0x3fffff, prdt->dba);
1441 if (cfis[0] != FIS_TYPE_REGH2D) {
1442 WPRINTF("Not a H2D FIS:%02x\n", cfis[0]);
1446 if (cfis[1] & 0x80) {
1447 ahci_handle_cmd(p, slot, cfis);
1449 if (cfis[15] & (1 << 2))
1451 else if (p->reset) {
1455 p->ci &= ~(1 << slot);
1460 ahci_handle_port(struct ahci_port *p)
1464 if (!(p->cmd & AHCI_P_CMD_ST))
1468 * Search for any new commands to issue ignoring those that
1469 * are already in-flight.
1471 for (i = 0; (i < 32) && p->ci; i++) {
1472 if ((p->ci & (1 << i)) && !(p->pending & (1 << i))) {
1473 p->cmd &= ~AHCI_P_CMD_CCS_MASK;
1474 p->cmd |= i << AHCI_P_CMD_CCS_SHIFT;
1475 ahci_handle_slot(p, i);
1481 * blockif callback routine - this runs in the context of the blockif
1482 * i/o thread, so the mutex needs to be acquired.
1485 ata_ioreq_cb(struct blockif_req *br, int err)
1487 struct ahci_cmd_hdr *hdr;
1488 struct ahci_ioreq *aior;
1489 struct ahci_port *p;
1490 struct pci_ahci_softc *sc;
1493 int pending, slot, ncq;
1495 DPRINTF("%s %d\n", __func__, err);
1498 aior = br->br_param;
1502 pending = aior->prdtl;
1504 hdr = (struct ahci_cmd_hdr *)(p->cmd_lst + slot * AHCI_CL_SIZE);
1506 if (cfis[2] == ATA_WRITE_FPDMA_QUEUED ||
1507 cfis[2] == ATA_READ_FPDMA_QUEUED)
1510 pthread_mutex_lock(&sc->mtx);
1513 * Delete the blockif request from the busy list
1515 TAILQ_REMOVE(&p->iobhd, aior, io_blist);
1518 * Move the blockif request back to the free list
1520 STAILQ_INSERT_TAIL(&p->iofhd, aior, io_flist);
1522 if (pending && !err) {
1523 ahci_handle_dma(p, slot, cfis, aior->done,
1524 hdr->prdtl - pending);
1528 if (!err && aior->done == aior->len) {
1529 tfd = ATA_S_READY | ATA_S_DSC;
1533 hdr->prdbc = aior->len;
1535 tfd = (ATA_E_ABORT << 8) | ATA_S_READY | ATA_S_ERROR;
1538 p->serr |= (1 << slot);
1542 p->sact &= ~(1 << slot);
1543 ahci_write_fis_sdb(p, slot, tfd);
1545 ahci_write_fis_d2h(p, slot, cfis, tfd);
1548 * This command is now complete.
1550 p->pending &= ~(1 << slot);
1552 ahci_check_stopped(p);
1554 pthread_mutex_unlock(&sc->mtx);
1555 DPRINTF("%s exit\n", __func__);
1559 atapi_ioreq_cb(struct blockif_req *br, int err)
1561 struct ahci_cmd_hdr *hdr;
1562 struct ahci_ioreq *aior;
1563 struct ahci_port *p;
1564 struct pci_ahci_softc *sc;
1569 DPRINTF("%s %d\n", __func__, err);
1571 aior = br->br_param;
1575 pending = aior->prdtl;
1577 hdr = (struct ahci_cmd_hdr *)(p->cmd_lst + aior->slot * AHCI_CL_SIZE);
1579 pthread_mutex_lock(&sc->mtx);
1582 * Delete the blockif request from the busy list
1584 TAILQ_REMOVE(&p->iobhd, aior, io_blist);
1587 * Move the blockif request back to the free list
1589 STAILQ_INSERT_TAIL(&p->iofhd, aior, io_flist);
1591 if (pending && !err) {
1592 atapi_read(p, slot, cfis, aior->done, hdr->prdtl - pending);
1596 if (!err && aior->done == aior->len) {
1597 tfd = ATA_S_READY | ATA_S_DSC;
1598 hdr->prdbc = aior->len;
1600 p->sense_key = ATA_SENSE_ILLEGAL_REQUEST;
1602 tfd = (p->sense_key << 12) | ATA_S_READY | ATA_S_ERROR;
1606 cfis[4] = (cfis[4] & ~7) | ATA_I_CMD | ATA_I_IN;
1607 ahci_write_fis_d2h(p, slot, cfis, tfd);
1610 * This command is now complete.
1612 p->pending &= ~(1 << slot);
1614 ahci_check_stopped(p);
1616 pthread_mutex_unlock(&sc->mtx);
1617 DPRINTF("%s exit\n", __func__);
1621 pci_ahci_ioreq_init(struct ahci_port *pr)
1623 struct ahci_ioreq *vr;
1626 pr->ioqsz = blockif_queuesz(pr->bctx);
1627 pr->ioreq = calloc(pr->ioqsz, sizeof(struct ahci_ioreq));
1628 STAILQ_INIT(&pr->iofhd);
1631 * Add all i/o request entries to the free queue
1633 for (i = 0; i < pr->ioqsz; i++) {
1637 vr->io_req.br_callback = ata_ioreq_cb;
1639 vr->io_req.br_callback = atapi_ioreq_cb;
1640 vr->io_req.br_param = vr;
1641 STAILQ_INSERT_TAIL(&pr->iofhd, vr, io_flist);
1644 TAILQ_INIT(&pr->iobhd);
1648 pci_ahci_port_write(struct pci_ahci_softc *sc, uint64_t offset, uint64_t value)
1650 int port = (offset - AHCI_OFFSET) / AHCI_STEP;
1651 offset = (offset - AHCI_OFFSET) % AHCI_STEP;
1652 struct ahci_port *p = &sc->port[port];
1654 DPRINTF("pci_ahci_port %d: write offset 0x%"PRIx64" value 0x%"PRIx64"\n",
1655 port, offset, value);
1674 p->ie = value & 0xFDC000FF;
1675 ahci_generate_intr(sc);
1681 if (!(value & AHCI_P_CMD_ST)) {
1686 p->cmd |= AHCI_P_CMD_CR;
1687 clb = (uint64_t)p->clbu << 32 | p->clb;
1688 p->cmd_lst = paddr_guest2host(ahci_ctx(sc), clb,
1689 AHCI_CL_SIZE * AHCI_MAX_SLOTS);
1692 if (value & AHCI_P_CMD_FRE) {
1695 p->cmd |= AHCI_P_CMD_FR;
1696 fb = (uint64_t)p->fbu << 32 | p->fb;
1697 /* we don't support FBSCP, so rfis size is 256Bytes */
1698 p->rfis = paddr_guest2host(ahci_ctx(sc), fb, 256);
1700 p->cmd &= ~AHCI_P_CMD_FR;
1703 if (value & AHCI_P_CMD_CLO) {
1705 p->cmd &= ~AHCI_P_CMD_CLO;
1708 ahci_handle_port(p);
1714 WPRINTF("pci_ahci_port: read only registers 0x%"PRIx64"\n", offset);
1717 if (!(p->cmd & AHCI_P_CMD_ST)) {
1718 if (value & ATA_SC_DET_RESET)
1731 ahci_handle_port(p);
1741 pci_ahci_host_write(struct pci_ahci_softc *sc, uint64_t offset, uint64_t value)
1743 DPRINTF("pci_ahci_host: write offset 0x%"PRIx64" value 0x%"PRIx64"\n",
1751 DPRINTF("pci_ahci_host: read only registers 0x%"PRIx64"\n", offset);
1754 if (value & AHCI_GHC_HR)
1756 else if (value & AHCI_GHC_IE) {
1757 sc->ghc |= AHCI_GHC_IE;
1758 ahci_generate_intr(sc);
1763 ahci_generate_intr(sc);
1771 pci_ahci_write(struct vmctx *ctx, int vcpu, struct pci_devinst *pi,
1772 int baridx, uint64_t offset, int size, uint64_t value)
1774 struct pci_ahci_softc *sc = pi->pi_arg;
1776 assert(baridx == 5);
1779 pthread_mutex_lock(&sc->mtx);
1781 if (offset < AHCI_OFFSET)
1782 pci_ahci_host_write(sc, offset, value);
1783 else if (offset < AHCI_OFFSET + sc->ports * AHCI_STEP)
1784 pci_ahci_port_write(sc, offset, value);
1786 WPRINTF("pci_ahci: unknown i/o write offset 0x%"PRIx64"\n", offset);
1788 pthread_mutex_unlock(&sc->mtx);
1792 pci_ahci_host_read(struct pci_ahci_softc *sc, uint64_t offset)
1808 uint32_t *p = &sc->cap;
1809 p += (offset - AHCI_CAP) / sizeof(uint32_t);
1817 DPRINTF("pci_ahci_host: read offset 0x%"PRIx64" value 0x%x\n",
1824 pci_ahci_port_read(struct pci_ahci_softc *sc, uint64_t offset)
1827 int port = (offset - AHCI_OFFSET) / AHCI_STEP;
1828 offset = (offset - AHCI_OFFSET) % AHCI_STEP;
1848 uint32_t *p= &sc->port[port].clb;
1849 p += (offset - AHCI_P_CLB) / sizeof(uint32_t);
1858 DPRINTF("pci_ahci_port %d: read offset 0x%"PRIx64" value 0x%x\n",
1859 port, offset, value);
1865 pci_ahci_read(struct vmctx *ctx, int vcpu, struct pci_devinst *pi, int baridx,
1866 uint64_t offset, int size)
1868 struct pci_ahci_softc *sc = pi->pi_arg;
1871 assert(baridx == 5);
1874 pthread_mutex_lock(&sc->mtx);
1876 if (offset < AHCI_OFFSET)
1877 value = pci_ahci_host_read(sc, offset);
1878 else if (offset < AHCI_OFFSET + sc->ports * AHCI_STEP)
1879 value = pci_ahci_port_read(sc, offset);
1882 WPRINTF("pci_ahci: unknown i/o read offset 0x%"PRIx64"\n", offset);
1885 pthread_mutex_unlock(&sc->mtx);
1891 pci_ahci_init(struct vmctx *ctx, struct pci_devinst *pi, char *opts, int atapi)
1893 char bident[sizeof("XX:X:X")];
1894 struct blockif_ctxt *bctxt;
1895 struct pci_ahci_softc *sc;
1901 fprintf(stderr, "pci_ahci: backing device required\n");
1906 dbg = fopen("/tmp/log", "w+");
1909 sc = calloc(1, sizeof(struct pci_ahci_softc));
1912 sc->ports = MAX_PORTS;
1915 * Only use port 0 for a backing device. All other ports will be
1918 sc->port[0].atapi = atapi;
1921 * Attempt to open the backing image. Use the PCI
1922 * slot/func for the identifier string.
1924 snprintf(bident, sizeof(bident), "%d:%d", pi->pi_slot, pi->pi_func);
1925 bctxt = blockif_open(opts, bident);
1926 if (bctxt == NULL) {
1930 sc->port[0].bctx = bctxt;
1931 sc->port[0].pr_sc = sc;
1934 * Allocate blockif request structures and add them
1937 pci_ahci_ioreq_init(&sc->port[0]);
1939 pthread_mutex_init(&sc->mtx, NULL);
1941 /* Intel ICH8 AHCI */
1942 slots = sc->port[0].ioqsz;
1946 sc->cap = AHCI_CAP_64BIT | AHCI_CAP_SNCQ | AHCI_CAP_SSNTF |
1947 AHCI_CAP_SMPS | AHCI_CAP_SSS | AHCI_CAP_SALP |
1948 AHCI_CAP_SAL | AHCI_CAP_SCLO | (0x3 << AHCI_CAP_ISS_SHIFT)|
1949 AHCI_CAP_PMD | AHCI_CAP_SSC | AHCI_CAP_PSC |
1950 (slots << AHCI_CAP_NCS_SHIFT) | AHCI_CAP_SXS | (sc->ports - 1);
1952 /* Only port 0 implemented */
1955 sc->cap2 = AHCI_CAP2_APST;
1958 pci_set_cfgdata16(pi, PCIR_DEVICE, 0x2821);
1959 pci_set_cfgdata16(pi, PCIR_VENDOR, 0x8086);
1960 pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_STORAGE);
1961 pci_set_cfgdata8(pi, PCIR_SUBCLASS, PCIS_STORAGE_SATA);
1962 pci_set_cfgdata8(pi, PCIR_PROGIF, PCIP_STORAGE_SATA_AHCI_1_0);
1963 pci_emul_add_msicap(pi, 1);
1964 pci_emul_alloc_bar(pi, 5, PCIBAR_MEM32,
1965 AHCI_OFFSET + sc->ports * AHCI_STEP);
1967 pci_lintr_request(pi);
1971 blockif_close(sc->port[0].bctx);
1979 pci_ahci_hd_init(struct vmctx *ctx, struct pci_devinst *pi, char *opts)
1982 return (pci_ahci_init(ctx, pi, opts, 0));
1986 pci_ahci_atapi_init(struct vmctx *ctx, struct pci_devinst *pi, char *opts)
1989 return (pci_ahci_init(ctx, pi, opts, 1));
1993 * Use separate emulation names to distinguish drive and atapi devices
1995 struct pci_devemu pci_de_ahci_hd = {
1996 .pe_emu = "ahci-hd",
1997 .pe_init = pci_ahci_hd_init,
1998 .pe_barwrite = pci_ahci_write,
1999 .pe_barread = pci_ahci_read
2001 PCI_EMUL_SET(pci_de_ahci_hd);
2003 struct pci_devemu pci_de_ahci_cd = {
2004 .pe_emu = "ahci-cd",
2005 .pe_init = pci_ahci_atapi_init,
2006 .pe_barwrite = pci_ahci_write,
2007 .pe_barread = pci_ahci_read
2009 PCI_EMUL_SET(pci_de_ahci_cd);