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