2 * Common functions for CAM "type" (peripheral) drivers.
4 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
6 * Copyright (c) 1997, 1998 Justin T. Gibbs.
7 * Copyright (c) 1997, 1998, 1999, 2000 Kenneth D. Merry.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions, and the following disclaimer,
15 * without modification, immediately at the beginning of the file.
16 * 2. The name of the author may not be used to endorse or promote products
17 * derived from this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/types.h>
38 #include <sys/malloc.h>
39 #include <sys/kernel.h>
42 #include <sys/devctl.h>
44 #include <sys/mutex.h>
47 #include <sys/devicestat.h>
49 #include <sys/sysctl.h>
51 #include <vm/vm_extern.h>
54 #include <cam/cam_ccb.h>
55 #include <cam/cam_queue.h>
56 #include <cam/cam_xpt_periph.h>
57 #include <cam/cam_xpt_internal.h>
58 #include <cam/cam_periph.h>
59 #include <cam/cam_debug.h>
60 #include <cam/cam_sim.h>
62 #include <cam/scsi/scsi_all.h>
63 #include <cam/scsi/scsi_message.h>
64 #include <cam/scsi/scsi_pass.h>
66 static u_int camperiphnextunit(struct periph_driver *p_drv,
67 u_int newunit, int wired,
68 path_id_t pathid, target_id_t target,
70 static u_int camperiphunit(struct periph_driver *p_drv,
71 path_id_t pathid, target_id_t target,
73 static void camperiphdone(struct cam_periph *periph,
75 static void camperiphfree(struct cam_periph *periph);
76 static int camperiphscsistatuserror(union ccb *ccb,
79 u_int32_t sense_flags,
81 u_int32_t *relsim_flags,
84 const char **action_string);
85 static int camperiphscsisenseerror(union ccb *ccb,
88 u_int32_t sense_flags,
90 u_int32_t *relsim_flags,
93 const char **action_string);
94 static void cam_periph_devctl_notify(union ccb *ccb);
96 static int nperiph_drivers;
97 static int initialized = 0;
98 struct periph_driver **periph_drivers;
100 static MALLOC_DEFINE(M_CAMPERIPH, "CAM periph", "CAM peripheral buffers");
102 static int periph_selto_delay = 1000;
103 TUNABLE_INT("kern.cam.periph_selto_delay", &periph_selto_delay);
104 static int periph_noresrc_delay = 500;
105 TUNABLE_INT("kern.cam.periph_noresrc_delay", &periph_noresrc_delay);
106 static int periph_busy_delay = 500;
107 TUNABLE_INT("kern.cam.periph_busy_delay", &periph_busy_delay);
109 static u_int periph_mapmem_thresh = 65536;
110 SYSCTL_UINT(_kern_cam, OID_AUTO, mapmem_thresh, CTLFLAG_RWTUN,
111 &periph_mapmem_thresh, 0, "Threshold for user-space buffer mapping");
114 periphdriver_register(void *data)
116 struct periph_driver *drv = (struct periph_driver *)data;
117 struct periph_driver **newdrivers, **old;
121 ndrivers = nperiph_drivers + 2;
122 newdrivers = malloc(sizeof(*newdrivers) * ndrivers, M_CAMPERIPH,
125 if (ndrivers != nperiph_drivers + 2) {
127 * Lost race against itself; go around.
130 free(newdrivers, M_CAMPERIPH);
134 bcopy(periph_drivers, newdrivers,
135 sizeof(*newdrivers) * nperiph_drivers);
136 newdrivers[nperiph_drivers] = drv;
137 newdrivers[nperiph_drivers + 1] = NULL;
138 old = periph_drivers;
139 periph_drivers = newdrivers;
143 free(old, M_CAMPERIPH);
144 /* If driver marked as early or it is late now, initialize it. */
145 if (((drv->flags & CAM_PERIPH_DRV_EARLY) != 0 && initialized > 0) ||
151 periphdriver_unregister(void *data)
153 struct periph_driver *drv = (struct periph_driver *)data;
156 /* If driver marked as early or it is late now, deinitialize it. */
157 if (((drv->flags & CAM_PERIPH_DRV_EARLY) != 0 && initialized > 0) ||
159 if (drv->deinit == NULL) {
160 printf("CAM periph driver '%s' doesn't have deinit.\n",
164 error = drv->deinit();
170 for (n = 0; n < nperiph_drivers && periph_drivers[n] != drv; n++)
172 KASSERT(n < nperiph_drivers,
173 ("Periph driver '%s' was not registered", drv->driver_name));
174 for (; n + 1 < nperiph_drivers; n++)
175 periph_drivers[n] = periph_drivers[n + 1];
176 periph_drivers[n + 1] = NULL;
183 periphdriver_init(int level)
187 initialized = max(initialized, level);
188 for (i = 0; periph_drivers[i] != NULL; i++) {
189 early = (periph_drivers[i]->flags & CAM_PERIPH_DRV_EARLY) ? 1 : 2;
190 if (early == initialized)
191 (*periph_drivers[i]->init)();
196 cam_periph_alloc(periph_ctor_t *periph_ctor,
197 periph_oninv_t *periph_oninvalidate,
198 periph_dtor_t *periph_dtor, periph_start_t *periph_start,
199 char *name, cam_periph_type type, struct cam_path *path,
200 ac_callback_t *ac_callback, ac_code code, void *arg)
202 struct periph_driver **p_drv;
204 struct cam_periph *periph;
205 struct cam_periph *cur_periph;
207 target_id_t target_id;
214 * Handle Hot-Plug scenarios. If there is already a peripheral
215 * of our type assigned to this path, we are likely waiting for
216 * final close on an old, invalidated, peripheral. If this is
217 * the case, queue up a deferred call to the peripheral's async
218 * handler. If it looks like a mistaken re-allocation, complain.
220 if ((periph = cam_periph_find(path, name)) != NULL) {
221 if ((periph->flags & CAM_PERIPH_INVALID) != 0
222 && (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) == 0) {
223 periph->flags |= CAM_PERIPH_NEW_DEV_FOUND;
224 periph->deferred_callback = ac_callback;
225 periph->deferred_ac = code;
226 return (CAM_REQ_INPROG);
228 printf("cam_periph_alloc: attempt to re-allocate "
229 "valid device %s%d rejected flags %#x "
230 "refcount %d\n", periph->periph_name,
231 periph->unit_number, periph->flags,
234 return (CAM_REQ_INVALID);
237 periph = (struct cam_periph *)malloc(sizeof(*periph), M_CAMPERIPH,
241 return (CAM_RESRC_UNAVAIL);
245 sim = xpt_path_sim(path);
246 path_id = xpt_path_path_id(path);
247 target_id = xpt_path_target_id(path);
248 lun_id = xpt_path_lun_id(path);
249 periph->periph_start = periph_start;
250 periph->periph_dtor = periph_dtor;
251 periph->periph_oninval = periph_oninvalidate;
253 periph->periph_name = name;
254 periph->scheduled_priority = CAM_PRIORITY_NONE;
255 periph->immediate_priority = CAM_PRIORITY_NONE;
256 periph->refcount = 1; /* Dropped by invalidation. */
258 SLIST_INIT(&periph->ccb_list);
259 status = xpt_create_path(&path, periph, path_id, target_id, lun_id);
260 if (status != CAM_REQ_CMP)
265 for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
266 if (strcmp((*p_drv)->driver_name, name) == 0)
269 if (*p_drv == NULL) {
270 printf("cam_periph_alloc: invalid periph name '%s'\n", name);
272 xpt_free_path(periph->path);
273 free(periph, M_CAMPERIPH);
274 return (CAM_REQ_INVALID);
276 periph->unit_number = camperiphunit(*p_drv, path_id, target_id, lun_id);
277 cur_periph = TAILQ_FIRST(&(*p_drv)->units);
278 while (cur_periph != NULL
279 && cur_periph->unit_number < periph->unit_number)
280 cur_periph = TAILQ_NEXT(cur_periph, unit_links);
281 if (cur_periph != NULL) {
282 KASSERT(cur_periph->unit_number != periph->unit_number,
283 ("duplicate units on periph list"));
284 TAILQ_INSERT_BEFORE(cur_periph, periph, unit_links);
286 TAILQ_INSERT_TAIL(&(*p_drv)->units, periph, unit_links);
287 (*p_drv)->generation++;
293 status = xpt_add_periph(periph);
294 if (status != CAM_REQ_CMP)
298 CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph created\n"));
300 status = periph_ctor(periph, arg);
302 if (status == CAM_REQ_CMP)
306 switch (init_level) {
308 /* Initialized successfully */
311 CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph destroyed\n"));
312 xpt_remove_periph(periph);
316 TAILQ_REMOVE(&(*p_drv)->units, periph, unit_links);
318 xpt_free_path(periph->path);
321 free(periph, M_CAMPERIPH);
324 /* No cleanup to perform. */
327 panic("%s: Unknown init level", __func__);
333 * Find a peripheral structure with the specified path, target, lun,
334 * and (optionally) type. If the name is NULL, this function will return
335 * the first peripheral driver that matches the specified path.
338 cam_periph_find(struct cam_path *path, char *name)
340 struct periph_driver **p_drv;
341 struct cam_periph *periph;
344 for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
345 if (name != NULL && (strcmp((*p_drv)->driver_name, name) != 0))
348 TAILQ_FOREACH(periph, &(*p_drv)->units, unit_links) {
349 if (xpt_path_comp(periph->path, path) == 0) {
351 cam_periph_assert(periph, MA_OWNED);
365 * Find peripheral driver instances attached to the specified path.
368 cam_periph_list(struct cam_path *path, struct sbuf *sb)
370 struct sbuf local_sb;
371 struct periph_driver **p_drv;
372 struct cam_periph *periph;
378 sbuf_new(&local_sb, NULL, sbuf_alloc_len, SBUF_FIXEDLEN);
381 for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
382 TAILQ_FOREACH(periph, &(*p_drv)->units, unit_links) {
383 if (xpt_path_comp(periph->path, path) != 0)
386 if (sbuf_len(&local_sb) != 0)
387 sbuf_cat(&local_sb, ",");
389 sbuf_printf(&local_sb, "%s%d", periph->periph_name,
390 periph->unit_number);
392 if (sbuf_error(&local_sb) == ENOMEM) {
395 sbuf_delete(&local_sb);
402 sbuf_finish(&local_sb);
403 if (sbuf_len(sb) != 0)
405 sbuf_cat(sb, sbuf_data(&local_sb));
406 sbuf_delete(&local_sb);
411 cam_periph_acquire(struct cam_periph *periph)
420 if ((periph->flags & CAM_PERIPH_INVALID) == 0) {
430 cam_periph_doacquire(struct cam_periph *periph)
434 KASSERT(periph->refcount >= 1,
435 ("cam_periph_doacquire() with refcount == %d", periph->refcount));
441 cam_periph_release_locked_buses(struct cam_periph *periph)
444 cam_periph_assert(periph, MA_OWNED);
445 KASSERT(periph->refcount >= 1, ("periph->refcount >= 1"));
446 if (--periph->refcount == 0)
447 camperiphfree(periph);
451 cam_periph_release_locked(struct cam_periph *periph)
458 cam_periph_release_locked_buses(periph);
463 cam_periph_release(struct cam_periph *periph)
470 cam_periph_assert(periph, MA_NOTOWNED);
471 mtx = cam_periph_mtx(periph);
473 cam_periph_release_locked(periph);
478 * hold/unhold act as mutual exclusion for sections of the code that
479 * need to sleep and want to make sure that other sections that
480 * will interfere are held off. This only protects exclusive sections
484 cam_periph_hold(struct cam_periph *periph, int priority)
489 * Increment the reference count on the peripheral
490 * while we wait for our lock attempt to succeed
491 * to ensure the peripheral doesn't disappear out
492 * from user us while we sleep.
495 if (cam_periph_acquire(periph) != 0)
498 cam_periph_assert(periph, MA_OWNED);
499 while ((periph->flags & CAM_PERIPH_LOCKED) != 0) {
500 periph->flags |= CAM_PERIPH_LOCK_WANTED;
501 if ((error = cam_periph_sleep(periph, periph, priority,
502 "caplck", 0)) != 0) {
503 cam_periph_release_locked(periph);
506 if (periph->flags & CAM_PERIPH_INVALID) {
507 cam_periph_release_locked(periph);
512 periph->flags |= CAM_PERIPH_LOCKED;
517 cam_periph_unhold(struct cam_periph *periph)
520 cam_periph_assert(periph, MA_OWNED);
522 periph->flags &= ~CAM_PERIPH_LOCKED;
523 if ((periph->flags & CAM_PERIPH_LOCK_WANTED) != 0) {
524 periph->flags &= ~CAM_PERIPH_LOCK_WANTED;
528 cam_periph_release_locked(periph);
532 * Look for the next unit number that is not currently in use for this
533 * peripheral type starting at "newunit". Also exclude unit numbers that
534 * are reserved by for future "hardwiring" unless we already know that this
535 * is a potential wired device. Only assume that the device is "wired" the
536 * first time through the loop since after that we'll be looking at unit
537 * numbers that did not match a wiring entry.
540 camperiphnextunit(struct periph_driver *p_drv, u_int newunit, int wired,
541 path_id_t pathid, target_id_t target, lun_id_t lun)
543 struct cam_periph *periph;
545 int i, val, dunit, r;
546 const char *dname, *strval;
548 periph_name = p_drv->driver_name;
550 for (periph = TAILQ_FIRST(&p_drv->units);
551 periph != NULL && periph->unit_number != newunit;
552 periph = TAILQ_NEXT(periph, unit_links))
555 if (periph != NULL && periph->unit_number == newunit) {
557 xpt_print(periph->path, "Duplicate Wired "
559 xpt_print(periph->path, "Second device (%s "
560 "device at scbus%d target %d lun %d) will "
561 "not be wired\n", periph_name, pathid,
571 * Don't match entries like "da 4" as a wired down
572 * device, but do match entries like "da 4 target 5"
573 * or even "da 4 scbus 1".
578 r = resource_find_dev(&i, dname, &dunit, NULL, NULL);
581 /* if no "target" and no specific scbus, skip */
582 if (resource_int_value(dname, dunit, "target", &val) &&
583 (resource_string_value(dname, dunit, "at",&strval)||
584 strcmp(strval, "scbus") == 0))
586 if (newunit == dunit)
596 camperiphunit(struct periph_driver *p_drv, path_id_t pathid,
597 target_id_t target, lun_id_t lun)
600 int wired, i, val, dunit;
601 const char *dname, *strval;
602 char pathbuf[32], *periph_name;
604 periph_name = p_drv->driver_name;
605 snprintf(pathbuf, sizeof(pathbuf), "scbus%d", pathid);
609 for (wired = 0; resource_find_dev(&i, dname, &dunit, NULL, NULL) == 0;
611 if (resource_string_value(dname, dunit, "at", &strval) == 0) {
612 if (strcmp(strval, pathbuf) != 0)
616 if (resource_int_value(dname, dunit, "target", &val) == 0) {
621 if (resource_int_value(dname, dunit, "lun", &val) == 0) {
633 * Either start from 0 looking for the next unit or from
634 * the unit number given in the resource config. This way,
635 * if we have wildcard matches, we don't return the same
638 unit = camperiphnextunit(p_drv, unit, wired, pathid, target, lun);
644 cam_periph_invalidate(struct cam_periph *periph)
647 cam_periph_assert(periph, MA_OWNED);
649 * We only tear down the device the first time a peripheral is
652 if ((periph->flags & CAM_PERIPH_INVALID) != 0)
655 CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph invalidated\n"));
656 if ((periph->flags & CAM_PERIPH_ANNOUNCED) && !rebooting) {
660 sbuf_new(&sb, buffer, 160, SBUF_FIXEDLEN);
661 xpt_denounce_periph_sbuf(periph, &sb);
665 periph->flags |= CAM_PERIPH_INVALID;
666 periph->flags &= ~CAM_PERIPH_NEW_DEV_FOUND;
667 if (periph->periph_oninval != NULL)
668 periph->periph_oninval(periph);
669 cam_periph_release_locked(periph);
673 camperiphfree(struct cam_periph *periph)
675 struct periph_driver **p_drv;
676 struct periph_driver *drv;
678 cam_periph_assert(periph, MA_OWNED);
679 KASSERT(periph->periph_allocating == 0, ("%s%d: freed while allocating",
680 periph->periph_name, periph->unit_number));
681 for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
682 if (strcmp((*p_drv)->driver_name, periph->periph_name) == 0)
685 if (*p_drv == NULL) {
686 printf("camperiphfree: attempt to free non-existant periph\n");
690 * Cache a pointer to the periph_driver structure. If a
691 * periph_driver is added or removed from the array (see
692 * periphdriver_register()) while we drop the toplogy lock
693 * below, p_drv may change. This doesn't protect against this
694 * particular periph_driver going away. That will require full
695 * reference counting in the periph_driver infrastructure.
700 * We need to set this flag before dropping the topology lock, to
701 * let anyone who is traversing the list that this peripheral is
702 * about to be freed, and there will be no more reference count
705 periph->flags |= CAM_PERIPH_FREE;
708 * The peripheral destructor semantics dictate calling with only the
709 * SIM mutex held. Since it might sleep, it should not be called
710 * with the topology lock held.
715 * We need to call the peripheral destructor prior to removing the
716 * peripheral from the list. Otherwise, we risk running into a
717 * scenario where the peripheral unit number may get reused
718 * (because it has been removed from the list), but some resources
719 * used by the peripheral are still hanging around. In particular,
720 * the devfs nodes used by some peripherals like the pass(4) driver
721 * aren't fully cleaned up until the destructor is run. If the
722 * unit number is reused before the devfs instance is fully gone,
725 if (periph->periph_dtor != NULL)
726 periph->periph_dtor(periph);
729 * The peripheral list is protected by the topology lock. We have to
730 * remove the periph from the drv list before we call deferred_ac. The
731 * AC_FOUND_DEVICE callback won't create a new periph if it's still there.
735 TAILQ_REMOVE(&drv->units, periph, unit_links);
738 xpt_remove_periph(periph);
741 if ((periph->flags & CAM_PERIPH_ANNOUNCED) && !rebooting)
742 xpt_print(periph->path, "Periph destroyed\n");
744 CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph destroyed\n"));
746 if (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) {
750 switch (periph->deferred_ac) {
751 case AC_FOUND_DEVICE:
752 ccb.ccb_h.func_code = XPT_GDEV_TYPE;
753 xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
757 case AC_PATH_REGISTERED:
758 xpt_path_inq(&ccb.cpi, periph->path);
765 periph->deferred_callback(NULL, periph->deferred_ac,
768 xpt_free_path(periph->path);
769 free(periph, M_CAMPERIPH);
774 * Map user virtual pointers into kernel virtual address space, so we can
775 * access the memory. This is now a generic function that centralizes most
776 * of the sanity checks on the data flags, if any.
777 * This also only works for up to maxphys memory. Since we use
778 * buffers to map stuff in and out, we're limited to the buffer size.
781 cam_periph_mapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo,
785 u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
786 u_int32_t lengths[CAM_PERIPH_MAXMAPS];
787 u_int32_t dirs[CAM_PERIPH_MAXMAPS];
789 bzero(mapinfo, sizeof(*mapinfo));
791 maxmap = DFLTPHYS; /* traditional default */
792 else if (maxmap > maxphys)
793 maxmap = maxphys; /* for safety */
794 switch(ccb->ccb_h.func_code) {
796 if (ccb->cdm.match_buf_len == 0) {
797 printf("cam_periph_mapmem: invalid match buffer "
801 if (ccb->cdm.pattern_buf_len > 0) {
802 data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
803 lengths[0] = ccb->cdm.pattern_buf_len;
804 dirs[0] = CAM_DIR_OUT;
805 data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
806 lengths[1] = ccb->cdm.match_buf_len;
807 dirs[1] = CAM_DIR_IN;
810 data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
811 lengths[0] = ccb->cdm.match_buf_len;
812 dirs[0] = CAM_DIR_IN;
816 * This request will not go to the hardware, no reason
817 * to be so strict. vmapbuf() is able to map up to maxphys.
822 case XPT_CONT_TARGET_IO:
823 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
825 if ((ccb->ccb_h.flags & CAM_DATA_MASK) != CAM_DATA_VADDR)
827 data_ptrs[0] = &ccb->csio.data_ptr;
828 lengths[0] = ccb->csio.dxfer_len;
829 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
833 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
835 if ((ccb->ccb_h.flags & CAM_DATA_MASK) != CAM_DATA_VADDR)
837 data_ptrs[0] = &ccb->ataio.data_ptr;
838 lengths[0] = ccb->ataio.dxfer_len;
839 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
843 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
845 /* Two mappings: one for cmd->data and one for cmd->data->data */
846 data_ptrs[0] = (unsigned char **)&ccb->mmcio.cmd.data;
847 lengths[0] = sizeof(struct mmc_data *);
848 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
849 data_ptrs[1] = (unsigned char **)&ccb->mmcio.cmd.data->data;
850 lengths[1] = ccb->mmcio.cmd.data->len;
851 dirs[1] = ccb->ccb_h.flags & CAM_DIR_MASK;
855 data_ptrs[0] = &ccb->smpio.smp_request;
856 lengths[0] = ccb->smpio.smp_request_len;
857 dirs[0] = CAM_DIR_OUT;
858 data_ptrs[1] = &ccb->smpio.smp_response;
859 lengths[1] = ccb->smpio.smp_response_len;
860 dirs[1] = CAM_DIR_IN;
865 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
867 if ((ccb->ccb_h.flags & CAM_DATA_MASK) != CAM_DATA_VADDR)
869 data_ptrs[0] = &ccb->nvmeio.data_ptr;
870 lengths[0] = ccb->nvmeio.dxfer_len;
871 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
874 case XPT_DEV_ADVINFO:
875 if (ccb->cdai.bufsiz == 0)
878 data_ptrs[0] = (uint8_t **)&ccb->cdai.buf;
879 lengths[0] = ccb->cdai.bufsiz;
880 dirs[0] = CAM_DIR_IN;
884 * This request will not go to the hardware, no reason
885 * to be so strict. vmapbuf() is able to map up to maxphys.
891 break; /* NOTREACHED */
895 * Check the transfer length and permissions first, so we don't
896 * have to unmap any previously mapped buffers.
898 for (i = 0; i < numbufs; i++) {
899 if (lengths[i] > maxmap) {
900 printf("cam_periph_mapmem: attempt to map %lu bytes, "
901 "which is greater than %lu\n",
902 (long)(lengths[i]), (u_long)maxmap);
908 * This keeps the kernel stack of current thread from getting
909 * swapped. In low-memory situations where the kernel stack might
910 * otherwise get swapped out, this holds it and allows the thread
911 * to make progress and release the kernel mapped pages sooner.
913 * XXX KDM should I use P_NOSWAP instead?
917 for (i = 0; i < numbufs; i++) {
918 /* Save the user's data address. */
919 mapinfo->orig[i] = *data_ptrs[i];
922 * For small buffers use malloc+copyin/copyout instead of
923 * mapping to KVA to avoid expensive TLB shootdowns. For
924 * small allocations malloc is backed by UMA, and so much
925 * cheaper on SMP systems.
927 if (lengths[i] <= periph_mapmem_thresh &&
928 ccb->ccb_h.func_code != XPT_MMC_IO) {
929 *data_ptrs[i] = malloc(lengths[i], M_CAMPERIPH,
931 if (dirs[i] != CAM_DIR_IN) {
932 if (copyin(mapinfo->orig[i], *data_ptrs[i],
934 free(*data_ptrs[i], M_CAMPERIPH);
935 *data_ptrs[i] = mapinfo->orig[i];
939 bzero(*data_ptrs[i], lengths[i]);
946 mapinfo->bp[i] = uma_zalloc(pbuf_zone, M_WAITOK);
948 /* set the direction */
949 mapinfo->bp[i]->b_iocmd = (dirs[i] == CAM_DIR_OUT) ?
950 BIO_WRITE : BIO_READ;
952 /* Map the buffer into kernel memory. */
953 if (vmapbuf(mapinfo->bp[i], *data_ptrs[i], lengths[i], 1) < 0) {
954 uma_zfree(pbuf_zone, mapinfo->bp[i]);
958 /* set our pointer to the new mapped area */
959 *data_ptrs[i] = mapinfo->bp[i]->b_data;
963 * Now that we've gotten this far, change ownership to the kernel
964 * of the buffers so that we don't run afoul of returning to user
965 * space with locks (on the buffer) held.
967 for (i = 0; i < numbufs; i++) {
969 BUF_KERNPROC(mapinfo->bp[i]);
972 mapinfo->num_bufs_used = numbufs;
976 for (i--; i >= 0; i--) {
977 if (mapinfo->bp[i]) {
978 vunmapbuf(mapinfo->bp[i]);
979 uma_zfree(pbuf_zone, mapinfo->bp[i]);
981 free(*data_ptrs[i], M_CAMPERIPH);
982 *data_ptrs[i] = mapinfo->orig[i];
989 * Unmap memory segments mapped into kernel virtual address space by
990 * cam_periph_mapmem().
993 cam_periph_unmapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo)
996 u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
997 u_int32_t lengths[CAM_PERIPH_MAXMAPS];
998 u_int32_t dirs[CAM_PERIPH_MAXMAPS];
1000 if (mapinfo->num_bufs_used <= 0) {
1001 /* nothing to free and the process wasn't held. */
1005 switch (ccb->ccb_h.func_code) {
1007 if (ccb->cdm.pattern_buf_len > 0) {
1008 data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
1009 lengths[0] = ccb->cdm.pattern_buf_len;
1010 dirs[0] = CAM_DIR_OUT;
1011 data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
1012 lengths[1] = ccb->cdm.match_buf_len;
1013 dirs[1] = CAM_DIR_IN;
1016 data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
1017 lengths[0] = ccb->cdm.match_buf_len;
1018 dirs[0] = CAM_DIR_IN;
1023 case XPT_CONT_TARGET_IO:
1024 data_ptrs[0] = &ccb->csio.data_ptr;
1025 lengths[0] = ccb->csio.dxfer_len;
1026 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1030 data_ptrs[0] = &ccb->ataio.data_ptr;
1031 lengths[0] = ccb->ataio.dxfer_len;
1032 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1036 data_ptrs[0] = (u_int8_t **)&ccb->mmcio.cmd.data;
1037 lengths[0] = sizeof(struct mmc_data *);
1038 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1039 data_ptrs[1] = (u_int8_t **)&ccb->mmcio.cmd.data->data;
1040 lengths[1] = ccb->mmcio.cmd.data->len;
1041 dirs[1] = ccb->ccb_h.flags & CAM_DIR_MASK;
1045 data_ptrs[0] = &ccb->smpio.smp_request;
1046 lengths[0] = ccb->smpio.smp_request_len;
1047 dirs[0] = CAM_DIR_OUT;
1048 data_ptrs[1] = &ccb->smpio.smp_response;
1049 lengths[1] = ccb->smpio.smp_response_len;
1050 dirs[1] = CAM_DIR_IN;
1054 case XPT_NVME_ADMIN:
1055 data_ptrs[0] = &ccb->nvmeio.data_ptr;
1056 lengths[0] = ccb->nvmeio.dxfer_len;
1057 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1060 case XPT_DEV_ADVINFO:
1061 data_ptrs[0] = (uint8_t **)&ccb->cdai.buf;
1062 lengths[0] = ccb->cdai.bufsiz;
1063 dirs[0] = CAM_DIR_IN;
1067 /* allow ourselves to be swapped once again */
1070 break; /* NOTREACHED */
1073 for (i = 0; i < numbufs; i++) {
1074 if (mapinfo->bp[i]) {
1075 /* unmap the buffer */
1076 vunmapbuf(mapinfo->bp[i]);
1078 /* release the buffer */
1079 uma_zfree(pbuf_zone, mapinfo->bp[i]);
1081 if (dirs[i] != CAM_DIR_OUT) {
1082 copyout(*data_ptrs[i], mapinfo->orig[i],
1085 free(*data_ptrs[i], M_CAMPERIPH);
1088 /* Set the user's pointer back to the original value */
1089 *data_ptrs[i] = mapinfo->orig[i];
1092 /* allow ourselves to be swapped once again */
1097 cam_periph_ioctl(struct cam_periph *periph, u_long cmd, caddr_t addr,
1098 int (*error_routine)(union ccb *ccb,
1100 u_int32_t sense_flags))
1109 case CAMGETPASSTHRU:
1110 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1111 xpt_setup_ccb(&ccb->ccb_h,
1113 CAM_PRIORITY_NORMAL);
1114 ccb->ccb_h.func_code = XPT_GDEVLIST;
1117 * Basically, the point of this is that we go through
1118 * getting the list of devices, until we find a passthrough
1119 * device. In the current version of the CAM code, the
1120 * only way to determine what type of device we're dealing
1121 * with is by its name.
1123 while (found == 0) {
1124 ccb->cgdl.index = 0;
1125 ccb->cgdl.status = CAM_GDEVLIST_MORE_DEVS;
1126 while (ccb->cgdl.status == CAM_GDEVLIST_MORE_DEVS) {
1127 /* we want the next device in the list */
1129 if (strncmp(ccb->cgdl.periph_name,
1135 if ((ccb->cgdl.status == CAM_GDEVLIST_LAST_DEVICE) &&
1137 ccb->cgdl.periph_name[0] = '\0';
1138 ccb->cgdl.unit_number = 0;
1143 /* copy the result back out */
1144 bcopy(ccb, addr, sizeof(union ccb));
1146 /* and release the ccb */
1147 xpt_release_ccb(ccb);
1158 cam_periph_done_panic(struct cam_periph *periph, union ccb *done_ccb)
1161 panic("%s: already done with ccb %p", __func__, done_ccb);
1165 cam_periph_done(struct cam_periph *periph, union ccb *done_ccb)
1168 /* Caller will release the CCB */
1169 xpt_path_assert(done_ccb->ccb_h.path, MA_OWNED);
1170 done_ccb->ccb_h.cbfcnp = cam_periph_done_panic;
1171 wakeup(&done_ccb->ccb_h.cbfcnp);
1175 cam_periph_ccbwait(union ccb *ccb)
1178 if ((ccb->ccb_h.func_code & XPT_FC_QUEUED) != 0) {
1179 while (ccb->ccb_h.cbfcnp != cam_periph_done_panic)
1180 xpt_path_sleep(ccb->ccb_h.path, &ccb->ccb_h.cbfcnp,
1181 PRIBIO, "cbwait", 0);
1183 KASSERT(ccb->ccb_h.pinfo.index == CAM_UNQUEUED_INDEX &&
1184 (ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_INPROG,
1185 ("%s: proceeding with incomplete ccb: ccb=%p, func_code=%#x, "
1186 "status=%#x, index=%d", __func__, ccb, ccb->ccb_h.func_code,
1187 ccb->ccb_h.status, ccb->ccb_h.pinfo.index));
1191 * Dispatch a CCB and wait for it to complete. If the CCB has set a
1192 * callback function (ccb->ccb_h.cbfcnp), it will be overwritten and lost.
1195 cam_periph_runccb(union ccb *ccb,
1196 int (*error_routine)(union ccb *ccb,
1198 u_int32_t sense_flags),
1199 cam_flags camflags, u_int32_t sense_flags,
1202 struct bintime *starttime;
1203 struct bintime ltime;
1206 uint32_t timeout = 1;
1209 xpt_path_assert(ccb->ccb_h.path, MA_OWNED);
1210 KASSERT((ccb->ccb_h.flags & CAM_UNLOCKED) == 0,
1211 ("%s: ccb=%p, func_code=%#x, flags=%#x", __func__, ccb,
1212 ccb->ccb_h.func_code, ccb->ccb_h.flags));
1215 * If the user has supplied a stats structure, and if we understand
1216 * this particular type of ccb, record the transaction start.
1219 (ccb->ccb_h.func_code == XPT_SCSI_IO ||
1220 ccb->ccb_h.func_code == XPT_ATA_IO ||
1221 ccb->ccb_h.func_code == XPT_NVME_IO)) {
1223 binuptime(starttime);
1224 devstat_start_transaction(ds, starttime);
1228 * We must poll the I/O while we're dumping. The scheduler is normally
1229 * stopped for dumping, except when we call doadump from ddb. While the
1230 * scheduler is running in this case, we still need to poll the I/O to
1231 * avoid sleeping waiting for the ccb to complete.
1233 * A panic triggered dump stops the scheduler, any callback from the
1234 * shutdown_post_sync event will run with the scheduler stopped, but
1235 * before we're officially dumping. To avoid hanging in adashutdown
1236 * initiated commands (or other similar situations), we have to test for
1237 * either SCHEDULER_STOPPED() here as well.
1239 * To avoid locking problems, dumping/polling callers must call
1240 * without a periph lock held.
1242 must_poll = dumping || SCHEDULER_STOPPED();
1243 ccb->ccb_h.cbfcnp = cam_periph_done;
1246 * If we're polling, then we need to ensure that we have ample resources
1247 * in the periph. cam_periph_error can reschedule the ccb by calling
1248 * xpt_action and returning ERESTART, so we have to effect the polling
1249 * in the do loop below.
1252 if (cam_sim_pollable(ccb->ccb_h.path->bus->sim))
1253 timeout = xpt_poll_setup(ccb);
1259 ccb->ccb_h.status = CAM_RESRC_UNAVAIL;
1265 xpt_pollwait(ccb, timeout);
1266 timeout = ccb->ccb_h.timeout * 10;
1268 cam_periph_ccbwait(ccb);
1270 if ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP)
1272 else if (error_routine != NULL) {
1273 ccb->ccb_h.cbfcnp = cam_periph_done;
1274 error = (*error_routine)(ccb, camflags, sense_flags);
1277 } while (error == ERESTART);
1280 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1281 cam_release_devq(ccb->ccb_h.path,
1282 /* relsim_flags */0,
1285 /* getcount_only */ FALSE);
1286 ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1291 devstat_tag_type tag;
1294 if (ccb->ccb_h.func_code == XPT_SCSI_IO) {
1295 bytes = ccb->csio.dxfer_len - ccb->csio.resid;
1296 tag = (devstat_tag_type)(ccb->csio.tag_action & 0x3);
1297 } else if (ccb->ccb_h.func_code == XPT_ATA_IO) {
1298 bytes = ccb->ataio.dxfer_len - ccb->ataio.resid;
1299 tag = (devstat_tag_type)0;
1300 } else if (ccb->ccb_h.func_code == XPT_NVME_IO) {
1301 bytes = ccb->nvmeio.dxfer_len; /* NB: resid no possible */
1302 tag = (devstat_tag_type)0;
1307 devstat_end_transaction(ds, bytes, tag,
1308 ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE) ?
1309 DEVSTAT_NO_DATA : (ccb->ccb_h.flags & CAM_DIR_OUT) ?
1310 DEVSTAT_WRITE : DEVSTAT_READ, NULL, starttime);
1317 cam_freeze_devq(struct cam_path *path)
1319 struct ccb_hdr ccb_h;
1321 CAM_DEBUG(path, CAM_DEBUG_TRACE, ("cam_freeze_devq\n"));
1322 xpt_setup_ccb(&ccb_h, path, /*priority*/1);
1323 ccb_h.func_code = XPT_NOOP;
1324 ccb_h.flags = CAM_DEV_QFREEZE;
1325 xpt_action((union ccb *)&ccb_h);
1329 cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
1330 u_int32_t openings, u_int32_t arg,
1333 struct ccb_relsim crs;
1335 CAM_DEBUG(path, CAM_DEBUG_TRACE, ("cam_release_devq(%u, %u, %u, %d)\n",
1336 relsim_flags, openings, arg, getcount_only));
1337 xpt_setup_ccb(&crs.ccb_h, path, CAM_PRIORITY_NORMAL);
1338 crs.ccb_h.func_code = XPT_REL_SIMQ;
1339 crs.ccb_h.flags = getcount_only ? CAM_DEV_QFREEZE : 0;
1340 crs.release_flags = relsim_flags;
1341 crs.openings = openings;
1342 crs.release_timeout = arg;
1343 xpt_action((union ccb *)&crs);
1344 return (crs.qfrozen_cnt);
1347 #define saved_ccb_ptr ppriv_ptr0
1349 camperiphdone(struct cam_periph *periph, union ccb *done_ccb)
1351 union ccb *saved_ccb;
1353 struct scsi_start_stop_unit *scsi_cmd;
1354 int error = 0, error_code, sense_key, asc, ascq;
1356 scsi_cmd = (struct scsi_start_stop_unit *)
1357 &done_ccb->csio.cdb_io.cdb_bytes;
1358 status = done_ccb->ccb_h.status;
1360 if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1361 if (scsi_extract_sense_ccb(done_ccb,
1362 &error_code, &sense_key, &asc, &ascq)) {
1364 * If the error is "invalid field in CDB",
1365 * and the load/eject flag is set, turn the
1366 * flag off and try again. This is just in
1367 * case the drive in question barfs on the
1368 * load eject flag. The CAM code should set
1369 * the load/eject flag by default for
1372 if ((scsi_cmd->opcode == START_STOP_UNIT) &&
1373 ((scsi_cmd->how & SSS_LOEJ) != 0) &&
1374 (asc == 0x24) && (ascq == 0x00)) {
1375 scsi_cmd->how &= ~SSS_LOEJ;
1376 if (status & CAM_DEV_QFRZN) {
1377 cam_release_devq(done_ccb->ccb_h.path,
1379 done_ccb->ccb_h.status &=
1382 xpt_action(done_ccb);
1386 error = cam_periph_error(done_ccb, 0,
1387 SF_RETRY_UA | SF_NO_PRINT);
1388 if (error == ERESTART)
1390 if (done_ccb->ccb_h.status & CAM_DEV_QFRZN) {
1391 cam_release_devq(done_ccb->ccb_h.path, 0, 0, 0, 0);
1392 done_ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1396 * If we have successfully taken a device from the not
1397 * ready to ready state, re-scan the device and re-get
1398 * the inquiry information. Many devices (mostly disks)
1399 * don't properly report their inquiry information unless
1402 if (scsi_cmd->opcode == START_STOP_UNIT)
1403 xpt_async(AC_INQ_CHANGED, done_ccb->ccb_h.path, NULL);
1406 /* If we tried long wait and still failed, remember that. */
1407 if ((periph->flags & CAM_PERIPH_RECOVERY_WAIT) &&
1408 (done_ccb->csio.cdb_io.cdb_bytes[0] == TEST_UNIT_READY)) {
1409 periph->flags &= ~CAM_PERIPH_RECOVERY_WAIT;
1410 if (error != 0 && done_ccb->ccb_h.retry_count == 0)
1411 periph->flags |= CAM_PERIPH_RECOVERY_WAIT_FAILED;
1415 * After recovery action(s) completed, return to the original CCB.
1416 * If the recovery CCB has failed, considering its own possible
1417 * retries and recovery, assume we are back in state where we have
1418 * been originally, but without recovery hopes left. In such case,
1419 * after the final attempt below, we cancel any further retries,
1420 * blocking by that also any new recovery attempts for this CCB,
1421 * and the result will be the final one returned to the CCB owher.
1423 saved_ccb = (union ccb *)done_ccb->ccb_h.saved_ccb_ptr;
1424 saved_ccb->ccb_h.periph_links = done_ccb->ccb_h.periph_links;
1425 bcopy(saved_ccb, done_ccb, sizeof(*done_ccb));
1426 xpt_free_ccb(saved_ccb);
1427 if (done_ccb->ccb_h.cbfcnp != camperiphdone)
1428 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
1430 done_ccb->ccb_h.retry_count = 0;
1431 xpt_action(done_ccb);
1434 /* Drop freeze taken due to CAM_DEV_QFREEZE flag set. */
1435 cam_release_devq(done_ccb->ccb_h.path, 0, 0, 0, 0);
1439 * Generic Async Event handler. Peripheral drivers usually
1440 * filter out the events that require personal attention,
1441 * and leave the rest to this function.
1444 cam_periph_async(struct cam_periph *periph, u_int32_t code,
1445 struct cam_path *path, void *arg)
1448 case AC_LOST_DEVICE:
1449 cam_periph_invalidate(periph);
1457 cam_periph_bus_settle(struct cam_periph *periph, u_int bus_settle)
1459 struct ccb_getdevstats cgds;
1461 xpt_setup_ccb(&cgds.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
1462 cgds.ccb_h.func_code = XPT_GDEV_STATS;
1463 xpt_action((union ccb *)&cgds);
1464 cam_periph_freeze_after_event(periph, &cgds.last_reset, bus_settle);
1468 cam_periph_freeze_after_event(struct cam_periph *periph,
1469 struct timeval* event_time, u_int duration_ms)
1471 struct timeval delta;
1472 struct timeval duration_tv;
1474 if (!timevalisset(event_time))
1478 timevalsub(&delta, event_time);
1479 duration_tv.tv_sec = duration_ms / 1000;
1480 duration_tv.tv_usec = (duration_ms % 1000) * 1000;
1481 if (timevalcmp(&delta, &duration_tv, <)) {
1482 timevalsub(&duration_tv, &delta);
1484 duration_ms = duration_tv.tv_sec * 1000;
1485 duration_ms += duration_tv.tv_usec / 1000;
1486 cam_freeze_devq(periph->path);
1487 cam_release_devq(periph->path,
1488 RELSIM_RELEASE_AFTER_TIMEOUT,
1490 /*timeout*/duration_ms,
1491 /*getcount_only*/0);
1497 camperiphscsistatuserror(union ccb *ccb, union ccb **orig_ccb,
1498 cam_flags camflags, u_int32_t sense_flags,
1499 int *openings, u_int32_t *relsim_flags,
1500 u_int32_t *timeout, u_int32_t *action, const char **action_string)
1502 struct cam_periph *periph;
1505 switch (ccb->csio.scsi_status) {
1506 case SCSI_STATUS_OK:
1507 case SCSI_STATUS_COND_MET:
1508 case SCSI_STATUS_INTERMED:
1509 case SCSI_STATUS_INTERMED_COND_MET:
1512 case SCSI_STATUS_CMD_TERMINATED:
1513 case SCSI_STATUS_CHECK_COND:
1514 error = camperiphscsisenseerror(ccb, orig_ccb,
1523 case SCSI_STATUS_QUEUE_FULL:
1526 struct ccb_getdevstats cgds;
1529 * First off, find out what the current
1530 * transaction counts are.
1532 xpt_setup_ccb(&cgds.ccb_h,
1534 CAM_PRIORITY_NORMAL);
1535 cgds.ccb_h.func_code = XPT_GDEV_STATS;
1536 xpt_action((union ccb *)&cgds);
1539 * If we were the only transaction active, treat
1540 * the QUEUE FULL as if it were a BUSY condition.
1542 if (cgds.dev_active != 0) {
1546 * Reduce the number of openings to
1547 * be 1 less than the amount it took
1548 * to get a queue full bounded by the
1549 * minimum allowed tag count for this
1552 total_openings = cgds.dev_active + cgds.dev_openings;
1553 *openings = cgds.dev_active;
1554 if (*openings < cgds.mintags)
1555 *openings = cgds.mintags;
1556 if (*openings < total_openings)
1557 *relsim_flags = RELSIM_ADJUST_OPENINGS;
1560 * Some devices report queue full for
1561 * temporary resource shortages. For
1562 * this reason, we allow a minimum
1563 * tag count to be entered via a
1564 * quirk entry to prevent the queue
1565 * count on these devices from falling
1566 * to a pessimisticly low value. We
1567 * still wait for the next successful
1568 * completion, however, before queueing
1569 * more transactions to the device.
1571 *relsim_flags = RELSIM_RELEASE_AFTER_CMDCMPLT;
1575 *action &= ~SSQ_PRINT_SENSE;
1580 case SCSI_STATUS_BUSY:
1582 * Restart the queue after either another
1583 * command completes or a 1 second timeout.
1585 periph = xpt_path_periph(ccb->ccb_h.path);
1586 if (periph->flags & CAM_PERIPH_INVALID) {
1588 *action_string = "Periph was invalidated";
1589 } else if ((sense_flags & SF_RETRY_BUSY) != 0 ||
1590 ccb->ccb_h.retry_count > 0) {
1591 if ((sense_flags & SF_RETRY_BUSY) == 0)
1592 ccb->ccb_h.retry_count--;
1594 *relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT
1595 | RELSIM_RELEASE_AFTER_CMDCMPLT;
1599 *action_string = "Retries exhausted";
1602 case SCSI_STATUS_RESERV_CONFLICT:
1611 camperiphscsisenseerror(union ccb *ccb, union ccb **orig,
1612 cam_flags camflags, u_int32_t sense_flags,
1613 int *openings, u_int32_t *relsim_flags,
1614 u_int32_t *timeout, u_int32_t *action, const char **action_string)
1616 struct cam_periph *periph;
1617 union ccb *orig_ccb = ccb;
1618 int error, recoveryccb;
1620 #if defined(BUF_TRACKING) || defined(FULL_BUF_TRACKING)
1621 if (ccb->ccb_h.func_code == XPT_SCSI_IO && ccb->csio.bio != NULL)
1622 biotrack(ccb->csio.bio, __func__);
1625 periph = xpt_path_periph(ccb->ccb_h.path);
1626 recoveryccb = (ccb->ccb_h.cbfcnp == camperiphdone);
1627 if ((periph->flags & CAM_PERIPH_RECOVERY_INPROG) && !recoveryccb) {
1629 * If error recovery is already in progress, don't attempt
1630 * to process this error, but requeue it unconditionally
1631 * and attempt to process it once error recovery has
1632 * completed. This failed command is probably related to
1633 * the error that caused the currently active error recovery
1634 * action so our current recovery efforts should also
1635 * address this command. Be aware that the error recovery
1636 * code assumes that only one recovery action is in progress
1637 * on a particular peripheral instance at any given time
1638 * (e.g. only one saved CCB for error recovery) so it is
1639 * imperitive that we don't violate this assumption.
1642 *action &= ~SSQ_PRINT_SENSE;
1644 scsi_sense_action err_action;
1645 struct ccb_getdev cgd;
1648 * Grab the inquiry data for this device.
1650 xpt_setup_ccb(&cgd.ccb_h, ccb->ccb_h.path, CAM_PRIORITY_NORMAL);
1651 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1652 xpt_action((union ccb *)&cgd);
1654 err_action = scsi_error_action(&ccb->csio, &cgd.inq_data,
1656 error = err_action & SS_ERRMASK;
1659 * Do not autostart sequential access devices
1660 * to avoid unexpected tape loading.
1662 if ((err_action & SS_MASK) == SS_START &&
1663 SID_TYPE(&cgd.inq_data) == T_SEQUENTIAL) {
1664 *action_string = "Will not autostart a "
1665 "sequential access device";
1666 goto sense_error_done;
1670 * Avoid recovery recursion if recovery action is the same.
1672 if ((err_action & SS_MASK) >= SS_START && recoveryccb) {
1673 if (((err_action & SS_MASK) == SS_START &&
1674 ccb->csio.cdb_io.cdb_bytes[0] == START_STOP_UNIT) ||
1675 ((err_action & SS_MASK) == SS_TUR &&
1676 (ccb->csio.cdb_io.cdb_bytes[0] == TEST_UNIT_READY))) {
1677 err_action = SS_RETRY|SSQ_DECREMENT_COUNT|EIO;
1678 *relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1684 * If the recovery action will consume a retry,
1685 * make sure we actually have retries available.
1687 if ((err_action & SSQ_DECREMENT_COUNT) != 0) {
1688 if (ccb->ccb_h.retry_count > 0 &&
1689 (periph->flags & CAM_PERIPH_INVALID) == 0)
1690 ccb->ccb_h.retry_count--;
1692 *action_string = "Retries exhausted";
1693 goto sense_error_done;
1697 if ((err_action & SS_MASK) >= SS_START) {
1699 * Do common portions of commands that
1700 * use recovery CCBs.
1702 orig_ccb = xpt_alloc_ccb_nowait();
1703 if (orig_ccb == NULL) {
1704 *action_string = "Can't allocate recovery CCB";
1705 goto sense_error_done;
1708 * Clear freeze flag for original request here, as
1709 * this freeze will be dropped as part of ERESTART.
1711 ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1712 bcopy(ccb, orig_ccb, sizeof(*orig_ccb));
1715 switch (err_action & SS_MASK) {
1717 *action_string = "No recovery action needed";
1721 *action_string = "Retrying command (per sense data)";
1725 *action_string = "Unretryable error";
1732 * Send a start unit command to the device, and
1733 * then retry the command.
1735 *action_string = "Attempting to start unit";
1736 periph->flags |= CAM_PERIPH_RECOVERY_INPROG;
1739 * Check for removable media and set
1740 * load/eject flag appropriately.
1742 if (SID_IS_REMOVABLE(&cgd.inq_data))
1747 scsi_start_stop(&ccb->csio,
1761 * Send a Test Unit Ready to the device.
1762 * If the 'many' flag is set, we send 120
1763 * test unit ready commands, one every half
1764 * second. Otherwise, we just send one TUR.
1765 * We only want to do this if the retry
1766 * count has not been exhausted.
1770 if ((err_action & SSQ_MANY) != 0 && (periph->flags &
1771 CAM_PERIPH_RECOVERY_WAIT_FAILED) == 0) {
1772 periph->flags |= CAM_PERIPH_RECOVERY_WAIT;
1773 *action_string = "Polling device for readiness";
1776 *action_string = "Testing device for readiness";
1779 periph->flags |= CAM_PERIPH_RECOVERY_INPROG;
1780 scsi_test_unit_ready(&ccb->csio,
1788 * Accomplish our 500ms delay by deferring
1789 * the release of our device queue appropriately.
1791 *relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1796 panic("Unhandled error action %x", err_action);
1799 if ((err_action & SS_MASK) >= SS_START) {
1801 * Drop the priority, so that the recovery
1802 * CCB is the first to execute. Freeze the queue
1803 * after this command is sent so that we can
1804 * restore the old csio and have it queued in
1805 * the proper order before we release normal
1806 * transactions to the device.
1808 ccb->ccb_h.pinfo.priority--;
1809 ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1810 ccb->ccb_h.saved_ccb_ptr = orig_ccb;
1816 *action = err_action;
1822 * Generic error handler. Peripheral drivers usually filter
1823 * out the errors that they handle in a unique manner, then
1824 * call this function.
1827 cam_periph_error(union ccb *ccb, cam_flags camflags,
1828 u_int32_t sense_flags)
1830 struct cam_path *newpath;
1831 union ccb *orig_ccb, *scan_ccb;
1832 struct cam_periph *periph;
1833 const char *action_string;
1835 int frozen, error, openings, devctl_err;
1836 u_int32_t action, relsim_flags, timeout;
1838 action = SSQ_PRINT_SENSE;
1839 periph = xpt_path_periph(ccb->ccb_h.path);
1840 action_string = NULL;
1841 status = ccb->ccb_h.status;
1842 frozen = (status & CAM_DEV_QFRZN) != 0;
1843 status &= CAM_STATUS_MASK;
1844 devctl_err = openings = relsim_flags = timeout = 0;
1847 /* Filter the errors that should be reported via devctl */
1848 switch (ccb->ccb_h.status & CAM_STATUS_MASK) {
1849 case CAM_CMD_TIMEOUT:
1850 case CAM_REQ_ABORTED:
1851 case CAM_REQ_CMP_ERR:
1852 case CAM_REQ_TERMIO:
1853 case CAM_UNREC_HBA_ERROR:
1854 case CAM_DATA_RUN_ERR:
1855 case CAM_SCSI_STATUS_ERROR:
1856 case CAM_ATA_STATUS_ERROR:
1857 case CAM_SMP_STATUS_ERROR:
1867 action &= ~SSQ_PRINT_SENSE;
1869 case CAM_SCSI_STATUS_ERROR:
1870 error = camperiphscsistatuserror(ccb, &orig_ccb,
1871 camflags, sense_flags, &openings, &relsim_flags,
1872 &timeout, &action, &action_string);
1874 case CAM_AUTOSENSE_FAIL:
1875 error = EIO; /* we have to kill the command */
1879 case CAM_MSG_REJECT_REC:
1880 /* XXX Don't know that these are correct */
1883 case CAM_SEL_TIMEOUT:
1884 if ((camflags & CAM_RETRY_SELTO) != 0) {
1885 if (ccb->ccb_h.retry_count > 0 &&
1886 (periph->flags & CAM_PERIPH_INVALID) == 0) {
1887 ccb->ccb_h.retry_count--;
1891 * Wait a bit to give the device
1892 * time to recover before we try again.
1894 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1895 timeout = periph_selto_delay;
1898 action_string = "Retries exhausted";
1901 case CAM_DEV_NOT_THERE:
1905 case CAM_REQ_INVALID:
1906 case CAM_PATH_INVALID:
1908 case CAM_PROVIDE_FAIL:
1909 case CAM_REQ_TOO_BIG:
1910 case CAM_LUN_INVALID:
1911 case CAM_TID_INVALID:
1912 case CAM_FUNC_NOTAVAIL:
1915 case CAM_SCSI_BUS_RESET:
1918 * Commands that repeatedly timeout and cause these
1919 * kinds of error recovery actions, should return
1920 * CAM_CMD_TIMEOUT, which allows us to safely assume
1921 * that this command was an innocent bystander to
1922 * these events and should be unconditionally
1925 case CAM_REQUEUE_REQ:
1926 /* Unconditional requeue if device is still there */
1927 if (periph->flags & CAM_PERIPH_INVALID) {
1928 action_string = "Periph was invalidated";
1930 } else if (sense_flags & SF_NO_RETRY) {
1932 action_string = "Retry was blocked";
1935 action &= ~SSQ_PRINT_SENSE;
1938 case CAM_RESRC_UNAVAIL:
1939 /* Wait a bit for the resource shortage to abate. */
1940 timeout = periph_noresrc_delay;
1944 /* Wait a bit for the busy condition to abate. */
1945 timeout = periph_busy_delay;
1947 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1949 case CAM_ATA_STATUS_ERROR:
1950 case CAM_REQ_CMP_ERR:
1951 case CAM_CMD_TIMEOUT:
1952 case CAM_UNEXP_BUSFREE:
1953 case CAM_UNCOR_PARITY:
1954 case CAM_DATA_RUN_ERR:
1956 if (periph->flags & CAM_PERIPH_INVALID) {
1958 action_string = "Periph was invalidated";
1959 } else if (ccb->ccb_h.retry_count == 0) {
1961 action_string = "Retries exhausted";
1962 } else if (sense_flags & SF_NO_RETRY) {
1964 action_string = "Retry was blocked";
1966 ccb->ccb_h.retry_count--;
1972 if ((sense_flags & SF_PRINT_ALWAYS) ||
1973 CAM_DEBUGGED(ccb->ccb_h.path, CAM_DEBUG_INFO))
1974 action |= SSQ_PRINT_SENSE;
1975 else if (sense_flags & SF_NO_PRINT)
1976 action &= ~SSQ_PRINT_SENSE;
1977 if ((action & SSQ_PRINT_SENSE) != 0)
1978 cam_error_print(orig_ccb, CAM_ESF_ALL, CAM_EPF_ALL);
1979 if (error != 0 && (action & SSQ_PRINT_SENSE) != 0) {
1980 if (error != ERESTART) {
1981 if (action_string == NULL)
1982 action_string = "Unretryable error";
1983 xpt_print(ccb->ccb_h.path, "Error %d, %s\n",
1984 error, action_string);
1985 } else if (action_string != NULL)
1986 xpt_print(ccb->ccb_h.path, "%s\n", action_string);
1988 xpt_print(ccb->ccb_h.path,
1989 "Retrying command, %d more tries remain\n",
1990 ccb->ccb_h.retry_count);
1994 if (devctl_err && (error != 0 || (action & SSQ_PRINT_SENSE) != 0))
1995 cam_periph_devctl_notify(orig_ccb);
1997 if ((action & SSQ_LOST) != 0) {
2001 * For a selection timeout, we consider all of the LUNs on
2002 * the target to be gone. If the status is CAM_DEV_NOT_THERE,
2003 * then we only get rid of the device(s) specified by the
2004 * path in the original CCB.
2006 if (status == CAM_SEL_TIMEOUT)
2007 lun_id = CAM_LUN_WILDCARD;
2009 lun_id = xpt_path_lun_id(ccb->ccb_h.path);
2011 /* Should we do more if we can't create the path?? */
2012 if (xpt_create_path(&newpath, periph,
2013 xpt_path_path_id(ccb->ccb_h.path),
2014 xpt_path_target_id(ccb->ccb_h.path),
2015 lun_id) == CAM_REQ_CMP) {
2017 * Let peripheral drivers know that this
2018 * device has gone away.
2020 xpt_async(AC_LOST_DEVICE, newpath, NULL);
2021 xpt_free_path(newpath);
2025 /* Broadcast UNIT ATTENTIONs to all periphs. */
2026 if ((action & SSQ_UA) != 0)
2027 xpt_async(AC_UNIT_ATTENTION, orig_ccb->ccb_h.path, orig_ccb);
2029 /* Rescan target on "Reported LUNs data has changed" */
2030 if ((action & SSQ_RESCAN) != 0) {
2031 if (xpt_create_path(&newpath, NULL,
2032 xpt_path_path_id(ccb->ccb_h.path),
2033 xpt_path_target_id(ccb->ccb_h.path),
2034 CAM_LUN_WILDCARD) == CAM_REQ_CMP) {
2035 scan_ccb = xpt_alloc_ccb_nowait();
2036 if (scan_ccb != NULL) {
2037 scan_ccb->ccb_h.path = newpath;
2038 scan_ccb->ccb_h.func_code = XPT_SCAN_TGT;
2039 scan_ccb->crcn.flags = 0;
2040 xpt_rescan(scan_ccb);
2043 "Can't allocate CCB to rescan target\n");
2044 xpt_free_path(newpath);
2049 /* Attempt a retry */
2050 if (error == ERESTART || error == 0) {
2052 ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
2053 if (error == ERESTART)
2056 cam_release_devq(ccb->ccb_h.path,
2060 /*getcount_only*/0);
2066 #define CAM_PERIPH_DEVD_MSG_SIZE 256
2069 cam_periph_devctl_notify(union ccb *ccb)
2071 struct cam_periph *periph;
2072 struct ccb_getdev *cgd;
2074 int serr, sk, asc, ascq;
2077 sbmsg = malloc(CAM_PERIPH_DEVD_MSG_SIZE, M_CAMPERIPH, M_NOWAIT);
2081 sbuf_new(&sb, sbmsg, CAM_PERIPH_DEVD_MSG_SIZE, SBUF_FIXEDLEN);
2083 periph = xpt_path_periph(ccb->ccb_h.path);
2084 sbuf_printf(&sb, "device=%s%d ", periph->periph_name,
2085 periph->unit_number);
2087 sbuf_printf(&sb, "serial=\"");
2088 if ((cgd = (struct ccb_getdev *)xpt_alloc_ccb_nowait()) != NULL) {
2089 xpt_setup_ccb(&cgd->ccb_h, ccb->ccb_h.path,
2090 CAM_PRIORITY_NORMAL);
2091 cgd->ccb_h.func_code = XPT_GDEV_TYPE;
2092 xpt_action((union ccb *)cgd);
2094 if (cgd->ccb_h.status == CAM_REQ_CMP)
2095 sbuf_bcat(&sb, cgd->serial_num, cgd->serial_num_len);
2096 xpt_free_ccb((union ccb *)cgd);
2098 sbuf_printf(&sb, "\" ");
2099 sbuf_printf(&sb, "cam_status=\"0x%x\" ", ccb->ccb_h.status);
2101 switch (ccb->ccb_h.status & CAM_STATUS_MASK) {
2102 case CAM_CMD_TIMEOUT:
2103 sbuf_printf(&sb, "timeout=%d ", ccb->ccb_h.timeout);
2106 case CAM_SCSI_STATUS_ERROR:
2107 sbuf_printf(&sb, "scsi_status=%d ", ccb->csio.scsi_status);
2108 if (scsi_extract_sense_ccb(ccb, &serr, &sk, &asc, &ascq))
2109 sbuf_printf(&sb, "scsi_sense=\"%02x %02x %02x %02x\" ",
2110 serr, sk, asc, ascq);
2113 case CAM_ATA_STATUS_ERROR:
2114 sbuf_printf(&sb, "RES=\"");
2115 ata_res_sbuf(&ccb->ataio.res, &sb);
2116 sbuf_printf(&sb, "\" ");
2124 if (ccb->ccb_h.func_code == XPT_SCSI_IO) {
2125 sbuf_printf(&sb, "CDB=\"");
2126 scsi_cdb_sbuf(scsiio_cdb_ptr(&ccb->csio), &sb);
2127 sbuf_printf(&sb, "\" ");
2128 } else if (ccb->ccb_h.func_code == XPT_ATA_IO) {
2129 sbuf_printf(&sb, "ACB=\"");
2130 ata_cmd_sbuf(&ccb->ataio.cmd, &sb);
2131 sbuf_printf(&sb, "\" ");
2134 if (sbuf_finish(&sb) == 0)
2135 devctl_notify("CAM", "periph", type, sbuf_data(&sb));
2137 free(sbmsg, M_CAMPERIPH);
2141 * Sysctl to force an invalidation of the drive right now. Can be
2142 * called with CTLFLAG_MPSAFE since we take periph lock.
2145 cam_periph_invalidate_sysctl(SYSCTL_HANDLER_ARGS)
2147 struct cam_periph *periph;
2152 error = sysctl_handle_int(oidp, &value, 0, req);
2153 if (error != 0 || req->newptr == NULL || value != 1)
2156 cam_periph_lock(periph);
2157 cam_periph_invalidate(periph);
2158 cam_periph_unlock(periph);