thermal.h

Go to the documentation of this file.

/************************************************************
 * <bsn.cl fy=2014 v=onl>
 *
 *        Copyright 2014, 2015 Big Switch Networks, Inc.
 *
 * Licensed under the Eclipse Public License, Version 1.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *        http://www.eclipse.org/legal/epl-v10.html
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific
 * language governing permissions and limitations under the
 * License.
 *
 * </bsn.cl>
 ********************************************************/
#ifndef __ONLP_THERMAL_H__
#define __ONLP_THERMAL_H__

#include <onlp/onlp_config.h>
#include <onlp/onlp.h>
#include <onlp/oids.h>

/* <auto.start.enum(tag:thermal).define> */
typedef enum onlp_thermal_caps_e {
    ONLP_THERMAL_CAPS_GET_TEMPERATURE = (1 << 0),
    ONLP_THERMAL_CAPS_GET_WARNING_THRESHOLD = (1 << 1),
    ONLP_THERMAL_CAPS_GET_ERROR_THRESHOLD = (1 << 2),
    ONLP_THERMAL_CAPS_GET_SHUTDOWN_THRESHOLD = (1 << 3),
} onlp_thermal_caps_t;

typedef enum onlp_thermal_threshold_e {
    ONLP_THERMAL_THRESHOLD_WARNING_DEFAULT = 45000,
    ONLP_THERMAL_THRESHOLD_ERROR_DEFAULT = 55000,
    ONLP_THERMAL_THRESHOLD_SHUTDOWN_DEFAULT = 60000,
} onlp_thermal_threshold_t;
/* <auto.end.enum(tag:thermal).define> */

#define ONLP_THERMAL_CAPS_ALL 0xF

#define ONLP_THERMAL_CAPS_GET_ANY_THRESHOLD                             \
    ( ONLP_THERMAL_CAPS_GET_WARNING_THRESHOLD |                         \
      ONLP_THERMAL_CAPS_GET_ERROR_THRESHOLD   |                         \
      ONLP_THERMAL_CAPS_GET_SHUTDOWN_THRESHOLD )

#define ONLP_THERMAL_THRESHOLD_INIT_DEFAULTS            \
    { ONLP_THERMAL_THRESHOLD_WARNING_DEFAULT,           \
      ONLP_THERMAL_THRESHOLD_ERROR_DEFAULT,             \
      ONLP_THERMAL_THRESHOLD_SHUTDOWN_DEFAULT }

typedef struct onlp_thermal_info_s {

    onlp_oid_hdr_t hdr;

    uint32_t caps;

    int mcelsius;

    struct {
        int warning;

        int error;

        int shutdown;
    } thresholds;

} onlp_thermal_info_t;


#define ONLP_THERMAL_INFO_CAP_IS_SET(_pinfo, _name)     \
    ((_pinfo)->caps & ONLP_THERMAL_CAPS_##_name)

int onlp_thermal_sw_init(void);

int onlp_thermal_hw_init(uint32_t flags);

int onlp_thermal_sw_denit(void);

int onlp_thermal_hdr_get(onlp_oid_t oid, onlp_oid_hdr_t* rv);

int onlp_thermal_info_get(onlp_oid_t oid, onlp_thermal_info_t* rv);

int onlp_thermal_info_to_json(onlp_thermal_info_t* info, cJSON** rv, uint32_t flags);


int onlp_thermal_info_from_json(cJSON* cj, onlp_thermal_info_t* info);

int onlp_thermal_info_to_user_json(onlp_thermal_info_t* info, cJSON** rv, uint32_t flags);



/******************************************************************************
 *
 * Enumeration Support Definitions.
 *
 * Please do not add additional code beyond this point.
 *
 *****************************************************************************/
/* <auto.start.enum(tag:thermal).supportheader> */
const char* onlp_thermal_caps_name(onlp_thermal_caps_t e);

int onlp_thermal_caps_value(const char* str, onlp_thermal_caps_t* e, int substr);

const char* onlp_thermal_caps_desc(onlp_thermal_caps_t e);

int onlp_thermal_caps_valid(onlp_thermal_caps_t e);

#define ONLP_THERMAL_CAPS_VALID(_e) \
    (onlp_thermal_caps_valid((_e)))

extern aim_map_si_t onlp_thermal_caps_map[];
extern aim_map_si_t onlp_thermal_caps_desc_map[];

const char* onlp_thermal_threshold_name(onlp_thermal_threshold_t e);

int onlp_thermal_threshold_value(const char* str, onlp_thermal_threshold_t* e, int substr);

const char* onlp_thermal_threshold_desc(onlp_thermal_threshold_t e);

int onlp_thermal_threshold_valid(onlp_thermal_threshold_t e);

#define ONLP_THERMAL_THRESHOLD_VALID(_e) \
    (onlp_thermal_threshold_valid((_e)))

extern aim_map_si_t onlp_thermal_threshold_map[];
extern aim_map_si_t onlp_thermal_threshold_desc_map[];
/* <auto.end.enum(tag:thermal).supportheader> */

#endif /* __ONLP_THERMAL_H__ */
/* @} */