xref: /onnv-gate/usr/src/uts/common/sys/sysevent/dr.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 2000-2002 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_SYS_SYSEVENT_DR_H
28*0Sstevel@tonic-gate #define	_SYS_SYSEVENT_DR_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 /*
37*0Sstevel@tonic-gate  * dr.h contains the publicly defined sysevent attribute names and values
38*0Sstevel@tonic-gate  * for all DR type sysevents.  Additions/removals/changes are subject to
39*0Sstevel@tonic-gate  * PSARC approval.
40*0Sstevel@tonic-gate  */
41*0Sstevel@tonic-gate 
42*0Sstevel@tonic-gate /*
43*0Sstevel@tonic-gate  * Event type EC_DR/ESC_DR_AP_STATE_CHANGE event schema
44*0Sstevel@tonic-gate  *	Event Class 	- EC_DR
45*0Sstevel@tonic-gate  *	Event Sub-Class - ESC_DR_AP_STATE_CHANGE
46*0Sstevel@tonic-gate  *	Event Publisher	- SUNW:kern:[dr_subsystem_name]
47*0Sstevel@tonic-gate  *	Attribute Name	- DR_AP_ID
48*0Sstevel@tonic-gate  *	Attribute Type	- SE_DATA_TYPE_STRING
49*0Sstevel@tonic-gate  *	Attribute Value	- [Attachment Point Identifier]
50*0Sstevel@tonic-gate  *	Attribute Name	- DR_HINT
51*0Sstevel@tonic-gate  *	Attribute Type	- SE_DATA_TYPE_STRING
52*0Sstevel@tonic-gate  *	Attribute Value	- DR_RESERVED_ATTR | DR_HINT_INSERT | DR_HINT_REMOVE
53*0Sstevel@tonic-gate  */
54*0Sstevel@tonic-gate #define	DR_AP_ID	"dr_ap_id"	/* Attachment point id */
55*0Sstevel@tonic-gate #define	DR_HINT	"dr_hint"		/* Operation hint */
56*0Sstevel@tonic-gate #define	DR_HINT_INSERT	"dr_insert"	/* Insert hint */
57*0Sstevel@tonic-gate #define	DR_HINT_REMOVE	"dr_remove"	/* Remove hint */
58*0Sstevel@tonic-gate #define	DR_RESERVED_ATTR	""
59*0Sstevel@tonic-gate 
60*0Sstevel@tonic-gate /*
61*0Sstevel@tonic-gate  * Useful macros for insert/remove event.
62*0Sstevel@tonic-gate  */
63*0Sstevel@tonic-gate #define	SE_NO_HINT		0x0
64*0Sstevel@tonic-gate #define	SE_HINT_INSERT		0x1
65*0Sstevel@tonic-gate #define	SE_HINT_REMOVE		0x2
66*0Sstevel@tonic-gate #define	SE_HINT2STR(h)		((h) == SE_HINT_INSERT ? DR_HINT_INSERT : \
67*0Sstevel@tonic-gate 				    (h) == SE_HINT_REMOVE ? DR_HINT_REMOVE : \
68*0Sstevel@tonic-gate 				    DR_RESERVED_ATTR)
69*0Sstevel@tonic-gate /*
70*0Sstevel@tonic-gate  * Event type EC_DR/ESC_DR_REQ event schema
71*0Sstevel@tonic-gate  *	Event Class	- EC_DR
72*0Sstevel@tonic-gate  *	Event Sub-Class	- ESC_DR_REQ
73*0Sstevel@tonic-gate  *	Event Publisher	- SUNW:kern:[dr_subsystem_name]
74*0Sstevel@tonic-gate  *	Attribute Name	- DR_AP_ID
75*0Sstevel@tonic-gate  *	Attribute Type	- SE_DATA_TYPE_STRING
76*0Sstevel@tonic-gate  *	Attribute Value	- [Attachment Point Name]
77*0Sstevel@tonic-gate  *	Attribute Name	- DR_REQ_TYPE
78*0Sstevel@tonic-gate  *	Attribute Type	- SE_DATA_TYPE_STRING
79*0Sstevel@tonic-gate  *	Attribute Value	- DR_RESERVED_ATTR | DR_REQ_INCOMING_RES |
80*0Sstevel@tonic-gate  *			DR_REQ_OUTGOING_RES | DR_REQ_INVESTIGATE_RES
81*0Sstevel@tonic-gate  */
82*0Sstevel@tonic-gate #define	DR_REQ_TYPE	"dr_request_type"	/* User request type */
83*0Sstevel@tonic-gate #define	DR_REQ_INCOMING_RES	"dr_request_incoming_resource"
84*0Sstevel@tonic-gate #define	DR_REQ_OUTGOING_RES	"dr_request_outgoing_resource"
85*0Sstevel@tonic-gate #define	DR_REQ_INVESTIGATE_RES	"dr_request_investigate_resource"
86*0Sstevel@tonic-gate 
87*0Sstevel@tonic-gate #define	SE_INVESTIGATE_RES	0x0
88*0Sstevel@tonic-gate #define	SE_INCOMING_RES		0x1
89*0Sstevel@tonic-gate #define	SE_OUTGOING_RES		0x2
90*0Sstevel@tonic-gate #define	SE_REQ2STR(h)		((h) == SE_INCOMING_RES ? \
91*0Sstevel@tonic-gate 					DR_REQ_INCOMING_RES : \
92*0Sstevel@tonic-gate 					(h) == SE_OUTGOING_RES ? \
93*0Sstevel@tonic-gate 					DR_REQ_OUTGOING_RES : \
94*0Sstevel@tonic-gate 					DR_REQ_INVESTIGATE_RES)
95*0Sstevel@tonic-gate 
96*0Sstevel@tonic-gate #ifdef	__cplusplus
97*0Sstevel@tonic-gate }
98*0Sstevel@tonic-gate #endif
99*0Sstevel@tonic-gate 
100*0Sstevel@tonic-gate #endif /* _SYS_SYSEVENT_DR_H */
101