2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Implementation of Utility functions for all SCSI device types.
6 * Copyright (c) 1997, 1998, 1999 Justin T. Gibbs.
7 * Copyright (c) 1997, 1998, 2003 Kenneth D. Merry.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions, and the following disclaimer,
15 * without modification, immediately at the beginning of the file.
16 * 2. The name of the author may not be used to endorse or promote products
17 * derived from this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_scsi_all.c#2 $
34 #include <sys/param.h>
36 __FBSDID("$FreeBSD$");
38 #include <sys/types.h>
40 #include <sys/systm.h>
41 #include <sys/libkern.h>
42 #include <sys/kernel.h>
43 #include <sys/sysctl.h>
53 #include <cam/cam_ccb.h>
54 #include <cam/cam_queue.h>
55 #include <cam/cam_xpt.h>
56 #include <cam/scsi/scsi_all.h>
58 #include <cam/ctl/ctl_io.h>
59 #include <cam/ctl/ctl_scsi_all.h>
66 ctl_scsi_status_string(struct ctl_scsiio *ctsio)
68 switch(ctsio->scsi_status) {
71 case SCSI_STATUS_CHECK_COND:
72 return("Check Condition");
73 case SCSI_STATUS_BUSY:
75 case SCSI_STATUS_INTERMED:
76 return("Intermediate");
77 case SCSI_STATUS_INTERMED_COND_MET:
78 return("Intermediate-Condition Met");
79 case SCSI_STATUS_RESERV_CONFLICT:
80 return("Reservation Conflict");
81 case SCSI_STATUS_CMD_TERMINATED:
82 return("Command Terminated");
83 case SCSI_STATUS_QUEUE_FULL:
85 case SCSI_STATUS_ACA_ACTIVE:
87 case SCSI_STATUS_TASK_ABORTED:
88 return("Task Aborted");
90 static char unkstr[64];
91 snprintf(unkstr, sizeof(unkstr), "Unknown %#x",
99 * scsi_command_string() returns 0 for success and -1 for failure.
102 ctl_scsi_command_string(struct ctl_scsiio *ctsio,
103 struct scsi_inquiry_data *inq_data, struct sbuf *sb)
105 char cdb_str[(SCSI_MAX_CDBLEN * 3) + 1];
107 sbuf_printf(sb, "%s. CDB: %s",
108 scsi_op_desc(ctsio->cdb[0], inq_data),
109 scsi_cdb_string(ctsio->cdb, cdb_str, sizeof(cdb_str)));
115 ctl_scsi_path_string(union ctl_io *io, char *path_str, int len)
118 snprintf(path_str, len, "(%u:%u:%u/%u): ",
119 io->io_hdr.nexus.initid, io->io_hdr.nexus.targ_port,
120 io->io_hdr.nexus.targ_lun, io->io_hdr.nexus.targ_mapped_lun);
124 * ctl_scsi_sense_sbuf() returns 0 for success and -1 for failure.
127 ctl_scsi_sense_sbuf(struct ctl_scsiio *ctsio,
128 struct scsi_inquiry_data *inq_data, struct sbuf *sb,
129 scsi_sense_string_flags flags)
133 if ((ctsio == NULL) || (sb == NULL))
136 ctl_scsi_path_string((union ctl_io *)ctsio, path_str, sizeof(path_str));
138 if (flags & SSS_FLAG_PRINT_COMMAND) {
140 sbuf_cat(sb, path_str);
142 ctl_scsi_command_string(ctsio, inq_data, sb);
144 sbuf_printf(sb, "\n");
147 scsi_sense_only_sbuf(&ctsio->sense_data, ctsio->sense_len, sb,
148 path_str, inq_data, ctsio->cdb, ctsio->cdb_len);
154 ctl_scsi_sense_string(struct ctl_scsiio *ctsio,
155 struct scsi_inquiry_data *inq_data, char *str,
160 sbuf_new(&sb, str, str_len, 0);
162 ctl_scsi_sense_sbuf(ctsio, inq_data, &sb, SSS_FLAG_PRINT_COMMAND);
166 return(sbuf_data(&sb));
171 ctl_scsi_sense_print(struct ctl_scsiio *ctsio,
172 struct scsi_inquiry_data *inq_data)
177 sbuf_new(&sb, str, sizeof(str), 0);
179 ctl_scsi_sense_sbuf(ctsio, inq_data, &sb, SSS_FLAG_PRINT_COMMAND);
183 printf("%s", sbuf_data(&sb));
188 ctl_scsi_sense_print(struct ctl_scsiio *ctsio,
189 struct scsi_inquiry_data *inq_data, FILE *ofile)
194 if ((ctsio == NULL) || (ofile == NULL))
197 sbuf_new(&sb, str, sizeof(str), 0);
199 ctl_scsi_sense_sbuf(ctsio, inq_data, &sb, SSS_FLAG_PRINT_COMMAND);
203 fprintf(ofile, "%s", sbuf_data(&sb));