2 * Implementation of Utility functions for all SCSI device types.
4 * Copyright (c) 1997, 1998, 1999 Justin T. Gibbs.
5 * Copyright (c) 1997, 1998, 2003 Kenneth D. Merry.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions, and the following disclaimer,
13 * without modification, immediately at the beginning of the file.
14 * 2. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
21 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_scsi_all.c#2 $
32 #include <sys/param.h>
34 __FBSDID("$FreeBSD$");
36 #include <sys/types.h>
38 #include <sys/systm.h>
39 #include <sys/libkern.h>
40 #include <sys/kernel.h>
41 #include <sys/sysctl.h>
51 #include <cam/cam_ccb.h>
52 #include <cam/cam_queue.h>
53 #include <cam/cam_xpt.h>
54 #include <cam/scsi/scsi_all.h>
56 #include <cam/ctl/ctl_io.h>
57 #include <cam/ctl/ctl_scsi_all.h>
64 ctl_scsi_status_string(struct ctl_scsiio *ctsio)
66 switch(ctsio->scsi_status) {
69 case SCSI_STATUS_CHECK_COND:
70 return("Check Condition");
71 case SCSI_STATUS_BUSY:
73 case SCSI_STATUS_INTERMED:
74 return("Intermediate");
75 case SCSI_STATUS_INTERMED_COND_MET:
76 return("Intermediate-Condition Met");
77 case SCSI_STATUS_RESERV_CONFLICT:
78 return("Reservation Conflict");
79 case SCSI_STATUS_CMD_TERMINATED:
80 return("Command Terminated");
81 case SCSI_STATUS_QUEUE_FULL:
83 case SCSI_STATUS_ACA_ACTIVE:
85 case SCSI_STATUS_TASK_ABORTED:
86 return("Task Aborted");
88 static char unkstr[64];
89 snprintf(unkstr, sizeof(unkstr), "Unknown %#x",
97 * scsi_command_string() returns 0 for success and -1 for failure.
100 ctl_scsi_command_string(struct ctl_scsiio *ctsio,
101 struct scsi_inquiry_data *inq_data, struct sbuf *sb)
103 char cdb_str[(SCSI_MAX_CDBLEN * 3) + 1];
105 sbuf_printf(sb, "%s. CDB: %s",
106 scsi_op_desc(ctsio->cdb[0], inq_data),
107 scsi_cdb_string(ctsio->cdb, cdb_str, sizeof(cdb_str)));
113 ctl_scsi_path_string(union ctl_io *io, char *path_str, int len)
115 if (io->io_hdr.nexus.targ_target.wwid[0] == 0) {
116 snprintf(path_str, len, "(%ju:%d:%ju:%d): ",
117 (uintmax_t)io->io_hdr.nexus.initid.id,
118 io->io_hdr.nexus.targ_port,
119 (uintmax_t)io->io_hdr.nexus.targ_target.id,
120 io->io_hdr.nexus.targ_lun);
123 * XXX KDM find a better way to display FC WWIDs.
126 snprintf(path_str, len, "(%ju:%d:%#jx,%#jx:%d): ",
127 (uintmax_t)io->io_hdr.nexus.initid.id,
128 io->io_hdr.nexus.targ_port,
129 (intmax_t)io->io_hdr.nexus.targ_target.wwid[0],
130 (intmax_t)io->io_hdr.nexus.targ_target.wwid[1],
131 io->io_hdr.nexus.targ_lun);
133 snprintf(path_str, len, "(%ju:%d:%#jx,%#jx:%d): ",
134 (uintmax_t)io->io_hdr.nexus.initid.id,
135 io->io_hdr.nexus.targ_port,
136 (intmax_t)io->io_hdr.nexus.targ_target.wwid[0],
137 (intmax_t)io->io_hdr.nexus.targ_target.wwid[1],
138 io->io_hdr.nexus.targ_lun);
144 * ctl_scsi_sense_sbuf() returns 0 for success and -1 for failure.
147 ctl_scsi_sense_sbuf(struct ctl_scsiio *ctsio,
148 struct scsi_inquiry_data *inq_data, struct sbuf *sb,
149 scsi_sense_string_flags flags)
153 if ((ctsio == NULL) || (sb == NULL))
156 ctl_scsi_path_string((union ctl_io *)ctsio, path_str, sizeof(path_str));
158 if (flags & SSS_FLAG_PRINT_COMMAND) {
160 sbuf_cat(sb, path_str);
162 ctl_scsi_command_string(ctsio, inq_data, sb);
164 sbuf_printf(sb, "\n");
167 scsi_sense_only_sbuf(&ctsio->sense_data, ctsio->sense_len, sb,
168 path_str, inq_data, ctsio->cdb, ctsio->cdb_len);
174 ctl_scsi_sense_string(struct ctl_scsiio *ctsio,
175 struct scsi_inquiry_data *inq_data, char *str,
180 sbuf_new(&sb, str, str_len, 0);
182 ctl_scsi_sense_sbuf(ctsio, inq_data, &sb, SSS_FLAG_PRINT_COMMAND);
186 return(sbuf_data(&sb));
191 ctl_scsi_sense_print(struct ctl_scsiio *ctsio,
192 struct scsi_inquiry_data *inq_data)
197 sbuf_new(&sb, str, sizeof(str), 0);
199 ctl_scsi_sense_sbuf(ctsio, inq_data, &sb, SSS_FLAG_PRINT_COMMAND);
203 printf("%s", sbuf_data(&sb));
208 ctl_scsi_sense_print(struct ctl_scsiio *ctsio,
209 struct scsi_inquiry_data *inq_data, FILE *ofile)
214 if ((ctsio == NULL) || (ofile == NULL))
217 sbuf_new(&sb, str, sizeof(str), 0);
219 ctl_scsi_sense_sbuf(ctsio, inq_data, &sb, SSS_FLAG_PRINT_COMMAND);
223 fprintf(ofile, "%s", sbuf_data(&sb));