[linux.git] / include / linux / ata.h


/*
 *  Copyright 2003-2004 Red Hat, Inc.  All rights reserved.
 *  Copyright 2003-2004 Jeff Garzik
 *
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2, or (at your option)
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; see the file COPYING.  If not, write to
 *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *
 *  libata documentation is available via 'make {ps|pdf}docs',
 *  as Documentation/DocBook/libata.*
 *
 *  Hardware documentation available from http://www.t13.org/
 *
 */

#ifndef __LINUX_ATA_H__
#define __LINUX_ATA_H__

#include <linux/types.h>

/* defines only for the constants which don't work well as enums */
#define ATA_DMA_BOUNDARY	0xffffUL
#define ATA_DMA_MASK		0xffffffffULL

enum {
	/* various global constants */
	ATA_MAX_DEVICES		= 2,	/* per bus/port */
	ATA_MAX_PRD		= 256,	/* we could make these 256/256 */
	ATA_SECT_SIZE		= 512,

	ATA_ID_WORDS		= 256,
	ATA_ID_SERNO_OFS	= 10,
	ATA_ID_FW_REV_OFS	= 23,
	ATA_ID_PROD_OFS		= 27,
	ATA_ID_OLD_PIO_MODES	= 51,
	ATA_ID_FIELD_VALID	= 53,
	ATA_ID_MWDMA_MODES	= 63,
	ATA_ID_PIO_MODES	= 64,
	ATA_ID_EIDE_DMA_MIN	= 65,
	ATA_ID_EIDE_PIO		= 67,
	ATA_ID_EIDE_PIO_IORDY	= 68,
	ATA_ID_UDMA_MODES	= 88,
	ATA_ID_MAJOR_VER	= 80,
	ATA_ID_PIO4		= (1 << 1),

	ATA_PCI_CTL_OFS		= 2,
	ATA_SERNO_LEN		= 20,
	ATA_UDMA0		= (1 << 0),
	ATA_UDMA1		= ATA_UDMA0 | (1 << 1),
	ATA_UDMA2		= ATA_UDMA1 | (1 << 2),
	ATA_UDMA3		= ATA_UDMA2 | (1 << 3),
	ATA_UDMA4		= ATA_UDMA3 | (1 << 4),
	ATA_UDMA5		= ATA_UDMA4 | (1 << 5),
	ATA_UDMA6		= ATA_UDMA5 | (1 << 6),
	ATA_UDMA7		= ATA_UDMA6 | (1 << 7),
	/* ATA_UDMA7 is just for completeness... doesn't exist (yet?).  */

	ATA_UDMA_MASK_40C	= ATA_UDMA2,	/* udma0-2 */

	/* DMA-related */
	ATA_PRD_SZ		= 8,
	ATA_PRD_TBL_SZ		= (ATA_MAX_PRD * ATA_PRD_SZ),
	ATA_PRD_EOT		= (1 << 31),	/* end-of-table flag */

	ATA_DMA_TABLE_OFS	= 4,
	ATA_DMA_STATUS		= 2,
	ATA_DMA_CMD		= 0,
	ATA_DMA_WR		= (1 << 3),
	ATA_DMA_START		= (1 << 0),
	ATA_DMA_INTR		= (1 << 2),
	ATA_DMA_ERR		= (1 << 1),
	ATA_DMA_ACTIVE		= (1 << 0),

	/* bits in ATA command block registers */
	ATA_HOB			= (1 << 7),	/* LBA48 selector */
	ATA_NIEN		= (1 << 1),	/* disable-irq flag */
	ATA_LBA			= (1 << 6),	/* LBA28 selector */
	ATA_DEV1		= (1 << 4),	/* Select Device 1 (slave) */
	ATA_DEVICE_OBS		= (1 << 7) | (1 << 5), /* obs bits in dev reg */
	ATA_DEVCTL_OBS		= (1 << 3),	/* obsolete bit in devctl reg */
	ATA_BUSY		= (1 << 7),	/* BSY status bit */
	ATA_DRDY		= (1 << 6),	/* device ready */
	ATA_DF			= (1 << 5),	/* device fault */
	ATA_DRQ			= (1 << 3),	/* data request i/o */
	ATA_ERR			= (1 << 0),	/* have an error */
	ATA_SRST		= (1 << 2),	/* software reset */
	ATA_ICRC		= (1 << 7),	/* interface CRC error */
	ATA_UNC			= (1 << 6),	/* uncorrectable media error */
	ATA_IDNF		= (1 << 4),	/* ID not found */
	ATA_ABORTED		= (1 << 2),	/* command aborted */

