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