2 * Copyright (c) 1997, 1998 Justin T. Gibbs.
3 * Copyright (c) 1997, 1998, 1999 Kenneth D. Merry.
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, immediately at the beginning of the file.
12 * 2. The name of the author may not be used to endorse or promote products
13 * derived from this software without specific prior written permission.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
19 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * $FreeBSD: src/sys/cam/scsi/scsi_pass.c,v 1.19 2000/01/17 06:27:37 mjacob Exp $
28 * $DragonFly: src/sys/bus/cam/scsi/scsi_pass.c,v 1.15 2006/03/24 18:35:27 dillon Exp $
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
34 #include <sys/types.h>
36 #include <sys/malloc.h>
37 #include <sys/fcntl.h>
42 #include <sys/errno.h>
43 #include <sys/devicestat.h>
46 #include <sys/thread2.h>
49 #include "../cam_ccb.h"
50 #include "../cam_extend.h"
51 #include "../cam_periph.h"
52 #include "../cam_xpt_periph.h"
53 #include "../cam_debug.h"
56 #include "scsi_message.h"
58 #include "scsi_pass.h"
61 PASS_FLAG_OPEN = 0x01,
62 PASS_FLAG_LOCKED = 0x02,
63 PASS_FLAG_INVALID = 0x04
75 #define ccb_type ppriv_field0
76 #define ccb_bio ppriv_ptr1
82 struct bio_queue_head bio_queue;
84 struct devstat device_stats;
87 #define PASS_CDEV_MAJOR 31
89 static d_open_t passopen;
90 static d_close_t passclose;
91 static d_ioctl_t passioctl;
92 static d_strategy_t passstrategy;
94 static periph_init_t passinit;
95 static periph_ctor_t passregister;
96 static periph_oninv_t passoninvalidate;
97 static periph_dtor_t passcleanup;
98 static periph_start_t passstart;
99 static void passasync(void *callback_arg, u_int32_t code,
100 struct cam_path *path, void *arg);
101 static void passdone(struct cam_periph *periph,
102 union ccb *done_ccb);
103 static int passerror(union ccb *ccb, u_int32_t cam_flags,
104 u_int32_t sense_flags);
105 static int passsendccb(struct cam_periph *periph, union ccb *ccb,
108 static struct periph_driver passdriver =
111 TAILQ_HEAD_INITIALIZER(passdriver.units), /* generation */ 0
114 DATA_SET(periphdriver_set, passdriver);
116 static struct cdevsw pass_cdevsw = {
118 /* maj */ PASS_CDEV_MAJOR,
124 /* close */ passclose,
126 /* write */ physwrite,
127 /* ioctl */ passioctl,
130 /* strategy */ passstrategy,
135 static struct extend_array *passperiphs;
141 struct cam_path *path;
144 * Create our extend array for storing the devices we attach to.
146 passperiphs = cam_extend_new();
147 if (passperiphs == NULL) {
148 printf("passm: Failed to alloc extend array!\n");
153 * Install a global async callback. This callback will
154 * receive async callbacks like "new device found".
156 status = xpt_create_path(&path, /*periph*/NULL, CAM_XPT_PATH_ID,
157 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
159 if (status == CAM_REQ_CMP) {
160 struct ccb_setasync csa;
162 xpt_setup_ccb(&csa.ccb_h, path, /*priority*/5);
163 csa.ccb_h.func_code = XPT_SASYNC_CB;
164 csa.event_enable = AC_FOUND_DEVICE;
165 csa.callback = passasync;
166 csa.callback_arg = NULL;
167 xpt_action((union ccb *)&csa);
168 status = csa.ccb_h.status;
172 if (status != CAM_REQ_CMP) {
173 printf("pass: Failed to attach master async callback "
174 "due to status 0x%x!\n", status);
180 passoninvalidate(struct cam_periph *periph)
182 struct pass_softc *softc;
185 struct ccb_setasync csa;
187 softc = (struct pass_softc *)periph->softc;
190 * De-register any async callbacks.
192 xpt_setup_ccb(&csa.ccb_h, periph->path,
194 csa.ccb_h.func_code = XPT_SASYNC_CB;
195 csa.event_enable = 0;
196 csa.callback = passasync;
197 csa.callback_arg = periph;
198 xpt_action((union ccb *)&csa);
200 softc->flags |= PASS_FLAG_INVALID;
203 * We need to be in a critical section here to keep the buffer
204 * queue from being modified while we traverse it.
209 * Return all queued I/O with ENXIO.
210 * XXX Handle any transactions queued to the card
211 * with XPT_ABORT_CCB.
213 while ((q_bio = bioq_first(&softc->bio_queue)) != NULL){
214 bioq_remove(&softc->bio_queue, q_bio);
215 q_bp = q_bio->bio_buf;
216 q_bp->b_resid = q_bp->b_bcount;
217 q_bp->b_error = ENXIO;
218 q_bp->b_flags |= B_ERROR;
224 xpt_print_path(periph->path);
225 printf("lost device\n");
231 passcleanup(struct cam_periph *periph)
233 struct pass_softc *softc;
235 softc = (struct pass_softc *)periph->softc;
237 devstat_remove_entry(&softc->device_stats);
239 cam_extend_release(passperiphs, periph->unit_number);
242 xpt_print_path(periph->path);
243 printf("removing device entry\n");
245 cdevsw_remove(&pass_cdevsw, -1, periph->unit_number);
246 free(softc, M_DEVBUF);
250 passasync(void *callback_arg, u_int32_t code,
251 struct cam_path *path, void *arg)
253 struct cam_periph *periph;
255 periph = (struct cam_periph *)callback_arg;
258 case AC_FOUND_DEVICE:
260 struct ccb_getdev *cgd;
263 cgd = (struct ccb_getdev *)arg;
266 * Allocate a peripheral instance for
267 * this device and start the probe
270 status = cam_periph_alloc(passregister, passoninvalidate,
271 passcleanup, passstart, "pass",
272 CAM_PERIPH_BIO, cgd->ccb_h.path,
273 passasync, AC_FOUND_DEVICE, cgd);
275 if (status != CAM_REQ_CMP
276 && status != CAM_REQ_INPROG)
277 printf("passasync: Unable to attach new device "
278 "due to status 0x%x\n", status);
283 cam_periph_async(periph, code, path, arg);
289 passregister(struct cam_periph *periph, void *arg)
291 struct pass_softc *softc;
292 struct ccb_setasync csa;
293 struct ccb_getdev *cgd;
295 cgd = (struct ccb_getdev *)arg;
296 if (periph == NULL) {
297 printf("passregister: periph was NULL!!\n");
298 return(CAM_REQ_CMP_ERR);
302 printf("passregister: no getdev CCB, can't register device\n");
303 return(CAM_REQ_CMP_ERR);
306 softc = malloc(sizeof(*softc), M_DEVBUF, M_INTWAIT | M_ZERO);
307 softc->state = PASS_STATE_NORMAL;
308 softc->pd_type = SID_TYPE(&cgd->inq_data);
309 bioq_init(&softc->bio_queue);
311 periph->softc = softc;
313 cam_extend_set(passperiphs, periph->unit_number, periph);
315 * We pass in 0 for a blocksize, since we don't
316 * know what the blocksize of this device is, if
317 * it even has a blocksize.
319 devstat_add_entry(&softc->device_stats, "pass", periph->unit_number,
320 0, DEVSTAT_NO_BLOCKSIZE | DEVSTAT_NO_ORDERED_TAGS,
322 DEVSTAT_TYPE_IF_SCSI |
324 DEVSTAT_PRIORITY_PASS);
326 /* Register the device */
327 cdevsw_add(&pass_cdevsw, -1, periph->unit_number);
328 make_dev(&pass_cdevsw, periph->unit_number, UID_ROOT,
329 GID_OPERATOR, 0600, "%s%d", periph->periph_name,
330 periph->unit_number);
333 * Add an async callback so that we get
334 * notified if this device goes away.
336 xpt_setup_ccb(&csa.ccb_h, periph->path, /* priority */ 5);
337 csa.ccb_h.func_code = XPT_SASYNC_CB;
338 csa.event_enable = AC_LOST_DEVICE;
339 csa.callback = passasync;
340 csa.callback_arg = periph;
341 xpt_action((union ccb *)&csa);
344 xpt_announce_periph(periph, NULL);
350 passopen(dev_t dev, int flags, int fmt, struct thread *td)
352 struct cam_periph *periph;
353 struct pass_softc *softc;
356 error = 0; /* default to no error */
358 /* unit = dkunit(dev); */
359 /* XXX KDM fix this */
360 unit = minor(dev) & 0xff;
362 periph = cam_extend_get(passperiphs, unit);
367 softc = (struct pass_softc *)periph->softc;
370 if (softc->flags & PASS_FLAG_INVALID) {
376 * Don't allow access when we're running at a high securelvel.
378 if (securelevel > 1) {
384 * Only allow read-write access.
386 if (((flags & FWRITE) == 0) || ((flags & FREAD) == 0)) {
392 * We don't allow nonblocking access.
394 if ((flags & O_NONBLOCK) != 0) {
395 xpt_print_path(periph->path);
396 printf("can't do nonblocking accesss\n");
401 if ((error = cam_periph_lock(periph, PCATCH)) != 0) {
408 if ((softc->flags & PASS_FLAG_OPEN) == 0) {
409 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
411 softc->flags |= PASS_FLAG_OPEN;
414 cam_periph_unlock(periph);
420 passclose(dev_t dev, int flag, int fmt, struct thread *td)
422 struct cam_periph *periph;
423 struct pass_softc *softc;
426 /* unit = dkunit(dev); */
427 /* XXX KDM fix this */
428 unit = minor(dev) & 0xff;
430 periph = cam_extend_get(passperiphs, unit);
434 softc = (struct pass_softc *)periph->softc;
436 if ((error = cam_periph_lock(periph, 0)) != 0)
439 softc->flags &= ~PASS_FLAG_OPEN;
441 cam_periph_unlock(periph);
442 cam_periph_release(periph);
448 * Actually translate the requested transfer into one the physical driver
449 * can understand. The transfer is described by a buf and will include
450 * only one physical transfer.
453 passstrategy(dev_t dev, struct bio *bio)
455 struct buf *bp = bio->bio_buf;
456 struct cam_periph *periph;
457 struct pass_softc *softc;
461 * The read/write interface for the passthrough driver doesn't
462 * really work right now. So, we just pass back EINVAL to tell the
465 bp->b_error = EINVAL;
468 /* unit = dkunit(dev); */
469 /* XXX KDM fix this */
470 unit = minor(dev) & 0xff;
472 periph = cam_extend_get(passperiphs, unit);
473 if (periph == NULL) {
477 softc = (struct pass_softc *)periph->softc;
480 * Odd number of bytes or negative offset
483 if (bio->bio_offset < 0) {
484 bp->b_error = EINVAL;
489 * Mask interrupts so that the pack cannot be invalidated until
490 * after we are in the queue. Otherwise, we might not properly
491 * clean up one of the buffers.
494 bioq_insert_tail(&softc->bio_queue, bio);
498 * Schedule ourselves for performing the work.
500 xpt_schedule(periph, /* XXX priority */1);
504 bp->b_flags |= B_ERROR;
507 * Correctly set the buf to indicate a completed xfer
509 bp->b_resid = bp->b_bcount;
514 passstart(struct cam_periph *periph, union ccb *start_ccb)
516 struct pass_softc *softc;
518 softc = (struct pass_softc *)periph->softc;
520 switch (softc->state) {
521 case PASS_STATE_NORMAL:
527 bio = bioq_first(&softc->bio_queue);
528 if (periph->immediate_priority <= periph->pinfo.priority) {
529 start_ccb->ccb_h.ccb_type = PASS_CCB_WAITING;
530 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
532 periph->immediate_priority = CAM_PRIORITY_NONE;
534 wakeup(&periph->ccb_list);
535 } else if (bio == NULL) {
537 xpt_release_ccb(start_ccb);
540 bioq_remove(&softc->bio_queue, bio);
543 devstat_start_transaction(&softc->device_stats);
547 * Interpret the contents of the bp as a CCB
548 * and pass it to a routine shared by our ioctl
550 * For now, just biodone it with EIO so we don't
554 bp->b_flags |= B_ERROR;
555 bp->b_resid = bp->b_bcount;
557 bio = bioq_first(&softc->bio_queue);
560 xpt_action(start_ccb);
564 /* Have more work to do, so ensure we stay scheduled */
565 xpt_schedule(periph, /* XXX priority */1);
572 passdone(struct cam_periph *periph, union ccb *done_ccb)
574 struct pass_softc *softc;
575 struct ccb_scsiio *csio;
577 softc = (struct pass_softc *)periph->softc;
578 csio = &done_ccb->csio;
579 switch (csio->ccb_h.ccb_type) {
580 case PASS_CCB_BUFFER_IO:
585 u_int8_t scsi_status;
586 devstat_trans_flags ds_flags;
588 status = done_ccb->ccb_h.status;
589 scsi_status = done_ccb->csio.scsi_status;
590 bio = (struct bio *)done_ccb->ccb_h.ccb_bio;
593 /* XXX handle errors */
594 if (!(((status & CAM_STATUS_MASK) == CAM_REQ_CMP)
595 && (scsi_status == SCSI_STATUS_OK))) {
598 if ((error = passerror(done_ccb, 0, 0)) == ERESTART) {
600 * A retry was scheuled, so
607 * XXX unfreeze the queue after we complete
611 bp->b_flags |= B_ERROR;
614 if ((done_ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_IN)
615 ds_flags = DEVSTAT_READ;
616 else if ((done_ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_OUT)
617 ds_flags = DEVSTAT_WRITE;
619 ds_flags = DEVSTAT_NO_DATA;
621 devstat_end_transaction_buf(&softc->device_stats, bp);
625 case PASS_CCB_WAITING:
627 /* Caller will release the CCB */
628 wakeup(&done_ccb->ccb_h.cbfcnp);
632 xpt_release_ccb(done_ccb);
636 passioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
638 struct cam_periph *periph;
639 struct pass_softc *softc;
644 /* unit = dkunit(dev); */
645 /* XXX KDM fix this */
646 unit = minor(dev) & 0xff;
648 periph = cam_extend_get(passperiphs, unit);
653 softc = (struct pass_softc *)periph->softc;
665 inccb = (union ccb *)addr;
668 * Some CCB types, like scan bus and scan lun can only go
669 * through the transport layer device.
671 if (inccb->ccb_h.func_code & XPT_FC_XPT_ONLY) {
672 xpt_print_path(periph->path);
673 printf("CCB function code %#x is restricted to the "
674 "XPT device\n", inccb->ccb_h.func_code);
680 * Non-immediate CCBs need a CCB from the per-device pool
681 * of CCBs, which is scheduled by the transport layer.
682 * Immediate CCBs and user-supplied CCBs should just be
685 if ((inccb->ccb_h.func_code & XPT_FC_QUEUED)
686 && ((inccb->ccb_h.func_code & XPT_FC_USER_CCB) == 0)) {
687 ccb = cam_periph_getccb(periph,
688 inccb->ccb_h.pinfo.priority);
691 ccb = xpt_alloc_ccb();
694 xpt_setup_ccb(&ccb->ccb_h, periph->path,
695 inccb->ccb_h.pinfo.priority);
700 xpt_print_path(periph->path);
701 printf("unable to allocate CCB\n");
706 error = passsendccb(periph, ccb, inccb);
711 xpt_release_ccb(ccb);
716 error = cam_periph_ioctl(periph, cmd, addr, passerror);
724 * Generally, "ccb" should be the CCB supplied by the kernel. "inccb"
725 * should be the CCB that is copied in from the user.
728 passsendccb(struct cam_periph *periph, union ccb *ccb, union ccb *inccb)
730 struct pass_softc *softc;
731 struct cam_periph_map_info mapinfo;
732 int error, need_unmap;
734 softc = (struct pass_softc *)periph->softc;
739 * There are some fields in the CCB header that need to be
740 * preserved, the rest we get from the user.
742 xpt_merge_ccb(ccb, inccb);
745 * There's no way for the user to have a completion
746 * function, so we put our own completion function in here.
748 ccb->ccb_h.cbfcnp = passdone;
751 * We only attempt to map the user memory into kernel space
752 * if they haven't passed in a physical memory pointer,
753 * and if there is actually an I/O operation to perform.
754 * Right now cam_periph_mapmem() only supports SCSI and device
755 * match CCBs. For the SCSI CCBs, we only pass the CCB in if
756 * there's actually data to map. cam_periph_mapmem() will do the
757 * right thing, even if there isn't data to map, but since CCBs
758 * without data are a reasonably common occurance (e.g. test unit
759 * ready), it will save a few cycles if we check for it here.
761 if (((ccb->ccb_h.flags & CAM_DATA_PHYS) == 0)
762 && (((ccb->ccb_h.func_code == XPT_SCSI_IO)
763 && ((ccb->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE))
764 || (ccb->ccb_h.func_code == XPT_DEV_MATCH))) {
766 bzero(&mapinfo, sizeof(mapinfo));
768 error = cam_periph_mapmem(ccb, &mapinfo);
771 * cam_periph_mapmem returned an error, we can't continue.
772 * Return the error to the user.
778 * We successfully mapped the memory in, so we need to
779 * unmap it when the transaction is done.
785 * If the user wants us to perform any error recovery, then honor
786 * that request. Otherwise, it's up to the user to perform any
789 error = cam_periph_runccb(ccb,
790 (ccb->ccb_h.flags & CAM_PASS_ERR_RECOVER) ?
793 /* sense_flags */SF_RETRY_UA | SF_RETRY_SELTO,
794 &softc->device_stats);
797 cam_periph_unmapmem(ccb, &mapinfo);
799 ccb->ccb_h.cbfcnp = NULL;
800 ccb->ccb_h.periph_priv = inccb->ccb_h.periph_priv;
801 bcopy(ccb, inccb, sizeof(union ccb));
807 passerror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
809 struct cam_periph *periph;
810 struct pass_softc *softc;
812 periph = xpt_path_periph(ccb->ccb_h.path);
813 softc = (struct pass_softc *)periph->softc;
815 return(cam_periph_error(ccb, cam_flags, sense_flags,