in_ble_prf_mesh.h

#ifndef IN_BLE_PRF_MESH_H
#define IN_BLE_PRF_MESH_H

#include <stdint.h>
#include "./ble/in_ble_prf.h"


#define MESH_LABEL_UUID_LEN (16)

/*
 * Enumerations
 ****************************************************************************************
 */

enum mesh_error
{
    MESH_ERR_NO_ERROR                             = 0x0000,

    /* **************************************************************** */
    /* *                     PROTOCOL ERROR CODES                     * */
    /* **************************************************************** */

    MESH_ERR_INVALID_ADDR                         = 0x0180,
    MESH_ERR_INVALID_MODEL                        = 0x0280,
    MESH_ERR_INVALID_APPKEY_ID                    = 0x0380,
    MESH_ERR_INVALID_NETKEY_ID                    = 0x0480,
    MESH_ERR_INSUFFICIENT_RESOURCES               = 0x0580,
    MESH_ERR_KEY_ID_ALREADY_STORED                = 0x0680,
    MESH_ERR_INVALID_PUBLISH_PARAMS               = 0x0780,
    MESH_ERR_NOT_A_SUBSCRIBE_MODEL                = 0x0880,
    MESH_ERR_STORAGE_FAILURE                      = 0x0980,
    MESH_ERR_NOT_SUPPORTED                        = 0x0A80,
    MESH_ERR_CANNOT_UPDATE                        = 0x0B80,
    MESH_ERR_CANNOT_REMOVE                        = 0x0C80,
    MESH_ERR_CANNOT_BIND                          = 0x0D80,
    MESH_ERR_TEMP_UNABLE_TO_CHANGE_STATE          = 0x0E80,
    MESH_ERR_CANNOT_SET                           = 0x0F80,
    MESH_ERR_UNSPECIFIED_ERROR                    = 0x1080,
    MESH_ERR_INVALID_BINDING                      = 0x1180,

    /* **************************************************************** */
    /* *                     PROVISIONING ERROR CODES                 * */
    /* **************************************************************** */

    MESH_ERR_PROV_PROHIBITED                      = 0x0081,
    MESH_ERR_PROV_INVALID_PDU                     = 0x0181,
    MESH_ERR_PROV_INVALID_FORMAT                  = 0x0281,
    MESH_ERR_PROV_UNEXPECTED_PDU                  = 0x0381,
    MESH_ERR_PROV_CONFIRMATION_FAILED             = 0x0481,
    MESH_ERR_PROV_OUT_OF_RESOURCES                = 0x0581,
    MESH_ERR_PROV_DECRYPTION_FAILED               = 0x0681,
    MESH_ERR_PROV_UNEXPECTED                      = 0x0781,
    MESH_ERR_PROV_CANNOT_ASSIGN_ADDR              = 0x0881,

    /* **************************************************************** */
    /* *                     INTERNAL ERROR CODES                     * */
    /* **************************************************************** */
    MESH_ERR_INVALID_PARAM                        = 0x0182,
    MESH_ERR_COMMAND_DISALLOWED                   = 0x0282,
    MESH_ERR_MIC_ERROR                            = 0x0382,
    MESH_ERR_BUSY                                 = 0x0482,
    MESH_ERR_TIME_PAST                            = 0x0582,
    MESH_ERR_NOT_FOUND                            = 0x0682,
    MESH_ERR_SEQ_ERROR                            = 0x0782,
    MESH_ERR_BEARER_CLOSED                        = 0x0882,
    MESH_ERR_PROVISIONING_FAILED                  = 0x0982,
    MESH_ERR_PROVISIONING_TIMEOUT                 = 0x0A82,
    MESH_ERR_ECDH_FAILED                          = 0x0B82,
    MESH_ERR_NO_EFFECT                            = 0x0C82,
    MESH_ERR_CANNOT_FRAGMENT                      = 0x0D82,

    /* **************************************************************** */
    /* *                  LOW POWER NODE ERROR CODES                  * */
    /* **************************************************************** */
    MESH_ERR_LPN_ESTAB_FAILED                     = 0x0183,
    MESH_ERR_LPN_ESTAB_FAILED_KEY                 = 0x0283,
    MESH_ERR_LPN_ESTAB_FAILED_UPD                 = 0x0383,
    MESH_ERR_LPN_FRIEND_LOST_LOCAL                = 0x0483,
    MESH_ERR_LPN_FRIEND_LOST_TIMEOUT              = 0x0583,
};


