xref: /onnv-gate/usr/src/uts/sun4/sys/dmv.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright (c) 1998 by Sun Microsystems, Inc.
24*0Sstevel@tonic-gate  * All rights reserved.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _SYS_DMV_H
28*0Sstevel@tonic-gate #define	_SYS_DMV_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef	__cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate #ifndef _ASM
37*0Sstevel@tonic-gate #include <sys/inttypes.h>
38*0Sstevel@tonic-gate #endif
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate 
41*0Sstevel@tonic-gate /*
42*0Sstevel@tonic-gate  * Definitions for databearing mondo vector facility.  See PSARC 1998/222 for
43*0Sstevel@tonic-gate  * more details.
44*0Sstevel@tonic-gate  */
45*0Sstevel@tonic-gate 
46*0Sstevel@tonic-gate /*
47*0Sstevel@tonic-gate  * DMV layout.
48*0Sstevel@tonic-gate  *
49*0Sstevel@tonic-gate  *		  +--+----------------+----------+---------------------------+
50*0Sstevel@tonic-gate  *		  |63|62            61|60      48|47                        0|
51*0Sstevel@tonic-gate  *		  +--+----------------+----------+---------------------------+
52*0Sstevel@tonic-gate  *	Word 0:   | 1| reserved (MBZ) | dmv_inum | device private data       |
53*0Sstevel@tonic-gate  *		  +--+----------+----------------+---------------------------+
54*0Sstevel@tonic-gate  *	Word 1-7: | device private data                                      |
55*0Sstevel@tonic-gate  *		  +----------------------------------------------------------+
56*0Sstevel@tonic-gate  */
57*0Sstevel@tonic-gate 
58*0Sstevel@tonic-gate #define	DMV_INUM_SHIFT		48
59*0Sstevel@tonic-gate #define	DMV_INUM_MASK		0x1FFF
60*0Sstevel@tonic-gate #define	DMV_PRIVATE_MASK	0xFFFFFFFFFFFF
61*0Sstevel@tonic-gate 
62*0Sstevel@tonic-gate /*
63*0Sstevel@tonic-gate  * The following macro is designed to allow the construction of the first
64*0Sstevel@tonic-gate  * word of a DMV in software, for instance for testing purposes.
65*0Sstevel@tonic-gate  */
66*0Sstevel@tonic-gate #define	DMV_MAKE_DMV(dmv_inum, dev_private) \
67*0Sstevel@tonic-gate 	((UINT64_C(1) << 63) | \
68*0Sstevel@tonic-gate 	    ((((uint64_t)(dmv_inum)) & UINT64_C(DMV_INUM_MASK)) <<  \
69*0Sstevel@tonic-gate 	    DMV_INUM_SHIFT) | \
70*0Sstevel@tonic-gate 	    (((uint64_t)(dev_private)) & UINT64_C(DMV_PRIVATE_MASK)))
71*0Sstevel@tonic-gate 
72*0Sstevel@tonic-gate #define	DMV_IS_DMV(irdr0)	(((uint64_t)(irdr0)) >> 63)
73*0Sstevel@tonic-gate 
74*0Sstevel@tonic-gate 
75*0Sstevel@tonic-gate /*
76*0Sstevel@tonic-gate  * Version control for the dmv interfaces.
77*0Sstevel@tonic-gate  */
78*0Sstevel@tonic-gate 
79*0Sstevel@tonic-gate #define	DMV_INTERFACE_MAJOR_VERSION	1
80*0Sstevel@tonic-gate #define	DMV_INTERFACE_MINOR_VERSION	1
81*0Sstevel@tonic-gate 
82*0Sstevel@tonic-gate #ifndef _ASM
83*0Sstevel@tonic-gate 
84*0Sstevel@tonic-gate extern int dmv_interface_major_version;
85*0Sstevel@tonic-gate extern int dmv_interface_minor_version;
86*0Sstevel@tonic-gate 
87*0Sstevel@tonic-gate int dmv_add_intr(int dmv_inum, void (*routine)(), void *arg);
88*0Sstevel@tonic-gate int dmv_add_softintr(void (*routine)(void), void *arg);
89*0Sstevel@tonic-gate int dmv_rem_intr(int dmv_inum);
90*0Sstevel@tonic-gate 
91*0Sstevel@tonic-gate /*
92*0Sstevel@tonic-gate  * The following macros are for use with the intr_add_cpu and
93*0Sstevel@tonic-gate  * intr_rem_cpu functions.  These functions allow a driver to choose
94*0Sstevel@tonic-gate  * a CPU to be targeted by a device's interrupts, and also allow
95*0Sstevel@tonic-gate  * interrupt retargeting when a CPU is taken offline.  The macros
96*0Sstevel@tonic-gate  * convert a databearing inum to (and from) a value which will not
97*0Sstevel@tonic-gate  * clash with an ordinary inum, thus allowing both values to coexist
98*0Sstevel@tonic-gate  * in the same linked list.
99*0Sstevel@tonic-gate  *
100*0Sstevel@tonic-gate  * If a driver registers at least one soft interrupt handler for each
101*0Sstevel@tonic-gate  * databearing mondo is uses, and keeps track of the correspondence
102*0Sstevel@tonic-gate  * between them, it could also use the soft interrupt inum as input to
103*0Sstevel@tonic-gate  * intr_add_cpu.
104*0Sstevel@tonic-gate  */
105*0Sstevel@tonic-gate 
106*0Sstevel@tonic-gate #define	DMV_INUM_2_INUM(i)	(((i) | 0x8000) << 16)
107*0Sstevel@tonic-gate #define	INUM_2_DMV_INUM(i)	(((i) >> 16) & 0x1FFF)
108*0Sstevel@tonic-gate 
109*0Sstevel@tonic-gate /*
110*0Sstevel@tonic-gate  * DMV dispatch table entry.
111*0Sstevel@tonic-gate  *
112*0Sstevel@tonic-gate  * Note on consistency: we want to ensure that if dmv_func is valid, then
113*0Sstevel@tonic-gate  * dmv_arg is as well.  We don't want to have to do any locking in the
114*0Sstevel@tonic-gate  * interrupt handler, so instead we do the following:
115*0Sstevel@tonic-gate  *
116*0Sstevel@tonic-gate  * 1. When we initialize an entry, we set dmv_arg first, then do a membar #sync,
117*0Sstevel@tonic-gate  *    then set dmv_func.
118*0Sstevel@tonic-gate  *
119*0Sstevel@tonic-gate  * 2. When we clear an entry, we only clear dmv_func.
120*0Sstevel@tonic-gate  *
121*0Sstevel@tonic-gate  * 3. When the interrupt handler uses an entry, it uses either an ldx (in
122*0Sstevel@tonic-gate  *    the 32-bit kernel) or an atomic quad load (in the 64-bit kernel) to
123*0Sstevel@tonic-gate  *    get a matching func/arg pair.  If func is zero, there is no handler and
124*0Sstevel@tonic-gate  *    we discard the interrupt.
125*0Sstevel@tonic-gate  */
126*0Sstevel@tonic-gate 
127*0Sstevel@tonic-gate struct dmv_disp {
128*0Sstevel@tonic-gate 	void (*dmv_func)(void);
129*0Sstevel@tonic-gate 	void *dmv_arg;
130*0Sstevel@tonic-gate };
131*0Sstevel@tonic-gate 
132*0Sstevel@tonic-gate #endif	/* _ASM */
133*0Sstevel@tonic-gate 
134*0Sstevel@tonic-gate #ifdef	__cplusplus
135*0Sstevel@tonic-gate }
136*0Sstevel@tonic-gate #endif
137*0Sstevel@tonic-gate 
138*0Sstevel@tonic-gate #endif	/* _SYS_DMV_H */
139