Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | |
| 2 | /* |
Jeff Garzik | af36d7f | 2005-08-28 20:18:39 -0400 | [diff] [blame] | 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 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 27 | */ |
| 28 | |
| 29 | #ifndef __LINUX_ATA_H__ |
| 30 | #define __LINUX_ATA_H__ |
| 31 | |
| 32 | #include <linux/types.h> |
| 33 | |
| 34 | /* defines only for the constants which don't work well as enums */ |
| 35 | #define ATA_DMA_BOUNDARY 0xffffUL |
| 36 | #define ATA_DMA_MASK 0xffffffffULL |
| 37 | |
| 38 | enum { |
| 39 | /* various global constants */ |
| 40 | ATA_MAX_DEVICES = 2, /* per bus/port */ |
| 41 | ATA_MAX_PRD = 256, /* we could make these 256/256 */ |
| 42 | ATA_SECT_SIZE = 512, |
Albert Lee | 18d6e9d | 2007-04-02 11:34:15 +0800 | [diff] [blame] | 43 | ATA_MAX_SECTORS_128 = 128, |
Jeff Garzik | 8b881b0 | 2006-06-11 09:59:27 -0400 | [diff] [blame] | 44 | ATA_MAX_SECTORS = 256, |
| 45 | ATA_MAX_SECTORS_LBA48 = 65535,/* TODO: 65536? */ |
Tony Battersby | f8d8e57 | 2007-10-30 11:44:35 -0400 | [diff] [blame] | 46 | ATA_MAX_SECTORS_TAPE = 65535, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 47 | |
| 48 | ATA_ID_WORDS = 256, |
Tejun Heo | a0cf733 | 2007-01-02 20:18:49 +0900 | [diff] [blame] | 49 | ATA_ID_SERNO = 10, |
| 50 | ATA_ID_FW_REV = 23, |
| 51 | ATA_ID_PROD = 27, |
Alan Cox | 11e29e2 | 2005-10-21 18:46:32 -0400 | [diff] [blame] | 52 | ATA_ID_OLD_PIO_MODES = 51, |
| 53 | ATA_ID_FIELD_VALID = 53, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 54 | ATA_ID_MWDMA_MODES = 63, |
Alan Cox | 11e29e2 | 2005-10-21 18:46:32 -0400 | [diff] [blame] | 55 | ATA_ID_PIO_MODES = 64, |
| 56 | ATA_ID_EIDE_DMA_MIN = 65, |
| 57 | ATA_ID_EIDE_PIO = 67, |
| 58 | ATA_ID_EIDE_PIO_IORDY = 68, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 59 | ATA_ID_UDMA_MODES = 88, |
Alan Cox | 11e29e2 | 2005-10-21 18:46:32 -0400 | [diff] [blame] | 60 | ATA_ID_MAJOR_VER = 80, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 61 | ATA_ID_PIO4 = (1 << 1), |
| 62 | |
Tejun Heo | a0cf733 | 2007-01-02 20:18:49 +0900 | [diff] [blame] | 63 | ATA_ID_SERNO_LEN = 20, |
| 64 | ATA_ID_FW_REV_LEN = 8, |
| 65 | ATA_ID_PROD_LEN = 40, |
| 66 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 67 | ATA_PCI_CTL_OFS = 2, |
Bartlomiej Zolnierkiewicz | 4099d14 | 2007-07-20 01:11:59 +0200 | [diff] [blame] | 68 | |
| 69 | ATA_PIO0 = (1 << 0), |
| 70 | ATA_PIO1 = ATA_PIO0 | (1 << 1), |
| 71 | ATA_PIO2 = ATA_PIO1 | (1 << 2), |
| 72 | ATA_PIO3 = ATA_PIO2 | (1 << 3), |
| 73 | ATA_PIO4 = ATA_PIO3 | (1 << 4), |
| 74 | ATA_PIO5 = ATA_PIO4 | (1 << 5), |
| 75 | ATA_PIO6 = ATA_PIO5 | (1 << 6), |
| 76 | |
Bartlomiej Zolnierkiewicz | 91a6d4e | 2007-08-27 19:35:22 +0200 | [diff] [blame] | 77 | ATA_SWDMA0 = (1 << 0), |
| 78 | ATA_SWDMA1 = ATA_SWDMA0 | (1 << 1), |
| 79 | ATA_SWDMA2 = ATA_SWDMA1 | (1 << 2), |
| 80 | |
| 81 | ATA_SWDMA2_ONLY = (1 << 2), |
| 82 | |
| 83 | ATA_MWDMA0 = (1 << 0), |
| 84 | ATA_MWDMA1 = ATA_MWDMA0 | (1 << 1), |
| 85 | ATA_MWDMA2 = ATA_MWDMA1 | (1 << 2), |
| 86 | |
| 87 | ATA_MWDMA12_ONLY = (1 << 1) | (1 << 2), |
| 88 | ATA_MWDMA2_ONLY = (1 << 2), |
| 89 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 90 | ATA_UDMA0 = (1 << 0), |
| 91 | ATA_UDMA1 = ATA_UDMA0 | (1 << 1), |
| 92 | ATA_UDMA2 = ATA_UDMA1 | (1 << 2), |
| 93 | ATA_UDMA3 = ATA_UDMA2 | (1 << 3), |
| 94 | ATA_UDMA4 = ATA_UDMA3 | (1 << 4), |
| 95 | ATA_UDMA5 = ATA_UDMA4 | (1 << 5), |
| 96 | ATA_UDMA6 = ATA_UDMA5 | (1 << 6), |
| 97 | ATA_UDMA7 = ATA_UDMA6 | (1 << 7), |
| 98 | /* ATA_UDMA7 is just for completeness... doesn't exist (yet?). */ |
| 99 | |
| 100 | ATA_UDMA_MASK_40C = ATA_UDMA2, /* udma0-2 */ |
| 101 | |
| 102 | /* DMA-related */ |
| 103 | ATA_PRD_SZ = 8, |
| 104 | ATA_PRD_TBL_SZ = (ATA_MAX_PRD * ATA_PRD_SZ), |
| 105 | ATA_PRD_EOT = (1 << 31), /* end-of-table flag */ |
| 106 | |
| 107 | ATA_DMA_TABLE_OFS = 4, |
| 108 | ATA_DMA_STATUS = 2, |
| 109 | ATA_DMA_CMD = 0, |
| 110 | ATA_DMA_WR = (1 << 3), |
| 111 | ATA_DMA_START = (1 << 0), |
| 112 | ATA_DMA_INTR = (1 << 2), |
| 113 | ATA_DMA_ERR = (1 << 1), |
| 114 | ATA_DMA_ACTIVE = (1 << 0), |
| 115 | |
| 116 | /* bits in ATA command block registers */ |
| 117 | ATA_HOB = (1 << 7), /* LBA48 selector */ |
| 118 | ATA_NIEN = (1 << 1), /* disable-irq flag */ |
| 119 | ATA_LBA = (1 << 6), /* LBA28 selector */ |
| 120 | ATA_DEV1 = (1 << 4), /* Select Device 1 (slave) */ |
| 121 | ATA_DEVICE_OBS = (1 << 7) | (1 << 5), /* obs bits in dev reg */ |
| 122 | ATA_DEVCTL_OBS = (1 << 3), /* obsolete bit in devctl reg */ |
| 123 | ATA_BUSY = (1 << 7), /* BSY status bit */ |
| 124 | ATA_DRDY = (1 << 6), /* device ready */ |
| 125 | ATA_DF = (1 << 5), /* device fault */ |
| 126 | ATA_DRQ = (1 << 3), /* data request i/o */ |
| 127 | ATA_ERR = (1 << 0), /* have an error */ |
| 128 | ATA_SRST = (1 << 2), /* software reset */ |
Tejun Heo | 9be1e97 | 2006-05-15 20:58:17 +0900 | [diff] [blame] | 129 | ATA_ICRC = (1 << 7), /* interface CRC error */ |
| 130 | ATA_UNC = (1 << 6), /* uncorrectable media error */ |
| 131 | ATA_IDNF = (1 << 4), /* ID not found */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 132 | ATA_ABORTED = (1 << 2), /* command aborted */ |
| 133 | |
| 134 | /* ATA command block registers */ |
| 135 | ATA_REG_DATA = 0x00, |
| 136 | ATA_REG_ERR = 0x01, |
| 137 | ATA_REG_NSECT = 0x02, |
| 138 | ATA_REG_LBAL = 0x03, |
| 139 | ATA_REG_LBAM = 0x04, |
| 140 | ATA_REG_LBAH = 0x05, |
| 141 | ATA_REG_DEVICE = 0x06, |
| 142 | ATA_REG_STATUS = 0x07, |
| 143 | |
| 144 | ATA_REG_FEATURE = ATA_REG_ERR, /* and their aliases */ |
| 145 | ATA_REG_CMD = ATA_REG_STATUS, |
| 146 | ATA_REG_BYTEL = ATA_REG_LBAM, |
| 147 | ATA_REG_BYTEH = ATA_REG_LBAH, |
| 148 | ATA_REG_DEVSEL = ATA_REG_DEVICE, |
| 149 | ATA_REG_IRQ = ATA_REG_NSECT, |
| 150 | |
| 151 | /* ATA device commands */ |
Jeff Garzik | ab2181c | 2007-05-28 08:30:36 -0400 | [diff] [blame] | 152 | ATA_CMD_DEV_RESET = 0x08, /* ATAPI device reset */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 153 | ATA_CMD_CHK_POWER = 0xE5, /* check power mode */ |
Douglas Gilbert | 972dcaf | 2005-08-11 03:35:53 -0400 | [diff] [blame] | 154 | ATA_CMD_STANDBY = 0xE2, /* place in standby power mode */ |
| 155 | ATA_CMD_IDLE = 0xE3, /* place in idle power mode */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 156 | ATA_CMD_EDD = 0x90, /* execute device diagnostic */ |
| 157 | ATA_CMD_FLUSH = 0xE7, |
| 158 | ATA_CMD_FLUSH_EXT = 0xEA, |
| 159 | ATA_CMD_ID_ATA = 0xEC, |
| 160 | ATA_CMD_ID_ATAPI = 0xA1, |
| 161 | ATA_CMD_READ = 0xC8, |
| 162 | ATA_CMD_READ_EXT = 0x25, |
| 163 | ATA_CMD_WRITE = 0xCA, |
| 164 | ATA_CMD_WRITE_EXT = 0x35, |
Tejun Heo | 9a3dccc | 2006-01-06 09:56:18 +0100 | [diff] [blame] | 165 | ATA_CMD_WRITE_FUA_EXT = 0x3D, |
Tejun Heo | 88e4903 | 2006-05-15 21:03:38 +0900 | [diff] [blame] | 166 | ATA_CMD_FPDMA_READ = 0x60, |
| 167 | ATA_CMD_FPDMA_WRITE = 0x61, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 168 | ATA_CMD_PIO_READ = 0x20, |
| 169 | ATA_CMD_PIO_READ_EXT = 0x24, |
| 170 | ATA_CMD_PIO_WRITE = 0x30, |
| 171 | ATA_CMD_PIO_WRITE_EXT = 0x34, |
Albert Lee | 8cbd6df | 2005-10-12 15:06:27 +0800 | [diff] [blame] | 172 | ATA_CMD_READ_MULTI = 0xC4, |
| 173 | ATA_CMD_READ_MULTI_EXT = 0x29, |
| 174 | ATA_CMD_WRITE_MULTI = 0xC5, |
| 175 | ATA_CMD_WRITE_MULTI_EXT = 0x39, |
Tejun Heo | 9a3dccc | 2006-01-06 09:56:18 +0100 | [diff] [blame] | 176 | ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 177 | ATA_CMD_SET_FEATURES = 0xEF, |
Albert Lee | 2c3d2a4 | 2007-06-07 16:01:17 +0800 | [diff] [blame] | 178 | ATA_CMD_SET_MULTI = 0xC6, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 179 | ATA_CMD_PACKET = 0xA0, |
| 180 | ATA_CMD_VERIFY = 0x40, |
| 181 | ATA_CMD_VERIFY_EXT = 0x42, |
Jeff Garzik | 2dcb407 | 2007-10-19 06:42:56 -0400 | [diff] [blame] | 182 | ATA_CMD_STANDBYNOW1 = 0xE0, |
| 183 | ATA_CMD_IDLEIMMEDIATE = 0xE1, |
Tejun Heo | 054a5fb | 2007-10-25 18:30:36 +0900 | [diff] [blame] | 184 | ATA_CMD_SLEEP = 0xE6, |
Albert Lee | 8bf62ece | 2005-05-12 15:29:42 -0400 | [diff] [blame] | 185 | ATA_CMD_INIT_DEV_PARAMS = 0x91, |
Alan Cox | b678272 | 2006-03-21 15:52:49 +0000 | [diff] [blame] | 186 | ATA_CMD_READ_NATIVE_MAX = 0xF8, |
| 187 | ATA_CMD_READ_NATIVE_MAX_EXT = 0x27, |
Alan Cox | 1e99973 | 2007-04-11 00:23:13 +0100 | [diff] [blame] | 188 | ATA_CMD_SET_MAX = 0xF9, |
| 189 | ATA_CMD_SET_MAX_EXT = 0x37, |
Tejun Heo | 88e4903 | 2006-05-15 21:03:38 +0900 | [diff] [blame] | 190 | ATA_CMD_READ_LOG_EXT = 0x2f, |
Tejun Heo | 814600e | 2007-07-01 19:05:58 +0900 | [diff] [blame] | 191 | ATA_CMD_PMP_READ = 0xE4, |
| 192 | ATA_CMD_PMP_WRITE = 0xE8, |
Tejun Heo | 88e4903 | 2006-05-15 21:03:38 +0900 | [diff] [blame] | 193 | |
| 194 | /* READ_LOG_EXT pages */ |
| 195 | ATA_LOG_SATA_NCQ = 0x10, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 196 | |
Mark Lord | 5a5dbd1 | 2007-03-16 10:22:26 -0400 | [diff] [blame] | 197 | /* READ/WRITE LONG (obsolete) */ |
| 198 | ATA_CMD_READ_LONG = 0x22, |
| 199 | ATA_CMD_READ_LONG_ONCE = 0x23, |
| 200 | ATA_CMD_WRITE_LONG = 0x32, |
| 201 | ATA_CMD_WRITE_LONG_ONCE = 0x33, |
| 202 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 203 | /* SETFEATURES stuff */ |
| 204 | SETFEATURES_XFER = 0x03, |
| 205 | XFER_UDMA_7 = 0x47, |
| 206 | XFER_UDMA_6 = 0x46, |
| 207 | XFER_UDMA_5 = 0x45, |
| 208 | XFER_UDMA_4 = 0x44, |
| 209 | XFER_UDMA_3 = 0x43, |
| 210 | XFER_UDMA_2 = 0x42, |
| 211 | XFER_UDMA_1 = 0x41, |
| 212 | XFER_UDMA_0 = 0x40, |
Alan Cox | b352e57 | 2006-08-10 18:52:12 +0100 | [diff] [blame] | 213 | XFER_MW_DMA_4 = 0x24, /* CFA only */ |
| 214 | XFER_MW_DMA_3 = 0x23, /* CFA only */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 215 | XFER_MW_DMA_2 = 0x22, |
| 216 | XFER_MW_DMA_1 = 0x21, |
| 217 | XFER_MW_DMA_0 = 0x20, |
Alan Cox | b4b52db | 2005-09-26 12:48:41 +0100 | [diff] [blame] | 218 | XFER_SW_DMA_2 = 0x12, |
| 219 | XFER_SW_DMA_1 = 0x11, |
| 220 | XFER_SW_DMA_0 = 0x10, |
Alan Cox | b352e57 | 2006-08-10 18:52:12 +0100 | [diff] [blame] | 221 | XFER_PIO_6 = 0x0E, /* CFA only */ |
| 222 | XFER_PIO_5 = 0x0D, /* CFA only */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 223 | XFER_PIO_4 = 0x0C, |
| 224 | XFER_PIO_3 = 0x0B, |
| 225 | XFER_PIO_2 = 0x0A, |
| 226 | XFER_PIO_1 = 0x09, |
| 227 | XFER_PIO_0 = 0x08, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 228 | XFER_PIO_SLOW = 0x00, |
| 229 | |
zhao, forrest | 3057ac3 | 2006-06-12 12:01:34 +0800 | [diff] [blame] | 230 | SETFEATURES_WC_ON = 0x02, /* Enable write cache */ |
| 231 | SETFEATURES_WC_OFF = 0x82, /* Disable write cache */ |
| 232 | |
Mark Lord | 169439c | 2007-04-17 18:26:07 -0400 | [diff] [blame] | 233 | SETFEATURES_SPINUP = 0x07, /* Spin-up drive */ |
| 234 | |
Kristen Carlson Accardi | 9f45cbd | 2007-08-15 03:57:11 -0400 | [diff] [blame] | 235 | SETFEATURES_SATA_ENABLE = 0x10, /* Enable use of SATA feature */ |
| 236 | SETFEATURES_SATA_DISABLE = 0x90, /* Disable use of SATA feature */ |
| 237 | |
| 238 | /* SETFEATURE Sector counts for SATA features */ |
| 239 | SATA_AN = 0x05, /* Asynchronous Notification */ |
Kristen Carlson Accardi | ca77329 | 2007-10-25 00:58:59 -0400 | [diff] [blame] | 240 | SATA_DIPM = 0x03, /* Device Initiated Power Management */ |
Kristen Carlson Accardi | 9f45cbd | 2007-08-15 03:57:11 -0400 | [diff] [blame] | 241 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 242 | /* ATAPI stuff */ |
| 243 | ATAPI_PKT_DMA = (1 << 0), |
| 244 | ATAPI_DMADIR = (1 << 2), /* ATAPI data dir: |
| 245 | 0=to device, 1=to host */ |
| 246 | ATAPI_CDB_LEN = 16, |
| 247 | |
Tejun Heo | 814600e | 2007-07-01 19:05:58 +0900 | [diff] [blame] | 248 | /* PMP stuff */ |
| 249 | SATA_PMP_MAX_PORTS = 15, |
| 250 | SATA_PMP_CTRL_PORT = 15, |
| 251 | |
| 252 | SATA_PMP_GSCR_DWORDS = 128, |
| 253 | SATA_PMP_GSCR_PROD_ID = 0, |
| 254 | SATA_PMP_GSCR_REV = 1, |
| 255 | SATA_PMP_GSCR_PORT_INFO = 2, |
| 256 | SATA_PMP_GSCR_ERROR = 32, |
| 257 | SATA_PMP_GSCR_ERROR_EN = 33, |
| 258 | SATA_PMP_GSCR_FEAT = 64, |
| 259 | SATA_PMP_GSCR_FEAT_EN = 96, |
| 260 | |
| 261 | SATA_PMP_PSCR_STATUS = 0, |
| 262 | SATA_PMP_PSCR_ERROR = 1, |
| 263 | SATA_PMP_PSCR_CONTROL = 2, |
| 264 | |
| 265 | SATA_PMP_FEAT_BIST = (1 << 0), |
| 266 | SATA_PMP_FEAT_PMREQ = (1 << 1), |
| 267 | SATA_PMP_FEAT_DYNSSC = (1 << 2), |
| 268 | SATA_PMP_FEAT_NOTIFY = (1 << 3), |
| 269 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 270 | /* cable types */ |
| 271 | ATA_CBL_NONE = 0, |
| 272 | ATA_CBL_PATA40 = 1, |
| 273 | ATA_CBL_PATA80 = 2, |
Alan Cox | fc08515 | 2006-10-10 14:28:11 -0700 | [diff] [blame] | 274 | ATA_CBL_PATA40_SHORT = 3, /* 40 wire cable to high UDMA spec */ |
| 275 | ATA_CBL_PATA_UNK = 4, |
| 276 | ATA_CBL_SATA = 5, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 277 | |
| 278 | /* SATA Status and Control Registers */ |
| 279 | SCR_STATUS = 0, |
| 280 | SCR_ERROR = 1, |
| 281 | SCR_CONTROL = 2, |
| 282 | SCR_ACTIVE = 3, |
| 283 | SCR_NOTIFICATION = 4, |
| 284 | |
Tejun Heo | 9be1e97 | 2006-05-15 20:58:17 +0900 | [diff] [blame] | 285 | /* SError bits */ |
| 286 | SERR_DATA_RECOVERED = (1 << 0), /* recovered data error */ |
| 287 | SERR_COMM_RECOVERED = (1 << 1), /* recovered comm failure */ |
| 288 | SERR_DATA = (1 << 8), /* unrecovered data error */ |
| 289 | SERR_PERSISTENT = (1 << 9), /* persistent data/comm error */ |
| 290 | SERR_PROTOCOL = (1 << 10), /* protocol violation */ |
| 291 | SERR_INTERNAL = (1 << 11), /* host internal error */ |
| 292 | SERR_PHYRDY_CHG = (1 << 16), /* PHY RDY changed */ |
Robert Hancock | 1333e19 | 2007-10-02 11:22:02 -0400 | [diff] [blame] | 293 | SERR_PHY_INT_ERR = (1 << 17), /* PHY internal error */ |
| 294 | SERR_COMM_WAKE = (1 << 18), /* Comm wake */ |
| 295 | SERR_10B_8B_ERR = (1 << 19), /* 10b to 8b decode error */ |
| 296 | SERR_DISPARITY = (1 << 20), /* Disparity */ |
| 297 | SERR_CRC = (1 << 21), /* CRC error */ |
| 298 | SERR_HANDSHAKE = (1 << 22), /* Handshake error */ |
| 299 | SERR_LINK_SEQ_ERR = (1 << 23), /* Link sequence error */ |
| 300 | SERR_TRANS_ST_ERROR = (1 << 24), /* Transport state trans. error */ |
| 301 | SERR_UNRECOG_FIS = (1 << 25), /* Unrecognized FIS */ |
Tejun Heo | 9be1e97 | 2006-05-15 20:58:17 +0900 | [diff] [blame] | 302 | SERR_DEV_XCHG = (1 << 26), /* device exchanged */ |
| 303 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 304 | /* struct ata_taskfile flags */ |
| 305 | ATA_TFLAG_LBA48 = (1 << 0), /* enable 48-bit LBA and "HOB" */ |
| 306 | ATA_TFLAG_ISADDR = (1 << 1), /* enable r/w to nsect/lba regs */ |
| 307 | ATA_TFLAG_DEVICE = (1 << 2), /* enable r/w to device reg */ |
| 308 | ATA_TFLAG_WRITE = (1 << 3), /* data dir: host->dev==1 (write) */ |
Albert Lee | 8bf62ece | 2005-05-12 15:29:42 -0400 | [diff] [blame] | 309 | ATA_TFLAG_LBA = (1 << 4), /* enable LBA */ |
Tejun Heo | 9a3dccc | 2006-01-06 09:56:18 +0100 | [diff] [blame] | 310 | ATA_TFLAG_FUA = (1 << 5), /* enable FUA */ |
Jeff Garzik | ea9b395 | 2006-01-17 10:29:06 -0500 | [diff] [blame] | 311 | ATA_TFLAG_POLLING = (1 << 6), /* set nIEN to 1 and use polling */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 312 | }; |
| 313 | |
| 314 | enum ata_tf_protocols { |
| 315 | /* ATA taskfile protocols */ |
| 316 | ATA_PROT_UNKNOWN, /* unknown/invalid */ |
| 317 | ATA_PROT_NODATA, /* no data */ |
Albert Lee | 1dce589 | 2007-06-07 15:49:22 +0800 | [diff] [blame] | 318 | ATA_PROT_PIO, /* PIO data xfer */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 319 | ATA_PROT_DMA, /* DMA */ |
Tejun Heo | 88e4903 | 2006-05-15 21:03:38 +0900 | [diff] [blame] | 320 | ATA_PROT_NCQ, /* NCQ */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 321 | ATA_PROT_ATAPI, /* packet command, PIO data xfer*/ |
| 322 | ATA_PROT_ATAPI_NODATA, /* packet command, no data */ |
| 323 | ATA_PROT_ATAPI_DMA, /* packet command with special DMA sauce */ |
| 324 | }; |
| 325 | |
| 326 | enum ata_ioctls { |
| 327 | ATA_IOC_GET_IO32 = 0x309, |
| 328 | ATA_IOC_SET_IO32 = 0x324, |
| 329 | }; |
| 330 | |
| 331 | /* core structures */ |
| 332 | |
| 333 | struct ata_prd { |
| 334 | u32 addr; |
| 335 | u32 flags_len; |
| 336 | }; |
| 337 | |
| 338 | struct ata_taskfile { |
| 339 | unsigned long flags; /* ATA_TFLAG_xxx */ |
| 340 | u8 protocol; /* ATA_PROT_xxx */ |
| 341 | |
| 342 | u8 ctl; /* control reg */ |
| 343 | |
| 344 | u8 hob_feature; /* additional data */ |
| 345 | u8 hob_nsect; /* to support LBA48 */ |
| 346 | u8 hob_lbal; |
| 347 | u8 hob_lbam; |
| 348 | u8 hob_lbah; |
| 349 | |
| 350 | u8 feature; |
| 351 | u8 nsect; |
| 352 | u8 lbal; |
| 353 | u8 lbam; |
| 354 | u8 lbah; |
| 355 | |
| 356 | u8 device; |
| 357 | |
| 358 | u8 command; /* IO operation */ |
| 359 | }; |
| 360 | |
| 361 | #define ata_id_is_ata(id) (((id)[0] & (1 << 15)) == 0) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 362 | #define ata_id_has_lba(id) ((id)[49] & (1 << 9)) |
| 363 | #define ata_id_has_dma(id) ((id)[49] & (1 << 8)) |
Tejun Heo | 88e4903 | 2006-05-15 21:03:38 +0900 | [diff] [blame] | 364 | #define ata_id_has_ncq(id) ((id)[76] & (1 << 8)) |
| 365 | #define ata_id_queue_depth(id) (((id)[75] & 0x1f) + 1) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 366 | #define ata_id_removeable(id) ((id)[0] & (1 << 7)) |
Alan Cox | c729387 | 2007-08-22 23:31:43 +0100 | [diff] [blame] | 367 | #define ata_id_has_dword_io(id) ((id)[48] & (1 << 0)) |
Tejun Heo | 854c73a | 2007-09-23 13:14:11 +0900 | [diff] [blame] | 368 | #define ata_id_has_atapi_AN(id) \ |
Kristen Carlson Accardi | 9f45cbd | 2007-08-15 03:57:11 -0400 | [diff] [blame] | 369 | ( (((id)[76] != 0x0000) && ((id)[76] != 0xffff)) && \ |
| 370 | ((id)[78] & (1 << 5)) ) |
Alan | 49554c1 | 2007-02-05 16:17:19 +0000 | [diff] [blame] | 371 | #define ata_id_iordy_disable(id) ((id)[49] & (1 << 10)) |
Alan Cox | 0bc2a79 | 2007-07-31 14:01:48 +0100 | [diff] [blame] | 372 | #define ata_id_has_iordy(id) ((id)[49] & (1 << 11)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 373 | #define ata_id_u32(id,n) \ |
| 374 | (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)])) |
| 375 | #define ata_id_u64(id,n) \ |
| 376 | ( ((u64) (id)[(n) + 3] << 48) | \ |
| 377 | ((u64) (id)[(n) + 2] << 32) | \ |
| 378 | ((u64) (id)[(n) + 1] << 16) | \ |
| 379 | ((u64) (id)[(n) + 0]) ) |
| 380 | |
Albert Lee | 312f7da | 2005-09-27 17:38:03 +0800 | [diff] [blame] | 381 | #define ata_id_cdb_intr(id) (((id)[0] & 0x60) == 0x20) |
| 382 | |
Kristen Carlson Accardi | ca77329 | 2007-10-25 00:58:59 -0400 | [diff] [blame] | 383 | static inline bool ata_id_has_hipm(const u16 *id) |
| 384 | { |
| 385 | u16 val = id[76]; |
| 386 | |
| 387 | if (val == 0 || val == 0xffff) |
| 388 | return false; |
| 389 | |
| 390 | return val & (1 << 9); |
| 391 | } |
| 392 | |
| 393 | static inline bool ata_id_has_dipm(const u16 *id) |
| 394 | { |
| 395 | u16 val = id[78]; |
| 396 | |
| 397 | if (val == 0 || val == 0xffff) |
| 398 | return false; |
| 399 | |
| 400 | return val & (1 << 3); |
| 401 | } |
| 402 | |
Alan Cox | c729387 | 2007-08-22 23:31:43 +0100 | [diff] [blame] | 403 | static inline int ata_id_has_fua(const u16 *id) |
| 404 | { |
| 405 | if ((id[84] & 0xC000) != 0x4000) |
| 406 | return 0; |
| 407 | return id[84] & (1 << 6); |
| 408 | } |
| 409 | |
| 410 | static inline int ata_id_has_flush(const u16 *id) |
| 411 | { |
| 412 | if ((id[83] & 0xC000) != 0x4000) |
| 413 | return 0; |
| 414 | return id[83] & (1 << 12); |
| 415 | } |
| 416 | |
| 417 | static inline int ata_id_has_flush_ext(const u16 *id) |
| 418 | { |
| 419 | if ((id[83] & 0xC000) != 0x4000) |
| 420 | return 0; |
| 421 | return id[83] & (1 << 13); |
| 422 | } |
| 423 | |
| 424 | static inline int ata_id_has_lba48(const u16 *id) |
| 425 | { |
| 426 | if ((id[83] & 0xC000) != 0x4000) |
| 427 | return 0; |
Geert Uytterhoeven | 17bd9a2 | 2007-10-29 21:21:37 +0100 | [diff] [blame] | 428 | if (!ata_id_u64(id, 100)) |
| 429 | return 0; |
Alan Cox | c729387 | 2007-08-22 23:31:43 +0100 | [diff] [blame] | 430 | return id[83] & (1 << 10); |
| 431 | } |
| 432 | |
| 433 | static inline int ata_id_hpa_enabled(const u16 *id) |
| 434 | { |
| 435 | /* Yes children, word 83 valid bits cover word 82 data */ |
| 436 | if ((id[83] & 0xC000) != 0x4000) |
| 437 | return 0; |
| 438 | /* And 87 covers 85-87 */ |
| 439 | if ((id[87] & 0xC000) != 0x4000) |
| 440 | return 0; |
| 441 | /* Check command sets enabled as well as supported */ |
| 442 | if ((id[85] & ( 1 << 10)) == 0) |
| 443 | return 0; |
| 444 | return id[82] & (1 << 10); |
| 445 | } |
| 446 | |
| 447 | static inline int ata_id_has_wcache(const u16 *id) |
| 448 | { |
| 449 | /* Yes children, word 83 valid bits cover word 82 data */ |
| 450 | if ((id[83] & 0xC000) != 0x4000) |
| 451 | return 0; |
| 452 | return id[82] & (1 << 5); |
| 453 | } |
| 454 | |
| 455 | static inline int ata_id_has_pm(const u16 *id) |
| 456 | { |
| 457 | if ((id[83] & 0xC000) != 0x4000) |
| 458 | return 0; |
| 459 | return id[82] & (1 << 3); |
| 460 | } |
| 461 | |
| 462 | static inline int ata_id_rahead_enabled(const u16 *id) |
| 463 | { |
| 464 | if ((id[87] & 0xC000) != 0x4000) |
| 465 | return 0; |
| 466 | return id[85] & (1 << 6); |
| 467 | } |
| 468 | |
| 469 | static inline int ata_id_wcache_enabled(const u16 *id) |
| 470 | { |
| 471 | if ((id[87] & 0xC000) != 0x4000) |
| 472 | return 0; |
| 473 | return id[85] & (1 << 5); |
| 474 | } |
| 475 | |
| 476 | /** |
| 477 | * ata_id_major_version - get ATA level of drive |
| 478 | * @id: Identify data |
| 479 | * |
| 480 | * Caveats: |
| 481 | * ATA-1 considers identify optional |
| 482 | * ATA-2 introduces mandatory identify |
| 483 | * ATA-3 introduces word 80 and accurate reporting |
| 484 | * |
| 485 | * The practical impact of this is that ata_id_major_version cannot |
Jeff Garzik | 2dcb407 | 2007-10-19 06:42:56 -0400 | [diff] [blame] | 486 | * reliably report on drives below ATA3. |
Alan Cox | c729387 | 2007-08-22 23:31:43 +0100 | [diff] [blame] | 487 | */ |
| 488 | |
Tejun Heo | 3d2ca91 | 2006-02-12 22:47:04 +0900 | [diff] [blame] | 489 | static inline unsigned int ata_id_major_version(const u16 *id) |
| 490 | { |
| 491 | unsigned int mver; |
| 492 | |
Alan Cox | b352e57 | 2006-08-10 18:52:12 +0100 | [diff] [blame] | 493 | if (id[ATA_ID_MAJOR_VER] == 0xFFFF) |
| 494 | return 0; |
| 495 | |
Tejun Heo | 3d2ca91 | 2006-02-12 22:47:04 +0900 | [diff] [blame] | 496 | for (mver = 14; mver >= 1; mver--) |
| 497 | if (id[ATA_ID_MAJOR_VER] & (1 << mver)) |
| 498 | break; |
| 499 | return mver; |
| 500 | } |
| 501 | |
Tejun Heo | 32d9091 | 2007-02-21 20:25:08 +0900 | [diff] [blame] | 502 | static inline int ata_id_is_sata(const u16 *id) |
| 503 | { |
| 504 | return ata_id_major_version(id) >= 5 && id[93] == 0; |
| 505 | } |
| 506 | |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 507 | static inline int ata_id_current_chs_valid(const u16 *id) |
Albert Lee | 8bf62ece | 2005-05-12 15:29:42 -0400 | [diff] [blame] | 508 | { |
Jeff Garzik | 9bec2e3 | 2006-08-31 00:02:15 -0400 | [diff] [blame] | 509 | /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command |
| 510 | has not been issued to the device then the values of |
Albert Lee | 8bf62ece | 2005-05-12 15:29:42 -0400 | [diff] [blame] | 511 | id[54] to id[56] are vendor specific. */ |
| 512 | return (id[53] & 0x01) && /* Current translation valid */ |
| 513 | id[54] && /* cylinders in current translation */ |
| 514 | id[55] && /* heads in current translation */ |
| 515 | id[55] <= 16 && |
| 516 | id[56]; /* sectors in current translation */ |
| 517 | } |
| 518 | |
Alan Cox | b352e57 | 2006-08-10 18:52:12 +0100 | [diff] [blame] | 519 | static inline int ata_id_is_cfa(const u16 *id) |
| 520 | { |
| 521 | u16 v = id[0]; |
| 522 | if (v == 0x848A) /* Standard CF */ |
| 523 | return 1; |
| 524 | /* Could be CF hiding as standard ATA */ |
| 525 | if (ata_id_major_version(id) >= 3 && id[82] != 0xFFFF && |
| 526 | (id[82] & ( 1 << 2))) |
| 527 | return 1; |
| 528 | return 0; |
| 529 | } |
| 530 | |
Alan Cox | fc08515 | 2006-10-10 14:28:11 -0700 | [diff] [blame] | 531 | static inline int ata_drive_40wire(const u16 *dev_id) |
| 532 | { |
Tejun Heo | 32d9091 | 2007-02-21 20:25:08 +0900 | [diff] [blame] | 533 | if (ata_id_is_sata(dev_id)) |
Alan Cox | fc08515 | 2006-10-10 14:28:11 -0700 | [diff] [blame] | 534 | return 0; /* SATA */ |
Tejun Heo | 61f216c | 2007-02-05 23:21:19 +0900 | [diff] [blame] | 535 | if ((dev_id[93] & 0xE000) == 0x6000) |
Alan Cox | fc08515 | 2006-10-10 14:28:11 -0700 | [diff] [blame] | 536 | return 0; /* 80 wire */ |
| 537 | return 1; |
| 538 | } |
| 539 | |
Alan Cox | 6bbfd53 | 2007-11-05 22:58:58 +0000 | [diff] [blame] | 540 | static inline int ata_drive_40wire_relaxed(const u16 *dev_id) |
| 541 | { |
| 542 | if (ata_id_is_sata(dev_id)) |
| 543 | return 0; /* SATA */ |
| 544 | if ((dev_id[93] & 0x2000) == 0x2000) |
| 545 | return 0; /* 80 wire */ |
| 546 | return 1; |
| 547 | } |
| 548 | |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 549 | static inline int atapi_cdb_len(const u16 *dev_id) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 550 | { |
| 551 | u16 tmp = dev_id[0] & 0x3; |
| 552 | switch (tmp) { |
| 553 | case 0: return 12; |
| 554 | case 1: return 16; |
| 555 | default: return -1; |
| 556 | } |
| 557 | } |
| 558 | |
Tony Battersby | f8d8e57 | 2007-10-30 11:44:35 -0400 | [diff] [blame] | 559 | static inline int atapi_command_packet_set(const u16 *dev_id) |
| 560 | { |
| 561 | return (dev_id[0] >> 8) & 0x1f; |
| 562 | } |
| 563 | |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 564 | static inline int is_atapi_taskfile(const struct ata_taskfile *tf) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 565 | { |
| 566 | return (tf->protocol == ATA_PROT_ATAPI) || |
| 567 | (tf->protocol == ATA_PROT_ATAPI_NODATA) || |
| 568 | (tf->protocol == ATA_PROT_ATAPI_DMA); |
| 569 | } |
| 570 | |
Albert Lee | 07f6f7d | 2005-11-01 19:33:20 +0800 | [diff] [blame] | 571 | static inline int is_multi_taskfile(struct ata_taskfile *tf) |
| 572 | { |
| 573 | return (tf->command == ATA_CMD_READ_MULTI) || |
| 574 | (tf->command == ATA_CMD_WRITE_MULTI) || |
| 575 | (tf->command == ATA_CMD_READ_MULTI_EXT) || |
Albert Lee | c2956a3 | 2006-03-03 10:34:05 +0800 | [diff] [blame] | 576 | (tf->command == ATA_CMD_WRITE_MULTI_EXT) || |
| 577 | (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT); |
Albert Lee | 07f6f7d | 2005-11-01 19:33:20 +0800 | [diff] [blame] | 578 | } |
| 579 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 580 | static inline int ata_ok(u8 status) |
| 581 | { |
| 582 | return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR)) |
| 583 | == ATA_DRDY); |
| 584 | } |
| 585 | |
Albert Lee | c6a33e2 | 2005-10-12 15:12:26 +0800 | [diff] [blame] | 586 | static inline int lba_28_ok(u64 block, u32 n_block) |
| 587 | { |
| 588 | /* check the ending block number */ |
| 589 | return ((block + n_block - 1) < ((u64)1 << 28)) && (n_block <= 256); |
| 590 | } |
| 591 | |
| 592 | static inline int lba_48_ok(u64 block, u32 n_block) |
| 593 | { |
| 594 | /* check the ending block number */ |
| 595 | return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536); |
| 596 | } |
| 597 | |
Tejun Heo | 814600e | 2007-07-01 19:05:58 +0900 | [diff] [blame] | 598 | #define sata_pmp_gscr_vendor(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff) |
| 599 | #define sata_pmp_gscr_devid(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16) |
| 600 | #define sata_pmp_gscr_rev(gscr) (((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff) |
| 601 | #define sata_pmp_gscr_ports(gscr) ((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf) |
| 602 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 603 | #endif /* __LINUX_ATA_H__ */ |