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>
52 #include <cam/scsi/scsi_all.h>
53 #include <cam/scsi/scsi_pass.h>
56 PASS_FLAG_OPEN = 0x01,
57 PASS_FLAG_LOCKED = 0x02,
58 PASS_FLAG_INVALID = 0x04
70 #define ccb_type ppriv_field0
71 #define ccb_bp ppriv_ptr1
78 struct devstat *device_stats;
80 struct cdev *alias_dev;
81 struct task add_physpath_task;
85 static d_open_t passopen;
86 static d_close_t passclose;
87 static d_ioctl_t passioctl;
89 static periph_init_t passinit;
90 static periph_ctor_t passregister;
91 static periph_oninv_t passoninvalidate;
92 static periph_dtor_t passcleanup;
93 static periph_start_t passstart;
94 static void pass_add_physpath(void *context, int pending);
95 static void passasync(void *callback_arg, u_int32_t code,
96 struct cam_path *path, void *arg);
97 static void passdone(struct cam_periph *periph,
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,
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 passoninvalidate(struct cam_periph *periph)
142 struct pass_softc *softc;
144 softc = (struct pass_softc *)periph->softc;
147 * De-register any async callbacks.
149 xpt_register_async(0, passasync, periph, periph->path);
151 softc->flags |= PASS_FLAG_INVALID;
154 * XXX Return all queued I/O with ENXIO.
155 * XXX Handle any transactions queued to the card
156 * with XPT_ABORT_CCB.
160 xpt_print(periph->path, "lost device\n");
166 passcleanup(struct cam_periph *periph)
168 struct pass_softc *softc;
170 softc = (struct pass_softc *)periph->softc;
173 xpt_print(periph->path, "removing device entry\n");
174 devstat_remove_entry(softc->device_stats);
176 cam_periph_unlock(periph);
177 taskqueue_drain(taskqueue_thread, &softc->add_physpath_task);
180 * passcleanup() is indirectly a d_close method via passclose,
181 * so using destroy_dev(9) directly can result in deadlock.
183 destroy_dev_sched(softc->dev);
184 cam_periph_lock(periph);
186 free(softc, M_DEVBUF);
190 pass_add_physpath(void *context, int pending)
192 struct cam_periph *periph;
193 struct pass_softc *softc;
197 * If we have one, create a devfs alias for our
201 softc = periph->softc;
202 physpath = malloc(MAXPATHLEN, M_DEVBUF, M_WAITOK);
203 if (xpt_getattr(physpath, MAXPATHLEN,
204 "GEOM::physpath", periph->path) == 0
205 && strlen(physpath) != 0) {
207 make_dev_physpath_alias(MAKEDEV_WAITOK, &softc->alias_dev,
208 softc->dev, softc->alias_dev, physpath);
210 free(physpath, M_DEVBUF);
214 passasync(void *callback_arg, u_int32_t code,
215 struct cam_path *path, void *arg)
217 struct cam_periph *periph;
219 periph = (struct cam_periph *)callback_arg;
222 case AC_FOUND_DEVICE:
224 struct ccb_getdev *cgd;
227 cgd = (struct ccb_getdev *)arg;
232 * Allocate a peripheral instance for
233 * this device and start the probe
236 status = cam_periph_alloc(passregister, passoninvalidate,
237 passcleanup, passstart, "pass",
238 CAM_PERIPH_BIO, cgd->ccb_h.path,
239 passasync, AC_FOUND_DEVICE, cgd);
241 if (status != CAM_REQ_CMP
242 && status != CAM_REQ_INPROG) {
243 const struct cam_status_entry *entry;
245 entry = cam_fetch_status_entry(status);
247 printf("passasync: Unable to attach new device "
248 "due to status %#x: %s\n", status, entry ?
249 entry->status_text : "Unknown");
254 case AC_ADVINFO_CHANGED:
258 buftype = (uintptr_t)arg;
259 if (buftype == CDAI_TYPE_PHYS_PATH) {
260 struct pass_softc *softc;
262 softc = (struct pass_softc *)periph->softc;
263 taskqueue_enqueue(taskqueue_thread,
264 &softc->add_physpath_task);
269 cam_periph_async(periph, code, path, arg);
275 passregister(struct cam_periph *periph, void *arg)
277 struct pass_softc *softc;
278 struct ccb_getdev *cgd;
279 struct ccb_pathinq cpi;
282 cgd = (struct ccb_getdev *)arg;
283 if (periph == NULL) {
284 printf("passregister: periph was NULL!!\n");
285 return(CAM_REQ_CMP_ERR);
289 printf("passregister: no getdev CCB, can't register device\n");
290 return(CAM_REQ_CMP_ERR);
293 softc = (struct pass_softc *)malloc(sizeof(*softc),
297 printf("passregister: Unable to probe new device. "
298 "Unable to allocate softc\n");
299 return(CAM_REQ_CMP_ERR);
302 bzero(softc, sizeof(*softc));
303 softc->state = PASS_STATE_NORMAL;
304 if (cgd->protocol == PROTO_SCSI || cgd->protocol == PROTO_ATAPI)
305 softc->pd_type = SID_TYPE(&cgd->inq_data);
306 else if (cgd->protocol == PROTO_SATAPM)
307 softc->pd_type = T_ENCLOSURE;
309 softc->pd_type = T_DIRECT;
311 periph->softc = softc;
313 bzero(&cpi, sizeof(cpi));
314 xpt_setup_ccb(&cpi.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
315 cpi.ccb_h.func_code = XPT_PATH_INQ;
316 xpt_action((union ccb *)&cpi);
319 * We pass in 0 for a blocksize, since we don't
320 * know what the blocksize of this device is, if
321 * it even has a blocksize.
323 mtx_unlock(periph->sim->mtx);
324 no_tags = (cgd->inq_data.flags & SID_CmdQue) == 0;
325 softc->device_stats = devstat_new_entry("pass",
326 periph->unit_number, 0,
328 | (no_tags ? DEVSTAT_NO_ORDERED_TAGS : 0),
330 XPORT_DEVSTAT_TYPE(cpi.transport) |
332 DEVSTAT_PRIORITY_PASS);
334 /* Register the device */
335 softc->dev = make_dev(&pass_cdevsw, periph->unit_number,
336 UID_ROOT, GID_OPERATOR, 0600, "%s%d",
337 periph->periph_name, periph->unit_number);
338 mtx_lock(periph->sim->mtx);
339 softc->dev->si_drv1 = periph;
341 TASK_INIT(&softc->add_physpath_task, /*priority*/0,
342 pass_add_physpath, periph);
345 * See if physical path information is already available.
347 taskqueue_enqueue(taskqueue_thread, &softc->add_physpath_task);
350 * Add an async callback so that we get notified if
351 * this device goes away or its physical path
352 * (stored in the advanced info data of the EDT) has
355 xpt_register_async(AC_LOST_DEVICE | AC_ADVINFO_CHANGED,
356 passasync, periph, periph->path);
359 xpt_announce_periph(periph, NULL);
365 passopen(struct cdev *dev, int flags, int fmt, struct thread *td)
367 struct cam_periph *periph;
368 struct pass_softc *softc;
371 periph = (struct cam_periph *)dev->si_drv1;
372 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
375 cam_periph_lock(periph);
377 softc = (struct pass_softc *)periph->softc;
379 if (softc->flags & PASS_FLAG_INVALID) {
380 cam_periph_unlock(periph);
381 cam_periph_release(periph);
386 * Don't allow access when we're running at a high securelevel.
388 error = securelevel_gt(td->td_ucred, 1);
390 cam_periph_unlock(periph);
391 cam_periph_release(periph);
396 * Only allow read-write access.
398 if (((flags & FWRITE) == 0) || ((flags & FREAD) == 0)) {
399 cam_periph_unlock(periph);
400 cam_periph_release(periph);
405 * We don't allow nonblocking access.
407 if ((flags & O_NONBLOCK) != 0) {
408 xpt_print(periph->path, "can't do nonblocking access\n");
409 cam_periph_unlock(periph);
410 cam_periph_release(periph);
414 if ((softc->flags & PASS_FLAG_OPEN) == 0) {
415 softc->flags |= PASS_FLAG_OPEN;
416 cam_periph_unlock(periph);
418 /* Device closes aren't symmertical, so fix up the refcount */
419 cam_periph_unlock(periph);
420 cam_periph_release(periph);
427 passclose(struct cdev *dev, int flag, int fmt, struct thread *td)
429 struct cam_periph *periph;
430 struct pass_softc *softc;
432 periph = (struct cam_periph *)dev->si_drv1;
436 cam_periph_lock(periph);
438 softc = (struct pass_softc *)periph->softc;
439 softc->flags &= ~PASS_FLAG_OPEN;
441 cam_periph_unlock(periph);
442 cam_periph_release(periph);
448 passstart(struct cam_periph *periph, union ccb *start_ccb)
450 struct pass_softc *softc;
452 softc = (struct pass_softc *)periph->softc;
454 switch (softc->state) {
455 case PASS_STATE_NORMAL:
456 start_ccb->ccb_h.ccb_type = PASS_CCB_WAITING;
457 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
459 periph->immediate_priority = CAM_PRIORITY_NONE;
460 wakeup(&periph->ccb_list);
466 passdone(struct cam_periph *periph, union ccb *done_ccb)
468 struct pass_softc *softc;
469 struct ccb_scsiio *csio;
471 softc = (struct pass_softc *)periph->softc;
472 csio = &done_ccb->csio;
473 switch (csio->ccb_h.ccb_type) {
474 case PASS_CCB_WAITING:
475 /* Caller will release the CCB */
476 wakeup(&done_ccb->ccb_h.cbfcnp);
479 xpt_release_ccb(done_ccb);
483 passioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
485 struct cam_periph *periph;
486 struct pass_softc *softc;
489 periph = (struct cam_periph *)dev->si_drv1;
493 cam_periph_lock(periph);
494 softc = (struct pass_softc *)periph->softc;
506 inccb = (union ccb *)addr;
509 * Some CCB types, like scan bus and scan lun can only go
510 * through the transport layer device.
512 if (inccb->ccb_h.func_code & XPT_FC_XPT_ONLY) {
513 xpt_print(periph->path, "CCB function code %#x is "
514 "restricted to the XPT device\n",
515 inccb->ccb_h.func_code);
521 * Non-immediate CCBs need a CCB from the per-device pool
522 * of CCBs, which is scheduled by the transport layer.
523 * Immediate CCBs and user-supplied CCBs should just be
526 if ((inccb->ccb_h.func_code & XPT_FC_QUEUED)
527 && ((inccb->ccb_h.func_code & XPT_FC_USER_CCB) == 0)) {
528 ccb = cam_periph_getccb(periph,
529 inccb->ccb_h.pinfo.priority);
532 ccb = xpt_alloc_ccb_nowait();
535 xpt_setup_ccb(&ccb->ccb_h, periph->path,
536 inccb->ccb_h.pinfo.priority);
541 xpt_print(periph->path, "unable to allocate CCB\n");
546 error = passsendccb(periph, ccb, inccb);
551 xpt_release_ccb(ccb);
556 error = cam_periph_ioctl(periph, cmd, addr, passerror);
560 cam_periph_unlock(periph);
565 * Generally, "ccb" should be the CCB supplied by the kernel. "inccb"
566 * should be the CCB that is copied in from the user.
569 passsendccb(struct cam_periph *periph, union ccb *ccb, union ccb *inccb)
571 struct pass_softc *softc;
572 struct cam_periph_map_info mapinfo;
573 int error, need_unmap;
575 softc = (struct pass_softc *)periph->softc;
580 * There are some fields in the CCB header that need to be
581 * preserved, the rest we get from the user.
583 xpt_merge_ccb(ccb, inccb);
586 * There's no way for the user to have a completion
587 * function, so we put our own completion function in here.
589 ccb->ccb_h.cbfcnp = passdone;
592 * We only attempt to map the user memory into kernel space
593 * if they haven't passed in a physical memory pointer,
594 * and if there is actually an I/O operation to perform.
595 * cam_periph_mapmem() supports SCSI, ATA, SMP, ADVINFO and device
596 * match CCBs. For the SCSI, ATA and ADVINFO CCBs, we only pass the
597 * CCB in if there's actually data to map. cam_periph_mapmem() will
598 * do the right thing, even if there isn't data to map, but since CCBs
599 * without data are a reasonably common occurance (e.g. test unit
600 * ready), it will save a few cycles if we check for it here.
602 if (((ccb->ccb_h.flags & CAM_DATA_PHYS) == 0)
603 && (((ccb->ccb_h.func_code == XPT_SCSI_IO ||
604 ccb->ccb_h.func_code == XPT_ATA_IO)
605 && ((ccb->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE))
606 || (ccb->ccb_h.func_code == XPT_DEV_MATCH)
607 || (ccb->ccb_h.func_code == XPT_SMP_IO)
608 || ((ccb->ccb_h.func_code == XPT_DEV_ADVINFO)
609 && (ccb->cdai.bufsiz > 0)))) {
611 bzero(&mapinfo, sizeof(mapinfo));
614 * cam_periph_mapmem calls into proc and vm functions that can
615 * sleep as well as trigger I/O, so we can't hold the lock.
616 * Dropping it here is reasonably safe.
618 cam_periph_unlock(periph);
619 error = cam_periph_mapmem(ccb, &mapinfo);
620 cam_periph_lock(periph);
623 * cam_periph_mapmem returned an error, we can't continue.
624 * Return the error to the user.
630 * We successfully mapped the memory in, so we need to
631 * unmap it when the transaction is done.
637 * If the user wants us to perform any error recovery, then honor
638 * that request. Otherwise, it's up to the user to perform any
641 cam_periph_runccb(ccb,
642 (ccb->ccb_h.flags & CAM_PASS_ERR_RECOVER) ? passerror : NULL,
643 /* cam_flags */ CAM_RETRY_SELTO, /* sense_flags */SF_RETRY_UA,
644 softc->device_stats);
647 cam_periph_unmapmem(ccb, &mapinfo);
649 ccb->ccb_h.cbfcnp = NULL;
650 ccb->ccb_h.periph_priv = inccb->ccb_h.periph_priv;
651 bcopy(ccb, inccb, sizeof(union ccb));
657 passerror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
659 struct cam_periph *periph;
660 struct pass_softc *softc;
662 periph = xpt_path_periph(ccb->ccb_h.path);
663 softc = (struct pass_softc *)periph->softc;
665 return(cam_periph_error(ccb, cam_flags, sense_flags,