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