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