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