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