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