[libata] Add ATA transport class
[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 #define DRV_VERSION     "3.00"  /* must be exactly four chars */
33
34 struct ata_scsi_args {
35         struct ata_device       *dev;
36         u16                     *id;
37         struct scsi_cmnd        *cmd;
38         void                    (*done)(struct scsi_cmnd *);
39 };
40
41 /* libata-core.c */
42 enum {
43         /* flags for ata_dev_read_id() */
44         ATA_READID_POSTRESET    = (1 << 0), /* reading ID after reset */
45
46         /* selector for ata_down_xfermask_limit() */
47         ATA_DNXFER_PIO          = 0,    /* speed down PIO */
48         ATA_DNXFER_DMA          = 1,    /* speed down DMA */
49         ATA_DNXFER_40C          = 2,    /* apply 40c cable limit */
50         ATA_DNXFER_FORCE_PIO    = 3,    /* force PIO */
51         ATA_DNXFER_FORCE_PIO0   = 4,    /* force PIO0 */
52
53         ATA_DNXFER_QUIET        = (1 << 31),
54 };
55
56 extern unsigned int ata_print_id;
57 extern int atapi_passthru16;
58 extern int libata_fua;
59 extern int libata_noacpi;
60 extern int libata_allow_tpm;
61 extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
62 extern void ata_force_cbl(struct ata_port *ap);
63 extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
64 extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
65 extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev);
66 extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
67                            u64 block, u32 n_block, unsigned int tf_flags,
68                            unsigned int tag);
69 extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev);
70 extern unsigned ata_exec_internal(struct ata_device *dev,
71                                   struct ata_taskfile *tf, const u8 *cdb,
72                                   int dma_dir, void *buf, unsigned int buflen,
73                                   unsigned long timeout);
74 extern unsigned ata_exec_internal_sg(struct ata_device *dev,
75                                      struct ata_taskfile *tf, const u8 *cdb,
76                                      int dma_dir, struct scatterlist *sg,
77                                      unsigned int n_elem, unsigned long timeout);
78 extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd);
79 extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
80                           int (*check_ready)(struct ata_link *link));
81 extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
82                            unsigned int flags, u16 *id);
83 extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
84 extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
85                               unsigned int readid_flags);
86 extern int ata_dev_configure(struct ata_device *dev);
87 extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
88 extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
89 extern void ata_sg_clean(struct ata_queued_cmd *qc);
90 extern void ata_qc_free(struct ata_queued_cmd *qc);
91 extern void ata_qc_issue(struct ata_queued_cmd *qc);
92 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
93 extern int atapi_check_dma(struct ata_queued_cmd *qc);
94 extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
95 extern bool ata_phys_link_online(struct ata_link *link);
96 extern bool ata_phys_link_offline(struct ata_link *link);
97 extern void ata_dev_init(struct ata_device *dev);
98 extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
99 extern int sata_link_init_spd(struct ata_link *link);
100 extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
101 extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
102 extern struct ata_port *ata_port_alloc(struct ata_host *host);
103 extern void ata_dev_enable_pm(struct ata_device *dev, enum link_pm policy);
104 extern void ata_lpm_schedule(struct ata_port *ap, enum link_pm);
105 extern const char *sata_spd_string(unsigned int spd);
106
107 /* libata-acpi.c */
108 #ifdef CONFIG_ATA_ACPI
109 extern unsigned int ata_acpi_gtf_filter;
110
111 extern void ata_acpi_associate_sata_port(struct ata_port *ap);
112 extern void ata_acpi_associate(struct ata_host *host);
113 extern void ata_acpi_dissociate(struct ata_host *host);
114 extern int ata_acpi_on_suspend(struct ata_port *ap);
115 extern void ata_acpi_on_resume(struct ata_port *ap);
116 extern int ata_acpi_on_devcfg(struct ata_device *dev);
117 extern void ata_acpi_on_disable(struct ata_device *dev);
118 extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
119 #else
120 static inline void ata_acpi_associate_sata_port(struct ata_port *ap) { }
121 static inline void ata_acpi_associate(struct ata_host *host) { }
122 static inline void ata_acpi_dissociate(struct ata_host *host) { }
123 static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
124 static inline void ata_acpi_on_resume(struct ata_port *ap) { }
125 static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
126 static inline void ata_acpi_on_disable(struct ata_device *dev) { }
127 static inline void ata_acpi_set_state(struct ata_port *ap,
128                                       pm_message_t state) { }
129 #endif
130
131 /* libata-scsi.c */
132 extern int ata_scsi_add_hosts(struct ata_host *host,
133                               struct scsi_host_template *sht);
134 extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
135 extern int ata_scsi_offline_dev(struct ata_device *dev);
136 extern void ata_scsi_media_change_notify(struct ata_device *dev);
137 extern void ata_scsi_hotplug(struct work_struct *work);
138 extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
139 extern void ata_scsi_dev_rescan(struct work_struct *work);
140 extern int ata_bus_probe(struct ata_port *ap);
141 extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
142                               unsigned int id, unsigned int lun);
143
144
145 /* libata-eh.c */
146 extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
147 extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
148 extern enum blk_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
149 extern void ata_scsi_error(struct Scsi_Host *host);
150 extern void ata_port_wait_eh(struct ata_port *ap);
151 extern void ata_eh_fastdrain_timerfn(unsigned long arg);
152 extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
153 extern void ata_dev_disable(struct ata_device *dev);
154 extern void ata_eh_detach_dev(struct ata_device *dev);
155 extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
156                                unsigned int action);
157 extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
158                         unsigned int action);
159 extern void ata_eh_autopsy(struct ata_port *ap);
160 const char *ata_get_cmd_descript(u8 command);
161 extern void ata_eh_report(struct ata_port *ap);
162 extern int ata_eh_reset(struct ata_link *link, int classify,
163                         ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
164                         ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
165 extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
166 extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
167                           ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
168                           ata_postreset_fn_t postreset,
169                           struct ata_link **r_failed_disk);
170 extern void ata_eh_finish(struct ata_port *ap);
171 extern int ata_ering_map(struct ata_ering *ering,
172                          int (*map_fn)(struct ata_ering_entry *, void *),
173                          void *arg);
174
175 /* libata-pmp.c */
176 #ifdef CONFIG_SATA_PMP
177 extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
178 extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
179 extern int sata_pmp_attach(struct ata_device *dev);
180 #else /* CONFIG_SATA_PMP */
181 static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
182 {
183         return -EINVAL;
184 }
185
186 static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
187 {
188         return -EINVAL;
189 }
190
191 static inline int sata_pmp_attach(struct ata_device *dev)
192 {
193         return -EINVAL;
194 }
195 #endif /* CONFIG_SATA_PMP */
196
197 /* libata-sff.c */
198 #ifdef CONFIG_ATA_SFF
199 extern void ata_sff_flush_pio_task(struct ata_port *ap);
200 extern void ata_sff_port_init(struct ata_port *ap);
201 extern int ata_sff_init(void);
202 extern void ata_sff_exit(void);
203 #else /* CONFIG_ATA_SFF */
204 static inline void ata_sff_flush_pio_task(struct ata_port *ap)
205 { }
206 static inline void ata_sff_port_init(struct ata_port *ap)
207 { }
208 static inline int ata_sff_init(void)
209 { return 0; }
210 static inline void ata_sff_exit(void)
211 { }
212 #endif /* CONFIG_ATA_SFF */
213
214 #endif /* __LIBATA_H__ */