tr_nvram_attr.h

Go to the documentation of this file.

#ifndef TR_NVRAM_ATTR_H
#define TR_NVRAM_ATTR_H
 
#include "tr_af.h"
 
// NV RAM data storage versions
#define TR_NVRAM_STORAGE_VER_1 (1)
#define TR_NVRAM_STORAGE_VER_2 (2)
 
// the default time to delay writes to NV in ms
// use this for the function tr_check_for_attr_nvram_update(...) for the argument delay_time_ms
#define TR_NVRAM_WRITE_DELAY_MS (2000)
 
// versions for zigbee attribute section
#define TR_NVRAM_ATTR_STORAGE_VER_1      (1)
#define TR_NVRAM_ATTR_STORAGE_CUR_VER    (TR_NVRAM_ATTR_STORAGE_VER_1)
 
#define TR_NVRAM_SECTION_ID_ZIGBEE_ATTRS 0x8001
 
// turn these on to have this module print
// #define TR_NVRAM_PRINT_ENABLE         1
// #define TR_NVRAM_VERBOSE_PRINT_ENABLE 1

#ifdef TR_NVRAM_PRINT_ENABLE
#define tr_nvram_printf(...) tr_core_printf(__VA_ARGS__)
#else
#define tr_nvram_printf(...)
#endif

#ifdef TR_NVRAM_VERBOSE_PRINT_ENABLE
#define tr_nvram_verbose_printf(...) tr_core_printf(__VA_ARGS__)
#else
#define tr_nvram_verbose_printf(...)
#endif


typedef enum
{
    TR_NVRAM_SECTION_ZIGBEE_ATTRIBUTES    = 1,
    TR_NVRAM_SECTION_SCENES_TABLE         = 2,
    TR_NVRAM_SECTION_DOOR_LOCK_USER_TABLE = 3,
    TR_NVRAM_SECTION_TSTAT_SCHEDULE_TABLE = 4,
    TR_NVRAM_SECTION_APP_DATA_1           = 101
 
} tr_nvram_section_id_t;

#ifdef TR_SCENES_SERVER_PLUGIN_ENABLE
    #define TR_NVRAM_SCENES_SLOTS 1
#else
    #define TR_NVRAM_SCENES_SLOTS 0
#endif
 
#ifdef TR_DOOR_LOCK_SERVER_PLUGIN_ENABLE
    #define TR_NVRAM_DOOR_LOCK_SLOTS 1
#else
    #define TR_NVRAM_DOOR_LOCK_SLOTS 0
#endif
 
#ifndef TR_NVRAM_NUM_APP_SECTIONS
    #define TR_NVRAM_NUM_APP_SECTIONS 1
#endif
 
// number of slots used is app + door lock + scenes
#define TR_NVRAM_NUM_TABLE_SLOTS (TR_NVRAM_NUM_APP_SECTIONS + TR_NVRAM_DOOR_LOCK_SLOTS + TR_NVRAM_SCENES_SLOTS)

typedef struct
{
    tr_nvram_section_id_t section_id;
    zb_uint8_t            data_version;
    zb_uint16_t           entry_size;
    zb_uint8_t            num_entries;
}tr_nvram_section_header_t;

typedef ZB_PACKED_PRE struct
{
    zb_uint8_t  endpoint;
    zb_uint16_t cluster_id;
    zb_uint16_t attr_id;
    zb_uint8_t  cluster_role;
    zb_uint16_t manuf_code;
    zb_uint8_t  data_type;
}ZB_PACKED_STRUCT tr_nvram_attr_storage_v1_t;


zb_uint16_t tr_get_nvram_data_size(void);

zb_ret_t tr_nvram_write_app_data_cb(zb_uint8_t  page,
                                    zb_uint32_t pos);

void tr_nvram_read_app_data_cb(zb_uint8_t  page,
                               zb_uint32_t pos,
                               zb_uint16_t payload_length);

void tr_check_for_attr_nvram_update(zb_uint8_t  ep,
                                    zb_uint16_t cluster_id,
                                    zb_uint8_t  cluster_role,
                                    zb_uint16_t attr_id,
                                    zb_uint16_t manuf_code);

void tr_check_for_attr_nvram_update_delay(zb_uint8_t  ep,
                                          zb_uint16_t cluster_id,
                                          zb_uint8_t  cluster_role,
                                          zb_uint16_t attr_id,
                                          zb_uint16_t manuf_code,
                                          zb_uint16_t delay_time_ms);

typedef zb_bool_t (*tr_nvram_clear_data_t)(void);

typedef zb_bool_t (*tr_nvram_err_handler_t)(zb_uint8_t *saved_data_ptr,
                                            zb_uint8_t data_entry_size,
                                            zb_uint8_t data_num_entries);

typedef struct
{
    tr_nvram_section_id_t  section_id;       // unique ID for data
    zb_uint8_t             data_version;     // version number for data
    zb_uint8_t             entry_size_len;   // data entry size, limited to 255
    zb_uint8_t             num_entries;      // data num entries, limited to 255
    zb_uint8_t             *plugin_data_ptr; // pointer to the plugin data
    tr_nvram_clear_data_t  clear_data_fx;    // function to clear data
    tr_nvram_err_handler_t err_hndl_fx;      // function to handle errors
}tr_nvram_data_info_t;

void tr_nvram_register(tr_nvram_data_info_t *register_data);

void tr_nvram_save(zb_uint16_t delay_time_ms);

 
#endif // TR_NVRAM_ATTR_H