1 /*- 2 * Data structures and definitions for CAM peripheral ("type") drivers. 3 * 4 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 5 * 6 * Copyright (c) 1997, 1998 Justin T. Gibbs. 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions, and the following disclaimer, 14 * without modification, immediately at the beginning of the file. 15 * 2. The name of the author may not be used to endorse or promote products 16 * derived from this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 22 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 * $FreeBSD$ 31 */ 32 33 #ifndef _CAM_CAM_PERIPH_H 34 #define _CAM_CAM_PERIPH_H 1 35 36 #include <sys/queue.h> 37 #include <cam/cam_sim.h> 38 39 #ifdef _KERNEL 40 #include <sys/taskqueue.h> 41 42 #include <cam/cam_xpt.h> 43 44 struct devstat; 45 46 extern struct cam_periph *xpt_periph; 47 48 extern struct periph_driver **periph_drivers; 49 void periphdriver_register(void *); 50 int periphdriver_unregister(void *); 51 void periphdriver_init(int level); 52 53 #include <sys/module.h> 54 #define PERIPHDRIVER_DECLARE(name, driver) \ 55 static int name ## _modevent(module_t mod, int type, void *data) \ 56 { \ 57 switch (type) { \ 58 case MOD_LOAD: \ 59 periphdriver_register(data); \ 60 break; \ 61 case MOD_UNLOAD: \ 62 return (periphdriver_unregister(data)); \ 63 default: \ 64 return EOPNOTSUPP; \ 65 } \ 66 return 0; \ 67 } \ 68 static moduledata_t name ## _mod = { \ 69 #name, \ 70 name ## _modevent, \ 71 (void *)&driver \ 72 }; \ 73 DECLARE_MODULE(name, name ## _mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \ 74 MODULE_DEPEND(name, cam, 1, 1, 1) 75 76 /* 77 * Callback informing the peripheral driver it can perform it's 78 * initialization since the XPT is now fully initialized. 79 */ 80 typedef void (periph_init_t)(void); 81 82 /* 83 * Callback requesting the peripheral driver to remove its instances 84 * and shutdown, if possible. 85 */ 86 typedef int (periph_deinit_t)(void); 87 88 struct periph_driver { 89 periph_init_t *init; 90 char *driver_name; 91 TAILQ_HEAD(,cam_periph) units; 92 u_int generation; 93 u_int flags; 94 #define CAM_PERIPH_DRV_EARLY 0x01 95 periph_deinit_t *deinit; 96 }; 97 98 typedef enum { 99 CAM_PERIPH_BIO 100 } cam_periph_type; 101 102 /* Generically useful offsets into the peripheral private area */ 103 #define ppriv_ptr0 periph_priv.entries[0].ptr 104 #define ppriv_ptr1 periph_priv.entries[1].ptr 105 #define ppriv_field0 periph_priv.entries[0].field 106 #define ppriv_field1 periph_priv.entries[1].field 107 108 typedef void periph_start_t (struct cam_periph *periph, 109 union ccb *start_ccb); 110 typedef cam_status periph_ctor_t (struct cam_periph *periph, 111 void *arg); 112 typedef void periph_oninv_t (struct cam_periph *periph); 113 typedef void periph_dtor_t (struct cam_periph *periph); 114 struct cam_periph { 115 periph_start_t *periph_start; 116 periph_oninv_t *periph_oninval; 117 periph_dtor_t *periph_dtor; 118 char *periph_name; 119 struct cam_path *path; /* Compiled path to device */ 120 void *softc; 121 struct cam_sim *sim; 122 u_int32_t unit_number; 123 cam_periph_type type; 124 u_int32_t flags; 125 #define CAM_PERIPH_RUNNING 0x01 126 #define CAM_PERIPH_LOCKED 0x02 127 #define CAM_PERIPH_LOCK_WANTED 0x04 128 #define CAM_PERIPH_INVALID 0x08 129 #define CAM_PERIPH_NEW_DEV_FOUND 0x10 130 #define CAM_PERIPH_RECOVERY_INPROG 0x20 131 #define CAM_PERIPH_RUN_TASK 0x40 132 #define CAM_PERIPH_FREE 0x80 133 #define CAM_PERIPH_ANNOUNCED 0x100 134 uint32_t scheduled_priority; 135 uint32_t immediate_priority; 136 int periph_allocating; 137 int periph_allocated; 138 u_int32_t refcount; 139 SLIST_HEAD(, ccb_hdr) ccb_list; /* For "immediate" requests */ 140 SLIST_ENTRY(cam_periph) periph_links; 141 TAILQ_ENTRY(cam_periph) unit_links; 142 ac_callback_t *deferred_callback; 143 ac_code deferred_ac; 144 struct task periph_run_task; 145 }; 146 147 #define CAM_PERIPH_MAXMAPS 2 148 149 struct cam_periph_map_info { 150 int num_bufs_used; 151 struct buf *bp[CAM_PERIPH_MAXMAPS]; 152 }; 153 154 cam_status cam_periph_alloc(periph_ctor_t *periph_ctor, 155 periph_oninv_t *periph_oninvalidate, 156 periph_dtor_t *periph_dtor, 157 periph_start_t *periph_start, 158 char *name, cam_periph_type type, struct cam_path *, 159 ac_callback_t *, ac_code, void *arg); 160 struct cam_periph *cam_periph_find(struct cam_path *path, char *name); 161 int cam_periph_list(struct cam_path *, struct sbuf *); 162 cam_status cam_periph_acquire(struct cam_periph *periph); 163 void cam_periph_doacquire(struct cam_periph *periph); 164 void cam_periph_release(struct cam_periph *periph); 165 void cam_periph_release_locked(struct cam_periph *periph); 166 void cam_periph_release_locked_buses(struct cam_periph *periph); 167 int cam_periph_hold(struct cam_periph *periph, int priority); 168 void cam_periph_unhold(struct cam_periph *periph); 169 void cam_periph_invalidate(struct cam_periph *periph); 170 int cam_periph_mapmem(union ccb *ccb, 171 struct cam_periph_map_info *mapinfo, 172 u_int maxmap); 173 void cam_periph_unmapmem(union ccb *ccb, 174 struct cam_periph_map_info *mapinfo); 175 union ccb *cam_periph_getccb(struct cam_periph *periph, 176 u_int32_t priority); 177 int cam_periph_runccb(union ccb *ccb, 178 int (*error_routine)(union ccb *ccb, 179 cam_flags camflags, 180 u_int32_t sense_flags), 181 cam_flags camflags, u_int32_t sense_flags, 182 struct devstat *ds); 183 int cam_periph_ioctl(struct cam_periph *periph, u_long cmd, 184 caddr_t addr, 185 int (*error_routine)(union ccb *ccb, 186 cam_flags camflags, 187 u_int32_t sense_flags)); 188 void cam_freeze_devq(struct cam_path *path); 189 u_int32_t cam_release_devq(struct cam_path *path, u_int32_t relsim_flags, 190 u_int32_t opening_reduction, u_int32_t arg, 191 int getcount_only); 192 void cam_periph_async(struct cam_periph *periph, u_int32_t code, 193 struct cam_path *path, void *arg); 194 void cam_periph_bus_settle(struct cam_periph *periph, 195 u_int bus_settle_ms); 196 void cam_periph_freeze_after_event(struct cam_periph *periph, 197 struct timeval* event_time, 198 u_int duration_ms); 199 int cam_periph_error(union ccb *ccb, cam_flags camflags, 200 u_int32_t sense_flags, union ccb *save_ccb); 201 202 static __inline struct mtx * 203 cam_periph_mtx(struct cam_periph *periph) 204 { 205 return (xpt_path_mtx(periph->path)); 206 } 207 208 #define cam_periph_owned(periph) \ 209 mtx_owned(xpt_path_mtx((periph)->path)) 210 211 #define cam_periph_lock(periph) \ 212 mtx_lock(xpt_path_mtx((periph)->path)) 213 214 #define cam_periph_unlock(periph) \ 215 mtx_unlock(xpt_path_mtx((periph)->path)) 216 217 #define cam_periph_assert(periph, what) \ 218 mtx_assert(xpt_path_mtx((periph)->path), (what)) 219 220 #define cam_periph_sleep(periph, chan, priority, wmesg, timo) \ 221 xpt_path_sleep((periph)->path, (chan), (priority), (wmesg), (timo)) 222 223 static inline struct cam_periph * 224 cam_periph_acquire_first(struct periph_driver *driver) 225 { 226 struct cam_periph *periph; 227 228 xpt_lock_buses(); 229 periph = TAILQ_FIRST(&driver->units); 230 while (periph != NULL && (periph->flags & CAM_PERIPH_INVALID) != 0) 231 periph = TAILQ_NEXT(periph, unit_links); 232 if (periph != NULL) 233 periph->refcount++; 234 xpt_unlock_buses(); 235 return (periph); 236 } 237 238 static inline struct cam_periph * 239 cam_periph_acquire_next(struct cam_periph *pperiph) 240 { 241 struct cam_periph *periph = pperiph; 242 243 cam_periph_assert(pperiph, MA_NOTOWNED); 244 xpt_lock_buses(); 245 do { 246 periph = TAILQ_NEXT(periph, unit_links); 247 } while (periph != NULL && (periph->flags & CAM_PERIPH_INVALID) != 0); 248 if (periph != NULL) 249 periph->refcount++; 250 xpt_unlock_buses(); 251 cam_periph_release(pperiph); 252 return (periph); 253 } 254 255 #define CAM_PERIPH_FOREACH(periph, driver) \ 256 for ((periph) = cam_periph_acquire_first(driver); \ 257 (periph) != NULL; \ 258 (periph) = cam_periph_acquire_next(periph)) 259 260 #endif /* _KERNEL */ 261 #endif /* _CAM_CAM_PERIPH_H */ 262