libata.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
  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. #ifndef __LIBATA_H__
  12. #define __LIBATA_H__
  13. #define DRV_NAME "libata"
  14. #define DRV_VERSION "3.00" /* must be exactly four chars */
  15. /* libata-core.c */
  16. enum {
  17. /* flags for ata_dev_read_id() */
  18. ATA_READID_POSTRESET = (1 << 0), /* reading ID after reset */
  19. /* selector for ata_down_xfermask_limit() */
  20. ATA_DNXFER_PIO = 0, /* speed down PIO */
  21. ATA_DNXFER_DMA = 1, /* speed down DMA */
  22. ATA_DNXFER_40C = 2, /* apply 40c cable limit */
  23. ATA_DNXFER_FORCE_PIO = 3, /* force PIO */
  24. ATA_DNXFER_FORCE_PIO0 = 4, /* force PIO0 */
  25. ATA_DNXFER_QUIET = (1 << 31),
  26. };
  27. extern atomic_t ata_print_id;
  28. extern int atapi_passthru16;
  29. extern int libata_fua;
  30. extern int libata_noacpi;
  31. extern int libata_allow_tpm;
  32. extern const struct device_type ata_port_type;
  33. extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
  34. #ifdef CONFIG_ATA_FORCE
  35. extern void ata_force_cbl(struct ata_port *ap);
  36. #else
  37. static inline void ata_force_cbl(struct ata_port *ap) { }
  38. #endif
  39. extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
  40. extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
  41. extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev, int tag);
  42. extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
  43. u64 block, u32 n_block, unsigned int tf_flags,
  44. unsigned int tag, int class);
  45. extern u64 ata_tf_read_block(const struct ata_taskfile *tf,
  46. struct ata_device *dev);
  47. extern unsigned ata_exec_internal(struct ata_device *dev,
  48. struct ata_taskfile *tf, const u8 *cdb,
  49. int dma_dir, void *buf, unsigned int buflen,
  50. unsigned long timeout);
  51. extern unsigned ata_exec_internal_sg(struct ata_device *dev,
  52. struct ata_taskfile *tf, const u8 *cdb,
  53. int dma_dir, struct scatterlist *sg,
  54. unsigned int n_elem, unsigned long 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 enable, u8 feature);
  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 int ata_port_probe(struct ata_port *ap);
  82. extern void __ata_port_probe(struct ata_port *ap);
  83. extern unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
  84. u8 page, void *buf, unsigned int sectors);
  85. #define to_ata_port(d) container_of(d, struct ata_port, tdev)
  86. /* libata-sata.c */
  87. #ifdef CONFIG_SATA_HOST
  88. int ata_sas_allocate_tag(struct ata_port *ap);
  89. void ata_sas_free_tag(unsigned int tag, struct ata_port *ap);
  90. #else
  91. static inline int ata_sas_allocate_tag(struct ata_port *ap)
  92. {
  93. return -EOPNOTSUPP;
  94. }
  95. static inline void ata_sas_free_tag(unsigned int tag, struct ata_port *ap) { }
  96. #endif
  97. /* libata-acpi.c */
  98. #ifdef CONFIG_ATA_ACPI
  99. extern unsigned int ata_acpi_gtf_filter;
  100. extern void ata_acpi_dissociate(struct ata_host *host);
  101. extern int ata_acpi_on_suspend(struct ata_port *ap);
  102. extern void ata_acpi_on_resume(struct ata_port *ap);
  103. extern int ata_acpi_on_devcfg(struct ata_device *dev);
  104. extern void ata_acpi_on_disable(struct ata_device *dev);
  105. extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
  106. extern void ata_acpi_bind_port(struct ata_port *ap);
  107. extern void ata_acpi_bind_dev(struct ata_device *dev);
  108. extern acpi_handle ata_dev_acpi_handle(struct ata_device *dev);
  109. #else
  110. static inline void ata_acpi_dissociate(struct ata_host *host) { }
  111. static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
  112. static inline void ata_acpi_on_resume(struct ata_port *ap) { }
  113. static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
  114. static inline void ata_acpi_on_disable(struct ata_device *dev) { }
  115. static inline void ata_acpi_set_state(struct ata_port *ap,
  116. pm_message_t state) { }
  117. static inline void ata_acpi_bind_port(struct ata_port *ap) {}
  118. static inline void ata_acpi_bind_dev(struct ata_device *dev) {}
  119. #endif
  120. /* libata-scsi.c */
  121. extern struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
  122. const struct scsi_device *scsidev);
  123. extern int ata_scsi_add_hosts(struct ata_host *host,
  124. struct scsi_host_template *sht);
  125. extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
  126. extern int ata_scsi_offline_dev(struct ata_device *dev);
  127. extern void ata_scsi_set_sense(struct ata_device *dev,
  128. struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq);
  129. extern void ata_scsi_set_sense_information(struct ata_device *dev,
  130. struct scsi_cmnd *cmd,
  131. const struct ata_taskfile *tf);
  132. extern void ata_scsi_media_change_notify(struct ata_device *dev);
  133. extern void ata_scsi_hotplug(struct work_struct *work);
  134. extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
  135. extern void ata_scsi_dev_rescan(struct work_struct *work);
  136. extern int ata_bus_probe(struct ata_port *ap);
  137. extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
  138. unsigned int id, u64 lun);
  139. void ata_scsi_sdev_config(struct scsi_device *sdev);
  140. int ata_scsi_dev_config(struct scsi_device *sdev, struct ata_device *dev);
  141. void ata_scsi_dump_cdb(struct ata_port *ap, struct scsi_cmnd *cmd);
  142. int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev);
  143. /* libata-eh.c */
  144. extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
  145. extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
  146. extern void ata_eh_acquire(struct ata_port *ap);
  147. extern void ata_eh_release(struct ata_port *ap);
  148. extern void ata_scsi_error(struct Scsi_Host *host);
  149. extern void ata_eh_fastdrain_timerfn(struct timer_list *t);
  150. extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
  151. extern void ata_dev_disable(struct ata_device *dev);
  152. extern void ata_eh_detach_dev(struct ata_device *dev);
  153. extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
  154. unsigned int action);
  155. extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
  156. unsigned int action);
  157. extern void ata_eh_autopsy(struct ata_port *ap);
  158. const char *ata_get_cmd_descript(u8 command);
  159. extern void ata_eh_report(struct ata_port *ap);
  160. extern int ata_eh_reset(struct ata_link *link, int classify,
  161. ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
  162. ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
  163. extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
  164. extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
  165. ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
  166. ata_postreset_fn_t postreset,
  167. struct ata_link **r_failed_disk);
  168. extern void ata_eh_finish(struct ata_port *ap);
  169. extern int ata_ering_map(struct ata_ering *ering,
  170. int (*map_fn)(struct ata_ering_entry *, void *),
  171. void *arg);
  172. extern unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key);
  173. extern unsigned int atapi_eh_request_sense(struct ata_device *dev,
  174. u8 *sense_buf, u8 dfl_sense_key);
  175. /* libata-pmp.c */
  176. #ifdef CONFIG_SATA_PMP
  177. extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
  178. extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
  179. extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
  180. unsigned hints);
  181. extern int sata_pmp_attach(struct ata_device *dev);
  182. #else /* CONFIG_SATA_PMP */
  183. static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
  184. {
  185. return -EINVAL;
  186. }
  187. static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
  188. {
  189. return -EINVAL;
  190. }
  191. static inline int sata_pmp_set_lpm(struct ata_link *link,
  192. enum ata_lpm_policy policy, unsigned hints)
  193. {
  194. return -EINVAL;
  195. }
  196. static inline int sata_pmp_attach(struct ata_device *dev)
  197. {
  198. return -EINVAL;
  199. }
  200. #endif /* CONFIG_SATA_PMP */
  201. /* libata-sff.c */
  202. #ifdef CONFIG_ATA_SFF
  203. extern void ata_sff_flush_pio_task(struct ata_port *ap);
  204. extern void ata_sff_port_init(struct ata_port *ap);
  205. extern int ata_sff_init(void);
  206. extern void ata_sff_exit(void);
  207. #else /* CONFIG_ATA_SFF */
  208. static inline void ata_sff_flush_pio_task(struct ata_port *ap)
  209. { }
  210. static inline void ata_sff_port_init(struct ata_port *ap)
  211. { }
  212. static inline int ata_sff_init(void)
  213. { return 0; }
  214. static inline void ata_sff_exit(void)
  215. { }
  216. #endif /* CONFIG_ATA_SFF */
  217. /* libata-zpodd.c */
  218. #ifdef CONFIG_SATA_ZPODD
  219. void zpodd_init(struct ata_device *dev);
  220. void zpodd_exit(struct ata_device *dev);
  221. static inline bool zpodd_dev_enabled(struct ata_device *dev)
  222. {
  223. return dev->zpodd != NULL;
  224. }
  225. void zpodd_on_suspend(struct ata_device *dev);
  226. bool zpodd_zpready(struct ata_device *dev);
  227. void zpodd_enable_run_wake(struct ata_device *dev);
  228. void zpodd_disable_run_wake(struct ata_device *dev);
  229. void zpodd_post_poweron(struct ata_device *dev);
  230. #else /* CONFIG_SATA_ZPODD */
  231. static inline void zpodd_init(struct ata_device *dev) {}
  232. static inline void zpodd_exit(struct ata_device *dev) {}
  233. static inline bool zpodd_dev_enabled(struct ata_device *dev) { return false; }
  234. static inline void zpodd_on_suspend(struct ata_device *dev) {}
  235. static inline bool zpodd_zpready(struct ata_device *dev) { return false; }
  236. static inline void zpodd_enable_run_wake(struct ata_device *dev) {}
  237. static inline void zpodd_disable_run_wake(struct ata_device *dev) {}
  238. static inline void zpodd_post_poweron(struct ata_device *dev) {}
  239. #endif /* CONFIG_SATA_ZPODD */
  240. #endif /* __LIBATA_H__ */