wms_settings.h

Go to the documentation of this file.

/* Copyright 2019 Wirepas Ltd. All Rights Reserved.
 *
 * See file LICENSE.txt for full license details.
 *
 */
 
#ifndef APP_LIB_SETTINGS_H_
#define APP_LIB_SETTINGS_H_
 
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
 
#include "wms_app.h"
 
#define APP_LIB_SETTINGS_NAME 0x74ced676  
 
 
#define APP_LIB_SETTINGS_VERSION 0x20d
 
#define APP_LIB_SETTINGS_AES_KEY_NUM_BYTES 16
 
// Device address definition is in app/app.h */
 
typedef uint32_t app_lib_settings_net_addr_t;
 
typedef uint8_t app_lib_settings_net_channel_t;
 
#define CHANNEL_NO_CHANNEL 0
 
typedef enum
{
    APP_LIB_SETTINGS_ROLE_SINK_LE = 0x00,
    APP_LIB_SETTINGS_ROLE_SINK_LL = 0x10,
    APP_LIB_SETTINGS_ROLE_HEADNODE_LE = 0x01,
    APP_LIB_SETTINGS_ROLE_HEADNODE_LL = 0x11,
    APP_LIB_SETTINGS_ROLE_SUBNODE_LE = 0x02,
    APP_LIB_SETTINGS_ROLE_SUBNODE_LL = 0x12,
    APP_LIB_SETTINGS_ROLE_AUTOROLE_LE = 0x42,
    APP_LIB_SETTINGS_ROLE_AUTOROLE_LL = 0x52,
    APP_LIB_SETTINGS_ROLE_ADVERTISER = 0x04,
} app_lib_settings_role_e;
 
 
typedef enum
{
    APP_LIB_SETTINGS_REMOTE_API_RES_NONE = 0,
    APP_LIB_SETTINGS_REMOTE_API_RES_OK = 1,
    APP_LIB_SETTINGS_REMOTE_API_RES_OK_RESET = 2,
} app_lib_settings_remote_api_res_e;
 
 
typedef struct __attribute__((packed))
{
    struct
    {
        const uint8_t (*encryption_key_p)
            [APP_LIB_SETTINGS_AES_KEY_NUM_BYTES]; 
        const uint8_t (*authentication_key_p)
            [APP_LIB_SETTINGS_AES_KEY_NUM_BYTES]; 
    } network_key_pair, management_key_pair;
 
    struct
    {
        uint8_t apply_flags : 1;
 
        uint8_t app_key_management_supported : 1;
 
        uint8_t app_key_management_configured : 1;
 
        uint8_t revoke_keys : 1;
 
        uint8_t reserved : 4;
    } flags;
 
    uint8_t network_key_pair_seq; 
    uint8_t management_key_pair_seq; 
} app_lib_settings_key_management_configuration_t;
 
 
typedef uint8_t app_lib_settings_role_t;
 
typedef bool (*app_lib_settings_is_group_cb_f)(app_addr_t group_addr);
 
typedef app_res_e (*app_lib_settings_reset_all_f)(void);
 
typedef app_res_e (*app_lib_settings_get_feature_lock_bits_f)(
    uint32_t * bits_p);
 
typedef app_res_e (*app_lib_settings_set_feature_lock_bits_f)(uint32_t bits);
 
typedef app_res_e (*app_lib_settings_get_feature_lock_key_f)(uint8_t * key_p);
 
typedef app_res_e (*app_lib_settings_set_feature_lock_key_f)(
    const uint8_t * key_p);
 
typedef app_res_e (*app_lib_settings_get_node_address_f)(app_addr_t * addr_p);
 
typedef app_res_e (*app_lib_settings_set_node_address_f)(app_addr_t addr);
 
typedef app_res_e (*app_lib_settings_get_network_address_f)(
    app_lib_settings_net_addr_t * addr_p);
 
typedef app_res_e (*app_lib_settings_set_network_address_f)(
    app_lib_settings_net_addr_t addr);
 
typedef app_res_e (*app_lib_settings_get_network_channel_f)(
    app_lib_settings_net_channel_t * channel_p);
 
