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 * $FreeBSD$ 29 */ 30 31 #ifndef _CAM_CAM_PERIPH_H 32 #define _CAM_CAM_PERIPH_H 1 33 34 #include <sys/queue.h> 35 #include <cam/cam_sim.h> 36 37 #ifdef _KERNEL 38 39 struct devstat; 40 41 extern struct cam_periph *xpt_periph; 42 43 extern struct periph_driver **periph_drivers; 44 void periphdriver_register(void *); 45 46 #include <sys/module.h> 47 #define PERIPHDRIVER_DECLARE(name, driver) \ 48 static int name ## _modevent(module_t mod, int type, void *data) \ 49 { \ 50 switch (type) { \ 51 case MOD_LOAD: \ 52 periphdriver_register(data); \ 53 break; \ 54 case MOD_UNLOAD: \ 55 printf(#name " module unload - not possible for this module type\n"); \ 56 return EINVAL; \ 57 default: \ 58 return EOPNOTSUPP; \ 59 } \ 60 return 0; \ 61 } \ 62 static moduledata_t name ## _mod = { \ 63 #name, \ 64 name ## _modevent, \ 65 (void *)&driver \ 66 }; \ 67 DECLARE_MODULE(name, name ## _mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \ 68 MODULE_DEPEND(name, cam, 1, 1, 1) 69 70 typedef void (periph_init_t)(void); /* 71 * Callback informing the peripheral driver 72 * it can perform it's initialization since 73 * the XPT is now fully initialized. 74 */ 75 typedef periph_init_t *periph_init_func_t; 76 77 struct periph_driver { 78 periph_init_func_t init; 79 char *driver_name; 80 TAILQ_HEAD(,cam_periph) units; 81 u_int generation; 82 u_int flags; 83 #define CAM_PERIPH_DRV_EARLY 0x01 84 }; 85 86 typedef enum { 87 CAM_PERIPH_BIO 88 } cam_periph_type; 89 90 /* Generically usefull offsets into the peripheral private area */ 91 #define ppriv_ptr0 periph_priv.entries[0].ptr 92 #define ppriv_ptr1 periph_priv.entries[1].ptr 93 #define ppriv_field0 periph_priv.entries[0].field 94 #define ppriv_field1 periph_priv.entries[1].field 95 96 typedef void periph_start_t (struct cam_periph *periph, 97 union ccb *start_ccb); 98 typedef cam_status periph_ctor_t (struct cam_periph *periph, 99 void *arg); 100 typedef void periph_oninv_t (struct cam_periph *periph); 101 typedef void periph_dtor_t (struct cam_periph *periph); 102 struct cam_periph { 103 cam_pinfo pinfo; 104 periph_start_t *periph_start; 105 periph_oninv_t *periph_oninval; 106 periph_dtor_t *periph_dtor; 107 char *periph_name; 108 struct cam_path *path; /* Compiled path to device */ 109 void *softc; 110 struct cam_sim *sim; 111 u_int32_t unit_number; 112 cam_periph_type type; 113 u_int32_t flags; 114 #define CAM_PERIPH_RUNNING 0x01 115 #define CAM_PERIPH_LOCKED 0x02 116 #define CAM_PERIPH_LOCK_WANTED 0x04 117 #define CAM_PERIPH_INVALID 0x08 118 #define CAM_PERIPH_NEW_DEV_FOUND 0x10 119 #define CAM_PERIPH_RECOVERY_INPROG 0x20 120 u_int32_t immediate_priority; 121 u_int32_t refcount; 122 SLIST_HEAD(, ccb_hdr) ccb_list; /* For "immediate" requests */ 123 SLIST_ENTRY(cam_periph) periph_links; 124 TAILQ_ENTRY(cam_periph) unit_links; 125 ac_callback_t *deferred_callback; 126 ac_code deferred_ac; 127 }; 128 129 #define CAM_PERIPH_MAXMAPS 2 130 131 struct cam_periph_map_info { 132 int num_bufs_used; 133 struct buf *bp[CAM_PERIPH_MAXMAPS]; 134 }; 135 136 cam_status cam_periph_alloc(periph_ctor_t *periph_ctor, 137 periph_oninv_t *periph_oninvalidate, 138 periph_dtor_t *periph_dtor, 139 periph_start_t *periph_start, 140 char *name, cam_periph_type type, struct cam_path *, 141 ac_callback_t *, ac_code, void *arg); 142 struct cam_periph *cam_periph_find(struct cam_path *path, char *name); 143 cam_status cam_periph_acquire(struct cam_periph *periph); 144 void cam_periph_release(struct cam_periph *periph); 145 void cam_periph_release_locked(struct cam_periph *periph); 146 int cam_periph_hold(struct cam_periph *periph, int priority); 147 void cam_periph_unhold(struct cam_periph *periph); 148 void cam_periph_invalidate(struct cam_periph *periph); 149 int cam_periph_mapmem(union ccb *ccb, 150 struct cam_periph_map_info *mapinfo); 151 void cam_periph_unmapmem(union ccb *ccb, 152 struct cam_periph_map_info *mapinfo); 153 union ccb *cam_periph_getccb(struct cam_periph *periph, 154 u_int32_t priority); 155 void cam_periph_ccbwait(union ccb *ccb); 156 int cam_periph_runccb(union ccb *ccb, 157 int (*error_routine)(union ccb *ccb, 158 cam_flags camflags, 159 u_int32_t sense_flags), 160 cam_flags camflags, u_int32_t sense_flags, 161 struct devstat *ds); 162 int cam_periph_ioctl(struct cam_periph *periph, u_long cmd, 163 caddr_t addr, 164 int (*error_routine)(union ccb *ccb, 165 cam_flags camflags, 166 u_int32_t sense_flags)); 167 void cam_freeze_devq(struct cam_path *path); 168 u_int32_t cam_release_devq(struct cam_path *path, u_int32_t relsim_flags, 169 u_int32_t opening_reduction, u_int32_t timeout, 170 int getcount_only); 171 void cam_periph_async(struct cam_periph *periph, u_int32_t code, 172 struct cam_path *path, void *arg); 173 void cam_periph_bus_settle(struct cam_periph *periph, 174 u_int bus_settle_ms); 175 void cam_periph_freeze_after_event(struct cam_periph *periph, 176 struct timeval* event_time, 177 u_int duration_ms); 178 int cam_periph_error(union ccb *ccb, cam_flags camflags, 179 u_int32_t sense_flags, union ccb *save_ccb); 180 181 static __inline void 182 cam_periph_lock(struct cam_periph *periph) 183 { 184 mtx_lock(periph->sim->mtx); 185 } 186 187 static __inline void 188 cam_periph_unlock(struct cam_periph *periph) 189 { 190 mtx_unlock(periph->sim->mtx); 191 } 192 193 static __inline int 194 cam_periph_owned(struct cam_periph *periph) 195 { 196 return (mtx_owned(periph->sim->mtx)); 197 } 198 199 #endif /* _KERNEL */ 200 #endif /* _CAM_CAM_PERIPH_H */ 201