1 #ifndef HW_IDE_INTERNAL_H
2 #define HW_IDE_INTERNAL_H
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
10 #include "block_int.h"
13 /* debug IDE devices */
15 //#define DEBUG_IDE_ATAPI
19 typedef struct IDEBus IDEBus
;
20 typedef struct IDEDevice IDEDevice
;
21 typedef struct IDEDeviceInfo IDEDeviceInfo
;
22 typedef struct IDEState IDEState
;
23 typedef struct BMDMAState BMDMAState
;
25 /* Bits of HD_STATUS */
27 #define INDEX_STAT 0x02
28 #define ECC_STAT 0x04 /* Corrected error */
30 #define SEEK_STAT 0x10
32 #define WRERR_STAT 0x20
33 #define READY_STAT 0x40
34 #define BUSY_STAT 0x80
36 /* Bits for HD_ERROR */
37 #define MARK_ERR 0x01 /* Bad address mark */
38 #define TRK0_ERR 0x02 /* couldn't find track 0 */
39 #define ABRT_ERR 0x04 /* Command aborted */
40 #define MCR_ERR 0x08 /* media change request */
41 #define ID_ERR 0x10 /* ID field not found */
42 #define MC_ERR 0x20 /* media changed */
43 #define ECC_ERR 0x40 /* Uncorrectable ECC error */
44 #define BBD_ERR 0x80 /* pre-EIDE meaning: block marked bad */
45 #define ICRC_ERR 0x80 /* new meaning: CRC error during transfer */
47 /* Bits of HD_NSECTOR */
53 #define IDE_CMD_RESET 0x04
54 #define IDE_CMD_DISABLE_IRQ 0x02
56 /* ATA/ATAPI Commands pre T13 Spec */
61 #define CFA_REQ_EXT_ERROR_CODE 0x03 /* CFA Request Extended Error Code */
65 #define WIN_SRST 0x08 /* ATAPI soft reset command */
66 #define WIN_DEVICE_RESET 0x08
70 #define WIN_RECAL 0x10
71 #define WIN_RESTORE WIN_RECAL
75 #define WIN_READ 0x20 /* 28-Bit */
76 #define WIN_READ_ONCE 0x21 /* 28-Bit without retries */
77 #define WIN_READ_LONG 0x22 /* 28-Bit */
78 #define WIN_READ_LONG_ONCE 0x23 /* 28-Bit without retries */
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 */
82 #define WIN_READ_NATIVE_MAX_EXT 0x27 /* 48-Bit */
86 #define WIN_MULTREAD_EXT 0x29 /* 48-Bit */
90 #define WIN_WRITE 0x30 /* 28-Bit */
91 #define WIN_WRITE_ONCE 0x31 /* 28-Bit without retries */
92 #define WIN_WRITE_LONG 0x32 /* 28-Bit */
93 #define WIN_WRITE_LONG_ONCE 0x33 /* 28-Bit without retries */
94 #define WIN_WRITE_EXT 0x34 /* 48-Bit */
95 #define WIN_WRITEDMA_EXT 0x35 /* 48-Bit */
96 #define WIN_WRITEDMA_QUEUED_EXT 0x36 /* 48-Bit */
97 #define WIN_SET_MAX_EXT 0x37 /* 48-Bit */
98 #define CFA_WRITE_SECT_WO_ERASE 0x38 /* CFA Write Sectors without erase */
99 #define WIN_MULTWRITE_EXT 0x39 /* 48-Bit */
101 * 0x3A->0x3B Reserved
103 #define WIN_WRITE_VERIFY 0x3C /* 28-Bit */
105 * 0x3D->0x3F Reserved
107 #define WIN_VERIFY 0x40 /* 28-Bit - Read Verify Sectors */
108 #define WIN_VERIFY_ONCE 0x41 /* 28-Bit - without retries */
109 #define WIN_VERIFY_EXT 0x42 /* 48-Bit */
111 * 0x43->0x4F Reserved
113 #define WIN_FORMAT 0x50
115 * 0x51->0x5F Reserved
117 #define WIN_INIT 0x60
119 * 0x61->0x5F Reserved
121 #define WIN_SEEK 0x70 /* 0x70-0x7F Reserved */
122 #define CFA_TRANSLATE_SECTOR 0x87 /* CFA Translate Sector */
123 #define WIN_DIAGNOSE 0x90
124 #define WIN_SPECIFY 0x91 /* set drive geometry translation */
125 #define WIN_DOWNLOAD_MICROCODE 0x92
126 #define WIN_STANDBYNOW2 0x94
127 #define CFA_IDLEIMMEDIATE 0x95 /* force drive to become "ready" */
128 #define WIN_STANDBY2 0x96
129 #define WIN_SETIDLE2 0x97
130 #define WIN_CHECKPOWERMODE2 0x98
131 #define WIN_SLEEPNOW2 0x99
135 #define WIN_PACKETCMD 0xA0 /* Send a packet command. */
136 #define WIN_PIDENTIFY 0xA1 /* identify ATAPI device */
137 #define WIN_QUEUED_SERVICE 0xA2
138 #define WIN_SMART 0xB0 /* self-monitoring and reporting */
139 #define CFA_ACCESS_METADATA_STORAGE 0xB8
140 #define CFA_ERASE_SECTORS 0xC0 /* microdrives implement as NOP */
141 #define WIN_MULTREAD 0xC4 /* read sectors using multiple mode*/
142 #define WIN_MULTWRITE 0xC5 /* write sectors using multiple mode */
143 #define WIN_SETMULT 0xC6 /* enable/disable multiple mode */
144 #define WIN_READDMA_QUEUED 0xC7 /* read sectors using Queued DMA transfers */
145 #define WIN_READDMA 0xC8 /* read sectors using DMA transfers */
146 #define WIN_READDMA_ONCE 0xC9 /* 28-Bit - without retries */
147 #define WIN_WRITEDMA 0xCA /* write sectors using DMA transfers */
148 #define WIN_WRITEDMA_ONCE 0xCB /* 28-Bit - without retries */
149 #define WIN_WRITEDMA_QUEUED 0xCC /* write sectors using Queued DMA transfers */
150 #define CFA_WRITE_MULTI_WO_ERASE 0xCD /* CFA Write multiple without erase */
151 #define WIN_GETMEDIASTATUS 0xDA
152 #define WIN_ACKMEDIACHANGE 0xDB /* ATA-1, ATA-2 vendor */
153 #define WIN_POSTBOOT 0xDC
154 #define WIN_PREBOOT 0xDD
155 #define WIN_DOORLOCK 0xDE /* lock door on removable drives */
156 #define WIN_DOORUNLOCK 0xDF /* unlock door on removable drives */
157 #define WIN_STANDBYNOW1 0xE0
158 #define WIN_IDLEIMMEDIATE 0xE1 /* force drive to become "ready" */
159 #define WIN_STANDBY 0xE2 /* Set device in Standby Mode */
160 #define WIN_SETIDLE1 0xE3
161 #define WIN_READ_BUFFER 0xE4 /* force read only 1 sector */
162 #define WIN_CHECKPOWERMODE1 0xE5
163 #define WIN_SLEEPNOW1 0xE6
164 #define WIN_FLUSH_CACHE 0xE7
165 #define WIN_WRITE_BUFFER 0xE8 /* force write only 1 sector */
166 #define WIN_WRITE_SAME 0xE9 /* read ata-2 to use */
167 /* SET_FEATURES 0x22 or 0xDD */
168 #define WIN_FLUSH_CACHE_EXT 0xEA /* 48-Bit */
169 #define WIN_IDENTIFY 0xEC /* ask drive to identify itself */
170 #define WIN_MEDIAEJECT 0xED
171 #define WIN_IDENTIFY_DMA 0xEE /* same as WIN_IDENTIFY, but DMA */
172 #define WIN_SETFEATURES 0xEF /* set special drive features */
173 #define EXABYTE_ENABLE_NEST 0xF0
174 #define IBM_SENSE_CONDITION 0xF0 /* measure disk temperature */
175 #define WIN_SECURITY_SET_PASS 0xF1
176 #define WIN_SECURITY_UNLOCK 0xF2
177 #define WIN_SECURITY_ERASE_PREPARE 0xF3
178 #define WIN_SECURITY_ERASE_UNIT 0xF4
179 #define WIN_SECURITY_FREEZE_LOCK 0xF5
180 #define CFA_WEAR_LEVEL 0xF5 /* microdrives implement as NOP */
181 #define WIN_SECURITY_DISABLE 0xF6
182 #define WIN_READ_NATIVE_MAX 0xF8 /* return the native maximum address */
183 #define WIN_SET_MAX 0xF9
184 #define DISABLE_SEAGATE 0xFB
186 /* set to 1 set disable mult support */
187 #define MAX_MULT_SECTORS 16
189 #define IDE_DMA_BUF_SECTORS 256
191 #if (IDE_DMA_BUF_SECTORS < MAX_MULT_SECTORS)
192 #error "IDE_DMA_BUF_SECTORS must be bigger or equal to MAX_MULT_SECTORS"
197 #define ATAPI_PACKET_SIZE 12
199 /* The generic packet command opcodes for CD/DVD Logical Units,
200 * From Table 57 of the SFF8090 Ver. 3 (Mt. Fuji) draft standard. */
201 #define GPCMD_BLANK 0xa1
202 #define GPCMD_CLOSE_TRACK 0x5b
203 #define GPCMD_FLUSH_CACHE 0x35
204 #define GPCMD_FORMAT_UNIT 0x04
205 #define GPCMD_GET_CONFIGURATION 0x46
206 #define GPCMD_GET_EVENT_STATUS_NOTIFICATION 0x4a
207 #define GPCMD_GET_PERFORMANCE 0xac
208 #define GPCMD_INQUIRY 0x12
209 #define GPCMD_LOAD_UNLOAD 0xa6
210 #define GPCMD_MECHANISM_STATUS 0xbd
211 #define GPCMD_MODE_SELECT_10 0x55
212 #define GPCMD_MODE_SENSE_10 0x5a
213 #define GPCMD_PAUSE_RESUME 0x4b
214 #define GPCMD_PLAY_AUDIO_10 0x45
215 #define GPCMD_PLAY_AUDIO_MSF 0x47
216 #define GPCMD_PLAY_AUDIO_TI 0x48
217 #define GPCMD_PLAY_CD 0xbc
218 #define GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL 0x1e
219 #define GPCMD_READ_10 0x28
220 #define GPCMD_READ_12 0xa8
221 #define GPCMD_READ_CDVD_CAPACITY 0x25
222 #define GPCMD_READ_CD 0xbe
223 #define GPCMD_READ_CD_MSF 0xb9
224 #define GPCMD_READ_DISC_INFO 0x51
225 #define GPCMD_READ_DVD_STRUCTURE 0xad
226 #define GPCMD_READ_FORMAT_CAPACITIES 0x23
227 #define GPCMD_READ_HEADER 0x44
228 #define GPCMD_READ_TRACK_RZONE_INFO 0x52
229 #define GPCMD_READ_SUBCHANNEL 0x42
230 #define GPCMD_READ_TOC_PMA_ATIP 0x43
231 #define GPCMD_REPAIR_RZONE_TRACK 0x58
232 #define GPCMD_REPORT_KEY 0xa4
233 #define GPCMD_REQUEST_SENSE 0x03
234 #define GPCMD_RESERVE_RZONE_TRACK 0x53
235 #define GPCMD_SCAN 0xba
236 #define GPCMD_SEEK 0x2b
237 #define GPCMD_SEND_DVD_STRUCTURE 0xad
238 #define GPCMD_SEND_EVENT 0xa2
239 #define GPCMD_SEND_KEY 0xa3
240 #define GPCMD_SEND_OPC 0x54
241 #define GPCMD_SET_READ_AHEAD 0xa7
242 #define GPCMD_SET_STREAMING 0xb6
243 #define GPCMD_START_STOP_UNIT 0x1b
244 #define GPCMD_STOP_PLAY_SCAN 0x4e
245 #define GPCMD_TEST_UNIT_READY 0x00
246 #define GPCMD_VERIFY_10 0x2f
247 #define GPCMD_WRITE_10 0x2a
248 #define GPCMD_WRITE_AND_VERIFY_10 0x2e
249 /* This is listed as optional in ATAPI 2.6, but is (curiously)
250 * missing from Mt. Fuji, Table 57. It _is_ mentioned in Mt. Fuji
251 * Table 377 as an MMC command for SCSi devices though... Most ATAPI
252 * drives support it. */
253 #define GPCMD_SET_SPEED 0xbb
254 /* This seems to be a SCSI specific CD-ROM opcode
255 * to play data at track/index */
256 #define GPCMD_PLAYAUDIO_TI 0x48
258 * From MS Media Status Notification Support Specification. For
261 #define GPCMD_GET_MEDIA_STATUS 0xda
262 #define GPCMD_MODE_SENSE_6 0x1a
264 /* Mode page codes for mode sense/set */
265 #define GPMODE_R_W_ERROR_PAGE 0x01
266 #define GPMODE_WRITE_PARMS_PAGE 0x05
267 #define GPMODE_AUDIO_CTL_PAGE 0x0e
268 #define GPMODE_POWER_PAGE 0x1a
269 #define GPMODE_FAULT_FAIL_PAGE 0x1c
270 #define GPMODE_TO_PROTECT_PAGE 0x1d
271 #define GPMODE_CAPABILITIES_PAGE 0x2a
272 #define GPMODE_ALL_PAGES 0x3f
273 /* Not in Mt. Fuji, but in ATAPI 2.6 -- depricated now in favor
274 * of MODE_SENSE_POWER_PAGE */
275 #define GPMODE_CDROM_PAGE 0x0d
278 * Based on values from <linux/cdrom.h> but extending CD_MINS
279 * to the maximum common size allowed by the Orange's Book ATIP
281 * 90 and 99 min CDs are also available but using them as the
282 * upper limit reduces the effectiveness of the heuristic to
283 * detect DVDs burned to less than 25% of their maximum capacity
286 /* Some generally useful CD-ROM information */
287 #define CD_MINS 80 /* max. minutes per CD */
288 #define CD_SECS 60 /* seconds per minute */
289 #define CD_FRAMES 75 /* frames per second */
290 #define CD_FRAMESIZE 2048 /* bytes per frame, "cooked" mode */
291 #define CD_MAX_BYTES (CD_MINS * CD_SECS * CD_FRAMES * CD_FRAMESIZE)
292 #define CD_MAX_SECTORS (CD_MAX_BYTES / 512)
295 * The MMC values are not IDE specific and might need to be moved
296 * to a common header if they are also needed for the SCSI emulation
299 /* Profile list from MMC-6 revision 1 table 91 */
300 #define MMC_PROFILE_NONE 0x0000
301 #define MMC_PROFILE_CD_ROM 0x0008
302 #define MMC_PROFILE_CD_R 0x0009
303 #define MMC_PROFILE_CD_RW 0x000A
304 #define MMC_PROFILE_DVD_ROM 0x0010
305 #define MMC_PROFILE_DVD_R_SR 0x0011
306 #define MMC_PROFILE_DVD_RAM 0x0012
307 #define MMC_PROFILE_DVD_RW_RO 0x0013
308 #define MMC_PROFILE_DVD_RW_SR 0x0014
309 #define MMC_PROFILE_DVD_R_DL_SR 0x0015
310 #define MMC_PROFILE_DVD_R_DL_JR 0x0016
311 #define MMC_PROFILE_DVD_RW_DL 0x0017
312 #define MMC_PROFILE_DVD_DDR 0x0018
313 #define MMC_PROFILE_DVD_PLUS_RW 0x001A
314 #define MMC_PROFILE_DVD_PLUS_R 0x001B
315 #define MMC_PROFILE_DVD_PLUS_RW_DL 0x002A
316 #define MMC_PROFILE_DVD_PLUS_R_DL 0x002B
317 #define MMC_PROFILE_BD_ROM 0x0040
318 #define MMC_PROFILE_BD_R_SRM 0x0041
319 #define MMC_PROFILE_BD_R_RRM 0x0042
320 #define MMC_PROFILE_BD_RE 0x0043
321 #define MMC_PROFILE_HDDVD_ROM 0x0050
322 #define MMC_PROFILE_HDDVD_R 0x0051
323 #define MMC_PROFILE_HDDVD_RAM 0x0052
324 #define MMC_PROFILE_HDDVD_RW 0x0053
325 #define MMC_PROFILE_HDDVD_R_DL 0x0058
326 #define MMC_PROFILE_HDDVD_RW_DL 0x005A
327 #define MMC_PROFILE_INVALID 0xFFFF
329 #define ATAPI_INT_REASON_CD 0x01 /* 0 = data transfer */
330 #define ATAPI_INT_REASON_IO 0x02 /* 1 = transfer to the host */
331 #define ATAPI_INT_REASON_REL 0x04
332 #define ATAPI_INT_REASON_TAG 0xf8
334 /* same constants as bochs */
335 #define ASC_ILLEGAL_OPCODE 0x20
336 #define ASC_LOGICAL_BLOCK_OOR 0x21
337 #define ASC_INV_FIELD_IN_CMD_PACKET 0x24
338 #define ASC_MEDIUM_MAY_HAVE_CHANGED 0x28
339 #define ASC_INCOMPATIBLE_FORMAT 0x30
340 #define ASC_MEDIUM_NOT_PRESENT 0x3a
341 #define ASC_SAVING_PARAMETERS_NOT_SUPPORTED 0x39
342 #define ASC_MEDIA_REMOVAL_PREVENTED 0x53
344 #define CFA_NO_ERROR 0x00
345 #define CFA_MISC_ERROR 0x09
346 #define CFA_INVALID_COMMAND 0x20
347 #define CFA_INVALID_ADDRESS 0x21
348 #define CFA_ADDRESS_OVERFLOW 0x2f
351 #define SENSE_NOT_READY 2
352 #define SENSE_ILLEGAL_REQUEST 5
353 #define SENSE_UNIT_ATTENTION 6
355 #define SMART_READ_DATA 0xd0
356 #define SMART_READ_THRESH 0xd1
357 #define SMART_ATTR_AUTOSAVE 0xd2
358 #define SMART_SAVE_ATTR 0xd3
359 #define SMART_EXECUTE_OFFLINE 0xd4
360 #define SMART_READ_LOG 0xd5
361 #define SMART_WRITE_LOG 0xd6
362 #define SMART_ENABLE 0xd8
363 #define SMART_DISABLE 0xd9
364 #define SMART_STATUS 0xda
366 typedef enum { IDE_HD
, IDE_CD
, IDE_CFATA
} IDEDriveKind
;
368 typedef void EndTransferFunc(IDEState
*);
370 /* NOTE: IDEState represents in fact one drive */
375 IDEDriveKind drive_kind
;
376 int cylinders
, heads
, sectors
;
380 uint8_t identify_data
[512];
382 char drive_serial_str
[21];
390 /* other part of tf for lba48 support */
400 /* set for lba48 access */
402 BlockDriverState
*bs
;
407 uint8_t cdrom_changed
;
408 int packet_transfer_size
;
409 int elementary_transfer_size
;
413 int atapi_dma
; /* true if dma is requested for the packet cmd */
417 /* PIO transfer handling */
418 int req_nb_sectors
; /* number of sectors per interrupt */
419 EndTransferFunc
*end_transfer_func
;
423 /* PIO save/restore */
424 int32_t io_buffer_total_len
;
425 int cur_io_buffer_offset
;
426 int cur_io_buffer_len
;
427 uint8_t end_transfer_fn_idx
;
428 QEMUTimer
*sector_write_timer
; /* only used for win2k install hack */
429 uint32_t irq_count
; /* counts IRQs when using win2k install hack */
430 /* CF-ATA extended error */
432 /* CF-ATA metadata storage */
434 uint8_t *mdata_storage
;
439 uint8_t smart_enabled
;
440 uint8_t smart_autosave
;
442 uint8_t smart_selftest_count
;
443 uint8_t *smart_selftest_data
;
466 typedef int (*ide_qdev_initfn
)(IDEDevice
*dev
);
467 struct IDEDeviceInfo
{
469 ide_qdev_initfn init
;
472 #define BM_STATUS_DMAING 0x01
473 #define BM_STATUS_ERROR 0x02
474 #define BM_STATUS_INT 0x04
475 #define BM_STATUS_DMA_RETRY 0x08
476 #define BM_STATUS_PIO_RETRY 0x10
477 #define BM_STATUS_RETRY_READ 0x20
478 #define BM_STATUS_RETRY_FLUSH 0x40
480 #define BM_CMD_START 0x01
481 #define BM_CMD_READ 0x08
489 /* current transfer state */
491 uint32_t cur_prd_last
;
492 uint32_t cur_prd_addr
;
493 uint32_t cur_prd_len
;
495 BlockDriverCompletionFunc
*dma_cb
;
496 BlockDriverAIOCB
*aiocb
;
505 static inline IDEState
*idebus_active_if(IDEBus
*bus
)
507 return bus
->ifs
+ bus
->unit
;
510 static inline IDEState
*bmdma_active_if(BMDMAState
*bmdma
)
512 assert(bmdma
->unit
!= (uint8_t)-1);
513 return bmdma
->bus
->ifs
+ bmdma
->unit
;
516 static inline void ide_set_irq(IDEBus
*bus
)
518 BMDMAState
*bm
= bus
->bmdma
;
519 if (!(bus
->cmd
& IDE_CMD_DISABLE_IRQ
)) {
521 bm
->status
|= BM_STATUS_INT
;
523 qemu_irq_raise(bus
->irq
);
528 extern const VMStateDescription vmstate_ide_bus
;
530 #define VMSTATE_IDE_BUS(_field, _state) \
531 VMSTATE_STRUCT(_field, _state, 1, vmstate_ide_bus, IDEBus)
533 #define VMSTATE_IDE_BUS_ARRAY(_field, _state, _num) \
534 VMSTATE_STRUCT_ARRAY(_field, _state, _num, 1, vmstate_ide_bus, IDEBus)
536 extern const VMStateDescription vmstate_ide_drive
;
538 #define VMSTATE_IDE_DRIVES(_field, _state) \
539 VMSTATE_STRUCT_ARRAY(_field, _state, 2, 3, vmstate_ide_drive, IDEState)
541 void ide_bus_reset(IDEBus
*bus
);
542 int64_t ide_get_sector(IDEState
*s
);
543 void ide_set_sector(IDEState
*s
, int64_t sector_num
);
545 void ide_dma_cancel(BMDMAState
*bm
);
546 void ide_dma_restart_cb(void *opaque
, int running
, int reason
);
547 void ide_dma_error(IDEState
*s
);
548 void ide_dma_reset(BMDMAState
*bm
);
550 void ide_atapi_cmd_ok(IDEState
*s
);
551 void ide_atapi_cmd_error(IDEState
*s
, int sense_key
, int asc
);
552 void ide_atapi_io_error(IDEState
*s
, int ret
);
554 void ide_ioport_write(void *opaque
, uint32_t addr
, uint32_t val
);
555 uint32_t ide_ioport_read(void *opaque
, uint32_t addr1
);
556 uint32_t ide_status_read(void *opaque
, uint32_t addr
);
557 void ide_cmd_write(void *opaque
, uint32_t addr
, uint32_t val
);
558 void ide_data_writew(void *opaque
, uint32_t addr
, uint32_t val
);
559 uint32_t ide_data_readw(void *opaque
, uint32_t addr
);
560 void ide_data_writel(void *opaque
, uint32_t addr
, uint32_t val
);
561 uint32_t ide_data_readl(void *opaque
, uint32_t addr
);
563 int ide_init_drive(IDEState
*s
, BlockDriverState
*bs
,
564 const char *version
, const char *serial
);
565 void ide_init2(IDEBus
*bus
, qemu_irq irq
);
566 void ide_init2_with_non_qdev_drives(IDEBus
*bus
, DriveInfo
*hd0
,
567 DriveInfo
*hd1
, qemu_irq irq
);
568 void ide_init_ioport(IDEBus
*bus
, int iobase
, int iobase2
);
571 void ide_bus_new(IDEBus
*idebus
, DeviceState
*dev
, int bus_id
);
572 IDEDevice
*ide_create_drive(IDEBus
*bus
, int unit
, DriveInfo
*drive
);
574 #endif /* HW_IDE_INTERNAL_H */