[linux-2.6-block.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_MAX_SECTORS_128	= 128,
	ATA_MAX_SECTORS		= 256,
	ATA_MAX_SECTORS_LBA48	= 65535,/* TODO: 65536? */

	ATA_ID_WORDS		= 256,
	ATA_ID_SERNO		= 10,
	ATA_ID_FW_REV		= 23,
	ATA_ID_PROD		= 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_ID_SERNO_LEN	= 20,
	ATA_ID_FW_REV_LEN	= 8,
	ATA_ID_PROD_LEN		= 40,

	ATA_PCI_CTL_OFS		= 2,

	ATA_PIO0		= (1 << 0),
	ATA_PIO1		= ATA_PIO0 | (1 << 1),
	ATA_PIO2		= ATA_PIO1 | (1 << 2),
	ATA_PIO3		= ATA_PIO2 | (1 << 3),
	ATA_PIO4		= ATA_PIO3 | (1 << 4),
	ATA_PIO5		= ATA_PIO4 | (1 << 5),
	ATA_PIO6		= ATA_PIO5 | (1 << 6),

	ATA_SWDMA0		= (1 << 0),
	ATA_SWDMA1		= ATA_SWDMA0 | (1 << 1),
	ATA_SWDMA2		= ATA_SWDMA1 | (1 << 2),

	ATA_SWDMA2_ONLY		= (1 << 2),

	ATA_MWDMA0		= (1 << 0),
	ATA_MWDMA1		= ATA_MWDMA0 | (1 << 1),
	ATA_MWDMA2		= ATA_MWDMA1 | (1 << 2),

	ATA_MWDMA12_ONLY	= (1 << 1) | (1 << 2),
	ATA_MWDMA2_ONLY		= (1 << 2),

	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_DEV_RESET	= 0x08, /* ATAPI device reset */
	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_FPDMA_READ	= 0x60,
	ATA_CMD_FPDMA_WRITE	= 0x61,
	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_SET_MULTI	= 0xC6,
	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,
	ATA_CMD_SET_MAX		= 0xF9,
	ATA_CMD_SET_MAX_EXT	= 0x37,
	ATA_CMD_READ_LOG_EXT	= 0x2f,
	ATA_CMD_PMP_READ	= 0xE4,
	ATA_CMD_PMP_WRITE	= 0xE8,

	/* READ_LOG_EXT pages */
	ATA_LOG_SATA_NCQ	= 0x10,

	/* READ/WRITE LONG (obsolete) */
	ATA_CMD_READ_LONG	= 0x22,
	ATA_CMD_READ_LONG_ONCE	= 0x23,
	ATA_CMD_WRITE_LONG	= 0x32,
	ATA_CMD_WRITE_LONG_ONCE	= 0x33,

	/* 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_4		= 0x24,	/* CFA only */
	XFER_MW_DMA_3		= 0x23,	/* CFA only */
	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_6		= 0x0E,	/* CFA only */
	XFER_PIO_5		= 0x0D,	/* CFA only */
	XFER_PIO_4		= 0x0C,
	XFER_PIO_3		= 0x0B,
	XFER_PIO_2		= 0x0A,
	XFER_PIO_1		= 0x09,
	XFER_PIO_0		= 0x08,
	XFER_PIO_SLOW		= 0x00,

	SETFEATURES_WC_ON	= 0x02, /* Enable write cache */
	SETFEATURES_WC_OFF	= 0x82, /* Disable write cache */

	SETFEATURES_SPINUP	= 0x07, /* Spin-up drive */

	SETFEATURES_SATA_ENABLE = 0x10, /* Enable use of SATA feature */
	SETFEATURES_SATA_DISABLE = 0x90, /* Disable use of SATA feature */

	/* SETFEATURE Sector counts for SATA features */
	SATA_AN			= 0x05,  /* Asynchronous Notification */

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

	/* PMP stuff */
	SATA_PMP_MAX_PORTS	= 15,
	SATA_PMP_CTRL_PORT	= 15,

	SATA_PMP_GSCR_DWORDS	= 128,
	SATA_PMP_GSCR_PROD_ID	= 0,
	SATA_PMP_GSCR_REV	= 1,
	SATA_PMP_GSCR_PORT_INFO	= 2,
	SATA_PMP_GSCR_ERROR	= 32,
	SATA_PMP_GSCR_ERROR_EN	= 33,
	SATA_PMP_GSCR_FEAT	= 64,
	SATA_PMP_GSCR_FEAT_EN	= 96,

	SATA_PMP_PSCR_STATUS	= 0,
	SATA_PMP_PSCR_ERROR	= 1,
	SATA_PMP_PSCR_CONTROL	= 2,

	SATA_PMP_FEAT_BIST	= (1 << 0),
	SATA_PMP_FEAT_PMREQ	= (1 << 1),
	SATA_PMP_FEAT_DYNSSC	= (1 << 2),
	SATA_PMP_FEAT_NOTIFY	= (1 << 3),

	/* cable types */
	ATA_CBL_NONE		= 0,
	ATA_CBL_PATA40		= 1,
	ATA_CBL_PATA80		= 2,
	ATA_CBL_PATA40_SHORT	= 3,		/* 40 wire cable to high UDMA spec */
	ATA_CBL_PATA_UNK	= 4,
	ATA_CBL_SATA		= 5,

	/* 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_PHY_INT_ERR	= (1 << 17), /* PHY internal error */
	SERR_COMM_WAKE		= (1 << 18), /* Comm wake */
	SERR_10B_8B_ERR		= (1 << 19), /* 10b to 8b decode error */
	SERR_DISPARITY		= (1 << 20), /* Disparity */
	SERR_CRC		= (1 << 21), /* CRC error */
	SERR_HANDSHAKE		= (1 << 22), /* Handshake error */
	SERR_LINK_SEQ_ERR	= (1 << 23), /* Link sequence error */
	SERR_TRANS_ST_ERROR	= (1 << 24), /* Transport state trans. error */
	SERR_UNRECOG_FIS	= (1 << 25), /* Unrecognized FIS */
	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 data xfer */
	ATA_PROT_DMA,		/* DMA */
	ATA_PROT_NCQ,		/* NCQ */
	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_has_lba(id)	((id)[49] & (1 << 9))
#define ata_id_has_dma(id)	((id)[49] & (1 << 8))
#define ata_id_has_ncq(id)	((id)[76] & (1 << 8))
#define ata_id_queue_depth(id)	(((id)[75] & 0x1f) + 1)
#define ata_id_removeable(id)	((id)[0] & (1 << 7))
#define ata_id_has_dword_io(id)	((id)[48] & (1 << 0))
#define ata_id_has_atapi_AN(id)	\
	( (((id)[76] != 0x0000) && ((id)[76] != 0xffff)) && \
	  ((id)[78] & (1 << 5)) )
#define ata_id_iordy_disable(id) ((id)[49] & (1 << 10))
#define ata_id_has_iordy(id) ((id)[49] & (1 << 11))
#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 int ata_id_has_fua(const u16 *id)
{
	if ((id[84] & 0xC000) != 0x4000)
		return 0;
	return id[84] & (1 << 6);
}

static inline int ata_id_has_flush(const u16 *id)
{
	if ((id[83] & 0xC000) != 0x4000)
		return 0;
	return id[83] & (1 << 12);
}

static inline int ata_id_has_flush_ext(const u16 *id)
{
	if ((id[83] & 0xC000) != 0x4000)
		return 0;
	return id[83] & (1 << 13);
}

static inline int ata_id_has_lba48(const u16 *id)
{
	if ((id[83] & 0xC000) != 0x4000)
		return 0;
	return id[83] & (1 << 10);
}

static inline int ata_id_hpa_enabled(const u16 *id)
{
	/* Yes children, word 83 valid bits cover word 82 data */
	if ((id[83] & 0xC000) != 0x4000)
		return 0;
	/* And 87 covers 85-87 */
	if ((id[87] & 0xC000) != 0x4000)
		return 0;
	/* Check command sets enabled as well as supported */
	if ((id[85] & ( 1 << 10)) == 0)
		return 0;
	return id[82] & (1 << 10);
}

static inline int ata_id_has_wcache(const u16 *id)
{
	/* Yes children, word 83 valid bits cover word 82 data */
	if ((id[83] & 0xC000) != 0x4000)
		return 0;
	return id[82] & (1 << 5);
}

static inline int ata_id_has_pm(const u16 *id)
{
	if ((id[83] & 0xC000) != 0x4000)
		return 0;
	return id[82] & (1 << 3);
}

static inline int ata_id_rahead_enabled(const u16 *id)
{
	if ((id[87] & 0xC000) != 0x4000)
		return 0;
	return id[85] & (1 << 6);
}

static inline int ata_id_wcache_enabled(const u16 *id)
{
	if ((id[87] & 0xC000) != 0x4000)
		return 0;
	return id[85] & (1 << 5);
}

/**
 *	ata_id_major_version	-	get ATA level of drive
 *	@id: Identify data
 *
 *	Caveats:
 *		ATA-1 considers identify optional
 *		ATA-2 introduces mandatory identify
 *		ATA-3 introduces word 80 and accurate reporting
 *
 *	The practical impact of this is that ata_id_major_version cannot
 *	reliably report on drives below ATA3.
 */

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

	if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
		return 0;

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

static inline int ata_id_is_sata(const u16 *id)
{
	return ata_id_major_version(id) >= 5 && id[93] == 0;
}

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 ata_id_is_cfa(const u16 *id)
{
	u16 v = id[0];
	if (v == 0x848A)	/* Standard CF */
		return 1;
	/* Could be CF hiding as standard ATA */
	if (ata_id_major_version(id) >= 3 &&  id[82] != 0xFFFF &&
			(id[82] & ( 1 << 2)))
		return 1;
	return 0;
}

static inline int ata_drive_40wire(const u16 *dev_id)
{
	if (ata_id_is_sata(dev_id))
		return 0;	/* SATA */
	if ((dev_id[93] & 0xE000) == 0x6000)
		return 0;	/* 80 wire */
	return 1;
}

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);
}

