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