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/dma-mapping.h> 32 #include <linux/scatterlist.h> 33 #include <linux/io.h> 34 #include <linux/ata.h> 35 #include <linux/workqueue.h> 36 #include <scsi/scsi_host.h> 37 #include <linux/acpi.h> 38 #include <linux/cdrom.h> 39 40 /* 41 * Define if arch has non-standard setup. This is a _PCI_ standard 42 * not a legacy or ISA standard. 43 */ 44 #ifdef CONFIG_ATA_NONSTANDARD 45 #include <asm/libata-portmap.h> 46 #else 47 #include <asm-generic/libata-portmap.h> 48 #endif 49 50 /* 51 * compile-time options: to be removed as soon as all the drivers are 52 * converted to the new debugging mechanism 53 */ 54 #undef ATA_DEBUG /* debugging output */ 55 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */ 56 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */ 57 #undef ATA_NDEBUG /* define to disable quick runtime checks */ 58 59 60 /* note: prints function name for you */ 61 #ifdef ATA_DEBUG 62 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) 63 #ifdef ATA_VERBOSE_DEBUG 64 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) 65 #else 66 #define VPRINTK(fmt, args...) 67 #endif /* ATA_VERBOSE_DEBUG */ 68 #else 69 #define DPRINTK(fmt, args...) 70 #define VPRINTK(fmt, args...) 71 #endif /* ATA_DEBUG */ 72 73 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) 74 75 /* NEW: debug levels */ 76 #define HAVE_LIBATA_MSG 1 77 78 enum { 79 ATA_MSG_DRV = 0x0001, 80 ATA_MSG_INFO = 0x0002, 81 ATA_MSG_PROBE = 0x0004, 82 ATA_MSG_WARN = 0x0008, 83 ATA_MSG_MALLOC = 0x0010, 84 ATA_MSG_CTL = 0x0020, 85 ATA_MSG_INTR = 0x0040, 86 ATA_MSG_ERR = 0x0080, 87 }; 88 89 #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV) 90 #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO) 91 #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE) 92 #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN) 93 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC) 94 #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL) 95 #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR) 96 #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR) 97 98 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits) 99 { 100 if (dval < 0 || dval >= (sizeof(u32) * 8)) 101 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */ 102 if (!dval) 103 return 0; 104 return (1 << dval) - 1; 105 } 106 107 /* defines only for the constants which don't work well as enums */ 108 #define ATA_TAG_POISON 0xfafbfcfdU 109 110 enum { 111 /* various global constants */ 112 LIBATA_MAX_PRD = ATA_MAX_PRD / 2, 113 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */ 114 ATA_MAX_PORTS = 8, 115 ATA_DEF_QUEUE = 1, 116 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */ 117 ATA_MAX_QUEUE = 32, 118 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1, 119 ATA_MAX_BUS = 2, 120 ATA_DEF_BUSY_WAIT = 10000, 121 ATA_SHORT_PAUSE = (HZ >> 6) + 1, 122 123 ATAPI_MAX_DRAIN = 16 << 10, 124 125 ATA_SHT_EMULATED = 1, 126 ATA_SHT_CMD_PER_LUN = 1, 127 ATA_SHT_THIS_ID = -1, 128 ATA_SHT_USE_CLUSTERING = 1, 129 130 /* struct ata_device stuff */ 131 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */ 132 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */ 133 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */ 134 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */ 135 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */ 136 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */ 137 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */ 138 ATA_DFLAG_AN = (1 << 7), /* AN configured */ 139 ATA_DFLAG_HIPM = (1 << 8), /* device supports HIPM */ 140 ATA_DFLAG_DIPM = (1 << 9), /* device supports DIPM */ 141 ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */ 142 ATA_DFLAG_CFG_MASK = (1 << 12) - 1, 143 144 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */ 145 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */ 146 ATA_DFLAG_SPUNDOWN = (1 << 14), /* XXX: for spindown_compat */ 147 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */ 148 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */ 149 ATA_DFLAG_INIT_MASK = (1 << 24) - 1, 150 151 ATA_DFLAG_DETACH = (1 << 24), 152 ATA_DFLAG_DETACHED = (1 << 25), 153 154 ATA_DEV_UNKNOWN = 0, /* unknown device */ 155 ATA_DEV_ATA = 1, /* ATA device */ 156 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */ 157 ATA_DEV_ATAPI = 3, /* ATAPI device */ 158 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */ 159 ATA_DEV_PMP = 5, /* SATA port multiplier */ 160 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */ 161 ATA_DEV_SEMB = 7, /* SEMB */ 162 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */ 163 ATA_DEV_NONE = 9, /* no device */ 164 165 /* struct ata_link flags */ 166 ATA_LFLAG_HRST_TO_RESUME = (1 << 0), /* hardreset to resume link */ 167 ATA_LFLAG_SKIP_D2H_BSY = (1 << 1), /* can't wait for the first D2H 168 * Register FIS clearing BSY */ 169 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */ 170 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */ 171 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */ 172 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB, 173 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */ 174 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */ 175 176 /* struct ata_port flags */ 177 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */ 178 /* (doesn't imply presence) */ 179 ATA_FLAG_SATA = (1 << 1), 180 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */ 181 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */ 182 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */ 183 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */ 184 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */ 185 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */ 186 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */ 187 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD 188 * doesn't handle PIO interrupts */ 189 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */ 190 ATA_FLAG_DEBUGMSG = (1 << 13), 191 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */ 192 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */ 193 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */ 194 ATA_FLAG_AN = (1 << 18), /* controller supports AN */ 195 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */ 196 ATA_FLAG_IPM = (1 << 20), /* driver can handle IPM */ 197 198 /* The following flag belongs to ap->pflags but is kept in 199 * ap->flags because it's referenced in many LLDs and will be 200 * removed in not-too-distant future. 201 */ 202 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */ 203 204 /* bits 24:31 of ap->flags are reserved for LLD specific flags */ 205 206 /* struct ata_port pflags */ 207 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */ 208 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */ 209 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */ 210 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */ 211 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */ 212 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */ 213 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */ 214 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */ 215 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */ 216 217 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */ 218 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */ 219 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */ 220 221 /* struct ata_queued_cmd flags */ 222 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */ 223 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */ 224 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */ 225 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */ 226 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */ 227 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */ 228 229 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */ 230 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */ 231 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */ 232 233 /* host set flags */ 234 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */ 235 ATA_HOST_STARTED = (1 << 1), /* Host started */ 236 237 /* bits 24:31 of host->flags are reserved for LLD specific flags */ 238 239 /* various lengths of time */ 240 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */ 241 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */ 242 ATA_TMOUT_INTERNAL = 30 * HZ, 243 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ, 244 245 /* FIXME: GoVault needs 2s but we can't afford that without 246 * parallel probing. 800ms is enough for iVDR disk 247 * HHD424020F7SV00. Increase to 2secs when parallel probing 248 * is in place. 249 */ 250 ATA_TMOUT_FF_WAIT = 4 * HZ / 5, 251 252 /* ATA bus states */ 253 BUS_UNKNOWN = 0, 254 BUS_DMA = 1, 255 BUS_IDLE = 2, 256 BUS_NOINTR = 3, 257 BUS_NODATA = 4, 258 BUS_TIMER = 5, 259 BUS_PIO = 6, 260 BUS_EDD = 7, 261 BUS_IDENTIFY = 8, 262 BUS_PACKET = 9, 263 264 /* SATA port states */ 265 PORT_UNKNOWN = 0, 266 PORT_ENABLED = 1, 267 PORT_DISABLED = 2, 268 269 /* encoding various smaller bitmaps into a single 270 * unsigned long bitmap 271 */ 272 ATA_NR_PIO_MODES = 7, 273 ATA_NR_MWDMA_MODES = 5, 274 ATA_NR_UDMA_MODES = 8, 275 276 ATA_SHIFT_PIO = 0, 277 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES, 278 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES, 279 280 /* size of buffer to pad xfers ending on unaligned boundaries */ 281 ATA_DMA_PAD_SZ = 4, 282 283 /* ering size */ 284 ATA_ERING_SIZE = 32, 285 286 /* return values for ->qc_defer */ 287 ATA_DEFER_LINK = 1, 288 ATA_DEFER_PORT = 2, 289 290 /* desc_len for ata_eh_info and context */ 291 ATA_EH_DESC_LEN = 80, 292 293 /* reset / recovery action types */ 294 ATA_EH_REVALIDATE = (1 << 0), 295 ATA_EH_SOFTRESET = (1 << 1), 296 ATA_EH_HARDRESET = (1 << 2), 297 ATA_EH_ENABLE_LINK = (1 << 3), 298 299 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET, 300 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE, 301 302 /* ata_eh_info->flags */ 303 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */ 304 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */ 305 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */ 306 ATA_EHI_QUIET = (1 << 3), /* be quiet */ 307 ATA_EHI_LPM = (1 << 4), /* link power management action */ 308 309 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */ 310 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */ 311 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */ 312 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */ 313 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */ 314 315 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET, 316 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK, 317 318 /* max tries if error condition is still set after ->error_handler */ 319 ATA_EH_MAX_TRIES = 5, 320 321 /* how hard are we gonna try to probe/recover devices */ 322 ATA_PROBE_MAX_TRIES = 3, 323 ATA_EH_DEV_TRIES = 3, 324 ATA_EH_PMP_TRIES = 5, 325 ATA_EH_PMP_LINK_TRIES = 3, 326 327 SATA_PMP_SCR_TIMEOUT = 250, 328 329 /* Horkage types. May be set by libata or controller on drives 330 (some horkage may be drive/controller pair dependant */ 331 332 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */ 333 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */ 334 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */ 335 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */ 336 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */ 337 ATA_HORKAGE_SKIP_PM = (1 << 5), /* Skip PM operations */ 338 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */ 339 ATA_HORKAGE_IPM = (1 << 7), /* Link PM problems */ 340 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */ 341 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */ 342 343 /* DMA mask for user DMA control: User visible values; DO NOT 344 renumber */ 345 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */ 346 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */ 347 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */ 348 349 /* ATAPI command types */ 350 ATAPI_READ = 0, /* READs */ 351 ATAPI_WRITE = 1, /* WRITEs */ 352 ATAPI_READ_CD = 2, /* READ CD [MSF] */ 353 ATAPI_MISC = 3, /* the rest */ 354 }; 355 356 enum ata_xfer_mask { 357 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1) 358 << ATA_SHIFT_PIO, 359 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1) 360 << ATA_SHIFT_MWDMA, 361 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1) 362 << ATA_SHIFT_UDMA, 363 }; 364 365 enum hsm_task_states { 366 HSM_ST_IDLE, /* no command on going */ 367 HSM_ST_FIRST, /* (waiting the device to) 368 write CDB or first data block */ 369 HSM_ST, /* (waiting the device to) transfer data */ 370 HSM_ST_LAST, /* (waiting the device to) complete command */ 371 HSM_ST_ERR, /* error */ 372 }; 373 374 enum ata_completion_errors { 375 AC_ERR_DEV = (1 << 0), /* device reported error */ 376 AC_ERR_HSM = (1 << 1), /* host state machine violation */ 377 AC_ERR_TIMEOUT = (1 << 2), /* timeout */ 378 AC_ERR_MEDIA = (1 << 3), /* media error */ 379 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */ 380 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */ 381 AC_ERR_SYSTEM = (1 << 6), /* system error */ 382 AC_ERR_INVALID = (1 << 7), /* invalid argument */ 383 AC_ERR_OTHER = (1 << 8), /* unknown */ 384 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */ 385 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */ 386 }; 387 388 /* forward declarations */ 389 struct scsi_device; 390 struct ata_port_operations; 391 struct ata_port; 392 struct ata_link; 393 struct ata_queued_cmd; 394 395 /* typedefs */ 396 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc); 397 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline); 398 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes, 399 unsigned long deadline); 400 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes); 401 402 /* 403 * host pm policy: If you alter this, you also need to alter libata-scsi.c 404 * (for the ascii descriptions) 405 */ 406 enum link_pm { 407 NOT_AVAILABLE, 408 MIN_POWER, 409 MAX_PERFORMANCE, 410 MEDIUM_POWER, 411 }; 412 extern struct class_device_attribute class_device_attr_link_power_management_policy; 413 414 struct ata_ioports { 415 void __iomem *cmd_addr; 416 void __iomem *data_addr; 417 void __iomem *error_addr; 418 void __iomem *feature_addr; 419 void __iomem *nsect_addr; 420 void __iomem *lbal_addr; 421 void __iomem *lbam_addr; 422 void __iomem *lbah_addr; 423 void __iomem *device_addr; 424 void __iomem *status_addr; 425 void __iomem *command_addr; 426 void __iomem *altstatus_addr; 427 void __iomem *ctl_addr; 428 void __iomem *bmdma_addr; 429 void __iomem *scr_addr; 430 }; 431 432 struct ata_host { 433 spinlock_t lock; 434 struct device *dev; 435 void __iomem * const *iomap; 436 unsigned int n_ports; 437 void *private_data; 438 const struct ata_port_operations *ops; 439 unsigned long flags; 440 #ifdef CONFIG_ATA_ACPI 441 acpi_handle acpi_handle; 442 #endif 443 struct ata_port *simplex_claimed; /* channel owning the DMA */ 444 struct ata_port *ports[0]; 445 }; 446 447 struct ata_queued_cmd { 448 struct ata_port *ap; 449 struct ata_device *dev; 450 451 struct scsi_cmnd *scsicmd; 452 void (*scsidone)(struct scsi_cmnd *); 453 454 struct ata_taskfile tf; 455 u8 cdb[ATAPI_CDB_LEN]; 456 457 unsigned long flags; /* ATA_QCFLAG_xxx */ 458 unsigned int tag; 459 unsigned int n_elem; 460 461 int dma_dir; 462 463 unsigned int sect_size; 464 465 unsigned int nbytes; 466 unsigned int curbytes; 467 468 struct scatterlist *cursg; 469 unsigned int cursg_ofs; 470 471 struct scatterlist sgent; 472 473 struct scatterlist *sg; 474 475 unsigned int err_mask; 476 struct ata_taskfile result_tf; 477 ata_qc_cb_t complete_fn; 478 479 void *private_data; 480 void *lldd_task; 481 }; 482 483 struct ata_port_stats { 484 unsigned long unhandled_irq; 485 unsigned long idle_irq; 486 unsigned long rw_reqbuf; 487 }; 488 489 struct ata_ering_entry { 490 unsigned int eflags; 491 unsigned int err_mask; 492 u64 timestamp; 493 }; 494 495 struct ata_ering { 496 int cursor; 497 struct ata_ering_entry ring[ATA_ERING_SIZE]; 498 }; 499 500 struct ata_device { 501 struct ata_link *link; 502 unsigned int devno; /* 0 or 1 */ 503 unsigned long flags; /* ATA_DFLAG_xxx */ 504 unsigned int horkage; /* List of broken features */ 505 struct scsi_device *sdev; /* attached SCSI device */ 506 #ifdef CONFIG_ATA_ACPI 507 acpi_handle acpi_handle; 508 union acpi_object *gtf_cache; 509 #endif 510 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */ 511 u64 n_sectors; /* size of device, if ATA */ 512 unsigned int class; /* ATA_DEV_xxx */ 513 514 union { 515 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */ 516 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */ 517 }; 518 519 u8 pio_mode; 520 u8 dma_mode; 521 u8 xfer_mode; 522 unsigned int xfer_shift; /* ATA_SHIFT_xxx */ 523 524 unsigned int multi_count; /* sectors count for 525 READ/WRITE MULTIPLE */ 526 unsigned int max_sectors; /* per-device max sectors */ 527 unsigned int cdb_len; 528 529 /* per-dev xfer mask */ 530 unsigned long pio_mask; 531 unsigned long mwdma_mask; 532 unsigned long udma_mask; 533 534 /* for CHS addressing */ 535 u16 cylinders; /* Number of cylinders */ 536 u16 heads; /* Number of heads */ 537 u16 sectors; /* Number of sectors per track */ 538 539 /* error history */ 540 struct ata_ering ering; 541 int spdn_cnt; 542 }; 543 544 /* Offset into struct ata_device. Fields above it are maintained 545 * acress device init. Fields below are zeroed. 546 */ 547 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors) 548 549 struct ata_eh_info { 550 struct ata_device *dev; /* offending device */ 551 u32 serror; /* SError from LLDD */ 552 unsigned int err_mask; /* port-wide err_mask */ 553 unsigned int action; /* ATA_EH_* action mask */ 554 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */ 555 unsigned int flags; /* ATA_EHI_* flags */ 556 557 unsigned int probe_mask; 558 559 char desc[ATA_EH_DESC_LEN]; 560 int desc_len; 561 }; 562 563 struct ata_eh_context { 564 struct ata_eh_info i; 565 int tries[ATA_MAX_DEVICES]; 566 unsigned int classes[ATA_MAX_DEVICES]; 567 unsigned int did_probe_mask; 568 unsigned int saved_ncq_enabled; 569 u8 saved_xfer_mode[ATA_MAX_DEVICES]; 570 }; 571 572 struct ata_acpi_drive 573 { 574 u32 pio; 575 u32 dma; 576 } __packed; 577 578 struct ata_acpi_gtm { 579 struct ata_acpi_drive drive[2]; 580 u32 flags; 581 } __packed; 582 583 struct ata_link { 584 struct ata_port *ap; 585 int pmp; /* port multiplier port # */ 586 587 unsigned int active_tag; /* active tag on this link */ 588 u32 sactive; /* active NCQ commands */ 589 590 unsigned int flags; /* ATA_LFLAG_xxx */ 591 592 unsigned int hw_sata_spd_limit; 593 unsigned int sata_spd_limit; 594 unsigned int sata_spd; /* current SATA PHY speed */ 595 596 /* record runtime error info, protected by host_set lock */ 597 struct ata_eh_info eh_info; 598 /* EH context */ 599 struct ata_eh_context eh_context; 600 601 struct ata_device device[ATA_MAX_DEVICES]; 602 }; 603 604 struct ata_port { 605 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */ 606 const struct ata_port_operations *ops; 607 spinlock_t *lock; 608 unsigned long flags; /* ATA_FLAG_xxx */ 609 unsigned int pflags; /* ATA_PFLAG_xxx */ 610 unsigned int print_id; /* user visible unique port ID */ 611 unsigned int port_no; /* 0 based port no. inside the host */ 612 613 struct ata_prd *prd; /* our SG list */ 614 dma_addr_t prd_dma; /* and its DMA mapping */ 615 616 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */ 617 618 u8 ctl; /* cache of ATA control register */ 619 u8 last_ctl; /* Cache last written value */ 620 unsigned int pio_mask; 621 unsigned int mwdma_mask; 622 unsigned int udma_mask; 623 unsigned int cbl; /* cable type; ATA_CBL_xxx */ 624 625 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE]; 626 unsigned long qc_allocated; 627 unsigned int qc_active; 628 int nr_active_links; /* #links with active qcs */ 629 630 struct ata_link link; /* host default link */ 631 632 int nr_pmp_links; /* nr of available PMP links */ 633 struct ata_link *pmp_link; /* array of PMP links */ 634 struct ata_link *excl_link; /* for PMP qc exclusion */ 635 636 struct ata_port_stats stats; 637 struct ata_host *host; 638 struct device *dev; 639 640 void *port_task_data; 641 struct delayed_work port_task; 642 struct delayed_work hotplug_task; 643 struct work_struct scsi_rescan_task; 644 645 unsigned int hsm_task_state; 646 647 u32 msg_enable; 648 struct list_head eh_done_q; 649 wait_queue_head_t eh_wait_q; 650 int eh_tries; 651 652 pm_message_t pm_mesg; 653 int *pm_result; 654 enum link_pm pm_policy; 655 656 struct timer_list fastdrain_timer; 657 unsigned long fastdrain_cnt; 658 659 void *private_data; 660 661 #ifdef CONFIG_ATA_ACPI 662 acpi_handle acpi_handle; 663 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */ 664 #endif 665 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */ 666 }; 667 668 struct ata_port_operations { 669 void (*dev_config) (struct ata_device *); 670 671 void (*set_piomode) (struct ata_port *, struct ata_device *); 672 void (*set_dmamode) (struct ata_port *, struct ata_device *); 673 unsigned long (*mode_filter) (struct ata_device *, unsigned long); 674 675 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf); 676 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf); 677 678 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf); 679 u8 (*check_status)(struct ata_port *ap); 680 u8 (*check_altstatus)(struct ata_port *ap); 681 void (*dev_select)(struct ata_port *ap, unsigned int device); 682 683 void (*phy_reset) (struct ata_port *ap); /* obsolete */ 684 int (*set_mode) (struct ata_link *link, struct ata_device **r_failed_dev); 685 686 int (*cable_detect) (struct ata_port *ap); 687 688 int (*check_atapi_dma) (struct ata_queued_cmd *qc); 689 690 void (*bmdma_setup) (struct ata_queued_cmd *qc); 691 void (*bmdma_start) (struct ata_queued_cmd *qc); 692 693 unsigned int (*data_xfer) (struct ata_device *dev, unsigned char *buf, 694 unsigned int buflen, int rw); 695 696 int (*qc_defer) (struct ata_queued_cmd *qc); 697 void (*qc_prep) (struct ata_queued_cmd *qc); 698 unsigned int (*qc_issue) (struct ata_queued_cmd *qc); 699 700 /* port multiplier */ 701 void (*pmp_attach) (struct ata_port *ap); 702 void (*pmp_detach) (struct ata_port *ap); 703 704 /* Error handlers. ->error_handler overrides ->eng_timeout and 705 * indicates that new-style EH is in place. 706 */ 707 void (*eng_timeout) (struct ata_port *ap); /* obsolete */ 708 709 void (*freeze) (struct ata_port *ap); 710 void (*thaw) (struct ata_port *ap); 711 void (*error_handler) (struct ata_port *ap); 712 void (*post_internal_cmd) (struct ata_queued_cmd *qc); 713 714 irq_handler_t irq_handler; 715 void (*irq_clear) (struct ata_port *); 716 u8 (*irq_on) (struct ata_port *); 717 718 int (*scr_read) (struct ata_port *ap, unsigned int sc_reg, u32 *val); 719 int (*scr_write) (struct ata_port *ap, unsigned int sc_reg, u32 val); 720 721 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg); 722 int (*port_resume) (struct ata_port *ap); 723 int (*enable_pm) (struct ata_port *ap, enum link_pm policy); 724 void (*disable_pm) (struct ata_port *ap); 725 int (*port_start) (struct ata_port *ap); 726 void (*port_stop) (struct ata_port *ap); 727 728 void (*host_stop) (struct ata_host *host); 729 730 void (*bmdma_stop) (struct ata_queued_cmd *qc); 731 u8 (*bmdma_status) (struct ata_port *ap); 732 }; 733 734 struct ata_port_info { 735 struct scsi_host_template *sht; 736 unsigned long flags; 737 unsigned long link_flags; 738 unsigned long pio_mask; 739 unsigned long mwdma_mask; 740 unsigned long udma_mask; 741 const struct ata_port_operations *port_ops; 742 irq_handler_t irq_handler; 743 void *private_data; 744 }; 745 746 struct ata_timing { 747 unsigned short mode; /* ATA mode */ 748 unsigned short setup; /* t1 */ 749 unsigned short act8b; /* t2 for 8-bit I/O */ 750 unsigned short rec8b; /* t2i for 8-bit I/O */ 751 unsigned short cyc8b; /* t0 for 8-bit I/O */ 752 unsigned short active; /* t2 or tD */ 753 unsigned short recover; /* t2i or tK */ 754 unsigned short cycle; /* t0 */ 755 unsigned short udma; /* t2CYCTYP/2 */ 756 }; 757 758 #define FIT(v, vmin, vmax) max_t(short, min_t(short, v, vmax), vmin) 759 760 extern const unsigned long sata_deb_timing_normal[]; 761 extern const unsigned long sata_deb_timing_hotplug[]; 762 extern const unsigned long sata_deb_timing_long[]; 763 764 extern const struct ata_port_operations ata_dummy_port_ops; 765 extern const struct ata_port_info ata_dummy_port_info; 766 767 static inline const unsigned long * 768 sata_ehc_deb_timing(struct ata_eh_context *ehc) 769 { 770 if (ehc->i.flags & ATA_EHI_HOTPLUGGED) 771 return sata_deb_timing_hotplug; 772 else 773 return sata_deb_timing_normal; 774 } 775 776 static inline int ata_port_is_dummy(struct ata_port *ap) 777 { 778 return ap->ops == &ata_dummy_port_ops; 779 } 780 781 extern void sata_print_link_status(struct ata_link *link); 782 extern void ata_port_probe(struct ata_port *); 783 extern void ata_bus_reset(struct ata_port *ap); 784 extern int sata_set_spd(struct ata_link *link); 785 extern int sata_link_debounce(struct ata_link *link, 786 const unsigned long *params, unsigned long deadline); 787 extern int sata_link_resume(struct ata_link *link, const unsigned long *params, 788 unsigned long deadline); 789 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline); 790 extern int ata_std_softreset(struct ata_link *link, unsigned int *classes, 791 unsigned long deadline); 792 extern int sata_link_hardreset(struct ata_link *link, 793 const unsigned long *timing, unsigned long deadline); 794 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class, 795 unsigned long deadline); 796 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes); 797 extern void ata_port_disable(struct ata_port *); 798 extern void ata_std_ports(struct ata_ioports *ioaddr); 799 800 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports); 801 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev, 802 const struct ata_port_info * const * ppi, int n_ports); 803 extern int ata_host_start(struct ata_host *host); 804 extern int ata_host_register(struct ata_host *host, 805 struct scsi_host_template *sht); 806 extern int ata_host_activate(struct ata_host *host, int irq, 807 irq_handler_t irq_handler, unsigned long irq_flags, 808 struct scsi_host_template *sht); 809 extern void ata_host_detach(struct ata_host *host); 810 extern void ata_host_init(struct ata_host *, struct device *, 811 unsigned long, const struct ata_port_operations *); 812 extern int ata_scsi_detect(struct scsi_host_template *sht); 813 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg); 814 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *)); 815 extern void ata_sas_port_destroy(struct ata_port *); 816 extern struct ata_port *ata_sas_port_alloc(struct ata_host *, 817 struct ata_port_info *, struct Scsi_Host *); 818 extern int ata_sas_port_init(struct ata_port *); 819 extern int ata_sas_port_start(struct ata_port *ap); 820 extern void ata_sas_port_stop(struct ata_port *ap); 821 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *); 822 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), 823 struct ata_port *ap); 824 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc); 825 extern int sata_scr_valid(struct ata_link *link); 826 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val); 827 extern int sata_scr_write(struct ata_link *link, int reg, u32 val); 828 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val); 829 extern int ata_link_online(struct ata_link *link); 830 extern int ata_link_offline(struct ata_link *link); 831 #ifdef CONFIG_PM 832 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg); 833 extern void ata_host_resume(struct ata_host *host); 834 #endif 835 extern int ata_ratelimit(void); 836 extern int ata_busy_sleep(struct ata_port *ap, 837 unsigned long timeout_pat, unsigned long timeout); 838 extern void ata_wait_after_reset(struct ata_port *ap, unsigned long deadline); 839 extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline); 840 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val, 841 unsigned long interval_msec, 842 unsigned long timeout_msec); 843 extern unsigned int ata_dev_try_classify(struct ata_device *dev, int present, 844 u8 *r_err); 845 846 /* 847 * Default driver ops implementations 848 */ 849 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf); 850 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf); 851 extern void ata_tf_to_fis(const struct ata_taskfile *tf, 852 u8 pmp, int is_cmd, u8 *fis); 853 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf); 854 extern unsigned long ata_pack_xfermask(unsigned long pio_mask, 855 unsigned long mwdma_mask, unsigned long udma_mask); 856 extern void ata_unpack_xfermask(unsigned long xfer_mask, 857 unsigned long *pio_mask, unsigned long *mwdma_mask, 858 unsigned long *udma_mask); 859 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask); 860 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode); 861 extern int ata_xfer_mode2shift(unsigned long xfer_mode); 862 extern const char *ata_mode_string(unsigned long xfer_mask); 863 extern unsigned long ata_id_xfermask(const u16 *id); 864 extern void ata_noop_dev_select(struct ata_port *ap, unsigned int device); 865 extern void ata_std_dev_select(struct ata_port *ap, unsigned int device); 866 extern u8 ata_check_status(struct ata_port *ap); 867 extern u8 ata_altstatus(struct ata_port *ap); 868 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf); 869 extern int ata_port_start(struct ata_port *ap); 870 extern int ata_sff_port_start(struct ata_port *ap); 871 extern irqreturn_t ata_interrupt(int irq, void *dev_instance); 872 extern unsigned int ata_data_xfer(struct ata_device *dev, 873 unsigned char *buf, unsigned int buflen, int rw); 874 extern unsigned int ata_data_xfer_noirq(struct ata_device *dev, 875 unsigned char *buf, unsigned int buflen, int rw); 876 extern int ata_std_qc_defer(struct ata_queued_cmd *qc); 877 extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc); 878 extern void ata_qc_prep(struct ata_queued_cmd *qc); 879 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc); 880 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc); 881 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg, 882 unsigned int n_elem); 883 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf); 884 extern void ata_dev_disable(struct ata_device *adev); 885 extern void ata_id_string(const u16 *id, unsigned char *s, 886 unsigned int ofs, unsigned int len); 887 extern void ata_id_c_string(const u16 *id, unsigned char *s, 888 unsigned int ofs, unsigned int len); 889 extern void ata_bmdma_setup(struct ata_queued_cmd *qc); 890 extern void ata_bmdma_start(struct ata_queued_cmd *qc); 891 extern void ata_bmdma_stop(struct ata_queued_cmd *qc); 892 extern u8 ata_bmdma_status(struct ata_port *ap); 893 extern void ata_bmdma_irq_clear(struct ata_port *ap); 894 extern void ata_bmdma_freeze(struct ata_port *ap); 895 extern void ata_bmdma_thaw(struct ata_port *ap); 896 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset, 897 ata_reset_fn_t softreset, 898 ata_reset_fn_t hardreset, 899 ata_postreset_fn_t postreset); 900 extern void ata_bmdma_error_handler(struct ata_port *ap); 901 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc); 902 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc, 903 u8 status, int in_wq); 904 extern void ata_qc_complete(struct ata_queued_cmd *qc); 905 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active, 906 void (*finish_qc)(struct ata_queued_cmd *)); 907 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd, 908 void (*done)(struct scsi_cmnd *)); 909 extern int ata_std_bios_param(struct scsi_device *sdev, 910 struct block_device *bdev, 911 sector_t capacity, int geom[]); 912 extern int ata_scsi_slave_config(struct scsi_device *sdev); 913 extern void ata_scsi_slave_destroy(struct scsi_device *sdev); 914 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev, 915 int queue_depth); 916 extern struct ata_device *ata_dev_pair(struct ata_device *adev); 917 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev); 918 extern u8 ata_irq_on(struct ata_port *ap); 919 920 extern int ata_cable_40wire(struct ata_port *ap); 921 extern int ata_cable_80wire(struct ata_port *ap); 922 extern int ata_cable_sata(struct ata_port *ap); 923 extern int ata_cable_ignore(struct ata_port *ap); 924 extern int ata_cable_unknown(struct ata_port *ap); 925 926 /* 927 * Timing helpers 928 */ 929 930 extern unsigned int ata_pio_need_iordy(const struct ata_device *); 931 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode); 932 extern int ata_timing_compute(struct ata_device *, unsigned short, 933 struct ata_timing *, int, int); 934 extern void ata_timing_merge(const struct ata_timing *, 935 const struct ata_timing *, struct ata_timing *, 936 unsigned int); 937 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle); 938 939 enum { 940 ATA_TIMING_SETUP = (1 << 0), 941 ATA_TIMING_ACT8B = (1 << 1), 942 ATA_TIMING_REC8B = (1 << 2), 943 ATA_TIMING_CYC8B = (1 << 3), 944 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B | 945 ATA_TIMING_CYC8B, 946 ATA_TIMING_ACTIVE = (1 << 4), 947 ATA_TIMING_RECOVER = (1 << 5), 948 ATA_TIMING_CYCLE = (1 << 6), 949 ATA_TIMING_UDMA = (1 << 7), 950 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B | 951 ATA_TIMING_REC8B | ATA_TIMING_CYC8B | 952 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER | 953 ATA_TIMING_CYCLE | ATA_TIMING_UDMA, 954 }; 955 956 /* libata-acpi.c */ 957 #ifdef CONFIG_ATA_ACPI 958 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap) 959 { 960 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID) 961 return &ap->__acpi_init_gtm; 962 return NULL; 963 } 964 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm); 965 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm); 966 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev, 967 const struct ata_acpi_gtm *gtm); 968 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm); 969 #else 970 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap) 971 { 972 return NULL; 973 } 974 975 static inline int ata_acpi_stm(const struct ata_port *ap, 976 struct ata_acpi_gtm *stm) 977 { 978 return -ENOSYS; 979 } 980 981 static inline int ata_acpi_gtm(const struct ata_port *ap, 982 struct ata_acpi_gtm *stm) 983 { 984 return -ENOSYS; 985 } 986 987 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev, 988 const struct ata_acpi_gtm *gtm) 989 { 990 return 0; 991 } 992 993 static inline int ata_acpi_cbl_80wire(struct ata_port *ap, 994 const struct ata_acpi_gtm *gtm) 995 { 996 return 0; 997 } 998 #endif 999 1000 #ifdef CONFIG_PCI 1001 struct pci_dev; 1002 1003 extern int ata_pci_init_one(struct pci_dev *pdev, 1004 const struct ata_port_info * const * ppi); 1005 extern void ata_pci_remove_one(struct pci_dev *pdev); 1006 #ifdef CONFIG_PM 1007 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg); 1008 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev); 1009 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg); 1010 extern int ata_pci_device_resume(struct pci_dev *pdev); 1011 #endif 1012 extern int ata_pci_clear_simplex(struct pci_dev *pdev); 1013 1014 struct pci_bits { 1015 unsigned int reg; /* PCI config register to read */ 1016 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */ 1017 unsigned long mask; 1018 unsigned long val; 1019 }; 1020 1021 extern int ata_pci_init_sff_host(struct ata_host *host); 1022 extern int ata_pci_init_bmdma(struct ata_host *host); 1023 extern int ata_pci_prepare_sff_host(struct pci_dev *pdev, 1024 const struct ata_port_info * const * ppi, 1025 struct ata_host **r_host); 1026 extern int ata_pci_activate_sff_host(struct ata_host *host, 1027 irq_handler_t irq_handler, 1028 struct scsi_host_template *sht); 1029 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits); 1030 extern unsigned long ata_pci_default_filter(struct ata_device *dev, 1031 unsigned long xfer_mask); 1032 #endif /* CONFIG_PCI */ 1033 1034 /* 1035 * PMP 1036 */ 1037 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc); 1038 extern int sata_pmp_std_prereset(struct ata_link *link, unsigned long deadline); 1039 extern int sata_pmp_std_hardreset(struct ata_link *link, unsigned int *class, 1040 unsigned long deadline); 1041 extern void sata_pmp_std_postreset(struct ata_link *link, unsigned int *class); 1042 extern void sata_pmp_do_eh(struct ata_port *ap, 1043 ata_prereset_fn_t prereset, ata_reset_fn_t softreset, 1044 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset, 1045 ata_prereset_fn_t pmp_prereset, ata_reset_fn_t pmp_softreset, 1046 ata_reset_fn_t pmp_hardreset, ata_postreset_fn_t pmp_postreset); 1047 1048 /* 1049 * EH 1050 */ 1051 extern void ata_port_schedule_eh(struct ata_port *ap); 1052 extern int ata_link_abort(struct ata_link *link); 1053 extern int ata_port_abort(struct ata_port *ap); 1054 extern int ata_port_freeze(struct ata_port *ap); 1055 extern int sata_async_notification(struct ata_port *ap); 1056 1057 extern void ata_eh_freeze_port(struct ata_port *ap); 1058 extern void ata_eh_thaw_port(struct ata_port *ap); 1059 1060 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc); 1061 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc); 1062 1063 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset, 1064 ata_reset_fn_t softreset, ata_reset_fn_t hardreset, 1065 ata_postreset_fn_t postreset); 1066 1067 /* 1068 * printk helpers 1069 */ 1070 #define ata_port_printk(ap, lv, fmt, args...) \ 1071 printk("%sata%u: "fmt, lv, (ap)->print_id , ##args) 1072 1073 #define ata_link_printk(link, lv, fmt, args...) do { \ 1074 if ((link)->ap->nr_pmp_links) \ 1075 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \ 1076 (link)->pmp , ##args); \ 1077 else \ 1078 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \ 1079 } while(0) 1080 1081 #define ata_dev_printk(dev, lv, fmt, args...) \ 1082 printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \ 1083 (dev)->link->pmp + (dev)->devno , ##args) 1084 1085 /* 1086 * ata_eh_info helpers 1087 */ 1088 extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...) 1089 __attribute__ ((format (printf, 2, 3))); 1090 extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...) 1091 __attribute__ ((format (printf, 2, 3))); 1092 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi); 1093 1094 static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi) 1095 { 1096 ehi->flags |= ATA_EHI_RESUME_LINK; 1097 ehi->action |= ATA_EH_SOFTRESET; 1098 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1; 1099 } 1100 1101 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi) 1102 { 1103 ata_ehi_schedule_probe(ehi); 1104 ehi->flags |= ATA_EHI_HOTPLUGGED; 1105 ehi->action |= ATA_EH_ENABLE_LINK; 1106 ehi->err_mask |= AC_ERR_ATA_BUS; 1107 } 1108 1109 /* 1110 * port description helpers 1111 */ 1112 extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...) 1113 __attribute__ ((format (printf, 2, 3))); 1114 #ifdef CONFIG_PCI 1115 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset, 1116 const char *name); 1117 #endif 1118 1119 static inline unsigned int ata_tag_valid(unsigned int tag) 1120 { 1121 return (tag < ATA_MAX_QUEUE) ? 1 : 0; 1122 } 1123 1124 static inline unsigned int ata_tag_internal(unsigned int tag) 1125 { 1126 return tag == ATA_MAX_QUEUE - 1; 1127 } 1128 1129 /* 1130 * device helpers 1131 */ 1132 static inline unsigned int ata_class_enabled(unsigned int class) 1133 { 1134 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI || 1135 class == ATA_DEV_PMP || class == ATA_DEV_SEMB; 1136 } 1137 1138 static inline unsigned int ata_class_disabled(unsigned int class) 1139 { 1140 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP || 1141 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP; 1142 } 1143 1144 static inline unsigned int ata_class_absent(unsigned int class) 1145 { 1146 return !ata_class_enabled(class) && !ata_class_disabled(class); 1147 } 1148 1149 static inline unsigned int ata_dev_enabled(const struct ata_device *dev) 1150 { 1151 return ata_class_enabled(dev->class); 1152 } 1153 1154 static inline unsigned int ata_dev_disabled(const struct ata_device *dev) 1155 { 1156 return ata_class_disabled(dev->class); 1157 } 1158 1159 static inline unsigned int ata_dev_absent(const struct ata_device *dev) 1160 { 1161 return ata_class_absent(dev->class); 1162 } 1163 1164 /* 1165 * link helpers 1166 */ 1167 static inline int ata_is_host_link(const struct ata_link *link) 1168 { 1169 return link == &link->ap->link; 1170 } 1171 1172 static inline int ata_link_max_devices(const struct ata_link *link) 1173 { 1174 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS) 1175 return 2; 1176 return 1; 1177 } 1178 1179 static inline int ata_link_active(struct ata_link *link) 1180 { 1181 return ata_tag_valid(link->active_tag) || link->sactive; 1182 } 1183 1184 static inline struct ata_link *ata_port_first_link(struct ata_port *ap) 1185 { 1186 if (ap->nr_pmp_links) 1187 return ap->pmp_link; 1188 return &ap->link; 1189 } 1190 1191 static inline struct ata_link *ata_port_next_link(struct ata_link *link) 1192 { 1193 struct ata_port *ap = link->ap; 1194 1195 if (link == &ap->link) { 1196 if (!ap->nr_pmp_links) 1197 return NULL; 1198 return ap->pmp_link; 1199 } 1200 1201 if (++link < ap->nr_pmp_links + ap->pmp_link) 1202 return link; 1203 return NULL; 1204 } 1205 1206 #define __ata_port_for_each_link(lk, ap) \ 1207 for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk)) 1208 1209 #define ata_port_for_each_link(link, ap) \ 1210 for ((link) = ata_port_first_link(ap); (link); \ 1211 (link) = ata_port_next_link(link)) 1212 1213 #define ata_link_for_each_dev(dev, link) \ 1214 for ((dev) = (link)->device; \ 1215 (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \ 1216 (dev)++) 1217 1218 #define ata_link_for_each_dev_reverse(dev, link) \ 1219 for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \ 1220 (dev) >= (link)->device || ((dev) = NULL); (dev)--) 1221 1222 static inline u8 ata_chk_status(struct ata_port *ap) 1223 { 1224 return ap->ops->check_status(ap); 1225 } 1226 1227 /** 1228 * ata_ncq_enabled - Test whether NCQ is enabled 1229 * @dev: ATA device to test for 1230 * 1231 * LOCKING: 1232 * spin_lock_irqsave(host lock) 1233 * 1234 * RETURNS: 1235 * 1 if NCQ is enabled for @dev, 0 otherwise. 1236 */ 1237 static inline int ata_ncq_enabled(struct ata_device *dev) 1238 { 1239 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF | 1240 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ; 1241 } 1242 1243 /** 1244 * ata_pause - Flush writes and pause 400 nanoseconds. 1245 * @ap: Port to wait for. 1246 * 1247 * LOCKING: 1248 * Inherited from caller. 1249 */ 1250 1251 static inline void ata_pause(struct ata_port *ap) 1252 { 1253 ata_altstatus(ap); 1254 ndelay(400); 1255 } 1256 1257 1258 /** 1259 * ata_busy_wait - Wait for a port status register 1260 * @ap: Port to wait for. 1261 * @bits: bits that must be clear 1262 * @max: number of 10uS waits to perform 1263 * 1264 * Waits up to max*10 microseconds for the selected bits in the port's 1265 * status register to be cleared. 1266 * Returns final value of status register. 1267 * 1268 * LOCKING: 1269 * Inherited from caller. 1270 */ 1271 1272 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits, 1273 unsigned int max) 1274 { 1275 u8 status; 1276 1277 do { 1278 udelay(10); 1279 status = ata_chk_status(ap); 1280 max--; 1281 } while (status != 0xff && (status & bits) && (max > 0)); 1282 1283 return status; 1284 } 1285 1286 1287 /** 1288 * ata_wait_idle - Wait for a port to be idle. 1289 * @ap: Port to wait for. 1290 * 1291 * Waits up to 10ms for port's BUSY and DRQ signals to clear. 1292 * Returns final value of status register. 1293 * 1294 * LOCKING: 1295 * Inherited from caller. 1296 */ 1297 1298 static inline u8 ata_wait_idle(struct ata_port *ap) 1299 { 1300 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000); 1301 1302 #ifdef ATA_DEBUG 1303 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) 1304 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n", 1305 status); 1306 #endif 1307 1308 return status; 1309 } 1310 1311 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc) 1312 { 1313 qc->tf.ctl |= ATA_NIEN; 1314 } 1315 1316 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap, 1317 unsigned int tag) 1318 { 1319 if (likely(ata_tag_valid(tag))) 1320 return &ap->qcmd[tag]; 1321 return NULL; 1322 } 1323 1324 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap, 1325 unsigned int tag) 1326 { 1327 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag); 1328 1329 if (unlikely(!qc) || !ap->ops->error_handler) 1330 return qc; 1331 1332 if ((qc->flags & (ATA_QCFLAG_ACTIVE | 1333 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE) 1334 return qc; 1335 1336 return NULL; 1337 } 1338 1339 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf) 1340 { 1341 memset(tf, 0, sizeof(*tf)); 1342 1343 tf->ctl = dev->link->ap->ctl; 1344 if (dev->devno == 0) 1345 tf->device = ATA_DEVICE_OBS; 1346 else 1347 tf->device = ATA_DEVICE_OBS | ATA_DEV1; 1348 } 1349 1350 static inline void ata_qc_reinit(struct ata_queued_cmd *qc) 1351 { 1352 qc->dma_dir = DMA_NONE; 1353 qc->sg = NULL; 1354 qc->flags = 0; 1355 qc->cursg = NULL; 1356 qc->cursg_ofs = 0; 1357 qc->nbytes = qc->curbytes = 0; 1358 qc->n_elem = 0; 1359 qc->err_mask = 0; 1360 qc->sect_size = ATA_SECT_SIZE; 1361 1362 ata_tf_init(qc->dev, &qc->tf); 1363 1364 /* init result_tf such that it indicates normal completion */ 1365 qc->result_tf.command = ATA_DRDY; 1366 qc->result_tf.feature = 0; 1367 } 1368 1369 static inline int ata_try_flush_cache(const struct ata_device *dev) 1370 { 1371 return ata_id_wcache_enabled(dev->id) || 1372 ata_id_has_flush(dev->id) || 1373 ata_id_has_flush_ext(dev->id); 1374 } 1375 1376 static inline int atapi_cmd_type(u8 opcode) 1377 { 1378 switch (opcode) { 1379 case GPCMD_READ_10: 1380 case GPCMD_READ_12: 1381 return ATAPI_READ; 1382 1383 case GPCMD_WRITE_10: 1384 case GPCMD_WRITE_12: 1385 case GPCMD_WRITE_AND_VERIFY_10: 1386 return ATAPI_WRITE; 1387 1388 case GPCMD_READ_CD: 1389 case GPCMD_READ_CD_MSF: 1390 return ATAPI_READ_CD; 1391 1392 default: 1393 return ATAPI_MISC; 1394 } 1395 } 1396 1397 static inline unsigned int ac_err_mask(u8 status) 1398 { 1399 if (status & (ATA_BUSY | ATA_DRQ)) 1400 return AC_ERR_HSM; 1401 if (status & (ATA_ERR | ATA_DF)) 1402 return AC_ERR_DEV; 1403 return 0; 1404 } 1405 1406 static inline unsigned int __ac_err_mask(u8 status) 1407 { 1408 unsigned int mask = ac_err_mask(status); 1409 if (mask == 0) 1410 return AC_ERR_OTHER; 1411 return mask; 1412 } 1413 1414 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host) 1415 { 1416 return *(struct ata_port **)&host->hostdata[0]; 1417 } 1418 1419 #endif /* __LINUX_LIBATA_H__ */ 1420