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
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
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>
44 #include <cam/cam_ccb.h>
45 #include <cam/cam_periph.h>
46 #include <cam/cam_xpt_periph.h>
47 #include <cam/cam_debug.h>
49 #include <cam/scsi/scsi_all.h>
50 #include <cam/scsi/scsi_message.h>
51 #include <cam/scsi/scsi_pt.h>
63 PT_FLAG_DEVICE_INVALID = 0x02,
64 PT_FLAG_RETRY_UA = 0x04
68 PT_CCB_BUFFER_IO = 0x01,
69 PT_CCB_WAITING = 0x02,
70 PT_CCB_RETRY_UA = 0x04,
71 PT_CCB_BUFFER_IO_UA = PT_CCB_BUFFER_IO|PT_CCB_RETRY_UA
74 /* Offsets into our private area for storing information */
75 #define ccb_state ppriv_field0
76 #define ccb_bp ppriv_ptr1
79 struct bio_queue_head bio_queue;
80 struct devstat *device_stats;
81 LIST_HEAD(, ccb_hdr) pending_ccbs;
89 static d_open_t ptopen;
90 static d_close_t ptclose;
91 static d_strategy_t ptstrategy;
92 static periph_init_t ptinit;
93 static void ptasync(void *callback_arg, u_int32_t code,
94 struct cam_path *path, void *arg);
95 static periph_ctor_t ptctor;
96 static periph_oninv_t ptoninvalidate;
97 static periph_dtor_t ptdtor;
98 static periph_start_t ptstart;
99 static void ptdone(struct cam_periph *periph,
100 union ccb *done_ccb);
101 static d_ioctl_t ptioctl;
102 static int pterror(union ccb *ccb, u_int32_t cam_flags,
103 u_int32_t sense_flags);
105 void scsi_send_receive(struct ccb_scsiio *csio, u_int32_t retries,
106 void (*cbfcnp)(struct cam_periph *, union ccb *),
107 u_int tag_action, int readop, u_int byte2,
108 u_int32_t xfer_len, u_int8_t *data_ptr,
109 u_int8_t sense_len, u_int32_t timeout);
111 static struct periph_driver ptdriver =
114 TAILQ_HEAD_INITIALIZER(ptdriver.units), /* generation */ 0
117 PERIPHDRIVER_DECLARE(pt, ptdriver);
120 static struct cdevsw pt_cdevsw = {
121 .d_version = D_VERSION,
126 .d_write = physwrite,
128 .d_strategy = ptstrategy,
132 #ifndef SCSI_PT_DEFAULT_TIMEOUT
133 #define SCSI_PT_DEFAULT_TIMEOUT 60
137 ptopen(struct cdev *dev, int flags, int fmt, struct thread *td)
139 struct cam_periph *periph;
140 struct pt_softc *softc;
143 periph = (struct cam_periph *)dev->si_drv1;
144 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
147 softc = (struct pt_softc *)periph->softc;
149 cam_periph_lock(periph);
150 if (softc->flags & PT_FLAG_DEVICE_INVALID) {
151 cam_periph_release_locked(periph);
152 cam_periph_unlock(periph);
156 if ((softc->flags & PT_FLAG_OPEN) == 0)
157 softc->flags |= PT_FLAG_OPEN;
160 cam_periph_release(periph);
163 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
164 ("ptopen: dev=%s\n", devtoname(dev)));
166 cam_periph_unlock(periph);
171 ptclose(struct cdev *dev, int flag, int fmt, struct thread *td)
173 struct cam_periph *periph;
174 struct pt_softc *softc;
176 periph = (struct cam_periph *)dev->si_drv1;
180 softc = (struct pt_softc *)periph->softc;
182 cam_periph_lock(periph);
184 softc->flags &= ~PT_FLAG_OPEN;
185 cam_periph_release_locked(periph);
186 cam_periph_unlock(periph);
191 * Actually translate the requested transfer into one the physical driver
192 * can understand. The transfer is described by a buf and will include
193 * only one physical transfer.
196 ptstrategy(struct bio *bp)
198 struct cam_periph *periph;
199 struct pt_softc *softc;
201 periph = (struct cam_periph *)bp->bio_dev->si_drv1;
202 bp->bio_resid = bp->bio_bcount;
203 if (periph == NULL) {
204 biofinish(bp, NULL, ENXIO);
207 cam_periph_lock(periph);
208 softc = (struct pt_softc *)periph->softc;
211 * If the device has been made invalid, error out
213 if ((softc->flags & PT_FLAG_DEVICE_INVALID)) {
214 cam_periph_unlock(periph);
215 biofinish(bp, NULL, ENXIO);
220 * Place it in the queue of disk activities for this disk
222 bioq_insert_tail(&softc->bio_queue, bp);
225 * Schedule ourselves for performing the work.
227 xpt_schedule(periph, CAM_PRIORITY_NORMAL);
228 cam_periph_unlock(periph);
239 * Install a global async callback. This callback will
240 * receive async callbacks like "new device found".
242 status = xpt_register_async(AC_FOUND_DEVICE, ptasync, NULL, NULL);
244 if (status != CAM_REQ_CMP) {
245 printf("pt: Failed to attach master async callback "
246 "due to status 0x%x!\n", status);
251 ptctor(struct cam_periph *periph, void *arg)
253 struct pt_softc *softc;
254 struct ccb_getdev *cgd;
255 struct ccb_pathinq cpi;
257 cgd = (struct ccb_getdev *)arg;
259 printf("ptregister: no getdev CCB, can't register device\n");
260 return(CAM_REQ_CMP_ERR);
263 softc = (struct pt_softc *)malloc(sizeof(*softc),M_DEVBUF,M_NOWAIT);
266 printf("daregister: Unable to probe new device. "
267 "Unable to allocate softc\n");
268 return(CAM_REQ_CMP_ERR);
271 bzero(softc, sizeof(*softc));
272 LIST_INIT(&softc->pending_ccbs);
273 softc->state = PT_STATE_NORMAL;
274 bioq_init(&softc->bio_queue);
276 softc->io_timeout = SCSI_PT_DEFAULT_TIMEOUT * 1000;
278 periph->softc = softc;
280 bzero(&cpi, sizeof(cpi));
281 xpt_setup_ccb(&cpi.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
282 cpi.ccb_h.func_code = XPT_PATH_INQ;
283 xpt_action((union ccb *)&cpi);
285 cam_periph_unlock(periph);
286 softc->device_stats = devstat_new_entry("pt",
287 periph->unit_number, 0,
288 DEVSTAT_NO_BLOCKSIZE,
289 SID_TYPE(&cgd->inq_data) |
290 XPORT_DEVSTAT_TYPE(cpi.transport),
291 DEVSTAT_PRIORITY_OTHER);
293 softc->dev = make_dev(&pt_cdevsw, periph->unit_number, UID_ROOT,
294 GID_OPERATOR, 0600, "%s%d", periph->periph_name,
295 periph->unit_number);
296 cam_periph_lock(periph);
297 softc->dev->si_drv1 = periph;
300 * Add async callbacks for bus reset and
301 * bus device reset calls. I don't bother
302 * checking if this fails as, in most cases,
303 * the system will function just fine without
304 * them and the only alternative would be to
305 * not attach the device on failure.
307 xpt_register_async(AC_SENT_BDR | AC_BUS_RESET | AC_LOST_DEVICE,
308 ptasync, periph, periph->path);
310 /* Tell the user we've attached to the device */
311 xpt_announce_periph(periph, NULL);
317 ptoninvalidate(struct cam_periph *periph)
319 struct pt_softc *softc;
321 softc = (struct pt_softc *)periph->softc;
324 * De-register any async callbacks.
326 xpt_register_async(0, ptasync, periph, periph->path);
328 softc->flags |= PT_FLAG_DEVICE_INVALID;
331 * Return all queued I/O with ENXIO.
332 * XXX Handle any transactions queued to the card
333 * with XPT_ABORT_CCB.
335 bioq_flush(&softc->bio_queue, NULL, ENXIO);
339 ptdtor(struct cam_periph *periph)
341 struct pt_softc *softc;
343 softc = (struct pt_softc *)periph->softc;
345 devstat_remove_entry(softc->device_stats);
346 cam_periph_unlock(periph);
347 destroy_dev(softc->dev);
348 cam_periph_lock(periph);
349 free(softc, M_DEVBUF);
353 ptasync(void *callback_arg, u_int32_t code, struct cam_path *path, void *arg)
355 struct cam_periph *periph;
357 periph = (struct cam_periph *)callback_arg;
359 case AC_FOUND_DEVICE:
361 struct ccb_getdev *cgd;
364 cgd = (struct ccb_getdev *)arg;
368 if (cgd->protocol != PROTO_SCSI)
371 if (SID_TYPE(&cgd->inq_data) != T_PROCESSOR)
375 * Allocate a peripheral instance for
376 * this device and start the probe
379 status = cam_periph_alloc(ptctor, ptoninvalidate, ptdtor,
380 ptstart, "pt", CAM_PERIPH_BIO,
381 cgd->ccb_h.path, ptasync,
382 AC_FOUND_DEVICE, cgd);
384 if (status != CAM_REQ_CMP
385 && status != CAM_REQ_INPROG)
386 printf("ptasync: Unable to attach to new device "
387 "due to status 0x%x\n", status);
393 struct pt_softc *softc;
394 struct ccb_hdr *ccbh;
396 softc = (struct pt_softc *)periph->softc;
398 * Don't fail on the expected unit attention
401 softc->flags |= PT_FLAG_RETRY_UA;
402 LIST_FOREACH(ccbh, &softc->pending_ccbs, periph_links.le)
403 ccbh->ccb_state |= PT_CCB_RETRY_UA;
407 cam_periph_async(periph, code, path, arg);
413 ptstart(struct cam_periph *periph, union ccb *start_ccb)
415 struct pt_softc *softc;
418 softc = (struct pt_softc *)periph->softc;
420 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("ptstart\n"));
423 * See if there is a buf with work for us to do..
425 bp = bioq_first(&softc->bio_queue);
426 if (periph->immediate_priority <= periph->pinfo.priority) {
427 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
428 ("queuing for immediate ccb\n"));
429 start_ccb->ccb_h.ccb_state = PT_CCB_WAITING;
430 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
432 periph->immediate_priority = CAM_PRIORITY_NONE;
433 wakeup(&periph->ccb_list);
434 } else if (bp == NULL) {
435 xpt_release_ccb(start_ccb);
437 bioq_remove(&softc->bio_queue, bp);
439 devstat_start_transaction_bio(softc->device_stats, bp);
441 scsi_send_receive(&start_ccb->csio,
445 bp->bio_cmd == BIO_READ,
449 /*sense_len*/SSD_FULL_SIZE,
450 /*timeout*/softc->io_timeout);
452 start_ccb->ccb_h.ccb_state = PT_CCB_BUFFER_IO_UA;
455 * Block out any asynchronous callbacks
456 * while we touch the pending ccb list.
458 LIST_INSERT_HEAD(&softc->pending_ccbs, &start_ccb->ccb_h,
461 start_ccb->ccb_h.ccb_bp = bp;
462 bp = bioq_first(&softc->bio_queue);
464 xpt_action(start_ccb);
467 /* Have more work to do, so ensure we stay scheduled */
468 xpt_schedule(periph, CAM_PRIORITY_NORMAL);
474 ptdone(struct cam_periph *periph, union ccb *done_ccb)
476 struct pt_softc *softc;
477 struct ccb_scsiio *csio;
479 softc = (struct pt_softc *)periph->softc;
481 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("ptdone\n"));
483 csio = &done_ccb->csio;
484 switch (csio->ccb_h.ccb_state) {
485 case PT_CCB_BUFFER_IO:
486 case PT_CCB_BUFFER_IO_UA:
490 bp = (struct bio *)done_ccb->ccb_h.ccb_bp;
491 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
495 if ((csio->ccb_h.ccb_state & PT_CCB_RETRY_UA) != 0)
500 error = pterror(done_ccb, CAM_RETRY_SELTO, sf);
501 if (error == ERESTART) {
503 * A retry was scheuled, so
509 if (error == ENXIO) {
511 * Catastrophic error. Mark our device
514 xpt_print(periph->path,
515 "Invalidating device\n");
516 softc->flags |= PT_FLAG_DEVICE_INVALID;
520 * return all queued I/O with EIO, so that
521 * the client can retry these I/Os in the
522 * proper order should it attempt to recover.
524 bioq_flush(&softc->bio_queue, NULL, EIO);
525 bp->bio_error = error;
526 bp->bio_resid = bp->bio_bcount;
527 bp->bio_flags |= BIO_ERROR;
529 bp->bio_resid = csio->resid;
531 if (bp->bio_resid != 0) {
532 /* Short transfer ??? */
533 bp->bio_flags |= BIO_ERROR;
536 if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
537 cam_release_devq(done_ccb->ccb_h.path,
543 bp->bio_resid = csio->resid;
544 if (bp->bio_resid != 0)
545 bp->bio_flags |= BIO_ERROR;
549 * Block out any asynchronous callbacks
550 * while we touch the pending ccb list.
552 LIST_REMOVE(&done_ccb->ccb_h, periph_links.le);
554 biofinish(bp, softc->device_stats, 0);
558 /* Caller will release the CCB */
559 wakeup(&done_ccb->ccb_h.cbfcnp);
562 xpt_release_ccb(done_ccb);
566 pterror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
568 struct pt_softc *softc;
569 struct cam_periph *periph;
571 periph = xpt_path_periph(ccb->ccb_h.path);
572 softc = (struct pt_softc *)periph->softc;
574 return(cam_periph_error(ccb, cam_flags, sense_flags,
579 ptioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
581 struct cam_periph *periph;
582 struct pt_softc *softc;
585 periph = (struct cam_periph *)dev->si_drv1;
589 softc = (struct pt_softc *)periph->softc;
591 cam_periph_lock(periph);
594 case PTIOCGETTIMEOUT:
595 if (softc->io_timeout >= 1000)
596 *(int *)addr = softc->io_timeout / 1000;
600 case PTIOCSETTIMEOUT:
601 if (*(int *)addr < 1) {
606 softc->io_timeout = *(int *)addr * 1000;
610 error = cam_periph_ioctl(periph, cmd, addr, pterror);
614 cam_periph_unlock(periph);
620 scsi_send_receive(struct ccb_scsiio *csio, u_int32_t retries,
621 void (*cbfcnp)(struct cam_periph *, union ccb *),
622 u_int tag_action, int readop, u_int byte2,
623 u_int32_t xfer_len, u_int8_t *data_ptr, u_int8_t sense_len,
626 struct scsi_send_receive *scsi_cmd;
628 scsi_cmd = (struct scsi_send_receive *)&csio->cdb_io.cdb_bytes;
629 scsi_cmd->opcode = readop ? RECEIVE : SEND;
630 scsi_cmd->byte2 = byte2;
631 scsi_ulto3b(xfer_len, scsi_cmd->xfer_len);
632 scsi_cmd->control = 0;
637 /*flags*/readop ? CAM_DIR_IN : CAM_DIR_OUT,