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
26 #include <sys/cdefs.h>
27 __FBSDID("$FreeBSD$");
29 #include <sys/types.h>
30 #include <sys/param.h>
41 #include <cam/scsi/scsi_all.h>
42 #include <cam/cam_ccb.h>
43 #include <cam/scsi/scsi_pass.h>
47 static const char *nonrewind_devs[] = {
51 char cam_errbuf[CAM_ERRBUF_SIZE];
53 static struct cam_device *cam_real_open_device(const char *path, int flags,
54 struct cam_device *device,
55 const char *given_path,
56 const char *given_dev_name,
57 int given_unit_number);
58 static struct cam_device *cam_lookup_pass(const char *dev_name, int unit,
59 int flags, const char *given_path,
60 struct cam_device *device);
63 * Send a ccb to a passthrough device.
66 cam_send_ccb(struct cam_device *device, union ccb *ccb)
68 return(ioctl(device->fd, CAMIOCOMMAND, ccb));
72 * Malloc a CCB, zero out the header and set its path, target and lun ids.
75 cam_getccb(struct cam_device *dev)
79 ccb = (union ccb *)malloc(sizeof(union ccb));
81 bzero(&ccb->ccb_h, sizeof(struct ccb_hdr));
82 ccb->ccb_h.path_id = dev->path_id;
83 ccb->ccb_h.target_id = dev->target_id;
84 ccb->ccb_h.target_lun = dev->target_lun;
94 cam_freeccb(union ccb *ccb)
100 * Take a device name or path passed in by the user, and attempt to figure
101 * out the device name and unit number. Some possible device name formats are:
106 * Some peripheral drivers create separate device nodes with 'n' prefix for
107 * non-rewind operations. Currently only sa(4) tape driver has this feature.
108 * We extract pure peripheral name as device name for this special case.
110 * Input parameters: device name/path, length of devname string
111 * Output: device name, unit number
112 * Return values: returns 0 for success, -1 for failure
115 cam_get_device(const char *path, char *dev_name, int devnamelen, int *unit)
117 char *tmpstr, *tmpstr2;
123 snprintf(cam_errbuf, nitems(cam_errbuf),
124 "%s: device pathname was NULL", __func__);
129 * We can be rather destructive to the path string. Make a copy of
130 * it so we don't hose the user's string.
132 newpath = (char *)strdup(path);
136 * Check to see whether we have an absolute pathname.
138 if (*tmpstr == '/') {
140 tmpstr = strrchr(tmpstr2, '/');
141 if ((tmpstr != NULL) && (*tmpstr != '\0'))
145 if (*tmpstr == '\0') {
146 snprintf(cam_errbuf, nitems(cam_errbuf),
147 "%s: no text after slash", __func__);
153 * Check to see whether the user has given us a nonrewound tape
156 if (*tmpstr == 'n' || *tmpstr == 'e') {
157 for (i = 0; i < sizeof(nonrewind_devs)/sizeof(char *); i++) {
158 int len = strlen(nonrewind_devs[i]);
159 if (strncmp(tmpstr + 1, nonrewind_devs[i], len) == 0) {
160 if (isdigit(tmpstr[len + 1])) {
169 * We should now have just a device name and unit number.
170 * That means that there must be at least 2 characters.
171 * If we only have 1, we don't have a valid device name.
173 if (strlen(tmpstr) < 2) {
174 snprintf(cam_errbuf, nitems(cam_errbuf),
175 "%s: must have both device name and unit number",
182 * If the first character of the string is a digit, then the user
183 * has probably given us all numbers. Point out the error.
185 if (isdigit(*tmpstr)) {
186 snprintf(cam_errbuf, nitems(cam_errbuf),
187 "%s: device name cannot begin with a number",
194 * At this point, if the last character of the string isn't a
195 * number, we know the user either didn't give us a device number,
196 * or he gave us a device name/number format we don't recognize.
198 if (!isdigit(tmpstr[strlen(tmpstr) - 1])) {
199 snprintf(cam_errbuf, nitems(cam_errbuf),
200 "%s: unable to find device unit number", __func__);
206 * Attempt to figure out where the device name ends and the unit
207 * number begins. As long as unit_offset is at least 1 less than
208 * the length of the string, we can still potentially have a device
209 * name at the front of the string. When we get to something that
210 * isn't a digit, we've hit the device name. Because of the check
211 * above, we know that this cannot happen when unit_offset == 1.
212 * Therefore it is okay to decrement unit_offset -- it won't cause
213 * us to go past the end of the character array.
215 for (unit_offset = 1;
216 (unit_offset < (strlen(tmpstr)))
217 && (isdigit(tmpstr[strlen(tmpstr) - unit_offset])); unit_offset++);
222 * Grab the unit number.
224 *unit = atoi(&tmpstr[strlen(tmpstr) - unit_offset]);
227 * Put a null in place of the first number of the unit number so
228 * that all we have left is the device name.
230 tmpstr[strlen(tmpstr) - unit_offset] = '\0';
232 strlcpy(dev_name, tmpstr, devnamelen);
234 /* Clean up allocated memory */
242 * Backwards compatible wrapper for the real open routine. This translates
243 * a pathname into a device name and unit number for use with the real open
247 cam_open_device(const char *path, int flags)
250 char dev_name[DEV_IDLEN + 1];
253 * cam_get_device() has already put an error message in cam_errbuf,
254 * so we don't need to.
256 if (cam_get_device(path, dev_name, sizeof(dev_name), &unit) == -1)
259 return(cam_lookup_pass(dev_name, unit, flags, path, NULL));
263 * Open the passthrough device for a given bus, target and lun, if the
264 * passthrough device exists.
267 cam_open_btl(path_id_t path_id, target_id_t target_id, lun_id_t target_lun,
268 int flags, struct cam_device *device)
271 struct periph_match_pattern *match_pat;
274 if ((fd = open(XPT_DEVICE, O_RDWR)) < 0) {
275 snprintf(cam_errbuf, nitems(cam_errbuf),
276 "%s: couldn't open %s\n%s: %s", __func__, XPT_DEVICE,
277 __func__, strerror(errno));
281 bzero(&ccb, sizeof(union ccb));
282 ccb.ccb_h.func_code = XPT_DEV_MATCH;
283 ccb.ccb_h.path_id = CAM_XPT_PATH_ID;
284 ccb.ccb_h.target_id = CAM_TARGET_WILDCARD;
285 ccb.ccb_h.target_lun = CAM_LUN_WILDCARD;
287 /* Setup the result buffer */
288 bufsize = sizeof(struct dev_match_result);
289 ccb.cdm.match_buf_len = bufsize;
290 ccb.cdm.matches = (struct dev_match_result *)malloc(bufsize);
291 if (ccb.cdm.matches == NULL) {
292 snprintf(cam_errbuf, nitems(cam_errbuf),
293 "%s: couldn't malloc match buffer", __func__);
297 ccb.cdm.num_matches = 0;
299 /* Setup the pattern buffer */
300 ccb.cdm.num_patterns = 1;
301 ccb.cdm.pattern_buf_len = sizeof(struct dev_match_pattern);
302 ccb.cdm.patterns = (struct dev_match_pattern *)malloc(
303 sizeof(struct dev_match_pattern));
304 if (ccb.cdm.patterns == NULL) {
305 snprintf(cam_errbuf, nitems(cam_errbuf),
306 "%s: couldn't malloc pattern buffer", __func__);
307 free(ccb.cdm.matches);
308 ccb.cdm.matches = NULL;
312 ccb.cdm.patterns[0].type = DEV_MATCH_PERIPH;
313 match_pat = &ccb.cdm.patterns[0].pattern.periph_pattern;
316 * We're looking for the passthrough device associated with this
317 * particular bus/target/lun.
319 sprintf(match_pat->periph_name, "pass");
320 match_pat->path_id = path_id;
321 match_pat->target_id = target_id;
322 match_pat->target_lun = target_lun;
323 /* Now set the flags to indicate what we're looking for. */
324 match_pat->flags = PERIPH_MATCH_PATH | PERIPH_MATCH_TARGET |
325 PERIPH_MATCH_LUN | PERIPH_MATCH_NAME;
327 if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
328 snprintf(cam_errbuf, nitems(cam_errbuf),
329 "%s: CAMIOCOMMAND ioctl failed\n"
330 "%s: %s", __func__, __func__, strerror(errno));
335 * Check for an outright error.
337 if ((ccb.ccb_h.status != CAM_REQ_CMP)
338 || ((ccb.cdm.status != CAM_DEV_MATCH_LAST)
339 && (ccb.cdm.status != CAM_DEV_MATCH_MORE))) {
340 snprintf(cam_errbuf, nitems(cam_errbuf),
341 "%s: CAM error %#x, CDM error %d "
342 "returned from XPT_DEV_MATCH ccb", __func__,
343 ccb.ccb_h.status, ccb.cdm.status);
347 if (ccb.cdm.status == CAM_DEV_MATCH_MORE) {
348 snprintf(cam_errbuf, nitems(cam_errbuf),
349 "%s: CDM reported more than one"
350 " passthrough device at %d:%d:%jx!!\n",
351 __func__, path_id, target_id, (uintmax_t)target_lun);
355 if (ccb.cdm.num_matches == 0) {
356 snprintf(cam_errbuf, nitems(cam_errbuf),
357 "%s: no passthrough device found at"
358 " %d:%d:%jx", __func__, path_id, target_id,
359 (uintmax_t)target_lun);
363 switch(ccb.cdm.matches[0].type) {
364 case DEV_MATCH_PERIPH: {
367 struct periph_match_result *periph_result;
369 periph_result = &ccb.cdm.matches[0].result.periph_result;
370 pass_unit = periph_result->unit_number;
371 free(ccb.cdm.matches);
372 ccb.cdm.matches = NULL;
373 free(ccb.cdm.patterns);
374 ccb.cdm.patterns = NULL;
376 sprintf(dev_path, "/dev/pass%d", pass_unit);
377 return(cam_real_open_device(dev_path, flags, device, NULL,
379 break; /* NOTREACHED */
382 snprintf(cam_errbuf, nitems(cam_errbuf),
383 "%s: asked for a peripheral match, but"
384 " got a bus or device match", __func__);
386 break; /* NOTREACHED */
390 free(ccb.cdm.matches);
391 ccb.cdm.matches = NULL;
392 free(ccb.cdm.patterns);
393 ccb.cdm.patterns = NULL;
399 cam_open_spec_device(const char *dev_name, int unit, int flags,
400 struct cam_device *device)
402 return(cam_lookup_pass(dev_name, unit, flags, NULL, device));
406 cam_open_pass(const char *path, int flags, struct cam_device *device)
408 return(cam_real_open_device(path, flags, device, path, NULL, 0));
411 static struct cam_device *
412 cam_lookup_pass(const char *dev_name, int unit, int flags,
413 const char *given_path, struct cam_device *device)
420 * The flags argument above only applies to the actual passthrough
421 * device open, not our open of the given device to find the
422 * passthrough device.
424 if ((fd = open(XPT_DEVICE, O_RDWR)) < 0) {
425 snprintf(cam_errbuf, nitems(cam_errbuf),
426 "%s: couldn't open %s\n%s: %s", __func__, XPT_DEVICE,
427 __func__, strerror(errno));
431 /* This isn't strictly necessary for the GETPASSTHRU ioctl. */
432 ccb.ccb_h.func_code = XPT_GDEVLIST;
434 /* These two are necessary for the GETPASSTHRU ioctl to work. */
435 strlcpy(ccb.cgdl.periph_name, dev_name, sizeof(ccb.cgdl.periph_name));
436 ccb.cgdl.unit_number = unit;
439 * Attempt to get the passthrough device. This ioctl will fail if
440 * the device name is null, if the device doesn't exist, or if the
441 * passthrough driver isn't in the kernel.
443 if (ioctl(fd, CAMGETPASSTHRU, &ccb) == -1) {
447 * If we get ENOENT from the transport layer version of
448 * the CAMGETPASSTHRU ioctl, it means one of two things:
449 * either the device name/unit number passed in doesn't
450 * exist, or the passthrough driver isn't in the kernel.
452 if (errno == ENOENT) {
453 snprintf(tmpstr, sizeof(tmpstr),
454 "\n%s: either the pass driver isn't in "
455 "your kernel\n%s: or %s%d doesn't exist",
456 __func__, __func__, dev_name, unit);
458 snprintf(cam_errbuf, nitems(cam_errbuf),
459 "%s: CAMGETPASSTHRU ioctl failed\n"
460 "%s: %s%s", __func__, __func__, strerror(errno),
461 (errno == ENOENT) ? tmpstr : "");
470 * If the ioctl returned the right status, but we got an error back
471 * in the ccb, that means that the kernel found the device the user
472 * passed in, but was unable to find the passthrough device for
473 * the device the user gave us.
475 if (ccb.cgdl.status == CAM_GDEVLIST_ERROR) {
476 snprintf(cam_errbuf, nitems(cam_errbuf),
477 "%s: device %s%d does not exist!",
478 __func__, dev_name, unit);
482 sprintf(dev_path, "/dev/%s%d", ccb.cgdl.periph_name,
483 ccb.cgdl.unit_number);
485 return(cam_real_open_device(dev_path, flags, device, NULL,
490 * Open a given device. The path argument isn't strictly necessary, but it
491 * is copied into the cam_device structure as a convenience to the user.
493 static struct cam_device *
494 cam_real_open_device(const char *path, int flags, struct cam_device *device,
495 const char *given_path, const char *given_dev_name,
496 int given_unit_number)
499 int fd = -1, malloced_device = 0;
502 * See if the user wants us to malloc a device for him.
504 if (device == NULL) {
505 if ((device = (struct cam_device *)malloc(
506 sizeof(struct cam_device))) == NULL) {
507 snprintf(cam_errbuf, nitems(cam_errbuf),
508 "%s: device structure malloc"
509 " failed\n%s: %s", __func__, __func__,
518 * If the user passed in a path, save it for him.
520 if (given_path != NULL)
521 strlcpy(device->device_path, given_path,
522 sizeof(device->device_path));
524 device->device_path[0] = '\0';
527 * If the user passed in a device name and unit number pair, save
530 if (given_dev_name != NULL)
531 strlcpy(device->given_dev_name, given_dev_name,
532 sizeof(device->given_dev_name));
534 device->given_dev_name[0] = '\0';
535 device->given_unit_number = given_unit_number;
537 if ((fd = open(path, flags)) < 0) {
538 snprintf(cam_errbuf, nitems(cam_errbuf),
539 "%s: couldn't open passthrough device %s\n"
540 "%s: %s", __func__, path, __func__,
547 bzero(&ccb, sizeof(union ccb));
550 * Unlike the transport layer version of the GETPASSTHRU ioctl,
551 * we don't have to set any fields.
553 ccb.ccb_h.func_code = XPT_GDEVLIST;
556 * We're only doing this to get some information on the device in
557 * question. Otherwise, we'd have to pass in yet another
558 * parameter: the passthrough driver unit number.
560 if (ioctl(fd, CAMGETPASSTHRU, &ccb) == -1) {
562 * At this point we know the passthrough device must exist
563 * because we just opened it above. The only way this
564 * ioctl can fail is if the ccb size is wrong.
566 snprintf(cam_errbuf, nitems(cam_errbuf),
567 "%s: CAMGETPASSTHRU ioctl failed\n"
568 "%s: %s", __func__, __func__, strerror(errno));
573 * If the ioctl returned the right status, but we got an error back
574 * in the ccb, that means that the kernel found the device the user
575 * passed in, but was unable to find the passthrough device for
576 * the device the user gave us.
578 if (ccb.cgdl.status == CAM_GDEVLIST_ERROR) {
579 snprintf(cam_errbuf, nitems(cam_errbuf),
580 "%s: passthrough device does not exist!", __func__);
584 device->dev_unit_num = ccb.cgdl.unit_number;
585 strlcpy(device->device_name, ccb.cgdl.periph_name,
586 sizeof(device->device_name));
587 device->path_id = ccb.ccb_h.path_id;
588 device->target_id = ccb.ccb_h.target_id;
589 device->target_lun = ccb.ccb_h.target_lun;
591 ccb.ccb_h.func_code = XPT_PATH_INQ;
592 if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
593 snprintf(cam_errbuf, nitems(cam_errbuf),
594 "%s: Path Inquiry CCB failed\n"
595 "%s: %s", __func__, __func__, strerror(errno));
598 strlcpy(device->sim_name, ccb.cpi.dev_name, sizeof(device->sim_name));
599 device->sim_unit_number = ccb.cpi.unit_number;
600 device->bus_id = ccb.cpi.bus_id;
603 * It doesn't really matter what is in the payload for a getdev
604 * CCB, the kernel doesn't look at it.
606 ccb.ccb_h.func_code = XPT_GDEV_TYPE;
607 if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
608 snprintf(cam_errbuf, nitems(cam_errbuf),
609 "%s: Get Device Type CCB failed\n"
610 "%s: %s", __func__, __func__, strerror(errno));
613 device->pd_type = SID_TYPE(&ccb.cgd.inq_data);
614 bcopy(&ccb.cgd.inq_data, &device->inq_data,
615 sizeof(struct scsi_inquiry_data));
616 device->serial_num_len = ccb.cgd.serial_num_len;
617 bcopy(&ccb.cgd.serial_num, &device->serial_num, device->serial_num_len);
620 * Zero the payload, the kernel does look at the flags.
622 CCB_CLEAR_ALL_EXCEPT_HDR(&ccb.cts);
625 * Get transfer settings for this device.
627 ccb.ccb_h.func_code = XPT_GET_TRAN_SETTINGS;
629 ccb.cts.type = CTS_TYPE_CURRENT_SETTINGS;
631 if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
632 snprintf(cam_errbuf, nitems(cam_errbuf),
633 "%s: Get Transfer Settings CCB failed\n"
634 "%s: %s", __func__, __func__, strerror(errno));
637 if (ccb.cts.transport == XPORT_SPI) {
638 struct ccb_trans_settings_spi *spi =
639 &ccb.cts.xport_specific.spi;
640 device->sync_period = spi->sync_period;
641 device->sync_offset = spi->sync_offset;
642 device->bus_width = spi->bus_width;
644 device->sync_period = 0;
645 device->sync_offset = 0;
646 device->bus_width = 0;
663 cam_close_device(struct cam_device *dev)
668 cam_close_spec_device(dev);
674 cam_close_spec_device(struct cam_device *dev)
686 cam_path_string(struct cam_device *dev, char *str, int len)
689 snprintf(str, len, "No path");
693 snprintf(str, len, "(%s%d:%s%d:%d:%d:%jx): ",
694 (dev->device_name[0] != '\0') ? dev->device_name : "pass",
696 (dev->sim_name[0] != '\0') ? dev->sim_name : "unknown",
697 dev->sim_unit_number,
700 (uintmax_t)dev->target_lun);
706 * Malloc/duplicate a CAM device structure.
709 cam_device_dup(struct cam_device *device)
711 struct cam_device *newdev;
713 if (device == NULL) {
714 snprintf(cam_errbuf, nitems(cam_errbuf),
715 "%s: device is NULL", __func__);
719 newdev = malloc(sizeof(struct cam_device));
720 if (newdev == NULL) {
721 snprintf(cam_errbuf, nitems(cam_errbuf),
722 "%s: couldn't malloc CAM device structure", __func__);
726 bcopy(device, newdev, sizeof(struct cam_device));
732 * Copy a CAM device structure.
735 cam_device_copy(struct cam_device *src, struct cam_device *dst)
739 snprintf(cam_errbuf, nitems(cam_errbuf),
740 "%s: source device struct was NULL", __func__);
745 snprintf(cam_errbuf, nitems(cam_errbuf),
746 "%s: destination device struct was NULL", __func__);
750 bcopy(src, dst, sizeof(struct cam_device));