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 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_zac(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_queued_cmd *qc);
92extern void __ata_qc_complete(struct ata_queued_cmd *qc);
93extern int atapi_check_dma(struct ata_queued_cmd *qc);
94extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
95extern bool ata_phys_link_online(struct ata_link *link);
96extern bool ata_phys_link_offline(struct ata_link *link);
97extern void ata_dev_init(struct ata_device *dev);
98extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
99extern int sata_link_init_spd(struct ata_link *link);
100extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
101extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
102extern const char *sata_spd_string(unsigned int spd);
103extern unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
104 u8 page, void *buf, unsigned int sectors);
105
106#define to_ata_port(d) container_of(d, struct ata_port, tdev)
107
108/* libata-sata.c */
109#ifdef CONFIG_SATA_HOST
110int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
111int ata_eh_get_ncq_success_sense(struct ata_link *link);
112#else
113static inline int sata_down_spd_limit(struct ata_link *link, u32 spd_limit)
114{
115 return -EOPNOTSUPP;
116}
117static inline int ata_eh_get_ncq_success_sense(struct ata_link *link)
118{
119 return -EOPNOTSUPP;
120}
121#endif
122
123/* libata-acpi.c */
124#ifdef CONFIG_ATA_ACPI
125extern unsigned int ata_acpi_gtf_filter;
126extern void ata_acpi_dissociate(struct ata_host *host);
127extern void ata_acpi_on_resume(struct ata_port *ap);
128extern int ata_acpi_on_devcfg(struct ata_device *dev);
129extern void ata_acpi_on_disable(struct ata_device *dev);
130extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
131extern void ata_acpi_bind_port(struct ata_port *ap);
132extern void ata_acpi_bind_dev(struct ata_device *dev);
133extern void ata_acpi_port_power_on(struct ata_port *ap);
134extern bool ata_acpi_dev_manage_restart(struct ata_device *dev);
135extern acpi_handle ata_dev_acpi_handle(struct ata_device *dev);
136#else
137static inline void ata_acpi_dissociate(struct ata_host *host) { }
138static inline void ata_acpi_on_resume(struct ata_port *ap) { }
139static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
140static inline void ata_acpi_on_disable(struct ata_device *dev) { }
141static inline void ata_acpi_set_state(struct ata_port *ap,
142 pm_message_t state) { }
143static inline void ata_acpi_bind_port(struct ata_port *ap) {}
144static inline void ata_acpi_bind_dev(struct ata_device *dev) {}
145static inline void ata_acpi_port_power_on(struct ata_port *ap) {}
146static inline bool ata_acpi_dev_manage_restart(struct ata_device *dev) { return 0; }
147#endif
148
149/* libata-scsi.c */
150extern struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
151 const struct scsi_device *scsidev);
152extern int ata_scsi_add_hosts(struct ata_host *host,
153 const struct scsi_host_template *sht);
154extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
155extern bool ata_scsi_offline_dev(struct ata_device *dev);
156extern bool ata_scsi_sense_is_valid(u8 sk, u8 asc, u8 ascq);
157extern void ata_scsi_set_sense(struct ata_device *dev,
158 struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq);
159extern void ata_scsi_media_change_notify(struct ata_device *dev);
160extern void ata_scsi_hotplug(struct work_struct *work);
161extern void ata_scsi_dev_rescan(struct work_struct *work);
162extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
163 unsigned int id, u64 lun);
164void ata_scsi_sdev_config(struct scsi_device *sdev);
165int ata_scsi_dev_config(struct scsi_device *sdev, struct queue_limits *lim,
166 struct ata_device *dev);
167int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev);
168
169/* libata-eh.c */
170extern unsigned int ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
171extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
172extern void ata_eh_acquire(struct ata_port *ap);
173extern void ata_eh_release(struct ata_port *ap);
174extern void ata_scsi_error(struct Scsi_Host *host);
175extern void ata_eh_fastdrain_timerfn(struct timer_list *t);
176extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
177extern void ata_dev_disable(struct ata_device *dev);
178extern void ata_eh_detach_dev(struct ata_device *dev);
179extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
180 unsigned int action);
181extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
182 unsigned int action);
183extern void ata_eh_autopsy(struct ata_port *ap);
184const char *ata_get_cmd_name(u8 command);
185extern void ata_eh_report(struct ata_port *ap);
186extern int ata_eh_reset(struct ata_link *link, int classify,
187 struct ata_reset_operations *reset_ops);
188extern int ata_eh_recover(struct ata_port *ap,
189 struct ata_reset_operations *reset_ops,
190 struct ata_link **r_failed_disk);
191extern void ata_eh_finish(struct ata_port *ap);
192extern int ata_ering_map(struct ata_ering *ering,
193 int (*map_fn)(struct ata_ering_entry *, void *),
194 void *arg);
195enum scsi_disposition ata_eh_decide_disposition(struct ata_queued_cmd *qc);
196extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key);
197extern unsigned int atapi_eh_request_sense(struct ata_device *dev,
198 u8 *sense_buf, u8 dfl_sense_key);
199
200/* libata-pmp.c */
201#ifdef CONFIG_SATA_PMP
202extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
203extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
204extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
205 unsigned hints);
206extern int sata_pmp_attach(struct ata_device *dev);
207#else /* CONFIG_SATA_PMP */
208static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
209{
210 return -EINVAL;
211}
212
213static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
214{
215 return -EINVAL;
216}
217
218static inline int sata_pmp_set_lpm(struct ata_link *link,
219 enum ata_lpm_policy policy, unsigned hints)
220{
221 return -EINVAL;
222}
223
224static inline int sata_pmp_attach(struct ata_device *dev)
225{
226 return -EINVAL;
227}
228#endif /* CONFIG_SATA_PMP */
229
230/* libata-sff.c */
231#ifdef CONFIG_ATA_SFF
232extern void ata_sff_flush_pio_task(struct ata_port *ap);
233extern void ata_sff_port_init(struct ata_port *ap);
234extern int ata_sff_init(void);
235extern void ata_sff_exit(void);
236#else /* CONFIG_ATA_SFF */
237static inline void ata_sff_flush_pio_task(struct ata_port *ap)
238{ }
239static inline void ata_sff_port_init(struct ata_port *ap)
240{ }
241static inline int ata_sff_init(void)
242{ return 0; }
243static inline void ata_sff_exit(void)
244{ }
245#endif /* CONFIG_ATA_SFF */
246
247/* libata-zpodd.c */
248#ifdef CONFIG_SATA_ZPODD
249void zpodd_init(struct ata_device *dev);
250void zpodd_exit(struct ata_device *dev);
251static inline bool zpodd_dev_enabled(struct ata_device *dev)
252{
253 return dev->zpodd != NULL;
254}
255void zpodd_on_suspend(struct ata_device *dev);
256bool zpodd_zpready(struct ata_device *dev);
257void zpodd_enable_run_wake(struct ata_device *dev);
258void zpodd_disable_run_wake(struct ata_device *dev);
259void zpodd_post_poweron(struct ata_device *dev);
260#else /* CONFIG_SATA_ZPODD */
261static inline void zpodd_init(struct ata_device *dev) {}
262static inline void zpodd_exit(struct ata_device *dev) {}
263static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; }
264static inline void zpodd_on_suspend(struct ata_device *dev) {}
265static inline bool zpodd_zpready(struct ata_device *dev) { return false; }
266static inline void zpodd_enable_run_wake(struct ata_device *dev) {}
267static inline void zpodd_disable_run_wake(struct ata_device *dev) {}
268static inline void zpodd_post_poweron(struct ata_device *dev) {}
269#endif /* CONFIG_SATA_ZPODD */
270
271#endif /* __LIBATA_H__ */