VirtualBox

source: vbox/trunk/src/VBox/Devices/Storage/ide.h@ 12474

Last change on this file since 12474 was 11144, checked in by vboxsync, 16 years ago

#1865: ATA and AHCI.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 21.6 KB
Line 
1/* $Id: ide.h 11144 2008-08-05 21:05:57Z 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. */
56typedef 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#ifdef DEBUG
166static const char * const g_apszATACmdNames[256] =
167{
168 "NOP", /* 0x00 */
169 "", /* 0x01 */
170 "", /* 0x02 */
171 "CFA REQUEST EXTENDED ERROR CODE", /* 0x03 */
172 "", /* 0x04 */
173 "", /* 0x05 */
174 "", /* 0x06 */
175 "", /* 0x07 */
176 "DEVICE RESET", /* 0x08 */
177 "", /* 0x09 */
178 "", /* 0x0a */
179 "", /* 0x0b */
180 "", /* 0x0c */
181 "", /* 0x0d */
182 "", /* 0x0e */
183 "", /* 0x0f */
184 "RECALIBRATE", /* 0x10 */
185 "", /* 0x11 */
186 "", /* 0x12 */
187 "", /* 0x13 */
188 "", /* 0x14 */
189 "", /* 0x15 */
190 "", /* 0x16 */
191 "", /* 0x17 */
192 "", /* 0x18 */
193 "", /* 0x19 */
194 "", /* 0x1a */
195 "", /* 0x1b */
196 "", /* 0x1c */
197 "", /* 0x1d */
198 "", /* 0x1e */
199 "", /* 0x1f */
200 "READ SECTORS", /* 0x20 */
201 "READ SECTORS WITHOUT RETRIES", /* 0x21 */
202 "READ LONG", /* 0x22 */
203 "READ LONG WITHOUT RETRIES", /* 0x23 */
204 "READ SECTORS EXT", /* 0x24 */
205 "READ DMA EXT", /* 0x25 */
206 "READ DMA QUEUED EXT", /* 0x26 */
207 "READ NATIVE MAX ADDRESS EXT", /* 0x27 */
208 "", /* 0x28 */
209 "READ MULTIPLE EXT", /* 0x29 */
210 "READ STREAM DMA EXT", /* 0x2a */
211 "READ STREAM EXT", /* 0x2b */
212 "", /* 0x2c */
213 "", /* 0x2d */
214 "", /* 0x2e */
215 "READ LOG EXT", /* 0x2f */
216 "WRITE SECTORS", /* 0x30 */
217 "WRITE SECTORS WITHOUT RETRIES", /* 0x31 */
218 "WRITE LONG", /* 0x32 */
219 "WRITE LONG WITHOUT RETRIES", /* 0x33 */
220 "WRITE SECTORS EXT", /* 0x34 */
221 "WRITE DMA EXT", /* 0x35 */
222 "WRITE DMA QUEUED EXT", /* 0x36 */
223 "SET MAX ADDRESS EXT", /* 0x37 */
224 "CFA WRITE SECTORS WITHOUT ERASE", /* 0x38 */
225 "WRITE MULTIPLE EXT", /* 0x39 */
226 "WRITE STREAM DMA EXT", /* 0x3a */
227 "WRITE STREAM EXT", /* 0x3b */
228 "WRITE VERIFY", /* 0x3c */
229 "WRITE DMA FUA EXT", /* 0x3d */
230 "WRITE DMA QUEUED FUA EXT", /* 0x3e */
231 "WRITE LOG EXT", /* 0x3f */
232 "READ VERIFY SECTORS", /* 0x40 */
233 "READ VERIFY SECTORS WITHOUT RETRIES", /* 0x41 */
234 "READ VERIFY SECTORS EXT", /* 0x42 */
235 "", /* 0x43 */
236 "", /* 0x44 */
237 "WRITE UNCORRECTABLE EXT", /* 0x45 */
238 "", /* 0x46 */
239 "READ LOG DMA EXT", /* 0x47 */
240 "", /* 0x48 */
241 "", /* 0x49 */
242 "", /* 0x4a */
243 "", /* 0x4b */
244 "", /* 0x4c */
245 "", /* 0x4d */
246 "", /* 0x4e */
247 "", /* 0x4f */
248 "FORMAT TRACK", /* 0x50 */
249 "CONFIGURE STREAM", /* 0x51 */
250 "", /* 0x52 */
251 "", /* 0x53 */
252 "", /* 0x54 */
253 "", /* 0x55 */
254 "", /* 0x56 */
255 "WRITE LOG DMA EXT", /* 0x57 */
256 "", /* 0x58 */
257 "", /* 0x59 */
258 "", /* 0x5a */
259 "", /* 0x5b */
260 "TRUSTED RECEIVE", /* 0x5c */
261 "TRUSTED RECEIVE DMA", /* 0x5d */
262 "TRUSTED SEND", /* 0x5e */
263 "TRUSTED SEND DMA", /* 0x5f */
264 "READ FPDMA QUEUED", /* 0x60 */
265 "WRITE FPDMA QUEUED", /* 0x61 */
266 "", /* 0x62 */
267 "", /* 0x63 */
268 "", /* 0x64 */
269 "", /* 0x65 */
270 "", /* 0x66 */
271 "", /* 0x67 */
272 "", /* 0x68 */
273 "", /* 0x69 */
274 "", /* 0x6a */
275 "", /* 0x6b */
276 "", /* 0x6c */
277 "", /* 0x6d */
278 "", /* 0x6e */
279 "", /* 0x6f */
280 "SEEK", /* 0x70 */
281 "", /* 0x71 */
282 "", /* 0x72 */
283 "", /* 0x73 */
284 "", /* 0x74 */
285 "", /* 0x75 */
286 "", /* 0x76 */
287 "", /* 0x77 */
288 "", /* 0x78 */
289 "", /* 0x79 */
290 "", /* 0x7a */
291 "", /* 0x7b */
292 "", /* 0x7c */
293 "", /* 0x7d */
294 "", /* 0x7e */
295 "", /* 0x7f */
296 "", /* 0x80 */
297 "", /* 0x81 */
298 "", /* 0x82 */
299 "", /* 0x83 */
300 "", /* 0x84 */
301 "", /* 0x85 */
302 "", /* 0x86 */
303 "CFA TRANSLATE SECTOR", /* 0x87 */
304 "", /* 0x88 */
305 "", /* 0x89 */
306 "", /* 0x8a */
307 "", /* 0x8b */
308 "", /* 0x8c */
309 "", /* 0x8d */
310 "", /* 0x8e */
311 "", /* 0x8f */
312 "EXECUTE DEVICE DIAGNOSTIC", /* 0x90 */
313 "INITIALIZE DEVICE PARAMETERS", /* 0x91 */
314 "DOWNLOAD MICROCODE", /* 0x92 */
315 "", /* 0x93 */
316 "STANDBY IMMEDIATE ALT", /* 0x94 */
317 "IDLE IMMEDIATE ALT", /* 0x95 */
318 "STANDBY ALT", /* 0x96 */
319 "IDLE ALT", /* 0x97 */
320 "CHECK POWER MODE ALT", /* 0x98 */
321 "SLEEP ALT", /* 0x99 */
322 "", /* 0x9a */
323 "", /* 0x9b */
324 "", /* 0x9c */
325 "", /* 0x9d */
326 "", /* 0x9e */
327 "", /* 0x9f */
328 "PACKET", /* 0xa0 */
329 "IDENTIFY PACKET DEVICE", /* 0xa1 */
330 "SERVICE", /* 0xa2 */
331 "", /* 0xa3 */
332 "", /* 0xa4 */
333 "", /* 0xa5 */
334 "", /* 0xa6 */
335 "", /* 0xa7 */
336 "", /* 0xa8 */
337 "", /* 0xa9 */
338 "", /* 0xaa */
339 "", /* 0xab */
340 "", /* 0xac */
341 "", /* 0xad */
342 "", /* 0xae */
343 "", /* 0xaf */
344 "SMART", /* 0xb0 */
345 "DEVICE CONFIGURATION OVERLAY", /* 0xb1 */
346 "", /* 0xb2 */
347 "", /* 0xb3 */
348 "", /* 0xb4 */
349 "", /* 0xb5 */
350 "NV CACHE", /* 0xb6 */
351 "", /* 0xb7 */
352 "", /* 0xb8 */
353 "", /* 0xb9 */
354 "", /* 0xba */
355 "", /* 0xbb */
356 "", /* 0xbc */
357 "", /* 0xbd */
358 "", /* 0xbe */
359 "", /* 0xbf */
360 "CFA ERASE SECTORS", /* 0xc0 */
361 "", /* 0xc1 */
362 "", /* 0xc2 */
363 "", /* 0xc3 */
364 "READ MULTIPLE", /* 0xc4 */
365 "WRITE MULTIPLE", /* 0xc5 */
366 "SET MULTIPLE MODE", /* 0xc6 */
367 "READ DMA QUEUED", /* 0xc7 */
368 "READ DMA", /* 0xc8 */
369 "READ DMA WITHOUT RETRIES", /* 0xc9 */
370 "WRITE DMA", /* 0xca */
371 "WRITE DMA WITHOUT RETRIES", /* 0xcb */
372 "WRITE DMA QUEUED", /* 0xcc */
373 "CFA WRITE MULTIPLE WITHOUT ERASE", /* 0xcd */
374 "WRITE MULTIPLE FUA EXT", /* 0xce */
375 "", /* 0xcf */
376 "", /* 0xd0 */
377 "CHECK MEDIA CARD TYPE", /* 0xd1 */
378 "", /* 0xd2 */
379 "", /* 0xd3 */
380 "", /* 0xd4 */
381 "", /* 0xd5 */
382 "", /* 0xd6 */
383 "", /* 0xd7 */
384 "", /* 0xd8 */
385 "", /* 0xd9 */
386 "GET MEDIA STATUS", /* 0xda */
387 "ACKNOWLEDGE MEDIA CHANGE", /* 0xdb */
388 "BOOT POST BOOT", /* 0xdc */
389 "BOOT PRE BOOT", /* 0xdd */
390 "MEDIA LOCK", /* 0xde */
391 "MEDIA UNLOCK", /* 0xdf */
392 "STANDBY IMMEDIATE", /* 0xe0 */
393 "IDLE IMMEDIATE", /* 0xe1 */
394 "STANDBY", /* 0xe2 */
395 "IDLE", /* 0xe3 */
396 "READ BUFFER", /* 0xe4 */
397 "CHECK POWER MODE", /* 0xe5 */
398 "SLEEP", /* 0xe6 */
399 "FLUSH CACHE", /* 0xe7 */
400 "WRITE BUFFER", /* 0xe8 */
401 "WRITE SAME", /* 0xe9 */
402 "FLUSH CACHE EXT", /* 0xea */
403 "", /* 0xeb */
404 "IDENTIFY DEVICE", /* 0xec */
405 "MEDIA EJECT", /* 0xed */
406 "IDENTIFY DMA", /* 0xee */
407 "SET FEATURES", /* 0xef */
408 "", /* 0xf0 */
409 "SECURITY SET PASSWORD", /* 0xf1 */
410 "SECURITY UNLOCK", /* 0xf2 */
411 "SECURITY ERASE PREPARE", /* 0xf3 */
412 "SECURITY ERASE UNIT", /* 0xf4 */
413 "SECURITY FREEZE LOCK", /* 0xf5 */
414 "SECURITY DISABLE PASSWORD", /* 0xf6 */
415 "", /* 0xf7 */
416 "READ NATIVE MAX ADDRESS", /* 0xf8 */
417 "SET MAX", /* 0xf9 */
418 "", /* 0xfa */
419 "", /* 0xfb */
420 "", /* 0xfc */
421 "", /* 0xfd */
422 "", /* 0xfe */
423 "" /* 0xff */
424};
425#endif /* DEBUG */
426
427
428#define ATA_MODE_MDMA 0x20
429#define ATA_MODE_UDMA 0x40
430
431
432#define ATA_TRANSFER_ID(thismode, maxspeed, currmode) \
433 ( ((1 << (maxspeed + 1)) - 1) \
434 | ((((thismode ^ currmode) & 0xf8) == 0) ? 1 << ((currmode & 0x07) + 8) : 0))
435
436
437/* ATAPI defines */
438
439#define ATAPI_PACKET_SIZE 12
440
441
442#define ATAPI_INT_REASON_CD 0x01 /* 0 = data transfer */
443#define ATAPI_INT_REASON_IO 0x02 /* 1 = transfer to the host */
444#define ATAPI_INT_REASON_REL 0x04
445#define ATAPI_INT_REASON_TAG_MASK 0xf8
446
447
448#endif /* !___Storage_IDE_h */
449
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette