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