564cd234c805335999bf40fefe0b00eab1f061d1
[linux-2.6.git] / drivers / ata / libata.h
1 /*
2  *  libata.h - helper library for ATA
3  *
4  *  Copyright 2003-2004 Red Hat, Inc.  All rights reserved.
5  *  Copyright 2003-2004 Jeff Garzik
6  *
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2, or (at your option)
11  *  any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; see the file COPYING.  If not, write to
20  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
21  *
22  *
23  *  libata documentation is available via 'make {ps|pdf}docs',
24  *  as Documentation/DocBook/libata.*
25  *
26  */
27
28 #ifndef __LIBATA_H__
29 #define __LIBATA_H__
30
31 #define DRV_NAME        "libata"
32
33 struct ata_scsi_args {
34         struct ata_device       *dev;
35         u16                     *id;
36         struct scsi_cmnd        *cmd;
37         void                    (*done)(struct scsi_cmnd *);
38 };
39
40 /* libata-core.c */
41 enum {
42         /* flags for ata_dev_read_id() */
43         ATA_READID_POSTRESET    = (1 << 0), /* reading ID after reset */
44
45         /* selector for ata_down_xfermask_limit() */
46         ATA_DNXFER_PIO          = 0,    /* speed down PIO */
47         ATA_DNXFER_DMA          = 1,    /* speed down DMA */
48         ATA_DNXFER_40C          = 2,    /* apply 40c cable limit */
49         ATA_DNXFER_FORCE_PIO    = 3,    /* force PIO */
50         ATA_DNXFER_FORCE_PIO0   = 4,    /* force PIO0 */
51
52         ATA_DNXFER_QUIET        = (1 << 31),
53 };
54
55 extern unsigned int ata_print_id;
56 extern struct workqueue_struct *ata_aux_wq;
57 extern int atapi_enabled;
58 extern int atapi_dmadir;
59 extern int libata_fua;
60 extern int libata_noacpi;
61 extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev);
62 extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
63                            u64 block, u32 n_block, unsigned int tf_flags,
64                            unsigned int tag);
65 extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev);
66 extern void ata_dev_disable(struct ata_device *dev);
67 extern void ata_port_flush_task(struct ata_port *ap);
68 extern unsigned ata_exec_internal(struct ata_device *dev,
69                                   struct ata_taskfile *tf, const u8 *cdb,
70                                   int dma_dir, void *buf, unsigned int buflen);
71 extern unsigned ata_exec_internal_sg(struct ata_device *dev,
72                                      struct ata_taskfile *tf, const u8 *cdb,
73                                      int dma_dir, struct scatterlist *sg,
74                                      unsigned int n_elem);
75 extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd);
76 extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
77                            unsigned int flags, u16 *id);
78 extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
79 extern int ata_dev_revalidate(struct ata_device *dev, unsigned int readid_flags);
80 extern int ata_dev_configure(struct ata_device *dev);
81 extern int sata_down_spd_limit(struct ata_port *ap);
82 extern int sata_set_spd_needed(struct ata_port *ap);
83 extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
84 extern int ata_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev);
85 extern void ata_sg_clean(struct ata_queued_cmd *qc);
86 extern void ata_qc_free(struct ata_queued_cmd *qc);
87 extern void ata_qc_issue(struct ata_queued_cmd *qc);
88 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
89 extern int ata_check_atapi_dma(struct ata_queued_cmd *qc);
90 extern void ata_dev_select(struct ata_port *ap, unsigned int device,
91                            unsigned int wait, unsigned int can_sleep);
92 extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
93 extern int ata_flush_cache(struct ata_device *dev);
94 extern void ata_dev_init(struct ata_device *dev);
95 extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
96 extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
97 extern struct ata_port *ata_port_alloc(struct ata_host *host);
98
99 /* libata-acpi.c */
100 #ifdef CONFIG_ATA_ACPI
101 extern void ata_acpi_associate(struct ata_host *host);
102 extern int ata_acpi_on_suspend(struct ata_port *ap);
103 extern void ata_acpi_on_resume(struct ata_port *ap);
104 extern int ata_acpi_on_devcfg(struct ata_device *adev);
105 #else
106 static inline void ata_acpi_associate(struct ata_host *host) { }
107 static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
108 static inline void ata_acpi_on_resume(struct ata_port *ap) { }
109 static inline int ata_acpi_on_devcfg(struct ata_device *adev) { return 0; }
110 #endif
111
112 /* libata-scsi.c */
113 extern int ata_scsi_add_hosts(struct ata_host *host,
114                               struct scsi_host_template *sht);
115 extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
116 extern int ata_scsi_offline_dev(struct ata_device *dev);
117 extern void ata_scsi_hotplug(struct work_struct *work);
118 extern unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
119                                unsigned int buflen);
120
121 extern unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
122                               unsigned int buflen);
123
124 extern unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
125                               unsigned int buflen);
126 extern unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
127                               unsigned int buflen);
128 extern unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
129                             unsigned int buflen);
130 extern unsigned int ata_scsiop_sync_cache(struct ata_scsi_args *args, u8 *rbuf,
131                                   unsigned int buflen);
132 extern unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
133                                   unsigned int buflen);
134 extern unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
135                                 unsigned int buflen);
136 extern unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
137                                    unsigned int buflen);
138 extern void ata_scsi_badcmd(struct scsi_cmnd *cmd,
139                             void (*done)(struct scsi_cmnd *),
140                             u8 asc, u8 ascq);
141 extern void ata_scsi_set_sense(struct scsi_cmnd *cmd,
142                                u8 sk, u8 asc, u8 ascq);
143 extern void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
144                         unsigned int (*actor) (struct ata_scsi_args *args,
145                                            u8 *rbuf, unsigned int buflen));
146 extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
147 extern void ata_scsi_dev_rescan(struct work_struct *work);
148 extern int ata_bus_probe(struct ata_port *ap);
149
150 /* libata-eh.c */
151 extern enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
152 extern void ata_scsi_error(struct Scsi_Host *host);
153 extern void ata_port_wait_eh(struct ata_port *ap);
154 extern void ata_eh_fastdrain_timerfn(unsigned long arg);
155 extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
156
157 /* libata-sff.c */
158 extern u8 ata_irq_on(struct ata_port *ap);
159
160
161 #endif /* __LIBATA_H__ */