1/*-
2 * Copyright (c) 1997 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
28/*
29 * Derived from the NetBSD SCSI changer driver.
30 *
31 * $NetBSD: ch.c,v 1.32 1998/01/12 09:49:12 thorpej Exp $
32 *
33 */
34/*-
35 * Copyright (c) 1996, 1997 Jason R. Thorpe <thorpej@and.com>
36 * All rights reserved.
37 *
38 * Partially based on an autochanger driver written by Stefan Grefen
39 * and on an autochanger driver written by the Systems Programming Group
40 * at the University of Utah Computer Science Department.
41 *
42 * Redistribution and use in source and binary forms, with or without
43 * modification, are permitted provided that the following conditions
44 * are met:
45 * 1. Redistributions of source code must retain the above copyright
46 * notice, this list of conditions and the following disclaimer.
47 * 2. Redistributions in binary form must reproduce the above copyright
48 * notice, this list of conditions and the following disclaimer in the
49 * documentation and/or other materials provided with the distribution.
50 * 3. All advertising materials mentioning features or use of this software
51 * must display the following acknowledgements:
52 * This product includes software developed by Jason R. Thorpe
53 * for And Communications, http://www.and.com/
54 * 4. The name of the author may not be used to endorse or promote products
55 * derived from this software without specific prior written permission.
56 *
57 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
58 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
59 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
60 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
61 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
62 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
63 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
64 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
65 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
66 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
67 * SUCH DAMAGE.
68 */
69
70#include <sys/cdefs.h>
71__FBSDID("$FreeBSD: head/sys/cam/scsi/scsi_ch.c 287806 2015-09-15 05:09:17Z markj $");
72
73#include <sys/param.h>
74#include <sys/queue.h>
75#include <sys/systm.h>
76#include <sys/kernel.h>
77#include <sys/types.h>
78#include <sys/malloc.h>
79#include <sys/fcntl.h>
80#include <sys/conf.h>
81#include <sys/chio.h>
82#include <sys/errno.h>
83#include <sys/devicestat.h>
84
85#include <cam/cam.h>
86#include <cam/cam_ccb.h>
87#include <cam/cam_periph.h>
88#include <cam/cam_xpt_periph.h>
89#include <cam/cam_debug.h>
90
91#include <cam/scsi/scsi_all.h>
92#include <cam/scsi/scsi_message.h>
93#include <cam/scsi/scsi_ch.h>
94
95/*
96 * Timeout definitions for various changer related commands. They may
97 * be too short for some devices (especially the timeout for INITIALIZE
98 * ELEMENT STATUS).
99 */
100
101static const u_int32_t CH_TIMEOUT_MODE_SENSE = 6000;
102static const u_int32_t CH_TIMEOUT_MOVE_MEDIUM = 15 * 60 * 1000;
103static const u_int32_t CH_TIMEOUT_EXCHANGE_MEDIUM = 15 * 60 * 1000;
104static const u_int32_t CH_TIMEOUT_POSITION_TO_ELEMENT = 15 * 60 * 1000;
105static const u_int32_t CH_TIMEOUT_READ_ELEMENT_STATUS = 5 * 60 * 1000;
106static const u_int32_t CH_TIMEOUT_SEND_VOLTAG = 10000;
107static const u_int32_t CH_TIMEOUT_INITIALIZE_ELEMENT_STATUS = 500000;
108
109typedef enum {
110 CH_FLAG_INVALID = 0x001
111} ch_flags;
112
113typedef enum {
114 CH_STATE_PROBE,
115 CH_STATE_NORMAL
116} ch_state;
117
118typedef enum {
119 CH_CCB_PROBE
120} ch_ccb_types;
121
122typedef enum {
123 CH_Q_NONE = 0x00,
124 CH_Q_NO_DBD = 0x01,
125 CH_Q_NO_DVCID = 0x02
126} ch_quirks;
127
128#define CH_Q_BIT_STRING \
129 "\020" \
130 "\001NO_DBD" \
131 "\002NO_DVCID"
132
133#define ccb_state ppriv_field0
134#define ccb_bp ppriv_ptr1
135
136struct scsi_mode_sense_data {
137 struct scsi_mode_header_6 header;
138 struct scsi_mode_blk_desc blk_desc;
139 union {
140 struct page_element_address_assignment ea;
141 struct page_transport_geometry_parameters tg;
142 struct page_device_capabilities cap;
143 } pages;
144};
145
146struct ch_softc {
147 ch_flags flags;
148 ch_state state;
149 ch_quirks quirks;
150 union ccb saved_ccb;
151 struct devstat *device_stats;
152 struct cdev *dev;
153 int open_count;
154
155 int sc_picker; /* current picker */
156
157 /*
158 * The following information is obtained from the
159 * element address assignment page.
160 */
161 int sc_firsts[CHET_MAX + 1]; /* firsts */
162 int sc_counts[CHET_MAX + 1]; /* counts */
163
164 /*
165 * The following mask defines the legal combinations
166 * of elements for the MOVE MEDIUM command.
167 */
168 u_int8_t sc_movemask[CHET_MAX + 1];
169
170 /*
171 * As above, but for EXCHANGE MEDIUM.
172 */
173 u_int8_t sc_exchangemask[CHET_MAX + 1];
174
175 /*
176 * Quirks; see below. XXX KDM not implemented yet
177 */
178 int sc_settledelay; /* delay for settle */
179};
180
181static d_open_t chopen;
182static d_close_t chclose;
183static d_ioctl_t chioctl;
184static periph_init_t chinit;
185static periph_ctor_t chregister;
186static periph_oninv_t choninvalidate;
187static periph_dtor_t chcleanup;
188static periph_start_t chstart;
189static void chasync(void *callback_arg, u_int32_t code,
190 struct cam_path *path, void *arg);
191static void chdone(struct cam_periph *periph,
192 union ccb *done_ccb);
193static int cherror(union ccb *ccb, u_int32_t cam_flags,
194 u_int32_t sense_flags);
195static int chmove(struct cam_periph *periph,
196 struct changer_move *cm);
197static int chexchange(struct cam_periph *periph,
198 struct changer_exchange *ce);
199static int chposition(struct cam_periph *periph,
200 struct changer_position *cp);
201static int chgetelemstatus(struct cam_periph *periph,
202 int scsi_version, u_long cmd,
203 struct changer_element_status_request *csr);
204static int chsetvoltag(struct cam_periph *periph,
205 struct changer_set_voltag_request *csvr);
206static int chielem(struct cam_periph *periph,
207 unsigned int timeout);
208static int chgetparams(struct cam_periph *periph);
209static int chscsiversion(struct cam_periph *periph);
210
211static struct periph_driver chdriver =
212{
213 chinit, "ch",
214 TAILQ_HEAD_INITIALIZER(chdriver.units), /* generation */ 0
215};
216
217PERIPHDRIVER_DECLARE(ch, chdriver);
218
219static struct cdevsw ch_cdevsw = {
220 .d_version = D_VERSION,
221 .d_flags = D_TRACKCLOSE,
222 .d_open = chopen,
223 .d_close = chclose,
224 .d_ioctl = chioctl,
225 .d_name = "ch",
226};
227
228static MALLOC_DEFINE(M_SCSICH, "scsi_ch", "scsi_ch buffers");
229
230static void
231chinit(void)
232{
233 cam_status status;
234
235 /*
236 * Install a global async callback. This callback will
237 * receive async callbacks like "new device found".
238 */
239 status = xpt_register_async(AC_FOUND_DEVICE, chasync, NULL, NULL);
240
241 if (status != CAM_REQ_CMP) {
242 printf("ch: Failed to attach master async callback "
243 "due to status 0x%x!\n", status);
244 }
245}
246
247static void
248chdevgonecb(void *arg)
249{
250 struct ch_softc *softc;
251 struct cam_periph *periph;
252 struct mtx *mtx;
253 int i;
254
255 periph = (struct cam_periph *)arg;
256 mtx = cam_periph_mtx(periph);
257 mtx_lock(mtx);
258
259 softc = (struct ch_softc *)periph->softc;
260 KASSERT(softc->open_count >= 0, ("Negative open count %d",
261 softc->open_count));
262
263 /*
264 * When we get this callback, we will get no more close calls from
265 * devfs. So if we have any dangling opens, we need to release the
266 * reference held for that particular context.
267 */
268 for (i = 0; i < softc->open_count; i++)
269 cam_periph_release_locked(periph);
270
271 softc->open_count = 0;
272
273 /*
274 * Release the reference held for the device node, it is gone now.
275 */
276 cam_periph_release_locked(periph);
277
278 /*
279 * We reference the lock directly here, instead of using
280 * cam_periph_unlock(). The reason is that the final call to
281 * cam_periph_release_locked() above could result in the periph
282 * getting freed. If that is the case, dereferencing the periph
283 * with a cam_periph_unlock() call would cause a page fault.
284 */
285 mtx_unlock(mtx);
286}
287
288static void
289choninvalidate(struct cam_periph *periph)
290{
291 struct ch_softc *softc;
292
293 softc = (struct ch_softc *)periph->softc;
294
295 /*
296 * De-register any async callbacks.
297 */
298 xpt_register_async(0, chasync, periph, periph->path);
299
300 softc->flags |= CH_FLAG_INVALID;
301
302 /*
303 * Tell devfs this device has gone away, and ask for a callback
304 * when it has cleaned up its state.
305 */
306 destroy_dev_sched_cb(softc->dev, chdevgonecb, periph);
307}
308
309static void
310chcleanup(struct cam_periph *periph)
311{
312 struct ch_softc *softc;
313
314 softc = (struct ch_softc *)periph->softc;
315
316 devstat_remove_entry(softc->device_stats);
317
318 free(softc, M_DEVBUF);
319}
320
321static void
322chasync(void *callback_arg, u_int32_t code, struct cam_path *path, void *arg)
323{
324 struct cam_periph *periph;
325
326 periph = (struct cam_periph *)callback_arg;
327
328 switch(code) {
329 case AC_FOUND_DEVICE:
330 {
331 struct ccb_getdev *cgd;
332 cam_status status;
333
334 cgd = (struct ccb_getdev *)arg;
335 if (cgd == NULL)
336 break;
337
338 if (cgd->protocol != PROTO_SCSI)
339 break;
340 if (SID_QUAL(&cgd->inq_data) != SID_QUAL_LU_CONNECTED)
341 break;
342 if (SID_TYPE(&cgd->inq_data)!= T_CHANGER)
343 break;
344
345 /*
346 * Allocate a peripheral instance for
347 * this device and start the probe
348 * process.
349 */
350 status = cam_periph_alloc(chregister, choninvalidate,
351 chcleanup, chstart, "ch",
352 CAM_PERIPH_BIO, path,
353 chasync, AC_FOUND_DEVICE, cgd);
354
355 if (status != CAM_REQ_CMP
356 && status != CAM_REQ_INPROG)
357 printf("chasync: Unable to probe new device "
358 "due to status 0x%x\n", status);
359
360 break;
361
362 }
363 default:
364 cam_periph_async(periph, code, path, arg);
365 break;
366 }
367}
368
369static cam_status
370chregister(struct cam_periph *periph, void *arg)
371{
372 struct ch_softc *softc;
373 struct ccb_getdev *cgd;
374 struct ccb_pathinq cpi;
375
376 cgd = (struct ccb_getdev *)arg;
377 if (cgd == NULL) {
378 printf("chregister: no getdev CCB, can't register device\n");
379 return(CAM_REQ_CMP_ERR);
380 }
381
382 softc = (struct ch_softc *)malloc(sizeof(*softc),M_DEVBUF,M_NOWAIT);
383
384 if (softc == NULL) {
385 printf("chregister: Unable to probe new device. "
386 "Unable to allocate softc\n");
387 return(CAM_REQ_CMP_ERR);
388 }
389
390 bzero(softc, sizeof(*softc));
391 softc->state = CH_STATE_PROBE;
392 periph->softc = softc;
393 softc->quirks = CH_Q_NONE;
394
395 /*
396 * The DVCID and CURDATA bits were not introduced until the SMC
397 * spec. If this device claims SCSI-2 or earlier support, then it
398 * very likely does not support these bits.
399 */
400 if (cgd->inq_data.version <= SCSI_REV_2)
401 softc->quirks |= CH_Q_NO_DVCID;
402
403 bzero(&cpi, sizeof(cpi));
404 xpt_setup_ccb(&cpi.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
405 cpi.ccb_h.func_code = XPT_PATH_INQ;
406 xpt_action((union ccb *)&cpi);
407
408 /*
409 * Changers don't have a blocksize, and obviously don't support
410 * tagged queueing.
411 */
412 cam_periph_unlock(periph);
413 softc->device_stats = devstat_new_entry("ch",
414 periph->unit_number, 0,
415 DEVSTAT_NO_BLOCKSIZE | DEVSTAT_NO_ORDERED_TAGS,
416 SID_TYPE(&cgd->inq_data) |
417 XPORT_DEVSTAT_TYPE(cpi.transport),
418 DEVSTAT_PRIORITY_OTHER);
419
420 /*
421 * Acquire a reference to the periph before we create the devfs
422 * instance for it. We'll release this reference once the devfs
423 * instance has been freed.
424 */
425 if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
426 xpt_print(periph->path, "%s: lost periph during "
427 "registration!\n", __func__);
428 cam_periph_lock(periph);
429 return (CAM_REQ_CMP_ERR);
430 }
431
432
433 /* Register the device */
434 softc->dev = make_dev(&ch_cdevsw, periph->unit_number, UID_ROOT,
435 GID_OPERATOR, 0600, "%s%d", periph->periph_name,
436 periph->unit_number);
437 cam_periph_lock(periph);
438 softc->dev->si_drv1 = periph;
439
440 /*
441 * Add an async callback so that we get
442 * notified if this device goes away.
443 */
444 xpt_register_async(AC_LOST_DEVICE, chasync, periph, periph->path);
445
446 /*
447 * Lock this periph until we are setup.
448 * This first call can't block
449 */
450 (void)cam_periph_hold(periph, PRIBIO);
451 xpt_schedule(periph, CAM_PRIORITY_DEV);
452
453 return(CAM_REQ_CMP);
454}
455
456static int
457chopen(struct cdev *dev, int flags, int fmt, struct thread *td)
458{
459 struct cam_periph *periph;
460 struct ch_softc *softc;
461 int error;
462
463 periph = (struct cam_periph *)dev->si_drv1;
464 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
465 return (ENXIO);
466
467 softc = (struct ch_softc *)periph->softc;
468
469 cam_periph_lock(periph);
470
471 if (softc->flags & CH_FLAG_INVALID) {
472 cam_periph_release_locked(periph);
473 cam_periph_unlock(periph);
474 return(ENXIO);
475 }
476
477 if ((error = cam_periph_hold(periph, PRIBIO | PCATCH)) != 0) {
478 cam_periph_unlock(periph);
479 cam_periph_release(periph);
480 return (error);
481 }
482
483 /*
484 * Load information about this changer device into the softc.
485 */
486 if ((error = chgetparams(periph)) != 0) {
487 cam_periph_unhold(periph);
488 cam_periph_release_locked(periph);
489 cam_periph_unlock(periph);
490 return(error);
491 }
492
493 cam_periph_unhold(periph);
494
495 softc->open_count++;
496
497 cam_periph_unlock(periph);
498
499 return(error);
500}
501
502static int
503chclose(struct cdev *dev, int flag, int fmt, struct thread *td)
504{
505 struct cam_periph *periph;
506 struct ch_softc *softc;
507 struct mtx *mtx;
508
509 periph = (struct cam_periph *)dev->si_drv1;
510 if (periph == NULL)
511 return(ENXIO);
512 mtx = cam_periph_mtx(periph);
513 mtx_lock(mtx);
514
515 softc = (struct ch_softc *)periph->softc;
516 softc->open_count--;
517
518 cam_periph_release_locked(periph);
519
520 /*
521 * We reference the lock directly here, instead of using
522 * cam_periph_unlock(). The reason is that the call to
523 * cam_periph_release_locked() above could result in the periph
524 * getting freed. If that is the case, dereferencing the periph
525 * with a cam_periph_unlock() call would cause a page fault.
526 *
527 * cam_periph_release() avoids this problem using the same method,
528 * but we're manually acquiring and dropping the lock here to
529 * protect the open count and avoid another lock acquisition and
530 * release.
531 */
532 mtx_unlock(mtx);
533
534 return(0);
535}
536
537static void
538chstart(struct cam_periph *periph, union ccb *start_ccb)
539{
540 struct ch_softc *softc;
541
542 softc = (struct ch_softc *)periph->softc;
543
544 switch (softc->state) {
545 case CH_STATE_NORMAL:
546 {
547 xpt_release_ccb(start_ccb);
548 break;
549 }
550 case CH_STATE_PROBE:
551 {
552 int mode_buffer_len;
553 void *mode_buffer;
554
555 /*
556 * Include the block descriptor when calculating the mode
557 * buffer length,
558 */
559 mode_buffer_len = sizeof(struct scsi_mode_header_6) +
560 sizeof(struct scsi_mode_blk_desc) +
561 sizeof(struct page_element_address_assignment);
562
563 mode_buffer = malloc(mode_buffer_len, M_SCSICH, M_NOWAIT);
564
565 if (mode_buffer == NULL) {
566 printf("chstart: couldn't malloc mode sense data\n");
567 break;
568 }
569 bzero(mode_buffer, mode_buffer_len);
570
571 /*
572 * Get the element address assignment page.
573 */
574 scsi_mode_sense(&start_ccb->csio,
575 /* retries */ 1,
576 /* cbfcnp */ chdone,
577 /* tag_action */ MSG_SIMPLE_Q_TAG,
578 /* dbd */ (softc->quirks & CH_Q_NO_DBD) ?
579 FALSE : TRUE,
580 /* page_code */ SMS_PAGE_CTRL_CURRENT,
581 /* page */ CH_ELEMENT_ADDR_ASSIGN_PAGE,
582 /* param_buf */ (u_int8_t *)mode_buffer,
583 /* param_len */ mode_buffer_len,
584 /* sense_len */ SSD_FULL_SIZE,
585 /* timeout */ CH_TIMEOUT_MODE_SENSE);
586
587 start_ccb->ccb_h.ccb_bp = NULL;
588 start_ccb->ccb_h.ccb_state = CH_CCB_PROBE;
589 xpt_action(start_ccb);
590 break;
591 }
592 }
593}
594
595static void
596chdone(struct cam_periph *periph, union ccb *done_ccb)
597{
598 struct ch_softc *softc;
599 struct ccb_scsiio *csio;
600
601 softc = (struct ch_softc *)periph->softc;
602 csio = &done_ccb->csio;
603
604 switch(done_ccb->ccb_h.ccb_state) {
605 case CH_CCB_PROBE:
606 {
607 struct scsi_mode_header_6 *mode_header;
608 struct page_element_address_assignment *ea;
609 char announce_buf[80];
610
611
612 mode_header = (struct scsi_mode_header_6 *)csio->data_ptr;
613
614 ea = (struct page_element_address_assignment *)
615 find_mode_page_6(mode_header);
616
617 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP){
618
619 softc->sc_firsts[CHET_MT] = scsi_2btoul(ea->mtea);
620 softc->sc_counts[CHET_MT] = scsi_2btoul(ea->nmte);
621 softc->sc_firsts[CHET_ST] = scsi_2btoul(ea->fsea);
622 softc->sc_counts[CHET_ST] = scsi_2btoul(ea->nse);
623 softc->sc_firsts[CHET_IE] = scsi_2btoul(ea->fieea);
624 softc->sc_counts[CHET_IE] = scsi_2btoul(ea->niee);
625 softc->sc_firsts[CHET_DT] = scsi_2btoul(ea->fdtea);
626 softc->sc_counts[CHET_DT] = scsi_2btoul(ea->ndte);
627 softc->sc_picker = softc->sc_firsts[CHET_MT];
628
629#define PLURAL(c) (c) == 1 ? "" : "s"
630 snprintf(announce_buf, sizeof(announce_buf),
631 "%d slot%s, %d drive%s, "
632 "%d picker%s, %d portal%s",
633 softc->sc_counts[CHET_ST],
634 PLURAL(softc->sc_counts[CHET_ST]),
635 softc->sc_counts[CHET_DT],
636 PLURAL(softc->sc_counts[CHET_DT]),
637 softc->sc_counts[CHET_MT],
638 PLURAL(softc->sc_counts[CHET_MT]),
639 softc->sc_counts[CHET_IE],
640 PLURAL(softc->sc_counts[CHET_IE]));
641#undef PLURAL
642 } else {
643 int error;
644
645 error = cherror(done_ccb, CAM_RETRY_SELTO,
646 SF_RETRY_UA | SF_NO_PRINT);
647 /*
648 * Retry any UNIT ATTENTION type errors. They
649 * are expected at boot.
650 */
651 if (error == ERESTART) {
652 /*
653 * A retry was scheuled, so
654 * just return.
655 */
656 return;
657 } else if (error != 0) {
658 struct scsi_mode_sense_6 *sms;
659 int frozen, retry_scheduled;
660
661 sms = (struct scsi_mode_sense_6 *)
662 done_ccb->csio.cdb_io.cdb_bytes;
663 frozen = (done_ccb->ccb_h.status &
664 CAM_DEV_QFRZN) != 0;
665
666 /*
667 * Check to see if block descriptors were
668 * disabled. Some devices don't like that.
669 * We're taking advantage of the fact that
670 * the first few bytes of the 6 and 10 byte
671 * mode sense commands are the same. If
672 * block descriptors were disabled, enable
673 * them and re-send the command.
674 */
675 if ((sms->byte2 & SMS_DBD) != 0 &&
676 (periph->flags & CAM_PERIPH_INVALID) == 0) {
677 sms->byte2 &= ~SMS_DBD;
678 xpt_action(done_ccb);
679 softc->quirks |= CH_Q_NO_DBD;
680 retry_scheduled = 1;
681 } else
682 retry_scheduled = 0;
683
684 /* Don't wedge this device's queue */
685 if (frozen)
686 cam_release_devq(done_ccb->ccb_h.path,
687 /*relsim_flags*/0,
688 /*reduction*/0,
689 /*timeout*/0,
690 /*getcount_only*/0);
691
692 if (retry_scheduled)
693 return;
694
695 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK)
696 == CAM_SCSI_STATUS_ERROR)
697 scsi_sense_print(&done_ccb->csio);
698 else {
699 xpt_print(periph->path,
700 "got CAM status %#x\n",
701 done_ccb->ccb_h.status);
702 }
703 xpt_print(periph->path, "fatal error, failed "
704 "to attach to device\n");
705
706 cam_periph_invalidate(periph);
707
708 announce_buf[0] = '\0';
709 }
710 }
711 if (announce_buf[0] != '\0') {
712 xpt_announce_periph(periph, announce_buf);
713 xpt_announce_quirks(periph, softc->quirks,
714 CH_Q_BIT_STRING);
715 }
716 softc->state = CH_STATE_NORMAL;
717 free(mode_header, M_SCSICH);
718 /*
719 * Since our peripheral may be invalidated by an error
720 * above or an external event, we must release our CCB
721 * before releasing the probe lock on the peripheral.
722 * The peripheral will only go away once the last lock
723 * is removed, and we need it around for the CCB release
724 * operation.
725 */
726 xpt_release_ccb(done_ccb);
727 cam_periph_unhold(periph);
728 return;
729 }
730 default:
731 break;
732 }
733 xpt_release_ccb(done_ccb);
734}
735
736static int
737cherror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
738{
739 struct ch_softc *softc;
740 struct cam_periph *periph;
741
742 periph = xpt_path_periph(ccb->ccb_h.path);
743 softc = (struct ch_softc *)periph->softc;
744
745 return (cam_periph_error(ccb, cam_flags, sense_flags,
746 &softc->saved_ccb));
747}
748
749static int
750chioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
751{
752 struct cam_periph *periph;
753 struct ch_softc *softc;
754 int error;
755
756 periph = (struct cam_periph *)dev->si_drv1;
757 if (periph == NULL)
758 return(ENXIO);
759
760 cam_periph_lock(periph);
761 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering chioctl\n"));
762
763 softc = (struct ch_softc *)periph->softc;
764
765 error = 0;
766
767 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
768 ("trying to do ioctl %#lx\n", cmd));
769
770 /*
771 * If this command can change the device's state, we must
772 * have the device open for writing.
773 */
774 switch (cmd) {
775 case CHIOGPICKER:
776 case CHIOGPARAMS:
777 case OCHIOGSTATUS:
778 case CHIOGSTATUS:
779 break;
780
781 default:
782 if ((flag & FWRITE) == 0) {
783 cam_periph_unlock(periph);
784 return (EBADF);
785 }
786 }
787
788 switch (cmd) {
789 case CHIOMOVE:
790 error = chmove(periph, (struct changer_move *)addr);
791 break;
792
793 case CHIOEXCHANGE:
794 error = chexchange(periph, (struct changer_exchange *)addr);
795 break;
796
797 case CHIOPOSITION:
798 error = chposition(periph, (struct changer_position *)addr);
799 break;
800
801 case CHIOGPICKER:
802 *(int *)addr = softc->sc_picker - softc->sc_firsts[CHET_MT];
803 break;
804
805 case CHIOSPICKER:
806 {
807 int new_picker = *(int *)addr;
808
809 if (new_picker > (softc->sc_counts[CHET_MT] - 1)) {
810 error = EINVAL;
811 break;
812 }
813 softc->sc_picker = softc->sc_firsts[CHET_MT] + new_picker;
814 break;
815 }
816 case CHIOGPARAMS:
817 {
818 struct changer_params *cp = (struct changer_params *)addr;
819
820 cp->cp_npickers = softc->sc_counts[CHET_MT];
821 cp->cp_nslots = softc->sc_counts[CHET_ST];
822 cp->cp_nportals = softc->sc_counts[CHET_IE];
823 cp->cp_ndrives = softc->sc_counts[CHET_DT];
824 break;
825 }
826 case CHIOIELEM:
827 error = chielem(periph, *(unsigned int *)addr);
828 break;
829
830 case OCHIOGSTATUS:
831 {
832 error = chgetelemstatus(periph, SCSI_REV_2, cmd,
833 (struct changer_element_status_request *)addr);
834 break;
835 }
836
837 case CHIOGSTATUS:
838 {
839 int scsi_version;
840
841 scsi_version = chscsiversion(periph);
842 if (scsi_version >= SCSI_REV_0) {
843 error = chgetelemstatus(periph, scsi_version, cmd,
844 (struct changer_element_status_request *)addr);
845 }
846 else { /* unable to determine the SCSI version */
847 cam_periph_unlock(periph);
848 return (ENXIO);
849 }
850 break;
851 }
852
853 case CHIOSETVOLTAG:
854 {
855 error = chsetvoltag(periph,
856 (struct changer_set_voltag_request *) addr);
857 break;
858 }
859
860 /* Implement prevent/allow? */
861
862 default:
863 error = cam_periph_ioctl(periph, cmd, addr, cherror);
864 break;
865 }
866
867 cam_periph_unlock(periph);
868 return (error);
869}
870
871static int
872chmove(struct cam_periph *periph, struct changer_move *cm)
873{
874 struct ch_softc *softc;
875 u_int16_t fromelem, toelem;
876 union ccb *ccb;
877 int error;
878
879 error = 0;
880 softc = (struct ch_softc *)periph->softc;
881
882 /*
883 * Check arguments.
884 */
885 if ((cm->cm_fromtype > CHET_DT) || (cm->cm_totype > CHET_DT))
886 return (EINVAL);
887 if ((cm->cm_fromunit > (softc->sc_counts[cm->cm_fromtype] - 1)) ||
888 (cm->cm_tounit > (softc->sc_counts[cm->cm_totype] - 1)))
889 return (ENODEV);
890
891 /*
892 * Check the request against the changer's capabilities.
893 */
894 if ((softc->sc_movemask[cm->cm_fromtype] & (1 << cm->cm_totype)) == 0)
895 return (ENODEV);
896
897 /*
898 * Calculate the source and destination elements.
899 */
900 fromelem = softc->sc_firsts[cm->cm_fromtype] + cm->cm_fromunit;
901 toelem = softc->sc_firsts[cm->cm_totype] + cm->cm_tounit;
902
903 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
904
905 scsi_move_medium(&ccb->csio,
906 /* retries */ 1,
907 /* cbfcnp */ chdone,
908 /* tag_action */ MSG_SIMPLE_Q_TAG,
909 /* tea */ softc->sc_picker,
910 /* src */ fromelem,
911 /* dst */ toelem,
912 /* invert */ (cm->cm_flags & CM_INVERT) ? TRUE : FALSE,
913 /* sense_len */ SSD_FULL_SIZE,
914 /* timeout */ CH_TIMEOUT_MOVE_MEDIUM);
915
916 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/CAM_RETRY_SELTO,
917 /*sense_flags*/ SF_RETRY_UA,
918 softc->device_stats);
919
920 xpt_release_ccb(ccb);
921
922 return(error);
923}
924
925static int
926chexchange(struct cam_periph *periph, struct changer_exchange *ce)
927{
928 struct ch_softc *softc;
929 u_int16_t src, dst1, dst2;
930 union ccb *ccb;
931 int error;
932
933 error = 0;
934 softc = (struct ch_softc *)periph->softc;
935 /*
936 * Check arguments.
937 */
938 if ((ce->ce_srctype > CHET_DT) || (ce->ce_fdsttype > CHET_DT) ||
939 (ce->ce_sdsttype > CHET_DT))
940 return (EINVAL);
941 if ((ce->ce_srcunit > (softc->sc_counts[ce->ce_srctype] - 1)) ||
942 (ce->ce_fdstunit > (softc->sc_counts[ce->ce_fdsttype] - 1)) ||
943 (ce->ce_sdstunit > (softc->sc_counts[ce->ce_sdsttype] - 1)))
944 return (ENODEV);
945
946 /*
947 * Check the request against the changer's capabilities.
948 */
949 if (((softc->sc_exchangemask[ce->ce_srctype] &
950 (1 << ce->ce_fdsttype)) == 0) ||
951 ((softc->sc_exchangemask[ce->ce_fdsttype] &
952 (1 << ce->ce_sdsttype)) == 0))
953 return (ENODEV);
954
955 /*
956 * Calculate the source and destination elements.
957 */
958 src = softc->sc_firsts[ce->ce_srctype] + ce->ce_srcunit;
959 dst1 = softc->sc_firsts[ce->ce_fdsttype] + ce->ce_fdstunit;
960 dst2 = softc->sc_firsts[ce->ce_sdsttype] + ce->ce_sdstunit;
961
962 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
963
964 scsi_exchange_medium(&ccb->csio,
965 /* retries */ 1,
966 /* cbfcnp */ chdone,
967 /* tag_action */ MSG_SIMPLE_Q_TAG,
968 /* tea */ softc->sc_picker,
969 /* src */ src,
970 /* dst1 */ dst1,
971 /* dst2 */ dst2,
972 /* invert1 */ (ce->ce_flags & CE_INVERT1) ?
973 TRUE : FALSE,
974 /* invert2 */ (ce->ce_flags & CE_INVERT2) ?
975 TRUE : FALSE,
976 /* sense_len */ SSD_FULL_SIZE,
977 /* timeout */ CH_TIMEOUT_EXCHANGE_MEDIUM);
978
979 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/CAM_RETRY_SELTO,
980 /*sense_flags*/ SF_RETRY_UA,
981 softc->device_stats);
982
983 xpt_release_ccb(ccb);
984
985 return(error);
986}
987
988static int
989chposition(struct cam_periph *periph, struct changer_position *cp)
990{
991 struct ch_softc *softc;
992 u_int16_t dst;
993 union ccb *ccb;
994 int error;
995
996 error = 0;
997 softc = (struct ch_softc *)periph->softc;
998
999 /*
1000 * Check arguments.
1001 */
1002 if (cp->cp_type > CHET_DT)
1003 return (EINVAL);
1004 if (cp->cp_unit > (softc->sc_counts[cp->cp_type] - 1))
1005 return (ENODEV);
1006
1007 /*
1008 * Calculate the destination element.
1009 */
1010 dst = softc->sc_firsts[cp->cp_type] + cp->cp_unit;
1011
1012 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1013
1014 scsi_position_to_element(&ccb->csio,
1015 /* retries */ 1,
1016 /* cbfcnp */ chdone,
1017 /* tag_action */ MSG_SIMPLE_Q_TAG,
1018 /* tea */ softc->sc_picker,
1019 /* dst */ dst,
1020 /* invert */ (cp->cp_flags & CP_INVERT) ?
1021 TRUE : FALSE,
1022 /* sense_len */ SSD_FULL_SIZE,
1023 /* timeout */ CH_TIMEOUT_POSITION_TO_ELEMENT);
1024
1025 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1026 /*sense_flags*/ SF_RETRY_UA,
1027 softc->device_stats);
1028
1029 xpt_release_ccb(ccb);
1030
1031 return(error);
1032}
1033
1034/*
1035 * Copy a volume tag to a volume_tag struct, converting SCSI byte order
1036 * to host native byte order in the volume serial number. The volume
1037 * label as returned by the changer is transferred to user mode as
1038 * nul-terminated string. Volume labels are truncated at the first
1039 * space, as suggested by SCSI-2.
1040 */
1041static void
1042copy_voltag(struct changer_voltag *uvoltag, struct volume_tag *voltag)
1043{
1044 int i;
1045 for (i=0; i<CH_VOLTAG_MAXLEN; i++) {
1046 char c = voltag->vif[i];
1047 if (c && c != ' ')
1048 uvoltag->cv_volid[i] = c;
1049 else
1050 break;
1051 }
1052 uvoltag->cv_serial = scsi_2btoul(voltag->vsn);
1053}
1054
1055/*
1056 * Copy an element status descriptor to a user-mode
1057 * changer_element_status structure.
1058 */
1059static void
1060copy_element_status(struct ch_softc *softc,
1061 u_int16_t flags,
1062 struct read_element_status_descriptor *desc,
1063 struct changer_element_status *ces,
1064 int scsi_version)
1065{
1066 u_int16_t eaddr = scsi_2btoul(desc->eaddr);
1067 u_int16_t et;
1068 struct volume_tag *pvol_tag = NULL, *avol_tag = NULL;
1069 struct read_element_status_device_id *devid = NULL;
1070
1071 ces->ces_int_addr = eaddr;
1072 /* set up logical address in element status */
1073 for (et = CHET_MT; et <= CHET_DT; et++) {
1074 if ((softc->sc_firsts[et] <= eaddr)
1075 && ((softc->sc_firsts[et] + softc->sc_counts[et])
1076 > eaddr)) {
1077 ces->ces_addr = eaddr - softc->sc_firsts[et];
1078 ces->ces_type = et;
1079 break;
1080 }
1081 }
1082
1083 ces->ces_flags = desc->flags1;
1084
1085 ces->ces_sensecode = desc->sense_code;
1086 ces->ces_sensequal = desc->sense_qual;
1087
1088 if (desc->flags2 & READ_ELEMENT_STATUS_INVERT)
1089 ces->ces_flags |= CES_INVERT;
1090
1091 if (desc->flags2 & READ_ELEMENT_STATUS_SVALID) {
1092
1093 eaddr = scsi_2btoul(desc->ssea);
1094
1095 /* convert source address to logical format */
1096 for (et = CHET_MT; et <= CHET_DT; et++) {
1097 if ((softc->sc_firsts[et] <= eaddr)
1098 && ((softc->sc_firsts[et] + softc->sc_counts[et])
1099 > eaddr)) {
1100 ces->ces_source_addr =
1101 eaddr - softc->sc_firsts[et];
1102 ces->ces_source_type = et;
1103 ces->ces_flags |= CES_SOURCE_VALID;
1104 break;
1105 }
1106 }
1107
1108 if (!(ces->ces_flags & CES_SOURCE_VALID))
1109 printf("ch: warning: could not map element source "
1110 "address %ud to a valid element type\n",
1111 eaddr);
1112 }
1113
1114 /*
1115 * pvoltag and avoltag are common between SCSI-2 and later versions
1116 */
1117 if (flags & READ_ELEMENT_STATUS_PVOLTAG)
1118 pvol_tag = &desc->voltag_devid.pvoltag;
1119 if (flags & READ_ELEMENT_STATUS_AVOLTAG)
1120 avol_tag = (flags & READ_ELEMENT_STATUS_PVOLTAG) ?
1121 &desc->voltag_devid.voltag[1] :&desc->voltag_devid.pvoltag;
1122 /*
1123 * For SCSI-3 and later, element status can carry designator and
1124 * other information.
1125 */
1126 if (scsi_version >= SCSI_REV_SPC) {
1127 if ((flags & READ_ELEMENT_STATUS_PVOLTAG) ^
1128 (flags & READ_ELEMENT_STATUS_AVOLTAG))
1129 devid = &desc->voltag_devid.pvol_and_devid.devid;
1130 else if (!(flags & READ_ELEMENT_STATUS_PVOLTAG) &&
1131 !(flags & READ_ELEMENT_STATUS_AVOLTAG))
1132 devid = &desc->voltag_devid.devid;
1133 else /* Have both PVOLTAG and AVOLTAG */
1134 devid = &desc->voltag_devid.vol_tags_and_devid.devid;
1135 }
1136
1137 if (pvol_tag)
1138 copy_voltag(&(ces->ces_pvoltag), pvol_tag);
1139 if (avol_tag)
1140 copy_voltag(&(ces->ces_pvoltag), avol_tag);
1141 if (devid != NULL) {
1142 if (devid->designator_length > 0) {
1143 bcopy((void *)devid->designator,
1144 (void *)ces->ces_designator,
1145 devid->designator_length);
1146 ces->ces_designator_length = devid->designator_length;
1147 /*
1148 * Make sure we are always NUL terminated. The
1149 * This won't matter for the binary code set,
1150 * since the user will only pay attention to the
1151 * length field.
1152 */
1153 ces->ces_designator[devid->designator_length]= '\0';
1154 }
1155 if (devid->piv_assoc_designator_type &
1156 READ_ELEMENT_STATUS_PIV_SET) {
1157 ces->ces_flags |= CES_PIV;
1158 ces->ces_protocol_id =
1159 READ_ELEMENT_STATUS_PROTOCOL_ID(
1160 devid->prot_code_set);
1161 }
1162 ces->ces_code_set =
1163 READ_ELEMENT_STATUS_CODE_SET(devid->prot_code_set);
1164 ces->ces_assoc = READ_ELEMENT_STATUS_ASSOCIATION(
1165 devid->piv_assoc_designator_type);
1166 ces->ces_designator_type = READ_ELEMENT_STATUS_DESIGNATOR_TYPE(
1167 devid->piv_assoc_designator_type);
1168 } else if (scsi_version > SCSI_REV_2) {
1169 /* SCSI-SPC and No devid, no designator */
1170 ces->ces_designator_length = 0;
1171 ces->ces_designator[0] = '\0';
1172 ces->ces_protocol_id = CES_PROTOCOL_ID_FCP_4;
1173 }
1174
1175 if (scsi_version <= SCSI_REV_2) {
1176 if (desc->dt_or_obsolete.scsi_2.dt_scsi_flags &
1177 READ_ELEMENT_STATUS_DT_IDVALID) {
1178 ces->ces_flags |= CES_SCSIID_VALID;
1179 ces->ces_scsi_id =
1180 desc->dt_or_obsolete.scsi_2.dt_scsi_addr;
1181 }
1182
1183 if (desc->dt_or_obsolete.scsi_2.dt_scsi_addr &
1184 READ_ELEMENT_STATUS_DT_LUVALID) {
1185 ces->ces_flags |= CES_LUN_VALID;
1186 ces->ces_scsi_lun =
1187 desc->dt_or_obsolete.scsi_2.dt_scsi_flags &
1188 READ_ELEMENT_STATUS_DT_LUNMASK;
1189 }
1190 }
1191}
1192
1193static int
1194chgetelemstatus(struct cam_periph *periph, int scsi_version, u_long cmd,
1195 struct changer_element_status_request *cesr)
1196{
1197 struct read_element_status_header *st_hdr;
1198 struct read_element_status_page_header *pg_hdr;
1199 struct read_element_status_descriptor *desc;
1200 caddr_t data = NULL;
1201 size_t size, desclen;
1202 int avail, i, error = 0;
1203 int curdata, dvcid, sense_flags;
1204 int try_no_dvcid = 0;
1205 struct changer_element_status *user_data = NULL;
1206 struct ch_softc *softc;
1207 union ccb *ccb;
1208 int chet = cesr->cesr_element_type;
1209 int want_voltags = (cesr->cesr_flags & CESR_VOLTAGS) ? 1 : 0;
1210
1211 softc = (struct ch_softc *)periph->softc;
1212
1213 /* perform argument checking */
1214
1215 /*
1216 * Perform a range check on the cesr_element_{base,count}
1217 * request argument fields.
1218 */
1219 if ((softc->sc_counts[chet] - cesr->cesr_element_base) <= 0
1220 || (cesr->cesr_element_base + cesr->cesr_element_count)
1221 > softc->sc_counts[chet])
1222 return (EINVAL);
1223
1224 /*
1225 * Request one descriptor for the given element type. This
1226 * is used to determine the size of the descriptor so that
1227 * we can allocate enough storage for all of them. We assume
1228 * that the first one can fit into 1k.
1229 */
1230 cam_periph_unlock(periph);
1231 data = (caddr_t)malloc(1024, M_DEVBUF, M_WAITOK);
1232
1233 cam_periph_lock(periph);
1234 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1235
1236 sense_flags = SF_RETRY_UA;
1237 if (softc->quirks & CH_Q_NO_DVCID) {
1238 dvcid = 0;
1239 curdata = 0;
1240 } else {
1241 dvcid = 1;
1242 curdata = 1;
1243 /*
1244 * Don't print anything for an Illegal Request, because
1245 * these flags can cause some changers to complain. We'll
1246 * retry without them if we get an error.
1247 */
1248 sense_flags |= SF_QUIET_IR;
1249 }
1250
1251retry_einval:
1252
1253 scsi_read_element_status(&ccb->csio,
1254 /* retries */ 1,
1255 /* cbfcnp */ chdone,
1256 /* tag_action */ MSG_SIMPLE_Q_TAG,
1257 /* voltag */ want_voltags,
1258 /* sea */ softc->sc_firsts[chet],
1259 /* curdata */ curdata,
1260 /* dvcid */ dvcid,
1261 /* count */ 1,
1262 /* data_ptr */ data,
1263 /* dxfer_len */ 1024,
1264 /* sense_len */ SSD_FULL_SIZE,
1265 /* timeout */ CH_TIMEOUT_READ_ELEMENT_STATUS);
1266
1267 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1268 /*sense_flags*/ sense_flags,
1269 softc->device_stats);
1270
1271 /*
1272 * An Illegal Request sense key (only used if there is no asc/ascq)
1273 * or 0x24,0x00 for an ASC/ASCQ both map to EINVAL. If dvcid or
1274 * curdata are set (we set both or neither), try turning them off
1275 * and see if the command is successful.
1276 */
1277 if ((error == EINVAL)
1278 && (dvcid || curdata)) {
1279 dvcid = 0;
1280 curdata = 0;
1281 error = 0;
1282 /* At this point we want to report any Illegal Request */
1283 sense_flags &= ~SF_QUIET_IR;
1284 try_no_dvcid = 1;
1285 goto retry_einval;
1286 }
1287
1288 /*
1289 * In this case, we tried a read element status with dvcid and
1290 * curdata set, and it failed. We retried without those bits, and
1291 * it succeeded. Suggest to the user that he set a quirk, so we
1292 * don't go through the retry process the first time in the future.
1293 * This should only happen on changers that claim SCSI-3 or higher,
1294 * but don't support these bits.
1295 */
1296 if ((try_no_dvcid != 0)
1297 && (error == 0))
1298 softc->quirks |= CH_Q_NO_DVCID;
1299
1300 if (error)
1301 goto done;
1302 cam_periph_unlock(periph);
1303
1304 st_hdr = (struct read_element_status_header *)data;
1305 pg_hdr = (struct read_element_status_page_header *)((uintptr_t)st_hdr +
1306 sizeof(struct read_element_status_header));
1307 desclen = scsi_2btoul(pg_hdr->edl);
1308
1309 size = sizeof(struct read_element_status_header) +
1310 sizeof(struct read_element_status_page_header) +
1311 (desclen * cesr->cesr_element_count);
1312 /*
1313 * Reallocate storage for descriptors and get them from the
1314 * device.
1315 */
1316 free(data, M_DEVBUF);
1317 data = (caddr_t)malloc(size, M_DEVBUF, M_WAITOK);
1318
1319 cam_periph_lock(periph);
1320 scsi_read_element_status(&ccb->csio,
1321 /* retries */ 1,
1322 /* cbfcnp */ chdone,
1323 /* tag_action */ MSG_SIMPLE_Q_TAG,
1324 /* voltag */ want_voltags,
1325 /* sea */ softc->sc_firsts[chet]
1326 + cesr->cesr_element_base,
1327 /* curdata */ curdata,
1328 /* dvcid */ dvcid,
1329 /* count */ cesr->cesr_element_count,
1330 /* data_ptr */ data,
1331 /* dxfer_len */ size,
1332 /* sense_len */ SSD_FULL_SIZE,
1333 /* timeout */ CH_TIMEOUT_READ_ELEMENT_STATUS);
1334
1335 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1336 /*sense_flags*/ SF_RETRY_UA,
1337 softc->device_stats);
1338
1339 if (error)
1340 goto done;
1341 cam_periph_unlock(periph);
1342
1343 /*
1344 * Fill in the user status array.
1345 */
1346 st_hdr = (struct read_element_status_header *)data;
1347 pg_hdr = (struct read_element_status_page_header *)((uintptr_t)st_hdr +
1348 sizeof(struct read_element_status_header));
1349 avail = scsi_2btoul(st_hdr->count);
1350
1351 if (avail != cesr->cesr_element_count) {
1352 xpt_print(periph->path,
1353 "warning, READ ELEMENT STATUS avail != count\n");
1354 }
1355
1356 user_data = (struct changer_element_status *)
1357 malloc(avail * sizeof(struct changer_element_status),
1358 M_DEVBUF, M_WAITOK | M_ZERO);
1359
1360 desc = (struct read_element_status_descriptor *)((uintptr_t)data +
1361 sizeof(struct read_element_status_header) +
1362 sizeof(struct read_element_status_page_header));
1363 /*
1364 * Set up the individual element status structures
1365 */
1366 for (i = 0; i < avail; ++i) {
1367 struct changer_element_status *ces;
1368
1369 /*
1370 * In the changer_element_status structure, fields from
1371 * the beginning to the field of ces_scsi_lun are common
1372 * between SCSI-2 and SCSI-3, while all the rest are new
1373 * from SCSI-3. In order to maintain backward compatibility
1374 * of the chio command, the ces pointer, below, is computed
1375 * such that it lines up with the structure boundary
1376 * corresponding to the SCSI version.
1377 */
1378 ces = cmd == OCHIOGSTATUS ?
1379 (struct changer_element_status *)
1380 ((unsigned char *)user_data + i *
1381 (offsetof(struct changer_element_status,ces_scsi_lun)+1)):
1382 &user_data[i];
1383
1384 copy_element_status(softc, pg_hdr->flags, desc,
1385 ces, scsi_version);
1386
1387 desc = (struct read_element_status_descriptor *)
1388 ((unsigned char *)desc + desclen);
1389 }
1390
1391 /* Copy element status structures out to userspace. */
1392 if (cmd == OCHIOGSTATUS)
1393 error = copyout(user_data,
1394 cesr->cesr_element_status,
1395 avail* (offsetof(struct changer_element_status,
1396 ces_scsi_lun) + 1));
1397 else
1398 error = copyout(user_data,
1399 cesr->cesr_element_status,
1400 avail * sizeof(struct changer_element_status));
1401
1402 cam_periph_lock(periph);
1403
1404 done:
1405 xpt_release_ccb(ccb);
1406
1407 if (data != NULL)
1408 free(data, M_DEVBUF);
1409 if (user_data != NULL)
1410 free(user_data, M_DEVBUF);
1411
1412 return (error);
1413}
1414
1415static int
1416chielem(struct cam_periph *periph,
1417 unsigned int timeout)
1418{
1419 union ccb *ccb;
1420 struct ch_softc *softc;
1421 int error;
1422
1423 if (!timeout) {
1424 timeout = CH_TIMEOUT_INITIALIZE_ELEMENT_STATUS;
1425 } else {
1426 timeout *= 1000;
1427 }
1428
1429 error = 0;
1430 softc = (struct ch_softc *)periph->softc;
1431
1432 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1433
1434 scsi_initialize_element_status(&ccb->csio,
1435 /* retries */ 1,
1436 /* cbfcnp */ chdone,
1437 /* tag_action */ MSG_SIMPLE_Q_TAG,
1438 /* sense_len */ SSD_FULL_SIZE,
1439 /* timeout */ timeout);
1440
1441 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1442 /*sense_flags*/ SF_RETRY_UA,
1443 softc->device_stats);
1444
1445 xpt_release_ccb(ccb);
1446
1447 return(error);
1448}
1449
1450static int
1451chsetvoltag(struct cam_periph *periph,
1452 struct changer_set_voltag_request *csvr)
1453{
1454 union ccb *ccb;
1455 struct ch_softc *softc;
1456 u_int16_t ea;
1457 u_int8_t sac;
1458 struct scsi_send_volume_tag_parameters ssvtp;
1459 int error;
1460 int i;
1461
1462 error = 0;
1463 softc = (struct ch_softc *)periph->softc;
1464
1465 bzero(&ssvtp, sizeof(ssvtp));
1466 for (i=0; i<sizeof(ssvtp.vitf); i++) {
1467 ssvtp.vitf[i] = ' ';
1468 }
1469
1470 /*
1471 * Check arguments.
1472 */
1473 if (csvr->csvr_type > CHET_DT)
1474 return EINVAL;
1475 if (csvr->csvr_addr > (softc->sc_counts[csvr->csvr_type] - 1))
1476 return ENODEV;
1477
1478 ea = softc->sc_firsts[csvr->csvr_type] + csvr->csvr_addr;
1479
1480 if (csvr->csvr_flags & CSVR_ALTERNATE) {
1481 switch (csvr->csvr_flags & CSVR_MODE_MASK) {
1482 case CSVR_MODE_SET:
1483 sac = SEND_VOLUME_TAG_ASSERT_ALTERNATE;
1484 break;
1485 case CSVR_MODE_REPLACE:
1486 sac = SEND_VOLUME_TAG_REPLACE_ALTERNATE;
1487 break;
1488 case CSVR_MODE_CLEAR:
1489 sac = SEND_VOLUME_TAG_UNDEFINED_ALTERNATE;
1490 break;
1491 default:
1492 error = EINVAL;
1493 goto out;
1494 }
1495 } else {
1496 switch (csvr->csvr_flags & CSVR_MODE_MASK) {
1497 case CSVR_MODE_SET:
1498 sac = SEND_VOLUME_TAG_ASSERT_PRIMARY;
1499 break;
1500 case CSVR_MODE_REPLACE:
1501 sac = SEND_VOLUME_TAG_REPLACE_PRIMARY;
1502 break;
1503 case CSVR_MODE_CLEAR:
1504 sac = SEND_VOLUME_TAG_UNDEFINED_PRIMARY;
1505 break;
1506 default:
1507 error = EINVAL;
1508 goto out;
1509 }
1510 }
1511
1512 memcpy(ssvtp.vitf, csvr->csvr_voltag.cv_volid,
1513 min(strlen(csvr->csvr_voltag.cv_volid), sizeof(ssvtp.vitf)));
1514 scsi_ulto2b(csvr->csvr_voltag.cv_serial, ssvtp.minvsn);
1515
1516 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1517
1518 scsi_send_volume_tag(&ccb->csio,
1519 /* retries */ 1,
1520 /* cbfcnp */ chdone,
1521 /* tag_action */ MSG_SIMPLE_Q_TAG,
1522 /* element_address */ ea,
1523 /* send_action_code */ sac,
1524 /* parameters */ &ssvtp,
1525 /* sense_len */ SSD_FULL_SIZE,
1526 /* timeout */ CH_TIMEOUT_SEND_VOLTAG);
1527
1528 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1529 /*sense_flags*/ SF_RETRY_UA,
1530 softc->device_stats);
1531
1532 xpt_release_ccb(ccb);
1533
1534 out:
1535 return error;
1536}
1537
1538static int
1539chgetparams(struct cam_periph *periph)
1540{
1541 union ccb *ccb;
1542 struct ch_softc *softc;
1543 void *mode_buffer;
1544 int mode_buffer_len;
1545 struct page_element_address_assignment *ea;
1546 struct page_device_capabilities *cap;
1547 int error, from, dbd;
1548 u_int8_t *moves, *exchanges;
1549
1550 error = 0;
1551
1552 softc = (struct ch_softc *)periph->softc;
1553
1554 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1555
1556 /*
1557 * The scsi_mode_sense_data structure is just a convenience
1558 * structure that allows us to easily calculate the worst-case
1559 * storage size of the mode sense buffer.
1560 */
1561 mode_buffer_len = sizeof(struct scsi_mode_sense_data);
1562
1563 mode_buffer = malloc(mode_buffer_len, M_SCSICH, M_NOWAIT);
1564
1565 if (mode_buffer == NULL) {
1566 printf("chgetparams: couldn't malloc mode sense data\n");
1567 return(ENOSPC);
1568 }
1569
1570 bzero(mode_buffer, mode_buffer_len);
1571
1572 if (softc->quirks & CH_Q_NO_DBD)
1573 dbd = FALSE;
1574 else
1575 dbd = TRUE;
1576
1577 /*
1578 * Get the element address assignment page.
1579 */
1580 scsi_mode_sense(&ccb->csio,
1581 /* retries */ 1,
1582 /* cbfcnp */ chdone,
1583 /* tag_action */ MSG_SIMPLE_Q_TAG,
1584 /* dbd */ dbd,
1585 /* page_code */ SMS_PAGE_CTRL_CURRENT,
1586 /* page */ CH_ELEMENT_ADDR_ASSIGN_PAGE,
1587 /* param_buf */ (u_int8_t *)mode_buffer,
1588 /* param_len */ mode_buffer_len,
1589 /* sense_len */ SSD_FULL_SIZE,
1590 /* timeout */ CH_TIMEOUT_MODE_SENSE);
1591
1592 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1593 /* sense_flags */ SF_RETRY_UA|SF_NO_PRINT,
1594 softc->device_stats);
1595
1596 if (error) {
1597 if (dbd) {
1598 struct scsi_mode_sense_6 *sms;
1599
1600 sms = (struct scsi_mode_sense_6 *)
1601 ccb->csio.cdb_io.cdb_bytes;
1602
1603 sms->byte2 &= ~SMS_DBD;
1604 error = cam_periph_runccb(ccb, cherror,
1605 /*cam_flags*/ CAM_RETRY_SELTO,
1606 /*sense_flags*/ SF_RETRY_UA,
1607 softc->device_stats);
1608 } else {
1609 /*
1610 * Since we disabled sense printing above, print
1611 * out the sense here since we got an error.
1612 */
1613 scsi_sense_print(&ccb->csio);
1614 }
1615
1616 if (error) {
1617 xpt_print(periph->path,
1618 "chgetparams: error getting element "
1619 "address page\n");
1620 xpt_release_ccb(ccb);
1621 free(mode_buffer, M_SCSICH);
1622 return(error);
1623 }
1624 }
1625
1626 ea = (struct page_element_address_assignment *)
1627 find_mode_page_6((struct scsi_mode_header_6 *)mode_buffer);
1628
1629 softc->sc_firsts[CHET_MT] = scsi_2btoul(ea->mtea);
1630 softc->sc_counts[CHET_MT] = scsi_2btoul(ea->nmte);
1631 softc->sc_firsts[CHET_ST] = scsi_2btoul(ea->fsea);
1632 softc->sc_counts[CHET_ST] = scsi_2btoul(ea->nse);
1633 softc->sc_firsts[CHET_IE] = scsi_2btoul(ea->fieea);
1634 softc->sc_counts[CHET_IE] = scsi_2btoul(ea->niee);
1635 softc->sc_firsts[CHET_DT] = scsi_2btoul(ea->fdtea);
1636 softc->sc_counts[CHET_DT] = scsi_2btoul(ea->ndte);
1637
1638 bzero(mode_buffer, mode_buffer_len);
1639
1640 /*
1641 * Now get the device capabilities page.
1642 */
1643 scsi_mode_sense(&ccb->csio,
1644 /* retries */ 1,
1645 /* cbfcnp */ chdone,
1646 /* tag_action */ MSG_SIMPLE_Q_TAG,
1647 /* dbd */ dbd,
1648 /* page_code */ SMS_PAGE_CTRL_CURRENT,
1649 /* page */ CH_DEVICE_CAP_PAGE,
1650 /* param_buf */ (u_int8_t *)mode_buffer,
1651 /* param_len */ mode_buffer_len,
1652 /* sense_len */ SSD_FULL_SIZE,
1653 /* timeout */ CH_TIMEOUT_MODE_SENSE);
1654
1655 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1656 /* sense_flags */ SF_RETRY_UA | SF_NO_PRINT,
1657 softc->device_stats);
1658
1659 if (error) {
1660 if (dbd) {
1661 struct scsi_mode_sense_6 *sms;
1662
1663 sms = (struct scsi_mode_sense_6 *)
1664 ccb->csio.cdb_io.cdb_bytes;
1665
1666 sms->byte2 &= ~SMS_DBD;
1667 error = cam_periph_runccb(ccb, cherror,
1668 /*cam_flags*/ CAM_RETRY_SELTO,
1669 /*sense_flags*/ SF_RETRY_UA,
1670 softc->device_stats);
1671 } else {
1672 /*
1673 * Since we disabled sense printing above, print
1674 * out the sense here since we got an error.
1675 */
1676 scsi_sense_print(&ccb->csio);
1677 }
1678
1679 if (error) {
1680 xpt_print(periph->path,
1681 "chgetparams: error getting device "
1682 "capabilities page\n");
1683 xpt_release_ccb(ccb);
1684 free(mode_buffer, M_SCSICH);
1685 return(error);
1686 }
1687 }
1688
1689 xpt_release_ccb(ccb);
1690
1691 cap = (struct page_device_capabilities *)
1692 find_mode_page_6((struct scsi_mode_header_6 *)mode_buffer);
1693
1694 bzero(softc->sc_movemask, sizeof(softc->sc_movemask));
1695 bzero(softc->sc_exchangemask, sizeof(softc->sc_exchangemask));
1696 moves = cap->move_from;
1697 exchanges = cap->exchange_with;
1698 for (from = CHET_MT; from <= CHET_MAX; ++from) {
1699 softc->sc_movemask[from] = moves[from];
1700 softc->sc_exchangemask[from] = exchanges[from];
1701 }
1702
1703 free(mode_buffer, M_SCSICH);
1704
1705 return(error);
1706}
1707
1708static int
1709chscsiversion(struct cam_periph *periph)
1710{
1711 struct scsi_inquiry_data *inq_data;
1712 struct ccb_getdev *cgd;
1713 int dev_scsi_version;
1714
1715 cam_periph_assert(periph, MA_OWNED);
1716 if ((cgd = (struct ccb_getdev *)xpt_alloc_ccb_nowait()) == NULL)
1717 return (-1);
1718 /*
1719 * Get the device information.
1720 */
1721 xpt_setup_ccb(&cgd->ccb_h,
1722 periph->path,
1723 CAM_PRIORITY_NORMAL);
1724 cgd->ccb_h.func_code = XPT_GDEV_TYPE;
1725 xpt_action((union ccb *)cgd);
1726
1727 if (cgd->ccb_h.status != CAM_REQ_CMP) {
1728 xpt_free_ccb((union ccb *)cgd);
1729 return -1;
1730 }
1731
1732 inq_data = &cgd->inq_data;
1733 dev_scsi_version = inq_data->version;
1734 xpt_free_ccb((union ccb *)cgd);
1735
1736 return dev_scsi_version;
1737}
1738
1739void
1740scsi_move_medium(struct ccb_scsiio *csio, u_int32_t retries,
1741 void (*cbfcnp)(struct cam_periph *, union ccb *),
1742 u_int8_t tag_action, u_int32_t tea, u_int32_t src,
1743 u_int32_t dst, int invert, u_int8_t sense_len,
1744 u_int32_t timeout)
1745{
1746 struct scsi_move_medium *scsi_cmd;
1747
1748 scsi_cmd = (struct scsi_move_medium *)&csio->cdb_io.cdb_bytes;
1749 bzero(scsi_cmd, sizeof(*scsi_cmd));
1750
1751 scsi_cmd->opcode = MOVE_MEDIUM;
1752
1753 scsi_ulto2b(tea, scsi_cmd->tea);
1754 scsi_ulto2b(src, scsi_cmd->src);
1755 scsi_ulto2b(dst, scsi_cmd->dst);
1756
1757 if (invert)
1758 scsi_cmd->invert |= MOVE_MEDIUM_INVERT;
1759
1760 cam_fill_csio(csio,
1761 retries,
1762 cbfcnp,
1763 /*flags*/ CAM_DIR_NONE,
1764 tag_action,
1765 /*data_ptr*/ NULL,
1766 /*dxfer_len*/ 0,
1767 sense_len,
1768 sizeof(*scsi_cmd),
1769 timeout);
1770}
1771
1772void
1773scsi_exchange_medium(struct ccb_scsiio *csio, u_int32_t retries,
1774 void (*cbfcnp)(struct cam_periph *, union ccb *),
1775 u_int8_t tag_action, u_int32_t tea, u_int32_t src,
1776 u_int32_t dst1, u_int32_t dst2, int invert1,
1777 int invert2, u_int8_t sense_len, u_int32_t timeout)
1778{
1779 struct scsi_exchange_medium *scsi_cmd;
1780
1781 scsi_cmd = (struct scsi_exchange_medium *)&csio->cdb_io.cdb_bytes;
1782 bzero(scsi_cmd, sizeof(*scsi_cmd));
1783
1784 scsi_cmd->opcode = EXCHANGE_MEDIUM;
1785
1786 scsi_ulto2b(tea, scsi_cmd->tea);
1787 scsi_ulto2b(src, scsi_cmd->src);
1788 scsi_ulto2b(dst1, scsi_cmd->fdst);
1789 scsi_ulto2b(dst2, scsi_cmd->sdst);
1790
1791 if (invert1)
1792 scsi_cmd->invert |= EXCHANGE_MEDIUM_INV1;
1793
1794 if (invert2)
1795 scsi_cmd->invert |= EXCHANGE_MEDIUM_INV2;
1796
1797 cam_fill_csio(csio,
1798 retries,
1799 cbfcnp,
1800 /*flags*/ CAM_DIR_NONE,
1801 tag_action,
1802 /*data_ptr*/ NULL,
1803 /*dxfer_len*/ 0,
1804 sense_len,
1805 sizeof(*scsi_cmd),
1806 timeout);
1807}
1808
1809void
1810scsi_position_to_element(struct ccb_scsiio *csio, u_int32_t retries,
1811 void (*cbfcnp)(struct cam_periph *, union ccb *),
1812 u_int8_t tag_action, u_int32_t tea, u_int32_t dst,
1813 int invert, u_int8_t sense_len, u_int32_t timeout)
1814{
1815 struct scsi_position_to_element *scsi_cmd;
1816
1817 scsi_cmd = (struct scsi_position_to_element *)&csio->cdb_io.cdb_bytes;
1818 bzero(scsi_cmd, sizeof(*scsi_cmd));
1819
1820 scsi_cmd->opcode = POSITION_TO_ELEMENT;
1821
1822 scsi_ulto2b(tea, scsi_cmd->tea);
1823 scsi_ulto2b(dst, scsi_cmd->dst);
1824
1825 if (invert)
1826 scsi_cmd->invert |= POSITION_TO_ELEMENT_INVERT;
1827
1828 cam_fill_csio(csio,
1829 retries,
1830 cbfcnp,
1831 /*flags*/ CAM_DIR_NONE,
1832 tag_action,
1833 /*data_ptr*/ NULL,
1834 /*dxfer_len*/ 0,
1835 sense_len,
1836 sizeof(*scsi_cmd),
1837 timeout);
1838}
1839
1840void
1841scsi_read_element_status(struct ccb_scsiio *csio, u_int32_t retries,
1842 void (*cbfcnp)(struct cam_periph *, union ccb *),
1843 u_int8_t tag_action, int voltag, u_int32_t sea,
1844 int curdata, int dvcid,
1845 u_int32_t count, u_int8_t *data_ptr,
1846 u_int32_t dxfer_len, u_int8_t sense_len,
1847 u_int32_t timeout)
1848{
1849 struct scsi_read_element_status *scsi_cmd;
1850
1851 scsi_cmd = (struct scsi_read_element_status *)&csio->cdb_io.cdb_bytes;
1852 bzero(scsi_cmd, sizeof(*scsi_cmd));
1853
1854 scsi_cmd->opcode = READ_ELEMENT_STATUS;
1855
1856 scsi_ulto2b(sea, scsi_cmd->sea);
1857 scsi_ulto2b(count, scsi_cmd->count);
1858 scsi_ulto3b(dxfer_len, scsi_cmd->len);
1859 if (dvcid)
1860 scsi_cmd->flags |= READ_ELEMENT_STATUS_DVCID;
1861 if (curdata)
1862 scsi_cmd->flags |= READ_ELEMENT_STATUS_CURDATA;
1863
1864 if (voltag)
1865 scsi_cmd->byte2 |= READ_ELEMENT_STATUS_VOLTAG;
1866
1867 cam_fill_csio(csio,
1868 retries,
1869 cbfcnp,
1870 /*flags*/ CAM_DIR_IN,
1871 tag_action,
1872 data_ptr,
1873 dxfer_len,
1874 sense_len,
1875 sizeof(*scsi_cmd),
1876 timeout);
1877}
1878
1879void
1880scsi_initialize_element_status(struct ccb_scsiio *csio, u_int32_t retries,
1881 void (*cbfcnp)(struct cam_periph *, union ccb *),
1882 u_int8_t tag_action, u_int8_t sense_len,
1883 u_int32_t timeout)
1884{
1885 struct scsi_initialize_element_status *scsi_cmd;
1886
1887 scsi_cmd = (struct scsi_initialize_element_status *)
1888 &csio->cdb_io.cdb_bytes;
1889 bzero(scsi_cmd, sizeof(*scsi_cmd));
1890
1891 scsi_cmd->opcode = INITIALIZE_ELEMENT_STATUS;
1892
1893 cam_fill_csio(csio,
1894 retries,
1895 cbfcnp,
1896 /*flags*/ CAM_DIR_NONE,
1897 tag_action,
1898 /* data_ptr */ NULL,
1899 /* dxfer_len */ 0,
1900 sense_len,
1901 sizeof(*scsi_cmd),
1902 timeout);
1903}
1904
1905void
1906scsi_send_volume_tag(struct ccb_scsiio *csio, u_int32_t retries,
1907 void (*cbfcnp)(struct cam_periph *, union ccb *),
1908 u_int8_t tag_action,
1909 u_int16_t element_address,
1910 u_int8_t send_action_code,
1911 struct scsi_send_volume_tag_parameters *parameters,
1912 u_int8_t sense_len, u_int32_t timeout)
1913{
1914 struct scsi_send_volume_tag *scsi_cmd;
1915
1916 scsi_cmd = (struct scsi_send_volume_tag *) &csio->cdb_io.cdb_bytes;
1917 bzero(scsi_cmd, sizeof(*scsi_cmd));
1918
1919 scsi_cmd->opcode = SEND_VOLUME_TAG;
1920 scsi_ulto2b(element_address, scsi_cmd->ea);
1921 scsi_cmd->sac = send_action_code;
1922 scsi_ulto2b(sizeof(*parameters), scsi_cmd->pll);
1923
1924 cam_fill_csio(csio,
1925 retries,
1926 cbfcnp,
1927 /*flags*/ CAM_DIR_OUT,
1928 tag_action,
1929 /* data_ptr */ (u_int8_t *) parameters,
1930 sizeof(*parameters),
1931 sense_len,
1932 sizeof(*scsi_cmd),
1933 timeout);
1934}
2 * Copyright (c) 1997 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
28/*
29 * Derived from the NetBSD SCSI changer driver.
30 *
31 * $NetBSD: ch.c,v 1.32 1998/01/12 09:49:12 thorpej Exp $
32 *
33 */
34/*-
35 * Copyright (c) 1996, 1997 Jason R. Thorpe <thorpej@and.com>
36 * All rights reserved.
37 *
38 * Partially based on an autochanger driver written by Stefan Grefen
39 * and on an autochanger driver written by the Systems Programming Group
40 * at the University of Utah Computer Science Department.
41 *
42 * Redistribution and use in source and binary forms, with or without
43 * modification, are permitted provided that the following conditions
44 * are met:
45 * 1. Redistributions of source code must retain the above copyright
46 * notice, this list of conditions and the following disclaimer.
47 * 2. Redistributions in binary form must reproduce the above copyright
48 * notice, this list of conditions and the following disclaimer in the
49 * documentation and/or other materials provided with the distribution.
50 * 3. All advertising materials mentioning features or use of this software
51 * must display the following acknowledgements:
52 * This product includes software developed by Jason R. Thorpe
53 * for And Communications, http://www.and.com/
54 * 4. The name of the author may not be used to endorse or promote products
55 * derived from this software without specific prior written permission.
56 *
57 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
58 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
59 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
60 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
61 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
62 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
63 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
64 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
65 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
66 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
67 * SUCH DAMAGE.
68 */
69
70#include <sys/cdefs.h>
71__FBSDID("$FreeBSD: head/sys/cam/scsi/scsi_ch.c 287806 2015-09-15 05:09:17Z markj $");
72
73#include <sys/param.h>
74#include <sys/queue.h>
75#include <sys/systm.h>
76#include <sys/kernel.h>
77#include <sys/types.h>
78#include <sys/malloc.h>
79#include <sys/fcntl.h>
80#include <sys/conf.h>
81#include <sys/chio.h>
82#include <sys/errno.h>
83#include <sys/devicestat.h>
84
85#include <cam/cam.h>
86#include <cam/cam_ccb.h>
87#include <cam/cam_periph.h>
88#include <cam/cam_xpt_periph.h>
89#include <cam/cam_debug.h>
90
91#include <cam/scsi/scsi_all.h>
92#include <cam/scsi/scsi_message.h>
93#include <cam/scsi/scsi_ch.h>
94
95/*
96 * Timeout definitions for various changer related commands. They may
97 * be too short for some devices (especially the timeout for INITIALIZE
98 * ELEMENT STATUS).
99 */
100
101static const u_int32_t CH_TIMEOUT_MODE_SENSE = 6000;
102static const u_int32_t CH_TIMEOUT_MOVE_MEDIUM = 15 * 60 * 1000;
103static const u_int32_t CH_TIMEOUT_EXCHANGE_MEDIUM = 15 * 60 * 1000;
104static const u_int32_t CH_TIMEOUT_POSITION_TO_ELEMENT = 15 * 60 * 1000;
105static const u_int32_t CH_TIMEOUT_READ_ELEMENT_STATUS = 5 * 60 * 1000;
106static const u_int32_t CH_TIMEOUT_SEND_VOLTAG = 10000;
107static const u_int32_t CH_TIMEOUT_INITIALIZE_ELEMENT_STATUS = 500000;
108
109typedef enum {
110 CH_FLAG_INVALID = 0x001
111} ch_flags;
112
113typedef enum {
114 CH_STATE_PROBE,
115 CH_STATE_NORMAL
116} ch_state;
117
118typedef enum {
119 CH_CCB_PROBE
120} ch_ccb_types;
121
122typedef enum {
123 CH_Q_NONE = 0x00,
124 CH_Q_NO_DBD = 0x01,
125 CH_Q_NO_DVCID = 0x02
126} ch_quirks;
127
128#define CH_Q_BIT_STRING \
129 "\020" \
130 "\001NO_DBD" \
131 "\002NO_DVCID"
132
133#define ccb_state ppriv_field0
134#define ccb_bp ppriv_ptr1
135
136struct scsi_mode_sense_data {
137 struct scsi_mode_header_6 header;
138 struct scsi_mode_blk_desc blk_desc;
139 union {
140 struct page_element_address_assignment ea;
141 struct page_transport_geometry_parameters tg;
142 struct page_device_capabilities cap;
143 } pages;
144};
145
146struct ch_softc {
147 ch_flags flags;
148 ch_state state;
149 ch_quirks quirks;
150 union ccb saved_ccb;
151 struct devstat *device_stats;
152 struct cdev *dev;
153 int open_count;
154
155 int sc_picker; /* current picker */
156
157 /*
158 * The following information is obtained from the
159 * element address assignment page.
160 */
161 int sc_firsts[CHET_MAX + 1]; /* firsts */
162 int sc_counts[CHET_MAX + 1]; /* counts */
163
164 /*
165 * The following mask defines the legal combinations
166 * of elements for the MOVE MEDIUM command.
167 */
168 u_int8_t sc_movemask[CHET_MAX + 1];
169
170 /*
171 * As above, but for EXCHANGE MEDIUM.
172 */
173 u_int8_t sc_exchangemask[CHET_MAX + 1];
174
175 /*
176 * Quirks; see below. XXX KDM not implemented yet
177 */
178 int sc_settledelay; /* delay for settle */
179};
180
181static d_open_t chopen;
182static d_close_t chclose;
183static d_ioctl_t chioctl;
184static periph_init_t chinit;
185static periph_ctor_t chregister;
186static periph_oninv_t choninvalidate;
187static periph_dtor_t chcleanup;
188static periph_start_t chstart;
189static void chasync(void *callback_arg, u_int32_t code,
190 struct cam_path *path, void *arg);
191static void chdone(struct cam_periph *periph,
192 union ccb *done_ccb);
193static int cherror(union ccb *ccb, u_int32_t cam_flags,
194 u_int32_t sense_flags);
195static int chmove(struct cam_periph *periph,
196 struct changer_move *cm);
197static int chexchange(struct cam_periph *periph,
198 struct changer_exchange *ce);
199static int chposition(struct cam_periph *periph,
200 struct changer_position *cp);
201static int chgetelemstatus(struct cam_periph *periph,
202 int scsi_version, u_long cmd,
203 struct changer_element_status_request *csr);
204static int chsetvoltag(struct cam_periph *periph,
205 struct changer_set_voltag_request *csvr);
206static int chielem(struct cam_periph *periph,
207 unsigned int timeout);
208static int chgetparams(struct cam_periph *periph);
209static int chscsiversion(struct cam_periph *periph);
210
211static struct periph_driver chdriver =
212{
213 chinit, "ch",
214 TAILQ_HEAD_INITIALIZER(chdriver.units), /* generation */ 0
215};
216
217PERIPHDRIVER_DECLARE(ch, chdriver);
218
219static struct cdevsw ch_cdevsw = {
220 .d_version = D_VERSION,
221 .d_flags = D_TRACKCLOSE,
222 .d_open = chopen,
223 .d_close = chclose,
224 .d_ioctl = chioctl,
225 .d_name = "ch",
226};
227
228static MALLOC_DEFINE(M_SCSICH, "scsi_ch", "scsi_ch buffers");
229
230static void
231chinit(void)
232{
233 cam_status status;
234
235 /*
236 * Install a global async callback. This callback will
237 * receive async callbacks like "new device found".
238 */
239 status = xpt_register_async(AC_FOUND_DEVICE, chasync, NULL, NULL);
240
241 if (status != CAM_REQ_CMP) {
242 printf("ch: Failed to attach master async callback "
243 "due to status 0x%x!\n", status);
244 }
245}
246
247static void
248chdevgonecb(void *arg)
249{
250 struct ch_softc *softc;
251 struct cam_periph *periph;
252 struct mtx *mtx;
253 int i;
254
255 periph = (struct cam_periph *)arg;
256 mtx = cam_periph_mtx(periph);
257 mtx_lock(mtx);
258
259 softc = (struct ch_softc *)periph->softc;
260 KASSERT(softc->open_count >= 0, ("Negative open count %d",
261 softc->open_count));
262
263 /*
264 * When we get this callback, we will get no more close calls from
265 * devfs. So if we have any dangling opens, we need to release the
266 * reference held for that particular context.
267 */
268 for (i = 0; i < softc->open_count; i++)
269 cam_periph_release_locked(periph);
270
271 softc->open_count = 0;
272
273 /*
274 * Release the reference held for the device node, it is gone now.
275 */
276 cam_periph_release_locked(periph);
277
278 /*
279 * We reference the lock directly here, instead of using
280 * cam_periph_unlock(). The reason is that the final call to
281 * cam_periph_release_locked() above could result in the periph
282 * getting freed. If that is the case, dereferencing the periph
283 * with a cam_periph_unlock() call would cause a page fault.
284 */
285 mtx_unlock(mtx);
286}
287
288static void
289choninvalidate(struct cam_periph *periph)
290{
291 struct ch_softc *softc;
292
293 softc = (struct ch_softc *)periph->softc;
294
295 /*
296 * De-register any async callbacks.
297 */
298 xpt_register_async(0, chasync, periph, periph->path);
299
300 softc->flags |= CH_FLAG_INVALID;
301
302 /*
303 * Tell devfs this device has gone away, and ask for a callback
304 * when it has cleaned up its state.
305 */
306 destroy_dev_sched_cb(softc->dev, chdevgonecb, periph);
307}
308
309static void
310chcleanup(struct cam_periph *periph)
311{
312 struct ch_softc *softc;
313
314 softc = (struct ch_softc *)periph->softc;
315
316 devstat_remove_entry(softc->device_stats);
317
318 free(softc, M_DEVBUF);
319}
320
321static void
322chasync(void *callback_arg, u_int32_t code, struct cam_path *path, void *arg)
323{
324 struct cam_periph *periph;
325
326 periph = (struct cam_periph *)callback_arg;
327
328 switch(code) {
329 case AC_FOUND_DEVICE:
330 {
331 struct ccb_getdev *cgd;
332 cam_status status;
333
334 cgd = (struct ccb_getdev *)arg;
335 if (cgd == NULL)
336 break;
337
338 if (cgd->protocol != PROTO_SCSI)
339 break;
340 if (SID_QUAL(&cgd->inq_data) != SID_QUAL_LU_CONNECTED)
341 break;
342 if (SID_TYPE(&cgd->inq_data)!= T_CHANGER)
343 break;
344
345 /*
346 * Allocate a peripheral instance for
347 * this device and start the probe
348 * process.
349 */
350 status = cam_periph_alloc(chregister, choninvalidate,
351 chcleanup, chstart, "ch",
352 CAM_PERIPH_BIO, path,
353 chasync, AC_FOUND_DEVICE, cgd);
354
355 if (status != CAM_REQ_CMP
356 && status != CAM_REQ_INPROG)
357 printf("chasync: Unable to probe new device "
358 "due to status 0x%x\n", status);
359
360 break;
361
362 }
363 default:
364 cam_periph_async(periph, code, path, arg);
365 break;
366 }
367}
368
369static cam_status
370chregister(struct cam_periph *periph, void *arg)
371{
372 struct ch_softc *softc;
373 struct ccb_getdev *cgd;
374 struct ccb_pathinq cpi;
375
376 cgd = (struct ccb_getdev *)arg;
377 if (cgd == NULL) {
378 printf("chregister: no getdev CCB, can't register device\n");
379 return(CAM_REQ_CMP_ERR);
380 }
381
382 softc = (struct ch_softc *)malloc(sizeof(*softc),M_DEVBUF,M_NOWAIT);
383
384 if (softc == NULL) {
385 printf("chregister: Unable to probe new device. "
386 "Unable to allocate softc\n");
387 return(CAM_REQ_CMP_ERR);
388 }
389
390 bzero(softc, sizeof(*softc));
391 softc->state = CH_STATE_PROBE;
392 periph->softc = softc;
393 softc->quirks = CH_Q_NONE;
394
395 /*
396 * The DVCID and CURDATA bits were not introduced until the SMC
397 * spec. If this device claims SCSI-2 or earlier support, then it
398 * very likely does not support these bits.
399 */
400 if (cgd->inq_data.version <= SCSI_REV_2)
401 softc->quirks |= CH_Q_NO_DVCID;
402
403 bzero(&cpi, sizeof(cpi));
404 xpt_setup_ccb(&cpi.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
405 cpi.ccb_h.func_code = XPT_PATH_INQ;
406 xpt_action((union ccb *)&cpi);
407
408 /*
409 * Changers don't have a blocksize, and obviously don't support
410 * tagged queueing.
411 */
412 cam_periph_unlock(periph);
413 softc->device_stats = devstat_new_entry("ch",
414 periph->unit_number, 0,
415 DEVSTAT_NO_BLOCKSIZE | DEVSTAT_NO_ORDERED_TAGS,
416 SID_TYPE(&cgd->inq_data) |
417 XPORT_DEVSTAT_TYPE(cpi.transport),
418 DEVSTAT_PRIORITY_OTHER);
419
420 /*
421 * Acquire a reference to the periph before we create the devfs
422 * instance for it. We'll release this reference once the devfs
423 * instance has been freed.
424 */
425 if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
426 xpt_print(periph->path, "%s: lost periph during "
427 "registration!\n", __func__);
428 cam_periph_lock(periph);
429 return (CAM_REQ_CMP_ERR);
430 }
431
432
433 /* Register the device */
434 softc->dev = make_dev(&ch_cdevsw, periph->unit_number, UID_ROOT,
435 GID_OPERATOR, 0600, "%s%d", periph->periph_name,
436 periph->unit_number);
437 cam_periph_lock(periph);
438 softc->dev->si_drv1 = periph;
439
440 /*
441 * Add an async callback so that we get
442 * notified if this device goes away.
443 */
444 xpt_register_async(AC_LOST_DEVICE, chasync, periph, periph->path);
445
446 /*
447 * Lock this periph until we are setup.
448 * This first call can't block
449 */
450 (void)cam_periph_hold(periph, PRIBIO);
451 xpt_schedule(periph, CAM_PRIORITY_DEV);
452
453 return(CAM_REQ_CMP);
454}
455
456static int
457chopen(struct cdev *dev, int flags, int fmt, struct thread *td)
458{
459 struct cam_periph *periph;
460 struct ch_softc *softc;
461 int error;
462
463 periph = (struct cam_periph *)dev->si_drv1;
464 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
465 return (ENXIO);
466
467 softc = (struct ch_softc *)periph->softc;
468
469 cam_periph_lock(periph);
470
471 if (softc->flags & CH_FLAG_INVALID) {
472 cam_periph_release_locked(periph);
473 cam_periph_unlock(periph);
474 return(ENXIO);
475 }
476
477 if ((error = cam_periph_hold(periph, PRIBIO | PCATCH)) != 0) {
478 cam_periph_unlock(periph);
479 cam_periph_release(periph);
480 return (error);
481 }
482
483 /*
484 * Load information about this changer device into the softc.
485 */
486 if ((error = chgetparams(periph)) != 0) {
487 cam_periph_unhold(periph);
488 cam_periph_release_locked(periph);
489 cam_periph_unlock(periph);
490 return(error);
491 }
492
493 cam_periph_unhold(periph);
494
495 softc->open_count++;
496
497 cam_periph_unlock(periph);
498
499 return(error);
500}
501
502static int
503chclose(struct cdev *dev, int flag, int fmt, struct thread *td)
504{
505 struct cam_periph *periph;
506 struct ch_softc *softc;
507 struct mtx *mtx;
508
509 periph = (struct cam_periph *)dev->si_drv1;
510 if (periph == NULL)
511 return(ENXIO);
512 mtx = cam_periph_mtx(periph);
513 mtx_lock(mtx);
514
515 softc = (struct ch_softc *)periph->softc;
516 softc->open_count--;
517
518 cam_periph_release_locked(periph);
519
520 /*
521 * We reference the lock directly here, instead of using
522 * cam_periph_unlock(). The reason is that the call to
523 * cam_periph_release_locked() above could result in the periph
524 * getting freed. If that is the case, dereferencing the periph
525 * with a cam_periph_unlock() call would cause a page fault.
526 *
527 * cam_periph_release() avoids this problem using the same method,
528 * but we're manually acquiring and dropping the lock here to
529 * protect the open count and avoid another lock acquisition and
530 * release.
531 */
532 mtx_unlock(mtx);
533
534 return(0);
535}
536
537static void
538chstart(struct cam_periph *periph, union ccb *start_ccb)
539{
540 struct ch_softc *softc;
541
542 softc = (struct ch_softc *)periph->softc;
543
544 switch (softc->state) {
545 case CH_STATE_NORMAL:
546 {
547 xpt_release_ccb(start_ccb);
548 break;
549 }
550 case CH_STATE_PROBE:
551 {
552 int mode_buffer_len;
553 void *mode_buffer;
554
555 /*
556 * Include the block descriptor when calculating the mode
557 * buffer length,
558 */
559 mode_buffer_len = sizeof(struct scsi_mode_header_6) +
560 sizeof(struct scsi_mode_blk_desc) +
561 sizeof(struct page_element_address_assignment);
562
563 mode_buffer = malloc(mode_buffer_len, M_SCSICH, M_NOWAIT);
564
565 if (mode_buffer == NULL) {
566 printf("chstart: couldn't malloc mode sense data\n");
567 break;
568 }
569 bzero(mode_buffer, mode_buffer_len);
570
571 /*
572 * Get the element address assignment page.
573 */
574 scsi_mode_sense(&start_ccb->csio,
575 /* retries */ 1,
576 /* cbfcnp */ chdone,
577 /* tag_action */ MSG_SIMPLE_Q_TAG,
578 /* dbd */ (softc->quirks & CH_Q_NO_DBD) ?
579 FALSE : TRUE,
580 /* page_code */ SMS_PAGE_CTRL_CURRENT,
581 /* page */ CH_ELEMENT_ADDR_ASSIGN_PAGE,
582 /* param_buf */ (u_int8_t *)mode_buffer,
583 /* param_len */ mode_buffer_len,
584 /* sense_len */ SSD_FULL_SIZE,
585 /* timeout */ CH_TIMEOUT_MODE_SENSE);
586
587 start_ccb->ccb_h.ccb_bp = NULL;
588 start_ccb->ccb_h.ccb_state = CH_CCB_PROBE;
589 xpt_action(start_ccb);
590 break;
591 }
592 }
593}
594
595static void
596chdone(struct cam_periph *periph, union ccb *done_ccb)
597{
598 struct ch_softc *softc;
599 struct ccb_scsiio *csio;
600
601 softc = (struct ch_softc *)periph->softc;
602 csio = &done_ccb->csio;
603
604 switch(done_ccb->ccb_h.ccb_state) {
605 case CH_CCB_PROBE:
606 {
607 struct scsi_mode_header_6 *mode_header;
608 struct page_element_address_assignment *ea;
609 char announce_buf[80];
610
611
612 mode_header = (struct scsi_mode_header_6 *)csio->data_ptr;
613
614 ea = (struct page_element_address_assignment *)
615 find_mode_page_6(mode_header);
616
617 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP){
618
619 softc->sc_firsts[CHET_MT] = scsi_2btoul(ea->mtea);
620 softc->sc_counts[CHET_MT] = scsi_2btoul(ea->nmte);
621 softc->sc_firsts[CHET_ST] = scsi_2btoul(ea->fsea);
622 softc->sc_counts[CHET_ST] = scsi_2btoul(ea->nse);
623 softc->sc_firsts[CHET_IE] = scsi_2btoul(ea->fieea);
624 softc->sc_counts[CHET_IE] = scsi_2btoul(ea->niee);
625 softc->sc_firsts[CHET_DT] = scsi_2btoul(ea->fdtea);
626 softc->sc_counts[CHET_DT] = scsi_2btoul(ea->ndte);
627 softc->sc_picker = softc->sc_firsts[CHET_MT];
628
629#define PLURAL(c) (c) == 1 ? "" : "s"
630 snprintf(announce_buf, sizeof(announce_buf),
631 "%d slot%s, %d drive%s, "
632 "%d picker%s, %d portal%s",
633 softc->sc_counts[CHET_ST],
634 PLURAL(softc->sc_counts[CHET_ST]),
635 softc->sc_counts[CHET_DT],
636 PLURAL(softc->sc_counts[CHET_DT]),
637 softc->sc_counts[CHET_MT],
638 PLURAL(softc->sc_counts[CHET_MT]),
639 softc->sc_counts[CHET_IE],
640 PLURAL(softc->sc_counts[CHET_IE]));
641#undef PLURAL
642 } else {
643 int error;
644
645 error = cherror(done_ccb, CAM_RETRY_SELTO,
646 SF_RETRY_UA | SF_NO_PRINT);
647 /*
648 * Retry any UNIT ATTENTION type errors. They
649 * are expected at boot.
650 */
651 if (error == ERESTART) {
652 /*
653 * A retry was scheuled, so
654 * just return.
655 */
656 return;
657 } else if (error != 0) {
658 struct scsi_mode_sense_6 *sms;
659 int frozen, retry_scheduled;
660
661 sms = (struct scsi_mode_sense_6 *)
662 done_ccb->csio.cdb_io.cdb_bytes;
663 frozen = (done_ccb->ccb_h.status &
664 CAM_DEV_QFRZN) != 0;
665
666 /*
667 * Check to see if block descriptors were
668 * disabled. Some devices don't like that.
669 * We're taking advantage of the fact that
670 * the first few bytes of the 6 and 10 byte
671 * mode sense commands are the same. If
672 * block descriptors were disabled, enable
673 * them and re-send the command.
674 */
675 if ((sms->byte2 & SMS_DBD) != 0 &&
676 (periph->flags & CAM_PERIPH_INVALID) == 0) {
677 sms->byte2 &= ~SMS_DBD;
678 xpt_action(done_ccb);
679 softc->quirks |= CH_Q_NO_DBD;
680 retry_scheduled = 1;
681 } else
682 retry_scheduled = 0;
683
684 /* Don't wedge this device's queue */
685 if (frozen)
686 cam_release_devq(done_ccb->ccb_h.path,
687 /*relsim_flags*/0,
688 /*reduction*/0,
689 /*timeout*/0,
690 /*getcount_only*/0);
691
692 if (retry_scheduled)
693 return;
694
695 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK)
696 == CAM_SCSI_STATUS_ERROR)
697 scsi_sense_print(&done_ccb->csio);
698 else {
699 xpt_print(periph->path,
700 "got CAM status %#x\n",
701 done_ccb->ccb_h.status);
702 }
703 xpt_print(periph->path, "fatal error, failed "
704 "to attach to device\n");
705
706 cam_periph_invalidate(periph);
707
708 announce_buf[0] = '\0';
709 }
710 }
711 if (announce_buf[0] != '\0') {
712 xpt_announce_periph(periph, announce_buf);
713 xpt_announce_quirks(periph, softc->quirks,
714 CH_Q_BIT_STRING);
715 }
716 softc->state = CH_STATE_NORMAL;
717 free(mode_header, M_SCSICH);
718 /*
719 * Since our peripheral may be invalidated by an error
720 * above or an external event, we must release our CCB
721 * before releasing the probe lock on the peripheral.
722 * The peripheral will only go away once the last lock
723 * is removed, and we need it around for the CCB release
724 * operation.
725 */
726 xpt_release_ccb(done_ccb);
727 cam_periph_unhold(periph);
728 return;
729 }
730 default:
731 break;
732 }
733 xpt_release_ccb(done_ccb);
734}
735
736static int
737cherror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
738{
739 struct ch_softc *softc;
740 struct cam_periph *periph;
741
742 periph = xpt_path_periph(ccb->ccb_h.path);
743 softc = (struct ch_softc *)periph->softc;
744
745 return (cam_periph_error(ccb, cam_flags, sense_flags,
746 &softc->saved_ccb));
747}
748
749static int
750chioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
751{
752 struct cam_periph *periph;
753 struct ch_softc *softc;
754 int error;
755
756 periph = (struct cam_periph *)dev->si_drv1;
757 if (periph == NULL)
758 return(ENXIO);
759
760 cam_periph_lock(periph);
761 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering chioctl\n"));
762
763 softc = (struct ch_softc *)periph->softc;
764
765 error = 0;
766
767 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
768 ("trying to do ioctl %#lx\n", cmd));
769
770 /*
771 * If this command can change the device's state, we must
772 * have the device open for writing.
773 */
774 switch (cmd) {
775 case CHIOGPICKER:
776 case CHIOGPARAMS:
777 case OCHIOGSTATUS:
778 case CHIOGSTATUS:
779 break;
780
781 default:
782 if ((flag & FWRITE) == 0) {
783 cam_periph_unlock(periph);
784 return (EBADF);
785 }
786 }
787
788 switch (cmd) {
789 case CHIOMOVE:
790 error = chmove(periph, (struct changer_move *)addr);
791 break;
792
793 case CHIOEXCHANGE:
794 error = chexchange(periph, (struct changer_exchange *)addr);
795 break;
796
797 case CHIOPOSITION:
798 error = chposition(periph, (struct changer_position *)addr);
799 break;
800
801 case CHIOGPICKER:
802 *(int *)addr = softc->sc_picker - softc->sc_firsts[CHET_MT];
803 break;
804
805 case CHIOSPICKER:
806 {
807 int new_picker = *(int *)addr;
808
809 if (new_picker > (softc->sc_counts[CHET_MT] - 1)) {
810 error = EINVAL;
811 break;
812 }
813 softc->sc_picker = softc->sc_firsts[CHET_MT] + new_picker;
814 break;
815 }
816 case CHIOGPARAMS:
817 {
818 struct changer_params *cp = (struct changer_params *)addr;
819
820 cp->cp_npickers = softc->sc_counts[CHET_MT];
821 cp->cp_nslots = softc->sc_counts[CHET_ST];
822 cp->cp_nportals = softc->sc_counts[CHET_IE];
823 cp->cp_ndrives = softc->sc_counts[CHET_DT];
824 break;
825 }
826 case CHIOIELEM:
827 error = chielem(periph, *(unsigned int *)addr);
828 break;
829
830 case OCHIOGSTATUS:
831 {
832 error = chgetelemstatus(periph, SCSI_REV_2, cmd,
833 (struct changer_element_status_request *)addr);
834 break;
835 }
836
837 case CHIOGSTATUS:
838 {
839 int scsi_version;
840
841 scsi_version = chscsiversion(periph);
842 if (scsi_version >= SCSI_REV_0) {
843 error = chgetelemstatus(periph, scsi_version, cmd,
844 (struct changer_element_status_request *)addr);
845 }
846 else { /* unable to determine the SCSI version */
847 cam_periph_unlock(periph);
848 return (ENXIO);
849 }
850 break;
851 }
852
853 case CHIOSETVOLTAG:
854 {
855 error = chsetvoltag(periph,
856 (struct changer_set_voltag_request *) addr);
857 break;
858 }
859
860 /* Implement prevent/allow? */
861
862 default:
863 error = cam_periph_ioctl(periph, cmd, addr, cherror);
864 break;
865 }
866
867 cam_periph_unlock(periph);
868 return (error);
869}
870
871static int
872chmove(struct cam_periph *periph, struct changer_move *cm)
873{
874 struct ch_softc *softc;
875 u_int16_t fromelem, toelem;
876 union ccb *ccb;
877 int error;
878
879 error = 0;
880 softc = (struct ch_softc *)periph->softc;
881
882 /*
883 * Check arguments.
884 */
885 if ((cm->cm_fromtype > CHET_DT) || (cm->cm_totype > CHET_DT))
886 return (EINVAL);
887 if ((cm->cm_fromunit > (softc->sc_counts[cm->cm_fromtype] - 1)) ||
888 (cm->cm_tounit > (softc->sc_counts[cm->cm_totype] - 1)))
889 return (ENODEV);
890
891 /*
892 * Check the request against the changer's capabilities.
893 */
894 if ((softc->sc_movemask[cm->cm_fromtype] & (1 << cm->cm_totype)) == 0)
895 return (ENODEV);
896
897 /*
898 * Calculate the source and destination elements.
899 */
900 fromelem = softc->sc_firsts[cm->cm_fromtype] + cm->cm_fromunit;
901 toelem = softc->sc_firsts[cm->cm_totype] + cm->cm_tounit;
902
903 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
904
905 scsi_move_medium(&ccb->csio,
906 /* retries */ 1,
907 /* cbfcnp */ chdone,
908 /* tag_action */ MSG_SIMPLE_Q_TAG,
909 /* tea */ softc->sc_picker,
910 /* src */ fromelem,
911 /* dst */ toelem,
912 /* invert */ (cm->cm_flags & CM_INVERT) ? TRUE : FALSE,
913 /* sense_len */ SSD_FULL_SIZE,
914 /* timeout */ CH_TIMEOUT_MOVE_MEDIUM);
915
916 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/CAM_RETRY_SELTO,
917 /*sense_flags*/ SF_RETRY_UA,
918 softc->device_stats);
919
920 xpt_release_ccb(ccb);
921
922 return(error);
923}
924
925static int
926chexchange(struct cam_periph *periph, struct changer_exchange *ce)
927{
928 struct ch_softc *softc;
929 u_int16_t src, dst1, dst2;
930 union ccb *ccb;
931 int error;
932
933 error = 0;
934 softc = (struct ch_softc *)periph->softc;
935 /*
936 * Check arguments.
937 */
938 if ((ce->ce_srctype > CHET_DT) || (ce->ce_fdsttype > CHET_DT) ||
939 (ce->ce_sdsttype > CHET_DT))
940 return (EINVAL);
941 if ((ce->ce_srcunit > (softc->sc_counts[ce->ce_srctype] - 1)) ||
942 (ce->ce_fdstunit > (softc->sc_counts[ce->ce_fdsttype] - 1)) ||
943 (ce->ce_sdstunit > (softc->sc_counts[ce->ce_sdsttype] - 1)))
944 return (ENODEV);
945
946 /*
947 * Check the request against the changer's capabilities.
948 */
949 if (((softc->sc_exchangemask[ce->ce_srctype] &
950 (1 << ce->ce_fdsttype)) == 0) ||
951 ((softc->sc_exchangemask[ce->ce_fdsttype] &
952 (1 << ce->ce_sdsttype)) == 0))
953 return (ENODEV);
954
955 /*
956 * Calculate the source and destination elements.
957 */
958 src = softc->sc_firsts[ce->ce_srctype] + ce->ce_srcunit;
959 dst1 = softc->sc_firsts[ce->ce_fdsttype] + ce->ce_fdstunit;
960 dst2 = softc->sc_firsts[ce->ce_sdsttype] + ce->ce_sdstunit;
961
962 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
963
964 scsi_exchange_medium(&ccb->csio,
965 /* retries */ 1,
966 /* cbfcnp */ chdone,
967 /* tag_action */ MSG_SIMPLE_Q_TAG,
968 /* tea */ softc->sc_picker,
969 /* src */ src,
970 /* dst1 */ dst1,
971 /* dst2 */ dst2,
972 /* invert1 */ (ce->ce_flags & CE_INVERT1) ?
973 TRUE : FALSE,
974 /* invert2 */ (ce->ce_flags & CE_INVERT2) ?
975 TRUE : FALSE,
976 /* sense_len */ SSD_FULL_SIZE,
977 /* timeout */ CH_TIMEOUT_EXCHANGE_MEDIUM);
978
979 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/CAM_RETRY_SELTO,
980 /*sense_flags*/ SF_RETRY_UA,
981 softc->device_stats);
982
983 xpt_release_ccb(ccb);
984
985 return(error);
986}
987
988static int
989chposition(struct cam_periph *periph, struct changer_position *cp)
990{
991 struct ch_softc *softc;
992 u_int16_t dst;
993 union ccb *ccb;
994 int error;
995
996 error = 0;
997 softc = (struct ch_softc *)periph->softc;
998
999 /*
1000 * Check arguments.
1001 */
1002 if (cp->cp_type > CHET_DT)
1003 return (EINVAL);
1004 if (cp->cp_unit > (softc->sc_counts[cp->cp_type] - 1))
1005 return (ENODEV);
1006
1007 /*
1008 * Calculate the destination element.
1009 */
1010 dst = softc->sc_firsts[cp->cp_type] + cp->cp_unit;
1011
1012 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1013
1014 scsi_position_to_element(&ccb->csio,
1015 /* retries */ 1,
1016 /* cbfcnp */ chdone,
1017 /* tag_action */ MSG_SIMPLE_Q_TAG,
1018 /* tea */ softc->sc_picker,
1019 /* dst */ dst,
1020 /* invert */ (cp->cp_flags & CP_INVERT) ?
1021 TRUE : FALSE,
1022 /* sense_len */ SSD_FULL_SIZE,
1023 /* timeout */ CH_TIMEOUT_POSITION_TO_ELEMENT);
1024
1025 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1026 /*sense_flags*/ SF_RETRY_UA,
1027 softc->device_stats);
1028
1029 xpt_release_ccb(ccb);
1030
1031 return(error);
1032}
1033
1034/*
1035 * Copy a volume tag to a volume_tag struct, converting SCSI byte order
1036 * to host native byte order in the volume serial number. The volume
1037 * label as returned by the changer is transferred to user mode as
1038 * nul-terminated string. Volume labels are truncated at the first
1039 * space, as suggested by SCSI-2.
1040 */
1041static void
1042copy_voltag(struct changer_voltag *uvoltag, struct volume_tag *voltag)
1043{
1044 int i;
1045 for (i=0; i<CH_VOLTAG_MAXLEN; i++) {
1046 char c = voltag->vif[i];
1047 if (c && c != ' ')
1048 uvoltag->cv_volid[i] = c;
1049 else
1050 break;
1051 }
1052 uvoltag->cv_serial = scsi_2btoul(voltag->vsn);
1053}
1054
1055/*
1056 * Copy an element status descriptor to a user-mode
1057 * changer_element_status structure.
1058 */
1059static void
1060copy_element_status(struct ch_softc *softc,
1061 u_int16_t flags,
1062 struct read_element_status_descriptor *desc,
1063 struct changer_element_status *ces,
1064 int scsi_version)
1065{
1066 u_int16_t eaddr = scsi_2btoul(desc->eaddr);
1067 u_int16_t et;
1068 struct volume_tag *pvol_tag = NULL, *avol_tag = NULL;
1069 struct read_element_status_device_id *devid = NULL;
1070
1071 ces->ces_int_addr = eaddr;
1072 /* set up logical address in element status */
1073 for (et = CHET_MT; et <= CHET_DT; et++) {
1074 if ((softc->sc_firsts[et] <= eaddr)
1075 && ((softc->sc_firsts[et] + softc->sc_counts[et])
1076 > eaddr)) {
1077 ces->ces_addr = eaddr - softc->sc_firsts[et];
1078 ces->ces_type = et;
1079 break;
1080 }
1081 }
1082
1083 ces->ces_flags = desc->flags1;
1084
1085 ces->ces_sensecode = desc->sense_code;
1086 ces->ces_sensequal = desc->sense_qual;
1087
1088 if (desc->flags2 & READ_ELEMENT_STATUS_INVERT)
1089 ces->ces_flags |= CES_INVERT;
1090
1091 if (desc->flags2 & READ_ELEMENT_STATUS_SVALID) {
1092
1093 eaddr = scsi_2btoul(desc->ssea);
1094
1095 /* convert source address to logical format */
1096 for (et = CHET_MT; et <= CHET_DT; et++) {
1097 if ((softc->sc_firsts[et] <= eaddr)
1098 && ((softc->sc_firsts[et] + softc->sc_counts[et])
1099 > eaddr)) {
1100 ces->ces_source_addr =
1101 eaddr - softc->sc_firsts[et];
1102 ces->ces_source_type = et;
1103 ces->ces_flags |= CES_SOURCE_VALID;
1104 break;
1105 }
1106 }
1107
1108 if (!(ces->ces_flags & CES_SOURCE_VALID))
1109 printf("ch: warning: could not map element source "
1110 "address %ud to a valid element type\n",
1111 eaddr);
1112 }
1113
1114 /*
1115 * pvoltag and avoltag are common between SCSI-2 and later versions
1116 */
1117 if (flags & READ_ELEMENT_STATUS_PVOLTAG)
1118 pvol_tag = &desc->voltag_devid.pvoltag;
1119 if (flags & READ_ELEMENT_STATUS_AVOLTAG)
1120 avol_tag = (flags & READ_ELEMENT_STATUS_PVOLTAG) ?
1121 &desc->voltag_devid.voltag[1] :&desc->voltag_devid.pvoltag;
1122 /*
1123 * For SCSI-3 and later, element status can carry designator and
1124 * other information.
1125 */
1126 if (scsi_version >= SCSI_REV_SPC) {
1127 if ((flags & READ_ELEMENT_STATUS_PVOLTAG) ^
1128 (flags & READ_ELEMENT_STATUS_AVOLTAG))
1129 devid = &desc->voltag_devid.pvol_and_devid.devid;
1130 else if (!(flags & READ_ELEMENT_STATUS_PVOLTAG) &&
1131 !(flags & READ_ELEMENT_STATUS_AVOLTAG))
1132 devid = &desc->voltag_devid.devid;
1133 else /* Have both PVOLTAG and AVOLTAG */
1134 devid = &desc->voltag_devid.vol_tags_and_devid.devid;
1135 }
1136
1137 if (pvol_tag)
1138 copy_voltag(&(ces->ces_pvoltag), pvol_tag);
1139 if (avol_tag)
1140 copy_voltag(&(ces->ces_pvoltag), avol_tag);
1141 if (devid != NULL) {
1142 if (devid->designator_length > 0) {
1143 bcopy((void *)devid->designator,
1144 (void *)ces->ces_designator,
1145 devid->designator_length);
1146 ces->ces_designator_length = devid->designator_length;
1147 /*
1148 * Make sure we are always NUL terminated. The
1149 * This won't matter for the binary code set,
1150 * since the user will only pay attention to the
1151 * length field.
1152 */
1153 ces->ces_designator[devid->designator_length]= '\0';
1154 }
1155 if (devid->piv_assoc_designator_type &
1156 READ_ELEMENT_STATUS_PIV_SET) {
1157 ces->ces_flags |= CES_PIV;
1158 ces->ces_protocol_id =
1159 READ_ELEMENT_STATUS_PROTOCOL_ID(
1160 devid->prot_code_set);
1161 }
1162 ces->ces_code_set =
1163 READ_ELEMENT_STATUS_CODE_SET(devid->prot_code_set);
1164 ces->ces_assoc = READ_ELEMENT_STATUS_ASSOCIATION(
1165 devid->piv_assoc_designator_type);
1166 ces->ces_designator_type = READ_ELEMENT_STATUS_DESIGNATOR_TYPE(
1167 devid->piv_assoc_designator_type);
1168 } else if (scsi_version > SCSI_REV_2) {
1169 /* SCSI-SPC and No devid, no designator */
1170 ces->ces_designator_length = 0;
1171 ces->ces_designator[0] = '\0';
1172 ces->ces_protocol_id = CES_PROTOCOL_ID_FCP_4;
1173 }
1174
1175 if (scsi_version <= SCSI_REV_2) {
1176 if (desc->dt_or_obsolete.scsi_2.dt_scsi_flags &
1177 READ_ELEMENT_STATUS_DT_IDVALID) {
1178 ces->ces_flags |= CES_SCSIID_VALID;
1179 ces->ces_scsi_id =
1180 desc->dt_or_obsolete.scsi_2.dt_scsi_addr;
1181 }
1182
1183 if (desc->dt_or_obsolete.scsi_2.dt_scsi_addr &
1184 READ_ELEMENT_STATUS_DT_LUVALID) {
1185 ces->ces_flags |= CES_LUN_VALID;
1186 ces->ces_scsi_lun =
1187 desc->dt_or_obsolete.scsi_2.dt_scsi_flags &
1188 READ_ELEMENT_STATUS_DT_LUNMASK;
1189 }
1190 }
1191}
1192
1193static int
1194chgetelemstatus(struct cam_periph *periph, int scsi_version, u_long cmd,
1195 struct changer_element_status_request *cesr)
1196{
1197 struct read_element_status_header *st_hdr;
1198 struct read_element_status_page_header *pg_hdr;
1199 struct read_element_status_descriptor *desc;
1200 caddr_t data = NULL;
1201 size_t size, desclen;
1202 int avail, i, error = 0;
1203 int curdata, dvcid, sense_flags;
1204 int try_no_dvcid = 0;
1205 struct changer_element_status *user_data = NULL;
1206 struct ch_softc *softc;
1207 union ccb *ccb;
1208 int chet = cesr->cesr_element_type;
1209 int want_voltags = (cesr->cesr_flags & CESR_VOLTAGS) ? 1 : 0;
1210
1211 softc = (struct ch_softc *)periph->softc;
1212
1213 /* perform argument checking */
1214
1215 /*
1216 * Perform a range check on the cesr_element_{base,count}
1217 * request argument fields.
1218 */
1219 if ((softc->sc_counts[chet] - cesr->cesr_element_base) <= 0
1220 || (cesr->cesr_element_base + cesr->cesr_element_count)
1221 > softc->sc_counts[chet])
1222 return (EINVAL);
1223
1224 /*
1225 * Request one descriptor for the given element type. This
1226 * is used to determine the size of the descriptor so that
1227 * we can allocate enough storage for all of them. We assume
1228 * that the first one can fit into 1k.
1229 */
1230 cam_periph_unlock(periph);
1231 data = (caddr_t)malloc(1024, M_DEVBUF, M_WAITOK);
1232
1233 cam_periph_lock(periph);
1234 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1235
1236 sense_flags = SF_RETRY_UA;
1237 if (softc->quirks & CH_Q_NO_DVCID) {
1238 dvcid = 0;
1239 curdata = 0;
1240 } else {
1241 dvcid = 1;
1242 curdata = 1;
1243 /*
1244 * Don't print anything for an Illegal Request, because
1245 * these flags can cause some changers to complain. We'll
1246 * retry without them if we get an error.
1247 */
1248 sense_flags |= SF_QUIET_IR;
1249 }
1250
1251retry_einval:
1252
1253 scsi_read_element_status(&ccb->csio,
1254 /* retries */ 1,
1255 /* cbfcnp */ chdone,
1256 /* tag_action */ MSG_SIMPLE_Q_TAG,
1257 /* voltag */ want_voltags,
1258 /* sea */ softc->sc_firsts[chet],
1259 /* curdata */ curdata,
1260 /* dvcid */ dvcid,
1261 /* count */ 1,
1262 /* data_ptr */ data,
1263 /* dxfer_len */ 1024,
1264 /* sense_len */ SSD_FULL_SIZE,
1265 /* timeout */ CH_TIMEOUT_READ_ELEMENT_STATUS);
1266
1267 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1268 /*sense_flags*/ sense_flags,
1269 softc->device_stats);
1270
1271 /*
1272 * An Illegal Request sense key (only used if there is no asc/ascq)
1273 * or 0x24,0x00 for an ASC/ASCQ both map to EINVAL. If dvcid or
1274 * curdata are set (we set both or neither), try turning them off
1275 * and see if the command is successful.
1276 */
1277 if ((error == EINVAL)
1278 && (dvcid || curdata)) {
1279 dvcid = 0;
1280 curdata = 0;
1281 error = 0;
1282 /* At this point we want to report any Illegal Request */
1283 sense_flags &= ~SF_QUIET_IR;
1284 try_no_dvcid = 1;
1285 goto retry_einval;
1286 }
1287
1288 /*
1289 * In this case, we tried a read element status with dvcid and
1290 * curdata set, and it failed. We retried without those bits, and
1291 * it succeeded. Suggest to the user that he set a quirk, so we
1292 * don't go through the retry process the first time in the future.
1293 * This should only happen on changers that claim SCSI-3 or higher,
1294 * but don't support these bits.
1295 */
1296 if ((try_no_dvcid != 0)
1297 && (error == 0))
1298 softc->quirks |= CH_Q_NO_DVCID;
1299
1300 if (error)
1301 goto done;
1302 cam_periph_unlock(periph);
1303
1304 st_hdr = (struct read_element_status_header *)data;
1305 pg_hdr = (struct read_element_status_page_header *)((uintptr_t)st_hdr +
1306 sizeof(struct read_element_status_header));
1307 desclen = scsi_2btoul(pg_hdr->edl);
1308
1309 size = sizeof(struct read_element_status_header) +
1310 sizeof(struct read_element_status_page_header) +
1311 (desclen * cesr->cesr_element_count);
1312 /*
1313 * Reallocate storage for descriptors and get them from the
1314 * device.
1315 */
1316 free(data, M_DEVBUF);
1317 data = (caddr_t)malloc(size, M_DEVBUF, M_WAITOK);
1318
1319 cam_periph_lock(periph);
1320 scsi_read_element_status(&ccb->csio,
1321 /* retries */ 1,
1322 /* cbfcnp */ chdone,
1323 /* tag_action */ MSG_SIMPLE_Q_TAG,
1324 /* voltag */ want_voltags,
1325 /* sea */ softc->sc_firsts[chet]
1326 + cesr->cesr_element_base,
1327 /* curdata */ curdata,
1328 /* dvcid */ dvcid,
1329 /* count */ cesr->cesr_element_count,
1330 /* data_ptr */ data,
1331 /* dxfer_len */ size,
1332 /* sense_len */ SSD_FULL_SIZE,
1333 /* timeout */ CH_TIMEOUT_READ_ELEMENT_STATUS);
1334
1335 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1336 /*sense_flags*/ SF_RETRY_UA,
1337 softc->device_stats);
1338
1339 if (error)
1340 goto done;
1341 cam_periph_unlock(periph);
1342
1343 /*
1344 * Fill in the user status array.
1345 */
1346 st_hdr = (struct read_element_status_header *)data;
1347 pg_hdr = (struct read_element_status_page_header *)((uintptr_t)st_hdr +
1348 sizeof(struct read_element_status_header));
1349 avail = scsi_2btoul(st_hdr->count);
1350
1351 if (avail != cesr->cesr_element_count) {
1352 xpt_print(periph->path,
1353 "warning, READ ELEMENT STATUS avail != count\n");
1354 }
1355
1356 user_data = (struct changer_element_status *)
1357 malloc(avail * sizeof(struct changer_element_status),
1358 M_DEVBUF, M_WAITOK | M_ZERO);
1359
1360 desc = (struct read_element_status_descriptor *)((uintptr_t)data +
1361 sizeof(struct read_element_status_header) +
1362 sizeof(struct read_element_status_page_header));
1363 /*
1364 * Set up the individual element status structures
1365 */
1366 for (i = 0; i < avail; ++i) {
1367 struct changer_element_status *ces;
1368
1369 /*
1370 * In the changer_element_status structure, fields from
1371 * the beginning to the field of ces_scsi_lun are common
1372 * between SCSI-2 and SCSI-3, while all the rest are new
1373 * from SCSI-3. In order to maintain backward compatibility
1374 * of the chio command, the ces pointer, below, is computed
1375 * such that it lines up with the structure boundary
1376 * corresponding to the SCSI version.
1377 */
1378 ces = cmd == OCHIOGSTATUS ?
1379 (struct changer_element_status *)
1380 ((unsigned char *)user_data + i *
1381 (offsetof(struct changer_element_status,ces_scsi_lun)+1)):
1382 &user_data[i];
1383
1384 copy_element_status(softc, pg_hdr->flags, desc,
1385 ces, scsi_version);
1386
1387 desc = (struct read_element_status_descriptor *)
1388 ((unsigned char *)desc + desclen);
1389 }
1390
1391 /* Copy element status structures out to userspace. */
1392 if (cmd == OCHIOGSTATUS)
1393 error = copyout(user_data,
1394 cesr->cesr_element_status,
1395 avail* (offsetof(struct changer_element_status,
1396 ces_scsi_lun) + 1));
1397 else
1398 error = copyout(user_data,
1399 cesr->cesr_element_status,
1400 avail * sizeof(struct changer_element_status));
1401
1402 cam_periph_lock(periph);
1403
1404 done:
1405 xpt_release_ccb(ccb);
1406
1407 if (data != NULL)
1408 free(data, M_DEVBUF);
1409 if (user_data != NULL)
1410 free(user_data, M_DEVBUF);
1411
1412 return (error);
1413}
1414
1415static int
1416chielem(struct cam_periph *periph,
1417 unsigned int timeout)
1418{
1419 union ccb *ccb;
1420 struct ch_softc *softc;
1421 int error;
1422
1423 if (!timeout) {
1424 timeout = CH_TIMEOUT_INITIALIZE_ELEMENT_STATUS;
1425 } else {
1426 timeout *= 1000;
1427 }
1428
1429 error = 0;
1430 softc = (struct ch_softc *)periph->softc;
1431
1432 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1433
1434 scsi_initialize_element_status(&ccb->csio,
1435 /* retries */ 1,
1436 /* cbfcnp */ chdone,
1437 /* tag_action */ MSG_SIMPLE_Q_TAG,
1438 /* sense_len */ SSD_FULL_SIZE,
1439 /* timeout */ timeout);
1440
1441 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1442 /*sense_flags*/ SF_RETRY_UA,
1443 softc->device_stats);
1444
1445 xpt_release_ccb(ccb);
1446
1447 return(error);
1448}
1449
1450static int
1451chsetvoltag(struct cam_periph *periph,
1452 struct changer_set_voltag_request *csvr)
1453{
1454 union ccb *ccb;
1455 struct ch_softc *softc;
1456 u_int16_t ea;
1457 u_int8_t sac;
1458 struct scsi_send_volume_tag_parameters ssvtp;
1459 int error;
1460 int i;
1461
1462 error = 0;
1463 softc = (struct ch_softc *)periph->softc;
1464
1465 bzero(&ssvtp, sizeof(ssvtp));
1466 for (i=0; i<sizeof(ssvtp.vitf); i++) {
1467 ssvtp.vitf[i] = ' ';
1468 }
1469
1470 /*
1471 * Check arguments.
1472 */
1473 if (csvr->csvr_type > CHET_DT)
1474 return EINVAL;
1475 if (csvr->csvr_addr > (softc->sc_counts[csvr->csvr_type] - 1))
1476 return ENODEV;
1477
1478 ea = softc->sc_firsts[csvr->csvr_type] + csvr->csvr_addr;
1479
1480 if (csvr->csvr_flags & CSVR_ALTERNATE) {
1481 switch (csvr->csvr_flags & CSVR_MODE_MASK) {
1482 case CSVR_MODE_SET:
1483 sac = SEND_VOLUME_TAG_ASSERT_ALTERNATE;
1484 break;
1485 case CSVR_MODE_REPLACE:
1486 sac = SEND_VOLUME_TAG_REPLACE_ALTERNATE;
1487 break;
1488 case CSVR_MODE_CLEAR:
1489 sac = SEND_VOLUME_TAG_UNDEFINED_ALTERNATE;
1490 break;
1491 default:
1492 error = EINVAL;
1493 goto out;
1494 }
1495 } else {
1496 switch (csvr->csvr_flags & CSVR_MODE_MASK) {
1497 case CSVR_MODE_SET:
1498 sac = SEND_VOLUME_TAG_ASSERT_PRIMARY;
1499 break;
1500 case CSVR_MODE_REPLACE:
1501 sac = SEND_VOLUME_TAG_REPLACE_PRIMARY;
1502 break;
1503 case CSVR_MODE_CLEAR:
1504 sac = SEND_VOLUME_TAG_UNDEFINED_PRIMARY;
1505 break;
1506 default:
1507 error = EINVAL;
1508 goto out;
1509 }
1510 }
1511
1512 memcpy(ssvtp.vitf, csvr->csvr_voltag.cv_volid,
1513 min(strlen(csvr->csvr_voltag.cv_volid), sizeof(ssvtp.vitf)));
1514 scsi_ulto2b(csvr->csvr_voltag.cv_serial, ssvtp.minvsn);
1515
1516 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1517
1518 scsi_send_volume_tag(&ccb->csio,
1519 /* retries */ 1,
1520 /* cbfcnp */ chdone,
1521 /* tag_action */ MSG_SIMPLE_Q_TAG,
1522 /* element_address */ ea,
1523 /* send_action_code */ sac,
1524 /* parameters */ &ssvtp,
1525 /* sense_len */ SSD_FULL_SIZE,
1526 /* timeout */ CH_TIMEOUT_SEND_VOLTAG);
1527
1528 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1529 /*sense_flags*/ SF_RETRY_UA,
1530 softc->device_stats);
1531
1532 xpt_release_ccb(ccb);
1533
1534 out:
1535 return error;
1536}
1537
1538static int
1539chgetparams(struct cam_periph *periph)
1540{
1541 union ccb *ccb;
1542 struct ch_softc *softc;
1543 void *mode_buffer;
1544 int mode_buffer_len;
1545 struct page_element_address_assignment *ea;
1546 struct page_device_capabilities *cap;
1547 int error, from, dbd;
1548 u_int8_t *moves, *exchanges;
1549
1550 error = 0;
1551
1552 softc = (struct ch_softc *)periph->softc;
1553
1554 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1555
1556 /*
1557 * The scsi_mode_sense_data structure is just a convenience
1558 * structure that allows us to easily calculate the worst-case
1559 * storage size of the mode sense buffer.
1560 */
1561 mode_buffer_len = sizeof(struct scsi_mode_sense_data);
1562
1563 mode_buffer = malloc(mode_buffer_len, M_SCSICH, M_NOWAIT);
1564
1565 if (mode_buffer == NULL) {
1566 printf("chgetparams: couldn't malloc mode sense data\n");
1567 return(ENOSPC);
1568 }
1569
1570 bzero(mode_buffer, mode_buffer_len);
1571
1572 if (softc->quirks & CH_Q_NO_DBD)
1573 dbd = FALSE;
1574 else
1575 dbd = TRUE;
1576
1577 /*
1578 * Get the element address assignment page.
1579 */
1580 scsi_mode_sense(&ccb->csio,
1581 /* retries */ 1,
1582 /* cbfcnp */ chdone,
1583 /* tag_action */ MSG_SIMPLE_Q_TAG,
1584 /* dbd */ dbd,
1585 /* page_code */ SMS_PAGE_CTRL_CURRENT,
1586 /* page */ CH_ELEMENT_ADDR_ASSIGN_PAGE,
1587 /* param_buf */ (u_int8_t *)mode_buffer,
1588 /* param_len */ mode_buffer_len,
1589 /* sense_len */ SSD_FULL_SIZE,
1590 /* timeout */ CH_TIMEOUT_MODE_SENSE);
1591
1592 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1593 /* sense_flags */ SF_RETRY_UA|SF_NO_PRINT,
1594 softc->device_stats);
1595
1596 if (error) {
1597 if (dbd) {
1598 struct scsi_mode_sense_6 *sms;
1599
1600 sms = (struct scsi_mode_sense_6 *)
1601 ccb->csio.cdb_io.cdb_bytes;
1602
1603 sms->byte2 &= ~SMS_DBD;
1604 error = cam_periph_runccb(ccb, cherror,
1605 /*cam_flags*/ CAM_RETRY_SELTO,
1606 /*sense_flags*/ SF_RETRY_UA,
1607 softc->device_stats);
1608 } else {
1609 /*
1610 * Since we disabled sense printing above, print
1611 * out the sense here since we got an error.
1612 */
1613 scsi_sense_print(&ccb->csio);
1614 }
1615
1616 if (error) {
1617 xpt_print(periph->path,
1618 "chgetparams: error getting element "
1619 "address page\n");
1620 xpt_release_ccb(ccb);
1621 free(mode_buffer, M_SCSICH);
1622 return(error);
1623 }
1624 }
1625
1626 ea = (struct page_element_address_assignment *)
1627 find_mode_page_6((struct scsi_mode_header_6 *)mode_buffer);
1628
1629 softc->sc_firsts[CHET_MT] = scsi_2btoul(ea->mtea);
1630 softc->sc_counts[CHET_MT] = scsi_2btoul(ea->nmte);
1631 softc->sc_firsts[CHET_ST] = scsi_2btoul(ea->fsea);
1632 softc->sc_counts[CHET_ST] = scsi_2btoul(ea->nse);
1633 softc->sc_firsts[CHET_IE] = scsi_2btoul(ea->fieea);
1634 softc->sc_counts[CHET_IE] = scsi_2btoul(ea->niee);
1635 softc->sc_firsts[CHET_DT] = scsi_2btoul(ea->fdtea);
1636 softc->sc_counts[CHET_DT] = scsi_2btoul(ea->ndte);
1637
1638 bzero(mode_buffer, mode_buffer_len);
1639
1640 /*
1641 * Now get the device capabilities page.
1642 */
1643 scsi_mode_sense(&ccb->csio,
1644 /* retries */ 1,
1645 /* cbfcnp */ chdone,
1646 /* tag_action */ MSG_SIMPLE_Q_TAG,
1647 /* dbd */ dbd,
1648 /* page_code */ SMS_PAGE_CTRL_CURRENT,
1649 /* page */ CH_DEVICE_CAP_PAGE,
1650 /* param_buf */ (u_int8_t *)mode_buffer,
1651 /* param_len */ mode_buffer_len,
1652 /* sense_len */ SSD_FULL_SIZE,
1653 /* timeout */ CH_TIMEOUT_MODE_SENSE);
1654
1655 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1656 /* sense_flags */ SF_RETRY_UA | SF_NO_PRINT,
1657 softc->device_stats);
1658
1659 if (error) {
1660 if (dbd) {
1661 struct scsi_mode_sense_6 *sms;
1662
1663 sms = (struct scsi_mode_sense_6 *)
1664 ccb->csio.cdb_io.cdb_bytes;
1665
1666 sms->byte2 &= ~SMS_DBD;
1667 error = cam_periph_runccb(ccb, cherror,
1668 /*cam_flags*/ CAM_RETRY_SELTO,
1669 /*sense_flags*/ SF_RETRY_UA,
1670 softc->device_stats);
1671 } else {
1672 /*
1673 * Since we disabled sense printing above, print
1674 * out the sense here since we got an error.
1675 */
1676 scsi_sense_print(&ccb->csio);
1677 }
1678
1679 if (error) {
1680 xpt_print(periph->path,
1681 "chgetparams: error getting device "
1682 "capabilities page\n");
1683 xpt_release_ccb(ccb);
1684 free(mode_buffer, M_SCSICH);
1685 return(error);
1686 }
1687 }
1688
1689 xpt_release_ccb(ccb);
1690
1691 cap = (struct page_device_capabilities *)
1692 find_mode_page_6((struct scsi_mode_header_6 *)mode_buffer);
1693
1694 bzero(softc->sc_movemask, sizeof(softc->sc_movemask));
1695 bzero(softc->sc_exchangemask, sizeof(softc->sc_exchangemask));
1696 moves = cap->move_from;
1697 exchanges = cap->exchange_with;
1698 for (from = CHET_MT; from <= CHET_MAX; ++from) {
1699 softc->sc_movemask[from] = moves[from];
1700 softc->sc_exchangemask[from] = exchanges[from];
1701 }
1702
1703 free(mode_buffer, M_SCSICH);
1704
1705 return(error);
1706}
1707
1708static int
1709chscsiversion(struct cam_periph *periph)
1710{
1711 struct scsi_inquiry_data *inq_data;
1712 struct ccb_getdev *cgd;
1713 int dev_scsi_version;
1714
1715 cam_periph_assert(periph, MA_OWNED);
1716 if ((cgd = (struct ccb_getdev *)xpt_alloc_ccb_nowait()) == NULL)
1717 return (-1);
1718 /*
1719 * Get the device information.
1720 */
1721 xpt_setup_ccb(&cgd->ccb_h,
1722 periph->path,
1723 CAM_PRIORITY_NORMAL);
1724 cgd->ccb_h.func_code = XPT_GDEV_TYPE;
1725 xpt_action((union ccb *)cgd);
1726
1727 if (cgd->ccb_h.status != CAM_REQ_CMP) {
1728 xpt_free_ccb((union ccb *)cgd);
1729 return -1;
1730 }
1731
1732 inq_data = &cgd->inq_data;
1733 dev_scsi_version = inq_data->version;
1734 xpt_free_ccb((union ccb *)cgd);
1735
1736 return dev_scsi_version;
1737}
1738
1739void
1740scsi_move_medium(struct ccb_scsiio *csio, u_int32_t retries,
1741 void (*cbfcnp)(struct cam_periph *, union ccb *),
1742 u_int8_t tag_action, u_int32_t tea, u_int32_t src,
1743 u_int32_t dst, int invert, u_int8_t sense_len,
1744 u_int32_t timeout)
1745{
1746 struct scsi_move_medium *scsi_cmd;
1747
1748 scsi_cmd = (struct scsi_move_medium *)&csio->cdb_io.cdb_bytes;
1749 bzero(scsi_cmd, sizeof(*scsi_cmd));
1750
1751 scsi_cmd->opcode = MOVE_MEDIUM;
1752
1753 scsi_ulto2b(tea, scsi_cmd->tea);
1754 scsi_ulto2b(src, scsi_cmd->src);
1755 scsi_ulto2b(dst, scsi_cmd->dst);
1756
1757 if (invert)
1758 scsi_cmd->invert |= MOVE_MEDIUM_INVERT;
1759
1760 cam_fill_csio(csio,
1761 retries,
1762 cbfcnp,
1763 /*flags*/ CAM_DIR_NONE,
1764 tag_action,
1765 /*data_ptr*/ NULL,
1766 /*dxfer_len*/ 0,
1767 sense_len,
1768 sizeof(*scsi_cmd),
1769 timeout);
1770}
1771
1772void
1773scsi_exchange_medium(struct ccb_scsiio *csio, u_int32_t retries,
1774 void (*cbfcnp)(struct cam_periph *, union ccb *),
1775 u_int8_t tag_action, u_int32_t tea, u_int32_t src,
1776 u_int32_t dst1, u_int32_t dst2, int invert1,
1777 int invert2, u_int8_t sense_len, u_int32_t timeout)
1778{
1779 struct scsi_exchange_medium *scsi_cmd;
1780
1781 scsi_cmd = (struct scsi_exchange_medium *)&csio->cdb_io.cdb_bytes;
1782 bzero(scsi_cmd, sizeof(*scsi_cmd));
1783
1784 scsi_cmd->opcode = EXCHANGE_MEDIUM;
1785
1786 scsi_ulto2b(tea, scsi_cmd->tea);
1787 scsi_ulto2b(src, scsi_cmd->src);
1788 scsi_ulto2b(dst1, scsi_cmd->fdst);
1789 scsi_ulto2b(dst2, scsi_cmd->sdst);
1790
1791 if (invert1)
1792 scsi_cmd->invert |= EXCHANGE_MEDIUM_INV1;
1793
1794 if (invert2)
1795 scsi_cmd->invert |= EXCHANGE_MEDIUM_INV2;
1796
1797 cam_fill_csio(csio,
1798 retries,
1799 cbfcnp,
1800 /*flags*/ CAM_DIR_NONE,
1801 tag_action,
1802 /*data_ptr*/ NULL,
1803 /*dxfer_len*/ 0,
1804 sense_len,
1805 sizeof(*scsi_cmd),
1806 timeout);
1807}
1808
1809void
1810scsi_position_to_element(struct ccb_scsiio *csio, u_int32_t retries,
1811 void (*cbfcnp)(struct cam_periph *, union ccb *),
1812 u_int8_t tag_action, u_int32_t tea, u_int32_t dst,
1813 int invert, u_int8_t sense_len, u_int32_t timeout)
1814{
1815 struct scsi_position_to_element *scsi_cmd;
1816
1817 scsi_cmd = (struct scsi_position_to_element *)&csio->cdb_io.cdb_bytes;
1818 bzero(scsi_cmd, sizeof(*scsi_cmd));
1819
1820 scsi_cmd->opcode = POSITION_TO_ELEMENT;
1821
1822 scsi_ulto2b(tea, scsi_cmd->tea);
1823 scsi_ulto2b(dst, scsi_cmd->dst);
1824
1825 if (invert)
1826 scsi_cmd->invert |= POSITION_TO_ELEMENT_INVERT;
1827
1828 cam_fill_csio(csio,
1829 retries,
1830 cbfcnp,
1831 /*flags*/ CAM_DIR_NONE,
1832 tag_action,
1833 /*data_ptr*/ NULL,
1834 /*dxfer_len*/ 0,
1835 sense_len,
1836 sizeof(*scsi_cmd),
1837 timeout);
1838}
1839
1840void
1841scsi_read_element_status(struct ccb_scsiio *csio, u_int32_t retries,
1842 void (*cbfcnp)(struct cam_periph *, union ccb *),
1843 u_int8_t tag_action, int voltag, u_int32_t sea,
1844 int curdata, int dvcid,
1845 u_int32_t count, u_int8_t *data_ptr,
1846 u_int32_t dxfer_len, u_int8_t sense_len,
1847 u_int32_t timeout)
1848{
1849 struct scsi_read_element_status *scsi_cmd;
1850
1851 scsi_cmd = (struct scsi_read_element_status *)&csio->cdb_io.cdb_bytes;
1852 bzero(scsi_cmd, sizeof(*scsi_cmd));
1853
1854 scsi_cmd->opcode = READ_ELEMENT_STATUS;
1855
1856 scsi_ulto2b(sea, scsi_cmd->sea);
1857 scsi_ulto2b(count, scsi_cmd->count);
1858 scsi_ulto3b(dxfer_len, scsi_cmd->len);
1859 if (dvcid)
1860 scsi_cmd->flags |= READ_ELEMENT_STATUS_DVCID;
1861 if (curdata)
1862 scsi_cmd->flags |= READ_ELEMENT_STATUS_CURDATA;
1863
1864 if (voltag)
1865 scsi_cmd->byte2 |= READ_ELEMENT_STATUS_VOLTAG;
1866
1867 cam_fill_csio(csio,
1868 retries,
1869 cbfcnp,
1870 /*flags*/ CAM_DIR_IN,
1871 tag_action,
1872 data_ptr,
1873 dxfer_len,
1874 sense_len,
1875 sizeof(*scsi_cmd),
1876 timeout);
1877}
1878
1879void
1880scsi_initialize_element_status(struct ccb_scsiio *csio, u_int32_t retries,
1881 void (*cbfcnp)(struct cam_periph *, union ccb *),
1882 u_int8_t tag_action, u_int8_t sense_len,
1883 u_int32_t timeout)
1884{
1885 struct scsi_initialize_element_status *scsi_cmd;
1886
1887 scsi_cmd = (struct scsi_initialize_element_status *)
1888 &csio->cdb_io.cdb_bytes;
1889 bzero(scsi_cmd, sizeof(*scsi_cmd));
1890
1891 scsi_cmd->opcode = INITIALIZE_ELEMENT_STATUS;
1892
1893 cam_fill_csio(csio,
1894 retries,
1895 cbfcnp,
1896 /*flags*/ CAM_DIR_NONE,
1897 tag_action,
1898 /* data_ptr */ NULL,
1899 /* dxfer_len */ 0,
1900 sense_len,
1901 sizeof(*scsi_cmd),
1902 timeout);
1903}
1904
1905void
1906scsi_send_volume_tag(struct ccb_scsiio *csio, u_int32_t retries,
1907 void (*cbfcnp)(struct cam_periph *, union ccb *),
1908 u_int8_t tag_action,
1909 u_int16_t element_address,
1910 u_int8_t send_action_code,
1911 struct scsi_send_volume_tag_parameters *parameters,
1912 u_int8_t sense_len, u_int32_t timeout)
1913{
1914 struct scsi_send_volume_tag *scsi_cmd;
1915
1916 scsi_cmd = (struct scsi_send_volume_tag *) &csio->cdb_io.cdb_bytes;
1917 bzero(scsi_cmd, sizeof(*scsi_cmd));
1918
1919 scsi_cmd->opcode = SEND_VOLUME_TAG;
1920 scsi_ulto2b(element_address, scsi_cmd->ea);
1921 scsi_cmd->sac = send_action_code;
1922 scsi_ulto2b(sizeof(*parameters), scsi_cmd->pll);
1923
1924 cam_fill_csio(csio,
1925 retries,
1926 cbfcnp,
1927 /*flags*/ CAM_DIR_OUT,
1928 tag_action,
1929 /* data_ptr */ (u_int8_t *) parameters,
1930 sizeof(*parameters),
1931 sense_len,
1932 sizeof(*scsi_cmd),
1933 timeout);
1934}