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 #include <cam/cam_xpt.h> 40 41 struct devstat; 42 43 extern struct cam_periph *xpt_periph; 44 45 extern struct periph_driver **periph_drivers; 46 void periphdriver_register(void *); 47 void periphdriver_init(int level); 48 49 #include <sys/module.h> 50 #define PERIPHDRIVER_DECLARE(name, driver) \ 51 static int name ## _modevent(module_t mod, int type, void *data) \ 52 { \ 53 switch (type) { \ 54 case MOD_LOAD: \ 55 periphdriver_register(data); \ 56 break; \ 57 case MOD_UNLOAD: \ 58 printf(#name " module unload - not possible for this module type\n"); \ 59 return EINVAL; \ 60 default: \ 61 return EOPNOTSUPP; \ 62 } \ 63 return 0; \ 64 } \ 65 static moduledata_t name ## _mod = { \ 66 #name, \ 67 name ## _modevent, \ 68 (void *)&driver \ 69 }; \ 70 DECLARE_MODULE(name, name ## _mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \ 71 MODULE_DEPEND(name, cam, 1, 1, 1) 72 73 typedef void (periph_init_t)(void); /* 74 * Callback informing the peripheral driver 75 * it can perform it's initialization since 76 * the XPT is now fully initialized. 77 */ 78 typedef periph_init_t *periph_init_func_t; 79 80 struct periph_driver { 81 periph_init_func_t init; 82 char *driver_name; 83 TAILQ_HEAD(,cam_periph) units; 84 u_int generation; 85 u_int flags; 86 #define CAM_PERIPH_DRV_EARLY 0x01 87 }; 88 89 typedef enum { 90 CAM_PERIPH_BIO 91 } cam_periph_type; 92 93 /* Generically useful offsets into the peripheral private area */ 94 #define ppriv_ptr0 periph_priv.entries[0].ptr 95 #define ppriv_ptr1 periph_priv.entries[1].ptr 96 #define ppriv_field0 periph_priv.entries[0].field 97 #define ppriv_field1 periph_priv.entries[1].field 98 99 typedef void periph_start_t (struct cam_periph *periph, 100 union ccb *start_ccb); 101 typedef cam_status periph_ctor_t (struct cam_periph *periph, 102 void *arg); 103 typedef void periph_oninv_t (struct cam_periph *periph); 104 typedef void periph_dtor_t (struct cam_periph *periph); 105 struct cam_periph { 106 cam_pinfo pinfo; 107 periph_start_t *periph_start; 108 periph_oninv_t *periph_oninval; 109 periph_dtor_t *periph_dtor; 110 char *periph_name; 111 struct cam_path *path; /* Compiled path to device */ 112 void *softc; 113 struct cam_sim *sim; 114 u_int32_t unit_number; 115 cam_periph_type type; 116 u_int32_t flags; 117 #define CAM_PERIPH_RUNNING 0x01 118 #define CAM_PERIPH_LOCKED 0x02 119 #define CAM_PERIPH_LOCK_WANTED 0x04 120 #define CAM_PERIPH_INVALID 0x08 121 #define CAM_PERIPH_NEW_DEV_FOUND 0x10 122 #define CAM_PERIPH_RECOVERY_INPROG 0x20 123 #define CAM_PERIPH_FREE 0x80 124 u_int32_t immediate_priority; 125 u_int32_t refcount; 126 SLIST_HEAD(, ccb_hdr) ccb_list; /* For "immediate" requests */ 127 SLIST_ENTRY(cam_periph) periph_links; 128 TAILQ_ENTRY(cam_periph) unit_links; 129 ac_callback_t *deferred_callback; 130 ac_code deferred_ac; 131 }; 132 133 #define CAM_PERIPH_MAXMAPS 2 134 135 struct cam_periph_map_info { 136 int num_bufs_used; 137 struct buf *bp[CAM_PERIPH_MAXMAPS]; 138 }; 139 140 cam_status cam_periph_alloc(periph_ctor_t *periph_ctor, 141 periph_oninv_t *periph_oninvalidate, 142 periph_dtor_t *periph_dtor, 143 periph_start_t *periph_start, 144 char *name, cam_periph_type type, struct cam_path *, 145 ac_callback_t *, ac_code, void *arg); 146 struct cam_periph *cam_periph_find(struct cam_path *path, char *name); 147 int cam_periph_list(struct cam_path *, struct sbuf *); 148 cam_status cam_periph_acquire(struct cam_periph *periph); 149 void cam_periph_release(struct cam_periph *periph); 150 void cam_periph_release_locked(struct cam_periph *periph); 151 void cam_periph_release_locked_buses(struct cam_periph *periph); 152 int cam_periph_hold(struct cam_periph *periph, int priority); 153 void cam_periph_unhold(struct cam_periph *periph); 154 void cam_periph_invalidate(struct cam_periph *periph); 155 int cam_periph_mapmem(union ccb *ccb, 156 struct cam_periph_map_info *mapinfo); 157 void cam_periph_unmapmem(union ccb *ccb, 158 struct cam_periph_map_info *mapinfo); 159 union ccb *cam_periph_getccb(struct cam_periph *periph, 160 u_int32_t priority); 161 void cam_periph_ccbwait(union ccb *ccb); 162 int cam_periph_runccb(union ccb *ccb, 163 int (*error_routine)(union ccb *ccb, 164 cam_flags camflags, 165 u_int32_t sense_flags), 166 cam_flags camflags, u_int32_t sense_flags, 167 struct devstat *ds); 168 int cam_periph_ioctl(struct cam_periph *periph, u_long cmd, 169 caddr_t addr, 170 int (*error_routine)(union ccb *ccb, 171 cam_flags camflags, 172 u_int32_t sense_flags)); 173 void cam_freeze_devq(struct cam_path *path); 174 u_int32_t cam_release_devq(struct cam_path *path, u_int32_t relsim_flags, 175 u_int32_t opening_reduction, u_int32_t arg, 176 int getcount_only); 177 void cam_periph_async(struct cam_periph *periph, u_int32_t code, 178 struct cam_path *path, void *arg); 179 void cam_periph_bus_settle(struct cam_periph *periph, 180 u_int bus_settle_ms); 181 void cam_periph_freeze_after_event(struct cam_periph *periph, 182 struct timeval* event_time, 183 u_int duration_ms); 184 int cam_periph_error(union ccb *ccb, cam_flags camflags, 185 u_int32_t sense_flags, union ccb *save_ccb); 186 187 static __inline void 188 cam_periph_lock(struct cam_periph *periph) 189 { 190 mtx_lock(periph->sim->mtx); 191 } 192 193 static __inline void 194 cam_periph_unlock(struct cam_periph *periph) 195 { 196 mtx_unlock(periph->sim->mtx); 197 } 198 199 static __inline int 200 cam_periph_owned(struct cam_periph *periph) 201 { 202 return (mtx_owned(periph->sim->mtx)); 203 } 204 205 static __inline int 206 cam_periph_sleep(struct cam_periph *periph, void *chan, int priority, 207 const char *wmesg, int timo) 208 { 209 return (msleep(chan, periph->sim->mtx, priority, wmesg, timo)); 210 } 211 212 static inline struct cam_periph * 213 cam_periph_acquire_first(struct periph_driver *driver) 214 { 215 struct cam_periph *periph; 216 217 xpt_lock_buses(); 218 periph = TAILQ_FIRST(&driver->units); 219 while (periph != NULL && (periph->flags & CAM_PERIPH_INVALID) != 0) 220 periph = TAILQ_NEXT(periph, unit_links); 221 if (periph != NULL) 222 periph->refcount++; 223 xpt_unlock_buses(); 224 return (periph); 225 } 226 227 static inline struct cam_periph * 228 cam_periph_acquire_next(struct cam_periph *pperiph) 229 { 230 struct cam_periph *periph = pperiph; 231 232 mtx_assert(pperiph->sim->mtx, MA_NOTOWNED); 233 xpt_lock_buses(); 234 do { 235 periph = TAILQ_NEXT(periph, unit_links); 236 } while (periph != NULL && (periph->flags & CAM_PERIPH_INVALID) != 0); 237 if (periph != NULL) 238 periph->refcount++; 239 xpt_unlock_buses(); 240 cam_periph_release(pperiph); 241 return (periph); 242 } 243 244 #define CAM_PERIPH_FOREACH(periph, driver) \ 245 for ((periph) = cam_periph_acquire_first(driver); \ 246 (periph) != NULL; \ 247 (periph) = cam_periph_acquire_next(periph)) 248 249 #endif /* _KERNEL */ 250 #endif /* _CAM_CAM_PERIPH_H */ 251