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