1
2 /*
3 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
4 * Copyright 2003-2004 Jeff Garzik
5 *
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2, or (at your option)
10 * any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; see the file COPYING. If not, write to
19 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
20 *
21 *
22 * libata documentation is available via 'make {ps|pdf}docs',
23 * as Documentation/DocBook/libata.*
24 *
25 * Hardware documentation available from http://www.t13.org/
26 *
27 */
28
29 #ifndef __LINUX_ATA_H__
30 #define __LINUX_ATA_H__
31
32 #include <linux/kernel.h>
33 #include <linux/string.h>
34 #include <linux/types.h>
35 #include <asm/byteorder.h>
36
37 /* defines only for the constants which don't work well as enums */
38 #define ATA_DMA_BOUNDARY 0xffffUL
39 #define ATA_DMA_MASK 0xffffffffULL
40
41 enum {
42 /* various global constants */
43 ATA_MAX_DEVICES = 2, /* per bus/port */
44 ATA_MAX_PRD = 256, /* we could make these 256/256 */
45 ATA_SECT_SIZE = 512,
46 ATA_MAX_SECTORS_128 = 128,
47 ATA_MAX_SECTORS = 256,
48 ATA_MAX_SECTORS_1024 = 1024,
49 ATA_MAX_SECTORS_LBA48 = 65535,/* avoid count to be 0000h */
50 ATA_MAX_SECTORS_TAPE = 65535,
51 ATA_MAX_TRIM_RNUM = 64, /* 512-byte payload / (6-byte LBA + 2-byte range per entry) */
52
53 ATA_ID_WORDS = 256,
54 ATA_ID_CONFIG = 0,
55 ATA_ID_CYLS = 1,
56 ATA_ID_HEADS = 3,
57 ATA_ID_SECTORS = 6,
58 ATA_ID_SERNO = 10,
59 ATA_ID_BUF_SIZE = 21,
60 ATA_ID_FW_REV = 23,
61 ATA_ID_PROD = 27,
62 ATA_ID_MAX_MULTSECT = 47,
63 ATA_ID_DWORD_IO = 48,
64 ATA_ID_CAPABILITY = 49,
65 ATA_ID_OLD_PIO_MODES = 51,
66 ATA_ID_OLD_DMA_MODES = 52,
67 ATA_ID_FIELD_VALID = 53,
68 ATA_ID_CUR_CYLS = 54,
69 ATA_ID_CUR_HEADS = 55,
70 ATA_ID_CUR_SECTORS = 56,
71 ATA_ID_MULTSECT = 59,
72 ATA_ID_LBA_CAPACITY = 60,
73 ATA_ID_SWDMA_MODES = 62,
74 ATA_ID_MWDMA_MODES = 63,
75 ATA_ID_PIO_MODES = 64,
76 ATA_ID_EIDE_DMA_MIN = 65,
77 ATA_ID_EIDE_DMA_TIME = 66,
78 ATA_ID_EIDE_PIO = 67,
79 ATA_ID_EIDE_PIO_IORDY = 68,
80 ATA_ID_ADDITIONAL_SUPP = 69,
81 ATA_ID_QUEUE_DEPTH = 75,
82 ATA_ID_SATA_CAPABILITY = 76,
83 ATA_ID_SATA_CAPABILITY_2 = 77,
84 ATA_ID_FEATURE_SUPP = 78,
85 ATA_ID_MAJOR_VER = 80,
86 ATA_ID_COMMAND_SET_1 = 82,
87 ATA_ID_COMMAND_SET_2 = 83,
88 ATA_ID_CFSSE = 84,
89 ATA_ID_CFS_ENABLE_1 = 85,
90 ATA_ID_CFS_ENABLE_2 = 86,
91 ATA_ID_CSF_DEFAULT = 87,
92 ATA_ID_UDMA_MODES = 88,
93 ATA_ID_HW_CONFIG = 93,
94 ATA_ID_SPG = 98,
95 ATA_ID_LBA_CAPACITY_2 = 100,
96 ATA_ID_SECTOR_SIZE = 106,
97 ATA_ID_WWN = 108,
98 ATA_ID_LOGICAL_SECTOR_SIZE = 117, /* and 118 */
99 ATA_ID_COMMAND_SET_3 = 119,
100 ATA_ID_COMMAND_SET_4 = 120,
101 ATA_ID_LAST_LUN = 126,
102 ATA_ID_DLF = 128,
103 ATA_ID_CSFO = 129,
104 ATA_ID_CFA_POWER = 160,
105 ATA_ID_CFA_KEY_MGMT = 162,
106 ATA_ID_CFA_MODES = 163,
107 ATA_ID_DATA_SET_MGMT = 169,
108 ATA_ID_SCT_CMD_XPORT = 206,
109 ATA_ID_ROT_SPEED = 217,
110 ATA_ID_PIO4 = (1 << 1),
111
112 ATA_ID_SERNO_LEN = 20,
113 ATA_ID_FW_REV_LEN = 8,
114 ATA_ID_PROD_LEN = 40,
115 ATA_ID_WWN_LEN = 8,
116
117 ATA_PCI_CTL_OFS = 2,
118
119 ATA_PIO0 = (1 << 0),
120 ATA_PIO1 = ATA_PIO0 | (1 << 1),
121 ATA_PIO2 = ATA_PIO1 | (1 << 2),
122 ATA_PIO3 = ATA_PIO2 | (1 << 3),
123 ATA_PIO4 = ATA_PIO3 | (1 << 4),
124 ATA_PIO5 = ATA_PIO4 | (1 << 5),
125 ATA_PIO6 = ATA_PIO5 | (1 << 6),
126
127 ATA_PIO4_ONLY = (1 << 4),
128
129 ATA_SWDMA0 = (1 << 0),
130 ATA_SWDMA1 = ATA_SWDMA0 | (1 << 1),
131 ATA_SWDMA2 = ATA_SWDMA1 | (1 << 2),
132
133 ATA_SWDMA2_ONLY = (1 << 2),
134
135 ATA_MWDMA0 = (1 << 0),
136 ATA_MWDMA1 = ATA_MWDMA0 | (1 << 1),
137 ATA_MWDMA2 = ATA_MWDMA1 | (1 << 2),
138 ATA_MWDMA3 = ATA_MWDMA2 | (1 << 3),
139 ATA_MWDMA4 = ATA_MWDMA3 | (1 << 4),
140
141 ATA_MWDMA12_ONLY = (1 << 1) | (1 << 2),
142 ATA_MWDMA2_ONLY = (1 << 2),
143
144 ATA_UDMA0 = (1 << 0),
145 ATA_UDMA1 = ATA_UDMA0 | (1 << 1),
146 ATA_UDMA2 = ATA_UDMA1 | (1 << 2),
147 ATA_UDMA3 = ATA_UDMA2 | (1 << 3),
148 ATA_UDMA4 = ATA_UDMA3 | (1 << 4),
149 ATA_UDMA5 = ATA_UDMA4 | (1 << 5),
150 ATA_UDMA6 = ATA_UDMA5 | (1 << 6),
151 ATA_UDMA7 = ATA_UDMA6 | (1 << 7),
152 /* ATA_UDMA7 is just for completeness... doesn't exist (yet?). */
153
154 ATA_UDMA24_ONLY = (1 << 2) | (1 << 4),
155
156 ATA_UDMA_MASK_40C = ATA_UDMA2, /* udma0-2 */
157
158 /* DMA-related */
159 ATA_PRD_SZ = 8,
160 ATA_PRD_TBL_SZ = (ATA_MAX_PRD * ATA_PRD_SZ),
161 ATA_PRD_EOT = (1 << 31), /* end-of-table flag */
162
163 ATA_DMA_TABLE_OFS = 4,
164 ATA_DMA_STATUS = 2,
165 ATA_DMA_CMD = 0,
166 ATA_DMA_WR = (1 << 3),
167 ATA_DMA_START = (1 << 0),
168 ATA_DMA_INTR = (1 << 2),
169 ATA_DMA_ERR = (1 << 1),
170 ATA_DMA_ACTIVE = (1 << 0),
171
172 /* bits in ATA command block registers */
173 ATA_HOB = (1 << 7), /* LBA48 selector */
174 ATA_NIEN = (1 << 1), /* disable-irq flag */
175 ATA_LBA = (1 << 6), /* LBA28 selector */
176 ATA_DEV1 = (1 << 4), /* Select Device 1 (slave) */
177 ATA_DEVICE_OBS = (1 << 7) | (1 << 5), /* obs bits in dev reg */
178 ATA_DEVCTL_OBS = (1 << 3), /* obsolete bit in devctl reg */
179 ATA_BUSY = (1 << 7), /* BSY status bit */
180 ATA_DRDY = (1 << 6), /* device ready */
181 ATA_DF = (1 << 5), /* device fault */
182 ATA_DSC = (1 << 4), /* drive seek complete */
183 ATA_DRQ = (1 << 3), /* data request i/o */
184 ATA_CORR = (1 << 2), /* corrected data error */
185 ATA_SENSE = (1 << 1), /* sense code available */
186 ATA_ERR = (1 << 0), /* have an error */
187 ATA_SRST = (1 << 2), /* software reset */
188 ATA_ICRC = (1 << 7), /* interface CRC error */
189 ATA_BBK = ATA_ICRC, /* pre-EIDE: block marked bad */
190 ATA_UNC = (1 << 6), /* uncorrectable media error */
191 ATA_MC = (1 << 5), /* media changed */
192 ATA_IDNF = (1 << 4), /* ID not found */
193 ATA_MCR = (1 << 3), /* media change requested */
194 ATA_ABORTED = (1 << 2), /* command aborted */
195 ATA_TRK0NF = (1 << 1), /* track 0 not found */
196 ATA_AMNF = (1 << 0), /* address mark not found */
197 ATAPI_LFS = 0xF0, /* last failed sense */
198 ATAPI_EOM = ATA_TRK0NF, /* end of media */
199 ATAPI_ILI = ATA_AMNF, /* illegal length indication */
200 ATAPI_IO = (1 << 1),
201 ATAPI_COD = (1 << 0),
202
203 /* ATA command block registers */
204 ATA_REG_DATA = 0x00,
205 ATA_REG_ERR = 0x01,
206 ATA_REG_NSECT = 0x02,
207 ATA_REG_LBAL = 0x03,
208 ATA_REG_LBAM = 0x04,
209 ATA_REG_LBAH = 0x05,
210 ATA_REG_DEVICE = 0x06,
211 ATA_REG_STATUS = 0x07,
212
213 ATA_REG_FEATURE = ATA_REG_ERR, /* and their aliases */
214 ATA_REG_CMD = ATA_REG_STATUS,
215 ATA_REG_BYTEL = ATA_REG_LBAM,
216 ATA_REG_BYTEH = ATA_REG_LBAH,
217 ATA_REG_DEVSEL = ATA_REG_DEVICE,
218 ATA_REG_IRQ = ATA_REG_NSECT,
219
220 /* ATA device commands */
221 ATA_CMD_DEV_RESET = 0x08, /* ATAPI device reset */
222 ATA_CMD_CHK_POWER = 0xE5, /* check power mode */
223 ATA_CMD_STANDBY = 0xE2, /* place in standby power mode */
224 ATA_CMD_IDLE = 0xE3, /* place in idle power mode */
225 ATA_CMD_EDD = 0x90, /* execute device diagnostic */
226 ATA_CMD_DOWNLOAD_MICRO = 0x92,
227 ATA_CMD_DOWNLOAD_MICRO_DMA = 0x93,
228 ATA_CMD_NOP = 0x00,
229 ATA_CMD_FLUSH = 0xE7,
230 ATA_CMD_FLUSH_EXT = 0xEA,
231 ATA_CMD_ID_ATA = 0xEC,
232 ATA_CMD_ID_ATAPI = 0xA1,
233 ATA_CMD_SERVICE = 0xA2,
234 ATA_CMD_READ = 0xC8,
235 ATA_CMD_READ_EXT = 0x25,
236 ATA_CMD_READ_QUEUED = 0x26,
237 ATA_CMD_READ_STREAM_EXT = 0x2B,
238 ATA_CMD_READ_STREAM_DMA_EXT = 0x2A,
239 ATA_CMD_WRITE = 0xCA,
240 ATA_CMD_WRITE_EXT = 0x35,
241 ATA_CMD_WRITE_QUEUED = 0x36,
242 ATA_CMD_WRITE_STREAM_EXT = 0x3B,
243 ATA_CMD_WRITE_STREAM_DMA_EXT = 0x3A,
244 ATA_CMD_WRITE_FUA_EXT = 0x3D,
245 ATA_CMD_WRITE_QUEUED_FUA_EXT = 0x3E,
246 ATA_CMD_FPDMA_READ = 0x60,
247 ATA_CMD_FPDMA_WRITE = 0x61,
248 ATA_CMD_NCQ_NON_DATA = 0x63,
249 ATA_CMD_FPDMA_SEND = 0x64,
250 ATA_CMD_FPDMA_RECV = 0x65,
251 ATA_CMD_PIO_READ = 0x20,
252 ATA_CMD_PIO_READ_EXT = 0x24,
253 ATA_CMD_PIO_WRITE = 0x30,
254 ATA_CMD_PIO_WRITE_EXT = 0x34,
255 ATA_CMD_READ_MULTI = 0xC4,
256 ATA_CMD_READ_MULTI_EXT = 0x29,
257 ATA_CMD_WRITE_MULTI = 0xC5,
258 ATA_CMD_WRITE_MULTI_EXT = 0x39,
259 ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
260 ATA_CMD_SET_FEATURES = 0xEF,
261 ATA_CMD_SET_MULTI = 0xC6,
262 ATA_CMD_PACKET = 0xA0,
263 ATA_CMD_VERIFY = 0x40,
264 ATA_CMD_VERIFY_EXT = 0x42,
265 ATA_CMD_WRITE_UNCORR_EXT = 0x45,
266 ATA_CMD_STANDBYNOW1 = 0xE0,
267 ATA_CMD_IDLEIMMEDIATE = 0xE1,
268 ATA_CMD_SLEEP = 0xE6,
269 ATA_CMD_INIT_DEV_PARAMS = 0x91,
270 ATA_CMD_READ_NATIVE_MAX = 0xF8,
271 ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
272 ATA_CMD_SET_MAX = 0xF9,
273 ATA_CMD_SET_MAX_EXT = 0x37,
274 ATA_CMD_READ_LOG_EXT = 0x2F,
275 ATA_CMD_WRITE_LOG_EXT = 0x3F,
276 ATA_CMD_READ_LOG_DMA_EXT = 0x47,
277 ATA_CMD_WRITE_LOG_DMA_EXT = 0x57,
278 ATA_CMD_TRUSTED_NONDATA = 0x5B,
279 ATA_CMD_TRUSTED_RCV = 0x5C,
280 ATA_CMD_TRUSTED_RCV_DMA = 0x5D,
281 ATA_CMD_TRUSTED_SND = 0x5E,
282 ATA_CMD_TRUSTED_SND_DMA = 0x5F,
283 ATA_CMD_PMP_READ = 0xE4,
284 ATA_CMD_PMP_READ_DMA = 0xE9,
285 ATA_CMD_PMP_WRITE = 0xE8,
286 ATA_CMD_PMP_WRITE_DMA = 0xEB,
287 ATA_CMD_CONF_OVERLAY = 0xB1,
288 ATA_CMD_SEC_SET_PASS = 0xF1,
289 ATA_CMD_SEC_UNLOCK = 0xF2,
290 ATA_CMD_SEC_ERASE_PREP = 0xF3,
291 ATA_CMD_SEC_ERASE_UNIT = 0xF4,
292 ATA_CMD_SEC_FREEZE_LOCK = 0xF5,
293 ATA_CMD_SEC_DISABLE_PASS = 0xF6,
294 ATA_CMD_CONFIG_STREAM = 0x51,
295 ATA_CMD_SMART = 0xB0,
296 ATA_CMD_MEDIA_LOCK = 0xDE,
297 ATA_CMD_MEDIA_UNLOCK = 0xDF,
298 ATA_CMD_DSM = 0x06,
299 ATA_CMD_CHK_MED_CRD_TYP = 0xD1,
300 ATA_CMD_CFA_REQ_EXT_ERR = 0x03,
301 ATA_CMD_CFA_WRITE_NE = 0x38,
302 ATA_CMD_CFA_TRANS_SECT = 0x87,
303 ATA_CMD_CFA_ERASE = 0xC0,
304 ATA_CMD_CFA_WRITE_MULT_NE = 0xCD,
305 ATA_CMD_REQ_SENSE_DATA = 0x0B,
306 ATA_CMD_SANITIZE_DEVICE = 0xB4,
307 ATA_CMD_ZAC_MGMT_IN = 0x4A,
308 ATA_CMD_ZAC_MGMT_OUT = 0x9F,
309
310 /* marked obsolete in the ATA/ATAPI-7 spec */
311 ATA_CMD_RESTORE = 0x10,
312
313 /* Subcmds for ATA_CMD_FPDMA_RECV */
314 ATA_SUBCMD_FPDMA_RECV_RD_LOG_DMA_EXT = 0x01,
315 ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN = 0x02,
316
317 /* Subcmds for ATA_CMD_FPDMA_SEND */
318 ATA_SUBCMD_FPDMA_SEND_DSM = 0x00,
319 ATA_SUBCMD_FPDMA_SEND_WR_LOG_DMA_EXT = 0x02,
320
321 /* Subcmds for ATA_CMD_NCQ_NON_DATA */
322 ATA_SUBCMD_NCQ_NON_DATA_ABORT_QUEUE = 0x00,
323 ATA_SUBCMD_NCQ_NON_DATA_SET_FEATURES = 0x05,
324 ATA_SUBCMD_NCQ_NON_DATA_ZERO_EXT = 0x06,
325 ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT = 0x07,
326
327 /* Subcmds for ATA_CMD_ZAC_MGMT_IN */
328 ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES = 0x00,
329
330 /* Subcmds for ATA_CMD_ZAC_MGMT_OUT */
331 ATA_SUBCMD_ZAC_MGMT_OUT_CLOSE_ZONE = 0x01,
332 ATA_SUBCMD_ZAC_MGMT_OUT_FINISH_ZONE = 0x02,
333 ATA_SUBCMD_ZAC_MGMT_OUT_OPEN_ZONE = 0x03,
334 ATA_SUBCMD_ZAC_MGMT_OUT_RESET_WRITE_POINTER = 0x04,
335
336 /* READ_LOG_EXT pages */
337 ATA_LOG_DIRECTORY = 0x0,
338 ATA_LOG_SATA_NCQ = 0x10,
339 ATA_LOG_NCQ_NON_DATA = 0x12,
340 ATA_LOG_NCQ_SEND_RECV = 0x13,
341 ATA_LOG_SATA_ID_DEV_DATA = 0x30,
342 ATA_LOG_SATA_SETTINGS = 0x08,
343 ATA_LOG_ZONED_INFORMATION = 0x09,
344 ATA_LOG_DEVSLP_OFFSET = 0x30,
345 ATA_LOG_DEVSLP_SIZE = 0x08,
346 ATA_LOG_DEVSLP_MDAT = 0x00,
347 ATA_LOG_DEVSLP_MDAT_MASK = 0x1F,
348 ATA_LOG_DEVSLP_DETO = 0x01,
349 ATA_LOG_DEVSLP_VALID = 0x07,
350 ATA_LOG_DEVSLP_VALID_MASK = 0x80,
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 /* 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
438 /* feature values for SET_MAX */
439 ATA_SET_MAX_ADDR = 0x00,
440 ATA_SET_MAX_PASSWD = 0x01,
441 ATA_SET_MAX_LOCK = 0x02,
442 ATA_SET_MAX_UNLOCK = 0x03,
443 ATA_SET_MAX_FREEZE_LOCK = 0x04,
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_has_atapi_AN(id) \
568 ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
569 ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
570 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 5)))
571 #define ata_id_has_fpdma_aa(id) \
572 ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
573 ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
574 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 2)))
575 #define ata_id_iordy_disable(id) ((id)[ATA_ID_CAPABILITY] & (1 << 10))
576 #define ata_id_has_iordy(id) ((id)[ATA_ID_CAPABILITY] & (1 << 11))
577 #define ata_id_u32(id,n) \
578 (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
579 #define ata_id_u64(id,n) \
580 ( ((u64) (id)[(n) + 3] << 48) | \
581 ((u64) (id)[(n) + 2] << 32) | \
582 ((u64) (id)[(n) + 1] << 16) | \
583 ((u64) (id)[(n) + 0]) )
584
585 #define ata_id_cdb_intr(id) (((id)[ATA_ID_CONFIG] & 0x60) == 0x20)
586 #define ata_id_has_da(id) ((id)[ATA_ID_SATA_CAPABILITY_2] & (1 << 4))
587 #define ata_id_has_devslp(id) ((id)[ATA_ID_FEATURE_SUPP] & (1 << 8))
588 #define ata_id_has_ncq_autosense(id) \
589 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 7))
590
ata_id_has_hipm(const u16 * id)591 static inline bool ata_id_has_hipm(const u16 *id)
592 {
593 u16 val = id[ATA_ID_SATA_CAPABILITY];
594
595 if (val == 0 || val == 0xffff)
596 return false;
597
598 return val & (1 << 9);
599 }
600
ata_id_has_dipm(const u16 * id)601 static inline bool ata_id_has_dipm(const u16 *id)
602 {
603 u16 val = id[ATA_ID_FEATURE_SUPP];
604
605 if (val == 0 || val == 0xffff)
606 return false;
607
608 return val & (1 << 3);
609 }
610
611
ata_id_has_fua(const u16 * id)612 static inline bool ata_id_has_fua(const u16 *id)
613 {
614 if ((id[ATA_ID_CFSSE] & 0xC000) != 0x4000)
615 return false;
616 return id[ATA_ID_CFSSE] & (1 << 6);
617 }
618
ata_id_has_flush(const u16 * id)619 static inline bool ata_id_has_flush(const u16 *id)
620 {
621 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
622 return false;
623 return id[ATA_ID_COMMAND_SET_2] & (1 << 12);
624 }
625
ata_id_flush_enabled(const u16 * id)626 static inline bool ata_id_flush_enabled(const u16 *id)
627 {
628 if (ata_id_has_flush(id) == 0)
629 return false;
630 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
631 return false;
632 return id[ATA_ID_CFS_ENABLE_2] & (1 << 12);
633 }
634
ata_id_has_flush_ext(const u16 * id)635 static inline bool ata_id_has_flush_ext(const u16 *id)
636 {
637 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
638 return false;
639 return id[ATA_ID_COMMAND_SET_2] & (1 << 13);
640 }
641
ata_id_flush_ext_enabled(const u16 * id)642 static inline bool ata_id_flush_ext_enabled(const u16 *id)
643 {
644 if (ata_id_has_flush_ext(id) == 0)
645 return false;
646 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
647 return false;
648 /*
649 * some Maxtor disks have bit 13 defined incorrectly
650 * so check bit 10 too
651 */
652 return (id[ATA_ID_CFS_ENABLE_2] & 0x2400) == 0x2400;
653 }
654
ata_id_logical_sector_size(const u16 * id)655 static inline u32 ata_id_logical_sector_size(const u16 *id)
656 {
657 /* T13/1699-D Revision 6a, Sep 6, 2008. Page 128.
658 * IDENTIFY DEVICE data, word 117-118.
659 * 0xd000 ignores bit 13 (logical:physical > 1)
660 */
661 if ((id[ATA_ID_SECTOR_SIZE] & 0xd000) == 0x5000)
662 return (((id[ATA_ID_LOGICAL_SECTOR_SIZE+1] << 16)
663 + id[ATA_ID_LOGICAL_SECTOR_SIZE]) * sizeof(u16)) ;
664 return ATA_SECT_SIZE;
665 }
666
ata_id_log2_per_physical_sector(const u16 * id)667 static inline u8 ata_id_log2_per_physical_sector(const u16 *id)
668 {
669 /* T13/1699-D Revision 6a, Sep 6, 2008. Page 128.
670 * IDENTIFY DEVICE data, word 106.
671 * 0xe000 ignores bit 12 (logical sector > 512 bytes)
672 */
673 if ((id[ATA_ID_SECTOR_SIZE] & 0xe000) == 0x6000)
674 return (id[ATA_ID_SECTOR_SIZE] & 0xf);
675 return 0;
676 }
677
678 /* Offset of logical sectors relative to physical sectors.
679 *
680 * If device has more than one logical sector per physical sector
681 * (aka 512 byte emulation), vendors might offset the "sector 0" address
682 * so sector 63 is "naturally aligned" - e.g. FAT partition table.
683 * This avoids Read/Mod/Write penalties when using FAT partition table
684 * and updating "well aligned" (FS perspective) physical sectors on every
685 * transaction.
686 */
ata_id_logical_sector_offset(const u16 * id,u8 log2_per_phys)687 static inline u16 ata_id_logical_sector_offset(const u16 *id,
688 u8 log2_per_phys)
689 {
690 u16 word_209 = id[209];
691
692 if ((log2_per_phys > 1) && (word_209 & 0xc000) == 0x4000) {
693 u16 first = word_209 & 0x3fff;
694 if (first > 0)
695 return (1 << log2_per_phys) - first;
696 }
697 return 0;
698 }
699
ata_id_has_lba48(const u16 * id)700 static inline bool ata_id_has_lba48(const u16 *id)
701 {
702 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
703 return false;
704 if (!ata_id_u64(id, ATA_ID_LBA_CAPACITY_2))
705 return false;
706 return id[ATA_ID_COMMAND_SET_2] & (1 << 10);
707 }
708
ata_id_lba48_enabled(const u16 * id)709 static inline bool ata_id_lba48_enabled(const u16 *id)
710 {
711 if (ata_id_has_lba48(id) == 0)
712 return false;
713 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
714 return false;
715 return id[ATA_ID_CFS_ENABLE_2] & (1 << 10);
716 }
717
ata_id_hpa_enabled(const u16 * id)718 static inline bool ata_id_hpa_enabled(const u16 *id)
719 {
720 /* Yes children, word 83 valid bits cover word 82 data */
721 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
722 return false;
723 /* And 87 covers 85-87 */
724 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
725 return false;
726 /* Check command sets enabled as well as supported */
727 if ((id[ATA_ID_CFS_ENABLE_1] & (1 << 10)) == 0)
728 return false;
729 return id[ATA_ID_COMMAND_SET_1] & (1 << 10);
730 }
731
ata_id_has_wcache(const u16 * id)732 static inline bool ata_id_has_wcache(const u16 *id)
733 {
734 /* Yes children, word 83 valid bits cover word 82 data */
735 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
736 return false;
737 return id[ATA_ID_COMMAND_SET_1] & (1 << 5);
738 }
739
ata_id_has_pm(const u16 * id)740 static inline bool ata_id_has_pm(const u16 *id)
741 {
742 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
743 return false;
744 return id[ATA_ID_COMMAND_SET_1] & (1 << 3);
745 }
746
ata_id_rahead_enabled(const u16 * id)747 static inline bool ata_id_rahead_enabled(const u16 *id)
748 {
749 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
750 return false;
751 return id[ATA_ID_CFS_ENABLE_1] & (1 << 6);
752 }
753
ata_id_wcache_enabled(const u16 * id)754 static inline bool ata_id_wcache_enabled(const u16 *id)
755 {
756 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
757 return false;
758 return id[ATA_ID_CFS_ENABLE_1] & (1 << 5);
759 }
760
ata_id_has_read_log_dma_ext(const u16 * id)761 static inline bool ata_id_has_read_log_dma_ext(const u16 *id)
762 {
763 /* Word 86 must have bit 15 set */
764 if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
765 return false;
766
767 /* READ LOG DMA EXT support can be signaled either from word 119
768 * or from word 120. The format is the same for both words: Bit
769 * 15 must be cleared, bit 14 set and bit 3 set.
770 */
771 if ((id[ATA_ID_COMMAND_SET_3] & 0xC008) == 0x4008 ||
772 (id[ATA_ID_COMMAND_SET_4] & 0xC008) == 0x4008)
773 return true;
774
775 return false;
776 }
777
ata_id_has_sense_reporting(const u16 * id)778 static inline bool ata_id_has_sense_reporting(const u16 *id)
779 {
780 if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
781 return false;
782 return id[ATA_ID_COMMAND_SET_3] & (1 << 6);
783 }
784
ata_id_sense_reporting_enabled(const u16 * id)785 static inline bool ata_id_sense_reporting_enabled(const u16 *id)
786 {
787 if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
788 return false;
789 return id[ATA_ID_COMMAND_SET_4] & (1 << 6);
790 }
791
792 /**
793 *
794 * Word: 206 - SCT Command Transport
795 * 15:12 - Vendor Specific
796 * 11:6 - Reserved
797 * 5 - SCT Command Transport Data Tables supported
798 * 4 - SCT Command Transport Features Control supported
799 * 3 - SCT Command Transport Error Recovery Control supported
800 * 2 - SCT Command Transport Write Same supported
801 * 1 - SCT Command Transport Long Sector Access supported
802 * 0 - SCT Command Transport supported
803 */
ata_id_sct_data_tables(const u16 * id)804 static inline bool ata_id_sct_data_tables(const u16 *id)
805 {
806 return id[ATA_ID_SCT_CMD_XPORT] & (1 << 5) ? true : false;
807 }
808
ata_id_sct_features_ctrl(const u16 * id)809 static inline bool ata_id_sct_features_ctrl(const u16 *id)
810 {
811 return id[ATA_ID_SCT_CMD_XPORT] & (1 << 4) ? true : false;
812 }
813
ata_id_sct_error_recovery_ctrl(const u16 * id)814 static inline bool ata_id_sct_error_recovery_ctrl(const u16 *id)
815 {
816 return id[ATA_ID_SCT_CMD_XPORT] & (1 << 3) ? true : false;
817 }
818
ata_id_sct_write_same(const u16 * id)819 static inline bool ata_id_sct_write_same(const u16 *id)
820 {
821 return id[ATA_ID_SCT_CMD_XPORT] & (1 << 2) ? true : false;
822 }
823
ata_id_sct_long_sector_access(const u16 * id)824 static inline bool ata_id_sct_long_sector_access(const u16 *id)
825 {
826 return id[ATA_ID_SCT_CMD_XPORT] & (1 << 1) ? true : false;
827 }
828
ata_id_sct_supported(const u16 * id)829 static inline bool ata_id_sct_supported(const u16 *id)
830 {
831 return id[ATA_ID_SCT_CMD_XPORT] & (1 << 0) ? true : false;
832 }
833
834 /**
835 * ata_id_major_version - get ATA level of drive
836 * @id: Identify data
837 *
838 * Caveats:
839 * ATA-1 considers identify optional
840 * ATA-2 introduces mandatory identify
841 * ATA-3 introduces word 80 and accurate reporting
842 *
843 * The practical impact of this is that ata_id_major_version cannot
844 * reliably report on drives below ATA3.
845 */
846
ata_id_major_version(const u16 * id)847 static inline unsigned int ata_id_major_version(const u16 *id)
848 {
849 unsigned int mver;
850
851 if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
852 return 0;
853
854 for (mver = 14; mver >= 1; mver--)
855 if (id[ATA_ID_MAJOR_VER] & (1 << mver))
856 break;
857 return mver;
858 }
859
ata_id_is_sata(const u16 * id)860 static inline bool ata_id_is_sata(const u16 *id)
861 {
862 /*
863 * See if word 93 is 0 AND drive is at least ATA-5 compatible
864 * verifying that word 80 by casting it to a signed type --
865 * this trick allows us to filter out the reserved values of
866 * 0x0000 and 0xffff along with the earlier ATA revisions...
867 */
868 if (id[ATA_ID_HW_CONFIG] == 0 && (short)id[ATA_ID_MAJOR_VER] >= 0x0020)
869 return true;
870 return false;
871 }
872
ata_id_has_tpm(const u16 * id)873 static inline bool ata_id_has_tpm(const u16 *id)
874 {
875 /* The TPM bits are only valid on ATA8 */
876 if (ata_id_major_version(id) < 8)
877 return false;
878 if ((id[48] & 0xC000) != 0x4000)
879 return false;
880 return id[48] & (1 << 0);
881 }
882
ata_id_has_dword_io(const u16 * id)883 static inline bool ata_id_has_dword_io(const u16 *id)
884 {
885 /* ATA 8 reuses this flag for "trusted" computing */
886 if (ata_id_major_version(id) > 7)
887 return false;
888 return id[ATA_ID_DWORD_IO] & (1 << 0);
889 }
890
ata_id_has_unload(const u16 * id)891 static inline bool ata_id_has_unload(const u16 *id)
892 {
893 if (ata_id_major_version(id) >= 7 &&
894 (id[ATA_ID_CFSSE] & 0xC000) == 0x4000 &&
895 id[ATA_ID_CFSSE] & (1 << 13))
896 return true;
897 return false;
898 }
899
ata_id_has_wwn(const u16 * id)900 static inline bool ata_id_has_wwn(const u16 *id)
901 {
902 return (id[ATA_ID_CSF_DEFAULT] & 0xC100) == 0x4100;
903 }
904
ata_id_form_factor(const u16 * id)905 static inline int ata_id_form_factor(const u16 *id)
906 {
907 u16 val = id[168];
908
909 if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
910 return 0;
911
912 val &= 0xf;
913
914 if (val > 5)
915 return 0;
916
917 return val;
918 }
919
ata_id_rotation_rate(const u16 * id)920 static inline int ata_id_rotation_rate(const u16 *id)
921 {
922 u16 val = id[217];
923
924 if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
925 return 0;
926
927 if (val > 1 && val < 0x401)
928 return 0;
929
930 return val;
931 }
932
ata_id_has_ncq_send_and_recv(const u16 * id)933 static inline bool ata_id_has_ncq_send_and_recv(const u16 *id)
934 {
935 return id[ATA_ID_SATA_CAPABILITY_2] & BIT(6);
936 }
937
ata_id_has_ncq_non_data(const u16 * id)938 static inline bool ata_id_has_ncq_non_data(const u16 *id)
939 {
940 return id[ATA_ID_SATA_CAPABILITY_2] & BIT(5);
941 }
942
ata_id_has_trim(const u16 * id)943 static inline bool ata_id_has_trim(const u16 *id)
944 {
945 if (ata_id_major_version(id) >= 7 &&
946 (id[ATA_ID_DATA_SET_MGMT] & 1))
947 return true;
948 return false;
949 }
950
ata_id_has_zero_after_trim(const u16 * id)951 static inline bool ata_id_has_zero_after_trim(const u16 *id)
952 {
953 /* DSM supported, deterministic read, and read zero after trim set */
954 if (ata_id_has_trim(id) &&
955 (id[ATA_ID_ADDITIONAL_SUPP] & 0x4020) == 0x4020)
956 return true;
957
958 return false;
959 }
960
ata_id_current_chs_valid(const u16 * id)961 static inline bool ata_id_current_chs_valid(const u16 *id)
962 {
963 /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
964 has not been issued to the device then the values of
965 id[ATA_ID_CUR_CYLS] to id[ATA_ID_CUR_SECTORS] are vendor specific. */
966 return (id[ATA_ID_FIELD_VALID] & 1) && /* Current translation valid */
967 id[ATA_ID_CUR_CYLS] && /* cylinders in current translation */
968 id[ATA_ID_CUR_HEADS] && /* heads in current translation */
969 id[ATA_ID_CUR_HEADS] <= 16 &&
970 id[ATA_ID_CUR_SECTORS]; /* sectors in current translation */
971 }
972
ata_id_is_cfa(const u16 * id)973 static inline bool ata_id_is_cfa(const u16 *id)
974 {
975 if ((id[ATA_ID_CONFIG] == 0x848A) || /* Traditional CF */
976 (id[ATA_ID_CONFIG] == 0x844A)) /* Delkin Devices CF */
977 return true;
978 /*
979 * CF specs don't require specific value in the word 0 anymore and yet
980 * they forbid to report the ATA version in the word 80 and require the
981 * CFA feature set support to be indicated in the word 83 in this case.
982 * Unfortunately, some cards only follow either of this requirements,
983 * and while those that don't indicate CFA feature support need some
984 * sort of quirk list, it seems impractical for the ones that do...
985 */
986 return (id[ATA_ID_COMMAND_SET_2] & 0xC004) == 0x4004;
987 }
988
ata_id_is_ssd(const u16 * id)989 static inline bool ata_id_is_ssd(const u16 *id)
990 {
991 return id[ATA_ID_ROT_SPEED] == 0x01;
992 }
993
ata_id_zoned_cap(const u16 * id)994 static inline u8 ata_id_zoned_cap(const u16 *id)
995 {
996 return (id[ATA_ID_ADDITIONAL_SUPP] & 0x3);
997 }
998
ata_id_pio_need_iordy(const u16 * id,const u8 pio)999 static inline bool ata_id_pio_need_iordy(const u16 *id, const u8 pio)
1000 {
1001 /* CF spec. r4.1 Table 22 says no IORDY on PIO5 and PIO6. */
1002 if (pio > 4 && ata_id_is_cfa(id))
1003 return false;
1004 /* For PIO3 and higher it is mandatory. */
1005 if (pio > 2)
1006 return true;
1007 /* Turn it on when possible. */
1008 return ata_id_has_iordy(id);
1009 }
1010
ata_drive_40wire(const u16 * dev_id)1011 static inline bool ata_drive_40wire(const u16 *dev_id)
1012 {
1013 if (ata_id_is_sata(dev_id))
1014 return false; /* SATA */
1015 if ((dev_id[ATA_ID_HW_CONFIG] & 0xE000) == 0x6000)
1016 return false; /* 80 wire */
1017 return true;
1018 }
1019
ata_drive_40wire_relaxed(const u16 * dev_id)1020 static inline bool ata_drive_40wire_relaxed(const u16 *dev_id)
1021 {
1022 if ((dev_id[ATA_ID_HW_CONFIG] & 0x2000) == 0x2000)
1023 return false; /* 80 wire */
1024 return true;
1025 }
1026
atapi_cdb_len(const u16 * dev_id)1027 static inline int atapi_cdb_len(const u16 *dev_id)
1028 {
1029 u16 tmp = dev_id[ATA_ID_CONFIG] & 0x3;
1030 switch (tmp) {
1031 case 0: return 12;
1032 case 1: return 16;
1033 default: return -1;
1034 }
1035 }
1036
atapi_command_packet_set(const u16 * dev_id)1037 static inline int atapi_command_packet_set(const u16 *dev_id)
1038 {
1039 return (dev_id[ATA_ID_CONFIG] >> 8) & 0x1f;
1040 }
1041
atapi_id_dmadir(const u16 * dev_id)1042 static inline bool atapi_id_dmadir(const u16 *dev_id)
1043 {
1044 return ata_id_major_version(dev_id) >= 7 && (dev_id[62] & 0x8000);
1045 }
1046
1047 /*
1048 * ata_id_is_lba_capacity_ok() performs a sanity check on
1049 * the claimed LBA capacity value for the device.
1050 *
1051 * Returns 1 if LBA capacity looks sensible, 0 otherwise.
1052 *
1053 * It is called only once for each device.
1054 */
ata_id_is_lba_capacity_ok(u16 * id)1055 static inline bool ata_id_is_lba_capacity_ok(u16 *id)
1056 {
1057 unsigned long lba_sects, chs_sects, head, tail;
1058
1059 /* No non-LBA info .. so valid! */
1060 if (id[ATA_ID_CYLS] == 0)
1061 return true;
1062
1063 lba_sects = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
1064
1065 /*
1066 * The ATA spec tells large drives to return
1067 * C/H/S = 16383/16/63 independent of their size.
1068 * Some drives can be jumpered to use 15 heads instead of 16.
1069 * Some drives can be jumpered to use 4092 cyls instead of 16383.
1070 */
1071 if ((id[ATA_ID_CYLS] == 16383 ||
1072 (id[ATA_ID_CYLS] == 4092 && id[ATA_ID_CUR_CYLS] == 16383)) &&
1073 id[ATA_ID_SECTORS] == 63 &&
1074 (id[ATA_ID_HEADS] == 15 || id[ATA_ID_HEADS] == 16) &&
1075 (lba_sects >= 16383 * 63 * id[ATA_ID_HEADS]))
1076 return true;
1077
1078 chs_sects = id[ATA_ID_CYLS] * id[ATA_ID_HEADS] * id[ATA_ID_SECTORS];
1079
1080 /* perform a rough sanity check on lba_sects: within 10% is OK */
1081 if (lba_sects - chs_sects < chs_sects/10)
1082 return true;
1083
1084 /* some drives have the word order reversed */
1085 head = (lba_sects >> 16) & 0xffff;
1086 tail = lba_sects & 0xffff;
1087 lba_sects = head | (tail << 16);
1088
1089 if (lba_sects - chs_sects < chs_sects/10) {
1090 *(__le32 *)&id[ATA_ID_LBA_CAPACITY] = __cpu_to_le32(lba_sects);
1091 return true; /* LBA capacity is (now) good */
1092 }
1093
1094 return false; /* LBA capacity value may be bad */
1095 }
1096
ata_id_to_hd_driveid(u16 * id)1097 static inline void ata_id_to_hd_driveid(u16 *id)
1098 {
1099 #ifdef __BIG_ENDIAN
1100 /* accessed in struct hd_driveid as 8-bit values */
1101 id[ATA_ID_MAX_MULTSECT] = __cpu_to_le16(id[ATA_ID_MAX_MULTSECT]);
1102 id[ATA_ID_CAPABILITY] = __cpu_to_le16(id[ATA_ID_CAPABILITY]);
1103 id[ATA_ID_OLD_PIO_MODES] = __cpu_to_le16(id[ATA_ID_OLD_PIO_MODES]);
1104 id[ATA_ID_OLD_DMA_MODES] = __cpu_to_le16(id[ATA_ID_OLD_DMA_MODES]);
1105 id[ATA_ID_MULTSECT] = __cpu_to_le16(id[ATA_ID_MULTSECT]);
1106
1107 /* as 32-bit values */
1108 *(u32 *)&id[ATA_ID_LBA_CAPACITY] = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
1109 *(u32 *)&id[ATA_ID_SPG] = ata_id_u32(id, ATA_ID_SPG);
1110
1111 /* as 64-bit value */
1112 *(u64 *)&id[ATA_ID_LBA_CAPACITY_2] =
1113 ata_id_u64(id, ATA_ID_LBA_CAPACITY_2);
1114 #endif
1115 }
1116
ata_ok(u8 status)1117 static inline bool ata_ok(u8 status)
1118 {
1119 return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
1120 == ATA_DRDY);
1121 }
1122
lba_28_ok(u64 block,u32 n_block)1123 static inline bool lba_28_ok(u64 block, u32 n_block)
1124 {
1125 /* check the ending block number: must be LESS THAN 0x0fffffff */
1126 return ((block + n_block) < ((1 << 28) - 1)) && (n_block <= ATA_MAX_SECTORS);
1127 }
1128
lba_48_ok(u64 block,u32 n_block)1129 static inline bool lba_48_ok(u64 block, u32 n_block)
1130 {
1131 /* check the ending block number */
1132 return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= ATA_MAX_SECTORS_LBA48);
1133 }
1134
1135 #define sata_pmp_gscr_vendor(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
1136 #define sata_pmp_gscr_devid(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
1137 #define sata_pmp_gscr_rev(gscr) (((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
1138 #define sata_pmp_gscr_ports(gscr) ((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)
1139
1140 #endif /* __LINUX_ATA_H__ */
1141