2 * Implementation of the Target Mode 'Black Hole device' for CAM.
4 * Copyright (c) 1999 Justin T. Gibbs.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification, immediately at the beginning of the file.
13 * 2. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * $FreeBSD: src/sys/cam/scsi/scsi_targ_bh.c,v 1.4.2.5 2001/07/30 00:15:22 mjacob Exp $
29 * $DragonFly: src/sys/bus/cam/scsi/scsi_targ_bh.c,v 1.4 2003/08/07 21:16:45 dillon Exp $
31 #include <sys/param.h>
32 #include <sys/queue.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/types.h>
38 #include <sys/devicestat.h>
39 #include <sys/malloc.h>
43 #include "../cam_ccb.h"
44 #include "../cam_extend.h"
45 #include "../cam_periph.h"
46 #include "../cam_queue.h"
47 #include "../cam_xpt_periph.h"
48 #include "../cam_debug.h"
51 #include "scsi_message.h"
55 TARGBH_STATE_EXCEPTION,
60 TARGBH_FLAG_NONE = 0x00,
61 TARGBH_FLAG_LUN_ENABLED = 0x01
70 #define MAX_IMMEDIATE 16
71 #define MAX_BUF_SIZE 256 /* Max inquiry/sense/mode page transfer */
73 /* Offsets into our private CCB area for storing accept information */
74 #define ccb_type ppriv_field0
75 #define ccb_descr ppriv_ptr1
77 /* We stick a pointer to the originating accept TIO in each continue I/O CCB */
78 #define ccb_atio ppriv_ptr1
80 TAILQ_HEAD(ccb_queue, ccb_hdr);
83 struct ccb_queue pending_queue;
84 struct ccb_queue work_queue;
85 struct ccb_queue unknown_atio_queue;
86 struct devstat device_stats;
91 struct ccb_accept_tio *accept_tio_list;
92 struct ccb_hdr_slist immed_notify_slist;
95 struct targbh_cmd_desc {
96 struct ccb_accept_tio* atio_link;
97 u_int data_resid; /* How much left to transfer */
98 u_int data_increment;/* Amount to send before next disconnect */
99 void* data; /* The data. Can be from backing_store or not */
100 void* backing_store;/* Backing store allocated for this descriptor*/
101 u_int max_size; /* Size of backing_store */
103 u_int8_t status; /* Status to return to initiator */
106 static struct scsi_inquiry_data no_lun_inq_data =
108 T_NODEVICE | (SID_QUAL_BAD_LU << 5), 0,
109 /* version */2, /* format version */2
112 static struct scsi_sense_data no_lun_sense_data =
114 SSD_CURRENT_ERROR|SSD_ERRCODE_VALID,
118 /*extra_len*/offsetof(struct scsi_sense_data, fru)
119 - offsetof(struct scsi_sense_data, extra_len),
121 /* Logical Unit Not Supported */
122 /*ASC*/0x25, /*ASCQ*/0
125 static const int request_sense_size = offsetof(struct scsi_sense_data, fru);
127 static periph_init_t targbhinit;
128 static void targbhasync(void *callback_arg, u_int32_t code,
129 struct cam_path *path, void *arg);
130 static cam_status targbhenlun(struct cam_periph *periph);
131 static cam_status targbhdislun(struct cam_periph *periph);
132 static periph_ctor_t targbhctor;
133 static periph_dtor_t targbhdtor;
134 static periph_start_t targbhstart;
135 static void targbhdone(struct cam_periph *periph,
136 union ccb *done_ccb);
138 static int targbherror(union ccb *ccb, u_int32_t cam_flags,
139 u_int32_t sense_flags);
141 static struct targbh_cmd_desc* targbhallocdescr(void);
142 static void targbhfreedescr(struct targbh_cmd_desc *buf);
144 static struct periph_driver targbhdriver =
146 targbhinit, "targbh",
147 TAILQ_HEAD_INITIALIZER(targbhdriver.units), /* generation */ 0
150 DATA_SET(periphdriver_set, targbhdriver);
156 struct cam_path *path;
159 * Install a global async callback. This callback will
160 * receive async callbacks like "new path registered".
162 status = xpt_create_path(&path, /*periph*/NULL, CAM_XPT_PATH_ID,
163 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
165 if (status == CAM_REQ_CMP) {
166 struct ccb_setasync csa;
168 xpt_setup_ccb(&csa.ccb_h, path, /*priority*/5);
169 csa.ccb_h.func_code = XPT_SASYNC_CB;
170 csa.event_enable = AC_PATH_REGISTERED;
171 csa.callback = targbhasync;
172 csa.callback_arg = NULL;
173 xpt_action((union ccb *)&csa);
174 status = csa.ccb_h.status;
178 if (status != CAM_REQ_CMP) {
179 printf("targbh: Failed to attach master async callback "
180 "due to status 0x%x!\n", status);
185 targbhasync(void *callback_arg, u_int32_t code,
186 struct cam_path *path, void *arg)
188 struct cam_periph *periph;
190 periph = (struct cam_periph *)callback_arg;
192 case AC_PATH_REGISTERED:
194 struct ccb_pathinq *cpi;
195 struct cam_path *new_path;
198 cpi = (struct ccb_pathinq *)arg;
200 /* Only attach to controllers that support target mode */
201 if ((cpi->target_sprt & PIT_PROCESSOR) == 0)
205 * Allocate a peripheral instance for
206 * this target instance.
208 status = xpt_create_path(&new_path, NULL,
209 xpt_path_path_id(path),
210 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
211 if (status != CAM_REQ_CMP) {
212 printf("targbhasync: Unable to create path "
213 "due to status 0x%x\n", status);
216 status = cam_periph_alloc(targbhctor, NULL, targbhdtor,
218 "targbh", CAM_PERIPH_BIO,
219 new_path, targbhasync,
222 xpt_free_path(new_path);
223 if (status != CAM_REQ_CMP
224 && status != CAM_REQ_INPROG)
225 printf("targbhasync: Unable to allocate new periph "
226 "due to status 0x%x\n", status);
229 case AC_PATH_DEREGISTERED:
231 targbhdislun(periph);
239 /* Attempt to enable our lun */
241 targbhenlun(struct cam_periph *periph)
244 struct targbh_softc *softc;
248 softc = (struct targbh_softc *)periph->softc;
250 if ((softc->flags & TARGBH_FLAG_LUN_ENABLED) != 0)
251 return (CAM_REQ_CMP);
253 xpt_setup_ccb(&immed_ccb.ccb_h, periph->path, /*priority*/1);
254 immed_ccb.ccb_h.func_code = XPT_EN_LUN;
256 /* Don't need support for any vendor specific commands */
257 immed_ccb.cel.grp6_len = 0;
258 immed_ccb.cel.grp7_len = 0;
259 immed_ccb.cel.enable = 1;
260 xpt_action(&immed_ccb);
261 status = immed_ccb.ccb_h.status;
262 if (status != CAM_REQ_CMP) {
263 xpt_print_path(periph->path);
264 printf("targbhenlun - Enable Lun Rejected with status 0x%x\n",
269 softc->flags |= TARGBH_FLAG_LUN_ENABLED;
272 * Build up a buffer of accept target I/O
273 * operations for incoming selections.
275 for (i = 0; i < MAX_ACCEPT; i++) {
276 struct ccb_accept_tio *atio;
278 atio = (struct ccb_accept_tio*)malloc(sizeof(*atio), M_DEVBUF,
281 status = CAM_RESRC_UNAVAIL;
285 atio->ccb_h.ccb_descr = targbhallocdescr();
287 if (atio->ccb_h.ccb_descr == NULL) {
288 free(atio, M_DEVBUF);
289 status = CAM_RESRC_UNAVAIL;
293 xpt_setup_ccb(&atio->ccb_h, periph->path, /*priority*/1);
294 atio->ccb_h.func_code = XPT_ACCEPT_TARGET_IO;
295 atio->ccb_h.cbfcnp = targbhdone;
296 xpt_action((union ccb *)atio);
297 status = atio->ccb_h.status;
298 if (status != CAM_REQ_INPROG) {
299 targbhfreedescr(atio->ccb_h.ccb_descr);
300 free(atio, M_DEVBUF);
303 ((struct targbh_cmd_desc*)atio->ccb_h.ccb_descr)->atio_link =
304 softc->accept_tio_list;
305 softc->accept_tio_list = atio;
309 xpt_print_path(periph->path);
310 printf("targbhenlun - Could not allocate accept tio CCBs: "
311 "status = 0x%x\n", status);
312 targbhdislun(periph);
313 return (CAM_REQ_CMP_ERR);
317 * Build up a buffer of immediate notify CCBs
318 * so the SIM can tell us of asynchronous target mode events.
320 for (i = 0; i < MAX_ACCEPT; i++) {
321 struct ccb_immed_notify *inot;
323 inot = (struct ccb_immed_notify*)malloc(sizeof(*inot), M_DEVBUF,
327 status = CAM_RESRC_UNAVAIL;
331 xpt_setup_ccb(&inot->ccb_h, periph->path, /*priority*/1);
332 inot->ccb_h.func_code = XPT_IMMED_NOTIFY;
333 inot->ccb_h.cbfcnp = targbhdone;
334 xpt_action((union ccb *)inot);
335 status = inot->ccb_h.status;
336 if (status != CAM_REQ_INPROG) {
337 free(inot, M_DEVBUF);
340 SLIST_INSERT_HEAD(&softc->immed_notify_slist, &inot->ccb_h,
345 xpt_print_path(periph->path);
346 printf("targbhenlun - Could not allocate immediate notify "
347 "CCBs: status = 0x%x\n", status);
348 targbhdislun(periph);
349 return (CAM_REQ_CMP_ERR);
352 return (CAM_REQ_CMP);
356 targbhdislun(struct cam_periph *periph)
359 struct targbh_softc *softc;
360 struct ccb_accept_tio* atio;
361 struct ccb_hdr *ccb_h;
363 softc = (struct targbh_softc *)periph->softc;
364 if ((softc->flags & TARGBH_FLAG_LUN_ENABLED) == 0)
367 /* XXX Block for Continue I/O completion */
369 /* Kill off all ACCECPT and IMMEDIATE CCBs */
370 while ((atio = softc->accept_tio_list) != NULL) {
372 softc->accept_tio_list =
373 ((struct targbh_cmd_desc*)atio->ccb_h.ccb_descr)->atio_link;
374 xpt_setup_ccb(&ccb.cab.ccb_h, periph->path, /*priority*/1);
375 ccb.cab.ccb_h.func_code = XPT_ABORT;
376 ccb.cab.abort_ccb = (union ccb *)atio;
380 while ((ccb_h = SLIST_FIRST(&softc->immed_notify_slist)) != NULL) {
381 SLIST_REMOVE_HEAD(&softc->immed_notify_slist, periph_links.sle);
382 xpt_setup_ccb(&ccb.cab.ccb_h, periph->path, /*priority*/1);
383 ccb.cab.ccb_h.func_code = XPT_ABORT;
384 ccb.cab.abort_ccb = (union ccb *)ccb_h;
391 xpt_setup_ccb(&ccb.cel.ccb_h, periph->path, /*priority*/1);
392 ccb.cel.ccb_h.func_code = XPT_EN_LUN;
396 if (ccb.cel.ccb_h.status != CAM_REQ_CMP)
397 printf("targbhdislun - Disabling lun on controller failed "
398 "with status 0x%x\n", ccb.cel.ccb_h.status);
400 softc->flags &= ~TARGBH_FLAG_LUN_ENABLED;
401 return (ccb.cel.ccb_h.status);
405 targbhctor(struct cam_periph *periph, void *arg)
407 struct ccb_pathinq *cpi;
408 struct targbh_softc *softc;
410 cpi = (struct ccb_pathinq *)arg;
412 /* Allocate our per-instance private storage */
413 softc = (struct targbh_softc *)malloc(sizeof(*softc),
416 printf("targctor: unable to malloc softc\n");
417 return (CAM_REQ_CMP_ERR);
420 bzero(softc, sizeof(*softc));
421 TAILQ_INIT(&softc->pending_queue);
422 TAILQ_INIT(&softc->work_queue);
423 softc->accept_tio_list = NULL;
424 SLIST_INIT(&softc->immed_notify_slist);
425 softc->state = TARGBH_STATE_NORMAL;
426 periph->softc = softc;
429 return (targbhenlun(periph));
433 targbhdtor(struct cam_periph *periph)
435 struct targbh_softc *softc;
437 softc = (struct targbh_softc *)periph->softc;
439 softc->state = TARGBH_STATE_TEARDOWN;
441 targbhdislun(periph);
443 switch (softc->init_level) {
447 free(softc, M_DEVBUF);
450 panic("targdtor - impossible init level");;
455 targbhstart(struct cam_periph *periph, union ccb *start_ccb)
457 struct targbh_softc *softc;
458 struct ccb_hdr *ccbh;
459 struct ccb_accept_tio *atio;
460 struct targbh_cmd_desc *desc;
461 struct ccb_scsiio *csio;
465 softc = (struct targbh_softc *)periph->softc;
468 ccbh = TAILQ_FIRST(&softc->work_queue);
469 if (periph->immediate_priority <= periph->pinfo.priority) {
470 start_ccb->ccb_h.ccb_type = TARGBH_CCB_WAITING;
471 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
473 periph->immediate_priority = CAM_PRIORITY_NONE;
475 wakeup(&periph->ccb_list);
476 } else if (ccbh == NULL) {
478 xpt_release_ccb(start_ccb);
480 TAILQ_REMOVE(&softc->work_queue, ccbh, periph_links.tqe);
481 TAILQ_INSERT_HEAD(&softc->pending_queue, ccbh,
484 atio = (struct ccb_accept_tio*)ccbh;
485 desc = (struct targbh_cmd_desc *)atio->ccb_h.ccb_descr;
487 /* Is this a tagged request? */
488 flags = atio->ccb_h.flags & (CAM_TAG_ACTION_VALID|CAM_DIR_MASK);
490 csio = &start_ccb->csio;
492 * If we are done with the transaction, tell the
493 * controller to send status and perform a CMD_CMPLT.
494 * If we have associated sense data, see if we can
497 if (desc->data_resid == desc->data_increment) {
498 flags |= CAM_SEND_STATUS;
499 if (atio->sense_len) {
500 csio->sense_len = atio->sense_len;
501 csio->sense_data = atio->sense_data;
502 flags |= CAM_SEND_SENSE;
511 (flags & CAM_TAG_ACTION_VALID)?
512 MSG_SIMPLE_Q_TAG : 0,
516 /*data_ptr*/desc->data_increment == 0
518 /*dxfer_len*/desc->data_increment,
519 /*timeout*/desc->timeout);
521 /* Override our wildcard attachment */
522 start_ccb->ccb_h.target_id = atio->ccb_h.target_id;
523 start_ccb->ccb_h.target_lun = atio->ccb_h.target_lun;
525 start_ccb->ccb_h.ccb_type = TARGBH_CCB_WORKQ;
526 start_ccb->ccb_h.ccb_atio = atio;
527 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
528 ("Sending a CTIO\n"));
529 xpt_action(start_ccb);
531 ccbh = TAILQ_FIRST(&softc->work_queue);
535 xpt_schedule(periph, /*priority*/1);
539 targbhdone(struct cam_periph *periph, union ccb *done_ccb)
541 struct targbh_softc *softc;
543 softc = (struct targbh_softc *)periph->softc;
545 if (done_ccb->ccb_h.ccb_type == TARGBH_CCB_WAITING) {
546 /* Caller will release the CCB */
547 wakeup(&done_ccb->ccb_h.cbfcnp);
551 switch (done_ccb->ccb_h.func_code) {
552 case XPT_ACCEPT_TARGET_IO:
554 struct ccb_accept_tio *atio;
555 struct targbh_cmd_desc *descr;
558 atio = &done_ccb->atio;
559 descr = (struct targbh_cmd_desc*)atio->ccb_h.ccb_descr;
560 cdb = atio->cdb_io.cdb_bytes;
561 if (softc->state == TARGBH_STATE_TEARDOWN
562 || atio->ccb_h.status == CAM_REQ_ABORTED) {
563 targbhfreedescr(descr);
564 free(done_ccb, M_DEVBUF);
569 * Determine the type of incoming command and
570 * setup our buffer for a response.
575 struct scsi_inquiry *inq;
577 inq = (struct scsi_inquiry *)cdb;
578 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
579 ("Saw an inquiry!\n"));
581 * Validate the command. We don't
582 * support any VPD pages, so complain
585 if ((inq->byte2 & SI_EVPD) != 0
586 || inq->page_code != 0) {
587 atio->ccb_h.flags &= ~CAM_DIR_MASK;
588 atio->ccb_h.flags |= CAM_DIR_NONE;
590 * This needs to have other than a
591 * no_lun_sense_data response.
593 atio->sense_data = no_lun_sense_data;
594 atio->sense_len = sizeof(no_lun_sense_data);
595 descr->data_resid = 0;
596 descr->data_increment = 0;
597 descr->status = SCSI_STATUS_CHECK_COND;
601 * Direction is always relative
604 atio->ccb_h.flags &= ~CAM_DIR_MASK;
605 atio->ccb_h.flags |= CAM_DIR_IN;
606 descr->data = &no_lun_inq_data;
607 descr->data_resid = MIN(sizeof(no_lun_inq_data),
608 SCSI_CDB6_LEN(inq->length));
609 descr->data_increment = descr->data_resid;
610 descr->timeout = 5 * 1000;
611 descr->status = SCSI_STATUS_OK;
616 struct scsi_request_sense *rsense;
618 rsense = (struct scsi_request_sense *)cdb;
619 /* Refer to static sense data */
620 atio->ccb_h.flags &= ~CAM_DIR_MASK;
621 atio->ccb_h.flags |= CAM_DIR_IN;
622 descr->data = &no_lun_sense_data;
623 descr->data_resid = request_sense_size;
624 descr->data_resid = MIN(descr->data_resid,
625 SCSI_CDB6_LEN(rsense->length));
626 descr->data_increment = descr->data_resid;
627 descr->timeout = 5 * 1000;
628 descr->status = SCSI_STATUS_OK;
632 /* Constant CA, tell initiator */
633 /* Direction is always relative to the initator */
634 atio->ccb_h.flags &= ~CAM_DIR_MASK;
635 atio->ccb_h.flags |= CAM_DIR_NONE;
636 atio->sense_data = no_lun_sense_data;
637 atio->sense_len = sizeof (no_lun_sense_data);
638 descr->data_resid = 0;
639 descr->data_increment = 0;
640 descr->timeout = 5 * 1000;
641 descr->status = SCSI_STATUS_CHECK_COND;
645 /* Queue us up to receive a Continue Target I/O ccb. */
646 TAILQ_INSERT_TAIL(&softc->work_queue, &atio->ccb_h,
648 xpt_schedule(periph, /*priority*/1);
651 case XPT_CONT_TARGET_IO:
653 struct ccb_accept_tio *atio;
654 struct targbh_cmd_desc *desc;
656 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
657 ("Received completed CTIO\n"));
658 atio = (struct ccb_accept_tio*)done_ccb->ccb_h.ccb_atio;
659 desc = (struct targbh_cmd_desc *)atio->ccb_h.ccb_descr;
661 TAILQ_REMOVE(&softc->pending_queue, &atio->ccb_h,
665 * We could check for CAM_SENT_SENSE bein set here,
666 * but since we're not maintaining any CA/UA state,
670 done_ccb->ccb_h.flags &= ~CAM_SEND_SENSE;
671 done_ccb->ccb_h.status &= ~CAM_SENT_SENSE;
673 /* XXX Check for errors */
674 desc->data_resid -= desc->data_increment;
675 xpt_release_ccb(done_ccb);
676 if (softc->state != TARGBH_STATE_TEARDOWN) {
679 * Send the original accept TIO back to the
680 * controller to handle more work.
682 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
683 ("Returning ATIO to target\n"));
684 /* Restore wildcards */
685 atio->ccb_h.target_id = CAM_TARGET_WILDCARD;
686 atio->ccb_h.target_lun = CAM_LUN_WILDCARD;
687 xpt_action((union ccb *)atio);
690 targbhfreedescr(desc);
691 free(atio, M_DEVBUF);
695 case XPT_IMMED_NOTIFY:
697 if (softc->state == TARGBH_STATE_TEARDOWN
698 || done_ccb->ccb_h.status == CAM_REQ_ABORTED) {
699 printf("Freed an immediate notify\n");
700 free(done_ccb, M_DEVBUF);
705 panic("targbhdone: Unexpected ccb opcode");
712 targbherror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
718 static struct targbh_cmd_desc*
721 struct targbh_cmd_desc* descr;
723 /* Allocate the targbh_descr structure */
724 descr = (struct targbh_cmd_desc *)malloc(sizeof(*descr),
729 bzero(descr, sizeof(*descr));
731 /* Allocate buffer backing store */
732 descr->backing_store = malloc(MAX_BUF_SIZE, M_DEVBUF, M_NOWAIT);
733 if (descr->backing_store == NULL) {
734 free(descr, M_DEVBUF);
737 descr->max_size = MAX_BUF_SIZE;
742 targbhfreedescr(struct targbh_cmd_desc *descr)
744 free(descr->backing_store, M_DEVBUF);
745 free(descr, M_DEVBUF);