#define sata_pmp_gscr_vendor(gscr)	((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
#define sata_pmp_gscr_devid(gscr)	((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
#define sata_pmp_gscr_rev(gscr)		(((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
#define sata_pmp_gscr_ports(gscr)	((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)

#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,
18d6e9d5	43	ATA_MAX_SECTORS_128 = 128,
8b881b04 JG	44	ATA_MAX_SECTORS = 256,
8b881b04 JG	45	ATA_MAX_SECTORS_LBA48 = 65535,/* TODO: 65536? */
1da177e4 LT	46
1da177e4 LT	47	ATA_ID_WORDS = 256,
a0cf733b TH	48	ATA_ID_SERNO = 10,
	49	ATA_ID_FW_REV = 23,
	50	ATA_ID_PROD = 27,
11e29e21 AC	51	ATA_ID_OLD_PIO_MODES = 51,
11e29e21 AC	52	ATA_ID_FIELD_VALID = 53,
1da177e4	53	ATA_ID_MWDMA_MODES = 63,
11e29e21 AC	54	ATA_ID_PIO_MODES = 64,
	55	ATA_ID_EIDE_DMA_MIN = 65,
	56	ATA_ID_EIDE_PIO = 67,
	57	ATA_ID_EIDE_PIO_IORDY = 68,
