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