xref: /titanic_51/usr/src/lib/fm/topo/libtopo/common/libtopo.h (revision 78d5422c60f052a980af8624e3b6c7f589577c8f)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _LIBTOPO_H
28 #define	_LIBTOPO_H
29 
30 #include <sys/nvpair.h>
31 #include <stdio.h>
32 #include <libdevinfo.h>
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 #define	TOPO_VERSION	1	/* Library ABI Interface Version */
39 
40 typedef struct topo_hdl topo_hdl_t;
41 typedef struct topo_node tnode_t;
42 typedef struct topo_walk topo_walk_t;
43 typedef int32_t topo_instance_t;
44 typedef uint32_t topo_version_t;
45 
46 typedef struct topo_list {
47 	struct topo_list *l_prev;
48 	struct topo_list *l_next;
49 } topo_list_t;
50 
51 typedef struct topo_faclist {
52 	topo_list_t	tf_list;
53 	tnode_t		*tf_node;
54 } topo_faclist_t;
55 
56 /*
57  * The following functions, error codes and data structures are private
58  * to libtopo snapshot consumers and enumerator modules.
59  */
60 extern topo_hdl_t *topo_open(int, const char *, int *);
61 extern void topo_close(topo_hdl_t *);
62 extern char *topo_snap_hold(topo_hdl_t *, const char *, int *);
63 extern char *topo_snap_hold_no_forceload(topo_hdl_t *, const char *, int *);
64 extern void topo_snap_release(topo_hdl_t *);
65 
66 /*
67  * Snapshot walker support
68  */
69 typedef int (*topo_walk_cb_t)(topo_hdl_t *, tnode_t *, void *);
70 
71 extern topo_walk_t *topo_walk_init(topo_hdl_t *, const char *, topo_walk_cb_t,
72     void *, int *);
73 extern int topo_walk_step(topo_walk_t *, int);
74 extern void topo_walk_fini(topo_walk_t *);
75 extern di_node_t topo_hdl_devinfo(topo_hdl_t *);
76 extern di_prom_handle_t topo_hdl_prominfo(topo_hdl_t *);
77 
78 /*
79  * Walk status returned from walker
80  */
81 #define	TOPO_WALK_ERR		-1
82 #define	TOPO_WALK_NEXT		0
83 #define	TOPO_WALK_TERMINATE	1
84 
85 /*
86  * Types of walks: depth-first (child) or breadth-first (sibling)
87  */
88 #define	TOPO_WALK_CHILD		0x0001
89 #define	TOPO_WALK_SIBLING	0x0002
90 
91 /*
92  * FMRI helper routines
93  */
94 extern int topo_fmri_present(topo_hdl_t *, nvlist_t *, int *);
95 extern int topo_fmri_replaced(topo_hdl_t *, nvlist_t *, int *);
96 extern int topo_fmri_contains(topo_hdl_t *, nvlist_t *, nvlist_t *, int *);
97 extern int topo_fmri_expand(topo_hdl_t *, nvlist_t *, int *);
98 extern int topo_fmri_unusable(topo_hdl_t *, nvlist_t *, int *);
99 extern int topo_fmri_service_state(topo_hdl_t *, nvlist_t *, int *);
100 extern int topo_fmri_retire(topo_hdl_t *, nvlist_t *, int *);
101 extern int topo_fmri_unretire(topo_hdl_t *, nvlist_t *, int *);
102 extern int topo_fmri_nvl2str(topo_hdl_t *, nvlist_t *, char **, int *);
103 extern int topo_fmri_str2nvl(topo_hdl_t *, const char *, nvlist_t **, int *);
104 extern int topo_fmri_asru(topo_hdl_t *, nvlist_t *, nvlist_t **, int *);
105 extern int topo_fmri_fru(topo_hdl_t *, nvlist_t *, nvlist_t **,
106     int *);
107 extern int topo_fmri_label(topo_hdl_t *, nvlist_t *, char **, int *);
108 extern int topo_fmri_serial(topo_hdl_t *, nvlist_t *, char **, int *);
109 extern int topo_fmri_compare(topo_hdl_t *, nvlist_t *, nvlist_t *, int *);
110 extern int topo_fmri_facility(topo_hdl_t *, nvlist_t *, const char *,
111     uint32_t, topo_walk_cb_t, void *, int *);
112 
113 /*
114  * Private utility functions for fmd
115  */
116 extern ulong_t topo_fmri_strhash(topo_hdl_t *, const char *);
117 extern boolean_t topo_fmri_strcmp(topo_hdl_t *, const char *, const char *);
118 
119 /*
120  * Topo node utilities: callable from topo_walk_step() callback or module
121  * enumeration, topo_mod_enumerate()
122  */
123 extern char *topo_node_name(tnode_t *);
124 extern topo_instance_t topo_node_instance(tnode_t *);
125 extern tnode_t *topo_node_parent(tnode_t *);
126 extern void *topo_node_private(tnode_t *);
127 extern int topo_node_flags(tnode_t *);
128 extern int topo_node_asru(tnode_t *, nvlist_t **, nvlist_t *, int *);
129 extern int topo_node_fru(tnode_t *, nvlist_t **, nvlist_t *, int *);
130 extern int topo_node_resource(tnode_t *, nvlist_t **, int *);
131 extern int topo_node_label(tnode_t *, char **, int *);
132 extern tnode_t *topo_node_lookup(tnode_t *, const char *, topo_instance_t);
133 extern int topo_method_invoke(tnode_t *node, const char *, topo_version_t,
134     nvlist_t *, nvlist_t **, int *);
135 extern boolean_t topo_method_supported(tnode_t *, const char *,
136     topo_version_t);
137 extern int topo_node_facility(topo_hdl_t *, tnode_t *, const char *,
138     uint32_t, topo_faclist_t *, int *);
139 
140 /*
141  * Node flags: denotes type of node
142  */
143 #define	TOPO_NODE_DEFAULT	0
144 #define	TOPO_NODE_FACILITY	1
145 
146 #define	TOPO_FAC_TYPE_SENSOR	"sensor"
147 #define	TOPO_FAC_TYPE_INDICATOR	"indicator"
148 
149 /*
150  * Topo property get functions
151  */
152 extern int topo_prop_get_int32(tnode_t *, const char *, const char *,
153     int32_t *, int *);
154 extern int topo_prop_get_uint32(tnode_t *, const char *, const char *,
155     uint32_t *, int *);
156 extern int topo_prop_get_int64(tnode_t *, const char *, const char *,
157     int64_t *, int *);
158 extern int topo_prop_get_uint64(tnode_t *, const char *, const char *,
159     uint64_t *, int *);
160 extern int topo_prop_get_double(tnode_t *, const char *, const char *,
161     double *, int *);
162 extern int topo_prop_get_string(tnode_t *, const char *, const char *,
163     char **, int *);
164 extern int topo_prop_get_fmri(tnode_t *, const char *, const char *,
165     nvlist_t **, int *);
166 extern int topo_prop_get_int32_array(tnode_t *, const char *, const char *,
167     int32_t **, uint_t *, int *);
168 extern int topo_prop_get_uint32_array(tnode_t *, const char *, const char *,
169     uint32_t **, uint_t *, int *);
170 extern int topo_prop_get_int64_array(tnode_t *, const char *, const char *,
171     int64_t **, uint_t *, int *);
172 extern int topo_prop_get_uint64_array(tnode_t *, const char *, const char *,
173     uint64_t **, uint_t *, int *);
174 extern int topo_prop_get_string_array(tnode_t *, const char *, const char *,
175     char ***, uint_t *, int *);
176 extern int topo_prop_get_fmri_array(tnode_t *, const char *, const char *,
177     nvlist_t ***, uint_t *, int *);
178 
179 /*
180  * Topo property set functions
181  */
182 extern int topo_prop_set_int32(tnode_t *, const char *, const char *, int,
183     int32_t, int *);
184 extern int topo_prop_set_uint32(tnode_t *, const char *, const char *, int,
185     uint32_t, int *);
186 extern int topo_prop_set_int64(tnode_t *, const char *, const char *,
187     int, int64_t, int *);
188 extern int topo_prop_set_uint64(tnode_t *, const char *, const char *,
189     int, uint64_t, int *);
190 extern int topo_prop_set_double(tnode_t *, const char *, const char *,
191     int, double, int *);
192 extern int topo_prop_set_string(tnode_t *, const char *, const char *,
193     int, const char *, int *);
194 extern int topo_prop_set_fmri(tnode_t *, const char *, const char *,
195     int, const nvlist_t *, int *);
196 extern int topo_prop_set_int32_array(tnode_t *, const char *, const char *, int,
197     int32_t *, uint_t, int *);
198 extern int topo_prop_set_uint32_array(tnode_t *, const char *, const char *,
199     int, uint32_t *, uint_t, int *);
200 extern int topo_prop_set_int64_array(tnode_t *, const char *, const char *,
201     int, int64_t *, uint_t, int *);
202 extern int topo_prop_set_uint64_array(tnode_t *, const char *, const char *,
203     int, uint64_t *, uint_t, int *);
204 extern int topo_prop_set_string_array(tnode_t *, const char *, const char *,
205     int, const char **, uint_t, int *);
206 extern int topo_prop_set_fmri_array(tnode_t *, const char *, const char *,
207     int, const nvlist_t **, uint_t, int *);
208 
209 #define	TOPO_PROP_IMMUTABLE	0
210 #define	TOPO_PROP_MUTABLE	0x01
211 #define	TOPO_PROP_NONVOLATILE	0x02
212 
213 /* Protocol property group and property names */
214 #define	TOPO_PGROUP_PROTOCOL	"protocol"	/* Required property group */
215 #define	TOPO_PROP_RESOURCE	"resource"	/* resource FMRI */
216 #define	TOPO_PROP_ASRU		"ASRU"		/* ASRU FMRI */
217 #define	TOPO_PROP_FRU		"FRU"		/* FRU FMRI */
218 #define	TOPO_PROP_MOD		"module"	/* software module FMRI */
219 #define	TOPO_PROP_PKG		"package"	/* software package FMRI */
220 #define	TOPO_PROP_LABEL		"label"		/*  property LABEL */
221 
222 #define	TOPO_METH_FAC_ENUM	"fac_enum"
223 
224 /*
225  * System property group
226  */
227 #define	TOPO_PGROUP_SYSTEM	"system"
228 #define	TOPO_PROP_ISA		"isa"
229 #define	TOPO_PROP_MACHINE	"machine"
230 
231 /*
232  * These enum definitions are used to define a set of error tags associated with
233  * libtopo error conditions occuring during the adminstration of
234  * properties, invocation of methods and fmri-based queries.  The shell script
235  * mkerror.sh is used to parse this file and create a corresponding topo_error.c
236  * source file.
237  *
238  * If you do something other than add a new error tag here, you may need to
239  * update the mkerror shell script as it is based upon simple regexps.
240  */
241 typedef enum topo_prop_errno {
242     ETOPO_PROP_UNKNOWN = 3000, /* unknown topo prop error */
243     ETOPO_PROP_NOENT,   /* undefined property or property group */
244     ETOPO_PROP_DEFD,    /* static property already defined */
245     ETOPO_PROP_NOMEM,   /* memory limit exceeded during property allocation */
246     ETOPO_PROP_TYPE,    /* invalid property type */
247     ETOPO_PROP_NAME,    /* invalid property name */
248     ETOPO_PROP_NOINHERIT, /* can not inherit property */
249     ETOPO_PROP_NVL,	/* malformed property nvlist */
250     ETOPO_PROP_METHOD,	/* get property method failed */
251     ETOPO_PROP_END	/* end of prop errno list (to ease auto-merge) */
252 } topo_prop_errno_t;
253 
254 typedef enum topo_method_errno {
255     ETOPO_METHOD_UNKNOWN = 3100, /* unknown topo method error */
256     ETOPO_METHOD_INVAL,		/* invalid method registration */
257     ETOPO_METHOD_NOTSUP,	/* method not supported */
258     ETOPO_METHOD_FAIL,		/* method failed */
259     ETOPO_METHOD_VEROLD,	/* app is compiled to use obsolete method */
260     ETOPO_METHOD_VERNEW,	/* app is compiled to use obsolete method */
261     ETOPO_METHOD_NOMEM,		/* memory limit exceeded during method op */
262     ETOPO_METHOD_DEFD,		/* method op already defined */
263     ETOPO_METHOD_END		/* end of method errno list */
264 } topo_method_errno_t;
265 
266 typedef enum topo_fmri_errno {
267     ETOPO_FMRI_UNKNOWN = 3200, /* unknown topo fmri error */
268     ETOPO_FMRI_NVL,		/* nvlist allocation failure for FMRI */
269     ETOPO_FMRI_VERSION,		/* invalid FMRI scheme version */
270     ETOPO_FMRI_MALFORM,		/* malformed FMRI */
271     ETOPO_FMRI_NOMEM,		/* memory limit exceeded */
272     ETOPO_FMRI_END		/* end of fmri errno list */
273 } topo_fmri_errno_t;
274 
275 typedef enum topo_hdl_errno {
276     ETOPO_HDL_UNKNOWN = 3300,	/* unknown topo handle error */
277     ETOPO_HDL_ABIVER,		/* handle opened with invalid ABI version */
278     ETOPO_HDL_SNAP,		/* snapshot already taken */
279     ETOPO_HDL_INVAL,		/* invalid argument specified */
280     ETOPO_HDL_UUID,		/* uuid already set */
281     ETOPO_HDL_NOMEM,		/* memory limit exceeded */
282     ETOPO_HDL_END		/* end of handle errno list */
283 } topo_hdl_errno_t;
284 
285 extern const char *topo_strerror(int);
286 extern void topo_hdl_strfree(topo_hdl_t *, char *);
287 extern void topo_debug_set(topo_hdl_t *, const char *, const char *);
288 
289 /*
290  * The following functions and data structures to support property
291  * observability are private to the fmtopo command.
292  */
293 
294 /*
295  * Each topology node advertises the name and data stability of each of its
296  * modules and properties. (see attributes(5)).
297  */
298 
299 /*
300  * Topo stability attributes
301  */
302 typedef enum topo_stability {
303 	TOPO_STABILITY_UNKNOWN = 0,	/* private to libtopo */
304 	TOPO_STABILITY_INTERNAL,	/* private to libtopo */
305 	TOPO_STABILITY_PRIVATE,		/* private to Sun */
306 	TOPO_STABILITY_OBSOLETE,	/* scheduled for removal */
307 	TOPO_STABILITY_EXTERNAL,	/* not controlled by Sun */
308 	TOPO_STABILITY_UNSTABLE,	/* new or rapidly changing */
309 	TOPO_STABILITY_EVOLVING,	/* less rapidly changing */
310 	TOPO_STABILITY_STABLE,		/* mature interface from Sun */
311 	TOPO_STABILITY_STANDARD		/* industry standard */
312 } topo_stability_t;
313 
314 #define	TOPO_STABILITY_MAX	TOPO_STABILITY_STANDARD	/* max valid stab */
315 
316 typedef struct topo_pgroup_info {
317 	const char *tpi_name;		/* property group name */
318 	topo_stability_t tpi_namestab;	/* stability of group name */
319 	topo_stability_t tpi_datastab;	/* stability of all property values */
320 	topo_version_t tpi_version;	/* version of pgroup definition */
321 } topo_pgroup_info_t;
322 
323 extern topo_stability_t topo_name2stability(const char *);
324 extern const char *topo_stability2name(topo_stability_t);
325 extern void topo_pgroup_destroy(tnode_t *, const char *);
326 extern topo_pgroup_info_t *topo_pgroup_info(tnode_t *, const char *, int *);
327 
328 typedef enum {
329 	TOPO_TYPE_INVALID = 0,
330 	TOPO_TYPE_BOOLEAN,	/* boolean */
331 	TOPO_TYPE_INT32,	/* int32_t */
332 	TOPO_TYPE_UINT32,	/* uint32_t */
333 	TOPO_TYPE_INT64,	/* int64_t */
334 	TOPO_TYPE_UINT64,	/* uint64_t */
335 	TOPO_TYPE_STRING,	/* const char* */
336 	TOPO_TYPE_TIME,		/* uint64_t */
337 	TOPO_TYPE_SIZE,		/* uint64_t */
338 	TOPO_TYPE_FMRI,		/* nvlist_t */
339 	TOPO_TYPE_INT32_ARRAY,	/* array of int32_t */
340 	TOPO_TYPE_UINT32_ARRAY,	/* array of uint32_t */
341 	TOPO_TYPE_INT64_ARRAY,	/* array of int64_t */
342 	TOPO_TYPE_UINT64_ARRAY,	/* array of uint64_t */
343 	TOPO_TYPE_STRING_ARRAY,	/* array of const char* */
344 	TOPO_TYPE_FMRI_ARRAY,	/* array of nvlist_t */
345 	TOPO_TYPE_DOUBLE	/* double */
346 } topo_type_t;
347 
348 extern nvlist_t *topo_prop_getprops(tnode_t *, int *err);
349 extern int topo_prop_getprop(tnode_t *, const char *, const char *,
350     nvlist_t *, nvlist_t **, int *);
351 extern int topo_prop_getpgrp(tnode_t *, const char *, nvlist_t **, int *);
352 extern int topo_prop_setprop(tnode_t *, const char *, nvlist_t *,
353     int, nvlist_t *, int *);
354 extern int topo_fmri_getprop(topo_hdl_t *, nvlist_t *, const char *,
355     const char *, nvlist_t *,  nvlist_t **, int *);
356 extern int topo_fmri_getpgrp(topo_hdl_t *, nvlist_t *, const char *,
357     nvlist_t **, int *);
358 extern int topo_fmri_setprop(topo_hdl_t *, nvlist_t *, const char *,
359     nvlist_t *, int, nvlist_t *, int *);
360 
361 /* Property node NVL names used in topo_prop_getprops */
362 #define	TOPO_PROP_GROUP		"property-group"
363 #define	TOPO_PROP_GROUP_NAME	"property-group-name"
364 #define	TOPO_PROP_GROUP_DSTAB	"property-group-data-stability"
365 #define	TOPO_PROP_GROUP_NSTAB	"property-group-name-stability"
366 #define	TOPO_PROP_GROUP_VERSION	"property-group-version"
367 #define	TOPO_PROP_VAL		"property"
368 #define	TOPO_PROP_VAL_NAME	"property-name"
369 #define	TOPO_PROP_VAL_VAL	"property-value"
370 #define	TOPO_PROP_VAL_TYPE	"property-type"
371 #define	TOPO_PROP_FLAG		"property-flag"
372 
373 /*
374  * ARGS list used in topo property methods
375  */
376 #define	TOPO_PROP_ARGS	"args"
377 #define	TOPO_PROP_PARGS	"private-args"
378 
379 extern int topo_xml_print(topo_hdl_t *, FILE *, const char *scheme, int *);
380 
381 extern void *topo_hdl_alloc(topo_hdl_t *, size_t);
382 extern void *topo_hdl_zalloc(topo_hdl_t *, size_t);
383 extern void topo_hdl_free(topo_hdl_t *, void *, size_t);
384 extern int topo_hdl_nvalloc(topo_hdl_t *, nvlist_t **, uint_t);
385 extern int topo_hdl_nvdup(topo_hdl_t *, nvlist_t *, nvlist_t **);
386 extern char *topo_hdl_strdup(topo_hdl_t *, const char *);
387 
388 /*
389  * Interfaces for converting sensor/indicator types, units, states, etc to
390  * a string
391  */
392 void topo_sensor_type_name(uint32_t type, char *buf, size_t len);
393 void topo_sensor_units_name(uint8_t type, char *buf, size_t len);
394 void topo_led_type_name(uint8_t type, char *buf, size_t len);
395 void topo_led_state_name(uint8_t type, char *buf, size_t len);
396 void topo_sensor_state_name(uint32_t sensor_type, uint8_t state, char *buf,
397     size_t len);
398 
399 /*
400  * Defines for standard properties for sensors and indicators
401  */
402 #define	TOPO_PGROUP_FACILITY	"facility"
403 
404 #define	TOPO_SENSOR_READING	"reading"
405 #define	TOPO_SENSOR_STATE	"state"
406 #define	TOPO_SENSOR_CLASS	"sensor-class"
407 #define	TOPO_FACILITY_TYPE	"type"
408 #define	TOPO_SENSOR_UNITS	"units"
409 #define	TOPO_LED_MODE		"mode"
410 
411 /*
412  * Sensor Classes
413  *
414  * The "sensor-class" property in the "facility" propgroup on
415  * facility nodes of type "sensor" should be set to one of these
416  * two values.
417  *
418  * Threshold sensors provide an analog sensor reading via the
419  * "reading" property in the facility propgroup.  They will also
420  * provide one or more discrete states via the "state" property
421  * in the facility propgroup.
422  *
423  * Discrete sensors will not provide an analog reading by will
424  * provide one or more discrete states via the "state" property
425  * in the facility propgroup.
426  */
427 #define	TOPO_SENSOR_CLASS_THRESHOLD	"threshold"
428 #define	TOPO_SENSOR_CLASS_DISCRETE	"discrete"
429 
430 /*
431  * Sensor unit types.  We're using the unit types and corresponding
432  * codes described in the IPMI 2.0 spec as a reference as it seems to be a
433  * reasonably comprehensive list.  This also simplifies the IPMI provider code
434  * since the unit type codes will map exactly to what libtopo uses (so no
435  * conversion necessary).
436  */
437 typedef enum topo_sensor_unit {
438 	TOPO_SENSOR_UNITS_UNSPECIFIED = 0,
439 	TOPO_SENSOR_UNITS_DEGREES_C,
440 	TOPO_SENSOR_UNITS_DEGREES_F,
441 	TOPO_SENSOR_UNITS_DEGREES_K,
442 	TOPO_SENSOR_UNITS_VOLTS,
443 	TOPO_SENSOR_UNITS_AMPS,
444 	TOPO_SENSOR_UNITS_WATTS,
445 	TOPO_SENSOR_UNITS_JOULES,
446 	TOPO_SENSOR_UNITS_COULOMBS,
447 	TOPO_SENSOR_UNITS_VA,
448 	TOPO_SENSOR_UNITS_NITS,
449 	TOPO_SENSOR_UNITS_LUMEN,
450 	TOPO_SENSOR_UNITS_LUX,
451 	TOPO_SENSOR_UNITS_CANDELA,
452 	TOPO_SENSOR_UNITS_KPA,
453 	TOPO_SENSOR_UNITS_PSI,
454 
455 	TOPO_SENSOR_UNITS_NEWTON,
456 	TOPO_SENSOR_UNITS_CFM,
457 	TOPO_SENSOR_UNITS_RPM,
458 	TOPO_SENSOR_UNITS_HZ,
459 	TOPO_SENSOR_UNITS_MICROSEC,
460 	TOPO_SENSOR_UNITS_MILLISEC,
461 	TOPO_SENSOR_UNITS_SECS,
462 	TOPO_SENSOR_UNITS_MIN,
463 	TOPO_SENSOR_UNITS_HOUR,
464 	TOPO_SENSOR_UNITS_DAY,
465 	TOPO_SENSOR_UNITS_WEEK,
466 	TOPO_SENSOR_UNITS_MIL,
467 	TOPO_SENSOR_UNITS_INCHES,
468 	TOPO_SENSOR_UNITS_FEET,
469 	TOPO_SENSOR_UNITS_CUB_INCH,
470 	TOPO_SENSOR_UNITS_CUB_FEET,
471 
472 	TOPO_SENSOR_UNITS_MM,
473 	TOPO_SENSOR_UNITS_CM,
474 	TOPO_SENSOR_UNITS_METERS,
475 	TOPO_SENSOR_UNITS_CUB_CM,
476 	TOPO_SENSOR_UNITS_CUB_METER,
477 	TOPO_SENSOR_UNITS_LITERS,
478 	TOPO_SENSOR_UNITS_FLUID_OUNCE,
479 	TOPO_SENSOR_UNITS_RADIANS,
480 	TOPO_SENSOR_UNITS_STERADIANS,
481 	TOPO_SENSOR_UNITS_REVOLUTIONS,
482 	TOPO_SENSOR_UNITS_CYCLES,
483 	TOPO_SENSOR_UNITS_GRAVITIES,
484 	TOPO_SENSOR_UNITS_OUNCE,
485 	TOPO_SENSOR_UNITS_POUND,
486 	TOPO_SENSOR_UNITS_FOOT_POUND,
487 	TOPO_SENSOR_UNITS_OZ_INCH,
488 
489 	TOPO_SENSOR_UNITS_GAUSS,
490 	TOPO_SENSOR_UNITS_GILBERTS,
491 	TOPO_SENSOR_UNITS_HENRY,
492 	TOPO_SENSOR_UNITS_MILHENRY,
493 	TOPO_SENSOR_UNITS_FARAD,
494 	TOPO_SENSOR_UNITS_MICROFARAD,
495 	TOPO_SENSOR_UNITS_OHMS,
496 	TOPO_SENSOR_UNITS_SIEMENS,
497 	TOPO_SENSOR_UNITS_MOLE,
498 	TOPO_SENSOR_UNITS_BECQUEREL,
499 	TOPO_SENSOR_UNITS_PPM,
500 	TOPO_SENSOR_UNITS_RESERVED1,
501 	TOPO_SENSOR_UNITS_DECIBELS,
502 	TOPO_SENSOR_UNITS_DBA,
503 	TOPO_SENSOR_UNITS_DBC,
504 	TOPO_SENSOR_UNITS_GRAY,
505 
506 	TOPO_SENSOR_UNITS_SIEVERT,
507 	TOPO_SENSOR_UNITS_COLOR_TEMP_K,
508 	TOPO_SENSOR_UNITS_BIT,
509 	TOPO_SENSOR_UNITS_KILOBIT,
510 	TOPO_SENSOR_UNITS_MEGABIT,
511 	TOPO_SENSOR_UNITS_GIGABIT,
512 	TOPO_SENSOR_UNITS_BYTE,
513 	TOPO_SENSOR_UNITS_KILOBYTE,
514 	TOPO_SENSOR_UNITS_MEGABYTE,
515 	TOPO_SENSOR_UNITS_GIGABYTE,
516 	TOPO_SENSOR_UNITS_WORD,
517 	TOPO_SENSOR_UNITS_DWORD,
518 	TOPO_SENSOR_UNITS_QWORD,
519 	TOPO_SENSOR_UNITS_MEMLINE,
520 	TOPO_SENSOR_UNITS_HIT,
521 	TOPO_SENSOR_UNITS_MISS,
522 
523 	TOPO_SENSOR_UNITS_RETRY,
524 	TOPO_SENSOR_UNITS_RESET,
525 	TOPO_SENSOR_UNITS_OVERFLOW,
526 	TOPO_SENSOR_UNITS_UNDERRUN,
527 	TOPO_SENSOR_UNITS_COLLISION,
528 	TOPO_SENSOR_UNITS_PACKETS,
529 	TOPO_SENSOR_UNITS_MESSAGES,
530 	TOPO_SENSOR_UNITS_CHARACTERS,
531 	TOPO_SENSOR_UNITS_ERROR,
532 	TOPO_SENSOR_UNITS_CE,
533 	TOPO_SENSOR_UNITS_UE,
534 	TOPO_SENSOR_UNITS_FATAL_ERROR,
535 	TOPO_SENSOR_UNITS_GRAMS
536 } topo_sensor_unit_t;
537 
538 /*
539  * These defines are used by the topo_method_sensor_failure to indicate
540  * whether the source of a sensor failure is believed to be the result of an
541  * internal failure, external condition or unknown
542  */
543 #define	TOPO_SENSOR_ERRSRC_UNKNOWN	0
544 #define	TOPO_SENSOR_ERRSRC_INTERNAL	1
545 #define	TOPO_SENSOR_ERRSRC_EXTERNAL	2
546 
547 /*
548  * Sensor Types amd the associated sensor-type-specific states
549  *
550  * These are used to decode the type and state properties in the facility
551  * propgroup on facility nodes of type sensor.
552  *
553  * Again we're basically using the same defines as for IPMI as it's serves
554  * as a good starting point and simplifies the IPMI provider code.  Of course
555  * other facility providers will need to convert from their native codes
556  * to the topo code when they set the type and state properties.
557  */
558 #define	TOPO_SENSOR_TYPE_RESERVED			0x0000
559 #define	TOPO_SENSOR_TYPE_TEMP				0x0001
560 #define	TOPO_SENSOR_TYPE_VOLTAGE			0x0002
561 #define	TOPO_SENSOR_TYPE_CURRENT			0x0003
562 #define	TOPO_SENSOR_TYPE_FAN				0x0004
563 #define	TOPO_SENSOR_TYPE_PHYSICAL			0x0005
564 
565 #define	TOPO_SENSOR_STATE_PHYSICAL_GENERAL		0x0001
566 #define	TOPO_SENSOR_STATE_PHYSICAL_BAY			0x0002
567 #define	TOPO_SENSOR_STATE_PHYSICAL_CARD			0x0004
568 #define	TOPO_SENSOR_STATE_PHYSICAL_PROCESSOR		0x0008
569 #define	TOPO_SENSOR_STATE_PHYSICAL_LAN			0x0010
570 #define	TOPO_SENSOR_STATE_PHYSICAL_DOCK			0x0020
571 #define	TOPO_SENSOR_STATE_PHYSICAL_FAN			0x0040
572 
573 #define	TOPO_SENSOR_TYPE_PLATFORM			0x0006
574 
575 #define	TOPO_SENSOR_STATE_PLATFORM_SECURE		0x0001
576 #define	TOPO_SENSOR_STATE_PLATFORM_USER_PASS		0x0002
577 #define	TOPO_SENSOR_STATE_PLATFORM_SETUP_PASS		0x0004
578 #define	TOPO_SENSOR_STATE_PLATFORM_NETWORK_PASS		0x0008
579 #define	TOPO_SENSOR_STATE_PLATFORM_OTHER_PASS		0x0010
580 #define	TOPO_SENSOR_STATE_PLATFORM_OUT_OF_BAND		0x0020
581 
582 #define	TOPO_SENSOR_TYPE_PROCESSOR			0x0007
583 
584 #define	TOPO_SENSOR_STATE_PROCESSOR_IERR		0x0001
585 #define	TOPO_SENSOR_STATE_PROCESSOR_THERMAL		0x0002
586 #define	TOPO_SENSOR_STATE_PROCESSOR_FRB1		0x0004
587 #define	TOPO_SENSOR_STATE_PROCESSOR_FRB2		0x0008
588 #define	TOPO_SENSOR_STATE_PROCESSOR_FRB3		0x0010
589 #define	TOPO_SENSOR_STATE_PROCESSOR_CONFIG		0x0020
590 #define	TOPO_SENSOR_STATE_PROCESSOR_SMBIOS		0x0040
591 #define	TOPO_SENSOR_STATE_PROCESSOR_PRESENT		0x0080
592 #define	TOPO_SENSOR_STATE_PROCESSOR_DISABLED		0x0100
593 #define	TOPO_SENSOR_STATE_PROCESSOR_TERMINATOR		0x0200
594 #define	TOPO_SENSOR_STATE_PROCESSOR_THROTTLED		0x0400
595 
596 #define	TOPO_SENSOR_TYPE_POWER_SUPPLY			0x0008
597 
598 #define	TOPO_SENSOR_STATE_POWER_SUPPLY_PRESENT		0x0001
599 #define	TOPO_SENSOR_STATE_POWER_SUPPLY_FAILURE		0x0002
600 #define	TOPO_SENSOR_STATE_POWER_SUPPLY_PREDFAIL		0x0004
601 #define	TOPO_SENSOR_STATE_POWER_SUPPLY_INPUT_LOST	0x0008
602 #define	TOPO_SENSOR_STATE_POWER_SUPPLY_INPUT_RANGE	0x0010
603 #define	TOPO_SENSOR_STATE_POWER_SUPPLY_INPUT_RANGE_PRES	0x0020
604 #define	TOPO_SENSOR_STATE_POWER_SUPPLY_CONFIG_ERR	0x0040
605 
606 #define	TOPO_SENSOR_TYPE_POWER_UNIT			0x0009
607 
608 #define	TOPO_SENSOR_STATE_POWER_UNIT_OFF		0x0001
609 #define	TOPO_SENSOR_STATE_POWER_UNIT_CYCLE		0x0002
610 #define	TOPO_SENSOR_STATE_POWER_UNIT_240_DOWN		0x0004
611 #define	TOPO_SENSOR_STATE_POWER_UNIT_INTERLOCK_DOWN	0x0008
612 #define	TOPO_SENSOR_STATE_POWER_UNIT_AC_LOST		0x0010
613 #define	TOPO_SENSOR_STATE_POWER_UNIT_SOFT_FAILURE	0x0020
614 #define	TOPO_SENSOR_STATE_POWER_UNIT_FAIL		0x0040
615 #define	TOPO_SENSOR_STATE_POWER_UNIT_PREDFAIL		0x0080
616 
617 #define	TOPO_SENSOR_TYPE_COOLING			0x000A
618 #define	TOPO_SENSOR_TYPE_OTHER				0x000B
619 
620 #define	TOPO_SENSOR_TYPE_MEMORY				0x000C
621 
622 #define	TOPO_SENSOR_STATE_MEMORY_CE			0x0001
623 #define	TOPO_SENSOR_STATE_MEMORY_UE			0x0002
624 #define	TOPO_SENSOR_STATE_MEMORY_PARITY			0x0004
625 #define	TOPO_SENSOR_STATE_MEMORY_SCRUB_FAIL		0x0008
626 #define	TOPO_SENSOR_STATE_MEMORY_DISABLED		0x0010
627 #define	TOPO_SENSOR_STATE_MEMORY_CE_LOG_LIMIT		0x0020
628 #define	TOPO_SENSOR_STATE_MEMORY_PRESENT		0x0040
629 #define	TOPO_SENSOR_STATE_MEMORY_CONFIG_ERR		0x0080
630 #define	TOPO_SENSOR_STATE_MEMORY_SPARE			0x0100
631 #define	TOPO_SENSOR_STATE_MEMORY_THROTTLED		0x0200
632 #define	TOPO_SENSOR_STATE_MEMORY_OVERTEMP		0x0400
633 
634 #define	TOPO_SENSOR_TYPE_BAY				0x000D
635 
636 #define	TOPO_SENSOR_STATE_BAY_PRESENT			0x0001
637 #define	TOPO_SENSOR_STATE_BAY_FAULT			0x0002
638 #define	TOPO_SENSOR_STATE_BAY_PREDFAIL			0x0004
639 #define	TOPO_SENSOR_STATE_BAY_SPARE			0x0008
640 #define	TOPO_SENSOR_STATE_BAY_CHECK			0x0010
641 #define	TOPO_SENSOR_STATE_BAY_CRITICAL			0x0020
642 #define	TOPO_SENSOR_STATE_BAY_FAILED			0x0040
643 #define	TOPO_SENSOR_STATE_BAY_REBUILDING		0x0080
644 #define	TOPO_SENSOR_STATE_BAY_ABORTED			0x0100
645 
646 #define	TOPO_SENSOR_TYPE_POST_RESIZE			0x000E
647 
648 #define	TOPO_SENSOR_TYPE_FIRMWARE			0x000F
649 
650 #define	TOPO_SENSOR_STATE_FIRMWARE_ERROR		0x0001
651 #define	TOPO_SENSOR_STATE_FIRMWARE_HANG			0x0002
652 #define	TOPO_SENSOR_STATE_FIRMWARE_PROGRESS		0x0004
653 
654 #define	TOPO_SENSOR_TYPE_EVENT_LOG			0x0010
655 
656 #define	TOPO_SENSOR_STATE_EVENT_LOG_CE			0x0001
657 #define	TOPO_SENSOR_STATE_EVENT_LOG_TYPE		0x0002
658 #define	TOPO_SENSOR_STATE_EVENT_LOG_RESET		0x0004
659 #define	TOPO_SENSOR_STATE_EVENT_LOG_ALL			0x0008
660 #define	TOPO_SENSOR_STATE_EVENT_LOG_FULL		0x0010
661 #define	TOPO_SENSOR_STATE_EVENT_LOG_ALMOST_FULL		0x0020
662 
663 #define	TOPO_SENSOR_TYPE_WATCHDOG1			0x0011
664 
665 #define	TOPO_SENSOR_STATE_WATCHDOG_BIOS_RESET		0x0001
666 #define	TOPO_SENSOR_STATE_WATCHDOG_OS_RESET		0x0002
667 #define	TOPO_SENSOR_STATE_WATCHDOG_OS_SHUTDOWN		0x0004
668 #define	TOPO_SENSOR_STATE_WATCHDOG_OS_PWR_DOWN		0x0008
669 #define	TOPO_SENSOR_STATE_WATCHDOG_OS_PWR_CYCLE		0x0010
670 #define	TOPO_SENSOR_STATE_WATCHDOG_OS_NMI_DIAG		0x0020
671 #define	TOPO_SENSOR_STATE_WATCHDOG_EXPIRED		0x0040
672 #define	TOPO_SENSOR_STATE_WATCHDOG_PRE_TIMEOUT_INT	0x0080
673 
674 #define	TOPO_SENSOR_TYPE_SYSTEM				0x0012
675 
676 #define	TOPO_SENSOR_STATE_SYSTEM_RECONF			0x0001
677 #define	TOPO_SENSOR_STATE_SYSTEM_BOOT			0x0002
678 #define	TOPO_SENSOR_STATE_SYSTEM_UNKNOWN_HW_FAILURE	0x0004
679 #define	TOPO_SENSOR_STATE_SYSTEM_AUX_LOG_UPDATED	0x0008
680 #define	TOPO_SENSOR_STATE_SYSTEM_PEF_ACTION		0x0010
681 #define	TOPO_SENSOR_STATE_SYSTEM_TIMETAMP_CLOCKSYNC	0x0020
682 
683 #define	TOPO_SENSOR_TYPE_CRITICAL			0x0013
684 
685 #define	TOPO_SENSOR_STATE_CRITICAL_EXT_NMI		0x0001
686 #define	TOPO_SENSOR_STATE_CRITICAL_BUS_TIMEOUT		0x0002
687 #define	TOPO_SENSOR_STATE_CRITICAL_IO_NMI		0x0004
688 #define	TOPO_SENSOR_STATE_CRITICAL_SW_NMI		0x0008
689 #define	TOPO_SENSOR_STATE_CRITICAL_PCI_PERR		0x0010
690 #define	TOPO_SENSOR_STATE_CRITICAL_PCI_SERR		0x0020
691 #define	TOPO_SENSOR_STATE_CRITICAL_EISA_FAILSAFE	0x0040
692 #define	TOPO_SENSOR_STATE_CRITICAL_BUS_CE		0x0080
693 #define	TOPO_SENSOR_STATE_CRITICAL_BUS_UE		0x0100
694 #define	TOPO_SENSOR_STATE_CRITICAL_FATAL_NMI		0x0200
695 #define	TOPO_SENSOR_STATE_CRITICAL_BUS_FATAL_ERR	0x0400
696 #define	TOPO_SENSOR_STATE_CRITICAL_BUS_DEGRADED		0x0800
697 
698 #define	TOPO_SENSOR_TYPE_BUTTON				0x0014
699 
700 #define	TOPO_SENSOR_STATE_BUTTON_PWR			0x0001
701 #define	TOPO_SENSOR_STATE_BUTTON_SLEEP			0x0002
702 #define	TOPO_SENSOR_STATE_BUTTON_RESET			0x0004
703 #define	TOPO_SENSOR_STATE_BUTTON_FRU_LATCH		0x0008
704 #define	TOPO_SENSOR_STATE_BUTTON_FRU_SERVICE		0x0010
705 
706 #define	TOPO_SENSOR_TYPE_MODULE				0x0015
707 #define	TOPO_SENSOR_TYPE_MICROCONTROLLER		0x0016
708 #define	TOPO_SENSOR_TYPE_CARD				0x0017
709 #define	TOPO_SENSOR_TYPE_CHASSIS			0x0018
710 
711 #define	TOPO_SENSOR_TYPE_CHIPSET			0x0019
712 
713 #define	TOPO_SENSOR_STATE_CHIPSET_PWR_CTL_FAIL		0x0001
714 
715 #define	TOPO_SENSOR_TYPE_FRU				0x001A
716 
717 #define	TOPO_SENSOR_TYPE_CABLE				0x001B
718 
719 #define	TOPO_SENSOR_STATE_CABLE_CONNECTED		0x0001
720 #define	TOPO_SENSOR_STATE_CABLE_CONFIG_ERR		0x0002
721 
722 #define	TOPO_SENSOR_TYPE_TERMINATOR			0x001C
723 
724 #define	TOPO_SENSOR_TYPE_BOOT_STATE			0x001D
725 
726 #define	TOPO_SENSOR_STATE_BOOT_STATE_BIOS_PWR_UP	0x0001
727 #define	TOPO_SENSOR_STATE_BOOT_STATE_BIOS_HARD_RESET	0x0002
728 #define	TOPO_SENSOR_STATE_BOOT_STATE_BIOS_WARM_RESET	0x0004
729 #define	TOPO_SENSOR_STATE_BOOT_STATE_PXE_BOOT		0x0008
730 #define	TOPO_SENSOR_STATE_BOOT_STATE_DIAG_BOOT		0x0010
731 #define	TOPO_SENSOR_STATE_BOOT_STATE_OS_HARD_RESET	0x0020
732 #define	TOPO_SENSOR_STATE_BOOT_STATE_OS_WARM_RESET	0x0040
733 #define	TOPO_SENSOR_STATE_BOOT_STATE_SYS_RESTART	0x0080
734 
735 #define	TOPO_SENSOR_TYPE_BOOT_ERROR			0x001E
736 
737 #define	TOPO_SENSOR_STATE_BOOT_ERROR_NOMEDIA		0x0001
738 #define	TOPO_SENSOR_STATE_BOOT_ERROR_NON_BOOTABLE_DISK	0x0002
739 #define	TOPO_SENSOR_STATE_BOOT_ERROR_NO_PXE_SERVER	0x0004
740 #define	TOPO_SENSOR_STATE_BOOT_ERROR_INV_BOOT_SECT	0x0008
741 #define	TOPO_SENSOR_STATE_BOOT_ERROR_USR_SELECT_TIMEOUT	0x0010
742 
743 #define	TOPO_SENSOR_TYPE_BOOT_OS			0x001F
744 
745 #define	TOPO_SENSOR_STATE_BOOT_OS_A_DRV_BOOT_COMPLETE	0x0001
746 #define	TOPO_SENSOR_STATE_BOOT_OS_C_DRV_BOOT_COMPLETE	0x0002
747 #define	TOPO_SENSOR_STATE_BOOT_OS_PXE_BOOT_COMPLETE	0x0004
748 #define	TOPO_SENSOR_STATE_BOOT_OS_DIAG_BOOT_COMPLETE	0x0008
749 #define	TOPO_SENSOR_STATE_BOOT_OS_CDROM_BOOT_COMPLETE	0x0010
750 #define	TOPO_SENSOR_STATE_BOOT_OS_ROM_BOOT_COMPLETE	0x0020
751 #define	TOPO_SENSOR_STATE_BOOT_OS_UNSPEC_BOOT_COMPLETE	0x0040
752 
753 #define	TOPO_SENSOR_TYPE_OS_SHUTDOWN			0x0020
754 
755 #define	TOPO_SENSOR_STATE_OS_SHUTDOWN_LOADING		0x0001
756 #define	TOPO_SENSOR_STATE_OS_SHUTDOWN_CRASH		0x0002
757 #define	TOPO_SENSOR_STATE_OS_STOP_GRACEFUL		0x0004
758 #define	TOPO_SENSOR_STATE_OS_SHUTDOWN_GRACEFUL		0x0008
759 #define	TOPO_SENSOR_STATE_OS_SHUTDOWN_PEF		0x0010
760 #define	TOPO_SENSOR_STATE_OS_SHUTDOWN_BMC		0x0020
761 
762 #define	TOPO_SENSOR_TYPE_SLOT				0x0021
763 
764 #define	TOPO_SENSOR_STATE_SLOT_FAULT_ASSERTED		0x0001
765 #define	TOPO_SENSOR_STATE_SLOT_IDENTIFY_ASSERTED	0x0002
766 #define	TOPO_SENSOR_STATE_SLOT_CONNECTED		0x0004
767 #define	TOPO_SENSOR_STATE_SLOT_INSTALL_READY		0x0008
768 #define	TOPO_SENSOR_STATE_SLOT_REMOVE_READY		0x0010
769 #define	TOPO_SENSOR_STATE_SLOT_PWR_OFF			0x0020
770 #define	TOPO_SENSOR_STATE_SLOT_REMOVED			0x0040
771 #define	TOPO_SENSOR_STATE_SLOT_INTERLOCK_ASSERTED	0x0080
772 #define	TOPO_SENSOR_STATE_SLOT_DISABLED			0x0100
773 #define	TOPO_SENSOR_STATE_SLOT_SPARE_DEVICE		0x0200
774 
775 #define	TOPO_SENSOR_TYPE_ACPI				0x0022
776 
777 #define	TOPO_SENSOR_STATE_ACPI_PSTATE_S0_G0		0x0001
778 #define	TOPO_SENSOR_STATE_ACPI_PSTATE_S1		0x0002
779 #define	TOPO_SENSOR_STATE_ACPI_PSTATE_S2		0x0004
780 #define	TOPO_SENSOR_STATE_ACPI_PSTATE_S3		0x0008
781 #define	TOPO_SENSOR_STATE_ACPI_PSTATE_S4		0x0010
782 #define	TOPO_SENSOR_STATE_ACPI_PSTATE_S5_G2_SOFT_OFF	0x0020
783 #define	TOPO_SENSOR_STATE_ACPI_PSTATE_S4_S5_SOFT_OFF	0x0040
784 #define	TOPO_SENSOR_STATE_ACPI_PSATTE_G3_MECH_OFF	0x0080
785 #define	TOPO_SENSOR_STATE_ACPI_PSTATE_S1_S2_S3_SLEEP	0x0100
786 #define	TOPO_SENSOR_STATE_ACPI_PSTATE_G1_SLEEP		0x0200
787 #define	TOPO_SENSOR_STATE_ACPI_PSTATE_S5_OVERRIDE	0x0400
788 #define	TOPO_SENSOR_STATE_ACPI_PSTATE_LEGACY_ON		0x0800
789 #define	TOPO_SENSOR_STATE_ACPI_PSTATE_LEGACY_OFF	0x1000
790 #define	TOPO_SENSOR_STATE_ACPI_PSTATE_UNKNOWN		0x2000
791 
792 #define	TOPO_SENSOR_TYPE_WATCHDOG2			0x0023
793 
794 #define	TOPO_SENSOR_STATE_WATCHDOG2_EXPIRED		0x0001
795 #define	TOPO_SENSOR_STATE_WATCHDOG2_HARD_RESET		0x0002
796 #define	TOPO_SENSOR_STATE_WATCHDOG2_PWR_DOWN		0x0004
797 #define	TOPO_SENSOR_STATE_WATCHDOG2_PWR_CYCLE		0x0008
798 #define	TOPO_SENSOR_STATE_WATCHDOG2_RESERVED1		0x0010
799 #define	TOPO_SENSOR_STATE_WATCHDOG2_RESERVED2		0x0020
800 #define	TOPO_SENSOR_STATE_WATCHDOG2_RESERVED3		0x0040
801 #define	TOPO_SENSOR_STATE_WATCHDOG2_RESERVED4		0x0080
802 #define	TOPO_SENSOR_STATE_WATCHDOG2_TIMEOUT_INT		0x0100
803 
804 #define	TOPO_SENSOR_TYPE_ALERT				0x0024
805 
806 #define	TOPO_SENSOR_STATE_ALERT_PLAT_PAGE		0x0001
807 #define	TOPO_SENSOR_STATE_ALERT_PLAT_LAN_ALERT		0x0002
808 #define	TOPO_SENSOR_STATE_ALERT_PLAT_EVT_TRAP		0x0004
809 #define	TOPO_SENSOR_STATE_ALERT_PLAT_SNMP_TRAP		0x0008
810 
811 #define	TOPO_SENSOR_TYPE_PRESENCE			0x0025
812 
813 #define	TOPO_SENSOR_STATE_PRESENCE_PRESENT		0x0001
814 #define	TOPO_SENSOR_STATE_PRESENCE_ABSENT		0x0002
815 #define	TOPO_SENSOR_STATE_PRESENCE_DISABLED		0x0004
816 
817 #define	TOPO_SENSOR_TYPE_ASIC				0x0026
818 
819 #define	TOPO_SENSOR_TYPE_LAN				0x0027
820 
821 #define	TOPO_SENSOR_STATE_LAN_HEARTBEAT_LOST		0x0001
822 #define	TOPO_SENSOR_STATE_LAN_HEARTBEAT			0x0002
823 
824 #define	TOPO_SENSOR_TYPE_HEALTH				0x0028
825 
826 #define	TOPO_SENSOR_STATE_HEALTH_SENSOR_ACC_DEGRADED	0x0001
827 #define	TOPO_SENSOR_STATE_HEALTH_CNTLR_ACC_DEGRADED	0x0002
828 #define	TOPO_SENSOR_STATE_HEALTH_CNTLR_OFFLINE		0x0004
829 #define	TOPO_SENSOR_STATE_HEALTH_CNTLR_UNAVAIL		0x0008
830 #define	TOPO_SENSOR_STATE_HEALTH_SENSOR_FAILURE		0x0010
831 #define	TOPO_SENSOR_STATE_HEALTH_FRU_FAILURE		0x0020
832 
833 #define	TOPO_SENSOR_TYPE_BATTERY			0x0029
834 
835 #define	TOPO_SENSOR_STATE_BATTERY_LOW			0x0001
836 #define	TOPO_SENSOR_STATE_BATTERY_FAILED		0x0002
837 #define	TOPO_SENSOR_STATE_BATTERY_PRESENCE		0x0004
838 
839 #define	TOPO_SENSOR_TYPE_AUDIT				0x002A
840 
841 #define	TOPO_SENSOR_STATE_AUDIT_SESSION_ACTIVATED	0x0001
842 #define	TOPO_SENSOR_STATE_AUDIT_SESSION_DEACTIVATED	0x0002
843 
844 #define	TOPO_SENSOR_TYPE_VERSION			0x002B
845 
846 #define	TOPO_SENSOR_STATE_VERSION_HW_CHANGE		0x0001
847 #define	TOPO_SENSOR_STATE_VERSION_SW_CHANGE		0x0002
848 #define	TOPO_SENSOR_STATE_VERSION_HW_INCOMPATIBLE	0x0004
849 #define	TOPO_SENSOR_STATE_VERSION_SW_INCOMPATIBLE	0x0008
850 #define	TOPO_SENSOR_STATE_VERSION_HW_INVAL		0x0010
851 #define	TOPO_SENSOR_STATE_VERSION_SW_INVAL		0x0020
852 #define	TOPO_SENSOR_STATE_VERSION_HW_CHANGE_SUCCESS	0x0040
853 #define	TOPO_SENSOR_STATE_VERSION_SW_CHANGE_SUCCESS	0x0080
854 
855 #define	TOPO_SENSOR_TYPE_FRU_STATE			0x002C
856 
857 #define	TOPO_SENSOR_STATE_FRU_STATE_NOT_INSTALLED	0x0001
858 #define	TOPO_SENSOR_STATE_FRU_STATE_INACTIVE		0x0002
859 #define	TOPO_SENSOR_STATE_FRU_STATE_ACT_REQ		0x0004
860 #define	TOPO_SENSOR_STATE_FRU_STATE_ACT_INPROGRESS	0x0008
861 #define	TOPO_SENSOR_STATE_FRU_STATE_ACTIVE		0x0010
862 #define	TOPO_SENSOR_STATE_FRU_STATE_DEACT_REQ		0x0020
863 #define	TOPO_SENSOR_STATE_FRU_STATE_DEACT_INPROGRESS	0x0040
864 #define	TOPO_SENSOR_STATE_FRU_STATE_COMM_LOST		0x0080
865 
866 /*
867  * We simplify the IPMI sensor type code defines by combining the generic
868  * and sensor-specific codes into a single range.  Because there's overlap
869  * between the two ranges we offset the generic type codes by 0x0100
870  * which allows ample room in the hole for future expansion of the table to
871  * accomodate either additions to the IPMI spec or to support new sensor types
872  * for alternate provider modules.
873  */
874 #define	TOPO_SENSOR_TYPE_THRESHOLD_STATE		0x0101
875 
876 #define	TOPO_SENSOR_STATE_THRESH_LOWER_NONCRIT		0x0001
877 #define	TOPO_SENSOR_STATE_THRESH_LOWER_CRIT		0x0002
878 #define	TOPO_SENSOR_STATE_THRESH_LOWER_NONREC		0x0004
879 #define	TOPO_SENSOR_STATE_THRESH_UPPER_NONCRIT		0x0008
880 #define	TOPO_SENSOR_STATE_THRESH_UPPER_CRIT		0x0010
881 #define	TOPO_SENSOR_STATE_THRESH_UPPER_NONREC		0x0020
882 
883 #define	TOPO_SENSOR_TYPE_GENERIC_USAGE			0x0102
884 
885 #define	TOPO_SENSOR_STATE_GENERIC_USAGE_IDLE		0x0001
886 #define	TOPO_SENSOR_STATE_GENERIC_USAGE_ACTIVE		0x0002
887 #define	TOPO_SENSOR_STATE_GENERIC_USAGE_BUSY		0x0004
888 
889 #define	TOPO_SENSOR_TYPE_GENERIC_STATE			0x0103
890 
891 #define	TOPO_SENSOR_STATE_GENERIC_STATE_DEASSERTED	0x0001
892 #define	TOPO_SENSOR_STATE_GENERIC_STATE_ASSERTED	0x0002
893 
894 #define	TOPO_SENSOR_TYPE_GENERIC_PREDFAIL		0x0104
895 
896 #define	TOPO_SENSOR_STATE_GENERIC_PREDFAIL_DEASSERTED	0x0001
897 #define	TOPO_SENSOR_STATE_GENERIC_PREDFAIL_ASSERTED	0x0002
898 
899 #define	TOPO_SENSOR_TYPE_GENERIC_LIMIT			0x0105
900 
901 #define	TOPO_SENSOR_STATE_GENERIC_LIMIT_NOT_EXCEEDED	0x0001
902 #define	TOPO_SENSOR_STATE_GENERIC_LIMIT_EXCEEDED	0x0002
903 
904 #define	TOPO_SENSOR_TYPE_GENERIC_PERFORMANCE		0x0106
905 
906 #define	TOPO_SENSOR_STATE_GENERIC_PERFORMANCE_MET	0x0001
907 #define	TOPO_SENSOR_STATE_GENERIC_PERFORMANCE_LAGS	0x0002
908 
909 #define	TOPO_SENSOR_TYPE_SEVERITY			0x0107
910 
911 #define	TOPO_SENSOR_STATE_SEVERITY_OK			0x0001
912 #define	TOPO_SENSOR_STATE_SEVERITY_NONCRIT_GOING_HIGH	0x0002
913 #define	TOPO_SENSOR_STATE_SEVERITY_CRIT_GOING_HIGH	0x0004
914 #define	TOPO_SENSOR_STATE_SEVERITY_NONREC_GOING_HIGH	0x0008
915 #define	TOPO_SENSOR_STATE_SEVERITY_NONCRIT_GOING_LOW	0x0010
916 #define	TOPO_SENSOR_STATE_SEVERITY_CRIT_GOING_LOW	0x0020
917 #define	TOPO_SENSOR_STATE_SEVERITY_NONREC_GOING_LOW	0x0020
918 #define	TOPO_SENSOR_STATE_SEVERITY_MONITOR		0x0040
919 #define	TOPO_SENSOR_STATE_SEVERITY_INFORMATIONAL	0x0080
920 
921 #define	TOPO_SENSOR_TYPE_GENERIC_PRESENCE		0x0108
922 
923 #define	TOPO_SENSOR_STATE_GENERIC_PRESENCE_DEASSERTED	0x0001
924 #define	TOPO_SENSOR_STATE_GENERIC_PRESENCE_ASSERTED	0x0002
925 
926 #define	TOPO_SENSOR_TYPE_GENERIC_AVAILABILITY		0x0109
927 
928 #define	TOPO_SENSOR_STATE_GENERIC_AVAIL_DEASSERTED	0x0001
929 #define	TOPO_SENSOR_STATE_GENERIC_AVAIL_ASSERTED	0x0002
930 
931 #define	TOPO_SENSOR_TYPE_GENERIC_STATUS			0x010A
932 
933 #define	TOPO_SENSOR_STATE_GENERIC_STATUS_RUNNING	0x0001
934 #define	TOPO_SENSOR_STATE_GENERIC_STATUS_IN_TEST	0x0002
935 #define	TOPO_SENSOR_STATE_GENERIC_STATUS_POWER_OFF	0x0004
936 #define	TOPO_SENSOR_STATE_GENERIC_STATUS_ONLINE		0x0008
937 #define	TOPO_SENSOR_STATE_GENERIC_STATUS_OFFLINE	0x0010
938 #define	TOPO_SENSOR_STATE_GENERIC_STATUS_OFF_DUTY	0x0020
939 #define	TOPO_SENSOR_STATE_GENERIC_STATUS_DEGRADED	0x0040
940 #define	TOPO_SENSOR_STATE_GENERIC_STATUS_POWER_SAVE	0x0080
941 #define	TOPO_SENSOR_STATE_GENERIC_STATUS_INSTALL_ERR	0x0100
942 
943 #define	TOPO_SENSOR_TYPE_GENERIC_REDUNDANCY		0x010B
944 
945 /*
946  * ACPI power state
947  */
948 #define	TOPO_SENSOR_TYPE_GENERIC_ACPI			0x010C
949 
950 #define	TOPO_SENSOR_STATE_GENERIC_ACPI_D0		0x0001
951 #define	TOPO_SENSOR_STATE_GENERIC_ACPI_D1		0x0002
952 #define	TOPO_SENSOR_STATE_GENERIC_ACPI_D2		0x0004
953 #define	TOPO_SENSOR_STATE_GENERIC_ACPI_D3		0x0008
954 
955 /*
956  * These sensor types don't exist in the IPMI spec, but allow consumers to
957  * associate discrete sensors with component failure.  The 'ok' sensor is the
958  * inverse of the 'failure' sensor.  Note that the values intentionally mimic
959  * TOPO_SENSOR_TYPE_GENERIC_STATE, so that you can use existing IPMI sensors
960  * but just change the type to get semantically meaningful behavior.
961  */
962 #define	TOPO_SENSOR_TYPE_GENERIC_FAILURE		0x010D
963 
964 #define	TOPO_SENSOR_STATE_GENERIC_FAIL_DEASSERTED	0x0001
965 #define	TOPO_SENSOR_STATE_GENERIC_FAIL_NONRECOV		0x0002
966 #define	TOPO_SENSOR_STATE_GENERIC_FAIL_CRITICAL		0x0004
967 
968 #define	TOPO_SENSOR_TYPE_GENERIC_OK			0x010E
969 
970 #define	TOPO_SENSOR_STATE_GENERIC_OK_DEASSERTED		0x0001
971 #define	TOPO_SENSOR_STATE_GENERIC_OK_ASSERTED		0x0002
972 
973 /*
974  * Indicator modes and types
975  */
976 typedef enum topo_led_state {
977 	TOPO_LED_STATE_OFF = 0,
978 	TOPO_LED_STATE_ON
979 } topo_led_state_t;
980 
981 #define	TOPO_FAC_TYPE_ANY	0xFFFFFFFF
982 
983 /*
984  * This list is limited to the set of LED's that we're likely to manage through
985  * FMA.  Thus is does not include things like power or activity LED's
986  */
987 typedef enum topo_led_type {
988 	TOPO_LED_TYPE_SERVICE = 0,
989 	TOPO_LED_TYPE_LOCATE,
990 	TOPO_LED_TYPE_OK2RM,
991 	TOPO_LED_TYPE_PRESENT
992 } topo_led_type_t;
993 
994 
995 #ifdef __cplusplus
996 }
997 #endif
998 
999 #endif /* _LIBTOPO_H */
1000