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