libata.h 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227
  1. /*
  2. * libata.h - helper library for ATA
  3. *
  4. * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
  5. * Copyright 2003-2004 Jeff Garzik
  6. *
  7. *
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation; either version 2, or (at your option)
  11. * any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program; see the file COPYING. If not, write to
  20. * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  21. *
  22. *
  23. * libata documentation is available via 'make {ps|pdf}docs',
  24. * as Documentation/DocBook/libata.*
  25. *
  26. */
  27. #ifndef __LIBATA_H__
  28. #define __LIBATA_H__
  29. #define DRV_NAME "libata"
  30. #define DRV_VERSION "3.00" /* must be exactly four chars */
  31. struct ata_scsi_args {
  32. struct ata_device *dev;
  33. u16 *id;
  34. struct scsi_cmnd *cmd;
  35. void (*done)(struct scsi_cmnd *);
  36. };
  37. /* libata-core.c */
  38. enum {
  39. /* flags for ata_dev_read_id() */
  40. ATA_READID_POSTRESET = (1 << 0), /* reading ID after reset */
  41. /* selector for ata_down_xfermask_limit() */
  42. ATA_DNXFER_PIO = 0, /* speed down PIO */
  43. ATA_DNXFER_DMA = 1, /* speed down DMA */
  44. ATA_DNXFER_40C = 2, /* apply 40c cable limit */
  45. ATA_DNXFER_FORCE_PIO = 3, /* force PIO */
  46. ATA_DNXFER_FORCE_PIO0 = 4, /* force PIO0 */
  47. ATA_DNXFER_QUIET = (1 << 31),
  48. };
  49. extern atomic_t ata_print_id;
  50. extern int atapi_passthru16;
  51. extern int libata_fua;
  52. extern int libata_noacpi;
  53. extern int libata_allow_tpm;
  54. extern struct device_type ata_port_type;
  55. extern struct ata_link *ata_dev_phys_link(struct ata_device *dev);
  56. extern void ata_force_cbl(struct ata_port *ap);
  57. extern u64 ata_tf_to_lba(const struct ata_taskfile *tf);
  58. extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf);
  59. extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev);
  60. extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
  61. u64 block, u32 n_block, unsigned int tf_flags,
  62. unsigned int tag);
  63. extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev);
  64. extern unsigned ata_exec_internal(struct ata_device *dev,
  65. struct ata_taskfile *tf, const u8 *cdb,
  66. int dma_dir, void *buf, unsigned int buflen,
  67. unsigned long timeout);
  68. extern unsigned ata_exec_internal_sg(struct ata_device *dev,
  69. struct ata_taskfile *tf, const u8 *cdb,
  70. int dma_dir, struct scatterlist *sg,
  71. unsigned int n_elem, unsigned long timeout);
  72. extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd);
  73. extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
  74. int (*check_ready)(struct ata_link *link));
  75. extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
  76. unsigned int flags, u16 *id);
  77. extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
  78. extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
  79. unsigned int readid_flags);
  80. extern int ata_dev_configure(struct ata_device *dev);
  81. extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit);
  82. extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
  83. extern unsigned int ata_dev_set_feature(struct ata_device *dev,
  84. u8 enable, u8 feature);
  85. extern void ata_sg_clean(struct ata_queued_cmd *qc);
  86. extern void ata_qc_free(struct ata_queued_cmd *qc);
  87. extern void ata_qc_issue(struct ata_queued_cmd *qc);
  88. extern void __ata_qc_complete(struct ata_queued_cmd *qc);
  89. extern int atapi_check_dma(struct ata_queued_cmd *qc);
  90. extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
  91. extern bool ata_phys_link_online(struct ata_link *link);
  92. extern bool ata_phys_link_offline(struct ata_link *link);
  93. extern void ata_dev_init(struct ata_device *dev);
  94. extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
  95. extern int sata_link_init_spd(struct ata_link *link);
  96. extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
  97. extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
  98. extern struct ata_port *ata_port_alloc(struct ata_host *host);
  99. extern const char *sata_spd_string(unsigned int spd);
  100. extern int ata_port_probe(struct ata_port *ap);
  101. extern void __ata_port_probe(struct ata_port *ap);
  102. /* libata-acpi.c */
  103. #ifdef CONFIG_ATA_ACPI
  104. extern unsigned int ata_acpi_gtf_filter;
  105. extern void ata_acpi_associate_sata_port(struct ata_port *ap);
  106. extern void ata_acpi_associate(struct ata_host *host);
  107. extern void ata_acpi_dissociate(struct ata_host *host);
  108. extern int ata_acpi_on_suspend(struct ata_port *ap);
  109. extern void ata_acpi_on_resume(struct ata_port *ap);
  110. extern int ata_acpi_on_devcfg(struct ata_device *dev);
  111. extern void ata_acpi_on_disable(struct ata_device *dev);
  112. extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
  113. #else
  114. static inline void ata_acpi_associate_sata_port(struct ata_port *ap) { }
  115. static inline void ata_acpi_associate(struct ata_host *host) { }
  116. static inline void ata_acpi_dissociate(struct ata_host *host) { }
  117. static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
  118. static inline void ata_acpi_on_resume(struct ata_port *ap) { }
  119. static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
  120. static inline void ata_acpi_on_disable(struct ata_device *dev) { }
  121. static inline void ata_acpi_set_state(struct ata_port *ap,
  122. pm_message_t state) { }
  123. #endif
  124. /* libata-scsi.c */
  125. extern int ata_scsi_add_hosts(struct ata_host *host,
  126. struct scsi_host_template *sht);
  127. extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
  128. extern int ata_scsi_offline_dev(struct ata_device *dev);
  129. extern void ata_scsi_media_change_notify(struct ata_device *dev);
  130. extern void ata_scsi_hotplug(struct work_struct *work);
  131. extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
  132. extern void ata_scsi_dev_rescan(struct work_struct *work);
  133. extern int ata_bus_probe(struct ata_port *ap);
  134. extern int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
  135. unsigned int id, unsigned int lun);
  136. /* libata-eh.c */
  137. extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd);
  138. extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd);
  139. extern void ata_eh_acquire(struct ata_port *ap);
  140. extern void ata_eh_release(struct ata_port *ap);
  141. extern enum blk_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
  142. extern void ata_scsi_error(struct Scsi_Host *host);
  143. extern void ata_eh_fastdrain_timerfn(unsigned long arg);
  144. extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
  145. extern void ata_dev_disable(struct ata_device *dev);
  146. extern void ata_eh_detach_dev(struct ata_device *dev);
  147. extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
  148. unsigned int action);
  149. extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
  150. unsigned int action);
  151. extern void ata_eh_autopsy(struct ata_port *ap);
  152. const char *ata_get_cmd_descript(u8 command);
  153. extern void ata_eh_report(struct ata_port *ap);
  154. extern int ata_eh_reset(struct ata_link *link, int classify,
  155. ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
  156. ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
  157. extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
  158. extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
  159. ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
  160. ata_postreset_fn_t postreset,
  161. struct ata_link **r_failed_disk);
  162. extern void ata_eh_finish(struct ata_port *ap);
  163. extern int ata_ering_map(struct ata_ering *ering,
  164. int (*map_fn)(struct ata_ering_entry *, void *),
  165. void *arg);
  166. /* libata-pmp.c */
  167. #ifdef CONFIG_SATA_PMP
  168. extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
  169. extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
  170. extern int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
  171. unsigned hints);
  172. extern int sata_pmp_attach(struct ata_device *dev);
  173. #else /* CONFIG_SATA_PMP */
  174. static inline int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val)
  175. {
  176. return -EINVAL;
  177. }
  178. static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
  179. {
  180. return -EINVAL;
  181. }
  182. static inline int sata_pmp_set_lpm(struct ata_link *link,
  183. enum ata_lpm_policy policy, unsigned hints)
  184. {
  185. return -EINVAL;
  186. }
  187. static inline int sata_pmp_attach(struct ata_device *dev)
  188. {
  189. return -EINVAL;
  190. }
  191. #endif /* CONFIG_SATA_PMP */
  192. /* libata-sff.c */
  193. #ifdef CONFIG_ATA_SFF
  194. extern void ata_sff_flush_pio_task(struct ata_port *ap);
  195. extern void ata_sff_port_init(struct ata_port *ap);
  196. extern int ata_sff_init(void);
  197. extern void ata_sff_exit(void);
  198. #else /* CONFIG_ATA_SFF */
  199. static inline void ata_sff_flush_pio_task(struct ata_port *ap)
  200. { }
  201. static inline void ata_sff_port_init(struct ata_port *ap)
  202. { }
  203. static inline int ata_sff_init(void)
  204. { return 0; }
  205. static inline void ata_sff_exit(void)
  206. { }
  207. #endif /* CONFIG_ATA_SFF */
  208. #endif /* __LIBATA_H__ */