2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2000 - 2008 Søren Schmidt <sos@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer,
12 * without modification, immediately at the beginning of the file.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #include <sys/ioccom.h>
36 /* ATA/ATAPI device parameters */
38 /*000*/ u_int16_t config; /* configuration info */
39 #define ATA_PROTO_MASK 0x8003
40 #define ATA_PROTO_ATAPI 0x8000
41 #define ATA_PROTO_ATAPI_12 0x8000
42 #define ATA_PROTO_ATAPI_16 0x8001
43 #define ATA_PROTO_CFA 0x848a
44 #define ATA_ATAPI_TYPE_MASK 0x1f00
45 #define ATA_ATAPI_TYPE_DIRECT 0x0000 /* disk/floppy */
46 #define ATA_ATAPI_TYPE_TAPE 0x0100 /* streaming tape */
47 #define ATA_ATAPI_TYPE_CDROM 0x0500 /* CD-ROM device */
48 #define ATA_ATAPI_TYPE_OPTICAL 0x0700 /* optical disk */
49 #define ATA_DRQ_MASK 0x0060
50 #define ATA_DRQ_SLOW 0x0000 /* cpu 3 ms delay */
51 #define ATA_DRQ_INTR 0x0020 /* interrupt 10 ms delay */
52 #define ATA_DRQ_FAST 0x0040 /* accel 50 us delay */
53 #define ATA_RESP_INCOMPLETE 0x0004
55 /*001*/ u_int16_t cylinders; /* # of cylinders */
56 /*002*/ u_int16_t specconf; /* specific configuration */
57 /*003*/ u_int16_t heads; /* # heads */
60 /*006*/ u_int16_t sectors; /* # sectors/track */
61 /*007*/ u_int16_t vendor7[3];
62 /*010*/ u_int8_t serial[20]; /* serial number */
63 /*020*/ u_int16_t retired20;
66 /*023*/ u_int8_t revision[8]; /* firmware revision */
67 /*027*/ u_int8_t model[40]; /* model name */
68 /*047*/ u_int16_t sectors_intr; /* sectors per interrupt */
69 /*048*/ u_int16_t tcg; /* Trusted Computing Group */
70 #define ATA_SUPPORT_TCG 0x0001
71 /*049*/ u_int16_t capabilities1;
72 #define ATA_SUPPORT_DMA 0x0100
73 #define ATA_SUPPORT_LBA 0x0200
74 #define ATA_SUPPORT_IORDYDIS 0x0400
75 #define ATA_SUPPORT_IORDY 0x0800
76 #define ATA_SUPPORT_OVERLAP 0x4000
78 /*050*/ u_int16_t capabilities2;
79 /*051*/ u_int16_t retired_piomode; /* PIO modes 0-2 */
80 #define ATA_RETIRED_PIO_MASK 0x0300
82 /*052*/ u_int16_t retired_dmamode; /* DMA modes */
83 #define ATA_RETIRED_DMA_MASK 0x0003
85 /*053*/ u_int16_t atavalid; /* fields valid */
86 #define ATA_FLAG_54_58 0x0001 /* words 54-58 valid */
87 #define ATA_FLAG_64_70 0x0002 /* words 64-70 valid */
88 #define ATA_FLAG_88 0x0004 /* word 88 valid */
90 /*054*/ u_int16_t current_cylinders;
91 /*055*/ u_int16_t current_heads;
92 /*056*/ u_int16_t current_sectors;
93 /*057*/ u_int16_t current_size_1;
94 /*058*/ u_int16_t current_size_2;
95 /*059*/ u_int16_t multi;
96 #define ATA_SUPPORT_BLOCK_ERASE_EXT 0x8000
97 #define ATA_SUPPORT_OVERWRITE_EXT 0x4000
98 #define ATA_SUPPORT_CRYPTO_SCRAMBLE_EXT 0x2000
99 #define ATA_SUPPORT_SANITIZE 0x1000
100 #define ATA_MULTI_VALID 0x0100
102 /*060*/ u_int16_t lba_size_1;
103 u_int16_t lba_size_2;
104 u_int16_t obsolete62;
105 /*063*/ u_int16_t mwdmamodes; /* multiword DMA modes */
106 /*064*/ u_int16_t apiomodes; /* advanced PIO modes */
108 /*065*/ u_int16_t mwdmamin; /* min. M/W DMA time/word ns */
109 /*066*/ u_int16_t mwdmarec; /* rec. M/W DMA time ns */
110 /*067*/ u_int16_t pioblind; /* min. PIO cycle w/o flow */
111 /*068*/ u_int16_t pioiordy; /* min. PIO cycle IORDY flow */
112 /*069*/ u_int16_t support3;
113 #define ATA_SUPPORT_RZAT 0x0020
114 #define ATA_SUPPORT_DRAT 0x4000
115 #define ATA_ENCRYPTS_ALL_USER_DATA 0x0010 /* Self-encrypting drive */
116 #define ATA_SUPPORT_ZONE_MASK 0x0003
117 #define ATA_SUPPORT_ZONE_NR 0x0000
118 #define ATA_SUPPORT_ZONE_HOST_AWARE 0x0001
119 #define ATA_SUPPORT_ZONE_DEV_MANAGED 0x0002
120 u_int16_t reserved70;
121 /*071*/ u_int16_t rlsovlap; /* rel time (us) for overlap */
122 /*072*/ u_int16_t rlsservice; /* rel time (us) for service */
123 u_int16_t reserved73;
124 u_int16_t reserved74;
125 /*075*/ u_int16_t queue;
126 #define ATA_QUEUE_LEN(x) ((x) & 0x001f)
128 /*76*/ u_int16_t satacapabilities;
129 #define ATA_SATA_GEN1 0x0002
130 #define ATA_SATA_GEN2 0x0004
131 #define ATA_SATA_GEN3 0x0008
132 #define ATA_SUPPORT_NCQ 0x0100
133 #define ATA_SUPPORT_IFPWRMNGTRCV 0x0200
134 #define ATA_SUPPORT_PHYEVENTCNT 0x0400
135 #define ATA_SUPPORT_NCQ_UNLOAD 0x0800
136 #define ATA_SUPPORT_NCQ_PRIO 0x1000
137 #define ATA_SUPPORT_HAPST 0x2000
138 #define ATA_SUPPORT_DAPST 0x4000
139 #define ATA_SUPPORT_READLOGDMAEXT 0x8000
141 /*77*/ u_int16_t satacapabilities2;
142 #define ATA_SATA_CURR_GEN_MASK 0x0006
143 #define ATA_SUPPORT_NCQ_STREAM 0x0010
144 #define ATA_SUPPORT_NCQ_QMANAGEMENT 0x0020
145 #define ATA_SUPPORT_RCVSND_FPDMA_QUEUED 0x0040
146 /*78*/ u_int16_t satasupport;
147 #define ATA_SUPPORT_NONZERO 0x0002
148 #define ATA_SUPPORT_AUTOACTIVATE 0x0004
149 #define ATA_SUPPORT_IFPWRMNGT 0x0008
150 #define ATA_SUPPORT_INORDERDATA 0x0010
151 #define ATA_SUPPORT_ASYNCNOTIF 0x0020
152 #define ATA_SUPPORT_SOFTSETPRESERVE 0x0040
153 /*79*/ u_int16_t sataenabled;
154 #define ATA_ENABLED_DAPST 0x0080
156 /*080*/ u_int16_t version_major;
157 /*081*/ u_int16_t version_minor;
160 /*082/085*/ u_int16_t command1;
161 #define ATA_SUPPORT_SMART 0x0001
162 #define ATA_SUPPORT_SECURITY 0x0002
163 #define ATA_SUPPORT_REMOVABLE 0x0004
164 #define ATA_SUPPORT_POWERMGT 0x0008
165 #define ATA_SUPPORT_PACKET 0x0010
166 #define ATA_SUPPORT_WRITECACHE 0x0020
167 #define ATA_SUPPORT_LOOKAHEAD 0x0040
168 #define ATA_SUPPORT_RELEASEIRQ 0x0080
169 #define ATA_SUPPORT_SERVICEIRQ 0x0100
170 #define ATA_SUPPORT_RESET 0x0200
171 #define ATA_SUPPORT_PROTECTED 0x0400
172 #define ATA_SUPPORT_WRITEBUFFER 0x1000
173 #define ATA_SUPPORT_READBUFFER 0x2000
174 #define ATA_SUPPORT_NOP 0x4000
176 /*083/086*/ u_int16_t command2;
177 #define ATA_SUPPORT_MICROCODE 0x0001
178 #define ATA_SUPPORT_QUEUED 0x0002
179 #define ATA_SUPPORT_CFA 0x0004
180 #define ATA_SUPPORT_APM 0x0008
181 #define ATA_SUPPORT_NOTIFY 0x0010
182 #define ATA_SUPPORT_STANDBY 0x0020
183 #define ATA_SUPPORT_SPINUP 0x0040
184 #define ATA_SUPPORT_MAXSECURITY 0x0100
185 #define ATA_SUPPORT_AUTOACOUSTIC 0x0200
186 #define ATA_SUPPORT_ADDRESS48 0x0400
187 #define ATA_SUPPORT_OVERLAY 0x0800
188 #define ATA_SUPPORT_FLUSHCACHE 0x1000
189 #define ATA_SUPPORT_FLUSHCACHE48 0x2000
191 /*084/087*/ u_int16_t extension;
192 #define ATA_SUPPORT_SMARTLOG 0x0001
193 #define ATA_SUPPORT_SMARTTEST 0x0002
194 #define ATA_SUPPORT_MEDIASN 0x0004
195 #define ATA_SUPPORT_MEDIAPASS 0x0008
196 #define ATA_SUPPORT_STREAMING 0x0010
197 #define ATA_SUPPORT_GENLOG 0x0020
198 #define ATA_SUPPORT_WRITEDMAFUAEXT 0x0040
199 #define ATA_SUPPORT_WRITEDMAQFUAEXT 0x0080
200 #define ATA_SUPPORT_64BITWWN 0x0100
201 #define ATA_SUPPORT_UNLOAD 0x2000
202 } __packed support, enabled;
204 /*088*/ u_int16_t udmamodes; /* UltraDMA modes */
205 /*089*/ u_int16_t erase_time; /* time req'd in 2min units */
206 /*090*/ u_int16_t enhanced_erase_time; /* time req'd in 2min units */
207 /*091*/ u_int16_t apm_value;
208 /*092*/ u_int16_t master_passwd_revision; /* password revision code */
209 /*093*/ u_int16_t hwres;
210 #define ATA_CABLE_ID 0x2000
212 /*094*/ u_int16_t acoustic;
213 #define ATA_ACOUSTIC_CURRENT(x) ((x) & 0x00ff)
214 #define ATA_ACOUSTIC_VENDOR(x) (((x) & 0xff00) >> 8)
216 /*095*/ u_int16_t stream_min_req_size;
217 /*096*/ u_int16_t stream_transfer_time;
218 /*097*/ u_int16_t stream_access_latency;
219 /*098*/ u_int32_t stream_granularity;
220 /*100*/ u_int16_t lba_size48_1;
221 u_int16_t lba_size48_2;
222 u_int16_t lba_size48_3;
223 u_int16_t lba_size48_4;
224 u_int16_t reserved104;
225 /*105*/ u_int16_t max_dsm_blocks;
226 /*106*/ u_int16_t pss;
227 #define ATA_PSS_LSPPS 0x000F
228 #define ATA_PSS_LSSABOVE512 0x1000
229 #define ATA_PSS_MULTLS 0x2000
230 #define ATA_PSS_VALID_MASK 0xC000
231 #define ATA_PSS_VALID_VALUE 0x4000
232 /*107*/ u_int16_t isd;
233 /*108*/ u_int16_t wwn[4];
234 u_int16_t reserved112[5];
235 /*117*/ u_int16_t lss_1;
236 /*118*/ u_int16_t lss_2;
237 /*119*/ u_int16_t support2;
238 #define ATA_SUPPORT_WRITEREADVERIFY 0x0002
239 #define ATA_SUPPORT_WRITEUNCORREXT 0x0004
240 #define ATA_SUPPORT_RWLOGDMAEXT 0x0008
241 #define ATA_SUPPORT_MICROCODE3 0x0010
242 #define ATA_SUPPORT_FREEFALL 0x0020
243 #define ATA_SUPPORT_SENSE_REPORT 0x0040
244 #define ATA_SUPPORT_EPC 0x0080
245 /*120*/ u_int16_t enabled2;
246 #define ATA_ENABLED_WRITEREADVERIFY 0x0002
247 #define ATA_ENABLED_WRITEUNCORREXT 0x0004
248 #define ATA_ENABLED_FREEFALL 0x0020
249 #define ATA_ENABLED_SENSE_REPORT 0x0040
250 #define ATA_ENABLED_EPC 0x0080
251 u_int16_t reserved121[6];
252 /*127*/ u_int16_t removable_status;
253 /*128*/ u_int16_t security_status;
254 #define ATA_SECURITY_LEVEL 0x0100 /* 0: high, 1: maximum */
255 #define ATA_SECURITY_ENH_SUPP 0x0020 /* enhanced erase supported */
256 #define ATA_SECURITY_COUNT_EXP 0x0010 /* count expired */
257 #define ATA_SECURITY_FROZEN 0x0008 /* security config is frozen */
258 #define ATA_SECURITY_LOCKED 0x0004 /* drive is locked */
259 #define ATA_SECURITY_ENABLED 0x0002 /* ATA Security is enabled */
260 #define ATA_SECURITY_SUPPORTED 0x0001 /* ATA Security is supported */
262 u_int16_t reserved129[31];
263 /*160*/ u_int16_t cfa_powermode1;
264 u_int16_t reserved161;
265 /*162*/ u_int16_t cfa_kms_support;
266 /*163*/ u_int16_t cfa_trueide_modes;
267 /*164*/ u_int16_t cfa_memory_modes;
268 u_int16_t reserved165[3];
269 /*168*/ u_int16_t form_factor;
270 #define ATA_FORM_FACTOR_MASK 0x000f
271 #define ATA_FORM_FACTOR_NOT_REPORTED 0x0000
272 #define ATA_FORM_FACTOR_5_25 0x0001
273 #define ATA_FORM_FACTOR_3_5 0x0002
274 #define ATA_FORM_FACTOR_2_5 0x0003
275 #define ATA_FORM_FACTOR_1_8 0x0004
276 #define ATA_FORM_FACTOR_SUB_1_8 0x0005
277 #define ATA_FORM_FACTOR_MSATA 0x0006
278 #define ATA_FORM_FACTOR_M_2 0x0007
279 #define ATA_FORM_FACTOR_MICRO_SSD 0x0008
280 #define ATA_FORM_FACTOR_C_FAST 0x0009
281 /*169*/ u_int16_t support_dsm;
282 #define ATA_SUPPORT_DSM_TRIM 0x0001
283 u_int16_t reserved170[6];
284 /*176*/ u_int8_t media_serial[60];
285 /*206*/ u_int16_t sct;
286 u_int16_t reserved207[2];
287 /*209*/ u_int16_t lsalign;
288 /*210*/ u_int16_t wrv_sectors_m3_1;
289 u_int16_t wrv_sectors_m3_2;
290 /*212*/ u_int16_t wrv_sectors_m2_1;
291 u_int16_t wrv_sectors_m2_2;
292 /*214*/ u_int16_t nv_cache_caps;
293 /*215*/ u_int16_t nv_cache_size_1;
294 u_int16_t nv_cache_size_2;
295 /*217*/ u_int16_t media_rotation_rate;
296 #define ATA_RATE_NOT_REPORTED 0x0000
297 #define ATA_RATE_NON_ROTATING 0x0001
298 u_int16_t reserved218;
299 /*219*/ u_int16_t nv_cache_opt;
300 /*220*/ u_int16_t wrv_mode;
301 u_int16_t reserved221;
302 /*222*/ u_int16_t transport_major;
303 /*223*/ u_int16_t transport_minor;
304 u_int16_t reserved224[31];
305 /*255*/ u_int16_t integrity;
308 /* ATA Dataset Management */
309 #define ATA_DSM_BLK_SIZE 512
310 #define ATA_DSM_BLK_RANGES 64
311 #define ATA_DSM_RANGE_SIZE 8
312 #define ATA_DSM_RANGE_MAX 65535
315 * ATA Device Register
317 * bit 7 Obsolete (was 1 in early ATA specs)
318 * bit 6 Sets LBA/CHS mode. 1=LBA, 0=CHS
319 * bit 5 Obsolete (was 1 in early ATA specs)
320 * bit 4 1 = Slave Drive, 0 = Master Drive
321 * bit 3-0 In LBA mode, 27-24 of address. In CHS mode, head number
324 #define ATA_DEV_MASTER 0x00
325 #define ATA_DEV_SLAVE 0x10
326 #define ATA_DEV_LBA 0x40
329 #define ATA_MAX_28BIT_LBA 268435455UL
331 /* ATA Status Register */
332 #define ATA_STATUS_ERROR 0x01
333 #define ATA_STATUS_SENSE_AVAIL 0x02
334 #define ATA_STATUS_ALIGN_ERR 0x04
335 #define ATA_STATUS_DATA_REQ 0x08
336 #define ATA_STATUS_DEF_WRITE_ERR 0x10
337 #define ATA_STATUS_DEVICE_FAULT 0x20
338 #define ATA_STATUS_DEVICE_READY 0x40
339 #define ATA_STATUS_BUSY 0x80
341 /* ATA Error Register */
342 #define ATA_ERROR_ABORT 0x04
343 #define ATA_ERROR_ID_NOT_FOUND 0x10
345 /* ATA HPA Features */
346 #define ATA_HPA_FEAT_MAX_ADDR 0x00
347 #define ATA_HPA_FEAT_SET_PWD 0x01
348 #define ATA_HPA_FEAT_LOCK 0x02
349 #define ATA_HPA_FEAT_UNLOCK 0x03
350 #define ATA_HPA_FEAT_FREEZE 0x04
352 /* ATA transfer modes */
353 #define ATA_MODE_MASK 0x0f
354 #define ATA_DMA_MASK 0xf0
356 #define ATA_PIO0 0x08
357 #define ATA_PIO1 0x09
358 #define ATA_PIO2 0x0a
359 #define ATA_PIO3 0x0b
360 #define ATA_PIO4 0x0c
361 #define ATA_PIO_MAX 0x0f
363 #define ATA_WDMA0 0x20
364 #define ATA_WDMA1 0x21
365 #define ATA_WDMA2 0x22
366 #define ATA_UDMA0 0x40
367 #define ATA_UDMA1 0x41
368 #define ATA_UDMA2 0x42
369 #define ATA_UDMA3 0x43
370 #define ATA_UDMA4 0x44
371 #define ATA_UDMA5 0x45
372 #define ATA_UDMA6 0x46
373 #define ATA_SA150 0x47
374 #define ATA_SA300 0x48
375 #define ATA_SA600 0x49
376 #define ATA_DMA_MAX 0x4f
380 #define ATA_NOP 0x00 /* NOP */
381 #define ATA_NF_FLUSHQUEUE 0x00 /* flush queued cmd's */
382 #define ATA_NF_AUTOPOLL 0x01 /* start autopoll function */
383 #define ATA_DATA_SET_MANAGEMENT 0x06
384 #define ATA_DSM_TRIM 0x01
385 #define ATA_DEVICE_RESET 0x08 /* reset device */
386 #define ATA_READ 0x20 /* read */
387 #define ATA_READ48 0x24 /* read 48bit LBA */
388 #define ATA_READ_DMA48 0x25 /* read DMA 48bit LBA */
389 #define ATA_READ_DMA_QUEUED48 0x26 /* read DMA QUEUED 48bit LBA */
390 #define ATA_READ_NATIVE_MAX_ADDRESS48 0x27 /* read native max addr 48bit */
391 #define ATA_READ_MUL48 0x29 /* read multi 48bit LBA */
392 #define ATA_READ_STREAM_DMA48 0x2a /* read DMA stream 48bit LBA */
393 #define ATA_READ_LOG_EXT 0x2f /* read log ext - PIO Data-In */
394 #define ATA_READ_STREAM48 0x2b /* read stream 48bit LBA */
395 #define ATA_WRITE 0x30 /* write */
396 #define ATA_WRITE48 0x34 /* write 48bit LBA */
397 #define ATA_WRITE_DMA48 0x35 /* write DMA 48bit LBA */
398 #define ATA_WRITE_DMA_QUEUED48 0x36 /* write DMA QUEUED 48bit LBA*/
399 #define ATA_SET_MAX_ADDRESS48 0x37 /* set max address 48bit */
400 #define ATA_WRITE_MUL48 0x39 /* write multi 48bit LBA */
401 #define ATA_WRITE_STREAM_DMA48 0x3a
402 #define ATA_WRITE_STREAM48 0x3b
403 #define ATA_WRITE_DMA_FUA48 0x3d
404 #define ATA_WRITE_DMA_QUEUED_FUA48 0x3e
405 #define ATA_WRITE_LOG_EXT 0x3f
406 #define ATA_READ_VERIFY 0x40
407 #define ATA_READ_VERIFY48 0x42
408 #define ATA_WRITE_UNCORRECTABLE48 0x45 /* write uncorrectable 48bit LBA */
409 #define ATA_WU_PSEUDO 0x55 /* pseudo-uncorrectable error */
410 #define ATA_WU_FLAGGED 0xaa /* flagged-uncorrectable error */
411 #define ATA_READ_LOG_DMA_EXT 0x47 /* read log DMA ext - PIO Data-In */
412 #define ATA_ZAC_MANAGEMENT_IN 0x4a /* ZAC management in */
413 #define ATA_ZM_REPORT_ZONES 0x00 /* report zones */
414 #define ATA_WRITE_LOG_DMA_EXT 0x57 /* WRITE LOG DMA EXT */
415 #define ATA_TRUSTED_NON_DATA 0x5b /* TRUSTED NON-DATA */
416 #define ATA_TRUSTED_RECEIVE 0x5c /* TRUSTED RECEIVE */
417 #define ATA_TRUSTED_RECEIVE_DMA 0x5d /* TRUSTED RECEIVE DMA */
418 #define ATA_TRUSTED_SEND 0x5e /* TRUSTED SEND */
419 #define ATA_TRUSTED_SEND_DMA 0x5f /* TRUSTED SEND DMA */
420 #define ATA_READ_FPDMA_QUEUED 0x60 /* read DMA NCQ */
421 #define ATA_WRITE_FPDMA_QUEUED 0x61 /* write DMA NCQ */
422 #define ATA_NCQ_NON_DATA 0x63 /* NCQ non-data command */
423 #define ATA_ABORT_NCQ_QUEUE 0x00 /* abort NCQ queue */
424 #define ATA_DEADLINE_HANDLING 0x01 /* deadline handling */
425 #define ATA_SET_FEATURES 0x05 /* set features */
426 #define ATA_ZERO_EXT 0x06 /* zero ext */
427 #define ATA_NCQ_ZAC_MGMT_OUT 0x07 /* NCQ ZAC mgmt out no data */
428 #define ATA_SEND_FPDMA_QUEUED 0x64 /* send DMA NCQ */
429 #define ATA_SFPDMA_DSM 0x00 /* Data set management */
430 #define ATA_SFPDMA_DSM_TRIM 0x01 /* Set trim bit in auxiliary */
431 #define ATA_SFPDMA_HYBRID_EVICT 0x01 /* Hybrid Evict */
432 #define ATA_SFPDMA_WLDMA 0x02 /* Write Log DMA EXT */
433 #define ATA_SFPDMA_ZAC_MGMT_OUT 0x03 /* NCQ ZAC mgmt out w/data */
434 #define ATA_RECV_FPDMA_QUEUED 0x65 /* receive DMA NCQ */
435 #define ATA_RFPDMA_RL_DMA_EXT 0x00 /* Read Log DMA EXT */
436 #define ATA_RFPDMA_ZAC_MGMT_IN 0x02 /* NCQ ZAC mgmt in w/data */
437 #define ATA_SEP_ATTN 0x67 /* SEP request */
438 #define ATA_SEEK 0x70 /* seek */
439 #define ATA_ZAC_MANAGEMENT_OUT 0x9f /* ZAC management out */
440 #define ATA_ZM_CLOSE_ZONE 0x01 /* close zone */
441 #define ATA_ZM_FINISH_ZONE 0x02 /* finish zone */
442 #define ATA_ZM_OPEN_ZONE 0x03 /* open zone */
443 #define ATA_ZM_RWP 0x04 /* reset write pointer */
444 #define ATA_DOWNLOAD_MICROCODE 0x92 /* DOWNLOAD MICROCODE */
445 #define ATA_DOWNLOAD_MICROCODE_DMA 0x93 /* DOWNLOAD MICROCODE DMA */
446 #define ATA_PACKET_CMD 0xa0 /* packet command */
447 #define ATA_ATAPI_IDENTIFY 0xa1 /* get ATAPI params*/
448 #define ATA_SERVICE 0xa2 /* service command */
449 #define ATA_SMART_CMD 0xb0 /* SMART command */
450 #define ATA_CFA_ERASE 0xc0 /* CFA erase */
451 #define ATA_READ_MUL 0xc4 /* read multi */
452 #define ATA_WRITE_MUL 0xc5 /* write multi */
453 #define ATA_SET_MULTI 0xc6 /* set multi size */
454 #define ATA_READ_DMA_QUEUED 0xc7 /* read DMA QUEUED */
455 #define ATA_READ_DMA 0xc8 /* read DMA */
456 #define ATA_WRITE_DMA 0xca /* write DMA */
457 #define ATA_WRITE_DMA_QUEUED 0xcc /* write DMA QUEUED */
458 #define ATA_WRITE_MUL_FUA48 0xce
459 #define ATA_STANDBY_IMMEDIATE 0xe0 /* standby immediate */
460 #define ATA_IDLE_IMMEDIATE 0xe1 /* idle immediate */
461 #define ATA_STANDBY_CMD 0xe2 /* standby */
462 #define ATA_IDLE_CMD 0xe3 /* idle */
463 #define ATA_READ_BUFFER 0xe4 /* read buffer */
464 #define ATA_READ_PM 0xe4 /* read portmultiplier */
465 #define ATA_CHECK_POWER_MODE 0xe5 /* device power mode */
466 #define ATA_SLEEP 0xe6 /* sleep */
467 #define ATA_FLUSHCACHE 0xe7 /* flush cache to disk */
468 #define ATA_WRITE_BUFFER 0xe8 /* write buffer */
469 #define ATA_WRITE_PM 0xe8 /* write portmultiplier */
470 #define ATA_READ_BUFFER_DMA 0xe9 /* read buffer DMA */
471 #define ATA_FLUSHCACHE48 0xea /* flush cache to disk */
472 #define ATA_WRITE_BUFFER_DMA 0xeb /* write buffer DMA */
473 #define ATA_ATA_IDENTIFY 0xec /* get ATA params */
474 #define ATA_SETFEATURES 0xef /* features command */
475 #define ATA_SF_ENAB_WCACHE 0x02 /* enable write cache */
476 #define ATA_SF_DIS_WCACHE 0x82 /* disable write cache */
477 #define ATA_SF_SETXFER 0x03 /* set transfer mode */
478 #define ATA_SF_APM 0x05 /* Enable APM feature set */
479 #define ATA_SF_ENAB_PUIS 0x06 /* enable PUIS */
480 #define ATA_SF_DIS_PUIS 0x86 /* disable PUIS */
481 #define ATA_SF_PUIS_SPINUP 0x07 /* PUIS spin-up */
482 #define ATA_SF_WRV 0x0b /* Enable Write-Read-Verify */
483 #define ATA_SF_DLC 0x0c /* Enable device life control */
484 #define ATA_SF_SATA 0x10 /* Enable use of SATA feature */
485 #define ATA_SF_FFC 0x41 /* Free-fall Control */
486 #define ATA_SF_MHIST 0x43 /* Set Max Host Sect. Times */
487 #define ATA_SF_RATE 0x45 /* Set Rate Basis */
488 #define ATA_SF_EPC 0x4A /* Extended Power Conditions */
489 #define ATA_SF_ENAB_RCACHE 0xaa /* enable readahead cache */
490 #define ATA_SF_DIS_RCACHE 0x55 /* disable readahead cache */
491 #define ATA_SF_ENAB_RELIRQ 0x5d /* enable release interrupt */
492 #define ATA_SF_DIS_RELIRQ 0xdd /* disable release interrupt */
493 #define ATA_SF_ENAB_SRVIRQ 0x5e /* enable service interrupt */
494 #define ATA_SF_DIS_SRVIRQ 0xde /* disable service interrupt */
495 #define ATA_SF_LPSAERC 0x62 /* Long Phys Sect Align ErrRep*/
496 #define ATA_SF_DSN 0x63 /* Device Stats Notification */
497 #define ATA_CHECK_POWER_MODE 0xe5 /* Check Power Mode */
498 #define ATA_SECURITY_SET_PASSWORD 0xf1 /* set drive password */
499 #define ATA_SECURITY_UNLOCK 0xf2 /* unlock drive using passwd */
500 #define ATA_SECURITY_ERASE_PREPARE 0xf3 /* prepare to erase drive */
501 #define ATA_SECURITY_ERASE_UNIT 0xf4 /* erase all blocks on drive */
502 #define ATA_SECURITY_FREEZE_LOCK 0xf5 /* freeze security config */
503 #define ATA_SECURITY_DISABLE_PASSWORD 0xf6 /* disable drive password */
504 #define ATA_READ_NATIVE_MAX_ADDRESS 0xf8 /* read native max address */
505 #define ATA_SET_MAX_ADDRESS 0xf9 /* set max address */
509 #define ATAPI_TEST_UNIT_READY 0x00 /* check if device is ready */
510 #define ATAPI_REZERO 0x01 /* rewind */
511 #define ATAPI_REQUEST_SENSE 0x03 /* get sense data */
512 #define ATAPI_FORMAT 0x04 /* format unit */
513 #define ATAPI_READ 0x08 /* read data */
514 #define ATAPI_WRITE 0x0a /* write data */
515 #define ATAPI_WEOF 0x10 /* write filemark */
516 #define ATAPI_WF_WRITE 0x01
517 #define ATAPI_SPACE 0x11 /* space command */
518 #define ATAPI_SP_FM 0x01
519 #define ATAPI_SP_EOD 0x03
520 #define ATAPI_INQUIRY 0x12 /* get inquiry data */
521 #define ATAPI_MODE_SELECT 0x15 /* mode select */
522 #define ATAPI_ERASE 0x19 /* erase */
523 #define ATAPI_MODE_SENSE 0x1a /* mode sense */
524 #define ATAPI_START_STOP 0x1b /* start/stop unit */
525 #define ATAPI_SS_LOAD 0x01
526 #define ATAPI_SS_RETENSION 0x02
527 #define ATAPI_SS_EJECT 0x04
528 #define ATAPI_PREVENT_ALLOW 0x1e /* media removal */
529 #define ATAPI_READ_FORMAT_CAPACITIES 0x23 /* get format capacities */
530 #define ATAPI_READ_CAPACITY 0x25 /* get volume capacity */
531 #define ATAPI_READ_BIG 0x28 /* read data */
532 #define ATAPI_WRITE_BIG 0x2a /* write data */
533 #define ATAPI_LOCATE 0x2b /* locate to position */
534 #define ATAPI_READ_POSITION 0x34 /* read position */
535 #define ATAPI_SYNCHRONIZE_CACHE 0x35 /* flush buf, close channel */
536 #define ATAPI_WRITE_BUFFER 0x3b /* write device buffer */
537 #define ATAPI_READ_BUFFER 0x3c /* read device buffer */
538 #define ATAPI_READ_SUBCHANNEL 0x42 /* get subchannel info */
539 #define ATAPI_READ_TOC 0x43 /* get table of contents */
540 #define ATAPI_PLAY_10 0x45 /* play by lba */
541 #define ATAPI_PLAY_MSF 0x47 /* play by MSF address */
542 #define ATAPI_PLAY_TRACK 0x48 /* play by track number */
543 #define ATAPI_PAUSE 0x4b /* pause audio operation */
544 #define ATAPI_READ_DISK_INFO 0x51 /* get disk info structure */
545 #define ATAPI_READ_TRACK_INFO 0x52 /* get track info structure */
546 #define ATAPI_RESERVE_TRACK 0x53 /* reserve track */
547 #define ATAPI_SEND_OPC_INFO 0x54 /* send OPC structurek */
548 #define ATAPI_MODE_SELECT_BIG 0x55 /* set device parameters */
549 #define ATAPI_REPAIR_TRACK 0x58 /* repair track */
550 #define ATAPI_READ_MASTER_CUE 0x59 /* read master CUE info */
551 #define ATAPI_MODE_SENSE_BIG 0x5a /* get device parameters */
552 #define ATAPI_CLOSE_TRACK 0x5b /* close track/session */
553 #define ATAPI_READ_BUFFER_CAPACITY 0x5c /* get buffer capicity */
554 #define ATAPI_SEND_CUE_SHEET 0x5d /* send CUE sheet */
555 #define ATAPI_SERVICE_ACTION_IN 0x96 /* get service data */
556 #define ATAPI_BLANK 0xa1 /* blank the media */
557 #define ATAPI_SEND_KEY 0xa3 /* send DVD key structure */
558 #define ATAPI_REPORT_KEY 0xa4 /* get DVD key structure */
559 #define ATAPI_PLAY_12 0xa5 /* play by lba */
560 #define ATAPI_LOAD_UNLOAD 0xa6 /* changer control command */
561 #define ATAPI_READ_STRUCTURE 0xad /* get DVD structure */
562 #define ATAPI_PLAY_CD 0xb4 /* universal play command */
563 #define ATAPI_SET_SPEED 0xbb /* set drive speed */
564 #define ATAPI_MECH_STATUS 0xbd /* get changer status */
565 #define ATAPI_READ_CD 0xbe /* read data */
566 #define ATAPI_POLL_DSC 0xff /* poll DSC status bit */
569 struct ata_ioc_devices {
572 struct ata_params params[2];
575 /* pr channel ATA ioctl calls */
576 #define IOCATAGMAXCHANNEL _IOR('a', 1, int)
577 #define IOCATAREINIT _IOW('a', 2, int)
578 #define IOCATAATTACH _IOW('a', 3, int)
579 #define IOCATADETACH _IOW('a', 4, int)
580 #define IOCATADEVICES _IOWR('a', 5, struct ata_ioc_devices)
582 /* ATAPI request sense structure */
584 u_int8_t error; /* current or deferred errors */
585 #define ATA_SENSE_VALID 0x80
587 u_int8_t segment; /* segment number */
588 u_int8_t key; /* sense key */
589 #define ATA_SENSE_KEY_MASK 0x0f /* sense key mask */
590 #define ATA_SENSE_NO_SENSE 0x00 /* no specific sense key info */
591 #define ATA_SENSE_RECOVERED_ERROR 0x01 /* command OK, data recovered */
592 #define ATA_SENSE_NOT_READY 0x02 /* no access to drive */
593 #define ATA_SENSE_MEDIUM_ERROR 0x03 /* non-recovered data error */
594 #define ATA_SENSE_HARDWARE_ERROR 0x04 /* non-recoverable HW failure */
595 #define ATA_SENSE_ILLEGAL_REQUEST 0x05 /* invalid command param(s) */
596 #define ATA_SENSE_UNIT_ATTENTION 0x06 /* media changed */
597 #define ATA_SENSE_DATA_PROTECT 0x07 /* write protect */
598 #define ATA_SENSE_BLANK_CHECK 0x08 /* blank check */
599 #define ATA_SENSE_VENDOR_SPECIFIC 0x09 /* vendor specific skey */
600 #define ATA_SENSE_COPY_ABORTED 0x0a /* copy aborted */
601 #define ATA_SENSE_ABORTED_COMMAND 0x0b /* command aborted, try again */
602 #define ATA_SENSE_EQUAL 0x0c /* equal */
603 #define ATA_SENSE_VOLUME_OVERFLOW 0x0d /* volume overflow */
604 #define ATA_SENSE_MISCOMPARE 0x0e /* data dont match the medium */
605 #define ATA_SENSE_RESERVED 0x0f
606 #define ATA_SENSE_ILI 0x20;
607 #define ATA_SENSE_EOM 0x40;
608 #define ATA_SENSE_FILEMARK 0x80;
610 u_int32_t cmd_info; /* cmd information */
611 u_int8_t sense_length; /* additional sense len (n-7) */
612 u_int32_t cmd_specific_info; /* additional cmd spec info */
613 u_int8_t asc; /* additional sense code */
614 u_int8_t ascq; /* additional sense code qual */
615 u_int8_t replaceable_unit_code; /* replaceable unit code */
616 u_int8_t specific; /* sense key specific */
617 #define ATA_SENSE_SPEC_VALID 0x80
618 #define ATA_SENSE_SPEC_MASK 0x7f
620 u_int8_t specific1; /* sense key specific */
621 u_int8_t specific2; /* sense key specific */
625 * SET FEATURES subcommands
629 * SET FEATURES command
630 * Extended Power Conditions subcommand -- ATA_SF_EPC (0x4A)
631 * These values go in the LBA 3:0.
633 #define ATA_SF_EPC_RESTORE 0x00 /* Restore Power Condition Settings */
634 #define ATA_SF_EPC_GOTO 0x01 /* Go To Power Condition */
635 #define ATA_SF_EPC_SET_TIMER 0x02 /* Set Power Condition Timer */
636 #define ATA_SF_EPC_SET_STATE 0x03 /* Set Power Condition State */
637 #define ATA_SF_EPC_ENABLE 0x04 /* Enable the EPC feature set */
638 #define ATA_SF_EPC_DISABLE 0x05 /* Disable the EPC feature set */
639 #define ATA_SF_EPC_SET_SOURCE 0x06 /* Set EPC Power Source */
642 * SET FEATURES command
643 * Extended Power Conditions subcommand -- ATA_SF_EPC (0x4A)
644 * Power Condition ID field
645 * These values go in the count register.
647 #define ATA_EPC_STANDBY_Z 0x00 /* Substate of PM2:Standby */
648 #define ATA_EPC_STANDBY_Y 0x01 /* Substate of PM2:Standby */
649 #define ATA_EPC_IDLE_A 0x81 /* Substate of PM1:Idle */
650 #define ATA_EPC_IDLE_B 0x82 /* Substate of PM1:Idle */
651 #define ATA_EPC_IDLE_C 0x83 /* Substate of PM1:Idle */
652 #define ATA_EPC_ALL 0xff /* All supported power conditions */
655 * SET FEATURES command
656 * Extended Power Conditions subcommand -- ATA_SF_EPC (0x4A)
657 * Restore Power Conditions Settings subcommand
658 * These values go in the LBA register.
660 #define ATA_SF_EPC_RST_DFLT 0x40 /* 1=Rst from Default, 0= from Saved */
661 #define ATA_SF_EPC_RST_SAVE 0x10 /* 1=Save on completion */
664 * SET FEATURES command
665 * Extended Power Conditions subcommand -- ATA_SF_EPC (0x4A)
666 * Got To Power Condition subcommand
667 * These values go in the LBA register.
669 #define ATA_SF_EPC_GOTO_DELAY 0x02000000 /* Delayed entry bit */
670 #define ATA_SF_EPC_GOTO_HOLD 0x01000000 /* Hold Power Cond bit */
673 * SET FEATURES command
674 * Extended Power Conditions subcommand -- ATA_SF_EPC (0x4A)
675 * Set Power Condition Timer subcommand
676 * These values go in the LBA register.
678 #define ATA_SF_EPC_TIMER_MASK 0x00ffff00 /* Timer field */
679 #define ATA_SF_EPC_TIMER_SHIFT 8
680 #define ATA_SF_EPC_TIMER_SEC 0x00000080 /* Timer units, 1=sec, 0=.1s */
681 #define ATA_SF_EPC_TIMER_EN 0x00000020 /* Enable/disable cond. */
682 #define ATA_SF_EPC_TIMER_SAVE 0x00000010 /* Save settings on comp. */
685 * SET FEATURES command
686 * Extended Power Conditions subcommand -- ATA_SF_EPC (0x4A)
687 * Set Power Condition State subcommand
688 * These values go in the LBA register.
690 #define ATA_SF_EPC_SETCON_EN 0x00000020 /* Enable power cond. */
691 #define ATA_SF_EPC_SETCON_SAVE 0x00000010 /* Save settings on comp */
694 * SET FEATURES command
695 * Extended Power Conditions subcommand -- ATA_SF_EPC (0x4A)
696 * Set EPC Power Source subcommand
697 * These values go in the count register.
699 #define ATA_SF_EPC_SRC_UNKNOWN 0x0000 /* Unknown source */
700 #define ATA_SF_EPC_SRC_BAT 0x0001 /* battery source */
701 #define ATA_SF_EPC_SRC_NOT_BAT 0x0002 /* not battery source */
703 #define ATA_LOG_DIRECTORY 0x00 /* Directory of all logs */
704 #define ATA_POWER_COND_LOG 0x08 /* Power Conditions Log */
705 #define ATA_PCL_IDLE 0x00 /* Idle Power Conditions Page */
706 #define ATA_PCL_STANDBY 0x01 /* Standby Power Conditions Page */
707 #define ATA_IDENTIFY_DATA_LOG 0x30 /* Identify Device Data Log */
708 #define ATA_IDL_PAGE_LIST 0x00 /* List of supported pages */
709 #define ATA_IDL_IDENTIFY_DATA 0x01 /* Copy of Identify Device data */
710 #define ATA_IDL_CAPACITY 0x02 /* Capacity */
711 #define ATA_IDL_SUP_CAP 0x03 /* Supported Capabilities */
712 #define ATA_IDL_CUR_SETTINGS 0x04 /* Current Settings */
713 #define ATA_IDL_ATA_STRINGS 0x05 /* ATA Strings */
714 #define ATA_IDL_SECURITY 0x06 /* Security */
715 #define ATA_IDL_PARALLEL_ATA 0x07 /* Parallel ATA */
716 #define ATA_IDL_SERIAL_ATA 0x08 /* Serial ATA */
717 #define ATA_IDL_ZDI 0x09 /* Zoned Device Information */
719 struct ata_gp_log_dir {
721 #define ATA_GP_LOG_DIR_VERSION 0x0001
722 uint8_t num_pages[255*2]; /* Number of log pages at address */
726 * ATA Power Conditions log descriptor
728 struct ata_power_cond_log_desc {
731 #define ATA_PCL_COND_SUPPORTED 0x80
732 #define ATA_PCL_COND_SAVEABLE 0x40
733 #define ATA_PCL_COND_CHANGEABLE 0x20
734 #define ATA_PCL_DEFAULT_TIMER_EN 0x10
735 #define ATA_PCL_SAVED_TIMER_EN 0x08
736 #define ATA_PCL_CURRENT_TIMER_EN 0x04
737 #define ATA_PCL_HOLD_PC_NOT_SUP 0x02
738 uint8_t reserved2[2];
739 uint8_t default_timer[4];
740 uint8_t saved_timer[4];
741 uint8_t current_timer[4];
742 uint8_t nom_time_to_active[4];
743 uint8_t min_timer[4];
744 uint8_t max_timer[4];
745 uint8_t num_transitions_to_pc[4];
746 uint8_t hours_in_pc[4];
747 uint8_t reserved3[28];
751 * ATA Power Conditions Log (0x08), Idle power conditions page (0x00)
753 struct ata_power_cond_log_idle {
754 struct ata_power_cond_log_desc idle_a_desc;
755 struct ata_power_cond_log_desc idle_b_desc;
756 struct ata_power_cond_log_desc idle_c_desc;
757 uint8_t reserved[320];
761 * ATA Power Conditions Log (0x08), Standby power conditions page (0x01)
763 struct ata_power_cond_log_standby {
764 uint8_t reserved[384];
765 struct ata_power_cond_log_desc standby_y_desc;
766 struct ata_power_cond_log_desc standby_z_desc;
770 * ATA IDENTIFY DEVICE data log (0x30) page 0x00
771 * List of Supported IDENTIFY DEVICE data pages.
773 struct ata_identify_log_pages {
775 #define ATA_IDLOG_REVISION 0x0000000000000001
777 uint8_t entries[503];
781 * ATA IDENTIFY DEVICE data log (0x30)
782 * Capacity (Page 0x02).
784 struct ata_identify_log_capacity {
786 #define ATA_CAP_HEADER_VALID 0x8000000000000000
787 #define ATA_CAP_PAGE_NUM_MASK 0x0000000000ff0000
788 #define ATA_CAP_PAGE_NUM_SHIFT 16
789 #define ATA_CAP_REV_MASK 0x00000000000000ff
791 #define ATA_CAP_CAPACITY_VALID 0x8000000000000000
792 #define ATA_CAP_ACCESSIBLE_CAP 0x0000ffffffffffff
793 uint8_t phys_logical_sect_size[8];
794 #define ATA_CAP_PL_VALID 0x8000000000000000
795 #define ATA_CAP_LTOP_REL_SUP 0x4000000000000000
796 #define ATA_CAP_LOG_SECT_SUP 0x2000000000000000
797 #define ATA_CAP_ALIGN_ERR_MASK 0x0000000000300000
798 #define ATA_CAP_LTOP_MASK 0x00000000000f0000
799 #define ATA_CAP_LOG_SECT_OFF 0x000000000000ffff
800 uint8_t logical_sect_size[8];
801 #define ATA_CAP_LOG_SECT_VALID 0x8000000000000000
802 #define ATA_CAP_LOG_SECT_SIZE 0x00000000ffffffff
803 uint8_t nominal_buffer_size[8];
804 #define ATA_CAP_NOM_BUF_VALID 0x8000000000000000
805 #define ATA_CAP_NOM_BUF_SIZE 0x7fffffffffffffff
806 uint8_t reserved[472];
810 * ATA IDENTIFY DEVICE data log (0x30)
811 * Supported Capabilities (Page 0x03).
814 struct ata_identify_log_sup_cap {
816 #define ATA_SUP_CAP_HEADER_VALID 0x8000000000000000
817 #define ATA_SUP_CAP_PAGE_NUM_MASK 0x0000000000ff0000
818 #define ATA_SUP_CAP_PAGE_NUM_SHIFT 16
819 #define ATA_SUP_CAP_REV_MASK 0x00000000000000ff
821 #define ATA_SUP_CAP_VALID 0x8000000000000000
822 #define ATA_SC_SET_SECT_CONFIG_SUP 0x0002000000000000 /* Set Sect Conf*/
823 #define ATA_SC_ZERO_EXT_SUP 0x0001000000000000 /* Zero EXT */
824 #define ATA_SC_SUCC_NCQ_SENSE_SUP 0x0000800000000000 /* Succ. NCQ Sns */
825 #define ATA_SC_DLC_SUP 0x0000400000000000 /* DLC */
826 #define ATA_SC_RQSN_DEV_FAULT_SUP 0x0000200000000000 /* Req Sns Dev Flt*/
827 #define ATA_SC_DSN_SUP 0x0000100000000000 /* DSN */
828 #define ATA_SC_LP_STANDBY_SUP 0x0000080000000000 /* LP Standby */
829 #define ATA_SC_SET_EPC_PS_SUP 0x0000040000000000 /* Set EPC PS */
830 #define ATA_SC_AMAX_ADDR_SUP 0x0000020000000000 /* AMAX Addr */
831 #define ATA_SC_DRAT_SUP 0x0000008000000000 /* DRAT */
832 #define ATA_SC_LPS_MISALGN_SUP 0x0000004000000000 /* LPS Misalign */
833 #define ATA_SC_RB_DMA_SUP 0x0000001000000000 /* Read Buf DMA */
834 #define ATA_SC_WB_DMA_SUP 0x0000000800000000 /* Write Buf DMA */
835 #define ATA_SC_DNLD_MC_DMA_SUP 0x0000000200000000 /* DL MCode DMA */
836 #define ATA_SC_28BIT_SUP 0x0000000100000000 /* 28-bit */
837 #define ATA_SC_RZAT_SUP 0x0000000080000000 /* RZAT */
838 #define ATA_SC_NOP_SUP 0x0000000020000000 /* NOP */
839 #define ATA_SC_READ_BUFFER_SUP 0x0000000010000000 /* Read Buffer */
840 #define ATA_SC_WRITE_BUFFER_SUP 0x0000000008000000 /* Write Buffer */
841 #define ATA_SC_READ_LOOK_AHEAD_SUP 0x0000000002000000 /* Read Look-Ahead*/
842 #define ATA_SC_VOLATILE_WC_SUP 0x0000000001000000 /* Volatile WC */
843 #define ATA_SC_SMART_SUP 0x0000000000800000 /* SMART */
844 #define ATA_SC_FLUSH_CACHE_EXT_SUP 0x0000000000400000 /* Flush Cache Ext */
845 #define ATA_SC_48BIT_SUP 0x0000000000100000 /* 48-Bit */
846 #define ATA_SC_SPINUP_SUP 0x0000000000040000 /* Spin-Up */
847 #define ATA_SC_PUIS_SUP 0x0000000000020000 /* PUIS */
848 #define ATA_SC_APM_SUP 0x0000000000010000 /* APM */
849 #define ATA_SC_DL_MICROCODE_SUP 0x0000000000004000 /* DL Microcode */
850 #define ATA_SC_UNLOAD_SUP 0x0000000000002000 /* Unload */
851 #define ATA_SC_WRITE_FUA_EXT_SUP 0x0000000000001000 /* Write FUA EXT */
852 #define ATA_SC_GPL_SUP 0x0000000000000800 /* GPL */
853 #define ATA_SC_STREAMING_SUP 0x0000000000000400 /* Streaming */
854 #define ATA_SC_SMART_SELFTEST_SUP 0x0000000000000100 /* SMART self-test */
855 #define ATA_SC_SMART_ERR_LOG_SUP 0x0000000000000080 /* SMART Err Log */
856 #define ATA_SC_EPC_SUP 0x0000000000000040 /* EPC */
857 #define ATA_SC_SENSE_SUP 0x0000000000000020 /* Sense data */
858 #define ATA_SC_FREEFALL_SUP 0x0000000000000010 /* Free-Fall */
859 #define ATA_SC_DM_MODE3_SUP 0x0000000000000008 /* DM Mode 3 */
860 #define ATA_SC_GPL_DMA_SUP 0x0000000000000004 /* GPL DMA */
861 #define ATA_SC_WRITE_UNCOR_SUP 0x0000000000000002 /* Write uncorr. */
862 #define ATA_SC_WRV_SUP 0x0000000000000001 /* WRV */
863 uint8_t download_code_cap[8];
864 #define ATA_DL_CODE_VALID 0x8000000000000000
865 #define ATA_DLC_DM_OFFSETS_DEFER_SUP 0x0000000400000000
866 #define ATA_DLC_DM_IMMED_SUP 0x0000000200000000
867 #define ATA_DLC_DM_OFF_IMMED_SUP 0x0000000100000000
868 #define ATA_DLC_DM_MAX_XFER_SIZE_MASK 0x00000000ffff0000
869 #define ATA_DLC_DM_MAX_XFER_SIZE_SHIFT 16
870 #define ATA_DLC_DM_MIN_XFER_SIZE_MASK 0x000000000000ffff
871 uint8_t nom_media_rotation_rate[8];
872 #define ATA_NOM_MEDIA_ROTATION_VALID 0x8000000000000000
873 #define ATA_ROTATION_MASK 0x000000000000ffff
874 uint8_t form_factor[8];
875 #define ATA_FORM_FACTOR_VALID 0x8000000000000000
876 #define ATA_FF_MASK 0x000000000000000f
877 #define ATA_FF_NOT_REPORTED 0x0000000000000000 /* Not reported */
878 #define ATA_FF_525_IN 0x0000000000000001 /* 5.25 inch */
879 #define ATA_FF_35_IN 0x0000000000000002 /* 3.5 inch */
880 #define ATA_FF_25_IN 0x0000000000000003 /* 2.5 inch */
881 #define ATA_FF_18_IN 0x0000000000000004 /* 1.8 inch */
882 #define ATA_FF_LT_18_IN 0x0000000000000005 /* < 1.8 inch */
883 #define ATA_FF_MSATA 0x0000000000000006 /* mSATA */
884 #define ATA_FF_M2 0x0000000000000007 /* M.2 */
885 #define ATA_FF_MICROSSD 0x0000000000000008 /* MicroSSD */
886 #define ATA_FF_CFAST 0x0000000000000009 /* CFast */
887 uint8_t wrv_sec_cnt_mode3[8];
888 #define ATA_WRV_MODE3_VALID 0x8000000000000000
889 #define ATA_WRV_MODE3_COUNT 0x00000000ffffffff
890 uint8_t wrv_sec_cnt_mode2[8];
891 #define ATA_WRV_MODE2_VALID 0x8000000000000000
892 #define ATA_WRV_MODE2_COUNT 0x00000000ffffffff
894 /* XXX KDM need to figure out how to handle 128-bit fields */
896 #define ATA_DSM_VALID 0x8000000000000000
897 #define ATA_LB_MARKUP_SUP 0x000000000000ff00
898 #define ATA_TRIM_SUP 0x0000000000000001
899 uint8_t util_per_unit_time[16];
900 /* XXX KDM need to figure out how to handle 128-bit fields */
901 uint8_t util_usage_rate_sup[8];
902 #define ATA_UTIL_USAGE_RATE_VALID 0x8000000000000000
903 #define ATA_SETTING_RATE_SUP 0x0000000000800000
904 #define ATA_SINCE_POWERON_SUP 0x0000000000000100
905 #define ATA_POH_RATE_SUP 0x0000000000000010
906 #define ATA_DATE_TIME_RATE_SUP 0x0000000000000001
907 uint8_t zoned_cap[8];
908 #define ATA_ZONED_VALID 0x8000000000000000
909 #define ATA_ZONED_MASK 0x0000000000000003
910 uint8_t sup_zac_cap[8];
911 #define ATA_SUP_ZAC_CAP_VALID 0x8000000000000000
912 #define ATA_ND_RWP_SUP 0x0000000000000010 /* Reset Write Ptr*/
913 #define ATA_ND_FINISH_ZONE_SUP 0x0000000000000008 /* Finish Zone */
914 #define ATA_ND_CLOSE_ZONE_SUP 0x0000000000000004 /* Close Zone */
915 #define ATA_ND_OPEN_ZONE_SUP 0x0000000000000002 /* Open Zone */
916 #define ATA_REPORT_ZONES_SUP 0x0000000000000001 /* Report Zones */
917 uint8_t reserved[392];
921 * ATA Identify Device Data Log Zoned Device Information Page (0x09).
922 * Current as of ZAC r04a, August 25, 2015.
924 struct ata_zoned_info_log {
926 #define ATA_ZDI_HEADER_VALID 0x8000000000000000
927 #define ATA_ZDI_PAGE_NUM_MASK 0x0000000000ff0000
928 #define ATA_ZDI_PAGE_NUM_SHIFT 16
929 #define ATA_ZDI_REV_MASK 0x00000000000000ff
930 uint8_t zoned_cap[8];
931 #define ATA_ZDI_CAP_VALID 0x8000000000000000
932 #define ATA_ZDI_CAP_URSWRZ 0x0000000000000001
933 uint8_t zoned_settings[8];
934 #define ATA_ZDI_SETTINGS_VALID 0x8000000000000000
935 uint8_t optimal_seq_zones[8];
936 #define ATA_ZDI_OPT_SEQ_VALID 0x8000000000000000
937 #define ATA_ZDI_OPT_SEQ_MASK 0x00000000ffffffff
938 uint8_t optimal_nonseq_zones[8];
939 #define ATA_ZDI_OPT_NS_VALID 0x8000000000000000
940 #define ATA_ZDI_OPT_NS_MASK 0x00000000ffffffff
941 uint8_t max_seq_req_zones[8];
942 #define ATA_ZDI_MAX_SEQ_VALID 0x8000000000000000
943 #define ATA_ZDI_MAX_SEQ_MASK 0x00000000ffffffff
944 uint8_t version_info[8];
945 #define ATA_ZDI_VER_VALID 0x8000000000000000
946 #define ATA_ZDI_VER_ZAC_SUP 0x0100000000000000
947 #define ATA_ZDI_VER_ZAC_MASK 0x00000000000000ff
948 uint8_t reserved[456];
951 struct ata_ioc_request {
961 struct atapi_sense sense;
967 #define ATA_CMD_CONTROL 0x01
968 #define ATA_CMD_READ 0x02
969 #define ATA_CMD_WRITE 0x04
970 #define ATA_CMD_ATAPI 0x08
976 struct ata_security_password {
978 #define ATA_SECURITY_PASSWORD_USER 0x0000
979 #define ATA_SECURITY_PASSWORD_MASTER 0x0001
980 #define ATA_SECURITY_ERASE_NORMAL 0x0000
981 #define ATA_SECURITY_ERASE_ENHANCED 0x0002
982 #define ATA_SECURITY_LEVEL_HIGH 0x0000
983 #define ATA_SECURITY_LEVEL_MAXIMUM 0x0100
985 u_int8_t password[32];
987 u_int16_t reserved[238];
990 /* pr device ATA ioctl calls */
991 #define IOCATAREQUEST _IOWR('a', 100, struct ata_ioc_request)
992 #define IOCATAGPARM _IOR('a', 101, struct ata_params)
993 #define IOCATAGMODE _IOR('a', 102, int)
994 #define IOCATASMODE _IOW('a', 103, int)
996 #define IOCATAGSPINDOWN _IOR('a', 104, int)
997 #define IOCATASSPINDOWN _IOW('a', 105, int)
1000 struct ata_ioc_raid_config {
1003 #define AR_JBOD 0x0001
1004 #define AR_SPAN 0x0002
1005 #define AR_RAID0 0x0004
1006 #define AR_RAID1 0x0008
1007 #define AR_RAID01 0x0010
1008 #define AR_RAID3 0x0020
1009 #define AR_RAID4 0x0040
1010 #define AR_RAID5 0x0080
1015 #define AR_DEGRADED 2
1016 #define AR_REBUILDING 4
1023 struct ata_ioc_raid_status {
1032 #define AR_DISK_ONLINE 0x01
1033 #define AR_DISK_PRESENT 0x02
1034 #define AR_DISK_SPARE 0x04
1039 /* ATA RAID ioctl calls */
1040 #define IOCATARAIDCREATE _IOWR('a', 200, struct ata_ioc_raid_config)
1041 #define IOCATARAIDDELETE _IOW('a', 201, int)
1042 #define IOCATARAIDSTATUS _IOWR('a', 202, struct ata_ioc_raid_status)
1043 #define IOCATARAIDADDSPARE _IOW('a', 203, struct ata_ioc_raid_config)
1044 #define IOCATARAIDREBUILD _IOW('a', 204, int)
1046 #endif /* _SYS_ATA_H_ */