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