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