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