xref: /freebsd/sys/cam/cam_periph.c (revision 81490eda6034d22794fc7a5e759f4288a0d0ef14)
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>
42f34fa851SJohn Baldwin #include <sys/lock.h>
43f34fa851SJohn Baldwin #include <sys/mutex.h>
448b8a9b1dSJustin T. Gibbs #include <sys/buf.h>
458b8a9b1dSJustin T. Gibbs #include <sys/proc.h>
468b8a9b1dSJustin T. Gibbs #include <sys/devicestat.h>
4775f51904SPeter Wemm #include <sys/bus.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>
578b8a9b1dSJustin T. Gibbs #include <cam/cam_periph.h>
588b8a9b1dSJustin T. Gibbs #include <cam/cam_debug.h>
592b83592fSScott Long #include <cam/cam_sim.h>
608b8a9b1dSJustin T. Gibbs 
618b8a9b1dSJustin T. Gibbs #include <cam/scsi/scsi_all.h>
628b8a9b1dSJustin T. Gibbs #include <cam/scsi/scsi_message.h>
638b8a9b1dSJustin T. Gibbs #include <cam/scsi/scsi_pass.h>
648b8a9b1dSJustin T. Gibbs 
658b8a9b1dSJustin T. Gibbs static	u_int		camperiphnextunit(struct periph_driver *p_drv,
66501468a5SKenneth D. Merry 					  u_int newunit, int wired,
67501468a5SKenneth D. Merry 					  path_id_t pathid, target_id_t target,
68501468a5SKenneth D. Merry 					  lun_id_t lun);
698b8a9b1dSJustin T. Gibbs static	u_int		camperiphunit(struct periph_driver *p_drv,
70501468a5SKenneth D. Merry 				      path_id_t pathid, target_id_t target,
71501468a5SKenneth D. Merry 				      lun_id_t lun);
728b8a9b1dSJustin T. Gibbs static	void		camperiphdone(struct cam_periph *periph,
738b8a9b1dSJustin T. Gibbs 					union ccb *done_ccb);
748b8a9b1dSJustin T. Gibbs static  void		camperiphfree(struct cam_periph *periph);
753393f8daSKenneth D. Merry static int		camperiphscsistatuserror(union ccb *ccb,
760191d9b3SAlexander Motin 					        union ccb **orig_ccb,
773393f8daSKenneth D. Merry 						 cam_flags camflags,
783393f8daSKenneth D. Merry 						 u_int32_t sense_flags,
793393f8daSKenneth D. Merry 						 int *openings,
803393f8daSKenneth D. Merry 						 u_int32_t *relsim_flags,
8183c5d981SAlexander Motin 						 u_int32_t *timeout,
820181d54bSAlexander Motin 						 u_int32_t  *action,
8383c5d981SAlexander Motin 						 const char **action_string);
843393f8daSKenneth D. Merry static	int		camperiphscsisenseerror(union ccb *ccb,
850191d9b3SAlexander Motin 					        union ccb **orig_ccb,
863393f8daSKenneth D. Merry 					        cam_flags camflags,
873393f8daSKenneth D. Merry 					        u_int32_t sense_flags,
883393f8daSKenneth D. Merry 					        int *openings,
893393f8daSKenneth D. Merry 					        u_int32_t *relsim_flags,
9083c5d981SAlexander Motin 					        u_int32_t *timeout,
910181d54bSAlexander Motin 					        u_int32_t *action,
9283c5d981SAlexander Motin 					        const char **action_string);
93a30ecd42SScott Long static void		cam_periph_devctl_notify(union ccb *ccb);
948b8a9b1dSJustin T. Gibbs 
950b7c27b9SPeter Wemm static int nperiph_drivers;
9683c5d981SAlexander Motin static int initialized = 0;
970b7c27b9SPeter Wemm struct periph_driver **periph_drivers;
980b7c27b9SPeter Wemm 
99d745c852SEd Schouten static MALLOC_DEFINE(M_CAMPERIPH, "CAM periph", "CAM peripheral buffers");
100362abc44STai-hwa Liang 
10173cf209fSMatt Jacob static int periph_selto_delay = 1000;
10273cf209fSMatt Jacob TUNABLE_INT("kern.cam.periph_selto_delay", &periph_selto_delay);
10373cf209fSMatt Jacob static int periph_noresrc_delay = 500;
10473cf209fSMatt Jacob TUNABLE_INT("kern.cam.periph_noresrc_delay", &periph_noresrc_delay);
10573cf209fSMatt Jacob static int periph_busy_delay = 500;
10673cf209fSMatt Jacob TUNABLE_INT("kern.cam.periph_busy_delay", &periph_busy_delay);
10773cf209fSMatt Jacob 
108b059686aSAlexander Motin static u_int periph_mapmem_thresh = 65536;
109b059686aSAlexander Motin SYSCTL_UINT(_kern_cam, OID_AUTO, mapmem_thresh, CTLFLAG_RWTUN,
110b059686aSAlexander Motin     &periph_mapmem_thresh, 0, "Threshold for user-space buffer mapping");
11173cf209fSMatt Jacob 
1120b7c27b9SPeter Wemm void
1130b7c27b9SPeter Wemm periphdriver_register(void *data)
1140b7c27b9SPeter Wemm {
11583c5d981SAlexander Motin 	struct periph_driver *drv = (struct periph_driver *)data;
1160b7c27b9SPeter Wemm 	struct periph_driver **newdrivers, **old;
1170b7c27b9SPeter Wemm 	int ndrivers;
1180b7c27b9SPeter Wemm 
1195719711fSEdward Tomasz Napierala again:
1200b7c27b9SPeter Wemm 	ndrivers = nperiph_drivers + 2;
1210dd50e9bSScott Long 	newdrivers = malloc(sizeof(*newdrivers) * ndrivers, M_CAMPERIPH,
1220dd50e9bSScott Long 			    M_WAITOK);
1235719711fSEdward Tomasz Napierala 	xpt_lock_buses();
1245719711fSEdward Tomasz Napierala 	if (ndrivers != nperiph_drivers + 2) {
1255719711fSEdward Tomasz Napierala 		/*
1265719711fSEdward Tomasz Napierala 		 * Lost race against itself; go around.
1275719711fSEdward Tomasz Napierala 		 */
1285719711fSEdward Tomasz Napierala 		xpt_unlock_buses();
1295719711fSEdward Tomasz Napierala 		free(newdrivers, M_CAMPERIPH);
1305719711fSEdward Tomasz Napierala 		goto again;
1315719711fSEdward Tomasz Napierala 	}
1320b7c27b9SPeter Wemm 	if (periph_drivers)
1330b7c27b9SPeter Wemm 		bcopy(periph_drivers, newdrivers,
134623db360SKenneth D. Merry 		      sizeof(*newdrivers) * nperiph_drivers);
13583c5d981SAlexander Motin 	newdrivers[nperiph_drivers] = drv;
1360b7c27b9SPeter Wemm 	newdrivers[nperiph_drivers + 1] = NULL;
1370b7c27b9SPeter Wemm 	old = periph_drivers;
1380b7c27b9SPeter Wemm 	periph_drivers = newdrivers;
1395719711fSEdward Tomasz Napierala 	nperiph_drivers++;
1405719711fSEdward Tomasz Napierala 	xpt_unlock_buses();
1410b7c27b9SPeter Wemm 	if (old)
1420dd50e9bSScott Long 		free(old, M_CAMPERIPH);
14383c5d981SAlexander Motin 	/* If driver marked as early or it is late now, initialize it. */
14483c5d981SAlexander Motin 	if (((drv->flags & CAM_PERIPH_DRV_EARLY) != 0 && initialized > 0) ||
14583c5d981SAlexander Motin 	    initialized > 1)
14683c5d981SAlexander Motin 		(*drv->init)();
14783c5d981SAlexander Motin }
14883c5d981SAlexander Motin 
14994173c3cSAlexander Motin int
15094173c3cSAlexander Motin periphdriver_unregister(void *data)
15194173c3cSAlexander Motin {
15294173c3cSAlexander Motin 	struct periph_driver *drv = (struct periph_driver *)data;
15394173c3cSAlexander Motin 	int error, n;
15494173c3cSAlexander Motin 
15594173c3cSAlexander Motin 	/* If driver marked as early or it is late now, deinitialize it. */
15694173c3cSAlexander Motin 	if (((drv->flags & CAM_PERIPH_DRV_EARLY) != 0 && initialized > 0) ||
15794173c3cSAlexander Motin 	    initialized > 1) {
15894173c3cSAlexander Motin 		if (drv->deinit == NULL) {
15994173c3cSAlexander Motin 			printf("CAM periph driver '%s' doesn't have deinit.\n",
16094173c3cSAlexander Motin 			    drv->driver_name);
16194173c3cSAlexander Motin 			return (EOPNOTSUPP);
16294173c3cSAlexander Motin 		}
16394173c3cSAlexander Motin 		error = drv->deinit();
16494173c3cSAlexander Motin 		if (error != 0)
16594173c3cSAlexander Motin 			return (error);
16694173c3cSAlexander Motin 	}
16794173c3cSAlexander Motin 
16894173c3cSAlexander Motin 	xpt_lock_buses();
16994173c3cSAlexander Motin 	for (n = 0; n < nperiph_drivers && periph_drivers[n] != drv; n++)
17094173c3cSAlexander Motin 		;
17194173c3cSAlexander Motin 	KASSERT(n < nperiph_drivers,
17294173c3cSAlexander Motin 	    ("Periph driver '%s' was not registered", drv->driver_name));
17394173c3cSAlexander Motin 	for (; n + 1 < nperiph_drivers; n++)
17494173c3cSAlexander Motin 		periph_drivers[n] = periph_drivers[n + 1];
17594173c3cSAlexander Motin 	periph_drivers[n + 1] = NULL;
17694173c3cSAlexander Motin 	nperiph_drivers--;
17794173c3cSAlexander Motin 	xpt_unlock_buses();
17894173c3cSAlexander Motin 	return (0);
17994173c3cSAlexander Motin }
18094173c3cSAlexander Motin 
18183c5d981SAlexander Motin void
18283c5d981SAlexander Motin periphdriver_init(int level)
18383c5d981SAlexander Motin {
18483c5d981SAlexander Motin 	int	i, early;
18583c5d981SAlexander Motin 
18683c5d981SAlexander Motin 	initialized = max(initialized, level);
18783c5d981SAlexander Motin 	for (i = 0; periph_drivers[i] != NULL; i++) {
18883c5d981SAlexander Motin 		early = (periph_drivers[i]->flags & CAM_PERIPH_DRV_EARLY) ? 1 : 2;
18983c5d981SAlexander Motin 		if (early == initialized)
19083c5d981SAlexander Motin 			(*periph_drivers[i]->init)();
19183c5d981SAlexander Motin 	}
1920b7c27b9SPeter Wemm }
1930b7c27b9SPeter Wemm 
1948b8a9b1dSJustin T. Gibbs cam_status
195ee9c90c7SKenneth D. Merry cam_periph_alloc(periph_ctor_t *periph_ctor,
196ee9c90c7SKenneth D. Merry 		 periph_oninv_t *periph_oninvalidate,
197ee9c90c7SKenneth D. Merry 		 periph_dtor_t *periph_dtor, periph_start_t *periph_start,
198ee9c90c7SKenneth D. Merry 		 char *name, cam_periph_type type, struct cam_path *path,
199ee9c90c7SKenneth D. Merry 		 ac_callback_t *ac_callback, ac_code code, void *arg)
2008b8a9b1dSJustin T. Gibbs {
2018b8a9b1dSJustin T. Gibbs 	struct		periph_driver **p_drv;
2022b83592fSScott Long 	struct		cam_sim *sim;
2038b8a9b1dSJustin T. Gibbs 	struct		cam_periph *periph;
2048b8a9b1dSJustin T. Gibbs 	struct		cam_periph *cur_periph;
2058b8a9b1dSJustin T. Gibbs 	path_id_t	path_id;
2068b8a9b1dSJustin T. Gibbs 	target_id_t	target_id;
2078b8a9b1dSJustin T. Gibbs 	lun_id_t	lun_id;
2088b8a9b1dSJustin T. Gibbs 	cam_status	status;
2098b8a9b1dSJustin T. Gibbs 	u_int		init_level;
2108b8a9b1dSJustin T. Gibbs 
2118b8a9b1dSJustin T. Gibbs 	init_level = 0;
2128b8a9b1dSJustin T. Gibbs 	/*
2138b8a9b1dSJustin T. Gibbs 	 * Handle Hot-Plug scenarios.  If there is already a peripheral
2148b8a9b1dSJustin T. Gibbs 	 * of our type assigned to this path, we are likely waiting for
2158b8a9b1dSJustin T. Gibbs 	 * final close on an old, invalidated, peripheral.  If this is
2168b8a9b1dSJustin T. Gibbs 	 * the case, queue up a deferred call to the peripheral's async
21774c91ec5SJustin T. Gibbs 	 * handler.  If it looks like a mistaken re-allocation, complain.
2188b8a9b1dSJustin T. Gibbs 	 */
2198b8a9b1dSJustin T. Gibbs 	if ((periph = cam_periph_find(path, name)) != NULL) {
2208b8a9b1dSJustin T. Gibbs 
2218b8a9b1dSJustin T. Gibbs 		if ((periph->flags & CAM_PERIPH_INVALID) != 0
2228b8a9b1dSJustin T. Gibbs 		 && (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) == 0) {
2238b8a9b1dSJustin T. Gibbs 			periph->flags |= CAM_PERIPH_NEW_DEV_FOUND;
2248b8a9b1dSJustin T. Gibbs 			periph->deferred_callback = ac_callback;
2258b8a9b1dSJustin T. Gibbs 			periph->deferred_ac = code;
2268b8a9b1dSJustin T. Gibbs 			return (CAM_REQ_INPROG);
2278b8a9b1dSJustin T. Gibbs 		} else {
2288b8a9b1dSJustin T. Gibbs 			printf("cam_periph_alloc: attempt to re-allocate "
2298900f4b8SKenneth D. Merry 			       "valid device %s%d rejected flags %#x "
2308900f4b8SKenneth D. Merry 			       "refcount %d\n", periph->periph_name,
2318900f4b8SKenneth D. Merry 			       periph->unit_number, periph->flags,
2328900f4b8SKenneth D. Merry 			       periph->refcount);
2338b8a9b1dSJustin T. Gibbs 		}
2348b8a9b1dSJustin T. Gibbs 		return (CAM_REQ_INVALID);
2358b8a9b1dSJustin T. Gibbs 	}
2368b8a9b1dSJustin T. Gibbs 
237362abc44STai-hwa Liang 	periph = (struct cam_periph *)malloc(sizeof(*periph), M_CAMPERIPH,
2388900f4b8SKenneth D. Merry 					     M_NOWAIT|M_ZERO);
2398b8a9b1dSJustin T. Gibbs 
2408b8a9b1dSJustin T. Gibbs 	if (periph == NULL)
2418b8a9b1dSJustin T. Gibbs 		return (CAM_RESRC_UNAVAIL);
2428b8a9b1dSJustin T. Gibbs 
2438b8a9b1dSJustin T. Gibbs 	init_level++;
2448b8a9b1dSJustin T. Gibbs 
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 	}
277f1e2546aSMatt Jacob 	periph->unit_number = camperiphunit(*p_drv, path_id, target_id, lun_id);
2788b8a9b1dSJustin T. Gibbs 	cur_periph = TAILQ_FIRST(&(*p_drv)->units);
2798b8a9b1dSJustin T. Gibbs 	while (cur_periph != NULL
2808b8a9b1dSJustin T. Gibbs 	    && cur_periph->unit_number < periph->unit_number)
2818b8a9b1dSJustin T. Gibbs 		cur_periph = TAILQ_NEXT(cur_periph, unit_links);
282f1e2546aSMatt Jacob 	if (cur_periph != NULL) {
283f1e2546aSMatt Jacob 		KASSERT(cur_periph->unit_number != periph->unit_number, ("duplicate units on periph list"));
2848b8a9b1dSJustin T. Gibbs 		TAILQ_INSERT_BEFORE(cur_periph, periph, unit_links);
285f1e2546aSMatt Jacob 	} else {
2868b8a9b1dSJustin T. Gibbs 		TAILQ_INSERT_TAIL(&(*p_drv)->units, periph, unit_links);
2878b8a9b1dSJustin T. Gibbs 		(*p_drv)->generation++;
2888b8a9b1dSJustin T. Gibbs 	}
289f1e2546aSMatt Jacob 	xpt_unlock_buses();
290f1e2546aSMatt Jacob 
291f1e2546aSMatt Jacob 	init_level++;
292f1e2546aSMatt Jacob 
293f1e2546aSMatt Jacob 	status = xpt_add_periph(periph);
294f1e2546aSMatt Jacob 	if (status != CAM_REQ_CMP)
295f1e2546aSMatt Jacob 		goto failure;
2968b8a9b1dSJustin T. Gibbs 
2978b8a9b1dSJustin T. Gibbs 	init_level++;
29822c7d606SAlexander Motin 	CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph created\n"));
2998b8a9b1dSJustin T. Gibbs 
3008b8a9b1dSJustin T. Gibbs 	status = periph_ctor(periph, arg);
3018b8a9b1dSJustin T. Gibbs 
3028b8a9b1dSJustin T. Gibbs 	if (status == CAM_REQ_CMP)
3038b8a9b1dSJustin T. Gibbs 		init_level++;
3048b8a9b1dSJustin T. Gibbs 
3058b8a9b1dSJustin T. Gibbs failure:
3068b8a9b1dSJustin T. Gibbs 	switch (init_level) {
3078b8a9b1dSJustin T. Gibbs 	case 4:
3088b8a9b1dSJustin T. Gibbs 		/* Initialized successfully */
3098b8a9b1dSJustin T. Gibbs 		break;
3108b8a9b1dSJustin T. Gibbs 	case 3:
31122c7d606SAlexander Motin 		CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph destroyed\n"));
312a29779e8SAlexander Motin 		xpt_remove_periph(periph);
3137379c88fSPoul-Henning Kamp 		/* FALLTHROUGH */
3148b8a9b1dSJustin T. Gibbs 	case 2:
315f1e2546aSMatt Jacob 		xpt_lock_buses();
316f1e2546aSMatt Jacob 		TAILQ_REMOVE(&(*p_drv)->units, periph, unit_links);
317f1e2546aSMatt Jacob 		xpt_unlock_buses();
3188b8a9b1dSJustin T. Gibbs 		xpt_free_path(periph->path);
3197379c88fSPoul-Henning Kamp 		/* FALLTHROUGH */
3208b8a9b1dSJustin T. Gibbs 	case 1:
321362abc44STai-hwa Liang 		free(periph, M_CAMPERIPH);
3227379c88fSPoul-Henning Kamp 		/* FALLTHROUGH */
3238b8a9b1dSJustin T. Gibbs 	case 0:
3248b8a9b1dSJustin T. Gibbs 		/* No cleanup to perform. */
3258b8a9b1dSJustin T. Gibbs 		break;
3268b8a9b1dSJustin T. Gibbs 	default:
327905cb85dSKenneth D. Merry 		panic("%s: Unknown init level", __func__);
3288b8a9b1dSJustin T. Gibbs 	}
3298b8a9b1dSJustin T. Gibbs 	return(status);
3308b8a9b1dSJustin T. Gibbs }
3318b8a9b1dSJustin T. Gibbs 
3328b8a9b1dSJustin T. Gibbs /*
3338b8a9b1dSJustin T. Gibbs  * Find a peripheral structure with the specified path, target, lun,
3348b8a9b1dSJustin T. Gibbs  * and (optionally) type.  If the name is NULL, this function will return
3358b8a9b1dSJustin T. Gibbs  * the first peripheral driver that matches the specified path.
3368b8a9b1dSJustin T. Gibbs  */
3378b8a9b1dSJustin T. Gibbs struct cam_periph *
3388b8a9b1dSJustin T. Gibbs cam_periph_find(struct cam_path *path, char *name)
3398b8a9b1dSJustin T. Gibbs {
3408b8a9b1dSJustin T. Gibbs 	struct periph_driver **p_drv;
3418b8a9b1dSJustin T. Gibbs 	struct cam_periph *periph;
3428b8a9b1dSJustin T. Gibbs 
34377dc25ccSScott Long 	xpt_lock_buses();
3440b7c27b9SPeter Wemm 	for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
3458b8a9b1dSJustin T. Gibbs 
3468b8a9b1dSJustin T. Gibbs 		if (name != NULL && (strcmp((*p_drv)->driver_name, name) != 0))
3478b8a9b1dSJustin T. Gibbs 			continue;
3488b8a9b1dSJustin T. Gibbs 
34937d40066SPoul-Henning Kamp 		TAILQ_FOREACH(periph, &(*p_drv)->units, unit_links) {
3508b8a9b1dSJustin T. Gibbs 			if (xpt_path_comp(periph->path, path) == 0) {
35177dc25ccSScott Long 				xpt_unlock_buses();
352227d67aaSAlexander Motin 				cam_periph_assert(periph, MA_OWNED);
3538b8a9b1dSJustin T. Gibbs 				return(periph);
3548b8a9b1dSJustin T. Gibbs 			}
3558b8a9b1dSJustin T. Gibbs 		}
35677dc25ccSScott Long 		if (name != NULL) {
35777dc25ccSScott Long 			xpt_unlock_buses();
3588b8a9b1dSJustin T. Gibbs 			return(NULL);
3598b8a9b1dSJustin T. Gibbs 		}
36077dc25ccSScott Long 	}
36177dc25ccSScott Long 	xpt_unlock_buses();
3628b8a9b1dSJustin T. Gibbs 	return(NULL);
3638b8a9b1dSJustin T. Gibbs }
3648b8a9b1dSJustin T. Gibbs 
3653501942bSJustin T. Gibbs /*
3668900f4b8SKenneth D. Merry  * Find peripheral driver instances attached to the specified path.
3673501942bSJustin T. Gibbs  */
3683501942bSJustin T. Gibbs int
3693501942bSJustin T. Gibbs cam_periph_list(struct cam_path *path, struct sbuf *sb)
3703501942bSJustin T. Gibbs {
3718900f4b8SKenneth D. Merry 	struct sbuf local_sb;
3723501942bSJustin T. Gibbs 	struct periph_driver **p_drv;
3733501942bSJustin T. Gibbs 	struct cam_periph *periph;
3743501942bSJustin T. Gibbs 	int count;
3758900f4b8SKenneth D. Merry 	int sbuf_alloc_len;
3763501942bSJustin T. Gibbs 
3778900f4b8SKenneth D. Merry 	sbuf_alloc_len = 16;
3788900f4b8SKenneth D. Merry retry:
3798900f4b8SKenneth D. Merry 	sbuf_new(&local_sb, NULL, sbuf_alloc_len, SBUF_FIXEDLEN);
3803501942bSJustin T. Gibbs 	count = 0;
3813501942bSJustin T. Gibbs 	xpt_lock_buses();
3823501942bSJustin T. Gibbs 	for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
3833501942bSJustin T. Gibbs 
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 
5338b8a9b1dSJustin T. Gibbs /*
5348b8a9b1dSJustin T. Gibbs  * Look for the next unit number that is not currently in use for this
5358b8a9b1dSJustin T. Gibbs  * peripheral type starting at "newunit".  Also exclude unit numbers that
5368b8a9b1dSJustin T. Gibbs  * are reserved by for future "hardwiring" unless we already know that this
5378b8a9b1dSJustin T. Gibbs  * is a potential wired device.  Only assume that the device is "wired" the
5388b8a9b1dSJustin T. Gibbs  * first time through the loop since after that we'll be looking at unit
5398b8a9b1dSJustin T. Gibbs  * numbers that did not match a wiring entry.
5408b8a9b1dSJustin T. Gibbs  */
5418b8a9b1dSJustin T. Gibbs static u_int
542501468a5SKenneth D. Merry camperiphnextunit(struct periph_driver *p_drv, u_int newunit, int wired,
543501468a5SKenneth D. Merry 		  path_id_t pathid, target_id_t target, lun_id_t lun)
5448b8a9b1dSJustin T. Gibbs {
5458b8a9b1dSJustin T. Gibbs 	struct	cam_periph *periph;
5462398f0cdSPeter Wemm 	char	*periph_name;
5472398f0cdSPeter Wemm 	int	i, val, dunit, r;
5482398f0cdSPeter Wemm 	const char *dname, *strval;
5498b8a9b1dSJustin T. Gibbs 
5508b8a9b1dSJustin T. Gibbs 	periph_name = p_drv->driver_name;
5518b8a9b1dSJustin T. Gibbs 	for (;;newunit++) {
5528b8a9b1dSJustin T. Gibbs 
5538b8a9b1dSJustin T. Gibbs 		for (periph = TAILQ_FIRST(&p_drv->units);
5548b8a9b1dSJustin T. Gibbs 		     periph != NULL && periph->unit_number != newunit;
5558b8a9b1dSJustin T. Gibbs 		     periph = TAILQ_NEXT(periph, unit_links))
5568b8a9b1dSJustin T. Gibbs 			;
5578b8a9b1dSJustin T. Gibbs 
5588b8a9b1dSJustin T. Gibbs 		if (periph != NULL && periph->unit_number == newunit) {
5598b8a9b1dSJustin T. Gibbs 			if (wired != 0) {
560f0d9af51SMatt Jacob 				xpt_print(periph->path, "Duplicate Wired "
561f0d9af51SMatt Jacob 				    "Device entry!\n");
562f0d9af51SMatt Jacob 				xpt_print(periph->path, "Second device (%s "
563f0d9af51SMatt Jacob 				    "device at scbus%d target %d lun %d) will "
564f0d9af51SMatt Jacob 				    "not be wired\n", periph_name, pathid,
565f0d9af51SMatt Jacob 				    target, lun);
5668b8a9b1dSJustin T. Gibbs 				wired = 0;
5678b8a9b1dSJustin T. Gibbs 			}
5688b8a9b1dSJustin T. Gibbs 			continue;
5698b8a9b1dSJustin T. Gibbs 		}
57075f51904SPeter Wemm 		if (wired)
57175f51904SPeter Wemm 			break;
5728b8a9b1dSJustin T. Gibbs 
5738b8a9b1dSJustin T. Gibbs 		/*
5748b8a9b1dSJustin T. Gibbs 		 * Don't match entries like "da 4" as a wired down
5758b8a9b1dSJustin T. Gibbs 		 * device, but do match entries like "da 4 target 5"
5768b8a9b1dSJustin T. Gibbs 		 * or even "da 4 scbus 1".
5778b8a9b1dSJustin T. Gibbs 		 */
5782398f0cdSPeter Wemm 		i = 0;
5792398f0cdSPeter Wemm 		dname = periph_name;
5802398f0cdSPeter Wemm 		for (;;) {
5812398f0cdSPeter Wemm 			r = resource_find_dev(&i, dname, &dunit, NULL, NULL);
5822398f0cdSPeter Wemm 			if (r != 0)
5832398f0cdSPeter Wemm 				break;
58475f51904SPeter Wemm 			/* if no "target" and no specific scbus, skip */
58575f51904SPeter Wemm 			if (resource_int_value(dname, dunit, "target", &val) &&
58675f51904SPeter Wemm 			    (resource_string_value(dname, dunit, "at",&strval)||
58775f51904SPeter Wemm 			     strcmp(strval, "scbus") == 0))
58875f51904SPeter Wemm 				continue;
58975f51904SPeter Wemm 			if (newunit == dunit)
5908b8a9b1dSJustin T. Gibbs 				break;
5918b8a9b1dSJustin T. Gibbs 		}
5922398f0cdSPeter Wemm 		if (r != 0)
5938b8a9b1dSJustin T. Gibbs 			break;
5948b8a9b1dSJustin T. Gibbs 	}
5958b8a9b1dSJustin T. Gibbs 	return (newunit);
5968b8a9b1dSJustin T. Gibbs }
5978b8a9b1dSJustin T. Gibbs 
5988b8a9b1dSJustin T. Gibbs static u_int
5998b8a9b1dSJustin T. Gibbs camperiphunit(struct periph_driver *p_drv, path_id_t pathid,
6008b8a9b1dSJustin T. Gibbs 	      target_id_t target, lun_id_t lun)
6018b8a9b1dSJustin T. Gibbs {
6028b8a9b1dSJustin T. Gibbs 	u_int	unit;
603c1b81613SPeter Wemm 	int	wired, i, val, dunit;
6042398f0cdSPeter Wemm 	const char *dname, *strval;
6052398f0cdSPeter Wemm 	char	pathbuf[32], *periph_name;
6068b8a9b1dSJustin T. Gibbs 
60775f51904SPeter Wemm 	periph_name = p_drv->driver_name;
60875f51904SPeter Wemm 	snprintf(pathbuf, sizeof(pathbuf), "scbus%d", pathid);
609c1b81613SPeter Wemm 	unit = 0;
6102398f0cdSPeter Wemm 	i = 0;
6112398f0cdSPeter Wemm 	dname = periph_name;
612c1b81613SPeter Wemm 	for (wired = 0; resource_find_dev(&i, dname, &dunit, NULL, NULL) == 0;
613c1b81613SPeter Wemm 	     wired = 0) {
61475f51904SPeter Wemm 		if (resource_string_value(dname, dunit, "at", &strval) == 0) {
61575f51904SPeter Wemm 			if (strcmp(strval, pathbuf) != 0)
6168b8a9b1dSJustin T. Gibbs 				continue;
617c1b81613SPeter Wemm 			wired++;
6188b8a9b1dSJustin T. Gibbs 		}
61975f51904SPeter Wemm 		if (resource_int_value(dname, dunit, "target", &val) == 0) {
62075f51904SPeter Wemm 			if (val != target)
6218b8a9b1dSJustin T. Gibbs 				continue;
622c1b81613SPeter Wemm 			wired++;
6238b8a9b1dSJustin T. Gibbs 		}
62475f51904SPeter Wemm 		if (resource_int_value(dname, dunit, "lun", &val) == 0) {
62575f51904SPeter Wemm 			if (val != lun)
6268b8a9b1dSJustin T. Gibbs 				continue;
627c1b81613SPeter Wemm 			wired++;
6288b8a9b1dSJustin T. Gibbs 		}
629c1b81613SPeter Wemm 		if (wired != 0) {
63075f51904SPeter Wemm 			unit = dunit;
6318b8a9b1dSJustin T. Gibbs 			break;
6328b8a9b1dSJustin T. Gibbs 		}
6338b8a9b1dSJustin T. Gibbs 	}
6348b8a9b1dSJustin T. Gibbs 
6358b8a9b1dSJustin T. Gibbs 	/*
6368b8a9b1dSJustin T. Gibbs 	 * Either start from 0 looking for the next unit or from
63775f51904SPeter Wemm 	 * the unit number given in the resource config.  This way,
6388b8a9b1dSJustin T. Gibbs 	 * if we have wildcard matches, we don't return the same
6398b8a9b1dSJustin T. Gibbs 	 * unit number twice.
6408b8a9b1dSJustin T. Gibbs 	 */
641c1b81613SPeter Wemm 	unit = camperiphnextunit(p_drv, unit, wired, pathid, target, lun);
6428b8a9b1dSJustin T. Gibbs 
6438b8a9b1dSJustin T. Gibbs 	return (unit);
6448b8a9b1dSJustin T. Gibbs }
6458b8a9b1dSJustin T. Gibbs 
6468b8a9b1dSJustin T. Gibbs void
6478b8a9b1dSJustin T. Gibbs cam_periph_invalidate(struct cam_periph *periph)
6488b8a9b1dSJustin T. Gibbs {
6498b8a9b1dSJustin T. Gibbs 
650227d67aaSAlexander Motin 	cam_periph_assert(periph, MA_OWNED);
651ee9c90c7SKenneth D. Merry 	/*
6526fda2c54SWarner Losh 	 * We only tear down the device the first time a peripheral is
65377dc25ccSScott Long 	 * invalidated.
654ee9c90c7SKenneth D. Merry 	 */
655d38c0e53SAlexander Motin 	if ((periph->flags & CAM_PERIPH_INVALID) != 0)
656d38c0e53SAlexander Motin 		return;
657ee9c90c7SKenneth D. Merry 
658d38c0e53SAlexander Motin 	CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph invalidated\n"));
6595d01277fSScott Long 	if ((periph->flags & CAM_PERIPH_ANNOUNCED) && !rebooting) {
6605d01277fSScott Long 		struct sbuf sb;
661da0d7209SScott Long 		char buffer[160];
6625d01277fSScott Long 
663da0d7209SScott Long 		sbuf_new(&sb, buffer, 160, SBUF_FIXEDLEN);
6645d01277fSScott Long 		xpt_denounce_periph_sbuf(periph, &sb);
6655d01277fSScott Long 		sbuf_finish(&sb);
6665d01277fSScott Long 		sbuf_putbuf(&sb);
6675d01277fSScott Long 	}
6688b8a9b1dSJustin T. Gibbs 	periph->flags |= CAM_PERIPH_INVALID;
6698b8a9b1dSJustin T. Gibbs 	periph->flags &= ~CAM_PERIPH_NEW_DEV_FOUND;
670d38c0e53SAlexander Motin 	if (periph->periph_oninval != NULL)
671d38c0e53SAlexander Motin 		periph->periph_oninval(periph);
672d38c0e53SAlexander Motin 	cam_periph_release_locked(periph);
6738b8a9b1dSJustin T. Gibbs }
6748b8a9b1dSJustin T. Gibbs 
6758b8a9b1dSJustin T. Gibbs static void
6768b8a9b1dSJustin T. Gibbs camperiphfree(struct cam_periph *periph)
6778b8a9b1dSJustin T. Gibbs {
6788b8a9b1dSJustin T. Gibbs 	struct periph_driver **p_drv;
67959fe7664SKenneth D. Merry 	struct periph_driver *drv;
6808b8a9b1dSJustin T. Gibbs 
681227d67aaSAlexander Motin 	cam_periph_assert(periph, MA_OWNED);
682227d67aaSAlexander Motin 	KASSERT(periph->periph_allocating == 0, ("%s%d: freed while allocating",
683227d67aaSAlexander Motin 	    periph->periph_name, periph->unit_number));
6840b7c27b9SPeter Wemm 	for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
6858b8a9b1dSJustin T. Gibbs 		if (strcmp((*p_drv)->driver_name, periph->periph_name) == 0)
6868b8a9b1dSJustin T. Gibbs 			break;
6878b8a9b1dSJustin T. Gibbs 	}
688661658a6SScott Long 	if (*p_drv == NULL) {
689661658a6SScott Long 		printf("camperiphfree: attempt to free non-existant periph\n");
690661658a6SScott Long 		return;
691661658a6SScott Long 	}
69259fe7664SKenneth D. Merry 	/*
69359fe7664SKenneth D. Merry 	 * Cache a pointer to the periph_driver structure.  If a
69459fe7664SKenneth D. Merry 	 * periph_driver is added or removed from the array (see
69559fe7664SKenneth D. Merry 	 * periphdriver_register()) while we drop the toplogy lock
69659fe7664SKenneth D. Merry 	 * below, p_drv may change.  This doesn't protect against this
69759fe7664SKenneth D. Merry 	 * particular periph_driver going away.  That will require full
69859fe7664SKenneth D. Merry 	 * reference counting in the periph_driver infrastructure.
69959fe7664SKenneth D. Merry 	 */
70059fe7664SKenneth D. Merry 	drv = *p_drv;
7018b8a9b1dSJustin T. Gibbs 
702ea37f519SKenneth D. Merry 	/*
70333a38f74SKenneth D. Merry 	 * We need to set this flag before dropping the topology lock, to
70433a38f74SKenneth D. Merry 	 * let anyone who is traversing the list that this peripheral is
70533a38f74SKenneth D. Merry 	 * about to be freed, and there will be no more reference count
70633a38f74SKenneth D. Merry 	 * checks.
70733a38f74SKenneth D. Merry 	 */
70833a38f74SKenneth D. Merry 	periph->flags |= CAM_PERIPH_FREE;
70933a38f74SKenneth D. Merry 
71033a38f74SKenneth D. Merry 	/*
711ea37f519SKenneth D. Merry 	 * The peripheral destructor semantics dictate calling with only the
712ea37f519SKenneth D. Merry 	 * SIM mutex held.  Since it might sleep, it should not be called
713ea37f519SKenneth D. Merry 	 * with the topology lock held.
714ea37f519SKenneth D. Merry 	 */
715f3548746SScott Long 	xpt_unlock_buses();
7168b8a9b1dSJustin T. Gibbs 
717ea37f519SKenneth D. Merry 	/*
718ea37f519SKenneth D. Merry 	 * We need to call the peripheral destructor prior to removing the
719ea37f519SKenneth D. Merry 	 * peripheral from the list.  Otherwise, we risk running into a
720ea37f519SKenneth D. Merry 	 * scenario where the peripheral unit number may get reused
721ea37f519SKenneth D. Merry 	 * (because it has been removed from the list), but some resources
722ea37f519SKenneth D. Merry 	 * used by the peripheral are still hanging around.  In particular,
723ea37f519SKenneth D. Merry 	 * the devfs nodes used by some peripherals like the pass(4) driver
724ea37f519SKenneth D. Merry 	 * aren't fully cleaned up until the destructor is run.  If the
725ea37f519SKenneth D. Merry 	 * unit number is reused before the devfs instance is fully gone,
726ea37f519SKenneth D. Merry 	 * devfs will panic.
727ea37f519SKenneth D. Merry 	 */
728f3548746SScott Long 	if (periph->periph_dtor != NULL)
729f3548746SScott Long 		periph->periph_dtor(periph);
730ea37f519SKenneth D. Merry 
731ea37f519SKenneth D. Merry 	/*
732*81490edaSWarner Losh 	 * The peripheral list is protected by the topology lock. We have to
733*81490edaSWarner Losh 	 * remove the periph from the drv list before we call deferred_ac. The
734*81490edaSWarner Losh 	 * AC_FOUND_DEVICE callback won't create a new periph if it's still there.
735ea37f519SKenneth D. Merry 	 */
736ea37f519SKenneth D. Merry 	xpt_lock_buses();
737ea37f519SKenneth D. Merry 
73859fe7664SKenneth D. Merry 	TAILQ_REMOVE(&drv->units, periph, unit_links);
73959fe7664SKenneth D. Merry 	drv->generation++;
740ea37f519SKenneth D. Merry 
741a29779e8SAlexander Motin 	xpt_remove_periph(periph);
742ea37f519SKenneth D. Merry 
743ea37f519SKenneth D. Merry 	xpt_unlock_buses();
744de6a705eSMarius Strobl 	if ((periph->flags & CAM_PERIPH_ANNOUNCED) && !rebooting)
7458d36a71bSAlexander Motin 		xpt_print(periph->path, "Periph destroyed\n");
746de6a705eSMarius Strobl 	else
74722c7d606SAlexander Motin 		CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph destroyed\n"));
7488b8a9b1dSJustin T. Gibbs 
7498b8a9b1dSJustin T. Gibbs 	if (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) {
7508b8a9b1dSJustin T. Gibbs 		union ccb ccb;
7518b8a9b1dSJustin T. Gibbs 		void *arg;
7528b8a9b1dSJustin T. Gibbs 
7538b8a9b1dSJustin T. Gibbs 		switch (periph->deferred_ac) {
7548b8a9b1dSJustin T. Gibbs 		case AC_FOUND_DEVICE:
7558b8a9b1dSJustin T. Gibbs 			ccb.ccb_h.func_code = XPT_GDEV_TYPE;
756bbfa4aa1SAlexander Motin 			xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
7578b8a9b1dSJustin T. Gibbs 			xpt_action(&ccb);
7588b8a9b1dSJustin T. Gibbs 			arg = &ccb;
7598b8a9b1dSJustin T. Gibbs 			break;
7608b8a9b1dSJustin T. Gibbs 		case AC_PATH_REGISTERED:
761762a7f4fSWarner Losh 			xpt_path_inq(&ccb.cpi, periph->path);
7628b8a9b1dSJustin T. Gibbs 			arg = &ccb;
7638b8a9b1dSJustin T. Gibbs 			break;
7648b8a9b1dSJustin T. Gibbs 		default:
7658b8a9b1dSJustin T. Gibbs 			arg = NULL;
7668b8a9b1dSJustin T. Gibbs 			break;
7678b8a9b1dSJustin T. Gibbs 		}
7688b8a9b1dSJustin T. Gibbs 		periph->deferred_callback(NULL, periph->deferred_ac,
7698b8a9b1dSJustin T. Gibbs 					  periph->path, arg);
7708b8a9b1dSJustin T. Gibbs 	}
7718b8a9b1dSJustin T. Gibbs 	xpt_free_path(periph->path);
772362abc44STai-hwa Liang 	free(periph, M_CAMPERIPH);
773f3548746SScott Long 	xpt_lock_buses();
7748b8a9b1dSJustin T. Gibbs }
7758b8a9b1dSJustin T. Gibbs 
7768b8a9b1dSJustin T. Gibbs /*
7778b8a9b1dSJustin T. Gibbs  * Map user virtual pointers into kernel virtual address space, so we can
77895fbded6SScott Long  * access the memory.  This is now a generic function that centralizes most
77995fbded6SScott Long  * of the sanity checks on the data flags, if any.
78095fbded6SScott Long  * This also only works for up to MAXPHYS memory.  Since we use
7818b8a9b1dSJustin T. Gibbs  * buffers to map stuff in and out, we're limited to the buffer size.
7828b8a9b1dSJustin T. Gibbs  */
7838b8a9b1dSJustin T. Gibbs int
784de239312SAlexander Motin cam_periph_mapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo,
785de239312SAlexander Motin     u_int maxmap)
7868b8a9b1dSJustin T. Gibbs {
787b059686aSAlexander Motin 	int numbufs, i;
7888b8a9b1dSJustin T. Gibbs 	u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
7898b8a9b1dSJustin T. Gibbs 	u_int32_t lengths[CAM_PERIPH_MAXMAPS];
7908b8a9b1dSJustin T. Gibbs 	u_int32_t dirs[CAM_PERIPH_MAXMAPS];
791c389a786SAlexander Motin 	bool misaligned[CAM_PERIPH_MAXMAPS];
7928b8a9b1dSJustin T. Gibbs 
793b059686aSAlexander Motin 	bzero(mapinfo, sizeof(*mapinfo));
794de239312SAlexander Motin 	if (maxmap == 0)
795de239312SAlexander Motin 		maxmap = DFLTPHYS;	/* traditional default */
796de239312SAlexander Motin 	else if (maxmap > MAXPHYS)
797de239312SAlexander Motin 		maxmap = MAXPHYS;	/* for safety */
7988b8a9b1dSJustin T. Gibbs 	switch(ccb->ccb_h.func_code) {
7998b8a9b1dSJustin T. Gibbs 	case XPT_DEV_MATCH:
8008b8a9b1dSJustin T. Gibbs 		if (ccb->cdm.match_buf_len == 0) {
8018b8a9b1dSJustin T. Gibbs 			printf("cam_periph_mapmem: invalid match buffer "
8028b8a9b1dSJustin T. Gibbs 			       "length 0\n");
8038b8a9b1dSJustin T. Gibbs 			return(EINVAL);
8048b8a9b1dSJustin T. Gibbs 		}
8058b8a9b1dSJustin T. Gibbs 		if (ccb->cdm.pattern_buf_len > 0) {
8068b8a9b1dSJustin T. Gibbs 			data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
8078b8a9b1dSJustin T. Gibbs 			lengths[0] = ccb->cdm.pattern_buf_len;
8088b8a9b1dSJustin T. Gibbs 			dirs[0] = CAM_DIR_OUT;
8098b8a9b1dSJustin T. Gibbs 			data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
8108b8a9b1dSJustin T. Gibbs 			lengths[1] = ccb->cdm.match_buf_len;
8118b8a9b1dSJustin T. Gibbs 			dirs[1] = CAM_DIR_IN;
8128b8a9b1dSJustin T. Gibbs 			numbufs = 2;
8138b8a9b1dSJustin T. Gibbs 		} else {
8148b8a9b1dSJustin T. Gibbs 			data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
8158b8a9b1dSJustin T. Gibbs 			lengths[0] = ccb->cdm.match_buf_len;
8168b8a9b1dSJustin T. Gibbs 			dirs[0] = CAM_DIR_IN;
8178b8a9b1dSJustin T. Gibbs 			numbufs = 1;
8188b8a9b1dSJustin T. Gibbs 		}
81952c9ce25SScott Long 		/*
82052c9ce25SScott Long 		 * This request will not go to the hardware, no reason
82152c9ce25SScott Long 		 * to be so strict. vmapbuf() is able to map up to MAXPHYS.
82252c9ce25SScott Long 		 */
82352c9ce25SScott Long 		maxmap = MAXPHYS;
8248b8a9b1dSJustin T. Gibbs 		break;
8258b8a9b1dSJustin T. Gibbs 	case XPT_SCSI_IO:
82687cfaf0eSJustin T. Gibbs 	case XPT_CONT_TARGET_IO:
8278b8a9b1dSJustin T. Gibbs 		if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
8288b8a9b1dSJustin T. Gibbs 			return(0);
82995fbded6SScott Long 		if ((ccb->ccb_h.flags & CAM_DATA_MASK) != CAM_DATA_VADDR)
83095fbded6SScott Long 			return (EINVAL);
8318b8a9b1dSJustin T. Gibbs 		data_ptrs[0] = &ccb->csio.data_ptr;
83279d49a06SKenneth D. Merry 		lengths[0] = ccb->csio.dxfer_len;
8338b8a9b1dSJustin T. Gibbs 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
8348b8a9b1dSJustin T. Gibbs 		numbufs = 1;
8358b8a9b1dSJustin T. Gibbs 		break;
83652c9ce25SScott Long 	case XPT_ATA_IO:
83752c9ce25SScott Long 		if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
83852c9ce25SScott Long 			return(0);
83995fbded6SScott Long 		if ((ccb->ccb_h.flags & CAM_DATA_MASK) != CAM_DATA_VADDR)
84095fbded6SScott Long 			return (EINVAL);
84152c9ce25SScott Long 		data_ptrs[0] = &ccb->ataio.data_ptr;
84252c9ce25SScott Long 		lengths[0] = ccb->ataio.dxfer_len;
84352c9ce25SScott Long 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
84452c9ce25SScott Long 		numbufs = 1;
84552c9ce25SScott Long 		break;
846a94a63f0SWarner Losh 	case XPT_MMC_IO:
847a94a63f0SWarner Losh 		if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
848a94a63f0SWarner Losh 			return(0);
849a94a63f0SWarner Losh 		/* Two mappings: one for cmd->data and one for cmd->data->data */
850a94a63f0SWarner Losh 		data_ptrs[0] = (unsigned char **)&ccb->mmcio.cmd.data;
851a94a63f0SWarner Losh 		lengths[0] = sizeof(struct mmc_data *);
852a94a63f0SWarner Losh 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
853a94a63f0SWarner Losh 		data_ptrs[1] = (unsigned char **)&ccb->mmcio.cmd.data->data;
854a94a63f0SWarner Losh 		lengths[1] = ccb->mmcio.cmd.data->len;
855a94a63f0SWarner Losh 		dirs[1] = ccb->ccb_h.flags & CAM_DIR_MASK;
856a94a63f0SWarner Losh 		numbufs = 2;
857a94a63f0SWarner Losh 		break;
85806e79492SKenneth D. Merry 	case XPT_SMP_IO:
85906e79492SKenneth D. Merry 		data_ptrs[0] = &ccb->smpio.smp_request;
86006e79492SKenneth D. Merry 		lengths[0] = ccb->smpio.smp_request_len;
86106e79492SKenneth D. Merry 		dirs[0] = CAM_DIR_OUT;
86206e79492SKenneth D. Merry 		data_ptrs[1] = &ccb->smpio.smp_response;
86306e79492SKenneth D. Merry 		lengths[1] = ccb->smpio.smp_response_len;
86406e79492SKenneth D. Merry 		dirs[1] = CAM_DIR_IN;
86506e79492SKenneth D. Merry 		numbufs = 2;
86606e79492SKenneth D. Merry 		break;
867df424515SWarner Losh 	case XPT_NVME_IO:
868df424515SWarner Losh 	case XPT_NVME_ADMIN:
869df424515SWarner Losh 		if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
870df424515SWarner Losh 			return (0);
871df424515SWarner Losh 		if ((ccb->ccb_h.flags & CAM_DATA_MASK) != CAM_DATA_VADDR)
872df424515SWarner Losh 			return (EINVAL);
873df424515SWarner Losh 		data_ptrs[0] = &ccb->nvmeio.data_ptr;
874df424515SWarner Losh 		lengths[0] = ccb->nvmeio.dxfer_len;
875df424515SWarner Losh 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
876df424515SWarner Losh 		numbufs = 1;
877df424515SWarner Losh 		break;
8783501942bSJustin T. Gibbs 	case XPT_DEV_ADVINFO:
8793501942bSJustin T. Gibbs 		if (ccb->cdai.bufsiz == 0)
8807c103ddeSKenneth D. Merry 			return (0);
8817c103ddeSKenneth D. Merry 
8823501942bSJustin T. Gibbs 		data_ptrs[0] = (uint8_t **)&ccb->cdai.buf;
8833501942bSJustin T. Gibbs 		lengths[0] = ccb->cdai.bufsiz;
88406e79492SKenneth D. Merry 		dirs[0] = CAM_DIR_IN;
88506e79492SKenneth D. Merry 		numbufs = 1;
8867c103ddeSKenneth D. Merry 
8877c103ddeSKenneth D. Merry 		/*
8887c103ddeSKenneth D. Merry 		 * This request will not go to the hardware, no reason
8897c103ddeSKenneth D. Merry 		 * to be so strict. vmapbuf() is able to map up to MAXPHYS.
8907c103ddeSKenneth D. Merry 		 */
8917c103ddeSKenneth D. Merry 		maxmap = MAXPHYS;
89206e79492SKenneth D. Merry 		break;
8938b8a9b1dSJustin T. Gibbs 	default:
8948b8a9b1dSJustin T. Gibbs 		return(EINVAL);
8958b8a9b1dSJustin T. Gibbs 		break; /* NOTREACHED */
8968b8a9b1dSJustin T. Gibbs 	}
8978b8a9b1dSJustin T. Gibbs 
8988b8a9b1dSJustin T. Gibbs 	/*
89979d49a06SKenneth D. Merry 	 * Check the transfer length and permissions first, so we don't
90079d49a06SKenneth D. Merry 	 * have to unmap any previously mapped buffers.
9018b8a9b1dSJustin T. Gibbs 	 */
9028b8a9b1dSJustin T. Gibbs 	for (i = 0; i < numbufs; i++) {
903c389a786SAlexander Motin 		if (lengths[i] > maxmap) {
904c389a786SAlexander Motin 			printf("cam_periph_mapmem: attempt to map %lu bytes, "
905c389a786SAlexander Motin 			       "which is greater than %lu\n",
906c389a786SAlexander Motin 			       (long)(lengths[i]), (u_long)maxmap);
907c389a786SAlexander Motin 			return (E2BIG);
908c389a786SAlexander Motin 		}
90979d49a06SKenneth D. Merry 
91079d49a06SKenneth D. Merry 		/*
91179d49a06SKenneth D. Merry 		 * The userland data pointer passed in may not be page
91279d49a06SKenneth D. Merry 		 * aligned.  vmapbuf() truncates the address to a page
91379d49a06SKenneth D. Merry 		 * boundary, so if the address isn't page aligned, we'll
91479d49a06SKenneth D. Merry 		 * need enough space for the given transfer length, plus
91579d49a06SKenneth D. Merry 		 * whatever extra space is necessary to make it to the page
91679d49a06SKenneth D. Merry 		 * boundary.
91779d49a06SKenneth D. Merry 		 */
918c389a786SAlexander Motin 		misaligned[i] = (lengths[i] +
919c389a786SAlexander Motin 		    (((vm_offset_t)(*data_ptrs[i])) & PAGE_MASK) > MAXPHYS);
92079d49a06SKenneth D. Merry 	}
92179d49a06SKenneth D. Merry 
92279d49a06SKenneth D. Merry 	/*
923cef367e6SEitan Adler 	 * This keeps the kernel stack of current thread from getting
92495fbded6SScott Long 	 * swapped.  In low-memory situations where the kernel stack might
92595fbded6SScott Long 	 * otherwise get swapped out, this holds it and allows the thread
92695fbded6SScott Long 	 * to make progress and release the kernel mapped pages sooner.
92795fbded6SScott Long 	 *
92879d49a06SKenneth D. Merry 	 * XXX KDM should I use P_NOSWAP instead?
92979d49a06SKenneth D. Merry 	 */
9300cbbb7bfSPeter Wemm 	PHOLD(curproc);
93179d49a06SKenneth D. Merry 
93279d49a06SKenneth D. Merry 	for (i = 0; i < numbufs; i++) {
933b059686aSAlexander Motin 
934b059686aSAlexander Motin 		/* Save the user's data address. */
935b059686aSAlexander Motin 		mapinfo->orig[i] = *data_ptrs[i];
936b059686aSAlexander Motin 
937b059686aSAlexander Motin 		/*
938b059686aSAlexander Motin 		 * For small buffers use malloc+copyin/copyout instead of
939b059686aSAlexander Motin 		 * mapping to KVA to avoid expensive TLB shootdowns.  For
940b059686aSAlexander Motin 		 * small allocations malloc is backed by UMA, and so much
941b059686aSAlexander Motin 		 * cheaper on SMP systems.
942b059686aSAlexander Motin 		 */
943c389a786SAlexander Motin 		if ((lengths[i] <= periph_mapmem_thresh || misaligned[i]) &&
944b059686aSAlexander Motin 		    ccb->ccb_h.func_code != XPT_MMC_IO) {
945b059686aSAlexander Motin 			*data_ptrs[i] = malloc(lengths[i], M_CAMPERIPH,
946b059686aSAlexander Motin 			    M_WAITOK);
947b059686aSAlexander Motin 			if (dirs[i] != CAM_DIR_IN) {
948b059686aSAlexander Motin 				if (copyin(mapinfo->orig[i], *data_ptrs[i],
949b059686aSAlexander Motin 				    lengths[i]) != 0) {
950b059686aSAlexander Motin 					free(*data_ptrs[i], M_CAMPERIPH);
951b059686aSAlexander Motin 					*data_ptrs[i] = mapinfo->orig[i];
952b059686aSAlexander Motin 					goto fail;
953b059686aSAlexander Motin 				}
954b059686aSAlexander Motin 			} else
955b059686aSAlexander Motin 				bzero(*data_ptrs[i], lengths[i]);
956b059686aSAlexander Motin 			continue;
957b059686aSAlexander Motin 		}
958b059686aSAlexander Motin 
9598b8a9b1dSJustin T. Gibbs 		/*
9608b8a9b1dSJustin T. Gibbs 		 * Get the buffer.
9618b8a9b1dSJustin T. Gibbs 		 */
962756a5412SGleb Smirnoff 		mapinfo->bp[i] = uma_zalloc(pbuf_zone, M_WAITOK);
9638b8a9b1dSJustin T. Gibbs 
9648b8a9b1dSJustin T. Gibbs 		/* put our pointer in the data slot */
9658b8a9b1dSJustin T. Gibbs 		mapinfo->bp[i]->b_data = *data_ptrs[i];
9668b8a9b1dSJustin T. Gibbs 
96752c9ce25SScott Long 		/* set the transfer length, we know it's < MAXPHYS */
9688b8a9b1dSJustin T. Gibbs 		mapinfo->bp[i]->b_bufsize = lengths[i];
9698b8a9b1dSJustin T. Gibbs 
97021144e3bSPoul-Henning Kamp 		/* set the direction */
971b059686aSAlexander Motin 		mapinfo->bp[i]->b_iocmd = (dirs[i] == CAM_DIR_OUT) ?
972b059686aSAlexander Motin 		    BIO_WRITE : BIO_READ;
9738b8a9b1dSJustin T. Gibbs 
9742d5c7e45SMatthew Dillon 		/*
9752d5c7e45SMatthew Dillon 		 * Map the buffer into kernel memory.
9762d5c7e45SMatthew Dillon 		 *
9772d5c7e45SMatthew Dillon 		 * Note that useracc() alone is not a  sufficient test.
9782d5c7e45SMatthew Dillon 		 * vmapbuf() can still fail due to a smaller file mapped
9792d5c7e45SMatthew Dillon 		 * into a larger area of VM, or if userland races against
9802d5c7e45SMatthew Dillon 		 * vmapbuf() after the useracc() check.
9812d5c7e45SMatthew Dillon 		 */
982e81ff91eSKonstantin Belousov 		if (vmapbuf(mapinfo->bp[i], 1) < 0) {
983756a5412SGleb Smirnoff 			uma_zfree(pbuf_zone, mapinfo->bp[i]);
984b059686aSAlexander Motin 			goto fail;
9852d5c7e45SMatthew Dillon 		}
9868b8a9b1dSJustin T. Gibbs 
9878b8a9b1dSJustin T. Gibbs 		/* set our pointer to the new mapped area */
9888b8a9b1dSJustin T. Gibbs 		*data_ptrs[i] = mapinfo->bp[i]->b_data;
9898b8a9b1dSJustin T. Gibbs 	}
9908b8a9b1dSJustin T. Gibbs 
991a62525f3SMatt Jacob 	/*
992a62525f3SMatt Jacob 	 * Now that we've gotten this far, change ownership to the kernel
993a62525f3SMatt Jacob 	 * of the buffers so that we don't run afoul of returning to user
994a62525f3SMatt Jacob 	 * space with locks (on the buffer) held.
995a62525f3SMatt Jacob 	 */
996a62525f3SMatt Jacob 	for (i = 0; i < numbufs; i++) {
997b059686aSAlexander Motin 		if (mapinfo->bp[i])
998a62525f3SMatt Jacob 			BUF_KERNPROC(mapinfo->bp[i]);
999a62525f3SMatt Jacob 	}
1000a62525f3SMatt Jacob 
1001b059686aSAlexander Motin 	mapinfo->num_bufs_used = numbufs;
10028b8a9b1dSJustin T. Gibbs 	return(0);
1003b059686aSAlexander Motin 
1004b059686aSAlexander Motin fail:
1005b059686aSAlexander Motin 	for (i--; i >= 0; i--) {
1006b059686aSAlexander Motin 		if (mapinfo->bp[i]) {
1007b059686aSAlexander Motin 			vunmapbuf(mapinfo->bp[i]);
1008b059686aSAlexander Motin 			uma_zfree(pbuf_zone, mapinfo->bp[i]);
1009b059686aSAlexander Motin 		} else
1010b059686aSAlexander Motin 			free(*data_ptrs[i], M_CAMPERIPH);
1011b059686aSAlexander Motin 		*data_ptrs[i] = mapinfo->orig[i];
1012b059686aSAlexander Motin 	}
1013b059686aSAlexander Motin 	PRELE(curproc);
1014b059686aSAlexander Motin 	return(EACCES);
10158b8a9b1dSJustin T. Gibbs }
10168b8a9b1dSJustin T. Gibbs 
10178b8a9b1dSJustin T. Gibbs /*
10188b8a9b1dSJustin T. Gibbs  * Unmap memory segments mapped into kernel virtual address space by
10198b8a9b1dSJustin T. Gibbs  * cam_periph_mapmem().
10208b8a9b1dSJustin T. Gibbs  */
10218b8a9b1dSJustin T. Gibbs void
10228b8a9b1dSJustin T. Gibbs cam_periph_unmapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo)
10238b8a9b1dSJustin T. Gibbs {
10248b8a9b1dSJustin T. Gibbs 	int numbufs, i;
10258b8a9b1dSJustin T. Gibbs 	u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
1026b059686aSAlexander Motin 	u_int32_t lengths[CAM_PERIPH_MAXMAPS];
1027b059686aSAlexander Motin 	u_int32_t dirs[CAM_PERIPH_MAXMAPS];
10288b8a9b1dSJustin T. Gibbs 
10298b8a9b1dSJustin T. Gibbs 	if (mapinfo->num_bufs_used <= 0) {
103095fbded6SScott Long 		/* nothing to free and the process wasn't held. */
10318b8a9b1dSJustin T. Gibbs 		return;
10328b8a9b1dSJustin T. Gibbs 	}
10338b8a9b1dSJustin T. Gibbs 
10348b8a9b1dSJustin T. Gibbs 	switch (ccb->ccb_h.func_code) {
10358b8a9b1dSJustin T. Gibbs 	case XPT_DEV_MATCH:
1036b059686aSAlexander Motin 		if (ccb->cdm.pattern_buf_len > 0) {
10378b8a9b1dSJustin T. Gibbs 			data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
1038b059686aSAlexander Motin 			lengths[0] = ccb->cdm.pattern_buf_len;
1039b059686aSAlexander Motin 			dirs[0] = CAM_DIR_OUT;
10408b8a9b1dSJustin T. Gibbs 			data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
1041b059686aSAlexander Motin 			lengths[1] = ccb->cdm.match_buf_len;
1042b059686aSAlexander Motin 			dirs[1] = CAM_DIR_IN;
1043b059686aSAlexander Motin 			numbufs = 2;
1044b059686aSAlexander Motin 		} else {
1045b059686aSAlexander Motin 			data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
1046b059686aSAlexander Motin 			lengths[0] = ccb->cdm.match_buf_len;
1047b059686aSAlexander Motin 			dirs[0] = CAM_DIR_IN;
1048b059686aSAlexander Motin 			numbufs = 1;
10498b8a9b1dSJustin T. Gibbs 		}
10508b8a9b1dSJustin T. Gibbs 		break;
10518b8a9b1dSJustin T. Gibbs 	case XPT_SCSI_IO:
10529911ecf9SJustin T. Gibbs 	case XPT_CONT_TARGET_IO:
10538b8a9b1dSJustin T. Gibbs 		data_ptrs[0] = &ccb->csio.data_ptr;
1054b059686aSAlexander Motin 		lengths[0] = ccb->csio.dxfer_len;
1055b059686aSAlexander Motin 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1056b059686aSAlexander Motin 		numbufs = 1;
10578b8a9b1dSJustin T. Gibbs 		break;
105852c9ce25SScott Long 	case XPT_ATA_IO:
105952c9ce25SScott Long 		data_ptrs[0] = &ccb->ataio.data_ptr;
1060b059686aSAlexander Motin 		lengths[0] = ccb->ataio.dxfer_len;
1061b059686aSAlexander Motin 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1062b059686aSAlexander Motin 		numbufs = 1;
1063b059686aSAlexander Motin 		break;
1064b059686aSAlexander Motin 	case XPT_MMC_IO:
1065b059686aSAlexander Motin 		data_ptrs[0] = (u_int8_t **)&ccb->mmcio.cmd.data;
1066b059686aSAlexander Motin 		lengths[0] = sizeof(struct mmc_data *);
1067b059686aSAlexander Motin 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1068b059686aSAlexander Motin 		data_ptrs[1] = (u_int8_t **)&ccb->mmcio.cmd.data->data;
1069b059686aSAlexander Motin 		lengths[1] = ccb->mmcio.cmd.data->len;
1070b059686aSAlexander Motin 		dirs[1] = ccb->ccb_h.flags & CAM_DIR_MASK;
1071b059686aSAlexander Motin 		numbufs = 2;
107252c9ce25SScott Long 		break;
107306e79492SKenneth D. Merry 	case XPT_SMP_IO:
107406e79492SKenneth D. Merry 		data_ptrs[0] = &ccb->smpio.smp_request;
1075b059686aSAlexander Motin 		lengths[0] = ccb->smpio.smp_request_len;
1076b059686aSAlexander Motin 		dirs[0] = CAM_DIR_OUT;
107706e79492SKenneth D. Merry 		data_ptrs[1] = &ccb->smpio.smp_response;
1078b059686aSAlexander Motin 		lengths[1] = ccb->smpio.smp_response_len;
1079b059686aSAlexander Motin 		dirs[1] = CAM_DIR_IN;
1080b059686aSAlexander Motin 		numbufs = 2;
108106e79492SKenneth D. Merry 		break;
1082df424515SWarner Losh 	case XPT_NVME_IO:
1083df424515SWarner Losh 	case XPT_NVME_ADMIN:
1084df424515SWarner Losh 		data_ptrs[0] = &ccb->nvmeio.data_ptr;
1085b059686aSAlexander Motin 		lengths[0] = ccb->nvmeio.dxfer_len;
1086b059686aSAlexander Motin 		dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1087b059686aSAlexander Motin 		numbufs = 1;
1088b059686aSAlexander Motin 		break;
1089b059686aSAlexander Motin 	case XPT_DEV_ADVINFO:
1090b059686aSAlexander Motin 		data_ptrs[0] = (uint8_t **)&ccb->cdai.buf;
1091b059686aSAlexander Motin 		lengths[0] = ccb->cdai.bufsiz;
1092b059686aSAlexander Motin 		dirs[0] = CAM_DIR_IN;
1093b059686aSAlexander Motin 		numbufs = 1;
1094df424515SWarner Losh 		break;
10958b8a9b1dSJustin T. Gibbs 	default:
10968b8a9b1dSJustin T. Gibbs 		/* allow ourselves to be swapped once again */
10970cbbb7bfSPeter Wemm 		PRELE(curproc);
10988b8a9b1dSJustin T. Gibbs 		return;
10998b8a9b1dSJustin T. Gibbs 		break; /* NOTREACHED */
11008b8a9b1dSJustin T. Gibbs 	}
11018b8a9b1dSJustin T. Gibbs 
11028b8a9b1dSJustin T. Gibbs 	for (i = 0; i < numbufs; i++) {
1103b059686aSAlexander Motin 		if (mapinfo->bp[i]) {
11048b8a9b1dSJustin T. Gibbs 			/* unmap the buffer */
11058b8a9b1dSJustin T. Gibbs 			vunmapbuf(mapinfo->bp[i]);
11068b8a9b1dSJustin T. Gibbs 
11078b8a9b1dSJustin T. Gibbs 			/* release the buffer */
1108756a5412SGleb Smirnoff 			uma_zfree(pbuf_zone, mapinfo->bp[i]);
1109b059686aSAlexander Motin 		} else {
1110b059686aSAlexander Motin 			if (dirs[i] != CAM_DIR_OUT) {
1111b059686aSAlexander Motin 				copyout(*data_ptrs[i], mapinfo->orig[i],
1112b059686aSAlexander Motin 				    lengths[i]);
1113b059686aSAlexander Motin 			}
1114b059686aSAlexander Motin 			free(*data_ptrs[i], M_CAMPERIPH);
1115b059686aSAlexander Motin 		}
1116b059686aSAlexander Motin 
1117b059686aSAlexander Motin 		/* Set the user's pointer back to the original value */
1118b059686aSAlexander Motin 		*data_ptrs[i] = mapinfo->orig[i];
11198b8a9b1dSJustin T. Gibbs 	}
11208b8a9b1dSJustin T. Gibbs 
11218b8a9b1dSJustin T. Gibbs 	/* allow ourselves to be swapped once again */
11220cbbb7bfSPeter Wemm 	PRELE(curproc);
11238b8a9b1dSJustin T. Gibbs }
11248b8a9b1dSJustin T. Gibbs 
11258b8a9b1dSJustin T. Gibbs int
1126571e8e20SScott Long cam_periph_ioctl(struct cam_periph *periph, u_long cmd, caddr_t addr,
11278b8a9b1dSJustin T. Gibbs 		 int (*error_routine)(union ccb *ccb,
11288b8a9b1dSJustin T. Gibbs 				      cam_flags camflags,
11298b8a9b1dSJustin T. Gibbs 				      u_int32_t sense_flags))
11308b8a9b1dSJustin T. Gibbs {
11318b8a9b1dSJustin T. Gibbs 	union ccb 	     *ccb;
11328b8a9b1dSJustin T. Gibbs 	int 		     error;
11338b8a9b1dSJustin T. Gibbs 	int		     found;
11348b8a9b1dSJustin T. Gibbs 
11358b8a9b1dSJustin T. Gibbs 	error = found = 0;
11368b8a9b1dSJustin T. Gibbs 
11378b8a9b1dSJustin T. Gibbs 	switch(cmd){
11388b8a9b1dSJustin T. Gibbs 	case CAMGETPASSTHRU:
1139bbfa4aa1SAlexander Motin 		ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
11408b8a9b1dSJustin T. Gibbs 		xpt_setup_ccb(&ccb->ccb_h,
11418b8a9b1dSJustin T. Gibbs 			      ccb->ccb_h.path,
1142bbfa4aa1SAlexander Motin 			      CAM_PRIORITY_NORMAL);
11438b8a9b1dSJustin T. Gibbs 		ccb->ccb_h.func_code = XPT_GDEVLIST;
11448b8a9b1dSJustin T. Gibbs 
11458b8a9b1dSJustin T. Gibbs 		/*
11468b8a9b1dSJustin T. Gibbs 		 * Basically, the point of this is that we go through
11478b8a9b1dSJustin T. Gibbs 		 * getting the list of devices, until we find a passthrough
11488b8a9b1dSJustin T. Gibbs 		 * device.  In the current version of the CAM code, the
11498b8a9b1dSJustin T. Gibbs 		 * only way to determine what type of device we're dealing
11508b8a9b1dSJustin T. Gibbs 		 * with is by its name.
11518b8a9b1dSJustin T. Gibbs 		 */
11528b8a9b1dSJustin T. Gibbs 		while (found == 0) {
11538b8a9b1dSJustin T. Gibbs 			ccb->cgdl.index = 0;
11548b8a9b1dSJustin T. Gibbs 			ccb->cgdl.status = CAM_GDEVLIST_MORE_DEVS;
11558b8a9b1dSJustin T. Gibbs 			while (ccb->cgdl.status == CAM_GDEVLIST_MORE_DEVS) {
11568b8a9b1dSJustin T. Gibbs 
11578b8a9b1dSJustin T. Gibbs 				/* we want the next device in the list */
11588b8a9b1dSJustin T. Gibbs 				xpt_action(ccb);
11598b8a9b1dSJustin T. Gibbs 				if (strncmp(ccb->cgdl.periph_name,
11608b8a9b1dSJustin T. Gibbs 				    "pass", 4) == 0){
11618b8a9b1dSJustin T. Gibbs 					found = 1;
11628b8a9b1dSJustin T. Gibbs 					break;
11638b8a9b1dSJustin T. Gibbs 				}
11648b8a9b1dSJustin T. Gibbs 			}
11658b8a9b1dSJustin T. Gibbs 			if ((ccb->cgdl.status == CAM_GDEVLIST_LAST_DEVICE) &&
11668b8a9b1dSJustin T. Gibbs 			    (found == 0)) {
11678b8a9b1dSJustin T. Gibbs 				ccb->cgdl.periph_name[0] = '\0';
11688b8a9b1dSJustin T. Gibbs 				ccb->cgdl.unit_number = 0;
11698b8a9b1dSJustin T. Gibbs 				break;
11708b8a9b1dSJustin T. Gibbs 			}
11718b8a9b1dSJustin T. Gibbs 		}
11728b8a9b1dSJustin T. Gibbs 
11738b8a9b1dSJustin T. Gibbs 		/* copy the result back out */
11748b8a9b1dSJustin T. Gibbs 		bcopy(ccb, addr, sizeof(union ccb));
11758b8a9b1dSJustin T. Gibbs 
11768b8a9b1dSJustin T. Gibbs 		/* and release the ccb */
11778b8a9b1dSJustin T. Gibbs 		xpt_release_ccb(ccb);
11788b8a9b1dSJustin T. Gibbs 
11798b8a9b1dSJustin T. Gibbs 		break;
11808b8a9b1dSJustin T. Gibbs 	default:
11818b8a9b1dSJustin T. Gibbs 		error = ENOTTY;
11828b8a9b1dSJustin T. Gibbs 		break;
11838b8a9b1dSJustin T. Gibbs 	}
11848b8a9b1dSJustin T. Gibbs 	return(error);
11858b8a9b1dSJustin T. Gibbs }
11868b8a9b1dSJustin T. Gibbs 
1187227d67aaSAlexander Motin static void
1188991b5d26SMark Johnston cam_periph_done_panic(struct cam_periph *periph, union ccb *done_ccb)
1189991b5d26SMark Johnston {
1190991b5d26SMark Johnston 
1191991b5d26SMark Johnston 	panic("%s: already done with ccb %p", __func__, done_ccb);
1192991b5d26SMark Johnston }
1193991b5d26SMark Johnston 
1194991b5d26SMark Johnston static void
1195227d67aaSAlexander Motin cam_periph_done(struct cam_periph *periph, union ccb *done_ccb)
1196227d67aaSAlexander Motin {
1197227d67aaSAlexander Motin 
1198227d67aaSAlexander Motin 	/* Caller will release the CCB */
1199991b5d26SMark Johnston 	xpt_path_assert(done_ccb->ccb_h.path, MA_OWNED);
1200991b5d26SMark Johnston 	done_ccb->ccb_h.cbfcnp = cam_periph_done_panic;
1201227d67aaSAlexander Motin 	wakeup(&done_ccb->ccb_h.cbfcnp);
1202227d67aaSAlexander Motin }
1203227d67aaSAlexander Motin 
1204991b5d26SMark Johnston static void
1205991b5d26SMark Johnston cam_periph_ccbwait(union ccb *ccb)
1206991b5d26SMark Johnston {
1207991b5d26SMark Johnston 
1208991b5d26SMark Johnston 	if ((ccb->ccb_h.func_code & XPT_FC_QUEUED) != 0) {
1209991b5d26SMark Johnston 		while (ccb->ccb_h.cbfcnp != cam_periph_done_panic)
1210991b5d26SMark Johnston 			xpt_path_sleep(ccb->ccb_h.path, &ccb->ccb_h.cbfcnp,
1211991b5d26SMark Johnston 			    PRIBIO, "cbwait", 0);
1212991b5d26SMark Johnston 	}
1213991b5d26SMark Johnston 	KASSERT(ccb->ccb_h.pinfo.index == CAM_UNQUEUED_INDEX &&
1214991b5d26SMark Johnston 	    (ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_INPROG,
1215991b5d26SMark Johnston 	    ("%s: proceeding with incomplete ccb: ccb=%p, func_code=%#x, "
1216991b5d26SMark Johnston 	     "status=%#x, index=%d", __func__, ccb, ccb->ccb_h.func_code,
1217991b5d26SMark Johnston 	     ccb->ccb_h.status, ccb->ccb_h.pinfo.index));
1218991b5d26SMark Johnston }
1219991b5d26SMark Johnston 
122076314772SScott Long /*
122176314772SScott Long  * Dispatch a CCB and wait for it to complete.  If the CCB has set a
122276314772SScott Long  * callback function (ccb->ccb_h.cbfcnp), it will be overwritten and lost.
122376314772SScott Long  */
12248b8a9b1dSJustin T. Gibbs int
12258b8a9b1dSJustin T. Gibbs cam_periph_runccb(union ccb *ccb,
12268b8a9b1dSJustin T. Gibbs 		  int (*error_routine)(union ccb *ccb,
12278b8a9b1dSJustin T. Gibbs 				       cam_flags camflags,
12288b8a9b1dSJustin T. Gibbs 				       u_int32_t sense_flags),
12298b8a9b1dSJustin T. Gibbs 		  cam_flags camflags, u_int32_t sense_flags,
12308b8a9b1dSJustin T. Gibbs 		  struct devstat *ds)
12318b8a9b1dSJustin T. Gibbs {
1232fd8be18fSKenneth D. Merry 	struct bintime *starttime;
1233fd8be18fSKenneth D. Merry 	struct bintime ltime;
12348b8a9b1dSJustin T. Gibbs 	int error;
12355cf3cd10SWarner Losh 	bool must_poll;
1236f93a843cSWarner Losh 	uint32_t timeout = 1;
12378b8a9b1dSJustin T. Gibbs 
1238fd8be18fSKenneth D. Merry 	starttime = NULL;
1239227d67aaSAlexander Motin 	xpt_path_assert(ccb->ccb_h.path, MA_OWNED);
1240991b5d26SMark Johnston 	KASSERT((ccb->ccb_h.flags & CAM_UNLOCKED) == 0,
1241991b5d26SMark Johnston 	    ("%s: ccb=%p, func_code=%#x, flags=%#x", __func__, ccb,
1242991b5d26SMark Johnston 	     ccb->ccb_h.func_code, ccb->ccb_h.flags));
12438b8a9b1dSJustin T. Gibbs 
12448b8a9b1dSJustin T. Gibbs 	/*
12458b8a9b1dSJustin T. Gibbs 	 * If the user has supplied a stats structure, and if we understand
12468b8a9b1dSJustin T. Gibbs 	 * this particular type of ccb, record the transaction start.
12478b8a9b1dSJustin T. Gibbs 	 */
1248d2f3208dSWarner Losh 	if (ds != NULL &&
1249d2f3208dSWarner Losh 	    (ccb->ccb_h.func_code == XPT_SCSI_IO ||
1250d2f3208dSWarner Losh 	    ccb->ccb_h.func_code == XPT_ATA_IO ||
1251d2f3208dSWarner Losh 	    ccb->ccb_h.func_code == XPT_NVME_IO)) {
1252fd8be18fSKenneth D. Merry 		starttime = &ltime;
1253fd8be18fSKenneth D. Merry 		binuptime(starttime);
1254fd8be18fSKenneth D. Merry 		devstat_start_transaction(ds, starttime);
1255fd8be18fSKenneth D. Merry 	}
12568b8a9b1dSJustin T. Gibbs 
12575cf3cd10SWarner Losh 	/*
12585cf3cd10SWarner Losh 	 * We must poll the I/O while we're dumping. The scheduler is normally
12595cf3cd10SWarner Losh 	 * stopped for dumping, except when we call doadump from ddb. While the
12605cf3cd10SWarner Losh 	 * scheduler is running in this case, we still need to poll the I/O to
12615cf3cd10SWarner Losh 	 * avoid sleeping waiting for the ccb to complete.
126204e814aeSScott Long 	 *
1263045f8bc8SWarner Losh 	 * A panic triggered dump stops the scheduler, any callback from the
1264045f8bc8SWarner Losh 	 * shutdown_post_sync event will run with the scheduler stopped, but
1265045f8bc8SWarner Losh 	 * before we're officially dumping. To avoid hanging in adashutdown
1266045f8bc8SWarner Losh 	 * initiated commands (or other similar situations), we have to test for
1267045f8bc8SWarner Losh 	 * either SCHEDULER_STOPPED() here as well.
1268045f8bc8SWarner Losh 	 *
1269045f8bc8SWarner Losh 	 * To avoid locking problems, dumping/polling callers must call
127004e814aeSScott Long 	 * without a periph lock held.
12715cf3cd10SWarner Losh 	 */
1272045f8bc8SWarner Losh 	must_poll = dumping || SCHEDULER_STOPPED();
1273227d67aaSAlexander Motin 	ccb->ccb_h.cbfcnp = cam_periph_done;
12748b8a9b1dSJustin T. Gibbs 
1275f93a843cSWarner Losh 	/*
1276f93a843cSWarner Losh 	 * If we're polling, then we need to ensure that we have ample resources
127776314772SScott Long 	 * in the periph.  cam_periph_error can reschedule the ccb by calling
127876314772SScott Long 	 * xpt_action and returning ERESTART, so we have to effect the polling
127976314772SScott Long 	 * in the do loop below.
1280f93a843cSWarner Losh 	 */
12815cf3cd10SWarner Losh 	if (must_poll) {
1282f93a843cSWarner Losh 		timeout = xpt_poll_setup(ccb);
1283f93a843cSWarner Losh 	}
1284f93a843cSWarner Losh 
1285f93a843cSWarner Losh 	if (timeout == 0) {
1286f93a843cSWarner Losh 		ccb->ccb_h.status = CAM_RESRC_UNAVAIL;
1287f93a843cSWarner Losh 		error = EBUSY;
1288f93a843cSWarner Losh 	} else {
1289f93a843cSWarner Losh 		xpt_action(ccb);
12908b8a9b1dSJustin T. Gibbs 		do {
12915cf3cd10SWarner Losh 			if (must_poll) {
1292f93a843cSWarner Losh 				xpt_pollwait(ccb, timeout);
1293f93a843cSWarner Losh 				timeout = ccb->ccb_h.timeout * 10;
12945cf3cd10SWarner Losh 			} else {
12955cf3cd10SWarner Losh 				cam_periph_ccbwait(ccb);
1296f93a843cSWarner Losh 			}
12978b8a9b1dSJustin T. Gibbs 			if ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP)
12988b8a9b1dSJustin T. Gibbs 				error = 0;
1299991b5d26SMark Johnston 			else if (error_routine != NULL) {
1300991b5d26SMark Johnston 				ccb->ccb_h.cbfcnp = cam_periph_done;
13018b8a9b1dSJustin T. Gibbs 				error = (*error_routine)(ccb, camflags, sense_flags);
1302991b5d26SMark Johnston 			} else
13038b8a9b1dSJustin T. Gibbs 				error = 0;
13048b8a9b1dSJustin T. Gibbs 		} while (error == ERESTART);
1305f93a843cSWarner Losh 	}
1306f93a843cSWarner Losh 
130783c5d981SAlexander Motin 	if ((ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
13088b8a9b1dSJustin T. Gibbs 		cam_release_devq(ccb->ccb_h.path,
13098b8a9b1dSJustin T. Gibbs 				 /* relsim_flags */0,
13108b8a9b1dSJustin T. Gibbs 				 /* openings */0,
13118b8a9b1dSJustin T. Gibbs 				 /* timeout */0,
13128b8a9b1dSJustin T. Gibbs 				 /* getcount_only */ FALSE);
131383c5d981SAlexander Motin 		ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
131483c5d981SAlexander Motin 	}
13158b8a9b1dSJustin T. Gibbs 
1316379ad358SAlexander Motin 	if (ds != NULL) {
1317d2f3208dSWarner Losh 		uint32_t bytes;
1318d2f3208dSWarner Losh 		devstat_tag_type tag;
1319d2f3208dSWarner Losh 		bool valid = true;
1320d2f3208dSWarner Losh 
1321379ad358SAlexander Motin 		if (ccb->ccb_h.func_code == XPT_SCSI_IO) {
1322d2f3208dSWarner Losh 			bytes = ccb->csio.dxfer_len - ccb->csio.resid;
1323d2f3208dSWarner Losh 			tag = (devstat_tag_type)(ccb->csio.tag_action & 0x3);
1324379ad358SAlexander Motin 		} else if (ccb->ccb_h.func_code == XPT_ATA_IO) {
1325d2f3208dSWarner Losh 			bytes = ccb->ataio.dxfer_len - ccb->ataio.resid;
1326d2f3208dSWarner Losh 			tag = (devstat_tag_type)0;
1327d2f3208dSWarner Losh 		} else if (ccb->ccb_h.func_code == XPT_NVME_IO) {
1328d2f3208dSWarner Losh 			bytes = ccb->nvmeio.dxfer_len; /* NB: resid no possible */
1329d2f3208dSWarner Losh 			tag = (devstat_tag_type)0;
1330d2f3208dSWarner Losh 		} else {
1331d2f3208dSWarner Losh 			valid = false;
1332379ad358SAlexander Motin 		}
1333d2f3208dSWarner Losh 		if (valid)
1334d2f3208dSWarner Losh 			devstat_end_transaction(ds, bytes, tag,
1335d2f3208dSWarner Losh 			    ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE) ?
1336d2f3208dSWarner Losh 			    DEVSTAT_NO_DATA : (ccb->ccb_h.flags & CAM_DIR_OUT) ?
1337d2f3208dSWarner Losh 			    DEVSTAT_WRITE : DEVSTAT_READ, NULL, starttime);
1338379ad358SAlexander Motin 	}
13398b8a9b1dSJustin T. Gibbs 
13408b8a9b1dSJustin T. Gibbs 	return(error);
13418b8a9b1dSJustin T. Gibbs }
13428b8a9b1dSJustin T. Gibbs 
134387cfaf0eSJustin T. Gibbs void
134487cfaf0eSJustin T. Gibbs cam_freeze_devq(struct cam_path *path)
134587cfaf0eSJustin T. Gibbs {
1346cccf4220SAlexander Motin 	struct ccb_hdr ccb_h;
134787cfaf0eSJustin T. Gibbs 
13480d4f3c31SAlexander Motin 	CAM_DEBUG(path, CAM_DEBUG_TRACE, ("cam_freeze_devq\n"));
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));
1364bbfa4aa1SAlexander Motin 	xpt_setup_ccb(&crs.ccb_h, path, CAM_PRIORITY_NORMAL);
13658b8a9b1dSJustin T. Gibbs 	crs.ccb_h.func_code = XPT_REL_SIMQ;
13668b8a9b1dSJustin T. Gibbs 	crs.ccb_h.flags = getcount_only ? CAM_DEV_QFREEZE : 0;
13678b8a9b1dSJustin T. Gibbs 	crs.release_flags = relsim_flags;
13688b8a9b1dSJustin T. Gibbs 	crs.openings = openings;
136983c5d981SAlexander Motin 	crs.release_timeout = arg;
13708b8a9b1dSJustin T. Gibbs 	xpt_action((union ccb *)&crs);
13718b8a9b1dSJustin T. Gibbs 	return (crs.qfrozen_cnt);
13728b8a9b1dSJustin T. Gibbs }
13738b8a9b1dSJustin T. Gibbs 
13748b8a9b1dSJustin T. Gibbs #define saved_ccb_ptr ppriv_ptr0
137583c5d981SAlexander Motin static void
137683c5d981SAlexander Motin camperiphdone(struct cam_periph *periph, union ccb *done_ccb)
137783c5d981SAlexander Motin {
13780191d9b3SAlexander Motin 	union ccb      *saved_ccb;
137983c5d981SAlexander Motin 	cam_status	status;
138083c5d981SAlexander Motin 	struct scsi_start_stop_unit *scsi_cmd;
138179fab7d4SAlexander Motin 	int		error = 0, error_code, sense_key, asc, ascq;
138283c5d981SAlexander Motin 
13830191d9b3SAlexander Motin 	scsi_cmd = (struct scsi_start_stop_unit *)
13840191d9b3SAlexander Motin 	    &done_ccb->csio.cdb_io.cdb_bytes;
138583c5d981SAlexander Motin 	status = done_ccb->ccb_h.status;
13868b8a9b1dSJustin T. Gibbs 
13870191d9b3SAlexander Motin 	if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1388e7493b28SAlexander Motin 		if (scsi_extract_sense_ccb(done_ccb,
1389e7493b28SAlexander Motin 		    &error_code, &sense_key, &asc, &ascq)) {
139065afe1f4SKenneth D. Merry 			/*
13918b8a9b1dSJustin T. Gibbs 			 * If the error is "invalid field in CDB",
13928b8a9b1dSJustin T. Gibbs 			 * and the load/eject flag is set, turn the
13938b8a9b1dSJustin T. Gibbs 			 * flag off and try again.  This is just in
13948b8a9b1dSJustin T. Gibbs 			 * case the drive in question barfs on the
13958b8a9b1dSJustin T. Gibbs 			 * load eject flag.  The CAM code should set
13968b8a9b1dSJustin T. Gibbs 			 * the load/eject flag by default for
13978b8a9b1dSJustin T. Gibbs 			 * removable media.
13988b8a9b1dSJustin T. Gibbs 			 */
13998b8a9b1dSJustin T. Gibbs 			if ((scsi_cmd->opcode == START_STOP_UNIT) &&
14008b8a9b1dSJustin T. Gibbs 			    ((scsi_cmd->how & SSS_LOEJ) != 0) &&
14010191d9b3SAlexander Motin 			     (asc == 0x24) && (ascq == 0x00)) {
14028b8a9b1dSJustin T. Gibbs 				scsi_cmd->how &= ~SSS_LOEJ;
14030191d9b3SAlexander Motin 				if (status & CAM_DEV_QFRZN) {
14040191d9b3SAlexander Motin 					cam_release_devq(done_ccb->ccb_h.path,
14050191d9b3SAlexander Motin 					    0, 0, 0, 0);
14060191d9b3SAlexander Motin 					done_ccb->ccb_h.status &=
14070191d9b3SAlexander Motin 					    ~CAM_DEV_QFRZN;
14080191d9b3SAlexander Motin 				}
14098b8a9b1dSJustin T. Gibbs 				xpt_action(done_ccb);
14100191d9b3SAlexander Motin 				goto out;
14110191d9b3SAlexander Motin 			}
14120191d9b3SAlexander Motin 		}
141379fab7d4SAlexander Motin 		error = cam_periph_error(done_ccb, 0,
141479fab7d4SAlexander Motin 		    SF_RETRY_UA | SF_NO_PRINT);
141579fab7d4SAlexander Motin 		if (error == ERESTART)
14160191d9b3SAlexander Motin 			goto out;
14170191d9b3SAlexander Motin 		if (done_ccb->ccb_h.status & CAM_DEV_QFRZN) {
14180191d9b3SAlexander Motin 			cam_release_devq(done_ccb->ccb_h.path, 0, 0, 0, 0);
14190191d9b3SAlexander Motin 			done_ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
14200191d9b3SAlexander Motin 		}
14210191d9b3SAlexander Motin 	} else {
14220191d9b3SAlexander Motin 		/*
14230191d9b3SAlexander Motin 		 * If we have successfully taken a device from the not
14240191d9b3SAlexander Motin 		 * ready to ready state, re-scan the device and re-get
14250191d9b3SAlexander Motin 		 * the inquiry information.  Many devices (mostly disks)
14260191d9b3SAlexander Motin 		 * don't properly report their inquiry information unless
14270191d9b3SAlexander Motin 		 * they are spun up.
14280191d9b3SAlexander Motin 		 */
14290191d9b3SAlexander Motin 		if (scsi_cmd->opcode == START_STOP_UNIT)
14300191d9b3SAlexander Motin 			xpt_async(AC_INQ_CHANGED, done_ccb->ccb_h.path, NULL);
14310191d9b3SAlexander Motin 	}
143265afe1f4SKenneth D. Merry 
1433bae3729bSAlexander Motin 	/* If we tried long wait and still failed, remember that. */
1434bae3729bSAlexander Motin 	if ((periph->flags & CAM_PERIPH_RECOVERY_WAIT) &&
1435bae3729bSAlexander Motin 	    (done_ccb->csio.cdb_io.cdb_bytes[0] == TEST_UNIT_READY)) {
1436bae3729bSAlexander Motin 		periph->flags &= ~CAM_PERIPH_RECOVERY_WAIT;
1437bae3729bSAlexander Motin 		if (error != 0 && done_ccb->ccb_h.retry_count == 0)
1438bae3729bSAlexander Motin 			periph->flags |= CAM_PERIPH_RECOVERY_WAIT_FAILED;
1439bae3729bSAlexander Motin 	}
1440bae3729bSAlexander Motin 
14418b8a9b1dSJustin T. Gibbs 	/*
144279fab7d4SAlexander Motin 	 * After recovery action(s) completed, return to the original CCB.
144379fab7d4SAlexander Motin 	 * If the recovery CCB has failed, considering its own possible
144479fab7d4SAlexander Motin 	 * retries and recovery, assume we are back in state where we have
144579fab7d4SAlexander Motin 	 * been originally, but without recovery hopes left.  In such case,
144679fab7d4SAlexander Motin 	 * after the final attempt below, we cancel any further retries,
144779fab7d4SAlexander Motin 	 * blocking by that also any new recovery attempts for this CCB,
144879fab7d4SAlexander Motin 	 * and the result will be the final one returned to the CCB owher.
14498b8a9b1dSJustin T. Gibbs 	 */
14500191d9b3SAlexander Motin 	saved_ccb = (union ccb *)done_ccb->ccb_h.saved_ccb_ptr;
145183c5d981SAlexander Motin 	bcopy(saved_ccb, done_ccb, sizeof(*done_ccb));
145283c5d981SAlexander Motin 	xpt_free_ccb(saved_ccb);
14530191d9b3SAlexander Motin 	if (done_ccb->ccb_h.cbfcnp != camperiphdone)
145460a899a0SKenneth D. Merry 		periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
145579fab7d4SAlexander Motin 	if (error != 0)
145679fab7d4SAlexander Motin 		done_ccb->ccb_h.retry_count = 0;
14578b8a9b1dSJustin T. Gibbs 	xpt_action(done_ccb);
14588b8a9b1dSJustin T. Gibbs 
14590191d9b3SAlexander Motin out:
14600191d9b3SAlexander Motin 	/* Drop freeze taken due to CAM_DEV_QFREEZE flag set. */
14610191d9b3SAlexander Motin 	cam_release_devq(done_ccb->ccb_h.path, 0, 0, 0, 0);
1462d84c90a6SAlexander Motin }
14638b8a9b1dSJustin T. Gibbs 
14648b8a9b1dSJustin T. Gibbs /*
146587cfaf0eSJustin T. Gibbs  * Generic Async Event handler.  Peripheral drivers usually
146687cfaf0eSJustin T. Gibbs  * filter out the events that require personal attention,
146787cfaf0eSJustin T. Gibbs  * and leave the rest to this function.
146887cfaf0eSJustin T. Gibbs  */
146987cfaf0eSJustin T. Gibbs void
147087cfaf0eSJustin T. Gibbs cam_periph_async(struct cam_periph *periph, u_int32_t code,
147187cfaf0eSJustin T. Gibbs 		 struct cam_path *path, void *arg)
147287cfaf0eSJustin T. Gibbs {
147387cfaf0eSJustin T. Gibbs 	switch (code) {
147487cfaf0eSJustin T. Gibbs 	case AC_LOST_DEVICE:
147587cfaf0eSJustin T. Gibbs 		cam_periph_invalidate(periph);
147687cfaf0eSJustin T. Gibbs 		break;
147787cfaf0eSJustin T. Gibbs 	default:
147887cfaf0eSJustin T. Gibbs 		break;
147987cfaf0eSJustin T. Gibbs 	}
148087cfaf0eSJustin T. Gibbs }
148187cfaf0eSJustin T. Gibbs 
148287cfaf0eSJustin T. Gibbs void
148387cfaf0eSJustin T. Gibbs cam_periph_bus_settle(struct cam_periph *periph, u_int bus_settle)
148487cfaf0eSJustin T. Gibbs {
148587cfaf0eSJustin T. Gibbs 	struct ccb_getdevstats cgds;
148687cfaf0eSJustin T. Gibbs 
1487bbfa4aa1SAlexander Motin 	xpt_setup_ccb(&cgds.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
148887cfaf0eSJustin T. Gibbs 	cgds.ccb_h.func_code = XPT_GDEV_STATS;
148987cfaf0eSJustin T. Gibbs 	xpt_action((union ccb *)&cgds);
149087cfaf0eSJustin T. Gibbs 	cam_periph_freeze_after_event(periph, &cgds.last_reset, bus_settle);
149187cfaf0eSJustin T. Gibbs }
149287cfaf0eSJustin T. Gibbs 
149387cfaf0eSJustin T. Gibbs void
149487cfaf0eSJustin T. Gibbs cam_periph_freeze_after_event(struct cam_periph *periph,
149587cfaf0eSJustin T. Gibbs 			      struct timeval* event_time, u_int duration_ms)
149687cfaf0eSJustin T. Gibbs {
149787cfaf0eSJustin T. Gibbs 	struct timeval delta;
149887cfaf0eSJustin T. Gibbs 	struct timeval duration_tv;
149987cfaf0eSJustin T. Gibbs 
1500f8ff57d2SAlexander Motin 	if (!timevalisset(event_time))
1501f8ff57d2SAlexander Motin 		return;
1502f8ff57d2SAlexander Motin 
150387cfaf0eSJustin T. Gibbs 	microtime(&delta);
150487cfaf0eSJustin T. Gibbs 	timevalsub(&delta, event_time);
150587cfaf0eSJustin T. Gibbs 	duration_tv.tv_sec = duration_ms / 1000;
150687cfaf0eSJustin T. Gibbs 	duration_tv.tv_usec = (duration_ms % 1000) * 1000;
150787cfaf0eSJustin T. Gibbs 	if (timevalcmp(&delta, &duration_tv, <)) {
150887cfaf0eSJustin T. Gibbs 		timevalsub(&duration_tv, &delta);
150987cfaf0eSJustin T. Gibbs 
151087cfaf0eSJustin T. Gibbs 		duration_ms = duration_tv.tv_sec * 1000;
151187cfaf0eSJustin T. Gibbs 		duration_ms += duration_tv.tv_usec / 1000;
151287cfaf0eSJustin T. Gibbs 		cam_freeze_devq(periph->path);
151387cfaf0eSJustin T. Gibbs 		cam_release_devq(periph->path,
151487cfaf0eSJustin T. Gibbs 				RELSIM_RELEASE_AFTER_TIMEOUT,
151587cfaf0eSJustin T. Gibbs 				/*reduction*/0,
151687cfaf0eSJustin T. Gibbs 				/*timeout*/duration_ms,
151787cfaf0eSJustin T. Gibbs 				/*getcount_only*/0);
151887cfaf0eSJustin T. Gibbs 	}
151987cfaf0eSJustin T. Gibbs 
152087cfaf0eSJustin T. Gibbs }
152187cfaf0eSJustin T. Gibbs 
15223393f8daSKenneth D. Merry static int
15230191d9b3SAlexander Motin camperiphscsistatuserror(union ccb *ccb, union ccb **orig_ccb,
15240191d9b3SAlexander Motin     cam_flags camflags, u_int32_t sense_flags,
15253393f8daSKenneth D. Merry     int *openings, u_int32_t *relsim_flags,
15260181d54bSAlexander Motin     u_int32_t *timeout, u_int32_t *action, const char **action_string)
15278b8a9b1dSJustin T. Gibbs {
152899bad9caSAlexander Motin 	struct cam_periph *periph;
15298b8a9b1dSJustin T. Gibbs 	int error;
15308b8a9b1dSJustin T. Gibbs 
15318b8a9b1dSJustin T. Gibbs 	switch (ccb->csio.scsi_status) {
15328b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_OK:
15338b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_COND_MET:
15348b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_INTERMED:
15358b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_INTERMED_COND_MET:
15368b8a9b1dSJustin T. Gibbs 		error = 0;
15378b8a9b1dSJustin T. Gibbs 		break;
15388b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_CMD_TERMINATED:
15398b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_CHECK_COND:
15400191d9b3SAlexander Motin 		error = camperiphscsisenseerror(ccb, orig_ccb,
15413393f8daSKenneth D. Merry 					        camflags,
15428b8a9b1dSJustin T. Gibbs 					        sense_flags,
15433393f8daSKenneth D. Merry 					        openings,
15443393f8daSKenneth D. Merry 					        relsim_flags,
154583c5d981SAlexander Motin 					        timeout,
15460181d54bSAlexander Motin 					        action,
154783c5d981SAlexander Motin 					        action_string);
15488b8a9b1dSJustin T. Gibbs 		break;
15498b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_QUEUE_FULL:
15508b8a9b1dSJustin T. Gibbs 	{
15518b8a9b1dSJustin T. Gibbs 		/* no decrement */
155282815562SJustin T. Gibbs 		struct ccb_getdevstats cgds;
15538b8a9b1dSJustin T. Gibbs 
15548b8a9b1dSJustin T. Gibbs 		/*
15558b8a9b1dSJustin T. Gibbs 		 * First off, find out what the current
15568b8a9b1dSJustin T. Gibbs 		 * transaction counts are.
15578b8a9b1dSJustin T. Gibbs 		 */
155882815562SJustin T. Gibbs 		xpt_setup_ccb(&cgds.ccb_h,
15598b8a9b1dSJustin T. Gibbs 			      ccb->ccb_h.path,
1560bbfa4aa1SAlexander Motin 			      CAM_PRIORITY_NORMAL);
156182815562SJustin T. Gibbs 		cgds.ccb_h.func_code = XPT_GDEV_STATS;
156282815562SJustin T. Gibbs 		xpt_action((union ccb *)&cgds);
15638b8a9b1dSJustin T. Gibbs 
15648b8a9b1dSJustin T. Gibbs 		/*
15658b8a9b1dSJustin T. Gibbs 		 * If we were the only transaction active, treat
15668b8a9b1dSJustin T. Gibbs 		 * the QUEUE FULL as if it were a BUSY condition.
15678b8a9b1dSJustin T. Gibbs 		 */
156882815562SJustin T. Gibbs 		if (cgds.dev_active != 0) {
156982815562SJustin T. Gibbs 			int total_openings;
157082815562SJustin T. Gibbs 
15718b8a9b1dSJustin T. Gibbs 			/*
15728b8a9b1dSJustin T. Gibbs 		 	 * Reduce the number of openings to
15738b8a9b1dSJustin T. Gibbs 			 * be 1 less than the amount it took
15748b8a9b1dSJustin T. Gibbs 			 * to get a queue full bounded by the
15758b8a9b1dSJustin T. Gibbs 			 * minimum allowed tag count for this
15768b8a9b1dSJustin T. Gibbs 			 * device.
15778b8a9b1dSJustin T. Gibbs 		 	 */
15783393f8daSKenneth D. Merry 			total_openings = cgds.dev_active + cgds.dev_openings;
15793393f8daSKenneth D. Merry 			*openings = cgds.dev_active;
15803393f8daSKenneth D. Merry 			if (*openings < cgds.mintags)
15813393f8daSKenneth D. Merry 				*openings = cgds.mintags;
15823393f8daSKenneth D. Merry 			if (*openings < total_openings)
15833393f8daSKenneth D. Merry 				*relsim_flags = RELSIM_ADJUST_OPENINGS;
15848b8a9b1dSJustin T. Gibbs 			else {
15858b8a9b1dSJustin T. Gibbs 				/*
15868b8a9b1dSJustin T. Gibbs 				 * Some devices report queue full for
15878b8a9b1dSJustin T. Gibbs 				 * temporary resource shortages.  For
15888b8a9b1dSJustin T. Gibbs 				 * this reason, we allow a minimum
15898b8a9b1dSJustin T. Gibbs 				 * tag count to be entered via a
15908b8a9b1dSJustin T. Gibbs 				 * quirk entry to prevent the queue
15918b8a9b1dSJustin T. Gibbs 				 * count on these devices from falling
15928b8a9b1dSJustin T. Gibbs 				 * to a pessimisticly low value.  We
15938b8a9b1dSJustin T. Gibbs 				 * still wait for the next successful
15948b8a9b1dSJustin T. Gibbs 				 * completion, however, before queueing
15958b8a9b1dSJustin T. Gibbs 				 * more transactions to the device.
15968b8a9b1dSJustin T. Gibbs 				 */
15973393f8daSKenneth D. Merry 				*relsim_flags = RELSIM_RELEASE_AFTER_CMDCMPLT;
15988b8a9b1dSJustin T. Gibbs 			}
15993393f8daSKenneth D. Merry 			*timeout = 0;
16008b8a9b1dSJustin T. Gibbs 			error = ERESTART;
16010181d54bSAlexander Motin 			*action &= ~SSQ_PRINT_SENSE;
16028b8a9b1dSJustin T. Gibbs 			break;
16038b8a9b1dSJustin T. Gibbs 		}
16048b8a9b1dSJustin T. Gibbs 		/* FALLTHROUGH */
16058b8a9b1dSJustin T. Gibbs 	}
16068b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_BUSY:
16078b8a9b1dSJustin T. Gibbs 		/*
16088b8a9b1dSJustin T. Gibbs 		 * Restart the queue after either another
16098b8a9b1dSJustin T. Gibbs 		 * command completes or a 1 second timeout.
16108b8a9b1dSJustin T. Gibbs 		 */
161199bad9caSAlexander Motin 		periph = xpt_path_periph(ccb->ccb_h.path);
161299bad9caSAlexander Motin 		if (periph->flags & CAM_PERIPH_INVALID) {
161399bad9caSAlexander Motin 			error = EIO;
161499bad9caSAlexander Motin 			*action_string = "Periph was invalidated";
161599bad9caSAlexander Motin 		} else if ((sense_flags & SF_RETRY_BUSY) != 0 ||
161699bad9caSAlexander Motin 		    ccb->ccb_h.retry_count > 0) {
161799bad9caSAlexander Motin 			if ((sense_flags & SF_RETRY_BUSY) == 0)
161899bad9caSAlexander Motin 				ccb->ccb_h.retry_count--;
16198b8a9b1dSJustin T. Gibbs 			error = ERESTART;
16203393f8daSKenneth D. Merry 			*relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT
16218b8a9b1dSJustin T. Gibbs 				      | RELSIM_RELEASE_AFTER_CMDCMPLT;
16223393f8daSKenneth D. Merry 			*timeout = 1000;
1623af51b059SMatt Jacob 		} else {
1624af51b059SMatt Jacob 			error = EIO;
162599bad9caSAlexander Motin 			*action_string = "Retries exhausted";
1626af51b059SMatt Jacob 		}
16278b8a9b1dSJustin T. Gibbs 		break;
16288b8a9b1dSJustin T. Gibbs 	case SCSI_STATUS_RESERV_CONFLICT:
16298b8a9b1dSJustin T. Gibbs 	default:
16308b8a9b1dSJustin T. Gibbs 		error = EIO;
16318b8a9b1dSJustin T. Gibbs 		break;
16328b8a9b1dSJustin T. Gibbs 	}
16333393f8daSKenneth D. Merry 	return (error);
16343393f8daSKenneth D. Merry }
16353393f8daSKenneth D. Merry 
16363393f8daSKenneth D. Merry static int
16370191d9b3SAlexander Motin camperiphscsisenseerror(union ccb *ccb, union ccb **orig,
16380191d9b3SAlexander Motin     cam_flags camflags, u_int32_t sense_flags,
16393393f8daSKenneth D. Merry     int *openings, u_int32_t *relsim_flags,
16400181d54bSAlexander Motin     u_int32_t *timeout, u_int32_t *action, const char **action_string)
16413393f8daSKenneth D. Merry {
16423393f8daSKenneth D. Merry 	struct cam_periph *periph;
164383c5d981SAlexander Motin 	union ccb *orig_ccb = ccb;
16440191d9b3SAlexander Motin 	int error, recoveryccb;
16453393f8daSKenneth D. Merry 
16468532d381SConrad Meyer #if defined(BUF_TRACKING) || defined(FULL_BUF_TRACKING)
16478532d381SConrad Meyer 	if (ccb->ccb_h.func_code == XPT_SCSI_IO && ccb->csio.bio != NULL)
16488532d381SConrad Meyer 		biotrack(ccb->csio.bio, __func__);
16498532d381SConrad Meyer #endif
16508532d381SConrad Meyer 
16513393f8daSKenneth D. Merry 	periph = xpt_path_periph(ccb->ccb_h.path);
16520191d9b3SAlexander Motin 	recoveryccb = (ccb->ccb_h.cbfcnp == camperiphdone);
16530191d9b3SAlexander Motin 	if ((periph->flags & CAM_PERIPH_RECOVERY_INPROG) && !recoveryccb) {
16543393f8daSKenneth D. Merry 		/*
16553393f8daSKenneth D. Merry 		 * If error recovery is already in progress, don't attempt
16563393f8daSKenneth D. Merry 		 * to process this error, but requeue it unconditionally
16573393f8daSKenneth D. Merry 		 * and attempt to process it once error recovery has
16583393f8daSKenneth D. Merry 		 * completed.  This failed command is probably related to
16593393f8daSKenneth D. Merry 		 * the error that caused the currently active error recovery
16603393f8daSKenneth D. Merry 		 * action so our  current recovery efforts should also
16613393f8daSKenneth D. Merry 		 * address this command.  Be aware that the error recovery
16623393f8daSKenneth D. Merry 		 * code assumes that only one recovery action is in progress
16633393f8daSKenneth D. Merry 		 * on a particular peripheral instance at any given time
16643393f8daSKenneth D. Merry 		 * (e.g. only one saved CCB for error recovery) so it is
16653393f8daSKenneth D. Merry 		 * imperitive that we don't violate this assumption.
16663393f8daSKenneth D. Merry 		 */
16673393f8daSKenneth D. Merry 		error = ERESTART;
16680181d54bSAlexander Motin 		*action &= ~SSQ_PRINT_SENSE;
16693393f8daSKenneth D. Merry 	} else {
16703393f8daSKenneth D. Merry 		scsi_sense_action err_action;
16713393f8daSKenneth D. Merry 		struct ccb_getdev cgd;
16723393f8daSKenneth D. Merry 
16733393f8daSKenneth D. Merry 		/*
16743393f8daSKenneth D. Merry 		 * Grab the inquiry data for this device.
16753393f8daSKenneth D. Merry 		 */
1676bbfa4aa1SAlexander Motin 		xpt_setup_ccb(&cgd.ccb_h, ccb->ccb_h.path, CAM_PRIORITY_NORMAL);
16773393f8daSKenneth D. Merry 		cgd.ccb_h.func_code = XPT_GDEV_TYPE;
16783393f8daSKenneth D. Merry 		xpt_action((union ccb *)&cgd);
16793393f8daSKenneth D. Merry 
1680e7493b28SAlexander Motin 		err_action = scsi_error_action(&ccb->csio, &cgd.inq_data,
16813393f8daSKenneth D. Merry 		    sense_flags);
16823393f8daSKenneth D. Merry 		error = err_action & SS_ERRMASK;
16833393f8daSKenneth D. Merry 
16843393f8daSKenneth D. Merry 		/*
16850191d9b3SAlexander Motin 		 * Do not autostart sequential access devices
16860191d9b3SAlexander Motin 		 * to avoid unexpected tape loading.
16870191d9b3SAlexander Motin 		 */
16880191d9b3SAlexander Motin 		if ((err_action & SS_MASK) == SS_START &&
16890191d9b3SAlexander Motin 		    SID_TYPE(&cgd.inq_data) == T_SEQUENTIAL) {
16900191d9b3SAlexander Motin 			*action_string = "Will not autostart a "
16910191d9b3SAlexander Motin 			    "sequential access device";
16920191d9b3SAlexander Motin 			goto sense_error_done;
16930191d9b3SAlexander Motin 		}
16940191d9b3SAlexander Motin 
16950191d9b3SAlexander Motin 		/*
16960191d9b3SAlexander Motin 		 * Avoid recovery recursion if recovery action is the same.
16970191d9b3SAlexander Motin 		 */
16980191d9b3SAlexander Motin 		if ((err_action & SS_MASK) >= SS_START && recoveryccb) {
16990191d9b3SAlexander Motin 			if (((err_action & SS_MASK) == SS_START &&
17000191d9b3SAlexander Motin 			     ccb->csio.cdb_io.cdb_bytes[0] == START_STOP_UNIT) ||
17010191d9b3SAlexander Motin 			    ((err_action & SS_MASK) == SS_TUR &&
17020191d9b3SAlexander Motin 			     (ccb->csio.cdb_io.cdb_bytes[0] == TEST_UNIT_READY))) {
17030191d9b3SAlexander Motin 				err_action = SS_RETRY|SSQ_DECREMENT_COUNT|EIO;
17040191d9b3SAlexander Motin 				*relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
17050191d9b3SAlexander Motin 				*timeout = 500;
17060191d9b3SAlexander Motin 			}
17070191d9b3SAlexander Motin 		}
17080191d9b3SAlexander Motin 
17090191d9b3SAlexander Motin 		/*
17103393f8daSKenneth D. Merry 		 * If the recovery action will consume a retry,
17113393f8daSKenneth D. Merry 		 * make sure we actually have retries available.
17123393f8daSKenneth D. Merry 		 */
17133393f8daSKenneth D. Merry 		if ((err_action & SSQ_DECREMENT_COUNT) != 0) {
1714a07e846bSAlexander Motin 		 	if (ccb->ccb_h.retry_count > 0 &&
1715a07e846bSAlexander Motin 			    (periph->flags & CAM_PERIPH_INVALID) == 0)
17163393f8daSKenneth D. Merry 		 		ccb->ccb_h.retry_count--;
17173393f8daSKenneth D. Merry 			else {
171883c5d981SAlexander Motin 				*action_string = "Retries exhausted";
17193393f8daSKenneth D. Merry 				goto sense_error_done;
17203393f8daSKenneth D. Merry 			}
17213393f8daSKenneth D. Merry 		}
17223393f8daSKenneth D. Merry 
17233393f8daSKenneth D. Merry 		if ((err_action & SS_MASK) >= SS_START) {
17243393f8daSKenneth D. Merry 			/*
17253393f8daSKenneth D. Merry 			 * Do common portions of commands that
17263393f8daSKenneth D. Merry 			 * use recovery CCBs.
17273393f8daSKenneth D. Merry 			 */
172883c5d981SAlexander Motin 			orig_ccb = xpt_alloc_ccb_nowait();
172983c5d981SAlexander Motin 			if (orig_ccb == NULL) {
173083c5d981SAlexander Motin 				*action_string = "Can't allocate recovery CCB";
17313393f8daSKenneth D. Merry 				goto sense_error_done;
17323393f8daSKenneth D. Merry 			}
17331f1158b2SAlexander Motin 			/*
17341f1158b2SAlexander Motin 			 * Clear freeze flag for original request here, as
17351f1158b2SAlexander Motin 			 * this freeze will be dropped as part of ERESTART.
17361f1158b2SAlexander Motin 			 */
17371f1158b2SAlexander Motin 			ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
173883c5d981SAlexander Motin 			bcopy(ccb, orig_ccb, sizeof(*orig_ccb));
17393393f8daSKenneth D. Merry 		}
17403393f8daSKenneth D. Merry 
17413393f8daSKenneth D. Merry 		switch (err_action & SS_MASK) {
17423393f8daSKenneth D. Merry 		case SS_NOP:
174383c5d981SAlexander Motin 			*action_string = "No recovery action needed";
174400e54d14SKenneth D. Merry 			error = 0;
174500e54d14SKenneth D. Merry 			break;
17463393f8daSKenneth D. Merry 		case SS_RETRY:
174783c5d981SAlexander Motin 			*action_string = "Retrying command (per sense data)";
17483393f8daSKenneth D. Merry 			error = ERESTART;
17498b8a9b1dSJustin T. Gibbs 			break;
17503393f8daSKenneth D. Merry 		case SS_FAIL:
175183c5d981SAlexander Motin 			*action_string = "Unretryable error";
17523393f8daSKenneth D. Merry 			break;
17533393f8daSKenneth D. Merry 		case SS_START:
17543393f8daSKenneth D. Merry 		{
17553393f8daSKenneth D. Merry 			int le;
17563393f8daSKenneth D. Merry 
17573393f8daSKenneth D. Merry 			/*
17583393f8daSKenneth D. Merry 			 * Send a start unit command to the device, and
17593393f8daSKenneth D. Merry 			 * then retry the command.
17603393f8daSKenneth D. Merry 			 */
176183c5d981SAlexander Motin 			*action_string = "Attempting to start unit";
176283c5d981SAlexander Motin 			periph->flags |= CAM_PERIPH_RECOVERY_INPROG;
17633393f8daSKenneth D. Merry 
17643393f8daSKenneth D. Merry 			/*
17653393f8daSKenneth D. Merry 			 * Check for removable media and set
17663393f8daSKenneth D. Merry 			 * load/eject flag appropriately.
17673393f8daSKenneth D. Merry 			 */
17683393f8daSKenneth D. Merry 			if (SID_IS_REMOVABLE(&cgd.inq_data))
17693393f8daSKenneth D. Merry 				le = TRUE;
17703393f8daSKenneth D. Merry 			else
17713393f8daSKenneth D. Merry 				le = FALSE;
17723393f8daSKenneth D. Merry 
17733393f8daSKenneth D. Merry 			scsi_start_stop(&ccb->csio,
17743393f8daSKenneth D. Merry 					/*retries*/1,
17753393f8daSKenneth D. Merry 					camperiphdone,
17763393f8daSKenneth D. Merry 					MSG_SIMPLE_Q_TAG,
17773393f8daSKenneth D. Merry 					/*start*/TRUE,
17783393f8daSKenneth D. Merry 					/*load/eject*/le,
17793393f8daSKenneth D. Merry 					/*immediate*/FALSE,
17803393f8daSKenneth D. Merry 					SSD_FULL_SIZE,
17813393f8daSKenneth D. Merry 					/*timeout*/50000);
17823393f8daSKenneth D. Merry 			break;
17833393f8daSKenneth D. Merry 		}
17843393f8daSKenneth D. Merry 		case SS_TUR:
17853393f8daSKenneth D. Merry 		{
17863393f8daSKenneth D. Merry 			/*
17873393f8daSKenneth D. Merry 			 * Send a Test Unit Ready to the device.
17883393f8daSKenneth D. Merry 			 * If the 'many' flag is set, we send 120
17893393f8daSKenneth D. Merry 			 * test unit ready commands, one every half
17903393f8daSKenneth D. Merry 			 * second.  Otherwise, we just send one TUR.
17913393f8daSKenneth D. Merry 			 * We only want to do this if the retry
17923393f8daSKenneth D. Merry 			 * count has not been exhausted.
17933393f8daSKenneth D. Merry 			 */
17943393f8daSKenneth D. Merry 			int retries;
17953393f8daSKenneth D. Merry 
1796bae3729bSAlexander Motin 			if ((err_action & SSQ_MANY) != 0 && (periph->flags &
1797bae3729bSAlexander Motin 			     CAM_PERIPH_RECOVERY_WAIT_FAILED) == 0) {
1798bae3729bSAlexander Motin 				periph->flags |= CAM_PERIPH_RECOVERY_WAIT;
179983c5d981SAlexander Motin 				*action_string = "Polling device for readiness";
18003393f8daSKenneth D. Merry 				retries = 120;
18013393f8daSKenneth D. Merry 			} else {
180283c5d981SAlexander Motin 				*action_string = "Testing device for readiness";
18033393f8daSKenneth D. Merry 				retries = 1;
18043393f8daSKenneth D. Merry 			}
180583c5d981SAlexander Motin 			periph->flags |= CAM_PERIPH_RECOVERY_INPROG;
18063393f8daSKenneth D. Merry 			scsi_test_unit_ready(&ccb->csio,
18073393f8daSKenneth D. Merry 					     retries,
18083393f8daSKenneth D. Merry 					     camperiphdone,
18093393f8daSKenneth D. Merry 					     MSG_SIMPLE_Q_TAG,
18103393f8daSKenneth D. Merry 					     SSD_FULL_SIZE,
18113393f8daSKenneth D. Merry 					     /*timeout*/5000);
18123393f8daSKenneth D. Merry 
18133393f8daSKenneth D. Merry 			/*
18143393f8daSKenneth D. Merry 			 * Accomplish our 500ms delay by deferring
18153393f8daSKenneth D. Merry 			 * the release of our device queue appropriately.
18163393f8daSKenneth D. Merry 			 */
18173393f8daSKenneth D. Merry 			*relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
18183393f8daSKenneth D. Merry 			*timeout = 500;
18193393f8daSKenneth D. Merry 			break;
18203393f8daSKenneth D. Merry 		}
18213393f8daSKenneth D. Merry 		default:
1822e3c29144SWarner Losh 			panic("Unhandled error action %x", err_action);
18233393f8daSKenneth D. Merry 		}
18243393f8daSKenneth D. Merry 
18253393f8daSKenneth D. Merry 		if ((err_action & SS_MASK) >= SS_START) {
18263393f8daSKenneth D. Merry 			/*
1827bbfa4aa1SAlexander Motin 			 * Drop the priority, so that the recovery
18283393f8daSKenneth D. Merry 			 * CCB is the first to execute.  Freeze the queue
18293393f8daSKenneth D. Merry 			 * after this command is sent so that we can
18303393f8daSKenneth D. Merry 			 * restore the old csio and have it queued in
18313393f8daSKenneth D. Merry 			 * the proper order before we release normal
18323393f8daSKenneth D. Merry 			 * transactions to the device.
18333393f8daSKenneth D. Merry 			 */
183483c5d981SAlexander Motin 			ccb->ccb_h.pinfo.priority--;
18353393f8daSKenneth D. Merry 			ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
183683c5d981SAlexander Motin 			ccb->ccb_h.saved_ccb_ptr = orig_ccb;
18373393f8daSKenneth D. Merry 			error = ERESTART;
18380191d9b3SAlexander Motin 			*orig = orig_ccb;
18393393f8daSKenneth D. Merry 		}
18403393f8daSKenneth D. Merry 
18413393f8daSKenneth D. Merry sense_error_done:
18420181d54bSAlexander Motin 		*action = err_action;
18433393f8daSKenneth D. Merry 	}
18443393f8daSKenneth D. Merry 	return (error);
18453393f8daSKenneth D. Merry }
18463393f8daSKenneth D. Merry 
18473393f8daSKenneth D. Merry /*
18483393f8daSKenneth D. Merry  * Generic error handler.  Peripheral drivers usually filter
18491ffe5851SPedro F. Giffuni  * out the errors that they handle in a unique manner, then
18503393f8daSKenneth D. Merry  * call this function.
18513393f8daSKenneth D. Merry  */
18523393f8daSKenneth D. Merry int
18533393f8daSKenneth D. Merry cam_periph_error(union ccb *ccb, cam_flags camflags,
1854553484aeSWarner Losh 		 u_int32_t sense_flags)
18553393f8daSKenneth D. Merry {
18560181d54bSAlexander Motin 	struct cam_path *newpath;
18570181d54bSAlexander Motin 	union ccb  *orig_ccb, *scan_ccb;
1858a07e846bSAlexander Motin 	struct cam_periph *periph;
18593393f8daSKenneth D. Merry 	const char *action_string;
18603393f8daSKenneth D. Merry 	cam_status  status;
1861a30ecd42SScott Long 	int	    frozen, error, openings, devctl_err;
18620181d54bSAlexander Motin 	u_int32_t   action, relsim_flags, timeout;
18633393f8daSKenneth D. Merry 
18640181d54bSAlexander Motin 	action = SSQ_PRINT_SENSE;
1865a07e846bSAlexander Motin 	periph = xpt_path_periph(ccb->ccb_h.path);
18663393f8daSKenneth D. Merry 	action_string = NULL;
18673393f8daSKenneth D. Merry 	status = ccb->ccb_h.status;
18683393f8daSKenneth D. Merry 	frozen = (status & CAM_DEV_QFRZN) != 0;
18693393f8daSKenneth D. Merry 	status &= CAM_STATUS_MASK;
1870a30ecd42SScott Long 	devctl_err = openings = relsim_flags = timeout = 0;
18710191d9b3SAlexander Motin 	orig_ccb = ccb;
18723393f8daSKenneth D. Merry 
1873a30ecd42SScott Long 	/* Filter the errors that should be reported via devctl */
1874a30ecd42SScott Long 	switch (ccb->ccb_h.status & CAM_STATUS_MASK) {
1875a30ecd42SScott Long 	case CAM_CMD_TIMEOUT:
1876a30ecd42SScott Long 	case CAM_REQ_ABORTED:
1877a30ecd42SScott Long 	case CAM_REQ_CMP_ERR:
1878a30ecd42SScott Long 	case CAM_REQ_TERMIO:
1879a30ecd42SScott Long 	case CAM_UNREC_HBA_ERROR:
1880a30ecd42SScott Long 	case CAM_DATA_RUN_ERR:
1881a30ecd42SScott Long 	case CAM_SCSI_STATUS_ERROR:
1882a30ecd42SScott Long 	case CAM_ATA_STATUS_ERROR:
1883a30ecd42SScott Long 	case CAM_SMP_STATUS_ERROR:
1884a30ecd42SScott Long 		devctl_err++;
1885a30ecd42SScott Long 		break;
1886a30ecd42SScott Long 	default:
1887a30ecd42SScott Long 		break;
1888a30ecd42SScott Long 	}
1889a30ecd42SScott Long 
18903393f8daSKenneth D. Merry 	switch (status) {
18913393f8daSKenneth D. Merry 	case CAM_REQ_CMP:
18923393f8daSKenneth D. Merry 		error = 0;
18930181d54bSAlexander Motin 		action &= ~SSQ_PRINT_SENSE;
18943393f8daSKenneth D. Merry 		break;
18953393f8daSKenneth D. Merry 	case CAM_SCSI_STATUS_ERROR:
18960191d9b3SAlexander Motin 		error = camperiphscsistatuserror(ccb, &orig_ccb,
18970191d9b3SAlexander Motin 		    camflags, sense_flags, &openings, &relsim_flags,
18980181d54bSAlexander Motin 		    &timeout, &action, &action_string);
18993393f8daSKenneth D. Merry 		break;
19003393f8daSKenneth D. Merry 	case CAM_AUTOSENSE_FAIL:
1901c7ec4390SMatt Jacob 		error = EIO;	/* we have to kill the command */
1902c7ec4390SMatt Jacob 		break;
19038b8a9b1dSJustin T. Gibbs 	case CAM_UA_ABORT:
19048b8a9b1dSJustin T. Gibbs 	case CAM_UA_TERMIO:
19058b8a9b1dSJustin T. Gibbs 	case CAM_MSG_REJECT_REC:
19068b8a9b1dSJustin T. Gibbs 		/* XXX Don't know that these are correct */
19078b8a9b1dSJustin T. Gibbs 		error = EIO;
19088b8a9b1dSJustin T. Gibbs 		break;
19098b8a9b1dSJustin T. Gibbs 	case CAM_SEL_TIMEOUT:
19103393f8daSKenneth D. Merry 		if ((camflags & CAM_RETRY_SELTO) != 0) {
1911a07e846bSAlexander Motin 			if (ccb->ccb_h.retry_count > 0 &&
1912a07e846bSAlexander Motin 			    (periph->flags & CAM_PERIPH_INVALID) == 0) {
19133393f8daSKenneth D. Merry 				ccb->ccb_h.retry_count--;
19143393f8daSKenneth D. Merry 				error = ERESTART;
19153393f8daSKenneth D. Merry 
19163393f8daSKenneth D. Merry 				/*
191773cf209fSMatt Jacob 				 * Wait a bit to give the device
19183393f8daSKenneth D. Merry 				 * time to recover before we try again.
19193393f8daSKenneth D. Merry 				 */
19203393f8daSKenneth D. Merry 				relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
192173cf209fSMatt Jacob 				timeout = periph_selto_delay;
19223393f8daSKenneth D. Merry 				break;
19233393f8daSKenneth D. Merry 			}
1924a07e846bSAlexander Motin 			action_string = "Retries exhausted";
19253393f8daSKenneth D. Merry 		}
19268900f4b8SKenneth D. Merry 		/* FALLTHROUGH */
19278900f4b8SKenneth D. Merry 	case CAM_DEV_NOT_THERE:
19283393f8daSKenneth D. Merry 		error = ENXIO;
19290181d54bSAlexander Motin 		action = SSQ_LOST;
19308b8a9b1dSJustin T. Gibbs 		break;
19318b8a9b1dSJustin T. Gibbs 	case CAM_REQ_INVALID:
19328b8a9b1dSJustin T. Gibbs 	case CAM_PATH_INVALID:
19338b8a9b1dSJustin T. Gibbs 	case CAM_NO_HBA:
19348b8a9b1dSJustin T. Gibbs 	case CAM_PROVIDE_FAIL:
19358b8a9b1dSJustin T. Gibbs 	case CAM_REQ_TOO_BIG:
19369a014e6fSIan Dowse 	case CAM_LUN_INVALID:
19379a014e6fSIan Dowse 	case CAM_TID_INVALID:
1938357478a5SAlexander Motin 	case CAM_FUNC_NOTAVAIL:
19398b8a9b1dSJustin T. Gibbs 		error = EINVAL;
19408b8a9b1dSJustin T. Gibbs 		break;
19418b8a9b1dSJustin T. Gibbs 	case CAM_SCSI_BUS_RESET:
19428b8a9b1dSJustin T. Gibbs 	case CAM_BDR_SENT:
19433393f8daSKenneth D. Merry 		/*
19443393f8daSKenneth D. Merry 		 * Commands that repeatedly timeout and cause these
19453393f8daSKenneth D. Merry 		 * kinds of error recovery actions, should return
19463393f8daSKenneth D. Merry 		 * CAM_CMD_TIMEOUT, which allows us to safely assume
19473393f8daSKenneth D. Merry 		 * that this command was an innocent bystander to
19483393f8daSKenneth D. Merry 		 * these events and should be unconditionally
19493393f8daSKenneth D. Merry 		 * retried.
19503393f8daSKenneth D. Merry 		 */
19518b8a9b1dSJustin T. Gibbs 	case CAM_REQUEUE_REQ:
19520191d9b3SAlexander Motin 		/* Unconditional requeue if device is still there */
19530191d9b3SAlexander Motin 		if (periph->flags & CAM_PERIPH_INVALID) {
19540191d9b3SAlexander Motin 			action_string = "Periph was invalidated";
1955a07e846bSAlexander Motin 			error = EIO;
19560191d9b3SAlexander Motin 		} else if (sense_flags & SF_NO_RETRY) {
19570191d9b3SAlexander Motin 			error = EIO;
19580191d9b3SAlexander Motin 			action_string = "Retry was blocked";
195984c4de2dSAlexander Motin 		} else {
19600191d9b3SAlexander Motin 			error = ERESTART;
19610181d54bSAlexander Motin 			action &= ~SSQ_PRINT_SENSE;
196284c4de2dSAlexander Motin 		}
19638b8a9b1dSJustin T. Gibbs 		break;
19648b8a9b1dSJustin T. Gibbs 	case CAM_RESRC_UNAVAIL:
196573cf209fSMatt Jacob 		/* Wait a bit for the resource shortage to abate. */
196673cf209fSMatt Jacob 		timeout = periph_noresrc_delay;
196773cf209fSMatt Jacob 		/* FALLTHROUGH */
19688b8a9b1dSJustin T. Gibbs 	case CAM_BUSY:
196973cf209fSMatt Jacob 		if (timeout == 0) {
197073cf209fSMatt Jacob 			/* Wait a bit for the busy condition to abate. */
197173cf209fSMatt Jacob 			timeout = periph_busy_delay;
197273cf209fSMatt Jacob 		}
197373cf209fSMatt Jacob 		relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
197473cf209fSMatt Jacob 		/* FALLTHROUGH */
19750191d9b3SAlexander Motin 	case CAM_ATA_STATUS_ERROR:
19760191d9b3SAlexander Motin 	case CAM_REQ_CMP_ERR:
19770191d9b3SAlexander Motin 	case CAM_CMD_TIMEOUT:
19780191d9b3SAlexander Motin 	case CAM_UNEXP_BUSFREE:
19790191d9b3SAlexander Motin 	case CAM_UNCOR_PARITY:
19800191d9b3SAlexander Motin 	case CAM_DATA_RUN_ERR:
19818b8a9b1dSJustin T. Gibbs 	default:
19820191d9b3SAlexander Motin 		if (periph->flags & CAM_PERIPH_INVALID) {
19830191d9b3SAlexander Motin 			error = EIO;
19840191d9b3SAlexander Motin 			action_string = "Periph was invalidated";
19850191d9b3SAlexander Motin 		} else if (ccb->ccb_h.retry_count == 0) {
19868b8a9b1dSJustin T. Gibbs 			error = EIO;
198783c5d981SAlexander Motin 			action_string = "Retries exhausted";
19880191d9b3SAlexander Motin 		} else if (sense_flags & SF_NO_RETRY) {
19890191d9b3SAlexander Motin 			error = EIO;
19900191d9b3SAlexander Motin 			action_string = "Retry was blocked";
19910191d9b3SAlexander Motin 		} else {
19920191d9b3SAlexander Motin 			ccb->ccb_h.retry_count--;
19930191d9b3SAlexander Motin 			error = ERESTART;
19948b8a9b1dSJustin T. Gibbs 		}
19958b8a9b1dSJustin T. Gibbs 		break;
19968b8a9b1dSJustin T. Gibbs 	}
19978b8a9b1dSJustin T. Gibbs 
19980191d9b3SAlexander Motin 	if ((sense_flags & SF_PRINT_ALWAYS) ||
19990191d9b3SAlexander Motin 	    CAM_DEBUGGED(ccb->ccb_h.path, CAM_DEBUG_INFO))
20000181d54bSAlexander Motin 		action |= SSQ_PRINT_SENSE;
20010191d9b3SAlexander Motin 	else if (sense_flags & SF_NO_PRINT)
20020181d54bSAlexander Motin 		action &= ~SSQ_PRINT_SENSE;
20030181d54bSAlexander Motin 	if ((action & SSQ_PRINT_SENSE) != 0)
20040191d9b3SAlexander Motin 		cam_error_print(orig_ccb, CAM_ESF_ALL, CAM_EPF_ALL);
20050181d54bSAlexander Motin 	if (error != 0 && (action & SSQ_PRINT_SENSE) != 0) {
20060f3e2159SAlexander Motin 		if (error != ERESTART) {
20073393f8daSKenneth D. Merry 			if (action_string == NULL)
200883c5d981SAlexander Motin 				action_string = "Unretryable error";
200983c5d981SAlexander Motin 			xpt_print(ccb->ccb_h.path, "Error %d, %s\n",
201083c5d981SAlexander Motin 			    error, action_string);
201183c5d981SAlexander Motin 		} else if (action_string != NULL)
2012f0d9af51SMatt Jacob 			xpt_print(ccb->ccb_h.path, "%s\n", action_string);
2013bc40691eSWarner Losh 		else {
2014bc40691eSWarner Losh 			xpt_print(ccb->ccb_h.path,
2015bc40691eSWarner Losh 			    "Retrying command, %d more tries remain\n",
2016bc40691eSWarner Losh 			    ccb->ccb_h.retry_count);
2017bc40691eSWarner Losh 		}
20180f3e2159SAlexander Motin 	}
20190f3e2159SAlexander Motin 
2020cd375264SAlexander Motin 	if (devctl_err && (error != 0 || (action & SSQ_PRINT_SENSE) != 0))
2021a30ecd42SScott Long 		cam_periph_devctl_notify(orig_ccb);
2022a30ecd42SScott Long 
20230181d54bSAlexander Motin 	if ((action & SSQ_LOST) != 0) {
20240191d9b3SAlexander Motin 		lun_id_t lun_id;
20250191d9b3SAlexander Motin 
20260191d9b3SAlexander Motin 		/*
20270191d9b3SAlexander Motin 		 * For a selection timeout, we consider all of the LUNs on
20280191d9b3SAlexander Motin 		 * the target to be gone.  If the status is CAM_DEV_NOT_THERE,
20290191d9b3SAlexander Motin 		 * then we only get rid of the device(s) specified by the
20300191d9b3SAlexander Motin 		 * path in the original CCB.
20310191d9b3SAlexander Motin 		 */
20320181d54bSAlexander Motin 		if (status == CAM_SEL_TIMEOUT)
20330191d9b3SAlexander Motin 			lun_id = CAM_LUN_WILDCARD;
20340181d54bSAlexander Motin 		else
20350181d54bSAlexander Motin 			lun_id = xpt_path_lun_id(ccb->ccb_h.path);
20360191d9b3SAlexander Motin 
20370191d9b3SAlexander Motin 		/* Should we do more if we can't create the path?? */
20380191d9b3SAlexander Motin 		if (xpt_create_path(&newpath, periph,
20390191d9b3SAlexander Motin 				    xpt_path_path_id(ccb->ccb_h.path),
20400191d9b3SAlexander Motin 				    xpt_path_target_id(ccb->ccb_h.path),
20410191d9b3SAlexander Motin 				    lun_id) == CAM_REQ_CMP) {
20420191d9b3SAlexander Motin 
20430191d9b3SAlexander Motin 			/*
20440191d9b3SAlexander Motin 			 * Let peripheral drivers know that this
20450191d9b3SAlexander Motin 			 * device has gone away.
20460191d9b3SAlexander Motin 			 */
20470191d9b3SAlexander Motin 			xpt_async(AC_LOST_DEVICE, newpath, NULL);
20480191d9b3SAlexander Motin 			xpt_free_path(newpath);
20490191d9b3SAlexander Motin 		}
20500181d54bSAlexander Motin 	}
20513631c638SAlexander Motin 
20523631c638SAlexander Motin 	/* Broadcast UNIT ATTENTIONs to all periphs. */
20530181d54bSAlexander Motin 	if ((action & SSQ_UA) != 0)
20543631c638SAlexander Motin 		xpt_async(AC_UNIT_ATTENTION, orig_ccb->ccb_h.path, orig_ccb);
20550181d54bSAlexander Motin 
20560181d54bSAlexander Motin 	/* Rescan target on "Reported LUNs data has changed" */
20570181d54bSAlexander Motin 	if ((action & SSQ_RESCAN) != 0) {
20580181d54bSAlexander Motin 		if (xpt_create_path(&newpath, NULL,
20590181d54bSAlexander Motin 				    xpt_path_path_id(ccb->ccb_h.path),
20600181d54bSAlexander Motin 				    xpt_path_target_id(ccb->ccb_h.path),
2061e5736ac8SAlexander Motin 				    CAM_LUN_WILDCARD) == CAM_REQ_CMP) {
20620181d54bSAlexander Motin 
20630181d54bSAlexander Motin 			scan_ccb = xpt_alloc_ccb_nowait();
2064e5736ac8SAlexander Motin 			if (scan_ccb != NULL) {
20650181d54bSAlexander Motin 				scan_ccb->ccb_h.path = newpath;
2066e5736ac8SAlexander Motin 				scan_ccb->ccb_h.func_code = XPT_SCAN_TGT;
20670181d54bSAlexander Motin 				scan_ccb->crcn.flags = 0;
20680181d54bSAlexander Motin 				xpt_rescan(scan_ccb);
20693231e8bdSAlexander Motin 			} else {
2070e5736ac8SAlexander Motin 				xpt_print(newpath,
2071e5736ac8SAlexander Motin 				    "Can't allocate CCB to rescan target\n");
20723231e8bdSAlexander Motin 				xpt_free_path(newpath);
20733231e8bdSAlexander Motin 			}
20740181d54bSAlexander Motin 		}
20750191d9b3SAlexander Motin 	}
20760191d9b3SAlexander Motin 
20770f3e2159SAlexander Motin 	/* Attempt a retry */
20780f3e2159SAlexander Motin 	if (error == ERESTART || error == 0) {
20790f3e2159SAlexander Motin 		if (frozen != 0)
20800f3e2159SAlexander Motin 			ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
20810f3e2159SAlexander Motin 		if (error == ERESTART)
20820f3e2159SAlexander Motin 			xpt_action(ccb);
20830f3e2159SAlexander Motin 		if (frozen != 0)
20840f3e2159SAlexander Motin 			cam_release_devq(ccb->ccb_h.path,
20850f3e2159SAlexander Motin 					 relsim_flags,
20860f3e2159SAlexander Motin 					 openings,
20870f3e2159SAlexander Motin 					 timeout,
20880f3e2159SAlexander Motin 					 /*getcount_only*/0);
20893393f8daSKenneth D. Merry 	}
20908b8a9b1dSJustin T. Gibbs 
20918b8a9b1dSJustin T. Gibbs 	return (error);
20928b8a9b1dSJustin T. Gibbs }
2093a30ecd42SScott Long 
2094a30ecd42SScott Long #define CAM_PERIPH_DEVD_MSG_SIZE	256
2095a30ecd42SScott Long 
2096a30ecd42SScott Long static void
2097a30ecd42SScott Long cam_periph_devctl_notify(union ccb *ccb)
2098a30ecd42SScott Long {
2099a30ecd42SScott Long 	struct cam_periph *periph;
2100a30ecd42SScott Long 	struct ccb_getdev *cgd;
2101a30ecd42SScott Long 	struct sbuf sb;
2102a30ecd42SScott Long 	int serr, sk, asc, ascq;
2103a30ecd42SScott Long 	char *sbmsg, *type;
2104a30ecd42SScott Long 
2105a30ecd42SScott Long 	sbmsg = malloc(CAM_PERIPH_DEVD_MSG_SIZE, M_CAMPERIPH, M_NOWAIT);
2106a30ecd42SScott Long 	if (sbmsg == NULL)
2107a30ecd42SScott Long 		return;
2108a30ecd42SScott Long 
2109a30ecd42SScott Long 	sbuf_new(&sb, sbmsg, CAM_PERIPH_DEVD_MSG_SIZE, SBUF_FIXEDLEN);
2110a30ecd42SScott Long 
2111a30ecd42SScott Long 	periph = xpt_path_periph(ccb->ccb_h.path);
2112a30ecd42SScott Long 	sbuf_printf(&sb, "device=%s%d ", periph->periph_name,
2113a30ecd42SScott Long 	    periph->unit_number);
2114a30ecd42SScott Long 
2115a30ecd42SScott Long 	sbuf_printf(&sb, "serial=\"");
2116a30ecd42SScott Long 	if ((cgd = (struct ccb_getdev *)xpt_alloc_ccb_nowait()) != NULL) {
2117a30ecd42SScott Long 		xpt_setup_ccb(&cgd->ccb_h, ccb->ccb_h.path,
2118a30ecd42SScott Long 		    CAM_PRIORITY_NORMAL);
2119a30ecd42SScott Long 		cgd->ccb_h.func_code = XPT_GDEV_TYPE;
2120a30ecd42SScott Long 		xpt_action((union ccb *)cgd);
2121a30ecd42SScott Long 
2122a30ecd42SScott Long 		if (cgd->ccb_h.status == CAM_REQ_CMP)
2123a30ecd42SScott Long 			sbuf_bcat(&sb, cgd->serial_num, cgd->serial_num_len);
2124de482e7bSScott Long 		xpt_free_ccb((union ccb *)cgd);
2125a30ecd42SScott Long 	}
2126a30ecd42SScott Long 	sbuf_printf(&sb, "\" ");
2127a30ecd42SScott Long 	sbuf_printf(&sb, "cam_status=\"0x%x\" ", ccb->ccb_h.status);
2128a30ecd42SScott Long 
2129a30ecd42SScott Long 	switch (ccb->ccb_h.status & CAM_STATUS_MASK) {
2130a30ecd42SScott Long 	case CAM_CMD_TIMEOUT:
2131a30ecd42SScott Long 		sbuf_printf(&sb, "timeout=%d ", ccb->ccb_h.timeout);
2132a30ecd42SScott Long 		type = "timeout";
2133a30ecd42SScott Long 		break;
2134a30ecd42SScott Long 	case CAM_SCSI_STATUS_ERROR:
2135a30ecd42SScott Long 		sbuf_printf(&sb, "scsi_status=%d ", ccb->csio.scsi_status);
2136a30ecd42SScott Long 		if (scsi_extract_sense_ccb(ccb, &serr, &sk, &asc, &ascq))
2137a30ecd42SScott Long 			sbuf_printf(&sb, "scsi_sense=\"%02x %02x %02x %02x\" ",
2138a30ecd42SScott Long 			    serr, sk, asc, ascq);
2139a30ecd42SScott Long 		type = "error";
2140a30ecd42SScott Long 		break;
2141a30ecd42SScott Long 	case CAM_ATA_STATUS_ERROR:
2142a30ecd42SScott Long 		sbuf_printf(&sb, "RES=\"");
2143a30ecd42SScott Long 		ata_res_sbuf(&ccb->ataio.res, &sb);
2144a30ecd42SScott Long 		sbuf_printf(&sb, "\" ");
2145a30ecd42SScott Long 		type = "error";
2146a30ecd42SScott Long 		break;
2147a30ecd42SScott Long 	default:
2148a30ecd42SScott Long 		type = "error";
2149a30ecd42SScott Long 		break;
2150a30ecd42SScott Long 	}
2151a30ecd42SScott Long 
2152a30ecd42SScott Long 	if (ccb->ccb_h.func_code == XPT_SCSI_IO) {
2153a30ecd42SScott Long 		sbuf_printf(&sb, "CDB=\"");
21544902e14dSAlexander Motin 		scsi_cdb_sbuf(scsiio_cdb_ptr(&ccb->csio), &sb);
2155a30ecd42SScott Long 		sbuf_printf(&sb, "\" ");
2156a30ecd42SScott Long 	} else if (ccb->ccb_h.func_code == XPT_ATA_IO) {
2157a30ecd42SScott Long 		sbuf_printf(&sb, "ACB=\"");
2158a30ecd42SScott Long 		ata_cmd_sbuf(&ccb->ataio.cmd, &sb);
2159a30ecd42SScott Long 		sbuf_printf(&sb, "\" ");
2160a30ecd42SScott Long 	}
2161a30ecd42SScott Long 
2162a30ecd42SScott Long 	if (sbuf_finish(&sb) == 0)
2163a30ecd42SScott Long 		devctl_notify("CAM", "periph", type, sbuf_data(&sb));
2164a30ecd42SScott Long 	sbuf_delete(&sb);
2165a30ecd42SScott Long 	free(sbmsg, M_CAMPERIPH);
2166a30ecd42SScott Long }
2167a30ecd42SScott Long 
2168d38677d2SWarner Losh /*
2169d38677d2SWarner Losh  * Sysctl to force an invalidation of the drive right now. Can be
2170d38677d2SWarner Losh  * called with CTLFLAG_MPSAFE since we take periph lock.
2171d38677d2SWarner Losh  */
2172d38677d2SWarner Losh int
2173d38677d2SWarner Losh cam_periph_invalidate_sysctl(SYSCTL_HANDLER_ARGS)
2174d38677d2SWarner Losh {
2175d38677d2SWarner Losh 	struct cam_periph *periph;
2176d38677d2SWarner Losh 	int error, value;
2177d38677d2SWarner Losh 
2178d38677d2SWarner Losh 	periph = arg1;
2179d38677d2SWarner Losh 	value = 0;
2180d38677d2SWarner Losh 	error = sysctl_handle_int(oidp, &value, 0, req);
2181d38677d2SWarner Losh 	if (error != 0 || req->newptr == NULL || value != 1)
2182d38677d2SWarner Losh 		return (error);
2183d38677d2SWarner Losh 
2184d38677d2SWarner Losh 	cam_periph_lock(periph);
2185d38677d2SWarner Losh 	cam_periph_invalidate(periph);
2186d38677d2SWarner Losh 	cam_periph_unlock(periph);
2187d38677d2SWarner Losh 
2188d38677d2SWarner Losh 	return (0);
2189d38677d2SWarner Losh }
2190