root/sys/dev/ahci/ahci_pci.c
/*-
 * Copyright (c) 2009-2012 Alexander Motin <mav@FreeBSD.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer,
 *    without modification, immediately at the beginning of the file.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include <sys/param.h>
#include <sys/module.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/bus.h>
#include <sys/conf.h>
#include <sys/endian.h>
#include <sys/malloc.h>
#include <sys/lock.h>
#include <sys/mutex.h>
#include <sys/stdarg.h>
#include <sys/sysctl.h>
#include <sys/taskqueue.h>
#include <sys/tree.h>
#include <machine/resource.h>
#include <machine/bus.h>
#include <sys/rman.h>
#include <dev/pci/pcivar.h>
#include <dev/pci/pcireg.h>
#include <dev/iommu/iommu.h>
#include "ahci.h"

static int force_ahci = 1;
TUNABLE_INT("hw.ahci.force", &force_ahci);

static const struct {
        uint32_t        id;
        uint8_t         rev;
        const char      *name;
        int             quirks;
} ahci_ids[] = {
        {0x43801002, 0x00, "AMD SB600",
            AHCI_Q_NOMSI | AHCI_Q_ATI_PMP_BUG | AHCI_Q_MAXIO_64K},
        {0x43901002, 0x00, "AMD SB7x0/SB8x0/SB9x0",
            AHCI_Q_ATI_PMP_BUG | AHCI_Q_1MSI},
        {0x43911002, 0x00, "AMD SB7x0/SB8x0/SB9x0",
            AHCI_Q_ATI_PMP_BUG | AHCI_Q_1MSI},
        {0x43921002, 0x00, "AMD SB7x0/SB8x0/SB9x0",
            AHCI_Q_ATI_PMP_BUG | AHCI_Q_1MSI},
        {0x43931002, 0x00, "AMD SB7x0/SB8x0/SB9x0",
            AHCI_Q_ATI_PMP_BUG | AHCI_Q_1MSI},
        {0x43941002, 0x00, "AMD SB7x0/SB8x0/SB9x0",
            AHCI_Q_ATI_PMP_BUG | AHCI_Q_1MSI},
        /* Not sure SB8x0/SB9x0 needs this quirk. Be conservative though */
        {0x43951002, 0x00, "AMD SB8x0/SB9x0",   AHCI_Q_ATI_PMP_BUG},
        {0x43b61022, 0x00, "AMD X399",          0},
        {0x43b51022, 0x00, "AMD 300 Series",    0}, /* X370 */
        {0x43b71022, 0x00, "AMD 300 Series",    0}, /* B350 */
        {0x43c81022, 0x00, "AMD 400 Series",    0}, /* B450 */
        {0x43eb1022, 0x00, "AMD 500 Series",    0},
        {0x43f61022, 0x00, "AMD 600 Series",    0}, /* X670 */
        {0x78001022, 0x00, "AMD Hudson-2",      0},
        {0x78011022, 0x00, "AMD Hudson-2",      0},
        {0x78021022, 0x00, "AMD Hudson-2",      0},
        {0x78031022, 0x00, "AMD Hudson-2",      0},
        {0x78041022, 0x00, "AMD Hudson-2",      0},
        {0x79001022, 0x00, "AMD KERNCZ",        0},
        {0x79011022, 0x00, "AMD KERNCZ",        0},
        {0x79021022, 0x00, "AMD KERNCZ",        0},
        {0x79031022, 0x00, "AMD KERNCZ",        0},
        {0x79041022, 0x00, "AMD KERNCZ",        0},
        {0x79161022, 0x00, "AMD KERNCZ (RAID)", 0},
        {0x06011b21, 0x00, "ASMedia ASM1060",   AHCI_Q_NOCCS|AHCI_Q_NOAUX},
        {0x06021b21, 0x00, "ASMedia ASM1060",   AHCI_Q_NOCCS|AHCI_Q_NOAUX},
        {0x06111b21, 0x00, "ASMedia ASM1061",   AHCI_Q_NOCCS|AHCI_Q_NOAUX},
        {0x06121b21, 0x00, "ASMedia ASM1062",   AHCI_Q_NOCCS|AHCI_Q_NOAUX},
        {0x06201b21, 0x00, "ASMedia ASM106x",   AHCI_Q_NOCCS|AHCI_Q_NOAUX},
        {0x06211b21, 0x00, "ASMedia ASM106x",   AHCI_Q_NOCCS|AHCI_Q_NOAUX},
        {0x06221b21, 0x00, "ASMedia ASM106x",   AHCI_Q_NOCCS|AHCI_Q_NOAUX},
        {0x06241b21, 0x00, "ASMedia ASM106x",   AHCI_Q_NOCCS|AHCI_Q_NOAUX},
        {0x06251b21, 0x00, "ASMedia ASM106x",   AHCI_Q_NOCCS|AHCI_Q_NOAUX},
        {0x10621b21, 0x00, "ASMedia ASM116x",   0},
        {0x10641b21, 0x00, "ASMedia ASM116x",   0},
        {0x11641b21, 0x00, "ASMedia ASM116x",   0},
        {0x11651b21, 0x00, "ASMedia ASM116x",   0},
        {0x11661b21, 0x00, "ASMedia ASM116x",   0},
        {0x79011d94, 0x00, "Hygon KERNCZ",      0},
        {0x0f228086, 0x00, "Intel BayTrail",    0},
        {0x0f238086, 0x00, "Intel BayTrail",    0},
        {0x26528086, 0x00, "Intel ICH6",        AHCI_Q_NOFORCE},
        {0x26538086, 0x00, "Intel ICH6M",       AHCI_Q_NOFORCE},
        {0x26818086, 0x00, "Intel ESB2",        0},
        {0x26828086, 0x00, "Intel ESB2",        0},
        {0x26838086, 0x00, "Intel ESB2",        0},
        {0x27c18086, 0x00, "Intel ICH7",        0},
        {0x27c38086, 0x00, "Intel ICH7",        0},
        {0x27c58086, 0x00, "Intel ICH7M",       0},
        {0x27c68086, 0x00, "Intel ICH7M",       0},
        {0x28218086, 0x00, "Intel ICH8",        0},
        {0x28228086, 0x00, "Intel ICH8+ (RAID)",        0},
        {0x28248086, 0x00, "Intel ICH8",        0},
        {0x28298086, 0x00, "Intel ICH8M",       0},
        {0x282a8086, 0x00, "Intel ICH8M+ (RAID)",       0},
        {0x29228086, 0x00, "Intel ICH9",        0},
        {0x29238086, 0x00, "Intel ICH9",        0},
        {0x29248086, 0x00, "Intel ICH9",        0},
        {0x29258086, 0x00, "Intel ICH9",        0},
        {0x29278086, 0x00, "Intel ICH9",        0},
        {0x29298086, 0x00, "Intel ICH9M",       0},
        {0x292a8086, 0x00, "Intel ICH9M",       0},
        {0x292b8086, 0x00, "Intel ICH9M",       0},
        {0x292c8086, 0x00, "Intel ICH9M",       0},
        {0x292f8086, 0x00, "Intel ICH9M",       0},
        {0x294d8086, 0x00, "Intel ICH9",        0},
        {0x294e8086, 0x00, "Intel ICH9M",       0},
        {0x3a028086, 0x00, "Intel ICH10",       0},
        {0x3a058086, 0x00, "Intel ICH10 (RAID)",        0},
        {0x3a228086, 0x00, "Intel ICH10",       0},
        {0x3a258086, 0x00, "Intel ICH10 (RAID)",        0},
        {0x3b228086, 0x00, "Intel Ibex Peak",   0},
        {0x3b238086, 0x00, "Intel Ibex Peak",   0},
        {0x3b258086, 0x00, "Intel Ibex Peak (RAID)",    0},
        {0x3b298086, 0x00, "Intel Ibex Peak-M", 0},
        {0x3b2c8086, 0x00, "Intel Ibex Peak-M (RAID)",  0},
        {0x3b2f8086, 0x00, "Intel Ibex Peak-M", 0},
        {0x06d68086, 0x00, "Intel Comet Lake (RAID)", 0},
        {0x19b08086, 0x00, "Intel Denverton",   0},
        {0x19b18086, 0x00, "Intel Denverton",   0},
        {0x19b28086, 0x00, "Intel Denverton",   0},
        {0x19b38086, 0x00, "Intel Denverton",   0},
        {0x19b48086, 0x00, "Intel Denverton",   0},
        {0x19b58086, 0x00, "Intel Denverton",   0},
        {0x19b68086, 0x00, "Intel Denverton",   0},
        {0x19b78086, 0x00, "Intel Denverton",   0},
        {0x19be8086, 0x00, "Intel Denverton",   0},
        {0x19bf8086, 0x00, "Intel Denverton",   0},
        {0x19c08086, 0x00, "Intel Denverton",   0},
        {0x19c18086, 0x00, "Intel Denverton",   0},
        {0x19c28086, 0x00, "Intel Denverton",   0},
        {0x19c38086, 0x00, "Intel Denverton",   0},
        {0x19c48086, 0x00, "Intel Denverton",   0},
        {0x19c58086, 0x00, "Intel Denverton",   0},
        {0x19c68086, 0x00, "Intel Denverton",   0},
        {0x19c78086, 0x00, "Intel Denverton",   0},
        {0x19ce8086, 0x00, "Intel Denverton",   0},
        {0x19cf8086, 0x00, "Intel Denverton",   0},
        {0x1c028086, 0x00, "Intel Cougar Point",        0},
        {0x1c038086, 0x00, "Intel Cougar Point",        0},
        {0x1c048086, 0x00, "Intel Cougar Point (RAID)", 0},
        {0x1c058086, 0x00, "Intel Cougar Point (RAID)", 0},
        {0x1c068086, 0x00, "Intel Cougar Point (RAID)", 0},
        {0x1d028086, 0x00, "Intel Patsburg",    0},
        {0x1d048086, 0x00, "Intel Patsburg",    0},
        {0x1d068086, 0x00, "Intel Patsburg",    0},
        {0x28268086, 0x00, "Intel Patsburg+ (RAID)",    0},
        {0x1e028086, 0x00, "Intel Panther Point",       0},
        {0x1e038086, 0x00, "Intel Panther Point",       0},
        {0x1e048086, 0x00, "Intel Panther Point (RAID)",        0},
        {0x1e058086, 0x00, "Intel Panther Point (RAID)",        0},
        {0x1e068086, 0x00, "Intel Panther Point (RAID)",        0},
        {0x1e078086, 0x00, "Intel Panther Point (RAID)",        0},
        {0x1e0e8086, 0x00, "Intel Panther Point (RAID)",        0},
        {0x1e0f8086, 0x00, "Intel Panther Point (RAID)",        0},
        {0x1f228086, 0x00, "Intel Avoton",      0},
        {0x1f238086, 0x00, "Intel Avoton",      0},
        {0x1f248086, 0x00, "Intel Avoton (RAID)",       0},
        {0x1f258086, 0x00, "Intel Avoton (RAID)",       0},
        {0x1f268086, 0x00, "Intel Avoton (RAID)",       0},
        {0x1f278086, 0x00, "Intel Avoton (RAID)",       0},
        {0x1f2e8086, 0x00, "Intel Avoton (RAID)",       0},
        {0x1f2f8086, 0x00, "Intel Avoton (RAID)",       0},
        {0x1f328086, 0x00, "Intel Avoton",      0},
        {0x1f338086, 0x00, "Intel Avoton",      0},
        {0x1f348086, 0x00, "Intel Avoton (RAID)",       0},
        {0x1f358086, 0x00, "Intel Avoton (RAID)",       0},
        {0x1f368086, 0x00, "Intel Avoton (RAID)",       0},
        {0x1f378086, 0x00, "Intel Avoton (RAID)",       0},
        {0x1f3e8086, 0x00, "Intel Avoton (RAID)",       0},
        {0x1f3f8086, 0x00, "Intel Avoton (RAID)",       0},
        {0x23a38086, 0x00, "Intel Coleto Creek",        0},
        {0x31e38086, 0x00, "Intel Gemini Lake", 0},
        {0x4b638086, 0x00, "Intel Elkhart Lake",        0},
        {0x5ae38086, 0x00, "Intel Apollo Lake", 0},
        {0x7ae28086, 0x00, "Intel Alder Lake",  0},
        {0x8c028086, 0x00, "Intel Lynx Point",  0},
        {0x8c038086, 0x00, "Intel Lynx Point",  0},
        {0x8c048086, 0x00, "Intel Lynx Point (RAID)",   0},
        {0x8c058086, 0x00, "Intel Lynx Point (RAID)",   0},
        {0x8c068086, 0x00, "Intel Lynx Point (RAID)",   0},
        {0x8c078086, 0x00, "Intel Lynx Point (RAID)",   0},
        {0x8c0e8086, 0x00, "Intel Lynx Point (RAID)",   0},
        {0x8c0f8086, 0x00, "Intel Lynx Point (RAID)",   0},
        {0x8c828086, 0x00, "Intel Wildcat Point",       0},
        {0x8c838086, 0x00, "Intel Wildcat Point",       0},
        {0x8c848086, 0x00, "Intel Wildcat Point (RAID)",        0},
        {0x8c858086, 0x00, "Intel Wildcat Point (RAID)",        0},
        {0x8c868086, 0x00, "Intel Wildcat Point (RAID)",        0},
        {0x8c878086, 0x00, "Intel Wildcat Point (RAID)",        0},
        {0x8c8e8086, 0x00, "Intel Wildcat Point (RAID)",        0},
        {0x8c8f8086, 0x00, "Intel Wildcat Point (RAID)",        0},
        {0x8d028086, 0x00, "Intel Wellsburg",   0},
        {0x8d048086, 0x00, "Intel Wellsburg (RAID)",    0},
        {0x8d068086, 0x00, "Intel Wellsburg (RAID)",    0},
        {0x8d628086, 0x00, "Intel Wellsburg",   0},
        {0x8d648086, 0x00, "Intel Wellsburg (RAID)",    0},
        {0x8d668086, 0x00, "Intel Wellsburg (RAID)",    0},
        {0x8d6e8086, 0x00, "Intel Wellsburg (RAID)",    0},
        {0x28238086, 0x00, "Intel Wellsburg+ (RAID)",   0},
        {0x28278086, 0x00, "Intel Wellsburg+ (RAID)",   0},
        {0x9c028086, 0x00, "Intel Lynx Point-LP",       0},
        {0x9c038086, 0x00, "Intel Lynx Point-LP",       0},
        {0x9c048086, 0x00, "Intel Lynx Point-LP (RAID)",        0},
        {0x9c058086, 0x00, "Intel Lynx Point-LP (RAID)",        0},
        {0x9c068086, 0x00, "Intel Lynx Point-LP (RAID)",        0},
        {0x9c078086, 0x00, "Intel Lynx Point-LP (RAID)",        0},
        {0x9c0e8086, 0x00, "Intel Lynx Point-LP (RAID)",        0},
        {0x9c0f8086, 0x00, "Intel Lynx Point-LP (RAID)",        0},
        {0x9c838086, 0x00, "Intel Wildcat Point-LP",    0},
        {0x9c858086, 0x00, "Intel Wildcat Point-LP (RAID)",     0},
        {0x9c878086, 0x00, "Intel Wildcat Point-LP (RAID)",     0},
        {0x9c8f8086, 0x00, "Intel Wildcat Point-LP (RAID)",     0},
        {0x9d038086, 0x00, "Intel Sunrise Point-LP",    0},
        {0x9d058086, 0x00, "Intel Sunrise Point-LP (RAID)",     0},
        {0x9d078086, 0x00, "Intel Sunrise Point-LP (RAID)",     0},
        {0xa1028086, 0x00, "Intel Sunrise Point",       0},
        {0xa1038086, 0x00, "Intel Sunrise Point",       0},
        {0xa1058086, 0x00, "Intel Sunrise Point (RAID)",        0},
        {0xa1068086, 0x00, "Intel Sunrise Point (RAID)",        0},
        {0xa1078086, 0x00, "Intel Sunrise Point (RAID)",        0},
        {0xa10f8086, 0x00, "Intel Sunrise Point (RAID)",        0},
        {0xa1828086, 0x00, "Intel Lewisburg",   0},
        {0xa1868086, 0x00, "Intel Lewisburg (RAID)",    0},
        {0xa1d28086, 0x00, "Intel Lewisburg",   0},
        {0xa1d68086, 0x00, "Intel Lewisburg (RAID)",    0},
        {0xa2028086, 0x00, "Intel Lewisburg",   0},
        {0xa2068086, 0x00, "Intel Lewisburg (RAID)",    0},
        {0xa2528086, 0x00, "Intel Lewisburg",   0},
        {0xa2568086, 0x00, "Intel Lewisburg (RAID)",    0},
        {0xa2828086, 0x00, "Intel Union Point", 0},
        {0xa2868086, 0x00, "Intel Union Point (RAID)",  0},
        {0xa28e8086, 0x00, "Intel Union Point (RAID)",  0},
        {0xa3528086, 0x00, "Intel Cannon Lake", 0},
        {0xa3538086, 0x00, "Intel Cannon Lake", 0},
        {0x23238086, 0x00, "Intel DH89xxCC",    0},
        {0x2360197b, 0x00, "JMicron JMB360",    0},
        {0x2361197b, 0x00, "JMicron JMB361",    AHCI_Q_NOFORCE | AHCI_Q_1CH},
        {0x2362197b, 0x00, "JMicron JMB362",    0},
        {0x2363197b, 0x00, "JMicron JMB363",    AHCI_Q_NOFORCE},
        {0x2365197b, 0x00, "JMicron JMB365",    AHCI_Q_NOFORCE},
        {0x2366197b, 0x00, "JMicron JMB366",    AHCI_Q_NOFORCE},
        {0x2368197b, 0x00, "JMicron JMB368",    AHCI_Q_NOFORCE},
        {0x2392197b, 0x00, "JMicron JMB388",    AHCI_Q_IOMMU_BUSWIDE},
        {0x0585197b, 0x00, "JMicron JMB58x",    0},
        {0x01221c28, 0x00, "Lite-On Plextor M6E (Marvell 88SS9183)",
            AHCI_Q_IOMMU_BUSWIDE},
        {0x611111ab, 0x00, "Marvell 88SE6111",  AHCI_Q_NOFORCE | AHCI_Q_NOPMP |
            AHCI_Q_1CH | AHCI_Q_EDGEIS},
        {0x612111ab, 0x00, "Marvell 88SE6121",  AHCI_Q_NOFORCE | AHCI_Q_NOPMP |
            AHCI_Q_2CH | AHCI_Q_EDGEIS | AHCI_Q_NONCQ | AHCI_Q_NOCOUNT},
        {0x614111ab, 0x00, "Marvell 88SE6141",  AHCI_Q_NOFORCE | AHCI_Q_NOPMP |
            AHCI_Q_4CH | AHCI_Q_EDGEIS | AHCI_Q_NONCQ | AHCI_Q_NOCOUNT},
        {0x614511ab, 0x00, "Marvell 88SE6145",  AHCI_Q_NOFORCE | AHCI_Q_NOPMP |
            AHCI_Q_4CH | AHCI_Q_EDGEIS | AHCI_Q_NONCQ | AHCI_Q_NOCOUNT},
        {0x91201b4b, 0x00, "Marvell 88SE912x",  AHCI_Q_EDGEIS |
            AHCI_Q_IOMMU_BUSWIDE},
        {0x91231b4b, 0x11, "Marvell 88SE912x",  AHCI_Q_ALTSIG |
            AHCI_Q_IOMMU_BUSWIDE},
        {0x91231b4b, 0x00, "Marvell 88SE912x",  AHCI_Q_EDGEIS | AHCI_Q_SATA2 |
            AHCI_Q_IOMMU_BUSWIDE},
        {0x91251b4b, 0x00, "Marvell 88SE9125",  0},
        {0x91281b4b, 0x00, "Marvell 88SE9128",  AHCI_Q_ALTSIG |
            AHCI_Q_IOMMU_BUSWIDE},
        {0x91301b4b, 0x00, "Marvell 88SE9130",  AHCI_Q_ALTSIG |
            AHCI_Q_IOMMU_BUSWIDE},
        {0x91701b4b, 0x00, "Marvell 88SE9170",  AHCI_Q_IOMMU_BUSWIDE},
        {0x91721b4b, 0x00, "Marvell 88SE9172",  AHCI_Q_IOMMU_BUSWIDE},
        {0x917a1b4b, 0x00, "Marvell 88SE917A",  AHCI_Q_IOMMU_BUSWIDE},
        {0x91821b4b, 0x00, "Marvell 88SE9182",  AHCI_Q_IOMMU_BUSWIDE},
        {0x91831b4b, 0x00, "Marvell 88SS9183",  AHCI_Q_IOMMU_BUSWIDE},
        {0x91a01b4b, 0x00, "Marvell 88SE91Ax",  AHCI_Q_IOMMU_BUSWIDE},
        {0x92151b4b, 0x00, "Marvell 88SE9215",  0},
        {0x92201b4b, 0x00, "Marvell 88SE9220",  AHCI_Q_ALTSIG |
            AHCI_Q_IOMMU_BUSWIDE},
        {0x92301b4b, 0x00, "Marvell 88SE9230",  AHCI_Q_ALTSIG |
            AHCI_Q_IOMMU_BUSWIDE | AHCI_Q_SLOWDEV},
        {0x92351b4b, 0x00, "Marvell 88SE9235",  0},
        {0x06201103, 0x00, "HighPoint RocketRAID 620",  0},
        {0x06201b4b, 0x00, "HighPoint RocketRAID 620",  0},
        {0x06221103, 0x00, "HighPoint RocketRAID 622",  0},
        {0x06221b4b, 0x00, "HighPoint RocketRAID 622",  0},
        {0x06401103, 0x00, "HighPoint RocketRAID 640",  0},
        {0x06401b4b, 0x00, "HighPoint RocketRAID 640",  0},
        {0x06441103, 0x00, "HighPoint RocketRAID 644",  0},
        {0x06441b4b, 0x00, "HighPoint RocketRAID 644",  0},
        {0x06411103, 0x00, "HighPoint RocketRAID 640L", 0},
        {0x06421103, 0x00, "HighPoint RocketRAID 642L", AHCI_Q_IOMMU_BUSWIDE},
        {0x06451103, 0x00, "HighPoint RocketRAID 644L", AHCI_Q_IOMMU_BUSWIDE},
        {0x044c10de, 0x00, "NVIDIA MCP65",      AHCI_Q_NOAA},
        {0x044d10de, 0x00, "NVIDIA MCP65",      AHCI_Q_NOAA},
        {0x044e10de, 0x00, "NVIDIA MCP65",      AHCI_Q_NOAA},
        {0x044f10de, 0x00, "NVIDIA MCP65",      AHCI_Q_NOAA},
        {0x045c10de, 0x00, "NVIDIA MCP65",      AHCI_Q_NOAA},
        {0x045d10de, 0x00, "NVIDIA MCP65",      AHCI_Q_NOAA},
        {0x045e10de, 0x00, "NVIDIA MCP65",      AHCI_Q_NOAA},
        {0x045f10de, 0x00, "NVIDIA MCP65",      AHCI_Q_NOAA},
        {0x055010de, 0x00, "NVIDIA MCP67",      AHCI_Q_NOAA},
        {0x055110de, 0x00, "NVIDIA MCP67",      AHCI_Q_NOAA},
        {0x055210de, 0x00, "NVIDIA MCP67",      AHCI_Q_NOAA},
        {0x055310de, 0x00, "NVIDIA MCP67",      AHCI_Q_NOAA},
        {0x055410de, 0x00, "NVIDIA MCP67",      AHCI_Q_NOAA},
        {0x055510de, 0x00, "NVIDIA MCP67",      AHCI_Q_NOAA},
        {0x055610de, 0x00, "NVIDIA MCP67",      AHCI_Q_NOAA},
        {0x055710de, 0x00, "NVIDIA MCP67",      AHCI_Q_NOAA},
        {0x055810de, 0x00, "NVIDIA MCP67",      AHCI_Q_NOAA},
        {0x055910de, 0x00, "NVIDIA MCP67",      AHCI_Q_NOAA},
        {0x055A10de, 0x00, "NVIDIA MCP67",      AHCI_Q_NOAA},
        {0x055B10de, 0x00, "NVIDIA MCP67",      AHCI_Q_NOAA},
        {0x058410de, 0x00, "NVIDIA MCP67",      AHCI_Q_NOAA},
        {0x07f010de, 0x00, "NVIDIA MCP73",      AHCI_Q_NOAA},
        {0x07f110de, 0x00, "NVIDIA MCP73",      AHCI_Q_NOAA},
        {0x07f210de, 0x00, "NVIDIA MCP73",      AHCI_Q_NOAA},
        {0x07f310de, 0x00, "NVIDIA MCP73",      AHCI_Q_NOAA},
        {0x07f410de, 0x00, "NVIDIA MCP73",      AHCI_Q_NOAA},
        {0x07f510de, 0x00, "NVIDIA MCP73",      AHCI_Q_NOAA},
        {0x07f610de, 0x00, "NVIDIA MCP73",      AHCI_Q_NOAA},
        {0x07f710de, 0x00, "NVIDIA MCP73",      AHCI_Q_NOAA},
        {0x07f810de, 0x00, "NVIDIA MCP73",      AHCI_Q_NOAA},
        {0x07f910de, 0x00, "NVIDIA MCP73",      AHCI_Q_NOAA},
        {0x07fa10de, 0x00, "NVIDIA MCP73",      AHCI_Q_NOAA},
        {0x07fb10de, 0x00, "NVIDIA MCP73",      AHCI_Q_NOAA},
        {0x0ad010de, 0x00, "NVIDIA MCP77",      AHCI_Q_NOAA},
        {0x0ad110de, 0x00, "NVIDIA MCP77",      AHCI_Q_NOAA},
        {0x0ad210de, 0x00, "NVIDIA MCP77",      AHCI_Q_NOAA},
        {0x0ad310de, 0x00, "NVIDIA MCP77",      AHCI_Q_NOAA},
        {0x0ad410de, 0x00, "NVIDIA MCP77",      AHCI_Q_NOAA},
        {0x0ad510de, 0x00, "NVIDIA MCP77",      AHCI_Q_NOAA},
        {0x0ad610de, 0x00, "NVIDIA MCP77",      AHCI_Q_NOAA},
        {0x0ad710de, 0x00, "NVIDIA MCP77",      AHCI_Q_NOAA},
        {0x0ad810de, 0x00, "NVIDIA MCP77",      AHCI_Q_NOAA},
        {0x0ad910de, 0x00, "NVIDIA MCP77",      AHCI_Q_NOAA},
        {0x0ada10de, 0x00, "NVIDIA MCP77",      AHCI_Q_NOAA},
        {0x0adb10de, 0x00, "NVIDIA MCP77",      AHCI_Q_NOAA},
        {0x0ab410de, 0x00, "NVIDIA MCP79",      AHCI_Q_NOAA},
        {0x0ab510de, 0x00, "NVIDIA MCP79",      AHCI_Q_NOAA},
        {0x0ab610de, 0x00, "NVIDIA MCP79",      AHCI_Q_NOAA},
        {0x0ab710de, 0x00, "NVIDIA MCP79",      AHCI_Q_NOAA},
        {0x0ab810de, 0x00, "NVIDIA MCP79",      AHCI_Q_NOAA},
        {0x0ab910de, 0x00, "NVIDIA MCP79",      AHCI_Q_NOAA},
        {0x0aba10de, 0x00, "NVIDIA MCP79",      AHCI_Q_NOAA},
        {0x0abb10de, 0x00, "NVIDIA MCP79",      AHCI_Q_NOAA},
        {0x0abc10de, 0x00, "NVIDIA MCP79",      AHCI_Q_NOAA},
        {0x0abd10de, 0x00, "NVIDIA MCP79",      AHCI_Q_NOAA},
        {0x0abe10de, 0x00, "NVIDIA MCP79",      AHCI_Q_NOAA},
        {0x0abf10de, 0x00, "NVIDIA MCP79",      AHCI_Q_NOAA},
        {0x0d8410de, 0x00, "NVIDIA MCP89",      AHCI_Q_NOAA},
        {0x0d8510de, 0x00, "NVIDIA MCP89",      AHCI_Q_NOFORCE|AHCI_Q_NOAA},
        {0x0d8610de, 0x00, "NVIDIA MCP89",      AHCI_Q_NOAA},
        {0x0d8710de, 0x00, "NVIDIA MCP89",      AHCI_Q_NOAA},
        {0x0d8810de, 0x00, "NVIDIA MCP89",      AHCI_Q_NOAA},
        {0x0d8910de, 0x00, "NVIDIA MCP89",      AHCI_Q_NOAA},
        {0x0d8a10de, 0x00, "NVIDIA MCP89",      AHCI_Q_NOAA},
        {0x0d8b10de, 0x00, "NVIDIA MCP89",      AHCI_Q_NOAA},
        {0x0d8c10de, 0x00, "NVIDIA MCP89",      AHCI_Q_NOAA},
        {0x0d8d10de, 0x00, "NVIDIA MCP89",      AHCI_Q_NOAA},
        {0x0d8e10de, 0x00, "NVIDIA MCP89",      AHCI_Q_NOAA},
        {0x0d8f10de, 0x00, "NVIDIA MCP89",      AHCI_Q_NOAA},
        {0x3781105a, 0x00, "Promise TX8660",    0},
        {0x33491106, 0x00, "VIA VT8251",        AHCI_Q_NOPMP|AHCI_Q_NONCQ},
        {0x62871106, 0x00, "VIA VT8251",        AHCI_Q_NOPMP|AHCI_Q_NONCQ},
        {0x11841039, 0x00, "SiS 966",           0},
        {0x11851039, 0x00, "SiS 968",           0},
        {0x01861039, 0x00, "SiS 968",           0},
        {0xa01c177d, 0x00, "ThunderX",          AHCI_Q_ABAR0|AHCI_Q_1MSI},
        {0x00311c36, 0x00, "Annapurna",         AHCI_Q_FORCE_PI|AHCI_Q_RESTORE_CAP|AHCI_Q_NOMSIX},
        {0x1600144d, 0x00, "Samsung",           AHCI_Q_NOMSI},
        {0x07e015ad, 0x00, "VMware",            0},
        {0x00000000, 0x00, NULL,                0}
};

