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