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
71 #define ccb_type ppriv_field0
72 #define ccb_bp ppriv_ptr1
80 struct devstat *device_stats;
82 struct cdev *alias_dev;
83 struct task add_physpath_task;
87 static d_open_t passopen;
88 static d_close_t passclose;
89 static d_ioctl_t passioctl;
90 static d_ioctl_t passdoioctl;
92 static periph_init_t passinit;
93 static periph_ctor_t passregister;
94 static periph_oninv_t passoninvalidate;
95 static periph_dtor_t passcleanup;
96 static void pass_add_physpath(void *context, int pending);
97 static void passasync(void *callback_arg, u_int32_t code,
98 struct cam_path *path, void *arg);
99 static int passerror(union ccb *ccb, u_int32_t cam_flags,
100 u_int32_t sense_flags);
101 static int passsendccb(struct cam_periph *periph, union ccb *ccb,
104 static struct periph_driver passdriver =
107 TAILQ_HEAD_INITIALIZER(passdriver.units), /* generation */ 0
110 PERIPHDRIVER_DECLARE(pass, passdriver);
112 static struct cdevsw pass_cdevsw = {
113 .d_version = D_VERSION,
114 .d_flags = D_TRACKCLOSE,
116 .d_close = passclose,
117 .d_ioctl = passioctl,
127 * Install a global async callback. This callback will
128 * receive async callbacks like "new device found".
130 status = xpt_register_async(AC_FOUND_DEVICE, passasync, NULL, NULL);
132 if (status != CAM_REQ_CMP) {
133 printf("pass: Failed to attach master async callback "
134 "due to status 0x%x!\n", status);
140 passdevgonecb(void *arg)
142 struct cam_periph *periph;
144 struct pass_softc *softc;
147 periph = (struct cam_periph *)arg;
148 mtx = cam_periph_mtx(periph);
151 softc = (struct pass_softc *)periph->softc;
152 KASSERT(softc->open_count >= 0, ("Negative open count %d",
156 * When we get this callback, we will get no more close calls from
157 * devfs. So if we have any dangling opens, we need to release the
158 * reference held for that particular context.
160 for (i = 0; i < softc->open_count; i++)
161 cam_periph_release_locked(periph);
163 softc->open_count = 0;
166 * Release the reference held for the device node, it is gone now.
168 cam_periph_release_locked(periph);
171 * We reference the lock directly here, instead of using
172 * cam_periph_unlock(). The reason is that the final call to
173 * cam_periph_release_locked() above could result in the periph
174 * getting freed. If that is the case, dereferencing the periph
175 * with a cam_periph_unlock() call would cause a page fault.
181 passoninvalidate(struct cam_periph *periph)
183 struct pass_softc *softc;
185 softc = (struct pass_softc *)periph->softc;
188 * De-register any async callbacks.
190 xpt_register_async(0, passasync, periph, periph->path);
192 softc->flags |= PASS_FLAG_INVALID;
195 * Tell devfs this device has gone away, and ask for a callback
196 * when it has cleaned up its state.
198 destroy_dev_sched_cb(softc->dev, passdevgonecb, periph);
201 * XXX Return all queued I/O with ENXIO.
202 * XXX Handle any transactions queued to the card
203 * with XPT_ABORT_CCB.
208 passcleanup(struct cam_periph *periph)
210 struct pass_softc *softc;
212 softc = (struct pass_softc *)periph->softc;
214 devstat_remove_entry(softc->device_stats);
216 cam_periph_unlock(periph);
217 taskqueue_drain(taskqueue_thread, &softc->add_physpath_task);
219 cam_periph_lock(periph);
221 free(softc, M_DEVBUF);
225 pass_add_physpath(void *context, int pending)
227 struct cam_periph *periph;
228 struct pass_softc *softc;
232 * If we have one, create a devfs alias for our
236 softc = periph->softc;
237 physpath = malloc(MAXPATHLEN, M_DEVBUF, M_WAITOK);
238 cam_periph_lock(periph);
239 if (periph->flags & CAM_PERIPH_INVALID) {
240 cam_periph_unlock(periph);
243 if (xpt_getattr(physpath, MAXPATHLEN,
244 "GEOM::physpath", periph->path) == 0
245 && strlen(physpath) != 0) {
247 cam_periph_unlock(periph);
248 make_dev_physpath_alias(MAKEDEV_WAITOK, &softc->alias_dev,
249 softc->dev, softc->alias_dev, physpath);
250 cam_periph_lock(periph);
254 * Now that we've made our alias, we no longer have to have a
255 * reference to the device.
257 if ((softc->flags & PASS_FLAG_INITIAL_PHYSPATH) == 0) {
258 softc->flags |= PASS_FLAG_INITIAL_PHYSPATH;
259 cam_periph_unlock(periph);
263 cam_periph_unlock(periph);
266 free(physpath, M_DEVBUF);
270 passasync(void *callback_arg, u_int32_t code,
271 struct cam_path *path, void *arg)
273 struct cam_periph *periph;
275 periph = (struct cam_periph *)callback_arg;
278 case AC_FOUND_DEVICE:
280 struct ccb_getdev *cgd;
283 cgd = (struct ccb_getdev *)arg;
288 * Allocate a peripheral instance for
289 * this device and start the probe
292 status = cam_periph_alloc(passregister, passoninvalidate,
293 passcleanup, NULL, "pass",
294 CAM_PERIPH_BIO, path,
295 passasync, AC_FOUND_DEVICE, cgd);
297 if (status != CAM_REQ_CMP
298 && status != CAM_REQ_INPROG) {
299 const struct cam_status_entry *entry;
301 entry = cam_fetch_status_entry(status);
303 printf("passasync: Unable to attach new device "
304 "due to status %#x: %s\n", status, entry ?
305 entry->status_text : "Unknown");
310 case AC_ADVINFO_CHANGED:
314 buftype = (uintptr_t)arg;
315 if (buftype == CDAI_TYPE_PHYS_PATH) {
316 struct pass_softc *softc;
318 softc = (struct pass_softc *)periph->softc;
319 taskqueue_enqueue(taskqueue_thread,
320 &softc->add_physpath_task);
325 cam_periph_async(periph, code, path, arg);
331 passregister(struct cam_periph *periph, void *arg)
333 struct pass_softc *softc;
334 struct ccb_getdev *cgd;
335 struct ccb_pathinq cpi;
338 cgd = (struct ccb_getdev *)arg;
340 printf("%s: no getdev CCB, can't register device\n", __func__);
341 return(CAM_REQ_CMP_ERR);
344 softc = (struct pass_softc *)malloc(sizeof(*softc),
348 printf("%s: Unable to probe new device. "
349 "Unable to allocate softc\n", __func__);
350 return(CAM_REQ_CMP_ERR);
353 bzero(softc, sizeof(*softc));
354 softc->state = PASS_STATE_NORMAL;
355 if (cgd->protocol == PROTO_SCSI || cgd->protocol == PROTO_ATAPI)
356 softc->pd_type = SID_TYPE(&cgd->inq_data);
357 else if (cgd->protocol == PROTO_SATAPM)
358 softc->pd_type = T_ENCLOSURE;
360 softc->pd_type = T_DIRECT;
362 periph->softc = softc;
364 bzero(&cpi, sizeof(cpi));
365 xpt_setup_ccb(&cpi.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
366 cpi.ccb_h.func_code = XPT_PATH_INQ;
367 xpt_action((union ccb *)&cpi);
370 * We pass in 0 for a blocksize, since we don't
371 * know what the blocksize of this device is, if
372 * it even has a blocksize.
374 cam_periph_unlock(periph);
375 no_tags = (cgd->inq_data.flags & SID_CmdQue) == 0;
376 softc->device_stats = devstat_new_entry("pass",
377 periph->unit_number, 0,
379 | (no_tags ? DEVSTAT_NO_ORDERED_TAGS : 0),
381 XPORT_DEVSTAT_TYPE(cpi.transport) |
383 DEVSTAT_PRIORITY_PASS);
386 * Acquire a reference to the periph before we create the devfs
387 * instance for it. We'll release this reference once the devfs
388 * instance has been freed.
390 if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
391 xpt_print(periph->path, "%s: lost periph during "
392 "registration!\n", __func__);
393 cam_periph_lock(periph);
394 return (CAM_REQ_CMP_ERR);
397 /* Register the device */
398 softc->dev = make_dev(&pass_cdevsw, periph->unit_number,
399 UID_ROOT, GID_OPERATOR, 0600, "%s%d",
400 periph->periph_name, periph->unit_number);
403 * Now that we have made the devfs instance, hold a reference to it
404 * until the task queue has run to setup the physical path alias.
405 * That way devfs won't get rid of the device before we add our
410 cam_periph_lock(periph);
411 softc->dev->si_drv1 = periph;
413 TASK_INIT(&softc->add_physpath_task, /*priority*/0,
414 pass_add_physpath, periph);
417 * See if physical path information is already available.
419 taskqueue_enqueue(taskqueue_thread, &softc->add_physpath_task);
422 * Add an async callback so that we get notified if
423 * this device goes away or its physical path
424 * (stored in the advanced info data of the EDT) has
427 xpt_register_async(AC_LOST_DEVICE | AC_ADVINFO_CHANGED,
428 passasync, periph, periph->path);
431 xpt_announce_periph(periph, NULL);
437 passopen(struct cdev *dev, int flags, int fmt, struct thread *td)
439 struct cam_periph *periph;
440 struct pass_softc *softc;
443 periph = (struct cam_periph *)dev->si_drv1;
444 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
447 cam_periph_lock(periph);
449 softc = (struct pass_softc *)periph->softc;
451 if (softc->flags & PASS_FLAG_INVALID) {
452 cam_periph_release_locked(periph);
453 cam_periph_unlock(periph);
458 * Don't allow access when we're running at a high securelevel.
460 error = securelevel_gt(td->td_ucred, 1);
462 cam_periph_release_locked(periph);
463 cam_periph_unlock(periph);
468 * Only allow read-write access.
470 if (((flags & FWRITE) == 0) || ((flags & FREAD) == 0)) {
471 cam_periph_release_locked(periph);
472 cam_periph_unlock(periph);
477 * We don't allow nonblocking access.
479 if ((flags & O_NONBLOCK) != 0) {
480 xpt_print(periph->path, "can't do nonblocking access\n");
481 cam_periph_release_locked(periph);
482 cam_periph_unlock(periph);
488 cam_periph_unlock(periph);
494 passclose(struct cdev *dev, int flag, int fmt, struct thread *td)
496 struct cam_periph *periph;
497 struct pass_softc *softc;
500 periph = (struct cam_periph *)dev->si_drv1;
503 mtx = cam_periph_mtx(periph);
506 softc = periph->softc;
509 cam_periph_release_locked(periph);
512 * We reference the lock directly here, instead of using
513 * cam_periph_unlock(). The reason is that the call to
514 * cam_periph_release_locked() above could result in the periph
515 * getting freed. If that is the case, dereferencing the periph
516 * with a cam_periph_unlock() call would cause a page fault.
518 * cam_periph_release() avoids this problem using the same method,
519 * but we're manually acquiring and dropping the lock here to
520 * protect the open count and avoid another lock acquisition and
529 passioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
533 if ((error = passdoioctl(dev, cmd, addr, flag, td)) == ENOTTY) {
534 error = cam_compat_ioctl(dev, cmd, addr, flag, td, passdoioctl);
540 passdoioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
542 struct cam_periph *periph;
543 struct pass_softc *softc;
547 periph = (struct cam_periph *)dev->si_drv1;
551 cam_periph_lock(periph);
552 softc = (struct pass_softc *)periph->softc;
564 inccb = (union ccb *)addr;
567 * Some CCB types, like scan bus and scan lun can only go
568 * through the transport layer device.
570 if (inccb->ccb_h.func_code & XPT_FC_XPT_ONLY) {
571 xpt_print(periph->path, "CCB function code %#x is "
572 "restricted to the XPT device\n",
573 inccb->ccb_h.func_code);
578 /* Compatibility for RL/priority-unaware code. */
579 priority = inccb->ccb_h.pinfo.priority;
580 if (priority <= CAM_PRIORITY_OOB)
581 priority += CAM_PRIORITY_OOB + 1;
584 * Non-immediate CCBs need a CCB from the per-device pool
585 * of CCBs, which is scheduled by the transport layer.
586 * Immediate CCBs and user-supplied CCBs should just be
589 if ((inccb->ccb_h.func_code & XPT_FC_QUEUED)
590 && ((inccb->ccb_h.func_code & XPT_FC_USER_CCB) == 0)) {
591 ccb = cam_periph_getccb(periph, priority);
594 ccb = xpt_alloc_ccb_nowait();
597 xpt_setup_ccb(&ccb->ccb_h, periph->path,
603 xpt_print(periph->path, "unable to allocate CCB\n");
608 error = passsendccb(periph, ccb, inccb);
613 xpt_release_ccb(ccb);
618 error = cam_periph_ioctl(periph, cmd, addr, passerror);
622 cam_periph_unlock(periph);
627 * Generally, "ccb" should be the CCB supplied by the kernel. "inccb"
628 * should be the CCB that is copied in from the user.
631 passsendccb(struct cam_periph *periph, union ccb *ccb, union ccb *inccb)
633 struct pass_softc *softc;
634 struct cam_periph_map_info mapinfo;
638 softc = (struct pass_softc *)periph->softc;
641 * There are some fields in the CCB header that need to be
642 * preserved, the rest we get from the user.
644 xpt_merge_ccb(ccb, inccb);
647 * Let cam_periph_mapmem do a sanity check on the data pointer format.
648 * Even if no data transfer is needed, it's a cheap check and it
649 * simplifies the code.
651 fc = ccb->ccb_h.func_code;
652 if ((fc == XPT_SCSI_IO) || (fc == XPT_ATA_IO) || (fc == XPT_SMP_IO)
653 || (fc == XPT_DEV_MATCH) || (fc == XPT_DEV_ADVINFO)) {
654 bzero(&mapinfo, sizeof(mapinfo));
657 * cam_periph_mapmem calls into proc and vm functions that can
658 * sleep as well as trigger I/O, so we can't hold the lock.
659 * Dropping it here is reasonably safe.
661 cam_periph_unlock(periph);
662 error = cam_periph_mapmem(ccb, &mapinfo);
663 cam_periph_lock(periph);
666 * cam_periph_mapmem returned an error, we can't continue.
667 * Return the error to the user.
672 /* Ensure that the unmap call later on is a no-op. */
673 mapinfo.num_bufs_used = 0;
676 * If the user wants us to perform any error recovery, then honor
677 * that request. Otherwise, it's up to the user to perform any
680 cam_periph_runccb(ccb, passerror, /* cam_flags */ CAM_RETRY_SELTO,
681 /* sense_flags */ ((ccb->ccb_h.flags & CAM_PASS_ERR_RECOVER) ?
682 SF_RETRY_UA : SF_NO_RECOVERY) | SF_NO_PRINT,
683 softc->device_stats);
685 cam_periph_unmapmem(ccb, &mapinfo);
687 ccb->ccb_h.cbfcnp = NULL;
688 ccb->ccb_h.periph_priv = inccb->ccb_h.periph_priv;
689 bcopy(ccb, inccb, sizeof(union ccb));
695 passerror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
697 struct cam_periph *periph;
698 struct pass_softc *softc;
700 periph = xpt_path_periph(ccb->ccb_h.path);
701 softc = (struct pass_softc *)periph->softc;
703 return(cam_periph_error(ccb, cam_flags, sense_flags,