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