1 /* 2 * Implementation of SCSI Processor Target Peripheral driver for CAM. 3 * 4 * Copyright (c) 1998 Justin T. Gibbs. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 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. 15 * 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 26 * SUCH DAMAGE. 27 * 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.23 2008/05/18 20:30:20 pavalos Exp $ 30 */ 31 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> 37 #include <sys/buf.h> 38 #include <sys/devicestat.h> 39 #include <sys/malloc.h> 40 #include <sys/conf.h> 41 #include <sys/ptio.h> 42 #include <sys/buf2.h> 43 #include <sys/thread2.h> 44 45 #include "../cam.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" 51 52 #include "scsi_all.h" 53 #include "scsi_message.h" 54 #include "scsi_pt.h" 55 56 #include "opt_pt.h" 57 58 typedef enum { 59 PT_STATE_PROBE, 60 PT_STATE_NORMAL 61 } pt_state; 62 63 typedef enum { 64 PT_FLAG_NONE = 0x00, 65 PT_FLAG_OPEN = 0x01, 66 PT_FLAG_DEVICE_INVALID = 0x02, 67 PT_FLAG_RETRY_UA = 0x04 68 } pt_flags; 69 70 typedef enum { 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 75 } pt_ccb_state; 76 77 /* Offsets into our private area for storing information */ 78 #define ccb_state ppriv_field0 79 #define ccb_bio ppriv_ptr1 80 81 struct pt_softc { 82 struct bio_queue_head bio_queue; 83 struct devstat device_stats; 84 LIST_HEAD(, ccb_hdr) pending_ccbs; 85 pt_state state; 86 pt_flags flags; 87 union ccb saved_ccb; 88 int io_timeout; 89 cdev_t dev; 90 }; 91 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); 107 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); 113 114 static struct periph_driver ptdriver = 115 { 116 ptinit, "pt", 117 TAILQ_HEAD_INITIALIZER(ptdriver.units), /* generation */ 0 118 }; 119 120 PERIPHDRIVER_DECLARE(pt, ptdriver); 121 122 #define PT_CDEV_MAJOR 61 123 124 static struct dev_ops pt_ops = { 125 { "pt", PT_CDEV_MAJOR, 0 }, 126 .d_open = ptopen, 127 .d_close = ptclose, 128 .d_read = physread, 129 .d_write = physwrite, 130 .d_ioctl = ptioctl, 131 .d_strategy = ptstrategy, 132 }; 133 134 static struct extend_array *ptperiphs; 135 136 #ifndef SCSI_PT_DEFAULT_TIMEOUT 137 #define SCSI_PT_DEFAULT_TIMEOUT 60 138 #endif 139 140 static int 141 ptopen(struct dev_open_args *ap) 142 { 143 cdev_t dev = ap->a_head.a_dev; 144 struct cam_periph *periph; 145 struct pt_softc *softc; 146 int unit; 147 int error = 0; 148 149 unit = minor(dev); 150 periph = cam_extend_get(ptperiphs, unit); 151 if (cam_periph_acquire(periph) != CAM_REQ_CMP) 152 return (ENXIO); 153 154 softc = (struct pt_softc *)periph->softc; 155 156 cam_periph_lock(periph); 157 if (softc->flags & PT_FLAG_DEVICE_INVALID) { 158 cam_periph_unlock(periph); 159 cam_periph_release(periph); 160 return(ENXIO); 161 } 162 163 if ((softc->flags & PT_FLAG_OPEN) == 0) 164 softc->flags |= PT_FLAG_OPEN; 165 else { 166 error = EBUSY; 167 cam_periph_release(periph); 168 } 169 170 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, 171 ("ptopen: dev=%s\n", devtoname(dev))); 172 173 cam_periph_unlock(periph); 174 return (error); 175 } 176 177 static int 178 ptclose(struct dev_close_args *ap) 179 { 180 cdev_t dev = ap->a_head.a_dev; 181 struct cam_periph *periph; 182 struct pt_softc *softc; 183 int unit; 184 185 unit = minor(dev); 186 periph = cam_extend_get(ptperiphs, unit); 187 if (periph == NULL) 188 return (ENXIO); 189 190 softc = (struct pt_softc *)periph->softc; 191 192 cam_periph_lock(periph); 193 194 softc->flags &= ~PT_FLAG_OPEN; 195 cam_periph_unlock(periph); 196 cam_periph_release(periph); 197 return (0); 198 } 199 200 /* 201 * Actually translate the requested transfer into one the physical driver 202 * can understand. The transfer is described by a buf and will include 203 * only one physical transfer. 204 */ 205 static int 206 ptstrategy(struct dev_strategy_args *ap) 207 { 208 cdev_t dev = ap->a_head.a_dev; 209 struct bio *bio = ap->a_bio; 210 struct buf *bp = bio->bio_buf; 211 struct cam_periph *periph; 212 struct pt_softc *softc; 213 u_int unit; 214 215 unit = minor(dev); 216 periph = cam_extend_get(ptperiphs, unit); 217 if (periph == NULL) { 218 bp->b_error = ENXIO; 219 goto bad; 220 } 221 cam_periph_lock(periph); 222 softc = (struct pt_softc *)periph->softc; 223 224 /* 225 * If the device has been made invalid, error out 226 */ 227 if ((softc->flags & PT_FLAG_DEVICE_INVALID)) { 228 cam_periph_unlock(periph); 229 bp->b_error = ENXIO; 230 goto bad; 231 } 232 233 /* 234 * Place it in the queue of disk activities for this disk 235 */ 236 bioq_insert_tail(&softc->bio_queue, bio); 237 238 /* 239 * Schedule ourselves for performing the work. 240 */ 241 xpt_schedule(periph, /* XXX priority */1); 242 cam_periph_unlock(periph); 243 244 return(0); 245 bad: 246 bp->b_flags |= B_ERROR; 247 248 /* 249 * Correctly set the buf to indicate a completed xfer 250 */ 251 bp->b_resid = bp->b_bcount; 252 biodone(bio); 253 return(0); 254 } 255 256 static void 257 ptinit(void) 258 { 259 cam_status status; 260 261 /* 262 * Create our extend array for storing the devices we attach to. 263 */ 264 ptperiphs = cam_extend_new(); 265 if (ptperiphs == NULL) { 266 kprintf("pt: Failed to alloc extend array!\n"); 267 return; 268 } 269 270 /* 271 * Install a global async callback. This callback will 272 * receive async callbacks like "new device found". 273 */ 274 status = xpt_register_async(AC_FOUND_DEVICE, ptasync, NULL, NULL); 275 276 if (status != CAM_REQ_CMP) { 277 kprintf("pt: Failed to attach master async callback " 278 "due to status 0x%x!\n", status); 279 } 280 } 281 282 static cam_status 283 ptctor(struct cam_periph *periph, void *arg) 284 { 285 struct pt_softc *softc; 286 struct ccb_getdev *cgd; 287 288 cgd = (struct ccb_getdev *)arg; 289 if (periph == NULL) { 290 kprintf("ptregister: periph was NULL!!\n"); 291 return(CAM_REQ_CMP_ERR); 292 } 293 294 if (cgd == NULL) { 295 kprintf("ptregister: no getdev CCB, can't register device\n"); 296 return(CAM_REQ_CMP_ERR); 297 } 298 299 softc = kmalloc(sizeof(*softc), M_DEVBUF, M_INTWAIT | M_ZERO); 300 LIST_INIT(&softc->pending_ccbs); 301 softc->state = PT_STATE_NORMAL; 302 bioq_init(&softc->bio_queue); 303 304 softc->io_timeout = SCSI_PT_DEFAULT_TIMEOUT * 1000; 305 306 periph->softc = softc; 307 308 cam_periph_unlock(periph); 309 cam_extend_set(ptperiphs, periph->unit_number, periph); 310 311 devstat_add_entry(&softc->device_stats, "pt", 312 periph->unit_number, 0, 313 DEVSTAT_NO_BLOCKSIZE, 314 SID_TYPE(&cgd->inq_data) | DEVSTAT_TYPE_IF_SCSI, 315 DEVSTAT_PRIORITY_OTHER); 316 317 make_dev(&pt_ops, periph->unit_number, UID_ROOT, 318 GID_OPERATOR, 0600, "%s%d", periph->periph_name, 319 periph->unit_number); 320 cam_periph_lock(periph); 321 /* 322 * Add async callbacks for bus reset and 323 * bus device reset calls. I don't bother 324 * checking if this fails as, in most cases, 325 * the system will function just fine without 326 * them and the only alternative would be to 327 * not attach the device on failure. 328 */ 329 xpt_register_async(AC_SENT_BDR | AC_BUS_RESET | AC_LOST_DEVICE, 330 ptasync, periph, periph->path); 331 332 /* Tell the user we've attached to the device */ 333 xpt_announce_periph(periph, NULL); 334 335 return(CAM_REQ_CMP); 336 } 337 338 static void 339 ptoninvalidate(struct cam_periph *periph) 340 { 341 struct pt_softc *softc; 342 struct bio *q_bio; 343 struct buf *q_bp; 344 345 softc = (struct pt_softc *)periph->softc; 346 347 /* 348 * De-register any async callbacks. 349 */ 350 xpt_register_async(0, ptasync, periph, periph->path); 351 352 softc->flags |= PT_FLAG_DEVICE_INVALID; 353 354 /* 355 * Return all queued I/O with ENXIO. 356 * XXX Handle any transactions queued to the card 357 * with XPT_ABORT_CCB. 358 */ 359 while ((q_bio = bioq_first(&softc->bio_queue)) != NULL){ 360 bioq_remove(&softc->bio_queue, q_bio); 361 q_bp = q_bio->bio_buf; 362 q_bp->b_resid = q_bp->b_bcount; 363 q_bp->b_error = ENXIO; 364 q_bp->b_flags |= B_ERROR; 365 biodone(q_bio); 366 } 367 368 xpt_print(periph->path, "lost device\n"); 369 } 370 371 static void 372 ptdtor(struct cam_periph *periph) 373 { 374 struct pt_softc *softc; 375 376 softc = (struct pt_softc *)periph->softc; 377 378 devstat_remove_entry(&softc->device_stats); 379 380 cam_extend_release(ptperiphs, periph->unit_number); 381 xpt_print(periph->path, "removing device entry\n"); 382 dev_ops_remove_minor(&pt_ops, periph->unit_number); 383 kfree(softc, M_DEVBUF); 384 } 385 386 static void 387 ptasync(void *callback_arg, u_int32_t code, struct cam_path *path, void *arg) 388 { 389 struct cam_periph *periph; 390 391 periph = (struct cam_periph *)callback_arg; 392 switch (code) { 393 case AC_FOUND_DEVICE: 394 { 395 struct ccb_getdev *cgd; 396 cam_status status; 397 398 cgd = (struct ccb_getdev *)arg; 399 if (cgd == NULL) 400 break; 401 402 if (SID_TYPE(&cgd->inq_data) != T_PROCESSOR) 403 break; 404 405 /* 406 * Allocate a peripheral instance for 407 * this device and start the probe 408 * process. 409 */ 410 status = cam_periph_alloc(ptctor, ptoninvalidate, ptdtor, 411 ptstart, "pt", CAM_PERIPH_BIO, 412 cgd->ccb_h.path, ptasync, 413 AC_FOUND_DEVICE, cgd); 414 415 if (status != CAM_REQ_CMP 416 && status != CAM_REQ_INPROG) 417 kprintf("ptasync: Unable to attach to new device " 418 "due to status 0x%x\n", status); 419 break; 420 } 421 case AC_SENT_BDR: 422 case AC_BUS_RESET: 423 { 424 struct pt_softc *softc; 425 struct ccb_hdr *ccbh; 426 427 softc = (struct pt_softc *)periph->softc; 428 /* 429 * Don't fail on the expected unit attention 430 * that will occur. 431 */ 432 softc->flags |= PT_FLAG_RETRY_UA; 433 LIST_FOREACH(ccbh, &softc->pending_ccbs, periph_links.le) 434 ccbh->ccb_state |= PT_CCB_RETRY_UA; 435 /* FALLTHROUGH */ 436 } 437 default: 438 cam_periph_async(periph, code, path, arg); 439 break; 440 } 441 } 442 443 static void 444 ptstart(struct cam_periph *periph, union ccb *start_ccb) 445 { 446 struct pt_softc *softc; 447 struct buf *bp; 448 struct bio *bio; 449 450 softc = (struct pt_softc *)periph->softc; 451 452 /* 453 * See if there is a buf with work for us to do.. 454 */ 455 bio = bioq_first(&softc->bio_queue); 456 if (periph->immediate_priority <= periph->pinfo.priority) { 457 CAM_DEBUG_PRINT(CAM_DEBUG_SUBTRACE, 458 ("queuing for immediate ccb\n")); 459 start_ccb->ccb_h.ccb_state = PT_CCB_WAITING; 460 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h, 461 periph_links.sle); 462 periph->immediate_priority = CAM_PRIORITY_NONE; 463 wakeup(&periph->ccb_list); 464 } else if (bio == NULL) { 465 xpt_release_ccb(start_ccb); 466 } else { 467 bioq_remove(&softc->bio_queue, bio); 468 bp = bio->bio_buf; 469 470 devstat_start_transaction(&softc->device_stats); 471 472 scsi_send_receive(&start_ccb->csio, 473 /*retries*/4, 474 ptdone, 475 MSG_SIMPLE_Q_TAG, 476 (bp->b_cmd == BUF_CMD_READ), 477 /*byte2*/0, 478 bp->b_bcount, 479 bp->b_data, 480 /*sense_len*/SSD_FULL_SIZE, 481 /*timeout*/softc->io_timeout); 482 483 start_ccb->ccb_h.ccb_state = PT_CCB_BUFFER_IO_UA; 484 485 /* 486 * Block out any asyncronous callbacks 487 * while we touch the pending ccb list. 488 */ 489 LIST_INSERT_HEAD(&softc->pending_ccbs, &start_ccb->ccb_h, 490 periph_links.le); 491 492 start_ccb->ccb_h.ccb_bio = bio; 493 bio = bioq_first(&softc->bio_queue); 494 495 xpt_action(start_ccb); 496 497 if (bio != NULL) { 498 /* Have more work to do, so ensure we stay scheduled */ 499 xpt_schedule(periph, /* XXX priority */1); 500 } 501 } 502 } 503 504 static void 505 ptdone(struct cam_periph *periph, union ccb *done_ccb) 506 { 507 struct pt_softc *softc; 508 struct ccb_scsiio *csio; 509 510 softc = (struct pt_softc *)periph->softc; 511 csio = &done_ccb->csio; 512 switch (csio->ccb_h.ccb_state) { 513 case PT_CCB_BUFFER_IO: 514 case PT_CCB_BUFFER_IO_UA: 515 { 516 struct buf *bp; 517 struct bio *bio; 518 519 bio = (struct bio *)done_ccb->ccb_h.ccb_bio; 520 bp = bio->bio_buf; 521 522 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) { 523 int error; 524 int sf; 525 526 if ((csio->ccb_h.ccb_state & PT_CCB_RETRY_UA) != 0) 527 sf = SF_RETRY_UA; 528 else 529 sf = 0; 530 531 error = pterror(done_ccb, CAM_RETRY_SELTO, sf); 532 if (error == ERESTART) { 533 /* 534 * A retry was scheuled, so 535 * just return. 536 */ 537 return; 538 } 539 if (error != 0) { 540 struct buf *q_bp; 541 struct bio *q_bio; 542 543 if (error == ENXIO) { 544 /* 545 * Catastrophic error. Mark our device 546 * as invalid. 547 */ 548 xpt_print(periph->path, 549 "Invalidating device\n"); 550 softc->flags |= PT_FLAG_DEVICE_INVALID; 551 } 552 553 /* 554 * return all queued I/O with EIO, so that 555 * the client can retry these I/Os in the 556 * proper order should it attempt to recover. 557 */ 558 while ((q_bio = bioq_first(&softc->bio_queue)) 559 != NULL) { 560 bioq_remove(&softc->bio_queue, q_bio); 561 q_bp = q_bio->bio_buf; 562 q_bp->b_resid = q_bp->b_bcount; 563 q_bp->b_error = EIO; 564 q_bp->b_flags |= B_ERROR; 565 biodone(q_bio); 566 } 567 bp->b_error = error; 568 bp->b_resid = bp->b_bcount; 569 bp->b_flags |= B_ERROR; 570 } else { 571 bp->b_resid = csio->resid; 572 bp->b_error = 0; 573 if (bp->b_resid != 0) { 574 /* Short transfer ??? */ 575 bp->b_flags |= B_ERROR; 576 } 577 } 578 if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) 579 cam_release_devq(done_ccb->ccb_h.path, 580 /*relsim_flags*/0, 581 /*reduction*/0, 582 /*timeout*/0, 583 /*getcount_only*/0); 584 } else { 585 bp->b_resid = csio->resid; 586 if (bp->b_resid != 0) 587 bp->b_flags |= B_ERROR; 588 } 589 590 /* 591 * Block out any asyncronous callbacks 592 * while we touch the pending ccb list. 593 */ 594 LIST_REMOVE(&done_ccb->ccb_h, periph_links.le); 595 596 devstat_end_transaction_buf(&softc->device_stats, bp); 597 biodone(bio); 598 break; 599 } 600 case PT_CCB_WAITING: 601 /* Caller will release the CCB */ 602 wakeup(&done_ccb->ccb_h.cbfcnp); 603 return; 604 } 605 xpt_release_ccb(done_ccb); 606 } 607 608 static int 609 pterror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags) 610 { 611 struct pt_softc *softc; 612 struct cam_periph *periph; 613 614 periph = xpt_path_periph(ccb->ccb_h.path); 615 softc = (struct pt_softc *)periph->softc; 616 617 return(cam_periph_error(ccb, cam_flags, sense_flags, 618 &softc->saved_ccb)); 619 } 620 621 static int 622 ptioctl(struct dev_ioctl_args *ap) 623 { 624 cdev_t dev = ap->a_head.a_dev; 625 caddr_t addr = ap->a_data; 626 struct cam_periph *periph; 627 struct pt_softc *softc; 628 int unit; 629 int error = 0; 630 631 unit = minor(dev); 632 periph = cam_extend_get(ptperiphs, unit); 633 634 if (periph == NULL) 635 return(ENXIO); 636 637 softc = (struct pt_softc *)periph->softc; 638 639 cam_periph_lock(periph); 640 641 switch(ap->a_cmd) { 642 case PTIOCGETTIMEOUT: 643 if (softc->io_timeout >= 1000) 644 *(int *)addr = softc->io_timeout / 1000; 645 else 646 *(int *)addr = 0; 647 break; 648 case PTIOCSETTIMEOUT: 649 if (*(int *)addr < 1) { 650 error = EINVAL; 651 break; 652 } 653 654 softc->io_timeout = *(int *)addr * 1000; 655 656 break; 657 default: 658 error = cam_periph_ioctl(periph, ap->a_cmd, addr, pterror); 659 break; 660 } 661 662 cam_periph_unlock(periph); 663 664 return(error); 665 } 666 667 void 668 scsi_send_receive(struct ccb_scsiio *csio, u_int32_t retries, 669 void (*cbfcnp)(struct cam_periph *, union ccb *), 670 u_int tag_action, int readop, u_int byte2, 671 u_int32_t xfer_len, u_int8_t *data_ptr, u_int8_t sense_len, 672 u_int32_t timeout) 673 { 674 struct scsi_send_receive *scsi_cmd; 675 676 scsi_cmd = (struct scsi_send_receive *)&csio->cdb_io.cdb_bytes; 677 scsi_cmd->opcode = readop ? RECEIVE : SEND; 678 scsi_cmd->byte2 = byte2; 679 scsi_ulto3b(xfer_len, scsi_cmd->xfer_len); 680 scsi_cmd->control = 0; 681 682 cam_fill_csio(csio, 683 retries, 684 cbfcnp, 685 /*flags*/readop ? CAM_DIR_IN : CAM_DIR_OUT, 686 tag_action, 687 data_ptr, 688 xfer_len, 689 sense_len, 690 sizeof(*scsi_cmd), 691 timeout); 692 } 693