1da177e4	58	ATA_ID_UDMA_MODES = 88,
11e29e21	59	ATA_ID_MAJOR_VER = 80,
1da177e4 LT	60	ATA_ID_PIO4 = (1 << 1),
1da177e4 LT	61
a0cf733b TH	62	ATA_ID_SERNO_LEN = 20,
	63	ATA_ID_FW_REV_LEN = 8,
	64	ATA_ID_PROD_LEN = 40,
	65
1da177e4	66	ATA_PCI_CTL_OFS = 2,
4099d143 BZ	67
	68	ATA_PIO0 = (1 << 0),
	69	ATA_PIO1 = ATA_PIO0 \| (1 << 1),
	70	ATA_PIO2 = ATA_PIO1 \| (1 << 2),
	71	ATA_PIO3 = ATA_PIO2 \| (1 << 3),
	72	ATA_PIO4 = ATA_PIO3 \| (1 << 4),
	73	ATA_PIO5 = ATA_PIO4 \| (1 << 5),
	74	ATA_PIO6 = ATA_PIO5 \| (1 << 6),
	75
91a6d4ed BZ	76	ATA_SWDMA0 = (1 << 0),
	77	ATA_SWDMA1 = ATA_SWDMA0 \| (1 << 1),
	78	ATA_SWDMA2 = ATA_SWDMA1 \| (1 << 2),
	79
	80	ATA_SWDMA2_ONLY = (1 << 2),
	81
	82	ATA_MWDMA0 = (1 << 0),
	83	ATA_MWDMA1 = ATA_MWDMA0 \| (1 << 1),
	84	ATA_MWDMA2 = ATA_MWDMA1 \| (1 << 2),
	85
	86	ATA_MWDMA12_ONLY = (1 << 1) \| (1 << 2),
	87	ATA_MWDMA2_ONLY = (1 << 2),
	88
