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>
44 #include <cam/cam_ccb.h>
45 #include <cam/cam_periph.h>
46 #include <cam/cam_queue.h>
47 #include <cam/cam_xpt_periph.h>
48 #include <cam/cam_debug.h>
49 #include <cam/cam_sim.h>
51 #include <cam/scsi/scsi_all.h>
52 #include <cam/scsi/scsi_pass.h>
55 PASS_FLAG_OPEN = 0x01,
56 PASS_FLAG_LOCKED = 0x02,
57 PASS_FLAG_INVALID = 0x04
69 #define ccb_type ppriv_field0
70 #define ccb_bp ppriv_ptr1
77 struct devstat *device_stats;
82 static d_open_t passopen;
83 static d_close_t passclose;
84 static d_ioctl_t passioctl;
86 static periph_init_t passinit;
87 static periph_ctor_t passregister;
88 static periph_oninv_t passoninvalidate;
89 static periph_dtor_t passcleanup;
90 static periph_start_t passstart;
91 static void passasync(void *callback_arg, u_int32_t code,
92 struct cam_path *path, void *arg);
93 static void passdone(struct cam_periph *periph,
95 static int passerror(union ccb *ccb, u_int32_t cam_flags,
96 u_int32_t sense_flags);
97 static int passsendccb(struct cam_periph *periph, union ccb *ccb,
100 static struct periph_driver passdriver =
103 TAILQ_HEAD_INITIALIZER(passdriver.units), /* generation */ 0
106 PERIPHDRIVER_DECLARE(pass, passdriver);
108 static struct cdevsw pass_cdevsw = {
109 .d_version = D_VERSION,
112 .d_close = passclose,
113 .d_ioctl = passioctl,
123 * Install a global async callback. This callback will
124 * receive async callbacks like "new device found".
126 status = xpt_register_async(AC_FOUND_DEVICE, passasync, NULL, NULL);
128 if (status != CAM_REQ_CMP) {
129 printf("pass: Failed to attach master async callback "
130 "due to status 0x%x!\n", status);
136 passoninvalidate(struct cam_periph *periph)
138 struct pass_softc *softc;
140 softc = (struct pass_softc *)periph->softc;
143 * De-register any async callbacks.
145 xpt_register_async(0, passasync, periph, periph->path);
147 softc->flags |= PASS_FLAG_INVALID;
150 * XXX Return all queued I/O with ENXIO.
151 * XXX Handle any transactions queued to the card
152 * with XPT_ABORT_CCB.
156 xpt_print(periph->path, "lost device\n");
162 passcleanup(struct cam_periph *periph)
164 struct pass_softc *softc;
166 softc = (struct pass_softc *)periph->softc;
169 xpt_print(periph->path, "removing device entry\n");
170 devstat_remove_entry(softc->device_stats);
171 cam_periph_unlock(periph);
173 * passcleanup() is indirectly a d_close method via passclose,
174 * so using destroy_dev(9) directly can result in deadlock.
176 destroy_dev_sched(softc->dev);
177 cam_periph_lock(periph);
178 free(softc, M_DEVBUF);
182 passasync(void *callback_arg, u_int32_t code,
183 struct cam_path *path, void *arg)
185 struct cam_periph *periph;
187 periph = (struct cam_periph *)callback_arg;
190 case AC_FOUND_DEVICE:
192 struct ccb_getdev *cgd;
195 cgd = (struct ccb_getdev *)arg;
200 * Allocate a peripheral instance for
201 * this device and start the probe
204 status = cam_periph_alloc(passregister, passoninvalidate,
205 passcleanup, passstart, "pass",
206 CAM_PERIPH_BIO, cgd->ccb_h.path,
207 passasync, AC_FOUND_DEVICE, cgd);
209 if (status != CAM_REQ_CMP
210 && status != CAM_REQ_INPROG) {
211 const struct cam_status_entry *entry;
213 entry = cam_fetch_status_entry(status);
215 printf("passasync: Unable to attach new device "
216 "due to status %#x: %s\n", status, entry ?
217 entry->status_text : "Unknown");
223 cam_periph_async(periph, code, path, arg);
229 passregister(struct cam_periph *periph, void *arg)
231 struct pass_softc *softc;
232 struct ccb_getdev *cgd;
235 cgd = (struct ccb_getdev *)arg;
236 if (periph == NULL) {
237 printf("passregister: periph was NULL!!\n");
238 return(CAM_REQ_CMP_ERR);
242 printf("passregister: no getdev CCB, can't register device\n");
243 return(CAM_REQ_CMP_ERR);
246 softc = (struct pass_softc *)malloc(sizeof(*softc),
250 printf("passregister: Unable to probe new device. "
251 "Unable to allocate softc\n");
252 return(CAM_REQ_CMP_ERR);
255 bzero(softc, sizeof(*softc));
256 softc->state = PASS_STATE_NORMAL;
257 softc->pd_type = SID_TYPE(&cgd->inq_data);
259 periph->softc = softc;
262 * We pass in 0 for a blocksize, since we don't
263 * know what the blocksize of this device is, if
264 * it even has a blocksize.
266 mtx_unlock(periph->sim->mtx);
267 no_tags = (cgd->inq_data.flags & SID_CmdQue) == 0;
268 softc->device_stats = devstat_new_entry("pass",
269 periph->unit_number, 0,
271 | (no_tags ? DEVSTAT_NO_ORDERED_TAGS : 0),
273 DEVSTAT_TYPE_IF_SCSI |
275 DEVSTAT_PRIORITY_PASS);
277 /* Register the device */
278 softc->dev = make_dev(&pass_cdevsw, periph->unit_number,
279 UID_ROOT, GID_OPERATOR, 0600, "%s%d",
280 periph->periph_name, periph->unit_number);
281 mtx_lock(periph->sim->mtx);
282 softc->dev->si_drv1 = periph;
285 * Add an async callback so that we get
286 * notified if this device goes away.
288 xpt_register_async(AC_LOST_DEVICE, passasync, periph, periph->path);
291 xpt_announce_periph(periph, NULL);
297 passopen(struct cdev *dev, int flags, int fmt, struct thread *td)
299 struct cam_periph *periph;
300 struct pass_softc *softc;
303 periph = (struct cam_periph *)dev->si_drv1;
304 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
307 cam_periph_lock(periph);
309 softc = (struct pass_softc *)periph->softc;
311 if (softc->flags & PASS_FLAG_INVALID) {
312 cam_periph_unlock(periph);
313 cam_periph_release(periph);
318 * Don't allow access when we're running at a high securelevel.
320 error = securelevel_gt(td->td_ucred, 1);
322 cam_periph_unlock(periph);
323 cam_periph_release(periph);
328 * Only allow read-write access.
330 if (((flags & FWRITE) == 0) || ((flags & FREAD) == 0)) {
331 cam_periph_unlock(periph);
332 cam_periph_release(periph);
337 * We don't allow nonblocking access.
339 if ((flags & O_NONBLOCK) != 0) {
340 xpt_print(periph->path, "can't do nonblocking access\n");
341 cam_periph_unlock(periph);
342 cam_periph_release(periph);
346 if ((softc->flags & PASS_FLAG_OPEN) == 0) {
347 softc->flags |= PASS_FLAG_OPEN;
348 cam_periph_unlock(periph);
350 /* Device closes aren't symmertical, so fix up the refcount */
351 cam_periph_unlock(periph);
352 cam_periph_release(periph);
359 passclose(struct cdev *dev, int flag, int fmt, struct thread *td)
361 struct cam_periph *periph;
362 struct pass_softc *softc;
364 periph = (struct cam_periph *)dev->si_drv1;
368 cam_periph_lock(periph);
370 softc = (struct pass_softc *)periph->softc;
371 softc->flags &= ~PASS_FLAG_OPEN;
373 cam_periph_unlock(periph);
374 cam_periph_release(periph);
380 passstart(struct cam_periph *periph, union ccb *start_ccb)
382 struct pass_softc *softc;
384 softc = (struct pass_softc *)periph->softc;
386 switch (softc->state) {
387 case PASS_STATE_NORMAL:
388 start_ccb->ccb_h.ccb_type = PASS_CCB_WAITING;
389 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
391 periph->immediate_priority = CAM_PRIORITY_NONE;
392 wakeup(&periph->ccb_list);
398 passdone(struct cam_periph *periph, union ccb *done_ccb)
400 struct pass_softc *softc;
401 struct ccb_scsiio *csio;
403 softc = (struct pass_softc *)periph->softc;
404 csio = &done_ccb->csio;
405 switch (csio->ccb_h.ccb_type) {
406 case PASS_CCB_WAITING:
407 /* Caller will release the CCB */
408 wakeup(&done_ccb->ccb_h.cbfcnp);
411 xpt_release_ccb(done_ccb);
415 passioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
417 struct cam_periph *periph;
418 struct pass_softc *softc;
421 periph = (struct cam_periph *)dev->si_drv1;
425 cam_periph_lock(periph);
426 softc = (struct pass_softc *)periph->softc;
438 inccb = (union ccb *)addr;
441 * Some CCB types, like scan bus and scan lun can only go
442 * through the transport layer device.
444 if (inccb->ccb_h.func_code & XPT_FC_XPT_ONLY) {
445 xpt_print(periph->path, "CCB function code %#x is "
446 "restricted to the XPT device\n",
447 inccb->ccb_h.func_code);
453 * Non-immediate CCBs need a CCB from the per-device pool
454 * of CCBs, which is scheduled by the transport layer.
455 * Immediate CCBs and user-supplied CCBs should just be
458 if ((inccb->ccb_h.func_code & XPT_FC_QUEUED)
459 && ((inccb->ccb_h.func_code & XPT_FC_USER_CCB) == 0)) {
460 ccb = cam_periph_getccb(periph,
461 inccb->ccb_h.pinfo.priority);
464 ccb = xpt_alloc_ccb_nowait();
467 xpt_setup_ccb(&ccb->ccb_h, periph->path,
468 inccb->ccb_h.pinfo.priority);
473 xpt_print(periph->path, "unable to allocate CCB\n");
478 error = passsendccb(periph, ccb, inccb);
483 xpt_release_ccb(ccb);
488 error = cam_periph_ioctl(periph, cmd, addr, passerror);
492 cam_periph_unlock(periph);
497 * Generally, "ccb" should be the CCB supplied by the kernel. "inccb"
498 * should be the CCB that is copied in from the user.
501 passsendccb(struct cam_periph *periph, union ccb *ccb, union ccb *inccb)
503 struct pass_softc *softc;
504 struct cam_periph_map_info mapinfo;
505 int error, need_unmap;
507 softc = (struct pass_softc *)periph->softc;
512 * There are some fields in the CCB header that need to be
513 * preserved, the rest we get from the user.
515 xpt_merge_ccb(ccb, inccb);
518 * There's no way for the user to have a completion
519 * function, so we put our own completion function in here.
521 ccb->ccb_h.cbfcnp = passdone;
524 * We only attempt to map the user memory into kernel space
525 * if they haven't passed in a physical memory pointer,
526 * and if there is actually an I/O operation to perform.
527 * Right now cam_periph_mapmem() only supports SCSI and device
528 * match CCBs. For the SCSI CCBs, we only pass the CCB in if
529 * there's actually data to map. cam_periph_mapmem() will do the
530 * right thing, even if there isn't data to map, but since CCBs
531 * without data are a reasonably common occurance (e.g. test unit
532 * ready), it will save a few cycles if we check for it here.
534 if (((ccb->ccb_h.flags & CAM_DATA_PHYS) == 0)
535 && (((ccb->ccb_h.func_code == XPT_SCSI_IO ||
536 ccb->ccb_h.func_code == XPT_ATA_IO)
537 && ((ccb->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE))
538 || (ccb->ccb_h.func_code == XPT_DEV_MATCH))) {
540 bzero(&mapinfo, sizeof(mapinfo));
543 * cam_periph_mapmem calls into proc and vm functions that can
544 * sleep as well as trigger I/O, so we can't hold the lock.
545 * Dropping it here is reasonably safe.
547 cam_periph_unlock(periph);
548 error = cam_periph_mapmem(ccb, &mapinfo);
549 cam_periph_lock(periph);
552 * cam_periph_mapmem returned an error, we can't continue.
553 * Return the error to the user.
559 * We successfully mapped the memory in, so we need to
560 * unmap it when the transaction is done.
566 * If the user wants us to perform any error recovery, then honor
567 * that request. Otherwise, it's up to the user to perform any
570 cam_periph_runccb(ccb,
571 (ccb->ccb_h.flags & CAM_PASS_ERR_RECOVER) ? passerror : NULL,
572 /* cam_flags */ CAM_RETRY_SELTO, /* sense_flags */SF_RETRY_UA,
573 softc->device_stats);
576 cam_periph_unmapmem(ccb, &mapinfo);
578 ccb->ccb_h.cbfcnp = NULL;
579 ccb->ccb_h.periph_priv = inccb->ccb_h.periph_priv;
580 bcopy(ccb, inccb, sizeof(union ccb));
586 passerror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
588 struct cam_periph *periph;
589 struct pass_softc *softc;
591 periph = xpt_path_periph(ccb->ccb_h.path);
592 softc = (struct pass_softc *)periph->softc;
594 return(cam_periph_error(ccb, cam_flags, sense_flags,