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