1da177e4 LT	89	ATA_UDMA0 = (1 << 0),
	90	ATA_UDMA1 = ATA_UDMA0 \| (1 << 1),
	91	ATA_UDMA2 = ATA_UDMA1 \| (1 << 2),
	92	ATA_UDMA3 = ATA_UDMA2 \| (1 << 3),
	93	ATA_UDMA4 = ATA_UDMA3 \| (1 << 4),
	94	ATA_UDMA5 = ATA_UDMA4 \| (1 << 5),
	95	ATA_UDMA6 = ATA_UDMA5 \| (1 << 6),
	96	ATA_UDMA7 = ATA_UDMA6 \| (1 << 7),
	97	/* ATA_UDMA7 is just for completeness... doesn't exist (yet?). */
	98
	99	ATA_UDMA_MASK_40C = ATA_UDMA2, /* udma0-2 */
	100
	101	/* DMA-related */
	102	ATA_PRD_SZ = 8,
	103	ATA_PRD_TBL_SZ = (ATA_MAX_PRD * ATA_PRD_SZ),
	104	ATA_PRD_EOT = (1 << 31), /* end-of-table flag */
	105
	106	ATA_DMA_TABLE_OFS = 4,
	107	ATA_DMA_STATUS = 2,
	108	ATA_DMA_CMD = 0,
	109	ATA_DMA_WR = (1 << 3),
	110	ATA_DMA_START = (1 << 0),
	111	ATA_DMA_INTR = (1 << 2),
	112	ATA_DMA_ERR = (1 << 1),
	113	ATA_DMA_ACTIVE = (1 << 0),
	114
	115	/* bits in ATA command block registers */
	116	ATA_HOB = (1 << 7), /* LBA48 selector */
	117	ATA_NIEN = (1 << 1), /* disable-irq flag */
	118	ATA_LBA = (1 << 6), /* LBA28 selector */
	119	ATA_DEV1 = (1 << 4), /* Select Device 1 (slave) */
	120	ATA_DEVICE_OBS = (1 << 7) \| (1 << 5), /* obs bits in dev reg */
	121	ATA_DEVCTL_OBS = (1 << 3), /* obsolete bit in devctl reg */
	122	ATA_BUSY = (1 << 7), /* BSY status bit */
	123	ATA_DRDY = (1 << 6), /* device ready */
	124	ATA_DF = (1 << 5), /* device fault */
	125	ATA_DRQ = (1 << 3), /* data request i/o */
	126	ATA_ERR = (1 << 0), /* have an error */
	127	ATA_SRST = (1 << 2), /* software reset */
9be1e979 TH	128	ATA_ICRC = (1 << 7), /* interface CRC error */
	129	ATA_UNC = (1 << 6), /* uncorrectable media error */
	130	ATA_IDNF = (1 << 4), /* ID not found */
1da177e4 LT	131	ATA_ABORTED = (1 << 2), /* command aborted */
	132
	133	/* ATA command block registers */
	134	ATA_REG_DATA = 0x00,
	135	ATA_REG_ERR = 0x01,
	136	ATA_REG_NSECT = 0x02,
	137	ATA_REG_LBAL = 0x03,
	138	ATA_REG_LBAM = 0x04,
	139	ATA_REG_LBAH = 0x05,
	140	ATA_REG_DEVICE = 0x06,
	141	ATA_REG_STATUS = 0x07,
	142
	143	ATA_REG_FEATURE = ATA_REG_ERR, /* and their aliases */
	144	ATA_REG_CMD = ATA_REG_STATUS,
	145	ATA_REG_BYTEL = ATA_REG_LBAM,
	146	ATA_REG_BYTEH = ATA_REG_LBAH,
	147	ATA_REG_DEVSEL = ATA_REG_DEVICE,
	148	ATA_REG_IRQ = ATA_REG_NSECT,
	149
	150	/* ATA device commands */
ab2181cf	151	ATA_CMD_DEV_RESET = 0x08, /* ATAPI device reset */
1da177e4	152	ATA_CMD_CHK_POWER = 0xE5, /* check power mode */
972dcafb DG	153	ATA_CMD_STANDBY = 0xE2, /* place in standby power mode */
972dcafb DG	154	ATA_CMD_IDLE = 0xE3, /* place in idle power mode */
1da177e4 LT	155	ATA_CMD_EDD = 0x90, /* execute device diagnostic */
	156	ATA_CMD_FLUSH = 0xE7,
	157	ATA_CMD_FLUSH_EXT = 0xEA,
	158	ATA_CMD_ID_ATA = 0xEC,
	159	ATA_CMD_ID_ATAPI = 0xA1,
	160	ATA_CMD_READ = 0xC8,
	161	ATA_CMD_READ_EXT = 0x25,
	162	ATA_CMD_WRITE = 0xCA,
	163	ATA_CMD_WRITE_EXT = 0x35,
9a3dccc4	164	ATA_CMD_WRITE_FUA_EXT = 0x3D,
88e49034 TH	165	ATA_CMD_FPDMA_READ = 0x60,
88e49034 TH	166	ATA_CMD_FPDMA_WRITE = 0x61,
1da177e4 LT	167	ATA_CMD_PIO_READ = 0x20,
	168	ATA_CMD_PIO_READ_EXT = 0x24,
	169	ATA_CMD_PIO_WRITE = 0x30,
	170	ATA_CMD_PIO_WRITE_EXT = 0x34,
8cbd6df1 AL	171	ATA_CMD_READ_MULTI = 0xC4,
	172	ATA_CMD_READ_MULTI_EXT = 0x29,
	173	ATA_CMD_WRITE_MULTI = 0xC5,
	174	ATA_CMD_WRITE_MULTI_EXT = 0x39,
9a3dccc4	175	ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
1da177e4	176	ATA_CMD_SET_FEATURES = 0xEF,
2c3d2a46	177	ATA_CMD_SET_MULTI = 0xC6,
1da177e4 LT	178	ATA_CMD_PACKET = 0xA0,
	179	ATA_CMD_VERIFY = 0x40,
	180	ATA_CMD_VERIFY_EXT = 0x42,
