]> 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
ata: add missing ATA_CMD_* defines
[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
32#include <linux/types.h>
33
34/* defines only for the constants which don't work well as enums */
35#define ATA_DMA_BOUNDARY 0xffffUL
36#define ATA_DMA_MASK 0xffffffffULL
37
38enum {
39 /* various global constants */
40 ATA_MAX_DEVICES = 2, /* per bus/port */
41 ATA_MAX_PRD = 256, /* we could make these 256/256 */
42 ATA_SECT_SIZE = 512,
18d6e9d5 43 ATA_MAX_SECTORS_128 = 128,
8b881b04
JG		 44 ATA_MAX_SECTORS = 256,
45 ATA_MAX_SECTORS_LBA48 = 65535,/* TODO: 65536? */
f8d8e579 46 ATA_MAX_SECTORS_TAPE = 65535,
1da177e4
LT		 47
48 ATA_ID_WORDS = 256,
37014c64
BZ		 49 ATA_ID_CONFIG = 0,
50 ATA_ID_CYLS = 1,
51 ATA_ID_HEADS = 3,
52 ATA_ID_SECTORS = 6,
a0cf733b 53 ATA_ID_SERNO = 10,
37014c64 54 ATA_ID_BUF_SIZE = 21,
a0cf733b
TH		 55 ATA_ID_FW_REV = 23,
56 ATA_ID_PROD = 27,
37014c64
BZ		 57 ATA_ID_MAX_MULTSECT = 47,
58 ATA_ID_DWORD_IO = 48,
59 ATA_ID_CAPABILITY = 49,
11e29e21 60 ATA_ID_OLD_PIO_MODES = 51,
37014c64 61 ATA_ID_OLD_DMA_MODES = 52,
11e29e21 62 ATA_ID_FIELD_VALID = 53,
37014c64
BZ		 63 ATA_ID_CUR_CYLS = 54,
64 ATA_ID_CUR_HEADS = 55,
65 ATA_ID_CUR_SECTORS = 56,
66 ATA_ID_MULTSECT = 59,
67 ATA_ID_LBA_CAPACITY = 60,
68 ATA_ID_SWDMA_MODES = 62,
1da177e4 69 ATA_ID_MWDMA_MODES = 63,
11e29e21
AC		 70 ATA_ID_PIO_MODES = 64,
71 ATA_ID_EIDE_DMA_MIN = 65,
37014c64 72 ATA_ID_EIDE_DMA_TIME = 66,
11e29e21
AC		 73 ATA_ID_EIDE_PIO = 67,
74 ATA_ID_EIDE_PIO_IORDY = 68,
37014c64 75 ATA_ID_QUEUE_DEPTH = 75,
11e29e21 76 ATA_ID_MAJOR_VER = 80,
37014c64
BZ		 77 ATA_ID_COMMAND_SET_1 = 82,
78 ATA_ID_COMMAND_SET_2 = 83,
79 ATA_ID_CFSSE = 84,
80 ATA_ID_CFS_ENABLE_1 = 85,
81 ATA_ID_CFS_ENABLE_2 = 86,
82 ATA_ID_CSF_DEFAULT = 87,
83 ATA_ID_UDMA_MODES = 88,
84 ATA_ID_HW_CONFIG = 93,
85 ATA_ID_SPG = 98,
86 ATA_ID_LBA_CAPACITY_2 = 100,
87 ATA_ID_LAST_LUN = 126,
88 ATA_ID_DLF = 128,
89 ATA_ID_CSFO = 129,
90 ATA_ID_CFA_POWER = 160,
1da177e4
LT		 91 ATA_ID_PIO4 = (1 << 1),
92
a0cf733b
TH		 93 ATA_ID_SERNO_LEN = 20,
94 ATA_ID_FW_REV_LEN = 8,
95 ATA_ID_PROD_LEN = 40,
96
1da177e4 97 ATA_PCI_CTL_OFS = 2,
4099d143
BZ		 98
99 ATA_PIO0 = (1 << 0),
100 ATA_PIO1 = ATA_PIO0 | (1 << 1),
101 ATA_PIO2 = ATA_PIO1 | (1 << 2),
102 ATA_PIO3 = ATA_PIO2 | (1 << 3),
103 ATA_PIO4 = ATA_PIO3 | (1 << 4),
104 ATA_PIO5 = ATA_PIO4 | (1 << 5),
105 ATA_PIO6 = ATA_PIO5 | (1 << 6),
106
91a6d4ed
BZ		 107 ATA_SWDMA0 = (1 << 0),
108 ATA_SWDMA1 = ATA_SWDMA0 | (1 << 1),
109 ATA_SWDMA2 = ATA_SWDMA1 | (1 << 2),
110
111 ATA_SWDMA2_ONLY = (1 << 2),
112
113 ATA_MWDMA0 = (1 << 0),
114 ATA_MWDMA1 = ATA_MWDMA0 | (1 << 1),
115 ATA_MWDMA2 = ATA_MWDMA1 | (1 << 2),
116
117 ATA_MWDMA12_ONLY = (1 << 1) | (1 << 2),
118 ATA_MWDMA2_ONLY = (1 << 2),
119
1da177e4
LT		 120 ATA_UDMA0 = (1 << 0),
121 ATA_UDMA1 = ATA_UDMA0 | (1 << 1),
122 ATA_UDMA2 = ATA_UDMA1 | (1 << 2),
123 ATA_UDMA3 = ATA_UDMA2 | (1 << 3),
124 ATA_UDMA4 = ATA_UDMA3 | (1 << 4),
125 ATA_UDMA5 = ATA_UDMA4 | (1 << 5),
126 ATA_UDMA6 = ATA_UDMA5 | (1 << 6),
127 ATA_UDMA7 = ATA_UDMA6 | (1 << 7),
128 /* ATA_UDMA7 is just for completeness... doesn't exist (yet?). */
129
130 ATA_UDMA_MASK_40C = ATA_UDMA2, /* udma0-2 */
131
132 /* DMA-related */
133 ATA_PRD_SZ = 8,
134 ATA_PRD_TBL_SZ = (ATA_MAX_PRD * ATA_PRD_SZ),
135 ATA_PRD_EOT = (1 << 31), /* end-of-table flag */
136
137 ATA_DMA_TABLE_OFS = 4,
138 ATA_DMA_STATUS = 2,
139 ATA_DMA_CMD = 0,
140 ATA_DMA_WR = (1 << 3),
141 ATA_DMA_START = (1 << 0),
142 ATA_DMA_INTR = (1 << 2),
143 ATA_DMA_ERR = (1 << 1),
144 ATA_DMA_ACTIVE = (1 << 0),
145
146 /* bits in ATA command block registers */
147 ATA_HOB = (1 << 7), /* LBA48 selector */
148 ATA_NIEN = (1 << 1), /* disable-irq flag */
149 ATA_LBA = (1 << 6), /* LBA28 selector */
150 ATA_DEV1 = (1 << 4), /* Select Device 1 (slave) */
151 ATA_DEVICE_OBS = (1 << 7) | (1 << 5), /* obs bits in dev reg */
152 ATA_DEVCTL_OBS = (1 << 3), /* obsolete bit in devctl reg */
153 ATA_BUSY = (1 << 7), /* BSY status bit */
154 ATA_DRDY = (1 << 6), /* device ready */
155 ATA_DF = (1 << 5), /* device fault */
156 ATA_DRQ = (1 << 3), /* data request i/o */
157 ATA_ERR = (1 << 0), /* have an error */
158 ATA_SRST = (1 << 2), /* software reset */
9be1e979
TH		 159 ATA_ICRC = (1 << 7), /* interface CRC error */
160 ATA_UNC = (1 << 6), /* uncorrectable media error */
161 ATA_IDNF = (1 << 4), /* ID not found */
1da177e4
LT		 162 ATA_ABORTED = (1 << 2), /* command aborted */
163
164 /* ATA command block registers */
165 ATA_REG_DATA = 0x00,
166 ATA_REG_ERR = 0x01,
167 ATA_REG_NSECT = 0x02,
168 ATA_REG_LBAL = 0x03,
169 ATA_REG_LBAM = 0x04,
170 ATA_REG_LBAH = 0x05,
171 ATA_REG_DEVICE = 0x06,
172 ATA_REG_STATUS = 0x07,
173
174 ATA_REG_FEATURE = ATA_REG_ERR, /* and their aliases */
175 ATA_REG_CMD = ATA_REG_STATUS,
176 ATA_REG_BYTEL = ATA_REG_LBAM,
177 ATA_REG_BYTEH = ATA_REG_LBAH,
178 ATA_REG_DEVSEL = ATA_REG_DEVICE,
179 ATA_REG_IRQ = ATA_REG_NSECT,
180
181 /* ATA device commands */
ab2181cf 182 ATA_CMD_DEV_RESET = 0x08, /* ATAPI device reset */
1da177e4 183 ATA_CMD_CHK_POWER = 0xE5, /* check power mode */
972dcafb
DG		 184 ATA_CMD_STANDBY = 0xE2, /* place in standby power mode */
185 ATA_CMD_IDLE = 0xE3, /* place in idle power mode */
1da177e4
LT		 186 ATA_CMD_EDD = 0x90, /* execute device diagnostic */
187 ATA_CMD_FLUSH = 0xE7,
188 ATA_CMD_FLUSH_EXT = 0xEA,
189 ATA_CMD_ID_ATA = 0xEC,
190 ATA_CMD_ID_ATAPI = 0xA1,
191 ATA_CMD_READ = 0xC8,
192 ATA_CMD_READ_EXT = 0x25,
193 ATA_CMD_WRITE = 0xCA,
194 ATA_CMD_WRITE_EXT = 0x35,
9a3dccc4 195 ATA_CMD_WRITE_FUA_EXT = 0x3D,
88e49034
TH		 196 ATA_CMD_FPDMA_READ = 0x60,
197 ATA_CMD_FPDMA_WRITE = 0x61,
1da177e4
LT		 198 ATA_CMD_PIO_READ = 0x20,
199 ATA_CMD_PIO_READ_EXT = 0x24,
200 ATA_CMD_PIO_WRITE = 0x30,
201 ATA_CMD_PIO_WRITE_EXT = 0x34,
8cbd6df1
AL		 202 ATA_CMD_READ_MULTI = 0xC4,
203 ATA_CMD_READ_MULTI_EXT = 0x29,
204 ATA_CMD_WRITE_MULTI = 0xC5,
205 ATA_CMD_WRITE_MULTI_EXT = 0x39,
9a3dccc4 206 ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
1da177e4 207 ATA_CMD_SET_FEATURES = 0xEF,
2c3d2a46 208 ATA_CMD_SET_MULTI = 0xC6,
1da177e4
LT		 209 ATA_CMD_PACKET = 0xA0,
210 ATA_CMD_VERIFY = 0x40,
211 ATA_CMD_VERIFY_EXT = 0x42,
2dcb407e
JG		 212 ATA_CMD_STANDBYNOW1 = 0xE0,
213 ATA_CMD_IDLEIMMEDIATE = 0xE1,
054a5fba 214 ATA_CMD_SLEEP = 0xE6,
8bf62ece 215 ATA_CMD_INIT_DEV_PARAMS = 0x91,
b6782728
AC		 216 ATA_CMD_READ_NATIVE_MAX = 0xF8,
217 ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
1e999736
AC		 218 ATA_CMD_SET_MAX = 0xF9,
219 ATA_CMD_SET_MAX_EXT = 0x37,
88e49034 220 ATA_CMD_READ_LOG_EXT = 0x2f,
814600ee
TH		 221 ATA_CMD_PMP_READ = 0xE4,
222 ATA_CMD_PMP_WRITE = 0xE8,
ce2e0abb
TH		 223 ATA_CMD_CONF_OVERLAY = 0xB1,
224 ATA_CMD_SEC_FREEZE_LOCK = 0xF5,
476d9894
BZ		 225 ATA_CMD_SMART = 0xB0,
226 ATA_CMD_MEDIA_LOCK = 0xDE,
227 ATA_CMD_MEDIA_UNLOCK = 0xDF,
228 /* marked obsolete in the ATA/ATAPI-7 spec */
229 ATA_CMD_RESTORE = 0x10,
230 /* EXABYTE specific */
231 ATA_EXABYTE_ENABLE_NEST = 0xF0,
88e49034
TH		 232
233 /* READ_LOG_EXT pages */
234 ATA_LOG_SATA_NCQ = 0x10,
1da177e4 235
5a5dbd18
ML		 236 /* READ/WRITE LONG (obsolete) */
237 ATA_CMD_READ_LONG = 0x22,
238 ATA_CMD_READ_LONG_ONCE = 0x23,
239 ATA_CMD_WRITE_LONG = 0x32,
240 ATA_CMD_WRITE_LONG_ONCE = 0x33,
241
1da177e4
LT		 242 /* SETFEATURES stuff */
243 SETFEATURES_XFER = 0x03,
244 XFER_UDMA_7 = 0x47,
245 XFER_UDMA_6 = 0x46,
246 XFER_UDMA_5 = 0x45,
247 XFER_UDMA_4 = 0x44,
248 XFER_UDMA_3 = 0x43,
249 XFER_UDMA_2 = 0x42,
250 XFER_UDMA_1 = 0x41,
251 XFER_UDMA_0 = 0x40,
b352e57d
AC		 252 XFER_MW_DMA_4 = 0x24, /* CFA only */
253 XFER_MW_DMA_3 = 0x23, /* CFA only */
1da177e4
LT		 254 XFER_MW_DMA_2 = 0x22,
255 XFER_MW_DMA_1 = 0x21,
256 XFER_MW_DMA_0 = 0x20,
b4b52db7
AC		 257 XFER_SW_DMA_2 = 0x12,
258 XFER_SW_DMA_1 = 0x11,
259 XFER_SW_DMA_0 = 0x10,
b352e57d
AC		 260 XFER_PIO_6 = 0x0E, /* CFA only */
261 XFER_PIO_5 = 0x0D, /* CFA only */
1da177e4
LT		 262 XFER_PIO_4 = 0x0C,
263 XFER_PIO_3 = 0x0B,
264 XFER_PIO_2 = 0x0A,
265 XFER_PIO_1 = 0x09,
266 XFER_PIO_0 = 0x08,
1da177e4
LT		 267 XFER_PIO_SLOW = 0x00,
268
3057ac3c 269 SETFEATURES_WC_ON = 0x02, /* Enable write cache */
270 SETFEATURES_WC_OFF = 0x82, /* Disable write cache */
271
476d9894
BZ		 272 /* Enable/Disable Automatic Acoustic Management */
273 SETFEATURES_AAM_ON = 0x42,
274 SETFEATURES_AAM_OFF = 0xC2,
275
169439c2
ML		 276 SETFEATURES_SPINUP = 0x07, /* Spin-up drive */
277
9f45cbd3
KCA		 278 SETFEATURES_SATA_ENABLE = 0x10, /* Enable use of SATA feature */
279 SETFEATURES_SATA_DISABLE = 0x90, /* Disable use of SATA feature */
280
281 /* SETFEATURE Sector counts for SATA features */
282 SATA_AN = 0x05, /* Asynchronous Notification */
ca77329f 283 SATA_DIPM = 0x03, /* Device Initiated Power Management */
9f45cbd3 284
ce2e0abb
TH		 285 /* feature values for SET_MAX */
286 ATA_SET_MAX_ADDR = 0x00,
287 ATA_SET_MAX_PASSWD = 0x01,
288 ATA_SET_MAX_LOCK = 0x02,
289 ATA_SET_MAX_UNLOCK = 0x03,
290 ATA_SET_MAX_FREEZE_LOCK = 0x04,
291
292 /* feature values for DEVICE CONFIGURATION OVERLAY */
293 ATA_DCO_RESTORE = 0xC0,
294 ATA_DCO_FREEZE_LOCK = 0xC1,
295 ATA_DCO_IDENTIFY = 0xC2,
296 ATA_DCO_SET = 0xC3,
297
476d9894
BZ		 298 /* feature values for SMART */
299 ATA_SMART_ENABLE = 0xD8,
300 ATA_SMART_READ_VALUES = 0xD0,
301 ATA_SMART_READ_THRESHOLDS = 0xD1,
302
303 /* password used in LBA Mid / LBA High for executing SMART commands */
304 ATA_SMART_LBAM_PASS = 0x4F,
305 ATA_SMART_LBAH_PASS = 0xC2,
306
1da177e4
LT		 307 /* ATAPI stuff */
308 ATAPI_PKT_DMA = (1 << 0),
309 ATAPI_DMADIR = (1 << 2), /* ATAPI data dir:
310 0=to device, 1=to host */
311 ATAPI_CDB_LEN = 16,
312
814600ee
TH		 313 /* PMP stuff */
314 SATA_PMP_MAX_PORTS = 15,
315 SATA_PMP_CTRL_PORT = 15,
316
317 SATA_PMP_GSCR_DWORDS = 128,
318 SATA_PMP_GSCR_PROD_ID = 0,
319 SATA_PMP_GSCR_REV = 1,
320 SATA_PMP_GSCR_PORT_INFO = 2,
321 SATA_PMP_GSCR_ERROR = 32,
322 SATA_PMP_GSCR_ERROR_EN = 33,
323 SATA_PMP_GSCR_FEAT = 64,
324 SATA_PMP_GSCR_FEAT_EN = 96,
325
326 SATA_PMP_PSCR_STATUS = 0,
327 SATA_PMP_PSCR_ERROR = 1,
328 SATA_PMP_PSCR_CONTROL = 2,
329
330 SATA_PMP_FEAT_BIST = (1 << 0),
331 SATA_PMP_FEAT_PMREQ = (1 << 1),
332 SATA_PMP_FEAT_DYNSSC = (1 << 2),
333 SATA_PMP_FEAT_NOTIFY = (1 << 3),
334
1da177e4
LT		 335 /* cable types */
336 ATA_CBL_NONE = 0,
337 ATA_CBL_PATA40 = 1,
338 ATA_CBL_PATA80 = 2,
c88f90c3
TH		 339 ATA_CBL_PATA40_SHORT = 3, /* 40 wire cable to high UDMA spec */
340 ATA_CBL_PATA_UNK = 4, /* don't know, maybe 80c? */
341 ATA_CBL_PATA_IGN = 5, /* don't know, ignore cable handling */
342 ATA_CBL_SATA = 6,
1da177e4
LT		 343
344 /* SATA Status and Control Registers */
345 SCR_STATUS = 0,
346 SCR_ERROR = 1,
347 SCR_CONTROL = 2,
348 SCR_ACTIVE = 3,
349 SCR_NOTIFICATION = 4,
350
9be1e979
TH		 351 /* SError bits */
352 SERR_DATA_RECOVERED = (1 << 0), /* recovered data error */
353 SERR_COMM_RECOVERED = (1 << 1), /* recovered comm failure */
354 SERR_DATA = (1 << 8), /* unrecovered data error */
355 SERR_PERSISTENT = (1 << 9), /* persistent data/comm error */
356 SERR_PROTOCOL = (1 << 10), /* protocol violation */
357 SERR_INTERNAL = (1 << 11), /* host internal error */
358 SERR_PHYRDY_CHG = (1 << 16), /* PHY RDY changed */
1333e194
RH		 359 SERR_PHY_INT_ERR = (1 << 17), /* PHY internal error */
360 SERR_COMM_WAKE = (1 << 18), /* Comm wake */
361 SERR_10B_8B_ERR = (1 << 19), /* 10b to 8b decode error */
362 SERR_DISPARITY = (1 << 20), /* Disparity */
363 SERR_CRC = (1 << 21), /* CRC error */
364 SERR_HANDSHAKE = (1 << 22), /* Handshake error */
365 SERR_LINK_SEQ_ERR = (1 << 23), /* Link sequence error */
366 SERR_TRANS_ST_ERROR = (1 << 24), /* Transport state trans. error */
367 SERR_UNRECOG_FIS = (1 << 25), /* Unrecognized FIS */
9be1e979
TH		 368 SERR_DEV_XCHG = (1 << 26), /* device exchanged */
369
1da177e4
LT		 370 /* struct ata_taskfile flags */
371 ATA_TFLAG_LBA48 = (1 << 0), /* enable 48-bit LBA and "HOB" */
372 ATA_TFLAG_ISADDR = (1 << 1), /* enable r/w to nsect/lba regs */
373 ATA_TFLAG_DEVICE = (1 << 2), /* enable r/w to device reg */
374 ATA_TFLAG_WRITE = (1 << 3), /* data dir: host->dev==1 (write) */
8bf62ece 375 ATA_TFLAG_LBA = (1 << 4), /* enable LBA */
9a3dccc4 376 ATA_TFLAG_FUA = (1 << 5), /* enable FUA */
ea9b395f 377 ATA_TFLAG_POLLING = (1 << 6), /* set nIEN to 1 and use polling */
405e66b3
TH		 378
379 /* protocol flags */
380 ATA_PROT_FLAG_PIO = (1 << 0), /* is PIO */
381 ATA_PROT_FLAG_DMA = (1 << 1), /* is DMA */
382 ATA_PROT_FLAG_DATA = ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA,
383 ATA_PROT_FLAG_NCQ = (1 << 2), /* is NCQ */
384 ATA_PROT_FLAG_ATAPI = (1 << 3), /* is ATAPI */
1da177e4
LT		 385};
386
387enum ata_tf_protocols {
388 /* ATA taskfile protocols */
389 ATA_PROT_UNKNOWN, /* unknown/invalid */
390 ATA_PROT_NODATA, /* no data */
1dce589c 391 ATA_PROT_PIO, /* PIO data xfer */
1da177e4 392 ATA_PROT_DMA, /* DMA */
88e49034 393 ATA_PROT_NCQ, /* NCQ */
0dc36888
TH		 394 ATAPI_PROT_NODATA, /* packet command, no data */
395 ATAPI_PROT_PIO, /* packet command, PIO data xfer*/
396 ATAPI_PROT_DMA, /* packet command with special DMA sauce */
1da177e4
LT		 397};
398
399enum ata_ioctls {
400 ATA_IOC_GET_IO32 = 0x309,
401 ATA_IOC_SET_IO32 = 0x324,
402};
403
404/* core structures */
405
406struct ata_prd {
4ca4e439
AV		 407 __le32 addr;
408 __le32 flags_len;
1da177e4
LT		 409};
410
411struct ata_taskfile {
412 unsigned long flags; /* ATA_TFLAG_xxx */
413 u8 protocol; /* ATA_PROT_xxx */
414
415 u8 ctl; /* control reg */
416
417 u8 hob_feature; /* additional data */
418 u8 hob_nsect; /* to support LBA48 */
419 u8 hob_lbal;
420 u8 hob_lbam;
421 u8 hob_lbah;
422
423 u8 feature;
424 u8 nsect;
425 u8 lbal;
426 u8 lbam;
427 u8 lbah;
428
429 u8 device;
430
431 u8 command; /* IO operation */
432};
433
405e66b3
TH		 434/*
435 * protocol tests
436 */
437static inline unsigned int ata_prot_flags(u8 prot)
438{
439 switch (prot) {
440 case ATA_PROT_NODATA:
441 return 0;
442 case ATA_PROT_PIO:
443 return ATA_PROT_FLAG_PIO;
444 case ATA_PROT_DMA:
445 return ATA_PROT_FLAG_DMA;
446 case ATA_PROT_NCQ:
447 return ATA_PROT_FLAG_DMA | ATA_PROT_FLAG_NCQ;
0dc36888 448 case ATAPI_PROT_NODATA:
405e66b3 449 return ATA_PROT_FLAG_ATAPI;
0dc36888 450 case ATAPI_PROT_PIO:
405e66b3 451 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_PIO;
0dc36888 452 case ATAPI_PROT_DMA:
405e66b3
TH		 453 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_DMA;
454 }
455 return 0;
456}
457
458static inline int ata_is_atapi(u8 prot)
459{
460 return ata_prot_flags(prot) & ATA_PROT_FLAG_ATAPI;
461}
462
463static inline int ata_is_nodata(u8 prot)
464{
465 return !(ata_prot_flags(prot) & ATA_PROT_FLAG_DATA);
466}
467
468static inline int ata_is_pio(u8 prot)
469{
470 return ata_prot_flags(prot) & ATA_PROT_FLAG_PIO;
471}
472
473static inline int ata_is_dma(u8 prot)
474{
475 return ata_prot_flags(prot) & ATA_PROT_FLAG_DMA;
476}
477
478static inline int ata_is_ncq(u8 prot)
479{
480 return ata_prot_flags(prot) & ATA_PROT_FLAG_NCQ;
481}
482
483static inline int ata_is_data(u8 prot)
484{
485 return ata_prot_flags(prot) & ATA_PROT_FLAG_DATA;
486}
487
488/*
489 * id tests
490 */
37014c64
BZ		 491#define ata_id_is_ata(id) (((id)[ATA_ID_CONFIG] & (1 << 15)) == 0)
492#define ata_id_has_lba(id) ((id)[ATA_ID_CAPABILITY] & (1 << 9))
493#define ata_id_has_dma(id) ((id)[ATA_ID_CAPABILITY] & (1 << 8))
88e49034 494#define ata_id_has_ncq(id) ((id)[76] & (1 << 8))
37014c64
BZ		 495#define ata_id_queue_depth(id) (((id)[ATA_ID_QUEUE_DEPTH] & 0x1f) + 1)
496#define ata_id_removeable(id) ((id)[ATA_ID_CONFIG] & (1 << 7))
854c73a2 497#define ata_id_has_atapi_AN(id) \
9f45cbd3
KCA		 498 ( (((id)[76] != 0x0000) && ((id)[76] != 0xffff)) && \
499 ((id)[78] & (1 << 5)) )
37014c64
BZ		 500#define ata_id_iordy_disable(id) ((id)[ATA_ID_CAPABILITY] & (1 << 10))
501#define ata_id_has_iordy(id) ((id)[ATA_ID_CAPABILITY] & (1 << 11))
1da177e4
LT		 502#define ata_id_u32(id,n) \
503 (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
504#define ata_id_u64(id,n) \
505 ( ((u64) (id)[(n) + 3] << 48) | \
506 ((u64) (id)[(n) + 2] << 32) | \
507 ((u64) (id)[(n) + 1] << 16) | \
508 ((u64) (id)[(n) + 0]) )
509
37014c64 510#define ata_id_cdb_intr(id) (((id)[ATA_ID_CONFIG] & 0x60) == 0x20)
312f7da2 511
ca77329f
KCA		 512static inline bool ata_id_has_hipm(const u16 *id)
513{
514 u16 val = id[76];
515
516 if (val == 0 || val == 0xffff)
517 return false;
518
519 return val & (1 << 9);
520}
521
522static inline bool ata_id_has_dipm(const u16 *id)
523{
524 u16 val = id[78];
525
526 if (val == 0 || val == 0xffff)
527 return false;
528
529 return val & (1 << 3);
530}
531
ae8d4ee7 532
c7293870
AC		 533static inline int ata_id_has_fua(const u16 *id)
534{
37014c64 535 if ((id[ATA_ID_CFSSE] & 0xC000) != 0x4000)
c7293870 536 return 0;
37014c64 537 return id[ATA_ID_CFSSE] & (1 << 6);
c7293870
AC		 538}
539
540static inline int ata_id_has_flush(const u16 *id)
541{
37014c64 542 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
c7293870 543 return 0;
37014c64 544 return id[ATA_ID_COMMAND_SET_2] & (1 << 12);
c7293870
AC		 545}
546
547static inline int ata_id_has_flush_ext(const u16 *id)
548{
37014c64 549 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
c7293870 550 return 0;
37014c64 551 return id[ATA_ID_COMMAND_SET_2] & (1 << 13);
c7293870
AC		 552}
553
554static inline int ata_id_has_lba48(const u16 *id)
555{
37014c64 556 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
c7293870 557 return 0;
37014c64 558 if (!ata_id_u64(id, ATA_ID_LBA_CAPACITY_2))
17bd9a2f 559 return 0;
37014c64 560 return id[ATA_ID_COMMAND_SET_2] & (1 << 10);
c7293870
AC		 561}
562
563static inline int ata_id_hpa_enabled(const u16 *id)
564{
565 /* Yes children, word 83 valid bits cover word 82 data */
37014c64 566 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
c7293870
AC		 567 return 0;
568 /* And 87 covers 85-87 */
37014c64 569 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
c7293870
AC		 570 return 0;
571 /* Check command sets enabled as well as supported */
37014c64 572 if ((id[ATA_ID_CFS_ENABLE_1] & (1 << 10)) == 0)
c7293870 573 return 0;
37014c64 574 return id[ATA_ID_COMMAND_SET_1] & (1 << 10);
c7293870
AC		 575}
576
577static inline int ata_id_has_wcache(const u16 *id)
578{
579 /* Yes children, word 83 valid bits cover word 82 data */
37014c64 580 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
c7293870 581 return 0;
37014c64 582 return id[ATA_ID_COMMAND_SET_1] & (1 << 5);
c7293870
AC		 583}
584
585static inline int ata_id_has_pm(const u16 *id)
586{
37014c64 587 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
c7293870 588 return 0;
37014c64 589 return id[ATA_ID_COMMAND_SET_1] & (1 << 3);
c7293870
AC		 590}
591
592static inline int ata_id_rahead_enabled(const u16 *id)
593{
37014c64 594 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
c7293870 595 return 0;
37014c64 596 return id[ATA_ID_CFS_ENABLE_1] & (1 << 6);
c7293870
AC		 597}
598
599static inline int ata_id_wcache_enabled(const u16 *id)
600{
37014c64 601 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
c7293870 602 return 0;
37014c64 603 return id[ATA_ID_CFS_ENABLE_1] & (1 << 5);
c7293870
AC		 604}
605
606/**
607 * ata_id_major_version - get ATA level of drive
608 * @id: Identify data
609 *
610 * Caveats:
611 * ATA-1 considers identify optional
612 * ATA-2 introduces mandatory identify
613 * ATA-3 introduces word 80 and accurate reporting
614 *
615 * The practical impact of this is that ata_id_major_version cannot
2dcb407e 616 * reliably report on drives below ATA3.
c7293870
AC		 617 */
618
3d2ca910
TH		 619static inline unsigned int ata_id_major_version(const u16 *id)
620{
621 unsigned int mver;
622
b352e57d
AC		 623 if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
624 return 0;
625
3d2ca910
TH		 626 for (mver = 14; mver >= 1; mver--)
627 if (id[ATA_ID_MAJOR_VER] & (1 << mver))
628 break;
629 return mver;
630}
631
32d90911
TH		 632static inline int ata_id_is_sata(const u16 *id)
633{
37014c64 634 return ata_id_major_version(id) >= 5 && id[ATA_ID_HW_CONFIG] == 0;
32d90911
TH		 635}
636
ae8d4ee7
AC		 637static inline int ata_id_has_tpm(const u16 *id)
638{
639 /* The TPM bits are only valid on ATA8 */
640 if (ata_id_major_version(id) < 8)
641 return 0;
642 if ((id[48] & 0xC000) != 0x4000)
643 return 0;
644 return id[48] & (1 << 0);
645}
646
647static inline int ata_id_has_dword_io(const u16 *id)
648{
649 /* ATA 8 reuses this flag for "trusted" computing */
650 if (ata_id_major_version(id) > 7)
651 return 0;
37014c64 652 if (id[ATA_ID_DWORD_IO] & (1 << 0))
ae8d4ee7
AC		 653 return 1;
654 return 0;
655}
656
057ace5e 657static inline int ata_id_current_chs_valid(const u16 *id)
8bf62ece 658{
9bec2e38
JG		 659 /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
660 has not been issued to the device then the values of
37014c64
BZ		 661 id[ATA_ID_CUR_CYLS] to id[ATA_ID_CUR_SECTORS] are vendor specific. */
662 return (id[ATA_ID_FIELD_VALID] & 1) && /* Current translation valid */
663 id[ATA_ID_CUR_CYLS] && /* cylinders in current translation */
664 id[ATA_ID_CUR_HEADS] && /* heads in current translation */
665 id[ATA_ID_CUR_HEADS] <= 16 &&
666 id[ATA_ID_CUR_SECTORS]; /* sectors in current translation */
8bf62ece
AL		 667}
668
b352e57d
AC		 669static inline int ata_id_is_cfa(const u16 *id)
670{
37014c64 671 if (id[ATA_ID_CONFIG] == 0x848A) /* Standard CF */
b352e57d
AC		 672 return 1;
673 /* Could be CF hiding as standard ATA */
37014c64
BZ		 674 if (ata_id_major_version(id) >= 3 &&
675 id[ATA_ID_COMMAND_SET_1] != 0xFFFF &&
676 (id[ATA_ID_COMMAND_SET_1] & (1 << 2)))
b352e57d
AC		 677 return 1;
678 return 0;
679}
680
fc085150
AC		 681static inline int ata_drive_40wire(const u16 *dev_id)
682{
32d90911 683 if (ata_id_is_sata(dev_id))
fc085150 684 return 0; /* SATA */
37014c64 685 if ((dev_id[ATA_ID_HW_CONFIG] & 0xE000) == 0x6000)
fc085150
AC		 686 return 0; /* 80 wire */
687 return 1;
688}
689
6bbfd53d
AC		 690static inline int ata_drive_40wire_relaxed(const u16 *dev_id)
691{
37014c64 692 if ((dev_id[ATA_ID_HW_CONFIG] & 0x2000) == 0x2000)
6bbfd53d
AC		 693 return 0; /* 80 wire */
694 return 1;
695}
696
057ace5e 697static inline int atapi_cdb_len(const u16 *dev_id)
1da177e4 698{
37014c64 699 u16 tmp = dev_id[ATA_ID_CONFIG] & 0x3;
1da177e4
LT		 700 switch (tmp) {
701 case 0: return 12;
702 case 1: return 16;
703 default: return -1;
704 }
705}
706
f8d8e579
TB		 707static inline int atapi_command_packet_set(const u16 *dev_id)
708{
37014c64 709 return (dev_id[ATA_ID_CONFIG] >> 8) & 0x1f;
f8d8e579
TB		 710}
711
91163006
TH		 712static inline int atapi_id_dmadir(const u16 *dev_id)
713{
714 return ata_id_major_version(dev_id) >= 7 && (dev_id[62] & 0x8000);
715}
716
07f6f7d0
AL		 717static inline int is_multi_taskfile(struct ata_taskfile *tf)
718{
719 return (tf->command == ATA_CMD_READ_MULTI) ||
720 (tf->command == ATA_CMD_WRITE_MULTI) ||
721 (tf->command == ATA_CMD_READ_MULTI_EXT) ||
c2956a3b
AL		 722 (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
723 (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
07f6f7d0
AL		 724}
725
1da177e4
LT		 726static inline int ata_ok(u8 status)
727{
728 return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
729 == ATA_DRDY);
730}
731
c6a33e24
AL		 732static inline int lba_28_ok(u64 block, u32 n_block)
733{
734 /* check the ending block number */
735 return ((block + n_block - 1) < ((u64)1 << 28)) && (n_block <= 256);
736}
737
738static inline int lba_48_ok(u64 block, u32 n_block)
739{
740 /* check the ending block number */
741 return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536);
742}
743
814600ee
TH		 744#define sata_pmp_gscr_vendor(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
745#define sata_pmp_gscr_devid(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
746#define sata_pmp_gscr_rev(gscr) (((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
747#define sata_pmp_gscr_ports(gscr) ((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)
748
1da177e4 749#endif /* __LINUX_ATA_H__ */
ubuntu-bionic-kernel mirror