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.11 2005/06/02 20:40:29 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 int flags[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++) {
535 * The userland data pointer passed in may not be page
536 * aligned. vmapbuf() truncates the address to a page
537 * boundary, so if the address isn't page aligned, we'll
538 * need enough space for the given transfer length, plus
539 * whatever extra space is necessary to make it to the page
543 (((vm_offset_t)(*data_ptrs[i])) & PAGE_MASK)) > DFLTPHYS){
544 printf("cam_periph_mapmem: attempt to map %lu bytes, "
545 "which is greater than DFLTPHYS(%d)\n",
547 (((vm_offset_t)(*data_ptrs[i])) & PAGE_MASK)),
552 if (dirs[i] & CAM_DIR_OUT) {
554 if (!useracc(*data_ptrs[i], lengths[i],
556 printf("cam_periph_mapmem: error, "
557 "address %p, length %lu isn't "
558 "user accessible for READ\n",
559 (void *)*data_ptrs[i],
566 * XXX this check is really bogus, since B_WRITE currently
567 * is all 0's, and so it is "set" all the time.
569 if (dirs[i] & CAM_DIR_IN) {
571 if (!useracc(*data_ptrs[i], lengths[i],
573 printf("cam_periph_mapmem: error, "
574 "address %p, length %lu isn't "
575 "user accessible for WRITE\n",
576 (void *)*data_ptrs[i],
585 for (i = 0; i < numbufs; i++) {
589 mapinfo->bp[i] = getpbuf(NULL);
591 /* save the buffer's data address */
592 mapinfo->bp[i]->b_saveaddr = mapinfo->bp[i]->b_data;
594 /* put our pointer in the data slot */
595 mapinfo->bp[i]->b_data = *data_ptrs[i];
597 /* set the transfer length, we know it's < DFLTPHYS */
598 mapinfo->bp[i]->b_bufsize = lengths[i];
601 mapinfo->bp[i]->b_flags = flags[i] | B_PHYS;
603 /* map the buffer into kernel memory */
604 if (vmapbuf(mapinfo->bp[i]) < 0) {
605 printf("cam_periph_mapmem: error, "
606 "address %p, length %lu isn't "
607 "user accessible any more\n",
608 (void *)*data_ptrs[i],
610 for (j = 0; j < i; ++j) {
611 *data_ptrs[j] = mapinfo->bp[j]->b_saveaddr;
612 mapinfo->bp[j]->b_flags &= ~B_PHYS;
613 relpbuf(mapinfo->bp[j], NULL);
618 /* set our pointer to the new mapped area */
619 *data_ptrs[i] = mapinfo->bp[i]->b_data;
621 mapinfo->num_bufs_used++;
628 * Unmap memory segments mapped into kernel virtual address space by
629 * cam_periph_mapmem().
632 cam_periph_unmapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo)
635 u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
637 if (mapinfo->num_bufs_used <= 0) {
638 /* allow ourselves to be swapped once again */
642 switch (ccb->ccb_h.func_code) {
644 numbufs = min(mapinfo->num_bufs_used, 2);
647 data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
649 data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
650 data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
654 case XPT_CONT_TARGET_IO:
655 data_ptrs[0] = &ccb->csio.data_ptr;
656 numbufs = min(mapinfo->num_bufs_used, 1);
659 /* allow ourselves to be swapped once again */
661 break; /* NOTREACHED */
664 for (i = 0; i < numbufs; i++) {
665 /* Set the user's pointer back to the original value */
666 *data_ptrs[i] = mapinfo->bp[i]->b_saveaddr;
668 /* unmap the buffer */
669 vunmapbuf(mapinfo->bp[i]);
671 /* clear the flags we set above */
672 mapinfo->bp[i]->b_flags &= ~B_PHYS;
674 /* release the buffer */
675 relpbuf(mapinfo->bp[i], NULL);
678 /* allow ourselves to be swapped once again */
682 cam_periph_getccb(struct cam_periph *periph, u_int32_t priority)
684 struct ccb_hdr *ccb_h;
686 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering cdgetccb\n"));
690 while (periph->ccb_list.slh_first == NULL) {
691 if (periph->immediate_priority > priority)
692 periph->immediate_priority = priority;
693 xpt_schedule(periph, priority);
694 if ((periph->ccb_list.slh_first != NULL)
695 && (periph->ccb_list.slh_first->pinfo.priority == priority))
697 tsleep(&periph->ccb_list, 0, "cgticb", 0);
700 ccb_h = periph->ccb_list.slh_first;
701 SLIST_REMOVE_HEAD(&periph->ccb_list, periph_links.sle);
703 return ((union ccb *)ccb_h);
707 cam_periph_ccbwait(union ccb *ccb)
710 if ((ccb->ccb_h.pinfo.index != CAM_UNQUEUED_INDEX)
711 || ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG))
712 tsleep(&ccb->ccb_h.cbfcnp, 0, "cbwait", 0);
717 cam_periph_ioctl(struct cam_periph *periph, int cmd, caddr_t addr,
718 int (*error_routine)(union ccb *ccb,
720 u_int32_t sense_flags))
730 ccb = cam_periph_getccb(periph, /* priority */ 1);
731 xpt_setup_ccb(&ccb->ccb_h,
734 ccb->ccb_h.func_code = XPT_GDEVLIST;
737 * Basically, the point of this is that we go through
738 * getting the list of devices, until we find a passthrough
739 * device. In the current version of the CAM code, the
740 * only way to determine what type of device we're dealing
741 * with is by its name.
745 ccb->cgdl.status = CAM_GDEVLIST_MORE_DEVS;
746 while (ccb->cgdl.status == CAM_GDEVLIST_MORE_DEVS) {
748 /* we want the next device in the list */
750 if (strncmp(ccb->cgdl.periph_name,
756 if ((ccb->cgdl.status == CAM_GDEVLIST_LAST_DEVICE) &&
758 ccb->cgdl.periph_name[0] = '\0';
759 ccb->cgdl.unit_number = 0;
764 /* copy the result back out */
765 bcopy(ccb, addr, sizeof(union ccb));
767 /* and release the ccb */
768 xpt_release_ccb(ccb);
779 cam_periph_runccb(union ccb *ccb,
780 int (*error_routine)(union ccb *ccb,
782 u_int32_t sense_flags),
783 cam_flags camflags, u_int32_t sense_flags,
791 * If the user has supplied a stats structure, and if we understand
792 * this particular type of ccb, record the transaction start.
794 if ((ds != NULL) && (ccb->ccb_h.func_code == XPT_SCSI_IO))
795 devstat_start_transaction(ds);
800 cam_periph_ccbwait(ccb);
801 if ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP)
803 else if (error_routine != NULL)
804 error = (*error_routine)(ccb, camflags, sense_flags);
808 } while (error == ERESTART);
810 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
811 cam_release_devq(ccb->ccb_h.path,
815 /* getcount_only */ FALSE);
817 if ((ds != NULL) && (ccb->ccb_h.func_code == XPT_SCSI_IO))
818 devstat_end_transaction(ds,
820 ccb->csio.tag_action & 0xf,
821 ((ccb->ccb_h.flags & CAM_DIR_MASK) ==
822 CAM_DIR_NONE) ? DEVSTAT_NO_DATA :
823 (ccb->ccb_h.flags & CAM_DIR_OUT) ?
831 cam_freeze_devq(struct cam_path *path)
833 struct ccb_hdr ccb_h;
835 xpt_setup_ccb(&ccb_h, path, /*priority*/1);
836 ccb_h.func_code = XPT_NOOP;
837 ccb_h.flags = CAM_DEV_QFREEZE;
838 xpt_action((union ccb *)&ccb_h);
842 cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
843 u_int32_t openings, u_int32_t timeout,
846 struct ccb_relsim crs;
848 xpt_setup_ccb(&crs.ccb_h, path,
850 crs.ccb_h.func_code = XPT_REL_SIMQ;
851 crs.ccb_h.flags = getcount_only ? CAM_DEV_QFREEZE : 0;
852 crs.release_flags = relsim_flags;
853 crs.openings = openings;
854 crs.release_timeout = timeout;
855 xpt_action((union ccb *)&crs);
856 return (crs.qfrozen_cnt);
859 #define saved_ccb_ptr ppriv_ptr0
861 camperiphdone(struct cam_periph *periph, union ccb *done_ccb)
866 struct scsi_start_stop_unit *scsi_cmd;
867 u_int32_t relsim_flags, timeout;
868 u_int32_t qfrozen_cnt;
870 status = done_ccb->ccb_h.status;
871 frozen = (status & CAM_DEV_QFRZN) != 0;
872 sense = (status & CAM_AUTOSNS_VALID) != 0;
873 status &= CAM_STATUS_MASK;
879 * Unfreeze the queue once if it is already frozen..
882 qfrozen_cnt = cam_release_devq(done_ccb->ccb_h.path,
894 * If we have successfully taken a device from the not
895 * ready to ready state, re-scan the device and re-get the
896 * inquiry information. Many devices (mostly disks) don't
897 * properly report their inquiry information unless they
900 if (done_ccb->ccb_h.func_code == XPT_SCSI_IO) {
901 scsi_cmd = (struct scsi_start_stop_unit *)
902 &done_ccb->csio.cdb_io.cdb_bytes;
904 if (scsi_cmd->opcode == START_STOP_UNIT)
905 xpt_async(AC_INQ_CHANGED,
906 done_ccb->ccb_h.path, NULL);
908 bcopy(done_ccb->ccb_h.saved_ccb_ptr, done_ccb,
911 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
913 xpt_action(done_ccb);
916 case CAM_SCSI_STATUS_ERROR:
917 scsi_cmd = (struct scsi_start_stop_unit *)
918 &done_ccb->csio.cdb_io.cdb_bytes;
920 struct scsi_sense_data *sense;
921 int error_code, sense_key, asc, ascq;
923 sense = &done_ccb->csio.sense_data;
924 scsi_extract_sense(sense, &error_code,
925 &sense_key, &asc, &ascq);
928 * If the error is "invalid field in CDB",
929 * and the load/eject flag is set, turn the
930 * flag off and try again. This is just in
931 * case the drive in question barfs on the
932 * load eject flag. The CAM code should set
933 * the load/eject flag by default for
938 * Should we check to see what the specific
939 * scsi status is?? Or does it not matter
940 * since we already know that there was an
941 * error, and we know what the specific
942 * error code was, and we know what the
945 if ((scsi_cmd->opcode == START_STOP_UNIT) &&
946 ((scsi_cmd->how & SSS_LOEJ) != 0) &&
947 (asc == 0x24) && (ascq == 0x00) &&
948 (done_ccb->ccb_h.retry_count > 0)) {
950 scsi_cmd->how &= ~SSS_LOEJ;
952 xpt_action(done_ccb);
954 } else if (done_ccb->ccb_h.retry_count > 0) {
956 * In this case, the error recovery
957 * command failed, but we've got
958 * some retries left on it. Give
962 /* set the timeout to .5 sec */
964 RELSIM_RELEASE_AFTER_TIMEOUT;
967 xpt_action(done_ccb);
973 * Copy the original CCB back and
974 * send it back to the caller.
976 bcopy(done_ccb->ccb_h.saved_ccb_ptr,
977 done_ccb, sizeof(union ccb));
979 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
981 xpt_action(done_ccb);
985 * Eh?? The command failed, but we don't
986 * have any sense. What's up with that?
987 * Fire the CCB again to return it to the
990 bcopy(done_ccb->ccb_h.saved_ccb_ptr,
991 done_ccb, sizeof(union ccb));
993 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
995 xpt_action(done_ccb);
1000 bcopy(done_ccb->ccb_h.saved_ccb_ptr, done_ccb,
1003 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
1005 xpt_action(done_ccb);
1010 /* decrement the retry count */
1011 if (done_ccb->ccb_h.retry_count > 0)
1012 done_ccb->ccb_h.retry_count--;
1014 qfrozen_cnt = cam_release_devq(done_ccb->ccb_h.path,
1015 /*relsim_flags*/relsim_flags,
1018 /*getcount_only*/0);
1022 * Generic Async Event handler. Peripheral drivers usually
1023 * filter out the events that require personal attention,
1024 * and leave the rest to this function.
1027 cam_periph_async(struct cam_periph *periph, u_int32_t code,
1028 struct cam_path *path, void *arg)
1031 case AC_LOST_DEVICE:
1032 cam_periph_invalidate(periph);
1037 cam_periph_bus_settle(periph, SCSI_DELAY);
1046 cam_periph_bus_settle(struct cam_periph *periph, u_int bus_settle)
1048 struct ccb_getdevstats cgds;
1050 xpt_setup_ccb(&cgds.ccb_h, periph->path, /*priority*/1);
1051 cgds.ccb_h.func_code = XPT_GDEV_STATS;
1052 xpt_action((union ccb *)&cgds);
1053 cam_periph_freeze_after_event(periph, &cgds.last_reset, bus_settle);
1057 cam_periph_freeze_after_event(struct cam_periph *periph,
1058 struct timeval* event_time, u_int duration_ms)
1060 struct timeval delta;
1061 struct timeval duration_tv;
1063 microuptime(&delta);
1064 timevalsub(&delta, event_time);
1065 duration_tv.tv_sec = duration_ms / 1000;
1066 duration_tv.tv_usec = (duration_ms % 1000) * 1000;
1067 if (timevalcmp(&delta, &duration_tv, <)) {
1068 timevalsub(&duration_tv, &delta);
1070 duration_ms = duration_tv.tv_sec * 1000;
1071 duration_ms += duration_tv.tv_usec / 1000;
1072 cam_freeze_devq(periph->path);
1073 cam_release_devq(periph->path,
1074 RELSIM_RELEASE_AFTER_TIMEOUT,
1076 /*timeout*/duration_ms,
1077 /*getcount_only*/0);
1083 * Generic error handler. Peripheral drivers usually filter
1084 * out the errors that they handle in a unique mannor, then
1085 * call this function.
1088 cam_periph_error(union ccb *ccb, cam_flags camflags,
1089 u_int32_t sense_flags, union ccb *save_ccb)
1097 u_int32_t relsim_flags;
1100 status = ccb->ccb_h.status;
1101 frozen = (status & CAM_DEV_QFRZN) != 0;
1102 sense = (status & CAM_AUTOSNS_VALID) != 0;
1103 status &= CAM_STATUS_MASK;
1108 /* decrement the number of retries */
1109 retry = ccb->ccb_h.retry_count > 0;
1111 ccb->ccb_h.retry_count--;
1114 case CAM_AUTOSENSE_FAIL:
1115 case CAM_SCSI_STATUS_ERROR:
1117 switch (ccb->csio.scsi_status) {
1118 case SCSI_STATUS_OK:
1119 case SCSI_STATUS_COND_MET:
1120 case SCSI_STATUS_INTERMED:
1121 case SCSI_STATUS_INTERMED_COND_MET:
1124 case SCSI_STATUS_CMD_TERMINATED:
1125 case SCSI_STATUS_CHECK_COND:
1127 struct scsi_sense_data *sense;
1128 int error_code, sense_key, asc, ascq;
1129 struct cam_periph *periph;
1130 scsi_sense_action err_action;
1131 struct ccb_getdev cgd;
1133 sense = &ccb->csio.sense_data;
1134 scsi_extract_sense(sense, &error_code,
1135 &sense_key, &asc, &ascq);
1136 periph = xpt_path_periph(ccb->ccb_h.path);
1139 * Grab the inquiry data for this device.
1141 xpt_setup_ccb(&cgd.ccb_h, ccb->ccb_h.path,
1143 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1144 xpt_action((union ccb *)&cgd);
1146 err_action = scsi_error_action(asc, ascq,
1150 * Send a Test Unit Ready to the device.
1151 * If the 'many' flag is set, we send 120
1152 * test unit ready commands, one every half
1153 * second. Otherwise, we just send one TUR.
1154 * We only want to do this if the retry
1155 * count has not been exhausted.
1157 if (((err_action & SS_MASK) == SS_TUR)
1159 && ccb->ccb_h.retry_count > 0) {
1162 * Since error recovery is already
1163 * in progress, don't attempt to
1164 * process this error. It is probably
1165 * related to the error that caused
1166 * the currently active error recovery
1167 * action. Also, we only have
1168 * space for one saved CCB, so if we
1169 * had two concurrent error recovery
1170 * actions, we would end up
1171 * over-writing one error recovery
1172 * CCB with another one.
1175 CAM_PERIPH_RECOVERY_INPROG) {
1181 CAM_PERIPH_RECOVERY_INPROG;
1183 /* decrement the number of retries */
1185 SSQ_DECREMENT_COUNT) != 0) {
1187 ccb->ccb_h.retry_count--;
1190 bcopy(ccb, save_ccb, sizeof(*save_ccb));
1193 * We retry this one every half
1194 * second for a minute. If the
1195 * device hasn't become ready in a
1196 * minute's time, it's unlikely to
1197 * ever become ready. If the table
1198 * doesn't specify SSQ_MANY, we can
1199 * only try this once. Oh well.
1201 if ((err_action & SSQ_MANY) != 0)
1202 scsi_test_unit_ready(&ccb->csio,
1209 scsi_test_unit_ready(&ccb->csio,
1216 /* release the queue after .5 sec. */
1218 RELSIM_RELEASE_AFTER_TIMEOUT;
1221 * Drop the priority to 0 so that
1222 * we are the first to execute. Also
1223 * freeze the queue after this command
1224 * is sent so that we can restore the
1225 * old csio and have it queued in the
1226 * proper order before we let normal
1227 * transactions go to the drive.
1229 ccb->ccb_h.pinfo.priority = 0;
1230 ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1233 * Save a pointer to the original
1234 * CCB in the new CCB.
1236 ccb->ccb_h.saved_ccb_ptr = save_ccb;
1241 * Send a start unit command to the device,
1242 * and then retry the command. We only
1243 * want to do this if the retry count has
1244 * not been exhausted. If the user
1245 * specified 0 retries, then we follow
1246 * their request and do not retry.
1248 else if (((err_action & SS_MASK) == SS_START)
1250 && ccb->ccb_h.retry_count > 0) {
1254 * Only one error recovery action
1255 * at a time. See above.
1258 CAM_PERIPH_RECOVERY_INPROG) {
1264 CAM_PERIPH_RECOVERY_INPROG;
1266 /* decrement the number of retries */
1268 ccb->ccb_h.retry_count--;
1271 * Check for removable media and
1272 * set load/eject flag
1275 if (SID_IS_REMOVABLE(&cgd.inq_data))
1281 * Attempt to start the drive up.
1283 * Save the current ccb so it can
1284 * be restored and retried once the
1285 * drive is started up.
1287 bcopy(ccb, save_ccb, sizeof(*save_ccb));
1289 scsi_start_stop(&ccb->csio,
1299 * Drop the priority to 0 so that
1300 * we are the first to execute. Also
1301 * freeze the queue after this command
1302 * is sent so that we can restore the
1303 * old csio and have it queued in the
1304 * proper order before we let normal
1305 * transactions go to the drive.
1307 ccb->ccb_h.pinfo.priority = 0;
1308 ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1311 * Save a pointer to the original
1312 * CCB in the new CCB.
1314 ccb->ccb_h.saved_ccb_ptr = save_ccb;
1317 } else if ((sense_flags & SF_RETRY_UA) != 0) {
1319 * XXX KDM this is a *horrible*
1322 error = scsi_interpret_sense(ccb,
1331 * Theoretically, this code should send a
1332 * test unit ready to the given device, and
1333 * if it returns and error, send a start
1334 * unit command. Since we don't yet have
1335 * the capability to do two-command error
1336 * recovery, just send a start unit.
1339 else if (((err_action & SS_MASK) == SS_TURSTART)
1341 && ccb->ccb_h.retry_count > 0) {
1345 * Only one error recovery action
1346 * at a time. See above.
1349 CAM_PERIPH_RECOVERY_INPROG) {
1355 CAM_PERIPH_RECOVERY_INPROG;
1357 /* decrement the number of retries */
1359 ccb->ccb_h.retry_count--;
1362 * Check for removable media and
1363 * set load/eject flag
1366 if (SID_IS_REMOVABLE(&cgd.inq_data))
1372 * Attempt to start the drive up.
1374 * Save the current ccb so it can
1375 * be restored and retried once the
1376 * drive is started up.
1378 bcopy(ccb, save_ccb, sizeof(*save_ccb));
1380 scsi_start_stop(&ccb->csio,
1390 /* release the queue after .5 sec. */
1392 RELSIM_RELEASE_AFTER_TIMEOUT;
1395 * Drop the priority to 0 so that
1396 * we are the first to execute. Also
1397 * freeze the queue after this command
1398 * is sent so that we can restore the
1399 * old csio and have it queued in the
1400 * proper order before we let normal
1401 * transactions go to the drive.
1403 ccb->ccb_h.pinfo.priority = 0;
1404 ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1407 * Save a pointer to the original
1408 * CCB in the new CCB.
1410 ccb->ccb_h.saved_ccb_ptr = save_ccb;
1414 error = scsi_interpret_sense(ccb,
1421 } else if (ccb->csio.scsi_status ==
1422 SCSI_STATUS_CHECK_COND
1423 && status != CAM_AUTOSENSE_FAIL) {
1424 /* no point in decrementing the retry count */
1425 panic("cam_periph_error: scsi status of "
1426 "CHECK COND returned but no sense "
1427 "information is availible. "
1428 "Controller should have returned "
1429 "CAM_AUTOSENSE_FAILED");
1432 } else if (ccb->ccb_h.retry_count == 0) {
1434 * XXX KDM shouldn't there be a better
1435 * argument to return??
1439 /* decrement the number of retries */
1440 retry = ccb->ccb_h.retry_count > 0;
1442 ccb->ccb_h.retry_count--;
1444 * If it was aborted with no
1445 * clue as to the reason, just
1451 case SCSI_STATUS_QUEUE_FULL:
1454 struct ccb_getdevstats cgds;
1457 * First off, find out what the current
1458 * transaction counts are.
1460 xpt_setup_ccb(&cgds.ccb_h,
1463 cgds.ccb_h.func_code = XPT_GDEV_STATS;
1464 xpt_action((union ccb *)&cgds);
1467 * If we were the only transaction active, treat
1468 * the QUEUE FULL as if it were a BUSY condition.
1470 if (cgds.dev_active != 0) {
1474 * Reduce the number of openings to
1475 * be 1 less than the amount it took
1476 * to get a queue full bounded by the
1477 * minimum allowed tag count for this
1481 cgds.dev_active+cgds.dev_openings;
1482 openings = cgds.dev_active;
1483 if (openings < cgds.mintags)
1484 openings = cgds.mintags;
1485 if (openings < total_openings)
1486 relsim_flags = RELSIM_ADJUST_OPENINGS;
1489 * Some devices report queue full for
1490 * temporary resource shortages. For
1491 * this reason, we allow a minimum
1492 * tag count to be entered via a
1493 * quirk entry to prevent the queue
1494 * count on these devices from falling
1495 * to a pessimisticly low value. We
1496 * still wait for the next successful
1497 * completion, however, before queueing
1498 * more transactions to the device.
1501 RELSIM_RELEASE_AFTER_CMDCMPLT;
1509 case SCSI_STATUS_BUSY:
1511 * Restart the queue after either another
1512 * command completes or a 1 second timeout.
1513 * If we have any retries left, that is.
1515 retry = ccb->ccb_h.retry_count > 0;
1517 ccb->ccb_h.retry_count--;
1519 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT
1520 | RELSIM_RELEASE_AFTER_CMDCMPLT;
1526 case SCSI_STATUS_RESERV_CONFLICT:
1534 case CAM_REQ_CMP_ERR:
1535 case CAM_CMD_TIMEOUT:
1536 case CAM_UNEXP_BUSFREE:
1537 case CAM_UNCOR_PARITY:
1538 case CAM_DATA_RUN_ERR:
1539 /* decrement the number of retries */
1540 retry = ccb->ccb_h.retry_count > 0;
1542 ccb->ccb_h.retry_count--;
1550 case CAM_MSG_REJECT_REC:
1551 /* XXX Don't know that these are correct */
1554 case CAM_SEL_TIMEOUT:
1558 * A single selection timeout should not be enough
1559 * to invalidate a device. We should retry for multiple
1560 * seconds assuming this isn't a probe. We'll probably
1561 * need a special flag for that.
1564 struct cam_path *newpath;
1566 /* Should we do more if we can't create the path?? */
1567 if (xpt_create_path(&newpath, xpt_path_periph(ccb->ccb_h.path),
1568 xpt_path_path_id(ccb->ccb_h.path),
1569 xpt_path_target_id(ccb->ccb_h.path),
1570 CAM_LUN_WILDCARD) != CAM_REQ_CMP)
1573 * Let peripheral drivers know that this device has gone
1576 xpt_async(AC_LOST_DEVICE, newpath, NULL);
1577 xpt_free_path(newpath);
1579 if ((sense_flags & SF_RETRY_SELTO) != 0) {
1580 retry = ccb->ccb_h.retry_count > 0;
1582 ccb->ccb_h.retry_count--;
1585 * Wait half a second to give the device
1586 * time to recover before we try again.
1588 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1598 case CAM_REQ_INVALID:
1599 case CAM_PATH_INVALID:
1600 case CAM_DEV_NOT_THERE:
1602 case CAM_PROVIDE_FAIL:
1603 case CAM_REQ_TOO_BIG:
1606 case CAM_SCSI_BUS_RESET:
1608 case CAM_REQUEUE_REQ:
1609 /* Unconditional requeue, dammit */
1612 case CAM_RESRC_UNAVAIL:
1616 /* decrement the number of retries */
1617 retry = ccb->ccb_h.retry_count > 0;
1619 ccb->ccb_h.retry_count--;
1622 /* Check the sense codes */
1628 /* Attempt a retry */
1629 if (error == ERESTART || error == 0) {
1631 ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1633 if (error == ERESTART)
1637 cam_release_devq(ccb->ccb_h.path,
1641 /*getcount_only*/0);