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