ctl_scsi_all.c revision 273531 
1/*-
2 * Implementation of Utility functions for all SCSI device types.
3 *
4 * Copyright (c) 1997, 1998, 1999 Justin T. Gibbs.
5 * Copyright (c) 1997, 1998, 2003 Kenneth D. Merry.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
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.
16 *
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
27 * SUCH DAMAGE.
28 *
29 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_scsi_all.c#2 $
30 */
31
32#include <sys/param.h>
33
34__FBSDID("$FreeBSD: stable/10/sys/cam/ctl/ctl_scsi_all.c 273531 2014-10-23 07:36:33Z mav $");
35
36#include <sys/types.h>
37#ifdef _KERNEL
38#include <sys/systm.h>
39#include <sys/libkern.h>
40#include <sys/kernel.h>
41#include <sys/sysctl.h>
42#else
43#include <errno.h>
44#include <stdio.h>
45#include <stdlib.h>
46#include <string.h>
47#include <inttypes.h>
48#endif
49
50#include <cam/cam.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>
55
56#include <cam/ctl/ctl_io.h>
57#include <cam/ctl/ctl_scsi_all.h>
58#include <sys/sbuf.h>
59#ifndef _KERNEL
60#include <camlib.h>
61#endif
62
63const char *
64ctl_scsi_status_string(struct ctl_scsiio *ctsio)
65{
66	switch(ctsio->scsi_status) {
67	case SCSI_STATUS_OK:
68		return("OK");
69	case SCSI_STATUS_CHECK_COND:
70		return("Check Condition");
71	case SCSI_STATUS_BUSY:
72		return("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:
82		return("Queue Full");
83	case SCSI_STATUS_ACA_ACTIVE:
84		return("ACA Active");
85	case SCSI_STATUS_TASK_ABORTED:
86		return("Task Aborted");
87	default: {
88		static char unkstr[64];
89		snprintf(unkstr, sizeof(unkstr), "Unknown %#x",
90			 ctsio->scsi_status);
91		return(unkstr);
92	}
93	}
94}
95
96/*
97 * scsi_command_string() returns 0 for success and -1 for failure.
98 */
99int
100ctl_scsi_command_string(struct ctl_scsiio *ctsio,
101			struct scsi_inquiry_data *inq_data, struct sbuf *sb)
102{
103	char cdb_str[(SCSI_MAX_CDBLEN * 3) + 1];
104
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)));
108
109	return(0);
110}
111
112void
113ctl_scsi_path_string(union ctl_io *io, char *path_str, int len)
114{
115
116	snprintf(path_str, len, "(%u:%u:%u/%u): ",
117	    io->io_hdr.nexus.initid.id, io->io_hdr.nexus.targ_port,
118	    io->io_hdr.nexus.targ_lun, io->io_hdr.nexus.targ_mapped_lun);
119}
120
121/*
122 * ctl_scsi_sense_sbuf() returns 0 for success and -1 for failure.
123 */
124int
125ctl_scsi_sense_sbuf(struct ctl_scsiio *ctsio,
126		    struct scsi_inquiry_data *inq_data, struct sbuf *sb,
127		    scsi_sense_string_flags flags)
128{
129	char	  path_str[64];
130
131	if ((ctsio == NULL) || (sb == NULL))
132		return(-1);
133
134	ctl_scsi_path_string((union ctl_io *)ctsio, path_str, sizeof(path_str));
135
136	if (flags & SSS_FLAG_PRINT_COMMAND) {
137
138		sbuf_cat(sb, path_str);
139
140		ctl_scsi_command_string(ctsio, inq_data, sb);
141
142		sbuf_printf(sb, "\n");
143	}
144
145	scsi_sense_only_sbuf(&ctsio->sense_data, ctsio->sense_len, sb,
146			     path_str, inq_data, ctsio->cdb, ctsio->cdb_len);
147
148	return(0);
149}
150
151char *
152ctl_scsi_sense_string(struct ctl_scsiio *ctsio,
153		      struct scsi_inquiry_data *inq_data, char *str,
154		      int str_len)
155{
156	struct sbuf sb;
157
158	sbuf_new(&sb, str, str_len, 0);
159
160	ctl_scsi_sense_sbuf(ctsio, inq_data, &sb, SSS_FLAG_PRINT_COMMAND);
161
162	sbuf_finish(&sb);
163
164	return(sbuf_data(&sb));
165}
166
167#ifdef _KERNEL
168void
169ctl_scsi_sense_print(struct ctl_scsiio *ctsio,
170		     struct scsi_inquiry_data *inq_data)
171{
172	struct sbuf sb;
173	char str[512];
174
175	sbuf_new(&sb, str, sizeof(str), 0);
176
177	ctl_scsi_sense_sbuf(ctsio, inq_data, &sb, SSS_FLAG_PRINT_COMMAND);
178
179	sbuf_finish(&sb);
180
181	printf("%s", sbuf_data(&sb));
182}
183
184#else /* _KERNEL */
185void
186ctl_scsi_sense_print(struct ctl_scsiio *ctsio,
187		     struct scsi_inquiry_data *inq_data, FILE *ofile)
188{
189	struct sbuf sb;
190	char str[512];
191
192	if ((ctsio == NULL) || (ofile == NULL))
193		return;
194
195	sbuf_new(&sb, str, sizeof(str), 0);
196
197	ctl_scsi_sense_sbuf(ctsio, inq_data, &sb, SSS_FLAG_PRINT_COMMAND);
198
199	sbuf_finish(&sb);
200
201	fprintf(ofile, "%s", sbuf_data(&sb));
202}
203
204#endif /* _KERNEL */
205
206