Back to home page

OSCL-LXR
 
 

     

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 
0003 /*
0004  *  Copyright 2003-2004 Red Hat, Inc.  All rights reserved.
0005  *  Copyright 2003-2004 Jeff Garzik
0006  *
0007  *  libata documentation is available via 'make {ps|pdf}docs',
0008  *  as Documentation/driver-api/libata.rst
0009  *
0010  *  Hardware documentation available from http://www.t13.org/
0011  */
0012 
0013 #ifndef __LINUX_ATA_H__
0014 #define __LINUX_ATA_H__
0015 
0016 #include <linux/bits.h>
0017 #include <linux/string.h>
0018 #include <linux/types.h>
0019 #include <asm/byteorder.h>
0020 
0021 /* defines only for the constants which don't work well as enums */
0022 #define ATA_DMA_BOUNDARY    0xffffUL
0023 #define ATA_DMA_MASK        0xffffffffULL
0024 
0025 enum {
0026     /* various global constants */
0027     ATA_MAX_DEVICES     = 2,    /* per bus/port */
0028     ATA_MAX_PRD     = 256,  /* we could make these 256/256 */
0029     ATA_SECT_SIZE       = 512,
0030     ATA_MAX_SECTORS_128 = 128,
0031     ATA_MAX_SECTORS     = 256,
0032     ATA_MAX_SECTORS_1024    = 1024,
0033     ATA_MAX_SECTORS_LBA48   = 65535,/* avoid count to be 0000h */
0034     ATA_MAX_SECTORS_TAPE    = 65535,
0035     ATA_MAX_TRIM_RNUM   = 64,   /* 512-byte payload / (6-byte LBA + 2-byte range per entry) */
0036 
0037     ATA_ID_WORDS        = 256,
0038     ATA_ID_CONFIG       = 0,
0039     ATA_ID_CYLS     = 1,
0040     ATA_ID_HEADS        = 3,
0041     ATA_ID_SECTORS      = 6,
0042     ATA_ID_SERNO        = 10,
0043     ATA_ID_BUF_SIZE     = 21,
0044     ATA_ID_FW_REV       = 23,
0045     ATA_ID_PROD     = 27,
0046     ATA_ID_MAX_MULTSECT = 47,
0047     ATA_ID_DWORD_IO     = 48,   /* before ATA-8 */
0048     ATA_ID_TRUSTED      = 48,   /* ATA-8 and later */
0049     ATA_ID_CAPABILITY   = 49,
0050     ATA_ID_OLD_PIO_MODES    = 51,
0051     ATA_ID_OLD_DMA_MODES    = 52,
0052     ATA_ID_FIELD_VALID  = 53,
0053     ATA_ID_CUR_CYLS     = 54,
0054     ATA_ID_CUR_HEADS    = 55,
0055     ATA_ID_CUR_SECTORS  = 56,
0056     ATA_ID_MULTSECT     = 59,
0057     ATA_ID_LBA_CAPACITY = 60,
0058     ATA_ID_SWDMA_MODES  = 62,
0059     ATA_ID_MWDMA_MODES  = 63,
0060     ATA_ID_PIO_MODES    = 64,
0061     ATA_ID_EIDE_DMA_MIN = 65,
0062     ATA_ID_EIDE_DMA_TIME    = 66,
0063     ATA_ID_EIDE_PIO     = 67,
0064     ATA_ID_EIDE_PIO_IORDY   = 68,
0065     ATA_ID_ADDITIONAL_SUPP  = 69,
0066     ATA_ID_QUEUE_DEPTH  = 75,
0067     ATA_ID_SATA_CAPABILITY  = 76,
0068     ATA_ID_SATA_CAPABILITY_2    = 77,
0069     ATA_ID_FEATURE_SUPP = 78,
0070     ATA_ID_MAJOR_VER    = 80,
0071     ATA_ID_COMMAND_SET_1    = 82,
0072     ATA_ID_COMMAND_SET_2    = 83,
0073     ATA_ID_CFSSE        = 84,
0074     ATA_ID_CFS_ENABLE_1 = 85,
0075     ATA_ID_CFS_ENABLE_2 = 86,
0076     ATA_ID_CSF_DEFAULT  = 87,
0077     ATA_ID_UDMA_MODES   = 88,
0078     ATA_ID_HW_CONFIG    = 93,
0079     ATA_ID_SPG      = 98,
0080     ATA_ID_LBA_CAPACITY_2   = 100,
0081     ATA_ID_SECTOR_SIZE  = 106,
0082     ATA_ID_WWN      = 108,
0083     ATA_ID_LOGICAL_SECTOR_SIZE  = 117,  /* and 118 */
0084     ATA_ID_COMMAND_SET_3    = 119,
0085     ATA_ID_COMMAND_SET_4    = 120,
0086     ATA_ID_LAST_LUN     = 126,
0087     ATA_ID_DLF      = 128,
0088     ATA_ID_CSFO     = 129,
0089     ATA_ID_CFA_POWER    = 160,
0090     ATA_ID_CFA_KEY_MGMT = 162,
0091     ATA_ID_CFA_MODES    = 163,
0092     ATA_ID_DATA_SET_MGMT    = 169,
0093     ATA_ID_SCT_CMD_XPORT    = 206,
0094     ATA_ID_ROT_SPEED    = 217,
0095     ATA_ID_PIO4     = (1 << 1),
0096 
0097     ATA_ID_SERNO_LEN    = 20,
0098     ATA_ID_FW_REV_LEN   = 8,
0099     ATA_ID_PROD_LEN     = 40,
0100     ATA_ID_WWN_LEN      = 8,
0101 
0102     ATA_PCI_CTL_OFS     = 2,
0103 
0104     ATA_PIO0        = (1 << 0),
0105     ATA_PIO1        = ATA_PIO0 | (1 << 1),
0106     ATA_PIO2        = ATA_PIO1 | (1 << 2),
0107     ATA_PIO3        = ATA_PIO2 | (1 << 3),
0108     ATA_PIO4        = ATA_PIO3 | (1 << 4),
0109     ATA_PIO5        = ATA_PIO4 | (1 << 5),
0110     ATA_PIO6        = ATA_PIO5 | (1 << 6),
0111 
0112     ATA_PIO4_ONLY       = (1 << 4),
0113 
0114     ATA_SWDMA0      = (1 << 0),
0115     ATA_SWDMA1      = ATA_SWDMA0 | (1 << 1),
0116     ATA_SWDMA2      = ATA_SWDMA1 | (1 << 2),
0117 
0118     ATA_SWDMA2_ONLY     = (1 << 2),
0119 
0120     ATA_MWDMA0      = (1 << 0),
0121     ATA_MWDMA1      = ATA_MWDMA0 | (1 << 1),
0122     ATA_MWDMA2      = ATA_MWDMA1 | (1 << 2),
0123     ATA_MWDMA3      = ATA_MWDMA2 | (1 << 3),
0124     ATA_MWDMA4      = ATA_MWDMA3 | (1 << 4),
0125 
0126     ATA_MWDMA12_ONLY    = (1 << 1) | (1 << 2),
0127     ATA_MWDMA2_ONLY     = (1 << 2),
0128 
0129     ATA_UDMA0       = (1 << 0),
0130     ATA_UDMA1       = ATA_UDMA0 | (1 << 1),
0131     ATA_UDMA2       = ATA_UDMA1 | (1 << 2),
0132     ATA_UDMA3       = ATA_UDMA2 | (1 << 3),
0133     ATA_UDMA4       = ATA_UDMA3 | (1 << 4),
0134     ATA_UDMA5       = ATA_UDMA4 | (1 << 5),
0135     ATA_UDMA6       = ATA_UDMA5 | (1 << 6),
0136     ATA_UDMA7       = ATA_UDMA6 | (1 << 7),
0137     /* ATA_UDMA7 is just for completeness... doesn't exist (yet?).  */
0138 
0139     ATA_UDMA24_ONLY     = (1 << 2) | (1 << 4),
0140 
0141     ATA_UDMA_MASK_40C   = ATA_UDMA2,    /* udma0-2 */
0142 
0143     /* DMA-related */
0144     ATA_PRD_SZ      = 8,
0145     ATA_PRD_TBL_SZ      = (ATA_MAX_PRD * ATA_PRD_SZ),
0146     ATA_PRD_EOT     = (1 << 31),    /* end-of-table flag */
0147 
0148     ATA_DMA_TABLE_OFS   = 4,
0149     ATA_DMA_STATUS      = 2,
0150     ATA_DMA_CMD     = 0,
0151     ATA_DMA_WR      = (1 << 3),
0152     ATA_DMA_START       = (1 << 0),
0153     ATA_DMA_INTR        = (1 << 2),
0154     ATA_DMA_ERR     = (1 << 1),
0155     ATA_DMA_ACTIVE      = (1 << 0),
0156 
0157     /* bits in ATA command block registers */
0158     ATA_HOB         = (1 << 7), /* LBA48 selector */
0159     ATA_NIEN        = (1 << 1), /* disable-irq flag */
0160     ATA_LBA         = (1 << 6), /* LBA28 selector */
0161     ATA_DEV1        = (1 << 4), /* Select Device 1 (slave) */
0162     ATA_DEVICE_OBS      = (1 << 7) | (1 << 5), /* obs bits in dev reg */
0163     ATA_DEVCTL_OBS      = (1 << 3), /* obsolete bit in devctl reg */
0164     ATA_BUSY        = (1 << 7), /* BSY status bit */
0165     ATA_DRDY        = (1 << 6), /* device ready */
0166     ATA_DF          = (1 << 5), /* device fault */
0167     ATA_DSC         = (1 << 4), /* drive seek complete */
0168     ATA_DRQ         = (1 << 3), /* data request i/o */
0169     ATA_CORR        = (1 << 2), /* corrected data error */
0170     ATA_SENSE       = (1 << 1), /* sense code available */
0171     ATA_ERR         = (1 << 0), /* have an error */
0172     ATA_SRST        = (1 << 2), /* software reset */
0173     ATA_ICRC        = (1 << 7), /* interface CRC error */
0174     ATA_BBK         = ATA_ICRC, /* pre-EIDE: block marked bad */
0175     ATA_UNC         = (1 << 6), /* uncorrectable media error */
0176     ATA_MC          = (1 << 5), /* media changed */
0177     ATA_IDNF        = (1 << 4), /* ID not found */
0178     ATA_MCR         = (1 << 3), /* media change requested */
0179     ATA_ABORTED     = (1 << 2), /* command aborted */
0180     ATA_TRK0NF      = (1 << 1), /* track 0 not found */
0181     ATA_AMNF        = (1 << 0), /* address mark not found */
0182     ATAPI_LFS       = 0xF0,     /* last failed sense */
0183     ATAPI_EOM       = ATA_TRK0NF,   /* end of media */
0184     ATAPI_ILI       = ATA_AMNF, /* illegal length indication */
0185     ATAPI_IO        = (1 << 1),
0186     ATAPI_COD       = (1 << 0),
0187 
0188     /* ATA command block registers */
0189     ATA_REG_DATA        = 0x00,
0190     ATA_REG_ERR     = 0x01,
0191     ATA_REG_NSECT       = 0x02,
0192     ATA_REG_LBAL        = 0x03,
0193     ATA_REG_LBAM        = 0x04,
0194     ATA_REG_LBAH        = 0x05,
0195     ATA_REG_DEVICE      = 0x06,
0196     ATA_REG_STATUS      = 0x07,
0197 
0198     ATA_REG_FEATURE     = ATA_REG_ERR, /* and their aliases */
0199     ATA_REG_CMD     = ATA_REG_STATUS,
0200     ATA_REG_BYTEL       = ATA_REG_LBAM,
0201     ATA_REG_BYTEH       = ATA_REG_LBAH,
0202     ATA_REG_DEVSEL      = ATA_REG_DEVICE,
0203     ATA_REG_IRQ     = ATA_REG_NSECT,
0204 
0205     /* ATA device commands */
0206     ATA_CMD_DEV_RESET   = 0x08, /* ATAPI device reset */
0207     ATA_CMD_CHK_POWER   = 0xE5, /* check power mode */
0208     ATA_CMD_STANDBY     = 0xE2, /* place in standby power mode */
0209     ATA_CMD_IDLE        = 0xE3, /* place in idle power mode */
0210     ATA_CMD_EDD     = 0x90, /* execute device diagnostic */
0211     ATA_CMD_DOWNLOAD_MICRO  = 0x92,
0212     ATA_CMD_DOWNLOAD_MICRO_DMA = 0x93,
0213     ATA_CMD_NOP     = 0x00,
0214     ATA_CMD_FLUSH       = 0xE7,
0215     ATA_CMD_FLUSH_EXT   = 0xEA,
0216     ATA_CMD_ID_ATA      = 0xEC,
0217     ATA_CMD_ID_ATAPI    = 0xA1,
0218     ATA_CMD_SERVICE     = 0xA2,
0219     ATA_CMD_READ        = 0xC8,
0220     ATA_CMD_READ_EXT    = 0x25,
0221     ATA_CMD_READ_QUEUED = 0x26,
0222     ATA_CMD_READ_STREAM_EXT = 0x2B,
0223     ATA_CMD_READ_STREAM_DMA_EXT = 0x2A,
0224     ATA_CMD_WRITE       = 0xCA,
0225     ATA_CMD_WRITE_EXT   = 0x35,
0226     ATA_CMD_WRITE_QUEUED    = 0x36,
0227     ATA_CMD_WRITE_STREAM_EXT = 0x3B,
0228     ATA_CMD_WRITE_STREAM_DMA_EXT = 0x3A,
0229     ATA_CMD_WRITE_FUA_EXT   = 0x3D,
0230     ATA_CMD_WRITE_QUEUED_FUA_EXT = 0x3E,
0231     ATA_CMD_FPDMA_READ  = 0x60,
0232     ATA_CMD_FPDMA_WRITE = 0x61,
0233     ATA_CMD_NCQ_NON_DATA    = 0x63,
0234     ATA_CMD_FPDMA_SEND  = 0x64,
0235     ATA_CMD_FPDMA_RECV  = 0x65,
0236     ATA_CMD_PIO_READ    = 0x20,
0237     ATA_CMD_PIO_READ_EXT    = 0x24,
0238     ATA_CMD_PIO_WRITE   = 0x30,
0239     ATA_CMD_PIO_WRITE_EXT   = 0x34,
0240     ATA_CMD_READ_MULTI  = 0xC4,
0241     ATA_CMD_READ_MULTI_EXT  = 0x29,
0242     ATA_CMD_WRITE_MULTI = 0xC5,
0243     ATA_CMD_WRITE_MULTI_EXT = 0x39,
0244     ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
0245     ATA_CMD_SET_FEATURES    = 0xEF,
0246     ATA_CMD_SET_MULTI   = 0xC6,
0247     ATA_CMD_PACKET      = 0xA0,
0248     ATA_CMD_VERIFY      = 0x40,
0249     ATA_CMD_VERIFY_EXT  = 0x42,
0250     ATA_CMD_WRITE_UNCORR_EXT = 0x45,
0251     ATA_CMD_STANDBYNOW1 = 0xE0,
0252     ATA_CMD_IDLEIMMEDIATE   = 0xE1,
0253     ATA_CMD_SLEEP       = 0xE6,
0254     ATA_CMD_INIT_DEV_PARAMS = 0x91,
0255     ATA_CMD_READ_NATIVE_MAX = 0xF8,
0256     ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
0257     ATA_CMD_SET_MAX     = 0xF9,
0258     ATA_CMD_SET_MAX_EXT = 0x37,
0259     ATA_CMD_READ_LOG_EXT    = 0x2F,
0260     ATA_CMD_WRITE_LOG_EXT   = 0x3F,
0261     ATA_CMD_READ_LOG_DMA_EXT = 0x47,
0262     ATA_CMD_WRITE_LOG_DMA_EXT = 0x57,
0263     ATA_CMD_TRUSTED_NONDATA = 0x5B,
0264     ATA_CMD_TRUSTED_RCV = 0x5C,
0265     ATA_CMD_TRUSTED_RCV_DMA = 0x5D,
0266     ATA_CMD_TRUSTED_SND = 0x5E,
0267     ATA_CMD_TRUSTED_SND_DMA = 0x5F,
0268     ATA_CMD_PMP_READ    = 0xE4,
0269     ATA_CMD_PMP_READ_DMA    = 0xE9,
0270     ATA_CMD_PMP_WRITE   = 0xE8,
0271     ATA_CMD_PMP_WRITE_DMA   = 0xEB,
0272     ATA_CMD_CONF_OVERLAY    = 0xB1,
0273     ATA_CMD_SEC_SET_PASS    = 0xF1,
0274     ATA_CMD_SEC_UNLOCK  = 0xF2,
0275     ATA_CMD_SEC_ERASE_PREP  = 0xF3,
0276     ATA_CMD_SEC_ERASE_UNIT  = 0xF4,
0277     ATA_CMD_SEC_FREEZE_LOCK = 0xF5,
0278     ATA_CMD_SEC_DISABLE_PASS = 0xF6,
0279     ATA_CMD_CONFIG_STREAM   = 0x51,
0280     ATA_CMD_SMART       = 0xB0,
0281     ATA_CMD_MEDIA_LOCK  = 0xDE,
0282     ATA_CMD_MEDIA_UNLOCK    = 0xDF,
0283     ATA_CMD_DSM     = 0x06,
0284     ATA_CMD_CHK_MED_CRD_TYP = 0xD1,
0285     ATA_CMD_CFA_REQ_EXT_ERR = 0x03,
0286     ATA_CMD_CFA_WRITE_NE    = 0x38,
0287     ATA_CMD_CFA_TRANS_SECT  = 0x87,
0288     ATA_CMD_CFA_ERASE   = 0xC0,
0289     ATA_CMD_CFA_WRITE_MULT_NE = 0xCD,
0290     ATA_CMD_REQ_SENSE_DATA  = 0x0B,
0291     ATA_CMD_SANITIZE_DEVICE = 0xB4,
0292     ATA_CMD_ZAC_MGMT_IN = 0x4A,
0293     ATA_CMD_ZAC_MGMT_OUT    = 0x9F,
0294 
0295     /* marked obsolete in the ATA/ATAPI-7 spec */
0296     ATA_CMD_RESTORE     = 0x10,
0297 
0298     /* Subcmds for ATA_CMD_FPDMA_RECV */
0299     ATA_SUBCMD_FPDMA_RECV_RD_LOG_DMA_EXT = 0x01,
0300     ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN    = 0x02,
0301 
0302     /* Subcmds for ATA_CMD_FPDMA_SEND */
0303     ATA_SUBCMD_FPDMA_SEND_DSM            = 0x00,
0304     ATA_SUBCMD_FPDMA_SEND_WR_LOG_DMA_EXT = 0x02,
0305 
0306     /* Subcmds for ATA_CMD_NCQ_NON_DATA */
0307     ATA_SUBCMD_NCQ_NON_DATA_ABORT_QUEUE  = 0x00,
0308     ATA_SUBCMD_NCQ_NON_DATA_SET_FEATURES = 0x05,
0309     ATA_SUBCMD_NCQ_NON_DATA_ZERO_EXT     = 0x06,
0310     ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT = 0x07,
0311 
0312     /* Subcmds for ATA_CMD_ZAC_MGMT_IN */
0313     ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES = 0x00,
0314 
0315     /* Subcmds for ATA_CMD_ZAC_MGMT_OUT */
0316     ATA_SUBCMD_ZAC_MGMT_OUT_CLOSE_ZONE = 0x01,
0317     ATA_SUBCMD_ZAC_MGMT_OUT_FINISH_ZONE = 0x02,
0318     ATA_SUBCMD_ZAC_MGMT_OUT_OPEN_ZONE = 0x03,
0319     ATA_SUBCMD_ZAC_MGMT_OUT_RESET_WRITE_POINTER = 0x04,
0320 
0321     /* READ_LOG_EXT pages */
0322     ATA_LOG_DIRECTORY   = 0x0,
0323     ATA_LOG_SATA_NCQ    = 0x10,
0324     ATA_LOG_NCQ_NON_DATA    = 0x12,
0325     ATA_LOG_NCQ_SEND_RECV   = 0x13,
0326     ATA_LOG_IDENTIFY_DEVICE = 0x30,
0327     ATA_LOG_CONCURRENT_POSITIONING_RANGES = 0x47,
0328 
0329     /* Identify device log pages: */
0330     ATA_LOG_SECURITY      = 0x06,
0331     ATA_LOG_SATA_SETTINGS     = 0x08,
0332     ATA_LOG_ZONED_INFORMATION = 0x09,
0333 
0334     /* Identify device SATA settings log:*/
0335     ATA_LOG_DEVSLP_OFFSET     = 0x30,
0336     ATA_LOG_DEVSLP_SIZE   = 0x08,
0337     ATA_LOG_DEVSLP_MDAT   = 0x00,
0338     ATA_LOG_DEVSLP_MDAT_MASK  = 0x1F,
0339     ATA_LOG_DEVSLP_DETO   = 0x01,
0340     ATA_LOG_DEVSLP_VALID      = 0x07,
0341     ATA_LOG_DEVSLP_VALID_MASK = 0x80,
0342     ATA_LOG_NCQ_PRIO_OFFSET   = 0x09,
0343 
0344     /* NCQ send and receive log */
0345     ATA_LOG_NCQ_SEND_RECV_SUBCMDS_OFFSET    = 0x00,
0346     ATA_LOG_NCQ_SEND_RECV_SUBCMDS_DSM   = (1 << 0),
0347     ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET    = 0x04,
0348     ATA_LOG_NCQ_SEND_RECV_DSM_TRIM      = (1 << 0),
0349     ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET = 0x08,
0350     ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED  = (1 << 0),
0351     ATA_LOG_NCQ_SEND_RECV_WR_LOG_OFFSET = 0x0C,
0352     ATA_LOG_NCQ_SEND_RECV_WR_LOG_SUPPORTED  = (1 << 0),
0353     ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OFFSET   = 0x10,
0354     ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OUT_SUPPORTED = (1 << 0),
0355     ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED = (1 << 1),
0356     ATA_LOG_NCQ_SEND_RECV_SIZE      = 0x14,
0357 
0358     /* NCQ Non-Data log */
0359     ATA_LOG_NCQ_NON_DATA_SUBCMDS_OFFSET = 0x00,
0360     ATA_LOG_NCQ_NON_DATA_ABORT_OFFSET   = 0x00,
0361     ATA_LOG_NCQ_NON_DATA_ABORT_NCQ      = (1 << 0),
0362     ATA_LOG_NCQ_NON_DATA_ABORT_ALL      = (1 << 1),
0363     ATA_LOG_NCQ_NON_DATA_ABORT_STREAMING    = (1 << 2),
0364     ATA_LOG_NCQ_NON_DATA_ABORT_NON_STREAMING = (1 << 3),
0365     ATA_LOG_NCQ_NON_DATA_ABORT_SELECTED = (1 << 4),
0366     ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET    = 0x1C,
0367     ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT   = (1 << 0),
0368     ATA_LOG_NCQ_NON_DATA_SIZE       = 0x40,
0369 
0370     /* READ/WRITE LONG (obsolete) */
0371     ATA_CMD_READ_LONG   = 0x22,
0372     ATA_CMD_READ_LONG_ONCE  = 0x23,
0373     ATA_CMD_WRITE_LONG  = 0x32,
0374     ATA_CMD_WRITE_LONG_ONCE = 0x33,
0375 
0376     /* SETFEATURES stuff */
0377     SETFEATURES_XFER    = 0x03,
0378     XFER_UDMA_7     = 0x47,
0379     XFER_UDMA_6     = 0x46,
0380     XFER_UDMA_5     = 0x45,
0381     XFER_UDMA_4     = 0x44,
0382     XFER_UDMA_3     = 0x43,
0383     XFER_UDMA_2     = 0x42,
0384     XFER_UDMA_1     = 0x41,
0385     XFER_UDMA_0     = 0x40,
0386     XFER_MW_DMA_4       = 0x24, /* CFA only */
0387     XFER_MW_DMA_3       = 0x23, /* CFA only */
0388     XFER_MW_DMA_2       = 0x22,
0389     XFER_MW_DMA_1       = 0x21,
0390     XFER_MW_DMA_0       = 0x20,
0391     XFER_SW_DMA_2       = 0x12,
0392     XFER_SW_DMA_1       = 0x11,
0393     XFER_SW_DMA_0       = 0x10,
0394     XFER_PIO_6      = 0x0E, /* CFA only */
0395     XFER_PIO_5      = 0x0D, /* CFA only */
0396     XFER_PIO_4      = 0x0C,
0397     XFER_PIO_3      = 0x0B,
0398     XFER_PIO_2      = 0x0A,
0399     XFER_PIO_1      = 0x09,
0400     XFER_PIO_0      = 0x08,
0401     XFER_PIO_SLOW       = 0x00,
0402 
0403     SETFEATURES_WC_ON   = 0x02, /* Enable write cache */
0404     SETFEATURES_WC_OFF  = 0x82, /* Disable write cache */
0405 
0406     SETFEATURES_RA_ON   = 0xaa, /* Enable read look-ahead */
0407     SETFEATURES_RA_OFF  = 0x55, /* Disable read look-ahead */
0408 
0409     /* Enable/Disable Automatic Acoustic Management */
0410     SETFEATURES_AAM_ON  = 0x42,
0411     SETFEATURES_AAM_OFF = 0xC2,
0412 
0413     SETFEATURES_SPINUP      = 0x07, /* Spin-up drive */
0414     SETFEATURES_SPINUP_TIMEOUT  = 30000, /* 30s timeout for drive spin-up from PUIS */
0415 
0416     SETFEATURES_SATA_ENABLE = 0x10, /* Enable use of SATA feature */
0417     SETFEATURES_SATA_DISABLE = 0x90, /* Disable use of SATA feature */
0418 
0419     /* SETFEATURE Sector counts for SATA features */
0420     SATA_FPDMA_OFFSET   = 0x01, /* FPDMA non-zero buffer offsets */
0421     SATA_FPDMA_AA       = 0x02, /* FPDMA Setup FIS Auto-Activate */
0422     SATA_DIPM       = 0x03, /* Device Initiated Power Management */
0423     SATA_FPDMA_IN_ORDER = 0x04, /* FPDMA in-order data delivery */
0424     SATA_AN         = 0x05, /* Asynchronous Notification */
0425     SATA_SSP        = 0x06, /* Software Settings Preservation */
0426     SATA_DEVSLP     = 0x09, /* Device Sleep */
0427 
0428     SETFEATURE_SENSE_DATA   = 0xC3, /* Sense Data Reporting feature */
0429 
0430     /* feature values for SET_MAX */
0431     ATA_SET_MAX_ADDR    = 0x00,
0432     ATA_SET_MAX_PASSWD  = 0x01,
0433     ATA_SET_MAX_LOCK    = 0x02,
0434     ATA_SET_MAX_UNLOCK  = 0x03,
0435     ATA_SET_MAX_FREEZE_LOCK = 0x04,
0436     ATA_SET_MAX_PASSWD_DMA  = 0x05,
0437     ATA_SET_MAX_UNLOCK_DMA  = 0x06,
0438 
0439     /* feature values for DEVICE CONFIGURATION OVERLAY */
0440     ATA_DCO_RESTORE     = 0xC0,
0441     ATA_DCO_FREEZE_LOCK = 0xC1,
0442     ATA_DCO_IDENTIFY    = 0xC2,
0443     ATA_DCO_SET     = 0xC3,
0444 
0445     /* feature values for SMART */
0446     ATA_SMART_ENABLE    = 0xD8,
0447     ATA_SMART_READ_VALUES   = 0xD0,
0448     ATA_SMART_READ_THRESHOLDS = 0xD1,
0449 
0450     /* feature values for Data Set Management */
0451     ATA_DSM_TRIM        = 0x01,
0452 
0453     /* password used in LBA Mid / LBA High for executing SMART commands */
0454     ATA_SMART_LBAM_PASS = 0x4F,
0455     ATA_SMART_LBAH_PASS = 0xC2,
0456 
0457     /* ATAPI stuff */
0458     ATAPI_PKT_DMA       = (1 << 0),
0459     ATAPI_DMADIR        = (1 << 2), /* ATAPI data dir:
0460                            0=to device, 1=to host */
0461     ATAPI_CDB_LEN       = 16,
0462 
0463     /* PMP stuff */
0464     SATA_PMP_MAX_PORTS  = 15,
0465     SATA_PMP_CTRL_PORT  = 15,
0466 
0467     SATA_PMP_GSCR_DWORDS    = 128,
0468     SATA_PMP_GSCR_PROD_ID   = 0,
0469     SATA_PMP_GSCR_REV   = 1,
0470     SATA_PMP_GSCR_PORT_INFO = 2,
0471     SATA_PMP_GSCR_ERROR = 32,
0472     SATA_PMP_GSCR_ERROR_EN  = 33,
0473     SATA_PMP_GSCR_FEAT  = 64,
0474     SATA_PMP_GSCR_FEAT_EN   = 96,
0475 
0476     SATA_PMP_PSCR_STATUS    = 0,
0477     SATA_PMP_PSCR_ERROR = 1,
0478     SATA_PMP_PSCR_CONTROL   = 2,
0479 
0480     SATA_PMP_FEAT_BIST  = (1 << 0),
0481     SATA_PMP_FEAT_PMREQ = (1 << 1),
0482     SATA_PMP_FEAT_DYNSSC    = (1 << 2),
0483     SATA_PMP_FEAT_NOTIFY    = (1 << 3),
0484 
0485     /* cable types */
0486     ATA_CBL_NONE        = 0,
0487     ATA_CBL_PATA40      = 1,
0488     ATA_CBL_PATA80      = 2,
0489     ATA_CBL_PATA40_SHORT    = 3,    /* 40 wire cable to high UDMA spec */
0490     ATA_CBL_PATA_UNK    = 4,    /* don't know, maybe 80c? */
0491     ATA_CBL_PATA_IGN    = 5,    /* don't know, ignore cable handling */
0492     ATA_CBL_SATA        = 6,
0493 
0494     /* SATA Status and Control Registers */
0495     SCR_STATUS      = 0,
0496     SCR_ERROR       = 1,
0497     SCR_CONTROL     = 2,
0498     SCR_ACTIVE      = 3,
0499     SCR_NOTIFICATION    = 4,
0500 
0501     /* SError bits */
0502     SERR_DATA_RECOVERED = (1 << 0), /* recovered data error */
0503     SERR_COMM_RECOVERED = (1 << 1), /* recovered comm failure */
0504     SERR_DATA       = (1 << 8), /* unrecovered data error */
0505     SERR_PERSISTENT     = (1 << 9), /* persistent data/comm error */
0506     SERR_PROTOCOL       = (1 << 10), /* protocol violation */
0507     SERR_INTERNAL       = (1 << 11), /* host internal error */
0508     SERR_PHYRDY_CHG     = (1 << 16), /* PHY RDY changed */
0509     SERR_PHY_INT_ERR    = (1 << 17), /* PHY internal error */
0510     SERR_COMM_WAKE      = (1 << 18), /* Comm wake */
0511     SERR_10B_8B_ERR     = (1 << 19), /* 10b to 8b decode error */
0512     SERR_DISPARITY      = (1 << 20), /* Disparity */
0513     SERR_CRC        = (1 << 21), /* CRC error */
0514     SERR_HANDSHAKE      = (1 << 22), /* Handshake error */
0515     SERR_LINK_SEQ_ERR   = (1 << 23), /* Link sequence error */
0516     SERR_TRANS_ST_ERROR = (1 << 24), /* Transport state trans. error */
0517     SERR_UNRECOG_FIS    = (1 << 25), /* Unrecognized FIS */
0518     SERR_DEV_XCHG       = (1 << 26), /* device exchanged */
0519 };
0520 
0521 enum ata_prot_flags {
0522     /* protocol flags */
0523     ATA_PROT_FLAG_PIO   = (1 << 0), /* is PIO */
0524     ATA_PROT_FLAG_DMA   = (1 << 1), /* is DMA */
0525     ATA_PROT_FLAG_NCQ   = (1 << 2), /* is NCQ */
0526     ATA_PROT_FLAG_ATAPI = (1 << 3), /* is ATAPI */
0527 
0528     /* taskfile protocols */
0529     ATA_PROT_UNKNOWN    = (u8)-1,
0530     ATA_PROT_NODATA     = 0,
0531     ATA_PROT_PIO        = ATA_PROT_FLAG_PIO,
0532     ATA_PROT_DMA        = ATA_PROT_FLAG_DMA,
0533     ATA_PROT_NCQ_NODATA = ATA_PROT_FLAG_NCQ,
0534     ATA_PROT_NCQ        = ATA_PROT_FLAG_DMA | ATA_PROT_FLAG_NCQ,
0535     ATAPI_PROT_NODATA   = ATA_PROT_FLAG_ATAPI,
0536     ATAPI_PROT_PIO      = ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_PIO,
0537     ATAPI_PROT_DMA      = ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_DMA,
0538 };
0539 
0540 enum ata_ioctls {
0541     ATA_IOC_GET_IO32    = 0x309, /* HDIO_GET_32BIT */
0542     ATA_IOC_SET_IO32    = 0x324, /* HDIO_SET_32BIT */
0543 };
0544 
0545 /* core structures */
0546 
0547 struct ata_bmdma_prd {
0548     __le32          addr;
0549     __le32          flags_len;
0550 };
0551 
0552 /*
0553  * id tests
0554  */
0555 #define ata_id_is_ata(id)   (((id)[ATA_ID_CONFIG] & (1 << 15)) == 0)
0556 #define ata_id_has_lba(id)  ((id)[ATA_ID_CAPABILITY] & (1 << 9))
0557 #define ata_id_has_dma(id)  ((id)[ATA_ID_CAPABILITY] & (1 << 8))
0558 #define ata_id_has_ncq(id)  ((id)[ATA_ID_SATA_CAPABILITY] & (1 << 8))
0559 #define ata_id_queue_depth(id)  (((id)[ATA_ID_QUEUE_DEPTH] & 0x1f) + 1)
0560 #define ata_id_removable(id)    ((id)[ATA_ID_CONFIG] & (1 << 7))
0561 #define ata_id_has_atapi_AN(id) \
0562     ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
0563       ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
0564      ((id)[ATA_ID_FEATURE_SUPP] & (1 << 5)))
0565 #define ata_id_has_fpdma_aa(id) \
0566     ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
0567       ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
0568      ((id)[ATA_ID_FEATURE_SUPP] & (1 << 2)))
0569 #define ata_id_iordy_disable(id) ((id)[ATA_ID_CAPABILITY] & (1 << 10))
0570 #define ata_id_has_iordy(id) ((id)[ATA_ID_CAPABILITY] & (1 << 11))
0571 #define ata_id_u32(id,n)    \
0572     (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
0573 #define ata_id_u64(id,n)    \
0574     ( ((u64) (id)[(n) + 3] << 48) | \
0575       ((u64) (id)[(n) + 2] << 32) | \
0576       ((u64) (id)[(n) + 1] << 16) | \
0577       ((u64) (id)[(n) + 0]) )
0578 
0579 #define ata_id_cdb_intr(id) (((id)[ATA_ID_CONFIG] & 0x60) == 0x20)
0580 #define ata_id_has_da(id)   ((id)[ATA_ID_SATA_CAPABILITY_2] & (1 << 4))
0581 #define ata_id_has_devslp(id)   ((id)[ATA_ID_FEATURE_SUPP] & (1 << 8))
0582 #define ata_id_has_ncq_autosense(id) \
0583                 ((id)[ATA_ID_FEATURE_SUPP] & (1 << 7))
0584 
0585 static inline bool ata_id_has_hipm(const u16 *id)
0586 {
0587     u16 val = id[ATA_ID_SATA_CAPABILITY];
0588 
0589     if (val == 0 || val == 0xffff)
0590         return false;
0591 
0592     return val & (1 << 9);
0593 }
0594 
0595 static inline bool ata_id_has_dipm(const u16 *id)
0596 {
0597     u16 val = id[ATA_ID_FEATURE_SUPP];
0598 
0599     if (val == 0 || val == 0xffff)
0600         return false;
0601 
0602     return val & (1 << 3);
0603 }
0604 
0605 
0606 static inline bool ata_id_has_fua(const u16 *id)
0607 {
0608     if ((id[ATA_ID_CFSSE] & 0xC000) != 0x4000)
0609         return false;
0610     return id[ATA_ID_CFSSE] & (1 << 6);
0611 }
0612 
0613 static inline bool ata_id_has_flush(const u16 *id)
0614 {
0615     if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
0616         return false;
0617     return id[ATA_ID_COMMAND_SET_2] & (1 << 12);
0618 }
0619 
0620 static inline bool ata_id_flush_enabled(const u16 *id)
0621 {
0622     if (ata_id_has_flush(id) == 0)
0623         return false;
0624     if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
0625         return false;
0626     return id[ATA_ID_CFS_ENABLE_2] & (1 << 12);
0627 }
0628 
0629 static inline bool ata_id_has_flush_ext(const u16 *id)
0630 {
0631     if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
0632         return false;
0633     return id[ATA_ID_COMMAND_SET_2] & (1 << 13);
0634 }
0635 
0636 static inline bool ata_id_flush_ext_enabled(const u16 *id)
0637 {
0638     if (ata_id_has_flush_ext(id) == 0)
0639         return false;
0640     if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
0641         return false;
0642     /*
0643      * some Maxtor disks have bit 13 defined incorrectly
0644      * so check bit 10 too
0645      */
0646     return (id[ATA_ID_CFS_ENABLE_2] & 0x2400) == 0x2400;
0647 }
0648 
0649 static inline u32 ata_id_logical_sector_size(const u16 *id)
0650 {
0651     /* T13/1699-D Revision 6a, Sep 6, 2008. Page 128.
0652      * IDENTIFY DEVICE data, word 117-118.
0653      * 0xd000 ignores bit 13 (logical:physical > 1)
0654      */
0655     if ((id[ATA_ID_SECTOR_SIZE] & 0xd000) == 0x5000)
0656         return (((id[ATA_ID_LOGICAL_SECTOR_SIZE+1] << 16)
0657              + id[ATA_ID_LOGICAL_SECTOR_SIZE]) * sizeof(u16)) ;
0658     return ATA_SECT_SIZE;
0659 }
0660 
0661 static inline u8 ata_id_log2_per_physical_sector(const u16 *id)
0662 {
0663     /* T13/1699-D Revision 6a, Sep 6, 2008. Page 128.
0664      * IDENTIFY DEVICE data, word 106.
0665      * 0xe000 ignores bit 12 (logical sector > 512 bytes)
0666      */
0667     if ((id[ATA_ID_SECTOR_SIZE] & 0xe000) == 0x6000)
0668         return (id[ATA_ID_SECTOR_SIZE] & 0xf);
0669     return 0;
0670 }
0671 
0672 /* Offset of logical sectors relative to physical sectors.
0673  *
0674  * If device has more than one logical sector per physical sector
0675  * (aka 512 byte emulation), vendors might offset the "sector 0" address
0676  * so sector 63 is "naturally aligned" - e.g. FAT partition table.
0677  * This avoids Read/Mod/Write penalties when using FAT partition table
0678  * and updating "well aligned" (FS perspective) physical sectors on every
0679  * transaction.
0680  */
0681 static inline u16 ata_id_logical_sector_offset(const u16 *id,
0682      u8 log2_per_phys)
0683 {
0684     u16 word_209 = id[209];
0685 
0686     if ((log2_per_phys > 1) && (word_209 & 0xc000) == 0x4000) {
0687         u16 first = word_209 & 0x3fff;
0688         if (first > 0)
0689             return (1 << log2_per_phys) - first;
0690     }
0691     return 0;
0692 }
0693 
0694 static inline bool ata_id_has_lba48(const u16 *id)
0695 {
0696     if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
0697         return false;
0698     if (!ata_id_u64(id, ATA_ID_LBA_CAPACITY_2))
0699         return false;
0700     return id[ATA_ID_COMMAND_SET_2] & (1 << 10);
0701 }
0702 
0703 static inline bool ata_id_lba48_enabled(const u16 *id)
0704 {
0705     if (ata_id_has_lba48(id) == 0)
0706         return false;
0707     if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
0708         return false;
0709     return id[ATA_ID_CFS_ENABLE_2] & (1 << 10);
0710 }
0711 
0712 static inline bool ata_id_hpa_enabled(const u16 *id)
0713 {
0714     /* Yes children, word 83 valid bits cover word 82 data */
0715     if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
0716         return false;
0717     /* And 87 covers 85-87 */
0718     if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
0719         return false;
0720     /* Check command sets enabled as well as supported */
0721     if ((id[ATA_ID_CFS_ENABLE_1] & (1 << 10)) == 0)
0722         return false;
0723     return id[ATA_ID_COMMAND_SET_1] & (1 << 10);
0724 }
0725 
0726 static inline bool ata_id_has_wcache(const u16 *id)
0727 {
0728     /* Yes children, word 83 valid bits cover word 82 data */
0729     if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
0730         return false;
0731     return id[ATA_ID_COMMAND_SET_1] & (1 << 5);
0732 }
0733 
0734 static inline bool ata_id_has_pm(const u16 *id)
0735 {
0736     if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
0737         return false;
0738     return id[ATA_ID_COMMAND_SET_1] & (1 << 3);
0739 }
0740 
0741 static inline bool ata_id_rahead_enabled(const u16 *id)
0742 {
0743     if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
0744         return false;
0745     return id[ATA_ID_CFS_ENABLE_1] & (1 << 6);
0746 }
0747 
0748 static inline bool ata_id_wcache_enabled(const u16 *id)
0749 {
0750     if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
0751         return false;
0752     return id[ATA_ID_CFS_ENABLE_1] & (1 << 5);
0753 }
0754 
0755 static inline bool ata_id_has_read_log_dma_ext(const u16 *id)
0756 {
0757     /* Word 86 must have bit 15 set */
0758     if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
0759         return false;
0760 
0761     /* READ LOG DMA EXT support can be signaled either from word 119
0762      * or from word 120. The format is the same for both words: Bit
0763      * 15 must be cleared, bit 14 set and bit 3 set.
0764      */
0765     if ((id[ATA_ID_COMMAND_SET_3] & 0xC008) == 0x4008 ||
0766         (id[ATA_ID_COMMAND_SET_4] & 0xC008) == 0x4008)
0767         return true;
0768 
0769     return false;
0770 }
0771 
0772 static inline bool ata_id_has_sense_reporting(const u16 *id)
0773 {
0774     if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
0775         return false;
0776     return id[ATA_ID_COMMAND_SET_3] & (1 << 6);
0777 }
0778 
0779 static inline bool ata_id_sense_reporting_enabled(const u16 *id)
0780 {
0781     if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
0782         return false;
0783     return id[ATA_ID_COMMAND_SET_4] & (1 << 6);
0784 }
0785 
0786 /**
0787  *
0788  * Word: 206 - SCT Command Transport
0789  *    15:12 - Vendor Specific
0790  *     11:6 - Reserved
0791  *        5 - SCT Command Transport Data Tables supported
0792  *        4 - SCT Command Transport Features Control supported
0793  *        3 - SCT Command Transport Error Recovery Control supported
0794  *        2 - SCT Command Transport Write Same supported
0795  *        1 - SCT Command Transport Long Sector Access supported
0796  *        0 - SCT Command Transport supported
0797  */
0798 static inline bool ata_id_sct_data_tables(const u16 *id)
0799 {
0800     return id[ATA_ID_SCT_CMD_XPORT] & (1 << 5) ? true : false;
0801 }
0802 
0803 static inline bool ata_id_sct_features_ctrl(const u16 *id)
0804 {
0805     return id[ATA_ID_SCT_CMD_XPORT] & (1 << 4) ? true : false;
0806 }
0807 
0808 static inline bool ata_id_sct_error_recovery_ctrl(const u16 *id)
0809 {
0810     return id[ATA_ID_SCT_CMD_XPORT] & (1 << 3) ? true : false;
0811 }
0812 
0813 static inline bool ata_id_sct_long_sector_access(const u16 *id)
0814 {
0815     return id[ATA_ID_SCT_CMD_XPORT] & (1 << 1) ? true : false;
0816 }
0817 
0818 static inline bool ata_id_sct_supported(const u16 *id)
0819 {
0820     return id[ATA_ID_SCT_CMD_XPORT] & (1 << 0) ? true : false;
0821 }
0822 
0823 /**
0824  *  ata_id_major_version    -   get ATA level of drive
0825  *  @id: Identify data
0826  *
0827  *  Caveats:
0828  *      ATA-1 considers identify optional
0829  *      ATA-2 introduces mandatory identify
0830  *      ATA-3 introduces word 80 and accurate reporting
0831  *
0832  *  The practical impact of this is that ata_id_major_version cannot
0833  *  reliably report on drives below ATA3.
0834  */
0835 
0836 static inline unsigned int ata_id_major_version(const u16 *id)
0837 {
0838     unsigned int mver;
0839 
0840     if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
0841         return 0;
0842 
0843     for (mver = 14; mver >= 1; mver--)
0844         if (id[ATA_ID_MAJOR_VER] & (1 << mver))
0845             break;
0846     return mver;
0847 }
0848 
0849 static inline bool ata_id_is_sata(const u16 *id)
0850 {
0851     /*
0852      * See if word 93 is 0 AND drive is at least ATA-5 compatible
0853      * verifying that word 80 by casting it to a signed type --
0854      * this trick allows us to filter out the reserved values of
0855      * 0x0000 and 0xffff along with the earlier ATA revisions...
0856      */
0857     if (id[ATA_ID_HW_CONFIG] == 0 && (short)id[ATA_ID_MAJOR_VER] >= 0x0020)
0858         return true;
0859     return false;
0860 }
0861 
0862 static inline bool ata_id_has_tpm(const u16 *id)
0863 {
0864     /* The TPM bits are only valid on ATA8 */
0865     if (ata_id_major_version(id) < 8)
0866         return false;
0867     if ((id[48] & 0xC000) != 0x4000)
0868         return false;
0869     return id[48] & (1 << 0);
0870 }
0871 
0872 static inline bool ata_id_has_dword_io(const u16 *id)
0873 {
0874     /* ATA 8 reuses this flag for "trusted" computing */
0875     if (ata_id_major_version(id) > 7)
0876         return false;
0877     return id[ATA_ID_DWORD_IO] & (1 << 0);
0878 }
0879 
0880 static inline bool ata_id_has_trusted(const u16 *id)
0881 {
0882     if (ata_id_major_version(id) <= 7)
0883         return false;
0884     return id[ATA_ID_TRUSTED] & (1 << 0);
0885 }
0886 
0887 static inline bool ata_id_has_unload(const u16 *id)
0888 {
0889     if (ata_id_major_version(id) >= 7 &&
0890         (id[ATA_ID_CFSSE] & 0xC000) == 0x4000 &&
0891         id[ATA_ID_CFSSE] & (1 << 13))
0892         return true;
0893     return false;
0894 }
0895 
0896 static inline bool ata_id_has_wwn(const u16 *id)
0897 {
0898     return (id[ATA_ID_CSF_DEFAULT] & 0xC100) == 0x4100;
0899 }
0900 
0901 static inline int ata_id_form_factor(const u16 *id)
0902 {
0903     u16 val = id[168];
0904 
0905     if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
0906         return 0;
0907 
0908     val &= 0xf;
0909 
0910     if (val > 5)
0911         return 0;
0912 
0913     return val;
0914 }
0915 
0916 static inline int ata_id_rotation_rate(const u16 *id)
0917 {
0918     u16 val = id[217];
0919 
0920     if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
0921         return 0;
0922 
0923     if (val > 1 && val < 0x401)
0924         return 0;
0925 
0926     return val;
0927 }
0928 
0929 static inline bool ata_id_has_ncq_send_and_recv(const u16 *id)
0930 {
0931     return id[ATA_ID_SATA_CAPABILITY_2] & BIT(6);
0932 }
0933 
0934 static inline bool ata_id_has_ncq_non_data(const u16 *id)
0935 {
0936     return id[ATA_ID_SATA_CAPABILITY_2] & BIT(5);
0937 }
0938 
0939 static inline bool ata_id_has_ncq_prio(const u16 *id)
0940 {
0941     return id[ATA_ID_SATA_CAPABILITY] & BIT(12);
0942 }
0943 
0944 static inline bool ata_id_has_trim(const u16 *id)
0945 {
0946     if (ata_id_major_version(id) >= 7 &&
0947         (id[ATA_ID_DATA_SET_MGMT] & 1))
0948         return true;
0949     return false;
0950 }
0951 
0952 static inline bool ata_id_has_zero_after_trim(const u16 *id)
0953 {
0954     /* DSM supported, deterministic read, and read zero after trim set */
0955     if (ata_id_has_trim(id) &&
0956         (id[ATA_ID_ADDITIONAL_SUPP] & 0x4020) == 0x4020)
0957         return true;
0958 
0959     return false;
0960 }
0961 
0962 static inline bool ata_id_current_chs_valid(const u16 *id)
0963 {
0964     /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
0965        has not been issued to the device then the values of
0966        id[ATA_ID_CUR_CYLS] to id[ATA_ID_CUR_SECTORS] are vendor specific. */
0967     return (id[ATA_ID_FIELD_VALID] & 1) && /* Current translation valid */
0968         id[ATA_ID_CUR_CYLS] &&  /* cylinders in current translation */
0969         id[ATA_ID_CUR_HEADS] &&  /* heads in current translation */
0970         id[ATA_ID_CUR_HEADS] <= 16 &&
0971         id[ATA_ID_CUR_SECTORS];    /* sectors in current translation */
0972 }
0973 
0974 static inline bool ata_id_is_cfa(const u16 *id)
0975 {
0976     if ((id[ATA_ID_CONFIG] == 0x848A) ||    /* Traditional CF */
0977         (id[ATA_ID_CONFIG] == 0x844A))  /* Delkin Devices CF */
0978         return true;
0979     /*
0980      * CF specs don't require specific value in the word 0 anymore and yet
0981      * they forbid to report the ATA version in the word 80 and require the
0982      * CFA feature set support to be indicated in the word 83 in this case.
0983      * Unfortunately, some cards only follow either of this requirements,
0984      * and while those that don't indicate CFA feature support need some
0985      * sort of quirk list, it seems impractical for the ones that do...
0986      */
0987     return (id[ATA_ID_COMMAND_SET_2] & 0xC004) == 0x4004;
0988 }
0989 
0990 static inline bool ata_id_is_ssd(const u16 *id)
0991 {
0992     return id[ATA_ID_ROT_SPEED] == 0x01;
0993 }
0994 
0995 static inline u8 ata_id_zoned_cap(const u16 *id)
0996 {
0997     return (id[ATA_ID_ADDITIONAL_SUPP] & 0x3);
0998 }
0999 
1000 static inline bool ata_id_pio_need_iordy(const u16 *id, const u8 pio)
1001 {
1002     /* CF spec. r4.1 Table 22 says no IORDY on PIO5 and PIO6. */
1003     if (pio > 4 && ata_id_is_cfa(id))
1004         return false;
1005     /* For PIO3 and higher it is mandatory. */
1006     if (pio > 2)
1007         return true;
1008     /* Turn it on when possible. */
1009     return ata_id_has_iordy(id);
1010 }
1011 
1012 static inline bool ata_drive_40wire(const u16 *dev_id)
1013 {
1014     if (ata_id_is_sata(dev_id))
1015         return false;   /* SATA */
1016     if ((dev_id[ATA_ID_HW_CONFIG] & 0xE000) == 0x6000)
1017         return false;   /* 80 wire */
1018     return true;
1019 }
1020 
1021 static inline bool ata_drive_40wire_relaxed(const u16 *dev_id)
1022 {
1023     if ((dev_id[ATA_ID_HW_CONFIG] & 0x2000) == 0x2000)
1024         return false;   /* 80 wire */
1025     return true;
1026 }
1027 
1028 static inline int atapi_cdb_len(const u16 *dev_id)
1029 {
1030     u16 tmp = dev_id[ATA_ID_CONFIG] & 0x3;
1031     switch (tmp) {
1032     case 0:     return 12;
1033     case 1:     return 16;
1034     default:    return -1;
1035     }
1036 }
1037 
1038 static inline int atapi_command_packet_set(const u16 *dev_id)
1039 {
1040     return (dev_id[ATA_ID_CONFIG] >> 8) & 0x1f;
1041 }
1042 
1043 static inline bool atapi_id_dmadir(const u16 *dev_id)
1044 {
1045     return ata_id_major_version(dev_id) >= 7 && (dev_id[62] & 0x8000);
1046 }
1047 
1048 /*
1049  * ata_id_is_lba_capacity_ok() performs a sanity check on
1050  * the claimed LBA capacity value for the device.
1051  *
1052  * Returns 1 if LBA capacity looks sensible, 0 otherwise.
1053  *
1054  * It is called only once for each device.
1055  */
1056 static inline bool ata_id_is_lba_capacity_ok(u16 *id)
1057 {
1058     unsigned long lba_sects, chs_sects, head, tail;
1059 
1060     /* No non-LBA info .. so valid! */
1061     if (id[ATA_ID_CYLS] == 0)
1062         return true;
1063 
1064     lba_sects = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
1065 
1066     /*
1067      * The ATA spec tells large drives to return
1068      * C/H/S = 16383/16/63 independent of their size.
1069      * Some drives can be jumpered to use 15 heads instead of 16.
1070      * Some drives can be jumpered to use 4092 cyls instead of 16383.
1071      */
1072     if ((id[ATA_ID_CYLS] == 16383 ||
1073          (id[ATA_ID_CYLS] == 4092 && id[ATA_ID_CUR_CYLS] == 16383)) &&
1074         id[ATA_ID_SECTORS] == 63 &&
1075         (id[ATA_ID_HEADS] == 15 || id[ATA_ID_HEADS] == 16) &&
1076         (lba_sects >= 16383 * 63 * id[ATA_ID_HEADS]))
1077         return true;
1078 
1079     chs_sects = id[ATA_ID_CYLS] * id[ATA_ID_HEADS] * id[ATA_ID_SECTORS];
1080 
1081     /* perform a rough sanity check on lba_sects: within 10% is OK */
1082     if (lba_sects - chs_sects < chs_sects/10)
1083         return true;
1084 
1085     /* some drives have the word order reversed */
1086     head = (lba_sects >> 16) & 0xffff;
1087     tail = lba_sects & 0xffff;
1088     lba_sects = head | (tail << 16);
1089 
1090     if (lba_sects - chs_sects < chs_sects/10) {
1091         *(__le32 *)&id[ATA_ID_LBA_CAPACITY] = __cpu_to_le32(lba_sects);
1092         return true;    /* LBA capacity is (now) good */
1093     }
1094 
1095     return false;   /* LBA capacity value may be bad */
1096 }
1097 
1098 static inline void ata_id_to_hd_driveid(u16 *id)
1099 {
1100 #ifdef __BIG_ENDIAN
1101     /* accessed in struct hd_driveid as 8-bit values */
1102     id[ATA_ID_MAX_MULTSECT]  = __cpu_to_le16(id[ATA_ID_MAX_MULTSECT]);
1103     id[ATA_ID_CAPABILITY]    = __cpu_to_le16(id[ATA_ID_CAPABILITY]);
1104     id[ATA_ID_OLD_PIO_MODES] = __cpu_to_le16(id[ATA_ID_OLD_PIO_MODES]);
1105     id[ATA_ID_OLD_DMA_MODES] = __cpu_to_le16(id[ATA_ID_OLD_DMA_MODES]);
1106     id[ATA_ID_MULTSECT]  = __cpu_to_le16(id[ATA_ID_MULTSECT]);
1107 
1108     /* as 32-bit values */
1109     *(u32 *)&id[ATA_ID_LBA_CAPACITY] = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
1110     *(u32 *)&id[ATA_ID_SPG]      = ata_id_u32(id, ATA_ID_SPG);
1111 
1112     /* as 64-bit value */
1113     *(u64 *)&id[ATA_ID_LBA_CAPACITY_2] =
1114         ata_id_u64(id, ATA_ID_LBA_CAPACITY_2);
1115 #endif
1116 }
1117 
1118 static inline bool ata_ok(u8 status)
1119 {
1120     return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
1121             == ATA_DRDY);
1122 }
1123 
1124 static inline bool lba_28_ok(u64 block, u32 n_block)
1125 {
1126     /* check the ending block number: must be LESS THAN 0x0fffffff */
1127     return ((block + n_block) < ((1 << 28) - 1)) && (n_block <= ATA_MAX_SECTORS);
1128 }
1129 
1130 static inline bool lba_48_ok(u64 block, u32 n_block)
1131 {
1132     /* check the ending block number */
1133     return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= ATA_MAX_SECTORS_LBA48);
1134 }
1135 
1136 #define sata_pmp_gscr_vendor(gscr)  ((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
1137 #define sata_pmp_gscr_devid(gscr)   ((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
1138 #define sata_pmp_gscr_rev(gscr)     (((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
1139 #define sata_pmp_gscr_ports(gscr)   ((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)
1140 
1141 #endif /* __LINUX_ATA_H__ */
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.1.0 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!