Loading...
1/*
2 * libata.h - helper library for ATA
3 *
4 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
5 * Copyright 2003-2004 Jeff Garzik
6 *
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2, or (at your option)
11 * any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; see the file COPYING. If not, write to
20 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
21 *
22 *
23 * libata documentation is available via 'make {ps|pdf}docs',
24 * as Documentation/DocBook/libata.*
25 *
26 */
27
28#ifndef __LIBATA_H__
29#define __LIBATA_H__
30
31#define DRV_NAME "libata"
32#define DRV_VERSION "3.00" /* must be exactly four chars */
33
34struct ata_scsi_args {
35 struct ata_device *dev;
36 u16 *id;
37 struct scsi_cmnd *cmd;
38 void (*done)(struct scsi_cmnd *);
39};
40
41/* libata-core.c */
42enum {
43 /* flags for ata_dev_read_id() */
44 ATA_READID_POSTRESET = (1 << 0), /* reading ID after reset */
45
46 /* selector for ata_down_xfermask_limit() */
47 ATA_DNXFER_PIO = 0, /* speed down PIO */
48 ATA_DNXFER_DMA = 1, /* speed down DMA */
49 ATA_DNXFER_40C = 2, /* apply 40c cable limit */
50 ATA_DNXFER_FORCE_PIO = 3, /* force PIO */
51 ATA_DNXFER_FORCE_PIO0 = 4, /* force PIO0 */
52
53 ATA_DNXFER_QUIET = (1 << 31),
54};
55
56extern atomic_t ata_print_id;
57extern int atapi_passthru16;
58extern int libata_fua;
59extern int libata_noacpi;
60extern int libata_allow_tpm;
61extern struct device_type ata_port_type;
62extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
63extern void ata_force_cbl(struct ata_port *ap);
64extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
65extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
66extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev);
67extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
68 u64 block, u32 n_block, unsigned int tf_flags,
69 unsigned int tag);
70extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev);
71extern unsigned ata_exec_internal(struct ata_device *dev,
72 struct ata_taskfile *tf, const u8 *cdb,
73 int dma_dir, void *buf, unsigned int buflen,
74 unsigned long timeout);
75extern unsigned ata_exec_internal_sg(struct ata_device *dev,
76 struct ata_taskfile *tf, const u8 *cdb,
77 int dma_dir, struct scatterlist *sg,
78 unsigned int n_elem, unsigned long timeout);
79extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd);
80extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
81 int (*check_ready)(struct ata_link *link));
82extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
83 unsigned int flags, u16 *id);
84extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
85extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
86 unsigned int readid_flags);
87extern int ata_dev_configure(struct ata_device *dev);
88extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
89extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
90extern unsigned int ata_dev_set_feature(struct ata_device *dev,
91 u8 enable, u8 feature);
92extern void ata_sg_clean(struct ata_queued_cmd *qc);
93extern void ata_qc_free(struct ata_queued_cmd *qc);
94extern void ata_qc_issue(struct ata_queued_cmd *qc);
95extern void __ata_qc_complete(struct ata_queued_cmd *qc);
96extern int atapi_check_dma(struct ata_queued_cmd *qc);
97extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
98extern bool ata_phys_link_online(struct ata_link *link);
99extern bool ata_phys_link_offline(struct ata_link *link);
100extern void ata_dev_init(struct ata_device *dev);
101extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
102extern int sata_link_init_spd(struct ata_link *link);
103extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
104extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
105extern struct ata_port *ata_port_alloc(struct ata_host *host);
106extern const char *sata_spd_string(unsigned int spd);
107extern int ata_port_probe(struct ata_port *ap);
108extern void __ata_port_probe(struct ata_port *ap);
109
110/* libata-acpi.c */
111#ifdef CONFIG_ATA_ACPI
112extern unsigned int ata_acpi_gtf_filter;
113
114extern void ata_acpi_associate_sata_port(struct ata_port *ap);
115extern void ata_acpi_associate(struct ata_host *host);
116extern void ata_acpi_dissociate(struct ata_host *host);
117extern int ata_acpi_on_suspend(struct ata_port *ap);
118extern void ata_acpi_on_resume(struct ata_port *ap);
119extern int ata_acpi_on_devcfg(struct ata_device *dev);
120extern void ata_acpi_on_disable(struct ata_device *dev);
121extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
122#else
123static inline void ata_acpi_associate_sata_port(struct ata_port *ap) { }
124static inline void ata_acpi_associate(struct ata_host *host) { }
125static inline void ata_acpi_dissociate(struct ata_host *host) { }
126static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
127static inline void ata_acpi_on_resume(struct ata_port *ap) { }
128static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
129static inline void ata_acpi_on_disable(struct ata_device *dev) { }
130static inline void ata_acpi_set_state(struct ata_port *ap,
131 pm_message_t state) { }
132#endif
133
134/* libata-scsi.c */
135extern int ata_scsi_add_hosts(struct ata_host *host,
136 struct scsi_host_template *sht);
137extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
138extern int ata_scsi_offline_dev(struct ata_device *dev);
139extern void ata_scsi_media_change_notify(struct ata_device *dev);
140extern void ata_scsi_hotplug(struct work_struct *work);
141extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
142extern void ata_scsi_dev_rescan(struct work_struct *work);
143extern int ata_bus_probe(struct ata_port *ap);
144extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
145 unsigned int id, unsigned int lun);
146
147
148/* libata-eh.c */
149extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
150extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
151extern void ata_eh_acquire(struct ata_port *ap);
152extern void ata_eh_release(struct ata_port *ap);
153extern enum blk_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
154extern void ata_scsi_error(struct Scsi_Host *host);
155extern void ata_eh_fastdrain_timerfn(unsigned long arg);
156extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
157extern void ata_dev_disable(struct ata_device *dev);
158extern void ata_eh_detach_dev(struct ata_device *dev);
159extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
160 unsigned int action);
161extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
162 unsigned int action);
163extern void ata_eh_autopsy(struct ata_port *ap);
164const char *ata_get_cmd_descript(u8 command);
165extern void ata_eh_report(struct ata_port *ap);
166extern int ata_eh_reset(struct ata_link *link, int classify,
167 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
168 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
169extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
170extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
171 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
172 ata_postreset_fn_t postreset,
173 struct ata_link **r_failed_disk);
174extern void ata_eh_finish(struct ata_port *ap);
175extern int ata_ering_map(struct ata_ering *ering,
176 int (*map_fn)(struct ata_ering_entry *, void *),
177 void *arg);
178
179/* libata-pmp.c */
180#ifdef CONFIG_SATA_PMP
181extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
182extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
183extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
184 unsigned hints);
185extern int sata_pmp_attach(struct ata_device *dev);
186#else /* CONFIG_SATA_PMP */
187static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
188{
189 return -EINVAL;
190}
191
192static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
193{
194 return -EINVAL;
195}
196
197static inline int sata_pmp_set_lpm(struct ata_link *link,
198 enum ata_lpm_policy policy, unsigned hints)
199{
200 return -EINVAL;
201}
202
203static inline int sata_pmp_attach(struct ata_device *dev)
204{
205 return -EINVAL;
206}
207#endif /* CONFIG_SATA_PMP */
208
209/* libata-sff.c */
210#ifdef CONFIG_ATA_SFF
211extern void ata_sff_flush_pio_task(struct ata_port *ap);
212extern void ata_sff_port_init(struct ata_port *ap);
213extern int ata_sff_init(void);
214extern void ata_sff_exit(void);
215#else /* CONFIG_ATA_SFF */
216static inline void ata_sff_flush_pio_task(struct ata_port *ap)
217{ }
218static inline void ata_sff_port_init(struct ata_port *ap)
219{ }
220static inline int ata_sff_init(void)
221{ return 0; }
222static inline void ata_sff_exit(void)
223{ }
224#endif /* CONFIG_ATA_SFF */
225
226#endif /* __LIBATA_H__ */
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
33extern atomic_t ata_print_id;
34extern int atapi_passthru16;
35extern int libata_fua;
36extern int libata_noacpi;
37extern int libata_allow_tpm;
38extern const struct device_type ata_port_type;
39extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
40#ifdef CONFIG_ATA_FORCE
41extern void ata_force_cbl(struct ata_port *ap);
42#else
43static inline void ata_force_cbl(struct ata_port *ap) { }
44#endif
45extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
46extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
47extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev, int tag);
48extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
49 u64 block, u32 n_block, unsigned int tf_flags,
50 unsigned int tag, int class);
51extern u64 ata_tf_read_block(const struct ata_taskfile *tf,
52 struct ata_device *dev);
53extern 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 long timeout);
57extern unsigned ata_exec_internal_sg(struct ata_device *dev,
58 struct ata_taskfile *tf, const u8 *cdb,
59 int dma_dir, struct scatterlist *sg,
60 unsigned int n_elem, unsigned long timeout);
61extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
62 int (*check_ready)(struct ata_link *link));
63extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
64 unsigned int flags, u16 *id);
65extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
66extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
67 unsigned int readid_flags);
68extern int ata_dev_configure(struct ata_device *dev);
69extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
70extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
71extern unsigned int ata_dev_set_feature(struct ata_device *dev,
72 u8 enable, u8 feature);
73extern void ata_qc_free(struct ata_queued_cmd *qc);
74extern void ata_qc_issue(struct ata_queued_cmd *qc);
75extern void __ata_qc_complete(struct ata_queued_cmd *qc);
76extern int atapi_check_dma(struct ata_queued_cmd *qc);
77extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
78extern bool ata_phys_link_online(struct ata_link *link);
79extern bool ata_phys_link_offline(struct ata_link *link);
80extern void ata_dev_init(struct ata_device *dev);
81extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
82extern int sata_link_init_spd(struct ata_link *link);
83extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
84extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
85extern struct ata_port *ata_port_alloc(struct ata_host *host);
86extern const char *sata_spd_string(unsigned int spd);
87extern int ata_port_probe(struct ata_port *ap);
88extern void __ata_port_probe(struct ata_port *ap);
89extern unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
90 u8 page, void *buf, unsigned int sectors);
91
92#define to_ata_port(d) container_of(d, struct ata_port, tdev)
93
94/* libata-sata.c */
95#ifdef CONFIG_SATA_HOST
96int ata_sas_allocate_tag(struct ata_port *ap);
97void ata_sas_free_tag(unsigned int tag, struct ata_port *ap);
98#else
99static inline int ata_sas_allocate_tag(struct ata_port *ap)
100{
101 return -EOPNOTSUPP;
102}
103static inline void ata_sas_free_tag(unsigned int tag, struct ata_port *ap) { }
104#endif
105
106/* libata-acpi.c */
107#ifdef CONFIG_ATA_ACPI
108extern unsigned int ata_acpi_gtf_filter;
109extern void ata_acpi_dissociate(struct ata_host *host);
110extern int ata_acpi_on_suspend(struct ata_port *ap);
111extern void ata_acpi_on_resume(struct ata_port *ap);
112extern int ata_acpi_on_devcfg(struct ata_device *dev);
113extern void ata_acpi_on_disable(struct ata_device *dev);
114extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
115extern void ata_acpi_bind_port(struct ata_port *ap);
116extern void ata_acpi_bind_dev(struct ata_device *dev);
117extern acpi_handle ata_dev_acpi_handle(struct ata_device *dev);
118#else
119static inline void ata_acpi_dissociate(struct ata_host *host) { }
120static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
121static inline void ata_acpi_on_resume(struct ata_port *ap) { }
122static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
123static inline void ata_acpi_on_disable(struct ata_device *dev) { }
124static inline void ata_acpi_set_state(struct ata_port *ap,
125 pm_message_t state) { }
126static inline void ata_acpi_bind_port(struct ata_port *ap) {}
127static inline void ata_acpi_bind_dev(struct ata_device *dev) {}
128#endif
129
130/* libata-scsi.c */
131extern struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
132 const struct scsi_device *scsidev);
133extern int ata_scsi_add_hosts(struct ata_host *host,
134 struct scsi_host_template *sht);
135extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
136extern int ata_scsi_offline_dev(struct ata_device *dev);
137extern void ata_scsi_set_sense(struct ata_device *dev,
138 struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq);
139extern void ata_scsi_set_sense_information(struct ata_device *dev,
140 struct scsi_cmnd *cmd,
141 const struct ata_taskfile *tf);
142extern void ata_scsi_media_change_notify(struct ata_device *dev);
143extern void ata_scsi_hotplug(struct work_struct *work);
144extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
145extern void ata_scsi_dev_rescan(struct work_struct *work);
146extern int ata_bus_probe(struct ata_port *ap);
147extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
148 unsigned int id, u64 lun);
149void ata_scsi_sdev_config(struct scsi_device *sdev);
150int ata_scsi_dev_config(struct scsi_device *sdev, struct ata_device *dev);
151void ata_scsi_dump_cdb(struct ata_port *ap, struct scsi_cmnd *cmd);
152int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev);
153
154/* libata-eh.c */
155extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
156extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
157extern void ata_eh_acquire(struct ata_port *ap);
158extern void ata_eh_release(struct ata_port *ap);
159extern void ata_scsi_error(struct Scsi_Host *host);
160extern void ata_eh_fastdrain_timerfn(struct timer_list *t);
161extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
162extern void ata_dev_disable(struct ata_device *dev);
163extern void ata_eh_detach_dev(struct ata_device *dev);
164extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
165 unsigned int action);
166extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
167 unsigned int action);
168extern void ata_eh_autopsy(struct ata_port *ap);
169const char *ata_get_cmd_descript(u8 command);
170extern void ata_eh_report(struct ata_port *ap);
171extern int ata_eh_reset(struct ata_link *link, int classify,
172 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
173 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
174extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
175extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
176 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
177 ata_postreset_fn_t postreset,
178 struct ata_link **r_failed_disk);
179extern void ata_eh_finish(struct ata_port *ap);
180extern int ata_ering_map(struct ata_ering *ering,
181 int (*map_fn)(struct ata_ering_entry *, void *),
182 void *arg);
183extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key);
184extern unsigned int atapi_eh_request_sense(struct ata_device *dev,
185 u8 *sense_buf, u8 dfl_sense_key);
186
187/* libata-pmp.c */
188#ifdef CONFIG_SATA_PMP
189extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
190extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
191extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
192 unsigned hints);
193extern int sata_pmp_attach(struct ata_device *dev);
194#else /* CONFIG_SATA_PMP */
195static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
196{
197 return -EINVAL;
198}
199
200static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
201{
202 return -EINVAL;
203}
204
205static inline int sata_pmp_set_lpm(struct ata_link *link,
206 enum ata_lpm_policy policy, unsigned hints)
207{
208 return -EINVAL;
209}
210
211static inline int sata_pmp_attach(struct ata_device *dev)
212{
213 return -EINVAL;
214}
215#endif /* CONFIG_SATA_PMP */
216
217/* libata-sff.c */
218#ifdef CONFIG_ATA_SFF
219extern void ata_sff_flush_pio_task(struct ata_port *ap);
220extern void ata_sff_port_init(struct ata_port *ap);
221extern int ata_sff_init(void);
222extern void ata_sff_exit(void);
223#else /* CONFIG_ATA_SFF */
224static inline void ata_sff_flush_pio_task(struct ata_port *ap)
225{ }
226static inline void ata_sff_port_init(struct ata_port *ap)
227{ }
228static inline int ata_sff_init(void)
229{ return 0; }
230static inline void ata_sff_exit(void)
231{ }
232#endif /* CONFIG_ATA_SFF */
233
234/* libata-zpodd.c */
235#ifdef CONFIG_SATA_ZPODD
236void zpodd_init(struct ata_device *dev);
237void zpodd_exit(struct ata_device *dev);
238static inline bool zpodd_dev_enabled(struct ata_device *dev)
239{
240 return dev->zpodd != NULL;
241}
242void zpodd_on_suspend(struct ata_device *dev);
243bool zpodd_zpready(struct ata_device *dev);
244void zpodd_enable_run_wake(struct ata_device *dev);
245void zpodd_disable_run_wake(struct ata_device *dev);
246void zpodd_post_poweron(struct ata_device *dev);
247#else /* CONFIG_SATA_ZPODD */
248static inline void zpodd_init(struct ata_device *dev) {}
249static inline void zpodd_exit(struct ata_device *dev) {}
250static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; }
251static inline void zpodd_on_suspend(struct ata_device *dev) {}
252static inline bool zpodd_zpready(struct ata_device *dev) { return false; }
253static inline void zpodd_enable_run_wake(struct ata_device *dev) {}
254static inline void zpodd_disable_run_wake(struct ata_device *dev) {}
255static inline void zpodd_post_poweron(struct ata_device *dev) {}
256#endif /* CONFIG_SATA_ZPODD */
257
258#endif /* __LIBATA_H__ */