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