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 static 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 54 static 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 60 extern void ata_force_cbl(struct ata_port *ap); 61 #else 62 static inline void ata_force_cbl(struct ata_port *ap) { } 63 #endif 64 extern u64 ata_tf_to_lba(const struct ata_taskfile *tf); 65 extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf); 66 extern int ata_build_rw_tf(struct ata_queued_cmd *qc, u64 block, u32 n_block, 67 unsigned int tf_flags, int dld, int class); 68 extern u64 ata_tf_read_block(const struct ata_taskfile *tf, 69 struct ata_device *dev); 70 unsigned 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); 74 extern int ata_wait_ready(struct ata_link *link, unsigned long deadline, 75 int (*check_ready)(struct ata_link *link)); 76 extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class, 77 unsigned int flags, u16 *id); 78 extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags); 79 extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class, 80 unsigned int readid_flags); 81 extern int ata_dev_configure(struct ata_device *dev); 82 extern bool ata_dev_power_init_tf(struct ata_device *dev, 83 struct ata_taskfile *tf, bool set_active); 84 extern void ata_dev_power_set_standby(struct ata_device *dev); 85 extern void ata_dev_power_set_active(struct ata_device *dev); 86 void ata_dev_free_resources(struct ata_device *dev); 87 extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel); 88 extern unsigned int ata_dev_set_feature(struct ata_device *dev, 89 u8 subcmd, u8 action); 90 extern void ata_qc_free(struct ata_queued_cmd *qc); 91 extern void ata_qc_issue(struct ata_queued_cmd *qc); 92 extern void __ata_qc_complete(struct ata_queued_cmd *qc); 93 extern int atapi_check_dma(struct ata_queued_cmd *qc); 94 extern void swap_buf_le16(u16 *buf, unsigned int buf_words); 95 extern bool ata_phys_link_online(struct ata_link *link); 96 extern bool ata_phys_link_offline(struct ata_link *link); 97 bool ata_adapter_is_online(struct ata_port *ap); 98 extern void ata_dev_init(struct ata_device *dev); 99 extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp); 100 extern int sata_link_init_spd(struct ata_link *link); 101 extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg); 102 extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg); 103 extern const char *sata_spd_string(unsigned int spd); 104 extern 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 111 int sata_down_spd_limit(struct ata_link *link, u32 spd_limit); 112 int ata_eh_get_ncq_success_sense(struct ata_link *link); 113 #else 114 static inline int sata_down_spd_limit(struct ata_link *link, u32 spd_limit) 115 { 116 return -EOPNOTSUPP; 117 } 118 static 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 126 extern unsigned int ata_acpi_gtf_filter; 127 extern void ata_acpi_dissociate(struct ata_host *host); 128 extern void ata_acpi_on_resume(struct ata_port *ap); 129 extern int ata_acpi_on_devcfg(struct ata_device *dev); 130 extern void ata_acpi_on_disable(struct ata_device *dev); 131 extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state); 132 extern void ata_acpi_bind_port(struct ata_port *ap); 133 extern void ata_acpi_bind_dev(struct ata_device *dev); 134 extern void ata_acpi_port_power_on(struct ata_port *ap); 135 extern bool ata_acpi_dev_manage_restart(struct ata_device *dev); 136 extern acpi_handle ata_dev_acpi_handle(struct ata_device *dev); 137 #else 138 static inline void ata_acpi_dissociate(struct ata_host *host) { } 139 static inline void ata_acpi_on_resume(struct ata_port *ap) { } 140 static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; } 141 static inline void ata_acpi_on_disable(struct ata_device *dev) { } 142 static inline void ata_acpi_set_state(struct ata_port *ap, 143 pm_message_t state) { } 144 static inline void ata_acpi_bind_port(struct ata_port *ap) {} 145 static inline void ata_acpi_bind_dev(struct ata_device *dev) {} 146 static inline void ata_acpi_port_power_on(struct ata_port *ap) {} 147 static inline bool ata_acpi_dev_manage_restart(struct ata_device *dev) { return 0; } 148 #endif 149 150 /* libata-scsi.c */ 151 extern struct ata_device *ata_scsi_find_dev(struct ata_port *ap, 152 const struct scsi_device *scsidev); 153 extern int ata_scsi_add_hosts(struct ata_host *host, 154 const struct scsi_host_template *sht); 155 extern void ata_scsi_scan_host(struct ata_port *ap, int sync); 156 extern bool ata_scsi_offline_dev(struct ata_device *dev); 157 extern bool ata_scsi_sense_is_valid(u8 sk, u8 asc, u8 ascq); 158 extern void ata_scsi_set_sense(struct ata_device *dev, 159 struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq); 160 extern void ata_scsi_media_change_notify(struct ata_device *dev); 161 extern void ata_scsi_hotplug(struct work_struct *work); 162 extern void ata_scsi_dev_rescan(struct work_struct *work); 163 extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel, 164 unsigned int id, u64 lun); 165 void ata_scsi_sdev_config(struct scsi_device *sdev); 166 int ata_scsi_dev_config(struct scsi_device *sdev, struct queue_limits *lim, 167 struct ata_device *dev); 168 enum scsi_qc_status __ata_scsi_queuecmd(struct scsi_cmnd *scmd, 169 struct ata_device *dev); 170 void ata_scsi_deferred_qc_work(struct work_struct *work); 171 void ata_scsi_requeue_deferred_qc(struct ata_port *ap); 172 173 /* libata-eh.c */ 174 extern unsigned int ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd); 175 extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd); 176 extern void ata_eh_acquire(struct ata_port *ap); 177 extern void ata_eh_release(struct ata_port *ap); 178 extern void ata_scsi_error(struct Scsi_Host *host); 179 extern void ata_eh_fastdrain_timerfn(struct timer_list *t); 180 extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc); 181 extern void ata_dev_disable(struct ata_device *dev); 182 extern void ata_eh_detach_dev(struct ata_device *dev); 183 extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev, 184 unsigned int action); 185 extern void ata_eh_done(struct ata_link *link, struct ata_device *dev, 186 unsigned int action); 187 extern void ata_eh_autopsy(struct ata_port *ap); 188 const char *ata_get_cmd_name(u8 command); 189 extern void ata_eh_report(struct ata_port *ap); 190 extern int ata_eh_reset(struct ata_link *link, int classify, 191 struct ata_reset_operations *reset_ops); 192 extern int ata_eh_recover(struct ata_port *ap, 193 struct ata_reset_operations *reset_ops, 194 struct ata_link **r_failed_disk); 195 extern void ata_eh_finish(struct ata_port *ap); 196 extern int ata_ering_map(struct ata_ering *ering, 197 int (*map_fn)(struct ata_ering_entry *, void *), 198 void *arg); 199 enum scsi_disposition ata_eh_decide_disposition(struct ata_queued_cmd *qc); 200 extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key); 201 extern unsigned int atapi_eh_request_sense(struct ata_device *dev, 202 u8 *sense_buf, u8 dfl_sense_key); 203 204 /* libata-pmp.c */ 205 #ifdef CONFIG_SATA_PMP 206 extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val); 207 extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val); 208 extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy, 209 unsigned hints); 210 extern int sata_pmp_attach(struct ata_device *dev); 211 #else /* CONFIG_SATA_PMP */ 212 static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val) 213 { 214 return -EINVAL; 215 } 216 217 static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val) 218 { 219 return -EINVAL; 220 } 221 222 static inline int sata_pmp_set_lpm(struct ata_link *link, 223 enum ata_lpm_policy policy, unsigned hints) 224 { 225 return -EINVAL; 226 } 227 228 static inline int sata_pmp_attach(struct ata_device *dev) 229 { 230 return -EINVAL; 231 } 232 #endif /* CONFIG_SATA_PMP */ 233 234 /* libata-sff.c */ 235 #ifdef CONFIG_ATA_SFF 236 extern void ata_sff_flush_pio_task(struct ata_port *ap); 237 extern void ata_sff_port_init(struct ata_port *ap); 238 extern int ata_sff_init(void); 239 extern void ata_sff_exit(void); 240 #else /* CONFIG_ATA_SFF */ 241 static inline void ata_sff_flush_pio_task(struct ata_port *ap) 242 { } 243 static inline void ata_sff_port_init(struct ata_port *ap) 244 { } 245 static inline int ata_sff_init(void) 246 { return 0; } 247 static inline void ata_sff_exit(void) 248 { } 249 #endif /* CONFIG_ATA_SFF */ 250 251 /* libata-zpodd.c */ 252 #ifdef CONFIG_SATA_ZPODD 253 void zpodd_init(struct ata_device *dev); 254 void zpodd_exit(struct ata_device *dev); 255 static inline bool zpodd_dev_enabled(struct ata_device *dev) 256 { 257 return dev->zpodd != NULL; 258 } 259 void zpodd_on_suspend(struct ata_device *dev); 260 bool zpodd_zpready(struct ata_device *dev); 261 void zpodd_enable_run_wake(struct ata_device *dev); 262 void zpodd_disable_run_wake(struct ata_device *dev); 263 void zpodd_post_poweron(struct ata_device *dev); 264 #else /* CONFIG_SATA_ZPODD */ 265 static inline void zpodd_init(struct ata_device *dev) {} 266 static inline void zpodd_exit(struct ata_device *dev) {} 267 static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; } 268 static inline void zpodd_on_suspend(struct ata_device *dev) {} 269 static inline bool zpodd_zpready(struct ata_device *dev) { return false; } 270 static inline void zpodd_enable_run_wake(struct ata_device *dev) {} 271 static inline void zpodd_disable_run_wake(struct ata_device *dev) {} 272 static inline void zpodd_post_poweron(struct ata_device *dev) {} 273 #endif /* CONFIG_SATA_ZPODD */ 274 275 #endif /* __LIBATA_H__ */ 276