libata.h revision c19ba8af4f104cca28d548cac55c128b28dd31fb
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 37/* 38 * compile-time options: to be removed as soon as all the drivers are 39 * converted to the new debugging mechanism 40 */ 41#undef ATA_DEBUG /* debugging output */ 42#undef ATA_VERBOSE_DEBUG /* yet more debugging output */ 43#undef ATA_IRQ_TRAP /* define to ack screaming irqs */ 44#undef ATA_NDEBUG /* define to disable quick runtime checks */ 45#undef ATA_ENABLE_PATA /* define to enable PATA support in some 46 * low-level drivers */ 47#undef ATAPI_ENABLE_DMADIR /* enables ATAPI DMADIR bridge support */ 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#ifdef ATA_NDEBUG 66#define assert(expr) 67#else 68#define assert(expr) \ 69 if(unlikely(!(expr))) { \ 70 printk(KERN_ERR "Assertion failed! %s,%s,%s,line=%d\n", \ 71 #expr,__FILE__,__FUNCTION__,__LINE__); \ 72 } 73#endif 74 75/* NEW: debug levels */ 76#define HAVE_LIBATA_MSG 1 77 78enum { 79 ATA_MSG_DRV = 0x0001, 80 ATA_MSG_INFO = 0x0002, 81 ATA_MSG_PROBE = 0x0004, 82 ATA_MSG_WARN = 0x0008, 83 ATA_MSG_MALLOC = 0x0010, 84 ATA_MSG_CTL = 0x0020, 85 ATA_MSG_INTR = 0x0040, 86 ATA_MSG_ERR = 0x0080, 87}; 88 89#define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV) 90#define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO) 91#define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE) 92#define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN) 93#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC) 94#define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL) 95#define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR) 96#define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR) 97 98static inline u32 ata_msg_init(int dval, int default_msg_enable_bits) 99{ 100 if (dval < 0 || dval >= (sizeof(u32) * 8)) 101 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */ 102 if (!dval) 103 return 0; 104 return (1 << dval) - 1; 105} 106 107/* defines only for the constants which don't work well as enums */ 108#define ATA_TAG_POISON 0xfafbfcfdU 109 110/* move to PCI layer? */ 111static inline struct device *pci_dev_to_dev(struct pci_dev *pdev) 112{ 113 return &pdev->dev; 114} 115 116enum { 117 /* various global constants */ 118 LIBATA_MAX_PRD = ATA_MAX_PRD / 2, 119 ATA_MAX_PORTS = 8, 120 ATA_DEF_QUEUE = 1, 121 ATA_MAX_QUEUE = 1, 122 ATA_MAX_SECTORS = 200, /* FIXME */ 123 ATA_MAX_BUS = 2, 124 ATA_DEF_BUSY_WAIT = 10000, 125 ATA_SHORT_PAUSE = (HZ >> 6) + 1, 126 127 ATA_SHT_EMULATED = 1, 128 ATA_SHT_CMD_PER_LUN = 1, 129 ATA_SHT_THIS_ID = -1, 130 ATA_SHT_USE_CLUSTERING = 1, 131 132 /* struct ata_device stuff */ 133 ATA_DFLAG_LBA48 = (1 << 0), /* device supports LBA48 */ 134 ATA_DFLAG_PIO = (1 << 1), /* device currently in PIO mode */ 135 ATA_DFLAG_LOCK_SECTORS = (1 << 2), /* don't adjust max_sectors */ 136 ATA_DFLAG_LBA = (1 << 3), /* device supports LBA */ 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 << 1), /* host supports slave dev */ 147 /* (doesn't imply presence) */ 148 ATA_FLAG_PORT_DISABLED = (1 << 2), /* port is disabled, ignore it */ 149 ATA_FLAG_SATA = (1 << 3), 150 ATA_FLAG_NO_LEGACY = (1 << 4), /* no legacy mode check */ 151 ATA_FLAG_SRST = (1 << 5), /* (obsolete) use ATA SRST, not E.D.D. */ 152 ATA_FLAG_MMIO = (1 << 6), /* use MMIO, not PIO */ 153 ATA_FLAG_SATA_RESET = (1 << 7), /* (obsolete) use COMRESET */ 154 ATA_FLAG_PIO_DMA = (1 << 8), /* PIO cmds via DMA */ 155 ATA_FLAG_NOINTR = (1 << 9), /* FIXME: Remove this once 156 * proper HSM is in place. */ 157 ATA_FLAG_DEBUGMSG = (1 << 10), 158 ATA_FLAG_NO_ATAPI = (1 << 11), /* No ATAPI support */ 159 160 ATA_FLAG_SUSPENDED = (1 << 12), /* port is suspended */ 161 162 ATA_FLAG_PIO_LBA48 = (1 << 13), /* Host DMA engine is LBA28 only */ 163 ATA_FLAG_IRQ_MASK = (1 << 14), /* Mask IRQ in PIO xfers */ 164 165 ATA_QCFLAG_ACTIVE = (1 << 1), /* cmd not yet ack'd to scsi lyer */ 166 ATA_QCFLAG_SG = (1 << 3), /* have s/g table? */ 167 ATA_QCFLAG_SINGLE = (1 << 4), /* no s/g, just a single buffer */ 168 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE, 169 170 /* various lengths of time */ 171 ATA_TMOUT_EDD = 5 * HZ, /* heuristic */ 172 ATA_TMOUT_PIO = 30 * HZ, 173 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */ 174 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */ 175 ATA_TMOUT_CDB = 30 * HZ, 176 ATA_TMOUT_CDB_QUICK = 5 * HZ, 177 ATA_TMOUT_INTERNAL = 30 * HZ, 178 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ, 179 180 /* ATA bus states */ 181 BUS_UNKNOWN = 0, 182 BUS_DMA = 1, 183 BUS_IDLE = 2, 184 BUS_NOINTR = 3, 185 BUS_NODATA = 4, 186 BUS_TIMER = 5, 187 BUS_PIO = 6, 188 BUS_EDD = 7, 189 BUS_IDENTIFY = 8, 190 BUS_PACKET = 9, 191 192 /* SATA port states */ 193 PORT_UNKNOWN = 0, 194 PORT_ENABLED = 1, 195 PORT_DISABLED = 2, 196 197 /* encoding various smaller bitmaps into a single 198 * unsigned long bitmap 199 */ 200 ATA_SHIFT_UDMA = 0, 201 ATA_SHIFT_MWDMA = 8, 202 ATA_SHIFT_PIO = 11, 203 204 /* size of buffer to pad xfers ending on unaligned boundaries */ 205 ATA_DMA_PAD_SZ = 4, 206 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE, 207 208 /* Masks for port functions */ 209 ATA_PORT_PRIMARY = (1 << 0), 210 ATA_PORT_SECONDARY = (1 << 1), 211}; 212 213enum hsm_task_states { 214 HSM_ST_UNKNOWN, 215 HSM_ST_IDLE, 216 HSM_ST_POLL, 217 HSM_ST_TMOUT, 218 HSM_ST, 219 HSM_ST_LAST, 220 HSM_ST_LAST_POLL, 221 HSM_ST_ERR, 222}; 223 224enum ata_completion_errors { 225 AC_ERR_DEV = (1 << 0), /* device reported error */ 226 AC_ERR_HSM = (1 << 1), /* host state machine violation */ 227 AC_ERR_TIMEOUT = (1 << 2), /* timeout */ 228 AC_ERR_MEDIA = (1 << 3), /* media error */ 229 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */ 230 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */ 231 AC_ERR_SYSTEM = (1 << 6), /* system error */ 232 AC_ERR_INVALID = (1 << 7), /* invalid argument */ 233 AC_ERR_OTHER = (1 << 8), /* unknown */ 234}; 235 236/* forward declarations */ 237struct scsi_device; 238struct ata_port_operations; 239struct ata_port; 240struct ata_queued_cmd; 241 242/* typedefs */ 243typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc); 244 245struct ata_ioports { 246 unsigned long cmd_addr; 247 unsigned long data_addr; 248 unsigned long error_addr; 249 unsigned long feature_addr; 250 unsigned long nsect_addr; 251 unsigned long lbal_addr; 252 unsigned long lbam_addr; 253 unsigned long lbah_addr; 254 unsigned long device_addr; 255 unsigned long status_addr; 256 unsigned long command_addr; 257 unsigned long altstatus_addr; 258 unsigned long ctl_addr; 259 unsigned long bmdma_addr; 260 unsigned long scr_addr; 261}; 262 263struct ata_probe_ent { 264 struct list_head node; 265 struct device *dev; 266 const struct ata_port_operations *port_ops; 267 struct scsi_host_template *sht; 268 struct ata_ioports port[ATA_MAX_PORTS]; 269 unsigned int n_ports; 270 unsigned int hard_port_no; 271 unsigned int pio_mask; 272 unsigned int mwdma_mask; 273 unsigned int udma_mask; 274 unsigned int legacy_mode; 275 unsigned long irq; 276 unsigned int irq_flags; 277 unsigned long host_flags; 278 void __iomem *mmio_base; 279 void *private_data; 280}; 281 282struct ata_host_set { 283 spinlock_t lock; 284 struct device *dev; 285 unsigned long irq; 286 void __iomem *mmio_base; 287 unsigned int n_ports; 288 void *private_data; 289 const struct ata_port_operations *ops; 290 struct ata_port * ports[0]; 291}; 292 293struct ata_queued_cmd { 294 struct ata_port *ap; 295 struct ata_device *dev; 296 297 struct scsi_cmnd *scsicmd; 298 void (*scsidone)(struct scsi_cmnd *); 299 300 struct ata_taskfile tf; 301 u8 cdb[ATAPI_CDB_LEN]; 302 303 unsigned long flags; /* ATA_QCFLAG_xxx */ 304 unsigned int tag; 305 unsigned int n_elem; 306 unsigned int orig_n_elem; 307 308 int dma_dir; 309 310 unsigned int pad_len; 311 312 unsigned int nsect; 313 unsigned int cursect; 314 315 unsigned int nbytes; 316 unsigned int curbytes; 317 318 unsigned int cursg; 319 unsigned int cursg_ofs; 320 321 struct scatterlist sgent; 322 struct scatterlist pad_sgent; 323 void *buf_virt; 324 325 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */ 326 struct scatterlist *__sg; 327 328 unsigned int err_mask; 329 330 ata_qc_cb_t complete_fn; 331 332 void *private_data; 333}; 334 335struct ata_host_stats { 336 unsigned long unhandled_irq; 337 unsigned long idle_irq; 338 unsigned long rw_reqbuf; 339}; 340 341struct ata_device { 342 u64 n_sectors; /* size of device, if ATA */ 343 unsigned long flags; /* ATA_DFLAG_xxx */ 344 unsigned int class; /* ATA_DEV_xxx */ 345 unsigned int devno; /* 0 or 1 */ 346 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */ 347 u8 pio_mode; 348 u8 dma_mode; 349 u8 xfer_mode; 350 unsigned int xfer_shift; /* ATA_SHIFT_xxx */ 351 352 unsigned int multi_count; /* sectors count for 353 READ/WRITE MULTIPLE */ 354 355 /* for CHS addressing */ 356 u16 cylinders; /* Number of cylinders */ 357 u16 heads; /* Number of heads */ 358 u16 sectors; /* Number of sectors per track */ 359}; 360 361struct ata_port { 362 struct Scsi_Host *host; /* our co-allocated scsi host */ 363 const struct ata_port_operations *ops; 364 unsigned long flags; /* ATA_FLAG_xxx */ 365 unsigned int id; /* unique id req'd by scsi midlyr */ 366 unsigned int port_no; /* unique port #; from zero */ 367 unsigned int hard_port_no; /* hardware port #; from zero */ 368 369 struct ata_prd *prd; /* our SG list */ 370 dma_addr_t prd_dma; /* and its DMA mapping */ 371 372 void *pad; /* array of DMA pad buffers */ 373 dma_addr_t pad_dma; 374 375 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */ 376 377 u8 ctl; /* cache of ATA control register */ 378 u8 last_ctl; /* Cache last written value */ 379 unsigned int pio_mask; 380 unsigned int mwdma_mask; 381 unsigned int udma_mask; 382 unsigned int cbl; /* cable type; ATA_CBL_xxx */ 383 unsigned int cdb_len; 384 385 struct ata_device device[ATA_MAX_DEVICES]; 386 387 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE]; 388 unsigned long qactive; 389 unsigned int active_tag; 390 391 struct ata_host_stats stats; 392 struct ata_host_set *host_set; 393 394 struct work_struct packet_task; 395 396 struct work_struct pio_task; 397 unsigned int hsm_task_state; 398 unsigned long pio_task_timeout; 399 400 u32 msg_enable; 401 struct list_head eh_done_q; 402 403 void *private_data; 404}; 405 406struct ata_port_operations { 407 void (*port_disable) (struct ata_port *); 408 409 void (*dev_config) (struct ata_port *, struct ata_device *); 410 411 void (*set_piomode) (struct ata_port *, struct ata_device *); 412 void (*set_dmamode) (struct ata_port *, struct ata_device *); 413 414 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf); 415 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf); 416 417 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf); 418 u8 (*check_status)(struct ata_port *ap); 419 u8 (*check_altstatus)(struct ata_port *ap); 420 void (*dev_select)(struct ata_port *ap, unsigned int device); 421 422 void (*phy_reset) (struct ata_port *ap); /* obsolete */ 423 int (*probe_reset) (struct ata_port *ap, unsigned int *classes); 424 425 void (*post_set_mode) (struct ata_port *ap); 426 427 int (*check_atapi_dma) (struct ata_queued_cmd *qc); 428 429 void (*bmdma_setup) (struct ata_queued_cmd *qc); 430 void (*bmdma_start) (struct ata_queued_cmd *qc); 431 432 void (*qc_prep) (struct ata_queued_cmd *qc); 433 unsigned int (*qc_issue) (struct ata_queued_cmd *qc); 434 435 void (*eng_timeout) (struct ata_port *ap); 436 437 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *); 438 void (*irq_clear) (struct ata_port *); 439 440 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg); 441 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg, 442 u32 val); 443 444 int (*port_start) (struct ata_port *ap); 445 void (*port_stop) (struct ata_port *ap); 446 447 void (*host_stop) (struct ata_host_set *host_set); 448 449 void (*bmdma_stop) (struct ata_queued_cmd *qc); 450 u8 (*bmdma_status) (struct ata_port *ap); 451}; 452 453struct ata_port_info { 454 struct scsi_host_template *sht; 455 unsigned long host_flags; 456 unsigned long pio_mask; 457 unsigned long mwdma_mask; 458 unsigned long udma_mask; 459 const struct ata_port_operations *port_ops; 460 void *private_data; 461}; 462 463struct ata_timing { 464 unsigned short mode; /* ATA mode */ 465 unsigned short setup; /* t1 */ 466 unsigned short act8b; /* t2 for 8-bit I/O */ 467 unsigned short rec8b; /* t2i for 8-bit I/O */ 468 unsigned short cyc8b; /* t0 for 8-bit I/O */ 469 unsigned short active; /* t2 or tD */ 470 unsigned short recover; /* t2i or tK */ 471 unsigned short cycle; /* t0 */ 472 unsigned short udma; /* t2CYCTYP/2 */ 473}; 474 475#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin) 476 477extern void ata_port_probe(struct ata_port *); 478extern void __sata_phy_reset(struct ata_port *ap); 479extern void sata_phy_reset(struct ata_port *ap); 480extern void ata_bus_reset(struct ata_port *ap); 481extern void ata_port_disable(struct ata_port *); 482extern void ata_std_ports(struct ata_ioports *ioaddr); 483#ifdef CONFIG_PCI 484extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info, 485 unsigned int n_ports); 486extern void ata_pci_remove_one (struct pci_dev *pdev); 487extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state); 488extern int ata_pci_device_resume(struct pci_dev *pdev); 489#endif /* CONFIG_PCI */ 490extern int ata_device_add(const struct ata_probe_ent *ent); 491extern void ata_host_set_remove(struct ata_host_set *host_set); 492extern int ata_scsi_detect(struct scsi_host_template *sht); 493extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg); 494extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *)); 495extern int ata_scsi_error(struct Scsi_Host *host); 496extern void ata_eh_qc_complete(struct ata_queued_cmd *qc); 497extern void ata_eh_qc_retry(struct ata_queued_cmd *qc); 498extern int ata_scsi_release(struct Scsi_Host *host); 499extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc); 500extern int ata_scsi_device_resume(struct scsi_device *); 501extern int ata_scsi_device_suspend(struct scsi_device *); 502extern int ata_device_resume(struct ata_port *, struct ata_device *); 503extern int ata_device_suspend(struct ata_port *, struct ata_device *); 504extern int ata_ratelimit(void); 505extern unsigned int ata_busy_sleep(struct ata_port *ap, 506 unsigned long timeout_pat, 507 unsigned long timeout); 508 509/* 510 * Default driver ops implementations 511 */ 512extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf); 513extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf); 514extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp); 515extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf); 516extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device); 517extern void ata_std_dev_select (struct ata_port *ap, unsigned int device); 518extern u8 ata_check_status(struct ata_port *ap); 519extern u8 ata_altstatus(struct ata_port *ap); 520extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf); 521extern int ata_port_start (struct ata_port *ap); 522extern void ata_port_stop (struct ata_port *ap); 523extern void ata_host_stop (struct ata_host_set *host_set); 524extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs); 525extern void ata_qc_prep(struct ata_queued_cmd *qc); 526extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc); 527extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf, 528 unsigned int buflen); 529extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg, 530 unsigned int n_elem); 531extern unsigned int ata_dev_classify(const struct ata_taskfile *tf); 532extern void ata_dev_id_string(const u16 *id, unsigned char *s, 533 unsigned int ofs, unsigned int len); 534extern void ata_dev_config(struct ata_port *ap, unsigned int i); 535extern void ata_bmdma_setup (struct ata_queued_cmd *qc); 536extern void ata_bmdma_start (struct ata_queued_cmd *qc); 537extern void ata_bmdma_stop(struct ata_queued_cmd *qc); 538extern u8 ata_bmdma_status(struct ata_port *ap); 539extern void ata_bmdma_irq_clear(struct ata_port *ap); 540extern void ata_qc_complete(struct ata_queued_cmd *qc); 541extern void ata_eng_timeout(struct ata_port *ap); 542extern void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev, 543 struct scsi_cmnd *cmd, 544 void (*done)(struct scsi_cmnd *)); 545extern int ata_std_bios_param(struct scsi_device *sdev, 546 struct block_device *bdev, 547 sector_t capacity, int geom[]); 548extern int ata_scsi_slave_config(struct scsi_device *sdev); 549 550/* 551 * Timing helpers 552 */ 553 554extern unsigned int ata_pio_need_iordy(const struct ata_device *); 555extern int ata_timing_compute(struct ata_device *, unsigned short, 556 struct ata_timing *, int, int); 557extern void ata_timing_merge(const struct ata_timing *, 558 const struct ata_timing *, struct ata_timing *, 559 unsigned int); 560 561enum { 562 ATA_TIMING_SETUP = (1 << 0), 563 ATA_TIMING_ACT8B = (1 << 1), 564 ATA_TIMING_REC8B = (1 << 2), 565 ATA_TIMING_CYC8B = (1 << 3), 566 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B | 567 ATA_TIMING_CYC8B, 568 ATA_TIMING_ACTIVE = (1 << 4), 569 ATA_TIMING_RECOVER = (1 << 5), 570 ATA_TIMING_CYCLE = (1 << 6), 571 ATA_TIMING_UDMA = (1 << 7), 572 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B | 573 ATA_TIMING_REC8B | ATA_TIMING_CYC8B | 574 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER | 575 ATA_TIMING_CYCLE | ATA_TIMING_UDMA, 576}; 577 578 579#ifdef CONFIG_PCI 580struct pci_bits { 581 unsigned int reg; /* PCI config register to read */ 582 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */ 583 unsigned long mask; 584 unsigned long val; 585}; 586 587extern void ata_pci_host_stop (struct ata_host_set *host_set); 588extern struct ata_probe_ent * 589ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask); 590extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits); 591 592#endif /* CONFIG_PCI */ 593 594 595static inline int 596ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc) 597{ 598 if (sg == &qc->pad_sgent) 599 return 1; 600 if (qc->pad_len) 601 return 0; 602 if (((sg - qc->__sg) + 1) == qc->n_elem) 603 return 1; 604 return 0; 605} 606 607static inline struct scatterlist * 608ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc) 609{ 610 if (sg == &qc->pad_sgent) 611 return NULL; 612 if (++sg - qc->__sg < qc->n_elem) 613 return sg; 614 return qc->pad_len ? &qc->pad_sgent : NULL; 615} 616 617#define ata_for_each_sg(sg, qc) \ 618 for (sg = qc->__sg; sg; sg = ata_qc_next_sg(sg, qc)) 619 620static inline unsigned int ata_tag_valid(unsigned int tag) 621{ 622 return (tag < ATA_MAX_QUEUE) ? 1 : 0; 623} 624 625static inline unsigned int ata_dev_present(const struct ata_device *dev) 626{ 627 return ((dev->class == ATA_DEV_ATA) || 628 (dev->class == ATA_DEV_ATAPI)); 629} 630 631static inline u8 ata_chk_status(struct ata_port *ap) 632{ 633 return ap->ops->check_status(ap); 634} 635 636 637/** 638 * ata_pause - Flush writes and pause 400 nanoseconds. 639 * @ap: Port to wait for. 640 * 641 * LOCKING: 642 * Inherited from caller. 643 */ 644 645static inline void ata_pause(struct ata_port *ap) 646{ 647 ata_altstatus(ap); 648 ndelay(400); 649} 650 651 652/** 653 * ata_busy_wait - Wait for a port status register 654 * @ap: Port to wait for. 655 * 656 * Waits up to max*10 microseconds for the selected bits in the port's 657 * status register to be cleared. 658 * Returns final value of status register. 659 * 660 * LOCKING: 661 * Inherited from caller. 662 */ 663 664static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits, 665 unsigned int max) 666{ 667 u8 status; 668 669 do { 670 udelay(10); 671 status = ata_chk_status(ap); 672 max--; 673 } while ((status & bits) && (max > 0)); 674 675 return status; 676} 677 678 679/** 680 * ata_wait_idle - Wait for a port to be idle. 681 * @ap: Port to wait for. 682 * 683 * Waits up to 10ms for port's BUSY and DRQ signals to clear. 684 * Returns final value of status register. 685 * 686 * LOCKING: 687 * Inherited from caller. 688 */ 689 690static inline u8 ata_wait_idle(struct ata_port *ap) 691{ 692 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000); 693 694 if (status & (ATA_BUSY | ATA_DRQ)) { 695 unsigned long l = ap->ioaddr.status_addr; 696 if (ata_msg_warn(ap)) 697 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n", 698 status, l); 699 } 700 701 return status; 702} 703 704static inline void ata_qc_set_polling(struct ata_queued_cmd *qc) 705{ 706 qc->tf.ctl |= ATA_NIEN; 707} 708 709static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap, 710 unsigned int tag) 711{ 712 if (likely(ata_tag_valid(tag))) 713 return &ap->qcmd[tag]; 714 return NULL; 715} 716 717static inline void ata_tf_init(struct ata_port *ap, struct ata_taskfile *tf, unsigned int device) 718{ 719 memset(tf, 0, sizeof(*tf)); 720 721 tf->ctl = ap->ctl; 722 if (device == 0) 723 tf->device = ATA_DEVICE_OBS; 724 else 725 tf->device = ATA_DEVICE_OBS | ATA_DEV1; 726} 727 728static inline void ata_qc_reinit(struct ata_queued_cmd *qc) 729{ 730 qc->__sg = NULL; 731 qc->flags = 0; 732 qc->cursect = qc->cursg = qc->cursg_ofs = 0; 733 qc->nsect = 0; 734 qc->nbytes = qc->curbytes = 0; 735 qc->err_mask = 0; 736 737 ata_tf_init(qc->ap, &qc->tf, qc->dev->devno); 738} 739 740 741/** 742 * ata_irq_on - Enable interrupts on a port. 743 * @ap: Port on which interrupts are enabled. 744 * 745 * Enable interrupts on a legacy IDE device using MMIO or PIO, 746 * wait for idle, clear any pending interrupts. 747 * 748 * LOCKING: 749 * Inherited from caller. 750 */ 751 752static inline u8 ata_irq_on(struct ata_port *ap) 753{ 754 struct ata_ioports *ioaddr = &ap->ioaddr; 755 u8 tmp; 756 757 ap->ctl &= ~ATA_NIEN; 758 ap->last_ctl = ap->ctl; 759 760 if (ap->flags & ATA_FLAG_MMIO) 761 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr); 762 else 763 outb(ap->ctl, ioaddr->ctl_addr); 764 tmp = ata_wait_idle(ap); 765 766 ap->ops->irq_clear(ap); 767 768 return tmp; 769} 770 771 772/** 773 * ata_irq_ack - Acknowledge a device interrupt. 774 * @ap: Port on which interrupts are enabled. 775 * 776 * Wait up to 10 ms for legacy IDE device to become idle (BUSY 777 * or BUSY+DRQ clear). Obtain dma status and port status from 778 * device. Clear the interrupt. Return port status. 779 * 780 * LOCKING: 781 */ 782 783static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq) 784{ 785 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY; 786 u8 host_stat, post_stat, status; 787 788 status = ata_busy_wait(ap, bits, 1000); 789 if (status & bits) 790 if (ata_msg_err(ap)) 791 printk(KERN_ERR "abnormal status 0x%X\n", status); 792 793 /* get controller status; clear intr, err bits */ 794 if (ap->flags & ATA_FLAG_MMIO) { 795 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr; 796 host_stat = readb(mmio + ATA_DMA_STATUS); 797 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR, 798 mmio + ATA_DMA_STATUS); 799 800 post_stat = readb(mmio + ATA_DMA_STATUS); 801 } else { 802 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS); 803 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR, 804 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS); 805 806 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS); 807 } 808 809 if (ata_msg_intr(ap)) 810 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n", 811 __FUNCTION__, 812 host_stat, post_stat, status); 813 814 return status; 815} 816 817static inline u32 scr_read(struct ata_port *ap, unsigned int reg) 818{ 819 return ap->ops->scr_read(ap, reg); 820} 821 822static inline void scr_write(struct ata_port *ap, unsigned int reg, u32 val) 823{ 824 ap->ops->scr_write(ap, reg, val); 825} 826 827static inline void scr_write_flush(struct ata_port *ap, unsigned int reg, 828 u32 val) 829{ 830 ap->ops->scr_write(ap, reg, val); 831 (void) ap->ops->scr_read(ap, reg); 832} 833 834static inline unsigned int sata_dev_present(struct ata_port *ap) 835{ 836 return ((scr_read(ap, SCR_STATUS) & 0xf) == 0x3) ? 1 : 0; 837} 838 839static inline int ata_try_flush_cache(const struct ata_device *dev) 840{ 841 return ata_id_wcache_enabled(dev->id) || 842 ata_id_has_flush(dev->id) || 843 ata_id_has_flush_ext(dev->id); 844} 845 846static inline unsigned int ac_err_mask(u8 status) 847{ 848 if (status & ATA_BUSY) 849 return AC_ERR_HSM; 850 if (status & (ATA_ERR | ATA_DF)) 851 return AC_ERR_DEV; 852 return 0; 853} 854 855static inline unsigned int __ac_err_mask(u8 status) 856{ 857 unsigned int mask = ac_err_mask(status); 858 if (mask == 0) 859 return AC_ERR_OTHER; 860 return mask; 861} 862 863static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev) 864{ 865 ap->pad_dma = 0; 866 ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ, 867 &ap->pad_dma, GFP_KERNEL); 868 return (ap->pad == NULL) ? -ENOMEM : 0; 869} 870 871static inline void ata_pad_free(struct ata_port *ap, struct device *dev) 872{ 873 dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma); 874} 875 876#endif /* __LINUX_LIBATA_H__ */ 877