hw/ide/internal.h

   1 #ifndef HW_IDE_INTERNAL_H
   2 #define HW_IDE_INTERNAL_H
   3
   4 /*
   5  * QEMU IDE Emulation -- internal header file
   6  * only files in hw/ide/ are supposed to include this file.
   7  * non-internal declarations are in hw/ide.h
   8  */
   9 #include <hw/ide.h>
  10 #include "iorange.h"
  11 #include "dma.h"
  12 #include "sysemu.h"
  13
  14 /* debug IDE devices */
  15 //#define DEBUG_IDE
  16 //#define DEBUG_IDE_ATAPI
  17 //#define DEBUG_AIO
  18 #define USE_DMA_CDROM
  19
  20 typedef struct IDEBus IDEBus;
  21 typedef struct IDEDevice IDEDevice;
  22 typedef struct IDEDeviceInfo IDEDeviceInfo;
  23 typedef struct IDEState IDEState;
  24 typedef struct IDEDMA IDEDMA;
  25 typedef struct IDEDMAOps IDEDMAOps;
  26
  27 /* Bits of HD_STATUS */
  28 #define ERR_STAT                0x01
  29 #define INDEX_STAT              0x02
  30 #define ECC_STAT                0x04    /* Corrected error */
  31 #define DRQ_STAT                0x08
  32 #define SEEK_STAT               0x10
  33 #define SRV_STAT                0x10
  34 #define WRERR_STAT              0x20
  35 #define READY_STAT              0x40
  36 #define BUSY_STAT               0x80
  37
  38 /* Bits for HD_ERROR */
  39 #define MARK_ERR                0x01    /* Bad address mark */
  40 #define TRK0_ERR                0x02    /* couldn't find track 0 */
  41 #define ABRT_ERR                0x04    /* Command aborted */
  42 #define MCR_ERR                 0x08    /* media change request */
  43 #define ID_ERR                  0x10    /* ID field not found */
  44 #define MC_ERR                  0x20    /* media changed */
  45 #define ECC_ERR                 0x40    /* Uncorrectable ECC error */
  46 #define BBD_ERR                 0x80    /* pre-EIDE meaning:  block marked bad */
  47 #define ICRC_ERR                0x80    /* new meaning:  CRC error during transfer */
  48
  49 /* Bits of HD_NSECTOR */
  50 #define CD                      0x01
  51 #define IO                      0x02
  52 #define REL                     0x04
  53 #define TAG_MASK                0xf8
  54
  55 #define IDE_CMD_RESET           0x04
  56 #define IDE_CMD_DISABLE_IRQ     0x02
  57
  58 /* ACS-2 T13/2015-D Table B.2 Command codes */
  59 #define WIN_NOP                         0x00
  60 /* reserved                             0x01..0x02 */
  61 #define CFA_REQ_EXT_ERROR_CODE          0x03 /* CFA Request Extended Error Code */
  62 /* reserved                             0x04..0x05 */
  63 #define WIN_DSM                         0x06
  64 /* reserved                             0x07 */
  65 #define WIN_DEVICE_RESET                0x08
  66 /* reserved                             0x09..0x0a */
  67 /* REQUEST SENSE DATA EXT               0x0B */
  68 /* reserved                             0x0C..0x0F */
  69 #define WIN_RECAL                       0x10 /* obsolete since ATA4 */
  70 /* obsolete since ATA3, retired in ATA4 0x11..0x1F */
  71 #define WIN_READ                        0x20 /* 28-Bit */
  72 #define WIN_READ_ONCE                   0x21 /* 28-Bit w/o retries, obsolete since ATA5 */
  73 /* obsolete since ATA4                  0x22..0x23 */
  74 #define WIN_READ_EXT                    0x24 /* 48-Bit */
  75 #define WIN_READDMA_EXT                 0x25 /* 48-Bit */
  76 #define WIN_READDMA_QUEUED_EXT          0x26 /* 48-Bit, obsolete since ACS2 */
  77 #define WIN_READ_NATIVE_MAX_EXT         0x27 /* 48-Bit */
  78 /* reserved                             0x28 */
  79 #define WIN_MULTREAD_EXT                0x29 /* 48-Bit */
  80 /* READ STREAM DMA EXT                  0x2A */
  81 /* READ STREAM EXT                      0x2B */
  82 /* reserved                             0x2C..0x2E */
  83 /* READ LOG EXT                         0x2F */
  84 #define WIN_WRITE                       0x30 /* 28-Bit */
  85 #define WIN_WRITE_ONCE                  0x31 /* 28-Bit w/o retries, obsolete since ATA5 */
  86 /* obsolete since ATA4                  0x32..0x33 */
  87 #define WIN_WRITE_EXT                   0x34 /* 48-Bit */
  88 #define WIN_WRITEDMA_EXT                0x35 /* 48-Bit */
  89 #define WIN_WRITEDMA_QUEUED_EXT         0x36 /* 48-Bit */
  90 #define WIN_SET_MAX_EXT                 0x37 /* 48-Bit, obsolete since ACS2 */
  91 #define WIN_SET_MAX_EXT                 0x37 /* 48-Bit */
  92 #define CFA_WRITE_SECT_WO_ERASE         0x38 /* CFA Write Sectors without erase */
  93 #define WIN_MULTWRITE_EXT               0x39 /* 48-Bit */
  94 /* WRITE STREAM DMA EXT                 0x3A */
  95 /* WRITE STREAM EXT                     0x3B */
  96 #define WIN_WRITE_VERIFY                0x3C /* 28-Bit, obsolete since ATA4 */
  97 /* WRITE DMA FUA EXT                    0x3D */
  98 /* obsolete since ACS2                  0x3E */
  99 /* WRITE LOG EXT                        0x3F */
 100 #define WIN_VERIFY                      0x40 /* 28-Bit - Read Verify Sectors */
 101 #define WIN_VERIFY_ONCE                 0x41 /* 28-Bit - w/o retries, obsolete since ATA5 */
 102 #define WIN_VERIFY_EXT                  0x42 /* 48-Bit */
 103 /* reserved                             0x43..0x44 */
 104 /* WRITE UNCORRECTABLE EXT              0x45 */
 105 /* reserved                             0x46 */
 106 /* READ LOG DMA EXT                     0x47 */
 107 /* reserved                             0x48..0x4F */
 108 /* obsolete since ATA4                  0x50 */
 109 /* CONFIGURE STREAM                     0x51 */
 110 /* reserved                             0x52..0x56 */
 111 /* WRITE LOG DMA EXT                    0x57 */
 112 /* reserved                             0x58..0x5A */
 113 /* TRUSTED NON DATA                     0x5B */
 114 /* TRUSTED RECEIVE                      0x5C */
 115 /* TRUSTED RECEIVE DMA                  0x5D */
 116 /* TRUSTED SEND                         0x5E */
 117 /* TRUSTED SEND DMA                     0x5F */
 118 /* READ FPDMA QUEUED                    0x60 */
 119 /* WRITE FPDMA QUEUED                   0x61 */
 120 /* reserved                             0x62->0x6F */
 121 #define WIN_SEEK                        0x70 /* obsolete since ATA7 */
 122 /* reserved                             0x71-0x7F */
 123 /* vendor specific                      0x80-0x86 */
 124 #define CFA_TRANSLATE_SECTOR            0x87 /* CFA Translate Sector */
 125 /* vendor specific                      0x88-0x8F */
 126 #define WIN_DIAGNOSE                    0x90
 127 #define WIN_SPECIFY                     0x91 /* set drive geometry translation, obsolete since ATA6 */
 128 #define WIN_DOWNLOAD_MICROCODE          0x92
 129 /* DOWNLOAD MICROCODE DMA               0x93 */
 130 #define WIN_STANDBYNOW2                 0x94 /* retired in ATA4 */
 131 #define WIN_IDLEIMMEDIATE2              0x95 /* force drive to become "ready", retired in ATA4 */
 132 #define WIN_STANDBY2                    0x96 /* retired in ATA4 */
 133 #define WIN_SETIDLE2                    0x97 /* retired in ATA4 */
 134 #define WIN_CHECKPOWERMODE2             0x98 /* retired in ATA4 */
 135 #define WIN_SLEEPNOW2                   0x99 /* retired in ATA4 */
 136 /* vendor specific                      0x9A */
 137 /* reserved                             0x9B..0x9F */
 138 #define WIN_PACKETCMD                   0xA0 /* Send a packet command. */
 139 #define WIN_PIDENTIFY                   0xA1 /* identify ATAPI device   */
 140 #define WIN_QUEUED_SERVICE              0xA2 /* obsolete since ACS2 */
 141 /* reserved                             0xA3..0xAF */
 142 #define WIN_SMART                       0xB0 /* self-monitoring and reporting */
 143 /* Device Configuration Overlay         0xB1 */
 144 /* reserved                             0xB2..0xB3 */
 145 /* Sanitize Device                      0xB4 */
 146 /* reserved                             0xB5 */
 147 /* NV Cache                             0xB6 */
 148 /* reserved for CFA                     0xB7..0xBB */
 149 #define CFA_ACCESS_METADATA_STORAGE     0xB8
 150 /* reserved                             0xBC..0xBF */
 151 #define CFA_ERASE_SECTORS               0xC0 /* microdrives implement as NOP */
 152 /* vendor specific                      0xC1..0xC3 */
 153 #define WIN_MULTREAD                    0xC4 /* read sectors using multiple mode*/
 154 #define WIN_MULTWRITE                   0xC5 /* write sectors using multiple mode */
 155 #define WIN_SETMULT                     0xC6 /* enable/disable multiple mode */
 156 #define WIN_READDMA_QUEUED              0xC7 /* read sectors using Queued DMA transfers, obsolete since ACS2 */
 157 #define WIN_READDMA                     0xC8 /* read sectors using DMA transfers */
 158 #define WIN_READDMA_ONCE                0xC9 /* 28-Bit - w/o retries, obsolete since ATA5 */
 159 #define WIN_WRITEDMA                    0xCA /* write sectors using DMA transfers */
 160 #define WIN_WRITEDMA_ONCE               0xCB /* 28-Bit - w/o retries, obsolete since ATA5 */
 161 #define WIN_WRITEDMA_QUEUED             0xCC /* write sectors using Queued DMA transfers, obsolete since ACS2 */
 162 #define CFA_WRITE_MULTI_WO_ERASE        0xCD /* CFA Write multiple without erase */
 163 /* WRITE MULTIPLE FUA EXT               0xCE */
 164 /* reserved                             0xCF..0xDO */
 165 /* CHECK MEDIA CARD TYPE                0xD1 */
 166 /* reserved for media card pass through 0xD2..0xD4 */
 167 /* reserved                             0xD5..0xD9 */
 168 #define WIN_GETMEDIASTATUS              0xDA /* obsolete since ATA8 */
 169 /* obsolete since ATA3, retired in ATA4 0xDB..0xDD */
 170 #define WIN_DOORLOCK                    0xDE /* lock door on removable drives, obsolete since ATA8 */
 171 #define WIN_DOORUNLOCK                  0xDF /* unlock door on removable drives, obsolete since ATA8 */
 172 #define WIN_STANDBYNOW1                 0xE0
 173 #define WIN_IDLEIMMEDIATE               0xE1 /* force drive to become "ready" */
 174 #define WIN_STANDBY                     0xE2 /* Set device in Standby Mode */
 175 #define WIN_SETIDLE1                    0xE3
 176 #define WIN_READ_BUFFER                 0xE4 /* force read only 1 sector */
 177 #define WIN_CHECKPOWERMODE1             0xE5
 178 #define WIN_SLEEPNOW1                   0xE6
 179 #define WIN_FLUSH_CACHE                 0xE7
 180 #define WIN_WRITE_BUFFER                0xE8 /* force write only 1 sector */
 181 /* READ BUFFER DMA                      0xE9 */
 182 #define WIN_FLUSH_CACHE_EXT             0xEA /* 48-Bit */
 183 /* WRITE BUFFER DMA                     0xEB */
 184 #define WIN_IDENTIFY                    0xEC /* ask drive to identify itself    */
 185 #define WIN_MEDIAEJECT                  0xED /* obsolete since ATA8 */
 186 /* obsolete since ATA4                  0xEE */
 187 #define WIN_SETFEATURES                 0xEF /* set special drive features */
 188 #define IBM_SENSE_CONDITION             0xF0 /* measure disk temperature, vendor specific */
 189 #define WIN_SECURITY_SET_PASS           0xF1
 190 #define WIN_SECURITY_UNLOCK             0xF2
 191 #define WIN_SECURITY_ERASE_PREPARE      0xF3
 192 #define WIN_SECURITY_ERASE_UNIT         0xF4
 193 #define WIN_SECURITY_FREEZE_LOCK        0xF5
 194 #define CFA_WEAR_LEVEL                  0xF5 /* microdrives implement as NOP; not specified in T13! */
 195 #define WIN_SECURITY_DISABLE            0xF6
 196 /* vendor specific                      0xF7 */
 197 #define WIN_READ_NATIVE_MAX             0xF8 /* return the native maximum address */
 198 #define WIN_SET_MAX                     0xF9
 199 /* vendor specific                      0xFA..0xFF */
 200
 201 /* set to 1 set disable mult support */
 202 #define MAX_MULT_SECTORS 16
 203
 204 #define IDE_DMA_BUF_SECTORS 256
 205
 206 /* feature values for Data Set Management */
 207 #define DSM_TRIM                        0x01
 208
 209 #if (IDE_DMA_BUF_SECTORS < MAX_MULT_SECTORS)
 210 #error "IDE_DMA_BUF_SECTORS must be bigger or equal to MAX_MULT_SECTORS"
 211 #endif
 212
 213 /* ATAPI defines */
 214
 215 #define ATAPI_PACKET_SIZE 12
 216
 217 /* The generic packet command opcodes for CD/DVD Logical Units,
 218  * From Table 57 of the SFF8090 Ver. 3 (Mt. Fuji) draft standard. */
 219 #define GPCMD_BLANK                         0xa1
 220 #define GPCMD_CLOSE_TRACK                   0x5b
 221 #define GPCMD_FLUSH_CACHE                   0x35
 222 #define GPCMD_FORMAT_UNIT                   0x04
 223 #define GPCMD_GET_CONFIGURATION             0x46
 224 #define GPCMD_GET_EVENT_STATUS_NOTIFICATION 0x4a
 225 #define GPCMD_GET_PERFORMANCE               0xac
 226 #define GPCMD_INQUIRY                       0x12
 227 #define GPCMD_LOAD_UNLOAD                   0xa6
 228 #define GPCMD_MECHANISM_STATUS              0xbd
 229 #define GPCMD_MODE_SELECT_10                0x55
 230 #define GPCMD_MODE_SENSE_10                 0x5a
 231 #define GPCMD_PAUSE_RESUME                  0x4b
 232 #define GPCMD_PLAY_AUDIO_10                 0x45
 233 #define GPCMD_PLAY_AUDIO_MSF                0x47
 234 #define GPCMD_PLAY_AUDIO_TI                 0x48
 235 #define GPCMD_PLAY_CD                       0xbc
 236 #define GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL  0x1e
 237 #define GPCMD_READ_10                       0x28
 238 #define GPCMD_READ_12                       0xa8
 239 #define GPCMD_READ_CDVD_CAPACITY            0x25
 240 #define GPCMD_READ_CD                       0xbe
 241 #define GPCMD_READ_CD_MSF                   0xb9
 242 #define GPCMD_READ_DISC_INFO                0x51
 243 #define GPCMD_READ_DVD_STRUCTURE            0xad
 244 #define GPCMD_READ_FORMAT_CAPACITIES        0x23
 245 #define GPCMD_READ_HEADER                   0x44
 246 #define GPCMD_READ_TRACK_RZONE_INFO         0x52
 247 #define GPCMD_READ_SUBCHANNEL               0x42
 248 #define GPCMD_READ_TOC_PMA_ATIP             0x43
 249 #define GPCMD_REPAIR_RZONE_TRACK            0x58
 250 #define GPCMD_REPORT_KEY                    0xa4
 251 #define GPCMD_REQUEST_SENSE                 0x03
 252 #define GPCMD_RESERVE_RZONE_TRACK           0x53
 253 #define GPCMD_SCAN                          0xba
 254 #define GPCMD_SEEK                          0x2b
 255 #define GPCMD_SEND_DVD_STRUCTURE            0xad
 256 #define GPCMD_SEND_EVENT                    0xa2
 257 #define GPCMD_SEND_KEY                      0xa3
 258 #define GPCMD_SEND_OPC                      0x54
 259 #define GPCMD_SET_READ_AHEAD                0xa7
 260 #define GPCMD_SET_STREAMING                 0xb6
 261 #define GPCMD_START_STOP_UNIT               0x1b
 262 #define GPCMD_STOP_PLAY_SCAN                0x4e
 263 #define GPCMD_TEST_UNIT_READY               0x00
 264 #define GPCMD_VERIFY_10                     0x2f
 265 #define GPCMD_WRITE_10                      0x2a
 266 #define GPCMD_WRITE_AND_VERIFY_10           0x2e
 267 /* This is listed as optional in ATAPI 2.6, but is (curiously)
 268  * missing from Mt. Fuji, Table 57.  It _is_ mentioned in Mt. Fuji
 269  * Table 377 as an MMC command for SCSi devices though...  Most ATAPI
 270  * drives support it. */
 271 #define GPCMD_SET_SPEED                     0xbb
 272 /* This seems to be a SCSI specific CD-ROM opcode
 273  * to play data at track/index */
 274 #define GPCMD_PLAYAUDIO_TI                  0x48
 275 /*
 276  * From MS Media Status Notification Support Specification. For
 277  * older drives only.
 278  */
 279 #define GPCMD_GET_MEDIA_STATUS              0xda
 280 #define GPCMD_MODE_SENSE_6                  0x1a
 281
 282 /* Mode page codes for mode sense/set */
 283 #define GPMODE_R_W_ERROR_PAGE           0x01
 284 #define GPMODE_WRITE_PARMS_PAGE         0x05
 285 #define GPMODE_AUDIO_CTL_PAGE           0x0e
 286 #define GPMODE_POWER_PAGE               0x1a
 287 #define GPMODE_FAULT_FAIL_PAGE          0x1c
 288 #define GPMODE_TO_PROTECT_PAGE          0x1d
 289 #define GPMODE_CAPABILITIES_PAGE        0x2a
 290 #define GPMODE_ALL_PAGES                0x3f
 291 /* Not in Mt. Fuji, but in ATAPI 2.6 -- depricated now in favor
 292  * of MODE_SENSE_POWER_PAGE */
 293 #define GPMODE_CDROM_PAGE               0x0d
 294
 295 /*
 296  * Based on values from <linux/cdrom.h> but extending CD_MINS
 297  * to the maximum common size allowed by the Orange's Book ATIP
 298  *
 299  * 90 and 99 min CDs are also available but using them as the
 300  * upper limit reduces the effectiveness of the heuristic to
 301  * detect DVDs burned to less than 25% of their maximum capacity
 302  */
 303
 304 /* Some generally useful CD-ROM information */
 305 #define CD_MINS                       80 /* max. minutes per CD */
 306 #define CD_SECS                       60 /* seconds per minute */
 307 #define CD_FRAMES                     75 /* frames per second */
 308 #define CD_FRAMESIZE                2048 /* bytes per frame, "cooked" mode */
 309 #define CD_MAX_BYTES       (CD_MINS * CD_SECS * CD_FRAMES * CD_FRAMESIZE)
 310 #define CD_MAX_SECTORS     (CD_MAX_BYTES / 512)
 311
 312 /*
 313  * The MMC values are not IDE specific and might need to be moved
 314  * to a common header if they are also needed for the SCSI emulation
 315  */
 316
 317 /* Profile list from MMC-6 revision 1 table 91 */
 318 #define MMC_PROFILE_NONE                0x0000
 319 #define MMC_PROFILE_CD_ROM              0x0008
 320 #define MMC_PROFILE_CD_R                0x0009
 321 #define MMC_PROFILE_CD_RW               0x000A
 322 #define MMC_PROFILE_DVD_ROM             0x0010
 323 #define MMC_PROFILE_DVD_R_SR            0x0011
 324 #define MMC_PROFILE_DVD_RAM             0x0012
 325 #define MMC_PROFILE_DVD_RW_RO           0x0013
 326 #define MMC_PROFILE_DVD_RW_SR           0x0014
 327 #define MMC_PROFILE_DVD_R_DL_SR         0x0015
 328 #define MMC_PROFILE_DVD_R_DL_JR         0x0016
 329 #define MMC_PROFILE_DVD_RW_DL           0x0017
 330 #define MMC_PROFILE_DVD_DDR             0x0018
 331 #define MMC_PROFILE_DVD_PLUS_RW         0x001A
 332 #define MMC_PROFILE_DVD_PLUS_R          0x001B
 333 #define MMC_PROFILE_DVD_PLUS_RW_DL      0x002A
 334 #define MMC_PROFILE_DVD_PLUS_R_DL       0x002B
 335 #define MMC_PROFILE_BD_ROM              0x0040
 336 #define MMC_PROFILE_BD_R_SRM            0x0041
 337 #define MMC_PROFILE_BD_R_RRM            0x0042
 338 #define MMC_PROFILE_BD_RE               0x0043
 339 #define MMC_PROFILE_HDDVD_ROM           0x0050
 340 #define MMC_PROFILE_HDDVD_R             0x0051
 341 #define MMC_PROFILE_HDDVD_RAM           0x0052
 342 #define MMC_PROFILE_HDDVD_RW            0x0053
 343 #define MMC_PROFILE_HDDVD_R_DL          0x0058
 344 #define MMC_PROFILE_HDDVD_RW_DL         0x005A
 345 #define MMC_PROFILE_INVALID             0xFFFF
 346
 347 #define ATAPI_INT_REASON_CD             0x01 /* 0 = data transfer */
 348 #define ATAPI_INT_REASON_IO             0x02 /* 1 = transfer to the host */
 349 #define ATAPI_INT_REASON_REL            0x04
 350 #define ATAPI_INT_REASON_TAG            0xf8
 351
 352 /* same constants as bochs */
 353 #define ASC_ILLEGAL_OPCODE                   0x20
 354 #define ASC_LOGICAL_BLOCK_OOR                0x21
 355 #define ASC_INV_FIELD_IN_CMD_PACKET          0x24
 356 #define ASC_MEDIUM_MAY_HAVE_CHANGED          0x28
 357 #define ASC_INCOMPATIBLE_FORMAT              0x30
 358 #define ASC_MEDIUM_NOT_PRESENT               0x3a
 359 #define ASC_SAVING_PARAMETERS_NOT_SUPPORTED  0x39
 360 #define ASC_MEDIA_REMOVAL_PREVENTED          0x53
 361
 362 #define CFA_NO_ERROR            0x00
 363 #define CFA_MISC_ERROR          0x09
 364 #define CFA_INVALID_COMMAND     0x20
 365 #define CFA_INVALID_ADDRESS     0x21
 366 #define CFA_ADDRESS_OVERFLOW    0x2f
 367
 368 #define SENSE_NONE            0
 369 #define SENSE_NOT_READY       2
 370 #define SENSE_ILLEGAL_REQUEST 5
 371 #define SENSE_UNIT_ATTENTION  6
 372
 373 #define SMART_READ_DATA       0xd0
 374 #define SMART_READ_THRESH     0xd1
 375 #define SMART_ATTR_AUTOSAVE   0xd2
 376 #define SMART_SAVE_ATTR       0xd3
 377 #define SMART_EXECUTE_OFFLINE 0xd4
 378 #define SMART_READ_LOG        0xd5
 379 #define SMART_WRITE_LOG       0xd6
 380 #define SMART_ENABLE          0xd8
 381 #define SMART_DISABLE         0xd9
 382 #define SMART_STATUS          0xda
 383
 384 typedef enum { IDE_HD, IDE_CD, IDE_CFATA } IDEDriveKind;
 385
 386 typedef void EndTransferFunc(IDEState *);
 387
 388 typedef void DMAStartFunc(IDEDMA *, IDEState *, BlockDriverCompletionFunc *);
 389 typedef int DMAFunc(IDEDMA *);
 390 typedef int DMAIntFunc(IDEDMA *, int);
 391 typedef void DMARestartFunc(void *, int, RunState);
 392
 393 struct unreported_events {
 394     bool eject_request;
 395     bool new_media;
 396 };
 397
 398 enum ide_dma_cmd {
 399     IDE_DMA_READ,
 400     IDE_DMA_WRITE,
 401     IDE_DMA_TRIM,
 402 };
 403
 404 #define ide_cmd_is_read(s) \
 405         ((s)->dma_cmd == IDE_DMA_READ)
 406
 407 /* NOTE: IDEState represents in fact one drive */
 408 struct IDEState {
 409     IDEBus *bus;
 410     uint8_t unit;
 411     /* ide config */
 412     IDEDriveKind drive_kind;
 413     int cylinders, heads, sectors;
 414     int64_t nb_sectors;
 415     int mult_sectors;
 416     int identify_set;
 417     uint8_t identify_data[512];
 418     int drive_serial;
 419     char drive_serial_str[21];
 420     /* ide regs */
 421     uint8_t feature;
 422     uint8_t error;
 423     uint32_t nsector;
 424     uint8_t sector;
 425     uint8_t lcyl;
 426     uint8_t hcyl;
 427     /* other part of tf for lba48 support */
 428     uint8_t hob_feature;
 429     uint8_t hob_nsector;
 430     uint8_t hob_sector;
 431     uint8_t hob_lcyl;
 432     uint8_t hob_hcyl;
 433
 434     uint8_t select;
 435     uint8_t status;
 436
 437     /* set for lba48 access */
 438     uint8_t lba48;
 439     BlockDriverState *bs;
 440     char version[9];
 441     /* ATAPI specific */
 442     struct unreported_events events;
 443     uint8_t sense_key;
 444     uint8_t asc;
 445     bool tray_open;
 446     bool tray_locked;
 447     uint8_t cdrom_changed;
 448     int packet_transfer_size;
 449     int elementary_transfer_size;
 450     int io_buffer_index;
 451     int lba;
 452     int cd_sector_size;
 453     int atapi_dma; /* true if dma is requested for the packet cmd */
 454     BlockAcctCookie acct;
 455     /* ATA DMA state */
 456     int io_buffer_size;
 457     QEMUSGList sg;
 458     /* PIO transfer handling */
 459     int req_nb_sectors; /* number of sectors per interrupt */
 460     EndTransferFunc *end_transfer_func;
 461     uint8_t *data_ptr;
 462     uint8_t *data_end;
 463     uint8_t *io_buffer;
 464     /* PIO save/restore */
 465     int32_t io_buffer_total_len;
 466     int cur_io_buffer_offset;
 467     int cur_io_buffer_len;
 468     uint8_t end_transfer_fn_idx;
 469     QEMUTimer *sector_write_timer; /* only used for win2k install hack */
 470     uint32_t irq_count; /* counts IRQs when using win2k install hack */
 471     /* CF-ATA extended error */
 472     uint8_t ext_error;
 473     /* CF-ATA metadata storage */
 474     uint32_t mdata_size;
 475     uint8_t *mdata_storage;
 476     int media_changed;
 477     enum ide_dma_cmd dma_cmd;
 478     /* SMART */
 479     uint8_t smart_enabled;
 480     uint8_t smart_autosave;
 481     int smart_errors;
 482     uint8_t smart_selftest_count;
 483     uint8_t *smart_selftest_data;
 484     /* AHCI */
 485     int ncq_queues;
 486 };
 487
 488 struct IDEDMAOps {
 489     DMAStartFunc *start_dma;
 490     DMAFunc *start_transfer;
 491     DMAIntFunc *prepare_buf;
 492     DMAIntFunc *rw_buf;
 493     DMAIntFunc *set_unit;
 494     DMAIntFunc *add_status;
 495     DMAFunc *set_inactive;
 496     DMARestartFunc *restart_cb;
 497     DMAFunc *reset;
 498 };
 499
 500 struct IDEDMA {
 501     const struct IDEDMAOps *ops;
 502     struct iovec iov;
 503     QEMUIOVector qiov;
 504     BlockDriverAIOCB *aiocb;
 505 };
 506
 507 struct IDEBus {
 508     BusState qbus;
 509     IDEDevice *master;
 510     IDEDevice *slave;
 511     IDEState ifs[2];
 512     int bus_id;
 513     IDEDMA *dma;
 514     uint8_t unit;
 515     uint8_t cmd;
 516     qemu_irq irq;
 517
 518     int error_status;
 519 };
 520
 521 struct IDEDevice {
 522     DeviceState qdev;
 523     uint32_t unit;
 524     BlockConf conf;
 525     char *version;
 526     char *serial;
 527 };
 528
 529 typedef int (*ide_qdev_initfn)(IDEDevice *dev);
 530 struct IDEDeviceInfo {
 531     DeviceInfo qdev;
 532     ide_qdev_initfn init;
 533 };
 534
 535 #define BM_STATUS_DMAING 0x01
 536 #define BM_STATUS_ERROR  0x02
 537 #define BM_STATUS_INT    0x04
 538
 539 /* FIXME These are not status register bits */
 540 #define BM_STATUS_DMA_RETRY  0x08
 541 #define BM_STATUS_PIO_RETRY  0x10
 542 #define BM_STATUS_RETRY_READ  0x20
 543 #define BM_STATUS_RETRY_FLUSH 0x40
 544 #define BM_STATUS_RETRY_TRIM 0x80
 545
 546 #define BM_MIGRATION_COMPAT_STATUS_BITS \
 547         (BM_STATUS_DMA_RETRY | BM_STATUS_PIO_RETRY | \
 548         BM_STATUS_RETRY_READ | BM_STATUS_RETRY_FLUSH)
 549
 550 #define BM_CMD_START     0x01
 551 #define BM_CMD_READ      0x08
 552
 553 static inline IDEState *idebus_active_if(IDEBus *bus)
 554 {
 555     return bus->ifs + bus->unit;
 556 }
 557
 558 static inline void ide_set_irq(IDEBus *bus)
 559 {
 560     if (!(bus->cmd & IDE_CMD_DISABLE_IRQ)) {
 561         qemu_irq_raise(bus->irq);
 562     }
 563 }
 564
 565 /* hw/ide/core.c */
 566 extern const VMStateDescription vmstate_ide_bus;
 567
 568 #define VMSTATE_IDE_BUS(_field, _state)                          \
 569     VMSTATE_STRUCT(_field, _state, 1, vmstate_ide_bus, IDEBus)
 570
 571 #define VMSTATE_IDE_BUS_ARRAY(_field, _state, _num)              \
 572     VMSTATE_STRUCT_ARRAY(_field, _state, _num, 1, vmstate_ide_bus, IDEBus)
 573
 574 extern const VMStateDescription vmstate_ide_drive;
 575
 576 #define VMSTATE_IDE_DRIVES(_field, _state) \
 577     VMSTATE_STRUCT_ARRAY(_field, _state, 2, 3, vmstate_ide_drive, IDEState)
 578
 579 void ide_bus_reset(IDEBus *bus);
 580 int64_t ide_get_sector(IDEState *s);
 581 void ide_set_sector(IDEState *s, int64_t sector_num);
 582
 583 void ide_dma_error(IDEState *s);
 584
 585 void ide_atapi_cmd_ok(IDEState *s);
 586 void ide_atapi_cmd_error(IDEState *s, int sense_key, int asc);
 587 void ide_atapi_io_error(IDEState *s, int ret);
 588
 589 void ide_ioport_write(void *opaque, uint32_t addr, uint32_t val);
 590 uint32_t ide_ioport_read(void *opaque, uint32_t addr1);
 591 uint32_t ide_status_read(void *opaque, uint32_t addr);
 592 void ide_cmd_write(void *opaque, uint32_t addr, uint32_t val);
 593 void ide_data_writew(void *opaque, uint32_t addr, uint32_t val);
 594 uint32_t ide_data_readw(void *opaque, uint32_t addr);
 595 void ide_data_writel(void *opaque, uint32_t addr, uint32_t val);
 596 uint32_t ide_data_readl(void *opaque, uint32_t addr);
 597
 598 int ide_init_drive(IDEState *s, BlockDriverState *bs, IDEDriveKind kind,
 599                    const char *version, const char *serial);
 600 void ide_init2(IDEBus *bus, qemu_irq irq);
 601 void ide_init2_with_non_qdev_drives(IDEBus *bus, DriveInfo *hd0,
 602                                     DriveInfo *hd1, qemu_irq irq);
 603 void ide_init_ioport(IDEBus *bus, int iobase, int iobase2);
 604
 605 void ide_exec_cmd(IDEBus *bus, uint32_t val);
 606 void ide_dma_cb(void *opaque, int ret);
 607 void ide_sector_write(IDEState *s);
 608 void ide_sector_read(IDEState *s);
 609 void ide_flush_cache(IDEState *s);
 610
 611 void ide_transfer_start(IDEState *s, uint8_t *buf, int size,
 612                         EndTransferFunc *end_transfer_func);
 613 void ide_transfer_stop(IDEState *s);
 614 void ide_set_inactive(IDEState *s);
 615 BlockDriverAIOCB *ide_issue_trim(BlockDriverState *bs,
 616         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
 617         BlockDriverCompletionFunc *cb, void *opaque);
 618
 619 /* hw/ide/atapi.c */
 620 void ide_atapi_cmd(IDEState *s);
 621 void ide_atapi_cmd_reply_end(IDEState *s);
 622
 623 /* hw/ide/qdev.c */
 624 void ide_bus_new(IDEBus *idebus, DeviceState *dev, int bus_id);
 625 IDEDevice *ide_create_drive(IDEBus *bus, int unit, DriveInfo *drive);
 626
 627 #endif /* HW_IDE_INTERNAL_H */