Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1
2/*
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 *
27 */
28
29#ifndef __LINUX_ATA_H__
30#define __LINUX_ATA_H__
31
32#include <linux/kernel.h>
33#include <linux/string.h>
34#include <linux/types.h>
35#include <asm/byteorder.h>
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,
46 ATA_MAX_SECTORS_128 = 128,
47 ATA_MAX_SECTORS = 256,
48 ATA_MAX_SECTORS_LBA48 = 65535,/* TODO: 65536? */
49 ATA_MAX_SECTORS_TAPE = 65535,
50
51 ATA_ID_WORDS = 256,
52 ATA_ID_CONFIG = 0,
53 ATA_ID_CYLS = 1,
54 ATA_ID_HEADS = 3,
55 ATA_ID_SECTORS = 6,
56 ATA_ID_SERNO = 10,
57 ATA_ID_BUF_SIZE = 21,
58 ATA_ID_FW_REV = 23,
59 ATA_ID_PROD = 27,
60 ATA_ID_MAX_MULTSECT = 47,
61 ATA_ID_DWORD_IO = 48,
62 ATA_ID_CAPABILITY = 49,
63 ATA_ID_OLD_PIO_MODES = 51,
64 ATA_ID_OLD_DMA_MODES = 52,
65 ATA_ID_FIELD_VALID = 53,
66 ATA_ID_CUR_CYLS = 54,
67 ATA_ID_CUR_HEADS = 55,
68 ATA_ID_CUR_SECTORS = 56,
69 ATA_ID_MULTSECT = 59,
70 ATA_ID_LBA_CAPACITY = 60,
71 ATA_ID_SWDMA_MODES = 62,
72 ATA_ID_MWDMA_MODES = 63,
73 ATA_ID_PIO_MODES = 64,
74 ATA_ID_EIDE_DMA_MIN = 65,
75 ATA_ID_EIDE_DMA_TIME = 66,
76 ATA_ID_EIDE_PIO = 67,
77 ATA_ID_EIDE_PIO_IORDY = 68,
78 ATA_ID_QUEUE_DEPTH = 75,
79 ATA_ID_MAJOR_VER = 80,
80 ATA_ID_COMMAND_SET_1 = 82,
81 ATA_ID_COMMAND_SET_2 = 83,
82 ATA_ID_CFSSE = 84,
83 ATA_ID_CFS_ENABLE_1 = 85,
84 ATA_ID_CFS_ENABLE_2 = 86,
85 ATA_ID_CSF_DEFAULT = 87,
86 ATA_ID_UDMA_MODES = 88,
87 ATA_ID_HW_CONFIG = 93,
88 ATA_ID_SPG = 98,
89 ATA_ID_LBA_CAPACITY_2 = 100,
90 ATA_ID_LAST_LUN = 126,
91 ATA_ID_DLF = 128,
92 ATA_ID_CSFO = 129,
93 ATA_ID_CFA_POWER = 160,
94 ATA_ID_CFA_KEY_MGMT = 162,
95 ATA_ID_CFA_MODES = 163,
96 ATA_ID_DATA_SET_MGMT = 169,
97 ATA_ID_ROT_SPEED = 217,
98 ATA_ID_PIO4 = (1 << 1),
99
100 ATA_ID_SERNO_LEN = 20,
101 ATA_ID_FW_REV_LEN = 8,
102 ATA_ID_PROD_LEN = 40,
103
104 ATA_PCI_CTL_OFS = 2,
105
106 ATA_PIO0 = (1 << 0),
107 ATA_PIO1 = ATA_PIO0 | (1 << 1),
108 ATA_PIO2 = ATA_PIO1 | (1 << 2),
109 ATA_PIO3 = ATA_PIO2 | (1 << 3),
110 ATA_PIO4 = ATA_PIO3 | (1 << 4),
111 ATA_PIO5 = ATA_PIO4 | (1 << 5),
112 ATA_PIO6 = ATA_PIO5 | (1 << 6),
113
114 ATA_PIO4_ONLY = (1 << 4),
115
116 ATA_SWDMA0 = (1 << 0),
117 ATA_SWDMA1 = ATA_SWDMA0 | (1 << 1),
118 ATA_SWDMA2 = ATA_SWDMA1 | (1 << 2),
119
120 ATA_SWDMA2_ONLY = (1 << 2),
121
122 ATA_MWDMA0 = (1 << 0),
123 ATA_MWDMA1 = ATA_MWDMA0 | (1 << 1),
124 ATA_MWDMA2 = ATA_MWDMA1 | (1 << 2),
125 ATA_MWDMA3 = ATA_MWDMA2 | (1 << 3),
126 ATA_MWDMA4 = ATA_MWDMA3 | (1 << 4),
127
128 ATA_MWDMA12_ONLY = (1 << 1) | (1 << 2),
129 ATA_MWDMA2_ONLY = (1 << 2),
130
131 ATA_UDMA0 = (1 << 0),
132 ATA_UDMA1 = ATA_UDMA0 | (1 << 1),
133 ATA_UDMA2 = ATA_UDMA1 | (1 << 2),
134 ATA_UDMA3 = ATA_UDMA2 | (1 << 3),
135 ATA_UDMA4 = ATA_UDMA3 | (1 << 4),
136 ATA_UDMA5 = ATA_UDMA4 | (1 << 5),
137 ATA_UDMA6 = ATA_UDMA5 | (1 << 6),
138 ATA_UDMA7 = ATA_UDMA6 | (1 << 7),
139 /* ATA_UDMA7 is just for completeness... doesn't exist (yet?). */
140
141 ATA_UDMA24_ONLY = (1 << 2) | (1 << 4),
142
143 ATA_UDMA_MASK_40C = ATA_UDMA2, /* udma0-2 */
144
145 /* DMA-related */
146 ATA_PRD_SZ = 8,
147 ATA_PRD_TBL_SZ = (ATA_MAX_PRD * ATA_PRD_SZ),
148 ATA_PRD_EOT = (1 << 31), /* end-of-table flag */
149
150 ATA_DMA_TABLE_OFS = 4,
151 ATA_DMA_STATUS = 2,
152 ATA_DMA_CMD = 0,
153 ATA_DMA_WR = (1 << 3),
154 ATA_DMA_START = (1 << 0),
155 ATA_DMA_INTR = (1 << 2),
156 ATA_DMA_ERR = (1 << 1),
157 ATA_DMA_ACTIVE = (1 << 0),
158
159 /* bits in ATA command block registers */
160 ATA_HOB = (1 << 7), /* LBA48 selector */
161 ATA_NIEN = (1 << 1), /* disable-irq flag */
162 ATA_LBA = (1 << 6), /* LBA28 selector */
163 ATA_DEV1 = (1 << 4), /* Select Device 1 (slave) */
164 ATA_DEVICE_OBS = (1 << 7) | (1 << 5), /* obs bits in dev reg */
165 ATA_DEVCTL_OBS = (1 << 3), /* obsolete bit in devctl reg */
166 ATA_BUSY = (1 << 7), /* BSY status bit */
167 ATA_DRDY = (1 << 6), /* device ready */
168 ATA_DF = (1 << 5), /* device fault */
169 ATA_DSC = (1 << 4), /* drive seek complete */
170 ATA_DRQ = (1 << 3), /* data request i/o */
171 ATA_CORR = (1 << 2), /* corrected data error */
172 ATA_IDX = (1 << 1), /* index */
173 ATA_ERR = (1 << 0), /* have an error */
174 ATA_SRST = (1 << 2), /* software reset */
175 ATA_ICRC = (1 << 7), /* interface CRC error */
176 ATA_BBK = ATA_ICRC, /* pre-EIDE: block marked bad */
177 ATA_UNC = (1 << 6), /* uncorrectable media error */
178 ATA_MC = (1 << 5), /* media changed */
179 ATA_IDNF = (1 << 4), /* ID not found */
180 ATA_MCR = (1 << 3), /* media change requested */
181 ATA_ABORTED = (1 << 2), /* command aborted */
182 ATA_TRK0NF = (1 << 1), /* track 0 not found */
183 ATA_AMNF = (1 << 0), /* address mark not found */
184 ATAPI_LFS = 0xF0, /* last failed sense */
185 ATAPI_EOM = ATA_TRK0NF, /* end of media */
186 ATAPI_ILI = ATA_AMNF, /* illegal length indication */
187 ATAPI_IO = (1 << 1),
188 ATAPI_COD = (1 << 0),
189
190 /* ATA command block registers */
191 ATA_REG_DATA = 0x00,
192 ATA_REG_ERR = 0x01,
193 ATA_REG_NSECT = 0x02,
194 ATA_REG_LBAL = 0x03,
195 ATA_REG_LBAM = 0x04,
196 ATA_REG_LBAH = 0x05,
197 ATA_REG_DEVICE = 0x06,
198 ATA_REG_STATUS = 0x07,
199
200 ATA_REG_FEATURE = ATA_REG_ERR, /* and their aliases */
201 ATA_REG_CMD = ATA_REG_STATUS,
202 ATA_REG_BYTEL = ATA_REG_LBAM,
203 ATA_REG_BYTEH = ATA_REG_LBAH,
204 ATA_REG_DEVSEL = ATA_REG_DEVICE,
205 ATA_REG_IRQ = ATA_REG_NSECT,
206
207 /* ATA device commands */
208 ATA_CMD_DEV_RESET = 0x08, /* ATAPI device reset */
209 ATA_CMD_CHK_POWER = 0xE5, /* check power mode */
210 ATA_CMD_STANDBY = 0xE2, /* place in standby power mode */
211 ATA_CMD_IDLE = 0xE3, /* place in idle power mode */
212 ATA_CMD_EDD = 0x90, /* execute device diagnostic */
213 ATA_CMD_FLUSH = 0xE7,
214 ATA_CMD_FLUSH_EXT = 0xEA,
215 ATA_CMD_ID_ATA = 0xEC,
216 ATA_CMD_ID_ATAPI = 0xA1,
217 ATA_CMD_READ = 0xC8,
218 ATA_CMD_READ_EXT = 0x25,
219 ATA_CMD_WRITE = 0xCA,
220 ATA_CMD_WRITE_EXT = 0x35,
221 ATA_CMD_WRITE_FUA_EXT = 0x3D,
222 ATA_CMD_FPDMA_READ = 0x60,
223 ATA_CMD_FPDMA_WRITE = 0x61,
224 ATA_CMD_PIO_READ = 0x20,
225 ATA_CMD_PIO_READ_EXT = 0x24,
226 ATA_CMD_PIO_WRITE = 0x30,
227 ATA_CMD_PIO_WRITE_EXT = 0x34,
228 ATA_CMD_READ_MULTI = 0xC4,
229 ATA_CMD_READ_MULTI_EXT = 0x29,
230 ATA_CMD_WRITE_MULTI = 0xC5,
231 ATA_CMD_WRITE_MULTI_EXT = 0x39,
232 ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
233 ATA_CMD_SET_FEATURES = 0xEF,
234 ATA_CMD_SET_MULTI = 0xC6,
235 ATA_CMD_PACKET = 0xA0,
236 ATA_CMD_VERIFY = 0x40,
237 ATA_CMD_VERIFY_EXT = 0x42,
238 ATA_CMD_STANDBYNOW1 = 0xE0,
239 ATA_CMD_IDLEIMMEDIATE = 0xE1,
240 ATA_CMD_SLEEP = 0xE6,
241 ATA_CMD_INIT_DEV_PARAMS = 0x91,
242 ATA_CMD_READ_NATIVE_MAX = 0xF8,
243 ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
244 ATA_CMD_SET_MAX = 0xF9,
245 ATA_CMD_SET_MAX_EXT = 0x37,
246 ATA_CMD_READ_LOG_EXT = 0x2f,
247 ATA_CMD_PMP_READ = 0xE4,
248 ATA_CMD_PMP_WRITE = 0xE8,
249 ATA_CMD_CONF_OVERLAY = 0xB1,
250 ATA_CMD_SEC_FREEZE_LOCK = 0xF5,
251 ATA_CMD_SMART = 0xB0,
252 ATA_CMD_MEDIA_LOCK = 0xDE,
253 ATA_CMD_MEDIA_UNLOCK = 0xDF,
254 ATA_CMD_DSM = 0x06,
255 /* marked obsolete in the ATA/ATAPI-7 spec */
256 ATA_CMD_RESTORE = 0x10,
257
258 /* READ_LOG_EXT pages */
259 ATA_LOG_SATA_NCQ = 0x10,
260
261 /* READ/WRITE LONG (obsolete) */
262 ATA_CMD_READ_LONG = 0x22,
263 ATA_CMD_READ_LONG_ONCE = 0x23,
264 ATA_CMD_WRITE_LONG = 0x32,
265 ATA_CMD_WRITE_LONG_ONCE = 0x33,
266
267 /* SETFEATURES stuff */
268 SETFEATURES_XFER = 0x03,
269 XFER_UDMA_7 = 0x47,
270 XFER_UDMA_6 = 0x46,
271 XFER_UDMA_5 = 0x45,
272 XFER_UDMA_4 = 0x44,
273 XFER_UDMA_3 = 0x43,
274 XFER_UDMA_2 = 0x42,
275 XFER_UDMA_1 = 0x41,
276 XFER_UDMA_0 = 0x40,
277 XFER_MW_DMA_4 = 0x24, /* CFA only */
278 XFER_MW_DMA_3 = 0x23, /* CFA only */
279 XFER_MW_DMA_2 = 0x22,
280 XFER_MW_DMA_1 = 0x21,
281 XFER_MW_DMA_0 = 0x20,
282 XFER_SW_DMA_2 = 0x12,
283 XFER_SW_DMA_1 = 0x11,
284 XFER_SW_DMA_0 = 0x10,
285 XFER_PIO_6 = 0x0E, /* CFA only */
286 XFER_PIO_5 = 0x0D, /* CFA only */
287 XFER_PIO_4 = 0x0C,
288 XFER_PIO_3 = 0x0B,
289 XFER_PIO_2 = 0x0A,
290 XFER_PIO_1 = 0x09,
291 XFER_PIO_0 = 0x08,
292 XFER_PIO_SLOW = 0x00,
293
294 SETFEATURES_WC_ON = 0x02, /* Enable write cache */
295 SETFEATURES_WC_OFF = 0x82, /* Disable write cache */
296
297 /* Enable/Disable Automatic Acoustic Management */
298 SETFEATURES_AAM_ON = 0x42,
299 SETFEATURES_AAM_OFF = 0xC2,
300
301 SETFEATURES_SPINUP = 0x07, /* Spin-up drive */
302
303 SETFEATURES_SATA_ENABLE = 0x10, /* Enable use of SATA feature */
304 SETFEATURES_SATA_DISABLE = 0x90, /* Disable use of SATA feature */
305
306 /* SETFEATURE Sector counts for SATA features */
307 SATA_AN = 0x05, /* Asynchronous Notification */
308 SATA_DIPM = 0x03, /* Device Initiated Power Management */
309
310 /* feature values for SET_MAX */
311 ATA_SET_MAX_ADDR = 0x00,
312 ATA_SET_MAX_PASSWD = 0x01,
313 ATA_SET_MAX_LOCK = 0x02,
314 ATA_SET_MAX_UNLOCK = 0x03,
315 ATA_SET_MAX_FREEZE_LOCK = 0x04,
316
317 /* feature values for DEVICE CONFIGURATION OVERLAY */
318 ATA_DCO_RESTORE = 0xC0,
319 ATA_DCO_FREEZE_LOCK = 0xC1,
320 ATA_DCO_IDENTIFY = 0xC2,
321 ATA_DCO_SET = 0xC3,
322
323 /* feature values for SMART */
324 ATA_SMART_ENABLE = 0xD8,
325 ATA_SMART_READ_VALUES = 0xD0,
326 ATA_SMART_READ_THRESHOLDS = 0xD1,
327
328 /* feature values for Data Set Management */
329 ATA_DSM_TRIM = 0x01,
330
331 /* password used in LBA Mid / LBA High for executing SMART commands */
332 ATA_SMART_LBAM_PASS = 0x4F,
333 ATA_SMART_LBAH_PASS = 0xC2,
334
335 /* ATAPI stuff */
336 ATAPI_PKT_DMA = (1 << 0),
337 ATAPI_DMADIR = (1 << 2), /* ATAPI data dir:
338 0=to device, 1=to host */
339 ATAPI_CDB_LEN = 16,
340
341 /* PMP stuff */
342 SATA_PMP_MAX_PORTS = 15,
343 SATA_PMP_CTRL_PORT = 15,
344
345 SATA_PMP_GSCR_DWORDS = 128,
346 SATA_PMP_GSCR_PROD_ID = 0,
347 SATA_PMP_GSCR_REV = 1,
348 SATA_PMP_GSCR_PORT_INFO = 2,
349 SATA_PMP_GSCR_ERROR = 32,
350 SATA_PMP_GSCR_ERROR_EN = 33,
351 SATA_PMP_GSCR_FEAT = 64,
352 SATA_PMP_GSCR_FEAT_EN = 96,
353
354 SATA_PMP_PSCR_STATUS = 0,
355 SATA_PMP_PSCR_ERROR = 1,
356 SATA_PMP_PSCR_CONTROL = 2,
357
358 SATA_PMP_FEAT_BIST = (1 << 0),
359 SATA_PMP_FEAT_PMREQ = (1 << 1),
360 SATA_PMP_FEAT_DYNSSC = (1 << 2),
361 SATA_PMP_FEAT_NOTIFY = (1 << 3),
362
363 /* cable types */
364 ATA_CBL_NONE = 0,
365 ATA_CBL_PATA40 = 1,
366 ATA_CBL_PATA80 = 2,
367 ATA_CBL_PATA40_SHORT = 3, /* 40 wire cable to high UDMA spec */
368 ATA_CBL_PATA_UNK = 4, /* don't know, maybe 80c? */
369 ATA_CBL_PATA_IGN = 5, /* don't know, ignore cable handling */
370 ATA_CBL_SATA = 6,
371
372 /* SATA Status and Control Registers */
373 SCR_STATUS = 0,
374 SCR_ERROR = 1,
375 SCR_CONTROL = 2,
376 SCR_ACTIVE = 3,
377 SCR_NOTIFICATION = 4,
378
379 /* SError bits */
380 SERR_DATA_RECOVERED = (1 << 0), /* recovered data error */
381 SERR_COMM_RECOVERED = (1 << 1), /* recovered comm failure */
382 SERR_DATA = (1 << 8), /* unrecovered data error */
383 SERR_PERSISTENT = (1 << 9), /* persistent data/comm error */
384 SERR_PROTOCOL = (1 << 10), /* protocol violation */
385 SERR_INTERNAL = (1 << 11), /* host internal error */
386 SERR_PHYRDY_CHG = (1 << 16), /* PHY RDY changed */
387 SERR_PHY_INT_ERR = (1 << 17), /* PHY internal error */
388 SERR_COMM_WAKE = (1 << 18), /* Comm wake */
389 SERR_10B_8B_ERR = (1 << 19), /* 10b to 8b decode error */
390 SERR_DISPARITY = (1 << 20), /* Disparity */
391 SERR_CRC = (1 << 21), /* CRC error */
392 SERR_HANDSHAKE = (1 << 22), /* Handshake error */
393 SERR_LINK_SEQ_ERR = (1 << 23), /* Link sequence error */
394 SERR_TRANS_ST_ERROR = (1 << 24), /* Transport state trans. error */
395 SERR_UNRECOG_FIS = (1 << 25), /* Unrecognized FIS */
396 SERR_DEV_XCHG = (1 << 26), /* device exchanged */
397
398 /* struct ata_taskfile flags */
399 ATA_TFLAG_LBA48 = (1 << 0), /* enable 48-bit LBA and "HOB" */
400 ATA_TFLAG_ISADDR = (1 << 1), /* enable r/w to nsect/lba regs */
401 ATA_TFLAG_DEVICE = (1 << 2), /* enable r/w to device reg */
402 ATA_TFLAG_WRITE = (1 << 3), /* data dir: host->dev==1 (write) */
403 ATA_TFLAG_LBA = (1 << 4), /* enable LBA */
404 ATA_TFLAG_FUA = (1 << 5), /* enable FUA */
405 ATA_TFLAG_POLLING = (1 << 6), /* set nIEN to 1 and use polling */
406
407 /* protocol flags */
408 ATA_PROT_FLAG_PIO = (1 << 0), /* is PIO */
409 ATA_PROT_FLAG_DMA = (1 << 1), /* is DMA */
410 ATA_PROT_FLAG_DATA = ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA,
411 ATA_PROT_FLAG_NCQ = (1 << 2), /* is NCQ */
412 ATA_PROT_FLAG_ATAPI = (1 << 3), /* is ATAPI */
413};
414
415enum ata_tf_protocols {
416 /* ATA taskfile protocols */
417 ATA_PROT_UNKNOWN, /* unknown/invalid */
418 ATA_PROT_NODATA, /* no data */
419 ATA_PROT_PIO, /* PIO data xfer */
420 ATA_PROT_DMA, /* DMA */
421 ATA_PROT_NCQ, /* NCQ */
422 ATAPI_PROT_NODATA, /* packet command, no data */
423 ATAPI_PROT_PIO, /* packet command, PIO data xfer*/
424 ATAPI_PROT_DMA, /* packet command with special DMA sauce */
425};
426
427enum ata_ioctls {
428 ATA_IOC_GET_IO32 = 0x309,
429 ATA_IOC_SET_IO32 = 0x324,
430};
431
432/* core structures */
433
434struct ata_prd {
435 __le32 addr;
436 __le32 flags_len;
437};
438
439struct ata_taskfile {
440 unsigned long flags; /* ATA_TFLAG_xxx */
441 u8 protocol; /* ATA_PROT_xxx */
442
443 u8 ctl; /* control reg */
444
445 u8 hob_feature; /* additional data */
446 u8 hob_nsect; /* to support LBA48 */
447 u8 hob_lbal;
448 u8 hob_lbam;
449 u8 hob_lbah;
450
451 u8 feature;
452 u8 nsect;
453 u8 lbal;
454 u8 lbam;
455 u8 lbah;
456
457 u8 device;
458
459 u8 command; /* IO operation */
460};
461
462/*
463 * protocol tests
464 */
465static inline unsigned int ata_prot_flags(u8 prot)
466{
467 switch (prot) {
468 case ATA_PROT_NODATA:
469 return 0;
470 case ATA_PROT_PIO:
471 return ATA_PROT_FLAG_PIO;
472 case ATA_PROT_DMA:
473 return ATA_PROT_FLAG_DMA;
474 case ATA_PROT_NCQ:
475 return ATA_PROT_FLAG_DMA | ATA_PROT_FLAG_NCQ;
476 case ATAPI_PROT_NODATA:
477 return ATA_PROT_FLAG_ATAPI;
478 case ATAPI_PROT_PIO:
479 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_PIO;
480 case ATAPI_PROT_DMA:
481 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_DMA;
482 }
483 return 0;
484}
485
486static inline int ata_is_atapi(u8 prot)
487{
488 return ata_prot_flags(prot) & ATA_PROT_FLAG_ATAPI;
489}
490
491static inline int ata_is_nodata(u8 prot)
492{
493 return !(ata_prot_flags(prot) & ATA_PROT_FLAG_DATA);
494}
495
496static inline int ata_is_pio(u8 prot)
497{
498 return ata_prot_flags(prot) & ATA_PROT_FLAG_PIO;
499}
500
501static inline int ata_is_dma(u8 prot)
502{
503 return ata_prot_flags(prot) & ATA_PROT_FLAG_DMA;
504}
505
506static inline int ata_is_ncq(u8 prot)
507{
508 return ata_prot_flags(prot) & ATA_PROT_FLAG_NCQ;
509}
510
511static inline int ata_is_data(u8 prot)
512{
513 return ata_prot_flags(prot) & ATA_PROT_FLAG_DATA;
514}
515
516/*
517 * id tests
518 */
519#define ata_id_is_ata(id) (((id)[ATA_ID_CONFIG] & (1 << 15)) == 0)
520#define ata_id_has_lba(id) ((id)[ATA_ID_CAPABILITY] & (1 << 9))
521#define ata_id_has_dma(id) ((id)[ATA_ID_CAPABILITY] & (1 << 8))
522#define ata_id_has_ncq(id) ((id)[76] & (1 << 8))
523#define ata_id_queue_depth(id) (((id)[ATA_ID_QUEUE_DEPTH] & 0x1f) + 1)
524#define ata_id_removeable(id) ((id)[ATA_ID_CONFIG] & (1 << 7))
525#define ata_id_has_atapi_AN(id) \
526 ( (((id)[76] != 0x0000) && ((id)[76] != 0xffff)) && \
527 ((id)[78] & (1 << 5)) )
528#define ata_id_iordy_disable(id) ((id)[ATA_ID_CAPABILITY] & (1 << 10))
529#define ata_id_has_iordy(id) ((id)[ATA_ID_CAPABILITY] & (1 << 11))
530#define ata_id_u32(id,n) \
531 (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
532#define ata_id_u64(id,n) \
533 ( ((u64) (id)[(n) + 3] << 48) | \
534 ((u64) (id)[(n) + 2] << 32) | \
535 ((u64) (id)[(n) + 1] << 16) | \
536 ((u64) (id)[(n) + 0]) )
537
538#define ata_id_cdb_intr(id) (((id)[ATA_ID_CONFIG] & 0x60) == 0x20)
539
540static inline bool ata_id_has_hipm(const u16 *id)
541{
542 u16 val = id[76];
543
544 if (val == 0 || val == 0xffff)
545 return false;
546
547 return val & (1 << 9);
548}
549
550static inline bool ata_id_has_dipm(const u16 *id)
551{
552 u16 val = id[78];
553
554 if (val == 0 || val == 0xffff)
555 return false;
556
557 return val & (1 << 3);
558}
559
560
561static inline int ata_id_has_fua(const u16 *id)
562{
563 if ((id[ATA_ID_CFSSE] & 0xC000) != 0x4000)
564 return 0;
565 return id[ATA_ID_CFSSE] & (1 << 6);
566}
567
568static inline int ata_id_has_flush(const u16 *id)
569{
570 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
571 return 0;
572 return id[ATA_ID_COMMAND_SET_2] & (1 << 12);
573}
574
575static inline int ata_id_flush_enabled(const u16 *id)
576{
577 if (ata_id_has_flush(id) == 0)
578 return 0;
579 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
580 return 0;
581 return id[ATA_ID_CFS_ENABLE_2] & (1 << 12);
582}
583
584static inline int ata_id_has_flush_ext(const u16 *id)
585{
586 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
587 return 0;
588 return id[ATA_ID_COMMAND_SET_2] & (1 << 13);
589}
590
591static inline int ata_id_flush_ext_enabled(const u16 *id)
592{
593 if (ata_id_has_flush_ext(id) == 0)
594 return 0;
595 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
596 return 0;
597 /*
598 * some Maxtor disks have bit 13 defined incorrectly
599 * so check bit 10 too
600 */
601 return (id[ATA_ID_CFS_ENABLE_2] & 0x2400) == 0x2400;
602}
603
604static inline int ata_id_has_lba48(const u16 *id)
605{
606 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
607 return 0;
608 if (!ata_id_u64(id, ATA_ID_LBA_CAPACITY_2))
609 return 0;
610 return id[ATA_ID_COMMAND_SET_2] & (1 << 10);
611}
612
613static inline int ata_id_lba48_enabled(const u16 *id)
614{
615 if (ata_id_has_lba48(id) == 0)
616 return 0;
617 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
618 return 0;
619 return id[ATA_ID_CFS_ENABLE_2] & (1 << 10);
620}
621
622static inline int ata_id_hpa_enabled(const u16 *id)
623{
624 /* Yes children, word 83 valid bits cover word 82 data */
625 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
626 return 0;
627 /* And 87 covers 85-87 */
628 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
629 return 0;
630 /* Check command sets enabled as well as supported */
631 if ((id[ATA_ID_CFS_ENABLE_1] & (1 << 10)) == 0)
632 return 0;
633 return id[ATA_ID_COMMAND_SET_1] & (1 << 10);
634}
635
636static inline int ata_id_has_wcache(const u16 *id)
637{
638 /* Yes children, word 83 valid bits cover word 82 data */
639 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
640 return 0;
641 return id[ATA_ID_COMMAND_SET_1] & (1 << 5);
642}
643
644static inline int ata_id_has_pm(const u16 *id)
645{
646 if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
647 return 0;
648 return id[ATA_ID_COMMAND_SET_1] & (1 << 3);
649}
650
651static inline int ata_id_rahead_enabled(const u16 *id)
652{
653 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
654 return 0;
655 return id[ATA_ID_CFS_ENABLE_1] & (1 << 6);
656}
657
658static inline int ata_id_wcache_enabled(const u16 *id)
659{
660 if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
661 return 0;
662 return id[ATA_ID_CFS_ENABLE_1] & (1 << 5);
663}
664
665/**
666 * ata_id_major_version - get ATA level of drive
667 * @id: Identify data
668 *
669 * Caveats:
670 * ATA-1 considers identify optional
671 * ATA-2 introduces mandatory identify
672 * ATA-3 introduces word 80 and accurate reporting
673 *
674 * The practical impact of this is that ata_id_major_version cannot
675 * reliably report on drives below ATA3.
676 */
677
678static inline unsigned int ata_id_major_version(const u16 *id)
679{
680 unsigned int mver;
681
682 if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
683 return 0;
684
685 for (mver = 14; mver >= 1; mver--)
686 if (id[ATA_ID_MAJOR_VER] & (1 << mver))
687 break;
688 return mver;
689}
690
691static inline int ata_id_is_sata(const u16 *id)
692{
693 /*
694 * See if word 93 is 0 AND drive is at least ATA-5 compatible
695 * verifying that word 80 by casting it to a signed type --
696 * this trick allows us to filter out the reserved values of
697 * 0x0000 and 0xffff along with the earlier ATA revisions...
698 */
699 if (id[ATA_ID_HW_CONFIG] == 0 && (short)id[ATA_ID_MAJOR_VER] >= 0x0020)
700 return 1;
701 return 0;
702}
703
704static inline int ata_id_has_tpm(const u16 *id)
705{
706 /* The TPM bits are only valid on ATA8 */
707 if (ata_id_major_version(id) < 8)
708 return 0;
709 if ((id[48] & 0xC000) != 0x4000)
710 return 0;
711 return id[48] & (1 << 0);
712}
713
714static inline int ata_id_has_dword_io(const u16 *id)
715{
716 /* ATA 8 reuses this flag for "trusted" computing */
717 if (ata_id_major_version(id) > 7)
718 return 0;
719 if (id[ATA_ID_DWORD_IO] & (1 << 0))
720 return 1;
721 return 0;
722}
723
724static inline int ata_id_has_unload(const u16 *id)
725{
726 if (ata_id_major_version(id) >= 7 &&
727 (id[ATA_ID_CFSSE] & 0xC000) == 0x4000 &&
728 id[ATA_ID_CFSSE] & (1 << 13))
729 return 1;
730 return 0;
731}
732
733static inline int ata_id_form_factor(const u16 *id)
734{
735 u16 val = id[168];
736
737 if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
738 return 0;
739
740 val &= 0xf;
741
742 if (val > 5)
743 return 0;
744
745 return val;
746}
747
748static inline int ata_id_rotation_rate(const u16 *id)
749{
750 u16 val = id[217];
751
752 if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
753 return 0;
754
755 if (val > 1 && val < 0x401)
756 return 0;
757
758 return val;
759}
760
761static inline int ata_id_has_trim(const u16 *id)
762{
763 if (ata_id_major_version(id) >= 7 &&
764 (id[ATA_ID_DATA_SET_MGMT] & 1))
765 return 1;
766 return 0;
767}
768
769static inline int ata_id_current_chs_valid(const u16 *id)
770{
771 /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
772 has not been issued to the device then the values of
773 id[ATA_ID_CUR_CYLS] to id[ATA_ID_CUR_SECTORS] are vendor specific. */
774 return (id[ATA_ID_FIELD_VALID] & 1) && /* Current translation valid */
775 id[ATA_ID_CUR_CYLS] && /* cylinders in current translation */
776 id[ATA_ID_CUR_HEADS] && /* heads in current translation */
777 id[ATA_ID_CUR_HEADS] <= 16 &&
778 id[ATA_ID_CUR_SECTORS]; /* sectors in current translation */
779}
780
781static inline int ata_id_is_cfa(const u16 *id)
782{
783 if (id[ATA_ID_CONFIG] == 0x848A) /* Traditional CF */
784 return 1;
785 /*
786 * CF specs don't require specific value in the word 0 anymore and yet
787 * they forbid to report the ATA version in the word 80 and require the
788 * CFA feature set support to be indicated in the word 83 in this case.
789 * Unfortunately, some cards only follow either of this requirements,
790 * and while those that don't indicate CFA feature support need some
791 * sort of quirk list, it seems impractical for the ones that do...
792 */
793 if ((id[ATA_ID_COMMAND_SET_2] & 0xC004) == 0x4004)
794 return 1;
795 return 0;
796}
797
798static inline int ata_id_is_ssd(const u16 *id)
799{
800 return id[ATA_ID_ROT_SPEED] == 0x01;
801}
802
803static inline int ata_drive_40wire(const u16 *dev_id)
804{
805 if (ata_id_is_sata(dev_id))
806 return 0; /* SATA */
807 if ((dev_id[ATA_ID_HW_CONFIG] & 0xE000) == 0x6000)
808 return 0; /* 80 wire */
809 return 1;
810}
811
812static inline int ata_drive_40wire_relaxed(const u16 *dev_id)
813{
814 if ((dev_id[ATA_ID_HW_CONFIG] & 0x2000) == 0x2000)
815 return 0; /* 80 wire */
816 return 1;
817}
818
819static inline int atapi_cdb_len(const u16 *dev_id)
820{
821 u16 tmp = dev_id[ATA_ID_CONFIG] & 0x3;
822 switch (tmp) {
823 case 0: return 12;
824 case 1: return 16;
825 default: return -1;
826 }
827}
828
829static inline int atapi_command_packet_set(const u16 *dev_id)
830{
831 return (dev_id[ATA_ID_CONFIG] >> 8) & 0x1f;
832}
833
834static inline int atapi_id_dmadir(const u16 *dev_id)
835{
836 return ata_id_major_version(dev_id) >= 7 && (dev_id[62] & 0x8000);
837}
838
839/*
840 * ata_id_is_lba_capacity_ok() performs a sanity check on
841 * the claimed LBA capacity value for the device.
842 *
843 * Returns 1 if LBA capacity looks sensible, 0 otherwise.
844 *
845 * It is called only once for each device.
846 */
847static inline int ata_id_is_lba_capacity_ok(u16 *id)
848{
849 unsigned long lba_sects, chs_sects, head, tail;
850
851 /* No non-LBA info .. so valid! */
852 if (id[ATA_ID_CYLS] == 0)
853 return 1;
854
855 lba_sects = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
856
857 /*
858 * The ATA spec tells large drives to return
859 * C/H/S = 16383/16/63 independent of their size.
860 * Some drives can be jumpered to use 15 heads instead of 16.
861 * Some drives can be jumpered to use 4092 cyls instead of 16383.
862 */
863 if ((id[ATA_ID_CYLS] == 16383 ||
864 (id[ATA_ID_CYLS] == 4092 && id[ATA_ID_CUR_CYLS] == 16383)) &&
865 id[ATA_ID_SECTORS] == 63 &&
866 (id[ATA_ID_HEADS] == 15 || id[ATA_ID_HEADS] == 16) &&
867 (lba_sects >= 16383 * 63 * id[ATA_ID_HEADS]))
868 return 1;
869
870 chs_sects = id[ATA_ID_CYLS] * id[ATA_ID_HEADS] * id[ATA_ID_SECTORS];
871
872 /* perform a rough sanity check on lba_sects: within 10% is OK */
873 if (lba_sects - chs_sects < chs_sects/10)
874 return 1;
875
876 /* some drives have the word order reversed */
877 head = (lba_sects >> 16) & 0xffff;
878 tail = lba_sects & 0xffff;
879 lba_sects = head | (tail << 16);
880
881 if (lba_sects - chs_sects < chs_sects/10) {
882 *(__le32 *)&id[ATA_ID_LBA_CAPACITY] = __cpu_to_le32(lba_sects);
883 return 1; /* LBA capacity is (now) good */
884 }
885
886 return 0; /* LBA capacity value may be bad */
887}
888
889static inline void ata_id_to_hd_driveid(u16 *id)
890{
891#ifdef __BIG_ENDIAN
892 /* accessed in struct hd_driveid as 8-bit values */
893 id[ATA_ID_MAX_MULTSECT] = __cpu_to_le16(id[ATA_ID_MAX_MULTSECT]);
894 id[ATA_ID_CAPABILITY] = __cpu_to_le16(id[ATA_ID_CAPABILITY]);
895 id[ATA_ID_OLD_PIO_MODES] = __cpu_to_le16(id[ATA_ID_OLD_PIO_MODES]);
896 id[ATA_ID_OLD_DMA_MODES] = __cpu_to_le16(id[ATA_ID_OLD_DMA_MODES]);
897 id[ATA_ID_MULTSECT] = __cpu_to_le16(id[ATA_ID_MULTSECT]);
898
899 /* as 32-bit values */
900 *(u32 *)&id[ATA_ID_LBA_CAPACITY] = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
901 *(u32 *)&id[ATA_ID_SPG] = ata_id_u32(id, ATA_ID_SPG);
902
903 /* as 64-bit value */
904 *(u64 *)&id[ATA_ID_LBA_CAPACITY_2] =
905 ata_id_u64(id, ATA_ID_LBA_CAPACITY_2);
906#endif
907}
908
909/*
910 * Write up to 'max' LBA Range Entries to the buffer that will cover the
911 * extent from sector to sector + count. This is used for TRIM and for
912 * ADD LBA(S) TO NV CACHE PINNED SET.
913 */
914static inline unsigned ata_set_lba_range_entries(void *_buffer, unsigned max,
915 u64 sector, unsigned long count)
916{
917 __le64 *buffer = _buffer;
918 unsigned i = 0;
919
920 while (i < max) {
921 u64 entry = sector |
922 ((u64)(count > 0xffff ? 0xffff : count) << 48);
923 buffer[i++] = __cpu_to_le64(entry);
924 if (count <= 0xffff)
925 break;
926 count -= 0xffff;
927 sector += 0xffff;
928 }
929
930 max = ALIGN(i * 8, 512);
931 memset(buffer + i, 0, max - i * 8);
932 return max;
933}
934
935static inline int is_multi_taskfile(struct ata_taskfile *tf)
936{
937 return (tf->command == ATA_CMD_READ_MULTI) ||
938 (tf->command == ATA_CMD_WRITE_MULTI) ||
939 (tf->command == ATA_CMD_READ_MULTI_EXT) ||
940 (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
941 (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
942}
943
944static inline int ata_ok(u8 status)
945{
946 return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
947 == ATA_DRDY);
948}
949
950static inline int lba_28_ok(u64 block, u32 n_block)
951{
952 /* check the ending block number */
953 return ((block + n_block) < ((u64)1 << 28)) && (n_block <= 256);
954}
955
956static inline int lba_48_ok(u64 block, u32 n_block)
957{
958 /* check the ending block number */
959 return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536);
960}
961
962#define sata_pmp_gscr_vendor(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
963#define sata_pmp_gscr_devid(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
964#define sata_pmp_gscr_rev(gscr) (((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
965#define sata_pmp_gscr_ports(gscr) ((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)
966
967#endif /* __LINUX_ATA_H__ */