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_int64_t lun_id_t;
44 #define CAM_XPT_PATH_ID ((path_id_t)~0)
45 #define CAM_BUS_WILDCARD ((path_id_t)~0)
46 #define CAM_TARGET_WILDCARD ((target_id_t)~0)
47 #define CAM_LUN_WILDCARD (~(u_int)0)
49 #define CAM_EXTLUN_BYTE_SWIZZLE(lun) ( \
50 ((((u_int64_t)lun) & 0xffff000000000000L) >> 48) | \
51 ((((u_int64_t)lun) & 0x0000ffff00000000L) >> 16) | \
52 ((((u_int64_t)lun) & 0x00000000ffff0000L) << 16) | \
53 ((((u_int64_t)lun) & 0x000000000000ffffL) << 48))
56 * Maximum length for a CAM CDB.
58 #define CAM_MAX_CDBLEN 16
61 * Definition of a CAM peripheral driver entry. Peripheral drivers instantiate
62 * one of these for each device they wish to communicate with and pass it into
63 * the xpt layer when they wish to schedule work on that device via the
69 * Priority information for a CAM structure.
80 * The generation number is incremented everytime a new entry is entered into
81 * the queue giving round robin per priority level scheduling.
85 #define CAM_PRIORITY_HOST ((CAM_RL_HOST << 8) + 0x80)
86 #define CAM_PRIORITY_BUS ((CAM_RL_BUS << 8) + 0x80)
87 #define CAM_PRIORITY_XPT ((CAM_RL_XPT << 8) + 0x80)
88 #define CAM_PRIORITY_DEV ((CAM_RL_DEV << 8) + 0x80)
89 #define CAM_PRIORITY_OOB (CAM_RL_DEV << 8)
90 #define CAM_PRIORITY_NORMAL ((CAM_RL_NORMAL << 8) + 0x80)
91 #define CAM_PRIORITY_NONE (u_int32_t)-1
94 #define CAM_UNQUEUED_INDEX -1
95 #define CAM_ACTIVE_INDEX -2
96 #define CAM_DONEQ_INDEX -3
97 #define CAM_EXTRAQ_INDEX INT_MAX
101 * Macro to compare two generation numbers. It is used like this:
103 * if (GENERATIONCMP(a, >=, b))
106 * GERERATIONCMP uses modular arithmetic to guard against wraps
107 * wraps in the generation number.
109 #define GENERATIONCMP(x, op, y) ((int32_t)((x) - (y)) op 0)
111 /* CAM flags XXX Move to cam_periph.h ??? */
113 CAM_FLAG_NONE = 0x00,
114 CAM_EXPECT_INQ_CHANGE = 0x01,
115 CAM_RETRY_SELTO = 0x02 /* Retry Selection Timeouts */
119 SF_RETRY_UA = 0x01, /* Retry UNIT ATTENTION conditions. */
120 SF_NO_PRINT = 0x02, /* Never print error status. */
121 SF_QUIET_IR = 0x04, /* Be quiet about Illegal Request reponses */
122 SF_PRINT_ALWAYS = 0x08, /* Always print error status. */
123 SF_NO_RECOVERY = 0x10, /* Don't do active error recovery. */
124 SF_NO_RETRY = 0x20 /* Don't do any retries. */
127 /* CAM Status field values */
129 /* CCB request is in progress */
130 CAM_REQ_INPROG = 0x00,
132 /* CCB request completed without error */
135 /* CCB request aborted by the host */
136 CAM_REQ_ABORTED = 0x02,
138 /* Unable to abort CCB request */
141 /* CCB request completed with an error */
142 CAM_REQ_CMP_ERR = 0x04,
144 /* CAM subsystem is busy */
147 /* CCB request was invalid */
148 CAM_REQ_INVALID = 0x06,
150 /* Supplied Path ID is invalid */
151 CAM_PATH_INVALID = 0x07,
153 /* SCSI Device Not Installed/there */
154 CAM_DEV_NOT_THERE = 0x08,
156 /* Unable to terminate I/O CCB request */
157 CAM_UA_TERMIO = 0x09,
159 /* Target Selection Timeout */
160 CAM_SEL_TIMEOUT = 0x0a,
162 /* Command timeout */
163 CAM_CMD_TIMEOUT = 0x0b,
165 /* SCSI error, look at error code in CCB */
166 CAM_SCSI_STATUS_ERROR = 0x0c,
168 /* Message Reject Received */
169 CAM_MSG_REJECT_REC = 0x0d,
171 /* SCSI Bus Reset Sent/Received */
172 CAM_SCSI_BUS_RESET = 0x0e,
174 /* Uncorrectable parity error occurred */
175 CAM_UNCOR_PARITY = 0x0f,
177 /* Autosense: request sense cmd fail */
178 CAM_AUTOSENSE_FAIL = 0x10,
180 /* No HBA Detected error */
183 /* Data Overrun error */
184 CAM_DATA_RUN_ERR = 0x12,
186 /* Unexpected Bus Free */
187 CAM_UNEXP_BUSFREE = 0x13,
189 /* Target Bus Phase Sequence Failure */
190 CAM_SEQUENCE_FAIL = 0x14,
192 /* CCB length supplied is inadequate */
193 CAM_CCB_LEN_ERR = 0x15,
195 /* Unable to provide requested capability*/
196 CAM_PROVIDE_FAIL = 0x16,
198 /* A SCSI BDR msg was sent to target */
201 /* CCB request terminated by the host */
202 CAM_REQ_TERMIO = 0x18,
204 /* Unrecoverable Host Bus Adapter Error */
205 CAM_UNREC_HBA_ERROR = 0x19,
207 /* Request was too large for this host */
208 CAM_REQ_TOO_BIG = 0x1a,
211 * This request should be requeued to preserve
212 * transaction ordering. This typically occurs
213 * when the SIM recognizes an error that should
214 * freeze the queue and must place additional
215 * requests for the target at the sim level
216 * back into the XPT queue.
218 CAM_REQUEUE_REQ = 0x1b,
220 /* ATA error, look at error code in CCB */
221 CAM_ATA_STATUS_ERROR = 0x1c,
223 /* Initiator/Target Nexus lost. */
224 CAM_SCSI_IT_NEXUS_LOST = 0x1d,
226 /* SMP error, look at error code in CCB */
227 CAM_SMP_STATUS_ERROR = 0x1e,
230 * Command completed without error but exceeded the soft
233 CAM_REQ_SOFTTIMEOUT = 0x1f,
236 * 0x20 - 0x32 are unassigned
239 /* Initiator Detected Error */
242 /* Resource Unavailable */
243 CAM_RESRC_UNAVAIL = 0x34,
245 /* Unacknowledged Event by Host */
246 CAM_UNACKED_EVENT = 0x35,
248 /* Message Received in Host Target Mode */
249 CAM_MESSAGE_RECV = 0x36,
251 /* Invalid CDB received in Host Target Mode */
252 CAM_INVALID_CDB = 0x37,
254 /* Lun supplied is invalid */
255 CAM_LUN_INVALID = 0x38,
257 /* Target ID supplied is invalid */
258 CAM_TID_INVALID = 0x39,
260 /* The requested function is not available */
261 CAM_FUNC_NOTAVAIL = 0x3a,
263 /* Nexus is not established */
266 /* The initiator ID is invalid */
267 CAM_IID_INVALID = 0x3c,
269 /* The SCSI CDB has been received */
270 CAM_CDB_RECVD = 0x3d,
272 /* The LUN is already enabled for target mode */
273 CAM_LUN_ALRDY_ENA = 0x3e,
276 CAM_SCSI_BUSY = 0x3f,
283 /* The DEV queue is frozen w/this err */
284 CAM_DEV_QFRZN = 0x40,
286 /* Autosense data valid for target */
287 CAM_AUTOSNS_VALID = 0x80,
289 /* SIM ready to take more commands */
290 CAM_RELEASE_SIMQ = 0x100,
292 /* SIM has this command in it's queue */
293 CAM_SIM_QUEUED = 0x200,
295 /* Quality of service data is valid */
296 CAM_QOS_VALID = 0x400,
298 /* Mask bits for just the status # */
299 CAM_STATUS_MASK = 0x3F,
302 * Target Specific Adjunct Status
305 /* sent sense with status */
306 CAM_SENT_SENSE = 0x40000000
311 CAM_ESF_COMMAND = 0x01,
312 CAM_ESF_CAM_STATUS = 0x02,
313 CAM_ESF_PROTO_STATUS = 0x04,
315 } cam_error_string_flags;
319 CAM_EPF_MINIMAL = 0x01,
320 CAM_EPF_NORMAL = 0x02,
322 CAM_EPF_LEVEL_MASK = 0x0f
323 /* All bits above bit 3 are protocol-specific */
324 } cam_error_proto_flags;
327 CAM_ESF_PRINT_NONE = 0x00,
328 CAM_ESF_PRINT_STATUS = 0x10,
329 CAM_ESF_PRINT_SENSE = 0x20
330 } cam_error_scsi_flags;
333 CAM_ESMF_PRINT_NONE = 0x00,
334 CAM_ESMF_PRINT_STATUS = 0x10,
335 CAM_ESMF_PRINT_FULL_CMD = 0x20,
336 } cam_error_smp_flags;
339 CAM_EAF_PRINT_NONE = 0x00,
340 CAM_EAF_PRINT_STATUS = 0x10,
341 CAM_EAF_PRINT_RESULT = 0x20
342 } cam_error_ata_flags;
344 struct cam_status_entry
346 cam_status status_code;
347 const char *status_text;
350 extern const struct cam_status_entry cam_status_table[];
351 extern const int num_cam_status_entries;
353 extern int cam_sort_io_queues;
357 #ifdef SYSCTL_DECL /* from sysctl.h */
358 SYSCTL_DECL(_kern_cam);
362 typedef int (cam_quirkmatch_t)(caddr_t, caddr_t);
364 caddr_t cam_quirkmatch(caddr_t target, caddr_t quirk_table, int num_entries,
365 int entry_size, cam_quirkmatch_t *comp_func);
367 void cam_strvis(u_int8_t *dst, const u_int8_t *src, int srclen, int dstlen);
369 int cam_strmatch(const u_int8_t *str, const u_int8_t *pattern, int str_len);
370 const struct cam_status_entry*
371 cam_fetch_status_entry(cam_status status);
373 char * cam_error_string(union ccb *ccb, char *str, int str_len,
374 cam_error_string_flags flags,
375 cam_error_proto_flags proto_flags);
376 void cam_error_print(union ccb *ccb, cam_error_string_flags flags,
377 cam_error_proto_flags proto_flags);
381 char * cam_error_string(struct cam_device *device, union ccb *ccb, char *str,
382 int str_len, cam_error_string_flags flags,
383 cam_error_proto_flags proto_flags);
384 void cam_error_print(struct cam_device *device, union ccb *ccb,
385 cam_error_string_flags flags,
386 cam_error_proto_flags proto_flags, FILE *ofile);
391 static __inline void cam_init_pinfo(cam_pinfo *pinfo);
393 static __inline void cam_init_pinfo(cam_pinfo *pinfo)
395 pinfo->priority = CAM_PRIORITY_NONE;
396 pinfo->index = CAM_UNQUEUED_INDEX;
400 #endif /* _CAM_CAM_H */