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