/usr/include/freeipmi/interpret/ipmi-interpret.h is in libfreeipmi-dev 1.4.11-1.1+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 | /*
* Copyright (C) 2003-2014 FreeIPMI Core Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef IPMI_INTERPRET_H
#define IPMI_INTERPRET_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
#define IPMI_INTERPRET_ERR_SUCCESS 0
#define IPMI_INTERPRET_ERR_CONTEXT_NULL 1
#define IPMI_INTERPRET_ERR_CONTEXT_INVALID 2
#define IPMI_INTERPRET_ERR_PARAMETERS 3
#define IPMI_INTERPRET_ERR_OUT_OF_MEMORY 4
#define IPMI_INTERPRET_ERR_PERMISSION 5
#define IPMI_INTERPRET_ERR_SEL_CONFIG_FILE_DOES_NOT_EXIST 6
#define IPMI_INTERPRET_ERR_SEL_CONFIG_FILE_PARSE 7
#define IPMI_INTERPRET_ERR_SENSOR_CONFIG_FILE_DOES_NOT_EXIST 8
#define IPMI_INTERPRET_ERR_SENSOR_CONFIG_FILE_PARSE 9
#define IPMI_INTERPRET_ERR_INVALID_SEL_RECORD 10
#define IPMI_INTERPRET_ERR_SYSTEM_ERROR 11
#define IPMI_INTERPRET_ERR_OVERFLOW 12
#define IPMI_INTERPRET_ERR_INTERNAL_ERROR 13
#define IPMI_INTERPRET_ERR_ERRNUMRANGE 14
#define IPMI_INTERPRET_FLAGS_DEFAULT 0x0000
#define IPMI_INTERPRET_FLAGS_INTERPRET_OEM_DATA 0x0001
#define IPMI_INTERPRET_FLAGS_SEL_ASSUME_SYSTEM_EVENT_RECORDS 0x0002
#define IPMI_INTERPRET_FLAGS_IGNORE_UNRECOGNIZED_EVENTS 0x0004
#define IPMI_INTERPRET_STATE_NOMINAL 0x00
#define IPMI_INTERPRET_STATE_WARNING 0x01
#define IPMI_INTERPRET_STATE_CRITICAL 0x02
#define IPMI_INTERPRET_STATE_UNKNOWN 0x03
typedef struct ipmi_interpret_ctx *ipmi_interpret_ctx_t;
/* Interpret Context Functions */
ipmi_interpret_ctx_t ipmi_interpret_ctx_create (void);
void ipmi_interpret_ctx_destroy (ipmi_interpret_ctx_t ctx);
int ipmi_interpret_ctx_errnum (ipmi_interpret_ctx_t ctx);
char * ipmi_interpret_ctx_strerror (int errnum);
char * ipmi_interpret_ctx_errormsg (ipmi_interpret_ctx_t ctx);
/* interpret flag functions */
int ipmi_interpret_ctx_get_flags (ipmi_interpret_ctx_t ctx, unsigned int *flags);
int ipmi_interpret_ctx_set_flags (ipmi_interpret_ctx_t ctx, unsigned int flags);
/* for use w/ IPMI_INTERPRET_FLAGS_INTERPRET_OEM_DATA */
int ipmi_interpret_ctx_get_manufacturer_id (ipmi_interpret_ctx_t ctx, uint32_t *manufacturer_id);
int ipmi_interpret_ctx_set_manufacturer_id (ipmi_interpret_ctx_t ctx, uint32_t manufacturer_id);
/* for use w/ IPMI_INTERPRET_FLAGS_INTERPRET_OEM_DATA */
int ipmi_interpret_ctx_get_product_id (ipmi_interpret_ctx_t ctx, uint16_t *product_id);
int ipmi_interpret_ctx_set_product_id (ipmi_interpret_ctx_t ctx, uint16_t product_id);
/* interpret file config loading */
/* specify NULL for default config file */
/* if not called, library default will always be used */
int ipmi_interpret_load_sel_config (ipmi_interpret_ctx_t ctx,
const char *sel_config_file);
/* specify NULL for default config file */
/* if not called, library default will always be used */
int ipmi_interpret_load_sensor_config (ipmi_interpret_ctx_t ctx,
const char *sensor_config_file);
/* interpret core functions */
int ipmi_interpret_sel (ipmi_interpret_ctx_t ctx,
const void *sel_record,
unsigned int sel_record_len,
unsigned int *sel_state);
int ipmi_interpret_sensor (ipmi_interpret_ctx_t ctx,
uint8_t event_reading_type_code,
uint8_t sensor_type,
uint16_t sensor_event_bitmask,
unsigned int *sensor_state);
#ifdef __cplusplus
}
#endif
#endif /* IPMI_INTERPRET_H */
|