1 /* 2 * Copyright (c) 1997, 1998, 2000 Justin T. Gibbs. 3 * Copyright (c) 1997, 1998, 1999 Kenneth D. Merry. 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 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. 14 * 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 25 * SUCH DAMAGE. 26 * 27 * $FreeBSD: src/sys/cam/scsi/scsi_pass.c,v 1.19 2000/01/17 06:27:37 mjacob Exp $ 28 */ 29 30 #include <sys/param.h> 31 #include <sys/systm.h> 32 #include <sys/kernel.h> 33 #include <sys/types.h> 34 #include <sys/buf.h> 35 #include <sys/malloc.h> 36 #include <sys/fcntl.h> 37 #include <sys/stat.h> 38 #include <sys/conf.h> 39 #include <sys/errno.h> 40 #include <sys/devicestat.h> 41 #include <sys/buf2.h> 42 #include <sys/thread2.h> 43 44 #include "../cam.h" 45 #include "../cam_ccb.h" 46 #include "../cam_extend.h" 47 #include "../cam_periph.h" 48 #include "../cam_queue.h" 49 #include "../cam_xpt_periph.h" 50 #include "../cam_debug.h" 51 #include "../cam_sim.h" 52 53 #include "scsi_all.h" 54 #include "scsi_message.h" 55 #include "scsi_da.h" 56 #include "scsi_pass.h" 57 58 typedef enum { 59 PASS_FLAG_OPEN = 0x01, 60 PASS_FLAG_LOCKED = 0x02, 61 PASS_FLAG_INVALID = 0x04 62 } pass_flags; 63 64 typedef enum { 65 PASS_STATE_NORMAL 66 } pass_state; 67 68 typedef enum { 69 PASS_CCB_POLLED, 70 PASS_CCB_BUFFER_IO, 71 PASS_CCB_WAITING 72 } pass_ccb_types; 73 74 #define ccb_type ppriv_field0 75 #define ccb_bio ppriv_ptr1 76 77 struct pass_softc { 78 pass_state state; 79 pass_flags flags; 80 u_int8_t pd_type; 81 union ccb saved_ccb; 82 struct devstat device_stats; 83 }; 84 85 static d_open_t passopen; 86 static d_close_t passclose; 87 static d_ioctl_t passioctl; 88 89 static periph_init_t passinit; 90 static periph_ctor_t passregister; 91 static periph_oninv_t passoninvalidate; 92 static periph_dtor_t passcleanup; 93 static periph_start_t passstart; 94 static void passasync(void *callback_arg, u_int32_t code, 95 struct cam_path *path, void *arg); 96 static void passdone(struct cam_periph *periph, 97 union ccb *done_ccb); 98 static int passerror(union ccb *ccb, u_int32_t cam_flags, 99 u_int32_t sense_flags); 100 static int passsendccb(struct cam_periph *periph, union ccb *ccb, 101 union ccb *inccb); 102 103 static struct periph_driver passdriver = 104 { 105 passinit, "pass", 106 TAILQ_HEAD_INITIALIZER(passdriver.units), /* generation */ 0 107 }; 108 109 PERIPHDRIVER_DECLARE(pass, passdriver); 110 111 static struct dev_ops pass_ops = { 112 { "pass", 0, D_MPSAFE }, 113 .d_open = passopen, 114 .d_close = passclose, 115 .d_ioctl = passioctl, 116 }; 117 118 static struct extend_array *passperiphs; 119 120 static void 121 passinit(void) 122 { 123 cam_status status; 124 125 /* 126 * Create our extend array for storing the devices we attach to. 127 */ 128 passperiphs = cam_extend_new(); 129 if (passperiphs == NULL) { 130 kprintf("passm: Failed to alloc extend array!\n"); 131 return; 132 } 133 134 /* 135 * Install a global async callback. This callback will 136 * receive async callbacks like "new device found". 137 */ 138 status = xpt_register_async(AC_FOUND_DEVICE, passasync, NULL, NULL); 139 140 if (status != CAM_REQ_CMP) { 141 kprintf("pass: Failed to attach master async callback " 142 "due to status 0x%x!\n", status); 143 } 144 145 } 146 147 static void 148 passoninvalidate(struct cam_periph *periph) 149 { 150 struct pass_softc *softc; 151 152 softc = (struct pass_softc *)periph->softc; 153 154 /* 155 * De-register any async callbacks. 156 */ 157 xpt_register_async(0, passasync, periph, periph->path); 158 159 softc->flags |= PASS_FLAG_INVALID; 160 161 if (bootverbose) { 162 xpt_print(periph->path, "lost device\n"); 163 } 164 165 } 166 167 static void 168 passcleanup(struct cam_periph *periph) 169 { 170 struct pass_softc *softc; 171 172 softc = (struct pass_softc *)periph->softc; 173 174 devstat_remove_entry(&softc->device_stats); 175 176 cam_extend_release(passperiphs, periph->unit_number); 177 178 if (bootverbose) { 179 xpt_print(periph->path, "removing device entry\n"); 180 } 181 dev_ops_remove_minor(&pass_ops, periph->unit_number); 182 kfree(softc, M_DEVBUF); 183 } 184 185 static void 186 passasync(void *callback_arg, u_int32_t code, 187 struct cam_path *path, void *arg) 188 { 189 struct cam_periph *periph; 190 191 periph = (struct cam_periph *)callback_arg; 192 193 switch (code) { 194 case AC_FOUND_DEVICE: 195 { 196 struct ccb_getdev *cgd; 197 cam_status status; 198 199 cgd = (struct ccb_getdev *)arg; 200 if (cgd == NULL) 201 break; 202 203 /* 204 * Don't complain if a valid peripheral is already attached. 205 */ 206 periph = cam_periph_find(cgd->ccb_h.path, "pass"); 207 if (periph && (periph->flags & CAM_PERIPH_INVALID) == 0) 208 break; 209 210 /* 211 * Allocate a peripheral instance for 212 * this device and start the probe 213 * process. 214 */ 215 status = cam_periph_alloc(passregister, passoninvalidate, 216 passcleanup, passstart, "pass", 217 CAM_PERIPH_BIO, cgd->ccb_h.path, 218 passasync, AC_FOUND_DEVICE, cgd); 219 220 if (status != CAM_REQ_CMP && status != CAM_REQ_INPROG) { 221 const struct cam_status_entry *entry; 222 223 entry = cam_fetch_status_entry(status); 224 225 kprintf("passasync: Unable to attach new device " 226 "due to status %#x: %s\n", status, entry ? 227 entry->status_text : "Unknown"); 228 } 229 230 break; 231 } 232 default: 233 cam_periph_async(periph, code, path, arg); 234 break; 235 } 236 } 237 238 static cam_status 239 passregister(struct cam_periph *periph, void *arg) 240 { 241 struct pass_softc *softc; 242 struct ccb_getdev *cgd; 243 int no_tags; 244 245 cgd = (struct ccb_getdev *)arg; 246 if (periph == NULL) { 247 kprintf("passregister: periph was NULL!!\n"); 248 return(CAM_REQ_CMP_ERR); 249 } 250 251 if (cgd == NULL) { 252 kprintf("passregister: no getdev CCB, can't register device\n"); 253 return(CAM_REQ_CMP_ERR); 254 } 255 256 softc = kmalloc(sizeof(*softc), M_DEVBUF, M_INTWAIT | M_ZERO); 257 softc->state = PASS_STATE_NORMAL; 258 softc->pd_type = SID_TYPE(&cgd->inq_data); 259 260 periph->softc = softc; 261 cam_extend_set(passperiphs, periph->unit_number, periph); 262 263 /* 264 * We pass in 0 for a blocksize, since we don't 265 * know what the blocksize of this device is, if 266 * it even has a blocksize. 267 */ 268 CAM_SIM_UNLOCK(periph->sim); 269 no_tags = (cgd->inq_data.flags & SID_CmdQue) == 0; 270 devstat_add_entry(&softc->device_stats, "pass", periph->unit_number, 0, 271 DEVSTAT_NO_BLOCKSIZE 272 | (no_tags ? DEVSTAT_NO_ORDERED_TAGS : 0), 273 softc->pd_type | 274 DEVSTAT_TYPE_IF_SCSI | 275 DEVSTAT_TYPE_PASS, 276 DEVSTAT_PRIORITY_PASS); 277 278 /* Register the device */ 279 make_dev(&pass_ops, periph->unit_number, UID_ROOT, 280 GID_OPERATOR, 0600, "%s%d", periph->periph_name, 281 periph->unit_number); 282 CAM_SIM_LOCK(periph->sim); 283 /* 284 * Add an async callback so that we get 285 * notified if this device goes away. 286 */ 287 xpt_register_async(AC_LOST_DEVICE, passasync, periph, periph->path); 288 289 #if 0 290 if (bootverbose) 291 xpt_announce_periph(periph, NULL); 292 #endif 293 294 return(CAM_REQ_CMP); 295 } 296 297 static int 298 passopen(struct dev_open_args *ap) 299 { 300 cdev_t dev = ap->a_head.a_dev; 301 struct cam_periph *periph; 302 struct pass_softc *softc; 303 int unit, error; 304 305 error = 0; /* default to no error */ 306 307 /* unit = dkunit(dev); */ 308 /* XXX KDM fix this */ 309 unit = minor(dev) & 0xff; 310 311 periph = cam_extend_get(passperiphs, unit); 312 313 if (cam_periph_acquire(periph) != CAM_REQ_CMP) 314 return (ENXIO); 315 316 cam_periph_lock(periph); 317 318 softc = (struct pass_softc *)periph->softc; 319 320 if (softc->flags & PASS_FLAG_INVALID) { 321 cam_periph_unlock(periph); 322 cam_periph_release(periph); 323 return(ENXIO); 324 } 325 326 /* 327 * Don't allow access when we're running at a high securelevel. 328 */ 329 if (securelevel > 1) { 330 cam_periph_unlock(periph); 331 cam_periph_release(periph); 332 return(EPERM); 333 } 334 335 /* 336 * Only allow read-write access. 337 */ 338 if (((ap->a_oflags & FWRITE) == 0) || ((ap->a_oflags & FREAD) == 0)) { 339 cam_periph_unlock(periph); 340 cam_periph_release(periph); 341 return(EPERM); 342 } 343 344 /* 345 * We don't allow nonblocking access. 346 */ 347 if ((ap->a_oflags & O_NONBLOCK) != 0) { 348 xpt_print(periph->path, "can't do nonblocking access\n"); 349 cam_periph_unlock(periph); 350 cam_periph_release(periph); 351 return(EINVAL); 352 } 353 354 if ((softc->flags & PASS_FLAG_OPEN) == 0) { 355 softc->flags |= PASS_FLAG_OPEN; 356 } else { 357 /* Device closes aren't symmertical, so fix up the refcount */ 358 cam_periph_release(periph); 359 } 360 361 cam_periph_unlock(periph); 362 363 return (error); 364 } 365 366 static int 367 passclose(struct dev_close_args *ap) 368 { 369 cdev_t dev = ap->a_head.a_dev; 370 struct cam_periph *periph; 371 struct pass_softc *softc; 372 int unit; 373 374 /* unit = dkunit(dev); */ 375 /* XXX KDM fix this */ 376 unit = minor(dev) & 0xff; 377 378 periph = cam_extend_get(passperiphs, unit); 379 if (periph == NULL) 380 return (ENXIO); 381 382 cam_periph_lock(periph); 383 384 softc = (struct pass_softc *)periph->softc; 385 softc->flags &= ~PASS_FLAG_OPEN; 386 387 cam_periph_unlock(periph); 388 cam_periph_release(periph); 389 390 return (0); 391 } 392 393 static void 394 passstart(struct cam_periph *periph, union ccb *start_ccb) 395 { 396 struct pass_softc *softc; 397 398 softc = (struct pass_softc *)periph->softc; 399 400 switch (softc->state) { 401 case PASS_STATE_NORMAL: 402 start_ccb->ccb_h.ccb_type = PASS_CCB_WAITING; 403 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h, 404 periph_links.sle); 405 periph->immediate_priority = CAM_PRIORITY_NONE; 406 wakeup(&periph->ccb_list); 407 break; 408 } 409 } 410 411 static void 412 passdone(struct cam_periph *periph, union ccb *done_ccb) 413 { 414 struct ccb_scsiio *csio; 415 416 csio = &done_ccb->csio; 417 418 switch (csio->ccb_h.ccb_type) { 419 case PASS_CCB_WAITING: 420 /* Caller will release the CCB */ 421 wakeup(&done_ccb->ccb_h.cbfcnp); 422 return; 423 case PASS_CCB_POLLED: 424 /* polled, caller releases ccb */ 425 wakeup(&done_ccb->ccb_h.cbfcnp); 426 return; 427 } 428 xpt_release_ccb(done_ccb); 429 } 430 431 static int 432 passioctl(struct dev_ioctl_args *ap) 433 { 434 cdev_t dev = ap->a_head.a_dev; 435 caddr_t addr = ap->a_data; 436 struct cam_periph *periph; 437 u_int8_t unit; 438 int error; 439 440 441 /* unit = dkunit(dev); */ 442 /* XXX KDM fix this */ 443 unit = minor(dev) & 0xff; 444 445 periph = cam_extend_get(passperiphs, unit); 446 447 if (periph == NULL) 448 return(ENXIO); 449 450 cam_periph_lock(periph); 451 452 error = 0; 453 454 switch (ap->a_cmd) { 455 456 case CAMIOCOMMAND: 457 { 458 union ccb *inccb; 459 union ccb *ccb; 460 int ccb_malloced; 461 462 inccb = (union ccb *)addr; 463 464 /* 465 * Some CCB types, like scan bus and scan lun can only go 466 * through the transport layer device. 467 */ 468 if (inccb->ccb_h.func_code & XPT_FC_XPT_ONLY) { 469 xpt_print(periph->path, "CCB function code %#x is " 470 "restricted to the XPT device\n", 471 inccb->ccb_h.func_code); 472 error = ENODEV; 473 break; 474 } 475 476 /* 477 * Non-immediate CCBs need a CCB from the per-device pool 478 * of CCBs, which is scheduled by the transport layer. 479 * Immediate CCBs and user-supplied CCBs should just be 480 * malloced. 481 */ 482 if ((inccb->ccb_h.func_code & XPT_FC_QUEUED) 483 && ((inccb->ccb_h.func_code & XPT_FC_USER_CCB) == 0)) { 484 ccb = cam_periph_getccb(periph, 485 inccb->ccb_h.pinfo.priority); 486 ccb_malloced = 0; 487 } else { 488 ccb = xpt_alloc_ccb(); 489 490 if (ccb != NULL) 491 xpt_setup_ccb(&ccb->ccb_h, periph->path, 492 inccb->ccb_h.pinfo.priority); 493 ccb_malloced = 1; 494 } 495 496 if (ccb == NULL) { 497 xpt_print(periph->path, "unable to allocate CCB\n"); 498 error = ENOMEM; 499 break; 500 } 501 502 ccb->ccb_h.ccb_type = PASS_CCB_POLLED; 503 error = passsendccb(periph, ccb, inccb); 504 505 if (ccb_malloced) 506 xpt_free_ccb(ccb); 507 else 508 xpt_release_ccb(ccb); 509 510 break; 511 } 512 default: 513 error = cam_periph_ioctl(periph, ap->a_cmd, addr, passerror); 514 break; 515 } 516 517 cam_periph_unlock(periph); 518 return(error); 519 } 520 521 /* 522 * Generally, "ccb" should be the CCB supplied by the kernel. "inccb" 523 * should be the CCB that is copied in from the user. 524 */ 525 static int 526 passsendccb(struct cam_periph *periph, union ccb *ccb, union ccb *inccb) 527 { 528 struct pass_softc *softc; 529 struct cam_periph_map_info mapinfo; 530 int error, need_unmap; 531 532 softc = (struct pass_softc *)periph->softc; 533 534 need_unmap = 0; 535 536 /* 537 * There are some fields in the CCB header that need to be 538 * preserved, the rest we get from the user. 539 */ 540 xpt_merge_ccb(ccb, inccb); 541 542 /* 543 * There's no way for the user to have a completion 544 * function, so we put our own completion function in here. 545 */ 546 ccb->ccb_h.cbfcnp = passdone; 547 548 /* 549 * We only attempt to map the user memory into kernel space 550 * if they haven't passed in a physical memory pointer, 551 * and if there is actually an I/O operation to perform. 552 * Right now cam_periph_mapmem() only supports SCSI and device 553 * match CCBs. For the SCSI CCBs, we only pass the CCB in if 554 * there's actually data to map. cam_periph_mapmem() will do the 555 * right thing, even if there isn't data to map, but since CCBs 556 * without data are a reasonably common occurance (e.g. test unit 557 * ready), it will save a few cycles if we check for it here. 558 */ 559 if (((ccb->ccb_h.flags & CAM_DATA_PHYS) == 0) 560 && (((ccb->ccb_h.func_code == XPT_SCSI_IO) 561 && ((ccb->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE)) 562 || (ccb->ccb_h.func_code == XPT_DEV_MATCH))) { 563 564 bzero(&mapinfo, sizeof(mapinfo)); 565 566 /* 567 * cam_periph_mapmem calls into proc and vm functions that can 568 * sleep as well as trigger I/O, so we can't hold the lock. 569 * Dropping it here is reasonably safe. 570 */ 571 cam_periph_unlock(periph); 572 error = cam_periph_mapmem(ccb, &mapinfo); 573 cam_periph_lock(periph); 574 575 /* 576 * cam_periph_mapmem returned an error, we can't continue. 577 * Return the error to the user. 578 */ 579 if (error) 580 return(error); 581 582 /* 583 * We successfully mapped the memory in, so we need to 584 * unmap it when the transaction is done. 585 */ 586 need_unmap = 1; 587 } 588 589 /* 590 * If the user wants us to perform any error recovery, then honor 591 * that request. Otherwise, it's up to the user to perform any 592 * error recovery. 593 */ 594 error = cam_periph_runccb(ccb, 595 (ccb->ccb_h.flags & CAM_PASS_ERR_RECOVER) ? 596 passerror : NULL, 597 /* cam_flags */ CAM_RETRY_SELTO, 598 /* sense_flags */SF_RETRY_UA, 599 &softc->device_stats); 600 601 if (need_unmap != 0) 602 cam_periph_unmapmem(ccb, &mapinfo); 603 604 ccb->ccb_h.cbfcnp = NULL; 605 ccb->ccb_h.periph_priv = inccb->ccb_h.periph_priv; 606 bcopy(ccb, inccb, sizeof(union ccb)); 607 608 return(error); 609 } 610 611 static int 612 passerror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags) 613 { 614 struct cam_periph *periph; 615 struct pass_softc *softc; 616 617 periph = xpt_path_periph(ccb->ccb_h.path); 618 softc = (struct pass_softc *)periph->softc; 619 620 return(cam_periph_error(ccb, cam_flags, sense_flags, 621 &softc->saved_ccb)); 622 } 623