2 * Copyright (c) 2008, 2009 Silicon Graphics International Corp.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
30 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/scsi_ctl.c#4 $
33 * Peripheral driver interface between CAM and CTL (CAM Target Layer).
35 * Author: Ken Merry <ken@FreeBSD.org>
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
41 #include <sys/param.h>
42 #include <sys/queue.h>
43 #include <sys/systm.h>
44 #include <sys/kernel.h>
46 #include <sys/mutex.h>
47 #include <sys/condvar.h>
48 #include <sys/malloc.h>
50 #include <sys/endian.h>
52 #include <sys/sysctl.h>
53 #include <sys/types.h>
54 #include <sys/systm.h>
55 #include <machine/bus.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>
66 #include <cam/scsi/scsi_all.h>
67 #include <cam/scsi/scsi_message.h>
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>
76 CTLFE_CCB_DEFAULT = 0x00
80 struct ctl_frontend fe;
83 char port_name[DEV_IDLEN];
84 struct mtx lun_softc_mtx;
85 STAILQ_HEAD(, ctlfe_lun_softc) lun_softc_list;
86 STAILQ_ENTRY(ctlfe_softc) links;
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;
99 CTLFE_LUN_NONE = 0x00,
100 CTLFE_LUN_WILDCARD = 0x01
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;
111 uint64_t ctios_returned;
113 uint64_t atios_returned;
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;
122 CTLFE_CMD_NONE = 0x00,
123 CTLFE_CMD_PIECEWISE = 0x01
127 * The size limit of this structure is CTL_PORT_PRIV_SIZE, from ctl_io.h.
128 * Currently that is 600 bytes.
130 struct ctlfe_lun_cmd_info {
131 int cur_transfer_index;
132 ctlfe_cmd_flags flags;
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.
138 bus_dma_segment_t cam_sglist[32];
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.
147 #define CTLFE_REQ_CTL_IO 4096
149 * Number of Accept Target I/O CCBs to allocate and queue down to the
151 * XXX KDM should this be controlled by CTL?
153 #define CTLFE_ATIO_PER_LUN 1024
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?
159 #define CTLFE_IN_PER_LUN 1024
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.
167 #define CTLFE_DMA_TIMEOUT 60
170 * Turn this on to enable extra debugging prints.
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.
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");
189 #define ccb_type ppriv_field0
190 /* This is only used in the ATIO */
191 #define io_ptr ppriv_ptr1
193 /* This is only used in the CTIO */
194 #define ccb_atio ppriv_ptr1
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);
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,
215 static int ctlfe_lun_disable(void *arg, struct ctl_id targ_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);
223 static struct periph_driver ctlfe_driver =
226 TAILQ_HEAD_INITIALIZER(ctlfe_driver.units), /*generation*/ 0
229 static int ctlfe_module_event_handler(module_t, int /*modeventtype_t*/, void *);
232 * We're not using PERIPHDRIVER_DECLARE(), because it runs at SI_SUB_DRIVERS,
233 * and that happens before CTL gets initialised.
235 static moduledata_t ctlfe_moduledata = {
237 ctlfe_module_event_handler,
241 DECLARE_MODULE(ctlfe, ctlfe_moduledata, SI_SUB_CONFIGURE, SI_ORDER_FOURTH);
242 MODULE_VERSION(ctlfe, 1);
243 MODULE_DEPEND(ctlfe, ctl, 1, 1, 1);
244 MODULE_DEPEND(ctlfe, cam, 1, 1, 1);
246 extern struct ctl_softc *control_softc;
259 STAILQ_INIT(&ctlfe_softc_list);
261 mtx_init(&ctlfe_list_mtx, ctlfe_mtx_desc, NULL, MTX_DEF);
263 KASSERT(control_softc != NULL, ("CTL is not initialized!"));
265 status = xpt_register_async(AC_PATH_REGISTERED | AC_PATH_DEREGISTERED |
266 AC_CONTRACT, ctlfeasync, NULL, NULL);
268 if (status != CAM_REQ_CMP) {
269 printf("ctl: Failed to attach async callback due to CAM "
270 "status 0x%x!\n", status);
275 ctlfe_module_event_handler(module_t mod, int what, void *arg)
280 periphdriver_register(&ctlfe_driver);
290 ctlfeasync(void *callback_arg, uint32_t code, struct cam_path *path, void *arg)
294 printf("%s: entered\n", __func__);
298 * When a new path gets registered, and it is capable of target
299 * mode, go ahead and attach. Later on, we may need to be more
300 * selective, but for now this will be sufficient.
303 case AC_PATH_REGISTERED: {
304 struct ctl_frontend *fe;
305 struct ctlfe_softc *bus_softc;
306 struct ccb_pathinq *cpi;
309 cpi = (struct ccb_pathinq *)arg;
311 /* Don't attach if it doesn't support target mode */
312 if ((cpi->target_sprt & PIT_PROCESSOR) == 0) {
314 printf("%s: SIM %s%d doesn't support target mode\n",
315 __func__, cpi->dev_name, cpi->unit_number);
320 #ifdef CTLFE_INIT_ENABLE
321 if (ctlfe_num_targets >= ctlfe_max_targets) {
324 ccb = (union ccb *)malloc(sizeof(*ccb), M_TEMP,
327 printf("%s: unable to malloc CCB!\n", __func__);
330 xpt_setup_ccb(&ccb->ccb_h, path, CAM_PRIORITY_NONE);
332 ccb->ccb_h.func_code = XPT_SET_SIM_KNOB;
333 ccb->knob.xport_specific.valid = KNOB_VALID_ROLE;
334 ccb->knob.xport_specific.fc.role = KNOB_ROLE_INITIATOR;
338 if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
340 printf("%s: SIM %s%d (path id %d) initiator "
341 "enable failed with status %#x\n",
342 __func__, cpi->dev_name,
343 cpi->unit_number, cpi->ccb_h.path_id,
346 printf("%s: SIM %s%d (path id %d) initiator "
347 "enable succeeded\n",
348 __func__, cpi->dev_name,
349 cpi->unit_number, cpi->ccb_h.path_id);
359 printf("%s: ctlfe_num_targets = %d\n", __func__,
361 #endif /* CTLFE_INIT_ENABLE */
364 * We're in an interrupt context here, so we have to
365 * use M_NOWAIT. Of course this means trouble if we
366 * can't allocate memory.
368 bus_softc = malloc(sizeof(*bus_softc), M_CTLFE,
370 if (bus_softc == NULL) {
371 printf("%s: unable to malloc %zd bytes for softc\n",
372 __func__, sizeof(*bus_softc));
376 bus_softc->path_id = cpi->ccb_h.path_id;
377 bus_softc->sim = xpt_path_sim(path);
378 mtx_init(&bus_softc->lun_softc_mtx, "LUN softc mtx", NULL,
380 STAILQ_INIT(&bus_softc->lun_softc_list);
385 * XXX KDM should we be more accurate here ?
387 if (cpi->transport == XPORT_FC)
388 fe->port_type = CTL_PORT_FC;
390 fe->port_type = CTL_PORT_SCSI;
392 /* XXX KDM what should the real number be here? */
393 fe->num_requested_ctl_io = 4096;
394 snprintf(bus_softc->port_name, sizeof(bus_softc->port_name),
395 "%s%d", cpi->dev_name, cpi->unit_number);
397 * XXX KDM it would be nice to allocate storage in the
398 * frontend structure itself.
400 fe->port_name = bus_softc->port_name;
401 fe->physical_port = cpi->unit_number;
402 fe->virtual_port = cpi->bus_id;
403 fe->port_online = ctlfe_online;
404 fe->port_offline = ctlfe_offline;
405 fe->onoff_arg = bus_softc;
406 fe->targ_enable = ctlfe_targ_enable;
407 fe->targ_disable = ctlfe_targ_disable;
408 fe->lun_enable = ctlfe_lun_enable;
409 fe->lun_disable = ctlfe_lun_disable;
410 fe->targ_lun_arg = bus_softc;
411 fe->fe_datamove = ctlfe_datamove_done;
412 fe->fe_done = ctlfe_datamove_done;
413 fe->fe_dump = ctlfe_dump;
415 * XXX KDM the path inquiry doesn't give us the maximum
416 * number of targets supported.
418 fe->max_targets = cpi->max_target;
419 fe->max_target_id = cpi->max_target;
422 * XXX KDM need to figure out whether we're the master or
426 printf("%s: calling ctl_frontend_register() for %s%d\n",
427 __func__, cpi->dev_name, cpi->unit_number);
429 retval = ctl_frontend_register(fe, /*master_SC*/ 1);
431 printf("%s: ctl_frontend_register() failed with "
432 "error %d!\n", __func__, retval);
433 mtx_destroy(&bus_softc->lun_softc_mtx);
434 free(bus_softc, M_CTLFE);
437 mtx_lock(&ctlfe_list_mtx);
438 STAILQ_INSERT_TAIL(&ctlfe_softc_list, bus_softc, links);
439 mtx_unlock(&ctlfe_list_mtx);
444 case AC_PATH_DEREGISTERED: {
445 struct ctlfe_softc *softc = NULL;
447 mtx_lock(&ctlfe_list_mtx);
448 STAILQ_FOREACH(softc, &ctlfe_softc_list, links) {
449 if (softc->path_id == xpt_path_path_id(path)) {
450 STAILQ_REMOVE(&ctlfe_softc_list, softc,
455 mtx_unlock(&ctlfe_list_mtx);
459 * XXX KDM are we certain at this point that there
460 * are no outstanding commands for this frontend?
462 ctl_frontend_deregister(&softc->fe);
463 mtx_destroy(&softc->lun_softc_mtx);
464 free(softc, M_CTLFE);
469 struct ac_contract *ac;
471 ac = (struct ac_contract *)arg;
473 switch (ac->contract_number) {
474 case AC_CONTRACT_DEV_CHG: {
475 struct ac_device_changed *dev_chg;
476 struct ctlfe_softc *softc;
479 dev_chg = (struct ac_device_changed *)ac->contract_data;
481 printf("%s: WWPN %#jx port 0x%06x path %u target %u %s\n",
482 __func__, dev_chg->wwpn, dev_chg->port,
483 xpt_path_path_id(path), dev_chg->target,
484 (dev_chg->arrived == 0) ? "left" : "arrived");
488 mtx_lock(&ctlfe_list_mtx);
489 STAILQ_FOREACH(softc, &ctlfe_softc_list, links) {
490 if (softc->path_id == xpt_path_path_id(path)) {
495 mtx_unlock(&ctlfe_list_mtx);
498 printf("%s: CTL port for CAM path %u not "
499 "found!\n", __func__,
500 xpt_path_path_id(path));
503 if (dev_chg->arrived != 0) {
504 retval = ctl_add_initiator(dev_chg->wwpn,
505 softc->fe.targ_port, dev_chg->target);
507 retval = ctl_remove_initiator(
508 softc->fe.targ_port, dev_chg->target);
512 printf("%s: could not %s port %d iid %u "
513 "WWPN %#jx!\n", __func__,
514 (dev_chg->arrived != 0) ? "add" :
515 "remove", softc->fe.targ_port,
517 (uintmax_t)dev_chg->wwpn);
522 printf("%s: unsupported contract number %ju\n",
523 __func__, (uintmax_t)ac->contract_number);
534 ctlferegister(struct cam_periph *periph, void *arg)
536 struct ctlfe_softc *bus_softc;
537 struct ctlfe_lun_softc *softc;
538 union ccb en_lun_ccb;
542 softc = (struct ctlfe_lun_softc *)arg;
543 bus_softc = softc->parent_softc;
545 TAILQ_INIT(&softc->work_queue);
546 softc->periph = periph;
548 callout_init_mtx(&softc->dma_callout, xpt_path_mtx(periph->path),
550 periph->softc = softc;
552 xpt_setup_ccb(&en_lun_ccb.ccb_h, periph->path, CAM_PRIORITY_NONE);
553 en_lun_ccb.ccb_h.func_code = XPT_EN_LUN;
554 en_lun_ccb.cel.grp6_len = 0;
555 en_lun_ccb.cel.grp7_len = 0;
556 en_lun_ccb.cel.enable = 1;
557 xpt_action(&en_lun_ccb);
558 status = (en_lun_ccb.ccb_h.status & CAM_STATUS_MASK);
559 if (status != CAM_REQ_CMP) {
560 xpt_print(periph->path, "%s: Enable LUN failed, status 0x%x\n",
561 __func__, en_lun_ccb.ccb_h.status);
565 status = CAM_REQ_CMP;
567 for (i = 0; i < CTLFE_ATIO_PER_LUN; i++) {
570 new_ccb = (union ccb *)malloc(sizeof(*new_ccb), M_CTLFE,
572 if (new_ccb == NULL) {
573 status = CAM_RESRC_UNAVAIL;
576 xpt_setup_ccb(&new_ccb->ccb_h, periph->path, /*priority*/ 1);
577 new_ccb->ccb_h.func_code = XPT_ACCEPT_TARGET_IO;
578 new_ccb->ccb_h.cbfcnp = ctlfedone;
579 new_ccb->ccb_h.flags |= CAM_UNLOCKED;
582 status = new_ccb->ccb_h.status;
583 if ((status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
584 free(new_ccb, M_CTLFE);
589 status = cam_periph_acquire(periph);
590 if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
591 xpt_print(periph->path, "%s: could not acquire reference "
592 "count, status = %#x\n", __func__, status);
597 xpt_print(periph->path, "%s: could not allocate ATIO CCBs, "
598 "status 0x%x\n", __func__, status);
599 return (CAM_REQ_CMP_ERR);
602 for (i = 0; i < CTLFE_IN_PER_LUN; i++) {
605 new_ccb = (union ccb *)malloc(sizeof(*new_ccb), M_CTLFE,
607 if (new_ccb == NULL) {
608 status = CAM_RESRC_UNAVAIL;
612 xpt_setup_ccb(&new_ccb->ccb_h, periph->path, /*priority*/ 1);
613 new_ccb->ccb_h.func_code = XPT_IMMEDIATE_NOTIFY;
614 new_ccb->ccb_h.cbfcnp = ctlfedone;
615 new_ccb->ccb_h.flags |= CAM_UNLOCKED;
618 status = new_ccb->ccb_h.status;
619 if ((status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
621 * Note that we don't free the CCB here. If the
622 * status is not CAM_REQ_INPROG, then we're
623 * probably talking to a SIM that says it is
624 * target-capable but doesn't support the
625 * XPT_IMMEDIATE_NOTIFY CCB. i.e. it supports the
626 * older API. In that case, it'll call xpt_done()
627 * on the CCB, and we need to free it in our done
628 * routine as a result.
634 || (status != CAM_REQ_INPROG)) {
635 xpt_print(periph->path, "%s: could not allocate immediate "
636 "notify CCBs, status 0x%x\n", __func__, status);
637 return (CAM_REQ_CMP_ERR);
639 return (CAM_REQ_CMP);
643 ctlfeoninvalidate(struct cam_periph *periph)
645 union ccb en_lun_ccb;
647 struct ctlfe_softc *bus_softc;
648 struct ctlfe_lun_softc *softc;
650 softc = (struct ctlfe_lun_softc *)periph->softc;
652 xpt_setup_ccb(&en_lun_ccb.ccb_h, periph->path, CAM_PRIORITY_NONE);
653 en_lun_ccb.ccb_h.func_code = XPT_EN_LUN;
654 en_lun_ccb.cel.grp6_len = 0;
655 en_lun_ccb.cel.grp7_len = 0;
656 en_lun_ccb.cel.enable = 0;
657 xpt_action(&en_lun_ccb);
658 status = (en_lun_ccb.ccb_h.status & CAM_STATUS_MASK);
659 if (status != CAM_REQ_CMP) {
660 xpt_print(periph->path, "%s: Disable LUN failed, status 0x%x\n",
661 __func__, en_lun_ccb.ccb_h.status);
663 * XXX KDM what do we do now?
666 xpt_print(periph->path, "LUN removed, %ju ATIOs outstanding, %ju "
667 "INOTs outstanding, %d refs\n", softc->atios_sent -
668 softc->atios_returned, softc->inots_sent -
669 softc->inots_returned, periph->refcount);
671 bus_softc = softc->parent_softc;
672 mtx_lock(&bus_softc->lun_softc_mtx);
673 STAILQ_REMOVE(&bus_softc->lun_softc_list, softc, ctlfe_lun_softc, links);
674 mtx_unlock(&bus_softc->lun_softc_mtx);
678 ctlfecleanup(struct cam_periph *periph)
680 struct ctlfe_lun_softc *softc;
682 xpt_print(periph->path, "%s: Called\n", __func__);
684 softc = (struct ctlfe_lun_softc *)periph->softc;
687 * XXX KDM is there anything else that needs to be done here?
690 callout_stop(&softc->dma_callout);
692 free(softc, M_CTLFE);
696 ctlfestart(struct cam_periph *periph, union ccb *start_ccb)
698 struct ctlfe_lun_softc *softc;
699 struct ccb_hdr *ccb_h;
701 softc = (struct ctlfe_lun_softc *)periph->softc;
703 softc->ccbs_alloced++;
705 start_ccb->ccb_h.ccb_type = CTLFE_CCB_DEFAULT;
707 ccb_h = TAILQ_FIRST(&softc->work_queue);
710 xpt_release_ccb(start_ccb);
712 struct ccb_accept_tio *atio;
713 struct ccb_scsiio *csio;
720 /* Take the ATIO off the work queue */
721 TAILQ_REMOVE(&softc->work_queue, ccb_h, periph_links.tqe);
722 atio = (struct ccb_accept_tio *)ccb_h;
723 io = (union ctl_io *)ccb_h->io_ptr;
724 csio = &start_ccb->csio;
726 flags = atio->ccb_h.flags &
727 (CAM_DIS_DISCONNECT|CAM_TAG_ACTION_VALID|CAM_DIR_MASK);
730 || (io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE) {
732 * We're done, send status back.
734 flags |= CAM_SEND_STATUS;
736 scsi_status = SCSI_STATUS_BUSY;
738 } else if ((io->io_hdr.status & CTL_STATUS_MASK) ==
740 io->io_hdr.flags &= ~CTL_FLAG_STATUS_QUEUED;
743 * If this command was aborted, we don't
744 * need to send status back to the SIM.
745 * Just free the CTIO and ctl_io, and
746 * recycle the ATIO back to the SIM.
748 xpt_print(periph->path, "%s: aborted "
749 "command 0x%04x discarded\n",
750 __func__, io->scsiio.tag_num);
753 * For a wildcard attachment, commands can
754 * come in with a specific target/lun. Reset
755 * the target and LUN fields back to the
756 * wildcard values before we send them back
757 * down to the SIM. The SIM has a wildcard
758 * LUN enabled, not whatever target/lun
759 * these happened to be.
761 if (softc->flags & CTLFE_LUN_WILDCARD) {
762 atio->ccb_h.target_id =
764 atio->ccb_h.target_lun =
768 if ((atio->ccb_h.status & CAM_DEV_QFRZN) != 0) {
769 cam_release_devq(periph->path,
774 atio->ccb_h.status &= ~CAM_DEV_QFRZN;
777 ccb_h = TAILQ_FIRST(&softc->work_queue);
779 if (atio->ccb_h.func_code !=
780 XPT_ACCEPT_TARGET_IO) {
781 xpt_print(periph->path, "%s: func_code "
782 "is %#x\n", __func__,
783 atio->ccb_h.func_code);
785 start_ccb->ccb_h.func_code = XPT_ABORT;
786 start_ccb->cab.abort_ccb = (union ccb *)atio;
788 /* Tell the SIM that we've aborted this ATIO */
789 xpt_action(start_ccb);
791 xpt_release_ccb(start_ccb);
794 * Send the ATIO back down to the SIM.
796 xpt_action((union ccb *)atio);
800 * If we still have work to do, ask for
801 * another CCB. Otherwise, deactivate our
805 xpt_schedule(periph, /*priority*/ 1);
807 callout_stop(&softc->dma_callout);
811 io->io_hdr.flags &= ~CTL_FLAG_STATUS_QUEUED;
812 scsi_status = io->scsiio.scsi_status;
813 csio->sense_len = io->scsiio.sense_len;
818 printf("%s: tag %04x io is NULL\n", __func__,
822 printf("%s: tag %04x status %x\n", __func__,
823 atio->tag_id, io->io_hdr.status);
826 csio->sglist_cnt = 0;
827 if (csio->sense_len != 0) {
828 csio->sense_data = io->scsiio.sense_data;
829 flags |= CAM_SEND_SENSE;
830 } else if (scsi_status == SCSI_STATUS_CHECK_COND) {
831 xpt_print(periph->path, "%s: check condition "
832 "with no sense\n", __func__);
835 struct ctlfe_lun_cmd_info *cmd_info;
838 * Datamove call, we need to setup the S/G list.
841 cmd_info = (struct ctlfe_lun_cmd_info *)
842 io->io_hdr.port_priv;
844 KASSERT(sizeof(*cmd_info) < CTL_PORT_PRIV_SIZE,
845 ("%s: sizeof(struct ctlfe_lun_cmd_info) %zd < "
846 "CTL_PORT_PRIV_SIZE %d", __func__,
847 sizeof(*cmd_info), CTL_PORT_PRIV_SIZE));
848 io->io_hdr.flags &= ~CTL_FLAG_DMA_QUEUED;
851 * Need to zero this, in case it has been used for
852 * a previous datamove for this particular I/O.
854 bzero(cmd_info, sizeof(*cmd_info));
858 * Set the direction, relative to the initiator.
860 flags &= ~CAM_DIR_MASK;
861 if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
865 flags |= CAM_DIR_OUT;
867 csio->cdb_len = atio->cdb_len;
869 flags &= ~CAM_DATA_MASK;
870 if (io->scsiio.kern_sg_entries == 0) {
872 data_ptr = io->scsiio.kern_data_ptr;
873 dxfer_len = io->scsiio.kern_data_len;
874 csio->sglist_cnt = 0;
876 if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR)
877 flags |= CAM_DATA_PADDR;
879 flags |= CAM_DATA_VADDR;
880 } else if (io->scsiio.kern_sg_entries <=
881 (sizeof(cmd_info->cam_sglist)/
882 sizeof(cmd_info->cam_sglist[0]))) {
884 * S/G list with physical or virtual pointers.
885 * Just populate the CAM S/G list with the
889 struct ctl_sg_entry *ctl_sglist;
890 bus_dma_segment_t *cam_sglist;
892 ctl_sglist = (struct ctl_sg_entry *)
893 io->scsiio.kern_data_ptr;
894 cam_sglist = cmd_info->cam_sglist;
896 for (i = 0; i < io->scsiio.kern_sg_entries;i++){
897 cam_sglist[i].ds_addr =
898 (bus_addr_t)ctl_sglist[i].addr;
899 cam_sglist[i].ds_len =
902 csio->sglist_cnt = io->scsiio.kern_sg_entries;
903 if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR)
904 flags |= CAM_DATA_SG_PADDR;
906 flags |= CAM_DATA_SG;
907 data_ptr = (uint8_t *)cam_sglist;
908 dxfer_len = io->scsiio.kern_data_len;
910 /* S/G list with virtual pointers */
911 struct ctl_sg_entry *sglist;
915 * If we have more S/G list pointers than
916 * will fit in the available storage in the
917 * cmd_info structure inside the ctl_io header,
918 * then we need to send down the pointers
919 * one element at a time.
922 sglist = (struct ctl_sg_entry *)
923 io->scsiio.kern_data_ptr;
924 ti = &cmd_info->cur_transfer_index;
925 data_ptr = sglist[*ti].addr;
926 dxfer_len = sglist[*ti].len;
927 csio->sglist_cnt = 0;
928 if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR)
929 flags |= CAM_DATA_PADDR;
931 flags |= CAM_DATA_VADDR;
932 cmd_info->flags |= CTLFE_CMD_PIECEWISE;
936 io->scsiio.ext_data_filled += dxfer_len;
938 if (io->scsiio.ext_data_filled >
939 io->scsiio.kern_total_len) {
940 xpt_print(periph->path, "%s: tag 0x%04x "
941 "fill len %u > total %u\n",
942 __func__, io->scsiio.tag_num,
943 io->scsiio.ext_data_filled,
944 io->scsiio.kern_total_len);
949 printf("%s: %s: tag %04x flags %x ptr %p len %u\n", __func__,
950 (flags & CAM_SEND_STATUS) ? "done" : "datamove",
951 atio->tag_id, flags, data_ptr, dxfer_len);
955 * Valid combinations:
956 * - CAM_SEND_STATUS, CAM_DATA_SG = 0, dxfer_len = 0,
958 * - CAM_SEND_STATUS = 0, CAM_DATA_SG = 0, dxfer_len != 0,
960 * - CAM_SEND_STATUS = 0, CAM_DATA_SG, dxfer_len != 0,
964 if (((flags & CAM_SEND_STATUS)
965 && (((flags & CAM_DATA_SG) != 0)
967 || (csio->sglist_cnt != 0)))
968 || (((flags & CAM_SEND_STATUS) == 0)
970 || ((flags & CAM_DATA_SG)
971 && (csio->sglist_cnt == 0))
972 || (((flags & CAM_DATA_SG) == 0)
973 && (csio->sglist_cnt != 0))) {
974 printf("%s: tag %04x cdb %02x flags %#x dxfer_len "
975 "%d sg %u\n", __func__, atio->tag_id,
976 atio->cdb_io.cdb_bytes[0], flags, dxfer_len,
979 printf("%s: tag %04x io status %#x\n", __func__,
980 atio->tag_id, io->io_hdr.status);
982 printf("%s: tag %04x no associated io\n",
983 __func__, atio->tag_id);
991 (flags & CAM_TAG_ACTION_VALID) ?
992 MSG_SIMPLE_Q_TAG : 0,
996 /*data_ptr*/ data_ptr,
997 /*dxfer_len*/ dxfer_len,
998 /*timeout*/ 5 * 1000);
999 start_ccb->ccb_h.flags |= CAM_UNLOCKED;
1000 start_ccb->ccb_h.ccb_atio = atio;
1001 if (((flags & CAM_SEND_STATUS) == 0)
1003 io->io_hdr.flags |= CTL_FLAG_DMA_INPROG;
1005 softc->ctios_sent++;
1007 cam_periph_unlock(periph);
1008 xpt_action(start_ccb);
1009 cam_periph_lock(periph);
1011 if ((atio->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1012 cam_release_devq(periph->path,
1016 /*getcount_only*/0);
1017 atio->ccb_h.status &= ~CAM_DEV_QFRZN;
1020 ccb_h = TAILQ_FIRST(&softc->work_queue);
1023 * If we still have work to do, ask for another CCB. Otherwise,
1024 * deactivate our callout.
1027 xpt_schedule(periph, /*priority*/ 1);
1029 callout_stop(&softc->dma_callout);
1033 ctlfe_free_ccb(struct cam_periph *periph, union ccb *ccb)
1035 struct ctlfe_lun_softc *softc;
1037 softc = (struct ctlfe_lun_softc *)periph->softc;
1039 switch (ccb->ccb_h.func_code) {
1040 case XPT_ACCEPT_TARGET_IO:
1041 softc->atios_returned++;
1043 case XPT_IMMEDIATE_NOTIFY:
1044 case XPT_NOTIFY_ACKNOWLEDGE:
1045 softc->inots_returned++;
1053 KASSERT(softc->atios_returned <= softc->atios_sent, ("%s: "
1054 "atios_returned %ju > atios_sent %ju", __func__,
1055 softc->atios_returned, softc->atios_sent));
1056 KASSERT(softc->inots_returned <= softc->inots_sent, ("%s: "
1057 "inots_returned %ju > inots_sent %ju", __func__,
1058 softc->inots_returned, softc->inots_sent));
1061 * If we have received all of our CCBs, we can release our
1062 * reference on the peripheral driver. It will probably go away
1065 if ((softc->atios_returned == softc->atios_sent)
1066 && (softc->inots_returned == softc->inots_sent)) {
1067 cam_periph_release_locked(periph);
1072 ctlfe_adjust_cdb(struct ccb_accept_tio *atio, uint32_t offset)
1075 uint32_t num_blocks, nbc;
1076 uint8_t *cmdbyt = (atio->ccb_h.flags & CAM_CDB_POINTER)?
1077 atio->cdb_io.cdb_ptr : atio->cdb_io.cdb_bytes;
1079 nbc = offset >> 9; /* ASSUMING 512 BYTE BLOCKS */
1081 switch (cmdbyt[0]) {
1085 struct scsi_rw_6 *cdb = (struct scsi_rw_6 *)cmdbyt;
1086 lba = scsi_3btoul(cdb->addr);
1088 num_blocks = cdb->length;
1089 if (num_blocks == 0)
1093 scsi_ulto3b(lba, cdb->addr);
1094 cdb->length = num_blocks;
1100 struct scsi_rw_10 *cdb = (struct scsi_rw_10 *)cmdbyt;
1101 lba = scsi_4btoul(cdb->addr);
1102 num_blocks = scsi_2btoul(cdb->length);
1105 scsi_ulto4b(lba, cdb->addr);
1106 scsi_ulto2b(num_blocks, cdb->length);
1112 struct scsi_rw_12 *cdb = (struct scsi_rw_12 *)cmdbyt;
1113 lba = scsi_4btoul(cdb->addr);
1114 num_blocks = scsi_4btoul(cdb->length);
1117 scsi_ulto4b(lba, cdb->addr);
1118 scsi_ulto4b(num_blocks, cdb->length);
1124 struct scsi_rw_16 *cdb = (struct scsi_rw_16 *)cmdbyt;
1125 lba = scsi_8btou64(cdb->addr);
1126 num_blocks = scsi_4btoul(cdb->length);
1129 scsi_u64to8b(lba, cdb->addr);
1130 scsi_ulto4b(num_blocks, cdb->length);
1140 ctlfedone(struct cam_periph *periph, union ccb *done_ccb)
1142 struct ctlfe_lun_softc *softc;
1143 struct ctlfe_softc *bus_softc;
1144 struct ccb_accept_tio *atio = NULL;
1145 union ctl_io *io = NULL;
1148 KASSERT((done_ccb->ccb_h.flags & CAM_UNLOCKED) != 0,
1149 ("CCB in ctlfedone() without CAM_UNLOCKED flag"));
1151 printf("%s: entered, func_code = %#x, type = %#lx\n", __func__,
1152 done_ccb->ccb_h.func_code, done_ccb->ccb_h.ccb_type);
1155 softc = (struct ctlfe_lun_softc *)periph->softc;
1156 bus_softc = softc->parent_softc;
1157 mtx = cam_periph_mtx(periph);
1161 * If the peripheral is invalid, ATIOs and immediate notify CCBs
1162 * need to be freed. Most of the ATIOs and INOTs that come back
1163 * will be CCBs that are being returned from the SIM as a result of
1164 * our disabling the LUN.
1166 * Other CCB types are handled in their respective cases below.
1168 if (periph->flags & CAM_PERIPH_INVALID) {
1169 switch (done_ccb->ccb_h.func_code) {
1170 case XPT_ACCEPT_TARGET_IO:
1171 case XPT_IMMEDIATE_NOTIFY:
1172 case XPT_NOTIFY_ACKNOWLEDGE:
1173 ctlfe_free_ccb(periph, done_ccb);
1180 switch (done_ccb->ccb_h.func_code) {
1181 case XPT_ACCEPT_TARGET_IO: {
1183 atio = &done_ccb->atio;
1185 softc->atios_returned++;
1189 * Allocate a ctl_io, pass it to CTL, and wait for the
1192 io = ctl_alloc_io(bus_softc->fe.ctl_pool_ref);
1194 atio->ccb_h.flags &= ~CAM_DIR_MASK;
1195 atio->ccb_h.flags |= CAM_DIR_NONE;
1197 printf("%s: ctl_alloc_io failed!\n", __func__);
1200 * XXX KDM need to set SCSI_STATUS_BUSY, but there
1201 * is no field in the ATIO structure to do that,
1202 * and we aren't able to allocate a ctl_io here.
1205 atio->sense_len = 0;
1206 done_ccb->ccb_h.io_ptr = NULL;
1207 TAILQ_INSERT_TAIL(&softc->work_queue, &atio->ccb_h,
1209 xpt_schedule(periph, /*priority*/ 1);
1215 /* Save pointers on both sides */
1216 io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr = done_ccb;
1217 done_ccb->ccb_h.io_ptr = io;
1220 * Only SCSI I/O comes down this path, resets, etc. come
1221 * down the immediate notify path below.
1223 io->io_hdr.io_type = CTL_IO_SCSI;
1224 io->io_hdr.nexus.initid.id = atio->init_id;
1225 io->io_hdr.nexus.targ_port = bus_softc->fe.targ_port;
1226 io->io_hdr.nexus.targ_target.id = atio->ccb_h.target_id;
1227 io->io_hdr.nexus.targ_lun = atio->ccb_h.target_lun;
1228 io->scsiio.tag_num = atio->tag_id;
1229 switch (atio->tag_action) {
1230 case CAM_TAG_ACTION_NONE:
1231 io->scsiio.tag_type = CTL_TAG_UNTAGGED;
1233 case MSG_SIMPLE_TASK:
1234 io->scsiio.tag_type = CTL_TAG_SIMPLE;
1236 case MSG_HEAD_OF_QUEUE_TASK:
1237 io->scsiio.tag_type = CTL_TAG_HEAD_OF_QUEUE;
1239 case MSG_ORDERED_TASK:
1240 io->scsiio.tag_type = CTL_TAG_ORDERED;
1243 io->scsiio.tag_type = CTL_TAG_ACA;
1246 io->scsiio.tag_type = CTL_TAG_UNTAGGED;
1247 printf("%s: unhandled tag type %#x!!\n", __func__,
1251 if (atio->cdb_len > sizeof(io->scsiio.cdb)) {
1252 printf("%s: WARNING: CDB len %d > ctl_io space %zd\n",
1253 __func__, atio->cdb_len, sizeof(io->scsiio.cdb));
1255 io->scsiio.cdb_len = min(atio->cdb_len, sizeof(io->scsiio.cdb));
1256 bcopy(atio->cdb_io.cdb_bytes, io->scsiio.cdb,
1257 io->scsiio.cdb_len);
1260 printf("%s: %ju:%d:%ju:%d: tag %04x CDB %02x\n", __func__,
1261 (uintmax_t)io->io_hdr.nexus.initid.id,
1262 io->io_hdr.nexus.targ_port,
1263 (uintmax_t)io->io_hdr.nexus.targ_target.id,
1264 io->io_hdr.nexus.targ_lun,
1265 io->scsiio.tag_num, io->scsiio.cdb[0]);
1271 case XPT_CONT_TARGET_IO: {
1273 uint32_t srr_off = 0;
1275 atio = (struct ccb_accept_tio *)done_ccb->ccb_h.ccb_atio;
1276 io = (union ctl_io *)atio->ccb_h.io_ptr;
1278 softc->ctios_returned++;
1280 printf("%s: got XPT_CONT_TARGET_IO tag %#x flags %#x\n",
1281 __func__, atio->tag_id, done_ccb->ccb_h.flags);
1284 * Handle SRR case were the data pointer is pushed back hack
1286 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_MESSAGE_RECV
1287 && done_ccb->csio.msg_ptr != NULL
1288 && done_ccb->csio.msg_ptr[0] == MSG_EXTENDED
1289 && done_ccb->csio.msg_ptr[1] == 5
1290 && done_ccb->csio.msg_ptr[2] == 0) {
1293 (done_ccb->csio.msg_ptr[3] << 24)
1294 | (done_ccb->csio.msg_ptr[4] << 16)
1295 | (done_ccb->csio.msg_ptr[5] << 8)
1296 | (done_ccb->csio.msg_ptr[6]);
1299 if (srr && (done_ccb->ccb_h.flags & CAM_SEND_STATUS)) {
1301 * If status was being sent, the back end data is now
1302 * history. Hack it up and resubmit a new command with
1303 * the CDB adjusted. If the SIM does the right thing,
1304 * all of the resid math should work.
1306 softc->ccbs_freed++;
1307 xpt_release_ccb(done_ccb);
1309 if (ctlfe_adjust_cdb(atio, srr_off) == 0) {
1310 done_ccb = (union ccb *)atio;
1314 * Fall through to doom....
1318 * If we have an srr and we're still sending data, we
1319 * should be able to adjust offsets and cycle again.
1321 io->scsiio.kern_rel_offset =
1322 io->scsiio.ext_data_filled = srr_off;
1323 io->scsiio.ext_data_len = io->scsiio.kern_total_len -
1324 io->scsiio.kern_rel_offset;
1325 softc->ccbs_freed++;
1326 io->scsiio.io_hdr.status = CTL_STATUS_NONE;
1327 xpt_release_ccb(done_ccb);
1328 TAILQ_INSERT_HEAD(&softc->work_queue, &atio->ccb_h,
1330 xpt_schedule(periph, /*priority*/ 1);
1335 * If we were sending status back to the initiator, free up
1336 * resources. If we were doing a datamove, call the
1337 * datamove done routine.
1339 if (done_ccb->ccb_h.flags & CAM_SEND_STATUS) {
1340 softc->ccbs_freed++;
1341 xpt_release_ccb(done_ccb);
1344 * For a wildcard attachment, commands can come in
1345 * with a specific target/lun. Reset the target
1346 * and LUN fields back to the wildcard values before
1347 * we send them back down to the SIM. The SIM has
1348 * a wildcard LUN enabled, not whatever target/lun
1349 * these happened to be.
1351 if (softc->flags & CTLFE_LUN_WILDCARD) {
1352 atio->ccb_h.target_id = CAM_TARGET_WILDCARD;
1353 atio->ccb_h.target_lun = CAM_LUN_WILDCARD;
1355 if (periph->flags & CAM_PERIPH_INVALID) {
1356 ctlfe_free_ccb(periph, (union ccb *)atio);
1358 softc->atios_sent++;
1360 xpt_action((union ccb *)atio);
1364 struct ctlfe_lun_cmd_info *cmd_info;
1365 struct ccb_scsiio *csio;
1367 csio = &done_ccb->csio;
1368 cmd_info = (struct ctlfe_lun_cmd_info *)
1369 io->io_hdr.port_priv;
1371 io->io_hdr.flags &= ~CTL_FLAG_DMA_INPROG;
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);
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.
1390 switch (done_ccb->ccb_h.status & CAM_STATUS_MASK) {
1392 io->io_hdr.port_status = 0;
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.
1406 io->io_hdr.port_status = 0xbad1;
1407 ctl_set_data_phase_error(&io->scsiio);
1409 * XXX KDM figure out residual.
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.
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;
1424 uint8_t scsi_status;
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|
1438 * Set the direction, relative to the initiator.
1440 flags &= ~CAM_DIR_MASK;
1441 if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
1443 flags |= CAM_DIR_IN;
1445 flags |= CAM_DIR_OUT;
1447 data_ptr = sglist[*ti].addr;
1448 dxfer_len = sglist[*ti].len;
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__,
1458 atio->cdb_io.cdb_bytes[0]);
1459 printf("%s: tag %04x io status %#x\n",
1460 __func__, atio->tag_id,
1468 (flags & CAM_TAG_ACTION_VALID) ?
1469 MSG_SIMPLE_Q_TAG : 0,
1473 /*data_ptr*/ data_ptr,
1474 /*dxfer_len*/ dxfer_len,
1475 /*timeout*/ 5 * 1000);
1477 csio->ccb_h.flags |= CAM_UNLOCKED;
1479 csio->ccb_h.ccb_atio = atio;
1480 io->io_hdr.flags |= CTL_FLAG_DMA_INPROG;
1481 softc->ctios_sent++;
1483 xpt_action((union ccb *)csio);
1486 * Release the CTIO. The ATIO will be sent back
1487 * down to the SIM once we send status.
1489 softc->ccbs_freed++;
1490 xpt_release_ccb(done_ccb);
1493 /* Call the backend move done callback */
1494 io->scsiio.be_move_done(io);
1500 case XPT_IMMEDIATE_NOTIFY: {
1502 struct ccb_immediate_notify *inot;
1506 inot = &done_ccb->cin1;
1508 softc->inots_returned++;
1510 frozen = (done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0;
1512 printf("%s: got XPT_IMMEDIATE_NOTIFY status %#x tag %#x "
1513 "seq %#x\n", __func__, inot->ccb_h.status,
1514 inot->tag_id, inot->seq_id);
1516 io = ctl_alloc_io(bus_softc->fe.ctl_pool_ref);
1523 io->io_hdr.io_type = CTL_IO_TASK;
1524 io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr =done_ccb;
1525 inot->ccb_h.io_ptr = io;
1526 io->io_hdr.nexus.initid.id = inot->initiator_id;
1527 io->io_hdr.nexus.targ_port = bus_softc->fe.targ_port;
1528 io->io_hdr.nexus.targ_target.id = inot->ccb_h.target_id;
1529 io->io_hdr.nexus.targ_lun = inot->ccb_h.target_lun;
1530 /* XXX KDM should this be the tag_id? */
1531 io->taskio.tag_num = inot->seq_id;
1533 status = inot->ccb_h.status & CAM_STATUS_MASK;
1535 case CAM_SCSI_BUS_RESET:
1536 io->taskio.task_action = CTL_TASK_BUS_RESET;
1539 io->taskio.task_action = CTL_TASK_TARGET_RESET;
1541 case CAM_MESSAGE_RECV:
1542 switch (inot->arg) {
1543 case MSG_ABORT_TASK_SET:
1545 * XXX KDM this isn't currently
1546 * supported by CTL. It ends up
1549 io->taskio.task_action =
1550 CTL_TASK_ABORT_TASK_SET;
1552 case MSG_TARGET_RESET:
1553 io->taskio.task_action =
1554 CTL_TASK_TARGET_RESET;
1556 case MSG_ABORT_TASK:
1557 io->taskio.task_action =
1558 CTL_TASK_ABORT_TASK;
1560 case MSG_LOGICAL_UNIT_RESET:
1561 io->taskio.task_action =
1564 case MSG_CLEAR_TASK_SET:
1566 * XXX KDM this isn't currently
1567 * supported by CTL. It ends up
1570 io->taskio.task_action =
1571 CTL_TASK_CLEAR_TASK_SET;
1574 io->taskio.task_action =
1581 xpt_print(periph->path, "%s: "
1582 "unsupported message 0x%x\n",
1583 __func__, inot->arg);
1588 case CAM_REQ_ABORTED:
1590 * This request was sent back by the driver.
1591 * XXX KDM what do we do here?
1595 case CAM_REQ_INVALID:
1596 case CAM_PROVIDE_FAIL:
1599 * We should only get here if we're talking
1600 * to a talking to a SIM that is target
1601 * capable but supports the old API. In
1602 * that case, we need to just free the CCB.
1603 * If we actually send a notify acknowledge,
1604 * it will send that back with an error as
1608 if ((status != CAM_REQ_INVALID)
1609 && (status != CAM_PROVIDE_FAIL))
1610 xpt_print(periph->path, "%s: "
1611 "unsupported CAM status "
1612 "0x%x\n", __func__, status);
1615 ctlfe_free_ccb(periph, done_ccb);
1619 if (send_ctl_io != 0) {
1623 done_ccb->ccb_h.status = CAM_REQ_INPROG;
1624 done_ccb->ccb_h.func_code =
1625 XPT_NOTIFY_ACKNOWLEDGE;
1626 xpt_action(done_ccb);
1629 xpt_print(periph->path, "%s: could not allocate "
1630 "ctl_io for immediate notify!\n", __func__);
1631 /* requeue this to the adapter */
1632 done_ccb->ccb_h.status = CAM_REQ_INPROG;
1633 done_ccb->ccb_h.func_code = XPT_NOTIFY_ACKNOWLEDGE;
1634 xpt_action(done_ccb);
1638 cam_release_devq(periph->path,
1640 /*opening reduction*/ 0,
1642 /*getcount_only*/ 0);
1646 case XPT_NOTIFY_ACKNOWLEDGE:
1648 * Queue this back down to the SIM as an immediate notify.
1650 done_ccb->ccb_h.func_code = XPT_IMMEDIATE_NOTIFY;
1651 xpt_action(done_ccb);
1652 softc->inots_sent++;
1654 case XPT_SET_SIM_KNOB:
1655 case XPT_GET_SIM_KNOB:
1658 panic("%s: unexpected CCB type %#x", __func__,
1659 done_ccb->ccb_h.func_code);
1668 ctlfe_onoffline(void *arg, int online)
1670 struct ctlfe_softc *bus_softc;
1673 struct cam_path *path;
1676 bus_softc = (struct ctlfe_softc *)arg;
1680 status = xpt_create_path(&path, /*periph*/ NULL, bus_softc->path_id,
1681 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
1682 if (status != CAM_REQ_CMP) {
1683 printf("%s: unable to create path!\n", __func__);
1686 ccb = (union ccb *)malloc(sizeof(*ccb), M_TEMP, M_NOWAIT | M_ZERO);
1688 printf("%s: unable to malloc CCB!\n", __func__);
1689 xpt_free_path(path);
1692 xpt_setup_ccb(&ccb->ccb_h, path, CAM_PRIORITY_NONE);
1697 * Bits 63-60: 0x5 NAA, IEEE registered name
1698 * Bits 59-36: 0x000ED5 IEEE Company name assigned to Copan
1699 * Bits 35-12: Copan SSN (Sequential Serial Number)
1700 * Bits 11-8: Type of port:
1704 * Bits 7-0: 0 == Node Name, >0 == Port Number
1709 ccb->ccb_h.func_code = XPT_GET_SIM_KNOB;
1715 if ((ccb->knob.xport_specific.valid & KNOB_VALID_ADDRESS) != 0){
1717 uint64_t random_bits;
1720 printf("%s: %s current WWNN %#jx\n", __func__,
1721 bus_softc->port_name,
1722 ccb->knob.xport_specific.fc.wwnn);
1723 printf("%s: %s current WWPN %#jx\n", __func__,
1724 bus_softc->port_name,
1725 ccb->knob.xport_specific.fc.wwpn);
1728 arc4rand(&random_bits, sizeof(random_bits), 0);
1732 * XXX KDM this is a bit of a kludge for now. We
1733 * take the current WWNN/WWPN from the card, and
1734 * replace the company identifier and the NL-Port
1735 * indicator and the port number (for the WWPN).
1736 * This should be replaced later with ddb_GetWWNN,
1737 * or possibly a more centralized scheme. (It
1738 * would be nice to have the WWNN/WWPN for each
1739 * port stored in the ctl_frontend structure.)
1742 ccb->knob.xport_specific.fc.wwnn =
1744 0x0000000fffffff00ULL) |
1745 /* Company ID */ 0x5000ED5000000000ULL |
1746 /* NL-Port */ 0x0300;
1747 ccb->knob.xport_specific.fc.wwpn =
1749 0x0000000fffffff00ULL) |
1750 /* Company ID */ 0x5000ED5000000000ULL |
1751 /* NL-Port */ 0x3000 |
1752 /* Port Num */ (bus_softc->fe.targ_port & 0xff);
1755 * This is a bit of an API break/reversal, but if
1756 * we're doing the random WWNN that's a little
1757 * different anyway. So record what we're actually
1758 * using with the frontend code so it's reported
1761 bus_softc->fe.wwnn =
1762 ccb->knob.xport_specific.fc.wwnn;
1763 bus_softc->fe.wwpn =
1764 ccb->knob.xport_specific.fc.wwpn;
1766 #else /* RANDOM_WWNN */
1768 * If the user has specified a WWNN/WWPN, send them
1769 * down to the SIM. Otherwise, record what the SIM
1772 if ((bus_softc->fe.wwnn != 0)
1773 && (bus_softc->fe.wwpn != 0)) {
1774 ccb->knob.xport_specific.fc.wwnn =
1776 ccb->knob.xport_specific.fc.wwpn =
1780 bus_softc->fe.wwnn =
1781 ccb->knob.xport_specific.fc.wwnn;
1782 bus_softc->fe.wwpn =
1783 ccb->knob.xport_specific.fc.wwpn;
1785 #endif /* RANDOM_WWNN */
1788 if (set_wwnn != 0) {
1789 printf("%s: %s new WWNN %#jx\n", __func__,
1790 bus_softc->port_name,
1791 ccb->knob.xport_specific.fc.wwnn);
1792 printf("%s: %s new WWPN %#jx\n", __func__,
1793 bus_softc->port_name,
1794 ccb->knob.xport_specific.fc.wwpn);
1797 printf("%s: %s has no valid WWNN/WWPN\n", __func__,
1798 bus_softc->port_name);
1801 ccb->ccb_h.func_code = XPT_SET_SIM_KNOB;
1802 ccb->knob.xport_specific.valid = KNOB_VALID_ROLE;
1804 ccb->knob.xport_specific.valid |= KNOB_VALID_ADDRESS;
1807 ccb->knob.xport_specific.fc.role = KNOB_ROLE_TARGET;
1809 ccb->knob.xport_specific.fc.role = KNOB_ROLE_NONE;
1813 if ((ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1814 printf("%s: SIM %s (path id %d) target %s failed with "
1816 __func__, bus_softc->port_name, bus_softc->path_id,
1817 (online != 0) ? "enable" : "disable",
1820 printf("%s: SIM %s (path id %d) target %s succeeded\n",
1821 __func__, bus_softc->port_name, bus_softc->path_id,
1822 (online != 0) ? "enable" : "disable");
1825 xpt_free_path(path);
1833 ctlfe_online(void *arg)
1835 struct ctlfe_softc *bus_softc;
1836 struct cam_path *path;
1838 struct ctlfe_lun_softc *lun_softc;
1840 bus_softc = (struct ctlfe_softc *)arg;
1843 * Create the wildcard LUN before bringing the port online.
1845 status = xpt_create_path(&path, /*periph*/ NULL,
1846 bus_softc->path_id, CAM_TARGET_WILDCARD,
1848 if (status != CAM_REQ_CMP) {
1849 printf("%s: unable to create path for wildcard periph\n",
1854 lun_softc = malloc(sizeof(*lun_softc), M_CTLFE,
1856 if (lun_softc == NULL) {
1857 xpt_print(path, "%s: unable to allocate softc for "
1858 "wildcard periph\n", __func__);
1859 xpt_free_path(path);
1863 xpt_path_lock(path);
1864 lun_softc->parent_softc = bus_softc;
1865 lun_softc->flags |= CTLFE_LUN_WILDCARD;
1867 mtx_lock(&bus_softc->lun_softc_mtx);
1868 STAILQ_INSERT_TAIL(&bus_softc->lun_softc_list, lun_softc, links);
1869 mtx_unlock(&bus_softc->lun_softc_mtx);
1871 status = cam_periph_alloc(ctlferegister,
1882 if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1883 const struct cam_status_entry *entry;
1885 entry = cam_fetch_status_entry(status);
1887 printf("%s: CAM error %s (%#x) returned from "
1888 "cam_periph_alloc()\n", __func__, (entry != NULL) ?
1889 entry->status_text : "Unknown", status);
1892 ctlfe_onoffline(arg, /*online*/ 1);
1894 xpt_path_unlock(path);
1895 xpt_free_path(path);
1899 ctlfe_offline(void *arg)
1901 struct ctlfe_softc *bus_softc;
1902 struct cam_path *path;
1904 struct cam_periph *periph;
1906 bus_softc = (struct ctlfe_softc *)arg;
1909 * Disable the wildcard LUN for this port now that we have taken
1912 status = xpt_create_path(&path, /*periph*/ NULL,
1913 bus_softc->path_id, CAM_TARGET_WILDCARD,
1915 if (status != CAM_REQ_CMP) {
1916 printf("%s: unable to create path for wildcard periph\n",
1921 xpt_path_lock(path);
1923 ctlfe_onoffline(arg, /*online*/ 0);
1925 if ((periph = cam_periph_find(path, "ctl")) != NULL)
1926 cam_periph_invalidate(periph);
1928 xpt_path_unlock(path);
1929 xpt_free_path(path);
1933 ctlfe_targ_enable(void *arg, struct ctl_id targ_id)
1939 ctlfe_targ_disable(void *arg, struct ctl_id targ_id)
1945 * This will get called to enable a LUN on every bus that is attached to
1946 * CTL. So we only need to create a path/periph for this particular bus.
1949 ctlfe_lun_enable(void *arg, struct ctl_id targ_id, int lun_id)
1951 struct ctlfe_softc *bus_softc;
1952 struct ctlfe_lun_softc *softc;
1953 struct cam_path *path;
1954 struct cam_periph *periph;
1957 bus_softc = (struct ctlfe_softc *)arg;
1959 status = xpt_create_path(&path, /*periph*/ NULL,
1961 targ_id.id, lun_id);
1962 /* XXX KDM need some way to return status to CTL here? */
1963 if (status != CAM_REQ_CMP) {
1964 printf("%s: could not create path, status %#x\n", __func__,
1969 softc = malloc(sizeof(*softc), M_CTLFE, M_WAITOK | M_ZERO);
1970 xpt_path_lock(path);
1971 periph = cam_periph_find(path, "ctl");
1972 if (periph != NULL) {
1973 /* We've already got a periph, no need to alloc a new one. */
1974 xpt_path_unlock(path);
1975 xpt_free_path(path);
1976 free(softc, M_CTLFE);
1980 softc->parent_softc = bus_softc;
1981 mtx_lock(&bus_softc->lun_softc_mtx);
1982 STAILQ_INSERT_TAIL(&bus_softc->lun_softc_list, softc, links);
1983 mtx_unlock(&bus_softc->lun_softc_mtx);
1985 status = cam_periph_alloc(ctlferegister,
1996 xpt_path_unlock(path);
1997 xpt_free_path(path);
2002 * This will get called when the user removes a LUN to disable that LUN
2003 * on every bus that is attached to CTL.
2006 ctlfe_lun_disable(void *arg, struct ctl_id targ_id, int lun_id)
2008 struct ctlfe_softc *softc;
2009 struct ctlfe_lun_softc *lun_softc;
2011 softc = (struct ctlfe_softc *)arg;
2013 mtx_lock(&softc->lun_softc_mtx);
2014 STAILQ_FOREACH(lun_softc, &softc->lun_softc_list, links) {
2015 struct cam_path *path;
2017 path = lun_softc->periph->path;
2019 if ((xpt_path_target_id(path) == targ_id.id)
2020 && (xpt_path_lun_id(path) == lun_id)) {
2024 if (lun_softc == NULL) {
2025 mtx_unlock(&softc->lun_softc_mtx);
2026 printf("%s: can't find target %d lun %d\n", __func__,
2027 targ_id.id, lun_id);
2030 cam_periph_acquire(lun_softc->periph);
2031 mtx_unlock(&softc->lun_softc_mtx);
2033 cam_periph_lock(lun_softc->periph);
2034 cam_periph_invalidate(lun_softc->periph);
2035 cam_periph_unlock(lun_softc->periph);
2036 cam_periph_release(lun_softc->periph);
2041 ctlfe_dump_sim(struct cam_sim *sim)
2044 printf("%s%d: max tagged openings: %d, max dev openings: %d\n",
2045 sim->sim_name, sim->unit_number,
2046 sim->max_tagged_dev_openings, sim->max_dev_openings);
2051 * Assumes that the SIM lock is held.
2054 ctlfe_dump_queue(struct ctlfe_lun_softc *softc)
2056 struct ccb_hdr *hdr;
2057 struct cam_periph *periph;
2060 periph = softc->periph;
2063 TAILQ_FOREACH(hdr, &softc->work_queue, periph_links.tqe) {
2071 * This can happen when we get an ATIO but can't allocate
2072 * a ctl_io. See the XPT_ACCEPT_TARGET_IO case in ctlfedone().
2075 struct ccb_scsiio *csio;
2077 csio = (struct ccb_scsiio *)hdr;
2079 xpt_print(periph->path, "CCB %#x ctl_io allocation "
2080 "failed\n", csio->tag_id);
2085 * Only regular SCSI I/O is put on the work
2086 * queue, so we can print sense here. There may be no
2087 * sense if it's no the queue for a DMA, but this serves to
2088 * print out the CCB as well.
2090 * XXX KDM switch this over to scsi_sense_print() when
2091 * CTL is merged in with CAM.
2093 ctl_io_error_print(io, NULL);
2096 * We're sending status back to the
2097 * initiator, so we're on the queue waiting
2098 * for a CTIO to do that.
2100 if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE)
2104 * Otherwise, we're on the queue waiting to
2105 * do a data transfer.
2107 xpt_print(periph->path, "Total %u, Current %u, Resid %u\n",
2108 io->scsiio.kern_total_len, io->scsiio.kern_data_len,
2109 io->scsiio.kern_data_resid);
2112 xpt_print(periph->path, "%d requests total waiting for CCBs\n",
2114 xpt_print(periph->path, "%ju CCBs outstanding (%ju allocated, %ju "
2115 "freed)\n", (uintmax_t)(softc->ccbs_alloced -
2116 softc->ccbs_freed), (uintmax_t)softc->ccbs_alloced,
2117 (uintmax_t)softc->ccbs_freed);
2118 xpt_print(periph->path, "%ju CTIOs outstanding (%ju sent, %ju "
2119 "returned\n", (uintmax_t)(softc->ctios_sent -
2120 softc->ctios_returned), softc->ctios_sent,
2121 softc->ctios_returned);
2125 * This function is called when we fail to get a CCB for a DMA or status return
2126 * to the initiator within the specified time period.
2128 * The callout code should insure that we hold the sim mutex here.
2131 ctlfe_dma_timeout(void *arg)
2133 struct ctlfe_lun_softc *softc;
2134 struct cam_periph *periph;
2135 struct cam_sim *sim;
2138 softc = (struct ctlfe_lun_softc *)arg;
2139 periph = softc->periph;
2140 sim = xpt_path_sim(periph->path);
2146 if (TAILQ_FIRST(&softc->work_queue) == NULL) {
2147 xpt_print(periph->path, "TIMEOUT triggered after %d "
2148 "seconds, but nothing on work queue??\n",
2153 xpt_print(periph->path, "TIMEOUT (%d seconds) waiting for DMA to "
2154 "start\n", CTLFE_DMA_TIMEOUT);
2156 ctlfe_dump_queue(softc);
2158 ctlfe_dump_sim(sim);
2160 xpt_print(periph->path, "calling xpt_schedule() to attempt to "
2161 "unstick our queue\n");
2163 xpt_schedule(periph, /*priority*/ 1);
2165 xpt_print(periph->path, "xpt_schedule() call complete\n");
2169 * Datamove/done routine called by CTL. Put ourselves on the queue to
2170 * receive a CCB from CAM so we can queue the continue I/O request down
2174 ctlfe_datamove_done(union ctl_io *io)
2177 struct cam_periph *periph;
2178 struct ctlfe_lun_softc *softc;
2180 ccb = io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr;
2182 periph = xpt_path_periph(ccb->ccb_h.path);
2183 cam_periph_lock(periph);
2185 softc = (struct ctlfe_lun_softc *)periph->softc;
2187 if (io->io_hdr.io_type == CTL_IO_TASK) {
2189 * Task management commands don't require any further
2190 * communication back to the adapter. Requeue the CCB
2191 * to the adapter, and free the CTL I/O.
2193 xpt_print(ccb->ccb_h.path, "%s: returning task I/O "
2194 "tag %#x seq %#x\n", __func__,
2195 ccb->cin1.tag_id, ccb->cin1.seq_id);
2197 * Send the notify acknowledge down to the SIM, to let it
2198 * know we processed the task management command.
2200 ccb->ccb_h.status = CAM_REQ_INPROG;
2201 ccb->ccb_h.func_code = XPT_NOTIFY_ACKNOWLEDGE;
2205 if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE)
2206 io->io_hdr.flags |= CTL_FLAG_STATUS_QUEUED;
2208 io->io_hdr.flags |= CTL_FLAG_DMA_QUEUED;
2210 TAILQ_INSERT_TAIL(&softc->work_queue, &ccb->ccb_h,
2214 * Reset the timeout for our latest active DMA.
2216 callout_reset(&softc->dma_callout,
2217 CTLFE_DMA_TIMEOUT * hz,
2218 ctlfe_dma_timeout, softc);
2220 * Ask for the CAM transport layer to send us a CCB to do
2221 * the DMA or send status, unless ctlfe_dma_enabled is set
2224 if (ctlfe_dma_enabled != 0)
2225 xpt_schedule(periph, /*priority*/ 1);
2228 cam_periph_unlock(periph);
2234 struct ctlfe_softc *bus_softc;
2236 STAILQ_FOREACH(bus_softc, &ctlfe_softc_list, links) {
2237 struct ctlfe_lun_softc *lun_softc;
2239 ctlfe_dump_sim(bus_softc->sim);
2241 STAILQ_FOREACH(lun_softc, &bus_softc->lun_softc_list, links) {
2242 ctlfe_dump_queue(lun_softc);