enum in_ble_mesh_evt 
{
    MESH_EVT_MODEL_OPCODE_REQ_IND = MESH_EVT_CODE+1,
    MESH_EVT_MODEL_MSG_IND,
    MESH_EVT_MODEL_MSG_SEND_IND,
    MESH_EVT_MODEL_PUBLISH_PERIOD_IND,
    MESH_EVT_ATTENTION_UPD_IND,
    MESH_EVT_NODE_RESET_IND,
    MESH_EVT_COMPO_DATA_REQ_IND,
    MESH_EVT_CFG_UPD_IND,
    MESH_EVT_FAULT_GET_REQ_IND,
    MESH_EVT_FAULT_TEST_REQ_IND,
    MESH_EVT_FAULT_CLEAR_IND,
    MESH_EVT_FAULT_PERIOD_IND,
    MESH_EVT_PROV_STATE_IND,
    MESH_EVT_PROV_PARAM_REQ_IND,
    MESH_EVT_PROV_AUTH_DATA_REQ_IND,
    MESH_EVT_LPN_OFFER_IND,
    MESH_EVT_LPN_STATUS_IND,
    MESH_EVT_DBG_FRIEND_LPN_IND,
};

typedef struct 
{
    uint8_t  model_lid;
    uint32_t opcode;
} mesh_evt_model_opcode_req_ind_t;

typedef struct 
{
    uint8_t  model_lid;
    uint8_t  app_key_lid;
    int8_t   rssi;
    uint8_t  not_relayed;
    uint32_t opcode;
    uint16_t src;
    uint16_t msg_len;
    uint8_t  msg[];

} mesh_evt_model_msg_ind_t;

typedef struct 
{
    uint8_t model_lid;
    uint8_t  tx_hdl;
    uint16_t status;
} mesh_evt_model_msg_sent_ind_t;


typedef struct 
{
    uint8_t  model_lid;
    uint32_t period_ms;
} mesh_evt_model_publish_period_ind_t;

typedef struct 
{
    uint8_t attention_state;
} mesh_evt_attention_upd_ind_t;

typedef struct 
{
    uint8_t page;
} mesh_evt_compo_data_req_ind_t;

typedef struct 
{
    uint8_t upd_type;
    uint8_t length;
    uint8_t data[];
} mesh_evt_cfg_upd_ind_t;

typedef struct 
{
    uint16_t comp_id;
} mesh_evt_fault_get_req_ind_t;

typedef struct 
{
    uint16_t comp_id;
    uint8_t  test_id;
    bool     cfm_needed;
} mesh_evt_fault_test_req_ind_t;

typedef struct 
{
    uint16_t comp_id;
} mesh_evt_fault_clear_ind_t;

typedef struct 
{
    uint32_t period_ms;
    uint32_t period_fault_ms;
} mesh_evt_fault_period_ind_t;

enum mesh_prov_state
{
    MESH_PROV_STARTED,
    MESH_PROV_SUCCEED,
    MESH_PROV_FAILED,
};

typedef struct 
{
    uint8_t state;
    uint16_t status;
} mesh_evt_prov_state_ind_t;

enum mesh_prov_out_oob
{
    MESH_PROV_OUT_OOB_BLINK        = 0x0001,
    MESH_PROV_OUT_OOB_BEEP         = 0x0002,
    MESH_PROV_OUT_OOB_VIBRATE      = 0x0004,
    MESH_PROV_OUT_OOB_NUMERIC      = 0x0008,
    MESH_PROV_OUT_OOB_ALPHANUMERIC = 0x0010,
};

enum mesh_prov_in_oob
{
    MESH_PROV_IN_OOB_PUSH         = 0x0001,
    MESH_PROV_IN_OOB_TWIST        = 0x0002,
    MESH_PROV_IN_OOB_NUMERIC      = 0x0004,
    MESH_PROV_IN_OOB_ALPHANUMERIC = 0x0008,
};

enum mesh_prov_info
{
    MESH_PROV_INFO_URI_HASH_PRESENT = (1 << 0),
};

typedef struct {
    uint8_t  dev_uuid[16];
    uint32_t uri_hash;
    uint16_t oob_info;
    uint8_t  pub_key_oob;
    uint8_t  static_oob;
    uint8_t  out_oob_size;
    uint8_t  in_oob_size;
    uint16_t out_oob_action;
    uint16_t in_oob_action;
    uint8_t  nb_elt;
    uint8_t  info;
} mesh_prov_param_t;

enum mesh_prov_auth_method
{
    MESH_PROV_AUTH_NO_OOB,
    MESH_PROV_AUTH_STATIC_OOB,
    MESH_PROV_AUTH_OUTPUT_OOB,
    MESH_PROV_AUTH_INPUT_OOB,
};


typedef struct 
{
    uint8_t  auth_method;
    uint8_t  auth_size;
    uint16_t auth_action;
} mesh_evt_prov_auth_data_req_ind_t;

