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