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>
43 #include <sys/mutex.h>
46 #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_periph.h>
58 #include <cam/cam_debug.h>
59 #include <cam/cam_sim.h>
61 #include <cam/scsi/scsi_all.h>
62 #include <cam/scsi/scsi_message.h>
63 #include <cam/scsi/scsi_pass.h>
65 static u_int camperiphnextunit(struct periph_driver *p_drv,
66 u_int newunit, int wired,
67 path_id_t pathid, target_id_t target,
69 static u_int camperiphunit(struct periph_driver *p_drv,
70 path_id_t pathid, target_id_t target,
72 static void camperiphdone(struct cam_periph *periph,
74 static void camperiphfree(struct cam_periph *periph);
75 static int camperiphscsistatuserror(union ccb *ccb,
78 u_int32_t sense_flags,
80 u_int32_t *relsim_flags,
83 const char **action_string);
84 static int camperiphscsisenseerror(union ccb *ccb,
87 u_int32_t sense_flags,
89 u_int32_t *relsim_flags,
92 const char **action_string);
93 static void cam_periph_devctl_notify(union ccb *ccb);
95 static int nperiph_drivers;
96 static int initialized = 0;
97 struct periph_driver **periph_drivers;
99 static MALLOC_DEFINE(M_CAMPERIPH, "CAM periph", "CAM peripheral buffers");
101 static int periph_selto_delay = 1000;
102 TUNABLE_INT("kern.cam.periph_selto_delay", &periph_selto_delay);
103 static int periph_noresrc_delay = 500;
104 TUNABLE_INT("kern.cam.periph_noresrc_delay", &periph_noresrc_delay);
105 static int periph_busy_delay = 500;
106 TUNABLE_INT("kern.cam.periph_busy_delay", &periph_busy_delay);
108 static u_int periph_mapmem_thresh = 65536;
109 SYSCTL_UINT(_kern_cam, OID_AUTO, mapmem_thresh, CTLFLAG_RWTUN,
110 &periph_mapmem_thresh, 0, "Threshold for user-space buffer mapping");
113 periphdriver_register(void *data)
115 struct periph_driver *drv = (struct periph_driver *)data;
116 struct periph_driver **newdrivers, **old;
120 ndrivers = nperiph_drivers + 2;
121 newdrivers = malloc(sizeof(*newdrivers) * ndrivers, M_CAMPERIPH,
124 if (ndrivers != nperiph_drivers + 2) {
126 * Lost race against itself; go around.
129 free(newdrivers, M_CAMPERIPH);
133 bcopy(periph_drivers, newdrivers,
134 sizeof(*newdrivers) * nperiph_drivers);
135 newdrivers[nperiph_drivers] = drv;
136 newdrivers[nperiph_drivers + 1] = NULL;
137 old = periph_drivers;
138 periph_drivers = newdrivers;
142 free(old, M_CAMPERIPH);
143 /* If driver marked as early or it is late now, initialize it. */
144 if (((drv->flags & CAM_PERIPH_DRV_EARLY) != 0 && initialized > 0) ||
150 periphdriver_unregister(void *data)
152 struct periph_driver *drv = (struct periph_driver *)data;
155 /* If driver marked as early or it is late now, deinitialize it. */
156 if (((drv->flags & CAM_PERIPH_DRV_EARLY) != 0 && initialized > 0) ||
158 if (drv->deinit == NULL) {
159 printf("CAM periph driver '%s' doesn't have deinit.\n",
163 error = drv->deinit();
169 for (n = 0; n < nperiph_drivers && periph_drivers[n] != drv; n++)
171 KASSERT(n < nperiph_drivers,
172 ("Periph driver '%s' was not registered", drv->driver_name));
173 for (; n + 1 < nperiph_drivers; n++)
174 periph_drivers[n] = periph_drivers[n + 1];
175 periph_drivers[n + 1] = NULL;
182 periphdriver_init(int level)
186 initialized = max(initialized, level);
187 for (i = 0; periph_drivers[i] != NULL; i++) {
188 early = (periph_drivers[i]->flags & CAM_PERIPH_DRV_EARLY) ? 1 : 2;
189 if (early == initialized)
190 (*periph_drivers[i]->init)();
195 cam_periph_alloc(periph_ctor_t *periph_ctor,
196 periph_oninv_t *periph_oninvalidate,
197 periph_dtor_t *periph_dtor, periph_start_t *periph_start,
198 char *name, cam_periph_type type, struct cam_path *path,
199 ac_callback_t *ac_callback, ac_code code, void *arg)
201 struct periph_driver **p_drv;
203 struct cam_periph *periph;
204 struct cam_periph *cur_periph;
206 target_id_t target_id;
213 * Handle Hot-Plug scenarios. If there is already a peripheral
214 * of our type assigned to this path, we are likely waiting for
215 * final close on an old, invalidated, peripheral. If this is
216 * the case, queue up a deferred call to the peripheral's async
217 * handler. If it looks like a mistaken re-allocation, complain.
219 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);
246 sim = xpt_path_sim(path);
247 path_id = xpt_path_path_id(path);
248 target_id = xpt_path_target_id(path);
249 lun_id = xpt_path_lun_id(path);
250 periph->periph_start = periph_start;
251 periph->periph_dtor = periph_dtor;
252 periph->periph_oninval = periph_oninvalidate;
254 periph->periph_name = name;
255 periph->scheduled_priority = CAM_PRIORITY_NONE;
256 periph->immediate_priority = CAM_PRIORITY_NONE;
257 periph->refcount = 1; /* Dropped by invalidation. */
259 SLIST_INIT(&periph->ccb_list);
260 status = xpt_create_path(&path, periph, path_id, target_id, lun_id);
261 if (status != CAM_REQ_CMP)
266 for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
267 if (strcmp((*p_drv)->driver_name, name) == 0)
270 if (*p_drv == NULL) {
271 printf("cam_periph_alloc: invalid periph name '%s'\n", name);
273 xpt_free_path(periph->path);
274 free(periph, M_CAMPERIPH);
275 return (CAM_REQ_INVALID);
277 periph->unit_number = camperiphunit(*p_drv, path_id, target_id, lun_id);
278 cur_periph = TAILQ_FIRST(&(*p_drv)->units);
279 while (cur_periph != NULL
280 && cur_periph->unit_number < periph->unit_number)
281 cur_periph = TAILQ_NEXT(cur_periph, unit_links);
282 if (cur_periph != NULL) {
283 KASSERT(cur_periph->unit_number != periph->unit_number, ("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++) {
346 if (name != NULL && (strcmp((*p_drv)->driver_name, name) != 0))
349 TAILQ_FOREACH(periph, &(*p_drv)->units, unit_links) {
350 if (xpt_path_comp(periph->path, path) == 0) {
352 cam_periph_assert(periph, MA_OWNED);
366 * Find peripheral driver instances attached to the specified path.
369 cam_periph_list(struct cam_path *path, struct sbuf *sb)
371 struct sbuf local_sb;
372 struct periph_driver **p_drv;
373 struct cam_periph *periph;
379 sbuf_new(&local_sb, NULL, sbuf_alloc_len, SBUF_FIXEDLEN);
382 for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
384 TAILQ_FOREACH(periph, &(*p_drv)->units, unit_links) {
385 if (xpt_path_comp(periph->path, path) != 0)
388 if (sbuf_len(&local_sb) != 0)
389 sbuf_cat(&local_sb, ",");
391 sbuf_printf(&local_sb, "%s%d", periph->periph_name,
392 periph->unit_number);
394 if (sbuf_error(&local_sb) == ENOMEM) {
397 sbuf_delete(&local_sb);
404 sbuf_finish(&local_sb);
405 sbuf_cpy(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;
551 for (periph = TAILQ_FIRST(&p_drv->units);
552 periph != NULL && periph->unit_number != newunit;
553 periph = TAILQ_NEXT(periph, unit_links))
556 if (periph != NULL && periph->unit_number == newunit) {
558 xpt_print(periph->path, "Duplicate Wired "
560 xpt_print(periph->path, "Second device (%s "
561 "device at scbus%d target %d lun %d) will "
562 "not be wired\n", periph_name, pathid,
572 * Don't match entries like "da 4" as a wired down
573 * device, but do match entries like "da 4 target 5"
574 * or even "da 4 scbus 1".
579 r = resource_find_dev(&i, dname, &dunit, NULL, NULL);
582 /* if no "target" and no specific scbus, skip */
583 if (resource_int_value(dname, dunit, "target", &val) &&
584 (resource_string_value(dname, dunit, "at",&strval)||
585 strcmp(strval, "scbus") == 0))
587 if (newunit == dunit)
597 camperiphunit(struct periph_driver *p_drv, path_id_t pathid,
598 target_id_t target, lun_id_t lun)
601 int wired, i, val, dunit;
602 const char *dname, *strval;
603 char pathbuf[32], *periph_name;
605 periph_name = p_drv->driver_name;
606 snprintf(pathbuf, sizeof(pathbuf), "scbus%d", pathid);
610 for (wired = 0; resource_find_dev(&i, dname, &dunit, NULL, NULL) == 0;
612 if (resource_string_value(dname, dunit, "at", &strval) == 0) {
613 if (strcmp(strval, pathbuf) != 0)
617 if (resource_int_value(dname, dunit, "target", &val) == 0) {
622 if (resource_int_value(dname, dunit, "lun", &val) == 0) {
634 * Either start from 0 looking for the next unit or from
635 * the unit number given in the resource config. This way,
636 * if we have wildcard matches, we don't return the same
639 unit = camperiphnextunit(p_drv, unit, wired, pathid, target, lun);
645 cam_periph_invalidate(struct cam_periph *periph)
648 cam_periph_assert(periph, MA_OWNED);
650 * We only call this routine the first time a peripheral is
653 if ((periph->flags & CAM_PERIPH_INVALID) != 0)
656 CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph invalidated\n"));
657 if ((periph->flags & CAM_PERIPH_ANNOUNCED) && !rebooting) {
661 sbuf_new(&sb, buffer, 160, SBUF_FIXEDLEN);
662 xpt_denounce_periph_sbuf(periph, &sb);
666 periph->flags |= CAM_PERIPH_INVALID;
667 periph->flags &= ~CAM_PERIPH_NEW_DEV_FOUND;
668 if (periph->periph_oninval != NULL)
669 periph->periph_oninval(periph);
670 cam_periph_release_locked(periph);
674 camperiphfree(struct cam_periph *periph)
676 struct periph_driver **p_drv;
677 struct periph_driver *drv;
679 cam_periph_assert(periph, MA_OWNED);
680 KASSERT(periph->periph_allocating == 0, ("%s%d: freed while allocating",
681 periph->periph_name, periph->unit_number));
682 for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
683 if (strcmp((*p_drv)->driver_name, periph->periph_name) == 0)
686 if (*p_drv == NULL) {
687 printf("camperiphfree: attempt to free non-existant periph\n");
691 * Cache a pointer to the periph_driver structure. If a
692 * periph_driver is added or removed from the array (see
693 * periphdriver_register()) while we drop the toplogy lock
694 * below, p_drv may change. This doesn't protect against this
695 * particular periph_driver going away. That will require full
696 * reference counting in the periph_driver infrastructure.
701 * We need to set this flag before dropping the topology lock, to
702 * let anyone who is traversing the list that this peripheral is
703 * about to be freed, and there will be no more reference count
706 periph->flags |= CAM_PERIPH_FREE;
709 * The peripheral destructor semantics dictate calling with only the
710 * SIM mutex held. Since it might sleep, it should not be called
711 * with the topology lock held.
716 * We need to call the peripheral destructor prior to removing the
717 * peripheral from the list. Otherwise, we risk running into a
718 * scenario where the peripheral unit number may get reused
719 * (because it has been removed from the list), but some resources
720 * used by the peripheral are still hanging around. In particular,
721 * the devfs nodes used by some peripherals like the pass(4) driver
722 * aren't fully cleaned up until the destructor is run. If the
723 * unit number is reused before the devfs instance is fully gone,
726 if (periph->periph_dtor != NULL)
727 periph->periph_dtor(periph);
730 * The peripheral list is protected by the topology lock.
734 TAILQ_REMOVE(&drv->units, periph, unit_links);
737 xpt_remove_periph(periph);
740 if ((periph->flags & CAM_PERIPH_ANNOUNCED) && !rebooting)
741 xpt_print(periph->path, "Periph destroyed\n");
743 CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph destroyed\n"));
745 if (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) {
749 switch (periph->deferred_ac) {
750 case AC_FOUND_DEVICE:
751 ccb.ccb_h.func_code = XPT_GDEV_TYPE;
752 xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
756 case AC_PATH_REGISTERED:
757 xpt_path_inq(&ccb.cpi, periph->path);
764 periph->deferred_callback(NULL, periph->deferred_ac,
767 xpt_free_path(periph->path);
768 free(periph, M_CAMPERIPH);
773 * Map user virtual pointers into kernel virtual address space, so we can
774 * access the memory. This is now a generic function that centralizes most
775 * of the sanity checks on the data flags, if any.
776 * This also only works for up to MAXPHYS memory. Since we use
777 * buffers to map stuff in and out, we're limited to the buffer size.
780 cam_periph_mapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo,
784 u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
785 u_int32_t lengths[CAM_PERIPH_MAXMAPS];
786 u_int32_t dirs[CAM_PERIPH_MAXMAPS];
788 bzero(mapinfo, sizeof(*mapinfo));
790 maxmap = DFLTPHYS; /* traditional default */
791 else if (maxmap > MAXPHYS)
792 maxmap = MAXPHYS; /* for safety */
793 switch(ccb->ccb_h.func_code) {
795 if (ccb->cdm.match_buf_len == 0) {
796 printf("cam_periph_mapmem: invalid match buffer "
800 if (ccb->cdm.pattern_buf_len > 0) {
801 data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
802 lengths[0] = ccb->cdm.pattern_buf_len;
803 dirs[0] = CAM_DIR_OUT;
804 data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
805 lengths[1] = ccb->cdm.match_buf_len;
806 dirs[1] = CAM_DIR_IN;
809 data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
810 lengths[0] = ccb->cdm.match_buf_len;
811 dirs[0] = CAM_DIR_IN;
815 * This request will not go to the hardware, no reason
816 * to be so strict. vmapbuf() is able to map up to MAXPHYS.
821 case XPT_CONT_TARGET_IO:
822 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
824 if ((ccb->ccb_h.flags & CAM_DATA_MASK) != CAM_DATA_VADDR)
826 data_ptrs[0] = &ccb->csio.data_ptr;
827 lengths[0] = ccb->csio.dxfer_len;
828 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
832 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
834 if ((ccb->ccb_h.flags & CAM_DATA_MASK) != CAM_DATA_VADDR)
836 data_ptrs[0] = &ccb->ataio.data_ptr;
837 lengths[0] = ccb->ataio.dxfer_len;
838 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
842 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
844 /* Two mappings: one for cmd->data and one for cmd->data->data */
845 data_ptrs[0] = (unsigned char **)&ccb->mmcio.cmd.data;
846 lengths[0] = sizeof(struct mmc_data *);
847 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
848 data_ptrs[1] = (unsigned char **)&ccb->mmcio.cmd.data->data;
849 lengths[1] = ccb->mmcio.cmd.data->len;
850 dirs[1] = ccb->ccb_h.flags & CAM_DIR_MASK;
854 data_ptrs[0] = &ccb->smpio.smp_request;
855 lengths[0] = ccb->smpio.smp_request_len;
856 dirs[0] = CAM_DIR_OUT;
857 data_ptrs[1] = &ccb->smpio.smp_response;
858 lengths[1] = ccb->smpio.smp_response_len;
859 dirs[1] = CAM_DIR_IN;
864 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
866 if ((ccb->ccb_h.flags & CAM_DATA_MASK) != CAM_DATA_VADDR)
868 data_ptrs[0] = &ccb->nvmeio.data_ptr;
869 lengths[0] = ccb->nvmeio.dxfer_len;
870 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
873 case XPT_DEV_ADVINFO:
874 if (ccb->cdai.bufsiz == 0)
877 data_ptrs[0] = (uint8_t **)&ccb->cdai.buf;
878 lengths[0] = ccb->cdai.bufsiz;
879 dirs[0] = CAM_DIR_IN;
883 * This request will not go to the hardware, no reason
884 * to be so strict. vmapbuf() is able to map up to MAXPHYS.
890 break; /* NOTREACHED */
894 * Check the transfer length and permissions first, so we don't
895 * have to unmap any previously mapped buffers.
897 for (i = 0; i < numbufs; i++) {
900 * The userland data pointer passed in may not be page
901 * aligned. vmapbuf() truncates the address to a page
902 * boundary, so if the address isn't page aligned, we'll
903 * need enough space for the given transfer length, plus
904 * whatever extra space is necessary to make it to the page
908 (((vm_offset_t)(*data_ptrs[i])) & PAGE_MASK)) > maxmap){
909 printf("cam_periph_mapmem: attempt to map %lu bytes, "
910 "which is greater than %lu\n",
912 (((vm_offset_t)(*data_ptrs[i])) & PAGE_MASK)),
919 * This keeps the kernel stack of current thread from getting
920 * swapped. In low-memory situations where the kernel stack might
921 * otherwise get swapped out, this holds it and allows the thread
922 * to make progress and release the kernel mapped pages sooner.
924 * XXX KDM should I use P_NOSWAP instead?
928 for (i = 0; i < numbufs; i++) {
930 /* Save the user's data address. */
931 mapinfo->orig[i] = *data_ptrs[i];
934 * For small buffers use malloc+copyin/copyout instead of
935 * mapping to KVA to avoid expensive TLB shootdowns. For
936 * small allocations malloc is backed by UMA, and so much
937 * cheaper on SMP systems.
939 if (lengths[i] <= periph_mapmem_thresh &&
940 ccb->ccb_h.func_code != XPT_MMC_IO) {
941 *data_ptrs[i] = malloc(lengths[i], M_CAMPERIPH,
943 if (dirs[i] != CAM_DIR_IN) {
944 if (copyin(mapinfo->orig[i], *data_ptrs[i],
946 free(*data_ptrs[i], M_CAMPERIPH);
947 *data_ptrs[i] = mapinfo->orig[i];
951 bzero(*data_ptrs[i], lengths[i]);
958 mapinfo->bp[i] = uma_zalloc(pbuf_zone, M_WAITOK);
960 /* put our pointer in the data slot */
961 mapinfo->bp[i]->b_data = *data_ptrs[i];
963 /* set the transfer length, we know it's < MAXPHYS */
964 mapinfo->bp[i]->b_bufsize = lengths[i];
966 /* set the direction */
967 mapinfo->bp[i]->b_iocmd = (dirs[i] == CAM_DIR_OUT) ?
968 BIO_WRITE : BIO_READ;
971 * Map the buffer into kernel memory.
973 * Note that useracc() alone is not a sufficient test.
974 * vmapbuf() can still fail due to a smaller file mapped
975 * into a larger area of VM, or if userland races against
976 * vmapbuf() after the useracc() check.
978 if (vmapbuf(mapinfo->bp[i], 1) < 0) {
979 uma_zfree(pbuf_zone, mapinfo->bp[i]);
983 /* set our pointer to the new mapped area */
984 *data_ptrs[i] = mapinfo->bp[i]->b_data;
988 * Now that we've gotten this far, change ownership to the kernel
989 * of the buffers so that we don't run afoul of returning to user
990 * space with locks (on the buffer) held.
992 for (i = 0; i < numbufs; i++) {
994 BUF_KERNPROC(mapinfo->bp[i]);
997 mapinfo->num_bufs_used = numbufs;
1001 for (i--; i >= 0; i--) {
1002 if (mapinfo->bp[i]) {
1003 vunmapbuf(mapinfo->bp[i]);
1004 uma_zfree(pbuf_zone, mapinfo->bp[i]);
1006 free(*data_ptrs[i], M_CAMPERIPH);
1007 *data_ptrs[i] = mapinfo->orig[i];
1014 * Unmap memory segments mapped into kernel virtual address space by
1015 * cam_periph_mapmem().
1018 cam_periph_unmapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo)
1021 u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
1022 u_int32_t lengths[CAM_PERIPH_MAXMAPS];
1023 u_int32_t dirs[CAM_PERIPH_MAXMAPS];
1025 if (mapinfo->num_bufs_used <= 0) {
1026 /* nothing to free and the process wasn't held. */
1030 switch (ccb->ccb_h.func_code) {
1032 if (ccb->cdm.pattern_buf_len > 0) {
1033 data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
1034 lengths[0] = ccb->cdm.pattern_buf_len;
1035 dirs[0] = CAM_DIR_OUT;
1036 data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
1037 lengths[1] = ccb->cdm.match_buf_len;
1038 dirs[1] = CAM_DIR_IN;
1041 data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
1042 lengths[0] = ccb->cdm.match_buf_len;
1043 dirs[0] = CAM_DIR_IN;
1048 case XPT_CONT_TARGET_IO:
1049 data_ptrs[0] = &ccb->csio.data_ptr;
1050 lengths[0] = ccb->csio.dxfer_len;
1051 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1055 data_ptrs[0] = &ccb->ataio.data_ptr;
1056 lengths[0] = ccb->ataio.dxfer_len;
1057 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1061 data_ptrs[0] = (u_int8_t **)&ccb->mmcio.cmd.data;
1062 lengths[0] = sizeof(struct mmc_data *);
1063 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1064 data_ptrs[1] = (u_int8_t **)&ccb->mmcio.cmd.data->data;
1065 lengths[1] = ccb->mmcio.cmd.data->len;
1066 dirs[1] = ccb->ccb_h.flags & CAM_DIR_MASK;
1070 data_ptrs[0] = &ccb->smpio.smp_request;
1071 lengths[0] = ccb->smpio.smp_request_len;
1072 dirs[0] = CAM_DIR_OUT;
1073 data_ptrs[1] = &ccb->smpio.smp_response;
1074 lengths[1] = ccb->smpio.smp_response_len;
1075 dirs[1] = CAM_DIR_IN;
1079 case XPT_NVME_ADMIN:
1080 data_ptrs[0] = &ccb->nvmeio.data_ptr;
1081 lengths[0] = ccb->nvmeio.dxfer_len;
1082 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1085 case XPT_DEV_ADVINFO:
1086 data_ptrs[0] = (uint8_t **)&ccb->cdai.buf;
1087 lengths[0] = ccb->cdai.bufsiz;
1088 dirs[0] = CAM_DIR_IN;
1092 /* allow ourselves to be swapped once again */
1095 break; /* NOTREACHED */
1098 for (i = 0; i < numbufs; i++) {
1099 if (mapinfo->bp[i]) {
1100 /* unmap the buffer */
1101 vunmapbuf(mapinfo->bp[i]);
1103 /* release the buffer */
1104 uma_zfree(pbuf_zone, mapinfo->bp[i]);
1106 if (dirs[i] != CAM_DIR_OUT) {
1107 copyout(*data_ptrs[i], mapinfo->orig[i],
1110 free(*data_ptrs[i], M_CAMPERIPH);
1113 /* Set the user's pointer back to the original value */
1114 *data_ptrs[i] = mapinfo->orig[i];
1117 /* allow ourselves to be swapped once again */
1122 cam_periph_ioctl(struct cam_periph *periph, u_long cmd, caddr_t addr,
1123 int (*error_routine)(union ccb *ccb,
1125 u_int32_t sense_flags))
1134 case CAMGETPASSTHRU:
1135 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1136 xpt_setup_ccb(&ccb->ccb_h,
1138 CAM_PRIORITY_NORMAL);
1139 ccb->ccb_h.func_code = XPT_GDEVLIST;
1142 * Basically, the point of this is that we go through
1143 * getting the list of devices, until we find a passthrough
1144 * device. In the current version of the CAM code, the
1145 * only way to determine what type of device we're dealing
1146 * with is by its name.
1148 while (found == 0) {
1149 ccb->cgdl.index = 0;
1150 ccb->cgdl.status = CAM_GDEVLIST_MORE_DEVS;
1151 while (ccb->cgdl.status == CAM_GDEVLIST_MORE_DEVS) {
1153 /* we want the next device in the list */
1155 if (strncmp(ccb->cgdl.periph_name,
1161 if ((ccb->cgdl.status == CAM_GDEVLIST_LAST_DEVICE) &&
1163 ccb->cgdl.periph_name[0] = '\0';
1164 ccb->cgdl.unit_number = 0;
1169 /* copy the result back out */
1170 bcopy(ccb, addr, sizeof(union ccb));
1172 /* and release the ccb */
1173 xpt_release_ccb(ccb);
1184 cam_periph_done_panic(struct cam_periph *periph, union ccb *done_ccb)
1187 panic("%s: already done with ccb %p", __func__, done_ccb);
1191 cam_periph_done(struct cam_periph *periph, union ccb *done_ccb)
1194 /* Caller will release the CCB */
1195 xpt_path_assert(done_ccb->ccb_h.path, MA_OWNED);
1196 done_ccb->ccb_h.cbfcnp = cam_periph_done_panic;
1197 wakeup(&done_ccb->ccb_h.cbfcnp);
1201 cam_periph_ccbwait(union ccb *ccb)
1204 if ((ccb->ccb_h.func_code & XPT_FC_QUEUED) != 0) {
1205 while (ccb->ccb_h.cbfcnp != cam_periph_done_panic)
1206 xpt_path_sleep(ccb->ccb_h.path, &ccb->ccb_h.cbfcnp,
1207 PRIBIO, "cbwait", 0);
1209 KASSERT(ccb->ccb_h.pinfo.index == CAM_UNQUEUED_INDEX &&
1210 (ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_INPROG,
1211 ("%s: proceeding with incomplete ccb: ccb=%p, func_code=%#x, "
1212 "status=%#x, index=%d", __func__, ccb, ccb->ccb_h.func_code,
1213 ccb->ccb_h.status, ccb->ccb_h.pinfo.index));
1217 * Dispatch a CCB and wait for it to complete. If the CCB has set a
1218 * callback function (ccb->ccb_h.cbfcnp), it will be overwritten and lost.
1221 cam_periph_runccb(union ccb *ccb,
1222 int (*error_routine)(union ccb *ccb,
1224 u_int32_t sense_flags),
1225 cam_flags camflags, u_int32_t sense_flags,
1228 struct bintime *starttime;
1229 struct bintime ltime;
1232 uint32_t timeout = 1;
1235 xpt_path_assert(ccb->ccb_h.path, MA_OWNED);
1236 KASSERT((ccb->ccb_h.flags & CAM_UNLOCKED) == 0,
1237 ("%s: ccb=%p, func_code=%#x, flags=%#x", __func__, ccb,
1238 ccb->ccb_h.func_code, ccb->ccb_h.flags));
1241 * If the user has supplied a stats structure, and if we understand
1242 * this particular type of ccb, record the transaction start.
1245 (ccb->ccb_h.func_code == XPT_SCSI_IO ||
1246 ccb->ccb_h.func_code == XPT_ATA_IO ||
1247 ccb->ccb_h.func_code == XPT_NVME_IO)) {
1249 binuptime(starttime);
1250 devstat_start_transaction(ds, starttime);
1254 * We must poll the I/O while we're dumping. The scheduler is normally
1255 * stopped for dumping, except when we call doadump from ddb. While the
1256 * scheduler is running in this case, we still need to poll the I/O to
1257 * avoid sleeping waiting for the ccb to complete.
1259 * A panic triggered dump stops the scheduler, any callback from the
1260 * shutdown_post_sync event will run with the scheduler stopped, but
1261 * before we're officially dumping. To avoid hanging in adashutdown
1262 * initiated commands (or other similar situations), we have to test for
1263 * either SCHEDULER_STOPPED() here as well.
1265 * To avoid locking problems, dumping/polling callers must call
1266 * without a periph lock held.
1268 must_poll = dumping || SCHEDULER_STOPPED();
1269 ccb->ccb_h.cbfcnp = cam_periph_done;
1272 * If we're polling, then we need to ensure that we have ample resources
1273 * in the periph. cam_periph_error can reschedule the ccb by calling
1274 * xpt_action and returning ERESTART, so we have to effect the polling
1275 * in the do loop below.
1278 timeout = xpt_poll_setup(ccb);
1282 ccb->ccb_h.status = CAM_RESRC_UNAVAIL;
1288 xpt_pollwait(ccb, timeout);
1289 timeout = ccb->ccb_h.timeout * 10;
1291 cam_periph_ccbwait(ccb);
1293 if ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP)
1295 else if (error_routine != NULL) {
1296 ccb->ccb_h.cbfcnp = cam_periph_done;
1297 error = (*error_routine)(ccb, camflags, sense_flags);
1300 } while (error == ERESTART);
1303 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1304 cam_release_devq(ccb->ccb_h.path,
1305 /* relsim_flags */0,
1308 /* getcount_only */ FALSE);
1309 ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1314 devstat_tag_type tag;
1317 if (ccb->ccb_h.func_code == XPT_SCSI_IO) {
1318 bytes = ccb->csio.dxfer_len - ccb->csio.resid;
1319 tag = (devstat_tag_type)(ccb->csio.tag_action & 0x3);
1320 } else if (ccb->ccb_h.func_code == XPT_ATA_IO) {
1321 bytes = ccb->ataio.dxfer_len - ccb->ataio.resid;
1322 tag = (devstat_tag_type)0;
1323 } else if (ccb->ccb_h.func_code == XPT_NVME_IO) {
1324 bytes = ccb->nvmeio.dxfer_len; /* NB: resid no possible */
1325 tag = (devstat_tag_type)0;
1330 devstat_end_transaction(ds, bytes, tag,
1331 ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE) ?
1332 DEVSTAT_NO_DATA : (ccb->ccb_h.flags & CAM_DIR_OUT) ?
1333 DEVSTAT_WRITE : DEVSTAT_READ, NULL, starttime);
1340 cam_freeze_devq(struct cam_path *path)
1342 struct ccb_hdr ccb_h;
1344 CAM_DEBUG(path, CAM_DEBUG_TRACE, ("cam_freeze_devq\n"));
1345 xpt_setup_ccb(&ccb_h, path, /*priority*/1);
1346 ccb_h.func_code = XPT_NOOP;
1347 ccb_h.flags = CAM_DEV_QFREEZE;
1348 xpt_action((union ccb *)&ccb_h);
1352 cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
1353 u_int32_t openings, u_int32_t arg,
1356 struct ccb_relsim crs;
1358 CAM_DEBUG(path, CAM_DEBUG_TRACE, ("cam_release_devq(%u, %u, %u, %d)\n",
1359 relsim_flags, openings, arg, getcount_only));
1360 xpt_setup_ccb(&crs.ccb_h, path, CAM_PRIORITY_NORMAL);
1361 crs.ccb_h.func_code = XPT_REL_SIMQ;
1362 crs.ccb_h.flags = getcount_only ? CAM_DEV_QFREEZE : 0;
1363 crs.release_flags = relsim_flags;
1364 crs.openings = openings;
1365 crs.release_timeout = arg;
1366 xpt_action((union ccb *)&crs);
1367 return (crs.qfrozen_cnt);
1370 #define saved_ccb_ptr ppriv_ptr0
1372 camperiphdone(struct cam_periph *periph, union ccb *done_ccb)
1374 union ccb *saved_ccb;
1376 struct scsi_start_stop_unit *scsi_cmd;
1377 int error = 0, error_code, sense_key, asc, ascq;
1379 scsi_cmd = (struct scsi_start_stop_unit *)
1380 &done_ccb->csio.cdb_io.cdb_bytes;
1381 status = done_ccb->ccb_h.status;
1383 if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1384 if (scsi_extract_sense_ccb(done_ccb,
1385 &error_code, &sense_key, &asc, &ascq)) {
1387 * If the error is "invalid field in CDB",
1388 * and the load/eject flag is set, turn the
1389 * flag off and try again. This is just in
1390 * case the drive in question barfs on the
1391 * load eject flag. The CAM code should set
1392 * the load/eject flag by default for
1395 if ((scsi_cmd->opcode == START_STOP_UNIT) &&
1396 ((scsi_cmd->how & SSS_LOEJ) != 0) &&
1397 (asc == 0x24) && (ascq == 0x00)) {
1398 scsi_cmd->how &= ~SSS_LOEJ;
1399 if (status & CAM_DEV_QFRZN) {
1400 cam_release_devq(done_ccb->ccb_h.path,
1402 done_ccb->ccb_h.status &=
1405 xpt_action(done_ccb);
1409 error = cam_periph_error(done_ccb, 0,
1410 SF_RETRY_UA | SF_NO_PRINT);
1411 if (error == ERESTART)
1413 if (done_ccb->ccb_h.status & CAM_DEV_QFRZN) {
1414 cam_release_devq(done_ccb->ccb_h.path, 0, 0, 0, 0);
1415 done_ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1419 * If we have successfully taken a device from the not
1420 * ready to ready state, re-scan the device and re-get
1421 * the inquiry information. Many devices (mostly disks)
1422 * don't properly report their inquiry information unless
1425 if (scsi_cmd->opcode == START_STOP_UNIT)
1426 xpt_async(AC_INQ_CHANGED, done_ccb->ccb_h.path, NULL);
1430 * After recovery action(s) completed, return to the original CCB.
1431 * If the recovery CCB has failed, considering its own possible
1432 * retries and recovery, assume we are back in state where we have
1433 * been originally, but without recovery hopes left. In such case,
1434 * after the final attempt below, we cancel any further retries,
1435 * blocking by that also any new recovery attempts for this CCB,
1436 * and the result will be the final one returned to the CCB owher.
1438 saved_ccb = (union ccb *)done_ccb->ccb_h.saved_ccb_ptr;
1439 bcopy(saved_ccb, done_ccb, sizeof(*done_ccb));
1440 xpt_free_ccb(saved_ccb);
1441 if (done_ccb->ccb_h.cbfcnp != camperiphdone)
1442 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
1444 done_ccb->ccb_h.retry_count = 0;
1445 xpt_action(done_ccb);
1448 /* Drop freeze taken due to CAM_DEV_QFREEZE flag set. */
1449 cam_release_devq(done_ccb->ccb_h.path, 0, 0, 0, 0);
1453 * Generic Async Event handler. Peripheral drivers usually
1454 * filter out the events that require personal attention,
1455 * and leave the rest to this function.
1458 cam_periph_async(struct cam_periph *periph, u_int32_t code,
1459 struct cam_path *path, void *arg)
1462 case AC_LOST_DEVICE:
1463 cam_periph_invalidate(periph);
1471 cam_periph_bus_settle(struct cam_periph *periph, u_int bus_settle)
1473 struct ccb_getdevstats cgds;
1475 xpt_setup_ccb(&cgds.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
1476 cgds.ccb_h.func_code = XPT_GDEV_STATS;
1477 xpt_action((union ccb *)&cgds);
1478 cam_periph_freeze_after_event(periph, &cgds.last_reset, bus_settle);
1482 cam_periph_freeze_after_event(struct cam_periph *periph,
1483 struct timeval* event_time, u_int duration_ms)
1485 struct timeval delta;
1486 struct timeval duration_tv;
1488 if (!timevalisset(event_time))
1492 timevalsub(&delta, event_time);
1493 duration_tv.tv_sec = duration_ms / 1000;
1494 duration_tv.tv_usec = (duration_ms % 1000) * 1000;
1495 if (timevalcmp(&delta, &duration_tv, <)) {
1496 timevalsub(&duration_tv, &delta);
1498 duration_ms = duration_tv.tv_sec * 1000;
1499 duration_ms += duration_tv.tv_usec / 1000;
1500 cam_freeze_devq(periph->path);
1501 cam_release_devq(periph->path,
1502 RELSIM_RELEASE_AFTER_TIMEOUT,
1504 /*timeout*/duration_ms,
1505 /*getcount_only*/0);
1511 camperiphscsistatuserror(union ccb *ccb, union ccb **orig_ccb,
1512 cam_flags camflags, u_int32_t sense_flags,
1513 int *openings, u_int32_t *relsim_flags,
1514 u_int32_t *timeout, u_int32_t *action, const char **action_string)
1516 struct cam_periph *periph;
1519 switch (ccb->csio.scsi_status) {
1520 case SCSI_STATUS_OK:
1521 case SCSI_STATUS_COND_MET:
1522 case SCSI_STATUS_INTERMED:
1523 case SCSI_STATUS_INTERMED_COND_MET:
1526 case SCSI_STATUS_CMD_TERMINATED:
1527 case SCSI_STATUS_CHECK_COND:
1528 error = camperiphscsisenseerror(ccb, orig_ccb,
1537 case SCSI_STATUS_QUEUE_FULL:
1540 struct ccb_getdevstats cgds;
1543 * First off, find out what the current
1544 * transaction counts are.
1546 xpt_setup_ccb(&cgds.ccb_h,
1548 CAM_PRIORITY_NORMAL);
1549 cgds.ccb_h.func_code = XPT_GDEV_STATS;
1550 xpt_action((union ccb *)&cgds);
1553 * If we were the only transaction active, treat
1554 * the QUEUE FULL as if it were a BUSY condition.
1556 if (cgds.dev_active != 0) {
1560 * Reduce the number of openings to
1561 * be 1 less than the amount it took
1562 * to get a queue full bounded by the
1563 * minimum allowed tag count for this
1566 total_openings = cgds.dev_active + cgds.dev_openings;
1567 *openings = cgds.dev_active;
1568 if (*openings < cgds.mintags)
1569 *openings = cgds.mintags;
1570 if (*openings < total_openings)
1571 *relsim_flags = RELSIM_ADJUST_OPENINGS;
1574 * Some devices report queue full for
1575 * temporary resource shortages. For
1576 * this reason, we allow a minimum
1577 * tag count to be entered via a
1578 * quirk entry to prevent the queue
1579 * count on these devices from falling
1580 * to a pessimisticly low value. We
1581 * still wait for the next successful
1582 * completion, however, before queueing
1583 * more transactions to the device.
1585 *relsim_flags = RELSIM_RELEASE_AFTER_CMDCMPLT;
1589 *action &= ~SSQ_PRINT_SENSE;
1594 case SCSI_STATUS_BUSY:
1596 * Restart the queue after either another
1597 * command completes or a 1 second timeout.
1599 periph = xpt_path_periph(ccb->ccb_h.path);
1600 if (periph->flags & CAM_PERIPH_INVALID) {
1602 *action_string = "Periph was invalidated";
1603 } else if ((sense_flags & SF_RETRY_BUSY) != 0 ||
1604 ccb->ccb_h.retry_count > 0) {
1605 if ((sense_flags & SF_RETRY_BUSY) == 0)
1606 ccb->ccb_h.retry_count--;
1608 *relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT
1609 | RELSIM_RELEASE_AFTER_CMDCMPLT;
1613 *action_string = "Retries exhausted";
1616 case SCSI_STATUS_RESERV_CONFLICT:
1625 camperiphscsisenseerror(union ccb *ccb, union ccb **orig,
1626 cam_flags camflags, u_int32_t sense_flags,
1627 int *openings, u_int32_t *relsim_flags,
1628 u_int32_t *timeout, u_int32_t *action, const char **action_string)
1630 struct cam_periph *periph;
1631 union ccb *orig_ccb = ccb;
1632 int error, recoveryccb;
1634 #if defined(BUF_TRACKING) || defined(FULL_BUF_TRACKING)
1635 if (ccb->ccb_h.func_code == XPT_SCSI_IO && ccb->csio.bio != NULL)
1636 biotrack(ccb->csio.bio, __func__);
1639 periph = xpt_path_periph(ccb->ccb_h.path);
1640 recoveryccb = (ccb->ccb_h.cbfcnp == camperiphdone);
1641 if ((periph->flags & CAM_PERIPH_RECOVERY_INPROG) && !recoveryccb) {
1643 * If error recovery is already in progress, don't attempt
1644 * to process this error, but requeue it unconditionally
1645 * and attempt to process it once error recovery has
1646 * completed. This failed command is probably related to
1647 * the error that caused the currently active error recovery
1648 * action so our current recovery efforts should also
1649 * address this command. Be aware that the error recovery
1650 * code assumes that only one recovery action is in progress
1651 * on a particular peripheral instance at any given time
1652 * (e.g. only one saved CCB for error recovery) so it is
1653 * imperitive that we don't violate this assumption.
1656 *action &= ~SSQ_PRINT_SENSE;
1658 scsi_sense_action err_action;
1659 struct ccb_getdev cgd;
1662 * Grab the inquiry data for this device.
1664 xpt_setup_ccb(&cgd.ccb_h, ccb->ccb_h.path, CAM_PRIORITY_NORMAL);
1665 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1666 xpt_action((union ccb *)&cgd);
1668 err_action = scsi_error_action(&ccb->csio, &cgd.inq_data,
1670 error = err_action & SS_ERRMASK;
1673 * Do not autostart sequential access devices
1674 * to avoid unexpected tape loading.
1676 if ((err_action & SS_MASK) == SS_START &&
1677 SID_TYPE(&cgd.inq_data) == T_SEQUENTIAL) {
1678 *action_string = "Will not autostart a "
1679 "sequential access device";
1680 goto sense_error_done;
1684 * Avoid recovery recursion if recovery action is the same.
1686 if ((err_action & SS_MASK) >= SS_START && recoveryccb) {
1687 if (((err_action & SS_MASK) == SS_START &&
1688 ccb->csio.cdb_io.cdb_bytes[0] == START_STOP_UNIT) ||
1689 ((err_action & SS_MASK) == SS_TUR &&
1690 (ccb->csio.cdb_io.cdb_bytes[0] == TEST_UNIT_READY))) {
1691 err_action = SS_RETRY|SSQ_DECREMENT_COUNT|EIO;
1692 *relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1698 * If the recovery action will consume a retry,
1699 * make sure we actually have retries available.
1701 if ((err_action & SSQ_DECREMENT_COUNT) != 0) {
1702 if (ccb->ccb_h.retry_count > 0 &&
1703 (periph->flags & CAM_PERIPH_INVALID) == 0)
1704 ccb->ccb_h.retry_count--;
1706 *action_string = "Retries exhausted";
1707 goto sense_error_done;
1711 if ((err_action & SS_MASK) >= SS_START) {
1713 * Do common portions of commands that
1714 * use recovery CCBs.
1716 orig_ccb = xpt_alloc_ccb_nowait();
1717 if (orig_ccb == NULL) {
1718 *action_string = "Can't allocate recovery CCB";
1719 goto sense_error_done;
1722 * Clear freeze flag for original request here, as
1723 * this freeze will be dropped as part of ERESTART.
1725 ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1726 bcopy(ccb, orig_ccb, sizeof(*orig_ccb));
1729 switch (err_action & SS_MASK) {
1731 *action_string = "No recovery action needed";
1735 *action_string = "Retrying command (per sense data)";
1739 *action_string = "Unretryable error";
1746 * Send a start unit command to the device, and
1747 * then retry the command.
1749 *action_string = "Attempting to start unit";
1750 periph->flags |= CAM_PERIPH_RECOVERY_INPROG;
1753 * Check for removable media and set
1754 * load/eject flag appropriately.
1756 if (SID_IS_REMOVABLE(&cgd.inq_data))
1761 scsi_start_stop(&ccb->csio,
1775 * Send a Test Unit Ready to the device.
1776 * If the 'many' flag is set, we send 120
1777 * test unit ready commands, one every half
1778 * second. Otherwise, we just send one TUR.
1779 * We only want to do this if the retry
1780 * count has not been exhausted.
1784 if ((err_action & SSQ_MANY) != 0) {
1785 *action_string = "Polling device for readiness";
1788 *action_string = "Testing device for readiness";
1791 periph->flags |= CAM_PERIPH_RECOVERY_INPROG;
1792 scsi_test_unit_ready(&ccb->csio,
1800 * Accomplish our 500ms delay by deferring
1801 * the release of our device queue appropriately.
1803 *relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1808 panic("Unhandled error action %x", err_action);
1811 if ((err_action & SS_MASK) >= SS_START) {
1813 * Drop the priority, so that the recovery
1814 * CCB is the first to execute. Freeze the queue
1815 * after this command is sent so that we can
1816 * restore the old csio and have it queued in
1817 * the proper order before we release normal
1818 * transactions to the device.
1820 ccb->ccb_h.pinfo.priority--;
1821 ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1822 ccb->ccb_h.saved_ccb_ptr = orig_ccb;
1828 *action = err_action;
1834 * Generic error handler. Peripheral drivers usually filter
1835 * out the errors that they handle in a unique manner, then
1836 * call this function.
1839 cam_periph_error(union ccb *ccb, cam_flags camflags,
1840 u_int32_t sense_flags)
1842 struct cam_path *newpath;
1843 union ccb *orig_ccb, *scan_ccb;
1844 struct cam_periph *periph;
1845 const char *action_string;
1847 int frozen, error, openings, devctl_err;
1848 u_int32_t action, relsim_flags, timeout;
1850 action = SSQ_PRINT_SENSE;
1851 periph = xpt_path_periph(ccb->ccb_h.path);
1852 action_string = NULL;
1853 status = ccb->ccb_h.status;
1854 frozen = (status & CAM_DEV_QFRZN) != 0;
1855 status &= CAM_STATUS_MASK;
1856 devctl_err = openings = relsim_flags = timeout = 0;
1859 /* Filter the errors that should be reported via devctl */
1860 switch (ccb->ccb_h.status & CAM_STATUS_MASK) {
1861 case CAM_CMD_TIMEOUT:
1862 case CAM_REQ_ABORTED:
1863 case CAM_REQ_CMP_ERR:
1864 case CAM_REQ_TERMIO:
1865 case CAM_UNREC_HBA_ERROR:
1866 case CAM_DATA_RUN_ERR:
1867 case CAM_SCSI_STATUS_ERROR:
1868 case CAM_ATA_STATUS_ERROR:
1869 case CAM_SMP_STATUS_ERROR:
1879 action &= ~SSQ_PRINT_SENSE;
1881 case CAM_SCSI_STATUS_ERROR:
1882 error = camperiphscsistatuserror(ccb, &orig_ccb,
1883 camflags, sense_flags, &openings, &relsim_flags,
1884 &timeout, &action, &action_string);
1886 case CAM_AUTOSENSE_FAIL:
1887 error = EIO; /* we have to kill the command */
1891 case CAM_MSG_REJECT_REC:
1892 /* XXX Don't know that these are correct */
1895 case CAM_SEL_TIMEOUT:
1896 if ((camflags & CAM_RETRY_SELTO) != 0) {
1897 if (ccb->ccb_h.retry_count > 0 &&
1898 (periph->flags & CAM_PERIPH_INVALID) == 0) {
1899 ccb->ccb_h.retry_count--;
1903 * Wait a bit to give the device
1904 * time to recover before we try again.
1906 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1907 timeout = periph_selto_delay;
1910 action_string = "Retries exhausted";
1913 case CAM_DEV_NOT_THERE:
1917 case CAM_REQ_INVALID:
1918 case CAM_PATH_INVALID:
1920 case CAM_PROVIDE_FAIL:
1921 case CAM_REQ_TOO_BIG:
1922 case CAM_LUN_INVALID:
1923 case CAM_TID_INVALID:
1924 case CAM_FUNC_NOTAVAIL:
1927 case CAM_SCSI_BUS_RESET:
1930 * Commands that repeatedly timeout and cause these
1931 * kinds of error recovery actions, should return
1932 * CAM_CMD_TIMEOUT, which allows us to safely assume
1933 * that this command was an innocent bystander to
1934 * these events and should be unconditionally
1937 case CAM_REQUEUE_REQ:
1938 /* Unconditional requeue if device is still there */
1939 if (periph->flags & CAM_PERIPH_INVALID) {
1940 action_string = "Periph was invalidated";
1942 } else if (sense_flags & SF_NO_RETRY) {
1944 action_string = "Retry was blocked";
1947 action &= ~SSQ_PRINT_SENSE;
1950 case CAM_RESRC_UNAVAIL:
1951 /* Wait a bit for the resource shortage to abate. */
1952 timeout = periph_noresrc_delay;
1956 /* Wait a bit for the busy condition to abate. */
1957 timeout = periph_busy_delay;
1959 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1961 case CAM_ATA_STATUS_ERROR:
1962 case CAM_REQ_CMP_ERR:
1963 case CAM_CMD_TIMEOUT:
1964 case CAM_UNEXP_BUSFREE:
1965 case CAM_UNCOR_PARITY:
1966 case CAM_DATA_RUN_ERR:
1968 if (periph->flags & CAM_PERIPH_INVALID) {
1970 action_string = "Periph was invalidated";
1971 } else if (ccb->ccb_h.retry_count == 0) {
1973 action_string = "Retries exhausted";
1974 } else if (sense_flags & SF_NO_RETRY) {
1976 action_string = "Retry was blocked";
1978 ccb->ccb_h.retry_count--;
1984 if ((sense_flags & SF_PRINT_ALWAYS) ||
1985 CAM_DEBUGGED(ccb->ccb_h.path, CAM_DEBUG_INFO))
1986 action |= SSQ_PRINT_SENSE;
1987 else if (sense_flags & SF_NO_PRINT)
1988 action &= ~SSQ_PRINT_SENSE;
1989 if ((action & SSQ_PRINT_SENSE) != 0)
1990 cam_error_print(orig_ccb, CAM_ESF_ALL, CAM_EPF_ALL);
1991 if (error != 0 && (action & SSQ_PRINT_SENSE) != 0) {
1992 if (error != ERESTART) {
1993 if (action_string == NULL)
1994 action_string = "Unretryable error";
1995 xpt_print(ccb->ccb_h.path, "Error %d, %s\n",
1996 error, action_string);
1997 } else if (action_string != NULL)
1998 xpt_print(ccb->ccb_h.path, "%s\n", action_string);
2000 xpt_print(ccb->ccb_h.path,
2001 "Retrying command, %d more tries remain\n",
2002 ccb->ccb_h.retry_count);
2006 if (devctl_err && (error != 0 || (action & SSQ_PRINT_SENSE) != 0))
2007 cam_periph_devctl_notify(orig_ccb);
2009 if ((action & SSQ_LOST) != 0) {
2013 * For a selection timeout, we consider all of the LUNs on
2014 * the target to be gone. If the status is CAM_DEV_NOT_THERE,
2015 * then we only get rid of the device(s) specified by the
2016 * path in the original CCB.
2018 if (status == CAM_SEL_TIMEOUT)
2019 lun_id = CAM_LUN_WILDCARD;
2021 lun_id = xpt_path_lun_id(ccb->ccb_h.path);
2023 /* Should we do more if we can't create the path?? */
2024 if (xpt_create_path(&newpath, periph,
2025 xpt_path_path_id(ccb->ccb_h.path),
2026 xpt_path_target_id(ccb->ccb_h.path),
2027 lun_id) == CAM_REQ_CMP) {
2030 * Let peripheral drivers know that this
2031 * device has gone away.
2033 xpt_async(AC_LOST_DEVICE, newpath, NULL);
2034 xpt_free_path(newpath);
2038 /* Broadcast UNIT ATTENTIONs to all periphs. */
2039 if ((action & SSQ_UA) != 0)
2040 xpt_async(AC_UNIT_ATTENTION, orig_ccb->ccb_h.path, orig_ccb);
2042 /* Rescan target on "Reported LUNs data has changed" */
2043 if ((action & SSQ_RESCAN) != 0) {
2044 if (xpt_create_path(&newpath, NULL,
2045 xpt_path_path_id(ccb->ccb_h.path),
2046 xpt_path_target_id(ccb->ccb_h.path),
2047 CAM_LUN_WILDCARD) == CAM_REQ_CMP) {
2049 scan_ccb = xpt_alloc_ccb_nowait();
2050 if (scan_ccb != NULL) {
2051 scan_ccb->ccb_h.path = newpath;
2052 scan_ccb->ccb_h.func_code = XPT_SCAN_TGT;
2053 scan_ccb->crcn.flags = 0;
2054 xpt_rescan(scan_ccb);
2057 "Can't allocate CCB to rescan target\n");
2058 xpt_free_path(newpath);
2063 /* Attempt a retry */
2064 if (error == ERESTART || error == 0) {
2066 ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
2067 if (error == ERESTART)
2070 cam_release_devq(ccb->ccb_h.path,
2074 /*getcount_only*/0);
2080 #define CAM_PERIPH_DEVD_MSG_SIZE 256
2083 cam_periph_devctl_notify(union ccb *ccb)
2085 struct cam_periph *periph;
2086 struct ccb_getdev *cgd;
2088 int serr, sk, asc, ascq;
2091 sbmsg = malloc(CAM_PERIPH_DEVD_MSG_SIZE, M_CAMPERIPH, M_NOWAIT);
2095 sbuf_new(&sb, sbmsg, CAM_PERIPH_DEVD_MSG_SIZE, SBUF_FIXEDLEN);
2097 periph = xpt_path_periph(ccb->ccb_h.path);
2098 sbuf_printf(&sb, "device=%s%d ", periph->periph_name,
2099 periph->unit_number);
2101 sbuf_printf(&sb, "serial=\"");
2102 if ((cgd = (struct ccb_getdev *)xpt_alloc_ccb_nowait()) != NULL) {
2103 xpt_setup_ccb(&cgd->ccb_h, ccb->ccb_h.path,
2104 CAM_PRIORITY_NORMAL);
2105 cgd->ccb_h.func_code = XPT_GDEV_TYPE;
2106 xpt_action((union ccb *)cgd);
2108 if (cgd->ccb_h.status == CAM_REQ_CMP)
2109 sbuf_bcat(&sb, cgd->serial_num, cgd->serial_num_len);
2110 xpt_free_ccb((union ccb *)cgd);
2112 sbuf_printf(&sb, "\" ");
2113 sbuf_printf(&sb, "cam_status=\"0x%x\" ", ccb->ccb_h.status);
2115 switch (ccb->ccb_h.status & CAM_STATUS_MASK) {
2116 case CAM_CMD_TIMEOUT:
2117 sbuf_printf(&sb, "timeout=%d ", ccb->ccb_h.timeout);
2120 case CAM_SCSI_STATUS_ERROR:
2121 sbuf_printf(&sb, "scsi_status=%d ", ccb->csio.scsi_status);
2122 if (scsi_extract_sense_ccb(ccb, &serr, &sk, &asc, &ascq))
2123 sbuf_printf(&sb, "scsi_sense=\"%02x %02x %02x %02x\" ",
2124 serr, sk, asc, ascq);
2127 case CAM_ATA_STATUS_ERROR:
2128 sbuf_printf(&sb, "RES=\"");
2129 ata_res_sbuf(&ccb->ataio.res, &sb);
2130 sbuf_printf(&sb, "\" ");
2138 if (ccb->ccb_h.func_code == XPT_SCSI_IO) {
2139 sbuf_printf(&sb, "CDB=\"");
2140 scsi_cdb_sbuf(scsiio_cdb_ptr(&ccb->csio), &sb);
2141 sbuf_printf(&sb, "\" ");
2142 } else if (ccb->ccb_h.func_code == XPT_ATA_IO) {
2143 sbuf_printf(&sb, "ACB=\"");
2144 ata_cmd_sbuf(&ccb->ataio.cmd, &sb);
2145 sbuf_printf(&sb, "\" ");
2148 if (sbuf_finish(&sb) == 0)
2149 devctl_notify("CAM", "periph", type, sbuf_data(&sb));
2151 free(sbmsg, M_CAMPERIPH);
2155 * Sysctl to force an invalidation of the drive right now. Can be
2156 * called with CTLFLAG_MPSAFE since we take periph lock.
2159 cam_periph_invalidate_sysctl(SYSCTL_HANDLER_ARGS)
2161 struct cam_periph *periph;
2166 error = sysctl_handle_int(oidp, &value, 0, req);
2167 if (error != 0 || req->newptr == NULL || value != 1)
2170 cam_periph_lock(periph);
2171 cam_periph_invalidate(periph);
2172 cam_periph_unlock(periph);