blob: 564cd234c805335999bf40fefe0b00eab1f061d1 [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 Heof3187192007-04-17 23:44:07 +090055extern unsigned int ata_print_id;
Tejun Heo453b07a2006-05-31 18:27:42 +090056extern struct workqueue_struct *ata_aux_wq;
Jeff Garzik1623c812005-08-30 03:37:42 -040057extern int atapi_enabled;
Albert Lee95de7192006-04-04 10:57:18 +080058extern int atapi_dmadir;
Jeff Garzikc3c013a2006-02-27 22:31:19 -050059extern int libata_fua;
Jeff Garzikd7d0dad2007-03-28 01:57:37 -040060extern int libata_noacpi;
Tejun Heo3373efd2006-05-15 20:57:53 +090061extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev);
Tejun Heobd056d72006-11-14 22:47:10 +090062extern int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
63 u64 block, u32 n_block, unsigned int tf_flags,
64 unsigned int tag);
Tejun Heo35b649f2006-11-14 22:37:35 +090065extern u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev);
Tejun Heo3373efd2006-05-15 20:57:53 +090066extern void ata_dev_disable(struct ata_device *dev);
Tejun Heo86e45b62006-03-05 15:29:09 +090067extern void ata_port_flush_task(struct ata_port *ap);
Tejun Heo3373efd2006-05-15 20:57:53 +090068extern unsigned ata_exec_internal(struct ata_device *dev,
Tejun Heo1ad8e7f2006-04-02 18:51:53 +090069 struct ata_taskfile *tf, const u8 *cdb,
70 int dma_dir, void *buf, unsigned int buflen);
Tejun Heo24326972006-11-14 22:47:09 +090071extern unsigned ata_exec_internal_sg(struct ata_device *dev,
72 struct ata_taskfile *tf, const u8 *cdb,
73 int dma_dir, struct scatterlist *sg,
74 unsigned int n_elem);
Tejun Heo77b08fb2006-06-24 20:30:19 +090075extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd);
Tejun Heoa9beec92006-05-31 18:27:44 +090076extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
Tejun Heobff04642006-11-10 18:08:10 +090077 unsigned int flags, u16 *id);
Tejun Heofe309112007-05-15 03:28:15 +090078extern int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags);
79extern int ata_dev_revalidate(struct ata_device *dev, unsigned int readid_flags);
Tejun Heoefdaedc2006-11-01 18:38:52 +090080extern int ata_dev_configure(struct ata_device *dev);
Tejun Heo3c567b72006-05-15 20:57:23 +090081extern int sata_down_spd_limit(struct ata_port *ap);
82extern int sata_set_spd_needed(struct ata_port *ap);
Tejun Heo458337d2007-02-02 16:22:30 +090083extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
Tejun Heo1ad8e7f2006-04-02 18:51:53 +090084extern int ata_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev);
Tejun Heo70e6ad02006-11-14 22:47:10 +090085extern void ata_sg_clean(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086extern void ata_qc_free(struct ata_queued_cmd *qc);
Tejun Heo8e0e6942006-03-31 20:41:11 +090087extern void ata_qc_issue(struct ata_queued_cmd *qc);
Tejun Heof686bcb2006-05-15 20:58:05 +090088extern void __ata_qc_complete(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089extern int ata_check_atapi_dma(struct ata_queued_cmd *qc);
90extern void ata_dev_select(struct ata_port *ap, unsigned int device,
91 unsigned int wait, unsigned int can_sleep);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
Tejun Heo77b08fb2006-06-24 20:30:19 +090093extern int ata_flush_cache(struct ata_device *dev);
Tejun Heo3ef3b432006-05-31 18:27:30 +090094extern void ata_dev_init(struct ata_device *dev);
Jeff Garzikb0955182005-05-12 15:45:22 -040095extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
96extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
Tejun Heof3187192007-04-17 23:44:07 +090097extern struct ata_port *ata_port_alloc(struct ata_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070099/* libata-acpi.c */
Tejun Heoe92351b2007-05-05 23:50:38 +0900100#ifdef CONFIG_ATA_ACPI
Tejun Heofafbae82007-05-15 03:28:16 +0900101extern void ata_acpi_associate(struct ata_host *host);
Tejun Heo64578a32007-05-15 03:28:16 +0900102extern int ata_acpi_on_suspend(struct ata_port *ap);
Tejun Heo67465442007-05-15 03:28:16 +0900103extern void ata_acpi_on_resume(struct ata_port *ap);
104extern int ata_acpi_on_devcfg(struct ata_device *adev);
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700105#else
Tejun Heofafbae82007-05-15 03:28:16 +0900106static inline void ata_acpi_associate(struct ata_host *host) { }
Tejun Heo64578a32007-05-15 03:28:16 +0900107static inline int ata_acpi_on_suspend(struct ata_port *ap) { return 0; }
Tejun Heo67465442007-05-15 03:28:16 +0900108static inline void ata_acpi_on_resume(struct ata_port *ap) { }
109static inline int ata_acpi_on_devcfg(struct ata_device *adev) { return 0; }
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700110#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
112/* libata-scsi.c */
Tejun Heof3187192007-04-17 23:44:07 +0900113extern int ata_scsi_add_hosts(struct ata_host *host,
114 struct scsi_host_template *sht);
Tejun Heo1ae46312007-07-16 14:29:40 +0900115extern void ata_scsi_scan_host(struct ata_port *ap, int sync);
Tejun Heo0ea035a2006-05-31 18:28:01 +0900116extern int ata_scsi_offline_dev(struct ata_device *dev);
David Howells65f27f32006-11-22 14:55:48 +0000117extern void ata_scsi_hotplug(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118extern unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
119 unsigned int buflen);
120
121extern unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
122 unsigned int buflen);
123
124extern unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
125 unsigned int buflen);
126extern unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
127 unsigned int buflen);
128extern unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
129 unsigned int buflen);
130extern unsigned int ata_scsiop_sync_cache(struct ata_scsi_args *args, u8 *rbuf,
131 unsigned int buflen);
132extern unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
133 unsigned int buflen);
134extern unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
135 unsigned int buflen);
136extern unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
137 unsigned int buflen);
138extern void ata_scsi_badcmd(struct scsi_cmnd *cmd,
139 void (*done)(struct scsi_cmnd *),
140 u8 asc, u8 ascq);
Douglas Gilbert845c5832005-10-09 08:55:41 -0400141extern void ata_scsi_set_sense(struct scsi_cmnd *cmd,
142 u8 sk, u8 asc, u8 ascq);
Jeff Garzik8a60a072005-07-31 13:13:24 -0400143extern void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 unsigned int (*actor) (struct ata_scsi_args *args,
145 u8 *rbuf, unsigned int buflen));
Tejun Heo7b70fc02006-05-15 20:58:07 +0900146extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
David Howells65f27f32006-11-22 14:55:48 +0000147extern void ata_scsi_dev_rescan(struct work_struct *work);
Brian King80289162006-08-07 14:27:31 -0500148extern int ata_bus_probe(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
Tejun Heoece1d632006-04-02 18:51:53 +0900150/* libata-eh.c */
151extern enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
Jeff Garzik381544b2006-04-11 13:04:39 -0400152extern void ata_scsi_error(struct Scsi_Host *host);
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900153extern void ata_port_wait_eh(struct ata_port *ap);
Tejun Heo5ddf24c2007-07-16 14:29:41 +0900154extern void ata_eh_fastdrain_timerfn(unsigned long arg);
Tejun Heof686bcb2006-05-15 20:58:05 +0900155extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
Tejun Heoece1d632006-04-02 18:51:53 +0900156
Tejun Heo90088bb2006-10-09 11:10:26 +0900157/* libata-sff.c */
158extern u8 ata_irq_on(struct ata_port *ap);
159
Adrian Bunk77a527e2007-01-30 00:59:17 -0800160
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161#endif /* __LIBATA_H__ */