1 /* 2 * Data structures and definitions for the CAM system. 3 * 4 * Copyright (c) 1997 Justin T. Gibbs. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions, and the following disclaimer, 12 * without modification, immediately at the beginning of the file. 13 * 2. The name of the author may not be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD: src/sys/cam/cam.h,v 1.6.2.1 2000/03/17 22:36:21 peter Exp $ 29 * $DragonFly: src/sys/bus/cam/cam.h,v 1.4 2004/02/16 19:49:28 dillon Exp $ 30 */ 31 32 #ifndef _CAM_CAM_H 33 #define _CAM_CAM_H 1 34 35 #ifdef _KERNEL 36 #include <opt_cam.h> 37 #include <sys/sysctl.h> 38 #endif 39 40 #include <sys/cdefs.h> 41 42 typedef u_int path_id_t; 43 typedef u_int target_id_t; 44 typedef u_int lun_id_t; 45 46 #define CAM_XPT_PATH_ID ((path_id_t)~0) 47 #define CAM_BUS_WILDCARD ((path_id_t)~0) 48 #define CAM_TARGET_WILDCARD ((target_id_t)~0) 49 #define CAM_LUN_WILDCARD ((lun_id_t)~0) 50 51 /* 52 * Maximum length for a CAM CDB. 53 */ 54 #define CAM_MAX_CDBLEN 16 55 56 /* 57 * Definition of a CAM peripheral driver entry. Peripheral drivers instantiate 58 * one of these for each device they wish to communicate with and pass it into 59 * the xpt layer when they wish to schedule work on that device via the 60 * xpt_schedule API. 61 */ 62 struct cam_periph; 63 64 /* 65 * Priority information for a CAM structure. The generation number is 66 * incremented everytime a new entry is entered into the queue giving round 67 * robin per priority level scheduling. 68 */ 69 typedef struct { 70 u_int32_t priority; 71 #define CAM_PRIORITY_NONE (u_int32_t)-1 72 u_int32_t generation; 73 int index; 74 #define CAM_UNQUEUED_INDEX -1 75 #define CAM_ACTIVE_INDEX -2 76 #define CAM_DONEQ_INDEX -3 77 } cam_pinfo; 78 79 /* 80 * Macro to compare two generation numbers. It is used like this: 81 * 82 * if (GENERATIONCMP(a, >=, b)) 83 * ...; 84 * 85 * GERERATIONCMP uses modular arithmetic to guard against wraps 86 * wraps in the generation number. 87 */ 88 #define GENERATIONCMP(x, op, y) ((int32_t)((x) - (y)) op 0) 89 90 /* CAM flags */ 91 typedef enum { 92 CAM_FLAG_NONE = 0x00, 93 CAM_EXPECT_INQ_CHANGE = 0x01 94 } cam_flags; 95 96 /* CAM Status field values */ 97 typedef enum { 98 CAM_REQ_INPROG, /* CCB request is in progress */ 99 CAM_REQ_CMP, /* CCB request completed without error */ 100 CAM_REQ_ABORTED, /* CCB request aborted by the host */ 101 CAM_UA_ABORT, /* Unable to abort CCB request */ 102 CAM_REQ_CMP_ERR, /* CCB request completed with an error */ 103 CAM_BUSY, /* CAM subsytem is busy */ 104 CAM_REQ_INVALID, /* CCB request was invalid */ 105 CAM_PATH_INVALID, /* Supplied Path ID is invalid */ 106 CAM_DEV_NOT_THERE, /* SCSI Device Not Installed/there */ 107 CAM_UA_TERMIO, /* Unable to terminate I/O CCB request */ 108 CAM_SEL_TIMEOUT, /* Target Selection Timeout */ 109 CAM_CMD_TIMEOUT, /* Command timeout */ 110 CAM_SCSI_STATUS_ERROR, /* SCSI error, look at error code in CCB */ 111 CAM_MSG_REJECT_REC, /* Message Reject Received */ 112 CAM_SCSI_BUS_RESET, /* SCSI Bus Reset Sent/Received */ 113 CAM_UNCOR_PARITY, /* Uncorrectable parity error occurred */ 114 CAM_AUTOSENSE_FAIL = 0x10,/* Autosense: request sense cmd fail */ 115 CAM_NO_HBA, /* No HBA Detected error */ 116 CAM_DATA_RUN_ERR, /* Data Overrun error */ 117 CAM_UNEXP_BUSFREE, /* Unexpected Bus Free */ 118 CAM_SEQUENCE_FAIL, /* Target Bus Phase Sequence Failure */ 119 CAM_CCB_LEN_ERR, /* CCB length supplied is inadequate */ 120 CAM_PROVIDE_FAIL, /* Unable to provide requested capability */ 121 CAM_BDR_SENT, /* A SCSI BDR msg was sent to target */ 122 CAM_REQ_TERMIO, /* CCB request terminated by the host */ 123 CAM_UNREC_HBA_ERROR, /* Unrecoverable Host Bus Adapter Error */ 124 CAM_REQ_TOO_BIG, /* The request was too large for this host */ 125 CAM_REQUEUE_REQ, /* 126 * This request should be requeued to preserve 127 * transaction ordering. This typically occurs 128 * when the SIM recognizes an error that should 129 * freeze the queue and must place additional 130 * requests for the target at the sim level 131 * back into the XPT queue. 132 */ 133 CAM_IDE = 0x33, /* Initiator Detected Error */ 134 CAM_RESRC_UNAVAIL, /* Resource Unavailable */ 135 CAM_UNACKED_EVENT, /* Unacknowledged Event by Host */ 136 CAM_MESSAGE_RECV, /* Message Received in Host Target Mode */ 137 CAM_INVALID_CDB, /* Invalid CDB received in Host Target Mode */ 138 CAM_LUN_INVALID, /* Lun supplied is invalid */ 139 CAM_TID_INVALID, /* Target ID supplied is invalid */ 140 CAM_FUNC_NOTAVAIL, /* The requested function is not available */ 141 CAM_NO_NEXUS, /* Nexus is not established */ 142 CAM_IID_INVALID, /* The initiator ID is invalid */ 143 CAM_CDB_RECVD, /* The SCSI CDB has been received */ 144 CAM_LUN_ALRDY_ENA, /* The LUN is already eanbeld for target mode */ 145 CAM_SCSI_BUSY, /* SCSI Bus Busy */ 146 147 CAM_DEV_QFRZN = 0x40, /* The DEV queue is frozen w/this err */ 148 149 /* Autosense data valid for target */ 150 CAM_AUTOSNS_VALID = 0x80, 151 CAM_RELEASE_SIMQ = 0x100,/* SIM ready to take more commands */ 152 CAM_SIM_QUEUED = 0x200,/* SIM has this command in it's queue */ 153 154 CAM_STATUS_MASK = 0x3F, /* Mask bits for just the status # */ 155 156 /* Target Specific Adjunct Status */ 157 CAM_SENT_SENSE = 0x40000000 /* sent sense with status */ 158 } cam_status; 159 160 __BEGIN_DECLS 161 typedef int (cam_quirkmatch_t)(caddr_t, caddr_t); 162 163 caddr_t cam_quirkmatch(caddr_t target, caddr_t quirk_table, int num_entries, 164 int entry_size, cam_quirkmatch_t *comp_func); 165 166 void cam_strvis(u_int8_t *dst, const u_int8_t *src, int srclen, int dstlen); 167 168 int cam_strmatch(const u_int8_t *str, const u_int8_t *pattern, int str_len); 169 __END_DECLS 170 171 #ifdef _KERNEL 172 173 SYSCTL_DECL(_kern_cam); 174 175 static __inline void cam_init_pinfo(cam_pinfo *pinfo); 176 177 static __inline void cam_init_pinfo(cam_pinfo *pinfo) 178 { 179 pinfo->priority = CAM_PRIORITY_NONE; 180 pinfo->index = CAM_UNQUEUED_INDEX; 181 } 182 #endif 183 184 #endif /* _CAM_CAM_H */ 185