tests/libqos/ahci.h

   1 #ifndef __libqos_ahci_h
   2 #define __libqos_ahci_h
   3
   4 /*
   5  * AHCI qtest library functions and definitions
   6  *
   7  * Copyright (c) 2014 John Snow <jsnow@redhat.com>
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  22  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25  * THE SOFTWARE.
  26  */
  27
  28 #include <stdint.h>
  29 #include <stdlib.h>
  30 #include <stdbool.h>
  31 #include "libqos/libqos.h"
  32 #include "libqos/pci.h"
  33 #include "libqos/malloc-pc.h"
  34
  35 /*** Supplementary PCI Config Space IDs & Masks ***/
  36 #define PCI_DEVICE_ID_INTEL_Q35_AHCI   (0x2922)
  37 #define PCI_MSI_FLAGS_RESERVED         (0xFF00)
  38 #define PCI_PM_CTRL_RESERVED             (0xFC)
  39 #define PCI_BCC(REG32)          ((REG32) >> 24)
  40 #define PCI_PI(REG32)   (((REG32) >> 8) & 0xFF)
  41 #define PCI_SCC(REG32) (((REG32) >> 16) & 0xFF)
  42
  43 /*** Recognized AHCI Device Types ***/
  44 #define AHCI_INTEL_ICH9 (PCI_DEVICE_ID_INTEL_Q35_AHCI << 16 | \
  45                          PCI_VENDOR_ID_INTEL)
  46
  47 /*** AHCI/HBA Register Offsets and Bitmasks ***/
  48 #define AHCI_CAP                          (0)
  49 #define AHCI_CAP_NP                    (0x1F)
  50 #define AHCI_CAP_SXS                   (0x20)
  51 #define AHCI_CAP_EMS                   (0x40)
  52 #define AHCI_CAP_CCCS                  (0x80)
  53 #define AHCI_CAP_NCS                 (0x1F00)
  54 #define AHCI_CAP_PSC                 (0x2000)
  55 #define AHCI_CAP_SSC                 (0x4000)
  56 #define AHCI_CAP_PMD                 (0x8000)
  57 #define AHCI_CAP_FBSS               (0x10000)
  58 #define AHCI_CAP_SPM                (0x20000)
  59 #define AHCI_CAP_SAM                (0x40000)
  60 #define AHCI_CAP_RESERVED           (0x80000)
  61 #define AHCI_CAP_ISS               (0xF00000)
  62 #define AHCI_CAP_SCLO             (0x1000000)
  63 #define AHCI_CAP_SAL              (0x2000000)
  64 #define AHCI_CAP_SALP             (0x4000000)
  65 #define AHCI_CAP_SSS              (0x8000000)
  66 #define AHCI_CAP_SMPS            (0x10000000)
  67 #define AHCI_CAP_SSNTF           (0x20000000)
  68 #define AHCI_CAP_SNCQ            (0x40000000)
  69 #define AHCI_CAP_S64A            (0x80000000)
  70
  71 #define AHCI_GHC                          (1)
  72 #define AHCI_GHC_HR                    (0x01)
  73 #define AHCI_GHC_IE                    (0x02)
  74 #define AHCI_GHC_MRSM                  (0x04)
  75 #define AHCI_GHC_RESERVED        (0x7FFFFFF8)
  76 #define AHCI_GHC_AE              (0x80000000)
  77
  78 #define AHCI_IS                           (2)
  79 #define AHCI_PI                           (3)
  80 #define AHCI_VS                           (4)
  81
  82 #define AHCI_CCCCTL                       (5)
  83 #define AHCI_CCCCTL_EN                 (0x01)
  84 #define AHCI_CCCCTL_RESERVED           (0x06)
  85 #define AHCI_CCCCTL_CC               (0xFF00)
  86 #define AHCI_CCCCTL_TV           (0xFFFF0000)
  87
  88 #define AHCI_CCCPORTS                     (6)
  89 #define AHCI_EMLOC                        (7)
  90
  91 #define AHCI_EMCTL                        (8)
  92 #define AHCI_EMCTL_STSMR               (0x01)
  93 #define AHCI_EMCTL_CTLTM              (0x100)
  94 #define AHCI_EMCTL_CTLRST             (0x200)
  95 #define AHCI_EMCTL_RESERVED      (0xF0F0FCFE)
  96
  97 #define AHCI_CAP2                         (9)
  98 #define AHCI_CAP2_BOH                  (0x01)
  99 #define AHCI_CAP2_NVMP                 (0x02)
 100 #define AHCI_CAP2_APST                 (0x04)
 101 #define AHCI_CAP2_RESERVED       (0xFFFFFFF8)
 102
 103 #define AHCI_BOHC                        (10)
 104 #define AHCI_RESERVED                    (11)
 105 #define AHCI_NVMHCI                      (24)
 106 #define AHCI_VENDOR                      (40)
 107 #define AHCI_PORTS                       (64)
 108
 109 /*** Port Memory Offsets & Bitmasks ***/
 110 #define AHCI_PX_CLB                       (0)
 111 #define AHCI_PX_CLB_RESERVED          (0x1FF)
 112
 113 #define AHCI_PX_CLBU                      (1)
 114
 115 #define AHCI_PX_FB                        (2)
 116 #define AHCI_PX_FB_RESERVED            (0xFF)
 117
 118 #define AHCI_PX_FBU                       (3)
 119
 120 #define AHCI_PX_IS                        (4)
 121 #define AHCI_PX_IS_DHRS                 (0x1)
 122 #define AHCI_PX_IS_PSS                  (0x2)
 123 #define AHCI_PX_IS_DSS                  (0x4)
 124 #define AHCI_PX_IS_SDBS                 (0x8)
 125 #define AHCI_PX_IS_UFS                 (0x10)
 126 #define AHCI_PX_IS_DPS                 (0x20)
 127 #define AHCI_PX_IS_PCS                 (0x40)
 128 #define AHCI_PX_IS_DMPS                (0x80)
 129 #define AHCI_PX_IS_RESERVED       (0x23FFF00)
 130 #define AHCI_PX_IS_PRCS            (0x400000)
 131 #define AHCI_PX_IS_IPMS            (0x800000)
 132 #define AHCI_PX_IS_OFS            (0x1000000)
 133 #define AHCI_PX_IS_INFS           (0x4000000)
 134 #define AHCI_PX_IS_IFS            (0x8000000)
 135 #define AHCI_PX_IS_HBDS          (0x10000000)
 136 #define AHCI_PX_IS_HBFS          (0x20000000)
 137 #define AHCI_PX_IS_TFES          (0x40000000)
 138 #define AHCI_PX_IS_CPDS          (0x80000000)
 139
 140 #define AHCI_PX_IE                        (5)
 141 #define AHCI_PX_IE_DHRE                 (0x1)
 142 #define AHCI_PX_IE_PSE                  (0x2)
 143 #define AHCI_PX_IE_DSE                  (0x4)
 144 #define AHCI_PX_IE_SDBE                 (0x8)
 145 #define AHCI_PX_IE_UFE                 (0x10)
 146 #define AHCI_PX_IE_DPE                 (0x20)
 147 #define AHCI_PX_IE_PCE                 (0x40)
 148 #define AHCI_PX_IE_DMPE                (0x80)
 149 #define AHCI_PX_IE_RESERVED       (0x23FFF00)
 150 #define AHCI_PX_IE_PRCE            (0x400000)
 151 #define AHCI_PX_IE_IPME            (0x800000)
 152 #define AHCI_PX_IE_OFE            (0x1000000)
 153 #define AHCI_PX_IE_INFE           (0x4000000)
 154 #define AHCI_PX_IE_IFE            (0x8000000)
 155 #define AHCI_PX_IE_HBDE          (0x10000000)
 156 #define AHCI_PX_IE_HBFE          (0x20000000)
 157 #define AHCI_PX_IE_TFEE          (0x40000000)
 158 #define AHCI_PX_IE_CPDE          (0x80000000)
 159
 160 #define AHCI_PX_CMD                       (6)
 161 #define AHCI_PX_CMD_ST                  (0x1)
 162 #define AHCI_PX_CMD_SUD                 (0x2)
 163 #define AHCI_PX_CMD_POD                 (0x4)
 164 #define AHCI_PX_CMD_CLO                 (0x8)
 165 #define AHCI_PX_CMD_FRE                (0x10)
 166 #define AHCI_PX_CMD_RESERVED           (0xE0)
 167 #define AHCI_PX_CMD_CCS              (0x1F00)
 168 #define AHCI_PX_CMD_MPSS             (0x2000)
 169 #define AHCI_PX_CMD_FR               (0x4000)
 170 #define AHCI_PX_CMD_CR               (0x8000)
 171 #define AHCI_PX_CMD_CPS             (0x10000)
 172 #define AHCI_PX_CMD_PMA             (0x20000)
 173 #define AHCI_PX_CMD_HPCP            (0x40000)
 174 #define AHCI_PX_CMD_MPSP            (0x80000)
 175 #define AHCI_PX_CMD_CPD            (0x100000)
 176 #define AHCI_PX_CMD_ESP            (0x200000)
 177 #define AHCI_PX_CMD_FBSCP          (0x400000)
 178 #define AHCI_PX_CMD_APSTE          (0x800000)
 179 #define AHCI_PX_CMD_ATAPI         (0x1000000)
 180 #define AHCI_PX_CMD_DLAE          (0x2000000)
 181 #define AHCI_PX_CMD_ALPE          (0x4000000)
 182 #define AHCI_PX_CMD_ASP           (0x8000000)
 183 #define AHCI_PX_CMD_ICC          (0xF0000000)
 184
 185 #define AHCI_PX_RES1                      (7)
 186
 187 #define AHCI_PX_TFD                       (8)
 188 #define AHCI_PX_TFD_STS                (0xFF)
 189 #define AHCI_PX_TFD_STS_ERR            (0x01)
 190 #define AHCI_PX_TFD_STS_CS1            (0x06)
 191 #define AHCI_PX_TFD_STS_DRQ            (0x08)
 192 #define AHCI_PX_TFD_STS_CS2            (0x70)
 193 #define AHCI_PX_TFD_STS_BSY            (0x80)
 194 #define AHCI_PX_TFD_ERR              (0xFF00)
 195 #define AHCI_PX_TFD_RESERVED     (0xFFFF0000)
 196
 197 #define AHCI_PX_SIG                       (9)
 198 #define AHCI_PX_SIG_SECTOR_COUNT       (0xFF)
 199 #define AHCI_PX_SIG_LBA_LOW          (0xFF00)
 200 #define AHCI_PX_SIG_LBA_MID        (0xFF0000)
 201 #define AHCI_PX_SIG_LBA_HIGH     (0xFF000000)
 202
 203 #define AHCI_PX_SSTS                     (10)
 204 #define AHCI_PX_SSTS_DET               (0x0F)
 205 #define AHCI_PX_SSTS_SPD               (0xF0)
 206 #define AHCI_PX_SSTS_IPM              (0xF00)
 207 #define AHCI_PX_SSTS_RESERVED    (0xFFFFF000)
 208 #define SSTS_DET_NO_DEVICE             (0x00)
 209 #define SSTS_DET_PRESENT               (0x01)
 210 #define SSTS_DET_ESTABLISHED           (0x03)
 211 #define SSTS_DET_OFFLINE               (0x04)
 212
 213 #define AHCI_PX_SCTL                     (11)
 214
 215 #define AHCI_PX_SERR                     (12)
 216 #define AHCI_PX_SERR_ERR             (0xFFFF)
 217 #define AHCI_PX_SERR_DIAG        (0xFFFF0000)
 218 #define AHCI_PX_SERR_DIAG_X      (0x04000000)
 219
 220 #define AHCI_PX_SACT                     (13)
 221 #define AHCI_PX_CI                       (14)
 222 #define AHCI_PX_SNTF                     (15)
 223
 224 #define AHCI_PX_FBS                      (16)
 225 #define AHCI_PX_FBS_EN                  (0x1)
 226 #define AHCI_PX_FBS_DEC                 (0x2)
 227 #define AHCI_PX_FBS_SDE                 (0x4)
 228 #define AHCI_PX_FBS_DEV               (0xF00)
 229 #define AHCI_PX_FBS_ADO              (0xF000)
 230 #define AHCI_PX_FBS_DWE             (0xF0000)
 231 #define AHCI_PX_FBS_RESERVED     (0xFFF000F8)
 232
 233 #define AHCI_PX_RES2                     (17)
 234 #define AHCI_PX_VS                       (28)
 235
 236 #define HBA_DATA_REGION_SIZE            (256)
 237 #define HBA_PORT_DATA_SIZE              (128)
 238 #define HBA_PORT_NUM_REG (HBA_PORT_DATA_SIZE/4)
 239
 240 #define AHCI_VERSION_0_95        (0x00000905)
 241 #define AHCI_VERSION_1_0         (0x00010000)
 242 #define AHCI_VERSION_1_1         (0x00010100)
 243 #define AHCI_VERSION_1_2         (0x00010200)
 244 #define AHCI_VERSION_1_3         (0x00010300)
 245
 246 /*** Structures ***/
 247
 248 typedef struct AHCIPortQState {
 249     uint64_t fb;
 250     uint64_t clb;
 251     uint64_t ctba[32];
 252     uint16_t prdtl[32];
 253     uint8_t next; /** Next Command Slot to Use **/
 254 } AHCIPortQState;
 255
 256 typedef struct AHCIQState {
 257     QOSState *parent;
 258     QPCIDevice *dev;
 259     void *hba_base;
 260     uint64_t barsize;
 261     uint32_t fingerprint;
 262     uint32_t cap;
 263     uint32_t cap2;
 264     AHCIPortQState port[32];
 265 } AHCIQState;
 266
 267 /**
 268  * Generic FIS structure.
 269  */
 270 typedef struct FIS {
 271     uint8_t fis_type;
 272     uint8_t flags;
 273     char data[0];
 274 } __attribute__((__packed__)) FIS;
 275
 276 /**
 277  * Register device-to-host FIS structure.
 278  */
 279 typedef struct RegD2HFIS {
 280     /* DW0 */
 281     uint8_t fis_type;
 282     uint8_t flags;
 283     uint8_t status;
 284     uint8_t error;
 285     /* DW1 */
 286     uint8_t lba_low;
 287     uint8_t lba_mid;
 288     uint8_t lba_high;
 289     uint8_t device;
 290     /* DW2 */
 291     uint8_t lba3;
 292     uint8_t lba4;
 293     uint8_t lba5;
 294     uint8_t res1;
 295     /* DW3 */
 296     uint16_t count;
 297     uint8_t res2;
 298     uint8_t res3;
 299     /* DW4 */
 300     uint16_t res4;
 301     uint16_t res5;
 302 } __attribute__((__packed__)) RegD2HFIS;
 303
 304 /**
 305  * Register host-to-device FIS structure.
 306  */
 307 typedef struct RegH2DFIS {
 308     /* DW0 */
 309     uint8_t fis_type;
 310     uint8_t flags;
 311     uint8_t command;
 312     uint8_t feature_low;
 313     /* DW1 */
 314     uint8_t lba_low;
 315     uint8_t lba_mid;
 316     uint8_t lba_high;
 317     uint8_t device;
 318     /* DW2 */
 319     uint8_t lba3;
 320     uint8_t lba4;
 321     uint8_t lba5;
 322     uint8_t feature_high;
 323     /* DW3 */
 324     uint16_t count;
 325     uint8_t icc;
 326     uint8_t control;
 327     /* DW4 */
 328     uint32_t aux;
 329 } __attribute__((__packed__)) RegH2DFIS;
 330
 331 /**
 332  * Command List entry structure.
 333  * The command list contains between 1-32 of these structures.
 334  */
 335 typedef struct AHCICommandHeader {
 336     uint16_t flags; /* Cmd-Fis-Len, PMP#, and flags. */
 337     uint16_t prdtl; /* Phys Region Desc. Table Length */
 338     uint32_t prdbc; /* Phys Region Desc. Byte Count */
 339     uint64_t ctba;  /* Command Table Descriptor Base Address */
 340     uint32_t res[4];
 341 } __attribute__((__packed__)) AHCICommandHeader;
 342
 343 /**
 344  * Physical Region Descriptor; pointed to by the Command List Header,
 345  * struct ahci_command.
 346  */
 347 typedef struct PRD {
 348     uint64_t dba;  /* Data Base Address */
 349     uint32_t res;  /* Reserved */
 350     uint32_t dbc;  /* Data Byte Count (0-indexed) & Interrupt Flag (bit 2^31) */
 351 } __attribute__((__packed__)) PRD;
 352
 353 /*** Macro Utilities ***/
 354 #define BITANY(data, mask) (((data) & (mask)) != 0)
 355 #define BITSET(data, mask) (((data) & (mask)) == (mask))
 356 #define BITCLR(data, mask) (((data) & (mask)) == 0)
 357 #define ASSERT_BIT_SET(data, mask) g_assert_cmphex((data) & (mask), ==, (mask))
 358 #define ASSERT_BIT_CLEAR(data, mask) g_assert_cmphex((data) & (mask), ==, 0)
 359
 360 /* For calculating how big the PRD table needs to be: */
 361 #define CMD_TBL_SIZ(n) ((0x80 + ((n) * sizeof(PRD)) + 0x7F) & ~0x7F)
 362
 363 /* Helpers for reading/writing AHCI HBA register values */
 364
 365 static inline uint32_t ahci_mread(AHCIQState *ahci, size_t offset)
 366 {
 367     return qpci_io_readl(ahci->dev, ahci->hba_base + offset);
 368 }
 369
 370 static inline void ahci_mwrite(AHCIQState *ahci, size_t offset, uint32_t value)
 371 {
 372     qpci_io_writel(ahci->dev, ahci->hba_base + offset, value);
 373 }
 374
 375 static inline uint32_t ahci_rreg(AHCIQState *ahci, uint32_t reg_num)
 376 {
 377     return ahci_mread(ahci, 4 * reg_num);
 378 }
 379
 380 static inline void ahci_wreg(AHCIQState *ahci, uint32_t reg_num, uint32_t value)
 381 {
 382     ahci_mwrite(ahci, 4 * reg_num, value);
 383 }
 384
 385 static inline void ahci_set(AHCIQState *ahci, uint32_t reg_num, uint32_t mask)
 386 {
 387     ahci_wreg(ahci, reg_num, ahci_rreg(ahci, reg_num) | mask);
 388 }
 389
 390 static inline void ahci_clr(AHCIQState *ahci, uint32_t reg_num, uint32_t mask)
 391 {
 392     ahci_wreg(ahci, reg_num, ahci_rreg(ahci, reg_num) & ~mask);
 393 }
 394
 395 static inline size_t ahci_px_offset(uint8_t port, uint32_t reg_num)
 396 {
 397     return AHCI_PORTS + (HBA_PORT_NUM_REG * port) + reg_num;
 398 }
 399
 400 static inline uint32_t ahci_px_rreg(AHCIQState *ahci, uint8_t port,
 401                                     uint32_t reg_num)
 402 {
 403     return ahci_rreg(ahci, ahci_px_offset(port, reg_num));
 404 }
 405
 406 static inline void ahci_px_wreg(AHCIQState *ahci, uint8_t port,
 407                                 uint32_t reg_num, uint32_t value)
 408 {
 409     ahci_wreg(ahci, ahci_px_offset(port, reg_num), value);
 410 }
 411
 412 static inline void ahci_px_set(AHCIQState *ahci, uint8_t port,
 413                                uint32_t reg_num, uint32_t mask)
 414 {
 415     ahci_px_wreg(ahci, port, reg_num,
 416                  ahci_px_rreg(ahci, port, reg_num) | mask);
 417 }
 418
 419 static inline void ahci_px_clr(AHCIQState *ahci, uint8_t port,
 420                                uint32_t reg_num, uint32_t mask)
 421 {
 422     ahci_px_wreg(ahci, port, reg_num,
 423                  ahci_px_rreg(ahci, port, reg_num) & ~mask);
 424 }
 425
 426 /*** Prototypes ***/
 427 uint64_t ahci_alloc(AHCIQState *ahci, size_t bytes);
 428 void ahci_free(AHCIQState *ahci, uint64_t addr);
 429 QPCIDevice *get_ahci_device(uint32_t *fingerprint);
 430 void free_ahci_device(QPCIDevice *dev);
 431 void ahci_pci_enable(AHCIQState *ahci);
 432 void start_ahci_device(AHCIQState *ahci);
 433 void ahci_hba_enable(AHCIQState *ahci);
 434 unsigned ahci_port_select(AHCIQState *ahci);
 435 void ahci_port_clear(AHCIQState *ahci, uint8_t port);
 436 void ahci_port_check_error(AHCIQState *ahci, uint8_t port);
 437 void ahci_port_check_interrupts(AHCIQState *ahci, uint8_t port,
 438                                 uint32_t intr_mask);
 439 void ahci_port_check_nonbusy(AHCIQState *ahci, uint8_t port, uint8_t slot);
 440 void ahci_get_command_header(AHCIQState *ahci, uint8_t port,
 441                              uint8_t slot, AHCICommandHeader *cmd);
 442 void ahci_set_command_header(AHCIQState *ahci, uint8_t port,
 443                              uint8_t slot, AHCICommandHeader *cmd);
 444 void ahci_destroy_command(AHCIQState *ahci, uint8_t port, uint8_t slot);
 445 unsigned ahci_pick_cmd(AHCIQState *ahci, uint8_t port);
 446
 447 #endif