]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/ata/libata.h
libata: implement more acpi filtering options
[mirror_ubuntu-bionic-kernel.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
57c9efdf
TH
41static inline int ata_is_builtin_hardreset(ata_reset_fn_t reset)
42{
43 if (reset == sata_std_hardreset)
44 return 1;
127102ae 45#ifdef CONFIG_ATA_SFF
57c9efdf
TH
46 if (reset == sata_sff_hardreset)
47 return 1;
127102ae 48#endif
57c9efdf
TH
49 return 0;
50}
51
1da177e4 52/* libata-core.c */
bff04647
TH
53enum {
54 /* flags for ata_dev_read_id() */
55 ATA_READID_POSTRESET = (1 << 0), /* reading ID after reset */
458337db
TH
56
57 /* selector for ata_down_xfermask_limit() */
58 ATA_DNXFER_PIO = 0, /* speed down PIO */
59 ATA_DNXFER_DMA = 1, /* speed down DMA */
60 ATA_DNXFER_40C = 2, /* apply 40c cable limit */
61 ATA_DNXFER_FORCE_PIO = 3, /* force PIO */
62 ATA_DNXFER_FORCE_PIO0 = 4, /* force PIO0 */
458337db
TH
63
64 ATA_DNXFER_QUIET = (1 << 31),
bff04647
TH
65};
66
f3187195 67extern unsigned int ata_print_id;
453b07ac 68extern struct workqueue_struct *ata_aux_wq;
baf4fdfa 69extern int atapi_passthru16;
c3c013a2 70extern int libata_fua;
d7d0dad6 71extern int libata_noacpi;
ae8d4ee7 72extern int libata_allow_tpm;
b1c72916 73extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
33267325 74extern void ata_force_cbl(struct ata_port *ap);
a5987e0a
TH
75extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
76extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
8a8bc223 77extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev);
bd056d7e
TH
78extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
79 u64 block, u32 n_block, unsigned int tf_flags,
80 unsigned int tag);
35b649fe 81extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev);
86e45b6b 82extern void ata_port_flush_task(struct ata_port *ap);
3373efd8 83extern unsigned ata_exec_internal(struct ata_device *dev,
1ad8e7f9 84 struct ata_taskfile *tf, const u8 *cdb,
2b789108
TH
85 int dma_dir, void *buf, unsigned int buflen,
86 unsigned long timeout);
2432697b
TH
87extern unsigned ata_exec_internal_sg(struct ata_device *dev,
88 struct ata_taskfile *tf, const u8 *cdb,
89 int dma_dir, struct scatterlist *sg,
2b789108 90 unsigned int n_elem, unsigned long timeout);
77b08fb5 91extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd);
aa2731ad
TH
92extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
93 int (*check_ready)(struct ata_link *link));
a9beec95 94extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
bff04647 95 unsigned int flags, u16 *id);
fe30911b 96extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
422c9daa
TH
97extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
98 unsigned int readid_flags);
efdaedc4 99extern int ata_dev_configure(struct ata_device *dev);
a07d499b 100extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
458337db 101extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
70e6ad0c 102extern void ata_sg_clean(struct ata_queued_cmd *qc);
8a8bc223 103extern void ata_qc_free(struct ata_queued_cmd *qc);
8e0e694a 104extern void ata_qc_issue(struct ata_queued_cmd *qc);
f686bcb8 105extern void __ata_qc_complete(struct ata_queued_cmd *qc);
5895ef9a 106extern int atapi_check_dma(struct ata_queued_cmd *qc);
1da177e4 107extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
b1c72916
TH
108extern bool ata_phys_link_online(struct ata_link *link);
109extern bool ata_phys_link_offline(struct ata_link *link);
3ef3b43d 110extern void ata_dev_init(struct ata_device *dev);
fb7fd614
TH
111extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
112extern int sata_link_init_spd(struct ata_link *link);
b095518e
JG
113extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
114extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
f3187195 115extern struct ata_port *ata_port_alloc(struct ata_host *host);
ca77329f
KCA
116extern void ata_dev_enable_pm(struct ata_device *dev, enum link_pm policy);
117extern void ata_lpm_schedule(struct ata_port *ap, enum link_pm);
1da177e4 118
11ef697b 119/* libata-acpi.c */
e92351bb 120#ifdef CONFIG_ATA_ACPI
d0df8b5d 121extern void ata_acpi_associate_sata_port(struct ata_port *ap);
fafbae87 122extern void ata_acpi_associate(struct ata_host *host);
562f0c2d 123extern void ata_acpi_dissociate(struct ata_host *host);
64578a3d 124extern int ata_acpi_on_suspend(struct ata_port *ap);
6746544c 125extern void ata_acpi_on_resume(struct ata_port *ap);
562f0c2d
TH
126extern int ata_acpi_on_devcfg(struct ata_device *dev);
127extern void ata_acpi_on_disable(struct ata_device *dev);
bd3adca5 128extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
11ef697b 129#else
d0df8b5d 130static inline void ata_acpi_associate_sata_port(struct ata_port *ap) { }
fafbae87 131static inline void ata_acpi_associate(struct ata_host *host) { }
562f0c2d 132static inline void ata_acpi_dissociate(struct ata_host *host) { }
64578a3d 133static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
6746544c 134static inline void ata_acpi_on_resume(struct ata_port *ap) { }
562f0c2d
TH
135static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
136static inline void ata_acpi_on_disable(struct ata_device *dev) { }
bd3adca5
SL
137static inline void ata_acpi_set_state(struct ata_port *ap,
138 pm_message_t state) { }
11ef697b 139#endif
1da177e4
LT
140
141/* libata-scsi.c */
f3187195
TH
142extern int ata_scsi_add_hosts(struct ata_host *host,
143 struct scsi_host_template *sht);
1ae46317 144extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
0ea035a3 145extern int ata_scsi_offline_dev(struct ata_device *dev);
7d77b247 146extern void ata_scsi_media_change_notify(struct ata_device *dev);
65f27f38 147extern void ata_scsi_hotplug(struct work_struct *work);
7b70fc03 148extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
65f27f38 149extern void ata_scsi_dev_rescan(struct work_struct *work);
80289167 150extern int ata_bus_probe(struct ata_port *ap);
1da177e4 151
ece1d636 152/* libata-eh.c */
87fbc5a0
TH
153extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
154extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
242f9dcb 155extern enum blk_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
381544bb 156extern void ata_scsi_error(struct Scsi_Host *host);
c6cf9e99 157extern void ata_port_wait_eh(struct ata_port *ap);
5ddf24c5 158extern void ata_eh_fastdrain_timerfn(unsigned long arg);
f686bcb8 159extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
678afac6 160extern void ata_dev_disable(struct ata_device *dev);
fb7fd614
TH
161extern void ata_eh_detach_dev(struct ata_device *dev);
162extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
163 unsigned int action);
164extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
165 unsigned int action);
166extern void ata_eh_autopsy(struct ata_port *ap);
6521148c 167const char *ata_get_cmd_descript(u8 command);
fb7fd614
TH
168extern void ata_eh_report(struct ata_port *ap);
169extern int ata_eh_reset(struct ata_link *link, int classify,
170 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
171 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
6f1d1e3a 172extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
fb7fd614
TH
173extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
174 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
175 ata_postreset_fn_t postreset,
176 struct ata_link **r_failed_disk);
177extern void ata_eh_finish(struct ata_port *ap);
ece1d636 178
48515f6c 179/* libata-pmp.c */
88fcd562 180#ifdef CONFIG_SATA_PMP
48515f6c
TH
181extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
182extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
183extern int sata_pmp_attach(struct ata_device *dev);
88fcd562
TH
184#else /* CONFIG_SATA_PMP */
185static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
186{
187 return -EINVAL;
188}
189
190static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
191{
192 return -EINVAL;
193}
194
195static inline int sata_pmp_attach(struct ata_device *dev)
196{
197 return -EINVAL;
198}
199#endif /* CONFIG_SATA_PMP */
48515f6c 200
90088bb4 201/* libata-sff.c */
127102ae 202#ifdef CONFIG_ATA_SFF
624d5c51
TH
203extern void ata_dev_select(struct ata_port *ap, unsigned int device,
204 unsigned int wait, unsigned int can_sleep);
90088bb4 205extern u8 ata_irq_on(struct ata_port *ap);
624d5c51 206extern void ata_pio_task(struct work_struct *work);
127102ae 207#endif /* CONFIG_ATA_SFF */
77a527ea 208
1da177e4 209#endif /* __LIBATA_H__ */