cam_sim.h revision 139743 
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 139743 2005-01-05 22:34:37Z imp $
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				int max_dev_transactions,
60				int max_tagged_dev_transactions,
61				struct cam_devq *queue);
62void		  cam_sim_free(struct cam_sim *sim, int free_devq);
63
64/* Optional sim attributes may be set with these. */
65void	cam_sim_set_path(struct cam_sim *sim, u_int32_t path_id);
66
67
68
69/* Convenience routines for accessing sim attributes. */
70static __inline u_int32_t    cam_sim_path(struct cam_sim *sim);
71static __inline const char * cam_sim_name(struct cam_sim *sim);
72static __inline void *	     cam_sim_softc(struct cam_sim *sim);
73static __inline u_int32_t    cam_sim_unit(struct cam_sim *sim);
74static __inline u_int32_t    cam_sim_bus(struct cam_sim *sim);
75
76
77
78/* Generically useful offsets into the sim private area */
79#define spriv_ptr0 sim_priv.entries[0].ptr
80#define spriv_ptr1 sim_priv.entries[1].ptr
81#define spriv_field0 sim_priv.entries[0].field
82#define spriv_field1 sim_priv.entries[1].field
83
84/*
85 * The sim driver should not access anything directly from this
86 * structure.
87 */
88struct cam_sim {
89	sim_action_func		sim_action;
90	sim_poll_func		sim_poll;
91	const char		*sim_name;
92	void			*softc;
93	u_int32_t		path_id;/* The Boot device may set this to 0? */
94	u_int32_t		unit_number;
95	u_int32_t		bus_id;
96	int			max_tagged_dev_openings;
97	int			max_dev_openings;
98	u_int32_t		flags;
99#define		CAM_SIM_REL_TIMEOUT_PENDING	0x01
100	struct callout_handle	c_handle;
101	struct cam_devq 	*devq;	/* Device Queue to use for this SIM */
102};
103
104static __inline u_int32_t
105cam_sim_path(struct cam_sim *sim)
106{
107	return (sim->path_id);
108}
109
110static __inline const char *
111cam_sim_name(struct cam_sim *sim)
112{
113	return (sim->sim_name);
114}
115
116static __inline void *
117cam_sim_softc(struct cam_sim *sim)
118{
119	return (sim->softc);
120}
121
122static __inline u_int32_t
123cam_sim_unit(struct cam_sim *sim)
124{
125	return (sim->unit_number);
126}
127
128static __inline u_int32_t
129cam_sim_bus(struct cam_sim *sim)
130{
131	return (sim->bus_id);
132}
133
134#endif /* _KERNEL */
135#endif /* _CAM_CAM_SIM_H */
136