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