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