CC_Configuration.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2020 Silicon Laboratories Inc. <https://www.silabs.com/>
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
/***************************************************************************/
 
#ifndef ZAF_COMMANDCLASSES_CONFIGURATION_CC_CONFIGURATION_H_
#define ZAF_COMMANDCLASSES_CONFIGURATION_CC_CONFIGURATION_H_
 
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
#include <ZAF_types.h>
#include <ZW_classcmd.h>
#include <zpal_nvm.h>


typedef enum {
  CC_CONFIG_PARAMETER_SIZE_8_BIT            = 1,   
  CC_CONFIG_PARAMETER_SIZE_16_BIT           = 2,   
  CC_CONFIG_PARAMETER_SIZE_32_BIT           = 4,   
  CC_CONFIG_PARAMETER_SIZE_NOT_SPECIFIED    = 0xFF,
}
cc_config_parameter_size_t;

typedef enum {
  CC_CONFIG_PARAMETER_FORMAT_SIGNED_INTEGER   = CONFIGURATION_PROPERTIES_REPORT_FORMAT_SIGNED_INTEGER_V3,  
  CC_CONFIG_PARAMETER_FORMAT_UNSIGNED_INTEGER = CONFIGURATION_PROPERTIES_REPORT_FORMAT_UNSIGNED_INTEGER_V3,
  CC_CONFIG_PARAMETER_FORMAT_ENUMERATED       = CONFIGURATION_PROPERTIES_REPORT_FORMAT_ENUMERATED_V3,      
  CC_CONFIG_PARAMETER_FORMAT_BIT_FIELD        = CONFIGURATION_PROPERTIES_REPORT_FORMAT_BIT_FIELD_V3,       
}
cc_config_parameter_format_t;

typedef union {
  // Unsigned integers
  uint32_t as_uint32;
  uint16_t as_uint16;
  uint8_t  as_uint8;
  // Signed integers
  int32_t  as_int32;
  int16_t  as_int16;
  int8_t   as_int8;
  // Array representation
  uint8_t as_uint8_array[4];
}
cc_config_parameter_value_t;
 
typedef struct _cc_config_parameter_attributes_t{
  char const * const name;                           
  char const * const info;                           
  const cc_config_parameter_value_t min_value;       
  const cc_config_parameter_value_t max_value;       
  cc_config_parameter_size_t  size;                  
  const cc_config_parameter_format_t format;         
  const cc_config_parameter_value_t  default_value;  
  const struct {
    bool altering_capabilities : 1;          
    bool read_only             : 1;          
    bool advanced              : 1;          
  } flags;
} cc_config_parameter_attributes_t;
 
typedef struct cc_config_parameter_buffer_t cc_config_parameter_buffer_t;
 
typedef struct {
  const uint16_t number;                       
  uint16_t next_number;                        
  const zpal_nvm_object_key_t file_id;              
  cc_config_parameter_attributes_t attributes; 
  bool (*migration_handler)(cc_config_parameter_buffer_t* parameter_buffer); 
} cc_config_parameter_metadata_t;
 
struct cc_config_parameter_buffer_t {
  const cc_config_parameter_metadata_t* metadata;
  cc_config_parameter_value_t     data_buffer;
};

typedef enum {
  CC_CONFIG_RETURN_CODE_NOT_SUPPORTED,
  CC_CONFIG_RETURN_CODE_IO_FAIL,
  CC_CONFIG_RETURN_CODE_OK
}
cc_config_configuration_set_return_value;

typedef struct {
  uint16_t numberOfParameters;
  const cc_config_parameter_metadata_t* parameters;
} cc_configuration_t;

typedef struct {
  bool (*write_handler)(zpal_nvm_object_key_t file_id, uint8_t const* data, size_t size); 
  bool (*read_handler)(zpal_nvm_object_key_t file_id, uint8_t *data, size_t size);        
} cc_configuration_io_interface_t;

typedef void * cc_configuration_handle_t;

bool CC_Configuration_SetValue(cc_configuration_handle_t handle,
                               uint16_t number,
                               cc_config_parameter_value_t value);

bool
cc_configuration_get(uint16_t parameter_number, cc_config_parameter_buffer_t* parameter_buffer);

void
cc_configuration_set_interface(cc_configuration_io_interface_t const* interface);

void
cc_configuration_set_default_configuration(cc_configuration_t const* configuration);

bool
cc_configuration_limit_value(cc_config_parameter_buffer_t const* parameter_buffer,
                             cc_config_parameter_value_t * pNewValue);
#endif /* ZAF_COMMANDCLASSES_CONFIGURATION_CC_CONFIGURATION_H_ */