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 int atapi_passthru16
;
58 extern int libata_fua
;
59 extern int libata_noacpi
;
60 extern int libata_allow_tpm
;
61 extern struct device_type ata_port_type
;
62 extern struct ata_link
*ata_dev_phys_link(struct ata_device
*dev
);
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 unsigned ata_exec_internal(struct ata_device
*dev
,
72 struct ata_taskfile
*tf
, const u8
*cdb
,
73 int dma_dir
, void *buf
, unsigned int buflen
,
74 unsigned long timeout
);
75 extern unsigned ata_exec_internal_sg(struct ata_device
*dev
,
76 struct ata_taskfile
*tf
, const u8
*cdb
,
77 int dma_dir
, struct scatterlist
*sg
,
78 unsigned int n_elem
, unsigned long timeout
);
79 extern unsigned int ata_do_simple_cmd(struct ata_device
*dev
, u8 cmd
);
80 extern int ata_wait_ready(struct ata_link
*link
, unsigned long deadline
,
81 int (*check_ready
)(struct ata_link
*link
));
82 extern int ata_dev_read_id(struct ata_device
*dev
, unsigned int *p_class
,
83 unsigned int flags
, u16
*id
);
84 extern int ata_dev_reread_id(struct ata_device
*dev
, unsigned int readid_flags
);
85 extern int ata_dev_revalidate(struct ata_device
*dev
, unsigned int new_class
,
86 unsigned int readid_flags
);
87 extern int ata_dev_configure(struct ata_device
*dev
);
88 extern int sata_down_spd_limit(struct ata_link
*link
, u32 spd_limit
);
89 extern int ata_down_xfermask_limit(struct ata_device
*dev
, unsigned int sel
);
90 extern unsigned int ata_dev_set_feature(struct ata_device
*dev
,
91 u8 enable
, u8 feature
);
92 extern void ata_sg_clean(struct ata_queued_cmd
*qc
);
93 extern void ata_qc_free(struct ata_queued_cmd
*qc
);
94 extern void ata_qc_issue(struct ata_queued_cmd
*qc
);
95 extern void __ata_qc_complete(struct ata_queued_cmd
*qc
);
96 extern int atapi_check_dma(struct ata_queued_cmd
*qc
);
97 extern void swap_buf_le16(u16
*buf
, unsigned int buf_words
);
98 extern bool ata_phys_link_online(struct ata_link
*link
);
99 extern bool ata_phys_link_offline(struct ata_link
*link
);
100 extern void ata_dev_init(struct ata_device
*dev
);
101 extern void ata_link_init(struct ata_port
*ap
, struct ata_link
*link
, int pmp
);
102 extern int sata_link_init_spd(struct ata_link
*link
);
103 extern int ata_task_ioctl(struct scsi_device
*scsidev
, void __user
*arg
);
104 extern int ata_cmd_ioctl(struct scsi_device
*scsidev
, void __user
*arg
);
105 extern struct ata_port
*ata_port_alloc(struct ata_host
*host
);
106 extern const char *sata_spd_string(unsigned int spd
);
107 extern int ata_port_probe(struct ata_port
*ap
);
110 #ifdef CONFIG_ATA_ACPI
111 extern unsigned int ata_acpi_gtf_filter
;
113 extern void ata_acpi_associate_sata_port(struct ata_port
*ap
);
114 extern void ata_acpi_associate(struct ata_host
*host
);
115 extern void ata_acpi_dissociate(struct ata_host
*host
);
116 extern int ata_acpi_on_suspend(struct ata_port
*ap
);
117 extern void ata_acpi_on_resume(struct ata_port
*ap
);
118 extern int ata_acpi_on_devcfg(struct ata_device
*dev
);
119 extern void ata_acpi_on_disable(struct ata_device
*dev
);
120 extern void ata_acpi_set_state(struct ata_port
*ap
, pm_message_t state
);
122 static inline void ata_acpi_associate_sata_port(struct ata_port
*ap
) { }
123 static inline void ata_acpi_associate(struct ata_host
*host
) { }
124 static inline void ata_acpi_dissociate(struct ata_host
*host
) { }
125 static inline int ata_acpi_on_suspend(struct ata_port
*ap
) { return 0; }
126 static inline void ata_acpi_on_resume(struct ata_port
*ap
) { }
127 static inline int ata_acpi_on_devcfg(struct ata_device
*dev
) { return 0; }
128 static inline void ata_acpi_on_disable(struct ata_device
*dev
) { }
129 static inline void ata_acpi_set_state(struct ata_port
*ap
,
130 pm_message_t state
) { }
134 extern int ata_scsi_add_hosts(struct ata_host
*host
,
135 struct scsi_host_template
*sht
);
136 extern void ata_scsi_scan_host(struct ata_port
*ap
, int sync
);
137 extern int ata_scsi_offline_dev(struct ata_device
*dev
);
138 extern void ata_scsi_media_change_notify(struct ata_device
*dev
);
139 extern void ata_scsi_hotplug(struct work_struct
*work
);
140 extern void ata_schedule_scsi_eh(struct Scsi_Host
*shost
);
141 extern void ata_scsi_dev_rescan(struct work_struct
*work
);
142 extern int ata_bus_probe(struct ata_port
*ap
);
143 extern int ata_scsi_user_scan(struct Scsi_Host
*shost
, unsigned int channel
,
144 unsigned int id
, unsigned int lun
);
148 extern unsigned long ata_internal_cmd_timeout(struct ata_device
*dev
, u8 cmd
);
149 extern void ata_internal_cmd_timed_out(struct ata_device
*dev
, u8 cmd
);
150 extern void ata_eh_acquire(struct ata_port
*ap
);
151 extern void ata_eh_release(struct ata_port
*ap
);
152 extern enum blk_eh_timer_return
ata_scsi_timed_out(struct scsi_cmnd
*cmd
);
153 extern void ata_scsi_error(struct Scsi_Host
*host
);
154 extern void ata_port_wait_eh(struct ata_port
*ap
);
155 extern void ata_eh_fastdrain_timerfn(unsigned long arg
);
156 extern void ata_qc_schedule_eh(struct ata_queued_cmd
*qc
);
157 extern void ata_dev_disable(struct ata_device
*dev
);
158 extern void ata_eh_detach_dev(struct ata_device
*dev
);
159 extern void ata_eh_about_to_do(struct ata_link
*link
, struct ata_device
*dev
,
160 unsigned int action
);
161 extern void ata_eh_done(struct ata_link
*link
, struct ata_device
*dev
,
162 unsigned int action
);
163 extern void ata_eh_autopsy(struct ata_port
*ap
);
164 const char *ata_get_cmd_descript(u8 command
);
165 extern void ata_eh_report(struct ata_port
*ap
);
166 extern int ata_eh_reset(struct ata_link
*link
, int classify
,
167 ata_prereset_fn_t prereset
, ata_reset_fn_t softreset
,
168 ata_reset_fn_t hardreset
, ata_postreset_fn_t postreset
);
169 extern int ata_set_mode(struct ata_link
*link
, struct ata_device
**r_failed_dev
);
170 extern int ata_eh_recover(struct ata_port
*ap
, ata_prereset_fn_t prereset
,
171 ata_reset_fn_t softreset
, ata_reset_fn_t hardreset
,
172 ata_postreset_fn_t postreset
,
173 struct ata_link
**r_failed_disk
);
174 extern void ata_eh_finish(struct ata_port
*ap
);
175 extern int ata_ering_map(struct ata_ering
*ering
,
176 int (*map_fn
)(struct ata_ering_entry
*, void *),
180 #ifdef CONFIG_SATA_PMP
181 extern int sata_pmp_scr_read(struct ata_link
*link
, int reg
, u32
*val
);
182 extern int sata_pmp_scr_write(struct ata_link
*link
, int reg
, u32 val
);
183 extern int sata_pmp_set_lpm(struct ata_link
*link
, enum ata_lpm_policy policy
,
185 extern int sata_pmp_attach(struct ata_device
*dev
);
186 #else /* CONFIG_SATA_PMP */
187 static inline int sata_pmp_scr_read(struct ata_link
*link
, int reg
, u32
*val
)
192 static inline int sata_pmp_scr_write(struct ata_link
*link
, int reg
, u32 val
)
197 static inline int sata_pmp_set_lpm(struct ata_link
*link
,
198 enum ata_lpm_policy policy
, unsigned hints
)
203 static inline int sata_pmp_attach(struct ata_device
*dev
)
207 #endif /* CONFIG_SATA_PMP */
210 #ifdef CONFIG_ATA_SFF
211 extern void ata_sff_flush_pio_task(struct ata_port
*ap
);
212 extern void ata_sff_port_init(struct ata_port
*ap
);
213 extern int ata_sff_init(void);
214 extern void ata_sff_exit(void);
215 #else /* CONFIG_ATA_SFF */
216 static inline void ata_sff_flush_pio_task(struct ata_port
*ap
)
218 static inline void ata_sff_port_init(struct ata_port
*ap
)
220 static inline int ata_sff_init(void)
222 static inline void ata_sff_exit(void)
224 #endif /* CONFIG_ATA_SFF */
226 #endif /* __LIBATA_H__ */