drivers/ata/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 */
  19 enum {
  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 extern atomic_t ata_print_id;
  34 extern int atapi_passthru16;
  35 extern int libata_fua;
  36 extern int libata_noacpi;
  37 extern int libata_allow_tpm;
  38 extern const struct device_type ata_port_type;
  39 extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
  40 #ifdef CONFIG_ATA_FORCE
  41 extern void ata_force_cbl(struct ata_port *ap);
  42 #else
  43 static inline void ata_force_cbl(struct ata_port *ap) { }
  44 #endif
  45 extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
  46 extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
  47 extern int ata_build_rw_tf(struct ata_queued_cmd *qc, u64 block, u32 n_block,
  48                            unsigned int tf_flags, int dld, int class);
  49 extern u64 ata_tf_read_block(const struct ata_taskfile *tf,
  50                              struct ata_device *dev);
  51 extern unsigned ata_exec_internal(struct ata_device *dev,
  52                                   struct ata_taskfile *tf, const u8 *cdb,
  53                                   int dma_dir, void *buf, unsigned int buflen,
  54                                   unsigned int timeout);
  55 extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
  56                           int (*check_ready)(struct ata_link *link));
  57 extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
  58                            unsigned int flags, u16 *id);
  59 extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
  60 extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
  61                               unsigned int readid_flags);
  62 extern int ata_dev_configure(struct ata_device *dev);
  63 extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
  64 extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
  65 extern unsigned int ata_dev_set_feature(struct ata_device *dev,
  66                                         u8 subcmd, u8 action);
  67 extern void ata_qc_free(struct ata_queued_cmd *qc);
  68 extern void ata_qc_issue(struct ata_queued_cmd *qc);
  69 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
  70 extern int atapi_check_dma(struct ata_queued_cmd *qc);
  71 extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
  72 extern bool ata_phys_link_online(struct ata_link *link);
  73 extern bool ata_phys_link_offline(struct ata_link *link);
  74 extern void ata_dev_init(struct ata_device *dev);
  75 extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
  76 extern int sata_link_init_spd(struct ata_link *link);
  77 extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
  78 extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
  79 extern struct ata_port *ata_port_alloc(struct ata_host *host);
  80 extern const char *sata_spd_string(unsigned int spd);
  81 extern unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
  82                                       u8 page, void *buf, unsigned int sectors);
  83
  84 #define to_ata_port(d) container_of(d, struct ata_port, tdev)
  85
  86 /* libata-acpi.c */
  87 #ifdef CONFIG_ATA_ACPI
  88 extern unsigned int ata_acpi_gtf_filter;
  89 extern void ata_acpi_dissociate(struct ata_host *host);
  90 extern void ata_acpi_on_resume(struct ata_port *ap);
  91 extern int ata_acpi_on_devcfg(struct ata_device *dev);
  92 extern void ata_acpi_on_disable(struct ata_device *dev);
  93 extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
  94 extern void ata_acpi_bind_port(struct ata_port *ap);
  95 extern void ata_acpi_bind_dev(struct ata_device *dev);
  96 extern acpi_handle ata_dev_acpi_handle(struct ata_device *dev);
  97 #else
  98 static inline void ata_acpi_dissociate(struct ata_host *host) { }
  99 static inline void ata_acpi_on_resume(struct ata_port *ap) { }
 100 static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
 101 static inline void ata_acpi_on_disable(struct ata_device *dev) { }
 102 static inline void ata_acpi_set_state(struct ata_port *ap,
 103                                       pm_message_t state) { }
 104 static inline void ata_acpi_bind_port(struct ata_port *ap) {}
 105 static inline void ata_acpi_bind_dev(struct ata_device *dev) {}
 106 #endif
 107
 108 /* libata-scsi.c */
 109 extern struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
 110                                             const struct scsi_device *scsidev);
 111 extern int ata_scsi_add_hosts(struct ata_host *host,
 112                               const struct scsi_host_template *sht);
 113 extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
 114 extern int ata_scsi_offline_dev(struct ata_device *dev);
 115 extern bool ata_scsi_sense_is_valid(u8 sk, u8 asc, u8 ascq);
 116 extern void ata_scsi_set_sense(struct ata_device *dev,
 117                                struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq);
 118 extern void ata_scsi_set_sense_information(struct ata_device *dev,
 119                                            struct scsi_cmnd *cmd,
 120                                            const struct ata_taskfile *tf);
 121 extern void ata_scsi_media_change_notify(struct ata_device *dev);
 122 extern void ata_scsi_hotplug(struct work_struct *work);
 123 extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
 124 extern void ata_scsi_dev_rescan(struct work_struct *work);
 125 extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
 126                               unsigned int id, u64 lun);
 127 void ata_scsi_sdev_config(struct scsi_device *sdev);
 128 int ata_scsi_dev_config(struct scsi_device *sdev, struct ata_device *dev);
 129 int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev);
 130
 131 /* libata-eh.c */
 132 extern unsigned int ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
 133 extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
 134 extern void ata_eh_acquire(struct ata_port *ap);
 135 extern void ata_eh_release(struct ata_port *ap);
 136 extern void ata_scsi_error(struct Scsi_Host *host);
 137 extern void ata_eh_fastdrain_timerfn(struct timer_list *t);
 138 extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
 139 extern void ata_dev_disable(struct ata_device *dev);
 140 extern void ata_eh_detach_dev(struct ata_device *dev);
 141 extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
 142                                unsigned int action);
 143 extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
 144                         unsigned int action);
 145 extern void ata_eh_autopsy(struct ata_port *ap);
 146 const char *ata_get_cmd_name(u8 command);
 147 extern void ata_eh_report(struct ata_port *ap);
 148 extern int ata_eh_reset(struct ata_link *link, int classify,
 149                         ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
 150                         ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
 151 extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
 152 extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
 153                           ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
 154                           ata_postreset_fn_t postreset,
 155                           struct ata_link **r_failed_disk);
 156 extern void ata_eh_finish(struct ata_port *ap);
 157 extern int ata_ering_map(struct ata_ering *ering,
 158                          int (*map_fn)(struct ata_ering_entry *, void *),
 159                          void *arg);
 160 extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key);
 161 extern unsigned int atapi_eh_request_sense(struct ata_device *dev,
 162                                            u8 *sense_buf, u8 dfl_sense_key);
 163
 164 /* libata-pmp.c */
 165 #ifdef CONFIG_SATA_PMP
 166 extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
 167 extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
 168 extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
 169                             unsigned hints);
 170 extern int sata_pmp_attach(struct ata_device *dev);
 171 #else /* CONFIG_SATA_PMP */
 172 static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
 173 {
 174         return -EINVAL;
 175 }
 176
 177 static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
 178 {
 179         return -EINVAL;
 180 }
 181
 182 static inline int sata_pmp_set_lpm(struct ata_link *link,
 183                                    enum ata_lpm_policy policy, unsigned hints)
 184 {
 185         return -EINVAL;
 186 }
 187
 188 static inline int sata_pmp_attach(struct ata_device *dev)
 189 {
 190         return -EINVAL;
 191 }
 192 #endif /* CONFIG_SATA_PMP */
 193
 194 /* libata-sff.c */
 195 #ifdef CONFIG_ATA_SFF
 196 extern void ata_sff_flush_pio_task(struct ata_port *ap);
 197 extern void ata_sff_port_init(struct ata_port *ap);
 198 extern int ata_sff_init(void);
 199 extern void ata_sff_exit(void);
 200 #else /* CONFIG_ATA_SFF */
 201 static inline void ata_sff_flush_pio_task(struct ata_port *ap)
 202 { }
 203 static inline void ata_sff_port_init(struct ata_port *ap)
 204 { }
 205 static inline int ata_sff_init(void)
 206 { return 0; }
 207 static inline void ata_sff_exit(void)
 208 { }
 209 #endif /* CONFIG_ATA_SFF */
 210
 211 /* libata-zpodd.c */
 212 #ifdef CONFIG_SATA_ZPODD
 213 void zpodd_init(struct ata_device *dev);
 214 void zpodd_exit(struct ata_device *dev);
 215 static inline bool zpodd_dev_enabled(struct ata_device *dev)
 216 {
 217         return dev->zpodd != NULL;
 218 }
 219 void zpodd_on_suspend(struct ata_device *dev);
 220 bool zpodd_zpready(struct ata_device *dev);
 221 void zpodd_enable_run_wake(struct ata_device *dev);
 222 void zpodd_disable_run_wake(struct ata_device *dev);
 223 void zpodd_post_poweron(struct ata_device *dev);
 224 #else /* CONFIG_SATA_ZPODD */
 225 static inline void zpodd_init(struct ata_device *dev) {}
 226 static inline void zpodd_exit(struct ata_device *dev) {}
 227 static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; }
 228 static inline void zpodd_on_suspend(struct ata_device *dev) {}
 229 static inline bool zpodd_zpready(struct ata_device *dev) { return false; }
 230 static inline void zpodd_enable_run_wake(struct ata_device *dev) {}
 231 static inline void zpodd_disable_run_wake(struct ata_device *dev) {}
 232 static inline void zpodd_post_poweron(struct ata_device *dev) {}
 233 #endif /* CONFIG_SATA_ZPODD */
 234
 235 #endif /* __LIBATA_H__ */