]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/ata.h
projects / mirror_ubuntu-bionic-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
libata: NCQ encapsulation for ZAC MANAGEMENT OUT
[mirror_ubuntu-bionic-kernel.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,
661ce1f0 246 ATA_CMD_NCQ_NON_DATA = 0x63,
ed36911c
MC		 247 ATA_CMD_FPDMA_SEND = 0x64,
248 ATA_CMD_FPDMA_RECV = 0x65,
1da177e4
LT		 249 ATA_CMD_PIO_READ = 0x20,
250 ATA_CMD_PIO_READ_EXT = 0x24,
251 ATA_CMD_PIO_WRITE = 0x30,
252 ATA_CMD_PIO_WRITE_EXT = 0x34,
8cbd6df1
AL		 253 ATA_CMD_READ_MULTI = 0xC4,
254 ATA_CMD_READ_MULTI_EXT = 0x29,
255 ATA_CMD_WRITE_MULTI = 0xC5,
256 ATA_CMD_WRITE_MULTI_EXT = 0x39,
9a3dccc4 257 ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
1da177e4 258 ATA_CMD_SET_FEATURES = 0xEF,
2c3d2a46 259 ATA_CMD_SET_MULTI = 0xC6,
1da177e4
LT		 260 ATA_CMD_PACKET = 0xA0,
261 ATA_CMD_VERIFY = 0x40,
262 ATA_CMD_VERIFY_EXT = 0x42,
6521148c 263 ATA_CMD_WRITE_UNCORR_EXT = 0x45,
2dcb407e
JG		 264 ATA_CMD_STANDBYNOW1 = 0xE0,
265 ATA_CMD_IDLEIMMEDIATE = 0xE1,
054a5fba 266 ATA_CMD_SLEEP = 0xE6,
8bf62ece 267 ATA_CMD_INIT_DEV_PARAMS = 0x91,
b6782728
AC		 268 ATA_CMD_READ_NATIVE_MAX = 0xF8,
269 ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
1e999736
AC		 270 ATA_CMD_SET_MAX = 0xF9,
271 ATA_CMD_SET_MAX_EXT = 0x37,
6521148c
RH		 272 ATA_CMD_READ_LOG_EXT = 0x2F,
273 ATA_CMD_WRITE_LOG_EXT = 0x3F,
274 ATA_CMD_READ_LOG_DMA_EXT = 0x47,
275 ATA_CMD_WRITE_LOG_DMA_EXT = 0x57,
3915c3b5 276 ATA_CMD_TRUSTED_NONDATA = 0x5B,
6521148c
RH		 277 ATA_CMD_TRUSTED_RCV = 0x5C,
278 ATA_CMD_TRUSTED_RCV_DMA = 0x5D,
279 ATA_CMD_TRUSTED_SND = 0x5E,
280 ATA_CMD_TRUSTED_SND_DMA = 0x5F,
814600ee 281 ATA_CMD_PMP_READ = 0xE4,
3915c3b5 282 ATA_CMD_PMP_READ_DMA = 0xE9,
814600ee 283 ATA_CMD_PMP_WRITE = 0xE8,
3915c3b5 284 ATA_CMD_PMP_WRITE_DMA = 0xEB,
ce2e0abb 285 ATA_CMD_CONF_OVERLAY = 0xB1,
6521148c
RH		 286 ATA_CMD_SEC_SET_PASS = 0xF1,
287 ATA_CMD_SEC_UNLOCK = 0xF2,
288 ATA_CMD_SEC_ERASE_PREP = 0xF3,
289 ATA_CMD_SEC_ERASE_UNIT = 0xF4,
ce2e0abb 290 ATA_CMD_SEC_FREEZE_LOCK = 0xF5,
6521148c
RH		 291 ATA_CMD_SEC_DISABLE_PASS = 0xF6,
292 ATA_CMD_CONFIG_STREAM = 0x51,
476d9894
BZ		 293 ATA_CMD_SMART = 0xB0,
294 ATA_CMD_MEDIA_LOCK = 0xDE,
295 ATA_CMD_MEDIA_UNLOCK = 0xDF,
0c659b82 296 ATA_CMD_DSM = 0x06,
6521148c
RH		 297 ATA_CMD_CHK_MED_CRD_TYP = 0xD1,
298 ATA_CMD_CFA_REQ_EXT_ERR = 0x03,
299 ATA_CMD_CFA_WRITE_NE = 0x38,
300 ATA_CMD_CFA_TRANS_SECT = 0x87,
301 ATA_CMD_CFA_ERASE = 0xC0,
302 ATA_CMD_CFA_WRITE_MULT_NE = 0xCD,
3915c3b5
RH		 303 ATA_CMD_REQ_SENSE_DATA = 0x0B,
304 ATA_CMD_SANITIZE_DEVICE = 0xB4,
28a3fc22 305 ATA_CMD_ZAC_MGMT_IN = 0x4A,
27708a95 306 ATA_CMD_ZAC_MGMT_OUT = 0x9F,
3915c3b5 307
476d9894
BZ		 308 /* marked obsolete in the ATA/ATAPI-7 spec */
309 ATA_CMD_RESTORE = 0x10,
88e49034 310
5c65d8bb
HR		 311 /* Subcmds for ATA_CMD_FPDMA_RECV */
312 ATA_SUBCMD_FPDMA_RECV_RD_LOG_DMA_EXT = 0x01,
28a3fc22 313 ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN = 0x02,
5c65d8bb 314
ed36911c
MC		 315 /* Subcmds for ATA_CMD_FPDMA_SEND */
316 ATA_SUBCMD_FPDMA_SEND_DSM = 0x00,
317 ATA_SUBCMD_FPDMA_SEND_WR_LOG_DMA_EXT = 0x02,
318
a5703849
HR		 319 /* Subcmds for ATA_CMD_NCQ_NON_DATA */
320 ATA_SUBCMD_NCQ_NON_DATA_ABORT_QUEUE = 0x00,
321 ATA_SUBCMD_NCQ_NON_DATA_SET_FEATURES = 0x05,
322 ATA_SUBCMD_NCQ_NON_DATA_ZERO_EXT = 0x06,
284b3b77 323 ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT = 0x07,
a5703849 324
28a3fc22
HR		 325 /* Subcmds for ATA_CMD_ZAC_MGMT_IN */
326 ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES = 0x00,
327
27708a95
HR		 328 /* Subcmds for ATA_CMD_ZAC_MGMT_OUT */
329 ATA_SUBCMD_ZAC_MGMT_OUT_CLOSE_ZONE = 0x01,
330 ATA_SUBCMD_ZAC_MGMT_OUT_FINISH_ZONE = 0x02,
331 ATA_SUBCMD_ZAC_MGMT_OUT_OPEN_ZONE = 0x03,
332 ATA_SUBCMD_ZAC_MGMT_OUT_RESET_WRITE_POINTER = 0x04,
333
88e49034 334 /* READ_LOG_EXT pages */
fe5af0cc 335 ATA_LOG_DIRECTORY = 0x0,
88e49034 336 ATA_LOG_SATA_NCQ = 0x10,
284b3b77 337 ATA_LOG_NCQ_NON_DATA = 0x12,
ed36911c 338 ATA_LOG_NCQ_SEND_RECV = 0x13,
65fe1f0f
SH		 339 ATA_LOG_SATA_ID_DEV_DATA = 0x30,
340 ATA_LOG_SATA_SETTINGS = 0x08,
803739d2
SH		 341 ATA_LOG_DEVSLP_OFFSET = 0x30,
342 ATA_LOG_DEVSLP_SIZE = 0x08,
343 ATA_LOG_DEVSLP_MDAT = 0x00,
65fe1f0f 344 ATA_LOG_DEVSLP_MDAT_MASK = 0x1F,
803739d2
SH		 345 ATA_LOG_DEVSLP_DETO = 0x01,
346 ATA_LOG_DEVSLP_VALID = 0x07,
65fe1f0f 347 ATA_LOG_DEVSLP_VALID_MASK = 0x80,
1da177e4 348
ed36911c
MC		 349 /* NCQ send and receive log */
350 ATA_LOG_NCQ_SEND_RECV_SUBCMDS_OFFSET = 0x00,
351 ATA_LOG_NCQ_SEND_RECV_SUBCMDS_DSM = (1 << 0),
352 ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET = 0x04,
353 ATA_LOG_NCQ_SEND_RECV_DSM_TRIM = (1 << 0),
354 ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET = 0x08,
5c65d8bb 355 ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED = (1 << 0),
ed36911c 356 ATA_LOG_NCQ_SEND_RECV_WR_LOG_OFFSET = 0x0C,
5c65d8bb 357 ATA_LOG_NCQ_SEND_RECV_WR_LOG_SUPPORTED = (1 << 0),
28a3fc22
HR		 358 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OFFSET = 0x10,
359 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OUT_SUPPORTED = (1 << 0),
360 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED = (1 << 1),
361 ATA_LOG_NCQ_SEND_RECV_SIZE = 0x14,
ed36911c 362
a5703849
HR		 363 /* NCQ Non-Data log */
364 ATA_LOG_NCQ_NON_DATA_SUBCMDS_OFFSET = 0x00,
365 ATA_LOG_NCQ_NON_DATA_ABORT_OFFSET = 0x00,
366 ATA_LOG_NCQ_NON_DATA_ABORT_NCQ = (1 << 0),
367 ATA_LOG_NCQ_NON_DATA_ABORT_ALL = (1 << 1),
368 ATA_LOG_NCQ_NON_DATA_ABORT_STREAMING = (1 << 2),
369 ATA_LOG_NCQ_NON_DATA_ABORT_NON_STREAMING = (1 << 3),
370 ATA_LOG_NCQ_NON_DATA_ABORT_SELECTED = (1 << 4),
371 ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET = 0x1C,
372 ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT = (1 << 0),
373 ATA_LOG_NCQ_NON_DATA_SIZE = 0x40,
374
5a5dbd18
ML		 375 /* READ/WRITE LONG (obsolete) */
376 ATA_CMD_READ_LONG = 0x22,
377 ATA_CMD_READ_LONG_ONCE = 0x23,
378 ATA_CMD_WRITE_LONG = 0x32,
379 ATA_CMD_WRITE_LONG_ONCE = 0x33,
380
1da177e4
LT		 381 /* SETFEATURES stuff */
382 SETFEATURES_XFER = 0x03,
383 XFER_UDMA_7 = 0x47,
384 XFER_UDMA_6 = 0x46,
385 XFER_UDMA_5 = 0x45,
386 XFER_UDMA_4 = 0x44,
387 XFER_UDMA_3 = 0x43,
388 XFER_UDMA_2 = 0x42,
389 XFER_UDMA_1 = 0x41,
390 XFER_UDMA_0 = 0x40,
b352e57d
AC		 391 XFER_MW_DMA_4 = 0x24, /* CFA only */
392 XFER_MW_DMA_3 = 0x23, /* CFA only */
1da177e4
LT		 393 XFER_MW_DMA_2 = 0x22,
394 XFER_MW_DMA_1 = 0x21,
395 XFER_MW_DMA_0 = 0x20,
b4b52db7
AC		 396 XFER_SW_DMA_2 = 0x12,
397 XFER_SW_DMA_1 = 0x11,
398 XFER_SW_DMA_0 = 0x10,
b352e57d
AC		 399 XFER_PIO_6 = 0x0E, /* CFA only */
400 XFER_PIO_5 = 0x0D, /* CFA only */
1da177e4
LT		 401 XFER_PIO_4 = 0x0C,
402 XFER_PIO_3 = 0x0B,
403 XFER_PIO_2 = 0x0A,
404 XFER_PIO_1 = 0x09,
405 XFER_PIO_0 = 0x08,
1da177e4
LT		 406 XFER_PIO_SLOW = 0x00,
407
3057ac3c 408 SETFEATURES_WC_ON = 0x02, /* Enable write cache */
409 SETFEATURES_WC_OFF = 0x82, /* Disable write cache */
410
476d9894
BZ		 411 /* Enable/Disable Automatic Acoustic Management */
412 SETFEATURES_AAM_ON = 0x42,
413 SETFEATURES_AAM_OFF = 0xC2,
414
169439c2
ML		 415 SETFEATURES_SPINUP = 0x07, /* Spin-up drive */
416
9f45cbd3
KCA		 417 SETFEATURES_SATA_ENABLE = 0x10, /* Enable use of SATA feature */
418 SETFEATURES_SATA_DISABLE = 0x90, /* Disable use of SATA feature */
419
420 /* SETFEATURE Sector counts for SATA features */
fa5b561c 421 SATA_FPDMA_OFFSET = 0x01, /* FPDMA non-zero buffer offsets */
f1bce7f8
TH		 422 SATA_FPDMA_AA = 0x02, /* FPDMA Setup FIS Auto-Activate */
423 SATA_DIPM = 0x03, /* Device Initiated Power Management */
fa5b561c 424 SATA_FPDMA_IN_ORDER = 0x04, /* FPDMA in-order data delivery */
f1bce7f8 425 SATA_AN = 0x05, /* Asynchronous Notification */
fa5b561c 426 SATA_SSP = 0x06, /* Software Settings Preservation */
65fe1f0f 427 SATA_DEVSLP = 0x09, /* Device Sleep */
9f45cbd3 428
e87fd28c
HR		 429 SETFEATURE_SENSE_DATA = 0xC3, /* Sense Data Reporting feature */
430
ce2e0abb
TH		 431 /* feature values for SET_MAX */
432 ATA_SET_MAX_ADDR = 0x00,
433 ATA_SET_MAX_PASSWD = 0x01,
434 ATA_SET_MAX_LOCK = 0x02,
435 ATA_SET_MAX_UNLOCK = 0x03,
436 ATA_SET_MAX_FREEZE_LOCK = 0x04,
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
520enum ata_tf_protocols {
521 /* ATA taskfile protocols */
522 ATA_PROT_UNKNOWN, /* unknown/invalid */
523 ATA_PROT_NODATA, /* no data */
1dce589c 524 ATA_PROT_PIO, /* PIO data xfer */
1da177e4 525 ATA_PROT_DMA, /* DMA */
88e49034 526 ATA_PROT_NCQ, /* NCQ */
0dc36888
TH		 527 ATAPI_PROT_NODATA, /* packet command, no data */
528 ATAPI_PROT_PIO, /* packet command, PIO data xfer*/
529 ATAPI_PROT_DMA, /* packet command with special DMA sauce */
1da177e4
LT		 530};
531
532enum ata_ioctls {
287e6611
AB		 533 ATA_IOC_GET_IO32 = 0x309, /* HDIO_GET_32BIT */
534 ATA_IOC_SET_IO32 = 0x324, /* HDIO_SET_32BIT */
1da177e4
LT		 535};
536
537/* core structures */
538
f60d7011 539struct ata_bmdma_prd {
4ca4e439
AV		 540 __le32 addr;
541 __le32 flags_len;
1da177e4
LT		 542};
543
405e66b3
TH		 544/*
545 * id tests
546 */
37014c64
BZ		 547#define ata_id_is_ata(id) (((id)[ATA_ID_CONFIG] & (1 << 15)) == 0)
548#define ata_id_has_lba(id) ((id)[ATA_ID_CAPABILITY] & (1 << 9))
549#define ata_id_has_dma(id) ((id)[ATA_ID_CAPABILITY] & (1 << 8))
583661a8 550#define ata_id_has_ncq(id) ((id)[ATA_ID_SATA_CAPABILITY] & (1 << 8))
37014c64 551#define ata_id_queue_depth(id) (((id)[ATA_ID_QUEUE_DEPTH] & 0x1f) + 1)
0628ee7c 552#define ata_id_removable(id) ((id)[ATA_ID_CONFIG] & (1 << 7))
854c73a2 553#define ata_id_has_atapi_AN(id) \
583661a8
SH		 554 ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
555 ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
556 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 5)))
388539f3 557#define ata_id_has_fpdma_aa(id) \
583661a8
SH		 558 ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
559 ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
560 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 2)))
37014c64
BZ		 561#define ata_id_iordy_disable(id) ((id)[ATA_ID_CAPABILITY] & (1 << 10))
562#define ata_id_has_iordy(id) ((id)[ATA_ID_CAPABILITY] & (1 << 11))
1da177e4
LT		 563#define ata_id_u32(id,n) \
564 (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
565#define ata_id_u64(id,n) \
566 ( ((u64) (id)[(n) + 3] << 48) | \
567 ((u64) (id)[(n) + 2] << 32) | \
568 ((u64) (id)[(n) + 1] << 16) | \
569 ((u64) (id)[(n) + 0]) )
570
37014c64 571#define ata_id_cdb_intr(id) (((id)[ATA_ID_CONFIG] & 0x60) == 0x20)
583661a8 572#define ata_id_has_da(id) ((id)[ATA_ID_SATA_CAPABILITY_2] & (1 << 4))
65fe1f0f 573#define ata_id_has_devslp(id) ((id)[ATA_ID_FEATURE_SUPP] & (1 << 8))
5b01e4b9
HR		 574#define ata_id_has_ncq_autosense(id) \
575 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 7))
312f7da2 576
ca77329f
KCA		 577static inline bool ata_id_has_hipm(const u16 *id)
578{
583661a8 579 u16 val = id[ATA_ID_SATA_CAPABILITY];
ca77329f
KCA		 580
581 if (val == 0 || val == 0xffff)
582 return false;
583
584 return val & (1 << 9);
585}
586
587static inline bool ata_id_has_dipm(const u16 *id)
588{
583661a8 589 u16 val = id[ATA_ID_FEATURE_SUPP];
ca77329f
KCA		 590
591 if (val == 0 || val == 0xffff)
592 return false;
593
594 return val & (1 << 3);
595}
596
ae8d4ee7 597
4dce8ba9 598static inline bool ata_id_has_fua(const u16 *id)
c7293870 599{
37014c64 600 if ((id[ATA_ID_CFSSE] & 0xC000) != 0x4000)
4dce8ba9 601 return false;
37014c64 602 return id[ATA_ID_CFSSE] & (1 << 6);
c7293870
AC		 603}
604
4dce8ba9 605static inline bool ata_id_has_flush(const u16 *id)
c7293870 606{
37014c64 607 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
4dce8ba9 608 return false;
37014c64 609 return id[ATA_ID_COMMAND_SET_2] & (1 << 12);
c7293870
AC		 610}
611
4dce8ba9 612static inline bool ata_id_flush_enabled(const u16 *id)
4b58f17d
BZ		 613{
614 if (ata_id_has_flush(id) == 0)
4dce8ba9 615 return false;
4b58f17d 616 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
4dce8ba9 617 return false;
4b58f17d
BZ		 618 return id[ATA_ID_CFS_ENABLE_2] & (1 << 12);
619}
620
4dce8ba9 621static inline bool ata_id_has_flush_ext(const u16 *id)
c7293870 622{
37014c64 623 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
4dce8ba9 624 return false;
37014c64 625 return id[ATA_ID_COMMAND_SET_2] & (1 << 13);
c7293870
AC		 626}
627
4dce8ba9 628static inline bool ata_id_flush_ext_enabled(const u16 *id)
ff2779b5
BZ		 629{
630 if (ata_id_has_flush_ext(id) == 0)
4dce8ba9 631 return false;
ff2779b5 632 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
4dce8ba9 633 return false;
ff2779b5
BZ		 634 /*
635 * some Maxtor disks have bit 13 defined incorrectly
636 * so check bit 10 too
637 */
638 return (id[ATA_ID_CFS_ENABLE_2] & 0x2400) == 0x2400;
639}
640
295124dc 641static inline u32 ata_id_logical_sector_size(const u16 *id)
18f0f978 642{
295124dc
GG		 643 /* T13/1699-D Revision 6a, Sep 6, 2008. Page 128.
644 * IDENTIFY DEVICE data, word 117-118.
645 * 0xd000 ignores bit 13 (logical:physical > 1)
646 */
647 if ((id[ATA_ID_SECTOR_SIZE] & 0xd000) == 0x5000)
648 return (((id[ATA_ID_LOGICAL_SECTOR_SIZE+1] << 16)
649 + id[ATA_ID_LOGICAL_SECTOR_SIZE]) * sizeof(u16)) ;
650 return ATA_SECT_SIZE;
651}
652
653static inline u8 ata_id_log2_per_physical_sector(const u16 *id)
654{
655 /* T13/1699-D Revision 6a, Sep 6, 2008. Page 128.
656 * IDENTIFY DEVICE data, word 106.
657 * 0xe000 ignores bit 12 (logical sector > 512 bytes)
658 */
659 if ((id[ATA_ID_SECTOR_SIZE] & 0xe000) == 0x6000)
660 return (id[ATA_ID_SECTOR_SIZE] & 0xf);
661 return 0;
18f0f978
CH		 662}
663
295124dc
GG		 664/* Offset of logical sectors relative to physical sectors.
665 *
666 * If device has more than one logical sector per physical sector
667 * (aka 512 byte emulation), vendors might offset the "sector 0" address
668 * so sector 63 is "naturally aligned" - e.g. FAT partition table.
669 * This avoids Read/Mod/Write penalties when using FAT partition table
670 * and updating "well aligned" (FS perspective) physical sectors on every
671 * transaction.
672 */
673static inline u16 ata_id_logical_sector_offset(const u16 *id,
674 u8 log2_per_phys)
18f0f978 675{
295124dc
GG		 676 u16 word_209 = id[209];
677
678 if ((log2_per_phys > 1) && (word_209 & 0xc000) == 0x4000) {
679 u16 first = word_209 & 0x3fff;
680 if (first > 0)
681 return (1 << log2_per_phys) - first;
682 }
683 return 0;
18f0f978
CH		 684}
685
4dce8ba9 686static inline bool ata_id_has_lba48(const u16 *id)
c7293870 687{
37014c64 688 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
4dce8ba9 689 return false;
37014c64 690 if (!ata_id_u64(id, ATA_ID_LBA_CAPACITY_2))
4dce8ba9 691 return false;
37014c64 692 return id[ATA_ID_COMMAND_SET_2] & (1 << 10);
c7293870
AC		 693}
694
4dce8ba9 695static inline bool ata_id_lba48_enabled(const u16 *id)
942dcd85
BZ		 696{
697 if (ata_id_has_lba48(id) == 0)
4dce8ba9 698 return false;
942dcd85 699 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
4dce8ba9 700 return false;
942dcd85
BZ		 701 return id[ATA_ID_CFS_ENABLE_2] & (1 << 10);
702}
703
4dce8ba9 704static inline bool ata_id_hpa_enabled(const u16 *id)
c7293870
AC		 705{
706 /* Yes children, word 83 valid bits cover word 82 data */
37014c64 707 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
4dce8ba9 708 return false;
c7293870 709 /* And 87 covers 85-87 */
37014c64 710 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
4dce8ba9 711 return false;
c7293870 712 /* Check command sets enabled as well as supported */
37014c64 713 if ((id[ATA_ID_CFS_ENABLE_1] & (1 << 10)) == 0)
4dce8ba9 714 return false;
37014c64 715 return id[ATA_ID_COMMAND_SET_1] & (1 << 10);
c7293870
AC		 716}
717
4dce8ba9 718static inline bool ata_id_has_wcache(const u16 *id)
c7293870
AC		 719{
720 /* Yes children, word 83 valid bits cover word 82 data */
37014c64 721 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
4dce8ba9 722 return false;
37014c64 723 return id[ATA_ID_COMMAND_SET_1] & (1 << 5);
c7293870
AC		 724}
725
4dce8ba9 726static inline bool ata_id_has_pm(const u16 *id)
c7293870 727{
37014c64 728 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
4dce8ba9 729 return false;
37014c64 730 return id[ATA_ID_COMMAND_SET_1] & (1 << 3);
c7293870
AC		 731}
732
4dce8ba9 733static inline bool ata_id_rahead_enabled(const u16 *id)
c7293870 734{
37014c64 735 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
4dce8ba9 736 return false;
37014c64 737 return id[ATA_ID_CFS_ENABLE_1] & (1 << 6);
c7293870
AC		 738}
739
4dce8ba9 740static inline bool ata_id_wcache_enabled(const u16 *id)
c7293870 741{
37014c64 742 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
4dce8ba9 743 return false;
37014c64 744 return id[ATA_ID_CFS_ENABLE_1] & (1 << 5);
c7293870
AC		 745}
746
9faa6438
HR		 747static inline bool ata_id_has_read_log_dma_ext(const u16 *id)
748{
406c057c 749 /* Word 86 must have bit 15 set */
9faa6438
HR		 750 if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
751 return false;
406c057c
MP		 752
753 /* READ LOG DMA EXT support can be signaled either from word 119
754 * or from word 120. The format is the same for both words: Bit
755 * 15 must be cleared, bit 14 set and bit 3 set.
756 */
757 if ((id[ATA_ID_COMMAND_SET_3] & 0xC008) == 0x4008 ||
758 (id[ATA_ID_COMMAND_SET_4] & 0xC008) == 0x4008)
759 return true;
760
761 return false;
9faa6438
HR		 762}
763
e87fd28c
HR		 764static inline bool ata_id_has_sense_reporting(const u16 *id)
765{
766 if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
767 return false;
768 return id[ATA_ID_COMMAND_SET_3] & (1 << 6);
769}
770
771static inline bool ata_id_sense_reporting_enabled(const u16 *id)
772{
773 if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
774 return false;
775 return id[ATA_ID_COMMAND_SET_4] & (1 << 6);
776}
777
c7293870
AC		 778/**
779 * ata_id_major_version - get ATA level of drive
780 * @id: Identify data
781 *
782 * Caveats:
783 * ATA-1 considers identify optional
784 * ATA-2 introduces mandatory identify
785 * ATA-3 introduces word 80 and accurate reporting
786 *
787 * The practical impact of this is that ata_id_major_version cannot
2dcb407e 788 * reliably report on drives below ATA3.
c7293870
AC		 789 */
790
3d2ca910
TH		 791static inline unsigned int ata_id_major_version(const u16 *id)
792{
793 unsigned int mver;
794
b352e57d
AC		 795 if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
796 return 0;
797
3d2ca910
TH		 798 for (mver = 14; mver >= 1; mver--)
799 if (id[ATA_ID_MAJOR_VER] & (1 << mver))
800 break;
801 return mver;
802}
803
4dce8ba9 804static inline bool ata_id_is_sata(const u16 *id)
32d90911 805{
367d7e78
BZ		 806 /*
807 * See if word 93 is 0 AND drive is at least ATA-5 compatible
808 * verifying that word 80 by casting it to a signed type --
809 * this trick allows us to filter out the reserved values of
810 * 0x0000 and 0xffff along with the earlier ATA revisions...
811 */
812 if (id[ATA_ID_HW_CONFIG] == 0 && (short)id[ATA_ID_MAJOR_VER] >= 0x0020)
4dce8ba9
HR		 813 return true;
814 return false;
32d90911
TH		 815}
816
4dce8ba9 817static inline bool ata_id_has_tpm(const u16 *id)
ae8d4ee7
AC		 818{
819 /* The TPM bits are only valid on ATA8 */
820 if (ata_id_major_version(id) < 8)
4dce8ba9 821 return false;
ae8d4ee7 822 if ((id[48] & 0xC000) != 0x4000)
4dce8ba9 823 return false;
ae8d4ee7
AC		 824 return id[48] & (1 << 0);
825}
826
4dce8ba9 827static inline bool ata_id_has_dword_io(const u16 *id)
ae8d4ee7
AC		 828{
829 /* ATA 8 reuses this flag for "trusted" computing */
830 if (ata_id_major_version(id) > 7)
4dce8ba9
HR		 831 return false;
832 return id[ATA_ID_DWORD_IO] & (1 << 0);
ae8d4ee7
AC		 833}
834
4dce8ba9 835static inline bool ata_id_has_unload(const u16 *id)
ea6ce53c
EO		 836{
837 if (ata_id_major_version(id) >= 7 &&
838 (id[ATA_ID_CFSSE] & 0xC000) == 0x4000 &&
839 id[ATA_ID_CFSSE] & (1 << 13))
4dce8ba9
HR		 840 return true;
841 return false;
ea6ce53c
EO		 842}
843
6b3b9d73
HR		 844static inline bool ata_id_has_wwn(const u16 *id)
845{
846 return (id[ATA_ID_CSF_DEFAULT] & 0xC100) == 0x4100;
847}
848
4bca3286
MP		 849static inline int ata_id_form_factor(const u16 *id)
850{
851 u16 val = id[168];
852
853 if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
854 return 0;
855
856 val &= 0xf;
857
858 if (val > 5)
859 return 0;
860
861 return val;
862}
863
864static inline int ata_id_rotation_rate(const u16 *id)
865{
866 u16 val = id[217];
867
868 if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
869 return 0;
870
871 if (val > 1 && val < 0x401)
872 return 0;
873
874 return val;
875}
876
ed36911c
MC		 877static inline bool ata_id_has_ncq_send_and_recv(const u16 *id)
878{
879 return id[ATA_ID_SATA_CAPABILITY_2] & BIT(6);
880}
881
284b3b77
HR		 882static inline bool ata_id_has_ncq_non_data(const u16 *id)
883{
884 return id[ATA_ID_SATA_CAPABILITY_2] & BIT(5);
885}
886
4dce8ba9 887static inline bool ata_id_has_trim(const u16 *id)
0c659b82
MW		 888{
889 if (ata_id_major_version(id) >= 7 &&
890 (id[ATA_ID_DATA_SET_MGMT] & 1))
4dce8ba9
HR		 891 return true;
892 return false;
0c659b82
MW		 893}
894
4dce8ba9 895static inline bool ata_id_has_zero_after_trim(const u16 *id)
e78db4df
MP		 896{
897 /* DSM supported, deterministic read, and read zero after trim set */
898 if (ata_id_has_trim(id) &&
899 (id[ATA_ID_ADDITIONAL_SUPP] & 0x4020) == 0x4020)
4dce8ba9 900 return true;
e78db4df 901
4dce8ba9 902 return false;
e78db4df
MP		 903}
904
4dce8ba9 905static inline bool ata_id_current_chs_valid(const u16 *id)
8bf62ece 906{
9bec2e38
JG		 907 /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
908 has not been issued to the device then the values of
37014c64
BZ		 909 id[ATA_ID_CUR_CYLS] to id[ATA_ID_CUR_SECTORS] are vendor specific. */
910 return (id[ATA_ID_FIELD_VALID] & 1) && /* Current translation valid */
911 id[ATA_ID_CUR_CYLS] && /* cylinders in current translation */
912 id[ATA_ID_CUR_HEADS] && /* heads in current translation */
913 id[ATA_ID_CUR_HEADS] <= 16 &&
914 id[ATA_ID_CUR_SECTORS]; /* sectors in current translation */
8bf62ece
AL		 915}
916
4dce8ba9 917static inline bool ata_id_is_cfa(const u16 *id)
b352e57d 918{
4b7d1c05
BG		 919 if ((id[ATA_ID_CONFIG] == 0x848A) || /* Traditional CF */
920 (id[ATA_ID_CONFIG] == 0x844A)) /* Delkin Devices CF */
4dce8ba9 921 return true;
2999b58b
SS		 922 /*
923 * CF specs don't require specific value in the word 0 anymore and yet
924 * they forbid to report the ATA version in the word 80 and require the
925 * CFA feature set support to be indicated in the word 83 in this case.
926 * Unfortunately, some cards only follow either of this requirements,
927 * and while those that don't indicate CFA feature support need some
928 * sort of quirk list, it seems impractical for the ones that do...
929 */
4dce8ba9 930 return (id[ATA_ID_COMMAND_SET_2] & 0xC004) == 0x4004;
b352e57d
AC		 931}
932
4dce8ba9 933static inline bool ata_id_is_ssd(const u16 *id)
8bff7c6b
JA		 934{
935 return id[ATA_ID_ROT_SPEED] == 0x01;
936}
937
4dce8ba9 938static inline bool ata_id_pio_need_iordy(const u16 *id, const u8 pio)
6dae44f9
BZ		 939{
940 /* CF spec. r4.1 Table 22 says no IORDY on PIO5 and PIO6. */
941 if (pio > 4 && ata_id_is_cfa(id))
4dce8ba9 942 return false;
6dae44f9
BZ		 943 /* For PIO3 and higher it is mandatory. */
944 if (pio > 2)
4dce8ba9 945 return true;
6dae44f9 946 /* Turn it on when possible. */
4dce8ba9 947 return ata_id_has_iordy(id);
6dae44f9
BZ		 948}
949
4dce8ba9 950static inline bool ata_drive_40wire(const u16 *dev_id)
fc085150 951{
32d90911 952 if (ata_id_is_sata(dev_id))
4dce8ba9 953 return false; /* SATA */
37014c64 954 if ((dev_id[ATA_ID_HW_CONFIG] & 0xE000) == 0x6000)
4dce8ba9
HR		 955 return false; /* 80 wire */
956 return true;
fc085150
AC		 957}
958
4dce8ba9 959static inline bool ata_drive_40wire_relaxed(const u16 *dev_id)
6bbfd53d 960{
37014c64 961 if ((dev_id[ATA_ID_HW_CONFIG] & 0x2000) == 0x2000)
4dce8ba9
HR		 962 return false; /* 80 wire */
963 return true;
6bbfd53d
AC		 964}
965
057ace5e 966static inline int atapi_cdb_len(const u16 *dev_id)
1da177e4 967{
37014c64 968 u16 tmp = dev_id[ATA_ID_CONFIG] & 0x3;
1da177e4
LT		 969 switch (tmp) {
970 case 0: return 12;
971 case 1: return 16;
972 default: return -1;
973 }
974}
975
d8668fcb 976static inline int atapi_command_packet_set(const u16 *dev_id)
f8d8e579 977{
37014c64 978 return (dev_id[ATA_ID_CONFIG] >> 8) & 0x1f;
f8d8e579
TB		 979}
980
4dce8ba9 981static inline bool atapi_id_dmadir(const u16 *dev_id)
91163006
TH		 982{
983 return ata_id_major_version(dev_id) >= 7 && (dev_id[62] & 0x8000);
984}
985
a02227c9
BZ		 986/*
987 * ata_id_is_lba_capacity_ok() performs a sanity check on
988 * the claimed LBA capacity value for the device.
989 *
990 * Returns 1 if LBA capacity looks sensible, 0 otherwise.
991 *
992 * It is called only once for each device.
993 */
4dce8ba9 994static inline bool ata_id_is_lba_capacity_ok(u16 *id)
a02227c9
BZ		 995{
996 unsigned long lba_sects, chs_sects, head, tail;
997
998 /* No non-LBA info .. so valid! */
999 if (id[ATA_ID_CYLS] == 0)
4dce8ba9 1000 return true;
a02227c9
BZ		 1001
1002 lba_sects = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
1003
1004 /*
1005 * The ATA spec tells large drives to return
1006 * C/H/S = 16383/16/63 independent of their size.
1007 * Some drives can be jumpered to use 15 heads instead of 16.
1008 * Some drives can be jumpered to use 4092 cyls instead of 16383.
1009 */
1010 if ((id[ATA_ID_CYLS] == 16383 ||
1011 (id[ATA_ID_CYLS] == 4092 && id[ATA_ID_CUR_CYLS] == 16383)) &&
1012 id[ATA_ID_SECTORS] == 63 &&
1013 (id[ATA_ID_HEADS] == 15 || id[ATA_ID_HEADS] == 16) &&
1014 (lba_sects >= 16383 * 63 * id[ATA_ID_HEADS]))
4dce8ba9 1015 return true;
a02227c9
BZ		 1016
1017 chs_sects = id[ATA_ID_CYLS] * id[ATA_ID_HEADS] * id[ATA_ID_SECTORS];
1018
1019 /* perform a rough sanity check on lba_sects: within 10% is OK */
1020 if (lba_sects - chs_sects < chs_sects/10)
4dce8ba9 1021 return true;
a02227c9
BZ		 1022
1023 /* some drives have the word order reversed */
1024 head = (lba_sects >> 16) & 0xffff;
1025 tail = lba_sects & 0xffff;
1026 lba_sects = head | (tail << 16);
1027
1028 if (lba_sects - chs_sects < chs_sects/10) {
1029 *(__le32 *)&id[ATA_ID_LBA_CAPACITY] = __cpu_to_le32(lba_sects);
4dce8ba9 1030 return true; /* LBA capacity is (now) good */
a02227c9
BZ		 1031 }
1032
4dce8ba9 1033 return false; /* LBA capacity value may be bad */
a02227c9
BZ		 1034}
1035
93734a23
BZ		 1036static inline void ata_id_to_hd_driveid(u16 *id)
1037{
1038#ifdef __BIG_ENDIAN
1039 /* accessed in struct hd_driveid as 8-bit values */
1040 id[ATA_ID_MAX_MULTSECT] = __cpu_to_le16(id[ATA_ID_MAX_MULTSECT]);
1041 id[ATA_ID_CAPABILITY] = __cpu_to_le16(id[ATA_ID_CAPABILITY]);
1042 id[ATA_ID_OLD_PIO_MODES] = __cpu_to_le16(id[ATA_ID_OLD_PIO_MODES]);
1043 id[ATA_ID_OLD_DMA_MODES] = __cpu_to_le16(id[ATA_ID_OLD_DMA_MODES]);
1044 id[ATA_ID_MULTSECT] = __cpu_to_le16(id[ATA_ID_MULTSECT]);
1045
1046 /* as 32-bit values */
1047 *(u32 *)&id[ATA_ID_LBA_CAPACITY] = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
1048 *(u32 *)&id[ATA_ID_SPG] = ata_id_u32(id, ATA_ID_SPG);
1049
1050 /* as 64-bit value */
1051 *(u64 *)&id[ATA_ID_LBA_CAPACITY_2] =
1052 ata_id_u64(id, ATA_ID_LBA_CAPACITY_2);
1053#endif
1054}
1055
0c659b82 1056/*
d0634c4a
MP		 1057 * Write LBA Range Entries to the buffer that will cover the extent from
1058 * sector to sector + count. This is used for TRIM and for ADD LBA(S)
1059 * TO NV CACHE PINNED SET.
0c659b82 1060 */
d0634c4a
MP		 1061static inline unsigned ata_set_lba_range_entries(void *_buffer,
1062 unsigned buf_size, u64 sector, unsigned long count)
0c659b82
MW		 1063{
1064 __le64 *buffer = _buffer;
d0634c4a 1065 unsigned i = 0, used_bytes;
0c659b82 1066
d0634c4a 1067 while (i < buf_size / 8 ) { /* 6-byte LBA + 2-byte range per entry */
0c659b82
MW		 1068 u64 entry = sector |
1069 ((u64)(count > 0xffff ? 0xffff : count) << 48);
1070 buffer[i++] = __cpu_to_le64(entry);
1071 if (count <= 0xffff)
1072 break;
1073 count -= 0xffff;
1074 sector += 0xffff;
1075 }
1076
d0634c4a
MP		 1077 used_bytes = ALIGN(i * 8, 512);
1078 memset(buffer + i, 0, used_bytes - i * 8);
1079 return used_bytes;
0c659b82
MW		 1080}
1081
4dce8ba9 1082static inline bool ata_ok(u8 status)
1da177e4
LT		 1083{
1084 return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
1085 == ATA_DRDY);
1086}
1087
4dce8ba9 1088static inline bool lba_28_ok(u64 block, u32 n_block)
c6a33e24 1089{
45c4d015
ML		 1090 /* check the ending block number: must be LESS THAN 0x0fffffff */
1091 return ((block + n_block) < ((1 << 28) - 1)) && (n_block <= 256);
c6a33e24
AL		 1092}
1093
4dce8ba9 1094static inline bool lba_48_ok(u64 block, u32 n_block)
c6a33e24
AL		 1095{
1096 /* check the ending block number */
1097 return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536);
1098}
1099
814600ee
TH		 1100#define sata_pmp_gscr_vendor(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
1101#define sata_pmp_gscr_devid(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
1102#define sata_pmp_gscr_rev(gscr) (((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
1103#define sata_pmp_gscr_ports(gscr) ((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)
1104
1da177e4 1105#endif /* __LINUX_ATA_H__ */
ubuntu-bionic-kernel mirror