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