2dcb407e JG	181	ATA_CMD_STANDBYNOW1 = 0xE0,
2dcb407e JG	182	ATA_CMD_IDLEIMMEDIATE = 0xE1,
8bf62ece	183	ATA_CMD_INIT_DEV_PARAMS = 0x91,
b6782728 AC	184	ATA_CMD_READ_NATIVE_MAX = 0xF8,
b6782728 AC	185	ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
1e999736 AC	186	ATA_CMD_SET_MAX = 0xF9,
1e999736 AC	187	ATA_CMD_SET_MAX_EXT = 0x37,
88e49034	188	ATA_CMD_READ_LOG_EXT = 0x2f,
814600ee TH	189	ATA_CMD_PMP_READ = 0xE4,
814600ee TH	190	ATA_CMD_PMP_WRITE = 0xE8,
88e49034 TH	191
	192	/* READ_LOG_EXT pages */
	193	ATA_LOG_SATA_NCQ = 0x10,
1da177e4	194
5a5dbd18 ML	195	/* READ/WRITE LONG (obsolete) */
	196	ATA_CMD_READ_LONG = 0x22,
	197	ATA_CMD_READ_LONG_ONCE = 0x23,
	198	ATA_CMD_WRITE_LONG = 0x32,
	199	ATA_CMD_WRITE_LONG_ONCE = 0x33,
	200
1da177e4 LT	201	/* SETFEATURES stuff */
	202	SETFEATURES_XFER = 0x03,
	203	XFER_UDMA_7 = 0x47,
	204	XFER_UDMA_6 = 0x46,
	205	XFER_UDMA_5 = 0x45,
	206	XFER_UDMA_4 = 0x44,
	207	XFER_UDMA_3 = 0x43,
	208	XFER_UDMA_2 = 0x42,
	209	XFER_UDMA_1 = 0x41,
	210	XFER_UDMA_0 = 0x40,
b352e57d AC	211	XFER_MW_DMA_4 = 0x24, /* CFA only */
b352e57d AC	212	XFER_MW_DMA_3 = 0x23, /* CFA only */
1da177e4 LT	213	XFER_MW_DMA_2 = 0x22,
	214	XFER_MW_DMA_1 = 0x21,
	215	XFER_MW_DMA_0 = 0x20,
b4b52db7 AC	216	XFER_SW_DMA_2 = 0x12,
	217	XFER_SW_DMA_1 = 0x11,
	218	XFER_SW_DMA_0 = 0x10,
b352e57d AC	219	XFER_PIO_6 = 0x0E, /* CFA only */
b352e57d AC	220	XFER_PIO_5 = 0x0D, /* CFA only */
1da177e4 LT	221	XFER_PIO_4 = 0x0C,
	222	XFER_PIO_3 = 0x0B,
	223	XFER_PIO_2 = 0x0A,
	224	XFER_PIO_1 = 0x09,
	225	XFER_PIO_0 = 0x08,
1da177e4 LT	226	XFER_PIO_SLOW = 0x00,
1da177e4 LT	227
3057ac3c	228	SETFEATURES_WC_ON = 0x02, /* Enable write cache */
	229	SETFEATURES_WC_OFF = 0x82, /* Disable write cache */
	230
169439c2 ML	231	SETFEATURES_SPINUP = 0x07, /* Spin-up drive */
169439c2 ML	232
9f45cbd3 KCA	233	SETFEATURES_SATA_ENABLE = 0x10, /* Enable use of SATA feature */
	234	SETFEATURES_SATA_DISABLE = 0x90, /* Disable use of SATA feature */
	235
	236	/* SETFEATURE Sector counts for SATA features */
	237	SATA_AN = 0x05, /* Asynchronous Notification */
	238
1da177e4 LT	239	/* ATAPI stuff */
	240	ATAPI_PKT_DMA = (1 << 0),
	241	ATAPI_DMADIR = (1 << 2), /* ATAPI data dir:
	242	0=to device, 1=to host */
	243	ATAPI_CDB_LEN = 16,
	244
814600ee TH	245	/* PMP stuff */
	246	SATA_PMP_MAX_PORTS = 15,
	247	SATA_PMP_CTRL_PORT = 15,
	248
	249	SATA_PMP_GSCR_DWORDS = 128,
	250	SATA_PMP_GSCR_PROD_ID = 0,
	251	SATA_PMP_GSCR_REV = 1,
	252	SATA_PMP_GSCR_PORT_INFO = 2,
	253	SATA_PMP_GSCR_ERROR = 32,
	254	SATA_PMP_GSCR_ERROR_EN = 33,
	255	SATA_PMP_GSCR_FEAT = 64,
	256	SATA_PMP_GSCR_FEAT_EN = 96,
	257
	258	SATA_PMP_PSCR_STATUS = 0,
	259	SATA_PMP_PSCR_ERROR = 1,
	260	SATA_PMP_PSCR_CONTROL = 2,
	261
	262	SATA_PMP_FEAT_BIST = (1 << 0),
	263	SATA_PMP_FEAT_PMREQ = (1 << 1),
	264	SATA_PMP_FEAT_DYNSSC = (1 << 2),
	265	SATA_PMP_FEAT_NOTIFY = (1 << 3),
	266
