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 atomic_t 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 device_type ata_port_type;
62 extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
63 extern void ata_force_cbl(struct ata_port *ap);
64 extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
65 extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
66 extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev, int tag);
67 extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
68 u64 block, u32 n_block, unsigned int tf_flags,
69 unsigned int tag);
70 extern u64 ata_tf_read_block(const struct ata_taskfile *tf,
71 struct ata_device *dev);
72 extern unsigned ata_exec_internal(struct ata_device *dev,
73 struct ata_taskfile *tf, const u8 *cdb,
74 int dma_dir, void *buf, unsigned int buflen,
75 unsigned long timeout);
76 extern unsigned ata_exec_internal_sg(struct ata_device *dev,
77 struct ata_taskfile *tf, const u8 *cdb,
78 int dma_dir, struct scatterlist *sg,
79 unsigned int n_elem, unsigned long timeout);
80 extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
81 int (*check_ready)(struct ata_link *link));
82 extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
83 unsigned int flags, u16 *id);
84 extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
85 extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
86 unsigned int readid_flags);
87 extern int ata_dev_configure(struct ata_device *dev);
88 extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
89 extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
90 extern unsigned int ata_dev_set_feature(struct ata_device *dev,
91 u8 enable, u8 feature);
92 extern void ata_sg_clean(struct ata_queued_cmd *qc);
93 extern void ata_qc_free(struct ata_queued_cmd *qc);
94 extern void ata_qc_issue(struct ata_queued_cmd *qc);
95 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
96 extern int atapi_check_dma(struct ata_queued_cmd *qc);
97 extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
98 extern bool ata_phys_link_online(struct ata_link *link);
99 extern bool ata_phys_link_offline(struct ata_link *link);
100 extern void ata_dev_init(struct ata_device *dev);
101 extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
102 extern int sata_link_init_spd(struct ata_link *link);
103 extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
104 extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
105 extern struct ata_port *ata_port_alloc(struct ata_host *host);
106 extern const char *sata_spd_string(unsigned int spd);
107 extern int ata_port_probe(struct ata_port *ap);
108 extern void __ata_port_probe(struct ata_port *ap);
109
110 #define to_ata_port(d) container_of(d, struct ata_port, tdev)
111
112 /* libata-acpi.c */
113 #ifdef CONFIG_ATA_ACPI
114 extern unsigned int ata_acpi_gtf_filter;
115 extern void ata_acpi_dissociate(struct ata_host *host);
116 extern int ata_acpi_on_suspend(struct ata_port *ap);
117 extern void ata_acpi_on_resume(struct ata_port *ap);
118 extern int ata_acpi_on_devcfg(struct ata_device *dev);
119 extern void ata_acpi_on_disable(struct ata_device *dev);
120 extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
121 extern void ata_acpi_bind_port(struct ata_port *ap);
122 extern void ata_acpi_bind_dev(struct ata_device *dev);
123 extern acpi_handle ata_dev_acpi_handle(struct ata_device *dev);
124 #else
ata_acpi_dissociate(struct ata_host * host)125 static inline void ata_acpi_dissociate(struct ata_host *host) { }
ata_acpi_on_suspend(struct ata_port * ap)126 static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
ata_acpi_on_resume(struct ata_port * ap)127 static inline void ata_acpi_on_resume(struct ata_port *ap) { }
ata_acpi_on_devcfg(struct ata_device * dev)128 static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
ata_acpi_on_disable(struct ata_device * dev)129 static inline void ata_acpi_on_disable(struct ata_device *dev) { }
ata_acpi_set_state(struct ata_port * ap,pm_message_t state)130 static inline void ata_acpi_set_state(struct ata_port *ap,
131 pm_message_t state) { }
ata_acpi_bind_port(struct ata_port * ap)132 static inline void ata_acpi_bind_port(struct ata_port *ap) {}
ata_acpi_bind_dev(struct ata_device * dev)133 static inline void ata_acpi_bind_dev(struct ata_device *dev) {}
134 #endif
135
136 /* libata-scsi.c */
137 extern int ata_scsi_add_hosts(struct ata_host *host,
138 struct scsi_host_template *sht);
139 extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
140 extern int ata_scsi_offline_dev(struct ata_device *dev);
141 extern void ata_scsi_set_sense(struct ata_device *dev,
142 struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq);
143 extern void ata_scsi_set_sense_information(struct ata_device *dev,
144 struct scsi_cmnd *cmd,
145 const struct ata_taskfile *tf);
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 extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
152 unsigned int id, u64 lun);
153 int ata_sas_allocate_tag(struct ata_port *ap);
154 void ata_sas_free_tag(unsigned int tag, struct ata_port *ap);
155
156
157 /* libata-eh.c */
158 extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
159 extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
160 extern void ata_eh_acquire(struct ata_port *ap);
161 extern void ata_eh_release(struct ata_port *ap);
162 extern enum blk_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
163 extern void ata_scsi_error(struct Scsi_Host *host);
164 extern void ata_eh_fastdrain_timerfn(unsigned long arg);
165 extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
166 extern void ata_dev_disable(struct ata_device *dev);
167 extern void ata_eh_detach_dev(struct ata_device *dev);
168 extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
169 unsigned int action);
170 extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
171 unsigned int action);
172 extern unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
173 u8 page, void *buf, unsigned int sectors);
174 extern void ata_eh_autopsy(struct ata_port *ap);
175 const char *ata_get_cmd_descript(u8 command);
176 extern void ata_eh_report(struct ata_port *ap);
177 extern int ata_eh_reset(struct ata_link *link, int classify,
178 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
179 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
180 extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
181 extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
182 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
183 ata_postreset_fn_t postreset,
184 struct ata_link **r_failed_disk);
185 extern void ata_eh_finish(struct ata_port *ap);
186 extern int ata_ering_map(struct ata_ering *ering,
187 int (*map_fn)(struct ata_ering_entry *, void *),
188 void *arg);
189 extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key);
190 extern unsigned int atapi_eh_request_sense(struct ata_device *dev,
191 u8 *sense_buf, u8 dfl_sense_key);
192
193 /* libata-pmp.c */
194 #ifdef CONFIG_SATA_PMP
195 extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
196 extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
197 extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
198 unsigned hints);
199 extern int sata_pmp_attach(struct ata_device *dev);
200 #else /* CONFIG_SATA_PMP */
sata_pmp_scr_read(struct ata_link * link,int reg,u32 * val)201 static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
202 {
203 return -EINVAL;
204 }
205
sata_pmp_scr_write(struct ata_link * link,int reg,u32 val)206 static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
207 {
208 return -EINVAL;
209 }
210
sata_pmp_set_lpm(struct ata_link * link,enum ata_lpm_policy policy,unsigned hints)211 static inline int sata_pmp_set_lpm(struct ata_link *link,
212 enum ata_lpm_policy policy, unsigned hints)
213 {
214 return -EINVAL;
215 }
216
sata_pmp_attach(struct ata_device * dev)217 static inline int sata_pmp_attach(struct ata_device *dev)
218 {
219 return -EINVAL;
220 }
221 #endif /* CONFIG_SATA_PMP */
222
223 /* libata-sff.c */
224 #ifdef CONFIG_ATA_SFF
225 extern void ata_sff_flush_pio_task(struct ata_port *ap);
226 extern void ata_sff_port_init(struct ata_port *ap);
227 extern int ata_sff_init(void);
228 extern void ata_sff_exit(void);
229 #else /* CONFIG_ATA_SFF */
ata_sff_flush_pio_task(struct ata_port * ap)230 static inline void ata_sff_flush_pio_task(struct ata_port *ap)
231 { }
ata_sff_port_init(struct ata_port * ap)232 static inline void ata_sff_port_init(struct ata_port *ap)
233 { }
ata_sff_init(void)234 static inline int ata_sff_init(void)
235 { return 0; }
ata_sff_exit(void)236 static inline void ata_sff_exit(void)
237 { }
238 #endif /* CONFIG_ATA_SFF */
239
240 /* libata-zpodd.c */
241 #ifdef CONFIG_SATA_ZPODD
242 void zpodd_init(struct ata_device *dev);
243 void zpodd_exit(struct ata_device *dev);
zpodd_dev_enabled(struct ata_device * dev)244 static inline bool zpodd_dev_enabled(struct ata_device *dev)
245 {
246 return dev->zpodd != NULL;
247 }
248 void zpodd_on_suspend(struct ata_device *dev);
249 bool zpodd_zpready(struct ata_device *dev);
250 void zpodd_enable_run_wake(struct ata_device *dev);
251 void zpodd_disable_run_wake(struct ata_device *dev);
252 void zpodd_post_poweron(struct ata_device *dev);
253 #else /* CONFIG_SATA_ZPODD */
zpodd_init(struct ata_device * dev)254 static inline void zpodd_init(struct ata_device *dev) {}
zpodd_exit(struct ata_device * dev)255 static inline void zpodd_exit(struct ata_device *dev) {}
zpodd_dev_enabled(struct ata_device * dev)256 static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; }
zpodd_on_suspend(struct ata_device * dev)257 static inline void zpodd_on_suspend(struct ata_device *dev) {}
zpodd_zpready(struct ata_device * dev)258 static inline bool zpodd_zpready(struct ata_device *dev) { return false; }
zpodd_enable_run_wake(struct ata_device * dev)259 static inline void zpodd_enable_run_wake(struct ata_device *dev) {}
zpodd_disable_run_wake(struct ata_device * dev)260 static inline void zpodd_disable_run_wake(struct ata_device *dev) {}
zpodd_post_poweron(struct ata_device * dev)261 static inline void zpodd_post_poweron(struct ata_device *dev) {}
262 #endif /* CONFIG_SATA_ZPODD */
263
264 #endif /* __LIBATA_H__ */
265