blob: ebe22982e80ccf54b383d24523a4d7a4fb7bf1e9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Jeff Garzikaf36d7f2005-08-28 20:18:39 -04002 * 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 Torvalds1da177e2005-04-16 15:20:36 -070026 */
27
28#ifndef __LIBATA_H__
29#define __LIBATA_H__
30
31#define DRV_NAME "libata"
Jeff Garzikc78968b2007-09-21 21:03:28 -040032#define DRV_VERSION "2.21" /* must be exactly four chars */
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
34struct ata_scsi_args {
Tejun Heo9a3dccc2006-01-06 09:56:18 +010035 struct ata_device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 u16 *id;
37 struct scsi_cmnd *cmd;
38 void (*done)(struct scsi_cmnd *);
39};
40
41/* libata-core.c */
Tejun Heobff04642006-11-10 18:08:10 +090042enum {
43 /* flags for ata_dev_read_id() */
44 ATA_READID_POSTRESET = (1 << 0), /* reading ID after reset */
Tejun Heo458337d2007-02-02 16:22:30 +090045
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 Heo458337d2007-02-02 16:22:30 +090052
53 ATA_DNXFER_QUIET = (1 << 31),
Tejun Heobff04642006-11-10 18:08:10 +090054};
55
Tejun Heof3187192007-04-17 23:44:07 +090056extern unsigned int ata_print_id;
Tejun Heo453b07a2006-05-31 18:27:42 +090057extern struct workqueue_struct *ata_aux_wq;
Jeff Garzik1623c812005-08-30 03:37:42 -040058extern int atapi_enabled;
Albert Lee95de7192006-04-04 10:57:18 +080059extern int atapi_dmadir;
Mark Lordbaf4fdf2007-08-08 01:08:45 +090060extern int atapi_passthru16;
Jeff Garzikc3c013a2006-02-27 22:31:19 -050061extern int libata_fua;
Jeff Garzikd7d0dad2007-03-28 01:57:37 -040062extern int libata_noacpi;
Tejun Heo3373efd2006-05-15 20:57:53 +090063extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev);
Tejun Heobd056d72006-11-14 22:47:10 +090064extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
65 u64 block, u32 n_block, unsigned int tf_flags,
66 unsigned int tag);
Tejun Heo35b649f2006-11-14 22:37:35 +090067extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev);
Tejun Heo3373efd2006-05-15 20:57:53 +090068extern void ata_dev_disable(struct ata_device *dev);
Tejun Heo86e45b62006-03-05 15:29:09 +090069extern void ata_port_flush_task(struct ata_port *ap);
Tejun Heo3373efd2006-05-15 20:57:53 +090070extern unsigned ata_exec_internal(struct ata_device *dev,
Tejun Heo1ad8e7f2006-04-02 18:51:53 +090071 struct ata_taskfile *tf, const u8 *cdb,
72 int dma_dir, void *buf, unsigned int buflen);
Tejun Heo24326972006-11-14 22:47:09 +090073extern unsigned ata_exec_internal_sg(struct ata_device *dev,
74 struct ata_taskfile *tf, const u8 *cdb,
75 int dma_dir, struct scatterlist *sg,
76 unsigned int n_elem);
Tejun Heo77b08fb2006-06-24 20:30:19 +090077extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd);
Tejun Heoa9beec92006-05-31 18:27:44 +090078extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
Tejun Heobff04642006-11-10 18:08:10 +090079 unsigned int flags, u16 *id);
Tejun Heofe309112007-05-15 03:28:15 +090080extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
Tejun Heo422c9da2007-09-23 13:14:12 +090081extern int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
82 unsigned int readid_flags);
Tejun Heoefdaedc2006-11-01 18:38:52 +090083extern int ata_dev_configure(struct ata_device *dev);
Tejun Heo936fd732007-08-06 18:36:23 +090084extern int sata_down_spd_limit(struct ata_link *link);
85extern int sata_set_spd_needed(struct ata_link *link);
Tejun Heo458337d2007-02-02 16:22:30 +090086extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
Tejun Heo02607312007-08-06 18:36:23 +090087extern int ata_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
Tejun Heo70e6ad02006-11-14 22:47:10 +090088extern void ata_sg_clean(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089extern void ata_qc_free(struct ata_queued_cmd *qc);
Tejun Heo8e0e6942006-03-31 20:41:11 +090090extern void ata_qc_issue(struct ata_queued_cmd *qc);
Tejun Heof686bcb2006-05-15 20:58:05 +090091extern void __ata_qc_complete(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092extern int ata_check_atapi_dma(struct ata_queued_cmd *qc);
93extern void ata_dev_select(struct ata_port *ap, unsigned int device,
94 unsigned int wait, unsigned int can_sleep);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
Tejun Heo77b08fb2006-06-24 20:30:19 +090096extern int ata_flush_cache(struct ata_device *dev);
Tejun Heo3ef3b432006-05-31 18:27:30 +090097extern void ata_dev_init(struct ata_device *dev);
Tejun Heofb7fd612007-09-23 13:14:12 +090098extern void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp);
99extern int sata_link_init_spd(struct ata_link *link);
Jeff Garzikb0955182005-05-12 15:45:22 -0400100extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
101extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
Tejun Heof3187192007-04-17 23:44:07 +0900102extern struct ata_port *ata_port_alloc(struct ata_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700104/* libata-acpi.c */
Tejun Heoe92351b2007-05-05 23:50:38 +0900105#ifdef CONFIG_ATA_ACPI
Tejun Heofafbae82007-05-15 03:28:16 +0900106extern void ata_acpi_associate(struct ata_host *host);
Tejun Heo64578a32007-05-15 03:28:16 +0900107extern int ata_acpi_on_suspend(struct ata_port *ap);
Tejun Heo67465442007-05-15 03:28:16 +0900108extern void ata_acpi_on_resume(struct ata_port *ap);
109extern int ata_acpi_on_devcfg(struct ata_device *adev);
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700110#else
Tejun Heofafbae82007-05-15 03:28:16 +0900111static inline void ata_acpi_associate(struct ata_host *host) { }
Tejun Heo64578a32007-05-15 03:28:16 +0900112static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
Tejun Heo67465442007-05-15 03:28:16 +0900113static inline void ata_acpi_on_resume(struct ata_port *ap) { }
114static inline int ata_acpi_on_devcfg(struct ata_device *adev) { return 0; }
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700115#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
117/* libata-scsi.c */
Tejun Heof3187192007-04-17 23:44:07 +0900118extern int ata_scsi_add_hosts(struct ata_host *host,
119 struct scsi_host_template *sht);
Tejun Heo1ae46312007-07-16 14:29:40 +0900120extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
Tejun Heo0ea035a2006-05-31 18:28:01 +0900121extern int ata_scsi_offline_dev(struct ata_device *dev);
Tejun Heo7d77b242007-09-23 13:14:13 +0900122extern void ata_scsi_media_change_notify(struct ata_device *dev);
David Howells65f27f32006-11-22 14:55:48 +0000123extern void ata_scsi_hotplug(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124extern unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
125 unsigned int buflen);
126
127extern unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
128 unsigned int buflen);
129
130extern unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
131 unsigned int buflen);
132extern unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
133 unsigned int buflen);
134extern unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
135 unsigned int buflen);
136extern unsigned int ata_scsiop_sync_cache(struct ata_scsi_args *args, u8 *rbuf,
137 unsigned int buflen);
138extern unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
139 unsigned int buflen);
140extern unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
141 unsigned int buflen);
142extern unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
143 unsigned int buflen);
144extern void ata_scsi_badcmd(struct scsi_cmnd *cmd,
145 void (*done)(struct scsi_cmnd *),
146 u8 asc, u8 ascq);
Douglas Gilbert845c5832005-10-09 08:55:41 -0400147extern void ata_scsi_set_sense(struct scsi_cmnd *cmd,
148 u8 sk, u8 asc, u8 ascq);
Jeff Garzik8a60a072005-07-31 13:13:24 -0400149extern void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 unsigned int (*actor) (struct ata_scsi_args *args,
151 u8 *rbuf, unsigned int buflen));
Tejun Heo7b70fc02006-05-15 20:58:07 +0900152extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
David Howells65f27f32006-11-22 14:55:48 +0000153extern void ata_scsi_dev_rescan(struct work_struct *work);
Brian King80289162006-08-07 14:27:31 -0500154extern int ata_bus_probe(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
Tejun Heoece1d632006-04-02 18:51:53 +0900156/* libata-eh.c */
157extern enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
Jeff Garzik381544b2006-04-11 13:04:39 -0400158extern void ata_scsi_error(struct Scsi_Host *host);
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900159extern void ata_port_wait_eh(struct ata_port *ap);
Tejun Heo5ddf24c2007-07-16 14:29:41 +0900160extern void ata_eh_fastdrain_timerfn(unsigned long arg);
Tejun Heof686bcb2006-05-15 20:58:05 +0900161extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
Tejun Heofb7fd612007-09-23 13:14:12 +0900162extern void ata_eh_detach_dev(struct ata_device *dev);
163extern void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev,
164 unsigned int action);
165extern void ata_eh_done(struct ata_link *link, struct ata_device *dev,
166 unsigned int action);
167extern void ata_eh_autopsy(struct ata_port *ap);
168extern void ata_eh_report(struct ata_port *ap);
169extern int ata_eh_reset(struct ata_link *link, int classify,
170 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
171 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
172extern int ata_eh_recover(struct ata_port *ap, ata_prereset_fn_t prereset,
173 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
174 ata_postreset_fn_t postreset,
175 struct ata_link **r_failed_disk);
176extern void ata_eh_finish(struct ata_port *ap);
Tejun Heoece1d632006-04-02 18:51:53 +0900177
Tejun Heo90088bb2006-10-09 11:10:26 +0900178/* libata-sff.c */
179extern u8 ata_irq_on(struct ata_port *ap);
180
Adrian Bunk77a527e2007-01-30 00:59:17 -0800181
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182#endif /* __LIBATA_H__ */