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