1 /* 2 * Data structures and definitions for CAM peripheral ("type") drivers. 3 * 4 * Copyright (c) 1997, 1998 Justin T. Gibbs. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions, and the following disclaimer, 12 * without modification, immediately at the beginning of the file. 13 * 2. The name of the author may not be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $Id$ 29 */ 30 31 #ifndef _CAM_CAM_PERIPH_H 32 #define _CAM_CAM_PERIPH_H 1 33 34 #include <sys/queue.h> 35 36 #ifdef KERNEL 37 38 extern struct linker_set periphdriver_set; 39 40 typedef void (periph_init_t)(void); /* 41 * Callback informing the peripheral driver 42 * it can perform it's initialization since 43 * the XPT is now fully initialized. 44 */ 45 typedef periph_init_t *periph_init_func_t; 46 47 struct periph_driver { 48 periph_init_func_t init; 49 char *driver_name; 50 TAILQ_HEAD(,cam_periph) units; 51 u_int generation; 52 }; 53 54 typedef enum { 55 CAM_PERIPH_BIO, 56 CAM_PERIPH_NET 57 } cam_periph_type; 58 59 /* Generically usefull offsets into the peripheral private area */ 60 #define ppriv_ptr0 periph_priv.entries[0].ptr 61 #define ppriv_ptr1 periph_priv.entries[1].ptr 62 #define ppriv_field0 periph_priv.entries[0].field 63 #define ppriv_field1 periph_priv.entries[1].field 64 65 typedef void periph_start_t (struct cam_periph *periph, 66 union ccb *start_ccb); 67 typedef cam_status periph_ctor_t (struct cam_periph *periph, 68 void *arg); 69 typedef void periph_dtor_t (struct cam_periph *periph); 70 71 struct cam_periph { 72 cam_pinfo pinfo; 73 periph_start_t *periph_start; 74 periph_dtor_t *periph_dtor; 75 char *periph_name; 76 struct cam_path *path; /* Compiled path to device */ 77 void *softc; 78 u_int32_t unit_number; 79 cam_periph_type type; 80 u_int32_t flags; 81 #define CAM_PERIPH_RUNNING 0x01 82 #define CAM_PERIPH_LOCKED 0x02 83 #define CAM_PERIPH_LOCK_WANTED 0x04 84 #define CAM_PERIPH_INVALID 0x08 85 #define CAM_PERIPH_NEW_DEV_FOUND 0x10 86 u_int32_t immediate_priority; 87 u_int32_t refcount; 88 SLIST_HEAD(, ccb_hdr) ccb_list; /* For "immediate" requests */ 89 SLIST_ENTRY(cam_periph) periph_links; 90 TAILQ_ENTRY(cam_periph) unit_links; 91 ac_callback_t *deferred_callback; 92 ac_code deferred_ac; 93 }; 94 95 #define CAM_PERIPH_MAXMAPS 2 96 97 struct cam_periph_map_info { 98 int num_bufs_used; 99 struct buf *bp[CAM_PERIPH_MAXMAPS]; 100 }; 101 102 cam_status cam_periph_alloc(periph_ctor_t*, periph_dtor_t*, periph_start_t*, 103 char *name, cam_periph_type type, struct cam_path *, ac_callback_t *, ac_code, void *arg); 104 struct cam_periph *cam_periph_find(struct cam_path *path, char *name); 105 int cam_periph_lock(struct cam_periph *periph, int priority); 106 void cam_periph_unlock(struct cam_periph *periph); 107 cam_status cam_periph_acquire(struct cam_periph *periph); 108 void cam_periph_release(struct cam_periph *periph); 109 void cam_periph_invalidate(struct cam_periph *periph); 110 int cam_periph_mapmem(union ccb *ccb, 111 struct cam_periph_map_info *mapinfo); 112 void cam_periph_unmapmem(union ccb *ccb, 113 struct cam_periph_map_info *mapinfo); 114 union ccb *cam_periph_getccb(struct cam_periph *periph, 115 u_int32_t priority); 116 void cam_periph_ccbwait(union ccb *ccb); 117 int cam_periph_runccb(union ccb *ccb, 118 int (*error_routine)(union ccb *ccb, 119 cam_flags camflags, 120 u_int32_t sense_flags), 121 cam_flags camflags, u_int32_t sense_flags, 122 struct devstat *ds); 123 int cam_periph_ioctl(struct cam_periph *periph, int cmd, 124 caddr_t addr, 125 int (*error_routine)(union ccb *ccb, 126 cam_flags camflags, 127 u_int32_t sense_flags)); 128 u_int32_t cam_release_devq(struct cam_path *path, u_int32_t relsim_flags, 129 u_int32_t opening_reduction, u_int32_t timeout, 130 int getcount_only); 131 int cam_periph_error(union ccb *ccb, cam_flags camflags, 132 u_int32_t sense_flags, union ccb *save_ccb); 133 134 #endif /* KERNEL */ 135 #endif /* _CAM_CAM_PERIPH_H */ 136