attribute.h

Go to the documentation of this file.

/************************************************************
 * <bsn.cl fy=2017 v=onl>
 *
 *        Copyright 2017 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_ATTRIBUTE_H__
#define __ONLP_ATTRIBUTE_H__

#include <onlp/oids.h>
#include <onlp/onlp.h>
#include <onlp/stdattrs.h>
#include <AIM/aim_pvs.h>

int onlp_attribute_sw_init(void);

int onlp_attribute_hw_init(uint32_t flags);

int onlp_attribute_sw_denit(void);

int onlp_attribute_supported(onlp_oid_t oid, const char* attribute);

int onlp_attribute_set(onlp_oid_t oid, const char* attribute, void* value);

int onlp_attribute_get(onlp_oid_t oid, const char* attribute,
                       void** value);

int onlp_attribute_free(onlp_oid_t oid, const char* attribute, void* value);

#define ONLP_ATTRIBUTE_EQUALS(_a, _b) (!strcmp(_a, _b))

/******************************************************************************
 *
 * These functions provide access to standard ONIE and Asset attributes.
 * These are so common that they have their own interface for
 * for both the user and the platform implementations.
 *
 *****************************************************************************/
int onlp_attribute_onie_info_get(onlp_oid_t oid, onlp_onie_info_t** rp);

int onlp_attribute_onie_info_free(onlp_oid_t oid, onlp_onie_info_t* p);

int onlp_attribute_onie_info_get_json(onlp_oid_t oid, cJSON** rp);

int onlp_attribute_onie_info_show(onlp_oid_t oid, aim_pvs_t* pvs);

int onlp_attribute_onie_info_show_json(onlp_oid_t oid, aim_pvs_t* pvs);

int onlp_attribute_asset_info_get(onlp_oid_t oid, onlp_asset_info_t** rp);

int onlp_attribute_asset_info_free(onlp_oid_t oid, onlp_asset_info_t* p);

int onlp_attribute_asset_info_get_json(onlp_oid_t oid, cJSON** rp);

int onlp_attribute_asset_info_show(onlp_oid_t oid, aim_pvs_t* pvs);

int onlp_attribute_asset_info_show_json(onlp_oid_t oid, aim_pvs_t* pvs);

#endif /* __ONLP_ATTRIBUTE_H__ */
/* @} */