meshx_ble_mesh_prov_srv.h

Go to the documentation of this file.

 
#ifndef __MESHX_BLE_MESH_PROV_SRV_H__
#define __MESHX_BLE_MESH_PROV_SRV_H__
 
#include "../meshx_ble_mesh_cmn.h"
#include "meshx_control_task.h"
 
typedef control_task_msg_handle_t prov_srv_cb_t;
typedef control_task_msg_evt_provision_t prov_evt_t;

typedef enum
{
    MESHX_PROV_ADV  = MESHX_BIT(0),
    MESHX_PROV_GATT = MESHX_BIT(1),
} meshx_prov_bearer_t;

typedef enum
{
    MESHX_PROV_OOB_OTHER        = MESHX_BIT(0),
    MESHX_PROV_OOB_URI          = MESHX_BIT(1),
    MESHX_PROV_OOB_2D_CODE      = MESHX_BIT(2),
    MESHX_PROV_OOB_BAR_CODE     = MESHX_BIT(3),
    MESHX_PROV_OOB_NFC          = MESHX_BIT(4),
    MESHX_PROV_OOB_NUMBER       = MESHX_BIT(5),
    MESHX_PROV_OOB_STRING       = MESHX_BIT(6),
    MESHX_PROV_CERT_BASED       = MESHX_BIT(7),
    MESHX_PROV_RECORDS          = MESHX_BIT(8),
    /* 9 - 10 are reserved */
    MESHX_PROV_OOB_ON_BOX       = MESHX_BIT(11),
    MESHX_PROV_OOB_IN_BOX       = MESHX_BIT(12),
    MESHX_PROV_OOB_ON_PAPER     = MESHX_BIT(13),
    MESHX_PROV_OOB_IN_MANUAL    = MESHX_BIT(14),
    MESHX_PROV_OOB_ON_DEV       = MESHX_BIT(15),
} meshx_prov_oob_info_t;