	/* ATA command block registers */
	ATA_REG_DATA		= 0x00,
	ATA_REG_ERR		= 0x01,
	ATA_REG_NSECT		= 0x02,
	ATA_REG_LBAL		= 0x03,
	ATA_REG_LBAM		= 0x04,
	ATA_REG_LBAH		= 0x05,
	ATA_REG_DEVICE		= 0x06,
	ATA_REG_STATUS		= 0x07,

	ATA_REG_FEATURE		= ATA_REG_ERR, /* and their aliases */
	ATA_REG_CMD		= ATA_REG_STATUS,
	ATA_REG_BYTEL		= ATA_REG_LBAM,
	ATA_REG_BYTEH		= ATA_REG_LBAH,
	ATA_REG_DEVSEL		= ATA_REG_DEVICE,
	ATA_REG_IRQ		= ATA_REG_NSECT,

	/* ATA device commands */
	ATA_CMD_CHK_POWER	= 0xE5, /* check power mode */
	ATA_CMD_STANDBY		= 0xE2, /* place in standby power mode */
	ATA_CMD_IDLE		= 0xE3, /* place in idle power mode */
	ATA_CMD_EDD		= 0x90,	/* execute device diagnostic */
	ATA_CMD_FLUSH		= 0xE7,
	ATA_CMD_FLUSH_EXT	= 0xEA,
	ATA_CMD_ID_ATA		= 0xEC,
	ATA_CMD_ID_ATAPI	= 0xA1,
	ATA_CMD_READ		= 0xC8,
	ATA_CMD_READ_EXT	= 0x25,
	ATA_CMD_WRITE		= 0xCA,
	ATA_CMD_WRITE_EXT	= 0x35,
	ATA_CMD_WRITE_FUA_EXT	= 0x3D,
	ATA_CMD_PIO_READ	= 0x20,
	ATA_CMD_PIO_READ_EXT	= 0x24,
	ATA_CMD_PIO_WRITE	= 0x30,
	ATA_CMD_PIO_WRITE_EXT	= 0x34,
	ATA_CMD_READ_MULTI	= 0xC4,
	ATA_CMD_READ_MULTI_EXT	= 0x29,
	ATA_CMD_WRITE_MULTI	= 0xC5,
	ATA_CMD_WRITE_MULTI_EXT	= 0x39,
	ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
	ATA_CMD_SET_FEATURES	= 0xEF,
	ATA_CMD_PACKET		= 0xA0,
	ATA_CMD_VERIFY		= 0x40,
	ATA_CMD_VERIFY_EXT	= 0x42,
 	ATA_CMD_STANDBYNOW1	= 0xE0,
 	ATA_CMD_IDLEIMMEDIATE	= 0xE1,
	ATA_CMD_INIT_DEV_PARAMS	= 0x91,
	ATA_CMD_READ_NATIVE_MAX	= 0xF8,
	ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,

	/* SETFEATURES stuff */
	SETFEATURES_XFER	= 0x03,
	XFER_UDMA_7		= 0x47,
	XFER_UDMA_6		= 0x46,
	XFER_UDMA_5		= 0x45,
	XFER_UDMA_4		= 0x44,
	XFER_UDMA_3		= 0x43,
	XFER_UDMA_2		= 0x42,
	XFER_UDMA_1		= 0x41,
	XFER_UDMA_0		= 0x40,
	XFER_MW_DMA_2		= 0x22,
	XFER_MW_DMA_1		= 0x21,
	XFER_MW_DMA_0		= 0x20,
	XFER_SW_DMA_2		= 0x12,
	XFER_SW_DMA_1		= 0x11,
	XFER_SW_DMA_0		= 0x10,
	XFER_PIO_4		= 0x0C,
	XFER_PIO_3		= 0x0B,
	XFER_PIO_2		= 0x0A,
	XFER_PIO_1		= 0x09,
	XFER_PIO_0		= 0x08,
	XFER_PIO_SLOW		= 0x00,

