Merge branch 'for-linus' of git://github.com/dtor/input
[deliverable/linux.git] / drivers / ata / libata.h
CommitLineData
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
34struct 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
42enum {
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 56extern unsigned int ata_print_id;
baf4fdfa 57extern int atapi_passthru16;
c3c013a2 58extern int libata_fua;
d7d0dad6 59extern int libata_noacpi;
ae8d4ee7 60extern int libata_allow_tpm;
b1c72916 61extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
33267325 62extern void ata_force_cbl(struct ata_port *ap);
a5987e0a
TH
63extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
64extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
8a8bc223 65extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev);
bd056d7e
TH
66extern 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);
35b649fe 69extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev);
3373efd8 70extern unsigned ata_exec_internal(struct ata_device *dev,
1ad8e7f9 71 struct ata_taskfile *tf, const u8 *cdb,
2b789108
TH
72 int dma_dir, void *buf, unsigned int buflen,
73 unsigned long timeout);
2432697b
TH
74extern unsigned ata_exec_internal_sg(struct ata_device *dev,
75 struct ata_taskfile *tf, const u8 *cdb,
76 int dma_dir, struct scatterlist *sg,
2b789108 77 unsigned int n_elem, unsigned long timeout);
77b08fb5 78extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd);
aa2731ad
TH
79extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
80 int (*check_ready)(struct ata_link *link));
a9beec95 81extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
bff04647 82 unsigned int flags, u16 *id);
fe30911b 83extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
422c9daa
TH
84extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
85 unsigned int readid_flags);
efdaedc4 86extern int ata_dev_configure(struct ata_device *dev);
a07d499b 87extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
458337db 88extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
1152b261
TH
89extern unsigned int ata_dev_set_feature(struct ata_device *dev,
90 u8 enable, u8 feature);
70e6ad0c 91extern void ata_sg_clean(struct ata_queued_cmd *qc);
8a8bc223 92extern void ata_qc_free(struct ata_queued_cmd *qc);
8e0e694a 93extern void ata_qc_issue(struct ata_queued_cmd *qc);
f686bcb8 94extern void __ata_qc_complete(struct ata_queued_cmd *qc);
5895ef9a 95extern int atapi_check_dma(struct ata_queued_cmd *qc);
1da177e4 96extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
b1c72916
TH
97extern bool ata_phys_link_online(struct ata_link *link);
98extern bool ata_phys_link_offline(struct ata_link *link);
3ef3b43d 99extern void ata_dev_init(struct ata_device *dev);
fb7fd614
TH
100extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
101extern int sata_link_init_spd(struct ata_link *link);
b095518e
JG
102extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
103extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
f3187195 104extern struct ata_port *ata_port_alloc(struct ata_host *host);
d9027470 105extern const char *sata_spd_string(unsigned int spd);
238c9cf9 106extern int ata_port_probe(struct ata_port *ap);
1da177e4 107
11ef697b 108/* libata-acpi.c */
e92351bb 109#ifdef CONFIG_ATA_ACPI
110f66d2
TH
110extern unsigned int ata_acpi_gtf_filter;
111
d0df8b5d 112extern void ata_acpi_associate_sata_port(struct ata_port *ap);
fafbae87 113extern void ata_acpi_associate(struct ata_host *host);
562f0c2d 114extern void ata_acpi_dissociate(struct ata_host *host);
64578a3d 115extern int ata_acpi_on_suspend(struct ata_port *ap);
6746544c 116extern void ata_acpi_on_resume(struct ata_port *ap);
562f0c2d
TH
117extern int ata_acpi_on_devcfg(struct ata_device *dev);
118extern void ata_acpi_on_disable(struct ata_device *dev);
bd3adca5 119extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
11ef697b 120#else
d0df8b5d 121static inline void ata_acpi_associate_sata_port(struct ata_port *ap) { }
fafbae87 122static inline void ata_acpi_associate(struct ata_host *host) { }
562f0c2d 123static inline void ata_acpi_dissociate(struct ata_host *host) { }
64578a3d 124static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
6746544c 125static inline void ata_acpi_on_resume(struct ata_port *ap) { }
562f0c2d
TH
126static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
127static inline void ata_acpi_on_disable(struct ata_device *dev) { }
bd3adca5
SL
128static inline void ata_acpi_set_state(struct ata_port *ap,
129 pm_message_t state) { }
11ef697b 130#endif
1da177e4
LT
131
132/* libata-scsi.c */
f3187195
TH
133extern int ata_scsi_add_hosts(struct ata_host *host,
134 struct scsi_host_template *sht);
1ae46317 135extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
0ea035a3 136extern int ata_scsi_offline_dev(struct ata_device *dev);
7d77b247 137extern void ata_scsi_media_change_notify(struct ata_device *dev);
65f27f38 138extern void ata_scsi_hotplug(struct work_struct *work);
7b70fc03 139extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
65f27f38 140extern void ata_scsi_dev_rescan(struct work_struct *work);
80289167 141extern int ata_bus_probe(struct ata_port *ap);
d9027470
GG
142extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
143 unsigned int id, unsigned int lun);
144
1da177e4 145
ece1d636 146/* libata-eh.c */
87fbc5a0
TH
147extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
148extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
c0c362b6
TH
149extern void ata_eh_acquire(struct ata_port *ap);
150extern void ata_eh_release(struct ata_port *ap);
242f9dcb 151extern enum blk_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
381544bb 152extern void ata_scsi_error(struct Scsi_Host *host);
c6cf9e99 153extern void ata_port_wait_eh(struct ata_port *ap);
5ddf24c5 154extern void ata_eh_fastdrain_timerfn(unsigned long arg);
f686bcb8 155extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
678afac6 156extern void ata_dev_disable(struct ata_device *dev);
fb7fd614
TH
157extern void ata_eh_detach_dev(struct ata_device *dev);
158extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
159 unsigned int action);
160extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
161 unsigned int action);
162extern void ata_eh_autopsy(struct ata_port *ap);
6521148c 163const char *ata_get_cmd_descript(u8 command);
fb7fd614
TH
164extern void ata_eh_report(struct ata_port *ap);
165extern 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);
6f1d1e3a 168extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
fb7fd614
TH
169extern 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);
173extern void ata_eh_finish(struct ata_port *ap);
d9027470
GG
174extern int ata_ering_map(struct ata_ering *ering,
175 int (*map_fn)(struct ata_ering_entry *, void *),
176 void *arg);
ece1d636 177
48515f6c 178/* libata-pmp.c */
88fcd562 179#ifdef CONFIG_SATA_PMP
48515f6c
TH
180extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
181extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
6c8ea89c
TH
182extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
183 unsigned hints);
48515f6c 184extern int sata_pmp_attach(struct ata_device *dev);
88fcd562
TH
185#else /* CONFIG_SATA_PMP */
186static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
187{
188 return -EINVAL;
189}
190
191static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
192{
193 return -EINVAL;
194}
195
6c8ea89c
TH
196static inline int sata_pmp_set_lpm(struct ata_link *link,
197 enum ata_lpm_policy policy, unsigned hints)
198{
199 return -EINVAL;
200}
201
88fcd562
TH
202static inline int sata_pmp_attach(struct ata_device *dev)
203{
204 return -EINVAL;
205}
206#endif /* CONFIG_SATA_PMP */
48515f6c 207
90088bb4 208/* libata-sff.c */
127102ae 209#ifdef CONFIG_ATA_SFF
c429137a 210extern void ata_sff_flush_pio_task(struct ata_port *ap);
270390e1
TH
211extern void ata_sff_port_init(struct ata_port *ap);
212extern int ata_sff_init(void);
213extern void ata_sff_exit(void);
214#else /* CONFIG_ATA_SFF */
c429137a
TH
215static inline void ata_sff_flush_pio_task(struct ata_port *ap)
216{ }
270390e1
TH
217static inline void ata_sff_port_init(struct ata_port *ap)
218{ }
219static inline int ata_sff_init(void)
220{ return 0; }
221static inline void ata_sff_exit(void)
222{ }
127102ae 223#endif /* CONFIG_ATA_SFF */
77a527ea 224
1da177e4 225#endif /* __LIBATA_H__ */
This page took 0.928868 seconds and 5 git commands to generate.