Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
af36d7f0 JG |
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 | * | |
1da177e4 LT |
26 | */ |
27 | ||
28 | #ifndef __LIBATA_H__ | |
29 | #define __LIBATA_H__ | |
30 | ||
31 | #define DRV_NAME "libata" | |
633273a3 | 32 | #define DRV_VERSION "3.00" /* must be exactly four chars */ |
1da177e4 LT |
33 | |
34 | struct ata_scsi_args { | |
9a3dccc4 | 35 | struct ata_device *dev; |
1da177e4 LT |
36 | u16 *id; |
37 | struct scsi_cmnd *cmd; | |
38 | void (*done)(struct scsi_cmnd *); | |
39 | }; | |
40 | ||
41 | /* libata-core.c */ | |
bff04647 TH |
42 | enum { |
43 | /* flags for ata_dev_read_id() */ | |
44 | ATA_READID_POSTRESET = (1 << 0), /* reading ID after reset */ | |
458337db TH |
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 */ | |
458337db TH |
52 | |
53 | ATA_DNXFER_QUIET = (1 << 31), | |
bff04647 TH |
54 | }; |
55 | ||
f3187195 | 56 | extern unsigned int ata_print_id; |
453b07ac | 57 | extern struct workqueue_struct *ata_aux_wq; |
1623c81e | 58 | extern int atapi_enabled; |
baf4fdfa | 59 | extern int atapi_passthru16; |
c3c013a2 | 60 | extern int libata_fua; |
d7d0dad6 | 61 | extern int libata_noacpi; |
ae8d4ee7 | 62 | extern int libata_allow_tpm; |
33267325 | 63 | extern void ata_force_cbl(struct ata_port *ap); |
3373efd8 | 64 | extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev); |
bd056d7e TH |
65 | extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev, |
66 | u64 block, u32 n_block, unsigned int tf_flags, | |
67 | unsigned int tag); | |
35b649fe | 68 | extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev); |
3373efd8 | 69 | extern void ata_dev_disable(struct ata_device *dev); |
86e45b6b | 70 | extern void ata_port_flush_task(struct ata_port *ap); |
3373efd8 | 71 | extern unsigned ata_exec_internal(struct ata_device *dev, |
1ad8e7f9 | 72 | struct ata_taskfile *tf, const u8 *cdb, |
2b789108 TH |
73 | int dma_dir, void *buf, unsigned int buflen, |
74 | unsigned long timeout); | |
2432697b TH |
75 | extern unsigned ata_exec_internal_sg(struct ata_device *dev, |
76 | struct ata_taskfile *tf, const u8 *cdb, | |
77 | int dma_dir, struct scatterlist *sg, | |
2b789108 | 78 | unsigned int n_elem, unsigned long timeout); |
77b08fb5 | 79 | extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd); |
a9beec95 | 80 | extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class, |
bff04647 | 81 | unsigned int flags, u16 *id); |
fe30911b | 82 | extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags); |
422c9daa TH |
83 | extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class, |
84 | unsigned int readid_flags); | |
efdaedc4 | 85 | extern int ata_dev_configure(struct ata_device *dev); |
936fd732 TH |
86 | extern int sata_down_spd_limit(struct ata_link *link); |
87 | extern int sata_set_spd_needed(struct ata_link *link); | |
458337db | 88 | extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel); |
70e6ad0c | 89 | extern void ata_sg_clean(struct ata_queued_cmd *qc); |
1da177e4 | 90 | extern void ata_qc_free(struct ata_queued_cmd *qc); |
8e0e694a | 91 | extern void ata_qc_issue(struct ata_queued_cmd *qc); |
f686bcb8 | 92 | extern void __ata_qc_complete(struct ata_queued_cmd *qc); |
1da177e4 LT |
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); | |
1da177e4 | 96 | extern void swap_buf_le16(u16 *buf, unsigned int buf_words); |
77b08fb5 | 97 | extern int ata_flush_cache(struct ata_device *dev); |
3ef3b43d | 98 | extern void ata_dev_init(struct ata_device *dev); |
fb7fd614 TH |
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); | |
b095518e JG |
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); | |
f3187195 | 103 | extern struct ata_port *ata_port_alloc(struct ata_host *host); |
ca77329f KCA |
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); | |
1da177e4 | 106 | |
11ef697b | 107 | /* libata-acpi.c */ |
e92351bb | 108 | #ifdef CONFIG_ATA_ACPI |
d0df8b5d | 109 | extern void ata_acpi_associate_sata_port(struct ata_port *ap); |
fafbae87 | 110 | extern void ata_acpi_associate(struct ata_host *host); |
562f0c2d | 111 | extern void ata_acpi_dissociate(struct ata_host *host); |
64578a3d | 112 | extern int ata_acpi_on_suspend(struct ata_port *ap); |
6746544c | 113 | extern void ata_acpi_on_resume(struct ata_port *ap); |
562f0c2d TH |
114 | extern int ata_acpi_on_devcfg(struct ata_device *dev); |
115 | extern void ata_acpi_on_disable(struct ata_device *dev); | |
bd3adca5 | 116 | extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state); |
11ef697b | 117 | #else |
d0df8b5d | 118 | static inline void ata_acpi_associate_sata_port(struct ata_port *ap) { } |
fafbae87 | 119 | static inline void ata_acpi_associate(struct ata_host *host) { } |
562f0c2d | 120 | static inline void ata_acpi_dissociate(struct ata_host *host) { } |
64578a3d | 121 | static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; } |
6746544c | 122 | static inline void ata_acpi_on_resume(struct ata_port *ap) { } |
562f0c2d TH |
123 | static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; } |
124 | static inline void ata_acpi_on_disable(struct ata_device *dev) { } | |
bd3adca5 SL |
125 | static inline void ata_acpi_set_state(struct ata_port *ap, |
126 | pm_message_t state) { } | |
11ef697b | 127 | #endif |
1da177e4 LT |
128 | |
129 | /* libata-scsi.c */ | |
f3187195 TH |
130 | extern int ata_scsi_add_hosts(struct ata_host *host, |
131 | struct scsi_host_template *sht); | |
1ae46317 | 132 | extern void ata_scsi_scan_host(struct ata_port *ap, int sync); |
0ea035a3 | 133 | extern int ata_scsi_offline_dev(struct ata_device *dev); |
7d77b247 | 134 | extern void ata_scsi_media_change_notify(struct ata_device *dev); |
65f27f38 | 135 | extern void ata_scsi_hotplug(struct work_struct *work); |
1da177e4 LT |
136 | extern unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf, |
137 | unsigned int buflen); | |
138 | ||
139 | extern unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf, | |
140 | unsigned int buflen); | |
141 | ||
142 | extern unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf, | |
143 | unsigned int buflen); | |
144 | extern unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf, | |
145 | unsigned int buflen); | |
146 | extern unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf, | |
147 | unsigned int buflen); | |
148 | extern unsigned int ata_scsiop_sync_cache(struct ata_scsi_args *args, u8 *rbuf, | |
149 | unsigned int buflen); | |
150 | extern unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf, | |
151 | unsigned int buflen); | |
152 | extern unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf, | |
153 | unsigned int buflen); | |
154 | extern unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf, | |
155 | unsigned int buflen); | |
156 | extern void ata_scsi_badcmd(struct scsi_cmnd *cmd, | |
157 | void (*done)(struct scsi_cmnd *), | |
158 | u8 asc, u8 ascq); | |
845c5834 DG |
159 | extern void ata_scsi_set_sense(struct scsi_cmnd *cmd, |
160 | u8 sk, u8 asc, u8 ascq); | |
8a60a071 | 161 | extern void ata_scsi_rbuf_fill(struct ata_scsi_args *args, |
1da177e4 LT |
162 | unsigned int (*actor) (struct ata_scsi_args *args, |
163 | u8 *rbuf, unsigned int buflen)); | |
7b70fc03 | 164 | extern void ata_schedule_scsi_eh(struct Scsi_Host *shost); |
65f27f38 | 165 | extern void ata_scsi_dev_rescan(struct work_struct *work); |
80289167 | 166 | extern int ata_bus_probe(struct ata_port *ap); |
1da177e4 | 167 | |
3af9a77a TH |
168 | /* libata-pmp.c */ |
169 | extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val); | |
170 | extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val); | |
171 | extern int sata_pmp_attach(struct ata_device *dev); | |
172 | ||
ece1d636 TH |
173 | /* libata-eh.c */ |
174 | extern enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd); | |
381544bb | 175 | extern void ata_scsi_error(struct Scsi_Host *host); |
c6cf9e99 | 176 | extern void ata_port_wait_eh(struct ata_port *ap); |
5ddf24c5 | 177 | extern void ata_eh_fastdrain_timerfn(unsigned long arg); |
f686bcb8 | 178 | extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc); |
fb7fd614 TH |
179 | extern void ata_eh_detach_dev(struct ata_device *dev); |
180 | extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev, | |
181 | unsigned int action); | |
182 | extern void ata_eh_done(struct ata_link *link, struct ata_device *dev, | |
183 | unsigned int action); | |
184 | extern void ata_eh_autopsy(struct ata_port *ap); | |
185 | extern void ata_eh_report(struct ata_port *ap); | |
186 | extern int ata_eh_reset(struct ata_link *link, int classify, | |
187 | ata_prereset_fn_t prereset, ata_reset_fn_t softreset, | |
188 | ata_reset_fn_t hardreset, ata_postreset_fn_t postreset); | |
6f1d1e3a | 189 | extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev); |
fb7fd614 TH |
190 | extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset, |
191 | ata_reset_fn_t softreset, ata_reset_fn_t hardreset, | |
192 | ata_postreset_fn_t postreset, | |
193 | struct ata_link **r_failed_disk); | |
194 | extern void ata_eh_finish(struct ata_port *ap); | |
ece1d636 | 195 | |
90088bb4 TH |
196 | /* libata-sff.c */ |
197 | extern u8 ata_irq_on(struct ata_port *ap); | |
198 | ||
77a527ea | 199 | |
1da177e4 | 200 | #endif /* __LIBATA_H__ */ |