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