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