1 /* $NetBSD: scsipiconf.c,v 1.38 2010/06/07 01:41:39 pgoyette Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 1999, 2004 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; by 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 * Originally written by Julian Elischer (julian@tfs.com) 35 * for TRW Financial Systems for use under the MACH(2.5) operating system. 36 * 37 * TRW Financial Systems, in accordance with their agreement with Carnegie 38 * Mellon University, makes this software available to CMU to distribute 39 * or use in any manner that they see fit as long as this message is kept with 40 * the software. For this reason TFS also grants any other persons or 41 * organisations permission to use or modify this software. 42 * 43 * TFS supplies this software to be publicly redistributed 44 * on the understanding that TFS is not responsible for the correct 45 * functioning of this software in any circumstances. 46 * 47 * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992 48 */ 49 50 #include <sys/cdefs.h> 51 __KERNEL_RCSID(0, "$NetBSD: scsipiconf.c,v 1.38 2010/06/07 01:41:39 pgoyette Exp $"); 52 53 #include <sys/param.h> 54 #include <sys/systm.h> 55 #include <sys/malloc.h> 56 #include <sys/module.h> 57 #include <sys/device.h> 58 #include <sys/proc.h> 59 60 #include <dev/scsipi/scsipi_all.h> 61 #include <dev/scsipi/scsipiconf.h> 62 #include <dev/scsipi/scsipi_base.h> 63 64 #define STRVIS_ISWHITE(x) ((x) == ' ' || (x) == '\0' || (x) == (u_char)'\377') 65 66 /* Function pointers and stub routines for scsiverbose module */ 67 int (*scsipi_print_sense)(struct scsipi_xfer *, int) = scsipi_print_sense_stub; 68 void (*scsipi_print_sense_data)(struct scsi_sense_data *, int) = 69 scsipi_print_sense_data_stub; 70 71 int scsi_verbose_loaded = 0; 72 73 int scsipi_print_sense_stub(struct scsipi_xfer * xs, int verbosity) 74 { 75 scsipi_load_verbose(); 76 if (scsi_verbose_loaded) 77 return scsipi_print_sense(xs, verbosity); 78 else 79 return 0; 80 } 81 82 void scsipi_print_sense_data_stub(struct scsi_sense_data *sense, int verbosity) 83 { 84 scsipi_load_verbose(); 85 if (scsi_verbose_loaded) 86 scsipi_print_sense_data(sense, verbosity); 87 } 88 89 int 90 scsipi_command(struct scsipi_periph *periph, struct scsipi_generic *cmd, 91 int cmdlen, u_char *data_addr, int datalen, int retries, int timeout, 92 struct buf *bp, int flags) 93 { 94 struct scsipi_xfer *xs; 95 96 xs = scsipi_make_xs(periph, cmd, cmdlen, data_addr, datalen, retries, 97 timeout, bp, flags); 98 if (!xs) 99 return (ENOMEM); 100 101 return (scsipi_execute_xs(xs)); 102 } 103 104 /* 105 * Load the scsiverbose module 106 */ 107 void 108 scsipi_load_verbose(void) 109 { 110 if (scsi_verbose_loaded) 111 return; 112 113 mutex_enter(&module_lock); 114 if (module_autoload("scsiverbose", MODULE_CLASS_MISC) == 0) 115 scsi_verbose_loaded++; 116 mutex_exit(&module_lock); 117 } 118 119 /* 120 * allocate and init a scsipi_periph structure for a new device. 121 */ 122 struct scsipi_periph * 123 scsipi_alloc_periph(int malloc_flag) 124 { 125 struct scsipi_periph *periph; 126 u_int i; 127 128 periph = malloc(sizeof(*periph), M_DEVBUF, malloc_flag|M_ZERO); 129 if (periph == NULL) 130 return NULL; 131 132 periph->periph_dev = NULL; 133 134 /* 135 * Start with one command opening. The periph driver 136 * will grow this if it knows it can take advantage of it. 137 */ 138 periph->periph_openings = 1; 139 periph->periph_active = 0; 140 141 for (i = 0; i < PERIPH_NTAGWORDS; i++) 142 periph->periph_freetags[i] = 0xffffffff; 143 144 TAILQ_INIT(&periph->periph_xferq); 145 callout_init(&periph->periph_callout, 0); 146 147 return periph; 148 } 149 150 /* 151 * Return a priority based on how much of the inquiry data matches 152 * the patterns for the particular driver. 153 */ 154 const void * 155 scsipi_inqmatch(struct scsipi_inquiry_pattern *inqbuf, const void *base, 156 size_t nmatches, size_t matchsize, int *bestpriority) 157 { 158 u_int8_t type; 159 const struct scsipi_inquiry_pattern *bestmatch; 160 161 /* Include the qualifier to catch vendor-unique types. */ 162 type = inqbuf->type; 163 164 for (*bestpriority = 0, bestmatch = 0; nmatches--; 165 base = (const char *)base + matchsize) { 166 const struct scsipi_inquiry_pattern *match = base; 167 int priority, len; 168 169 if (type != match->type) 170 continue; 171 if (inqbuf->removable != match->removable) 172 continue; 173 priority = 2; 174 len = strlen(match->vendor); 175 if (memcmp(inqbuf->vendor, match->vendor, len)) 176 continue; 177 priority += len; 178 len = strlen(match->product); 179 if (memcmp(inqbuf->product, match->product, len)) 180 continue; 181 priority += len; 182 len = strlen(match->revision); 183 if (memcmp(inqbuf->revision, match->revision, len)) 184 continue; 185 priority += len; 186 187 #ifdef SCSIPI_DEBUG 188 printf("scsipi_inqmatch: %d/%d/%d <%s, %s, %s>\n", 189 priority, match->type, match->removable, 190 match->vendor, match->product, match->revision); 191 #endif 192 if (priority > *bestpriority) { 193 *bestpriority = priority; 194 bestmatch = base; 195 } 196 } 197 198 return (bestmatch); 199 } 200 201 const char * 202 scsipi_dtype(int type) 203 { 204 const char *dtype; 205 206 switch (type) { 207 case T_DIRECT: 208 dtype = "disk"; 209 break; 210 case T_SEQUENTIAL: 211 dtype = "tape"; 212 break; 213 case T_PRINTER: 214 dtype = "printer"; 215 break; 216 case T_PROCESSOR: 217 dtype = "processor"; 218 break; 219 case T_WORM: 220 dtype = "worm"; 221 break; 222 case T_CDROM: 223 dtype = "cdrom"; 224 break; 225 case T_SCANNER: 226 dtype = "scanner"; 227 break; 228 case T_OPTICAL: 229 dtype = "optical"; 230 break; 231 case T_CHANGER: 232 dtype = "changer"; 233 break; 234 case T_COMM: 235 dtype = "communication"; 236 break; 237 case T_IT8_1: 238 case T_IT8_2: 239 dtype = "graphic arts pre-press"; 240 break; 241 case T_STORARRAY: 242 dtype = "storage array"; 243 break; 244 case T_ENCLOSURE: 245 dtype = "enclosure services"; 246 break; 247 case T_SIMPLE_DIRECT: 248 dtype = "simplified direct"; 249 break; 250 case T_OPTIC_CARD_RW: 251 dtype = "optical card r/w"; 252 break; 253 case T_OBJECT_STORED: 254 dtype = "object-based storage"; 255 break; 256 case T_NODEVICE: 257 panic("scsipi_dtype: impossible device type"); 258 default: 259 dtype = "unknown"; 260 break; 261 } 262 return (dtype); 263 } 264 265 void 266 scsipi_strvis(u_char *dst, int dlen, const u_char *src, int slen) 267 { 268 269 /* Trim leading and trailing blanks and NULs. */ 270 while (slen > 0 && STRVIS_ISWHITE(src[0])) 271 ++src, --slen; 272 while (slen > 0 && STRVIS_ISWHITE(src[slen - 1])) 273 --slen; 274 275 while (slen > 0) { 276 if (*src < 0x20 || *src >= 0x80) { 277 /* non-printable characters */ 278 dlen -= 4; 279 if (dlen < 1) 280 break; 281 *dst++ = '\\'; 282 *dst++ = ((*src & 0300) >> 6) + '0'; 283 *dst++ = ((*src & 0070) >> 3) + '0'; 284 *dst++ = ((*src & 0007) >> 0) + '0'; 285 } else if (*src == '\\') { 286 /* quote characters */ 287 dlen -= 2; 288 if (dlen < 1) 289 break; 290 *dst++ = '\\'; 291 *dst++ = '\\'; 292 } else { 293 /* normal characters */ 294 if (--dlen < 1) 295 break; 296 *dst++ = *src; 297 } 298 ++src, --slen; 299 } 300 301 *dst++ = 0; 302 } 303