	/* ATAPI stuff */
	ATAPI_PKT_DMA		= (1 << 0),
	ATAPI_DMADIR		= (1 << 2),	/* ATAPI data dir:
						   0=to device, 1=to host */
	ATAPI_CDB_LEN		= 16,

	/* cable types */
	ATA_CBL_NONE		= 0,
	ATA_CBL_PATA40		= 1,
	ATA_CBL_PATA80		= 2,
	ATA_CBL_PATA_UNK	= 3,
	ATA_CBL_SATA		= 4,

	/* SATA Status and Control Registers */
	SCR_STATUS		= 0,
	SCR_ERROR		= 1,
	SCR_CONTROL		= 2,
	SCR_ACTIVE		= 3,
	SCR_NOTIFICATION	= 4,

	/* SError bits */
	SERR_DATA_RECOVERED	= (1 << 0), /* recovered data error */
	SERR_COMM_RECOVERED	= (1 << 1), /* recovered comm failure */
	SERR_DATA		= (1 << 8), /* unrecovered data error */
	SERR_PERSISTENT		= (1 << 9), /* persistent data/comm error */
	SERR_PROTOCOL		= (1 << 10), /* protocol violation */
	SERR_INTERNAL		= (1 << 11), /* host internal error */
	SERR_PHYRDY_CHG		= (1 << 16), /* PHY RDY changed */
	SERR_DEV_XCHG		= (1 << 26), /* device exchanged */

	/* struct ata_taskfile flags */
	ATA_TFLAG_LBA48		= (1 << 0), /* enable 48-bit LBA and "HOB" */
	ATA_TFLAG_ISADDR	= (1 << 1), /* enable r/w to nsect/lba regs */
	ATA_TFLAG_DEVICE	= (1 << 2), /* enable r/w to device reg */
	ATA_TFLAG_WRITE		= (1 << 3), /* data dir: host->dev==1 (write) */
	ATA_TFLAG_LBA		= (1 << 4), /* enable LBA */
	ATA_TFLAG_FUA		= (1 << 5), /* enable FUA */
	ATA_TFLAG_POLLING	= (1 << 6), /* set nIEN to 1 and use polling */
};

enum ata_tf_protocols {
	/* ATA taskfile protocols */
	ATA_PROT_UNKNOWN,	/* unknown/invalid */
	ATA_PROT_NODATA,	/* no data */
	ATA_PROT_PIO,		/* PIO single sector */
	ATA_PROT_DMA,		/* DMA */
	ATA_PROT_ATAPI,		/* packet command, PIO data xfer*/
	ATA_PROT_ATAPI_NODATA,	/* packet command, no data */
	ATA_PROT_ATAPI_DMA,	/* packet command with special DMA sauce */
};

enum ata_ioctls {
	ATA_IOC_GET_IO32	= 0x309,
	ATA_IOC_SET_IO32	= 0x324,
};

/* core structures */

struct ata_prd {
	u32			addr;
	u32			flags_len;
};

struct ata_taskfile {
	unsigned long		flags;		/* ATA_TFLAG_xxx */
	u8			protocol;	/* ATA_PROT_xxx */

	u8			ctl;		/* control reg */

	u8			hob_feature;	/* additional data */
	u8			hob_nsect;	/* to support LBA48 */
	u8			hob_lbal;
	u8			hob_lbam;
	u8			hob_lbah;

	u8			feature;
	u8			nsect;
	u8			lbal;
	u8			lbam;
	u8			lbah;

	u8			device;

	u8			command;	/* IO operation */
};

