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/kernel.h>
  33 #include <linux/string.h>
  34 #include <linux/types.h>
  35 #include <asm/byteorder.h>
  36
  37 /* defines only for the constants which don't work well as enums */
  38 #define ATA_DMA_BOUNDARY        0xffffUL
  39 #define ATA_DMA_MASK            0xffffffffULL
  40
  41 enum {
  42         /* various global constants */
  43         ATA_MAX_DEVICES         = 2,    /* per bus/port */
  44         ATA_MAX_PRD             = 256,  /* we could make these 256/256 */
  45         ATA_SECT_SIZE           = 512,
  46         ATA_MAX_SECTORS_128     = 128,
  47         ATA_MAX_SECTORS         = 256,
  48         ATA_MAX_SECTORS_1024    = 1024,
  49         ATA_MAX_SECTORS_LBA48   = 65535,/* TODO: 65536? */
  50         ATA_MAX_SECTORS_TAPE    = 65535,
  51
  52         ATA_ID_WORDS            = 256,
  53         ATA_ID_CONFIG           = 0,
  54         ATA_ID_CYLS             = 1,
  55         ATA_ID_HEADS            = 3,
  56         ATA_ID_SECTORS          = 6,
  57         ATA_ID_SERNO            = 10,
  58         ATA_ID_BUF_SIZE         = 21,
  59         ATA_ID_FW_REV           = 23,
  60         ATA_ID_PROD             = 27,
  61         ATA_ID_MAX_MULTSECT     = 47,
  62         ATA_ID_DWORD_IO         = 48,
  63         ATA_ID_CAPABILITY       = 49,
  64         ATA_ID_OLD_PIO_MODES    = 51,
  65         ATA_ID_OLD_DMA_MODES    = 52,
  66         ATA_ID_FIELD_VALID      = 53,
  67         ATA_ID_CUR_CYLS         = 54,
  68         ATA_ID_CUR_HEADS        = 55,
  69         ATA_ID_CUR_SECTORS      = 56,
  70         ATA_ID_MULTSECT         = 59,
  71         ATA_ID_LBA_CAPACITY     = 60,
  72         ATA_ID_SWDMA_MODES      = 62,
  73         ATA_ID_MWDMA_MODES      = 63,
  74         ATA_ID_PIO_MODES        = 64,
  75         ATA_ID_EIDE_DMA_MIN     = 65,
  76         ATA_ID_EIDE_DMA_TIME    = 66,
  77         ATA_ID_EIDE_PIO         = 67,
  78         ATA_ID_EIDE_PIO_IORDY   = 68,
  79         ATA_ID_ADDITIONAL_SUPP  = 69,
  80         ATA_ID_QUEUE_DEPTH      = 75,
  81         ATA_ID_SATA_CAPABILITY  = 76,
  82         ATA_ID_SATA_CAPABILITY_2        = 77,
  83         ATA_ID_FEATURE_SUPP     = 78,
  84         ATA_ID_MAJOR_VER        = 80,
  85         ATA_ID_COMMAND_SET_1    = 82,
  86         ATA_ID_COMMAND_SET_2    = 83,
  87         ATA_ID_CFSSE            = 84,
  88         ATA_ID_CFS_ENABLE_1     = 85,
  89         ATA_ID_CFS_ENABLE_2     = 86,
  90         ATA_ID_CSF_DEFAULT      = 87,
  91         ATA_ID_UDMA_MODES       = 88,
  92         ATA_ID_HW_CONFIG        = 93,
  93         ATA_ID_SPG              = 98,
  94         ATA_ID_LBA_CAPACITY_2   = 100,
  95         ATA_ID_SECTOR_SIZE      = 106,
  96         ATA_ID_WWN              = 108,
  97         ATA_ID_LOGICAL_SECTOR_SIZE      = 117,  /* and 118 */
  98         ATA_ID_COMMAND_SET_3    = 119,
  99         ATA_ID_COMMAND_SET_4    = 120,
 100         ATA_ID_LAST_LUN         = 126,
 101         ATA_ID_DLF              = 128,
 102         ATA_ID_CSFO             = 129,
 103         ATA_ID_CFA_POWER        = 160,
 104         ATA_ID_CFA_KEY_MGMT     = 162,
 105         ATA_ID_CFA_MODES        = 163,
 106         ATA_ID_DATA_SET_MGMT    = 169,
 107         ATA_ID_ROT_SPEED        = 217,
 108         ATA_ID_PIO4             = (1 << 1),
 109
 110         ATA_ID_SERNO_LEN        = 20,
 111         ATA_ID_FW_REV_LEN       = 8,
 112         ATA_ID_PROD_LEN         = 40,
 113         ATA_ID_WWN_LEN          = 8,
 114
 115         ATA_PCI_CTL_OFS         = 2,
 116
 117         ATA_PIO0                = (1 << 0),
 118         ATA_PIO1                = ATA_PIO0 | (1 << 1),
 119         ATA_PIO2                = ATA_PIO1 | (1 << 2),
 120         ATA_PIO3                = ATA_PIO2 | (1 << 3),
 121         ATA_PIO4                = ATA_PIO3 | (1 << 4),
 122         ATA_PIO5                = ATA_PIO4 | (1 << 5),
 123         ATA_PIO6                = ATA_PIO5 | (1 << 6),
 124
 125         ATA_PIO4_ONLY           = (1 << 4),
 126
 127         ATA_SWDMA0              = (1 << 0),
 128         ATA_SWDMA1              = ATA_SWDMA0 | (1 << 1),
 129         ATA_SWDMA2              = ATA_SWDMA1 | (1 << 2),
 130
 131         ATA_SWDMA2_ONLY         = (1 << 2),
 132
 133         ATA_MWDMA0              = (1 << 0),
 134         ATA_MWDMA1              = ATA_MWDMA0 | (1 << 1),
 135         ATA_MWDMA2              = ATA_MWDMA1 | (1 << 2),
 136         ATA_MWDMA3              = ATA_MWDMA2 | (1 << 3),
 137         ATA_MWDMA4              = ATA_MWDMA3 | (1 << 4),
 138
 139         ATA_MWDMA12_ONLY        = (1 << 1) | (1 << 2),
 140         ATA_MWDMA2_ONLY         = (1 << 2),
 141
 142         ATA_UDMA0               = (1 << 0),
 143         ATA_UDMA1               = ATA_UDMA0 | (1 << 1),
 144         ATA_UDMA2               = ATA_UDMA1 | (1 << 2),
 145         ATA_UDMA3               = ATA_UDMA2 | (1 << 3),
 146         ATA_UDMA4               = ATA_UDMA3 | (1 << 4),
 147         ATA_UDMA5               = ATA_UDMA4 | (1 << 5),
 148         ATA_UDMA6               = ATA_UDMA5 | (1 << 6),
 149         ATA_UDMA7               = ATA_UDMA6 | (1 << 7),
 150         /* ATA_UDMA7 is just for completeness... doesn't exist (yet?).  */
 151
 152         ATA_UDMA24_ONLY         = (1 << 2) | (1 << 4),
 153
 154         ATA_UDMA_MASK_40C       = ATA_UDMA2,    /* udma0-2 */
 155
 156         /* DMA-related */
 157         ATA_PRD_SZ              = 8,
 158         ATA_PRD_TBL_SZ          = (ATA_MAX_PRD * ATA_PRD_SZ),
 159         ATA_PRD_EOT             = (1 << 31),    /* end-of-table flag */
 160
 161         ATA_DMA_TABLE_OFS       = 4,
 162         ATA_DMA_STATUS          = 2,
 163         ATA_DMA_CMD             = 0,
 164         ATA_DMA_WR              = (1 << 3),
 165         ATA_DMA_START           = (1 << 0),
 166         ATA_DMA_INTR            = (1 << 2),
 167         ATA_DMA_ERR             = (1 << 1),
 168         ATA_DMA_ACTIVE          = (1 << 0),
 169
 170         /* bits in ATA command block registers */
 171         ATA_HOB                 = (1 << 7),     /* LBA48 selector */
 172         ATA_NIEN                = (1 << 1),     /* disable-irq flag */
 173         ATA_LBA                 = (1 << 6),     /* LBA28 selector */
 174         ATA_DEV1                = (1 << 4),     /* Select Device 1 (slave) */
 175         ATA_DEVICE_OBS          = (1 << 7) | (1 << 5), /* obs bits in dev reg */
 176         ATA_DEVCTL_OBS          = (1 << 3),     /* obsolete bit in devctl reg */
 177         ATA_BUSY                = (1 << 7),     /* BSY status bit */
 178         ATA_DRDY                = (1 << 6),     /* device ready */
 179         ATA_DF                  = (1 << 5),     /* device fault */
 180         ATA_DSC                 = (1 << 4),     /* drive seek complete */
 181         ATA_DRQ                 = (1 << 3),     /* data request i/o */
 182         ATA_CORR                = (1 << 2),     /* corrected data error */
 183         ATA_SENSE               = (1 << 1),     /* sense code available */
 184         ATA_ERR                 = (1 << 0),     /* have an error */
 185         ATA_SRST                = (1 << 2),     /* software reset */
 186         ATA_ICRC                = (1 << 7),     /* interface CRC error */
 187         ATA_BBK                 = ATA_ICRC,     /* pre-EIDE: block marked bad */
 188         ATA_UNC                 = (1 << 6),     /* uncorrectable media error */
 189         ATA_MC                  = (1 << 5),     /* media changed */
 190         ATA_IDNF                = (1 << 4),     /* ID not found */
 191         ATA_MCR                 = (1 << 3),     /* media change requested */
 192         ATA_ABORTED             = (1 << 2),     /* command aborted */
 193         ATA_TRK0NF              = (1 << 1),     /* track 0 not found */
 194         ATA_AMNF                = (1 << 0),     /* address mark not found */
 195         ATAPI_LFS               = 0xF0,         /* last failed sense */
 196         ATAPI_EOM               = ATA_TRK0NF,   /* end of media */
 197         ATAPI_ILI               = ATA_AMNF,     /* illegal length indication */
 198         ATAPI_IO                = (1 << 1),
 199         ATAPI_COD               = (1 << 0),
 200
 201         /* ATA command block registers */
 202         ATA_REG_DATA            = 0x00,
 203         ATA_REG_ERR             = 0x01,
 204         ATA_REG_NSECT           = 0x02,
 205         ATA_REG_LBAL            = 0x03,
 206         ATA_REG_LBAM            = 0x04,
 207         ATA_REG_LBAH            = 0x05,
 208         ATA_REG_DEVICE          = 0x06,
 209         ATA_REG_STATUS          = 0x07,
 210
 211         ATA_REG_FEATURE         = ATA_REG_ERR, /* and their aliases */
 212         ATA_REG_CMD             = ATA_REG_STATUS,
 213         ATA_REG_BYTEL           = ATA_REG_LBAM,
 214         ATA_REG_BYTEH           = ATA_REG_LBAH,
 215         ATA_REG_DEVSEL          = ATA_REG_DEVICE,
 216         ATA_REG_IRQ             = ATA_REG_NSECT,
 217
 218         /* ATA device commands */
 219         ATA_CMD_DEV_RESET       = 0x08, /* ATAPI device reset */
 220         ATA_CMD_CHK_POWER       = 0xE5, /* check power mode */
 221         ATA_CMD_STANDBY         = 0xE2, /* place in standby power mode */
 222         ATA_CMD_IDLE            = 0xE3, /* place in idle power mode */
 223         ATA_CMD_EDD             = 0x90, /* execute device diagnostic */
 224         ATA_CMD_DOWNLOAD_MICRO  = 0x92,
 225         ATA_CMD_DOWNLOAD_MICRO_DMA = 0x93,
 226         ATA_CMD_NOP             = 0x00,
 227         ATA_CMD_FLUSH           = 0xE7,
 228         ATA_CMD_FLUSH_EXT       = 0xEA,
 229         ATA_CMD_ID_ATA          = 0xEC,
 230         ATA_CMD_ID_ATAPI        = 0xA1,
 231         ATA_CMD_SERVICE         = 0xA2,
 232         ATA_CMD_READ            = 0xC8,
 233         ATA_CMD_READ_EXT        = 0x25,
 234         ATA_CMD_READ_QUEUED     = 0x26,
 235         ATA_CMD_READ_STREAM_EXT = 0x2B,
 236         ATA_CMD_READ_STREAM_DMA_EXT = 0x2A,
 237         ATA_CMD_WRITE           = 0xCA,
 238         ATA_CMD_WRITE_EXT       = 0x35,
 239         ATA_CMD_WRITE_QUEUED    = 0x36,
 240         ATA_CMD_WRITE_STREAM_EXT = 0x3B,
 241         ATA_CMD_WRITE_STREAM_DMA_EXT = 0x3A,
 242         ATA_CMD_WRITE_FUA_EXT   = 0x3D,
 243         ATA_CMD_WRITE_QUEUED_FUA_EXT = 0x3E,
 244         ATA_CMD_FPDMA_READ      = 0x60,
 245         ATA_CMD_FPDMA_WRITE     = 0x61,
 246         ATA_CMD_NCQ_NON_DATA    = 0x63,
 247         ATA_CMD_FPDMA_SEND      = 0x64,
 248         ATA_CMD_FPDMA_RECV      = 0x65,
 249         ATA_CMD_PIO_READ        = 0x20,
 250         ATA_CMD_PIO_READ_EXT    = 0x24,
 251         ATA_CMD_PIO_WRITE       = 0x30,
 252         ATA_CMD_PIO_WRITE_EXT   = 0x34,
 253         ATA_CMD_READ_MULTI      = 0xC4,
 254         ATA_CMD_READ_MULTI_EXT  = 0x29,
 255         ATA_CMD_WRITE_MULTI     = 0xC5,
 256         ATA_CMD_WRITE_MULTI_EXT = 0x39,
 257         ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
 258         ATA_CMD_SET_FEATURES    = 0xEF,
 259         ATA_CMD_SET_MULTI       = 0xC6,
 260         ATA_CMD_PACKET          = 0xA0,
 261         ATA_CMD_VERIFY          = 0x40,
 262         ATA_CMD_VERIFY_EXT      = 0x42,
 263         ATA_CMD_WRITE_UNCORR_EXT = 0x45,
 264         ATA_CMD_STANDBYNOW1     = 0xE0,
 265         ATA_CMD_IDLEIMMEDIATE   = 0xE1,
 266         ATA_CMD_SLEEP           = 0xE6,
 267         ATA_CMD_INIT_DEV_PARAMS = 0x91,
 268         ATA_CMD_READ_NATIVE_MAX = 0xF8,
 269         ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
 270         ATA_CMD_SET_MAX         = 0xF9,
 271         ATA_CMD_SET_MAX_EXT     = 0x37,
 272         ATA_CMD_READ_LOG_EXT    = 0x2F,
 273         ATA_CMD_WRITE_LOG_EXT   = 0x3F,
 274         ATA_CMD_READ_LOG_DMA_EXT = 0x47,
 275         ATA_CMD_WRITE_LOG_DMA_EXT = 0x57,
 276         ATA_CMD_TRUSTED_NONDATA = 0x5B,
 277         ATA_CMD_TRUSTED_RCV     = 0x5C,
 278         ATA_CMD_TRUSTED_RCV_DMA = 0x5D,
 279         ATA_CMD_TRUSTED_SND     = 0x5E,
 280         ATA_CMD_TRUSTED_SND_DMA = 0x5F,
 281         ATA_CMD_PMP_READ        = 0xE4,
 282         ATA_CMD_PMP_READ_DMA    = 0xE9,
 283         ATA_CMD_PMP_WRITE       = 0xE8,
 284         ATA_CMD_PMP_WRITE_DMA   = 0xEB,
 285         ATA_CMD_CONF_OVERLAY    = 0xB1,
 286         ATA_CMD_SEC_SET_PASS    = 0xF1,
 287         ATA_CMD_SEC_UNLOCK      = 0xF2,
 288         ATA_CMD_SEC_ERASE_PREP  = 0xF3,
 289         ATA_CMD_SEC_ERASE_UNIT  = 0xF4,
 290         ATA_CMD_SEC_FREEZE_LOCK = 0xF5,
 291         ATA_CMD_SEC_DISABLE_PASS = 0xF6,
 292         ATA_CMD_CONFIG_STREAM   = 0x51,
 293         ATA_CMD_SMART           = 0xB0,
 294         ATA_CMD_MEDIA_LOCK      = 0xDE,
 295         ATA_CMD_MEDIA_UNLOCK    = 0xDF,
 296         ATA_CMD_DSM             = 0x06,
 297         ATA_CMD_CHK_MED_CRD_TYP = 0xD1,
 298         ATA_CMD_CFA_REQ_EXT_ERR = 0x03,
 299         ATA_CMD_CFA_WRITE_NE    = 0x38,
 300         ATA_CMD_CFA_TRANS_SECT  = 0x87,
 301         ATA_CMD_CFA_ERASE       = 0xC0,
 302         ATA_CMD_CFA_WRITE_MULT_NE = 0xCD,
 303         ATA_CMD_REQ_SENSE_DATA  = 0x0B,
 304         ATA_CMD_SANITIZE_DEVICE = 0xB4,
 305
 306         /* marked obsolete in the ATA/ATAPI-7 spec */
 307         ATA_CMD_RESTORE         = 0x10,
 308
 309         /* Subcmds for ATA_CMD_FPDMA_RECV */
 310         ATA_SUBCMD_FPDMA_RECV_RD_LOG_DMA_EXT = 0x01,
 311
 312         /* Subcmds for ATA_CMD_FPDMA_SEND */
 313         ATA_SUBCMD_FPDMA_SEND_DSM            = 0x00,
 314         ATA_SUBCMD_FPDMA_SEND_WR_LOG_DMA_EXT = 0x02,
 315
 316         /* Subcmds for ATA_CMD_NCQ_NON_DATA */
 317         ATA_SUBCMD_NCQ_NON_DATA_ABORT_QUEUE  = 0x00,
 318         ATA_SUBCMD_NCQ_NON_DATA_SET_FEATURES = 0x05,
 319         ATA_SUBCMD_NCQ_NON_DATA_ZERO_EXT     = 0x06,
 320
 321         /* READ_LOG_EXT pages */
 322         ATA_LOG_DIRECTORY       = 0x0,
 323         ATA_LOG_SATA_NCQ        = 0x10,
 324         ATA_LOG_NCQ_SEND_RECV     = 0x13,
 325         ATA_LOG_SATA_ID_DEV_DATA  = 0x30,
 326         ATA_LOG_SATA_SETTINGS     = 0x08,
 327         ATA_LOG_DEVSLP_OFFSET     = 0x30,
 328         ATA_LOG_DEVSLP_SIZE       = 0x08,
 329         ATA_LOG_DEVSLP_MDAT       = 0x00,
 330         ATA_LOG_DEVSLP_MDAT_MASK  = 0x1F,
 331         ATA_LOG_DEVSLP_DETO       = 0x01,
 332         ATA_LOG_DEVSLP_VALID      = 0x07,
 333         ATA_LOG_DEVSLP_VALID_MASK = 0x80,
 334
 335         /* NCQ send and receive log */
 336         ATA_LOG_NCQ_SEND_RECV_SUBCMDS_OFFSET    = 0x00,
 337         ATA_LOG_NCQ_SEND_RECV_SUBCMDS_DSM       = (1 << 0),
 338         ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET        = 0x04,
 339         ATA_LOG_NCQ_SEND_RECV_DSM_TRIM          = (1 << 0),
 340         ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET     = 0x08,
 341         ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED  = (1 << 0),
 342         ATA_LOG_NCQ_SEND_RECV_WR_LOG_OFFSET     = 0x0C,
 343         ATA_LOG_NCQ_SEND_RECV_WR_LOG_SUPPORTED  = (1 << 0),
 344         ATA_LOG_NCQ_SEND_RECV_SIZE              = 0x10,
 345
 346         /* NCQ Non-Data log */
 347         ATA_LOG_NCQ_NON_DATA_SUBCMDS_OFFSET     = 0x00,
 348         ATA_LOG_NCQ_NON_DATA_ABORT_OFFSET       = 0x00,
 349         ATA_LOG_NCQ_NON_DATA_ABORT_NCQ          = (1 << 0),
 350         ATA_LOG_NCQ_NON_DATA_ABORT_ALL          = (1 << 1),
 351         ATA_LOG_NCQ_NON_DATA_ABORT_STREAMING    = (1 << 2),
 352         ATA_LOG_NCQ_NON_DATA_ABORT_NON_STREAMING = (1 << 3),
 353         ATA_LOG_NCQ_NON_DATA_ABORT_SELECTED     = (1 << 4),
 354         ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET    = 0x1C,
 355         ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT       = (1 << 0),
 356         ATA_LOG_NCQ_NON_DATA_SIZE               = 0x40,
 357
 358         /* READ/WRITE LONG (obsolete) */
 359         ATA_CMD_READ_LONG       = 0x22,
 360         ATA_CMD_READ_LONG_ONCE  = 0x23,
 361         ATA_CMD_WRITE_LONG      = 0x32,
 362         ATA_CMD_WRITE_LONG_ONCE = 0x33,
 363
 364         /* SETFEATURES stuff */
 365         SETFEATURES_XFER        = 0x03,
 366         XFER_UDMA_7             = 0x47,
 367         XFER_UDMA_6             = 0x46,
 368         XFER_UDMA_5             = 0x45,
 369         XFER_UDMA_4             = 0x44,
 370         XFER_UDMA_3             = 0x43,
 371         XFER_UDMA_2             = 0x42,
 372         XFER_UDMA_1             = 0x41,
 373         XFER_UDMA_0             = 0x40,
 374         XFER_MW_DMA_4           = 0x24, /* CFA only */
 375         XFER_MW_DMA_3           = 0x23, /* CFA only */
 376         XFER_MW_DMA_2           = 0x22,
 377         XFER_MW_DMA_1           = 0x21,
 378         XFER_MW_DMA_0           = 0x20,
 379         XFER_SW_DMA_2           = 0x12,
 380         XFER_SW_DMA_1           = 0x11,
 381         XFER_SW_DMA_0           = 0x10,
 382         XFER_PIO_6              = 0x0E, /* CFA only */
 383         XFER_PIO_5              = 0x0D, /* CFA only */
 384         XFER_PIO_4              = 0x0C,
 385         XFER_PIO_3              = 0x0B,
 386         XFER_PIO_2              = 0x0A,
 387         XFER_PIO_1              = 0x09,
 388         XFER_PIO_0              = 0x08,
 389         XFER_PIO_SLOW           = 0x00,
 390
 391         SETFEATURES_WC_ON       = 0x02, /* Enable write cache */
 392         SETFEATURES_WC_OFF      = 0x82, /* Disable write cache */
 393
 394         /* Enable/Disable Automatic Acoustic Management */
 395         SETFEATURES_AAM_ON      = 0x42,
 396         SETFEATURES_AAM_OFF     = 0xC2,
 397
 398         SETFEATURES_SPINUP      = 0x07, /* Spin-up drive */
 399
 400         SETFEATURES_SATA_ENABLE = 0x10, /* Enable use of SATA feature */
 401         SETFEATURES_SATA_DISABLE = 0x90, /* Disable use of SATA feature */
 402
 403         /* SETFEATURE Sector counts for SATA features */
 404         SATA_FPDMA_OFFSET       = 0x01, /* FPDMA non-zero buffer offsets */
 405         SATA_FPDMA_AA           = 0x02, /* FPDMA Setup FIS Auto-Activate */
 406         SATA_DIPM               = 0x03, /* Device Initiated Power Management */
 407         SATA_FPDMA_IN_ORDER     = 0x04, /* FPDMA in-order data delivery */
 408         SATA_AN                 = 0x05, /* Asynchronous Notification */
 409         SATA_SSP                = 0x06, /* Software Settings Preservation */
 410         SATA_DEVSLP             = 0x09, /* Device Sleep */
 411
 412         SETFEATURE_SENSE_DATA   = 0xC3, /* Sense Data Reporting feature */
 413
 414         /* feature values for SET_MAX */
 415         ATA_SET_MAX_ADDR        = 0x00,
 416         ATA_SET_MAX_PASSWD      = 0x01,
 417         ATA_SET_MAX_LOCK        = 0x02,
 418         ATA_SET_MAX_UNLOCK      = 0x03,
 419         ATA_SET_MAX_FREEZE_LOCK = 0x04,
 420
 421         /* feature values for DEVICE CONFIGURATION OVERLAY */
 422         ATA_DCO_RESTORE         = 0xC0,
 423         ATA_DCO_FREEZE_LOCK     = 0xC1,
 424         ATA_DCO_IDENTIFY        = 0xC2,
 425         ATA_DCO_SET             = 0xC3,
 426
 427         /* feature values for SMART */
 428         ATA_SMART_ENABLE        = 0xD8,
 429         ATA_SMART_READ_VALUES   = 0xD0,
 430         ATA_SMART_READ_THRESHOLDS = 0xD1,
 431
 432         /* feature values for Data Set Management */
 433         ATA_DSM_TRIM            = 0x01,
 434
 435         /* password used in LBA Mid / LBA High for executing SMART commands */
 436         ATA_SMART_LBAM_PASS     = 0x4F,
 437         ATA_SMART_LBAH_PASS     = 0xC2,
 438
 439         /* ATAPI stuff */
 440         ATAPI_PKT_DMA           = (1 << 0),
 441         ATAPI_DMADIR            = (1 << 2),     /* ATAPI data dir:
 442                                                    0=to device, 1=to host */
 443         ATAPI_CDB_LEN           = 16,
 444
 445         /* PMP stuff */
 446         SATA_PMP_MAX_PORTS      = 15,
 447         SATA_PMP_CTRL_PORT      = 15,
 448
 449         SATA_PMP_GSCR_DWORDS    = 128,
 450         SATA_PMP_GSCR_PROD_ID   = 0,
 451         SATA_PMP_GSCR_REV       = 1,
 452         SATA_PMP_GSCR_PORT_INFO = 2,
 453         SATA_PMP_GSCR_ERROR     = 32,
 454         SATA_PMP_GSCR_ERROR_EN  = 33,
 455         SATA_PMP_GSCR_FEAT      = 64,
 456         SATA_PMP_GSCR_FEAT_EN   = 96,
 457
 458         SATA_PMP_PSCR_STATUS    = 0,
 459         SATA_PMP_PSCR_ERROR     = 1,
 460         SATA_PMP_PSCR_CONTROL   = 2,
 461
 462         SATA_PMP_FEAT_BIST      = (1 << 0),
 463         SATA_PMP_FEAT_PMREQ     = (1 << 1),
 464         SATA_PMP_FEAT_DYNSSC    = (1 << 2),
 465         SATA_PMP_FEAT_NOTIFY    = (1 << 3),
 466
 467         /* cable types */
 468         ATA_CBL_NONE            = 0,
 469         ATA_CBL_PATA40          = 1,
 470         ATA_CBL_PATA80          = 2,
 471         ATA_CBL_PATA40_SHORT    = 3,    /* 40 wire cable to high UDMA spec */
 472         ATA_CBL_PATA_UNK        = 4,    /* don't know, maybe 80c? */
 473         ATA_CBL_PATA_IGN        = 5,    /* don't know, ignore cable handling */
 474         ATA_CBL_SATA            = 6,
 475
 476         /* SATA Status and Control Registers */
 477         SCR_STATUS              = 0,
 478         SCR_ERROR               = 1,
 479         SCR_CONTROL             = 2,
 480         SCR_ACTIVE              = 3,
 481         SCR_NOTIFICATION        = 4,
 482
 483         /* SError bits */
 484         SERR_DATA_RECOVERED     = (1 << 0), /* recovered data error */
 485         SERR_COMM_RECOVERED     = (1 << 1), /* recovered comm failure */
 486         SERR_DATA               = (1 << 8), /* unrecovered data error */
 487         SERR_PERSISTENT         = (1 << 9), /* persistent data/comm error */
 488         SERR_PROTOCOL           = (1 << 10), /* protocol violation */
 489         SERR_INTERNAL           = (1 << 11), /* host internal error */
 490         SERR_PHYRDY_CHG         = (1 << 16), /* PHY RDY changed */
 491         SERR_PHY_INT_ERR        = (1 << 17), /* PHY internal error */
 492         SERR_COMM_WAKE          = (1 << 18), /* Comm wake */
 493         SERR_10B_8B_ERR         = (1 << 19), /* 10b to 8b decode error */
 494         SERR_DISPARITY          = (1 << 20), /* Disparity */
 495         SERR_CRC                = (1 << 21), /* CRC error */
 496         SERR_HANDSHAKE          = (1 << 22), /* Handshake error */
 497         SERR_LINK_SEQ_ERR       = (1 << 23), /* Link sequence error */
 498         SERR_TRANS_ST_ERROR     = (1 << 24), /* Transport state trans. error */
 499         SERR_UNRECOG_FIS        = (1 << 25), /* Unrecognized FIS */
 500         SERR_DEV_XCHG           = (1 << 26), /* device exchanged */
 501 };
 502
 503 enum ata_tf_protocols {
 504         /* ATA taskfile protocols */
 505         ATA_PROT_UNKNOWN,       /* unknown/invalid */
 506         ATA_PROT_NODATA,        /* no data */
 507         ATA_PROT_PIO,           /* PIO data xfer */
 508         ATA_PROT_DMA,           /* DMA */
 509         ATA_PROT_NCQ,           /* NCQ */
 510         ATAPI_PROT_NODATA,      /* packet command, no data */
 511         ATAPI_PROT_PIO,         /* packet command, PIO data xfer*/
 512         ATAPI_PROT_DMA,         /* packet command with special DMA sauce */
 513 };
 514
 515 enum ata_ioctls {
 516         ATA_IOC_GET_IO32        = 0x309, /* HDIO_GET_32BIT */
 517         ATA_IOC_SET_IO32        = 0x324, /* HDIO_SET_32BIT */
 518 };
 519
 520 /* core structures */
 521
 522 struct ata_bmdma_prd {
 523         __le32                  addr;
 524         __le32                  flags_len;
 525 };
 526
 527 /*
 528  * id tests
 529  */
 530 #define ata_id_is_ata(id)       (((id)[ATA_ID_CONFIG] & (1 << 15)) == 0)
 531 #define ata_id_has_lba(id)      ((id)[ATA_ID_CAPABILITY] & (1 << 9))
 532 #define ata_id_has_dma(id)      ((id)[ATA_ID_CAPABILITY] & (1 << 8))
 533 #define ata_id_has_ncq(id)      ((id)[ATA_ID_SATA_CAPABILITY] & (1 << 8))
 534 #define ata_id_queue_depth(id)  (((id)[ATA_ID_QUEUE_DEPTH] & 0x1f) + 1)
 535 #define ata_id_removable(id)    ((id)[ATA_ID_CONFIG] & (1 << 7))
 536 #define ata_id_has_atapi_AN(id) \
 537         ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
 538           ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
 539          ((id)[ATA_ID_FEATURE_SUPP] & (1 << 5)))
 540 #define ata_id_has_fpdma_aa(id) \
 541         ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
 542           ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
 543          ((id)[ATA_ID_FEATURE_SUPP] & (1 << 2)))
 544 #define ata_id_iordy_disable(id) ((id)[ATA_ID_CAPABILITY] & (1 << 10))
 545 #define ata_id_has_iordy(id) ((id)[ATA_ID_CAPABILITY] & (1 << 11))
 546 #define ata_id_u32(id,n)        \
 547         (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
 548 #define ata_id_u64(id,n)        \
 549         ( ((u64) (id)[(n) + 3] << 48) | \
 550           ((u64) (id)[(n) + 2] << 32) | \
 551           ((u64) (id)[(n) + 1] << 16) | \
 552           ((u64) (id)[(n) + 0]) )
 553
 554 #define ata_id_cdb_intr(id)     (((id)[ATA_ID_CONFIG] & 0x60) == 0x20)
 555 #define ata_id_has_da(id)       ((id)[ATA_ID_SATA_CAPABILITY_2] & (1 << 4))
 556 #define ata_id_has_devslp(id)   ((id)[ATA_ID_FEATURE_SUPP] & (1 << 8))
 557 #define ata_id_has_ncq_autosense(id) \
 558                                 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 7))
 559
 560 static inline bool ata_id_has_hipm(const u16 *id)
 561 {
 562         u16 val = id[ATA_ID_SATA_CAPABILITY];
 563
 564         if (val == 0 || val == 0xffff)
 565                 return false;
 566
 567         return val & (1 << 9);
 568 }
 569
 570 static inline bool ata_id_has_dipm(const u16 *id)
 571 {
 572         u16 val = id[ATA_ID_FEATURE_SUPP];
 573
 574         if (val == 0 || val == 0xffff)
 575                 return false;
 576
 577         return val & (1 << 3);
 578 }
 579
 580
 581 static inline bool ata_id_has_fua(const u16 *id)
 582 {
 583         if ((id[ATA_ID_CFSSE] & 0xC000) != 0x4000)
 584                 return false;
 585         return id[ATA_ID_CFSSE] & (1 << 6);
 586 }
 587
 588 static inline bool ata_id_has_flush(const u16 *id)
 589 {
 590         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
 591                 return false;
 592         return id[ATA_ID_COMMAND_SET_2] & (1 << 12);
 593 }
 594
 595 static inline bool ata_id_flush_enabled(const u16 *id)
 596 {
 597         if (ata_id_has_flush(id) == 0)
 598                 return false;
 599         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
 600                 return false;
 601         return id[ATA_ID_CFS_ENABLE_2] & (1 << 12);
 602 }
 603
 604 static inline bool ata_id_has_flush_ext(const u16 *id)
 605 {
 606         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
 607                 return false;
 608         return id[ATA_ID_COMMAND_SET_2] & (1 << 13);
 609 }
 610
 611 static inline bool ata_id_flush_ext_enabled(const u16 *id)
 612 {
 613         if (ata_id_has_flush_ext(id) == 0)
 614                 return false;
 615         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
 616                 return false;
 617         /*
 618          * some Maxtor disks have bit 13 defined incorrectly
 619          * so check bit 10 too
 620          */
 621         return (id[ATA_ID_CFS_ENABLE_2] & 0x2400) == 0x2400;
 622 }
 623
 624 static inline u32 ata_id_logical_sector_size(const u16 *id)
 625 {
 626         /* T13/1699-D Revision 6a, Sep 6, 2008. Page 128.
 627          * IDENTIFY DEVICE data, word 117-118.
 628          * 0xd000 ignores bit 13 (logical:physical > 1)
 629          */
 630         if ((id[ATA_ID_SECTOR_SIZE] & 0xd000) == 0x5000)
 631                 return (((id[ATA_ID_LOGICAL_SECTOR_SIZE+1] << 16)
 632                          + id[ATA_ID_LOGICAL_SECTOR_SIZE]) * sizeof(u16)) ;
 633         return ATA_SECT_SIZE;
 634 }
 635
 636 static inline u8 ata_id_log2_per_physical_sector(const u16 *id)
 637 {
 638         /* T13/1699-D Revision 6a, Sep 6, 2008. Page 128.
 639          * IDENTIFY DEVICE data, word 106.
 640          * 0xe000 ignores bit 12 (logical sector > 512 bytes)
 641          */
 642         if ((id[ATA_ID_SECTOR_SIZE] & 0xe000) == 0x6000)
 643                 return (id[ATA_ID_SECTOR_SIZE] & 0xf);
 644         return 0;
 645 }
 646
 647 /* Offset of logical sectors relative to physical sectors.
 648  *
 649  * If device has more than one logical sector per physical sector
 650  * (aka 512 byte emulation), vendors might offset the "sector 0" address
 651  * so sector 63 is "naturally aligned" - e.g. FAT partition table.
 652  * This avoids Read/Mod/Write penalties when using FAT partition table
 653  * and updating "well aligned" (FS perspective) physical sectors on every
 654  * transaction.
 655  */
 656 static inline u16 ata_id_logical_sector_offset(const u16 *id,
 657          u8 log2_per_phys)
 658 {
 659         u16 word_209 = id[209];
 660
 661         if ((log2_per_phys > 1) && (word_209 & 0xc000) == 0x4000) {
 662                 u16 first = word_209 & 0x3fff;
 663                 if (first > 0)
 664                         return (1 << log2_per_phys) - first;
 665         }
 666         return 0;
 667 }
 668
 669 static inline bool ata_id_has_lba48(const u16 *id)
 670 {
 671         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
 672                 return false;
 673         if (!ata_id_u64(id, ATA_ID_LBA_CAPACITY_2))
 674                 return false;
 675         return id[ATA_ID_COMMAND_SET_2] & (1 << 10);
 676 }
 677
 678 static inline bool ata_id_lba48_enabled(const u16 *id)
 679 {
 680         if (ata_id_has_lba48(id) == 0)
 681                 return false;
 682         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
 683                 return false;
 684         return id[ATA_ID_CFS_ENABLE_2] & (1 << 10);
 685 }
 686
 687 static inline bool ata_id_hpa_enabled(const u16 *id)
 688 {
 689         /* Yes children, word 83 valid bits cover word 82 data */
 690         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
 691                 return false;
 692         /* And 87 covers 85-87 */
 693         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
 694                 return false;
 695         /* Check command sets enabled as well as supported */
 696         if ((id[ATA_ID_CFS_ENABLE_1] & (1 << 10)) == 0)
 697                 return false;
 698         return id[ATA_ID_COMMAND_SET_1] & (1 << 10);
 699 }
 700
 701 static inline bool ata_id_has_wcache(const u16 *id)
 702 {
 703         /* Yes children, word 83 valid bits cover word 82 data */
 704         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
 705                 return false;
 706         return id[ATA_ID_COMMAND_SET_1] & (1 << 5);
 707 }
 708
 709 static inline bool ata_id_has_pm(const u16 *id)
 710 {
 711         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
 712                 return false;
 713         return id[ATA_ID_COMMAND_SET_1] & (1 << 3);
 714 }
 715
 716 static inline bool ata_id_rahead_enabled(const u16 *id)
 717 {
 718         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
 719                 return false;
 720         return id[ATA_ID_CFS_ENABLE_1] & (1 << 6);
 721 }
 722
 723 static inline bool ata_id_wcache_enabled(const u16 *id)
 724 {
 725         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
 726                 return false;
 727         return id[ATA_ID_CFS_ENABLE_1] & (1 << 5);
 728 }
 729
 730 static inline bool ata_id_has_read_log_dma_ext(const u16 *id)
 731 {
 732         /* Word 86 must have bit 15 set */
 733         if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
 734                 return false;
 735
 736         /* READ LOG DMA EXT support can be signaled either from word 119
 737          * or from word 120. The format is the same for both words: Bit
 738          * 15 must be cleared, bit 14 set and bit 3 set.
 739          */
 740         if ((id[ATA_ID_COMMAND_SET_3] & 0xC008) == 0x4008 ||
 741             (id[ATA_ID_COMMAND_SET_4] & 0xC008) == 0x4008)
 742                 return true;
 743
 744         return false;
 745 }
 746
 747 static inline bool ata_id_has_sense_reporting(const u16 *id)
 748 {
 749         if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
 750                 return false;
 751         return id[ATA_ID_COMMAND_SET_3] & (1 << 6);
 752 }
 753
 754 static inline bool ata_id_sense_reporting_enabled(const u16 *id)
 755 {
 756         if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
 757                 return false;
 758         return id[ATA_ID_COMMAND_SET_4] & (1 << 6);
 759 }
 760
 761 /**
 762  *      ata_id_major_version    -       get ATA level of drive
 763  *      @id: Identify data
 764  *
 765  *      Caveats:
 766  *              ATA-1 considers identify optional
 767  *              ATA-2 introduces mandatory identify
 768  *              ATA-3 introduces word 80 and accurate reporting
 769  *
 770  *      The practical impact of this is that ata_id_major_version cannot
 771  *      reliably report on drives below ATA3.
 772  */
 773
 774 static inline unsigned int ata_id_major_version(const u16 *id)
 775 {
 776         unsigned int mver;
 777
 778         if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
 779                 return 0;
 780
 781         for (mver = 14; mver >= 1; mver--)
 782                 if (id[ATA_ID_MAJOR_VER] & (1 << mver))
 783                         break;
 784         return mver;
 785 }
 786
 787 static inline bool ata_id_is_sata(const u16 *id)
 788 {
 789         /*
 790          * See if word 93 is 0 AND drive is at least ATA-5 compatible
 791          * verifying that word 80 by casting it to a signed type --
 792          * this trick allows us to filter out the reserved values of
 793          * 0x0000 and 0xffff along with the earlier ATA revisions...
 794          */
 795         if (id[ATA_ID_HW_CONFIG] == 0 && (short)id[ATA_ID_MAJOR_VER] >= 0x0020)
 796                 return true;
 797         return false;
 798 }
 799
 800 static inline bool ata_id_has_tpm(const u16 *id)
 801 {
 802         /* The TPM bits are only valid on ATA8 */
 803         if (ata_id_major_version(id) < 8)
 804                 return false;
 805         if ((id[48] & 0xC000) != 0x4000)
 806                 return false;
 807         return id[48] & (1 << 0);
 808 }
 809
 810 static inline bool ata_id_has_dword_io(const u16 *id)
 811 {
 812         /* ATA 8 reuses this flag for "trusted" computing */
 813         if (ata_id_major_version(id) > 7)
 814                 return false;
 815         return id[ATA_ID_DWORD_IO] & (1 << 0);
 816 }
 817
 818 static inline bool ata_id_has_unload(const u16 *id)
 819 {
 820         if (ata_id_major_version(id) >= 7 &&
 821             (id[ATA_ID_CFSSE] & 0xC000) == 0x4000 &&
 822             id[ATA_ID_CFSSE] & (1 << 13))
 823                 return true;
 824         return false;
 825 }
 826
 827 static inline bool ata_id_has_wwn(const u16 *id)
 828 {
 829         return (id[ATA_ID_CSF_DEFAULT] & 0xC100) == 0x4100;
 830 }
 831
 832 static inline int ata_id_form_factor(const u16 *id)
 833 {
 834         u16 val = id[168];
 835
 836         if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
 837                 return 0;
 838
 839         val &= 0xf;
 840
 841         if (val > 5)
 842                 return 0;
 843
 844         return val;
 845 }
 846
 847 static inline int ata_id_rotation_rate(const u16 *id)
 848 {
 849         u16 val = id[217];
 850
 851         if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
 852                 return 0;
 853
 854         if (val > 1 && val < 0x401)
 855                 return 0;
 856
 857         return val;
 858 }
 859
 860 static inline bool ata_id_has_ncq_send_and_recv(const u16 *id)
 861 {
 862         return id[ATA_ID_SATA_CAPABILITY_2] & BIT(6);
 863 }
 864
 865 static inline bool ata_id_has_trim(const u16 *id)
 866 {
 867         if (ata_id_major_version(id) >= 7 &&
 868             (id[ATA_ID_DATA_SET_MGMT] & 1))
 869                 return true;
 870         return false;
 871 }
 872
 873 static inline bool ata_id_has_zero_after_trim(const u16 *id)
 874 {
 875         /* DSM supported, deterministic read, and read zero after trim set */
 876         if (ata_id_has_trim(id) &&
 877             (id[ATA_ID_ADDITIONAL_SUPP] & 0x4020) == 0x4020)
 878                 return true;
 879
 880         return false;
 881 }
 882
 883 static inline bool ata_id_current_chs_valid(const u16 *id)
 884 {
 885         /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
 886            has not been issued to the device then the values of
 887            id[ATA_ID_CUR_CYLS] to id[ATA_ID_CUR_SECTORS] are vendor specific. */
 888         return (id[ATA_ID_FIELD_VALID] & 1) && /* Current translation valid */
 889                 id[ATA_ID_CUR_CYLS] &&  /* cylinders in current translation */
 890                 id[ATA_ID_CUR_HEADS] &&  /* heads in current translation */
 891                 id[ATA_ID_CUR_HEADS] <= 16 &&
 892                 id[ATA_ID_CUR_SECTORS];    /* sectors in current translation */
 893 }
 894
 895 static inline bool ata_id_is_cfa(const u16 *id)
 896 {
 897         if ((id[ATA_ID_CONFIG] == 0x848A) ||    /* Traditional CF */
 898             (id[ATA_ID_CONFIG] == 0x844A))      /* Delkin Devices CF */
 899                 return true;
 900         /*
 901          * CF specs don't require specific value in the word 0 anymore and yet
 902          * they forbid to report the ATA version in the word 80 and require the
 903          * CFA feature set support to be indicated in the word 83 in this case.
 904          * Unfortunately, some cards only follow either of this requirements,
 905          * and while those that don't indicate CFA feature support need some
 906          * sort of quirk list, it seems impractical for the ones that do...
 907          */
 908         return (id[ATA_ID_COMMAND_SET_2] & 0xC004) == 0x4004;
 909 }
 910
 911 static inline bool ata_id_is_ssd(const u16 *id)
 912 {
 913         return id[ATA_ID_ROT_SPEED] == 0x01;
 914 }
 915
 916 static inline bool ata_id_pio_need_iordy(const u16 *id, const u8 pio)
 917 {
 918         /* CF spec. r4.1 Table 22 says no IORDY on PIO5 and PIO6. */
 919         if (pio > 4 && ata_id_is_cfa(id))
 920                 return false;
 921         /* For PIO3 and higher it is mandatory. */
 922         if (pio > 2)
 923                 return true;
 924         /* Turn it on when possible. */
 925         return ata_id_has_iordy(id);
 926 }
 927
 928 static inline bool ata_drive_40wire(const u16 *dev_id)
 929 {
 930         if (ata_id_is_sata(dev_id))
 931                 return false;   /* SATA */
 932         if ((dev_id[ATA_ID_HW_CONFIG] & 0xE000) == 0x6000)
 933                 return false;   /* 80 wire */
 934         return true;
 935 }
 936
 937 static inline bool ata_drive_40wire_relaxed(const u16 *dev_id)
 938 {
 939         if ((dev_id[ATA_ID_HW_CONFIG] & 0x2000) == 0x2000)
 940                 return false;   /* 80 wire */
 941         return true;
 942 }
 943
 944 static inline int atapi_cdb_len(const u16 *dev_id)
 945 {
 946         u16 tmp = dev_id[ATA_ID_CONFIG] & 0x3;
 947         switch (tmp) {
 948         case 0:         return 12;
 949         case 1:         return 16;
 950         default:        return -1;
 951         }
 952 }
 953
 954 static inline int atapi_command_packet_set(const u16 *dev_id)
 955 {
 956         return (dev_id[ATA_ID_CONFIG] >> 8) & 0x1f;
 957 }
 958
 959 static inline bool atapi_id_dmadir(const u16 *dev_id)
 960 {
 961         return ata_id_major_version(dev_id) >= 7 && (dev_id[62] & 0x8000);
 962 }
 963
 964 /*
 965  * ata_id_is_lba_capacity_ok() performs a sanity check on
 966  * the claimed LBA capacity value for the device.
 967  *
 968  * Returns 1 if LBA capacity looks sensible, 0 otherwise.
 969  *
 970  * It is called only once for each device.
 971  */
 972 static inline bool ata_id_is_lba_capacity_ok(u16 *id)
 973 {
 974         unsigned long lba_sects, chs_sects, head, tail;
 975
 976         /* No non-LBA info .. so valid! */
 977         if (id[ATA_ID_CYLS] == 0)
 978                 return true;
 979
 980         lba_sects = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
 981
 982         /*
 983          * The ATA spec tells large drives to return
 984          * C/H/S = 16383/16/63 independent of their size.
 985          * Some drives can be jumpered to use 15 heads instead of 16.
 986          * Some drives can be jumpered to use 4092 cyls instead of 16383.
 987          */
 988         if ((id[ATA_ID_CYLS] == 16383 ||
 989              (id[ATA_ID_CYLS] == 4092 && id[ATA_ID_CUR_CYLS] == 16383)) &&
 990             id[ATA_ID_SECTORS] == 63 &&
 991             (id[ATA_ID_HEADS] == 15 || id[ATA_ID_HEADS] == 16) &&
 992             (lba_sects >= 16383 * 63 * id[ATA_ID_HEADS]))
 993                 return true;
 994
 995         chs_sects = id[ATA_ID_CYLS] * id[ATA_ID_HEADS] * id[ATA_ID_SECTORS];
 996
 997         /* perform a rough sanity check on lba_sects: within 10% is OK */
 998         if (lba_sects - chs_sects < chs_sects/10)
 999                 return true;
1000
1001         /* some drives have the word order reversed */
1002         head = (lba_sects >> 16) & 0xffff;
1003         tail = lba_sects & 0xffff;
1004         lba_sects = head | (tail << 16);
1005
1006         if (lba_sects - chs_sects < chs_sects/10) {
1007                 *(__le32 *)&id[ATA_ID_LBA_CAPACITY] = __cpu_to_le32(lba_sects);
1008                 return true;    /* LBA capacity is (now) good */
1009         }
1010
1011         return false;   /* LBA capacity value may be bad */
1012 }
1013
1014 static inline void ata_id_to_hd_driveid(u16 *id)
1015 {
1016 #ifdef __BIG_ENDIAN
1017         /* accessed in struct hd_driveid as 8-bit values */
1018         id[ATA_ID_MAX_MULTSECT]  = __cpu_to_le16(id[ATA_ID_MAX_MULTSECT]);
1019         id[ATA_ID_CAPABILITY]    = __cpu_to_le16(id[ATA_ID_CAPABILITY]);
1020         id[ATA_ID_OLD_PIO_MODES] = __cpu_to_le16(id[ATA_ID_OLD_PIO_MODES]);
1021         id[ATA_ID_OLD_DMA_MODES] = __cpu_to_le16(id[ATA_ID_OLD_DMA_MODES]);
1022         id[ATA_ID_MULTSECT]      = __cpu_to_le16(id[ATA_ID_MULTSECT]);
1023
1024         /* as 32-bit values */
1025         *(u32 *)&id[ATA_ID_LBA_CAPACITY] = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
1026         *(u32 *)&id[ATA_ID_SPG]          = ata_id_u32(id, ATA_ID_SPG);
1027
1028         /* as 64-bit value */
1029         *(u64 *)&id[ATA_ID_LBA_CAPACITY_2] =
1030                 ata_id_u64(id, ATA_ID_LBA_CAPACITY_2);
1031 #endif
1032 }
1033
1034 /*
1035  * Write LBA Range Entries to the buffer that will cover the extent from
1036  * sector to sector + count.  This is used for TRIM and for ADD LBA(S)
1037  * TO NV CACHE PINNED SET.
1038  */
1039 static inline unsigned ata_set_lba_range_entries(void *_buffer,
1040                 unsigned buf_size, u64 sector, unsigned long count)
1041 {
1042         __le64 *buffer = _buffer;
1043         unsigned i = 0, used_bytes;
1044
1045         while (i < buf_size / 8 ) { /* 6-byte LBA + 2-byte range per entry */
1046                 u64 entry = sector |
1047                         ((u64)(count > 0xffff ? 0xffff : count) << 48);
1048                 buffer[i++] = __cpu_to_le64(entry);
1049                 if (count <= 0xffff)
1050                         break;
1051                 count -= 0xffff;
1052                 sector += 0xffff;
1053         }
1054
1055         used_bytes = ALIGN(i * 8, 512);
1056         memset(buffer + i, 0, used_bytes - i * 8);
1057         return used_bytes;
1058 }
1059
1060 static inline bool ata_ok(u8 status)
1061 {
1062         return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
1063                         == ATA_DRDY);
1064 }
1065
1066 static inline bool lba_28_ok(u64 block, u32 n_block)
1067 {
1068         /* check the ending block number: must be LESS THAN 0x0fffffff */
1069         return ((block + n_block) < ((1 << 28) - 1)) && (n_block <= 256);
1070 }
1071
1072 static inline bool lba_48_ok(u64 block, u32 n_block)
1073 {
1074         /* check the ending block number */
1075         return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536);
1076 }
1077
1078 #define sata_pmp_gscr_vendor(gscr)      ((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
1079 #define sata_pmp_gscr_devid(gscr)       ((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
1080 #define sata_pmp_gscr_rev(gscr)         (((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
1081 #define sata_pmp_gscr_ports(gscr)       ((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)
1082
1083 #endif /* __LINUX_ATA_H__ */