057ace5e79
Enforce access rules where appropriate. If the compiler is smart enough, this may buy us an optimization or two as a side effect.
299 lines
8.3 KiB
C
299 lines
8.3 KiB
C
|
|
/*
|
|
* 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_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_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_SET_FEATURES = 0xEF,
|
|
ATA_CMD_PACKET = 0xA0,
|
|
ATA_CMD_VERIFY = 0x40,
|
|
ATA_CMD_VERIFY_EXT = 0x42,
|
|
ATA_CMD_INIT_DEV_PARAMS = 0x91,
|
|
|
|
/* 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,
|
|
|
|
/* 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 */
|
|
};
|
|
|
|
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_PIO_MULT, /* PIO multiple 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_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_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_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_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]) )
|
|
|
|
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 ata_ok(u8 status)
|
|
{
|
|
return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
|
|
== ATA_DRDY);
|
|
}
|
|
|
|
#endif /* __LINUX_ATA_H__ */
|