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