VirtualBox

source: vbox/trunk/include/VBox/ata.h@ 67107

Last change on this file since 67107 was 65075, checked in by vboxsync, 8 years ago

Devices/Storage: Move ide.h to include/VBox/ata.h to be consistent with how the headers are layed out for the SCSI bits. Renamed to ata.h to reflect that it belongs to the ATA standard
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 8.5 KB
Line 
1/* $Id: ata.h 65075 2017-01-03 11:52:07Z vboxsync $ */
2/** @file
3 * VBox storage devices: ATA/ATAPI declarations
4 */
5
6/*
7 * Copyright (C) 2006-2016 Oracle Corporation
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
18#ifndef ___VBox_ata_h
19#define ___VBox_ata_h
20
21
22/* Bits of HD_STATUS */
23#define ATA_STAT_ERR 0x01
24#define ATA_STAT_INDEX 0x02
25#define ATA_STAT_ECC 0x04 /* Corrected error */
26#define ATA_STAT_DRQ 0x08
27#define ATA_STAT_SEEK 0x10
28#define ATA_STAT_SRV 0x10
29#define ATA_STAT_WRERR 0x20
30#define ATA_STAT_READY 0x40
31#define ATA_STAT_BUSY 0x80
32
33/* Bits for HD_ERROR */
34#define MARK_ERR 0x01 /* Bad address mark */
35#define TRK0_ERR 0x02 /* couldn't find track 0 */
36#define ABRT_ERR 0x04 /* Command aborted */
37#define MCR_ERR 0x08 /* media change request */
38#define ID_ERR 0x10 /* ID field not found */
39#define MC_ERR 0x20 /* media changed */
40#define ECC_ERR 0x40 /* Uncorrectable ECC error */
41#define BBD_ERR 0x80 /* pre-EIDE meaning: block marked bad */
42#define ICRC_ERR 0x80 /* new meaning: CRC error during transfer */
43
44/* Bits for uATARegDevCtl. */
45#define ATA_DEVCTL_DISABLE_IRQ 0x02
46#define ATA_DEVCTL_RESET 0x04
47#define ATA_DEVCTL_HOB 0x80
48
49
50/* ATA/ATAPI Commands (as of ATA/ATAPI-8 draft T13/1699D Revision 3a).
51 * Please keep this in sync with g_apszATACmdNames. */
52typedef enum ATACMD
53{
54 ATA_NOP = 0x00,
55 ATA_CFA_REQUEST_EXTENDED_ERROR_CODE = 0x03,
56 ATA_DATA_SET_MANAGEMENT = 0x06,
57 ATA_DEVICE_RESET = 0x08,
58 ATA_RECALIBRATE = 0x10,
59 ATA_READ_SECTORS = 0x20,
60 ATA_READ_SECTORS_WITHOUT_RETRIES = 0x21,
61 ATA_READ_LONG = 0x22,
62 ATA_READ_LONG_WITHOUT_RETRIES = 0x23,
63 ATA_READ_SECTORS_EXT = 0x24,
64 ATA_READ_DMA_EXT = 0x25,
65 ATA_READ_DMA_QUEUED_EXT = 0x26,
66 ATA_READ_NATIVE_MAX_ADDRESS_EXT = 0x27,
67 ATA_READ_MULTIPLE_EXT = 0x29,
68 ATA_READ_STREAM_DMA_EXT = 0x2a,
69 ATA_READ_STREAM_EXT = 0x2b,
70 ATA_READ_LOG_EXT = 0x2f,
71 ATA_WRITE_SECTORS = 0x30,
72 ATA_WRITE_SECTORS_WITHOUT_RETRIES = 0x31,
73 ATA_WRITE_LONG = 0x32,
74 ATA_WRITE_LONG_WITHOUT_RETRIES = 0x33,
75 ATA_WRITE_SECTORS_EXT = 0x34,
76 ATA_WRITE_DMA_EXT = 0x35,
77 ATA_WRITE_DMA_QUEUED_EXT = 0x36,
78 ATA_SET_MAX_ADDRESS_EXT = 0x37,
79 ATA_CFA_WRITE_SECTORS_WITHOUT_ERASE = 0x38,
80 ATA_WRITE_MULTIPLE_EXT = 0x39,
81 ATA_WRITE_STREAM_DMA_EXT = 0x3a,
82 ATA_WRITE_STREAM_EXT = 0x3b,
83 ATA_WRITE_VERIFY = 0x3c,
84 ATA_WRITE_DMA_FUA_EXT = 0x3d,
85 ATA_WRITE_DMA_QUEUED_FUA_EXT = 0x3e,
86 ATA_WRITE_LOG_EXT = 0x3f,
87 ATA_READ_VERIFY_SECTORS = 0x40,
88 ATA_READ_VERIFY_SECTORS_WITHOUT_RETRIES = 0x41,
89 ATA_READ_VERIFY_SECTORS_EXT = 0x42,
90 ATA_WRITE_UNCORRECTABLE_EXT = 0x45,
91 ATA_READ_LOG_DMA_EXT = 0x47,
92 ATA_FORMAT_TRACK = 0x50,
93 ATA_CONFIGURE_STREAM = 0x51,
94 ATA_WRITE_LOG_DMA_EXT = 0x57,
95 ATA_TRUSTED_RECEIVE = 0x5c,
96 ATA_TRUSTED_RECEIVE_DMA = 0x5d,
97 ATA_TRUSTED_SEND = 0x5e,
98 ATA_TRUSTED_SEND_DMA = 0x5f,
99 ATA_READ_FPDMA_QUEUED = 0x60,
100 ATA_WRITE_FPDMA_QUEUED = 0x61,
101 ATA_SEEK = 0x70,
102 ATA_CFA_TRANSLATE_SECTOR = 0x87,
103 ATA_EXECUTE_DEVICE_DIAGNOSTIC = 0x90,
104 ATA_INITIALIZE_DEVICE_PARAMETERS = 0x91,
105 ATA_DOWNLOAD_MICROCODE = 0x92,
106 ATA_STANDBY_IMMEDIATE__ALT = 0x94,
107 ATA_IDLE_IMMEDIATE__ALT = 0x95,
108 ATA_STANDBY__ALT = 0x96,
109 ATA_IDLE__ALT = 0x97,
110 ATA_CHECK_POWER_MODE__ALT = 0x98,
111 ATA_SLEEP__ALT = 0x99,
112 ATA_PACKET = 0xa0,
113 ATA_IDENTIFY_PACKET_DEVICE = 0xa1,
114 ATA_SERVICE = 0xa2,
115 ATA_SMART = 0xb0,
116 ATA_DEVICE_CONFIGURATION_OVERLAY = 0xb1,
117 ATA_NV_CACHE = 0xb6,
118 ATA_CFA_ERASE_SECTORS = 0xc0,
119 ATA_READ_MULTIPLE = 0xc4,
120 ATA_WRITE_MULTIPLE = 0xc5,
121 ATA_SET_MULTIPLE_MODE = 0xc6,
122 ATA_READ_DMA_QUEUED = 0xc7,
123 ATA_READ_DMA = 0xc8,
124 ATA_READ_DMA_WITHOUT_RETRIES = 0xc9,
125 ATA_WRITE_DMA = 0xca,
126 ATA_WRITE_DMA_WITHOUT_RETRIES = 0xcb,
127 ATA_WRITE_DMA_QUEUED = 0xcc,
128 ATA_CFA_WRITE_MULTIPLE_WITHOUT_ERASE = 0xcd,
129 ATA_WRITE_MULTIPLE_FUA_EXT = 0xce,
130 ATA_CHECK_MEDIA_CARD_TYPE = 0xd1,
131 ATA_GET_MEDIA_STATUS = 0xda,
132 ATA_ACKNOWLEDGE_MEDIA_CHANGE = 0xdb,
133 ATA_BOOT_POST_BOOT = 0xdc,
134 ATA_BOOT_PRE_BOOT = 0xdd,
135 ATA_MEDIA_LOCK = 0xde,
136 ATA_MEDIA_UNLOCK = 0xdf,
137 ATA_STANDBY_IMMEDIATE = 0xe0,
138 ATA_IDLE_IMMEDIATE = 0xe1,
139 ATA_STANDBY = 0xe2,
140 ATA_IDLE = 0xe3,
141 ATA_READ_BUFFER = 0xe4,
142 ATA_CHECK_POWER_MODE = 0xe5,
143 ATA_SLEEP = 0xe6,
144 ATA_FLUSH_CACHE = 0xe7,
145 ATA_WRITE_BUFFER = 0xe8,
146 ATA_WRITE_SAME = 0xe9,
147 ATA_FLUSH_CACHE_EXT = 0xea,
148 ATA_IDENTIFY_DEVICE = 0xec,
149 ATA_MEDIA_EJECT = 0xed,
150 ATA_IDENTIFY_DMA = 0xee,
151 ATA_SET_FEATURES = 0xef,
152 ATA_SECURITY_SET_PASSWORD = 0xf1,
153 ATA_SECURITY_UNLOCK = 0xf2,
154 ATA_SECURITY_ERASE_PREPARE = 0xf3,
155 ATA_SECURITY_ERASE_UNIT = 0xf4,
156 ATA_SECURITY_FREEZE_LOCK = 0xf5,
157 ATA_SECURITY_DISABLE_PASSWORD = 0xf6,
158 ATA_READ_NATIVE_MAX_ADDRESS = 0xf8,
159 ATA_SET_MAX = 0xf9
160} ATACMD;
161
162
163#define ATA_MODE_MDMA 0x20
164#define ATA_MODE_UDMA 0x40
165
166
167#define ATA_TRANSFER_ID(thismode, maxspeed, currmode) \
168 ( ((1 << (maxspeed + 1)) - 1) \
169 | ((((thismode ^ currmode) & 0xf8) == 0) ? 1 << ((currmode & 0x07) + 8) : 0))
170
171/**
172 * Length of the ATA VPD data (without termination)
173 */
174#define ATA_SERIAL_NUMBER_LENGTH 20
175#define ATA_FIRMWARE_REVISION_LENGTH 8
176#define ATA_MODEL_NUMBER_LENGTH 40
177
178/** Mask to get the LBA value from a LBA range. */
179#define ATA_RANGE_LBA_MASK UINT64_C(0xffffffffffff)
180/** Mas to get the length value from a LBA range. */
181#define ATA_RANGE_LENGTH_MASK UINT64_C(0xffff000000000000)
182/** Returns the length of the range in sectors. */
183#define ATA_RANGE_LENGTH_GET(val) (((val) & ATA_RANGE_LENGTH_MASK) >> 48)
184
185/* ATAPI defines */
186
187#define ATAPI_PACKET_SIZE 12
188
189
190#define ATAPI_INT_REASON_CD 0x01 /* 0 = data transfer */
191#define ATAPI_INT_REASON_IO 0x02 /* 1 = transfer to the host */
192#define ATAPI_INT_REASON_REL 0x04
193#define ATAPI_INT_REASON_TAG_MASK 0xf8
194
195#if defined(LOG_ENABLED) && defined(IN_RING3)
196const char * ATACmdText(uint8_t uCmd);
197#endif
198
199#endif /* !___VBox_ata_h */
200
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