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 extern struct cam_periph *xpt_periph; 39 40 extern struct linker_set periphdriver_set; 41 42 typedef void (periph_init_t)(void); /* 43 * Callback informing the peripheral driver 44 * it can perform it's initialization since 45 * the XPT is now fully initialized. 46 */ 47 typedef periph_init_t *periph_init_func_t; 48 49 struct periph_driver { 50 periph_init_func_t init; 51 char *driver_name; 52 TAILQ_HEAD(,cam_periph) units; 53 u_int generation; 54 }; 55 56 typedef enum { 57 CAM_PERIPH_BIO, 58 CAM_PERIPH_NET 59 } cam_periph_type; 60 61 /* Generically usefull offsets into the peripheral private area */ 62 #define ppriv_ptr0 periph_priv.entries[0].ptr 63 #define ppriv_ptr1 periph_priv.entries[1].ptr 64 #define ppriv_field0 periph_priv.entries[0].field 65 #define ppriv_field1 periph_priv.entries[1].field 66 67 typedef void periph_start_t (struct cam_periph *periph, 68 union ccb *start_ccb); 69 typedef cam_status periph_ctor_t (struct cam_periph *periph, 70 void *arg); 71 typedef void periph_oninv_t (struct cam_periph *periph); 72 typedef void periph_dtor_t (struct cam_periph *periph); 73 struct cam_periph { 74 cam_pinfo pinfo; 75 periph_start_t *periph_start; 76 periph_oninv_t *periph_oninval; 77 periph_dtor_t *periph_dtor; 78 char *periph_name; 79 struct cam_path *path; /* Compiled path to device */ 80 void *softc; 81 u_int32_t unit_number; 82 cam_periph_type type; 83 u_int32_t flags; 84 #define CAM_PERIPH_RUNNING 0x01 85 #define CAM_PERIPH_LOCKED 0x02 86 #define CAM_PERIPH_LOCK_WANTED 0x04 87 #define CAM_PERIPH_INVALID 0x08 88 #define CAM_PERIPH_NEW_DEV_FOUND 0x10 89 #define CAM_PERIPH_RECOVERY_INPROG 0x20 90 u_int32_t immediate_priority; 91 u_int32_t refcount; 92 SLIST_HEAD(, ccb_hdr) ccb_list; /* For "immediate" requests */ 93 SLIST_ENTRY(cam_periph) periph_links; 94 TAILQ_ENTRY(cam_periph) unit_links; 95 ac_callback_t *deferred_callback; 96 ac_code deferred_ac; 97 }; 98 99 #define CAM_PERIPH_MAXMAPS 2 100 101 struct cam_periph_map_info { 102 int num_bufs_used; 103 struct buf *bp[CAM_PERIPH_MAXMAPS]; 104 }; 105 106 cam_status cam_periph_alloc(periph_ctor_t *periph_ctor, 107 periph_oninv_t *periph_oninvalidate, 108 periph_dtor_t *periph_dtor, 109 periph_start_t *periph_start, 110 char *name, cam_periph_type type, struct cam_path *, 111 ac_callback_t *, ac_code, void *arg); 112 struct cam_periph *cam_periph_find(struct cam_path *path, char *name); 113 int cam_periph_lock(struct cam_periph *periph, int priority); 114 void cam_periph_unlock(struct cam_periph *periph); 115 cam_status cam_periph_acquire(struct cam_periph *periph); 116 void cam_periph_release(struct cam_periph *periph); 117 void cam_periph_invalidate(struct cam_periph *periph); 118 int cam_periph_mapmem(union ccb *ccb, 119 struct cam_periph_map_info *mapinfo); 120 void cam_periph_unmapmem(union ccb *ccb, 121 struct cam_periph_map_info *mapinfo); 122 union ccb *cam_periph_getccb(struct cam_periph *periph, 123 u_int32_t priority); 124 void cam_periph_ccbwait(union ccb *ccb); 125 int cam_periph_runccb(union ccb *ccb, 126 int (*error_routine)(union ccb *ccb, 127 cam_flags camflags, 128 u_int32_t sense_flags), 129 cam_flags camflags, u_int32_t sense_flags, 130 struct devstat *ds); 131 int cam_periph_ioctl(struct cam_periph *periph, int cmd, 132 caddr_t addr, 133 int (*error_routine)(union ccb *ccb, 134 cam_flags camflags, 135 u_int32_t sense_flags)); 136 void cam_freeze_devq(struct cam_path *path); 137 u_int32_t cam_release_devq(struct cam_path *path, u_int32_t relsim_flags, 138 u_int32_t opening_reduction, u_int32_t timeout, 139 int getcount_only); 140 void cam_periph_async(struct cam_periph *periph, u_int32_t code, 141 struct cam_path *path, void *arg); 142 void cam_periph_bus_settle(struct cam_periph *periph, 143 u_int bus_settle_ms); 144 void cam_periph_freeze_after_event(struct cam_periph *periph, 145 struct timeval* event_time, 146 u_int duration_ms); 147 int cam_periph_error(union ccb *ccb, cam_flags camflags, 148 u_int32_t sense_flags, union ccb *save_ccb); 149 150 #endif /* _KERNEL */ 151 #endif /* _CAM_CAM_PERIPH_H */ 152