libata.h revision 6357357cae7794dcb89cace758108dec612e7ed5
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/interrupt.h> 31#include <linux/dma-mapping.h> 32#include <linux/scatterlist.h> 33#include <linux/io.h> 34#include <linux/ata.h> 35#include <linux/workqueue.h> 36#include <scsi/scsi_host.h> 37#include <linux/acpi.h> 38 39/* 40 * Define if arch has non-standard setup. This is a _PCI_ standard 41 * not a legacy or ISA standard. 42 */ 43#ifdef CONFIG_ATA_NONSTANDARD 44#include <asm/libata-portmap.h> 45#else 46#include <asm-generic/libata-portmap.h> 47#endif 48 49/* 50 * compile-time options: to be removed as soon as all the drivers are 51 * converted to the new debugging mechanism 52 */ 53#undef ATA_DEBUG /* debugging output */ 54#undef ATA_VERBOSE_DEBUG /* yet more debugging output */ 55#undef ATA_IRQ_TRAP /* define to ack screaming irqs */ 56#undef ATA_NDEBUG /* define to disable quick runtime checks */ 57 58 59/* note: prints function name for you */ 60#ifdef ATA_DEBUG 61#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) 62#ifdef ATA_VERBOSE_DEBUG 63#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) 64#else 65#define VPRINTK(fmt, args...) 66#endif /* ATA_VERBOSE_DEBUG */ 67#else 68#define DPRINTK(fmt, args...) 69#define VPRINTK(fmt, args...) 70#endif /* ATA_DEBUG */ 71 72#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) 73 74/* NEW: debug levels */ 75#define HAVE_LIBATA_MSG 1 76 77enum { 78 ATA_MSG_DRV = 0x0001, 79 ATA_MSG_INFO = 0x0002, 80 ATA_MSG_PROBE = 0x0004, 81 ATA_MSG_WARN = 0x0008, 82 ATA_MSG_MALLOC = 0x0010, 83 ATA_MSG_CTL = 0x0020, 84 ATA_MSG_INTR = 0x0040, 85 ATA_MSG_ERR = 0x0080, 86}; 87 88#define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV) 89#define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO) 90#define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE) 91#define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN) 92#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC) 93#define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL) 94#define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR) 95#define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR) 96 97static inline u32 ata_msg_init(int dval, int default_msg_enable_bits) 98{ 99 if (dval < 0 || dval >= (sizeof(u32) * 8)) 100 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */ 101 if (!dval) 102 return 0; 103 return (1 << dval) - 1; 104} 105 106/* defines only for the constants which don't work well as enums */ 107#define ATA_TAG_POISON 0xfafbfcfdU 108 109enum { 110 /* various global constants */ 111 LIBATA_MAX_PRD = ATA_MAX_PRD / 2, 112 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */ 113 ATA_MAX_PORTS = 8, 114 ATA_DEF_QUEUE = 1, 115 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */ 116 ATA_MAX_QUEUE = 32, 117 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1, 118 ATA_MAX_BUS = 2, 119 ATA_DEF_BUSY_WAIT = 10000, 120 ATA_SHORT_PAUSE = (HZ >> 6) + 1, 121 122 ATAPI_MAX_DRAIN = 16 << 10, 123 124 ATA_SHT_EMULATED = 1, 125 ATA_SHT_CMD_PER_LUN = 1, 126 ATA_SHT_THIS_ID = -1, 127 ATA_SHT_USE_CLUSTERING = 1, 128 129 /* struct ata_device stuff */ 130 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */ 131 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */ 132 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */ 133 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */ 134 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */ 135 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */ 136 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */ 137 ATA_DFLAG_AN = (1 << 7), /* AN configured */ 138 ATA_DFLAG_HIPM = (1 << 8), /* device supports HIPM */ 139 ATA_DFLAG_DIPM = (1 << 9), /* device supports DIPM */ 140 ATA_DFLAG_CFG_MASK = (1 << 12) - 1, 141 142 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */ 143 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */ 144 ATA_DFLAG_SPUNDOWN = (1 << 14), /* XXX: for spindown_compat */ 145 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */ 146 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */ 147 ATA_DFLAG_INIT_MASK = (1 << 24) - 1, 148 149 ATA_DFLAG_DETACH = (1 << 24), 150 ATA_DFLAG_DETACHED = (1 << 25), 151 152 ATA_DEV_UNKNOWN = 0, /* unknown device */ 153 ATA_DEV_ATA = 1, /* ATA device */ 154 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */ 155 ATA_DEV_ATAPI = 3, /* ATAPI device */ 156 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */ 157 ATA_DEV_PMP = 5, /* SATA port multiplier */ 158 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */ 159 ATA_DEV_SEMB = 7, /* SEMB */ 160 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */ 161 ATA_DEV_NONE = 9, /* no device */ 162 163 /* struct ata_link flags */ 164 ATA_LFLAG_HRST_TO_RESUME = (1 << 0), /* hardreset to resume link */ 165 ATA_LFLAG_SKIP_D2H_BSY = (1 << 1), /* can't wait for the first D2H 166 * Register FIS clearing BSY */ 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 174 /* struct ata_port flags */ 175 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */ 176 /* (doesn't imply presence) */ 177 ATA_FLAG_SATA = (1 << 1), 178 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */ 179 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */ 180 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */ 181 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */ 182 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */ 183 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */ 184 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */ 185 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD 186 * doesn't handle PIO interrupts */ 187 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */ 188 ATA_FLAG_DEBUGMSG = (1 << 13), 189 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */ 190 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */ 191 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */ 192 ATA_FLAG_AN = (1 << 18), /* controller supports AN */ 193 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */ 194 ATA_FLAG_IPM = (1 << 20), /* driver can handle IPM */ 195 196 /* The following flag belongs to ap->pflags but is kept in 197 * ap->flags because it's referenced in many LLDs and will be 198 * removed in not-too-distant future. 199 */ 200 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */ 201 202 /* bits 24:31 of ap->flags are reserved for LLD specific flags */ 203 204 /* struct ata_port pflags */ 205 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */ 206 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */ 207 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */ 208 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */ 209 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */ 210 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */ 211 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */ 212 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */ 213 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */ 214 215 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */ 216 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */ 217 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */ 218 219 /* struct ata_queued_cmd flags */ 220 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */ 221 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */ 222 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */ 223 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE, 224 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */ 225 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */ 226 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */ 227 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */ 228 229 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */ 230 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */ 231 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */ 232 233 /* host set flags */ 234 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */ 235 ATA_HOST_STARTED = (1 << 1), /* Host started */ 236 237 /* bits 24:31 of host->flags are reserved for LLD specific flags */ 238 239 /* various lengths of time */ 240 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */ 241 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */ 242 ATA_TMOUT_INTERNAL = 30 * HZ, 243 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ, 244 245 /* FIXME: GoVault needs 2s but we can't afford that without 246 * parallel probing. 800ms is enough for iVDR disk 247 * HHD424020F7SV00. Increase to 2secs when parallel probing 248 * is in place. 249 */ 250 ATA_TMOUT_FF_WAIT = 4 * HZ / 5, 251 252 /* ATA bus states */ 253 BUS_UNKNOWN = 0, 254 BUS_DMA = 1, 255 BUS_IDLE = 2, 256 BUS_NOINTR = 3, 257 BUS_NODATA = 4, 258 BUS_TIMER = 5, 259 BUS_PIO = 6, 260 BUS_EDD = 7, 261 BUS_IDENTIFY = 8, 262 BUS_PACKET = 9, 263 264 /* SATA port states */ 265 PORT_UNKNOWN = 0, 266 PORT_ENABLED = 1, 267 PORT_DISABLED = 2, 268 269 /* encoding various smaller bitmaps into a single 270 * unsigned int bitmap 271 */ 272 ATA_BITS_PIO = 7, 273 ATA_BITS_MWDMA = 5, 274 ATA_BITS_UDMA = 8, 275 276 ATA_SHIFT_PIO = 0, 277 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO, 278 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA, 279 280 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO, 281 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA, 282 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA, 283 284 /* size of buffer to pad xfers ending on unaligned boundaries */ 285 ATA_DMA_PAD_SZ = 4, 286 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE, 287 288 /* ering size */ 289 ATA_ERING_SIZE = 32, 290 291 /* return values for ->qc_defer */ 292 ATA_DEFER_LINK = 1, 293 ATA_DEFER_PORT = 2, 294 295 /* desc_len for ata_eh_info and context */ 296 ATA_EH_DESC_LEN = 80, 297 298 /* reset / recovery action types */ 299 ATA_EH_REVALIDATE = (1 << 0), 300 ATA_EH_SOFTRESET = (1 << 1), 301 ATA_EH_HARDRESET = (1 << 2), 302 ATA_EH_ENABLE_LINK = (1 << 3), 303 304 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET, 305 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE, 306 307 /* ata_eh_info->flags */ 308 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */ 309 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */ 310 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */ 311 ATA_EHI_QUIET = (1 << 3), /* be quiet */ 312 ATA_EHI_LPM = (1 << 4), /* link power management action */ 313 314 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */ 315 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */ 316 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */ 317 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */ 318 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */ 319 320 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET, 321 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK, 322 323 /* max tries if error condition is still set after ->error_handler */ 324 ATA_EH_MAX_TRIES = 5, 325 326 /* how hard are we gonna try to probe/recover devices */ 327 ATA_PROBE_MAX_TRIES = 3, 328 ATA_EH_DEV_TRIES = 3, 329 ATA_EH_PMP_TRIES = 5, 330 ATA_EH_PMP_LINK_TRIES = 3, 331 332 SATA_PMP_SCR_TIMEOUT = 250, 333 334 /* Horkage types. May be set by libata or controller on drives 335 (some horkage may be drive/controller pair dependant */ 336 337 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */ 338 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */ 339 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */ 340 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */ 341 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */ 342 ATA_HORKAGE_SKIP_PM = (1 << 5), /* Skip PM operations */ 343 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */ 344 ATA_HORKAGE_IPM = (1 << 7), /* Link PM problems */ 345 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */ 346 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */ 347 348 /* DMA mask for user DMA control: User visible values; DO NOT 349 renumber */ 350 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */ 351 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */ 352 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */ 353}; 354 355enum hsm_task_states { 356 HSM_ST_IDLE, /* no command on going */ 357 HSM_ST_FIRST, /* (waiting the device to) 358 write CDB or first data block */ 359 HSM_ST, /* (waiting the device to) transfer data */ 360 HSM_ST_LAST, /* (waiting the device to) complete command */ 361 HSM_ST_ERR, /* error */ 362}; 363 364enum ata_completion_errors { 365 AC_ERR_DEV = (1 << 0), /* device reported error */ 366 AC_ERR_HSM = (1 << 1), /* host state machine violation */ 367 AC_ERR_TIMEOUT = (1 << 2), /* timeout */ 368 AC_ERR_MEDIA = (1 << 3), /* media error */ 369 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */ 370 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */ 371 AC_ERR_SYSTEM = (1 << 6), /* system error */ 372 AC_ERR_INVALID = (1 << 7), /* invalid argument */ 373 AC_ERR_OTHER = (1 << 8), /* unknown */ 374 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */ 375 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */ 376}; 377 378/* forward declarations */ 379struct scsi_device; 380struct ata_port_operations; 381struct ata_port; 382struct ata_link; 383struct ata_queued_cmd; 384 385/* typedefs */ 386typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc); 387typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline); 388typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes, 389 unsigned long deadline); 390typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes); 391 392/* 393 * host pm policy: If you alter this, you also need to alter libata-scsi.c 394 * (for the ascii descriptions) 395 */ 396enum link_pm { 397 NOT_AVAILABLE, 398 MIN_POWER, 399 MAX_PERFORMANCE, 400 MEDIUM_POWER, 401}; 402extern struct class_device_attribute class_device_attr_link_power_management_policy; 403 404struct ata_ioports { 405 void __iomem *cmd_addr; 406 void __iomem *data_addr; 407 void __iomem *error_addr; 408 void __iomem *feature_addr; 409 void __iomem *nsect_addr; 410 void __iomem *lbal_addr; 411 void __iomem *lbam_addr; 412 void __iomem *lbah_addr; 413 void __iomem *device_addr; 414 void __iomem *status_addr; 415 void __iomem *command_addr; 416 void __iomem *altstatus_addr; 417 void __iomem *ctl_addr; 418 void __iomem *bmdma_addr; 419 void __iomem *scr_addr; 420}; 421 422struct ata_host { 423 spinlock_t lock; 424 struct device *dev; 425 void __iomem * const *iomap; 426 unsigned int n_ports; 427 void *private_data; 428 const struct ata_port_operations *ops; 429 unsigned long flags; 430#ifdef CONFIG_ATA_ACPI 431 acpi_handle acpi_handle; 432#endif 433 struct ata_port *simplex_claimed; /* channel owning the DMA */ 434 struct ata_port *ports[0]; 435}; 436 437struct ata_queued_cmd { 438 struct ata_port *ap; 439 struct ata_device *dev; 440 441 struct scsi_cmnd *scsicmd; 442 void (*scsidone)(struct scsi_cmnd *); 443 444 struct ata_taskfile tf; 445 u8 cdb[ATAPI_CDB_LEN]; 446 447 unsigned long flags; /* ATA_QCFLAG_xxx */ 448 unsigned int tag; 449 unsigned int n_elem; 450 unsigned int n_iter; 451 unsigned int orig_n_elem; 452 453 int dma_dir; 454 455 unsigned int pad_len; 456 unsigned int sect_size; 457 458 unsigned int nbytes; 459 unsigned int curbytes; 460 461 struct scatterlist *cursg; 462 unsigned int cursg_ofs; 463 464 struct scatterlist sgent; 465 struct scatterlist pad_sgent; 466 void *buf_virt; 467 468 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */ 469 struct scatterlist *__sg; 470 471 unsigned int err_mask; 472 struct ata_taskfile result_tf; 473 ata_qc_cb_t complete_fn; 474 475 void *private_data; 476 void *lldd_task; 477}; 478 479struct ata_port_stats { 480 unsigned long unhandled_irq; 481 unsigned long idle_irq; 482 unsigned long rw_reqbuf; 483}; 484 485struct ata_ering_entry { 486 unsigned int eflags; 487 unsigned int err_mask; 488 u64 timestamp; 489}; 490 491struct ata_ering { 492 int cursor; 493 struct ata_ering_entry ring[ATA_ERING_SIZE]; 494}; 495 496struct ata_device { 497 struct ata_link *link; 498 unsigned int devno; /* 0 or 1 */ 499 unsigned long flags; /* ATA_DFLAG_xxx */ 500 unsigned int horkage; /* List of broken features */ 501 struct scsi_device *sdev; /* attached SCSI device */ 502#ifdef CONFIG_ATA_ACPI 503 acpi_handle acpi_handle; 504 union acpi_object *gtf_cache; 505#endif 506 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */ 507 u64 n_sectors; /* size of device, if ATA */ 508 unsigned int class; /* ATA_DEV_xxx */ 509 510 union { 511 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */ 512 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */ 513 }; 514 515 u8 pio_mode; 516 u8 dma_mode; 517 u8 xfer_mode; 518 unsigned int xfer_shift; /* ATA_SHIFT_xxx */ 519 520 unsigned int multi_count; /* sectors count for 521 READ/WRITE MULTIPLE */ 522 unsigned int max_sectors; /* per-device max sectors */ 523 unsigned int cdb_len; 524 525 /* per-dev xfer mask */ 526 unsigned int pio_mask; 527 unsigned int mwdma_mask; 528 unsigned int udma_mask; 529 530 /* for CHS addressing */ 531 u16 cylinders; /* Number of cylinders */ 532 u16 heads; /* Number of heads */ 533 u16 sectors; /* Number of sectors per track */ 534 535 /* error history */ 536 struct ata_ering ering; 537 int spdn_cnt; 538}; 539 540/* Offset into struct ata_device. Fields above it are maintained 541 * acress device init. Fields below are zeroed. 542 */ 543#define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors) 544 545struct ata_eh_info { 546 struct ata_device *dev; /* offending device */ 547 u32 serror; /* SError from LLDD */ 548 unsigned int err_mask; /* port-wide err_mask */ 549 unsigned int action; /* ATA_EH_* action mask */ 550 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */ 551 unsigned int flags; /* ATA_EHI_* flags */ 552 553 unsigned int probe_mask; 554 555 char desc[ATA_EH_DESC_LEN]; 556 int desc_len; 557}; 558 559struct ata_eh_context { 560 struct ata_eh_info i; 561 int tries[ATA_MAX_DEVICES]; 562 unsigned int classes[ATA_MAX_DEVICES]; 563 unsigned int did_probe_mask; 564 unsigned int saved_ncq_enabled; 565 u8 saved_xfer_mode[ATA_MAX_DEVICES]; 566}; 567 568struct ata_acpi_drive 569{ 570 u32 pio; 571 u32 dma; 572} __packed; 573 574struct ata_acpi_gtm { 575 struct ata_acpi_drive drive[2]; 576 u32 flags; 577} __packed; 578 579struct ata_link { 580 struct ata_port *ap; 581 int pmp; /* port multiplier port # */ 582 583 unsigned int active_tag; /* active tag on this link */ 584 u32 sactive; /* active NCQ commands */ 585 586 unsigned int flags; /* ATA_LFLAG_xxx */ 587 588 unsigned int hw_sata_spd_limit; 589 unsigned int sata_spd_limit; 590 unsigned int sata_spd; /* current SATA PHY speed */ 591 592 /* record runtime error info, protected by host_set lock */ 593 struct ata_eh_info eh_info; 594 /* EH context */ 595 struct ata_eh_context eh_context; 596 597 struct ata_device device[ATA_MAX_DEVICES]; 598}; 599 600struct ata_port { 601 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */ 602 const struct ata_port_operations *ops; 603 spinlock_t *lock; 604 unsigned long flags; /* ATA_FLAG_xxx */ 605 unsigned int pflags; /* ATA_PFLAG_xxx */ 606 unsigned int print_id; /* user visible unique port ID */ 607 unsigned int port_no; /* 0 based port no. inside the host */ 608 609 struct ata_prd *prd; /* our SG list */ 610 dma_addr_t prd_dma; /* and its DMA mapping */ 611 612 void *pad; /* array of DMA pad buffers */ 613 dma_addr_t pad_dma; 614 615 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */ 616 617 u8 ctl; /* cache of ATA control register */ 618 u8 last_ctl; /* Cache last written value */ 619 unsigned int pio_mask; 620 unsigned int mwdma_mask; 621 unsigned int udma_mask; 622 unsigned int cbl; /* cable type; ATA_CBL_xxx */ 623 624 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE]; 625 unsigned long qc_allocated; 626 unsigned int qc_active; 627 int nr_active_links; /* #links with active qcs */ 628 629 struct ata_link link; /* host default link */ 630 631 int nr_pmp_links; /* nr of available PMP links */ 632 struct ata_link *pmp_link; /* array of PMP links */ 633 struct ata_link *excl_link; /* for PMP qc exclusion */ 634 635 struct ata_port_stats stats; 636 struct ata_host *host; 637 struct device *dev; 638 639 void *port_task_data; 640 struct delayed_work port_task; 641 struct delayed_work hotplug_task; 642 struct work_struct scsi_rescan_task; 643 644 unsigned int hsm_task_state; 645 646 u32 msg_enable; 647 struct list_head eh_done_q; 648 wait_queue_head_t eh_wait_q; 649 int eh_tries; 650 651 pm_message_t pm_mesg; 652 int *pm_result; 653 enum link_pm pm_policy; 654 655 struct timer_list fastdrain_timer; 656 unsigned long fastdrain_cnt; 657 658 void *private_data; 659 660#ifdef CONFIG_ATA_ACPI 661 acpi_handle acpi_handle; 662 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */ 663#endif 664 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */ 665}; 666 667struct ata_port_operations { 668 void (*dev_config) (struct ata_device *); 669 670 void (*set_piomode) (struct ata_port *, struct ata_device *); 671 void (*set_dmamode) (struct ata_port *, struct ata_device *); 672 unsigned long (*mode_filter) (struct ata_device *, unsigned long); 673 674 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf); 675 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf); 676 677 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf); 678 u8 (*check_status)(struct ata_port *ap); 679 u8 (*check_altstatus)(struct ata_port *ap); 680 void (*dev_select)(struct ata_port *ap, unsigned int device); 681 682 void (*phy_reset) (struct ata_port *ap); /* obsolete */ 683 int (*set_mode) (struct ata_link *link, struct ata_device **r_failed_dev); 684 685 int (*cable_detect) (struct ata_port *ap); 686 687 int (*check_atapi_dma) (struct ata_queued_cmd *qc); 688 689 void (*bmdma_setup) (struct ata_queued_cmd *qc); 690 void (*bmdma_start) (struct ata_queued_cmd *qc); 691 692 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int); 693 694 int (*qc_defer) (struct ata_queued_cmd *qc); 695 void (*qc_prep) (struct ata_queued_cmd *qc); 696 unsigned int (*qc_issue) (struct ata_queued_cmd *qc); 697 698 /* port multiplier */ 699 void (*pmp_attach) (struct ata_port *ap); 700 void (*pmp_detach) (struct ata_port *ap); 701 702 /* Error handlers. ->error_handler overrides ->eng_timeout and 703 * indicates that new-style EH is in place. 704 */ 705 void (*eng_timeout) (struct ata_port *ap); /* obsolete */ 706 707 void (*freeze) (struct ata_port *ap); 708 void (*thaw) (struct ata_port *ap); 709 void (*error_handler) (struct ata_port *ap); 710 void (*post_internal_cmd) (struct ata_queued_cmd *qc); 711 712 irq_handler_t irq_handler; 713 void (*irq_clear) (struct ata_port *); 714 u8 (*irq_on) (struct ata_port *); 715 716 int (*scr_read) (struct ata_port *ap, unsigned int sc_reg, u32 *val); 717 int (*scr_write) (struct ata_port *ap, unsigned int sc_reg, u32 val); 718 719 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg); 720 int (*port_resume) (struct ata_port *ap); 721 int (*enable_pm) (struct ata_port *ap, enum link_pm policy); 722 void (*disable_pm) (struct ata_port *ap); 723 int (*port_start) (struct ata_port *ap); 724 void (*port_stop) (struct ata_port *ap); 725 726 void (*host_stop) (struct ata_host *host); 727 728 void (*bmdma_stop) (struct ata_queued_cmd *qc); 729 u8 (*bmdma_status) (struct ata_port *ap); 730}; 731 732struct ata_port_info { 733 struct scsi_host_template *sht; 734 unsigned long flags; 735 unsigned long link_flags; 736 unsigned long pio_mask; 737 unsigned long mwdma_mask; 738 unsigned long udma_mask; 739 const struct ata_port_operations *port_ops; 740 irq_handler_t irq_handler; 741 void *private_data; 742}; 743 744struct ata_timing { 745 unsigned short mode; /* ATA mode */ 746 unsigned short setup; /* t1 */ 747 unsigned short act8b; /* t2 for 8-bit I/O */ 748 unsigned short rec8b; /* t2i for 8-bit I/O */ 749 unsigned short cyc8b; /* t0 for 8-bit I/O */ 750 unsigned short active; /* t2 or tD */ 751 unsigned short recover; /* t2i or tK */ 752 unsigned short cycle; /* t0 */ 753 unsigned short udma; /* t2CYCTYP/2 */ 754}; 755 756#define FIT(v, vmin, vmax) max_t(short, min_t(short, v, vmax), vmin) 757 758extern const unsigned long sata_deb_timing_normal[]; 759extern const unsigned long sata_deb_timing_hotplug[]; 760extern const unsigned long sata_deb_timing_long[]; 761 762extern const struct ata_port_operations ata_dummy_port_ops; 763extern const struct ata_port_info ata_dummy_port_info; 764 765static inline const unsigned long * 766sata_ehc_deb_timing(struct ata_eh_context *ehc) 767{ 768 if (ehc->i.flags & ATA_EHI_HOTPLUGGED) 769 return sata_deb_timing_hotplug; 770 else 771 return sata_deb_timing_normal; 772} 773 774static inline int ata_port_is_dummy(struct ata_port *ap) 775{ 776 return ap->ops == &ata_dummy_port_ops; 777} 778 779extern void sata_print_link_status(struct ata_link *link); 780extern void ata_port_probe(struct ata_port *); 781extern void ata_bus_reset(struct ata_port *ap); 782extern int sata_set_spd(struct ata_link *link); 783extern int sata_link_debounce(struct ata_link *link, 784 const unsigned long *params, unsigned long deadline); 785extern int sata_link_resume(struct ata_link *link, const unsigned long *params, 786 unsigned long deadline); 787extern int ata_std_prereset(struct ata_link *link, unsigned long deadline); 788extern int ata_std_softreset(struct ata_link *link, unsigned int *classes, 789 unsigned long deadline); 790extern int sata_link_hardreset(struct ata_link *link, 791 const unsigned long *timing, unsigned long deadline); 792extern int sata_std_hardreset(struct ata_link *link, unsigned int *class, 793 unsigned long deadline); 794extern void ata_std_postreset(struct ata_link *link, unsigned int *classes); 795extern void ata_port_disable(struct ata_port *); 796extern void ata_std_ports(struct ata_ioports *ioaddr); 797 798extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports); 799extern struct ata_host *ata_host_alloc_pinfo(struct device *dev, 800 const struct ata_port_info * const * ppi, int n_ports); 801extern int ata_host_start(struct ata_host *host); 802extern int ata_host_register(struct ata_host *host, 803 struct scsi_host_template *sht); 804extern int ata_host_activate(struct ata_host *host, int irq, 805 irq_handler_t irq_handler, unsigned long irq_flags, 806 struct scsi_host_template *sht); 807extern void ata_host_detach(struct ata_host *host); 808extern void ata_host_init(struct ata_host *, struct device *, 809 unsigned long, const struct ata_port_operations *); 810extern int ata_scsi_detect(struct scsi_host_template *sht); 811extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg); 812extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *)); 813extern void ata_sas_port_destroy(struct ata_port *); 814extern struct ata_port *ata_sas_port_alloc(struct ata_host *, 815 struct ata_port_info *, struct Scsi_Host *); 816extern int ata_sas_port_init(struct ata_port *); 817extern int ata_sas_port_start(struct ata_port *ap); 818extern void ata_sas_port_stop(struct ata_port *ap); 819extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *); 820extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), 821 struct ata_port *ap); 822extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc); 823extern int sata_scr_valid(struct ata_link *link); 824extern int sata_scr_read(struct ata_link *link, int reg, u32 *val); 825extern int sata_scr_write(struct ata_link *link, int reg, u32 val); 826extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val); 827extern int ata_link_online(struct ata_link *link); 828extern int ata_link_offline(struct ata_link *link); 829#ifdef CONFIG_PM 830extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg); 831extern void ata_host_resume(struct ata_host *host); 832#endif 833extern int ata_ratelimit(void); 834extern int ata_busy_sleep(struct ata_port *ap, 835 unsigned long timeout_pat, unsigned long timeout); 836extern void ata_wait_after_reset(struct ata_port *ap, unsigned long deadline); 837extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline); 838extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn, 839 void *data, unsigned long delay); 840extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val, 841 unsigned long interval_msec, 842 unsigned long timeout_msec); 843extern unsigned int ata_dev_try_classify(struct ata_device *dev, int present, 844 u8 *r_err); 845 846/* 847 * Default driver ops implementations 848 */ 849extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf); 850extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf); 851extern void ata_tf_to_fis(const struct ata_taskfile *tf, 852 u8 pmp, int is_cmd, u8 *fis); 853extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf); 854extern unsigned int ata_pack_xfermask(unsigned int pio_mask, 855 unsigned int mwdma_mask, unsigned int udma_mask); 856extern void ata_unpack_xfermask(unsigned int xfer_mask, unsigned int *pio_mask, 857 unsigned int *mwdma_mask, unsigned int *udma_mask); 858extern u8 ata_xfer_mask2mode(unsigned int xfer_mask); 859extern unsigned int ata_xfer_mode2mask(u8 xfer_mode); 860extern int ata_xfer_mode2shift(unsigned int xfer_mode); 861extern const char *ata_mode_string(unsigned int xfer_mask); 862extern unsigned int ata_id_xfermask(const u16 *id); 863extern void ata_noop_dev_select(struct ata_port *ap, unsigned int device); 864extern void ata_std_dev_select(struct ata_port *ap, unsigned int device); 865extern u8 ata_check_status(struct ata_port *ap); 866extern u8 ata_altstatus(struct ata_port *ap); 867extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf); 868extern int ata_port_start(struct ata_port *ap); 869extern int ata_sff_port_start(struct ata_port *ap); 870extern irqreturn_t ata_interrupt(int irq, void *dev_instance); 871extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf, 872 unsigned int buflen, int write_data); 873extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf, 874 unsigned int buflen, int write_data); 875extern int ata_std_qc_defer(struct ata_queued_cmd *qc); 876extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc); 877extern void ata_qc_prep(struct ata_queued_cmd *qc); 878extern void ata_noop_qc_prep(struct ata_queued_cmd *qc); 879extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc); 880extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf, 881 unsigned int buflen); 882extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg, 883 unsigned int n_elem); 884extern unsigned int ata_dev_classify(const struct ata_taskfile *tf); 885extern void ata_dev_disable(struct ata_device *adev); 886extern void ata_id_string(const u16 *id, unsigned char *s, 887 unsigned int ofs, unsigned int len); 888extern void ata_id_c_string(const u16 *id, unsigned char *s, 889 unsigned int ofs, unsigned int len); 890extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown); 891extern void ata_bmdma_setup(struct ata_queued_cmd *qc); 892extern void ata_bmdma_start(struct ata_queued_cmd *qc); 893extern void ata_bmdma_stop(struct ata_queued_cmd *qc); 894extern u8 ata_bmdma_status(struct ata_port *ap); 895extern void ata_bmdma_irq_clear(struct ata_port *ap); 896extern void ata_bmdma_freeze(struct ata_port *ap); 897extern void ata_bmdma_thaw(struct ata_port *ap); 898extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset, 899 ata_reset_fn_t softreset, 900 ata_reset_fn_t hardreset, 901 ata_postreset_fn_t postreset); 902extern void ata_bmdma_error_handler(struct ata_port *ap); 903extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc); 904extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc, 905 u8 status, int in_wq); 906extern void ata_qc_complete(struct ata_queued_cmd *qc); 907extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active, 908 void (*finish_qc)(struct ata_queued_cmd *)); 909extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd, 910 void (*done)(struct scsi_cmnd *)); 911extern int ata_std_bios_param(struct scsi_device *sdev, 912 struct block_device *bdev, 913 sector_t capacity, int geom[]); 914extern int ata_scsi_slave_config(struct scsi_device *sdev); 915extern void ata_scsi_slave_destroy(struct scsi_device *sdev); 916extern int ata_scsi_change_queue_depth(struct scsi_device *sdev, 917 int queue_depth); 918extern struct ata_device *ata_dev_pair(struct ata_device *adev); 919extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev); 920extern u8 ata_irq_on(struct ata_port *ap); 921 922extern int ata_cable_40wire(struct ata_port *ap); 923extern int ata_cable_80wire(struct ata_port *ap); 924extern int ata_cable_sata(struct ata_port *ap); 925extern int ata_cable_unknown(struct ata_port *ap); 926 927/* 928 * Timing helpers 929 */ 930 931extern unsigned int ata_pio_need_iordy(const struct ata_device *); 932extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode); 933extern int ata_timing_compute(struct ata_device *, unsigned short, 934 struct ata_timing *, int, int); 935extern void ata_timing_merge(const struct ata_timing *, 936 const struct ata_timing *, struct ata_timing *, 937 unsigned int); 938 939enum { 940 ATA_TIMING_SETUP = (1 << 0), 941 ATA_TIMING_ACT8B = (1 << 1), 942 ATA_TIMING_REC8B = (1 << 2), 943 ATA_TIMING_CYC8B = (1 << 3), 944 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B | 945 ATA_TIMING_CYC8B, 946 ATA_TIMING_ACTIVE = (1 << 4), 947 ATA_TIMING_RECOVER = (1 << 5), 948 ATA_TIMING_CYCLE = (1 << 6), 949 ATA_TIMING_UDMA = (1 << 7), 950 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B | 951 ATA_TIMING_REC8B | ATA_TIMING_CYC8B | 952 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER | 953 ATA_TIMING_CYCLE | ATA_TIMING_UDMA, 954}; 955 956/* libata-acpi.c */ 957#ifdef CONFIG_ATA_ACPI 958static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap) 959{ 960 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID) 961 return &ap->__acpi_init_gtm; 962 return NULL; 963} 964extern int ata_acpi_cbl_80wire(struct ata_port *ap); 965int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm); 966int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm); 967#else 968static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap) 969{ 970 return NULL; 971} 972static inline int ata_acpi_cbl_80wire(struct ata_port *ap) { return 0; } 973#endif 974 975#ifdef CONFIG_PCI 976struct pci_dev; 977 978extern int ata_pci_init_one(struct pci_dev *pdev, 979 const struct ata_port_info * const * ppi); 980extern void ata_pci_remove_one(struct pci_dev *pdev); 981#ifdef CONFIG_PM 982extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg); 983extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev); 984extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg); 985extern int ata_pci_device_resume(struct pci_dev *pdev); 986#endif 987extern int ata_pci_clear_simplex(struct pci_dev *pdev); 988 989struct pci_bits { 990 unsigned int reg; /* PCI config register to read */ 991 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */ 992 unsigned long mask; 993 unsigned long val; 994}; 995 996extern int ata_pci_init_sff_host(struct ata_host *host); 997extern int ata_pci_init_bmdma(struct ata_host *host); 998extern int ata_pci_prepare_sff_host(struct pci_dev *pdev, 999 const struct ata_port_info * const * ppi, 1000 struct ata_host **r_host); 1001extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits); 1002extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long); 1003#endif /* CONFIG_PCI */ 1004 1005/* 1006 * PMP 1007 */ 1008extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc); 1009extern int sata_pmp_std_prereset(struct ata_link *link, unsigned long deadline); 1010extern int sata_pmp_std_hardreset(struct ata_link *link, unsigned int *class, 1011 unsigned long deadline); 1012extern void sata_pmp_std_postreset(struct ata_link *link, unsigned int *class); 1013extern void sata_pmp_do_eh(struct ata_port *ap, 1014 ata_prereset_fn_t prereset, ata_reset_fn_t softreset, 1015 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset, 1016 ata_prereset_fn_t pmp_prereset, ata_reset_fn_t pmp_softreset, 1017 ata_reset_fn_t pmp_hardreset, ata_postreset_fn_t pmp_postreset); 1018 1019/* 1020 * EH 1021 */ 1022extern void ata_port_schedule_eh(struct ata_port *ap); 1023extern int ata_link_abort(struct ata_link *link); 1024extern int ata_port_abort(struct ata_port *ap); 1025extern int ata_port_freeze(struct ata_port *ap); 1026extern int sata_async_notification(struct ata_port *ap); 1027 1028extern void ata_eh_freeze_port(struct ata_port *ap); 1029extern void ata_eh_thaw_port(struct ata_port *ap); 1030 1031extern void ata_eh_qc_complete(struct ata_queued_cmd *qc); 1032extern void ata_eh_qc_retry(struct ata_queued_cmd *qc); 1033 1034extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset, 1035 ata_reset_fn_t softreset, ata_reset_fn_t hardreset, 1036 ata_postreset_fn_t postreset); 1037 1038/* 1039 * printk helpers 1040 */ 1041#define ata_port_printk(ap, lv, fmt, args...) \ 1042 printk("%sata%u: "fmt, lv, (ap)->print_id , ##args) 1043 1044#define ata_link_printk(link, lv, fmt, args...) do { \ 1045 if ((link)->ap->nr_pmp_links) \ 1046 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \ 1047 (link)->pmp , ##args); \ 1048 else \ 1049 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \ 1050 } while(0) 1051 1052#define ata_dev_printk(dev, lv, fmt, args...) \ 1053 printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \ 1054 (dev)->link->pmp + (dev)->devno , ##args) 1055 1056/* 1057 * ata_eh_info helpers 1058 */ 1059extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...) 1060 __attribute__ ((format (printf, 2, 3))); 1061extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...) 1062 __attribute__ ((format (printf, 2, 3))); 1063extern void ata_ehi_clear_desc(struct ata_eh_info *ehi); 1064 1065static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi) 1066{ 1067 ehi->flags |= ATA_EHI_RESUME_LINK; 1068 ehi->action |= ATA_EH_SOFTRESET; 1069 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1; 1070} 1071 1072static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi) 1073{ 1074 ata_ehi_schedule_probe(ehi); 1075 ehi->flags |= ATA_EHI_HOTPLUGGED; 1076 ehi->action |= ATA_EH_ENABLE_LINK; 1077 ehi->err_mask |= AC_ERR_ATA_BUS; 1078} 1079 1080/* 1081 * port description helpers 1082 */ 1083extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...) 1084 __attribute__ ((format (printf, 2, 3))); 1085#ifdef CONFIG_PCI 1086extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset, 1087 const char *name); 1088#endif 1089 1090/* 1091 * qc helpers 1092 */ 1093static inline struct scatterlist * 1094ata_qc_first_sg(struct ata_queued_cmd *qc) 1095{ 1096 qc->n_iter = 0; 1097 if (qc->n_elem) 1098 return qc->__sg; 1099 if (qc->pad_len) 1100 return &qc->pad_sgent; 1101 return NULL; 1102} 1103 1104static inline struct scatterlist * 1105ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc) 1106{ 1107 if (sg == &qc->pad_sgent) 1108 return NULL; 1109 if (++qc->n_iter < qc->n_elem) 1110 return sg_next(sg); 1111 if (qc->pad_len) 1112 return &qc->pad_sgent; 1113 return NULL; 1114} 1115 1116#define ata_for_each_sg(sg, qc) \ 1117 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc)) 1118 1119static inline unsigned int ata_tag_valid(unsigned int tag) 1120{ 1121 return (tag < ATA_MAX_QUEUE) ? 1 : 0; 1122} 1123 1124static inline unsigned int ata_tag_internal(unsigned int tag) 1125{ 1126 return tag == ATA_MAX_QUEUE - 1; 1127} 1128 1129/* 1130 * device helpers 1131 */ 1132static inline unsigned int ata_class_enabled(unsigned int class) 1133{ 1134 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI || 1135 class == ATA_DEV_PMP || class == ATA_DEV_SEMB; 1136} 1137 1138static inline unsigned int ata_class_disabled(unsigned int class) 1139{ 1140 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP || 1141 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP; 1142} 1143 1144static inline unsigned int ata_class_absent(unsigned int class) 1145{ 1146 return !ata_class_enabled(class) && !ata_class_disabled(class); 1147} 1148 1149static inline unsigned int ata_dev_enabled(const struct ata_device *dev) 1150{ 1151 return ata_class_enabled(dev->class); 1152} 1153 1154static inline unsigned int ata_dev_disabled(const struct ata_device *dev) 1155{ 1156 return ata_class_disabled(dev->class); 1157} 1158 1159static inline unsigned int ata_dev_absent(const struct ata_device *dev) 1160{ 1161 return ata_class_absent(dev->class); 1162} 1163 1164/* 1165 * link helpers 1166 */ 1167static inline int ata_is_host_link(const struct ata_link *link) 1168{ 1169 return link == &link->ap->link; 1170} 1171 1172static inline int ata_link_max_devices(const struct ata_link *link) 1173{ 1174 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS) 1175 return 2; 1176 return 1; 1177} 1178 1179static inline int ata_link_active(struct ata_link *link) 1180{ 1181 return ata_tag_valid(link->active_tag) || link->sactive; 1182} 1183 1184static inline struct ata_link *ata_port_first_link(struct ata_port *ap) 1185{ 1186 if (ap->nr_pmp_links) 1187 return ap->pmp_link; 1188 return &ap->link; 1189} 1190 1191static inline struct ata_link *ata_port_next_link(struct ata_link *link) 1192{ 1193 struct ata_port *ap = link->ap; 1194 1195 if (link == &ap->link) { 1196 if (!ap->nr_pmp_links) 1197 return NULL; 1198 return ap->pmp_link; 1199 } 1200 1201 if (++link - ap->pmp_link < ap->nr_pmp_links) 1202 return link; 1203 return NULL; 1204} 1205 1206#define __ata_port_for_each_link(lk, ap) \ 1207 for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk)) 1208 1209#define ata_port_for_each_link(link, ap) \ 1210 for ((link) = ata_port_first_link(ap); (link); \ 1211 (link) = ata_port_next_link(link)) 1212 1213#define ata_link_for_each_dev(dev, link) \ 1214 for ((dev) = (link)->device; \ 1215 (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \ 1216 (dev)++) 1217 1218#define ata_link_for_each_dev_reverse(dev, link) \ 1219 for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \ 1220 (dev) >= (link)->device || ((dev) = NULL); (dev)--) 1221 1222static inline u8 ata_chk_status(struct ata_port *ap) 1223{ 1224 return ap->ops->check_status(ap); 1225} 1226 1227/** 1228 * ata_ncq_enabled - Test whether NCQ is enabled 1229 * @dev: ATA device to test for 1230 * 1231 * LOCKING: 1232 * spin_lock_irqsave(host lock) 1233 * 1234 * RETURNS: 1235 * 1 if NCQ is enabled for @dev, 0 otherwise. 1236 */ 1237static inline int ata_ncq_enabled(struct ata_device *dev) 1238{ 1239 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF | 1240 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ; 1241} 1242 1243/** 1244 * ata_pause - Flush writes and pause 400 nanoseconds. 1245 * @ap: Port to wait for. 1246 * 1247 * LOCKING: 1248 * Inherited from caller. 1249 */ 1250 1251static inline void ata_pause(struct ata_port *ap) 1252{ 1253 ata_altstatus(ap); 1254 ndelay(400); 1255} 1256 1257 1258/** 1259 * ata_busy_wait - Wait for a port status register 1260 * @ap: Port to wait for. 1261 * @bits: bits that must be clear 1262 * @max: number of 10uS waits to perform 1263 * 1264 * Waits up to max*10 microseconds for the selected bits in the port's 1265 * status register to be cleared. 1266 * Returns final value of status register. 1267 * 1268 * LOCKING: 1269 * Inherited from caller. 1270 */ 1271 1272static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits, 1273 unsigned int max) 1274{ 1275 u8 status; 1276 1277 do { 1278 udelay(10); 1279 status = ata_chk_status(ap); 1280 max--; 1281 } while (status != 0xff && (status & bits) && (max > 0)); 1282 1283 return status; 1284} 1285 1286 1287/** 1288 * ata_wait_idle - Wait for a port to be idle. 1289 * @ap: Port to wait for. 1290 * 1291 * Waits up to 10ms for port's BUSY and DRQ signals to clear. 1292 * Returns final value of status register. 1293 * 1294 * LOCKING: 1295 * Inherited from caller. 1296 */ 1297 1298static inline u8 ata_wait_idle(struct ata_port *ap) 1299{ 1300 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000); 1301 1302#ifdef ATA_DEBUG 1303 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) 1304 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n", 1305 status); 1306#endif 1307 1308 return status; 1309} 1310 1311static inline void ata_qc_set_polling(struct ata_queued_cmd *qc) 1312{ 1313 qc->tf.ctl |= ATA_NIEN; 1314} 1315 1316static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap, 1317 unsigned int tag) 1318{ 1319 if (likely(ata_tag_valid(tag))) 1320 return &ap->qcmd[tag]; 1321 return NULL; 1322} 1323 1324static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap, 1325 unsigned int tag) 1326{ 1327 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag); 1328 1329 if (unlikely(!qc) || !ap->ops->error_handler) 1330 return qc; 1331 1332 if ((qc->flags & (ATA_QCFLAG_ACTIVE | 1333 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE) 1334 return qc; 1335 1336 return NULL; 1337} 1338 1339static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf) 1340{ 1341 memset(tf, 0, sizeof(*tf)); 1342 1343 tf->ctl = dev->link->ap->ctl; 1344 if (dev->devno == 0) 1345 tf->device = ATA_DEVICE_OBS; 1346 else 1347 tf->device = ATA_DEVICE_OBS | ATA_DEV1; 1348} 1349 1350static inline void ata_qc_reinit(struct ata_queued_cmd *qc) 1351{ 1352 qc->dma_dir = DMA_NONE; 1353 qc->__sg = NULL; 1354 qc->flags = 0; 1355 qc->cursg = NULL; 1356 qc->cursg_ofs = 0; 1357 qc->nbytes = qc->curbytes = 0; 1358 qc->n_elem = 0; 1359 qc->n_iter = 0; 1360 qc->err_mask = 0; 1361 qc->pad_len = 0; 1362 qc->sect_size = ATA_SECT_SIZE; 1363 1364 ata_tf_init(qc->dev, &qc->tf); 1365 1366 /* init result_tf such that it indicates normal completion */ 1367 qc->result_tf.command = ATA_DRDY; 1368 qc->result_tf.feature = 0; 1369} 1370 1371static inline int ata_try_flush_cache(const struct ata_device *dev) 1372{ 1373 return ata_id_wcache_enabled(dev->id) || 1374 ata_id_has_flush(dev->id) || 1375 ata_id_has_flush_ext(dev->id); 1376} 1377 1378static inline unsigned int ac_err_mask(u8 status) 1379{ 1380 if (status & (ATA_BUSY | ATA_DRQ)) 1381 return AC_ERR_HSM; 1382 if (status & (ATA_ERR | ATA_DF)) 1383 return AC_ERR_DEV; 1384 return 0; 1385} 1386 1387static inline unsigned int __ac_err_mask(u8 status) 1388{ 1389 unsigned int mask = ac_err_mask(status); 1390 if (mask == 0) 1391 return AC_ERR_OTHER; 1392 return mask; 1393} 1394 1395static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev) 1396{ 1397 ap->pad_dma = 0; 1398 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ, 1399 &ap->pad_dma, GFP_KERNEL); 1400 return (ap->pad == NULL) ? -ENOMEM : 0; 1401} 1402 1403static inline void ata_pad_free(struct ata_port *ap, struct device *dev) 1404{ 1405 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma); 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 1413#endif /* __LINUX_LIBATA_H__ */ 1414