2 * Data structures and definitions for CAM peripheral ("type") drivers.
4 * Copyright (c) 1997, 1998 Justin T. Gibbs.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
31 #ifndef _CAM_CAM_PERIPH_H
32 #define _CAM_CAM_PERIPH_H 1
34 #include <sys/queue.h>
35 #include <cam/cam_sim.h>
38 #include <sys/taskqueue.h>
40 #include <cam/cam_xpt.h>
44 extern struct cam_periph *xpt_periph;
46 extern struct periph_driver **periph_drivers;
47 void periphdriver_register(void *);
48 void periphdriver_init(int level);
50 #include <sys/module.h>
51 #define PERIPHDRIVER_DECLARE(name, driver) \
52 static int name ## _modevent(module_t mod, int type, void *data) \
56 periphdriver_register(data); \
59 printf(#name " module unload - not possible for this module type\n"); \
66 static moduledata_t name ## _mod = { \
71 DECLARE_MODULE(name, name ## _mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \
72 MODULE_DEPEND(name, cam, 1, 1, 1)
74 typedef void (periph_init_t)(void); /*
75 * Callback informing the peripheral driver
76 * it can perform it's initialization since
77 * the XPT is now fully initialized.
79 typedef periph_init_t *periph_init_func_t;
81 struct periph_driver {
82 periph_init_func_t init;
84 TAILQ_HEAD(,cam_periph) units;
87 #define CAM_PERIPH_DRV_EARLY 0x01
94 /* Generically useful offsets into the peripheral private area */
95 #define ppriv_ptr0 periph_priv.entries[0].ptr
96 #define ppriv_ptr1 periph_priv.entries[1].ptr
97 #define ppriv_field0 periph_priv.entries[0].field
98 #define ppriv_field1 periph_priv.entries[1].field
100 typedef void periph_start_t (struct cam_periph *periph,
101 union ccb *start_ccb);
102 typedef cam_status periph_ctor_t (struct cam_periph *periph,
104 typedef void periph_oninv_t (struct cam_periph *periph);
105 typedef void periph_dtor_t (struct cam_periph *periph);
107 periph_start_t *periph_start;
108 periph_oninv_t *periph_oninval;
109 periph_dtor_t *periph_dtor;
111 struct cam_path *path; /* Compiled path to device */
114 u_int32_t unit_number;
115 cam_periph_type type;
117 #define CAM_PERIPH_RUNNING 0x01
118 #define CAM_PERIPH_LOCKED 0x02
119 #define CAM_PERIPH_LOCK_WANTED 0x04
120 #define CAM_PERIPH_INVALID 0x08
121 #define CAM_PERIPH_NEW_DEV_FOUND 0x10
122 #define CAM_PERIPH_RECOVERY_INPROG 0x20
123 #define CAM_PERIPH_RUN_TASK 0x40
124 #define CAM_PERIPH_FREE 0x80
125 #define CAM_PERIPH_ANNOUNCED 0x100
126 uint32_t scheduled_priority;
127 uint32_t immediate_priority;
128 int periph_allocating;
129 int periph_allocated;
131 SLIST_HEAD(, ccb_hdr) ccb_list; /* For "immediate" requests */
132 SLIST_ENTRY(cam_periph) periph_links;
133 TAILQ_ENTRY(cam_periph) unit_links;
134 ac_callback_t *deferred_callback;
136 struct task periph_run_task;
139 #define CAM_PERIPH_MAXMAPS 2
141 struct cam_periph_map_info {
143 struct buf *bp[CAM_PERIPH_MAXMAPS];
146 cam_status cam_periph_alloc(periph_ctor_t *periph_ctor,
147 periph_oninv_t *periph_oninvalidate,
148 periph_dtor_t *periph_dtor,
149 periph_start_t *periph_start,
150 char *name, cam_periph_type type, struct cam_path *,
151 ac_callback_t *, ac_code, void *arg);
152 struct cam_periph *cam_periph_find(struct cam_path *path, char *name);
153 int cam_periph_list(struct cam_path *, struct sbuf *);
154 cam_status cam_periph_acquire(struct cam_periph *periph);
155 void cam_periph_doacquire(struct cam_periph *periph);
156 void cam_periph_release(struct cam_periph *periph);
157 void cam_periph_release_locked(struct cam_periph *periph);
158 void cam_periph_release_locked_buses(struct cam_periph *periph);
159 int cam_periph_hold(struct cam_periph *periph, int priority);
160 void cam_periph_unhold(struct cam_periph *periph);
161 void cam_periph_invalidate(struct cam_periph *periph);
162 int cam_periph_mapmem(union ccb *ccb,
163 struct cam_periph_map_info *mapinfo);
164 void cam_periph_unmapmem(union ccb *ccb,
165 struct cam_periph_map_info *mapinfo);
166 union ccb *cam_periph_getccb(struct cam_periph *periph,
168 void cam_periph_ccbwait(union ccb *ccb);
169 int cam_periph_runccb(union ccb *ccb,
170 int (*error_routine)(union ccb *ccb,
172 u_int32_t sense_flags),
173 cam_flags camflags, u_int32_t sense_flags,
175 int cam_periph_ioctl(struct cam_periph *periph, u_long cmd,
177 int (*error_routine)(union ccb *ccb,
179 u_int32_t sense_flags));
180 void cam_freeze_devq(struct cam_path *path);
181 u_int32_t cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
182 u_int32_t opening_reduction, u_int32_t arg,
184 void cam_periph_async(struct cam_periph *periph, u_int32_t code,
185 struct cam_path *path, void *arg);
186 void cam_periph_bus_settle(struct cam_periph *periph,
187 u_int bus_settle_ms);
188 void cam_periph_freeze_after_event(struct cam_periph *periph,
189 struct timeval* event_time,
191 int cam_periph_error(union ccb *ccb, cam_flags camflags,
192 u_int32_t sense_flags, union ccb *save_ccb);
194 static __inline struct mtx *
195 cam_periph_mtx(struct cam_periph *periph)
197 return (xpt_path_mtx(periph->path));
200 #define cam_periph_owned(periph) \
201 mtx_owned(xpt_path_mtx((periph)->path))
203 #define cam_periph_lock(periph) \
204 mtx_lock(xpt_path_mtx((periph)->path))
206 #define cam_periph_unlock(periph) \
207 mtx_unlock(xpt_path_mtx((periph)->path))
209 #define cam_periph_assert(periph, what) \
210 mtx_assert(xpt_path_mtx((periph)->path), (what))
212 #define cam_periph_sleep(periph, chan, priority, wmesg, timo) \
213 xpt_path_sleep((periph)->path, (chan), (priority), (wmesg), (timo))
215 static inline struct cam_periph *
216 cam_periph_acquire_first(struct periph_driver *driver)
218 struct cam_periph *periph;
221 periph = TAILQ_FIRST(&driver->units);
222 while (periph != NULL && (periph->flags & CAM_PERIPH_INVALID) != 0)
223 periph = TAILQ_NEXT(periph, unit_links);
230 static inline struct cam_periph *
231 cam_periph_acquire_next(struct cam_periph *pperiph)
233 struct cam_periph *periph = pperiph;
235 cam_periph_assert(pperiph, MA_NOTOWNED);
238 periph = TAILQ_NEXT(periph, unit_links);
239 } while (periph != NULL && (periph->flags & CAM_PERIPH_INVALID) != 0);
243 cam_periph_release(pperiph);
247 #define CAM_PERIPH_FOREACH(periph, driver) \
248 for ((periph) = cam_periph_acquire_first(driver); \
250 (periph) = cam_periph_acquire_next(periph))
253 #endif /* _CAM_CAM_PERIPH_H */