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