2 * Copyright (c) 2008, 2009 Silicon Graphics International Corp.
3 * Copyright (c) 2014-2015 Alexander Motin <mav@FreeBSD.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions, and the following disclaimer,
11 * without modification.
12 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
13 * substantially similar to the "NO WARRANTY" disclaimer below
14 * ("Disclaimer") and any redistribution must be conditioned upon
15 * including a substantially similar Disclaimer requirement for further
16 * binary redistribution.
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
28 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGES.
31 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/scsi_ctl.c#4 $
34 * Peripheral driver interface between CAM and CTL (CAM Target Layer).
36 * Author: Ken Merry <ken@FreeBSD.org>
39 #include <sys/cdefs.h>
40 __FBSDID("$FreeBSD$");
42 #include <sys/param.h>
43 #include <sys/queue.h>
44 #include <sys/systm.h>
45 #include <sys/kernel.h>
47 #include <sys/mutex.h>
48 #include <sys/condvar.h>
49 #include <sys/malloc.h>
51 #include <sys/endian.h>
53 #include <sys/sysctl.h>
54 #include <sys/types.h>
55 #include <sys/systm.h>
56 #include <machine/bus.h>
59 #include <cam/cam_ccb.h>
60 #include <cam/cam_periph.h>
61 #include <cam/cam_queue.h>
62 #include <cam/cam_xpt_periph.h>
63 #include <cam/cam_debug.h>
64 #include <cam/cam_sim.h>
65 #include <cam/cam_xpt.h>
67 #include <cam/scsi/scsi_all.h>
68 #include <cam/scsi/scsi_message.h>
70 #include <cam/ctl/ctl_io.h>
71 #include <cam/ctl/ctl.h>
72 #include <cam/ctl/ctl_frontend.h>
73 #include <cam/ctl/ctl_util.h>
74 #include <cam/ctl/ctl_error.h>
79 target_id_t target_id;
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 #ifdef CTLFE_INIT_ENABLE
93 static int ctlfe_max_targets = 1;
94 static int ctlfe_num_targets = 0;
98 CTLFE_LUN_NONE = 0x00,
99 CTLFE_LUN_WILDCARD = 0x01
102 struct ctlfe_lun_softc {
103 struct ctlfe_softc *parent_softc;
104 struct cam_periph *periph;
105 ctlfe_lun_flags flags;
106 uint64_t ccbs_alloced;
109 uint64_t ctios_returned;
110 uint64_t atios_alloced;
111 uint64_t atios_freed;
112 uint64_t inots_alloced;
113 uint64_t inots_freed;
114 /* bus_dma_tag_t dma_tag; */
115 TAILQ_HEAD(, ccb_hdr) work_queue;
116 STAILQ_ENTRY(ctlfe_lun_softc) links;
120 CTLFE_CMD_NONE = 0x00,
121 CTLFE_CMD_PIECEWISE = 0x01
124 struct ctlfe_cmd_info {
125 int cur_transfer_index;
126 size_t cur_transfer_off;
127 ctlfe_cmd_flags flags;
129 * XXX KDM struct bus_dma_segment is 8 bytes on i386, and 16
130 * bytes on amd64. So with 32 elements, this is 256 bytes on
131 * i386 and 512 bytes on amd64.
133 #define CTLFE_MAX_SEGS 32
134 bus_dma_segment_t cam_sglist[CTLFE_MAX_SEGS];
138 * When we register the adapter/bus, request that this many ctl_ios be
139 * allocated. This should be the maximum supported by the adapter, but we
140 * currently don't have a way to get that back from the path inquiry.
141 * XXX KDM add that to the path inquiry.
143 #define CTLFE_REQ_CTL_IO 4096
145 * Number of Accept Target I/O CCBs to allocate and queue down to the
147 * XXX KDM should this be controlled by CTL?
149 #define CTLFE_ATIO_PER_LUN 1024
151 * Number of Immediate Notify CCBs (used for aborts, resets, etc.) to
152 * allocate and queue down to the adapter per LUN.
153 * XXX KDM should this be controlled by CTL?
155 #define CTLFE_IN_PER_LUN 1024
158 * Timeout (in seconds) on CTIO CCB allocation for doing a DMA or sending
159 * status to the initiator. The SIM is expected to have its own timeouts,
160 * so we're not putting this timeout around the CCB execution time. The
161 * SIM should timeout and let us know if it has an issue.
163 #define CTLFE_DMA_TIMEOUT 60
166 * Turn this on to enable extra debugging prints.
173 * Use randomly assigned WWNN/WWPN values. This is to work around an issue
174 * in the FreeBSD initiator that makes it unable to rescan the target if
175 * the target gets rebooted and the WWNN/WWPN stay the same.
181 MALLOC_DEFINE(M_CTLFE, "CAM CTL FE", "CAM CTL FE interface");
183 #define io_ptr ppriv_ptr0
185 /* This is only used in the CTIO */
186 #define ccb_atio ppriv_ptr1
188 #define PRIV_CCB(io) ((io)->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptrs[0])
189 #define PRIV_INFO(io) ((io)->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptrs[1])
191 int ctlfeinitialize(void);
192 void ctlfeshutdown(void);
193 static periph_init_t ctlfeperiphinit;
194 static void ctlfeasync(void *callback_arg, uint32_t code,
195 struct cam_path *path, void *arg);
196 static periph_ctor_t ctlferegister;
197 static periph_oninv_t ctlfeoninvalidate;
198 static periph_dtor_t ctlfecleanup;
199 static periph_start_t ctlfestart;
200 static void ctlfedone(struct cam_periph *periph,
201 union ccb *done_ccb);
203 static void ctlfe_onoffline(void *arg, int online);
204 static void ctlfe_online(void *arg);
205 static void ctlfe_offline(void *arg);
206 static int ctlfe_lun_enable(void *arg, int lun_id);
207 static int ctlfe_lun_disable(void *arg, int lun_id);
208 static void ctlfe_dump_sim(struct cam_sim *sim);
209 static void ctlfe_dump_queue(struct ctlfe_lun_softc *softc);
210 static void ctlfe_datamove(union ctl_io *io);
211 static void ctlfe_done(union ctl_io *io);
212 static void ctlfe_dump(void);
214 static struct periph_driver ctlfe_driver =
216 ctlfeperiphinit, "ctl",
217 TAILQ_HEAD_INITIALIZER(ctlfe_driver.units), /*generation*/ 0,
221 static struct ctl_frontend ctlfe_frontend =
224 .init = ctlfeinitialize,
225 .fe_dump = ctlfe_dump,
226 .shutdown = ctlfeshutdown,
228 CTL_FRONTEND_DECLARE(ctlfe, ctlfe_frontend);
237 ctlfeinitialize(void)
240 STAILQ_INIT(&ctlfe_softc_list);
241 mtx_init(&ctlfe_list_mtx, ctlfe_mtx_desc, NULL, MTX_DEF);
242 periphdriver_register(&ctlfe_driver);
247 ctlfeperiphinit(void)
251 status = xpt_register_async(AC_PATH_REGISTERED | AC_PATH_DEREGISTERED |
252 AC_CONTRACT, ctlfeasync, NULL, NULL);
253 if (status != CAM_REQ_CMP) {
254 printf("ctl: Failed to attach async callback due to CAM "
255 "status 0x%x!\n", status);
260 ctlfeasync(void *callback_arg, uint32_t code, struct cam_path *path, void *arg)
262 struct ctlfe_softc *softc;
265 printf("%s: entered\n", __func__);
268 mtx_lock(&ctlfe_list_mtx);
269 STAILQ_FOREACH(softc, &ctlfe_softc_list, links) {
270 if (softc->path_id == xpt_path_path_id(path))
273 mtx_unlock(&ctlfe_list_mtx);
276 * When a new path gets registered, and it is capable of target
277 * mode, go ahead and attach. Later on, we may need to be more
278 * selective, but for now this will be sufficient.
281 case AC_PATH_REGISTERED: {
282 struct ctl_port *port;
283 struct ccb_pathinq *cpi;
286 cpi = (struct ccb_pathinq *)arg;
288 /* Don't attach if it doesn't support target mode */
289 if ((cpi->target_sprt & PIT_PROCESSOR) == 0) {
291 printf("%s: SIM %s%d doesn't support target mode\n",
292 __func__, cpi->dev_name, cpi->unit_number);
299 printf("%s: CTL port for CAM path %u already exists\n",
300 __func__, xpt_path_path_id(path));
305 #ifdef CTLFE_INIT_ENABLE
306 if (ctlfe_num_targets >= ctlfe_max_targets) {
309 ccb = (union ccb *)malloc(sizeof(*ccb), M_TEMP,
312 printf("%s: unable to malloc CCB!\n", __func__);
315 xpt_setup_ccb(&ccb->ccb_h, path, CAM_PRIORITY_NONE);
317 ccb->ccb_h.func_code = XPT_SET_SIM_KNOB;
318 ccb->knob.xport_specific.valid = KNOB_VALID_ROLE;
319 ccb->knob.xport_specific.fc.role = KNOB_ROLE_INITIATOR;
323 if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
325 printf("%s: SIM %s%d (path id %d) initiator "
326 "enable failed with status %#x\n",
327 __func__, cpi->dev_name,
328 cpi->unit_number, cpi->ccb_h.path_id,
331 printf("%s: SIM %s%d (path id %d) initiator "
332 "enable succeeded\n",
333 __func__, cpi->dev_name,
334 cpi->unit_number, cpi->ccb_h.path_id);
344 printf("%s: ctlfe_num_targets = %d\n", __func__,
346 #endif /* CTLFE_INIT_ENABLE */
349 * We're in an interrupt context here, so we have to
350 * use M_NOWAIT. Of course this means trouble if we
351 * can't allocate memory.
353 softc = malloc(sizeof(*softc), M_CTLFE, M_NOWAIT | M_ZERO);
355 printf("%s: unable to malloc %zd bytes for softc\n",
356 __func__, sizeof(*softc));
360 softc->path_id = cpi->ccb_h.path_id;
361 softc->target_id = cpi->initiator_id;
362 softc->sim = xpt_path_sim(path);
363 softc->hba_misc = cpi->hba_misc;
365 softc->maxio = cpi->maxio;
367 softc->maxio = DFLTPHYS;
368 mtx_init(&softc->lun_softc_mtx, "LUN softc mtx", NULL, MTX_DEF);
369 STAILQ_INIT(&softc->lun_softc_list);
372 port->frontend = &ctlfe_frontend;
375 * XXX KDM should we be more accurate here ?
377 if (cpi->transport == XPORT_FC)
378 port->port_type = CTL_PORT_FC;
379 else if (cpi->transport == XPORT_SAS)
380 port->port_type = CTL_PORT_SAS;
382 port->port_type = CTL_PORT_SCSI;
384 /* XXX KDM what should the real number be here? */
385 port->num_requested_ctl_io = 4096;
386 snprintf(softc->port_name, sizeof(softc->port_name),
387 "%s%d", cpi->dev_name, cpi->unit_number);
389 * XXX KDM it would be nice to allocate storage in the
390 * frontend structure itself.
392 port->port_name = softc->port_name;
393 port->physical_port = cpi->bus_id;
394 port->virtual_port = 0;
395 port->port_online = ctlfe_online;
396 port->port_offline = ctlfe_offline;
397 port->onoff_arg = softc;
398 port->lun_enable = ctlfe_lun_enable;
399 port->lun_disable = ctlfe_lun_disable;
400 port->targ_lun_arg = softc;
401 port->fe_datamove = ctlfe_datamove;
402 port->fe_done = ctlfe_done;
404 * XXX KDM the path inquiry doesn't give us the maximum
405 * number of targets supported.
407 port->max_targets = cpi->max_target;
408 port->max_target_id = cpi->max_target;
409 port->targ_port = -1;
412 * XXX KDM need to figure out whether we're the master or
416 printf("%s: calling ctl_port_register() for %s%d\n",
417 __func__, cpi->dev_name, cpi->unit_number);
419 retval = ctl_port_register(port);
421 printf("%s: ctl_port_register() failed with "
422 "error %d!\n", __func__, retval);
423 mtx_destroy(&softc->lun_softc_mtx);
424 free(softc, M_CTLFE);
427 mtx_lock(&ctlfe_list_mtx);
428 STAILQ_INSERT_TAIL(&ctlfe_softc_list, softc, links);
429 mtx_unlock(&ctlfe_list_mtx);
434 case AC_PATH_DEREGISTERED: {
438 * XXX KDM are we certain at this point that there
439 * are no outstanding commands for this frontend?
441 mtx_lock(&ctlfe_list_mtx);
442 STAILQ_REMOVE(&ctlfe_softc_list, softc, ctlfe_softc,
444 mtx_unlock(&ctlfe_list_mtx);
445 ctl_port_deregister(&softc->port);
446 mtx_destroy(&softc->lun_softc_mtx);
447 free(softc, M_CTLFE);
452 struct ac_contract *ac;
454 ac = (struct ac_contract *)arg;
456 switch (ac->contract_number) {
457 case AC_CONTRACT_DEV_CHG: {
458 struct ac_device_changed *dev_chg;
461 dev_chg = (struct ac_device_changed *)ac->contract_data;
463 printf("%s: WWPN %#jx port 0x%06x path %u target %u %s\n",
464 __func__, dev_chg->wwpn, dev_chg->port,
465 xpt_path_path_id(path), dev_chg->target,
466 (dev_chg->arrived == 0) ? "left" : "arrived");
469 printf("%s: CTL port for CAM path %u not "
470 "found!\n", __func__,
471 xpt_path_path_id(path));
474 if (dev_chg->arrived != 0) {
475 retval = ctl_add_initiator(&softc->port,
476 dev_chg->target, dev_chg->wwpn, NULL);
478 retval = ctl_remove_initiator(&softc->port,
483 printf("%s: could not %s port %d iid %u "
484 "WWPN %#jx!\n", __func__,
485 (dev_chg->arrived != 0) ? "add" :
486 "remove", softc->port.targ_port,
488 (uintmax_t)dev_chg->wwpn);
493 printf("%s: unsupported contract number %ju\n",
494 __func__, (uintmax_t)ac->contract_number);
505 ctlferegister(struct cam_periph *periph, void *arg)
507 struct ctlfe_softc *bus_softc;
508 struct ctlfe_lun_softc *softc;
509 union ccb en_lun_ccb;
513 softc = (struct ctlfe_lun_softc *)arg;
514 bus_softc = softc->parent_softc;
516 TAILQ_INIT(&softc->work_queue);
517 softc->periph = periph;
518 periph->softc = softc;
520 xpt_setup_ccb(&en_lun_ccb.ccb_h, periph->path, CAM_PRIORITY_NONE);
521 en_lun_ccb.ccb_h.func_code = XPT_EN_LUN;
522 en_lun_ccb.cel.grp6_len = 0;
523 en_lun_ccb.cel.grp7_len = 0;
524 en_lun_ccb.cel.enable = 1;
525 xpt_action(&en_lun_ccb);
526 status = (en_lun_ccb.ccb_h.status & CAM_STATUS_MASK);
527 if (status != CAM_REQ_CMP) {
528 xpt_print(periph->path, "%s: Enable LUN failed, status 0x%x\n",
529 __func__, en_lun_ccb.ccb_h.status);
533 status = CAM_REQ_CMP;
535 for (i = 0; i < CTLFE_ATIO_PER_LUN; i++) {
537 union ctl_io *new_io;
538 struct ctlfe_cmd_info *cmd_info;
540 new_ccb = (union ccb *)malloc(sizeof(*new_ccb), M_CTLFE,
542 if (new_ccb == NULL) {
543 status = CAM_RESRC_UNAVAIL;
546 new_io = ctl_alloc_io_nowait(bus_softc->port.ctl_pool_ref);
547 if (new_io == NULL) {
548 free(new_ccb, M_CTLFE);
549 status = CAM_RESRC_UNAVAIL;
552 cmd_info = malloc(sizeof(*cmd_info), M_CTLFE,
554 if (cmd_info == NULL) {
556 free(new_ccb, M_CTLFE);
557 status = CAM_RESRC_UNAVAIL;
560 PRIV_INFO(new_io) = cmd_info;
561 softc->atios_alloced++;
562 new_ccb->ccb_h.io_ptr = new_io;
564 xpt_setup_ccb(&new_ccb->ccb_h, periph->path, /*priority*/ 1);
565 new_ccb->ccb_h.func_code = XPT_ACCEPT_TARGET_IO;
566 new_ccb->ccb_h.cbfcnp = ctlfedone;
567 new_ccb->ccb_h.flags |= CAM_UNLOCKED;
569 status = new_ccb->ccb_h.status;
570 if ((status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
571 free(cmd_info, M_CTLFE);
573 free(new_ccb, M_CTLFE);
578 status = cam_periph_acquire(periph);
579 if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
580 xpt_print(periph->path, "%s: could not acquire reference "
581 "count, status = %#x\n", __func__, status);
586 xpt_print(periph->path, "%s: could not allocate ATIO CCBs, "
587 "status 0x%x\n", __func__, status);
588 return (CAM_REQ_CMP_ERR);
591 for (i = 0; i < CTLFE_IN_PER_LUN; i++) {
593 union ctl_io *new_io;
595 new_ccb = (union ccb *)malloc(sizeof(*new_ccb), M_CTLFE,
597 if (new_ccb == NULL) {
598 status = CAM_RESRC_UNAVAIL;
601 new_io = ctl_alloc_io_nowait(bus_softc->port.ctl_pool_ref);
602 if (new_io == NULL) {
603 free(new_ccb, M_CTLFE);
604 status = CAM_RESRC_UNAVAIL;
607 softc->inots_alloced++;
608 new_ccb->ccb_h.io_ptr = new_io;
610 xpt_setup_ccb(&new_ccb->ccb_h, periph->path, /*priority*/ 1);
611 new_ccb->ccb_h.func_code = XPT_IMMEDIATE_NOTIFY;
612 new_ccb->ccb_h.cbfcnp = ctlfedone;
613 new_ccb->ccb_h.flags |= CAM_UNLOCKED;
615 status = new_ccb->ccb_h.status;
616 if ((status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
618 * Note that we don't free the CCB here. If the
619 * status is not CAM_REQ_INPROG, then we're
620 * probably talking to a SIM that says it is
621 * target-capable but doesn't support the
622 * XPT_IMMEDIATE_NOTIFY CCB. i.e. it supports the
623 * older API. In that case, it'll call xpt_done()
624 * on the CCB, and we need to free it in our done
625 * routine as a result.
631 || (status != CAM_REQ_INPROG)) {
632 xpt_print(periph->path, "%s: could not allocate immediate "
633 "notify CCBs, status 0x%x\n", __func__, status);
634 return (CAM_REQ_CMP_ERR);
636 mtx_lock(&bus_softc->lun_softc_mtx);
637 STAILQ_INSERT_TAIL(&bus_softc->lun_softc_list, softc, links);
638 mtx_unlock(&bus_softc->lun_softc_mtx);
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?
667 bus_softc = softc->parent_softc;
668 mtx_lock(&bus_softc->lun_softc_mtx);
669 STAILQ_REMOVE(&bus_softc->lun_softc_list, softc, ctlfe_lun_softc, links);
670 mtx_unlock(&bus_softc->lun_softc_mtx);
674 ctlfecleanup(struct cam_periph *periph)
676 struct ctlfe_lun_softc *softc;
678 softc = (struct ctlfe_lun_softc *)periph->softc;
680 KASSERT(softc->ccbs_freed == softc->ccbs_alloced, ("%s: "
681 "ccbs_freed %ju != ccbs_alloced %ju", __func__,
682 softc->ccbs_freed, softc->ccbs_alloced));
683 KASSERT(softc->ctios_returned == softc->ctios_sent, ("%s: "
684 "ctios_returned %ju != ctios_sent %ju", __func__,
685 softc->ctios_returned, softc->ctios_sent));
686 KASSERT(softc->atios_freed == softc->atios_alloced, ("%s: "
687 "atios_freed %ju != atios_alloced %ju", __func__,
688 softc->atios_freed, softc->atios_alloced));
689 KASSERT(softc->inots_freed == softc->inots_alloced, ("%s: "
690 "inots_freed %ju != inots_alloced %ju", __func__,
691 softc->inots_freed, softc->inots_alloced));
693 free(softc, M_CTLFE);
697 ctlfedata(struct ctlfe_lun_softc *softc, union ctl_io *io,
698 ccb_flags *flags, uint8_t **data_ptr, uint32_t *dxfer_len,
699 u_int16_t *sglist_cnt)
701 struct ctlfe_softc *bus_softc;
702 struct ctlfe_cmd_info *cmd_info;
703 struct ctl_sg_entry *ctl_sglist;
704 bus_dma_segment_t *cam_sglist;
708 cmd_info = PRIV_INFO(io);
709 bus_softc = softc->parent_softc;
712 * Set the direction, relative to the initiator.
714 *flags &= ~CAM_DIR_MASK;
715 if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN)
716 *flags |= CAM_DIR_IN;
718 *flags |= CAM_DIR_OUT;
720 *flags &= ~CAM_DATA_MASK;
721 idx = cmd_info->cur_transfer_index;
722 off = cmd_info->cur_transfer_off;
723 cmd_info->flags &= ~CTLFE_CMD_PIECEWISE;
724 if (io->scsiio.kern_sg_entries == 0) {
726 *data_ptr = io->scsiio.kern_data_ptr + off;
727 if (io->scsiio.kern_data_len - off <= bus_softc->maxio) {
728 *dxfer_len = io->scsiio.kern_data_len - off;
730 *dxfer_len = bus_softc->maxio;
731 cmd_info->cur_transfer_index = -1;
732 cmd_info->cur_transfer_off = bus_softc->maxio;
733 cmd_info->flags |= CTLFE_CMD_PIECEWISE;
737 if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR)
738 *flags |= CAM_DATA_PADDR;
740 *flags |= CAM_DATA_VADDR;
742 /* S/G list with physical or virtual pointers. */
743 ctl_sglist = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
744 cam_sglist = cmd_info->cam_sglist;
746 for (i = 0; i < io->scsiio.kern_sg_entries - idx; i++) {
747 cam_sglist[i].ds_addr = (bus_addr_t)ctl_sglist[i + idx].addr + off;
748 if (ctl_sglist[i + idx].len - off <= bus_softc->maxio - *dxfer_len) {
749 cam_sglist[i].ds_len = ctl_sglist[idx + i].len - off;
750 *dxfer_len += cam_sglist[i].ds_len;
752 cam_sglist[i].ds_len = bus_softc->maxio - *dxfer_len;
753 cmd_info->cur_transfer_index = idx + i;
754 cmd_info->cur_transfer_off = cam_sglist[i].ds_len + off;
755 cmd_info->flags |= CTLFE_CMD_PIECEWISE;
756 *dxfer_len += cam_sglist[i].ds_len;
757 if (ctl_sglist[i].len != 0)
761 if (i == (CTLFE_MAX_SEGS - 1) &&
762 idx + i < (io->scsiio.kern_sg_entries - 1)) {
763 cmd_info->cur_transfer_index = idx + i + 1;
764 cmd_info->cur_transfer_off = 0;
765 cmd_info->flags |= CTLFE_CMD_PIECEWISE;
772 if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR)
773 *flags |= CAM_DATA_SG_PADDR;
775 *flags |= CAM_DATA_SG;
776 *data_ptr = (uint8_t *)cam_sglist;
781 ctlfestart(struct cam_periph *periph, union ccb *start_ccb)
783 struct ctlfe_lun_softc *softc;
784 struct ctlfe_cmd_info *cmd_info;
785 struct ccb_hdr *ccb_h;
786 struct ccb_accept_tio *atio;
787 struct ccb_scsiio *csio;
794 softc = (struct ctlfe_lun_softc *)periph->softc;
795 softc->ccbs_alloced++;
797 ccb_h = TAILQ_FIRST(&softc->work_queue);
800 xpt_release_ccb(start_ccb);
804 /* Take the ATIO off the work queue */
805 TAILQ_REMOVE(&softc->work_queue, ccb_h, periph_links.tqe);
806 atio = (struct ccb_accept_tio *)ccb_h;
807 io = (union ctl_io *)ccb_h->io_ptr;
808 csio = &start_ccb->csio;
810 flags = atio->ccb_h.flags &
811 (CAM_DIS_DISCONNECT|CAM_TAG_ACTION_VALID|CAM_DIR_MASK);
812 cmd_info = PRIV_INFO(io);
813 cmd_info->cur_transfer_index = 0;
814 cmd_info->cur_transfer_off = 0;
817 if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED) {
819 * Datamove call, we need to setup the S/G list.
822 csio->cdb_len = atio->cdb_len;
823 ctlfedata(softc, io, &flags, &data_ptr, &dxfer_len,
825 io->scsiio.ext_data_filled += dxfer_len;
826 if (io->scsiio.ext_data_filled > io->scsiio.kern_total_len) {
827 xpt_print(periph->path, "%s: tag 0x%04x "
828 "fill len %u > total %u\n",
829 __func__, io->scsiio.tag_num,
830 io->scsiio.ext_data_filled,
831 io->scsiio.kern_total_len);
835 * We're done, send status back.
837 if ((io->io_hdr.flags & CTL_FLAG_ABORT) &&
838 (io->io_hdr.flags & CTL_FLAG_ABORT_STATUS) == 0) {
839 io->io_hdr.flags &= ~CTL_FLAG_STATUS_QUEUED;
842 * If this command was aborted, we don't
843 * need to send status back to the SIM.
844 * Just free the CTIO and ctl_io, and
845 * recycle the ATIO back to the SIM.
847 xpt_print(periph->path, "%s: aborted "
848 "command 0x%04x discarded\n",
849 __func__, io->scsiio.tag_num);
851 * For a wildcard attachment, commands can
852 * come in with a specific target/lun. Reset
853 * the target and LUN fields back to the
854 * wildcard values before we send them back
855 * down to the SIM. The SIM has a wildcard
856 * LUN enabled, not whatever target/lun
857 * these happened to be.
859 if (softc->flags & CTLFE_LUN_WILDCARD) {
860 atio->ccb_h.target_id = CAM_TARGET_WILDCARD;
861 atio->ccb_h.target_lun = CAM_LUN_WILDCARD;
864 if (atio->ccb_h.func_code != XPT_ACCEPT_TARGET_IO) {
865 xpt_print(periph->path, "%s: func_code "
866 "is %#x\n", __func__,
867 atio->ccb_h.func_code);
869 start_ccb->ccb_h.func_code = XPT_ABORT;
870 start_ccb->cab.abort_ccb = (union ccb *)atio;
872 /* Tell the SIM that we've aborted this ATIO */
873 xpt_action(start_ccb);
875 xpt_release_ccb(start_ccb);
878 * Send the ATIO back down to the SIM.
880 xpt_action((union ccb *)atio);
883 * If we still have work to do, ask for
884 * another CCB. Otherwise, deactivate our
887 if (!TAILQ_EMPTY(&softc->work_queue))
888 xpt_schedule(periph, /*priority*/ 1);
893 csio->sglist_cnt = 0;
896 if ((io->io_hdr.flags & CTL_FLAG_STATUS_QUEUED) &&
897 (cmd_info->flags & CTLFE_CMD_PIECEWISE) == 0 &&
898 ((io->io_hdr.flags & CTL_FLAG_DMA_QUEUED) == 0 ||
899 io->io_hdr.status == CTL_SUCCESS)) {
900 flags |= CAM_SEND_STATUS;
901 scsi_status = io->scsiio.scsi_status;
902 csio->sense_len = io->scsiio.sense_len;
904 printf("%s: tag %04x status %x\n", __func__,
905 atio->tag_id, io->io_hdr.status);
907 if (csio->sense_len != 0) {
908 csio->sense_data = io->scsiio.sense_data;
909 flags |= CAM_SEND_SENSE;
910 } else if (scsi_status == SCSI_STATUS_CHECK_COND) {
911 xpt_print(periph->path, "%s: check condition "
912 "with no sense\n", __func__);
917 printf("%s: %s: tag %04x flags %x ptr %p len %u\n", __func__,
918 (flags & CAM_SEND_STATUS) ? "done" : "datamove",
919 atio->tag_id, flags, data_ptr, dxfer_len);
923 * Valid combinations:
924 * - CAM_SEND_STATUS, CAM_DATA_SG = 0, dxfer_len = 0,
926 * - CAM_SEND_STATUS = 0, CAM_DATA_SG = 0, dxfer_len != 0,
928 * - CAM_SEND_STATUS = 0, CAM_DATA_SG, dxfer_len != 0,
932 if (((flags & CAM_SEND_STATUS)
933 && (((flags & CAM_DATA_SG) != 0)
935 || (csio->sglist_cnt != 0)))
936 || (((flags & CAM_SEND_STATUS) == 0)
938 || ((flags & CAM_DATA_SG)
939 && (csio->sglist_cnt == 0))
940 || (((flags & CAM_DATA_SG) == 0)
941 && (csio->sglist_cnt != 0))) {
942 printf("%s: tag %04x cdb %02x flags %#x dxfer_len "
943 "%d sg %u\n", __func__, atio->tag_id,
944 atio_cdb_ptr(atio)[0], flags, dxfer_len,
946 printf("%s: tag %04x io status %#x\n", __func__,
947 atio->tag_id, io->io_hdr.status);
954 (flags & CAM_TAG_ACTION_VALID) ? MSG_SIMPLE_Q_TAG : 0,
958 /*data_ptr*/ data_ptr,
959 /*dxfer_len*/ dxfer_len,
960 /*timeout*/ 5 * 1000);
961 start_ccb->ccb_h.flags |= CAM_UNLOCKED;
962 start_ccb->ccb_h.ccb_atio = atio;
963 if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED)
964 io->io_hdr.flags |= CTL_FLAG_DMA_INPROG;
965 io->io_hdr.flags &= ~(CTL_FLAG_DMA_QUEUED | CTL_FLAG_STATUS_QUEUED);
969 cam_periph_unlock(periph);
970 xpt_action(start_ccb);
971 cam_periph_lock(periph);
974 * If we still have work to do, ask for another CCB.
976 if (!TAILQ_EMPTY(&softc->work_queue))
977 xpt_schedule(periph, /*priority*/ 1);
981 ctlfe_free_ccb(struct cam_periph *periph, union ccb *ccb)
983 struct ctlfe_lun_softc *softc;
985 struct ctlfe_cmd_info *cmd_info;
987 softc = (struct ctlfe_lun_softc *)periph->softc;
988 io = ccb->ccb_h.io_ptr;
990 switch (ccb->ccb_h.func_code) {
991 case XPT_ACCEPT_TARGET_IO:
992 softc->atios_freed++;
993 cmd_info = PRIV_INFO(io);
994 free(cmd_info, M_CTLFE);
996 case XPT_IMMEDIATE_NOTIFY:
997 case XPT_NOTIFY_ACKNOWLEDGE:
998 softc->inots_freed++;
1007 KASSERT(softc->atios_freed <= softc->atios_alloced, ("%s: "
1008 "atios_freed %ju > atios_alloced %ju", __func__,
1009 softc->atios_freed, softc->atios_alloced));
1010 KASSERT(softc->inots_freed <= softc->inots_alloced, ("%s: "
1011 "inots_freed %ju > inots_alloced %ju", __func__,
1012 softc->inots_freed, softc->inots_alloced));
1015 * If we have received all of our CCBs, we can release our
1016 * reference on the peripheral driver. It will probably go away
1019 if ((softc->atios_freed == softc->atios_alloced)
1020 && (softc->inots_freed == softc->inots_alloced)) {
1021 cam_periph_release_locked(periph);
1026 ctlfe_adjust_cdb(struct ccb_accept_tio *atio, uint32_t offset)
1029 uint32_t num_blocks, nbc;
1030 uint8_t *cmdbyt = atio_cdb_ptr(atio);
1032 nbc = offset >> 9; /* ASSUMING 512 BYTE BLOCKS */
1034 switch (cmdbyt[0]) {
1038 struct scsi_rw_6 *cdb = (struct scsi_rw_6 *)cmdbyt;
1039 lba = scsi_3btoul(cdb->addr);
1041 num_blocks = cdb->length;
1042 if (num_blocks == 0)
1046 scsi_ulto3b(lba, cdb->addr);
1047 cdb->length = num_blocks;
1053 struct scsi_rw_10 *cdb = (struct scsi_rw_10 *)cmdbyt;
1054 lba = scsi_4btoul(cdb->addr);
1055 num_blocks = scsi_2btoul(cdb->length);
1058 scsi_ulto4b(lba, cdb->addr);
1059 scsi_ulto2b(num_blocks, cdb->length);
1065 struct scsi_rw_12 *cdb = (struct scsi_rw_12 *)cmdbyt;
1066 lba = scsi_4btoul(cdb->addr);
1067 num_blocks = scsi_4btoul(cdb->length);
1070 scsi_ulto4b(lba, cdb->addr);
1071 scsi_ulto4b(num_blocks, cdb->length);
1077 struct scsi_rw_16 *cdb = (struct scsi_rw_16 *)cmdbyt;
1078 lba = scsi_8btou64(cdb->addr);
1079 num_blocks = scsi_4btoul(cdb->length);
1082 scsi_u64to8b(lba, cdb->addr);
1083 scsi_ulto4b(num_blocks, cdb->length);
1093 ctlfedone(struct cam_periph *periph, union ccb *done_ccb)
1095 struct ctlfe_lun_softc *softc;
1096 struct ctlfe_softc *bus_softc;
1097 struct ctlfe_cmd_info *cmd_info;
1098 struct ccb_accept_tio *atio = NULL;
1099 union ctl_io *io = NULL;
1102 KASSERT((done_ccb->ccb_h.flags & CAM_UNLOCKED) != 0,
1103 ("CCB in ctlfedone() without CAM_UNLOCKED flag"));
1105 printf("%s: entered, func_code = %#x\n", __func__,
1106 done_ccb->ccb_h.func_code);
1110 * At this point CTL has no known use case for device queue freezes.
1111 * In case some SIM think different -- drop its freeze right here.
1113 if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1114 cam_release_devq(periph->path,
1118 /*getcount_only*/0);
1119 done_ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1122 softc = (struct ctlfe_lun_softc *)periph->softc;
1123 bus_softc = softc->parent_softc;
1124 mtx = cam_periph_mtx(periph);
1128 * If the peripheral is invalid, ATIOs and immediate notify CCBs
1129 * need to be freed. Most of the ATIOs and INOTs that come back
1130 * will be CCBs that are being returned from the SIM as a result of
1131 * our disabling the LUN.
1133 * Other CCB types are handled in their respective cases below.
1135 if (periph->flags & CAM_PERIPH_INVALID) {
1136 switch (done_ccb->ccb_h.func_code) {
1137 case XPT_ACCEPT_TARGET_IO:
1138 case XPT_IMMEDIATE_NOTIFY:
1139 case XPT_NOTIFY_ACKNOWLEDGE:
1140 ctlfe_free_ccb(periph, done_ccb);
1147 switch (done_ccb->ccb_h.func_code) {
1148 case XPT_ACCEPT_TARGET_IO: {
1150 atio = &done_ccb->atio;
1154 * Allocate a ctl_io, pass it to CTL, and wait for the
1158 io = done_ccb->ccb_h.io_ptr;
1159 cmd_info = PRIV_INFO(io);
1162 /* Save pointers on both sides */
1163 PRIV_CCB(io) = done_ccb;
1164 PRIV_INFO(io) = cmd_info;
1165 done_ccb->ccb_h.io_ptr = io;
1168 * Only SCSI I/O comes down this path, resets, etc. come
1169 * down the immediate notify path below.
1171 io->io_hdr.io_type = CTL_IO_SCSI;
1172 io->io_hdr.nexus.initid = atio->init_id;
1173 io->io_hdr.nexus.targ_port = bus_softc->port.targ_port;
1174 if (bus_softc->hba_misc & PIM_EXTLUNS) {
1175 io->io_hdr.nexus.targ_lun = ctl_decode_lun(
1176 CAM_EXTLUN_BYTE_SWIZZLE(atio->ccb_h.target_lun));
1178 io->io_hdr.nexus.targ_lun = atio->ccb_h.target_lun;
1180 io->scsiio.tag_num = atio->tag_id;
1181 switch (atio->tag_action) {
1182 case CAM_TAG_ACTION_NONE:
1183 io->scsiio.tag_type = CTL_TAG_UNTAGGED;
1185 case MSG_SIMPLE_TASK:
1186 io->scsiio.tag_type = CTL_TAG_SIMPLE;
1188 case MSG_HEAD_OF_QUEUE_TASK:
1189 io->scsiio.tag_type = CTL_TAG_HEAD_OF_QUEUE;
1191 case MSG_ORDERED_TASK:
1192 io->scsiio.tag_type = CTL_TAG_ORDERED;
1195 io->scsiio.tag_type = CTL_TAG_ACA;
1198 io->scsiio.tag_type = CTL_TAG_UNTAGGED;
1199 printf("%s: unhandled tag type %#x!!\n", __func__,
1203 if (atio->cdb_len > sizeof(io->scsiio.cdb)) {
1204 printf("%s: WARNING: CDB len %d > ctl_io space %zd\n",
1205 __func__, atio->cdb_len, sizeof(io->scsiio.cdb));
1207 io->scsiio.cdb_len = min(atio->cdb_len, sizeof(io->scsiio.cdb));
1208 bcopy(atio_cdb_ptr(atio), io->scsiio.cdb, io->scsiio.cdb_len);
1211 printf("%s: %u:%u:%u: tag %04x CDB %02x\n", __func__,
1212 io->io_hdr.nexus.initid,
1213 io->io_hdr.nexus.targ_port,
1214 io->io_hdr.nexus.targ_lun,
1215 io->scsiio.tag_num, io->scsiio.cdb[0]);
1221 case XPT_CONT_TARGET_IO: {
1223 uint32_t srr_off = 0;
1225 atio = (struct ccb_accept_tio *)done_ccb->ccb_h.ccb_atio;
1226 io = (union ctl_io *)atio->ccb_h.io_ptr;
1228 softc->ctios_returned++;
1230 printf("%s: got XPT_CONT_TARGET_IO tag %#x flags %#x\n",
1231 __func__, atio->tag_id, done_ccb->ccb_h.flags);
1234 * Handle SRR case were the data pointer is pushed back hack
1236 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_MESSAGE_RECV
1237 && done_ccb->csio.msg_ptr != NULL
1238 && done_ccb->csio.msg_ptr[0] == MSG_EXTENDED
1239 && done_ccb->csio.msg_ptr[1] == 5
1240 && done_ccb->csio.msg_ptr[2] == 0) {
1243 (done_ccb->csio.msg_ptr[3] << 24)
1244 | (done_ccb->csio.msg_ptr[4] << 16)
1245 | (done_ccb->csio.msg_ptr[5] << 8)
1246 | (done_ccb->csio.msg_ptr[6]);
1249 if (srr && (io->io_hdr.flags & CTL_FLAG_DMA_INPROG) == 0) {
1251 * If status was being sent, the back end data is now
1252 * history. Hack it up and resubmit a new command with
1253 * the CDB adjusted. If the SIM does the right thing,
1254 * all of the resid math should work.
1256 softc->ccbs_freed++;
1257 xpt_release_ccb(done_ccb);
1258 if (ctlfe_adjust_cdb(atio, srr_off) == 0) {
1259 done_ccb = (union ccb *)atio;
1263 * Fall through to doom....
1267 * If we have an srr and we're still sending data, we
1268 * should be able to adjust offsets and cycle again.
1270 io->scsiio.kern_rel_offset =
1271 io->scsiio.ext_data_filled = srr_off;
1272 io->scsiio.ext_data_len = io->scsiio.kern_total_len -
1273 io->scsiio.kern_rel_offset;
1274 softc->ccbs_freed++;
1275 io->scsiio.io_hdr.status = CTL_STATUS_NONE;
1276 xpt_release_ccb(done_ccb);
1277 TAILQ_INSERT_HEAD(&softc->work_queue, &atio->ccb_h,
1279 xpt_schedule(periph, /*priority*/ 1);
1283 if ((done_ccb->ccb_h.flags & CAM_SEND_STATUS) &&
1284 (done_ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP)
1285 io->io_hdr.flags |= CTL_FLAG_STATUS_SENT;
1288 * If we were sending status back to the initiator, free up
1289 * resources. If we were doing a datamove, call the
1290 * datamove done routine.
1292 if ((io->io_hdr.flags & CTL_FLAG_DMA_INPROG) == 0) {
1293 softc->ccbs_freed++;
1294 xpt_release_ccb(done_ccb);
1296 * For a wildcard attachment, commands can come in
1297 * with a specific target/lun. Reset the target
1298 * and LUN fields back to the wildcard values before
1299 * we send them back down to the SIM. The SIM has
1300 * a wildcard LUN enabled, not whatever target/lun
1301 * these happened to be.
1303 if (softc->flags & CTLFE_LUN_WILDCARD) {
1304 atio->ccb_h.target_id = CAM_TARGET_WILDCARD;
1305 atio->ccb_h.target_lun = CAM_LUN_WILDCARD;
1307 if (periph->flags & CAM_PERIPH_INVALID) {
1308 ctlfe_free_ccb(periph, (union ccb *)atio);
1311 xpt_action((union ccb *)atio);
1315 struct ctlfe_cmd_info *cmd_info;
1316 struct ccb_scsiio *csio;
1318 csio = &done_ccb->csio;
1319 cmd_info = PRIV_INFO(io);
1321 io->io_hdr.flags &= ~CTL_FLAG_DMA_INPROG;
1323 io->scsiio.ext_data_len += csio->dxfer_len;
1324 if (io->scsiio.ext_data_len >
1325 io->scsiio.kern_total_len) {
1326 xpt_print(periph->path, "%s: tag 0x%04x "
1327 "done len %u > total %u sent %u\n",
1328 __func__, io->scsiio.tag_num,
1329 io->scsiio.ext_data_len,
1330 io->scsiio.kern_total_len,
1331 io->scsiio.ext_data_filled);
1334 * Translate CAM status to CTL status. Success
1335 * does not change the overall, ctl_io status. In
1336 * that case we just set port_status to 0. If we
1337 * have a failure, though, set a data phase error
1338 * for the overall ctl_io.
1340 switch (done_ccb->ccb_h.status & CAM_STATUS_MASK) {
1342 io->io_hdr.port_status = 0;
1346 * XXX KDM we probably need to figure out a
1347 * standard set of errors that the SIM
1348 * drivers should return in the event of a
1349 * data transfer failure. A data phase
1350 * error will at least point the user to a
1351 * data transfer error of some sort.
1352 * Hopefully the SIM printed out some
1353 * additional information to give the user
1354 * a clue what happened.
1356 io->io_hdr.port_status = 0xbad1;
1357 ctl_set_data_phase_error(&io->scsiio);
1359 * XXX KDM figure out residual.
1364 * If we had to break this S/G list into multiple
1365 * pieces, figure out where we are in the list, and
1366 * continue sending pieces if necessary.
1368 if ((cmd_info->flags & CTLFE_CMD_PIECEWISE)
1369 && (io->io_hdr.port_status == 0)) {
1371 uint8_t scsi_status;
1375 flags = atio->ccb_h.flags &
1376 (CAM_DIS_DISCONNECT|
1377 CAM_TAG_ACTION_VALID);
1379 ctlfedata(softc, io, &flags, &data_ptr,
1380 &dxfer_len, &csio->sglist_cnt);
1384 if (((flags & CAM_SEND_STATUS) == 0)
1385 && (dxfer_len == 0)) {
1386 printf("%s: tag %04x no status or "
1387 "len cdb = %02x\n", __func__,
1389 atio_cdb_ptr(atio)[0]);
1390 printf("%s: tag %04x io status %#x\n",
1391 __func__, atio->tag_id,
1399 (flags & CAM_TAG_ACTION_VALID) ?
1400 MSG_SIMPLE_Q_TAG : 0,
1404 /*data_ptr*/ data_ptr,
1405 /*dxfer_len*/ dxfer_len,
1406 /*timeout*/ 5 * 1000);
1408 csio->ccb_h.flags |= CAM_UNLOCKED;
1410 csio->ccb_h.ccb_atio = atio;
1411 io->io_hdr.flags |= CTL_FLAG_DMA_INPROG;
1412 softc->ctios_sent++;
1414 xpt_action((union ccb *)csio);
1417 * Release the CTIO. The ATIO will be sent back
1418 * down to the SIM once we send status.
1420 softc->ccbs_freed++;
1421 xpt_release_ccb(done_ccb);
1424 /* Call the backend move done callback */
1425 io->scsiio.be_move_done(io);
1431 case XPT_IMMEDIATE_NOTIFY: {
1433 struct ccb_immediate_notify *inot;
1437 inot = &done_ccb->cin1;
1438 printf("%s: got XPT_IMMEDIATE_NOTIFY status %#x tag %#x "
1439 "seq %#x\n", __func__, inot->ccb_h.status,
1440 inot->tag_id, inot->seq_id);
1442 io = done_ccb->ccb_h.io_ptr;
1447 io->io_hdr.io_type = CTL_IO_TASK;
1448 PRIV_CCB(io) = done_ccb;
1449 inot->ccb_h.io_ptr = io;
1450 io->io_hdr.nexus.initid = inot->initiator_id;
1451 io->io_hdr.nexus.targ_port = bus_softc->port.targ_port;
1452 if (bus_softc->hba_misc & PIM_EXTLUNS) {
1453 io->io_hdr.nexus.targ_lun = ctl_decode_lun(
1454 CAM_EXTLUN_BYTE_SWIZZLE(inot->ccb_h.target_lun));
1456 io->io_hdr.nexus.targ_lun = inot->ccb_h.target_lun;
1458 /* XXX KDM should this be the tag_id? */
1459 io->taskio.tag_num = inot->seq_id;
1461 status = inot->ccb_h.status & CAM_STATUS_MASK;
1463 case CAM_SCSI_BUS_RESET:
1464 io->taskio.task_action = CTL_TASK_BUS_RESET;
1467 io->taskio.task_action = CTL_TASK_TARGET_RESET;
1469 case CAM_MESSAGE_RECV:
1470 switch (inot->arg) {
1471 case MSG_ABORT_TASK_SET:
1472 io->taskio.task_action =
1473 CTL_TASK_ABORT_TASK_SET;
1475 case MSG_TARGET_RESET:
1476 io->taskio.task_action = CTL_TASK_TARGET_RESET;
1478 case MSG_ABORT_TASK:
1479 io->taskio.task_action = CTL_TASK_ABORT_TASK;
1481 case MSG_LOGICAL_UNIT_RESET:
1482 io->taskio.task_action = CTL_TASK_LUN_RESET;
1484 case MSG_CLEAR_TASK_SET:
1485 io->taskio.task_action =
1486 CTL_TASK_CLEAR_TASK_SET;
1489 io->taskio.task_action = CTL_TASK_CLEAR_ACA;
1491 case MSG_QUERY_TASK:
1492 io->taskio.task_action = CTL_TASK_QUERY_TASK;
1494 case MSG_QUERY_TASK_SET:
1495 io->taskio.task_action =
1496 CTL_TASK_QUERY_TASK_SET;
1498 case MSG_QUERY_ASYNC_EVENT:
1499 io->taskio.task_action =
1500 CTL_TASK_QUERY_ASYNC_EVENT;
1506 xpt_print(periph->path,
1507 "%s: unsupported message 0x%x\n",
1508 __func__, inot->arg);
1513 case CAM_REQ_ABORTED:
1515 * This request was sent back by the driver.
1516 * XXX KDM what do we do here?
1520 case CAM_REQ_INVALID:
1521 case CAM_PROVIDE_FAIL:
1524 * We should only get here if we're talking
1525 * to a talking to a SIM that is target
1526 * capable but supports the old API. In
1527 * that case, we need to just free the CCB.
1528 * If we actually send a notify acknowledge,
1529 * it will send that back with an error as
1533 if ((status != CAM_REQ_INVALID)
1534 && (status != CAM_PROVIDE_FAIL))
1535 xpt_print(periph->path,
1536 "%s: unsupported CAM status 0x%x\n",
1539 ctlfe_free_ccb(periph, done_ccb);
1543 if (send_ctl_io != 0) {
1546 done_ccb->ccb_h.status = CAM_REQ_INPROG;
1547 done_ccb->ccb_h.func_code = XPT_NOTIFY_ACKNOWLEDGE;
1548 xpt_action(done_ccb);
1552 case XPT_NOTIFY_ACKNOWLEDGE:
1554 * Queue this back down to the SIM as an immediate notify.
1556 done_ccb->ccb_h.status = CAM_REQ_INPROG;
1557 done_ccb->ccb_h.func_code = XPT_IMMEDIATE_NOTIFY;
1558 xpt_action(done_ccb);
1560 case XPT_SET_SIM_KNOB:
1561 case XPT_GET_SIM_KNOB:
1564 panic("%s: unexpected CCB type %#x", __func__,
1565 done_ccb->ccb_h.func_code);
1574 ctlfe_onoffline(void *arg, int online)
1576 struct ctlfe_softc *bus_softc;
1579 struct cam_path *path;
1582 bus_softc = (struct ctlfe_softc *)arg;
1586 status = xpt_create_path(&path, /*periph*/ NULL, bus_softc->path_id,
1587 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
1588 if (status != CAM_REQ_CMP) {
1589 printf("%s: unable to create path!\n", __func__);
1592 ccb = xpt_alloc_ccb();
1593 xpt_setup_ccb(&ccb->ccb_h, path, CAM_PRIORITY_NONE);
1594 ccb->ccb_h.func_code = XPT_GET_SIM_KNOB;
1600 * Bits 63-60: 0x5 NAA, IEEE registered name
1601 * Bits 59-36: 0x000ED5 IEEE Company name assigned to Copan
1602 * Bits 35-12: Copan SSN (Sequential Serial Number)
1603 * Bits 11-8: Type of port:
1607 * Bits 7-0: 0 == Node Name, >0 == Port Number
1610 if ((ccb->knob.xport_specific.valid & KNOB_VALID_ADDRESS) != 0){
1612 uint64_t random_bits;
1615 printf("%s: %s current WWNN %#jx\n", __func__,
1616 bus_softc->port_name,
1617 ccb->knob.xport_specific.fc.wwnn);
1618 printf("%s: %s current WWPN %#jx\n", __func__,
1619 bus_softc->port_name,
1620 ccb->knob.xport_specific.fc.wwpn);
1623 arc4rand(&random_bits, sizeof(random_bits), 0);
1627 * XXX KDM this is a bit of a kludge for now. We
1628 * take the current WWNN/WWPN from the card, and
1629 * replace the company identifier and the NL-Port
1630 * indicator and the port number (for the WWPN).
1631 * This should be replaced later with ddb_GetWWNN,
1632 * or possibly a more centralized scheme. (It
1633 * would be nice to have the WWNN/WWPN for each
1634 * port stored in the ctl_port structure.)
1637 ccb->knob.xport_specific.fc.wwnn =
1639 0x0000000fffffff00ULL) |
1640 /* Company ID */ 0x5000ED5000000000ULL |
1641 /* NL-Port */ 0x0300;
1642 ccb->knob.xport_specific.fc.wwpn =
1644 0x0000000fffffff00ULL) |
1645 /* Company ID */ 0x5000ED5000000000ULL |
1646 /* NL-Port */ 0x3000 |
1647 /* Port Num */ (bus_softc->port.targ_port & 0xff);
1650 * This is a bit of an API break/reversal, but if
1651 * we're doing the random WWNN that's a little
1652 * different anyway. So record what we're actually
1653 * using with the frontend code so it's reported
1656 ctl_port_set_wwns(&bus_softc->port,
1657 true, ccb->knob.xport_specific.fc.wwnn,
1658 true, ccb->knob.xport_specific.fc.wwpn);
1660 #else /* RANDOM_WWNN */
1662 * If the user has specified a WWNN/WWPN, send them
1663 * down to the SIM. Otherwise, record what the SIM
1666 if (bus_softc->port.wwnn != 0 && bus_softc->port.wwnn
1667 != ccb->knob.xport_specific.fc.wwnn) {
1668 ccb->knob.xport_specific.fc.wwnn =
1669 bus_softc->port.wwnn;
1672 ctl_port_set_wwns(&bus_softc->port,
1673 true, ccb->knob.xport_specific.fc.wwnn,
1676 if (bus_softc->port.wwpn != 0 && bus_softc->port.wwpn
1677 != ccb->knob.xport_specific.fc.wwpn) {
1678 ccb->knob.xport_specific.fc.wwpn =
1679 bus_softc->port.wwpn;
1682 ctl_port_set_wwns(&bus_softc->port,
1684 true, ccb->knob.xport_specific.fc.wwpn);
1686 #endif /* RANDOM_WWNN */
1689 if (set_wwnn != 0) {
1690 printf("%s: %s new WWNN %#jx\n", __func__,
1691 bus_softc->port_name,
1692 ccb->knob.xport_specific.fc.wwnn);
1693 printf("%s: %s new WWPN %#jx\n", __func__,
1694 bus_softc->port_name,
1695 ccb->knob.xport_specific.fc.wwpn);
1698 printf("%s: %s has no valid WWNN/WWPN\n", __func__,
1699 bus_softc->port_name);
1702 ccb->ccb_h.func_code = XPT_SET_SIM_KNOB;
1703 ccb->knob.xport_specific.valid = KNOB_VALID_ROLE;
1705 ccb->knob.xport_specific.valid |= KNOB_VALID_ADDRESS;
1708 ccb->knob.xport_specific.fc.role |= KNOB_ROLE_TARGET;
1710 ccb->knob.xport_specific.fc.role &= ~KNOB_ROLE_TARGET;
1714 if ((ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1715 printf("%s: SIM %s (path id %d) target %s failed with "
1717 __func__, bus_softc->port_name, bus_softc->path_id,
1718 (online != 0) ? "enable" : "disable",
1721 printf("%s: SIM %s (path id %d) target %s succeeded\n",
1722 __func__, bus_softc->port_name, bus_softc->path_id,
1723 (online != 0) ? "enable" : "disable");
1726 xpt_free_path(path);
1731 ctlfe_online(void *arg)
1733 struct ctlfe_softc *bus_softc;
1734 struct cam_path *path;
1736 struct ctlfe_lun_softc *lun_softc;
1737 struct cam_periph *periph;
1739 bus_softc = (struct ctlfe_softc *)arg;
1742 * Create the wildcard LUN before bringing the port online.
1744 status = xpt_create_path(&path, /*periph*/ NULL,
1745 bus_softc->path_id, CAM_TARGET_WILDCARD,
1747 if (status != CAM_REQ_CMP) {
1748 printf("%s: unable to create path for wildcard periph\n",
1753 lun_softc = malloc(sizeof(*lun_softc), M_CTLFE, M_WAITOK | M_ZERO);
1755 xpt_path_lock(path);
1756 periph = cam_periph_find(path, "ctl");
1757 if (periph != NULL) {
1758 /* We've already got a periph, no need to alloc a new one. */
1759 xpt_path_unlock(path);
1760 xpt_free_path(path);
1761 free(lun_softc, M_CTLFE);
1764 lun_softc->parent_softc = bus_softc;
1765 lun_softc->flags |= CTLFE_LUN_WILDCARD;
1767 status = cam_periph_alloc(ctlferegister,
1778 if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1779 const struct cam_status_entry *entry;
1781 entry = cam_fetch_status_entry(status);
1782 printf("%s: CAM error %s (%#x) returned from "
1783 "cam_periph_alloc()\n", __func__, (entry != NULL) ?
1784 entry->status_text : "Unknown", status);
1785 free(lun_softc, M_CTLFE);
1788 xpt_path_unlock(path);
1789 ctlfe_onoffline(arg, /*online*/ 1);
1790 xpt_free_path(path);
1794 ctlfe_offline(void *arg)
1796 struct ctlfe_softc *bus_softc;
1797 struct cam_path *path;
1799 struct cam_periph *periph;
1801 bus_softc = (struct ctlfe_softc *)arg;
1803 ctlfe_onoffline(arg, /*online*/ 0);
1806 * Disable the wildcard LUN for this port now that we have taken
1809 status = xpt_create_path(&path, /*periph*/ NULL,
1810 bus_softc->path_id, CAM_TARGET_WILDCARD,
1812 if (status != CAM_REQ_CMP) {
1813 printf("%s: unable to create path for wildcard periph\n",
1817 xpt_path_lock(path);
1818 if ((periph = cam_periph_find(path, "ctl")) != NULL)
1819 cam_periph_invalidate(periph);
1820 xpt_path_unlock(path);
1821 xpt_free_path(path);
1825 * This will get called to enable a LUN on every bus that is attached to
1826 * CTL. So we only need to create a path/periph for this particular bus.
1829 ctlfe_lun_enable(void *arg, int lun_id)
1831 struct ctlfe_softc *bus_softc;
1832 struct ctlfe_lun_softc *softc;
1833 struct cam_path *path;
1834 struct cam_periph *periph;
1837 bus_softc = (struct ctlfe_softc *)arg;
1838 if (bus_softc->hba_misc & PIM_EXTLUNS)
1839 lun_id = CAM_EXTLUN_BYTE_SWIZZLE(ctl_encode_lun(lun_id));
1841 status = xpt_create_path(&path, /*periph*/ NULL,
1842 bus_softc->path_id, bus_softc->target_id, lun_id);
1843 /* XXX KDM need some way to return status to CTL here? */
1844 if (status != CAM_REQ_CMP) {
1845 printf("%s: could not create path, status %#x\n", __func__,
1850 softc = malloc(sizeof(*softc), M_CTLFE, M_WAITOK | M_ZERO);
1851 xpt_path_lock(path);
1852 periph = cam_periph_find(path, "ctl");
1853 if (periph != NULL) {
1854 /* We've already got a periph, no need to alloc a new one. */
1855 xpt_path_unlock(path);
1856 xpt_free_path(path);
1857 free(softc, M_CTLFE);
1860 softc->parent_softc = bus_softc;
1862 status = cam_periph_alloc(ctlferegister,
1873 if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1874 const struct cam_status_entry *entry;
1876 entry = cam_fetch_status_entry(status);
1877 printf("%s: CAM error %s (%#x) returned from "
1878 "cam_periph_alloc()\n", __func__, (entry != NULL) ?
1879 entry->status_text : "Unknown", status);
1880 free(softc, M_CTLFE);
1883 xpt_path_unlock(path);
1884 xpt_free_path(path);
1889 * This will get called when the user removes a LUN to disable that LUN
1890 * on every bus that is attached to CTL.
1893 ctlfe_lun_disable(void *arg, int lun_id)
1895 struct ctlfe_softc *softc;
1896 struct ctlfe_lun_softc *lun_softc;
1898 softc = (struct ctlfe_softc *)arg;
1899 if (softc->hba_misc & PIM_EXTLUNS)
1900 lun_id = CAM_EXTLUN_BYTE_SWIZZLE(ctl_encode_lun(lun_id));
1902 mtx_lock(&softc->lun_softc_mtx);
1903 STAILQ_FOREACH(lun_softc, &softc->lun_softc_list, links) {
1904 struct cam_path *path;
1906 path = lun_softc->periph->path;
1908 if ((xpt_path_target_id(path) == softc->target_id)
1909 && (xpt_path_lun_id(path) == lun_id)) {
1913 if (lun_softc == NULL) {
1914 mtx_unlock(&softc->lun_softc_mtx);
1915 printf("%s: can't find lun %d\n", __func__, lun_id);
1918 cam_periph_acquire(lun_softc->periph);
1919 mtx_unlock(&softc->lun_softc_mtx);
1921 cam_periph_lock(lun_softc->periph);
1922 cam_periph_invalidate(lun_softc->periph);
1923 cam_periph_unlock(lun_softc->periph);
1924 cam_periph_release(lun_softc->periph);
1929 ctlfe_dump_sim(struct cam_sim *sim)
1932 printf("%s%d: max tagged openings: %d, max dev openings: %d\n",
1933 sim->sim_name, sim->unit_number,
1934 sim->max_tagged_dev_openings, sim->max_dev_openings);
1938 * Assumes that the SIM lock is held.
1941 ctlfe_dump_queue(struct ctlfe_lun_softc *softc)
1943 struct ccb_hdr *hdr;
1944 struct cam_periph *periph;
1947 periph = softc->periph;
1950 TAILQ_FOREACH(hdr, &softc->work_queue, periph_links.tqe) {
1951 union ctl_io *io = hdr->io_ptr;
1956 * Only regular SCSI I/O is put on the work
1957 * queue, so we can print sense here. There may be no
1958 * sense if it's no the queue for a DMA, but this serves to
1959 * print out the CCB as well.
1961 * XXX KDM switch this over to scsi_sense_print() when
1962 * CTL is merged in with CAM.
1964 ctl_io_error_print(io, NULL);
1967 * Print DMA status if we are DMA_QUEUED.
1969 if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED) {
1970 xpt_print(periph->path,
1971 "Total %u, Current %u, Resid %u\n",
1972 io->scsiio.kern_total_len,
1973 io->scsiio.kern_data_len,
1974 io->scsiio.kern_data_resid);
1978 xpt_print(periph->path, "%d requests total waiting for CCBs\n",
1980 xpt_print(periph->path, "%ju CCBs outstanding (%ju allocated, %ju "
1981 "freed)\n", (uintmax_t)(softc->ccbs_alloced -
1982 softc->ccbs_freed), (uintmax_t)softc->ccbs_alloced,
1983 (uintmax_t)softc->ccbs_freed);
1984 xpt_print(periph->path, "%ju CTIOs outstanding (%ju sent, %ju "
1985 "returned\n", (uintmax_t)(softc->ctios_sent -
1986 softc->ctios_returned), softc->ctios_sent,
1987 softc->ctios_returned);
1991 * Datamove/done routine called by CTL. Put ourselves on the queue to
1992 * receive a CCB from CAM so we can queue the continue I/O request down
1996 ctlfe_datamove(union ctl_io *io)
1999 struct cam_periph *periph;
2000 struct ctlfe_lun_softc *softc;
2002 KASSERT(io->io_hdr.io_type == CTL_IO_SCSI,
2003 ("Unexpected io_type (%d) in ctlfe_datamove", io->io_hdr.io_type));
2006 periph = xpt_path_periph(ccb->ccb_h.path);
2007 cam_periph_lock(periph);
2008 softc = (struct ctlfe_lun_softc *)periph->softc;
2009 io->io_hdr.flags |= CTL_FLAG_DMA_QUEUED;
2010 if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE)
2011 io->io_hdr.flags |= CTL_FLAG_STATUS_QUEUED;
2012 TAILQ_INSERT_TAIL(&softc->work_queue, &ccb->ccb_h,
2014 xpt_schedule(periph, /*priority*/ 1);
2015 cam_periph_unlock(periph);
2019 ctlfe_done(union ctl_io *io)
2022 struct cam_periph *periph;
2023 struct ctlfe_lun_softc *softc;
2026 periph = xpt_path_periph(ccb->ccb_h.path);
2027 cam_periph_lock(periph);
2028 softc = (struct ctlfe_lun_softc *)periph->softc;
2030 if (io->io_hdr.io_type == CTL_IO_TASK) {
2032 * Task management commands don't require any further
2033 * communication back to the adapter. Requeue the CCB
2034 * to the adapter, and free the CTL I/O.
2036 xpt_print(ccb->ccb_h.path, "%s: returning task I/O "
2037 "tag %#x seq %#x\n", __func__,
2038 ccb->cin1.tag_id, ccb->cin1.seq_id);
2040 * Send the notify acknowledge down to the SIM, to let it
2041 * know we processed the task management command.
2043 ccb->ccb_h.status = CAM_REQ_INPROG;
2044 ccb->ccb_h.func_code = XPT_NOTIFY_ACKNOWLEDGE;
2045 switch (io->taskio.task_status) {
2046 case CTL_TASK_FUNCTION_COMPLETE:
2047 ccb->cna2.arg = CAM_RSP_TMF_COMPLETE;
2049 case CTL_TASK_FUNCTION_SUCCEEDED:
2050 ccb->cna2.arg = CAM_RSP_TMF_SUCCEEDED;
2051 ccb->ccb_h.flags |= CAM_SEND_STATUS;
2053 case CTL_TASK_FUNCTION_REJECTED:
2054 ccb->cna2.arg = CAM_RSP_TMF_REJECTED;
2055 ccb->ccb_h.flags |= CAM_SEND_STATUS;
2057 case CTL_TASK_LUN_DOES_NOT_EXIST:
2058 ccb->cna2.arg = CAM_RSP_TMF_INCORRECT_LUN;
2059 ccb->ccb_h.flags |= CAM_SEND_STATUS;
2061 case CTL_TASK_FUNCTION_NOT_SUPPORTED:
2062 ccb->cna2.arg = CAM_RSP_TMF_FAILED;
2063 ccb->ccb_h.flags |= CAM_SEND_STATUS;
2066 ccb->cna2.arg |= scsi_3btoul(io->taskio.task_resp) << 8;
2068 } else if (io->io_hdr.flags & CTL_FLAG_STATUS_SENT) {
2069 if (softc->flags & CTLFE_LUN_WILDCARD) {
2070 ccb->ccb_h.target_id = CAM_TARGET_WILDCARD;
2071 ccb->ccb_h.target_lun = CAM_LUN_WILDCARD;
2073 if (periph->flags & CAM_PERIPH_INVALID) {
2074 ctlfe_free_ccb(periph, ccb);
2076 cam_periph_unlock(periph);
2081 io->io_hdr.flags |= CTL_FLAG_STATUS_QUEUED;
2082 TAILQ_INSERT_TAIL(&softc->work_queue, &ccb->ccb_h,
2084 xpt_schedule(periph, /*priority*/ 1);
2087 cam_periph_unlock(periph);
2093 struct ctlfe_softc *bus_softc;
2094 struct ctlfe_lun_softc *lun_softc;
2096 STAILQ_FOREACH(bus_softc, &ctlfe_softc_list, links) {
2097 ctlfe_dump_sim(bus_softc->sim);
2098 STAILQ_FOREACH(lun_softc, &bus_softc->lun_softc_list, links)
2099 ctlfe_dump_queue(lun_softc);