1da177e4 LT	267	/* cable types */
	268	ATA_CBL_NONE = 0,
	269	ATA_CBL_PATA40 = 1,
	270	ATA_CBL_PATA80 = 2,
fc085150 AC	271	ATA_CBL_PATA40_SHORT = 3, /* 40 wire cable to high UDMA spec */
	272	ATA_CBL_PATA_UNK = 4,
	273	ATA_CBL_SATA = 5,
1da177e4 LT	274
	275	/* SATA Status and Control Registers */
	276	SCR_STATUS = 0,
	277	SCR_ERROR = 1,
	278	SCR_CONTROL = 2,
	279	SCR_ACTIVE = 3,
	280	SCR_NOTIFICATION = 4,
	281
9be1e979 TH	282	/* SError bits */
	283	SERR_DATA_RECOVERED = (1 << 0), /* recovered data error */
	284	SERR_COMM_RECOVERED = (1 << 1), /* recovered comm failure */
	285	SERR_DATA = (1 << 8), /* unrecovered data error */
	286	SERR_PERSISTENT = (1 << 9), /* persistent data/comm error */
	287	SERR_PROTOCOL = (1 << 10), /* protocol violation */
	288	SERR_INTERNAL = (1 << 11), /* host internal error */
	289	SERR_PHYRDY_CHG = (1 << 16), /* PHY RDY changed */
1333e194 RH	290	SERR_PHY_INT_ERR = (1 << 17), /* PHY internal error */
	291	SERR_COMM_WAKE = (1 << 18), /* Comm wake */
	292	SERR_10B_8B_ERR = (1 << 19), /* 10b to 8b decode error */
	293	SERR_DISPARITY = (1 << 20), /* Disparity */
	294	SERR_CRC = (1 << 21), /* CRC error */
	295	SERR_HANDSHAKE = (1 << 22), /* Handshake error */
	296	SERR_LINK_SEQ_ERR = (1 << 23), /* Link sequence error */
	297	SERR_TRANS_ST_ERROR = (1 << 24), /* Transport state trans. error */
	298	SERR_UNRECOG_FIS = (1 << 25), /* Unrecognized FIS */
9be1e979 TH	299	SERR_DEV_XCHG = (1 << 26), /* device exchanged */
9be1e979 TH	300
1da177e4 LT	301	/* struct ata_taskfile flags */
	302	ATA_TFLAG_LBA48 = (1 << 0), /* enable 48-bit LBA and "HOB" */
	303	ATA_TFLAG_ISADDR = (1 << 1), /* enable r/w to nsect/lba regs */
	304	ATA_TFLAG_DEVICE = (1 << 2), /* enable r/w to device reg */
	305	ATA_TFLAG_WRITE = (1 << 3), /* data dir: host->dev==1 (write) */
8bf62ece	306	ATA_TFLAG_LBA = (1 << 4), /* enable LBA */
9a3dccc4	307	ATA_TFLAG_FUA = (1 << 5), /* enable FUA */
ea9b395f	308	ATA_TFLAG_POLLING = (1 << 6), /* set nIEN to 1 and use polling */
1da177e4 LT	309	};
	310
	311	enum ata_tf_protocols {
	312	/* ATA taskfile protocols */
	313	ATA_PROT_UNKNOWN, /* unknown/invalid */
	314	ATA_PROT_NODATA, /* no data */
1dce589c	315	ATA_PROT_PIO, /* PIO data xfer */
1da177e4	316	ATA_PROT_DMA, /* DMA */
88e49034	317	ATA_PROT_NCQ, /* NCQ */
1da177e4 LT	318	ATA_PROT_ATAPI, /* packet command, PIO data xfer*/
	319	ATA_PROT_ATAPI_NODATA, /* packet command, no data */
	320	ATA_PROT_ATAPI_DMA, /* packet command with special DMA sauce */
	321	};
	322
	323	enum ata_ioctls {
	324	ATA_IOC_GET_IO32 = 0x309,
	325	ATA_IOC_SET_IO32 = 0x324,
	326	};
	327
	328	/* core structures */
	329
	330	struct ata_prd {
	331	u32 addr;
	332	u32 flags_len;
	333	};
	334
	335	struct ata_taskfile {
	336	unsigned long flags; /* ATA_TFLAG_xxx */
	337	u8 protocol; /* ATA_PROT_xxx */
	338
	339	u8 ctl; /* control reg */
	340
	341	u8 hob_feature; /* additional data */
	342	u8 hob_nsect; /* to support LBA48 */
	343	u8 hob_lbal;
	344	u8 hob_lbam;
	345	u8 hob_lbah;
	346
	347	u8 feature;
	348	u8 nsect;
	349	u8 lbal;
	350	u8 lbam;
	351	u8 lbah;
	352
	353	u8 device;
	354
	355	u8 command; /* IO operation */
	356	};
	357
	358	#define ata_id_is_ata(id) (((id)[0] & (1 << 15)) == 0)
