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