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