libata: add command name parsing for error output
[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_passthru16;
70 extern int libata_fua;
71 extern int libata_noacpi;
72 extern int libata_allow_tpm;
73 extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
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_port_flush_task(struct ata_port *ap);
83 extern unsigned ata_exec_internal(struct ata_device *dev,
84                                   struct ata_taskfile *tf, const u8 *cdb,
85                                   int dma_dir, void *buf, unsigned int buflen,
86                                   unsigned long timeout);
87 extern unsigned ata_exec_internal_sg(struct ata_device *dev,
88                                      struct ata_taskfile *tf, const u8 *cdb,
89                                      int dma_dir, struct scatterlist *sg,
90                                      unsigned int n_elem, unsigned long timeout);
91 extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd);
92 extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
93                           int (*check_ready)(struct ata_link *link));
94 extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
95                            unsigned int flags, u16 *id);
96 extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
97 extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
98                               unsigned int readid_flags);
99 extern int ata_dev_configure(struct ata_device *dev);
100 extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
101 extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
102 extern void ata_sg_clean(struct ata_queued_cmd *qc);
103 extern void ata_qc_free(struct ata_queued_cmd *qc);
104 extern void ata_qc_issue(struct ata_queued_cmd *qc);
105 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
106 extern int atapi_check_dma(struct ata_queued_cmd *qc);
107 extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
108 extern bool ata_phys_link_online(struct ata_link *link);
109 extern bool ata_phys_link_offline(struct ata_link *link);
110 extern void ata_dev_init(struct ata_device *dev);
111 extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
112 extern int sata_link_init_spd(struct ata_link *link);
113 extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
114 extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
115 extern struct ata_port *ata_port_alloc(struct ata_host *host);
116 extern void ata_dev_enable_pm(struct ata_device *dev, enum link_pm policy);
117 extern void ata_lpm_schedule(struct ata_port *ap, enum link_pm);
118
119 /* libata-acpi.c */
120 #ifdef CONFIG_ATA_ACPI
121 extern void ata_acpi_associate_sata_port(struct ata_port *ap);
122 extern void ata_acpi_associate(struct ata_host *host);
123 extern void ata_acpi_dissociate(struct ata_host *host);
124 extern int ata_acpi_on_suspend(struct ata_port *ap);
125 extern void ata_acpi_on_resume(struct ata_port *ap);
126 extern int ata_acpi_on_devcfg(struct ata_device *dev);
127 extern void ata_acpi_on_disable(struct ata_device *dev);
128 extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
129 #else
130 static inline void ata_acpi_associate_sata_port(struct ata_port *ap) { }
131 static inline void ata_acpi_associate(struct ata_host *host) { }
132 static inline void ata_acpi_dissociate(struct ata_host *host) { }
133 static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
134 static inline void ata_acpi_on_resume(struct ata_port *ap) { }
135 static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
136 static inline void ata_acpi_on_disable(struct ata_device *dev) { }
137 static inline void ata_acpi_set_state(struct ata_port *ap,
138                                       pm_message_t state) { }
139 #endif
140
141 /* libata-scsi.c */
142 extern int ata_scsi_add_hosts(struct ata_host *host,
143                               struct scsi_host_template *sht);
144 extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
145 extern int ata_scsi_offline_dev(struct ata_device *dev);
146 extern void ata_scsi_media_change_notify(struct ata_device *dev);
147 extern void ata_scsi_hotplug(struct work_struct *work);
148 extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
149 extern void ata_scsi_dev_rescan(struct work_struct *work);
150 extern int ata_bus_probe(struct ata_port *ap);
151
152 /* libata-eh.c */
153 extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
154 extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
155 extern enum blk_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
156 extern void ata_scsi_error(struct Scsi_Host *host);
157 extern void ata_port_wait_eh(struct ata_port *ap);
158 extern void ata_eh_fastdrain_timerfn(unsigned long arg);
159 extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
160 extern void ata_dev_disable(struct ata_device *dev);
161 extern void ata_eh_detach_dev(struct ata_device *dev);
162 extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
163                                unsigned int action);
164 extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
165                         unsigned int action);
166 extern void ata_eh_autopsy(struct ata_port *ap);
167 const char *ata_get_cmd_descript(u8 command);
168 extern void ata_eh_report(struct ata_port *ap);
169 extern int ata_eh_reset(struct ata_link *link, int classify,
170                         ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
171                         ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
172 extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
173 extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
174                           ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
175                           ata_postreset_fn_t postreset,
176                           struct ata_link **r_failed_disk);
177 extern void ata_eh_finish(struct ata_port *ap);
178
179 /* libata-pmp.c */
180 #ifdef CONFIG_SATA_PMP
181 extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
182 extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
183 extern int sata_pmp_attach(struct ata_device *dev);
184 #else /* CONFIG_SATA_PMP */
185 static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
186 {
187         return -EINVAL;
188 }
189
190 static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
191 {
192         return -EINVAL;
193 }
194
195 static inline int sata_pmp_attach(struct ata_device *dev)
196 {
197         return -EINVAL;
198 }
199 #endif /* CONFIG_SATA_PMP */
200
201 /* libata-sff.c */
202 #ifdef CONFIG_ATA_SFF
203 extern void ata_dev_select(struct ata_port *ap, unsigned int device,
204                            unsigned int wait, unsigned int can_sleep);
205 extern u8 ata_irq_on(struct ata_port *ap);
206 extern void ata_pio_task(struct work_struct *work);
207 #endif /* CONFIG_ATA_SFF */
208
209 #endif /* __LIBATA_H__ */