static int
ahci_pci_ctlr_reset(device_t dev)
{

        return(ahci_ctlr_reset(dev));
}

static int
ahci_probe(device_t dev)
{
        int i, valid = 0;
        uint32_t devid = pci_get_devid(dev);
        uint8_t revid = pci_get_revid(dev);

        /*
         * Ensure it is not a PCI bridge (some vendors use
         * the same PID and VID in PCI bridge and AHCI cards).
         */
        if (pci_get_class(dev) == PCIC_BRIDGE)
                return (ENXIO);

        /* Is this a possible AHCI candidate? */
        if (pci_get_class(dev) == PCIC_STORAGE &&
            pci_get_subclass(dev) == PCIS_STORAGE_SATA &&
            pci_get_progif(dev) == PCIP_STORAGE_SATA_AHCI_1_0)
                valid = 1;
        else if (pci_get_class(dev) == PCIC_STORAGE &&
            pci_get_subclass(dev) == PCIS_STORAGE_RAID)
                valid = 2;
        /* Is this a known AHCI chip? */
        for (i = 0; ahci_ids[i].id != 0; i++) {
                if (ahci_ids[i].id == devid &&
                    ahci_ids[i].rev <= revid &&
                    (valid || (force_ahci == 1 &&
                     !(ahci_ids[i].quirks & AHCI_Q_NOFORCE)))) {
                        /* Do not attach JMicrons with single PCI function. */
                        if (pci_get_vendor(dev) == 0x197b &&
                            (ahci_ids[i].quirks & AHCI_Q_NOFORCE) &&
                            (pci_read_config(dev, 0xdf, 1) & 0x40) == 0)
                                return (ENXIO);
                        device_set_descf(dev, "%s AHCI SATA controller",
                            ahci_ids[i].name);
                        return (BUS_PROBE_DEFAULT);
                }
        }
        if (valid != 1)
                return (ENXIO);
        device_set_desc(dev, "AHCI SATA controller");
        return (BUS_PROBE_DEFAULT);
}

