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