typedef app_res_e (*app_lib_settings_set_network_channel_f)(
    app_lib_settings_net_channel_t channel);
 
typedef app_res_e (*app_lib_settings_get_node_role_f)(
    app_lib_settings_role_t * role_p);
 
typedef app_res_e (*app_lib_settings_set_node_role_f)(
    app_lib_settings_role_t role);
 
typedef app_res_e (*app_lib_settings_get_authentication_key_f)(uint8_t * key_p);
 
typedef app_res_e (*app_lib_settings_set_authentication_key_f)(
    const uint8_t * key_p);
 
typedef app_res_e (*app_lib_settings_get_encryption_key_f)(uint8_t * key_p);
 
typedef app_res_e (*app_lib_settings_set_encryption_key_f)(
    const uint8_t * key_p);
 
typedef app_res_e (*app_lib_settings_get_ac_range_f)(uint16_t * ac_min_value_p,
                                                     uint16_t * ac_max_value_p);
 
typedef app_res_e (*app_lib_settings_set_ac_range_f)(uint16_t ac_min_value,
                                                     uint16_t ac_max_value);
 
typedef app_res_e (*app_lib_settings_get_offline_scan_f)(uint16_t * max_scan_p);
 
typedef app_res_e (*app_lib_settings_set_offline_scan_f)(uint16_t max_scan);
 
typedef app_res_e (*app_lib_settings_get_network_channel_limits_f)(
    uint16_t * min_value_p, uint16_t * max_value_p);
 
typedef app_res_e (*app_lib_settings_get_ac_range_limits_f)(
    uint16_t * min_value_p, uint16_t * max_value_p);
 
typedef app_res_e (*app_lib_settings_set_group_query_cb_f)(
    app_lib_settings_is_group_cb_f cb);
 
typedef app_res_e (*app_lib_settings_get_reserved_channels_f)(
    uint8_t * channels_p, size_t num_bytes);
 
typedef app_res_e (*app_lib_settings_set_reserved_channels_f)(
    const uint8_t * channels_p, size_t num_bytes);
 
typedef bool (*app_lib_settings_is_valid_network_address_f)(
    app_lib_settings_net_addr_t addr);
 
typedef bool (*app_lib_settings_is_valid_network_channel_f)(uint8_t channel);
 
typedef bool (*app_lib_settings_is_valid_node_address_f)(app_addr_t addr);
 
typedef bool (*app_lib_settings_is_valid_node_role_f)(
    app_lib_settings_role_t role);
 
typedef app_res_e (*app_lib_settings_key_management_config_f)(
    const app_lib_settings_key_management_configuration_t * key_mgmt_cfg_p);
 
 
#define REMOTE_API_CSAP_WRITE_UNICAST 0x1
 
// Return codes, these must match the values of the enum response_type_e in remote API
#define REMOTE_API_CSAP_RESPONSE_NORMAL 0
 
#define REMOTE_API_CSAP_RESPONSE_NONE 1
 
#define REMOTE_API_CSAP_RESPONSE_ACCESS_DENIED 0xf8
 
#define REMOTE_API_CSAP_RESPONSE_WRITE_ONLY_ATTRIBUTE 0xf9
 
#define REMOTE_API_CSAP_RESPONSE_INVALID_BROADCAST_REQUEST 0xfa
 
#define REMOTE_API_CSAP_RESPONSE_INVALID_BEGIN 0xfb
 
#define REMOTE_API_CSAP_RESPONSE_NO_SPACE_FOR_RESPONSE 0xfc
 
#define REMOTE_API_CSAP_RESPONSE_INVALID_VALUE 0xfd
 
#define REMOTE_API_CSAP_RESPONSE_INVALID_LENGTH 0xfe
 
#define REMOTE_API_CSAP_RESPONSE_UNKNOWN_REQUEST 0xff
 
typedef struct
{
    const uint8_t * request_buffer;
    uint8_t * response_buffer;
    uint8_t request_buffer_len;
    uint8_t response_buffer_len;
} app_lib_settings_remote_api_csap_data_t;
 
