xref: /freebsd/sys/cam/cam_periph.c (revision 90bcc81bc35e89049a94a12c259b0c53fcf7a299)
1898b0535SWarner Losh /*-
28b8a9b1dSJustin T. Gibbs  * Common functions for CAM "type" (peripheral) drivers.
38b8a9b1dSJustin T. Gibbs  *
4bec9534dSPedro F. Giffuni  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
5bec9534dSPedro F. Giffuni  *
68b8a9b1dSJustin T. Gibbs  * Copyright (c) 1997, 1998 Justin T. Gibbs.
7501468a5SKenneth D. Merry  * Copyright (c) 1997, 1998, 1999, 2000 Kenneth D. Merry.
88b8a9b1dSJustin T. Gibbs  * All rights reserved.
98b8a9b1dSJustin T. Gibbs  *
108b8a9b1dSJustin T. Gibbs  * Redistribution and use in source and binary forms, with or without
118b8a9b1dSJustin T. Gibbs  * modification, are permitted provided that the following conditions
128b8a9b1dSJustin T. Gibbs  * are met:
138b8a9b1dSJustin T. Gibbs  * 1. Redistributions of source code must retain the above copyright
148b8a9b1dSJustin T. Gibbs  *    notice, this list of conditions, and the following disclaimer,
158b8a9b1dSJustin T. Gibbs  *    without modification, immediately at the beginning of the file.
168b8a9b1dSJustin T. Gibbs  * 2. The name of the author may not be used to endorse or promote products
178b8a9b1dSJustin T. Gibbs  *    derived from this software without specific prior written permission.
188b8a9b1dSJustin T. Gibbs  *
198b8a9b1dSJustin T. Gibbs  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
208b8a9b1dSJustin T. Gibbs  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
218b8a9b1dSJustin T. Gibbs  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
228b8a9b1dSJustin T. Gibbs  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
238b8a9b1dSJustin T. Gibbs  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
248b8a9b1dSJustin T. Gibbs  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
258b8a9b1dSJustin T. Gibbs  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
268b8a9b1dSJustin T. Gibbs  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
278b8a9b1dSJustin T. Gibbs  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
288b8a9b1dSJustin T. Gibbs  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
298b8a9b1dSJustin T. Gibbs  * SUCH DAMAGE.
308b8a9b1dSJustin T. Gibbs  */
318b8a9b1dSJustin T. Gibbs 
329c963d87SDavid E. O'Brien #include <sys/cdefs.h>
339c963d87SDavid E. O'Brien __FBSDID("$FreeBSD$");
349c963d87SDavid E. O'Brien 
358b8a9b1dSJustin T. Gibbs #include <sys/param.h>
368b8a9b1dSJustin T. Gibbs #include <sys/systm.h>
378b8a9b1dSJustin T. Gibbs #include <sys/types.h>
388b8a9b1dSJustin T. Gibbs #include <sys/malloc.h>
39362abc44STai-hwa Liang #include <sys/kernel.h>
409626b608SPoul-Henning Kamp #include <sys/bio.h>
415cf3cd10SWarner Losh #include <sys/conf.h>
42773e541eSWarner Losh #include <sys/devctl.h>
43f34fa851SJohn Baldwin #include <sys/lock.h>
44f34fa851SJohn Baldwin #include <sys/mutex.h>
458b8a9b1dSJustin T. Gibbs #include <sys/buf.h>
468b8a9b1dSJustin T. Gibbs #include <sys/proc.h>
478b8a9b1dSJustin T. Gibbs #include <sys/devicestat.h>
483501942bSJustin T. Gibbs #include <sys/sbuf.h>
49b059686aSAlexander Motin #include <sys/sysctl.h>
508b8a9b1dSJustin T. Gibbs #include <vm/vm.h>
518b8a9b1dSJustin T. Gibbs #include <vm/vm_extern.h>
528b8a9b1dSJustin T. Gibbs 
538b8a9b1dSJustin T. Gibbs #include <cam/cam.h>
548b8a9b1dSJustin T. Gibbs #include <cam/cam_ccb.h>
5552c9ce25SScott Long #include <cam/cam_queue.h>
568b8a9b1dSJustin T. Gibbs #include <cam/cam_xpt_periph.h>
57447b3557SJohn Baldwin #include <cam/cam_xpt_internal.h>
588b8a9b1dSJustin T. Gibbs #include <cam/cam_periph.h>
598b8a9b1dSJustin T. Gibbs #include <cam/cam_debug.h>
602b83592fSScott Long #include <cam/cam_sim.h>
618b8a9b1dSJustin T. Gibbs 
628b8a9b1dSJustin T. Gibbs #include <cam/scsi/scsi_all.h>
638b8a9b1dSJustin T. Gibbs #include <cam/scsi/scsi_message.h>
648b8a9b1dSJustin T. Gibbs #include <cam/scsi/scsi_pass.h>
658b8a9b1dSJustin T. Gibbs 
668b8a9b1dSJustin T. Gibbs static	u_int		camperiphnextunit(struct periph_driver *p_drv,
67d836c48eSWarner Losh 					  u_int newunit, bool wired,
68501468a5SKenneth D. Merry 					  path_id_t pathid, target_id_t target,
69501468a5SKenneth D. Merry 					  lun_id_t lun);
708b8a9b1dSJustin T. Gibbs static	u_int		camperiphunit(struct periph_driver *p_drv,
71501468a5SKenneth D. Merry 				      path_id_t pathid, target_id_t target,
72577f9aa2SWarner Losh 				      lun_id_t lun,
73577f9aa2SWarner Losh 				      const char *sn);
748b8a9b1dSJustin T. Gibbs static	void		camperiphdone(struct cam_periph *periph,
758b8a9b1dSJustin T. Gibbs 					union ccb *done_ccb);
768b8a9b1dSJustin T. Gibbs static  void		camperiphfree(struct cam_periph *periph);
773393f8daSKenneth D. Merry static int		camperiphscsistatuserror(union ccb *ccb,
780191d9b3SAlexander Motin 					        union ccb **orig_ccb,
793393f8daSKenneth D. Merry 						 cam_flags camflags,
803393f8daSKenneth D. Merry 						 u_int32_t sense_flags,
813393f8daSKenneth D. Merry 						 int *openings,
823393f8daSKenneth D. Merry 						 u_int32_t *relsim_flags,
8383c5d981SAlexander Motin 						 u_int32_t *timeout,
840181d54bSAlexander Motin 						 u_int32_t  *action,
8583c5d981SAlexander Motin 						 const char **action_string);
863393f8daSKenneth D. Merry static	int		camperiphscsisenseerror(union ccb *ccb,
870191d9b3SAlexander Motin 					        union ccb **orig_ccb,
883393f8daSKenneth D. Merry 					        cam_flags camflags,
893393f8daSKenneth D. Merry 					        u_int32_t sense_flags,
903393f8daSKenneth D. Merry 					        int *openings,
913393f8daSKenneth D. Merry 					        u_int32_t *relsim_flags,
9283c5d981SAlexander Motin 					        u_int32_t *timeout,
930181d54bSAlexander Motin 					        u_int32_t *action,
9483c5d981SAlexander Motin 					        const char **action_string);
95a30ecd42SScott Long static void		cam_periph_devctl_notify(union ccb *ccb);
968b8a9b1dSJustin T. Gibbs 
970b7c27b9SPeter Wemm static int nperiph_drivers;
9883c5d981SAlexander Motin static int initialized = 0;
990b7c27b9SPeter Wemm struct periph_driver **periph_drivers;
1000b7c27b9SPeter Wemm 
101d745c852SEd Schouten static MALLOC_DEFINE(M_CAMPERIPH, "CAM periph", "CAM peripheral buffers");
102362abc44STai-hwa Liang 
10373cf209fSMatt Jacob static int periph_selto_delay = 1000;
10473cf209fSMatt Jacob TUNABLE_INT("kern.cam.periph_selto_delay", &periph_selto_delay);
10573cf209fSMatt Jacob static int periph_noresrc_delay = 500;
10673cf209fSMatt Jacob TUNABLE_INT("kern.cam.periph_noresrc_delay", &periph_noresrc_delay);
10773cf209fSMatt Jacob static int periph_busy_delay = 500;
10873cf209fSMatt Jacob TUNABLE_INT("kern.cam.periph_busy_delay", &periph_busy_delay);
10973cf209fSMatt Jacob 
110b059686aSAlexander Motin static u_int periph_mapmem_thresh = 65536;
111b059686aSAlexander Motin SYSCTL_UINT(_kern_cam, OID_AUTO, mapmem_thresh, CTLFLAG_RWTUN,
112b059686aSAlexander Motin     &periph_mapmem_thresh, 0, "Threshold for user-space buffer mapping");
11373cf209fSMatt Jacob 
1140b7c27b9SPeter Wemm void
1150b7c27b9SPeter Wemm periphdriver_register(void *data)
1160b7c27b9SPeter Wemm {
11783c5d981SAlexander Motin 	struct periph_driver *drv = (struct periph_driver *)data;
1180b7c27b9SPeter Wemm 	struct periph_driver **newdrivers, **old;
1190b7c27b9SPeter Wemm 	int ndrivers;
1200b7c27b9SPeter Wemm 
1215719711fSEdward Tomasz Napierala again:
1220b7c27b9SPeter Wemm 	ndrivers = nperiph_drivers + 2;
1230dd50e9bSScott Long 	newdrivers = malloc(sizeof(*newdrivers) * ndrivers, M_CAMPERIPH,
1240dd50e9bSScott Long 			    M_WAITOK);
1255719711fSEdward Tomasz Napierala 	xpt_lock_buses();
1265719711fSEdward Tomasz Napierala 	if (ndrivers != nperiph_drivers + 2) {
1275719711fSEdward Tomasz Napierala 		/*
1285719711fSEdward Tomasz Napierala 		 * Lost race against itself; go around.
1295719711fSEdward Tomasz Napierala 		 */
1305719711fSEdward Tomasz Napierala 		xpt_unlock_buses();
1315719711fSEdward Tomasz Napierala 		free(newdrivers, M_CAMPERIPH);
1325719711fSEdward Tomasz Napierala 		goto again;
1335719711fSEdward Tomasz Napierala 	}
1340b7c27b9SPeter Wemm 	if (periph_drivers)
1350b7c27b9SPeter Wemm 		bcopy(periph_drivers, newdrivers,
136623db360SKenneth D. Merry 		      sizeof(*newdrivers) * nperiph_drivers);
13783c5d981SAlexander Motin 	newdrivers[nperiph_drivers] = drv;
1380b7c27b9SPeter Wemm 	newdrivers[nperiph_drivers + 1] = NULL;
1390b7c27b9SPeter Wemm 	old = periph_drivers;
1400b7c27b9SPeter Wemm 	periph_drivers = newdrivers;
1415719711fSEdward Tomasz Napierala 	nperiph_drivers++;
1425719711fSEdward Tomasz Napierala 	xpt_unlock_buses();
1430b7c27b9SPeter Wemm 	if (old)
1440dd50e9bSScott Long 		free(old, M_CAMPERIPH);
14583c5d981SAlexander Motin 	/* If driver marked as early or it is late now, initialize it. */
14683c5d981SAlexander Motin 	if (((drv->flags & CAM_PERIPH_DRV_EARLY) != 0 && initialized > 0) ||
14783c5d981SAlexander Motin 	    initialized > 1)
14883c5d981SAlexander Motin 		(*drv->init)();
14983c5d981SAlexander Motin }
15083c5d981SAlexander Motin 
15194173c3cSAlexander Motin int
15294173c3cSAlexander Motin periphdriver_unregister(void *data)
15394173c3cSAlexander Motin {
15494173c3cSAlexander Motin 	struct periph_driver *drv = (struct periph_driver *)data;
15594173c3cSAlexander Motin 	int error, n;
15694173c3cSAlexander Motin 
15794173c3cSAlexander Motin 	/* If driver marked as early or it is late now, deinitialize it. */
15894173c3cSAlexander Motin 	if (((drv->flags & CAM_PERIPH_DRV_EARLY) != 0 && initialized > 0) ||
15994173c3cSAlexander Motin 	    initialized > 1) {
16094173c3cSAlexander Motin 		if (drv->deinit == NULL) {
16194173c3cSAlexander Motin 			printf("CAM periph driver '%s' doesn't have deinit.\n",
16294173c3cSAlexander Motin 			    drv->driver_name);
16394173c3cSAlexander Motin 			return (EOPNOTSUPP);
16494173c3cSAlexander Motin 		}
16594173c3cSAlexander Motin 		error = drv->deinit();
16694173c3cSAlexander Motin 		if (error != 0)
16794173c3cSAlexander Motin 			return (error);
16894173c3cSAlexander Motin 	}
16994173c3cSAlexander Motin 
17094173c3cSAlexander Motin 	xpt_lock_buses();
17194173c3cSAlexander Motin 	for (n = 0; n < nperiph_drivers && periph_drivers[n] != drv; n++)
17294173c3cSAlexander Motin 		;
17394173c3cSAlexander Motin 	KASSERT(n < nperiph_drivers,
17494173c3cSAlexander Motin 	    ("Periph driver '%s' was not registered", drv->driver_name));
17594173c3cSAlexander Motin 	for (; n + 1 < nperiph_drivers; n++)
17694173c3cSAlexander Motin 		periph_drivers[n] = periph_drivers[n + 1];
17794173c3cSAlexander Motin 	periph_drivers[n + 1] = NULL;
17894173c3cSAlexander Motin 	nperiph_drivers--;
17994173c3cSAlexander Motin 	xpt_unlock_buses();
18094173c3cSAlexander Motin 	return (0);
18194173c3cSAlexander Motin }
18294173c3cSAlexander Motin 
18383c5d981SAlexander Motin void
18483c5d981SAlexander Motin periphdriver_init(int level)
18583c5d981SAlexander Motin {
18683c5d981SAlexander Motin 	int	i, early;
18783c5d981SAlexander Motin 
18883c5d981SAlexander Motin 	initialized = max(initialized, level);
18983c5d981SAlexander Motin 	for (i = 0; periph_drivers[i] != NULL; i++) {
19083c5d981SAlexander Motin 		early = (periph_drivers[i]->flags & CAM_PERIPH_DRV_EARLY) ? 1 : 2;
19183c5d981SAlexander Motin 		if (early == initialized)
19283c5d981SAlexander Motin 			(*periph_drivers[i]->init)();
19383c5d981SAlexander Motin 	}
1940b7c27b9SPeter Wemm }
1950b7c27b9SPeter Wemm 
1968b8a9b1dSJustin T. Gibbs cam_status
197ee9c90c7SKenneth D. Merry cam_periph_alloc(periph_ctor_t *periph_ctor,
198ee9c90c7SKenneth D. Merry 		 periph_oninv_t *periph_oninvalidate,
199ee9c90c7SKenneth D. Merry 		 periph_dtor_t *periph_dtor, periph_start_t *periph_start,
200ee9c90c7SKenneth D. Merry 		 char *name, cam_periph_type type, struct cam_path *path,
201ee9c90c7SKenneth D. Merry 		 ac_callback_t *ac_callback, ac_code code, void *arg)
2028b8a9b1dSJustin T. Gibbs {
2038b8a9b1dSJustin T. Gibbs 	struct		periph_driver **p_drv;
2042b83592fSScott Long 	struct		cam_sim *sim;
2058b8a9b1dSJustin T. Gibbs 	struct		cam_periph *periph;
2068b8a9b1dSJustin T. Gibbs 	struct		cam_periph *cur_periph;
2078b8a9b1dSJustin T. Gibbs 	path_id_t	path_id;
2088b8a9b1dSJustin T. Gibbs 	target_id_t	target_id;
2098b8a9b1dSJustin T. Gibbs 	lun_id_t	lun_id;
2108b8a9b1dSJustin T. Gibbs 	cam_status	status;
2118b8a9b1dSJustin T. Gibbs 	u_int		init_level;
2128b8a9b1dSJustin T. Gibbs 
2138b8a9b1dSJustin T. Gibbs 	init_level = 0;
2148b8a9b1dSJustin T. Gibbs 	/*
2158b8a9b1dSJustin T. Gibbs 	 * Handle Hot-Plug scenarios.  If there is already a peripheral
2168b8a9b1dSJustin T. Gibbs 	 * of our type assigned to this path, we are likely waiting for
2178b8a9b1dSJustin T. Gibbs 	 * final close on an old, invalidated, peripheral.  If this is
2188b8a9b1dSJustin T. Gibbs 	 * the case, queue up a deferred call to the peripheral's async
21974c91ec5SJustin T. Gibbs 	 * handler.  If it looks like a mistaken re-allocation, complain.
2208b8a9b1dSJustin T. Gibbs 	 */
2218b8a9b1dSJustin T. Gibbs 	if ((periph = cam_periph_find(path, name)) != NULL) {
2228b8a9b1dSJustin T. Gibbs 		if ((periph->flags & CAM_PERIPH_INVALID) != 0
2238b8a9b1dSJustin T. Gibbs 		 && (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) == 0) {
2248b8a9b1dSJustin T. Gibbs 			periph->flags |= CAM_PERIPH_NEW_DEV_FOUND;
2258b8a9b1dSJustin T. Gibbs 			periph->deferred_callback = ac_callback;
2268b8a9b1dSJustin T. Gibbs 			periph->deferred_ac = code;
2278b8a9b1dSJustin T. Gibbs 			return (CAM_REQ_INPROG);
2288b8a9b1dSJustin T. Gibbs 		} else {
2298b8a9b1dSJustin T. Gibbs 			printf("cam_periph_alloc: attempt to re-allocate "
2308900f4b8SKenneth D. Merry 			       "valid device %s%d rejected flags %#x "
2318900f4b8SKenneth D. Merry 			       "refcount %d\n", periph->periph_name,
2328900f4b8SKenneth D. Merry 			       periph->unit_number, periph->flags,
2338900f4b8SKenneth D. Merry 			       periph->refcount);
2348b8a9b1dSJustin T. Gibbs 		}
2358b8a9b1dSJustin T. Gibbs 		return (CAM_REQ_INVALID);
2368b8a9b1dSJustin T. Gibbs 	}
2378b8a9b1dSJustin T. Gibbs 
238362abc44STai-hwa Liang 	periph = (struct cam_periph *)malloc(sizeof(*periph), M_CAMPERIPH,
2398900f4b8SKenneth D. Merry 					     M_NOWAIT|M_ZERO);
2408b8a9b1dSJustin T. Gibbs 
2418b8a9b1dSJustin T. Gibbs 	if (periph == NULL)
2428b8a9b1dSJustin T. Gibbs 		return (CAM_RESRC_UNAVAIL);
2438b8a9b1dSJustin T. Gibbs 
2448b8a9b1dSJustin T. Gibbs 	init_level++;
2458b8a9b1dSJustin T. Gibbs 
2462b83592fSScott Long 	sim = xpt_path_sim(path);
2478b8a9b1dSJustin T. Gibbs 	path_id = xpt_path_path_id(path);
2488b8a9b1dSJustin T. Gibbs 	target_id = xpt_path_target_id(path);
2498b8a9b1dSJustin T. Gibbs 	lun_id = xpt_path_lun_id(path);
2508b8a9b1dSJustin T. Gibbs 	periph->periph_start = periph_start;
2518b8a9b1dSJustin T. Gibbs 	periph->periph_dtor = periph_dtor;
252ee9c90c7SKenneth D. Merry 	periph->periph_oninval = periph_oninvalidate;
2538b8a9b1dSJustin T. Gibbs 	periph->type = type;
2548b8a9b1dSJustin T. Gibbs 	periph->periph_name = name;
255227d67aaSAlexander Motin 	periph->scheduled_priority = CAM_PRIORITY_NONE;
2568b8a9b1dSJustin T. Gibbs 	periph->immediate_priority = CAM_PRIORITY_NONE;
257d38c0e53SAlexander Motin 	periph->refcount = 1;		/* Dropped by invalidation. */
2582b83592fSScott Long 	periph->sim = sim;
2598b8a9b1dSJustin T. Gibbs 	SLIST_INIT(&periph->ccb_list);
2608b8a9b1dSJustin T. Gibbs 	status = xpt_create_path(&path, periph, path_id, target_id, lun_id);
2618b8a9b1dSJustin T. Gibbs 	if (status != CAM_REQ_CMP)
2628b8a9b1dSJustin T. Gibbs 		goto failure;
2638b8a9b1dSJustin T. Gibbs 	periph->path = path;
2648b8a9b1dSJustin T. Gibbs 
265f1e2546aSMatt Jacob 	xpt_lock_buses();
266f1e2546aSMatt Jacob 	for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
267f1e2546aSMatt Jacob 		if (strcmp((*p_drv)->driver_name, name) == 0)
268f1e2546aSMatt Jacob 			break;
269f1e2546aSMatt Jacob 	}
270f1e2546aSMatt Jacob 	if (*p_drv == NULL) {
271f1e2546aSMatt Jacob 		printf("cam_periph_alloc: invalid periph name '%s'\n", name);
2729e0d30e2SEdward Tomasz Napierala 		xpt_unlock_buses();
273f1e2546aSMatt Jacob 		xpt_free_path(periph->path);
274f1e2546aSMatt Jacob 		free(periph, M_CAMPERIPH);
275f1e2546aSMatt Jacob 		return (CAM_REQ_INVALID);
276f1e2546aSMatt Jacob 	}
277577f9aa2SWarner Losh 	periph->unit_number = camperiphunit(*p_drv, path_id, target_id, lun_id,
278577f9aa2SWarner Losh 	    path->device->serial_num);
2798b8a9b1dSJustin T. Gibbs 	cur_periph = TAILQ_FIRST(&(*p_drv)->units);
2808b8a9b1dSJustin T. Gibbs 	while (cur_periph != NULL
2818b8a9b1dSJustin T. Gibbs 	    && cur_periph->unit_number < periph->unit_number)
2828b8a9b1dSJustin T. Gibbs 		cur_periph = TAILQ_NEXT(cur_periph, unit_links);
283f1e2546aSMatt Jacob 	if (cur_periph != NULL) {
284dbfe5dd3SWarner Losh 		KASSERT(cur_periph->unit_number != periph->unit_number,
285dbfe5dd3SWarner Losh 		    ("duplicate units on periph list"));
2868b8a9b1dSJustin T. Gibbs 		TAILQ_INSERT_BEFORE(cur_periph, periph, unit_links);
287f1e2546aSMatt Jacob 	} else {
2888b8a9b1dSJustin T. Gibbs 		TAILQ_INSERT_TAIL(&(*p_drv)->units, periph, unit_links);
2898b8a9b1dSJustin T. Gibbs 		(*p_drv)->generation++;
2908b8a9b1dSJustin T. Gibbs 	}
291f1e2546aSMatt Jacob 	xpt_unlock_buses();
292f1e2546aSMatt Jacob 
293f1e2546aSMatt Jacob 	init_level++;
294f1e2546aSMatt Jacob 
295f1e2546aSMatt Jacob 	status = xpt_add_periph(periph);
296f1e2546aSMatt Jacob 	if (status != CAM_REQ_CMP)
297f1e2546aSMatt Jacob 		goto failure;
2988b8a9b1dSJustin T. Gibbs 
2998b8a9b1dSJustin T. Gibbs 	init_level++;
30022c7d606SAlexander Motin 	CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph created\n"));
3018b8a9b1dSJustin T. Gibbs 
3028b8a9b1dSJustin T. Gibbs 	status = periph_ctor(periph, arg);
3038b8a9b1dSJustin T. Gibbs 
3048b8a9b1dSJustin T. Gibbs 	if (status == CAM_REQ_CMP)
3058b8a9b1dSJustin T. Gibbs 		init_level++;
3068b8a9b1dSJustin T. Gibbs 
3078b8a9b1dSJustin T. Gibbs failure:
3088b8a9b1dSJustin T. Gibbs 	switch (init_level) {
3098b8a9b1dSJustin T. Gibbs 	case 4:
3108b8a9b1dSJustin T. Gibbs 		/* Initialized successfully */
3118b8a9b1dSJustin T. Gibbs 		break;
3128b8a9b1dSJustin T. Gibbs 	case 3:
31322c7d606SAlexander Motin 		CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph destroyed\n"));
314a29779e8SAlexander Motin 		xpt_remove_periph(periph);
3157379c88fSPoul-Henning Kamp 		/* FALLTHROUGH */
3168b8a9b1dSJustin T. Gibbs 	case 2:
317f1e2546aSMatt Jacob 		xpt_lock_buses();
318f1e2546aSMatt Jacob 		TAILQ_REMOVE(&(*p_drv)->units, periph, unit_links);
319f1e2546aSMatt Jacob 		xpt_unlock_buses();
3208b8a9b1dSJustin T. Gibbs 		xpt_free_path(periph->path);
3217379c88fSPoul-Henning Kamp 		/* FALLTHROUGH */
3228b8a9b1dSJustin T. Gibbs 	case 1:
323362abc44STai-hwa Liang 		free(periph, M_CAMPERIPH);
3247379c88fSPoul-Henning Kamp 		/* FALLTHROUGH */
3258b8a9b1dSJustin T. Gibbs 	case 0:
3268b8a9b1dSJustin T. Gibbs 		/* No cleanup to perform. */
3278b8a9b1dSJustin T. Gibbs 		break;
3288b8a9b1dSJustin T. Gibbs 	default:
329905cb85dSKenneth D. Merry 		panic("%s: Unknown init level", __func__);
3308b8a9b1dSJustin T. Gibbs 	}
3318b8a9b1dSJustin T. Gibbs 	return(status);
3328b8a9b1dSJustin T. Gibbs }
3338b8a9b1dSJustin T. Gibbs 
3348b8a9b1dSJustin T. Gibbs /*
3358b8a9b1dSJustin T. Gibbs  * Find a peripheral structure with the specified path, target, lun,
3368b8a9b1dSJustin T. Gibbs  * and (optionally) type.  If the name is NULL, this function will return
3378b8a9b1dSJustin T. Gibbs  * the first peripheral driver that matches the specified path.
3388b8a9b1dSJustin T. Gibbs  */
3398b8a9b1dSJustin T. Gibbs struct cam_periph *
3408b8a9b1dSJustin T. Gibbs cam_periph_find(struct cam_path *path, char *name)
3418b8a9b1dSJustin T. Gibbs {
3428b8a9b1dSJustin T. Gibbs 	struct periph_driver **p_drv;
3438b8a9b1dSJustin T. Gibbs 	struct cam_periph *periph;
3448b8a9b1dSJustin T. Gibbs 
34577dc25ccSScott Long 	xpt_lock_buses();
3460b7c27b9SPeter Wemm 	for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
3478b8a9b1dSJustin T. Gibbs 		if (name != NULL && (strcmp((*p_drv)->driver_name, name) != 0))
3488b8a9b1dSJustin T. Gibbs 			continue;
3498b8a9b1dSJustin T. Gibbs 
35037d40066SPoul-Henning Kamp 		TAILQ_FOREACH(periph, &(*p_drv)->units, unit_links) {
3518b8a9b1dSJustin T. Gibbs 			if (xpt_path_comp(periph->path, path) == 0) {
35277dc25ccSScott Long 				xpt_unlock_buses();
353227d67aaSAlexander Motin 				cam_periph_assert(periph, MA_OWNED);
3548b8a9b1dSJustin T. Gibbs 				return(periph);
3558b8a9b1dSJustin T. Gibbs 			}
3568b8a9b1dSJustin T. Gibbs 		}
35777dc25ccSScott Long 		if (name != NULL) {
35877dc25ccSScott Long 			xpt_unlock_buses();
3598b8a9b1dSJustin T. Gibbs 			return(NULL);
3608b8a9b1dSJustin T. Gibbs 		}
36177dc25ccSScott Long 	}
36277dc25ccSScott Long 	xpt_unlock_buses();
3638b8a9b1dSJustin T. Gibbs 	return(NULL);
3648b8a9b1dSJustin T. Gibbs }
3658b8a9b1dSJustin T. Gibbs 
3663501942bSJustin T. Gibbs /*
3678900f4b8SKenneth D. Merry  * Find peripheral driver instances attached to the specified path.
3683501942bSJustin T. Gibbs  */
3693501942bSJustin T. Gibbs int
3703501942bSJustin T. Gibbs cam_periph_list(struct cam_path *path, struct sbuf *sb)
3713501942bSJustin T. Gibbs {
3728900f4b8SKenneth D. Merry 	struct sbuf local_sb;
3733501942bSJustin T. Gibbs 	struct periph_driver **p_drv;
3743501942bSJustin T. Gibbs 	struct cam_periph *periph;
3753501942bSJustin T. Gibbs 	int count;
3768900f4b8SKenneth D. Merry 	int sbuf_alloc_len;
3773501942bSJustin T. Gibbs 
3788900f4b8SKenneth D. Merry 	sbuf_alloc_len = 16;
3798900f4b8SKenneth D. Merry retry:
3808900f4b8SKenneth D. Merry 	sbuf_new(&local_sb, NULL, sbuf_alloc_len, SBUF_FIXEDLEN);
3813501942bSJustin T. Gibbs 	count = 0;
3823501942bSJustin T. Gibbs 	xpt_lock_buses();
3833501942bSJustin T. Gibbs 	for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
3843501942bSJustin T. Gibbs 		TAILQ_FOREACH(periph, &(*p_drv)->units, unit_links) {
3853501942bSJustin T. Gibbs 			if (xpt_path_comp(periph->path, path) != 0)
3863501942bSJustin T. Gibbs 				continue;
3873501942bSJustin T. Gibbs 
3888900f4b8SKenneth D. Merry 			if (sbuf_len(&local_sb) != 0)
3898900f4b8SKenneth D. Merry 				sbuf_cat(&local_sb, ",");
3903501942bSJustin T. Gibbs 
3918900f4b8SKenneth D. Merry 			sbuf_printf(&local_sb, "%s%d", periph->periph_name,
3923501942bSJustin T. Gibbs 				    periph->unit_number);
3938900f4b8SKenneth D. Merry 
3948900f4b8SKenneth D. Merry 			if (sbuf_error(&local_sb) == ENOMEM) {
3958900f4b8SKenneth D. Merry 				sbuf_alloc_len *= 2;
3968900f4b8SKenneth D. Merry 				xpt_unlock_buses();
3978900f4b8SKenneth D. Merry 				sbuf_delete(&local_sb);
3988900f4b8SKenneth D. Merry 				goto retry;
3998900f4b8SKenneth D. Merry 			}
4003501942bSJustin T. Gibbs 			count++;
4013501942bSJustin T. Gibbs 		}
4023501942bSJustin T. Gibbs 	}
4033501942bSJustin T. Gibbs 	xpt_unlock_buses();
4048900f4b8SKenneth D. Merry 	sbuf_finish(&local_sb);
40507f7e4c8SAlexander Motin 	if (sbuf_len(sb) != 0)
40607f7e4c8SAlexander Motin 		sbuf_cat(sb, ",");
40707f7e4c8SAlexander Motin 	sbuf_cat(sb, sbuf_data(&local_sb));
4088900f4b8SKenneth D. Merry 	sbuf_delete(&local_sb);
4093501942bSJustin T. Gibbs 	return (count);
4103501942bSJustin T. Gibbs }
4113501942bSJustin T. Gibbs 
41299e7a4adSScott Long int
4138b8a9b1dSJustin T. Gibbs cam_periph_acquire(struct cam_periph *periph)
4148b8a9b1dSJustin T. Gibbs {
41599e7a4adSScott Long 	int status;
4168b8a9b1dSJustin T. Gibbs 
4178b8a9b1dSJustin T. Gibbs 	if (periph == NULL)
41899e7a4adSScott Long 		return (EINVAL);
4198b8a9b1dSJustin T. Gibbs 
42099e7a4adSScott Long 	status = ENOENT;
4212b83592fSScott Long 	xpt_lock_buses();
4228900f4b8SKenneth D. Merry 	if ((periph->flags & CAM_PERIPH_INVALID) == 0) {
4238b8a9b1dSJustin T. Gibbs 		periph->refcount++;
42499e7a4adSScott Long 		status = 0;
4258900f4b8SKenneth D. Merry 	}
4262b83592fSScott Long 	xpt_unlock_buses();
4278b8a9b1dSJustin T. Gibbs 
4288900f4b8SKenneth D. Merry 	return (status);
4298900f4b8SKenneth D. Merry }
4308900f4b8SKenneth D. Merry 
4318900f4b8SKenneth D. Merry void
432c33e4029SAlexander Motin cam_periph_doacquire(struct cam_periph *periph)
433c33e4029SAlexander Motin {
434c33e4029SAlexander Motin 
435c33e4029SAlexander Motin 	xpt_lock_buses();
436c33e4029SAlexander Motin 	KASSERT(periph->refcount >= 1,
437c33e4029SAlexander Motin 	    ("cam_periph_doacquire() with refcount == %d", periph->refcount));
438c33e4029SAlexander Motin 	periph->refcount++;
439c33e4029SAlexander Motin 	xpt_unlock_buses();
440c33e4029SAlexander Motin }
441c33e4029SAlexander Motin 
442c33e4029SAlexander Motin void
4438900f4b8SKenneth D. Merry cam_periph_release_locked_buses(struct cam_periph *periph)
4448900f4b8SKenneth D. Merry {
445dcdf6e74SAlexander Motin 
446227d67aaSAlexander Motin 	cam_periph_assert(periph, MA_OWNED);
447dcdf6e74SAlexander Motin 	KASSERT(periph->refcount >= 1, ("periph->refcount >= 1"));
448d38c0e53SAlexander Motin 	if (--periph->refcount == 0)
4498900f4b8SKenneth D. Merry 		camperiphfree(periph);
4508900f4b8SKenneth D. Merry }
4518b8a9b1dSJustin T. Gibbs 
4528b8a9b1dSJustin T. Gibbs void
45324ebf566SEdward Tomasz Napierala cam_periph_release_locked(struct cam_periph *periph)
4548b8a9b1dSJustin T. Gibbs {
4558b8a9b1dSJustin T. Gibbs 
4568b8a9b1dSJustin T. Gibbs 	if (periph == NULL)
4578b8a9b1dSJustin T. Gibbs 		return;
4588b8a9b1dSJustin T. Gibbs 
4592b83592fSScott Long 	xpt_lock_buses();
4608900f4b8SKenneth D. Merry 	cam_periph_release_locked_buses(periph);
4612b83592fSScott Long 	xpt_unlock_buses();
46224ebf566SEdward Tomasz Napierala }
4638b8a9b1dSJustin T. Gibbs 
46424ebf566SEdward Tomasz Napierala void
46524ebf566SEdward Tomasz Napierala cam_periph_release(struct cam_periph *periph)
46624ebf566SEdward Tomasz Napierala {
467227d67aaSAlexander Motin 	struct mtx *mtx;
46824ebf566SEdward Tomasz Napierala 
46924ebf566SEdward Tomasz Napierala 	if (periph == NULL)
47024ebf566SEdward Tomasz Napierala 		return;
47124ebf566SEdward Tomasz Napierala 
472227d67aaSAlexander Motin 	cam_periph_assert(periph, MA_NOTOWNED);
473227d67aaSAlexander Motin 	mtx = cam_periph_mtx(periph);
474227d67aaSAlexander Motin 	mtx_lock(mtx);
47524ebf566SEdward Tomasz Napierala 	cam_periph_release_locked(periph);
476227d67aaSAlexander Motin 	mtx_unlock(mtx);
4778b8a9b1dSJustin T. Gibbs }
4788b8a9b1dSJustin T. Gibbs 
4799385e92bSWarner Losh /*
4809385e92bSWarner Losh  * hold/unhold act as mutual exclusion for sections of the code that
4819385e92bSWarner Losh  * need to sleep and want to make sure that other sections that
4829385e92bSWarner Losh  * will interfere are held off. This only protects exclusive sections
4839385e92bSWarner Losh  * from each other.
4849385e92bSWarner Losh  */
4852b83592fSScott Long int
4862b83592fSScott Long cam_periph_hold(struct cam_periph *periph, int priority)
4872b83592fSScott Long {
4882b83592fSScott Long 	int error;
4892b83592fSScott Long 
4902b83592fSScott Long 	/*
4912b83592fSScott Long 	 * Increment the reference count on the peripheral
4922b83592fSScott Long 	 * while we wait for our lock attempt to succeed
4932b83592fSScott Long 	 * to ensure the peripheral doesn't disappear out
4942b83592fSScott Long 	 * from user us while we sleep.
4952b83592fSScott Long 	 */
4962b83592fSScott Long 
49799e7a4adSScott Long 	if (cam_periph_acquire(periph) != 0)
4982b83592fSScott Long 		return (ENXIO);
4992b83592fSScott Long 
500227d67aaSAlexander Motin 	cam_periph_assert(periph, MA_OWNED);
5012b83592fSScott Long 	while ((periph->flags & CAM_PERIPH_LOCKED) != 0) {
5022b83592fSScott Long 		periph->flags |= CAM_PERIPH_LOCK_WANTED;
503227d67aaSAlexander Motin 		if ((error = cam_periph_sleep(periph, periph, priority,
5041fa738c2SJohn Baldwin 		    "caplck", 0)) != 0) {
50524ebf566SEdward Tomasz Napierala 			cam_periph_release_locked(periph);
5062b83592fSScott Long 			return (error);
5072b83592fSScott Long 		}
508aed9c88cSAlexander Motin 		if (periph->flags & CAM_PERIPH_INVALID) {
509aed9c88cSAlexander Motin 			cam_periph_release_locked(periph);
510aed9c88cSAlexander Motin 			return (ENXIO);
511aed9c88cSAlexander Motin 		}
5122b83592fSScott Long 	}
5132b83592fSScott Long 
5142b83592fSScott Long 	periph->flags |= CAM_PERIPH_LOCKED;
5152b83592fSScott Long 	return (0);
5162b83592fSScott Long }
5172b83592fSScott Long 
5182b83592fSScott Long void
5192b83592fSScott Long cam_periph_unhold(struct cam_periph *periph)
5202b83592fSScott Long {
5212b83592fSScott Long 
522227d67aaSAlexander Motin 	cam_periph_assert(periph, MA_OWNED);
5232b83592fSScott Long 
5242b83592fSScott Long 	periph->flags &= ~CAM_PERIPH_LOCKED;
5252b83592fSScott Long 	if ((periph->flags & CAM_PERIPH_LOCK_WANTED) != 0) {
5262b83592fSScott Long 		periph->flags &= ~CAM_PERIPH_LOCK_WANTED;
5272b83592fSScott Long 		wakeup(periph);
5282b83592fSScott Long 	}
5292b83592fSScott Long 
53024ebf566SEdward Tomasz Napierala 	cam_periph_release_locked(periph);
5312b83592fSScott Long }
5322b83592fSScott Long 
533*90bcc81bSAlexander Motin void
534*90bcc81bSAlexander Motin cam_periph_hold_boot(struct cam_periph *periph)
535*90bcc81bSAlexander Motin {
536*90bcc81bSAlexander Motin 
537*90bcc81bSAlexander Motin 	root_mount_hold_token(periph->periph_name, &periph->periph_rootmount);
538*90bcc81bSAlexander Motin }
539*90bcc81bSAlexander Motin 
540*90bcc81bSAlexander Motin void
541*90bcc81bSAlexander Motin cam_periph_release_boot(struct cam_periph *periph)
542*90bcc81bSAlexander Motin {
543*90bcc81bSAlexander Motin 
544*90bcc81bSAlexander Motin 	root_mount_rel(&periph->periph_rootmount);
545*90bcc81bSAlexander Motin }
546*90bcc81bSAlexander Motin 
5478b8a9b1dSJustin T. Gibbs /*
5488b8a9b1dSJustin T. Gibbs  * Look for the next unit number that is not currently in use for this
5498b8a9b1dSJustin T. Gibbs  * peripheral type starting at "newunit".  Also exclude unit numbers that
5508b8a9b1dSJustin T. Gibbs  * are reserved by for future "hardwiring" unless we already know that this
5518b8a9b1dSJustin T. Gibbs  * is a potential wired device.  Only assume that the device is "wired" the
5528b8a9b1dSJustin T. Gibbs  * first time through the loop since after that we'll be looking at unit
5538b8a9b1dSJustin T. Gibbs  * numbers that did not match a wiring entry.
5548b8a9b1dSJustin T. Gibbs  */
5558b8a9b1dSJustin T. Gibbs static u_int
556d836c48eSWarner Losh camperiphnextunit(struct periph_driver *p_drv, u_int newunit, bool wired,
557501468a5SKenneth D. Merry 		  path_id_t pathid, target_id_t target, lun_id_t lun)
5588b8a9b1dSJustin T. Gibbs {
5598b8a9b1dSJustin T. Gibbs 	struct	cam_periph *periph;
5602398f0cdSPeter Wemm 	char	*periph_name;
5612398f0cdSPeter Wemm 	int	i, val, dunit, r;
5622398f0cdSPeter Wemm 	const char *dname, *strval;
5638b8a9b1dSJustin T. Gibbs 
5648b8a9b1dSJustin T. Gibbs 	periph_name = p_drv->driver_name;
5658b8a9b1dSJustin T. Gibbs 	for (;;newunit++) {
5668b8a9b1dSJustin T. Gibbs 		for (periph = TAILQ_FIRST(&p_drv->units);
5678b8a9b1dSJustin T. Gibbs 		     periph != NULL && periph->unit_number != newunit;
5688b8a9b1dSJustin T. Gibbs 		     periph = TAILQ_NEXT(periph, unit_links))
5698b8a9b1dSJustin T. Gibbs 			;
5708b8a9b1dSJustin T. Gibbs 
5718b8a9b1dSJustin T. Gibbs 		if (periph != NULL && periph->unit_number == newunit) {
572d836c48eSWarner Losh 			if (wired) {
573f0d9af51SMatt Jacob 				xpt_print(periph->path, "Duplicate Wired "
574f0d9af51SMatt Jacob 				    "Device entry!\n");
575f0d9af51SMatt Jacob 				xpt_print(periph->path, "Second device (%s "
576f0d9af51SMatt Jacob 				    "device at scbus%d target %d lun %d) will "
577f0d9af51SMatt Jacob 				    "not be wired\n", periph_name, pathid,
578f0d9af51SMatt Jacob 				    target, lun);
579d836c48eSWarner Losh 				wired = false;
5808b8a9b1dSJustin T. Gibbs 			}
5818b8a9b1dSJustin T. Gibbs 			continue;
5828b8a9b1dSJustin T. Gibbs 		}
58375f51904SPeter Wemm 		if (wired)
58475f51904SPeter Wemm 			break;
5858b8a9b1dSJustin T. Gibbs 
5868b8a9b1dSJustin T. Gibbs 		/*
58700f79c97SWarner Losh 		 * Don't allow the mere presence of any attributes of a device
58800f79c97SWarner Losh 		 * means that it is for a wired down entry. Instead, insist that
58900f79c97SWarner Losh 		 * one of the matching criteria from camperiphunit be present
59000f79c97SWarner Losh 		 * for the device.
5918b8a9b1dSJustin T. Gibbs 		 */
5922398f0cdSPeter Wemm 		i = 0;
5932398f0cdSPeter Wemm 		dname = periph_name;
5942398f0cdSPeter Wemm 		for (;;) {
5952398f0cdSPeter Wemm 			r = resource_find_dev(&i, dname, &dunit, NULL, NULL);
5962398f0cdSPeter Wemm 			if (r != 0)
5972398f0cdSPeter Wemm 				break;
598bee0133fSWarner Losh 
599bee0133fSWarner Losh 			if (newunit != dunit)
60075f51904SPeter Wemm 				continue;
601577f9aa2SWarner Losh 			if (resource_string_value(dname, dunit, "sn", &strval) == 0 ||
602577f9aa2SWarner Losh 			    resource_int_value(dname, dunit, "lun", &val) == 0 ||
603710a519eSWarner Losh 			    resource_int_value(dname, dunit, "target", &val) == 0 ||
604bee0133fSWarner Losh 			    resource_string_value(dname, dunit, "at", &strval) == 0)
6058b8a9b1dSJustin T. Gibbs 				break;
6068b8a9b1dSJustin T. Gibbs 		}
6072398f0cdSPeter Wemm 		if (r != 0)
6088b8a9b1dSJustin T. Gibbs 			break;
6098b8a9b1dSJustin T. Gibbs 	}
6108b8a9b1dSJustin T. Gibbs 	return (newunit);
6118b8a9b1dSJustin T. Gibbs }
6128b8a9b1dSJustin T. Gibbs 
6138b8a9b1dSJustin T. Gibbs static u_int
6148b8a9b1dSJustin T. Gibbs camperiphunit(struct periph_driver *p_drv, path_id_t pathid,
615577f9aa2SWarner Losh     target_id_t target, lun_id_t lun, const char *sn)
6168b8a9b1dSJustin T. Gibbs {
6173846662dSWarner Losh 	bool	wired = false;
6188b8a9b1dSJustin T. Gibbs 	u_int	unit;
619d836c48eSWarner Losh 	int	i, val, dunit;
6202398f0cdSPeter Wemm 	const char *dname, *strval;
6212398f0cdSPeter Wemm 	char	pathbuf[32], *periph_name;
6228b8a9b1dSJustin T. Gibbs 
62375f51904SPeter Wemm 	periph_name = p_drv->driver_name;
62475f51904SPeter Wemm 	snprintf(pathbuf, sizeof(pathbuf), "scbus%d", pathid);
625c1b81613SPeter Wemm 	unit = 0;
6262398f0cdSPeter Wemm 	i = 0;
6272398f0cdSPeter Wemm 	dname = periph_name;
628272e4f53SWarner Losh 
629272e4f53SWarner Losh 	for (wired = false; resource_find_dev(&i, dname, &dunit, NULL, NULL) == 0;
630272e4f53SWarner Losh 	     wired = false) {
63175f51904SPeter Wemm 		if (resource_string_value(dname, dunit, "at", &strval) == 0) {
63275f51904SPeter Wemm 			if (strcmp(strval, pathbuf) != 0)
6338b8a9b1dSJustin T. Gibbs 				continue;
634d836c48eSWarner Losh 			wired = true;
6358b8a9b1dSJustin T. Gibbs 		}
63675f51904SPeter Wemm 		if (resource_int_value(dname, dunit, "target", &val) == 0) {
63775f51904SPeter Wemm 			if (val != target)
6388b8a9b1dSJustin T. Gibbs 				continue;
639d836c48eSWarner Losh 			wired = true;
6408b8a9b1dSJustin T. Gibbs 		}
64175f51904SPeter Wemm 		if (resource_int_value(dname, dunit, "lun", &val) == 0) {
64275f51904SPeter Wemm 			if (val != lun)
6438b8a9b1dSJustin T. Gibbs 				continue;
644d836c48eSWarner Losh 			wired = true;
6458b8a9b1dSJustin T. Gibbs 		}
646577f9aa2SWarner Losh 		if (resource_string_value(dname, dunit, "sn", &strval) == 0) {
647577f9aa2SWarner Losh 			if (sn == NULL || strcmp(strval, sn) != 0)
648577f9aa2SWarner Losh 				continue;
649d836c48eSWarner Losh 			wired = true;
650577f9aa2SWarner Losh 		}
651d836c48eSWarner Losh 		if (wired) {
65275f51904SPeter Wemm 			unit = dunit;
6538b8a9b1dSJustin T. Gibbs 			break;
6548b8a9b1dSJustin T. Gibbs 		}
6558b8a9b1dSJustin T. Gibbs 	}
6568b8a9b1dSJustin T. Gibbs 
6578b8a9b1dSJustin T. Gibbs 	/*
6588b8a9b1dSJustin T. Gibbs 	 * Either start from 0 looking for the next unit or from
65975f51904SPeter Wemm 	 * the unit number given in the resource config.  This way,
6608b8a9b1dSJustin T. Gibbs 	 * if we have wildcard matches, we don't return the same
6618b8a9b1dSJustin T. Gibbs 	 * unit number twice.
6628b8a9b1dSJustin T. Gibbs 	 */
663c1b81613SPeter Wemm 	unit = camperiphnextunit(p_drv, unit, wired, pathid, target, lun);
6648b8a9b1dSJustin T. Gibbs 
6658b8a9b1dSJustin T. Gibbs 	return (unit);
6668b8a9b1dSJustin T. Gibbs }
6678b8a9b1dSJustin T. Gibbs 
6688b8a9b1dSJustin T. Gibbs void
6698b8a9b1dSJustin T. Gibbs cam_periph_invalidate(struct cam_periph *periph)
6708b8a9b1dSJustin T. Gibbs {
6718b8a9b1dSJustin T. Gibbs 
672227d67aaSAlexander Motin 	cam_periph_assert(periph, MA_OWNED);
673ee9c90c7SKenneth D. Merry 	/*
6746fda2c54SWarner Losh 	 * We only tear down the device the first time a peripheral is
67577dc25ccSScott Long 	 * invalidated.
676ee9c90c7SKenneth D. Merry 	 */
677d38c0e53SAlexander Motin 	if ((periph->flags & CAM_PERIPH_INVALID) != 0)
678d38c0e53SAlexander Motin 		return;
679ee9c90c7SKenneth D. Merry 
680d38c0e53SAlexander Motin 	CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph invalidated\n"));
6815d01277fSScott Long 	if ((periph->flags & CAM_PERIPH_ANNOUNCED) && !rebooting) {
6825d01277fSScott Long 		struct sbuf sb;
683da0d7209SScott Long 		char buffer[160];
6845d01277fSScott Long 
685da0d7209SScott Long 		sbuf_new(&sb, buffer, 160, SBUF_FIXEDLEN);
6865d01277fSScott Long 		xpt_denounce_periph_sbuf(periph, &sb);
6875d01277fSScott Long 		sbuf_finish(&sb);
6885d01277fSScott Long 		sbuf_putbuf(&sb);
6895d01277fSScott Long 	}
6908b8a9b1dSJustin T. Gibbs 	periph->flags |= CAM_PERIPH_INVALID;
6918b8a9b1dSJustin T. Gibbs 	periph->flags &= ~CAM_PERIPH_NEW_DEV_FOUND;
692d38c0e53SAlexander Motin 	if (periph->periph_oninval != NULL)
693d38c0e53SAlexander Motin 		periph->periph_oninval(periph);
694d38c0e53SAlexander Motin 	cam_periph_release_locked(periph);
6958b8a9b1dSJustin T. Gibbs }
6968b8a9b1dSJustin T. Gibbs 
6978b8a9b1dSJustin T. Gibbs static void
6988b8a9b1dSJustin T. Gibbs camperiphfree(struct cam_periph *periph)
6998b8a9b1dSJustin T. Gibbs {
7008b8a9b1dSJustin T. Gibbs 	struct periph_driver **p_drv;
70159fe7664SKenneth D. Merry 	struct periph_driver *drv;
7028b8a9b1dSJustin T. Gibbs 
703227d67aaSAlexander Motin 	cam_periph_assert(periph, MA_OWNED);
704227d67aaSAlexander Motin 	KASSERT(periph->periph_allocating == 0, ("%s%d: freed while allocating",
705227d67aaSAlexander Motin 	    periph->periph_name, periph->unit_number));
7060b7c27b9SPeter Wemm 	for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
7078b8a9b1dSJustin T. Gibbs 		if (strcmp((*p_drv)->driver_name, periph->periph_name) == 0)
7088b8a9b1dSJustin T. Gibbs 			break;
7098b8a9b1dSJustin T. Gibbs 	}
710661658a6SScott Long 	if (*p_drv == NULL) {
711661658a6SScott Long 		printf("camperiphfree: attempt to free non-existant periph\n");
712661658a6SScott Long 		return;
713661658a6SScott Long 	}
71459fe7664SKenneth D. Merry 	/*
71559fe7664SKenneth D. Merry 	 * Cache a pointer to the periph_driver structure.  If a
71659fe7664SKenneth D. Merry 	 * periph_driver is added or removed from the array (see
71759fe7664SKenneth D. Merry 	 * periphdriver_register()) while we drop the toplogy lock
71859fe7664SKenneth D. Merry 	 * below, p_drv may change.  This doesn't protect against this
71959fe7664SKenneth D. Merry 	 * particular periph_driver going away.  That will require full
72059fe7664SKenneth D. Merry 	 * reference counting in the periph_driver infrastructure.
72159fe7664SKenneth D. Merry 	 */
72259fe7664SKenneth D. Merry 	drv = *p_drv;
7238b8a9b1dSJustin T. Gibbs 
724ea37f519SKenneth D. Merry 	/*
72533a38f74SKenneth D. Merry 	 * We need to set this flag before dropping the topology lock, to
72633a38f74SKenneth D. Merry 	 * let anyone who is traversing the list that this peripheral is
72733a38f74SKenneth D. Merry 	 * about to be freed, and there will be no more reference count
72833a38f74SKenneth D. Merry 	 * checks.
72933a38f74SKenneth D. Merry 	 */
73033a38f74SKenneth D. Merry 	periph->flags |= CAM_PERIPH_FREE;
73133a38f74SKenneth D. Merry 
73233a38f74SKenneth D. Merry 	/*
733ea37f519SKenneth D. Merry 	 * The peripheral destructor semantics dictate calling with only the
734ea37f519SKenneth D. Merry 	 * SIM mutex held.  Since it might sleep, it should not be called
735ea37f519SKenneth D. Merry 	 * with the topology lock held.
736ea37f519SKenneth D. Merry 	 */
737f3548746SScott Long 	xpt_unlock_buses();
7388b8a9b1dSJustin T. Gibbs 
739ea37f519SKenneth D. Merry 	/*
740ea37f519SKenneth D. Merry 	 * We need to call the peripheral destructor prior to removing the
741ea37f519SKenneth D. Merry 	 * peripheral from the list.  Otherwise, we risk running into a
742ea37f519SKenneth D. Merry 	 * scenario where the peripheral unit number may get reused
743ea37f519SKenneth D. Merry 	 * (because it has been removed from the list), but some resources
744ea37f519SKenneth D. Merry 	 * used by the peripheral are still hanging around.  In particular,
745ea37f519SKenneth D. Merry 	 * the devfs nodes used by some peripherals like the pass(4) driver
746ea37f519SKenneth D. Merry 	 * aren't fully cleaned up until the destructor is run.  If the
747ea37f519SKenneth D. Merry 	 * unit number is reused before the devfs instance is fully gone,
748ea37f519SKenneth D. Merry 	 * devfs will panic.
749ea37f519SKenneth D. Merry 	 */
750f3548746SScott Long 	if (periph->periph_dtor != NULL)
751f3548746SScott Long 		periph->periph_dtor(periph);
752ea37f519SKenneth D. Merry 
753ea37f519SKenneth D. Merry 	/*
75481490edaSWarner Losh 	 * The peripheral list is protected by the topology lock. We have to
75581490edaSWarner Losh 	 * remove the periph from the drv list before we call deferred_ac. The
75681490edaSWarner Losh 	 * AC_FOUND_DEVICE callback won't create a new periph if it's still there.
757ea37f519SKenneth D. Merry 	 */
758ea37f519SKenneth D. Merry 	xpt_lock_buses();
759ea37f519SKenneth D. Merry 
76059fe7664SKenneth D. Merry 	TAILQ_REMOVE(&drv->units, periph, unit_links);
76159fe7664SKenneth D. Merry 	drv->generation++;
762ea37f519SKenneth D. Merry 
763a29779e8SAlexander Motin 	xpt_remove_periph(periph);
764ea37f519SKenneth D. Merry 
765ea37f519SKenneth D. Merry 	xpt_unlock_buses();
766de6a705eSMarius Strobl 	if ((periph->flags & CAM_PERIPH_ANNOUNCED) && !rebooting)
7678d36a71bSAlexander Motin 		xpt_print(periph->path, "Periph destroyed\n");
768de6a705eSMarius Strobl 	else
76922c7d606SAlexander Motin 		CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph destroyed\n"));
7708b8a9b1dSJustin T. Gibbs 
7718b8a9b1dSJustin T. Gibbs 	if (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) {
7728b8a9b1dSJustin T. Gibbs 		union ccb ccb;
7738b8a9b1dSJustin T. Gibbs 		void *arg;
7748b8a9b1dSJustin T. Gibbs 
775076686feSEdward Tomasz Napierala 		memset(&ccb, 0, sizeof(ccb));
7768b8a9b1dSJustin T. Gibbs 		switch (periph->deferred_ac) {
7778b8a9b1dSJustin T. Gibbs 		case AC_FOUND_DEVICE:
7788b8a9b1dSJustin T. Gibbs 			ccb.ccb_h.func_code = XPT_GDEV_TYPE;
779bbfa4aa1SAlexander Motin 			xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
7808b8a9b1dSJustin T. Gibbs 			xpt_action(&ccb);
7818b8a9b1dSJustin T. Gibbs 			arg = &ccb;
7828b8a9b1dSJustin T. Gibbs 			break;
7838b8a9b1dSJustin T. Gibbs 		case AC_PATH_REGISTERED:
784762a7f4fSWarner Losh 			xpt_path_inq(&ccb.cpi, periph->path);
7858b8a9b1dSJustin T. Gibbs 			arg = &ccb;
7868b8a9b1dSJustin T. Gibbs 			break;
7878b8a9b1dSJustin T. Gibbs 		default:
7888b8a9b1dSJustin T. Gibbs 			arg = NULL;
7898b8a9b1dSJustin T. Gibbs 			break;
7908b8a9b1dSJustin T. Gibbs 		}
7918b8a9b1dSJustin T. Gibbs 		periph->deferred_callback(NULL, periph->deferred_ac,
7928b8a9b1dSJustin T. Gibbs 					  periph->path, arg);
7938b8a9b1dSJustin T. Gibbs 	}
7948b8a9b1dSJustin T. Gibbs 	xpt_free_path(periph->path);
795362abc44STai-hwa Liang 	free(periph, M_CAMPERIPH);
796f3548746SScott Long 	xpt_lock_buses();
7978b8a9b1dSJustin T. Gibbs }
7988b8a9b1dSJustin T. Gibbs 
7998b8a9b1dSJustin T. Gibbs /*
8008b8a9b1dSJustin T. Gibbs  * Map user virtual pointers into kernel virtual address space, so we can
80195fbded6SScott Long  * access the memory.  This is now a generic function that centralizes most
80295fbded6SScott Long  * of the sanity checks on the data flags, if any.
803cd853791SKonstantin Belousov  * This also only works for up to maxphys memory.  Since we use
8048b8a9b1dSJustin T. Gibbs  * buffers to map stuff in and out, we're limited to the buffer size.
8058b8a9b1dSJustin T. Gibbs  */
8068b8a9b1dSJustin T. Gibbs int
807de239312SAlexander Motin cam_periph_mapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo,
808de239312SAlexander Motin     u_int maxmap)
8098b8a9b1dSJustin T. Gibbs {
810b059686aSAlexander Motin 	int numbufs, i;
8118b8a9b1dSJustin T. Gibbs 	u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
8128b8a9b1dSJustin T. Gibbs 	u_int32_t lengths[CAM_PERIPH_MAXMAPS];
8138b8a9b1dSJustin T. Gibbs 	u_int32_t dirs[CAM_PERIPH_MAXMAPS];
8148b8a9b1dSJustin T. Gibbs 
815b059686aSAlexander Motin 	bzero(mapinfo, sizeof(*mapinfo));
816de239312SAlexander Motin 	if (maxmap == 0)
817de239312SAlexander Motin 		maxmap = DFLTPHYS;	/* traditional default */
818cd853791SKonstantin Belousov 	else if (maxmap > maxphys)
819cd853791SKonstantin Belousov 		maxmap = maxphys;	/* for safety */
8208b8a9b1dSJustin T. Gibbs 	switch(ccb->ccb_h.func_code) {
8218b8a9b1dSJustin T. Gibbs 	case XPT_DEV_MATCH:
8228b8a9b1dSJustin T. Gibbs 		if (ccb->cdm.match_buf_len == 0) {
8238b8a9b1dSJustin T. Gibbs 			printf("cam_periph_mapmem: invalid match buffer "
8248b8a9b1dSJustin T. Gibbs 			       "length 0\n");
8258b8a9b1dSJustin T. Gibbs 			return(EINVAL);
8268b8a9b1dSJustin T. Gibbs 		}
8278b8a9b1dSJustin T. Gibbs 		if (ccb->cdm.pattern_buf_len > 0) {
8288b8a9b1dSJustin T. Gibbs 			data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
8298b8a9b1dSJustin T. Gibbs 			lengths[0] = ccb->cdm.pattern_buf_len;
8308b8a9b1dSJustin T. Gibbs 			dirs[0] = CAM_DIR_OUT;
8318b8a9b1dSJustin T. Gibbs 			data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
8328b8a9b1dSJustin T. Gibbs 			lengths[1] = ccb->cdm.match_buf_len;
8338b8a9b1dSJustin T. Gibbs 			dirs[1] = CAM_DIR_IN;
8348b8a9b1dSJustin T. Gibbs 			numbufs = 2;
8358b8a9b1dSJustin T. Gibbs 		} else {
8368b8a9b1dSJustin T. Gibbs 			data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
8378b8a9b1dSJustin T. Gibbs 			lengths[0] = ccb->cdm.match_buf_len;
8388b8a9b1dSJustin T. Gibbs 			dirs[0] = CAM_DIR_IN;
8398b8a9b1dSJustin T. Gibbs 			numbufs = 1;
8408b8a9b1dSJustin T. Gibbs 		}
84152c9ce25SScott Long 		/*
84252c9ce25SScott Long 		 * This request will not go to the hardware, no reason
843cd853791SKonstantin Belousov 		 * to be so strict. vmapbuf() is able to map up to maxphys.
84452c9ce25SScott Long 		 */
845cd853791SKonstantin Belousov 		maxmap = maxphys;
8468b8a9b1dSJustin T. Gibbs 		break;
8478b8a9b1dSJustin T. Gibbs 	case XPT_SCSI_IO:
84887cfaf0eSJustin T. Gibbs 	case XPT_CONT_TARGET_IO:
8498b8a9b1dSJustin T. Gibbs 		if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
8508b8a9b1dSJustin T. Gibbs 			return(0);
85195fbded6SScott Long 		if ((ccb->ccb_h.flags & CAM_DATA_MASK) != CAM_DATA_VADDR)
85295fbded6SScott Long 			return (EINVAL);
8538b8a9b1dSJustin T. Gibbs 		data_ptrs[0] = &ccb->csio.data_ptr;
85479d49a06SKenneth D. Merry 		lengths[0] = ccb->csio.dxfer_len;
8558b8a9b1dSJustin T. Gibbs 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
8568b8a9b1dSJustin T. Gibbs 		numbufs = 1;
8578b8a9b1dSJustin T. Gibbs 		break;
85852c9ce25SScott Long 	case XPT_ATA_IO:
85952c9ce25SScott Long 		if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
86052c9ce25SScott Long 			return(0);
86195fbded6SScott Long 		if ((ccb->ccb_h.flags & CAM_DATA_MASK) != CAM_DATA_VADDR)
86295fbded6SScott Long 			return (EINVAL);
86352c9ce25SScott Long 		data_ptrs[0] = &ccb->ataio.data_ptr;
86452c9ce25SScott Long 		lengths[0] = ccb->ataio.dxfer_len;
86552c9ce25SScott Long 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
86652c9ce25SScott Long 		numbufs = 1;
86752c9ce25SScott Long 		break;
868a94a63f0SWarner Losh 	case XPT_MMC_IO:
869a94a63f0SWarner Losh 		if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
870a94a63f0SWarner Losh 			return(0);
871a94a63f0SWarner Losh 		/* Two mappings: one for cmd->data and one for cmd->data->data */
872a94a63f0SWarner Losh 		data_ptrs[0] = (unsigned char **)&ccb->mmcio.cmd.data;
873a94a63f0SWarner Losh 		lengths[0] = sizeof(struct mmc_data *);
874a94a63f0SWarner Losh 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
875a94a63f0SWarner Losh 		data_ptrs[1] = (unsigned char **)&ccb->mmcio.cmd.data->data;
876a94a63f0SWarner Losh 		lengths[1] = ccb->mmcio.cmd.data->len;
877a94a63f0SWarner Losh 		dirs[1] = ccb->ccb_h.flags & CAM_DIR_MASK;
878a94a63f0SWarner Losh 		numbufs = 2;
879a94a63f0SWarner Losh 		break;
88006e79492SKenneth D. Merry 	case XPT_SMP_IO:
88106e79492SKenneth D. Merry 		data_ptrs[0] = &ccb->smpio.smp_request;
88206e79492SKenneth D. Merry 		lengths[0] = ccb->smpio.smp_request_len;
88306e79492SKenneth D. Merry 		dirs[0] = CAM_DIR_OUT;
88406e79492SKenneth D. Merry 		data_ptrs[1] = &ccb->smpio.smp_response;
88506e79492SKenneth D. Merry 		lengths[1] = ccb->smpio.smp_response_len;
88606e79492SKenneth D. Merry 		dirs[1] = CAM_DIR_IN;
88706e79492SKenneth D. Merry 		numbufs = 2;
88806e79492SKenneth D. Merry 		break;
889df424515SWarner Losh 	case XPT_NVME_IO:
890df424515SWarner Losh 	case XPT_NVME_ADMIN:
891df424515SWarner Losh 		if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
892df424515SWarner Losh 			return (0);
893df424515SWarner Losh 		if ((ccb->ccb_h.flags & CAM_DATA_MASK) != CAM_DATA_VADDR)
894df424515SWarner Losh 			return (EINVAL);
895df424515SWarner Losh 		data_ptrs[0] = &ccb->nvmeio.data_ptr;
896df424515SWarner Losh 		lengths[0] = ccb->nvmeio.dxfer_len;
897df424515SWarner Losh 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
898df424515SWarner Losh 		numbufs = 1;
899df424515SWarner Losh 		break;
9003501942bSJustin T. Gibbs 	case XPT_DEV_ADVINFO:
9013501942bSJustin T. Gibbs 		if (ccb->cdai.bufsiz == 0)
9027c103ddeSKenneth D. Merry 			return (0);
9037c103ddeSKenneth D. Merry 
9043501942bSJustin T. Gibbs 		data_ptrs[0] = (uint8_t **)&ccb->cdai.buf;
9053501942bSJustin T. Gibbs 		lengths[0] = ccb->cdai.bufsiz;
90606e79492SKenneth D. Merry 		dirs[0] = CAM_DIR_IN;
90706e79492SKenneth D. Merry 		numbufs = 1;
9087c103ddeSKenneth D. Merry 
9097c103ddeSKenneth D. Merry 		/*
9107c103ddeSKenneth D. Merry 		 * This request will not go to the hardware, no reason
911cd853791SKonstantin Belousov 		 * to be so strict. vmapbuf() is able to map up to maxphys.
9127c103ddeSKenneth D. Merry 		 */
913cd853791SKonstantin Belousov 		maxmap = maxphys;
91406e79492SKenneth D. Merry 		break;
9158b8a9b1dSJustin T. Gibbs 	default:
9168b8a9b1dSJustin T. Gibbs 		return(EINVAL);
9178b8a9b1dSJustin T. Gibbs 		break; /* NOTREACHED */
9188b8a9b1dSJustin T. Gibbs 	}
9198b8a9b1dSJustin T. Gibbs 
9208b8a9b1dSJustin T. Gibbs 	/*
92179d49a06SKenneth D. Merry 	 * Check the transfer length and permissions first, so we don't
92279d49a06SKenneth D. Merry 	 * have to unmap any previously mapped buffers.
9238b8a9b1dSJustin T. Gibbs 	 */
9248b8a9b1dSJustin T. Gibbs 	for (i = 0; i < numbufs; i++) {
925c389a786SAlexander Motin 		if (lengths[i] > maxmap) {
926c389a786SAlexander Motin 			printf("cam_periph_mapmem: attempt to map %lu bytes, "
927c389a786SAlexander Motin 			       "which is greater than %lu\n",
928c389a786SAlexander Motin 			       (long)(lengths[i]), (u_long)maxmap);
929c389a786SAlexander Motin 			return (E2BIG);
930c389a786SAlexander Motin 		}
93179d49a06SKenneth D. Merry 	}
93279d49a06SKenneth D. Merry 
93379d49a06SKenneth D. Merry 	/*
934cef367e6SEitan Adler 	 * This keeps the kernel stack of current thread from getting
93595fbded6SScott Long 	 * swapped.  In low-memory situations where the kernel stack might
93695fbded6SScott Long 	 * otherwise get swapped out, this holds it and allows the thread
93795fbded6SScott Long 	 * to make progress and release the kernel mapped pages sooner.
93895fbded6SScott Long 	 *
93979d49a06SKenneth D. Merry 	 * XXX KDM should I use P_NOSWAP instead?
94079d49a06SKenneth D. Merry 	 */
9410cbbb7bfSPeter Wemm 	PHOLD(curproc);
94279d49a06SKenneth D. Merry 
94379d49a06SKenneth D. Merry 	for (i = 0; i < numbufs; i++) {
944b059686aSAlexander Motin 		/* Save the user's data address. */
945b059686aSAlexander Motin 		mapinfo->orig[i] = *data_ptrs[i];
946b059686aSAlexander Motin 
947b059686aSAlexander Motin 		/*
948b059686aSAlexander Motin 		 * For small buffers use malloc+copyin/copyout instead of
949b059686aSAlexander Motin 		 * mapping to KVA to avoid expensive TLB shootdowns.  For
950b059686aSAlexander Motin 		 * small allocations malloc is backed by UMA, and so much
951b059686aSAlexander Motin 		 * cheaper on SMP systems.
952b059686aSAlexander Motin 		 */
9539093e27cSAlexander Motin 		if (lengths[i] <= periph_mapmem_thresh &&
954b059686aSAlexander Motin 		    ccb->ccb_h.func_code != XPT_MMC_IO) {
955b059686aSAlexander Motin 			*data_ptrs[i] = malloc(lengths[i], M_CAMPERIPH,
956b059686aSAlexander Motin 			    M_WAITOK);
957b059686aSAlexander Motin 			if (dirs[i] != CAM_DIR_IN) {
958b059686aSAlexander Motin 				if (copyin(mapinfo->orig[i], *data_ptrs[i],
959b059686aSAlexander Motin 				    lengths[i]) != 0) {
960b059686aSAlexander Motin 					free(*data_ptrs[i], M_CAMPERIPH);
961b059686aSAlexander Motin 					*data_ptrs[i] = mapinfo->orig[i];
962b059686aSAlexander Motin 					goto fail;
963b059686aSAlexander Motin 				}
964b059686aSAlexander Motin 			} else
965b059686aSAlexander Motin 				bzero(*data_ptrs[i], lengths[i]);
966b059686aSAlexander Motin 			continue;
967b059686aSAlexander Motin 		}
968b059686aSAlexander Motin 
9698b8a9b1dSJustin T. Gibbs 		/*
9708b8a9b1dSJustin T. Gibbs 		 * Get the buffer.
9718b8a9b1dSJustin T. Gibbs 		 */
972756a5412SGleb Smirnoff 		mapinfo->bp[i] = uma_zalloc(pbuf_zone, M_WAITOK);
9738b8a9b1dSJustin T. Gibbs 
97421144e3bSPoul-Henning Kamp 		/* set the direction */
975b059686aSAlexander Motin 		mapinfo->bp[i]->b_iocmd = (dirs[i] == CAM_DIR_OUT) ?
976b059686aSAlexander Motin 		    BIO_WRITE : BIO_READ;
9778b8a9b1dSJustin T. Gibbs 
978450a2e2aSWarner Losh 		/* Map the buffer into kernel memory. */
97944ca4575SBrooks Davis 		if (vmapbuf(mapinfo->bp[i], *data_ptrs[i], lengths[i], 1) < 0) {
980756a5412SGleb Smirnoff 			uma_zfree(pbuf_zone, mapinfo->bp[i]);
981b059686aSAlexander Motin 			goto fail;
9822d5c7e45SMatthew Dillon 		}
9838b8a9b1dSJustin T. Gibbs 
9848b8a9b1dSJustin T. Gibbs 		/* set our pointer to the new mapped area */
9858b8a9b1dSJustin T. Gibbs 		*data_ptrs[i] = mapinfo->bp[i]->b_data;
9868b8a9b1dSJustin T. Gibbs 	}
9878b8a9b1dSJustin T. Gibbs 
988a62525f3SMatt Jacob 	/*
989a62525f3SMatt Jacob 	 * Now that we've gotten this far, change ownership to the kernel
990a62525f3SMatt Jacob 	 * of the buffers so that we don't run afoul of returning to user
991a62525f3SMatt Jacob 	 * space with locks (on the buffer) held.
992a62525f3SMatt Jacob 	 */
993a62525f3SMatt Jacob 	for (i = 0; i < numbufs; i++) {
994b059686aSAlexander Motin 		if (mapinfo->bp[i])
995a62525f3SMatt Jacob 			BUF_KERNPROC(mapinfo->bp[i]);
996a62525f3SMatt Jacob 	}
997a62525f3SMatt Jacob 
998b059686aSAlexander Motin 	mapinfo->num_bufs_used = numbufs;
9998b8a9b1dSJustin T. Gibbs 	return(0);
1000b059686aSAlexander Motin 
1001b059686aSAlexander Motin fail:
1002b059686aSAlexander Motin 	for (i--; i >= 0; i--) {
1003b059686aSAlexander Motin 		if (mapinfo->bp[i]) {
1004b059686aSAlexander Motin 			vunmapbuf(mapinfo->bp[i]);
1005b059686aSAlexander Motin 			uma_zfree(pbuf_zone, mapinfo->bp[i]);
1006b059686aSAlexander Motin 		} else
1007b059686aSAlexander Motin 			free(*data_ptrs[i], M_CAMPERIPH);
1008b059686aSAlexander Motin 		*data_ptrs[i] = mapinfo->orig[i];
1009b059686aSAlexander Motin 	}
1010b059686aSAlexander Motin 	PRELE(curproc);
1011b059686aSAlexander Motin 	return(EACCES);
10128b8a9b1dSJustin T. Gibbs }
10138b8a9b1dSJustin T. Gibbs 
10148b8a9b1dSJustin T. Gibbs /*
10158b8a9b1dSJustin T. Gibbs  * Unmap memory segments mapped into kernel virtual address space by
10168b8a9b1dSJustin T. Gibbs  * cam_periph_mapmem().
10178b8a9b1dSJustin T. Gibbs  */
10188b8a9b1dSJustin T. Gibbs void
10198b8a9b1dSJustin T. Gibbs cam_periph_unmapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo)
10208b8a9b1dSJustin T. Gibbs {
10218b8a9b1dSJustin T. Gibbs 	int numbufs, i;
10228b8a9b1dSJustin T. Gibbs 	u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
1023b059686aSAlexander Motin 	u_int32_t lengths[CAM_PERIPH_MAXMAPS];
1024b059686aSAlexander Motin 	u_int32_t dirs[CAM_PERIPH_MAXMAPS];
10258b8a9b1dSJustin T. Gibbs 
10268b8a9b1dSJustin T. Gibbs 	if (mapinfo->num_bufs_used <= 0) {
102795fbded6SScott Long 		/* nothing to free and the process wasn't held. */
10288b8a9b1dSJustin T. Gibbs 		return;
10298b8a9b1dSJustin T. Gibbs 	}
10308b8a9b1dSJustin T. Gibbs 
10318b8a9b1dSJustin T. Gibbs 	switch (ccb->ccb_h.func_code) {
10328b8a9b1dSJustin T. Gibbs 	case XPT_DEV_MATCH:
1033b059686aSAlexander Motin 		if (ccb->cdm.pattern_buf_len > 0) {
10348b8a9b1dSJustin T. Gibbs 			data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
1035b059686aSAlexander Motin 			lengths[0] = ccb->cdm.pattern_buf_len;
1036b059686aSAlexander Motin 			dirs[0] = CAM_DIR_OUT;
10378b8a9b1dSJustin T. Gibbs 			data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
1038b059686aSAlexander Motin 			lengths[1] = ccb->cdm.match_buf_len;
1039b059686aSAlexander Motin 			dirs[1] = CAM_DIR_IN;
1040b059686aSAlexander Motin 			numbufs = 2;
1041b059686aSAlexander Motin 		} else {
1042b059686aSAlexander Motin 			data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
1043b059686aSAlexander Motin 			lengths[0] = ccb->cdm.match_buf_len;
1044b059686aSAlexander Motin 			dirs[0] = CAM_DIR_IN;
1045b059686aSAlexander Motin 			numbufs = 1;
10468b8a9b1dSJustin T. Gibbs 		}
10478b8a9b1dSJustin T. Gibbs 		break;
10488b8a9b1dSJustin T. Gibbs 	case XPT_SCSI_IO:
10499911ecf9SJustin T. Gibbs 	case XPT_CONT_TARGET_IO:
10508b8a9b1dSJustin T. Gibbs 		data_ptrs[0] = &ccb->csio.data_ptr;
1051b059686aSAlexander Motin 		lengths[0] = ccb->csio.dxfer_len;
1052b059686aSAlexander Motin 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1053b059686aSAlexander Motin 		numbufs = 1;
10548b8a9b1dSJustin T. Gibbs 		break;
105552c9ce25SScott Long 	case XPT_ATA_IO:
105652c9ce25SScott Long 		data_ptrs[0] = &ccb->ataio.data_ptr;
1057b059686aSAlexander Motin 		lengths[0] = ccb->ataio.dxfer_len;
1058b059686aSAlexander Motin 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1059b059686aSAlexander Motin 		numbufs = 1;
1060b059686aSAlexander Motin 		break;
1061b059686aSAlexander Motin 	case XPT_MMC_IO:
1062b059686aSAlexander Motin 		data_ptrs[0] = (u_int8_t **)&ccb->mmcio.cmd.data;
1063b059686aSAlexander Motin 		lengths[0] = sizeof(struct mmc_data *);
1064b059686aSAlexander Motin 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1065b059686aSAlexander Motin 		data_ptrs[1] = (u_int8_t **)&ccb->mmcio.cmd.data->data;
1066b059686aSAlexander Motin 		lengths[1] = ccb->mmcio.cmd.data->len;
1067b059686aSAlexander Motin 		dirs[1] = ccb->ccb_h.flags & CAM_DIR_MASK;
1068b059686aSAlexander Motin 		numbufs = 2;
106952c9ce25SScott Long 		break;
107006e79492SKenneth D. Merry 	case XPT_SMP_IO:
107106e79492SKenneth D. Merry 		data_ptrs[0] = &ccb->smpio.smp_request;
1072b059686aSAlexander Motin 		lengths[0] = ccb->smpio.smp_request_len;
1073b059686aSAlexander Motin 		dirs[0] = CAM_DIR_OUT;
107406e79492SKenneth D. Merry 		data_ptrs[1] = &ccb->smpio.smp_response;
1075b059686aSAlexander Motin 		lengths[1] = ccb->smpio.smp_response_len;
1076b059686aSAlexander Motin 		dirs[1] = CAM_DIR_IN;
1077b059686aSAlexander Motin 		numbufs = 2;
107806e79492SKenneth D. Merry 		break;
1079df424515SWarner Losh 	case XPT_NVME_IO:
1080df424515SWarner Losh 	case XPT_NVME_ADMIN:
1081df424515SWarner Losh 		data_ptrs[0] = &ccb->nvmeio.data_ptr;
1082b059686aSAlexander Motin 		lengths[0] = ccb->nvmeio.dxfer_len;
1083b059686aSAlexander Motin 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1084b059686aSAlexander Motin 		numbufs = 1;
1085b059686aSAlexander Motin 		break;
1086b059686aSAlexander Motin 	case XPT_DEV_ADVINFO:
1087b059686aSAlexander Motin 		data_ptrs[0] = (uint8_t **)&ccb->cdai.buf;
1088b059686aSAlexander Motin 		lengths[0] = ccb->cdai.bufsiz;
1089b059686aSAlexander Motin 		dirs[0] = CAM_DIR_IN;
1090b059686aSAlexander Motin 		numbufs = 1;
1091df424515SWarner Losh 		break;
10928b8a9b1dSJustin T. Gibbs 	default:
10938b8a9b1dSJustin T. Gibbs 		/* allow ourselves to be swapped once again */
10940cbbb7bfSPeter Wemm 		PRELE(curproc);
10958b8a9b1dSJustin T. Gibbs 		return;
10968b8a9b1dSJustin T. Gibbs 		break; /* NOTREACHED */
10978b8a9b1dSJustin T. Gibbs 	}
10988b8a9b1dSJustin T. Gibbs 
10998b8a9b1dSJustin T. Gibbs 	for (i = 0; i < numbufs; i++) {
1100b059686aSAlexander Motin 		if (mapinfo->bp[i]) {
11018b8a9b1dSJustin T. Gibbs 			/* unmap the buffer */
11028b8a9b1dSJustin T. Gibbs 			vunmapbuf(mapinfo->bp[i]);
11038b8a9b1dSJustin T. Gibbs 
11048b8a9b1dSJustin T. Gibbs 			/* release the buffer */
1105756a5412SGleb Smirnoff 			uma_zfree(pbuf_zone, mapinfo->bp[i]);
1106b059686aSAlexander Motin 		} else {
1107b059686aSAlexander Motin 			if (dirs[i] != CAM_DIR_OUT) {
1108b059686aSAlexander Motin 				copyout(*data_ptrs[i], mapinfo->orig[i],
1109b059686aSAlexander Motin 				    lengths[i]);
1110b059686aSAlexander Motin 			}
1111b059686aSAlexander Motin 			free(*data_ptrs[i], M_CAMPERIPH);
1112b059686aSAlexander Motin 		}
1113b059686aSAlexander Motin 
1114b059686aSAlexander Motin 		/* Set the user's pointer back to the original value */
1115b059686aSAlexander Motin 		*data_ptrs[i] = mapinfo->orig[i];
11168b8a9b1dSJustin T. Gibbs 	}
11178b8a9b1dSJustin T. Gibbs 
11188b8a9b1dSJustin T. Gibbs 	/* allow ourselves to be swapped once again */
11190cbbb7bfSPeter Wemm 	PRELE(curproc);
11208b8a9b1dSJustin T. Gibbs }
11218b8a9b1dSJustin T. Gibbs 
11228b8a9b1dSJustin T. Gibbs int
1123571e8e20SScott Long cam_periph_ioctl(struct cam_periph *periph, u_long cmd, caddr_t addr,
11248b8a9b1dSJustin T. Gibbs 		 int (*error_routine)(union ccb *ccb,
11258b8a9b1dSJustin T. Gibbs 				      cam_flags camflags,
11268b8a9b1dSJustin T. Gibbs 				      u_int32_t sense_flags))
11278b8a9b1dSJustin T. Gibbs {
11288b8a9b1dSJustin T. Gibbs 	union ccb 	     *ccb;
11298b8a9b1dSJustin T. Gibbs 	int 		     error;
11308b8a9b1dSJustin T. Gibbs 	int		     found;
11318b8a9b1dSJustin T. Gibbs 
11328b8a9b1dSJustin T. Gibbs 	error = found = 0;
11338b8a9b1dSJustin T. Gibbs 
11348b8a9b1dSJustin T. Gibbs 	switch(cmd){
11358b8a9b1dSJustin T. Gibbs 	case CAMGETPASSTHRU:
1136bbfa4aa1SAlexander Motin 		ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
11378b8a9b1dSJustin T. Gibbs 		xpt_setup_ccb(&ccb->ccb_h,
11388b8a9b1dSJustin T. Gibbs 			      ccb->ccb_h.path,
1139bbfa4aa1SAlexander Motin 			      CAM_PRIORITY_NORMAL);
11408b8a9b1dSJustin T. Gibbs 		ccb->ccb_h.func_code = XPT_GDEVLIST;
11418b8a9b1dSJustin T. Gibbs 
11428b8a9b1dSJustin T. Gibbs 		/*
11438b8a9b1dSJustin T. Gibbs 		 * Basically, the point of this is that we go through
11448b8a9b1dSJustin T. Gibbs 		 * getting the list of devices, until we find a passthrough
11458b8a9b1dSJustin T. Gibbs 		 * device.  In the current version of the CAM code, the
11468b8a9b1dSJustin T. Gibbs 		 * only way to determine what type of device we're dealing
11478b8a9b1dSJustin T. Gibbs 		 * with is by its name.
11488b8a9b1dSJustin T. Gibbs 		 */
11498b8a9b1dSJustin T. Gibbs 		while (found == 0) {
11508b8a9b1dSJustin T. Gibbs 			ccb->cgdl.index = 0;
11518b8a9b1dSJustin T. Gibbs 			ccb->cgdl.status = CAM_GDEVLIST_MORE_DEVS;
11528b8a9b1dSJustin T. Gibbs 			while (ccb->cgdl.status == CAM_GDEVLIST_MORE_DEVS) {
11538b8a9b1dSJustin T. Gibbs 				/* we want the next device in the list */
11548b8a9b1dSJustin T. Gibbs 				xpt_action(ccb);
11558b8a9b1dSJustin T. Gibbs 				if (strncmp(ccb->cgdl.periph_name,
11568b8a9b1dSJustin T. Gibbs 				    "pass", 4) == 0){
11578b8a9b1dSJustin T. Gibbs 					found = 1;
11588b8a9b1dSJustin T. Gibbs 					break;
11598b8a9b1dSJustin T. Gibbs 				}
11608b8a9b1dSJustin T. Gibbs 			}
11618b8a9b1dSJustin T. Gibbs 			if ((ccb->cgdl.status == CAM_GDEVLIST_LAST_DEVICE) &&
11628b8a9b1dSJustin T. Gibbs 			    (found == 0)) {
11638b8a9b1dSJustin T. Gibbs 				ccb->cgdl.periph_name[0] = '\0';
11648b8a9b1dSJustin T. Gibbs 				ccb->cgdl.unit_number = 0;
11658b8a9b1dSJustin T. Gibbs 				break;
11668b8a9b1dSJustin T. Gibbs 			}
11678b8a9b1dSJustin T. Gibbs 		}
11688b8a9b1dSJustin T. Gibbs 
11698b8a9b1dSJustin T. Gibbs 		/* copy the result back out */
11708b8a9b1dSJustin T. Gibbs 		bcopy(ccb, addr, sizeof(union ccb));
11718b8a9b1dSJustin T. Gibbs 
11728b8a9b1dSJustin T. Gibbs 		/* and release the ccb */
11738b8a9b1dSJustin T. Gibbs 		xpt_release_ccb(ccb);
11748b8a9b1dSJustin T. Gibbs 
11758b8a9b1dSJustin T. Gibbs 		break;
11768b8a9b1dSJustin T. Gibbs 	default:
11778b8a9b1dSJustin T. Gibbs 		error = ENOTTY;
11788b8a9b1dSJustin T. Gibbs 		break;
11798b8a9b1dSJustin T. Gibbs 	}
11808b8a9b1dSJustin T. Gibbs 	return(error);
11818b8a9b1dSJustin T. Gibbs }
11828b8a9b1dSJustin T. Gibbs 
1183227d67aaSAlexander Motin static void
1184991b5d26SMark Johnston cam_periph_done_panic(struct cam_periph *periph, union ccb *done_ccb)
1185991b5d26SMark Johnston {
1186991b5d26SMark Johnston 
1187991b5d26SMark Johnston 	panic("%s: already done with ccb %p", __func__, done_ccb);
1188991b5d26SMark Johnston }
1189991b5d26SMark Johnston 
1190991b5d26SMark Johnston static void
1191227d67aaSAlexander Motin cam_periph_done(struct cam_periph *periph, union ccb *done_ccb)
1192227d67aaSAlexander Motin {
1193227d67aaSAlexander Motin 
1194227d67aaSAlexander Motin 	/* Caller will release the CCB */
1195991b5d26SMark Johnston 	xpt_path_assert(done_ccb->ccb_h.path, MA_OWNED);
1196991b5d26SMark Johnston 	done_ccb->ccb_h.cbfcnp = cam_periph_done_panic;
1197227d67aaSAlexander Motin 	wakeup(&done_ccb->ccb_h.cbfcnp);
1198227d67aaSAlexander Motin }
1199227d67aaSAlexander Motin 
1200991b5d26SMark Johnston static void
1201991b5d26SMark Johnston cam_periph_ccbwait(union ccb *ccb)
1202991b5d26SMark Johnston {
1203991b5d26SMark Johnston 
1204991b5d26SMark Johnston 	if ((ccb->ccb_h.func_code & XPT_FC_QUEUED) != 0) {
1205991b5d26SMark Johnston 		while (ccb->ccb_h.cbfcnp != cam_periph_done_panic)
1206991b5d26SMark Johnston 			xpt_path_sleep(ccb->ccb_h.path, &ccb->ccb_h.cbfcnp,
1207991b5d26SMark Johnston 			    PRIBIO, "cbwait", 0);
1208991b5d26SMark Johnston 	}
1209991b5d26SMark Johnston 	KASSERT(ccb->ccb_h.pinfo.index == CAM_UNQUEUED_INDEX &&
1210991b5d26SMark Johnston 	    (ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_INPROG,
1211991b5d26SMark Johnston 	    ("%s: proceeding with incomplete ccb: ccb=%p, func_code=%#x, "
1212991b5d26SMark Johnston 	     "status=%#x, index=%d", __func__, ccb, ccb->ccb_h.func_code,
1213991b5d26SMark Johnston 	     ccb->ccb_h.status, ccb->ccb_h.pinfo.index));
1214991b5d26SMark Johnston }
1215991b5d26SMark Johnston 
121676314772SScott Long /*
121776314772SScott Long  * Dispatch a CCB and wait for it to complete.  If the CCB has set a
121876314772SScott Long  * callback function (ccb->ccb_h.cbfcnp), it will be overwritten and lost.
121976314772SScott Long  */
12208b8a9b1dSJustin T. Gibbs int
12218b8a9b1dSJustin T. Gibbs cam_periph_runccb(union ccb *ccb,
12228b8a9b1dSJustin T. Gibbs 		  int (*error_routine)(union ccb *ccb,
12238b8a9b1dSJustin T. Gibbs 				       cam_flags camflags,
12248b8a9b1dSJustin T. Gibbs 				       u_int32_t sense_flags),
12258b8a9b1dSJustin T. Gibbs 		  cam_flags camflags, u_int32_t sense_flags,
12268b8a9b1dSJustin T. Gibbs 		  struct devstat *ds)
12278b8a9b1dSJustin T. Gibbs {
1228fd8be18fSKenneth D. Merry 	struct bintime *starttime;
1229fd8be18fSKenneth D. Merry 	struct bintime ltime;
12308b8a9b1dSJustin T. Gibbs 	int error;
12315cf3cd10SWarner Losh 	bool must_poll;
1232f93a843cSWarner Losh 	uint32_t timeout = 1;
12338b8a9b1dSJustin T. Gibbs 
1234fd8be18fSKenneth D. Merry 	starttime = NULL;
1235227d67aaSAlexander Motin 	xpt_path_assert(ccb->ccb_h.path, MA_OWNED);
1236991b5d26SMark Johnston 	KASSERT((ccb->ccb_h.flags & CAM_UNLOCKED) == 0,
1237991b5d26SMark Johnston 	    ("%s: ccb=%p, func_code=%#x, flags=%#x", __func__, ccb,
1238991b5d26SMark Johnston 	     ccb->ccb_h.func_code, ccb->ccb_h.flags));
12398b8a9b1dSJustin T. Gibbs 
12408b8a9b1dSJustin T. Gibbs 	/*
12418b8a9b1dSJustin T. Gibbs 	 * If the user has supplied a stats structure, and if we understand
12428b8a9b1dSJustin T. Gibbs 	 * this particular type of ccb, record the transaction start.
12438b8a9b1dSJustin T. Gibbs 	 */
1244d2f3208dSWarner Losh 	if (ds != NULL &&
1245d2f3208dSWarner Losh 	    (ccb->ccb_h.func_code == XPT_SCSI_IO ||
1246d2f3208dSWarner Losh 	    ccb->ccb_h.func_code == XPT_ATA_IO ||
1247d2f3208dSWarner Losh 	    ccb->ccb_h.func_code == XPT_NVME_IO)) {
1248fd8be18fSKenneth D. Merry 		starttime = &ltime;
1249fd8be18fSKenneth D. Merry 		binuptime(starttime);
1250fd8be18fSKenneth D. Merry 		devstat_start_transaction(ds, starttime);
1251fd8be18fSKenneth D. Merry 	}
12528b8a9b1dSJustin T. Gibbs 
12535cf3cd10SWarner Losh 	/*
12545cf3cd10SWarner Losh 	 * We must poll the I/O while we're dumping. The scheduler is normally
12555cf3cd10SWarner Losh 	 * stopped for dumping, except when we call doadump from ddb. While the
12565cf3cd10SWarner Losh 	 * scheduler is running in this case, we still need to poll the I/O to
12575cf3cd10SWarner Losh 	 * avoid sleeping waiting for the ccb to complete.
125804e814aeSScott Long 	 *
1259045f8bc8SWarner Losh 	 * A panic triggered dump stops the scheduler, any callback from the
1260045f8bc8SWarner Losh 	 * shutdown_post_sync event will run with the scheduler stopped, but
1261045f8bc8SWarner Losh 	 * before we're officially dumping. To avoid hanging in adashutdown
1262045f8bc8SWarner Losh 	 * initiated commands (or other similar situations), we have to test for
1263045f8bc8SWarner Losh 	 * either SCHEDULER_STOPPED() here as well.
1264045f8bc8SWarner Losh 	 *
1265045f8bc8SWarner Losh 	 * To avoid locking problems, dumping/polling callers must call
126604e814aeSScott Long 	 * without a periph lock held.
12675cf3cd10SWarner Losh 	 */
1268045f8bc8SWarner Losh 	must_poll = dumping || SCHEDULER_STOPPED();
1269227d67aaSAlexander Motin 	ccb->ccb_h.cbfcnp = cam_periph_done;
12708b8a9b1dSJustin T. Gibbs 
1271f93a843cSWarner Losh 	/*
1272f93a843cSWarner Losh 	 * If we're polling, then we need to ensure that we have ample resources
127376314772SScott Long 	 * in the periph.  cam_periph_error can reschedule the ccb by calling
127476314772SScott Long 	 * xpt_action and returning ERESTART, so we have to effect the polling
127576314772SScott Long 	 * in the do loop below.
1276f93a843cSWarner Losh 	 */
12775cf3cd10SWarner Losh 	if (must_poll) {
1278447b3557SJohn Baldwin 		if (cam_sim_pollable(ccb->ccb_h.path->bus->sim))
1279f93a843cSWarner Losh 			timeout = xpt_poll_setup(ccb);
1280447b3557SJohn Baldwin 		else
1281447b3557SJohn Baldwin 			timeout = 0;
1282f93a843cSWarner Losh 	}
1283f93a843cSWarner Losh 
1284f93a843cSWarner Losh 	if (timeout == 0) {
1285f93a843cSWarner Losh 		ccb->ccb_h.status = CAM_RESRC_UNAVAIL;
1286f93a843cSWarner Losh 		error = EBUSY;
1287f93a843cSWarner Losh 	} else {
1288f93a843cSWarner Losh 		xpt_action(ccb);
12898b8a9b1dSJustin T. Gibbs 		do {
12905cf3cd10SWarner Losh 			if (must_poll) {
1291f93a843cSWarner Losh 				xpt_pollwait(ccb, timeout);
1292f93a843cSWarner Losh 				timeout = ccb->ccb_h.timeout * 10;
12935cf3cd10SWarner Losh 			} else {
12945cf3cd10SWarner Losh 				cam_periph_ccbwait(ccb);
1295f93a843cSWarner Losh 			}
12968b8a9b1dSJustin T. Gibbs 			if ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP)
12978b8a9b1dSJustin T. Gibbs 				error = 0;
1298991b5d26SMark Johnston 			else if (error_routine != NULL) {
1299991b5d26SMark Johnston 				ccb->ccb_h.cbfcnp = cam_periph_done;
13008b8a9b1dSJustin T. Gibbs 				error = (*error_routine)(ccb, camflags, sense_flags);
1301991b5d26SMark Johnston 			} else
13028b8a9b1dSJustin T. Gibbs 				error = 0;
13038b8a9b1dSJustin T. Gibbs 		} while (error == ERESTART);
1304f93a843cSWarner Losh 	}
1305f93a843cSWarner Losh 
130683c5d981SAlexander Motin 	if ((ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
13078b8a9b1dSJustin T. Gibbs 		cam_release_devq(ccb->ccb_h.path,
13088b8a9b1dSJustin T. Gibbs 				 /* relsim_flags */0,
13098b8a9b1dSJustin T. Gibbs 				 /* openings */0,
13108b8a9b1dSJustin T. Gibbs 				 /* timeout */0,
13118b8a9b1dSJustin T. Gibbs 				 /* getcount_only */ FALSE);
131283c5d981SAlexander Motin 		ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
131383c5d981SAlexander Motin 	}
13148b8a9b1dSJustin T. Gibbs 
1315379ad358SAlexander Motin 	if (ds != NULL) {
1316d2f3208dSWarner Losh 		uint32_t bytes;
1317d2f3208dSWarner Losh 		devstat_tag_type tag;
1318d2f3208dSWarner Losh 		bool valid = true;
1319d2f3208dSWarner Losh 
1320379ad358SAlexander Motin 		if (ccb->ccb_h.func_code == XPT_SCSI_IO) {
1321d2f3208dSWarner Losh 			bytes = ccb->csio.dxfer_len - ccb->csio.resid;
1322d2f3208dSWarner Losh 			tag = (devstat_tag_type)(ccb->csio.tag_action & 0x3);
1323379ad358SAlexander Motin 		} else if (ccb->ccb_h.func_code == XPT_ATA_IO) {
1324d2f3208dSWarner Losh 			bytes = ccb->ataio.dxfer_len - ccb->ataio.resid;
1325d2f3208dSWarner Losh 			tag = (devstat_tag_type)0;
1326d2f3208dSWarner Losh 		} else if (ccb->ccb_h.func_code == XPT_NVME_IO) {
1327d2f3208dSWarner Losh 			bytes = ccb->nvmeio.dxfer_len; /* NB: resid no possible */
1328d2f3208dSWarner Losh 			tag = (devstat_tag_type)0;
1329d2f3208dSWarner Losh 		} else {
1330d2f3208dSWarner Losh 			valid = false;
1331379ad358SAlexander Motin 		}
1332d2f3208dSWarner Losh 		if (valid)
1333d2f3208dSWarner Losh 			devstat_end_transaction(ds, bytes, tag,
1334d2f3208dSWarner Losh 			    ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE) ?
1335d2f3208dSWarner Losh 			    DEVSTAT_NO_DATA : (ccb->ccb_h.flags & CAM_DIR_OUT) ?
1336d2f3208dSWarner Losh 			    DEVSTAT_WRITE : DEVSTAT_READ, NULL, starttime);
1337379ad358SAlexander Motin 	}
13388b8a9b1dSJustin T. Gibbs 
13398b8a9b1dSJustin T. Gibbs 	return(error);
13408b8a9b1dSJustin T. Gibbs }
13418b8a9b1dSJustin T. Gibbs 
134287cfaf0eSJustin T. Gibbs void
134387cfaf0eSJustin T. Gibbs cam_freeze_devq(struct cam_path *path)
134487cfaf0eSJustin T. Gibbs {
1345cccf4220SAlexander Motin 	struct ccb_hdr ccb_h;
134687cfaf0eSJustin T. Gibbs 
13470d4f3c31SAlexander Motin 	CAM_DEBUG(path, CAM_DEBUG_TRACE, ("cam_freeze_devq\n"));
1348076686feSEdward Tomasz Napierala 	memset(&ccb_h, 0, sizeof(ccb_h));
1349cccf4220SAlexander Motin 	xpt_setup_ccb(&ccb_h, path, /*priority*/1);
1350cccf4220SAlexander Motin 	ccb_h.func_code = XPT_NOOP;
1351cccf4220SAlexander Motin 	ccb_h.flags = CAM_DEV_QFREEZE;
1352cccf4220SAlexander Motin 	xpt_action((union ccb *)&ccb_h);
135387cfaf0eSJustin T. Gibbs }
135487cfaf0eSJustin T. Gibbs 
13558b8a9b1dSJustin T. Gibbs u_int32_t
13568b8a9b1dSJustin T. Gibbs cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
135783c5d981SAlexander Motin 		 u_int32_t openings, u_int32_t arg,
13588b8a9b1dSJustin T. Gibbs 		 int getcount_only)
13598b8a9b1dSJustin T. Gibbs {
13608b8a9b1dSJustin T. Gibbs 	struct ccb_relsim crs;
13618b8a9b1dSJustin T. Gibbs 
13620d4f3c31SAlexander Motin 	CAM_DEBUG(path, CAM_DEBUG_TRACE, ("cam_release_devq(%u, %u, %u, %d)\n",
13630d4f3c31SAlexander Motin 	    relsim_flags, openings, arg, getcount_only));
1364076686feSEdward Tomasz Napierala 	memset(&crs, 0, sizeof(crs));
1365bbfa4aa1SAlexander Motin 	xpt_setup_ccb(&crs.ccb_h, path, CAM_PRIORITY_NORMAL);
13668b8a9b1dSJustin T. Gibbs 	crs.ccb_h.func_code = XPT_REL_SIMQ;
13678b8a9b1dSJustin T. Gibbs 	crs.ccb_h.flags = getcount_only ? CAM_DEV_QFREEZE : 0;
13688b8a9b1dSJustin T. Gibbs 	crs.release_flags = relsim_flags;
13698b8a9b1dSJustin T. Gibbs 	crs.openings = openings;
137083c5d981SAlexander Motin 	crs.release_timeout = arg;
13718b8a9b1dSJustin T. Gibbs 	xpt_action((union ccb *)&crs);
13728b8a9b1dSJustin T. Gibbs 	return (crs.qfrozen_cnt);
13738b8a9b1dSJustin T. Gibbs }
13748b8a9b1dSJustin T. Gibbs 
13758b8a9b1dSJustin T. Gibbs #define saved_ccb_ptr ppriv_ptr0
137683c5d981SAlexander Motin static void
137783c5d981SAlexander Motin camperiphdone(struct cam_periph *periph, union ccb *done_ccb)
137883c5d981SAlexander Motin {
13790191d9b3SAlexander Motin 	union ccb      *saved_ccb;
138083c5d981SAlexander Motin 	cam_status	status;
138183c5d981SAlexander Motin 	struct scsi_start_stop_unit *scsi_cmd;
138279fab7d4SAlexander Motin 	int		error = 0, error_code, sense_key, asc, ascq;
138313aa56fcSEdward Tomasz Napierala 	u_int16_t	done_flags;
138483c5d981SAlexander Motin 
13850191d9b3SAlexander Motin 	scsi_cmd = (struct scsi_start_stop_unit *)
13860191d9b3SAlexander Motin 	    &done_ccb->csio.cdb_io.cdb_bytes;
138783c5d981SAlexander Motin 	status = done_ccb->ccb_h.status;
13888b8a9b1dSJustin T. Gibbs 
13890191d9b3SAlexander Motin 	if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1390e7493b28SAlexander Motin 		if (scsi_extract_sense_ccb(done_ccb,
1391e7493b28SAlexander Motin 		    &error_code, &sense_key, &asc, &ascq)) {
139265afe1f4SKenneth D. Merry 			/*
13938b8a9b1dSJustin T. Gibbs 			 * If the error is "invalid field in CDB",
13948b8a9b1dSJustin T. Gibbs 			 * and the load/eject flag is set, turn the
13958b8a9b1dSJustin T. Gibbs 			 * flag off and try again.  This is just in
13968b8a9b1dSJustin T. Gibbs 			 * case the drive in question barfs on the
13978b8a9b1dSJustin T. Gibbs 			 * load eject flag.  The CAM code should set
13988b8a9b1dSJustin T. Gibbs 			 * the load/eject flag by default for
13998b8a9b1dSJustin T. Gibbs 			 * removable media.
14008b8a9b1dSJustin T. Gibbs 			 */
14018b8a9b1dSJustin T. Gibbs 			if ((scsi_cmd->opcode == START_STOP_UNIT) &&
14028b8a9b1dSJustin T. Gibbs 			    ((scsi_cmd->how & SSS_LOEJ) != 0) &&
14030191d9b3SAlexander Motin 			     (asc == 0x24) && (ascq == 0x00)) {
14048b8a9b1dSJustin T. Gibbs 				scsi_cmd->how &= ~SSS_LOEJ;
14050191d9b3SAlexander Motin 				if (status & CAM_DEV_QFRZN) {
14060191d9b3SAlexander Motin 					cam_release_devq(done_ccb->ccb_h.path,
14070191d9b3SAlexander Motin 					    0, 0, 0, 0);
14080191d9b3SAlexander Motin 					done_ccb->ccb_h.status &=
14090191d9b3SAlexander Motin 					    ~CAM_DEV_QFRZN;
14100191d9b3SAlexander Motin 				}
14118b8a9b1dSJustin T. Gibbs 				xpt_action(done_ccb);
14120191d9b3SAlexander Motin 				goto out;
14130191d9b3SAlexander Motin 			}
14140191d9b3SAlexander Motin 		}
141579fab7d4SAlexander Motin 		error = cam_periph_error(done_ccb, 0,
141679fab7d4SAlexander Motin 		    SF_RETRY_UA | SF_NO_PRINT);
141779fab7d4SAlexander Motin 		if (error == ERESTART)
14180191d9b3SAlexander Motin 			goto out;
14190191d9b3SAlexander Motin 		if (done_ccb->ccb_h.status & CAM_DEV_QFRZN) {
14200191d9b3SAlexander Motin 			cam_release_devq(done_ccb->ccb_h.path, 0, 0, 0, 0);
14210191d9b3SAlexander Motin 			done_ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
14220191d9b3SAlexander Motin 		}
14230191d9b3SAlexander Motin 	} else {
14240191d9b3SAlexander Motin 		/*
14250191d9b3SAlexander Motin 		 * If we have successfully taken a device from the not
14260191d9b3SAlexander Motin 		 * ready to ready state, re-scan the device and re-get
14270191d9b3SAlexander Motin 		 * the inquiry information.  Many devices (mostly disks)
14280191d9b3SAlexander Motin 		 * don't properly report their inquiry information unless
14290191d9b3SAlexander Motin 		 * they are spun up.
14300191d9b3SAlexander Motin 		 */
14310191d9b3SAlexander Motin 		if (scsi_cmd->opcode == START_STOP_UNIT)
14320191d9b3SAlexander Motin 			xpt_async(AC_INQ_CHANGED, done_ccb->ccb_h.path, NULL);
14330191d9b3SAlexander Motin 	}
143465afe1f4SKenneth D. Merry 
1435bae3729bSAlexander Motin 	/* If we tried long wait and still failed, remember that. */
1436bae3729bSAlexander Motin 	if ((periph->flags & CAM_PERIPH_RECOVERY_WAIT) &&
1437bae3729bSAlexander Motin 	    (done_ccb->csio.cdb_io.cdb_bytes[0] == TEST_UNIT_READY)) {
1438bae3729bSAlexander Motin 		periph->flags &= ~CAM_PERIPH_RECOVERY_WAIT;
1439bae3729bSAlexander Motin 		if (error != 0 && done_ccb->ccb_h.retry_count == 0)
1440bae3729bSAlexander Motin 			periph->flags |= CAM_PERIPH_RECOVERY_WAIT_FAILED;
1441bae3729bSAlexander Motin 	}
1442bae3729bSAlexander Motin 
14438b8a9b1dSJustin T. Gibbs 	/*
144479fab7d4SAlexander Motin 	 * After recovery action(s) completed, return to the original CCB.
144579fab7d4SAlexander Motin 	 * If the recovery CCB has failed, considering its own possible
144679fab7d4SAlexander Motin 	 * retries and recovery, assume we are back in state where we have
144779fab7d4SAlexander Motin 	 * been originally, but without recovery hopes left.  In such case,
144879fab7d4SAlexander Motin 	 * after the final attempt below, we cancel any further retries,
144979fab7d4SAlexander Motin 	 * blocking by that also any new recovery attempts for this CCB,
145079fab7d4SAlexander Motin 	 * and the result will be the final one returned to the CCB owher.
14518b8a9b1dSJustin T. Gibbs 	 */
14520191d9b3SAlexander Motin 	saved_ccb = (union ccb *)done_ccb->ccb_h.saved_ccb_ptr;
145313aa56fcSEdward Tomasz Napierala 	KASSERT(saved_ccb->ccb_h.func_code == XPT_SCSI_IO,
145413aa56fcSEdward Tomasz Napierala 	    ("%s: saved_ccb func_code %#x != XPT_SCSI_IO",
145513aa56fcSEdward Tomasz Napierala 	     __func__, saved_ccb->ccb_h.func_code));
145613aa56fcSEdward Tomasz Napierala 	KASSERT(done_ccb->ccb_h.func_code == XPT_SCSI_IO,
145713aa56fcSEdward Tomasz Napierala 	    ("%s: done_ccb func_code %#x != XPT_SCSI_IO",
145813aa56fcSEdward Tomasz Napierala 	     __func__, done_ccb->ccb_h.func_code));
1459404f0011SAlexander Motin 	saved_ccb->ccb_h.periph_links = done_ccb->ccb_h.periph_links;
146013aa56fcSEdward Tomasz Napierala 	done_flags = done_ccb->ccb_h.alloc_flags;
146113aa56fcSEdward Tomasz Napierala 	bcopy(saved_ccb, done_ccb, sizeof(struct ccb_scsiio));
146213aa56fcSEdward Tomasz Napierala 	done_ccb->ccb_h.alloc_flags = done_flags;
146383c5d981SAlexander Motin 	xpt_free_ccb(saved_ccb);
14640191d9b3SAlexander Motin 	if (done_ccb->ccb_h.cbfcnp != camperiphdone)
146560a899a0SKenneth D. Merry 		periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
146679fab7d4SAlexander Motin 	if (error != 0)
146779fab7d4SAlexander Motin 		done_ccb->ccb_h.retry_count = 0;
14688b8a9b1dSJustin T. Gibbs 	xpt_action(done_ccb);
14698b8a9b1dSJustin T. Gibbs 
14700191d9b3SAlexander Motin out:
14710191d9b3SAlexander Motin 	/* Drop freeze taken due to CAM_DEV_QFREEZE flag set. */
14720191d9b3SAlexander Motin 	cam_release_devq(done_ccb->ccb_h.path, 0, 0, 0, 0);
1473d84c90a6SAlexander Motin }
14748b8a9b1dSJustin T. Gibbs 
14758b8a9b1dSJustin T. Gibbs /*
147687cfaf0eSJustin T. Gibbs  * Generic Async Event handler.  Peripheral drivers usually
147787cfaf0eSJustin T. Gibbs  * filter out the events that require personal attention,
147887cfaf0eSJustin T. Gibbs  * and leave the rest to this function.
147987cfaf0eSJustin T. Gibbs  */
148087cfaf0eSJustin T. Gibbs void
148187cfaf0eSJustin T. Gibbs cam_periph_async(struct cam_periph *periph, u_int32_t code,
148287cfaf0eSJustin T. Gibbs 		 struct cam_path *path, void *arg)
148387cfaf0eSJustin T. Gibbs {
148487cfaf0eSJustin T. Gibbs 	switch (code) {
148587cfaf0eSJustin T. Gibbs 	case AC_LOST_DEVICE:
148687cfaf0eSJustin T. Gibbs 		cam_periph_invalidate(periph);
148787cfaf0eSJustin T. Gibbs 		break;
148887cfaf0eSJustin T. Gibbs 	default:
148987cfaf0eSJustin T. Gibbs 		break;
149087cfaf0eSJustin T. Gibbs 	}
149187cfaf0eSJustin T. Gibbs }
149287cfaf0eSJustin T. Gibbs 
149387cfaf0eSJustin T. Gibbs void
149487cfaf0eSJustin T. Gibbs cam_periph_bus_settle(struct cam_periph *periph, u_int bus_settle)
149587cfaf0eSJustin T. Gibbs {
149687cfaf0eSJustin T. Gibbs 	struct ccb_getdevstats cgds;
149787cfaf0eSJustin T. Gibbs 
1498076686feSEdward Tomasz Napierala 	memset(&cgds, 0, sizeof(cgds));
1499bbfa4aa1SAlexander Motin 	xpt_setup_ccb(&cgds.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
150087cfaf0eSJustin T. Gibbs 	cgds.ccb_h.func_code = XPT_GDEV_STATS;
150187cfaf0eSJustin T. Gibbs 	xpt_action((union ccb *)&cgds);
150287cfaf0eSJustin T. Gibbs 	cam_periph_freeze_after_event(periph, &cgds.last_reset, bus_settle);
150387cfaf0eSJustin T. Gibbs }
150487cfaf0eSJustin T. Gibbs 
150587cfaf0eSJustin T. Gibbs void
150687cfaf0eSJustin T. Gibbs cam_periph_freeze_after_event(struct cam_periph *periph,
150787cfaf0eSJustin T. Gibbs 			      struct timeval* event_time, u_int duration_ms)
150887cfaf0eSJustin T. Gibbs {
150987cfaf0eSJustin T. Gibbs 	struct timeval delta;
151087cfaf0eSJustin T. Gibbs 	struct timeval duration_tv;
151187cfaf0eSJustin T. Gibbs 
1512f8ff57d2SAlexander Motin 	if (!timevalisset(event_time))
1513f8ff57d2SAlexander Motin 		return;
1514f8ff57d2SAlexander Motin 
151587cfaf0eSJustin T. Gibbs 	microtime(&delta);
151687cfaf0eSJustin T. Gibbs 	timevalsub(&delta, event_time);
151787cfaf0eSJustin T. Gibbs 	duration_tv.tv_sec = duration_ms / 1000;
151887cfaf0eSJustin T. Gibbs 	duration_tv.tv_usec = (duration_ms % 1000) * 1000;
151987cfaf0eSJustin T. Gibbs 	if (timevalcmp(&delta, &duration_tv, <)) {
152087cfaf0eSJustin T. Gibbs 		timevalsub(&duration_tv, &delta);
152187cfaf0eSJustin T. Gibbs 
152287cfaf0eSJustin T. Gibbs 		duration_ms = duration_tv.tv_sec * 1000;
152387cfaf0eSJustin T. Gibbs 		duration_ms += duration_tv.tv_usec / 1000;
152487cfaf0eSJustin T. Gibbs 		cam_freeze_devq(periph->path);
152587cfaf0eSJustin T. Gibbs 		cam_release_devq(periph->path,
152687cfaf0eSJustin T. Gibbs 				RELSIM_RELEASE_AFTER_TIMEOUT,
152787cfaf0eSJustin T. Gibbs 				/*reduction*/0,
152887cfaf0eSJustin T. Gibbs 				/*timeout*/duration_ms,
152987cfaf0eSJustin T. Gibbs 				/*getcount_only*/0);
153087cfaf0eSJustin T. Gibbs 	}
153187cfaf0eSJustin T. Gibbs 
153287cfaf0eSJustin T. Gibbs }
153387cfaf0eSJustin T. Gibbs 
15343393f8daSKenneth D. Merry static int
15350191d9b3SAlexander Motin camperiphscsistatuserror(union ccb *ccb, union ccb **orig_ccb,
15360191d9b3SAlexander Motin     cam_flags camflags, u_int32_t sense_flags,
15373393f8daSKenneth D. Merry     int *openings, u_int32_t *relsim_flags,
15380181d54bSAlexander Motin     u_int32_t *timeout, u_int32_t *action, const char **action_string)
15398b8a9b1dSJustin T. Gibbs {
154099bad9caSAlexander Motin 	struct cam_periph *periph;
15418b8a9b1dSJustin T. Gibbs 	int error;
15428b8a9b1dSJustin T. Gibbs 
15438b8a9b1dSJustin T. Gibbs 	switch (ccb->csio.scsi_status) {
15448b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_OK:
15458b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_COND_MET:
15468b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_INTERMED:
15478b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_INTERMED_COND_MET:
15488b8a9b1dSJustin T. Gibbs 		error = 0;
15498b8a9b1dSJustin T. Gibbs 		break;
15508b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_CMD_TERMINATED:
15518b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_CHECK_COND:
15520191d9b3SAlexander Motin 		error = camperiphscsisenseerror(ccb, orig_ccb,
15533393f8daSKenneth D. Merry 					        camflags,
15548b8a9b1dSJustin T. Gibbs 					        sense_flags,
15553393f8daSKenneth D. Merry 					        openings,
15563393f8daSKenneth D. Merry 					        relsim_flags,
155783c5d981SAlexander Motin 					        timeout,
15580181d54bSAlexander Motin 					        action,
155983c5d981SAlexander Motin 					        action_string);
15608b8a9b1dSJustin T. Gibbs 		break;
15618b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_QUEUE_FULL:
15628b8a9b1dSJustin T. Gibbs 	{
15638b8a9b1dSJustin T. Gibbs 		/* no decrement */
156482815562SJustin T. Gibbs 		struct ccb_getdevstats cgds;
15658b8a9b1dSJustin T. Gibbs 
15668b8a9b1dSJustin T. Gibbs 		/*
15678b8a9b1dSJustin T. Gibbs 		 * First off, find out what the current
15688b8a9b1dSJustin T. Gibbs 		 * transaction counts are.
15698b8a9b1dSJustin T. Gibbs 		 */
1570076686feSEdward Tomasz Napierala 		memset(&cgds, 0, sizeof(cgds));
157182815562SJustin T. Gibbs 		xpt_setup_ccb(&cgds.ccb_h,
15728b8a9b1dSJustin T. Gibbs 			      ccb->ccb_h.path,
1573bbfa4aa1SAlexander Motin 			      CAM_PRIORITY_NORMAL);
157482815562SJustin T. Gibbs 		cgds.ccb_h.func_code = XPT_GDEV_STATS;
157582815562SJustin T. Gibbs 		xpt_action((union ccb *)&cgds);
15768b8a9b1dSJustin T. Gibbs 
15778b8a9b1dSJustin T. Gibbs 		/*
15788b8a9b1dSJustin T. Gibbs 		 * If we were the only transaction active, treat
15798b8a9b1dSJustin T. Gibbs 		 * the QUEUE FULL as if it were a BUSY condition.
15808b8a9b1dSJustin T. Gibbs 		 */
158182815562SJustin T. Gibbs 		if (cgds.dev_active != 0) {
158282815562SJustin T. Gibbs 			int total_openings;
158382815562SJustin T. Gibbs 
15848b8a9b1dSJustin T. Gibbs 			/*
15858b8a9b1dSJustin T. Gibbs 		 	 * Reduce the number of openings to
15868b8a9b1dSJustin T. Gibbs 			 * be 1 less than the amount it took
15878b8a9b1dSJustin T. Gibbs 			 * to get a queue full bounded by the
15888b8a9b1dSJustin T. Gibbs 			 * minimum allowed tag count for this
15898b8a9b1dSJustin T. Gibbs 			 * device.
15908b8a9b1dSJustin T. Gibbs 		 	 */
15913393f8daSKenneth D. Merry 			total_openings = cgds.dev_active + cgds.dev_openings;
15923393f8daSKenneth D. Merry 			*openings = cgds.dev_active;
15933393f8daSKenneth D. Merry 			if (*openings < cgds.mintags)
15943393f8daSKenneth D. Merry 				*openings = cgds.mintags;
15953393f8daSKenneth D. Merry 			if (*openings < total_openings)
15963393f8daSKenneth D. Merry 				*relsim_flags = RELSIM_ADJUST_OPENINGS;
15978b8a9b1dSJustin T. Gibbs 			else {
15988b8a9b1dSJustin T. Gibbs 				/*
15998b8a9b1dSJustin T. Gibbs 				 * Some devices report queue full for
16008b8a9b1dSJustin T. Gibbs 				 * temporary resource shortages.  For
16018b8a9b1dSJustin T. Gibbs 				 * this reason, we allow a minimum
16028b8a9b1dSJustin T. Gibbs 				 * tag count to be entered via a
16038b8a9b1dSJustin T. Gibbs 				 * quirk entry to prevent the queue
16048b8a9b1dSJustin T. Gibbs 				 * count on these devices from falling
16058b8a9b1dSJustin T. Gibbs 				 * to a pessimisticly low value.  We
16068b8a9b1dSJustin T. Gibbs 				 * still wait for the next successful
16078b8a9b1dSJustin T. Gibbs 				 * completion, however, before queueing
16088b8a9b1dSJustin T. Gibbs 				 * more transactions to the device.
16098b8a9b1dSJustin T. Gibbs 				 */
16103393f8daSKenneth D. Merry 				*relsim_flags = RELSIM_RELEASE_AFTER_CMDCMPLT;
16118b8a9b1dSJustin T. Gibbs 			}
16123393f8daSKenneth D. Merry 			*timeout = 0;
16138b8a9b1dSJustin T. Gibbs 			error = ERESTART;
16140181d54bSAlexander Motin 			*action &= ~SSQ_PRINT_SENSE;
16158b8a9b1dSJustin T. Gibbs 			break;
16168b8a9b1dSJustin T. Gibbs 		}
16178b8a9b1dSJustin T. Gibbs 		/* FALLTHROUGH */
16188b8a9b1dSJustin T. Gibbs 	}
16198b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_BUSY:
16208b8a9b1dSJustin T. Gibbs 		/*
16218b8a9b1dSJustin T. Gibbs 		 * Restart the queue after either another
16228b8a9b1dSJustin T. Gibbs 		 * command completes or a 1 second timeout.
16238b8a9b1dSJustin T. Gibbs 		 */
162499bad9caSAlexander Motin 		periph = xpt_path_periph(ccb->ccb_h.path);
162599bad9caSAlexander Motin 		if (periph->flags & CAM_PERIPH_INVALID) {
16269fb40bafSWarner Losh 			error = ENXIO;
162799bad9caSAlexander Motin 			*action_string = "Periph was invalidated";
162899bad9caSAlexander Motin 		} else if ((sense_flags & SF_RETRY_BUSY) != 0 ||
162999bad9caSAlexander Motin 		    ccb->ccb_h.retry_count > 0) {
163099bad9caSAlexander Motin 			if ((sense_flags & SF_RETRY_BUSY) == 0)
163199bad9caSAlexander Motin 				ccb->ccb_h.retry_count--;
16328b8a9b1dSJustin T. Gibbs 			error = ERESTART;
16333393f8daSKenneth D. Merry 			*relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT
16348b8a9b1dSJustin T. Gibbs 				      | RELSIM_RELEASE_AFTER_CMDCMPLT;
16353393f8daSKenneth D. Merry 			*timeout = 1000;
1636af51b059SMatt Jacob 		} else {
1637af51b059SMatt Jacob 			error = EIO;
163899bad9caSAlexander Motin 			*action_string = "Retries exhausted";
1639af51b059SMatt Jacob 		}
16408b8a9b1dSJustin T. Gibbs 		break;
16418b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_RESERV_CONFLICT:
16428b8a9b1dSJustin T. Gibbs 	default:
16438b8a9b1dSJustin T. Gibbs 		error = EIO;
16448b8a9b1dSJustin T. Gibbs 		break;
16458b8a9b1dSJustin T. Gibbs 	}
16463393f8daSKenneth D. Merry 	return (error);
16473393f8daSKenneth D. Merry }
16483393f8daSKenneth D. Merry 
16493393f8daSKenneth D. Merry static int
16500191d9b3SAlexander Motin camperiphscsisenseerror(union ccb *ccb, union ccb **orig,
16510191d9b3SAlexander Motin     cam_flags camflags, u_int32_t sense_flags,
16523393f8daSKenneth D. Merry     int *openings, u_int32_t *relsim_flags,
16530181d54bSAlexander Motin     u_int32_t *timeout, u_int32_t *action, const char **action_string)
16543393f8daSKenneth D. Merry {
16553393f8daSKenneth D. Merry 	struct cam_periph *periph;
165683c5d981SAlexander Motin 	union ccb *orig_ccb = ccb;
16570191d9b3SAlexander Motin 	int error, recoveryccb;
165813aa56fcSEdward Tomasz Napierala 	u_int16_t flags;
16593393f8daSKenneth D. Merry 
16608532d381SConrad Meyer #if defined(BUF_TRACKING) || defined(FULL_BUF_TRACKING)
16618532d381SConrad Meyer 	if (ccb->ccb_h.func_code == XPT_SCSI_IO && ccb->csio.bio != NULL)
16628532d381SConrad Meyer 		biotrack(ccb->csio.bio, __func__);
16638532d381SConrad Meyer #endif
16648532d381SConrad Meyer 
16653393f8daSKenneth D. Merry 	periph = xpt_path_periph(ccb->ccb_h.path);
16660191d9b3SAlexander Motin 	recoveryccb = (ccb->ccb_h.cbfcnp == camperiphdone);
16670191d9b3SAlexander Motin 	if ((periph->flags & CAM_PERIPH_RECOVERY_INPROG) && !recoveryccb) {
16683393f8daSKenneth D. Merry 		/*
16693393f8daSKenneth D. Merry 		 * If error recovery is already in progress, don't attempt
16703393f8daSKenneth D. Merry 		 * to process this error, but requeue it unconditionally
16713393f8daSKenneth D. Merry 		 * and attempt to process it once error recovery has
16723393f8daSKenneth D. Merry 		 * completed.  This failed command is probably related to
16733393f8daSKenneth D. Merry 		 * the error that caused the currently active error recovery
16743393f8daSKenneth D. Merry 		 * action so our  current recovery efforts should also
16753393f8daSKenneth D. Merry 		 * address this command.  Be aware that the error recovery
16763393f8daSKenneth D. Merry 		 * code assumes that only one recovery action is in progress
16773393f8daSKenneth D. Merry 		 * on a particular peripheral instance at any given time
16783393f8daSKenneth D. Merry 		 * (e.g. only one saved CCB for error recovery) so it is
16793393f8daSKenneth D. Merry 		 * imperitive that we don't violate this assumption.
16803393f8daSKenneth D. Merry 		 */
16813393f8daSKenneth D. Merry 		error = ERESTART;
16820181d54bSAlexander Motin 		*action &= ~SSQ_PRINT_SENSE;
16833393f8daSKenneth D. Merry 	} else {
16843393f8daSKenneth D. Merry 		scsi_sense_action err_action;
16853393f8daSKenneth D. Merry 		struct ccb_getdev cgd;
16863393f8daSKenneth D. Merry 
16873393f8daSKenneth D. Merry 		/*
16883393f8daSKenneth D. Merry 		 * Grab the inquiry data for this device.
16893393f8daSKenneth D. Merry 		 */
1690076686feSEdward Tomasz Napierala 		memset(&cgd, 0, sizeof(cgd));
1691bbfa4aa1SAlexander Motin 		xpt_setup_ccb(&cgd.ccb_h, ccb->ccb_h.path, CAM_PRIORITY_NORMAL);
16923393f8daSKenneth D. Merry 		cgd.ccb_h.func_code = XPT_GDEV_TYPE;
16933393f8daSKenneth D. Merry 		xpt_action((union ccb *)&cgd);
16943393f8daSKenneth D. Merry 
1695e7493b28SAlexander Motin 		err_action = scsi_error_action(&ccb->csio, &cgd.inq_data,
16963393f8daSKenneth D. Merry 		    sense_flags);
16973393f8daSKenneth D. Merry 		error = err_action & SS_ERRMASK;
16983393f8daSKenneth D. Merry 
16993393f8daSKenneth D. Merry 		/*
17000191d9b3SAlexander Motin 		 * Do not autostart sequential access devices
17010191d9b3SAlexander Motin 		 * to avoid unexpected tape loading.
17020191d9b3SAlexander Motin 		 */
17030191d9b3SAlexander Motin 		if ((err_action & SS_MASK) == SS_START &&
17040191d9b3SAlexander Motin 		    SID_TYPE(&cgd.inq_data) == T_SEQUENTIAL) {
17050191d9b3SAlexander Motin 			*action_string = "Will not autostart a "
17060191d9b3SAlexander Motin 			    "sequential access device";
17070191d9b3SAlexander Motin 			goto sense_error_done;
17080191d9b3SAlexander Motin 		}
17090191d9b3SAlexander Motin 
17100191d9b3SAlexander Motin 		/*
17110191d9b3SAlexander Motin 		 * Avoid recovery recursion if recovery action is the same.
17120191d9b3SAlexander Motin 		 */
17130191d9b3SAlexander Motin 		if ((err_action & SS_MASK) >= SS_START && recoveryccb) {
17140191d9b3SAlexander Motin 			if (((err_action & SS_MASK) == SS_START &&
17150191d9b3SAlexander Motin 			     ccb->csio.cdb_io.cdb_bytes[0] == START_STOP_UNIT) ||
17160191d9b3SAlexander Motin 			    ((err_action & SS_MASK) == SS_TUR &&
17170191d9b3SAlexander Motin 			     (ccb->csio.cdb_io.cdb_bytes[0] == TEST_UNIT_READY))) {
17180191d9b3SAlexander Motin 				err_action = SS_RETRY|SSQ_DECREMENT_COUNT|EIO;
17190191d9b3SAlexander Motin 				*relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
17200191d9b3SAlexander Motin 				*timeout = 500;
17210191d9b3SAlexander Motin 			}
17220191d9b3SAlexander Motin 		}
17230191d9b3SAlexander Motin 
17240191d9b3SAlexander Motin 		/*
17253393f8daSKenneth D. Merry 		 * If the recovery action will consume a retry,
17263393f8daSKenneth D. Merry 		 * make sure we actually have retries available.
17273393f8daSKenneth D. Merry 		 */
17283393f8daSKenneth D. Merry 		if ((err_action & SSQ_DECREMENT_COUNT) != 0) {
1729a07e846bSAlexander Motin 		 	if (ccb->ccb_h.retry_count > 0 &&
1730a07e846bSAlexander Motin 			    (periph->flags & CAM_PERIPH_INVALID) == 0)
17313393f8daSKenneth D. Merry 		 		ccb->ccb_h.retry_count--;
17323393f8daSKenneth D. Merry 			else {
173383c5d981SAlexander Motin 				*action_string = "Retries exhausted";
17343393f8daSKenneth D. Merry 				goto sense_error_done;
17353393f8daSKenneth D. Merry 			}
17363393f8daSKenneth D. Merry 		}
17373393f8daSKenneth D. Merry 
17383393f8daSKenneth D. Merry 		if ((err_action & SS_MASK) >= SS_START) {
17393393f8daSKenneth D. Merry 			/*
17403393f8daSKenneth D. Merry 			 * Do common portions of commands that
17413393f8daSKenneth D. Merry 			 * use recovery CCBs.
17423393f8daSKenneth D. Merry 			 */
174383c5d981SAlexander Motin 			orig_ccb = xpt_alloc_ccb_nowait();
174483c5d981SAlexander Motin 			if (orig_ccb == NULL) {
174583c5d981SAlexander Motin 				*action_string = "Can't allocate recovery CCB";
17463393f8daSKenneth D. Merry 				goto sense_error_done;
17473393f8daSKenneth D. Merry 			}
17481f1158b2SAlexander Motin 			/*
17491f1158b2SAlexander Motin 			 * Clear freeze flag for original request here, as
17501f1158b2SAlexander Motin 			 * this freeze will be dropped as part of ERESTART.
17511f1158b2SAlexander Motin 			 */
17521f1158b2SAlexander Motin 			ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
175313aa56fcSEdward Tomasz Napierala 
175413aa56fcSEdward Tomasz Napierala 			KASSERT(ccb->ccb_h.func_code == XPT_SCSI_IO,
175513aa56fcSEdward Tomasz Napierala 			    ("%s: ccb func_code %#x != XPT_SCSI_IO",
175613aa56fcSEdward Tomasz Napierala 			     __func__, ccb->ccb_h.func_code));
175713aa56fcSEdward Tomasz Napierala 			flags = orig_ccb->ccb_h.alloc_flags;
175813aa56fcSEdward Tomasz Napierala 			bcopy(ccb, orig_ccb, sizeof(struct ccb_scsiio));
175913aa56fcSEdward Tomasz Napierala 			orig_ccb->ccb_h.alloc_flags = flags;
17603393f8daSKenneth D. Merry 		}
17613393f8daSKenneth D. Merry 
17623393f8daSKenneth D. Merry 		switch (err_action & SS_MASK) {
17633393f8daSKenneth D. Merry 		case SS_NOP:
176483c5d981SAlexander Motin 			*action_string = "No recovery action needed";
176500e54d14SKenneth D. Merry 			error = 0;
176600e54d14SKenneth D. Merry 			break;
17673393f8daSKenneth D. Merry 		case SS_RETRY:
176883c5d981SAlexander Motin 			*action_string = "Retrying command (per sense data)";
17693393f8daSKenneth D. Merry 			error = ERESTART;
17708b8a9b1dSJustin T. Gibbs 			break;
17713393f8daSKenneth D. Merry 		case SS_FAIL:
177283c5d981SAlexander Motin 			*action_string = "Unretryable error";
17733393f8daSKenneth D. Merry 			break;
17743393f8daSKenneth D. Merry 		case SS_START:
17753393f8daSKenneth D. Merry 		{
17763393f8daSKenneth D. Merry 			int le;
17773393f8daSKenneth D. Merry 
17783393f8daSKenneth D. Merry 			/*
17793393f8daSKenneth D. Merry 			 * Send a start unit command to the device, and
17803393f8daSKenneth D. Merry 			 * then retry the command.
17813393f8daSKenneth D. Merry 			 */
178283c5d981SAlexander Motin 			*action_string = "Attempting to start unit";
178383c5d981SAlexander Motin 			periph->flags |= CAM_PERIPH_RECOVERY_INPROG;
17843393f8daSKenneth D. Merry 
17853393f8daSKenneth D. Merry 			/*
17863393f8daSKenneth D. Merry 			 * Check for removable media and set
17873393f8daSKenneth D. Merry 			 * load/eject flag appropriately.
17883393f8daSKenneth D. Merry 			 */
17893393f8daSKenneth D. Merry 			if (SID_IS_REMOVABLE(&cgd.inq_data))
17903393f8daSKenneth D. Merry 				le = TRUE;
17913393f8daSKenneth D. Merry 			else
17923393f8daSKenneth D. Merry 				le = FALSE;
17933393f8daSKenneth D. Merry 
17943393f8daSKenneth D. Merry 			scsi_start_stop(&ccb->csio,
17953393f8daSKenneth D. Merry 					/*retries*/1,
17963393f8daSKenneth D. Merry 					camperiphdone,
17973393f8daSKenneth D. Merry 					MSG_SIMPLE_Q_TAG,
17983393f8daSKenneth D. Merry 					/*start*/TRUE,
17993393f8daSKenneth D. Merry 					/*load/eject*/le,
18003393f8daSKenneth D. Merry 					/*immediate*/FALSE,
18013393f8daSKenneth D. Merry 					SSD_FULL_SIZE,
18023393f8daSKenneth D. Merry 					/*timeout*/50000);
18033393f8daSKenneth D. Merry 			break;
18043393f8daSKenneth D. Merry 		}
18053393f8daSKenneth D. Merry 		case SS_TUR:
18063393f8daSKenneth D. Merry 		{
18073393f8daSKenneth D. Merry 			/*
18083393f8daSKenneth D. Merry 			 * Send a Test Unit Ready to the device.
18093393f8daSKenneth D. Merry 			 * If the 'many' flag is set, we send 120
18103393f8daSKenneth D. Merry 			 * test unit ready commands, one every half
18113393f8daSKenneth D. Merry 			 * second.  Otherwise, we just send one TUR.
18123393f8daSKenneth D. Merry 			 * We only want to do this if the retry
18133393f8daSKenneth D. Merry 			 * count has not been exhausted.
18143393f8daSKenneth D. Merry 			 */
18153393f8daSKenneth D. Merry 			int retries;
18163393f8daSKenneth D. Merry 
1817bae3729bSAlexander Motin 			if ((err_action & SSQ_MANY) != 0 && (periph->flags &
1818bae3729bSAlexander Motin 			     CAM_PERIPH_RECOVERY_WAIT_FAILED) == 0) {
1819bae3729bSAlexander Motin 				periph->flags |= CAM_PERIPH_RECOVERY_WAIT;
182083c5d981SAlexander Motin 				*action_string = "Polling device for readiness";
18213393f8daSKenneth D. Merry 				retries = 120;
18223393f8daSKenneth D. Merry 			} else {
182383c5d981SAlexander Motin 				*action_string = "Testing device for readiness";
18243393f8daSKenneth D. Merry 				retries = 1;
18253393f8daSKenneth D. Merry 			}
182683c5d981SAlexander Motin 			periph->flags |= CAM_PERIPH_RECOVERY_INPROG;
18273393f8daSKenneth D. Merry 			scsi_test_unit_ready(&ccb->csio,
18283393f8daSKenneth D. Merry 					     retries,
18293393f8daSKenneth D. Merry 					     camperiphdone,
18303393f8daSKenneth D. Merry 					     MSG_SIMPLE_Q_TAG,
18313393f8daSKenneth D. Merry 					     SSD_FULL_SIZE,
18323393f8daSKenneth D. Merry 					     /*timeout*/5000);
18333393f8daSKenneth D. Merry 
18343393f8daSKenneth D. Merry 			/*
18353393f8daSKenneth D. Merry 			 * Accomplish our 500ms delay by deferring
18363393f8daSKenneth D. Merry 			 * the release of our device queue appropriately.
18373393f8daSKenneth D. Merry 			 */
18383393f8daSKenneth D. Merry 			*relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
18393393f8daSKenneth D. Merry 			*timeout = 500;
18403393f8daSKenneth D. Merry 			break;
18413393f8daSKenneth D. Merry 		}
18423393f8daSKenneth D. Merry 		default:
1843e3c29144SWarner Losh 			panic("Unhandled error action %x", err_action);
18443393f8daSKenneth D. Merry 		}
18453393f8daSKenneth D. Merry 
18463393f8daSKenneth D. Merry 		if ((err_action & SS_MASK) >= SS_START) {
18473393f8daSKenneth D. Merry 			/*
1848bbfa4aa1SAlexander Motin 			 * Drop the priority, so that the recovery
18493393f8daSKenneth D. Merry 			 * CCB is the first to execute.  Freeze the queue
18503393f8daSKenneth D. Merry 			 * after this command is sent so that we can
18513393f8daSKenneth D. Merry 			 * restore the old csio and have it queued in
18523393f8daSKenneth D. Merry 			 * the proper order before we release normal
18533393f8daSKenneth D. Merry 			 * transactions to the device.
18543393f8daSKenneth D. Merry 			 */
185583c5d981SAlexander Motin 			ccb->ccb_h.pinfo.priority--;
18563393f8daSKenneth D. Merry 			ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
185783c5d981SAlexander Motin 			ccb->ccb_h.saved_ccb_ptr = orig_ccb;
18583393f8daSKenneth D. Merry 			error = ERESTART;
18590191d9b3SAlexander Motin 			*orig = orig_ccb;
18603393f8daSKenneth D. Merry 		}
18613393f8daSKenneth D. Merry 
18623393f8daSKenneth D. Merry sense_error_done:
18630181d54bSAlexander Motin 		*action = err_action;
18643393f8daSKenneth D. Merry 	}
18653393f8daSKenneth D. Merry 	return (error);
18663393f8daSKenneth D. Merry }
18673393f8daSKenneth D. Merry 
18683393f8daSKenneth D. Merry /*
18693393f8daSKenneth D. Merry  * Generic error handler.  Peripheral drivers usually filter
18701ffe5851SPedro F. Giffuni  * out the errors that they handle in a unique manner, then
18713393f8daSKenneth D. Merry  * call this function.
18723393f8daSKenneth D. Merry  */
18733393f8daSKenneth D. Merry int
18743393f8daSKenneth D. Merry cam_periph_error(union ccb *ccb, cam_flags camflags,
1875553484aeSWarner Losh 		 u_int32_t sense_flags)
18763393f8daSKenneth D. Merry {
18770181d54bSAlexander Motin 	struct cam_path *newpath;
18780181d54bSAlexander Motin 	union ccb  *orig_ccb, *scan_ccb;
1879a07e846bSAlexander Motin 	struct cam_periph *periph;
18803393f8daSKenneth D. Merry 	const char *action_string;
18813393f8daSKenneth D. Merry 	cam_status  status;
1882a30ecd42SScott Long 	int	    frozen, error, openings, devctl_err;
18830181d54bSAlexander Motin 	u_int32_t   action, relsim_flags, timeout;
18843393f8daSKenneth D. Merry 
18850181d54bSAlexander Motin 	action = SSQ_PRINT_SENSE;
1886a07e846bSAlexander Motin 	periph = xpt_path_periph(ccb->ccb_h.path);
18873393f8daSKenneth D. Merry 	action_string = NULL;
18883393f8daSKenneth D. Merry 	status = ccb->ccb_h.status;
18893393f8daSKenneth D. Merry 	frozen = (status & CAM_DEV_QFRZN) != 0;
18903393f8daSKenneth D. Merry 	status &= CAM_STATUS_MASK;
1891a30ecd42SScott Long 	devctl_err = openings = relsim_flags = timeout = 0;
18920191d9b3SAlexander Motin 	orig_ccb = ccb;
18933393f8daSKenneth D. Merry 
1894a30ecd42SScott Long 	/* Filter the errors that should be reported via devctl */
1895a30ecd42SScott Long 	switch (ccb->ccb_h.status & CAM_STATUS_MASK) {
1896a30ecd42SScott Long 	case CAM_CMD_TIMEOUT:
1897a30ecd42SScott Long 	case CAM_REQ_ABORTED:
1898a30ecd42SScott Long 	case CAM_REQ_CMP_ERR:
1899a30ecd42SScott Long 	case CAM_REQ_TERMIO:
1900a30ecd42SScott Long 	case CAM_UNREC_HBA_ERROR:
1901a30ecd42SScott Long 	case CAM_DATA_RUN_ERR:
1902a30ecd42SScott Long 	case CAM_SCSI_STATUS_ERROR:
1903a30ecd42SScott Long 	case CAM_ATA_STATUS_ERROR:
1904a30ecd42SScott Long 	case CAM_SMP_STATUS_ERROR:
1905a30ecd42SScott Long 		devctl_err++;
1906a30ecd42SScott Long 		break;
1907a30ecd42SScott Long 	default:
1908a30ecd42SScott Long 		break;
1909a30ecd42SScott Long 	}
1910a30ecd42SScott Long 
19113393f8daSKenneth D. Merry 	switch (status) {
19123393f8daSKenneth D. Merry 	case CAM_REQ_CMP:
19133393f8daSKenneth D. Merry 		error = 0;
19140181d54bSAlexander Motin 		action &= ~SSQ_PRINT_SENSE;
19153393f8daSKenneth D. Merry 		break;
19163393f8daSKenneth D. Merry 	case CAM_SCSI_STATUS_ERROR:
19170191d9b3SAlexander Motin 		error = camperiphscsistatuserror(ccb, &orig_ccb,
19180191d9b3SAlexander Motin 		    camflags, sense_flags, &openings, &relsim_flags,
19190181d54bSAlexander Motin 		    &timeout, &action, &action_string);
19203393f8daSKenneth D. Merry 		break;
19213393f8daSKenneth D. Merry 	case CAM_AUTOSENSE_FAIL:
1922c7ec4390SMatt Jacob 		error = EIO;	/* we have to kill the command */
1923c7ec4390SMatt Jacob 		break;
19248b8a9b1dSJustin T. Gibbs 	case CAM_UA_ABORT:
19258b8a9b1dSJustin T. Gibbs 	case CAM_UA_TERMIO:
19268b8a9b1dSJustin T. Gibbs 	case CAM_MSG_REJECT_REC:
19278b8a9b1dSJustin T. Gibbs 		/* XXX Don't know that these are correct */
19288b8a9b1dSJustin T. Gibbs 		error = EIO;
19298b8a9b1dSJustin T. Gibbs 		break;
19308b8a9b1dSJustin T. Gibbs 	case CAM_SEL_TIMEOUT:
19313393f8daSKenneth D. Merry 		if ((camflags & CAM_RETRY_SELTO) != 0) {
1932a07e846bSAlexander Motin 			if (ccb->ccb_h.retry_count > 0 &&
1933a07e846bSAlexander Motin 			    (periph->flags & CAM_PERIPH_INVALID) == 0) {
19343393f8daSKenneth D. Merry 				ccb->ccb_h.retry_count--;
19353393f8daSKenneth D. Merry 				error = ERESTART;
19363393f8daSKenneth D. Merry 
19373393f8daSKenneth D. Merry 				/*
193873cf209fSMatt Jacob 				 * Wait a bit to give the device
19393393f8daSKenneth D. Merry 				 * time to recover before we try again.
19403393f8daSKenneth D. Merry 				 */
19413393f8daSKenneth D. Merry 				relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
194273cf209fSMatt Jacob 				timeout = periph_selto_delay;
19433393f8daSKenneth D. Merry 				break;
19443393f8daSKenneth D. Merry 			}
1945a07e846bSAlexander Motin 			action_string = "Retries exhausted";
19463393f8daSKenneth D. Merry 		}
19478900f4b8SKenneth D. Merry 		/* FALLTHROUGH */
19488900f4b8SKenneth D. Merry 	case CAM_DEV_NOT_THERE:
19493393f8daSKenneth D. Merry 		error = ENXIO;
19500181d54bSAlexander Motin 		action = SSQ_LOST;
19518b8a9b1dSJustin T. Gibbs 		break;
19528b8a9b1dSJustin T. Gibbs 	case CAM_REQ_INVALID:
19538b8a9b1dSJustin T. Gibbs 	case CAM_PATH_INVALID:
19548b8a9b1dSJustin T. Gibbs 	case CAM_NO_HBA:
19558b8a9b1dSJustin T. Gibbs 	case CAM_PROVIDE_FAIL:
19568b8a9b1dSJustin T. Gibbs 	case CAM_REQ_TOO_BIG:
19579a014e6fSIan Dowse 	case CAM_LUN_INVALID:
19589a014e6fSIan Dowse 	case CAM_TID_INVALID:
1959357478a5SAlexander Motin 	case CAM_FUNC_NOTAVAIL:
19608b8a9b1dSJustin T. Gibbs 		error = EINVAL;
19618b8a9b1dSJustin T. Gibbs 		break;
19628b8a9b1dSJustin T. Gibbs 	case CAM_SCSI_BUS_RESET:
19638b8a9b1dSJustin T. Gibbs 	case CAM_BDR_SENT:
19643393f8daSKenneth D. Merry 		/*
19653393f8daSKenneth D. Merry 		 * Commands that repeatedly timeout and cause these
19663393f8daSKenneth D. Merry 		 * kinds of error recovery actions, should return
19673393f8daSKenneth D. Merry 		 * CAM_CMD_TIMEOUT, which allows us to safely assume
19683393f8daSKenneth D. Merry 		 * that this command was an innocent bystander to
19693393f8daSKenneth D. Merry 		 * these events and should be unconditionally
19703393f8daSKenneth D. Merry 		 * retried.
19713393f8daSKenneth D. Merry 		 */
19728b8a9b1dSJustin T. Gibbs 	case CAM_REQUEUE_REQ:
19730191d9b3SAlexander Motin 		/* Unconditional requeue if device is still there */
19740191d9b3SAlexander Motin 		if (periph->flags & CAM_PERIPH_INVALID) {
19750191d9b3SAlexander Motin 			action_string = "Periph was invalidated";
19769fb40bafSWarner Losh 			error = ENXIO;
19770191d9b3SAlexander Motin 		} else if (sense_flags & SF_NO_RETRY) {
19780191d9b3SAlexander Motin 			error = EIO;
19790191d9b3SAlexander Motin 			action_string = "Retry was blocked";
198084c4de2dSAlexander Motin 		} else {
19810191d9b3SAlexander Motin 			error = ERESTART;
19820181d54bSAlexander Motin 			action &= ~SSQ_PRINT_SENSE;
198384c4de2dSAlexander Motin 		}
19848b8a9b1dSJustin T. Gibbs 		break;
19858b8a9b1dSJustin T. Gibbs 	case CAM_RESRC_UNAVAIL:
198673cf209fSMatt Jacob 		/* Wait a bit for the resource shortage to abate. */
198773cf209fSMatt Jacob 		timeout = periph_noresrc_delay;
198873cf209fSMatt Jacob 		/* FALLTHROUGH */
19898b8a9b1dSJustin T. Gibbs 	case CAM_BUSY:
199073cf209fSMatt Jacob 		if (timeout == 0) {
199173cf209fSMatt Jacob 			/* Wait a bit for the busy condition to abate. */
199273cf209fSMatt Jacob 			timeout = periph_busy_delay;
199373cf209fSMatt Jacob 		}
199473cf209fSMatt Jacob 		relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
199573cf209fSMatt Jacob 		/* FALLTHROUGH */
19960191d9b3SAlexander Motin 	case CAM_ATA_STATUS_ERROR:
19970191d9b3SAlexander Motin 	case CAM_REQ_CMP_ERR:
19980191d9b3SAlexander Motin 	case CAM_CMD_TIMEOUT:
19990191d9b3SAlexander Motin 	case CAM_UNEXP_BUSFREE:
20000191d9b3SAlexander Motin 	case CAM_UNCOR_PARITY:
20010191d9b3SAlexander Motin 	case CAM_DATA_RUN_ERR:
20028b8a9b1dSJustin T. Gibbs 	default:
20030191d9b3SAlexander Motin 		if (periph->flags & CAM_PERIPH_INVALID) {
20049fb40bafSWarner Losh 			error = ENXIO;
20050191d9b3SAlexander Motin 			action_string = "Periph was invalidated";
20060191d9b3SAlexander Motin 		} else if (ccb->ccb_h.retry_count == 0) {
20078b8a9b1dSJustin T. Gibbs 			error = EIO;
200883c5d981SAlexander Motin 			action_string = "Retries exhausted";
20090191d9b3SAlexander Motin 		} else if (sense_flags & SF_NO_RETRY) {
20100191d9b3SAlexander Motin 			error = EIO;
20110191d9b3SAlexander Motin 			action_string = "Retry was blocked";
20120191d9b3SAlexander Motin 		} else {
20130191d9b3SAlexander Motin 			ccb->ccb_h.retry_count--;
20140191d9b3SAlexander Motin 			error = ERESTART;
20158b8a9b1dSJustin T. Gibbs 		}
20168b8a9b1dSJustin T. Gibbs 		break;
20178b8a9b1dSJustin T. Gibbs 	}
20188b8a9b1dSJustin T. Gibbs 
20190191d9b3SAlexander Motin 	if ((sense_flags & SF_PRINT_ALWAYS) ||
20200191d9b3SAlexander Motin 	    CAM_DEBUGGED(ccb->ccb_h.path, CAM_DEBUG_INFO))
20210181d54bSAlexander Motin 		action |= SSQ_PRINT_SENSE;
20220191d9b3SAlexander Motin 	else if (sense_flags & SF_NO_PRINT)
20230181d54bSAlexander Motin 		action &= ~SSQ_PRINT_SENSE;
20240181d54bSAlexander Motin 	if ((action & SSQ_PRINT_SENSE) != 0)
20250191d9b3SAlexander Motin 		cam_error_print(orig_ccb, CAM_ESF_ALL, CAM_EPF_ALL);
20260181d54bSAlexander Motin 	if (error != 0 && (action & SSQ_PRINT_SENSE) != 0) {
20270f3e2159SAlexander Motin 		if (error != ERESTART) {
20283393f8daSKenneth D. Merry 			if (action_string == NULL)
202983c5d981SAlexander Motin 				action_string = "Unretryable error";
203083c5d981SAlexander Motin 			xpt_print(ccb->ccb_h.path, "Error %d, %s\n",
203183c5d981SAlexander Motin 			    error, action_string);
203283c5d981SAlexander Motin 		} else if (action_string != NULL)
2033f0d9af51SMatt Jacob 			xpt_print(ccb->ccb_h.path, "%s\n", action_string);
2034bc40691eSWarner Losh 		else {
2035bc40691eSWarner Losh 			xpt_print(ccb->ccb_h.path,
2036bc40691eSWarner Losh 			    "Retrying command, %d more tries remain\n",
2037bc40691eSWarner Losh 			    ccb->ccb_h.retry_count);
2038bc40691eSWarner Losh 		}
20390f3e2159SAlexander Motin 	}
20400f3e2159SAlexander Motin 
2041cd375264SAlexander Motin 	if (devctl_err && (error != 0 || (action & SSQ_PRINT_SENSE) != 0))
2042a30ecd42SScott Long 		cam_periph_devctl_notify(orig_ccb);
2043a30ecd42SScott Long 
20440181d54bSAlexander Motin 	if ((action & SSQ_LOST) != 0) {
20450191d9b3SAlexander Motin 		lun_id_t lun_id;
20460191d9b3SAlexander Motin 
20470191d9b3SAlexander Motin 		/*
20480191d9b3SAlexander Motin 		 * For a selection timeout, we consider all of the LUNs on
20490191d9b3SAlexander Motin 		 * the target to be gone.  If the status is CAM_DEV_NOT_THERE,
20500191d9b3SAlexander Motin 		 * then we only get rid of the device(s) specified by the
20510191d9b3SAlexander Motin 		 * path in the original CCB.
20520191d9b3SAlexander Motin 		 */
20530181d54bSAlexander Motin 		if (status == CAM_SEL_TIMEOUT)
20540191d9b3SAlexander Motin 			lun_id = CAM_LUN_WILDCARD;
20550181d54bSAlexander Motin 		else
20560181d54bSAlexander Motin 			lun_id = xpt_path_lun_id(ccb->ccb_h.path);
20570191d9b3SAlexander Motin 
20580191d9b3SAlexander Motin 		/* Should we do more if we can't create the path?? */
20590191d9b3SAlexander Motin 		if (xpt_create_path(&newpath, periph,
20600191d9b3SAlexander Motin 				    xpt_path_path_id(ccb->ccb_h.path),
20610191d9b3SAlexander Motin 				    xpt_path_target_id(ccb->ccb_h.path),
20620191d9b3SAlexander Motin 				    lun_id) == CAM_REQ_CMP) {
20630191d9b3SAlexander Motin 			/*
20640191d9b3SAlexander Motin 			 * Let peripheral drivers know that this
20650191d9b3SAlexander Motin 			 * device has gone away.
20660191d9b3SAlexander Motin 			 */
20670191d9b3SAlexander Motin 			xpt_async(AC_LOST_DEVICE, newpath, NULL);
20680191d9b3SAlexander Motin 			xpt_free_path(newpath);
20690191d9b3SAlexander Motin 		}
20700181d54bSAlexander Motin 	}
20713631c638SAlexander Motin 
20723631c638SAlexander Motin 	/* Broadcast UNIT ATTENTIONs to all periphs. */
20730181d54bSAlexander Motin 	if ((action & SSQ_UA) != 0)
20743631c638SAlexander Motin 		xpt_async(AC_UNIT_ATTENTION, orig_ccb->ccb_h.path, orig_ccb);
20750181d54bSAlexander Motin 
20760181d54bSAlexander Motin 	/* Rescan target on "Reported LUNs data has changed" */
20770181d54bSAlexander Motin 	if ((action & SSQ_RESCAN) != 0) {
20780181d54bSAlexander Motin 		if (xpt_create_path(&newpath, NULL,
20790181d54bSAlexander Motin 				    xpt_path_path_id(ccb->ccb_h.path),
20800181d54bSAlexander Motin 				    xpt_path_target_id(ccb->ccb_h.path),
2081e5736ac8SAlexander Motin 				    CAM_LUN_WILDCARD) == CAM_REQ_CMP) {
20820181d54bSAlexander Motin 			scan_ccb = xpt_alloc_ccb_nowait();
2083e5736ac8SAlexander Motin 			if (scan_ccb != NULL) {
20840181d54bSAlexander Motin 				scan_ccb->ccb_h.path = newpath;
2085e5736ac8SAlexander Motin 				scan_ccb->ccb_h.func_code = XPT_SCAN_TGT;
20860181d54bSAlexander Motin 				scan_ccb->crcn.flags = 0;
20870181d54bSAlexander Motin 				xpt_rescan(scan_ccb);
20883231e8bdSAlexander Motin 			} else {
2089e5736ac8SAlexander Motin 				xpt_print(newpath,
2090e5736ac8SAlexander Motin 				    "Can't allocate CCB to rescan target\n");
20913231e8bdSAlexander Motin 				xpt_free_path(newpath);
20923231e8bdSAlexander Motin 			}
20930181d54bSAlexander Motin 		}
20940191d9b3SAlexander Motin 	}
20950191d9b3SAlexander Motin 
20960f3e2159SAlexander Motin 	/* Attempt a retry */
20970f3e2159SAlexander Motin 	if (error == ERESTART || error == 0) {
20980f3e2159SAlexander Motin 		if (frozen != 0)
20990f3e2159SAlexander Motin 			ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
21000f3e2159SAlexander Motin 		if (error == ERESTART)
21010f3e2159SAlexander Motin 			xpt_action(ccb);
21020f3e2159SAlexander Motin 		if (frozen != 0)
21030f3e2159SAlexander Motin 			cam_release_devq(ccb->ccb_h.path,
21040f3e2159SAlexander Motin 					 relsim_flags,
21050f3e2159SAlexander Motin 					 openings,
21060f3e2159SAlexander Motin 					 timeout,
21070f3e2159SAlexander Motin 					 /*getcount_only*/0);
21083393f8daSKenneth D. Merry 	}
21098b8a9b1dSJustin T. Gibbs 
21108b8a9b1dSJustin T. Gibbs 	return (error);
21118b8a9b1dSJustin T. Gibbs }
2112a30ecd42SScott Long 
2113a30ecd42SScott Long #define CAM_PERIPH_DEVD_MSG_SIZE	256
2114a30ecd42SScott Long 
2115a30ecd42SScott Long static void
2116a30ecd42SScott Long cam_periph_devctl_notify(union ccb *ccb)
2117a30ecd42SScott Long {
2118a30ecd42SScott Long 	struct cam_periph *periph;
2119a30ecd42SScott Long 	struct ccb_getdev *cgd;
2120a30ecd42SScott Long 	struct sbuf sb;
2121a30ecd42SScott Long 	int serr, sk, asc, ascq;
2122a30ecd42SScott Long 	char *sbmsg, *type;
2123a30ecd42SScott Long 
2124a30ecd42SScott Long 	sbmsg = malloc(CAM_PERIPH_DEVD_MSG_SIZE, M_CAMPERIPH, M_NOWAIT);
2125a30ecd42SScott Long 	if (sbmsg == NULL)
2126a30ecd42SScott Long 		return;
2127a30ecd42SScott Long 
2128a30ecd42SScott Long 	sbuf_new(&sb, sbmsg, CAM_PERIPH_DEVD_MSG_SIZE, SBUF_FIXEDLEN);
2129a30ecd42SScott Long 
2130a30ecd42SScott Long 	periph = xpt_path_periph(ccb->ccb_h.path);
2131a30ecd42SScott Long 	sbuf_printf(&sb, "device=%s%d ", periph->periph_name,
2132a30ecd42SScott Long 	    periph->unit_number);
2133a30ecd42SScott Long 
2134a30ecd42SScott Long 	sbuf_printf(&sb, "serial=\"");
2135a30ecd42SScott Long 	if ((cgd = (struct ccb_getdev *)xpt_alloc_ccb_nowait()) != NULL) {
2136a30ecd42SScott Long 		xpt_setup_ccb(&cgd->ccb_h, ccb->ccb_h.path,
2137a30ecd42SScott Long 		    CAM_PRIORITY_NORMAL);
2138a30ecd42SScott Long 		cgd->ccb_h.func_code = XPT_GDEV_TYPE;
2139a30ecd42SScott Long 		xpt_action((union ccb *)cgd);
2140a30ecd42SScott Long 
2141a30ecd42SScott Long 		if (cgd->ccb_h.status == CAM_REQ_CMP)
2142a30ecd42SScott Long 			sbuf_bcat(&sb, cgd->serial_num, cgd->serial_num_len);
2143de482e7bSScott Long 		xpt_free_ccb((union ccb *)cgd);
2144a30ecd42SScott Long 	}
2145a30ecd42SScott Long 	sbuf_printf(&sb, "\" ");
2146a30ecd42SScott Long 	sbuf_printf(&sb, "cam_status=\"0x%x\" ", ccb->ccb_h.status);
2147a30ecd42SScott Long 
2148a30ecd42SScott Long 	switch (ccb->ccb_h.status & CAM_STATUS_MASK) {
2149a30ecd42SScott Long 	case CAM_CMD_TIMEOUT:
2150a30ecd42SScott Long 		sbuf_printf(&sb, "timeout=%d ", ccb->ccb_h.timeout);
2151a30ecd42SScott Long 		type = "timeout";
2152a30ecd42SScott Long 		break;
2153a30ecd42SScott Long 	case CAM_SCSI_STATUS_ERROR:
2154a30ecd42SScott Long 		sbuf_printf(&sb, "scsi_status=%d ", ccb->csio.scsi_status);
2155a30ecd42SScott Long 		if (scsi_extract_sense_ccb(ccb, &serr, &sk, &asc, &ascq))
2156a30ecd42SScott Long 			sbuf_printf(&sb, "scsi_sense=\"%02x %02x %02x %02x\" ",
2157a30ecd42SScott Long 			    serr, sk, asc, ascq);
2158a30ecd42SScott Long 		type = "error";
2159a30ecd42SScott Long 		break;
2160a30ecd42SScott Long 	case CAM_ATA_STATUS_ERROR:
2161a30ecd42SScott Long 		sbuf_printf(&sb, "RES=\"");
2162a30ecd42SScott Long 		ata_res_sbuf(&ccb->ataio.res, &sb);
2163a30ecd42SScott Long 		sbuf_printf(&sb, "\" ");
2164a30ecd42SScott Long 		type = "error";
2165a30ecd42SScott Long 		break;
2166a30ecd42SScott Long 	default:
2167a30ecd42SScott Long 		type = "error";
2168a30ecd42SScott Long 		break;
2169a30ecd42SScott Long 	}
2170a30ecd42SScott Long 
2171a30ecd42SScott Long 	if (ccb->ccb_h.func_code == XPT_SCSI_IO) {
2172a30ecd42SScott Long 		sbuf_printf(&sb, "CDB=\"");
21734902e14dSAlexander Motin 		scsi_cdb_sbuf(scsiio_cdb_ptr(&ccb->csio), &sb);
2174a30ecd42SScott Long 		sbuf_printf(&sb, "\" ");
2175a30ecd42SScott Long 	} else if (ccb->ccb_h.func_code == XPT_ATA_IO) {
2176a30ecd42SScott Long 		sbuf_printf(&sb, "ACB=\"");
2177a30ecd42SScott Long 		ata_cmd_sbuf(&ccb->ataio.cmd, &sb);
2178a30ecd42SScott Long 		sbuf_printf(&sb, "\" ");
2179a30ecd42SScott Long 	}
2180a30ecd42SScott Long 
2181a30ecd42SScott Long 	if (sbuf_finish(&sb) == 0)
2182a30ecd42SScott Long 		devctl_notify("CAM", "periph", type, sbuf_data(&sb));
2183a30ecd42SScott Long 	sbuf_delete(&sb);
2184a30ecd42SScott Long 	free(sbmsg, M_CAMPERIPH);
2185a30ecd42SScott Long }
2186a30ecd42SScott Long 
2187d38677d2SWarner Losh /*
2188d38677d2SWarner Losh  * Sysctl to force an invalidation of the drive right now. Can be
2189d38677d2SWarner Losh  * called with CTLFLAG_MPSAFE since we take periph lock.
2190d38677d2SWarner Losh  */
2191d38677d2SWarner Losh int
2192d38677d2SWarner Losh cam_periph_invalidate_sysctl(SYSCTL_HANDLER_ARGS)
2193d38677d2SWarner Losh {
2194d38677d2SWarner Losh 	struct cam_periph *periph;
2195d38677d2SWarner Losh 	int error, value;
2196d38677d2SWarner Losh 
2197d38677d2SWarner Losh 	periph = arg1;
2198d38677d2SWarner Losh 	value = 0;
2199d38677d2SWarner Losh 	error = sysctl_handle_int(oidp, &value, 0, req);
2200d38677d2SWarner Losh 	if (error != 0 || req->newptr == NULL || value != 1)
2201d38677d2SWarner Losh 		return (error);
2202d38677d2SWarner Losh 
2203d38677d2SWarner Losh 	cam_periph_lock(periph);
2204d38677d2SWarner Losh 	cam_periph_invalidate(periph);
2205d38677d2SWarner Losh 	cam_periph_unlock(periph);
2206d38677d2SWarner Losh 
2207d38677d2SWarner Losh 	return (0);
2208d38677d2SWarner Losh }
2209