camlib.c revision 79183
1/*
2 * Copyright (c) 1997, 1998, 1999 Kenneth D. Merry.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. The name of the author may not be used to endorse or promote products
11 *    derived from this software without specific prior written permission.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 * SUCH DAMAGE.
24 *
25 * $FreeBSD: head/lib/libcam/camlib.c 79183 2001-07-04 07:43:10Z mjacob $
26 */
27
28#include <sys/types.h>
29#include <sys/param.h>
30#include <stdio.h>
31#include <stdlib.h>
32#include <string.h>
33#include <fcntl.h>
34#include <unistd.h>
35#include <errno.h>
36#include <ctype.h>
37
38#include <cam/cam.h>
39#include <cam/scsi/scsi_all.h>
40#include <cam/cam_ccb.h>
41#include <cam/scsi/scsi_pass.h>
42#include "camlib.h"
43
44struct cam_devequiv {
45	char *given_dev;
46	char *real_dev;
47};
48
49struct cam_devequiv devmatchtable[] = {
50	{"sd", "da"},
51	{"st", "sa"}
52};
53
54char cam_errbuf[CAM_ERRBUF_SIZE];
55
56static struct cam_device *cam_real_open_device(const char *path, int flags,
57					       struct cam_device *device,
58					       const char *given_path,
59					       const char *given_dev_name,
60					       int given_unit_number);
61static struct cam_device *cam_lookup_pass(const char *dev_name, int unit,
62					  int flags, const char *given_path,
63					  struct cam_device *device);
64
65/*
66 * Send a ccb to a passthrough device.
67 */
68int
69cam_send_ccb(struct cam_device *device, union ccb *ccb)
70{
71	return(ioctl(device->fd, CAMIOCOMMAND, ccb));
72}
73
74/*
75 * Malloc a CCB, zero out the header and set its path, target and lun ids.
76 */
77union ccb *
78cam_getccb(struct cam_device *dev)
79{
80	union ccb *ccb;
81
82	ccb = (union ccb *)malloc(sizeof(union ccb));
83	if (ccb != NULL) {
84		bzero(&ccb->ccb_h, sizeof(struct ccb_hdr));
85		ccb->ccb_h.path_id = dev->path_id;
86		ccb->ccb_h.target_id = dev->target_id;
87		ccb->ccb_h.target_lun = dev->target_lun;
88	}
89
90	return(ccb);
91}
92
93/*
94 * Free a CCB.
95 */
96void
97cam_freeccb(union ccb *ccb)
98{
99	if (ccb != NULL)
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			strncpy(dev_name,devmatchtable[i].real_dev, devnamelen);
292			found = 1;
293			break;
294		}
295	}
296	if (found == 0)
297		strncpy(dev_name, tmpstr, devnamelen);
298
299	/* Make sure we pass back a null-terminated string */
300	dev_name[devnamelen - 1] = '\0';
301
302	/* Clean up allocated memory */
303	free(newpath);
304
305	return(0);
306
307}
308
309/*
310 * Backwards compatible wrapper for the real open routine.  This translates
311 * a pathname into a device name and unit number for use with the real open
312 * routine.
313 */
314struct cam_device *
315cam_open_device(const char *path, int flags)
316{
317	int unit;
318	char dev_name[DEV_IDLEN + 1];
319
320	/*
321	 * cam_get_device() has already put an error message in cam_errbuf,
322	 * so we don't need to.
323	 */
324	if (cam_get_device(path, dev_name, DEV_IDLEN + 1, &unit) == -1)
325		return(NULL);
326
327	return(cam_lookup_pass(dev_name, unit, flags, path, NULL));
328}
329
330/*
331 * Open the passthrough device for a given bus, target and lun, if the
332 * passthrough device exists.
333 */
334struct cam_device *
335cam_open_btl(path_id_t path_id, target_id_t target_id, lun_id_t target_lun,
336	     int flags, struct cam_device *device)
337{
338	union ccb ccb;
339	struct periph_match_pattern *match_pat;
340	char *func_name = "cam_open_btl";
341	int fd, bufsize;
342
343	if ((fd = open(XPT_DEVICE, O_RDWR)) < 0) {
344		snprintf(cam_errbuf, CAM_ERRBUF_SIZE,
345			 "%s: couldn't open %s\n%s: %s", func_name, XPT_DEVICE,
346			 func_name, strerror(errno));
347		return(NULL);
348	}
349
350	bzero(&ccb, sizeof(union ccb));
351	ccb.ccb_h.func_code = XPT_DEV_MATCH;
352
353	/* Setup the result buffer */
354	bufsize = sizeof(struct dev_match_result);
355	ccb.cdm.match_buf_len = bufsize;
356	ccb.cdm.matches = (struct dev_match_result *)malloc(bufsize);
357	if (ccb.cdm.matches == NULL) {
358		snprintf(cam_errbuf, CAM_ERRBUF_SIZE,
359			 "%s: couldn't malloc match buffer", func_name);
360		close(fd);
361		return(NULL);
362	}
363	ccb.cdm.num_matches = 0;
364
365	/* Setup the pattern buffer */
366	ccb.cdm.num_patterns = 1;
367	ccb.cdm.pattern_buf_len = sizeof(struct dev_match_pattern);
368	ccb.cdm.patterns = (struct dev_match_pattern *)malloc(
369		sizeof(struct dev_match_pattern));
370	if (ccb.cdm.patterns == NULL) {
371		snprintf(cam_errbuf, CAM_ERRBUF_SIZE,
372			 "%s: couldn't malloc pattern buffer", func_name);
373		free(ccb.cdm.matches);
374		close(fd);
375		return(NULL);
376	}
377	ccb.cdm.patterns[0].type = DEV_MATCH_PERIPH;
378	match_pat = &ccb.cdm.patterns[0].pattern.periph_pattern;
379
380	/*
381	 * We're looking for the passthrough device associated with this
382	 * particular bus/target/lun.
383	 */
384	sprintf(match_pat->periph_name, "pass");
385	match_pat->path_id = path_id;
386	match_pat->target_id = target_id;
387	match_pat->target_lun = target_lun;
388	/* Now set the flags to indicate what we're looking for. */
389	match_pat->flags = PERIPH_MATCH_PATH | PERIPH_MATCH_TARGET |
390			   PERIPH_MATCH_LUN | PERIPH_MATCH_NAME;
391
392	if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
393		sprintf(cam_errbuf, "%s: CAMIOCOMMAND ioctl failed\n"
394			"%s: %s", func_name, func_name, strerror(errno));
395		goto btl_bailout;
396	}
397
398	/*
399	 * Check for an outright error.
400	 */
401	if ((ccb.ccb_h.status != CAM_REQ_CMP)
402	 || ((ccb.cdm.status != CAM_DEV_MATCH_LAST)
403	   && (ccb.cdm.status != CAM_DEV_MATCH_MORE))) {
404		sprintf(cam_errbuf, "%s: CAM error %#x, CDM error %d "
405			"returned from XPT_DEV_MATCH ccb", func_name,
406			ccb.ccb_h.status, ccb.cdm.status);
407		goto btl_bailout;
408	}
409
410	if (ccb.cdm.status == CAM_DEV_MATCH_MORE) {
411		sprintf(cam_errbuf, "%s: CDM reported more than one"
412			" passthrough device at %d:%d:%d!!\n",
413			func_name, path_id, target_id, target_lun);
414		goto btl_bailout;
415	}
416
417	if (ccb.cdm.num_matches == 0) {
418		sprintf(cam_errbuf, "%s: no passthrough device found at"
419			" %d:%d:%d", func_name, path_id, target_id,
420			target_lun);
421		goto btl_bailout;
422	}
423
424	switch(ccb.cdm.matches[0].type) {
425	case DEV_MATCH_PERIPH: {
426		int pass_unit;
427		char dev_path[256];
428		struct periph_match_result *periph_result;
429
430		periph_result = &ccb.cdm.matches[0].result.periph_result;
431		pass_unit = periph_result->unit_number;
432		free(ccb.cdm.matches);
433		free(ccb.cdm.patterns);
434		close(fd);
435		sprintf(dev_path, "/dev/pass%d", pass_unit);
436		return(cam_real_open_device(dev_path, flags, device, NULL,
437					    NULL, 0));
438		break; /* NOTREACHED */
439	}
440	default:
441		sprintf(cam_errbuf, "%s: asked for a peripheral match, but"
442			" got a bus or device match??!!", func_name);
443		goto btl_bailout;
444		break; /* NOTREACHED */
445	}
446
447btl_bailout:
448	free(ccb.cdm.matches);
449	free(ccb.cdm.patterns);
450	close(fd);
451	return(NULL);
452}
453
454struct cam_device *
455cam_open_spec_device(const char *dev_name, int unit, int flags,
456		     struct cam_device *device)
457{
458	return(cam_lookup_pass(dev_name, unit, flags, NULL, device));
459}
460
461struct cam_device *
462cam_open_pass(const char *path, int flags, struct cam_device *device)
463{
464	return(cam_real_open_device(path, flags, device, path, NULL, 0));
465}
466
467static struct cam_device *
468cam_lookup_pass(const char *dev_name, int unit, int flags,
469		const char *given_path, struct cam_device *device)
470{
471	int fd;
472	union ccb ccb;
473	char dev_path[256];
474	char *func_name = "cam_lookup_pass";
475
476	/*
477	 * The flags argument above only applies to the actual passthrough
478	 * device open, not our open of the given device to find the
479	 * passthrough device.
480	 */
481	if ((fd = open(XPT_DEVICE, O_RDWR)) < 0) {
482		snprintf(cam_errbuf, CAM_ERRBUF_SIZE,
483			 "%s: couldn't open %s\n%s: %s", func_name, XPT_DEVICE,
484			 func_name, strerror(errno));
485		return(NULL);
486	}
487
488	/* This isn't strictly necessary for the GETPASSTHRU ioctl. */
489	ccb.ccb_h.func_code = XPT_GDEVLIST;
490
491	/* These two are necessary for the GETPASSTHRU ioctl to work. */
492	strncpy(ccb.cgdl.periph_name, dev_name, DEV_IDLEN - 1);
493	ccb.cgdl.periph_name[DEV_IDLEN - 1] = '\0';
494	ccb.cgdl.unit_number = unit;
495
496	/*
497	 * Attempt to get the passthrough device.  This ioctl will fail if
498	 * the device name is null, if the device doesn't exist, or if the
499	 * passthrough driver isn't in the kernel.
500	 */
501	if (ioctl(fd, CAMGETPASSTHRU, &ccb) == -1) {
502		char tmpstr[256];
503
504		/*
505		 * If we get ENOENT from the transport layer version of
506		 * the CAMGETPASSTHRU ioctl, it means one of two things:
507		 * either the device name/unit number passed in doesn't
508		 * exist, or the passthrough driver isn't in the kernel.
509		 */
510		if (errno == ENOENT) {
511			snprintf(tmpstr, sizeof(tmpstr),
512				 "\n%s: either the pass driver isn't in "
513				 "your kernel\n%s: or %s%d doesn't exist",
514				 func_name, func_name, dev_name, unit);
515		}
516		snprintf(cam_errbuf, sizeof(cam_errbuf),
517			 "%s: CAMGETPASSTHRU ioctl failed\n"
518			 "%s: %s%s", func_name, func_name, strerror(errno),
519			 (errno == ENOENT) ? tmpstr : "");
520
521		return(NULL);
522	}
523
524	close(fd);
525
526	/*
527	 * If the ioctl returned the right status, but we got an error back
528	 * in the ccb, that means that the kernel found the device the user
529	 * passed in, but was unable to find the passthrough device for
530	 * the device the user gave us.
531	 */
532	if (ccb.cgdl.status == CAM_GDEVLIST_ERROR) {
533		sprintf(cam_errbuf, "%s: device %s%d does not exist",
534			func_name, dev_name, unit);
535		return(NULL);
536	}
537
538	sprintf(dev_path, "/dev/%s%d", ccb.cgdl.periph_name,
539		ccb.cgdl.unit_number);
540
541	return(cam_real_open_device(dev_path, flags, device, NULL,
542				    dev_name, unit));
543}
544
545/*
546 * Open a given device.  The path argument isn't strictly necessary, but it
547 * is copied into the cam_device structure as a convenience to the user.
548 */
549static struct cam_device *
550cam_real_open_device(const char *path, int flags, struct cam_device *device,
551		     const char *given_path, const char *given_dev_name,
552		     int given_unit_number)
553{
554	char newpath[MAXPATHLEN+1];
555	char *func_name = "cam_real_open_device";
556	union ccb ccb;
557	int fd = -1, malloced_device = 0;
558
559	/*
560	 * See if the user wants us to malloc a device for him.
561	 */
562	if (device == NULL) {
563		if ((device = (struct cam_device *)malloc(
564		     sizeof(struct cam_device))) == NULL) {
565			sprintf(cam_errbuf, "%s: device structure malloc"
566				" failed\n%s: %s", func_name, func_name,
567				strerror(errno));
568			return(NULL);
569		}
570		device->fd = -1;
571		malloced_device = 1;
572	}
573
574	/*
575	 * If the user passed in a path, save it for him.
576	 */
577	if (given_path != NULL)
578		strncpy(device->device_path, given_path, MAXPATHLEN + 1);
579	else
580		device->device_path[0] = '\0';
581
582	/*
583	 * If the user passed in a device name and unit number pair, save
584	 * those as well.
585	 */
586	if (given_dev_name != NULL)
587		strncpy(device->given_dev_name, given_dev_name, DEV_IDLEN);
588	else
589		device->given_dev_name[0] = '\0';
590	device->given_unit_number = given_unit_number;
591
592	if ((fd = open(path, flags)) < 0) {
593		snprintf(cam_errbuf, CAM_ERRBUF_SIZE,
594			 "%s: couldn't open passthrough device %s\n"
595			 "%s: %s", func_name, path, func_name,
596			 strerror(errno));
597		goto crod_bailout;
598	}
599
600	device->fd = fd;
601
602	bzero(&ccb, sizeof(union ccb));
603
604	/*
605	 * Unlike the transport layer version of the GETPASSTHRU ioctl,
606	 * we don't have to set any fields.
607	 */
608	ccb.ccb_h.func_code = XPT_GDEVLIST;
609
610	/*
611	 * We're only doing this to get some information on the device in
612	 * question.  Otherwise, we'd have to pass in yet another
613	 * parameter: the passthrough driver unit number.
614	 */
615	if (ioctl(fd, CAMGETPASSTHRU, &ccb) == -1) {
616		/*
617		 * At this point we know the passthrough device must exist
618		 * because we just opened it above.  The only way this
619		 * ioctl can fail is if the ccb size is wrong.
620		 */
621		sprintf(cam_errbuf, "%s: CAMGETPASSTHRU ioctl failed\n"
622			"%s: %s", func_name, func_name, strerror(errno));
623		goto crod_bailout;
624	}
625
626	/*
627	 * If the ioctl returned the right status, but we got an error back
628	 * in the ccb, that means that the kernel found the device the user
629	 * passed in, but was unable to find the passthrough device for
630	 * the device the user gave us.
631	 */
632	if (ccb.cgdl.status == CAM_GDEVLIST_ERROR) {
633		sprintf(cam_errbuf, "%s: passthrough device does not exist??!!",
634			func_name);
635		goto crod_bailout;
636	}
637
638	device->dev_unit_num = ccb.cgdl.unit_number;
639	strcpy(device->device_name, ccb.cgdl.periph_name);
640	device->path_id = ccb.ccb_h.path_id;
641	device->target_id = ccb.ccb_h.target_id;
642	device->target_lun = ccb.ccb_h.target_lun;
643
644	ccb.ccb_h.func_code = XPT_PATH_INQ;
645	if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
646		sprintf(cam_errbuf, "%s: Path Inquiry CCB failed\n"
647			"%s: %s", func_name, func_name, strerror(errno));
648		goto crod_bailout;
649	}
650	strncpy(device->sim_name, ccb.cpi.dev_name, SIM_IDLEN);
651	device->sim_unit_number = ccb.cpi.unit_number;
652	device->bus_id = ccb.cpi.bus_id;
653
654	/*
655	 * It doesn't really matter what is in the payload for a getdev
656	 * CCB, the kernel doesn't look at it.
657	 */
658	ccb.ccb_h.func_code = XPT_GDEV_TYPE;
659	if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
660		sprintf(cam_errbuf, "%s: Get Device Type CCB failed\n"
661			"%s: %s", func_name, func_name, strerror(errno));
662		goto crod_bailout;
663	}
664	device->pd_type = SID_TYPE(&ccb.cgd.inq_data);
665	bcopy(&ccb.cgd.inq_data, &device->inq_data,
666	      sizeof(struct scsi_inquiry_data));
667	device->serial_num_len = ccb.cgd.serial_num_len;
668	bcopy(&ccb.cgd.serial_num, &device->serial_num, device->serial_num_len);
669
670	/*
671	 * Zero the payload, the kernel does look at the flags.
672	 */
673	bzero(&(&ccb.ccb_h)[1], sizeof(struct ccb_trans_settings));
674
675	/*
676	 * Get transfer settings for this device.
677	 */
678	ccb.ccb_h.func_code = XPT_GET_TRAN_SETTINGS;
679
680	ccb.cts.flags = CCB_TRANS_CURRENT_SETTINGS;
681
682	if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
683		sprintf(cam_errbuf, "%s: Get Transfer Settings CCB failed\n"
684			"%s: %s", func_name, func_name, strerror(errno));
685		goto crod_bailout;
686	}
687	device->sync_period = ccb.cts.sync_period;
688	device->sync_offset = ccb.cts.sync_offset;
689	device->bus_width = ccb.cts.bus_width;
690
691	return(device);
692
693crod_bailout:
694
695	if (fd >= 0)
696		close(fd);
697
698	if (malloced_device)
699		free(device);
700
701	return(NULL);
702}
703
704void
705cam_close_device(struct cam_device *dev)
706{
707	if (dev == NULL)
708		return;
709
710	cam_close_spec_device(dev);
711
712	if (dev != NULL)
713		free(dev);
714}
715
716void
717cam_close_spec_device(struct cam_device *dev)
718{
719	if (dev == NULL)
720		return;
721
722	if (dev->fd >= 0)
723		close(dev->fd);
724}
725
726char *
727cam_path_string(struct cam_device *dev, char *str, int len)
728{
729	if (dev == NULL) {
730		snprintf(str, len, "No path");
731		return(str);
732	}
733
734	snprintf(str, len, "(%s%d:%s%d:%d:%d:%d): ",
735		 (dev->device_name[0] != '\0') ? dev->device_name : "pass",
736		 dev->dev_unit_num,
737		 (dev->sim_name[0] != '\0') ? dev->sim_name : "unknown",
738		 dev->sim_unit_number,
739		 dev->bus_id,
740		 dev->target_id,
741		 dev->target_lun);
742
743	return(str);
744}
745
746/*
747 * Malloc/duplicate a CAM device structure.
748 */
749struct cam_device *
750cam_device_dup(struct cam_device *device)
751{
752	char *func_name = "cam_device_dup";
753	struct cam_device *newdev;
754
755	if (device == NULL) {
756		sprintf(cam_errbuf, "%s: device is NULL", func_name);
757		return(NULL);
758	}
759
760	newdev = malloc(sizeof(struct cam_device));
761
762	bcopy(device, newdev, sizeof(struct cam_device));
763
764	return(newdev);
765}
766
767/*
768 * Copy a CAM device structure.
769 */
770void
771cam_device_copy(struct cam_device *src, struct cam_device *dst)
772{
773	char *func_name = "cam_device_copy";
774
775	if (src == NULL) {
776		sprintf(cam_errbuf, "%s: source device struct was NULL",
777			func_name);
778		return;
779	}
780
781	if (dst == NULL) {
782		sprintf(cam_errbuf, "%s: destination device struct was NULL",
783			func_name);
784		return;
785	}
786
787	bcopy(src, dst, sizeof(struct cam_device));
788
789}
790