cam_sim.h revision 168752 
1/*-
2 * Data structures and definitions for SCSI Interface Modules (SIMs).
3 *
4 * Copyright (c) 1997 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_sim.h 168752 2007-04-15 08:49:19Z scottl $
29 */
30
31#ifndef _CAM_CAM_SIM_H
32#define _CAM_CAM_SIM_H 1
33
34#ifdef _KERNEL
35
36/*
37 * The sim driver creates a sim for each controller.  The sim device
38 * queue is separately created in order to allow resource sharing between
39 * sims.  For instance, a driver may create one sim for each channel of
40 * a multi-channel controller and use the same queue for each channel.
41 * In this way, the queue resources are shared across all the channels
42 * of the multi-channel controller.
43 */
44
45struct cam_sim;
46struct cam_devq;
47
48typedef void (*sim_action_func)(struct cam_sim *sim, union ccb *ccb);
49typedef void (*sim_poll_func)(struct cam_sim *sim);
50
51struct cam_devq * cam_simq_alloc(u_int32_t max_sim_transactions);
52void		  cam_simq_free(struct cam_devq *devq);
53
54struct cam_sim *  cam_sim_alloc(sim_action_func sim_action,
55				sim_poll_func sim_poll,
56				const char *sim_name,
57				void *softc,
58				u_int32_t unit,
59				struct mtx *mtx,
60				int max_dev_transactions,
61				int max_tagged_dev_transactions,
62				struct cam_devq *queue);
63void		  cam_sim_free(struct cam_sim *sim, int free_devq);
64
65/* Optional sim attributes may be set with these. */
66void	cam_sim_set_path(struct cam_sim *sim, u_int32_t path_id);
67
68
69
70/* Convenience routines for accessing sim attributes. */
71static __inline u_int32_t    cam_sim_path(struct cam_sim *sim);
72static __inline const char * cam_sim_name(struct cam_sim *sim);
73static __inline void *	     cam_sim_softc(struct cam_sim *sim);
74static __inline u_int32_t    cam_sim_unit(struct cam_sim *sim);
75static __inline u_int32_t    cam_sim_bus(struct cam_sim *sim);
76
77
78
79/* Generically useful offsets into the sim private area */
80#define spriv_ptr0 sim_priv.entries[0].ptr
81#define spriv_ptr1 sim_priv.entries[1].ptr
82#define spriv_field0 sim_priv.entries[0].field
83#define spriv_field1 sim_priv.entries[1].field
84
85/*
86 * The sim driver should not access anything directly from this
87 * structure.
88 */
89struct cam_sim {
90	sim_action_func		sim_action;
91	sim_poll_func		sim_poll;
92	const char		*sim_name;
93	void			*softc;
94	struct mtx		*mtx;
95	u_int32_t		path_id;/* The Boot device may set this to 0? */
96	u_int32_t		unit_number;
97	u_int32_t		bus_id;
98	int			max_tagged_dev_openings;
99	int			max_dev_openings;
100	u_int32_t		flags;
101#define	CAM_SIM_REL_TIMEOUT_PENDING	0x01
102#define	CAM_SIM_MPSAFE			0x02
103	struct callout		callout;
104	struct cam_devq 	*devq;	/* Device Queue to use for this SIM */
105
106	/* "Pool" of inactive ccbs managed by xpt_alloc_ccb and xpt_free_ccb */
107	SLIST_HEAD(,ccb_hdr)	ccb_freeq;
108	/*
109	 * Maximum size of ccb pool.  Modified as devices are added/removed
110	 * or have their * opening counts changed.
111	 */
112	u_int			max_ccbs;
113	/* Current count of allocated ccbs */
114	u_int			ccb_count;
115
116};
117
118#define CAM_SIM_LOCK(sim)	mtx_lock((sim)->mtx);
119#define CAM_SIM_UNLOCK(sim)	mtx_unlock((sim)->mtx);
120
121static __inline u_int32_t
122cam_sim_path(struct cam_sim *sim)
123{
124	return (sim->path_id);
125}
126
127static __inline const char *
128cam_sim_name(struct cam_sim *sim)
129{
130	return (sim->sim_name);
131}
132
133static __inline void *
134cam_sim_softc(struct cam_sim *sim)
135{
136	return (sim->softc);
137}
138
139static __inline u_int32_t
140cam_sim_unit(struct cam_sim *sim)
141{
142	return (sim->unit_number);
143}
144
145static __inline u_int32_t
146cam_sim_bus(struct cam_sim *sim)
147{
148	return (sim->bus_id);
149}
150
151#endif /* _KERNEL */
152#endif /* _CAM_CAM_SIM_H */
153