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