1 /* 2 * Copyright (C) 2019 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 24 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 #ifndef __MESH_NODE_H 39 #define __MESH_NODE_H 40 41 #include <stdint.h> 42 43 #include "btstack_linked_list.h" 44 #include "mesh/mesh_network.h" 45 46 #if defined __cplusplus 47 extern "C" { 48 #endif 49 50 #define MESH_APPKEY_INVALID 0xffffu 51 52 #define MAX_NR_MESH_APPKEYS_PER_MODEL 3u 53 #define MAX_NR_MESH_SUBSCRIPTION_PER_MODEL 3u 54 55 struct mesh_model; 56 struct mesh_element; 57 58 // function to handle model operation message 59 typedef void (*mesh_operation_handler)(struct mesh_model * mesh_model, mesh_pdu_t * pdu); 60 61 // function to publish the current state of a model 62 // @param mesh_model to publish 63 // @returns mesh_pdu with status message 64 typedef mesh_pdu_t * (*mesh_publish_state_t)(struct mesh_model * mesh_model); 65 66 typedef enum { 67 MESH_NODE_IDENTITY_STATE_ADVERTISING_STOPPED = 0, 68 MESH_NODE_IDENTITY_STATE_ADVERTISING_RUNNING, 69 MESH_NODE_IDENTITY_STATE_ADVERTISING_NOT_SUPPORTED 70 } mesh_node_identity_state_t; 71 72 typedef enum { 73 MESH_MODEL_PUBLICATION_STATE_IDLE, 74 MESH_MODEL_PUBLICATION_STATE_W4_PUBLICATION_MS, 75 MESH_MODEL_PUBLICATION_STATE_PUBLICATION_READY, 76 MESH_MODEL_PUBLICATION_STATE_W4_RETRANSMIT_MS, 77 MESH_MODEL_PUBLICATION_STATE_RETRANSMIT_READY, 78 } mesh_model_publication_state_t; 79 80 typedef struct { 81 mesh_publish_state_t publish_state_fn; 82 mesh_model_publication_state_t state; 83 uint32_t next_publication_ms; 84 uint32_t next_retransmit_ms; 85 uint8_t retransmit_count; 86 87 uint16_t address; 88 uint16_t appkey_index; 89 uint8_t friendship_credential_flag; 90 uint8_t period; 91 uint8_t period_divisor; // divide period by 2 ^ period_divisor, default = 2^0 = 1, added for Health Server 92 uint8_t ttl; 93 uint8_t retransmit; 94 } mesh_publication_model_t; 95 96 typedef struct { 97 uint32_t opcode; 98 uint16_t minimum_length; 99 mesh_operation_handler handler; 100 } mesh_operation_t; 101 102 typedef struct mesh_model { 103 // linked list item 104 btstack_linked_item_t item; 105 106 // element 107 struct mesh_element * element; 108 109 // internal model enumeration 110 uint16_t mid; 111 112 // vendor_id << 16 | model id, use BLUETOOTH_COMPANY_ID_BLUETOOTH_SIG_INC for SIG models 113 uint32_t model_identifier; 114 115 // model operations 116 const mesh_operation_t * operations; 117 118 // publication model if supported 119 mesh_publication_model_t * publication_model; 120 121 // data 122 void * model_data; 123 124 // bound appkeys 125 uint16_t appkey_indices[MAX_NR_MESH_APPKEYS_PER_MODEL]; 126 127 // subscription list 128 uint16_t subscriptions[MAX_NR_MESH_SUBSCRIPTION_PER_MODEL]; 129 130 // packet handler for transition events in server, event callback handler in client 131 btstack_packet_handler_t model_packet_handler; 132 } mesh_model_t; 133 134 typedef struct { 135 btstack_linked_list_iterator_t it; 136 } mesh_model_iterator_t; 137 138 typedef struct mesh_element { 139 // linked list item 140 btstack_linked_item_t item; 141 142 // element index 143 uint16_t element_index; 144 145 // LOC 146 uint16_t loc; 147 148 // models 149 btstack_linked_list_t models; 150 uint16_t models_count_sig; 151 uint16_t models_count_vendor; 152 153 } mesh_element_t; 154 155 typedef struct { 156 btstack_linked_list_iterator_t it; 157 } mesh_element_iterator_t; 158 159 160 void mesh_node_init(void); 161 162 /** 163 * @brief Set unicast address of primary element 164 * @param unicast_address 165 */ 166 void mesh_node_primary_element_address_set(uint16_t unicast_address); 167 168 /** 169 * @brief Set location of primary element 170 * @note Returned by Configuration Server Composite Data 171 * @param location 172 */ 173 void mesh_node_set_primary_element_location(uint16_t location); 174 175 /** 176 * @brief Set location of element 177 * @param element 178 * @param location 179 */ 180 void mesh_node_set_element_location(mesh_element_t * element, uint16_t location); 181 182 /** 183 * @brief Get unicast address of primary element 184 */ 185 uint16_t mesh_node_get_primary_element_address(void); 186 187 /** 188 * @brief Get Primary Element of this node 189 */ 190 mesh_element_t * mesh_node_get_primary_element(void); 191 192 /** 193 * @brief Add secondary element 194 * @param element 195 */ 196 void mesh_node_add_element(mesh_element_t * element); 197 198 /** 199 * @brief Get number elements 200 * @returns number of elements on this node 201 */ 202 uint16_t mesh_node_element_count(void); 203 204 /** 205 * @brief Get element for given unicast address 206 * @param unicast_address 207 */ 208 mesh_element_t * mesh_node_element_for_unicast_address(uint16_t unicast_address); 209 210 /** 211 * @brief Get element by index 212 * @param element_index 213 */ 214 mesh_element_t * mesh_node_element_for_index(uint16_t element_index); 215 216 /** 217 * @brief Get element index for give model 218 * @param mesh_model 219 */ 220 uint8_t mesh_access_get_element_index(mesh_model_t * mesh_model); 221 222 /** 223 * @brief Get unicast address for give model 224 * @param mesh_model 225 */ 226 uint16_t mesh_access_get_element_address(mesh_model_t * mesh_model); 227 228 /** 229 * @brief Add model to element 230 * @param element 231 * @param mesh_model 232 */ 233 void mesh_element_add_model(mesh_element_t * element, mesh_model_t * mesh_model); 234 235 // Mesh Element Iterator 236 void mesh_element_iterator_init(mesh_element_iterator_t * iterator); 237 238 int mesh_element_iterator_has_next(mesh_element_iterator_t * iterator); 239 240 mesh_element_t * mesh_element_iterator_next(mesh_element_iterator_t * iterator); 241 242 // Mesh Model Iterator 243 244 void mesh_model_iterator_init(mesh_model_iterator_t * iterator, mesh_element_t * element); 245 246 int mesh_model_iterator_has_next(mesh_model_iterator_t * iterator); 247 248 mesh_model_t * mesh_model_iterator_next(mesh_model_iterator_t * iterator); 249 250 // Mesh Model Utility 251 252 mesh_model_t * mesh_model_get_by_identifier(mesh_element_t * element, uint32_t model_identifier); 253 254 uint32_t mesh_model_get_model_identifier_bluetooth_sig(uint16_t model_id); 255 256 int mesh_model_is_bluetooth_sig(uint32_t model_identifier); 257 258 uint16_t mesh_model_get_model_id(uint32_t model_identifier); 259 260 uint32_t mesh_model_get_model_identifier(uint16_t vendor_id, uint16_t model_id); 261 262 uint16_t mesh_model_get_vendor_id(uint32_t model_identifier); 263 264 mesh_model_t * mesh_node_get_configuration_server(void); 265 266 mesh_model_t * mesh_node_get_health_server(void); 267 268 mesh_model_t * mesh_access_model_for_address_and_model_identifier(uint16_t element_address, uint32_t model_identifier, uint8_t * status); 269 270 void mesh_model_reset_appkeys(mesh_model_t * mesh_model); 271 272 // Mesh Model Subscriptions 273 int mesh_model_contains_subscription(mesh_model_t * mesh_model, uint16_t address); 274 275 /** 276 * @brief Set Device UUID 277 * @param device_uuid 278 */ 279 void mesh_node_set_device_uuid(const uint8_t * device_uuid); 280 281 /** 282 * @brief Get Device UUID 283 * @returns device_uuid if set, NULL otherwise 284 */ 285 const uint8_t * mesh_node_get_device_uuid(void); 286 287 /** 288 * @brief Set node info reported in Composition Data Page 0 289 * @param company_id (cid) 290 * @param product_id (pid) 291 * @param product_version_id (vid) 292 */ 293 void mesh_node_set_info(uint16_t company_id, uint16_t product_id, uint16_t product_version_id); 294 295 /** 296 * @brief Get node info: company_id 297 * @returns company_id 298 */ 299 uint16_t mesh_node_get_company_id(void); 300 301 /** 302 * @brief Get node info: product_id 303 * @returns product_id 304 */ 305 uint16_t mesh_node_get_product_id(void); 306 307 /** 308 * @brief Get node info: product_version_id 309 * @returns product_version_id 310 */ 311 uint16_t mesh_node_get_product_version_id(void); 312 313 #if defined __cplusplus 314 } 315 #endif 316 317 #endif //__MESH_NODE_H 318