blob: e4629b023ad7449612f8544e1d80365c33ce78a2 [file] [log] [blame]
Gerd Hoffmann356721a2009-08-20 15:22:18 +02001#ifndef HW_IDE_INTERNAL_H
2#define HW_IDE_INTERNAL_H
3
4/*
5 * QEMU IDE Emulation -- internal header file
Gerd Hoffmann59f2a782009-08-20 15:22:26 +02006 * only files in hw/ide/ are supposed to include this file.
Gerd Hoffmann356721a2009-08-20 15:22:18 +02007 * non-internal declarations are in hw/ide.h
8 */
Gerd Hoffmann59f2a782009-08-20 15:22:26 +02009#include <hw/ide.h>
Paolo Bonzini0d09e412013-02-05 17:06:20 +010010#include <hw/isa/isa.h>
Paolo Bonzini9c17d612012-12-17 18:20:04 +010011#include "sysemu/dma.h"
12#include "sysemu/sysemu.h"
Paolo Bonzini0d09e412013-02-05 17:06:20 +010013#include "hw/block/block.h"
14#include "block/scsi.h"
Gerd Hoffmann356721a2009-08-20 15:22:18 +020015
16/* debug IDE devices */
17//#define DEBUG_IDE
18//#define DEBUG_IDE_ATAPI
19//#define DEBUG_AIO
20#define USE_DMA_CDROM
21
22typedef struct IDEBus IDEBus;
Gerd Hoffmannda4d0412009-09-15 19:23:34 +000023typedef struct IDEDevice IDEDevice;
Gerd Hoffmann356721a2009-08-20 15:22:18 +020024typedef struct IDEState IDEState;
Alexander Graf40a62382010-12-15 00:23:00 +010025typedef struct IDEDMA IDEDMA;
26typedef struct IDEDMAOps IDEDMAOps;
Gerd Hoffmann356721a2009-08-20 15:22:18 +020027
Anthony Liguori0d936922012-05-02 09:00:20 +020028#define TYPE_IDE_BUS "IDE"
29#define IDE_BUS(obj) OBJECT_CHECK(IDEBus, (obj), TYPE_IDE_BUS)
30
Gerd Hoffmann356721a2009-08-20 15:22:18 +020031/* Bits of HD_STATUS */
32#define ERR_STAT 0x01
33#define INDEX_STAT 0x02
34#define ECC_STAT 0x04 /* Corrected error */
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/* Bits for HD_ERROR */
43#define MARK_ERR 0x01 /* Bad address mark */
44#define TRK0_ERR 0x02 /* couldn't find track 0 */
45#define ABRT_ERR 0x04 /* Command aborted */
46#define MCR_ERR 0x08 /* media change request */
47#define ID_ERR 0x10 /* ID field not found */
48#define MC_ERR 0x20 /* media changed */
49#define ECC_ERR 0x40 /* Uncorrectable ECC error */
50#define BBD_ERR 0x80 /* pre-EIDE meaning: block marked bad */
51#define ICRC_ERR 0x80 /* new meaning: CRC error during transfer */
52
53/* Bits of HD_NSECTOR */
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
Markus Armbruster1d4316d2011-08-03 15:07:43 +020062/* ACS-2 T13/2015-D Table B.2 Command codes */
Gerd Hoffmann356721a2009-08-20 15:22:18 +020063#define WIN_NOP 0x00
Markus Armbruster1d4316d2011-08-03 15:07:43 +020064/* reserved 0x01..0x02 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +020065#define CFA_REQ_EXT_ERROR_CODE 0x03 /* CFA Request Extended Error Code */
Markus Armbruster1d4316d2011-08-03 15:07:43 +020066/* reserved 0x04..0x05 */
Christoph Hellwigd353fb72011-05-19 10:58:19 +020067#define WIN_DSM 0x06
Markus Armbruster1d4316d2011-08-03 15:07:43 +020068/* reserved 0x07 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +020069#define WIN_DEVICE_RESET 0x08
Markus Armbruster1d4316d2011-08-03 15:07:43 +020070/* reserved 0x09..0x0a */
71/* REQUEST SENSE DATA EXT 0x0B */
72/* reserved 0x0C..0x0F */
73#define WIN_RECAL 0x10 /* obsolete since ATA4 */
74/* obsolete since ATA3, retired in ATA4 0x11..0x1F */
Gerd Hoffmann356721a2009-08-20 15:22:18 +020075#define WIN_READ 0x20 /* 28-Bit */
Markus Armbruster1d4316d2011-08-03 15:07:43 +020076#define WIN_READ_ONCE 0x21 /* 28-Bit w/o retries, obsolete since ATA5 */
77/* obsolete since ATA4 0x22..0x23 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +020078#define WIN_READ_EXT 0x24 /* 48-Bit */
79#define WIN_READDMA_EXT 0x25 /* 48-Bit */
Markus Armbruster1d4316d2011-08-03 15:07:43 +020080#define WIN_READDMA_QUEUED_EXT 0x26 /* 48-Bit, obsolete since ACS2 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +020081#define WIN_READ_NATIVE_MAX_EXT 0x27 /* 48-Bit */
Markus Armbruster1d4316d2011-08-03 15:07:43 +020082/* reserved 0x28 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +020083#define WIN_MULTREAD_EXT 0x29 /* 48-Bit */
Markus Armbruster1d4316d2011-08-03 15:07:43 +020084/* READ STREAM DMA EXT 0x2A */
85/* READ STREAM EXT 0x2B */
86/* reserved 0x2C..0x2E */
87/* READ LOG EXT 0x2F */
Gerd Hoffmann356721a2009-08-20 15:22:18 +020088#define WIN_WRITE 0x30 /* 28-Bit */
Markus Armbruster1d4316d2011-08-03 15:07:43 +020089#define WIN_WRITE_ONCE 0x31 /* 28-Bit w/o retries, obsolete since ATA5 */
90/* obsolete since ATA4 0x32..0x33 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +020091#define WIN_WRITE_EXT 0x34 /* 48-Bit */
92#define WIN_WRITEDMA_EXT 0x35 /* 48-Bit */
93#define WIN_WRITEDMA_QUEUED_EXT 0x36 /* 48-Bit */
Markus Armbruster1d4316d2011-08-03 15:07:43 +020094#define WIN_SET_MAX_EXT 0x37 /* 48-Bit, obsolete since ACS2 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +020095#define WIN_SET_MAX_EXT 0x37 /* 48-Bit */
96#define CFA_WRITE_SECT_WO_ERASE 0x38 /* CFA Write Sectors without erase */
97#define WIN_MULTWRITE_EXT 0x39 /* 48-Bit */
Markus Armbruster1d4316d2011-08-03 15:07:43 +020098/* WRITE STREAM DMA EXT 0x3A */
99/* WRITE STREAM EXT 0x3B */
100#define WIN_WRITE_VERIFY 0x3C /* 28-Bit, obsolete since ATA4 */
101/* WRITE DMA FUA EXT 0x3D */
102/* obsolete since ACS2 0x3E */
103/* WRITE LOG EXT 0x3F */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200104#define WIN_VERIFY 0x40 /* 28-Bit - Read Verify Sectors */
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200105#define WIN_VERIFY_ONCE 0x41 /* 28-Bit - w/o retries, obsolete since ATA5 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200106#define WIN_VERIFY_EXT 0x42 /* 48-Bit */
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200107/* reserved 0x43..0x44 */
108/* WRITE UNCORRECTABLE EXT 0x45 */
109/* reserved 0x46 */
110/* READ LOG DMA EXT 0x47 */
111/* reserved 0x48..0x4F */
112/* obsolete since ATA4 0x50 */
113/* CONFIGURE STREAM 0x51 */
114/* reserved 0x52..0x56 */
115/* WRITE LOG DMA EXT 0x57 */
116/* reserved 0x58..0x5A */
117/* TRUSTED NON DATA 0x5B */
118/* TRUSTED RECEIVE 0x5C */
119/* TRUSTED RECEIVE DMA 0x5D */
120/* TRUSTED SEND 0x5E */
121/* TRUSTED SEND DMA 0x5F */
122/* READ FPDMA QUEUED 0x60 */
123/* WRITE FPDMA QUEUED 0x61 */
124/* reserved 0x62->0x6F */
125#define WIN_SEEK 0x70 /* obsolete since ATA7 */
126/* reserved 0x71-0x7F */
127/* vendor specific 0x80-0x86 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200128#define CFA_TRANSLATE_SECTOR 0x87 /* CFA Translate Sector */
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200129/* vendor specific 0x88-0x8F */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200130#define WIN_DIAGNOSE 0x90
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200131#define WIN_SPECIFY 0x91 /* set drive geometry translation, obsolete since ATA6 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200132#define WIN_DOWNLOAD_MICROCODE 0x92
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200133/* DOWNLOAD MICROCODE DMA 0x93 */
134#define WIN_STANDBYNOW2 0x94 /* retired in ATA4 */
135#define WIN_IDLEIMMEDIATE2 0x95 /* force drive to become "ready", retired in ATA4 */
136#define WIN_STANDBY2 0x96 /* retired in ATA4 */
137#define WIN_SETIDLE2 0x97 /* retired in ATA4 */
138#define WIN_CHECKPOWERMODE2 0x98 /* retired in ATA4 */
139#define WIN_SLEEPNOW2 0x99 /* retired in ATA4 */
140/* vendor specific 0x9A */
141/* reserved 0x9B..0x9F */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200142#define WIN_PACKETCMD 0xA0 /* Send a packet command. */
143#define WIN_PIDENTIFY 0xA1 /* identify ATAPI device */
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200144#define WIN_QUEUED_SERVICE 0xA2 /* obsolete since ACS2 */
145/* reserved 0xA3..0xAF */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200146#define WIN_SMART 0xB0 /* self-monitoring and reporting */
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200147/* Device Configuration Overlay 0xB1 */
148/* reserved 0xB2..0xB3 */
149/* Sanitize Device 0xB4 */
150/* reserved 0xB5 */
151/* NV Cache 0xB6 */
152/* reserved for CFA 0xB7..0xBB */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200153#define CFA_ACCESS_METADATA_STORAGE 0xB8
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200154/* reserved 0xBC..0xBF */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200155#define CFA_ERASE_SECTORS 0xC0 /* microdrives implement as NOP */
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200156/* vendor specific 0xC1..0xC3 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200157#define WIN_MULTREAD 0xC4 /* read sectors using multiple mode*/
158#define WIN_MULTWRITE 0xC5 /* write sectors using multiple mode */
159#define WIN_SETMULT 0xC6 /* enable/disable multiple mode */
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200160#define WIN_READDMA_QUEUED 0xC7 /* read sectors using Queued DMA transfers, obsolete since ACS2 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200161#define WIN_READDMA 0xC8 /* read sectors using DMA transfers */
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200162#define WIN_READDMA_ONCE 0xC9 /* 28-Bit - w/o retries, obsolete since ATA5 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200163#define WIN_WRITEDMA 0xCA /* write sectors using DMA transfers */
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200164#define WIN_WRITEDMA_ONCE 0xCB /* 28-Bit - w/o retries, obsolete since ATA5 */
165#define WIN_WRITEDMA_QUEUED 0xCC /* write sectors using Queued DMA transfers, obsolete since ACS2 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200166#define CFA_WRITE_MULTI_WO_ERASE 0xCD /* CFA Write multiple without erase */
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200167/* WRITE MULTIPLE FUA EXT 0xCE */
168/* reserved 0xCF..0xDO */
169/* CHECK MEDIA CARD TYPE 0xD1 */
170/* reserved for media card pass through 0xD2..0xD4 */
171/* reserved 0xD5..0xD9 */
172#define WIN_GETMEDIASTATUS 0xDA /* obsolete since ATA8 */
173/* obsolete since ATA3, retired in ATA4 0xDB..0xDD */
174#define WIN_DOORLOCK 0xDE /* lock door on removable drives, obsolete since ATA8 */
175#define WIN_DOORUNLOCK 0xDF /* unlock door on removable drives, obsolete since ATA8 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200176#define WIN_STANDBYNOW1 0xE0
177#define WIN_IDLEIMMEDIATE 0xE1 /* force drive to become "ready" */
178#define WIN_STANDBY 0xE2 /* Set device in Standby Mode */
179#define WIN_SETIDLE1 0xE3
180#define WIN_READ_BUFFER 0xE4 /* force read only 1 sector */
181#define WIN_CHECKPOWERMODE1 0xE5
182#define WIN_SLEEPNOW1 0xE6
183#define WIN_FLUSH_CACHE 0xE7
184#define WIN_WRITE_BUFFER 0xE8 /* force write only 1 sector */
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200185/* READ BUFFER DMA 0xE9 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200186#define WIN_FLUSH_CACHE_EXT 0xEA /* 48-Bit */
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200187/* WRITE BUFFER DMA 0xEB */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200188#define WIN_IDENTIFY 0xEC /* ask drive to identify itself */
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200189#define WIN_MEDIAEJECT 0xED /* obsolete since ATA8 */
190/* obsolete since ATA4 0xEE */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200191#define WIN_SETFEATURES 0xEF /* set special drive features */
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200192#define IBM_SENSE_CONDITION 0xF0 /* measure disk temperature, vendor specific */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200193#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
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200198#define CFA_WEAR_LEVEL 0xF5 /* microdrives implement as NOP; not specified in T13! */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200199#define WIN_SECURITY_DISABLE 0xF6
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200200/* vendor specific 0xF7 */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200201#define WIN_READ_NATIVE_MAX 0xF8 /* return the native maximum address */
202#define WIN_SET_MAX 0xF9
Markus Armbruster1d4316d2011-08-03 15:07:43 +0200203/* vendor specific 0xFA..0xFF */
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200204
205/* set to 1 set disable mult support */
206#define MAX_MULT_SECTORS 16
207
208#define IDE_DMA_BUF_SECTORS 256
209
Christoph Hellwigd353fb72011-05-19 10:58:19 +0200210/* feature values for Data Set Management */
211#define DSM_TRIM 0x01
212
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200213#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/* ATAPI defines */
218
219#define ATAPI_PACKET_SIZE 12
220
221/* The generic packet command opcodes for CD/DVD Logical Units,
222 * From Table 57 of the SFF8090 Ver. 3 (Mt. Fuji) draft standard. */
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/* This is listed as optional in ATAPI 2.6, but is (curiously)
272 * missing from Mt. Fuji, Table 57. It _is_ mentioned in Mt. Fuji
273 * Table 377 as an MMC command for SCSi devices though... Most ATAPI
274 * drives support it. */
275#define GPCMD_SET_SPEED 0xbb
276/* This seems to be a SCSI specific CD-ROM opcode
277 * to play data at track/index */
278#define GPCMD_PLAYAUDIO_TI 0x48
279/*
280 * From MS Media Status Notification Support Specification. For
281 * older drives only.
282 */
283#define GPCMD_GET_MEDIA_STATUS 0xda
284#define GPCMD_MODE_SENSE_6 0x1a
285
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200286#define ATAPI_INT_REASON_CD 0x01 /* 0 = data transfer */
287#define ATAPI_INT_REASON_IO 0x02 /* 1 = transfer to the host */
288#define ATAPI_INT_REASON_REL 0x04
289#define ATAPI_INT_REASON_TAG 0xf8
290
291/* same constants as bochs */
Dr. David Alan Gilberta71754e2014-12-09 18:15:09 +0000292#define ASC_NO_SEEK_COMPLETE 0x02
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200293#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
John Snow9a502562014-12-10 13:17:07 -0500300#define ASC_DATA_PHASE_ERROR 0x4b
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200301#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
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200309#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
Markus Armbrustercd8722b2010-05-28 13:32:45 +0200320typedef enum { IDE_HD, IDE_CD, IDE_CFATA } IDEDriveKind;
321
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200322typedef void EndTransferFunc(IDEState *);
323
Markus Armbruster097310b2014-10-07 13:59:15 +0200324typedef void DMAStartFunc(IDEDMA *, IDEState *, BlockCompletionFunc *);
Paolo Bonzini1374bec2014-08-04 17:11:06 -0400325typedef void DMAVoidFunc(IDEDMA *);
Alexander Graf40a62382010-12-15 00:23:00 +0100326typedef int DMAIntFunc(IDEDMA *, int);
John Snowa7189782015-07-04 02:06:04 -0400327typedef int32_t DMAInt32Func(IDEDMA *, int32_t len);
John Snow659142e2014-10-01 18:55:47 -0400328typedef void DMAu32Func(IDEDMA *, uint32_t);
Paolo Bonzini0e7ce542014-08-04 17:11:12 -0400329typedef void DMAStopFunc(IDEDMA *, bool);
Luiz Capitulino1dfb4dd2011-07-29 14:26:33 -0300330typedef void DMARestartFunc(void *, int, RunState);
Alexander Graf40a62382010-12-15 00:23:00 +0100331
Amit Shah996faf12011-04-12 21:36:07 +0530332struct unreported_events {
333 bool eject_request;
334 bool new_media;
335};
336
Christoph Hellwig4e1e0052011-05-19 10:58:09 +0200337enum ide_dma_cmd {
338 IDE_DMA_READ,
339 IDE_DMA_WRITE,
Christoph Hellwigd353fb72011-05-19 10:58:19 +0200340 IDE_DMA_TRIM,
Christoph Hellwig4e1e0052011-05-19 10:58:09 +0200341};
342
343#define ide_cmd_is_read(s) \
344 ((s)->dma_cmd == IDE_DMA_READ)
345
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200346/* NOTE: IDEState represents in fact one drive */
347struct IDEState {
348 IDEBus *bus;
349 uint8_t unit;
350 /* ide config */
Markus Armbrustercd8722b2010-05-28 13:32:45 +0200351 IDEDriveKind drive_kind;
Markus Armbruster91390462012-07-10 11:12:38 +0200352 int cylinders, heads, sectors, chs_trans;
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200353 int64_t nb_sectors;
354 int mult_sectors;
355 int identify_set;
Juan Quintela96c35ce2009-10-07 17:58:34 +0200356 uint8_t identify_data[512];
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200357 int drive_serial;
358 char drive_serial_str[21];
Floris Bos27e0c9a2012-03-12 21:05:09 +0100359 char drive_model_str[41];
Floris Bos95ebda82012-03-13 13:31:47 +0100360 uint64_t wwn;
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200361 /* ide regs */
362 uint8_t feature;
363 uint8_t error;
364 uint32_t nsector;
365 uint8_t sector;
366 uint8_t lcyl;
367 uint8_t hcyl;
368 /* other part of tf for lba48 support */
369 uint8_t hob_feature;
370 uint8_t hob_nsector;
371 uint8_t hob_sector;
372 uint8_t hob_lcyl;
373 uint8_t hob_hcyl;
374
375 uint8_t select;
376 uint8_t status;
377
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200378 /* set for lba48 access */
379 uint8_t lba48;
Markus Armbruster4be74632014-10-07 13:59:18 +0200380 BlockBackend *blk;
Gerd Hoffmann47c06342010-01-14 14:44:12 +0100381 char version[9];
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200382 /* ATAPI specific */
Amit Shah996faf12011-04-12 21:36:07 +0530383 struct unreported_events events;
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200384 uint8_t sense_key;
385 uint8_t asc;
Markus Armbrusterdd063332011-09-06 18:58:38 +0200386 bool tray_open;
Markus Armbrustera0a75732011-09-06 18:58:43 +0200387 bool tray_locked;
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200388 uint8_t cdrom_changed;
389 int packet_transfer_size;
390 int elementary_transfer_size;
John Snow3251bdc2014-10-31 16:03:39 -0400391 int32_t io_buffer_index;
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200392 int lba;
393 int cd_sector_size;
394 int atapi_dma; /* true if dma is requested for the packet cmd */
Christoph Hellwiga597e792011-08-25 08:26:01 +0200395 BlockAcctCookie acct;
Markus Armbruster7c84b1b2014-10-07 13:59:14 +0200396 BlockAIOCB *pio_aiocb;
Stefan Hajnoczibef0fd52012-03-29 10:31:30 +0100397 struct iovec iov;
398 QEMUIOVector qiov;
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200399 /* ATA DMA state */
John Snow9fbf0fa2015-11-06 14:09:00 -0500400 uint64_t io_buffer_offset;
John Snow3251bdc2014-10-31 16:03:39 -0400401 int32_t io_buffer_size;
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200402 QEMUSGList sg;
403 /* PIO transfer handling */
404 int req_nb_sectors; /* number of sectors per interrupt */
405 EndTransferFunc *end_transfer_func;
406 uint8_t *data_ptr;
407 uint8_t *data_end;
408 uint8_t *io_buffer;
Juan Quintela50641c52010-07-26 21:38:44 +0200409 /* PIO save/restore */
410 int32_t io_buffer_total_len;
John Snow3251bdc2014-10-31 16:03:39 -0400411 int32_t cur_io_buffer_offset;
412 int32_t cur_io_buffer_len;
Juan Quintela50641c52010-07-26 21:38:44 +0200413 uint8_t end_transfer_fn_idx;
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200414 QEMUTimer *sector_write_timer; /* only used for win2k install hack */
415 uint32_t irq_count; /* counts IRQs when using win2k install hack */
416 /* CF-ATA extended error */
417 uint8_t ext_error;
418 /* CF-ATA metadata storage */
419 uint32_t mdata_size;
420 uint8_t *mdata_storage;
421 int media_changed;
Christoph Hellwig4e1e0052011-05-19 10:58:09 +0200422 enum ide_dma_cmd dma_cmd;
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200423 /* SMART */
424 uint8_t smart_enabled;
425 uint8_t smart_autosave;
426 int smart_errors;
427 uint8_t smart_selftest_count;
428 uint8_t *smart_selftest_data;
Roland Elekccf0fd82010-12-14 01:34:37 +0100429 /* AHCI */
430 int ncq_queues;
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200431};
432
Alexander Graf40a62382010-12-15 00:23:00 +0100433struct IDEDMAOps {
434 DMAStartFunc *start_dma;
Paolo Bonzini44635122014-08-04 17:11:09 -0400435 DMAVoidFunc *start_transfer;
John Snow3251bdc2014-10-31 16:03:39 -0400436 DMAInt32Func *prepare_buf;
John Snow659142e2014-10-01 18:55:47 -0400437 DMAu32Func *commit_buf;
Alexander Graf40a62382010-12-15 00:23:00 +0100438 DMAIntFunc *rw_buf;
John Snow7c03a692015-07-04 02:06:04 -0400439 DMAVoidFunc *restart;
Paolo Bonzinibd8892c2015-02-23 11:17:51 -0500440 DMAVoidFunc *restart_dma;
Paolo Bonzini0e7ce542014-08-04 17:11:12 -0400441 DMAStopFunc *set_inactive;
Paolo Bonzinic7e73ad2014-08-04 17:11:17 -0400442 DMAVoidFunc *cmd_done;
Paolo Bonzini1374bec2014-08-04 17:11:06 -0400443 DMAVoidFunc *reset;
Alexander Graf40a62382010-12-15 00:23:00 +0100444};
445
446struct IDEDMA {
447 const struct IDEDMAOps *ops;
448 struct iovec iov;
449 QEMUIOVector qiov;
Markus Armbruster7c84b1b2014-10-07 13:59:14 +0200450 BlockAIOCB *aiocb;
Alexander Graf40a62382010-12-15 00:23:00 +0100451};
452
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200453struct IDEBus {
454 BusState qbus;
Gerd Hoffmannda4d0412009-09-15 19:23:34 +0000455 IDEDevice *master;
456 IDEDevice *slave;
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200457 IDEState ifs[2];
Paolo Bonzini98985862015-02-23 11:17:55 -0500458 QEMUBH *bh;
459
Gleb Natapov38355102010-12-08 13:34:58 +0200460 int bus_id;
Kevin Wolf0ee20e62013-05-06 15:58:04 +0200461 int max_units;
Alexander Graf40a62382010-12-15 00:23:00 +0100462 IDEDMA *dma;
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200463 uint8_t unit;
Gerd Hoffmann9cdd03a2009-08-28 16:37:42 +0200464 uint8_t cmd;
465 qemu_irq irq;
Kevin Wolfdef93792011-05-26 15:00:34 +0200466
467 int error_status;
Paolo Bonzinia96cb232015-02-23 11:17:57 -0500468 uint8_t retry_unit;
Paolo Bonzinidc5d0af2015-02-23 11:17:58 -0500469 int64_t retry_sector_num;
470 uint32_t retry_nsector;
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200471};
472
Anthony Liguorid1482112011-12-16 13:41:12 -0600473#define TYPE_IDE_DEVICE "ide-device"
474#define IDE_DEVICE(obj) \
475 OBJECT_CHECK(IDEDevice, (obj), TYPE_IDE_DEVICE)
476#define IDE_DEVICE_CLASS(klass) \
477 OBJECT_CLASS_CHECK(IDEDeviceClass, (klass), TYPE_IDE_DEVICE)
478#define IDE_DEVICE_GET_CLASS(obj) \
479 OBJECT_GET_CLASS(IDEDeviceClass, (obj), TYPE_IDE_DEVICE)
480
481typedef struct IDEDeviceClass {
482 DeviceClass parent_class;
483 int (*init)(IDEDevice *dev);
484} IDEDeviceClass;
485
Gerd Hoffmannda4d0412009-09-15 19:23:34 +0000486struct IDEDevice {
487 DeviceState qdev;
488 uint32_t unit;
Christoph Hellwig428c1492010-02-10 23:37:09 +0100489 BlockConf conf;
Markus Armbruster6e6f61a2012-07-10 11:12:48 +0200490 int chs_trans;
Gerd Hoffmann47c06342010-01-14 14:44:12 +0100491 char *version;
Markus Armbruster6ced55a2010-06-01 20:32:32 +0200492 char *serial;
Floris Bos27e0c9a2012-03-12 21:05:09 +0100493 char *model;
Floris Bos95ebda82012-03-13 13:31:47 +0100494 uint64_t wwn;
Gerd Hoffmannda4d0412009-09-15 19:23:34 +0000495};
496
Paolo Bonzinifd648f12014-08-04 17:11:14 -0400497/* These are used for the error_status field of IDEBus */
498#define IDE_RETRY_DMA 0x08
499#define IDE_RETRY_PIO 0x10
500#define IDE_RETRY_READ 0x20
501#define IDE_RETRY_FLUSH 0x40
502#define IDE_RETRY_TRIM 0x80
John Snow7c03a692015-07-04 02:06:04 -0400503#define IDE_RETRY_HBA 0x100
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200504
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200505static inline IDEState *idebus_active_if(IDEBus *bus)
506{
507 return bus->ifs + bus->unit;
508}
509
Gerd Hoffmann9cdd03a2009-08-28 16:37:42 +0200510static inline void ide_set_irq(IDEBus *bus)
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200511{
Gerd Hoffmann9cdd03a2009-08-28 16:37:42 +0200512 if (!(bus->cmd & IDE_CMD_DISABLE_IRQ)) {
Gerd Hoffmann9cdd03a2009-08-28 16:37:42 +0200513 qemu_irq_raise(bus->irq);
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200514 }
515}
516
Gerd Hoffmannda4d0412009-09-15 19:23:34 +0000517/* hw/ide/core.c */
Juan Quintelab38436e2009-10-07 18:51:30 +0200518extern const VMStateDescription vmstate_ide_bus;
519
520#define VMSTATE_IDE_BUS(_field, _state) \
521 VMSTATE_STRUCT(_field, _state, 1, vmstate_ide_bus, IDEBus)
522
Juan Quintela407a4f32009-10-07 20:55:32 +0200523#define VMSTATE_IDE_BUS_ARRAY(_field, _state, _num) \
524 VMSTATE_STRUCT_ARRAY(_field, _state, _num, 1, vmstate_ide_bus, IDEBus)
525
Juan Quintelab38436e2009-10-07 18:51:30 +0200526extern const VMStateDescription vmstate_ide_drive;
527
528#define VMSTATE_IDE_DRIVES(_field, _state) \
529 VMSTATE_STRUCT_ARRAY(_field, _state, 2, 3, vmstate_ide_drive, IDEState)
530
John Snowbd664912015-02-23 11:18:03 -0500531#define VMSTATE_IDE_DRIVE(_field, _state) \
532 VMSTATE_STRUCT(_field, _state, 1, vmstate_ide_drive, IDEState)
533
Blue Swirl4a643562009-11-07 14:13:05 +0000534void ide_bus_reset(IDEBus *bus);
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200535int64_t ide_get_sector(IDEState *s);
536void ide_set_sector(IDEState *s, int64_t sector_num);
537
Markus Armbruster097310b2014-10-07 13:59:15 +0200538void ide_start_dma(IDEState *s, BlockCompletionFunc *cb);
John Snowaaeda4a2015-09-17 14:17:04 -0400539void dma_buf_commit(IDEState *s, uint32_t tx_bytes);
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200540void ide_dma_error(IDEState *s);
John Snow9ef2e932015-09-17 14:17:05 -0400541void ide_abort_command(IDEState *s);
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200542
543void ide_atapi_cmd_ok(IDEState *s);
544void ide_atapi_cmd_error(IDEState *s, int sense_key, int asc);
Dr. David Alan Gilberta71754e2014-12-09 18:15:09 +0000545void ide_atapi_dma_restart(IDEState *s);
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200546void ide_atapi_io_error(IDEState *s, int ret);
547
548void ide_ioport_write(void *opaque, uint32_t addr, uint32_t val);
549uint32_t ide_ioport_read(void *opaque, uint32_t addr1);
550uint32_t ide_status_read(void *opaque, uint32_t addr);
551void ide_cmd_write(void *opaque, uint32_t addr, uint32_t val);
552void ide_data_writew(void *opaque, uint32_t addr, uint32_t val);
553uint32_t ide_data_readw(void *opaque, uint32_t addr);
554void ide_data_writel(void *opaque, uint32_t addr, uint32_t val);
555uint32_t ide_data_readl(void *opaque, uint32_t addr);
556
Markus Armbruster4be74632014-10-07 13:59:18 +0200557int ide_init_drive(IDEState *s, BlockBackend *blk, IDEDriveKind kind,
Floris Bos95ebda82012-03-13 13:31:47 +0100558 const char *version, const char *serial, const char *model,
Markus Armbrusterba801962012-07-10 11:12:44 +0200559 uint64_t wwn,
560 uint32_t cylinders, uint32_t heads, uint32_t secs,
561 int chs_trans);
Markus Armbruster57234ee2010-06-01 20:32:29 +0200562void ide_init2(IDEBus *bus, qemu_irq irq);
Richard Henderson4a91d3b2011-08-16 08:59:00 -0700563void ide_init_ioport(IDEBus *bus, ISADevice *isa, int iobase, int iobase2);
Paolo Bonzinif878c912015-02-23 11:17:52 -0500564void ide_register_restart_cb(IDEBus *bus);
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200565
Alexander Graf7cff87f2010-12-14 01:34:33 +0100566void ide_exec_cmd(IDEBus *bus, uint32_t val);
567
Kevin Wolf33231e02011-04-18 16:45:49 +0200568void ide_transfer_start(IDEState *s, uint8_t *buf, int size,
569 EndTransferFunc *end_transfer_func);
570void ide_transfer_stop(IDEState *s);
Paolo Bonzini0e7ce542014-08-04 17:11:12 -0400571void ide_set_inactive(IDEState *s, bool more);
Markus Armbruster4be74632014-10-07 13:59:18 +0200572BlockAIOCB *ide_issue_trim(BlockBackend *blk,
Christoph Hellwigd353fb72011-05-19 10:58:19 +0200573 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
Markus Armbruster097310b2014-10-07 13:59:15 +0200574 BlockCompletionFunc *cb, void *opaque);
Kevin Wolf33231e02011-04-18 16:45:49 +0200575
576/* hw/ide/atapi.c */
577void ide_atapi_cmd(IDEState *s);
578void ide_atapi_cmd_reply_end(IDEState *s);
579
Gerd Hoffmannda4d0412009-09-15 19:23:34 +0000580/* hw/ide/qdev.c */
Andreas Färberc6baf942013-08-23 20:18:50 +0200581void ide_bus_new(IDEBus *idebus, size_t idebus_size, DeviceState *dev,
582 int bus_id, int max_units);
Gerd Hoffmannda4d0412009-09-15 19:23:34 +0000583IDEDevice *ide_create_drive(IDEBus *bus, int unit, DriveInfo *drive);
584
Gerd Hoffmann356721a2009-08-20 15:22:18 +0200585#endif /* HW_IDE_INTERNAL_H */