Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * libata.h - helper library for ATA
4 *
5 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
6 * Copyright 2003-2004 Jeff Garzik
7 *
8 * libata documentation is available via 'make {ps|pdf}docs',
9 * as Documentation/driver-api/libata.rst
10 */
11
12#ifndef __LIBATA_H__
13#define __LIBATA_H__
14
15#define DRV_NAME "libata"
16#define DRV_VERSION "3.00" /* must be exactly four chars */
17
18/* libata-core.c */
19enum {
20 /* flags for ata_dev_read_id() */
21 ATA_READID_POSTRESET = (1 << 0), /* reading ID after reset */
22
23 /* selector for ata_down_xfermask_limit() */
24 ATA_DNXFER_PIO = 0, /* speed down PIO */
25 ATA_DNXFER_DMA = 1, /* speed down DMA */
26 ATA_DNXFER_40C = 2, /* apply 40c cable limit */
27 ATA_DNXFER_FORCE_PIO = 3, /* force PIO */
28 ATA_DNXFER_FORCE_PIO0 = 4, /* force PIO0 */
29
30 ATA_DNXFER_QUIET = (1 << 31),
31};
32
33extern atomic_t ata_print_id;
34extern int atapi_passthru16;
35extern int libata_fua;
36extern int libata_noacpi;
37extern int libata_allow_tpm;
38extern const struct device_type ata_port_type;
39extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
40extern void ata_force_cbl(struct ata_port *ap);
41extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
42extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
43extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev, int tag);
44extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
45 u64 block, u32 n_block, unsigned int tf_flags,
46 unsigned int tag, int class);
47extern u64 ata_tf_read_block(const struct ata_taskfile *tf,
48 struct ata_device *dev);
49extern unsigned ata_exec_internal(struct ata_device *dev,
50 struct ata_taskfile *tf, const u8 *cdb,
51 int dma_dir, void *buf, unsigned int buflen,
52 unsigned long timeout);
53extern unsigned ata_exec_internal_sg(struct ata_device *dev,
54 struct ata_taskfile *tf, const u8 *cdb,
55 int dma_dir, struct scatterlist *sg,
56 unsigned int n_elem, unsigned long timeout);
57extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
58 int (*check_ready)(struct ata_link *link));
59extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
60 unsigned int flags, u16 *id);
61extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
62extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
63 unsigned int readid_flags);
64extern int ata_dev_configure(struct ata_device *dev);
65extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
66extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
67extern unsigned int ata_dev_set_feature(struct ata_device *dev,
68 u8 enable, u8 feature);
69extern void ata_qc_free(struct ata_queued_cmd *qc);
70extern void ata_qc_issue(struct ata_queued_cmd *qc);
71extern void __ata_qc_complete(struct ata_queued_cmd *qc);
72extern int atapi_check_dma(struct ata_queued_cmd *qc);
73extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
74extern bool ata_phys_link_online(struct ata_link *link);
75extern bool ata_phys_link_offline(struct ata_link *link);
76extern void ata_dev_init(struct ata_device *dev);
77extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
78extern int sata_link_init_spd(struct ata_link *link);
79extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
80extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
81extern struct ata_port *ata_port_alloc(struct ata_host *host);
82extern const char *sata_spd_string(unsigned int spd);
83extern int ata_port_probe(struct ata_port *ap);
84extern void __ata_port_probe(struct ata_port *ap);
85extern unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
86 u8 page, void *buf, unsigned int sectors);
87
88#define to_ata_port(d) container_of(d, struct ata_port, tdev)
89
90/* libata-acpi.c */
91#ifdef CONFIG_ATA_ACPI
92extern unsigned int ata_acpi_gtf_filter;
93extern void ata_acpi_dissociate(struct ata_host *host);
94extern int ata_acpi_on_suspend(struct ata_port *ap);
95extern void ata_acpi_on_resume(struct ata_port *ap);
96extern int ata_acpi_on_devcfg(struct ata_device *dev);
97extern void ata_acpi_on_disable(struct ata_device *dev);
98extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
99extern void ata_acpi_bind_port(struct ata_port *ap);
100extern void ata_acpi_bind_dev(struct ata_device *dev);
101extern acpi_handle ata_dev_acpi_handle(struct ata_device *dev);
102#else
103static inline void ata_acpi_dissociate(struct ata_host *host) { }
104static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
105static inline void ata_acpi_on_resume(struct ata_port *ap) { }
106static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
107static inline void ata_acpi_on_disable(struct ata_device *dev) { }
108static inline void ata_acpi_set_state(struct ata_port *ap,
109 pm_message_t state) { }
110static inline void ata_acpi_bind_port(struct ata_port *ap) {}
111static inline void ata_acpi_bind_dev(struct ata_device *dev) {}
112#endif
113
114/* libata-scsi.c */
115extern int ata_scsi_add_hosts(struct ata_host *host,
116 struct scsi_host_template *sht);
117extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
118extern int ata_scsi_offline_dev(struct ata_device *dev);
119extern void ata_scsi_set_sense(struct ata_device *dev,
120 struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq);
121extern void ata_scsi_set_sense_information(struct ata_device *dev,
122 struct scsi_cmnd *cmd,
123 const struct ata_taskfile *tf);
124extern void ata_scsi_media_change_notify(struct ata_device *dev);
125extern void ata_scsi_hotplug(struct work_struct *work);
126extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
127extern void ata_scsi_dev_rescan(struct work_struct *work);
128extern int ata_bus_probe(struct ata_port *ap);
129extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
130 unsigned int id, u64 lun);
131int ata_sas_allocate_tag(struct ata_port *ap);
132void ata_sas_free_tag(unsigned int tag, struct ata_port *ap);
133
134
135/* libata-eh.c */
136extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
137extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
138extern void ata_eh_acquire(struct ata_port *ap);
139extern void ata_eh_release(struct ata_port *ap);
140extern void ata_scsi_error(struct Scsi_Host *host);
141extern void ata_eh_fastdrain_timerfn(struct timer_list *t);
142extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
143extern void ata_dev_disable(struct ata_device *dev);
144extern void ata_eh_detach_dev(struct ata_device *dev);
145extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
146 unsigned int action);
147extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
148 unsigned int action);
149extern void ata_eh_autopsy(struct ata_port *ap);
150const char *ata_get_cmd_descript(u8 command);
151extern void ata_eh_report(struct ata_port *ap);
152extern int ata_eh_reset(struct ata_link *link, int classify,
153 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
154 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
155extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
156extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
157 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
158 ata_postreset_fn_t postreset,
159 struct ata_link **r_failed_disk);
160extern void ata_eh_finish(struct ata_port *ap);
161extern int ata_ering_map(struct ata_ering *ering,
162 int (*map_fn)(struct ata_ering_entry *, void *),
163 void *arg);
164extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key);
165extern unsigned int atapi_eh_request_sense(struct ata_device *dev,
166 u8 *sense_buf, u8 dfl_sense_key);
167
168/* libata-pmp.c */
169#ifdef CONFIG_SATA_PMP
170extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
171extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
172extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
173 unsigned hints);
174extern int sata_pmp_attach(struct ata_device *dev);
175#else /* CONFIG_SATA_PMP */
176static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
177{
178 return -EINVAL;
179}
180
181static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
182{
183 return -EINVAL;
184}
185
186static inline int sata_pmp_set_lpm(struct ata_link *link,
187 enum ata_lpm_policy policy, unsigned hints)
188{
189 return -EINVAL;
190}
191
192static inline int sata_pmp_attach(struct ata_device *dev)
193{
194 return -EINVAL;
195}
196#endif /* CONFIG_SATA_PMP */
197
198/* libata-sff.c */
199#ifdef CONFIG_ATA_SFF
200extern void ata_sff_flush_pio_task(struct ata_port *ap);
201extern void ata_sff_port_init(struct ata_port *ap);
202extern int ata_sff_init(void);
203extern void ata_sff_exit(void);
204#else /* CONFIG_ATA_SFF */
205static inline void ata_sff_flush_pio_task(struct ata_port *ap)
206{ }
207static inline void ata_sff_port_init(struct ata_port *ap)
208{ }
209static inline int ata_sff_init(void)
210{ return 0; }
211static inline void ata_sff_exit(void)
212{ }
213#endif /* CONFIG_ATA_SFF */
214
215/* libata-zpodd.c */
216#ifdef CONFIG_SATA_ZPODD
217void zpodd_init(struct ata_device *dev);
218void zpodd_exit(struct ata_device *dev);
219static inline bool zpodd_dev_enabled(struct ata_device *dev)
220{
221 return dev->zpodd != NULL;
222}
223void zpodd_on_suspend(struct ata_device *dev);
224bool zpodd_zpready(struct ata_device *dev);
225void zpodd_enable_run_wake(struct ata_device *dev);
226void zpodd_disable_run_wake(struct ata_device *dev);
227void zpodd_post_poweron(struct ata_device *dev);
228#else /* CONFIG_SATA_ZPODD */
229static inline void zpodd_init(struct ata_device *dev) {}
230static inline void zpodd_exit(struct ata_device *dev) {}
231static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; }
232static inline void zpodd_on_suspend(struct ata_device *dev) {}
233static inline bool zpodd_zpready(struct ata_device *dev) { return false; }
234static inline void zpodd_enable_run_wake(struct ata_device *dev) {}
235static inline void zpodd_disable_run_wake(struct ata_device *dev) {}
236static inline void zpodd_post_poweron(struct ata_device *dev) {}
237#endif /* CONFIG_SATA_ZPODD */
238
239#endif /* __LIBATA_H__ */