[libata] Link power management infrastructure
[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 struct workqueue_struct *ata_aux_wq;
58 extern int atapi_enabled;
59 extern int atapi_dmadir;
60 extern int atapi_passthru16;
61 extern int libata_fua;
62 extern int libata_noacpi;
63 extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev);
64 extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
65                            u64 block, u32 n_block, unsigned int tf_flags,
66                            unsigned int tag);
67 extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev);
68 extern void ata_dev_disable(struct ata_device *dev);
69 extern void ata_port_flush_task(struct ata_port *ap);
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_dev_read_id(struct ata_device *dev, unsigned int *p_class,
80                            unsigned int flags, u16 *id);
81 extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
82 extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
83                               unsigned int readid_flags);
84 extern int ata_dev_configure(struct ata_device *dev);
85 extern int sata_down_spd_limit(struct ata_link *link);
86 extern int sata_set_spd_needed(struct ata_link *link);
87 extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
88 extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
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 ata_check_atapi_dma(struct ata_queued_cmd *qc);
94 extern void ata_dev_select(struct ata_port *ap, unsigned int device,
95                            unsigned int wait, unsigned int can_sleep);
96 extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
97 extern int ata_flush_cache(struct ata_device *dev);
98 extern void ata_dev_init(struct ata_device *dev);
99 extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
100 extern int sata_link_init_spd(struct ata_link *link);
101 extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
102 extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
103 extern struct ata_port *ata_port_alloc(struct ata_host *host);
104 extern void ata_dev_enable_pm(struct ata_device *dev, enum link_pm policy);
105 extern void ata_lpm_schedule(struct ata_port *ap, enum link_pm);
106
107 /* libata-acpi.c */
108 #ifdef CONFIG_ATA_ACPI
109 extern void ata_acpi_associate_sata_port(struct ata_port *ap);
110 extern void ata_acpi_associate(struct ata_host *host);
111 extern int ata_acpi_on_suspend(struct ata_port *ap);
112 extern void ata_acpi_on_resume(struct ata_port *ap);
113 extern int ata_acpi_on_devcfg(struct ata_device *adev);
114 #else
115 static inline void ata_acpi_associate_sata_port(struct ata_port *ap) { }
116 static inline void ata_acpi_associate(struct ata_host *host) { }
117 static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
118 static inline void ata_acpi_on_resume(struct ata_port *ap) { }
119 static inline int ata_acpi_on_devcfg(struct ata_device *adev) { return 0; }
120 #endif
121
122 /* libata-scsi.c */
123 extern int ata_scsi_add_hosts(struct ata_host *host,
124                               struct scsi_host_template *sht);
125 extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
126 extern int ata_scsi_offline_dev(struct ata_device *dev);
127 extern void ata_scsi_media_change_notify(struct ata_device *dev);
128 extern void ata_scsi_hotplug(struct work_struct *work);
129 extern unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
130                                unsigned int buflen);
131
132 extern unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
133                               unsigned int buflen);
134
135 extern unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
136                               unsigned int buflen);
137 extern unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
138                               unsigned int buflen);
139 extern unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
140                             unsigned int buflen);
141 extern unsigned int ata_scsiop_sync_cache(struct ata_scsi_args *args, u8 *rbuf,
142                                   unsigned int buflen);
143 extern unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
144                                   unsigned int buflen);
145 extern unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
146                                 unsigned int buflen);
147 extern unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
148                                    unsigned int buflen);
149 extern void ata_scsi_badcmd(struct scsi_cmnd *cmd,
150                             void (*done)(struct scsi_cmnd *),
151                             u8 asc, u8 ascq);
152 extern void ata_scsi_set_sense(struct scsi_cmnd *cmd,
153                                u8 sk, u8 asc, u8 ascq);
154 extern void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
155                         unsigned int (*actor) (struct ata_scsi_args *args,
156                                            u8 *rbuf, unsigned int buflen));
157 extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
158 extern void ata_scsi_dev_rescan(struct work_struct *work);
159 extern int ata_bus_probe(struct ata_port *ap);
160
161 /* libata-pmp.c */
162 extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
163 extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
164 extern int sata_pmp_attach(struct ata_device *dev);
165
166 /* libata-eh.c */
167 extern enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
168 extern void ata_scsi_error(struct Scsi_Host *host);
169 extern void ata_port_wait_eh(struct ata_port *ap);
170 extern void ata_eh_fastdrain_timerfn(unsigned long arg);
171 extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
172 extern void ata_eh_detach_dev(struct ata_device *dev);
173 extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
174                                unsigned int action);
175 extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
176                         unsigned int action);
177 extern void ata_eh_autopsy(struct ata_port *ap);
178 extern void ata_eh_report(struct ata_port *ap);
179 extern int ata_eh_reset(struct ata_link *link, int classify,
180                         ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
181                         ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
182 extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
183                           ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
184                           ata_postreset_fn_t postreset,
185                           struct ata_link **r_failed_disk);
186 extern void ata_eh_finish(struct ata_port *ap);
187
188 /* libata-sff.c */
189 extern u8 ata_irq_on(struct ata_port *ap);
190
191
192 #endif /* __LIBATA_H__ */