File Index
Files and directories
Sign in
FILE

libata.h

File preview with syntax highlighting.

linux-6.19.14/include/linux/libata.h C
   1/* SPDX-License-Identifier: GPL-2.0-or-later */
   2/*
   3 *  Copyright 2003-2005 Red Hat, Inc.  All rights reserved.
   4 *  Copyright 2003-2005 Jeff Garzik
   5 *
   6 *  libata documentation is available via 'make {ps|pdf}docs',
   7 *  as Documentation/driver-api/libata.rst
   8 */
   9
  10#ifndef __LINUX_LIBATA_H__
  11#define __LINUX_LIBATA_H__
  12
  13#include <linux/delay.h>
  14#include <linux/jiffies.h>
  15#include <linux/interrupt.h>
  16#include <linux/dma-mapping.h>
  17#include <linux/scatterlist.h>
  18#include <linux/io.h>
  19#include <linux/ata.h>
  20#include <linux/workqueue.h>
  21#include <scsi/scsi_host.h>
  22#include <linux/acpi.h>
  23#include <linux/cdrom.h>
  24#include <linux/sched.h>
  25#include <linux/async.h>
  26
  27/*
  28 * Define if arch has non-standard setup.  This is a _PCI_ standard
  29 * not a legacy or ISA standard.
  30 */
  31#ifdef CONFIG_ATA_NONSTANDARD
  32#include <asm/libata-portmap.h>
  33#else
  34#define ATA_PRIMARY_IRQ(dev)	14
  35#define ATA_SECONDARY_IRQ(dev)	15
  36#endif
  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_IRQ_TRAP		/* define to ack screaming irqs */
  43
  44/* defines only for the constants which don't work well as enums */
  45#define ATA_TAG_POISON		0xfafbfcfdU
  46
  47/*
  48 * Quirk flags bits.
  49 * ata_device->quirks is an unsigned int, so __ATA_QUIRK_MAX must not exceed 32.
  50 */
  51enum ata_quirks {
  52	__ATA_QUIRK_DIAGNOSTIC,		/* Failed boot diag */
  53	__ATA_QUIRK_NODMA,		/* DMA problems */
  54	__ATA_QUIRK_NONCQ,		/* Don't use NCQ */
  55	__ATA_QUIRK_MAX_SEC_128,	/* Limit max sects to 128 */
  56	__ATA_QUIRK_BROKEN_HPA,		/* Broken HPA */
  57	__ATA_QUIRK_DISABLE,		/* Disable it */
  58	__ATA_QUIRK_HPA_SIZE,		/* Native size off by one */
  59	__ATA_QUIRK_IVB,		/* cbl det validity bit bugs */
  60	__ATA_QUIRK_STUCK_ERR,		/* Stuck ERR on next PACKET */
  61	__ATA_QUIRK_BRIDGE_OK,		/* No bridge limits */
  62	__ATA_QUIRK_ATAPI_MOD16_DMA,	/* Use ATAPI DMA for commands that */
  63					/* are not a multiple of 16 bytes */
  64	__ATA_QUIRK_FIRMWARE_WARN,	/* Firmware update warning */
  65	__ATA_QUIRK_1_5_GBPS,		/* Force 1.5 Gbps */
  66	__ATA_QUIRK_NOSETXFER,		/* Skip SETXFER, SATA only */
  67	__ATA_QUIRK_BROKEN_FPDMA_AA,	/* Skip AA */
  68	__ATA_QUIRK_DUMP_ID,		/* Dump IDENTIFY data */
  69	__ATA_QUIRK_MAX_SEC_LBA48,	/* Set max sects to 65535 */
  70	__ATA_QUIRK_ATAPI_DMADIR,	/* Device requires dmadir */
  71	__ATA_QUIRK_NO_NCQ_TRIM,	/* Do not use queued TRIM */
  72	__ATA_QUIRK_NOLPM,		/* Do not use LPM */
  73	__ATA_QUIRK_WD_BROKEN_LPM,	/* Some WDs have broken LPM */
  74	__ATA_QUIRK_ZERO_AFTER_TRIM,	/* Guarantees zero after trim */
  75	__ATA_QUIRK_NO_DMA_LOG,		/* Do not use DMA for log read */
  76	__ATA_QUIRK_NOTRIM,		/* Do not use TRIM */
  77	__ATA_QUIRK_MAX_SEC_1024,	/* Limit max sects to 1024 */
  78	__ATA_QUIRK_MAX_SEC,		/* Limit max sectors */
  79	__ATA_QUIRK_MAX_TRIM_128M,	/* Limit max trim size to 128M */
  80	__ATA_QUIRK_NO_NCQ_ON_ATI,	/* Disable NCQ on ATI chipset */
  81	__ATA_QUIRK_NO_LPM_ON_ATI,	/* Disable LPM on ATI chipset */
  82	__ATA_QUIRK_NO_ID_DEV_LOG,	/* Identify device log missing */
  83	__ATA_QUIRK_NO_LOG_DIR,		/* Do not read log directory */
  84	__ATA_QUIRK_NO_FUA,		/* Do not use FUA */
  85
  86	__ATA_QUIRK_MAX,
  87};
  88
  89/*
  90 * Quirk flags: may be set by libata or controller drivers on drives.
  91 * Some quirks may be drive/controller pair dependent.
  92 */
  93enum {
  94	ATA_QUIRK_DIAGNOSTIC		= (1U << __ATA_QUIRK_DIAGNOSTIC),
  95	ATA_QUIRK_NODMA			= (1U << __ATA_QUIRK_NODMA),
  96	ATA_QUIRK_NONCQ			= (1U << __ATA_QUIRK_NONCQ),
  97	ATA_QUIRK_MAX_SEC_128		= (1U << __ATA_QUIRK_MAX_SEC_128),
  98	ATA_QUIRK_BROKEN_HPA		= (1U << __ATA_QUIRK_BROKEN_HPA),
  99	ATA_QUIRK_DISABLE		= (1U << __ATA_QUIRK_DISABLE),
 100	ATA_QUIRK_HPA_SIZE		= (1U << __ATA_QUIRK_HPA_SIZE),
 101	ATA_QUIRK_IVB			= (1U << __ATA_QUIRK_IVB),
 102	ATA_QUIRK_STUCK_ERR		= (1U << __ATA_QUIRK_STUCK_ERR),
 103	ATA_QUIRK_BRIDGE_OK		= (1U << __ATA_QUIRK_BRIDGE_OK),
 104	ATA_QUIRK_ATAPI_MOD16_DMA	= (1U << __ATA_QUIRK_ATAPI_MOD16_DMA),
 105	ATA_QUIRK_FIRMWARE_WARN		= (1U << __ATA_QUIRK_FIRMWARE_WARN),
 106	ATA_QUIRK_1_5_GBPS		= (1U << __ATA_QUIRK_1_5_GBPS),
 107	ATA_QUIRK_NOSETXFER		= (1U << __ATA_QUIRK_NOSETXFER),
 108	ATA_QUIRK_BROKEN_FPDMA_AA	= (1U << __ATA_QUIRK_BROKEN_FPDMA_AA),
 109	ATA_QUIRK_DUMP_ID		= (1U << __ATA_QUIRK_DUMP_ID),
 110	ATA_QUIRK_MAX_SEC_LBA48		= (1U << __ATA_QUIRK_MAX_SEC_LBA48),
 111	ATA_QUIRK_ATAPI_DMADIR		= (1U << __ATA_QUIRK_ATAPI_DMADIR),
 112	ATA_QUIRK_NO_NCQ_TRIM		= (1U << __ATA_QUIRK_NO_NCQ_TRIM),
 113	ATA_QUIRK_NOLPM			= (1U << __ATA_QUIRK_NOLPM),
 114	ATA_QUIRK_WD_BROKEN_LPM		= (1U << __ATA_QUIRK_WD_BROKEN_LPM),
 115	ATA_QUIRK_ZERO_AFTER_TRIM	= (1U << __ATA_QUIRK_ZERO_AFTER_TRIM),
 116	ATA_QUIRK_NO_DMA_LOG		= (1U << __ATA_QUIRK_NO_DMA_LOG),
 117	ATA_QUIRK_NOTRIM		= (1U << __ATA_QUIRK_NOTRIM),
 118	ATA_QUIRK_MAX_SEC_1024		= (1U << __ATA_QUIRK_MAX_SEC_1024),
 119	ATA_QUIRK_MAX_SEC		= (1U << __ATA_QUIRK_MAX_SEC),
 120	ATA_QUIRK_MAX_TRIM_128M		= (1U << __ATA_QUIRK_MAX_TRIM_128M),
 121	ATA_QUIRK_NO_NCQ_ON_ATI		= (1U << __ATA_QUIRK_NO_NCQ_ON_ATI),
 122	ATA_QUIRK_NO_LPM_ON_ATI		= (1U << __ATA_QUIRK_NO_LPM_ON_ATI),
 123	ATA_QUIRK_NO_ID_DEV_LOG		= (1U << __ATA_QUIRK_NO_ID_DEV_LOG),
 124	ATA_QUIRK_NO_LOG_DIR		= (1U << __ATA_QUIRK_NO_LOG_DIR),
 125	ATA_QUIRK_NO_FUA		= (1U << __ATA_QUIRK_NO_FUA),
 126};
 127
 128enum {
 129	/* various global constants */
 130	LIBATA_MAX_PRD		= ATA_MAX_PRD / 2,
 131	LIBATA_DUMB_MAX_PRD	= ATA_MAX_PRD / 4,	/* Worst case */
 132	ATA_DEF_QUEUE		= 1,
 133	ATA_MAX_QUEUE		= 32,
 134	ATA_TAG_INTERNAL	= ATA_MAX_QUEUE,
 135	ATA_SHORT_PAUSE		= 16,
 136
 137	ATAPI_MAX_DRAIN		= 16 << 10,
 138
 139	ATA_ALL_DEVICES		= (1 << ATA_MAX_DEVICES) - 1,
 140
 141	ATA_SHT_EMULATED	= 1,
 142	ATA_SHT_THIS_ID		= -1,
 143
 144	/* struct ata_taskfile flags */
 145	ATA_TFLAG_LBA48		= (1 << 0), /* enable 48-bit LBA and "HOB" */
 146	ATA_TFLAG_ISADDR	= (1 << 1), /* enable r/w to nsect/lba regs */
 147	ATA_TFLAG_DEVICE	= (1 << 2), /* enable r/w to device reg */
 148	ATA_TFLAG_WRITE		= (1 << 3), /* data dir: host->dev==1 (write) */
 149	ATA_TFLAG_LBA		= (1 << 4), /* enable LBA */
 150	ATA_TFLAG_FUA		= (1 << 5), /* enable FUA */
 151	ATA_TFLAG_POLLING	= (1 << 6), /* set nIEN to 1 and use polling */
 152
 153	/* struct ata_device stuff */
 154	ATA_DFLAG_LBA		= (1 << 0), /* device supports LBA */
 155	ATA_DFLAG_LBA48		= (1 << 1), /* device supports LBA48 */
 156	ATA_DFLAG_CDB_INTR	= (1 << 2), /* device asserts INTRQ when ready for CDB */
 157	ATA_DFLAG_NCQ		= (1 << 3), /* device supports NCQ */
 158	ATA_DFLAG_FLUSH_EXT	= (1 << 4), /* do FLUSH_EXT instead of FLUSH */
 159	ATA_DFLAG_ACPI_PENDING	= (1 << 5), /* ACPI resume action pending */
 160	ATA_DFLAG_ACPI_FAILED	= (1 << 6), /* ACPI on devcfg has failed */
 161	ATA_DFLAG_AN		= (1 << 7), /* AN configured */
 162	ATA_DFLAG_TRUSTED	= (1 << 8), /* device supports trusted send/recv */
 163	ATA_DFLAG_FUA		= (1 << 9), /* device supports FUA */
 164	ATA_DFLAG_DMADIR	= (1 << 10), /* device requires DMADIR */
 165	ATA_DFLAG_NCQ_SEND_RECV = (1 << 11), /* device supports NCQ SEND and RECV */
 166	ATA_DFLAG_NCQ_PRIO	= (1 << 12), /* device supports NCQ priority */
 167	ATA_DFLAG_CDL		= (1 << 13), /* supports cmd duration limits */
 168	ATA_DFLAG_CFG_MASK	= (1 << 14) - 1,
 169
 170	ATA_DFLAG_PIO		= (1 << 14), /* device limited to PIO mode */
 171	ATA_DFLAG_NCQ_OFF	= (1 << 15), /* device limited to non-NCQ mode */
 172	ATA_DFLAG_SLEEPING	= (1 << 16), /* device is sleeping */
 173	ATA_DFLAG_DUBIOUS_XFER	= (1 << 17), /* data transfer not verified */
 174	ATA_DFLAG_NO_UNLOAD	= (1 << 18), /* device doesn't support unload */
 175	ATA_DFLAG_UNLOCK_HPA	= (1 << 19), /* unlock HPA */
 176	ATA_DFLAG_INIT_MASK	= (1 << 20) - 1,
 177
 178	ATA_DFLAG_NCQ_PRIO_ENABLED = (1 << 20), /* Priority cmds sent to dev */
 179	ATA_DFLAG_CDL_ENABLED	= (1 << 21), /* cmd duration limits is enabled */
 180	ATA_DFLAG_RESUMING	= (1 << 22),  /* Device is resuming */
 181	ATA_DFLAG_DETACH	= (1 << 24),
 182	ATA_DFLAG_DETACHED	= (1 << 25),
 183	ATA_DFLAG_DA		= (1 << 26), /* device supports Device Attention */
 184	ATA_DFLAG_DEVSLP	= (1 << 27), /* device supports Device Sleep */
 185	ATA_DFLAG_ACPI_DISABLED = (1 << 28), /* ACPI for the device is disabled */
 186	ATA_DFLAG_D_SENSE	= (1 << 29), /* Descriptor sense requested */
 187
 188	ATA_DFLAG_FEATURES_MASK	= (ATA_DFLAG_TRUSTED | ATA_DFLAG_DA |	\
 189				   ATA_DFLAG_DEVSLP | ATA_DFLAG_NCQ_SEND_RECV | \
 190				   ATA_DFLAG_NCQ_PRIO | ATA_DFLAG_FUA | \
 191				   ATA_DFLAG_CDL),
 192
 193	ATA_DEV_UNKNOWN		= 0,	/* unknown device */
 194	ATA_DEV_ATA		= 1,	/* ATA device */
 195	ATA_DEV_ATA_UNSUP	= 2,	/* ATA device (unsupported) */
 196	ATA_DEV_ATAPI		= 3,	/* ATAPI device */
 197	ATA_DEV_ATAPI_UNSUP	= 4,	/* ATAPI device (unsupported) */
 198	ATA_DEV_PMP		= 5,	/* SATA port multiplier */
 199	ATA_DEV_PMP_UNSUP	= 6,	/* SATA port multiplier (unsupported) */
 200	ATA_DEV_SEMB		= 7,	/* SEMB */
 201	ATA_DEV_SEMB_UNSUP	= 8,	/* SEMB (unsupported) */
 202	ATA_DEV_ZAC		= 9,	/* ZAC device */
 203	ATA_DEV_ZAC_UNSUP	= 10,	/* ZAC device (unsupported) */
 204	ATA_DEV_NONE		= 11,	/* no device */
 205
 206	/* struct ata_link flags */
 207	/* NOTE: struct ata_force_param currently stores lflags in u16 */
 208	ATA_LFLAG_NO_HRST	= (1 << 1), /* avoid hardreset */
 209	ATA_LFLAG_NO_SRST	= (1 << 2), /* avoid softreset */
 210	ATA_LFLAG_ASSUME_ATA	= (1 << 3), /* assume ATA class */
 211	ATA_LFLAG_ASSUME_SEMB	= (1 << 4), /* assume SEMB class */
 212	ATA_LFLAG_ASSUME_CLASS	= ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
 213	ATA_LFLAG_NO_RETRY	= (1 << 5), /* don't retry this link */
 214	ATA_LFLAG_DISABLED	= (1 << 6), /* link is disabled */
 215	ATA_LFLAG_SW_ACTIVITY	= (1 << 7), /* keep activity stats */
 216	ATA_LFLAG_NO_LPM	= (1 << 8), /* disable LPM on this link */
 217	ATA_LFLAG_RST_ONCE	= (1 << 9), /* limit recovery to one reset */
 218	ATA_LFLAG_CHANGED	= (1 << 10), /* LPM state changed on this link */
 219	ATA_LFLAG_NO_DEBOUNCE_DELAY = (1 << 11), /* no debounce delay on link resume */
 220
 221	/* struct ata_port flags */
 222	ATA_FLAG_SLAVE_POSS	= (1 << 0), /* host supports slave dev */
 223					    /* (doesn't imply presence) */
 224	ATA_FLAG_SATA		= (1 << 1),
 225	ATA_FLAG_NO_LPM		= (1 << 2), /* host not happy with LPM */
 226	ATA_FLAG_NO_LOG_PAGE	= (1 << 5), /* do not issue log page read */
 227	ATA_FLAG_NO_ATAPI	= (1 << 6), /* No ATAPI support */
 228	ATA_FLAG_PIO_DMA	= (1 << 7), /* PIO cmds via DMA */
 229	ATA_FLAG_PIO_LBA48	= (1 << 8), /* Host DMA engine is LBA28 only */
 230	ATA_FLAG_PIO_POLLING	= (1 << 9), /* use polling PIO if LLD
 231					     * doesn't handle PIO interrupts */
 232	ATA_FLAG_NCQ		= (1 << 10), /* host supports NCQ */
 233	ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
 234	ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
 235	ATA_FLAG_DEBUGMSG	= (1 << 13),
 236	ATA_FLAG_FPDMA_AA		= (1 << 14), /* driver supports Auto-Activate */
 237	ATA_FLAG_IGN_SIMPLEX	= (1 << 15), /* ignore SIMPLEX */
 238	ATA_FLAG_NO_IORDY	= (1 << 16), /* controller lacks iordy */
 239	ATA_FLAG_ACPI_SATA	= (1 << 17), /* need native SATA ACPI layout */
 240	ATA_FLAG_AN		= (1 << 18), /* controller supports AN */
 241	ATA_FLAG_PMP		= (1 << 19), /* controller supports PMP */
 242	ATA_FLAG_FPDMA_AUX	= (1 << 20), /* controller supports H2DFIS aux field */
 243	ATA_FLAG_EM		= (1 << 21), /* driver supports enclosure
 244					      * management */
 245	ATA_FLAG_SW_ACTIVITY	= (1 << 22), /* driver supports sw activity
 246					      * led */
 247	ATA_FLAG_NO_DIPM	= (1 << 23), /* host not happy with DIPM */
 248	ATA_FLAG_SAS_HOST	= (1 << 24), /* SAS host */
 249
 250	/* bits 24:31 of ap->flags are reserved for LLD specific flags */
 251
 252
 253	/* struct ata_port pflags */
 254	ATA_PFLAG_EH_PENDING	= (1 << 0), /* EH pending */
 255	ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
 256	ATA_PFLAG_FROZEN	= (1 << 2), /* port is frozen */
 257	ATA_PFLAG_RECOVERED	= (1 << 3), /* recovery action performed */
 258	ATA_PFLAG_LOADING	= (1 << 4), /* boot/loading probe */
 259	ATA_PFLAG_SCSI_HOTPLUG	= (1 << 6), /* SCSI hotplug scheduled */
 260	ATA_PFLAG_INITIALIZING	= (1 << 7), /* being initialized, don't touch */
 261	ATA_PFLAG_RESETTING	= (1 << 8), /* reset in progress */
 262	ATA_PFLAG_UNLOADING	= (1 << 9), /* driver is being unloaded */
 263	ATA_PFLAG_UNLOADED	= (1 << 10), /* driver is unloaded */
 264
 265	ATA_PFLAG_RESUMING	= (1 << 16),  /* port is being resumed */
 266	ATA_PFLAG_SUSPENDED	= (1 << 17), /* port is suspended (power) */
 267	ATA_PFLAG_PM_PENDING	= (1 << 18), /* PM operation pending */
 268	ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
 269
 270	ATA_PFLAG_PIO32		= (1 << 20),  /* 32bit PIO */
 271	ATA_PFLAG_PIO32CHANGE	= (1 << 21),  /* 32bit PIO can be turned on/off */
 272	ATA_PFLAG_EXTERNAL	= (1 << 22),  /* eSATA/external port */
 273
 274	/* struct ata_queued_cmd flags */
 275	ATA_QCFLAG_ACTIVE	= (1 << 0), /* cmd not yet ack'd to scsi lyer */
 276	ATA_QCFLAG_DMAMAP	= (1 << 1), /* SG table is DMA mapped */
 277	ATA_QCFLAG_RTF_FILLED	= (1 << 2), /* result TF has been filled */
 278	ATA_QCFLAG_IO		= (1 << 3), /* standard IO command */
 279	ATA_QCFLAG_RESULT_TF	= (1 << 4), /* result TF requested */
 280	ATA_QCFLAG_CLEAR_EXCL	= (1 << 5), /* clear excl_link on completion */
 281	ATA_QCFLAG_QUIET	= (1 << 6), /* don't report device error */
 282	ATA_QCFLAG_RETRY	= (1 << 7), /* retry after failure */
 283	ATA_QCFLAG_HAS_CDL	= (1 << 8), /* qc has CDL a descriptor set */
 284
 285	ATA_QCFLAG_EH		= (1 << 16), /* cmd aborted and owned by EH */
 286	ATA_QCFLAG_SENSE_VALID	= (1 << 17), /* sense data valid */
 287	ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
 288	ATA_QCFLAG_EH_SUCCESS_CMD = (1 << 19), /* EH should fetch sense for this successful cmd */
 289
 290	/* host set flags */
 291	ATA_HOST_SIMPLEX	= (1 << 0),	/* Host is simplex, one DMA channel per host only */
 292	ATA_HOST_STARTED	= (1 << 1),	/* Host started */
 293	ATA_HOST_PARALLEL_SCAN	= (1 << 2),	/* Ports on this host can be scanned in parallel */
 294	ATA_HOST_IGNORE_ATA	= (1 << 3),	/* Ignore ATA devices on this host. */
 295
 296	ATA_HOST_NO_PART	= (1 << 4), /* Host does not support partial */
 297	ATA_HOST_NO_SSC		= (1 << 5), /* Host does not support slumber */
 298	ATA_HOST_NO_DEVSLP	= (1 << 6), /* Host does not support devslp */
 299
 300	/* bits 24:31 of host->flags are reserved for LLD specific flags */
 301
 302	/* Various lengths of time */
 303	ATA_TMOUT_INTERNAL_QUICK = 5000,
 304	ATA_TMOUT_MAX_PARK	= 30000,
 305
 306	/*
 307	 * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms.  2s
 308	 * is too much without parallel probing.  Use 2s if parallel
 309	 * probing is available, 800ms otherwise.
 310	 */
 311	ATA_TMOUT_FF_WAIT_LONG	=  2000,
 312	ATA_TMOUT_FF_WAIT	=   800,
 313
 314	/* Spec mandates to wait for ">= 2ms" before checking status
 315	 * after reset.  We wait 150ms, because that was the magic
 316	 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
 317	 * the period of time between when the ATA command register is
 318	 * written, and then status is checked.  Because waiting for
 319	 * "a while" before checking status is fine, post SRST, we
 320	 * perform this magic delay here as well.
 321	 *
 322	 * Old drivers/ide uses the 2mS rule and then waits for ready.
 323	 */
 324	ATA_WAIT_AFTER_RESET	=  150,
 325
 326	/* If PMP is supported, we have to do follow-up SRST.  As some
 327	 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
 328	 * advised to wait only for the following duration before
 329	 * doing SRST.
 330	 */
 331	ATA_TMOUT_PMP_SRST_WAIT	= 10000,
 332
 333	/* When the LPM policy is set to ATA_LPM_MAX_POWER, there might
 334	 * be a spurious PHY event, so ignore the first PHY event that
 335	 * occurs within 10s after the policy change.
 336	 */
 337	ATA_TMOUT_SPURIOUS_PHY	= 10000,
 338
 339	/* ATA bus states */
 340	BUS_UNKNOWN		= 0,
 341	BUS_DMA			= 1,
 342	BUS_IDLE		= 2,
 343	BUS_NOINTR		= 3,
 344	BUS_NODATA		= 4,
 345	BUS_TIMER		= 5,
 346	BUS_PIO			= 6,
 347	BUS_EDD			= 7,
 348	BUS_IDENTIFY		= 8,
 349	BUS_PACKET		= 9,
 350
 351	/* SATA port states */
 352	PORT_UNKNOWN		= 0,
 353	PORT_ENABLED		= 1,
 354	PORT_DISABLED		= 2,
 355
 356	/* encoding various smaller bitmaps into a single
 357	 * unsigned int bitmap
 358	 */
 359	ATA_NR_PIO_MODES	= 7,
 360	ATA_NR_MWDMA_MODES	= 5,
 361	ATA_NR_UDMA_MODES	= 8,
 362
 363	ATA_SHIFT_PIO		= 0,
 364	ATA_SHIFT_MWDMA		= ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
 365	ATA_SHIFT_UDMA		= ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
 366	ATA_SHIFT_PRIO		= 6,
 367
 368	ATA_PRIO_HIGH		= 2,
 369	/* size of buffer to pad xfers ending on unaligned boundaries */
 370	ATA_DMA_PAD_SZ		= 4,
 371
 372	/* ering size */
 373	ATA_ERING_SIZE		= 32,
 374
 375	/* return values for ->qc_defer */
 376	ATA_DEFER_LINK		= 1,
 377	ATA_DEFER_PORT		= 2,
 378
 379	/* desc_len for ata_eh_info and context */
 380	ATA_EH_DESC_LEN		= 80,
 381
 382	/* reset / recovery action types */
 383	ATA_EH_REVALIDATE	= (1 << 0),
 384	ATA_EH_SOFTRESET	= (1 << 1), /* meaningful only in ->prereset */
 385	ATA_EH_HARDRESET	= (1 << 2), /* meaningful only in ->prereset */
 386	ATA_EH_RESET		= ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
 387	ATA_EH_ENABLE_LINK	= (1 << 3),
 388	ATA_EH_PARK		= (1 << 5), /* unload heads and stop I/O */
 389	ATA_EH_GET_SUCCESS_SENSE = (1 << 6), /* Get sense data for successful cmd */
 390	ATA_EH_SET_ACTIVE	= (1 << 7), /* Set a device to active power mode */
 391
 392	ATA_EH_PERDEV_MASK	= ATA_EH_REVALIDATE | ATA_EH_PARK |
 393				  ATA_EH_GET_SUCCESS_SENSE | ATA_EH_SET_ACTIVE,
 394	ATA_EH_ALL_ACTIONS	= ATA_EH_REVALIDATE | ATA_EH_RESET |
 395				  ATA_EH_ENABLE_LINK,
 396
 397	/* ata_eh_info->flags */
 398	ATA_EHI_HOTPLUGGED	= (1 << 0),  /* could have been hotplugged */
 399	ATA_EHI_NO_AUTOPSY	= (1 << 2),  /* no autopsy */
 400	ATA_EHI_QUIET		= (1 << 3),  /* be quiet */
 401	ATA_EHI_NO_RECOVERY	= (1 << 4),  /* no recovery */
 402
 403	ATA_EHI_DID_SOFTRESET	= (1 << 16), /* already soft-reset this port */
 404	ATA_EHI_DID_HARDRESET	= (1 << 17), /* already soft-reset this port */
 405	ATA_EHI_PRINTINFO	= (1 << 18), /* print configuration info */
 406	ATA_EHI_SETMODE		= (1 << 19), /* configure transfer mode */
 407	ATA_EHI_POST_SETMODE	= (1 << 20), /* revalidating after setmode */
 408	ATA_EHI_DID_PRINT_QUIRKS = (1 << 21), /* already printed quirks info */
 409
 410	ATA_EHI_DID_RESET	= ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
 411
 412	/* mask of flags to transfer *to* the slave link */
 413	ATA_EHI_TO_SLAVE_MASK	= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
 414
 415	/* max tries if error condition is still set after ->error_handler */
 416	ATA_EH_MAX_TRIES	= 5,
 417
 418	/* sometimes resuming a link requires several retries */
 419	ATA_LINK_RESUME_TRIES	= 5,
 420
 421	/* how hard are we gonna try to probe/recover devices */
 422	ATA_EH_DEV_TRIES	= 3,
 423	ATA_EH_PMP_TRIES	= 5,
 424	ATA_EH_PMP_LINK_TRIES	= 3,
 425
 426	SATA_PMP_RW_TIMEOUT	= 3000,		/* PMP read/write timeout */
 427
 428	/* This should match the actual table size of
 429	 * ata_eh_cmd_timeout_table in libata-eh.c.
 430	 */
 431	ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 8,
 432
 433	/* User visible DMA mask for DMA control. DO NOT renumber. */
 434	ATA_DMA_MASK_ATA	= (1 << 0),	/* DMA on ATA Disk */
 435	ATA_DMA_MASK_ATAPI	= (1 << 1),	/* DMA on ATAPI */
 436	ATA_DMA_MASK_CFA	= (1 << 2),	/* DMA on CF Card */
 437
 438	/* ATAPI command types */
 439	ATAPI_READ		= 0,		/* READs */
 440	ATAPI_WRITE		= 1,		/* WRITEs */
 441	ATAPI_READ_CD		= 2,		/* READ CD [MSF] */
 442	ATAPI_PASS_THRU		= 3,		/* SAT pass-thru */
 443	ATAPI_MISC		= 4,		/* the rest */
 444
 445	/* Timing constants */
 446	ATA_TIMING_SETUP	= (1 << 0),
 447	ATA_TIMING_ACT8B	= (1 << 1),
 448	ATA_TIMING_REC8B	= (1 << 2),
 449	ATA_TIMING_CYC8B	= (1 << 3),
 450	ATA_TIMING_8BIT		= ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
 451				  ATA_TIMING_CYC8B,
 452	ATA_TIMING_ACTIVE	= (1 << 4),
 453	ATA_TIMING_RECOVER	= (1 << 5),
 454	ATA_TIMING_DMACK_HOLD	= (1 << 6),
 455	ATA_TIMING_CYCLE	= (1 << 7),
 456	ATA_TIMING_UDMA		= (1 << 8),
 457	ATA_TIMING_ALL		= ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
 458				  ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
 459				  ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
 460				  ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
 461				  ATA_TIMING_UDMA,
 462
 463	/* ACPI constants */
 464	ATA_ACPI_FILTER_SETXFER	= 1 << 0,
 465	ATA_ACPI_FILTER_LOCK	= 1 << 1,
 466	ATA_ACPI_FILTER_DIPM	= 1 << 2,
 467	ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3,	/* FPDMA non-zero offset */
 468	ATA_ACPI_FILTER_FPDMA_AA = 1 << 4,	/* FPDMA auto activate */
 469
 470	ATA_ACPI_FILTER_DEFAULT	= ATA_ACPI_FILTER_SETXFER |
 471				  ATA_ACPI_FILTER_LOCK |
 472				  ATA_ACPI_FILTER_DIPM,
 473};
 474
 475enum ata_xfer_mask {
 476	ATA_MASK_PIO		= ((1U << ATA_NR_PIO_MODES) - 1) << ATA_SHIFT_PIO,
 477	ATA_MASK_MWDMA		= ((1U << ATA_NR_MWDMA_MODES) - 1) << ATA_SHIFT_MWDMA,
 478	ATA_MASK_UDMA		= ((1U << ATA_NR_UDMA_MODES) - 1) << ATA_SHIFT_UDMA,
 479};
 480
 481enum hsm_task_states {
 482	HSM_ST_IDLE,		/* no command on going */
 483	HSM_ST_FIRST,		/* (waiting the device to)
 484				   write CDB or first data block */
 485	HSM_ST,			/* (waiting the device to) transfer data */
 486	HSM_ST_LAST,		/* (waiting the device to) complete command */
 487	HSM_ST_ERR,		/* error */
 488};
 489
 490enum ata_completion_errors {
 491	AC_ERR_OK		= 0,	    /* no error */
 492	AC_ERR_DEV		= (1 << 0), /* device reported error */
 493	AC_ERR_HSM		= (1 << 1), /* host state machine violation */
 494	AC_ERR_TIMEOUT		= (1 << 2), /* timeout */
 495	AC_ERR_MEDIA		= (1 << 3), /* media error */
 496	AC_ERR_ATA_BUS		= (1 << 4), /* ATA bus error */
 497	AC_ERR_HOST_BUS		= (1 << 5), /* host bus error */
 498	AC_ERR_SYSTEM		= (1 << 6), /* system error */
 499	AC_ERR_INVALID		= (1 << 7), /* invalid argument */
 500	AC_ERR_OTHER		= (1 << 8), /* unknown */
 501	AC_ERR_NODEV_HINT	= (1 << 9), /* polling device detection hint */
 502	AC_ERR_NCQ		= (1 << 10), /* marker for offending NCQ qc */
 503};
 504
 505/*
 506 * Link Power Management (LPM) policies.
 507 *
 508 * The default LPM policy to use for a device link is defined using these values
 509 * with the CONFIG_SATA_MOBILE_LPM_POLICY config option and applied through the
 510 * target_lpm_policy field of struct ata_port.
 511 *
 512 * If you alter this, you also need to alter the policy names used with the
 513 * sysfs attribute link_power_management_policy defined in libata-sata.c.
 514 */
 515enum ata_lpm_policy {
 516	/* Keep firmware settings */
 517	ATA_LPM_UNKNOWN,
 518	/* No power savings (maximum performance) */
 519	ATA_LPM_MAX_POWER,
 520	/* HIPM (Partial) */
 521	ATA_LPM_MED_POWER,
 522	/* HIPM (Partial) and DIPM (Partial and Slumber) */
 523	ATA_LPM_MED_POWER_WITH_DIPM,
 524	/* HIPM (Partial and DevSleep) and DIPM (Partial and Slumber) */
 525	ATA_LPM_MIN_POWER_WITH_PARTIAL,
 526	/* HIPM (Slumber and DevSleep) and DIPM (Partial and Slumber) */
 527	ATA_LPM_MIN_POWER,
 528};
 529
 530enum ata_lpm_hints {
 531	ATA_LPM_EMPTY		= (1 << 0), /* port empty/probing */
 532	ATA_LPM_HIPM		= (1 << 1), /* may use HIPM */
 533	ATA_LPM_WAKE_ONLY	= (1 << 2), /* only wake up link */
 534};
 535
 536/* forward declarations */
 537struct scsi_device;
 538struct ata_port_operations;
 539struct ata_port;
 540struct ata_link;
 541struct ata_queued_cmd;
 542
 543/* typedefs */
 544typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
 545typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
 546typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
 547			      unsigned long deadline);
 548typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
 549
 550extern struct device_attribute dev_attr_unload_heads;
 551#ifdef CONFIG_SATA_HOST
 552extern struct device_attribute dev_attr_link_power_management_supported;
 553extern struct device_attribute dev_attr_link_power_management_policy;
 554extern struct device_attribute dev_attr_ncq_prio_supported;
 555extern struct device_attribute dev_attr_ncq_prio_enable;
 556extern struct device_attribute dev_attr_em_message_type;
 557extern struct device_attribute dev_attr_em_message;
 558extern struct device_attribute dev_attr_sw_activity;
 559#endif
 560
 561enum sw_activity {
 562	OFF,
 563	BLINK_ON,
 564	BLINK_OFF,
 565};
 566
 567struct ata_taskfile {
 568	unsigned long		flags;		/* ATA_TFLAG_xxx */
 569	u8			protocol;	/* ATA_PROT_xxx */
 570
 571	u8			ctl;		/* control reg */
 572
 573	u8			hob_feature;	/* additional data */
 574	u8			hob_nsect;	/* to support LBA48 */
 575	u8			hob_lbal;
 576	u8			hob_lbam;
 577	u8			hob_lbah;
 578
 579	union {
 580		u8		error;
 581		u8		feature;
 582	};
 583	u8			nsect;
 584	u8			lbal;
 585	u8			lbam;
 586	u8			lbah;
 587
 588	u8			device;
 589
 590	union {
 591		u8		status;
 592		u8		command;
 593	};
 594
 595	u32			auxiliary;	/* auxiliary field */
 596						/* from SATA 3.1 and */
 597						/* ATA-8 ACS-3 */
 598};
 599
 600#ifdef CONFIG_ATA_SFF
 601struct ata_ioports {
 602	void __iomem		*cmd_addr;
 603	void __iomem		*data_addr;
 604	void __iomem		*error_addr;
 605	void __iomem		*feature_addr;
 606	void __iomem		*nsect_addr;
 607	void __iomem		*lbal_addr;
 608	void __iomem		*lbam_addr;
 609	void __iomem		*lbah_addr;
 610	void __iomem		*device_addr;
 611	void __iomem		*status_addr;
 612	void __iomem		*command_addr;
 613	void __iomem		*altstatus_addr;
 614	void __iomem		*ctl_addr;
 615#ifdef CONFIG_ATA_BMDMA
 616	void __iomem		*bmdma_addr;
 617#endif /* CONFIG_ATA_BMDMA */
 618	void __iomem		*scr_addr;
 619};
 620#endif /* CONFIG_ATA_SFF */
 621
 622struct ata_host {
 623	spinlock_t		lock;
 624	struct device 		*dev;
 625	void __iomem * const	*iomap;
 626	unsigned int		n_ports;
 627	unsigned int		n_tags;			/* nr of NCQ tags */
 628	void			*private_data;
 629	struct ata_port_operations *ops;
 630	unsigned long		flags;
 631	struct kref		kref;
 632
 633	struct mutex		eh_mutex;
 634	struct task_struct	*eh_owner;
 635
 636	struct ata_port		*simplex_claimed;	/* channel owning the DMA */
 637	struct ata_port		*ports[];
 638};
 639
 640struct ata_queued_cmd {
 641	struct ata_port		*ap;
 642	struct ata_device	*dev;
 643
 644	struct scsi_cmnd	*scsicmd;
 645	void			(*scsidone)(struct scsi_cmnd *);
 646
 647	struct ata_taskfile	tf;
 648	u8			cdb[ATAPI_CDB_LEN];
 649
 650	unsigned long		flags;		/* ATA_QCFLAG_xxx */
 651	unsigned int		tag;		/* libata core tag */
 652	unsigned int		hw_tag;		/* driver tag */
 653	unsigned int		n_elem;
 654	unsigned int		orig_n_elem;
 655
 656	int			dma_dir;
 657
 658	unsigned int		sect_size;
 659
 660	unsigned int		nbytes;
 661	unsigned int		extrabytes;
 662	unsigned int		curbytes;
 663
 664	struct scatterlist	sgent;
 665
 666	struct scatterlist	*sg;
 667
 668	struct scatterlist	*cursg;
 669	unsigned int		cursg_ofs;
 670
 671	unsigned int		err_mask;
 672	struct ata_taskfile	result_tf;
 673	ata_qc_cb_t		complete_fn;
 674
 675	void			*private_data;
 676	void			*lldd_task;
 677};
 678
 679struct ata_port_stats {
 680	unsigned long		unhandled_irq;
 681	unsigned long		idle_irq;
 682	unsigned long		rw_reqbuf;
 683};
 684
 685struct ata_ering_entry {
 686	unsigned int		eflags;
 687	unsigned int		err_mask;
 688	u64			timestamp;
 689};
 690
 691struct ata_ering {
 692	int			cursor;
 693	struct ata_ering_entry	ring[ATA_ERING_SIZE];
 694};
 695
 696struct ata_cpr {
 697	u8			num;
 698	u8			num_storage_elements;
 699	u64			start_lba;
 700	u64			num_lbas;
 701};
 702
 703struct ata_cpr_log {
 704	u8			nr_cpr;
 705	struct ata_cpr		cpr[] __counted_by(nr_cpr);
 706};
 707
 708struct ata_cdl {
 709	/*
 710	 * Buffer to cache the CDL log page 18h (command duration descriptors)
 711	 * for SCSI-ATA translation.
 712	 */
 713	u8			desc_log_buf[ATA_LOG_CDL_SIZE];
 714
 715	/*
 716	 * Buffer to handle reading the sense data for successful NCQ Commands
 717	 * log page for commands using a CDL with one of the limits policy set
 718	 * to 0xD (successful completion with sense data available bit set).
 719	 */
 720	u8			ncq_sense_log_buf[ATA_LOG_SENSE_NCQ_SIZE];
 721};
 722
 723struct ata_device {
 724	struct ata_link		*link;
 725	unsigned int		devno;		/* 0 or 1 */
 726	unsigned int		quirks;		/* List of broken features */
 727	unsigned long		flags;		/* ATA_DFLAG_xxx */
 728	struct scsi_device	*sdev;		/* attached SCSI device */
 729	void			*private_data;
 730#ifdef CONFIG_ATA_ACPI
 731	union acpi_object	*gtf_cache;
 732	unsigned int		gtf_filter;
 733#endif
 734#ifdef CONFIG_SATA_ZPODD
 735	void			*zpodd;
 736#endif
 737	struct device		tdev;
 738	/* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
 739	u64			n_sectors;	/* size of device, if ATA */
 740	u64			n_native_sectors; /* native size, if ATA */
 741	unsigned int		class;		/* ATA_DEV_xxx */
 742	unsigned long		unpark_deadline;
 743
 744	u8			pio_mode;
 745	u8			dma_mode;
 746	u8			xfer_mode;
 747	unsigned int		xfer_shift;	/* ATA_SHIFT_xxx */
 748
 749	unsigned int		multi_count;	/* sectors count for
 750						   READ/WRITE MULTIPLE */
 751	unsigned int		max_sectors;	/* per-device max sectors */
 752	unsigned int		cdb_len;
 753
 754	/* per-dev xfer mask */
 755	unsigned int		pio_mask;
 756	unsigned int		mwdma_mask;
 757	unsigned int		udma_mask;
 758
 759	/* for CHS addressing */
 760	u16			cylinders;	/* Number of cylinders */
 761	u16			heads;		/* Number of heads */
 762	u16			sectors;	/* Number of sectors per track */
 763
 764	union {
 765		u16		id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
 766		u32		gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
 767	} ____cacheline_aligned;
 768
 769	/* General Purpose Log Directory log page */
 770	u8			gp_log_dir[ATA_SECT_SIZE] ____cacheline_aligned;
 771
 772	/* DEVSLP Timing Variables from Identify Device Data Log */
 773	u8			devslp_timing[ATA_LOG_DEVSLP_SIZE];
 774
 775	/* NCQ send and receive log subcommand support */
 776	u8			ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_SIZE];
 777	u8			ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_SIZE];
 778
 779	/* ZAC zone configuration */
 780	u32			zac_zoned_cap;
 781	u32			zac_zones_optimal_open;
 782	u32			zac_zones_optimal_nonseq;
 783	u32			zac_zones_max_open;
 784
 785	/* Concurrent positioning ranges */
 786	struct ata_cpr_log	*cpr_log;
 787
 788	/* Command Duration Limits support */
 789	struct ata_cdl		*cdl;
 790
 791	/* error history */
 792	int			spdn_cnt;
 793	/* ering is CLEAR_END, read comment above CLEAR_END */
 794	struct ata_ering	ering;
 795
 796	/* For EH */
 797	u8			sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
 798};
 799
 800/* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
 801 * cleared to zero on ata_dev_init().
 802 */
 803#define ATA_DEVICE_CLEAR_BEGIN		offsetof(struct ata_device, n_sectors)
 804#define ATA_DEVICE_CLEAR_END		offsetof(struct ata_device, ering)
 805
 806struct ata_eh_info {
 807	struct ata_device	*dev;		/* offending device */
 808	u32			serror;		/* SError from LLDD */
 809	unsigned int		err_mask;	/* port-wide err_mask */
 810	unsigned int		action;		/* ATA_EH_* action mask */
 811	unsigned int		dev_action[ATA_MAX_DEVICES]; /* dev EH action */
 812	unsigned int		flags;		/* ATA_EHI_* flags */
 813
 814	unsigned int		probe_mask;
 815
 816	char			desc[ATA_EH_DESC_LEN];
 817	int			desc_len;
 818};
 819
 820struct ata_eh_context {
 821	struct ata_eh_info	i;
 822	int			tries[ATA_MAX_DEVICES];
 823	int			cmd_timeout_idx[ATA_MAX_DEVICES]
 824					       [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
 825	unsigned int		classes[ATA_MAX_DEVICES];
 826	unsigned int		did_probe_mask;
 827	unsigned int		unloaded_mask;
 828	unsigned int		saved_ncq_enabled;
 829	u8			saved_xfer_mode[ATA_MAX_DEVICES];
 830	/* timestamp for the last reset attempt or success */
 831	unsigned long		last_reset;
 832};
 833
 834struct ata_acpi_drive
 835{
 836	u32 pio;
 837	u32 dma;
 838} __packed;
 839
 840struct ata_acpi_gtm {
 841	struct ata_acpi_drive drive[2];
 842	u32 flags;
 843} __packed;
 844
 845struct ata_link {
 846	struct ata_port		*ap;
 847	int			pmp;		/* port multiplier port # */
 848
 849	struct device		tdev;
 850	unsigned int		active_tag;	/* active tag on this link */
 851	u32			sactive;	/* active NCQ commands */
 852
 853	unsigned int		flags;		/* ATA_LFLAG_xxx */
 854
 855	u32			saved_scontrol;	/* SControl on probe */
 856	unsigned int		hw_sata_spd_limit;
 857	unsigned int		sata_spd_limit;
 858	unsigned int		sata_spd;	/* current SATA PHY speed */
 859	enum ata_lpm_policy	lpm_policy;
 860
 861	/* record runtime error info, protected by host_set lock */
 862	struct ata_eh_info	eh_info;
 863	/* EH context */
 864	struct ata_eh_context	eh_context;
 865
 866	struct ata_device	device[ATA_MAX_DEVICES];
 867
 868	unsigned long		last_lpm_change; /* when last LPM change happened */
 869};
 870#define ATA_LINK_CLEAR_BEGIN		offsetof(struct ata_link, active_tag)
 871#define ATA_LINK_CLEAR_END		offsetof(struct ata_link, device[0])
 872
 873struct ata_port {
 874	struct Scsi_Host	*scsi_host; /* our co-allocated scsi host */
 875	struct ata_port_operations *ops;
 876	spinlock_t		*lock;
 877	/* Flags owned by the EH context. Only EH should touch these once the
 878	   port is active */
 879	unsigned long		flags;	/* ATA_FLAG_xxx */
 880	/* Flags that change dynamically, protected by ap->lock */
 881	unsigned int		pflags; /* ATA_PFLAG_xxx */
 882	unsigned int		print_id; /* user visible unique port ID */
 883	unsigned int		port_no; /* 0 based port no. inside the host */
 884
 885#ifdef CONFIG_ATA_SFF
 886	struct ata_ioports	ioaddr;	/* ATA cmd/ctl/dma register blocks */
 887	u8			ctl;	/* cache of ATA control register */
 888	u8			last_ctl;	/* Cache last written value */
 889	struct ata_link*	sff_pio_task_link; /* link currently used */
 890	struct delayed_work	sff_pio_task;
 891#ifdef CONFIG_ATA_BMDMA
 892	struct ata_bmdma_prd	*bmdma_prd;	/* BMDMA SG list */
 893	dma_addr_t		bmdma_prd_dma;	/* and its DMA mapping */
 894#endif /* CONFIG_ATA_BMDMA */
 895#endif /* CONFIG_ATA_SFF */
 896
 897	unsigned int		pio_mask;
 898	unsigned int		mwdma_mask;
 899	unsigned int		udma_mask;
 900	unsigned int		cbl;	/* cable type; ATA_CBL_xxx */
 901
 902	struct ata_queued_cmd	qcmd[ATA_MAX_QUEUE + 1];
 903	u64			qc_active;
 904	int			nr_active_links; /* #links with active qcs */
 905
 906	struct work_struct	deferred_qc_work;
 907	struct ata_queued_cmd	*deferred_qc;
 908
 909	struct ata_link		link;		/* host default link */
 910	struct ata_link		*slave_link;	/* see ata_slave_link_init() */
 911
 912	int			nr_pmp_links;	/* nr of available PMP links */
 913	struct ata_link		*pmp_link;	/* array of PMP links */
 914	struct ata_link		*excl_link;	/* for PMP qc exclusion */
 915
 916	struct ata_port_stats	stats;
 917	struct ata_host		*host;
 918	struct device 		*dev;
 919	struct device		tdev;
 920
 921	struct mutex		scsi_scan_mutex;
 922	struct delayed_work	hotplug_task;
 923	struct delayed_work	scsi_rescan_task;
 924
 925	unsigned int		hsm_task_state;
 926
 927	struct list_head	eh_done_q;
 928	wait_queue_head_t	eh_wait_q;
 929	int			eh_tries;
 930	struct completion	park_req_pending;
 931
 932	pm_message_t		pm_mesg;
 933	enum ata_lpm_policy	target_lpm_policy;
 934
 935	struct timer_list	fastdrain_timer;
 936	unsigned int		fastdrain_cnt;
 937
 938	async_cookie_t		cookie;
 939
 940	int			em_message_type;
 941	void			*private_data;
 942
 943#ifdef CONFIG_ATA_ACPI
 944	struct ata_acpi_gtm	__acpi_init_gtm; /* use ata_acpi_init_gtm() */
 945#endif
 946};
 947
 948/* The following initializer overrides a method to NULL whether one of
 949 * its parent has the method defined or not.  This is equivalent to
 950 * ERR_PTR(-ENOENT).  Unfortunately, ERR_PTR doesn't render a constant
 951 * expression and thus can't be used as an initializer.
 952 */
 953#define ATA_OP_NULL		(void *)(unsigned long)(-ENOENT)
 954
 955struct ata_reset_operations {
 956	ata_prereset_fn_t	prereset;
 957	ata_reset_fn_t		softreset;
 958	ata_reset_fn_t		hardreset;
 959	ata_postreset_fn_t	postreset;
 960};
 961
 962struct ata_port_operations {
 963	/*
 964	 * Command execution
 965	 */
 966	int (*qc_defer)(struct ata_queued_cmd *qc);
 967	int (*check_atapi_dma)(struct ata_queued_cmd *qc);
 968	enum ata_completion_errors (*qc_prep)(struct ata_queued_cmd *qc);
 969	unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
 970	void (*qc_fill_rtf)(struct ata_queued_cmd *qc);
 971	void (*qc_ncq_fill_rtf)(struct ata_port *ap, u64 done_mask);
 972
 973	/*
 974	 * Configuration and exception handling
 975	 */
 976	int  (*cable_detect)(struct ata_port *ap);
 977	unsigned int (*mode_filter)(struct ata_device *dev, unsigned int xfer_mask);
 978	void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
 979	void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
 980	int  (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
 981	unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf,
 982				__le16 *id);
 983
 984	void (*dev_config)(struct ata_device *dev);
 985
 986	void (*freeze)(struct ata_port *ap);
 987	void (*thaw)(struct ata_port *ap);
 988	struct ata_reset_operations reset;
 989	struct ata_reset_operations pmp_reset;
 990	void (*error_handler)(struct ata_port *ap);
 991	void (*lost_interrupt)(struct ata_port *ap);
 992	void (*post_internal_cmd)(struct ata_queued_cmd *qc);
 993	void (*sched_eh)(struct ata_port *ap);
 994	void (*end_eh)(struct ata_port *ap);
 995
 996	/*
 997	 * Optional features
 998	 */
 999	int  (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
1000	int  (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
1001	void (*pmp_attach)(struct ata_port *ap);
1002	void (*pmp_detach)(struct ata_port *ap);
1003	int  (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
1004			unsigned hints);
1005
1006	/*
1007	 * Start, stop, suspend and resume
1008	 */
1009	int  (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
1010	int  (*port_resume)(struct ata_port *ap);
1011	int  (*port_start)(struct ata_port *ap);
1012	void (*port_stop)(struct ata_port *ap);
1013	void (*host_stop)(struct ata_host *host);
1014
1015#ifdef CONFIG_ATA_SFF
1016	/*
1017	 * SFF / taskfile oriented ops
1018	 */
1019	void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
1020	void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
1021	u8   (*sff_check_status)(struct ata_port *ap);
1022	u8   (*sff_check_altstatus)(struct ata_port *ap);
1023	void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
1024	void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
1025	void (*sff_exec_command)(struct ata_port *ap,
1026				 const struct ata_taskfile *tf);
1027	unsigned int (*sff_data_xfer)(struct ata_queued_cmd *qc,
1028			unsigned char *buf, unsigned int buflen, int rw);
1029	void (*sff_irq_on)(struct ata_port *);
1030	bool (*sff_irq_check)(struct ata_port *);
1031	void (*sff_irq_clear)(struct ata_port *);
1032	void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
1033
1034#ifdef CONFIG_ATA_BMDMA
1035	void (*bmdma_setup)(struct ata_queued_cmd *qc);
1036	void (*bmdma_start)(struct ata_queued_cmd *qc);
1037	void (*bmdma_stop)(struct ata_queued_cmd *qc);
1038	u8   (*bmdma_status)(struct ata_port *ap);
1039#endif /* CONFIG_ATA_BMDMA */
1040#endif /* CONFIG_ATA_SFF */
1041
1042	ssize_t (*em_show)(struct ata_port *ap, char *buf);
1043	ssize_t (*em_store)(struct ata_port *ap, const char *message,
1044			    size_t size);
1045	ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
1046	ssize_t (*sw_activity_store)(struct ata_device *dev,
1047				     enum sw_activity val);
1048	ssize_t (*transmit_led_message)(struct ata_port *ap, u32 state,
1049					ssize_t size);
1050
1051	/*
1052	 * ->inherits must be the last field and all the preceding
1053	 * fields must be pointers.
1054	 */
1055	const struct ata_port_operations	*inherits;
1056};
1057
1058struct ata_port_info {
1059	unsigned long		flags;
1060	unsigned long		link_flags;
1061	unsigned int		pio_mask;
1062	unsigned int		mwdma_mask;
1063	unsigned int		udma_mask;
1064	struct ata_port_operations *port_ops;
1065	void 			*private_data;
1066};
1067
1068struct ata_timing {
1069	unsigned short mode;		/* ATA mode */
1070	unsigned short setup;		/* t1 */
1071	unsigned short act8b;		/* t2 for 8-bit I/O */
1072	unsigned short rec8b;		/* t2i for 8-bit I/O */
1073	unsigned short cyc8b;		/* t0 for 8-bit I/O */
1074	unsigned short active;		/* t2 or tD */
1075	unsigned short recover;		/* t2i or tK */
1076	unsigned short dmack_hold;	/* tj */
1077	unsigned short cycle;		/* t0 */
1078	unsigned short udma;		/* t2CYCTYP/2 */
1079};
1080
1081/*
1082 * Core layer - drivers/ata/libata-core.c
1083 */
1084extern struct ata_port_operations ata_dummy_port_ops;
1085extern const struct ata_port_info ata_dummy_port_info;
1086
1087static inline bool ata_is_atapi(u8 prot)
1088{
1089	return prot & ATA_PROT_FLAG_ATAPI;
1090}
1091
1092static inline bool ata_is_pio(u8 prot)
1093{
1094	return prot & ATA_PROT_FLAG_PIO;
1095}
1096
1097static inline bool ata_is_dma(u8 prot)
1098{
1099	return prot & ATA_PROT_FLAG_DMA;
1100}
1101
1102static inline bool ata_is_ncq(u8 prot)
1103{
1104	return prot & ATA_PROT_FLAG_NCQ;
1105}
1106
1107static inline bool ata_is_data(u8 prot)
1108{
1109	return prot & (ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA);
1110}
1111
1112static inline int is_multi_taskfile(struct ata_taskfile *tf)
1113{
1114	return (tf->command == ATA_CMD_READ_MULTI) ||
1115	       (tf->command == ATA_CMD_WRITE_MULTI) ||
1116	       (tf->command == ATA_CMD_READ_MULTI_EXT) ||
1117	       (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
1118	       (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
1119}
1120
1121static inline int ata_port_is_dummy(struct ata_port *ap)
1122{
1123	return ap->ops == &ata_dummy_port_ops;
1124}
1125
1126static inline bool ata_port_is_frozen(const struct ata_port *ap)
1127{
1128	return ap->pflags & ATA_PFLAG_FROZEN;
1129}
1130
1131extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
1132extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
1133				int (*check_ready)(struct ata_link *link));
1134extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
1135
1136extern struct ata_host *ata_host_alloc(struct device *dev, int n_ports);
1137extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
1138			const struct ata_port_info * const * ppi, int n_ports);
1139extern void ata_host_get(struct ata_host *host);
1140extern void ata_host_put(struct ata_host *host);
1141extern int ata_host_start(struct ata_host *host);
1142extern int ata_host_register(struct ata_host *host,
1143			     const struct scsi_host_template *sht);
1144extern int ata_host_activate(struct ata_host *host, int irq,
1145			     irq_handler_t irq_handler, unsigned long irq_flags,
1146			     const struct scsi_host_template *sht);
1147extern void ata_host_detach(struct ata_host *host);
1148extern void ata_host_init(struct ata_host *, struct device *, struct ata_port_operations *);
1149extern int ata_scsi_ioctl(struct scsi_device *dev, unsigned int cmd,
1150			  void __user *arg);
1151#ifdef CONFIG_COMPAT
1152#define ATA_SCSI_COMPAT_IOCTL .compat_ioctl = ata_scsi_ioctl,
1153#else
1154#define ATA_SCSI_COMPAT_IOCTL /* empty */
1155#endif
1156extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
1157#if IS_REACHABLE(CONFIG_ATA)
1158bool ata_scsi_dma_need_drain(struct request *rq);
1159#else
1160#define ata_scsi_dma_need_drain NULL
1161#endif
1162extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
1163			    unsigned int cmd, void __user *arg);
1164extern bool ata_link_online(struct ata_link *link);
1165extern bool ata_link_offline(struct ata_link *link);
1166#ifdef CONFIG_PM
1167extern void ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1168extern void ata_host_resume(struct ata_host *host);
1169extern void ata_sas_port_suspend(struct ata_port *ap);
1170extern void ata_sas_port_resume(struct ata_port *ap);
1171#else
1172static inline void ata_sas_port_suspend(struct ata_port *ap)
1173{
1174}
1175static inline void ata_sas_port_resume(struct ata_port *ap)
1176{
1177}
1178#endif
1179extern int ata_ratelimit(void);
1180extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1181extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1182			     u32 val, unsigned int interval, unsigned int timeout);
1183extern int atapi_cmd_type(u8 opcode);
1184extern unsigned int ata_pack_xfermask(unsigned int pio_mask,
1185				      unsigned int mwdma_mask,
1186				      unsigned int udma_mask);
1187extern void ata_unpack_xfermask(unsigned int xfer_mask,
1188				unsigned int *pio_mask,
1189				unsigned int *mwdma_mask,
1190				unsigned int *udma_mask);
1191extern u8 ata_xfer_mask2mode(unsigned int xfer_mask);
1192extern unsigned int ata_xfer_mode2mask(u8 xfer_mode);
1193extern int ata_xfer_mode2shift(u8 xfer_mode);
1194extern const char *ata_mode_string(unsigned int xfer_mask);
1195extern unsigned int ata_id_xfermask(const u16 *id);
1196extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
1197extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1198		 unsigned int n_elem);
1199extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
1200extern unsigned int ata_port_classify(struct ata_port *ap,
1201				      const struct ata_taskfile *tf);
1202extern void ata_dev_disable(struct ata_device *adev);
1203extern void ata_id_string(const u16 *id, unsigned char *s,
1204			  unsigned int ofs, unsigned int len);
1205extern void ata_id_c_string(const u16 *id, unsigned char *s,
1206			    unsigned int ofs, unsigned int len);
1207extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1208				       struct ata_taskfile *tf, __le16 *id);
1209extern void ata_qc_complete(struct ata_queued_cmd *qc);
1210extern u64 ata_qc_get_active(struct ata_port *ap);
1211extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
1212extern int ata_std_bios_param(struct scsi_device *sdev,
1213			      struct gendisk *unused,
1214			      sector_t capacity, int geom[]);
1215extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
1216extern int ata_scsi_sdev_init(struct scsi_device *sdev);
1217int ata_scsi_sdev_configure(struct scsi_device *sdev, struct queue_limits *lim);
1218extern void ata_scsi_sdev_destroy(struct scsi_device *sdev);
1219extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1220				       int queue_depth);
1221extern int ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1222				  int queue_depth);
1223extern int ata_ncq_prio_supported(struct ata_port *ap, struct scsi_device *sdev,
1224				  bool *supported);
1225extern int ata_ncq_prio_enabled(struct ata_port *ap, struct scsi_device *sdev,
1226				bool *enabled);
1227extern int ata_ncq_prio_enable(struct ata_port *ap, struct scsi_device *sdev,
1228			       bool enable);
1229extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1230int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1231extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1232extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
1233
1234/*
1235 * SATA specific code - drivers/ata/libata-sata.c
1236 */
1237#ifdef CONFIG_SATA_HOST
1238extern const unsigned int sata_deb_timing_normal[];
1239extern const unsigned int sata_deb_timing_hotplug[];
1240extern const unsigned int sata_deb_timing_long[];
1241
1242static inline const unsigned int *
1243sata_ehc_deb_timing(struct ata_eh_context *ehc)
1244{
1245	if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
1246		return sata_deb_timing_hotplug;
1247	else
1248		return sata_deb_timing_normal;
1249}
1250
1251extern int sata_scr_valid(struct ata_link *link);
1252extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
1253extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
1254extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
1255extern int sata_set_spd(struct ata_link *link);
1256int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1257		       unsigned long deadline);
1258extern int sata_link_hardreset(struct ata_link *link,
1259			const unsigned int *timing, unsigned long deadline,
1260			bool *online, int (*check_ready)(struct ata_link *));
1261extern int sata_link_resume(struct ata_link *link, const unsigned int *params,
1262			    unsigned long deadline);
1263extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1264#else
1265static inline const unsigned int *
1266sata_ehc_deb_timing(struct ata_eh_context *ehc)
1267{
1268	return NULL;
1269}
1270static inline int sata_scr_valid(struct ata_link *link) { return 0; }
1271static inline int sata_scr_read(struct ata_link *link, int reg, u32 *val)
1272{
1273	return -EOPNOTSUPP;
1274}
1275static inline int sata_scr_write(struct ata_link *link, int reg, u32 val)
1276{
1277	return -EOPNOTSUPP;
1278}
1279static inline int sata_scr_write_flush(struct ata_link *link, int reg, u32 val)
1280{
1281	return -EOPNOTSUPP;
1282}
1283static inline int sata_set_spd(struct ata_link *link) { return -EOPNOTSUPP; }
1284static inline int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1285				     unsigned long deadline)
1286{
1287	return -EOPNOTSUPP;
1288}
1289static inline int sata_link_hardreset(struct ata_link *link,
1290				      const unsigned int *timing,
1291				      unsigned long deadline,
1292				      bool *online,
1293				      int (*check_ready)(struct ata_link *))
1294{
1295	if (online)
1296		*online = false;
1297	return -EOPNOTSUPP;
1298}
1299static inline int sata_link_resume(struct ata_link *link,
1300				   const unsigned int *params,
1301				   unsigned long deadline)
1302{
1303	return -EOPNOTSUPP;
1304}
1305static inline void ata_eh_analyze_ncq_error(struct ata_link *link) { }
1306#endif
1307extern int sata_link_debounce(struct ata_link *link,
1308			      const unsigned int *params, unsigned long deadline);
1309extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
1310			     bool spm_wakeup);
1311extern int ata_slave_link_init(struct ata_port *ap);
1312extern void ata_port_probe(struct ata_port *ap);
1313extern struct ata_port *ata_port_alloc(struct ata_host *host);
1314extern void ata_port_free(struct ata_port *ap);
1315extern int ata_tport_add(struct device *parent, struct ata_port *ap);
1316extern void ata_tport_delete(struct ata_port *ap);
1317int ata_sas_sdev_configure(struct scsi_device *sdev, struct queue_limits *lim,
1318			   struct ata_port *ap);
1319extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
1320extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1321			  u8 pmp, int is_cmd, u8 *fis);
1322extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1323extern int ata_qc_complete_multiple(struct ata_port *ap, u64 qc_active);
1324extern bool sata_lpm_ignore_phy_events(struct ata_link *link);
1325extern int sata_async_notification(struct ata_port *ap);
1326
1327extern int ata_cable_40wire(struct ata_port *ap);
1328extern int ata_cable_80wire(struct ata_port *ap);
1329extern int ata_cable_sata(struct ata_port *ap);
1330extern int ata_cable_ignore(struct ata_port *ap);
1331extern int ata_cable_unknown(struct ata_port *ap);
1332
1333/* Timing helpers */
1334extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1335extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1336
1337/* PCI */
1338#ifdef CONFIG_PCI
1339struct pci_dev;
1340
1341struct pci_bits {
1342	unsigned int		reg;	/* PCI config register to read */
1343	unsigned int		width;	/* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1344	unsigned long		mask;
1345	unsigned long		val;
1346};
1347
1348extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1349extern void ata_pci_shutdown_one(struct pci_dev *pdev);
1350extern void ata_pci_remove_one(struct pci_dev *pdev);
1351
1352#ifdef CONFIG_PM
1353extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1354extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1355extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1356extern int ata_pci_device_resume(struct pci_dev *pdev);
1357#endif /* CONFIG_PM */
1358#endif /* CONFIG_PCI */
1359
1360struct platform_device;
1361
1362extern void ata_platform_remove_one(struct platform_device *pdev);
1363
1364/*
1365 * ACPI - drivers/ata/libata-acpi.c
1366 */
1367#ifdef CONFIG_ATA_ACPI
1368static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1369{
1370	if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1371		return &ap->__acpi_init_gtm;
1372	return NULL;
1373}
1374int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1375int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1376unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1377				   const struct ata_acpi_gtm *gtm);
1378int ata_acpi_cbl_pata_type(struct ata_port *ap);
1379#else
1380static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1381{
1382	return NULL;
1383}
1384
1385static inline int ata_acpi_stm(const struct ata_port *ap,
1386			       struct ata_acpi_gtm *stm)
1387{
1388	return -ENOSYS;
1389}
1390
1391static inline int ata_acpi_gtm(const struct ata_port *ap,
1392			       struct ata_acpi_gtm *stm)
1393{
1394	return -ENOSYS;
1395}
1396
1397static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1398					const struct ata_acpi_gtm *gtm)
1399{
1400	return 0;
1401}
1402
1403static inline int ata_acpi_cbl_pata_type(struct ata_port *ap)
1404{
1405	return ATA_CBL_PATA40;
1406}
1407#endif
1408
1409/*
1410 * EH - drivers/ata/libata-eh.c
1411 */
1412extern void ata_port_schedule_eh(struct ata_port *ap);
1413extern void ata_port_wait_eh(struct ata_port *ap);
1414extern int ata_link_abort(struct ata_link *link);
1415extern int ata_port_abort(struct ata_port *ap);
1416extern int ata_port_freeze(struct ata_port *ap);
1417
1418extern void ata_eh_freeze_port(struct ata_port *ap);
1419extern void ata_eh_thaw_port(struct ata_port *ap);
1420
1421extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1422extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1423
1424extern void ata_std_error_handler(struct ata_port *ap);
1425extern void ata_std_sched_eh(struct ata_port *ap);
1426extern void ata_std_end_eh(struct ata_port *ap);
1427extern int ata_link_nr_enabled(struct ata_link *link);
1428
1429/*
1430 * Base operations to inherit from and initializers for sht
1431 *
1432 * Operations
1433 *
1434 * base  : Common to all libata drivers.
1435 * sata  : SATA controllers w/ native interface.
1436 * pmp   : SATA controllers w/ PMP support.
1437 * sff   : SFF ATA controllers w/o BMDMA support.
1438 * bmdma : SFF ATA controllers w/ BMDMA support.
1439 *
1440 * sht initializers
1441 *
1442 * BASE  : Common to all libata drivers.  The user must set
1443 *	   sg_tablesize and dma_boundary.
1444 * PIO   : SFF ATA controllers w/ only PIO support.
1445 * BMDMA : SFF ATA controllers w/ BMDMA support.  sg_tablesize and
1446 *	   dma_boundary are set to BMDMA limits.
1447 * NCQ   : SATA controllers supporting NCQ.  The user must set
1448 *	   sg_tablesize, dma_boundary and can_queue.
1449 */
1450extern const struct ata_port_operations ata_base_port_ops;
1451extern const struct ata_port_operations sata_port_ops;
1452extern const struct attribute_group *ata_common_sdev_groups[];
1453
1454/*
1455 * All sht initializers (BASE, PIO, BMDMA, NCQ) must be instantiated
1456 * by the edge drivers.  Because the 'module' field of sht must be the
1457 * edge driver's module reference, otherwise the driver can be unloaded
1458 * even if the scsi_device is being accessed.
1459 */
1460#define __ATA_BASE_SHT(drv_name)				\
1461	.module			= THIS_MODULE,			\
1462	.name			= drv_name,			\
1463	.ioctl			= ata_scsi_ioctl,		\
1464	ATA_SCSI_COMPAT_IOCTL					\
1465	.queuecommand		= ata_scsi_queuecmd,		\
1466	.dma_need_drain		= ata_scsi_dma_need_drain,	\
1467	.this_id		= ATA_SHT_THIS_ID,		\
1468	.emulated		= ATA_SHT_EMULATED,		\
1469	.proc_name		= drv_name,			\
1470	.sdev_init		= ata_scsi_sdev_init,		\
1471	.sdev_destroy		= ata_scsi_sdev_destroy,	\
1472	.bios_param		= ata_std_bios_param,		\
1473	.unlock_native_capacity	= ata_scsi_unlock_native_capacity,\
1474	.max_sectors		= ATA_MAX_SECTORS_LBA48
1475
1476#define ATA_SUBBASE_SHT(drv_name)				\
1477	__ATA_BASE_SHT(drv_name),				\
1478	.can_queue		= ATA_DEF_QUEUE,		\
1479	.tag_alloc_policy_rr	= true,				\
1480	.sdev_configure		= ata_scsi_sdev_configure
1481
1482#define ATA_SUBBASE_SHT_QD(drv_name, drv_qd)			\
1483	__ATA_BASE_SHT(drv_name),				\
1484	.can_queue		= drv_qd,			\
1485	.tag_alloc_policy_rr	= true,				\
1486	.sdev_configure		= ata_scsi_sdev_configure
1487
1488#define ATA_BASE_SHT(drv_name)					\
1489	ATA_SUBBASE_SHT(drv_name),				\
1490	.sdev_groups		= ata_common_sdev_groups
1491
1492#ifdef CONFIG_SATA_HOST
1493extern const struct attribute_group *ata_ncq_sdev_groups[];
1494
1495#define ATA_NCQ_SHT(drv_name)					\
1496	ATA_SUBBASE_SHT(drv_name),				\
1497	.sdev_groups		= ata_ncq_sdev_groups,		\
1498	.change_queue_depth	= ata_scsi_change_queue_depth
1499
1500#define ATA_NCQ_SHT_QD(drv_name, drv_qd)			\
1501	ATA_SUBBASE_SHT_QD(drv_name, drv_qd),			\
1502	.sdev_groups		= ata_ncq_sdev_groups,		\
1503	.change_queue_depth	= ata_scsi_change_queue_depth
1504#endif
1505
1506/*
1507 * PMP helpers
1508 */
1509#ifdef CONFIG_SATA_PMP
1510static inline bool sata_pmp_supported(struct ata_port *ap)
1511{
1512	return ap->flags & ATA_FLAG_PMP;
1513}
1514
1515static inline bool sata_pmp_attached(struct ata_port *ap)
1516{
1517	return ap->nr_pmp_links != 0;
1518}
1519
1520static inline bool ata_is_host_link(const struct ata_link *link)
1521{
1522	return link == &link->ap->link || link == link->ap->slave_link;
1523}
1524#else /* CONFIG_SATA_PMP */
1525static inline bool sata_pmp_supported(struct ata_port *ap)
1526{
1527	return false;
1528}
1529
1530static inline bool sata_pmp_attached(struct ata_port *ap)
1531{
1532	return false;
1533}
1534
1535static inline bool ata_is_host_link(const struct ata_link *link)
1536{
1537	return true;
1538}
1539#endif /* CONFIG_SATA_PMP */
1540
1541static inline int sata_srst_pmp(struct ata_link *link)
1542{
1543	if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1544		return SATA_PMP_CTRL_PORT;
1545	return link->pmp;
1546}
1547
1548#define ata_port_printk(level, ap, fmt, ...)			\
1549	pr_ ## level ("ata%u: " fmt, (ap)->print_id, ##__VA_ARGS__)
1550
1551#define ata_port_err(ap, fmt, ...)				\
1552	ata_port_printk(err, ap, fmt, ##__VA_ARGS__)
1553#define ata_port_warn(ap, fmt, ...)				\
1554	ata_port_printk(warn, ap, fmt, ##__VA_ARGS__)
1555#define ata_port_notice(ap, fmt, ...)				\
1556	ata_port_printk(notice, ap, fmt, ##__VA_ARGS__)
1557#define ata_port_info(ap, fmt, ...)				\
1558	ata_port_printk(info, ap, fmt, ##__VA_ARGS__)
1559#define ata_port_dbg(ap, fmt, ...)				\
1560	ata_port_printk(debug, ap, fmt, ##__VA_ARGS__)
1561
1562#define ata_link_printk(level, link, fmt, ...)			\
1563do {								\
1564	if (sata_pmp_attached((link)->ap) ||			\
1565	    (link)->ap->slave_link)				\
1566		pr_ ## level ("ata%u.%02u: " fmt,		\
1567			      (link)->ap->print_id,		\
1568			      (link)->pmp,			\
1569			      ##__VA_ARGS__);			\
1570        else							\
1571		pr_ ## level ("ata%u: " fmt,			\
1572			      (link)->ap->print_id,		\
1573			      ##__VA_ARGS__);			\
1574} while (0)
1575
1576#define ata_link_err(link, fmt, ...)				\
1577	ata_link_printk(err, link, fmt, ##__VA_ARGS__)
1578#define ata_link_warn(link, fmt, ...)				\
1579	ata_link_printk(warn, link, fmt, ##__VA_ARGS__)
1580#define ata_link_notice(link, fmt, ...)				\
1581	ata_link_printk(notice, link, fmt, ##__VA_ARGS__)
1582#define ata_link_info(link, fmt, ...)				\
1583	ata_link_printk(info, link, fmt, ##__VA_ARGS__)
1584#define ata_link_dbg(link, fmt, ...)				\
1585	ata_link_printk(debug, link, fmt, ##__VA_ARGS__)
1586
1587#define ata_dev_printk(level, dev, fmt, ...)			\
1588        pr_ ## level("ata%u.%02u: " fmt,			\
1589               (dev)->link->ap->print_id,			\
1590	       (dev)->link->pmp + (dev)->devno,			\
1591	       ##__VA_ARGS__)
1592
1593#define ata_dev_err(dev, fmt, ...)				\
1594	ata_dev_printk(err, dev, fmt, ##__VA_ARGS__)
1595#define ata_dev_warn(dev, fmt, ...)				\
1596	ata_dev_printk(warn, dev, fmt, ##__VA_ARGS__)
1597#define ata_dev_notice(dev, fmt, ...)				\
1598	ata_dev_printk(notice, dev, fmt, ##__VA_ARGS__)
1599#define ata_dev_info(dev, fmt, ...)				\
1600	ata_dev_printk(info, dev, fmt, ##__VA_ARGS__)
1601#define ata_dev_dbg(dev, fmt, ...)				\
1602	ata_dev_printk(debug, dev, fmt, ##__VA_ARGS__)
1603
1604#define ata_dev_warn_once(dev, fmt, ...)			\
1605	pr_warn_once("ata%u.%02u: " fmt,			\
1606		     (dev)->link->ap->print_id,			\
1607		     (dev)->link->pmp + (dev)->devno,		\
1608		     ##__VA_ARGS__)
1609
1610static inline void ata_print_version_once(const struct device *dev,
1611					  const char *version)
1612{
1613	dev_dbg_once(dev, "version %s\n", version);
1614}
1615
1616/*
1617 * ata_eh_info helpers
1618 */
1619extern __printf(2, 3)
1620void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1621extern __printf(2, 3)
1622void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1623extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1624
1625static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1626{
1627	ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1628	ehi->flags |= ATA_EHI_HOTPLUGGED;
1629	ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1630	ehi->err_mask |= AC_ERR_ATA_BUS;
1631}
1632
1633/*
1634 * port description helpers
1635 */
1636extern __printf(2, 3)
1637void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
1638#ifdef CONFIG_PCI
1639extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1640			       const char *name);
1641#endif
1642static inline void ata_port_desc_misc(struct ata_port *ap, int irq)
1643{
1644	ata_port_desc(ap, "irq %d", irq);
1645	ata_port_desc(ap, "lpm-pol %d", ap->target_lpm_policy);
1646	if (ap->pflags & ATA_PFLAG_EXTERNAL)
1647		ata_port_desc(ap, "ext");
1648}
1649
1650static inline bool ata_tag_internal(unsigned int tag)
1651{
1652	return tag == ATA_TAG_INTERNAL;
1653}
1654
1655static inline bool ata_tag_valid(unsigned int tag)
1656{
1657	return tag < ATA_MAX_QUEUE || ata_tag_internal(tag);
1658}
1659
1660#define __ata_qc_for_each(ap, qc, tag, max_tag, fn)		\
1661	for ((tag) = 0; (tag) < (max_tag) &&			\
1662	     ({ qc = fn((ap), (tag)); 1; }); (tag)++)		\
1663
1664/*
1665 * Internal use only, iterate commands ignoring error handling and
1666 * status of 'qc'.
1667 */
1668#define ata_qc_for_each_raw(ap, qc, tag)					\
1669	__ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, __ata_qc_from_tag)
1670
1671/*
1672 * Iterate all potential commands that can be queued
1673 */
1674#define ata_qc_for_each(ap, qc, tag)					\
1675	__ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, ata_qc_from_tag)
1676
1677/*
1678 * Like ata_qc_for_each, but with the internal tag included
1679 */
1680#define ata_qc_for_each_with_internal(ap, qc, tag)			\
1681	__ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE + 1, ata_qc_from_tag)
1682
1683/*
1684 * device helpers
1685 */
1686static inline unsigned int ata_class_enabled(unsigned int class)
1687{
1688	return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1689		class == ATA_DEV_PMP || class == ATA_DEV_SEMB ||
1690		class == ATA_DEV_ZAC;
1691}
1692
1693static inline unsigned int ata_class_disabled(unsigned int class)
1694{
1695	return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1696		class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP ||
1697		class == ATA_DEV_ZAC_UNSUP;
1698}
1699
1700static inline unsigned int ata_class_absent(unsigned int class)
1701{
1702	return !ata_class_enabled(class) && !ata_class_disabled(class);
1703}
1704
1705static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1706{
1707	return ata_class_enabled(dev->class);
1708}
1709
1710static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1711{
1712	return ata_class_disabled(dev->class);
1713}
1714
1715static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1716{
1717	return ata_class_absent(dev->class);
1718}
1719
1720/*
1721 * link helpers
1722 */
1723static inline int ata_link_max_devices(const struct ata_link *link)
1724{
1725	if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1726		return 2;
1727	return 1;
1728}
1729
1730static inline int ata_link_active(struct ata_link *link)
1731{
1732	return ata_tag_valid(link->active_tag) || link->sactive;
1733}
1734
1735/*
1736 * Iterators
1737 *
1738 * ATA_LITER_* constants are used to select link iteration mode and
1739 * ATA_DITER_* device iteration mode.
1740 *
1741 * For a custom iteration directly using ata_{link|dev}_next(), if
1742 * @link or @dev, respectively, is NULL, the first element is
1743 * returned.  @dev and @link can be any valid device or link and the
1744 * next element according to the iteration mode will be returned.
1745 * After the last element, NULL is returned.
1746 */
1747enum ata_link_iter_mode {
1748	ATA_LITER_EDGE,		/* if present, PMP links only; otherwise,
1749				 * host link.  no slave link */
1750	ATA_LITER_HOST_FIRST,	/* host link followed by PMP or slave links */
1751	ATA_LITER_PMP_FIRST,	/* PMP links followed by host link,
1752				 * slave link still comes after host link */
1753};
1754
1755enum ata_dev_iter_mode {
1756	ATA_DITER_ENABLED,
1757	ATA_DITER_ENABLED_REVERSE,
1758	ATA_DITER_ALL,
1759	ATA_DITER_ALL_REVERSE,
1760};
1761
1762extern struct ata_link *ata_link_next(struct ata_link *link,
1763				      struct ata_port *ap,
1764				      enum ata_link_iter_mode mode);
1765
1766extern struct ata_device *ata_dev_next(struct ata_device *dev,
1767				       struct ata_link *link,
1768				       enum ata_dev_iter_mode mode);
1769
1770/*
1771 * Shortcut notation for iterations
1772 *
1773 * ata_for_each_link() iterates over each link of @ap according to
1774 * @mode.  @link points to the current link in the loop.  @link is
1775 * NULL after loop termination.  ata_for_each_dev() works the same way
1776 * except that it iterates over each device of @link.
1777 *
1778 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1779 * specified when using the following shorthand notations.  Only the
1780 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1781 * specified.  This not only increases brevity but also makes it
1782 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1783 */
1784#define ata_for_each_link(link, ap, mode) \
1785	for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1786	     (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1787
1788#define ata_for_each_dev(dev, link, mode) \
1789	for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1790	     (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1791
1792/**
1793 *	ata_ncq_supported - Test whether NCQ is supported
1794 *	@dev: ATA device to test
1795 *
1796 *	LOCKING:
1797 *	spin_lock_irqsave(host lock)
1798 *
1799 *	RETURNS:
1800 *	true if @dev supports NCQ, false otherwise.
1801 */
1802static inline bool ata_ncq_supported(struct ata_device *dev)
1803{
1804	if (!IS_ENABLED(CONFIG_SATA_HOST))
1805		return false;
1806	return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1807}
1808
1809/**
1810 *	ata_ncq_enabled - Test whether NCQ is enabled
1811 *	@dev: ATA device to test
1812 *
1813 *	LOCKING:
1814 *	spin_lock_irqsave(host lock)
1815 *
1816 *	RETURNS:
1817 *	true if NCQ is enabled for @dev, false otherwise.
1818 */
1819static inline bool ata_ncq_enabled(struct ata_device *dev)
1820{
1821	return ata_ncq_supported(dev) && !(dev->flags & ATA_DFLAG_NCQ_OFF);
1822}
1823
1824static inline bool ata_fpdma_dsm_supported(struct ata_device *dev)
1825{
1826	return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1827		(dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &
1828		 ATA_LOG_NCQ_SEND_RECV_DSM_TRIM);
1829}
1830
1831static inline bool ata_fpdma_read_log_supported(struct ata_device *dev)
1832{
1833	return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1834		(dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET] &
1835		 ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED);
1836}
1837
1838static inline bool ata_fpdma_zac_mgmt_in_supported(struct ata_device *dev)
1839{
1840	return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1841		(dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OFFSET] &
1842		ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED);
1843}
1844
1845static inline bool ata_fpdma_zac_mgmt_out_supported(struct ata_device *dev)
1846{
1847	return (dev->ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET] &
1848		ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT);
1849}
1850
1851static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1852{
1853	qc->tf.ctl |= ATA_NIEN;
1854}
1855
1856static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1857						       unsigned int tag)
1858{
1859	if (ata_tag_valid(tag))
1860		return &ap->qcmd[tag];
1861	return NULL;
1862}
1863
1864static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1865						     unsigned int tag)
1866{
1867	struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1868
1869	if (unlikely(!qc))
1870		return qc;
1871
1872	if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1873			  ATA_QCFLAG_EH)) == ATA_QCFLAG_ACTIVE)
1874		return qc;
1875
1876	return NULL;
1877}
1878
1879static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1880{
1881	return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1882}
1883
1884static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1885{
1886	memset(tf, 0, sizeof(*tf));
1887
1888#ifdef CONFIG_ATA_SFF
1889	tf->ctl = dev->link->ap->ctl;
1890#else
1891	tf->ctl = ATA_DEVCTL_OBS;
1892#endif
1893	if (dev->devno == 0)
1894		tf->device = ATA_DEVICE_OBS;
1895	else
1896		tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1897}
1898
1899static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1900{
1901	qc->dma_dir = DMA_NONE;
1902	qc->sg = NULL;
1903	qc->flags = 0;
1904	qc->cursg = NULL;
1905	qc->cursg_ofs = 0;
1906	qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1907	qc->n_elem = 0;
1908	qc->err_mask = 0;
1909	qc->sect_size = ATA_SECT_SIZE;
1910
1911	ata_tf_init(qc->dev, &qc->tf);
1912
1913	/* init result_tf such that it indicates normal completion */
1914	qc->result_tf.command = ATA_DRDY;
1915	qc->result_tf.feature = 0;
1916}
1917
1918static inline int ata_try_flush_cache(const struct ata_device *dev)
1919{
1920	return ata_id_wcache_enabled(dev->id) ||
1921	       ata_id_has_flush(dev->id) ||
1922	       ata_id_has_flush_ext(dev->id);
1923}
1924
1925static inline unsigned int ac_err_mask(u8 status)
1926{
1927	if (status & (ATA_BUSY | ATA_DRQ))
1928		return AC_ERR_HSM;
1929	if (status & (ATA_ERR | ATA_DF))
1930		return AC_ERR_DEV;
1931	return 0;
1932}
1933
1934static inline unsigned int __ac_err_mask(u8 status)
1935{
1936	unsigned int mask = ac_err_mask(status);
1937	if (mask == 0)
1938		return AC_ERR_OTHER;
1939	return mask;
1940}
1941
1942static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1943{
1944	return *(struct ata_port **)&host->hostdata[0];
1945}
1946
1947static inline int ata_check_ready(u8 status)
1948{
1949	if (!(status & ATA_BUSY))
1950		return 1;
1951
1952	/* 0xff indicates either no device or device not ready */
1953	if (status == 0xff)
1954		return -ENODEV;
1955
1956	return 0;
1957}
1958
1959static inline unsigned long ata_deadline(unsigned long from_jiffies,
1960					 unsigned int timeout_msecs)
1961{
1962	return from_jiffies + msecs_to_jiffies(timeout_msecs);
1963}
1964
1965/* Don't open code these in drivers as there are traps. Firstly the range may
1966   change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1967   > UDMA_0. Dyma ddreigiau */
1968
1969static inline bool ata_using_mwdma(struct ata_device *adev)
1970{
1971	return adev->dma_mode >= XFER_MW_DMA_0 &&
1972		adev->dma_mode <= XFER_MW_DMA_4;
1973}
1974
1975static inline bool ata_using_udma(struct ata_device *adev)
1976{
1977	return adev->dma_mode >= XFER_UDMA_0 &&
1978		adev->dma_mode <= XFER_UDMA_7;
1979}
1980
1981static inline bool ata_dma_enabled(struct ata_device *adev)
1982{
1983	return adev->dma_mode != 0xFF;
1984}
1985
1986/**************************************************************************
1987 * PATA timings - drivers/ata/libata-pata-timings.c
1988 */
1989extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1990extern int ata_timing_compute(struct ata_device *, unsigned short,
1991			      struct ata_timing *, int, int);
1992extern void ata_timing_merge(const struct ata_timing *,
1993			     const struct ata_timing *, struct ata_timing *,
1994			     unsigned int);
1995
1996/**************************************************************************
1997 * PMP - drivers/ata/libata-pmp.c
1998 */
1999#ifdef CONFIG_SATA_PMP
2000
2001extern const struct ata_port_operations sata_pmp_port_ops;
2002
2003extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
2004extern void sata_pmp_error_handler(struct ata_port *ap);
2005
2006#else /* CONFIG_SATA_PMP */
2007
2008#define sata_pmp_port_ops		sata_port_ops
2009#define sata_pmp_qc_defer_cmd_switch	ata_std_qc_defer
2010#define sata_pmp_error_handler		ata_std_error_handler
2011
2012#endif /* CONFIG_SATA_PMP */
2013
2014
2015/**************************************************************************
2016 * SFF - drivers/ata/libata-sff.c
2017 */
2018#ifdef CONFIG_ATA_SFF
2019
2020extern const struct ata_port_operations ata_sff_port_ops;
2021extern const struct ata_port_operations ata_bmdma32_port_ops;
2022
2023/* PIO only, sg_tablesize and dma_boundary limits can be removed */
2024#define ATA_PIO_SHT(drv_name)					\
2025	ATA_BASE_SHT(drv_name),					\
2026	.sg_tablesize		= LIBATA_MAX_PRD,		\
2027	.dma_boundary		= ATA_DMA_BOUNDARY
2028
2029extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
2030extern u8 ata_sff_check_status(struct ata_port *ap);
2031extern void ata_sff_pause(struct ata_port *ap);
2032extern void ata_sff_dma_pause(struct ata_port *ap);
2033extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
2034extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
2035extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
2036extern void ata_sff_exec_command(struct ata_port *ap,
2037				 const struct ata_taskfile *tf);
2038extern unsigned int ata_sff_data_xfer(struct ata_queued_cmd *qc,
2039			unsigned char *buf, unsigned int buflen, int rw);
2040extern unsigned int ata_sff_data_xfer32(struct ata_queued_cmd *qc,
2041			unsigned char *buf, unsigned int buflen, int rw);
2042extern void ata_sff_irq_on(struct ata_port *ap);
2043extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
2044			    u8 status, int in_wq);
2045extern void ata_sff_queue_work(struct work_struct *work);
2046extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
2047		unsigned long delay);
2048extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
2049extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
2050extern void ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
2051extern unsigned int ata_sff_port_intr(struct ata_port *ap,
2052				      struct ata_queued_cmd *qc);
2053extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
2054extern void ata_sff_lost_interrupt(struct ata_port *ap);
2055extern void ata_sff_freeze(struct ata_port *ap);
2056extern void ata_sff_thaw(struct ata_port *ap);
2057extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
2058extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
2059					  u8 *r_err);
2060extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
2061				    unsigned long deadline);
2062extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
2063			     unsigned long deadline);
2064extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
2065			       unsigned long deadline);
2066extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
2067extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
2068extern void ata_sff_error_handler(struct ata_port *ap);
2069extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
2070#ifdef CONFIG_PCI
2071extern int ata_pci_sff_init_host(struct ata_host *host);
2072extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
2073				    const struct ata_port_info * const * ppi,
2074				    struct ata_host **r_host);
2075extern int ata_pci_sff_activate_host(struct ata_host *host,
2076				     irq_handler_t irq_handler,
2077				     const struct scsi_host_template *sht);
2078extern int ata_pci_sff_init_one(struct pci_dev *pdev,
2079		const struct ata_port_info * const * ppi,
2080		const struct scsi_host_template *sht, void *host_priv, int hflags);
2081#endif /* CONFIG_PCI */
2082
2083#ifdef CONFIG_ATA_BMDMA
2084
2085extern const struct ata_port_operations ata_bmdma_port_ops;
2086
2087#define ATA_BMDMA_SHT(drv_name)					\
2088	ATA_BASE_SHT(drv_name),					\
2089	.sg_tablesize		= LIBATA_MAX_PRD,		\
2090	.dma_boundary		= ATA_DMA_BOUNDARY
2091
2092extern enum ata_completion_errors ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
2093extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
2094extern enum ata_completion_errors ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
2095extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
2096				      struct ata_queued_cmd *qc);
2097extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
2098extern void ata_bmdma_error_handler(struct ata_port *ap);
2099extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
2100extern void ata_bmdma_irq_clear(struct ata_port *ap);
2101extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
2102extern void ata_bmdma_start(struct ata_queued_cmd *qc);
2103extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
2104extern u8 ata_bmdma_status(struct ata_port *ap);
2105extern int ata_bmdma_port_start(struct ata_port *ap);
2106extern int ata_bmdma_port_start32(struct ata_port *ap);
2107
2108#ifdef CONFIG_PCI
2109extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
2110extern void ata_pci_bmdma_init(struct ata_host *host);
2111extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
2112				      const struct ata_port_info * const * ppi,
2113				      struct ata_host **r_host);
2114extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
2115				  const struct ata_port_info * const * ppi,
2116				  const struct scsi_host_template *sht,
2117				  void *host_priv, int hflags);
2118#endif /* CONFIG_PCI */
2119#endif /* CONFIG_ATA_BMDMA */
2120
2121/**
2122 *	ata_sff_busy_wait - Wait for a port status register
2123 *	@ap: Port to wait for.
2124 *	@bits: bits that must be clear
2125 *	@max: number of 10uS waits to perform
2126 *
2127 *	Waits up to max*10 microseconds for the selected bits in the port's
2128 *	status register to be cleared.
2129 *	Returns final value of status register.
2130 *
2131 *	LOCKING:
2132 *	Inherited from caller.
2133 */
2134static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
2135				   unsigned int max)
2136{
2137	u8 status;
2138
2139	do {
2140		udelay(10);
2141		status = ap->ops->sff_check_status(ap);
2142		max--;
2143	} while (status != 0xff && (status & bits) && (max > 0));
2144
2145	return status;
2146}
2147
2148/**
2149 *	ata_wait_idle - Wait for a port to be idle.
2150 *	@ap: Port to wait for.
2151 *
2152 *	Waits up to 10ms for port's BUSY and DRQ signals to clear.
2153 *	Returns final value of status register.
2154 *
2155 *	LOCKING:
2156 *	Inherited from caller.
2157 */
2158static inline u8 ata_wait_idle(struct ata_port *ap)
2159{
2160	u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
2161
2162	if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
2163		ata_port_dbg(ap, "abnormal Status 0x%X\n", status);
2164
2165	return status;
2166}
2167#else /* CONFIG_ATA_SFF */
2168static inline int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
2169				     unsigned long deadline)
2170{
2171	return -EOPNOTSUPP;
2172}
2173#endif /* CONFIG_ATA_SFF */
2174
2175#endif /* __LINUX_LIBATA_H__ */
~/ Read-only file preview.