include/linux/ata.h

   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/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         ATA_MAX_SECTORS_128     = 128,
  44         ATA_MAX_SECTORS         = 256,
  45         ATA_MAX_SECTORS_LBA48   = 65535,/* TODO: 65536? */
  46         ATA_MAX_SECTORS_TAPE    = 65535,
  47
  48         ATA_ID_WORDS            = 256,
  49         ATA_ID_CONFIG           = 0,
  50         ATA_ID_CYLS             = 1,
  51         ATA_ID_HEADS            = 3,
  52         ATA_ID_SECTORS          = 6,
  53         ATA_ID_SERNO            = 10,
  54         ATA_ID_BUF_SIZE         = 21,
  55         ATA_ID_FW_REV           = 23,
  56         ATA_ID_PROD             = 27,
  57         ATA_ID_MAX_MULTSECT     = 47,
  58         ATA_ID_DWORD_IO         = 48,
  59         ATA_ID_CAPABILITY       = 49,
  60         ATA_ID_OLD_PIO_MODES    = 51,
  61         ATA_ID_OLD_DMA_MODES    = 52,
  62         ATA_ID_FIELD_VALID      = 53,
  63         ATA_ID_CUR_CYLS         = 54,
  64         ATA_ID_CUR_HEADS        = 55,
  65         ATA_ID_CUR_SECTORS      = 56,
  66         ATA_ID_MULTSECT         = 59,
  67         ATA_ID_LBA_CAPACITY     = 60,
  68         ATA_ID_SWDMA_MODES      = 62,
  69         ATA_ID_MWDMA_MODES      = 63,
  70         ATA_ID_PIO_MODES        = 64,
  71         ATA_ID_EIDE_DMA_MIN     = 65,
  72         ATA_ID_EIDE_DMA_TIME    = 66,
  73         ATA_ID_EIDE_PIO         = 67,
  74         ATA_ID_EIDE_PIO_IORDY   = 68,
  75         ATA_ID_QUEUE_DEPTH      = 75,
  76         ATA_ID_MAJOR_VER        = 80,
  77         ATA_ID_COMMAND_SET_1    = 82,
  78         ATA_ID_COMMAND_SET_2    = 83,
  79         ATA_ID_CFSSE            = 84,
  80         ATA_ID_CFS_ENABLE_1     = 85,
  81         ATA_ID_CFS_ENABLE_2     = 86,
  82         ATA_ID_CSF_DEFAULT      = 87,
  83         ATA_ID_UDMA_MODES       = 88,
  84         ATA_ID_HW_CONFIG        = 93,
  85         ATA_ID_SPG              = 98,
  86         ATA_ID_LBA_CAPACITY_2   = 100,
  87         ATA_ID_LAST_LUN         = 126,
  88         ATA_ID_DLF              = 128,
  89         ATA_ID_CSFO             = 129,
  90         ATA_ID_CFA_POWER        = 160,
  91         ATA_ID_ROT_SPEED        = 217,
  92         ATA_ID_PIO4             = (1 << 1),
  93
  94         ATA_ID_SERNO_LEN        = 20,
  95         ATA_ID_FW_REV_LEN       = 8,
  96         ATA_ID_PROD_LEN         = 40,
  97
  98         ATA_PCI_CTL_OFS         = 2,
  99
 100         ATA_PIO0                = (1 << 0),
 101         ATA_PIO1                = ATA_PIO0 | (1 << 1),
 102         ATA_PIO2                = ATA_PIO1 | (1 << 2),
 103         ATA_PIO3                = ATA_PIO2 | (1 << 3),
 104         ATA_PIO4                = ATA_PIO3 | (1 << 4),
 105         ATA_PIO5                = ATA_PIO4 | (1 << 5),
 106         ATA_PIO6                = ATA_PIO5 | (1 << 6),
 107
 108         ATA_SWDMA0              = (1 << 0),
 109         ATA_SWDMA1              = ATA_SWDMA0 | (1 << 1),
 110         ATA_SWDMA2              = ATA_SWDMA1 | (1 << 2),
 111
 112         ATA_SWDMA2_ONLY         = (1 << 2),
 113
 114         ATA_MWDMA0              = (1 << 0),
 115         ATA_MWDMA1              = ATA_MWDMA0 | (1 << 1),
 116         ATA_MWDMA2              = ATA_MWDMA1 | (1 << 2),
 117
 118         ATA_MWDMA12_ONLY        = (1 << 1) | (1 << 2),
 119         ATA_MWDMA2_ONLY         = (1 << 2),
 120
 121         ATA_UDMA0               = (1 << 0),
 122         ATA_UDMA1               = ATA_UDMA0 | (1 << 1),
 123         ATA_UDMA2               = ATA_UDMA1 | (1 << 2),
 124         ATA_UDMA3               = ATA_UDMA2 | (1 << 3),
 125         ATA_UDMA4               = ATA_UDMA3 | (1 << 4),
 126         ATA_UDMA5               = ATA_UDMA4 | (1 << 5),
 127         ATA_UDMA6               = ATA_UDMA5 | (1 << 6),
 128         ATA_UDMA7               = ATA_UDMA6 | (1 << 7),
 129         /* ATA_UDMA7 is just for completeness... doesn't exist (yet?).  */
 130
 131         ATA_UDMA_MASK_40C       = ATA_UDMA2,    /* udma0-2 */
 132
 133         /* DMA-related */
 134         ATA_PRD_SZ              = 8,
 135         ATA_PRD_TBL_SZ          = (ATA_MAX_PRD * ATA_PRD_SZ),
 136         ATA_PRD_EOT             = (1 << 31),    /* end-of-table flag */
 137
 138         ATA_DMA_TABLE_OFS       = 4,
 139         ATA_DMA_STATUS          = 2,
 140         ATA_DMA_CMD             = 0,
 141         ATA_DMA_WR              = (1 << 3),
 142         ATA_DMA_START           = (1 << 0),
 143         ATA_DMA_INTR            = (1 << 2),
 144         ATA_DMA_ERR             = (1 << 1),
 145         ATA_DMA_ACTIVE          = (1 << 0),
 146
 147         /* bits in ATA command block registers */
 148         ATA_HOB                 = (1 << 7),     /* LBA48 selector */
 149         ATA_NIEN                = (1 << 1),     /* disable-irq flag */
 150         ATA_LBA                 = (1 << 6),     /* LBA28 selector */
 151         ATA_DEV1                = (1 << 4),     /* Select Device 1 (slave) */
 152         ATA_DEVICE_OBS          = (1 << 7) | (1 << 5), /* obs bits in dev reg */
 153         ATA_DEVCTL_OBS          = (1 << 3),     /* obsolete bit in devctl reg */
 154         ATA_BUSY                = (1 << 7),     /* BSY status bit */
 155         ATA_DRDY                = (1 << 6),     /* device ready */
 156         ATA_DF                  = (1 << 5),     /* device fault */
 157         ATA_DSC                 = (1 << 4),     /* drive seek complete */
 158         ATA_DRQ                 = (1 << 3),     /* data request i/o */
 159         ATA_CORR                = (1 << 2),     /* corrected data error */
 160         ATA_IDX                 = (1 << 1),     /* index */
 161         ATA_ERR                 = (1 << 0),     /* have an error */
 162         ATA_SRST                = (1 << 2),     /* software reset */
 163         ATA_ICRC                = (1 << 7),     /* interface CRC error */
 164         ATA_BBK                 = ATA_ICRC,     /* pre-EIDE: block marked bad */
 165         ATA_UNC                 = (1 << 6),     /* uncorrectable media error */
 166         ATA_MC                  = (1 << 5),     /* media changed */
 167         ATA_IDNF                = (1 << 4),     /* ID not found */
 168         ATA_MCR                 = (1 << 3),     /* media change requested */
 169         ATA_ABORTED             = (1 << 2),     /* command aborted */
 170         ATA_TRK0NF              = (1 << 1),     /* track 0 not found */
 171         ATA_AMNF                = (1 << 0),     /* address mark not found */
 172         ATAPI_LFS               = 0xF0,         /* last failed sense */
 173         ATAPI_EOM               = ATA_TRK0NF,   /* end of media */
 174         ATAPI_ILI               = ATA_AMNF,     /* illegal length indication */
 175         ATAPI_IO                = (1 << 1),
 176         ATAPI_COD               = (1 << 0),
 177
 178         /* ATA command block registers */
 179         ATA_REG_DATA            = 0x00,
 180         ATA_REG_ERR             = 0x01,
 181         ATA_REG_NSECT           = 0x02,
 182         ATA_REG_LBAL            = 0x03,
 183         ATA_REG_LBAM            = 0x04,
 184         ATA_REG_LBAH            = 0x05,
 185         ATA_REG_DEVICE          = 0x06,
 186         ATA_REG_STATUS          = 0x07,
 187
 188         ATA_REG_FEATURE         = ATA_REG_ERR, /* and their aliases */
 189         ATA_REG_CMD             = ATA_REG_STATUS,
 190         ATA_REG_BYTEL           = ATA_REG_LBAM,
 191         ATA_REG_BYTEH           = ATA_REG_LBAH,
 192         ATA_REG_DEVSEL          = ATA_REG_DEVICE,
 193         ATA_REG_IRQ             = ATA_REG_NSECT,
 194
 195         /* ATA device commands */
 196         ATA_CMD_DEV_RESET       = 0x08, /* ATAPI device reset */
 197         ATA_CMD_CHK_POWER       = 0xE5, /* check power mode */
 198         ATA_CMD_STANDBY         = 0xE2, /* place in standby power mode */
 199         ATA_CMD_IDLE            = 0xE3, /* place in idle power mode */
 200         ATA_CMD_EDD             = 0x90, /* execute device diagnostic */
 201         ATA_CMD_FLUSH           = 0xE7,
 202         ATA_CMD_FLUSH_EXT       = 0xEA,
 203         ATA_CMD_ID_ATA          = 0xEC,
 204         ATA_CMD_ID_ATAPI        = 0xA1,
 205         ATA_CMD_READ            = 0xC8,
 206         ATA_CMD_READ_EXT        = 0x25,
 207         ATA_CMD_WRITE           = 0xCA,
 208         ATA_CMD_WRITE_EXT       = 0x35,
 209         ATA_CMD_WRITE_FUA_EXT   = 0x3D,
 210         ATA_CMD_FPDMA_READ      = 0x60,
 211         ATA_CMD_FPDMA_WRITE     = 0x61,
 212         ATA_CMD_PIO_READ        = 0x20,
 213         ATA_CMD_PIO_READ_EXT    = 0x24,
 214         ATA_CMD_PIO_WRITE       = 0x30,
 215         ATA_CMD_PIO_WRITE_EXT   = 0x34,
 216         ATA_CMD_READ_MULTI      = 0xC4,
 217         ATA_CMD_READ_MULTI_EXT  = 0x29,
 218         ATA_CMD_WRITE_MULTI     = 0xC5,
 219         ATA_CMD_WRITE_MULTI_EXT = 0x39,
 220         ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
 221         ATA_CMD_SET_FEATURES    = 0xEF,
 222         ATA_CMD_SET_MULTI       = 0xC6,
 223         ATA_CMD_PACKET          = 0xA0,
 224         ATA_CMD_VERIFY          = 0x40,
 225         ATA_CMD_VERIFY_EXT      = 0x42,
 226         ATA_CMD_STANDBYNOW1     = 0xE0,
 227         ATA_CMD_IDLEIMMEDIATE   = 0xE1,
 228         ATA_CMD_SLEEP           = 0xE6,
 229         ATA_CMD_INIT_DEV_PARAMS = 0x91,
 230         ATA_CMD_READ_NATIVE_MAX = 0xF8,
 231         ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
 232         ATA_CMD_SET_MAX         = 0xF9,
 233         ATA_CMD_SET_MAX_EXT     = 0x37,
 234         ATA_CMD_READ_LOG_EXT    = 0x2f,
 235         ATA_CMD_PMP_READ        = 0xE4,
 236         ATA_CMD_PMP_WRITE       = 0xE8,
 237         ATA_CMD_CONF_OVERLAY    = 0xB1,
 238         ATA_CMD_SEC_FREEZE_LOCK = 0xF5,
 239         ATA_CMD_SMART           = 0xB0,
 240         ATA_CMD_MEDIA_LOCK      = 0xDE,
 241         ATA_CMD_MEDIA_UNLOCK    = 0xDF,
 242         /* marked obsolete in the ATA/ATAPI-7 spec */
 243         ATA_CMD_RESTORE         = 0x10,
 244         /* EXABYTE specific */
 245         ATA_EXABYTE_ENABLE_NEST = 0xF0,
 246
 247         /* READ_LOG_EXT pages */
 248         ATA_LOG_SATA_NCQ        = 0x10,
 249
 250         /* READ/WRITE LONG (obsolete) */
 251         ATA_CMD_READ_LONG       = 0x22,
 252         ATA_CMD_READ_LONG_ONCE  = 0x23,
 253         ATA_CMD_WRITE_LONG      = 0x32,
 254         ATA_CMD_WRITE_LONG_ONCE = 0x33,
 255
 256         /* SETFEATURES stuff */
 257         SETFEATURES_XFER        = 0x03,
 258         XFER_UDMA_7             = 0x47,
 259         XFER_UDMA_6             = 0x46,
 260         XFER_UDMA_5             = 0x45,
 261         XFER_UDMA_4             = 0x44,
 262         XFER_UDMA_3             = 0x43,
 263         XFER_UDMA_2             = 0x42,
 264         XFER_UDMA_1             = 0x41,
 265         XFER_UDMA_0             = 0x40,
 266         XFER_MW_DMA_4           = 0x24, /* CFA only */
 267         XFER_MW_DMA_3           = 0x23, /* CFA only */
 268         XFER_MW_DMA_2           = 0x22,
 269         XFER_MW_DMA_1           = 0x21,
 270         XFER_MW_DMA_0           = 0x20,
 271         XFER_SW_DMA_2           = 0x12,
 272         XFER_SW_DMA_1           = 0x11,
 273         XFER_SW_DMA_0           = 0x10,
 274         XFER_PIO_6              = 0x0E, /* CFA only */
 275         XFER_PIO_5              = 0x0D, /* CFA only */
 276         XFER_PIO_4              = 0x0C,
 277         XFER_PIO_3              = 0x0B,
 278         XFER_PIO_2              = 0x0A,
 279         XFER_PIO_1              = 0x09,
 280         XFER_PIO_0              = 0x08,
 281         XFER_PIO_SLOW           = 0x00,
 282
 283         SETFEATURES_WC_ON       = 0x02, /* Enable write cache */
 284         SETFEATURES_WC_OFF      = 0x82, /* Disable write cache */
 285
 286         /* Enable/Disable Automatic Acoustic Management */
 287         SETFEATURES_AAM_ON      = 0x42,
 288         SETFEATURES_AAM_OFF     = 0xC2,
 289
 290         SETFEATURES_SPINUP      = 0x07, /* Spin-up drive */
 291
 292         SETFEATURES_SATA_ENABLE = 0x10, /* Enable use of SATA feature */
 293         SETFEATURES_SATA_DISABLE = 0x90, /* Disable use of SATA feature */
 294
 295         /* SETFEATURE Sector counts for SATA features */
 296         SATA_AN                 = 0x05,  /* Asynchronous Notification */
 297         SATA_DIPM               = 0x03,  /* Device Initiated Power Management */
 298
 299         /* feature values for SET_MAX */
 300         ATA_SET_MAX_ADDR        = 0x00,
 301         ATA_SET_MAX_PASSWD      = 0x01,
 302         ATA_SET_MAX_LOCK        = 0x02,
 303         ATA_SET_MAX_UNLOCK      = 0x03,
 304         ATA_SET_MAX_FREEZE_LOCK = 0x04,
 305
 306         /* feature values for DEVICE CONFIGURATION OVERLAY */
 307         ATA_DCO_RESTORE         = 0xC0,
 308         ATA_DCO_FREEZE_LOCK     = 0xC1,
 309         ATA_DCO_IDENTIFY        = 0xC2,
 310         ATA_DCO_SET             = 0xC3,
 311
 312         /* feature values for SMART */
 313         ATA_SMART_ENABLE        = 0xD8,
 314         ATA_SMART_READ_VALUES   = 0xD0,
 315         ATA_SMART_READ_THRESHOLDS = 0xD1,
 316
 317         /* password used in LBA Mid / LBA High for executing SMART commands */
 318         ATA_SMART_LBAM_PASS     = 0x4F,
 319         ATA_SMART_LBAH_PASS     = 0xC2,
 320
 321         /* ATAPI stuff */
 322         ATAPI_PKT_DMA           = (1 << 0),
 323         ATAPI_DMADIR            = (1 << 2),     /* ATAPI data dir:
 324                                                    0=to device, 1=to host */
 325         ATAPI_CDB_LEN           = 16,
 326
 327         /* PMP stuff */
 328         SATA_PMP_MAX_PORTS      = 15,
 329         SATA_PMP_CTRL_PORT      = 15,
 330
 331         SATA_PMP_GSCR_DWORDS    = 128,
 332         SATA_PMP_GSCR_PROD_ID   = 0,
 333         SATA_PMP_GSCR_REV       = 1,
 334         SATA_PMP_GSCR_PORT_INFO = 2,
 335         SATA_PMP_GSCR_ERROR     = 32,
 336         SATA_PMP_GSCR_ERROR_EN  = 33,
 337         SATA_PMP_GSCR_FEAT      = 64,
 338         SATA_PMP_GSCR_FEAT_EN   = 96,
 339
 340         SATA_PMP_PSCR_STATUS    = 0,
 341         SATA_PMP_PSCR_ERROR     = 1,
 342         SATA_PMP_PSCR_CONTROL   = 2,
 343
 344         SATA_PMP_FEAT_BIST      = (1 << 0),
 345         SATA_PMP_FEAT_PMREQ     = (1 << 1),
 346         SATA_PMP_FEAT_DYNSSC    = (1 << 2),
 347         SATA_PMP_FEAT_NOTIFY    = (1 << 3),
 348
 349         /* cable types */
 350         ATA_CBL_NONE            = 0,
 351         ATA_CBL_PATA40          = 1,
 352         ATA_CBL_PATA80          = 2,
 353         ATA_CBL_PATA40_SHORT    = 3,    /* 40 wire cable to high UDMA spec */
 354         ATA_CBL_PATA_UNK        = 4,    /* don't know, maybe 80c? */
 355         ATA_CBL_PATA_IGN        = 5,    /* don't know, ignore cable handling */
 356         ATA_CBL_SATA            = 6,
 357
 358         /* SATA Status and Control Registers */
 359         SCR_STATUS              = 0,
 360         SCR_ERROR               = 1,
 361         SCR_CONTROL             = 2,
 362         SCR_ACTIVE              = 3,
 363         SCR_NOTIFICATION        = 4,
 364
 365         /* SError bits */
 366         SERR_DATA_RECOVERED     = (1 << 0), /* recovered data error */
 367         SERR_COMM_RECOVERED     = (1 << 1), /* recovered comm failure */
 368         SERR_DATA               = (1 << 8), /* unrecovered data error */
 369         SERR_PERSISTENT         = (1 << 9), /* persistent data/comm error */
 370         SERR_PROTOCOL           = (1 << 10), /* protocol violation */
 371         SERR_INTERNAL           = (1 << 11), /* host internal error */
 372         SERR_PHYRDY_CHG         = (1 << 16), /* PHY RDY changed */
 373         SERR_PHY_INT_ERR        = (1 << 17), /* PHY internal error */
 374         SERR_COMM_WAKE          = (1 << 18), /* Comm wake */
 375         SERR_10B_8B_ERR         = (1 << 19), /* 10b to 8b decode error */
 376         SERR_DISPARITY          = (1 << 20), /* Disparity */
 377         SERR_CRC                = (1 << 21), /* CRC error */
 378         SERR_HANDSHAKE          = (1 << 22), /* Handshake error */
 379         SERR_LINK_SEQ_ERR       = (1 << 23), /* Link sequence error */
 380         SERR_TRANS_ST_ERROR     = (1 << 24), /* Transport state trans. error */
 381         SERR_UNRECOG_FIS        = (1 << 25), /* Unrecognized FIS */
 382         SERR_DEV_XCHG           = (1 << 26), /* device exchanged */
 383
 384         /* struct ata_taskfile flags */
 385         ATA_TFLAG_LBA48         = (1 << 0), /* enable 48-bit LBA and "HOB" */
 386         ATA_TFLAG_ISADDR        = (1 << 1), /* enable r/w to nsect/lba regs */
 387         ATA_TFLAG_DEVICE        = (1 << 2), /* enable r/w to device reg */
 388         ATA_TFLAG_WRITE         = (1 << 3), /* data dir: host->dev==1 (write) */
 389         ATA_TFLAG_LBA           = (1 << 4), /* enable LBA */
 390         ATA_TFLAG_FUA           = (1 << 5), /* enable FUA */
 391         ATA_TFLAG_POLLING       = (1 << 6), /* set nIEN to 1 and use polling */
 392
 393         /* protocol flags */
 394         ATA_PROT_FLAG_PIO       = (1 << 0), /* is PIO */
 395         ATA_PROT_FLAG_DMA       = (1 << 1), /* is DMA */
 396         ATA_PROT_FLAG_DATA      = ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA,
 397         ATA_PROT_FLAG_NCQ       = (1 << 2), /* is NCQ */
 398         ATA_PROT_FLAG_ATAPI     = (1 << 3), /* is ATAPI */
 399 };
 400
 401 enum ata_tf_protocols {
 402         /* ATA taskfile protocols */
 403         ATA_PROT_UNKNOWN,       /* unknown/invalid */
 404         ATA_PROT_NODATA,        /* no data */
 405         ATA_PROT_PIO,           /* PIO data xfer */
 406         ATA_PROT_DMA,           /* DMA */
 407         ATA_PROT_NCQ,           /* NCQ */
 408         ATAPI_PROT_NODATA,      /* packet command, no data */
 409         ATAPI_PROT_PIO,         /* packet command, PIO data xfer*/
 410         ATAPI_PROT_DMA,         /* packet command with special DMA sauce */
 411 };
 412
 413 enum ata_ioctls {
 414         ATA_IOC_GET_IO32        = 0x309,
 415         ATA_IOC_SET_IO32        = 0x324,
 416 };
 417
 418 /* core structures */
 419
 420 struct ata_prd {
 421         __le32                  addr;
 422         __le32                  flags_len;
 423 };
 424
 425 struct ata_taskfile {
 426         unsigned long           flags;          /* ATA_TFLAG_xxx */
 427         u8                      protocol;       /* ATA_PROT_xxx */
 428
 429         u8                      ctl;            /* control reg */
 430
 431         u8                      hob_feature;    /* additional data */
 432         u8                      hob_nsect;      /* to support LBA48 */
 433         u8                      hob_lbal;
 434         u8                      hob_lbam;
 435         u8                      hob_lbah;
 436
 437         u8                      feature;
 438         u8                      nsect;
 439         u8                      lbal;
 440         u8                      lbam;
 441         u8                      lbah;
 442
 443         u8                      device;
 444
 445         u8                      command;        /* IO operation */
 446 };
 447
 448 /*
 449  * protocol tests
 450  */
 451 static inline unsigned int ata_prot_flags(u8 prot)
 452 {
 453         switch (prot) {
 454         case ATA_PROT_NODATA:
 455                 return 0;
 456         case ATA_PROT_PIO:
 457                 return ATA_PROT_FLAG_PIO;
 458         case ATA_PROT_DMA:
 459                 return ATA_PROT_FLAG_DMA;
 460         case ATA_PROT_NCQ:
 461                 return ATA_PROT_FLAG_DMA | ATA_PROT_FLAG_NCQ;
 462         case ATAPI_PROT_NODATA:
 463                 return ATA_PROT_FLAG_ATAPI;
 464         case ATAPI_PROT_PIO:
 465                 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_PIO;
 466         case ATAPI_PROT_DMA:
 467                 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_DMA;
 468         }
 469         return 0;
 470 }
 471
 472 static inline int ata_is_atapi(u8 prot)
 473 {
 474         return ata_prot_flags(prot) & ATA_PROT_FLAG_ATAPI;
 475 }
 476
 477 static inline int ata_is_nodata(u8 prot)
 478 {
 479         return !(ata_prot_flags(prot) & ATA_PROT_FLAG_DATA);
 480 }
 481
 482 static inline int ata_is_pio(u8 prot)
 483 {
 484         return ata_prot_flags(prot) & ATA_PROT_FLAG_PIO;
 485 }
 486
 487 static inline int ata_is_dma(u8 prot)
 488 {
 489         return ata_prot_flags(prot) & ATA_PROT_FLAG_DMA;
 490 }
 491
 492 static inline int ata_is_ncq(u8 prot)
 493 {
 494         return ata_prot_flags(prot) & ATA_PROT_FLAG_NCQ;
 495 }
 496
 497 static inline int ata_is_data(u8 prot)
 498 {
 499         return ata_prot_flags(prot) & ATA_PROT_FLAG_DATA;
 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)[76] & (1 << 8))
 509 #define ata_id_queue_depth(id)  (((id)[ATA_ID_QUEUE_DEPTH] & 0x1f) + 1)
 510 #define ata_id_removeable(id)   ((id)[ATA_ID_CONFIG] & (1 << 7))
 511 #define ata_id_has_atapi_AN(id) \
 512         ( (((id)[76] != 0x0000) && ((id)[76] != 0xffff)) && \
 513           ((id)[78] & (1 << 5)) )
 514 #define ata_id_iordy_disable(id) ((id)[ATA_ID_CAPABILITY] & (1 << 10))
 515 #define ata_id_has_iordy(id) ((id)[ATA_ID_CAPABILITY] & (1 << 11))
 516 #define ata_id_u32(id,n)        \
 517         (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
 518 #define ata_id_u64(id,n)        \
 519         ( ((u64) (id)[(n) + 3] << 48) | \
 520           ((u64) (id)[(n) + 2] << 32) | \
 521           ((u64) (id)[(n) + 1] << 16) | \
 522           ((u64) (id)[(n) + 0]) )
 523
 524 #define ata_id_cdb_intr(id)     (((id)[ATA_ID_CONFIG] & 0x60) == 0x20)
 525
 526 static inline bool ata_id_has_hipm(const u16 *id)
 527 {
 528         u16 val = id[76];
 529
 530         if (val == 0 || val == 0xffff)
 531                 return false;
 532
 533         return val & (1 << 9);
 534 }
 535
 536 static inline bool ata_id_has_dipm(const u16 *id)
 537 {
 538         u16 val = id[78];
 539
 540         if (val == 0 || val == 0xffff)
 541                 return false;
 542
 543         return val & (1 << 3);
 544 }
 545
 546
 547 static inline int ata_id_has_fua(const u16 *id)
 548 {
 549         if ((id[ATA_ID_CFSSE] & 0xC000) != 0x4000)
 550                 return 0;
 551         return id[ATA_ID_CFSSE] & (1 << 6);
 552 }
 553
 554 static inline int ata_id_has_flush(const u16 *id)
 555 {
 556         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
 557                 return 0;
 558         return id[ATA_ID_COMMAND_SET_2] & (1 << 12);
 559 }
 560
 561 static inline int ata_id_has_flush_ext(const u16 *id)
 562 {
 563         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
 564                 return 0;
 565         return id[ATA_ID_COMMAND_SET_2] & (1 << 13);
 566 }
 567
 568 static inline int ata_id_has_lba48(const u16 *id)
 569 {
 570         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
 571                 return 0;
 572         if (!ata_id_u64(id, ATA_ID_LBA_CAPACITY_2))
 573                 return 0;
 574         return id[ATA_ID_COMMAND_SET_2] & (1 << 10);
 575 }
 576
 577 static inline int ata_id_hpa_enabled(const u16 *id)
 578 {
 579         /* Yes children, word 83 valid bits cover word 82 data */
 580         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
 581                 return 0;
 582         /* And 87 covers 85-87 */
 583         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
 584                 return 0;
 585         /* Check command sets enabled as well as supported */
 586         if ((id[ATA_ID_CFS_ENABLE_1] & (1 << 10)) == 0)
 587                 return 0;
 588         return id[ATA_ID_COMMAND_SET_1] & (1 << 10);
 589 }
 590
 591 static inline int ata_id_has_wcache(const u16 *id)
 592 {
 593         /* Yes children, word 83 valid bits cover word 82 data */
 594         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
 595                 return 0;
 596         return id[ATA_ID_COMMAND_SET_1] & (1 << 5);
 597 }
 598
 599 static inline int ata_id_has_pm(const u16 *id)
 600 {
 601         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
 602                 return 0;
 603         return id[ATA_ID_COMMAND_SET_1] & (1 << 3);
 604 }
 605
 606 static inline int ata_id_rahead_enabled(const u16 *id)
 607 {
 608         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
 609                 return 0;
 610         return id[ATA_ID_CFS_ENABLE_1] & (1 << 6);
 611 }
 612
 613 static inline int ata_id_wcache_enabled(const u16 *id)
 614 {
 615         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
 616                 return 0;
 617         return id[ATA_ID_CFS_ENABLE_1] & (1 << 5);
 618 }
 619
 620 /**
 621  *      ata_id_major_version    -       get ATA level of drive
 622  *      @id: Identify data
 623  *
 624  *      Caveats:
 625  *              ATA-1 considers identify optional
 626  *              ATA-2 introduces mandatory identify
 627  *              ATA-3 introduces word 80 and accurate reporting
 628  *
 629  *      The practical impact of this is that ata_id_major_version cannot
 630  *      reliably report on drives below ATA3.
 631  */
 632
 633 static inline unsigned int ata_id_major_version(const u16 *id)
 634 {
 635         unsigned int mver;
 636
 637         if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
 638                 return 0;
 639
 640         for (mver = 14; mver >= 1; mver--)
 641                 if (id[ATA_ID_MAJOR_VER] & (1 << mver))
 642                         break;
 643         return mver;
 644 }
 645
 646 static inline int ata_id_is_sata(const u16 *id)
 647 {
 648         return ata_id_major_version(id) >= 5 && id[ATA_ID_HW_CONFIG] == 0;
 649 }
 650
 651 static inline int ata_id_has_tpm(const u16 *id)
 652 {
 653         /* The TPM bits are only valid on ATA8 */
 654         if (ata_id_major_version(id) < 8)
 655                 return 0;
 656         if ((id[48] & 0xC000) != 0x4000)
 657                 return 0;
 658         return id[48] & (1 << 0);
 659 }
 660
 661 static inline int ata_id_has_dword_io(const u16 *id)
 662 {
 663         /* ATA 8 reuses this flag for "trusted" computing */
 664         if (ata_id_major_version(id) > 7)
 665                 return 0;
 666         if (id[ATA_ID_DWORD_IO] & (1 << 0))
 667                 return 1;
 668         return 0;
 669 }
 670
 671 static inline int ata_id_has_unload(const u16 *id)
 672 {
 673         if (ata_id_major_version(id) >= 7 &&
 674             (id[ATA_ID_CFSSE] & 0xC000) == 0x4000 &&
 675             id[ATA_ID_CFSSE] & (1 << 13))
 676                 return 1;
 677         return 0;
 678 }
 679
 680 static inline int ata_id_current_chs_valid(const u16 *id)
 681 {
 682         /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
 683            has not been issued to the device then the values of
 684            id[ATA_ID_CUR_CYLS] to id[ATA_ID_CUR_SECTORS] are vendor specific. */
 685         return (id[ATA_ID_FIELD_VALID] & 1) && /* Current translation valid */
 686                 id[ATA_ID_CUR_CYLS] &&  /* cylinders in current translation */
 687                 id[ATA_ID_CUR_HEADS] &&  /* heads in current translation */
 688                 id[ATA_ID_CUR_HEADS] <= 16 &&
 689                 id[ATA_ID_CUR_SECTORS];    /* sectors in current translation */
 690 }
 691
 692 static inline int ata_id_is_cfa(const u16 *id)
 693 {
 694         if (id[ATA_ID_CONFIG] == 0x848A)        /* Standard CF */
 695                 return 1;
 696         /* Could be CF hiding as standard ATA */
 697         if (ata_id_major_version(id) >= 3 &&
 698             id[ATA_ID_COMMAND_SET_1] != 0xFFFF &&
 699            (id[ATA_ID_COMMAND_SET_1] & (1 << 2)))
 700                 return 1;
 701         return 0;
 702 }
 703
 704 static inline int ata_id_is_ssd(const u16 *id)
 705 {
 706         return id[ATA_ID_ROT_SPEED] == 0x01;
 707 }
 708
 709 static inline int ata_drive_40wire(const u16 *dev_id)
 710 {
 711         if (ata_id_is_sata(dev_id))
 712                 return 0;       /* SATA */
 713         if ((dev_id[ATA_ID_HW_CONFIG] & 0xE000) == 0x6000)
 714                 return 0;       /* 80 wire */
 715         return 1;
 716 }
 717
 718 static inline int ata_drive_40wire_relaxed(const u16 *dev_id)
 719 {
 720         if ((dev_id[ATA_ID_HW_CONFIG] & 0x2000) == 0x2000)
 721                 return 0;       /* 80 wire */
 722         return 1;
 723 }
 724
 725 static inline int atapi_cdb_len(const u16 *dev_id)
 726 {
 727         u16 tmp = dev_id[ATA_ID_CONFIG] & 0x3;
 728         switch (tmp) {
 729         case 0:         return 12;
 730         case 1:         return 16;
 731         default:        return -1;
 732         }
 733 }
 734
 735 static inline int atapi_command_packet_set(const u16 *dev_id)
 736 {
 737         return (dev_id[ATA_ID_CONFIG] >> 8) & 0x1f;
 738 }
 739
 740 static inline int atapi_id_dmadir(const u16 *dev_id)
 741 {
 742         return ata_id_major_version(dev_id) >= 7 && (dev_id[62] & 0x8000);
 743 }
 744
 745 static inline int is_multi_taskfile(struct ata_taskfile *tf)
 746 {
 747         return (tf->command == ATA_CMD_READ_MULTI) ||
 748                (tf->command == ATA_CMD_WRITE_MULTI) ||
 749                (tf->command == ATA_CMD_READ_MULTI_EXT) ||
 750                (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
 751                (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
 752 }
 753
 754 static inline int ata_ok(u8 status)
 755 {
 756         return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
 757                         == ATA_DRDY);
 758 }
 759
 760 static inline int lba_28_ok(u64 block, u32 n_block)
 761 {
 762         /* check the ending block number */
 763         return ((block + n_block) < ((u64)1 << 28)) && (n_block <= 256);
 764 }
 765
 766 static inline int lba_48_ok(u64 block, u32 n_block)
 767 {
 768         /* check the ending block number */
 769         return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536);
 770 }
 771
 772 #define sata_pmp_gscr_vendor(gscr)      ((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
 773 #define sata_pmp_gscr_devid(gscr)       ((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
 774 #define sata_pmp_gscr_rev(gscr)         (((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
 775 #define sata_pmp_gscr_ports(gscr)       ((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)
 776
 777 #endif /* __LINUX_ATA_H__ */