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
*);
41 static inline int ata_is_builtin_hardreset(ata_reset_fn_t reset
)
43 if (reset
== sata_std_hardreset
)
46 if (reset
== sata_sff_hardreset
)
54 /* flags for ata_dev_read_id() */
55 ATA_READID_POSTRESET
= (1 << 0), /* reading ID after reset */
57 /* selector for ata_down_xfermask_limit() */
58 ATA_DNXFER_PIO
= 0, /* speed down PIO */
59 ATA_DNXFER_DMA
= 1, /* speed down DMA */
60 ATA_DNXFER_40C
= 2, /* apply 40c cable limit */
61 ATA_DNXFER_FORCE_PIO
= 3, /* force PIO */
62 ATA_DNXFER_FORCE_PIO0
= 4, /* force PIO0 */
64 ATA_DNXFER_QUIET
= (1 << 31),
67 extern unsigned int ata_print_id
;
68 extern struct workqueue_struct
*ata_aux_wq
;
69 extern int atapi_enabled
;
70 extern int atapi_passthru16
;
71 extern int libata_fua
;
72 extern int libata_noacpi
;
73 extern int libata_allow_tpm
;
74 extern void ata_force_cbl(struct ata_port
*ap
);
75 extern u64
ata_tf_to_lba(const struct ata_taskfile
*tf
);
76 extern u64
ata_tf_to_lba48(const struct ata_taskfile
*tf
);
77 extern struct ata_queued_cmd
*ata_qc_new_init(struct ata_device
*dev
);
78 extern int ata_build_rw_tf(struct ata_taskfile
*tf
, struct ata_device
*dev
,
79 u64 block
, u32 n_block
, unsigned int tf_flags
,
81 extern u64
ata_tf_read_block(struct ata_taskfile
*tf
, struct ata_device
*dev
);
82 extern void ata_dev_disable(struct ata_device
*dev
);
83 extern void ata_pio_queue_task(struct ata_port
*ap
, void *data
,
85 extern void ata_port_flush_task(struct ata_port
*ap
);
86 extern unsigned ata_exec_internal(struct ata_device
*dev
,
87 struct ata_taskfile
*tf
, const u8
*cdb
,
88 int dma_dir
, void *buf
, unsigned int buflen
,
89 unsigned long timeout
);
90 extern unsigned ata_exec_internal_sg(struct ata_device
*dev
,
91 struct ata_taskfile
*tf
, const u8
*cdb
,
92 int dma_dir
, struct scatterlist
*sg
,
93 unsigned int n_elem
, unsigned long timeout
);
94 extern unsigned int ata_do_simple_cmd(struct ata_device
*dev
, u8 cmd
);
95 extern int ata_wait_ready(struct ata_link
*link
, unsigned long deadline
,
96 int (*check_ready
)(struct ata_link
*link
));
97 extern int ata_dev_read_id(struct ata_device
*dev
, unsigned int *p_class
,
98 unsigned int flags
, u16
*id
);
99 extern int ata_dev_reread_id(struct ata_device
*dev
, unsigned int readid_flags
);
100 extern int ata_dev_revalidate(struct ata_device
*dev
, unsigned int new_class
,
101 unsigned int readid_flags
);
102 extern int ata_dev_configure(struct ata_device
*dev
);
103 extern int sata_down_spd_limit(struct ata_link
*link
);
104 extern int ata_down_xfermask_limit(struct ata_device
*dev
, unsigned int sel
);
105 extern void ata_sg_clean(struct ata_queued_cmd
*qc
);
106 extern void ata_qc_free(struct ata_queued_cmd
*qc
);
107 extern void ata_qc_issue(struct ata_queued_cmd
*qc
);
108 extern void __ata_qc_complete(struct ata_queued_cmd
*qc
);
109 extern int ata_check_atapi_dma(struct ata_queued_cmd
*qc
);
110 extern void swap_buf_le16(u16
*buf
, unsigned int buf_words
);
111 extern void ata_dev_init(struct ata_device
*dev
);
112 extern void ata_link_init(struct ata_port
*ap
, struct ata_link
*link
, int pmp
);
113 extern int sata_link_init_spd(struct ata_link
*link
);
114 extern int ata_task_ioctl(struct scsi_device
*scsidev
, void __user
*arg
);
115 extern int ata_cmd_ioctl(struct scsi_device
*scsidev
, void __user
*arg
);
116 extern struct ata_port
*ata_port_alloc(struct ata_host
*host
);
117 extern void ata_dev_enable_pm(struct ata_device
*dev
, enum link_pm policy
);
118 extern void ata_lpm_schedule(struct ata_port
*ap
, enum link_pm
);
121 #ifdef CONFIG_ATA_ACPI
122 extern void ata_acpi_associate_sata_port(struct ata_port
*ap
);
123 extern void ata_acpi_associate(struct ata_host
*host
);
124 extern void ata_acpi_dissociate(struct ata_host
*host
);
125 extern int ata_acpi_on_suspend(struct ata_port
*ap
);
126 extern void ata_acpi_on_resume(struct ata_port
*ap
);
127 extern int ata_acpi_on_devcfg(struct ata_device
*dev
);
128 extern void ata_acpi_on_disable(struct ata_device
*dev
);
129 extern void ata_acpi_set_state(struct ata_port
*ap
, pm_message_t state
);
131 static inline void ata_acpi_associate_sata_port(struct ata_port
*ap
) { }
132 static inline void ata_acpi_associate(struct ata_host
*host
) { }
133 static inline void ata_acpi_dissociate(struct ata_host
*host
) { }
134 static inline int ata_acpi_on_suspend(struct ata_port
*ap
) { return 0; }
135 static inline void ata_acpi_on_resume(struct ata_port
*ap
) { }
136 static inline int ata_acpi_on_devcfg(struct ata_device
*dev
) { return 0; }
137 static inline void ata_acpi_on_disable(struct ata_device
*dev
) { }
138 static inline void ata_acpi_set_state(struct ata_port
*ap
,
139 pm_message_t state
) { }
143 extern int ata_scsi_add_hosts(struct ata_host
*host
,
144 struct scsi_host_template
*sht
);
145 extern void ata_scsi_scan_host(struct ata_port
*ap
, int sync
);
146 extern int ata_scsi_offline_dev(struct ata_device
*dev
);
147 extern void ata_scsi_media_change_notify(struct ata_device
*dev
);
148 extern void ata_scsi_hotplug(struct work_struct
*work
);
149 extern unsigned int ata_scsiop_inq_std(struct ata_scsi_args
*args
, u8
*rbuf
,
150 unsigned int buflen
);
152 extern unsigned int ata_scsiop_inq_00(struct ata_scsi_args
*args
, u8
*rbuf
,
153 unsigned int buflen
);
155 extern unsigned int ata_scsiop_inq_80(struct ata_scsi_args
*args
, u8
*rbuf
,
156 unsigned int buflen
);
157 extern unsigned int ata_scsiop_inq_83(struct ata_scsi_args
*args
, u8
*rbuf
,
158 unsigned int buflen
);
159 extern unsigned int ata_scsiop_noop(struct ata_scsi_args
*args
, u8
*rbuf
,
160 unsigned int buflen
);
161 extern unsigned int ata_scsiop_sync_cache(struct ata_scsi_args
*args
, u8
*rbuf
,
162 unsigned int buflen
);
163 extern unsigned int ata_scsiop_mode_sense(struct ata_scsi_args
*args
, u8
*rbuf
,
164 unsigned int buflen
);
165 extern unsigned int ata_scsiop_read_cap(struct ata_scsi_args
*args
, u8
*rbuf
,
166 unsigned int buflen
);
167 extern unsigned int ata_scsiop_report_luns(struct ata_scsi_args
*args
, u8
*rbuf
,
168 unsigned int buflen
);
169 extern void ata_scsi_badcmd(struct scsi_cmnd
*cmd
,
170 void (*done
)(struct scsi_cmnd
*),
172 extern void ata_scsi_set_sense(struct scsi_cmnd
*cmd
,
173 u8 sk
, u8 asc
, u8 ascq
);
174 extern void ata_scsi_rbuf_fill(struct ata_scsi_args
*args
,
175 unsigned int (*actor
) (struct ata_scsi_args
*args
,
176 u8
*rbuf
, unsigned int buflen
));
177 extern void ata_schedule_scsi_eh(struct Scsi_Host
*shost
);
178 extern void ata_scsi_dev_rescan(struct work_struct
*work
);
179 extern int ata_bus_probe(struct ata_port
*ap
);
182 extern enum scsi_eh_timer_return
ata_scsi_timed_out(struct scsi_cmnd
*cmd
);
183 extern void ata_scsi_error(struct Scsi_Host
*host
);
184 extern void ata_port_wait_eh(struct ata_port
*ap
);
185 extern void ata_eh_fastdrain_timerfn(unsigned long arg
);
186 extern void ata_qc_schedule_eh(struct ata_queued_cmd
*qc
);
187 extern void ata_eh_detach_dev(struct ata_device
*dev
);
188 extern void ata_eh_about_to_do(struct ata_link
*link
, struct ata_device
*dev
,
189 unsigned int action
);
190 extern void ata_eh_done(struct ata_link
*link
, struct ata_device
*dev
,
191 unsigned int action
);
192 extern void ata_eh_autopsy(struct ata_port
*ap
);
193 extern void ata_eh_report(struct ata_port
*ap
);
194 extern int ata_eh_reset(struct ata_link
*link
, int classify
,
195 ata_prereset_fn_t prereset
, ata_reset_fn_t softreset
,
196 ata_reset_fn_t hardreset
, ata_postreset_fn_t postreset
);
197 extern int ata_set_mode(struct ata_link
*link
, struct ata_device
**r_failed_dev
);
198 extern int ata_eh_recover(struct ata_port
*ap
, ata_prereset_fn_t prereset
,
199 ata_reset_fn_t softreset
, ata_reset_fn_t hardreset
,
200 ata_postreset_fn_t postreset
,
201 struct ata_link
**r_failed_disk
);
202 extern void ata_eh_finish(struct ata_port
*ap
);
205 #ifdef CONFIG_SATA_PMP
206 extern int sata_pmp_scr_read(struct ata_link
*link
, int reg
, u32
*val
);
207 extern int sata_pmp_scr_write(struct ata_link
*link
, int reg
, u32 val
);
208 extern int sata_pmp_attach(struct ata_device
*dev
);
209 #else /* CONFIG_SATA_PMP */
210 static inline int sata_pmp_scr_read(struct ata_link
*link
, int reg
, u32
*val
)
215 static inline int sata_pmp_scr_write(struct ata_link
*link
, int reg
, u32 val
)
220 static inline int sata_pmp_attach(struct ata_device
*dev
)
224 #endif /* CONFIG_SATA_PMP */
227 #ifdef CONFIG_ATA_SFF
228 extern void ata_dev_select(struct ata_port
*ap
, unsigned int device
,
229 unsigned int wait
, unsigned int can_sleep
);
230 extern u8
ata_irq_on(struct ata_port
*ap
);
231 extern void ata_pio_task(struct work_struct
*work
);
232 #endif /* CONFIG_ATA_SFF */
234 #endif /* __LIBATA_H__ */