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