libata.h revision 05944bdf6fadb5394710269df6770dde447b23ca
1/* 2 * Copyright 2003-2005 Red Hat, Inc. All rights reserved. 3 * Copyright 2003-2005 Jeff Garzik 4 * 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation; either version 2, or (at your option) 9 * any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License 17 * along with this program; see the file COPYING. If not, write to 18 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 19 * 20 * 21 * libata documentation is available via 'make {ps|pdf}docs', 22 * as Documentation/DocBook/libata.* 23 * 24 */ 25 26#ifndef __LINUX_LIBATA_H__ 27#define __LINUX_LIBATA_H__ 28 29#include <linux/delay.h> 30#include <linux/jiffies.h> 31#include <linux/interrupt.h> 32#include <linux/dma-mapping.h> 33#include <linux/scatterlist.h> 34#include <linux/io.h> 35#include <linux/ata.h> 36#include <linux/workqueue.h> 37#include <scsi/scsi_host.h> 38#include <linux/acpi.h> 39#include <linux/cdrom.h> 40 41/* 42 * Define if arch has non-standard setup. This is a _PCI_ standard 43 * not a legacy or ISA standard. 44 */ 45#ifdef CONFIG_ATA_NONSTANDARD 46#include <asm/libata-portmap.h> 47#else 48#include <asm-generic/libata-portmap.h> 49#endif 50 51/* 52 * compile-time options: to be removed as soon as all the drivers are 53 * converted to the new debugging mechanism 54 */ 55#undef ATA_DEBUG /* debugging output */ 56#undef ATA_VERBOSE_DEBUG /* yet more debugging output */ 57#undef ATA_IRQ_TRAP /* define to ack screaming irqs */ 58#undef ATA_NDEBUG /* define to disable quick runtime checks */ 59 60 61/* note: prints function name for you */ 62#ifdef ATA_DEBUG 63#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args) 64#ifdef ATA_VERBOSE_DEBUG 65#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args) 66#else 67#define VPRINTK(fmt, args...) 68#endif /* ATA_VERBOSE_DEBUG */ 69#else 70#define DPRINTK(fmt, args...) 71#define VPRINTK(fmt, args...) 72#endif /* ATA_DEBUG */ 73 74#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args) 75 76/* NEW: debug levels */ 77#define HAVE_LIBATA_MSG 1 78 79enum { 80 ATA_MSG_DRV = 0x0001, 81 ATA_MSG_INFO = 0x0002, 82 ATA_MSG_PROBE = 0x0004, 83 ATA_MSG_WARN = 0x0008, 84 ATA_MSG_MALLOC = 0x0010, 85 ATA_MSG_CTL = 0x0020, 86 ATA_MSG_INTR = 0x0040, 87 ATA_MSG_ERR = 0x0080, 88}; 89 90#define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV) 91#define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO) 92#define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE) 93#define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN) 94#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC) 95#define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL) 96#define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR) 97#define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR) 98 99static inline u32 ata_msg_init(int dval, int default_msg_enable_bits) 100{ 101 if (dval < 0 || dval >= (sizeof(u32) * 8)) 102 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */ 103 if (!dval) 104 return 0; 105 return (1 << dval) - 1; 106} 107 108/* defines only for the constants which don't work well as enums */ 109#define ATA_TAG_POISON 0xfafbfcfdU 110 111enum { 112 /* various global constants */ 113 LIBATA_MAX_PRD = ATA_MAX_PRD / 2, 114 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */ 115 ATA_DEF_QUEUE = 1, 116 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */ 117 ATA_MAX_QUEUE = 32, 118 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1, 119 ATA_SHORT_PAUSE = 16, 120 121 ATAPI_MAX_DRAIN = 16 << 10, 122 123 ATA_ALL_DEVICES = (1 << ATA_MAX_DEVICES) - 1, 124 125 ATA_SHT_EMULATED = 1, 126 ATA_SHT_CMD_PER_LUN = 1, 127 ATA_SHT_THIS_ID = -1, 128 ATA_SHT_USE_CLUSTERING = 1, 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_HIPM = (1 << 8), /* device supports HIPM */ 140 ATA_DFLAG_DIPM = (1 << 9), /* device supports DIPM */ 141 ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */ 142 ATA_DFLAG_CFG_MASK = (1 << 12) - 1, 143 144 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */ 145 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */ 146 ATA_DFLAG_SPUNDOWN = (1 << 14), /* XXX: for spindown_compat */ 147 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */ 148 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */ 149 ATA_DFLAG_INIT_MASK = (1 << 24) - 1, 150 151 ATA_DFLAG_DETACH = (1 << 24), 152 ATA_DFLAG_DETACHED = (1 << 25), 153 154 ATA_DEV_UNKNOWN = 0, /* unknown device */ 155 ATA_DEV_ATA = 1, /* ATA device */ 156 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */ 157 ATA_DEV_ATAPI = 3, /* ATAPI device */ 158 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */ 159 ATA_DEV_PMP = 5, /* SATA port multiplier */ 160 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */ 161 ATA_DEV_SEMB = 7, /* SEMB */ 162 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */ 163 ATA_DEV_NONE = 9, /* no device */ 164 165 /* struct ata_link flags */ 166 ATA_LFLAG_NO_HRST = (1 << 1), /* avoid hardreset */ 167 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */ 168 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */ 169 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */ 170 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB, 171 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */ 172 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */ 173 ATA_LFLAG_SW_ACTIVITY = (1 << 7), /* keep activity stats */ 174 175 /* struct ata_port flags */ 176 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */ 177 /* (doesn't imply presence) */ 178 ATA_FLAG_SATA = (1 << 1), 179 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */ 180 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */ 181 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */ 182 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */ 183 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */ 184 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */ 185 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */ 186 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD 187 * doesn't handle PIO interrupts */ 188 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */ 189 ATA_FLAG_DEBUGMSG = (1 << 13), 190 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */ 191 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */ 192 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */ 193 ATA_FLAG_AN = (1 << 18), /* controller supports AN */ 194 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */ 195 ATA_FLAG_IPM = (1 << 20), /* driver can handle IPM */ 196 ATA_FLAG_EM = (1 << 21), /* driver supports enclosure 197 * management */ 198 ATA_FLAG_SW_ACTIVITY = (1 << 22), /* driver supports sw activity 199 * led */ 200 201 /* The following flag belongs to ap->pflags but is kept in 202 * ap->flags because it's referenced in many LLDs and will be 203 * removed in not-too-distant future. 204 */ 205 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */ 206 207 /* bits 24:31 of ap->flags are reserved for LLD specific flags */ 208 209 /* struct ata_port pflags */ 210 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */ 211 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */ 212 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */ 213 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */ 214 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */ 215 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */ 216 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */ 217 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */ 218 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */ 219 220 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */ 221 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */ 222 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */ 223 224 /* struct ata_queued_cmd flags */ 225 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */ 226 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */ 227 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */ 228 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */ 229 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */ 230 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */ 231 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */ 232 233 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */ 234 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */ 235 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */ 236 237 /* host set flags */ 238 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */ 239 ATA_HOST_STARTED = (1 << 1), /* Host started */ 240 241 /* bits 24:31 of host->flags are reserved for LLD specific flags */ 242 243 /* various lengths of time */ 244 ATA_TMOUT_BOOT = 30000, /* heuristic */ 245 ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */ 246 ATA_TMOUT_INTERNAL_QUICK = 5000, 247 248 /* FIXME: GoVault needs 2s but we can't afford that without 249 * parallel probing. 800ms is enough for iVDR disk 250 * HHD424020F7SV00. Increase to 2secs when parallel probing 251 * is in place. 252 */ 253 ATA_TMOUT_FF_WAIT = 800, 254 255 /* Spec mandates to wait for ">= 2ms" before checking status 256 * after reset. We wait 150ms, because that was the magic 257 * delay used for ATAPI devices in Hale Landis's ATADRVR, for 258 * the period of time between when the ATA command register is 259 * written, and then status is checked. Because waiting for 260 * "a while" before checking status is fine, post SRST, we 261 * perform this magic delay here as well. 262 * 263 * Old drivers/ide uses the 2mS rule and then waits for ready. 264 */ 265 ATA_WAIT_AFTER_RESET = 150, 266 267 /* If PMP is supported, we have to do follow-up SRST. As some 268 * PMPs don't send D2H Reg FIS after hardreset, LLDs are 269 * advised to wait only for the following duration before 270 * doing SRST. 271 */ 272 ATA_TMOUT_PMP_SRST_WAIT = 1000, 273 274 /* ATA bus states */ 275 BUS_UNKNOWN = 0, 276 BUS_DMA = 1, 277 BUS_IDLE = 2, 278 BUS_NOINTR = 3, 279 BUS_NODATA = 4, 280 BUS_TIMER = 5, 281 BUS_PIO = 6, 282 BUS_EDD = 7, 283 BUS_IDENTIFY = 8, 284 BUS_PACKET = 9, 285 286 /* SATA port states */ 287 PORT_UNKNOWN = 0, 288 PORT_ENABLED = 1, 289 PORT_DISABLED = 2, 290 291 /* encoding various smaller bitmaps into a single 292 * unsigned long bitmap 293 */ 294 ATA_NR_PIO_MODES = 7, 295 ATA_NR_MWDMA_MODES = 5, 296 ATA_NR_UDMA_MODES = 8, 297 298 ATA_SHIFT_PIO = 0, 299 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES, 300 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES, 301 302 /* size of buffer to pad xfers ending on unaligned boundaries */ 303 ATA_DMA_PAD_SZ = 4, 304 305 /* ering size */ 306 ATA_ERING_SIZE = 32, 307 308 /* return values for ->qc_defer */ 309 ATA_DEFER_LINK = 1, 310 ATA_DEFER_PORT = 2, 311 312 /* desc_len for ata_eh_info and context */ 313 ATA_EH_DESC_LEN = 80, 314 315 /* reset / recovery action types */ 316 ATA_EH_REVALIDATE = (1 << 0), 317 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */ 318 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */ 319 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET, 320 ATA_EH_ENABLE_LINK = (1 << 3), 321 ATA_EH_LPM = (1 << 4), /* link power management action */ 322 323 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE, 324 325 /* ata_eh_info->flags */ 326 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */ 327 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */ 328 ATA_EHI_QUIET = (1 << 3), /* be quiet */ 329 330 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */ 331 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */ 332 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */ 333 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */ 334 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */ 335 336 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET, 337 338 /* max tries if error condition is still set after ->error_handler */ 339 ATA_EH_MAX_TRIES = 5, 340 341 /* how hard are we gonna try to probe/recover devices */ 342 ATA_PROBE_MAX_TRIES = 3, 343 ATA_EH_DEV_TRIES = 3, 344 ATA_EH_PMP_TRIES = 5, 345 ATA_EH_PMP_LINK_TRIES = 3, 346 347 SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */ 348 349 /* This should match the actual table size of 350 * ata_eh_cmd_timeout_table in libata-eh.c. 351 */ 352 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 5, 353 354 /* Horkage types. May be set by libata or controller on drives 355 (some horkage may be drive/controller pair dependant */ 356 357 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */ 358 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */ 359 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */ 360 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */ 361 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */ 362 ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */ 363 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */ 364 ATA_HORKAGE_IPM = (1 << 7), /* Link PM problems */ 365 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */ 366 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */ 367 368 /* DMA mask for user DMA control: User visible values; DO NOT 369 renumber */ 370 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */ 371 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */ 372 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */ 373 374 /* ATAPI command types */ 375 ATAPI_READ = 0, /* READs */ 376 ATAPI_WRITE = 1, /* WRITEs */ 377 ATAPI_READ_CD = 2, /* READ CD [MSF] */ 378 ATAPI_PASS_THRU = 3, /* SAT pass-thru */ 379 ATAPI_MISC = 4, /* the rest */ 380 381 /* Timing constants */ 382 ATA_TIMING_SETUP = (1 << 0), 383 ATA_TIMING_ACT8B = (1 << 1), 384 ATA_TIMING_REC8B = (1 << 2), 385 ATA_TIMING_CYC8B = (1 << 3), 386 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B | 387 ATA_TIMING_CYC8B, 388 ATA_TIMING_ACTIVE = (1 << 4), 389 ATA_TIMING_RECOVER = (1 << 5), 390 ATA_TIMING_CYCLE = (1 << 6), 391 ATA_TIMING_UDMA = (1 << 7), 392 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B | 393 ATA_TIMING_REC8B | ATA_TIMING_CYC8B | 394 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER | 395 ATA_TIMING_CYCLE | ATA_TIMING_UDMA, 396}; 397 398enum ata_xfer_mask { 399 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1) 400 << ATA_SHIFT_PIO, 401 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1) 402 << ATA_SHIFT_MWDMA, 403 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1) 404 << ATA_SHIFT_UDMA, 405}; 406 407enum hsm_task_states { 408 HSM_ST_IDLE, /* no command on going */ 409 HSM_ST_FIRST, /* (waiting the device to) 410 write CDB or first data block */ 411 HSM_ST, /* (waiting the device to) transfer data */ 412 HSM_ST_LAST, /* (waiting the device to) complete command */ 413 HSM_ST_ERR, /* error */ 414}; 415 416enum ata_completion_errors { 417 AC_ERR_DEV = (1 << 0), /* device reported error */ 418 AC_ERR_HSM = (1 << 1), /* host state machine violation */ 419 AC_ERR_TIMEOUT = (1 << 2), /* timeout */ 420 AC_ERR_MEDIA = (1 << 3), /* media error */ 421 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */ 422 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */ 423 AC_ERR_SYSTEM = (1 << 6), /* system error */ 424 AC_ERR_INVALID = (1 << 7), /* invalid argument */ 425 AC_ERR_OTHER = (1 << 8), /* unknown */ 426 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */ 427 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */ 428}; 429 430/* forward declarations */ 431struct scsi_device; 432struct ata_port_operations; 433struct ata_port; 434struct ata_link; 435struct ata_queued_cmd; 436 437/* typedefs */ 438typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc); 439typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline); 440typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes, 441 unsigned long deadline); 442typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes); 443 444/* 445 * host pm policy: If you alter this, you also need to alter libata-scsi.c 446 * (for the ascii descriptions) 447 */ 448enum link_pm { 449 NOT_AVAILABLE, 450 MIN_POWER, 451 MAX_PERFORMANCE, 452 MEDIUM_POWER, 453}; 454extern struct device_attribute dev_attr_link_power_management_policy; 455extern struct device_attribute dev_attr_em_message_type; 456extern struct device_attribute dev_attr_em_message; 457extern struct device_attribute dev_attr_sw_activity; 458 459enum sw_activity { 460 OFF, 461 BLINK_ON, 462 BLINK_OFF, 463}; 464 465#ifdef CONFIG_ATA_SFF 466struct ata_ioports { 467 void __iomem *cmd_addr; 468 void __iomem *data_addr; 469 void __iomem *error_addr; 470 void __iomem *feature_addr; 471 void __iomem *nsect_addr; 472 void __iomem *lbal_addr; 473 void __iomem *lbam_addr; 474 void __iomem *lbah_addr; 475 void __iomem *device_addr; 476 void __iomem *status_addr; 477 void __iomem *command_addr; 478 void __iomem *altstatus_addr; 479 void __iomem *ctl_addr; 480 void __iomem *bmdma_addr; 481 void __iomem *scr_addr; 482}; 483#endif /* CONFIG_ATA_SFF */ 484 485struct ata_host { 486 spinlock_t lock; 487 struct device *dev; 488 void __iomem * const *iomap; 489 unsigned int n_ports; 490 void *private_data; 491 struct ata_port_operations *ops; 492 unsigned long flags; 493#ifdef CONFIG_ATA_ACPI 494 acpi_handle acpi_handle; 495#endif 496 struct ata_port *simplex_claimed; /* channel owning the DMA */ 497 struct ata_port *ports[0]; 498}; 499 500struct ata_queued_cmd { 501 struct ata_port *ap; 502 struct ata_device *dev; 503 504 struct scsi_cmnd *scsicmd; 505 void (*scsidone)(struct scsi_cmnd *); 506 507 struct ata_taskfile tf; 508 u8 cdb[ATAPI_CDB_LEN]; 509 510 unsigned long flags; /* ATA_QCFLAG_xxx */ 511 unsigned int tag; 512 unsigned int n_elem; 513 514 int dma_dir; 515 516 unsigned int sect_size; 517 518 unsigned int nbytes; 519 unsigned int extrabytes; 520 unsigned int curbytes; 521 522 struct scatterlist *cursg; 523 unsigned int cursg_ofs; 524 525 struct scatterlist sgent; 526 527 struct scatterlist *sg; 528 529 unsigned int err_mask; 530 struct ata_taskfile result_tf; 531 ata_qc_cb_t complete_fn; 532 533 void *private_data; 534 void *lldd_task; 535}; 536 537struct ata_port_stats { 538 unsigned long unhandled_irq; 539 unsigned long idle_irq; 540 unsigned long rw_reqbuf; 541}; 542 543struct ata_ering_entry { 544 unsigned int eflags; 545 unsigned int err_mask; 546 u64 timestamp; 547}; 548 549struct ata_ering { 550 int cursor; 551 struct ata_ering_entry ring[ATA_ERING_SIZE]; 552}; 553 554struct ata_device { 555 struct ata_link *link; 556 unsigned int devno; /* 0 or 1 */ 557 unsigned long flags; /* ATA_DFLAG_xxx */ 558 unsigned int horkage; /* List of broken features */ 559 struct scsi_device *sdev; /* attached SCSI device */ 560#ifdef CONFIG_ATA_ACPI 561 acpi_handle acpi_handle; 562 union acpi_object *gtf_cache; 563#endif 564 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */ 565 u64 n_sectors; /* size of device, if ATA */ 566 unsigned int class; /* ATA_DEV_xxx */ 567 568 u8 pio_mode; 569 u8 dma_mode; 570 u8 xfer_mode; 571 unsigned int xfer_shift; /* ATA_SHIFT_xxx */ 572 573 unsigned int multi_count; /* sectors count for 574 READ/WRITE MULTIPLE */ 575 unsigned int max_sectors; /* per-device max sectors */ 576 unsigned int cdb_len; 577 578 /* per-dev xfer mask */ 579 unsigned long pio_mask; 580 unsigned long mwdma_mask; 581 unsigned long udma_mask; 582 583 /* for CHS addressing */ 584 u16 cylinders; /* Number of cylinders */ 585 u16 heads; /* Number of heads */ 586 u16 sectors; /* Number of sectors per track */ 587 588 /* error history */ 589 int spdn_cnt; 590 struct ata_ering ering; 591 592 union { 593 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */ 594 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */ 595 }; 596}; 597 598/* Offset into struct ata_device. Fields above it are maintained 599 * acress device init. Fields below are zeroed. 600 */ 601#define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors) 602 603struct ata_eh_info { 604 struct ata_device *dev; /* offending device */ 605 u32 serror; /* SError from LLDD */ 606 unsigned int err_mask; /* port-wide err_mask */ 607 unsigned int action; /* ATA_EH_* action mask */ 608 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */ 609 unsigned int flags; /* ATA_EHI_* flags */ 610 611 unsigned int probe_mask; 612 613 char desc[ATA_EH_DESC_LEN]; 614 int desc_len; 615}; 616 617struct ata_eh_context { 618 struct ata_eh_info i; 619 int tries[ATA_MAX_DEVICES]; 620 int cmd_timeout_idx[ATA_MAX_DEVICES] 621 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE]; 622 unsigned int classes[ATA_MAX_DEVICES]; 623 unsigned int did_probe_mask; 624 unsigned int saved_ncq_enabled; 625 u8 saved_xfer_mode[ATA_MAX_DEVICES]; 626 /* timestamp for the last reset attempt or success */ 627 unsigned long last_reset; 628}; 629 630struct ata_acpi_drive 631{ 632 u32 pio; 633 u32 dma; 634} __packed; 635 636struct ata_acpi_gtm { 637 struct ata_acpi_drive drive[2]; 638 u32 flags; 639} __packed; 640 641struct ata_link { 642 struct ata_port *ap; 643 int pmp; /* port multiplier port # */ 644 645 unsigned int active_tag; /* active tag on this link */ 646 u32 sactive; /* active NCQ commands */ 647 648 unsigned int flags; /* ATA_LFLAG_xxx */ 649 650 unsigned int hw_sata_spd_limit; 651 unsigned int sata_spd_limit; 652 unsigned int sata_spd; /* current SATA PHY speed */ 653 654 /* record runtime error info, protected by host_set lock */ 655 struct ata_eh_info eh_info; 656 /* EH context */ 657 struct ata_eh_context eh_context; 658 659 struct ata_device device[ATA_MAX_DEVICES]; 660}; 661 662struct ata_port { 663 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */ 664 struct ata_port_operations *ops; 665 spinlock_t *lock; 666 unsigned long flags; /* ATA_FLAG_xxx */ 667 unsigned int pflags; /* ATA_PFLAG_xxx */ 668 unsigned int print_id; /* user visible unique port ID */ 669 unsigned int port_no; /* 0 based port no. inside the host */ 670 671 struct ata_prd *prd; /* our SG list */ 672 dma_addr_t prd_dma; /* and its DMA mapping */ 673 674#ifdef CONFIG_ATA_SFF 675 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */ 676#endif /* CONFIG_ATA_SFF */ 677 678 u8 ctl; /* cache of ATA control register */ 679 u8 last_ctl; /* Cache last written value */ 680 unsigned int pio_mask; 681 unsigned int mwdma_mask; 682 unsigned int udma_mask; 683 unsigned int cbl; /* cable type; ATA_CBL_xxx */ 684 685 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE]; 686 unsigned long qc_allocated; 687 unsigned int qc_active; 688 int nr_active_links; /* #links with active qcs */ 689 690 struct ata_link link; /* host default link */ 691 692 int nr_pmp_links; /* nr of available PMP links */ 693 struct ata_link *pmp_link; /* array of PMP links */ 694 struct ata_link *excl_link; /* for PMP qc exclusion */ 695 696 struct ata_port_stats stats; 697 struct ata_host *host; 698 struct device *dev; 699 700 void *port_task_data; 701 struct delayed_work port_task; 702 struct delayed_work hotplug_task; 703 struct work_struct scsi_rescan_task; 704 705 unsigned int hsm_task_state; 706 707 u32 msg_enable; 708 struct list_head eh_done_q; 709 wait_queue_head_t eh_wait_q; 710 int eh_tries; 711 712 pm_message_t pm_mesg; 713 int *pm_result; 714 enum link_pm pm_policy; 715 716 struct timer_list fastdrain_timer; 717 unsigned long fastdrain_cnt; 718 719 int em_message_type; 720 void *private_data; 721 722#ifdef CONFIG_ATA_ACPI 723 acpi_handle acpi_handle; 724 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */ 725#endif 726 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */ 727}; 728 729/* The following initializer overrides a method to NULL whether one of 730 * its parent has the method defined or not. This is equivalent to 731 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant 732 * expression and thus can't be used as an initializer. 733 */ 734#define ATA_OP_NULL (void *)(unsigned long)(-ENOENT) 735 736struct ata_port_operations { 737 /* 738 * Command execution 739 */ 740 int (*qc_defer)(struct ata_queued_cmd *qc); 741 int (*check_atapi_dma)(struct ata_queued_cmd *qc); 742 void (*qc_prep)(struct ata_queued_cmd *qc); 743 unsigned int (*qc_issue)(struct ata_queued_cmd *qc); 744 bool (*qc_fill_rtf)(struct ata_queued_cmd *qc); 745 746 /* 747 * Configuration and exception handling 748 */ 749 int (*cable_detect)(struct ata_port *ap); 750 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask); 751 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev); 752 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev); 753 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev); 754 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id); 755 756 void (*dev_config)(struct ata_device *dev); 757 758 void (*freeze)(struct ata_port *ap); 759 void (*thaw)(struct ata_port *ap); 760 ata_prereset_fn_t prereset; 761 ata_reset_fn_t softreset; 762 ata_reset_fn_t hardreset; 763 ata_postreset_fn_t postreset; 764 ata_prereset_fn_t pmp_prereset; 765 ata_reset_fn_t pmp_softreset; 766 ata_reset_fn_t pmp_hardreset; 767 ata_postreset_fn_t pmp_postreset; 768 void (*error_handler)(struct ata_port *ap); 769 void (*post_internal_cmd)(struct ata_queued_cmd *qc); 770 771 /* 772 * Optional features 773 */ 774 int (*scr_read)(struct ata_port *ap, unsigned int sc_reg, u32 *val); 775 int (*scr_write)(struct ata_port *ap, unsigned int sc_reg, u32 val); 776 void (*pmp_attach)(struct ata_port *ap); 777 void (*pmp_detach)(struct ata_port *ap); 778 int (*enable_pm)(struct ata_port *ap, enum link_pm policy); 779 void (*disable_pm)(struct ata_port *ap); 780 781 /* 782 * Start, stop, suspend and resume 783 */ 784 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg); 785 int (*port_resume)(struct ata_port *ap); 786 int (*port_start)(struct ata_port *ap); 787 void (*port_stop)(struct ata_port *ap); 788 void (*host_stop)(struct ata_host *host); 789 790#ifdef CONFIG_ATA_SFF 791 /* 792 * SFF / taskfile oriented ops 793 */ 794 void (*sff_dev_select)(struct ata_port *ap, unsigned int device); 795 u8 (*sff_check_status)(struct ata_port *ap); 796 u8 (*sff_check_altstatus)(struct ata_port *ap); 797 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf); 798 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf); 799 void (*sff_exec_command)(struct ata_port *ap, 800 const struct ata_taskfile *tf); 801 unsigned int (*sff_data_xfer)(struct ata_device *dev, 802 unsigned char *buf, unsigned int buflen, int rw); 803 u8 (*sff_irq_on)(struct ata_port *); 804 void (*sff_irq_clear)(struct ata_port *); 805 806 void (*bmdma_setup)(struct ata_queued_cmd *qc); 807 void (*bmdma_start)(struct ata_queued_cmd *qc); 808 void (*bmdma_stop)(struct ata_queued_cmd *qc); 809 u8 (*bmdma_status)(struct ata_port *ap); 810#endif /* CONFIG_ATA_SFF */ 811 812 ssize_t (*em_show)(struct ata_port *ap, char *buf); 813 ssize_t (*em_store)(struct ata_port *ap, const char *message, 814 size_t size); 815 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf); 816 ssize_t (*sw_activity_store)(struct ata_device *dev, 817 enum sw_activity val); 818 /* 819 * Obsolete 820 */ 821 void (*phy_reset)(struct ata_port *ap); 822 void (*eng_timeout)(struct ata_port *ap); 823 824 /* 825 * ->inherits must be the last field and all the preceding 826 * fields must be pointers. 827 */ 828 const struct ata_port_operations *inherits; 829}; 830 831struct ata_port_info { 832 unsigned long flags; 833 unsigned long link_flags; 834 unsigned long pio_mask; 835 unsigned long mwdma_mask; 836 unsigned long udma_mask; 837 struct ata_port_operations *port_ops; 838 void *private_data; 839}; 840 841struct ata_timing { 842 unsigned short mode; /* ATA mode */ 843 unsigned short setup; /* t1 */ 844 unsigned short act8b; /* t2 for 8-bit I/O */ 845 unsigned short rec8b; /* t2i for 8-bit I/O */ 846 unsigned short cyc8b; /* t0 for 8-bit I/O */ 847 unsigned short active; /* t2 or tD */ 848 unsigned short recover; /* t2i or tK */ 849 unsigned short cycle; /* t0 */ 850 unsigned short udma; /* t2CYCTYP/2 */ 851}; 852 853/* 854 * Core layer - drivers/ata/libata-core.c 855 */ 856extern const unsigned long sata_deb_timing_normal[]; 857extern const unsigned long sata_deb_timing_hotplug[]; 858extern const unsigned long sata_deb_timing_long[]; 859 860extern struct ata_port_operations ata_dummy_port_ops; 861extern const struct ata_port_info ata_dummy_port_info; 862 863static inline const unsigned long * 864sata_ehc_deb_timing(struct ata_eh_context *ehc) 865{ 866 if (ehc->i.flags & ATA_EHI_HOTPLUGGED) 867 return sata_deb_timing_hotplug; 868 else 869 return sata_deb_timing_normal; 870} 871 872static inline int ata_port_is_dummy(struct ata_port *ap) 873{ 874 return ap->ops == &ata_dummy_port_ops; 875} 876 877extern void ata_port_probe(struct ata_port *); 878extern int sata_set_spd(struct ata_link *link); 879extern int ata_std_prereset(struct ata_link *link, unsigned long deadline); 880extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline, 881 int (*check_ready)(struct ata_link *link)); 882extern int sata_link_debounce(struct ata_link *link, 883 const unsigned long *params, unsigned long deadline); 884extern int sata_link_resume(struct ata_link *link, const unsigned long *params, 885 unsigned long deadline); 886extern int sata_link_hardreset(struct ata_link *link, 887 const unsigned long *timing, unsigned long deadline, 888 bool *online, int (*check_ready)(struct ata_link *)); 889extern int sata_std_hardreset(struct ata_link *link, unsigned int *class, 890 unsigned long deadline); 891extern void ata_std_postreset(struct ata_link *link, unsigned int *classes); 892extern void ata_port_disable(struct ata_port *); 893 894extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports); 895extern struct ata_host *ata_host_alloc_pinfo(struct device *dev, 896 const struct ata_port_info * const * ppi, int n_ports); 897extern int ata_host_start(struct ata_host *host); 898extern int ata_host_register(struct ata_host *host, 899 struct scsi_host_template *sht); 900extern int ata_host_activate(struct ata_host *host, int irq, 901 irq_handler_t irq_handler, unsigned long irq_flags, 902 struct scsi_host_template *sht); 903extern void ata_host_detach(struct ata_host *host); 904extern void ata_host_init(struct ata_host *, struct device *, 905 unsigned long, struct ata_port_operations *); 906extern int ata_scsi_detect(struct scsi_host_template *sht); 907extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg); 908extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *)); 909extern void ata_sas_port_destroy(struct ata_port *); 910extern struct ata_port *ata_sas_port_alloc(struct ata_host *, 911 struct ata_port_info *, struct Scsi_Host *); 912extern int ata_sas_port_init(struct ata_port *); 913extern int ata_sas_port_start(struct ata_port *ap); 914extern void ata_sas_port_stop(struct ata_port *ap); 915extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *); 916extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), 917 struct ata_port *ap); 918extern int sata_scr_valid(struct ata_link *link); 919extern int sata_scr_read(struct ata_link *link, int reg, u32 *val); 920extern int sata_scr_write(struct ata_link *link, int reg, u32 val); 921extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val); 922extern int ata_link_online(struct ata_link *link); 923extern int ata_link_offline(struct ata_link *link); 924#ifdef CONFIG_PM 925extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg); 926extern void ata_host_resume(struct ata_host *host); 927#endif 928extern int ata_ratelimit(void); 929extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val, 930 unsigned long interval, unsigned long timeout); 931extern int atapi_cmd_type(u8 opcode); 932extern void ata_tf_to_fis(const struct ata_taskfile *tf, 933 u8 pmp, int is_cmd, u8 *fis); 934extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf); 935extern unsigned long ata_pack_xfermask(unsigned long pio_mask, 936 unsigned long mwdma_mask, unsigned long udma_mask); 937extern void ata_unpack_xfermask(unsigned long xfer_mask, 938 unsigned long *pio_mask, unsigned long *mwdma_mask, 939 unsigned long *udma_mask); 940extern u8 ata_xfer_mask2mode(unsigned long xfer_mask); 941extern unsigned long ata_xfer_mode2mask(u8 xfer_mode); 942extern int ata_xfer_mode2shift(unsigned long xfer_mode); 943extern const char *ata_mode_string(unsigned long xfer_mask); 944extern unsigned long ata_id_xfermask(const u16 *id); 945extern int ata_port_start(struct ata_port *ap); 946extern int ata_std_qc_defer(struct ata_queued_cmd *qc); 947extern void ata_noop_qc_prep(struct ata_queued_cmd *qc); 948extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg, 949 unsigned int n_elem); 950extern unsigned int ata_dev_classify(const struct ata_taskfile *tf); 951extern void ata_dev_disable(struct ata_device *adev); 952extern void ata_id_string(const u16 *id, unsigned char *s, 953 unsigned int ofs, unsigned int len); 954extern void ata_id_c_string(const u16 *id, unsigned char *s, 955 unsigned int ofs, unsigned int len); 956extern unsigned int ata_do_dev_read_id(struct ata_device *dev, 957 struct ata_taskfile *tf, u16 *id); 958extern void ata_qc_complete(struct ata_queued_cmd *qc); 959extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active); 960extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd, 961 void (*done)(struct scsi_cmnd *)); 962extern int ata_std_bios_param(struct scsi_device *sdev, 963 struct block_device *bdev, 964 sector_t capacity, int geom[]); 965extern int ata_scsi_slave_config(struct scsi_device *sdev); 966extern void ata_scsi_slave_destroy(struct scsi_device *sdev); 967extern int ata_scsi_change_queue_depth(struct scsi_device *sdev, 968 int queue_depth); 969extern struct ata_device *ata_dev_pair(struct ata_device *adev); 970extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev); 971 972extern int ata_cable_40wire(struct ata_port *ap); 973extern int ata_cable_80wire(struct ata_port *ap); 974extern int ata_cable_sata(struct ata_port *ap); 975extern int ata_cable_ignore(struct ata_port *ap); 976extern int ata_cable_unknown(struct ata_port *ap); 977 978/* Timing helpers */ 979extern unsigned int ata_pio_need_iordy(const struct ata_device *); 980extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode); 981extern int ata_timing_compute(struct ata_device *, unsigned short, 982 struct ata_timing *, int, int); 983extern void ata_timing_merge(const struct ata_timing *, 984 const struct ata_timing *, struct ata_timing *, 985 unsigned int); 986extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle); 987 988/* PCI */ 989#ifdef CONFIG_PCI 990struct pci_dev; 991 992struct pci_bits { 993 unsigned int reg; /* PCI config register to read */ 994 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */ 995 unsigned long mask; 996 unsigned long val; 997}; 998 999extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits); 1000extern void ata_pci_remove_one(struct pci_dev *pdev); 1001 1002#ifdef CONFIG_PM 1003extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg); 1004extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev); 1005extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg); 1006extern int ata_pci_device_resume(struct pci_dev *pdev); 1007#endif /* CONFIG_PM */ 1008#endif /* CONFIG_PCI */ 1009 1010/* 1011 * ACPI - drivers/ata/libata-acpi.c 1012 */ 1013#ifdef CONFIG_ATA_ACPI 1014static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap) 1015{ 1016 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID) 1017 return &ap->__acpi_init_gtm; 1018 return NULL; 1019} 1020int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm); 1021int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm); 1022unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev, 1023 const struct ata_acpi_gtm *gtm); 1024int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm); 1025#else 1026static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap) 1027{ 1028 return NULL; 1029} 1030 1031static inline int ata_acpi_stm(const struct ata_port *ap, 1032 struct ata_acpi_gtm *stm) 1033{ 1034 return -ENOSYS; 1035} 1036 1037static inline int ata_acpi_gtm(const struct ata_port *ap, 1038 struct ata_acpi_gtm *stm) 1039{ 1040 return -ENOSYS; 1041} 1042 1043static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev, 1044 const struct ata_acpi_gtm *gtm) 1045{ 1046 return 0; 1047} 1048 1049static inline int ata_acpi_cbl_80wire(struct ata_port *ap, 1050 const struct ata_acpi_gtm *gtm) 1051{ 1052 return 0; 1053} 1054#endif 1055 1056/* 1057 * EH - drivers/ata/libata-eh.c 1058 */ 1059extern void ata_port_schedule_eh(struct ata_port *ap); 1060extern int ata_link_abort(struct ata_link *link); 1061extern int ata_port_abort(struct ata_port *ap); 1062extern int ata_port_freeze(struct ata_port *ap); 1063extern int sata_async_notification(struct ata_port *ap); 1064 1065extern void ata_eh_freeze_port(struct ata_port *ap); 1066extern void ata_eh_thaw_port(struct ata_port *ap); 1067 1068extern void ata_eh_qc_complete(struct ata_queued_cmd *qc); 1069extern void ata_eh_qc_retry(struct ata_queued_cmd *qc); 1070extern void ata_eh_analyze_ncq_error(struct ata_link *link); 1071 1072extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset, 1073 ata_reset_fn_t softreset, ata_reset_fn_t hardreset, 1074 ata_postreset_fn_t postreset); 1075extern void ata_std_error_handler(struct ata_port *ap); 1076 1077/* 1078 * Base operations to inherit from and initializers for sht 1079 * 1080 * Operations 1081 * 1082 * base : Common to all libata drivers. 1083 * sata : SATA controllers w/ native interface. 1084 * pmp : SATA controllers w/ PMP support. 1085 * sff : SFF ATA controllers w/o BMDMA support. 1086 * bmdma : SFF ATA controllers w/ BMDMA support. 1087 * 1088 * sht initializers 1089 * 1090 * BASE : Common to all libata drivers. The user must set 1091 * sg_tablesize and dma_boundary. 1092 * PIO : SFF ATA controllers w/ only PIO support. 1093 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and 1094 * dma_boundary are set to BMDMA limits. 1095 * NCQ : SATA controllers supporting NCQ. The user must set 1096 * sg_tablesize, dma_boundary and can_queue. 1097 */ 1098extern const struct ata_port_operations ata_base_port_ops; 1099extern const struct ata_port_operations sata_port_ops; 1100 1101#define ATA_BASE_SHT(drv_name) \ 1102 .module = THIS_MODULE, \ 1103 .name = drv_name, \ 1104 .ioctl = ata_scsi_ioctl, \ 1105 .queuecommand = ata_scsi_queuecmd, \ 1106 .can_queue = ATA_DEF_QUEUE, \ 1107 .this_id = ATA_SHT_THIS_ID, \ 1108 .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \ 1109 .emulated = ATA_SHT_EMULATED, \ 1110 .use_clustering = ATA_SHT_USE_CLUSTERING, \ 1111 .proc_name = drv_name, \ 1112 .slave_configure = ata_scsi_slave_config, \ 1113 .slave_destroy = ata_scsi_slave_destroy, \ 1114 .bios_param = ata_std_bios_param 1115 1116#define ATA_NCQ_SHT(drv_name) \ 1117 ATA_BASE_SHT(drv_name), \ 1118 .change_queue_depth = ata_scsi_change_queue_depth 1119 1120/* 1121 * PMP helpers 1122 */ 1123#ifdef CONFIG_SATA_PMP 1124static inline bool sata_pmp_supported(struct ata_port *ap) 1125{ 1126 return ap->flags & ATA_FLAG_PMP; 1127} 1128 1129static inline bool sata_pmp_attached(struct ata_port *ap) 1130{ 1131 return ap->nr_pmp_links != 0; 1132} 1133 1134static inline int ata_is_host_link(const struct ata_link *link) 1135{ 1136 return link == &link->ap->link; 1137} 1138#else /* CONFIG_SATA_PMP */ 1139static inline bool sata_pmp_supported(struct ata_port *ap) 1140{ 1141 return false; 1142} 1143 1144static inline bool sata_pmp_attached(struct ata_port *ap) 1145{ 1146 return false; 1147} 1148 1149static inline int ata_is_host_link(const struct ata_link *link) 1150{ 1151 return 1; 1152} 1153#endif /* CONFIG_SATA_PMP */ 1154 1155static inline int sata_srst_pmp(struct ata_link *link) 1156{ 1157 if (sata_pmp_supported(link->ap) && ata_is_host_link(link)) 1158 return SATA_PMP_CTRL_PORT; 1159 return link->pmp; 1160} 1161 1162/* 1163 * printk helpers 1164 */ 1165#define ata_port_printk(ap, lv, fmt, args...) \ 1166 printk("%sata%u: "fmt, lv, (ap)->print_id , ##args) 1167 1168#define ata_link_printk(link, lv, fmt, args...) do { \ 1169 if (sata_pmp_attached((link)->ap)) \ 1170 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \ 1171 (link)->pmp , ##args); \ 1172 else \ 1173 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \ 1174 } while(0) 1175 1176#define ata_dev_printk(dev, lv, fmt, args...) \ 1177 printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \ 1178 (dev)->link->pmp + (dev)->devno , ##args) 1179 1180/* 1181 * ata_eh_info helpers 1182 */ 1183extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...) 1184 __attribute__ ((format (printf, 2, 3))); 1185extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...) 1186 __attribute__ ((format (printf, 2, 3))); 1187extern void ata_ehi_clear_desc(struct ata_eh_info *ehi); 1188 1189static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi) 1190{ 1191 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1; 1192 ehi->flags |= ATA_EHI_HOTPLUGGED; 1193 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK; 1194 ehi->err_mask |= AC_ERR_ATA_BUS; 1195} 1196 1197/* 1198 * port description helpers 1199 */ 1200extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...) 1201 __attribute__ ((format (printf, 2, 3))); 1202#ifdef CONFIG_PCI 1203extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset, 1204 const char *name); 1205#endif 1206 1207static inline unsigned int ata_tag_valid(unsigned int tag) 1208{ 1209 return (tag < ATA_MAX_QUEUE) ? 1 : 0; 1210} 1211 1212static inline unsigned int ata_tag_internal(unsigned int tag) 1213{ 1214 return tag == ATA_TAG_INTERNAL; 1215} 1216 1217/* 1218 * device helpers 1219 */ 1220static inline unsigned int ata_class_enabled(unsigned int class) 1221{ 1222 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI || 1223 class == ATA_DEV_PMP || class == ATA_DEV_SEMB; 1224} 1225 1226static inline unsigned int ata_class_disabled(unsigned int class) 1227{ 1228 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP || 1229 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP; 1230} 1231 1232static inline unsigned int ata_class_absent(unsigned int class) 1233{ 1234 return !ata_class_enabled(class) && !ata_class_disabled(class); 1235} 1236 1237static inline unsigned int ata_dev_enabled(const struct ata_device *dev) 1238{ 1239 return ata_class_enabled(dev->class); 1240} 1241 1242static inline unsigned int ata_dev_disabled(const struct ata_device *dev) 1243{ 1244 return ata_class_disabled(dev->class); 1245} 1246 1247static inline unsigned int ata_dev_absent(const struct ata_device *dev) 1248{ 1249 return ata_class_absent(dev->class); 1250} 1251 1252/* 1253 * link helpers 1254 */ 1255static inline int ata_link_max_devices(const struct ata_link *link) 1256{ 1257 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS) 1258 return 2; 1259 return 1; 1260} 1261 1262static inline int ata_link_active(struct ata_link *link) 1263{ 1264 return ata_tag_valid(link->active_tag) || link->sactive; 1265} 1266 1267static inline struct ata_link *ata_port_first_link(struct ata_port *ap) 1268{ 1269 if (sata_pmp_attached(ap)) 1270 return ap->pmp_link; 1271 return &ap->link; 1272} 1273 1274static inline struct ata_link *ata_port_next_link(struct ata_link *link) 1275{ 1276 struct ata_port *ap = link->ap; 1277 1278 if (ata_is_host_link(link)) { 1279 if (!sata_pmp_attached(ap)) 1280 return NULL; 1281 return ap->pmp_link; 1282 } 1283 1284 if (++link < ap->nr_pmp_links + ap->pmp_link) 1285 return link; 1286 return NULL; 1287} 1288 1289#define __ata_port_for_each_link(lk, ap) \ 1290 for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk)) 1291 1292#define ata_port_for_each_link(link, ap) \ 1293 for ((link) = ata_port_first_link(ap); (link); \ 1294 (link) = ata_port_next_link(link)) 1295 1296#define ata_link_for_each_dev(dev, link) \ 1297 for ((dev) = (link)->device; \ 1298 (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \ 1299 (dev)++) 1300 1301#define ata_link_for_each_dev_reverse(dev, link) \ 1302 for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \ 1303 (dev) >= (link)->device || ((dev) = NULL); (dev)--) 1304 1305/** 1306 * ata_ncq_enabled - Test whether NCQ is enabled 1307 * @dev: ATA device to test for 1308 * 1309 * LOCKING: 1310 * spin_lock_irqsave(host lock) 1311 * 1312 * RETURNS: 1313 * 1 if NCQ is enabled for @dev, 0 otherwise. 1314 */ 1315static inline int ata_ncq_enabled(struct ata_device *dev) 1316{ 1317 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF | 1318 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ; 1319} 1320 1321static inline void ata_qc_set_polling(struct ata_queued_cmd *qc) 1322{ 1323 qc->tf.ctl |= ATA_NIEN; 1324} 1325 1326static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap, 1327 unsigned int tag) 1328{ 1329 if (likely(ata_tag_valid(tag))) 1330 return &ap->qcmd[tag]; 1331 return NULL; 1332} 1333 1334static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap, 1335 unsigned int tag) 1336{ 1337 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag); 1338 1339 if (unlikely(!qc) || !ap->ops->error_handler) 1340 return qc; 1341 1342 if ((qc->flags & (ATA_QCFLAG_ACTIVE | 1343 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE) 1344 return qc; 1345 1346 return NULL; 1347} 1348 1349static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc) 1350{ 1351 return qc->nbytes - min(qc->extrabytes, qc->nbytes); 1352} 1353 1354static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf) 1355{ 1356 memset(tf, 0, sizeof(*tf)); 1357 1358 tf->ctl = dev->link->ap->ctl; 1359 if (dev->devno == 0) 1360 tf->device = ATA_DEVICE_OBS; 1361 else 1362 tf->device = ATA_DEVICE_OBS | ATA_DEV1; 1363} 1364 1365static inline void ata_qc_reinit(struct ata_queued_cmd *qc) 1366{ 1367 qc->dma_dir = DMA_NONE; 1368 qc->sg = NULL; 1369 qc->flags = 0; 1370 qc->cursg = NULL; 1371 qc->cursg_ofs = 0; 1372 qc->nbytes = qc->extrabytes = qc->curbytes = 0; 1373 qc->n_elem = 0; 1374 qc->err_mask = 0; 1375 qc->sect_size = ATA_SECT_SIZE; 1376 1377 ata_tf_init(qc->dev, &qc->tf); 1378 1379 /* init result_tf such that it indicates normal completion */ 1380 qc->result_tf.command = ATA_DRDY; 1381 qc->result_tf.feature = 0; 1382} 1383 1384static inline int ata_try_flush_cache(const struct ata_device *dev) 1385{ 1386 return ata_id_wcache_enabled(dev->id) || 1387 ata_id_has_flush(dev->id) || 1388 ata_id_has_flush_ext(dev->id); 1389} 1390 1391static inline unsigned int ac_err_mask(u8 status) 1392{ 1393 if (status & (ATA_BUSY | ATA_DRQ)) 1394 return AC_ERR_HSM; 1395 if (status & (ATA_ERR | ATA_DF)) 1396 return AC_ERR_DEV; 1397 return 0; 1398} 1399 1400static inline unsigned int __ac_err_mask(u8 status) 1401{ 1402 unsigned int mask = ac_err_mask(status); 1403 if (mask == 0) 1404 return AC_ERR_OTHER; 1405 return mask; 1406} 1407 1408static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host) 1409{ 1410 return *(struct ata_port **)&host->hostdata[0]; 1411} 1412 1413static inline int ata_check_ready(u8 status) 1414{ 1415 if (!(status & ATA_BUSY)) 1416 return 1; 1417 1418 /* 0xff indicates either no device or device not ready */ 1419 if (status == 0xff) 1420 return -ENODEV; 1421 1422 return 0; 1423} 1424 1425static inline unsigned long ata_deadline(unsigned long from_jiffies, 1426 unsigned long timeout_msecs) 1427{ 1428 return from_jiffies + msecs_to_jiffies(timeout_msecs); 1429} 1430 1431 1432/************************************************************************** 1433 * PMP - drivers/ata/libata-pmp.c 1434 */ 1435#ifdef CONFIG_SATA_PMP 1436 1437extern const struct ata_port_operations sata_pmp_port_ops; 1438 1439extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc); 1440extern void sata_pmp_error_handler(struct ata_port *ap); 1441 1442#else /* CONFIG_SATA_PMP */ 1443 1444#define sata_pmp_port_ops sata_port_ops 1445#define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer 1446#define sata_pmp_error_handler ata_std_error_handler 1447 1448#endif /* CONFIG_SATA_PMP */ 1449 1450 1451/************************************************************************** 1452 * SFF - drivers/ata/libata-sff.c 1453 */ 1454#ifdef CONFIG_ATA_SFF 1455 1456extern const struct ata_port_operations ata_sff_port_ops; 1457extern const struct ata_port_operations ata_bmdma_port_ops; 1458 1459/* PIO only, sg_tablesize and dma_boundary limits can be removed */ 1460#define ATA_PIO_SHT(drv_name) \ 1461 ATA_BASE_SHT(drv_name), \ 1462 .sg_tablesize = LIBATA_MAX_PRD, \ 1463 .dma_boundary = ATA_DMA_BOUNDARY 1464 1465#define ATA_BMDMA_SHT(drv_name) \ 1466 ATA_BASE_SHT(drv_name), \ 1467 .sg_tablesize = LIBATA_MAX_PRD, \ 1468 .dma_boundary = ATA_DMA_BOUNDARY 1469 1470extern void ata_sff_qc_prep(struct ata_queued_cmd *qc); 1471extern void ata_sff_dumb_qc_prep(struct ata_queued_cmd *qc); 1472extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device); 1473extern u8 ata_sff_check_status(struct ata_port *ap); 1474extern void ata_sff_pause(struct ata_port *ap); 1475extern void ata_sff_dma_pause(struct ata_port *ap); 1476extern int ata_sff_busy_sleep(struct ata_port *ap, 1477 unsigned long timeout_pat, unsigned long timeout); 1478extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline); 1479extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf); 1480extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf); 1481extern void ata_sff_exec_command(struct ata_port *ap, 1482 const struct ata_taskfile *tf); 1483extern unsigned int ata_sff_data_xfer(struct ata_device *dev, 1484 unsigned char *buf, unsigned int buflen, int rw); 1485extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev, 1486 unsigned char *buf, unsigned int buflen, int rw); 1487extern u8 ata_sff_irq_on(struct ata_port *ap); 1488extern void ata_sff_irq_clear(struct ata_port *ap); 1489extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc, 1490 u8 status, int in_wq); 1491extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc); 1492extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc); 1493extern unsigned int ata_sff_host_intr(struct ata_port *ap, 1494 struct ata_queued_cmd *qc); 1495extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance); 1496extern void ata_sff_freeze(struct ata_port *ap); 1497extern void ata_sff_thaw(struct ata_port *ap); 1498extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline); 1499extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present, 1500 u8 *r_err); 1501extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask, 1502 unsigned long deadline); 1503extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes, 1504 unsigned long deadline); 1505extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class, 1506 unsigned long deadline); 1507extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes); 1508extern void ata_sff_error_handler(struct ata_port *ap); 1509extern void ata_sff_post_internal_cmd(struct ata_queued_cmd *qc); 1510extern int ata_sff_port_start(struct ata_port *ap); 1511extern void ata_sff_std_ports(struct ata_ioports *ioaddr); 1512extern unsigned long ata_bmdma_mode_filter(struct ata_device *dev, 1513 unsigned long xfer_mask); 1514extern void ata_bmdma_setup(struct ata_queued_cmd *qc); 1515extern void ata_bmdma_start(struct ata_queued_cmd *qc); 1516extern void ata_bmdma_stop(struct ata_queued_cmd *qc); 1517extern u8 ata_bmdma_status(struct ata_port *ap); 1518extern void ata_bus_reset(struct ata_port *ap); 1519 1520#ifdef CONFIG_PCI 1521extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev); 1522extern int ata_pci_bmdma_init(struct ata_host *host); 1523extern int ata_pci_sff_init_host(struct ata_host *host); 1524extern int ata_pci_sff_prepare_host(struct pci_dev *pdev, 1525 const struct ata_port_info * const * ppi, 1526 struct ata_host **r_host); 1527extern int ata_pci_sff_activate_host(struct ata_host *host, 1528 irq_handler_t irq_handler, 1529 struct scsi_host_template *sht); 1530extern int ata_pci_sff_init_one(struct pci_dev *pdev, 1531 const struct ata_port_info * const * ppi, 1532 struct scsi_host_template *sht, void *host_priv); 1533#endif /* CONFIG_PCI */ 1534 1535/** 1536 * ata_sff_busy_wait - Wait for a port status register 1537 * @ap: Port to wait for. 1538 * @bits: bits that must be clear 1539 * @max: number of 10uS waits to perform 1540 * 1541 * Waits up to max*10 microseconds for the selected bits in the port's 1542 * status register to be cleared. 1543 * Returns final value of status register. 1544 * 1545 * LOCKING: 1546 * Inherited from caller. 1547 */ 1548static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits, 1549 unsigned int max) 1550{ 1551 u8 status; 1552 1553 do { 1554 udelay(10); 1555 status = ap->ops->sff_check_status(ap); 1556 max--; 1557 } while (status != 0xff && (status & bits) && (max > 0)); 1558 1559 return status; 1560} 1561 1562/** 1563 * ata_wait_idle - Wait for a port to be idle. 1564 * @ap: Port to wait for. 1565 * 1566 * Waits up to 10ms for port's BUSY and DRQ signals to clear. 1567 * Returns final value of status register. 1568 * 1569 * LOCKING: 1570 * Inherited from caller. 1571 */ 1572static inline u8 ata_wait_idle(struct ata_port *ap) 1573{ 1574 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000); 1575 1576#ifdef ATA_DEBUG 1577 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) 1578 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n", 1579 status); 1580#endif 1581 1582 return status; 1583} 1584#endif /* CONFIG_ATA_SFF */ 1585 1586#endif /* __LINUX_LIBATA_H__ */ 1587