1 /* 2 * QEMU AHCI Emulation 3 * 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> 8 * 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. 13 * 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. 18 * 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/>. 21 * 22 */ 23 24 #ifndef HW_IDE_AHCI_H 25 #define HW_IDE_AHCI_H 26 27 #define AHCI_MEM_BAR_SIZE 0x1000 28 #define AHCI_MAX_PORTS 32 29 #define AHCI_MAX_SG 168 /* hardware max is 64K */ 30 #define AHCI_DMA_BOUNDARY 0xffffffff 31 #define AHCI_USE_CLUSTERING 0 32 #define AHCI_MAX_CMDS 32 33 #define AHCI_CMD_SZ 32 34 #define AHCI_CMD_SLOT_SZ (AHCI_MAX_CMDS * AHCI_CMD_SZ) 35 #define AHCI_RX_FIS_SZ 256 36 #define AHCI_CMD_TBL_CDB 0x40 37 #define AHCI_CMD_TBL_HDR_SZ 0x80 38 #define AHCI_CMD_TBL_SZ (AHCI_CMD_TBL_HDR_SZ + (AHCI_MAX_SG * 16)) 39 #define AHCI_CMD_TBL_AR_SZ (AHCI_CMD_TBL_SZ * AHCI_MAX_CMDS) 40 #define AHCI_PORT_PRIV_DMA_SZ (AHCI_CMD_SLOT_SZ + AHCI_CMD_TBL_AR_SZ + \ 41 AHCI_RX_FIS_SZ) 42 43 #define AHCI_IRQ_ON_SG (1U << 31) 44 #define AHCI_CMD_ATAPI (1 << 5) 45 #define AHCI_CMD_WRITE (1 << 6) 46 #define AHCI_CMD_PREFETCH (1 << 7) 47 #define AHCI_CMD_RESET (1 << 8) 48 #define AHCI_CMD_CLR_BUSY (1 << 10) 49 50 #define RX_FIS_D2H_REG 0x40 /* offset of D2H Register FIS data */ 51 #define RX_FIS_SDB 0x58 /* offset of SDB FIS data */ 52 #define RX_FIS_UNK 0x60 /* offset of Unknown FIS data */ 53 54 /* global controller registers */ 55 #define HOST_CAP 0x00 /* host capabilities */ 56 #define HOST_CTL 0x04 /* global host control */ 57 #define HOST_IRQ_STAT 0x08 /* interrupt status */ 58 #define HOST_PORTS_IMPL 0x0c /* bitmap of implemented ports */ 59 #define HOST_VERSION 0x10 /* AHCI spec. version compliancy */ 60 61 /* HOST_CTL bits */ 62 #define HOST_CTL_RESET (1 << 0) /* reset controller; self-clear */ 63 #define HOST_CTL_IRQ_EN (1 << 1) /* global IRQ enable */ 64 #define HOST_CTL_AHCI_EN (1U << 31) /* AHCI enabled */ 65 66 /* HOST_CAP bits */ 67 #define HOST_CAP_SSC (1 << 14) /* Slumber capable */ 68 #define HOST_CAP_AHCI (1 << 18) /* AHCI only */ 69 #define HOST_CAP_CLO (1 << 24) /* Command List Override support */ 70 #define HOST_CAP_SSS (1 << 27) /* Staggered Spin-up */ 71 #define HOST_CAP_NCQ (1 << 30) /* Native Command Queueing */ 72 #define HOST_CAP_64 (1U << 31) /* PCI DAC (64-bit DMA) support */ 73 74 /* registers for each SATA port */ 75 #define PORT_LST_ADDR 0x00 /* command list DMA addr */ 76 #define PORT_LST_ADDR_HI 0x04 /* command list DMA addr hi */ 77 #define PORT_FIS_ADDR 0x08 /* FIS rx buf addr */ 78 #define PORT_FIS_ADDR_HI 0x0c /* FIS rx buf addr hi */ 79 #define PORT_IRQ_STAT 0x10 /* interrupt status */ 80 #define PORT_IRQ_MASK 0x14 /* interrupt enable/disable mask */ 81 #define PORT_CMD 0x18 /* port command */ 82 #define PORT_TFDATA 0x20 /* taskfile data */ 83 #define PORT_SIG 0x24 /* device TF signature */ 84 #define PORT_SCR_STAT 0x28 /* SATA phy register: SStatus */ 85 #define PORT_SCR_CTL 0x2c /* SATA phy register: SControl */ 86 #define PORT_SCR_ERR 0x30 /* SATA phy register: SError */ 87 #define PORT_SCR_ACT 0x34 /* SATA phy register: SActive */ 88 #define PORT_CMD_ISSUE 0x38 /* command issue */ 89 #define PORT_RESERVED 0x3c /* reserved */ 90 91 /* PORT_IRQ_{STAT,MASK} bits */ 92 #define PORT_IRQ_COLD_PRES (1U << 31) /* cold presence detect */ 93 #define PORT_IRQ_TF_ERR (1 << 30) /* task file error */ 94 #define PORT_IRQ_HBUS_ERR (1 << 29) /* host bus fatal error */ 95 #define PORT_IRQ_HBUS_DATA_ERR (1 << 28) /* host bus data error */ 96 #define PORT_IRQ_IF_ERR (1 << 27) /* interface fatal error */ 97 #define PORT_IRQ_IF_NONFATAL (1 << 26) /* interface non-fatal error */ 98 #define PORT_IRQ_OVERFLOW (1 << 24) /* xfer exhausted available S/G */ 99 #define PORT_IRQ_BAD_PMP (1 << 23) /* incorrect port multiplier */ 100 101 #define PORT_IRQ_PHYRDY (1 << 22) /* PhyRdy changed */ 102 #define PORT_IRQ_DEV_ILCK (1 << 7) /* device interlock */ 103 #define PORT_IRQ_CONNECT (1 << 6) /* port connect change status */ 104 #define PORT_IRQ_SG_DONE (1 << 5) /* descriptor processed */ 105 #define PORT_IRQ_UNK_FIS (1 << 4) /* unknown FIS rx'd */ 106 #define PORT_IRQ_SDB_FIS (1 << 3) /* Set Device Bits FIS rx'd */ 107 #define PORT_IRQ_DMAS_FIS (1 << 2) /* DMA Setup FIS rx'd */ 108 #define PORT_IRQ_PIOS_FIS (1 << 1) /* PIO Setup FIS rx'd */ 109 #define PORT_IRQ_D2H_REG_FIS (1 << 0) /* D2H Register FIS rx'd */ 110 111 #define PORT_IRQ_FREEZE (PORT_IRQ_HBUS_ERR | PORT_IRQ_IF_ERR | \ 112 PORT_IRQ_CONNECT | PORT_IRQ_PHYRDY | \ 113 PORT_IRQ_UNK_FIS) 114 #define PORT_IRQ_ERROR (PORT_IRQ_FREEZE | PORT_IRQ_TF_ERR | \ 115 PORT_IRQ_HBUS_DATA_ERR) 116 #define DEF_PORT_IRQ (PORT_IRQ_ERROR | PORT_IRQ_SG_DONE | \ 117 PORT_IRQ_SDB_FIS | PORT_IRQ_DMAS_FIS | \ 118 PORT_IRQ_PIOS_FIS | PORT_IRQ_D2H_REG_FIS) 119 120 /* PORT_CMD bits */ 121 #define PORT_CMD_ATAPI (1 << 24) /* Device is ATAPI */ 122 #define PORT_CMD_LIST_ON (1 << 15) /* cmd list DMA engine running */ 123 #define PORT_CMD_FIS_ON (1 << 14) /* FIS DMA engine running */ 124 #define PORT_CMD_FIS_RX (1 << 4) /* Enable FIS receive DMA engine */ 125 #define PORT_CMD_CLO (1 << 3) /* Command list override */ 126 #define PORT_CMD_POWER_ON (1 << 2) /* Power up device */ 127 #define PORT_CMD_SPIN_UP (1 << 1) /* Spin up device */ 128 #define PORT_CMD_START (1 << 0) /* Enable port DMA engine */ 129 130 #define PORT_CMD_ICC_MASK (0xf << 28) /* i/f ICC state mask */ 131 #define PORT_CMD_ICC_ACTIVE (0x1 << 28) /* Put i/f in active state */ 132 #define PORT_CMD_ICC_PARTIAL (0x2 << 28) /* Put i/f in partial state */ 133 #define PORT_CMD_ICC_SLUMBER (0x6 << 28) /* Put i/f in slumber state */ 134 135 #define PORT_CMD_RO_MASK 0x007dffe0 /* Which CMD bits are read only? */ 136 137 /* ap->flags bits */ 138 #define AHCI_FLAG_NO_NCQ (1 << 24) 139 #define AHCI_FLAG_IGN_IRQ_IF_ERR (1 << 25) /* ignore IRQ_IF_ERR */ 140 #define AHCI_FLAG_HONOR_PI (1 << 26) /* honor PORTS_IMPL */ 141 #define AHCI_FLAG_IGN_SERR_INTERNAL (1 << 27) /* ignore SERR_INTERNAL */ 142 #define AHCI_FLAG_32BIT_ONLY (1 << 28) /* force 32bit */ 143 144 #define ATA_SRST (1 << 2) /* software reset */ 145 146 #define STATE_RUN 0 147 #define STATE_RESET 1 148 149 #define SATA_SCR_SSTATUS_DET_NODEV 0x0 150 #define SATA_SCR_SSTATUS_DET_DEV_PRESENT_PHY_UP 0x3 151 152 #define SATA_SCR_SSTATUS_SPD_NODEV 0x00 153 #define SATA_SCR_SSTATUS_SPD_GEN1 0x10 154 155 #define SATA_SCR_SSTATUS_IPM_NODEV 0x000 156 #define SATA_SCR_SSTATUS_IPM_ACTIVE 0X100 157 158 #define AHCI_SCR_SCTL_DET 0xf 159 160 #define SATA_FIS_TYPE_REGISTER_H2D 0x27 161 #define SATA_FIS_REG_H2D_UPDATE_COMMAND_REGISTER 0x80 162 #define SATA_FIS_TYPE_REGISTER_D2H 0x34 163 #define SATA_FIS_TYPE_PIO_SETUP 0x5f 164 #define SATA_FIS_TYPE_SDB 0xA1 165 166 #define AHCI_CMD_HDR_CMD_FIS_LEN 0x1f 167 #define AHCI_CMD_HDR_PRDT_LEN 16 168 169 #define SATA_SIGNATURE_CDROM 0xeb140000 170 #define SATA_SIGNATURE_DISK 0x00000101 171 172 #define AHCI_GENERIC_HOST_CONTROL_REGS_MAX_ADDR 0x20 173 /* Shouldn't this be 0x2c? */ 174 175 #define AHCI_PORT_REGS_START_ADDR 0x100 176 #define AHCI_PORT_ADDR_OFFSET_MASK 0x7f 177 #define AHCI_PORT_ADDR_OFFSET_LEN 0x80 178 179 #define AHCI_NUM_COMMAND_SLOTS 31 180 #define AHCI_SUPPORTED_SPEED 20 181 #define AHCI_SUPPORTED_SPEED_GEN1 1 182 #define AHCI_VERSION_1_0 0x10000 183 184 #define AHCI_PROGMODE_MAJOR_REV_1 1 185 186 #define AHCI_COMMAND_TABLE_ACMD 0x40 187 188 #define AHCI_PRDT_SIZE_MASK 0x3fffff 189 190 #define IDE_FEATURE_DMA 1 191 192 #define READ_FPDMA_QUEUED 0x60 193 #define WRITE_FPDMA_QUEUED 0x61 194 #define NCQ_NON_DATA 0x63 195 #define RECEIVE_FPDMA_QUEUED 0x65 196 #define SEND_FPDMA_QUEUED 0x64 197 198 #define NCQ_FIS_FUA_MASK 0x80 199 #define NCQ_FIS_RARC_MASK 0x01 200 201 #define RES_FIS_DSFIS 0x00 202 #define RES_FIS_PSFIS 0x20 203 #define RES_FIS_RFIS 0x40 204 #define RES_FIS_SDBFIS 0x58 205 #define RES_FIS_UFIS 0x60 206 207 #define SATA_CAP_SIZE 0x8 208 #define SATA_CAP_REV 0x2 209 #define SATA_CAP_BAR 0x4 210 211 typedef struct AHCIControlRegs { 212 uint32_t cap; 213 uint32_t ghc; 214 uint32_t irqstatus; 215 uint32_t impl; 216 uint32_t version; 217 } AHCIControlRegs; 218 219 typedef struct AHCIPortRegs { 220 uint32_t lst_addr; 221 uint32_t lst_addr_hi; 222 uint32_t fis_addr; 223 uint32_t fis_addr_hi; 224 uint32_t irq_stat; 225 uint32_t irq_mask; 226 uint32_t cmd; 227 uint32_t unused0; 228 uint32_t tfdata; 229 uint32_t sig; 230 uint32_t scr_stat; 231 uint32_t scr_ctl; 232 uint32_t scr_err; 233 uint32_t scr_act; 234 uint32_t cmd_issue; 235 uint32_t reserved; 236 } AHCIPortRegs; 237 238 typedef struct AHCICmdHdr { 239 uint16_t opts; 240 uint16_t prdtl; 241 uint32_t status; 242 uint64_t tbl_addr; 243 uint32_t reserved[4]; 244 } QEMU_PACKED AHCICmdHdr; 245 246 typedef struct AHCI_SG { 247 uint64_t addr; 248 uint32_t reserved; 249 uint32_t flags_size; 250 } QEMU_PACKED AHCI_SG; 251 252 typedef struct AHCIDevice AHCIDevice; 253 254 typedef struct NCQTransferState { 255 AHCIDevice *drive; 256 BlockAIOCB *aiocb; 257 QEMUSGList sglist; 258 BlockAcctCookie acct; 259 uint16_t sector_count; 260 uint64_t lba; 261 uint8_t tag; 262 uint8_t cmd; 263 int slot; 264 int used; 265 bool halt; 266 } NCQTransferState; 267 268 struct AHCIDevice { 269 IDEDMA dma; 270 IDEBus port; 271 int port_no; 272 uint32_t port_state; 273 uint32_t finished; 274 AHCIPortRegs port_regs; 275 struct AHCIState *hba; 276 QEMUBH *check_bh; 277 uint8_t *lst; 278 uint8_t *res_fis; 279 bool done_atapi_packet; 280 int32_t busy_slot; 281 bool init_d2h_sent; 282 AHCICmdHdr *cur_cmd; 283 NCQTransferState ncq_tfs[AHCI_MAX_CMDS]; 284 }; 285 286 typedef struct AHCIState { 287 AHCIDevice *dev; 288 AHCIControlRegs control_regs; 289 MemoryRegion mem; 290 MemoryRegion idp; /* Index-Data Pair I/O port space */ 291 unsigned idp_offset; /* Offset of index in I/O port space */ 292 uint32_t idp_index; /* Current IDP index */ 293 int32_t ports; 294 qemu_irq irq; 295 AddressSpace *as; 296 } AHCIState; 297 298 typedef struct AHCIPCIState { 299 /*< private >*/ 300 PCIDevice parent_obj; 301 /*< public >*/ 302 303 AHCIState ahci; 304 } AHCIPCIState; 305 306 #define TYPE_ICH9_AHCI "ich9-ahci" 307 308 #define ICH_AHCI(obj) \ 309 OBJECT_CHECK(AHCIPCIState, (obj), TYPE_ICH9_AHCI) 310 311 extern const VMStateDescription vmstate_ahci; 312 313 #define VMSTATE_AHCI(_field, _state) { \ 314 .name = (stringify(_field)), \ 315 .size = sizeof(AHCIState), \ 316 .vmsd = &vmstate_ahci, \ 317 .flags = VMS_STRUCT, \ 318 .offset = vmstate_offset_value(_state, _field, AHCIState), \ 319 } 320 321 /** 322 * NCQFrame is the same as a Register H2D FIS (described in SATA 3.2), 323 * but some fields have been re-mapped and re-purposed, as seen in 324 * SATA 3.2 section 13.6.4.1 ("READ FPDMA QUEUED") 325 * 326 * cmd_fis[3], feature 7:0, becomes sector count 7:0. 327 * cmd_fis[7], device 7:0, uses bit 7 as the Force Unit Access bit. 328 * cmd_fis[11], feature 15:8, becomes sector count 15:8. 329 * cmd_fis[12], count 7:0, becomes the NCQ TAG (7:3) and RARC bit (0) 330 * cmd_fis[13], count 15:8, becomes the priority value (7:6) 331 * bytes 16-19 become an le32 "auxiliary" field. 332 */ 333 typedef struct NCQFrame { 334 uint8_t fis_type; 335 uint8_t c; 336 uint8_t command; 337 uint8_t sector_count_low; /* (feature 7:0) */ 338 uint8_t lba0; 339 uint8_t lba1; 340 uint8_t lba2; 341 uint8_t fua; /* (device 7:0) */ 342 uint8_t lba3; 343 uint8_t lba4; 344 uint8_t lba5; 345 uint8_t sector_count_high; /* (feature 15:8) */ 346 uint8_t tag; /* (count 0:7) */ 347 uint8_t prio; /* (count 15:8) */ 348 uint8_t icc; 349 uint8_t control; 350 uint8_t aux0; 351 uint8_t aux1; 352 uint8_t aux2; 353 uint8_t aux3; 354 } QEMU_PACKED NCQFrame; 355 356 typedef struct SDBFIS { 357 uint8_t type; 358 uint8_t flags; 359 uint8_t status; 360 uint8_t error; 361 uint32_t payload; 362 } QEMU_PACKED SDBFIS; 363 364 void ahci_init(AHCIState *s, DeviceState *qdev, AddressSpace *as, int ports); 365 void ahci_uninit(AHCIState *s); 366 367 void ahci_reset(AHCIState *s); 368 369 void ahci_ide_create_devs(PCIDevice *dev, DriveInfo **hd); 370 371 #endif /* HW_IDE_AHCI_H */ 372