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