2 * Generic utility routines for the Common Access Method layer.
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
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/kernel.h>
36 #include <sys/sysctl.h>
43 #include <cam/cam_ccb.h>
44 #include <cam/scsi/scsi_all.h>
48 #include <sys/libkern.h>
49 #include <cam/cam_xpt.h>
52 static int camstatusentrycomp(const void *key, const void *member);
54 const struct cam_status_entry cam_status_table[] = {
55 { CAM_REQ_INPROG, "CCB request is in progress" },
56 { CAM_REQ_CMP, "CCB request completed without error" },
57 { CAM_REQ_ABORTED, "CCB request aborted by the host" },
58 { CAM_UA_ABORT, "Unable to abort CCB request" },
59 { CAM_REQ_CMP_ERR, "CCB request completed with an error" },
60 { CAM_BUSY, "CAM subsytem is busy" },
61 { CAM_REQ_INVALID, "CCB request was invalid" },
62 { CAM_PATH_INVALID, "Supplied Path ID is invalid" },
63 { CAM_DEV_NOT_THERE, "Device Not Present" },
64 { CAM_UA_TERMIO, "Unable to terminate I/O CCB request" },
65 { CAM_SEL_TIMEOUT, "Selection Timeout" },
66 { CAM_CMD_TIMEOUT, "Command timeout" },
67 { CAM_SCSI_STATUS_ERROR, "SCSI Status Error" },
68 { CAM_MSG_REJECT_REC, "Message Reject Reveived" },
69 { CAM_SCSI_BUS_RESET, "SCSI Bus Reset Sent/Received" },
70 { CAM_UNCOR_PARITY, "Uncorrectable parity/CRC error" },
71 { CAM_AUTOSENSE_FAIL, "Auto-Sense Retrieval Failed" },
72 { CAM_NO_HBA, "No HBA Detected" },
73 { CAM_DATA_RUN_ERR, "Data Overrun error" },
74 { CAM_UNEXP_BUSFREE, "Unexpected Bus Free" },
75 { CAM_SEQUENCE_FAIL, "Target Bus Phase Sequence Failure" },
76 { CAM_CCB_LEN_ERR, "CCB length supplied is inadequate" },
77 { CAM_PROVIDE_FAIL, "Unable to provide requested capability" },
78 { CAM_BDR_SENT, "SCSI BDR Message Sent" },
79 { CAM_REQ_TERMIO, "CCB request terminated by the host" },
80 { CAM_UNREC_HBA_ERROR, "Unrecoverable Host Bus Adapter Error" },
81 { CAM_REQ_TOO_BIG, "The request was too large for this host" },
82 { CAM_REQUEUE_REQ, "Unconditionally Re-queue Request", },
83 { CAM_IDE, "Initiator Detected Error Message Received" },
84 { CAM_RESRC_UNAVAIL, "Resource Unavailable" },
85 { CAM_UNACKED_EVENT, "Unacknowledged Event by Host" },
86 { CAM_MESSAGE_RECV, "Message Received in Host Target Mode" },
87 { CAM_INVALID_CDB, "Invalid CDB received in Host Target Mode" },
88 { CAM_LUN_INVALID, "Invalid Lun" },
89 { CAM_TID_INVALID, "Invalid Target ID" },
90 { CAM_FUNC_NOTAVAIL, "Function Not Available" },
91 { CAM_NO_NEXUS, "Nexus Not Established" },
92 { CAM_IID_INVALID, "Invalid Initiator ID" },
93 { CAM_CDB_RECVD, "CDB Received" },
94 { CAM_LUN_ALRDY_ENA, "LUN Already Enabled for Target Mode" },
95 { CAM_SCSI_BUSY, "SCSI Bus Busy" },
98 const int num_cam_status_entries =
99 sizeof(cam_status_table)/sizeof(*cam_status_table);
102 SYSCTL_NODE(_kern, OID_AUTO, cam, CTLFLAG_RD, 0, "CAM Subsystem");
106 cam_strvis(u_int8_t *dst, const u_int8_t *src, int srclen, int dstlen)
109 /* Trim leading/trailing spaces, nulls. */
110 while (srclen > 0 && src[0] == ' ')
113 && (src[srclen-1] == ' ' || src[srclen-1] == '\0'))
116 while (srclen > 0 && dstlen > 1) {
117 u_int8_t *cur_pos = dst;
119 if (*src < 0x20 || *src >= 0x80) {
120 /* SCSI-II Specifies that these should never occur. */
121 /* non-printable character */
124 *cur_pos++ = ((*src & 0300) >> 6) + '0';
125 *cur_pos++ = ((*src & 0070) >> 3) + '0';
126 *cur_pos++ = ((*src & 0007) >> 0) + '0';
131 /* normal character */
136 dstlen -= cur_pos - dst;
143 * Compare string with pattern, returning 0 on match.
144 * Short pattern matches trailing blanks in name,
145 * wildcard '*' in pattern matches rest of name,
146 * wildcard '?' matches a single non-space character.
149 cam_strmatch(const u_int8_t *str, const u_int8_t *pattern, int str_len)
152 while (*pattern != '\0'&& str_len > 0) {
154 if (*pattern == '*') {
157 if ((*pattern != *str)
158 && (*pattern != '?' || *str == ' ')) {
165 while (str_len > 0 && *str++ == ' ')
172 cam_quirkmatch(caddr_t target, caddr_t quirk_table, int num_entries,
173 int entry_size, cam_quirkmatch_t *comp_func)
175 for (; num_entries > 0; num_entries--, quirk_table += entry_size) {
176 if ((*comp_func)(target, quirk_table) == 0)
177 return (quirk_table);
182 const struct cam_status_entry*
183 cam_fetch_status_entry(cam_status status)
185 status &= CAM_STATUS_MASK;
186 return (bsearch(&status, &cam_status_table,
187 num_cam_status_entries,
188 sizeof(*cam_status_table),
189 camstatusentrycomp));
193 camstatusentrycomp(const void *key, const void *member)
196 const struct cam_status_entry *table_entry;
198 status = *(const cam_status *)key;
199 table_entry = (const struct cam_status_entry *)member;
201 return (status - table_entry->status_code);
207 cam_error_string(union ccb *ccb, char *str, int str_len,
208 cam_error_string_flags flags,
209 cam_error_proto_flags proto_flags)
212 cam_error_string(struct cam_device *device, union ccb *ccb, char *str,
213 int str_len, cam_error_string_flags flags,
214 cam_error_proto_flags proto_flags)
215 #endif /* _KERNEL/!_KERNEL */
225 if (flags == CAM_ESF_NONE)
228 switch (ccb->ccb_h.func_code) {
230 switch (proto_flags & CAM_EPF_LEVEL_MASK) {
235 proto_flags |= CAM_ESF_PRINT_SENSE;
237 case CAM_EPF_MINIMAL:
238 proto_flags |= CAM_ESF_PRINT_STATUS;
248 xpt_path_string(ccb->csio.ccb_h.path, path_str, sizeof(path_str));
250 cam_path_string(device, path_str, sizeof(path_str));
251 #endif /* _KERNEL/!_KERNEL */
253 sbuf_new(&sb, str, str_len, 0);
255 if (flags & CAM_ESF_COMMAND) {
257 sbuf_cat(&sb, path_str);
259 switch (ccb->ccb_h.func_code) {
262 scsi_command_string(&ccb->csio, &sb);
264 scsi_command_string(device, &ccb->csio, &sb);
265 #endif /* _KERNEL/!_KERNEL */
266 sbuf_printf(&sb, "\n");
274 if (flags & CAM_ESF_CAM_STATUS) {
276 const struct cam_status_entry *entry;
278 sbuf_cat(&sb, path_str);
280 status = ccb->ccb_h.status & CAM_STATUS_MASK;
282 entry = cam_fetch_status_entry(status);
285 sbuf_printf(&sb, "CAM Status: Unknown (%#x)\n",
288 sbuf_printf(&sb, "CAM Status: %s\n",
292 if (flags & CAM_ESF_PROTO_STATUS) {
294 switch (ccb->ccb_h.func_code) {
296 if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
297 CAM_SCSI_STATUS_ERROR)
300 if (proto_flags & CAM_ESF_PRINT_STATUS) {
301 sbuf_cat(&sb, path_str);
303 * Print out the SCSI status byte as long as
304 * the user wants some protocol output.
306 sbuf_printf(&sb, "SCSI Status: %s\n",
307 scsi_status_string(&ccb->csio));
310 if ((proto_flags & CAM_ESF_PRINT_SENSE)
311 && (ccb->csio.scsi_status == SCSI_STATUS_CHECK_COND)
312 && (ccb->ccb_h.status & CAM_AUTOSNS_VALID)) {
315 scsi_sense_sbuf(&ccb->csio, &sb,
318 scsi_sense_sbuf(device, &ccb->csio, &sb,
320 #endif /* _KERNEL/!_KERNEL */
330 return(sbuf_data(&sb));
336 cam_error_print(union ccb *ccb, cam_error_string_flags flags,
337 cam_error_proto_flags proto_flags)
341 printf("%s", cam_error_string(ccb, str, sizeof(str), flags,
348 cam_error_print(struct cam_device *device, union ccb *ccb,
349 cam_error_string_flags flags, cam_error_proto_flags proto_flags,
354 if ((device == NULL) || (ccb == NULL) || (ofile == NULL))
357 fprintf(ofile, "%s", cam_error_string(device, ccb, str, sizeof(str),
358 flags, proto_flags));
361 #endif /* _KERNEL/!_KERNEL */
364 * Common calculate geometry fuction
366 * Caller should set ccg->volume_size and block_size.
367 * The extended parameter should be zero if extended translation
368 * should not be used.
371 cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended)
373 uint32_t size_mb, secs_per_cylinder;
375 if (ccg->block_size == 0) {
376 ccg->ccb_h.status = CAM_REQ_CMP_ERR;
379 size_mb = (1024L * 1024L) / ccg->block_size;
381 ccg->ccb_h.status = CAM_REQ_CMP_ERR;
384 size_mb = ccg->volume_size / size_mb;
385 if (size_mb > 1024 && extended) {
387 ccg->secs_per_track = 63;
390 ccg->secs_per_track = 32;
392 secs_per_cylinder = ccg->heads * ccg->secs_per_track;
393 if (secs_per_cylinder == 0) {
394 ccg->ccb_h.status = CAM_REQ_CMP_ERR;
397 ccg->cylinders = ccg->volume_size / secs_per_cylinder;
398 ccg->ccb_h.status = CAM_REQ_CMP;