fan.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_FAN_H__
#define __ONLP_FAN_H__

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

#include <BigList/biglist.h>

/* <auto.start.enum(tag:fan).define> */
typedef enum onlp_fan_caps_e {
    ONLP_FAN_CAPS_SET_DIR = (1 << 0),
    ONLP_FAN_CAPS_GET_DIR = (1 << 1),
    ONLP_FAN_CAPS_SET_RPM = (1 << 2),
    ONLP_FAN_CAPS_SET_PERCENTAGE = (1 << 3),
    ONLP_FAN_CAPS_GET_RPM = (1 << 4),
    ONLP_FAN_CAPS_GET_PERCENTAGE = (1 << 5),
} onlp_fan_caps_t;

typedef enum onlp_fan_dir_e {
    ONLP_FAN_DIR_UNKNOWN,
    ONLP_FAN_DIR_B2F,
    ONLP_FAN_DIR_F2B,
    ONLP_FAN_DIR_LAST = ONLP_FAN_DIR_F2B,
    ONLP_FAN_DIR_COUNT,
    ONLP_FAN_DIR_INVALID = -1,
} onlp_fan_dir_t;
/* <auto.end.enum(tag:fan).define> */

typedef struct onlp_fan_info_s {
    onlp_oid_hdr_t hdr;

    onlp_fan_dir_t dir;

    uint32_t caps;

    int rpm;

    int percentage;

    char model[ONLP_CONFIG_INFO_STR_MAX];

    char serial[ONLP_CONFIG_INFO_STR_MAX];

} onlp_fan_info_t;

#define ONLP_FAN_INFO_CAP_IS_SET(_pinfo, _name) \
    ((_pinfo)->caps & ONLP_FAN_CAPS_##_name)

int onlp_fan_sw_init(void);

int onlp_fan_hw_init(uint32_t flags);

int onlp_fan_sw_denit(void);

int onlp_fan_hdr_get(onlp_oid_t oid, onlp_oid_hdr_t* hdr);

int onlp_fan_info_get(onlp_oid_t oid, onlp_fan_info_t* rv);

int onlp_fan_caps_get(onlp_oid_t oid, uint32_t* caps);

int onlp_fan_rpm_set(onlp_oid_t oid, int rpm);

int onlp_fan_percentage_set(onlp_oid_t oid, int p);

int onlp_fan_dir_set(onlp_oid_t oid, onlp_fan_dir_t dir);

int onlp_fan_info_to_user_json(onlp_fan_info_t* info, cJSON** cj,
                               uint32_t flags);

int onlp_fan_info_to_json(onlp_fan_info_t* info, cJSON** cj, uint32_t flags);

int onlp_fan_info_from_json(cJSON* cj, onlp_fan_info_t* info);


#define ONLP_FAN_STATUS_PRESENT(_fi) ((_fi).hdr.status & ONLP_OID_STATUS.PRESENT)

#define ONLP_FAN_STATUS_MISSING(_fi) (!ONLP_FAN_INFO_PRESENT(_fi))

#define ONLP_FAN_STATUS_FAILED(_fi) ( (_fi).hdr.status & ONLP_OID_STATUS.FAILED)

#define ONLP_FAN_STATUS_NORMAL(_fi) ( ONLP_FAN_STATUS_PRESENT(_fi) && !ONLP_FAN_STATUS_FAILED(_fi) )


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

int onlp_fan_caps_value(const char* str, onlp_fan_caps_t* e, int substr);

const char* onlp_fan_caps_desc(onlp_fan_caps_t e);

int onlp_fan_caps_valid(onlp_fan_caps_t e);

#define ONLP_FAN_CAPS_VALID(_e) \
    (onlp_fan_caps_valid((_e)))

extern aim_map_si_t onlp_fan_caps_map[];
extern aim_map_si_t onlp_fan_caps_desc_map[];

#define ONLP_FAN_DIR_STRINGS \
{\
    "UNKNOWN", \
    "B2F", \
    "F2B", \
}

const char* onlp_fan_dir_name(onlp_fan_dir_t e);

int onlp_fan_dir_value(const char* str, onlp_fan_dir_t* e, int substr);

const char* onlp_fan_dir_desc(onlp_fan_dir_t e);

#define ONLP_FAN_DIR_VALID(_e) \
    ( (0 <= (_e)) && ((_e) <= ONLP_FAN_DIR_F2B))

extern aim_map_si_t onlp_fan_dir_map[];
extern aim_map_si_t onlp_fan_dir_desc_map[];
/* <auto.end.enum(tag:fan).supportheader> */


#endif /* __ONLP_FAN_H__ */
/* @} */