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
28 * $FreeBSD: src/sys/cam/cam_periph.h,v 1.6.2.1 2000/05/07 18:16:49 n_hibma Exp $
29 * $DragonFly: src/sys/bus/cam/cam_periph.h,v 1.4 2003/11/10 06:12:00 dillon Exp $
32 #ifndef _CAM_CAM_PERIPH_H
33 #define _CAM_CAM_PERIPH_H 1
35 #include <sys/queue.h>
36 #ifndef _SYS_LINKER_SET_H_
37 #include <sys/linker_set.h>
42 extern struct cam_periph *xpt_periph;
44 SET_DECLARE(periphdriver_set, struct periph_driver);
46 typedef void (periph_init_t)(void); /*
47 * Callback informing the peripheral driver
48 * it can perform it's initialization since
49 * the XPT is now fully initialized.
51 typedef periph_init_t *periph_init_func_t;
53 struct periph_driver {
54 periph_init_func_t init;
56 TAILQ_HEAD(,cam_periph) units;
65 /* Generically usefull offsets into the peripheral private area */
66 #define ppriv_ptr0 periph_priv.entries[0].ptr
67 #define ppriv_ptr1 periph_priv.entries[1].ptr
68 #define ppriv_field0 periph_priv.entries[0].field
69 #define ppriv_field1 periph_priv.entries[1].field
71 typedef void periph_start_t (struct cam_periph *periph,
72 union ccb *start_ccb);
73 typedef cam_status periph_ctor_t (struct cam_periph *periph,
75 typedef void periph_oninv_t (struct cam_periph *periph);
76 typedef void periph_dtor_t (struct cam_periph *periph);
79 periph_start_t *periph_start;
80 periph_oninv_t *periph_oninval;
81 periph_dtor_t *periph_dtor;
83 struct cam_path *path; /* Compiled path to device */
85 u_int32_t unit_number;
88 #define CAM_PERIPH_RUNNING 0x01
89 #define CAM_PERIPH_LOCKED 0x02
90 #define CAM_PERIPH_LOCK_WANTED 0x04
91 #define CAM_PERIPH_INVALID 0x08
92 #define CAM_PERIPH_NEW_DEV_FOUND 0x10
93 #define CAM_PERIPH_RECOVERY_INPROG 0x20
94 u_int32_t immediate_priority;
96 SLIST_HEAD(, ccb_hdr) ccb_list; /* For "immediate" requests */
97 SLIST_ENTRY(cam_periph) periph_links;
98 TAILQ_ENTRY(cam_periph) unit_links;
99 ac_callback_t *deferred_callback;
103 #define CAM_PERIPH_MAXMAPS 2
105 struct cam_periph_map_info {
107 struct buf *bp[CAM_PERIPH_MAXMAPS];
110 cam_status cam_periph_alloc(periph_ctor_t *periph_ctor,
111 periph_oninv_t *periph_oninvalidate,
112 periph_dtor_t *periph_dtor,
113 periph_start_t *periph_start,
114 char *name, cam_periph_type type, struct cam_path *,
115 ac_callback_t *, ac_code, void *arg);
116 struct cam_periph *cam_periph_find(struct cam_path *path, char *name);
117 int cam_periph_lock(struct cam_periph *periph, int flags);
118 void cam_periph_unlock(struct cam_periph *periph);
119 cam_status cam_periph_acquire(struct cam_periph *periph);
120 void cam_periph_release(struct cam_periph *periph);
121 void cam_periph_invalidate(struct cam_periph *periph);
122 int cam_periph_mapmem(union ccb *ccb,
123 struct cam_periph_map_info *mapinfo);
124 void cam_periph_unmapmem(union ccb *ccb,
125 struct cam_periph_map_info *mapinfo);
126 union ccb *cam_periph_getccb(struct cam_periph *periph,
128 void cam_periph_ccbwait(union ccb *ccb);
129 int cam_periph_runccb(union ccb *ccb,
130 int (*error_routine)(union ccb *ccb,
132 u_int32_t sense_flags),
133 cam_flags camflags, u_int32_t sense_flags,
135 int cam_periph_ioctl(struct cam_periph *periph, int cmd,
137 int (*error_routine)(union ccb *ccb,
139 u_int32_t sense_flags));
140 void cam_freeze_devq(struct cam_path *path);
141 u_int32_t cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
142 u_int32_t opening_reduction, u_int32_t timeout,
144 void cam_periph_async(struct cam_periph *periph, u_int32_t code,
145 struct cam_path *path, void *arg);
146 void cam_periph_bus_settle(struct cam_periph *periph,
147 u_int bus_settle_ms);
148 void cam_periph_freeze_after_event(struct cam_periph *periph,
149 struct timeval* event_time,
151 int cam_periph_error(union ccb *ccb, cam_flags camflags,
152 u_int32_t sense_flags, union ccb *save_ccb);
155 #endif /* _CAM_CAM_PERIPH_H */