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