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: head/sys/cam/cam_periph.h 132199 2004-07-15 08:26:07Z phk $
29 */
30
31#ifndef _CAM_CAM_PERIPH_H
32#define _CAM_CAM_PERIPH_H 1
33
34#include <sys/queue.h>
35
36#ifdef _KERNEL
37
38struct devstat;
39
40extern struct cam_periph *xpt_periph;
41
42extern struct periph_driver **periph_drivers;
43void periphdriver_register(void *);
44
45#include <sys/module.h>
46#define PERIPHDRIVER_DECLARE(name, driver) \
47 static int name ## _modevent(module_t mod, int type, void *data) \
48 { \
49 switch (type) { \
50 case MOD_LOAD: \
51 periphdriver_register(data); \
52 break; \
53 case MOD_UNLOAD: \
54 printf(#name " module unload - not possible for this module type\n"); \
55 return EINVAL; \
56 default: \
57 return EOPNOTSUPP; \
58 } \
59 return 0; \
60 } \
61 static moduledata_t name ## _mod = { \
62 #name, \
63 name ## _modevent, \
64 (void *)&driver \
65 }; \
66 DECLARE_MODULE(name, name ## _mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \
67 MODULE_DEPEND(name, cam, 1, 1, 1)
68
69typedef 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.
73 */
74typedef periph_init_t *periph_init_func_t;
75
76struct periph_driver {
77 periph_init_func_t init;
78 char *driver_name;
79 TAILQ_HEAD(,cam_periph) units;
80 u_int generation;
81};
82
83typedef enum {
84 CAM_PERIPH_BIO,
85 CAM_PERIPH_NET
86} cam_periph_type;
87
88/* Generically usefull offsets into the peripheral private area */
89#define ppriv_ptr0 periph_priv.entries[0].ptr
90#define ppriv_ptr1 periph_priv.entries[1].ptr
91#define ppriv_field0 periph_priv.entries[0].field
92#define ppriv_field1 periph_priv.entries[1].field
93
94typedef void periph_start_t (struct cam_periph *periph,
95 union ccb *start_ccb);
96typedef cam_status periph_ctor_t (struct cam_periph *periph,
97 void *arg);
98typedef void periph_oninv_t (struct cam_periph *periph);
99typedef void periph_dtor_t (struct cam_periph *periph);
100struct cam_periph {
101 cam_pinfo pinfo;
102 periph_start_t *periph_start;
103 periph_oninv_t *periph_oninval;
104 periph_dtor_t *periph_dtor;
105 char *periph_name;
106 struct cam_path *path; /* Compiled path to device */
107 void *softc;
108 u_int32_t unit_number;
109 cam_periph_type type;
110 u_int32_t flags;
111#define CAM_PERIPH_RUNNING 0x01
112#define CAM_PERIPH_LOCKED 0x02
113#define CAM_PERIPH_LOCK_WANTED 0x04
114#define CAM_PERIPH_INVALID 0x08
115#define CAM_PERIPH_NEW_DEV_FOUND 0x10
116#define CAM_PERIPH_RECOVERY_INPROG 0x20
117 u_int32_t immediate_priority;
118 u_int32_t refcount;
119 SLIST_HEAD(, ccb_hdr) ccb_list; /* For "immediate" requests */
120 SLIST_ENTRY(cam_periph) periph_links;
121 TAILQ_ENTRY(cam_periph) unit_links;
122 ac_callback_t *deferred_callback;
123 ac_code deferred_ac;
124};
125
126#define CAM_PERIPH_MAXMAPS 2
127
128struct cam_periph_map_info {
129 int num_bufs_used;
130 struct buf *bp[CAM_PERIPH_MAXMAPS];
131};
132
133cam_status cam_periph_alloc(periph_ctor_t *periph_ctor,
134 periph_oninv_t *periph_oninvalidate,
135 periph_dtor_t *periph_dtor,
136 periph_start_t *periph_start,
137 char *name, cam_periph_type type, struct cam_path *,
138 ac_callback_t *, ac_code, void *arg);
139struct cam_periph *cam_periph_find(struct cam_path *path, char *name);
140int cam_periph_lock(struct cam_periph *periph, int priority);
141void cam_periph_unlock(struct cam_periph *periph);
142cam_status cam_periph_acquire(struct cam_periph *periph);
143void cam_periph_release(struct cam_periph *periph);
144void cam_periph_invalidate(struct cam_periph *periph);
145int cam_periph_mapmem(union ccb *ccb,
146 struct cam_periph_map_info *mapinfo);
147void cam_periph_unmapmem(union ccb *ccb,
148 struct cam_periph_map_info *mapinfo);
149union ccb *cam_periph_getccb(struct cam_periph *periph,
150 u_int32_t priority);
151void cam_periph_ccbwait(union ccb *ccb);
152int cam_periph_runccb(union ccb *ccb,
153 int (*error_routine)(union ccb *ccb,
154 cam_flags camflags,
155 u_int32_t sense_flags),
156 cam_flags camflags, u_int32_t sense_flags,
157 struct devstat *ds);
158int cam_periph_ioctl(struct cam_periph *periph, int cmd,
159 caddr_t addr,
160 int (*error_routine)(union ccb *ccb,
161 cam_flags camflags,
162 u_int32_t sense_flags));
163void cam_freeze_devq(struct cam_path *path);
164u_int32_t cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
165 u_int32_t opening_reduction, u_int32_t timeout,
166 int getcount_only);
167void cam_periph_async(struct cam_periph *periph, u_int32_t code,
168 struct cam_path *path, void *arg);
169void cam_periph_bus_settle(struct cam_periph *periph,
170 u_int bus_settle_ms);
171void cam_periph_freeze_after_event(struct cam_periph *periph,
172 struct timeval* event_time,
173 u_int duration_ms);
174int cam_periph_error(union ccb *ccb, cam_flags camflags,
175 u_int32_t sense_flags, union ccb *save_ccb);
176
177#endif /* _KERNEL */
178#endif /* _CAM_CAM_PERIPH_H */