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_MODEL_PUBLICATION_STATE_IDLE, 68 MESH_MODEL_PUBLICATION_STATE_W4_PUBLICATION_MS, 69 MESH_MODEL_PUBLICATION_STATE_PUBLICATION_READY, 70 MESH_MODEL_PUBLICATION_STATE_W4_RETRANSMIT_MS, 71 MESH_MODEL_PUBLICATION_STATE_RETRANSMIT_READY, 72 } mesh_model_publication_state_t; 73 74 typedef struct { 75 mesh_publish_state_t publish_state_fn; 76 mesh_model_publication_state_t state; 77 uint32_t next_publication_ms; 78 uint32_t next_retransmit_ms; 79 uint8_t retransmit_count; 80 81 uint16_t address; 82 uint16_t appkey_index; 83 uint8_t friendship_credential_flag; 84 uint8_t period; 85 uint8_t ttl; 86 uint8_t retransmit; 87 } mesh_publication_model_t; 88 89 typedef struct { 90 uint32_t opcode; 91 uint16_t minimum_length; 92 mesh_operation_handler handler; 93 } mesh_operation_t; 94 95 typedef struct mesh_model { 96 // linked list item 97 btstack_linked_item_t item; 98 99 // element 100 struct mesh_element * element; 101 102 // internal model enumeration 103 uint16_t mid; 104 105 // vendor_id << 16 | model id, use BLUETOOTH_COMPANY_ID_BLUETOOTH_SIG_INC for SIG models 106 uint32_t model_identifier; 107 108 // model operations 109 const mesh_operation_t * operations; 110 111 // publication model if supported 112 mesh_publication_model_t * publication_model; 113 114 // data 115 void * model_data; 116 117 // bound appkeys 118 uint16_t appkey_indices[MAX_NR_MESH_APPKEYS_PER_MODEL]; 119 120 // subscription list 121 uint16_t subscriptions[MAX_NR_MESH_SUBSCRIPTION_PER_MODEL]; 122 123 // packet handler for transition events in server, event callback handler in client 124 btstack_packet_handler_t model_packet_handler; 125 } mesh_model_t; 126 127 typedef struct { 128 btstack_linked_list_iterator_t it; 129 } mesh_model_iterator_t; 130 131 typedef struct mesh_element { 132 // linked list item 133 btstack_linked_item_t item; 134 135 // element index 136 uint16_t element_index; 137 138 // LOC 139 uint16_t loc; 140 141 // models 142 btstack_linked_list_t models; 143 uint16_t models_count_sig; 144 uint16_t models_count_vendor; 145 146 } mesh_element_t; 147 148 typedef struct { 149 btstack_linked_list_iterator_t it; 150 } mesh_element_iterator_t; 151 152 153 void mesh_node_init(void); 154 155 /** 156 * @brief Set unicast address of primary element 157 * @param unicast_address 158 */ 159 void mesh_node_primary_element_address_set(uint16_t unicast_address); 160 161 /** 162 * @brief Set location of primary element 163 * @note Returned by Configuration Server Composite Data 164 * @param location 165 */ 166 void mesh_node_set_primary_element_location(uint16_t location); 167 168 /** 169 * @brief Set location of element 170 * @param element 171 * @param location 172 */ 173 void mesh_node_set_element_location(mesh_element_t * element, uint16_t location); 174 175 /** 176 * @brief Get unicast address of primary element 177 */ 178 uint16_t mesh_node_get_primary_element_address(void); 179 180 /** 181 * @brief Get Primary Element of this node 182 */ 183 mesh_element_t * mesh_node_get_primary_element(void); 184 185 /** 186 * @brief Add secondary element 187 * @param element 188 */ 189 void mesh_node_add_element(mesh_element_t * element); 190 191 /** 192 * @brief Get number elements 193 * @returns number of elements on this node 194 */ 195 uint16_t mesh_node_element_count(void); 196 197 /** 198 * @brief Get element for given unicast address 199 * @param unicast_address 200 */ 201 mesh_element_t * mesh_node_element_for_unicast_address(uint16_t unicast_address); 202 203 /** 204 * @brief Get element by index 205 * @param element_index 206 */ 207 mesh_element_t * mesh_node_element_for_index(uint16_t element_index); 208 209 /** 210 * @brief Get element index for give model 211 * @param mesh_model 212 */ 213 uint8_t mesh_access_get_element_index(mesh_model_t * mesh_model); 214 215 /** 216 * @brief Get unicast address for give model 217 * @param mesh_model 218 */ 219 uint16_t mesh_access_get_element_address(mesh_model_t * mesh_model); 220 221 /** 222 * @brief Add model to element 223 * @param element 224 * @param mesh_model 225 */ 226 void mesh_element_add_model(mesh_element_t * element, mesh_model_t * mesh_model); 227 228 // Mesh Element Iterator 229 void mesh_element_iterator_init(mesh_element_iterator_t * iterator); 230 231 int mesh_element_iterator_has_next(mesh_element_iterator_t * iterator); 232 233 mesh_element_t * mesh_element_iterator_next(mesh_element_iterator_t * iterator); 234 235 // Mesh Model Iterator 236 237 void mesh_model_iterator_init(mesh_model_iterator_t * iterator, mesh_element_t * element); 238 239 int mesh_model_iterator_has_next(mesh_model_iterator_t * iterator); 240 241 mesh_model_t * mesh_model_iterator_next(mesh_model_iterator_t * iterator); 242 243 // Mesh Model Utility 244 245 mesh_model_t * mesh_model_get_by_identifier(mesh_element_t * element, uint32_t model_identifier); 246 247 uint32_t mesh_model_get_model_identifier_bluetooth_sig(uint16_t model_id); 248 249 int mesh_model_is_bluetooth_sig(uint32_t model_identifier); 250 251 uint16_t mesh_model_get_model_id(uint32_t model_identifier); 252 253 uint32_t mesh_model_get_model_identifier(uint16_t vendor_id, uint16_t model_id); 254 255 uint16_t mesh_model_get_vendor_id(uint32_t model_identifier); 256 257 mesh_model_t * mesh_model_get_configuration_server(void); 258 259 mesh_model_t * mesh_access_model_for_address_and_model_identifier(uint16_t element_address, uint32_t model_identifier, uint8_t * status); 260 261 void mesh_model_reset_appkeys(mesh_model_t * mesh_model); 262 263 // Mesh Model Subscriptions 264 int mesh_model_contains_subscription(mesh_model_t * mesh_model, uint16_t address); 265 266 /** 267 * @brief Set Device UUID 268 * @param device_uuid 269 */ 270 void mesh_node_set_device_uuid(const uint8_t * device_uuid); 271 272 /** 273 * @brief Get Device UUID 274 * @returns device_uuid if set, NULL otherwise 275 */ 276 const uint8_t * mesh_node_get_device_uuid(void); 277 278 #if defined __cplusplus 279 } 280 #endif 281 282 #endif //__MESH_NODE_H 283