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