1da177e4 LT	359	#define ata_id_has_lba(id) ((id)[49] & (1 << 9))
1da177e4 LT	360	#define ata_id_has_dma(id) ((id)[49] & (1 << 8))
88e49034 TH	361	#define ata_id_has_ncq(id) ((id)[76] & (1 << 8))
88e49034 TH	362	#define ata_id_queue_depth(id) (((id)[75] & 0x1f) + 1)
1da177e4	363	#define ata_id_removeable(id) ((id)[0] & (1 << 7))
c7293870	364	#define ata_id_has_dword_io(id) ((id)[48] & (1 << 0))
854c73a2	365	#define ata_id_has_atapi_AN(id) \
9f45cbd3 KCA	366	( (((id)[76] != 0x0000) && ((id)[76] != 0xffff)) && \
9f45cbd3 KCA	367	((id)[78] & (1 << 5)) )
49554c19	368	#define ata_id_iordy_disable(id) ((id)[49] & (1 << 10))
0bc2a79a	369	#define ata_id_has_iordy(id) ((id)[49] & (1 << 11))
1da177e4 LT	370	#define ata_id_u32(id,n) \
	371	(((u32) (id)[(n) + 1] << 16) \| ((u32) (id)[(n)]))
	372	#define ata_id_u64(id,n) \
	373	( ((u64) (id)[(n) + 3] << 48) \| \
	374	((u64) (id)[(n) + 2] << 32) \| \
	375	((u64) (id)[(n) + 1] << 16) \| \
	376	((u64) (id)[(n) + 0]) )
	377
312f7da2 AL	378	#define ata_id_cdb_intr(id) (((id)[0] & 0x60) == 0x20)
312f7da2 AL	379
c7293870 AC	380	static inline int ata_id_has_fua(const u16 *id)
	381	{
	382	if ((id[84] & 0xC000) != 0x4000)
	383	return 0;
	384	return id[84] & (1 << 6);
	385	}
	386
	387	static inline int ata_id_has_flush(const u16 *id)
	388	{
	389	if ((id[83] & 0xC000) != 0x4000)
	390	return 0;
	391	return id[83] & (1 << 12);
	392	}
	393
	394	static inline int ata_id_has_flush_ext(const u16 *id)
	395	{
	396	if ((id[83] & 0xC000) != 0x4000)
	397	return 0;
	398	return id[83] & (1 << 13);
	399	}
	400
	401	static inline int ata_id_has_lba48(const u16 *id)
	402	{
	403	if ((id[83] & 0xC000) != 0x4000)
	404	return 0;
	405	return id[83] & (1 << 10);
	406	}
	407
	408	static inline int ata_id_hpa_enabled(const u16 *id)
	409	{
	410	/* Yes children, word 83 valid bits cover word 82 data */
	411	if ((id[83] & 0xC000) != 0x4000)
	412	return 0;
	413	/* And 87 covers 85-87 */
	414	if ((id[87] & 0xC000) != 0x4000)
	415	return 0;
	416	/* Check command sets enabled as well as supported */
	417	if ((id[85] & ( 1 << 10)) == 0)
	418	return 0;
	419	return id[82] & (1 << 10);
	420	}
	421
	422	static inline int ata_id_has_wcache(const u16 *id)
	423	{
	424	/* Yes children, word 83 valid bits cover word 82 data */
	425	if ((id[83] & 0xC000) != 0x4000)
	426	return 0;
	427	return id[82] & (1 << 5);
	428	}
	429
	430	static inline int ata_id_has_pm(const u16 *id)
	431	{
	432	if ((id[83] & 0xC000) != 0x4000)
	433	return 0;
	434	return id[82] & (1 << 3);
	435	}
	436
	437	static inline int ata_id_rahead_enabled(const u16 *id)
	438	{
	439	if ((id[87] & 0xC000) != 0x4000)
	440	return 0;
	441	return id[85] & (1 << 6);
	442	}
	443
