projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
libata: move sas ata tag allocation to libata-scsi.c
[linux-2.6-block.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
85d6725b 56extern atomic_t ata_print_id;
baf4fdfa 57extern int atapi_passthru16;
c3c013a2 58extern int libata_fua;
d7d0dad6 59extern int libata_noacpi;
ae8d4ee7 60extern int libata_allow_tpm;
5ef41082 61extern struct device_type ata_port_type;
b1c72916 62extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
33267325 63extern void ata_force_cbl(struct ata_port *ap);
a5987e0a
TH		 64extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
65extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
12cb5ce1 66extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev, int tag);
bd056d7e
TH		 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);
35b649fe 70extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev);
3373efd8 71extern 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		 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,
2b789108 78 unsigned int n_elem, unsigned long timeout);
77b08fb5 79extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd);
aa2731ad
TH		 80extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
81 int (*check_ready)(struct ata_link *link));
a9beec95 82extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
bff04647 83 unsigned int flags, u16 *id);
fe30911b 84extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
422c9daa
TH		 85extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
86 unsigned int readid_flags);
efdaedc4 87extern int ata_dev_configure(struct ata_device *dev);
a07d499b 88extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
458337db 89extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
1152b261
TH		 90extern unsigned int ata_dev_set_feature(struct ata_device *dev,
91 u8 enable, u8 feature);
70e6ad0c 92extern void ata_sg_clean(struct ata_queued_cmd *qc);
8a8bc223 93extern void ata_qc_free(struct ata_queued_cmd *qc);
8e0e694a 94extern void ata_qc_issue(struct ata_queued_cmd *qc);
f686bcb8 95extern void __ata_qc_complete(struct ata_queued_cmd *qc);
5895ef9a 96extern int atapi_check_dma(struct ata_queued_cmd *qc);
1da177e4 97extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
b1c72916
TH		 98extern bool ata_phys_link_online(struct ata_link *link);
99extern bool ata_phys_link_offline(struct ata_link *link);
3ef3b43d 100extern void ata_dev_init(struct ata_device *dev);
fb7fd614
TH		 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);
b095518e
JG		 103extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
104extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
f3187195 105extern struct ata_port *ata_port_alloc(struct ata_host *host);
d9027470 106extern const char *sata_spd_string(unsigned int spd);
238c9cf9 107extern int ata_port_probe(struct ata_port *ap);
9508a66f 108extern void __ata_port_probe(struct ata_port *ap);
1da177e4 109
6b66d958
MG		 110#define to_ata_port(d) container_of(d, struct ata_port, tdev)
111
11ef697b 112/* libata-acpi.c */
e92351bb 113#ifdef CONFIG_ATA_ACPI
110f66d2 114extern unsigned int ata_acpi_gtf_filter;
562f0c2d 115extern void ata_acpi_dissociate(struct ata_host *host);
64578a3d 116extern int ata_acpi_on_suspend(struct ata_port *ap);
6746544c 117extern void ata_acpi_on_resume(struct ata_port *ap);
562f0c2d
TH		 118extern int ata_acpi_on_devcfg(struct ata_device *dev);
119extern void ata_acpi_on_disable(struct ata_device *dev);
bd3adca5 120extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
f1bc1e4c
AL		 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);
11ef697b 124#else
562f0c2d 125static inline void ata_acpi_dissociate(struct ata_host *host) { }
64578a3d 126static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
6746544c 127static inline void ata_acpi_on_resume(struct ata_port *ap) { }
562f0c2d
TH		 128static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
129static inline void ata_acpi_on_disable(struct ata_device *dev) { }
bd3adca5
SL		 130static inline void ata_acpi_set_state(struct ata_port *ap,
131 pm_message_t state) { }
f1bc1e4c
AL		 132static inline void ata_acpi_bind_port(struct ata_port *ap) {}
133static inline void ata_acpi_bind_dev(struct ata_device *dev) {}
11ef697b 134#endif
1da177e4
LT		 135
136/* libata-scsi.c */
f3187195
TH		 137extern int ata_scsi_add_hosts(struct ata_host *host,
138 struct scsi_host_template *sht);
1ae46317 139extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
0ea035a3 140extern int ata_scsi_offline_dev(struct ata_device *dev);
7d77b247 141extern void ata_scsi_media_change_notify(struct ata_device *dev);
65f27f38 142extern void ata_scsi_hotplug(struct work_struct *work);
7b70fc03 143extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
65f27f38 144extern void ata_scsi_dev_rescan(struct work_struct *work);
80289167 145extern int ata_bus_probe(struct ata_port *ap);
d9027470 146extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
9cb78c16 147 unsigned int id, u64 lun);
98bd4be1
SL		 148int ata_sas_allocate_tag(struct ata_port *ap);
149void ata_sas_free_tag(unsigned int tag, struct ata_port *ap);
d9027470 150
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);
c0c362b6
TH		 155extern void ata_eh_acquire(struct ata_port *ap);
156extern void ata_eh_release(struct ata_port *ap);
242f9dcb 157extern enum blk_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
381544bb 158extern void ata_scsi_error(struct Scsi_Host *host);
5ddf24c5 159extern void ata_eh_fastdrain_timerfn(unsigned long arg);
f686bcb8 160extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
678afac6 161extern void ata_dev_disable(struct ata_device *dev);
fb7fd614
TH		 162extern void ata_eh_detach_dev(struct ata_device *dev);
163extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
164 unsigned int action);
165extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
166 unsigned int action);
65fe1f0f
SH		 167extern unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
168 u8 page, void *buf, unsigned int sectors);
fb7fd614 169extern void ata_eh_autopsy(struct ata_port *ap);
6521148c 170const char *ata_get_cmd_descript(u8 command);
fb7fd614
TH		 171extern void ata_eh_report(struct ata_port *ap);
172extern int ata_eh_reset(struct ata_link *link, int classify,
173 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
174 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
6f1d1e3a 175extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
fb7fd614
TH		 176extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
177 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
178 ata_postreset_fn_t postreset,
179 struct ata_link **r_failed_disk);
180extern void ata_eh_finish(struct ata_port *ap);
d9027470
GG		 181extern int ata_ering_map(struct ata_ering *ering,
182 int (*map_fn)(struct ata_ering_entry *, void *),
183 void *arg);
3dc67440
AL		 184extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key);
185extern unsigned int atapi_eh_request_sense(struct ata_device *dev,
186 u8 *sense_buf, u8 dfl_sense_key);
ece1d636 187
48515f6c 188/* libata-pmp.c */
88fcd562 189#ifdef CONFIG_SATA_PMP
48515f6c
TH		 190extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
191extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
6c8ea89c
TH		 192extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
193 unsigned hints);
48515f6c 194extern int sata_pmp_attach(struct ata_device *dev);
88fcd562
TH		 195#else /* CONFIG_SATA_PMP */
196static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
197{
198 return -EINVAL;
199}
200
201static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
202{
203 return -EINVAL;
204}
205
6c8ea89c
TH		 206static inline int sata_pmp_set_lpm(struct ata_link *link,
207 enum ata_lpm_policy policy, unsigned hints)
208{
209 return -EINVAL;
210}
211
88fcd562
TH		 212static inline int sata_pmp_attach(struct ata_device *dev)
213{
214 return -EINVAL;
215}
216#endif /* CONFIG_SATA_PMP */
48515f6c 217
90088bb4 218/* libata-sff.c */
127102ae 219#ifdef CONFIG_ATA_SFF
c429137a 220extern void ata_sff_flush_pio_task(struct ata_port *ap);
270390e1
TH		 221extern void ata_sff_port_init(struct ata_port *ap);
222extern int ata_sff_init(void);
223extern void ata_sff_exit(void);
224#else /* CONFIG_ATA_SFF */
c429137a
TH		 225static inline void ata_sff_flush_pio_task(struct ata_port *ap)
226{ }
270390e1
TH		 227static inline void ata_sff_port_init(struct ata_port *ap)
228{ }
229static inline int ata_sff_init(void)
230{ return 0; }
231static inline void ata_sff_exit(void)
232{ }
127102ae 233#endif /* CONFIG_ATA_SFF */
77a527ea 234
afe75951
AL		 235/* libata-zpodd.c */
236#ifdef CONFIG_SATA_ZPODD
237void zpodd_init(struct ata_device *dev);
238void zpodd_exit(struct ata_device *dev);
239static inline bool zpodd_dev_enabled(struct ata_device *dev)
240{
241 return dev->zpodd != NULL;
242}
3dc67440 243void zpodd_on_suspend(struct ata_device *dev);
21334205
AL		 244bool zpodd_zpready(struct ata_device *dev);
245void zpodd_enable_run_wake(struct ata_device *dev);
246void zpodd_disable_run_wake(struct ata_device *dev);
247void zpodd_post_poweron(struct ata_device *dev);
afe75951
AL		 248#else /* CONFIG_SATA_ZPODD */
249static inline void zpodd_init(struct ata_device *dev) {}
250static inline void zpodd_exit(struct ata_device *dev) {}
251static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; }
3dc67440 252static inline void zpodd_on_suspend(struct ata_device *dev) {}
21334205
AL		 253static inline bool zpodd_zpready(struct ata_device *dev) { return false; }
254static inline void zpodd_enable_run_wake(struct ata_device *dev) {}
255static inline void zpodd_disable_run_wake(struct ata_device *dev) {}
256static inline void zpodd_post_poweron(struct ata_device *dev) {}
afe75951
AL		 257#endif /* CONFIG_SATA_ZPODD */
258
1da177e4 259#endif /* __LIBATA_H__ */
Linux 6.x block layer and io_uring tree(s)