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