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: src/sys/cam/cam_periph.h,v 1.18 2007/04/19 22:46:26 scottl Exp $ 29 * $DragonFly: src/sys/bus/cam/cam_periph.h,v 1.12 2008/07/18 00:07:21 dillon Exp $ 30 */ 31 32 #ifndef _CAM_CAM_PERIPH_H 33 #define _CAM_CAM_PERIPH_H 1 34 35 #include <sys/queue.h> 36 #include "cam_sim.h" 37 38 #ifdef _KERNEL 39 40 extern struct cam_periph *xpt_periph; 41 42 extern struct periph_driver **periph_drivers; 43 void periphdriver_register(void *); 44 45 #include <sys/module.h> 46 #define PERIPHDRIVER_DECLARE(name, driver) \ 47 static int name ## _modevent(module_t mod, int type, void *data) \ 48 { \ 49 switch (type) { \ 50 case MOD_LOAD: \ 51 periphdriver_register(data); \ 52 break; \ 53 case MOD_UNLOAD: \ 54 kprintf(#name " module unload - not possible for this module type\n"); \ 55 return EINVAL; \ 56 default: \ 57 return EOPNOTSUPP; \ 58 } \ 59 return 0; \ 60 } \ 61 static moduledata_t name ## _mod = { \ 62 #name, \ 63 name ## _modevent, \ 64 (void *)&driver \ 65 }; \ 66 DECLARE_MODULE(name, name ## _mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \ 67 MODULE_DEPEND(name, cam, 1, 1, 1) 68 69 typedef void (periph_init_t)(void); /* 70 * Callback informing the peripheral driver 71 * it can perform it's initialization since 72 * the XPT is now fully initialized. 73 */ 74 typedef periph_init_t *periph_init_func_t; 75 76 struct periph_driver { 77 periph_init_func_t init; 78 char *driver_name; 79 TAILQ_HEAD(,cam_periph) units; 80 u_int generation; 81 }; 82 83 typedef enum { 84 CAM_PERIPH_BIO 85 } cam_periph_type; 86 87 /* Generically useful offsets into the peripheral private area */ 88 #define ppriv_ptr0 periph_priv.entries[0].ptr 89 #define ppriv_ptr1 periph_priv.entries[1].ptr 90 #define ppriv_field0 periph_priv.entries[0].field 91 #define ppriv_field1 periph_priv.entries[1].field 92 93 typedef void periph_start_t (struct cam_periph *periph, 94 union ccb *start_ccb); 95 typedef cam_status periph_ctor_t (struct cam_periph *periph, 96 void *arg); 97 typedef void periph_oninv_t (struct cam_periph *periph); 98 typedef void periph_dtor_t (struct cam_periph *periph); 99 struct cam_periph { 100 cam_pinfo pinfo; 101 periph_start_t *periph_start; 102 periph_oninv_t *periph_oninval; 103 periph_dtor_t *periph_dtor; 104 char *periph_name; 105 struct cam_path *path; /* Compiled path to device */ 106 void *softc; 107 struct cam_sim *sim; 108 u_int32_t unit_number; 109 cam_periph_type type; 110 u_int32_t flags; 111 #define CAM_PERIPH_RUNNING 0x01 112 #define CAM_PERIPH_LOCKED 0x02 113 #define CAM_PERIPH_LOCK_WANTED 0x04 114 #define CAM_PERIPH_INVALID 0x08 115 #define CAM_PERIPH_NEW_DEV_FOUND 0x10 116 #define CAM_PERIPH_RECOVERY_INPROG 0x20 117 #define CAM_PERIPH_POLLED 0x40 118 u_int32_t immediate_priority; 119 u_int32_t refcount; 120 SLIST_HEAD(, ccb_hdr) ccb_list; /* For "immediate" requests */ 121 SLIST_ENTRY(cam_periph) periph_links; 122 TAILQ_ENTRY(cam_periph) unit_links; 123 ac_callback_t *deferred_callback; 124 ac_code deferred_ac; 125 }; 126 127 #define CAM_PERIPH_MAXMAPS 2 128 129 struct devstat; 130 131 struct cam_periph_map_info { 132 int num_bufs_used; 133 struct buf *bp[CAM_PERIPH_MAXMAPS]; 134 caddr_t saved_ptrs[CAM_PERIPH_MAXMAPS]; 135 u_int32_t dirs[CAM_PERIPH_MAXMAPS]; 136 int bounce[CAM_PERIPH_MAXMAPS]; 137 }; 138 139 cam_status cam_periph_alloc(periph_ctor_t *periph_ctor, 140 periph_oninv_t *periph_oninvalidate, 141 periph_dtor_t *periph_dtor, 142 periph_start_t *periph_start, 143 char *name, cam_periph_type type, struct cam_path *, 144 ac_callback_t *, ac_code, void *arg); 145 struct cam_periph *cam_periph_find(struct cam_path *path, char *name); 146 cam_status cam_periph_acquire(struct cam_periph *periph); 147 void cam_periph_release(struct cam_periph *periph); 148 int cam_periph_hold(struct cam_periph *periph, int flags); 149 void cam_periph_unhold(struct cam_periph *periph, int unlock); 150 void cam_periph_invalidate(struct cam_periph *periph); 151 int cam_periph_mapmem(union ccb *ccb, 152 struct cam_periph_map_info *mapinfo); 153 void cam_periph_unmapmem(union ccb *ccb, 154 struct cam_periph_map_info *mapinfo); 155 union ccb *cam_periph_getccb(struct cam_periph *periph, 156 u_int32_t priority); 157 void cam_periph_ccbwait(union ccb *ccb); 158 int cam_periph_runccb(union ccb *ccb, 159 int (*error_routine)(union ccb *ccb, 160 cam_flags camflags, 161 u_int32_t sense_flags), 162 cam_flags camflags, u_int32_t sense_flags, 163 struct devstat *ds); 164 int cam_periph_ioctl(struct cam_periph *periph, int cmd, 165 caddr_t addr, 166 int (*error_routine)(union ccb *ccb, 167 cam_flags camflags, 168 u_int32_t sense_flags)); 169 void cam_freeze_devq(struct cam_path *path); 170 u_int32_t cam_release_devq(struct cam_path *path, u_int32_t relsim_flags, 171 u_int32_t opening_reduction, u_int32_t timeout, 172 int getcount_only); 173 void cam_periph_async(struct cam_periph *periph, u_int32_t code, 174 struct cam_path *path, void *arg); 175 void cam_periph_bus_settle(struct cam_periph *periph, 176 u_int bus_settle_ms); 177 void cam_periph_freeze_after_event(struct cam_periph *periph, 178 struct timeval* event_time, 179 u_int duration_ms); 180 int cam_periph_error(union ccb *ccb, cam_flags camflags, 181 u_int32_t sense_flags, union ccb *save_ccb); 182 183 static __inline void 184 cam_periph_lock(struct cam_periph *periph) 185 { 186 CAM_SIM_LOCK(periph->sim); 187 } 188 189 static __inline void 190 cam_periph_unlock(struct cam_periph *periph) 191 { 192 CAM_SIM_UNLOCK(periph->sim); 193 } 194 195 #endif /* _KERNEL */ 196 #endif /* _CAM_CAM_PERIPH_H */ 197