1 | /* $Id: ide.h 12931 2008-10-02 11:46:56Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * VBox storage devices: ATA/ATAPI declarations
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2006-2007 Sun Microsystems, Inc.
|
---|
8 | *
|
---|
9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
10 | * available from http://www.virtualbox.org. This file is free software;
|
---|
11 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
12 | * General Public License (GPL) as published by the Free Software
|
---|
13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
16 | *
|
---|
17 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
|
---|
18 | * Clara, CA 95054 USA or visit http://www.sun.com if you need
|
---|
19 | * additional information or have any questions.
|
---|
20 | */
|
---|
21 |
|
---|
22 | #ifndef ___Storage_IDE_h
|
---|
23 | #define ___Storage_IDE_h
|
---|
24 |
|
---|
25 |
|
---|
26 | /* Bits of HD_STATUS */
|
---|
27 | #define ATA_STAT_ERR 0x01
|
---|
28 | #define ATA_STAT_INDEX 0x02
|
---|
29 | #define ATA_STAT_ECC 0x04 /* Corrected error */
|
---|
30 | #define ATA_STAT_DRQ 0x08
|
---|
31 | #define ATA_STAT_SEEK 0x10
|
---|
32 | #define ATA_STAT_SRV 0x10
|
---|
33 | #define ATA_STAT_WRERR 0x20
|
---|
34 | #define ATA_STAT_READY 0x40
|
---|
35 | #define ATA_STAT_BUSY 0x80
|
---|
36 |
|
---|
37 | /* Bits for HD_ERROR */
|
---|
38 | #define MARK_ERR 0x01 /* Bad address mark */
|
---|
39 | #define TRK0_ERR 0x02 /* couldn't find track 0 */
|
---|
40 | #define ABRT_ERR 0x04 /* Command aborted */
|
---|
41 | #define MCR_ERR 0x08 /* media change request */
|
---|
42 | #define ID_ERR 0x10 /* ID field not found */
|
---|
43 | #define MC_ERR 0x20 /* media changed */
|
---|
44 | #define ECC_ERR 0x40 /* Uncorrectable ECC error */
|
---|
45 | #define BBD_ERR 0x80 /* pre-EIDE meaning: block marked bad */
|
---|
46 | #define ICRC_ERR 0x80 /* new meaning: CRC error during transfer */
|
---|
47 |
|
---|
48 | /* Bits for uATARegDevCtl. */
|
---|
49 | #define ATA_DEVCTL_DISABLE_IRQ 0x02
|
---|
50 | #define ATA_DEVCTL_RESET 0x04
|
---|
51 | #define ATA_DEVCTL_HOB 0x80
|
---|
52 |
|
---|
53 |
|
---|
54 | /* ATA/ATAPI Commands (as of ATA/ATAPI-8 draft T13/1699D Revision 3a).
|
---|
55 | * Please keep this in sync with g_apszATACmdNames. */
|
---|
56 | typedef enum ATACMD
|
---|
57 | {
|
---|
58 | ATA_NOP = 0x00,
|
---|
59 | ATA_CFA_REQUEST_EXTENDED_ERROR_CODE = 0x03,
|
---|
60 | ATA_DEVICE_RESET = 0x08,
|
---|
61 | ATA_RECALIBRATE = 0x10,
|
---|
62 | ATA_READ_SECTORS = 0x20,
|
---|
63 | ATA_READ_SECTORS_WITHOUT_RETRIES = 0x21,
|
---|
64 | ATA_READ_LONG = 0x22,
|
---|
65 | ATA_READ_LONG_WITHOUT_RETRIES = 0x23,
|
---|
66 | ATA_READ_SECTORS_EXT = 0x24,
|
---|
67 | ATA_READ_DMA_EXT = 0x25,
|
---|
68 | ATA_READ_DMA_QUEUED_EXT = 0x26,
|
---|
69 | ATA_READ_NATIVE_MAX_ADDRESS_EXT = 0x27,
|
---|
70 | ATA_READ_MULTIPLE_EXT = 0x29,
|
---|
71 | ATA_READ_STREAM_DMA_EXT = 0x2a,
|
---|
72 | ATA_READ_STREAM_EXT = 0x2b,
|
---|
73 | ATA_READ_LOG_EXT = 0x2f,
|
---|
74 | ATA_WRITE_SECTORS = 0x30,
|
---|
75 | ATA_WRITE_SECTORS_WITHOUT_RETRIES = 0x31,
|
---|
76 | ATA_WRITE_LONG = 0x32,
|
---|
77 | ATA_WRITE_LONG_WITHOUT_RETRIES = 0x33,
|
---|
78 | ATA_WRITE_SECTORS_EXT = 0x34,
|
---|
79 | ATA_WRITE_DMA_EXT = 0x35,
|
---|
80 | ATA_WRITE_DMA_QUEUED_EXT = 0x36,
|
---|
81 | ATA_SET_MAX_ADDRESS_EXT = 0x37,
|
---|
82 | ATA_CFA_WRITE_SECTORS_WITHOUT_ERASE = 0x38,
|
---|
83 | ATA_WRITE_MULTIPLE_EXT = 0x39,
|
---|
84 | ATA_WRITE_STREAM_DMA_EXT = 0x3a,
|
---|
85 | ATA_WRITE_STREAM_EXT = 0x3b,
|
---|
86 | ATA_WRITE_VERIFY = 0x3c,
|
---|
87 | ATA_WRITE_DMA_FUA_EXT = 0x3d,
|
---|
88 | ATA_WRITE_DMA_QUEUED_FUA_EXT = 0x3e,
|
---|
89 | ATA_WRITE_LOG_EXT = 0x3f,
|
---|
90 | ATA_READ_VERIFY_SECTORS = 0x40,
|
---|
91 | ATA_READ_VERIFY_SECTORS_WITHOUT_RETRIES = 0x41,
|
---|
92 | ATA_READ_VERIFY_SECTORS_EXT = 0x42,
|
---|
93 | ATA_WRITE_UNCORRECTABLE_EXT = 0x45,
|
---|
94 | ATA_READ_LOG_DMA_EXT = 0x47,
|
---|
95 | ATA_FORMAT_TRACK = 0x50,
|
---|
96 | ATA_CONFIGURE_STREAM = 0x51,
|
---|
97 | ATA_WRITE_LOG_DMA_EXT = 0x57,
|
---|
98 | ATA_TRUSTED_RECEIVE = 0x5c,
|
---|
99 | ATA_TRUSTED_RECEIVE_DMA = 0x5d,
|
---|
100 | ATA_TRUSTED_SEND = 0x5e,
|
---|
101 | ATA_TRUSTED_SEND_DMA = 0x5f,
|
---|
102 | ATA_READ_FPDMA_QUEUED = 0x60,
|
---|
103 | ATA_WRITE_FPDMA_QUEUED = 0x61,
|
---|
104 | ATA_SEEK = 0x70,
|
---|
105 | ATA_CFA_TRANSLATE_SECTOR = 0x87,
|
---|
106 | ATA_EXECUTE_DEVICE_DIAGNOSTIC = 0x90,
|
---|
107 | ATA_INITIALIZE_DEVICE_PARAMETERS = 0x91,
|
---|
108 | ATA_DOWNLOAD_MICROCODE = 0x92,
|
---|
109 | ATA_STANDBY_IMMEDIATE__ALT = 0x94,
|
---|
110 | ATA_IDLE_IMMEDIATE__ALT = 0x95,
|
---|
111 | ATA_STANDBY__ALT = 0x96,
|
---|
112 | ATA_IDLE__ALT = 0x97,
|
---|
113 | ATA_CHECK_POWER_MODE__ALT = 0x98,
|
---|
114 | ATA_SLEEP__ALT = 0x99,
|
---|
115 | ATA_PACKET = 0xa0,
|
---|
116 | ATA_IDENTIFY_PACKET_DEVICE = 0xa1,
|
---|
117 | ATA_SERVICE = 0xa2,
|
---|
118 | ATA_SMART = 0xb0,
|
---|
119 | ATA_DEVICE_CONFIGURATION_OVERLAY = 0xb1,
|
---|
120 | ATA_NV_CACHE = 0xb6,
|
---|
121 | ATA_CFA_ERASE_SECTORS = 0xc0,
|
---|
122 | ATA_READ_MULTIPLE = 0xc4,
|
---|
123 | ATA_WRITE_MULTIPLE = 0xc5,
|
---|
124 | ATA_SET_MULTIPLE_MODE = 0xc6,
|
---|
125 | ATA_READ_DMA_QUEUED = 0xc7,
|
---|
126 | ATA_READ_DMA = 0xc8,
|
---|
127 | ATA_READ_DMA_WITHOUT_RETRIES = 0xc9,
|
---|
128 | ATA_WRITE_DMA = 0xca,
|
---|
129 | ATA_WRITE_DMA_WITHOUT_RETRIES = 0xcb,
|
---|
130 | ATA_WRITE_DMA_QUEUED = 0xcc,
|
---|
131 | ATA_CFA_WRITE_MULTIPLE_WITHOUT_ERASE = 0xcd,
|
---|
132 | ATA_WRITE_MULTIPLE_FUA_EXT = 0xce,
|
---|
133 | ATA_CHECK_MEDIA_CARD_TYPE = 0xd1,
|
---|
134 | ATA_GET_MEDIA_STATUS = 0xda,
|
---|
135 | ATA_ACKNOWLEDGE_MEDIA_CHANGE = 0xdb,
|
---|
136 | ATA_BOOT_POST_BOOT = 0xdc,
|
---|
137 | ATA_BOOT_PRE_BOOT = 0xdd,
|
---|
138 | ATA_MEDIA_LOCK = 0xde,
|
---|
139 | ATA_MEDIA_UNLOCK = 0xdf,
|
---|
140 | ATA_STANDBY_IMMEDIATE = 0xe0,
|
---|
141 | ATA_IDLE_IMMEDIATE = 0xe1,
|
---|
142 | ATA_STANDBY = 0xe2,
|
---|
143 | ATA_IDLE = 0xe3,
|
---|
144 | ATA_READ_BUFFER = 0xe4,
|
---|
145 | ATA_CHECK_POWER_MODE = 0xe5,
|
---|
146 | ATA_SLEEP = 0xe6,
|
---|
147 | ATA_FLUSH_CACHE = 0xe7,
|
---|
148 | ATA_WRITE_BUFFER = 0xe8,
|
---|
149 | ATA_WRITE_SAME = 0xe9,
|
---|
150 | ATA_FLUSH_CACHE_EXT = 0xea,
|
---|
151 | ATA_IDENTIFY_DEVICE = 0xec,
|
---|
152 | ATA_MEDIA_EJECT = 0xed,
|
---|
153 | ATA_IDENTIFY_DMA = 0xee,
|
---|
154 | ATA_SET_FEATURES = 0xef,
|
---|
155 | ATA_SECURITY_SET_PASSWORD = 0xf1,
|
---|
156 | ATA_SECURITY_UNLOCK = 0xf2,
|
---|
157 | ATA_SECURITY_ERASE_PREPARE = 0xf3,
|
---|
158 | ATA_SECURITY_ERASE_UNIT = 0xf4,
|
---|
159 | ATA_SECURITY_FREEZE_LOCK = 0xf5,
|
---|
160 | ATA_SECURITY_DISABLE_PASSWORD = 0xf6,
|
---|
161 | ATA_READ_NATIVE_MAX_ADDRESS = 0xf8,
|
---|
162 | ATA_SET_MAX = 0xf9
|
---|
163 | } ATACMD;
|
---|
164 |
|
---|
165 |
|
---|
166 | #define ATA_MODE_MDMA 0x20
|
---|
167 | #define ATA_MODE_UDMA 0x40
|
---|
168 |
|
---|
169 |
|
---|
170 | #define ATA_TRANSFER_ID(thismode, maxspeed, currmode) \
|
---|
171 | ( ((1 << (maxspeed + 1)) - 1) \
|
---|
172 | | ((((thismode ^ currmode) & 0xf8) == 0) ? 1 << ((currmode & 0x07) + 8) : 0))
|
---|
173 |
|
---|
174 |
|
---|
175 | /* ATAPI defines */
|
---|
176 |
|
---|
177 | #define ATAPI_PACKET_SIZE 12
|
---|
178 |
|
---|
179 |
|
---|
180 | #define ATAPI_INT_REASON_CD 0x01 /* 0 = data transfer */
|
---|
181 | #define ATAPI_INT_REASON_IO 0x02 /* 1 = transfer to the host */
|
---|
182 | #define ATAPI_INT_REASON_REL 0x04
|
---|
183 | #define ATAPI_INT_REASON_TAG_MASK 0xf8
|
---|
184 |
|
---|
185 | #if defined(DEBUG) && defined(IN_RING3)
|
---|
186 | const char * ATACmdText(uint8_t uCmd);
|
---|
187 | #endif
|
---|
188 |
|
---|
189 | #endif /* !___Storage_IDE_h */
|
---|
190 |
|
---|