bt-oal/hardware/bt_mesh.h

   1 /*
   2  * Copyright (C) 2020 Samsung Electronics Company Ltd.
   3  *
   4  * @author: Anupam Roy <anupam.r@samsung.com>
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 #ifndef TIZEN_INCLUDE_BT_MESH_H
  20 #define TIZEN_INCLUDE_BT_MESH_H
  21
  22 #include <stdint.h>
  23 #include <glib.h>
  24
  25 __BEGIN_DECLS
  26
  27 /* Mesh Authentication types */
  28 typedef enum {
  29         /*< Output authentication request types */
  30         BT_HAL_MESH_AUTH_ALPHANUMERIC_DISPLAY = 0,
  31         BT_HAL_MESH_AUTH_NUMERIC_DISPLAY,
  32         BT_HAL_MESH_AUTH_PUSH_COUNT_DISPLAY,
  33         BT_HAL_MESH_AUTH_TWIST_COUNT_DISPLAY,
  34
  35         /*< Input authentication request types */
  36         BT_HAL_MESH_AUTH_REQ_ALPHANUMERIC_INPUT,
  37         BT_HAL_MESH_AUTH_REQ_NUMERIC_INPUT,
  38         BT_HAL_MESH_AUTH_REQ_BLINK_COUNT_INPUT,
  39         BT_HAL_MESH_AUTH_REQ_BEEP_COUNT_INPUT,
  40         BT_HAL_MESH_AUTH_REQ_VIBRATE_COUNT_INPUT,
  41
  42         /**< OOB Key Inputs */
  43         BT_HAL_MESH_AUTH_REQ_OOB_PUBLIC_KEY_INPUT,
  44         BT_HAL_MESH_AUTH_REQ_OOB_STATIC_KEY_INPUT,
  45         BT_HAL_MESH_UNKNOWN_AUTH_METHOD
  46 } bt_hal_mesh_auth_variant_e;
  47
  48 /* Spec defined Error Codes */
  49 typedef enum {
  50         BT_HAL_MESH_PROV_ERR_INTERNAL               = -1,
  51         BT_HAL_MESH_PROV_ERR_SUCCESS                = 0x00,
  52         BT_HAL_MESH_PROV_ERR_INVALID_PDU            = 0x01,
  53         BT_HAL_MESH_PROV_ERR_INVALID_FORMAT         = 0x02,
  54         BT_HAL_MESH_PROV_ERR_UNEXPECTED_PDU         = 0x03,
  55         BT_HAL_MESH_PROV_ERR_CONFIRM_FAILED         = 0x04,
  56         BT_HAL_MESH_PROV_ERR_INSUF_RESOURCE         = 0x05,
  57         BT_HAL_MESH_PROV_ERR_DECRYPT_FAILED         = 0x06,
  58         BT_HAL_MESH_PROV_ERR_UNEXPECTED_ERR         = 0x07,
  59         BT_HAL_MESH_PROV_ERR_CANT_ASSIGN_ADDR       = 0x08,
  60         /* Internally generated  by Stack */
  61         BT_HAL_MESH_PROV_ERR_TIMEOUT                = 0xFF,
  62 } bt_hal_mesh_prov_error_codes_e;
  63
  64 /* Mesh Node Properties */
  65 typedef struct {
  66         uint16_t companyid;
  67         uint16_t vendorid;
  68         uint16_t versionid;
  69         uint16_t crpl;
  70 } bt_hal_mesh_vendor_info_t;
  71
  72 /* Mesh Model: 2 bytes for BT SIG Model & 4 bytes for Vendor Model */
  73 typedef struct {
  74         uint16_t elem_index;
  75         uint32_t model_id;
  76 } bt_hal_mesh_model_t;
  77
  78 /* Mesh Element structure */
  79 typedef struct {
  80         uint16_t index;
  81         int num_models;
  82 } bt_hal_mesh_element_t;
  83
  84 /* Mesh Node structure */
  85 typedef struct {
  86         bt_hal_mesh_vendor_info_t vendor_info;
  87         uint16_t num_elements;
  88         uint16_t primary_unicast;
  89         bt_uuid_t uuid;
  90         union {
  91                 uint8_t u8[8];
  92                 uint64_t u64;
  93         } token;
  94 } bt_hal_mesh_node_t;
  95
  96 /** Bluetooth Mesh Security Token */
  97 typedef struct {
  98         uint8_t token[8];
  99 } bt_mesh_token_t;
 100
 101 typedef struct {
 102         uint32_t scan_time;
 103 } bt_hal_mesh_scan_param_t;
 104
 105 typedef struct {
 106         bool public_oob;
 107         bool static_oob;
 108         uint16_t out_oob;
 109         uint16_t in_oob;
 110 } bt_hal_mesh_prov_caps_t;
 111
 112 /** Bluetooth Mesh Security Token */
 113 typedef struct {
 114         int rssi;
 115         bt_uuid_t dev_uuid;
 116         uint8_t oob_info[2];
 117         uint8_t uri_hash[4];
 118 } bt_mesh_scan_result_t;
 119
 120 /** Bluetooth Mesh Scan state */
 121 typedef enum {
 122         BT_MESH_SCAN_STOPPED,
 123         BT_MESH_SCAN_STARTED
 124 } bt_mesh_scan_state_t;
 125
 126 /** Bluetooth Mesh Scan state */
 127 typedef enum {
 128         BT_MESH_KEY_CREATE,
 129         BT_MESH_KEY_UPDATE,
 130         BT_MESH_KEY_DELETE,
 131 } bt_mesh_key_op_e;
 132
 133 /** Callback Signatures */
 134 typedef void (*btmesh_network_attached_callback)(bt_status_t status,
 135                 bt_mesh_token_t *token, bt_uuid_t *uuid);
 136
 137 typedef void (*btmesh_network_destroyed_callback)(bt_status_t status,
 138                 bt_mesh_token_t *token, bt_uuid_t *uuid);
 139
 140 typedef void (*btmesh_network_scan_status_callback)(
 141                 bt_mesh_scan_state_t scan_state, bt_status_t status,
 142                         bt_uuid_t *net_uuid);
 143
 144 typedef void (*btmesh_network_scan_result_callback)(bt_status_t status,
 145                 bt_uuid_t *net_uuid, bt_mesh_scan_result_t *scan_result);
 146
 147 typedef void (*btmesh_network_provisioning_status_callback)(
 148                 bt_status_t status, bt_uuid_t *net_uuid, bt_uuid_t *dev_uuid);
 149
 150 typedef void (*btmesh_network_provisioning_finished_callback)(
 151                 bt_status_t status, int reason, bt_uuid_t *net_uuid,
 152                         bt_uuid_t *dev_uuid, uint16_t unicast, uint8_t count);
 153
 154 typedef void (*btmesh_network_provisioning_data_requested_callback)(
 155                 bt_uuid_t *net_uuid, uint8_t count);
 156
 157 typedef void (*btmesh_network_authentication_requested_callback)(
 158                 bt_uuid_t *net_uuid,
 159                         bt_hal_mesh_auth_variant_e auth_type, char auth_value[]);
 160
 161 typedef void (*btmesh_network_netkey_execute_callback)(
 162                 bt_status_t status, bt_uuid_t *net_uuid,
 163                         uint8_t key_event, uint16_t netkey_idx);
 164
 165 typedef void (*btmesh_network_appkey_execute_callback)(
 166                 bt_status_t status, bt_uuid_t *net_uuid, uint8_t key_event,
 167                         uint16_t netkey_idx, uint16_t appkey_idx);
 168
 169 typedef void (*btmesh_devkey_message_received_callback)(bt_uuid_t *net_uuid,
 170                 uint16_t source_addr, bool is_devkey_remote, uint16_t netkey_idx,
 171                         uint16_t data_len, uint8_t *data);
 172
 173 typedef void (*btmesh_message_received_callback)(bt_uuid_t *net_uuid,
 174                 uint16_t source_addr, uint16_t dest_addr, uint16_t key_idx,
 175                         uint16_t data_len, uint8_t *data);
 176
 177 /** BT-Mesh callback structure. */
 178 typedef struct {
 179         /** set to sizeof(btmesh_callbacks_t) */
 180         size_t      size;
 181         btmesh_network_attached_callback  network_attached_cb;
 182         btmesh_network_destroyed_callback  network_destroyed_cb;
 183         btmesh_network_scan_status_callback  scan_status_cb;
 184         btmesh_network_scan_result_callback  scan_result_cb;
 185         btmesh_network_provisioning_status_callback  provisioning_status_cb;
 186         btmesh_network_provisioning_finished_callback  provisioning_finished_cb;
 187         btmesh_network_provisioning_data_requested_callback  provisioning_data_requested_cb;
 188         btmesh_network_authentication_requested_callback  authentication_requested_cb;
 189         btmesh_network_netkey_execute_callback  netkey_execute_cb;
 190         btmesh_network_appkey_execute_callback  appkey_execute_cb;
 191         btmesh_devkey_message_received_callback  devkey_msg_cb;
 192         btmesh_message_received_callback  msg_cb;
 193 } btmesh_callbacks_t;
 194
 195 /** Represents the standard BT-MESH interface. */
 196 typedef struct {
 197
 198         /** set to sizeof(btmesh_interface_t) */
 199         size_t          size;
 200         /**
 201          * Register the BT Mesh callbacks
 202          */
 203         bt_status_t (*init)(btmesh_callbacks_t* callbacks);
 204         bt_status_t (*create)(bt_hal_mesh_node_t *node,
 205                 GSList *model_list, bool is_prov);
 206         bt_status_t (*destroy)(bt_uuid_t *network);
 207         bt_status_t (*delete_node)(bt_uuid_t *network, uint16_t unicast,
 208                 uint16_t elem_cnt);
 209         bt_status_t (*scan)(bt_uuid_t *network,
 210                 bt_hal_mesh_scan_param_t *param);
 211         bt_status_t (*scan_cancel)(bt_uuid_t *network);
 212         bt_status_t (*capability)(bt_uuid_t *network,
 213                 bt_hal_mesh_prov_caps_t *param);
 214         bt_status_t (*provision)(bt_uuid_t *network, bt_uuid_t *dev_uuid);
 215         bt_status_t (*provision_data)(bt_uuid_t* network_uuid,
 216                 uint16_t netkey_idx, uint16_t unicast);
 217         bt_status_t (*auth_reply)(bt_hal_mesh_auth_variant_e auth_type,
 218                 const char *auth_value);
 219         bt_status_t (*subnet_execute)(bt_uuid_t* network_uuid,
 220                 bt_mesh_key_op_e op, uint16_t netkey_idx);
 221         bt_status_t (*appkey_execute)(bt_uuid_t* network_uuid,
 222                 bt_mesh_key_op_e op, uint16_t netkey_idx, uint16_t appkey_idx);
 223         bt_status_t (*config_send)(bt_uuid_t *network, uint16_t dest,
 224                 bool is_dev_key, uint16_t netkey_idx, uint8_t *buf, int len);
 225         bt_status_t (*key_send)(bt_uuid_t *network, uint16_t dest,
 226                 bool is_netkey, bool is_update, uint16_t key_idx, uint16_t netkey_idx);
 227         bt_status_t (*msg_execute)(bt_uuid_t *network, uint16_t dest,
 228                 uint16_t appkey_idx, uint8_t *buf, int len);
 229         bt_status_t (*attach)(void);
 230         /** Closes the interface. */
 231         void (*cleanup)(void);
 232 } btmesh_interface_t;
 233 __END_DECLS
 234
 235 #endif /* TIZEN_INCLUDE_BT_MESH_H */