1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2
3 /*
4 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
5 * Copyright 2003-2004 Jeff Garzik
6 *
7 * libata documentation is available via 'make {ps|pdf}docs',
8 * as Documentation/driver-api/libata.rst
9 *
10 * Hardware documentation available from http://www.t13.org/
11 */
12
13 #ifndef __LINUX_ATA_H__
14 #define __LINUX_ATA_H__
15
16 #include <linux/bits.h>
17 #include <linux/string.h>
18 #include <linux/types.h>
19
20 /* defines only for the constants which don't work well as enums */
21 #define ATA_DMA_BOUNDARY 0xffffUL
22 #define ATA_DMA_MASK 0xffffffffULL
23
24 enum {
25 /* various global constants */
26 ATA_MAX_DEVICES = 2, /* per bus/port */
27 ATA_MAX_PRD = 256, /* we could make these 256/256 */
28 ATA_SECT_SIZE = 512,
29 ATA_MAX_SECTORS = 256,
30 ATA_MAX_SECTORS_LBA48 = 65535,/* avoid count to be 0000h */
31 ATA_MAX_SECTORS_TAPE = 65535,
32 ATA_MAX_TRIM_RNUM = 64, /* 512-byte payload / (6-byte LBA + 2-byte range per entry) */
33
34 ATA_ID_WORDS = 256,
35 ATA_ID_CONFIG = 0,
36 ATA_ID_CYLS = 1,
37 ATA_ID_HEADS = 3,
38 ATA_ID_SECTORS = 6,
39 ATA_ID_SERNO = 10,
40 ATA_ID_BUF_SIZE = 21,
41 ATA_ID_FW_REV = 23,
42 ATA_ID_PROD = 27,
43 ATA_ID_MAX_MULTSECT = 47,
44 ATA_ID_DWORD_IO = 48, /* before ATA-8 */
45 ATA_ID_TRUSTED = 48, /* ATA-8 and later */
46 ATA_ID_CAPABILITY = 49,
47 ATA_ID_OLD_PIO_MODES = 51,
48 ATA_ID_OLD_DMA_MODES = 52,
49 ATA_ID_FIELD_VALID = 53,
50 ATA_ID_CUR_CYLS = 54,
51 ATA_ID_CUR_HEADS = 55,
52 ATA_ID_CUR_SECTORS = 56,
53 ATA_ID_MULTSECT = 59,
54 ATA_ID_LBA_CAPACITY = 60,
55 ATA_ID_SWDMA_MODES = 62,
56 ATA_ID_MWDMA_MODES = 63,
57 ATA_ID_PIO_MODES = 64,
58 ATA_ID_EIDE_DMA_MIN = 65,
59 ATA_ID_EIDE_DMA_TIME = 66,
60 ATA_ID_EIDE_PIO = 67,
61 ATA_ID_EIDE_PIO_IORDY = 68,
62 ATA_ID_ADDITIONAL_SUPP = 69,
63 ATA_ID_QUEUE_DEPTH = 75,
64 ATA_ID_SATA_CAPABILITY = 76,
65 ATA_ID_SATA_CAPABILITY_2 = 77,
66 ATA_ID_FEATURE_SUPP = 78,
67 ATA_ID_MAJOR_VER = 80,
68 ATA_ID_COMMAND_SET_1 = 82,
69 ATA_ID_COMMAND_SET_2 = 83,
70 ATA_ID_CFSSE = 84,
71 ATA_ID_CFS_ENABLE_1 = 85,
72 ATA_ID_CFS_ENABLE_2 = 86,
73 ATA_ID_CSF_DEFAULT = 87,
74 ATA_ID_UDMA_MODES = 88,
75 ATA_ID_HW_CONFIG = 93,
76 ATA_ID_SPG = 98,
77 ATA_ID_LBA_CAPACITY_2 = 100,
78 ATA_ID_MAX_PAGES_PER_DSM = 105,
79 ATA_ID_SECTOR_SIZE = 106,
80 ATA_ID_WWN = 108,
81 ATA_ID_LOGICAL_SECTOR_SIZE = 117, /* and 118 */
82 ATA_ID_COMMAND_SET_3 = 119,
83 ATA_ID_COMMAND_SET_4 = 120,
84 ATA_ID_LAST_LUN = 126,
85 ATA_ID_DLF = 128,
86 ATA_ID_CSFO = 129,
87 ATA_ID_CFA_POWER = 160,
88 ATA_ID_CFA_KEY_MGMT = 162,
89 ATA_ID_CFA_MODES = 163,
90 ATA_ID_DATA_SET_MGMT = 169,
91 ATA_ID_SCT_CMD_XPORT = 206,
92 ATA_ID_ROT_SPEED = 217,
93 ATA_ID_PIO4 = (1 << 1),
94
95 ATA_ID_SERNO_LEN = 20,
96 ATA_ID_FW_REV_LEN = 8,
97 ATA_ID_PROD_LEN = 40,
98 ATA_ID_WWN_LEN = 8,
99
100 ATA_PCI_CTL_OFS = 2,
101
102 ATA_PIO0 = (1 << 0),
103 ATA_PIO1 = ATA_PIO0 | (1 << 1),
104 ATA_PIO2 = ATA_PIO1 | (1 << 2),
105 ATA_PIO3 = ATA_PIO2 | (1 << 3),
106 ATA_PIO4 = ATA_PIO3 | (1 << 4),
107 ATA_PIO5 = ATA_PIO4 | (1 << 5),
108 ATA_PIO6 = ATA_PIO5 | (1 << 6),
109
110 ATA_PIO4_ONLY = (1 << 4),
111
112 ATA_SWDMA0 = (1 << 0),
113 ATA_SWDMA1 = ATA_SWDMA0 | (1 << 1),
114 ATA_SWDMA2 = ATA_SWDMA1 | (1 << 2),
115
116 ATA_SWDMA2_ONLY = (1 << 2),
117
118 ATA_MWDMA0 = (1 << 0),
119 ATA_MWDMA1 = ATA_MWDMA0 | (1 << 1),
120 ATA_MWDMA2 = ATA_MWDMA1 | (1 << 2),
121 ATA_MWDMA3 = ATA_MWDMA2 | (1 << 3),
122 ATA_MWDMA4 = ATA_MWDMA3 | (1 << 4),
123
124 ATA_MWDMA12_ONLY = (1 << 1) | (1 << 2),
125 ATA_MWDMA2_ONLY = (1 << 2),
126
127 ATA_UDMA0 = (1 << 0),
128 ATA_UDMA1 = ATA_UDMA0 | (1 << 1),
129 ATA_UDMA2 = ATA_UDMA1 | (1 << 2),
130 ATA_UDMA3 = ATA_UDMA2 | (1 << 3),
131 ATA_UDMA4 = ATA_UDMA3 | (1 << 4),
132 ATA_UDMA5 = ATA_UDMA4 | (1 << 5),
133 ATA_UDMA6 = ATA_UDMA5 | (1 << 6),
134 ATA_UDMA7 = ATA_UDMA6 | (1 << 7),
135 /* ATA_UDMA7 is just for completeness... doesn't exist (yet?). */
136
137 ATA_UDMA24_ONLY = (1 << 2) | (1 << 4),
138
139 ATA_UDMA_MASK_40C = ATA_UDMA2, /* udma0-2 */
140
141 /* DMA-related */
142 ATA_PRD_SZ = 8,
143 ATA_PRD_TBL_SZ = (ATA_MAX_PRD * ATA_PRD_SZ),
144 ATA_PRD_EOT = (1 << 31), /* end-of-table flag */
145
146 ATA_DMA_TABLE_OFS = 4,
147 ATA_DMA_STATUS = 2,
148 ATA_DMA_CMD = 0,
149 ATA_DMA_WR = (1 << 3),
150 ATA_DMA_START = (1 << 0),
151 ATA_DMA_INTR = (1 << 2),
152 ATA_DMA_ERR = (1 << 1),
153 ATA_DMA_ACTIVE = (1 << 0),
154
155 /* bits in ATA command block registers */
156 ATA_HOB = (1 << 7), /* LBA48 selector */
157 ATA_NIEN = (1 << 1), /* disable-irq flag */
158 ATA_LBA = (1 << 6), /* LBA28 selector */
159 ATA_DEV1 = (1 << 4), /* Select Device 1 (slave) */
160 ATA_DEVICE_OBS = (1 << 7) | (1 << 5), /* obs bits in dev reg */
161 ATA_DEVCTL_OBS = (1 << 3), /* obsolete bit in devctl reg */
162 ATA_BUSY = (1 << 7), /* BSY status bit */
163 ATA_DRDY = (1 << 6), /* device ready */
164 ATA_DF = (1 << 5), /* device fault */
165 ATA_DSC = (1 << 4), /* drive seek complete */
166 ATA_DRQ = (1 << 3), /* data request i/o */
167 ATA_CORR = (1 << 2), /* corrected data error */
168 ATA_SENSE = (1 << 1), /* sense code available */
169 ATA_ERR = (1 << 0), /* have an error */
170 ATA_SRST = (1 << 2), /* software reset */
171 ATA_ICRC = (1 << 7), /* interface CRC error */
172 ATA_BBK = ATA_ICRC, /* pre-EIDE: block marked bad */
173 ATA_UNC = (1 << 6), /* uncorrectable media error */
174 ATA_MC = (1 << 5), /* media changed */
175 ATA_IDNF = (1 << 4), /* ID not found */
176 ATA_MCR = (1 << 3), /* media change requested */
177 ATA_ABORTED = (1 << 2), /* command aborted */
178 ATA_TRK0NF = (1 << 1), /* track 0 not found */
179 ATA_AMNF = (1 << 0), /* address mark not found */
180 ATAPI_LFS = 0xF0, /* last failed sense */
181 ATAPI_EOM = ATA_TRK0NF, /* end of media */
182 ATAPI_ILI = ATA_AMNF, /* illegal length indication */
183 ATAPI_IO = (1 << 1),
184 ATAPI_COD = (1 << 0),
185
186 /* ATA command block registers */
187 ATA_REG_DATA = 0x00,
188 ATA_REG_ERR = 0x01,
189 ATA_REG_NSECT = 0x02,
190 ATA_REG_LBAL = 0x03,
191 ATA_REG_LBAM = 0x04,
192 ATA_REG_LBAH = 0x05,
193 ATA_REG_DEVICE = 0x06,
194 ATA_REG_STATUS = 0x07,
195
196 ATA_REG_FEATURE = ATA_REG_ERR, /* and their aliases */
197 ATA_REG_CMD = ATA_REG_STATUS,
198 ATA_REG_BYTEL = ATA_REG_LBAM,
199 ATA_REG_BYTEH = ATA_REG_LBAH,
200 ATA_REG_DEVSEL = ATA_REG_DEVICE,
201 ATA_REG_IRQ = ATA_REG_NSECT,
202
203 /* ATA device commands */
204 ATA_CMD_DEV_RESET = 0x08, /* ATAPI device reset */
205 ATA_CMD_CHK_POWER = 0xE5, /* check power mode */
206 ATA_CMD_STANDBY = 0xE2, /* place in standby power mode */
207 ATA_CMD_IDLE = 0xE3, /* place in idle power mode */
208 ATA_CMD_EDD = 0x90, /* execute device diagnostic */
209 ATA_CMD_DOWNLOAD_MICRO = 0x92,
210 ATA_CMD_DOWNLOAD_MICRO_DMA = 0x93,
211 ATA_CMD_NOP = 0x00,
212 ATA_CMD_FLUSH = 0xE7,
213 ATA_CMD_FLUSH_EXT = 0xEA,
214 ATA_CMD_ID_ATA = 0xEC,
215 ATA_CMD_ID_ATAPI = 0xA1,
216 ATA_CMD_SERVICE = 0xA2,
217 ATA_CMD_READ = 0xC8,
218 ATA_CMD_READ_EXT = 0x25,
219 ATA_CMD_READ_QUEUED = 0x26,
220 ATA_CMD_READ_STREAM_EXT = 0x2B,
221 ATA_CMD_READ_STREAM_DMA_EXT = 0x2A,
222 ATA_CMD_WRITE = 0xCA,
223 ATA_CMD_WRITE_EXT = 0x35,
224 ATA_CMD_WRITE_QUEUED = 0x36,
225 ATA_CMD_WRITE_STREAM_EXT = 0x3B,
226 ATA_CMD_WRITE_STREAM_DMA_EXT = 0x3A,
227 ATA_CMD_WRITE_FUA_EXT = 0x3D,
228 ATA_CMD_WRITE_QUEUED_FUA_EXT = 0x3E,
229 ATA_CMD_FPDMA_READ = 0x60,
230 ATA_CMD_FPDMA_WRITE = 0x61,
231 ATA_CMD_NCQ_NON_DATA = 0x63,
232 ATA_CMD_FPDMA_SEND = 0x64,
233 ATA_CMD_FPDMA_RECV = 0x65,
234 ATA_CMD_PIO_READ = 0x20,
235 ATA_CMD_PIO_READ_EXT = 0x24,
236 ATA_CMD_PIO_WRITE = 0x30,
237 ATA_CMD_PIO_WRITE_EXT = 0x34,
238 ATA_CMD_READ_MULTI = 0xC4,
239 ATA_CMD_READ_MULTI_EXT = 0x29,
240 ATA_CMD_WRITE_MULTI = 0xC5,
241 ATA_CMD_WRITE_MULTI_EXT = 0x39,
242 ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
243 ATA_CMD_SET_FEATURES = 0xEF,
244 ATA_CMD_SET_MULTI = 0xC6,
245 ATA_CMD_PACKET = 0xA0,
246 ATA_CMD_VERIFY = 0x40,
247 ATA_CMD_VERIFY_EXT = 0x42,
248 ATA_CMD_WRITE_UNCORR_EXT = 0x45,
249 ATA_CMD_STANDBYNOW1 = 0xE0,
250 ATA_CMD_IDLEIMMEDIATE = 0xE1,
251 ATA_CMD_SLEEP = 0xE6,
252 ATA_CMD_INIT_DEV_PARAMS = 0x91,
253 ATA_CMD_READ_NATIVE_MAX = 0xF8,
254 ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
255 ATA_CMD_SET_MAX = 0xF9,
256 ATA_CMD_SET_MAX_EXT = 0x37,
257 ATA_CMD_READ_LOG_EXT = 0x2F,
258 ATA_CMD_WRITE_LOG_EXT = 0x3F,
259 ATA_CMD_READ_LOG_DMA_EXT = 0x47,
260 ATA_CMD_WRITE_LOG_DMA_EXT = 0x57,
261 ATA_CMD_TRUSTED_NONDATA = 0x5B,
262 ATA_CMD_TRUSTED_RCV = 0x5C,
263 ATA_CMD_TRUSTED_RCV_DMA = 0x5D,
264 ATA_CMD_TRUSTED_SND = 0x5E,
265 ATA_CMD_TRUSTED_SND_DMA = 0x5F,
266 ATA_CMD_PMP_READ = 0xE4,
267 ATA_CMD_PMP_READ_DMA = 0xE9,
268 ATA_CMD_PMP_WRITE = 0xE8,
269 ATA_CMD_PMP_WRITE_DMA = 0xEB,
270 ATA_CMD_CONF_OVERLAY = 0xB1,
271 ATA_CMD_SEC_SET_PASS = 0xF1,
272 ATA_CMD_SEC_UNLOCK = 0xF2,
273 ATA_CMD_SEC_ERASE_PREP = 0xF3,
274 ATA_CMD_SEC_ERASE_UNIT = 0xF4,
275 ATA_CMD_SEC_FREEZE_LOCK = 0xF5,
276 ATA_CMD_SEC_DISABLE_PASS = 0xF6,
277 ATA_CMD_CONFIG_STREAM = 0x51,
278 ATA_CMD_SMART = 0xB0,
279 ATA_CMD_MEDIA_LOCK = 0xDE,
280 ATA_CMD_MEDIA_UNLOCK = 0xDF,
281 ATA_CMD_DSM = 0x06,
282 ATA_CMD_CHK_MED_CRD_TYP = 0xD1,
283 ATA_CMD_CFA_REQ_EXT_ERR = 0x03,
284 ATA_CMD_CFA_WRITE_NE = 0x38,
285 ATA_CMD_CFA_TRANS_SECT = 0x87,
286 ATA_CMD_CFA_ERASE = 0xC0,
287 ATA_CMD_CFA_WRITE_MULT_NE = 0xCD,
288 ATA_CMD_REQ_SENSE_DATA = 0x0B,
289 ATA_CMD_SANITIZE_DEVICE = 0xB4,
290 ATA_CMD_ZAC_MGMT_IN = 0x4A,
291 ATA_CMD_ZAC_MGMT_OUT = 0x9F,
292 ATA_CMD_GET_PHYS_ELEMENT_STATUS = 0x12,
293 ATA_CMD_REMOVE_ELEMENT_AND_TRUNCATE = 0x7c,
294 ATA_CMD_RESTORE_ELEMENTS_AND_REBUILD = 0x7d,
295 ATA_CMD_REMOVE_ELEMENT_AND_MODIFY_ZONES = 0x7e,
296
297 /* marked obsolete in the ATA/ATAPI-7 spec */
298 ATA_CMD_RESTORE = 0x10,
299
300 /* Subcmds for ATA_CMD_FPDMA_RECV */
301 ATA_SUBCMD_FPDMA_RECV_RD_LOG_DMA_EXT = 0x01,
302 ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN = 0x02,
303
304 /* Subcmds for ATA_CMD_FPDMA_SEND */
305 ATA_SUBCMD_FPDMA_SEND_DSM = 0x00,
306 ATA_SUBCMD_FPDMA_SEND_WR_LOG_DMA_EXT = 0x02,
307
308 /* Subcmds for ATA_CMD_NCQ_NON_DATA */
309 ATA_SUBCMD_NCQ_NON_DATA_ABORT_QUEUE = 0x00,
310 ATA_SUBCMD_NCQ_NON_DATA_SET_FEATURES = 0x05,
311 ATA_SUBCMD_NCQ_NON_DATA_ZERO_EXT = 0x06,
312 ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT = 0x07,
313
314 /* Subcmds for ATA_CMD_ZAC_MGMT_IN */
315 ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES = 0x00,
316
317 /* Subcmds for ATA_CMD_ZAC_MGMT_OUT */
318 ATA_SUBCMD_ZAC_MGMT_OUT_CLOSE_ZONE = 0x01,
319 ATA_SUBCMD_ZAC_MGMT_OUT_FINISH_ZONE = 0x02,
320 ATA_SUBCMD_ZAC_MGMT_OUT_OPEN_ZONE = 0x03,
321 ATA_SUBCMD_ZAC_MGMT_OUT_RESET_WRITE_POINTER = 0x04,
322
323 /* READ_LOG_EXT pages */
324 ATA_LOG_DIRECTORY = 0x0,
325 ATA_LOG_SATA_NCQ = 0x10,
326 ATA_LOG_NCQ_NON_DATA = 0x12,
327 ATA_LOG_NCQ_SEND_RECV = 0x13,
328 ATA_LOG_CDL = 0x18,
329 ATA_LOG_CDL_SIZE = ATA_SECT_SIZE,
330 ATA_LOG_IDENTIFY_DEVICE = 0x30,
331 ATA_LOG_SENSE_NCQ = 0x0F,
332 ATA_LOG_SENSE_NCQ_SIZE = ATA_SECT_SIZE * 2,
333 ATA_LOG_CONCURRENT_POSITIONING_RANGES = 0x47,
334
335 /* Identify device log pages: */
336 ATA_LOG_SUPPORTED_CAPABILITIES = 0x03,
337 ATA_LOG_CURRENT_SETTINGS = 0x04,
338 ATA_LOG_SECURITY = 0x06,
339 ATA_LOG_SATA_SETTINGS = 0x08,
340 ATA_LOG_ZONED_INFORMATION = 0x09,
341
342 /* Identify device SATA settings log: */
343 ATA_LOG_DEVSLP_OFFSET = 0x30,
344 ATA_LOG_DEVSLP_SIZE = 0x08,
345 ATA_LOG_DEVSLP_MDAT = 0x00,
346 ATA_LOG_DEVSLP_MDAT_MASK = 0x1F,
347 ATA_LOG_DEVSLP_DETO = 0x01,
348 ATA_LOG_DEVSLP_VALID = 0x07,
349 ATA_LOG_DEVSLP_VALID_MASK = 0x80,
350 ATA_LOG_NCQ_PRIO_OFFSET = 0x09,
351
352 /* NCQ send and receive log */
353 ATA_LOG_NCQ_SEND_RECV_SUBCMDS_OFFSET = 0x00,
354 ATA_LOG_NCQ_SEND_RECV_SUBCMDS_DSM = (1 << 0),
355 ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET = 0x04,
356 ATA_LOG_NCQ_SEND_RECV_DSM_TRIM = (1 << 0),
357 ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET = 0x08,
358 ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED = (1 << 0),
359 ATA_LOG_NCQ_SEND_RECV_WR_LOG_OFFSET = 0x0C,
360 ATA_LOG_NCQ_SEND_RECV_WR_LOG_SUPPORTED = (1 << 0),
361 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OFFSET = 0x10,
362 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OUT_SUPPORTED = (1 << 0),
363 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED = (1 << 1),
364 ATA_LOG_NCQ_SEND_RECV_SIZE = 0x14,
365
366 /* NCQ Non-Data log */
367 ATA_LOG_NCQ_NON_DATA_SUBCMDS_OFFSET = 0x00,
368 ATA_LOG_NCQ_NON_DATA_ABORT_OFFSET = 0x00,
369 ATA_LOG_NCQ_NON_DATA_ABORT_NCQ = (1 << 0),
370 ATA_LOG_NCQ_NON_DATA_ABORT_ALL = (1 << 1),
371 ATA_LOG_NCQ_NON_DATA_ABORT_STREAMING = (1 << 2),
372 ATA_LOG_NCQ_NON_DATA_ABORT_NON_STREAMING = (1 << 3),
373 ATA_LOG_NCQ_NON_DATA_ABORT_SELECTED = (1 << 4),
374 ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET = 0x1C,
375 ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT = (1 << 0),
376 ATA_LOG_NCQ_NON_DATA_SIZE = 0x40,
377
378 /* READ/WRITE LONG (obsolete) */
379 ATA_CMD_READ_LONG = 0x22,
380 ATA_CMD_READ_LONG_ONCE = 0x23,
381 ATA_CMD_WRITE_LONG = 0x32,
382 ATA_CMD_WRITE_LONG_ONCE = 0x33,
383
384 /* SETFEATURES stuff */
385 SETFEATURES_XFER = 0x03,
386 XFER_UDMA_7 = 0x47,
387 XFER_UDMA_6 = 0x46,
388 XFER_UDMA_5 = 0x45,
389 XFER_UDMA_4 = 0x44,
390 XFER_UDMA_3 = 0x43,
391 XFER_UDMA_2 = 0x42,
392 XFER_UDMA_1 = 0x41,
393 XFER_UDMA_0 = 0x40,
394 XFER_MW_DMA_4 = 0x24, /* CFA only */
395 XFER_MW_DMA_3 = 0x23, /* CFA only */
396 XFER_MW_DMA_2 = 0x22,
397 XFER_MW_DMA_1 = 0x21,
398 XFER_MW_DMA_0 = 0x20,
399 XFER_SW_DMA_2 = 0x12,
400 XFER_SW_DMA_1 = 0x11,
401 XFER_SW_DMA_0 = 0x10,
402 XFER_PIO_6 = 0x0E, /* CFA only */
403 XFER_PIO_5 = 0x0D, /* CFA only */
404 XFER_PIO_4 = 0x0C,
405 XFER_PIO_3 = 0x0B,
406 XFER_PIO_2 = 0x0A,
407 XFER_PIO_1 = 0x09,
408 XFER_PIO_0 = 0x08,
409 XFER_PIO_SLOW = 0x00,
410
411 SETFEATURES_WC_ON = 0x02, /* Enable write cache */
412 SETFEATURES_WC_OFF = 0x82, /* Disable write cache */
413
414 SETFEATURES_RA_ON = 0xaa, /* Enable read look-ahead */
415 SETFEATURES_RA_OFF = 0x55, /* Disable read look-ahead */
416
417 /* Enable/Disable Automatic Acoustic Management */
418 SETFEATURES_AAM_ON = 0x42,
419 SETFEATURES_AAM_OFF = 0xC2,
420
421 SETFEATURES_SPINUP = 0x07, /* Spin-up drive */
422 SETFEATURES_SPINUP_TIMEOUT = 30000, /* 30s timeout for drive spin-up from PUIS */
423
424 SETFEATURES_SATA_ENABLE = 0x10, /* Enable use of SATA feature */
425 SETFEATURES_SATA_DISABLE = 0x90, /* Disable use of SATA feature */
426
427 SETFEATURES_CDL = 0x0d, /* Enable/disable cmd duration limits */
428
429 /* SETFEATURE Sector counts for SATA features */
430 SATA_FPDMA_OFFSET = 0x01, /* FPDMA non-zero buffer offsets */
431 SATA_FPDMA_AA = 0x02, /* FPDMA Setup FIS Auto-Activate */
432 SATA_DIPM = 0x03, /* Device Initiated Power Management */
433 SATA_FPDMA_IN_ORDER = 0x04, /* FPDMA in-order data delivery */
434 SATA_AN = 0x05, /* Asynchronous Notification */
435 SATA_SSP = 0x06, /* Software Settings Preservation */
436 SATA_DEVSLP = 0x09, /* Device Sleep */
437
438 SETFEATURE_SENSE_DATA = 0xC3, /* Sense Data Reporting feature */
439 SETFEATURE_SENSE_DATA_SUCC_NCQ = 0xC4, /* Sense Data for successful NCQ commands */
440
441 /* feature values for SET_MAX */
442 ATA_SET_MAX_ADDR = 0x00,
443 ATA_SET_MAX_PASSWD = 0x01,
444 ATA_SET_MAX_LOCK = 0x02,
445 ATA_SET_MAX_UNLOCK = 0x03,
446 ATA_SET_MAX_FREEZE_LOCK = 0x04,
447 ATA_SET_MAX_PASSWD_DMA = 0x05,
448 ATA_SET_MAX_UNLOCK_DMA = 0x06,
449
450 /* feature values for DEVICE CONFIGURATION OVERLAY */
451 ATA_DCO_RESTORE = 0xC0,
452 ATA_DCO_FREEZE_LOCK = 0xC1,
453 ATA_DCO_IDENTIFY = 0xC2,
454 ATA_DCO_SET = 0xC3,
455
456 /* feature values for SMART */
457 ATA_SMART_ENABLE = 0xD8,
458 ATA_SMART_READ_VALUES = 0xD0,
459 ATA_SMART_READ_THRESHOLDS = 0xD1,
460
461 /* feature values for Data Set Management */
462 ATA_DSM_TRIM = 0x01,
463
464 /* password used in LBA Mid / LBA High for executing SMART commands */
465 ATA_SMART_LBAM_PASS = 0x4F,
466 ATA_SMART_LBAH_PASS = 0xC2,
467
468 /* ATAPI stuff */
469 ATAPI_PKT_DMA = (1 << 0),
470 ATAPI_DMADIR = (1 << 2), /* ATAPI data dir:
471 0=to device, 1=to host */
472 ATAPI_CDB_LEN = 16,
473
474 /* PMP stuff */
475 SATA_PMP_MAX_PORTS = 15,
476 SATA_PMP_CTRL_PORT = 15,
477
478 SATA_PMP_GSCR_DWORDS = 128,
479 SATA_PMP_GSCR_PROD_ID = 0,
480 SATA_PMP_GSCR_REV = 1,
481 SATA_PMP_GSCR_PORT_INFO = 2,
482 SATA_PMP_GSCR_ERROR = 32,
483 SATA_PMP_GSCR_ERROR_EN = 33,
484 SATA_PMP_GSCR_FEAT = 64,
485 SATA_PMP_GSCR_FEAT_EN = 96,
486
487 SATA_PMP_PSCR_STATUS = 0,
488 SATA_PMP_PSCR_ERROR = 1,
489 SATA_PMP_PSCR_CONTROL = 2,
490
491 SATA_PMP_FEAT_BIST = (1 << 0),
492 SATA_PMP_FEAT_PMREQ = (1 << 1),
493 SATA_PMP_FEAT_DYNSSC = (1 << 2),
494 SATA_PMP_FEAT_NOTIFY = (1 << 3),
495
496 /* cable types */
497 ATA_CBL_NONE = 0,
498 ATA_CBL_PATA40 = 1,
499 ATA_CBL_PATA80 = 2,
500 ATA_CBL_PATA40_SHORT = 3, /* 40 wire cable to high UDMA spec */
501 ATA_CBL_PATA_UNK = 4, /* don't know, maybe 80c? */
502 ATA_CBL_PATA_IGN = 5, /* don't know, ignore cable handling */
503 ATA_CBL_SATA = 6,
504
505 /* SATA Status and Control Registers */
506 SCR_STATUS = 0,
507 SCR_ERROR = 1,
508 SCR_CONTROL = 2,
509 SCR_ACTIVE = 3,
510 SCR_NOTIFICATION = 4,
511
512 /* SError bits */
513 SERR_DATA_RECOVERED = (1 << 0), /* recovered data error */
514 SERR_COMM_RECOVERED = (1 << 1), /* recovered comm failure */
515 SERR_DATA = (1 << 8), /* unrecovered data error */
516 SERR_PERSISTENT = (1 << 9), /* persistent data/comm error */
517 SERR_PROTOCOL = (1 << 10), /* protocol violation */
518 SERR_INTERNAL = (1 << 11), /* host internal error */
519 SERR_PHYRDY_CHG = (1 << 16), /* PHY RDY changed */
520 SERR_PHY_INT_ERR = (1 << 17), /* PHY internal error */
521 SERR_COMM_WAKE = (1 << 18), /* Comm wake */
522 SERR_10B_8B_ERR = (1 << 19), /* 10b to 8b decode error */
523 SERR_DISPARITY = (1 << 20), /* Disparity */
524 SERR_CRC = (1 << 21), /* CRC error */
525 SERR_HANDSHAKE = (1 << 22), /* Handshake error */
526 SERR_LINK_SEQ_ERR = (1 << 23), /* Link sequence error */
527 SERR_TRANS_ST_ERROR = (1 << 24), /* Transport state trans. error */
528 SERR_UNRECOG_FIS = (1 << 25), /* Unrecognized FIS */
529 SERR_DEV_XCHG = (1 << 26), /* device exchanged */
530 };
531
532 enum ata_prot_flags {
533 /* protocol flags */
534 ATA_PROT_FLAG_PIO = (1 << 0), /* is PIO */
535 ATA_PROT_FLAG_DMA = (1 << 1), /* is DMA */
536 ATA_PROT_FLAG_NCQ = (1 << 2), /* is NCQ */
537 ATA_PROT_FLAG_ATAPI = (1 << 3), /* is ATAPI */
538
539 /* taskfile protocols */
540 ATA_PROT_UNKNOWN = (u8)-1,
541 ATA_PROT_NODATA = 0,
542 ATA_PROT_PIO = ATA_PROT_FLAG_PIO,
543 ATA_PROT_DMA = ATA_PROT_FLAG_DMA,
544 ATA_PROT_NCQ_NODATA = ATA_PROT_FLAG_NCQ,
545 ATA_PROT_NCQ = ATA_PROT_FLAG_DMA | ATA_PROT_FLAG_NCQ,
546 ATAPI_PROT_NODATA = ATA_PROT_FLAG_ATAPI,
547 ATAPI_PROT_PIO = ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_PIO,
548 ATAPI_PROT_DMA = ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_DMA,
549 };
550
551 enum ata_ioctls {
552 ATA_IOC_GET_IO32 = 0x309, /* HDIO_GET_32BIT */
553 ATA_IOC_SET_IO32 = 0x324, /* HDIO_SET_32BIT */
554 };
555
556 /* core structures */
557
558 struct ata_bmdma_prd {
559 __le32 addr;
560 __le32 flags_len;
561 };
562
563 /*
564 * id tests
565 */
566 #define ata_id_is_ata(id) (((id)[ATA_ID_CONFIG] & (1 << 15)) == 0)
567 #define ata_id_has_lba(id) ((id)[ATA_ID_CAPABILITY] & (1 << 9))
568 #define ata_id_has_dma(id) ((id)[ATA_ID_CAPABILITY] & (1 << 8))
569 #define ata_id_has_ncq(id) ((id)[ATA_ID_SATA_CAPABILITY] & (1 << 8))
570 #define ata_id_queue_depth(id) (((id)[ATA_ID_QUEUE_DEPTH] & 0x1f) + 1)
571 #define ata_id_removable(id) ((id)[ATA_ID_CONFIG] & (1 << 7))
572 #define ata_id_is_locked(id) (((id)[ATA_ID_DLF] & 0x7) == 0x7)
573 #define ata_id_has_atapi_AN(id) \
574 ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
575 ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
576 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 5)))
577 #define ata_id_has_fpdma_aa(id) \
578 ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
579 ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
580 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 2)))
581 #define ata_id_has_devslp(id) \
582 ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
583 ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
584 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 8)))
585 #define ata_id_has_ncq_autosense(id) \
586 ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
587 ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
588 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 7)))
589 #define ata_id_has_dipm(id) \
590 ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
591 ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
592 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 3)))
593 #define ata_id_iordy_disable(id) ((id)[ATA_ID_CAPABILITY] & (1 << 10))
594 #define ata_id_has_iordy(id) ((id)[ATA_ID_CAPABILITY] & (1 << 11))
595 #define ata_id_u32(id,n) \
596 (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
597 #define ata_id_u64(id,n) \
598 ( ((u64) (id)[(n) + 3] << 48) | \
599 ((u64) (id)[(n) + 2] << 32) | \
600 ((u64) (id)[(n) + 1] << 16) | \
601 ((u64) (id)[(n) + 0]) )
602
603 #define ata_id_cdb_intr(id) (((id)[ATA_ID_CONFIG] & 0x60) == 0x20)
604 #define ata_id_has_da(id) ((id)[ATA_ID_SATA_CAPABILITY_2] & (1 << 4))
605
ata_id_has_hipm(const u16 * id)606 static inline bool ata_id_has_hipm(const u16 *id)
607 {
608 u16 val = id[ATA_ID_SATA_CAPABILITY];
609
610 if (val == 0 || val == 0xffff)
611 return false;
612
613 return val & (1 << 9);
614 }
615
ata_id_has_fua(const u16 * id)616 static inline bool ata_id_has_fua(const u16 *id)
617 {
618 if ((id[ATA_ID_CFSSE] & 0xC000) != 0x4000)
619 return false;
620 return id[ATA_ID_CFSSE] & (1 << 6);
621 }
622
ata_id_has_flush(const u16 * id)623 static inline bool ata_id_has_flush(const u16 *id)
624 {
625 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
626 return false;
627 return id[ATA_ID_COMMAND_SET_2] & (1 << 12);
628 }
629
ata_id_has_flush_ext(const u16 * id)630 static inline bool ata_id_has_flush_ext(const u16 *id)
631 {
632 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
633 return false;
634 return id[ATA_ID_COMMAND_SET_2] & (1 << 13);
635 }
636
ata_id_logical_sector_size(const u16 * id)637 static inline u32 ata_id_logical_sector_size(const u16 *id)
638 {
639 /* T13/1699-D Revision 6a, Sep 6, 2008. Page 128.
640 * IDENTIFY DEVICE data, word 117-118.
641 * 0xd000 ignores bit 13 (logical:physical > 1)
642 */
643 if ((id[ATA_ID_SECTOR_SIZE] & 0xd000) == 0x5000)
644 return (((id[ATA_ID_LOGICAL_SECTOR_SIZE+1] << 16)
645 + id[ATA_ID_LOGICAL_SECTOR_SIZE]) * sizeof(u16)) ;
646 return ATA_SECT_SIZE;
647 }
648
ata_id_log2_per_physical_sector(const u16 * id)649 static inline u8 ata_id_log2_per_physical_sector(const u16 *id)
650 {
651 /* T13/1699-D Revision 6a, Sep 6, 2008. Page 128.
652 * IDENTIFY DEVICE data, word 106.
653 * 0xe000 ignores bit 12 (logical sector > 512 bytes)
654 */
655 if ((id[ATA_ID_SECTOR_SIZE] & 0xe000) == 0x6000)
656 return (id[ATA_ID_SECTOR_SIZE] & 0xf);
657 return 0;
658 }
659
660 /* Offset of logical sectors relative to physical sectors.
661 *
662 * If device has more than one logical sector per physical sector
663 * (aka 512 byte emulation), vendors might offset the "sector 0" address
664 * so sector 63 is "naturally aligned" - e.g. FAT partition table.
665 * This avoids Read/Mod/Write penalties when using FAT partition table
666 * and updating "well aligned" (FS perspective) physical sectors on every
667 * transaction.
668 */
ata_id_logical_sector_offset(const u16 * id,u8 log2_per_phys)669 static inline u16 ata_id_logical_sector_offset(const u16 *id,
670 u8 log2_per_phys)
671 {
672 u16 word_209 = id[209];
673
674 if ((log2_per_phys > 1) && (word_209 & 0xc000) == 0x4000) {
675 u16 first = word_209 & 0x3fff;
676 if (first > 0)
677 return (1 << log2_per_phys) - first;
678 }
679 return 0;
680 }
681
ata_id_has_lba48(const u16 * id)682 static inline bool ata_id_has_lba48(const u16 *id)
683 {
684 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
685 return false;
686 if (!ata_id_u64(id, ATA_ID_LBA_CAPACITY_2))
687 return false;
688 return id[ATA_ID_COMMAND_SET_2] & (1 << 10);
689 }
690
ata_id_hpa_enabled(const u16 * id)691 static inline bool ata_id_hpa_enabled(const u16 *id)
692 {
693 /* Yes children, word 83 valid bits cover word 82 data */
694 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
695 return false;
696 /* And 87 covers 85-87 */
697 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
698 return false;
699 /* Check command sets enabled as well as supported */
700 if ((id[ATA_ID_CFS_ENABLE_1] & (1 << 10)) == 0)
701 return false;
702 return id[ATA_ID_COMMAND_SET_1] & (1 << 10);
703 }
704
ata_id_has_wcache(const u16 * id)705 static inline bool ata_id_has_wcache(const u16 *id)
706 {
707 /* Yes children, word 83 valid bits cover word 82 data */
708 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
709 return false;
710 return id[ATA_ID_COMMAND_SET_1] & (1 << 5);
711 }
712
ata_id_has_pm(const u16 * id)713 static inline bool ata_id_has_pm(const u16 *id)
714 {
715 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
716 return false;
717 return id[ATA_ID_COMMAND_SET_1] & (1 << 3);
718 }
719
ata_id_rahead_enabled(const u16 * id)720 static inline bool ata_id_rahead_enabled(const u16 *id)
721 {
722 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
723 return false;
724 return id[ATA_ID_CFS_ENABLE_1] & (1 << 6);
725 }
726
ata_id_wcache_enabled(const u16 * id)727 static inline bool ata_id_wcache_enabled(const u16 *id)
728 {
729 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
730 return false;
731 return id[ATA_ID_CFS_ENABLE_1] & (1 << 5);
732 }
733
ata_id_has_read_log_dma_ext(const u16 * id)734 static inline bool ata_id_has_read_log_dma_ext(const u16 *id)
735 {
736 /* Word 86 must have bit 15 set */
737 if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
738 return false;
739
740 /* READ LOG DMA EXT support can be signaled either from word 119
741 * or from word 120. The format is the same for both words: Bit
742 * 15 must be cleared, bit 14 set and bit 3 set.
743 */
744 if ((id[ATA_ID_COMMAND_SET_3] & 0xC008) == 0x4008 ||
745 (id[ATA_ID_COMMAND_SET_4] & 0xC008) == 0x4008)
746 return true;
747
748 return false;
749 }
750
ata_id_has_sense_reporting(const u16 * id)751 static inline bool ata_id_has_sense_reporting(const u16 *id)
752 {
753 if (!(id[ATA_ID_CFS_ENABLE_2] & BIT(15)))
754 return false;
755 if ((id[ATA_ID_COMMAND_SET_3] & (BIT(15) | BIT(14))) != BIT(14))
756 return false;
757 return id[ATA_ID_COMMAND_SET_3] & BIT(6);
758 }
759
ata_id_sense_reporting_enabled(const u16 * id)760 static inline bool ata_id_sense_reporting_enabled(const u16 *id)
761 {
762 if (!ata_id_has_sense_reporting(id))
763 return false;
764 /* ata_id_has_sense_reporting() == true, word 86 must have bit 15 set */
765 if ((id[ATA_ID_COMMAND_SET_4] & (BIT(15) | BIT(14))) != BIT(14))
766 return false;
767 return id[ATA_ID_COMMAND_SET_4] & BIT(6);
768 }
769
770 /*
771 * Word: 206 - SCT Command Transport
772 * 15:12 - Vendor Specific
773 * 11:6 - Reserved
774 * 5 - SCT Command Transport Data Tables supported
775 * 4 - SCT Command Transport Features Control supported
776 * 3 - SCT Command Transport Error Recovery Control supported
777 * 2 - SCT Command Transport Write Same supported
778 * 1 - SCT Command Transport Long Sector Access supported
779 * 0 - SCT Command Transport supported
780 */
ata_id_sct_data_tables(const u16 * id)781 static inline bool ata_id_sct_data_tables(const u16 *id)
782 {
783 return id[ATA_ID_SCT_CMD_XPORT] & (1 << 5) ? true : false;
784 }
785
ata_id_sct_features_ctrl(const u16 * id)786 static inline bool ata_id_sct_features_ctrl(const u16 *id)
787 {
788 return id[ATA_ID_SCT_CMD_XPORT] & (1 << 4) ? true : false;
789 }
790
ata_id_sct_error_recovery_ctrl(const u16 * id)791 static inline bool ata_id_sct_error_recovery_ctrl(const u16 *id)
792 {
793 return id[ATA_ID_SCT_CMD_XPORT] & (1 << 3) ? true : false;
794 }
795
ata_id_sct_long_sector_access(const u16 * id)796 static inline bool ata_id_sct_long_sector_access(const u16 *id)
797 {
798 return id[ATA_ID_SCT_CMD_XPORT] & (1 << 1) ? true : false;
799 }
800
ata_id_sct_supported(const u16 * id)801 static inline bool ata_id_sct_supported(const u16 *id)
802 {
803 return id[ATA_ID_SCT_CMD_XPORT] & (1 << 0) ? true : false;
804 }
805
806 /**
807 * ata_id_major_version - get ATA level of drive
808 * @id: Identify data
809 *
810 * Caveats:
811 * ATA-1 considers identify optional
812 * ATA-2 introduces mandatory identify
813 * ATA-3 introduces word 80 and accurate reporting
814 *
815 * The practical impact of this is that ata_id_major_version cannot
816 * reliably report on drives below ATA3.
817 *
818 * Returns: major version of ATA drive level or %0 if unknown
819 */
ata_id_major_version(const u16 * id)820 static inline unsigned int ata_id_major_version(const u16 *id)
821 {
822 unsigned int mver;
823
824 if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
825 return 0;
826
827 for (mver = 14; mver >= 1; mver--)
828 if (id[ATA_ID_MAJOR_VER] & (1 << mver))
829 break;
830 return mver;
831 }
832
ata_id_is_sata(const u16 * id)833 static inline bool ata_id_is_sata(const u16 *id)
834 {
835 /*
836 * See if word 93 is 0 AND drive is at least ATA-5 compatible
837 * verifying that word 80 by casting it to a signed type --
838 * this trick allows us to filter out the reserved values of
839 * 0x0000 and 0xffff along with the earlier ATA revisions...
840 */
841 if (id[ATA_ID_HW_CONFIG] == 0 && (short)id[ATA_ID_MAJOR_VER] >= 0x0020)
842 return true;
843 return false;
844 }
845
ata_id_has_tpm(const u16 * id)846 static inline bool ata_id_has_tpm(const u16 *id)
847 {
848 /* The TPM bits are only valid on ATA8 */
849 if (ata_id_major_version(id) < 8)
850 return false;
851 if ((id[48] & 0xC000) != 0x4000)
852 return false;
853 return id[48] & (1 << 0);
854 }
855
ata_id_has_dword_io(const u16 * id)856 static inline bool ata_id_has_dword_io(const u16 *id)
857 {
858 /* ATA 8 reuses this flag for "trusted" computing */
859 if (ata_id_major_version(id) > 7)
860 return false;
861 return id[ATA_ID_DWORD_IO] & (1 << 0);
862 }
863
ata_id_has_trusted(const u16 * id)864 static inline bool ata_id_has_trusted(const u16 *id)
865 {
866 if (ata_id_major_version(id) <= 7)
867 return false;
868 return id[ATA_ID_TRUSTED] & (1 << 0);
869 }
870
ata_id_has_unload(const u16 * id)871 static inline bool ata_id_has_unload(const u16 *id)
872 {
873 if (ata_id_major_version(id) >= 7 &&
874 (id[ATA_ID_CFSSE] & 0xC000) == 0x4000 &&
875 id[ATA_ID_CFSSE] & (1 << 13))
876 return true;
877 return false;
878 }
879
ata_id_has_wwn(const u16 * id)880 static inline bool ata_id_has_wwn(const u16 *id)
881 {
882 return (id[ATA_ID_CSF_DEFAULT] & 0xC100) == 0x4100;
883 }
884
ata_id_form_factor(const u16 * id)885 static inline int ata_id_form_factor(const u16 *id)
886 {
887 u16 val = id[168];
888
889 if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
890 return 0;
891
892 val &= 0xf;
893
894 if (val > 5)
895 return 0;
896
897 return val;
898 }
899
ata_id_rotation_rate(const u16 * id)900 static inline int ata_id_rotation_rate(const u16 *id)
901 {
902 u16 val = id[217];
903
904 if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
905 return 0;
906
907 if (val > 1 && val < 0x401)
908 return 0;
909
910 return val;
911 }
912
ata_id_has_ncq_send_and_recv(const u16 * id)913 static inline bool ata_id_has_ncq_send_and_recv(const u16 *id)
914 {
915 return id[ATA_ID_SATA_CAPABILITY_2] & BIT(6);
916 }
917
ata_id_has_ncq_non_data(const u16 * id)918 static inline bool ata_id_has_ncq_non_data(const u16 *id)
919 {
920 return id[ATA_ID_SATA_CAPABILITY_2] & BIT(5);
921 }
922
ata_id_has_ncq_prio(const u16 * id)923 static inline bool ata_id_has_ncq_prio(const u16 *id)
924 {
925 return id[ATA_ID_SATA_CAPABILITY] & BIT(12);
926 }
927
ata_id_has_trim(const u16 * id)928 static inline bool ata_id_has_trim(const u16 *id)
929 {
930 if (ata_id_major_version(id) >= 7 &&
931 (id[ATA_ID_DATA_SET_MGMT] & 1))
932 return true;
933 return false;
934 }
935
ata_id_dsm_max_pages(const u16 * id)936 static inline u16 ata_id_dsm_max_pages(const u16 *id)
937 {
938 /*
939 * IDENTIFY DEVICE word 105: MAX PAGES PER DSM COMMAND. Maximum number
940 * of 512-byte pages of LBA Range Entries the device accepts in a
941 * single DATA SET MANAGEMENT command. Zero means the device does not
942 * specify a limit. The field is reserved unless TRIM is supported, so
943 * callers must gate on ata_id_has_trim().
944 */
945 return id[ATA_ID_MAX_PAGES_PER_DSM];
946 }
947
ata_id_has_zero_after_trim(const u16 * id)948 static inline bool ata_id_has_zero_after_trim(const u16 *id)
949 {
950 /* DSM supported, deterministic read, and read zero after trim set */
951 if (ata_id_has_trim(id) &&
952 (id[ATA_ID_ADDITIONAL_SUPP] & 0x4020) == 0x4020)
953 return true;
954
955 return false;
956 }
957
ata_id_current_chs_valid(const u16 * id)958 static inline bool ata_id_current_chs_valid(const u16 *id)
959 {
960 /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
961 has not been issued to the device then the values of
962 id[ATA_ID_CUR_CYLS] to id[ATA_ID_CUR_SECTORS] are vendor specific. */
963 return (id[ATA_ID_FIELD_VALID] & 1) && /* Current translation valid */
964 id[ATA_ID_CUR_CYLS] && /* cylinders in current translation */
965 id[ATA_ID_CUR_HEADS] && /* heads in current translation */
966 id[ATA_ID_CUR_HEADS] <= 16 &&
967 id[ATA_ID_CUR_SECTORS]; /* sectors in current translation */
968 }
969
ata_id_is_cfa(const u16 * id)970 static inline bool ata_id_is_cfa(const u16 *id)
971 {
972 if ((id[ATA_ID_CONFIG] == 0x848A) || /* Traditional CF */
973 (id[ATA_ID_CONFIG] == 0x844A)) /* Delkin Devices CF */
974 return true;
975 /*
976 * CF specs don't require specific value in the word 0 anymore and yet
977 * they forbid to report the ATA version in the word 80 and require the
978 * CFA feature set support to be indicated in the word 83 in this case.
979 * Unfortunately, some cards only follow either of this requirements,
980 * and while those that don't indicate CFA feature support need some
981 * sort of quirk list, it seems impractical for the ones that do...
982 */
983 return (id[ATA_ID_COMMAND_SET_2] & 0xC004) == 0x4004;
984 }
985
ata_id_is_ssd(const u16 * id)986 static inline bool ata_id_is_ssd(const u16 *id)
987 {
988 return id[ATA_ID_ROT_SPEED] == 0x01;
989 }
990
ata_id_zoned_cap(const u16 * id)991 static inline u8 ata_id_zoned_cap(const u16 *id)
992 {
993 return (id[ATA_ID_ADDITIONAL_SUPP] & 0x3);
994 }
995
ata_id_pio_need_iordy(const u16 * id,const u8 pio)996 static inline bool ata_id_pio_need_iordy(const u16 *id, const u8 pio)
997 {
998 /* CF spec. r4.1 Table 22 says no IORDY on PIO5 and PIO6. */
999 if (pio > 4 && ata_id_is_cfa(id))
1000 return false;
1001 /* For PIO3 and higher it is mandatory. */
1002 if (pio > 2)
1003 return true;
1004 /* Turn it on when possible. */
1005 return ata_id_has_iordy(id);
1006 }
1007
ata_drive_40wire(const u16 * dev_id)1008 static inline bool ata_drive_40wire(const u16 *dev_id)
1009 {
1010 if (ata_id_is_sata(dev_id))
1011 return false; /* SATA */
1012 if ((dev_id[ATA_ID_HW_CONFIG] & 0xE000) == 0x6000)
1013 return false; /* 80 wire */
1014 return true;
1015 }
1016
ata_drive_40wire_relaxed(const u16 * dev_id)1017 static inline bool ata_drive_40wire_relaxed(const u16 *dev_id)
1018 {
1019 if ((dev_id[ATA_ID_HW_CONFIG] & 0x2000) == 0x2000)
1020 return false; /* 80 wire */
1021 return true;
1022 }
1023
atapi_cdb_len(const u16 * dev_id)1024 static inline int atapi_cdb_len(const u16 *dev_id)
1025 {
1026 u16 tmp = dev_id[ATA_ID_CONFIG] & 0x3;
1027 switch (tmp) {
1028 case 0: return 12;
1029 case 1: return 16;
1030 default: return -1;
1031 }
1032 }
1033
atapi_command_packet_set(const u16 * dev_id)1034 static inline int atapi_command_packet_set(const u16 *dev_id)
1035 {
1036 return (dev_id[ATA_ID_CONFIG] >> 8) & 0x1f;
1037 }
1038
atapi_id_dmadir(const u16 * dev_id)1039 static inline bool atapi_id_dmadir(const u16 *dev_id)
1040 {
1041 return ata_id_major_version(dev_id) >= 7 && (dev_id[62] & 0x8000);
1042 }
1043
ata_ok(u8 status)1044 static inline bool ata_ok(u8 status)
1045 {
1046 return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
1047 == ATA_DRDY);
1048 }
1049
lba_28_ok(u64 block,u32 n_block)1050 static inline bool lba_28_ok(u64 block, u32 n_block)
1051 {
1052 /* check the ending block number: must be LESS THAN 0x0fffffff */
1053 return ((block + n_block) < ((1 << 28) - 1)) && (n_block <= ATA_MAX_SECTORS);
1054 }
1055
lba_48_ok(u64 block,u32 n_block)1056 static inline bool lba_48_ok(u64 block, u32 n_block)
1057 {
1058 /* check the ending block number */
1059 return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= ATA_MAX_SECTORS_LBA48);
1060 }
1061
1062 #define sata_pmp_gscr_vendor(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
1063 #define sata_pmp_gscr_devid(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
1064 #define sata_pmp_gscr_rev(gscr) (((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
1065 #define sata_pmp_gscr_ports(gscr) ((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)
1066
1067 #endif /* __LINUX_ATA_H__ */
1068