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