projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge tag 'probes-fixes-v6.16-rc6' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-block.git] / drivers / ata / libata.h
CommitLineData
c82ee6d3 1/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4 2/*
af36d7f0
JG		 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 *
af36d7f0 8 * libata documentation is available via 'make {ps|pdf}docs',
9bb9a39c 9 * as Documentation/driver-api/libata.rst
1da177e4
LT		 10 */
11
12#ifndef __LIBATA_H__
13#define __LIBATA_H__
14
15#define DRV_NAME "libata"
633273a3 16#define DRV_VERSION "3.00" /* must be exactly four chars */
1da177e4 17
1da177e4 18/* libata-core.c */
bff04647
TH		 19enum {
20 /* flags for ata_dev_read_id() */
21 ATA_READID_POSTRESET = (1 << 0), /* reading ID after reset */
458337db
TH		 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 */
458337db
TH		 29
30 ATA_DNXFER_QUIET = (1 << 31),
bff04647
TH		 31};
32
75e2bd5f
DLM		 33#define ATA_PORT_TYPE_NAME "ata_port"
34
baf4fdfa 35extern int atapi_passthru16;
c3c013a2 36extern int libata_fua;
d7d0dad6 37extern int libata_noacpi;
ae8d4ee7 38extern int libata_allow_tpm;
8df82c13 39extern const struct device_type ata_port_type;
b1c72916 40extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
b642212d
DLM		 41
42static inline bool ata_sstatus_online(u32 sstatus)
43{
44 return (sstatus & 0xf) == 0x3;
45}
46
bf89b0bf 47#ifdef CONFIG_ATA_FORCE
33267325 48extern void ata_force_cbl(struct ata_port *ap);
bf89b0bf
BZ		 49#else
50static inline void ata_force_cbl(struct ata_port *ap) { }
51#endif
a5987e0a
TH		 52extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
53extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
066de3b9 54extern int ata_build_rw_tf(struct ata_queued_cmd *qc, u64 block, u32 n_block,
eafe804b 55 unsigned int tf_flags, int dld, int class);
cffd1ee9
HR		 56extern u64 ata_tf_read_block(const struct ata_taskfile *tf,
57 struct ata_device *dev);
9e6938e1
DLM		 58unsigned int ata_exec_internal(struct ata_device *dev, struct ata_taskfile *tf,
59 const u8 *cdb, enum dma_data_direction dma_dir,
60 void *buf, unsigned int buflen,
61 unsigned int timeout);
aa2731ad
TH		 62extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
63 int (*check_ready)(struct ata_link *link));
a9beec95 64extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
bff04647 65 unsigned int flags, u16 *id);
fe30911b 66extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
422c9daa
TH		 67extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
68 unsigned int readid_flags);
efdaedc4 69extern int ata_dev_configure(struct ata_device *dev);
8c1f0817
DLM		 70extern bool ata_dev_power_init_tf(struct ata_device *dev,
71 struct ata_taskfile *tf, bool set_active);
aa3998db
DLM		 72extern void ata_dev_power_set_standby(struct ata_device *dev);
73extern void ata_dev_power_set_active(struct ata_device *dev);
5f8319c4 74void ata_dev_free_resources(struct ata_device *dev);
458337db 75extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
1152b261 76extern unsigned int ata_dev_set_feature(struct ata_device *dev,
99ad3f9f 77 u8 subcmd, u8 action);
8a8bc223 78extern void ata_qc_free(struct ata_queued_cmd *qc);
8e0e694a 79extern void ata_qc_issue(struct ata_queued_cmd *qc);
f686bcb8 80extern void __ata_qc_complete(struct ata_queued_cmd *qc);
5895ef9a 81extern int atapi_check_dma(struct ata_queued_cmd *qc);
1da177e4 82extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
b1c72916
TH		 83extern bool ata_phys_link_online(struct ata_link *link);
84extern bool ata_phys_link_offline(struct ata_link *link);
3ef3b43d 85extern void ata_dev_init(struct ata_device *dev);
fb7fd614
TH		 86extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
87extern int sata_link_init_spd(struct ata_link *link);
b095518e
JG		 88extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
89extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
d9027470 90extern const char *sata_spd_string(unsigned int spd);
f01f62c2
CH		 91extern unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
92 u8 page, void *buf, unsigned int sectors);
602bcf21 93void ata_dev_cleanup_cdl_resources(struct ata_device *dev);
1da177e4 94
6b66d958
MG		 95#define to_ata_port(d) container_of(d, struct ata_port, tdev)
96
b642212d
DLM		 97/* libata-sata.c */
98#ifdef CONFIG_SATA_HOST
99int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
10e80763 100int ata_eh_get_ncq_success_sense(struct ata_link *link);
b642212d
DLM		 101#else
102static inline int sata_down_spd_limit(struct ata_link *link, u32 spd_limit)
103{
104 return -EOPNOTSUPP;
105}
10e80763
DLM		 106static inline int ata_eh_get_ncq_success_sense(struct ata_link *link)
107{
108 return -EOPNOTSUPP;
109}
b642212d
DLM		 110#endif
111
11ef697b 112/* libata-acpi.c */
e92351bb 113#ifdef CONFIG_ATA_ACPI
110f66d2 114extern unsigned int ata_acpi_gtf_filter;
562f0c2d 115extern void ata_acpi_dissociate(struct ata_host *host);
6746544c 116extern void ata_acpi_on_resume(struct ata_port *ap);
562f0c2d
TH		 117extern int ata_acpi_on_devcfg(struct ata_device *dev);
118extern void ata_acpi_on_disable(struct ata_device *dev);
bd3adca5 119extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
f1bc1e4c
AL		 120extern void ata_acpi_bind_port(struct ata_port *ap);
121extern void ata_acpi_bind_dev(struct ata_device *dev);
122extern acpi_handle ata_dev_acpi_handle(struct ata_device *dev);
11ef697b 123#else
562f0c2d 124static inline void ata_acpi_dissociate(struct ata_host *host) { }
6746544c 125static inline void ata_acpi_on_resume(struct ata_port *ap) { }
562f0c2d
TH		 126static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
127static inline void ata_acpi_on_disable(struct ata_device *dev) { }
bd3adca5
SL		 128static inline void ata_acpi_set_state(struct ata_port *ap,
129 pm_message_t state) { }
f1bc1e4c
AL		 130static inline void ata_acpi_bind_port(struct ata_port *ap) {}
131static inline void ata_acpi_bind_dev(struct ata_device *dev) {}
11ef697b 132#endif
1da177e4
LT		 133
134/* libata-scsi.c */
ec811a94
BZ		 135extern struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
136 const struct scsi_device *scsidev);
f3187195 137extern int ata_scsi_add_hosts(struct ata_host *host,
25df73d9 138 const struct scsi_host_template *sht);
1ae46317 139extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
0ea035a3 140extern int ata_scsi_offline_dev(struct ata_device *dev);
4b89ad8e 141extern bool ata_scsi_sense_is_valid(u8 sk, u8 asc, u8 ascq);
06dbde5f
HR		 142extern void ata_scsi_set_sense(struct ata_device *dev,
143 struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq);
7d77b247 144extern void ata_scsi_media_change_notify(struct ata_device *dev);
65f27f38 145extern void ata_scsi_hotplug(struct work_struct *work);
65f27f38 146extern void ata_scsi_dev_rescan(struct work_struct *work);
d9027470 147extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
9cb78c16 148 unsigned int id, u64 lun);
15964ff7 149void ata_scsi_sdev_config(struct scsi_device *sdev);
a25a9c85
CH		 150int ata_scsi_dev_config(struct scsi_device *sdev, struct queue_limits *lim,
151 struct ata_device *dev);
15964ff7 152int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev);
1da177e4 153
ece1d636 154/* libata-eh.c */
e06233f9 155extern unsigned int ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
87fbc5a0 156extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
c0c362b6
TH		 157extern void ata_eh_acquire(struct ata_port *ap);
158extern void ata_eh_release(struct ata_port *ap);
381544bb 159extern void ata_scsi_error(struct Scsi_Host *host);
b93ab338 160extern void ata_eh_fastdrain_timerfn(struct timer_list *t);
f686bcb8 161extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
678afac6 162extern void ata_dev_disable(struct ata_device *dev);
fb7fd614
TH		 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);
d4520903 169const char *ata_get_cmd_name(u8 command);
fb7fd614
TH		 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);
6f1d1e3a 174extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
fb7fd614
TH		 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);
d9027470
GG		 180extern int ata_ering_map(struct ata_ering *ering,
181 int (*map_fn)(struct ata_ering_entry *, void *),
bb6a42d7 182 void *arg);
9526dec2 183enum scsi_disposition ata_eh_decide_disposition(struct ata_queued_cmd *qc);
3dc67440
AL		 184extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key);
185extern unsigned int atapi_eh_request_sense(struct ata_device *dev,
186 u8 *sense_buf, u8 dfl_sense_key);
ece1d636 187
48515f6c 188/* libata-pmp.c */
88fcd562 189#ifdef CONFIG_SATA_PMP
48515f6c
TH		 190extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
191extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
6c8ea89c
TH		 192extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
193 unsigned hints);
48515f6c 194extern int sata_pmp_attach(struct ata_device *dev);
88fcd562
TH		 195#else /* CONFIG_SATA_PMP */
196static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
197{
198 return -EINVAL;
199}
200
201static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
202{
203 return -EINVAL;
204}
205
6c8ea89c
TH		 206static inline int sata_pmp_set_lpm(struct ata_link *link,
207 enum ata_lpm_policy policy, unsigned hints)
208{
209 return -EINVAL;
210}
211
88fcd562
TH		 212static inline int sata_pmp_attach(struct ata_device *dev)
213{
214 return -EINVAL;
215}
216#endif /* CONFIG_SATA_PMP */
48515f6c 217
90088bb4 218/* libata-sff.c */
127102ae 219#ifdef CONFIG_ATA_SFF
c429137a 220extern void ata_sff_flush_pio_task(struct ata_port *ap);
270390e1
TH		 221extern void ata_sff_port_init(struct ata_port *ap);
222extern int ata_sff_init(void);
223extern void ata_sff_exit(void);
224#else /* CONFIG_ATA_SFF */
c429137a
TH		 225static inline void ata_sff_flush_pio_task(struct ata_port *ap)
226{ }
270390e1
TH		 227static inline void ata_sff_port_init(struct ata_port *ap)
228{ }
229static inline int ata_sff_init(void)
230{ return 0; }
231static inline void ata_sff_exit(void)
232{ }
127102ae 233#endif /* CONFIG_ATA_SFF */
77a527ea 234
afe75951
AL		 235/* libata-zpodd.c */
236#ifdef CONFIG_SATA_ZPODD
237void zpodd_init(struct ata_device *dev);
238void zpodd_exit(struct ata_device *dev);
239static inline bool zpodd_dev_enabled(struct ata_device *dev)
240{
241 return dev->zpodd != NULL;
242}
3dc67440 243void zpodd_on_suspend(struct ata_device *dev);
21334205
AL		 244bool zpodd_zpready(struct ata_device *dev);
245void zpodd_enable_run_wake(struct ata_device *dev);
246void zpodd_disable_run_wake(struct ata_device *dev);
247void zpodd_post_poweron(struct ata_device *dev);
afe75951
AL		 248#else /* CONFIG_SATA_ZPODD */
249static inline void zpodd_init(struct ata_device *dev) {}
250static inline void zpodd_exit(struct ata_device *dev) {}
251static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; }
3dc67440 252static inline void zpodd_on_suspend(struct ata_device *dev) {}
21334205
AL		 253static inline bool zpodd_zpready(struct ata_device *dev) { return false; }
254static inline void zpodd_enable_run_wake(struct ata_device *dev) {}
255static inline void zpodd_disable_run_wake(struct ata_device *dev) {}
256static inline void zpodd_post_poweron(struct ata_device *dev) {}
afe75951
AL		 257#endif /* CONFIG_SATA_ZPODD */
258
1da177e4 259#endif /* __LIBATA_H__ */
Linux 6.x block layer and io_uring tree(s)