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