sys/vfs/hammer2: Remove comment on nonexistent hammer2_pfs_moderate()
[dragonfly.git] / sys / bus / cam / cam_periph.h
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.18 2007/04/19 22:46:26 scottl Exp $
29  */
30
31 #ifndef _CAM_CAM_PERIPH_H
32 #define _CAM_CAM_PERIPH_H 1
33
34 #include <sys/queue.h>
35 #include "cam_sim.h"
36
37 #ifdef _KERNEL
38
39 extern struct cam_periph *xpt_periph;
40
41 extern struct periph_driver **periph_drivers;
42 void periphdriver_register(void *);
43
44 #include <sys/module.h>
45
46 /*
47  * Declare a peripheral type driver (da, cd, etc).  This must be third in
48  * the module order to ensure that peripherals have registered their async
49  * callbacks before hardware drivers probe.
50  */
51 #define PERIPHDRIVER_DECLARE(name, driver) \
52         static int name ## _modevent(module_t mod, int type, void *data) \
53         { \
54                 switch (type) { \
55                 case MOD_LOAD: \
56                         periphdriver_register(data); \
57                         break; \
58                 case MOD_UNLOAD: \
59                         kprintf(#name " module unload - not possible for this module type\n"); \
60                         return EINVAL; \
61                 default: \
62                         return EOPNOTSUPP; \
63                 } \
64                 return 0; \
65         } \
66         static moduledata_t name ## _mod = { \
67                 #name, \
68                 name ## _modevent, \
69                 (void *)&driver \
70         }; \
71         DECLARE_MODULE(name, name ## _mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); \
72         MODULE_DEPEND(name, cam, 1, 1, 1)
73
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.
78                                      */
79 typedef periph_init_t *periph_init_func_t;
80
81 struct periph_driver {
82         periph_init_func_t       init;
83         char                     *driver_name;
84         TAILQ_HEAD(,cam_periph)  units;
85         u_int                    generation;
86 };
87
88 typedef enum {
89         CAM_PERIPH_BIO
90 } cam_periph_type;
91
92 /* Generically useful offsets into the peripheral private area */
93 #define ppriv_ptr0 periph_priv.entries[0].ptr
94 #define ppriv_ptr1 periph_priv.entries[1].ptr
95 #define ppriv_field0 periph_priv.entries[0].field
96 #define ppriv_field1 periph_priv.entries[1].field
97
98 typedef void            periph_start_t (struct cam_periph *periph,
99                                         union ccb *start_ccb);
100 typedef cam_status      periph_ctor_t (struct cam_periph *periph,
101                                        void *arg);
102 typedef void            periph_oninv_t (struct cam_periph *periph);
103 typedef void            periph_dtor_t (struct cam_periph *periph);
104 struct cam_periph {
105         cam_pinfo                pinfo;
106         periph_start_t          *periph_start;
107         periph_oninv_t          *periph_oninval;
108         periph_dtor_t           *periph_dtor;
109         char                    *periph_name;
110         struct cam_path         *path;  /* Compiled path to device */
111         void                    *softc;
112         struct cam_sim          *sim;
113         u_int32_t                unit_number;
114         cam_periph_type          type;
115         u_int32_t                flags;
116 #define CAM_PERIPH_RUNNING              0x01
117 #define CAM_PERIPH_LOCKED               0x02
118 #define CAM_PERIPH_LOCK_WANTED          0x04
119 #define CAM_PERIPH_INVALID              0x08
120 #define CAM_PERIPH_NEW_DEV_FOUND        0x10
121 #define CAM_PERIPH_RECOVERY_INPROG      0x20
122         u_int32_t                immediate_priority;
123         u_int32_t                refcount;
124         SLIST_HEAD(, ccb_hdr)    ccb_list;      /* For "immediate" requests */
125         SLIST_ENTRY(cam_periph)  periph_links;
126         TAILQ_ENTRY(cam_periph)  unit_links;
127         ac_callback_t           *deferred_callback; 
128         ac_code                  deferred_ac;
129 };
130
131 #define CAM_PERIPH_MAXMAPS      2
132
133 struct devstat;
134
135 struct cam_periph_map_info {
136         int             num_bufs_used;
137         struct buf      *bp[CAM_PERIPH_MAXMAPS];
138         caddr_t         saved_ptrs[CAM_PERIPH_MAXMAPS];
139         u_int32_t       dirs[CAM_PERIPH_MAXMAPS];
140 };
141
142 cam_status cam_periph_alloc(periph_ctor_t *periph_ctor,
143                             periph_oninv_t *periph_oninvalidate,
144                             periph_dtor_t *periph_dtor,
145                             periph_start_t *periph_start,
146                             char *name, cam_periph_type type,
147                             struct cam_path *path, ac_callback_t *ac_callback,
148                             ac_code code, void *arg);
149 struct cam_periph *cam_periph_find(struct cam_path *path, char *name);
150 cam_status      cam_periph_acquire(struct cam_periph *periph);
151 void            cam_periph_release(struct cam_periph *periph);
152 int             cam_periph_hold(struct cam_periph *periph, int flags);
153 void            cam_periph_unhold(struct cam_periph *periph, int unlock);
154 void            cam_periph_invalidate(struct cam_periph *periph);
155 int             cam_periph_mapmem(union ccb *ccb,
156                                   struct cam_periph_map_info *mapinfo);
157 void            cam_periph_unmapmem(union ccb *ccb,
158                                     struct cam_periph_map_info *mapinfo);
159 union ccb       *cam_periph_getccb(struct cam_periph *periph,
160                                    u_int32_t priority);
161 void            cam_periph_ccbwait(union ccb *ccb);
162 int             cam_periph_runccb(union ccb *ccb,
163                                   int (*error_routine)(union ccb *ccb,
164                                                        cam_flags camflags,
165                                                        u_int32_t sense_flags),
166                                   cam_flags camflags, u_int32_t sense_flags,
167                                   struct devstat *ds);
168 int             cam_periph_ioctl(struct cam_periph *periph, u_long cmd, 
169                                  caddr_t addr,
170                                  int (*error_routine)(union ccb *ccb,
171                                                       cam_flags camflags,
172                                                       u_int32_t sense_flags));
173 void            cam_freeze_devq(struct cam_path *path);
174 u_int32_t       cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
175                                  u_int32_t opening_reduction, u_int32_t timeout,
176                                  int getcount_only);
177 void            cam_periph_async(struct cam_periph *periph, u_int32_t code,
178                                  struct cam_path *path, void *arg);
179 void            cam_periph_bus_settle(struct cam_periph *periph,
180                                       u_int bus_settle_ms);
181 void            cam_periph_freeze_after_event(struct cam_periph *periph,
182                                               struct timeval* event_time,
183                                               u_int duration_ms);
184 int             cam_periph_error(union ccb *ccb, cam_flags camflags,
185                                  u_int32_t sense_flags, union ccb *save_ccb);
186
187 static __inline void
188 cam_periph_lock(struct cam_periph *periph)
189 {
190         CAM_SIM_LOCK(periph->sim);
191 }
192
193 static __inline void
194 cam_periph_unlock(struct cam_periph *periph)
195 {
196         CAM_SIM_UNLOCK(periph->sim);
197 }
198
199 #endif /* _KERNEL */
200 #endif /* _CAM_CAM_PERIPH_H */