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