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