freebsd-dev/lib/libscsi/scsi.h

/* Copyright (c) 1994 HD Associates (hd@world.std.com)
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 * This product includes software developed by HD Associates
 * 4. Neither the name of the HD Associaates nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY HD ASSOCIATES``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL HD ASSOCIATES OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef _SCSI_H_
#define _SCSI_H_

#include <sys/cdefs.h>

/* libscsi: Library header file for the SCSI user library.
 */

#include <sys/scsiio.h>
#include <stdio.h>

#define SCSIREQ_ERROR(SR) (\
0 \
|| SR->senselen_used	/* Sent sense */ \
|| SR->status      		/* Host adapter status */ \
|| SR->retsts      		/* SCSI transfer status */ \
|| SR->error       		/* copy of errno */ \
)

__BEGIN_DECLS
scsireq_t *scsireq_reset __P((scsireq_t *));
scsireq_t *scsireq_new __P((void));

int scsireq_buff_decode __P((u_char *, size_t, char *, ...));
int scsireq_buff_decode_visit __P((u_char *, size_t, char *,
void (*a)(void *, int, void *, int, char *), void *));

int scsireq_decode __P((scsireq_t *, char *, ...));
int scsireq_decode_visit __P((scsireq_t *, char *,
void (*) (void *, int, void *, int, char *), void *));

int scsireq_encode __P((scsireq_t *, char *, ...));
int scsireq_encode_visit __P((scsireq_t *, char *,
	int (*)(void *, char *), void *));
int scsireq_buff_encode_visit __P((u_char *, size_t, char *,
	int (*)(void *, char *), void *));

scsireq_t *scsireq_build __P((scsireq_t *,
	u_long, caddr_t, u_long,
	char *, ...));

scsireq_t *scsireq_build_visit __P((scsireq_t *,
	u_long, caddr_t, u_long, char *,
	int (*)(void *, char *), void *));

int scsireq_enter __P((int, scsireq_t *));

void scsi_dump __P((FILE *, char *, u_char *, int, int, int ));

int scsi_debug __P((FILE *, int, scsireq_t *));
FILE *scsi_debug_output __P((char *));
int scsi_open __P((const char *, int ));
__END_DECLS

#endif /* _SCSI_H_ */