libata: make SFF support optional
[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 static inline int ata_is_builtin_hardreset(ata_reset_fn_t reset)
42 {
43         if (reset == sata_std_hardreset)
44                 return 1;
45 #ifdef CONFIG_ATA_SFF
46         if (reset == sata_sff_hardreset)
47                 return 1;
48 #endif
49         return 0;
50 }
51
52 /* libata-core.c */
53 enum {
54         /* flags for ata_dev_read_id() */
55         ATA_READID_POSTRESET    = (1 << 0), /* reading ID after reset */
56
57         /* selector for ata_down_xfermask_limit() */
58         ATA_DNXFER_PIO          = 0,    /* speed down PIO */
59         ATA_DNXFER_DMA          = 1,    /* speed down DMA */
60         ATA_DNXFER_40C          = 2,    /* apply 40c cable limit */
61         ATA_DNXFER_FORCE_PIO    = 3,    /* force PIO */
62         ATA_DNXFER_FORCE_PIO0   = 4,    /* force PIO0 */
63
64         ATA_DNXFER_QUIET        = (1 << 31),
65 };
66
67 extern unsigned int ata_print_id;
68 extern struct workqueue_struct *ata_aux_wq;
69 extern int atapi_enabled;
70 extern int atapi_passthru16;
71 extern int libata_fua;
72 extern int libata_noacpi;
73 extern int libata_allow_tpm;
74 extern void ata_force_cbl(struct ata_port *ap);
75 extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
76 extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
77 extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev);
78 extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
79                            u64 block, u32 n_block, unsigned int tf_flags,
80                            unsigned int tag);
81 extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev);
82 extern void ata_dev_disable(struct ata_device *dev);
83 extern void ata_pio_queue_task(struct ata_port *ap, void *data,
84                                unsigned long delay);
85 extern void ata_port_flush_task(struct ata_port *ap);
86 extern unsigned ata_exec_internal(struct ata_device *dev,
87                                   struct ata_taskfile *tf, const u8 *cdb,
88                                   int dma_dir, void *buf, unsigned int buflen,
89                                   unsigned long timeout);
90 extern unsigned ata_exec_internal_sg(struct ata_device *dev,
91                                      struct ata_taskfile *tf, const u8 *cdb,
92                                      int dma_dir, struct scatterlist *sg,
93                                      unsigned int n_elem, unsigned long timeout);
94 extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd);
95 extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
96                           int (*check_ready)(struct ata_link *link));
97 extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
98                            unsigned int flags, u16 *id);
99 extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
100 extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
101                               unsigned int readid_flags);
102 extern int ata_dev_configure(struct ata_device *dev);
103 extern int sata_down_spd_limit(struct ata_link *link);
104 extern int sata_set_spd_needed(struct ata_link *link);
105 extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
106 extern void ata_sg_clean(struct ata_queued_cmd *qc);
107 extern void ata_qc_free(struct ata_queued_cmd *qc);
108 extern void ata_qc_issue(struct ata_queued_cmd *qc);
109 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
110 extern int ata_check_atapi_dma(struct ata_queued_cmd *qc);
111 extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
112 extern void ata_dev_init(struct ata_device *dev);
113 extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
114 extern int sata_link_init_spd(struct ata_link *link);
115 extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
116 extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
117 extern struct ata_port *ata_port_alloc(struct ata_host *host);
118 extern void ata_dev_enable_pm(struct ata_device *dev, enum link_pm policy);
119 extern void ata_lpm_schedule(struct ata_port *ap, enum link_pm);
120
121 /* libata-acpi.c */
122 #ifdef CONFIG_ATA_ACPI
123 extern void ata_acpi_associate_sata_port(struct ata_port *ap);
124 extern void ata_acpi_associate(struct ata_host *host);
125 extern void ata_acpi_dissociate(struct ata_host *host);
126 extern int ata_acpi_on_suspend(struct ata_port *ap);
127 extern void ata_acpi_on_resume(struct ata_port *ap);
128 extern int ata_acpi_on_devcfg(struct ata_device *dev);
129 extern void ata_acpi_on_disable(struct ata_device *dev);
130 extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
131 #else
132 static inline void ata_acpi_associate_sata_port(struct ata_port *ap) { }
133 static inline void ata_acpi_associate(struct ata_host *host) { }
134 static inline void ata_acpi_dissociate(struct ata_host *host) { }
135 static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
136 static inline void ata_acpi_on_resume(struct ata_port *ap) { }
137 static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
138 static inline void ata_acpi_on_disable(struct ata_device *dev) { }
139 static inline void ata_acpi_set_state(struct ata_port *ap,
140                                       pm_message_t state) { }
141 #endif
142
143 /* libata-scsi.c */
144 extern int ata_scsi_add_hosts(struct ata_host *host,
145                               struct scsi_host_template *sht);
146 extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
147 extern int ata_scsi_offline_dev(struct ata_device *dev);
148 extern void ata_scsi_media_change_notify(struct ata_device *dev);
149 extern void ata_scsi_hotplug(struct work_struct *work);
150 extern unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
151                                unsigned int buflen);
152
153 extern unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
154                               unsigned int buflen);
155
156 extern unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
157                               unsigned int buflen);
158 extern unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
159                               unsigned int buflen);
160 extern unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
161                             unsigned int buflen);
162 extern unsigned int ata_scsiop_sync_cache(struct ata_scsi_args *args, u8 *rbuf,
163                                   unsigned int buflen);
164 extern unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
165                                   unsigned int buflen);
166 extern unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
167                                 unsigned int buflen);
168 extern unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
169                                    unsigned int buflen);
170 extern void ata_scsi_badcmd(struct scsi_cmnd *cmd,
171                             void (*done)(struct scsi_cmnd *),
172                             u8 asc, u8 ascq);
173 extern void ata_scsi_set_sense(struct scsi_cmnd *cmd,
174                                u8 sk, u8 asc, u8 ascq);
175 extern void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
176                         unsigned int (*actor) (struct ata_scsi_args *args,
177                                            u8 *rbuf, unsigned int buflen));
178 extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
179 extern void ata_scsi_dev_rescan(struct work_struct *work);
180 extern int ata_bus_probe(struct ata_port *ap);
181
182 /* libata-pmp.c */
183 extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
184 extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
185 extern int sata_pmp_attach(struct ata_device *dev);
186
187 /* libata-eh.c */
188 extern enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
189 extern void ata_scsi_error(struct Scsi_Host *host);
190 extern void ata_port_wait_eh(struct ata_port *ap);
191 extern void ata_eh_fastdrain_timerfn(unsigned long arg);
192 extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
193 extern void ata_eh_detach_dev(struct ata_device *dev);
194 extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
195                                unsigned int action);
196 extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
197                         unsigned int action);
198 extern void ata_eh_autopsy(struct ata_port *ap);
199 extern void ata_eh_report(struct ata_port *ap);
200 extern int ata_eh_reset(struct ata_link *link, int classify,
201                         ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
202                         ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
203 extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
204 extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
205                           ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
206                           ata_postreset_fn_t postreset,
207                           struct ata_link **r_failed_disk);
208 extern void ata_eh_finish(struct ata_port *ap);
209
210 /* libata-sff.c */
211 #ifdef CONFIG_ATA_SFF
212 extern void ata_dev_select(struct ata_port *ap, unsigned int device,
213                            unsigned int wait, unsigned int can_sleep);
214 extern u8 ata_irq_on(struct ata_port *ap);
215 extern void ata_pio_task(struct work_struct *work);
216 #endif /* CONFIG_ATA_SFF */
217
218 #endif /* __LIBATA_H__ */