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