projects/linux·blob master · refs

292 lines · 11.4 KiB

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 int atapi_passthru16;
36extern int libata_fua;
37extern int libata_noacpi;
38extern int libata_allow_tpm;
39extern const struct device_type ata_port_type;
40extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
41
42static inline bool ata_sstatus_online(u32 sstatus)
43{
44 return (sstatus & 0xf) == 0x3;
45}
46
47static inline bool ata_dev_is_zoned(struct ata_device *dev)
48{
49 /* Host managed device or host aware device */
50 return dev->class == ATA_DEV_ZAC ||
51 ata_id_zoned_cap(dev->id) == 0x01;
52}
53
54static inline bool ata_port_eh_scheduled(struct ata_port *ap)
55{
56 return ap->pflags & (ATA_PFLAG_EH_PENDING | ATA_PFLAG_EH_IN_PROGRESS);
57}
58
59#ifdef CONFIG_ATA_FORCE
60extern void ata_force_cbl(struct ata_port *ap);
61#else
62static inline void ata_force_cbl(struct ata_port *ap) { }
63#endif
64extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
65extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
66extern int ata_build_rw_tf(struct ata_queued_cmd *qc, u64 block, u32 n_block,
67 unsigned int tf_flags, int dld, int class);
68extern u64 ata_tf_read_block(const struct ata_taskfile *tf,
69 struct ata_device *dev);
70unsigned int ata_exec_internal(struct ata_device *dev, struct ata_taskfile *tf,
71 const u8 *cdb, enum dma_data_direction dma_dir,
72 void *buf, unsigned int buflen,
73 unsigned int timeout);
74extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
75 int (*check_ready)(struct ata_link *link));
76extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
77 unsigned int flags, u16 *id);
78extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
79extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
80 unsigned int readid_flags);
81extern int ata_dev_configure(struct ata_device *dev);
82extern bool ata_dev_power_init_tf(struct ata_device *dev,
83 struct ata_taskfile *tf, bool set_active);
84extern void ata_dev_power_set_standby(struct ata_device *dev);
85extern void ata_dev_power_set_active(struct ata_device *dev);
86void ata_dev_free_resources(struct ata_device *dev);
87extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
88extern unsigned int ata_dev_set_feature(struct ata_device *dev,
89 u8 subcmd, u8 action);
90extern void ata_qc_free(struct ata_queued_cmd *qc);
91extern void ata_qc_issue(struct ata_port *ap, struct ata_queued_cmd *qc)
92 __must_hold(ap->lock);
93extern void __ata_qc_complete(struct ata_queued_cmd *qc);
94extern int atapi_check_dma(struct ata_queued_cmd *qc);
95extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
96extern bool ata_phys_link_online(struct ata_link *link);
97extern bool ata_phys_link_offline(struct ata_link *link);
98bool ata_adapter_is_online(struct ata_port *ap);
99extern void ata_dev_init(struct ata_device *dev);
100extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
101extern int sata_link_init_spd(struct ata_link *link);
102extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
103extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
104extern const char *sata_spd_string(unsigned int spd);
105extern unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
106 u8 page, void *buf, unsigned int sectors);
107
108#define to_ata_port(d) container_of(d, struct ata_port, tdev)
109
110/* libata-sata.c */
111#ifdef CONFIG_SATA_HOST
112int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
113int ata_eh_get_ncq_success_sense(struct ata_link *link);
114#else
115static inline int sata_down_spd_limit(struct ata_link *link, u32 spd_limit)
116{
117 return -EOPNOTSUPP;
118}
119static inline int ata_eh_get_ncq_success_sense(struct ata_link *link)
120{
121 return -EOPNOTSUPP;
122}
123#endif
124
125/* libata-acpi.c */
126#ifdef CONFIG_ATA_ACPI
127extern unsigned int ata_acpi_gtf_filter;
128extern void ata_acpi_dissociate(struct ata_host *host);
129extern void ata_acpi_on_resume(struct ata_port *ap);
130extern int ata_acpi_on_devcfg(struct ata_device *dev);
131extern void ata_acpi_on_disable(struct ata_device *dev);
132extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
133extern void ata_acpi_bind_port(struct ata_port *ap);
134extern void ata_acpi_bind_dev(struct ata_device *dev);
135extern void ata_acpi_port_power_on(struct ata_port *ap);
136extern bool ata_acpi_dev_manage_restart(struct ata_device *dev);
137extern acpi_handle ata_dev_acpi_handle(struct ata_device *dev);
138#else
139static inline void ata_acpi_dissociate(struct ata_host *host) { }
140static inline void ata_acpi_on_resume(struct ata_port *ap) { }
141static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
142static inline void ata_acpi_on_disable(struct ata_device *dev) { }
143static inline void ata_acpi_set_state(struct ata_port *ap,
144 pm_message_t state) { }
145static inline void ata_acpi_bind_port(struct ata_port *ap) {}
146static inline void ata_acpi_bind_dev(struct ata_device *dev) {}
147static inline void ata_acpi_port_power_on(struct ata_port *ap) {}
148static inline bool ata_acpi_dev_manage_restart(struct ata_device *dev) { return 0; }
149#endif
150
151/* libata-scsi.c */
152#define ATA_SCSI_RBUF_SIZE 2048
153
154/*
155 * Maximum number of concurrent positioning ranges (CPR) supported. The ACS
156 * specifications allow up to 255, but we limit this to the number of CPR
157 * descriptors that fit in the rbuf buffer used to emit VPD page B9h.
158 */
159#define ATA_DEV_MAX_CPR min(255, ((ATA_SCSI_RBUF_SIZE - 64) / 32))
160
161extern struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
162 const struct scsi_device *scsidev);
163extern int ata_scsi_add_hosts(struct ata_host *host,
164 const struct scsi_host_template *sht);
165extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
166extern bool ata_scsi_offline_dev(struct ata_device *dev);
167extern bool ata_scsi_sense_is_valid(u8 sk, u8 asc, u8 ascq);
168extern void ata_scsi_set_sense(struct ata_device *dev,
169 struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq);
170extern void ata_scsi_media_change_notify(struct ata_device *dev);
171extern void ata_scsi_hotplug(struct work_struct *work);
172extern void ata_scsi_dev_rescan(struct work_struct *work);
173extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
174 unsigned int id, u64 lun);
175void ata_scsi_sdev_config(struct scsi_device *sdev);
176int ata_scsi_dev_config(struct scsi_device *sdev, struct queue_limits *lim,
177 struct ata_device *dev);
178enum scsi_qc_status __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
179 struct ata_device *dev,
180 struct ata_port *ap)
181 __must_hold(ap->lock);
182void ata_scsi_deferred_qc_work(struct work_struct *work);
183enum scsi_timeout_action ata_scsi_requeue_deferred_qc(struct ata_port *ap,
184 struct scsi_cmnd *scmd);
185
186/* libata-eh.c */
187extern unsigned int ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
188extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
189extern void ata_eh_acquire(struct ata_port *ap)
190 __acquires(&ap->host->eh_mutex);
191extern void ata_eh_release(struct ata_port *ap)
192 __releases(&ap->host->eh_mutex);
193extern void ata_scsi_error(struct Scsi_Host *host);
194extern void ata_eh_fastdrain_timerfn(struct timer_list *t);
195extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
196extern void ata_dev_disable(struct ata_device *dev);
197extern void ata_eh_detach_dev(struct ata_device *dev);
198extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
199 unsigned int action);
200extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
201 unsigned int action);
202extern void ata_eh_autopsy(struct ata_port *ap);
203const char *ata_get_cmd_name(u8 command);
204extern void ata_eh_report(struct ata_port *ap);
205extern int ata_eh_reset(struct ata_port *ap, struct ata_link *link,
206 int classify, struct ata_reset_operations *reset_ops)
207 __must_hold(&ap->host->eh_mutex);
208extern int ata_eh_recover(struct ata_port *ap,
209 struct ata_reset_operations *reset_ops,
210 struct ata_link **r_failed_disk)
211 __must_hold(&ap->host->eh_mutex);
212extern void ata_eh_finish(struct ata_port *ap);
213extern int ata_ering_map(struct ata_ering *ering,
214 int (*map_fn)(struct ata_ering_entry *, void *),
215 void *arg);
216enum scsi_disposition ata_eh_decide_disposition(struct ata_queued_cmd *qc);
217extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key);
218extern unsigned int atapi_eh_request_sense(struct ata_device *dev,
219 u8 *sense_buf, u8 dfl_sense_key);
220
221/* libata-pmp.c */
222#ifdef CONFIG_SATA_PMP
223extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
224extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
225extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
226 unsigned hints);
227extern int sata_pmp_attach(struct ata_device *dev);
228#else /* CONFIG_SATA_PMP */
229static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
230{
231 return -EINVAL;
232}
233
234static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
235{
236 return -EINVAL;
237}
238
239static inline int sata_pmp_set_lpm(struct ata_link *link,
240 enum ata_lpm_policy policy, unsigned hints)
241{
242 return -EINVAL;
243}
244
245static inline int sata_pmp_attach(struct ata_device *dev)
246{
247 return -EINVAL;
248}
249#endif /* CONFIG_SATA_PMP */
250
251/* libata-sff.c */
252#ifdef CONFIG_ATA_SFF
253extern void ata_sff_flush_pio_task(struct ata_port *ap);
254extern void ata_sff_port_init(struct ata_port *ap);
255extern int ata_sff_init(void);
256extern void ata_sff_exit(void);
257#else /* CONFIG_ATA_SFF */
258static inline void ata_sff_flush_pio_task(struct ata_port *ap)
259{ }
260static inline void ata_sff_port_init(struct ata_port *ap)
261{ }
262static inline int ata_sff_init(void)
263{ return 0; }
264static inline void ata_sff_exit(void)
265{ }
266#endif /* CONFIG_ATA_SFF */
267
268/* libata-zpodd.c */
269#ifdef CONFIG_SATA_ZPODD
270void zpodd_init(struct ata_device *dev);
271void zpodd_exit(struct ata_device *dev);
272static inline bool zpodd_dev_enabled(struct ata_device *dev)
273{
274 return dev->zpodd != NULL;
275}
276void zpodd_on_suspend(struct ata_device *dev);
277bool zpodd_zpready(struct ata_device *dev);
278void zpodd_enable_run_wake(struct ata_device *dev);
279void zpodd_disable_run_wake(struct ata_device *dev);
280void zpodd_post_poweron(struct ata_device *dev);
281#else /* CONFIG_SATA_ZPODD */
282static inline void zpodd_init(struct ata_device *dev) {}
283static inline void zpodd_exit(struct ata_device *dev) {}
284static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; }
285static inline void zpodd_on_suspend(struct ata_device *dev) {}
286static inline bool zpodd_zpready(struct ata_device *dev) { return false; }
287static inline void zpodd_enable_run_wake(struct ata_device *dev) {}
288static inline void zpodd_disable_run_wake(struct ata_device *dev) {}
289static inline void zpodd_post_poweron(struct ata_device *dev) {}
290#endif /* CONFIG_SATA_ZPODD */
291
292#endif /* __LIBATA_H__ */