1 /* $NetBSD: ch.c,v 1.93 2020/12/18 01:55:22 thorpej Exp $ */ 2 3 /*- 4 * Copyright (c) 1996, 1997, 1998, 1999, 2004 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility, 9 * NASA Ames Research Center. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 #include <sys/cdefs.h> 34 __KERNEL_RCSID(0, "$NetBSD: ch.c,v 1.93 2020/12/18 01:55:22 thorpej Exp $"); 35 36 #include <sys/param.h> 37 #include <sys/systm.h> 38 #include <sys/kernel.h> 39 #include <sys/errno.h> 40 #include <sys/ioctl.h> 41 #include <sys/buf.h> 42 #include <sys/proc.h> 43 #include <sys/chio.h> 44 #include <sys/device.h> 45 #include <sys/malloc.h> 46 #include <sys/conf.h> 47 #include <sys/fcntl.h> 48 #include <sys/vnode.h> 49 #include <sys/time.h> 50 #include <sys/select.h> 51 #include <sys/poll.h> 52 53 #include <dev/scsipi/scsipi_all.h> 54 #include <dev/scsipi/scsi_all.h> 55 #include <dev/scsipi/scsi_changer.h> 56 #include <dev/scsipi/scsiconf.h> 57 58 #define CHRETRIES 2 59 #define CHTIMEOUT (5 * 60 * 1000) 60 61 #define CHUNIT(x) (minor((x))) 62 63 struct ch_softc { 64 device_t sc_dev; /* generic device info */ 65 struct scsipi_periph *sc_periph;/* our periph data */ 66 67 u_int sc_events; /* event bitmask */ 68 struct selinfo sc_selq; /* select/poll queue for events */ 69 70 int sc_flags; /* misc. info */ 71 72 int sc_picker; /* current picker */ 73 74 /* 75 * The following information is obtained from the 76 * element address assignment page. 77 */ 78 int sc_firsts[4]; /* firsts, indexed by CHET_* */ 79 int sc_counts[4]; /* counts, indexed by CHET_* */ 80 81 /* 82 * The following mask defines the legal combinations 83 * of elements for the MOVE MEDIUM command. 84 */ 85 u_int8_t sc_movemask[4]; 86 87 /* 88 * As above, but for EXCHANGE MEDIUM. 89 */ 90 u_int8_t sc_exchangemask[4]; 91 92 /* 93 * Quirks; see below. 94 */ 95 int sc_settledelay; /* delay for settle */ 96 97 }; 98 99 /* sc_flags */ 100 #define CHF_ROTATE 0x01 /* picker can rotate */ 101 102 /* Autoconfiguration glue */ 103 static int chmatch(device_t, cfdata_t, void *); 104 static void chattach(device_t, device_t, void *); 105 106 CFATTACH_DECL_NEW(ch, sizeof(struct ch_softc), 107 chmatch, chattach, NULL, NULL); 108 109 extern struct cfdriver ch_cd; 110 111 static struct scsipi_inquiry_pattern ch_patterns[] = { 112 {T_CHANGER, T_REMOV, 113 "", "", ""}, 114 }; 115 116 static dev_type_open(chopen); 117 static dev_type_close(chclose); 118 static dev_type_read(chread); 119 static dev_type_ioctl(chioctl); 120 static dev_type_poll(chpoll); 121 static dev_type_kqfilter(chkqfilter); 122 123 const struct cdevsw ch_cdevsw = { 124 .d_open = chopen, 125 .d_close = chclose, 126 .d_read = chread, 127 .d_write = nowrite, 128 .d_ioctl = chioctl, 129 .d_stop = nostop, 130 .d_tty = notty, 131 .d_poll = chpoll, 132 .d_mmap = nommap, 133 .d_kqfilter = chkqfilter, 134 .d_discard = nodiscard, 135 .d_flag = D_OTHER | D_MPSAFE 136 }; 137 138 /* SCSI glue */ 139 static int ch_interpret_sense(struct scsipi_xfer *); 140 141 static const struct scsipi_periphsw ch_switch = { 142 ch_interpret_sense, /* check our error handler first */ 143 NULL, /* no queue; our commands are synchronous */ 144 NULL, /* have no async handler */ 145 NULL, /* nothing to be done when xfer is done */ 146 }; 147 148 static int ch_move(struct ch_softc *, struct changer_move_request *); 149 static int ch_exchange(struct ch_softc *, 150 struct changer_exchange_request *); 151 static int ch_position(struct ch_softc *, 152 struct changer_position_request *); 153 static int ch_ielem(struct ch_softc *); 154 static int ch_ousergetelemstatus(struct ch_softc *, int, u_int8_t *); 155 static int ch_usergetelemstatus(struct ch_softc *, 156 struct changer_element_status_request *); 157 static int ch_getelemstatus(struct ch_softc *, int, int, void *, 158 size_t, int, int); 159 static int ch_setvoltag(struct ch_softc *, 160 struct changer_set_voltag_request *); 161 static int ch_get_params(struct ch_softc *, int); 162 static void ch_get_quirks(struct ch_softc *, 163 struct scsipi_inquiry_pattern *); 164 static void ch_event(struct ch_softc *, u_int); 165 static int ch_map_element(struct ch_softc *, u_int16_t, int *, int *); 166 167 static void ch_voltag_convert_in(const struct changer_volume_tag *, 168 struct changer_voltag *); 169 static int ch_voltag_convert_out(const struct changer_voltag *, 170 struct changer_volume_tag *); 171 172 /* 173 * SCSI changer quirks. 174 */ 175 struct chquirk { 176 struct scsipi_inquiry_pattern cq_match; /* device id pattern */ 177 int cq_settledelay; /* settle delay, in seconds */ 178 }; 179 180 static const struct chquirk chquirks[] = { 181 {{T_CHANGER, T_REMOV, 182 "SPECTRA", "9000", "0200"}, 183 75}, 184 }; 185 186 static int 187 chmatch(device_t parent, cfdata_t match, 188 void *aux) 189 { 190 struct scsipibus_attach_args *sa = aux; 191 int priority; 192 193 (void)scsipi_inqmatch(&sa->sa_inqbuf, 194 (void *)ch_patterns, sizeof(ch_patterns) / sizeof(ch_patterns[0]), 195 sizeof(ch_patterns[0]), &priority); 196 197 return (priority); 198 } 199 200 static void 201 chattach(device_t parent, device_t self, void *aux) 202 { 203 struct ch_softc *sc = device_private(self); 204 struct scsipibus_attach_args *sa = aux; 205 struct scsipi_periph *periph = sa->sa_periph; 206 207 sc->sc_dev = self; 208 selinit(&sc->sc_selq); 209 210 /* Glue into the SCSI bus */ 211 sc->sc_periph = periph; 212 periph->periph_dev = sc->sc_dev; 213 periph->periph_switch = &ch_switch; 214 215 printf("\n"); 216 217 /* 218 * Find out our device's quirks. 219 */ 220 ch_get_quirks(sc, &sa->sa_inqbuf); 221 222 /* 223 * Some changers require a long time to settle out, to do 224 * tape inventory, for instance. 225 */ 226 if (sc->sc_settledelay) { 227 printf("%s: waiting %d seconds for changer to settle...\n", 228 device_xname(sc->sc_dev), sc->sc_settledelay); 229 delay(1000000 * sc->sc_settledelay); 230 } 231 232 /* 233 * Get information about the device. Note we can't use 234 * interrupts yet. 235 */ 236 if (ch_get_params(sc, XS_CTL_DISCOVERY|XS_CTL_IGNORE_MEDIA_CHANGE)) 237 printf("%s: offline\n", device_xname(sc->sc_dev)); 238 else { 239 #define PLURAL(c) (c) == 1 ? "" : "s" 240 printf("%s: %d slot%s, %d drive%s, %d picker%s, %d portal%s\n", 241 device_xname(sc->sc_dev), 242 sc->sc_counts[CHET_ST], PLURAL(sc->sc_counts[CHET_ST]), 243 sc->sc_counts[CHET_DT], PLURAL(sc->sc_counts[CHET_DT]), 244 sc->sc_counts[CHET_MT], PLURAL(sc->sc_counts[CHET_MT]), 245 sc->sc_counts[CHET_IE], PLURAL(sc->sc_counts[CHET_IE])); 246 #undef PLURAL 247 #ifdef CHANGER_DEBUG 248 printf("%s: move mask: 0x%x 0x%x 0x%x 0x%x\n", 249 device_xname(sc->sc_dev), 250 sc->sc_movemask[CHET_MT], sc->sc_movemask[CHET_ST], 251 sc->sc_movemask[CHET_IE], sc->sc_movemask[CHET_DT]); 252 printf("%s: exchange mask: 0x%x 0x%x 0x%x 0x%x\n", 253 device_xname(sc->sc_dev), 254 sc->sc_exchangemask[CHET_MT], sc->sc_exchangemask[CHET_ST], 255 sc->sc_exchangemask[CHET_IE], sc->sc_exchangemask[CHET_DT]); 256 #endif /* CHANGER_DEBUG */ 257 } 258 259 /* Default the current picker. */ 260 sc->sc_picker = sc->sc_firsts[CHET_MT]; 261 } 262 263 static int 264 chopen(dev_t dev, int flags, int fmt, struct lwp *l) 265 { 266 struct ch_softc *sc; 267 struct scsipi_periph *periph; 268 struct scsipi_adapter *adapt; 269 int unit, error; 270 271 unit = CHUNIT(dev); 272 sc = device_lookup_private(&ch_cd, unit); 273 if (sc == NULL) 274 return (ENXIO); 275 276 periph = sc->sc_periph; 277 adapt = periph->periph_channel->chan_adapter; 278 279 /* 280 * Only allow one open at a time. 281 */ 282 if (periph->periph_flags & PERIPH_OPEN) 283 return (EBUSY); 284 285 if ((error = scsipi_adapter_addref(adapt)) != 0) 286 return (error); 287 288 /* 289 * Make sure the unit is on-line. If a UNIT ATTENTION 290 * occurs, we will mark that an Init-Element-Status is 291 * needed in ch_get_params(). 292 * 293 * We ignore NOT READY in case e.g a magazine isn't actually 294 * loaded into the changer or a tape isn't in the drive. 295 */ 296 error = scsipi_test_unit_ready(periph, XS_CTL_IGNORE_NOT_READY); 297 if (error) 298 goto bad; 299 300 periph->periph_flags |= PERIPH_OPEN; 301 302 /* 303 * Make sure our parameters are up to date. 304 */ 305 if ((error = ch_get_params(sc, 0)) != 0) 306 goto bad; 307 308 return (0); 309 310 bad: 311 scsipi_adapter_delref(adapt); 312 periph->periph_flags &= ~PERIPH_OPEN; 313 return (error); 314 } 315 316 static int 317 chclose(dev_t dev, int flags, int fmt, struct lwp *l) 318 { 319 struct ch_softc *sc = device_lookup_private(&ch_cd, CHUNIT(dev)); 320 struct scsipi_periph *periph = sc->sc_periph; 321 struct scsipi_adapter *adapt = periph->periph_channel->chan_adapter; 322 323 scsipi_wait_drain(periph); 324 325 scsipi_adapter_delref(adapt); 326 327 sc->sc_events = 0; 328 329 periph->periph_flags &= ~PERIPH_OPEN; 330 return (0); 331 } 332 333 static int 334 chread(dev_t dev, struct uio *uio, int flags) 335 { 336 struct ch_softc *sc = device_lookup_private(&ch_cd, CHUNIT(dev)); 337 int error; 338 339 if (uio->uio_resid != CHANGER_EVENT_SIZE) 340 return (EINVAL); 341 342 /* 343 * Read never blocks; if there are no events pending, we just 344 * return an all-clear bitmask. 345 */ 346 error = uiomove(&sc->sc_events, CHANGER_EVENT_SIZE, uio); 347 if (error == 0) 348 sc->sc_events = 0; 349 return (error); 350 } 351 352 static int 353 chioctl(dev_t dev, u_long cmd, void *data, int flags, struct lwp *l) 354 { 355 struct ch_softc *sc = device_lookup_private(&ch_cd, CHUNIT(dev)); 356 int error = 0; 357 358 /* 359 * If this command can change the device's state, we must 360 * have the device open for writing. 361 */ 362 switch (cmd) { 363 case CHIOGPICKER: 364 case CHIOGPARAMS: 365 case OCHIOGSTATUS: 366 break; 367 368 default: 369 if ((flags & FWRITE) == 0) 370 return (EBADF); 371 } 372 373 switch (cmd) { 374 case CHIOMOVE: 375 error = ch_move(sc, (struct changer_move_request *)data); 376 break; 377 378 case CHIOEXCHANGE: 379 error = ch_exchange(sc, 380 (struct changer_exchange_request *)data); 381 break; 382 383 case CHIOPOSITION: 384 error = ch_position(sc, 385 (struct changer_position_request *)data); 386 break; 387 388 case CHIOGPICKER: 389 *(int *)data = sc->sc_picker - sc->sc_firsts[CHET_MT]; 390 break; 391 392 case CHIOSPICKER: 393 { 394 int new_picker = *(int *)data; 395 396 if (new_picker > (sc->sc_counts[CHET_MT] - 1)) 397 return (EINVAL); 398 sc->sc_picker = sc->sc_firsts[CHET_MT] + new_picker; 399 break; 400 } 401 402 case CHIOGPARAMS: 403 { 404 struct changer_params *cp = (struct changer_params *)data; 405 406 cp->cp_curpicker = sc->sc_picker - sc->sc_firsts[CHET_MT]; 407 cp->cp_npickers = sc->sc_counts[CHET_MT]; 408 cp->cp_nslots = sc->sc_counts[CHET_ST]; 409 cp->cp_nportals = sc->sc_counts[CHET_IE]; 410 cp->cp_ndrives = sc->sc_counts[CHET_DT]; 411 break; 412 } 413 414 case CHIOIELEM: 415 error = ch_ielem(sc); 416 if (error == 0) { 417 sc->sc_periph->periph_flags |= PERIPH_MEDIA_LOADED; 418 } 419 break; 420 421 case OCHIOGSTATUS: 422 { 423 struct ochanger_element_status_request *cesr = 424 (struct ochanger_element_status_request *)data; 425 426 error = ch_ousergetelemstatus(sc, cesr->cesr_type, 427 cesr->cesr_data); 428 break; 429 } 430 431 case CHIOGSTATUS: 432 error = ch_usergetelemstatus(sc, 433 (struct changer_element_status_request *)data); 434 break; 435 436 case CHIOSVOLTAG: 437 error = ch_setvoltag(sc, 438 (struct changer_set_voltag_request *)data); 439 break; 440 441 /* Implement prevent/allow? */ 442 443 default: 444 error = scsipi_do_ioctl(sc->sc_periph, dev, cmd, data, 445 flags, l); 446 break; 447 } 448 449 return (error); 450 } 451 452 static int 453 chpoll(dev_t dev, int events, struct lwp *l) 454 { 455 struct ch_softc *sc = device_lookup_private(&ch_cd, CHUNIT(dev)); 456 int revents; 457 458 revents = events & (POLLOUT | POLLWRNORM); 459 460 if ((events & (POLLIN | POLLRDNORM)) == 0) 461 return (revents); 462 463 if (sc->sc_events == 0) 464 revents |= events & (POLLIN | POLLRDNORM); 465 else 466 selrecord(l, &sc->sc_selq); 467 468 return (revents); 469 } 470 471 static void 472 filt_chdetach(struct knote *kn) 473 { 474 struct ch_softc *sc = kn->kn_hook; 475 476 selremove_knote(&sc->sc_selq, kn); 477 } 478 479 static int 480 filt_chread(struct knote *kn, long hint) 481 { 482 struct ch_softc *sc = kn->kn_hook; 483 484 if (sc->sc_events == 0) 485 return (0); 486 kn->kn_data = CHANGER_EVENT_SIZE; 487 return (1); 488 } 489 490 static const struct filterops chread_filtops = { 491 .f_isfd = 1, 492 .f_attach = NULL, 493 .f_detach = filt_chdetach, 494 .f_event = filt_chread, 495 }; 496 497 static const struct filterops chwrite_filtops = { 498 .f_isfd = 1, 499 .f_attach = NULL, 500 .f_detach = filt_chdetach, 501 .f_event = filt_seltrue, 502 }; 503 504 static int 505 chkqfilter(dev_t dev, struct knote *kn) 506 { 507 struct ch_softc *sc = device_lookup_private(&ch_cd, CHUNIT(dev)); 508 509 switch (kn->kn_filter) { 510 case EVFILT_READ: 511 kn->kn_fop = &chread_filtops; 512 break; 513 514 case EVFILT_WRITE: 515 kn->kn_fop = &chwrite_filtops; 516 break; 517 518 default: 519 return (EINVAL); 520 } 521 522 kn->kn_hook = sc; 523 524 selrecord_knote(&sc->sc_selq, kn); 525 526 return (0); 527 } 528 529 static int 530 ch_interpret_sense(struct scsipi_xfer *xs) 531 { 532 struct scsipi_periph *periph = xs->xs_periph; 533 struct scsi_sense_data *sense = &xs->sense.scsi_sense; 534 struct ch_softc *sc = device_private(periph->periph_dev); 535 u_int16_t asc_ascq; 536 537 /* 538 * If the periph is already recovering, just do the 539 * normal error recovering. 540 */ 541 if (periph->periph_flags & PERIPH_RECOVERING) 542 return (EJUSTRETURN); 543 544 /* 545 * If it isn't an extended or extended/deferred error, let 546 * the generic code handle it. 547 */ 548 if (SSD_RCODE(sense->response_code) != SSD_RCODE_CURRENT && 549 SSD_RCODE(sense->response_code) != SSD_RCODE_DEFERRED) 550 return (EJUSTRETURN); 551 552 /* 553 * We're only interested in condtions that 554 * indicate potential inventory violation. 555 * 556 * We use ASC/ASCQ codes for this. 557 */ 558 559 asc_ascq = (((u_int16_t) sense->asc) << 8) | 560 sense->ascq; 561 562 switch (asc_ascq) { 563 case 0x2800: 564 /* "Not Ready To Ready Transition (Medium May Have Changed)" */ 565 case 0x2900: 566 /* "Power On, Reset, or Bus Device Reset Occurred" */ 567 sc->sc_periph->periph_flags &= ~PERIPH_MEDIA_LOADED; 568 /* 569 * Enqueue an Element-Status-Changed event, and wake up 570 * any processes waiting for them. 571 */ 572 if ((xs->xs_control & XS_CTL_IGNORE_MEDIA_CHANGE) == 0) 573 ch_event(sc, CHEV_ELEMENT_STATUS_CHANGED); 574 break; 575 default: 576 break; 577 } 578 579 return (EJUSTRETURN); 580 } 581 582 static void 583 ch_event(struct ch_softc *sc, u_int event) 584 { 585 586 sc->sc_events |= event; 587 selnotify(&sc->sc_selq, 0, 0); 588 } 589 590 static int 591 ch_move(struct ch_softc *sc, struct changer_move_request *cm) 592 { 593 struct scsi_move_medium cmd; 594 u_int16_t fromelem, toelem; 595 596 /* 597 * Check arguments. 598 */ 599 if ((cm->cm_fromtype > CHET_DT) || (cm->cm_totype > CHET_DT)) 600 return (EINVAL); 601 if ((cm->cm_fromunit > (sc->sc_counts[cm->cm_fromtype] - 1)) || 602 (cm->cm_tounit > (sc->sc_counts[cm->cm_totype] - 1))) 603 return (ENODEV); 604 605 /* 606 * Check the request against the changer's capabilities. 607 */ 608 if ((sc->sc_movemask[cm->cm_fromtype] & (1 << cm->cm_totype)) == 0) 609 return (ENODEV); 610 611 /* 612 * Calculate the source and destination elements. 613 */ 614 fromelem = sc->sc_firsts[cm->cm_fromtype] + cm->cm_fromunit; 615 toelem = sc->sc_firsts[cm->cm_totype] + cm->cm_tounit; 616 617 /* 618 * Build the SCSI command. 619 */ 620 memset(&cmd, 0, sizeof(cmd)); 621 cmd.opcode = MOVE_MEDIUM; 622 _lto2b(sc->sc_picker, cmd.tea); 623 _lto2b(fromelem, cmd.src); 624 _lto2b(toelem, cmd.dst); 625 if (cm->cm_flags & CM_INVERT) 626 cmd.flags |= MOVE_MEDIUM_INVERT; 627 628 /* 629 * Send command to changer. 630 */ 631 return (scsipi_command(sc->sc_periph, (void *)&cmd, sizeof(cmd), 0, 0, 632 CHRETRIES, CHTIMEOUT, NULL, 0)); 633 } 634 635 static int 636 ch_exchange(struct ch_softc *sc, struct changer_exchange_request *ce) 637 { 638 struct scsi_exchange_medium cmd; 639 u_int16_t src, dst1, dst2; 640 641 /* 642 * Check arguments. 643 */ 644 if ((ce->ce_srctype > CHET_DT) || (ce->ce_fdsttype > CHET_DT) || 645 (ce->ce_sdsttype > CHET_DT)) 646 return (EINVAL); 647 if ((ce->ce_srcunit > (sc->sc_counts[ce->ce_srctype] - 1)) || 648 (ce->ce_fdstunit > (sc->sc_counts[ce->ce_fdsttype] - 1)) || 649 (ce->ce_sdstunit > (sc->sc_counts[ce->ce_sdsttype] - 1))) 650 return (ENODEV); 651 652 /* 653 * Check the request against the changer's capabilities. 654 */ 655 if (((sc->sc_exchangemask[ce->ce_srctype] & 656 (1 << ce->ce_fdsttype)) == 0) || 657 ((sc->sc_exchangemask[ce->ce_fdsttype] & 658 (1 << ce->ce_sdsttype)) == 0)) 659 return (ENODEV); 660 661 /* 662 * Calculate the source and destination elements. 663 */ 664 src = sc->sc_firsts[ce->ce_srctype] + ce->ce_srcunit; 665 dst1 = sc->sc_firsts[ce->ce_fdsttype] + ce->ce_fdstunit; 666 dst2 = sc->sc_firsts[ce->ce_sdsttype] + ce->ce_sdstunit; 667 668 /* 669 * Build the SCSI command. 670 */ 671 memset(&cmd, 0, sizeof(cmd)); 672 cmd.opcode = EXCHANGE_MEDIUM; 673 _lto2b(sc->sc_picker, cmd.tea); 674 _lto2b(src, cmd.src); 675 _lto2b(dst1, cmd.fdst); 676 _lto2b(dst2, cmd.sdst); 677 if (ce->ce_flags & CE_INVERT1) 678 cmd.flags |= EXCHANGE_MEDIUM_INV1; 679 if (ce->ce_flags & CE_INVERT2) 680 cmd.flags |= EXCHANGE_MEDIUM_INV2; 681 682 /* 683 * Send command to changer. 684 */ 685 return (scsipi_command(sc->sc_periph, (void *)&cmd, sizeof(cmd), 0, 0, 686 CHRETRIES, CHTIMEOUT, NULL, 0)); 687 } 688 689 static int 690 ch_position(struct ch_softc *sc, struct changer_position_request *cp) 691 { 692 struct scsi_position_to_element cmd; 693 u_int16_t dst; 694 695 /* 696 * Check arguments. 697 */ 698 if (cp->cp_type > CHET_DT) 699 return (EINVAL); 700 if (cp->cp_unit > (sc->sc_counts[cp->cp_type] - 1)) 701 return (ENODEV); 702 703 /* 704 * Calculate the destination element. 705 */ 706 dst = sc->sc_firsts[cp->cp_type] + cp->cp_unit; 707 708 /* 709 * Build the SCSI command. 710 */ 711 memset(&cmd, 0, sizeof(cmd)); 712 cmd.opcode = POSITION_TO_ELEMENT; 713 _lto2b(sc->sc_picker, cmd.tea); 714 _lto2b(dst, cmd.dst); 715 if (cp->cp_flags & CP_INVERT) 716 cmd.flags |= POSITION_TO_ELEMENT_INVERT; 717 718 /* 719 * Send command to changer. 720 */ 721 return (scsipi_command(sc->sc_periph, (void *)&cmd, sizeof(cmd), 0, 0, 722 CHRETRIES, CHTIMEOUT, NULL, 0)); 723 } 724 725 /* 726 * Perform a READ ELEMENT STATUS on behalf of the user, and return to 727 * the user only the data the user is interested in. This returns the 728 * old data format. 729 */ 730 static int 731 ch_ousergetelemstatus(struct ch_softc *sc, int chet, u_int8_t *uptr) 732 { 733 struct read_element_status_header *st_hdrp, st_hdr; 734 struct read_element_status_page_header *pg_hdrp; 735 struct read_element_status_descriptor *desc; 736 size_t size, desclen; 737 void *data; 738 int avail, i, error = 0; 739 u_int8_t user_data; 740 741 /* 742 * If there are no elements of the requested type in the changer, 743 * the request is invalid. 744 */ 745 if (sc->sc_counts[chet] == 0) 746 return (EINVAL); 747 748 /* 749 * Do the request the user wants, but only read the status header. 750 * This will tell us the amount of storage we must allocate in 751 * order to read all data. 752 */ 753 error = ch_getelemstatus(sc, sc->sc_firsts[chet], 754 sc->sc_counts[chet], &st_hdr, sizeof(st_hdr), 0, 0); 755 if (error) 756 return (error); 757 758 size = sizeof(struct read_element_status_header) + 759 _3btol(st_hdr.nbytes); 760 761 /* 762 * We must have at least room for the status header and 763 * one page header (since we only ask for one element type 764 * at a time). 765 */ 766 if (size < (sizeof(struct read_element_status_header) + 767 sizeof(struct read_element_status_page_header))) 768 return (EIO); 769 770 /* 771 * Allocate the storage and do the request again. 772 */ 773 data = malloc(size, M_DEVBUF, M_WAITOK); 774 error = ch_getelemstatus(sc, sc->sc_firsts[chet], 775 sc->sc_counts[chet], data, size, 0, 0); 776 if (error) 777 goto done; 778 779 st_hdrp = (struct read_element_status_header *)data; 780 pg_hdrp = (struct read_element_status_page_header *)((u_long)st_hdrp + 781 sizeof(struct read_element_status_header)); 782 desclen = _2btol(pg_hdrp->edl); 783 784 /* 785 * Fill in the user status array. 786 */ 787 avail = _2btol(st_hdrp->count); 788 789 if (avail != sc->sc_counts[chet]) 790 printf("%s: warning, READ ELEMENT STATUS avail != count\n", 791 device_xname(sc->sc_dev)); 792 793 desc = (struct read_element_status_descriptor *)((u_long)data + 794 sizeof(struct read_element_status_header) + 795 sizeof(struct read_element_status_page_header)); 796 for (i = 0; i < avail; ++i) { 797 user_data = desc->flags1; 798 error = copyout(&user_data, &uptr[i], avail); 799 if (error) 800 break; 801 desc = (struct read_element_status_descriptor *)((u_long)desc 802 + desclen); 803 } 804 805 done: 806 if (data != NULL) 807 free(data, M_DEVBUF); 808 return (error); 809 } 810 811 /* 812 * Perform a READ ELEMENT STATUS on behalf of the user. This returns 813 * the new (more complete) data format. 814 */ 815 static int 816 ch_usergetelemstatus(struct ch_softc *sc, 817 struct changer_element_status_request *cesr) 818 { 819 struct scsipi_channel *chan = sc->sc_periph->periph_channel; 820 struct scsipi_periph *dtperiph; 821 struct read_element_status_header *st_hdrp, st_hdr; 822 struct read_element_status_page_header *pg_hdrp; 823 struct read_element_status_descriptor *desc; 824 struct changer_volume_tag *avol, *pvol; 825 size_t size, desclen, stddesclen, offset; 826 int first, avail, i, error = 0; 827 void *data; 828 void *uvendptr; 829 struct changer_element_status ces; 830 831 /* 832 * Check arguments. 833 */ 834 if (cesr->cesr_type > CHET_DT) 835 return (EINVAL); 836 if (sc->sc_counts[cesr->cesr_type] == 0) 837 return (ENODEV); 838 if (cesr->cesr_unit > (sc->sc_counts[cesr->cesr_type] - 1)) 839 return (ENODEV); 840 if (cesr->cesr_count > 841 (sc->sc_counts[cesr->cesr_type] + cesr->cesr_unit)) 842 return (EINVAL); 843 844 /* 845 * Do the request the user wants, but only read the status header. 846 * This will tell us the amount of storage we must allocate 847 * in order to read all the data. 848 */ 849 error = ch_getelemstatus(sc, sc->sc_firsts[cesr->cesr_type] + 850 cesr->cesr_unit, cesr->cesr_count, &st_hdr, sizeof(st_hdr), 0, 851 cesr->cesr_flags); 852 if (error) 853 return (error); 854 855 size = sizeof(struct read_element_status_header) + 856 _3btol(st_hdr.nbytes); 857 858 /* 859 * We must have at least room for the status header and 860 * one page header (since we only ask for oen element type 861 * at a time). 862 */ 863 if (size < (sizeof(struct read_element_status_header) + 864 sizeof(struct read_element_status_page_header))) 865 return (EIO); 866 867 /* 868 * Allocate the storage and do the request again. 869 */ 870 data = malloc(size, M_DEVBUF, M_WAITOK); 871 error = ch_getelemstatus(sc, sc->sc_firsts[cesr->cesr_type] + 872 cesr->cesr_unit, cesr->cesr_count, data, size, 0, 873 cesr->cesr_flags); 874 if (error) 875 goto done; 876 877 st_hdrp = (struct read_element_status_header *)data; 878 pg_hdrp = (struct read_element_status_page_header *)((u_long)st_hdrp + 879 sizeof(struct read_element_status_header)); 880 desclen = _2btol(pg_hdrp->edl); 881 882 /* 883 * Fill in the user status array. 884 */ 885 first = _2btol(st_hdrp->fear); 886 if (first < (sc->sc_firsts[cesr->cesr_type] + cesr->cesr_unit) || 887 first >= (sc->sc_firsts[cesr->cesr_type] + cesr->cesr_unit + 888 cesr->cesr_count)) { 889 error = EIO; 890 goto done; 891 } 892 first -= sc->sc_firsts[cesr->cesr_type] + cesr->cesr_unit; 893 894 avail = _2btol(st_hdrp->count); 895 if (avail <= 0 || avail > cesr->cesr_count) { 896 error = EIO; 897 goto done; 898 } 899 900 offset = sizeof(struct read_element_status_header) + 901 sizeof(struct read_element_status_page_header); 902 903 for (i = 0; i < cesr->cesr_count; i++) { 904 memset(&ces, 0, sizeof(ces)); 905 if (i < first || i >= (first + avail)) { 906 error = copyout(&ces, &cesr->cesr_data[i], 907 sizeof(ces)); 908 if (error) 909 goto done; 910 } 911 912 desc = (struct read_element_status_descriptor *) 913 ((char *)data + offset); 914 stddesclen = sizeof(struct read_element_status_descriptor); 915 offset += desclen; 916 917 ces.ces_flags = CESTATUS_STATUS_VALID; 918 919 /* 920 * The SCSI flags conveniently map directly to the 921 * chio API flags. 922 */ 923 ces.ces_flags |= (desc->flags1 & 0x3f); 924 925 ces.ces_asc = desc->sense_code; 926 ces.ces_ascq = desc->sense_qual; 927 928 /* 929 * For Data Transport elemenets, get the SCSI ID and LUN, 930 * and attempt to map them to a device name if they're 931 * on the same SCSI bus. 932 */ 933 if (desc->dt_scsi_flags & READ_ELEMENT_STATUS_DT_IDVALID) { 934 ces.ces_target = desc->dt_scsi_addr; 935 ces.ces_flags |= CESTATUS_TARGET_VALID; 936 } 937 if (desc->dt_scsi_flags & READ_ELEMENT_STATUS_DT_LUVALID) { 938 ces.ces_lun = desc->dt_scsi_flags & 939 READ_ELEMENT_STATUS_DT_LUNMASK; 940 ces.ces_flags |= CESTATUS_LUN_VALID; 941 } 942 if (desc->dt_scsi_flags & READ_ELEMENT_STATUS_DT_NOTBUS) 943 ces.ces_flags |= CESTATUS_NOTBUS; 944 else if ((ces.ces_flags & 945 (CESTATUS_TARGET_VALID|CESTATUS_LUN_VALID)) == 946 (CESTATUS_TARGET_VALID|CESTATUS_LUN_VALID)) { 947 if (ces.ces_target < chan->chan_ntargets && 948 ces.ces_lun < chan->chan_nluns && 949 (dtperiph = scsipi_lookup_periph(chan, 950 ces.ces_target, ces.ces_lun)) != NULL && 951 dtperiph->periph_dev != NULL) { 952 strlcpy(ces.ces_xname, 953 device_xname(dtperiph->periph_dev), 954 sizeof(ces.ces_xname)); 955 ces.ces_flags |= CESTATUS_XNAME_VALID; 956 } 957 } 958 959 if (desc->flags2 & READ_ELEMENT_STATUS_INVERT) 960 ces.ces_flags |= CESTATUS_INVERTED; 961 962 if (desc->flags2 & READ_ELEMENT_STATUS_SVALID) { 963 if (ch_map_element(sc, _2btol(desc->ssea), 964 &ces.ces_from_type, &ces.ces_from_unit)) 965 ces.ces_flags |= CESTATUS_FROM_VALID; 966 } 967 968 /* 969 * Extract volume tag information. 970 */ 971 switch (pg_hdrp->flags & 972 (READ_ELEMENT_STATUS_PVOLTAG|READ_ELEMENT_STATUS_AVOLTAG)) { 973 case (READ_ELEMENT_STATUS_PVOLTAG|READ_ELEMENT_STATUS_AVOLTAG): 974 pvol = (struct changer_volume_tag *)(desc + 1); 975 avol = pvol + 1; 976 break; 977 978 case READ_ELEMENT_STATUS_PVOLTAG: 979 pvol = (struct changer_volume_tag *)(desc + 1); 980 avol = NULL; 981 break; 982 983 case READ_ELEMENT_STATUS_AVOLTAG: 984 pvol = NULL; 985 avol = (struct changer_volume_tag *)(desc + 1); 986 break; 987 988 default: 989 avol = pvol = NULL; 990 break; 991 } 992 993 if (pvol != NULL) { 994 ch_voltag_convert_in(pvol, &ces.ces_pvoltag); 995 ces.ces_flags |= CESTATUS_PVOL_VALID; 996 stddesclen += sizeof(struct changer_volume_tag); 997 } 998 if (avol != NULL) { 999 ch_voltag_convert_in(avol, &ces.ces_avoltag); 1000 ces.ces_flags |= CESTATUS_AVOL_VALID; 1001 stddesclen += sizeof(struct changer_volume_tag); 1002 } 1003 1004 /* 1005 * Compute vendor-specific length. Note the 4 reserved 1006 * bytes between the volume tags and the vendor-specific 1007 * data. Copy it out of the user wants it. 1008 */ 1009 stddesclen += 4; 1010 if (desclen > stddesclen) 1011 ces.ces_vendor_len = desclen - stddesclen; 1012 1013 if (ces.ces_vendor_len != 0 && cesr->cesr_vendor_data != NULL) { 1014 error = copyin(&cesr->cesr_vendor_data[i], &uvendptr, 1015 sizeof(uvendptr)); 1016 if (error) 1017 goto done; 1018 error = copyout((void *)((u_long)desc + stddesclen), 1019 uvendptr, ces.ces_vendor_len); 1020 if (error) 1021 goto done; 1022 } 1023 1024 /* 1025 * Now copy out the status descriptor we've constructed. 1026 */ 1027 error = copyout(&ces, &cesr->cesr_data[i], sizeof(ces)); 1028 if (error) 1029 goto done; 1030 } 1031 1032 done: 1033 if (data != NULL) 1034 free(data, M_DEVBUF); 1035 return (error); 1036 } 1037 1038 static int 1039 ch_getelemstatus(struct ch_softc *sc, int first, int count, void *data, 1040 size_t datalen, int scsiflags, int flags) 1041 { 1042 struct scsi_read_element_status cmd; 1043 1044 /* 1045 * Build SCSI command. 1046 */ 1047 memset(&cmd, 0, sizeof(cmd)); 1048 cmd.opcode = READ_ELEMENT_STATUS; 1049 cmd.byte2 = ELEMENT_TYPE_ALL; 1050 if (flags & CESR_VOLTAGS) 1051 cmd.byte2 |= READ_ELEMENT_STATUS_VOLTAG; 1052 _lto2b(first, cmd.sea); 1053 _lto2b(count, cmd.count); 1054 _lto3b(datalen, cmd.len); 1055 1056 /* 1057 * Send command to changer. 1058 */ 1059 return (scsipi_command(sc->sc_periph, (void *)&cmd, sizeof(cmd), 1060 (void *)data, datalen, 1061 CHRETRIES, CHTIMEOUT, NULL, scsiflags | XS_CTL_DATA_IN)); 1062 } 1063 1064 static int 1065 ch_setvoltag(struct ch_softc *sc, struct changer_set_voltag_request *csvr) 1066 { 1067 struct scsi_send_volume_tag cmd; 1068 struct changer_volume_tag voltag; 1069 void *data = NULL; 1070 size_t datalen = 0; 1071 int error; 1072 u_int16_t dst; 1073 1074 /* 1075 * Check arguments. 1076 */ 1077 if (csvr->csvr_type > CHET_DT) 1078 return (EINVAL); 1079 if (csvr->csvr_unit > (sc->sc_counts[csvr->csvr_type] - 1)) 1080 return (ENODEV); 1081 1082 dst = sc->sc_firsts[csvr->csvr_type] + csvr->csvr_unit; 1083 1084 /* 1085 * Build the SCSI command. 1086 */ 1087 memset(&cmd, 0, sizeof(cmd)); 1088 cmd.opcode = SEND_VOLUME_TAG; 1089 _lto2b(dst, cmd.eaddr); 1090 1091 #define ALTERNATE (csvr->csvr_flags & CSVR_ALTERNATE) 1092 1093 switch (csvr->csvr_flags & CSVR_MODE_MASK) { 1094 case CSVR_MODE_SET: 1095 cmd.sac = ALTERNATE ? SAC_ASSERT_ALT : SAC_ASSERT_PRIMARY; 1096 break; 1097 1098 case CSVR_MODE_REPLACE: 1099 cmd.sac = ALTERNATE ? SAC_REPLACE_ALT : SAC_REPLACE_PRIMARY; 1100 break; 1101 1102 case CSVR_MODE_CLEAR: 1103 cmd.sac = ALTERNATE ? SAC_UNDEFINED_ALT : SAC_UNDEFINED_PRIMARY; 1104 break; 1105 1106 default: 1107 return (EINVAL); 1108 } 1109 1110 #undef ALTERNATE 1111 1112 if (cmd.sac < SAC_UNDEFINED_PRIMARY) { 1113 error = ch_voltag_convert_out(&csvr->csvr_voltag, &voltag); 1114 if (error) 1115 return (error); 1116 data = &voltag; 1117 datalen = sizeof(voltag); 1118 _lto2b(datalen, cmd.length); 1119 } 1120 1121 /* 1122 * Send command to changer. 1123 */ 1124 return (scsipi_command(sc->sc_periph, (void *)&cmd, sizeof(cmd), 1125 (void *)data, datalen, CHRETRIES, CHTIMEOUT, NULL, 1126 datalen ? XS_CTL_DATA_OUT : 0)); 1127 } 1128 1129 static int 1130 ch_ielem(struct ch_softc *sc) 1131 { 1132 int tmo; 1133 struct scsi_initialize_element_status cmd; 1134 1135 /* 1136 * Build SCSI command. 1137 */ 1138 memset(&cmd, 0, sizeof(cmd)); 1139 cmd.opcode = INITIALIZE_ELEMENT_STATUS; 1140 1141 /* 1142 * Send command to changer. 1143 * 1144 * The problem is, how long to allow for the command? 1145 * It can take a *really* long time, and also depends 1146 * on unknowable factors such as whether there are 1147 * *almost* readable labels on tapes that a barcode 1148 * reader is trying to decipher. 1149 * 1150 * I'm going to make this long enough to allow 5 minutes 1151 * per element plus an initial 10 minute wait. 1152 */ 1153 tmo = sc->sc_counts[CHET_MT] + 1154 sc->sc_counts[CHET_ST] + 1155 sc->sc_counts[CHET_IE] + 1156 sc->sc_counts[CHET_DT]; 1157 tmo *= 5 * 60 * 1000; 1158 tmo += (10 * 60 * 1000); 1159 1160 return (scsipi_command(sc->sc_periph, (void *)&cmd, sizeof(cmd), 0, 0, 1161 CHRETRIES, tmo, NULL, XS_CTL_IGNORE_ILLEGAL_REQUEST)); 1162 } 1163 1164 /* 1165 * Ask the device about itself and fill in the parameters in our 1166 * softc. 1167 */ 1168 static int 1169 ch_get_params(struct ch_softc *sc, int scsiflags) 1170 { 1171 struct scsi_mode_sense_data { 1172 struct scsi_mode_parameter_header_6 header; 1173 union { 1174 struct page_element_address_assignment ea; 1175 struct page_transport_geometry_parameters tg; 1176 struct page_device_capabilities cap; 1177 } pages; 1178 } sense_data; 1179 int error, from; 1180 u_int8_t *moves, *exchanges; 1181 1182 /* 1183 * Grab info from the element address assignment page. 1184 */ 1185 memset(&sense_data, 0, sizeof(sense_data)); 1186 error = scsipi_mode_sense(sc->sc_periph, SMS_DBD, 0x1d, 1187 &sense_data.header, sizeof(sense_data), 1188 scsiflags, CHRETRIES, 6000); 1189 if (error) { 1190 aprint_error_dev(sc->sc_dev, "could not sense element address page\n"); 1191 return (error); 1192 } 1193 1194 sc->sc_firsts[CHET_MT] = _2btol(sense_data.pages.ea.mtea); 1195 sc->sc_counts[CHET_MT] = _2btol(sense_data.pages.ea.nmte); 1196 sc->sc_firsts[CHET_ST] = _2btol(sense_data.pages.ea.fsea); 1197 sc->sc_counts[CHET_ST] = _2btol(sense_data.pages.ea.nse); 1198 sc->sc_firsts[CHET_IE] = _2btol(sense_data.pages.ea.fieea); 1199 sc->sc_counts[CHET_IE] = _2btol(sense_data.pages.ea.niee); 1200 sc->sc_firsts[CHET_DT] = _2btol(sense_data.pages.ea.fdtea); 1201 sc->sc_counts[CHET_DT] = _2btol(sense_data.pages.ea.ndte); 1202 1203 /* XXX ask for transport geometry page XXX */ 1204 1205 /* 1206 * Grab info from the capabilities page. 1207 */ 1208 memset(&sense_data, 0, sizeof(sense_data)); 1209 /* 1210 * XXX: Note: not all changers can deal with disabled block descriptors 1211 */ 1212 error = scsipi_mode_sense(sc->sc_periph, SMS_DBD, 0x1f, 1213 &sense_data.header, sizeof(sense_data), 1214 scsiflags, CHRETRIES, 6000); 1215 if (error) { 1216 aprint_error_dev(sc->sc_dev, "could not sense capabilities page\n"); 1217 return (error); 1218 } 1219 1220 memset(sc->sc_movemask, 0, sizeof(sc->sc_movemask)); 1221 memset(sc->sc_exchangemask, 0, sizeof(sc->sc_exchangemask)); 1222 moves = &sense_data.pages.cap.move_from_mt; 1223 exchanges = &sense_data.pages.cap.exchange_with_mt; 1224 for (from = CHET_MT; from <= CHET_DT; ++from) { 1225 sc->sc_movemask[from] = moves[from]; 1226 sc->sc_exchangemask[from] = exchanges[from]; 1227 } 1228 1229 #ifdef CH_AUTOMATIC_IELEM_POLICY 1230 /* 1231 * If we need to do an Init-Element-Status, 1232 * do that now that we know what's in the changer. 1233 */ 1234 if ((scsiflags & XS_CTL_IGNORE_MEDIA_CHANGE) == 0) { 1235 if ((sc->sc_periph->periph_flags & PERIPH_MEDIA_LOADED) == 0) 1236 error = ch_ielem(sc); 1237 if (error == 0) 1238 sc->sc_periph->periph_flags |= PERIPH_MEDIA_LOADED; 1239 else 1240 sc->sc_periph->periph_flags &= ~PERIPH_MEDIA_LOADED; 1241 } 1242 #endif 1243 return (error); 1244 } 1245 1246 static void 1247 ch_get_quirks(struct ch_softc *sc, struct scsipi_inquiry_pattern *inqbuf) 1248 { 1249 const struct chquirk *match; 1250 int priority; 1251 1252 sc->sc_settledelay = 0; 1253 1254 match = scsipi_inqmatch(inqbuf, chquirks, 1255 sizeof(chquirks) / sizeof(chquirks[0]), 1256 sizeof(chquirks[0]), &priority); 1257 if (priority != 0) 1258 sc->sc_settledelay = match->cq_settledelay; 1259 } 1260 1261 static int 1262 ch_map_element(struct ch_softc *sc, u_int16_t elem, int *typep, int *unitp) 1263 { 1264 int chet; 1265 1266 for (chet = CHET_MT; chet <= CHET_DT; chet++) { 1267 if (elem >= sc->sc_firsts[chet] && 1268 elem < (sc->sc_firsts[chet] + sc->sc_counts[chet])) { 1269 *typep = chet; 1270 *unitp = elem - sc->sc_firsts[chet]; 1271 return (1); 1272 } 1273 } 1274 return (0); 1275 } 1276 1277 static void 1278 ch_voltag_convert_in(const struct changer_volume_tag *sv, 1279 struct changer_voltag *cv) 1280 { 1281 int i; 1282 1283 memset(cv, 0, sizeof(struct changer_voltag)); 1284 1285 /* 1286 * Copy the volume tag string from the SCSI representation. 1287 * Per the SCSI-2 spec, we stop at the first blank character. 1288 */ 1289 for (i = 0; i < sizeof(sv->volid); i++) { 1290 if (sv->volid[i] == ' ') 1291 break; 1292 cv->cv_tag[i] = sv->volid[i]; 1293 } 1294 cv->cv_tag[i] = '\0'; 1295 1296 cv->cv_serial = _2btol(sv->volseq); 1297 } 1298 1299 static int 1300 ch_voltag_convert_out(const struct changer_voltag *cv, 1301 struct changer_volume_tag *sv) 1302 { 1303 int i; 1304 1305 memset(sv, ' ', sizeof(struct changer_volume_tag)); 1306 1307 for (i = 0; i < sizeof(sv->volid); i++) { 1308 if (cv->cv_tag[i] == '\0') 1309 break; 1310 /* 1311 * Limit the character set to what is suggested in 1312 * the SCSI-2 spec. 1313 */ 1314 if ((cv->cv_tag[i] < '0' || cv->cv_tag[i] > '9') && 1315 (cv->cv_tag[i] < 'A' || cv->cv_tag[i] > 'Z') && 1316 (cv->cv_tag[i] != '_')) 1317 return (EINVAL); 1318 sv->volid[i] = cv->cv_tag[i]; 1319 } 1320 1321 _lto2b(cv->cv_serial, sv->volseq); 1322 1323 return (0); 1324 } 1325