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