2 * Data structures and definitions for the CAM system.
4 * Copyright (c) 1997 Justin T. Gibbs.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
38 #include <sys/cdefs.h>
40 typedef u_int path_id_t;
41 typedef u_int target_id_t;
42 typedef u_int lun_id_t;
48 #define CAM_XPT_PATH_ID ((path_id_t)~0)
49 #define CAM_BUS_WILDCARD ((path_id_t)~0)
50 #define CAM_TARGET_WILDCARD ((target_id_t)~0)
51 #define CAM_LUN_WILDCARD ((lun_id_t)~0)
53 #define CAM_EXTLUN_BYTE_SWIZZLE(lun) ( \
54 ((((u_int64_t)lun) & 0xffff000000000000L) >> 48) | \
55 ((((u_int64_t)lun) & 0x0000ffff00000000L) >> 16) | \
56 ((((u_int64_t)lun) & 0x00000000ffff0000L) << 16) | \
57 ((((u_int64_t)lun) & 0x000000000000ffffL) << 48))
60 * Maximum length for a CAM CDB.
62 #define CAM_MAX_CDBLEN 16
65 * Definition of a CAM peripheral driver entry. Peripheral drivers instantiate
66 * one of these for each device they wish to communicate with and pass it into
67 * the xpt layer when they wish to schedule work on that device via the
73 * Priority information for a CAM structure.
84 * The generation number is incremented everytime a new entry is entered into
85 * the queue giving round robin per priority level scheduling.
89 #define CAM_PRIORITY_HOST ((CAM_RL_HOST << 8) + 0x80)
90 #define CAM_PRIORITY_BUS ((CAM_RL_BUS << 8) + 0x80)
91 #define CAM_PRIORITY_XPT ((CAM_RL_XPT << 8) + 0x80)
92 #define CAM_PRIORITY_DEV ((CAM_RL_DEV << 8) + 0x80)
93 #define CAM_PRIORITY_OOB (CAM_RL_DEV << 8)
94 #define CAM_PRIORITY_NORMAL ((CAM_RL_NORMAL << 8) + 0x80)
95 #define CAM_PRIORITY_NONE (u_int32_t)-1
98 #define CAM_UNQUEUED_INDEX -1
99 #define CAM_ACTIVE_INDEX -2
100 #define CAM_DONEQ_INDEX -3
101 #define CAM_EXTRAQ_INDEX INT_MAX
105 * Macro to compare two generation numbers. It is used like this:
107 * if (GENERATIONCMP(a, >=, b))
110 * GERERATIONCMP uses modular arithmetic to guard against wraps
111 * wraps in the generation number.
113 #define GENERATIONCMP(x, op, y) ((int32_t)((x) - (y)) op 0)
115 /* CAM flags XXX Move to cam_periph.h ??? */
117 CAM_FLAG_NONE = 0x00,
118 CAM_EXPECT_INQ_CHANGE = 0x01,
119 CAM_RETRY_SELTO = 0x02 /* Retry Selection Timeouts */
123 SF_RETRY_UA = 0x01, /* Retry UNIT ATTENTION conditions. */
124 SF_NO_PRINT = 0x02, /* Never print error status. */
125 SF_QUIET_IR = 0x04, /* Be quiet about Illegal Request reponses */
126 SF_PRINT_ALWAYS = 0x08, /* Always print error status. */
127 SF_NO_RECOVERY = 0x10, /* Don't do active error recovery. */
128 SF_NO_RETRY = 0x20, /* Don't do any retries. */
129 SF_RETRY_BUSY = 0x40 /* Retry BUSY status. */
132 /* CAM Status field values */
134 /* CCB request is in progress */
135 CAM_REQ_INPROG = 0x00,
137 /* CCB request completed without error */
140 /* CCB request aborted by the host */
141 CAM_REQ_ABORTED = 0x02,
143 /* Unable to abort CCB request */
146 /* CCB request completed with an error */
147 CAM_REQ_CMP_ERR = 0x04,
149 /* CAM subsystem is busy */
152 /* CCB request was invalid */
153 CAM_REQ_INVALID = 0x06,
155 /* Supplied Path ID is invalid */
156 CAM_PATH_INVALID = 0x07,
158 /* SCSI Device Not Installed/there */
159 CAM_DEV_NOT_THERE = 0x08,
161 /* Unable to terminate I/O CCB request */
162 CAM_UA_TERMIO = 0x09,
164 /* Target Selection Timeout */
165 CAM_SEL_TIMEOUT = 0x0a,
167 /* Command timeout */
168 CAM_CMD_TIMEOUT = 0x0b,
170 /* SCSI error, look at error code in CCB */
171 CAM_SCSI_STATUS_ERROR = 0x0c,
173 /* Message Reject Received */
174 CAM_MSG_REJECT_REC = 0x0d,
176 /* SCSI Bus Reset Sent/Received */
177 CAM_SCSI_BUS_RESET = 0x0e,
179 /* Uncorrectable parity error occurred */
180 CAM_UNCOR_PARITY = 0x0f,
182 /* Autosense: request sense cmd fail */
183 CAM_AUTOSENSE_FAIL = 0x10,
185 /* No HBA Detected error */
188 /* Data Overrun error */
189 CAM_DATA_RUN_ERR = 0x12,
191 /* Unexpected Bus Free */
192 CAM_UNEXP_BUSFREE = 0x13,
194 /* Target Bus Phase Sequence Failure */
195 CAM_SEQUENCE_FAIL = 0x14,
197 /* CCB length supplied is inadequate */
198 CAM_CCB_LEN_ERR = 0x15,
200 /* Unable to provide requested capability*/
201 CAM_PROVIDE_FAIL = 0x16,
203 /* A SCSI BDR msg was sent to target */
206 /* CCB request terminated by the host */
207 CAM_REQ_TERMIO = 0x18,
209 /* Unrecoverable Host Bus Adapter Error */
210 CAM_UNREC_HBA_ERROR = 0x19,
212 /* Request was too large for this host */
213 CAM_REQ_TOO_BIG = 0x1a,
216 * This request should be requeued to preserve
217 * transaction ordering. This typically occurs
218 * when the SIM recognizes an error that should
219 * freeze the queue and must place additional
220 * requests for the target at the sim level
221 * back into the XPT queue.
223 CAM_REQUEUE_REQ = 0x1b,
225 /* ATA error, look at error code in CCB */
226 CAM_ATA_STATUS_ERROR = 0x1c,
228 /* Initiator/Target Nexus lost. */
229 CAM_SCSI_IT_NEXUS_LOST = 0x1d,
231 /* SMP error, look at error code in CCB */
232 CAM_SMP_STATUS_ERROR = 0x1e,
235 * Command completed without error but exceeded the soft
238 CAM_REQ_SOFTTIMEOUT = 0x1f,
241 * 0x20 - 0x32 are unassigned
244 /* Initiator Detected Error */
247 /* Resource Unavailable */
248 CAM_RESRC_UNAVAIL = 0x34,
250 /* Unacknowledged Event by Host */
251 CAM_UNACKED_EVENT = 0x35,
253 /* Message Received in Host Target Mode */
254 CAM_MESSAGE_RECV = 0x36,
256 /* Invalid CDB received in Host Target Mode */
257 CAM_INVALID_CDB = 0x37,
259 /* Lun supplied is invalid */
260 CAM_LUN_INVALID = 0x38,
262 /* Target ID supplied is invalid */
263 CAM_TID_INVALID = 0x39,
265 /* The requested function is not available */
266 CAM_FUNC_NOTAVAIL = 0x3a,
268 /* Nexus is not established */
271 /* The initiator ID is invalid */
272 CAM_IID_INVALID = 0x3c,
274 /* The SCSI CDB has been received */
275 CAM_CDB_RECVD = 0x3d,
277 /* The LUN is already enabled for target mode */
278 CAM_LUN_ALRDY_ENA = 0x3e,
281 CAM_SCSI_BUSY = 0x3f,
288 /* The DEV queue is frozen w/this err */
289 CAM_DEV_QFRZN = 0x40,
291 /* Autosense data valid for target */
292 CAM_AUTOSNS_VALID = 0x80,
294 /* SIM ready to take more commands */
295 CAM_RELEASE_SIMQ = 0x100,
297 /* SIM has this command in it's queue */
298 CAM_SIM_QUEUED = 0x200,
300 /* Quality of service data is valid */
301 CAM_QOS_VALID = 0x400,
303 /* Mask bits for just the status # */
304 CAM_STATUS_MASK = 0x3F,
307 * Target Specific Adjunct Status
310 /* sent sense with status */
311 CAM_SENT_SENSE = 0x40000000
316 CAM_ESF_COMMAND = 0x01,
317 CAM_ESF_CAM_STATUS = 0x02,
318 CAM_ESF_PROTO_STATUS = 0x04,
320 } cam_error_string_flags;
324 CAM_EPF_MINIMAL = 0x01,
325 CAM_EPF_NORMAL = 0x02,
327 CAM_EPF_LEVEL_MASK = 0x0f
328 /* All bits above bit 3 are protocol-specific */
329 } cam_error_proto_flags;
332 CAM_ESF_PRINT_NONE = 0x00,
333 CAM_ESF_PRINT_STATUS = 0x10,
334 CAM_ESF_PRINT_SENSE = 0x20
335 } cam_error_scsi_flags;
338 CAM_ESMF_PRINT_NONE = 0x00,
339 CAM_ESMF_PRINT_STATUS = 0x10,
340 CAM_ESMF_PRINT_FULL_CMD = 0x20,
341 } cam_error_smp_flags;
344 CAM_EAF_PRINT_NONE = 0x00,
345 CAM_EAF_PRINT_STATUS = 0x10,
346 CAM_EAF_PRINT_RESULT = 0x20
347 } cam_error_ata_flags;
350 CAM_STRVIS_FLAG_NONE = 0x00,
351 CAM_STRVIS_FLAG_NONASCII_MASK = 0x03,
352 CAM_STRVIS_FLAG_NONASCII_TRIM = 0x00,
353 CAM_STRVIS_FLAG_NONASCII_RAW = 0x01,
354 CAM_STRVIS_FLAG_NONASCII_SPC = 0x02,
355 CAM_STRVIS_FLAG_NONASCII_ESC = 0x03
358 struct cam_status_entry
360 cam_status status_code;
361 const char *status_text;
364 extern const struct cam_status_entry cam_status_table[];
365 extern const int num_cam_status_entries;
367 extern int cam_sort_io_queues;
372 #ifdef SYSCTL_DECL /* from sysctl.h */
373 SYSCTL_DECL(_kern_cam);
377 typedef int (cam_quirkmatch_t)(caddr_t, caddr_t);
379 caddr_t cam_quirkmatch(caddr_t target, caddr_t quirk_table, int num_entries,
380 int entry_size, cam_quirkmatch_t *comp_func);
382 void cam_strvis(u_int8_t *dst, const u_int8_t *src, int srclen, int dstlen);
383 void cam_strvis_sbuf(struct sbuf *sb, const u_int8_t *src, int srclen,
386 int cam_strmatch(const u_int8_t *str, const u_int8_t *pattern, int str_len);
387 const struct cam_status_entry*
388 cam_fetch_status_entry(cam_status status);
390 char * cam_error_string(union ccb *ccb, char *str, int str_len,
391 cam_error_string_flags flags,
392 cam_error_proto_flags proto_flags);
393 void cam_error_print(union ccb *ccb, cam_error_string_flags flags,
394 cam_error_proto_flags proto_flags);
398 char * cam_error_string(struct cam_device *device, union ccb *ccb, char *str,
399 int str_len, cam_error_string_flags flags,
400 cam_error_proto_flags proto_flags);
401 void cam_error_print(struct cam_device *device, union ccb *ccb,
402 cam_error_string_flags flags,
403 cam_error_proto_flags proto_flags, FILE *ofile);
408 static __inline void cam_init_pinfo(cam_pinfo *pinfo);
410 static __inline void cam_init_pinfo(cam_pinfo *pinfo)
412 pinfo->priority = CAM_PRIORITY_NONE;
413 pinfo->index = CAM_UNQUEUED_INDEX;
417 #endif /* _CAM_CAM_H */