[PATCH] libata: cosmetic changes to sense generation functions
[linux-2.6.git] / drivers / ata / libata.h
1 /*
2  *  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  *
26  */
27
28 #ifndef __LIBATA_H__
29 #define __LIBATA_H__
30
31 #define DRV_NAME        "libata"
32 #define DRV_VERSION     "2.00"  /* must be exactly four chars */
33
34 struct ata_scsi_args {
35         struct ata_device       *dev;
36         u16                     *id;
37         struct scsi_cmnd        *cmd;
38         void                    (*done)(struct scsi_cmnd *);
39 };
40
41 /* libata-core.c */
42 enum {
43         /* flags for ata_dev_read_id() */
44         ATA_READID_POSTRESET    = (1 << 0), /* reading ID after reset */
45         ATA_READID_DETECT       = (1 << 1), /* perform presence detection
46                                              * using polling IDENTIFY */
47 };
48
49 extern struct workqueue_struct *ata_aux_wq;
50 extern int atapi_enabled;
51 extern int atapi_dmadir;
52 extern int libata_fua;
53 extern struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev);
54 extern int ata_rwcmd_protocol(struct ata_queued_cmd *qc);
55 extern void ata_dev_disable(struct ata_device *dev);
56 extern void ata_port_flush_task(struct ata_port *ap);
57 extern unsigned ata_exec_internal(struct ata_device *dev,
58                                   struct ata_taskfile *tf, const u8 *cdb,
59                                   int dma_dir, void *buf, unsigned int buflen);
60 extern unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd);
61 extern int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
62                            unsigned int flags, u16 *id);
63 extern int ata_dev_revalidate(struct ata_device *dev, unsigned int flags);
64 extern int ata_dev_configure(struct ata_device *dev);
65 extern int sata_down_spd_limit(struct ata_port *ap);
66 extern int sata_set_spd_needed(struct ata_port *ap);
67 extern int ata_down_xfermask_limit(struct ata_device *dev, int force_pio0);
68 extern int ata_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev);
69 extern void ata_qc_free(struct ata_queued_cmd *qc);
70 extern void ata_qc_issue(struct ata_queued_cmd *qc);
71 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
72 extern int ata_check_atapi_dma(struct ata_queued_cmd *qc);
73 extern void ata_dev_select(struct ata_port *ap, unsigned int device,
74                            unsigned int wait, unsigned int can_sleep);
75 extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
76 extern int ata_flush_cache(struct ata_device *dev);
77 extern void ata_dev_init(struct ata_device *dev);
78 extern int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg);
79 extern int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg);
80 extern void ata_port_init(struct ata_port *ap, struct ata_host *host,
81                           const struct ata_probe_ent *ent, unsigned int port_no);
82 extern struct ata_probe_ent *ata_probe_ent_alloc(struct device *dev,
83                                                  const struct ata_port_info *port);
84
85
86 /* libata-scsi.c */
87 extern struct scsi_transport_template ata_scsi_transport_template;
88
89 extern void ata_scsi_scan_host(struct ata_port *ap);
90 extern int ata_scsi_offline_dev(struct ata_device *dev);
91 extern void ata_scsi_hotplug(void *data);
92 extern unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
93                                unsigned int buflen);
94
95 extern unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
96                               unsigned int buflen);
97
98 extern unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
99                               unsigned int buflen);
100 extern unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
101                               unsigned int buflen);
102 extern unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
103                             unsigned int buflen);
104 extern unsigned int ata_scsiop_sync_cache(struct ata_scsi_args *args, u8 *rbuf,
105                                   unsigned int buflen);
106 extern unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
107                                   unsigned int buflen);
108 extern unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
109                                 unsigned int buflen);
110 extern unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
111                                    unsigned int buflen);
112 extern void ata_scsi_badcmd(struct scsi_cmnd *cmd,
113                             void (*done)(struct scsi_cmnd *),
114                             u8 asc, u8 ascq);
115 extern void ata_scsi_set_sense(struct scsi_cmnd *cmd,
116                                u8 sk, u8 asc, u8 ascq);
117 extern void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
118                         unsigned int (*actor) (struct ata_scsi_args *args,
119                                            u8 *rbuf, unsigned int buflen));
120 extern void ata_schedule_scsi_eh(struct Scsi_Host *shost);
121 extern void ata_scsi_dev_rescan(void *data);
122 extern int ata_bus_probe(struct ata_port *ap);
123
124 /* libata-eh.c */
125 extern enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
126 extern void ata_scsi_error(struct Scsi_Host *host);
127 extern void ata_port_wait_eh(struct ata_port *ap);
128 extern void ata_qc_schedule_eh(struct ata_queued_cmd *qc);
129
130 /* libata-sff.c */
131 extern u8 ata_irq_on(struct ata_port *ap);
132
133 #endif /* __LIBATA_H__ */