2 * Implementation of SCSI Processor Target Peripheral driver for CAM.
4 * Copyright (c) 1998 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_pt.c,v 1.17 2000/01/17 06:27:37 mjacob Exp $
29 * $DragonFly: src/sys/bus/cam/scsi/scsi_pt.c,v 1.18 2006/12/22 23:12:16 swildner Exp $
32 #include <sys/param.h>
33 #include <sys/queue.h>
34 #include <sys/systm.h>
35 #include <sys/kernel.h>
36 #include <sys/types.h>
38 #include <sys/devicestat.h>
39 #include <sys/malloc.h>
43 #include <sys/thread2.h>
46 #include "../cam_ccb.h"
47 #include "../cam_extend.h"
48 #include "../cam_periph.h"
49 #include "../cam_xpt_periph.h"
50 #include "../cam_debug.h"
53 #include "scsi_message.h"
66 PT_FLAG_DEVICE_INVALID = 0x02,
67 PT_FLAG_RETRY_UA = 0x04
71 PT_CCB_BUFFER_IO = 0x01,
72 PT_CCB_WAITING = 0x02,
73 PT_CCB_RETRY_UA = 0x04,
74 PT_CCB_BUFFER_IO_UA = PT_CCB_BUFFER_IO|PT_CCB_RETRY_UA
77 /* Offsets into our private area for storing information */
78 #define ccb_state ppriv_field0
79 #define ccb_bio ppriv_ptr1
82 struct bio_queue_head bio_queue;
83 struct devstat device_stats;
84 LIST_HEAD(, ccb_hdr) pending_ccbs;
92 static d_open_t ptopen;
93 static d_close_t ptclose;
94 static d_strategy_t ptstrategy;
95 static periph_init_t ptinit;
96 static void ptasync(void *callback_arg, u_int32_t code,
97 struct cam_path *path, void *arg);
98 static periph_ctor_t ptctor;
99 static periph_oninv_t ptoninvalidate;
100 static periph_dtor_t ptdtor;
101 static periph_start_t ptstart;
102 static void ptdone(struct cam_periph *periph,
103 union ccb *done_ccb);
104 static d_ioctl_t ptioctl;
105 static int pterror(union ccb *ccb, u_int32_t cam_flags,
106 u_int32_t sense_flags);
108 void scsi_send_receive(struct ccb_scsiio *csio, u_int32_t retries,
109 void (*cbfcnp)(struct cam_periph *, union ccb *),
110 u_int tag_action, int readop, u_int byte2,
111 u_int32_t xfer_len, u_int8_t *data_ptr,
112 u_int8_t sense_len, u_int32_t timeout);
114 static struct periph_driver ptdriver =
117 TAILQ_HEAD_INITIALIZER(ptdriver.units), /* generation */ 0
120 DATA_SET(periphdriver_set, ptdriver);
122 #define PT_CDEV_MAJOR 61
124 static struct dev_ops pt_ops = {
125 { "pt", PT_CDEV_MAJOR, 0 },
129 .d_write = physwrite,
131 .d_strategy = ptstrategy,
134 static struct extend_array *ptperiphs;
136 #ifndef SCSI_PT_DEFAULT_TIMEOUT
137 #define SCSI_PT_DEFAULT_TIMEOUT 60
141 ptopen(struct dev_open_args *ap)
143 cdev_t dev = ap->a_head.a_dev;
144 struct cam_periph *periph;
145 struct pt_softc *softc;
150 periph = cam_extend_get(ptperiphs, unit);
154 softc = (struct pt_softc *)periph->softc;
157 if (softc->flags & PT_FLAG_DEVICE_INVALID) {
162 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
163 ("ptopen: dev=%s (unit %d)\n", devtoname(dev), unit));
165 if ((error = cam_periph_lock(periph, PCATCH)) != 0) {
167 return (error); /* error code from tsleep */
172 if ((softc->flags & PT_FLAG_OPEN) == 0) {
173 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
176 softc->flags |= PT_FLAG_OPEN;
180 cam_periph_unlock(periph);
185 ptclose(struct dev_close_args *ap)
187 cdev_t dev = ap->a_head.a_dev;
188 struct cam_periph *periph;
189 struct pt_softc *softc;
194 periph = cam_extend_get(ptperiphs, unit);
198 softc = (struct pt_softc *)periph->softc;
200 if ((error = cam_periph_lock(periph, 0)) != 0)
201 return (error); /* error code from tsleep */
203 softc->flags &= ~PT_FLAG_OPEN;
204 cam_periph_unlock(periph);
205 cam_periph_release(periph);
210 * Actually translate the requested transfer into one the physical driver
211 * can understand. The transfer is described by a buf and will include
212 * only one physical transfer.
215 ptstrategy(struct dev_strategy_args *ap)
217 cdev_t dev = ap->a_head.a_dev;
218 struct bio *bio = ap->a_bio;
219 struct buf *bp = bio->bio_buf;
220 struct cam_periph *periph;
221 struct pt_softc *softc;
225 periph = cam_extend_get(ptperiphs, unit);
226 if (periph == NULL) {
230 softc = (struct pt_softc *)periph->softc;
233 * Mask interrupts so that the pack cannot be invalidated until
234 * after we are in the queue. Otherwise, we might not properly
235 * clean up one of the buffers.
240 * If the device has been made invalid, error out
242 if ((softc->flags & PT_FLAG_DEVICE_INVALID)) {
249 * Place it in the queue of disk activities for this disk
251 bioq_insert_tail(&softc->bio_queue, bio);
256 * Schedule ourselves for performing the work.
258 xpt_schedule(periph, /* XXX priority */1);
262 bp->b_flags |= B_ERROR;
265 * Correctly set the buf to indicate a completed xfer
267 bp->b_resid = bp->b_bcount;
276 struct cam_path *path;
279 * Create our extend array for storing the devices we attach to.
281 ptperiphs = cam_extend_new();
282 if (ptperiphs == NULL) {
283 kprintf("pt: Failed to alloc extend array!\n");
288 * Install a global async callback. This callback will
289 * receive async callbacks like "new device found".
291 status = xpt_create_path(&path, /*periph*/NULL, CAM_XPT_PATH_ID,
292 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
294 if (status == CAM_REQ_CMP) {
295 struct ccb_setasync csa;
297 xpt_setup_ccb(&csa.ccb_h, path, /*priority*/5);
298 csa.ccb_h.func_code = XPT_SASYNC_CB;
299 csa.event_enable = AC_FOUND_DEVICE;
300 csa.callback = ptasync;
301 csa.callback_arg = NULL;
302 xpt_action((union ccb *)&csa);
303 status = csa.ccb_h.status;
307 if (status != CAM_REQ_CMP) {
308 kprintf("pt: Failed to attach master async callback "
309 "due to status 0x%x!\n", status);
314 ptctor(struct cam_periph *periph, void *arg)
316 struct pt_softc *softc;
317 struct ccb_setasync csa;
318 struct ccb_getdev *cgd;
320 cgd = (struct ccb_getdev *)arg;
321 if (periph == NULL) {
322 kprintf("ptregister: periph was NULL!!\n");
323 return(CAM_REQ_CMP_ERR);
327 kprintf("ptregister: no getdev CCB, can't register device\n");
328 return(CAM_REQ_CMP_ERR);
331 softc = kmalloc(sizeof(*softc), M_DEVBUF, M_INTWAIT | M_ZERO);
332 LIST_INIT(&softc->pending_ccbs);
333 softc->state = PT_STATE_NORMAL;
334 bioq_init(&softc->bio_queue);
336 softc->io_timeout = SCSI_PT_DEFAULT_TIMEOUT * 1000;
338 periph->softc = softc;
340 cam_extend_set(ptperiphs, periph->unit_number, periph);
342 devstat_add_entry(&softc->device_stats, "pt",
343 periph->unit_number, 0,
344 DEVSTAT_NO_BLOCKSIZE,
345 SID_TYPE(&cgd->inq_data) | DEVSTAT_TYPE_IF_SCSI,
346 DEVSTAT_PRIORITY_OTHER);
348 dev_ops_add(&pt_ops, -1, periph->unit_number);
349 make_dev(&pt_ops, periph->unit_number, UID_ROOT,
350 GID_OPERATOR, 0600, "%s%d", periph->periph_name,
351 periph->unit_number);
353 * Add async callbacks for bus reset and
354 * bus device reset calls. I don't bother
355 * checking if this fails as, in most cases,
356 * the system will function just fine without
357 * them and the only alternative would be to
358 * not attach the device on failure.
360 xpt_setup_ccb(&csa.ccb_h, periph->path, /*priority*/5);
361 csa.ccb_h.func_code = XPT_SASYNC_CB;
362 csa.event_enable = AC_SENT_BDR | AC_BUS_RESET | AC_LOST_DEVICE;
363 csa.callback = ptasync;
364 csa.callback_arg = periph;
365 xpt_action((union ccb *)&csa);
367 /* Tell the user we've attached to the device */
368 xpt_announce_periph(periph, NULL);
374 ptoninvalidate(struct cam_periph *periph)
376 struct pt_softc *softc;
379 struct ccb_setasync csa;
381 softc = (struct pt_softc *)periph->softc;
384 * De-register any async callbacks.
386 xpt_setup_ccb(&csa.ccb_h, periph->path,
388 csa.ccb_h.func_code = XPT_SASYNC_CB;
389 csa.event_enable = 0;
390 csa.callback = ptasync;
391 csa.callback_arg = periph;
392 xpt_action((union ccb *)&csa);
394 softc->flags |= PT_FLAG_DEVICE_INVALID;
397 * We need to be in a critical section here to keep the buffer
398 * queue from being modified while we traverse it.
403 * Return all queued I/O with ENXIO.
404 * XXX Handle any transactions queued to the card
405 * with XPT_ABORT_CCB.
407 while ((q_bio = bioq_first(&softc->bio_queue)) != NULL){
408 bioq_remove(&softc->bio_queue, q_bio);
409 q_bp = q_bio->bio_buf;
410 q_bp->b_resid = q_bp->b_bcount;
411 q_bp->b_error = ENXIO;
412 q_bp->b_flags |= B_ERROR;
418 xpt_print_path(periph->path);
419 kprintf("lost device\n");
423 ptdtor(struct cam_periph *periph)
425 struct pt_softc *softc;
427 softc = (struct pt_softc *)periph->softc;
429 devstat_remove_entry(&softc->device_stats);
431 cam_extend_release(ptperiphs, periph->unit_number);
432 xpt_print_path(periph->path);
433 kprintf("removing device entry\n");
434 dev_ops_remove(&pt_ops, -1, periph->unit_number);
435 kfree(softc, M_DEVBUF);
439 ptasync(void *callback_arg, u_int32_t code, struct cam_path *path, void *arg)
441 struct cam_periph *periph;
443 periph = (struct cam_periph *)callback_arg;
445 case AC_FOUND_DEVICE:
447 struct ccb_getdev *cgd;
450 cgd = (struct ccb_getdev *)arg;
452 if (SID_TYPE(&cgd->inq_data) != T_PROCESSOR)
456 * Allocate a peripheral instance for
457 * this device and start the probe
460 status = cam_periph_alloc(ptctor, ptoninvalidate, ptdtor,
461 ptstart, "pt", CAM_PERIPH_BIO,
462 cgd->ccb_h.path, ptasync,
463 AC_FOUND_DEVICE, cgd);
465 if (status != CAM_REQ_CMP
466 && status != CAM_REQ_INPROG)
467 kprintf("ptasync: Unable to attach to new device "
468 "due to status 0x%x\n", status);
474 struct pt_softc *softc;
475 struct ccb_hdr *ccbh;
477 softc = (struct pt_softc *)periph->softc;
480 * Don't fail on the expected unit attention
483 softc->flags |= PT_FLAG_RETRY_UA;
484 for (ccbh = LIST_FIRST(&softc->pending_ccbs);
485 ccbh != NULL; ccbh = LIST_NEXT(ccbh, periph_links.le))
486 ccbh->ccb_state |= PT_CCB_RETRY_UA;
491 cam_periph_async(periph, code, path, arg);
497 ptstart(struct cam_periph *periph, union ccb *start_ccb)
499 struct pt_softc *softc;
503 softc = (struct pt_softc *)periph->softc;
506 * See if there is a buf with work for us to do..
509 bio = bioq_first(&softc->bio_queue);
510 if (periph->immediate_priority <= periph->pinfo.priority) {
511 CAM_DEBUG_PRINT(CAM_DEBUG_SUBTRACE,
512 ("queuing for immediate ccb\n"));
513 start_ccb->ccb_h.ccb_state = PT_CCB_WAITING;
514 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
516 periph->immediate_priority = CAM_PRIORITY_NONE;
518 wakeup(&periph->ccb_list);
519 } else if (bio == NULL) {
521 xpt_release_ccb(start_ccb);
523 bioq_remove(&softc->bio_queue, bio);
526 devstat_start_transaction(&softc->device_stats);
528 scsi_send_receive(&start_ccb->csio,
532 (bp->b_cmd == BUF_CMD_READ),
536 /*sense_len*/SSD_FULL_SIZE,
537 /*timeout*/softc->io_timeout);
539 start_ccb->ccb_h.ccb_state = PT_CCB_BUFFER_IO;
542 * Block out any asyncronous callbacks
543 * while we touch the pending ccb list.
545 LIST_INSERT_HEAD(&softc->pending_ccbs, &start_ccb->ccb_h,
548 start_ccb->ccb_h.ccb_bio = bio;
549 bio = bioq_first(&softc->bio_queue);
552 xpt_action(start_ccb);
555 /* Have more work to do, so ensure we stay scheduled */
556 xpt_schedule(periph, /* XXX priority */1);
562 ptdone(struct cam_periph *periph, union ccb *done_ccb)
564 struct pt_softc *softc;
565 struct ccb_scsiio *csio;
567 softc = (struct pt_softc *)periph->softc;
568 csio = &done_ccb->csio;
569 switch (csio->ccb_h.ccb_state) {
570 case PT_CCB_BUFFER_IO:
571 case PT_CCB_BUFFER_IO_UA:
576 bio = (struct bio *)done_ccb->ccb_h.ccb_bio;
579 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
583 if ((csio->ccb_h.ccb_state & PT_CCB_RETRY_UA) != 0)
588 sf |= SF_RETRY_SELTO;
590 if ((error = pterror(done_ccb, 0, sf)) == ERESTART) {
592 * A retry was scheuled, so
603 if (error == ENXIO) {
605 * Catastrophic error. Mark our device
608 xpt_print_path(periph->path);
609 kprintf("Invalidating device\n");
610 softc->flags |= PT_FLAG_DEVICE_INVALID;
614 * return all queued I/O with EIO, so that
615 * the client can retry these I/Os in the
616 * proper order should it attempt to recover.
618 while ((q_bio = bioq_first(&softc->bio_queue))
620 bioq_remove(&softc->bio_queue, q_bio);
621 q_bp = q_bio->bio_buf;
622 q_bp->b_resid = q_bp->b_bcount;
624 q_bp->b_flags |= B_ERROR;
629 bp->b_resid = bp->b_bcount;
630 bp->b_flags |= B_ERROR;
632 bp->b_resid = csio->resid;
634 if (bp->b_resid != 0) {
635 /* Short transfer ??? */
636 bp->b_flags |= B_ERROR;
639 if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
640 cam_release_devq(done_ccb->ccb_h.path,
646 bp->b_resid = csio->resid;
647 if (bp->b_resid != 0)
648 bp->b_flags |= B_ERROR;
652 * Block out any asyncronous callbacks
653 * while we touch the pending ccb list.
656 LIST_REMOVE(&done_ccb->ccb_h, periph_links.le);
659 devstat_end_transaction_buf(&softc->device_stats, bp);
664 /* Caller will release the CCB */
665 wakeup(&done_ccb->ccb_h.cbfcnp);
668 xpt_release_ccb(done_ccb);
672 pterror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
674 struct pt_softc *softc;
675 struct cam_periph *periph;
677 periph = xpt_path_periph(ccb->ccb_h.path);
678 softc = (struct pt_softc *)periph->softc;
680 return(cam_periph_error(ccb, cam_flags, sense_flags,
685 ptioctl(struct dev_ioctl_args *ap)
687 cdev_t dev = ap->a_head.a_dev;
688 caddr_t addr = ap->a_data;
689 struct cam_periph *periph;
690 struct pt_softc *softc;
695 periph = cam_extend_get(ptperiphs, unit);
700 softc = (struct pt_softc *)periph->softc;
702 if ((error = cam_periph_lock(periph, PCATCH)) != 0) {
703 return (error); /* error code from tsleep */
707 case PTIOCGETTIMEOUT:
708 if (softc->io_timeout >= 1000)
709 *(int *)addr = softc->io_timeout / 1000;
713 case PTIOCSETTIMEOUT:
715 if (*(int *)addr < 1) {
721 softc->io_timeout = *(int *)addr * 1000;
727 error = cam_periph_ioctl(periph, ap->a_cmd, addr, pterror);
731 cam_periph_unlock(periph);
737 scsi_send_receive(struct ccb_scsiio *csio, u_int32_t retries,
738 void (*cbfcnp)(struct cam_periph *, union ccb *),
739 u_int tag_action, int readop, u_int byte2,
740 u_int32_t xfer_len, u_int8_t *data_ptr, u_int8_t sense_len,
743 struct scsi_send_receive *scsi_cmd;
745 scsi_cmd = (struct scsi_send_receive *)&csio->cdb_io.cdb_bytes;
746 scsi_cmd->opcode = readop ? RECEIVE : SEND;
747 scsi_cmd->byte2 = byte2;
748 scsi_ulto3b(xfer_len, scsi_cmd->xfer_len);
749 scsi_cmd->control = 0;
754 /*flags*/readop ? CAM_DIR_IN : CAM_DIR_OUT,