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