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);
40#ifdef CONFIG_ATA_FORCE
41extern void ata_force_cbl(struct ata_port *ap);
42#else
43static inline void ata_force_cbl(struct ata_port *ap) { }
44#endif
45extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
46extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
47extern int ata_build_rw_tf(struct ata_queued_cmd *qc, u64 block, u32 n_block,
48 unsigned int tf_flags, int class);
49extern u64 ata_tf_read_block(const struct ata_taskfile *tf,
50 struct ata_device *dev);
51extern unsigned ata_exec_internal(struct ata_device *dev,
52 struct ata_taskfile *tf, const u8 *cdb,
53 int dma_dir, void *buf, unsigned int buflen,
54 unsigned int timeout);
55extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
56 int (*check_ready)(struct ata_link *link));
57extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
58 unsigned int flags, u16 *id);
59extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
60extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
61 unsigned int readid_flags);
62extern int ata_dev_configure(struct ata_device *dev);
63extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
64extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
65extern unsigned int ata_dev_set_feature(struct ata_device *dev,
66 u8 subcmd, u8 action);
67extern void ata_qc_free(struct ata_queued_cmd *qc);
68extern void ata_qc_issue(struct ata_queued_cmd *qc);
69extern void __ata_qc_complete(struct ata_queued_cmd *qc);
70extern int atapi_check_dma(struct ata_queued_cmd *qc);
71extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
72extern bool ata_phys_link_online(struct ata_link *link);
73extern bool ata_phys_link_offline(struct ata_link *link);
74extern void ata_dev_init(struct ata_device *dev);
75extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
76extern int sata_link_init_spd(struct ata_link *link);
77extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
78extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
79extern struct ata_port *ata_port_alloc(struct ata_host *host);
80extern const char *sata_spd_string(unsigned int spd);
81extern int ata_port_probe(struct ata_port *ap);
82extern void __ata_port_probe(struct ata_port *ap);
83extern unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
84 u8 page, void *buf, unsigned int sectors);
85
86#define to_ata_port(d) container_of(d, struct ata_port, tdev)
87
88/* libata-acpi.c */
89#ifdef CONFIG_ATA_ACPI
90extern unsigned int ata_acpi_gtf_filter;
91extern void ata_acpi_dissociate(struct ata_host *host);
92extern void ata_acpi_on_resume(struct ata_port *ap);
93extern int ata_acpi_on_devcfg(struct ata_device *dev);
94extern void ata_acpi_on_disable(struct ata_device *dev);
95extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
96extern void ata_acpi_bind_port(struct ata_port *ap);
97extern void ata_acpi_bind_dev(struct ata_device *dev);
98extern acpi_handle ata_dev_acpi_handle(struct ata_device *dev);
99#else
100static inline void ata_acpi_dissociate(struct ata_host *host) { }
101static inline void ata_acpi_on_resume(struct ata_port *ap) { }
102static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
103static inline void ata_acpi_on_disable(struct ata_device *dev) { }
104static inline void ata_acpi_set_state(struct ata_port *ap,
105 pm_message_t state) { }
106static inline void ata_acpi_bind_port(struct ata_port *ap) {}
107static inline void ata_acpi_bind_dev(struct ata_device *dev) {}
108#endif
109
110/* libata-scsi.c */
111extern struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
112 const struct scsi_device *scsidev);
113extern int ata_scsi_add_hosts(struct ata_host *host,
114 struct scsi_host_template *sht);
115extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
116extern int ata_scsi_offline_dev(struct ata_device *dev);
117extern bool ata_scsi_sense_is_valid(u8 sk, u8 asc, u8 ascq);
118extern void ata_scsi_set_sense(struct ata_device *dev,
119 struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq);
120extern void ata_scsi_set_sense_information(struct ata_device *dev,
121 struct scsi_cmnd *cmd,
122 const struct ata_taskfile *tf);
123extern void ata_scsi_media_change_notify(struct ata_device *dev);
124extern void ata_scsi_hotplug(struct work_struct *work);
125extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
126extern void ata_scsi_dev_rescan(struct work_struct *work);
127extern int ata_bus_probe(struct ata_port *ap);
128extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
129 unsigned int id, u64 lun);
130void ata_scsi_sdev_config(struct scsi_device *sdev);
131int ata_scsi_dev_config(struct scsi_device *sdev, struct ata_device *dev);
132int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev);
133
134/* libata-eh.c */
135extern unsigned int ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
136extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
137extern void ata_eh_acquire(struct ata_port *ap);
138extern void ata_eh_release(struct ata_port *ap);
139extern void ata_scsi_error(struct Scsi_Host *host);
140extern void ata_eh_fastdrain_timerfn(struct timer_list *t);
141extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
142extern void ata_dev_disable(struct ata_device *dev);
143extern void ata_eh_detach_dev(struct ata_device *dev);
144extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
145 unsigned int action);
146extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
147 unsigned int action);
148extern void ata_eh_autopsy(struct ata_port *ap);
149const char *ata_get_cmd_name(u8 command);
150extern void ata_eh_report(struct ata_port *ap);
151extern int ata_eh_reset(struct ata_link *link, int classify,
152 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
153 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
154extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
155extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
156 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
157 ata_postreset_fn_t postreset,
158 struct ata_link **r_failed_disk);
159extern void ata_eh_finish(struct ata_port *ap);
160extern int ata_ering_map(struct ata_ering *ering,
161 int (*map_fn)(struct ata_ering_entry *, void *),
162 void *arg);
163extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key);
164extern unsigned int atapi_eh_request_sense(struct ata_device *dev,
165 u8 *sense_buf, u8 dfl_sense_key);
166
167/* libata-pmp.c */
168#ifdef CONFIG_SATA_PMP
169extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
170extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
171extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
172 unsigned hints);
173extern int sata_pmp_attach(struct ata_device *dev);
174#else /* CONFIG_SATA_PMP */
175static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
176{
177 return -EINVAL;
178}
179
180static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
181{
182 return -EINVAL;
183}
184
185static inline int sata_pmp_set_lpm(struct ata_link *link,
186 enum ata_lpm_policy policy, unsigned hints)
187{
188 return -EINVAL;
189}
190
191static inline int sata_pmp_attach(struct ata_device *dev)
192{
193 return -EINVAL;
194}
195#endif /* CONFIG_SATA_PMP */
196
197/* libata-sff.c */
198#ifdef CONFIG_ATA_SFF
199extern void ata_sff_flush_pio_task(struct ata_port *ap);
200extern void ata_sff_port_init(struct ata_port *ap);
201extern int ata_sff_init(void);
202extern void ata_sff_exit(void);
203#else /* CONFIG_ATA_SFF */
204static inline void ata_sff_flush_pio_task(struct ata_port *ap)
205{ }
206static inline void ata_sff_port_init(struct ata_port *ap)
207{ }
208static inline int ata_sff_init(void)
209{ return 0; }
210static inline void ata_sff_exit(void)
211{ }
212#endif /* CONFIG_ATA_SFF */
213
214/* libata-zpodd.c */
215#ifdef CONFIG_SATA_ZPODD
216void zpodd_init(struct ata_device *dev);
217void zpodd_exit(struct ata_device *dev);
218static inline bool zpodd_dev_enabled(struct ata_device *dev)
219{
220 return dev->zpodd != NULL;
221}
222void zpodd_on_suspend(struct ata_device *dev);
223bool zpodd_zpready(struct ata_device *dev);
224void zpodd_enable_run_wake(struct ata_device *dev);
225void zpodd_disable_run_wake(struct ata_device *dev);
226void zpodd_post_poweron(struct ata_device *dev);
227#else /* CONFIG_SATA_ZPODD */
228static inline void zpodd_init(struct ata_device *dev) {}
229static inline void zpodd_exit(struct ata_device *dev) {}
230static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; }
231static inline void zpodd_on_suspend(struct ata_device *dev) {}
232static inline bool zpodd_zpready(struct ata_device *dev) { return false; }
233static inline void zpodd_enable_run_wake(struct ata_device *dev) {}
234static inline void zpodd_disable_run_wake(struct ata_device *dev) {}
235static inline void zpodd_post_poweron(struct ata_device *dev) {}
236#endif /* CONFIG_SATA_ZPODD */
237
238#endif /* __LIBATA_H__ */