xref: /freebsd/sys/cam/ctl/scsi_ctl.c (revision 3c91c65a2b999a8d27e99bcc6493de7cf812c948)
1 /*-
2  * Copyright (c) 2008, 2009 Silicon Graphics International Corp.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions, and the following disclaimer,
10  *    without modification.
11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12  *    substantially similar to the "NO WARRANTY" disclaimer below
13  *    ("Disclaimer") and any redistribution must be conditioned upon
14  *    including a substantially similar Disclaimer requirement for further
15  *    binary redistribution.
16  *
17  * NO WARRANTY
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
27  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGES.
29  *
30  * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/scsi_ctl.c#4 $
31  */
32 /*
33  * Peripheral driver interface between CAM and CTL (CAM Target Layer).
34  *
35  * Author: Ken Merry <ken@FreeBSD.org>
36  */
37 
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
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 <machine/bus.h>
56 
57 #include <cam/cam.h>
58 #include <cam/cam_ccb.h>
59 #include <cam/cam_periph.h>
60 #include <cam/cam_queue.h>
61 #include <cam/cam_xpt_periph.h>
62 #include <cam/cam_debug.h>
63 #include <cam/cam_sim.h>
64 #include <cam/cam_xpt.h>
65 
66 #include <cam/scsi/scsi_all.h>
67 #include <cam/scsi/scsi_message.h>
68 
69 #include <cam/ctl/ctl_io.h>
70 #include <cam/ctl/ctl.h>
71 #include <cam/ctl/ctl_frontend.h>
72 #include <cam/ctl/ctl_util.h>
73 #include <cam/ctl/ctl_error.h>
74 
75 typedef enum {
76 	CTLFE_CCB_DEFAULT	= 0x00,
77 	CTLFE_CCB_WAITING 	= 0x01
78 } ctlfe_ccb_types;
79 
80 struct ctlfe_softc {
81 	struct ctl_frontend fe;
82 	path_id_t path_id;
83 	struct cam_sim *sim;
84 	char port_name[DEV_IDLEN];
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 static int ctlfe_dma_enabled = 1;
93 #ifdef CTLFE_INIT_ENABLE
94 static int ctlfe_max_targets = 1;
95 static int ctlfe_num_targets = 0;
96 #endif
97 
98 typedef enum {
99 	CTLFE_LUN_NONE		= 0x00,
100 	CTLFE_LUN_WILDCARD	= 0x01
101 } ctlfe_lun_flags;
102 
103 struct ctlfe_lun_softc {
104 	struct ctlfe_softc *parent_softc;
105 	struct cam_periph *periph;
106 	ctlfe_lun_flags flags;
107 	struct callout dma_callout;
108 	uint64_t ccbs_alloced;
109 	uint64_t ccbs_freed;
110 	uint64_t ctios_sent;
111 	uint64_t ctios_returned;
112 	uint64_t atios_sent;
113 	uint64_t atios_returned;
114 	uint64_t inots_sent;
115 	uint64_t inots_returned;
116 	/* bus_dma_tag_t dma_tag; */
117 	TAILQ_HEAD(, ccb_hdr) work_queue;
118 	STAILQ_ENTRY(ctlfe_lun_softc) links;
119 };
120 
121 typedef enum {
122 	CTLFE_CMD_NONE		= 0x00,
123 	CTLFE_CMD_PIECEWISE	= 0x01
124 } ctlfe_cmd_flags;
125 
126 /*
127  * The size limit of this structure is CTL_PORT_PRIV_SIZE, from ctl_io.h.
128  * Currently that is 600 bytes.
129  */
130 struct ctlfe_lun_cmd_info {
131 	int cur_transfer_index;
132 	ctlfe_cmd_flags flags;
133 	/*
134 	 * XXX KDM struct bus_dma_segment is 8 bytes on i386, and 16
135 	 * bytes on amd64.  So with 32 elements, this is 256 bytes on
136 	 * i386 and 512 bytes on amd64.
137 	 */
138 	bus_dma_segment_t cam_sglist[32];
139 };
140 
141 /*
142  * When we register the adapter/bus, request that this many ctl_ios be
143  * allocated.  This should be the maximum supported by the adapter, but we
144  * currently don't have a way to get that back from the path inquiry.
145  * XXX KDM add that to the path inquiry.
146  */
147 #define	CTLFE_REQ_CTL_IO	4096
148 /*
149  * Number of Accept Target I/O CCBs to allocate and queue down to the
150  * adapter per LUN.
151  * XXX KDM should this be controlled by CTL?
152  */
153 #define	CTLFE_ATIO_PER_LUN	1024
154 /*
155  * Number of Immediate Notify CCBs (used for aborts, resets, etc.) to
156  * allocate and queue down to the adapter per LUN.
157  * XXX KDM should this be controlled by CTL?
158  */
159 #define	CTLFE_IN_PER_LUN	1024
160 
161 /*
162  * Timeout (in seconds) on CTIO CCB allocation for doing a DMA or sending
163  * status to the initiator.  The SIM is expected to have its own timeouts,
164  * so we're not putting this timeout around the CCB execution time.  The
165  * SIM should timeout and let us know if it has an issue.
166  */
167 #define	CTLFE_DMA_TIMEOUT	60
168 
169 /*
170  * Turn this on to enable extra debugging prints.
171  */
172 #if 0
173 #define	CTLFE_DEBUG
174 #endif
175 
176 /*
177  * Use randomly assigned WWNN/WWPN values.  This is to work around an issue
178  * in the FreeBSD initiator that makes it unable to rescan the target if
179  * the target gets rebooted and the WWNN/WWPN stay the same.
180  */
181 #if 0
182 #define	RANDOM_WWNN
183 #endif
184 
185 SYSCTL_INT(_kern_cam_ctl, OID_AUTO, dma_enabled, CTLFLAG_RW,
186 	   &ctlfe_dma_enabled, 0, "DMA enabled");
187 MALLOC_DEFINE(M_CTLFE, "CAM CTL FE", "CAM CTL FE interface");
188 
189 #define	ccb_type	ppriv_field0
190 /* This is only used in the ATIO */
191 #define	io_ptr		ppriv_ptr1
192 
193 /* This is only used in the CTIO */
194 #define	ccb_atio	ppriv_ptr1
195 
196 int			ctlfeinitialize(void);
197 void			ctlfeshutdown(void);
198 static periph_init_t	ctlfeinit;
199 static void		ctlfeasync(void *callback_arg, uint32_t code,
200 				   struct cam_path *path, void *arg);
201 static periph_ctor_t	ctlferegister;
202 static periph_oninv_t	ctlfeoninvalidate;
203 static periph_dtor_t	ctlfecleanup;
204 static periph_start_t	ctlfestart;
205 static void		ctlfedone(struct cam_periph *periph,
206 				  union ccb *done_ccb);
207 
208 static void 		ctlfe_onoffline(void *arg, int online);
209 static void 		ctlfe_online(void *arg);
210 static void 		ctlfe_offline(void *arg);
211 static int 		ctlfe_targ_enable(void *arg, struct ctl_id targ_id);
212 static int 		ctlfe_targ_disable(void *arg, struct ctl_id targ_id);
213 static int 		ctlfe_lun_enable(void *arg, struct ctl_id targ_id,
214 					 int lun_id);
215 static int 		ctlfe_lun_disable(void *arg, struct ctl_id targ_id,
216 					  int lun_id);
217 static void		ctlfe_dump_sim(struct cam_sim *sim);
218 static void		ctlfe_dump_queue(struct ctlfe_lun_softc *softc);
219 static void		ctlfe_dma_timeout(void *arg);
220 static void 		ctlfe_datamove_done(union ctl_io *io);
221 static void 		ctlfe_dump(void);
222 
223 static struct periph_driver ctlfe_driver =
224 {
225 	ctlfeinit, "ctl",
226 	TAILQ_HEAD_INITIALIZER(ctlfe_driver.units), /*generation*/ 0
227 };
228 PERIPHDRIVER_DECLARE(ctl, ctlfe_driver);
229 
230 extern struct ctl_softc *control_softc;
231 extern int ctl_disable;
232 
233 int
234 ctlfeinitialize(void)
235 {
236 	cam_status status;
237 
238 	/* Don't initialize if we're disabled */
239 	if (ctl_disable != 0)
240 		return (0);
241 
242 	STAILQ_INIT(&ctlfe_softc_list);
243 
244 	mtx_init(&ctlfe_list_mtx, ctlfe_mtx_desc, NULL, MTX_DEF);
245 
246 	xpt_lock_buses();
247 	periphdriver_register(&ctlfe_driver);
248 	xpt_unlock_buses();
249 
250 	status = xpt_register_async(AC_PATH_REGISTERED | AC_PATH_DEREGISTERED |
251 				    AC_CONTRACT, ctlfeasync, NULL, NULL);
252 
253 	if (status != CAM_REQ_CMP) {
254 		printf("ctl: Failed to attach async callback due to CAM "
255 		       "status 0x%x!\n", status);
256 	}
257 
258 	return (0);
259 }
260 
261 void
262 ctlfeshutdown(void)
263 {
264 	return;
265 }
266 
267 void
268 ctlfeinit(void)
269 {
270 	cam_status status;
271 
272 	/* Don't initialize if we're disabled */
273 	if (ctl_disable != 0)
274 		return;
275 
276 	STAILQ_INIT(&ctlfe_softc_list);
277 
278 	mtx_init(&ctlfe_list_mtx, ctlfe_mtx_desc, NULL, MTX_DEF);
279 
280 	KASSERT(control_softc != NULL, ("CTL is not initialized!"));
281 
282 	status = xpt_register_async(AC_PATH_REGISTERED | AC_PATH_DEREGISTERED |
283 				    AC_CONTRACT, ctlfeasync, NULL, NULL);
284 
285 	if (status != CAM_REQ_CMP) {
286 		printf("ctl: Failed to attach async callback due to CAM "
287 		       "status 0x%x!\n", status);
288 	}
289 }
290 
291 static void
292 ctlfeasync(void *callback_arg, uint32_t code, struct cam_path *path, void *arg)
293 {
294 
295 #ifdef CTLFEDEBUG
296 	printf("%s: entered\n", __func__);
297 #endif
298 
299 	/*
300 	 * When a new path gets registered, and it is capable of target
301 	 * mode, go ahead and attach.  Later on, we may need to be more
302 	 * selective, but for now this will be sufficient.
303  	 */
304 	switch (code) {
305 	case AC_PATH_REGISTERED: {
306 		struct ctl_frontend *fe;
307 		struct ctlfe_softc *bus_softc;
308 		struct ccb_pathinq *cpi;
309 		int retval;
310 
311 		cpi = (struct ccb_pathinq *)arg;
312 
313 		/* Don't attach if it doesn't support target mode */
314 		if ((cpi->target_sprt & PIT_PROCESSOR) == 0) {
315 #ifdef CTLFEDEBUG
316 			printf("%s: SIM %s%d doesn't support target mode\n",
317 			       __func__, cpi->dev_name, cpi->unit_number);
318 #endif
319 			break;
320 		}
321 
322 #ifdef CTLFE_INIT_ENABLE
323 		if (ctlfe_num_targets >= ctlfe_max_targets) {
324 			union ccb *ccb;
325 			struct cam_sim *sim;
326 
327 			ccb = (union ccb *)malloc(sizeof(*ccb), M_TEMP,
328 						  M_NOWAIT | M_ZERO);
329 			if (ccb == NULL) {
330 				printf("%s: unable to malloc CCB!\n", __func__);
331 				return;
332 			}
333 			xpt_setup_ccb(&ccb->ccb_h, cpi->ccb_h.path,
334 				      CAM_PRIORITY_NONE);
335 
336 			sim = xpt_path_sim(cpi->ccb_h.path);
337 
338 			ccb->ccb_h.func_code = XPT_SET_SIM_KNOB;
339 			ccb->knob.xport_specific.valid = KNOB_VALID_ROLE;
340 			ccb->knob.xport_specific.fc.role = KNOB_ROLE_INITIATOR;
341 
342 			/* We should hold the SIM lock here */
343 			mtx_assert(sim->mtx, MA_OWNED);
344 
345 			xpt_action(ccb);
346 
347 			if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
348 			     CAM_REQ_CMP) {
349 				printf("%s: SIM %s%d (path id %d) initiator "
350 				       "enable failed with status %#x\n",
351 				       __func__, cpi->dev_name,
352 				       cpi->unit_number, cpi->ccb_h.path_id,
353 				       ccb->ccb_h.status);
354 			} else {
355 				printf("%s: SIM %s%d (path id %d) initiator "
356 				       "enable succeeded\n",
357 				       __func__, cpi->dev_name,
358 				       cpi->unit_number, cpi->ccb_h.path_id);
359 			}
360 
361 			free(ccb, M_TEMP);
362 
363 			break;
364 		} else {
365 			ctlfe_num_targets++;
366 		}
367 
368 		printf("%s: ctlfe_num_targets = %d\n", __func__,
369 		       ctlfe_num_targets);
370 #endif /* CTLFE_INIT_ENABLE */
371 
372 		/*
373 		 * We're in an interrupt context here, so we have to
374 		 * use M_NOWAIT.  Of course this means trouble if we
375 		 * can't allocate memory.
376 		 */
377 		bus_softc = malloc(sizeof(*bus_softc), M_CTLFE,
378 				   M_NOWAIT | M_ZERO);
379 		if (bus_softc == NULL) {
380 			printf("%s: unable to malloc %zd bytes for softc\n",
381 			       __func__, sizeof(*bus_softc));
382 			return;
383 		}
384 
385 		bus_softc->path_id = cpi->ccb_h.path_id;
386 		bus_softc->sim = xpt_path_sim(cpi->ccb_h.path);
387 		STAILQ_INIT(&bus_softc->lun_softc_list);
388 
389 		fe = &bus_softc->fe;
390 
391 		/*
392 		 * XXX KDM should we be more accurate here ?
393 		 */
394 		if (cpi->transport == XPORT_FC)
395 			fe->port_type = CTL_PORT_FC;
396 		else
397 			fe->port_type = CTL_PORT_SCSI;
398 
399 		/* XXX KDM what should the real number be here? */
400 		fe->num_requested_ctl_io = 4096;
401 		snprintf(bus_softc->port_name, sizeof(bus_softc->port_name),
402 			 "%s%d", cpi->dev_name, cpi->unit_number);
403 		/*
404 		 * XXX KDM it would be nice to allocate storage in the
405 		 * frontend structure itself.
406 	 	 */
407 		fe->port_name = bus_softc->port_name;
408 		fe->physical_port = cpi->unit_number;
409 		fe->virtual_port = cpi->bus_id;
410 		fe->port_online = ctlfe_online;
411 		fe->port_offline = ctlfe_offline;
412 		fe->onoff_arg = bus_softc;
413 		fe->targ_enable = ctlfe_targ_enable;
414 		fe->targ_disable = ctlfe_targ_disable;
415 		fe->lun_enable = ctlfe_lun_enable;
416 		fe->lun_disable = ctlfe_lun_disable;
417 		fe->targ_lun_arg = bus_softc;
418 		fe->fe_datamove = ctlfe_datamove_done;
419 		fe->fe_done = ctlfe_datamove_done;
420 		fe->fe_dump = ctlfe_dump;
421 		/*
422 		 * XXX KDM the path inquiry doesn't give us the maximum
423 		 * number of targets supported.
424 		 */
425 		fe->max_targets = cpi->max_target;
426 		fe->max_target_id = cpi->max_target;
427 
428 		/*
429 		 * XXX KDM need to figure out whether we're the master or
430 		 * slave.
431 		 */
432 #ifdef CTLFEDEBUG
433 		printf("%s: calling ctl_frontend_register() for %s%d\n",
434 		       __func__, cpi->dev_name, cpi->unit_number);
435 #endif
436 		retval = ctl_frontend_register(fe, /*master_SC*/ 1);
437 		if (retval != 0) {
438 			printf("%s: ctl_frontend_register() failed with "
439 			       "error %d!\n", __func__, retval);
440 			free(bus_softc, M_CTLFE);
441 			break;
442 		} else {
443 			mtx_lock(&ctlfe_list_mtx);
444 			STAILQ_INSERT_TAIL(&ctlfe_softc_list, bus_softc, links);
445 			mtx_unlock(&ctlfe_list_mtx);
446 		}
447 
448 		break;
449 	}
450 	case AC_PATH_DEREGISTERED: {
451 		struct ctlfe_softc *softc = NULL;
452 
453 		mtx_lock(&ctlfe_list_mtx);
454 		STAILQ_FOREACH(softc, &ctlfe_softc_list, links) {
455 			if (softc->path_id == xpt_path_path_id(path)) {
456 				STAILQ_REMOVE(&ctlfe_softc_list, softc,
457 						ctlfe_softc, links);
458 				break;
459 			}
460 		}
461 		mtx_unlock(&ctlfe_list_mtx);
462 
463 		if (softc != NULL) {
464 			/*
465 			 * XXX KDM are we certain at this point that there
466 			 * are no outstanding commands for this frontend?
467 			 */
468 			ctl_frontend_deregister(&softc->fe);
469 			free(softc, M_CTLFE);
470 		}
471 		break;
472 	}
473 	case AC_CONTRACT: {
474 		struct ac_contract *ac;
475 
476 		ac = (struct ac_contract *)arg;
477 
478 		switch (ac->contract_number) {
479 		case AC_CONTRACT_DEV_CHG: {
480 			struct ac_device_changed *dev_chg;
481 			struct ctlfe_softc *softc;
482 			int retval, found;
483 
484 			dev_chg = (struct ac_device_changed *)ac->contract_data;
485 
486 			printf("%s: WWPN %#jx port 0x%06x path %u target %u %s\n",
487 			       __func__, dev_chg->wwpn, dev_chg->port,
488 			       xpt_path_path_id(path), dev_chg->target,
489 			       (dev_chg->arrived == 0) ?  "left" : "arrived");
490 
491 			found = 0;
492 
493 			mtx_lock(&ctlfe_list_mtx);
494 			STAILQ_FOREACH(softc, &ctlfe_softc_list, links) {
495 				if (softc->path_id == xpt_path_path_id(path)) {
496 					found = 1;
497 					break;
498 				}
499 			}
500 			mtx_unlock(&ctlfe_list_mtx);
501 
502 			if (found == 0) {
503 				printf("%s: CTL port for CAM path %u not "
504 				       "found!\n", __func__,
505 				       xpt_path_path_id(path));
506 				break;
507 			}
508 			if (dev_chg->arrived != 0) {
509 				retval = ctl_add_initiator(dev_chg->wwpn,
510 					softc->fe.targ_port, dev_chg->target);
511 			} else {
512 				retval = ctl_remove_initiator(
513 					softc->fe.targ_port, dev_chg->target);
514 			}
515 
516 			if (retval != 0) {
517 				printf("%s: could not %s port %d iid %u "
518 				       "WWPN %#jx!\n", __func__,
519 				       (dev_chg->arrived != 0) ? "add" :
520 				       "remove", softc->fe.targ_port,
521 				       dev_chg->target,
522 				       (uintmax_t)dev_chg->wwpn);
523 			}
524 			break;
525 		}
526 		default:
527 			printf("%s: unsupported contract number %ju\n",
528 			       __func__, (uintmax_t)ac->contract_number);
529 			break;
530 		}
531 		break;
532 	}
533 	default:
534 		break;
535 	}
536 }
537 
538 static cam_status
539 ctlferegister(struct cam_periph *periph, void *arg)
540 {
541 	struct ctlfe_softc *bus_softc;
542 	struct ctlfe_lun_softc *softc;
543 	struct cam_sim *sim;
544 	union ccb en_lun_ccb;
545 	cam_status status;
546 	int i;
547 
548 	softc = (struct ctlfe_lun_softc *)arg;
549 	bus_softc = softc->parent_softc;
550 	sim = xpt_path_sim(periph->path);
551 
552 	TAILQ_INIT(&softc->work_queue);
553 	softc->periph = periph;
554 
555 	callout_init_mtx(&softc->dma_callout, sim->mtx, /*flags*/ 0);
556 	periph->softc = softc;
557 
558 	xpt_setup_ccb(&en_lun_ccb.ccb_h, periph->path, CAM_PRIORITY_NONE);
559 	en_lun_ccb.ccb_h.func_code = XPT_EN_LUN;
560 	en_lun_ccb.cel.grp6_len = 0;
561 	en_lun_ccb.cel.grp7_len = 0;
562 	en_lun_ccb.cel.enable = 1;
563 	xpt_action(&en_lun_ccb);
564 	status = (en_lun_ccb.ccb_h.status & CAM_STATUS_MASK);
565 	if (status != CAM_REQ_CMP) {
566 		xpt_print(periph->path, "%s: Enable LUN failed, status 0x%x\n",
567 			  __func__, en_lun_ccb.ccb_h.status);
568 		return (status);
569 	}
570 
571 	status = CAM_REQ_CMP;
572 
573 	for (i = 0; i < CTLFE_ATIO_PER_LUN; i++) {
574 		union ccb *new_ccb;
575 
576 		new_ccb = (union ccb *)malloc(sizeof(*new_ccb), M_CTLFE,
577 					      M_ZERO|M_NOWAIT);
578 		if (new_ccb == NULL) {
579 			status = CAM_RESRC_UNAVAIL;
580 			break;
581 		}
582 		xpt_setup_ccb(&new_ccb->ccb_h, periph->path, /*priority*/ 1);
583 		new_ccb->ccb_h.func_code = XPT_ACCEPT_TARGET_IO;
584 		new_ccb->ccb_h.cbfcnp = ctlfedone;
585 		xpt_action(new_ccb);
586 		softc->atios_sent++;
587 		status = new_ccb->ccb_h.status;
588 		if ((status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
589 			free(new_ccb, M_CTLFE);
590 			break;
591 		}
592 	}
593 
594 	status = cam_periph_acquire(periph);
595 	if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
596 		xpt_print(periph->path, "%s: could not acquire reference "
597 			  "count, status = %#x\n", __func__, status);
598 		return (status);
599 	}
600 
601 	if (i == 0) {
602 		xpt_print(periph->path, "%s: could not allocate ATIO CCBs, "
603 			  "status 0x%x\n", __func__, status);
604 		return (CAM_REQ_CMP_ERR);
605 	}
606 
607 	for (i = 0; i < CTLFE_IN_PER_LUN; i++) {
608 		union ccb *new_ccb;
609 
610 		new_ccb = (union ccb *)malloc(sizeof(*new_ccb), M_CTLFE,
611 					      M_ZERO|M_NOWAIT);
612 		if (new_ccb == NULL) {
613 			status = CAM_RESRC_UNAVAIL;
614 			break;
615 		}
616 
617 		xpt_setup_ccb(&new_ccb->ccb_h, periph->path, /*priority*/ 1);
618 		new_ccb->ccb_h.func_code = XPT_IMMEDIATE_NOTIFY;
619 		new_ccb->ccb_h.cbfcnp = ctlfedone;
620 		xpt_action(new_ccb);
621 		softc->inots_sent++;
622 		status = new_ccb->ccb_h.status;
623 		if ((status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
624 			/*
625 			 * Note that we don't free the CCB here.  If the
626 			 * status is not CAM_REQ_INPROG, then we're
627 			 * probably talking to a SIM that says it is
628 			 * target-capable but doesn't support the
629 			 * XPT_IMMEDIATE_NOTIFY CCB.  i.e. it supports the
630 			 * older API.  In that case, it'll call xpt_done()
631 			 * on the CCB, and we need to free it in our done
632 			 * routine as a result.
633 			 */
634 			break;
635 		}
636 	}
637 	if ((i == 0)
638 	 || (status != CAM_REQ_INPROG)) {
639 		xpt_print(periph->path, "%s: could not allocate immediate "
640 			  "notify CCBs, status 0x%x\n", __func__, status);
641 		return (CAM_REQ_CMP_ERR);
642 	}
643 	return (CAM_REQ_CMP);
644 }
645 
646 static void
647 ctlfeoninvalidate(struct cam_periph *periph)
648 {
649 	union ccb en_lun_ccb;
650 	cam_status status;
651 	struct ctlfe_lun_softc *softc;
652 
653 	softc = (struct ctlfe_lun_softc *)periph->softc;
654 
655 	xpt_setup_ccb(&en_lun_ccb.ccb_h, periph->path, CAM_PRIORITY_NONE);
656 	en_lun_ccb.ccb_h.func_code = XPT_EN_LUN;
657 	en_lun_ccb.cel.grp6_len = 0;
658 	en_lun_ccb.cel.grp7_len = 0;
659 	en_lun_ccb.cel.enable = 0;
660 	xpt_action(&en_lun_ccb);
661 	status = (en_lun_ccb.ccb_h.status & CAM_STATUS_MASK);
662 	if (status != CAM_REQ_CMP) {
663 		xpt_print(periph->path, "%s: Disable LUN failed, status 0x%x\n",
664 			  __func__, en_lun_ccb.ccb_h.status);
665 		/*
666 		 * XXX KDM what do we do now?
667 		 */
668 	}
669 	xpt_print(periph->path, "LUN removed, %ju ATIOs outstanding, %ju "
670 		  "INOTs outstanding, %d refs\n", softc->atios_sent -
671 		  softc->atios_returned, softc->inots_sent -
672 		  softc->inots_returned, periph->refcount);
673 }
674 
675 static void
676 ctlfecleanup(struct cam_periph *periph)
677 {
678 	struct ctlfe_lun_softc *softc;
679 	struct ctlfe_softc *bus_softc;
680 
681 	xpt_print(periph->path, "%s: Called\n", __func__);
682 
683 	softc = (struct ctlfe_lun_softc *)periph->softc;
684 	bus_softc = softc->parent_softc;
685 
686 	STAILQ_REMOVE(&bus_softc->lun_softc_list, softc, ctlfe_lun_softc, links);
687 
688 	/*
689 	 * XXX KDM is there anything else that needs to be done here?
690 	 */
691 
692 	callout_stop(&softc->dma_callout);
693 
694 	free(softc, M_CTLFE);
695 }
696 
697 static void
698 ctlfestart(struct cam_periph *periph, union ccb *start_ccb)
699 {
700 	struct ctlfe_lun_softc *softc;
701 	struct ccb_hdr *ccb_h;
702 
703 	softc = (struct ctlfe_lun_softc *)periph->softc;
704 
705 	softc->ccbs_alloced++;
706 
707 	start_ccb->ccb_h.ccb_type = CTLFE_CCB_DEFAULT;
708 
709 	ccb_h = TAILQ_FIRST(&softc->work_queue);
710 	if (periph->immediate_priority <= periph->pinfo.priority) {
711 		panic("shouldn't get to the CCB waiting case!");
712 		start_ccb->ccb_h.ccb_type = CTLFE_CCB_WAITING;
713 		SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
714 				  periph_links.sle);
715 		periph->immediate_priority = CAM_PRIORITY_NONE;
716 		wakeup(&periph->ccb_list);
717 	} else if (ccb_h == NULL) {
718 		softc->ccbs_freed++;
719 		xpt_release_ccb(start_ccb);
720 	} else {
721 		struct ccb_accept_tio *atio;
722 		struct ccb_scsiio *csio;
723 		uint8_t *data_ptr;
724 		uint32_t dxfer_len;
725 		ccb_flags flags;
726 		union ctl_io *io;
727 		uint8_t scsi_status;
728 
729 		/* Take the ATIO off the work queue */
730 		TAILQ_REMOVE(&softc->work_queue, ccb_h, periph_links.tqe);
731 		atio = (struct ccb_accept_tio *)ccb_h;
732 		io = (union ctl_io *)ccb_h->io_ptr;
733 		csio = &start_ccb->csio;
734 
735 		flags = atio->ccb_h.flags &
736 			(CAM_DIS_DISCONNECT|CAM_TAG_ACTION_VALID|CAM_DIR_MASK);
737 
738 		if ((io == NULL)
739 		 || (io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE) {
740 			/*
741 			 * We're done, send status back.
742 			 */
743 			flags |= CAM_SEND_STATUS;
744 			if (io == NULL) {
745 				scsi_status = SCSI_STATUS_BUSY;
746 				csio->sense_len = 0;
747 			} else if ((io->io_hdr.status & CTL_STATUS_MASK) ==
748 				   CTL_CMD_ABORTED) {
749 				io->io_hdr.flags &= ~CTL_FLAG_STATUS_QUEUED;
750 
751 				/*
752 				 * If this command was aborted, we don't
753 				 * need to send status back to the SIM.
754 				 * Just free the CTIO and ctl_io, and
755 				 * recycle the ATIO back to the SIM.
756 				 */
757 				xpt_print(periph->path, "%s: aborted "
758 					  "command 0x%04x discarded\n",
759 					  __func__, io->scsiio.tag_num);
760 				ctl_free_io(io);
761 				/*
762 				 * For a wildcard attachment, commands can
763 				 * come in with a specific target/lun.  Reset
764 				 * the target and LUN fields back to the
765 				 * wildcard values before we send them back
766 				 * down to the SIM.  The SIM has a wildcard
767 				 * LUN enabled, not whatever target/lun
768 				 * these happened to be.
769 				 */
770 				if (softc->flags & CTLFE_LUN_WILDCARD) {
771 					atio->ccb_h.target_id =
772 						CAM_TARGET_WILDCARD;
773 					atio->ccb_h.target_lun =
774 						CAM_LUN_WILDCARD;
775 				}
776 
777 				if ((atio->ccb_h.status & CAM_DEV_QFRZN) != 0) {
778 					cam_release_devq(periph->path,
779 							 /*relsim_flags*/0,
780 							 /*reduction*/0,
781  							 /*timeout*/0,
782 							 /*getcount_only*/0);
783 					atio->ccb_h.status &= ~CAM_DEV_QFRZN;
784 				}
785 
786 				ccb_h = TAILQ_FIRST(&softc->work_queue);
787 
788 				if (atio->ccb_h.func_code !=
789 				    XPT_ACCEPT_TARGET_IO) {
790 					xpt_print(periph->path, "%s: func_code "
791 						  "is %#x\n", __func__,
792 						  atio->ccb_h.func_code);
793 				}
794 				start_ccb->ccb_h.func_code = XPT_ABORT;
795 				start_ccb->cab.abort_ccb = (union ccb *)atio;
796 				start_ccb->ccb_h.cbfcnp = ctlfedone;
797 
798 				/* Tell the SIM that we've aborted this ATIO */
799 				xpt_action(start_ccb);
800 				softc->ccbs_freed++;
801 				xpt_release_ccb(start_ccb);
802 
803 				/*
804 				 * Send the ATIO back down to the SIM.
805 				 */
806 				xpt_action((union ccb *)atio);
807 				softc->atios_sent++;
808 
809 				/*
810 				 * If we still have work to do, ask for
811 				 * another CCB.  Otherwise, deactivate our
812 				 * callout.
813 				 */
814 				if (ccb_h != NULL)
815 					xpt_schedule(periph, /*priority*/ 1);
816 				else
817 					callout_stop(&softc->dma_callout);
818 
819 				return;
820 			} else {
821 				io->io_hdr.flags &= ~CTL_FLAG_STATUS_QUEUED;
822 				scsi_status = io->scsiio.scsi_status;
823 				csio->sense_len = io->scsiio.sense_len;
824 			}
825 			data_ptr = NULL;
826 			dxfer_len = 0;
827 			if (io == NULL) {
828 				printf("%s: tag %04x io is NULL\n", __func__,
829 				       atio->tag_id);
830 			} else {
831 #ifdef CTLFEDEBUG
832 				printf("%s: tag %04x status %x\n", __func__,
833 				       atio->tag_id, io->io_hdr.status);
834 #endif
835 			}
836 			csio->sglist_cnt = 0;
837 			if (csio->sense_len != 0) {
838 				csio->sense_data = io->scsiio.sense_data;
839 				flags |= CAM_SEND_SENSE;
840 			} else if (scsi_status == SCSI_STATUS_CHECK_COND) {
841 				xpt_print(periph->path, "%s: check condition "
842 					  "with no sense\n", __func__);
843 			}
844 		} else {
845 			struct ctlfe_lun_cmd_info *cmd_info;
846 
847 			/*
848 			 * Datamove call, we need to setup the S/G list.
849 			 */
850 
851 			cmd_info = (struct ctlfe_lun_cmd_info *)
852 				io->io_hdr.port_priv;
853 
854 			KASSERT(sizeof(*cmd_info) < CTL_PORT_PRIV_SIZE,
855 				("%s: sizeof(struct ctlfe_lun_cmd_info) %zd < "
856 				"CTL_PORT_PRIV_SIZE %d", __func__,
857 				sizeof(*cmd_info), CTL_PORT_PRIV_SIZE));
858 			io->io_hdr.flags &= ~CTL_FLAG_DMA_QUEUED;
859 
860 			/*
861 			 * Need to zero this, in case it has been used for
862 			 * a previous datamove for this particular I/O.
863 			 */
864 			bzero(cmd_info, sizeof(*cmd_info));
865 			scsi_status = 0;
866 
867 			/*
868 			 * Set the direction, relative to the initiator.
869 			 */
870 			flags &= ~CAM_DIR_MASK;
871 			if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
872 			     CTL_FLAG_DATA_IN)
873 				flags |= CAM_DIR_IN;
874 			else
875 				flags |= CAM_DIR_OUT;
876 
877 			csio->cdb_len = atio->cdb_len;
878 
879 			if (io->scsiio.kern_sg_entries == 0) {
880 				/* No S/G list */
881 				data_ptr = io->scsiio.kern_data_ptr;
882 				dxfer_len = io->scsiio.kern_data_len;
883 				csio->sglist_cnt = 0;
884 
885 				if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR)
886 					flags |= CAM_DATA_PHYS;
887 			} else if (io->scsiio.kern_sg_entries <=
888 				   (sizeof(cmd_info->cam_sglist)/
889 				   sizeof(cmd_info->cam_sglist[0]))) {
890 				/*
891 				 * S/G list with physical or virtual pointers.
892 				 * Just populate the CAM S/G list with the
893 				 * pointers.
894 				 */
895 				int i;
896 				struct ctl_sg_entry *ctl_sglist;
897 				bus_dma_segment_t *cam_sglist;
898 
899 				ctl_sglist = (struct ctl_sg_entry *)
900 					io->scsiio.kern_data_ptr;
901 				cam_sglist = cmd_info->cam_sglist;
902 
903 				for (i = 0; i < io->scsiio.kern_sg_entries;i++){
904 					cam_sglist[i].ds_addr =
905 						(bus_addr_t)ctl_sglist[i].addr;
906 					cam_sglist[i].ds_len =
907 						ctl_sglist[i].len;
908 				}
909 				csio->sglist_cnt = io->scsiio.kern_sg_entries;
910 				flags |= CAM_SCATTER_VALID;
911 				if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR)
912 					flags |= CAM_SG_LIST_PHYS;
913 				else
914 					flags &= ~CAM_SG_LIST_PHYS;
915 				data_ptr = (uint8_t *)cam_sglist;
916 				dxfer_len = io->scsiio.kern_data_len;
917 			} else {
918 				/* S/G list with virtual pointers */
919 				struct ctl_sg_entry *sglist;
920 				int *ti;
921 
922 				/*
923 				 * If we have more S/G list pointers than
924 				 * will fit in the available storage in the
925 				 * cmd_info structure inside the ctl_io header,
926 				 * then we need to send down the pointers
927 				 * one element at a time.
928 				 */
929 
930 				sglist = (struct ctl_sg_entry *)
931 					io->scsiio.kern_data_ptr;
932 				ti = &cmd_info->cur_transfer_index;
933 				data_ptr = sglist[*ti].addr;
934 				dxfer_len = sglist[*ti].len;
935 				csio->sglist_cnt = 0;
936 				cmd_info->flags |= CTLFE_CMD_PIECEWISE;
937 				(*ti)++;
938 			}
939 
940 			io->scsiio.ext_data_filled += dxfer_len;
941 
942 			if (io->scsiio.ext_data_filled >
943 			    io->scsiio.kern_total_len) {
944 				xpt_print(periph->path, "%s: tag 0x%04x "
945 					  "fill len %u > total %u\n",
946 					  __func__, io->scsiio.tag_num,
947 					  io->scsiio.ext_data_filled,
948 					  io->scsiio.kern_total_len);
949 			}
950 		}
951 
952 #ifdef CTLFEDEBUG
953 		printf("%s: %s: tag %04x flags %x ptr %p len %u\n", __func__,
954 		       (flags & CAM_SEND_STATUS) ? "done" : "datamove",
955 		       atio->tag_id, flags, data_ptr, dxfer_len);
956 #endif
957 
958 		/*
959 		 * Valid combinations:
960 		 *  - CAM_SEND_STATUS, SCATTER_VALID = 0, dxfer_len = 0,
961 		 *    sglist_cnt = 0
962 		 *  - CAM_SEND_STATUS = 0, SCATTER_VALID = 0, dxfer_len != 0,
963 		 *    sglist_cnt = 0
964 		 *  - CAM_SEND_STATUS = 0, SCATTER_VALID, dxfer_len != 0,
965 		 *    sglist_cnt != 0
966 		 */
967 #ifdef CTLFEDEBUG
968 		if (((flags & CAM_SEND_STATUS)
969 		  && (((flags & CAM_SCATTER_VALID) != 0)
970 		   || (dxfer_len != 0)
971 		   || (csio->sglist_cnt != 0)))
972 		 || (((flags & CAM_SEND_STATUS) == 0)
973 		  && (dxfer_len == 0))
974 		 || ((flags & CAM_SCATTER_VALID)
975 		  && (csio->sglist_cnt == 0))
976 		 || (((flags & CAM_SCATTER_VALID) == 0)
977 		  && (csio->sglist_cnt != 0))) {
978 			printf("%s: tag %04x cdb %02x flags %#x dxfer_len "
979 			       "%d sg %u\n", __func__, atio->tag_id,
980 			       atio->cdb_io.cdb_bytes[0], flags, dxfer_len,
981 			       csio->sglist_cnt);
982 			if (io != NULL) {
983 				printf("%s: tag %04x io status %#x\n", __func__,
984 				       atio->tag_id, io->io_hdr.status);
985 			} else {
986 				printf("%s: tag %04x no associated io\n",
987 				       __func__, atio->tag_id);
988 			}
989 		}
990 #endif
991 		cam_fill_ctio(csio,
992 			      /*retries*/ 2,
993 			      ctlfedone,
994 			      flags,
995 			      (flags & CAM_TAG_ACTION_VALID) ?
996 			       MSG_SIMPLE_Q_TAG : 0,
997 			      atio->tag_id,
998 			      atio->init_id,
999 			      scsi_status,
1000 			      /*data_ptr*/ data_ptr,
1001 			      /*dxfer_len*/ dxfer_len,
1002 			      /*timeout*/ 5 * 1000);
1003 		start_ccb->ccb_h.ccb_atio = atio;
1004 		if (((flags & CAM_SEND_STATUS) == 0)
1005 		 && (io != NULL))
1006 			io->io_hdr.flags |= CTL_FLAG_DMA_INPROG;
1007 
1008 		softc->ctios_sent++;
1009 
1010 		xpt_action(start_ccb);
1011 
1012 		if ((atio->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1013 			cam_release_devq(periph->path,
1014 					 /*relsim_flags*/0,
1015 					 /*reduction*/0,
1016  					 /*timeout*/0,
1017 					 /*getcount_only*/0);
1018 			atio->ccb_h.status &= ~CAM_DEV_QFRZN;
1019 		}
1020 
1021 		ccb_h = TAILQ_FIRST(&softc->work_queue);
1022 	}
1023 	/*
1024 	 * If we still have work to do, ask for another CCB.  Otherwise,
1025 	 * deactivate our callout.
1026 	 */
1027 	if (ccb_h != NULL)
1028 		xpt_schedule(periph, /*priority*/ 1);
1029 	else
1030 		callout_stop(&softc->dma_callout);
1031 }
1032 
1033 static void
1034 ctlfe_free_ccb(struct cam_periph *periph, union ccb *ccb)
1035 {
1036 	struct ctlfe_lun_softc *softc;
1037 
1038 	softc = (struct ctlfe_lun_softc *)periph->softc;
1039 
1040 	switch (ccb->ccb_h.func_code) {
1041 	case XPT_ACCEPT_TARGET_IO:
1042 		softc->atios_returned++;
1043 		break;
1044 	case XPT_IMMEDIATE_NOTIFY:
1045 	case XPT_NOTIFY_ACKNOWLEDGE:
1046 		softc->inots_returned++;
1047 		break;
1048 	default:
1049 		break;
1050 	}
1051 
1052 	free(ccb, M_CTLFE);
1053 
1054 	KASSERT(softc->atios_returned <= softc->atios_sent, ("%s: "
1055 		"atios_returned %ju > atios_sent %ju", __func__,
1056 		softc->atios_returned, softc->atios_sent));
1057 	KASSERT(softc->inots_returned <= softc->inots_sent, ("%s: "
1058 		"inots_returned %ju > inots_sent %ju", __func__,
1059 		softc->inots_returned, softc->inots_sent));
1060 
1061 	/*
1062 	 * If we have received all of our CCBs, we can release our
1063 	 * reference on the peripheral driver.  It will probably go away
1064 	 * now.
1065 	 */
1066 	if ((softc->atios_returned == softc->atios_sent)
1067 	 && (softc->inots_returned == softc->inots_sent)) {
1068 		cam_periph_release_locked(periph);
1069 	}
1070 }
1071 
1072 static int
1073 ctlfe_adjust_cdb(struct ccb_accept_tio *atio, uint32_t offset)
1074 {
1075 	uint64_t lba;
1076 	uint32_t num_blocks, nbc;
1077 	uint8_t *cmdbyt = (atio->ccb_h.flags & CAM_CDB_POINTER)?
1078 	    atio->cdb_io.cdb_ptr : atio->cdb_io.cdb_bytes;
1079 
1080 	nbc = offset >> 9;	/* ASSUMING 512 BYTE BLOCKS */
1081 
1082 	switch (cmdbyt[0]) {
1083 	case READ_6:
1084 	case WRITE_6:
1085 	{
1086 		struct scsi_rw_6 *cdb = (struct scsi_rw_6 *)cmdbyt;
1087 		lba = scsi_3btoul(cdb->addr);
1088 		lba &= 0x1fffff;
1089 		num_blocks = cdb->length;
1090 		if (num_blocks == 0)
1091 			num_blocks = 256;
1092 		lba += nbc;
1093 		num_blocks -= nbc;
1094 		scsi_ulto3b(lba, cdb->addr);
1095 		cdb->length = num_blocks;
1096 		break;
1097 	}
1098 	case READ_10:
1099 	case WRITE_10:
1100 	{
1101 		struct scsi_rw_10 *cdb = (struct scsi_rw_10 *)cmdbyt;
1102 		lba = scsi_4btoul(cdb->addr);
1103 		num_blocks = scsi_2btoul(cdb->length);
1104 		lba += nbc;
1105 		num_blocks -= nbc;
1106 		scsi_ulto4b(lba, cdb->addr);
1107 		scsi_ulto2b(num_blocks, cdb->length);
1108 		break;
1109 	}
1110 	case READ_12:
1111 	case WRITE_12:
1112 	{
1113 		struct scsi_rw_12 *cdb = (struct scsi_rw_12 *)cmdbyt;
1114 		lba = scsi_4btoul(cdb->addr);
1115 		num_blocks = scsi_4btoul(cdb->length);
1116 		lba += nbc;
1117 		num_blocks -= nbc;
1118 		scsi_ulto4b(lba, cdb->addr);
1119 		scsi_ulto4b(num_blocks, cdb->length);
1120 		break;
1121 	}
1122 	case READ_16:
1123 	case WRITE_16:
1124 	{
1125 		struct scsi_rw_16 *cdb = (struct scsi_rw_16 *)cmdbyt;
1126 		lba = scsi_8btou64(cdb->addr);
1127 		num_blocks = scsi_4btoul(cdb->length);
1128 		lba += nbc;
1129 		num_blocks -= nbc;
1130 		scsi_u64to8b(lba, cdb->addr);
1131 		scsi_ulto4b(num_blocks, cdb->length);
1132 		break;
1133 	}
1134 	default:
1135 		return -1;
1136 	}
1137 	return (0);
1138 }
1139 
1140 static void
1141 ctlfedone(struct cam_periph *periph, union ccb *done_ccb)
1142 {
1143 	struct ctlfe_lun_softc *softc;
1144 	struct ctlfe_softc *bus_softc;
1145 	struct ccb_accept_tio *atio = NULL;
1146 	union ctl_io *io = NULL;
1147 
1148 #ifdef CTLFE_DEBUG
1149 	printf("%s: entered, func_code = %#x, type = %#lx\n", __func__,
1150 	       done_ccb->ccb_h.func_code, done_ccb->ccb_h.ccb_type);
1151 #endif
1152 
1153 	softc = (struct ctlfe_lun_softc *)periph->softc;
1154 	bus_softc = softc->parent_softc;
1155 
1156 	if (done_ccb->ccb_h.ccb_type == CTLFE_CCB_WAITING) {
1157 		panic("shouldn't get to the CCB waiting case!");
1158 		wakeup(&done_ccb->ccb_h.cbfcnp);
1159 		return;
1160 	}
1161 
1162 	/*
1163 	 * If the peripheral is invalid, ATIOs and immediate notify CCBs
1164 	 * need to be freed.  Most of the ATIOs and INOTs that come back
1165 	 * will be CCBs that are being returned from the SIM as a result of
1166 	 * our disabling the LUN.
1167 	 *
1168 	 * Other CCB types are handled in their respective cases below.
1169 	 */
1170 	if (periph->flags & CAM_PERIPH_INVALID) {
1171 		switch (done_ccb->ccb_h.func_code) {
1172 		case XPT_ACCEPT_TARGET_IO:
1173 		case XPT_IMMEDIATE_NOTIFY:
1174 		case XPT_NOTIFY_ACKNOWLEDGE:
1175 			ctlfe_free_ccb(periph, done_ccb);
1176 			return;
1177 		default:
1178 			break;
1179 		}
1180 
1181 	}
1182 	switch (done_ccb->ccb_h.func_code) {
1183 	case XPT_ACCEPT_TARGET_IO: {
1184 
1185 		atio = &done_ccb->atio;
1186 
1187 		softc->atios_returned++;
1188 
1189  resubmit:
1190 		/*
1191 		 * Allocate a ctl_io, pass it to CTL, and wait for the
1192 		 * datamove or done.
1193 		 */
1194 		io = ctl_alloc_io(bus_softc->fe.ctl_pool_ref);
1195 		if (io == NULL) {
1196 			atio->ccb_h.flags &= ~CAM_DIR_MASK;
1197 			atio->ccb_h.flags |= CAM_DIR_NONE;
1198 
1199 			printf("%s: ctl_alloc_io failed!\n", __func__);
1200 
1201 			/*
1202 			 * XXX KDM need to set SCSI_STATUS_BUSY, but there
1203 			 * is no field in the ATIO structure to do that,
1204 			 * and we aren't able to allocate a ctl_io here.
1205 			 * What to do?
1206 			 */
1207 			atio->sense_len = 0;
1208 			done_ccb->ccb_h.io_ptr = NULL;
1209 			TAILQ_INSERT_TAIL(&softc->work_queue, &atio->ccb_h,
1210 					  periph_links.tqe);
1211 			xpt_schedule(periph, /*priority*/ 1);
1212 			break;
1213 		}
1214 		ctl_zero_io(io);
1215 
1216 		/* Save pointers on both sides */
1217 		io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr = done_ccb;
1218 		done_ccb->ccb_h.io_ptr = io;
1219 
1220 		/*
1221 		 * Only SCSI I/O comes down this path, resets, etc. come
1222 		 * down the immediate notify path below.
1223 		 */
1224 		io->io_hdr.io_type = CTL_IO_SCSI;
1225 		io->io_hdr.nexus.initid.id = atio->init_id;
1226 		io->io_hdr.nexus.targ_port = bus_softc->fe.targ_port;
1227 		io->io_hdr.nexus.targ_target.id = atio->ccb_h.target_id;
1228 		io->io_hdr.nexus.targ_lun = atio->ccb_h.target_lun;
1229 		io->scsiio.tag_num = atio->tag_id;
1230 		switch (atio->tag_action) {
1231 		case CAM_TAG_ACTION_NONE:
1232 			io->scsiio.tag_type = CTL_TAG_UNTAGGED;
1233 			break;
1234 		case MSG_SIMPLE_TASK:
1235 			io->scsiio.tag_type = CTL_TAG_SIMPLE;
1236 			break;
1237 		case MSG_HEAD_OF_QUEUE_TASK:
1238         		io->scsiio.tag_type = CTL_TAG_HEAD_OF_QUEUE;
1239 			break;
1240 		case MSG_ORDERED_TASK:
1241         		io->scsiio.tag_type = CTL_TAG_ORDERED;
1242 			break;
1243 		case MSG_ACA_TASK:
1244 			io->scsiio.tag_type = CTL_TAG_ACA;
1245 			break;
1246 		default:
1247 			io->scsiio.tag_type = CTL_TAG_UNTAGGED;
1248 			printf("%s: unhandled tag type %#x!!\n", __func__,
1249 			       atio->tag_action);
1250 			break;
1251 		}
1252 		if (atio->cdb_len > sizeof(io->scsiio.cdb)) {
1253 			printf("%s: WARNING: CDB len %d > ctl_io space %zd\n",
1254 			       __func__, atio->cdb_len, sizeof(io->scsiio.cdb));
1255 		}
1256 		io->scsiio.cdb_len = min(atio->cdb_len, sizeof(io->scsiio.cdb));
1257 		bcopy(atio->cdb_io.cdb_bytes, io->scsiio.cdb,
1258 		      io->scsiio.cdb_len);
1259 
1260 #ifdef CTLFEDEBUG
1261 		printf("%s: %ju:%d:%ju:%d: tag %04x CDB %02x\n", __func__,
1262 		        (uintmax_t)io->io_hdr.nexus.initid.id,
1263 		        io->io_hdr.nexus.targ_port,
1264 		        (uintmax_t)io->io_hdr.nexus.targ_target.id,
1265 		        io->io_hdr.nexus.targ_lun,
1266 			io->scsiio.tag_num, io->scsiio.cdb[0]);
1267 #endif
1268 
1269 		ctl_queue(io);
1270 		break;
1271 	}
1272 	case XPT_CONT_TARGET_IO: {
1273 		int srr = 0;
1274 		uint32_t srr_off = 0;
1275 
1276 		atio = (struct ccb_accept_tio *)done_ccb->ccb_h.ccb_atio;
1277 		io = (union ctl_io *)atio->ccb_h.io_ptr;
1278 
1279 		softc->ctios_returned++;
1280 #ifdef CTLFEDEBUG
1281 		printf("%s: got XPT_CONT_TARGET_IO tag %#x flags %#x\n",
1282 		       __func__, atio->tag_id, done_ccb->ccb_h.flags);
1283 #endif
1284 		/*
1285 		 * Handle SRR case were the data pointer is pushed back hack
1286 		 */
1287 		if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_MESSAGE_RECV
1288 		    && done_ccb->csio.msg_ptr != NULL
1289 		    && done_ccb->csio.msg_ptr[0] == MSG_EXTENDED
1290 		    && done_ccb->csio.msg_ptr[1] == 5
1291        		    && done_ccb->csio.msg_ptr[2] == 0) {
1292 			srr = 1;
1293 			srr_off =
1294 			    (done_ccb->csio.msg_ptr[3] << 24)
1295 			    | (done_ccb->csio.msg_ptr[4] << 16)
1296 			    | (done_ccb->csio.msg_ptr[5] << 8)
1297 			    | (done_ccb->csio.msg_ptr[6]);
1298 		}
1299 
1300 		if (srr && (done_ccb->ccb_h.flags & CAM_SEND_STATUS)) {
1301 			/*
1302 			 * If status was being sent, the back end data is now
1303 			 * history. Hack it up and resubmit a new command with
1304 			 * the CDB adjusted. If the SIM does the right thing,
1305 			 * all of the resid math should work.
1306 			 */
1307 			softc->ccbs_freed++;
1308 			xpt_release_ccb(done_ccb);
1309 			ctl_free_io(io);
1310 			if (ctlfe_adjust_cdb(atio, srr_off) == 0) {
1311 				done_ccb = (union ccb *)atio;
1312 				goto resubmit;
1313 			}
1314 			/*
1315 			 * Fall through to doom....
1316 			 */
1317 		} else if (srr) {
1318 			/*
1319 			 * If we have an srr and we're still sending data, we
1320 			 * should be able to adjust offsets and cycle again.
1321 			 */
1322 			io->scsiio.kern_rel_offset =
1323 			    io->scsiio.ext_data_filled = srr_off;
1324 			io->scsiio.ext_data_len = io->scsiio.kern_total_len -
1325 			    io->scsiio.kern_rel_offset;
1326 			softc->ccbs_freed++;
1327 			io->scsiio.io_hdr.status = CTL_STATUS_NONE;
1328 			xpt_release_ccb(done_ccb);
1329 			TAILQ_INSERT_HEAD(&softc->work_queue, &atio->ccb_h,
1330 					  periph_links.tqe);
1331 			xpt_schedule(periph, /*priority*/ 1);
1332 			return;
1333 		}
1334 
1335 		/*
1336 		 * If we were sending status back to the initiator, free up
1337 		 * resources.  If we were doing a datamove, call the
1338 		 * datamove done routine.
1339 		 */
1340 		if (done_ccb->ccb_h.flags & CAM_SEND_STATUS) {
1341 			softc->ccbs_freed++;
1342 			xpt_release_ccb(done_ccb);
1343 			ctl_free_io(io);
1344 			/*
1345 			 * For a wildcard attachment, commands can come in
1346 			 * with a specific target/lun.  Reset the target
1347 			 * and LUN fields back to the wildcard values before
1348 			 * we send them back down to the SIM.  The SIM has
1349 			 * a wildcard LUN enabled, not whatever target/lun
1350 			 * these happened to be.
1351 			 */
1352 			if (softc->flags & CTLFE_LUN_WILDCARD) {
1353 				atio->ccb_h.target_id = CAM_TARGET_WILDCARD;
1354 				atio->ccb_h.target_lun = CAM_LUN_WILDCARD;
1355 			}
1356 			if (periph->flags & CAM_PERIPH_INVALID) {
1357 				ctlfe_free_ccb(periph, (union ccb *)atio);
1358 				return;
1359 			} else {
1360 				xpt_action((union ccb *)atio);
1361 				softc->atios_sent++;
1362 			}
1363 		} else {
1364 			struct ctlfe_lun_cmd_info *cmd_info;
1365 			struct ccb_scsiio *csio;
1366 
1367 			csio = &done_ccb->csio;
1368 			cmd_info = (struct ctlfe_lun_cmd_info *)
1369 				io->io_hdr.port_priv;
1370 
1371 			io->io_hdr.flags &= ~CTL_FLAG_DMA_INPROG;
1372 
1373 			io->scsiio.ext_data_len += csio->dxfer_len;
1374 			if (io->scsiio.ext_data_len >
1375 			    io->scsiio.kern_total_len) {
1376 				xpt_print(periph->path, "%s: tag 0x%04x "
1377 					  "done len %u > total %u sent %u\n",
1378 					  __func__, io->scsiio.tag_num,
1379 					  io->scsiio.ext_data_len,
1380 					  io->scsiio.kern_total_len,
1381 					  io->scsiio.ext_data_filled);
1382 			}
1383 			/*
1384 			 * Translate CAM status to CTL status.  Success
1385 			 * does not change the overall, ctl_io status.  In
1386 			 * that case we just set port_status to 0.  If we
1387 			 * have a failure, though, set a data phase error
1388 			 * for the overall ctl_io.
1389 			 */
1390 			switch (done_ccb->ccb_h.status & CAM_STATUS_MASK) {
1391 			case CAM_REQ_CMP:
1392 				io->io_hdr.port_status = 0;
1393 				break;
1394 			default:
1395 				/*
1396 				 * XXX KDM we probably need to figure out a
1397 				 * standard set of errors that the SIM
1398 				 * drivers should return in the event of a
1399 				 * data transfer failure.  A data phase
1400 				 * error will at least point the user to a
1401 				 * data transfer error of some sort.
1402 				 * Hopefully the SIM printed out some
1403 				 * additional information to give the user
1404 				 * a clue what happened.
1405 				 */
1406 				io->io_hdr.port_status = 0xbad1;
1407 				ctl_set_data_phase_error(&io->scsiio);
1408 				/*
1409 				 * XXX KDM figure out residual.
1410 				 */
1411 				break;
1412 			}
1413 			/*
1414 			 * If we had to break this S/G list into multiple
1415 			 * pieces, figure out where we are in the list, and
1416 			 * continue sending pieces if necessary.
1417 			 */
1418 			if ((cmd_info->flags & CTLFE_CMD_PIECEWISE)
1419 			 && (io->io_hdr.port_status == 0)
1420 			 && (cmd_info->cur_transfer_index <
1421 			     io->scsiio.kern_sg_entries)) {
1422 				struct ctl_sg_entry *sglist;
1423 				ccb_flags flags;
1424 				uint8_t scsi_status;
1425 				uint8_t *data_ptr;
1426 				uint32_t dxfer_len;
1427 				int *ti;
1428 
1429 				sglist = (struct ctl_sg_entry *)
1430 					io->scsiio.kern_data_ptr;
1431 				ti = &cmd_info->cur_transfer_index;
1432 				flags = atio->ccb_h.flags &
1433 					(CAM_DIS_DISCONNECT|
1434 					 CAM_TAG_ACTION_VALID|
1435 					 CAM_DIR_MASK);
1436 
1437 				/*
1438 				 * Set the direction, relative to the initiator.
1439 				 */
1440 				flags &= ~CAM_DIR_MASK;
1441 				if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
1442 				     CTL_FLAG_DATA_IN)
1443 					flags |= CAM_DIR_IN;
1444 				else
1445 					flags |= CAM_DIR_OUT;
1446 
1447 				data_ptr = sglist[*ti].addr;
1448 				dxfer_len = sglist[*ti].len;
1449 				(*ti)++;
1450 
1451 				scsi_status = 0;
1452 
1453 				if (((flags & CAM_SEND_STATUS) == 0)
1454 				 && (dxfer_len == 0)) {
1455 					printf("%s: tag %04x no status or "
1456 					       "len cdb = %02x\n", __func__,
1457 					       atio->tag_id,
1458 					atio->cdb_io.cdb_bytes[0]);
1459 					printf("%s: tag %04x io status %#x\n",
1460 					       __func__, atio->tag_id,
1461 					       io->io_hdr.status);
1462 				}
1463 
1464 				cam_fill_ctio(csio,
1465 					      /*retries*/ 2,
1466 					      ctlfedone,
1467 					      flags,
1468 					      (flags & CAM_TAG_ACTION_VALID) ?
1469 					       MSG_SIMPLE_Q_TAG : 0,
1470 					      atio->tag_id,
1471 					      atio->init_id,
1472 					      scsi_status,
1473 					      /*data_ptr*/ data_ptr,
1474 					      /*dxfer_len*/ dxfer_len,
1475 					      /*timeout*/ 5 * 1000);
1476 
1477 				csio->resid = 0;
1478 				csio->ccb_h.ccb_atio = atio;
1479 				io->io_hdr.flags |= CTL_FLAG_DMA_INPROG;
1480 				softc->ctios_sent++;
1481 				xpt_action((union ccb *)csio);
1482 			} else {
1483 				/*
1484 				 * Release the CTIO.  The ATIO will be sent back
1485 				 * down to the SIM once we send status.
1486 				 */
1487 				softc->ccbs_freed++;
1488 				xpt_release_ccb(done_ccb);
1489 
1490 				/* Call the backend move done callback */
1491 				io->scsiio.be_move_done(io);
1492 			}
1493 		}
1494 		break;
1495 	}
1496 	case XPT_IMMEDIATE_NOTIFY: {
1497 		union ctl_io *io;
1498 		struct ccb_immediate_notify *inot;
1499 		cam_status status;
1500 		int frozen;
1501 
1502 		inot = &done_ccb->cin1;
1503 
1504 		softc->inots_returned++;
1505 
1506 		frozen = (done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0;
1507 
1508 		printf("%s: got XPT_IMMEDIATE_NOTIFY status %#x tag %#x "
1509 		       "seq %#x\n", __func__, inot->ccb_h.status,
1510 		       inot->tag_id, inot->seq_id);
1511 
1512 		io = ctl_alloc_io(bus_softc->fe.ctl_pool_ref);
1513 		if (io != NULL) {
1514 			int send_ctl_io;
1515 
1516 			send_ctl_io = 1;
1517 
1518 			ctl_zero_io(io);
1519 			io->io_hdr.io_type = CTL_IO_TASK;
1520 			io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr =done_ccb;
1521 			inot->ccb_h.io_ptr = io;
1522 			io->io_hdr.nexus.initid.id = inot->initiator_id;
1523 			io->io_hdr.nexus.targ_port = bus_softc->fe.targ_port;
1524 			io->io_hdr.nexus.targ_target.id = inot->ccb_h.target_id;
1525 			io->io_hdr.nexus.targ_lun = inot->ccb_h.target_lun;
1526 			/* XXX KDM should this be the tag_id? */
1527 			io->taskio.tag_num = inot->seq_id;
1528 
1529 			status = inot->ccb_h.status & CAM_STATUS_MASK;
1530 			switch (status) {
1531 			case CAM_SCSI_BUS_RESET:
1532 				io->taskio.task_action = CTL_TASK_BUS_RESET;
1533 				break;
1534 			case CAM_BDR_SENT:
1535 				io->taskio.task_action = CTL_TASK_TARGET_RESET;
1536 				break;
1537 			case CAM_MESSAGE_RECV:
1538 				switch (inot->arg) {
1539 				case MSG_ABORT_TASK_SET:
1540 					/*
1541 					 * XXX KDM this isn't currently
1542 					 * supported by CTL.  It ends up
1543 					 * being a no-op.
1544 					 */
1545 					io->taskio.task_action =
1546 						CTL_TASK_ABORT_TASK_SET;
1547 					break;
1548 				case MSG_TARGET_RESET:
1549 					io->taskio.task_action =
1550 						CTL_TASK_TARGET_RESET;
1551 					break;
1552 				case MSG_ABORT_TASK:
1553 					io->taskio.task_action =
1554 						CTL_TASK_ABORT_TASK;
1555 					break;
1556 				case MSG_LOGICAL_UNIT_RESET:
1557 					io->taskio.task_action =
1558 						CTL_TASK_LUN_RESET;
1559 					break;
1560 				case MSG_CLEAR_TASK_SET:
1561 					/*
1562 					 * XXX KDM this isn't currently
1563 					 * supported by CTL.  It ends up
1564 					 * being a no-op.
1565 					 */
1566 					io->taskio.task_action =
1567 						CTL_TASK_CLEAR_TASK_SET;
1568 					break;
1569 				case MSG_CLEAR_ACA:
1570 					io->taskio.task_action =
1571 						CTL_TASK_CLEAR_ACA;
1572 					break;
1573 				case MSG_NOOP:
1574 					send_ctl_io = 0;
1575 					break;
1576 				default:
1577 					xpt_print(periph->path, "%s: "
1578 						  "unsupported message 0x%x\n",
1579 						  __func__, inot->arg);
1580 					send_ctl_io = 0;
1581 					break;
1582 				}
1583 				break;
1584 			case CAM_REQ_ABORTED:
1585 				/*
1586 				 * This request was sent back by the driver.
1587 				 * XXX KDM what do we do here?
1588 				 */
1589 				send_ctl_io = 0;
1590 				break;
1591 			case CAM_REQ_INVALID:
1592 			case CAM_PROVIDE_FAIL:
1593 			default:
1594 				/*
1595 				 * We should only get here if we're talking
1596 				 * to a talking to a SIM that is target
1597 				 * capable but supports the old API.  In
1598 				 * that case, we need to just free the CCB.
1599 				 * If we actually send a notify acknowledge,
1600 				 * it will send that back with an error as
1601 				 * well.
1602 				 */
1603 
1604 				if ((status != CAM_REQ_INVALID)
1605 				 && (status != CAM_PROVIDE_FAIL))
1606 					xpt_print(periph->path, "%s: "
1607 						  "unsupported CAM status "
1608 						  "0x%x\n", __func__, status);
1609 
1610 				ctl_free_io(io);
1611 				ctlfe_free_ccb(periph, done_ccb);
1612 
1613 				return;
1614 			}
1615 			if (send_ctl_io != 0) {
1616 				ctl_queue(io);
1617 			} else {
1618 				ctl_free_io(io);
1619 				done_ccb->ccb_h.status = CAM_REQ_INPROG;
1620 				done_ccb->ccb_h.func_code =
1621 					XPT_NOTIFY_ACKNOWLEDGE;
1622 				xpt_action(done_ccb);
1623 			}
1624 		} else {
1625 			xpt_print(periph->path, "%s: could not allocate "
1626 				  "ctl_io for immediate notify!\n", __func__);
1627 			/* requeue this to the adapter */
1628 			done_ccb->ccb_h.status = CAM_REQ_INPROG;
1629 			done_ccb->ccb_h.func_code = XPT_NOTIFY_ACKNOWLEDGE;
1630 			xpt_action(done_ccb);
1631 		}
1632 
1633 		if (frozen != 0) {
1634 			cam_release_devq(periph->path,
1635 					 /*relsim_flags*/ 0,
1636 					 /*opening reduction*/ 0,
1637 					 /*timeout*/ 0,
1638 					 /*getcount_only*/ 0);
1639 		}
1640 		break;
1641 	}
1642 	case XPT_NOTIFY_ACKNOWLEDGE:
1643 		/*
1644 		 * Queue this back down to the SIM as an immediate notify.
1645 		 */
1646 		done_ccb->ccb_h.func_code = XPT_IMMEDIATE_NOTIFY;
1647 		xpt_action(done_ccb);
1648 		softc->inots_sent++;
1649 		break;
1650 	case XPT_ABORT:
1651 		/*
1652 		 * XPT_ABORT is an immediate CCB, we shouldn't get here.
1653 		 */
1654 		panic("%s: XPT_ABORT CCB returned!", __func__);
1655 		break;
1656 	case XPT_SET_SIM_KNOB:
1657 	case XPT_GET_SIM_KNOB:
1658 		break;
1659 	default:
1660 		panic("%s: unexpected CCB type %#x", __func__,
1661 		      done_ccb->ccb_h.func_code);
1662 		break;
1663 	}
1664 }
1665 
1666 static void
1667 ctlfe_onoffline(void *arg, int online)
1668 {
1669 	struct ctlfe_softc *bus_softc;
1670 	union ccb *ccb;
1671 	cam_status status;
1672 	struct cam_path *path;
1673 	struct cam_sim *sim;
1674 	int set_wwnn;
1675 
1676 	bus_softc = (struct ctlfe_softc *)arg;
1677 
1678 	set_wwnn = 0;
1679 
1680 	sim = bus_softc->sim;
1681 
1682 	mtx_assert(sim->mtx, MA_OWNED);
1683 
1684 	status = xpt_create_path(&path, /*periph*/ NULL, bus_softc->path_id,
1685 		CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
1686 	if (status != CAM_REQ_CMP) {
1687 		printf("%s: unable to create path!\n", __func__);
1688 		return;
1689 	}
1690 	ccb = (union ccb *)malloc(sizeof(*ccb), M_TEMP, M_NOWAIT | M_ZERO);
1691 	if (ccb == NULL) {
1692 		printf("%s: unable to malloc CCB!\n", __func__);
1693 		xpt_free_path(path);
1694 		return;
1695 	}
1696 	xpt_setup_ccb(&ccb->ccb_h, path, CAM_PRIORITY_NONE);
1697 
1698 	/*
1699 	 * Copan WWN format:
1700 	 *
1701 	 * Bits 63-60:	0x5		NAA, IEEE registered name
1702 	 * Bits 59-36:	0x000ED5	IEEE Company name assigned to Copan
1703 	 * Bits 35-12:			Copan SSN (Sequential Serial Number)
1704 	 * Bits 11-8:			Type of port:
1705 	 *					1 == N-Port
1706 	 *					2 == F-Port
1707 	 *					3 == NL-Port
1708 	 * Bits 7-0:			0 == Node Name, >0 == Port Number
1709 	 */
1710 
1711 	if (online != 0) {
1712 
1713 		ccb->ccb_h.func_code = XPT_GET_SIM_KNOB;
1714 
1715 
1716 		xpt_action(ccb);
1717 
1718 
1719 		if ((ccb->knob.xport_specific.valid & KNOB_VALID_ADDRESS) != 0){
1720 #ifdef RANDOM_WWNN
1721 			uint64_t random_bits;
1722 #endif
1723 
1724 			printf("%s: %s current WWNN %#jx\n", __func__,
1725 			       bus_softc->port_name,
1726 			       ccb->knob.xport_specific.fc.wwnn);
1727 			printf("%s: %s current WWPN %#jx\n", __func__,
1728 			       bus_softc->port_name,
1729 			       ccb->knob.xport_specific.fc.wwpn);
1730 
1731 #ifdef RANDOM_WWNN
1732 			arc4rand(&random_bits, sizeof(random_bits), 0);
1733 #endif
1734 
1735 			/*
1736 			 * XXX KDM this is a bit of a kludge for now.  We
1737 			 * take the current WWNN/WWPN from the card, and
1738 			 * replace the company identifier and the NL-Port
1739 			 * indicator and the port number (for the WWPN).
1740 			 * This should be replaced later with ddb_GetWWNN,
1741 			 * or possibly a more centralized scheme.  (It
1742 			 * would be nice to have the WWNN/WWPN for each
1743 			 * port stored in the ctl_frontend structure.)
1744 			 */
1745 #ifdef RANDOM_WWNN
1746 			ccb->knob.xport_specific.fc.wwnn =
1747 				(random_bits &
1748 				0x0000000fffffff00ULL) |
1749 				/* Company ID */ 0x5000ED5000000000ULL |
1750 				/* NL-Port */    0x0300;
1751 			ccb->knob.xport_specific.fc.wwpn =
1752 				(random_bits &
1753 				0x0000000fffffff00ULL) |
1754 				/* Company ID */ 0x5000ED5000000000ULL |
1755 				/* NL-Port */    0x3000 |
1756 				/* Port Num */ (bus_softc->fe.targ_port & 0xff);
1757 
1758 			/*
1759 			 * This is a bit of an API break/reversal, but if
1760 			 * we're doing the random WWNN that's a little
1761 			 * different anyway.  So record what we're actually
1762 			 * using with the frontend code so it's reported
1763 			 * accurately.
1764 			 */
1765 			bus_softc->fe.wwnn =
1766 				ccb->knob.xport_specific.fc.wwnn;
1767 			bus_softc->fe.wwpn =
1768 				ccb->knob.xport_specific.fc.wwpn;
1769 			set_wwnn = 1;
1770 #else /* RANDOM_WWNN */
1771 			/*
1772 			 * If the user has specified a WWNN/WWPN, send them
1773 			 * down to the SIM.  Otherwise, record what the SIM
1774 			 * has reported.
1775 			 */
1776 			if ((bus_softc->fe.wwnn != 0)
1777 			 && (bus_softc->fe.wwpn != 0)) {
1778 				ccb->knob.xport_specific.fc.wwnn =
1779 					bus_softc->fe.wwnn;
1780 				ccb->knob.xport_specific.fc.wwpn =
1781 					bus_softc->fe.wwpn;
1782 				set_wwnn = 1;
1783 			} else {
1784 				bus_softc->fe.wwnn =
1785 					ccb->knob.xport_specific.fc.wwnn;
1786 				bus_softc->fe.wwpn =
1787 					ccb->knob.xport_specific.fc.wwpn;
1788 			}
1789 #endif /* RANDOM_WWNN */
1790 
1791 
1792 			if (set_wwnn != 0) {
1793 				printf("%s: %s new WWNN %#jx\n", __func__,
1794 				       bus_softc->port_name,
1795 				ccb->knob.xport_specific.fc.wwnn);
1796 				printf("%s: %s new WWPN %#jx\n", __func__,
1797 				       bus_softc->port_name,
1798 				       ccb->knob.xport_specific.fc.wwpn);
1799 			}
1800 		} else {
1801 			printf("%s: %s has no valid WWNN/WWPN\n", __func__,
1802 			       bus_softc->port_name);
1803 		}
1804 	}
1805 	ccb->ccb_h.func_code = XPT_SET_SIM_KNOB;
1806 	ccb->knob.xport_specific.valid = KNOB_VALID_ROLE;
1807 	if (set_wwnn != 0)
1808 		ccb->knob.xport_specific.valid |= KNOB_VALID_ADDRESS;
1809 
1810 	if (online != 0)
1811 		ccb->knob.xport_specific.fc.role = KNOB_ROLE_TARGET;
1812 	else
1813 		ccb->knob.xport_specific.fc.role = KNOB_ROLE_NONE;
1814 
1815 	xpt_action(ccb);
1816 
1817 	if ((ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1818 		printf("%s: SIM %s (path id %d) target %s failed with "
1819 		       "status %#x\n",
1820 		       __func__, bus_softc->port_name, bus_softc->path_id,
1821 		       (online != 0) ? "enable" : "disable",
1822 		       ccb->ccb_h.status);
1823 	} else {
1824 		printf("%s: SIM %s (path id %d) target %s succeeded\n",
1825 		       __func__, bus_softc->port_name, bus_softc->path_id,
1826 		       (online != 0) ? "enable" : "disable");
1827 	}
1828 
1829 	xpt_free_path(path);
1830 
1831 	free(ccb, M_TEMP);
1832 
1833 	return;
1834 }
1835 
1836 static void
1837 ctlfe_online(void *arg)
1838 {
1839 	struct ctlfe_softc *bus_softc;
1840 	struct cam_path *path;
1841 	cam_status status;
1842 	struct ctlfe_lun_softc *lun_softc;
1843 	struct cam_sim *sim;
1844 
1845 	bus_softc = (struct ctlfe_softc *)arg;
1846 	sim = bus_softc->sim;
1847 
1848 	CAM_SIM_LOCK(sim);
1849 
1850 	/*
1851 	 * Create the wildcard LUN before bringing the port online.
1852 	 */
1853 	status = xpt_create_path(&path, /*periph*/ NULL,
1854 				 bus_softc->path_id, CAM_TARGET_WILDCARD,
1855 				 CAM_LUN_WILDCARD);
1856 	if (status != CAM_REQ_CMP) {
1857 		printf("%s: unable to create path for wildcard periph\n",
1858 				__func__);
1859 		CAM_SIM_UNLOCK(sim);
1860 		return;
1861 	}
1862 
1863 	lun_softc = malloc(sizeof(*lun_softc), M_CTLFE,
1864 			M_NOWAIT | M_ZERO);
1865 	if (lun_softc == NULL) {
1866 		xpt_print(path, "%s: unable to allocate softc for "
1867 				"wildcard periph\n", __func__);
1868 		xpt_free_path(path);
1869 		CAM_SIM_UNLOCK(sim);
1870 		return;
1871 	}
1872 
1873 	lun_softc->parent_softc = bus_softc;
1874 	lun_softc->flags |= CTLFE_LUN_WILDCARD;
1875 
1876 	STAILQ_INSERT_TAIL(&bus_softc->lun_softc_list, lun_softc, links);
1877 
1878 
1879 	status = cam_periph_alloc(ctlferegister,
1880 				  ctlfeoninvalidate,
1881 				  ctlfecleanup,
1882 				  ctlfestart,
1883 				  "ctl",
1884 				  CAM_PERIPH_BIO,
1885 				  path,
1886 				  ctlfeasync,
1887 				  0,
1888 				  lun_softc);
1889 
1890 	if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1891 		const struct cam_status_entry *entry;
1892 
1893 		entry = cam_fetch_status_entry(status);
1894 
1895 		printf("%s: CAM error %s (%#x) returned from "
1896 		       "cam_periph_alloc()\n", __func__, (entry != NULL) ?
1897 		       entry->status_text : "Unknown", status);
1898 	}
1899 
1900 	xpt_free_path(path);
1901 
1902 	ctlfe_onoffline(arg, /*online*/ 1);
1903 
1904 	CAM_SIM_UNLOCK(sim);
1905 }
1906 
1907 static void
1908 ctlfe_offline(void *arg)
1909 {
1910 	struct ctlfe_softc *bus_softc;
1911 	struct cam_path *path;
1912 	cam_status status;
1913 	struct cam_periph *periph;
1914 	struct cam_sim *sim;
1915 
1916 	bus_softc = (struct ctlfe_softc *)arg;
1917 	sim = bus_softc->sim;
1918 
1919 	CAM_SIM_LOCK(sim);
1920 
1921 	ctlfe_onoffline(arg, /*online*/ 0);
1922 
1923 	/*
1924 	 * Disable the wildcard LUN for this port now that we have taken
1925 	 * the port offline.
1926 	 */
1927 	status = xpt_create_path(&path, /*periph*/ NULL,
1928 				 bus_softc->path_id, CAM_TARGET_WILDCARD,
1929 				 CAM_LUN_WILDCARD);
1930 	if (status != CAM_REQ_CMP) {
1931 		CAM_SIM_UNLOCK(sim);
1932 		printf("%s: unable to create path for wildcard periph\n",
1933 		       __func__);
1934 		return;
1935 	}
1936 
1937 
1938 	if ((periph = cam_periph_find(path, "ctl")) != NULL)
1939 		cam_periph_invalidate(periph);
1940 
1941 	xpt_free_path(path);
1942 
1943 	CAM_SIM_UNLOCK(sim);
1944 }
1945 
1946 static int
1947 ctlfe_targ_enable(void *arg, struct ctl_id targ_id)
1948 {
1949 	return (0);
1950 }
1951 
1952 static int
1953 ctlfe_targ_disable(void *arg, struct ctl_id targ_id)
1954 {
1955 	return (0);
1956 }
1957 
1958 /*
1959  * This will get called to enable a LUN on every bus that is attached to
1960  * CTL.  So we only need to create a path/periph for this particular bus.
1961  */
1962 static int
1963 ctlfe_lun_enable(void *arg, struct ctl_id targ_id, int lun_id)
1964 {
1965 	struct ctlfe_softc *bus_softc;
1966 	struct ctlfe_lun_softc *softc;
1967 	struct cam_path *path;
1968 	struct cam_periph *periph;
1969 	struct cam_sim *sim;
1970 	cam_status status;
1971 
1972 
1973 	bus_softc = (struct ctlfe_softc *)arg;
1974 	sim = bus_softc->sim;
1975 
1976 	status = xpt_create_path_unlocked(&path, /*periph*/ NULL,
1977 					  bus_softc->path_id,
1978 					  targ_id.id, lun_id);
1979 	/* XXX KDM need some way to return status to CTL here? */
1980 	if (status != CAM_REQ_CMP) {
1981 		printf("%s: could not create path, status %#x\n", __func__,
1982 		       status);
1983 		return (1);
1984 	}
1985 
1986 	softc = malloc(sizeof(*softc), M_CTLFE, M_WAITOK | M_ZERO);
1987 	CAM_SIM_LOCK(sim);
1988 	periph = cam_periph_find(path, "ctl");
1989 	if (periph != NULL) {
1990 		/* We've already got a periph, no need to alloc a new one. */
1991 		xpt_free_path(path);
1992 		free(softc, M_CTLFE);
1993 		CAM_SIM_UNLOCK(sim);
1994 		return (0);
1995 	}
1996 
1997 	softc->parent_softc = bus_softc;
1998 	STAILQ_INSERT_TAIL(&bus_softc->lun_softc_list, softc, links);
1999 
2000 	status = cam_periph_alloc(ctlferegister,
2001 				  ctlfeoninvalidate,
2002 				  ctlfecleanup,
2003 				  ctlfestart,
2004 				  "ctl",
2005 				  CAM_PERIPH_BIO,
2006 				  path,
2007 				  ctlfeasync,
2008 				  0,
2009 				  softc);
2010 
2011 	xpt_free_path(path);
2012 
2013 	CAM_SIM_UNLOCK(sim);
2014 
2015 	return (0);
2016 }
2017 
2018 /*
2019  * This will get called when the user removes a LUN to disable that LUN
2020  * on every bus that is attached to CTL.
2021  */
2022 static int
2023 ctlfe_lun_disable(void *arg, struct ctl_id targ_id, int lun_id)
2024 {
2025 	struct ctlfe_softc *softc;
2026 	struct ctlfe_lun_softc *lun_softc;
2027 	struct cam_sim *sim;
2028 
2029 	softc = (struct ctlfe_softc *)arg;
2030 	sim = softc->sim;
2031 
2032 	CAM_SIM_LOCK(sim);
2033 	STAILQ_FOREACH(lun_softc, &softc->lun_softc_list, links) {
2034 		struct cam_path *path;
2035 
2036 		path = lun_softc->periph->path;
2037 
2038 		if ((xpt_path_target_id(path) == targ_id.id)
2039 		 && (xpt_path_lun_id(path) == lun_id)) {
2040 			break;
2041 		}
2042 	}
2043 	if (lun_softc == NULL) {
2044 		CAM_SIM_UNLOCK(sim);
2045 		printf("%s: can't find target %d lun %d\n", __func__,
2046 		       targ_id.id, lun_id);
2047 		return (1);
2048 	}
2049 
2050 	cam_periph_invalidate(lun_softc->periph);
2051 
2052 	CAM_SIM_UNLOCK(sim);
2053 
2054 	return (0);
2055 }
2056 
2057 static void
2058 ctlfe_dump_sim(struct cam_sim *sim)
2059 {
2060 	int i;
2061 
2062 	printf("%s%d: max tagged openings: %d, max dev openings: %d\n",
2063 	       sim->sim_name, sim->unit_number,
2064 	       sim->max_tagged_dev_openings, sim->max_dev_openings);
2065 	printf("%s%d: max_ccbs: %u, ccb_count: %u\n",
2066 	       sim->sim_name, sim->unit_number,
2067 	       sim->max_ccbs, sim->ccb_count);
2068 	printf("%s%d: ccb_freeq is %sempty\n",
2069 	       sim->sim_name, sim->unit_number,
2070 	       (SLIST_FIRST(&sim->ccb_freeq) == NULL) ? "" : "NOT ");
2071 	printf("%s%d: alloc_queue.entries %d, alloc_openings %d\n",
2072 	       sim->sim_name, sim->unit_number,
2073 	       sim->devq->alloc_queue.entries, sim->devq->alloc_openings);
2074 	printf("%s%d: qfrozen_cnt:", sim->sim_name, sim->unit_number);
2075 	for (i = 0; i < CAM_RL_VALUES; i++) {
2076 		printf("%s%u", (i != 0) ? ":" : "",
2077 		sim->devq->alloc_queue.qfrozen_cnt[i]);
2078 	}
2079 	printf("\n");
2080 }
2081 
2082 /*
2083  * Assumes that the SIM lock is held.
2084  */
2085 static void
2086 ctlfe_dump_queue(struct ctlfe_lun_softc *softc)
2087 {
2088 	struct ccb_hdr *hdr;
2089 	struct cam_periph *periph;
2090 	int num_items;
2091 
2092 	periph = softc->periph;
2093 	num_items = 0;
2094 
2095 	TAILQ_FOREACH(hdr, &softc->work_queue, periph_links.tqe) {
2096 		union ctl_io *io;
2097 
2098 		io = hdr->io_ptr;
2099 
2100 		num_items++;
2101 
2102 		/*
2103 		 * This can happen when we get an ATIO but can't allocate
2104 		 * a ctl_io.  See the XPT_ACCEPT_TARGET_IO case in ctlfedone().
2105 		 */
2106 		if (io == NULL) {
2107 			struct ccb_scsiio *csio;
2108 
2109 			csio = (struct ccb_scsiio *)hdr;
2110 
2111 			xpt_print(periph->path, "CCB %#x ctl_io allocation "
2112 				  "failed\n", csio->tag_id);
2113 			continue;
2114 		}
2115 
2116 		/*
2117 		 * Only regular SCSI I/O is put on the work
2118 		 * queue, so we can print sense here.  There may be no
2119 		 * sense if it's no the queue for a DMA, but this serves to
2120 		 * print out the CCB as well.
2121 		 *
2122 		 * XXX KDM switch this over to scsi_sense_print() when
2123 		 * CTL is merged in with CAM.
2124 		 */
2125 		ctl_io_error_print(io, NULL);
2126 
2127 		/*
2128 		 * We're sending status back to the
2129 		 * initiator, so we're on the queue waiting
2130 		 * for a CTIO to do that.
2131 		 */
2132 		if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE)
2133 			continue;
2134 
2135 		/*
2136 		 * Otherwise, we're on the queue waiting to
2137 		 * do a data transfer.
2138 		 */
2139 		xpt_print(periph->path, "Total %u, Current %u, Resid %u\n",
2140 			  io->scsiio.kern_total_len, io->scsiio.kern_data_len,
2141 			  io->scsiio.kern_data_resid);
2142 	}
2143 
2144 	xpt_print(periph->path, "%d requests total waiting for CCBs\n",
2145 		  num_items);
2146 	xpt_print(periph->path, "%ju CCBs oustanding (%ju allocated, %ju "
2147 		  "freed)\n", (uintmax_t)(softc->ccbs_alloced -
2148 		  softc->ccbs_freed), (uintmax_t)softc->ccbs_alloced,
2149 		  (uintmax_t)softc->ccbs_freed);
2150 	xpt_print(periph->path, "%ju CTIOs outstanding (%ju sent, %ju "
2151 		  "returned\n", (uintmax_t)(softc->ctios_sent -
2152 		  softc->ctios_returned), softc->ctios_sent,
2153 		  softc->ctios_returned);
2154 }
2155 
2156 /*
2157  * This function is called when we fail to get a CCB for a DMA or status return
2158  * to the initiator within the specified time period.
2159  *
2160  * The callout code should insure that we hold the sim mutex here.
2161  */
2162 static void
2163 ctlfe_dma_timeout(void *arg)
2164 {
2165 	struct ctlfe_lun_softc *softc;
2166 	struct cam_periph *periph;
2167 	struct cam_sim *sim;
2168 	int num_queued;
2169 
2170 	softc = (struct ctlfe_lun_softc *)arg;
2171 	periph = softc->periph;
2172 	sim = xpt_path_sim(periph->path);
2173 	num_queued = 0;
2174 
2175 	/*
2176 	 * Nothing to do...
2177 	 */
2178 	if (TAILQ_FIRST(&softc->work_queue) == NULL) {
2179 		xpt_print(periph->path, "TIMEOUT triggered after %d "
2180 			  "seconds, but nothing on work queue??\n",
2181 			  CTLFE_DMA_TIMEOUT);
2182 		return;
2183 	}
2184 
2185 	xpt_print(periph->path, "TIMEOUT (%d seconds) waiting for DMA to "
2186 		  "start\n", CTLFE_DMA_TIMEOUT);
2187 
2188 	ctlfe_dump_queue(softc);
2189 
2190 	ctlfe_dump_sim(sim);
2191 
2192 	xpt_print(periph->path, "calling xpt_schedule() to attempt to "
2193 		  "unstick our queue\n");
2194 
2195 	xpt_schedule(periph, /*priority*/ 1);
2196 
2197 	xpt_print(periph->path, "xpt_schedule() call complete\n");
2198 }
2199 
2200 /*
2201  * Datamove/done routine called by CTL.  Put ourselves on the queue to
2202  * receive a CCB from CAM so we can queue the continue I/O request down
2203  * to the adapter.
2204  */
2205 static void
2206 ctlfe_datamove_done(union ctl_io *io)
2207 {
2208 	union ccb *ccb;
2209 	struct cam_sim *sim;
2210 	struct cam_periph *periph;
2211 	struct ctlfe_lun_softc *softc;
2212 
2213 	ccb = io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr;
2214 
2215 	sim = xpt_path_sim(ccb->ccb_h.path);
2216 
2217 	CAM_SIM_LOCK(sim);
2218 
2219 	periph = xpt_path_periph(ccb->ccb_h.path);
2220 
2221 	softc = (struct ctlfe_lun_softc *)periph->softc;
2222 
2223 	if (io->io_hdr.io_type == CTL_IO_TASK) {
2224 		/*
2225 		 * Task management commands don't require any further
2226 		 * communication back to the adapter.  Requeue the CCB
2227 		 * to the adapter, and free the CTL I/O.
2228 		 */
2229 		xpt_print(ccb->ccb_h.path, "%s: returning task I/O "
2230 			  "tag %#x seq %#x\n", __func__,
2231 			  ccb->cin1.tag_id, ccb->cin1.seq_id);
2232 		/*
2233 		 * Send the notify acknowledge down to the SIM, to let it
2234 		 * know we processed the task management command.
2235 		 */
2236 		ccb->ccb_h.status = CAM_REQ_INPROG;
2237 		ccb->ccb_h.func_code = XPT_NOTIFY_ACKNOWLEDGE;
2238 		xpt_action(ccb);
2239 		ctl_free_io(io);
2240 	} else {
2241 		if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE)
2242 			io->io_hdr.flags |= CTL_FLAG_STATUS_QUEUED;
2243 		else
2244 			io->io_hdr.flags |= CTL_FLAG_DMA_QUEUED;
2245 
2246 		TAILQ_INSERT_TAIL(&softc->work_queue, &ccb->ccb_h,
2247 				  periph_links.tqe);
2248 
2249 		/*
2250 		 * Reset the timeout for our latest active DMA.
2251 		 */
2252 		callout_reset(&softc->dma_callout,
2253 			      CTLFE_DMA_TIMEOUT * hz,
2254 			      ctlfe_dma_timeout, softc);
2255 		/*
2256 		 * Ask for the CAM transport layer to send us a CCB to do
2257 		 * the DMA or send status, unless ctlfe_dma_enabled is set
2258 		 * to 0.
2259 		 */
2260 		if (ctlfe_dma_enabled != 0)
2261 			xpt_schedule(periph, /*priority*/ 1);
2262 	}
2263 
2264 	CAM_SIM_UNLOCK(sim);
2265 }
2266 
2267 static void
2268 ctlfe_dump(void)
2269 {
2270 	struct ctlfe_softc *bus_softc;
2271 
2272 	STAILQ_FOREACH(bus_softc, &ctlfe_softc_list, links) {
2273 		struct ctlfe_lun_softc *lun_softc;
2274 
2275 		ctlfe_dump_sim(bus_softc->sim);
2276 
2277 		STAILQ_FOREACH(lun_softc, &bus_softc->lun_softc_list, links) {
2278 			ctlfe_dump_queue(lun_softc);
2279 		}
2280 	}
2281 }
2282