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