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