Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
Jeff Garzik | af36d7f | 2005-08-28 20:18:39 -0400 | [diff] [blame] | 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 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 26 | */ |
| 27 | |
| 28 | #ifndef __LIBATA_H__ |
| 29 | #define __LIBATA_H__ |
| 30 | |
| 31 | #define DRV_NAME "libata" |
Tejun Heo | 633273a | 2007-09-23 13:19:54 +0900 | [diff] [blame] | 32 | #define DRV_VERSION "3.00" /* must be exactly four chars */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 33 | |
| 34 | struct ata_scsi_args { |
Tejun Heo | 9a3dccc | 2006-01-06 09:56:18 +0100 | [diff] [blame] | 35 | struct ata_device *dev; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 36 | u16 *id; |
| 37 | struct scsi_cmnd *cmd; |
| 38 | void (*done)(struct scsi_cmnd *); |
| 39 | }; |
| 40 | |
| 41 | /* libata-core.c */ |
Tejun Heo | bff0464 | 2006-11-10 18:08:10 +0900 | [diff] [blame] | 42 | enum { |
| 43 | /* flags for ata_dev_read_id() */ |
| 44 | ATA_READID_POSTRESET = (1 << 0), /* reading ID after reset */ |
Tejun Heo | 458337d | 2007-02-02 16:22:30 +0900 | [diff] [blame] | 45 | |
| 46 | /* selector for ata_down_xfermask_limit() */ |
| 47 | ATA_DNXFER_PIO = 0, /* speed down PIO */ |
| 48 | ATA_DNXFER_DMA = 1, /* speed down DMA */ |
| 49 | ATA_DNXFER_40C = 2, /* apply 40c cable limit */ |
| 50 | ATA_DNXFER_FORCE_PIO = 3, /* force PIO */ |
| 51 | ATA_DNXFER_FORCE_PIO0 = 4, /* force PIO0 */ |
Tejun Heo | 458337d | 2007-02-02 16:22:30 +0900 | [diff] [blame] | 52 | |
| 53 | ATA_DNXFER_QUIET = (1 << 31), |
Tejun Heo | bff0464 | 2006-11-10 18:08:10 +0900 | [diff] [blame] | 54 | }; |
| 55 | |
Tejun Heo | f318719 | 2007-04-17 23:44:07 +0900 | [diff] [blame] | 56 | extern unsigned int ata_print_id; |
Mark Lord | baf4fdf | 2007-08-08 01:08:45 +0900 | [diff] [blame] | 57 | extern int atapi_passthru16; |
Jeff Garzik | c3c013a | 2006-02-27 22:31:19 -0500 | [diff] [blame] | 58 | extern int libata_fua; |
Jeff Garzik | d7d0dad | 2007-03-28 01:57:37 -0400 | [diff] [blame] | 59 | extern int libata_noacpi; |
Alan Cox | ae8d4ee | 2007-11-04 22:05:49 -0500 | [diff] [blame] | 60 | extern int libata_allow_tpm; |
Tejun Heo | b1c7291 | 2008-07-31 17:02:43 +0900 | [diff] [blame] | 61 | extern struct ata_link *ata_dev_phys_link(struct ata_device *dev); |
Tejun Heo | 3326732 | 2008-02-13 09:15:09 +0900 | [diff] [blame] | 62 | extern void ata_force_cbl(struct ata_port *ap); |
Tejun Heo | a5987e0 | 2008-03-27 19:14:23 +0900 | [diff] [blame] | 63 | extern u64 ata_tf_to_lba(const struct ata_taskfile *tf); |
| 64 | extern u64 ata_tf_to_lba48(const struct ata_taskfile *tf); |
Tejun Heo | 8a8bc22 | 2008-11-10 14:48:21 +0900 | [diff] [blame] | 65 | extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev); |
Tejun Heo | bd056d7 | 2006-11-14 22:47:10 +0900 | [diff] [blame] | 66 | extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev, |
| 67 | u64 block, u32 n_block, unsigned int tf_flags, |
| 68 | unsigned int tag); |
Tejun Heo | 35b649f | 2006-11-14 22:37:35 +0900 | [diff] [blame] | 69 | extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev); |
Tejun Heo | 3373efd | 2006-05-15 20:57:53 +0900 | [diff] [blame] | 70 | extern unsigned ata_exec_internal(struct ata_device *dev, |
Tejun Heo | 1ad8e7f | 2006-04-02 18:51:53 +0900 | [diff] [blame] | 71 | struct ata_taskfile *tf, const u8 *cdb, |
Tejun Heo | 2b78910 | 2007-10-09 15:05:44 +0900 | [diff] [blame] | 72 | int dma_dir, void *buf, unsigned int buflen, |
| 73 | unsigned long timeout); |
Tejun Heo | 2432697 | 2006-11-14 22:47:09 +0900 | [diff] [blame] | 74 | extern unsigned ata_exec_internal_sg(struct ata_device *dev, |
| 75 | struct ata_taskfile *tf, const u8 *cdb, |
| 76 | int dma_dir, struct scatterlist *sg, |
Tejun Heo | 2b78910 | 2007-10-09 15:05:44 +0900 | [diff] [blame] | 77 | unsigned int n_elem, unsigned long timeout); |
Tejun Heo | 77b08fb | 2006-06-24 20:30:19 +0900 | [diff] [blame] | 78 | extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd); |
Tejun Heo | aa2731a | 2008-04-07 22:47:19 +0900 | [diff] [blame] | 79 | extern int ata_wait_ready(struct ata_link *link, unsigned long deadline, |
| 80 | int (*check_ready)(struct ata_link *link)); |
Tejun Heo | a9beec9 | 2006-05-31 18:27:44 +0900 | [diff] [blame] | 81 | extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class, |
Tejun Heo | bff0464 | 2006-11-10 18:08:10 +0900 | [diff] [blame] | 82 | unsigned int flags, u16 *id); |
Tejun Heo | fe30911 | 2007-05-15 03:28:15 +0900 | [diff] [blame] | 83 | extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags); |
Tejun Heo | 422c9da | 2007-09-23 13:14:12 +0900 | [diff] [blame] | 84 | extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class, |
| 85 | unsigned int readid_flags); |
Tejun Heo | efdaedc | 2006-11-01 18:38:52 +0900 | [diff] [blame] | 86 | extern int ata_dev_configure(struct ata_device *dev); |
Tejun Heo | a07d499 | 2009-01-29 20:31:33 +0900 | [diff] [blame] | 87 | extern int sata_down_spd_limit(struct ata_link *link, u32 spd_limit); |
Tejun Heo | 458337d | 2007-02-02 16:22:30 +0900 | [diff] [blame] | 88 | extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel); |
Tejun Heo | 70e6ad0 | 2006-11-14 22:47:10 +0900 | [diff] [blame] | 89 | extern void ata_sg_clean(struct ata_queued_cmd *qc); |
Tejun Heo | 8a8bc22 | 2008-11-10 14:48:21 +0900 | [diff] [blame] | 90 | extern void ata_qc_free(struct ata_queued_cmd *qc); |
Tejun Heo | 8e0e694 | 2006-03-31 20:41:11 +0900 | [diff] [blame] | 91 | extern void ata_qc_issue(struct ata_queued_cmd *qc); |
Tejun Heo | f686bcb | 2006-05-15 20:58:05 +0900 | [diff] [blame] | 92 | extern void __ata_qc_complete(struct ata_queued_cmd *qc); |
Tejun Heo | 5895ef9 | 2008-06-17 12:36:26 +0900 | [diff] [blame] | 93 | extern int atapi_check_dma(struct ata_queued_cmd *qc); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 94 | extern void swap_buf_le16(u16 *buf, unsigned int buf_words); |
Tejun Heo | b1c7291 | 2008-07-31 17:02:43 +0900 | [diff] [blame] | 95 | extern bool ata_phys_link_online(struct ata_link *link); |
| 96 | extern bool ata_phys_link_offline(struct ata_link *link); |
Tejun Heo | 3ef3b43 | 2006-05-31 18:27:30 +0900 | [diff] [blame] | 97 | extern void ata_dev_init(struct ata_device *dev); |
Tejun Heo | fb7fd61 | 2007-09-23 13:14:12 +0900 | [diff] [blame] | 98 | extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp); |
| 99 | extern int sata_link_init_spd(struct ata_link *link); |
Jeff Garzik | b095518 | 2005-05-12 15:45:22 -0400 | [diff] [blame] | 100 | extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg); |
| 101 | extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg); |
Tejun Heo | f318719 | 2007-04-17 23:44:07 +0900 | [diff] [blame] | 102 | extern struct ata_port *ata_port_alloc(struct ata_host *host); |
Kristen Carlson Accardi | ca77329 | 2007-10-25 00:58:59 -0400 | [diff] [blame] | 103 | extern void ata_dev_enable_pm(struct ata_device *dev, enum link_pm policy); |
| 104 | extern void ata_lpm_schedule(struct ata_port *ap, enum link_pm); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 105 | |
Kristen Carlson Accardi | 11ef697 | 2006-09-28 11:29:01 -0700 | [diff] [blame] | 106 | /* libata-acpi.c */ |
Tejun Heo | e92351b | 2007-05-05 23:50:38 +0900 | [diff] [blame] | 107 | #ifdef CONFIG_ATA_ACPI |
Tejun Heo | 110f66d | 2009-09-16 04:17:28 +0900 | [diff] [blame] | 108 | extern unsigned int ata_acpi_gtf_filter; |
| 109 | |
Tejun Heo | d0df8b5d | 2007-09-23 13:19:54 +0900 | [diff] [blame] | 110 | extern void ata_acpi_associate_sata_port(struct ata_port *ap); |
Tejun Heo | fafbae8 | 2007-05-15 03:28:16 +0900 | [diff] [blame] | 111 | extern void ata_acpi_associate(struct ata_host *host); |
Tejun Heo | 562f0c2 | 2007-12-15 15:05:01 +0900 | [diff] [blame] | 112 | extern void ata_acpi_dissociate(struct ata_host *host); |
Tejun Heo | 64578a3 | 2007-05-15 03:28:16 +0900 | [diff] [blame] | 113 | extern int ata_acpi_on_suspend(struct ata_port *ap); |
Tejun Heo | 6746544 | 2007-05-15 03:28:16 +0900 | [diff] [blame] | 114 | extern void ata_acpi_on_resume(struct ata_port *ap); |
Tejun Heo | 562f0c2 | 2007-12-15 15:05:01 +0900 | [diff] [blame] | 115 | extern int ata_acpi_on_devcfg(struct ata_device *dev); |
| 116 | extern void ata_acpi_on_disable(struct ata_device *dev); |
Shaohua Li | bd3adca | 2007-11-02 09:32:38 +0800 | [diff] [blame] | 117 | extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state); |
Kristen Carlson Accardi | 11ef697 | 2006-09-28 11:29:01 -0700 | [diff] [blame] | 118 | #else |
Tejun Heo | d0df8b5d | 2007-09-23 13:19:54 +0900 | [diff] [blame] | 119 | static inline void ata_acpi_associate_sata_port(struct ata_port *ap) { } |
Tejun Heo | fafbae8 | 2007-05-15 03:28:16 +0900 | [diff] [blame] | 120 | static inline void ata_acpi_associate(struct ata_host *host) { } |
Tejun Heo | 562f0c2 | 2007-12-15 15:05:01 +0900 | [diff] [blame] | 121 | static inline void ata_acpi_dissociate(struct ata_host *host) { } |
Tejun Heo | 64578a3 | 2007-05-15 03:28:16 +0900 | [diff] [blame] | 122 | static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; } |
Tejun Heo | 6746544 | 2007-05-15 03:28:16 +0900 | [diff] [blame] | 123 | static inline void ata_acpi_on_resume(struct ata_port *ap) { } |
Tejun Heo | 562f0c2 | 2007-12-15 15:05:01 +0900 | [diff] [blame] | 124 | static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; } |
| 125 | static inline void ata_acpi_on_disable(struct ata_device *dev) { } |
Shaohua Li | bd3adca | 2007-11-02 09:32:38 +0800 | [diff] [blame] | 126 | static inline void ata_acpi_set_state(struct ata_port *ap, |
| 127 | pm_message_t state) { } |
Kristen Carlson Accardi | 11ef697 | 2006-09-28 11:29:01 -0700 | [diff] [blame] | 128 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 129 | |
| 130 | /* libata-scsi.c */ |
Tejun Heo | f318719 | 2007-04-17 23:44:07 +0900 | [diff] [blame] | 131 | extern int ata_scsi_add_hosts(struct ata_host *host, |
| 132 | struct scsi_host_template *sht); |
Tejun Heo | 1ae4631 | 2007-07-16 14:29:40 +0900 | [diff] [blame] | 133 | extern void ata_scsi_scan_host(struct ata_port *ap, int sync); |
Tejun Heo | 0ea035a | 2006-05-31 18:28:01 +0900 | [diff] [blame] | 134 | extern int ata_scsi_offline_dev(struct ata_device *dev); |
Tejun Heo | 7d77b24 | 2007-09-23 13:14:13 +0900 | [diff] [blame] | 135 | extern void ata_scsi_media_change_notify(struct ata_device *dev); |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 136 | extern void ata_scsi_hotplug(struct work_struct *work); |
Tejun Heo | 7b70fc0 | 2006-05-15 20:58:07 +0900 | [diff] [blame] | 137 | extern void ata_schedule_scsi_eh(struct Scsi_Host *shost); |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 138 | extern void ata_scsi_dev_rescan(struct work_struct *work); |
Brian King | 8028916 | 2006-08-07 14:27:31 -0500 | [diff] [blame] | 139 | extern int ata_bus_probe(struct ata_port *ap); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 140 | |
Tejun Heo | ece1d63 | 2006-04-02 18:51:53 +0900 | [diff] [blame] | 141 | /* libata-eh.c */ |
Tejun Heo | 87fbc5a | 2008-05-20 02:17:54 +0900 | [diff] [blame] | 142 | extern unsigned long ata_internal_cmd_timeout(struct ata_device *dev, u8 cmd); |
| 143 | extern void ata_internal_cmd_timed_out(struct ata_device *dev, u8 cmd); |
Jens Axboe | 242f9dc | 2008-09-14 05:55:09 -0700 | [diff] [blame] | 144 | extern enum blk_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd); |
Jeff Garzik | 381544b | 2006-04-11 13:04:39 -0400 | [diff] [blame] | 145 | extern void ata_scsi_error(struct Scsi_Host *host); |
Tejun Heo | c6cf9e9 | 2006-05-31 18:27:27 +0900 | [diff] [blame] | 146 | extern void ata_port_wait_eh(struct ata_port *ap); |
Tejun Heo | 5ddf24c | 2007-07-16 14:29:41 +0900 | [diff] [blame] | 147 | extern void ata_eh_fastdrain_timerfn(unsigned long arg); |
Tejun Heo | f686bcb | 2006-05-15 20:58:05 +0900 | [diff] [blame] | 148 | extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc); |
Tejun Heo | 678afac | 2009-01-29 20:31:30 +0900 | [diff] [blame] | 149 | extern void ata_dev_disable(struct ata_device *dev); |
Tejun Heo | fb7fd61 | 2007-09-23 13:14:12 +0900 | [diff] [blame] | 150 | extern void ata_eh_detach_dev(struct ata_device *dev); |
| 151 | extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev, |
| 152 | unsigned int action); |
| 153 | extern void ata_eh_done(struct ata_link *link, struct ata_device *dev, |
| 154 | unsigned int action); |
| 155 | extern void ata_eh_autopsy(struct ata_port *ap); |
Robert Hancock | 6521148 | 2009-07-14 20:43:39 -0600 | [diff] [blame] | 156 | const char *ata_get_cmd_descript(u8 command); |
Tejun Heo | fb7fd61 | 2007-09-23 13:14:12 +0900 | [diff] [blame] | 157 | extern void ata_eh_report(struct ata_port *ap); |
| 158 | extern int ata_eh_reset(struct ata_link *link, int classify, |
| 159 | ata_prereset_fn_t prereset, ata_reset_fn_t softreset, |
| 160 | ata_reset_fn_t hardreset, ata_postreset_fn_t postreset); |
Tejun Heo | 6f1d1e3 | 2007-11-27 19:28:55 +0900 | [diff] [blame] | 161 | extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev); |
Tejun Heo | fb7fd61 | 2007-09-23 13:14:12 +0900 | [diff] [blame] | 162 | extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset, |
| 163 | ata_reset_fn_t softreset, ata_reset_fn_t hardreset, |
| 164 | ata_postreset_fn_t postreset, |
| 165 | struct ata_link **r_failed_disk); |
| 166 | extern void ata_eh_finish(struct ata_port *ap); |
Tejun Heo | ece1d63 | 2006-04-02 18:51:53 +0900 | [diff] [blame] | 167 | |
Tejun Heo | 48515f6 | 2008-04-07 22:47:21 +0900 | [diff] [blame] | 168 | /* libata-pmp.c */ |
Tejun Heo | 88fcd56 | 2008-04-07 22:47:22 +0900 | [diff] [blame] | 169 | #ifdef CONFIG_SATA_PMP |
Tejun Heo | 48515f6 | 2008-04-07 22:47:21 +0900 | [diff] [blame] | 170 | extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val); |
| 171 | extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val); |
| 172 | extern int sata_pmp_attach(struct ata_device *dev); |
Tejun Heo | 88fcd56 | 2008-04-07 22:47:22 +0900 | [diff] [blame] | 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 | |
| 179 | static inline int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val) |
| 180 | { |
| 181 | return -EINVAL; |
| 182 | } |
| 183 | |
| 184 | static inline int sata_pmp_attach(struct ata_device *dev) |
| 185 | { |
| 186 | return -EINVAL; |
| 187 | } |
| 188 | #endif /* CONFIG_SATA_PMP */ |
Tejun Heo | 48515f6 | 2008-04-07 22:47:21 +0900 | [diff] [blame] | 189 | |
Tejun Heo | 90088bb | 2006-10-09 11:10:26 +0900 | [diff] [blame] | 190 | /* libata-sff.c */ |
Tejun Heo | 127102a | 2008-04-07 22:47:21 +0900 | [diff] [blame] | 191 | #ifdef CONFIG_ATA_SFF |
Tejun Heo | c429137 | 2010-05-10 21:41:38 +0200 | [diff] [blame] | 192 | extern void ata_sff_flush_pio_task(struct ata_port *ap); |
Tejun Heo | 270390e | 2010-05-10 21:41:35 +0200 | [diff] [blame] | 193 | extern void ata_sff_port_init(struct ata_port *ap); |
| 194 | extern int ata_sff_init(void); |
| 195 | extern void ata_sff_exit(void); |
| 196 | #else /* CONFIG_ATA_SFF */ |
Tejun Heo | c429137 | 2010-05-10 21:41:38 +0200 | [diff] [blame] | 197 | static inline void ata_sff_flush_pio_task(struct ata_port *ap) |
| 198 | { } |
Tejun Heo | 270390e | 2010-05-10 21:41:35 +0200 | [diff] [blame] | 199 | static inline void ata_sff_port_init(struct ata_port *ap) |
| 200 | { } |
| 201 | static inline int ata_sff_init(void) |
| 202 | { return 0; } |
| 203 | static inline void ata_sff_exit(void) |
| 204 | { } |
Tejun Heo | 127102a | 2008-04-07 22:47:21 +0900 | [diff] [blame] | 205 | #endif /* CONFIG_ATA_SFF */ |
Adrian Bunk | 77a527e | 2007-01-30 00:59:17 -0800 | [diff] [blame] | 206 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 207 | #endif /* __LIBATA_H__ */ |