static int
ahci_ata_probe(device_t dev)
{
        int i;
        uint32_t devid = pci_get_devid(dev);
        uint8_t revid = pci_get_revid(dev);

        if ((intptr_t)device_get_ivars(dev) >= 0)
                return (ENXIO);
        /* Is this a known AHCI chip? */
        for (i = 0; ahci_ids[i].id != 0; i++) {
                if (ahci_ids[i].id == devid &&
                    ahci_ids[i].rev <= revid) {
                        device_set_descf(dev, "%s AHCI SATA controller",
                            ahci_ids[i].name);
                        return (BUS_PROBE_DEFAULT);
                }
        }
        device_set_desc(dev, "AHCI SATA controller");
        return (BUS_PROBE_DEFAULT);
}

static int
ahci_pci_attach(device_t dev)
{
        struct ahci_controller *ctlr = device_get_softc(dev);
        int     error, i;
        uint32_t devid = pci_get_devid(dev);
        uint8_t revid = pci_get_revid(dev);
        int msi_count, msix_count;
        uint32_t caps, pi;

        msi_count = pci_msi_count(dev);
        msix_count = pci_msix_count(dev);

        i = 0;
        while (ahci_ids[i].id != 0 &&
            (ahci_ids[i].id != devid ||
             ahci_ids[i].rev > revid))
                i++;
        ctlr->quirks = ahci_ids[i].quirks;

        if (ctlr->quirks & AHCI_Q_IOMMU_BUSWIDE) {
                /*
                 * The controller issues DMA requests from PCI function 1,
                 * but the device is not multifunction.
                 * Ref: https://bugzilla.kernel.org/show_bug.cgi?id=42679
                 */
                bus_dma_iommu_set_buswide(dev);
        }

        /* Limit speed for my onboard JMicron external port.
         * It is not eSATA really, limit to SATA 1 */
        if (pci_get_devid(dev) == 0x2363197b &&
            pci_get_subvendor(dev) == 0x1043 &&
            pci_get_subdevice(dev) == 0x81e4)
                ctlr->quirks |= AHCI_Q_SATA1_UNIT0;
        resource_int_value(device_get_name(dev), device_get_unit(dev),
            "quirks", &ctlr->quirks);
        ctlr->vendorid = pci_get_vendor(dev);
        ctlr->deviceid = pci_get_device(dev);
        ctlr->subvendorid = pci_get_subvendor(dev);
        ctlr->subdeviceid = pci_get_subdevice(dev);

        /* Default AHCI Base Address is BAR(5), Cavium uses BAR(0) */
        if (ctlr->quirks & AHCI_Q_ABAR0)
                ctlr->r_rid = PCIR_BAR(0);
        else
                ctlr->r_rid = PCIR_BAR(5);
        if (!(ctlr->r_mem = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
            &ctlr->r_rid, RF_ACTIVE)))
                return ENXIO;

        /*
         * Intel RAID hardware can remap NVMe devices inside its BAR.
         * Try to detect this. Either we have to add the device
         * here, or the user has to change the mode in the BIOS
         * from RST to AHCI.
         */
        if (pci_get_vendor(dev) == 0x8086 &&
            rman_get_size(ctlr->r_mem) >= 512 * 1024) {
                uint32_t vscap;

                vscap = ATA_INL(ctlr->r_mem, AHCI_VSCAP);
                if (vscap & 1) {
                        uint32_t cap = ATA_INL(ctlr->r_mem, 0x800); /* Intel's REMAP CAP */
                        int i;

                        ctlr->remap_offset = 0x4000;
                        ctlr->remap_size = 0x4000;

                        /*
                         * Check each of the devices that might be remapped to
                         * make sure they are an nvme device. At the present,
                         * nvme are the only known devices remapped.
                         */
                        for (i = 0; i < 3; i++) {
                                if (cap & (1 << i) &&
                                    (ATA_INL(ctlr->r_mem, 0x880 + i * 0x80) ==
                                     ((PCIC_STORAGE << 16) |
                                      (PCIS_STORAGE_NVM << 8) |
                                      PCIP_STORAGE_NVM_ENTERPRISE_NVMHCI_1_0))) {
                                        ctlr->remapped_devices++;
                                }
                        }

                        /* If we have any remapped device, disable MSI */
                        if (ctlr->remapped_devices > 0) {
                                device_printf(dev, "Detected %d nvme remapped devices\n",
                                    ctlr->remapped_devices);
                                ctlr->quirks |= (AHCI_Q_NOMSIX | AHCI_Q_NOMSI);
                        }
                }
        }

        if (ctlr->quirks & AHCI_Q_NOMSIX)
                msix_count = 0;

        /* Allocate resources for MSI-x table and PBA */
        if (msix_count > 0) {
                ctlr->r_msix_tab_rid = pci_msix_table_bar(dev);
                ctlr->r_msix_pba_rid = pci_msix_pba_bar(dev);

                /*
                 * Allocate new MSI-x table only if not
                 * allocated before.
                 */
                ctlr->r_msix_table = NULL;
                if (ctlr->r_msix_tab_rid != ctlr->r_rid) {
                        /* Separate BAR for MSI-x */
                        ctlr->r_msix_table = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
                            &ctlr->r_msix_tab_rid, RF_ACTIVE);
                        if (ctlr->r_msix_table == NULL) {
                                msix_count = 0;
                                goto no_msix;
                        }
                }

                /*
                 * Allocate new PBA table only if not
                 * allocated before.
                 */
                ctlr->r_msix_pba = NULL;
                if ((ctlr->r_msix_pba_rid != ctlr->r_msix_tab_rid) &&
                    (ctlr->r_msix_pba_rid != ctlr->r_rid)) {
                        /* Separate BAR for PBA */
                        ctlr->r_msix_pba = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
                            &ctlr->r_msix_pba_rid, RF_ACTIVE);
                        if (ctlr->r_msix_pba == NULL) {
                                msix_count = 0;
                        }
                }
        }

