2 * Copyright (c) 1997, 1998, 2000 Justin T. Gibbs.
3 * Copyright (c) 1997, 1998, 1999 Kenneth D. Merry.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
34 #include <sys/types.h>
36 #include <sys/malloc.h>
37 #include <sys/fcntl.h>
39 #include <sys/errno.h>
40 #include <sys/devicestat.h>
42 #include <sys/taskqueue.h>
45 #include <cam/cam_ccb.h>
46 #include <cam/cam_periph.h>
47 #include <cam/cam_queue.h>
48 #include <cam/cam_xpt_periph.h>
49 #include <cam/cam_debug.h>
50 #include <cam/cam_sim.h>
51 #include <cam/cam_compat.h>
53 #include <cam/scsi/scsi_all.h>
54 #include <cam/scsi/scsi_pass.h>
57 PASS_FLAG_OPEN = 0x01,
58 PASS_FLAG_LOCKED = 0x02,
59 PASS_FLAG_INVALID = 0x04,
60 PASS_FLAG_INITIAL_PHYSPATH = 0x08
72 #define ccb_type ppriv_field0
73 #define ccb_bp ppriv_ptr1
81 struct devstat *device_stats;
83 struct cdev *alias_dev;
84 struct task add_physpath_task;
88 static d_open_t passopen;
89 static d_close_t passclose;
90 static d_ioctl_t passioctl;
91 static d_ioctl_t passdoioctl;
93 static periph_init_t passinit;
94 static periph_ctor_t passregister;
95 static periph_oninv_t passoninvalidate;
96 static periph_dtor_t passcleanup;
97 static periph_start_t passstart;
98 static void pass_add_physpath(void *context, int pending);
99 static void passasync(void *callback_arg, u_int32_t code,
100 struct cam_path *path, void *arg);
101 static void passdone(struct cam_periph *periph,
102 union ccb *done_ccb);
103 static int passerror(union ccb *ccb, u_int32_t cam_flags,
104 u_int32_t sense_flags);
105 static int passsendccb(struct cam_periph *periph, union ccb *ccb,
108 static struct periph_driver passdriver =
111 TAILQ_HEAD_INITIALIZER(passdriver.units), /* generation */ 0
114 PERIPHDRIVER_DECLARE(pass, passdriver);
116 static struct cdevsw pass_cdevsw = {
117 .d_version = D_VERSION,
118 .d_flags = D_TRACKCLOSE,
120 .d_close = passclose,
121 .d_ioctl = passioctl,
131 * Install a global async callback. This callback will
132 * receive async callbacks like "new device found".
134 status = xpt_register_async(AC_FOUND_DEVICE, passasync, NULL, NULL);
136 if (status != CAM_REQ_CMP) {
137 printf("pass: Failed to attach master async callback "
138 "due to status 0x%x!\n", status);
144 passdevgonecb(void *arg)
147 struct cam_periph *periph;
148 struct pass_softc *softc;
151 periph = (struct cam_periph *)arg;
153 softc = (struct pass_softc *)periph->softc;
155 KASSERT(softc->open_count >= 0, ("Negative open count %d",
161 * When we get this callback, we will get no more close calls from
162 * devfs. So if we have any dangling opens, we need to release the
163 * reference held for that particular context.
165 for (i = 0; i < softc->open_count; i++)
166 cam_periph_release_locked(periph);
168 softc->open_count = 0;
171 * Release the reference held for the device node, it is gone now.
173 cam_periph_release_locked(periph);
176 * We reference the SIM lock directly here, instead of using
177 * cam_periph_unlock(). The reason is that the final call to
178 * cam_periph_release_locked() above could result in the periph
179 * getting freed. If that is the case, dereferencing the periph
180 * with a cam_periph_unlock() call would cause a page fault.
182 mtx_unlock(sim->mtx);
186 passoninvalidate(struct cam_periph *periph)
188 struct pass_softc *softc;
190 softc = (struct pass_softc *)periph->softc;
193 * De-register any async callbacks.
195 xpt_register_async(0, passasync, periph, periph->path);
197 softc->flags |= PASS_FLAG_INVALID;
200 * Tell devfs this device has gone away, and ask for a callback
201 * when it has cleaned up its state.
203 destroy_dev_sched_cb(softc->dev, passdevgonecb, periph);
206 * XXX Return all queued I/O with ENXIO.
207 * XXX Handle any transactions queued to the card
208 * with XPT_ABORT_CCB.
212 xpt_print(periph->path, "lost device\n");
218 passcleanup(struct cam_periph *periph)
220 struct pass_softc *softc;
222 softc = (struct pass_softc *)periph->softc;
225 xpt_print(periph->path, "removing device entry\n");
226 devstat_remove_entry(softc->device_stats);
228 cam_periph_unlock(periph);
229 taskqueue_drain(taskqueue_thread, &softc->add_physpath_task);
231 cam_periph_lock(periph);
233 free(softc, M_DEVBUF);
237 pass_add_physpath(void *context, int pending)
239 struct cam_periph *periph;
240 struct pass_softc *softc;
244 * If we have one, create a devfs alias for our
248 softc = periph->softc;
249 physpath = malloc(MAXPATHLEN, M_DEVBUF, M_WAITOK);
250 cam_periph_lock(periph);
251 if (periph->flags & CAM_PERIPH_INVALID) {
252 cam_periph_unlock(periph);
255 if (xpt_getattr(physpath, MAXPATHLEN,
256 "GEOM::physpath", periph->path) == 0
257 && strlen(physpath) != 0) {
259 cam_periph_unlock(periph);
260 make_dev_physpath_alias(MAKEDEV_WAITOK, &softc->alias_dev,
261 softc->dev, softc->alias_dev, physpath);
262 cam_periph_lock(periph);
266 * Now that we've made our alias, we no longer have to have a
267 * reference to the device.
269 if ((softc->flags & PASS_FLAG_INITIAL_PHYSPATH) == 0) {
270 softc->flags |= PASS_FLAG_INITIAL_PHYSPATH;
271 cam_periph_unlock(periph);
275 cam_periph_unlock(periph);
278 free(physpath, M_DEVBUF);
282 passasync(void *callback_arg, u_int32_t code,
283 struct cam_path *path, void *arg)
285 struct cam_periph *periph;
287 periph = (struct cam_periph *)callback_arg;
290 case AC_FOUND_DEVICE:
292 struct ccb_getdev *cgd;
295 cgd = (struct ccb_getdev *)arg;
300 * Allocate a peripheral instance for
301 * this device and start the probe
304 status = cam_periph_alloc(passregister, passoninvalidate,
305 passcleanup, passstart, "pass",
306 CAM_PERIPH_BIO, cgd->ccb_h.path,
307 passasync, AC_FOUND_DEVICE, cgd);
309 if (status != CAM_REQ_CMP
310 && status != CAM_REQ_INPROG) {
311 const struct cam_status_entry *entry;
313 entry = cam_fetch_status_entry(status);
315 printf("passasync: Unable to attach new device "
316 "due to status %#x: %s\n", status, entry ?
317 entry->status_text : "Unknown");
322 case AC_ADVINFO_CHANGED:
326 buftype = (uintptr_t)arg;
327 if (buftype == CDAI_TYPE_PHYS_PATH) {
328 struct pass_softc *softc;
330 softc = (struct pass_softc *)periph->softc;
331 taskqueue_enqueue(taskqueue_thread,
332 &softc->add_physpath_task);
337 cam_periph_async(periph, code, path, arg);
343 passregister(struct cam_periph *periph, void *arg)
345 struct pass_softc *softc;
346 struct ccb_getdev *cgd;
347 struct ccb_pathinq cpi;
350 cgd = (struct ccb_getdev *)arg;
352 printf("%s: no getdev CCB, can't register device\n", __func__);
353 return(CAM_REQ_CMP_ERR);
356 softc = (struct pass_softc *)malloc(sizeof(*softc),
360 printf("%s: Unable to probe new device. "
361 "Unable to allocate softc\n", __func__);
362 return(CAM_REQ_CMP_ERR);
365 bzero(softc, sizeof(*softc));
366 softc->state = PASS_STATE_NORMAL;
367 if (cgd->protocol == PROTO_SCSI || cgd->protocol == PROTO_ATAPI)
368 softc->pd_type = SID_TYPE(&cgd->inq_data);
369 else if (cgd->protocol == PROTO_SATAPM)
370 softc->pd_type = T_ENCLOSURE;
372 softc->pd_type = T_DIRECT;
374 periph->softc = softc;
376 bzero(&cpi, sizeof(cpi));
377 xpt_setup_ccb(&cpi.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
378 cpi.ccb_h.func_code = XPT_PATH_INQ;
379 xpt_action((union ccb *)&cpi);
382 * We pass in 0 for a blocksize, since we don't
383 * know what the blocksize of this device is, if
384 * it even has a blocksize.
386 cam_periph_unlock(periph);
387 no_tags = (cgd->inq_data.flags & SID_CmdQue) == 0;
388 softc->device_stats = devstat_new_entry("pass",
389 periph->unit_number, 0,
391 | (no_tags ? DEVSTAT_NO_ORDERED_TAGS : 0),
393 XPORT_DEVSTAT_TYPE(cpi.transport) |
395 DEVSTAT_PRIORITY_PASS);
398 * Acquire a reference to the periph before we create the devfs
399 * instance for it. We'll release this reference once the devfs
400 * instance has been freed.
402 if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
403 xpt_print(periph->path, "%s: lost periph during "
404 "registration!\n", __func__);
405 cam_periph_lock(periph);
406 return (CAM_REQ_CMP_ERR);
409 /* Register the device */
410 softc->dev = make_dev(&pass_cdevsw, periph->unit_number,
411 UID_ROOT, GID_OPERATOR, 0600, "%s%d",
412 periph->periph_name, periph->unit_number);
415 * Now that we have made the devfs instance, hold a reference to it
416 * until the task queue has run to setup the physical path alias.
417 * That way devfs won't get rid of the device before we add our
422 cam_periph_lock(periph);
423 softc->dev->si_drv1 = periph;
425 TASK_INIT(&softc->add_physpath_task, /*priority*/0,
426 pass_add_physpath, periph);
429 * See if physical path information is already available.
431 taskqueue_enqueue(taskqueue_thread, &softc->add_physpath_task);
434 * Add an async callback so that we get notified if
435 * this device goes away or its physical path
436 * (stored in the advanced info data of the EDT) has
439 xpt_register_async(AC_LOST_DEVICE | AC_ADVINFO_CHANGED,
440 passasync, periph, periph->path);
443 xpt_announce_periph(periph, NULL);
449 passopen(struct cdev *dev, int flags, int fmt, struct thread *td)
451 struct cam_periph *periph;
452 struct pass_softc *softc;
455 periph = (struct cam_periph *)dev->si_drv1;
456 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
459 cam_periph_lock(periph);
461 softc = (struct pass_softc *)periph->softc;
463 if (softc->flags & PASS_FLAG_INVALID) {
464 cam_periph_release_locked(periph);
465 cam_periph_unlock(periph);
470 * Don't allow access when we're running at a high securelevel.
472 error = securelevel_gt(td->td_ucred, 1);
474 cam_periph_release_locked(periph);
475 cam_periph_unlock(periph);
480 * Only allow read-write access.
482 if (((flags & FWRITE) == 0) || ((flags & FREAD) == 0)) {
483 cam_periph_release_locked(periph);
484 cam_periph_unlock(periph);
489 * We don't allow nonblocking access.
491 if ((flags & O_NONBLOCK) != 0) {
492 xpt_print(periph->path, "can't do nonblocking access\n");
493 cam_periph_release_locked(periph);
494 cam_periph_unlock(periph);
500 cam_periph_unlock(periph);
506 passclose(struct cdev *dev, int flag, int fmt, struct thread *td)
509 struct cam_periph *periph;
510 struct pass_softc *softc;
512 periph = (struct cam_periph *)dev->si_drv1;
517 softc = periph->softc;
523 cam_periph_release_locked(periph);
526 * We reference the SIM lock directly here, instead of using
527 * cam_periph_unlock(). The reason is that the call to
528 * cam_periph_release_locked() above could result in the periph
529 * getting freed. If that is the case, dereferencing the periph
530 * with a cam_periph_unlock() call would cause a page fault.
532 * cam_periph_release() avoids this problem using the same method,
533 * but we're manually acquiring and dropping the lock here to
534 * protect the open count and avoid another lock acquisition and
537 mtx_unlock(sim->mtx);
543 passstart(struct cam_periph *periph, union ccb *start_ccb)
545 struct pass_softc *softc;
547 softc = (struct pass_softc *)periph->softc;
549 switch (softc->state) {
550 case PASS_STATE_NORMAL:
551 start_ccb->ccb_h.ccb_type = PASS_CCB_WAITING;
552 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
554 periph->immediate_priority = CAM_PRIORITY_NONE;
555 wakeup(&periph->ccb_list);
561 passdone(struct cam_periph *periph, union ccb *done_ccb)
563 struct pass_softc *softc;
564 struct ccb_scsiio *csio;
566 softc = (struct pass_softc *)periph->softc;
567 csio = &done_ccb->csio;
568 switch (csio->ccb_h.ccb_type) {
569 case PASS_CCB_WAITING:
570 /* Caller will release the CCB */
571 wakeup(&done_ccb->ccb_h.cbfcnp);
574 xpt_release_ccb(done_ccb);
578 passioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
582 if ((error = passdoioctl(dev, cmd, addr, flag, td)) == ENOTTY) {
583 error = cam_compat_ioctl(dev, &cmd, &addr, &flag, td);
585 return (passdoioctl(dev, cmd, addr, flag, td));
591 passdoioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
593 struct cam_periph *periph;
594 struct pass_softc *softc;
598 periph = (struct cam_periph *)dev->si_drv1;
602 cam_periph_lock(periph);
603 softc = (struct pass_softc *)periph->softc;
615 inccb = (union ccb *)addr;
618 * Some CCB types, like scan bus and scan lun can only go
619 * through the transport layer device.
621 if (inccb->ccb_h.func_code & XPT_FC_XPT_ONLY) {
622 xpt_print(periph->path, "CCB function code %#x is "
623 "restricted to the XPT device\n",
624 inccb->ccb_h.func_code);
629 /* Compatibility for RL/priority-unaware code. */
630 priority = inccb->ccb_h.pinfo.priority;
631 if (priority < CAM_RL_TO_PRIORITY(CAM_RL_NORMAL))
632 priority += CAM_RL_TO_PRIORITY(CAM_RL_NORMAL);
635 * Non-immediate CCBs need a CCB from the per-device pool
636 * of CCBs, which is scheduled by the transport layer.
637 * Immediate CCBs and user-supplied CCBs should just be
640 if ((inccb->ccb_h.func_code & XPT_FC_QUEUED)
641 && ((inccb->ccb_h.func_code & XPT_FC_USER_CCB) == 0)) {
642 ccb = cam_periph_getccb(periph, priority);
645 ccb = xpt_alloc_ccb_nowait();
648 xpt_setup_ccb(&ccb->ccb_h, periph->path,
654 xpt_print(periph->path, "unable to allocate CCB\n");
659 error = passsendccb(periph, ccb, inccb);
664 xpt_release_ccb(ccb);
669 error = cam_periph_ioctl(periph, cmd, addr, passerror);
673 cam_periph_unlock(periph);
678 * Generally, "ccb" should be the CCB supplied by the kernel. "inccb"
679 * should be the CCB that is copied in from the user.
682 passsendccb(struct cam_periph *periph, union ccb *ccb, union ccb *inccb)
684 struct pass_softc *softc;
685 struct cam_periph_map_info mapinfo;
689 softc = (struct pass_softc *)periph->softc;
692 * There are some fields in the CCB header that need to be
693 * preserved, the rest we get from the user.
695 xpt_merge_ccb(ccb, inccb);
698 * There's no way for the user to have a completion
699 * function, so we put our own completion function in here.
701 ccb->ccb_h.cbfcnp = passdone;
704 * Let cam_periph_mapmem do a sanity check on the data pointer format.
705 * Even if no data transfer is needed, it's a cheap check and it
706 * simplifies the code.
708 fc = ccb->ccb_h.func_code;
709 if ((fc == XPT_SCSI_IO) || (fc == XPT_ATA_IO) || (fc == XPT_SMP_IO)
710 || (fc == XPT_DEV_MATCH) || (fc == XPT_DEV_ADVINFO)) {
711 bzero(&mapinfo, sizeof(mapinfo));
714 * cam_periph_mapmem calls into proc and vm functions that can
715 * sleep as well as trigger I/O, so we can't hold the lock.
716 * Dropping it here is reasonably safe.
718 cam_periph_unlock(periph);
719 error = cam_periph_mapmem(ccb, &mapinfo);
720 cam_periph_lock(periph);
723 * cam_periph_mapmem returned an error, we can't continue.
724 * Return the error to the user.
729 /* Ensure that the unmap call later on is a no-op. */
730 mapinfo.num_bufs_used = 0;
733 * If the user wants us to perform any error recovery, then honor
734 * that request. Otherwise, it's up to the user to perform any
737 cam_periph_runccb(ccb, passerror, /* cam_flags */ CAM_RETRY_SELTO,
738 /* sense_flags */ ((ccb->ccb_h.flags & CAM_PASS_ERR_RECOVER) ?
739 SF_RETRY_UA : SF_NO_RECOVERY) | SF_NO_PRINT,
740 softc->device_stats);
742 cam_periph_unmapmem(ccb, &mapinfo);
744 ccb->ccb_h.cbfcnp = NULL;
745 ccb->ccb_h.periph_priv = inccb->ccb_h.periph_priv;
746 bcopy(ccb, inccb, sizeof(union ccb));
752 passerror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
754 struct cam_periph *periph;
755 struct pass_softc *softc;
757 periph = xpt_path_periph(ccb->ccb_h.path);
758 softc = (struct pass_softc *)periph->softc;
760 return(cam_periph_error(ccb, cam_flags, sense_flags,