psu.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_PSU_H__
#define __ONLP_PSU_H__

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

/* <auto.start.enum(tag:psu).define> */
typedef enum onlp_psu_caps_e {
    ONLP_PSU_CAPS_GET_TYPE = (1 << 0),
    ONLP_PSU_CAPS_GET_VIN = (1 << 1),
    ONLP_PSU_CAPS_GET_VOUT = (1 << 2),
    ONLP_PSU_CAPS_GET_IIN = (1 << 3),
    ONLP_PSU_CAPS_GET_IOUT = (1 << 4),
    ONLP_PSU_CAPS_GET_PIN = (1 << 5),
    ONLP_PSU_CAPS_GET_POUT = (1 << 6),
} onlp_psu_caps_t;

typedef enum onlp_psu_type_e {
    ONLP_PSU_TYPE_AC,
    ONLP_PSU_TYPE_DC12,
    ONLP_PSU_TYPE_DC48,
    ONLP_PSU_TYPE_LAST = ONLP_PSU_TYPE_DC48,
    ONLP_PSU_TYPE_COUNT,
    ONLP_PSU_TYPE_INVALID = -1,
} onlp_psu_type_t;
/* <auto.end.enum(tag:psu).define> */


typedef struct onlp_psu_info_t {
    onlp_oid_hdr_t hdr;

    char model[ONLP_CONFIG_INFO_STR_MAX];

    char serial[ONLP_CONFIG_INFO_STR_MAX];

    uint32_t caps;

    onlp_psu_type_t type;

    int mvin;

    int mvout;

    int miin;

    int miout;

    int mpin;

    int mpout;

} onlp_psu_info_t;


#define ONLP_PSU_INFO_CAP_IS_SET(_pinfo, _name) \
    ((_pinfo)->caps & ONLP_PSU_CAPS_##_name)

int onlp_psu_sw_init(void);

int onlp_psu_hw_init(uint32_t flags);

int onlp_psu_sw_denit(void);

int onlp_psu_hdr_get(onlp_oid_t oid, onlp_oid_hdr_t* rv);

int onlp_psu_info_get(onlp_oid_t oid, onlp_psu_info_t* rv);

int onlp_psu_info_to_user_json(onlp_psu_info_t* info, cJSON** cj, uint32_t flags);

int onlp_psu_info_to_json(onlp_psu_info_t* info, cJSON** cj, uint32_t flags);

int onlp_psu_info_from_json(cJSON* cj, onlp_psu_info_t* info);


#define ONLP_PSU_STATUS_PRESENT(_pi) ( (_pi).status & ONLP_PSU_STATUS_PRESENT )

#define ONLP_PSU_STATUS_MISSING(_pi) (!ONLP_PSU_STATUS_PRESENT(_pi))

#define ONLP_PSU_STATUS_FAILED(_pi) ( (_pi).status & ONLP_PSU_STATUS_FAILED)



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

int onlp_psu_caps_value(const char* str, onlp_psu_caps_t* e, int substr);

const char* onlp_psu_caps_desc(onlp_psu_caps_t e);

int onlp_psu_caps_valid(onlp_psu_caps_t e);

#define ONLP_PSU_CAPS_VALID(_e) \
    (onlp_psu_caps_valid((_e)))

extern aim_map_si_t onlp_psu_caps_map[];
extern aim_map_si_t onlp_psu_caps_desc_map[];

#define ONLP_PSU_TYPE_STRINGS \
{\
    "AC", \
    "DC12", \
    "DC48", \
}

const char* onlp_psu_type_name(onlp_psu_type_t e);

int onlp_psu_type_value(const char* str, onlp_psu_type_t* e, int substr);

const char* onlp_psu_type_desc(onlp_psu_type_t e);

#define ONLP_PSU_TYPE_VALID(_e) \
    ( (0 <= (_e)) && ((_e) <= ONLP_PSU_TYPE_DC48))

extern aim_map_si_t onlp_psu_type_map[];
extern aim_map_si_t onlp_psu_type_desc_map[];
/* <auto.end.enum(tag:psu).supportheader> */

#endif /* __ONLP_PSU_H__ */
/* @} */