xref: /freebsd/sys/cam/ctl/scsi_ctl.c (revision 41059135ce931c0f1014a999ffabc6bc470ce856)
1 /*-
2  * Copyright (c) 2008, 2009 Silicon Graphics International Corp.
3  * Copyright (c) 2014-2015 Alexander Motin <mav@FreeBSD.org>
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions, and the following disclaimer,
11  *    without modification.
12  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
13  *    substantially similar to the "NO WARRANTY" disclaimer below
14  *    ("Disclaimer") and any redistribution must be conditioned upon
15  *    including a substantially similar Disclaimer requirement for further
16  *    binary redistribution.
17  *
18  * NO WARRANTY
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
28  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGES.
30  *
31  * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/scsi_ctl.c#4 $
32  */
33 /*
34  * Peripheral driver interface between CAM and CTL (CAM Target Layer).
35  *
36  * Author: Ken Merry <ken@FreeBSD.org>
37  */
38 
39 #include <sys/cdefs.h>
40 __FBSDID("$FreeBSD$");
41 
42 #include <sys/param.h>
43 #include <sys/queue.h>
44 #include <sys/systm.h>
45 #include <sys/kernel.h>
46 #include <sys/lock.h>
47 #include <sys/mutex.h>
48 #include <sys/condvar.h>
49 #include <sys/malloc.h>
50 #include <sys/bus.h>
51 #include <sys/endian.h>
52 #include <sys/sbuf.h>
53 #include <sys/sysctl.h>
54 #include <sys/types.h>
55 #include <sys/systm.h>
56 #include <sys/taskqueue.h>
57 #include <machine/bus.h>
58 
59 #include <cam/cam.h>
60 #include <cam/cam_ccb.h>
61 #include <cam/cam_periph.h>
62 #include <cam/cam_queue.h>
63 #include <cam/cam_xpt_periph.h>
64 #include <cam/cam_debug.h>
65 #include <cam/cam_sim.h>
66 #include <cam/cam_xpt.h>
67 
68 #include <cam/scsi/scsi_all.h>
69 #include <cam/scsi/scsi_message.h>
70 
71 #include <cam/ctl/ctl_io.h>
72 #include <cam/ctl/ctl.h>
73 #include <cam/ctl/ctl_frontend.h>
74 #include <cam/ctl/ctl_util.h>
75 #include <cam/ctl/ctl_error.h>
76 
77 struct ctlfe_softc {
78 	struct ctl_port	port;
79 	path_id_t	path_id;
80 	target_id_t	target_id;
81 	uint32_t	hba_misc;
82 	u_int		maxio;
83 	struct cam_sim *sim;
84 	char		port_name[DEV_IDLEN];
85 	struct mtx	lun_softc_mtx;
86 	STAILQ_HEAD(, ctlfe_lun_softc) lun_softc_list;
87 	STAILQ_ENTRY(ctlfe_softc) links;
88 };
89 
90 STAILQ_HEAD(, ctlfe_softc) ctlfe_softc_list;
91 struct mtx ctlfe_list_mtx;
92 static char ctlfe_mtx_desc[] = "ctlfelist";
93 
94 typedef enum {
95 	CTLFE_LUN_NONE		= 0x00,
96 	CTLFE_LUN_WILDCARD	= 0x01
97 } ctlfe_lun_flags;
98 
99 struct ctlfe_lun_softc {
100 	struct ctlfe_softc *parent_softc;
101 	struct cam_periph *periph;
102 	ctlfe_lun_flags flags;
103 	int	 ctios_sent;		/* Number of active CTIOs */
104 	int	 refcount;		/* Number of active xpt_action() */
105 	int	 atios_alloced;		/* Number of ATIOs not freed */
106 	int	 inots_alloced;		/* Number of INOTs not freed */
107 	struct task	refdrain_task;
108 	STAILQ_HEAD(, ccb_hdr) work_queue;
109 	LIST_HEAD(, ccb_hdr) atio_list;	/* List of ATIOs queued to SIM. */
110 	LIST_HEAD(, ccb_hdr) inot_list;	/* List of INOTs queued to SIM. */
111 	STAILQ_ENTRY(ctlfe_lun_softc) links;
112 };
113 
114 typedef enum {
115 	CTLFE_CMD_NONE		= 0x00,
116 	CTLFE_CMD_PIECEWISE	= 0x01
117 } ctlfe_cmd_flags;
118 
119 struct ctlfe_cmd_info {
120 	int cur_transfer_index;
121 	size_t cur_transfer_off;
122 	ctlfe_cmd_flags flags;
123 	/*
124 	 * XXX KDM struct bus_dma_segment is 8 bytes on i386, and 16
125 	 * bytes on amd64.  So with 32 elements, this is 256 bytes on
126 	 * i386 and 512 bytes on amd64.
127 	 */
128 #define CTLFE_MAX_SEGS	32
129 	bus_dma_segment_t cam_sglist[CTLFE_MAX_SEGS];
130 };
131 
132 /*
133  * When we register the adapter/bus, request that this many ctl_ios be
134  * allocated.  This should be the maximum supported by the adapter, but we
135  * currently don't have a way to get that back from the path inquiry.
136  * XXX KDM add that to the path inquiry.
137  */
138 #define	CTLFE_REQ_CTL_IO	4096
139 /*
140  * Number of Accept Target I/O CCBs to allocate and queue down to the
141  * adapter per LUN.
142  * XXX KDM should this be controlled by CTL?
143  */
144 #define	CTLFE_ATIO_PER_LUN	1024
145 /*
146  * Number of Immediate Notify CCBs (used for aborts, resets, etc.) to
147  * allocate and queue down to the adapter per LUN.
148  * XXX KDM should this be controlled by CTL?
149  */
150 #define	CTLFE_IN_PER_LUN	1024
151 
152 /*
153  * Timeout (in seconds) on CTIO CCB doing DMA or sending status
154  */
155 #define	CTLFE_TIMEOUT	5
156 
157 /*
158  * Turn this on to enable extra debugging prints.
159  */
160 #if 0
161 #define	CTLFE_DEBUG
162 #endif
163 
164 MALLOC_DEFINE(M_CTLFE, "CAM CTL FE", "CAM CTL FE interface");
165 
166 #define	io_ptr		ppriv_ptr0
167 
168 /* This is only used in the CTIO */
169 #define	ccb_atio	ppriv_ptr1
170 
171 #define PRIV_CCB(io)	((io)->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptrs[0])
172 #define PRIV_INFO(io)	((io)->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptrs[1])
173 
174 static int		ctlfeinitialize(void);
175 static int		ctlfeshutdown(void);
176 static periph_init_t	ctlfeperiphinit;
177 static periph_deinit_t	ctlfeperiphdeinit;
178 static void		ctlfeasync(void *callback_arg, uint32_t code,
179 				   struct cam_path *path, void *arg);
180 static periph_ctor_t	ctlferegister;
181 static periph_oninv_t	ctlfeoninvalidate;
182 static periph_dtor_t	ctlfecleanup;
183 static periph_start_t	ctlfestart;
184 static void		ctlfedone(struct cam_periph *periph,
185 				  union ccb *done_ccb);
186 
187 static void 		ctlfe_onoffline(void *arg, int online);
188 static void 		ctlfe_online(void *arg);
189 static void 		ctlfe_offline(void *arg);
190 static int 		ctlfe_lun_enable(void *arg, int lun_id);
191 static int 		ctlfe_lun_disable(void *arg, int lun_id);
192 static void		ctlfe_dump_sim(struct cam_sim *sim);
193 static void		ctlfe_dump_queue(struct ctlfe_lun_softc *softc);
194 static void 		ctlfe_datamove(union ctl_io *io);
195 static void 		ctlfe_done(union ctl_io *io);
196 static void 		ctlfe_dump(void);
197 static void		ctlfe_free_ccb(struct cam_periph *periph,
198 			    union ccb *ccb);
199 static void		ctlfe_requeue_ccb(struct cam_periph *periph,
200 			    union ccb *ccb, int unlock);
201 
202 static struct periph_driver ctlfe_driver =
203 {
204 	ctlfeperiphinit, "ctl",
205 	TAILQ_HEAD_INITIALIZER(ctlfe_driver.units), /*generation*/ 0,
206 	CAM_PERIPH_DRV_EARLY,
207 	ctlfeperiphdeinit
208 };
209 
210 static struct ctl_frontend ctlfe_frontend =
211 {
212 	.name = "camtgt",
213 	.init = ctlfeinitialize,
214 	.fe_dump = ctlfe_dump,
215 	.shutdown = ctlfeshutdown,
216 };
217 CTL_FRONTEND_DECLARE(ctlfe, ctlfe_frontend);
218 
219 static int
220 ctlfeinitialize(void)
221 {
222 
223 	STAILQ_INIT(&ctlfe_softc_list);
224 	mtx_init(&ctlfe_list_mtx, ctlfe_mtx_desc, NULL, MTX_DEF);
225 	periphdriver_register(&ctlfe_driver);
226 	return (0);
227 }
228 
229 static int
230 ctlfeshutdown(void)
231 {
232 	int error;
233 
234 	error = periphdriver_unregister(&ctlfe_driver);
235 	if (error != 0)
236 		return (error);
237 	mtx_destroy(&ctlfe_list_mtx);
238 	return (0);
239 }
240 
241 static void
242 ctlfeperiphinit(void)
243 {
244 	cam_status status;
245 
246 	status = xpt_register_async(AC_PATH_REGISTERED | AC_PATH_DEREGISTERED |
247 				    AC_CONTRACT, ctlfeasync, NULL, NULL);
248 	if (status != CAM_REQ_CMP) {
249 		printf("ctl: Failed to attach async callback due to CAM "
250 		       "status 0x%x!\n", status);
251 	}
252 }
253 
254 static int
255 ctlfeperiphdeinit(void)
256 {
257 
258 	/* XXX: It would be good to tear down active ports here. */
259 	if (!TAILQ_EMPTY(&ctlfe_driver.units))
260 		return (EBUSY);
261 	xpt_register_async(0, ctlfeasync, NULL, NULL);
262 	return (0);
263 }
264 
265 static void
266 ctlfeasync(void *callback_arg, uint32_t code, struct cam_path *path, void *arg)
267 {
268 	struct ctlfe_softc *softc;
269 
270 #ifdef CTLFEDEBUG
271 	printf("%s: entered\n", __func__);
272 #endif
273 
274 	mtx_lock(&ctlfe_list_mtx);
275 	STAILQ_FOREACH(softc, &ctlfe_softc_list, links) {
276 		if (softc->path_id == xpt_path_path_id(path))
277 			break;
278 	}
279 	mtx_unlock(&ctlfe_list_mtx);
280 
281 	/*
282 	 * When a new path gets registered, and it is capable of target
283 	 * mode, go ahead and attach.  Later on, we may need to be more
284 	 * selective, but for now this will be sufficient.
285  	 */
286 	switch (code) {
287 	case AC_PATH_REGISTERED: {
288 		struct ctl_port *port;
289 		struct ccb_pathinq *cpi;
290 		int retval;
291 
292 		cpi = (struct ccb_pathinq *)arg;
293 
294 		/* Don't attach if it doesn't support target mode */
295 		if ((cpi->target_sprt & PIT_PROCESSOR) == 0) {
296 #ifdef CTLFEDEBUG
297 			printf("%s: SIM %s%d doesn't support target mode\n",
298 			       __func__, cpi->dev_name, cpi->unit_number);
299 #endif
300 			break;
301 		}
302 
303 		if (softc != NULL) {
304 #ifdef CTLFEDEBUG
305 			printf("%s: CTL port for CAM path %u already exists\n",
306 			       __func__, xpt_path_path_id(path));
307 #endif
308 			break;
309 		}
310 
311 		/*
312 		 * We're in an interrupt context here, so we have to
313 		 * use M_NOWAIT.  Of course this means trouble if we
314 		 * can't allocate memory.
315 		 */
316 		softc = malloc(sizeof(*softc), M_CTLFE, M_NOWAIT | M_ZERO);
317 		if (softc == NULL) {
318 			printf("%s: unable to malloc %zd bytes for softc\n",
319 			       __func__, sizeof(*softc));
320 			return;
321 		}
322 
323 		softc->path_id = cpi->ccb_h.path_id;
324 		softc->target_id = cpi->initiator_id;
325 		softc->sim = xpt_path_sim(path);
326 		softc->hba_misc = cpi->hba_misc;
327 		if (cpi->maxio != 0)
328 			softc->maxio = cpi->maxio;
329 		else
330 			softc->maxio = DFLTPHYS;
331 		mtx_init(&softc->lun_softc_mtx, "LUN softc mtx", NULL, MTX_DEF);
332 		STAILQ_INIT(&softc->lun_softc_list);
333 
334 		port = &softc->port;
335 		port->frontend = &ctlfe_frontend;
336 
337 		/*
338 		 * XXX KDM should we be more accurate here ?
339 		 */
340 		if (cpi->transport == XPORT_FC)
341 			port->port_type = CTL_PORT_FC;
342 		else if (cpi->transport == XPORT_SAS)
343 			port->port_type = CTL_PORT_SAS;
344 		else
345 			port->port_type = CTL_PORT_SCSI;
346 
347 		/* XXX KDM what should the real number be here? */
348 		port->num_requested_ctl_io = CTLFE_REQ_CTL_IO;
349 		snprintf(softc->port_name, sizeof(softc->port_name),
350 			 "%s%d", cpi->dev_name, cpi->unit_number);
351 		/*
352 		 * XXX KDM it would be nice to allocate storage in the
353 		 * frontend structure itself.
354 	 	 */
355 		port->port_name = softc->port_name;
356 		port->physical_port = cpi->bus_id;
357 		port->virtual_port = 0;
358 		port->port_online = ctlfe_online;
359 		port->port_offline = ctlfe_offline;
360 		port->onoff_arg = softc;
361 		port->lun_enable = ctlfe_lun_enable;
362 		port->lun_disable = ctlfe_lun_disable;
363 		port->targ_lun_arg = softc;
364 		port->fe_datamove = ctlfe_datamove;
365 		port->fe_done = ctlfe_done;
366 		port->targ_port = -1;
367 
368 		retval = ctl_port_register(port);
369 		if (retval != 0) {
370 			printf("%s: ctl_port_register() failed with "
371 			       "error %d!\n", __func__, retval);
372 			mtx_destroy(&softc->lun_softc_mtx);
373 			free(softc, M_CTLFE);
374 			break;
375 		} else {
376 			mtx_lock(&ctlfe_list_mtx);
377 			STAILQ_INSERT_TAIL(&ctlfe_softc_list, softc, links);
378 			mtx_unlock(&ctlfe_list_mtx);
379 		}
380 
381 		break;
382 	}
383 	case AC_PATH_DEREGISTERED: {
384 
385 		if (softc != NULL) {
386 			/*
387 			 * XXX KDM are we certain at this point that there
388 			 * are no outstanding commands for this frontend?
389 			 */
390 			mtx_lock(&ctlfe_list_mtx);
391 			STAILQ_REMOVE(&ctlfe_softc_list, softc, ctlfe_softc,
392 			    links);
393 			mtx_unlock(&ctlfe_list_mtx);
394 			ctl_port_deregister(&softc->port);
395 			mtx_destroy(&softc->lun_softc_mtx);
396 			free(softc, M_CTLFE);
397 		}
398 		break;
399 	}
400 	case AC_CONTRACT: {
401 		struct ac_contract *ac;
402 
403 		ac = (struct ac_contract *)arg;
404 
405 		switch (ac->contract_number) {
406 		case AC_CONTRACT_DEV_CHG: {
407 			struct ac_device_changed *dev_chg;
408 			int retval;
409 
410 			dev_chg = (struct ac_device_changed *)ac->contract_data;
411 
412 			printf("%s: WWPN %#jx port 0x%06x path %u target %u %s\n",
413 			       __func__, dev_chg->wwpn, dev_chg->port,
414 			       xpt_path_path_id(path), dev_chg->target,
415 			       (dev_chg->arrived == 0) ?  "left" : "arrived");
416 
417 			if (softc == NULL) {
418 				printf("%s: CTL port for CAM path %u not "
419 				       "found!\n", __func__,
420 				       xpt_path_path_id(path));
421 				break;
422 			}
423 			if (dev_chg->arrived != 0) {
424 				retval = ctl_add_initiator(&softc->port,
425 				    dev_chg->target, dev_chg->wwpn, NULL);
426 			} else {
427 				retval = ctl_remove_initiator(&softc->port,
428 				    dev_chg->target);
429 			}
430 
431 			if (retval < 0) {
432 				printf("%s: could not %s port %d iid %u "
433 				       "WWPN %#jx!\n", __func__,
434 				       (dev_chg->arrived != 0) ? "add" :
435 				       "remove", softc->port.targ_port,
436 				       dev_chg->target,
437 				       (uintmax_t)dev_chg->wwpn);
438 			}
439 			break;
440 		}
441 		default:
442 			printf("%s: unsupported contract number %ju\n",
443 			       __func__, (uintmax_t)ac->contract_number);
444 			break;
445 		}
446 		break;
447 	}
448 	default:
449 		break;
450 	}
451 }
452 
453 static cam_status
454 ctlferegister(struct cam_periph *periph, void *arg)
455 {
456 	struct ctlfe_softc *bus_softc;
457 	struct ctlfe_lun_softc *softc;
458 	union ccb ccb;
459 	cam_status status;
460 	int i;
461 
462 	softc = (struct ctlfe_lun_softc *)arg;
463 	bus_softc = softc->parent_softc;
464 
465 	STAILQ_INIT(&softc->work_queue);
466 	LIST_INIT(&softc->atio_list);
467 	LIST_INIT(&softc->inot_list);
468 	softc->periph = periph;
469 	periph->softc = softc;
470 
471 	/* Increase device openings to maximum for the SIM. */
472 	if (bus_softc->sim->max_tagged_dev_openings >
473 	    bus_softc->sim->max_dev_openings) {
474 		cam_release_devq(periph->path,
475 		    /*relsim_flags*/RELSIM_ADJUST_OPENINGS,
476 		    /*openings*/bus_softc->sim->max_tagged_dev_openings,
477 		    /*timeout*/0,
478 		    /*getcount_only*/1);
479 	}
480 
481 	xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NONE);
482 	ccb.ccb_h.func_code = XPT_EN_LUN;
483 	ccb.cel.grp6_len = 0;
484 	ccb.cel.grp7_len = 0;
485 	ccb.cel.enable = 1;
486 	xpt_action(&ccb);
487 	status = (ccb.ccb_h.status & CAM_STATUS_MASK);
488 	if (status != CAM_REQ_CMP) {
489 		xpt_print(periph->path, "%s: Enable LUN failed, status 0x%x\n",
490 			  __func__, ccb.ccb_h.status);
491 		return (status);
492 	}
493 
494 	status = CAM_REQ_CMP;
495 
496 	for (i = 0; i < CTLFE_ATIO_PER_LUN; i++) {
497 		union ccb *new_ccb;
498 		union ctl_io *new_io;
499 		struct ctlfe_cmd_info *cmd_info;
500 
501 		new_ccb = (union ccb *)malloc(sizeof(*new_ccb), M_CTLFE,
502 					      M_ZERO|M_NOWAIT);
503 		if (new_ccb == NULL) {
504 			status = CAM_RESRC_UNAVAIL;
505 			break;
506 		}
507 		new_io = ctl_alloc_io_nowait(bus_softc->port.ctl_pool_ref);
508 		if (new_io == NULL) {
509 			free(new_ccb, M_CTLFE);
510 			status = CAM_RESRC_UNAVAIL;
511 			break;
512 		}
513 		cmd_info = malloc(sizeof(*cmd_info), M_CTLFE,
514 		    M_ZERO | M_NOWAIT);
515 		if (cmd_info == NULL) {
516 			ctl_free_io(new_io);
517 			free(new_ccb, M_CTLFE);
518 			status = CAM_RESRC_UNAVAIL;
519 			break;
520 		}
521 		PRIV_INFO(new_io) = cmd_info;
522 		softc->atios_alloced++;
523 		new_ccb->ccb_h.io_ptr = new_io;
524 		LIST_INSERT_HEAD(&softc->atio_list, &new_ccb->ccb_h, periph_links.le);
525 
526 		xpt_setup_ccb(&new_ccb->ccb_h, periph->path, /*priority*/ 1);
527 		new_ccb->ccb_h.func_code = XPT_ACCEPT_TARGET_IO;
528 		new_ccb->ccb_h.cbfcnp = ctlfedone;
529 		new_ccb->ccb_h.flags |= CAM_UNLOCKED;
530 		xpt_action(new_ccb);
531 		status = new_ccb->ccb_h.status;
532 		if ((status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
533 			free(cmd_info, M_CTLFE);
534 			ctl_free_io(new_io);
535 			free(new_ccb, M_CTLFE);
536 			break;
537 		}
538 	}
539 
540 	status = cam_periph_acquire(periph);
541 	if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
542 		xpt_print(periph->path, "%s: could not acquire reference "
543 			  "count, status = %#x\n", __func__, status);
544 		return (status);
545 	}
546 
547 	if (i == 0) {
548 		xpt_print(periph->path, "%s: could not allocate ATIO CCBs, "
549 			  "status 0x%x\n", __func__, status);
550 		return (CAM_REQ_CMP_ERR);
551 	}
552 
553 	for (i = 0; i < CTLFE_IN_PER_LUN; i++) {
554 		union ccb *new_ccb;
555 		union ctl_io *new_io;
556 
557 		new_ccb = (union ccb *)malloc(sizeof(*new_ccb), M_CTLFE,
558 					      M_ZERO|M_NOWAIT);
559 		if (new_ccb == NULL) {
560 			status = CAM_RESRC_UNAVAIL;
561 			break;
562 		}
563 		new_io = ctl_alloc_io_nowait(bus_softc->port.ctl_pool_ref);
564 		if (new_io == NULL) {
565 			free(new_ccb, M_CTLFE);
566 			status = CAM_RESRC_UNAVAIL;
567 			break;
568 		}
569 		softc->inots_alloced++;
570 		new_ccb->ccb_h.io_ptr = new_io;
571 		LIST_INSERT_HEAD(&softc->inot_list, &new_ccb->ccb_h, periph_links.le);
572 
573 		xpt_setup_ccb(&new_ccb->ccb_h, periph->path, /*priority*/ 1);
574 		new_ccb->ccb_h.func_code = XPT_IMMEDIATE_NOTIFY;
575 		new_ccb->ccb_h.cbfcnp = ctlfedone;
576 		new_ccb->ccb_h.flags |= CAM_UNLOCKED;
577 		xpt_action(new_ccb);
578 		status = new_ccb->ccb_h.status;
579 		if ((status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
580 			/*
581 			 * Note that we don't free the CCB here.  If the
582 			 * status is not CAM_REQ_INPROG, then we're
583 			 * probably talking to a SIM that says it is
584 			 * target-capable but doesn't support the
585 			 * XPT_IMMEDIATE_NOTIFY CCB.  i.e. it supports the
586 			 * older API.  In that case, it'll call xpt_done()
587 			 * on the CCB, and we need to free it in our done
588 			 * routine as a result.
589 			 */
590 			break;
591 		}
592 	}
593 	if ((i == 0)
594 	 || (status != CAM_REQ_INPROG)) {
595 		xpt_print(periph->path, "%s: could not allocate immediate "
596 			  "notify CCBs, status 0x%x\n", __func__, status);
597 		return (CAM_REQ_CMP_ERR);
598 	}
599 	mtx_lock(&bus_softc->lun_softc_mtx);
600 	STAILQ_INSERT_TAIL(&bus_softc->lun_softc_list, softc, links);
601 	mtx_unlock(&bus_softc->lun_softc_mtx);
602 	return (CAM_REQ_CMP);
603 }
604 
605 static void
606 ctlfeoninvalidate(struct cam_periph *periph)
607 {
608 	struct ctlfe_lun_softc *softc = (struct ctlfe_lun_softc *)periph->softc;
609 	struct ctlfe_softc *bus_softc;
610 	union ccb ccb;
611 	struct ccb_hdr *hdr;
612 	cam_status status;
613 
614 	/* Abort all ATIOs and INOTs queued to SIM. */
615 	xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NONE);
616 	ccb.ccb_h.func_code = XPT_ABORT;
617 	LIST_FOREACH(hdr, &softc->atio_list, periph_links.le) {
618 		ccb.cab.abort_ccb = (union ccb *)hdr;
619 		xpt_action(&ccb);
620 	}
621 	LIST_FOREACH(hdr, &softc->inot_list, periph_links.le) {
622 		ccb.cab.abort_ccb = (union ccb *)hdr;
623 		xpt_action(&ccb);
624 	}
625 
626 	/* Disable the LUN in SIM. */
627 	ccb.ccb_h.func_code = XPT_EN_LUN;
628 	ccb.cel.grp6_len = 0;
629 	ccb.cel.grp7_len = 0;
630 	ccb.cel.enable = 0;
631 	xpt_action(&ccb);
632 	status = (ccb.ccb_h.status & CAM_STATUS_MASK);
633 	if (status != CAM_REQ_CMP) {
634 		xpt_print(periph->path, "%s: Disable LUN failed, status 0x%x\n",
635 			  __func__, ccb.ccb_h.status);
636 		/*
637 		 * XXX KDM what do we do now?
638 		 */
639 	}
640 
641 	bus_softc = softc->parent_softc;
642 	mtx_lock(&bus_softc->lun_softc_mtx);
643 	STAILQ_REMOVE(&bus_softc->lun_softc_list, softc, ctlfe_lun_softc, links);
644 	mtx_unlock(&bus_softc->lun_softc_mtx);
645 }
646 
647 static void
648 ctlfecleanup(struct cam_periph *periph)
649 {
650 	struct ctlfe_lun_softc *softc;
651 
652 	softc = (struct ctlfe_lun_softc *)periph->softc;
653 
654 	KASSERT(softc->ctios_sent == 0, ("%s: ctios_sent %d != 0",
655 	    __func__, softc->ctios_sent));
656 	KASSERT(softc->refcount == 0, ("%s: refcount %d != 0",
657 	    __func__, softc->refcount));
658 	KASSERT(softc->atios_alloced == 0, ("%s: atios_alloced %d != 0",
659 	    __func__, softc->atios_alloced));
660 	KASSERT(softc->inots_alloced == 0, ("%s: inots_alloced %d != 0",
661 	    __func__, softc->inots_alloced));
662 
663 	free(softc, M_CTLFE);
664 }
665 
666 static void
667 ctlfedata(struct ctlfe_lun_softc *softc, union ctl_io *io,
668     ccb_flags *flags, uint8_t **data_ptr, uint32_t *dxfer_len,
669     u_int16_t *sglist_cnt)
670 {
671 	struct ctlfe_softc *bus_softc;
672 	struct ctlfe_cmd_info *cmd_info;
673 	struct ctl_sg_entry *ctl_sglist;
674 	bus_dma_segment_t *cam_sglist;
675 	size_t off;
676 	int i, idx;
677 
678 	cmd_info = PRIV_INFO(io);
679 	bus_softc = softc->parent_softc;
680 
681 	/*
682 	 * Set the direction, relative to the initiator.
683 	 */
684 	*flags &= ~CAM_DIR_MASK;
685 	if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN)
686 		*flags |= CAM_DIR_IN;
687 	else
688 		*flags |= CAM_DIR_OUT;
689 
690 	*flags &= ~CAM_DATA_MASK;
691 	idx = cmd_info->cur_transfer_index;
692 	off = cmd_info->cur_transfer_off;
693 	cmd_info->flags &= ~CTLFE_CMD_PIECEWISE;
694 	if (io->scsiio.kern_sg_entries == 0) {	/* No S/G list. */
695 
696 		/* One time shift for SRR offset. */
697 		off += io->scsiio.ext_data_filled;
698 		io->scsiio.ext_data_filled = 0;
699 
700 		*data_ptr = io->scsiio.kern_data_ptr + off;
701 		if (io->scsiio.kern_data_len - off <= bus_softc->maxio) {
702 			*dxfer_len = io->scsiio.kern_data_len - off;
703 		} else {
704 			*dxfer_len = bus_softc->maxio;
705 			cmd_info->cur_transfer_off += bus_softc->maxio;
706 			cmd_info->flags |= CTLFE_CMD_PIECEWISE;
707 		}
708 		*sglist_cnt = 0;
709 
710 		if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR)
711 			*flags |= CAM_DATA_PADDR;
712 		else
713 			*flags |= CAM_DATA_VADDR;
714 	} else {	/* S/G list with physical or virtual pointers. */
715 		ctl_sglist = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
716 
717 		/* One time shift for SRR offset. */
718 		while (io->scsiio.ext_data_filled >= ctl_sglist[idx].len - off) {
719 			io->scsiio.ext_data_filled -= ctl_sglist[idx].len - off;
720 			idx++;
721 			off = 0;
722 		}
723 		off += io->scsiio.ext_data_filled;
724 		io->scsiio.ext_data_filled = 0;
725 
726 		cam_sglist = cmd_info->cam_sglist;
727 		*dxfer_len = 0;
728 		for (i = 0; i < io->scsiio.kern_sg_entries - idx; i++) {
729 			cam_sglist[i].ds_addr = (bus_addr_t)ctl_sglist[i + idx].addr + off;
730 			if (ctl_sglist[i + idx].len - off <= bus_softc->maxio - *dxfer_len) {
731 				cam_sglist[i].ds_len = ctl_sglist[idx + i].len - off;
732 				*dxfer_len += cam_sglist[i].ds_len;
733 			} else {
734 				cam_sglist[i].ds_len = bus_softc->maxio - *dxfer_len;
735 				cmd_info->cur_transfer_index = idx + i;
736 				cmd_info->cur_transfer_off = cam_sglist[i].ds_len + off;
737 				cmd_info->flags |= CTLFE_CMD_PIECEWISE;
738 				*dxfer_len += cam_sglist[i].ds_len;
739 				if (ctl_sglist[i].len != 0)
740 					i++;
741 				break;
742 			}
743 			if (i == (CTLFE_MAX_SEGS - 1) &&
744 			    idx + i < (io->scsiio.kern_sg_entries - 1)) {
745 				cmd_info->cur_transfer_index = idx + i + 1;
746 				cmd_info->cur_transfer_off = 0;
747 				cmd_info->flags |= CTLFE_CMD_PIECEWISE;
748 				i++;
749 				break;
750 			}
751 			off = 0;
752 		}
753 		*sglist_cnt = i;
754 		if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR)
755 			*flags |= CAM_DATA_SG_PADDR;
756 		else
757 			*flags |= CAM_DATA_SG;
758 		*data_ptr = (uint8_t *)cam_sglist;
759 	}
760 }
761 
762 static void
763 ctlfestart(struct cam_periph *periph, union ccb *start_ccb)
764 {
765 	struct ctlfe_lun_softc *softc;
766 	struct ctlfe_cmd_info *cmd_info;
767 	struct ccb_hdr *ccb_h;
768 	struct ccb_accept_tio *atio;
769 	struct ccb_scsiio *csio;
770 	uint8_t *data_ptr;
771 	uint32_t dxfer_len;
772 	ccb_flags flags;
773 	union ctl_io *io;
774 	uint8_t scsi_status;
775 
776 	softc = (struct ctlfe_lun_softc *)periph->softc;
777 
778 next:
779 	/* Take the ATIO off the work queue */
780 	ccb_h = STAILQ_FIRST(&softc->work_queue);
781 	if (ccb_h == NULL) {
782 		xpt_release_ccb(start_ccb);
783 		return;
784 	}
785 	STAILQ_REMOVE_HEAD(&softc->work_queue, periph_links.stqe);
786 	atio = (struct ccb_accept_tio *)ccb_h;
787 	io = (union ctl_io *)ccb_h->io_ptr;
788 	csio = &start_ccb->csio;
789 
790 	flags = atio->ccb_h.flags &
791 		(CAM_DIS_DISCONNECT|CAM_TAG_ACTION_VALID|CAM_DIR_MASK);
792 	cmd_info = PRIV_INFO(io);
793 	cmd_info->cur_transfer_index = 0;
794 	cmd_info->cur_transfer_off = 0;
795 	cmd_info->flags = 0;
796 
797 	if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED) {
798 		/*
799 		 * Datamove call, we need to setup the S/G list.
800 		 */
801 		ctlfedata(softc, io, &flags, &data_ptr, &dxfer_len,
802 		    &csio->sglist_cnt);
803 	} else {
804 		/*
805 		 * We're done, send status back.
806 		 */
807 		if ((io->io_hdr.flags & CTL_FLAG_ABORT) &&
808 		    (io->io_hdr.flags & CTL_FLAG_ABORT_STATUS) == 0) {
809 			io->io_hdr.flags &= ~CTL_FLAG_STATUS_QUEUED;
810 
811 			/* Tell the SIM that we've aborted this ATIO */
812 #ifdef CTLFEDEBUG
813 			printf("%s: tag %04x abort\n", __func__, atio->tag_id);
814 #endif
815 			KASSERT(atio->ccb_h.func_code == XPT_ACCEPT_TARGET_IO,
816 			    ("func_code %#x is not ATIO", atio->ccb_h.func_code));
817 			start_ccb->ccb_h.func_code = XPT_ABORT;
818 			start_ccb->cab.abort_ccb = (union ccb *)atio;
819 			xpt_action(start_ccb);
820 
821 			ctlfe_requeue_ccb(periph, (union ccb *)atio,
822 			    /* unlock */0);
823 
824 			/* XPT_ABORT is not queued, so we can take next I/O. */
825 			goto next;
826 		}
827 		data_ptr = NULL;
828 		dxfer_len = 0;
829 		csio->sglist_cnt = 0;
830 	}
831 	scsi_status = 0;
832 	if ((io->io_hdr.flags & CTL_FLAG_STATUS_QUEUED) &&
833 	    (cmd_info->flags & CTLFE_CMD_PIECEWISE) == 0 &&
834 	    ((io->io_hdr.flags & CTL_FLAG_DMA_QUEUED) == 0 ||
835 	     io->io_hdr.status == CTL_SUCCESS)) {
836 		flags |= CAM_SEND_STATUS;
837 		scsi_status = io->scsiio.scsi_status;
838 		csio->sense_len = io->scsiio.sense_len;
839 #ifdef CTLFEDEBUG
840 		printf("%s: tag %04x status %x\n", __func__,
841 		       atio->tag_id, io->io_hdr.status);
842 #endif
843 		if (csio->sense_len != 0) {
844 			csio->sense_data = io->scsiio.sense_data;
845 			flags |= CAM_SEND_SENSE;
846 		}
847 	}
848 
849 #ifdef CTLFEDEBUG
850 	printf("%s: %s: tag %04x flags %x ptr %p len %u\n", __func__,
851 	       (flags & CAM_SEND_STATUS) ? "done" : "datamove",
852 	       atio->tag_id, flags, data_ptr, dxfer_len);
853 #endif
854 
855 	/*
856 	 * Valid combinations:
857 	 *  - CAM_SEND_STATUS, CAM_DATA_SG = 0, dxfer_len = 0,
858 	 *    sglist_cnt = 0
859 	 *  - CAM_SEND_STATUS = 0, CAM_DATA_SG = 0, dxfer_len != 0,
860 	 *    sglist_cnt = 0
861 	 *  - CAM_SEND_STATUS = 0, CAM_DATA_SG, dxfer_len != 0,
862 	 *    sglist_cnt != 0
863 	 */
864 #ifdef CTLFEDEBUG
865 	if (((flags & CAM_SEND_STATUS)
866 	  && (((flags & CAM_DATA_SG) != 0)
867 	   || (dxfer_len != 0)
868 	   || (csio->sglist_cnt != 0)))
869 	 || (((flags & CAM_SEND_STATUS) == 0)
870 	  && (dxfer_len == 0))
871 	 || ((flags & CAM_DATA_SG)
872 	  && (csio->sglist_cnt == 0))
873 	 || (((flags & CAM_DATA_SG) == 0)
874 	  && (csio->sglist_cnt != 0))) {
875 		printf("%s: tag %04x cdb %02x flags %#x dxfer_len "
876 		       "%d sg %u\n", __func__, atio->tag_id,
877 		       atio_cdb_ptr(atio)[0], flags, dxfer_len,
878 		       csio->sglist_cnt);
879 		printf("%s: tag %04x io status %#x\n", __func__,
880 		       atio->tag_id, io->io_hdr.status);
881 	}
882 #endif
883 	cam_fill_ctio(csio,
884 		      /*retries*/ 2,
885 		      ctlfedone,
886 		      flags,
887 		      (flags & CAM_TAG_ACTION_VALID) ? MSG_SIMPLE_Q_TAG : 0,
888 		      atio->tag_id,
889 		      atio->init_id,
890 		      scsi_status,
891 		      /*data_ptr*/ data_ptr,
892 		      /*dxfer_len*/ dxfer_len,
893 		      /*timeout*/ CTLFE_TIMEOUT * 1000);
894 	start_ccb->ccb_h.flags |= CAM_UNLOCKED;
895 	start_ccb->ccb_h.ccb_atio = atio;
896 	if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED)
897 		io->io_hdr.flags |= CTL_FLAG_DMA_INPROG;
898 	io->io_hdr.flags &= ~(CTL_FLAG_DMA_QUEUED | CTL_FLAG_STATUS_QUEUED);
899 
900 	softc->ctios_sent++;
901 	softc->refcount++;
902 	cam_periph_unlock(periph);
903 	xpt_action(start_ccb);
904 	cam_periph_lock(periph);
905 	softc->refcount--;
906 
907 	/*
908 	 * If we still have work to do, ask for another CCB.
909 	 */
910 	if (!STAILQ_EMPTY(&softc->work_queue))
911 		xpt_schedule(periph, CAM_PRIORITY_NORMAL);
912 }
913 
914 static void
915 ctlfe_drain(void *context, int pending)
916 {
917 	struct cam_periph *periph = context;
918 	struct ctlfe_lun_softc *softc = periph->softc;
919 
920 	cam_periph_lock(periph);
921 	while (softc->refcount != 0) {
922 		cam_periph_sleep(periph, &softc->refcount, PRIBIO,
923 		    "ctlfe_drain", 1);
924 	}
925 	cam_periph_unlock(periph);
926 	cam_periph_release(periph);
927 }
928 
929 static void
930 ctlfe_free_ccb(struct cam_periph *periph, union ccb *ccb)
931 {
932 	struct ctlfe_lun_softc *softc;
933 	union ctl_io *io;
934 	struct ctlfe_cmd_info *cmd_info;
935 
936 	softc = (struct ctlfe_lun_softc *)periph->softc;
937 	io = ccb->ccb_h.io_ptr;
938 
939 	switch (ccb->ccb_h.func_code) {
940 	case XPT_ACCEPT_TARGET_IO:
941 		softc->atios_alloced--;
942 		cmd_info = PRIV_INFO(io);
943 		free(cmd_info, M_CTLFE);
944 		break;
945 	case XPT_IMMEDIATE_NOTIFY:
946 	case XPT_NOTIFY_ACKNOWLEDGE:
947 		softc->inots_alloced--;
948 		break;
949 	default:
950 		break;
951 	}
952 
953 	ctl_free_io(io);
954 	free(ccb, M_CTLFE);
955 
956 	KASSERT(softc->atios_alloced >= 0, ("%s: atios_alloced %d < 0",
957 	    __func__, softc->atios_alloced));
958 	KASSERT(softc->inots_alloced >= 0, ("%s: inots_alloced %d < 0",
959 	    __func__, softc->inots_alloced));
960 
961 	/*
962 	 * If we have received all of our CCBs, we can release our
963 	 * reference on the peripheral driver.  It will probably go away
964 	 * now.
965 	 */
966 	if (softc->atios_alloced == 0 && softc->inots_alloced == 0) {
967 		if (softc->refcount == 0) {
968 			cam_periph_release_locked(periph);
969 		} else {
970 			TASK_INIT(&softc->refdrain_task, 0, ctlfe_drain, periph);
971 			taskqueue_enqueue(taskqueue_thread,
972 			    &softc->refdrain_task);
973 		}
974 	}
975 }
976 
977 /*
978  * Send the ATIO/INOT back to the SIM, or free it if periph was invalidated.
979  */
980 static void
981 ctlfe_requeue_ccb(struct cam_periph *periph, union ccb *ccb, int unlock)
982 {
983 	struct ctlfe_lun_softc *softc;
984 	struct mtx *mtx;
985 
986 	if (periph->flags & CAM_PERIPH_INVALID) {
987 		mtx = cam_periph_mtx(periph);
988 		ctlfe_free_ccb(periph, ccb);
989 		if (unlock)
990 			mtx_unlock(mtx);
991 		return;
992 	}
993 	softc = (struct ctlfe_lun_softc *)periph->softc;
994 	if (ccb->ccb_h.func_code == XPT_ACCEPT_TARGET_IO)
995 		LIST_INSERT_HEAD(&softc->atio_list, &ccb->ccb_h, periph_links.le);
996 	else
997 		LIST_INSERT_HEAD(&softc->inot_list, &ccb->ccb_h, periph_links.le);
998 	if (unlock)
999 		cam_periph_unlock(periph);
1000 
1001 	/*
1002 	 * For a wildcard attachment, commands can come in with a specific
1003 	 * target/lun.  Reset the target and LUN fields back to the wildcard
1004 	 * values before we send them back down to the SIM.
1005 	 */
1006 	if (softc->flags & CTLFE_LUN_WILDCARD) {
1007 		ccb->ccb_h.target_id = CAM_TARGET_WILDCARD;
1008 		ccb->ccb_h.target_lun = CAM_LUN_WILDCARD;
1009 	}
1010 
1011 	xpt_action(ccb);
1012 }
1013 
1014 static int
1015 ctlfe_adjust_cdb(struct ccb_accept_tio *atio, uint32_t offset)
1016 {
1017 	uint64_t lba;
1018 	uint32_t num_blocks, nbc;
1019 	uint8_t *cmdbyt = atio_cdb_ptr(atio);
1020 
1021 	nbc = offset >> 9;	/* ASSUMING 512 BYTE BLOCKS */
1022 
1023 	switch (cmdbyt[0]) {
1024 	case READ_6:
1025 	case WRITE_6:
1026 	{
1027 		struct scsi_rw_6 *cdb = (struct scsi_rw_6 *)cmdbyt;
1028 		lba = scsi_3btoul(cdb->addr);
1029 		lba &= 0x1fffff;
1030 		num_blocks = cdb->length;
1031 		if (num_blocks == 0)
1032 			num_blocks = 256;
1033 		lba += nbc;
1034 		num_blocks -= nbc;
1035 		scsi_ulto3b(lba, cdb->addr);
1036 		cdb->length = num_blocks;
1037 		break;
1038 	}
1039 	case READ_10:
1040 	case WRITE_10:
1041 	{
1042 		struct scsi_rw_10 *cdb = (struct scsi_rw_10 *)cmdbyt;
1043 		lba = scsi_4btoul(cdb->addr);
1044 		num_blocks = scsi_2btoul(cdb->length);
1045 		lba += nbc;
1046 		num_blocks -= nbc;
1047 		scsi_ulto4b(lba, cdb->addr);
1048 		scsi_ulto2b(num_blocks, cdb->length);
1049 		break;
1050 	}
1051 	case READ_12:
1052 	case WRITE_12:
1053 	{
1054 		struct scsi_rw_12 *cdb = (struct scsi_rw_12 *)cmdbyt;
1055 		lba = scsi_4btoul(cdb->addr);
1056 		num_blocks = scsi_4btoul(cdb->length);
1057 		lba += nbc;
1058 		num_blocks -= nbc;
1059 		scsi_ulto4b(lba, cdb->addr);
1060 		scsi_ulto4b(num_blocks, cdb->length);
1061 		break;
1062 	}
1063 	case READ_16:
1064 	case WRITE_16:
1065 	{
1066 		struct scsi_rw_16 *cdb = (struct scsi_rw_16 *)cmdbyt;
1067 		lba = scsi_8btou64(cdb->addr);
1068 		num_blocks = scsi_4btoul(cdb->length);
1069 		lba += nbc;
1070 		num_blocks -= nbc;
1071 		scsi_u64to8b(lba, cdb->addr);
1072 		scsi_ulto4b(num_blocks, cdb->length);
1073 		break;
1074 	}
1075 	default:
1076 		return -1;
1077 	}
1078 	return (0);
1079 }
1080 
1081 static void
1082 ctlfedone(struct cam_periph *periph, union ccb *done_ccb)
1083 {
1084 	struct ctlfe_lun_softc *softc;
1085 	struct ctlfe_softc *bus_softc;
1086 	struct ctlfe_cmd_info *cmd_info;
1087 	struct ccb_accept_tio *atio = NULL;
1088 	union ctl_io *io = NULL;
1089 	struct mtx *mtx;
1090 	cam_status status;
1091 
1092 	KASSERT((done_ccb->ccb_h.flags & CAM_UNLOCKED) != 0,
1093 	    ("CCB in ctlfedone() without CAM_UNLOCKED flag"));
1094 #ifdef CTLFE_DEBUG
1095 	printf("%s: entered, func_code = %#x\n", __func__,
1096 	       done_ccb->ccb_h.func_code);
1097 #endif
1098 
1099 	/*
1100 	 * At this point CTL has no known use case for device queue freezes.
1101 	 * In case some SIM think different -- drop its freeze right here.
1102 	 */
1103 	if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1104 		cam_release_devq(periph->path,
1105 				 /*relsim_flags*/0,
1106 				 /*reduction*/0,
1107 				 /*timeout*/0,
1108 				 /*getcount_only*/0);
1109 		done_ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1110 	}
1111 
1112 	softc = (struct ctlfe_lun_softc *)periph->softc;
1113 	bus_softc = softc->parent_softc;
1114 	mtx = cam_periph_mtx(periph);
1115 	mtx_lock(mtx);
1116 
1117 	switch (done_ccb->ccb_h.func_code) {
1118 	case XPT_ACCEPT_TARGET_IO: {
1119 
1120 		LIST_REMOVE(&done_ccb->ccb_h, periph_links.le);
1121 		atio = &done_ccb->atio;
1122 		status = atio->ccb_h.status & CAM_STATUS_MASK;
1123 		if (status != CAM_CDB_RECVD) {
1124 			ctlfe_free_ccb(periph, done_ccb);
1125 			goto out;
1126 		}
1127 
1128  resubmit:
1129 		/*
1130 		 * Allocate a ctl_io, pass it to CTL, and wait for the
1131 		 * datamove or done.
1132 		 */
1133 		mtx_unlock(mtx);
1134 		io = done_ccb->ccb_h.io_ptr;
1135 		cmd_info = PRIV_INFO(io);
1136 		ctl_zero_io(io);
1137 
1138 		/* Save pointers on both sides */
1139 		PRIV_CCB(io) = done_ccb;
1140 		PRIV_INFO(io) = cmd_info;
1141 		done_ccb->ccb_h.io_ptr = io;
1142 
1143 		/*
1144 		 * Only SCSI I/O comes down this path, resets, etc. come
1145 		 * down the immediate notify path below.
1146 		 */
1147 		io->io_hdr.io_type = CTL_IO_SCSI;
1148 		io->io_hdr.nexus.initid = atio->init_id;
1149 		io->io_hdr.nexus.targ_port = bus_softc->port.targ_port;
1150 		if (bus_softc->hba_misc & PIM_EXTLUNS) {
1151 			io->io_hdr.nexus.targ_lun = ctl_decode_lun(
1152 			    CAM_EXTLUN_BYTE_SWIZZLE(atio->ccb_h.target_lun));
1153 		} else {
1154 			io->io_hdr.nexus.targ_lun = atio->ccb_h.target_lun;
1155 		}
1156 		io->scsiio.tag_num = atio->tag_id;
1157 		switch (atio->tag_action) {
1158 		case CAM_TAG_ACTION_NONE:
1159 			io->scsiio.tag_type = CTL_TAG_UNTAGGED;
1160 			break;
1161 		case MSG_SIMPLE_TASK:
1162 			io->scsiio.tag_type = CTL_TAG_SIMPLE;
1163 			break;
1164 		case MSG_HEAD_OF_QUEUE_TASK:
1165         		io->scsiio.tag_type = CTL_TAG_HEAD_OF_QUEUE;
1166 			break;
1167 		case MSG_ORDERED_TASK:
1168         		io->scsiio.tag_type = CTL_TAG_ORDERED;
1169 			break;
1170 		case MSG_ACA_TASK:
1171 			io->scsiio.tag_type = CTL_TAG_ACA;
1172 			break;
1173 		default:
1174 			io->scsiio.tag_type = CTL_TAG_UNTAGGED;
1175 			printf("%s: unhandled tag type %#x!!\n", __func__,
1176 			       atio->tag_action);
1177 			break;
1178 		}
1179 		if (atio->cdb_len > sizeof(io->scsiio.cdb)) {
1180 			printf("%s: WARNING: CDB len %d > ctl_io space %zd\n",
1181 			       __func__, atio->cdb_len, sizeof(io->scsiio.cdb));
1182 		}
1183 		io->scsiio.cdb_len = min(atio->cdb_len, sizeof(io->scsiio.cdb));
1184 		bcopy(atio_cdb_ptr(atio), io->scsiio.cdb, io->scsiio.cdb_len);
1185 
1186 #ifdef CTLFEDEBUG
1187 		printf("%s: %u:%u:%u: tag %04x CDB %02x\n", __func__,
1188 		        io->io_hdr.nexus.initid,
1189 		        io->io_hdr.nexus.targ_port,
1190 		        io->io_hdr.nexus.targ_lun,
1191 			io->scsiio.tag_num, io->scsiio.cdb[0]);
1192 #endif
1193 
1194 		ctl_queue(io);
1195 		return;
1196 	}
1197 	case XPT_CONT_TARGET_IO: {
1198 		int srr = 0;
1199 		uint32_t srr_off = 0;
1200 
1201 		atio = (struct ccb_accept_tio *)done_ccb->ccb_h.ccb_atio;
1202 		io = (union ctl_io *)atio->ccb_h.io_ptr;
1203 
1204 		softc->ctios_sent--;
1205 #ifdef CTLFEDEBUG
1206 		printf("%s: got XPT_CONT_TARGET_IO tag %#x flags %#x\n",
1207 		       __func__, atio->tag_id, done_ccb->ccb_h.flags);
1208 #endif
1209 		/*
1210 		 * Handle SRR case were the data pointer is pushed back hack
1211 		 */
1212 		if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_MESSAGE_RECV
1213 		    && done_ccb->csio.msg_ptr != NULL
1214 		    && done_ccb->csio.msg_ptr[0] == MSG_EXTENDED
1215 		    && done_ccb->csio.msg_ptr[1] == 5
1216        		    && done_ccb->csio.msg_ptr[2] == 0) {
1217 			srr = 1;
1218 			srr_off =
1219 			    (done_ccb->csio.msg_ptr[3] << 24)
1220 			    | (done_ccb->csio.msg_ptr[4] << 16)
1221 			    | (done_ccb->csio.msg_ptr[5] << 8)
1222 			    | (done_ccb->csio.msg_ptr[6]);
1223 		}
1224 
1225 		/*
1226 		 * If we have an SRR and we're still sending data, we
1227 		 * should be able to adjust offsets and cycle again.
1228 		 * It is possible only if offset is from this datamove.
1229 		 */
1230 		if (srr && (io->io_hdr.flags & CTL_FLAG_DMA_INPROG) &&
1231 		    srr_off >= io->scsiio.kern_rel_offset &&
1232 		    srr_off < io->scsiio.kern_rel_offset +
1233 		     io->scsiio.kern_data_len) {
1234 			io->scsiio.kern_data_resid =
1235 			    io->scsiio.kern_rel_offset +
1236 			    io->scsiio.kern_data_len - srr_off;
1237 			io->scsiio.ext_data_filled = srr_off;
1238 			io->scsiio.io_hdr.status = CTL_STATUS_NONE;
1239 			io->io_hdr.flags |= CTL_FLAG_DMA_QUEUED;
1240 			xpt_release_ccb(done_ccb);
1241 			STAILQ_INSERT_HEAD(&softc->work_queue, &atio->ccb_h,
1242 					  periph_links.stqe);
1243 			xpt_schedule(periph, CAM_PRIORITY_NORMAL);
1244 			break;
1245 		}
1246 
1247 		/*
1248 		 * If status was being sent, the back end data is now history.
1249 		 * Hack it up and resubmit a new command with the CDB adjusted.
1250 		 * If the SIM does the right thing, all of the resid math
1251 		 * should work.
1252 		 */
1253 		if (srr && (io->io_hdr.flags & CTL_FLAG_DMA_INPROG) == 0) {
1254 			xpt_release_ccb(done_ccb);
1255 			if (ctlfe_adjust_cdb(atio, srr_off) == 0) {
1256 				done_ccb = (union ccb *)atio;
1257 				goto resubmit;
1258 			}
1259 			/*
1260 			 * Fall through to doom....
1261 			 */
1262 		}
1263 
1264 		if ((done_ccb->ccb_h.flags & CAM_SEND_STATUS) &&
1265 		    (done_ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP)
1266 			io->io_hdr.flags |= CTL_FLAG_STATUS_SENT;
1267 
1268 		/*
1269 		 * If we were sending status back to the initiator, free up
1270 		 * resources.  If we were doing a datamove, call the
1271 		 * datamove done routine.
1272 		 */
1273 		if ((io->io_hdr.flags & CTL_FLAG_DMA_INPROG) == 0) {
1274 			/*
1275 			 * If we asked to send sense data but it wasn't sent,
1276 			 * queue the I/O back to CTL for later REQUEST SENSE.
1277 			 */
1278 			if ((done_ccb->ccb_h.flags & CAM_SEND_SENSE) != 0 &&
1279 			    (done_ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP &&
1280 			    (done_ccb->ccb_h.status & CAM_SENT_SENSE) == 0 &&
1281 			    (io = ctl_alloc_io_nowait(bus_softc->port.ctl_pool_ref)) != NULL) {
1282 				PRIV_INFO(io) = PRIV_INFO(
1283 				    (union ctl_io *)atio->ccb_h.io_ptr);
1284 				ctl_queue_sense(atio->ccb_h.io_ptr);
1285 				atio->ccb_h.io_ptr = io;
1286 			}
1287 
1288 			/* Abort ATIO if CTIO sending status has failed. */
1289 			if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) !=
1290 			    CAM_REQ_CMP) {
1291 				done_ccb->ccb_h.func_code = XPT_ABORT;
1292 				done_ccb->cab.abort_ccb = (union ccb *)atio;
1293 				xpt_action(done_ccb);
1294 			}
1295 
1296 			xpt_release_ccb(done_ccb);
1297 			ctlfe_requeue_ccb(periph, (union ccb *)atio,
1298 			    /* unlock */1);
1299 			return;
1300 		} else {
1301 			struct ctlfe_cmd_info *cmd_info;
1302 			struct ccb_scsiio *csio;
1303 
1304 			csio = &done_ccb->csio;
1305 			cmd_info = PRIV_INFO(io);
1306 
1307 			io->io_hdr.flags &= ~CTL_FLAG_DMA_INPROG;
1308 
1309 			/*
1310 			 * Translate CAM status to CTL status.  Success
1311 			 * does not change the overall, ctl_io status.  In
1312 			 * that case we just set port_status to 0.  If we
1313 			 * have a failure, though, set a data phase error
1314 			 * for the overall ctl_io.
1315 			 */
1316 			switch (done_ccb->ccb_h.status & CAM_STATUS_MASK) {
1317 			case CAM_REQ_CMP:
1318 				io->scsiio.kern_data_resid -=
1319 				    csio->dxfer_len - csio->resid;
1320 				io->io_hdr.port_status = 0;
1321 				break;
1322 			default:
1323 				/*
1324 				 * XXX KDM we probably need to figure out a
1325 				 * standard set of errors that the SIM
1326 				 * drivers should return in the event of a
1327 				 * data transfer failure.  A data phase
1328 				 * error will at least point the user to a
1329 				 * data transfer error of some sort.
1330 				 * Hopefully the SIM printed out some
1331 				 * additional information to give the user
1332 				 * a clue what happened.
1333 				 */
1334 				io->io_hdr.port_status = 0xbad1;
1335 				ctl_set_data_phase_error(&io->scsiio);
1336 				/*
1337 				 * XXX KDM figure out residual.
1338 				 */
1339 				break;
1340 			}
1341 			/*
1342 			 * If we had to break this S/G list into multiple
1343 			 * pieces, figure out where we are in the list, and
1344 			 * continue sending pieces if necessary.
1345 			 */
1346 			if ((cmd_info->flags & CTLFE_CMD_PIECEWISE) &&
1347 			    io->io_hdr.port_status == 0 && csio->resid == 0) {
1348 				ccb_flags flags;
1349 				uint8_t *data_ptr;
1350 				uint32_t dxfer_len;
1351 
1352 				flags = atio->ccb_h.flags &
1353 					(CAM_DIS_DISCONNECT|
1354 					 CAM_TAG_ACTION_VALID);
1355 
1356 				ctlfedata(softc, io, &flags, &data_ptr,
1357 				    &dxfer_len, &csio->sglist_cnt);
1358 
1359 				if (((flags & CAM_SEND_STATUS) == 0)
1360 				 && (dxfer_len == 0)) {
1361 					printf("%s: tag %04x no status or "
1362 					       "len cdb = %02x\n", __func__,
1363 					       atio->tag_id,
1364 					       atio_cdb_ptr(atio)[0]);
1365 					printf("%s: tag %04x io status %#x\n",
1366 					       __func__, atio->tag_id,
1367 					       io->io_hdr.status);
1368 				}
1369 
1370 				cam_fill_ctio(csio,
1371 					      /*retries*/ 2,
1372 					      ctlfedone,
1373 					      flags,
1374 					      (flags & CAM_TAG_ACTION_VALID) ?
1375 					       MSG_SIMPLE_Q_TAG : 0,
1376 					      atio->tag_id,
1377 					      atio->init_id,
1378 					      0,
1379 					      /*data_ptr*/ data_ptr,
1380 					      /*dxfer_len*/ dxfer_len,
1381 					      CTLFE_TIMEOUT * 1000);
1382 
1383 				csio->ccb_h.flags |= CAM_UNLOCKED;
1384 				csio->resid = 0;
1385 				csio->ccb_h.ccb_atio = atio;
1386 				io->io_hdr.flags |= CTL_FLAG_DMA_INPROG;
1387 				softc->ctios_sent++;
1388 				mtx_unlock(mtx);
1389 				xpt_action((union ccb *)csio);
1390 			} else {
1391 				/*
1392 				 * Release the CTIO.  The ATIO will be sent back
1393 				 * down to the SIM once we send status.
1394 				 */
1395 				xpt_release_ccb(done_ccb);
1396 				mtx_unlock(mtx);
1397 
1398 				/* Call the backend move done callback */
1399 				io->scsiio.be_move_done(io);
1400 			}
1401 			return;
1402 		}
1403 		break;
1404 	}
1405 	case XPT_IMMEDIATE_NOTIFY: {
1406 		union ctl_io *io;
1407 		struct ccb_immediate_notify *inot;
1408 		int send_ctl_io;
1409 
1410 		LIST_REMOVE(&done_ccb->ccb_h, periph_links.le);
1411 		inot = &done_ccb->cin1;
1412 		io = done_ccb->ccb_h.io_ptr;
1413 		ctl_zero_io(io);
1414 
1415 		send_ctl_io = 1;
1416 
1417 		io->io_hdr.io_type = CTL_IO_TASK;
1418 		PRIV_CCB(io) = done_ccb;
1419 		inot->ccb_h.io_ptr = io;
1420 		io->io_hdr.nexus.initid = inot->initiator_id;
1421 		io->io_hdr.nexus.targ_port = bus_softc->port.targ_port;
1422 		if (bus_softc->hba_misc & PIM_EXTLUNS) {
1423 			io->io_hdr.nexus.targ_lun = ctl_decode_lun(
1424 			    CAM_EXTLUN_BYTE_SWIZZLE(inot->ccb_h.target_lun));
1425 		} else {
1426 			io->io_hdr.nexus.targ_lun = inot->ccb_h.target_lun;
1427 		}
1428 		/* XXX KDM should this be the tag_id? */
1429 		io->taskio.tag_num = inot->seq_id;
1430 
1431 		status = inot->ccb_h.status & CAM_STATUS_MASK;
1432 		switch (status) {
1433 		case CAM_SCSI_BUS_RESET:
1434 			io->taskio.task_action = CTL_TASK_BUS_RESET;
1435 			break;
1436 		case CAM_BDR_SENT:
1437 			io->taskio.task_action = CTL_TASK_TARGET_RESET;
1438 			break;
1439 		case CAM_MESSAGE_RECV:
1440 			switch (inot->arg) {
1441 			case MSG_ABORT_TASK_SET:
1442 				io->taskio.task_action =
1443 				    CTL_TASK_ABORT_TASK_SET;
1444 				break;
1445 			case MSG_TARGET_RESET:
1446 				io->taskio.task_action = CTL_TASK_TARGET_RESET;
1447 				break;
1448 			case MSG_ABORT_TASK:
1449 				io->taskio.task_action = CTL_TASK_ABORT_TASK;
1450 				break;
1451 			case MSG_LOGICAL_UNIT_RESET:
1452 				io->taskio.task_action = CTL_TASK_LUN_RESET;
1453 				break;
1454 			case MSG_CLEAR_TASK_SET:
1455 				io->taskio.task_action =
1456 				    CTL_TASK_CLEAR_TASK_SET;
1457 				break;
1458 			case MSG_CLEAR_ACA:
1459 				io->taskio.task_action = CTL_TASK_CLEAR_ACA;
1460 				break;
1461 			case MSG_QUERY_TASK:
1462 				io->taskio.task_action = CTL_TASK_QUERY_TASK;
1463 				break;
1464 			case MSG_QUERY_TASK_SET:
1465 				io->taskio.task_action =
1466 				    CTL_TASK_QUERY_TASK_SET;
1467 				break;
1468 			case MSG_QUERY_ASYNC_EVENT:
1469 				io->taskio.task_action =
1470 				    CTL_TASK_QUERY_ASYNC_EVENT;
1471 				break;
1472 			case MSG_NOOP:
1473 				send_ctl_io = 0;
1474 				break;
1475 			default:
1476 				xpt_print(periph->path,
1477 				    "%s: unsupported INOT message 0x%x\n",
1478 				    __func__, inot->arg);
1479 				send_ctl_io = 0;
1480 				break;
1481 			}
1482 			break;
1483 		default:
1484 			xpt_print(periph->path,
1485 			    "%s: unsupported INOT status 0x%x\n",
1486 			    __func__, status);
1487 			/* FALLTHROUGH */
1488 		case CAM_REQ_ABORTED:
1489 		case CAM_REQ_INVALID:
1490 		case CAM_DEV_NOT_THERE:
1491 		case CAM_PROVIDE_FAIL:
1492 			ctlfe_free_ccb(periph, done_ccb);
1493 			goto out;
1494 		}
1495 		if (send_ctl_io != 0) {
1496 			ctl_queue(io);
1497 		} else {
1498 			done_ccb->ccb_h.status = CAM_REQ_INPROG;
1499 			done_ccb->ccb_h.func_code = XPT_NOTIFY_ACKNOWLEDGE;
1500 			xpt_action(done_ccb);
1501 		}
1502 		break;
1503 	}
1504 	case XPT_NOTIFY_ACKNOWLEDGE:
1505 		/* Queue this back down to the SIM as an immediate notify. */
1506 		done_ccb->ccb_h.status = CAM_REQ_INPROG;
1507 		done_ccb->ccb_h.func_code = XPT_IMMEDIATE_NOTIFY;
1508 		ctlfe_requeue_ccb(periph, done_ccb, /* unlock */1);
1509 		return;
1510 	case XPT_SET_SIM_KNOB:
1511 	case XPT_GET_SIM_KNOB:
1512 	case XPT_GET_SIM_KNOB_OLD:
1513 		break;
1514 	default:
1515 		panic("%s: unexpected CCB type %#x", __func__,
1516 		      done_ccb->ccb_h.func_code);
1517 		break;
1518 	}
1519 
1520 out:
1521 	mtx_unlock(mtx);
1522 }
1523 
1524 static void
1525 ctlfe_onoffline(void *arg, int online)
1526 {
1527 	struct ctlfe_softc *bus_softc = arg;
1528 	union ccb *ccb;
1529 	cam_status status;
1530 	struct cam_path *path;
1531 	int set_wwnn = 0;
1532 
1533 	status = xpt_create_path(&path, /*periph*/ NULL, bus_softc->path_id,
1534 	    CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
1535 	if (status != CAM_REQ_CMP) {
1536 		printf("%s: unable to create path!\n", __func__);
1537 		return;
1538 	}
1539 	ccb = xpt_alloc_ccb();
1540 	xpt_setup_ccb(&ccb->ccb_h, path, CAM_PRIORITY_NONE);
1541 	ccb->ccb_h.func_code = XPT_GET_SIM_KNOB;
1542 	xpt_action(ccb);
1543 
1544 	/* Check whether we should change WWNs. */
1545 	if (online != 0) {
1546 		if ((ccb->knob.xport_specific.valid & KNOB_VALID_ADDRESS) != 0){
1547 			printf("%s: %s current WWNN %#jx\n", __func__,
1548 			       bus_softc->port_name,
1549 			       ccb->knob.xport_specific.fc.wwnn);
1550 			printf("%s: %s current WWPN %#jx\n", __func__,
1551 			       bus_softc->port_name,
1552 			       ccb->knob.xport_specific.fc.wwpn);
1553 
1554 			/*
1555 			 * If the user has specified a WWNN/WWPN, send them
1556 			 * down to the SIM.  Otherwise, record what the SIM
1557 			 * has reported.
1558 			 */
1559 			if (bus_softc->port.wwnn != 0 && bus_softc->port.wwnn
1560 			    != ccb->knob.xport_specific.fc.wwnn) {
1561 				ccb->knob.xport_specific.fc.wwnn =
1562 				    bus_softc->port.wwnn;
1563 				set_wwnn = 1;
1564 			} else {
1565 				ctl_port_set_wwns(&bus_softc->port,
1566 				    true, ccb->knob.xport_specific.fc.wwnn,
1567 				    false, 0);
1568 			}
1569 			if (bus_softc->port.wwpn != 0 && bus_softc->port.wwpn
1570 			     != ccb->knob.xport_specific.fc.wwpn) {
1571 				ccb->knob.xport_specific.fc.wwpn =
1572 				    bus_softc->port.wwpn;
1573 				set_wwnn = 1;
1574 			} else {
1575 				ctl_port_set_wwns(&bus_softc->port,
1576 				    false, 0,
1577 				    true, ccb->knob.xport_specific.fc.wwpn);
1578 			}
1579 		} else {
1580 			printf("%s: %s has no valid WWNN/WWPN\n", __func__,
1581 			       bus_softc->port_name);
1582 			if (bus_softc->port.wwnn != 0) {
1583 				ccb->knob.xport_specific.fc.wwnn =
1584 				    bus_softc->port.wwnn;
1585 				set_wwnn = 1;
1586 			}
1587 			if (bus_softc->port.wwpn != 0) {
1588 				ccb->knob.xport_specific.fc.wwpn =
1589 				    bus_softc->port.wwpn;
1590 				set_wwnn = 1;
1591 			}
1592 		}
1593 	}
1594 	if (set_wwnn) {
1595 		ccb->ccb_h.func_code = XPT_SET_SIM_KNOB;
1596 		ccb->knob.xport_specific.valid = KNOB_VALID_ADDRESS;
1597 		xpt_action(ccb);
1598 		if ((ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1599 			printf("%s: %s (path id %d) failed set WWNs: %#x\n",
1600 			    __func__, bus_softc->port_name, bus_softc->path_id,
1601 			    ccb->ccb_h.status);
1602 		} else {
1603 			printf("%s: %s new WWNN %#jx\n", __func__,
1604 			       bus_softc->port_name,
1605 			       ccb->knob.xport_specific.fc.wwnn);
1606 			printf("%s: %s new WWPN %#jx\n", __func__,
1607 			       bus_softc->port_name,
1608 			       ccb->knob.xport_specific.fc.wwpn);
1609 		}
1610 	}
1611 
1612 	/* Check whether we should change role. */
1613 	if ((ccb->knob.xport_specific.valid & KNOB_VALID_ROLE) == 0 ||
1614 	    ((online != 0) ^
1615 	    ((ccb->knob.xport_specific.fc.role & KNOB_ROLE_TARGET) != 0)) != 0) {
1616 		ccb->ccb_h.func_code = XPT_SET_SIM_KNOB;
1617 		ccb->knob.xport_specific.valid = KNOB_VALID_ROLE;
1618 		if (online)
1619 			ccb->knob.xport_specific.fc.role |= KNOB_ROLE_TARGET;
1620 		else
1621 			ccb->knob.xport_specific.fc.role &= ~KNOB_ROLE_TARGET;
1622 		xpt_action(ccb);
1623 		if ((ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1624 			printf("%s: %s (path id %d) failed %s target role: %#x\n",
1625 			    __func__, bus_softc->port_name, bus_softc->path_id,
1626 			    online ? "enable" : "disable", ccb->ccb_h.status);
1627 		} else {
1628 			printf("%s: %s (path id %d) target role %s succeeded\n",
1629 			    __func__, bus_softc->port_name, bus_softc->path_id,
1630 			    online ? "enable" : "disable");
1631 		}
1632 	}
1633 
1634 	xpt_free_path(path);
1635 	xpt_free_ccb(ccb);
1636 }
1637 
1638 static void
1639 ctlfe_online(void *arg)
1640 {
1641 	struct ctlfe_softc *bus_softc;
1642 	struct cam_path *path;
1643 	cam_status status;
1644 	struct ctlfe_lun_softc *lun_softc;
1645 	struct cam_periph *periph;
1646 
1647 	bus_softc = (struct ctlfe_softc *)arg;
1648 
1649 	/*
1650 	 * Create the wildcard LUN before bringing the port online.
1651 	 */
1652 	status = xpt_create_path(&path, /*periph*/ NULL,
1653 				 bus_softc->path_id, CAM_TARGET_WILDCARD,
1654 				 CAM_LUN_WILDCARD);
1655 	if (status != CAM_REQ_CMP) {
1656 		printf("%s: unable to create path for wildcard periph\n",
1657 				__func__);
1658 		return;
1659 	}
1660 
1661 	lun_softc = malloc(sizeof(*lun_softc), M_CTLFE, M_WAITOK | M_ZERO);
1662 
1663 	xpt_path_lock(path);
1664 	periph = cam_periph_find(path, "ctl");
1665 	if (periph != NULL) {
1666 		/* We've already got a periph, no need to alloc a new one. */
1667 		xpt_path_unlock(path);
1668 		xpt_free_path(path);
1669 		free(lun_softc, M_CTLFE);
1670 		return;
1671 	}
1672 	lun_softc->parent_softc = bus_softc;
1673 	lun_softc->flags |= CTLFE_LUN_WILDCARD;
1674 
1675 	status = cam_periph_alloc(ctlferegister,
1676 				  ctlfeoninvalidate,
1677 				  ctlfecleanup,
1678 				  ctlfestart,
1679 				  "ctl",
1680 				  CAM_PERIPH_BIO,
1681 				  path,
1682 				  ctlfeasync,
1683 				  0,
1684 				  lun_softc);
1685 
1686 	if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1687 		const struct cam_status_entry *entry;
1688 
1689 		entry = cam_fetch_status_entry(status);
1690 		printf("%s: CAM error %s (%#x) returned from "
1691 		       "cam_periph_alloc()\n", __func__, (entry != NULL) ?
1692 		       entry->status_text : "Unknown", status);
1693 		free(lun_softc, M_CTLFE);
1694 	}
1695 
1696 	xpt_path_unlock(path);
1697 	ctlfe_onoffline(arg, /*online*/ 1);
1698 	xpt_free_path(path);
1699 }
1700 
1701 static void
1702 ctlfe_offline(void *arg)
1703 {
1704 	struct ctlfe_softc *bus_softc;
1705 	struct cam_path *path;
1706 	cam_status status;
1707 	struct cam_periph *periph;
1708 
1709 	bus_softc = (struct ctlfe_softc *)arg;
1710 
1711 	ctlfe_onoffline(arg, /*online*/ 0);
1712 
1713 	/*
1714 	 * Disable the wildcard LUN for this port now that we have taken
1715 	 * the port offline.
1716 	 */
1717 	status = xpt_create_path(&path, /*periph*/ NULL,
1718 				 bus_softc->path_id, CAM_TARGET_WILDCARD,
1719 				 CAM_LUN_WILDCARD);
1720 	if (status != CAM_REQ_CMP) {
1721 		printf("%s: unable to create path for wildcard periph\n",
1722 		       __func__);
1723 		return;
1724 	}
1725 	xpt_path_lock(path);
1726 	if ((periph = cam_periph_find(path, "ctl")) != NULL)
1727 		cam_periph_invalidate(periph);
1728 	xpt_path_unlock(path);
1729 	xpt_free_path(path);
1730 }
1731 
1732 /*
1733  * This will get called to enable a LUN on every bus that is attached to
1734  * CTL.  So we only need to create a path/periph for this particular bus.
1735  */
1736 static int
1737 ctlfe_lun_enable(void *arg, int lun_id)
1738 {
1739 	struct ctlfe_softc *bus_softc;
1740 	struct ctlfe_lun_softc *softc;
1741 	struct cam_path *path;
1742 	struct cam_periph *periph;
1743 	cam_status status;
1744 
1745 	bus_softc = (struct ctlfe_softc *)arg;
1746 	if (bus_softc->hba_misc & PIM_EXTLUNS)
1747 		lun_id = CAM_EXTLUN_BYTE_SWIZZLE(ctl_encode_lun(lun_id));
1748 
1749 	status = xpt_create_path(&path, /*periph*/ NULL,
1750 	    bus_softc->path_id, bus_softc->target_id, lun_id);
1751 	/* XXX KDM need some way to return status to CTL here? */
1752 	if (status != CAM_REQ_CMP) {
1753 		printf("%s: could not create path, status %#x\n", __func__,
1754 		       status);
1755 		return (1);
1756 	}
1757 
1758 	softc = malloc(sizeof(*softc), M_CTLFE, M_WAITOK | M_ZERO);
1759 	xpt_path_lock(path);
1760 	periph = cam_periph_find(path, "ctl");
1761 	if (periph != NULL) {
1762 		/* We've already got a periph, no need to alloc a new one. */
1763 		xpt_path_unlock(path);
1764 		xpt_free_path(path);
1765 		free(softc, M_CTLFE);
1766 		return (0);
1767 	}
1768 	softc->parent_softc = bus_softc;
1769 
1770 	status = cam_periph_alloc(ctlferegister,
1771 				  ctlfeoninvalidate,
1772 				  ctlfecleanup,
1773 				  ctlfestart,
1774 				  "ctl",
1775 				  CAM_PERIPH_BIO,
1776 				  path,
1777 				  ctlfeasync,
1778 				  0,
1779 				  softc);
1780 
1781 	if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1782 		const struct cam_status_entry *entry;
1783 
1784 		entry = cam_fetch_status_entry(status);
1785 		printf("%s: CAM error %s (%#x) returned from "
1786 		       "cam_periph_alloc()\n", __func__, (entry != NULL) ?
1787 		       entry->status_text : "Unknown", status);
1788 		free(softc, M_CTLFE);
1789 	}
1790 
1791 	xpt_path_unlock(path);
1792 	xpt_free_path(path);
1793 	return (0);
1794 }
1795 
1796 /*
1797  * This will get called when the user removes a LUN to disable that LUN
1798  * on every bus that is attached to CTL.
1799  */
1800 static int
1801 ctlfe_lun_disable(void *arg, int lun_id)
1802 {
1803 	struct ctlfe_softc *softc;
1804 	struct ctlfe_lun_softc *lun_softc;
1805 
1806 	softc = (struct ctlfe_softc *)arg;
1807 	if (softc->hba_misc & PIM_EXTLUNS)
1808 		lun_id = CAM_EXTLUN_BYTE_SWIZZLE(ctl_encode_lun(lun_id));
1809 
1810 	mtx_lock(&softc->lun_softc_mtx);
1811 	STAILQ_FOREACH(lun_softc, &softc->lun_softc_list, links) {
1812 		struct cam_path *path;
1813 
1814 		path = lun_softc->periph->path;
1815 
1816 		if ((xpt_path_target_id(path) == softc->target_id)
1817 		 && (xpt_path_lun_id(path) == lun_id)) {
1818 			break;
1819 		}
1820 	}
1821 	if (lun_softc == NULL) {
1822 		mtx_unlock(&softc->lun_softc_mtx);
1823 		printf("%s: can't find lun %d\n", __func__, lun_id);
1824 		return (1);
1825 	}
1826 	cam_periph_acquire(lun_softc->periph);
1827 	mtx_unlock(&softc->lun_softc_mtx);
1828 
1829 	cam_periph_lock(lun_softc->periph);
1830 	cam_periph_invalidate(lun_softc->periph);
1831 	cam_periph_unlock(lun_softc->periph);
1832 	cam_periph_release(lun_softc->periph);
1833 	return (0);
1834 }
1835 
1836 static void
1837 ctlfe_dump_sim(struct cam_sim *sim)
1838 {
1839 
1840 	printf("%s%d: max dev openings: %d, max tagged dev openings: %d\n",
1841 	    sim->sim_name, sim->unit_number, sim->max_dev_openings,
1842 	    sim->max_tagged_dev_openings);
1843 }
1844 
1845 /*
1846  * Assumes that the SIM lock is held.
1847  */
1848 static void
1849 ctlfe_dump_queue(struct ctlfe_lun_softc *softc)
1850 {
1851 	struct cam_periph *periph = softc->periph;
1852 	struct ccb_hdr *hdr;
1853 	struct ccb_getdevstats cgds;
1854 	int num_items;
1855 
1856 	xpt_setup_ccb(&cgds.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
1857 	cgds.ccb_h.func_code = XPT_GDEV_STATS;
1858 	xpt_action((union ccb *)&cgds);
1859 	if ((cgds.ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP) {
1860 		xpt_print(periph->path, "devq: openings %d, active %d, "
1861 		    "allocated %d, queued %d, held %d\n",
1862 		    cgds.dev_openings, cgds.dev_active, cgds.allocated,
1863 		    cgds.queued, cgds.held);
1864 	}
1865 
1866 	num_items = 0;
1867 
1868 	STAILQ_FOREACH(hdr, &softc->work_queue, periph_links.stqe) {
1869 		union ctl_io *io = hdr->io_ptr;
1870 
1871 		num_items++;
1872 
1873 		/*
1874 		 * Only regular SCSI I/O is put on the work
1875 		 * queue, so we can print sense here.  There may be no
1876 		 * sense if it's no the queue for a DMA, but this serves to
1877 		 * print out the CCB as well.
1878 		 *
1879 		 * XXX KDM switch this over to scsi_sense_print() when
1880 		 * CTL is merged in with CAM.
1881 		 */
1882 		ctl_io_error_print(io, NULL);
1883 
1884 		/*
1885 		 * Print DMA status if we are DMA_QUEUED.
1886 		 */
1887 		if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED) {
1888 			xpt_print(periph->path,
1889 			    "Total %u, Current %u, Resid %u\n",
1890 			    io->scsiio.kern_total_len,
1891 			    io->scsiio.kern_data_len,
1892 			    io->scsiio.kern_data_resid);
1893 		}
1894 	}
1895 
1896 	xpt_print(periph->path, "%d requests waiting for CCBs\n", num_items);
1897 	xpt_print(periph->path, "%d CTIOs outstanding\n", softc->ctios_sent);
1898 }
1899 
1900 /*
1901  * Datamove/done routine called by CTL.  Put ourselves on the queue to
1902  * receive a CCB from CAM so we can queue the continue I/O request down
1903  * to the adapter.
1904  */
1905 static void
1906 ctlfe_datamove(union ctl_io *io)
1907 {
1908 	union ccb *ccb;
1909 	struct cam_periph *periph;
1910 	struct ctlfe_lun_softc *softc;
1911 
1912 	KASSERT(io->io_hdr.io_type == CTL_IO_SCSI,
1913 	    ("Unexpected io_type (%d) in ctlfe_datamove", io->io_hdr.io_type));
1914 
1915 	io->scsiio.ext_data_filled = 0;
1916 	ccb = PRIV_CCB(io);
1917 	periph = xpt_path_periph(ccb->ccb_h.path);
1918 	cam_periph_lock(periph);
1919 	softc = (struct ctlfe_lun_softc *)periph->softc;
1920 	io->io_hdr.flags |= CTL_FLAG_DMA_QUEUED;
1921 	if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE)
1922 		io->io_hdr.flags |= CTL_FLAG_STATUS_QUEUED;
1923 	STAILQ_INSERT_TAIL(&softc->work_queue, &ccb->ccb_h,
1924 			  periph_links.stqe);
1925 	xpt_schedule(periph, CAM_PRIORITY_NORMAL);
1926 	cam_periph_unlock(periph);
1927 }
1928 
1929 static void
1930 ctlfe_done(union ctl_io *io)
1931 {
1932 	union ccb *ccb;
1933 	struct cam_periph *periph;
1934 	struct ctlfe_lun_softc *softc;
1935 
1936 	ccb = PRIV_CCB(io);
1937 	periph = xpt_path_periph(ccb->ccb_h.path);
1938 	cam_periph_lock(periph);
1939 	softc = (struct ctlfe_lun_softc *)periph->softc;
1940 
1941 	if (io->io_hdr.io_type == CTL_IO_TASK) {
1942 		/*
1943 		 * Send the notify acknowledge down to the SIM, to let it
1944 		 * know we processed the task management command.
1945 		 */
1946 		ccb->ccb_h.status = CAM_REQ_INPROG;
1947 		ccb->ccb_h.func_code = XPT_NOTIFY_ACKNOWLEDGE;
1948 		switch (io->taskio.task_status) {
1949 		case CTL_TASK_FUNCTION_COMPLETE:
1950 			ccb->cna2.arg = CAM_RSP_TMF_COMPLETE;
1951 			break;
1952 		case CTL_TASK_FUNCTION_SUCCEEDED:
1953 			ccb->cna2.arg = CAM_RSP_TMF_SUCCEEDED;
1954 			ccb->ccb_h.flags |= CAM_SEND_STATUS;
1955 			break;
1956 		case CTL_TASK_FUNCTION_REJECTED:
1957 			ccb->cna2.arg = CAM_RSP_TMF_REJECTED;
1958 			ccb->ccb_h.flags |= CAM_SEND_STATUS;
1959 			break;
1960 		case CTL_TASK_LUN_DOES_NOT_EXIST:
1961 			ccb->cna2.arg = CAM_RSP_TMF_INCORRECT_LUN;
1962 			ccb->ccb_h.flags |= CAM_SEND_STATUS;
1963 			break;
1964 		case CTL_TASK_FUNCTION_NOT_SUPPORTED:
1965 			ccb->cna2.arg = CAM_RSP_TMF_FAILED;
1966 			ccb->ccb_h.flags |= CAM_SEND_STATUS;
1967 			break;
1968 		}
1969 		ccb->cna2.arg |= scsi_3btoul(io->taskio.task_resp) << 8;
1970 		xpt_action(ccb);
1971 	} else if (io->io_hdr.flags & CTL_FLAG_STATUS_SENT) {
1972 		ctlfe_requeue_ccb(periph, ccb, /* unlock */1);
1973 		return;
1974 	} else {
1975 		io->io_hdr.flags |= CTL_FLAG_STATUS_QUEUED;
1976 		STAILQ_INSERT_TAIL(&softc->work_queue, &ccb->ccb_h,
1977 				  periph_links.stqe);
1978 		xpt_schedule(periph, CAM_PRIORITY_NORMAL);
1979 	}
1980 
1981 	cam_periph_unlock(periph);
1982 }
1983 
1984 static void
1985 ctlfe_dump(void)
1986 {
1987 	struct ctlfe_softc *bus_softc;
1988 	struct ctlfe_lun_softc *lun_softc;
1989 
1990 	STAILQ_FOREACH(bus_softc, &ctlfe_softc_list, links) {
1991 		ctlfe_dump_sim(bus_softc->sim);
1992 		STAILQ_FOREACH(lun_softc, &bus_softc->lun_softc_list, links)
1993 			ctlfe_dump_queue(lun_softc);
1994 	}
1995 }
1996