drivers/ata/libata.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /*
0003  *  libata.h - helper library for ATA
0004  *
0005  *  Copyright 2003-2004 Red Hat, Inc.  All rights reserved.
0006  *  Copyright 2003-2004 Jeff Garzik
0007  *
0008  *  libata documentation is available via 'make {ps|pdf}docs',
0009  *  as Documentation/driver-api/libata.rst
0010  */
0011
0012 #ifndef __LIBATA_H__
0013 #define __LIBATA_H__
0014
0015 #define DRV_NAME    "libata"
0016 #define DRV_VERSION "3.00"  /* must be exactly four chars */
0017
0018 /* libata-core.c */
0019 enum {
0020     /* flags for ata_dev_read_id() */
0021     ATA_READID_POSTRESET    = (1 << 0), /* reading ID after reset */
0022
0023     /* selector for ata_down_xfermask_limit() */
0024     ATA_DNXFER_PIO      = 0,    /* speed down PIO */
0025     ATA_DNXFER_DMA      = 1,    /* speed down DMA */
0026     ATA_DNXFER_40C      = 2,    /* apply 40c cable limit */
0027     ATA_DNXFER_FORCE_PIO    = 3,    /* force PIO */
0028     ATA_DNXFER_FORCE_PIO0   = 4,    /* force PIO0 */
0029
0030     ATA_DNXFER_QUIET    = (1 << 31),
0031 };
0032
0033 extern atomic_t ata_print_id;
0034 extern int atapi_passthru16;
0035 extern int libata_fua;
0036 extern int libata_noacpi;
0037 extern int libata_allow_tpm;
0038 extern const struct device_type ata_port_type;
0039 extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
0040 #ifdef CONFIG_ATA_FORCE
0041 extern void ata_force_cbl(struct ata_port *ap);
0042 #else
0043 static inline void ata_force_cbl(struct ata_port *ap) { }
0044 #endif
0045 extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
0046 extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
0047 extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
0048                u64 block, u32 n_block, unsigned int tf_flags,
0049                unsigned int tag, int class);
0050 extern u64 ata_tf_read_block(const struct ata_taskfile *tf,
0051                  struct ata_device *dev);
0052 extern unsigned ata_exec_internal(struct ata_device *dev,
0053                   struct ata_taskfile *tf, const u8 *cdb,
0054                   int dma_dir, void *buf, unsigned int buflen,
0055                   unsigned int timeout);
0056 extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
0057               int (*check_ready)(struct ata_link *link));
0058 extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
0059                unsigned int flags, u16 *id);
0060 extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
0061 extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
0062                   unsigned int readid_flags);
0063 extern int ata_dev_configure(struct ata_device *dev);
0064 extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
0065 extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
0066 extern unsigned int ata_dev_set_feature(struct ata_device *dev,
0067                     u8 enable, u8 feature);
0068 extern void ata_qc_free(struct ata_queued_cmd *qc);
0069 extern void ata_qc_issue(struct ata_queued_cmd *qc);
0070 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
0071 extern int atapi_check_dma(struct ata_queued_cmd *qc);
0072 extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
0073 extern bool ata_phys_link_online(struct ata_link *link);
0074 extern bool ata_phys_link_offline(struct ata_link *link);
0075 extern void ata_dev_init(struct ata_device *dev);
0076 extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
0077 extern int sata_link_init_spd(struct ata_link *link);
0078 extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
0079 extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
0080 extern struct ata_port *ata_port_alloc(struct ata_host *host);
0081 extern const char *sata_spd_string(unsigned int spd);
0082 extern int ata_port_probe(struct ata_port *ap);
0083 extern void __ata_port_probe(struct ata_port *ap);
0084 extern unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
0085                       u8 page, void *buf, unsigned int sectors);
0086
0087 #define to_ata_port(d) container_of(d, struct ata_port, tdev)
0088
0089 /* libata-acpi.c */
0090 #ifdef CONFIG_ATA_ACPI
0091 extern unsigned int ata_acpi_gtf_filter;
0092 extern void ata_acpi_dissociate(struct ata_host *host);
0093 extern void ata_acpi_on_resume(struct ata_port *ap);
0094 extern int ata_acpi_on_devcfg(struct ata_device *dev);
0095 extern void ata_acpi_on_disable(struct ata_device *dev);
0096 extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
0097 extern void ata_acpi_bind_port(struct ata_port *ap);
0098 extern void ata_acpi_bind_dev(struct ata_device *dev);
0099 extern acpi_handle ata_dev_acpi_handle(struct ata_device *dev);
0100 #else
0101 static inline void ata_acpi_dissociate(struct ata_host *host) { }
0102 static inline void ata_acpi_on_resume(struct ata_port *ap) { }
0103 static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
0104 static inline void ata_acpi_on_disable(struct ata_device *dev) { }
0105 static inline void ata_acpi_set_state(struct ata_port *ap,
0106                       pm_message_t state) { }
0107 static inline void ata_acpi_bind_port(struct ata_port *ap) {}
0108 static inline void ata_acpi_bind_dev(struct ata_device *dev) {}
0109 #endif
0110
0111 /* libata-scsi.c */
0112 extern struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
0113                         const struct scsi_device *scsidev);
0114 extern int ata_scsi_add_hosts(struct ata_host *host,
0115                   struct scsi_host_template *sht);
0116 extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
0117 extern int ata_scsi_offline_dev(struct ata_device *dev);
0118 extern void ata_scsi_set_sense(struct ata_device *dev,
0119                    struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq);
0120 extern void ata_scsi_set_sense_information(struct ata_device *dev,
0121                        struct scsi_cmnd *cmd,
0122                        const struct ata_taskfile *tf);
0123 extern void ata_scsi_media_change_notify(struct ata_device *dev);
0124 extern void ata_scsi_hotplug(struct work_struct *work);
0125 extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
0126 extern void ata_scsi_dev_rescan(struct work_struct *work);
0127 extern int ata_bus_probe(struct ata_port *ap);
0128 extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
0129                   unsigned int id, u64 lun);
0130 void ata_scsi_sdev_config(struct scsi_device *sdev);
0131 int ata_scsi_dev_config(struct scsi_device *sdev, struct ata_device *dev);
0132 int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev);
0133
0134 /* libata-eh.c */
0135 extern unsigned int ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
0136 extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
0137 extern void ata_eh_acquire(struct ata_port *ap);
0138 extern void ata_eh_release(struct ata_port *ap);
0139 extern void ata_scsi_error(struct Scsi_Host *host);
0140 extern void ata_eh_fastdrain_timerfn(struct timer_list *t);
0141 extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
0142 extern void ata_dev_disable(struct ata_device *dev);
0143 extern void ata_eh_detach_dev(struct ata_device *dev);
0144 extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
0145                    unsigned int action);
0146 extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
0147             unsigned int action);
0148 extern void ata_eh_autopsy(struct ata_port *ap);
0149 const char *ata_get_cmd_name(u8 command);
0150 extern void ata_eh_report(struct ata_port *ap);
0151 extern int ata_eh_reset(struct ata_link *link, int classify,
0152             ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
0153             ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
0154 extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
0155 extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
0156               ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
0157               ata_postreset_fn_t postreset,
0158               struct ata_link **r_failed_disk);
0159 extern void ata_eh_finish(struct ata_port *ap);
0160 extern int ata_ering_map(struct ata_ering *ering,
0161              int (*map_fn)(struct ata_ering_entry *, void *),
0162              void *arg);
0163 extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key);
0164 extern unsigned int atapi_eh_request_sense(struct ata_device *dev,
0165                        u8 *sense_buf, u8 dfl_sense_key);
0166
0167 /* libata-pmp.c */
0168 #ifdef CONFIG_SATA_PMP
0169 extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
0170 extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
0171 extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
0172                 unsigned hints);
0173 extern int sata_pmp_attach(struct ata_device *dev);
0174 #else /* CONFIG_SATA_PMP */
0175 static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
0176 {
0177     return -EINVAL;
0178 }
0179
0180 static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
0181 {
0182     return -EINVAL;
0183 }
0184
0185 static inline int sata_pmp_set_lpm(struct ata_link *link,
0186                    enum ata_lpm_policy policy, unsigned hints)
0187 {
0188     return -EINVAL;
0189 }
0190
0191 static inline int sata_pmp_attach(struct ata_device *dev)
0192 {
0193     return -EINVAL;
0194 }
0195 #endif /* CONFIG_SATA_PMP */
0196
0197 /* libata-sff.c */
0198 #ifdef CONFIG_ATA_SFF
0199 extern void ata_sff_flush_pio_task(struct ata_port *ap);
0200 extern void ata_sff_port_init(struct ata_port *ap);
0201 extern int ata_sff_init(void);
0202 extern void ata_sff_exit(void);
0203 #else /* CONFIG_ATA_SFF */
0204 static inline void ata_sff_flush_pio_task(struct ata_port *ap)
0205 { }
0206 static inline void ata_sff_port_init(struct ata_port *ap)
0207 { }
0208 static inline int ata_sff_init(void)
0209 { return 0; }
0210 static inline void ata_sff_exit(void)
0211 { }
0212 #endif /* CONFIG_ATA_SFF */
0213
0214 /* libata-zpodd.c */
0215 #ifdef CONFIG_SATA_ZPODD
0216 void zpodd_init(struct ata_device *dev);
0217 void zpodd_exit(struct ata_device *dev);
0218 static inline bool zpodd_dev_enabled(struct ata_device *dev)
0219 {
0220     return dev->zpodd != NULL;
0221 }
0222 void zpodd_on_suspend(struct ata_device *dev);
0223 bool zpodd_zpready(struct ata_device *dev);
0224 void zpodd_enable_run_wake(struct ata_device *dev);
0225 void zpodd_disable_run_wake(struct ata_device *dev);
0226 void zpodd_post_poweron(struct ata_device *dev);
0227 #else /* CONFIG_SATA_ZPODD */
0228 static inline void zpodd_init(struct ata_device *dev) {}
0229 static inline void zpodd_exit(struct ata_device *dev) {}
0230 static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; }
0231 static inline void zpodd_on_suspend(struct ata_device *dev) {}
0232 static inline bool zpodd_zpready(struct ata_device *dev) { return false; }
0233 static inline void zpodd_enable_run_wake(struct ata_device *dev) {}
0234 static inline void zpodd_disable_run_wake(struct ata_device *dev) {}
0235 static inline void zpodd_post_poweron(struct ata_device *dev) {}
0236 #endif /* CONFIG_SATA_ZPODD */
0237
0238 #endif /* __LIBATA_H__ */