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