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