1 /* 2 * Copyright 2003-2005 Red Hat, Inc. All rights reserved. 3 * Copyright 2003-2005 Jeff Garzik 4 * 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation; either version 2, or (at your option) 9 * any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License 17 * along with this program; see the file COPYING. If not, write to 18 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 19 * 20 * 21 * libata documentation is available via 'make {ps|pdf}docs', 22 * as Documentation/DocBook/libata.* 23 * 24 */ 25 26 #ifndef __LINUX_LIBATA_H__ 27 #define __LINUX_LIBATA_H__ 28 29 #include <linux/delay.h> 30 #include <linux/jiffies.h> 31 #include <linux/interrupt.h> 32 #include <linux/dma-mapping.h> 33 #include <linux/scatterlist.h> 34 #include <linux/io.h> 35 #include <linux/ata.h> 36 #include <linux/workqueue.h> 37 #include <scsi/scsi_host.h> 38 #include <linux/acpi.h> 39 #include <linux/cdrom.h> 40 #include <linux/sched.h> 41 42 /* 43 * Define if arch has non-standard setup. This is a _PCI_ standard 44 * not a legacy or ISA standard. 45 */ 46 #ifdef CONFIG_ATA_NONSTANDARD 47 #include <asm/libata-portmap.h> 48 #else 49 #include <asm-generic/libata-portmap.h> 50 #endif 51 52 /* 53 * compile-time options: to be removed as soon as all the drivers are 54 * converted to the new debugging mechanism 55 */ 56 #undef ATA_DEBUG /* debugging output */ 57 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */ 58 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */ 59 #undef ATA_NDEBUG /* define to disable quick runtime checks */ 60 61 62 /* note: prints function name for you */ 63 #ifdef ATA_DEBUG 64 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args) 65 #ifdef ATA_VERBOSE_DEBUG 66 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args) 67 #else 68 #define VPRINTK(fmt, args...) 69 #endif /* ATA_VERBOSE_DEBUG */ 70 #else 71 #define DPRINTK(fmt, args...) 72 #define VPRINTK(fmt, args...) 73 #endif /* ATA_DEBUG */ 74 75 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args) 76 77 #define ata_print_version_once(dev, version) \ 78 ({ \ 79 static bool __print_once; \ 80 \ 81 if (!__print_once) { \ 82 __print_once = true; \ 83 ata_print_version(dev, version); \ 84 } \ 85 }) 86 87 /* NEW: debug levels */ 88 #define HAVE_LIBATA_MSG 1 89 90 enum { 91 ATA_MSG_DRV = 0x0001, 92 ATA_MSG_INFO = 0x0002, 93 ATA_MSG_PROBE = 0x0004, 94 ATA_MSG_WARN = 0x0008, 95 ATA_MSG_MALLOC = 0x0010, 96 ATA_MSG_CTL = 0x0020, 97 ATA_MSG_INTR = 0x0040, 98 ATA_MSG_ERR = 0x0080, 99 }; 100 101 #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV) 102 #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO) 103 #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE) 104 #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN) 105 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC) 106 #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL) 107 #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR) 108 #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR) 109 110 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits) 111 { 112 if (dval < 0 || dval >= (sizeof(u32) * 8)) 113 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */ 114 if (!dval) 115 return 0; 116 return (1 << dval) - 1; 117 } 118 119 /* defines only for the constants which don't work well as enums */ 120 #define ATA_TAG_POISON 0xfafbfcfdU 121 122 enum { 123 /* various global constants */ 124 LIBATA_MAX_PRD = ATA_MAX_PRD / 2, 125 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */ 126 ATA_DEF_QUEUE = 1, 127 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */ 128 ATA_MAX_QUEUE = 32, 129 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1, 130 ATA_SHORT_PAUSE = 16, 131 132 ATAPI_MAX_DRAIN = 16 << 10, 133 134 ATA_ALL_DEVICES = (1 << ATA_MAX_DEVICES) - 1, 135 136 ATA_SHT_EMULATED = 1, 137 ATA_SHT_THIS_ID = -1, 138 ATA_SHT_USE_CLUSTERING = 1, 139 140 /* struct ata_taskfile flags */ 141 ATA_TFLAG_LBA48 = (1 << 0), /* enable 48-bit LBA and "HOB" */ 142 ATA_TFLAG_ISADDR = (1 << 1), /* enable r/w to nsect/lba regs */ 143 ATA_TFLAG_DEVICE = (1 << 2), /* enable r/w to device reg */ 144 ATA_TFLAG_WRITE = (1 << 3), /* data dir: host->dev==1 (write) */ 145 ATA_TFLAG_LBA = (1 << 4), /* enable LBA */ 146 ATA_TFLAG_FUA = (1 << 5), /* enable FUA */ 147 ATA_TFLAG_POLLING = (1 << 6), /* set nIEN to 1 and use polling */ 148 149 /* protocol flags */ 150 ATA_PROT_FLAG_PIO = (1 << 0), /* is PIO */ 151 ATA_PROT_FLAG_DMA = (1 << 1), /* is DMA */ 152 ATA_PROT_FLAG_DATA = ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA, 153 ATA_PROT_FLAG_NCQ = (1 << 2), /* is NCQ */ 154 ATA_PROT_FLAG_ATAPI = (1 << 3), /* is ATAPI */ 155 156 /* struct ata_device stuff */ 157 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */ 158 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */ 159 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */ 160 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */ 161 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */ 162 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */ 163 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */ 164 ATA_DFLAG_AN = (1 << 7), /* AN configured */ 165 ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */ 166 ATA_DFLAG_CFG_MASK = (1 << 12) - 1, 167 168 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */ 169 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */ 170 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */ 171 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */ 172 ATA_DFLAG_NO_UNLOAD = (1 << 17), /* device doesn't support unload */ 173 ATA_DFLAG_UNLOCK_HPA = (1 << 18), /* unlock HPA */ 174 ATA_DFLAG_NCQ_SEND_RECV = (1 << 19), /* device supports NCQ SEND and RECV */ 175 ATA_DFLAG_INIT_MASK = (1 << 24) - 1, 176 177 ATA_DFLAG_DETACH = (1 << 24), 178 ATA_DFLAG_DETACHED = (1 << 25), 179 180 ATA_DFLAG_DA = (1 << 26), /* device supports Device Attention */ 181 ATA_DFLAG_DEVSLP = (1 << 27), /* device supports Device Sleep */ 182 ATA_DFLAG_ACPI_DISABLED = (1 << 28), /* ACPI for the device is disabled */ 183 184 ATA_DEV_UNKNOWN = 0, /* unknown device */ 185 ATA_DEV_ATA = 1, /* ATA device */ 186 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */ 187 ATA_DEV_ATAPI = 3, /* ATAPI device */ 188 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */ 189 ATA_DEV_PMP = 5, /* SATA port multiplier */ 190 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */ 191 ATA_DEV_SEMB = 7, /* SEMB */ 192 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */ 193 ATA_DEV_ZAC = 9, /* ZAC device */ 194 ATA_DEV_NONE = 10, /* no device */ 195 196 /* struct ata_link flags */ 197 ATA_LFLAG_NO_HRST = (1 << 1), /* avoid hardreset */ 198 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */ 199 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */ 200 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */ 201 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB, 202 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */ 203 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */ 204 ATA_LFLAG_SW_ACTIVITY = (1 << 7), /* keep activity stats */ 205 ATA_LFLAG_NO_LPM = (1 << 8), /* disable LPM on this link */ 206 ATA_LFLAG_RST_ONCE = (1 << 9), /* limit recovery to one reset */ 207 ATA_LFLAG_CHANGED = (1 << 10), /* LPM state changed on this link */ 208 209 /* struct ata_port flags */ 210 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */ 211 /* (doesn't imply presence) */ 212 ATA_FLAG_SATA = (1 << 1), 213 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */ 214 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */ 215 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */ 216 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD 217 * doesn't handle PIO interrupts */ 218 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */ 219 ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */ 220 ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */ 221 ATA_FLAG_DEBUGMSG = (1 << 13), 222 ATA_FLAG_FPDMA_AA = (1 << 14), /* driver supports Auto-Activate */ 223 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */ 224 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */ 225 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */ 226 ATA_FLAG_AN = (1 << 18), /* controller supports AN */ 227 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */ 228 ATA_FLAG_FPDMA_AUX = (1 << 20), /* controller supports H2DFIS aux field */ 229 ATA_FLAG_EM = (1 << 21), /* driver supports enclosure 230 * management */ 231 ATA_FLAG_SW_ACTIVITY = (1 << 22), /* driver supports sw activity 232 * led */ 233 ATA_FLAG_NO_DIPM = (1 << 23), /* host not happy with DIPM */ 234 ATA_FLAG_SAS_HOST = (1 << 24), /* SAS host */ 235 236 /* bits 24:31 of ap->flags are reserved for LLD specific flags */ 237 238 239 /* struct ata_port pflags */ 240 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */ 241 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */ 242 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */ 243 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */ 244 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */ 245 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */ 246 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */ 247 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */ 248 ATA_PFLAG_UNLOADING = (1 << 9), /* driver is being unloaded */ 249 ATA_PFLAG_UNLOADED = (1 << 10), /* driver is unloaded */ 250 251 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */ 252 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */ 253 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */ 254 255 ATA_PFLAG_PIO32 = (1 << 20), /* 32bit PIO */ 256 ATA_PFLAG_PIO32CHANGE = (1 << 21), /* 32bit PIO can be turned on/off */ 257 ATA_PFLAG_EXTERNAL = (1 << 22), /* eSATA/external port */ 258 259 /* struct ata_queued_cmd flags */ 260 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */ 261 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */ 262 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */ 263 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */ 264 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */ 265 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */ 266 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */ 267 268 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */ 269 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */ 270 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */ 271 272 /* host set flags */ 273 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */ 274 ATA_HOST_STARTED = (1 << 1), /* Host started */ 275 ATA_HOST_PARALLEL_SCAN = (1 << 2), /* Ports on this host can be scanned in parallel */ 276 ATA_HOST_IGNORE_ATA = (1 << 3), /* Ignore ATA devices on this host. */ 277 278 /* bits 24:31 of host->flags are reserved for LLD specific flags */ 279 280 /* various lengths of time */ 281 ATA_TMOUT_BOOT = 30000, /* heuristic */ 282 ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */ 283 ATA_TMOUT_INTERNAL_QUICK = 5000, 284 ATA_TMOUT_MAX_PARK = 30000, 285 286 /* 287 * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms. 2s 288 * is too much without parallel probing. Use 2s if parallel 289 * probing is available, 800ms otherwise. 290 */ 291 ATA_TMOUT_FF_WAIT_LONG = 2000, 292 ATA_TMOUT_FF_WAIT = 800, 293 294 /* Spec mandates to wait for ">= 2ms" before checking status 295 * after reset. We wait 150ms, because that was the magic 296 * delay used for ATAPI devices in Hale Landis's ATADRVR, for 297 * the period of time between when the ATA command register is 298 * written, and then status is checked. Because waiting for 299 * "a while" before checking status is fine, post SRST, we 300 * perform this magic delay here as well. 301 * 302 * Old drivers/ide uses the 2mS rule and then waits for ready. 303 */ 304 ATA_WAIT_AFTER_RESET = 150, 305 306 /* If PMP is supported, we have to do follow-up SRST. As some 307 * PMPs don't send D2H Reg FIS after hardreset, LLDs are 308 * advised to wait only for the following duration before 309 * doing SRST. 310 */ 311 ATA_TMOUT_PMP_SRST_WAIT = 5000, 312 313 /* When the LPM policy is set to ATA_LPM_MAX_POWER, there might 314 * be a spurious PHY event, so ignore the first PHY event that 315 * occurs within 10s after the policy change. 316 */ 317 ATA_TMOUT_SPURIOUS_PHY = 10000, 318 319 /* ATA bus states */ 320 BUS_UNKNOWN = 0, 321 BUS_DMA = 1, 322 BUS_IDLE = 2, 323 BUS_NOINTR = 3, 324 BUS_NODATA = 4, 325 BUS_TIMER = 5, 326 BUS_PIO = 6, 327 BUS_EDD = 7, 328 BUS_IDENTIFY = 8, 329 BUS_PACKET = 9, 330 331 /* SATA port states */ 332 PORT_UNKNOWN = 0, 333 PORT_ENABLED = 1, 334 PORT_DISABLED = 2, 335 336 /* encoding various smaller bitmaps into a single 337 * unsigned long bitmap 338 */ 339 ATA_NR_PIO_MODES = 7, 340 ATA_NR_MWDMA_MODES = 5, 341 ATA_NR_UDMA_MODES = 8, 342 343 ATA_SHIFT_PIO = 0, 344 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES, 345 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES, 346 347 /* size of buffer to pad xfers ending on unaligned boundaries */ 348 ATA_DMA_PAD_SZ = 4, 349 350 /* ering size */ 351 ATA_ERING_SIZE = 32, 352 353 /* return values for ->qc_defer */ 354 ATA_DEFER_LINK = 1, 355 ATA_DEFER_PORT = 2, 356 357 /* desc_len for ata_eh_info and context */ 358 ATA_EH_DESC_LEN = 80, 359 360 /* reset / recovery action types */ 361 ATA_EH_REVALIDATE = (1 << 0), 362 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */ 363 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */ 364 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET, 365 ATA_EH_ENABLE_LINK = (1 << 3), 366 ATA_EH_PARK = (1 << 5), /* unload heads and stop I/O */ 367 368 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_PARK, 369 ATA_EH_ALL_ACTIONS = ATA_EH_REVALIDATE | ATA_EH_RESET | 370 ATA_EH_ENABLE_LINK, 371 372 /* ata_eh_info->flags */ 373 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */ 374 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */ 375 ATA_EHI_QUIET = (1 << 3), /* be quiet */ 376 ATA_EHI_NO_RECOVERY = (1 << 4), /* no recovery */ 377 378 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */ 379 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */ 380 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */ 381 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */ 382 ATA_EHI_POST_SETMODE = (1 << 20), /* revalidating after setmode */ 383 384 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET, 385 386 /* mask of flags to transfer *to* the slave link */ 387 ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET, 388 389 /* max tries if error condition is still set after ->error_handler */ 390 ATA_EH_MAX_TRIES = 5, 391 392 /* sometimes resuming a link requires several retries */ 393 ATA_LINK_RESUME_TRIES = 5, 394 395 /* how hard are we gonna try to probe/recover devices */ 396 ATA_PROBE_MAX_TRIES = 3, 397 ATA_EH_DEV_TRIES = 3, 398 ATA_EH_PMP_TRIES = 5, 399 ATA_EH_PMP_LINK_TRIES = 3, 400 401 SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */ 402 403 /* This should match the actual table size of 404 * ata_eh_cmd_timeout_table in libata-eh.c. 405 */ 406 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6, 407 408 /* Horkage types. May be set by libata or controller on drives 409 (some horkage may be drive/controller pair dependent */ 410 411 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */ 412 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */ 413 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */ 414 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */ 415 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */ 416 ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */ 417 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */ 418 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */ 419 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */ 420 ATA_HORKAGE_BRIDGE_OK = (1 << 10), /* no bridge limits */ 421 ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands 422 not multiple of 16 bytes */ 423 ATA_HORKAGE_FIRMWARE_WARN = (1 << 12), /* firmware update warning */ 424 ATA_HORKAGE_1_5_GBPS = (1 << 13), /* force 1.5 Gbps */ 425 ATA_HORKAGE_NOSETXFER = (1 << 14), /* skip SETXFER, SATA only */ 426 ATA_HORKAGE_BROKEN_FPDMA_AA = (1 << 15), /* skip AA */ 427 ATA_HORKAGE_DUMP_ID = (1 << 16), /* dump IDENTIFY data */ 428 ATA_HORKAGE_MAX_SEC_LBA48 = (1 << 17), /* Set max sects to 65535 */ 429 ATA_HORKAGE_ATAPI_DMADIR = (1 << 18), /* device requires dmadir */ 430 ATA_HORKAGE_NO_NCQ_TRIM = (1 << 19), /* don't use queued TRIM */ 431 ATA_HORKAGE_NOLPM = (1 << 20), /* don't use LPM */ 432 ATA_HORKAGE_WD_BROKEN_LPM = (1 << 21), /* some WDs have broken LPM */ 433 ATA_HORKAGE_ZERO_AFTER_TRIM = (1 << 22),/* guarantees zero after trim */ 434 ATA_HORKAGE_NO_NCQ_LOG = (1 << 23), /* don't use NCQ for log read */ 435 ATA_HORKAGE_NOTRIM = (1 << 24), /* don't use TRIM */ 436 ATA_HORKAGE_MAX_SEC_1024 = (1 << 25), /* Limit max sects to 1024 */ 437 438 /* DMA mask for user DMA control: User visible values; DO NOT 439 renumber */ 440 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */ 441 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */ 442 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */ 443 444 /* ATAPI command types */ 445 ATAPI_READ = 0, /* READs */ 446 ATAPI_WRITE = 1, /* WRITEs */ 447 ATAPI_READ_CD = 2, /* READ CD [MSF] */ 448 ATAPI_PASS_THRU = 3, /* SAT pass-thru */ 449 ATAPI_MISC = 4, /* the rest */ 450 451 /* Timing constants */ 452 ATA_TIMING_SETUP = (1 << 0), 453 ATA_TIMING_ACT8B = (1 << 1), 454 ATA_TIMING_REC8B = (1 << 2), 455 ATA_TIMING_CYC8B = (1 << 3), 456 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B | 457 ATA_TIMING_CYC8B, 458 ATA_TIMING_ACTIVE = (1 << 4), 459 ATA_TIMING_RECOVER = (1 << 5), 460 ATA_TIMING_DMACK_HOLD = (1 << 6), 461 ATA_TIMING_CYCLE = (1 << 7), 462 ATA_TIMING_UDMA = (1 << 8), 463 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B | 464 ATA_TIMING_REC8B | ATA_TIMING_CYC8B | 465 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER | 466 ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE | 467 ATA_TIMING_UDMA, 468 469 /* ACPI constants */ 470 ATA_ACPI_FILTER_SETXFER = 1 << 0, 471 ATA_ACPI_FILTER_LOCK = 1 << 1, 472 ATA_ACPI_FILTER_DIPM = 1 << 2, 473 ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3, /* FPDMA non-zero offset */ 474 ATA_ACPI_FILTER_FPDMA_AA = 1 << 4, /* FPDMA auto activate */ 475 476 ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER | 477 ATA_ACPI_FILTER_LOCK | 478 ATA_ACPI_FILTER_DIPM, 479 }; 480 481 enum ata_xfer_mask { 482 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1) 483 << ATA_SHIFT_PIO, 484 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1) 485 << ATA_SHIFT_MWDMA, 486 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1) 487 << ATA_SHIFT_UDMA, 488 }; 489 490 enum hsm_task_states { 491 HSM_ST_IDLE, /* no command on going */ 492 HSM_ST_FIRST, /* (waiting the device to) 493 write CDB or first data block */ 494 HSM_ST, /* (waiting the device to) transfer data */ 495 HSM_ST_LAST, /* (waiting the device to) complete command */ 496 HSM_ST_ERR, /* error */ 497 }; 498 499 enum ata_completion_errors { 500 AC_ERR_DEV = (1 << 0), /* device reported error */ 501 AC_ERR_HSM = (1 << 1), /* host state machine violation */ 502 AC_ERR_TIMEOUT = (1 << 2), /* timeout */ 503 AC_ERR_MEDIA = (1 << 3), /* media error */ 504 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */ 505 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */ 506 AC_ERR_SYSTEM = (1 << 6), /* system error */ 507 AC_ERR_INVALID = (1 << 7), /* invalid argument */ 508 AC_ERR_OTHER = (1 << 8), /* unknown */ 509 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */ 510 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */ 511 }; 512 513 /* 514 * Link power management policy: If you alter this, you also need to 515 * alter libata-scsi.c (for the ascii descriptions) 516 */ 517 enum ata_lpm_policy { 518 ATA_LPM_UNKNOWN, 519 ATA_LPM_MAX_POWER, 520 ATA_LPM_MED_POWER, 521 ATA_LPM_MIN_POWER, 522 }; 523 524 enum ata_lpm_hints { 525 ATA_LPM_EMPTY = (1 << 0), /* port empty/probing */ 526 ATA_LPM_HIPM = (1 << 1), /* may use HIPM */ 527 }; 528 529 /* forward declarations */ 530 struct scsi_device; 531 struct ata_port_operations; 532 struct ata_port; 533 struct ata_link; 534 struct ata_queued_cmd; 535 536 /* typedefs */ 537 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc); 538 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline); 539 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes, 540 unsigned long deadline); 541 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes); 542 543 extern struct device_attribute dev_attr_link_power_management_policy; 544 extern struct device_attribute dev_attr_unload_heads; 545 extern struct device_attribute dev_attr_em_message_type; 546 extern struct device_attribute dev_attr_em_message; 547 extern struct device_attribute dev_attr_sw_activity; 548 549 enum sw_activity { 550 OFF, 551 BLINK_ON, 552 BLINK_OFF, 553 }; 554 555 struct ata_taskfile { 556 unsigned long flags; /* ATA_TFLAG_xxx */ 557 u8 protocol; /* ATA_PROT_xxx */ 558 559 u8 ctl; /* control reg */ 560 561 u8 hob_feature; /* additional data */ 562 u8 hob_nsect; /* to support LBA48 */ 563 u8 hob_lbal; 564 u8 hob_lbam; 565 u8 hob_lbah; 566 567 u8 feature; 568 u8 nsect; 569 u8 lbal; 570 u8 lbam; 571 u8 lbah; 572 573 u8 device; 574 575 u8 command; /* IO operation */ 576 577 u32 auxiliary; /* auxiliary field */ 578 /* from SATA 3.1 and */ 579 /* ATA-8 ACS-3 */ 580 }; 581 582 #ifdef CONFIG_ATA_SFF 583 struct ata_ioports { 584 void __iomem *cmd_addr; 585 void __iomem *data_addr; 586 void __iomem *error_addr; 587 void __iomem *feature_addr; 588 void __iomem *nsect_addr; 589 void __iomem *lbal_addr; 590 void __iomem *lbam_addr; 591 void __iomem *lbah_addr; 592 void __iomem *device_addr; 593 void __iomem *status_addr; 594 void __iomem *command_addr; 595 void __iomem *altstatus_addr; 596 void __iomem *ctl_addr; 597 #ifdef CONFIG_ATA_BMDMA 598 void __iomem *bmdma_addr; 599 #endif /* CONFIG_ATA_BMDMA */ 600 void __iomem *scr_addr; 601 }; 602 #endif /* CONFIG_ATA_SFF */ 603 604 struct ata_host { 605 spinlock_t lock; 606 struct device *dev; 607 void __iomem * const *iomap; 608 unsigned int n_ports; 609 unsigned int n_tags; /* nr of NCQ tags */ 610 void *private_data; 611 struct ata_port_operations *ops; 612 unsigned long flags; 613 614 struct mutex eh_mutex; 615 struct task_struct *eh_owner; 616 617 struct ata_port *simplex_claimed; /* channel owning the DMA */ 618 struct ata_port *ports[0]; 619 }; 620 621 struct ata_queued_cmd { 622 struct ata_port *ap; 623 struct ata_device *dev; 624 625 struct scsi_cmnd *scsicmd; 626 void (*scsidone)(struct scsi_cmnd *); 627 628 struct ata_taskfile tf; 629 u8 cdb[ATAPI_CDB_LEN]; 630 631 unsigned long flags; /* ATA_QCFLAG_xxx */ 632 unsigned int tag; 633 unsigned int n_elem; 634 unsigned int orig_n_elem; 635 636 int dma_dir; 637 638 unsigned int sect_size; 639 640 unsigned int nbytes; 641 unsigned int extrabytes; 642 unsigned int curbytes; 643 644 struct scatterlist sgent; 645 646 struct scatterlist *sg; 647 648 struct scatterlist *cursg; 649 unsigned int cursg_ofs; 650 651 unsigned int err_mask; 652 struct ata_taskfile result_tf; 653 ata_qc_cb_t complete_fn; 654 655 void *private_data; 656 void *lldd_task; 657 }; 658 659 struct ata_port_stats { 660 unsigned long unhandled_irq; 661 unsigned long idle_irq; 662 unsigned long rw_reqbuf; 663 }; 664 665 struct ata_ering_entry { 666 unsigned int eflags; 667 unsigned int err_mask; 668 u64 timestamp; 669 }; 670 671 struct ata_ering { 672 int cursor; 673 struct ata_ering_entry ring[ATA_ERING_SIZE]; 674 }; 675 676 struct ata_device { 677 struct ata_link *link; 678 unsigned int devno; /* 0 or 1 */ 679 unsigned int horkage; /* List of broken features */ 680 unsigned long flags; /* ATA_DFLAG_xxx */ 681 struct scsi_device *sdev; /* attached SCSI device */ 682 void *private_data; 683 #ifdef CONFIG_ATA_ACPI 684 union acpi_object *gtf_cache; 685 unsigned int gtf_filter; 686 #endif 687 #ifdef CONFIG_SATA_ZPODD 688 void *zpodd; 689 #endif 690 struct device tdev; 691 /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */ 692 u64 n_sectors; /* size of device, if ATA */ 693 u64 n_native_sectors; /* native size, if ATA */ 694 unsigned int class; /* ATA_DEV_xxx */ 695 unsigned long unpark_deadline; 696 697 u8 pio_mode; 698 u8 dma_mode; 699 u8 xfer_mode; 700 unsigned int xfer_shift; /* ATA_SHIFT_xxx */ 701 702 unsigned int multi_count; /* sectors count for 703 READ/WRITE MULTIPLE */ 704 unsigned int max_sectors; /* per-device max sectors */ 705 unsigned int cdb_len; 706 707 /* per-dev xfer mask */ 708 unsigned long pio_mask; 709 unsigned long mwdma_mask; 710 unsigned long udma_mask; 711 712 /* for CHS addressing */ 713 u16 cylinders; /* Number of cylinders */ 714 u16 heads; /* Number of heads */ 715 u16 sectors; /* Number of sectors per track */ 716 717 union { 718 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */ 719 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */ 720 }; 721 722 /* DEVSLP Timing Variables from Identify Device Data Log */ 723 u8 devslp_timing[ATA_LOG_DEVSLP_SIZE]; 724 725 /* NCQ send and receive log subcommand support */ 726 u8 ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_SIZE]; 727 728 /* error history */ 729 int spdn_cnt; 730 /* ering is CLEAR_END, read comment above CLEAR_END */ 731 struct ata_ering ering; 732 }; 733 734 /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are 735 * cleared to zero on ata_dev_init(). 736 */ 737 #define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors) 738 #define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering) 739 740 struct ata_eh_info { 741 struct ata_device *dev; /* offending device */ 742 u32 serror; /* SError from LLDD */ 743 unsigned int err_mask; /* port-wide err_mask */ 744 unsigned int action; /* ATA_EH_* action mask */ 745 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */ 746 unsigned int flags; /* ATA_EHI_* flags */ 747 748 unsigned int probe_mask; 749 750 char desc[ATA_EH_DESC_LEN]; 751 int desc_len; 752 }; 753 754 struct ata_eh_context { 755 struct ata_eh_info i; 756 int tries[ATA_MAX_DEVICES]; 757 int cmd_timeout_idx[ATA_MAX_DEVICES] 758 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE]; 759 unsigned int classes[ATA_MAX_DEVICES]; 760 unsigned int did_probe_mask; 761 unsigned int unloaded_mask; 762 unsigned int saved_ncq_enabled; 763 u8 saved_xfer_mode[ATA_MAX_DEVICES]; 764 /* timestamp for the last reset attempt or success */ 765 unsigned long last_reset; 766 }; 767 768 struct ata_acpi_drive 769 { 770 u32 pio; 771 u32 dma; 772 } __packed; 773 774 struct ata_acpi_gtm { 775 struct ata_acpi_drive drive[2]; 776 u32 flags; 777 } __packed; 778 779 struct ata_link { 780 struct ata_port *ap; 781 int pmp; /* port multiplier port # */ 782 783 struct device tdev; 784 unsigned int active_tag; /* active tag on this link */ 785 u32 sactive; /* active NCQ commands */ 786 787 unsigned int flags; /* ATA_LFLAG_xxx */ 788 789 u32 saved_scontrol; /* SControl on probe */ 790 unsigned int hw_sata_spd_limit; 791 unsigned int sata_spd_limit; 792 unsigned int sata_spd; /* current SATA PHY speed */ 793 enum ata_lpm_policy lpm_policy; 794 795 /* record runtime error info, protected by host_set lock */ 796 struct ata_eh_info eh_info; 797 /* EH context */ 798 struct ata_eh_context eh_context; 799 800 struct ata_device device[ATA_MAX_DEVICES]; 801 802 unsigned long last_lpm_change; /* when last LPM change happened */ 803 }; 804 #define ATA_LINK_CLEAR_BEGIN offsetof(struct ata_link, active_tag) 805 #define ATA_LINK_CLEAR_END offsetof(struct ata_link, device[0]) 806 807 struct ata_port { 808 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */ 809 struct ata_port_operations *ops; 810 spinlock_t *lock; 811 /* Flags owned by the EH context. Only EH should touch these once the 812 port is active */ 813 unsigned long flags; /* ATA_FLAG_xxx */ 814 /* Flags that change dynamically, protected by ap->lock */ 815 unsigned int pflags; /* ATA_PFLAG_xxx */ 816 unsigned int print_id; /* user visible unique port ID */ 817 unsigned int local_port_no; /* host local port num */ 818 unsigned int port_no; /* 0 based port no. inside the host */ 819 820 #ifdef CONFIG_ATA_SFF 821 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */ 822 u8 ctl; /* cache of ATA control register */ 823 u8 last_ctl; /* Cache last written value */ 824 struct ata_link* sff_pio_task_link; /* link currently used */ 825 struct delayed_work sff_pio_task; 826 #ifdef CONFIG_ATA_BMDMA 827 struct ata_bmdma_prd *bmdma_prd; /* BMDMA SG list */ 828 dma_addr_t bmdma_prd_dma; /* and its DMA mapping */ 829 #endif /* CONFIG_ATA_BMDMA */ 830 #endif /* CONFIG_ATA_SFF */ 831 832 unsigned int pio_mask; 833 unsigned int mwdma_mask; 834 unsigned int udma_mask; 835 unsigned int cbl; /* cable type; ATA_CBL_xxx */ 836 837 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE]; 838 unsigned long sas_tag_allocated; /* for sas tag allocation only */ 839 unsigned int qc_active; 840 int nr_active_links; /* #links with active qcs */ 841 unsigned int sas_last_tag; /* track next tag hw expects */ 842 843 struct ata_link link; /* host default link */ 844 struct ata_link *slave_link; /* see ata_slave_link_init() */ 845 846 int nr_pmp_links; /* nr of available PMP links */ 847 struct ata_link *pmp_link; /* array of PMP links */ 848 struct ata_link *excl_link; /* for PMP qc exclusion */ 849 850 struct ata_port_stats stats; 851 struct ata_host *host; 852 struct device *dev; 853 struct device tdev; 854 855 struct mutex scsi_scan_mutex; 856 struct delayed_work hotplug_task; 857 struct work_struct scsi_rescan_task; 858 859 unsigned int hsm_task_state; 860 861 u32 msg_enable; 862 struct list_head eh_done_q; 863 wait_queue_head_t eh_wait_q; 864 int eh_tries; 865 struct completion park_req_pending; 866 867 pm_message_t pm_mesg; 868 enum ata_lpm_policy target_lpm_policy; 869 870 struct timer_list fastdrain_timer; 871 unsigned long fastdrain_cnt; 872 873 int em_message_type; 874 void *private_data; 875 876 #ifdef CONFIG_ATA_ACPI 877 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */ 878 #endif 879 /* owned by EH */ 880 u8 sector_buf[ATA_SECT_SIZE] ____cacheline_aligned; 881 }; 882 883 /* The following initializer overrides a method to NULL whether one of 884 * its parent has the method defined or not. This is equivalent to 885 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant 886 * expression and thus can't be used as an initializer. 887 */ 888 #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT) 889 890 struct ata_port_operations { 891 /* 892 * Command execution 893 */ 894 int (*qc_defer)(struct ata_queued_cmd *qc); 895 int (*check_atapi_dma)(struct ata_queued_cmd *qc); 896 void (*qc_prep)(struct ata_queued_cmd *qc); 897 unsigned int (*qc_issue)(struct ata_queued_cmd *qc); 898 bool (*qc_fill_rtf)(struct ata_queued_cmd *qc); 899 900 /* 901 * Configuration and exception handling 902 */ 903 int (*cable_detect)(struct ata_port *ap); 904 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask); 905 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev); 906 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev); 907 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev); 908 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id); 909 910 void (*dev_config)(struct ata_device *dev); 911 912 void (*freeze)(struct ata_port *ap); 913 void (*thaw)(struct ata_port *ap); 914 ata_prereset_fn_t prereset; 915 ata_reset_fn_t softreset; 916 ata_reset_fn_t hardreset; 917 ata_postreset_fn_t postreset; 918 ata_prereset_fn_t pmp_prereset; 919 ata_reset_fn_t pmp_softreset; 920 ata_reset_fn_t pmp_hardreset; 921 ata_postreset_fn_t pmp_postreset; 922 void (*error_handler)(struct ata_port *ap); 923 void (*lost_interrupt)(struct ata_port *ap); 924 void (*post_internal_cmd)(struct ata_queued_cmd *qc); 925 void (*sched_eh)(struct ata_port *ap); 926 void (*end_eh)(struct ata_port *ap); 927 928 /* 929 * Optional features 930 */ 931 int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val); 932 int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val); 933 void (*pmp_attach)(struct ata_port *ap); 934 void (*pmp_detach)(struct ata_port *ap); 935 int (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy, 936 unsigned hints); 937 938 /* 939 * Start, stop, suspend and resume 940 */ 941 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg); 942 int (*port_resume)(struct ata_port *ap); 943 int (*port_start)(struct ata_port *ap); 944 void (*port_stop)(struct ata_port *ap); 945 void (*host_stop)(struct ata_host *host); 946 947 #ifdef CONFIG_ATA_SFF 948 /* 949 * SFF / taskfile oriented ops 950 */ 951 void (*sff_dev_select)(struct ata_port *ap, unsigned int device); 952 void (*sff_set_devctl)(struct ata_port *ap, u8 ctl); 953 u8 (*sff_check_status)(struct ata_port *ap); 954 u8 (*sff_check_altstatus)(struct ata_port *ap); 955 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf); 956 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf); 957 void (*sff_exec_command)(struct ata_port *ap, 958 const struct ata_taskfile *tf); 959 unsigned int (*sff_data_xfer)(struct ata_device *dev, 960 unsigned char *buf, unsigned int buflen, int rw); 961 void (*sff_irq_on)(struct ata_port *); 962 bool (*sff_irq_check)(struct ata_port *); 963 void (*sff_irq_clear)(struct ata_port *); 964 void (*sff_drain_fifo)(struct ata_queued_cmd *qc); 965 966 #ifdef CONFIG_ATA_BMDMA 967 void (*bmdma_setup)(struct ata_queued_cmd *qc); 968 void (*bmdma_start)(struct ata_queued_cmd *qc); 969 void (*bmdma_stop)(struct ata_queued_cmd *qc); 970 u8 (*bmdma_status)(struct ata_port *ap); 971 #endif /* CONFIG_ATA_BMDMA */ 972 #endif /* CONFIG_ATA_SFF */ 973 974 ssize_t (*em_show)(struct ata_port *ap, char *buf); 975 ssize_t (*em_store)(struct ata_port *ap, const char *message, 976 size_t size); 977 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf); 978 ssize_t (*sw_activity_store)(struct ata_device *dev, 979 enum sw_activity val); 980 ssize_t (*transmit_led_message)(struct ata_port *ap, u32 state, 981 ssize_t size); 982 983 /* 984 * Obsolete 985 */ 986 void (*phy_reset)(struct ata_port *ap); 987 void (*eng_timeout)(struct ata_port *ap); 988 989 /* 990 * ->inherits must be the last field and all the preceding 991 * fields must be pointers. 992 */ 993 const struct ata_port_operations *inherits; 994 }; 995 996 struct ata_port_info { 997 unsigned long flags; 998 unsigned long link_flags; 999 unsigned long pio_mask; 1000 unsigned long mwdma_mask; 1001 unsigned long udma_mask; 1002 struct ata_port_operations *port_ops; 1003 void *private_data; 1004 }; 1005 1006 struct ata_timing { 1007 unsigned short mode; /* ATA mode */ 1008 unsigned short setup; /* t1 */ 1009 unsigned short act8b; /* t2 for 8-bit I/O */ 1010 unsigned short rec8b; /* t2i for 8-bit I/O */ 1011 unsigned short cyc8b; /* t0 for 8-bit I/O */ 1012 unsigned short active; /* t2 or tD */ 1013 unsigned short recover; /* t2i or tK */ 1014 unsigned short dmack_hold; /* tj */ 1015 unsigned short cycle; /* t0 */ 1016 unsigned short udma; /* t2CYCTYP/2 */ 1017 }; 1018 1019 /* 1020 * Core layer - drivers/ata/libata-core.c 1021 */ 1022 extern const unsigned long sata_deb_timing_normal[]; 1023 extern const unsigned long sata_deb_timing_hotplug[]; 1024 extern const unsigned long sata_deb_timing_long[]; 1025 1026 extern struct ata_port_operations ata_dummy_port_ops; 1027 extern const struct ata_port_info ata_dummy_port_info; 1028 1029 /* 1030 * protocol tests 1031 */ 1032 static inline unsigned int ata_prot_flags(u8 prot) 1033 { 1034 switch (prot) { 1035 case ATA_PROT_NODATA: 1036 return 0; 1037 case ATA_PROT_PIO: 1038 return ATA_PROT_FLAG_PIO; 1039 case ATA_PROT_DMA: 1040 return ATA_PROT_FLAG_DMA; 1041 case ATA_PROT_NCQ: 1042 return ATA_PROT_FLAG_DMA | ATA_PROT_FLAG_NCQ; 1043 case ATAPI_PROT_NODATA: 1044 return ATA_PROT_FLAG_ATAPI; 1045 case ATAPI_PROT_PIO: 1046 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_PIO; 1047 case ATAPI_PROT_DMA: 1048 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_DMA; 1049 } 1050 return 0; 1051 } 1052 1053 static inline int ata_is_atapi(u8 prot) 1054 { 1055 return ata_prot_flags(prot) & ATA_PROT_FLAG_ATAPI; 1056 } 1057 1058 static inline int ata_is_nodata(u8 prot) 1059 { 1060 return !(ata_prot_flags(prot) & ATA_PROT_FLAG_DATA); 1061 } 1062 1063 static inline int ata_is_pio(u8 prot) 1064 { 1065 return ata_prot_flags(prot) & ATA_PROT_FLAG_PIO; 1066 } 1067 1068 static inline int ata_is_dma(u8 prot) 1069 { 1070 return ata_prot_flags(prot) & ATA_PROT_FLAG_DMA; 1071 } 1072 1073 static inline int ata_is_ncq(u8 prot) 1074 { 1075 return ata_prot_flags(prot) & ATA_PROT_FLAG_NCQ; 1076 } 1077 1078 static inline int ata_is_data(u8 prot) 1079 { 1080 return ata_prot_flags(prot) & ATA_PROT_FLAG_DATA; 1081 } 1082 1083 static inline int is_multi_taskfile(struct ata_taskfile *tf) 1084 { 1085 return (tf->command == ATA_CMD_READ_MULTI) || 1086 (tf->command == ATA_CMD_WRITE_MULTI) || 1087 (tf->command == ATA_CMD_READ_MULTI_EXT) || 1088 (tf->command == ATA_CMD_WRITE_MULTI_EXT) || 1089 (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT); 1090 } 1091 1092 static inline const unsigned long * 1093 sata_ehc_deb_timing(struct ata_eh_context *ehc) 1094 { 1095 if (ehc->i.flags & ATA_EHI_HOTPLUGGED) 1096 return sata_deb_timing_hotplug; 1097 else 1098 return sata_deb_timing_normal; 1099 } 1100 1101 static inline int ata_port_is_dummy(struct ata_port *ap) 1102 { 1103 return ap->ops == &ata_dummy_port_ops; 1104 } 1105 1106 extern int sata_set_spd(struct ata_link *link); 1107 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline); 1108 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline, 1109 int (*check_ready)(struct ata_link *link)); 1110 extern int sata_link_debounce(struct ata_link *link, 1111 const unsigned long *params, unsigned long deadline); 1112 extern int sata_link_resume(struct ata_link *link, const unsigned long *params, 1113 unsigned long deadline); 1114 extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy, 1115 bool spm_wakeup); 1116 extern int sata_link_hardreset(struct ata_link *link, 1117 const unsigned long *timing, unsigned long deadline, 1118 bool *online, int (*check_ready)(struct ata_link *)); 1119 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class, 1120 unsigned long deadline); 1121 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes); 1122 1123 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports); 1124 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev, 1125 const struct ata_port_info * const * ppi, int n_ports); 1126 extern int ata_slave_link_init(struct ata_port *ap); 1127 extern int ata_host_start(struct ata_host *host); 1128 extern int ata_host_register(struct ata_host *host, 1129 struct scsi_host_template *sht); 1130 extern int ata_host_activate(struct ata_host *host, int irq, 1131 irq_handler_t irq_handler, unsigned long irq_flags, 1132 struct scsi_host_template *sht); 1133 extern void ata_host_detach(struct ata_host *host); 1134 extern void ata_host_init(struct ata_host *, struct device *, struct ata_port_operations *); 1135 extern int ata_scsi_detect(struct scsi_host_template *sht); 1136 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg); 1137 extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd); 1138 extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev, 1139 int cmd, void __user *arg); 1140 extern void ata_sas_port_destroy(struct ata_port *); 1141 extern struct ata_port *ata_sas_port_alloc(struct ata_host *, 1142 struct ata_port_info *, struct Scsi_Host *); 1143 extern void ata_sas_async_probe(struct ata_port *ap); 1144 extern int ata_sas_sync_probe(struct ata_port *ap); 1145 extern int ata_sas_port_init(struct ata_port *); 1146 extern int ata_sas_port_start(struct ata_port *ap); 1147 extern void ata_sas_port_stop(struct ata_port *ap); 1148 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *); 1149 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap); 1150 extern int sata_scr_valid(struct ata_link *link); 1151 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val); 1152 extern int sata_scr_write(struct ata_link *link, int reg, u32 val); 1153 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val); 1154 extern bool ata_link_online(struct ata_link *link); 1155 extern bool ata_link_offline(struct ata_link *link); 1156 #ifdef CONFIG_PM 1157 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg); 1158 extern void ata_host_resume(struct ata_host *host); 1159 extern void ata_sas_port_suspend(struct ata_port *ap); 1160 extern void ata_sas_port_resume(struct ata_port *ap); 1161 #else 1162 static inline void ata_sas_port_suspend(struct ata_port *ap) 1163 { 1164 } 1165 static inline void ata_sas_port_resume(struct ata_port *ap) 1166 { 1167 } 1168 #endif 1169 extern int ata_ratelimit(void); 1170 extern void ata_msleep(struct ata_port *ap, unsigned int msecs); 1171 extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask, 1172 u32 val, unsigned long interval, unsigned long timeout); 1173 extern int atapi_cmd_type(u8 opcode); 1174 extern void ata_tf_to_fis(const struct ata_taskfile *tf, 1175 u8 pmp, int is_cmd, u8 *fis); 1176 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf); 1177 extern unsigned long ata_pack_xfermask(unsigned long pio_mask, 1178 unsigned long mwdma_mask, unsigned long udma_mask); 1179 extern void ata_unpack_xfermask(unsigned long xfer_mask, 1180 unsigned long *pio_mask, unsigned long *mwdma_mask, 1181 unsigned long *udma_mask); 1182 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask); 1183 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode); 1184 extern int ata_xfer_mode2shift(unsigned long xfer_mode); 1185 extern const char *ata_mode_string(unsigned long xfer_mask); 1186 extern unsigned long ata_id_xfermask(const u16 *id); 1187 extern int ata_std_qc_defer(struct ata_queued_cmd *qc); 1188 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc); 1189 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg, 1190 unsigned int n_elem); 1191 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf); 1192 extern void ata_dev_disable(struct ata_device *adev); 1193 extern void ata_id_string(const u16 *id, unsigned char *s, 1194 unsigned int ofs, unsigned int len); 1195 extern void ata_id_c_string(const u16 *id, unsigned char *s, 1196 unsigned int ofs, unsigned int len); 1197 extern unsigned int ata_do_dev_read_id(struct ata_device *dev, 1198 struct ata_taskfile *tf, u16 *id); 1199 extern void ata_qc_complete(struct ata_queued_cmd *qc); 1200 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active); 1201 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd); 1202 extern int ata_std_bios_param(struct scsi_device *sdev, 1203 struct block_device *bdev, 1204 sector_t capacity, int geom[]); 1205 extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev); 1206 extern int ata_scsi_slave_config(struct scsi_device *sdev); 1207 extern void ata_scsi_slave_destroy(struct scsi_device *sdev); 1208 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev, 1209 int queue_depth); 1210 extern int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev, 1211 int queue_depth); 1212 extern struct ata_device *ata_dev_pair(struct ata_device *adev); 1213 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev); 1214 extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap); 1215 extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q); 1216 extern bool sata_lpm_ignore_phy_events(struct ata_link *link); 1217 1218 extern int ata_cable_40wire(struct ata_port *ap); 1219 extern int ata_cable_80wire(struct ata_port *ap); 1220 extern int ata_cable_sata(struct ata_port *ap); 1221 extern int ata_cable_ignore(struct ata_port *ap); 1222 extern int ata_cable_unknown(struct ata_port *ap); 1223 1224 /* Timing helpers */ 1225 extern unsigned int ata_pio_need_iordy(const struct ata_device *); 1226 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode); 1227 extern int ata_timing_compute(struct ata_device *, unsigned short, 1228 struct ata_timing *, int, int); 1229 extern void ata_timing_merge(const struct ata_timing *, 1230 const struct ata_timing *, struct ata_timing *, 1231 unsigned int); 1232 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle); 1233 1234 /* PCI */ 1235 #ifdef CONFIG_PCI 1236 struct pci_dev; 1237 1238 struct pci_bits { 1239 unsigned int reg; /* PCI config register to read */ 1240 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */ 1241 unsigned long mask; 1242 unsigned long val; 1243 }; 1244 1245 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits); 1246 extern void ata_pci_remove_one(struct pci_dev *pdev); 1247 1248 #ifdef CONFIG_PM 1249 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg); 1250 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev); 1251 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg); 1252 extern int ata_pci_device_resume(struct pci_dev *pdev); 1253 #endif /* CONFIG_PM */ 1254 #endif /* CONFIG_PCI */ 1255 1256 struct platform_device; 1257 1258 extern int ata_platform_remove_one(struct platform_device *pdev); 1259 1260 /* 1261 * ACPI - drivers/ata/libata-acpi.c 1262 */ 1263 #ifdef CONFIG_ATA_ACPI 1264 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap) 1265 { 1266 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID) 1267 return &ap->__acpi_init_gtm; 1268 return NULL; 1269 } 1270 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm); 1271 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm); 1272 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev, 1273 const struct ata_acpi_gtm *gtm); 1274 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm); 1275 #else 1276 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap) 1277 { 1278 return NULL; 1279 } 1280 1281 static inline int ata_acpi_stm(const struct ata_port *ap, 1282 struct ata_acpi_gtm *stm) 1283 { 1284 return -ENOSYS; 1285 } 1286 1287 static inline int ata_acpi_gtm(const struct ata_port *ap, 1288 struct ata_acpi_gtm *stm) 1289 { 1290 return -ENOSYS; 1291 } 1292 1293 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev, 1294 const struct ata_acpi_gtm *gtm) 1295 { 1296 return 0; 1297 } 1298 1299 static inline int ata_acpi_cbl_80wire(struct ata_port *ap, 1300 const struct ata_acpi_gtm *gtm) 1301 { 1302 return 0; 1303 } 1304 #endif 1305 1306 /* 1307 * EH - drivers/ata/libata-eh.c 1308 */ 1309 extern void ata_port_schedule_eh(struct ata_port *ap); 1310 extern void ata_port_wait_eh(struct ata_port *ap); 1311 extern int ata_link_abort(struct ata_link *link); 1312 extern int ata_port_abort(struct ata_port *ap); 1313 extern int ata_port_freeze(struct ata_port *ap); 1314 extern int sata_async_notification(struct ata_port *ap); 1315 1316 extern void ata_eh_freeze_port(struct ata_port *ap); 1317 extern void ata_eh_thaw_port(struct ata_port *ap); 1318 1319 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc); 1320 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc); 1321 extern void ata_eh_analyze_ncq_error(struct ata_link *link); 1322 1323 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset, 1324 ata_reset_fn_t softreset, ata_reset_fn_t hardreset, 1325 ata_postreset_fn_t postreset); 1326 extern void ata_std_error_handler(struct ata_port *ap); 1327 extern void ata_std_sched_eh(struct ata_port *ap); 1328 extern void ata_std_end_eh(struct ata_port *ap); 1329 extern int ata_link_nr_enabled(struct ata_link *link); 1330 1331 /* 1332 * Base operations to inherit from and initializers for sht 1333 * 1334 * Operations 1335 * 1336 * base : Common to all libata drivers. 1337 * sata : SATA controllers w/ native interface. 1338 * pmp : SATA controllers w/ PMP support. 1339 * sff : SFF ATA controllers w/o BMDMA support. 1340 * bmdma : SFF ATA controllers w/ BMDMA support. 1341 * 1342 * sht initializers 1343 * 1344 * BASE : Common to all libata drivers. The user must set 1345 * sg_tablesize and dma_boundary. 1346 * PIO : SFF ATA controllers w/ only PIO support. 1347 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and 1348 * dma_boundary are set to BMDMA limits. 1349 * NCQ : SATA controllers supporting NCQ. The user must set 1350 * sg_tablesize, dma_boundary and can_queue. 1351 */ 1352 extern const struct ata_port_operations ata_base_port_ops; 1353 extern const struct ata_port_operations sata_port_ops; 1354 extern struct device_attribute *ata_common_sdev_attrs[]; 1355 1356 /* 1357 * All sht initializers (BASE, PIO, BMDMA, NCQ) must be instantiated 1358 * by the edge drivers. Because the 'module' field of sht must be the 1359 * edge driver's module reference, otherwise the driver can be unloaded 1360 * even if the scsi_device is being accessed. 1361 */ 1362 #define ATA_BASE_SHT(drv_name) \ 1363 .module = THIS_MODULE, \ 1364 .name = drv_name, \ 1365 .ioctl = ata_scsi_ioctl, \ 1366 .queuecommand = ata_scsi_queuecmd, \ 1367 .can_queue = ATA_DEF_QUEUE, \ 1368 .tag_alloc_policy = BLK_TAG_ALLOC_RR, \ 1369 .this_id = ATA_SHT_THIS_ID, \ 1370 .emulated = ATA_SHT_EMULATED, \ 1371 .use_clustering = ATA_SHT_USE_CLUSTERING, \ 1372 .proc_name = drv_name, \ 1373 .slave_configure = ata_scsi_slave_config, \ 1374 .slave_destroy = ata_scsi_slave_destroy, \ 1375 .bios_param = ata_std_bios_param, \ 1376 .unlock_native_capacity = ata_scsi_unlock_native_capacity, \ 1377 .sdev_attrs = ata_common_sdev_attrs 1378 1379 #define ATA_NCQ_SHT(drv_name) \ 1380 ATA_BASE_SHT(drv_name), \ 1381 .change_queue_depth = ata_scsi_change_queue_depth 1382 1383 /* 1384 * PMP helpers 1385 */ 1386 #ifdef CONFIG_SATA_PMP 1387 static inline bool sata_pmp_supported(struct ata_port *ap) 1388 { 1389 return ap->flags & ATA_FLAG_PMP; 1390 } 1391 1392 static inline bool sata_pmp_attached(struct ata_port *ap) 1393 { 1394 return ap->nr_pmp_links != 0; 1395 } 1396 1397 static inline int ata_is_host_link(const struct ata_link *link) 1398 { 1399 return link == &link->ap->link || link == link->ap->slave_link; 1400 } 1401 #else /* CONFIG_SATA_PMP */ 1402 static inline bool sata_pmp_supported(struct ata_port *ap) 1403 { 1404 return false; 1405 } 1406 1407 static inline bool sata_pmp_attached(struct ata_port *ap) 1408 { 1409 return false; 1410 } 1411 1412 static inline int ata_is_host_link(const struct ata_link *link) 1413 { 1414 return 1; 1415 } 1416 #endif /* CONFIG_SATA_PMP */ 1417 1418 static inline int sata_srst_pmp(struct ata_link *link) 1419 { 1420 if (sata_pmp_supported(link->ap) && ata_is_host_link(link)) 1421 return SATA_PMP_CTRL_PORT; 1422 return link->pmp; 1423 } 1424 1425 /* 1426 * printk helpers 1427 */ 1428 __printf(3, 4) 1429 void ata_port_printk(const struct ata_port *ap, const char *level, 1430 const char *fmt, ...); 1431 __printf(3, 4) 1432 void ata_link_printk(const struct ata_link *link, const char *level, 1433 const char *fmt, ...); 1434 __printf(3, 4) 1435 void ata_dev_printk(const struct ata_device *dev, const char *level, 1436 const char *fmt, ...); 1437 1438 #define ata_port_err(ap, fmt, ...) \ 1439 ata_port_printk(ap, KERN_ERR, fmt, ##__VA_ARGS__) 1440 #define ata_port_warn(ap, fmt, ...) \ 1441 ata_port_printk(ap, KERN_WARNING, fmt, ##__VA_ARGS__) 1442 #define ata_port_notice(ap, fmt, ...) \ 1443 ata_port_printk(ap, KERN_NOTICE, fmt, ##__VA_ARGS__) 1444 #define ata_port_info(ap, fmt, ...) \ 1445 ata_port_printk(ap, KERN_INFO, fmt, ##__VA_ARGS__) 1446 #define ata_port_dbg(ap, fmt, ...) \ 1447 ata_port_printk(ap, KERN_DEBUG, fmt, ##__VA_ARGS__) 1448 1449 #define ata_link_err(link, fmt, ...) \ 1450 ata_link_printk(link, KERN_ERR, fmt, ##__VA_ARGS__) 1451 #define ata_link_warn(link, fmt, ...) \ 1452 ata_link_printk(link, KERN_WARNING, fmt, ##__VA_ARGS__) 1453 #define ata_link_notice(link, fmt, ...) \ 1454 ata_link_printk(link, KERN_NOTICE, fmt, ##__VA_ARGS__) 1455 #define ata_link_info(link, fmt, ...) \ 1456 ata_link_printk(link, KERN_INFO, fmt, ##__VA_ARGS__) 1457 #define ata_link_dbg(link, fmt, ...) \ 1458 ata_link_printk(link, KERN_DEBUG, fmt, ##__VA_ARGS__) 1459 1460 #define ata_dev_err(dev, fmt, ...) \ 1461 ata_dev_printk(dev, KERN_ERR, fmt, ##__VA_ARGS__) 1462 #define ata_dev_warn(dev, fmt, ...) \ 1463 ata_dev_printk(dev, KERN_WARNING, fmt, ##__VA_ARGS__) 1464 #define ata_dev_notice(dev, fmt, ...) \ 1465 ata_dev_printk(dev, KERN_NOTICE, fmt, ##__VA_ARGS__) 1466 #define ata_dev_info(dev, fmt, ...) \ 1467 ata_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__) 1468 #define ata_dev_dbg(dev, fmt, ...) \ 1469 ata_dev_printk(dev, KERN_DEBUG, fmt, ##__VA_ARGS__) 1470 1471 void ata_print_version(const struct device *dev, const char *version); 1472 1473 /* 1474 * ata_eh_info helpers 1475 */ 1476 extern __printf(2, 3) 1477 void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...); 1478 extern __printf(2, 3) 1479 void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...); 1480 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi); 1481 1482 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi) 1483 { 1484 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1; 1485 ehi->flags |= ATA_EHI_HOTPLUGGED; 1486 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK; 1487 ehi->err_mask |= AC_ERR_ATA_BUS; 1488 } 1489 1490 /* 1491 * port description helpers 1492 */ 1493 extern __printf(2, 3) 1494 void ata_port_desc(struct ata_port *ap, const char *fmt, ...); 1495 #ifdef CONFIG_PCI 1496 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset, 1497 const char *name); 1498 #endif 1499 1500 static inline unsigned int ata_tag_valid(unsigned int tag) 1501 { 1502 return (tag < ATA_MAX_QUEUE) ? 1 : 0; 1503 } 1504 1505 static inline unsigned int ata_tag_internal(unsigned int tag) 1506 { 1507 return tag == ATA_TAG_INTERNAL; 1508 } 1509 1510 /* 1511 * device helpers 1512 */ 1513 static inline unsigned int ata_class_enabled(unsigned int class) 1514 { 1515 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI || 1516 class == ATA_DEV_PMP || class == ATA_DEV_SEMB || 1517 class == ATA_DEV_ZAC; 1518 } 1519 1520 static inline unsigned int ata_class_disabled(unsigned int class) 1521 { 1522 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP || 1523 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP; 1524 } 1525 1526 static inline unsigned int ata_class_absent(unsigned int class) 1527 { 1528 return !ata_class_enabled(class) && !ata_class_disabled(class); 1529 } 1530 1531 static inline unsigned int ata_dev_enabled(const struct ata_device *dev) 1532 { 1533 return ata_class_enabled(dev->class); 1534 } 1535 1536 static inline unsigned int ata_dev_disabled(const struct ata_device *dev) 1537 { 1538 return ata_class_disabled(dev->class); 1539 } 1540 1541 static inline unsigned int ata_dev_absent(const struct ata_device *dev) 1542 { 1543 return ata_class_absent(dev->class); 1544 } 1545 1546 /* 1547 * link helpers 1548 */ 1549 static inline int ata_link_max_devices(const struct ata_link *link) 1550 { 1551 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS) 1552 return 2; 1553 return 1; 1554 } 1555 1556 static inline int ata_link_active(struct ata_link *link) 1557 { 1558 return ata_tag_valid(link->active_tag) || link->sactive; 1559 } 1560 1561 /* 1562 * Iterators 1563 * 1564 * ATA_LITER_* constants are used to select link iteration mode and 1565 * ATA_DITER_* device iteration mode. 1566 * 1567 * For a custom iteration directly using ata_{link|dev}_next(), if 1568 * @link or @dev, respectively, is NULL, the first element is 1569 * returned. @dev and @link can be any valid device or link and the 1570 * next element according to the iteration mode will be returned. 1571 * After the last element, NULL is returned. 1572 */ 1573 enum ata_link_iter_mode { 1574 ATA_LITER_EDGE, /* if present, PMP links only; otherwise, 1575 * host link. no slave link */ 1576 ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */ 1577 ATA_LITER_PMP_FIRST, /* PMP links followed by host link, 1578 * slave link still comes after host link */ 1579 }; 1580 1581 enum ata_dev_iter_mode { 1582 ATA_DITER_ENABLED, 1583 ATA_DITER_ENABLED_REVERSE, 1584 ATA_DITER_ALL, 1585 ATA_DITER_ALL_REVERSE, 1586 }; 1587 1588 extern struct ata_link *ata_link_next(struct ata_link *link, 1589 struct ata_port *ap, 1590 enum ata_link_iter_mode mode); 1591 1592 extern struct ata_device *ata_dev_next(struct ata_device *dev, 1593 struct ata_link *link, 1594 enum ata_dev_iter_mode mode); 1595 1596 /* 1597 * Shortcut notation for iterations 1598 * 1599 * ata_for_each_link() iterates over each link of @ap according to 1600 * @mode. @link points to the current link in the loop. @link is 1601 * NULL after loop termination. ata_for_each_dev() works the same way 1602 * except that it iterates over each device of @link. 1603 * 1604 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be 1605 * specified when using the following shorthand notations. Only the 1606 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be 1607 * specified. This not only increases brevity but also makes it 1608 * impossible to use ATA_LITER_* for device iteration or vice-versa. 1609 */ 1610 #define ata_for_each_link(link, ap, mode) \ 1611 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \ 1612 (link) = ata_link_next((link), (ap), ATA_LITER_##mode)) 1613 1614 #define ata_for_each_dev(dev, link, mode) \ 1615 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \ 1616 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode)) 1617 1618 /** 1619 * ata_ncq_enabled - Test whether NCQ is enabled 1620 * @dev: ATA device to test for 1621 * 1622 * LOCKING: 1623 * spin_lock_irqsave(host lock) 1624 * 1625 * RETURNS: 1626 * 1 if NCQ is enabled for @dev, 0 otherwise. 1627 */ 1628 static inline int ata_ncq_enabled(struct ata_device *dev) 1629 { 1630 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF | 1631 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ; 1632 } 1633 1634 static inline bool ata_fpdma_dsm_supported(struct ata_device *dev) 1635 { 1636 return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) && 1637 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] & 1638 ATA_LOG_NCQ_SEND_RECV_DSM_TRIM); 1639 } 1640 1641 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc) 1642 { 1643 qc->tf.ctl |= ATA_NIEN; 1644 } 1645 1646 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap, 1647 unsigned int tag) 1648 { 1649 if (likely(ata_tag_valid(tag))) 1650 return &ap->qcmd[tag]; 1651 return NULL; 1652 } 1653 1654 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap, 1655 unsigned int tag) 1656 { 1657 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag); 1658 1659 if (unlikely(!qc) || !ap->ops->error_handler) 1660 return qc; 1661 1662 if ((qc->flags & (ATA_QCFLAG_ACTIVE | 1663 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE) 1664 return qc; 1665 1666 return NULL; 1667 } 1668 1669 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc) 1670 { 1671 return qc->nbytes - min(qc->extrabytes, qc->nbytes); 1672 } 1673 1674 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf) 1675 { 1676 memset(tf, 0, sizeof(*tf)); 1677 1678 #ifdef CONFIG_ATA_SFF 1679 tf->ctl = dev->link->ap->ctl; 1680 #else 1681 tf->ctl = ATA_DEVCTL_OBS; 1682 #endif 1683 if (dev->devno == 0) 1684 tf->device = ATA_DEVICE_OBS; 1685 else 1686 tf->device = ATA_DEVICE_OBS | ATA_DEV1; 1687 } 1688 1689 static inline void ata_qc_reinit(struct ata_queued_cmd *qc) 1690 { 1691 qc->dma_dir = DMA_NONE; 1692 qc->sg = NULL; 1693 qc->flags = 0; 1694 qc->cursg = NULL; 1695 qc->cursg_ofs = 0; 1696 qc->nbytes = qc->extrabytes = qc->curbytes = 0; 1697 qc->n_elem = 0; 1698 qc->err_mask = 0; 1699 qc->sect_size = ATA_SECT_SIZE; 1700 1701 ata_tf_init(qc->dev, &qc->tf); 1702 1703 /* init result_tf such that it indicates normal completion */ 1704 qc->result_tf.command = ATA_DRDY; 1705 qc->result_tf.feature = 0; 1706 } 1707 1708 static inline int ata_try_flush_cache(const struct ata_device *dev) 1709 { 1710 return ata_id_wcache_enabled(dev->id) || 1711 ata_id_has_flush(dev->id) || 1712 ata_id_has_flush_ext(dev->id); 1713 } 1714 1715 static inline unsigned int ac_err_mask(u8 status) 1716 { 1717 if (status & (ATA_BUSY | ATA_DRQ)) 1718 return AC_ERR_HSM; 1719 if (status & (ATA_ERR | ATA_DF)) 1720 return AC_ERR_DEV; 1721 return 0; 1722 } 1723 1724 static inline unsigned int __ac_err_mask(u8 status) 1725 { 1726 unsigned int mask = ac_err_mask(status); 1727 if (mask == 0) 1728 return AC_ERR_OTHER; 1729 return mask; 1730 } 1731 1732 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host) 1733 { 1734 return *(struct ata_port **)&host->hostdata[0]; 1735 } 1736 1737 static inline int ata_check_ready(u8 status) 1738 { 1739 if (!(status & ATA_BUSY)) 1740 return 1; 1741 1742 /* 0xff indicates either no device or device not ready */ 1743 if (status == 0xff) 1744 return -ENODEV; 1745 1746 return 0; 1747 } 1748 1749 static inline unsigned long ata_deadline(unsigned long from_jiffies, 1750 unsigned long timeout_msecs) 1751 { 1752 return from_jiffies + msecs_to_jiffies(timeout_msecs); 1753 } 1754 1755 /* Don't open code these in drivers as there are traps. Firstly the range may 1756 change in future hardware and specs, secondly 0xFF means 'no DMA' but is 1757 > UDMA_0. Dyma ddreigiau */ 1758 1759 static inline int ata_using_mwdma(struct ata_device *adev) 1760 { 1761 if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4) 1762 return 1; 1763 return 0; 1764 } 1765 1766 static inline int ata_using_udma(struct ata_device *adev) 1767 { 1768 if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7) 1769 return 1; 1770 return 0; 1771 } 1772 1773 static inline int ata_dma_enabled(struct ata_device *adev) 1774 { 1775 return (adev->dma_mode == 0xFF ? 0 : 1); 1776 } 1777 1778 /************************************************************************** 1779 * PMP - drivers/ata/libata-pmp.c 1780 */ 1781 #ifdef CONFIG_SATA_PMP 1782 1783 extern const struct ata_port_operations sata_pmp_port_ops; 1784 1785 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc); 1786 extern void sata_pmp_error_handler(struct ata_port *ap); 1787 1788 #else /* CONFIG_SATA_PMP */ 1789 1790 #define sata_pmp_port_ops sata_port_ops 1791 #define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer 1792 #define sata_pmp_error_handler ata_std_error_handler 1793 1794 #endif /* CONFIG_SATA_PMP */ 1795 1796 1797 /************************************************************************** 1798 * SFF - drivers/ata/libata-sff.c 1799 */ 1800 #ifdef CONFIG_ATA_SFF 1801 1802 extern const struct ata_port_operations ata_sff_port_ops; 1803 extern const struct ata_port_operations ata_bmdma32_port_ops; 1804 1805 /* PIO only, sg_tablesize and dma_boundary limits can be removed */ 1806 #define ATA_PIO_SHT(drv_name) \ 1807 ATA_BASE_SHT(drv_name), \ 1808 .sg_tablesize = LIBATA_MAX_PRD, \ 1809 .dma_boundary = ATA_DMA_BOUNDARY 1810 1811 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device); 1812 extern u8 ata_sff_check_status(struct ata_port *ap); 1813 extern void ata_sff_pause(struct ata_port *ap); 1814 extern void ata_sff_dma_pause(struct ata_port *ap); 1815 extern int ata_sff_busy_sleep(struct ata_port *ap, 1816 unsigned long timeout_pat, unsigned long timeout); 1817 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline); 1818 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf); 1819 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf); 1820 extern void ata_sff_exec_command(struct ata_port *ap, 1821 const struct ata_taskfile *tf); 1822 extern unsigned int ata_sff_data_xfer(struct ata_device *dev, 1823 unsigned char *buf, unsigned int buflen, int rw); 1824 extern unsigned int ata_sff_data_xfer32(struct ata_device *dev, 1825 unsigned char *buf, unsigned int buflen, int rw); 1826 extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev, 1827 unsigned char *buf, unsigned int buflen, int rw); 1828 extern void ata_sff_irq_on(struct ata_port *ap); 1829 extern void ata_sff_irq_clear(struct ata_port *ap); 1830 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc, 1831 u8 status, int in_wq); 1832 extern void ata_sff_queue_work(struct work_struct *work); 1833 extern void ata_sff_queue_delayed_work(struct delayed_work *dwork, 1834 unsigned long delay); 1835 extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay); 1836 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc); 1837 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc); 1838 extern unsigned int ata_sff_port_intr(struct ata_port *ap, 1839 struct ata_queued_cmd *qc); 1840 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance); 1841 extern void ata_sff_lost_interrupt(struct ata_port *ap); 1842 extern void ata_sff_freeze(struct ata_port *ap); 1843 extern void ata_sff_thaw(struct ata_port *ap); 1844 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline); 1845 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present, 1846 u8 *r_err); 1847 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask, 1848 unsigned long deadline); 1849 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes, 1850 unsigned long deadline); 1851 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class, 1852 unsigned long deadline); 1853 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes); 1854 extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc); 1855 extern void ata_sff_error_handler(struct ata_port *ap); 1856 extern void ata_sff_std_ports(struct ata_ioports *ioaddr); 1857 #ifdef CONFIG_PCI 1858 extern int ata_pci_sff_init_host(struct ata_host *host); 1859 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev, 1860 const struct ata_port_info * const * ppi, 1861 struct ata_host **r_host); 1862 extern int ata_pci_sff_activate_host(struct ata_host *host, 1863 irq_handler_t irq_handler, 1864 struct scsi_host_template *sht); 1865 extern int ata_pci_sff_init_one(struct pci_dev *pdev, 1866 const struct ata_port_info * const * ppi, 1867 struct scsi_host_template *sht, void *host_priv, int hflags); 1868 #endif /* CONFIG_PCI */ 1869 1870 #ifdef CONFIG_ATA_BMDMA 1871 1872 extern const struct ata_port_operations ata_bmdma_port_ops; 1873 1874 #define ATA_BMDMA_SHT(drv_name) \ 1875 ATA_BASE_SHT(drv_name), \ 1876 .sg_tablesize = LIBATA_MAX_PRD, \ 1877 .dma_boundary = ATA_DMA_BOUNDARY 1878 1879 extern void ata_bmdma_qc_prep(struct ata_queued_cmd *qc); 1880 extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc); 1881 extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc); 1882 extern unsigned int ata_bmdma_port_intr(struct ata_port *ap, 1883 struct ata_queued_cmd *qc); 1884 extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance); 1885 extern void ata_bmdma_error_handler(struct ata_port *ap); 1886 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc); 1887 extern void ata_bmdma_irq_clear(struct ata_port *ap); 1888 extern void ata_bmdma_setup(struct ata_queued_cmd *qc); 1889 extern void ata_bmdma_start(struct ata_queued_cmd *qc); 1890 extern void ata_bmdma_stop(struct ata_queued_cmd *qc); 1891 extern u8 ata_bmdma_status(struct ata_port *ap); 1892 extern int ata_bmdma_port_start(struct ata_port *ap); 1893 extern int ata_bmdma_port_start32(struct ata_port *ap); 1894 1895 #ifdef CONFIG_PCI 1896 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev); 1897 extern void ata_pci_bmdma_init(struct ata_host *host); 1898 extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev, 1899 const struct ata_port_info * const * ppi, 1900 struct ata_host **r_host); 1901 extern int ata_pci_bmdma_init_one(struct pci_dev *pdev, 1902 const struct ata_port_info * const * ppi, 1903 struct scsi_host_template *sht, 1904 void *host_priv, int hflags); 1905 #endif /* CONFIG_PCI */ 1906 #endif /* CONFIG_ATA_BMDMA */ 1907 1908 /** 1909 * ata_sff_busy_wait - Wait for a port status register 1910 * @ap: Port to wait for. 1911 * @bits: bits that must be clear 1912 * @max: number of 10uS waits to perform 1913 * 1914 * Waits up to max*10 microseconds for the selected bits in the port's 1915 * status register to be cleared. 1916 * Returns final value of status register. 1917 * 1918 * LOCKING: 1919 * Inherited from caller. 1920 */ 1921 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits, 1922 unsigned int max) 1923 { 1924 u8 status; 1925 1926 do { 1927 udelay(10); 1928 status = ap->ops->sff_check_status(ap); 1929 max--; 1930 } while (status != 0xff && (status & bits) && (max > 0)); 1931 1932 return status; 1933 } 1934 1935 /** 1936 * ata_wait_idle - Wait for a port to be idle. 1937 * @ap: Port to wait for. 1938 * 1939 * Waits up to 10ms for port's BUSY and DRQ signals to clear. 1940 * Returns final value of status register. 1941 * 1942 * LOCKING: 1943 * Inherited from caller. 1944 */ 1945 static inline u8 ata_wait_idle(struct ata_port *ap) 1946 { 1947 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000); 1948 1949 #ifdef ATA_DEBUG 1950 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) 1951 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n", 1952 status); 1953 #endif 1954 1955 return status; 1956 } 1957 #endif /* CONFIG_ATA_SFF */ 1958 1959 #endif /* __LINUX_LIBATA_H__ */ 1960