#define ata_id_is_ata(id)	(((id)[0] & (1 << 15)) == 0)
#define ata_id_is_cfa(id)	((id)[0] == 0x848A)
#define ata_id_is_sata(id)	((id)[93] == 0)
#define ata_id_rahead_enabled(id) ((id)[85] & (1 << 6))
#define ata_id_wcache_enabled(id) ((id)[85] & (1 << 5))
#define ata_id_hpa_enabled(id)	((id)[85] & (1 << 10))
#define ata_id_has_fua(id)	((id)[84] & (1 << 6))
#define ata_id_has_flush(id)	((id)[83] & (1 << 12))
#define ata_id_has_flush_ext(id) ((id)[83] & (1 << 13))
#define ata_id_has_lba48(id)	((id)[83] & (1 << 10))
#define ata_id_has_hpa(id)	((id)[82] & (1 << 10))
#define ata_id_has_wcache(id)	((id)[82] & (1 << 5))
#define ata_id_has_pm(id)	((id)[82] & (1 << 3))
#define ata_id_has_lba(id)	((id)[49] & (1 << 9))
#define ata_id_has_dma(id)	((id)[49] & (1 << 8))
#define ata_id_removeable(id)	((id)[0] & (1 << 7))
#define ata_id_has_dword_io(id)	((id)[50] & (1 << 0))
#define ata_id_u32(id,n)	\
	(((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
#define ata_id_u64(id,n)	\
	( ((u64) (id)[(n) + 3] << 48) |	\
	  ((u64) (id)[(n) + 2] << 32) |	\
	  ((u64) (id)[(n) + 1] << 16) |	\
	  ((u64) (id)[(n) + 0]) )

#define ata_id_cdb_intr(id)	(((id)[0] & 0x60) == 0x20)

static inline unsigned int ata_id_major_version(const u16 *id)
{
	unsigned int mver;

	for (mver = 14; mver >= 1; mver--)
		if (id[ATA_ID_MAJOR_VER] & (1 << mver))
			break;
	return mver;
}

static inline int ata_id_current_chs_valid(const u16 *id)
{
	/* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command 
	   has not been issued to the device then the values of 
	   id[54] to id[56] are vendor specific. */
	return (id[53] & 0x01) && /* Current translation valid */
		id[54] &&  /* cylinders in current translation */
		id[55] &&  /* heads in current translation */
		id[55] <= 16 &&
		id[56];    /* sectors in current translation */
}

static inline int atapi_cdb_len(const u16 *dev_id)
{
	u16 tmp = dev_id[0] & 0x3;
	switch (tmp) {
	case 0:		return 12;
	case 1:		return 16;
	default:	return -1;
	}
}

static inline int is_atapi_taskfile(const struct ata_taskfile *tf)
{
	return (tf->protocol == ATA_PROT_ATAPI) ||
	       (tf->protocol == ATA_PROT_ATAPI_NODATA) ||
	       (tf->protocol == ATA_PROT_ATAPI_DMA);
}

static inline int is_multi_taskfile(struct ata_taskfile *tf)
{
	return (tf->command == ATA_CMD_READ_MULTI) ||
	       (tf->command == ATA_CMD_WRITE_MULTI) ||
	       (tf->command == ATA_CMD_READ_MULTI_EXT) ||
	       (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
	       (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
}

static inline int ata_ok(u8 status)
{
	return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
			== ATA_DRDY);
}

static inline int lba_28_ok(u64 block, u32 n_block)
{
	/* check the ending block number */
	return ((block + n_block - 1) < ((u64)1 << 28)) && (n_block <= 256);
}

static inline int lba_48_ok(u64 block, u32 n_block)
{
	/* check the ending block number */
	return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536);
}

#endif /* __LINUX_ATA_H__ */
Commit	Line	Data
1da177e4 LT	1
1da177e4 LT	2	/*
af36d7f0 JG	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	*
1da177e4 LT	27	*/
	28
	29	#ifndef __LINUX_ATA_H__
	30	#define __LINUX_ATA_H__
	31
	32	#include <linux/types.h>
	33
	34	/* defines only for the constants which don't work well as enums */
	35	#define ATA_DMA_BOUNDARY 0xffffUL
	36	#define ATA_DMA_MASK 0xffffffffULL
	37
	38	enum {
	39	/* various global constants */
	40	ATA_MAX_DEVICES = 2, /* per bus/port */
	41	ATA_MAX_PRD = 256, /* we could make these 256/256 */
	42	ATA_SECT_SIZE = 512,
	43
	44	ATA_ID_WORDS = 256,
1da177e4	45	ATA_ID_SERNO_OFS = 10,
11e29e21 AC	46	ATA_ID_FW_REV_OFS = 23,
	47	ATA_ID_PROD_OFS = 27,
	48	ATA_ID_OLD_PIO_MODES = 51,
	49	ATA_ID_FIELD_VALID = 53,
1da177e4	50	ATA_ID_MWDMA_MODES = 63,
11e29e21 AC	51	ATA_ID_PIO_MODES = 64,
	52	ATA_ID_EIDE_DMA_MIN = 65,
	53	ATA_ID_EIDE_PIO = 67,
	54	ATA_ID_EIDE_PIO_IORDY = 68,
1da177e4	55	ATA_ID_UDMA_MODES = 88,
11e29e21	56	ATA_ID_MAJOR_VER = 80,
1da177e4 LT	57	ATA_ID_PIO4 = (1 << 1),
	58
	59	ATA_PCI_CTL_OFS = 2,
	60	ATA_SERNO_LEN = 20,
	61	ATA_UDMA0 = (1 << 0),
	62	ATA_UDMA1 = ATA_UDMA0 \| (1 << 1),
	63	ATA_UDMA2 = ATA_UDMA1 \| (1 << 2),
	64	ATA_UDMA3 = ATA_UDMA2 \| (1 << 3),
	65	ATA_UDMA4 = ATA_UDMA3 \| (1 << 4),
	66	ATA_UDMA5 = ATA_UDMA4 \| (1 << 5),
	67	ATA_UDMA6 = ATA_UDMA5 \| (1 << 6),
	68	ATA_UDMA7 = ATA_UDMA6 \| (1 << 7),
	69	/* ATA_UDMA7 is just for completeness... doesn't exist (yet?). */
	70
	71	ATA_UDMA_MASK_40C = ATA_UDMA2, /* udma0-2 */
	72
	73	/* DMA-related */
	74	ATA_PRD_SZ = 8,
	75	ATA_PRD_TBL_SZ = (ATA_MAX_PRD * ATA_PRD_SZ),
	76	ATA_PRD_EOT = (1 << 31), /* end-of-table flag */
	77
	78	ATA_DMA_TABLE_OFS = 4,
	79	ATA_DMA_STATUS = 2,
	80	ATA_DMA_CMD = 0,
	81	ATA_DMA_WR = (1 << 3),
	82	ATA_DMA_START = (1 << 0),
	83	ATA_DMA_INTR = (1 << 2),
	84	ATA_DMA_ERR = (1 << 1),
	85	ATA_DMA_ACTIVE = (1 << 0),
	86
	87	/* bits in ATA command block registers */
	88	ATA_HOB = (1 << 7), /* LBA48 selector */
	89	ATA_NIEN = (1 << 1), /* disable-irq flag */
	90	ATA_LBA = (1 << 6), /* LBA28 selector */
	91	ATA_DEV1 = (1 << 4), /* Select Device 1 (slave) */
	92	ATA_DEVICE_OBS = (1 << 7) \| (1 << 5), /* obs bits in dev reg */
	93	ATA_DEVCTL_OBS = (1 << 3), /* obsolete bit in devctl reg */
	94	ATA_BUSY = (1 << 7), /* BSY status bit */
	95	ATA_DRDY = (1 << 6), /* device ready */
	96	ATA_DF = (1 << 5), /* device fault */
	97	ATA_DRQ = (1 << 3), /* data request i/o */
	98	ATA_ERR = (1 << 0), /* have an error */
	99	ATA_SRST = (1 << 2), /* software reset */
9be1e979 TH	100	ATA_ICRC = (1 << 7), /* interface CRC error */
	101	ATA_UNC = (1 << 6), /* uncorrectable media error */
	102	ATA_IDNF = (1 << 4), /* ID not found */
1da177e4 LT	103	ATA_ABORTED = (1 << 2), /* command aborted */
	104
	105	/* ATA command block registers */
	106	ATA_REG_DATA = 0x00,
	107	ATA_REG_ERR = 0x01,
	108	ATA_REG_NSECT = 0x02,
	109	ATA_REG_LBAL = 0x03,
	110	ATA_REG_LBAM = 0x04,
	111	ATA_REG_LBAH = 0x05,
	112	ATA_REG_DEVICE = 0x06,
	113	ATA_REG_STATUS = 0x07,
	114
	115	ATA_REG_FEATURE = ATA_REG_ERR, /* and their aliases */
	116	ATA_REG_CMD = ATA_REG_STATUS,
	117	ATA_REG_BYTEL = ATA_REG_LBAM,
	118	ATA_REG_BYTEH = ATA_REG_LBAH,
	119	ATA_REG_DEVSEL = ATA_REG_DEVICE,
	120	ATA_REG_IRQ = ATA_REG_NSECT,
	121
	122	/* ATA device commands */
	123	ATA_CMD_CHK_POWER = 0xE5, /* check power mode */
972dcafb DG	124	ATA_CMD_STANDBY = 0xE2, /* place in standby power mode */
972dcafb DG	125	ATA_CMD_IDLE = 0xE3, /* place in idle power mode */
1da177e4 LT	126	ATA_CMD_EDD = 0x90, /* execute device diagnostic */
	127	ATA_CMD_FLUSH = 0xE7,
	128	ATA_CMD_FLUSH_EXT = 0xEA,
	129	ATA_CMD_ID_ATA = 0xEC,
	130	ATA_CMD_ID_ATAPI = 0xA1,
	131	ATA_CMD_READ = 0xC8,
	132	ATA_CMD_READ_EXT = 0x25,
	133	ATA_CMD_WRITE = 0xCA,
	134	ATA_CMD_WRITE_EXT = 0x35,
9a3dccc4	135	ATA_CMD_WRITE_FUA_EXT = 0x3D,
1da177e4 LT	136	ATA_CMD_PIO_READ = 0x20,
	137	ATA_CMD_PIO_READ_EXT = 0x24,
	138	ATA_CMD_PIO_WRITE = 0x30,
	139	ATA_CMD_PIO_WRITE_EXT = 0x34,
8cbd6df1 AL	140	ATA_CMD_READ_MULTI = 0xC4,
	141	ATA_CMD_READ_MULTI_EXT = 0x29,
	142	ATA_CMD_WRITE_MULTI = 0xC5,
	143	ATA_CMD_WRITE_MULTI_EXT = 0x39,
9a3dccc4	144	ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
1da177e4 LT	145	ATA_CMD_SET_FEATURES = 0xEF,
	146	ATA_CMD_PACKET = 0xA0,
	147	ATA_CMD_VERIFY = 0x40,
	148	ATA_CMD_VERIFY_EXT = 0x42,
9b847548 JA	149	ATA_CMD_STANDBYNOW1 = 0xE0,
9b847548 JA	150	ATA_CMD_IDLEIMMEDIATE = 0xE1,
8bf62ece	151	ATA_CMD_INIT_DEV_PARAMS = 0x91,
b6782728 AC	152	ATA_CMD_READ_NATIVE_MAX = 0xF8,
b6782728 AC	153	ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
1da177e4 LT	154
	155	/* SETFEATURES stuff */
	156	SETFEATURES_XFER = 0x03,
	157	XFER_UDMA_7 = 0x47,
	158	XFER_UDMA_6 = 0x46,
	159	XFER_UDMA_5 = 0x45,
	160	XFER_UDMA_4 = 0x44,
	161	XFER_UDMA_3 = 0x43,
	162	XFER_UDMA_2 = 0x42,
	163	XFER_UDMA_1 = 0x41,
	164	XFER_UDMA_0 = 0x40,
	165	XFER_MW_DMA_2 = 0x22,
	166	XFER_MW_DMA_1 = 0x21,
	167	XFER_MW_DMA_0 = 0x20,
b4b52db7 AC	168	XFER_SW_DMA_2 = 0x12,
	169	XFER_SW_DMA_1 = 0x11,
	170	XFER_SW_DMA_0 = 0x10,
1da177e4 LT	171	XFER_PIO_4 = 0x0C,
	172	XFER_PIO_3 = 0x0B,
	173	XFER_PIO_2 = 0x0A,
	174	XFER_PIO_1 = 0x09,
	175	XFER_PIO_0 = 0x08,
1da177e4 LT	176	XFER_PIO_SLOW = 0x00,
	177
	178	/* ATAPI stuff */
	179	ATAPI_PKT_DMA = (1 << 0),
	180	ATAPI_DMADIR = (1 << 2), /* ATAPI data dir:
	181	0=to device, 1=to host */
	182	ATAPI_CDB_LEN = 16,
	183
	184	/* cable types */
	185	ATA_CBL_NONE = 0,
	186	ATA_CBL_PATA40 = 1,
	187	ATA_CBL_PATA80 = 2,
	188	ATA_CBL_PATA_UNK = 3,
	189	ATA_CBL_SATA = 4,
	190
	191	/* SATA Status and Control Registers */
	192	SCR_STATUS = 0,
	193	SCR_ERROR = 1,
	194	SCR_CONTROL = 2,
	195	SCR_ACTIVE = 3,
	196	SCR_NOTIFICATION = 4,
	197
9be1e979 TH	198	/* SError bits */
	199	SERR_DATA_RECOVERED = (1 << 0), /* recovered data error */
	200	SERR_COMM_RECOVERED = (1 << 1), /* recovered comm failure */
	201	SERR_DATA = (1 << 8), /* unrecovered data error */
	202	SERR_PERSISTENT = (1 << 9), /* persistent data/comm error */
	203	SERR_PROTOCOL = (1 << 10), /* protocol violation */
	204	SERR_INTERNAL = (1 << 11), /* host internal error */
	205	SERR_PHYRDY_CHG = (1 << 16), /* PHY RDY changed */
	206	SERR_DEV_XCHG = (1 << 26), /* device exchanged */
	207
1da177e4 LT	208	/* struct ata_taskfile flags */
	209	ATA_TFLAG_LBA48 = (1 << 0), /* enable 48-bit LBA and "HOB" */
	210	ATA_TFLAG_ISADDR = (1 << 1), /* enable r/w to nsect/lba regs */
	211	ATA_TFLAG_DEVICE = (1 << 2), /* enable r/w to device reg */
	212	ATA_TFLAG_WRITE = (1 << 3), /* data dir: host->dev==1 (write) */
8bf62ece	213	ATA_TFLAG_LBA = (1 << 4), /* enable LBA */
9a3dccc4	214	ATA_TFLAG_FUA = (1 << 5), /* enable FUA */
ea9b395f	215	ATA_TFLAG_POLLING = (1 << 6), /* set nIEN to 1 and use polling */
1da177e4 LT	216	};
	217
	218	enum ata_tf_protocols {
	219	/* ATA taskfile protocols */
	220	ATA_PROT_UNKNOWN, /* unknown/invalid */
	221	ATA_PROT_NODATA, /* no data */
	222	ATA_PROT_PIO, /* PIO single sector */
1da177e4 LT	223	ATA_PROT_DMA, /* DMA */
	224	ATA_PROT_ATAPI, /* packet command, PIO data xfer*/
	225	ATA_PROT_ATAPI_NODATA, /* packet command, no data */
	226	ATA_PROT_ATAPI_DMA, /* packet command with special DMA sauce */
	227	};
	228
	229	enum ata_ioctls {
	230	ATA_IOC_GET_IO32 = 0x309,
	231	ATA_IOC_SET_IO32 = 0x324,
	232	};
	233
	234	/* core structures */
	235
	236	struct ata_prd {
	237	u32 addr;
	238	u32 flags_len;
	239	};
	240
	241	struct ata_taskfile {
	242	unsigned long flags; /* ATA_TFLAG_xxx */
	243	u8 protocol; /* ATA_PROT_xxx */
	244
	245	u8 ctl; /* control reg */
	246
	247	u8 hob_feature; /* additional data */
	248	u8 hob_nsect; /* to support LBA48 */
	249	u8 hob_lbal;
	250	u8 hob_lbam;
	251	u8 hob_lbah;
	252
	253	u8 feature;
	254	u8 nsect;
	255	u8 lbal;
	256	u8 lbam;
	257	u8 lbah;
	258
	259	u8 device;
	260
	261	u8 command; /* IO operation */
	262	};
	263
	264	#define ata_id_is_ata(id) (((id)[0] & (1 << 15)) == 0)
b6782728	265	#define ata_id_is_cfa(id) ((id)[0] == 0x848A)
6f2f3812	266	#define ata_id_is_sata(id) ((id)[93] == 0)
1da177e4 LT	267	#define ata_id_rahead_enabled(id) ((id)[85] & (1 << 6))
1da177e4 LT	268	#define ata_id_wcache_enabled(id) ((id)[85] & (1 << 5))
b6782728	269	#define ata_id_hpa_enabled(id) ((id)[85] & (1 << 10))
9a3dccc4 TH	270	#define ata_id_has_fua(id) ((id)[84] & (1 << 6))
9a3dccc4 TH	271	#define ata_id_has_flush(id) ((id)[83] & (1 << 12))
1da177e4 LT	272	#define ata_id_has_flush_ext(id) ((id)[83] & (1 << 13))
1da177e4 LT	273	#define ata_id_has_lba48(id) ((id)[83] & (1 << 10))
b6782728	274	#define ata_id_has_hpa(id) ((id)[82] & (1 << 10))
1da177e4 LT	275	#define ata_id_has_wcache(id) ((id)[82] & (1 << 5))
	276	#define ata_id_has_pm(id) ((id)[82] & (1 << 3))
	277	#define ata_id_has_lba(id) ((id)[49] & (1 << 9))
	278	#define ata_id_has_dma(id) ((id)[49] & (1 << 8))
	279	#define ata_id_removeable(id) ((id)[0] & (1 << 7))
b6782728	280	#define ata_id_has_dword_io(id) ((id)[50] & (1 << 0))
1da177e4 LT	281	#define ata_id_u32(id,n) \
	282	(((u32) (id)[(n) + 1] << 16) \| ((u32) (id)[(n)]))
	283	#define ata_id_u64(id,n) \
	284	( ((u64) (id)[(n) + 3] << 48) \| \
	285	((u64) (id)[(n) + 2] << 32) \| \
	286	((u64) (id)[(n) + 1] << 16) \| \
	287	((u64) (id)[(n) + 0]) )
	288
312f7da2 AL	289	#define ata_id_cdb_intr(id) (((id)[0] & 0x60) == 0x20)
312f7da2 AL	290
3d2ca910 TH	291	static inline unsigned int ata_id_major_version(const u16 *id)
	292	{
	293	unsigned int mver;
	294
	295	for (mver = 14; mver >= 1; mver--)
	296	if (id[ATA_ID_MAJOR_VER] & (1 << mver))
	297	break;
	298	return mver;
	299	}
	300
057ace5e	301	static inline int ata_id_current_chs_valid(const u16 *id)
8bf62ece AL	302	{
	303	/* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
	304	has not been issued to the device then the values of
	305	id[54] to id[56] are vendor specific. */
	306	return (id[53] & 0x01) && /* Current translation valid */
	307	id[54] && /* cylinders in current translation */
	308	id[55] && /* heads in current translation */
	309	id[55] <= 16 &&
	310	id[56]; /* sectors in current translation */
	311	}
	312
057ace5e	313	static inline int atapi_cdb_len(const u16 *dev_id)
1da177e4 LT	314	{
	315	u16 tmp = dev_id[0] & 0x3;
	316	switch (tmp) {
	317	case 0: return 12;
	318	case 1: return 16;
	319	default: return -1;
	320	}
	321	}
	322
057ace5e	323	static inline int is_atapi_taskfile(const struct ata_taskfile *tf)
1da177e4 LT	324	{
	325	return (tf->protocol == ATA_PROT_ATAPI) \|\|
	326	(tf->protocol == ATA_PROT_ATAPI_NODATA) \|\|
	327	(tf->protocol == ATA_PROT_ATAPI_DMA);
	328	}
	329
07f6f7d0 AL	330	static inline int is_multi_taskfile(struct ata_taskfile *tf)
	331	{
	332	return (tf->command == ATA_CMD_READ_MULTI) \|\|
	333	(tf->command == ATA_CMD_WRITE_MULTI) \|\|
	334	(tf->command == ATA_CMD_READ_MULTI_EXT) \|\|
c2956a3b AL	335	(tf->command == ATA_CMD_WRITE_MULTI_EXT) \|\|
c2956a3b AL	336	(tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
07f6f7d0 AL	337	}
07f6f7d0 AL	338
1da177e4 LT	339	static inline int ata_ok(u8 status)
	340	{
	341	return ((status & (ATA_BUSY \| ATA_DRDY \| ATA_DF \| ATA_DRQ \| ATA_ERR))
	342	== ATA_DRDY);
	343	}
	344
c6a33e24 AL	345	static inline int lba_28_ok(u64 block, u32 n_block)
	346	{
	347	/* check the ending block number */
	348	return ((block + n_block - 1) < ((u64)1 << 28)) && (n_block <= 256);
	349	}
	350
	351	static inline int lba_48_ok(u64 block, u32 n_block)
	352	{
	353	/* check the ending block number */
	354	return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536);
	355	}
	356
1da177e4	357	#endif /* __LINUX_ATA_H__ */