xref: /openbmc/u-boot/include/libata.h (revision be059e88)
1 /*
2  * Copyright 2003-2004 Red Hat, Inc.  All rights reserved.
3  * Copyright 2003-2004 Jeff Garzik
4  * Copyright (C) 2008 Freescale Semiconductor, Inc.
5  *		Dave Liu <daveliu@freescale.com>
6  *		port from libata of linux kernel
7  *
8  * SPDX-License-Identifier:	GPL-2.0+
9  */
10 
11 #ifndef __LIBATA_H__
12 #define __LIBATA_H__
13 
14 #include <common.h>
15 
16 enum {
17 	/* various global constants */
18 	ATA_MAX_DEVICES		= 2,	/* per bus/port */
19 	ATA_MAX_PRD		= 256,	/* we could make these 256/256 */
20 	ATA_SECT_SIZE		= 512,
21 	ATA_MAX_SECTORS_128	= 128,
22 	ATA_MAX_SECTORS		= 256,
23 	ATA_MAX_SECTORS_LBA48	= 65535,
24 	ATA_MAX_SECTORS_TAPE	= 65535,
25 
26 	ATA_ID_WORDS		= 256,
27 	ATA_ID_SERNO		= 10,
28 	ATA_ID_FW_REV		= 23,
29 	ATA_ID_PROD		= 27,
30 	ATA_ID_OLD_PIO_MODES	= 51,
31 	ATA_ID_FIELD_VALID	= 53,
32 	ATA_ID_LBA_SECTORS	= 60,
33 	ATA_ID_MWDMA_MODES	= 63,
34 	ATA_ID_PIO_MODES	= 64,
35 	ATA_ID_EIDE_DMA_MIN	= 65,
36 	ATA_ID_EIDE_PIO		= 67,
37 	ATA_ID_EIDE_PIO_IORDY	= 68,
38 	ATA_ID_PIO4		= (1 << 1),
39 	ATA_ID_QUEUE_DEPTH	= 75,
40 	ATA_ID_SATA_CAP		= 76,
41 	ATA_ID_SATA_FEATURES	= 78,
42 	ATA_ID_SATA_FEATURES_EN	= 79,
43 	ATA_ID_MAJOR_VER	= 80,
44 	ATA_ID_MINOR_VER	= 81,
45 	ATA_ID_UDMA_MODES	= 88,
46 	ATA_ID_LBA48_SECTORS	= 100,
47 
48 	ATA_ID_SERNO_LEN	= 20,
49 	ATA_ID_FW_REV_LEN	= 8,
50 	ATA_ID_PROD_LEN		= 40,
51 
52 	ATA_PCI_CTL_OFS		= 2,
53 
54 	ATA_PIO0		= (1 << 0),
55 	ATA_PIO1		= ATA_PIO0 | (1 << 1),
56 	ATA_PIO2		= ATA_PIO1 | (1 << 2),
57 	ATA_PIO3		= ATA_PIO2 | (1 << 3),
58 	ATA_PIO4		= ATA_PIO3 | (1 << 4),
59 	ATA_PIO5		= ATA_PIO4 | (1 << 5),
60 	ATA_PIO6		= ATA_PIO5 | (1 << 6),
61 
62 	ATA_SWDMA0		= (1 << 0),
63 	ATA_SWDMA1		= ATA_SWDMA0 | (1 << 1),
64 	ATA_SWDMA2		= ATA_SWDMA1 | (1 << 2),
65 
66 	ATA_SWDMA2_ONLY		= (1 << 2),
67 
68 	ATA_MWDMA0		= (1 << 0),
69 	ATA_MWDMA1		= ATA_MWDMA0 | (1 << 1),
70 	ATA_MWDMA2		= ATA_MWDMA1 | (1 << 2),
71 
72 	ATA_MWDMA12_ONLY	= (1 << 1) | (1 << 2),
73 	ATA_MWDMA2_ONLY		= (1 << 2),
74 
75 	ATA_UDMA0		= (1 << 0),
76 	ATA_UDMA1		= ATA_UDMA0 | (1 << 1),
77 	ATA_UDMA2		= ATA_UDMA1 | (1 << 2),
78 	ATA_UDMA3		= ATA_UDMA2 | (1 << 3),
79 	ATA_UDMA4		= ATA_UDMA3 | (1 << 4),
80 	ATA_UDMA5		= ATA_UDMA4 | (1 << 5),
81 	ATA_UDMA6		= ATA_UDMA5 | (1 << 6),
82 	ATA_UDMA7		= ATA_UDMA6 | (1 << 7),
83 	/* ATA_UDMA7 is just for completeness... doesn't exist (yet?).  */
84 
85 	ATA_UDMA_MASK_40C	= ATA_UDMA2,	/* udma0-2 */
86 
87 	/* DMA-related */
88 	ATA_PRD_SZ		= 8,
89 	ATA_PRD_TBL_SZ		= (ATA_MAX_PRD * ATA_PRD_SZ),
90 	ATA_PRD_EOT		= (1 << 31),	/* end-of-table flag */
91 
92 	ATA_DMA_TABLE_OFS	= 4,
93 	ATA_DMA_STATUS		= 2,
94 	ATA_DMA_CMD		= 0,
95 	ATA_DMA_WR		= (1 << 3),
96 	ATA_DMA_START		= (1 << 0),
97 	ATA_DMA_INTR		= (1 << 2),
98 	ATA_DMA_ERR		= (1 << 1),
99 	ATA_DMA_ACTIVE		= (1 << 0),
100 
101 	/* bits in ATA command block registers */
102 	ATA_HOB			= (1 << 7),	/* LBA48 selector */
103 	ATA_NIEN		= (1 << 1),	/* disable-irq flag */
104 	ATA_LBA			= (1 << 6),	/* LBA28 selector */
105 	ATA_DEV1		= (1 << 4),	/* Select Device 1 (slave) */
106 	ATA_DEVICE_OBS		= (1 << 7) | (1 << 5), /* obs bits in dev reg */
107 	ATA_DEVCTL_OBS		= (1 << 3),	/* obsolete bit in devctl reg */
108 	ATA_BUSY		= (1 << 7),	/* BSY status bit */
109 	ATA_DRDY		= (1 << 6),	/* device ready */
110 	ATA_DF			= (1 << 5),	/* device fault */
111 	ATA_DRQ			= (1 << 3),	/* data request i/o */
112 	ATA_ERR			= (1 << 0),	/* have an error */
113 	ATA_SRST		= (1 << 2),	/* software reset */
114 	ATA_ICRC		= (1 << 7),	/* interface CRC error */
115 	ATA_UNC			= (1 << 6),	/* uncorrectable media error */
116 	ATA_IDNF		= (1 << 4),	/* ID not found */
117 	ATA_ABORTED		= (1 << 2),	/* command aborted */
118 
119 	/* ATA command block registers */
120 	ATA_REG_DATA		= 0x00,
121 	ATA_REG_ERR		= 0x01,
122 	ATA_REG_NSECT		= 0x02,
123 	ATA_REG_LBAL		= 0x03,
124 	ATA_REG_LBAM		= 0x04,
125 	ATA_REG_LBAH		= 0x05,
126 	ATA_REG_DEVICE		= 0x06,
127 	ATA_REG_STATUS		= 0x07,
128 
129 	ATA_REG_FEATURE		= ATA_REG_ERR, /* and their aliases */
130 	ATA_REG_CMD		= ATA_REG_STATUS,
131 	ATA_REG_BYTEL		= ATA_REG_LBAM,
132 	ATA_REG_BYTEH		= ATA_REG_LBAH,
133 	ATA_REG_DEVSEL		= ATA_REG_DEVICE,
134 	ATA_REG_IRQ		= ATA_REG_NSECT,
135 
136 	/* ATA device commands */
137 	ATA_CMD_DEV_RESET	= 0x08, /* ATAPI device reset */
138 	ATA_CMD_CHK_POWER	= 0xE5, /* check power mode */
139 	ATA_CMD_STANDBY		= 0xE2, /* place in standby power mode */
140 	ATA_CMD_IDLE		= 0xE3, /* place in idle power mode */
141 	ATA_CMD_EDD		= 0x90,	/* execute device diagnostic */
142 	ATA_CMD_FLUSH		= 0xE7,
143 	ATA_CMD_FLUSH_EXT	= 0xEA,
144 	ATA_CMD_ID_ATA		= 0xEC,
145 	ATA_CMD_ID_ATAPI	= 0xA1,
146 	ATA_CMD_READ		= 0xC8,
147 	ATA_CMD_READ_EXT	= 0x25,
148 	ATA_CMD_WRITE		= 0xCA,
149 	ATA_CMD_WRITE_EXT	= 0x35,
150 	ATA_CMD_WRITE_FUA_EXT	= 0x3D,
151 	ATA_CMD_FPDMA_READ	= 0x60,
152 	ATA_CMD_FPDMA_WRITE	= 0x61,
153 	ATA_CMD_PIO_READ	= 0x20,
154 	ATA_CMD_PIO_READ_EXT	= 0x24,
155 	ATA_CMD_PIO_WRITE	= 0x30,
156 	ATA_CMD_PIO_WRITE_EXT	= 0x34,
157 	ATA_CMD_READ_MULTI	= 0xC4,
158 	ATA_CMD_READ_MULTI_EXT	= 0x29,
159 	ATA_CMD_WRITE_MULTI	= 0xC5,
160 	ATA_CMD_WRITE_MULTI_EXT	= 0x39,
161 	ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
162 	ATA_CMD_SET_FEATURES	= 0xEF,
163 	ATA_CMD_SET_MULTI	= 0xC6,
164 	ATA_CMD_PACKET		= 0xA0,
165 	ATA_CMD_VERIFY		= 0x40,
166 	ATA_CMD_VERIFY_EXT	= 0x42,
167 	ATA_CMD_STANDBYNOW1	= 0xE0,
168 	ATA_CMD_IDLEIMMEDIATE	= 0xE1,
169 	ATA_CMD_SLEEP		= 0xE6,
170 	ATA_CMD_INIT_DEV_PARAMS	= 0x91,
171 	ATA_CMD_READ_NATIVE_MAX	= 0xF8,
172 	ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
173 	ATA_CMD_SET_MAX		= 0xF9,
174 	ATA_CMD_SET_MAX_EXT	= 0x37,
175 	ATA_CMD_READ_LOG_EXT	= 0x2f,
176 	ATA_CMD_PMP_READ	= 0xE4,
177 	ATA_CMD_PMP_WRITE	= 0xE8,
178 	ATA_CMD_CONF_OVERLAY	= 0xB1,
179 	ATA_CMD_SEC_FREEZE_LOCK	= 0xF5,
180 
181 	/* READ_LOG_EXT pages */
182 	ATA_LOG_SATA_NCQ	= 0x10,
183 
184 	/* READ/WRITE LONG (obsolete) */
185 	ATA_CMD_READ_LONG	= 0x22,
186 	ATA_CMD_READ_LONG_ONCE	= 0x23,
187 	ATA_CMD_WRITE_LONG	= 0x32,
188 	ATA_CMD_WRITE_LONG_ONCE	= 0x33,
189 
190 	/* SETFEATURES stuff */
191 	SETFEATURES_XFER	= 0x03,
192 	XFER_UDMA_7		= 0x47,
193 	XFER_UDMA_6		= 0x46,
194 	XFER_UDMA_5		= 0x45,
195 	XFER_UDMA_4		= 0x44,
196 	XFER_UDMA_3		= 0x43,
197 	XFER_UDMA_2		= 0x42,
198 	XFER_UDMA_1		= 0x41,
199 	XFER_UDMA_0		= 0x40,
200 	XFER_MW_DMA_4		= 0x24,	/* CFA only */
201 	XFER_MW_DMA_3		= 0x23,	/* CFA only */
202 	XFER_MW_DMA_2		= 0x22,
203 	XFER_MW_DMA_1		= 0x21,
204 	XFER_MW_DMA_0		= 0x20,
205 	XFER_SW_DMA_2		= 0x12,
206 	XFER_SW_DMA_1		= 0x11,
207 	XFER_SW_DMA_0		= 0x10,
208 	XFER_PIO_6		= 0x0E,	/* CFA only */
209 	XFER_PIO_5		= 0x0D,	/* CFA only */
210 	XFER_PIO_4		= 0x0C,
211 	XFER_PIO_3		= 0x0B,
212 	XFER_PIO_2		= 0x0A,
213 	XFER_PIO_1		= 0x09,
214 	XFER_PIO_0		= 0x08,
215 	XFER_PIO_SLOW		= 0x00,
216 
217 	SETFEATURES_WC_ON	= 0x02, /* Enable write cache */
218 	SETFEATURES_WC_OFF	= 0x82, /* Disable write cache */
219 
220 	SETFEATURES_SPINUP	= 0x07, /* Spin-up drive */
221 
222 	SETFEATURES_SATA_ENABLE = 0x10, /* Enable use of SATA feature */
223 	SETFEATURES_SATA_DISABLE = 0x90, /* Disable use of SATA feature */
224 
225 	/* SETFEATURE Sector counts for SATA features */
226 	SATA_AN			= 0x05,  /* Asynchronous Notification */
227 	SATA_DIPM		= 0x03,  /* Device Initiated Power Management */
228 
229 	/* feature values for SET_MAX */
230 	ATA_SET_MAX_ADDR	= 0x00,
231 	ATA_SET_MAX_PASSWD	= 0x01,
232 	ATA_SET_MAX_LOCK	= 0x02,
233 	ATA_SET_MAX_UNLOCK	= 0x03,
234 	ATA_SET_MAX_FREEZE_LOCK	= 0x04,
235 
236 	/* feature values for DEVICE CONFIGURATION OVERLAY */
237 	ATA_DCO_RESTORE		= 0xC0,
238 	ATA_DCO_FREEZE_LOCK	= 0xC1,
239 	ATA_DCO_IDENTIFY	= 0xC2,
240 	ATA_DCO_SET		= 0xC3,
241 
242 	/* ATAPI stuff */
243 	ATAPI_PKT_DMA		= (1 << 0),
244 	ATAPI_DMADIR		= (1 << 2),	/* ATAPI data dir:
245 						   0=to device, 1=to host */
246 	ATAPI_CDB_LEN		= 16,
247 
248 	/* PMP stuff */
249 	SATA_PMP_MAX_PORTS	= 15,
250 	SATA_PMP_CTRL_PORT	= 15,
251 
252 	SATA_PMP_GSCR_DWORDS	= 128,
253 	SATA_PMP_GSCR_PROD_ID	= 0,
254 	SATA_PMP_GSCR_REV	= 1,
255 	SATA_PMP_GSCR_PORT_INFO	= 2,
256 	SATA_PMP_GSCR_ERROR	= 32,
257 	SATA_PMP_GSCR_ERROR_EN	= 33,
258 	SATA_PMP_GSCR_FEAT	= 64,
259 	SATA_PMP_GSCR_FEAT_EN	= 96,
260 
261 	SATA_PMP_PSCR_STATUS	= 0,
262 	SATA_PMP_PSCR_ERROR	= 1,
263 	SATA_PMP_PSCR_CONTROL	= 2,
264 
265 	SATA_PMP_FEAT_BIST	= (1 << 0),
266 	SATA_PMP_FEAT_PMREQ	= (1 << 1),
267 	SATA_PMP_FEAT_DYNSSC	= (1 << 2),
268 	SATA_PMP_FEAT_NOTIFY	= (1 << 3),
269 
270 	/* cable types */
271 	ATA_CBL_NONE		= 0,
272 	ATA_CBL_PATA40		= 1,
273 	ATA_CBL_PATA80		= 2,
274 	ATA_CBL_PATA40_SHORT	= 3,	/* 40 wire cable to high UDMA spec */
275 	ATA_CBL_PATA_UNK	= 4,	/* don't know, maybe 80c? */
276 	ATA_CBL_PATA_IGN	= 5,	/* don't know, ignore cable handling */
277 	ATA_CBL_SATA		= 6,
278 
279 	/* SATA Status and Control Registers */
280 	SCR_STATUS		= 0,
281 	SCR_ERROR		= 1,
282 	SCR_CONTROL		= 2,
283 	SCR_ACTIVE		= 3,
284 	SCR_NOTIFICATION	= 4,
285 
286 	/* SError bits */
287 	SERR_DATA_RECOVERED	= (1 << 0), /* recovered data error */
288 	SERR_COMM_RECOVERED	= (1 << 1), /* recovered comm failure */
289 	SERR_DATA		= (1 << 8), /* unrecovered data error */
290 	SERR_PERSISTENT		= (1 << 9), /* persistent data/comm error */
291 	SERR_PROTOCOL		= (1 << 10), /* protocol violation */
292 	SERR_INTERNAL		= (1 << 11), /* host internal error */
293 	SERR_PHYRDY_CHG		= (1 << 16), /* PHY RDY changed */
294 	SERR_PHY_INT_ERR	= (1 << 17), /* PHY internal error */
295 	SERR_COMM_WAKE		= (1 << 18), /* Comm wake */
296 	SERR_10B_8B_ERR		= (1 << 19), /* 10b to 8b decode error */
297 	SERR_DISPARITY		= (1 << 20), /* Disparity */
298 	SERR_CRC		= (1 << 21), /* CRC error */
299 	SERR_HANDSHAKE		= (1 << 22), /* Handshake error */
300 	SERR_LINK_SEQ_ERR	= (1 << 23), /* Link sequence error */
301 	SERR_TRANS_ST_ERROR	= (1 << 24), /* Transport state trans. error */
302 	SERR_UNRECOG_FIS	= (1 << 25), /* Unrecognized FIS */
303 	SERR_DEV_XCHG		= (1 << 26), /* device exchanged */
304 
305 	/* struct ata_taskfile flags */
306 	ATA_TFLAG_LBA48		= (1 << 0), /* enable 48-bit LBA and "HOB" */
307 	ATA_TFLAG_ISADDR	= (1 << 1), /* enable r/w to nsect/lba regs */
308 	ATA_TFLAG_DEVICE	= (1 << 2), /* enable r/w to device reg */
309 	ATA_TFLAG_WRITE		= (1 << 3), /* data dir: host->dev==1 (write) */
310 	ATA_TFLAG_LBA		= (1 << 4), /* enable LBA */
311 	ATA_TFLAG_FUA		= (1 << 5), /* enable FUA */
312 	ATA_TFLAG_POLLING	= (1 << 6), /* set nIEN to 1 and use polling */
313 
314 	/* protocol flags */
315 	ATA_PROT_FLAG_PIO	= (1 << 0), /* is PIO */
316 	ATA_PROT_FLAG_DMA	= (1 << 1), /* is DMA */
317 	ATA_PROT_FLAG_DATA	= ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA,
318 	ATA_PROT_FLAG_NCQ	= (1 << 2), /* is NCQ */
319 	ATA_PROT_FLAG_ATAPI	= (1 << 3), /* is ATAPI */
320 };
321 
322 enum ata_tf_protocols {
323 	/* ATA taskfile protocols */
324 	ATA_PROT_UNKNOWN,	/* unknown/invalid */
325 	ATA_PROT_NODATA,	/* no data */
326 	ATA_PROT_PIO,		/* PIO data xfer */
327 	ATA_PROT_DMA,		/* DMA */
328 	ATA_PROT_NCQ,		/* NCQ */
329 	ATAPI_PROT_NODATA,	/* packet command, no data */
330 	ATAPI_PROT_PIO,		/* packet command, PIO data xfer*/
331 	ATAPI_PROT_DMA,		/* packet command with special DMA sauce */
332 };
333 
334 enum ata_ioctls {
335 	ATA_IOC_GET_IO32	= 0x309,
336 	ATA_IOC_SET_IO32	= 0x324,
337 };
338 
339 enum ata_dev_typed {
340 	ATA_DEV_ATA,		/* ATA device */
341 	ATA_DEV_ATAPI,		/* ATAPI device */
342 	ATA_DEV_PMP,		/* Port Multiplier Port */
343 	ATA_DEV_UNKNOWN,	/* unknown */
344 };
345 
346 struct ata_taskfile {
347 	unsigned long		flags;		/* ATA_TFLAG_xxx */
348 	u8			protocol;	/* ATA_PROT_xxx */
349 
350 	u8			ctl;		/* control reg */
351 
352 	u8			hob_feature;	/* additional data */
353 	u8			hob_nsect;	/* to support LBA48 */
354 	u8			hob_lbal;
355 	u8			hob_lbam;
356 	u8			hob_lbah;
357 
358 	u8			feature;
359 	u8			nsect;
360 	u8			lbal;
361 	u8			lbam;
362 	u8			lbah;
363 
364 	u8			device;
365 
366 	u8			command;	/* IO operation */
367 };
368 
369 /*
370  * protocol tests
371  */
372 static inline unsigned int ata_prot_flags(u8 prot)
373 {
374 	switch (prot) {
375 	case ATA_PROT_NODATA:
376 		return 0;
377 	case ATA_PROT_PIO:
378 		return ATA_PROT_FLAG_PIO;
379 	case ATA_PROT_DMA:
380 		return ATA_PROT_FLAG_DMA;
381 	case ATA_PROT_NCQ:
382 		return ATA_PROT_FLAG_DMA | ATA_PROT_FLAG_NCQ;
383 	case ATAPI_PROT_NODATA:
384 		return ATA_PROT_FLAG_ATAPI;
385 	case ATAPI_PROT_PIO:
386 		return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_PIO;
387 	case ATAPI_PROT_DMA:
388 		return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_DMA;
389 	}
390 	return 0;
391 }
392 
393 static inline int ata_is_atapi(u8 prot)
394 {
395 	return ata_prot_flags(prot) & ATA_PROT_FLAG_ATAPI;
396 }
397 
398 static inline int ata_is_nodata(u8 prot)
399 {
400 	return !(ata_prot_flags(prot) & ATA_PROT_FLAG_DATA);
401 }
402 
403 static inline int ata_is_pio(u8 prot)
404 {
405 	return ata_prot_flags(prot) & ATA_PROT_FLAG_PIO;
406 }
407 
408 static inline int ata_is_dma(u8 prot)
409 {
410 	return ata_prot_flags(prot) & ATA_PROT_FLAG_DMA;
411 }
412 
413 static inline int ata_is_ncq(u8 prot)
414 {
415 	return ata_prot_flags(prot) & ATA_PROT_FLAG_NCQ;
416 }
417 
418 static inline int ata_is_data(u8 prot)
419 {
420 	return ata_prot_flags(prot) & ATA_PROT_FLAG_DATA;
421 }
422 
423 /*
424  * id tests
425  */
426 #define ata_id_is_ata(id)		(((id)[0] & (1 << 15)) == 0)
427 #define ata_id_has_lba(id)		((id)[49] & (1 << 9))
428 #define ata_id_has_dma(id)		((id)[49] & (1 << 8))
429 #define ata_id_has_ncq(id)		((id)[76] & (1 << 8))
430 #define ata_id_queue_depth(id)		(((id)[75] & 0x1f) + 1)
431 #define ata_id_removeable(id)		((id)[0] & (1 << 7))
432 #define ata_id_iordy_disable(id)	((id)[49] & (1 << 10))
433 #define ata_id_has_iordy(id)		((id)[49] & (1 << 11))
434 
435 #define ata_id_u32(id,n)	\
436 	(((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
437 #define ata_id_u64(id,n)	\
438 	( ((u64) (id)[(n) + 3] << 48) | \
439 	  ((u64) (id)[(n) + 2] << 32) | \
440 	  ((u64) (id)[(n) + 1] << 16) | \
441 	  ((u64) (id)[(n) + 0]) )
442 
443 #define ata_id_cdb_intr(id)		(((id)[0] & 0x60) == 0x20)
444 
445 static inline int ata_id_has_fua(const u16 *id)
446 {
447 	if ((id[84] & 0xC000) != 0x4000)
448 		return 0;
449 	return id[84] & (1 << 6);
450 }
451 
452 static inline int ata_id_has_flush(const u16 *id)
453 {
454 	if ((id[83] & 0xC000) != 0x4000)
455 		return 0;
456 	return id[83] & (1 << 12);
457 }
458 
459 static inline int ata_id_has_flush_ext(const u16 *id)
460 {
461 	if ((id[83] & 0xC000) != 0x4000)
462 		return 0;
463 	return id[83] & (1 << 13);
464 }
465 
466 static inline int ata_id_has_lba48(const u16 *id)
467 {
468 	if ((id[83] & 0xC000) != 0x4000)
469 		return 0;
470 	if (!ata_id_u64(id, 100))
471 		return 0;
472 	return id[83] & (1 << 10);
473 }
474 
475 static inline int ata_id_hpa_enabled(const u16 *id)
476 {
477 	/* Yes children, word 83 valid bits cover word 82 data */
478 	if ((id[83] & 0xC000) != 0x4000)
479 		return 0;
480 	/* And 87 covers 85-87 */
481 	if ((id[87] & 0xC000) != 0x4000)
482 		return 0;
483 	/* Check command sets enabled as well as supported */
484 	if ((id[85] & ( 1 << 10)) == 0)
485 		return 0;
486 	return id[82] & (1 << 10);
487 }
488 
489 static inline int ata_id_has_wcache(const u16 *id)
490 {
491 	/* Yes children, word 83 valid bits cover word 82 data */
492 	if ((id[83] & 0xC000) != 0x4000)
493 		return 0;
494 	return id[82] & (1 << 5);
495 }
496 
497 static inline int ata_id_has_pm(const u16 *id)
498 {
499 	if ((id[83] & 0xC000) != 0x4000)
500 		return 0;
501 	return id[82] & (1 << 3);
502 }
503 
504 static inline int ata_id_rahead_enabled(const u16 *id)
505 {
506 	if ((id[87] & 0xC000) != 0x4000)
507 		return 0;
508 	return id[85] & (1 << 6);
509 }
510 
511 static inline int ata_id_wcache_enabled(const u16 *id)
512 {
513 	if ((id[87] & 0xC000) != 0x4000)
514 		return 0;
515 	return id[85] & (1 << 5);
516 }
517 
518 static inline unsigned int ata_id_major_version(const u16 *id)
519 {
520 	unsigned int mver;
521 
522 	if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
523 		return 0;
524 
525 	for (mver = 14; mver >= 1; mver--)
526 		if (id[ATA_ID_MAJOR_VER] & (1 << mver))
527 			break;
528 	return mver;
529 }
530 
531 static inline int ata_id_is_sata(const u16 *id)
532 {
533 	return ata_id_major_version(id) >= 5 && id[93] == 0;
534 }
535 
536 static inline int ata_id_has_tpm(const u16 *id)
537 {
538 	/* The TPM bits are only valid on ATA8 */
539 	if (ata_id_major_version(id) < 8)
540 		return 0;
541 	if ((id[48] & 0xC000) != 0x4000)
542 		return 0;
543 	return id[48] & (1 << 0);
544 }
545 
546 static inline int ata_id_has_dword_io(const u16 *id)
547 {
548 	/* ATA 8 reuses this flag for "trusted" computing */
549 	if (ata_id_major_version(id) > 7)
550 		return 0;
551 	if (id[48] & (1 << 0))
552 		return 1;
553 	return 0;
554 }
555 
556 static inline int ata_id_current_chs_valid(const u16 *id)
557 {
558 	/* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
559 	   has not been issued to the device then the values of
560 	   id[54] to id[56] are vendor specific. */
561 	return (id[53] & 0x01) && /* Current translation valid */
562 		id[54] &&  /* cylinders in current translation */
563 		id[55] &&  /* heads in current translation */
564 		id[55] <= 16 &&
565 		id[56];    /* sectors in current translation */
566 }
567 
568 static inline int ata_id_is_cfa(const u16 *id)
569 {
570 	u16 v = id[0];
571 	if (v == 0x848A)	/* Standard CF */
572 		return 1;
573 	/* Could be CF hiding as standard ATA */
574 	if (ata_id_major_version(id) >= 3 &&  id[82] != 0xFFFF &&
575 			(id[82] & ( 1 << 2)))
576 		return 1;
577 	return 0;
578 }
579 
580 static inline int ata_drive_40wire(const u16 *dev_id)
581 {
582 	if (ata_id_is_sata(dev_id))
583 		return 0;	/* SATA */
584 	if ((dev_id[93] & 0xE000) == 0x6000)
585 		return 0;	/* 80 wire */
586 	return 1;
587 }
588 
589 static inline int ata_drive_40wire_relaxed(const u16 *dev_id)
590 {
591 	if ((dev_id[93] & 0x2000) == 0x2000)
592 		return 0;	/* 80 wire */
593 	return 1;
594 }
595 
596 static inline int atapi_cdb_len(const u16 *dev_id)
597 {
598 	u16 tmp = dev_id[0] & 0x3;
599 	switch (tmp) {
600 	case 0:		return 12;
601 	case 1:		return 16;
602 	default:	return -1;
603 	}
604 }
605 
606 static inline int atapi_command_packet_set(const u16 *dev_id)
607 {
608 	return (dev_id[0] >> 8) & 0x1f;
609 }
610 
611 static inline int atapi_id_dmadir(const u16 *dev_id)
612 {
613 	return ata_id_major_version(dev_id) >= 7 && (dev_id[62] & 0x8000);
614 }
615 
616 static inline int is_multi_taskfile(struct ata_taskfile *tf)
617 {
618 	return (tf->command == ATA_CMD_READ_MULTI) ||
619 	       (tf->command == ATA_CMD_WRITE_MULTI) ||
620 	       (tf->command == ATA_CMD_READ_MULTI_EXT) ||
621 	       (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
622 	       (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
623 }
624 
625 static inline int ata_ok(u8 status)
626 {
627 	return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
628 			== ATA_DRDY);
629 }
630 
631 static inline int lba_28_ok(u64 block, u32 n_block)
632 {
633 	/* check the ending block number */
634 	return ((block + n_block - 1) < ((u64)1 << 28)) && (n_block <= 256);
635 }
636 
637 static inline int lba_48_ok(u64 block, u32 n_block)
638 {
639 	/* check the ending block number */
640 	return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536);
641 }
642 
643 #define sata_pmp_gscr_vendor(gscr)	((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
644 #define sata_pmp_gscr_devid(gscr)	((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
645 #define sata_pmp_gscr_rev(gscr)		(((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
646 #define sata_pmp_gscr_ports(gscr)	((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)
647 
648 u64 ata_id_n_sectors(u16 *id);
649 u32 ata_dev_classify(u32 sig);
650 void ata_id_c_string(const u16 *id, unsigned char *s,
651 			 unsigned int ofs, unsigned int len);
652 void ata_dump_id(u16 *id);
653 void ata_swap_buf_le16(u16 *buf, unsigned int buf_words);
654 
655 #endif /* __LIBATA_H__ */
656