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