typedef uint8_t (*app_lib_settings_remote_api_csap_write_f)( uint16_t attr_id, uint32_t flags, app_lib_settings_remote_api_csap_data_t * data);
 
typedef app_res_e (*app_lib_settings_register_remote_api_csap_write_cb_f)(
    app_lib_settings_remote_api_csap_write_f cb);
 
 
typedef uint8_t (*app_lib_settings_remote_api_csap_read_f)( uint16_t attr_id, app_lib_settings_remote_api_csap_data_t * data);
 
 
typedef app_res_e (*app_lib_settings_register_remote_api_csap_read_cb_f)(
    app_lib_settings_remote_api_csap_read_f cb);
 
 
typedef app_lib_settings_remote_api_res_e (*app_lib_settings_remote_api_csap_update_f)( void );
 
 
typedef app_res_e (*app_lib_settings_register_remote_api_csap_update_cb_f)(
    app_lib_settings_remote_api_csap_update_f cb);
 
 
typedef void (*app_lib_settings_remote_api_csap_cancel_f)( void );
 
typedef app_res_e (*app_lib_settings_register_remote_api_csap_cancel_cb_f)(
    app_lib_settings_remote_api_csap_cancel_f cb);
 
typedef struct
{
    app_lib_settings_reset_all_f                  resetAll;
    app_lib_settings_get_feature_lock_bits_f      getFeatureLockBits;
    app_lib_settings_set_feature_lock_bits_f      setFeatureLockBits;
    app_lib_settings_get_feature_lock_key_f       getFeatureLockKey;
    app_lib_settings_set_feature_lock_key_f       setFeatureLockKey;
    app_lib_settings_get_node_address_f           getNodeAddress;
    app_lib_settings_set_node_address_f           setNodeAddress;
    app_lib_settings_get_network_address_f        getNetworkAddress;
    app_lib_settings_set_network_address_f        setNetworkAddress;
    app_lib_settings_get_network_channel_f        getNetworkChannel;
    app_lib_settings_set_network_channel_f        setNetworkChannel;
    app_lib_settings_get_node_role_f              getNodeRole;
    app_lib_settings_set_node_role_f              setNodeRole;
    app_lib_settings_get_authentication_key_f     getAuthenticationKey;
    app_lib_settings_set_authentication_key_f     setAuthenticationKey;
    app_lib_settings_get_encryption_key_f         getEncryptionKey;
    app_lib_settings_set_encryption_key_f         setEncryptionKey;
    app_lib_settings_get_ac_range_f               getAcRange;
    app_lib_settings_set_ac_range_f               setAcRange;
    app_lib_settings_get_offline_scan_f           getOfflineScan;
    app_lib_settings_set_offline_scan_f           setOfflineScan;
    app_lib_settings_get_network_channel_limits_f getNetworkChannelLimits;
    app_lib_settings_get_ac_range_limits_f        getAcRangeLimits;
    app_lib_settings_set_group_query_cb_f         registerGroupQuery;
    app_lib_settings_get_reserved_channels_f      getReservedChannels;
    app_lib_settings_set_reserved_channels_f      setReservedChannels;
    app_lib_settings_is_valid_network_address_f   isValidNetworkAddress;
    app_lib_settings_is_valid_network_channel_f   isValidNetworkChannel;
    app_lib_settings_is_valid_node_address_f      isValidNodeAddress;
    app_lib_settings_is_valid_node_role_f         isValidNodeRole;
    app_lib_settings_key_management_config_f      keyManagementConfiguration;
    app_lib_settings_register_remote_api_csap_write_cb_f  registerRemoteApiCsapWriteCb;
    app_lib_settings_register_remote_api_csap_read_cb_f  registerRemoteApiCsapReadCb;
    app_lib_settings_register_remote_api_csap_update_cb_f  registerRemoteApiCsapUpdateCb;
    app_lib_settings_register_remote_api_csap_cancel_cb_f  registerRemoteApiCsapCancelCb;
} app_lib_settings_t;
 
#endif /* APP_LIB_SETTINGS_H_ */