c_tlm_var.h

Go to the documentation of this file.

/*
 *     SocialLedge.com - Copyright (C) 2013
 *
 *     This file is part of free software framework for embedded processors.
 *     You can use it and/or distribute it as long as this copyright header
 *     remains unmodified.  The code is free for personal use and requires
 *     permission to use in a commercial product.
 *
 *      THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED
 *      OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 *      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
 *      I SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR
 *      CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 *
 *     You can reach the author of this software at :
 *          p r e e t . w i k i @ g m a i l . c o m
 */

#ifndef C_TLM_VAR_H__
#define C_TLM_VAR_H__
#include "c_list.h"
#include "c_tlm_comp.h"
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    tlm_undefined   = 0,
    tlm_int         = 1,
    tlm_uint        = 2,
    tlm_char        = 3,
    tlm_float       = 4,
    tlm_double      = 5,
    tlm_string      = 6,
    tlm_binary      = 7,
    tlm_bit_or_bool = 8,
} tlm_type ;

typedef struct {
    const char *name;      
    const void *data_ptr;  
    uint32_t elm_size_bytes; 
    uint32_t elm_arr_size;   
    tlm_type elm_type;       
} tlm_reg_var_type;


bool tlm_variable_register(tlm_component *comp_ptr,
                             const char *name,
                             const void *data_ptr,
                             const uint16_t data_size,
                             const uint16_t arr_size,
                             tlm_type type);

#define TLM_REG_VAR(comp, var, type) \
    tlm_variable_register(comp, #var, &var, sizeof(var), 1, type)

#define TLM_REG_ARR(comp, var, type) \
    tlm_variable_register(comp, #var, &var[0], sizeof(var[0]), sizeof(var)/sizeof(var[0]), type)

const tlm_reg_var_type* tlm_variable_get_by_name(tlm_component *comp_ptr,
                                                 const char *name);

const tlm_reg_var_type* tlm_variable_get_by_comp_and_name(const char *comp_name,
                                                          const char *name);

bool tlm_variable_set_value(const char *comp_name, const char *name, const char *value);

bool tlm_variable_get_value(const char *comp_name, const char *name, char *buffer, int len);

bool tlm_variable_print_value(const tlm_reg_var_type *reg_var, char *buffer, int len);



#ifdef __cplusplus
}
#endif
#endif /* C_TLM_VAR_H__ */