/* * Data structures and definitions for the CAM system. * * Copyright (c) 1997 Justin T. Gibbs. * 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, *    without modification, immediately at the beginning of the file. * 2. The name of the author may not be used to endorse or promote products *    derived from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 THE AUTHOR 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. * *      $Id: cam.h,v 1.1.2.1 1999/04/07 23:08:55 gibbs Exp $ */#ifndef _CAM_CAM_H#define _CAM_CAM_H 1#ifdef KERNEL#include <opt_cam.h>#endif /* KERNEL */#include <sys/cdefs.h>typedef u_int path_id_t;typedef u_int target_id_t;typedef u_int lun_id_t;#define	CAM_XPT_PATH_ID	((path_id_t)~0)#define	CAM_BUS_WILDCARD ((path_id_t)~0)#define	CAM_TARGET_WILDCARD ((target_id_t)~0)#define	CAM_LUN_WILDCARD ((lun_id_t)~0)/* * Maximum length for a CAM CDB.   */#define CAM_MAX_CDBLEN 16/* * Definition of a CAM peripheral driver entry.  Peripheral drivers instantiate * one of these for each device they wish to communicate with and pass it into * the xpt layer when they wish to schedule work on that device via the * xpt_schecule API. */struct cam_periph;/* * Priority information for a CAM structure.  The generation number is * incremented everytime a new entry is entered into the queue giving round * robin per priority level scheduling. */typedef struct {	u_int32_t priority;#define CAM_PRIORITY_NONE	(u_int32_t)-1	u_int32_t generation;	int       index;#define CAM_UNQUEUED_INDEX	-1#define CAM_ACTIVE_INDEX	-2	#define CAM_DONEQ_INDEX		-3	} cam_pinfo;/* * Macro to compare two generation numbers.  It is used like this:   * *	if (GENERATIONCMP(a, >=, b)) *		...; * * GERERATIONCMP uses modular arithmetic to guard against wraps * wraps in the generation number. */#define GENERATIONCMP(x, op, y) ((int32_t)((x) - (y)) op 0)/* CAM flags */typedef enum {	CAM_FLAG_NONE		= 0x00,	CAM_EXPECT_INQ_CHANGE	= 0x01} cam_flags;/* CAM  Status field values */typedef enum {	CAM_REQ_INPROG,		/* CCB request is in progress */	CAM_REQ_CMP,		/* CCB request completed without error */	CAM_REQ_ABORTED,	/* CCB request aborted by the host */	CAM_UA_ABORT,		/* Unable to abort CCB request */	CAM_REQ_CMP_ERR,	/* CCB request completed with an error */	CAM_BUSY,		/* CAM subsytem is busy */	CAM_REQ_INVALID,	/* CCB request was invalid */	CAM_PATH_INVALID,	/* Supplied Path ID is invalid */	CAM_DEV_NOT_THERE,	/* SCSI Device Not Installed/there */	CAM_UA_TERMIO,		/* Unable to terminate I/O CCB request */	CAM_SEL_TIMEOUT,	/* Target Selection Timeout */	CAM_CMD_TIMEOUT,	/* Command timeout */	CAM_SCSI_STATUS_ERROR,	/* SCSI error, look at error code in CCB */	CAM_MSG_REJECT_REC,	/* Message Reject Reveived */	CAM_SCSI_BUS_RESET,	/* SCSI Bus Reset Sent/Received */	CAM_UNCOR_PARITY,	/* Uncorrectable parity error occurred */	CAM_AUTOSENSE_FAIL = 0x10,/* Autosense: request sense cmd fail */	CAM_NO_HBA,		/* No HBA Detected error */	CAM_DATA_RUN_ERR,	/* Data Overrun error */	CAM_UNEXP_BUSFREE,	/* Unexpected Bus Free */	CAM_SEQUENCE_FAIL,	/* Target Bus Phase Sequence Failure */	CAM_CCB_LEN_ERR,	/* CCB length supplied is inadequate */	CAM_PROVIDE_FAIL,	/* Unable to provide requested capability */	CAM_BDR_SENT,		/* A SCSI BDR msg was sent to target */	CAM_REQ_TERMIO,		/* CCB request terminated by the host */	CAM_UNREC_HBA_ERROR,	/* Unrecoverable Host Bus Adapter Error */	CAM_REQ_TOO_BIG,	/* The request was too large for this host */	CAM_REQUEUE_REQ,	/*				 * This request should be requeued to preserve				 * transaction ordering.  This typically occurs				 * when the SIM recognizes an error that should				 * freeze the queue and must place additional				 * requests for the target at the sim level				 * back into the XPT queue.				 */	CAM_IDE = 0x33,		/* Initiator Detected Error */	CAM_RESRC_UNAVAIL,	/* Resource Unavailable */	CAM_UNACKED_EVENT,	/* Unacknowledged Event by Host */	CAM_MESSAGE_RECV,	/* Message Received in Host Target Mode */	CAM_INVALID_CDB,	/* Invalid CDB received in Host Target Mode */	CAM_LUN_INVALID,	/* Lun supplied is invalid */	CAM_TID_INVALID,	/* Target ID supplied is invalid */	CAM_FUNC_NOTAVAIL,	/* The requested function is not available */	CAM_NO_NEXUS,		/* Nexus is not established */	CAM_IID_INVALID,	/* The initiator ID is invalid */	CAM_CDB_RECVD,		/* The SCSI CDB has been received */	CAM_LUN_ALRDY_ENA,	/* The LUN is already eanbeld for target mode */	CAM_SCSI_BUSY,		/* SCSI Bus Busy */	CAM_DEV_QFRZN = 0x40,	/* The DEV queue is frozen w/this err */				/* Autosense data valid for target */	CAM_AUTOSNS_VALID = 0x80,	CAM_RELEASE_SIMQ = 0x100,/* SIM ready to take more commands */	CAM_SIM_QUEUED   = 0x200,/* SIM has this command in it's queue */	CAM_STATUS_MASK = 0x3F,	/* Mask bits for just the status # */} cam_status;__BEGIN_DECLStypedef int (cam_quirkmatch_t)(caddr_t, caddr_t);caddr_t	cam_quirkmatch(caddr_t target, caddr_t quirk_table, int num_entries,		       int entry_size, cam_quirkmatch_t *comp_func);void	cam_strvis(u_int8_t *dst, const u_int8_t *src, int srclen, int dstlen);int	cam_strmatch(const u_int8_t *str, const u_int8_t *pattern, int str_len);__END_DECLS#ifdef KERNELstatic __inline void cam_init_pinfo(cam_pinfo *pinfo);static __inline void cam_init_pinfo(cam_pinfo *pinfo){	pinfo->priority = CAM_PRIORITY_NONE;		pinfo->index = CAM_UNQUEUED_INDEX;}#endif /* KERNEL */#endif /* _CAM_CAM_H */