typedef union
{
    struct meshx_prov_register_comp_param
    {
        int err_code;     
    } prov_register_comp; 

    struct meshx_set_unprov_dev_name_comp_param
    {
        int err_code;                
    } node_set_unprov_dev_name_comp; 

    struct meshx_prov_enable_comp_param
    {
        int err_code;        
    } node_prov_enable_comp; 

    struct meshx_prov_disable_comp_param
    {
        int err_code;         
    } node_prov_disable_comp; 

    struct meshx_link_open_evt_param
    {
        meshx_prov_bearer_t bearer; 
    } node_prov_link_open;          

    struct meshx_link_close_evt_param
    {
        meshx_prov_bearer_t bearer; 
        uint8_t reason;             
    } node_prov_link_close;         

    struct meshx_output_num_evt_param
    {
        meshx_output_action_t action; 
        uint32_t number;              
    } node_prov_output_num;           

    struct meshx_output_str_evt_param
    {
        char string[8];     
    } node_prov_output_str; 

    struct meshx_input_evt_param
    {
        meshx_input_action_t action; 
        uint8_t size;                
    } node_prov_input;               

    struct meshx_provision_complete_evt_param
    {
        uint16_t net_idx;    
        uint8_t net_key[16]; 
        uint16_t addr;       
        uint8_t flags;       
        uint32_t iv_index;   
    } node_prov_complete;    

    struct meshx_provision_reset_param
    {
 
    } node_prov_reset; 

    struct meshx_set_oob_pub_key_comp_param
    {
        int err_code;                 
    } node_prov_set_oob_pub_key_comp; 

    struct meshx_input_number_comp_param
    {
        int err_code;           
    } node_prov_input_num_comp; 

    struct meshx_input_string_comp_param
    {
        int err_code;           
    } node_prov_input_str_comp; 

    struct meshx_proxy_identity_enable_comp_param
    {
        int err_code;                  
    } node_proxy_identity_enable_comp; 

    struct meshx_proxy_gatt_enable_comp_param
    {
        int err_code;              
    } node_proxy_gatt_enable_comp; 

    struct meshx_proxy_gatt_disable_comp_param
    {
        int err_code;               
    } node_proxy_gatt_disable_comp; 

    struct meshx_proxy_private_identity_enable_comp_param
    {
        int err_code;                          
    } node_private_proxy_identity_enable_comp; 

    struct meshx_proxy_private_identity_disable_comp_param
    {
        int err_code;                           
    } node_private_proxy_identity_disable_comp; 

    struct meshx_node_add_local_net_key_comp_param
    {
        int err_code;        
        uint16_t net_idx;    
    } node_add_net_key_comp; 

    struct meshx_node_add_local_app_key_comp_param
    {
        int err_code;        
        uint16_t net_idx;    
        uint16_t app_idx;    
    } node_add_app_key_comp; 

    struct meshx_node_bind_local_mod_app_comp_param
    {
        int err_code;                  
        uint16_t element_addr;         
        uint16_t app_idx;              
        uint16_t company_id;           
        uint16_t model_id;             
    } node_bind_app_key_to_model_comp; 

    struct meshx_provisioner_recv_unprov_adv_pkt_param
    {
        uint8_t dev_uuid[16];          
        meshx_bd_addr_t addr;          
        meshx_addr_type_t addr_type;   
        uint16_t oob_info;             
        uint8_t adv_type;              
        meshx_prov_bearer_t bearer;    
        int8_t rssi;                   
    } provisioner_recv_unprov_adv_pkt; 

    struct meshx_provisioner_prov_enable_comp_param
    {
        int err_code;               
    } provisioner_prov_enable_comp; 

    struct meshx_provisioner_prov_disable_comp_param
    {
        int err_code;                
    } provisioner_prov_disable_comp; 

    struct meshx_provisioner_link_open_evt_param
    {
        meshx_prov_bearer_t bearer; 
    } provisioner_prov_link_open;   

    struct meshx_provisioner_prov_read_oob_pub_key_evt_param
    {
        uint8_t link_idx;                
    } provisioner_prov_read_oob_pub_key; 

    struct meshx_provisioner_prov_input_evt_param
    {
        meshx_oob_method_t method;    
        meshx_output_action_t action; 
        uint8_t size;                 
        uint8_t link_idx;             
    } provisioner_prov_input;         

    struct meshx_provisioner_prov_output_evt_param
    {
        meshx_oob_method_t method;   
        meshx_input_action_t action; 
        uint8_t size;                
        uint8_t link_idx;            
        union
        {
            char string[8];  
            uint32_t number; 
        };
    } provisioner_prov_output; 

    struct meshx_provisioner_link_close_evt_param
    {
        meshx_prov_bearer_t bearer; 
        uint8_t reason;             
    } provisioner_prov_link_close;  

    struct meshx_provisioner_prov_comp_param
    {
        uint16_t node_idx;       
        uint8_t device_uuid[16]; 
        uint16_t unicast_addr;   
        uint8_t element_num;     
        uint16_t netkey_idx;     
    } provisioner_prov_complete; 

    struct meshx_provisioner_cert_based_prov_start_evt_param
    {
        uint16_t link_idx;               
    } provisioner_cert_based_prov_start; 

    struct meshx_provisioner_recv_prov_records_list_evt_param
    {
        uint16_t link_idx;           
        uint16_t len;                
        uint8_t *msg;                
    } recv_provisioner_records_list; 

    struct meshx_provisioner_prov_record_recv_comp_evt_param
    {
        uint8_t status;                  
        uint16_t link_idx;               
        uint16_t record_id;              
        uint16_t frag_offset;            
        uint16_t total_len;              
        uint8_t *record;                 
    } provisioner_prov_record_recv_comp; 

    struct meshx_provisioner_send_prov_records_get_evt_param
    {
        int err_code;               
        uint16_t link_idx;          
    } provisioner_send_records_get; 

    struct meshx_provisioner_send_prov_record_req_evt_param
    {
        int err_code;              
        uint16_t link_idx;         
        uint16_t record_id;        
        uint16_t frag_offset;      
        uint16_t max_size;         
    } provisioner_send_record_req; 

    struct meshx_provisioner_send_prov_invite_evt_param
    {
        uint16_t link_idx;          
        int err_code;               
    } provisioner_send_prov_invite; 

    struct meshx_provisioner_send_link_close_evt_param
    {
        uint16_t link_idx;         
        int err_code;              
    } provisioner_send_link_close; 

    struct meshx_provisioner_add_unprov_dev_comp_param
    {
        int err_code;                  
    } provisioner_add_unprov_dev_comp; 

    struct meshx_provisioner_prov_dev_with_addr_comp_param
    {
        int err_code;                      
    } provisioner_prov_dev_with_addr_comp; 

    struct meshx_provisioner_delete_dev_comp_param
    {
        int err_code;              
    } provisioner_delete_dev_comp; 

    struct meshx_provisioner_set_dev_uuid_match_comp_param
    {
        int err_code;                      
    } provisioner_set_dev_uuid_match_comp; 

    struct meshx_provisioner_set_prov_data_info_comp_param
    {
        int err_code;                      
    } provisioner_set_prov_data_info_comp; 

    struct meshx_provisioner_set_static_oob_val_comp_param
    {
        int err_code;                      
    } provisioner_set_static_oob_val_comp; 

    struct meshx_provisioner_set_primary_elem_addr_comp_param
    {
        int err_code;                         
    } provisioner_set_primary_elem_addr_comp; 

    struct meshx_provisioner_prov_read_oob_pub_key_comp_param
    {
        int err_code;                         
    } provisioner_prov_read_oob_pub_key_comp; 

    struct meshx_provisioner_prov_input_num_comp_param
    {
        int err_code;                  
    } provisioner_prov_input_num_comp; 

    struct meshx_provisioner_prov_input_str_comp_param
    {
        int err_code;                  
    } provisioner_prov_input_str_comp; 

    struct meshx_provisioner_set_node_name_comp_param
    {
        int err_code;                 
        uint16_t node_index;          
    } provisioner_set_node_name_comp; 

    struct meshx_provisioner_add_local_app_key_comp_param
    {
        int err_code;               
        uint16_t net_idx;           
        uint16_t app_idx;           
    } provisioner_add_app_key_comp; 

    struct meshx_provisioner_update_local_app_key_comp_param
    {
        int err_code;                  
        uint16_t net_idx;              
        uint16_t app_idx;              
    } provisioner_update_app_key_comp; 

    struct meshx_provisioner_bind_local_mod_app_comp_param
    {
        int err_code;                         
        uint16_t element_addr;                
        uint16_t app_idx;                     
        uint16_t company_id;                  
        uint16_t model_id;                    
    } provisioner_bind_app_key_to_model_comp; 

    struct meshx_provisioner_add_local_net_key_comp_param
    {
        int err_code;               
        uint16_t net_idx;           
    } provisioner_add_net_key_comp; 

    struct meshx_provisioner_update_local_net_key_comp_param
    {
        int err_code;                  
        uint16_t net_idx;              
    } provisioner_update_net_key_comp; 

    struct meshx_provisioner_store_node_comp_data_comp_param
    {
        int err_code;                        
        uint16_t addr;                       
    } provisioner_store_node_comp_data_comp; 

    struct meshx_provisioner_delete_node_with_uuid_comp_param
    {
        int err_code;                         
        uint8_t uuid[16];                     
    } provisioner_delete_node_with_uuid_comp; 

    struct meshx_provisioner_delete_node_with_addr_comp_param
    {
        int err_code;                         
        uint16_t unicast_addr;                
    } provisioner_delete_node_with_addr_comp; 

    struct
    {
        int err_code;                         
        bool enable;                          
    } provisioner_enable_heartbeat_recv_comp; 
    struct
    {
        int err_code;                             
        uint8_t type;                             
    } provisioner_set_heartbeat_filter_type_comp; 
    struct
    {
        int err_code;                             
        uint8_t op;                               
        uint16_t hb_src;                          
        uint16_t hb_dst;                          
    } provisioner_set_heartbeat_filter_info_comp; 
    struct
    {
        uint16_t hb_src;          
        uint16_t hb_dst;          
        uint8_t init_ttl;         
        uint8_t rx_ttl;           
        uint8_t hops;             
        uint16_t feature;         
        int8_t rssi;              
    } provisioner_recv_heartbeat; 
    struct
    {
        int err_code;                         
    } provisioner_direct_erase_settings_comp; 
    struct
    {
        int err_code;                            
        uint8_t index;                           
    } provisioner_open_settings_with_index_comp; 
    struct
    {
        int err_code;                                 
        uint8_t index;                                
        char uid[MESHX_SETTINGS_UID_SIZE + 1]; 
    } provisioner_open_settings_with_uid_comp;        
    struct
    {
        int err_code;                             
        uint8_t index;                            
    } provisioner_close_settings_with_index_comp; 
    struct
    {
        int err_code;                                 
        uint8_t index;                                
        char uid[MESHX_SETTINGS_UID_SIZE + 1]; 
    } provisioner_close_settings_with_uid_comp;       
    struct
    {
        int err_code;                              
        uint8_t index;                             
    } provisioner_delete_settings_with_index_comp; 
    struct
    {
        int err_code;                                 
        uint8_t index;                                
        char uid[MESHX_SETTINGS_UID_SIZE + 1]; 
    } provisioner_delete_settings_with_uid_comp;      
    struct meshx_set_fast_prov_info_comp_param
    {
        uint8_t status_unicast; 
        uint8_t status_net_idx; 
        uint8_t status_match;   
    } set_fast_prov_info_comp;  

    struct meshx_set_fast_prov_action_comp_param
    {
        uint8_t status_action;   
    } set_fast_prov_action_comp; 

    struct meshx_heartbeat_msg_recv_param
    {
        uint8_t hops;     
        uint16_t feature; 
    } heartbeat_msg_recv; 

    struct meshx_lpn_enable_comp_param
    {
        int err_code;  
    } lpn_enable_comp; 

    struct meshx_lpn_disable_comp_param
    {
        int err_code;   
    } lpn_disable_comp; 

    struct meshx_lpn_poll_comp_param
    {
        int err_code; 
    } lpn_poll_comp;  

    struct meshx_lpn_friendship_establish_param
    {
        uint16_t friend_addr;   
    } lpn_friendship_establish; 

    struct meshx_lpn_friendship_terminate_param
    {
        uint16_t friend_addr;   
    } lpn_friendship_terminate; 

    struct meshx_friend_friendship_establish_param
    {
        uint16_t lpn_addr;       
    } frnd_friendship_establish; 

    struct meshx_friend_friendship_terminate_param
    {
        uint16_t lpn_addr; 
        enum
        {
            MESHX_FRND_FRIENDSHIP_TERMINATE_ESTABLISH_FAIL,  
            MESHX_FRND_FRIENDSHIP_TERMINATE_POLL_TIMEOUT,    
            MESHX_FRND_FRIENDSHIP_TERMINATE_RECV_FRND_REQ,   
            MESHX_FRND_FRIENDSHIP_TERMINATE_RECV_FRND_CLEAR, 
            MESHX_FRND_FRIENDSHIP_TERMINATE_DISABLE,         
        } reason;                                                   
    } frnd_friendship_terminate;                                    

    struct meshx_proxy_client_recv_adv_pkt_param
    {
        meshx_bd_addr_t addr;        
        meshx_addr_type_t addr_type; 
        uint16_t net_idx;            
        uint8_t net_id[8];           
        int8_t rssi;                 
    } proxy_client_recv_adv_pkt;     

    struct meshx_proxy_client_connected_param
    {
        meshx_bd_addr_t addr;        
        meshx_addr_type_t addr_type; 
        uint8_t conn_handle;         
        uint16_t net_idx;            
    } proxy_client_connected;        

    struct meshx_proxy_client_disconnected_param
    {
        meshx_bd_addr_t addr;        
        meshx_addr_type_t addr_type; 
        uint8_t conn_handle;         
        uint16_t net_idx;            
        uint8_t reason;              
    } proxy_client_disconnected;     

    struct meshx_proxy_client_recv_filter_status_param
    {
        uint8_t conn_handle;           
        uint16_t server_addr;          
        uint16_t net_idx;              
        uint8_t filter_type;           
        uint16_t list_size;            
    } proxy_client_recv_filter_status; 

    struct meshx_proxy_client_connect_comp_param
    {
        int err_code;                
        meshx_bd_addr_t addr;        
        meshx_addr_type_t addr_type; 
        uint16_t net_idx;            
    } proxy_client_connect_comp;     

    struct meshx_proxy_client_disconnect_comp_param
    {
        int err_code;               
        uint8_t conn_handle;        
    } proxy_client_disconnect_comp; 

    struct meshx_proxy_client_set_filter_type_comp_param
    {
        int err_code;                    
        uint8_t conn_handle;             
        uint16_t net_idx;                
    } proxy_client_set_filter_type_comp; 

    struct meshx_proxy_client_add_filter_addr_comp_param
    {
        int err_code;                    
        uint8_t conn_handle;             
        uint16_t net_idx;                
    } proxy_client_add_filter_addr_comp; 

    struct meshx_proxy_client_remove_filter_addr_comp_param
    {
        int err_code;                       
        uint8_t conn_handle;                
        uint16_t net_idx;                   
    } proxy_client_remove_filter_addr_comp; 

    struct meshx_proxy_client_directed_proxy_set_param
    {
        int err_code;                       
        uint8_t conn_handle;                
        uint16_t net_idx;                   
    } proxy_client_directed_proxy_set_comp; 

    struct meshx_proxy_server_connected_param
    {
        uint8_t conn_handle;  
    } proxy_server_connected; 

    struct meshx_proxy_server_disconnected_param
    {
        uint8_t conn_handle;     
        uint8_t reason;          
    } proxy_server_disconnected; 

    struct
    {
        int err_code;                   
        uint16_t net_idx;               
        uint16_t ssrc;                  
        uint16_t dst;                   
    } proxy_client_send_solic_pdu_comp; 
    struct meshx_model_sub_group_addr_comp_param
    {
        int err_code;            
        uint16_t element_addr;   
        uint16_t company_id;     
        uint16_t model_id;       
        uint16_t group_addr;     
    } model_sub_group_addr_comp; 

    struct meshx_model_unsub_group_addr_comp_param
    {
        int err_code;              
        uint16_t element_addr;     
        uint16_t company_id;       
        uint16_t model_id;         
        uint16_t group_addr;       
    } model_unsub_group_addr_comp; 

    struct meshx_deinit_mesh_comp_param
    {
        int err_code;    
    } deinit_mesh_comp;  
} meshx_prov_cb_param_t; 
 
typedef struct meshx_ble_mesh_prov_srv_param
{
    uint16_t prov_evt;
    meshx_prov_cb_param_t param;
}meshx_prov_srv_param_t;

meshx_err_t meshx_prov_srv_notify_plat_event(meshx_prov_srv_param_t *param);

meshx_err_t meshx_plat_init_prov(const uint8_t *uuid);

meshx_ptr_t meshx_plat_get_prov(void);
 
#endif /* __MESHX_BLE_MESH_PROV_SRV_H__ */