2 * Common functions for CAM "type" (peripheral) drivers.
4 * Copyright (c) 1997, 1998 Justin T. Gibbs.
5 * Copyright (c) 1997, 1998, 1999, 2000 Kenneth D. Merry.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions, and the following disclaimer,
13 * without modification, immediately at the beginning of the file.
14 * 2. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
21 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * $FreeBSD: src/sys/cam/cam_periph.c,v 1.24.2.3 2003/01/25 19:04:40 dillon Exp $
30 * $DragonFly: src/sys/bus/cam/cam_periph.c,v 1.14 2006/04/30 17:22:14 dillon Exp $
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/types.h>
36 #include <sys/malloc.h>
37 #include <sys/linker_set.h>
40 #include <sys/devicestat.h>
43 #include <vm/vm_extern.h>
45 #include <sys/thread2.h>
49 #include "cam_xpt_periph.h"
50 #include "cam_periph.h"
51 #include "cam_debug.h"
53 #include <bus/cam/scsi/scsi_all.h>
54 #include <bus/cam/scsi/scsi_message.h>
55 #include <bus/cam/scsi/scsi_da.h>
56 #include <bus/cam/scsi/scsi_pass.h>
58 static u_int camperiphnextunit(struct periph_driver *p_drv,
59 u_int newunit, int wired,
60 path_id_t pathid, target_id_t target,
62 static u_int camperiphunit(struct periph_driver *p_drv,
63 path_id_t pathid, target_id_t target,
65 static void camperiphdone(struct cam_periph *periph,
67 static void camperiphfree(struct cam_periph *periph);
70 cam_periph_alloc(periph_ctor_t *periph_ctor,
71 periph_oninv_t *periph_oninvalidate,
72 periph_dtor_t *periph_dtor, periph_start_t *periph_start,
73 char *name, cam_periph_type type, struct cam_path *path,
74 ac_callback_t *ac_callback, ac_code code, void *arg)
76 struct periph_driver **p_drv;
77 struct cam_periph *periph;
78 struct cam_periph *cur_periph;
80 target_id_t target_id;
87 * Handle Hot-Plug scenarios. If there is already a peripheral
88 * of our type assigned to this path, we are likely waiting for
89 * final close on an old, invalidated, peripheral. If this is
90 * the case, queue up a deferred call to the peripheral's async
91 * handler. If it looks like a mistaken re-alloation, complain.
93 if ((periph = cam_periph_find(path, name)) != NULL) {
95 if ((periph->flags & CAM_PERIPH_INVALID) != 0
96 && (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) == 0) {
97 periph->flags |= CAM_PERIPH_NEW_DEV_FOUND;
98 periph->deferred_callback = ac_callback;
99 periph->deferred_ac = code;
100 return (CAM_REQ_INPROG);
102 printf("cam_periph_alloc: attempt to re-allocate "
103 "valid device %s%d rejected\n",
104 periph->periph_name, periph->unit_number);
106 return (CAM_REQ_INVALID);
109 periph = malloc(sizeof(*periph), M_DEVBUF, M_INTWAIT | M_ZERO);
113 SET_FOREACH(p_drv, periphdriver_set) {
114 if (strcmp((*p_drv)->driver_name, name) == 0)
118 path_id = xpt_path_path_id(path);
119 target_id = xpt_path_target_id(path);
120 lun_id = xpt_path_lun_id(path);
121 cam_init_pinfo(&periph->pinfo);
122 periph->periph_start = periph_start;
123 periph->periph_dtor = periph_dtor;
124 periph->periph_oninval = periph_oninvalidate;
126 periph->periph_name = name;
127 periph->unit_number = camperiphunit(*p_drv, path_id, target_id, lun_id);
128 periph->immediate_priority = CAM_PRIORITY_NONE;
129 periph->refcount = 0;
130 SLIST_INIT(&periph->ccb_list);
131 status = xpt_create_path(&path, periph, path_id, target_id, lun_id);
132 if (status != CAM_REQ_CMP)
138 status = xpt_add_periph(periph);
140 if (status != CAM_REQ_CMP)
144 cur_periph = TAILQ_FIRST(&(*p_drv)->units);
145 while (cur_periph != NULL
146 && cur_periph->unit_number < periph->unit_number)
147 cur_periph = TAILQ_NEXT(cur_periph, unit_links);
149 if (cur_periph != NULL)
150 TAILQ_INSERT_BEFORE(cur_periph, periph, unit_links);
152 TAILQ_INSERT_TAIL(&(*p_drv)->units, periph, unit_links);
153 (*p_drv)->generation++;
160 status = periph_ctor(periph, arg);
162 if (status == CAM_REQ_CMP)
166 switch (init_level) {
168 /* Initialized successfully */
172 TAILQ_REMOVE(&(*p_drv)->units, periph, unit_links);
174 xpt_remove_periph(periph);
176 xpt_free_path(periph->path);
178 free(periph, M_DEVBUF);
180 /* No cleanup to perform. */
183 panic("cam_periph_alloc: Unkown init level");
189 * Find a peripheral structure with the specified path, target, lun,
190 * and (optionally) type. If the name is NULL, this function will return
191 * the first peripheral driver that matches the specified path.
194 cam_periph_find(struct cam_path *path, char *name)
196 struct periph_driver **p_drv;
197 struct cam_periph *periph;
199 SET_FOREACH(p_drv, periphdriver_set) {
200 if (name != NULL && (strcmp((*p_drv)->driver_name, name) != 0))
204 for (periph = TAILQ_FIRST(&(*p_drv)->units); periph != NULL;
205 periph = TAILQ_NEXT(periph, unit_links)) {
206 if (xpt_path_comp(periph->path, path) == 0) {
219 cam_periph_acquire(struct cam_periph *periph)
222 return(CAM_REQ_CMP_ERR);
232 cam_periph_release(struct cam_periph *periph)
238 if ((--periph->refcount == 0)
239 && (periph->flags & CAM_PERIPH_INVALID)) {
240 camperiphfree(periph);
246 * Look for the next unit number that is not currently in use for this
247 * peripheral type starting at "newunit". Also exclude unit numbers that
248 * are reserved by for future "hardwiring" unless we already know that this
249 * is a potential wired device. Only assume that the device is "wired" the
250 * first time through the loop since after that we'll be looking at unit
251 * numbers that did not match a wiring entry.
254 camperiphnextunit(struct periph_driver *p_drv, u_int newunit, int wired,
255 path_id_t pathid, target_id_t target, lun_id_t lun)
257 struct cam_periph *periph;
258 char *periph_name, *strval;
263 periph_name = p_drv->driver_name;
266 for (periph = TAILQ_FIRST(&p_drv->units);
267 periph != NULL && periph->unit_number != newunit;
268 periph = TAILQ_NEXT(periph, unit_links))
271 if (periph != NULL && periph->unit_number == newunit) {
273 xpt_print_path(periph->path);
274 printf("Duplicate Wired Device entry!\n");
275 xpt_print_path(periph->path);
276 printf("Second device (%s device at scbus%d "
277 "target %d lun %d) will not be wired\n",
278 periph_name, pathid, target, lun);
287 * Don't match entries like "da 4" as a wired down
288 * device, but do match entries like "da 4 target 5"
289 * or even "da 4 scbus 1".
292 while ((i = resource_locate(i, periph_name)) != -1) {
293 dname = resource_query_name(i);
294 dunit = resource_query_unit(i);
295 /* if no "target" and no specific scbus, skip */
296 if (resource_int_value(dname, dunit, "target", &val) &&
297 (resource_string_value(dname, dunit, "at",&strval)||
298 strcmp(strval, "scbus") == 0))
300 if (newunit == dunit)
311 camperiphunit(struct periph_driver *p_drv, path_id_t pathid,
312 target_id_t target, lun_id_t lun)
315 int hit, i, val, dunit;
317 char pathbuf[32], *strval, *periph_name;
321 periph_name = p_drv->driver_name;
322 snprintf(pathbuf, sizeof(pathbuf), "scbus%d", pathid);
324 for (hit = 0; (i = resource_locate(i, periph_name)) != -1; hit = 0) {
325 dname = resource_query_name(i);
326 dunit = resource_query_unit(i);
327 if (resource_string_value(dname, dunit, "at", &strval) == 0) {
328 if (strcmp(strval, pathbuf) != 0)
332 if (resource_int_value(dname, dunit, "target", &val) == 0) {
337 if (resource_int_value(dname, dunit, "lun", &val) == 0) {
349 * Either start from 0 looking for the next unit or from
350 * the unit number given in the resource config. This way,
351 * if we have wildcard matches, we don't return the same
354 unit = camperiphnextunit(p_drv, unit, /*wired*/hit, pathid,
361 cam_periph_invalidate(struct cam_periph *periph)
364 * We only call this routine the first time a peripheral is
365 * invalidated. The oninvalidate() routine is always called in
366 * a critical section.
369 if (((periph->flags & CAM_PERIPH_INVALID) == 0)
370 && (periph->periph_oninval != NULL))
371 periph->periph_oninval(periph);
373 periph->flags |= CAM_PERIPH_INVALID;
374 periph->flags &= ~CAM_PERIPH_NEW_DEV_FOUND;
376 if (periph->refcount == 0)
377 camperiphfree(periph);
378 else if (periph->refcount < 0)
379 printf("cam_invalidate_periph: refcount < 0!!\n");
384 camperiphfree(struct cam_periph *periph)
386 struct periph_driver **p_drv;
388 SET_FOREACH(p_drv, periphdriver_set) {
389 if (strcmp((*p_drv)->driver_name, periph->periph_name) == 0)
393 if (*p_drv == NULL) {
394 printf("camperiphfree: attempt to free "
395 "non-existant periph: %s\n", periph->periph_name);
399 if (periph->periph_dtor != NULL)
400 periph->periph_dtor(periph);
403 TAILQ_REMOVE(&(*p_drv)->units, periph, unit_links);
404 (*p_drv)->generation++;
407 xpt_remove_periph(periph);
409 if (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) {
413 switch (periph->deferred_ac) {
414 case AC_FOUND_DEVICE:
415 ccb.ccb_h.func_code = XPT_GDEV_TYPE;
416 xpt_setup_ccb(&ccb.ccb_h, periph->path, /*priority*/ 1);
420 case AC_PATH_REGISTERED:
421 ccb.ccb_h.func_code = XPT_PATH_INQ;
422 xpt_setup_ccb(&ccb.ccb_h, periph->path, /*priority*/ 1);
430 periph->deferred_callback(NULL, periph->deferred_ac,
433 xpt_free_path(periph->path);
434 free(periph, M_DEVBUF);
438 * Wait interruptibly for an exclusive lock.
441 cam_periph_lock(struct cam_periph *periph, int flags)
445 while ((periph->flags & CAM_PERIPH_LOCKED) != 0) {
446 periph->flags |= CAM_PERIPH_LOCK_WANTED;
447 if ((error = tsleep(periph, flags, "caplck", 0)) != 0)
451 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
454 periph->flags |= CAM_PERIPH_LOCKED;
459 * Unlock and wake up any waiters.
462 cam_periph_unlock(struct cam_periph *periph)
464 periph->flags &= ~CAM_PERIPH_LOCKED;
465 if ((periph->flags & CAM_PERIPH_LOCK_WANTED) != 0) {
466 periph->flags &= ~CAM_PERIPH_LOCK_WANTED;
470 cam_periph_release(periph);
474 * Map user virtual pointers into kernel virtual address space, so we can
475 * access the memory. This won't work on physical pointers, for now it's
476 * up to the caller to check for that. (XXX KDM -- should we do that here
477 * instead?) This also only works for up to MAXPHYS memory. Since we use
478 * buffers to map stuff in and out, we're limited to the buffer size.
481 cam_periph_mapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo)
484 buf_cmd_t cmd[CAM_PERIPH_MAXMAPS];
485 u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
486 u_int32_t lengths[CAM_PERIPH_MAXMAPS];
487 u_int32_t dirs[CAM_PERIPH_MAXMAPS];
489 switch(ccb->ccb_h.func_code) {
491 if (ccb->cdm.match_buf_len == 0) {
492 printf("cam_periph_mapmem: invalid match buffer "
496 if (ccb->cdm.pattern_buf_len > 0) {
497 data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
498 lengths[0] = ccb->cdm.pattern_buf_len;
499 dirs[0] = CAM_DIR_OUT;
500 data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
501 lengths[1] = ccb->cdm.match_buf_len;
502 dirs[1] = CAM_DIR_IN;
505 data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
506 lengths[0] = ccb->cdm.match_buf_len;
507 dirs[0] = CAM_DIR_IN;
512 case XPT_CONT_TARGET_IO:
513 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
516 data_ptrs[0] = &ccb->csio.data_ptr;
517 lengths[0] = ccb->csio.dxfer_len;
518 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
523 break; /* NOTREACHED */
527 * Check the transfer length and permissions first, so we don't
528 * have to unmap any previously mapped buffers.
530 for (i = 0; i < numbufs; i++) {
532 * Its kinda bogus, we need a R+W command. For now the
533 * buffer needs some sort of command. Use BUF_CMD_WRITE
534 * to indicate a write and BUF_CMD_READ to indicate R+W.
536 cmd[i] = BUF_CMD_WRITE;
539 * The userland data pointer passed in may not be page
540 * aligned. vmapbuf() truncates the address to a page
541 * boundary, so if the address isn't page aligned, we'll
542 * need enough space for the given transfer length, plus
543 * whatever extra space is necessary to make it to the page
547 (((vm_offset_t)(*data_ptrs[i])) & PAGE_MASK)) > DFLTPHYS){
548 printf("cam_periph_mapmem: attempt to map %lu bytes, "
549 "which is greater than DFLTPHYS(%d)\n",
551 (((vm_offset_t)(*data_ptrs[i])) & PAGE_MASK)),
556 if (dirs[i] & CAM_DIR_OUT) {
557 if (!useracc(*data_ptrs[i], lengths[i],
559 printf("cam_periph_mapmem: error, "
560 "address %p, length %lu isn't "
561 "user accessible for READ\n",
562 (void *)*data_ptrs[i],
568 if (dirs[i] & CAM_DIR_IN) {
569 cmd[i] = BUF_CMD_READ;
570 if (!useracc(*data_ptrs[i], lengths[i],
572 printf("cam_periph_mapmem: error, "
573 "address %p, length %lu isn't "
574 "user accessible for WRITE\n",
575 (void *)*data_ptrs[i],
584 for (i = 0; i < numbufs; i++) {
588 mapinfo->bp[i] = getpbuf(NULL);
590 /* save the buffer's data address */
591 mapinfo->bp[i]->b_saveaddr = mapinfo->bp[i]->b_data;
593 /* put our pointer in the data slot */
594 mapinfo->bp[i]->b_data = *data_ptrs[i];
596 /* set the transfer length, we know it's < DFLTPHYS */
597 mapinfo->bp[i]->b_bufsize = lengths[i];
600 mapinfo->bp[i]->b_cmd = cmd[i];
602 /* map the buffer into kernel memory */
603 if (vmapbuf(mapinfo->bp[i]) < 0) {
604 printf("cam_periph_mapmem: error, "
605 "address %p, length %lu isn't "
606 "user accessible any more\n",
607 (void *)*data_ptrs[i],
609 for (j = 0; j < i; ++j) {
610 *data_ptrs[j] = mapinfo->bp[j]->b_saveaddr;
611 relpbuf(mapinfo->bp[j], NULL);
616 /* set our pointer to the new mapped area */
617 *data_ptrs[i] = mapinfo->bp[i]->b_data;
619 mapinfo->num_bufs_used++;
626 * Unmap memory segments mapped into kernel virtual address space by
627 * cam_periph_mapmem().
630 cam_periph_unmapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo)
633 u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
635 if (mapinfo->num_bufs_used <= 0) {
636 /* allow ourselves to be swapped once again */
640 switch (ccb->ccb_h.func_code) {
642 numbufs = min(mapinfo->num_bufs_used, 2);
645 data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
647 data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
648 data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
652 case XPT_CONT_TARGET_IO:
653 data_ptrs[0] = &ccb->csio.data_ptr;
654 numbufs = min(mapinfo->num_bufs_used, 1);
657 /* allow ourselves to be swapped once again */
659 break; /* NOTREACHED */
662 for (i = 0; i < numbufs; i++) {
663 /* Set the user's pointer back to the original value */
664 *data_ptrs[i] = mapinfo->bp[i]->b_saveaddr;
666 /* unmap the buffer */
667 vunmapbuf(mapinfo->bp[i]);
669 /* release the buffer */
670 relpbuf(mapinfo->bp[i], NULL);
673 /* allow ourselves to be swapped once again */
677 cam_periph_getccb(struct cam_periph *periph, u_int32_t priority)
679 struct ccb_hdr *ccb_h;
681 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering cdgetccb\n"));
685 while (periph->ccb_list.slh_first == NULL) {
686 if (periph->immediate_priority > priority)
687 periph->immediate_priority = priority;
688 xpt_schedule(periph, priority);
689 if ((periph->ccb_list.slh_first != NULL)
690 && (periph->ccb_list.slh_first->pinfo.priority == priority))
692 tsleep(&periph->ccb_list, 0, "cgticb", 0);
695 ccb_h = periph->ccb_list.slh_first;
696 SLIST_REMOVE_HEAD(&periph->ccb_list, periph_links.sle);
698 return ((union ccb *)ccb_h);
702 cam_periph_ccbwait(union ccb *ccb)
705 if ((ccb->ccb_h.pinfo.index != CAM_UNQUEUED_INDEX)
706 || ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG))
707 tsleep(&ccb->ccb_h.cbfcnp, 0, "cbwait", 0);
712 cam_periph_ioctl(struct cam_periph *periph, int cmd, caddr_t addr,
713 int (*error_routine)(union ccb *ccb,
715 u_int32_t sense_flags))
725 ccb = cam_periph_getccb(periph, /* priority */ 1);
726 xpt_setup_ccb(&ccb->ccb_h,
729 ccb->ccb_h.func_code = XPT_GDEVLIST;
732 * Basically, the point of this is that we go through
733 * getting the list of devices, until we find a passthrough
734 * device. In the current version of the CAM code, the
735 * only way to determine what type of device we're dealing
736 * with is by its name.
740 ccb->cgdl.status = CAM_GDEVLIST_MORE_DEVS;
741 while (ccb->cgdl.status == CAM_GDEVLIST_MORE_DEVS) {
743 /* we want the next device in the list */
745 if (strncmp(ccb->cgdl.periph_name,
751 if ((ccb->cgdl.status == CAM_GDEVLIST_LAST_DEVICE) &&
753 ccb->cgdl.periph_name[0] = '\0';
754 ccb->cgdl.unit_number = 0;
759 /* copy the result back out */
760 bcopy(ccb, addr, sizeof(union ccb));
762 /* and release the ccb */
763 xpt_release_ccb(ccb);
774 cam_periph_runccb(union ccb *ccb,
775 int (*error_routine)(union ccb *ccb,
777 u_int32_t sense_flags),
778 cam_flags camflags, u_int32_t sense_flags,
786 * If the user has supplied a stats structure, and if we understand
787 * this particular type of ccb, record the transaction start.
789 if ((ds != NULL) && (ccb->ccb_h.func_code == XPT_SCSI_IO))
790 devstat_start_transaction(ds);
795 cam_periph_ccbwait(ccb);
796 if ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP)
798 else if (error_routine != NULL)
799 error = (*error_routine)(ccb, camflags, sense_flags);
803 } while (error == ERESTART);
805 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
806 cam_release_devq(ccb->ccb_h.path,
810 /* getcount_only */ FALSE);
812 if ((ds != NULL) && (ccb->ccb_h.func_code == XPT_SCSI_IO))
813 devstat_end_transaction(ds,
815 ccb->csio.tag_action & 0xf,
816 ((ccb->ccb_h.flags & CAM_DIR_MASK) ==
817 CAM_DIR_NONE) ? DEVSTAT_NO_DATA :
818 (ccb->ccb_h.flags & CAM_DIR_OUT) ?
826 cam_freeze_devq(struct cam_path *path)
828 struct ccb_hdr ccb_h;
830 xpt_setup_ccb(&ccb_h, path, /*priority*/1);
831 ccb_h.func_code = XPT_NOOP;
832 ccb_h.flags = CAM_DEV_QFREEZE;
833 xpt_action((union ccb *)&ccb_h);
837 cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
838 u_int32_t openings, u_int32_t timeout,
841 struct ccb_relsim crs;
843 xpt_setup_ccb(&crs.ccb_h, path,
845 crs.ccb_h.func_code = XPT_REL_SIMQ;
846 crs.ccb_h.flags = getcount_only ? CAM_DEV_QFREEZE : 0;
847 crs.release_flags = relsim_flags;
848 crs.openings = openings;
849 crs.release_timeout = timeout;
850 xpt_action((union ccb *)&crs);
851 return (crs.qfrozen_cnt);
854 #define saved_ccb_ptr ppriv_ptr0
856 camperiphdone(struct cam_periph *periph, union ccb *done_ccb)
861 struct scsi_start_stop_unit *scsi_cmd;
862 u_int32_t relsim_flags, timeout;
863 u_int32_t qfrozen_cnt;
865 status = done_ccb->ccb_h.status;
866 frozen = (status & CAM_DEV_QFRZN) != 0;
867 sense = (status & CAM_AUTOSNS_VALID) != 0;
868 status &= CAM_STATUS_MASK;
874 * Unfreeze the queue once if it is already frozen..
877 qfrozen_cnt = cam_release_devq(done_ccb->ccb_h.path,
889 * If we have successfully taken a device from the not
890 * ready to ready state, re-scan the device and re-get the
891 * inquiry information. Many devices (mostly disks) don't
892 * properly report their inquiry information unless they
895 if (done_ccb->ccb_h.func_code == XPT_SCSI_IO) {
896 scsi_cmd = (struct scsi_start_stop_unit *)
897 &done_ccb->csio.cdb_io.cdb_bytes;
899 if (scsi_cmd->opcode == START_STOP_UNIT)
900 xpt_async(AC_INQ_CHANGED,
901 done_ccb->ccb_h.path, NULL);
903 bcopy(done_ccb->ccb_h.saved_ccb_ptr, done_ccb,
906 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
908 xpt_action(done_ccb);
911 case CAM_SCSI_STATUS_ERROR:
912 scsi_cmd = (struct scsi_start_stop_unit *)
913 &done_ccb->csio.cdb_io.cdb_bytes;
915 struct scsi_sense_data *sense;
916 int error_code, sense_key, asc, ascq;
918 sense = &done_ccb->csio.sense_data;
919 scsi_extract_sense(sense, &error_code,
920 &sense_key, &asc, &ascq);
923 * If the error is "invalid field in CDB",
924 * and the load/eject flag is set, turn the
925 * flag off and try again. This is just in
926 * case the drive in question barfs on the
927 * load eject flag. The CAM code should set
928 * the load/eject flag by default for
933 * Should we check to see what the specific
934 * scsi status is?? Or does it not matter
935 * since we already know that there was an
936 * error, and we know what the specific
937 * error code was, and we know what the
940 if ((scsi_cmd->opcode == START_STOP_UNIT) &&
941 ((scsi_cmd->how & SSS_LOEJ) != 0) &&
942 (asc == 0x24) && (ascq == 0x00) &&
943 (done_ccb->ccb_h.retry_count > 0)) {
945 scsi_cmd->how &= ~SSS_LOEJ;
947 xpt_action(done_ccb);
949 } else if (done_ccb->ccb_h.retry_count > 0) {
951 * In this case, the error recovery
952 * command failed, but we've got
953 * some retries left on it. Give
957 /* set the timeout to .5 sec */
959 RELSIM_RELEASE_AFTER_TIMEOUT;
962 xpt_action(done_ccb);
968 * Copy the original CCB back and
969 * send it back to the caller.
971 bcopy(done_ccb->ccb_h.saved_ccb_ptr,
972 done_ccb, sizeof(union ccb));
974 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
976 xpt_action(done_ccb);
980 * Eh?? The command failed, but we don't
981 * have any sense. What's up with that?
982 * Fire the CCB again to return it to the
985 bcopy(done_ccb->ccb_h.saved_ccb_ptr,
986 done_ccb, sizeof(union ccb));
988 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
990 xpt_action(done_ccb);
995 bcopy(done_ccb->ccb_h.saved_ccb_ptr, done_ccb,
998 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
1000 xpt_action(done_ccb);
1005 /* decrement the retry count */
1006 if (done_ccb->ccb_h.retry_count > 0)
1007 done_ccb->ccb_h.retry_count--;
1009 qfrozen_cnt = cam_release_devq(done_ccb->ccb_h.path,
1010 /*relsim_flags*/relsim_flags,
1013 /*getcount_only*/0);
1017 * Generic Async Event handler. Peripheral drivers usually
1018 * filter out the events that require personal attention,
1019 * and leave the rest to this function.
1022 cam_periph_async(struct cam_periph *periph, u_int32_t code,
1023 struct cam_path *path, void *arg)
1026 case AC_LOST_DEVICE:
1027 cam_periph_invalidate(periph);
1032 cam_periph_bus_settle(periph, SCSI_DELAY);
1041 cam_periph_bus_settle(struct cam_periph *periph, u_int bus_settle)
1043 struct ccb_getdevstats cgds;
1045 xpt_setup_ccb(&cgds.ccb_h, periph->path, /*priority*/1);
1046 cgds.ccb_h.func_code = XPT_GDEV_STATS;
1047 xpt_action((union ccb *)&cgds);
1048 cam_periph_freeze_after_event(periph, &cgds.last_reset, bus_settle);
1052 cam_periph_freeze_after_event(struct cam_periph *periph,
1053 struct timeval* event_time, u_int duration_ms)
1055 struct timeval delta;
1056 struct timeval duration_tv;
1058 microuptime(&delta);
1059 timevalsub(&delta, event_time);
1060 duration_tv.tv_sec = duration_ms / 1000;
1061 duration_tv.tv_usec = (duration_ms % 1000) * 1000;
1062 if (timevalcmp(&delta, &duration_tv, <)) {
1063 timevalsub(&duration_tv, &delta);
1065 duration_ms = duration_tv.tv_sec * 1000;
1066 duration_ms += duration_tv.tv_usec / 1000;
1067 cam_freeze_devq(periph->path);
1068 cam_release_devq(periph->path,
1069 RELSIM_RELEASE_AFTER_TIMEOUT,
1071 /*timeout*/duration_ms,
1072 /*getcount_only*/0);
1078 * Generic error handler. Peripheral drivers usually filter
1079 * out the errors that they handle in a unique mannor, then
1080 * call this function.
1083 cam_periph_error(union ccb *ccb, cam_flags camflags,
1084 u_int32_t sense_flags, union ccb *save_ccb)
1092 u_int32_t relsim_flags;
1095 status = ccb->ccb_h.status;
1096 frozen = (status & CAM_DEV_QFRZN) != 0;
1097 sense = (status & CAM_AUTOSNS_VALID) != 0;
1098 status &= CAM_STATUS_MASK;
1103 /* decrement the number of retries */
1104 retry = ccb->ccb_h.retry_count > 0;
1106 ccb->ccb_h.retry_count--;
1109 case CAM_AUTOSENSE_FAIL:
1110 case CAM_SCSI_STATUS_ERROR:
1112 switch (ccb->csio.scsi_status) {
1113 case SCSI_STATUS_OK:
1114 case SCSI_STATUS_COND_MET:
1115 case SCSI_STATUS_INTERMED:
1116 case SCSI_STATUS_INTERMED_COND_MET:
1119 case SCSI_STATUS_CMD_TERMINATED:
1120 case SCSI_STATUS_CHECK_COND:
1122 struct scsi_sense_data *sense;
1123 int error_code, sense_key, asc, ascq;
1124 struct cam_periph *periph;
1125 scsi_sense_action err_action;
1126 struct ccb_getdev cgd;
1128 sense = &ccb->csio.sense_data;
1129 scsi_extract_sense(sense, &error_code,
1130 &sense_key, &asc, &ascq);
1131 periph = xpt_path_periph(ccb->ccb_h.path);
1134 * Grab the inquiry data for this device.
1136 xpt_setup_ccb(&cgd.ccb_h, ccb->ccb_h.path,
1138 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1139 xpt_action((union ccb *)&cgd);
1141 err_action = scsi_error_action(asc, ascq,
1145 * Send a Test Unit Ready to the device.
1146 * If the 'many' flag is set, we send 120
1147 * test unit ready commands, one every half
1148 * second. Otherwise, we just send one TUR.
1149 * We only want to do this if the retry
1150 * count has not been exhausted.
1152 if (((err_action & SS_MASK) == SS_TUR)
1154 && ccb->ccb_h.retry_count > 0) {
1157 * Since error recovery is already
1158 * in progress, don't attempt to
1159 * process this error. It is probably
1160 * related to the error that caused
1161 * the currently active error recovery
1162 * action. Also, we only have
1163 * space for one saved CCB, so if we
1164 * had two concurrent error recovery
1165 * actions, we would end up
1166 * over-writing one error recovery
1167 * CCB with another one.
1170 CAM_PERIPH_RECOVERY_INPROG) {
1176 CAM_PERIPH_RECOVERY_INPROG;
1178 /* decrement the number of retries */
1180 SSQ_DECREMENT_COUNT) != 0) {
1182 ccb->ccb_h.retry_count--;
1185 bcopy(ccb, save_ccb, sizeof(*save_ccb));
1188 * We retry this one every half
1189 * second for a minute. If the
1190 * device hasn't become ready in a
1191 * minute's time, it's unlikely to
1192 * ever become ready. If the table
1193 * doesn't specify SSQ_MANY, we can
1194 * only try this once. Oh well.
1196 if ((err_action & SSQ_MANY) != 0)
1197 scsi_test_unit_ready(&ccb->csio,
1204 scsi_test_unit_ready(&ccb->csio,
1211 /* release the queue after .5 sec. */
1213 RELSIM_RELEASE_AFTER_TIMEOUT;
1216 * Drop the priority to 0 so that
1217 * we are the first to execute. Also
1218 * freeze the queue after this command
1219 * is sent so that we can restore the
1220 * old csio and have it queued in the
1221 * proper order before we let normal
1222 * transactions go to the drive.
1224 ccb->ccb_h.pinfo.priority = 0;
1225 ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1228 * Save a pointer to the original
1229 * CCB in the new CCB.
1231 ccb->ccb_h.saved_ccb_ptr = save_ccb;
1236 * Send a start unit command to the device,
1237 * and then retry the command. We only
1238 * want to do this if the retry count has
1239 * not been exhausted. If the user
1240 * specified 0 retries, then we follow
1241 * their request and do not retry.
1243 else if (((err_action & SS_MASK) == SS_START)
1245 && ccb->ccb_h.retry_count > 0) {
1249 * Only one error recovery action
1250 * at a time. See above.
1253 CAM_PERIPH_RECOVERY_INPROG) {
1259 CAM_PERIPH_RECOVERY_INPROG;
1261 /* decrement the number of retries */
1263 ccb->ccb_h.retry_count--;
1266 * Check for removable media and
1267 * set load/eject flag
1270 if (SID_IS_REMOVABLE(&cgd.inq_data))
1276 * Attempt to start the drive up.
1278 * Save the current ccb so it can
1279 * be restored and retried once the
1280 * drive is started up.
1282 bcopy(ccb, save_ccb, sizeof(*save_ccb));
1284 scsi_start_stop(&ccb->csio,
1294 * Drop the priority to 0 so that
1295 * we are the first to execute. Also
1296 * freeze the queue after this command
1297 * is sent so that we can restore the
1298 * old csio and have it queued in the
1299 * proper order before we let normal
1300 * transactions go to the drive.
1302 ccb->ccb_h.pinfo.priority = 0;
1303 ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1306 * Save a pointer to the original
1307 * CCB in the new CCB.
1309 ccb->ccb_h.saved_ccb_ptr = save_ccb;
1312 } else if ((sense_flags & SF_RETRY_UA) != 0) {
1314 * XXX KDM this is a *horrible*
1317 error = scsi_interpret_sense(ccb,
1326 * Theoretically, this code should send a
1327 * test unit ready to the given device, and
1328 * if it returns and error, send a start
1329 * unit command. Since we don't yet have
1330 * the capability to do two-command error
1331 * recovery, just send a start unit.
1334 else if (((err_action & SS_MASK) == SS_TURSTART)
1336 && ccb->ccb_h.retry_count > 0) {
1340 * Only one error recovery action
1341 * at a time. See above.
1344 CAM_PERIPH_RECOVERY_INPROG) {
1350 CAM_PERIPH_RECOVERY_INPROG;
1352 /* decrement the number of retries */
1354 ccb->ccb_h.retry_count--;
1357 * Check for removable media and
1358 * set load/eject flag
1361 if (SID_IS_REMOVABLE(&cgd.inq_data))
1367 * Attempt to start the drive up.
1369 * Save the current ccb so it can
1370 * be restored and retried once the
1371 * drive is started up.
1373 bcopy(ccb, save_ccb, sizeof(*save_ccb));
1375 scsi_start_stop(&ccb->csio,
1385 /* release the queue after .5 sec. */
1387 RELSIM_RELEASE_AFTER_TIMEOUT;
1390 * Drop the priority to 0 so that
1391 * we are the first to execute. Also
1392 * freeze the queue after this command
1393 * is sent so that we can restore the
1394 * old csio and have it queued in the
1395 * proper order before we let normal
1396 * transactions go to the drive.
1398 ccb->ccb_h.pinfo.priority = 0;
1399 ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1402 * Save a pointer to the original
1403 * CCB in the new CCB.
1405 ccb->ccb_h.saved_ccb_ptr = save_ccb;
1409 error = scsi_interpret_sense(ccb,
1416 } else if (ccb->csio.scsi_status ==
1417 SCSI_STATUS_CHECK_COND
1418 && status != CAM_AUTOSENSE_FAIL) {
1419 /* no point in decrementing the retry count */
1420 panic("cam_periph_error: scsi status of "
1421 "CHECK COND returned but no sense "
1422 "information is availible. "
1423 "Controller should have returned "
1424 "CAM_AUTOSENSE_FAILED");
1427 } else if (ccb->ccb_h.retry_count == 0) {
1429 * XXX KDM shouldn't there be a better
1430 * argument to return??
1434 /* decrement the number of retries */
1435 retry = ccb->ccb_h.retry_count > 0;
1437 ccb->ccb_h.retry_count--;
1439 * If it was aborted with no
1440 * clue as to the reason, just
1446 case SCSI_STATUS_QUEUE_FULL:
1449 struct ccb_getdevstats cgds;
1452 * First off, find out what the current
1453 * transaction counts are.
1455 xpt_setup_ccb(&cgds.ccb_h,
1458 cgds.ccb_h.func_code = XPT_GDEV_STATS;
1459 xpt_action((union ccb *)&cgds);
1462 * If we were the only transaction active, treat
1463 * the QUEUE FULL as if it were a BUSY condition.
1465 if (cgds.dev_active != 0) {
1469 * Reduce the number of openings to
1470 * be 1 less than the amount it took
1471 * to get a queue full bounded by the
1472 * minimum allowed tag count for this
1476 cgds.dev_active+cgds.dev_openings;
1477 openings = cgds.dev_active;
1478 if (openings < cgds.mintags)
1479 openings = cgds.mintags;
1480 if (openings < total_openings)
1481 relsim_flags = RELSIM_ADJUST_OPENINGS;
1484 * Some devices report queue full for
1485 * temporary resource shortages. For
1486 * this reason, we allow a minimum
1487 * tag count to be entered via a
1488 * quirk entry to prevent the queue
1489 * count on these devices from falling
1490 * to a pessimisticly low value. We
1491 * still wait for the next successful
1492 * completion, however, before queueing
1493 * more transactions to the device.
1496 RELSIM_RELEASE_AFTER_CMDCMPLT;
1504 case SCSI_STATUS_BUSY:
1506 * Restart the queue after either another
1507 * command completes or a 1 second timeout.
1508 * If we have any retries left, that is.
1510 retry = ccb->ccb_h.retry_count > 0;
1512 ccb->ccb_h.retry_count--;
1514 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT
1515 | RELSIM_RELEASE_AFTER_CMDCMPLT;
1521 case SCSI_STATUS_RESERV_CONFLICT:
1529 case CAM_REQ_CMP_ERR:
1530 case CAM_CMD_TIMEOUT:
1531 case CAM_UNEXP_BUSFREE:
1532 case CAM_UNCOR_PARITY:
1533 case CAM_DATA_RUN_ERR:
1534 /* decrement the number of retries */
1535 retry = ccb->ccb_h.retry_count > 0;
1537 ccb->ccb_h.retry_count--;
1545 case CAM_MSG_REJECT_REC:
1546 /* XXX Don't know that these are correct */
1549 case CAM_SEL_TIMEOUT:
1553 * A single selection timeout should not be enough
1554 * to invalidate a device. We should retry for multiple
1555 * seconds assuming this isn't a probe. We'll probably
1556 * need a special flag for that.
1559 struct cam_path *newpath;
1561 /* Should we do more if we can't create the path?? */
1562 if (xpt_create_path(&newpath, xpt_path_periph(ccb->ccb_h.path),
1563 xpt_path_path_id(ccb->ccb_h.path),
1564 xpt_path_target_id(ccb->ccb_h.path),
1565 CAM_LUN_WILDCARD) != CAM_REQ_CMP)
1568 * Let peripheral drivers know that this device has gone
1571 xpt_async(AC_LOST_DEVICE, newpath, NULL);
1572 xpt_free_path(newpath);
1574 if ((sense_flags & SF_RETRY_SELTO) != 0) {
1575 retry = ccb->ccb_h.retry_count > 0;
1577 ccb->ccb_h.retry_count--;
1580 * Wait half a second to give the device
1581 * time to recover before we try again.
1583 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1593 case CAM_REQ_INVALID:
1594 case CAM_PATH_INVALID:
1595 case CAM_DEV_NOT_THERE:
1597 case CAM_PROVIDE_FAIL:
1598 case CAM_REQ_TOO_BIG:
1601 case CAM_SCSI_BUS_RESET:
1603 case CAM_REQUEUE_REQ:
1604 /* Unconditional requeue, dammit */
1607 case CAM_RESRC_UNAVAIL:
1611 /* decrement the number of retries */
1612 retry = ccb->ccb_h.retry_count > 0;
1614 ccb->ccb_h.retry_count--;
1617 /* Check the sense codes */
1623 /* Attempt a retry */
1624 if (error == ERESTART || error == 0) {
1626 ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1628 if (error == ERESTART)
1632 cam_release_devq(ccb->ccb_h.path,
1636 /*getcount_only*/0);