no_msix:
        pci_enable_busmaster(dev);
        /* Reset controller */
        if ((error = ahci_pci_ctlr_reset(dev)) != 0) {
                ahci_free_mem(dev);
                return (error);
        }

        /* Setup interrupts. */

        /* Setup MSI register parameters */
        /* Process hints. */
        caps = ATA_INL(ctlr->r_mem, AHCI_CAP);
        pi = ATA_INL(ctlr->r_mem, AHCI_PI);
        if (ctlr->quirks & AHCI_Q_NOMSI)
                ctlr->msi = 0;
        else if ((ctlr->quirks & AHCI_Q_1MSI) ||
            ((caps & (AHCI_CAP_NPMASK | AHCI_CAP_CCCS)) == 0 && pi == 1))
                ctlr->msi = 1;
        else
                ctlr->msi = 2;
        resource_int_value(device_get_name(dev),
            device_get_unit(dev), "msi", &ctlr->msi);
        ctlr->numirqs = 1;
        if (msi_count == 0 && msix_count == 0)
                ctlr->msi = 0;
        if (ctlr->msi < 0)
                ctlr->msi = 0;
        else if (ctlr->msi == 1) {
                msi_count = min(1, msi_count);
                msix_count = min(1, msix_count);
        } else if (ctlr->msi > 1)
                ctlr->msi = 2;

        /* Allocate MSI/MSI-x if needed/present. */
        if (ctlr->msi > 0) {
                error = ENXIO;

                /* Try to allocate MSI-x first */
                if (msix_count > 0) {
                        error = pci_alloc_msix(dev, &msix_count);
                        if (error == 0)
                                ctlr->numirqs = msix_count;
                }

                /*
                 * Try to allocate MSI if msi_count is greater than 0
                 * and if MSI-x allocation failed.
                 */
                if ((error != 0) && (msi_count > 0)) {
                        error = pci_alloc_msi(dev, &msi_count);
                        if (error == 0)
                                ctlr->numirqs = msi_count;
                }

                /* Both MSI and MSI-x allocations failed */
                if (error != 0) {
                        ctlr->msi = 0;
                        device_printf(dev, "Failed to allocate MSI/MSI-x, "
                            "falling back to INTx\n");
                }
        }

        error = ahci_attach(dev);
        if (error != 0) {
                if (ctlr->msi > 0)
                        pci_release_msi(dev);
                ahci_free_mem(dev);
        }
        return error;
}

