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