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 struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev, int tag); 48 extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev, 49 u64 block, u32 n_block, unsigned int tf_flags, 50 unsigned int tag, int class); 51 extern u64 ata_tf_read_block(const struct ata_taskfile *tf, 52 struct ata_device *dev); 53 extern unsigned ata_exec_internal(struct ata_device *dev, 54 struct ata_taskfile *tf, const u8 *cdb, 55 int dma_dir, void *buf, unsigned int buflen, 56 unsigned long timeout); 57 extern unsigned ata_exec_internal_sg(struct ata_device *dev, 58 struct ata_taskfile *tf, const u8 *cdb, 59 int dma_dir, struct scatterlist *sg, 60 unsigned int n_elem, unsigned long timeout); 61 extern int ata_wait_ready(struct ata_link *link, unsigned long deadline, 62 int (*check_ready)(struct ata_link *link)); 63 extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class, 64 unsigned int flags, u16 *id); 65 extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags); 66 extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class, 67 unsigned int readid_flags); 68 extern int ata_dev_configure(struct ata_device *dev); 69 extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit); 70 extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel); 71 extern unsigned int ata_dev_set_feature(struct ata_device *dev, 72 u8 enable, u8 feature); 73 extern void ata_qc_free(struct ata_queued_cmd *qc); 74 extern void ata_qc_issue(struct ata_queued_cmd *qc); 75 extern void __ata_qc_complete(struct ata_queued_cmd *qc); 76 extern int atapi_check_dma(struct ata_queued_cmd *qc); 77 extern void swap_buf_le16(u16 *buf, unsigned int buf_words); 78 extern bool ata_phys_link_online(struct ata_link *link); 79 extern bool ata_phys_link_offline(struct ata_link *link); 80 extern void ata_dev_init(struct ata_device *dev); 81 extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp); 82 extern int sata_link_init_spd(struct ata_link *link); 83 extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg); 84 extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg); 85 extern struct ata_port *ata_port_alloc(struct ata_host *host); 86 extern const char *sata_spd_string(unsigned int spd); 87 extern int ata_port_probe(struct ata_port *ap); 88 extern void __ata_port_probe(struct ata_port *ap); 89 extern unsigned int ata_read_log_page(struct ata_device *dev, u8 log, 90 u8 page, void *buf, unsigned int sectors); 91 92 #define to_ata_port(d) container_of(d, struct ata_port, tdev) 93 94 /* libata-sata.c */ 95 #ifdef CONFIG_SATA_HOST 96 int ata_sas_allocate_tag(struct ata_port *ap); 97 void ata_sas_free_tag(unsigned int tag, struct ata_port *ap); 98 #else 99 static inline int ata_sas_allocate_tag(struct ata_port *ap) 100 { 101 return -EOPNOTSUPP; 102 } 103 static inline void ata_sas_free_tag(unsigned int tag, struct ata_port *ap) { } 104 #endif 105 106 /* libata-acpi.c */ 107 #ifdef CONFIG_ATA_ACPI 108 extern unsigned int ata_acpi_gtf_filter; 109 extern void ata_acpi_dissociate(struct ata_host *host); 110 extern int ata_acpi_on_suspend(struct ata_port *ap); 111 extern void ata_acpi_on_resume(struct ata_port *ap); 112 extern int ata_acpi_on_devcfg(struct ata_device *dev); 113 extern void ata_acpi_on_disable(struct ata_device *dev); 114 extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state); 115 extern void ata_acpi_bind_port(struct ata_port *ap); 116 extern void ata_acpi_bind_dev(struct ata_device *dev); 117 extern acpi_handle ata_dev_acpi_handle(struct ata_device *dev); 118 #else 119 static inline void ata_acpi_dissociate(struct ata_host *host) { } 120 static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; } 121 static inline void ata_acpi_on_resume(struct ata_port *ap) { } 122 static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; } 123 static inline void ata_acpi_on_disable(struct ata_device *dev) { } 124 static inline void ata_acpi_set_state(struct ata_port *ap, 125 pm_message_t state) { } 126 static inline void ata_acpi_bind_port(struct ata_port *ap) {} 127 static inline void ata_acpi_bind_dev(struct ata_device *dev) {} 128 #endif 129 130 /* libata-scsi.c */ 131 extern struct ata_device *ata_scsi_find_dev(struct ata_port *ap, 132 const struct scsi_device *scsidev); 133 extern int ata_scsi_add_hosts(struct ata_host *host, 134 struct scsi_host_template *sht); 135 extern void ata_scsi_scan_host(struct ata_port *ap, int sync); 136 extern int ata_scsi_offline_dev(struct ata_device *dev); 137 extern void ata_scsi_set_sense(struct ata_device *dev, 138 struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq); 139 extern void ata_scsi_set_sense_information(struct ata_device *dev, 140 struct scsi_cmnd *cmd, 141 const struct ata_taskfile *tf); 142 extern void ata_scsi_media_change_notify(struct ata_device *dev); 143 extern void ata_scsi_hotplug(struct work_struct *work); 144 extern void ata_schedule_scsi_eh(struct Scsi_Host *shost); 145 extern void ata_scsi_dev_rescan(struct work_struct *work); 146 extern int ata_bus_probe(struct ata_port *ap); 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 ata_device *dev); 151 void ata_scsi_dump_cdb(struct ata_port *ap, struct scsi_cmnd *cmd); 152 int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev); 153 154 /* libata-eh.c */ 155 extern unsigned long 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_descript(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 extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key); 184 extern unsigned int atapi_eh_request_sense(struct ata_device *dev, 185 u8 *sense_buf, u8 dfl_sense_key); 186 187 /* libata-pmp.c */ 188 #ifdef CONFIG_SATA_PMP 189 extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val); 190 extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val); 191 extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy, 192 unsigned hints); 193 extern int sata_pmp_attach(struct ata_device *dev); 194 #else /* CONFIG_SATA_PMP */ 195 static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val) 196 { 197 return -EINVAL; 198 } 199 200 static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val) 201 { 202 return -EINVAL; 203 } 204 205 static inline int sata_pmp_set_lpm(struct ata_link *link, 206 enum ata_lpm_policy policy, unsigned hints) 207 { 208 return -EINVAL; 209 } 210 211 static inline int sata_pmp_attach(struct ata_device *dev) 212 { 213 return -EINVAL; 214 } 215 #endif /* CONFIG_SATA_PMP */ 216 217 /* libata-sff.c */ 218 #ifdef CONFIG_ATA_SFF 219 extern void ata_sff_flush_pio_task(struct ata_port *ap); 220 extern void ata_sff_port_init(struct ata_port *ap); 221 extern int ata_sff_init(void); 222 extern void ata_sff_exit(void); 223 #else /* CONFIG_ATA_SFF */ 224 static inline void ata_sff_flush_pio_task(struct ata_port *ap) 225 { } 226 static inline void ata_sff_port_init(struct ata_port *ap) 227 { } 228 static inline int ata_sff_init(void) 229 { return 0; } 230 static inline void ata_sff_exit(void) 231 { } 232 #endif /* CONFIG_ATA_SFF */ 233 234 /* libata-zpodd.c */ 235 #ifdef CONFIG_SATA_ZPODD 236 void zpodd_init(struct ata_device *dev); 237 void zpodd_exit(struct ata_device *dev); 238 static inline bool zpodd_dev_enabled(struct ata_device *dev) 239 { 240 return dev->zpodd != NULL; 241 } 242 void zpodd_on_suspend(struct ata_device *dev); 243 bool zpodd_zpready(struct ata_device *dev); 244 void zpodd_enable_run_wake(struct ata_device *dev); 245 void zpodd_disable_run_wake(struct ata_device *dev); 246 void zpodd_post_poweron(struct ata_device *dev); 247 #else /* CONFIG_SATA_ZPODD */ 248 static inline void zpodd_init(struct ata_device *dev) {} 249 static inline void zpodd_exit(struct ata_device *dev) {} 250 static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; } 251 static inline void zpodd_on_suspend(struct ata_device *dev) {} 252 static inline bool zpodd_zpready(struct ata_device *dev) { return false; } 253 static inline void zpodd_enable_run_wake(struct ata_device *dev) {} 254 static inline void zpodd_disable_run_wake(struct ata_device *dev) {} 255 static inline void zpodd_post_poweron(struct ata_device *dev) {} 256 #endif /* CONFIG_SATA_ZPODD */ 257 258 #endif /* __LIBATA_H__ */ 259