xref: /openbsd/sbin/scsi/libscsi.h (revision 17df1aa7)
1 /*	$OpenBSD: libscsi.h,v 1.2 2008/01/13 20:23:34 chl Exp $	*/
2 
3 /* Copyright (c) 1994 HD Associates (hd@world.std.com)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  * This product includes software developed by HD Associates
17  * 4. Neither the name of the HD Associaates nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY HD ASSOCIATES``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL HD ASSOCIATES OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 
34 #ifndef _SCSI_H_
35 #define _SCSI_H_
36 
37 #include <sys/cdefs.h>
38 
39 /* libscsi: Library header file for the SCSI user library.
40  */
41 
42 #include <sys/scsiio.h>
43 #include <stdio.h>
44 
45 #define SCSIREQ_ERROR(SR) \
46     (SR->senselen_used ||	/* Sent sense */ \
47     SR->status ||      		/* Host adapter status */ \
48     SR->retsts ||     		/* SCSI transfer status */ \
49     SR->error)       		/* copy of errno */
50 
51 scsireq_t *scsireq_reset(scsireq_t *);
52 scsireq_t *scsireq_new(void);
53 
54 int scsireq_buff_decode_visit(u_char *, size_t, char *,
55     void (*a)(void *, int, void *, int, char *), void *);
56 
57 int scsireq_decode_visit(scsireq_t *, char *,
58     void (*)(void *, int, void *, int, char *), void *);
59 
60 int scsireq_encode_visit(scsireq_t *, char *,
61     int (*)(void *, char *), void *);
62 int scsireq_buff_encode_visit(u_char *, size_t, char *,
63     int (*)(void *, char *), void *);
64 
65 scsireq_t *scsireq_build(scsireq_t *, u_long, caddr_t, u_long, char *, ...);
66 
67 scsireq_t *scsireq_build_visit(scsireq_t *, u_long, caddr_t, u_long, char *,
68     int (*)(void *, char *), void *);
69 
70 int scsireq_enter(int, scsireq_t *);
71 
72 void scsi_dump(FILE *, char *, u_char *, int, int, int );
73 
74 int scsi_debug(FILE *, int, scsireq_t *);
75 FILE *scsi_debug_output(char *);
76 int scsi_open(const char *, int );
77 
78 #endif /* _SCSI_H_ */
79