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