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