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