1 /*-
2 * Data structures and definitions for CAM peripheral ("type") drivers.
3 *
4 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
5 *
6 * Copyright (c) 1997, 1998 Justin T. Gibbs.
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions, and the following disclaimer,
14 * without modification, immediately at the beginning of the file.
15 * 2. The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
22 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 *
30 * $FreeBSD$
31 */
32
33 #ifndef _CAM_CAM_PERIPH_H
34 #define _CAM_CAM_PERIPH_H 1
35
36 #include <sys/queue.h>
37 #include <cam/cam_sim.h>
38
39 #ifdef _KERNEL
40 #include <sys/sysctl.h>
41 #include <sys/taskqueue.h>
42
43 #include <cam/cam_xpt.h>
44
45 struct devstat;
46
47 extern struct cam_periph *xpt_periph;
48
49 extern struct periph_driver **periph_drivers;
50 void periphdriver_register(void *);
51 int periphdriver_unregister(void *);
52 void periphdriver_init(int level);
53
54 #include <sys/module.h>
55 #define PERIPHDRIVER_DECLARE(name, driver) \
56 static int name ## _modevent(module_t mod, int type, void *data) \
57 { \
58 switch (type) { \
59 case MOD_LOAD: \
60 periphdriver_register(data); \
61 break; \
62 case MOD_UNLOAD: \
63 return (periphdriver_unregister(data)); \
64 default: \
65 return EOPNOTSUPP; \
66 } \
67 return 0; \
68 } \
69 static moduledata_t name ## _mod = { \
70 #name, \
71 name ## _modevent, \
72 (void *)&driver \
73 }; \
74 DECLARE_MODULE(name, name ## _mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \
75 MODULE_DEPEND(name, cam, 1, 1, 1)
76
77 /*
78 * Callback informing the peripheral driver it can perform it's
79 * initialization since the XPT is now fully initialized.
80 */
81 typedef void (periph_init_t)(void);
82
83 /*
84 * Callback requesting the peripheral driver to remove its instances
85 * and shutdown, if possible.
86 */
87 typedef int (periph_deinit_t)(void);
88
89 struct periph_driver {
90 periph_init_t *init;
91 char *driver_name;
92 TAILQ_HEAD(,cam_periph) units;
93 u_int generation;
94 u_int flags;
95 #define CAM_PERIPH_DRV_EARLY 0x01
96 periph_deinit_t *deinit;
97 };
98
99 typedef enum {
100 CAM_PERIPH_BIO
101 } cam_periph_type;
102
103 /* Generically useful offsets into the peripheral private area */
104 #define ppriv_ptr0 periph_priv.entries[0].ptr
105 #define ppriv_ptr1 periph_priv.entries[1].ptr
106 #define ppriv_field0 periph_priv.entries[0].field
107 #define ppriv_field1 periph_priv.entries[1].field
108
109 typedef void periph_start_t (struct cam_periph *periph,
110 union ccb *start_ccb);
111 typedef cam_status periph_ctor_t (struct cam_periph *periph,
112 void *arg);
113 typedef void periph_oninv_t (struct cam_periph *periph);
114 typedef void periph_dtor_t (struct cam_periph *periph);
115 struct cam_periph {
116 periph_start_t *periph_start;
117 periph_oninv_t *periph_oninval;
118 periph_dtor_t *periph_dtor;
119 char *periph_name;
120 struct cam_path *path; /* Compiled path to device */
121 void *softc;
122 struct cam_sim *sim;
123 u_int32_t unit_number;
124 cam_periph_type type;
125 u_int32_t flags;
126 #define CAM_PERIPH_RUNNING 0x01
127 #define CAM_PERIPH_LOCKED 0x02
128 #define CAM_PERIPH_LOCK_WANTED 0x04
129 #define CAM_PERIPH_INVALID 0x08
130 #define CAM_PERIPH_NEW_DEV_FOUND 0x10
131 #define CAM_PERIPH_RECOVERY_INPROG 0x20
132 #define CAM_PERIPH_RUN_TASK 0x40
133 #define CAM_PERIPH_FREE 0x80
134 #define CAM_PERIPH_ANNOUNCED 0x100
135 uint32_t scheduled_priority;
136 uint32_t immediate_priority;
137 int periph_allocating;
138 int periph_allocated;
139 u_int32_t refcount;
140 SLIST_HEAD(, ccb_hdr) ccb_list; /* For "immediate" requests */
141 SLIST_ENTRY(cam_periph) periph_links;
142 TAILQ_ENTRY(cam_periph) unit_links;
143 ac_callback_t *deferred_callback;
144 ac_code deferred_ac;
145 struct task periph_run_task;
146 };
147
148 #define CAM_PERIPH_MAXMAPS 2
149
150 struct cam_periph_map_info {
151 int num_bufs_used;
152 void *orig[CAM_PERIPH_MAXMAPS];
153 struct buf *bp[CAM_PERIPH_MAXMAPS];
154 };
155
156 cam_status cam_periph_alloc(periph_ctor_t *periph_ctor,
157 periph_oninv_t *periph_oninvalidate,
158 periph_dtor_t *periph_dtor,
159 periph_start_t *periph_start,
160 char *name, cam_periph_type type, struct cam_path *,
161 ac_callback_t *, ac_code, void *arg);
162 struct cam_periph *cam_periph_find(struct cam_path *path, char *name);
163 int cam_periph_list(struct cam_path *, struct sbuf *);
164 int cam_periph_acquire(struct cam_periph *periph);
165 void cam_periph_doacquire(struct cam_periph *periph);
166 void cam_periph_release(struct cam_periph *periph);
167 void cam_periph_release_locked(struct cam_periph *periph);
168 void cam_periph_release_locked_buses(struct cam_periph *periph);
169 int cam_periph_hold(struct cam_periph *periph, int priority);
170 void cam_periph_unhold(struct cam_periph *periph);
171 void cam_periph_invalidate(struct cam_periph *periph);
172 int cam_periph_mapmem(union ccb *ccb,
173 struct cam_periph_map_info *mapinfo,
174 u_int maxmap);
175 void cam_periph_unmapmem(union ccb *ccb,
176 struct cam_periph_map_info *mapinfo);
177 union ccb *cam_periph_getccb(struct cam_periph *periph,
178 u_int32_t priority);
179 int cam_periph_runccb(union ccb *ccb,
180 int (*error_routine)(union ccb *ccb,
181 cam_flags camflags,
182 u_int32_t sense_flags),
183 cam_flags camflags, u_int32_t sense_flags,
184 struct devstat *ds);
185 int cam_periph_ioctl(struct cam_periph *periph, u_long cmd,
186 caddr_t addr,
187 int (*error_routine)(union ccb *ccb,
188 cam_flags camflags,
189 u_int32_t sense_flags));
190 void cam_freeze_devq(struct cam_path *path);
191 u_int32_t cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
192 u_int32_t opening_reduction, u_int32_t arg,
193 int getcount_only);
194 void cam_periph_async(struct cam_periph *periph, u_int32_t code,
195 struct cam_path *path, void *arg);
196 void cam_periph_bus_settle(struct cam_periph *periph,
197 u_int bus_settle_ms);
198 void cam_periph_freeze_after_event(struct cam_periph *periph,
199 struct timeval* event_time,
200 u_int duration_ms);
201 int cam_periph_error(union ccb *ccb, cam_flags camflags,
202 u_int32_t sense_flags);
203 int cam_periph_invalidate_sysctl(SYSCTL_HANDLER_ARGS);
204
205 static __inline struct mtx *
cam_periph_mtx(struct cam_periph * periph)206 cam_periph_mtx(struct cam_periph *periph)
207 {
208 if (periph != NULL)
209 return (xpt_path_mtx(periph->path));
210 else
211 return (NULL);
212 }
213
214 #define cam_periph_owned(periph) \
215 mtx_owned(xpt_path_mtx((periph)->path))
216
217 #define cam_periph_lock(periph) \
218 mtx_lock(xpt_path_mtx((periph)->path))
219
220 #define cam_periph_unlock(periph) \
221 mtx_unlock(xpt_path_mtx((periph)->path))
222
223 #define cam_periph_assert(periph, what) \
224 mtx_assert(xpt_path_mtx((periph)->path), (what))
225
226 #define cam_periph_sleep(periph, chan, priority, wmesg, timo) \
227 xpt_path_sleep((periph)->path, (chan), (priority), (wmesg), (timo))
228
229 static inline struct cam_periph *
cam_periph_acquire_first(struct periph_driver * driver)230 cam_periph_acquire_first(struct periph_driver *driver)
231 {
232 struct cam_periph *periph;
233
234 xpt_lock_buses();
235 periph = TAILQ_FIRST(&driver->units);
236 while (periph != NULL && (periph->flags & CAM_PERIPH_INVALID) != 0)
237 periph = TAILQ_NEXT(periph, unit_links);
238 if (periph != NULL)
239 periph->refcount++;
240 xpt_unlock_buses();
241 return (periph);
242 }
243
244 static inline struct cam_periph *
cam_periph_acquire_next(struct cam_periph * pperiph)245 cam_periph_acquire_next(struct cam_periph *pperiph)
246 {
247 struct cam_periph *periph = pperiph;
248
249 cam_periph_assert(pperiph, MA_NOTOWNED);
250 xpt_lock_buses();
251 do {
252 periph = TAILQ_NEXT(periph, unit_links);
253 } while (periph != NULL && (periph->flags & CAM_PERIPH_INVALID) != 0);
254 if (periph != NULL)
255 periph->refcount++;
256 xpt_unlock_buses();
257 cam_periph_release(pperiph);
258 return (periph);
259 }
260
261 #define CAM_PERIPH_FOREACH(periph, driver) \
262 for ((periph) = cam_periph_acquire_first(driver); \
263 (periph) != NULL; \
264 (periph) = cam_periph_acquire_next(periph))
265
266 #define CAM_PERIPH_PRINT(p, msg, args...) \
267 printf("%s%d:" msg, (periph)->periph_name, (periph)->unit_number, ##args)
268
269 #endif /* _KERNEL */
270 #endif /* _CAM_CAM_PERIPH_H */
271