2 * Copyright (c) 1997, 1998, 1999, 2002 Kenneth D. Merry.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
25 * $FreeBSD: src/lib/libcam/camlib.c,v 1.8.2.2 2002/05/23 04:19:22 ken Exp $
28 #include <sys/types.h>
29 #include <sys/param.h>
39 #include <cam/scsi/scsi_all.h>
40 #include <cam/cam_ccb.h>
41 #include <cam/scsi/scsi_pass.h>
49 struct cam_devequiv devmatchtable
[] = {
54 char cam_errbuf
[CAM_ERRBUF_SIZE
];
56 static 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
);
61 static struct cam_device
*cam_lookup_pass(const char *dev_name
, int unit
,
62 int flags
, const char *given_path
,
63 struct cam_device
*device
);
66 * Send a ccb to a passthrough device.
69 cam_send_ccb(struct cam_device
*device
, union ccb
*ccb
)
71 return(ioctl(device
->fd
, CAMIOCOMMAND
, ccb
));
75 * Malloc a CCB, zero out the header and set its path, target and lun ids.
78 cam_getccb(struct cam_device
*dev
)
82 ccb
= (union ccb
*)malloc(sizeof(union ccb
));
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
;
97 cam_freeccb(union ccb
*ccb
)
103 * Take a device name or path passed in by the user, and attempt to figure
104 * out the device name and unit number. Some possible device name formats are:
114 * If the caller passes in an old style device name like 'sd' or 'st',
115 * it will be converted to the new style device name based upon devmatchtable
118 * Input parameters: device name/path, length of devname string
119 * Output: device name, unit number
120 * Return values: returns 0 for success, -1 for failure
123 cam_get_device(const char *path
, char *dev_name
, int devnamelen
, int *unit
)
125 char *func_name
= "cam_get_device";
126 char *tmpstr
, *tmpstr2
;
133 sprintf(cam_errbuf
, "%s: device pathname was NULL", func_name
);
138 * We can be rather destructive to the path string. Make a copy of
139 * it so we don't hose the user's string.
141 newpath
= (char *)strdup(path
);
144 /* Get rid of any leading white space */
145 while (isspace(*tmpstr
) && (*tmpstr
!= '\0'))
149 * Check to see whether we have an absolute pathname.
151 if (*tmpstr
== '/') {
153 tmpstr
= (char *)rindex(tmpstr2
, '/');
154 if ((tmpstr
!= NULL
) && (*tmpstr
!= '\0'))
158 if (*tmpstr
== '\0') {
159 sprintf(cam_errbuf
, "%s: no text after slash", func_name
);
165 * Check to see whether the user has given us a nonrewound tape
171 if (*tmpstr
== '\0') {
172 sprintf(cam_errbuf
, "%s: no text after leading 'n'", func_name
);
178 * See if the user has given us a character device.
183 if (*tmpstr
== '\0') {
184 sprintf(cam_errbuf
, "%s: no text after leading 'r'", func_name
);
190 * Try to get rid of any trailing white space or partition letters.
192 tmpstr2
= &tmpstr
[strlen(tmpstr
) - 1];
194 while ((*tmpstr2
!= '\0') && (tmpstr2
> tmpstr
) &&(!isdigit(*tmpstr2
))){
200 * Check to see whether we have been given a partition with a slice
201 * name. If so, get rid of the slice name/number.
203 if (strlen(tmpstr
) > 3) {
205 * Basically, we're looking for a string that ends in the
206 * following general manner: 1s1 -- a number, the letter
207 * s, and then another number. This indicates that the
208 * user has given us a slice. We substitute nulls for the
209 * s and the slice number.
211 if ((isdigit(tmpstr
[strlen(tmpstr
) - 1]))
212 && (tmpstr
[strlen(tmpstr
) - 2] == 's')
213 && (isdigit(tmpstr
[strlen(tmpstr
) - 3]))) {
214 tmpstr
[strlen(tmpstr
) - 1] = '\0';
215 tmpstr
[strlen(tmpstr
) - 1] = '\0';
220 * After we nuke off the slice, we should have just a device name
221 * and unit number. That means there must be at least 2
222 * characters. If we only have 1, we don't have a valid device name.
224 if (strlen(tmpstr
) < 2) {
226 "%s: must have both device name and unit number",
233 * If the first character of the string is a digit, then the user
234 * has probably given us all numbers. Point out the error.
236 if (isdigit(*tmpstr
)) {
238 "%s: device name cannot begin with a number",
245 * At this point, if the last character of the string isn't a
246 * number, we know the user either didn't give us a device number,
247 * or he gave us a device name/number format we don't recognize.
249 if (!isdigit(tmpstr
[strlen(tmpstr
) - 1])) {
250 sprintf(cam_errbuf
, "%s: unable to find device unit number",
257 * Attempt to figure out where the device name ends and the unit
258 * number begins. As long as unit_offset is at least 1 less than
259 * the length of the string, we can still potentially have a device
260 * name at the front of the string. When we get to something that
261 * isn't a digit, we've hit the device name. Because of the check
262 * above, we know that this cannot happen when unit_offset == 1.
263 * Therefore it is okay to decrement unit_offset -- it won't cause
264 * us to go past the end of the character array.
266 for (unit_offset
= 1;
267 (unit_offset
< (strlen(tmpstr
)))
268 && (isdigit(tmpstr
[strlen(tmpstr
) - unit_offset
])); unit_offset
++);
273 * Grab the unit number.
275 *unit
= atoi(&tmpstr
[strlen(tmpstr
) - unit_offset
]);
278 * Put a null in place of the first number of the unit number so
279 * that all we have left is the device name.
281 tmpstr
[strlen(tmpstr
) - unit_offset
] = '\0';
284 * Look through our equivalency table and see if the device name
285 * the user gave us is an old style device name. If so, translate
286 * it to the new style device name.
288 for (i
= 0; i
< NELEM(devmatchtable
); i
++) {
289 if (strcmp(tmpstr
, devmatchtable
[i
].given_dev
) == 0) {
290 strlcpy(dev_name
,devmatchtable
[i
].real_dev
, devnamelen
);
296 strlcpy(dev_name
, tmpstr
, devnamelen
);
298 /* Clean up allocated memory */
306 * Backwards compatible wrapper for the real open routine. This translates
307 * a pathname into a device name and unit number for use with the real open
311 cam_open_device(const char *path
, int flags
)
314 char dev_name
[DEV_IDLEN
+ 1];
317 * cam_get_device() has already put an error message in cam_errbuf,
318 * so we don't need to.
320 if (cam_get_device(path
, dev_name
, sizeof(dev_name
), &unit
) == -1)
323 return(cam_lookup_pass(dev_name
, unit
, flags
, path
, NULL
));
327 * Open the passthrough device for a given bus, target and lun, if the
328 * passthrough device exists.
331 cam_open_btl(path_id_t path_id
, target_id_t target_id
, lun_id_t target_lun
,
332 int flags
, struct cam_device
*device
)
335 struct periph_match_pattern
*match_pat
;
336 char *func_name
= "cam_open_btl";
339 if ((fd
= open(XPT_DEVICE
, O_RDWR
)) < 0) {
340 snprintf(cam_errbuf
, CAM_ERRBUF_SIZE
,
341 "%s: couldn't open %s\n%s: %s", func_name
, XPT_DEVICE
,
342 func_name
, strerror(errno
));
346 bzero(&ccb
, sizeof(union ccb
));
347 ccb
.ccb_h
.func_code
= XPT_DEV_MATCH
;
349 /* Setup the result buffer */
350 bufsize
= sizeof(struct dev_match_result
);
351 ccb
.cdm
.match_buf_len
= bufsize
;
352 ccb
.cdm
.matches
= (struct dev_match_result
*)malloc(bufsize
);
353 if (ccb
.cdm
.matches
== NULL
) {
354 snprintf(cam_errbuf
, CAM_ERRBUF_SIZE
,
355 "%s: couldn't malloc match buffer", func_name
);
359 ccb
.cdm
.num_matches
= 0;
361 /* Setup the pattern buffer */
362 ccb
.cdm
.num_patterns
= 1;
363 ccb
.cdm
.pattern_buf_len
= sizeof(struct dev_match_pattern
);
364 ccb
.cdm
.patterns
= (struct dev_match_pattern
*)malloc(
365 sizeof(struct dev_match_pattern
));
366 if (ccb
.cdm
.patterns
== NULL
) {
367 snprintf(cam_errbuf
, CAM_ERRBUF_SIZE
,
368 "%s: couldn't malloc pattern buffer", func_name
);
369 free(ccb
.cdm
.matches
);
373 ccb
.cdm
.patterns
[0].type
= DEV_MATCH_PERIPH
;
374 match_pat
= &ccb
.cdm
.patterns
[0].pattern
.periph_pattern
;
377 * We're looking for the passthrough device associated with this
378 * particular bus/target/lun.
380 sprintf(match_pat
->periph_name
, "pass");
381 match_pat
->path_id
= path_id
;
382 match_pat
->target_id
= target_id
;
383 match_pat
->target_lun
= target_lun
;
384 /* Now set the flags to indicate what we're looking for. */
385 match_pat
->flags
= PERIPH_MATCH_PATH
| PERIPH_MATCH_TARGET
|
386 PERIPH_MATCH_LUN
| PERIPH_MATCH_NAME
;
388 if (ioctl(fd
, CAMIOCOMMAND
, &ccb
) == -1) {
389 sprintf(cam_errbuf
, "%s: CAMIOCOMMAND ioctl failed\n"
390 "%s: %s", func_name
, func_name
, strerror(errno
));
395 * Check for an outright error.
397 if ((ccb
.ccb_h
.status
!= CAM_REQ_CMP
)
398 || ((ccb
.cdm
.status
!= CAM_DEV_MATCH_LAST
)
399 && (ccb
.cdm
.status
!= CAM_DEV_MATCH_MORE
))) {
400 sprintf(cam_errbuf
, "%s: CAM error %#x, CDM error %d "
401 "returned from XPT_DEV_MATCH ccb", func_name
,
402 ccb
.ccb_h
.status
, ccb
.cdm
.status
);
406 if (ccb
.cdm
.status
== CAM_DEV_MATCH_MORE
) {
407 sprintf(cam_errbuf
, "%s: CDM reported more than one"
408 " passthrough device at %d:%d:%d!!\n",
409 func_name
, path_id
, target_id
, target_lun
);
413 if (ccb
.cdm
.num_matches
== 0) {
414 sprintf(cam_errbuf
, "%s: no passthrough device found at"
415 " %d:%d:%d", func_name
, path_id
, target_id
,
420 switch(ccb
.cdm
.matches
[0].type
) {
421 case DEV_MATCH_PERIPH
: {
424 struct periph_match_result
*periph_result
;
426 periph_result
= &ccb
.cdm
.matches
[0].result
.periph_result
;
427 pass_unit
= periph_result
->unit_number
;
428 free(ccb
.cdm
.matches
);
429 free(ccb
.cdm
.patterns
);
431 sprintf(dev_path
, "/dev/pass%d", pass_unit
);
432 return(cam_real_open_device(dev_path
, flags
, device
, NULL
,
434 break; /* NOTREACHED */
437 sprintf(cam_errbuf
, "%s: asked for a peripheral match, but"
438 " got a bus or device match", func_name
);
440 break; /* NOTREACHED */
444 free(ccb
.cdm
.matches
);
445 free(ccb
.cdm
.patterns
);
451 cam_open_spec_device(const char *dev_name
, int unit
, int flags
,
452 struct cam_device
*device
)
454 return(cam_lookup_pass(dev_name
, unit
, flags
, NULL
, device
));
458 cam_open_pass(const char *path
, int flags
, struct cam_device
*device
)
460 return(cam_real_open_device(path
, flags
, device
, path
, NULL
, 0));
463 static struct cam_device
*
464 cam_lookup_pass(const char *dev_name
, int unit
, int flags
,
465 const char *given_path
, struct cam_device
*device
)
470 char *func_name
= "cam_lookup_pass";
473 * The flags argument above only applies to the actual passthrough
474 * device open, not our open of the given device to find the
475 * passthrough device.
477 if ((fd
= open(XPT_DEVICE
, O_RDWR
)) < 0) {
478 snprintf(cam_errbuf
, CAM_ERRBUF_SIZE
,
479 "%s: couldn't open %s\n%s: %s", func_name
, XPT_DEVICE
,
480 func_name
, strerror(errno
));
484 /* This isn't strictly necessary for the GETPASSTHRU ioctl. */
485 ccb
.ccb_h
.func_code
= XPT_GDEVLIST
;
487 /* These two are necessary for the GETPASSTHRU ioctl to work. */
488 strlcpy(ccb
.cgdl
.periph_name
, dev_name
, sizeof(ccb
.cgdl
.periph_name
));
489 ccb
.cgdl
.unit_number
= unit
;
492 * Attempt to get the passthrough device. This ioctl will fail if
493 * the device name is null, if the device doesn't exist, or if the
494 * passthrough driver isn't in the kernel.
496 if (ioctl(fd
, CAMGETPASSTHRU
, &ccb
) == -1) {
500 * If we get ENOENT from the transport layer version of
501 * the CAMGETPASSTHRU ioctl, it means one of two things:
502 * either the device name/unit number passed in doesn't
503 * exist, or the passthrough driver isn't in the kernel.
505 if (errno
== ENOENT
) {
506 snprintf(tmpstr
, sizeof(tmpstr
),
507 "\n%s: either the pass driver isn't in "
508 "your kernel\n%s: or %s%d doesn't exist",
509 func_name
, func_name
, dev_name
, unit
);
511 snprintf(cam_errbuf
, sizeof(cam_errbuf
),
512 "%s: CAMGETPASSTHRU ioctl failed\n"
513 "%s: %s%s", func_name
, func_name
, strerror(errno
),
514 (errno
== ENOENT
) ? tmpstr
: "");
523 * If the ioctl returned the right status, but we got an error back
524 * in the ccb, that means that the kernel found the device the user
525 * passed in, but was unable to find the passthrough device for
526 * the device the user gave us.
528 if (ccb
.cgdl
.status
== CAM_GDEVLIST_ERROR
) {
529 sprintf(cam_errbuf
, "%s: device %s%d does not exist!",
530 func_name
, dev_name
, unit
);
534 sprintf(dev_path
, "/dev/%s%d", ccb
.cgdl
.periph_name
,
535 ccb
.cgdl
.unit_number
);
537 return(cam_real_open_device(dev_path
, flags
, device
, NULL
,
542 * Open a given device. The path argument isn't strictly necessary, but it
543 * is copied into the cam_device structure as a convenience to the user.
545 static struct cam_device
*
546 cam_real_open_device(const char *path
, int flags
, struct cam_device
*device
,
547 const char *given_path
, const char *given_dev_name
,
548 int given_unit_number
)
550 char *func_name
= "cam_real_open_device";
552 int fd
= -1, malloced_device
= 0;
555 * See if the user wants us to malloc a device for him.
557 if (device
== NULL
) {
558 if ((device
= (struct cam_device
*)malloc(
559 sizeof(struct cam_device
))) == NULL
) {
560 sprintf(cam_errbuf
, "%s: device structure malloc"
561 " failed\n%s: %s", func_name
, func_name
,
570 * If the user passed in a path, save it for him.
572 if (given_path
!= NULL
)
573 strlcpy(device
->device_path
, given_path
,
574 sizeof(device
->device_path
));
576 device
->device_path
[0] = '\0';
579 * If the user passed in a device name and unit number pair, save
582 if (given_dev_name
!= NULL
)
583 strlcpy(device
->given_dev_name
, given_dev_name
,
584 sizeof(device
->given_dev_name
));
586 device
->given_dev_name
[0] = '\0';
587 device
->given_unit_number
= given_unit_number
;
589 if ((fd
= open(path
, flags
)) < 0) {
590 snprintf(cam_errbuf
, CAM_ERRBUF_SIZE
,
591 "%s: couldn't open passthrough device %s\n"
592 "%s: %s", func_name
, path
, func_name
,
599 bzero(&ccb
, sizeof(union ccb
));
602 * Unlike the transport layer version of the GETPASSTHRU ioctl,
603 * we don't have to set any fields.
605 ccb
.ccb_h
.func_code
= XPT_GDEVLIST
;
608 * We're only doing this to get some information on the device in
609 * question. Otherwise, we'd have to pass in yet another
610 * parameter: the passthrough driver unit number.
612 if (ioctl(fd
, CAMGETPASSTHRU
, &ccb
) == -1) {
614 * At this point we know the passthrough device must exist
615 * because we just opened it above. The only way this
616 * ioctl can fail is if the ccb size is wrong.
618 sprintf(cam_errbuf
, "%s: CAMGETPASSTHRU ioctl failed\n"
619 "%s: %s", func_name
, func_name
, strerror(errno
));
624 * If the ioctl returned the right status, but we got an error back
625 * in the ccb, that means that the kernel found the device the user
626 * passed in, but was unable to find the passthrough device for
627 * the device the user gave us.
629 if (ccb
.cgdl
.status
== CAM_GDEVLIST_ERROR
) {
630 sprintf(cam_errbuf
, "%s: passthrough device does not exist!",
635 device
->dev_unit_num
= ccb
.cgdl
.unit_number
;
636 strlcpy(device
->device_name
, ccb
.cgdl
.periph_name
,
637 sizeof(device
->device_name
));
638 device
->path_id
= ccb
.ccb_h
.path_id
;
639 device
->target_id
= ccb
.ccb_h
.target_id
;
640 device
->target_lun
= ccb
.ccb_h
.target_lun
;
642 ccb
.ccb_h
.func_code
= XPT_PATH_INQ
;
643 if (ioctl(fd
, CAMIOCOMMAND
, &ccb
) == -1) {
644 sprintf(cam_errbuf
, "%s: Path Inquiry CCB failed\n"
645 "%s: %s", func_name
, func_name
, strerror(errno
));
648 strlcpy(device
->sim_name
, ccb
.cpi
.dev_name
, sizeof(device
->sim_name
));
649 device
->sim_unit_number
= ccb
.cpi
.unit_number
;
650 device
->bus_id
= ccb
.cpi
.bus_id
;
653 * It doesn't really matter what is in the payload for a getdev
654 * CCB, the kernel doesn't look at it.
656 ccb
.ccb_h
.func_code
= XPT_GDEV_TYPE
;
657 if (ioctl(fd
, CAMIOCOMMAND
, &ccb
) == -1) {
658 sprintf(cam_errbuf
, "%s: Get Device Type CCB failed\n"
659 "%s: %s", func_name
, func_name
, strerror(errno
));
662 device
->pd_type
= SID_TYPE(&ccb
.cgd
.inq_data
);
663 bcopy(&ccb
.cgd
.inq_data
, &device
->inq_data
,
664 sizeof(struct scsi_inquiry_data
));
665 device
->serial_num_len
= ccb
.cgd
.serial_num_len
;
666 bcopy(&ccb
.cgd
.serial_num
, &device
->serial_num
, device
->serial_num_len
);
669 * Zero the payload, the kernel does look at the flags.
671 bzero(&(&ccb
.ccb_h
)[1], sizeof(struct ccb_trans_settings
));
674 * Get transfer settings for this device.
676 ccb
.ccb_h
.func_code
= XPT_GET_TRAN_SETTINGS
;
678 ccb
.cts
.type
= CTS_TYPE_CURRENT_SETTINGS
;
680 if (ioctl(fd
, CAMIOCOMMAND
, &ccb
) == -1) {
681 sprintf(cam_errbuf
, "%s: Get Transfer Settings CCB failed\n"
682 "%s: %s", func_name
, func_name
, strerror(errno
));
685 if (ccb
.cts
.transport
== XPORT_SPI
) {
686 struct ccb_trans_settings_spi
*spi
=
687 &ccb
.cts
.xport_specific
.spi
;
688 device
->sync_period
= spi
->sync_period
;
689 device
->sync_offset
= spi
->sync_offset
;
690 device
->bus_width
= spi
->bus_width
;
692 device
->sync_period
= 0;
693 device
->sync_offset
= 0;
694 device
->bus_width
= 0;
711 cam_close_device(struct cam_device
*dev
)
716 cam_close_spec_device(dev
);
722 cam_close_spec_device(struct cam_device
*dev
)
732 cam_path_string(struct cam_device
*dev
, char *str
, int len
)
735 snprintf(str
, len
, "No path");
739 snprintf(str
, len
, "(%s%d:%s%d:%d:%d:%d): ",
740 (dev
->device_name
[0] != '\0') ? dev
->device_name
: "pass",
742 (dev
->sim_name
[0] != '\0') ? dev
->sim_name
: "unknown",
743 dev
->sim_unit_number
,
752 * Malloc/duplicate a CAM device structure.
755 cam_device_dup(struct cam_device
*device
)
757 char *func_name
= "cam_device_dup";
758 struct cam_device
*newdev
;
760 if (device
== NULL
) {
761 sprintf(cam_errbuf
, "%s: device is NULL", func_name
);
765 newdev
= malloc(sizeof(struct cam_device
));
766 if (newdev
== NULL
) {
767 snprintf(cam_errbuf
, CAM_ERRBUF_SIZE
,
768 "%s: couldn't malloc CAM device structure", func_name
);
772 bcopy(device
, newdev
, sizeof(struct cam_device
));
778 * Copy a CAM device structure.
781 cam_device_copy(struct cam_device
*src
, struct cam_device
*dst
)
783 char *func_name
= "cam_device_copy";
786 sprintf(cam_errbuf
, "%s: source device struct was NULL",
792 sprintf(cam_errbuf
, "%s: destination device struct was NULL",
797 bcopy(src
, dst
, sizeof(struct cam_device
));