camlib.c revision 158171
1236769Sobrien/*
2236769Sobrien * Copyright (c) 1997, 1998, 1999, 2002 Kenneth D. Merry.
3236769Sobrien * All rights reserved.
4236769Sobrien *
5236769Sobrien * Redistribution and use in source and binary forms, with or without
6236769Sobrien * modification, are permitted provided that the following conditions
7236769Sobrien * are met:
8236769Sobrien * 1. Redistributions of source code must retain the above copyright
9236769Sobrien *    notice, this list of conditions and the following disclaimer.
10236769Sobrien * 2. The name of the author may not be used to endorse or promote products
11236769Sobrien *    derived from this software without specific prior written permission.
12236769Sobrien *
13236769Sobrien * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14236769Sobrien * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15236769Sobrien * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16236769Sobrien * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17236769Sobrien * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18236769Sobrien * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19236769Sobrien * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20236769Sobrien * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21236769Sobrien * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22236769Sobrien * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23236769Sobrien * SUCH DAMAGE.
24236769Sobrien */
25236769Sobrien
26236769Sobrien#include <sys/cdefs.h>
27236769Sobrien__FBSDID("$FreeBSD: head/lib/libcam/camlib.c 158171 2006-04-30 07:08:43Z marcus $");
28236769Sobrien
29236769Sobrien#include <sys/types.h>
30236769Sobrien#include <sys/param.h>
31236769Sobrien#include <stdio.h>
32236769Sobrien#include <stdlib.h>
33236769Sobrien#include <string.h>
34236769Sobrien#include <fcntl.h>
35236769Sobrien#include <unistd.h>
36236769Sobrien#include <errno.h>
37236769Sobrien#include <ctype.h>
38236769Sobrien
39236769Sobrien#include <cam/cam.h>
40236769Sobrien#include <cam/scsi/scsi_all.h>
41236769Sobrien#include <cam/cam_ccb.h>
42236769Sobrien#include <cam/scsi/scsi_pass.h>
43236769Sobrien#include "camlib.h"
44236769Sobrien
45236769Sobrienstruct cam_devequiv {
46236769Sobrien	char *given_dev;
47236769Sobrien	char *real_dev;
48236769Sobrien};
49236769Sobrien
50236769Sobrienstruct cam_devequiv devmatchtable[] = {
51236769Sobrien	{"sd", "da"},
52236769Sobrien	{"st", "sa"}
53236769Sobrien};
54236769Sobrien
55236769Sobrienchar cam_errbuf[CAM_ERRBUF_SIZE];
56236769Sobrien
57236769Sobrienstatic struct cam_device *cam_real_open_device(const char *path, int flags,
58236769Sobrien					       struct cam_device *device,
59236769Sobrien					       const char *given_path,
60236769Sobrien					       const char *given_dev_name,
61236769Sobrien					       int given_unit_number);
62236769Sobrienstatic struct cam_device *cam_lookup_pass(const char *dev_name, int unit,
63236769Sobrien					  int flags, const char *given_path,
64236769Sobrien					  struct cam_device *device);
65236769Sobrien
66236769Sobrien/*
67236769Sobrien * Send a ccb to a passthrough device.
68236769Sobrien */
69236769Sobrienint
70236769Sobriencam_send_ccb(struct cam_device *device, union ccb *ccb)
71236769Sobrien{
72236769Sobrien	return(ioctl(device->fd, CAMIOCOMMAND, ccb));
73236769Sobrien}
74236769Sobrien
75236769Sobrien/*
76236769Sobrien * Malloc a CCB, zero out the header and set its path, target and lun ids.
77236769Sobrien */
78236769Sobrienunion ccb *
79236769Sobriencam_getccb(struct cam_device *dev)
80{
81	union ccb *ccb;
82
83	ccb = (union ccb *)malloc(sizeof(union ccb));
84	if (ccb != NULL) {
85		bzero(&ccb->ccb_h, sizeof(struct ccb_hdr));
86		ccb->ccb_h.path_id = dev->path_id;
87		ccb->ccb_h.target_id = dev->target_id;
88		ccb->ccb_h.target_lun = dev->target_lun;
89	}
90
91	return(ccb);
92}
93
94/*
95 * Free a CCB.
96 */
97void
98cam_freeccb(union ccb *ccb)
99{
100	free(ccb);
101}
102
103/*
104 * Take a device name or path passed in by the user, and attempt to figure
105 * out the device name and unit number.  Some possible device name formats are:
106 * /dev/foo0a
107 * /dev/rfoo0a
108 * /dev/rfoos2c
109 * foo0
110 * foo0a
111 * rfoo0
112 * rfoo0a
113 * nrfoo0
114 *
115 * If the caller passes in an old style device name like 'sd' or 'st',
116 * it will be converted to the new style device name based upon devmatchtable
117 * above.
118 *
119 * Input parameters:  device name/path, length of devname string
120 * Output:            device name, unit number
121 * Return values:     returns 0 for success, -1 for failure
122 */
123int
124cam_get_device(const char *path, char *dev_name, int devnamelen, int *unit)
125{
126	char *func_name = "cam_get_device";
127	char *tmpstr, *tmpstr2;
128	char *newpath;
129	int unit_offset;
130	int i, found = 0;
131
132
133	if (path == NULL) {
134		sprintf(cam_errbuf, "%s: device pathname was NULL", func_name);
135		return(-1);
136	}
137
138	/*
139	 * We can be rather destructive to the path string.  Make a copy of
140	 * it so we don't hose the user's string.
141	 */
142	newpath = (char *)strdup(path);
143	tmpstr = newpath;
144
145	/* Get rid of any leading white space */
146	while (isspace(*tmpstr) && (*tmpstr != '\0'))
147		tmpstr++;
148
149	/*
150	 * Check to see whether we have an absolute pathname.
151	 */
152	if (*tmpstr == '/') {
153		tmpstr2 = tmpstr;
154		tmpstr = (char *)rindex(tmpstr2, '/');
155		if ((tmpstr != NULL) && (*tmpstr != '\0'))
156			tmpstr++;
157	}
158
159	if (*tmpstr == '\0') {
160		sprintf(cam_errbuf, "%s: no text after slash", func_name);
161		free(newpath);
162		return(-1);
163	}
164
165	/*
166	 * Check to see whether the user has given us a nonrewound tape
167	 * device.
168	 */
169	if (*tmpstr == 'n')
170		tmpstr++;
171
172	if (*tmpstr == '\0') {
173		sprintf(cam_errbuf, "%s: no text after leading 'n'", func_name);
174		free(newpath);
175		return(-1);
176	}
177
178	/*
179	 * See if the user has given us a character device.
180	 */
181	if (*tmpstr == 'r')
182		tmpstr++;
183
184	if (*tmpstr == '\0') {
185		sprintf(cam_errbuf, "%s: no text after leading 'r'", func_name);
186		free(newpath);
187		return(-1);
188	}
189
190	/*
191	 * Try to get rid of any trailing white space or partition letters.
192	 */
193	tmpstr2 = &tmpstr[strlen(tmpstr) - 1];
194
195	while ((*tmpstr2 != '\0') && (tmpstr2 > tmpstr) &&(!isdigit(*tmpstr2))){
196		*tmpstr2 = '\0';
197		tmpstr2--;
198	}
199
200	/*
201	 * Check to see whether we have been given a partition with a slice
202	 * name.  If so, get rid of the slice name/number.
203	 */
204	if (strlen(tmpstr) > 3) {
205		/*
206		 * Basically, we're looking for a string that ends in the
207		 * following general manner:  1s1 -- a number, the letter
208		 * s, and then another number.  This indicates that the
209		 * user has given us a slice.  We substitute nulls for the
210		 * s and the slice number.
211		 */
212		if ((isdigit(tmpstr[strlen(tmpstr) - 1]))
213		 && (tmpstr[strlen(tmpstr) - 2] == 's')
214		 && (isdigit(tmpstr[strlen(tmpstr) - 3]))) {
215			tmpstr[strlen(tmpstr) - 1] = '\0';
216			tmpstr[strlen(tmpstr) - 1] = '\0';
217		}
218	}
219
220	/*
221	 * After we nuke off the slice, we should have just a device name
222	 * and unit number.  That means there must be at least 2
223	 * characters.  If we only have 1, we don't have a valid device name.
224	 */
225	if (strlen(tmpstr) < 2) {
226		sprintf(cam_errbuf,
227			"%s: must have both device name and unit number",
228			func_name);
229		free(newpath);
230		return(-1);
231	}
232
233	/*
234	 * If the first character of the string is a digit, then the user
235	 * has probably given us all numbers.  Point out the error.
236	 */
237	if (isdigit(*tmpstr)) {
238		sprintf(cam_errbuf,
239			"%s: device name cannot begin with a number",
240			func_name);
241		free(newpath);
242		return(-1);
243	}
244
245	/*
246	 * At this point, if the last character of the string isn't a
247	 * number, we know the user either didn't give us a device number,
248	 * or he gave us a device name/number format we don't recognize.
249	 */
250	if (!isdigit(tmpstr[strlen(tmpstr) - 1])) {
251		sprintf(cam_errbuf, "%s: unable to find device unit number",
252			func_name);
253		free(newpath);
254		return(-1);
255	}
256
257	/*
258	 * Attempt to figure out where the device name ends and the unit
259	 * number begins.  As long as unit_offset is at least 1 less than
260	 * the length of the string, we can still potentially have a device
261	 * name at the front of the string.  When we get to something that
262	 * isn't a digit, we've hit the device name.  Because of the check
263	 * above, we know that this cannot happen when unit_offset == 1.
264	 * Therefore it is okay to decrement unit_offset -- it won't cause
265	 * us to go past the end of the character array.
266	 */
267	for (unit_offset = 1;
268	    (unit_offset < (strlen(tmpstr)))
269	    && (isdigit(tmpstr[strlen(tmpstr) - unit_offset])); unit_offset++);
270
271	unit_offset--;
272
273	/*
274	 * Grab the unit number.
275	 */
276	*unit = atoi(&tmpstr[strlen(tmpstr) - unit_offset]);
277
278	/*
279	 * Put a null in place of the first number of the unit number so
280	 * that all we have left is the device name.
281	 */
282	tmpstr[strlen(tmpstr) - unit_offset] = '\0';
283
284	/*
285	 * Look through our equivalency table and see if the device name
286	 * the user gave us is an old style device name.  If so, translate
287	 * it to the new style device name.
288	 */
289	for (i = 0;i < (sizeof(devmatchtable)/sizeof(struct cam_devequiv));i++){
290		if (strcmp(tmpstr, devmatchtable[i].given_dev) == 0) {
291			strlcpy(dev_name,devmatchtable[i].real_dev, devnamelen);
292			found = 1;
293			break;
294		}
295	}
296	if (found == 0)
297		strlcpy(dev_name, tmpstr, devnamelen);
298
299	/* Clean up allocated memory */
300	free(newpath);
301
302	return(0);
303
304}
305
306/*
307 * Backwards compatible wrapper for the real open routine.  This translates
308 * a pathname into a device name and unit number for use with the real open
309 * routine.
310 */
311struct cam_device *
312cam_open_device(const char *path, int flags)
313{
314	int unit;
315	char dev_name[DEV_IDLEN + 1];
316
317	/*
318	 * cam_get_device() has already put an error message in cam_errbuf,
319	 * so we don't need to.
320	 */
321	if (cam_get_device(path, dev_name, sizeof(dev_name), &unit) == -1)
322		return(NULL);
323
324	return(cam_lookup_pass(dev_name, unit, flags, path, NULL));
325}
326
327/*
328 * Open the passthrough device for a given bus, target and lun, if the
329 * passthrough device exists.
330 */
331struct cam_device *
332cam_open_btl(path_id_t path_id, target_id_t target_id, lun_id_t target_lun,
333	     int flags, struct cam_device *device)
334{
335	union ccb ccb;
336	struct periph_match_pattern *match_pat;
337	char *func_name = "cam_open_btl";
338	int fd, bufsize;
339
340	if ((fd = open(XPT_DEVICE, O_RDWR)) < 0) {
341		snprintf(cam_errbuf, CAM_ERRBUF_SIZE,
342			 "%s: couldn't open %s\n%s: %s", func_name, XPT_DEVICE,
343			 func_name, strerror(errno));
344		return(NULL);
345	}
346
347	bzero(&ccb, sizeof(union ccb));
348	ccb.ccb_h.func_code = XPT_DEV_MATCH;
349
350	/* Setup the result buffer */
351	bufsize = sizeof(struct dev_match_result);
352	ccb.cdm.match_buf_len = bufsize;
353	ccb.cdm.matches = (struct dev_match_result *)malloc(bufsize);
354	if (ccb.cdm.matches == NULL) {
355		snprintf(cam_errbuf, CAM_ERRBUF_SIZE,
356			 "%s: couldn't malloc match buffer", func_name);
357		close(fd);
358		return(NULL);
359	}
360	ccb.cdm.num_matches = 0;
361
362	/* Setup the pattern buffer */
363	ccb.cdm.num_patterns = 1;
364	ccb.cdm.pattern_buf_len = sizeof(struct dev_match_pattern);
365	ccb.cdm.patterns = (struct dev_match_pattern *)malloc(
366		sizeof(struct dev_match_pattern));
367	if (ccb.cdm.patterns == NULL) {
368		snprintf(cam_errbuf, CAM_ERRBUF_SIZE,
369			 "%s: couldn't malloc pattern buffer", func_name);
370		free(ccb.cdm.matches);
371		close(fd);
372		return(NULL);
373	}
374	ccb.cdm.patterns[0].type = DEV_MATCH_PERIPH;
375	match_pat = &ccb.cdm.patterns[0].pattern.periph_pattern;
376
377	/*
378	 * We're looking for the passthrough device associated with this
379	 * particular bus/target/lun.
380	 */
381	sprintf(match_pat->periph_name, "pass");
382	match_pat->path_id = path_id;
383	match_pat->target_id = target_id;
384	match_pat->target_lun = target_lun;
385	/* Now set the flags to indicate what we're looking for. */
386	match_pat->flags = PERIPH_MATCH_PATH | PERIPH_MATCH_TARGET |
387			   PERIPH_MATCH_LUN | PERIPH_MATCH_NAME;
388
389	if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
390		sprintf(cam_errbuf, "%s: CAMIOCOMMAND ioctl failed\n"
391			"%s: %s", func_name, func_name, strerror(errno));
392		goto btl_bailout;
393	}
394
395	/*
396	 * Check for an outright error.
397	 */
398	if ((ccb.ccb_h.status != CAM_REQ_CMP)
399	 || ((ccb.cdm.status != CAM_DEV_MATCH_LAST)
400	   && (ccb.cdm.status != CAM_DEV_MATCH_MORE))) {
401		sprintf(cam_errbuf, "%s: CAM error %#x, CDM error %d "
402			"returned from XPT_DEV_MATCH ccb", func_name,
403			ccb.ccb_h.status, ccb.cdm.status);
404		goto btl_bailout;
405	}
406
407	if (ccb.cdm.status == CAM_DEV_MATCH_MORE) {
408		sprintf(cam_errbuf, "%s: CDM reported more than one"
409			" passthrough device at %d:%d:%d!!\n",
410			func_name, path_id, target_id, target_lun);
411		goto btl_bailout;
412	}
413
414	if (ccb.cdm.num_matches == 0) {
415		sprintf(cam_errbuf, "%s: no passthrough device found at"
416			" %d:%d:%d", func_name, path_id, target_id,
417			target_lun);
418		goto btl_bailout;
419	}
420
421	switch(ccb.cdm.matches[0].type) {
422	case DEV_MATCH_PERIPH: {
423		int pass_unit;
424		char dev_path[256];
425		struct periph_match_result *periph_result;
426
427		periph_result = &ccb.cdm.matches[0].result.periph_result;
428		pass_unit = periph_result->unit_number;
429		free(ccb.cdm.matches);
430		free(ccb.cdm.patterns);
431		close(fd);
432		sprintf(dev_path, "/dev/pass%d", pass_unit);
433		return(cam_real_open_device(dev_path, flags, device, NULL,
434					    NULL, 0));
435		break; /* NOTREACHED */
436	}
437	default:
438		sprintf(cam_errbuf, "%s: asked for a peripheral match, but"
439			" got a bus or device match", func_name);
440		goto btl_bailout;
441		break; /* NOTREACHED */
442	}
443
444btl_bailout:
445	free(ccb.cdm.matches);
446	free(ccb.cdm.patterns);
447	close(fd);
448	return(NULL);
449}
450
451struct cam_device *
452cam_open_spec_device(const char *dev_name, int unit, int flags,
453		     struct cam_device *device)
454{
455	return(cam_lookup_pass(dev_name, unit, flags, NULL, device));
456}
457
458struct cam_device *
459cam_open_pass(const char *path, int flags, struct cam_device *device)
460{
461	return(cam_real_open_device(path, flags, device, path, NULL, 0));
462}
463
464static struct cam_device *
465cam_lookup_pass(const char *dev_name, int unit, int flags,
466		const char *given_path, struct cam_device *device)
467{
468	int fd;
469	union ccb ccb;
470	char dev_path[256];
471	char *func_name = "cam_lookup_pass";
472
473	/*
474	 * The flags argument above only applies to the actual passthrough
475	 * device open, not our open of the given device to find the
476	 * passthrough device.
477	 */
478	if ((fd = open(XPT_DEVICE, O_RDWR)) < 0) {
479		snprintf(cam_errbuf, CAM_ERRBUF_SIZE,
480			 "%s: couldn't open %s\n%s: %s", func_name, XPT_DEVICE,
481			 func_name, strerror(errno));
482		return(NULL);
483	}
484
485	/* This isn't strictly necessary for the GETPASSTHRU ioctl. */
486	ccb.ccb_h.func_code = XPT_GDEVLIST;
487
488	/* These two are necessary for the GETPASSTHRU ioctl to work. */
489	strlcpy(ccb.cgdl.periph_name, dev_name, sizeof(ccb.cgdl.periph_name));
490	ccb.cgdl.unit_number = unit;
491
492	/*
493	 * Attempt to get the passthrough device.  This ioctl will fail if
494	 * the device name is null, if the device doesn't exist, or if the
495	 * passthrough driver isn't in the kernel.
496	 */
497	if (ioctl(fd, CAMGETPASSTHRU, &ccb) == -1) {
498		char tmpstr[256];
499
500		/*
501		 * If we get ENOENT from the transport layer version of
502		 * the CAMGETPASSTHRU ioctl, it means one of two things:
503		 * either the device name/unit number passed in doesn't
504		 * exist, or the passthrough driver isn't in the kernel.
505		 */
506		if (errno == ENOENT) {
507			snprintf(tmpstr, sizeof(tmpstr),
508				 "\n%s: either the pass driver isn't in "
509				 "your kernel\n%s: or %s%d doesn't exist",
510				 func_name, func_name, dev_name, unit);
511		}
512		snprintf(cam_errbuf, sizeof(cam_errbuf),
513			 "%s: CAMGETPASSTHRU ioctl failed\n"
514			 "%s: %s%s", func_name, func_name, strerror(errno),
515			 (errno == ENOENT) ? tmpstr : "");
516
517		close(fd);
518		return(NULL);
519	}
520
521	close(fd);
522
523	/*
524	 * If the ioctl returned the right status, but we got an error back
525	 * in the ccb, that means that the kernel found the device the user
526	 * passed in, but was unable to find the passthrough device for
527	 * the device the user gave us.
528	 */
529	if (ccb.cgdl.status == CAM_GDEVLIST_ERROR) {
530		sprintf(cam_errbuf, "%s: device %s%d does not exist!",
531			func_name, dev_name, unit);
532		return(NULL);
533	}
534
535	sprintf(dev_path, "/dev/%s%d", ccb.cgdl.periph_name,
536		ccb.cgdl.unit_number);
537
538	return(cam_real_open_device(dev_path, flags, device, NULL,
539				    dev_name, unit));
540}
541
542/*
543 * Open a given device.  The path argument isn't strictly necessary, but it
544 * is copied into the cam_device structure as a convenience to the user.
545 */
546static struct cam_device *
547cam_real_open_device(const char *path, int flags, struct cam_device *device,
548		     const char *given_path, const char *given_dev_name,
549		     int given_unit_number)
550{
551	char *func_name = "cam_real_open_device";
552	union ccb ccb;
553	int fd = -1, malloced_device = 0;
554
555	/*
556	 * See if the user wants us to malloc a device for him.
557	 */
558	if (device == NULL) {
559		if ((device = (struct cam_device *)malloc(
560		     sizeof(struct cam_device))) == NULL) {
561			sprintf(cam_errbuf, "%s: device structure malloc"
562				" failed\n%s: %s", func_name, func_name,
563				strerror(errno));
564			return(NULL);
565		}
566		device->fd = -1;
567		malloced_device = 1;
568	}
569
570	/*
571	 * If the user passed in a path, save it for him.
572	 */
573	if (given_path != NULL)
574		strlcpy(device->device_path, given_path,
575			sizeof(device->device_path));
576	else
577		device->device_path[0] = '\0';
578
579	/*
580	 * If the user passed in a device name and unit number pair, save
581	 * those as well.
582	 */
583	if (given_dev_name != NULL)
584		strlcpy(device->given_dev_name, given_dev_name,
585			sizeof(device->given_dev_name));
586	else
587		device->given_dev_name[0] = '\0';
588	device->given_unit_number = given_unit_number;
589
590	if ((fd = open(path, flags)) < 0) {
591		snprintf(cam_errbuf, CAM_ERRBUF_SIZE,
592			 "%s: couldn't open passthrough device %s\n"
593			 "%s: %s", func_name, path, func_name,
594			 strerror(errno));
595		goto crod_bailout;
596	}
597
598	device->fd = fd;
599
600	bzero(&ccb, sizeof(union ccb));
601
602	/*
603	 * Unlike the transport layer version of the GETPASSTHRU ioctl,
604	 * we don't have to set any fields.
605	 */
606	ccb.ccb_h.func_code = XPT_GDEVLIST;
607
608	/*
609	 * We're only doing this to get some information on the device in
610	 * question.  Otherwise, we'd have to pass in yet another
611	 * parameter: the passthrough driver unit number.
612	 */
613	if (ioctl(fd, CAMGETPASSTHRU, &ccb) == -1) {
614		/*
615		 * At this point we know the passthrough device must exist
616		 * because we just opened it above.  The only way this
617		 * ioctl can fail is if the ccb size is wrong.
618		 */
619		sprintf(cam_errbuf, "%s: CAMGETPASSTHRU ioctl failed\n"
620			"%s: %s", func_name, func_name, strerror(errno));
621		goto crod_bailout;
622	}
623
624	/*
625	 * If the ioctl returned the right status, but we got an error back
626	 * in the ccb, that means that the kernel found the device the user
627	 * passed in, but was unable to find the passthrough device for
628	 * the device the user gave us.
629	 */
630	if (ccb.cgdl.status == CAM_GDEVLIST_ERROR) {
631		sprintf(cam_errbuf, "%s: passthrough device does not exist!",
632			func_name);
633		goto crod_bailout;
634	}
635
636	device->dev_unit_num = ccb.cgdl.unit_number;
637	strlcpy(device->device_name, ccb.cgdl.periph_name,
638		sizeof(device->device_name));
639	device->path_id = ccb.ccb_h.path_id;
640	device->target_id = ccb.ccb_h.target_id;
641	device->target_lun = ccb.ccb_h.target_lun;
642
643	ccb.ccb_h.func_code = XPT_PATH_INQ;
644	if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
645		sprintf(cam_errbuf, "%s: Path Inquiry CCB failed\n"
646			"%s: %s", func_name, func_name, strerror(errno));
647		goto crod_bailout;
648	}
649	strlcpy(device->sim_name, ccb.cpi.dev_name, sizeof(device->sim_name));
650	device->sim_unit_number = ccb.cpi.unit_number;
651	device->bus_id = ccb.cpi.bus_id;
652
653	/*
654	 * It doesn't really matter what is in the payload for a getdev
655	 * CCB, the kernel doesn't look at it.
656	 */
657	ccb.ccb_h.func_code = XPT_GDEV_TYPE;
658	if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
659		sprintf(cam_errbuf, "%s: Get Device Type CCB failed\n"
660			"%s: %s", func_name, func_name, strerror(errno));
661		goto crod_bailout;
662	}
663	device->pd_type = SID_TYPE(&ccb.cgd.inq_data);
664	bcopy(&ccb.cgd.inq_data, &device->inq_data,
665	      sizeof(struct scsi_inquiry_data));
666	device->serial_num_len = ccb.cgd.serial_num_len;
667	bcopy(&ccb.cgd.serial_num, &device->serial_num, device->serial_num_len);
668
669	/*
670	 * Zero the payload, the kernel does look at the flags.
671	 */
672	bzero(&(&ccb.ccb_h)[1], sizeof(struct ccb_trans_settings));
673
674	/*
675	 * Get transfer settings for this device.
676	 */
677	ccb.ccb_h.func_code = XPT_GET_TRAN_SETTINGS;
678
679	ccb.cts.flags = CCB_TRANS_CURRENT_SETTINGS;
680
681	if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
682		sprintf(cam_errbuf, "%s: Get Transfer Settings CCB failed\n"
683			"%s: %s", func_name, func_name, strerror(errno));
684		goto crod_bailout;
685	}
686	device->sync_period = ccb.cts.sync_period;
687	device->sync_offset = ccb.cts.sync_offset;
688	device->bus_width = ccb.cts.bus_width;
689
690	return(device);
691
692crod_bailout:
693
694	if (fd >= 0)
695		close(fd);
696
697	if (malloced_device)
698		free(device);
699
700	return(NULL);
701}
702
703void
704cam_close_device(struct cam_device *dev)
705{
706	if (dev == NULL)
707		return;
708
709	cam_close_spec_device(dev);
710
711	free(dev);
712}
713
714void
715cam_close_spec_device(struct cam_device *dev)
716{
717	if (dev == NULL)
718		return;
719
720	if (dev->fd >= 0)
721		close(dev->fd);
722}
723
724char *
725cam_path_string(struct cam_device *dev, char *str, int len)
726{
727	if (dev == NULL) {
728		snprintf(str, len, "No path");
729		return(str);
730	}
731
732	snprintf(str, len, "(%s%d:%s%d:%d:%d:%d): ",
733		 (dev->device_name[0] != '\0') ? dev->device_name : "pass",
734		 dev->dev_unit_num,
735		 (dev->sim_name[0] != '\0') ? dev->sim_name : "unknown",
736		 dev->sim_unit_number,
737		 dev->bus_id,
738		 dev->target_id,
739		 dev->target_lun);
740
741	return(str);
742}
743
744/*
745 * Malloc/duplicate a CAM device structure.
746 */
747struct cam_device *
748cam_device_dup(struct cam_device *device)
749{
750	char *func_name = "cam_device_dup";
751	struct cam_device *newdev;
752
753	if (device == NULL) {
754		sprintf(cam_errbuf, "%s: device is NULL", func_name);
755		return(NULL);
756	}
757
758	newdev = malloc(sizeof(struct cam_device));
759	if (newdev == NULL) {
760		snprintf(cam_errbuf, CAM_ERRBUF_SIZE,
761			"%s: couldn't malloc CAM device structure", func_name);
762		return(NULL);
763	}
764
765	bcopy(device, newdev, sizeof(struct cam_device));
766
767	return(newdev);
768}
769
770/*
771 * Copy a CAM device structure.
772 */
773void
774cam_device_copy(struct cam_device *src, struct cam_device *dst)
775{
776	char *func_name = "cam_device_copy";
777
778	if (src == NULL) {
779		sprintf(cam_errbuf, "%s: source device struct was NULL",
780			func_name);
781		return;
782	}
783
784	if (dst == NULL) {
785		sprintf(cam_errbuf, "%s: destination device struct was NULL",
786			func_name);
787		return;
788	}
789
790	bcopy(src, dst, sizeof(struct cam_device));
791
792}
793