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