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 36 #ifdef _KERNEL 37 38 struct devstat; 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 printf(#name " module unload - not possible for this module type\n"); \ 55 return EINVAL; \ 56 } \ 57 return 0; \ 58 } \ 59 static moduledata_t name ## _mod = { \ 60 #name, \ 61 name ## _modevent, \ 62 (void *)&driver \ 63 }; \ 64 DECLARE_MODULE(name, name ## _mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \ 65 MODULE_DEPEND(name, cam, 1, 1, 1) 66 67 typedef void (periph_init_t)(void); /* 68 * Callback informing the peripheral driver 69 * it can perform it's initialization since 70 * the XPT is now fully initialized. 71 */ 72 typedef periph_init_t *periph_init_func_t; 73 74 struct periph_driver { 75 periph_init_func_t init; 76 char *driver_name; 77 TAILQ_HEAD(,cam_periph) units; 78 u_int generation; 79 }; 80 81 typedef enum { 82 CAM_PERIPH_BIO, 83 CAM_PERIPH_NET 84 } cam_periph_type; 85 86 /* Generically usefull 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 u_int32_t unit_number; 107 cam_periph_type type; 108 u_int32_t flags; 109 #define CAM_PERIPH_RUNNING 0x01 110 #define CAM_PERIPH_LOCKED 0x02 111 #define CAM_PERIPH_LOCK_WANTED 0x04 112 #define CAM_PERIPH_INVALID 0x08 113 #define CAM_PERIPH_NEW_DEV_FOUND 0x10 114 #define CAM_PERIPH_RECOVERY_INPROG 0x20 115 u_int32_t immediate_priority; 116 u_int32_t refcount; 117 SLIST_HEAD(, ccb_hdr) ccb_list; /* For "immediate" requests */ 118 SLIST_ENTRY(cam_periph) periph_links; 119 TAILQ_ENTRY(cam_periph) unit_links; 120 ac_callback_t *deferred_callback; 121 ac_code deferred_ac; 122 }; 123 124 #define CAM_PERIPH_MAXMAPS 2 125 126 struct cam_periph_map_info { 127 int num_bufs_used; 128 struct buf *bp[CAM_PERIPH_MAXMAPS]; 129 }; 130 131 cam_status cam_periph_alloc(periph_ctor_t *periph_ctor, 132 periph_oninv_t *periph_oninvalidate, 133 periph_dtor_t *periph_dtor, 134 periph_start_t *periph_start, 135 char *name, cam_periph_type type, struct cam_path *, 136 ac_callback_t *, ac_code, void *arg); 137 struct cam_periph *cam_periph_find(struct cam_path *path, char *name); 138 int cam_periph_lock(struct cam_periph *periph, int priority); 139 void cam_periph_unlock(struct cam_periph *periph); 140 cam_status cam_periph_acquire(struct cam_periph *periph); 141 void cam_periph_release(struct cam_periph *periph); 142 void cam_periph_invalidate(struct cam_periph *periph); 143 int cam_periph_mapmem(union ccb *ccb, 144 struct cam_periph_map_info *mapinfo); 145 void cam_periph_unmapmem(union ccb *ccb, 146 struct cam_periph_map_info *mapinfo); 147 union ccb *cam_periph_getccb(struct cam_periph *periph, 148 u_int32_t priority); 149 void cam_periph_ccbwait(union ccb *ccb); 150 int cam_periph_runccb(union ccb *ccb, 151 int (*error_routine)(union ccb *ccb, 152 cam_flags camflags, 153 u_int32_t sense_flags), 154 cam_flags camflags, u_int32_t sense_flags, 155 struct devstat *ds); 156 int cam_periph_ioctl(struct cam_periph *periph, int cmd, 157 caddr_t addr, 158 int (*error_routine)(union ccb *ccb, 159 cam_flags camflags, 160 u_int32_t sense_flags)); 161 void cam_freeze_devq(struct cam_path *path); 162 u_int32_t cam_release_devq(struct cam_path *path, u_int32_t relsim_flags, 163 u_int32_t opening_reduction, u_int32_t timeout, 164 int getcount_only); 165 void cam_periph_async(struct cam_periph *periph, u_int32_t code, 166 struct cam_path *path, void *arg); 167 void cam_periph_bus_settle(struct cam_periph *periph, 168 u_int bus_settle_ms); 169 void cam_periph_freeze_after_event(struct cam_periph *periph, 170 struct timeval* event_time, 171 u_int duration_ms); 172 int cam_periph_error(union ccb *ccb, cam_flags camflags, 173 u_int32_t sense_flags, union ccb *save_ccb); 174 175 #endif /* _KERNEL */ 176 #endif /* _CAM_CAM_PERIPH_H */ 177