blob: 1f1e3a51f85965f7cebadb3f6b10cfbdb07afb29 [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"
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
33struct ata_scsi_args {
Tejun Heo9a3dccc2006-01-06 09:56:18 +010034 struct ata_device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 u16 *id;
36 struct scsi_cmnd *cmd;
37 void (*done)(struct scsi_cmnd *);
38};
39
40/* libata-core.c */
Tejun Heobff04642006-11-10 18:08:10 +090041enum {
42 /* flags for ata_dev_read_id() */
43 ATA_READID_POSTRESET = (1 << 0), /* reading ID after reset */
Tejun Heo458337d2007-02-02 16:22:30 +090044
45 /* selector for ata_down_xfermask_limit() */
46 ATA_DNXFER_PIO = 0, /* speed down PIO */
47 ATA_DNXFER_DMA = 1, /* speed down DMA */
48 ATA_DNXFER_40C = 2, /* apply 40c cable limit */
49 ATA_DNXFER_FORCE_PIO = 3, /* force PIO */
50 ATA_DNXFER_FORCE_PIO0 = 4, /* force PIO0 */
Tejun Heo458337d2007-02-02 16:22:30 +090051
52 ATA_DNXFER_QUIET = (1 << 31),
Tejun Heobff04642006-11-10 18:08:10 +090053};
54
Tejun Heo453b07a2006-05-31 18:27:42 +090055extern struct workqueue_struct *ata_aux_wq;
Jeff Garzik1623c812005-08-30 03:37:42 -040056extern int atapi_enabled;
Albert Lee95de7192006-04-04 10:57:18 +080057extern int atapi_dmadir;
Jeff Garzikc3c013a2006-02-27 22:31:19 -050058extern int libata_fua;
Jeff Garzikd7d0dad2007-03-28 01:57:37 -040059extern int libata_noacpi;
Tejun Heo3373efd2006-05-15 20:57:53 +090060extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev);
Tejun Heobd056d72006-11-14 22:47:10 +090061extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
62 u64 block, u32 n_block, unsigned int tf_flags,
63 unsigned int tag);
Tejun Heo35b649f2006-11-14 22:37:35 +090064extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev);
Tejun Heo3373efd2006-05-15 20:57:53 +090065extern void ata_dev_disable(struct ata_device *dev);
Tejun Heo86e45b62006-03-05 15:29:09 +090066extern void ata_port_flush_task(struct ata_port *ap);
Tejun Heo3373efd2006-05-15 20:57:53 +090067extern unsigned ata_exec_internal(struct ata_device *dev,
Tejun Heo1ad8e7f2006-04-02 18:51:53 +090068 struct ata_taskfile *tf, const u8 *cdb,
69 int dma_dir, void *buf, unsigned int buflen);
Tejun Heo24326972006-11-14 22:47:09 +090070extern unsigned ata_exec_internal_sg(struct ata_device *dev,
71 struct ata_taskfile *tf, const u8 *cdb,
72 int dma_dir, struct scatterlist *sg,
73 unsigned int n_elem);
Tejun Heo77b08fb2006-06-24 20:30:19 +090074extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd);
Tejun Heoa9beec92006-05-31 18:27:44 +090075extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
Tejun Heobff04642006-11-10 18:08:10 +090076 unsigned int flags, u16 *id);
77extern int ata_dev_revalidate(struct ata_device *dev, unsigned int flags);
Tejun Heoefdaedc2006-11-01 18:38:52 +090078extern int ata_dev_configure(struct ata_device *dev);
Tejun Heo3c567b72006-05-15 20:57:23 +090079extern int sata_down_spd_limit(struct ata_port *ap);
80extern int sata_set_spd_needed(struct ata_port *ap);
Tejun Heo458337d2007-02-02 16:22:30 +090081extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
Tejun Heo1ad8e7f2006-04-02 18:51:53 +090082extern int ata_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev);
Tejun Heo70e6ad02006-11-14 22:47:10 +090083extern void ata_sg_clean(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -070084extern void ata_qc_free(struct ata_queued_cmd *qc);
Tejun Heo8e0e6942006-03-31 20:41:11 +090085extern void ata_qc_issue(struct ata_queued_cmd *qc);
Tejun Heof686bcb2006-05-15 20:58:05 +090086extern void __ata_qc_complete(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087extern int ata_check_atapi_dma(struct ata_queued_cmd *qc);
88extern void ata_dev_select(struct ata_port *ap, unsigned int device,
89 unsigned int wait, unsigned int can_sleep);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
Tejun Heo77b08fb2006-06-24 20:30:19 +090091extern int ata_flush_cache(struct ata_device *dev);
Tejun Heo3ef3b432006-05-31 18:27:30 +090092extern void ata_dev_init(struct ata_device *dev);
Jeff Garzikb0955182005-05-12 15:45:22 -040093extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
94extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
Jeff Garzikcca39742006-08-24 03:19:22 -040095extern void ata_port_init(struct ata_port *ap, struct ata_host *host,
Brian King155a8a92006-08-07 14:27:17 -050096 const struct ata_probe_ent *ent, unsigned int port_no);
Brian Kingf6d950e2006-08-07 14:27:24 -050097extern struct ata_probe_ent *ata_probe_ent_alloc(struct device *dev,
98 const struct ata_port_info *port);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700100/* libata-acpi.c */
101#ifdef CONFIG_SATA_ACPI
102extern int ata_acpi_exec_tfs(struct ata_port *ap);
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700103extern int ata_acpi_push_id(struct ata_port *ap, unsigned int ix);
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700104#else
105static inline int ata_acpi_exec_tfs(struct ata_port *ap)
106{
107 return 0;
108}
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700109static inline int ata_acpi_push_id(struct ata_port *ap, unsigned int ix)
110{
111 return 0;
112}
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700113#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
115/* libata-scsi.c */
Tejun Heo30afc842006-03-18 18:40:14 +0900116extern struct scsi_transport_template ata_scsi_transport_template;
117
Jeff Garzik644dd0c2005-10-03 15:55:19 -0400118extern void ata_scsi_scan_host(struct ata_port *ap);
Tejun Heo0ea035a2006-05-31 18:28:01 +0900119extern int ata_scsi_offline_dev(struct ata_device *dev);
David Howells65f27f32006-11-22 14:55:48 +0000120extern void ata_scsi_hotplug(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121extern unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
122 unsigned int buflen);
123
124extern unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
125 unsigned int buflen);
126
127extern unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
128 unsigned int buflen);
129extern unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
130 unsigned int buflen);
131extern unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
132 unsigned int buflen);
133extern unsigned int ata_scsiop_sync_cache(struct ata_scsi_args *args, u8 *rbuf,
134 unsigned int buflen);
135extern unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
136 unsigned int buflen);
137extern unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
138 unsigned int buflen);
139extern unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
140 unsigned int buflen);
141extern void ata_scsi_badcmd(struct scsi_cmnd *cmd,
142 void (*done)(struct scsi_cmnd *),
143 u8 asc, u8 ascq);
Douglas Gilbert845c5832005-10-09 08:55:41 -0400144extern void ata_scsi_set_sense(struct scsi_cmnd *cmd,
145 u8 sk, u8 asc, u8 ascq);
Jeff Garzik8a60a072005-07-31 13:13:24 -0400146extern void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 unsigned int (*actor) (struct ata_scsi_args *args,
148 u8 *rbuf, unsigned int buflen));
Tejun Heo7b70fc02006-05-15 20:58:07 +0900149extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
David Howells65f27f32006-11-22 14:55:48 +0000150extern void ata_scsi_dev_rescan(struct work_struct *work);
Brian King80289162006-08-07 14:27:31 -0500151extern int ata_bus_probe(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
Tejun Heoece1d632006-04-02 18:51:53 +0900153/* libata-eh.c */
154extern enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
Jeff Garzik381544b2006-04-11 13:04:39 -0400155extern void ata_scsi_error(struct Scsi_Host *host);
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900156extern void ata_port_wait_eh(struct ata_port *ap);
Tejun Heof686bcb2006-05-15 20:58:05 +0900157extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
Tejun Heoece1d632006-04-02 18:51:53 +0900158
Tejun Heo90088bb2006-10-09 11:10:26 +0900159/* libata-sff.c */
160extern u8 ata_irq_on(struct ata_port *ap);
161
Adrian Bunk77a527e2007-01-30 00:59:17 -0800162
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163#endif /* __LIBATA_H__ */