444	static inline int ata_id_wcache_enabled(const u16 *id)
445	{
446	if ((id[87] & 0xC000) != 0x4000)
447	return 0;
448	return id[85] & (1 << 5);
449	}
450
451	/**
452	* ata_id_major_version - get ATA level of drive
453	* @id: Identify data
454	*
455	* Caveats:
456	* ATA-1 considers identify optional
457	* ATA-2 introduces mandatory identify
458	* ATA-3 introduces word 80 and accurate reporting
459	*
460	* The practical impact of this is that ata_id_major_version cannot
2dcb407e	461	* reliably report on drives below ATA3.
c7293870 AC	462	*/
c7293870 AC	463
3d2ca910 TH	464	static inline unsigned int ata_id_major_version(const u16 *id)
	465	{
	466	unsigned int mver;
	467
b352e57d AC	468	if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
	469	return 0;
	470
3d2ca910 TH	471	for (mver = 14; mver >= 1; mver--)
	472	if (id[ATA_ID_MAJOR_VER] & (1 << mver))
	473	break;
	474	return mver;
	475	}
	476
32d90911 TH	477	static inline int ata_id_is_sata(const u16 *id)
	478	{
	479	return ata_id_major_version(id) >= 5 && id[93] == 0;
	480	}
	481
057ace5e	482	static inline int ata_id_current_chs_valid(const u16 *id)
8bf62ece	483	{
9bec2e38 JG	484	/* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
9bec2e38 JG	485	has not been issued to the device then the values of
8bf62ece AL	486	id[54] to id[56] are vendor specific. */
	487	return (id[53] & 0x01) && /* Current translation valid */
	488	id[54] && /* cylinders in current translation */
	489	id[55] && /* heads in current translation */
	490	id[55] <= 16 &&
	491	id[56]; /* sectors in current translation */
	492	}
	493
b352e57d AC	494	static inline int ata_id_is_cfa(const u16 *id)
	495	{
	496	u16 v = id[0];
	497	if (v == 0x848A) /* Standard CF */
	498	return 1;
	499	/* Could be CF hiding as standard ATA */
	500	if (ata_id_major_version(id) >= 3 && id[82] != 0xFFFF &&
	501	(id[82] & ( 1 << 2)))
	502	return 1;
	503	return 0;
	504	}
	505
fc085150 AC	506	static inline int ata_drive_40wire(const u16 *dev_id)
fc085150 AC	507	{
32d90911	508	if (ata_id_is_sata(dev_id))
fc085150	509	return 0; /* SATA */
61f216c7	510	if ((dev_id[93] & 0xE000) == 0x6000)
fc085150 AC	511	return 0; /* 80 wire */
	512	return 1;
	513	}
	514
057ace5e	515	static inline int atapi_cdb_len(const u16 *dev_id)
1da177e4 LT	516	{
	517	u16 tmp = dev_id[0] & 0x3;
	518	switch (tmp) {
	519	case 0: return 12;
	520	case 1: return 16;
	521	default: return -1;
	522	}
	523	}
	524
057ace5e	525	static inline int is_atapi_taskfile(const struct ata_taskfile *tf)
1da177e4 LT	526	{
	527	return (tf->protocol == ATA_PROT_ATAPI) \|\|
	528	(tf->protocol == ATA_PROT_ATAPI_NODATA) \|\|
	529	(tf->protocol == ATA_PROT_ATAPI_DMA);
	530	}
	531
07f6f7d0 AL	532	static inline int is_multi_taskfile(struct ata_taskfile *tf)
	533	{
	534	return (tf->command == ATA_CMD_READ_MULTI) \|\|
	535	(tf->command == ATA_CMD_WRITE_MULTI) \|\|
	536	(tf->command == ATA_CMD_READ_MULTI_EXT) \|\|
c2956a3b AL	537	(tf->command == ATA_CMD_WRITE_MULTI_EXT) \|\|
c2956a3b AL	538	(tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
07f6f7d0 AL	539	}
07f6f7d0 AL	540
1da177e4 LT	541	static inline int ata_ok(u8 status)
	542	{
	543	return ((status & (ATA_BUSY \| ATA_DRDY \| ATA_DF \| ATA_DRQ \| ATA_ERR))
	544	== ATA_DRDY);
	545	}
	546
c6a33e24 AL	547	static inline int lba_28_ok(u64 block, u32 n_block)
	548	{
	549	/* check the ending block number */
	550	return ((block + n_block - 1) < ((u64)1 << 28)) && (n_block <= 256);
	551	}
	552
	553	static inline int lba_48_ok(u64 block, u32 n_block)
	554	{
	555	/* check the ending block number */
	556	return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536);
	557	}
	558
814600ee TH	559	#define sata_pmp_gscr_vendor(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
	560	#define sata_pmp_gscr_devid(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
	561	#define sata_pmp_gscr_rev(gscr) (((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
	562	#define sata_pmp_gscr_ports(gscr) ((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)
	563
1da177e4	564	#endif /* __LINUX_ATA_H__ */