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