263 lines · c
1/* SPDX-License-Identifier: GPL-2.0-or-later */2/*3 * libata.h - helper library for ATA4 *5 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.6 * Copyright 2003-2004 Jeff Garzik7 *8 * libata documentation is available via 'make {ps|pdf}docs',9 * as Documentation/driver-api/libata.rst10 */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 */19enum {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 35extern int atapi_passthru16;36extern int libata_fua;37extern int libata_noacpi;38extern int libata_allow_tpm;39extern const struct device_type ata_port_type;40extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);41 42static inline bool ata_sstatus_online(u32 sstatus)43{44 return (sstatus & 0xf) == 0x3;45}46 47#ifdef CONFIG_ATA_FORCE48extern void ata_force_cbl(struct ata_port *ap);49#else50static inline void ata_force_cbl(struct ata_port *ap) { }51#endif52extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);53extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);54extern int ata_build_rw_tf(struct ata_queued_cmd *qc, u64 block, u32 n_block,55 unsigned int tf_flags, int dld, int class);56extern u64 ata_tf_read_block(const struct ata_taskfile *tf,57 struct ata_device *dev);58unsigned 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);62extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,63 int (*check_ready)(struct ata_link *link));64extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,65 unsigned int flags, u16 *id);66extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);67extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,68 unsigned int readid_flags);69extern int ata_dev_configure(struct ata_device *dev);70extern bool ata_dev_power_init_tf(struct ata_device *dev,71 struct ata_taskfile *tf, bool set_active);72extern void ata_dev_power_set_standby(struct ata_device *dev);73extern void ata_dev_power_set_active(struct ata_device *dev);74void ata_dev_free_resources(struct ata_device *dev);75extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);76extern unsigned int ata_dev_set_feature(struct ata_device *dev,77 u8 subcmd, u8 action);78extern void ata_qc_free(struct ata_queued_cmd *qc);79extern void ata_qc_issue(struct ata_queued_cmd *qc);80extern void __ata_qc_complete(struct ata_queued_cmd *qc);81extern int atapi_check_dma(struct ata_queued_cmd *qc);82extern void swap_buf_le16(u16 *buf, unsigned int buf_words);83extern bool ata_phys_link_online(struct ata_link *link);84extern bool ata_phys_link_offline(struct ata_link *link);85extern void ata_dev_init(struct ata_device *dev);86extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);87extern int sata_link_init_spd(struct ata_link *link);88extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);89extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);90extern const char *sata_spd_string(unsigned int spd);91extern unsigned int ata_read_log_page(struct ata_device *dev, u8 log,92 u8 page, void *buf, unsigned int sectors);93void 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_HOST99int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);100int ata_eh_get_ncq_success_sense(struct ata_link *link);101#else102static inline int sata_down_spd_limit(struct ata_link *link, u32 spd_limit)103{104 return -EOPNOTSUPP;105}106static inline int ata_eh_get_ncq_success_sense(struct ata_link *link)107{108 return -EOPNOTSUPP;109}110#endif111 112/* libata-acpi.c */113#ifdef CONFIG_ATA_ACPI114extern unsigned int ata_acpi_gtf_filter;115extern void ata_acpi_dissociate(struct ata_host *host);116extern void ata_acpi_on_resume(struct ata_port *ap);117extern int ata_acpi_on_devcfg(struct ata_device *dev);118extern void ata_acpi_on_disable(struct ata_device *dev);119extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);120extern void ata_acpi_bind_port(struct ata_port *ap);121extern void ata_acpi_bind_dev(struct ata_device *dev);122extern acpi_handle ata_dev_acpi_handle(struct ata_device *dev);123#else124static inline void ata_acpi_dissociate(struct ata_host *host) { }125static inline void ata_acpi_on_resume(struct ata_port *ap) { }126static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }127static inline void ata_acpi_on_disable(struct ata_device *dev) { }128static inline void ata_acpi_set_state(struct ata_port *ap,129 pm_message_t state) { }130static inline void ata_acpi_bind_port(struct ata_port *ap) {}131static inline void ata_acpi_bind_dev(struct ata_device *dev) {}132#endif133 134/* libata-scsi.c */135extern struct ata_device *ata_scsi_find_dev(struct ata_port *ap,136 const struct scsi_device *scsidev);137extern int ata_scsi_add_hosts(struct ata_host *host,138 const struct scsi_host_template *sht);139extern void ata_scsi_scan_host(struct ata_port *ap, int sync);140extern int ata_scsi_offline_dev(struct ata_device *dev);141extern bool ata_scsi_sense_is_valid(u8 sk, u8 asc, u8 ascq);142extern void ata_scsi_set_sense(struct ata_device *dev,143 struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq);144extern void ata_scsi_set_sense_information(struct ata_device *dev,145 struct scsi_cmnd *cmd,146 const struct ata_taskfile *tf);147extern void ata_scsi_media_change_notify(struct ata_device *dev);148extern void ata_scsi_hotplug(struct work_struct *work);149extern void ata_scsi_dev_rescan(struct work_struct *work);150extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,151 unsigned int id, u64 lun);152void ata_scsi_sdev_config(struct scsi_device *sdev);153int ata_scsi_dev_config(struct scsi_device *sdev, struct queue_limits *lim,154 struct ata_device *dev);155int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev);156 157/* libata-eh.c */158extern unsigned int ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);159extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);160extern void ata_eh_acquire(struct ata_port *ap);161extern void ata_eh_release(struct ata_port *ap);162extern void ata_scsi_error(struct Scsi_Host *host);163extern void ata_eh_fastdrain_timerfn(struct timer_list *t);164extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);165extern void ata_dev_disable(struct ata_device *dev);166extern void ata_eh_detach_dev(struct ata_device *dev);167extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,168 unsigned int action);169extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,170 unsigned int action);171extern void ata_eh_autopsy(struct ata_port *ap);172const char *ata_get_cmd_name(u8 command);173extern void ata_eh_report(struct ata_port *ap);174extern int ata_eh_reset(struct ata_link *link, int classify,175 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,176 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);177extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);178extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,179 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,180 ata_postreset_fn_t postreset,181 struct ata_link **r_failed_disk);182extern void ata_eh_finish(struct ata_port *ap);183extern int ata_ering_map(struct ata_ering *ering,184 int (*map_fn)(struct ata_ering_entry *, void *),185 void *arg);186enum scsi_disposition ata_eh_decide_disposition(struct ata_queued_cmd *qc);187extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key);188extern unsigned int atapi_eh_request_sense(struct ata_device *dev,189 u8 *sense_buf, u8 dfl_sense_key);190 191/* libata-pmp.c */192#ifdef CONFIG_SATA_PMP193extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);194extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);195extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,196 unsigned hints);197extern int sata_pmp_attach(struct ata_device *dev);198#else /* CONFIG_SATA_PMP */199static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)200{201 return -EINVAL;202}203 204static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)205{206 return -EINVAL;207}208 209static inline int sata_pmp_set_lpm(struct ata_link *link,210 enum ata_lpm_policy policy, unsigned hints)211{212 return -EINVAL;213}214 215static inline int sata_pmp_attach(struct ata_device *dev)216{217 return -EINVAL;218}219#endif /* CONFIG_SATA_PMP */220 221/* libata-sff.c */222#ifdef CONFIG_ATA_SFF223extern void ata_sff_flush_pio_task(struct ata_port *ap);224extern void ata_sff_port_init(struct ata_port *ap);225extern int ata_sff_init(void);226extern void ata_sff_exit(void);227#else /* CONFIG_ATA_SFF */228static inline void ata_sff_flush_pio_task(struct ata_port *ap)229{ }230static inline void ata_sff_port_init(struct ata_port *ap)231{ }232static inline int ata_sff_init(void)233{ return 0; }234static inline void ata_sff_exit(void)235{ }236#endif /* CONFIG_ATA_SFF */237 238/* libata-zpodd.c */239#ifdef CONFIG_SATA_ZPODD240void zpodd_init(struct ata_device *dev);241void zpodd_exit(struct ata_device *dev);242static inline bool zpodd_dev_enabled(struct ata_device *dev)243{244 return dev->zpodd != NULL;245}246void zpodd_on_suspend(struct ata_device *dev);247bool zpodd_zpready(struct ata_device *dev);248void zpodd_enable_run_wake(struct ata_device *dev);249void zpodd_disable_run_wake(struct ata_device *dev);250void zpodd_post_poweron(struct ata_device *dev);251#else /* CONFIG_SATA_ZPODD */252static inline void zpodd_init(struct ata_device *dev) {}253static inline void zpodd_exit(struct ata_device *dev) {}254static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; }255static inline void zpodd_on_suspend(struct ata_device *dev) {}256static inline bool zpodd_zpready(struct ata_device *dev) { return false; }257static inline void zpodd_enable_run_wake(struct ata_device *dev) {}258static inline void zpodd_disable_run_wake(struct ata_device *dev) {}259static inline void zpodd_post_poweron(struct ata_device *dev) {}260#endif /* CONFIG_SATA_ZPODD */261 262#endif /* __LIBATA_H__ */263