static int
ahci_pci_detach(device_t dev)
{

        ahci_detach(dev);
        pci_release_msi(dev);
        return (0);
}

static int
ahci_pci_suspend(device_t dev)
{
        struct ahci_controller *ctlr = device_get_softc(dev);

        bus_generic_suspend(dev);
        /* Disable interupts, so the state change(s) doesn't trigger */
        ATA_OUTL(ctlr->r_mem, AHCI_GHC,
             ATA_INL(ctlr->r_mem, AHCI_GHC) & (~AHCI_GHC_IE));
        return 0;
}

static int
ahci_pci_resume(device_t dev)
{
        int res;

        if ((res = ahci_pci_ctlr_reset(dev)) != 0)
                return (res);
        ahci_ctlr_setup(dev);
        return (bus_generic_resume(dev));
}

static device_method_t ahci_methods[] = {
        DEVMETHOD(device_probe,     ahci_probe),
        DEVMETHOD(device_attach,    ahci_pci_attach),
        DEVMETHOD(device_detach,    ahci_pci_detach),
        DEVMETHOD(device_suspend,   ahci_pci_suspend),
        DEVMETHOD(device_resume,    ahci_pci_resume),
        DEVMETHOD(bus_print_child,  ahci_print_child),
        DEVMETHOD(bus_alloc_resource,       ahci_alloc_resource),
        DEVMETHOD(bus_release_resource,     ahci_release_resource),
        DEVMETHOD(bus_setup_intr,   ahci_setup_intr),
        DEVMETHOD(bus_teardown_intr,ahci_teardown_intr),
        DEVMETHOD(bus_child_location, ahci_child_location),
        DEVMETHOD(bus_get_dma_tag,  ahci_get_dma_tag),
        DEVMETHOD_END
};

