2 * libata.h - helper library for ATA
4 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
5 * Copyright 2003-2004 Jeff Garzik
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)
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.
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.
23 * libata documentation is available via 'make {ps|pdf}docs',
24 * as Documentation/DocBook/libata.*
31 #define DRV_NAME "libata"
32 #define DRV_VERSION "3.00" /* must be exactly four chars */
34 struct ata_scsi_args {
35 struct ata_device *dev;
37 struct scsi_cmnd *cmd;
38 void (*done)(struct scsi_cmnd *);
43 /* flags for ata_dev_read_id() */
44 ATA_READID_POSTRESET = (1 << 0), /* reading ID after reset */
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 */
53 ATA_DNXFER_QUIET = (1 << 31),
56 extern unsigned int ata_print_id;
57 extern struct workqueue_struct *ata_aux_wq;
58 extern int atapi_enabled;
59 extern int atapi_passthru16;
60 extern int libata_fua;
61 extern int libata_noacpi;
62 extern int libata_allow_tpm;
63 extern void ata_force_cbl(struct ata_port *ap);
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 struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev);
67 extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
68 u64 block, u32 n_block, unsigned int tf_flags,
70 extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev);
71 extern void ata_dev_disable(struct ata_device *dev);
72 extern void ata_pio_queue_task(struct ata_port *ap, void *data,
74 extern void ata_port_flush_task(struct ata_port *ap);
75 extern unsigned ata_exec_internal(struct ata_device *dev,
76 struct ata_taskfile *tf, const u8 *cdb,
77 int dma_dir, void *buf, unsigned int buflen,
78 unsigned long timeout);
79 extern unsigned ata_exec_internal_sg(struct ata_device *dev,
80 struct ata_taskfile *tf, const u8 *cdb,
81 int dma_dir, struct scatterlist *sg,
82 unsigned int n_elem, unsigned long timeout);
83 extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd);
84 extern int ata_wait_ready(struct ata_link *link, unsigned long deadline,
85 int (*check_ready)(struct ata_link *link));
86 extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
87 unsigned int flags, u16 *id);
88 extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
89 extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
90 unsigned int readid_flags);
91 extern int ata_dev_configure(struct ata_device *dev);
92 extern int sata_down_spd_limit(struct ata_link *link);
93 extern int sata_set_spd_needed(struct ata_link *link);
94 extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
95 extern void ata_sg_clean(struct ata_queued_cmd *qc);
96 extern void ata_qc_free(struct ata_queued_cmd *qc);
97 extern void ata_qc_issue(struct ata_queued_cmd *qc);
98 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
99 extern int ata_check_atapi_dma(struct ata_queued_cmd *qc);
100 extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
101 extern void ata_dev_init(struct ata_device *dev);
102 extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
103 extern int sata_link_init_spd(struct ata_link *link);
104 extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
105 extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
106 extern struct ata_port *ata_port_alloc(struct ata_host *host);
107 extern void ata_dev_enable_pm(struct ata_device *dev, enum link_pm policy);
108 extern void ata_lpm_schedule(struct ata_port *ap, enum link_pm);
111 #ifdef CONFIG_ATA_ACPI
112 extern void ata_acpi_associate_sata_port(struct ata_port *ap);
113 extern void ata_acpi_associate(struct ata_host *host);
114 extern void ata_acpi_dissociate(struct ata_host *host);
115 extern int ata_acpi_on_suspend(struct ata_port *ap);
116 extern void ata_acpi_on_resume(struct ata_port *ap);
117 extern int ata_acpi_on_devcfg(struct ata_device *dev);
118 extern void ata_acpi_on_disable(struct ata_device *dev);
119 extern void ata_acpi_set_state(struct ata_port *ap, pm_message_t state);
121 static inline void ata_acpi_associate_sata_port(struct ata_port *ap) { }
122 static inline void ata_acpi_associate(struct ata_host *host) { }
123 static inline void ata_acpi_dissociate(struct ata_host *host) { }
124 static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
125 static inline void ata_acpi_on_resume(struct ata_port *ap) { }
126 static inline int ata_acpi_on_devcfg(struct ata_device *dev) { return 0; }
127 static inline void ata_acpi_on_disable(struct ata_device *dev) { }
128 static inline void ata_acpi_set_state(struct ata_port *ap,
129 pm_message_t state) { }
133 extern int ata_scsi_add_hosts(struct ata_host *host,
134 struct scsi_host_template *sht);
135 extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
136 extern int ata_scsi_offline_dev(struct ata_device *dev);
137 extern void ata_scsi_media_change_notify(struct ata_device *dev);
138 extern void ata_scsi_hotplug(struct work_struct *work);
139 extern unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
140 unsigned int buflen);
142 extern unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
143 unsigned int buflen);
145 extern unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
146 unsigned int buflen);
147 extern unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
148 unsigned int buflen);
149 extern unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
150 unsigned int buflen);
151 extern unsigned int ata_scsiop_sync_cache(struct ata_scsi_args *args, u8 *rbuf,
152 unsigned int buflen);
153 extern unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
154 unsigned int buflen);
155 extern unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
156 unsigned int buflen);
157 extern unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
158 unsigned int buflen);
159 extern void ata_scsi_badcmd(struct scsi_cmnd *cmd,
160 void (*done)(struct scsi_cmnd *),
162 extern void ata_scsi_set_sense(struct scsi_cmnd *cmd,
163 u8 sk, u8 asc, u8 ascq);
164 extern void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
165 unsigned int (*actor) (struct ata_scsi_args *args,
166 u8 *rbuf, unsigned int buflen));
167 extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
168 extern void ata_scsi_dev_rescan(struct work_struct *work);
169 extern int ata_bus_probe(struct ata_port *ap);
172 extern int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *val);
173 extern int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val);
174 extern int sata_pmp_attach(struct ata_device *dev);
177 extern enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
178 extern void ata_scsi_error(struct Scsi_Host *host);
179 extern void ata_port_wait_eh(struct ata_port *ap);
180 extern void ata_eh_fastdrain_timerfn(unsigned long arg);
181 extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
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 extern void ata_eh_report(struct ata_port *ap);
189 extern int ata_eh_reset(struct ata_link *link, int classify,
190 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
191 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
192 extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
193 extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
194 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
195 ata_postreset_fn_t postreset,
196 struct ata_link **r_failed_disk);
197 extern void ata_eh_finish(struct ata_port *ap);
200 extern void ata_dev_select(struct ata_port *ap, unsigned int device,
201 unsigned int wait, unsigned int can_sleep);
202 extern u8 ata_irq_on(struct ata_port *ap);
203 extern void ata_pio_task(struct work_struct *work);
205 #endif /* __LIBATA_H__ */