xref: /netbsd-src/sbin/scsictl/scsi_subr.c (revision 68ceb367018f11095da42ffdf2909d0ff49fe6ab)
1 /*	$NetBSD: scsi_subr.c,v 1.14 2012/02/21 02:22:54 jakllsch Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Charles M. Hannum; Jason R. Thorpe of the Numerical Aerospace
9  * Simulation Facility, NASA Ames Research Center.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * SCSI support subroutines.
35  *
36  * XXX THESE SHOULD BE IN A LIBRARY!
37  */
38 #include <sys/cdefs.h>
39 
40 #ifndef lint
41 __RCSID("$NetBSD: scsi_subr.c,v 1.14 2012/02/21 02:22:54 jakllsch Exp $");
42 #endif
43 
44 
45 #include <sys/param.h>
46 #include <sys/ioctl.h>
47 #include <sys/scsiio.h>
48 #include <err.h>
49 #include <errno.h>
50 #include <stdio.h>
51 #include <stdlib.h>
52 #include <string.h>
53 #include <unistd.h>
54 
55 #include <dev/scsipi/scsi_spc.h>
56 
57 #include "extern.h"
58 
59 #define	STRVIS_ISWHITE(x) ((x) == ' ' || (x) == '\0' || (x) == (u_char)'\377')
60 
61 void
scsi_command(int fd,const void * cmd,size_t cmdlen,void * data,size_t datalen,int timeout,int flags)62 scsi_command(int fd, const void *cmd, size_t cmdlen,
63 	void *data, size_t datalen, int timeout, int flags)
64 {
65 	scsireq_t req;
66 
67 	memset(&req, 0, sizeof(req));
68 
69 	cmdlen = MIN(cmdlen, sizeof(req.cmd));
70 	memcpy(req.cmd, cmd, cmdlen);
71 	req.cmdlen = cmdlen;
72 	req.databuf = data;
73 	req.datalen = datalen;
74 	req.timeout = timeout;
75 	req.flags = flags;
76 	req.senselen = SENSEBUFLEN;
77 
78 	if (ioctl(fd, SCIOCCOMMAND, &req) == -1)
79 		err(1, "SCIOCCOMMAND");
80 
81 	if (req.retsts == SCCMD_OK)
82 		return;
83 
84 	/* Some problem; report it and exit. */
85 	if (req.retsts == SCCMD_TIMEOUT)
86 		fprintf(stderr, "%s: SCSI command timed out\n", dvname);
87 	else if (req.retsts == SCCMD_BUSY)
88 		fprintf(stderr, "%s: device is busy\n", dvname);
89 	else if (req.retsts == SCCMD_SENSE)
90 		scsi_print_sense(dvname, &req, 1);
91 	else
92 		fprintf(stderr, "%s: device had unknown status %x\n", dvname,
93 		    req.retsts);
94 
95 	exit(1);
96 }
97 
98 void
scsi_mode_sense(int fd,u_int8_t pgcode,u_int8_t pctl,void * buf,size_t len)99 scsi_mode_sense(int fd, u_int8_t pgcode, u_int8_t pctl, void *buf, size_t len)
100 {
101 	struct scsi_mode_sense_6 cmd;
102 
103 	memset(&cmd, 0, sizeof(cmd));
104 	memset(buf, 0, len);
105 
106 	cmd.opcode = SCSI_MODE_SENSE_6;
107 	cmd.page = pgcode | pctl;
108 	cmd.length = len;
109 
110 	scsi_command(fd, &cmd, sizeof(cmd), buf, len, 10000, SCCMD_READ);
111 }
112 
113 void
scsi_mode_select(int fd,u_int8_t byte2,void * buf,size_t len)114 scsi_mode_select(int fd, u_int8_t byte2, void *buf, size_t len)
115 {
116 	struct scsi_mode_select_6 cmd;
117 
118 	memset(&cmd, 0, sizeof(cmd));
119 
120 	cmd.opcode = SCSI_MODE_SELECT_6;
121 	cmd.byte2 = SMS_PF | byte2;
122 	cmd.length = len;
123 
124 	scsi_command(fd, &cmd, sizeof(cmd), buf, len, 10000, SCCMD_WRITE);
125 }
126 
127 void
scsi_request_sense(int fd,void * buf,size_t len)128 scsi_request_sense(int fd, void *buf, size_t len)
129 {
130 	struct scsi_request_sense cmd;
131 
132 	memset(&cmd, 0, sizeof(cmd));
133 	memset(buf, 0, len);
134 
135 	cmd.opcode = SCSI_REQUEST_SENSE;
136 	cmd.length = len;
137  	scsi_command(fd, &cmd, sizeof(cmd), buf, len, 10000, SCCMD_READ);
138 }
139 
140 void
scsi_strvis(char * sdst,size_t dlen,const char * ssrc,size_t slen)141 scsi_strvis(char *sdst, size_t dlen, const char *ssrc, size_t slen)
142 {
143 	u_char *dst = (u_char *)sdst;
144 	const u_char *src = (const u_char *)ssrc;
145 
146 	/* Trim leading and trailing blanks and NULs. */
147 	while (slen > 0 && STRVIS_ISWHITE(src[0]))
148 		++src, --slen;
149 	while (slen > 0 && STRVIS_ISWHITE(src[slen - 1]))
150 		--slen;
151 
152 	while (slen > 0) {
153 		if (*src < 0x20 || *src >= 0x80) {
154 			/* non-printable characters */
155 			dlen -= 4;
156 			if (dlen < 1)
157 				break;
158 			*dst++ = '\\';
159 			*dst++ = ((*src & 0300) >> 6) + '0';
160 			*dst++ = ((*src & 0070) >> 3) + '0';
161 			*dst++ = ((*src & 0007) >> 0) + '0';
162 		} else if (*src == '\\') {
163 			/* quote characters */
164 			dlen -= 2;
165 			if (dlen < 1)
166 				break;
167 			*dst++ = '\\';
168 			*dst++ = '\\';
169 		} else {
170 			/* normal characters */
171 			if (--dlen < 1)
172 				break;
173 			*dst++ = *src;
174 		}
175 		++src, --slen;
176 	}
177 
178 	*dst++ = 0;
179 }
180