libata.h revision 75e995855f45a83afdae34d50c0b3ee14fb23b7a
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/io.h> 34#include <linux/ata.h> 35#include <linux/workqueue.h> 36#include <scsi/scsi_host.h> 37 38/* 39 * compile-time options: to be removed as soon as all the drivers are 40 * converted to the new debugging mechanism 41 */ 42#undef ATA_DEBUG /* debugging output */ 43#undef ATA_VERBOSE_DEBUG /* yet more debugging output */ 44#undef ATA_IRQ_TRAP /* define to ack screaming irqs */ 45#undef ATA_NDEBUG /* define to disable quick runtime checks */ 46#undef ATA_ENABLE_PATA /* define to enable PATA support in some 47 * low-level drivers */ 48 49 50/* note: prints function name for you */ 51#ifdef ATA_DEBUG 52#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) 53#ifdef ATA_VERBOSE_DEBUG 54#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) 55#else 56#define VPRINTK(fmt, args...) 57#endif /* ATA_VERBOSE_DEBUG */ 58#else 59#define DPRINTK(fmt, args...) 60#define VPRINTK(fmt, args...) 61#endif /* ATA_DEBUG */ 62 63#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) 64 65/* NEW: debug levels */ 66#define HAVE_LIBATA_MSG 1 67 68enum { 69 ATA_MSG_DRV = 0x0001, 70 ATA_MSG_INFO = 0x0002, 71 ATA_MSG_PROBE = 0x0004, 72 ATA_MSG_WARN = 0x0008, 73 ATA_MSG_MALLOC = 0x0010, 74 ATA_MSG_CTL = 0x0020, 75 ATA_MSG_INTR = 0x0040, 76 ATA_MSG_ERR = 0x0080, 77}; 78 79#define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV) 80#define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO) 81#define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE) 82#define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN) 83#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC) 84#define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL) 85#define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR) 86#define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR) 87 88static inline u32 ata_msg_init(int dval, int default_msg_enable_bits) 89{ 90 if (dval < 0 || dval >= (sizeof(u32) * 8)) 91 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */ 92 if (!dval) 93 return 0; 94 return (1 << dval) - 1; 95} 96 97/* defines only for the constants which don't work well as enums */ 98#define ATA_TAG_POISON 0xfafbfcfdU 99 100/* move to PCI layer? */ 101static inline struct device *pci_dev_to_dev(struct pci_dev *pdev) 102{ 103 return &pdev->dev; 104} 105 106enum { 107 /* various global constants */ 108 LIBATA_MAX_PRD = ATA_MAX_PRD / 2, 109 ATA_MAX_PORTS = 8, 110 ATA_DEF_QUEUE = 1, 111 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */ 112 ATA_MAX_QUEUE = 32, 113 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1, 114 ATA_MAX_SECTORS = 200, /* FIXME */ 115 ATA_MAX_SECTORS_LBA48 = 65535, 116 ATA_MAX_BUS = 2, 117 ATA_DEF_BUSY_WAIT = 10000, 118 ATA_SHORT_PAUSE = (HZ >> 6) + 1, 119 120 ATA_SHT_EMULATED = 1, 121 ATA_SHT_CMD_PER_LUN = 1, 122 ATA_SHT_THIS_ID = -1, 123 ATA_SHT_USE_CLUSTERING = 1, 124 125 /* struct ata_device stuff */ 126 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */ 127 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */ 128 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */ 129 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */ 130 ATA_DFLAG_CFG_MASK = (1 << 8) - 1, 131 132 ATA_DFLAG_PIO = (1 << 8), /* device currently in PIO mode */ 133 134 ATA_DEV_UNKNOWN = 0, /* unknown device */ 135 ATA_DEV_ATA = 1, /* ATA device */ 136 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */ 137 ATA_DEV_ATAPI = 3, /* ATAPI device */ 138 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */ 139 ATA_DEV_NONE = 5, /* no device */ 140 141 /* struct ata_port flags */ 142 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */ 143 /* (doesn't imply presence) */ 144 ATA_FLAG_SATA = (1 << 1), 145 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */ 146 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */ 147 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */ 148 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */ 149 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */ 150 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */ 151 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */ 152 ATA_FLAG_PIO_POLLING = (1 << 10), /* use polling PIO if LLD 153 * doesn't handle PIO interrupts */ 154 ATA_FLAG_NCQ = (1 << 11), /* host supports NCQ */ 155 156 ATA_FLAG_DEBUGMSG = (1 << 14), 157 ATA_FLAG_FLUSH_PORT_TASK = (1 << 15), /* flush port task */ 158 159 ATA_FLAG_EH_PENDING = (1 << 16), /* EH pending */ 160 ATA_FLAG_FROZEN = (1 << 17), /* port is frozen */ 161 ATA_FLAG_RECOVERED = (1 << 18), /* recovery action performed */ 162 163 ATA_FLAG_DISABLED = (1 << 22), /* port is disabled, ignore it */ 164 ATA_FLAG_SUSPENDED = (1 << 23), /* port is suspended (power) */ 165 166 /* bits 24:31 of ap->flags are reserved for LLDD specific flags */ 167 168 /* struct ata_queued_cmd flags */ 169 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */ 170 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */ 171 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */ 172 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE, 173 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */ 174 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */ 175 176 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */ 177 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */ 178 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */ 179 180 /* host set flags */ 181 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host_set only */ 182 183 /* various lengths of time */ 184 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */ 185 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */ 186 ATA_TMOUT_INTERNAL = 30 * HZ, 187 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ, 188 189 /* ATA bus states */ 190 BUS_UNKNOWN = 0, 191 BUS_DMA = 1, 192 BUS_IDLE = 2, 193 BUS_NOINTR = 3, 194 BUS_NODATA = 4, 195 BUS_TIMER = 5, 196 BUS_PIO = 6, 197 BUS_EDD = 7, 198 BUS_IDENTIFY = 8, 199 BUS_PACKET = 9, 200 201 /* SATA port states */ 202 PORT_UNKNOWN = 0, 203 PORT_ENABLED = 1, 204 PORT_DISABLED = 2, 205 206 /* encoding various smaller bitmaps into a single 207 * unsigned int bitmap 208 */ 209 ATA_BITS_PIO = 5, 210 ATA_BITS_MWDMA = 3, 211 ATA_BITS_UDMA = 8, 212 213 ATA_SHIFT_PIO = 0, 214 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO, 215 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA, 216 217 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO, 218 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA, 219 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA, 220 221 /* size of buffer to pad xfers ending on unaligned boundaries */ 222 ATA_DMA_PAD_SZ = 4, 223 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE, 224 225 /* masks for port functions */ 226 ATA_PORT_PRIMARY = (1 << 0), 227 ATA_PORT_SECONDARY = (1 << 1), 228 229 /* ering size */ 230 ATA_ERING_SIZE = 32, 231 232 /* desc_len for ata_eh_info and context */ 233 ATA_EH_DESC_LEN = 80, 234 235 /* reset / recovery action types */ 236 ATA_EH_REVALIDATE = (1 << 0), 237 ATA_EH_SOFTRESET = (1 << 1), 238 ATA_EH_HARDRESET = (1 << 2), 239 240 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET, 241 242 /* ata_eh_info->flags */ 243 ATA_EHI_DID_RESET = (1 << 0), /* already reset this port */ 244 245 /* max repeat if error condition is still set after ->error_handler */ 246 ATA_EH_MAX_REPEAT = 5, 247 248 /* how hard are we gonna try to probe/recover devices */ 249 ATA_PROBE_MAX_TRIES = 3, 250 ATA_EH_RESET_TRIES = 3, 251 ATA_EH_DEV_TRIES = 3, 252}; 253 254enum hsm_task_states { 255 HSM_ST_UNKNOWN, /* state unknown */ 256 HSM_ST_IDLE, /* no command on going */ 257 HSM_ST, /* (waiting the device to) transfer data */ 258 HSM_ST_LAST, /* (waiting the device to) complete command */ 259 HSM_ST_ERR, /* error */ 260 HSM_ST_FIRST, /* (waiting the device to) 261 write CDB or first data block */ 262}; 263 264enum ata_completion_errors { 265 AC_ERR_DEV = (1 << 0), /* device reported error */ 266 AC_ERR_HSM = (1 << 1), /* host state machine violation */ 267 AC_ERR_TIMEOUT = (1 << 2), /* timeout */ 268 AC_ERR_MEDIA = (1 << 3), /* media error */ 269 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */ 270 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */ 271 AC_ERR_SYSTEM = (1 << 6), /* system error */ 272 AC_ERR_INVALID = (1 << 7), /* invalid argument */ 273 AC_ERR_OTHER = (1 << 8), /* unknown */ 274}; 275 276/* forward declarations */ 277struct scsi_device; 278struct ata_port_operations; 279struct ata_port; 280struct ata_queued_cmd; 281 282/* typedefs */ 283typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc); 284typedef void (*ata_probeinit_fn_t)(struct ata_port *); 285typedef int (*ata_reset_fn_t)(struct ata_port *, unsigned int *); 286typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *); 287 288struct ata_ioports { 289 unsigned long cmd_addr; 290 unsigned long data_addr; 291 unsigned long error_addr; 292 unsigned long feature_addr; 293 unsigned long nsect_addr; 294 unsigned long lbal_addr; 295 unsigned long lbam_addr; 296 unsigned long lbah_addr; 297 unsigned long device_addr; 298 unsigned long status_addr; 299 unsigned long command_addr; 300 unsigned long altstatus_addr; 301 unsigned long ctl_addr; 302 unsigned long bmdma_addr; 303 unsigned long scr_addr; 304}; 305 306struct ata_probe_ent { 307 struct list_head node; 308 struct device *dev; 309 const struct ata_port_operations *port_ops; 310 struct scsi_host_template *sht; 311 struct ata_ioports port[ATA_MAX_PORTS]; 312 unsigned int n_ports; 313 unsigned int hard_port_no; 314 unsigned int pio_mask; 315 unsigned int mwdma_mask; 316 unsigned int udma_mask; 317 unsigned int legacy_mode; 318 unsigned long irq; 319 unsigned int irq_flags; 320 unsigned long host_flags; 321 unsigned long host_set_flags; 322 void __iomem *mmio_base; 323 void *private_data; 324}; 325 326struct ata_host_set { 327 spinlock_t lock; 328 struct device *dev; 329 unsigned long irq; 330 void __iomem *mmio_base; 331 unsigned int n_ports; 332 void *private_data; 333 const struct ata_port_operations *ops; 334 unsigned long flags; 335 int simplex_claimed; /* Keep seperate in case we 336 ever need to do this locked */ 337 struct ata_port * ports[0]; 338}; 339 340struct ata_queued_cmd { 341 struct ata_port *ap; 342 struct ata_device *dev; 343 344 struct scsi_cmnd *scsicmd; 345 void (*scsidone)(struct scsi_cmnd *); 346 347 struct ata_taskfile tf; 348 u8 cdb[ATAPI_CDB_LEN]; 349 350 unsigned long flags; /* ATA_QCFLAG_xxx */ 351 unsigned int tag; 352 unsigned int n_elem; 353 unsigned int orig_n_elem; 354 355 int dma_dir; 356 357 unsigned int pad_len; 358 359 unsigned int nsect; 360 unsigned int cursect; 361 362 unsigned int nbytes; 363 unsigned int curbytes; 364 365 unsigned int cursg; 366 unsigned int cursg_ofs; 367 368 struct scatterlist sgent; 369 struct scatterlist pad_sgent; 370 void *buf_virt; 371 372 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */ 373 struct scatterlist *__sg; 374 375 unsigned int err_mask; 376 struct ata_taskfile result_tf; 377 ata_qc_cb_t complete_fn; 378 379 void *private_data; 380}; 381 382struct ata_host_stats { 383 unsigned long unhandled_irq; 384 unsigned long idle_irq; 385 unsigned long rw_reqbuf; 386}; 387 388struct ata_ering_entry { 389 int is_io; 390 unsigned int err_mask; 391 u64 timestamp; 392}; 393 394struct ata_ering { 395 int cursor; 396 struct ata_ering_entry ring[ATA_ERING_SIZE]; 397}; 398 399struct ata_device { 400 struct ata_port *ap; 401 u64 n_sectors; /* size of device, if ATA */ 402 unsigned long flags; /* ATA_DFLAG_xxx */ 403 unsigned int class; /* ATA_DEV_xxx */ 404 unsigned int devno; /* 0 or 1 */ 405 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */ 406 u8 pio_mode; 407 u8 dma_mode; 408 u8 xfer_mode; 409 unsigned int xfer_shift; /* ATA_SHIFT_xxx */ 410 411 unsigned int multi_count; /* sectors count for 412 READ/WRITE MULTIPLE */ 413 unsigned int max_sectors; /* per-device max sectors */ 414 unsigned int cdb_len; 415 416 /* per-dev xfer mask */ 417 unsigned int pio_mask; 418 unsigned int mwdma_mask; 419 unsigned int udma_mask; 420 421 /* for CHS addressing */ 422 u16 cylinders; /* Number of cylinders */ 423 u16 heads; /* Number of heads */ 424 u16 sectors; /* Number of sectors per track */ 425 426 /* error history */ 427 struct ata_ering ering; 428}; 429 430struct ata_eh_info { 431 struct ata_device *dev; /* offending device */ 432 u32 serror; /* SError from LLDD */ 433 unsigned int err_mask; /* port-wide err_mask */ 434 unsigned int action; /* ATA_EH_* action mask */ 435 unsigned int flags; /* ATA_EHI_* flags */ 436 char desc[ATA_EH_DESC_LEN]; 437 int desc_len; 438}; 439 440struct ata_eh_context { 441 struct ata_eh_info i; 442 int tries[ATA_MAX_DEVICES]; 443}; 444 445struct ata_port { 446 struct Scsi_Host *host; /* our co-allocated scsi host */ 447 const struct ata_port_operations *ops; 448 unsigned long flags; /* ATA_FLAG_xxx */ 449 unsigned int id; /* unique id req'd by scsi midlyr */ 450 unsigned int port_no; /* unique port #; from zero */ 451 unsigned int hard_port_no; /* hardware port #; from zero */ 452 453 struct ata_prd *prd; /* our SG list */ 454 dma_addr_t prd_dma; /* and its DMA mapping */ 455 456 void *pad; /* array of DMA pad buffers */ 457 dma_addr_t pad_dma; 458 459 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */ 460 461 u8 ctl; /* cache of ATA control register */ 462 u8 last_ctl; /* Cache last written value */ 463 unsigned int pio_mask; 464 unsigned int mwdma_mask; 465 unsigned int udma_mask; 466 unsigned int cbl; /* cable type; ATA_CBL_xxx */ 467 unsigned int sata_spd_limit; /* SATA PHY speed limit */ 468 469 /* record runtime error info, protected by host_set lock */ 470 struct ata_eh_info eh_info; 471 /* EH context owned by EH */ 472 struct ata_eh_context eh_context; 473 474 struct ata_device device[ATA_MAX_DEVICES]; 475 476 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE]; 477 unsigned long qc_allocated; 478 unsigned int qc_active; 479 480 unsigned int active_tag; 481 u32 sactive; 482 483 struct ata_host_stats stats; 484 struct ata_host_set *host_set; 485 struct device *dev; 486 487 struct work_struct port_task; 488 489 unsigned int hsm_task_state; 490 491 u32 msg_enable; 492 struct list_head eh_done_q; 493 494 void *private_data; 495 496 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */ 497}; 498 499struct ata_port_operations { 500 void (*port_disable) (struct ata_port *); 501 502 void (*dev_config) (struct ata_port *, struct ata_device *); 503 504 void (*set_piomode) (struct ata_port *, struct ata_device *); 505 void (*set_dmamode) (struct ata_port *, struct ata_device *); 506 unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long); 507 508 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf); 509 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf); 510 511 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf); 512 u8 (*check_status)(struct ata_port *ap); 513 u8 (*check_altstatus)(struct ata_port *ap); 514 void (*dev_select)(struct ata_port *ap, unsigned int device); 515 516 void (*phy_reset) (struct ata_port *ap); /* obsolete */ 517 void (*set_mode) (struct ata_port *ap); 518 int (*probe_reset) (struct ata_port *ap, unsigned int *classes); 519 520 void (*post_set_mode) (struct ata_port *ap); 521 522 int (*check_atapi_dma) (struct ata_queued_cmd *qc); 523 524 void (*bmdma_setup) (struct ata_queued_cmd *qc); 525 void (*bmdma_start) (struct ata_queued_cmd *qc); 526 527 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int); 528 529 void (*qc_prep) (struct ata_queued_cmd *qc); 530 unsigned int (*qc_issue) (struct ata_queued_cmd *qc); 531 532 /* Error handlers. ->error_handler overrides ->eng_timeout and 533 * indicates that new-style EH is in place. 534 */ 535 void (*eng_timeout) (struct ata_port *ap); /* obsolete */ 536 537 void (*freeze) (struct ata_port *ap); 538 void (*thaw) (struct ata_port *ap); 539 void (*error_handler) (struct ata_port *ap); 540 void (*post_internal_cmd) (struct ata_queued_cmd *qc); 541 542 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *); 543 void (*irq_clear) (struct ata_port *); 544 545 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg); 546 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg, 547 u32 val); 548 549 int (*port_start) (struct ata_port *ap); 550 void (*port_stop) (struct ata_port *ap); 551 552 void (*host_stop) (struct ata_host_set *host_set); 553 554 void (*bmdma_stop) (struct ata_queued_cmd *qc); 555 u8 (*bmdma_status) (struct ata_port *ap); 556}; 557 558struct ata_port_info { 559 struct scsi_host_template *sht; 560 unsigned long host_flags; 561 unsigned long pio_mask; 562 unsigned long mwdma_mask; 563 unsigned long udma_mask; 564 const struct ata_port_operations *port_ops; 565 void *private_data; 566}; 567 568struct ata_timing { 569 unsigned short mode; /* ATA mode */ 570 unsigned short setup; /* t1 */ 571 unsigned short act8b; /* t2 for 8-bit I/O */ 572 unsigned short rec8b; /* t2i for 8-bit I/O */ 573 unsigned short cyc8b; /* t0 for 8-bit I/O */ 574 unsigned short active; /* t2 or tD */ 575 unsigned short recover; /* t2i or tK */ 576 unsigned short cycle; /* t0 */ 577 unsigned short udma; /* t2CYCTYP/2 */ 578}; 579 580#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin) 581 582extern void ata_port_probe(struct ata_port *); 583extern void __sata_phy_reset(struct ata_port *ap); 584extern void sata_phy_reset(struct ata_port *ap); 585extern void ata_bus_reset(struct ata_port *ap); 586extern int sata_set_spd(struct ata_port *ap); 587extern int ata_drive_probe_reset(struct ata_port *ap, 588 ata_probeinit_fn_t probeinit, 589 ata_reset_fn_t softreset, ata_reset_fn_t hardreset, 590 ata_postreset_fn_t postreset, unsigned int *classes); 591extern void ata_std_probeinit(struct ata_port *ap); 592extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes); 593extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class); 594extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes); 595extern int ata_dev_revalidate(struct ata_device *dev, int post_reset); 596extern void ata_port_disable(struct ata_port *); 597extern void ata_std_ports(struct ata_ioports *ioaddr); 598#ifdef CONFIG_PCI 599extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info, 600 unsigned int n_ports); 601extern void ata_pci_remove_one (struct pci_dev *pdev); 602extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state); 603extern int ata_pci_device_resume(struct pci_dev *pdev); 604extern int ata_pci_clear_simplex(struct pci_dev *pdev); 605#endif /* CONFIG_PCI */ 606extern int ata_device_add(const struct ata_probe_ent *ent); 607extern void ata_host_set_remove(struct ata_host_set *host_set); 608extern int ata_scsi_detect(struct scsi_host_template *sht); 609extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg); 610extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *)); 611extern int ata_scsi_release(struct Scsi_Host *host); 612extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc); 613extern int sata_scr_valid(struct ata_port *ap); 614extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val); 615extern int sata_scr_write(struct ata_port *ap, int reg, u32 val); 616extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val); 617extern int ata_port_online(struct ata_port *ap); 618extern int ata_port_offline(struct ata_port *ap); 619extern int ata_scsi_device_resume(struct scsi_device *); 620extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t state); 621extern int ata_device_resume(struct ata_device *); 622extern int ata_device_suspend(struct ata_device *, pm_message_t state); 623extern int ata_ratelimit(void); 624extern unsigned int ata_busy_sleep(struct ata_port *ap, 625 unsigned long timeout_pat, 626 unsigned long timeout); 627extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *), 628 void *data, unsigned long delay); 629extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val, 630 unsigned long interval_msec, 631 unsigned long timeout_msec); 632 633/* 634 * Default driver ops implementations 635 */ 636extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf); 637extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf); 638extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp); 639extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf); 640extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device); 641extern void ata_std_dev_select (struct ata_port *ap, unsigned int device); 642extern u8 ata_check_status(struct ata_port *ap); 643extern u8 ata_altstatus(struct ata_port *ap); 644extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf); 645extern int ata_std_probe_reset(struct ata_port *ap, unsigned int *classes); 646extern int ata_port_start (struct ata_port *ap); 647extern void ata_port_stop (struct ata_port *ap); 648extern void ata_host_stop (struct ata_host_set *host_set); 649extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs); 650extern void ata_mmio_data_xfer(struct ata_device *adev, unsigned char *buf, 651 unsigned int buflen, int write_data); 652extern void ata_pio_data_xfer(struct ata_device *adev, unsigned char *buf, 653 unsigned int buflen, int write_data); 654extern void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf, 655 unsigned int buflen, int write_data); 656extern void ata_qc_prep(struct ata_queued_cmd *qc); 657extern void ata_noop_qc_prep(struct ata_queued_cmd *qc); 658extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc); 659extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf, 660 unsigned int buflen); 661extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg, 662 unsigned int n_elem); 663extern unsigned int ata_dev_classify(const struct ata_taskfile *tf); 664extern void ata_id_string(const u16 *id, unsigned char *s, 665 unsigned int ofs, unsigned int len); 666extern void ata_id_c_string(const u16 *id, unsigned char *s, 667 unsigned int ofs, unsigned int len); 668extern void ata_bmdma_setup (struct ata_queued_cmd *qc); 669extern void ata_bmdma_start (struct ata_queued_cmd *qc); 670extern void ata_bmdma_stop(struct ata_queued_cmd *qc); 671extern u8 ata_bmdma_status(struct ata_port *ap); 672extern void ata_bmdma_irq_clear(struct ata_port *ap); 673extern void ata_bmdma_freeze(struct ata_port *ap); 674extern void ata_bmdma_thaw(struct ata_port *ap); 675extern void ata_bmdma_drive_eh(struct ata_port *ap, 676 ata_reset_fn_t softreset, 677 ata_reset_fn_t hardreset, 678 ata_postreset_fn_t postreset); 679extern void ata_bmdma_error_handler(struct ata_port *ap); 680extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc); 681extern void ata_qc_complete(struct ata_queued_cmd *qc); 682extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active, 683 void (*finish_qc)(struct ata_queued_cmd *)); 684extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd, 685 void (*done)(struct scsi_cmnd *)); 686extern int ata_std_bios_param(struct scsi_device *sdev, 687 struct block_device *bdev, 688 sector_t capacity, int geom[]); 689extern int ata_scsi_slave_config(struct scsi_device *sdev); 690extern int ata_scsi_change_queue_depth(struct scsi_device *sdev, 691 int queue_depth); 692extern struct ata_device *ata_dev_pair(struct ata_device *adev); 693 694/* 695 * Timing helpers 696 */ 697 698extern unsigned int ata_pio_need_iordy(const struct ata_device *); 699extern int ata_timing_compute(struct ata_device *, unsigned short, 700 struct ata_timing *, int, int); 701extern void ata_timing_merge(const struct ata_timing *, 702 const struct ata_timing *, struct ata_timing *, 703 unsigned int); 704 705enum { 706 ATA_TIMING_SETUP = (1 << 0), 707 ATA_TIMING_ACT8B = (1 << 1), 708 ATA_TIMING_REC8B = (1 << 2), 709 ATA_TIMING_CYC8B = (1 << 3), 710 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B | 711 ATA_TIMING_CYC8B, 712 ATA_TIMING_ACTIVE = (1 << 4), 713 ATA_TIMING_RECOVER = (1 << 5), 714 ATA_TIMING_CYCLE = (1 << 6), 715 ATA_TIMING_UDMA = (1 << 7), 716 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B | 717 ATA_TIMING_REC8B | ATA_TIMING_CYC8B | 718 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER | 719 ATA_TIMING_CYCLE | ATA_TIMING_UDMA, 720}; 721 722 723#ifdef CONFIG_PCI 724struct pci_bits { 725 unsigned int reg; /* PCI config register to read */ 726 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */ 727 unsigned long mask; 728 unsigned long val; 729}; 730 731extern void ata_pci_host_stop (struct ata_host_set *host_set); 732extern struct ata_probe_ent * 733ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask); 734extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits); 735extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long); 736#endif /* CONFIG_PCI */ 737 738/* 739 * EH 740 */ 741extern void ata_eng_timeout(struct ata_port *ap); 742 743extern void ata_port_schedule_eh(struct ata_port *ap); 744extern int ata_port_abort(struct ata_port *ap); 745extern int ata_port_freeze(struct ata_port *ap); 746 747extern void ata_eh_freeze_port(struct ata_port *ap); 748extern void ata_eh_thaw_port(struct ata_port *ap); 749 750extern void ata_eh_qc_complete(struct ata_queued_cmd *qc); 751extern void ata_eh_qc_retry(struct ata_queued_cmd *qc); 752 753extern void ata_do_eh(struct ata_port *ap, ata_reset_fn_t softreset, 754 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset); 755 756/* 757 * printk helpers 758 */ 759#define ata_port_printk(ap, lv, fmt, args...) \ 760 printk(lv"ata%u: "fmt, (ap)->id , ##args) 761 762#define ata_dev_printk(dev, lv, fmt, args...) \ 763 printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args) 764 765/* 766 * ata_eh_info helpers 767 */ 768#define ata_ehi_push_desc(ehi, fmt, args...) do { \ 769 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \ 770 ATA_EH_DESC_LEN - (ehi)->desc_len, \ 771 fmt , ##args); \ 772} while (0) 773 774#define ata_ehi_clear_desc(ehi) do { \ 775 (ehi)->desc[0] = '\0'; \ 776 (ehi)->desc_len = 0; \ 777} while (0) 778 779/* 780 * qc helpers 781 */ 782static inline int 783ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc) 784{ 785 if (sg == &qc->pad_sgent) 786 return 1; 787 if (qc->pad_len) 788 return 0; 789 if (((sg - qc->__sg) + 1) == qc->n_elem) 790 return 1; 791 return 0; 792} 793 794static inline struct scatterlist * 795ata_qc_first_sg(struct ata_queued_cmd *qc) 796{ 797 if (qc->n_elem) 798 return qc->__sg; 799 if (qc->pad_len) 800 return &qc->pad_sgent; 801 return NULL; 802} 803 804static inline struct scatterlist * 805ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc) 806{ 807 if (sg == &qc->pad_sgent) 808 return NULL; 809 if (++sg - qc->__sg < qc->n_elem) 810 return sg; 811 if (qc->pad_len) 812 return &qc->pad_sgent; 813 return NULL; 814} 815 816#define ata_for_each_sg(sg, qc) \ 817 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc)) 818 819static inline unsigned int ata_tag_valid(unsigned int tag) 820{ 821 return (tag < ATA_MAX_QUEUE) ? 1 : 0; 822} 823 824static inline unsigned int ata_tag_internal(unsigned int tag) 825{ 826 return tag == ATA_MAX_QUEUE - 1; 827} 828 829static inline unsigned int ata_class_enabled(unsigned int class) 830{ 831 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI; 832} 833 834static inline unsigned int ata_class_disabled(unsigned int class) 835{ 836 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP; 837} 838 839static inline unsigned int ata_class_absent(unsigned int class) 840{ 841 return !ata_class_enabled(class) && !ata_class_disabled(class); 842} 843 844static inline unsigned int ata_dev_enabled(const struct ata_device *dev) 845{ 846 return ata_class_enabled(dev->class); 847} 848 849static inline unsigned int ata_dev_disabled(const struct ata_device *dev) 850{ 851 return ata_class_disabled(dev->class); 852} 853 854static inline unsigned int ata_dev_absent(const struct ata_device *dev) 855{ 856 return ata_class_absent(dev->class); 857} 858 859static inline u8 ata_chk_status(struct ata_port *ap) 860{ 861 return ap->ops->check_status(ap); 862} 863 864 865/** 866 * ata_pause - Flush writes and pause 400 nanoseconds. 867 * @ap: Port to wait for. 868 * 869 * LOCKING: 870 * Inherited from caller. 871 */ 872 873static inline void ata_pause(struct ata_port *ap) 874{ 875 ata_altstatus(ap); 876 ndelay(400); 877} 878 879 880/** 881 * ata_busy_wait - Wait for a port status register 882 * @ap: Port to wait for. 883 * 884 * Waits up to max*10 microseconds for the selected bits in the port's 885 * status register to be cleared. 886 * Returns final value of status register. 887 * 888 * LOCKING: 889 * Inherited from caller. 890 */ 891 892static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits, 893 unsigned int max) 894{ 895 u8 status; 896 897 do { 898 udelay(10); 899 status = ata_chk_status(ap); 900 max--; 901 } while ((status & bits) && (max > 0)); 902 903 return status; 904} 905 906 907/** 908 * ata_wait_idle - Wait for a port to be idle. 909 * @ap: Port to wait for. 910 * 911 * Waits up to 10ms for port's BUSY and DRQ signals to clear. 912 * Returns final value of status register. 913 * 914 * LOCKING: 915 * Inherited from caller. 916 */ 917 918static inline u8 ata_wait_idle(struct ata_port *ap) 919{ 920 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000); 921 922 if (status & (ATA_BUSY | ATA_DRQ)) { 923 unsigned long l = ap->ioaddr.status_addr; 924 if (ata_msg_warn(ap)) 925 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n", 926 status, l); 927 } 928 929 return status; 930} 931 932static inline void ata_qc_set_polling(struct ata_queued_cmd *qc) 933{ 934 qc->tf.ctl |= ATA_NIEN; 935} 936 937static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap, 938 unsigned int tag) 939{ 940 if (likely(ata_tag_valid(tag))) 941 return &ap->qcmd[tag]; 942 return NULL; 943} 944 945static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap, 946 unsigned int tag) 947{ 948 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag); 949 950 if (unlikely(!qc) || !ap->ops->error_handler) 951 return qc; 952 953 if ((qc->flags & (ATA_QCFLAG_ACTIVE | 954 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE) 955 return qc; 956 957 return NULL; 958} 959 960static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf) 961{ 962 memset(tf, 0, sizeof(*tf)); 963 964 tf->ctl = dev->ap->ctl; 965 if (dev->devno == 0) 966 tf->device = ATA_DEVICE_OBS; 967 else 968 tf->device = ATA_DEVICE_OBS | ATA_DEV1; 969} 970 971static inline void ata_qc_reinit(struct ata_queued_cmd *qc) 972{ 973 qc->__sg = NULL; 974 qc->flags = 0; 975 qc->cursect = qc->cursg = qc->cursg_ofs = 0; 976 qc->nsect = 0; 977 qc->nbytes = qc->curbytes = 0; 978 qc->err_mask = 0; 979 980 ata_tf_init(qc->dev, &qc->tf); 981 982 /* init result_tf such that it indicates normal completion */ 983 qc->result_tf.command = ATA_DRDY; 984 qc->result_tf.feature = 0; 985} 986 987/** 988 * ata_irq_on - Enable interrupts on a port. 989 * @ap: Port on which interrupts are enabled. 990 * 991 * Enable interrupts on a legacy IDE device using MMIO or PIO, 992 * wait for idle, clear any pending interrupts. 993 * 994 * LOCKING: 995 * Inherited from caller. 996 */ 997 998static inline u8 ata_irq_on(struct ata_port *ap) 999{ 1000 struct ata_ioports *ioaddr = &ap->ioaddr; 1001 u8 tmp; 1002 1003 ap->ctl &= ~ATA_NIEN; 1004 ap->last_ctl = ap->ctl; 1005 1006 if (ap->flags & ATA_FLAG_MMIO) 1007 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr); 1008 else 1009 outb(ap->ctl, ioaddr->ctl_addr); 1010 tmp = ata_wait_idle(ap); 1011 1012 ap->ops->irq_clear(ap); 1013 1014 return tmp; 1015} 1016 1017 1018/** 1019 * ata_irq_ack - Acknowledge a device interrupt. 1020 * @ap: Port on which interrupts are enabled. 1021 * 1022 * Wait up to 10 ms for legacy IDE device to become idle (BUSY 1023 * or BUSY+DRQ clear). Obtain dma status and port status from 1024 * device. Clear the interrupt. Return port status. 1025 * 1026 * LOCKING: 1027 */ 1028 1029static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq) 1030{ 1031 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY; 1032 u8 host_stat, post_stat, status; 1033 1034 status = ata_busy_wait(ap, bits, 1000); 1035 if (status & bits) 1036 if (ata_msg_err(ap)) 1037 printk(KERN_ERR "abnormal status 0x%X\n", status); 1038 1039 /* get controller status; clear intr, err bits */ 1040 if (ap->flags & ATA_FLAG_MMIO) { 1041 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr; 1042 host_stat = readb(mmio + ATA_DMA_STATUS); 1043 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR, 1044 mmio + ATA_DMA_STATUS); 1045 1046 post_stat = readb(mmio + ATA_DMA_STATUS); 1047 } else { 1048 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS); 1049 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR, 1050 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS); 1051 1052 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS); 1053 } 1054 1055 if (ata_msg_intr(ap)) 1056 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n", 1057 __FUNCTION__, 1058 host_stat, post_stat, status); 1059 1060 return status; 1061} 1062 1063static inline int ata_try_flush_cache(const struct ata_device *dev) 1064{ 1065 return ata_id_wcache_enabled(dev->id) || 1066 ata_id_has_flush(dev->id) || 1067 ata_id_has_flush_ext(dev->id); 1068} 1069 1070static inline unsigned int ac_err_mask(u8 status) 1071{ 1072 if (status & (ATA_BUSY | ATA_DRQ)) 1073 return AC_ERR_HSM; 1074 if (status & (ATA_ERR | ATA_DF)) 1075 return AC_ERR_DEV; 1076 return 0; 1077} 1078 1079static inline unsigned int __ac_err_mask(u8 status) 1080{ 1081 unsigned int mask = ac_err_mask(status); 1082 if (mask == 0) 1083 return AC_ERR_OTHER; 1084 return mask; 1085} 1086 1087static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev) 1088{ 1089 ap->pad_dma = 0; 1090 ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ, 1091 &ap->pad_dma, GFP_KERNEL); 1092 return (ap->pad == NULL) ? -ENOMEM : 0; 1093} 1094 1095static inline void ata_pad_free(struct ata_port *ap, struct device *dev) 1096{ 1097 dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma); 1098} 1099 1100static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host) 1101{ 1102 return (struct ata_port *) &host->hostdata[0]; 1103} 1104 1105#endif /* __LINUX_LIBATA_H__ */ 1106