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