1#ifndef HW_IDE_INTERNAL_H
2#define HW_IDE_INTERNAL_H
3
4
5
6
7
8
9#include "hw/ide.h"
10#include "hw/isa/isa.h"
11#include "sysemu/dma.h"
12#include "sysemu/sysemu.h"
13#include "hw/block/block.h"
14#include "scsi/constants.h"
15
16
17#define USE_DMA_CDROM
18
19typedef struct IDEBus IDEBus;
20typedef struct IDEDevice IDEDevice;
21typedef struct IDEState IDEState;
22typedef struct IDEDMA IDEDMA;
23typedef struct IDEDMAOps IDEDMAOps;
24
25#define TYPE_IDE_BUS "IDE"
26#define IDE_BUS(obj) OBJECT_CHECK(IDEBus, (obj), TYPE_IDE_BUS)
27
28
29#define ERR_STAT 0x01
30#define INDEX_STAT 0x02
31#define ECC_STAT 0x04
32#define DRQ_STAT 0x08
33#define SEEK_STAT 0x10
34#define SRV_STAT 0x10
35#define WRERR_STAT 0x20
36#define READY_STAT 0x40
37#define BUSY_STAT 0x80
38
39
40#define MARK_ERR 0x01
41#define TRK0_ERR 0x02
42#define ABRT_ERR 0x04
43#define MCR_ERR 0x08
44#define ID_ERR 0x10
45#define MC_ERR 0x20
46#define ECC_ERR 0x40
47#define BBD_ERR 0x80
48#define ICRC_ERR 0x80
49
50
51#define CD 0x01
52#define IO 0x02
53#define REL 0x04
54#define TAG_MASK 0xf8
55
56#define IDE_CMD_RESET 0x04
57#define IDE_CMD_DISABLE_IRQ 0x02
58
59
60#define WIN_NOP 0x00
61
62#define CFA_REQ_EXT_ERROR_CODE 0x03
63
64#define WIN_DSM 0x06
65
66#define WIN_DEVICE_RESET 0x08
67
68
69
70#define WIN_RECAL 0x10
71
72#define WIN_READ 0x20
73#define WIN_READ_ONCE 0x21
74
75#define WIN_READ_EXT 0x24
76#define WIN_READDMA_EXT 0x25
77#define WIN_READDMA_QUEUED_EXT 0x26
78#define WIN_READ_NATIVE_MAX_EXT 0x27
79
80#define WIN_MULTREAD_EXT 0x29
81
82
83
84
85#define WIN_WRITE 0x30
86#define WIN_WRITE_ONCE 0x31
87
88#define WIN_WRITE_EXT 0x34
89#define WIN_WRITEDMA_EXT 0x35
90#define WIN_WRITEDMA_QUEUED_EXT 0x36
91#define WIN_SET_MAX_EXT 0x37
92#define WIN_SET_MAX_EXT 0x37
93#define CFA_WRITE_SECT_WO_ERASE 0x38
94#define WIN_MULTWRITE_EXT 0x39
95
96
97#define WIN_WRITE_VERIFY 0x3C
98
99
100
101#define WIN_VERIFY 0x40
102#define WIN_VERIFY_ONCE 0x41
103#define WIN_VERIFY_EXT 0x42
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122#define WIN_SEEK 0x70
123
124
125#define CFA_TRANSLATE_SECTOR 0x87
126
127#define WIN_DIAGNOSE 0x90
128#define WIN_SPECIFY 0x91
129#define WIN_DOWNLOAD_MICROCODE 0x92
130
131#define WIN_STANDBYNOW2 0x94
132#define WIN_IDLEIMMEDIATE2 0x95
133#define WIN_STANDBY2 0x96
134#define WIN_SETIDLE2 0x97
135#define WIN_CHECKPOWERMODE2 0x98
136#define WIN_SLEEPNOW2 0x99
137
138
139#define WIN_PACKETCMD 0xA0
140#define WIN_PIDENTIFY 0xA1
141#define WIN_QUEUED_SERVICE 0xA2
142
143#define WIN_SMART 0xB0
144
145
146
147
148
149
150#define CFA_ACCESS_METADATA_STORAGE 0xB8
151
152#define CFA_ERASE_SECTORS 0xC0
153
154#define WIN_MULTREAD 0xC4
155#define WIN_MULTWRITE 0xC5
156#define WIN_SETMULT 0xC6
157#define WIN_READDMA_QUEUED 0xC7
158#define WIN_READDMA 0xC8
159#define WIN_READDMA_ONCE 0xC9
160#define WIN_WRITEDMA 0xCA
161#define WIN_WRITEDMA_ONCE 0xCB
162#define WIN_WRITEDMA_QUEUED 0xCC
163#define CFA_WRITE_MULTI_WO_ERASE 0xCD
164
165
166
167
168
169#define WIN_GETMEDIASTATUS 0xDA
170
171#define WIN_DOORLOCK 0xDE
172#define WIN_DOORUNLOCK 0xDF
173#define WIN_STANDBYNOW1 0xE0
174#define WIN_IDLEIMMEDIATE 0xE1
175#define WIN_STANDBY 0xE2
176#define WIN_SETIDLE1 0xE3
177#define WIN_READ_BUFFER 0xE4
178#define WIN_CHECKPOWERMODE1 0xE5
179#define WIN_SLEEPNOW1 0xE6
180#define WIN_FLUSH_CACHE 0xE7
181#define WIN_WRITE_BUFFER 0xE8
182
183#define WIN_FLUSH_CACHE_EXT 0xEA
184
185#define WIN_IDENTIFY 0xEC
186#define WIN_MEDIAEJECT 0xED
187
188#define WIN_SETFEATURES 0xEF
189#define IBM_SENSE_CONDITION 0xF0
190#define WIN_SECURITY_SET_PASS 0xF1
191#define WIN_SECURITY_UNLOCK 0xF2
192#define WIN_SECURITY_ERASE_PREPARE 0xF3
193#define WIN_SECURITY_ERASE_UNIT 0xF4
194#define WIN_SECURITY_FREEZE_LOCK 0xF5
195#define CFA_WEAR_LEVEL 0xF5
196#define WIN_SECURITY_DISABLE 0xF6
197
198#define WIN_READ_NATIVE_MAX 0xF8
199#define WIN_SET_MAX 0xF9
200
201
202
203#define MAX_MULT_SECTORS 16
204
205#define IDE_DMA_BUF_SECTORS 256
206
207
208#define DSM_TRIM 0x01
209
210#if (IDE_DMA_BUF_SECTORS < MAX_MULT_SECTORS)
211#error "IDE_DMA_BUF_SECTORS must be bigger or equal to MAX_MULT_SECTORS"
212#endif
213
214
215
216#define ATAPI_PACKET_SIZE 12
217
218
219
220#define GPCMD_BLANK 0xa1
221#define GPCMD_CLOSE_TRACK 0x5b
222#define GPCMD_FLUSH_CACHE 0x35
223#define GPCMD_FORMAT_UNIT 0x04
224#define GPCMD_GET_CONFIGURATION 0x46
225#define GPCMD_GET_EVENT_STATUS_NOTIFICATION 0x4a
226#define GPCMD_GET_PERFORMANCE 0xac
227#define GPCMD_INQUIRY 0x12
228#define GPCMD_LOAD_UNLOAD 0xa6
229#define GPCMD_MECHANISM_STATUS 0xbd
230#define GPCMD_MODE_SELECT_10 0x55
231#define GPCMD_MODE_SENSE_10 0x5a
232#define GPCMD_PAUSE_RESUME 0x4b
233#define GPCMD_PLAY_AUDIO_10 0x45
234#define GPCMD_PLAY_AUDIO_MSF 0x47
235#define GPCMD_PLAY_AUDIO_TI 0x48
236#define GPCMD_PLAY_CD 0xbc
237#define GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL 0x1e
238#define GPCMD_READ_10 0x28
239#define GPCMD_READ_12 0xa8
240#define GPCMD_READ_CDVD_CAPACITY 0x25
241#define GPCMD_READ_CD 0xbe
242#define GPCMD_READ_CD_MSF 0xb9
243#define GPCMD_READ_DISC_INFO 0x51
244#define GPCMD_READ_DVD_STRUCTURE 0xad
245#define GPCMD_READ_FORMAT_CAPACITIES 0x23
246#define GPCMD_READ_HEADER 0x44
247#define GPCMD_READ_TRACK_RZONE_INFO 0x52
248#define GPCMD_READ_SUBCHANNEL 0x42
249#define GPCMD_READ_TOC_PMA_ATIP 0x43
250#define GPCMD_REPAIR_RZONE_TRACK 0x58
251#define GPCMD_REPORT_KEY 0xa4
252#define GPCMD_REQUEST_SENSE 0x03
253#define GPCMD_RESERVE_RZONE_TRACK 0x53
254#define GPCMD_SCAN 0xba
255#define GPCMD_SEEK 0x2b
256#define GPCMD_SEND_DVD_STRUCTURE 0xad
257#define GPCMD_SEND_EVENT 0xa2
258#define GPCMD_SEND_KEY 0xa3
259#define GPCMD_SEND_OPC 0x54
260#define GPCMD_SET_READ_AHEAD 0xa7
261#define GPCMD_SET_STREAMING 0xb6
262#define GPCMD_START_STOP_UNIT 0x1b
263#define GPCMD_STOP_PLAY_SCAN 0x4e
264#define GPCMD_TEST_UNIT_READY 0x00
265#define GPCMD_VERIFY_10 0x2f
266#define GPCMD_WRITE_10 0x2a
267#define GPCMD_WRITE_AND_VERIFY_10 0x2e
268
269
270
271
272#define GPCMD_SET_SPEED 0xbb
273
274
275#define GPCMD_PLAYAUDIO_TI 0x48
276
277
278
279
280#define GPCMD_GET_MEDIA_STATUS 0xda
281#define GPCMD_MODE_SENSE_6 0x1a
282
283#define ATAPI_INT_REASON_CD 0x01
284#define ATAPI_INT_REASON_IO 0x02
285#define ATAPI_INT_REASON_REL 0x04
286#define ATAPI_INT_REASON_TAG 0xf8
287
288
289#define ASC_NO_SEEK_COMPLETE 0x02
290#define ASC_ILLEGAL_OPCODE 0x20
291#define ASC_LOGICAL_BLOCK_OOR 0x21
292#define ASC_INV_FIELD_IN_CMD_PACKET 0x24
293#define ASC_MEDIUM_MAY_HAVE_CHANGED 0x28
294#define ASC_INCOMPATIBLE_FORMAT 0x30
295#define ASC_MEDIUM_NOT_PRESENT 0x3a
296#define ASC_SAVING_PARAMETERS_NOT_SUPPORTED 0x39
297#define ASC_DATA_PHASE_ERROR 0x4b
298#define ASC_MEDIA_REMOVAL_PREVENTED 0x53
299
300#define CFA_NO_ERROR 0x00
301#define CFA_MISC_ERROR 0x09
302#define CFA_INVALID_COMMAND 0x20
303#define CFA_INVALID_ADDRESS 0x21
304#define CFA_ADDRESS_OVERFLOW 0x2f
305
306#define SMART_READ_DATA 0xd0
307#define SMART_READ_THRESH 0xd1
308#define SMART_ATTR_AUTOSAVE 0xd2
309#define SMART_SAVE_ATTR 0xd3
310#define SMART_EXECUTE_OFFLINE 0xd4
311#define SMART_READ_LOG 0xd5
312#define SMART_WRITE_LOG 0xd6
313#define SMART_ENABLE 0xd8
314#define SMART_DISABLE 0xd9
315#define SMART_STATUS 0xda
316
317typedef enum { IDE_HD, IDE_CD, IDE_CFATA } IDEDriveKind;
318
319typedef void EndTransferFunc(IDEState *);
320
321typedef void DMAStartFunc(IDEDMA *, IDEState *, BlockCompletionFunc *);
322typedef void DMAVoidFunc(IDEDMA *);
323typedef int DMAIntFunc(IDEDMA *, int);
324typedef int32_t DMAInt32Func(IDEDMA *, int32_t len);
325typedef void DMAu32Func(IDEDMA *, uint32_t);
326typedef void DMAStopFunc(IDEDMA *, bool);
327typedef void DMARestartFunc(void *, int, RunState);
328
329struct unreported_events {
330 bool eject_request;
331 bool new_media;
332};
333
334enum ide_dma_cmd {
335 IDE_DMA_READ = 0,
336 IDE_DMA_WRITE,
337 IDE_DMA_TRIM,
338 IDE_DMA_ATAPI,
339 IDE_DMA__COUNT
340};
341
342extern const char *IDE_DMA_CMD_lookup[IDE_DMA__COUNT];
343
344#define ide_cmd_is_read(s) \
345 ((s)->dma_cmd == IDE_DMA_READ)
346
347typedef struct IDEBufferedRequest {
348 QLIST_ENTRY(IDEBufferedRequest) list;
349 QEMUIOVector qiov;
350 QEMUIOVector *original_qiov;
351 BlockCompletionFunc *original_cb;
352 void *original_opaque;
353 bool orphaned;
354} IDEBufferedRequest;
355
356
357struct IDEState {
358 IDEBus *bus;
359 uint8_t unit;
360
361 IDEDriveKind drive_kind;
362 int cylinders, heads, sectors, chs_trans;
363 int64_t nb_sectors;
364 int mult_sectors;
365 int identify_set;
366 uint8_t identify_data[512];
367 int drive_serial;
368 char drive_serial_str[21];
369 char drive_model_str[41];
370 uint64_t wwn;
371
372 uint8_t feature;
373 uint8_t error;
374 uint32_t nsector;
375 uint8_t sector;
376 uint8_t lcyl;
377 uint8_t hcyl;
378
379 uint8_t hob_feature;
380 uint8_t hob_nsector;
381 uint8_t hob_sector;
382 uint8_t hob_lcyl;
383 uint8_t hob_hcyl;
384
385 uint8_t select;
386 uint8_t status;
387
388
389 uint8_t lba48;
390 BlockBackend *blk;
391 char version[9];
392
393 struct unreported_events events;
394 uint8_t sense_key;
395 uint8_t asc;
396 bool tray_open;
397 bool tray_locked;
398 uint8_t cdrom_changed;
399 int packet_transfer_size;
400 int elementary_transfer_size;
401 int32_t io_buffer_index;
402 int lba;
403 int cd_sector_size;
404 int atapi_dma;
405 BlockAcctCookie acct;
406 BlockAIOCB *pio_aiocb;
407 QEMUIOVector qiov;
408 QLIST_HEAD(, IDEBufferedRequest) buffered_requests;
409
410 uint64_t io_buffer_offset;
411 int32_t io_buffer_size;
412 QEMUSGList sg;
413
414 int req_nb_sectors;
415 EndTransferFunc *end_transfer_func;
416 uint8_t *data_ptr;
417 uint8_t *data_end;
418 uint8_t *io_buffer;
419
420 int32_t io_buffer_total_len;
421 int32_t cur_io_buffer_offset;
422 int32_t cur_io_buffer_len;
423 uint8_t end_transfer_fn_idx;
424 QEMUTimer *sector_write_timer;
425 uint32_t irq_count;
426
427 uint8_t ext_error;
428
429 uint32_t mdata_size;
430 uint8_t *mdata_storage;
431 int media_changed;
432 enum ide_dma_cmd dma_cmd;
433
434 uint8_t smart_enabled;
435 uint8_t smart_autosave;
436 int smart_errors;
437 uint8_t smart_selftest_count;
438 uint8_t *smart_selftest_data;
439
440 int ncq_queues;
441};
442
443struct IDEDMAOps {
444 DMAStartFunc *start_dma;
445 DMAVoidFunc *pio_transfer;
446 DMAInt32Func *prepare_buf;
447 DMAu32Func *commit_buf;
448 DMAIntFunc *rw_buf;
449 DMAVoidFunc *restart;
450 DMAVoidFunc *restart_dma;
451 DMAStopFunc *set_inactive;
452 DMAVoidFunc *cmd_done;
453 DMAVoidFunc *reset;
454};
455
456struct IDEDMA {
457 const struct IDEDMAOps *ops;
458 QEMUIOVector qiov;
459 BlockAIOCB *aiocb;
460};
461
462struct IDEBus {
463 BusState qbus;
464 IDEDevice *master;
465 IDEDevice *slave;
466 IDEState ifs[2];
467 QEMUBH *bh;
468
469 int bus_id;
470 int max_units;
471 IDEDMA *dma;
472 uint8_t unit;
473 uint8_t cmd;
474 qemu_irq irq;
475
476 int error_status;
477 uint8_t retry_unit;
478 int64_t retry_sector_num;
479 uint32_t retry_nsector;
480 PortioList portio_list;
481 PortioList portio2_list;
482 VMChangeStateEntry *vmstate;
483};
484
485#define TYPE_IDE_DEVICE "ide-device"
486#define IDE_DEVICE(obj) \
487 OBJECT_CHECK(IDEDevice, (obj), TYPE_IDE_DEVICE)
488#define IDE_DEVICE_CLASS(klass) \
489 OBJECT_CLASS_CHECK(IDEDeviceClass, (klass), TYPE_IDE_DEVICE)
490#define IDE_DEVICE_GET_CLASS(obj) \
491 OBJECT_GET_CLASS(IDEDeviceClass, (obj), TYPE_IDE_DEVICE)
492
493typedef struct IDEDeviceClass {
494 DeviceClass parent_class;
495 void (*realize)(IDEDevice *dev, Error **errp);
496} IDEDeviceClass;
497
498struct IDEDevice {
499 DeviceState qdev;
500 uint32_t unit;
501 BlockConf conf;
502 int chs_trans;
503 char *version;
504 char *serial;
505 char *model;
506 uint64_t wwn;
507
508
509
510
511
512
513
514 uint16_t rotation_rate;
515};
516
517
518#define IDE_RETRY_MASK 0xf8
519#define IDE_RETRY_DMA 0x08
520#define IDE_RETRY_PIO 0x10
521#define IDE_RETRY_ATAPI 0x20
522#define IDE_RETRY_READ 0x20
523#define IDE_RETRY_FLUSH 0x40
524#define IDE_RETRY_TRIM 0x80
525#define IDE_RETRY_HBA 0x100
526
527#define IS_IDE_RETRY_DMA(_status) \
528 ((_status) & IDE_RETRY_DMA)
529
530#define IS_IDE_RETRY_PIO(_status) \
531 ((_status) & IDE_RETRY_PIO)
532
533
534
535
536
537#define IS_IDE_RETRY_ATAPI(_status) \
538 (((_status) & IDE_RETRY_MASK) == IDE_RETRY_ATAPI)
539
540static inline uint8_t ide_dma_cmd_to_retry(uint8_t dma_cmd)
541{
542 switch (dma_cmd) {
543 case IDE_DMA_READ:
544 return IDE_RETRY_DMA | IDE_RETRY_READ;
545 case IDE_DMA_WRITE:
546 return IDE_RETRY_DMA;
547 case IDE_DMA_TRIM:
548 return IDE_RETRY_DMA | IDE_RETRY_TRIM;
549 case IDE_DMA_ATAPI:
550 return IDE_RETRY_ATAPI;
551 default:
552 break;
553 }
554 return 0;
555}
556
557static inline IDEState *idebus_active_if(IDEBus *bus)
558{
559 return bus->ifs + bus->unit;
560}
561
562static inline void ide_set_irq(IDEBus *bus)
563{
564 if (!(bus->cmd & IDE_CMD_DISABLE_IRQ)) {
565 qemu_irq_raise(bus->irq);
566 }
567}
568
569
570extern const VMStateDescription vmstate_ide_bus;
571
572#define VMSTATE_IDE_BUS(_field, _state) \
573 VMSTATE_STRUCT(_field, _state, 1, vmstate_ide_bus, IDEBus)
574
575#define VMSTATE_IDE_BUS_ARRAY(_field, _state, _num) \
576 VMSTATE_STRUCT_ARRAY(_field, _state, _num, 1, vmstate_ide_bus, IDEBus)
577
578extern const VMStateDescription vmstate_ide_drive;
579
580#define VMSTATE_IDE_DRIVES(_field, _state) \
581 VMSTATE_STRUCT_ARRAY(_field, _state, 2, 3, vmstate_ide_drive, IDEState)
582
583#define VMSTATE_IDE_DRIVE(_field, _state) \
584 VMSTATE_STRUCT(_field, _state, 1, vmstate_ide_drive, IDEState)
585
586void ide_bus_reset(IDEBus *bus);
587int64_t ide_get_sector(IDEState *s);
588void ide_set_sector(IDEState *s, int64_t sector_num);
589
590void ide_start_dma(IDEState *s, BlockCompletionFunc *cb);
591void dma_buf_commit(IDEState *s, uint32_t tx_bytes);
592void ide_dma_error(IDEState *s);
593void ide_abort_command(IDEState *s);
594
595void ide_atapi_cmd_ok(IDEState *s);
596void ide_atapi_cmd_error(IDEState *s, int sense_key, int asc);
597void ide_atapi_dma_restart(IDEState *s);
598void ide_atapi_io_error(IDEState *s, int ret);
599
600void ide_ioport_write(void *opaque, uint32_t addr, uint32_t val);
601uint32_t ide_ioport_read(void *opaque, uint32_t addr1);
602uint32_t ide_status_read(void *opaque, uint32_t addr);
603void ide_cmd_write(void *opaque, uint32_t addr, uint32_t val);
604void ide_data_writew(void *opaque, uint32_t addr, uint32_t val);
605uint32_t ide_data_readw(void *opaque, uint32_t addr);
606void ide_data_writel(void *opaque, uint32_t addr, uint32_t val);
607uint32_t ide_data_readl(void *opaque, uint32_t addr);
608
609int ide_init_drive(IDEState *s, BlockBackend *blk, IDEDriveKind kind,
610 const char *version, const char *serial, const char *model,
611 uint64_t wwn,
612 uint32_t cylinders, uint32_t heads, uint32_t secs,
613 int chs_trans, Error **errp);
614void ide_init2(IDEBus *bus, qemu_irq irq);
615void ide_exit(IDEState *s);
616void ide_init_ioport(IDEBus *bus, ISADevice *isa, int iobase, int iobase2);
617void ide_register_restart_cb(IDEBus *bus);
618
619void ide_exec_cmd(IDEBus *bus, uint32_t val);
620
621void ide_transfer_start(IDEState *s, uint8_t *buf, int size,
622 EndTransferFunc *end_transfer_func);
623bool ide_transfer_start_norecurse(IDEState *s, uint8_t *buf, int size,
624 EndTransferFunc *end_transfer_func);
625void ide_transfer_stop(IDEState *s);
626void ide_set_inactive(IDEState *s, bool more);
627BlockAIOCB *ide_issue_trim(
628 int64_t offset, QEMUIOVector *qiov,
629 BlockCompletionFunc *cb, void *cb_opaque, void *opaque);
630BlockAIOCB *ide_buffered_readv(IDEState *s, int64_t sector_num,
631 QEMUIOVector *iov, int nb_sectors,
632 BlockCompletionFunc *cb, void *opaque);
633void ide_cancel_dma_sync(IDEState *s);
634
635
636void ide_atapi_cmd(IDEState *s);
637void ide_atapi_cmd_reply_end(IDEState *s);
638
639
640void ide_bus_new(IDEBus *idebus, size_t idebus_size, DeviceState *dev,
641 int bus_id, int max_units);
642IDEDevice *ide_create_drive(IDEBus *bus, int unit, DriveInfo *drive);
643
644int ide_handle_rw_error(IDEState *s, int error, int op);
645
646#endif
647