projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
libata: factor out a ata_identify_page_supported helper
[linux-2.6-block.git] / include / linux / ata.h
CommitLineData
1da177e4
LT		 1
2/*
af36d7f0
JG		 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',
9bb9a39c 23 * as Documentation/driver-api/libata.rst
af36d7f0
JG		 24 *
25 * Hardware documentation available from http://www.t13.org/
26 *
1da177e4
LT		 27 */
28
29#ifndef __LINUX_ATA_H__
30#define __LINUX_ATA_H__
31
0c659b82
MW		 32#include <linux/kernel.h>
33#include <linux/string.h>
1da177e4 34#include <linux/types.h>
93734a23 35#include <asm/byteorder.h>
1da177e4
LT		 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
41enum {
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,
18d6e9d5 46 ATA_MAX_SECTORS_128 = 128,
8b881b04 47 ATA_MAX_SECTORS = 256,
af34d637 48 ATA_MAX_SECTORS_1024 = 1024,
35303d5c 49 ATA_MAX_SECTORS_LBA48 = 65535,/* avoid count to be 0000h */
f8d8e579 50 ATA_MAX_SECTORS_TAPE = 65535,
2983860c 51 ATA_MAX_TRIM_RNUM = 64, /* 512-byte payload / (6-byte LBA + 2-byte range per entry) */
1da177e4
LT		 52
53 ATA_ID_WORDS = 256,
37014c64
BZ		 54 ATA_ID_CONFIG = 0,
55 ATA_ID_CYLS = 1,
56 ATA_ID_HEADS = 3,
57 ATA_ID_SECTORS = 6,
a0cf733b 58 ATA_ID_SERNO = 10,
37014c64 59 ATA_ID_BUF_SIZE = 21,
a0cf733b
TH		 60 ATA_ID_FW_REV = 23,
61 ATA_ID_PROD = 27,
37014c64
BZ		 62 ATA_ID_MAX_MULTSECT = 47,
63 ATA_ID_DWORD_IO = 48,
64 ATA_ID_CAPABILITY = 49,
11e29e21 65 ATA_ID_OLD_PIO_MODES = 51,
37014c64 66 ATA_ID_OLD_DMA_MODES = 52,
11e29e21 67 ATA_ID_FIELD_VALID = 53,
37014c64
BZ		 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,
1da177e4 74 ATA_ID_MWDMA_MODES = 63,
11e29e21
AC		 75 ATA_ID_PIO_MODES = 64,
76 ATA_ID_EIDE_DMA_MIN = 65,
37014c64 77 ATA_ID_EIDE_DMA_TIME = 66,
11e29e21
AC		 78 ATA_ID_EIDE_PIO = 67,
79 ATA_ID_EIDE_PIO_IORDY = 68,
e78db4df 80 ATA_ID_ADDITIONAL_SUPP = 69,
37014c64 81 ATA_ID_QUEUE_DEPTH = 75,
583661a8
SH		 82 ATA_ID_SATA_CAPABILITY = 76,
83 ATA_ID_SATA_CAPABILITY_2 = 77,
84 ATA_ID_FEATURE_SUPP = 78,
11e29e21 85 ATA_ID_MAJOR_VER = 80,
37014c64
BZ		 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,
18f0f978 96 ATA_ID_SECTOR_SIZE = 106,
6b3b9d73 97 ATA_ID_WWN = 108,
295124dc 98 ATA_ID_LOGICAL_SECTOR_SIZE = 117, /* and 118 */
fe7173c2
HR		 99 ATA_ID_COMMAND_SET_3 = 119,
100 ATA_ID_COMMAND_SET_4 = 120,
37014c64
BZ		 101 ATA_ID_LAST_LUN = 126,
102 ATA_ID_DLF = 128,
103 ATA_ID_CSFO = 129,
104 ATA_ID_CFA_POWER = 160,
d42ad15b
SS		 105 ATA_ID_CFA_KEY_MGMT = 162,
106 ATA_ID_CFA_MODES = 163,
0c659b82 107 ATA_ID_DATA_SET_MGMT = 169,
7b203094 108 ATA_ID_SCT_CMD_XPORT = 206,
8bff7c6b 109 ATA_ID_ROT_SPEED = 217,
1da177e4
LT		 110 ATA_ID_PIO4 = (1 << 1),
111
a0cf733b
TH		 112 ATA_ID_SERNO_LEN = 20,
113 ATA_ID_FW_REV_LEN = 8,
114 ATA_ID_PROD_LEN = 40,
6b3b9d73 115 ATA_ID_WWN_LEN = 8,
a0cf733b 116
1da177e4 117 ATA_PCI_CTL_OFS = 2,
4099d143
BZ		 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
22ddbd1e
EIB		 127 ATA_PIO4_ONLY = (1 << 4),
128
91a6d4ed
BZ		 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),
22ddbd1e
EIB		 138 ATA_MWDMA3 = ATA_MWDMA2 | (1 << 3),
139 ATA_MWDMA4 = ATA_MWDMA3 | (1 << 4),
91a6d4ed
BZ		 140
141 ATA_MWDMA12_ONLY = (1 << 1) | (1 << 2),
142 ATA_MWDMA2_ONLY = (1 << 2),
143
1da177e4
LT		 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
22ddbd1e
EIB		 154 ATA_UDMA24_ONLY = (1 << 2) | (1 << 4),
155
1da177e4
LT		 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 */
b5911620 182 ATA_DSC = (1 << 4), /* drive seek complete */
1da177e4 183 ATA_DRQ = (1 << 3), /* data request i/o */
b5911620 184 ATA_CORR = (1 << 2), /* corrected data error */
27f00e53 185 ATA_SENSE = (1 << 1), /* sense code available */
1da177e4
LT		 186 ATA_ERR = (1 << 0), /* have an error */
187 ATA_SRST = (1 << 2), /* software reset */
9be1e979 188 ATA_ICRC = (1 << 7), /* interface CRC error */
b5911620 189 ATA_BBK = ATA_ICRC, /* pre-EIDE: block marked bad */
9be1e979 190 ATA_UNC = (1 << 6), /* uncorrectable media error */
b5911620 191 ATA_MC = (1 << 5), /* media changed */
9be1e979 192 ATA_IDNF = (1 << 4), /* ID not found */
b5911620 193 ATA_MCR = (1 << 3), /* media change requested */
1da177e4 194 ATA_ABORTED = (1 << 2), /* command aborted */
b5911620
BZ		 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),
1da177e4
LT		 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 */
ab2181cf 221 ATA_CMD_DEV_RESET = 0x08, /* ATAPI device reset */
1da177e4 222 ATA_CMD_CHK_POWER = 0xE5, /* check power mode */
972dcafb
DG		 223 ATA_CMD_STANDBY = 0xE2, /* place in standby power mode */
224 ATA_CMD_IDLE = 0xE3, /* place in idle power mode */
1da177e4 225 ATA_CMD_EDD = 0x90, /* execute device diagnostic */
6521148c 226 ATA_CMD_DOWNLOAD_MICRO = 0x92,
3915c3b5 227 ATA_CMD_DOWNLOAD_MICRO_DMA = 0x93,
6521148c 228 ATA_CMD_NOP = 0x00,
1da177e4
LT		 229 ATA_CMD_FLUSH = 0xE7,
230 ATA_CMD_FLUSH_EXT = 0xEA,
231 ATA_CMD_ID_ATA = 0xEC,
232 ATA_CMD_ID_ATAPI = 0xA1,
6521148c 233 ATA_CMD_SERVICE = 0xA2,
1da177e4
LT		 234 ATA_CMD_READ = 0xC8,
235 ATA_CMD_READ_EXT = 0x25,
6521148c
RH		 236 ATA_CMD_READ_QUEUED = 0x26,
237 ATA_CMD_READ_STREAM_EXT = 0x2B,
238 ATA_CMD_READ_STREAM_DMA_EXT = 0x2A,
1da177e4
LT		 239 ATA_CMD_WRITE = 0xCA,
240 ATA_CMD_WRITE_EXT = 0x35,
6521148c
RH		 241 ATA_CMD_WRITE_QUEUED = 0x36,
242 ATA_CMD_WRITE_STREAM_EXT = 0x3B,
243 ATA_CMD_WRITE_STREAM_DMA_EXT = 0x3A,
9a3dccc4 244 ATA_CMD_WRITE_FUA_EXT = 0x3D,
6521148c 245 ATA_CMD_WRITE_QUEUED_FUA_EXT = 0x3E,
88e49034
TH		 246 ATA_CMD_FPDMA_READ = 0x60,
247 ATA_CMD_FPDMA_WRITE = 0x61,
661ce1f0 248 ATA_CMD_NCQ_NON_DATA = 0x63,
ed36911c
MC		 249 ATA_CMD_FPDMA_SEND = 0x64,
250 ATA_CMD_FPDMA_RECV = 0x65,
1da177e4
LT		 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,
8cbd6df1
AL		 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,
9a3dccc4 259 ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
1da177e4 260 ATA_CMD_SET_FEATURES = 0xEF,
2c3d2a46 261 ATA_CMD_SET_MULTI = 0xC6,
1da177e4
LT		 262 ATA_CMD_PACKET = 0xA0,
263 ATA_CMD_VERIFY = 0x40,
264 ATA_CMD_VERIFY_EXT = 0x42,
6521148c 265 ATA_CMD_WRITE_UNCORR_EXT = 0x45,
2dcb407e
JG		 266 ATA_CMD_STANDBYNOW1 = 0xE0,
267 ATA_CMD_IDLEIMMEDIATE = 0xE1,
054a5fba 268 ATA_CMD_SLEEP = 0xE6,
8bf62ece 269 ATA_CMD_INIT_DEV_PARAMS = 0x91,
b6782728
AC		 270 ATA_CMD_READ_NATIVE_MAX = 0xF8,
271 ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
1e999736
AC		 272 ATA_CMD_SET_MAX = 0xF9,
273 ATA_CMD_SET_MAX_EXT = 0x37,
6521148c
RH		 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,
3915c3b5 278 ATA_CMD_TRUSTED_NONDATA = 0x5B,
6521148c
RH		 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,
814600ee 283 ATA_CMD_PMP_READ = 0xE4,
3915c3b5 284 ATA_CMD_PMP_READ_DMA = 0xE9,
814600ee 285 ATA_CMD_PMP_WRITE = 0xE8,
3915c3b5 286 ATA_CMD_PMP_WRITE_DMA = 0xEB,
ce2e0abb 287 ATA_CMD_CONF_OVERLAY = 0xB1,
6521148c
RH		 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,
ce2e0abb 292 ATA_CMD_SEC_FREEZE_LOCK = 0xF5,
6521148c
RH		 293 ATA_CMD_SEC_DISABLE_PASS = 0xF6,
294 ATA_CMD_CONFIG_STREAM = 0x51,
476d9894
BZ		 295 ATA_CMD_SMART = 0xB0,
296 ATA_CMD_MEDIA_LOCK = 0xDE,
297 ATA_CMD_MEDIA_UNLOCK = 0xDF,
0c659b82 298 ATA_CMD_DSM = 0x06,
6521148c
RH		 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,
3915c3b5
RH		 305 ATA_CMD_REQ_SENSE_DATA = 0x0B,
306 ATA_CMD_SANITIZE_DEVICE = 0xB4,
28a3fc22 307 ATA_CMD_ZAC_MGMT_IN = 0x4A,
27708a95 308 ATA_CMD_ZAC_MGMT_OUT = 0x9F,
3915c3b5 309
476d9894
BZ		 310 /* marked obsolete in the ATA/ATAPI-7 spec */
311 ATA_CMD_RESTORE = 0x10,
88e49034 312
5c65d8bb
HR		 313 /* Subcmds for ATA_CMD_FPDMA_RECV */
314 ATA_SUBCMD_FPDMA_RECV_RD_LOG_DMA_EXT = 0x01,
28a3fc22 315 ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN = 0x02,
5c65d8bb 316
ed36911c
MC		 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
a5703849
HR		 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,
284b3b77 325 ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT = 0x07,
a5703849 326
28a3fc22
HR		 327 /* Subcmds for ATA_CMD_ZAC_MGMT_IN */
328 ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES = 0x00,
329
27708a95
HR		 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
88e49034 336 /* READ_LOG_EXT pages */
fe5af0cc 337 ATA_LOG_DIRECTORY = 0x0,
88e49034 338 ATA_LOG_SATA_NCQ = 0x10,
1d51d5f3
CH		 339 ATA_LOG_NCQ_NON_DATA = 0x12,
340 ATA_LOG_NCQ_SEND_RECV = 0x13,
341 ATA_LOG_IDENTIFY_DEVICE = 0x30,
342
343 /* Identify device log pages: */
65fe1f0f 344 ATA_LOG_SATA_SETTINGS = 0x08,
6d1003ae 345 ATA_LOG_ZONED_INFORMATION = 0x09,
1d51d5f3
CH		 346
347 /* Identify device SATA settings log:*/
803739d2
SH		 348 ATA_LOG_DEVSLP_OFFSET = 0x30,
349 ATA_LOG_DEVSLP_SIZE = 0x08,
350 ATA_LOG_DEVSLP_MDAT = 0x00,
65fe1f0f 351 ATA_LOG_DEVSLP_MDAT_MASK = 0x1F,
803739d2
SH		 352 ATA_LOG_DEVSLP_DETO = 0x01,
353 ATA_LOG_DEVSLP_VALID = 0x07,
65fe1f0f 354 ATA_LOG_DEVSLP_VALID_MASK = 0x80,
8e061784 355 ATA_LOG_NCQ_PRIO_OFFSET = 0x09,
1da177e4 356
ed36911c
MC		 357 /* NCQ send and receive log */
358 ATA_LOG_NCQ_SEND_RECV_SUBCMDS_OFFSET = 0x00,
359 ATA_LOG_NCQ_SEND_RECV_SUBCMDS_DSM = (1 << 0),
360 ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET = 0x04,
361 ATA_LOG_NCQ_SEND_RECV_DSM_TRIM = (1 << 0),
362 ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET = 0x08,
5c65d8bb 363 ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED = (1 << 0),
ed36911c 364 ATA_LOG_NCQ_SEND_RECV_WR_LOG_OFFSET = 0x0C,
5c65d8bb 365 ATA_LOG_NCQ_SEND_RECV_WR_LOG_SUPPORTED = (1 << 0),
28a3fc22
HR		 366 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OFFSET = 0x10,
367 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OUT_SUPPORTED = (1 << 0),
368 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED = (1 << 1),
369 ATA_LOG_NCQ_SEND_RECV_SIZE = 0x14,
ed36911c 370
a5703849
HR		 371 /* NCQ Non-Data log */
372 ATA_LOG_NCQ_NON_DATA_SUBCMDS_OFFSET = 0x00,
373 ATA_LOG_NCQ_NON_DATA_ABORT_OFFSET = 0x00,
374 ATA_LOG_NCQ_NON_DATA_ABORT_NCQ = (1 << 0),
375 ATA_LOG_NCQ_NON_DATA_ABORT_ALL = (1 << 1),
376 ATA_LOG_NCQ_NON_DATA_ABORT_STREAMING = (1 << 2),
377 ATA_LOG_NCQ_NON_DATA_ABORT_NON_STREAMING = (1 << 3),
378 ATA_LOG_NCQ_NON_DATA_ABORT_SELECTED = (1 << 4),
379 ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET = 0x1C,
380 ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT = (1 << 0),
381 ATA_LOG_NCQ_NON_DATA_SIZE = 0x40,
ed36911c 382
5a5dbd18
ML		 383 /* READ/WRITE LONG (obsolete) */
384 ATA_CMD_READ_LONG = 0x22,
385 ATA_CMD_READ_LONG_ONCE = 0x23,
386 ATA_CMD_WRITE_LONG = 0x32,
387 ATA_CMD_WRITE_LONG_ONCE = 0x33,
388
1da177e4
LT		 389 /* SETFEATURES stuff */
390 SETFEATURES_XFER = 0x03,
391 XFER_UDMA_7 = 0x47,
392 XFER_UDMA_6 = 0x46,
393 XFER_UDMA_5 = 0x45,
394 XFER_UDMA_4 = 0x44,
395 XFER_UDMA_3 = 0x43,
396 XFER_UDMA_2 = 0x42,
397 XFER_UDMA_1 = 0x41,
398 XFER_UDMA_0 = 0x40,
b352e57d
AC		 399 XFER_MW_DMA_4 = 0x24, /* CFA only */
400 XFER_MW_DMA_3 = 0x23, /* CFA only */
1da177e4
LT		 401 XFER_MW_DMA_2 = 0x22,
402 XFER_MW_DMA_1 = 0x21,
403 XFER_MW_DMA_0 = 0x20,
b4b52db7
AC		 404 XFER_SW_DMA_2 = 0x12,
405 XFER_SW_DMA_1 = 0x11,
406 XFER_SW_DMA_0 = 0x10,
b352e57d
AC		 407 XFER_PIO_6 = 0x0E, /* CFA only */
408 XFER_PIO_5 = 0x0D, /* CFA only */
1da177e4
LT		 409 XFER_PIO_4 = 0x0C,
410 XFER_PIO_3 = 0x0B,
411 XFER_PIO_2 = 0x0A,
412 XFER_PIO_1 = 0x09,
413 XFER_PIO_0 = 0x08,
1da177e4
LT		 414 XFER_PIO_SLOW = 0x00,
415
3057ac3c 416 SETFEATURES_WC_ON = 0x02, /* Enable write cache */
417 SETFEATURES_WC_OFF = 0x82, /* Disable write cache */
418
0c12735e
TY		 419 SETFEATURES_RA_ON = 0xaa, /* Enable read look-ahead */
420 SETFEATURES_RA_OFF = 0x55, /* Disable read look-ahead */
421
476d9894
BZ		 422 /* Enable/Disable Automatic Acoustic Management */
423 SETFEATURES_AAM_ON = 0x42,
424 SETFEATURES_AAM_OFF = 0xC2,
425
974e0a45
DLM		 426 SETFEATURES_SPINUP = 0x07, /* Spin-up drive */
427 SETFEATURES_SPINUP_TIMEOUT = 30000, /* 30s timeout for drive spin-up from PUIS */
169439c2 428
9f45cbd3
KCA		 429 SETFEATURES_SATA_ENABLE = 0x10, /* Enable use of SATA feature */
430 SETFEATURES_SATA_DISABLE = 0x90, /* Disable use of SATA feature */
431
432 /* SETFEATURE Sector counts for SATA features */
fa5b561c 433 SATA_FPDMA_OFFSET = 0x01, /* FPDMA non-zero buffer offsets */
f1bce7f8
TH		 434 SATA_FPDMA_AA = 0x02, /* FPDMA Setup FIS Auto-Activate */
435 SATA_DIPM = 0x03, /* Device Initiated Power Management */
fa5b561c 436 SATA_FPDMA_IN_ORDER = 0x04, /* FPDMA in-order data delivery */
f1bce7f8 437 SATA_AN = 0x05, /* Asynchronous Notification */
fa5b561c 438 SATA_SSP = 0x06, /* Software Settings Preservation */
65fe1f0f 439 SATA_DEVSLP = 0x09, /* Device Sleep */
9f45cbd3 440
e87fd28c
HR		 441 SETFEATURE_SENSE_DATA = 0xC3, /* Sense Data Reporting feature */
442
ce2e0abb
TH		 443 /* feature values for SET_MAX */
444 ATA_SET_MAX_ADDR = 0x00,
445 ATA_SET_MAX_PASSWD = 0x01,
446 ATA_SET_MAX_LOCK = 0x02,
447 ATA_SET_MAX_UNLOCK = 0x03,
448 ATA_SET_MAX_FREEZE_LOCK = 0x04,
449
450 /* feature values for DEVICE CONFIGURATION OVERLAY */
451 ATA_DCO_RESTORE = 0xC0,
452 ATA_DCO_FREEZE_LOCK = 0xC1,
453 ATA_DCO_IDENTIFY = 0xC2,
454 ATA_DCO_SET = 0xC3,
455
476d9894
BZ		 456 /* feature values for SMART */
457 ATA_SMART_ENABLE = 0xD8,
458 ATA_SMART_READ_VALUES = 0xD0,
459 ATA_SMART_READ_THRESHOLDS = 0xD1,
460
0c659b82
MW		 461 /* feature values for Data Set Management */
462 ATA_DSM_TRIM = 0x01,
463
476d9894
BZ		 464 /* password used in LBA Mid / LBA High for executing SMART commands */
465 ATA_SMART_LBAM_PASS = 0x4F,
466 ATA_SMART_LBAH_PASS = 0xC2,
467
1da177e4
LT		 468 /* ATAPI stuff */
469 ATAPI_PKT_DMA = (1 << 0),
470 ATAPI_DMADIR = (1 << 2), /* ATAPI data dir:
471 0=to device, 1=to host */
472 ATAPI_CDB_LEN = 16,
473
814600ee
TH		 474 /* PMP stuff */
475 SATA_PMP_MAX_PORTS = 15,
476 SATA_PMP_CTRL_PORT = 15,
477
478 SATA_PMP_GSCR_DWORDS = 128,
479 SATA_PMP_GSCR_PROD_ID = 0,
480 SATA_PMP_GSCR_REV = 1,
481 SATA_PMP_GSCR_PORT_INFO = 2,
482 SATA_PMP_GSCR_ERROR = 32,
483 SATA_PMP_GSCR_ERROR_EN = 33,
484 SATA_PMP_GSCR_FEAT = 64,
485 SATA_PMP_GSCR_FEAT_EN = 96,
486
487 SATA_PMP_PSCR_STATUS = 0,
488 SATA_PMP_PSCR_ERROR = 1,
489 SATA_PMP_PSCR_CONTROL = 2,
490
491 SATA_PMP_FEAT_BIST = (1 << 0),
492 SATA_PMP_FEAT_PMREQ = (1 << 1),
493 SATA_PMP_FEAT_DYNSSC = (1 << 2),
494 SATA_PMP_FEAT_NOTIFY = (1 << 3),
495
1da177e4
LT		 496 /* cable types */
497 ATA_CBL_NONE = 0,
498 ATA_CBL_PATA40 = 1,
499 ATA_CBL_PATA80 = 2,
c88f90c3
TH		 500 ATA_CBL_PATA40_SHORT = 3, /* 40 wire cable to high UDMA spec */
501 ATA_CBL_PATA_UNK = 4, /* don't know, maybe 80c? */
502 ATA_CBL_PATA_IGN = 5, /* don't know, ignore cable handling */
503 ATA_CBL_SATA = 6,
1da177e4
LT		 504
505 /* SATA Status and Control Registers */
506 SCR_STATUS = 0,
507 SCR_ERROR = 1,
508 SCR_CONTROL = 2,
509 SCR_ACTIVE = 3,
510 SCR_NOTIFICATION = 4,
511
9be1e979
TH		 512 /* SError bits */
513 SERR_DATA_RECOVERED = (1 << 0), /* recovered data error */
514 SERR_COMM_RECOVERED = (1 << 1), /* recovered comm failure */
515 SERR_DATA = (1 << 8), /* unrecovered data error */
516 SERR_PERSISTENT = (1 << 9), /* persistent data/comm error */
517 SERR_PROTOCOL = (1 << 10), /* protocol violation */
518 SERR_INTERNAL = (1 << 11), /* host internal error */
519 SERR_PHYRDY_CHG = (1 << 16), /* PHY RDY changed */
1333e194
RH		 520 SERR_PHY_INT_ERR = (1 << 17), /* PHY internal error */
521 SERR_COMM_WAKE = (1 << 18), /* Comm wake */
522 SERR_10B_8B_ERR = (1 << 19), /* 10b to 8b decode error */
523 SERR_DISPARITY = (1 << 20), /* Disparity */
524 SERR_CRC = (1 << 21), /* CRC error */
525 SERR_HANDSHAKE = (1 << 22), /* Handshake error */
526 SERR_LINK_SEQ_ERR = (1 << 23), /* Link sequence error */
527 SERR_TRANS_ST_ERROR = (1 << 24), /* Transport state trans. error */
528 SERR_UNRECOG_FIS = (1 << 25), /* Unrecognized FIS */
9be1e979 529 SERR_DEV_XCHG = (1 << 26), /* device exchanged */
1da177e4
LT		 530};
531
37f92d77
CH		 532enum ata_prot_flags {
533 /* protocol flags */
534 ATA_PROT_FLAG_PIO = (1 << 0), /* is PIO */
535 ATA_PROT_FLAG_DMA = (1 << 1), /* is DMA */
536 ATA_PROT_FLAG_NCQ = (1 << 2), /* is NCQ */
537 ATA_PROT_FLAG_ATAPI = (1 << 3), /* is ATAPI */
538
539 /* taskfile protocols */
540 ATA_PROT_UNKNOWN = (u8)-1,
541 ATA_PROT_NODATA = 0,
542 ATA_PROT_PIO = ATA_PROT_FLAG_PIO,
543 ATA_PROT_DMA = ATA_PROT_FLAG_DMA,
544 ATA_PROT_NCQ_NODATA = ATA_PROT_FLAG_NCQ,
545 ATA_PROT_NCQ = ATA_PROT_FLAG_DMA | ATA_PROT_FLAG_NCQ,
546 ATAPI_PROT_NODATA = ATA_PROT_FLAG_ATAPI,
547 ATAPI_PROT_PIO = ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_PIO,
548 ATAPI_PROT_DMA = ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_DMA,
1da177e4
LT		 549};
550
551enum ata_ioctls {
287e6611
AB		 552 ATA_IOC_GET_IO32 = 0x309, /* HDIO_GET_32BIT */
553 ATA_IOC_SET_IO32 = 0x324, /* HDIO_SET_32BIT */
1da177e4
LT		 554};
555
556/* core structures */
557
f60d7011 558struct ata_bmdma_prd {
4ca4e439
AV		 559 __le32 addr;
560 __le32 flags_len;
1da177e4
LT		 561};
562
405e66b3
TH		 563/*
564 * id tests
565 */
37014c64
BZ		 566#define ata_id_is_ata(id) (((id)[ATA_ID_CONFIG] & (1 << 15)) == 0)
567#define ata_id_has_lba(id) ((id)[ATA_ID_CAPABILITY] & (1 << 9))
568#define ata_id_has_dma(id) ((id)[ATA_ID_CAPABILITY] & (1 << 8))
583661a8 569#define ata_id_has_ncq(id) ((id)[ATA_ID_SATA_CAPABILITY] & (1 << 8))
37014c64 570#define ata_id_queue_depth(id) (((id)[ATA_ID_QUEUE_DEPTH] & 0x1f) + 1)
0628ee7c 571#define ata_id_removable(id) ((id)[ATA_ID_CONFIG] & (1 << 7))
854c73a2 572#define ata_id_has_atapi_AN(id) \
583661a8
SH		 573 ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
574 ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
575 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 5)))
388539f3 576#define ata_id_has_fpdma_aa(id) \
583661a8
SH		 577 ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
578 ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
579 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 2)))
37014c64
BZ		 580#define ata_id_iordy_disable(id) ((id)[ATA_ID_CAPABILITY] & (1 << 10))
581#define ata_id_has_iordy(id) ((id)[ATA_ID_CAPABILITY] & (1 << 11))
1da177e4
LT		 582#define ata_id_u32(id,n) \
583 (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
584#define ata_id_u64(id,n) \
585 ( ((u64) (id)[(n) + 3] << 48) | \
586 ((u64) (id)[(n) + 2] << 32) | \
587 ((u64) (id)[(n) + 1] << 16) | \
588 ((u64) (id)[(n) + 0]) )
589
37014c64 590#define ata_id_cdb_intr(id) (((id)[ATA_ID_CONFIG] & 0x60) == 0x20)
583661a8 591#define ata_id_has_da(id) ((id)[ATA_ID_SATA_CAPABILITY_2] & (1 << 4))
65fe1f0f 592#define ata_id_has_devslp(id) ((id)[ATA_ID_FEATURE_SUPP] & (1 << 8))
5b01e4b9
HR		 593#define ata_id_has_ncq_autosense(id) \
594 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 7))
312f7da2 595
ca77329f
KCA		 596static inline bool ata_id_has_hipm(const u16 *id)
597{
583661a8 598 u16 val = id[ATA_ID_SATA_CAPABILITY];
ca77329f
KCA		 599
600 if (val == 0 || val == 0xffff)
601 return false;
602
603 return val & (1 << 9);
604}
605
606static inline bool ata_id_has_dipm(const u16 *id)
607{
583661a8 608 u16 val = id[ATA_ID_FEATURE_SUPP];
ca77329f
KCA		 609
610 if (val == 0 || val == 0xffff)
611 return false;
612
613 return val & (1 << 3);
614}
615
ae8d4ee7 616
4dce8ba9 617static inline bool ata_id_has_fua(const u16 *id)
c7293870 618{
37014c64 619 if ((id[ATA_ID_CFSSE] & 0xC000) != 0x4000)
4dce8ba9 620 return false;
37014c64 621 return id[ATA_ID_CFSSE] & (1 << 6);
c7293870
AC		 622}
623
4dce8ba9 624static inline bool ata_id_has_flush(const u16 *id)
c7293870 625{
37014c64 626 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
4dce8ba9 627 return false;
37014c64 628 return id[ATA_ID_COMMAND_SET_2] & (1 << 12);
c7293870
AC		 629}
630
4dce8ba9 631static inline bool ata_id_flush_enabled(const u16 *id)
4b58f17d
BZ		 632{
633 if (ata_id_has_flush(id) == 0)
4dce8ba9 634 return false;
4b58f17d 635 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
4dce8ba9 636 return false;
4b58f17d
BZ		 637 return id[ATA_ID_CFS_ENABLE_2] & (1 << 12);
638}
639
4dce8ba9 640static inline bool ata_id_has_flush_ext(const u16 *id)
c7293870 641{
37014c64 642 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
4dce8ba9 643 return false;
37014c64 644 return id[ATA_ID_COMMAND_SET_2] & (1 << 13);
c7293870
AC		 645}
646
4dce8ba9 647static inline bool ata_id_flush_ext_enabled(const u16 *id)
ff2779b5
BZ		 648{
649 if (ata_id_has_flush_ext(id) == 0)
4dce8ba9 650 return false;
ff2779b5 651 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
4dce8ba9 652 return false;
ff2779b5
BZ		 653 /*
654 * some Maxtor disks have bit 13 defined incorrectly
655 * so check bit 10 too
656 */
657 return (id[ATA_ID_CFS_ENABLE_2] & 0x2400) == 0x2400;
658}
659
295124dc 660static inline u32 ata_id_logical_sector_size(const u16 *id)
18f0f978 661{
295124dc
GG		 662 /* T13/1699-D Revision 6a, Sep 6, 2008. Page 128.
663 * IDENTIFY DEVICE data, word 117-118.
664 * 0xd000 ignores bit 13 (logical:physical > 1)
665 */
666 if ((id[ATA_ID_SECTOR_SIZE] & 0xd000) == 0x5000)
667 return (((id[ATA_ID_LOGICAL_SECTOR_SIZE+1] << 16)
668 + id[ATA_ID_LOGICAL_SECTOR_SIZE]) * sizeof(u16)) ;
669 return ATA_SECT_SIZE;
670}
671
672static inline u8 ata_id_log2_per_physical_sector(const u16 *id)
673{
674 /* T13/1699-D Revision 6a, Sep 6, 2008. Page 128.
675 * IDENTIFY DEVICE data, word 106.
676 * 0xe000 ignores bit 12 (logical sector > 512 bytes)
677 */
678 if ((id[ATA_ID_SECTOR_SIZE] & 0xe000) == 0x6000)
679 return (id[ATA_ID_SECTOR_SIZE] & 0xf);
680 return 0;
18f0f978
CH		 681}
682
295124dc
GG		 683/* Offset of logical sectors relative to physical sectors.
684 *
685 * If device has more than one logical sector per physical sector
686 * (aka 512 byte emulation), vendors might offset the "sector 0" address
687 * so sector 63 is "naturally aligned" - e.g. FAT partition table.
688 * This avoids Read/Mod/Write penalties when using FAT partition table
689 * and updating "well aligned" (FS perspective) physical sectors on every
690 * transaction.
691 */
692static inline u16 ata_id_logical_sector_offset(const u16 *id,
693 u8 log2_per_phys)
18f0f978 694{
295124dc
GG		 695 u16 word_209 = id[209];
696
697 if ((log2_per_phys > 1) && (word_209 & 0xc000) == 0x4000) {
698 u16 first = word_209 & 0x3fff;
699 if (first > 0)
700 return (1 << log2_per_phys) - first;
701 }
702 return 0;
18f0f978
CH		 703}
704
4dce8ba9 705static inline bool ata_id_has_lba48(const u16 *id)
c7293870 706{
37014c64 707 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
4dce8ba9 708 return false;
37014c64 709 if (!ata_id_u64(id, ATA_ID_LBA_CAPACITY_2))
4dce8ba9 710 return false;
37014c64 711 return id[ATA_ID_COMMAND_SET_2] & (1 << 10);
c7293870
AC		 712}
713
4dce8ba9 714static inline bool ata_id_lba48_enabled(const u16 *id)
942dcd85
BZ		 715{
716 if (ata_id_has_lba48(id) == 0)
4dce8ba9 717 return false;
942dcd85 718 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
4dce8ba9 719 return false;
942dcd85
BZ		 720 return id[ATA_ID_CFS_ENABLE_2] & (1 << 10);
721}
722
4dce8ba9 723static inline bool ata_id_hpa_enabled(const u16 *id)
c7293870
AC		 724{
725 /* Yes children, word 83 valid bits cover word 82 data */
37014c64 726 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
4dce8ba9 727 return false;
c7293870 728 /* And 87 covers 85-87 */
37014c64 729 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
4dce8ba9 730 return false;
c7293870 731 /* Check command sets enabled as well as supported */
37014c64 732 if ((id[ATA_ID_CFS_ENABLE_1] & (1 << 10)) == 0)
4dce8ba9 733 return false;
37014c64 734 return id[ATA_ID_COMMAND_SET_1] & (1 << 10);
c7293870
AC		 735}
736
4dce8ba9 737static inline bool ata_id_has_wcache(const u16 *id)
c7293870
AC		 738{
739 /* Yes children, word 83 valid bits cover word 82 data */
37014c64 740 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
4dce8ba9 741 return false;
37014c64 742 return id[ATA_ID_COMMAND_SET_1] & (1 << 5);
c7293870
AC		 743}
744
4dce8ba9 745static inline bool ata_id_has_pm(const u16 *id)
c7293870 746{
37014c64 747 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
4dce8ba9 748 return false;
37014c64 749 return id[ATA_ID_COMMAND_SET_1] & (1 << 3);
c7293870
AC		 750}
751
4dce8ba9 752static inline bool ata_id_rahead_enabled(const u16 *id)
c7293870 753{
37014c64 754 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
4dce8ba9 755 return false;
37014c64 756 return id[ATA_ID_CFS_ENABLE_1] & (1 << 6);
c7293870
AC		 757}
758
4dce8ba9 759static inline bool ata_id_wcache_enabled(const u16 *id)
c7293870 760{
37014c64 761 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
4dce8ba9 762 return false;
37014c64 763 return id[ATA_ID_CFS_ENABLE_1] & (1 << 5);
c7293870
AC		 764}
765
9faa6438
HR		 766static inline bool ata_id_has_read_log_dma_ext(const u16 *id)
767{
406c057c 768 /* Word 86 must have bit 15 set */
9faa6438
HR		 769 if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
770 return false;
406c057c
MP		 771
772 /* READ LOG DMA EXT support can be signaled either from word 119
773 * or from word 120. The format is the same for both words: Bit
774 * 15 must be cleared, bit 14 set and bit 3 set.
775 */
776 if ((id[ATA_ID_COMMAND_SET_3] & 0xC008) == 0x4008 ||
777 (id[ATA_ID_COMMAND_SET_4] & 0xC008) == 0x4008)
778 return true;
779
780 return false;
9faa6438
HR		 781}
782
e87fd28c
HR		 783static inline bool ata_id_has_sense_reporting(const u16 *id)
784{
785 if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
786 return false;
787 return id[ATA_ID_COMMAND_SET_3] & (1 << 6);
788}
789
790static inline bool ata_id_sense_reporting_enabled(const u16 *id)
791{
792 if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
793 return false;
794 return id[ATA_ID_COMMAND_SET_4] & (1 << 6);
795}
796
7b203094
ST		 797/**
798 *
799 * Word: 206 - SCT Command Transport
800 * 15:12 - Vendor Specific
801 * 11:6 - Reserved
802 * 5 - SCT Command Transport Data Tables supported
803 * 4 - SCT Command Transport Features Control supported
804 * 3 - SCT Command Transport Error Recovery Control supported
805 * 2 - SCT Command Transport Write Same supported
806 * 1 - SCT Command Transport Long Sector Access supported
807 * 0 - SCT Command Transport supported
808 */
809static inline bool ata_id_sct_data_tables(const u16 *id)
810{
811 return id[ATA_ID_SCT_CMD_XPORT] & (1 << 5) ? true : false;
812}
813
814static inline bool ata_id_sct_features_ctrl(const u16 *id)
815{
816 return id[ATA_ID_SCT_CMD_XPORT] & (1 << 4) ? true : false;
817}
818
819static inline bool ata_id_sct_error_recovery_ctrl(const u16 *id)
820{
821 return id[ATA_ID_SCT_CMD_XPORT] & (1 << 3) ? true : false;
822}
823
7b203094
ST		 824static 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
829static inline bool ata_id_sct_supported(const u16 *id)
830{
831 return id[ATA_ID_SCT_CMD_XPORT] & (1 << 0) ? true : false;
832}
833
c7293870
AC		 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
2dcb407e 844 * reliably report on drives below ATA3.
c7293870
AC		 845 */
846
3d2ca910
TH		 847static inline unsigned int ata_id_major_version(const u16 *id)
848{
849 unsigned int mver;
850
b352e57d
AC		 851 if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
852 return 0;
853
3d2ca910
TH		 854 for (mver = 14; mver >= 1; mver--)
855 if (id[ATA_ID_MAJOR_VER] & (1 << mver))
856 break;
857 return mver;
858}
859
4dce8ba9 860static inline bool ata_id_is_sata(const u16 *id)
32d90911 861{
367d7e78
BZ		 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)
4dce8ba9
HR		 869 return true;
870 return false;
32d90911
TH		 871}
872
4dce8ba9 873static inline bool ata_id_has_tpm(const u16 *id)
ae8d4ee7
AC		 874{
875 /* The TPM bits are only valid on ATA8 */
876 if (ata_id_major_version(id) < 8)
4dce8ba9 877 return false;
ae8d4ee7 878 if ((id[48] & 0xC000) != 0x4000)
4dce8ba9 879 return false;
ae8d4ee7
AC		 880 return id[48] & (1 << 0);
881}
882
4dce8ba9 883static inline bool ata_id_has_dword_io(const u16 *id)
ae8d4ee7
AC		 884{
885 /* ATA 8 reuses this flag for "trusted" computing */
886 if (ata_id_major_version(id) > 7)
4dce8ba9
HR		 887 return false;
888 return id[ATA_ID_DWORD_IO] & (1 << 0);
ae8d4ee7
AC		 889}
890
4dce8ba9 891static inline bool ata_id_has_unload(const u16 *id)
ea6ce53c
EO		 892{
893 if (ata_id_major_version(id) >= 7 &&
894 (id[ATA_ID_CFSSE] & 0xC000) == 0x4000 &&
895 id[ATA_ID_CFSSE] & (1 << 13))
4dce8ba9
HR		 896 return true;
897 return false;
ea6ce53c
EO		 898}
899
6b3b9d73
HR		 900static inline bool ata_id_has_wwn(const u16 *id)
901{
902 return (id[ATA_ID_CSF_DEFAULT] & 0xC100) == 0x4100;
903}
904
4bca3286
MP		 905static 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
920static 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
ed36911c
MC		 933static 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
284b3b77
HR		 938static inline bool ata_id_has_ncq_non_data(const u16 *id)
939{
940 return id[ATA_ID_SATA_CAPABILITY_2] & BIT(5);
941}
942
8e061784
AM		 943static inline bool ata_id_has_ncq_prio(const u16 *id)
944{
945 return id[ATA_ID_SATA_CAPABILITY] & BIT(12);
946}
947
4dce8ba9 948static inline bool ata_id_has_trim(const u16 *id)
0c659b82
MW		 949{
950 if (ata_id_major_version(id) >= 7 &&
951 (id[ATA_ID_DATA_SET_MGMT] & 1))
4dce8ba9
HR		 952 return true;
953 return false;
0c659b82
MW		 954}
955
4dce8ba9 956static inline bool ata_id_has_zero_after_trim(const u16 *id)
e78db4df
MP		 957{
958 /* DSM supported, deterministic read, and read zero after trim set */
959 if (ata_id_has_trim(id) &&
960 (id[ATA_ID_ADDITIONAL_SUPP] & 0x4020) == 0x4020)
4dce8ba9 961 return true;
e78db4df 962
4dce8ba9 963 return false;
e78db4df
MP		 964}
965
4dce8ba9 966static inline bool ata_id_current_chs_valid(const u16 *id)
8bf62ece 967{
9bec2e38
JG		 968 /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
969 has not been issued to the device then the values of
37014c64
BZ		 970 id[ATA_ID_CUR_CYLS] to id[ATA_ID_CUR_SECTORS] are vendor specific. */
971 return (id[ATA_ID_FIELD_VALID] & 1) && /* Current translation valid */
972 id[ATA_ID_CUR_CYLS] && /* cylinders in current translation */
973 id[ATA_ID_CUR_HEADS] && /* heads in current translation */
974 id[ATA_ID_CUR_HEADS] <= 16 &&
975 id[ATA_ID_CUR_SECTORS]; /* sectors in current translation */
8bf62ece
AL		 976}
977
4dce8ba9 978static inline bool ata_id_is_cfa(const u16 *id)
b352e57d 979{
4b7d1c05
BG		 980 if ((id[ATA_ID_CONFIG] == 0x848A) || /* Traditional CF */
981 (id[ATA_ID_CONFIG] == 0x844A)) /* Delkin Devices CF */
4dce8ba9 982 return true;
2999b58b
SS		 983 /*
984 * CF specs don't require specific value in the word 0 anymore and yet
985 * they forbid to report the ATA version in the word 80 and require the
986 * CFA feature set support to be indicated in the word 83 in this case.
987 * Unfortunately, some cards only follow either of this requirements,
988 * and while those that don't indicate CFA feature support need some
989 * sort of quirk list, it seems impractical for the ones that do...
990 */
4dce8ba9 991 return (id[ATA_ID_COMMAND_SET_2] & 0xC004) == 0x4004;
b352e57d
AC		 992}
993
4dce8ba9 994static inline bool ata_id_is_ssd(const u16 *id)
8bff7c6b
JA		 995{
996 return id[ATA_ID_ROT_SPEED] == 0x01;
997}
998
856c4663
HR		 999static inline u8 ata_id_zoned_cap(const u16 *id)
1000{
1001 return (id[ATA_ID_ADDITIONAL_SUPP] & 0x3);
1002}
1003
4dce8ba9 1004static inline bool ata_id_pio_need_iordy(const u16 *id, const u8 pio)
6dae44f9
BZ		 1005{
1006 /* CF spec. r4.1 Table 22 says no IORDY on PIO5 and PIO6. */
1007 if (pio > 4 && ata_id_is_cfa(id))
4dce8ba9 1008 return false;
6dae44f9
BZ		 1009 /* For PIO3 and higher it is mandatory. */
1010 if (pio > 2)
4dce8ba9 1011 return true;
6dae44f9 1012 /* Turn it on when possible. */
4dce8ba9 1013 return ata_id_has_iordy(id);
6dae44f9
BZ		 1014}
1015
4dce8ba9 1016static inline bool ata_drive_40wire(const u16 *dev_id)
fc085150 1017{
32d90911 1018 if (ata_id_is_sata(dev_id))
4dce8ba9 1019 return false; /* SATA */
37014c64 1020 if ((dev_id[ATA_ID_HW_CONFIG] & 0xE000) == 0x6000)
4dce8ba9
HR		 1021 return false; /* 80 wire */
1022 return true;
fc085150
AC		 1023}
1024
4dce8ba9 1025static inline bool ata_drive_40wire_relaxed(const u16 *dev_id)
6bbfd53d 1026{
37014c64 1027 if ((dev_id[ATA_ID_HW_CONFIG] & 0x2000) == 0x2000)
4dce8ba9
HR		 1028 return false; /* 80 wire */
1029 return true;
6bbfd53d
AC		 1030}
1031
057ace5e 1032static inline int atapi_cdb_len(const u16 *dev_id)
1da177e4 1033{
37014c64 1034 u16 tmp = dev_id[ATA_ID_CONFIG] & 0x3;
1da177e4
LT		 1035 switch (tmp) {
1036 case 0: return 12;
1037 case 1: return 16;
1038 default: return -1;
1039 }
1040}
1041
d8668fcb 1042static inline int atapi_command_packet_set(const u16 *dev_id)
f8d8e579 1043{
37014c64 1044 return (dev_id[ATA_ID_CONFIG] >> 8) & 0x1f;
f8d8e579
TB		 1045}
1046
4dce8ba9 1047static inline bool atapi_id_dmadir(const u16 *dev_id)
91163006
TH		 1048{
1049 return ata_id_major_version(dev_id) >= 7 && (dev_id[62] & 0x8000);
1050}
1051
a02227c9
BZ		 1052/*
1053 * ata_id_is_lba_capacity_ok() performs a sanity check on
1054 * the claimed LBA capacity value for the device.
1055 *
1056 * Returns 1 if LBA capacity looks sensible, 0 otherwise.
1057 *
1058 * It is called only once for each device.
1059 */
4dce8ba9 1060static inline bool ata_id_is_lba_capacity_ok(u16 *id)
a02227c9
BZ		 1061{
1062 unsigned long lba_sects, chs_sects, head, tail;
1063
1064 /* No non-LBA info .. so valid! */
1065 if (id[ATA_ID_CYLS] == 0)
4dce8ba9 1066 return true;
a02227c9
BZ		 1067
1068 lba_sects = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
1069
1070 /*
1071 * The ATA spec tells large drives to return
1072 * C/H/S = 16383/16/63 independent of their size.
1073 * Some drives can be jumpered to use 15 heads instead of 16.
1074 * Some drives can be jumpered to use 4092 cyls instead of 16383.
1075 */
1076 if ((id[ATA_ID_CYLS] == 16383 ||
1077 (id[ATA_ID_CYLS] == 4092 && id[ATA_ID_CUR_CYLS] == 16383)) &&
1078 id[ATA_ID_SECTORS] == 63 &&
1079 (id[ATA_ID_HEADS] == 15 || id[ATA_ID_HEADS] == 16) &&
1080 (lba_sects >= 16383 * 63 * id[ATA_ID_HEADS]))
4dce8ba9 1081 return true;
a02227c9
BZ		 1082
1083 chs_sects = id[ATA_ID_CYLS] * id[ATA_ID_HEADS] * id[ATA_ID_SECTORS];
1084
1085 /* perform a rough sanity check on lba_sects: within 10% is OK */
1086 if (lba_sects - chs_sects < chs_sects/10)
4dce8ba9 1087 return true;
a02227c9
BZ		 1088
1089 /* some drives have the word order reversed */
1090 head = (lba_sects >> 16) & 0xffff;
1091 tail = lba_sects & 0xffff;
1092 lba_sects = head | (tail << 16);
1093
1094 if (lba_sects - chs_sects < chs_sects/10) {
1095 *(__le32 *)&id[ATA_ID_LBA_CAPACITY] = __cpu_to_le32(lba_sects);
4dce8ba9 1096 return true; /* LBA capacity is (now) good */
a02227c9
BZ		 1097 }
1098
4dce8ba9 1099 return false; /* LBA capacity value may be bad */
a02227c9
BZ		 1100}
1101
93734a23
BZ		 1102static inline void ata_id_to_hd_driveid(u16 *id)
1103{
1104#ifdef __BIG_ENDIAN
1105 /* accessed in struct hd_driveid as 8-bit values */
1106 id[ATA_ID_MAX_MULTSECT] = __cpu_to_le16(id[ATA_ID_MAX_MULTSECT]);
1107 id[ATA_ID_CAPABILITY] = __cpu_to_le16(id[ATA_ID_CAPABILITY]);
1108 id[ATA_ID_OLD_PIO_MODES] = __cpu_to_le16(id[ATA_ID_OLD_PIO_MODES]);
1109 id[ATA_ID_OLD_DMA_MODES] = __cpu_to_le16(id[ATA_ID_OLD_DMA_MODES]);
1110 id[ATA_ID_MULTSECT] = __cpu_to_le16(id[ATA_ID_MULTSECT]);
1111
1112 /* as 32-bit values */
1113 *(u32 *)&id[ATA_ID_LBA_CAPACITY] = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
1114 *(u32 *)&id[ATA_ID_SPG] = ata_id_u32(id, ATA_ID_SPG);
1115
1116 /* as 64-bit value */
1117 *(u64 *)&id[ATA_ID_LBA_CAPACITY_2] =
1118 ata_id_u64(id, ATA_ID_LBA_CAPACITY_2);
1119#endif
1120}
1121
4dce8ba9 1122static inline bool ata_ok(u8 status)
1da177e4
LT		 1123{
1124 return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
1125 == ATA_DRDY);
1126}
1127
4dce8ba9 1128static inline bool lba_28_ok(u64 block, u32 n_block)
c6a33e24 1129{
45c4d015 1130 /* check the ending block number: must be LESS THAN 0x0fffffff */
35303d5c 1131 return ((block + n_block) < ((1 << 28) - 1)) && (n_block <= ATA_MAX_SECTORS);
c6a33e24
AL		 1132}
1133
4dce8ba9 1134static inline bool lba_48_ok(u64 block, u32 n_block)
c6a33e24
AL		 1135{
1136 /* check the ending block number */
35303d5c 1137 return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= ATA_MAX_SECTORS_LBA48);
c6a33e24
AL		 1138}
1139
814600ee
TH		 1140#define sata_pmp_gscr_vendor(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
1141#define sata_pmp_gscr_devid(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
1142#define sata_pmp_gscr_rev(gscr) (((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
1143#define sata_pmp_gscr_ports(gscr) ((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)
1144
1da177e4 1145#endif /* __LINUX_ATA_H__ */
Linux 6.x block layer and io_uring tree(s)