cam_periph.h revision 58111 
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 58111 2000-03-15 21:55:48Z n_hibma $
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
38extern struct linker_set periphdriver_set;
39
40typedef void (periph_init_t)(void); /*
41				     * Callback informing the peripheral driver
42				     * it can perform it's initialization since
43				     * the XPT is now fully initialized.
44				     */
45typedef periph_init_t *periph_init_func_t;
46
47struct periph_driver {
48	periph_init_func_t	 init;
49	char			 *driver_name;
50	TAILQ_HEAD(,cam_periph)	 units;
51	u_int			 generation;
52};
53
54typedef enum {
55	CAM_PERIPH_BIO,
56	CAM_PERIPH_NET
57} cam_periph_type;
58
59/* Generically usefull offsets into the peripheral private area */
60#define ppriv_ptr0 periph_priv.entries[0].ptr
61#define ppriv_ptr1 periph_priv.entries[1].ptr
62#define ppriv_field0 periph_priv.entries[0].field
63#define ppriv_field1 periph_priv.entries[1].field
64
65typedef void		periph_start_t (struct cam_periph *periph,
66					union ccb *start_ccb);
67typedef cam_status	periph_ctor_t (struct cam_periph *periph,
68				       void *arg);
69typedef void		periph_oninv_t (struct cam_periph *periph);
70typedef void		periph_dtor_t (struct cam_periph *periph);
71struct cam_periph {
72	cam_pinfo		 pinfo;
73	periph_start_t		*periph_start;
74	periph_oninv_t		*periph_oninval;
75	periph_dtor_t		*periph_dtor;
76	char			*periph_name;
77	struct cam_path		*path;	/* Compiled path to device */
78	void			*softc;
79	u_int32_t		 unit_number;
80	cam_periph_type		 type;
81	u_int32_t		 flags;
82#define CAM_PERIPH_RUNNING		0x01
83#define CAM_PERIPH_LOCKED		0x02
84#define CAM_PERIPH_LOCK_WANTED		0x04
85#define CAM_PERIPH_INVALID		0x08
86#define CAM_PERIPH_NEW_DEV_FOUND	0x10
87#define CAM_PERIPH_RECOVERY_INPROG	0x20
88	u_int32_t		 immediate_priority;
89	u_int32_t		 refcount;
90	SLIST_HEAD(, ccb_hdr)	 ccb_list;	/* For "immediate" requests */
91	SLIST_ENTRY(cam_periph)  periph_links;
92	TAILQ_ENTRY(cam_periph)  unit_links;
93	ac_callback_t		*deferred_callback;
94	ac_code			 deferred_ac;
95};
96
97#define CAM_PERIPH_MAXMAPS	2
98
99struct cam_periph_map_info {
100	int		num_bufs_used;
101	struct buf	*bp[CAM_PERIPH_MAXMAPS];
102};
103
104cam_status cam_periph_alloc(periph_ctor_t *periph_ctor,
105			    periph_oninv_t *periph_oninvalidate,
106			    periph_dtor_t *periph_dtor,
107			    periph_start_t *periph_start,
108			    char *name, cam_periph_type type, struct cam_path *,
109			    ac_callback_t *, ac_code, void *arg);
110struct cam_periph *cam_periph_find(struct cam_path *path, char *name);
111int		cam_periph_lock(struct cam_periph *periph, int priority);
112void		cam_periph_unlock(struct cam_periph *periph);
113cam_status	cam_periph_acquire(struct cam_periph *periph);
114void		cam_periph_release(struct cam_periph *periph);
115void		cam_periph_invalidate(struct cam_periph *periph);
116int		cam_periph_mapmem(union ccb *ccb,
117				  struct cam_periph_map_info *mapinfo);
118void		cam_periph_unmapmem(union ccb *ccb,
119				    struct cam_periph_map_info *mapinfo);
120union ccb	*cam_periph_getccb(struct cam_periph *periph,
121				   u_int32_t priority);
122void		cam_periph_ccbwait(union ccb *ccb);
123int		cam_periph_runccb(union ccb *ccb,
124				  int (*error_routine)(union ccb *ccb,
125						       cam_flags camflags,
126						       u_int32_t sense_flags),
127				  cam_flags camflags, u_int32_t sense_flags,
128				  struct devstat *ds);
129int		cam_periph_ioctl(struct cam_periph *periph, int cmd,
130				 caddr_t addr,
131				 int (*error_routine)(union ccb *ccb,
132						      cam_flags camflags,
133						      u_int32_t sense_flags));
134void		cam_freeze_devq(struct cam_path *path);
135u_int32_t	cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
136				 u_int32_t opening_reduction, u_int32_t timeout,
137				 int getcount_only);
138void		cam_periph_async(struct cam_periph *periph, u_int32_t code,
139		 		 struct cam_path *path, void *arg);
140void		cam_periph_bus_settle(struct cam_periph *periph,
141				      u_int bus_settle_ms);
142void		cam_periph_freeze_after_event(struct cam_periph *periph,
143					      struct timeval* event_time,
144					      u_int duration_ms);
145int		cam_periph_error(union ccb *ccb, cam_flags camflags,
146				 u_int32_t sense_flags, union ccb *save_ccb);
147
148#endif /* _KERNEL */
149#endif /* _CAM_CAM_PERIPH_H */
150