xref: /netbsd-src/sys/dev/scsipi/scsiconf.c (revision 1f2744e6e4915c9da2a3f980279398c4cf7d5e6d)
1 /*	$NetBSD: scsiconf.c,v 1.27 1995/02/22 19:32:33 mycroft Exp $	*/
2 
3 /*
4  * Copyright (c) 1994 Charles Hannum.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *	This product includes software developed by Charles Hannum.
17  * 4. The name of the author may not be used to endorse or promote products
18  *    derived from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * Originally written by Julian Elischer (julian@tfs.com)
34  * for TRW Financial Systems for use under the MACH(2.5) operating system.
35  *
36  * TRW Financial Systems, in accordance with their agreement with Carnegie
37  * Mellon University, makes this software available to CMU to distribute
38  * or use in any manner that they see fit as long as this message is kept with
39  * the software. For this reason TFS also grants any other persons or
40  * organisations permission to use or modify this software.
41  *
42  * TFS supplies this software to be publicly redistributed
43  * on the understanding that TFS is not responsible for the correct
44  * functioning of this software in any circumstances.
45  *
46  * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
47  */
48 
49 #include <sys/types.h>
50 #include <sys/param.h>
51 #include <sys/systm.h>
52 #include <sys/malloc.h>
53 #include <sys/device.h>
54 
55 #include <scsi/scsi_all.h>
56 #include <scsi/scsiconf.h>
57 
58 #if 0
59 #if NCALS > 0
60 	{ T_PROCESSOR, T_FIXED, 1,
61 	  0, 0, 0 },
62 #endif	/* NCALS */
63 #if NBLL > 0
64 	{ T_PROCESSOR, T_FIXED, 1,
65 	  "AEG     ", "READER          ", "V1.0" },
66 #endif	/* NBLL */
67 #if NKIL > 0
68 	{ T_SCANNER, T_FIXED, 0,
69 	  "KODAK   ", "IL Scanner 900  ", 0 },
70 #endif	/* NKIL */
71 #endif
72 
73 /*
74  * Declarations
75  */
76 void scsi_probedev __P((struct scsibus_softc *, int, int));
77 int scsi_probe_bus __P((int bus, int target, int lun));
78 
79 struct scsi_device probe_switch = {
80 	NULL,
81 	NULL,
82 	NULL,
83 	NULL,
84 };
85 
86 int scsibusmatch __P((struct device *, void *, void *));
87 void scsibusattach __P((struct device *, struct device *, void *));
88 
89 struct cfdriver scsibuscd = {
90 	NULL, "scsibus", scsibusmatch, scsibusattach, DV_DULL,
91 	sizeof(struct scsibus_softc)
92 };
93 
94 int
95 scsibusmatch(parent, match, aux)
96         struct device *parent;
97         void *match, *aux;
98 {
99 
100 	return 1;
101 }
102 
103 /*
104  * The routine called by the adapter boards to get all their
105  * devices configured in.
106  */
107 void
108 scsibusattach(parent, self, aux)
109         struct device *parent, *self;
110         void *aux;
111 {
112 	struct scsibus_softc *sb = (struct scsibus_softc *)self;
113 	struct scsi_link *sc_link_proto = aux;
114 
115 	sc_link_proto->scsibus = sb->sc_dev.dv_unit;
116 	sb->adapter_link = sc_link_proto;
117 	printf("\n");
118 
119 #if defined(SCSI_DELAY) && SCSI_DELAY > 2
120 	printf("%s: waiting for scsi devices to settle\n",
121 		sb->sc_dev.dv_xname);
122 #else	/* SCSI_DELAY > 2 */
123 #undef	SCSI_DELAY
124 #define SCSI_DELAY 2
125 #endif	/* SCSI_DELAY */
126 	delay(1000000 * SCSI_DELAY);
127 
128 	scsi_probe_bus(sb->sc_dev.dv_unit, -1, -1);
129 }
130 
131 int
132 scsibussubmatch(parent, match, aux)
133 	struct device *parent;
134 	void *match, *aux;
135 {
136 	struct cfdata *cf = match;
137 	struct scsibus_attach_args *sa = aux;
138 	struct scsi_link *sc_link = sa->sa_sc_link;
139 
140 	if (cf->cf_loc[0] != -1 && cf->cf_loc[0] != sc_link->target)
141 		return 0;
142 	if (cf->cf_loc[1] != -1 && cf->cf_loc[1] != sc_link->lun)
143 		return 0;
144 	return ((*cf->cf_driver->cd_match)(parent, match, aux));
145 }
146 
147 /*
148  * Probe the requested scsi bus. It must be already set up.
149  * -1 requests all set up scsi busses.
150  * target and lun optionally narrow the search if not -1
151  */
152 int
153 scsi_probe_busses(bus, target, lun)
154 	int bus, target, lun;
155 {
156 
157 	if (bus == -1) {
158 		for (bus = 0; bus < scsibuscd.cd_ndevs; bus++)
159 			if (scsibuscd.cd_devs[bus])
160 				scsi_probe_bus(bus, target, lun);
161 		return 0;
162 	} else {
163 		return scsi_probe_bus(bus, target, lun);
164 	}
165 }
166 
167 /*
168  * Probe the requested scsi bus. It must be already set up.
169  * target and lun optionally narrow the search if not -1
170  */
171 int
172 scsi_probe_bus(bus, target, lun)
173 	int bus, target, lun;
174 {
175 	struct scsibus_softc *scsi;
176 	int maxtarget, mintarget, maxlun, minlun;
177 	u_int8_t scsi_addr;
178 
179 	if (bus < 0 || bus >= scsibuscd.cd_ndevs)
180 		return ENXIO;
181 	scsi = scsibuscd.cd_devs[bus];
182 	if (!scsi)
183 		return ENXIO;
184 
185 	scsi_addr = scsi->adapter_link->adapter_target;
186 
187 	if (target == -1) {
188 		maxtarget = 7;
189 		mintarget = 0;
190 	} else {
191 		if (target < 0 || target > 7)
192 			return EINVAL;
193 		maxtarget = mintarget = target;
194 	}
195 
196 	if (lun == -1) {
197 		maxlun = 7;
198 		minlun = 0;
199 	} else {
200 		if (lun < 0 || lun > 7)
201 			return EINVAL;
202 		maxlun = minlun = lun;
203 	}
204 
205 	for (target = mintarget; target <= maxtarget; target++) {
206 		if (target == scsi_addr)
207 			continue;
208 		for (lun = minlun; lun <= maxlun; lun++) {
209 			/*
210 			 * See if there's a device present, and configure it.
211 			 */
212 			scsi_probedev(scsi, target, lun);
213 			if ((scsi->moreluns & (1 << target)) == 0)
214 				break;
215 			/* otherwise something says we should look further */
216 		}
217 	}
218 	return 0;
219 }
220 
221 void
222 scsi_strvis(dst, src, len)
223 	u_char *dst, *src;
224 	int len;
225 {
226 
227 	/* Trim leading and trailing blanks. */
228 	while (len > 0 && src[0] == ' ')
229 		++src, --len;
230 	while (len > 0 && src[len-1] == ' ')
231 		--len;
232 
233 	while (len > 0) {
234 		if (*src < 0x20 || *src >= 0x80) {
235 			/* non-printable characters */
236 			*dst++ = '\\';
237 			*dst++ = ((*src & 0300) >> 6) + '0';
238 			*dst++ = ((*src & 0070) >> 3) + '0';
239 			*dst++ = ((*src & 0007) >> 0) + '0';
240 		} else if (*src == '\\') {
241 			/* quote characters */
242 			*dst++ = '\\';
243 			*dst++ = '\\';
244 		} else {
245 			/* normal characters */
246 			*dst++ = *src;
247 		}
248 		++src, --len;
249 	}
250 
251 	*dst++ = 0;
252 }
253 
254 struct scsi_quirk_inquiry_pattern {
255 	struct scsi_inquiry_pattern pattern;
256 	u_int8_t quirks;
257 };
258 
259 struct scsi_quirk_inquiry_pattern scsi_quirk_patterns[] = {
260 	{T_CDROM, T_REMOV,
261 	 "CHINON  ", "CD-ROM CDS-431  ", "H42",  SDEV_NOLUNS},
262 	{T_CDROM, T_REMOV,
263 	 "CHINON  ", "CD-ROM CDS-535  ", "Q14",  SDEV_NOLUNS},
264 	{T_CDROM, T_REMOV,
265 	 "DENON   ", "DRD-25X         ", "V",    SDEV_NOLUNS},
266 	{T_CDROM, T_REMOV,
267 	 "IMS     ", "CDD521/10       ", "2.06", SDEV_NOLUNS},
268 	{T_CDROM, T_REMOV,
269 	 "NEC     ", "CD-ROM DRIVE:83 ", "1.2 ", SDEV_NOLUNS},
270 	{T_CDROM, T_REMOV,
271 	 "NEC     ", "CD-ROM DRIVE:841", "1.0 ", SDEV_NOLUNS},
272 	{T_CDROM, T_REMOV,
273 	 "SONY    ", "CD-ROM CDU-541  ", "4.3d", SDEV_NOLUNS},
274 	{T_CDROM, T_REMOV,
275 	 "SONY    ", "CD-ROM CDU-55S  ", "1.0i", SDEV_NOLUNS},
276 	{T_CDROM, T_REMOV,
277 	 "TEAC    ", "CD-ROM          ", "1.06", SDEV_NOLUNS},
278 	{T_CDROM, T_REMOV,
279 	 "TEXEL   ", "CD-ROM          ", "1.06", SDEV_NOLUNS},
280 	{T_CDROM, T_REMOV,
281 	 "MEDIAVIS", "CDR-H93MV       ", "1.31", SDEV_NOLUNS},
282 
283 	{T_DIRECT, T_FIXED,
284 	 "MAXTOR  ", "XT-3280         ", "",     SDEV_NOLUNS},
285 	{T_DIRECT, T_FIXED,
286 	 "MAXTOR  ", "XT-4380S        ", "",     SDEV_NOLUNS},
287 	{T_DIRECT, T_FIXED,
288 	 "MAXTOR  ", "MXT-1240S       ", "",     SDEV_NOLUNS},
289 	{T_DIRECT, T_FIXED,
290 	 "MAXTOR  ", "XT-4170S        ", "",     SDEV_NOLUNS},
291 	{T_DIRECT, T_FIXED,
292 	 "MAXTOR  ", "XT-8760S        ", "",     SDEV_NOLUNS},
293 	{T_DIRECT, T_FIXED,
294 	 "MAXTOR  ", "LXT-213S SUN0207", "",     SDEV_NOLUNS},
295 	{T_DIRECT, T_FIXED,
296 	 "RODIME  ", "RO3000S         ", "2.33", SDEV_NOLUNS},
297 	{T_DIRECT, T_FIXED,
298 	 "SEAGATE ", "ST157N          ", "\004|j", SDEV_NOLUNS},
299 	{T_DIRECT, T_FIXED,
300 	 "SEAGATE ", "ST296           ", "921",  SDEV_NOLUNS},
301 	{T_DIRECT, T_FIXED,
302 	 "QUANTUM ", "LPS525S         ", "3110", SDEV_NOLUNS},
303 	{T_DIRECT, T_FIXED,
304 	 "QUANTUM ", "PD1225S         ", "3110", SDEV_NOLUNS},
305 
306 	{T_SEQUENTIAL, T_REMOV,
307 	 "EXABYTE ", "EXB-8200        ", "",     SDEV_NOLUNS},
308 	{T_SEQUENTIAL, T_REMOV,
309 	 "SONY    ", "SDT-2000        ", "2.09", SDEV_NOLUNS},
310 	{T_SEQUENTIAL, T_REMOV,
311 	 "TANDBERG", " TDC 3600       ", "",     SDEV_NOLUNS},
312 
313 	{T_SEQUENTIAL, T_REMOV,
314 	 "SONY    ", "SDT-5000        ", "3.17", SDEV_NOSYNCWIDE},
315 	{T_SEQUENTIAL, T_REMOV,
316 	 "WangDAT ", "Model 1300      ", "02.4", SDEV_NOSYNCWIDE},
317 	{T_SEQUENTIAL, T_REMOV,
318 	 "WangDAT ", "Model 2600      ", "01.7", SDEV_NOSYNCWIDE},
319 	{T_SEQUENTIAL, T_REMOV,
320 	 "WangDAT ", "Model 3200      ", "02.2", SDEV_NOSYNCWIDE},
321 };
322 
323 /*
324  * given a target and lu, ask the device what
325  * it is, and find the correct driver table
326  * entry.
327  */
328 void
329 scsi_probedev(scsi, target, lun)
330 	struct scsibus_softc *scsi;
331 	int target, lun;
332 {
333 	struct scsi_link *sc_link;
334 	static struct scsi_inquiry_data inqbuf;
335 	struct scsi_quirk_inquiry_pattern *finger;
336 	int priority;
337 	u_int8_t type;
338 	boolean removable;
339 	char *dtype, *qtype;
340 	char vendor[33], product[65], revision[17];
341 	struct scsibus_attach_args sa;
342 	struct cfdata *cf;
343 
344 	/* Skip this slot if it is already attached. */
345 	if (scsi->sc_link[target][lun])
346 		return;
347 
348 	sc_link = malloc(sizeof(*sc_link), M_DEVBUF, M_NOWAIT);
349 	*sc_link = *scsi->adapter_link;
350 	sc_link->target = target;
351 	sc_link->lun = lun;
352 	sc_link->device = &probe_switch;
353 
354 	/*
355 	 * Ask the device what it is
356 	 */
357 #ifdef SCSIDEBUG
358 	if (target == DEBUGTARGET && lun == DEBUGLUN)
359 		sc_link->flags |= DEBUGLEVEL;
360 #endif /* SCSIDEBUG */
361 
362 	(void) scsi_test_unit_ready(sc_link,
363 	    SCSI_AUTOCONF | SCSI_IGNORE_ILLEGAL_REQUEST | SCSI_IGNORE_NOT_READY | SCSI_IGNORE_MEDIA_CHANGE);
364 
365 #ifdef SCSI_2_DEF
366 	/* some devices need to be told to go to SCSI2 */
367 	/* However some just explode if you tell them this.. leave it out */
368 	scsi_change_def(sc_link, SCSI_AUTOCONF | SCSI_SILENT);
369 #endif /* SCSI_2_DEF */
370 
371 	/* Now go ask the device all about itself. */
372 	bzero(&inqbuf, sizeof(inqbuf));
373 	if (scsi_inquire(sc_link, &inqbuf, SCSI_AUTOCONF) != 0)
374 		goto bad;
375 
376 	{
377 		int len = inqbuf.additional_length;
378 		while (len < 3)
379 			inqbuf.unused[len++] = '\0';
380 		while (len < 3 + 28)
381 			inqbuf.unused[len++] = ' ';
382 	}
383 
384 	finger = (struct scsi_quirk_inquiry_pattern *)scsi_inqmatch(&inqbuf,
385 	    (caddr_t)scsi_quirk_patterns,
386 	    sizeof(scsi_quirk_patterns)/sizeof(scsi_quirk_patterns[0]),
387 	    sizeof(scsi_quirk_patterns[0]), &priority);
388 	if (priority != 0)
389 		sc_link->quirks |= finger->quirks;
390 	if ((inqbuf.version & SID_ANSII) == 0)
391 		sc_link->quirks |= SDEV_NOLUNS;
392 
393 	if ((sc_link->quirks & SDEV_NOLUNS) == 0)
394 		scsi->moreluns |= (1 << target);
395 
396 	/*
397 	 * note what BASIC type of device it is
398 	 */
399 	type = inqbuf.device & SID_TYPE;
400 	removable = inqbuf.dev_qual2 & SID_REMOVABLE ? 1 : 0;
401 
402 	if (removable)
403 		sc_link->flags |= SDEV_REMOVABLE;
404 
405 	/*
406 	 * Any device qualifier that has the top bit set (qualifier&4 != 0)
407 	 * is vendor specific and won't match in this switch.
408 	 */
409 	dtype = 0;
410 	switch (inqbuf.device & SID_QUAL) {
411 	case SID_QUAL_LU_OK:
412 		qtype = "";
413 		break;
414 
415 	case SID_QUAL_LU_OFFLINE:
416 		qtype = " offline";
417 		break;
418 
419 	case SID_QUAL_RSVD:
420 	case SID_QUAL_BAD_LU:
421 		goto bad;
422 
423 	default:
424 		qtype = "";
425 		dtype = "vendor-unique";
426 		break;
427 	}
428 	if (dtype == 0) {
429 		switch (type) {
430 		case T_DIRECT:
431 			dtype = "direct";
432 			break;
433 		case T_SEQUENTIAL:
434 			dtype = "sequential";
435 			break;
436 		case T_PRINTER:
437 			dtype = "printer";
438 			break;
439 		case T_PROCESSOR:
440 			dtype = "processor";
441 			break;
442 		case T_CDROM:
443 			dtype = "cdrom";
444 			break;
445 		case T_WORM:
446 			dtype = "worm";
447 			break;
448 		case T_SCANNER:
449 			dtype = "scanner";
450 			break;
451 		case T_OPTICAL:
452 			dtype = "optical";
453 			break;
454 		case T_CHANGER:
455 			dtype = "changer";
456 			break;
457 		case T_COMM:
458 			dtype = "communication";
459 			break;
460 		case T_NODEVICE:
461 			goto bad;
462 		default:
463 			dtype = "unknown";
464 			break;
465 		}
466 	}
467 
468 	scsi_strvis(vendor, inqbuf.vendor, 8);
469 	scsi_strvis(product, inqbuf.product, 16);
470 	scsi_strvis(revision, inqbuf.revision, 4);
471 
472 	printf("%s targ %d lun %d: <%s, %s, %s> SCSI%d %d/%s %s%s\n",
473 	    ((struct device *)sc_link->adapter_softc)->dv_xname,
474 	    target, lun, vendor, product, revision,
475 	    inqbuf.version & SID_ANSII, type, dtype,
476 	    removable ? "removable" : "fixed", qtype);
477 
478 	sa.sa_sc_link = sc_link;
479 	sa.sa_inqbuf = &inqbuf;
480 
481 	if ((cf = config_search(scsibussubmatch, (struct device *)scsi, &sa)) != 0) {
482 		config_attach((struct device *)scsi, cf, &sa, NULL);
483 		scsi->sc_link[target][lun] = sc_link;
484 	} else
485 		goto bad;
486 
487 	return;
488 
489 bad:
490 	free(sc_link, M_DEVBUF);
491 	return;
492 }
493 
494 /*
495  * Return a priority based on how much of the inquiry data matches
496  * the patterns for the particular driver.
497  */
498 caddr_t
499 scsi_inqmatch(inqbuf, base, nmatches, matchsize, bestpriority)
500 	struct scsi_inquiry_data *inqbuf;
501 	caddr_t base;
502 	int nmatches, matchsize;
503 	int *bestpriority;
504 {
505 	u_int8_t type;
506 	boolean removable;
507 	caddr_t bestmatch;
508 
509 	/* Include the qualifier to catch vendor-unique types. */
510 	type = inqbuf->device;
511 	removable = inqbuf->dev_qual2 & SID_REMOVABLE ? T_REMOV : T_FIXED;
512 
513 	for (*bestpriority = 0, bestmatch = 0; nmatches--; base += matchsize) {
514 		struct scsi_inquiry_pattern *match = (void *)base;
515 		int priority, len;
516 
517 		if (type != match->type)
518 			continue;
519 		if (removable != match->removable)
520 			continue;
521 		priority = 2;
522 		len = strlen(match->vendor);
523 		if (bcmp(inqbuf->vendor, match->vendor, len))
524 			continue;
525 		priority += len;
526 		len = strlen(match->product);
527 		if (bcmp(inqbuf->product, match->product, len))
528 			continue;
529 		priority += len;
530 		len = strlen(match->revision);
531 		if (bcmp(inqbuf->revision, match->revision, len))
532 			continue;
533 		priority += len;
534 
535 #if 0
536 		printf("scsi_inqmatch: %d/%d/%d <%s, %s, %s>\n",
537 		    priority, match->type, match->removable,
538 		    match->vendor, match->product, match->revision);
539 #endif
540 		if (priority > *bestpriority) {
541 			*bestpriority = priority;
542 			bestmatch = base;
543 		}
544 	}
545 
546 	return (bestmatch);
547 }
548