1 /* 2 * Data structures and definitions for SCSI Interface Modules (SIMs). 3 * 4 * Copyright (c) 1997 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_sim.h,v 1.4 1999/12/29 04:54:27 peter Exp $ 29 * $DragonFly: src/sys/bus/cam/cam_sim.h,v 1.9 2008/07/18 00:07:21 dillon Exp $ 30 */ 31 32 #ifndef _CAM_CAM_SIM_H 33 #define _CAM_CAM_SIM_H 1 34 35 #ifdef _KERNEL 36 37 #ifndef _SYS_SPINLOCK_H_ 38 #include <sys/spinlock.h> 39 #endif 40 41 /* 42 * The sim driver creates a sim for each controller. The sim device 43 * queue is separately created in order to allow resource sharing between 44 * sims. For instance, a driver may create one sim for each channel of 45 * a multi-channel controller and use the same queue for each channel. 46 * In this way, the queue resources are shared across all the channels 47 * of the multi-channel controller. 48 */ 49 50 struct cam_sim; 51 struct cam_devq; 52 53 typedef void (*sim_action_func)(struct cam_sim *sim, union ccb *ccb); 54 typedef void (*sim_poll_func)(struct cam_sim *sim); 55 56 typedef struct lock sim_lock; 57 extern sim_lock sim_mplock; 58 59 void cam_sim_lock(sim_lock *lock); 60 void cam_sim_unlock(sim_lock *lock); 61 void sim_lock_assert_owned(sim_lock *lock); 62 void sim_lock_assert_unowned(sim_lock *lock); 63 int sim_lock_sleep(void *ident, int flags, const char *wmesg, 64 int timo, sim_lock *lock); 65 struct cam_devq * cam_simq_alloc(u_int32_t max_sim_transactions); 66 void cam_simq_release(struct cam_devq *devq); 67 68 struct cam_sim * cam_sim_alloc(sim_action_func sim_action, 69 sim_poll_func sim_poll, 70 const char *sim_name, 71 void *softc, 72 u_int32_t unit, 73 sim_lock *lock, 74 int max_dev_transactions, 75 int max_tagged_dev_transactions, 76 struct cam_devq *queue); 77 void cam_sim_free(struct cam_sim *sim); 78 void cam_sim_release(struct cam_sim *sim, int flags); 79 80 #define CAM_SIM_SOFTC 0x0002 81 82 /* Optional sim attributes may be set with these. */ 83 void cam_sim_set_path(struct cam_sim *sim, u_int32_t path_id); 84 85 86 87 /* Convenience routines for accessing sim attributes. */ 88 static __inline u_int32_t cam_sim_path(struct cam_sim *sim); 89 static __inline const char *cam_sim_name(struct cam_sim *sim); 90 static __inline void * cam_sim_softc(struct cam_sim *sim); 91 static __inline u_int32_t cam_sim_unit(struct cam_sim *sim); 92 static __inline u_int32_t cam_sim_bus(struct cam_sim *sim); 93 94 95 96 /* Generically useful offsets into the sim private area */ 97 #define spriv_ptr0 sim_priv.entries[0].ptr 98 #define spriv_ptr1 sim_priv.entries[1].ptr 99 #define spriv_field0 sim_priv.entries[0].field 100 #define spriv_field1 sim_priv.entries[1].field 101 102 /* 103 * The sim driver should not access anything directly from this 104 * structure. 105 */ 106 struct cam_sim { 107 sim_action_func sim_action; 108 sim_poll_func sim_poll; 109 const char *sim_name; 110 void *softc; /* might be NULL */ 111 sim_lock *lock; 112 struct spinlock sim_spin; 113 TAILQ_HEAD(, ccb_hdr) sim_doneq; 114 TAILQ_ENTRY(cam_sim) links; 115 u_int32_t path_id; /* bootdev may set this to 0? */ 116 u_int32_t unit_number; 117 u_int32_t bus_id; 118 int max_tagged_dev_openings; 119 int max_dev_openings; 120 u_int32_t flags; 121 #define CAM_SIM_REL_TIMEOUT_PENDING 0x01 122 #define CAM_SIM_MPSAFE 0x02 123 #define CAM_SIM_ON_DONEQ 0x04 124 #define CAM_SIM_DEREGISTERED 0x08 125 struct callout callout; 126 struct cam_devq *devq; /* Device Queue to use for this SIM */ 127 int refcount; /* References to the sim */ 128 129 /* "Pool" of inactive ccbs managed by xpt_alloc_ccb and xpt_free_ccb */ 130 SLIST_HEAD(,ccb_hdr) ccb_freeq; 131 /* 132 * Maximum size of ccb pool. Modified as devices are added/removed 133 * or have their * opening counts changed. 134 */ 135 u_int max_ccbs; 136 /* Current count of allocated ccbs */ 137 u_int ccb_count; 138 139 }; 140 141 #define CAM_SIM_LOCK(sim) cam_sim_lock((sim)->lock); 142 #define CAM_SIM_UNLOCK(sim) cam_sim_unlock((sim)->lock); 143 144 static __inline u_int32_t 145 cam_sim_path(struct cam_sim *sim) 146 { 147 return (sim->path_id); 148 } 149 150 static __inline const char * 151 cam_sim_name(struct cam_sim *sim) 152 { 153 return (sim->sim_name); 154 } 155 156 static __inline void * 157 cam_sim_softc(struct cam_sim *sim) 158 { 159 return (sim->softc); 160 } 161 162 static __inline u_int32_t 163 cam_sim_unit(struct cam_sim *sim) 164 { 165 return (sim->unit_number); 166 } 167 168 static __inline u_int32_t 169 cam_sim_bus(struct cam_sim *sim) 170 { 171 return (sim->bus_id); 172 } 173 174 #endif /* _KERNEL */ 175 #endif /* _CAM_CAM_SIM_H */ 176