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 41struct devstat; 42 43extern struct cam_periph *xpt_periph; 44 45extern struct periph_driver **periph_drivers; 46void periphdriver_register(void *); 47void 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 73typedef 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 */ 78typedef periph_init_t *periph_init_func_t; 79 80struct 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 89typedef 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 99typedef void periph_start_t (struct cam_periph *periph, 100 union ccb *start_ccb); 101typedef cam_status periph_ctor_t (struct cam_periph *periph, 102 void *arg); 103typedef void periph_oninv_t (struct cam_periph *periph); 104typedef void periph_dtor_t (struct cam_periph *periph); 105struct 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#define CAM_PERIPH_ANNOUNCED 0x100 125 u_int32_t immediate_priority; 126 u_int32_t refcount; 127 SLIST_HEAD(, ccb_hdr) ccb_list; /* For "immediate" requests */ 128 SLIST_ENTRY(cam_periph) periph_links; 129 TAILQ_ENTRY(cam_periph) unit_links; 130 ac_callback_t *deferred_callback; 131 ac_code deferred_ac; 132}; 133 134#define CAM_PERIPH_MAXMAPS 2 135 136struct cam_periph_map_info { 137 int num_bufs_used; 138 struct buf *bp[CAM_PERIPH_MAXMAPS]; 139}; 140 141cam_status cam_periph_alloc(periph_ctor_t *periph_ctor, 142 periph_oninv_t *periph_oninvalidate, 143 periph_dtor_t *periph_dtor, 144 periph_start_t *periph_start, 145 char *name, cam_periph_type type, struct cam_path *, 146 ac_callback_t *, ac_code, void *arg); 147struct cam_periph *cam_periph_find(struct cam_path *path, char *name); 148int cam_periph_list(struct cam_path *, struct sbuf *); 149cam_status cam_periph_acquire(struct cam_periph *periph); 150void cam_periph_release(struct cam_periph *periph); 151void cam_periph_release_locked(struct cam_periph *periph); 152void cam_periph_release_locked_buses(struct cam_periph *periph); 153int cam_periph_hold(struct cam_periph *periph, int priority); 154void cam_periph_unhold(struct cam_periph *periph); 155void cam_periph_invalidate(struct cam_periph *periph); 156int cam_periph_mapmem(union ccb *ccb, 157 struct cam_periph_map_info *mapinfo); 158void cam_periph_unmapmem(union ccb *ccb, 159 struct cam_periph_map_info *mapinfo); 160union ccb *cam_periph_getccb(struct cam_periph *periph, 161 u_int32_t priority); 162void cam_periph_ccbwait(union ccb *ccb); 163int cam_periph_runccb(union ccb *ccb, 164 int (*error_routine)(union ccb *ccb, 165 cam_flags camflags, 166 u_int32_t sense_flags), 167 cam_flags camflags, u_int32_t sense_flags, 168 struct devstat *ds); 169int cam_periph_ioctl(struct cam_periph *periph, u_long cmd, 170 caddr_t addr, 171 int (*error_routine)(union ccb *ccb, 172 cam_flags camflags, 173 u_int32_t sense_flags)); 174void cam_freeze_devq(struct cam_path *path); 175u_int32_t cam_release_devq(struct cam_path *path, u_int32_t relsim_flags, 176 u_int32_t opening_reduction, u_int32_t arg, 177 int getcount_only); 178void cam_periph_async(struct cam_periph *periph, u_int32_t code, 179 struct cam_path *path, void *arg); 180void cam_periph_bus_settle(struct cam_periph *periph, 181 u_int bus_settle_ms); 182void cam_periph_freeze_after_event(struct cam_periph *periph, 183 struct timeval* event_time, 184 u_int duration_ms); 185int cam_periph_error(union ccb *ccb, cam_flags camflags, 186 u_int32_t sense_flags, union ccb *save_ccb); 187 188static __inline void 189cam_periph_lock(struct cam_periph *periph) 190{ 191 mtx_lock(periph->sim->mtx); 192} 193 194static __inline void 195cam_periph_unlock(struct cam_periph *periph) 196{ 197 mtx_unlock(periph->sim->mtx); 198} 199 200static __inline int 201cam_periph_owned(struct cam_periph *periph) 202{ 203 return (mtx_owned(periph->sim->mtx)); 204} 205 206static __inline int 207cam_periph_sleep(struct cam_periph *periph, void *chan, int priority, 208 const char *wmesg, int timo) 209{ 210 return (msleep(chan, periph->sim->mtx, priority, wmesg, timo)); 211} 212 213static inline struct cam_periph * 214cam_periph_acquire_first(struct periph_driver *driver) 215{ 216 struct cam_periph *periph; 217 218 xpt_lock_buses(); 219 periph = TAILQ_FIRST(&driver->units); 220 while (periph != NULL && (periph->flags & CAM_PERIPH_INVALID) != 0) 221 periph = TAILQ_NEXT(periph, unit_links); 222 if (periph != NULL) 223 periph->refcount++; 224 xpt_unlock_buses(); 225 return (periph); 226} 227 228static inline struct cam_periph * 229cam_periph_acquire_next(struct cam_periph *pperiph) 230{ 231 struct cam_periph *periph = pperiph; 232 233 mtx_assert(pperiph->sim->mtx, MA_NOTOWNED); 234 xpt_lock_buses(); 235 do { 236 periph = TAILQ_NEXT(periph, unit_links); 237 } while (periph != NULL && (periph->flags & CAM_PERIPH_INVALID) != 0); 238 if (periph != NULL) 239 periph->refcount++; 240 xpt_unlock_buses(); 241 cam_periph_release(pperiph); 242 return (periph); 243} 244 245#define CAM_PERIPH_FOREACH(periph, driver) \ 246 for ((periph) = cam_periph_acquire_first(driver); \ 247 (periph) != NULL; \ 248 (periph) = cam_periph_acquire_next(periph)) 249 250#endif /* _KERNEL */ 251#endif /* _CAM_CAM_PERIPH_H */ 252