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