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 293350 2016-01-07 20:22:55Z kib $");
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 struct make_dev_args args;
376 int error;
377
378 cgd = (struct ccb_getdev *)arg;
379 if (cgd == NULL) {
380 printf("chregister: no getdev CCB, can't register device\n");
381 return(CAM_REQ_CMP_ERR);
382 }
383
384 softc = (struct ch_softc *)malloc(sizeof(*softc),M_DEVBUF,M_NOWAIT);
385
386 if (softc == NULL) {
387 printf("chregister: Unable to probe new device. "
388 "Unable to allocate softc\n");
389 return(CAM_REQ_CMP_ERR);
390 }
391
392 bzero(softc, sizeof(*softc));
393 softc->state = CH_STATE_PROBE;
394 periph->softc = softc;
395 softc->quirks = CH_Q_NONE;
396
397 /*
398 * The DVCID and CURDATA bits were not introduced until the SMC
399 * spec. If this device claims SCSI-2 or earlier support, then it
400 * very likely does not support these bits.
401 */
402 if (cgd->inq_data.version <= SCSI_REV_2)
403 softc->quirks |= CH_Q_NO_DVCID;
404
405 bzero(&cpi, sizeof(cpi));
406 xpt_setup_ccb(&cpi.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
407 cpi.ccb_h.func_code = XPT_PATH_INQ;
408 xpt_action((union ccb *)&cpi);
409
410 /*
411 * Changers don't have a blocksize, and obviously don't support
412 * tagged queueing.
413 */
414 cam_periph_unlock(periph);
415 softc->device_stats = devstat_new_entry("ch",
416 periph->unit_number, 0,
417 DEVSTAT_NO_BLOCKSIZE | DEVSTAT_NO_ORDERED_TAGS,
418 SID_TYPE(&cgd->inq_data) |
419 XPORT_DEVSTAT_TYPE(cpi.transport),
420 DEVSTAT_PRIORITY_OTHER);
421
422 /*
423 * Acquire a reference to the periph before we create the devfs
424 * instance for it. We'll release this reference once the devfs
425 * instance has been freed.
426 */
427 if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
428 xpt_print(periph->path, "%s: lost periph during "
429 "registration!\n", __func__);
430 cam_periph_lock(periph);
431 return (CAM_REQ_CMP_ERR);
432 }
433
434
435 /* Register the device */
436 make_dev_args_init(&args);
437 args.mda_devsw = &ch_cdevsw;
438 args.mda_unit = periph->unit_number;
439 args.mda_uid = UID_ROOT;
440 args.mda_gid = GID_OPERATOR;
441 args.mda_mode = 0600;
442 args.mda_si_drv1 = periph;
443 error = make_dev_s(&args, &softc->dev, "%s%d", periph->periph_name,
444 periph->unit_number);
445 cam_periph_lock(periph);
446 if (error != 0) {
447 cam_periph_release_locked(periph);
448 return (CAM_REQ_CMP_ERR);
449 }
450
451 /*
452 * Add an async callback so that we get
453 * notified if this device goes away.
454 */
455 xpt_register_async(AC_LOST_DEVICE, chasync, periph, periph->path);
456
457 /*
458 * Lock this periph until we are setup.
459 * This first call can't block
460 */
461 (void)cam_periph_hold(periph, PRIBIO);
462 xpt_schedule(periph, CAM_PRIORITY_DEV);
463
464 return(CAM_REQ_CMP);
465}
466
467static int
468chopen(struct cdev *dev, int flags, int fmt, struct thread *td)
469{
470 struct cam_periph *periph;
471 struct ch_softc *softc;
472 int error;
473
474 periph = (struct cam_periph *)dev->si_drv1;
475 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
476 return (ENXIO);
477
478 softc = (struct ch_softc *)periph->softc;
479
480 cam_periph_lock(periph);
481
482 if (softc->flags & CH_FLAG_INVALID) {
483 cam_periph_release_locked(periph);
484 cam_periph_unlock(periph);
485 return(ENXIO);
486 }
487
488 if ((error = cam_periph_hold(periph, PRIBIO | PCATCH)) != 0) {
489 cam_periph_unlock(periph);
490 cam_periph_release(periph);
491 return (error);
492 }
493
494 /*
495 * Load information about this changer device into the softc.
496 */
497 if ((error = chgetparams(periph)) != 0) {
498 cam_periph_unhold(periph);
499 cam_periph_release_locked(periph);
500 cam_periph_unlock(periph);
501 return(error);
502 }
503
504 cam_periph_unhold(periph);
505
506 softc->open_count++;
507
508 cam_periph_unlock(periph);
509
510 return(error);
511}
512
513static int
514chclose(struct cdev *dev, int flag, int fmt, struct thread *td)
515{
516 struct cam_periph *periph;
517 struct ch_softc *softc;
518 struct mtx *mtx;
519
520 periph = (struct cam_periph *)dev->si_drv1;
521 mtx = cam_periph_mtx(periph);
522 mtx_lock(mtx);
523
524 softc = (struct ch_softc *)periph->softc;
525 softc->open_count--;
526
527 cam_periph_release_locked(periph);
528
529 /*
530 * We reference the lock directly here, instead of using
531 * cam_periph_unlock(). The reason is that the call to
532 * cam_periph_release_locked() above could result in the periph
533 * getting freed. If that is the case, dereferencing the periph
534 * with a cam_periph_unlock() call would cause a page fault.
535 *
536 * cam_periph_release() avoids this problem using the same method,
537 * but we're manually acquiring and dropping the lock here to
538 * protect the open count and avoid another lock acquisition and
539 * release.
540 */
541 mtx_unlock(mtx);
542
543 return(0);
544}
545
546static void
547chstart(struct cam_periph *periph, union ccb *start_ccb)
548{
549 struct ch_softc *softc;
550
551 softc = (struct ch_softc *)periph->softc;
552
553 switch (softc->state) {
554 case CH_STATE_NORMAL:
555 {
556 xpt_release_ccb(start_ccb);
557 break;
558 }
559 case CH_STATE_PROBE:
560 {
561 int mode_buffer_len;
562 void *mode_buffer;
563
564 /*
565 * Include the block descriptor when calculating the mode
566 * buffer length,
567 */
568 mode_buffer_len = sizeof(struct scsi_mode_header_6) +
569 sizeof(struct scsi_mode_blk_desc) +
570 sizeof(struct page_element_address_assignment);
571
572 mode_buffer = malloc(mode_buffer_len, M_SCSICH, M_NOWAIT);
573
574 if (mode_buffer == NULL) {
575 printf("chstart: couldn't malloc mode sense data\n");
576 break;
577 }
578 bzero(mode_buffer, mode_buffer_len);
579
580 /*
581 * Get the element address assignment page.
582 */
583 scsi_mode_sense(&start_ccb->csio,
584 /* retries */ 1,
585 /* cbfcnp */ chdone,
586 /* tag_action */ MSG_SIMPLE_Q_TAG,
587 /* dbd */ (softc->quirks & CH_Q_NO_DBD) ?
588 FALSE : TRUE,
589 /* page_code */ SMS_PAGE_CTRL_CURRENT,
590 /* page */ CH_ELEMENT_ADDR_ASSIGN_PAGE,
591 /* param_buf */ (u_int8_t *)mode_buffer,
592 /* param_len */ mode_buffer_len,
593 /* sense_len */ SSD_FULL_SIZE,
594 /* timeout */ CH_TIMEOUT_MODE_SENSE);
595
596 start_ccb->ccb_h.ccb_bp = NULL;
597 start_ccb->ccb_h.ccb_state = CH_CCB_PROBE;
598 xpt_action(start_ccb);
599 break;
600 }
601 }
602}
603
604static void
605chdone(struct cam_periph *periph, union ccb *done_ccb)
606{
607 struct ch_softc *softc;
608 struct ccb_scsiio *csio;
609
610 softc = (struct ch_softc *)periph->softc;
611 csio = &done_ccb->csio;
612
613 switch(done_ccb->ccb_h.ccb_state) {
614 case CH_CCB_PROBE:
615 {
616 struct scsi_mode_header_6 *mode_header;
617 struct page_element_address_assignment *ea;
618 char announce_buf[80];
619
620
621 mode_header = (struct scsi_mode_header_6 *)csio->data_ptr;
622
623 ea = (struct page_element_address_assignment *)
624 find_mode_page_6(mode_header);
625
626 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP){
627
628 softc->sc_firsts[CHET_MT] = scsi_2btoul(ea->mtea);
629 softc->sc_counts[CHET_MT] = scsi_2btoul(ea->nmte);
630 softc->sc_firsts[CHET_ST] = scsi_2btoul(ea->fsea);
631 softc->sc_counts[CHET_ST] = scsi_2btoul(ea->nse);
632 softc->sc_firsts[CHET_IE] = scsi_2btoul(ea->fieea);
633 softc->sc_counts[CHET_IE] = scsi_2btoul(ea->niee);
634 softc->sc_firsts[CHET_DT] = scsi_2btoul(ea->fdtea);
635 softc->sc_counts[CHET_DT] = scsi_2btoul(ea->ndte);
636 softc->sc_picker = softc->sc_firsts[CHET_MT];
637
638#define PLURAL(c) (c) == 1 ? "" : "s"
639 snprintf(announce_buf, sizeof(announce_buf),
640 "%d slot%s, %d drive%s, "
641 "%d picker%s, %d portal%s",
642 softc->sc_counts[CHET_ST],
643 PLURAL(softc->sc_counts[CHET_ST]),
644 softc->sc_counts[CHET_DT],
645 PLURAL(softc->sc_counts[CHET_DT]),
646 softc->sc_counts[CHET_MT],
647 PLURAL(softc->sc_counts[CHET_MT]),
648 softc->sc_counts[CHET_IE],
649 PLURAL(softc->sc_counts[CHET_IE]));
650#undef PLURAL
651 } else {
652 int error;
653
654 error = cherror(done_ccb, CAM_RETRY_SELTO,
655 SF_RETRY_UA | SF_NO_PRINT);
656 /*
657 * Retry any UNIT ATTENTION type errors. They
658 * are expected at boot.
659 */
660 if (error == ERESTART) {
661 /*
662 * A retry was scheuled, so
663 * just return.
664 */
665 return;
666 } else if (error != 0) {
667 struct scsi_mode_sense_6 *sms;
668 int frozen, retry_scheduled;
669
670 sms = (struct scsi_mode_sense_6 *)
671 done_ccb->csio.cdb_io.cdb_bytes;
672 frozen = (done_ccb->ccb_h.status &
673 CAM_DEV_QFRZN) != 0;
674
675 /*
676 * Check to see if block descriptors were
677 * disabled. Some devices don't like that.
678 * We're taking advantage of the fact that
679 * the first few bytes of the 6 and 10 byte
680 * mode sense commands are the same. If
681 * block descriptors were disabled, enable
682 * them and re-send the command.
683 */
684 if ((sms->byte2 & SMS_DBD) != 0 &&
685 (periph->flags & CAM_PERIPH_INVALID) == 0) {
686 sms->byte2 &= ~SMS_DBD;
687 xpt_action(done_ccb);
688 softc->quirks |= CH_Q_NO_DBD;
689 retry_scheduled = 1;
690 } else
691 retry_scheduled = 0;
692
693 /* Don't wedge this device's queue */
694 if (frozen)
695 cam_release_devq(done_ccb->ccb_h.path,
696 /*relsim_flags*/0,
697 /*reduction*/0,
698 /*timeout*/0,
699 /*getcount_only*/0);
700
701 if (retry_scheduled)
702 return;
703
704 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK)
705 == CAM_SCSI_STATUS_ERROR)
706 scsi_sense_print(&done_ccb->csio);
707 else {
708 xpt_print(periph->path,
709 "got CAM status %#x\n",
710 done_ccb->ccb_h.status);
711 }
712 xpt_print(periph->path, "fatal error, failed "
713 "to attach to device\n");
714
715 cam_periph_invalidate(periph);
716
717 announce_buf[0] = '\0';
718 }
719 }
720 if (announce_buf[0] != '\0') {
721 xpt_announce_periph(periph, announce_buf);
722 xpt_announce_quirks(periph, softc->quirks,
723 CH_Q_BIT_STRING);
724 }
725 softc->state = CH_STATE_NORMAL;
726 free(mode_header, M_SCSICH);
727 /*
728 * Since our peripheral may be invalidated by an error
729 * above or an external event, we must release our CCB
730 * before releasing the probe lock on the peripheral.
731 * The peripheral will only go away once the last lock
732 * is removed, and we need it around for the CCB release
733 * operation.
734 */
735 xpt_release_ccb(done_ccb);
736 cam_periph_unhold(periph);
737 return;
738 }
739 default:
740 break;
741 }
742 xpt_release_ccb(done_ccb);
743}
744
745static int
746cherror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
747{
748 struct ch_softc *softc;
749 struct cam_periph *periph;
750
751 periph = xpt_path_periph(ccb->ccb_h.path);
752 softc = (struct ch_softc *)periph->softc;
753
754 return (cam_periph_error(ccb, cam_flags, sense_flags,
755 &softc->saved_ccb));
756}
757
758static int
759chioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
760{
761 struct cam_periph *periph;
762 struct ch_softc *softc;
763 int error;
764
765 periph = (struct cam_periph *)dev->si_drv1;
766 cam_periph_lock(periph);
767 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering chioctl\n"));
768
769 softc = (struct ch_softc *)periph->softc;
770
771 error = 0;
772
773 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
774 ("trying to do ioctl %#lx\n", cmd));
775
776 /*
777 * If this command can change the device's state, we must
778 * have the device open for writing.
779 */
780 switch (cmd) {
781 case CHIOGPICKER:
782 case CHIOGPARAMS:
783 case OCHIOGSTATUS:
784 case CHIOGSTATUS:
785 break;
786
787 default:
788 if ((flag & FWRITE) == 0) {
789 cam_periph_unlock(periph);
790 return (EBADF);
791 }
792 }
793
794 switch (cmd) {
795 case CHIOMOVE:
796 error = chmove(periph, (struct changer_move *)addr);
797 break;
798
799 case CHIOEXCHANGE:
800 error = chexchange(periph, (struct changer_exchange *)addr);
801 break;
802
803 case CHIOPOSITION:
804 error = chposition(periph, (struct changer_position *)addr);
805 break;
806
807 case CHIOGPICKER:
808 *(int *)addr = softc->sc_picker - softc->sc_firsts[CHET_MT];
809 break;
810
811 case CHIOSPICKER:
812 {
813 int new_picker = *(int *)addr;
814
815 if (new_picker > (softc->sc_counts[CHET_MT] - 1)) {
816 error = EINVAL;
817 break;
818 }
819 softc->sc_picker = softc->sc_firsts[CHET_MT] + new_picker;
820 break;
821 }
822 case CHIOGPARAMS:
823 {
824 struct changer_params *cp = (struct changer_params *)addr;
825
826 cp->cp_npickers = softc->sc_counts[CHET_MT];
827 cp->cp_nslots = softc->sc_counts[CHET_ST];
828 cp->cp_nportals = softc->sc_counts[CHET_IE];
829 cp->cp_ndrives = softc->sc_counts[CHET_DT];
830 break;
831 }
832 case CHIOIELEM:
833 error = chielem(periph, *(unsigned int *)addr);
834 break;
835
836 case OCHIOGSTATUS:
837 {
838 error = chgetelemstatus(periph, SCSI_REV_2, cmd,
839 (struct changer_element_status_request *)addr);
840 break;
841 }
842
843 case CHIOGSTATUS:
844 {
845 int scsi_version;
846
847 scsi_version = chscsiversion(periph);
848 if (scsi_version >= SCSI_REV_0) {
849 error = chgetelemstatus(periph, scsi_version, cmd,
850 (struct changer_element_status_request *)addr);
851 }
852 else { /* unable to determine the SCSI version */
853 cam_periph_unlock(periph);
854 return (ENXIO);
855 }
856 break;
857 }
858
859 case CHIOSETVOLTAG:
860 {
861 error = chsetvoltag(periph,
862 (struct changer_set_voltag_request *) addr);
863 break;
864 }
865
866 /* Implement prevent/allow? */
867
868 default:
869 error = cam_periph_ioctl(periph, cmd, addr, cherror);
870 break;
871 }
872
873 cam_periph_unlock(periph);
874 return (error);
875}
876
877static int
878chmove(struct cam_periph *periph, struct changer_move *cm)
879{
880 struct ch_softc *softc;
881 u_int16_t fromelem, toelem;
882 union ccb *ccb;
883 int error;
884
885 error = 0;
886 softc = (struct ch_softc *)periph->softc;
887
888 /*
889 * Check arguments.
890 */
891 if ((cm->cm_fromtype > CHET_DT) || (cm->cm_totype > CHET_DT))
892 return (EINVAL);
893 if ((cm->cm_fromunit > (softc->sc_counts[cm->cm_fromtype] - 1)) ||
894 (cm->cm_tounit > (softc->sc_counts[cm->cm_totype] - 1)))
895 return (ENODEV);
896
897 /*
898 * Check the request against the changer's capabilities.
899 */
900 if ((softc->sc_movemask[cm->cm_fromtype] & (1 << cm->cm_totype)) == 0)
901 return (ENODEV);
902
903 /*
904 * Calculate the source and destination elements.
905 */
906 fromelem = softc->sc_firsts[cm->cm_fromtype] + cm->cm_fromunit;
907 toelem = softc->sc_firsts[cm->cm_totype] + cm->cm_tounit;
908
909 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
910
911 scsi_move_medium(&ccb->csio,
912 /* retries */ 1,
913 /* cbfcnp */ chdone,
914 /* tag_action */ MSG_SIMPLE_Q_TAG,
915 /* tea */ softc->sc_picker,
916 /* src */ fromelem,
917 /* dst */ toelem,
918 /* invert */ (cm->cm_flags & CM_INVERT) ? TRUE : FALSE,
919 /* sense_len */ SSD_FULL_SIZE,
920 /* timeout */ CH_TIMEOUT_MOVE_MEDIUM);
921
922 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/CAM_RETRY_SELTO,
923 /*sense_flags*/ SF_RETRY_UA,
924 softc->device_stats);
925
926 xpt_release_ccb(ccb);
927
928 return(error);
929}
930
931static int
932chexchange(struct cam_periph *periph, struct changer_exchange *ce)
933{
934 struct ch_softc *softc;
935 u_int16_t src, dst1, dst2;
936 union ccb *ccb;
937 int error;
938
939 error = 0;
940 softc = (struct ch_softc *)periph->softc;
941 /*
942 * Check arguments.
943 */
944 if ((ce->ce_srctype > CHET_DT) || (ce->ce_fdsttype > CHET_DT) ||
945 (ce->ce_sdsttype > CHET_DT))
946 return (EINVAL);
947 if ((ce->ce_srcunit > (softc->sc_counts[ce->ce_srctype] - 1)) ||
948 (ce->ce_fdstunit > (softc->sc_counts[ce->ce_fdsttype] - 1)) ||
949 (ce->ce_sdstunit > (softc->sc_counts[ce->ce_sdsttype] - 1)))
950 return (ENODEV);
951
952 /*
953 * Check the request against the changer's capabilities.
954 */
955 if (((softc->sc_exchangemask[ce->ce_srctype] &
956 (1 << ce->ce_fdsttype)) == 0) ||
957 ((softc->sc_exchangemask[ce->ce_fdsttype] &
958 (1 << ce->ce_sdsttype)) == 0))
959 return (ENODEV);
960
961 /*
962 * Calculate the source and destination elements.
963 */
964 src = softc->sc_firsts[ce->ce_srctype] + ce->ce_srcunit;
965 dst1 = softc->sc_firsts[ce->ce_fdsttype] + ce->ce_fdstunit;
966 dst2 = softc->sc_firsts[ce->ce_sdsttype] + ce->ce_sdstunit;
967
968 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
969
970 scsi_exchange_medium(&ccb->csio,
971 /* retries */ 1,
972 /* cbfcnp */ chdone,
973 /* tag_action */ MSG_SIMPLE_Q_TAG,
974 /* tea */ softc->sc_picker,
975 /* src */ src,
976 /* dst1 */ dst1,
977 /* dst2 */ dst2,
978 /* invert1 */ (ce->ce_flags & CE_INVERT1) ?
979 TRUE : FALSE,
980 /* invert2 */ (ce->ce_flags & CE_INVERT2) ?
981 TRUE : FALSE,
982 /* sense_len */ SSD_FULL_SIZE,
983 /* timeout */ CH_TIMEOUT_EXCHANGE_MEDIUM);
984
985 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/CAM_RETRY_SELTO,
986 /*sense_flags*/ SF_RETRY_UA,
987 softc->device_stats);
988
989 xpt_release_ccb(ccb);
990
991 return(error);
992}
993
994static int
995chposition(struct cam_periph *periph, struct changer_position *cp)
996{
997 struct ch_softc *softc;
998 u_int16_t dst;
999 union ccb *ccb;
1000 int error;
1001
1002 error = 0;
1003 softc = (struct ch_softc *)periph->softc;
1004
1005 /*
1006 * Check arguments.
1007 */
1008 if (cp->cp_type > CHET_DT)
1009 return (EINVAL);
1010 if (cp->cp_unit > (softc->sc_counts[cp->cp_type] - 1))
1011 return (ENODEV);
1012
1013 /*
1014 * Calculate the destination element.
1015 */
1016 dst = softc->sc_firsts[cp->cp_type] + cp->cp_unit;
1017
1018 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1019
1020 scsi_position_to_element(&ccb->csio,
1021 /* retries */ 1,
1022 /* cbfcnp */ chdone,
1023 /* tag_action */ MSG_SIMPLE_Q_TAG,
1024 /* tea */ softc->sc_picker,
1025 /* dst */ dst,
1026 /* invert */ (cp->cp_flags & CP_INVERT) ?
1027 TRUE : FALSE,
1028 /* sense_len */ SSD_FULL_SIZE,
1029 /* timeout */ CH_TIMEOUT_POSITION_TO_ELEMENT);
1030
1031 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1032 /*sense_flags*/ SF_RETRY_UA,
1033 softc->device_stats);
1034
1035 xpt_release_ccb(ccb);
1036
1037 return(error);
1038}
1039
1040/*
1041 * Copy a volume tag to a volume_tag struct, converting SCSI byte order
1042 * to host native byte order in the volume serial number. The volume
1043 * label as returned by the changer is transferred to user mode as
1044 * nul-terminated string. Volume labels are truncated at the first
1045 * space, as suggested by SCSI-2.
1046 */
1047static void
1048copy_voltag(struct changer_voltag *uvoltag, struct volume_tag *voltag)
1049{
1050 int i;
1051 for (i=0; i<CH_VOLTAG_MAXLEN; i++) {
1052 char c = voltag->vif[i];
1053 if (c && c != ' ')
1054 uvoltag->cv_volid[i] = c;
1055 else
1056 break;
1057 }
1058 uvoltag->cv_serial = scsi_2btoul(voltag->vsn);
1059}
1060
1061/*
1062 * Copy an element status descriptor to a user-mode
1063 * changer_element_status structure.
1064 */
1065static void
1066copy_element_status(struct ch_softc *softc,
1067 u_int16_t flags,
1068 struct read_element_status_descriptor *desc,
1069 struct changer_element_status *ces,
1070 int scsi_version)
1071{
1072 u_int16_t eaddr = scsi_2btoul(desc->eaddr);
1073 u_int16_t et;
1074 struct volume_tag *pvol_tag = NULL, *avol_tag = NULL;
1075 struct read_element_status_device_id *devid = NULL;
1076
1077 ces->ces_int_addr = eaddr;
1078 /* set up logical address in element status */
1079 for (et = CHET_MT; et <= CHET_DT; et++) {
1080 if ((softc->sc_firsts[et] <= eaddr)
1081 && ((softc->sc_firsts[et] + softc->sc_counts[et])
1082 > eaddr)) {
1083 ces->ces_addr = eaddr - softc->sc_firsts[et];
1084 ces->ces_type = et;
1085 break;
1086 }
1087 }
1088
1089 ces->ces_flags = desc->flags1;
1090
1091 ces->ces_sensecode = desc->sense_code;
1092 ces->ces_sensequal = desc->sense_qual;
1093
1094 if (desc->flags2 & READ_ELEMENT_STATUS_INVERT)
1095 ces->ces_flags |= CES_INVERT;
1096
1097 if (desc->flags2 & READ_ELEMENT_STATUS_SVALID) {
1098
1099 eaddr = scsi_2btoul(desc->ssea);
1100
1101 /* convert source address to logical format */
1102 for (et = CHET_MT; et <= CHET_DT; et++) {
1103 if ((softc->sc_firsts[et] <= eaddr)
1104 && ((softc->sc_firsts[et] + softc->sc_counts[et])
1105 > eaddr)) {
1106 ces->ces_source_addr =
1107 eaddr - softc->sc_firsts[et];
1108 ces->ces_source_type = et;
1109 ces->ces_flags |= CES_SOURCE_VALID;
1110 break;
1111 }
1112 }
1113
1114 if (!(ces->ces_flags & CES_SOURCE_VALID))
1115 printf("ch: warning: could not map element source "
1116 "address %ud to a valid element type\n",
1117 eaddr);
1118 }
1119
1120 /*
1121 * pvoltag and avoltag are common between SCSI-2 and later versions
1122 */
1123 if (flags & READ_ELEMENT_STATUS_PVOLTAG)
1124 pvol_tag = &desc->voltag_devid.pvoltag;
1125 if (flags & READ_ELEMENT_STATUS_AVOLTAG)
1126 avol_tag = (flags & READ_ELEMENT_STATUS_PVOLTAG) ?
1127 &desc->voltag_devid.voltag[1] :&desc->voltag_devid.pvoltag;
1128 /*
1129 * For SCSI-3 and later, element status can carry designator and
1130 * other information.
1131 */
1132 if (scsi_version >= SCSI_REV_SPC) {
1133 if ((flags & READ_ELEMENT_STATUS_PVOLTAG) ^
1134 (flags & READ_ELEMENT_STATUS_AVOLTAG))
1135 devid = &desc->voltag_devid.pvol_and_devid.devid;
1136 else if (!(flags & READ_ELEMENT_STATUS_PVOLTAG) &&
1137 !(flags & READ_ELEMENT_STATUS_AVOLTAG))
1138 devid = &desc->voltag_devid.devid;
1139 else /* Have both PVOLTAG and AVOLTAG */
1140 devid = &desc->voltag_devid.vol_tags_and_devid.devid;
1141 }
1142
1143 if (pvol_tag)
1144 copy_voltag(&(ces->ces_pvoltag), pvol_tag);
1145 if (avol_tag)
1146 copy_voltag(&(ces->ces_pvoltag), avol_tag);
1147 if (devid != NULL) {
1148 if (devid->designator_length > 0) {
1149 bcopy((void *)devid->designator,
1150 (void *)ces->ces_designator,
1151 devid->designator_length);
1152 ces->ces_designator_length = devid->designator_length;
1153 /*
1154 * Make sure we are always NUL terminated. The
1155 * This won't matter for the binary code set,
1156 * since the user will only pay attention to the
1157 * length field.
1158 */
1159 ces->ces_designator[devid->designator_length]= '\0';
1160 }
1161 if (devid->piv_assoc_designator_type &
1162 READ_ELEMENT_STATUS_PIV_SET) {
1163 ces->ces_flags |= CES_PIV;
1164 ces->ces_protocol_id =
1165 READ_ELEMENT_STATUS_PROTOCOL_ID(
1166 devid->prot_code_set);
1167 }
1168 ces->ces_code_set =
1169 READ_ELEMENT_STATUS_CODE_SET(devid->prot_code_set);
1170 ces->ces_assoc = READ_ELEMENT_STATUS_ASSOCIATION(
1171 devid->piv_assoc_designator_type);
1172 ces->ces_designator_type = READ_ELEMENT_STATUS_DESIGNATOR_TYPE(
1173 devid->piv_assoc_designator_type);
1174 } else if (scsi_version > SCSI_REV_2) {
1175 /* SCSI-SPC and No devid, no designator */
1176 ces->ces_designator_length = 0;
1177 ces->ces_designator[0] = '\0';
1178 ces->ces_protocol_id = CES_PROTOCOL_ID_FCP_4;
1179 }
1180
1181 if (scsi_version <= SCSI_REV_2) {
1182 if (desc->dt_or_obsolete.scsi_2.dt_scsi_flags &
1183 READ_ELEMENT_STATUS_DT_IDVALID) {
1184 ces->ces_flags |= CES_SCSIID_VALID;
1185 ces->ces_scsi_id =
1186 desc->dt_or_obsolete.scsi_2.dt_scsi_addr;
1187 }
1188
1189 if (desc->dt_or_obsolete.scsi_2.dt_scsi_addr &
1190 READ_ELEMENT_STATUS_DT_LUVALID) {
1191 ces->ces_flags |= CES_LUN_VALID;
1192 ces->ces_scsi_lun =
1193 desc->dt_or_obsolete.scsi_2.dt_scsi_flags &
1194 READ_ELEMENT_STATUS_DT_LUNMASK;
1195 }
1196 }
1197}
1198
1199static int
1200chgetelemstatus(struct cam_periph *periph, int scsi_version, u_long cmd,
1201 struct changer_element_status_request *cesr)
1202{
1203 struct read_element_status_header *st_hdr;
1204 struct read_element_status_page_header *pg_hdr;
1205 struct read_element_status_descriptor *desc;
1206 caddr_t data = NULL;
1207 size_t size, desclen;
1208 int avail, i, error = 0;
1209 int curdata, dvcid, sense_flags;
1210 int try_no_dvcid = 0;
1211 struct changer_element_status *user_data = NULL;
1212 struct ch_softc *softc;
1213 union ccb *ccb;
1214 int chet = cesr->cesr_element_type;
1215 int want_voltags = (cesr->cesr_flags & CESR_VOLTAGS) ? 1 : 0;
1216
1217 softc = (struct ch_softc *)periph->softc;
1218
1219 /* perform argument checking */
1220
1221 /*
1222 * Perform a range check on the cesr_element_{base,count}
1223 * request argument fields.
1224 */
1225 if ((softc->sc_counts[chet] - cesr->cesr_element_base) <= 0
1226 || (cesr->cesr_element_base + cesr->cesr_element_count)
1227 > softc->sc_counts[chet])
1228 return (EINVAL);
1229
1230 /*
1231 * Request one descriptor for the given element type. This
1232 * is used to determine the size of the descriptor so that
1233 * we can allocate enough storage for all of them. We assume
1234 * that the first one can fit into 1k.
1235 */
1236 cam_periph_unlock(periph);
1237 data = (caddr_t)malloc(1024, M_DEVBUF, M_WAITOK);
1238
1239 cam_periph_lock(periph);
1240 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1241
1242 sense_flags = SF_RETRY_UA;
1243 if (softc->quirks & CH_Q_NO_DVCID) {
1244 dvcid = 0;
1245 curdata = 0;
1246 } else {
1247 dvcid = 1;
1248 curdata = 1;
1249 /*
1250 * Don't print anything for an Illegal Request, because
1251 * these flags can cause some changers to complain. We'll
1252 * retry without them if we get an error.
1253 */
1254 sense_flags |= SF_QUIET_IR;
1255 }
1256
1257retry_einval:
1258
1259 scsi_read_element_status(&ccb->csio,
1260 /* retries */ 1,
1261 /* cbfcnp */ chdone,
1262 /* tag_action */ MSG_SIMPLE_Q_TAG,
1263 /* voltag */ want_voltags,
1264 /* sea */ softc->sc_firsts[chet],
1265 /* curdata */ curdata,
1266 /* dvcid */ dvcid,
1267 /* count */ 1,
1268 /* data_ptr */ data,
1269 /* dxfer_len */ 1024,
1270 /* sense_len */ SSD_FULL_SIZE,
1271 /* timeout */ CH_TIMEOUT_READ_ELEMENT_STATUS);
1272
1273 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1274 /*sense_flags*/ sense_flags,
1275 softc->device_stats);
1276
1277 /*
1278 * An Illegal Request sense key (only used if there is no asc/ascq)
1279 * or 0x24,0x00 for an ASC/ASCQ both map to EINVAL. If dvcid or
1280 * curdata are set (we set both or neither), try turning them off
1281 * and see if the command is successful.
1282 */
1283 if ((error == EINVAL)
1284 && (dvcid || curdata)) {
1285 dvcid = 0;
1286 curdata = 0;
1287 error = 0;
1288 /* At this point we want to report any Illegal Request */
1289 sense_flags &= ~SF_QUIET_IR;
1290 try_no_dvcid = 1;
1291 goto retry_einval;
1292 }
1293
1294 /*
1295 * In this case, we tried a read element status with dvcid and
1296 * curdata set, and it failed. We retried without those bits, and
1297 * it succeeded. Suggest to the user that he set a quirk, so we
1298 * don't go through the retry process the first time in the future.
1299 * This should only happen on changers that claim SCSI-3 or higher,
1300 * but don't support these bits.
1301 */
1302 if ((try_no_dvcid != 0)
1303 && (error == 0))
1304 softc->quirks |= CH_Q_NO_DVCID;
1305
1306 if (error)
1307 goto done;
1308 cam_periph_unlock(periph);
1309
1310 st_hdr = (struct read_element_status_header *)data;
1311 pg_hdr = (struct read_element_status_page_header *)((uintptr_t)st_hdr +
1312 sizeof(struct read_element_status_header));
1313 desclen = scsi_2btoul(pg_hdr->edl);
1314
1315 size = sizeof(struct read_element_status_header) +
1316 sizeof(struct read_element_status_page_header) +
1317 (desclen * cesr->cesr_element_count);
1318 /*
1319 * Reallocate storage for descriptors and get them from the
1320 * device.
1321 */
1322 free(data, M_DEVBUF);
1323 data = (caddr_t)malloc(size, M_DEVBUF, M_WAITOK);
1324
1325 cam_periph_lock(periph);
1326 scsi_read_element_status(&ccb->csio,
1327 /* retries */ 1,
1328 /* cbfcnp */ chdone,
1329 /* tag_action */ MSG_SIMPLE_Q_TAG,
1330 /* voltag */ want_voltags,
1331 /* sea */ softc->sc_firsts[chet]
1332 + cesr->cesr_element_base,
1333 /* curdata */ curdata,
1334 /* dvcid */ dvcid,
1335 /* count */ cesr->cesr_element_count,
1336 /* data_ptr */ data,
1337 /* dxfer_len */ size,
1338 /* sense_len */ SSD_FULL_SIZE,
1339 /* timeout */ CH_TIMEOUT_READ_ELEMENT_STATUS);
1340
1341 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1342 /*sense_flags*/ SF_RETRY_UA,
1343 softc->device_stats);
1344
1345 if (error)
1346 goto done;
1347 cam_periph_unlock(periph);
1348
1349 /*
1350 * Fill in the user status array.
1351 */
1352 st_hdr = (struct read_element_status_header *)data;
1353 pg_hdr = (struct read_element_status_page_header *)((uintptr_t)st_hdr +
1354 sizeof(struct read_element_status_header));
1355 avail = scsi_2btoul(st_hdr->count);
1356
1357 if (avail != cesr->cesr_element_count) {
1358 xpt_print(periph->path,
1359 "warning, READ ELEMENT STATUS avail != count\n");
1360 }
1361
1362 user_data = (struct changer_element_status *)
1363 malloc(avail * sizeof(struct changer_element_status),
1364 M_DEVBUF, M_WAITOK | M_ZERO);
1365
1366 desc = (struct read_element_status_descriptor *)((uintptr_t)data +
1367 sizeof(struct read_element_status_header) +
1368 sizeof(struct read_element_status_page_header));
1369 /*
1370 * Set up the individual element status structures
1371 */
1372 for (i = 0; i < avail; ++i) {
1373 struct changer_element_status *ces;
1374
1375 /*
1376 * In the changer_element_status structure, fields from
1377 * the beginning to the field of ces_scsi_lun are common
1378 * between SCSI-2 and SCSI-3, while all the rest are new
1379 * from SCSI-3. In order to maintain backward compatibility
1380 * of the chio command, the ces pointer, below, is computed
1381 * such that it lines up with the structure boundary
1382 * corresponding to the SCSI version.
1383 */
1384 ces = cmd == OCHIOGSTATUS ?
1385 (struct changer_element_status *)
1386 ((unsigned char *)user_data + i *
1387 (offsetof(struct changer_element_status,ces_scsi_lun)+1)):
1388 &user_data[i];
1389
1390 copy_element_status(softc, pg_hdr->flags, desc,
1391 ces, scsi_version);
1392
1393 desc = (struct read_element_status_descriptor *)
1394 ((unsigned char *)desc + desclen);
1395 }
1396
1397 /* Copy element status structures out to userspace. */
1398 if (cmd == OCHIOGSTATUS)
1399 error = copyout(user_data,
1400 cesr->cesr_element_status,
1401 avail* (offsetof(struct changer_element_status,
1402 ces_scsi_lun) + 1));
1403 else
1404 error = copyout(user_data,
1405 cesr->cesr_element_status,
1406 avail * sizeof(struct changer_element_status));
1407
1408 cam_periph_lock(periph);
1409
1410 done:
1411 xpt_release_ccb(ccb);
1412
1413 if (data != NULL)
1414 free(data, M_DEVBUF);
1415 if (user_data != NULL)
1416 free(user_data, M_DEVBUF);
1417
1418 return (error);
1419}
1420
1421static int
1422chielem(struct cam_periph *periph,
1423 unsigned int timeout)
1424{
1425 union ccb *ccb;
1426 struct ch_softc *softc;
1427 int error;
1428
1429 if (!timeout) {
1430 timeout = CH_TIMEOUT_INITIALIZE_ELEMENT_STATUS;
1431 } else {
1432 timeout *= 1000;
1433 }
1434
1435 error = 0;
1436 softc = (struct ch_softc *)periph->softc;
1437
1438 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1439
1440 scsi_initialize_element_status(&ccb->csio,
1441 /* retries */ 1,
1442 /* cbfcnp */ chdone,
1443 /* tag_action */ MSG_SIMPLE_Q_TAG,
1444 /* sense_len */ SSD_FULL_SIZE,
1445 /* timeout */ timeout);
1446
1447 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1448 /*sense_flags*/ SF_RETRY_UA,
1449 softc->device_stats);
1450
1451 xpt_release_ccb(ccb);
1452
1453 return(error);
1454}
1455
1456static int
1457chsetvoltag(struct cam_periph *periph,
1458 struct changer_set_voltag_request *csvr)
1459{
1460 union ccb *ccb;
1461 struct ch_softc *softc;
1462 u_int16_t ea;
1463 u_int8_t sac;
1464 struct scsi_send_volume_tag_parameters ssvtp;
1465 int error;
1466 int i;
1467
1468 error = 0;
1469 softc = (struct ch_softc *)periph->softc;
1470
1471 bzero(&ssvtp, sizeof(ssvtp));
1472 for (i=0; i<sizeof(ssvtp.vitf); i++) {
1473 ssvtp.vitf[i] = ' ';
1474 }
1475
1476 /*
1477 * Check arguments.
1478 */
1479 if (csvr->csvr_type > CHET_DT)
1480 return EINVAL;
1481 if (csvr->csvr_addr > (softc->sc_counts[csvr->csvr_type] - 1))
1482 return ENODEV;
1483
1484 ea = softc->sc_firsts[csvr->csvr_type] + csvr->csvr_addr;
1485
1486 if (csvr->csvr_flags & CSVR_ALTERNATE) {
1487 switch (csvr->csvr_flags & CSVR_MODE_MASK) {
1488 case CSVR_MODE_SET:
1489 sac = SEND_VOLUME_TAG_ASSERT_ALTERNATE;
1490 break;
1491 case CSVR_MODE_REPLACE:
1492 sac = SEND_VOLUME_TAG_REPLACE_ALTERNATE;
1493 break;
1494 case CSVR_MODE_CLEAR:
1495 sac = SEND_VOLUME_TAG_UNDEFINED_ALTERNATE;
1496 break;
1497 default:
1498 error = EINVAL;
1499 goto out;
1500 }
1501 } else {
1502 switch (csvr->csvr_flags & CSVR_MODE_MASK) {
1503 case CSVR_MODE_SET:
1504 sac = SEND_VOLUME_TAG_ASSERT_PRIMARY;
1505 break;
1506 case CSVR_MODE_REPLACE:
1507 sac = SEND_VOLUME_TAG_REPLACE_PRIMARY;
1508 break;
1509 case CSVR_MODE_CLEAR:
1510 sac = SEND_VOLUME_TAG_UNDEFINED_PRIMARY;
1511 break;
1512 default:
1513 error = EINVAL;
1514 goto out;
1515 }
1516 }
1517
1518 memcpy(ssvtp.vitf, csvr->csvr_voltag.cv_volid,
1519 min(strlen(csvr->csvr_voltag.cv_volid), sizeof(ssvtp.vitf)));
1520 scsi_ulto2b(csvr->csvr_voltag.cv_serial, ssvtp.minvsn);
1521
1522 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1523
1524 scsi_send_volume_tag(&ccb->csio,
1525 /* retries */ 1,
1526 /* cbfcnp */ chdone,
1527 /* tag_action */ MSG_SIMPLE_Q_TAG,
1528 /* element_address */ ea,
1529 /* send_action_code */ sac,
1530 /* parameters */ &ssvtp,
1531 /* sense_len */ SSD_FULL_SIZE,
1532 /* timeout */ CH_TIMEOUT_SEND_VOLTAG);
1533
1534 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1535 /*sense_flags*/ SF_RETRY_UA,
1536 softc->device_stats);
1537
1538 xpt_release_ccb(ccb);
1539
1540 out:
1541 return error;
1542}
1543
1544static int
1545chgetparams(struct cam_periph *periph)
1546{
1547 union ccb *ccb;
1548 struct ch_softc *softc;
1549 void *mode_buffer;
1550 int mode_buffer_len;
1551 struct page_element_address_assignment *ea;
1552 struct page_device_capabilities *cap;
1553 int error, from, dbd;
1554 u_int8_t *moves, *exchanges;
1555
1556 error = 0;
1557
1558 softc = (struct ch_softc *)periph->softc;
1559
1560 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1561
1562 /*
1563 * The scsi_mode_sense_data structure is just a convenience
1564 * structure that allows us to easily calculate the worst-case
1565 * storage size of the mode sense buffer.
1566 */
1567 mode_buffer_len = sizeof(struct scsi_mode_sense_data);
1568
1569 mode_buffer = malloc(mode_buffer_len, M_SCSICH, M_NOWAIT);
1570
1571 if (mode_buffer == NULL) {
1572 printf("chgetparams: couldn't malloc mode sense data\n");
1573 return(ENOSPC);
1574 }
1575
1576 bzero(mode_buffer, mode_buffer_len);
1577
1578 if (softc->quirks & CH_Q_NO_DBD)
1579 dbd = FALSE;
1580 else
1581 dbd = TRUE;
1582
1583 /*
1584 * Get the element address assignment page.
1585 */
1586 scsi_mode_sense(&ccb->csio,
1587 /* retries */ 1,
1588 /* cbfcnp */ chdone,
1589 /* tag_action */ MSG_SIMPLE_Q_TAG,
1590 /* dbd */ dbd,
1591 /* page_code */ SMS_PAGE_CTRL_CURRENT,
1592 /* page */ CH_ELEMENT_ADDR_ASSIGN_PAGE,
1593 /* param_buf */ (u_int8_t *)mode_buffer,
1594 /* param_len */ mode_buffer_len,
1595 /* sense_len */ SSD_FULL_SIZE,
1596 /* timeout */ CH_TIMEOUT_MODE_SENSE);
1597
1598 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1599 /* sense_flags */ SF_RETRY_UA|SF_NO_PRINT,
1600 softc->device_stats);
1601
1602 if (error) {
1603 if (dbd) {
1604 struct scsi_mode_sense_6 *sms;
1605
1606 sms = (struct scsi_mode_sense_6 *)
1607 ccb->csio.cdb_io.cdb_bytes;
1608
1609 sms->byte2 &= ~SMS_DBD;
1610 error = cam_periph_runccb(ccb, cherror,
1611 /*cam_flags*/ CAM_RETRY_SELTO,
1612 /*sense_flags*/ SF_RETRY_UA,
1613 softc->device_stats);
1614 } else {
1615 /*
1616 * Since we disabled sense printing above, print
1617 * out the sense here since we got an error.
1618 */
1619 scsi_sense_print(&ccb->csio);
1620 }
1621
1622 if (error) {
1623 xpt_print(periph->path,
1624 "chgetparams: error getting element "
1625 "address page\n");
1626 xpt_release_ccb(ccb);
1627 free(mode_buffer, M_SCSICH);
1628 return(error);
1629 }
1630 }
1631
1632 ea = (struct page_element_address_assignment *)
1633 find_mode_page_6((struct scsi_mode_header_6 *)mode_buffer);
1634
1635 softc->sc_firsts[CHET_MT] = scsi_2btoul(ea->mtea);
1636 softc->sc_counts[CHET_MT] = scsi_2btoul(ea->nmte);
1637 softc->sc_firsts[CHET_ST] = scsi_2btoul(ea->fsea);
1638 softc->sc_counts[CHET_ST] = scsi_2btoul(ea->nse);
1639 softc->sc_firsts[CHET_IE] = scsi_2btoul(ea->fieea);
1640 softc->sc_counts[CHET_IE] = scsi_2btoul(ea->niee);
1641 softc->sc_firsts[CHET_DT] = scsi_2btoul(ea->fdtea);
1642 softc->sc_counts[CHET_DT] = scsi_2btoul(ea->ndte);
1643
1644 bzero(mode_buffer, mode_buffer_len);
1645
1646 /*
1647 * Now get the device capabilities page.
1648 */
1649 scsi_mode_sense(&ccb->csio,
1650 /* retries */ 1,
1651 /* cbfcnp */ chdone,
1652 /* tag_action */ MSG_SIMPLE_Q_TAG,
1653 /* dbd */ dbd,
1654 /* page_code */ SMS_PAGE_CTRL_CURRENT,
1655 /* page */ CH_DEVICE_CAP_PAGE,
1656 /* param_buf */ (u_int8_t *)mode_buffer,
1657 /* param_len */ mode_buffer_len,
1658 /* sense_len */ SSD_FULL_SIZE,
1659 /* timeout */ CH_TIMEOUT_MODE_SENSE);
1660
1661 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1662 /* sense_flags */ SF_RETRY_UA | SF_NO_PRINT,
1663 softc->device_stats);
1664
1665 if (error) {
1666 if (dbd) {
1667 struct scsi_mode_sense_6 *sms;
1668
1669 sms = (struct scsi_mode_sense_6 *)
1670 ccb->csio.cdb_io.cdb_bytes;
1671
1672 sms->byte2 &= ~SMS_DBD;
1673 error = cam_periph_runccb(ccb, cherror,
1674 /*cam_flags*/ CAM_RETRY_SELTO,
1675 /*sense_flags*/ SF_RETRY_UA,
1676 softc->device_stats);
1677 } else {
1678 /*
1679 * Since we disabled sense printing above, print
1680 * out the sense here since we got an error.
1681 */
1682 scsi_sense_print(&ccb->csio);
1683 }
1684
1685 if (error) {
1686 xpt_print(periph->path,
1687 "chgetparams: error getting device "
1688 "capabilities page\n");
1689 xpt_release_ccb(ccb);
1690 free(mode_buffer, M_SCSICH);
1691 return(error);
1692 }
1693 }
1694
1695 xpt_release_ccb(ccb);
1696
1697 cap = (struct page_device_capabilities *)
1698 find_mode_page_6((struct scsi_mode_header_6 *)mode_buffer);
1699
1700 bzero(softc->sc_movemask, sizeof(softc->sc_movemask));
1701 bzero(softc->sc_exchangemask, sizeof(softc->sc_exchangemask));
1702 moves = cap->move_from;
1703 exchanges = cap->exchange_with;
1704 for (from = CHET_MT; from <= CHET_MAX; ++from) {
1705 softc->sc_movemask[from] = moves[from];
1706 softc->sc_exchangemask[from] = exchanges[from];
1707 }
1708
1709 free(mode_buffer, M_SCSICH);
1710
1711 return(error);
1712}
1713
1714static int
1715chscsiversion(struct cam_periph *periph)
1716{
1717 struct scsi_inquiry_data *inq_data;
1718 struct ccb_getdev *cgd;
1719 int dev_scsi_version;
1720
1721 cam_periph_assert(periph, MA_OWNED);
1722 if ((cgd = (struct ccb_getdev *)xpt_alloc_ccb_nowait()) == NULL)
1723 return (-1);
1724 /*
1725 * Get the device information.
1726 */
1727 xpt_setup_ccb(&cgd->ccb_h,
1728 periph->path,
1729 CAM_PRIORITY_NORMAL);
1730 cgd->ccb_h.func_code = XPT_GDEV_TYPE;
1731 xpt_action((union ccb *)cgd);
1732
1733 if (cgd->ccb_h.status != CAM_REQ_CMP) {
1734 xpt_free_ccb((union ccb *)cgd);
1735 return -1;
1736 }
1737
1738 inq_data = &cgd->inq_data;
1739 dev_scsi_version = inq_data->version;
1740 xpt_free_ccb((union ccb *)cgd);
1741
1742 return dev_scsi_version;
1743}
1744
1745void
1746scsi_move_medium(struct ccb_scsiio *csio, u_int32_t retries,
1747 void (*cbfcnp)(struct cam_periph *, union ccb *),
1748 u_int8_t tag_action, u_int32_t tea, u_int32_t src,
1749 u_int32_t dst, int invert, u_int8_t sense_len,
1750 u_int32_t timeout)
1751{
1752 struct scsi_move_medium *scsi_cmd;
1753
1754 scsi_cmd = (struct scsi_move_medium *)&csio->cdb_io.cdb_bytes;
1755 bzero(scsi_cmd, sizeof(*scsi_cmd));
1756
1757 scsi_cmd->opcode = MOVE_MEDIUM;
1758
1759 scsi_ulto2b(tea, scsi_cmd->tea);
1760 scsi_ulto2b(src, scsi_cmd->src);
1761 scsi_ulto2b(dst, scsi_cmd->dst);
1762
1763 if (invert)
1764 scsi_cmd->invert |= MOVE_MEDIUM_INVERT;
1765
1766 cam_fill_csio(csio,
1767 retries,
1768 cbfcnp,
1769 /*flags*/ CAM_DIR_NONE,
1770 tag_action,
1771 /*data_ptr*/ NULL,
1772 /*dxfer_len*/ 0,
1773 sense_len,
1774 sizeof(*scsi_cmd),
1775 timeout);
1776}
1777
1778void
1779scsi_exchange_medium(struct ccb_scsiio *csio, u_int32_t retries,
1780 void (*cbfcnp)(struct cam_periph *, union ccb *),
1781 u_int8_t tag_action, u_int32_t tea, u_int32_t src,
1782 u_int32_t dst1, u_int32_t dst2, int invert1,
1783 int invert2, u_int8_t sense_len, u_int32_t timeout)
1784{
1785 struct scsi_exchange_medium *scsi_cmd;
1786
1787 scsi_cmd = (struct scsi_exchange_medium *)&csio->cdb_io.cdb_bytes;
1788 bzero(scsi_cmd, sizeof(*scsi_cmd));
1789
1790 scsi_cmd->opcode = EXCHANGE_MEDIUM;
1791
1792 scsi_ulto2b(tea, scsi_cmd->tea);
1793 scsi_ulto2b(src, scsi_cmd->src);
1794 scsi_ulto2b(dst1, scsi_cmd->fdst);
1795 scsi_ulto2b(dst2, scsi_cmd->sdst);
1796
1797 if (invert1)
1798 scsi_cmd->invert |= EXCHANGE_MEDIUM_INV1;
1799
1800 if (invert2)
1801 scsi_cmd->invert |= EXCHANGE_MEDIUM_INV2;
1802
1803 cam_fill_csio(csio,
1804 retries,
1805 cbfcnp,
1806 /*flags*/ CAM_DIR_NONE,
1807 tag_action,
1808 /*data_ptr*/ NULL,
1809 /*dxfer_len*/ 0,
1810 sense_len,
1811 sizeof(*scsi_cmd),
1812 timeout);
1813}
1814
1815void
1816scsi_position_to_element(struct ccb_scsiio *csio, u_int32_t retries,
1817 void (*cbfcnp)(struct cam_periph *, union ccb *),
1818 u_int8_t tag_action, u_int32_t tea, u_int32_t dst,
1819 int invert, u_int8_t sense_len, u_int32_t timeout)
1820{
1821 struct scsi_position_to_element *scsi_cmd;
1822
1823 scsi_cmd = (struct scsi_position_to_element *)&csio->cdb_io.cdb_bytes;
1824 bzero(scsi_cmd, sizeof(*scsi_cmd));
1825
1826 scsi_cmd->opcode = POSITION_TO_ELEMENT;
1827
1828 scsi_ulto2b(tea, scsi_cmd->tea);
1829 scsi_ulto2b(dst, scsi_cmd->dst);
1830
1831 if (invert)
1832 scsi_cmd->invert |= POSITION_TO_ELEMENT_INVERT;
1833
1834 cam_fill_csio(csio,
1835 retries,
1836 cbfcnp,
1837 /*flags*/ CAM_DIR_NONE,
1838 tag_action,
1839 /*data_ptr*/ NULL,
1840 /*dxfer_len*/ 0,
1841 sense_len,
1842 sizeof(*scsi_cmd),
1843 timeout);
1844}
1845
1846void
1847scsi_read_element_status(struct ccb_scsiio *csio, u_int32_t retries,
1848 void (*cbfcnp)(struct cam_periph *, union ccb *),
1849 u_int8_t tag_action, int voltag, u_int32_t sea,
1850 int curdata, int dvcid,
1851 u_int32_t count, u_int8_t *data_ptr,
1852 u_int32_t dxfer_len, u_int8_t sense_len,
1853 u_int32_t timeout)
1854{
1855 struct scsi_read_element_status *scsi_cmd;
1856
1857 scsi_cmd = (struct scsi_read_element_status *)&csio->cdb_io.cdb_bytes;
1858 bzero(scsi_cmd, sizeof(*scsi_cmd));
1859
1860 scsi_cmd->opcode = READ_ELEMENT_STATUS;
1861
1862 scsi_ulto2b(sea, scsi_cmd->sea);
1863 scsi_ulto2b(count, scsi_cmd->count);
1864 scsi_ulto3b(dxfer_len, scsi_cmd->len);
1865 if (dvcid)
1866 scsi_cmd->flags |= READ_ELEMENT_STATUS_DVCID;
1867 if (curdata)
1868 scsi_cmd->flags |= READ_ELEMENT_STATUS_CURDATA;
1869
1870 if (voltag)
1871 scsi_cmd->byte2 |= READ_ELEMENT_STATUS_VOLTAG;
1872
1873 cam_fill_csio(csio,
1874 retries,
1875 cbfcnp,
1876 /*flags*/ CAM_DIR_IN,
1877 tag_action,
1878 data_ptr,
1879 dxfer_len,
1880 sense_len,
1881 sizeof(*scsi_cmd),
1882 timeout);
1883}
1884
1885void
1886scsi_initialize_element_status(struct ccb_scsiio *csio, u_int32_t retries,
1887 void (*cbfcnp)(struct cam_periph *, union ccb *),
1888 u_int8_t tag_action, u_int8_t sense_len,
1889 u_int32_t timeout)
1890{
1891 struct scsi_initialize_element_status *scsi_cmd;
1892
1893 scsi_cmd = (struct scsi_initialize_element_status *)
1894 &csio->cdb_io.cdb_bytes;
1895 bzero(scsi_cmd, sizeof(*scsi_cmd));
1896
1897 scsi_cmd->opcode = INITIALIZE_ELEMENT_STATUS;
1898
1899 cam_fill_csio(csio,
1900 retries,
1901 cbfcnp,
1902 /*flags*/ CAM_DIR_NONE,
1903 tag_action,
1904 /* data_ptr */ NULL,
1905 /* dxfer_len */ 0,
1906 sense_len,
1907 sizeof(*scsi_cmd),
1908 timeout);
1909}
1910
1911void
1912scsi_send_volume_tag(struct ccb_scsiio *csio, u_int32_t retries,
1913 void (*cbfcnp)(struct cam_periph *, union ccb *),
1914 u_int8_t tag_action,
1915 u_int16_t element_address,
1916 u_int8_t send_action_code,
1917 struct scsi_send_volume_tag_parameters *parameters,
1918 u_int8_t sense_len, u_int32_t timeout)
1919{
1920 struct scsi_send_volume_tag *scsi_cmd;
1921
1922 scsi_cmd = (struct scsi_send_volume_tag *) &csio->cdb_io.cdb_bytes;
1923 bzero(scsi_cmd, sizeof(*scsi_cmd));
1924
1925 scsi_cmd->opcode = SEND_VOLUME_TAG;
1926 scsi_ulto2b(element_address, scsi_cmd->ea);
1927 scsi_cmd->sac = send_action_code;
1928 scsi_ulto2b(sizeof(*parameters), scsi_cmd->pll);
1929
1930 cam_fill_csio(csio,
1931 retries,
1932 cbfcnp,
1933 /*flags*/ CAM_DIR_OUT,
1934 tag_action,
1935 /* data_ptr */ (u_int8_t *) parameters,
1936 sizeof(*parameters),
1937 sense_len,
1938 sizeof(*scsi_cmd),
1939 timeout);
1940}
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 293350 2016-01-07 20:22:55Z kib $");
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 struct make_dev_args args;
376 int error;
377
378 cgd = (struct ccb_getdev *)arg;
379 if (cgd == NULL) {
380 printf("chregister: no getdev CCB, can't register device\n");
381 return(CAM_REQ_CMP_ERR);
382 }
383
384 softc = (struct ch_softc *)malloc(sizeof(*softc),M_DEVBUF,M_NOWAIT);
385
386 if (softc == NULL) {
387 printf("chregister: Unable to probe new device. "
388 "Unable to allocate softc\n");
389 return(CAM_REQ_CMP_ERR);
390 }
391
392 bzero(softc, sizeof(*softc));
393 softc->state = CH_STATE_PROBE;
394 periph->softc = softc;
395 softc->quirks = CH_Q_NONE;
396
397 /*
398 * The DVCID and CURDATA bits were not introduced until the SMC
399 * spec. If this device claims SCSI-2 or earlier support, then it
400 * very likely does not support these bits.
401 */
402 if (cgd->inq_data.version <= SCSI_REV_2)
403 softc->quirks |= CH_Q_NO_DVCID;
404
405 bzero(&cpi, sizeof(cpi));
406 xpt_setup_ccb(&cpi.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
407 cpi.ccb_h.func_code = XPT_PATH_INQ;
408 xpt_action((union ccb *)&cpi);
409
410 /*
411 * Changers don't have a blocksize, and obviously don't support
412 * tagged queueing.
413 */
414 cam_periph_unlock(periph);
415 softc->device_stats = devstat_new_entry("ch",
416 periph->unit_number, 0,
417 DEVSTAT_NO_BLOCKSIZE | DEVSTAT_NO_ORDERED_TAGS,
418 SID_TYPE(&cgd->inq_data) |
419 XPORT_DEVSTAT_TYPE(cpi.transport),
420 DEVSTAT_PRIORITY_OTHER);
421
422 /*
423 * Acquire a reference to the periph before we create the devfs
424 * instance for it. We'll release this reference once the devfs
425 * instance has been freed.
426 */
427 if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
428 xpt_print(periph->path, "%s: lost periph during "
429 "registration!\n", __func__);
430 cam_periph_lock(periph);
431 return (CAM_REQ_CMP_ERR);
432 }
433
434
435 /* Register the device */
436 make_dev_args_init(&args);
437 args.mda_devsw = &ch_cdevsw;
438 args.mda_unit = periph->unit_number;
439 args.mda_uid = UID_ROOT;
440 args.mda_gid = GID_OPERATOR;
441 args.mda_mode = 0600;
442 args.mda_si_drv1 = periph;
443 error = make_dev_s(&args, &softc->dev, "%s%d", periph->periph_name,
444 periph->unit_number);
445 cam_periph_lock(periph);
446 if (error != 0) {
447 cam_periph_release_locked(periph);
448 return (CAM_REQ_CMP_ERR);
449 }
450
451 /*
452 * Add an async callback so that we get
453 * notified if this device goes away.
454 */
455 xpt_register_async(AC_LOST_DEVICE, chasync, periph, periph->path);
456
457 /*
458 * Lock this periph until we are setup.
459 * This first call can't block
460 */
461 (void)cam_periph_hold(periph, PRIBIO);
462 xpt_schedule(periph, CAM_PRIORITY_DEV);
463
464 return(CAM_REQ_CMP);
465}
466
467static int
468chopen(struct cdev *dev, int flags, int fmt, struct thread *td)
469{
470 struct cam_periph *periph;
471 struct ch_softc *softc;
472 int error;
473
474 periph = (struct cam_periph *)dev->si_drv1;
475 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
476 return (ENXIO);
477
478 softc = (struct ch_softc *)periph->softc;
479
480 cam_periph_lock(periph);
481
482 if (softc->flags & CH_FLAG_INVALID) {
483 cam_periph_release_locked(periph);
484 cam_periph_unlock(periph);
485 return(ENXIO);
486 }
487
488 if ((error = cam_periph_hold(periph, PRIBIO | PCATCH)) != 0) {
489 cam_periph_unlock(periph);
490 cam_periph_release(periph);
491 return (error);
492 }
493
494 /*
495 * Load information about this changer device into the softc.
496 */
497 if ((error = chgetparams(periph)) != 0) {
498 cam_periph_unhold(periph);
499 cam_periph_release_locked(periph);
500 cam_periph_unlock(periph);
501 return(error);
502 }
503
504 cam_periph_unhold(periph);
505
506 softc->open_count++;
507
508 cam_periph_unlock(periph);
509
510 return(error);
511}
512
513static int
514chclose(struct cdev *dev, int flag, int fmt, struct thread *td)
515{
516 struct cam_periph *periph;
517 struct ch_softc *softc;
518 struct mtx *mtx;
519
520 periph = (struct cam_periph *)dev->si_drv1;
521 mtx = cam_periph_mtx(periph);
522 mtx_lock(mtx);
523
524 softc = (struct ch_softc *)periph->softc;
525 softc->open_count--;
526
527 cam_periph_release_locked(periph);
528
529 /*
530 * We reference the lock directly here, instead of using
531 * cam_periph_unlock(). The reason is that the call to
532 * cam_periph_release_locked() above could result in the periph
533 * getting freed. If that is the case, dereferencing the periph
534 * with a cam_periph_unlock() call would cause a page fault.
535 *
536 * cam_periph_release() avoids this problem using the same method,
537 * but we're manually acquiring and dropping the lock here to
538 * protect the open count and avoid another lock acquisition and
539 * release.
540 */
541 mtx_unlock(mtx);
542
543 return(0);
544}
545
546static void
547chstart(struct cam_periph *periph, union ccb *start_ccb)
548{
549 struct ch_softc *softc;
550
551 softc = (struct ch_softc *)periph->softc;
552
553 switch (softc->state) {
554 case CH_STATE_NORMAL:
555 {
556 xpt_release_ccb(start_ccb);
557 break;
558 }
559 case CH_STATE_PROBE:
560 {
561 int mode_buffer_len;
562 void *mode_buffer;
563
564 /*
565 * Include the block descriptor when calculating the mode
566 * buffer length,
567 */
568 mode_buffer_len = sizeof(struct scsi_mode_header_6) +
569 sizeof(struct scsi_mode_blk_desc) +
570 sizeof(struct page_element_address_assignment);
571
572 mode_buffer = malloc(mode_buffer_len, M_SCSICH, M_NOWAIT);
573
574 if (mode_buffer == NULL) {
575 printf("chstart: couldn't malloc mode sense data\n");
576 break;
577 }
578 bzero(mode_buffer, mode_buffer_len);
579
580 /*
581 * Get the element address assignment page.
582 */
583 scsi_mode_sense(&start_ccb->csio,
584 /* retries */ 1,
585 /* cbfcnp */ chdone,
586 /* tag_action */ MSG_SIMPLE_Q_TAG,
587 /* dbd */ (softc->quirks & CH_Q_NO_DBD) ?
588 FALSE : TRUE,
589 /* page_code */ SMS_PAGE_CTRL_CURRENT,
590 /* page */ CH_ELEMENT_ADDR_ASSIGN_PAGE,
591 /* param_buf */ (u_int8_t *)mode_buffer,
592 /* param_len */ mode_buffer_len,
593 /* sense_len */ SSD_FULL_SIZE,
594 /* timeout */ CH_TIMEOUT_MODE_SENSE);
595
596 start_ccb->ccb_h.ccb_bp = NULL;
597 start_ccb->ccb_h.ccb_state = CH_CCB_PROBE;
598 xpt_action(start_ccb);
599 break;
600 }
601 }
602}
603
604static void
605chdone(struct cam_periph *periph, union ccb *done_ccb)
606{
607 struct ch_softc *softc;
608 struct ccb_scsiio *csio;
609
610 softc = (struct ch_softc *)periph->softc;
611 csio = &done_ccb->csio;
612
613 switch(done_ccb->ccb_h.ccb_state) {
614 case CH_CCB_PROBE:
615 {
616 struct scsi_mode_header_6 *mode_header;
617 struct page_element_address_assignment *ea;
618 char announce_buf[80];
619
620
621 mode_header = (struct scsi_mode_header_6 *)csio->data_ptr;
622
623 ea = (struct page_element_address_assignment *)
624 find_mode_page_6(mode_header);
625
626 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP){
627
628 softc->sc_firsts[CHET_MT] = scsi_2btoul(ea->mtea);
629 softc->sc_counts[CHET_MT] = scsi_2btoul(ea->nmte);
630 softc->sc_firsts[CHET_ST] = scsi_2btoul(ea->fsea);
631 softc->sc_counts[CHET_ST] = scsi_2btoul(ea->nse);
632 softc->sc_firsts[CHET_IE] = scsi_2btoul(ea->fieea);
633 softc->sc_counts[CHET_IE] = scsi_2btoul(ea->niee);
634 softc->sc_firsts[CHET_DT] = scsi_2btoul(ea->fdtea);
635 softc->sc_counts[CHET_DT] = scsi_2btoul(ea->ndte);
636 softc->sc_picker = softc->sc_firsts[CHET_MT];
637
638#define PLURAL(c) (c) == 1 ? "" : "s"
639 snprintf(announce_buf, sizeof(announce_buf),
640 "%d slot%s, %d drive%s, "
641 "%d picker%s, %d portal%s",
642 softc->sc_counts[CHET_ST],
643 PLURAL(softc->sc_counts[CHET_ST]),
644 softc->sc_counts[CHET_DT],
645 PLURAL(softc->sc_counts[CHET_DT]),
646 softc->sc_counts[CHET_MT],
647 PLURAL(softc->sc_counts[CHET_MT]),
648 softc->sc_counts[CHET_IE],
649 PLURAL(softc->sc_counts[CHET_IE]));
650#undef PLURAL
651 } else {
652 int error;
653
654 error = cherror(done_ccb, CAM_RETRY_SELTO,
655 SF_RETRY_UA | SF_NO_PRINT);
656 /*
657 * Retry any UNIT ATTENTION type errors. They
658 * are expected at boot.
659 */
660 if (error == ERESTART) {
661 /*
662 * A retry was scheuled, so
663 * just return.
664 */
665 return;
666 } else if (error != 0) {
667 struct scsi_mode_sense_6 *sms;
668 int frozen, retry_scheduled;
669
670 sms = (struct scsi_mode_sense_6 *)
671 done_ccb->csio.cdb_io.cdb_bytes;
672 frozen = (done_ccb->ccb_h.status &
673 CAM_DEV_QFRZN) != 0;
674
675 /*
676 * Check to see if block descriptors were
677 * disabled. Some devices don't like that.
678 * We're taking advantage of the fact that
679 * the first few bytes of the 6 and 10 byte
680 * mode sense commands are the same. If
681 * block descriptors were disabled, enable
682 * them and re-send the command.
683 */
684 if ((sms->byte2 & SMS_DBD) != 0 &&
685 (periph->flags & CAM_PERIPH_INVALID) == 0) {
686 sms->byte2 &= ~SMS_DBD;
687 xpt_action(done_ccb);
688 softc->quirks |= CH_Q_NO_DBD;
689 retry_scheduled = 1;
690 } else
691 retry_scheduled = 0;
692
693 /* Don't wedge this device's queue */
694 if (frozen)
695 cam_release_devq(done_ccb->ccb_h.path,
696 /*relsim_flags*/0,
697 /*reduction*/0,
698 /*timeout*/0,
699 /*getcount_only*/0);
700
701 if (retry_scheduled)
702 return;
703
704 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK)
705 == CAM_SCSI_STATUS_ERROR)
706 scsi_sense_print(&done_ccb->csio);
707 else {
708 xpt_print(periph->path,
709 "got CAM status %#x\n",
710 done_ccb->ccb_h.status);
711 }
712 xpt_print(periph->path, "fatal error, failed "
713 "to attach to device\n");
714
715 cam_periph_invalidate(periph);
716
717 announce_buf[0] = '\0';
718 }
719 }
720 if (announce_buf[0] != '\0') {
721 xpt_announce_periph(periph, announce_buf);
722 xpt_announce_quirks(periph, softc->quirks,
723 CH_Q_BIT_STRING);
724 }
725 softc->state = CH_STATE_NORMAL;
726 free(mode_header, M_SCSICH);
727 /*
728 * Since our peripheral may be invalidated by an error
729 * above or an external event, we must release our CCB
730 * before releasing the probe lock on the peripheral.
731 * The peripheral will only go away once the last lock
732 * is removed, and we need it around for the CCB release
733 * operation.
734 */
735 xpt_release_ccb(done_ccb);
736 cam_periph_unhold(periph);
737 return;
738 }
739 default:
740 break;
741 }
742 xpt_release_ccb(done_ccb);
743}
744
745static int
746cherror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
747{
748 struct ch_softc *softc;
749 struct cam_periph *periph;
750
751 periph = xpt_path_periph(ccb->ccb_h.path);
752 softc = (struct ch_softc *)periph->softc;
753
754 return (cam_periph_error(ccb, cam_flags, sense_flags,
755 &softc->saved_ccb));
756}
757
758static int
759chioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
760{
761 struct cam_periph *periph;
762 struct ch_softc *softc;
763 int error;
764
765 periph = (struct cam_periph *)dev->si_drv1;
766 cam_periph_lock(periph);
767 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering chioctl\n"));
768
769 softc = (struct ch_softc *)periph->softc;
770
771 error = 0;
772
773 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
774 ("trying to do ioctl %#lx\n", cmd));
775
776 /*
777 * If this command can change the device's state, we must
778 * have the device open for writing.
779 */
780 switch (cmd) {
781 case CHIOGPICKER:
782 case CHIOGPARAMS:
783 case OCHIOGSTATUS:
784 case CHIOGSTATUS:
785 break;
786
787 default:
788 if ((flag & FWRITE) == 0) {
789 cam_periph_unlock(periph);
790 return (EBADF);
791 }
792 }
793
794 switch (cmd) {
795 case CHIOMOVE:
796 error = chmove(periph, (struct changer_move *)addr);
797 break;
798
799 case CHIOEXCHANGE:
800 error = chexchange(periph, (struct changer_exchange *)addr);
801 break;
802
803 case CHIOPOSITION:
804 error = chposition(periph, (struct changer_position *)addr);
805 break;
806
807 case CHIOGPICKER:
808 *(int *)addr = softc->sc_picker - softc->sc_firsts[CHET_MT];
809 break;
810
811 case CHIOSPICKER:
812 {
813 int new_picker = *(int *)addr;
814
815 if (new_picker > (softc->sc_counts[CHET_MT] - 1)) {
816 error = EINVAL;
817 break;
818 }
819 softc->sc_picker = softc->sc_firsts[CHET_MT] + new_picker;
820 break;
821 }
822 case CHIOGPARAMS:
823 {
824 struct changer_params *cp = (struct changer_params *)addr;
825
826 cp->cp_npickers = softc->sc_counts[CHET_MT];
827 cp->cp_nslots = softc->sc_counts[CHET_ST];
828 cp->cp_nportals = softc->sc_counts[CHET_IE];
829 cp->cp_ndrives = softc->sc_counts[CHET_DT];
830 break;
831 }
832 case CHIOIELEM:
833 error = chielem(periph, *(unsigned int *)addr);
834 break;
835
836 case OCHIOGSTATUS:
837 {
838 error = chgetelemstatus(periph, SCSI_REV_2, cmd,
839 (struct changer_element_status_request *)addr);
840 break;
841 }
842
843 case CHIOGSTATUS:
844 {
845 int scsi_version;
846
847 scsi_version = chscsiversion(periph);
848 if (scsi_version >= SCSI_REV_0) {
849 error = chgetelemstatus(periph, scsi_version, cmd,
850 (struct changer_element_status_request *)addr);
851 }
852 else { /* unable to determine the SCSI version */
853 cam_periph_unlock(periph);
854 return (ENXIO);
855 }
856 break;
857 }
858
859 case CHIOSETVOLTAG:
860 {
861 error = chsetvoltag(periph,
862 (struct changer_set_voltag_request *) addr);
863 break;
864 }
865
866 /* Implement prevent/allow? */
867
868 default:
869 error = cam_periph_ioctl(periph, cmd, addr, cherror);
870 break;
871 }
872
873 cam_periph_unlock(periph);
874 return (error);
875}
876
877static int
878chmove(struct cam_periph *periph, struct changer_move *cm)
879{
880 struct ch_softc *softc;
881 u_int16_t fromelem, toelem;
882 union ccb *ccb;
883 int error;
884
885 error = 0;
886 softc = (struct ch_softc *)periph->softc;
887
888 /*
889 * Check arguments.
890 */
891 if ((cm->cm_fromtype > CHET_DT) || (cm->cm_totype > CHET_DT))
892 return (EINVAL);
893 if ((cm->cm_fromunit > (softc->sc_counts[cm->cm_fromtype] - 1)) ||
894 (cm->cm_tounit > (softc->sc_counts[cm->cm_totype] - 1)))
895 return (ENODEV);
896
897 /*
898 * Check the request against the changer's capabilities.
899 */
900 if ((softc->sc_movemask[cm->cm_fromtype] & (1 << cm->cm_totype)) == 0)
901 return (ENODEV);
902
903 /*
904 * Calculate the source and destination elements.
905 */
906 fromelem = softc->sc_firsts[cm->cm_fromtype] + cm->cm_fromunit;
907 toelem = softc->sc_firsts[cm->cm_totype] + cm->cm_tounit;
908
909 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
910
911 scsi_move_medium(&ccb->csio,
912 /* retries */ 1,
913 /* cbfcnp */ chdone,
914 /* tag_action */ MSG_SIMPLE_Q_TAG,
915 /* tea */ softc->sc_picker,
916 /* src */ fromelem,
917 /* dst */ toelem,
918 /* invert */ (cm->cm_flags & CM_INVERT) ? TRUE : FALSE,
919 /* sense_len */ SSD_FULL_SIZE,
920 /* timeout */ CH_TIMEOUT_MOVE_MEDIUM);
921
922 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/CAM_RETRY_SELTO,
923 /*sense_flags*/ SF_RETRY_UA,
924 softc->device_stats);
925
926 xpt_release_ccb(ccb);
927
928 return(error);
929}
930
931static int
932chexchange(struct cam_periph *periph, struct changer_exchange *ce)
933{
934 struct ch_softc *softc;
935 u_int16_t src, dst1, dst2;
936 union ccb *ccb;
937 int error;
938
939 error = 0;
940 softc = (struct ch_softc *)periph->softc;
941 /*
942 * Check arguments.
943 */
944 if ((ce->ce_srctype > CHET_DT) || (ce->ce_fdsttype > CHET_DT) ||
945 (ce->ce_sdsttype > CHET_DT))
946 return (EINVAL);
947 if ((ce->ce_srcunit > (softc->sc_counts[ce->ce_srctype] - 1)) ||
948 (ce->ce_fdstunit > (softc->sc_counts[ce->ce_fdsttype] - 1)) ||
949 (ce->ce_sdstunit > (softc->sc_counts[ce->ce_sdsttype] - 1)))
950 return (ENODEV);
951
952 /*
953 * Check the request against the changer's capabilities.
954 */
955 if (((softc->sc_exchangemask[ce->ce_srctype] &
956 (1 << ce->ce_fdsttype)) == 0) ||
957 ((softc->sc_exchangemask[ce->ce_fdsttype] &
958 (1 << ce->ce_sdsttype)) == 0))
959 return (ENODEV);
960
961 /*
962 * Calculate the source and destination elements.
963 */
964 src = softc->sc_firsts[ce->ce_srctype] + ce->ce_srcunit;
965 dst1 = softc->sc_firsts[ce->ce_fdsttype] + ce->ce_fdstunit;
966 dst2 = softc->sc_firsts[ce->ce_sdsttype] + ce->ce_sdstunit;
967
968 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
969
970 scsi_exchange_medium(&ccb->csio,
971 /* retries */ 1,
972 /* cbfcnp */ chdone,
973 /* tag_action */ MSG_SIMPLE_Q_TAG,
974 /* tea */ softc->sc_picker,
975 /* src */ src,
976 /* dst1 */ dst1,
977 /* dst2 */ dst2,
978 /* invert1 */ (ce->ce_flags & CE_INVERT1) ?
979 TRUE : FALSE,
980 /* invert2 */ (ce->ce_flags & CE_INVERT2) ?
981 TRUE : FALSE,
982 /* sense_len */ SSD_FULL_SIZE,
983 /* timeout */ CH_TIMEOUT_EXCHANGE_MEDIUM);
984
985 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/CAM_RETRY_SELTO,
986 /*sense_flags*/ SF_RETRY_UA,
987 softc->device_stats);
988
989 xpt_release_ccb(ccb);
990
991 return(error);
992}
993
994static int
995chposition(struct cam_periph *periph, struct changer_position *cp)
996{
997 struct ch_softc *softc;
998 u_int16_t dst;
999 union ccb *ccb;
1000 int error;
1001
1002 error = 0;
1003 softc = (struct ch_softc *)periph->softc;
1004
1005 /*
1006 * Check arguments.
1007 */
1008 if (cp->cp_type > CHET_DT)
1009 return (EINVAL);
1010 if (cp->cp_unit > (softc->sc_counts[cp->cp_type] - 1))
1011 return (ENODEV);
1012
1013 /*
1014 * Calculate the destination element.
1015 */
1016 dst = softc->sc_firsts[cp->cp_type] + cp->cp_unit;
1017
1018 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1019
1020 scsi_position_to_element(&ccb->csio,
1021 /* retries */ 1,
1022 /* cbfcnp */ chdone,
1023 /* tag_action */ MSG_SIMPLE_Q_TAG,
1024 /* tea */ softc->sc_picker,
1025 /* dst */ dst,
1026 /* invert */ (cp->cp_flags & CP_INVERT) ?
1027 TRUE : FALSE,
1028 /* sense_len */ SSD_FULL_SIZE,
1029 /* timeout */ CH_TIMEOUT_POSITION_TO_ELEMENT);
1030
1031 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1032 /*sense_flags*/ SF_RETRY_UA,
1033 softc->device_stats);
1034
1035 xpt_release_ccb(ccb);
1036
1037 return(error);
1038}
1039
1040/*
1041 * Copy a volume tag to a volume_tag struct, converting SCSI byte order
1042 * to host native byte order in the volume serial number. The volume
1043 * label as returned by the changer is transferred to user mode as
1044 * nul-terminated string. Volume labels are truncated at the first
1045 * space, as suggested by SCSI-2.
1046 */
1047static void
1048copy_voltag(struct changer_voltag *uvoltag, struct volume_tag *voltag)
1049{
1050 int i;
1051 for (i=0; i<CH_VOLTAG_MAXLEN; i++) {
1052 char c = voltag->vif[i];
1053 if (c && c != ' ')
1054 uvoltag->cv_volid[i] = c;
1055 else
1056 break;
1057 }
1058 uvoltag->cv_serial = scsi_2btoul(voltag->vsn);
1059}
1060
1061/*
1062 * Copy an element status descriptor to a user-mode
1063 * changer_element_status structure.
1064 */
1065static void
1066copy_element_status(struct ch_softc *softc,
1067 u_int16_t flags,
1068 struct read_element_status_descriptor *desc,
1069 struct changer_element_status *ces,
1070 int scsi_version)
1071{
1072 u_int16_t eaddr = scsi_2btoul(desc->eaddr);
1073 u_int16_t et;
1074 struct volume_tag *pvol_tag = NULL, *avol_tag = NULL;
1075 struct read_element_status_device_id *devid = NULL;
1076
1077 ces->ces_int_addr = eaddr;
1078 /* set up logical address in element status */
1079 for (et = CHET_MT; et <= CHET_DT; et++) {
1080 if ((softc->sc_firsts[et] <= eaddr)
1081 && ((softc->sc_firsts[et] + softc->sc_counts[et])
1082 > eaddr)) {
1083 ces->ces_addr = eaddr - softc->sc_firsts[et];
1084 ces->ces_type = et;
1085 break;
1086 }
1087 }
1088
1089 ces->ces_flags = desc->flags1;
1090
1091 ces->ces_sensecode = desc->sense_code;
1092 ces->ces_sensequal = desc->sense_qual;
1093
1094 if (desc->flags2 & READ_ELEMENT_STATUS_INVERT)
1095 ces->ces_flags |= CES_INVERT;
1096
1097 if (desc->flags2 & READ_ELEMENT_STATUS_SVALID) {
1098
1099 eaddr = scsi_2btoul(desc->ssea);
1100
1101 /* convert source address to logical format */
1102 for (et = CHET_MT; et <= CHET_DT; et++) {
1103 if ((softc->sc_firsts[et] <= eaddr)
1104 && ((softc->sc_firsts[et] + softc->sc_counts[et])
1105 > eaddr)) {
1106 ces->ces_source_addr =
1107 eaddr - softc->sc_firsts[et];
1108 ces->ces_source_type = et;
1109 ces->ces_flags |= CES_SOURCE_VALID;
1110 break;
1111 }
1112 }
1113
1114 if (!(ces->ces_flags & CES_SOURCE_VALID))
1115 printf("ch: warning: could not map element source "
1116 "address %ud to a valid element type\n",
1117 eaddr);
1118 }
1119
1120 /*
1121 * pvoltag and avoltag are common between SCSI-2 and later versions
1122 */
1123 if (flags & READ_ELEMENT_STATUS_PVOLTAG)
1124 pvol_tag = &desc->voltag_devid.pvoltag;
1125 if (flags & READ_ELEMENT_STATUS_AVOLTAG)
1126 avol_tag = (flags & READ_ELEMENT_STATUS_PVOLTAG) ?
1127 &desc->voltag_devid.voltag[1] :&desc->voltag_devid.pvoltag;
1128 /*
1129 * For SCSI-3 and later, element status can carry designator and
1130 * other information.
1131 */
1132 if (scsi_version >= SCSI_REV_SPC) {
1133 if ((flags & READ_ELEMENT_STATUS_PVOLTAG) ^
1134 (flags & READ_ELEMENT_STATUS_AVOLTAG))
1135 devid = &desc->voltag_devid.pvol_and_devid.devid;
1136 else if (!(flags & READ_ELEMENT_STATUS_PVOLTAG) &&
1137 !(flags & READ_ELEMENT_STATUS_AVOLTAG))
1138 devid = &desc->voltag_devid.devid;
1139 else /* Have both PVOLTAG and AVOLTAG */
1140 devid = &desc->voltag_devid.vol_tags_and_devid.devid;
1141 }
1142
1143 if (pvol_tag)
1144 copy_voltag(&(ces->ces_pvoltag), pvol_tag);
1145 if (avol_tag)
1146 copy_voltag(&(ces->ces_pvoltag), avol_tag);
1147 if (devid != NULL) {
1148 if (devid->designator_length > 0) {
1149 bcopy((void *)devid->designator,
1150 (void *)ces->ces_designator,
1151 devid->designator_length);
1152 ces->ces_designator_length = devid->designator_length;
1153 /*
1154 * Make sure we are always NUL terminated. The
1155 * This won't matter for the binary code set,
1156 * since the user will only pay attention to the
1157 * length field.
1158 */
1159 ces->ces_designator[devid->designator_length]= '\0';
1160 }
1161 if (devid->piv_assoc_designator_type &
1162 READ_ELEMENT_STATUS_PIV_SET) {
1163 ces->ces_flags |= CES_PIV;
1164 ces->ces_protocol_id =
1165 READ_ELEMENT_STATUS_PROTOCOL_ID(
1166 devid->prot_code_set);
1167 }
1168 ces->ces_code_set =
1169 READ_ELEMENT_STATUS_CODE_SET(devid->prot_code_set);
1170 ces->ces_assoc = READ_ELEMENT_STATUS_ASSOCIATION(
1171 devid->piv_assoc_designator_type);
1172 ces->ces_designator_type = READ_ELEMENT_STATUS_DESIGNATOR_TYPE(
1173 devid->piv_assoc_designator_type);
1174 } else if (scsi_version > SCSI_REV_2) {
1175 /* SCSI-SPC and No devid, no designator */
1176 ces->ces_designator_length = 0;
1177 ces->ces_designator[0] = '\0';
1178 ces->ces_protocol_id = CES_PROTOCOL_ID_FCP_4;
1179 }
1180
1181 if (scsi_version <= SCSI_REV_2) {
1182 if (desc->dt_or_obsolete.scsi_2.dt_scsi_flags &
1183 READ_ELEMENT_STATUS_DT_IDVALID) {
1184 ces->ces_flags |= CES_SCSIID_VALID;
1185 ces->ces_scsi_id =
1186 desc->dt_or_obsolete.scsi_2.dt_scsi_addr;
1187 }
1188
1189 if (desc->dt_or_obsolete.scsi_2.dt_scsi_addr &
1190 READ_ELEMENT_STATUS_DT_LUVALID) {
1191 ces->ces_flags |= CES_LUN_VALID;
1192 ces->ces_scsi_lun =
1193 desc->dt_or_obsolete.scsi_2.dt_scsi_flags &
1194 READ_ELEMENT_STATUS_DT_LUNMASK;
1195 }
1196 }
1197}
1198
1199static int
1200chgetelemstatus(struct cam_periph *periph, int scsi_version, u_long cmd,
1201 struct changer_element_status_request *cesr)
1202{
1203 struct read_element_status_header *st_hdr;
1204 struct read_element_status_page_header *pg_hdr;
1205 struct read_element_status_descriptor *desc;
1206 caddr_t data = NULL;
1207 size_t size, desclen;
1208 int avail, i, error = 0;
1209 int curdata, dvcid, sense_flags;
1210 int try_no_dvcid = 0;
1211 struct changer_element_status *user_data = NULL;
1212 struct ch_softc *softc;
1213 union ccb *ccb;
1214 int chet = cesr->cesr_element_type;
1215 int want_voltags = (cesr->cesr_flags & CESR_VOLTAGS) ? 1 : 0;
1216
1217 softc = (struct ch_softc *)periph->softc;
1218
1219 /* perform argument checking */
1220
1221 /*
1222 * Perform a range check on the cesr_element_{base,count}
1223 * request argument fields.
1224 */
1225 if ((softc->sc_counts[chet] - cesr->cesr_element_base) <= 0
1226 || (cesr->cesr_element_base + cesr->cesr_element_count)
1227 > softc->sc_counts[chet])
1228 return (EINVAL);
1229
1230 /*
1231 * Request one descriptor for the given element type. This
1232 * is used to determine the size of the descriptor so that
1233 * we can allocate enough storage for all of them. We assume
1234 * that the first one can fit into 1k.
1235 */
1236 cam_periph_unlock(periph);
1237 data = (caddr_t)malloc(1024, M_DEVBUF, M_WAITOK);
1238
1239 cam_periph_lock(periph);
1240 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1241
1242 sense_flags = SF_RETRY_UA;
1243 if (softc->quirks & CH_Q_NO_DVCID) {
1244 dvcid = 0;
1245 curdata = 0;
1246 } else {
1247 dvcid = 1;
1248 curdata = 1;
1249 /*
1250 * Don't print anything for an Illegal Request, because
1251 * these flags can cause some changers to complain. We'll
1252 * retry without them if we get an error.
1253 */
1254 sense_flags |= SF_QUIET_IR;
1255 }
1256
1257retry_einval:
1258
1259 scsi_read_element_status(&ccb->csio,
1260 /* retries */ 1,
1261 /* cbfcnp */ chdone,
1262 /* tag_action */ MSG_SIMPLE_Q_TAG,
1263 /* voltag */ want_voltags,
1264 /* sea */ softc->sc_firsts[chet],
1265 /* curdata */ curdata,
1266 /* dvcid */ dvcid,
1267 /* count */ 1,
1268 /* data_ptr */ data,
1269 /* dxfer_len */ 1024,
1270 /* sense_len */ SSD_FULL_SIZE,
1271 /* timeout */ CH_TIMEOUT_READ_ELEMENT_STATUS);
1272
1273 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1274 /*sense_flags*/ sense_flags,
1275 softc->device_stats);
1276
1277 /*
1278 * An Illegal Request sense key (only used if there is no asc/ascq)
1279 * or 0x24,0x00 for an ASC/ASCQ both map to EINVAL. If dvcid or
1280 * curdata are set (we set both or neither), try turning them off
1281 * and see if the command is successful.
1282 */
1283 if ((error == EINVAL)
1284 && (dvcid || curdata)) {
1285 dvcid = 0;
1286 curdata = 0;
1287 error = 0;
1288 /* At this point we want to report any Illegal Request */
1289 sense_flags &= ~SF_QUIET_IR;
1290 try_no_dvcid = 1;
1291 goto retry_einval;
1292 }
1293
1294 /*
1295 * In this case, we tried a read element status with dvcid and
1296 * curdata set, and it failed. We retried without those bits, and
1297 * it succeeded. Suggest to the user that he set a quirk, so we
1298 * don't go through the retry process the first time in the future.
1299 * This should only happen on changers that claim SCSI-3 or higher,
1300 * but don't support these bits.
1301 */
1302 if ((try_no_dvcid != 0)
1303 && (error == 0))
1304 softc->quirks |= CH_Q_NO_DVCID;
1305
1306 if (error)
1307 goto done;
1308 cam_periph_unlock(periph);
1309
1310 st_hdr = (struct read_element_status_header *)data;
1311 pg_hdr = (struct read_element_status_page_header *)((uintptr_t)st_hdr +
1312 sizeof(struct read_element_status_header));
1313 desclen = scsi_2btoul(pg_hdr->edl);
1314
1315 size = sizeof(struct read_element_status_header) +
1316 sizeof(struct read_element_status_page_header) +
1317 (desclen * cesr->cesr_element_count);
1318 /*
1319 * Reallocate storage for descriptors and get them from the
1320 * device.
1321 */
1322 free(data, M_DEVBUF);
1323 data = (caddr_t)malloc(size, M_DEVBUF, M_WAITOK);
1324
1325 cam_periph_lock(periph);
1326 scsi_read_element_status(&ccb->csio,
1327 /* retries */ 1,
1328 /* cbfcnp */ chdone,
1329 /* tag_action */ MSG_SIMPLE_Q_TAG,
1330 /* voltag */ want_voltags,
1331 /* sea */ softc->sc_firsts[chet]
1332 + cesr->cesr_element_base,
1333 /* curdata */ curdata,
1334 /* dvcid */ dvcid,
1335 /* count */ cesr->cesr_element_count,
1336 /* data_ptr */ data,
1337 /* dxfer_len */ size,
1338 /* sense_len */ SSD_FULL_SIZE,
1339 /* timeout */ CH_TIMEOUT_READ_ELEMENT_STATUS);
1340
1341 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1342 /*sense_flags*/ SF_RETRY_UA,
1343 softc->device_stats);
1344
1345 if (error)
1346 goto done;
1347 cam_periph_unlock(periph);
1348
1349 /*
1350 * Fill in the user status array.
1351 */
1352 st_hdr = (struct read_element_status_header *)data;
1353 pg_hdr = (struct read_element_status_page_header *)((uintptr_t)st_hdr +
1354 sizeof(struct read_element_status_header));
1355 avail = scsi_2btoul(st_hdr->count);
1356
1357 if (avail != cesr->cesr_element_count) {
1358 xpt_print(periph->path,
1359 "warning, READ ELEMENT STATUS avail != count\n");
1360 }
1361
1362 user_data = (struct changer_element_status *)
1363 malloc(avail * sizeof(struct changer_element_status),
1364 M_DEVBUF, M_WAITOK | M_ZERO);
1365
1366 desc = (struct read_element_status_descriptor *)((uintptr_t)data +
1367 sizeof(struct read_element_status_header) +
1368 sizeof(struct read_element_status_page_header));
1369 /*
1370 * Set up the individual element status structures
1371 */
1372 for (i = 0; i < avail; ++i) {
1373 struct changer_element_status *ces;
1374
1375 /*
1376 * In the changer_element_status structure, fields from
1377 * the beginning to the field of ces_scsi_lun are common
1378 * between SCSI-2 and SCSI-3, while all the rest are new
1379 * from SCSI-3. In order to maintain backward compatibility
1380 * of the chio command, the ces pointer, below, is computed
1381 * such that it lines up with the structure boundary
1382 * corresponding to the SCSI version.
1383 */
1384 ces = cmd == OCHIOGSTATUS ?
1385 (struct changer_element_status *)
1386 ((unsigned char *)user_data + i *
1387 (offsetof(struct changer_element_status,ces_scsi_lun)+1)):
1388 &user_data[i];
1389
1390 copy_element_status(softc, pg_hdr->flags, desc,
1391 ces, scsi_version);
1392
1393 desc = (struct read_element_status_descriptor *)
1394 ((unsigned char *)desc + desclen);
1395 }
1396
1397 /* Copy element status structures out to userspace. */
1398 if (cmd == OCHIOGSTATUS)
1399 error = copyout(user_data,
1400 cesr->cesr_element_status,
1401 avail* (offsetof(struct changer_element_status,
1402 ces_scsi_lun) + 1));
1403 else
1404 error = copyout(user_data,
1405 cesr->cesr_element_status,
1406 avail * sizeof(struct changer_element_status));
1407
1408 cam_periph_lock(periph);
1409
1410 done:
1411 xpt_release_ccb(ccb);
1412
1413 if (data != NULL)
1414 free(data, M_DEVBUF);
1415 if (user_data != NULL)
1416 free(user_data, M_DEVBUF);
1417
1418 return (error);
1419}
1420
1421static int
1422chielem(struct cam_periph *periph,
1423 unsigned int timeout)
1424{
1425 union ccb *ccb;
1426 struct ch_softc *softc;
1427 int error;
1428
1429 if (!timeout) {
1430 timeout = CH_TIMEOUT_INITIALIZE_ELEMENT_STATUS;
1431 } else {
1432 timeout *= 1000;
1433 }
1434
1435 error = 0;
1436 softc = (struct ch_softc *)periph->softc;
1437
1438 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1439
1440 scsi_initialize_element_status(&ccb->csio,
1441 /* retries */ 1,
1442 /* cbfcnp */ chdone,
1443 /* tag_action */ MSG_SIMPLE_Q_TAG,
1444 /* sense_len */ SSD_FULL_SIZE,
1445 /* timeout */ timeout);
1446
1447 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1448 /*sense_flags*/ SF_RETRY_UA,
1449 softc->device_stats);
1450
1451 xpt_release_ccb(ccb);
1452
1453 return(error);
1454}
1455
1456static int
1457chsetvoltag(struct cam_periph *periph,
1458 struct changer_set_voltag_request *csvr)
1459{
1460 union ccb *ccb;
1461 struct ch_softc *softc;
1462 u_int16_t ea;
1463 u_int8_t sac;
1464 struct scsi_send_volume_tag_parameters ssvtp;
1465 int error;
1466 int i;
1467
1468 error = 0;
1469 softc = (struct ch_softc *)periph->softc;
1470
1471 bzero(&ssvtp, sizeof(ssvtp));
1472 for (i=0; i<sizeof(ssvtp.vitf); i++) {
1473 ssvtp.vitf[i] = ' ';
1474 }
1475
1476 /*
1477 * Check arguments.
1478 */
1479 if (csvr->csvr_type > CHET_DT)
1480 return EINVAL;
1481 if (csvr->csvr_addr > (softc->sc_counts[csvr->csvr_type] - 1))
1482 return ENODEV;
1483
1484 ea = softc->sc_firsts[csvr->csvr_type] + csvr->csvr_addr;
1485
1486 if (csvr->csvr_flags & CSVR_ALTERNATE) {
1487 switch (csvr->csvr_flags & CSVR_MODE_MASK) {
1488 case CSVR_MODE_SET:
1489 sac = SEND_VOLUME_TAG_ASSERT_ALTERNATE;
1490 break;
1491 case CSVR_MODE_REPLACE:
1492 sac = SEND_VOLUME_TAG_REPLACE_ALTERNATE;
1493 break;
1494 case CSVR_MODE_CLEAR:
1495 sac = SEND_VOLUME_TAG_UNDEFINED_ALTERNATE;
1496 break;
1497 default:
1498 error = EINVAL;
1499 goto out;
1500 }
1501 } else {
1502 switch (csvr->csvr_flags & CSVR_MODE_MASK) {
1503 case CSVR_MODE_SET:
1504 sac = SEND_VOLUME_TAG_ASSERT_PRIMARY;
1505 break;
1506 case CSVR_MODE_REPLACE:
1507 sac = SEND_VOLUME_TAG_REPLACE_PRIMARY;
1508 break;
1509 case CSVR_MODE_CLEAR:
1510 sac = SEND_VOLUME_TAG_UNDEFINED_PRIMARY;
1511 break;
1512 default:
1513 error = EINVAL;
1514 goto out;
1515 }
1516 }
1517
1518 memcpy(ssvtp.vitf, csvr->csvr_voltag.cv_volid,
1519 min(strlen(csvr->csvr_voltag.cv_volid), sizeof(ssvtp.vitf)));
1520 scsi_ulto2b(csvr->csvr_voltag.cv_serial, ssvtp.minvsn);
1521
1522 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1523
1524 scsi_send_volume_tag(&ccb->csio,
1525 /* retries */ 1,
1526 /* cbfcnp */ chdone,
1527 /* tag_action */ MSG_SIMPLE_Q_TAG,
1528 /* element_address */ ea,
1529 /* send_action_code */ sac,
1530 /* parameters */ &ssvtp,
1531 /* sense_len */ SSD_FULL_SIZE,
1532 /* timeout */ CH_TIMEOUT_SEND_VOLTAG);
1533
1534 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1535 /*sense_flags*/ SF_RETRY_UA,
1536 softc->device_stats);
1537
1538 xpt_release_ccb(ccb);
1539
1540 out:
1541 return error;
1542}
1543
1544static int
1545chgetparams(struct cam_periph *periph)
1546{
1547 union ccb *ccb;
1548 struct ch_softc *softc;
1549 void *mode_buffer;
1550 int mode_buffer_len;
1551 struct page_element_address_assignment *ea;
1552 struct page_device_capabilities *cap;
1553 int error, from, dbd;
1554 u_int8_t *moves, *exchanges;
1555
1556 error = 0;
1557
1558 softc = (struct ch_softc *)periph->softc;
1559
1560 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1561
1562 /*
1563 * The scsi_mode_sense_data structure is just a convenience
1564 * structure that allows us to easily calculate the worst-case
1565 * storage size of the mode sense buffer.
1566 */
1567 mode_buffer_len = sizeof(struct scsi_mode_sense_data);
1568
1569 mode_buffer = malloc(mode_buffer_len, M_SCSICH, M_NOWAIT);
1570
1571 if (mode_buffer == NULL) {
1572 printf("chgetparams: couldn't malloc mode sense data\n");
1573 return(ENOSPC);
1574 }
1575
1576 bzero(mode_buffer, mode_buffer_len);
1577
1578 if (softc->quirks & CH_Q_NO_DBD)
1579 dbd = FALSE;
1580 else
1581 dbd = TRUE;
1582
1583 /*
1584 * Get the element address assignment page.
1585 */
1586 scsi_mode_sense(&ccb->csio,
1587 /* retries */ 1,
1588 /* cbfcnp */ chdone,
1589 /* tag_action */ MSG_SIMPLE_Q_TAG,
1590 /* dbd */ dbd,
1591 /* page_code */ SMS_PAGE_CTRL_CURRENT,
1592 /* page */ CH_ELEMENT_ADDR_ASSIGN_PAGE,
1593 /* param_buf */ (u_int8_t *)mode_buffer,
1594 /* param_len */ mode_buffer_len,
1595 /* sense_len */ SSD_FULL_SIZE,
1596 /* timeout */ CH_TIMEOUT_MODE_SENSE);
1597
1598 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1599 /* sense_flags */ SF_RETRY_UA|SF_NO_PRINT,
1600 softc->device_stats);
1601
1602 if (error) {
1603 if (dbd) {
1604 struct scsi_mode_sense_6 *sms;
1605
1606 sms = (struct scsi_mode_sense_6 *)
1607 ccb->csio.cdb_io.cdb_bytes;
1608
1609 sms->byte2 &= ~SMS_DBD;
1610 error = cam_periph_runccb(ccb, cherror,
1611 /*cam_flags*/ CAM_RETRY_SELTO,
1612 /*sense_flags*/ SF_RETRY_UA,
1613 softc->device_stats);
1614 } else {
1615 /*
1616 * Since we disabled sense printing above, print
1617 * out the sense here since we got an error.
1618 */
1619 scsi_sense_print(&ccb->csio);
1620 }
1621
1622 if (error) {
1623 xpt_print(periph->path,
1624 "chgetparams: error getting element "
1625 "address page\n");
1626 xpt_release_ccb(ccb);
1627 free(mode_buffer, M_SCSICH);
1628 return(error);
1629 }
1630 }
1631
1632 ea = (struct page_element_address_assignment *)
1633 find_mode_page_6((struct scsi_mode_header_6 *)mode_buffer);
1634
1635 softc->sc_firsts[CHET_MT] = scsi_2btoul(ea->mtea);
1636 softc->sc_counts[CHET_MT] = scsi_2btoul(ea->nmte);
1637 softc->sc_firsts[CHET_ST] = scsi_2btoul(ea->fsea);
1638 softc->sc_counts[CHET_ST] = scsi_2btoul(ea->nse);
1639 softc->sc_firsts[CHET_IE] = scsi_2btoul(ea->fieea);
1640 softc->sc_counts[CHET_IE] = scsi_2btoul(ea->niee);
1641 softc->sc_firsts[CHET_DT] = scsi_2btoul(ea->fdtea);
1642 softc->sc_counts[CHET_DT] = scsi_2btoul(ea->ndte);
1643
1644 bzero(mode_buffer, mode_buffer_len);
1645
1646 /*
1647 * Now get the device capabilities page.
1648 */
1649 scsi_mode_sense(&ccb->csio,
1650 /* retries */ 1,
1651 /* cbfcnp */ chdone,
1652 /* tag_action */ MSG_SIMPLE_Q_TAG,
1653 /* dbd */ dbd,
1654 /* page_code */ SMS_PAGE_CTRL_CURRENT,
1655 /* page */ CH_DEVICE_CAP_PAGE,
1656 /* param_buf */ (u_int8_t *)mode_buffer,
1657 /* param_len */ mode_buffer_len,
1658 /* sense_len */ SSD_FULL_SIZE,
1659 /* timeout */ CH_TIMEOUT_MODE_SENSE);
1660
1661 error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1662 /* sense_flags */ SF_RETRY_UA | SF_NO_PRINT,
1663 softc->device_stats);
1664
1665 if (error) {
1666 if (dbd) {
1667 struct scsi_mode_sense_6 *sms;
1668
1669 sms = (struct scsi_mode_sense_6 *)
1670 ccb->csio.cdb_io.cdb_bytes;
1671
1672 sms->byte2 &= ~SMS_DBD;
1673 error = cam_periph_runccb(ccb, cherror,
1674 /*cam_flags*/ CAM_RETRY_SELTO,
1675 /*sense_flags*/ SF_RETRY_UA,
1676 softc->device_stats);
1677 } else {
1678 /*
1679 * Since we disabled sense printing above, print
1680 * out the sense here since we got an error.
1681 */
1682 scsi_sense_print(&ccb->csio);
1683 }
1684
1685 if (error) {
1686 xpt_print(periph->path,
1687 "chgetparams: error getting device "
1688 "capabilities page\n");
1689 xpt_release_ccb(ccb);
1690 free(mode_buffer, M_SCSICH);
1691 return(error);
1692 }
1693 }
1694
1695 xpt_release_ccb(ccb);
1696
1697 cap = (struct page_device_capabilities *)
1698 find_mode_page_6((struct scsi_mode_header_6 *)mode_buffer);
1699
1700 bzero(softc->sc_movemask, sizeof(softc->sc_movemask));
1701 bzero(softc->sc_exchangemask, sizeof(softc->sc_exchangemask));
1702 moves = cap->move_from;
1703 exchanges = cap->exchange_with;
1704 for (from = CHET_MT; from <= CHET_MAX; ++from) {
1705 softc->sc_movemask[from] = moves[from];
1706 softc->sc_exchangemask[from] = exchanges[from];
1707 }
1708
1709 free(mode_buffer, M_SCSICH);
1710
1711 return(error);
1712}
1713
1714static int
1715chscsiversion(struct cam_periph *periph)
1716{
1717 struct scsi_inquiry_data *inq_data;
1718 struct ccb_getdev *cgd;
1719 int dev_scsi_version;
1720
1721 cam_periph_assert(periph, MA_OWNED);
1722 if ((cgd = (struct ccb_getdev *)xpt_alloc_ccb_nowait()) == NULL)
1723 return (-1);
1724 /*
1725 * Get the device information.
1726 */
1727 xpt_setup_ccb(&cgd->ccb_h,
1728 periph->path,
1729 CAM_PRIORITY_NORMAL);
1730 cgd->ccb_h.func_code = XPT_GDEV_TYPE;
1731 xpt_action((union ccb *)cgd);
1732
1733 if (cgd->ccb_h.status != CAM_REQ_CMP) {
1734 xpt_free_ccb((union ccb *)cgd);
1735 return -1;
1736 }
1737
1738 inq_data = &cgd->inq_data;
1739 dev_scsi_version = inq_data->version;
1740 xpt_free_ccb((union ccb *)cgd);
1741
1742 return dev_scsi_version;
1743}
1744
1745void
1746scsi_move_medium(struct ccb_scsiio *csio, u_int32_t retries,
1747 void (*cbfcnp)(struct cam_periph *, union ccb *),
1748 u_int8_t tag_action, u_int32_t tea, u_int32_t src,
1749 u_int32_t dst, int invert, u_int8_t sense_len,
1750 u_int32_t timeout)
1751{
1752 struct scsi_move_medium *scsi_cmd;
1753
1754 scsi_cmd = (struct scsi_move_medium *)&csio->cdb_io.cdb_bytes;
1755 bzero(scsi_cmd, sizeof(*scsi_cmd));
1756
1757 scsi_cmd->opcode = MOVE_MEDIUM;
1758
1759 scsi_ulto2b(tea, scsi_cmd->tea);
1760 scsi_ulto2b(src, scsi_cmd->src);
1761 scsi_ulto2b(dst, scsi_cmd->dst);
1762
1763 if (invert)
1764 scsi_cmd->invert |= MOVE_MEDIUM_INVERT;
1765
1766 cam_fill_csio(csio,
1767 retries,
1768 cbfcnp,
1769 /*flags*/ CAM_DIR_NONE,
1770 tag_action,
1771 /*data_ptr*/ NULL,
1772 /*dxfer_len*/ 0,
1773 sense_len,
1774 sizeof(*scsi_cmd),
1775 timeout);
1776}
1777
1778void
1779scsi_exchange_medium(struct ccb_scsiio *csio, u_int32_t retries,
1780 void (*cbfcnp)(struct cam_periph *, union ccb *),
1781 u_int8_t tag_action, u_int32_t tea, u_int32_t src,
1782 u_int32_t dst1, u_int32_t dst2, int invert1,
1783 int invert2, u_int8_t sense_len, u_int32_t timeout)
1784{
1785 struct scsi_exchange_medium *scsi_cmd;
1786
1787 scsi_cmd = (struct scsi_exchange_medium *)&csio->cdb_io.cdb_bytes;
1788 bzero(scsi_cmd, sizeof(*scsi_cmd));
1789
1790 scsi_cmd->opcode = EXCHANGE_MEDIUM;
1791
1792 scsi_ulto2b(tea, scsi_cmd->tea);
1793 scsi_ulto2b(src, scsi_cmd->src);
1794 scsi_ulto2b(dst1, scsi_cmd->fdst);
1795 scsi_ulto2b(dst2, scsi_cmd->sdst);
1796
1797 if (invert1)
1798 scsi_cmd->invert |= EXCHANGE_MEDIUM_INV1;
1799
1800 if (invert2)
1801 scsi_cmd->invert |= EXCHANGE_MEDIUM_INV2;
1802
1803 cam_fill_csio(csio,
1804 retries,
1805 cbfcnp,
1806 /*flags*/ CAM_DIR_NONE,
1807 tag_action,
1808 /*data_ptr*/ NULL,
1809 /*dxfer_len*/ 0,
1810 sense_len,
1811 sizeof(*scsi_cmd),
1812 timeout);
1813}
1814
1815void
1816scsi_position_to_element(struct ccb_scsiio *csio, u_int32_t retries,
1817 void (*cbfcnp)(struct cam_periph *, union ccb *),
1818 u_int8_t tag_action, u_int32_t tea, u_int32_t dst,
1819 int invert, u_int8_t sense_len, u_int32_t timeout)
1820{
1821 struct scsi_position_to_element *scsi_cmd;
1822
1823 scsi_cmd = (struct scsi_position_to_element *)&csio->cdb_io.cdb_bytes;
1824 bzero(scsi_cmd, sizeof(*scsi_cmd));
1825
1826 scsi_cmd->opcode = POSITION_TO_ELEMENT;
1827
1828 scsi_ulto2b(tea, scsi_cmd->tea);
1829 scsi_ulto2b(dst, scsi_cmd->dst);
1830
1831 if (invert)
1832 scsi_cmd->invert |= POSITION_TO_ELEMENT_INVERT;
1833
1834 cam_fill_csio(csio,
1835 retries,
1836 cbfcnp,
1837 /*flags*/ CAM_DIR_NONE,
1838 tag_action,
1839 /*data_ptr*/ NULL,
1840 /*dxfer_len*/ 0,
1841 sense_len,
1842 sizeof(*scsi_cmd),
1843 timeout);
1844}
1845
1846void
1847scsi_read_element_status(struct ccb_scsiio *csio, u_int32_t retries,
1848 void (*cbfcnp)(struct cam_periph *, union ccb *),
1849 u_int8_t tag_action, int voltag, u_int32_t sea,
1850 int curdata, int dvcid,
1851 u_int32_t count, u_int8_t *data_ptr,
1852 u_int32_t dxfer_len, u_int8_t sense_len,
1853 u_int32_t timeout)
1854{
1855 struct scsi_read_element_status *scsi_cmd;
1856
1857 scsi_cmd = (struct scsi_read_element_status *)&csio->cdb_io.cdb_bytes;
1858 bzero(scsi_cmd, sizeof(*scsi_cmd));
1859
1860 scsi_cmd->opcode = READ_ELEMENT_STATUS;
1861
1862 scsi_ulto2b(sea, scsi_cmd->sea);
1863 scsi_ulto2b(count, scsi_cmd->count);
1864 scsi_ulto3b(dxfer_len, scsi_cmd->len);
1865 if (dvcid)
1866 scsi_cmd->flags |= READ_ELEMENT_STATUS_DVCID;
1867 if (curdata)
1868 scsi_cmd->flags |= READ_ELEMENT_STATUS_CURDATA;
1869
1870 if (voltag)
1871 scsi_cmd->byte2 |= READ_ELEMENT_STATUS_VOLTAG;
1872
1873 cam_fill_csio(csio,
1874 retries,
1875 cbfcnp,
1876 /*flags*/ CAM_DIR_IN,
1877 tag_action,
1878 data_ptr,
1879 dxfer_len,
1880 sense_len,
1881 sizeof(*scsi_cmd),
1882 timeout);
1883}
1884
1885void
1886scsi_initialize_element_status(struct ccb_scsiio *csio, u_int32_t retries,
1887 void (*cbfcnp)(struct cam_periph *, union ccb *),
1888 u_int8_t tag_action, u_int8_t sense_len,
1889 u_int32_t timeout)
1890{
1891 struct scsi_initialize_element_status *scsi_cmd;
1892
1893 scsi_cmd = (struct scsi_initialize_element_status *)
1894 &csio->cdb_io.cdb_bytes;
1895 bzero(scsi_cmd, sizeof(*scsi_cmd));
1896
1897 scsi_cmd->opcode = INITIALIZE_ELEMENT_STATUS;
1898
1899 cam_fill_csio(csio,
1900 retries,
1901 cbfcnp,
1902 /*flags*/ CAM_DIR_NONE,
1903 tag_action,
1904 /* data_ptr */ NULL,
1905 /* dxfer_len */ 0,
1906 sense_len,
1907 sizeof(*scsi_cmd),
1908 timeout);
1909}
1910
1911void
1912scsi_send_volume_tag(struct ccb_scsiio *csio, u_int32_t retries,
1913 void (*cbfcnp)(struct cam_periph *, union ccb *),
1914 u_int8_t tag_action,
1915 u_int16_t element_address,
1916 u_int8_t send_action_code,
1917 struct scsi_send_volume_tag_parameters *parameters,
1918 u_int8_t sense_len, u_int32_t timeout)
1919{
1920 struct scsi_send_volume_tag *scsi_cmd;
1921
1922 scsi_cmd = (struct scsi_send_volume_tag *) &csio->cdb_io.cdb_bytes;
1923 bzero(scsi_cmd, sizeof(*scsi_cmd));
1924
1925 scsi_cmd->opcode = SEND_VOLUME_TAG;
1926 scsi_ulto2b(element_address, scsi_cmd->ea);
1927 scsi_cmd->sac = send_action_code;
1928 scsi_ulto2b(sizeof(*parameters), scsi_cmd->pll);
1929
1930 cam_fill_csio(csio,
1931 retries,
1932 cbfcnp,
1933 /*flags*/ CAM_DIR_OUT,
1934 tag_action,
1935 /* data_ptr */ (u_int8_t *) parameters,
1936 sizeof(*parameters),
1937 sense_len,
1938 sizeof(*scsi_cmd),
1939 timeout);
1940}