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>
40 extern struct cam_periph *xpt_periph;
42 extern struct periph_driver **periph_drivers;
43 void periphdriver_register(void *);
45 #include <sys/module.h>
46 #define PERIPHDRIVER_DECLARE(name, driver) \
47 static int name ## _modevent(module_t mod, int type, void *data) \
51 periphdriver_register(data); \
54 printf(#name " module unload - not possible for this module type\n"); \
61 static moduledata_t name ## _mod = { \
66 DECLARE_MODULE(name, name ## _mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \
67 MODULE_DEPEND(name, cam, 1, 1, 1)
69 typedef void (periph_init_t)(void); /*
70 * Callback informing the peripheral driver
71 * it can perform it's initialization since
72 * the XPT is now fully initialized.
74 typedef periph_init_t *periph_init_func_t;
76 struct periph_driver {
77 periph_init_func_t init;
79 TAILQ_HEAD(,cam_periph) units;
87 /* Generically usefull offsets into the peripheral private area */
88 #define ppriv_ptr0 periph_priv.entries[0].ptr
89 #define ppriv_ptr1 periph_priv.entries[1].ptr
90 #define ppriv_field0 periph_priv.entries[0].field
91 #define ppriv_field1 periph_priv.entries[1].field
93 typedef void periph_start_t (struct cam_periph *periph,
94 union ccb *start_ccb);
95 typedef cam_status periph_ctor_t (struct cam_periph *periph,
97 typedef void periph_oninv_t (struct cam_periph *periph);
98 typedef void periph_dtor_t (struct cam_periph *periph);
101 periph_start_t *periph_start;
102 periph_oninv_t *periph_oninval;
103 periph_dtor_t *periph_dtor;
105 struct cam_path *path; /* Compiled path to device */
107 u_int32_t unit_number;
108 cam_periph_type type;
110 #define CAM_PERIPH_RUNNING 0x01
111 #define CAM_PERIPH_LOCKED 0x02
112 #define CAM_PERIPH_LOCK_WANTED 0x04
113 #define CAM_PERIPH_INVALID 0x08
114 #define CAM_PERIPH_NEW_DEV_FOUND 0x10
115 #define CAM_PERIPH_RECOVERY_INPROG 0x20
116 u_int32_t immediate_priority;
118 SLIST_HEAD(, ccb_hdr) ccb_list; /* For "immediate" requests */
119 SLIST_ENTRY(cam_periph) periph_links;
120 TAILQ_ENTRY(cam_periph) unit_links;
121 ac_callback_t *deferred_callback;
125 #define CAM_PERIPH_MAXMAPS 2
127 struct cam_periph_map_info {
129 struct buf *bp[CAM_PERIPH_MAXMAPS];
132 cam_status cam_periph_alloc(periph_ctor_t *periph_ctor,
133 periph_oninv_t *periph_oninvalidate,
134 periph_dtor_t *periph_dtor,
135 periph_start_t *periph_start,
136 char *name, cam_periph_type type, struct cam_path *,
137 ac_callback_t *, ac_code, void *arg);
138 struct cam_periph *cam_periph_find(struct cam_path *path, char *name);
139 int cam_periph_lock(struct cam_periph *periph, int priority);
140 void cam_periph_unlock(struct cam_periph *periph);
141 cam_status cam_periph_acquire(struct cam_periph *periph);
142 void cam_periph_release(struct cam_periph *periph);
143 void cam_periph_invalidate(struct cam_periph *periph);
144 int cam_periph_mapmem(union ccb *ccb,
145 struct cam_periph_map_info *mapinfo);
146 void cam_periph_unmapmem(union ccb *ccb,
147 struct cam_periph_map_info *mapinfo);
148 union ccb *cam_periph_getccb(struct cam_periph *periph,
150 void cam_periph_ccbwait(union ccb *ccb);
151 int cam_periph_runccb(union ccb *ccb,
152 int (*error_routine)(union ccb *ccb,
154 u_int32_t sense_flags),
155 cam_flags camflags, u_int32_t sense_flags,
157 int cam_periph_ioctl(struct cam_periph *periph, int cmd,
159 int (*error_routine)(union ccb *ccb,
161 u_int32_t sense_flags));
162 void cam_freeze_devq(struct cam_path *path);
163 u_int32_t cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
164 u_int32_t opening_reduction, u_int32_t timeout,
166 void cam_periph_async(struct cam_periph *periph, u_int32_t code,
167 struct cam_path *path, void *arg);
168 void cam_periph_bus_settle(struct cam_periph *periph,
169 u_int bus_settle_ms);
170 void cam_periph_freeze_after_event(struct cam_periph *periph,
171 struct timeval* event_time,
173 int cam_periph_error(union ccb *ccb, cam_flags camflags,
174 u_int32_t sense_flags, union ccb *save_ccb);
177 #endif /* _CAM_CAM_PERIPH_H */