typedef struct 
{
    uint16_t addr;
    uint8_t  rx_window;
    uint8_t  queue_size;
    uint8_t  subs_list_size;
    int8_t   rssi;
} mesh_evt_lpn_offer_ind_t;

typedef struct 
{
    uint16_t status;
    uint16_t friend_addr;
} mesh_evt_lpn_status_ind_t;

enum mesh_api_feat
{
    MESH_FEAT_RELAY_NODE_SUP       = (1 << 0),
    MESH_FEAT_PROXY_NODE_SUP       = (1 << 1),
    MESH_FEAT_FRIEND_NODE_SUP      = (1 << 2),
    MESH_FEAT_LOW_POWER_NODE_SUP   = (1 << 3),

    MESH_FEAT_MSG_API_SUP          = (1 << 14),
    MESH_FEAT_PB_GATT_SUP          = (1 << 15),
};


/*
 * Structures
 ****************************************************************************************
 */

typedef struct 
{
    uint16_t features;
    uint16_t cid;
    uint16_t pid;
    uint16_t vid;
    uint16_t loc;
    uint8_t  nb_cdata_page;
} mesh_cfg_t ;


typedef struct 
{
    uint16_t nb_wrap;
    uint32_t clock_ms;
} mesh_run_time_t;

typedef struct 
{
    uint32_t model_id;
    uint8_t  addr_offset;
    uint8_t  vendor;
} mesh_register_model_t;

typedef struct 
{
    uint8_t nb_bufs;
    uint8_t small;
    uint8_t block_id;
} mesh_buf_alloc_t;

typedef struct 
{
    uint8_t model_lid;
    uint8_t  trans_mic_64;
    uint32_t opcode;
    uint16_t len;
    uint8_t  msg[];
} mesh_model_publish_t;

typedef struct 
{
    uint8_t  model_lid;
    uint8_t  key_lid;
    uint8_t  trans_mic_64;
    uint32_t opcode;
    uint16_t dst;
    uint8_t  not_relay;
    uint16_t len;
    uint8_t  msg[];

} mesh_model_rsp_t;

typedef struct 
{
    uint16_t comp_id;
    uint8_t  test_id;
    uint8_t  length;
    uint8_t  fault_array[];
} mesh_health_status_t;

typedef struct 
{
    uint32_t poll_timeout;
    uint32_t poll_intv_ms;
    uint8_t  rx_delay;
    uint8_t  rssi_factor;
    uint8_t  rx_window_factor;
    uint8_t  min_queue_size_log;
} mesh_lpn_start_t;

typedef struct 
{
    uint8_t  pub_key_x[32];
    uint8_t  pub_key_y[32];
} mesh_pub_key_t;


/* ******************************** */
/* *        MODEL IO TESTS        * */
/* ******************************** */

typedef struct mesh_dbg_mio_set_publi_param_cmd
{

    uint8_t  model_lid;
    uint8_t  app_key_lid;
    uint16_t addr;
    uint8_t  ttl;
    uint8_t  period;
    uint8_t  retx_params;
    uint8_t  friend_cred;
    uint8_t  label_uuid[MESH_LABEL_UUID_LEN];//M_LABEL_UUID_LEN
} mesh_dbg_mio_set_publi_param_cmd_t;

typedef struct mesh_dbg_mio_get_publi_param_cmd
{


    uint8_t  model_lid;
} mesh_dbg_mio_get_publi_param_cmd_t;

typedef struct mesh_dbg_mio_publi_param
{

    uint16_t status;

    uint8_t  model_lid;
    uint8_t  app_key_lid;
    uint16_t addr;
    uint8_t  ttl;
    uint8_t  period;
    uint8_t  retx_params;
    uint8_t  friend_cred;
} mesh_dbg_mio_publi_param_t;

typedef struct mesh_dbg_mio_add_addr_subs_cmd
{


    uint16_t addr;
    uint8_t  model_lid;
    uint8_t  label_uuid[MESH_LABEL_UUID_LEN];
} mesh_dbg_mio_add_addr_subs_cmd_t;

typedef struct mesh_dbg_mio_del_addr_subs_cmd
{


    uint16_t addr;
    uint8_t  model_lid;
    uint8_t  label_uuid[MESH_LABEL_UUID_LEN];
} mesh_dbg_mio_del_addr_subs_cmd_t;

typedef struct mesh_dbg_mio_get_subs_cmd
{


    uint8_t  model_lid;
} mesh_dbg_mio_get_subs_cmd_t;

typedef struct mesh_dbg_mio_subs
{

    uint16_t status;

    uint16_t nb_addr;
    uint8_t  model_lid;
    uint16_t addr[];
} mesh_dbg_mio_subs_t;