static driver_t ahci_driver = {
        "ahci",
        ahci_methods,
        sizeof(struct ahci_controller)
};

DRIVER_MODULE(ahci, pci, ahci_driver, NULL, NULL);
/* Also matches class / subclass / progid XXX need to add when we have masking support */
MODULE_PNP_INFO("W32:vendor/device", pci, ahci, ahci_ids,
    nitems(ahci_ids) - 1);

static device_method_t ahci_ata_methods[] = {
        DEVMETHOD(device_probe,     ahci_ata_probe),
        DEVMETHOD(device_attach,    ahci_pci_attach),
        DEVMETHOD(device_detach,    ahci_pci_detach),
        DEVMETHOD(device_suspend,   ahci_pci_suspend),
        DEVMETHOD(device_resume,    ahci_pci_resume),
        DEVMETHOD(bus_print_child,  ahci_print_child),
        DEVMETHOD(bus_alloc_resource,       ahci_alloc_resource),
        DEVMETHOD(bus_release_resource,     ahci_release_resource),
        DEVMETHOD(bus_setup_intr,   ahci_setup_intr),
        DEVMETHOD(bus_teardown_intr,ahci_teardown_intr),
        DEVMETHOD(bus_child_location, ahci_child_location),
        DEVMETHOD_END
};

static driver_t ahci_ata_driver = {
        "ahci",
        ahci_ata_methods,
        sizeof(struct ahci_controller)
};

DRIVER_MODULE(ahci, atapci, ahci_ata_driver, NULL, NULL);