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.6 2003/11/14 11:31:25 simokawa Exp $
29 * $DragonFly: src/sys/bus/cam/scsi/scsi_targ_bh.c,v 1.8 2004/03/15 02:27:56 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 | AC_PATH_DEREGISTERED;
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_path *new_path;
189 struct ccb_pathinq *cpi;
190 path_id_t bus_path_id;
193 cpi = (struct ccb_pathinq *)arg;
194 if (code == AC_PATH_REGISTERED)
195 bus_path_id = cpi->ccb_h.path_id;
197 bus_path_id = xpt_path_path_id(path);
199 * Allocate a peripheral instance for
200 * this target instance.
202 status = xpt_create_path(&new_path, NULL,
204 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
205 if (status != CAM_REQ_CMP) {
206 printf("targbhasync: Unable to create path "
207 "due to status 0x%x\n", status);
212 case AC_PATH_REGISTERED:
214 /* Only attach to controllers that support target mode */
215 if ((cpi->target_sprt & PIT_PROCESSOR) == 0)
218 status = cam_periph_alloc(targbhctor, NULL, targbhdtor,
220 "targbh", CAM_PERIPH_BIO,
221 new_path, targbhasync,
226 case AC_PATH_DEREGISTERED:
228 struct cam_periph *periph;
230 if ((periph = cam_periph_find(new_path, "targbh")) != NULL)
231 cam_periph_invalidate(periph);
237 xpt_free_path(new_path);
240 /* Attempt to enable our lun */
242 targbhenlun(struct cam_periph *periph)
245 struct targbh_softc *softc;
249 softc = (struct targbh_softc *)periph->softc;
251 if ((softc->flags & TARGBH_FLAG_LUN_ENABLED) != 0)
252 return (CAM_REQ_CMP);
254 xpt_setup_ccb(&immed_ccb.ccb_h, periph->path, /*priority*/1);
255 immed_ccb.ccb_h.func_code = XPT_EN_LUN;
257 /* Don't need support for any vendor specific commands */
258 immed_ccb.cel.grp6_len = 0;
259 immed_ccb.cel.grp7_len = 0;
260 immed_ccb.cel.enable = 1;
261 xpt_action(&immed_ccb);
262 status = immed_ccb.ccb_h.status;
263 if (status != CAM_REQ_CMP) {
264 xpt_print_path(periph->path);
265 printf("targbhenlun - Enable Lun Rejected with status 0x%x\n",
270 softc->flags |= TARGBH_FLAG_LUN_ENABLED;
273 * Build up a buffer of accept target I/O
274 * operations for incoming selections.
276 for (i = 0; i < MAX_ACCEPT; i++) {
277 struct ccb_accept_tio *atio;
279 atio = malloc(sizeof(*atio), M_DEVBUF, M_INTWAIT);
281 atio->ccb_h.ccb_descr = targbhallocdescr();
283 xpt_setup_ccb(&atio->ccb_h, periph->path, /*priority*/1);
284 atio->ccb_h.func_code = XPT_ACCEPT_TARGET_IO;
285 atio->ccb_h.cbfcnp = targbhdone;
286 xpt_action((union ccb *)atio);
287 status = atio->ccb_h.status;
288 if (status != CAM_REQ_INPROG) {
289 targbhfreedescr(atio->ccb_h.ccb_descr);
290 free(atio, M_DEVBUF);
293 ((struct targbh_cmd_desc*)atio->ccb_h.ccb_descr)->atio_link =
294 softc->accept_tio_list;
295 softc->accept_tio_list = atio;
299 xpt_print_path(periph->path);
300 printf("targbhenlun - Could not allocate accept tio CCBs: "
301 "status = 0x%x\n", status);
302 targbhdislun(periph);
303 return (CAM_REQ_CMP_ERR);
307 * Build up a buffer of immediate notify CCBs
308 * so the SIM can tell us of asynchronous target mode events.
310 for (i = 0; i < MAX_ACCEPT; i++) {
311 struct ccb_immed_notify *inot;
313 inot = malloc(sizeof(*inot), M_DEVBUF, M_INTWAIT);
315 xpt_setup_ccb(&inot->ccb_h, periph->path, /*priority*/1);
316 inot->ccb_h.func_code = XPT_IMMED_NOTIFY;
317 inot->ccb_h.cbfcnp = targbhdone;
318 xpt_action((union ccb *)inot);
319 status = inot->ccb_h.status;
320 if (status != CAM_REQ_INPROG) {
321 free(inot, M_DEVBUF);
324 SLIST_INSERT_HEAD(&softc->immed_notify_slist, &inot->ccb_h,
329 xpt_print_path(periph->path);
330 printf("targbhenlun - Could not allocate immediate notify "
331 "CCBs: status = 0x%x\n", status);
332 targbhdislun(periph);
333 return (CAM_REQ_CMP_ERR);
336 return (CAM_REQ_CMP);
340 targbhdislun(struct cam_periph *periph)
343 struct targbh_softc *softc;
344 struct ccb_accept_tio* atio;
345 struct ccb_hdr *ccb_h;
347 softc = (struct targbh_softc *)periph->softc;
348 if ((softc->flags & TARGBH_FLAG_LUN_ENABLED) == 0)
351 /* XXX Block for Continue I/O completion */
353 /* Kill off all ACCECPT and IMMEDIATE CCBs */
354 while ((atio = softc->accept_tio_list) != NULL) {
356 softc->accept_tio_list =
357 ((struct targbh_cmd_desc*)atio->ccb_h.ccb_descr)->atio_link;
358 xpt_setup_ccb(&ccb.cab.ccb_h, periph->path, /*priority*/1);
359 ccb.cab.ccb_h.func_code = XPT_ABORT;
360 ccb.cab.abort_ccb = (union ccb *)atio;
364 while ((ccb_h = SLIST_FIRST(&softc->immed_notify_slist)) != NULL) {
365 SLIST_REMOVE_HEAD(&softc->immed_notify_slist, periph_links.sle);
366 xpt_setup_ccb(&ccb.cab.ccb_h, periph->path, /*priority*/1);
367 ccb.cab.ccb_h.func_code = XPT_ABORT;
368 ccb.cab.abort_ccb = (union ccb *)ccb_h;
375 xpt_setup_ccb(&ccb.cel.ccb_h, periph->path, /*priority*/1);
376 ccb.cel.ccb_h.func_code = XPT_EN_LUN;
380 if (ccb.cel.ccb_h.status != CAM_REQ_CMP)
381 printf("targbhdislun - Disabling lun on controller failed "
382 "with status 0x%x\n", ccb.cel.ccb_h.status);
384 softc->flags &= ~TARGBH_FLAG_LUN_ENABLED;
385 return (ccb.cel.ccb_h.status);
389 targbhctor(struct cam_periph *periph, void *arg)
391 struct ccb_pathinq *cpi;
392 struct targbh_softc *softc;
394 cpi = (struct ccb_pathinq *)arg;
396 /* Allocate our per-instance private storage */
397 softc = malloc(sizeof(*softc), M_DEVBUF, M_INTWAIT | M_ZERO);
398 TAILQ_INIT(&softc->pending_queue);
399 TAILQ_INIT(&softc->work_queue);
400 softc->accept_tio_list = NULL;
401 SLIST_INIT(&softc->immed_notify_slist);
402 softc->state = TARGBH_STATE_NORMAL;
403 periph->softc = softc;
406 return (targbhenlun(periph));
410 targbhdtor(struct cam_periph *periph)
412 struct targbh_softc *softc;
414 softc = (struct targbh_softc *)periph->softc;
416 softc->state = TARGBH_STATE_TEARDOWN;
418 targbhdislun(periph);
420 switch (softc->init_level) {
422 panic("targdtor - impossible init level");;
426 /* XXX Wait for callback of targbhdislun() */
427 tsleep(softc, 0, "targbh", hz/2);
428 free(softc, M_DEVBUF);
434 targbhstart(struct cam_periph *periph, union ccb *start_ccb)
436 struct targbh_softc *softc;
437 struct ccb_hdr *ccbh;
438 struct ccb_accept_tio *atio;
439 struct targbh_cmd_desc *desc;
440 struct ccb_scsiio *csio;
444 softc = (struct targbh_softc *)periph->softc;
447 ccbh = TAILQ_FIRST(&softc->work_queue);
448 if (periph->immediate_priority <= periph->pinfo.priority) {
449 start_ccb->ccb_h.ccb_type = TARGBH_CCB_WAITING;
450 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
452 periph->immediate_priority = CAM_PRIORITY_NONE;
454 wakeup(&periph->ccb_list);
455 } else if (ccbh == NULL) {
457 xpt_release_ccb(start_ccb);
459 TAILQ_REMOVE(&softc->work_queue, ccbh, periph_links.tqe);
460 TAILQ_INSERT_HEAD(&softc->pending_queue, ccbh,
463 atio = (struct ccb_accept_tio*)ccbh;
464 desc = (struct targbh_cmd_desc *)atio->ccb_h.ccb_descr;
466 /* Is this a tagged request? */
467 flags = atio->ccb_h.flags & (CAM_TAG_ACTION_VALID|CAM_DIR_MASK);
469 csio = &start_ccb->csio;
471 * If we are done with the transaction, tell the
472 * controller to send status and perform a CMD_CMPLT.
473 * If we have associated sense data, see if we can
476 if (desc->data_resid == desc->data_increment) {
477 flags |= CAM_SEND_STATUS;
478 if (atio->sense_len) {
479 csio->sense_len = atio->sense_len;
480 csio->sense_data = atio->sense_data;
481 flags |= CAM_SEND_SENSE;
490 (flags & CAM_TAG_ACTION_VALID)?
491 MSG_SIMPLE_Q_TAG : 0,
495 /*data_ptr*/desc->data_increment == 0
497 /*dxfer_len*/desc->data_increment,
498 /*timeout*/desc->timeout);
500 /* Override our wildcard attachment */
501 start_ccb->ccb_h.target_id = atio->ccb_h.target_id;
502 start_ccb->ccb_h.target_lun = atio->ccb_h.target_lun;
504 start_ccb->ccb_h.ccb_type = TARGBH_CCB_WORKQ;
505 start_ccb->ccb_h.ccb_atio = atio;
506 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
507 ("Sending a CTIO\n"));
508 xpt_action(start_ccb);
510 ccbh = TAILQ_FIRST(&softc->work_queue);
514 xpt_schedule(periph, /*priority*/1);
518 targbhdone(struct cam_periph *periph, union ccb *done_ccb)
520 struct targbh_softc *softc;
522 softc = (struct targbh_softc *)periph->softc;
524 if (done_ccb->ccb_h.ccb_type == TARGBH_CCB_WAITING) {
525 /* Caller will release the CCB */
526 wakeup(&done_ccb->ccb_h.cbfcnp);
530 switch (done_ccb->ccb_h.func_code) {
531 case XPT_ACCEPT_TARGET_IO:
533 struct ccb_accept_tio *atio;
534 struct targbh_cmd_desc *descr;
537 atio = &done_ccb->atio;
538 descr = (struct targbh_cmd_desc*)atio->ccb_h.ccb_descr;
539 cdb = atio->cdb_io.cdb_bytes;
540 if (softc->state == TARGBH_STATE_TEARDOWN
541 || atio->ccb_h.status == CAM_REQ_ABORTED) {
542 targbhfreedescr(descr);
543 free(done_ccb, M_DEVBUF);
548 * Determine the type of incoming command and
549 * setup our buffer for a response.
554 struct scsi_inquiry *inq;
556 inq = (struct scsi_inquiry *)cdb;
557 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
558 ("Saw an inquiry!\n"));
560 * Validate the command. We don't
561 * support any VPD pages, so complain
564 if ((inq->byte2 & SI_EVPD) != 0
565 || inq->page_code != 0) {
566 atio->ccb_h.flags &= ~CAM_DIR_MASK;
567 atio->ccb_h.flags |= CAM_DIR_NONE;
569 * This needs to have other than a
570 * no_lun_sense_data response.
572 atio->sense_data = no_lun_sense_data;
573 atio->sense_len = sizeof(no_lun_sense_data);
574 descr->data_resid = 0;
575 descr->data_increment = 0;
576 descr->status = SCSI_STATUS_CHECK_COND;
580 * Direction is always relative
583 atio->ccb_h.flags &= ~CAM_DIR_MASK;
584 atio->ccb_h.flags |= CAM_DIR_IN;
585 descr->data = &no_lun_inq_data;
586 descr->data_resid = MIN(sizeof(no_lun_inq_data),
587 SCSI_CDB6_LEN(inq->length));
588 descr->data_increment = descr->data_resid;
589 descr->timeout = 5 * 1000;
590 descr->status = SCSI_STATUS_OK;
595 struct scsi_request_sense *rsense;
597 rsense = (struct scsi_request_sense *)cdb;
598 /* Refer to static sense data */
599 atio->ccb_h.flags &= ~CAM_DIR_MASK;
600 atio->ccb_h.flags |= CAM_DIR_IN;
601 descr->data = &no_lun_sense_data;
602 descr->data_resid = request_sense_size;
603 descr->data_resid = MIN(descr->data_resid,
604 SCSI_CDB6_LEN(rsense->length));
605 descr->data_increment = descr->data_resid;
606 descr->timeout = 5 * 1000;
607 descr->status = SCSI_STATUS_OK;
611 /* Constant CA, tell initiator */
612 /* Direction is always relative to the initator */
613 atio->ccb_h.flags &= ~CAM_DIR_MASK;
614 atio->ccb_h.flags |= CAM_DIR_NONE;
615 atio->sense_data = no_lun_sense_data;
616 atio->sense_len = sizeof (no_lun_sense_data);
617 descr->data_resid = 0;
618 descr->data_increment = 0;
619 descr->timeout = 5 * 1000;
620 descr->status = SCSI_STATUS_CHECK_COND;
624 /* Queue us up to receive a Continue Target I/O ccb. */
625 TAILQ_INSERT_TAIL(&softc->work_queue, &atio->ccb_h,
627 xpt_schedule(periph, /*priority*/1);
630 case XPT_CONT_TARGET_IO:
632 struct ccb_accept_tio *atio;
633 struct targbh_cmd_desc *desc;
635 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
636 ("Received completed CTIO\n"));
637 atio = (struct ccb_accept_tio*)done_ccb->ccb_h.ccb_atio;
638 desc = (struct targbh_cmd_desc *)atio->ccb_h.ccb_descr;
640 TAILQ_REMOVE(&softc->pending_queue, &atio->ccb_h,
644 * We could check for CAM_SENT_SENSE bein set here,
645 * but since we're not maintaining any CA/UA state,
649 done_ccb->ccb_h.flags &= ~CAM_SEND_SENSE;
650 done_ccb->ccb_h.status &= ~CAM_SENT_SENSE;
652 /* XXX Check for errors */
653 desc->data_resid -= desc->data_increment;
654 xpt_release_ccb(done_ccb);
655 if (softc->state != TARGBH_STATE_TEARDOWN) {
658 * Send the original accept TIO back to the
659 * controller to handle more work.
661 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
662 ("Returning ATIO to target\n"));
663 /* Restore wildcards */
664 atio->ccb_h.target_id = CAM_TARGET_WILDCARD;
665 atio->ccb_h.target_lun = CAM_LUN_WILDCARD;
666 xpt_action((union ccb *)atio);
669 targbhfreedescr(desc);
670 free(atio, M_DEVBUF);
674 case XPT_IMMED_NOTIFY:
676 if (softc->state == TARGBH_STATE_TEARDOWN
677 || done_ccb->ccb_h.status == CAM_REQ_ABORTED) {
678 printf("Freed an immediate notify\n");
679 free(done_ccb, M_DEVBUF);
684 panic("targbhdone: Unexpected ccb opcode");
691 targbherror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
697 static struct targbh_cmd_desc*
700 struct targbh_cmd_desc* descr;
702 /* Allocate the targbh_descr structure */
703 descr = malloc(sizeof(*descr), M_DEVBUF, M_INTWAIT | M_ZERO);
705 /* Allocate buffer backing store */
706 descr->backing_store = malloc(MAX_BUF_SIZE, M_DEVBUF, M_INTWAIT);
707 descr->max_size = MAX_BUF_SIZE;
712 targbhfreedescr(struct targbh_cmd_desc *descr)
714 free(descr->backing_store, M_DEVBUF);
715 free(descr, M_DEVBUF);