typedef struct mesh_dbg_mio_clear_subs_cmd
{


    uint8_t  model_lid;
} mesh_dbg_mio_clear_subs_cmd_t;

typedef struct mesh_dbg_mio_is_addr_subs_cmd
{


    uint16_t addr;
    uint8_t  model_lid;
} mesh_dbg_mio_is_addr_subs_cmd_t;

typedef struct mesh_dbg_mio_set_prim_addr_cmd
{


    uint16_t prim_addr;
} mesh_dbg_mio_set_prim_addr_cmd_t;



enum in_ble_m_dbg_layer
{
    IN_BLE_M_DBG_LAYER_ABSTRACT = 0,
    IN_BLE_M_DBG_LAYER_BEARER,
    IN_BLE_M_DBG_LAYER_NETWORK,
    IN_BLE_M_DBG_LAYER_LTRANSPORT,
    IN_BLE_M_DBG_LAYER_UTRANSPORT,
    IN_BLE_M_DBG_LAYER_ACCESS,
    IN_BLE_M_DBG_LAYER_BEACON,
    IN_BLE_M_DBG_LAYER_PROVISIONING,
    IN_BLE_M_DBG_LAYER_FRIEND_NET,
};
enum in_ble_m_tb_friend_event
{
    IN_BLE_M_TB_FRIEND_EVENT_DISC = 0,
    IN_BLE_M_TB_FRIEND_EVENT_ESTAB,
    IN_BLE_M_TB_FRIEND_EVENT_LOST,
};
typedef struct mesh_dbg_data_send
{
    uint32_t cmd_code;

    uint8_t  layer;
    uint16_t data_len;
    uint16_t env_len;
    uint8_t  env_data[];
} mesh_dbg_data_send_t;
typedef struct mesh_dbg_friend_lpn_ind
{
    uint16_t lpn_addr;
    uint8_t  lpn_lid;
    uint8_t  event;
} mesh_dbg_friend_lpn_ind_t;
/*
 * APIs
 ****************************************************************************************
 */
int in_ble_mesh_add(void *hdl,  mesh_cfg_t *p_para, comp_cb callback);
int in_ble_mesh_enable(void *hdl, comp_cb callback);
int in_ble_mesh_disable(void *hdl, comp_cb callback  );
int in_ble_mesh_get_run_time(void *hdl,  mesh_run_time_t *p_para,  comp_cb callback);
int in_ble_mesh_set_run_time(void *hdl,  mesh_run_time_t *p_para,  comp_cb callback);
int in_ble_mesh_register_model(void *hdl,  mesh_register_model_t *p_para,  comp_cb callback);
int in_ble_mesh_load_stored_info(void *hdl,  uint8_t *buf ,uint32_t len,  comp_cb callback);
int in_ble_mesh_buf_alloc(void *hdl,  mesh_buf_alloc_t *p_para,  comp_cb callback);
int in_ble_mesh_buf_free(void *hdl,  uint8_t block_id,  comp_cb callback);
int in_ble_mesh_publish_model(void *hdl,  mesh_model_publish_t *p_para,  comp_cb callback);
int in_ble_mesh_model_resp(void *hdl,  mesh_model_rsp_t *p_para,  comp_cb callback);
int in_ble_mesh_health_status_send(void *hdl,  mesh_health_status_t *p_para,  comp_cb callback);
int in_ble_mesh_read_prov_pubkey(void *hdl,  comp_cb callback);
int in_ble_mesh_iv_upd_test_mode(void *hdl,  bool update,  comp_cb callback);
int in_ble_mesh_lpn_start(void *hdl,  mesh_lpn_start_t *p_para,  comp_cb callback);
int in_ble_mesh_lpn_stop(void *hdl,  comp_cb callback);
int in_ble_mesh_select_friend(void *hdl,  uint16_t friend_addr,  comp_cb callback);
int in_ble_mesh_proxy_ctl(void *hdl,  uint8_t enable,  comp_cb callback);
int in_ble_mesh_model_opcode_req_cfm(void *hdl,  uint8_t model_lid, uint16_t status, uint32_t opcode);
int in_ble_mesh_compo_data_cfm(void *hdl,  uint8_t page, uint16_t length, uint8_t *data);
int in_ble_mesh_fault_cfm(void *hdl,  bool accept, uint16_t comp_id, uint8_t test_id, uint8_t length, uint8_t *fault_array);
int in_ble_mesh_prov_param_cfm(void *hdl,  mesh_prov_param_t *p_para);
int in_ble_mesh_prov_auth_data_cfm(void *hdl,  uint8_t accept, uint8_t auth_size, uint8_t *auth_data);


#endif  /* IN_BLE_PRF_MESH_H */