1 /* 2 * Copyright (C) 2018 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_ACCESS_H 39 #define __MESH_ACCESS_H 40 41 #include <stdint.h> 42 #include <stdarg.h> 43 44 #include "bluetooth_company_id.h" 45 #include "btstack_linked_list.h" 46 47 #include "mesh/mesh_lower_transport.h" 48 #include "mesh/mesh_keys.h" 49 #include "mesh/mesh_node.h" 50 51 #ifdef __cplusplus 52 extern "C" 53 { 54 #endif 55 56 #define MAX_NR_MESH_APPKEYS_PER_MODEL 3u 57 #define MAX_NR_MESH_SUBSCRIPTION_PER_MODEL 3u 58 59 #define MESH_APPKEY_INVALID 0xffffu 60 61 #define MESH_SEQUENCE_NUMBER_STORAGE_INTERVAL 1000 62 63 struct mesh_model; 64 struct mesh_element; 65 66 // function to handle model operation message 67 typedef void (*mesh_operation_handler)(struct mesh_model * mesh_model, mesh_pdu_t * pdu); 68 69 // function to publish the current state of a model 70 // @param mesh_model to publish 71 // @returns mesh_pdu with status message 72 typedef mesh_pdu_t * (*mesh_publish_state_t)(struct mesh_model * mesh_model); 73 74 typedef enum { 75 MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_100ms = 0x00u, 76 MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_1s, 77 MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_10s, 78 MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_10min 79 } mesh_default_transition_step_resolution_t; 80 81 typedef enum { 82 MODEL_STATE_UPDATE_REASON_SET = 0x00u, 83 MODEL_STATE_UPDATE_REASON_TRANSITION_START, 84 // MODEL_STATE_UPDATE_REASON_TRANSITION_ACTIVE, 85 MODEL_STATE_UPDATE_REASON_TRANSITION_END, 86 MODEL_STATE_UPDATE_REASON_TRANSITION_ABORT, 87 // MODEL_STATE_UPDATE_REASON_BOUND_STATE, 88 MODEL_STATE_UPDATE_REASON_APPLICATION_CHANGE 89 } model_state_update_reason_t; 90 91 typedef enum { 92 TRANSITION_START, 93 TRANSITION_UPDATE 94 } transition_event_t; 95 96 typedef enum { 97 MESH_TRANSITION_STATE_IDLE, 98 MESH_TRANSITION_STATE_DELAYED, 99 MESH_TRANSITION_STATE_ACTIVE 100 } mesh_transition_state_t; 101 102 typedef enum { 103 MODEL_STATE_ID_GENERIC_ON_OFF = (BLUETOOTH_COMPANY_ID_BLUETOOTH_SIG_INC << 16) | 0u, 104 MODEL_STATE_ID_GENERIC_LEVEL = (BLUETOOTH_COMPANY_ID_BLUETOOTH_SIG_INC << 16) | 1u, 105 } model_state_id_t; 106 107 typedef enum { 108 MESH_MODEL_PUBLICATION_STATE_IDLE, 109 MESH_MODEL_PUBLICATION_STATE_W4_PUBLICATION_MS, 110 MESH_MODEL_PUBLICATION_STATE_W4_RETRANSMIT_MS, 111 } mesh_model_publication_state_t; 112 113 typedef struct { 114 mesh_publish_state_t publish_state_fn; 115 mesh_model_publication_state_t state; 116 uint32_t next_publication_ms; 117 uint32_t next_retransmit_ms; 118 uint8_t retransmit_count; 119 uint8_t publish_now; 120 121 uint16_t address; 122 uint16_t appkey_index; 123 uint8_t friendship_credential_flag; 124 uint8_t period; 125 uint8_t ttl; 126 uint8_t retransmit; 127 } mesh_publication_model_t; 128 129 130 typedef struct { 131 uint32_t opcode; 132 uint16_t minimum_length; 133 mesh_operation_handler handler; 134 } mesh_operation_t; 135 136 typedef struct mesh_model { 137 // linked list item 138 btstack_linked_item_t item; 139 140 // element 141 struct mesh_element * element; 142 143 // internal model enumeration 144 uint16_t mid; 145 146 // vendor_id << 16 | model id, use BLUETOOTH_COMPANY_ID_BLUETOOTH_SIG_INC for SIG models 147 uint32_t model_identifier; 148 149 // model operations 150 const mesh_operation_t * operations; 151 152 // publication model if supported 153 mesh_publication_model_t * publication_model; 154 155 // data 156 void * model_data; 157 158 // bound appkeys 159 uint16_t appkey_indices[MAX_NR_MESH_APPKEYS_PER_MODEL]; 160 161 // subscription list 162 uint16_t subscriptions[MAX_NR_MESH_SUBSCRIPTION_PER_MODEL]; 163 164 // packet handler for transition events in server, event callback handler in client 165 btstack_packet_handler_t model_packet_handler; 166 } mesh_model_t; 167 168 typedef struct { 169 btstack_linked_list_iterator_t it; 170 } mesh_model_iterator_t; 171 172 #define MESH_MAX_NUM_FAULTS 3 173 174 typedef struct { 175 // linked list item 176 btstack_linked_item_t item; 177 uint8_t test_id; 178 uint16_t company_id; 179 uint16_t num_faults; 180 uint8_t faults[MESH_MAX_NUM_FAULTS]; 181 } mesh_fault_t; 182 183 typedef struct { 184 uint32_t opcode; 185 uint8_t * data; 186 uint16_t len; 187 } mesh_access_parser_state_t; 188 189 typedef struct { 190 uint32_t opcode; 191 const char * format; 192 } mesh_access_message_t; 193 194 typedef enum { 195 MESH_TRANSACTION_STATUS_NEW = 0, 196 MESH_TRANSACTION_STATUS_RETRANSMISSION, 197 MESH_TRANSACTION_STATUS_DIFFERENT_DST_OR_SRC 198 } mesh_transaction_status_t; 199 200 typedef struct mesh_transition { 201 btstack_linked_item_t item; 202 203 mesh_transition_state_t state; 204 205 uint8_t transaction_identifier; 206 uint32_t transaction_timestamp_ms; 207 uint16_t src_address; 208 uint16_t dst_address; 209 210 mesh_default_transition_step_resolution_t step_duration_ms; 211 uint32_t phase_start_ms; 212 uint32_t remaining_delay_time_ms; 213 uint32_t remaining_transition_time_ms; 214 // to send events and/or publish changes 215 mesh_model_t * mesh_model; 216 217 // to execute transition 218 void (* transition_callback)(struct mesh_transition * transition, transition_event_t event, uint32_t current_timestamp); 219 } mesh_transition_t; 220 221 /** 222 * @brief Init access layer 223 */ 224 void mesh_access_init(void); 225 226 /** 227 * @brief Inform access layer that access message was processed by higher layer 228 * @param pdu 229 */ 230 void mesh_access_message_processed(mesh_pdu_t * pdu); 231 232 /** 233 * @brief Get number of retransmissions used by default 234 */ 235 uint8_t mesh_access_acknowledged_message_retransmissions(void); 236 237 /** 238 * @brief Get retransmission timeout 239 */ 240 uint32_t mesh_access_acknowledged_message_timeout_ms(void); 241 242 /** 243 * @brief Send unacknowledged message 244 * @param pdu 245 */ 246 void mesh_access_send_unacknowledged_pdu(mesh_pdu_t * pdu); 247 248 /** 249 * @brief Send acknowledged message. Retransmits message if no acknowledgement with expected opcode is received 250 * @param pdu 251 * @param retransmissions 252 * @param ack_opcode opcode of acknowledgement 253 */ 254 void mesh_access_send_acknowledged_pdu(mesh_pdu_t * pdu, uint8_t retransmissions, uint32_t ack_opcode); 255 256 /** 257 * @brief Get element index for give model 258 * @param mesh_model 259 */ 260 uint8_t mesh_access_get_element_index(mesh_model_t * mesh_model); 261 262 /** 263 * @brief Get unicast address for give model 264 * @param mesh_model 265 */ 266 uint16_t mesh_access_get_element_address(mesh_model_t * mesh_model); 267 268 /** 269 * @brief Add model to element 270 * @param element 271 * @param mesh_model 272 */ 273 void mesh_element_add_model(mesh_element_t * element, mesh_model_t * mesh_model); 274 275 // Mesh Model Iterator 276 277 void mesh_model_iterator_init(mesh_model_iterator_t * iterator, mesh_element_t * element); 278 279 int mesh_model_iterator_has_next(mesh_model_iterator_t * iterator); 280 281 mesh_model_t * mesh_model_iterator_next(mesh_model_iterator_t * iterator); 282 283 // Mesh Model Utility 284 285 mesh_model_t * mesh_model_get_by_identifier(mesh_element_t * element, uint32_t model_identifier); 286 287 uint32_t mesh_model_get_model_identifier_bluetooth_sig(uint16_t model_id); 288 289 int mesh_model_is_bluetooth_sig(uint32_t model_identifier); 290 291 uint16_t mesh_model_get_model_id(uint32_t model_identifier); 292 293 uint32_t mesh_model_get_model_identifier(uint16_t vendor_id, uint16_t model_id); 294 295 uint16_t mesh_model_get_vendor_id(uint32_t model_identifier); 296 297 mesh_model_t * mesh_model_get_configuration_server(void); 298 299 mesh_model_t * mesh_access_model_for_address_and_model_identifier(uint16_t element_address, uint32_t model_identifier, uint8_t * status); 300 301 uint8_t mesh_access_transitions_num_steps_from_gdtt(uint8_t time_gdtt); 302 uint32_t mesh_access_time_gdtt2ms(uint8_t time_gdtt); 303 304 void mesh_access_emit_state_update_bool(btstack_packet_handler_t event_handler, uint8_t element_index, uint32_t model_identifier, 305 model_state_id_t state_identifier, model_state_update_reason_t reason, uint8_t value); 306 void mesh_access_emit_state_update_int16(btstack_packet_handler_t event_handler, uint8_t element_index, uint32_t model_identifier, 307 model_state_id_t state_identifier, model_state_update_reason_t reason, int16_t value); 308 309 // Mesh Model Transitions 310 void mesh_access_transitions_setup_transaction(mesh_transition_t * transition, uint8_t transaction_identifier, uint16_t src_address, uint16_t dst_address); 311 void mesh_access_transitions_abort_transaction(mesh_transition_t * transition); 312 mesh_transaction_status_t mesh_access_transitions_transaction_status(mesh_transition_t * transition, uint8_t transaction_identifier, uint16_t src_address, uint16_t dst_address); 313 314 void mesh_access_transitions_setup(mesh_transition_t * transition, mesh_model_t * mesh_model, 315 uint8_t transition_time_gdtt, uint8_t delay_gdtt, 316 void (* transition_callback)(struct mesh_transition * transition, transition_event_t event, uint32_t current_timestamp)); 317 318 void mesh_access_transitions_add(mesh_transition_t * transition); 319 void mesh_access_transitions_remove(mesh_transition_t * transition); 320 uint8_t mesh_access_transactions_get_next_transaction_id(void); 321 322 // Key Refresh 323 void mesh_access_key_refresh_revoke_keys(mesh_subnet_t * subnet); 324 325 // Mesh Model Publicaation 326 327 /** 328 * Inform Mesh Access that the state of a model has changed. may trigger state publication 329 * @param mesh_model 330 */ 331 void mesh_access_state_changed(mesh_model_t * mesh_model); 332 333 /** 334 * Start Model Publication 335 * @param mesh_model 336 */ 337 void mesh_model_publication_start(mesh_model_t * mesh_model); 338 339 /** 340 * Stop Model Publication 341 * @param mesh_model 342 */ 343 void mesh_model_publication_stop(mesh_model_t * mesh_model); 344 345 // Mesh PDU Getter 346 uint16_t mesh_pdu_src(mesh_pdu_t * pdu); 347 uint16_t mesh_pdu_dst(mesh_pdu_t * pdu); 348 uint16_t mesh_pdu_netkey_index(mesh_pdu_t * pdu); 349 uint16_t mesh_pdu_appkey_index(mesh_pdu_t * pdu); 350 uint16_t mesh_pdu_len(mesh_pdu_t * pdu); 351 uint8_t * mesh_pdu_data(mesh_pdu_t * pdu); 352 353 void mesh_access_netkey_finalize(mesh_network_key_t * network_key); 354 void mesh_access_appkey_finalize(mesh_transport_key_t * transport_key); 355 356 // Mesh Model Subscriptions 357 int mesh_model_contains_subscription(mesh_model_t * mesh_model, uint16_t address); 358 359 // Mesh IV Index and sequence number 360 void mesh_store_iv_index_after_provisioning(uint32_t iv_index); 361 void mesh_store_iv_index_and_sequence_number(void); 362 int mesh_load_iv_index_and_sequence_number(uint32_t * iv_index, uint32_t * sequence_number); 363 364 // Mesh Access Parser 365 int mesh_access_pdu_get_opcode(mesh_pdu_t * pdu, uint32_t * opcode, uint16_t * opcode_size); 366 int mesh_access_parser_init(mesh_access_parser_state_t * state, mesh_pdu_t * pdu); 367 void mesh_access_parser_skip(mesh_access_parser_state_t * state, uint16_t bytes_to_skip); 368 uint16_t mesh_access_parser_available(mesh_access_parser_state_t * state); 369 uint8_t mesh_access_parser_get_u8(mesh_access_parser_state_t * state); 370 uint16_t mesh_access_parser_get_u16(mesh_access_parser_state_t * state); 371 uint32_t mesh_access_parser_get_u24(mesh_access_parser_state_t * state); 372 uint32_t mesh_access_parser_get_u32(mesh_access_parser_state_t * state); 373 void mesh_access_parser_get_u128(mesh_access_parser_state_t * state, uint8_t * dest); 374 void mesh_access_parser_get_label_uuid(mesh_access_parser_state_t * state, uint8_t * dest); 375 void mesh_access_parser_get_key(mesh_access_parser_state_t * state, uint8_t * dest); 376 uint32_t mesh_access_parser_get_model_identifier(mesh_access_parser_state_t * parser); 377 378 // message builder transport 379 mesh_transport_pdu_t * mesh_access_transport_init(uint32_t opcode); 380 void mesh_access_transport_add_uint8(mesh_transport_pdu_t * pdu, uint8_t value); 381 void mesh_access_transport_add_uint16(mesh_transport_pdu_t * pdu, uint16_t value); 382 void mesh_access_transport_add_uint24(mesh_transport_pdu_t * pdu, uint32_t value); 383 void mesh_access_transport_add_uint32(mesh_transport_pdu_t * pdu, uint32_t value); 384 void mesh_access_transport_add_model_identifier(mesh_transport_pdu_t * pdu, uint32_t model_identifier); 385 386 // message builder network 387 mesh_network_pdu_t * mesh_access_network_init(uint32_t opcode); 388 void mesh_access_network_add_uint8(mesh_network_pdu_t * pdu, uint8_t value); 389 void mesh_access_network_add_uint16(mesh_network_pdu_t * pdu, uint16_t value); 390 void mesh_access_network_add_uint24(mesh_network_pdu_t * pdu, uint16_t value); 391 void mesh_access_network_add_uint32(mesh_network_pdu_t * pdu, uint16_t value); 392 void mesh_access_network_add_model_identifier(mesh_network_pdu_t * pdu, uint32_t model_identifier); 393 394 // message builder using template 395 mesh_network_pdu_t * mesh_access_setup_unsegmented_message(const mesh_access_message_t *template, ...); 396 mesh_transport_pdu_t * mesh_access_setup_segmented_message(const mesh_access_message_t *template, ...); 397 398 #ifdef __cplusplus 399 } /* end of extern "C" */ 400 #endif 401 402 #endif 403