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