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 unsigned int ata_dev_set_feature(struct ata_device *dev,
90 u8 enable, u8 feature);
91 extern void ata_sg_clean(struct ata_queued_cmd *qc);
92 extern void ata_qc_free(struct ata_queued_cmd *qc);
93 extern void ata_qc_issue(struct ata_queued_cmd *qc);
94 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
95 extern int atapi_check_dma(struct ata_queued_cmd *qc);
96 extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
97 extern bool ata_phys_link_online(struct ata_link *link);
98 extern bool ata_phys_link_offline(struct ata_link *link);
99 extern void ata_dev_init(struct ata_device *dev);
100 extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
101 extern int sata_link_init_spd(struct ata_link *link);
102 extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
103 extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
104 extern struct ata_port *ata_port_alloc(struct ata_host *host);
105 extern const char *sata_spd_string(unsigned int spd);
106 extern int ata_port_probe(struct ata_port *ap);
107
108 /* libata-acpi.c */
109 #ifdef CONFIG_ATA_ACPI
110 extern unsigned int ata_acpi_gtf_filter;
111
112 extern void ata_acpi_associate_sata_port(struct ata_port *ap);
113 extern void ata_acpi_associate(struct ata_host *host);
114 extern void ata_acpi_dissociate(struct ata_host *host);
115 extern int ata_acpi_on_suspend(struct ata_port *ap);
116 extern void ata_acpi_on_resume(struct ata_port *ap);
117 extern int ata_acpi_on_devcfg(struct ata_device *dev);
118 extern void ata_acpi_on_disable(struct ata_device *dev);
119 extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
120 #else
ata_acpi_associate_sata_port(struct ata_port * ap)121 static inline void ata_acpi_associate_sata_port(struct ata_port *ap) { }
ata_acpi_associate(struct ata_host * host)122 static inline void ata_acpi_associate(struct ata_host *host) { }
ata_acpi_dissociate(struct ata_host * host)123 static inline void ata_acpi_dissociate(struct ata_host *host) { }
ata_acpi_on_suspend(struct ata_port * ap)124 static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
ata_acpi_on_resume(struct ata_port * ap)125 static inline void ata_acpi_on_resume(struct ata_port *ap) { }
ata_acpi_on_devcfg(struct ata_device * dev)126 static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
ata_acpi_on_disable(struct ata_device * dev)127 static inline void ata_acpi_on_disable(struct ata_device *dev) { }
ata_acpi_set_state(struct ata_port * ap,pm_message_t state)128 static inline void ata_acpi_set_state(struct ata_port *ap,
129 pm_message_t state) { }
130 #endif
131
132 /* libata-scsi.c */
133 extern int ata_scsi_add_hosts(struct ata_host *host,
134 struct scsi_host_template *sht);
135 extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
136 extern int ata_scsi_offline_dev(struct ata_device *dev);
137 extern void ata_scsi_media_change_notify(struct ata_device *dev);
138 extern void ata_scsi_hotplug(struct work_struct *work);
139 extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
140 extern void ata_scsi_dev_rescan(struct work_struct *work);
141 extern int ata_bus_probe(struct ata_port *ap);
142 extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
143 unsigned int id, unsigned int lun);
144
145
146 /* libata-eh.c */
147 extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
148 extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
149 extern void ata_eh_acquire(struct ata_port *ap);
150 extern void ata_eh_release(struct ata_port *ap);
151 extern enum blk_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
152 extern void ata_scsi_error(struct Scsi_Host *host);
153 extern void ata_port_wait_eh(struct ata_port *ap);
154 extern void ata_eh_fastdrain_timerfn(unsigned long arg);
155 extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
156 extern void ata_dev_disable(struct ata_device *dev);
157 extern void ata_eh_detach_dev(struct ata_device *dev);
158 extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
159 unsigned int action);
160 extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
161 unsigned int action);
162 extern void ata_eh_autopsy(struct ata_port *ap);
163 const char *ata_get_cmd_descript(u8 command);
164 extern void ata_eh_report(struct ata_port *ap);
165 extern int ata_eh_reset(struct ata_link *link, int classify,
166 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
167 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
168 extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
169 extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
170 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
171 ata_postreset_fn_t postreset,
172 struct ata_link **r_failed_disk);
173 extern void ata_eh_finish(struct ata_port *ap);
174 extern int ata_ering_map(struct ata_ering *ering,
175 int (*map_fn)(struct ata_ering_entry *, void *),
176 void *arg);
177
178 /* libata-pmp.c */
179 #ifdef CONFIG_SATA_PMP
180 extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
181 extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
182 extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
183 unsigned hints);
184 extern int sata_pmp_attach(struct ata_device *dev);
185 #else /* CONFIG_SATA_PMP */
sata_pmp_scr_read(struct ata_link * link,int reg,u32 * val)186 static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
187 {
188 return -EINVAL;
189 }
190
sata_pmp_scr_write(struct ata_link * link,int reg,u32 val)191 static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
192 {
193 return -EINVAL;
194 }
195
sata_pmp_set_lpm(struct ata_link * link,enum ata_lpm_policy policy,unsigned hints)196 static inline int sata_pmp_set_lpm(struct ata_link *link,
197 enum ata_lpm_policy policy, unsigned hints)
198 {
199 return -EINVAL;
200 }
201
sata_pmp_attach(struct ata_device * dev)202 static inline int sata_pmp_attach(struct ata_device *dev)
203 {
204 return -EINVAL;
205 }
206 #endif /* CONFIG_SATA_PMP */
207
208 /* libata-sff.c */
209 #ifdef CONFIG_ATA_SFF
210 extern void ata_sff_flush_pio_task(struct ata_port *ap);
211 extern void ata_sff_port_init(struct ata_port *ap);
212 extern int ata_sff_init(void);
213 extern void ata_sff_exit(void);
214 #else /* CONFIG_ATA_SFF */
ata_sff_flush_pio_task(struct ata_port * ap)215 static inline void ata_sff_flush_pio_task(struct ata_port *ap)
216 { }
ata_sff_port_init(struct ata_port * ap)217 static inline void ata_sff_port_init(struct ata_port *ap)
218 { }
ata_sff_init(void)219 static inline int ata_sff_init(void)
220 { return 0; }
ata_sff_exit(void)221 static inline void ata_sff_exit(void)
222 { }
223 #endif /* CONFIG_ATA_SFF */
224
225 #endif /* __LIBATA_H__ */
226