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