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 #define BTSTACK_FILE__ "mesh_access.c" 39 40 #include <string.h> 41 #include <stdio.h> 42 #include <stdarg.h> 43 44 #include "mesh/mesh_access.h" 45 46 #include "btstack_debug.h" 47 #include "btstack_memory.h" 48 #include "btstack_tlv.h" 49 50 #include "mesh/beacon.h" 51 #include "mesh/mesh_foundation.h" 52 #include "mesh/mesh_iv_index_seq_number.h" 53 #include "mesh/mesh_node.h" 54 #include "mesh/mesh_proxy.h" 55 #include "mesh/mesh_upper_transport.h" 56 #include "mesh/mesh.h" 57 #include "mesh_upper_transport.h" 58 59 #define MEST_TRANSACTION_TIMEOUT_MS 6000 60 61 static void mesh_access_message_process_handler(mesh_pdu_t * pdu); 62 static void mesh_access_upper_transport_handler(mesh_transport_callback_type_t callback_type, mesh_transport_status_t status, mesh_pdu_t * pdu); 63 static const mesh_operation_t * mesh_model_lookup_operation_by_opcode(mesh_model_t * model, uint32_t opcode); 64 65 // receive 66 static uint16_t mesh_access_received_pdu_refcount; 67 68 // acknowledged messages 69 static btstack_linked_list_t mesh_access_acknowledged_messages; 70 static btstack_timer_source_t mesh_access_acknowledged_timer; 71 static int mesh_access_acknowledged_timer_active; 72 73 // Transitions 74 static uint8_t mesh_transaction_id_counter = 0; 75 76 void mesh_access_init(void){ 77 // register with upper transport 78 mesh_upper_transport_register_access_message_handler(&mesh_access_upper_transport_handler); 79 } 80 81 void mesh_access_emit_state_update_bool(btstack_packet_handler_t event_handler, uint8_t element_index, uint32_t model_identifier, 82 model_state_id_t state_identifier, model_state_update_reason_t reason, uint8_t value){ 83 if (event_handler == NULL) return; 84 uint8_t event[14] = {HCI_EVENT_MESH_META, 12, MESH_SUBEVENT_STATE_UPDATE_BOOL}; 85 int pos = 3; 86 event[pos++] = element_index; 87 little_endian_store_32(event, pos, model_identifier); 88 pos += 4; 89 little_endian_store_32(event, pos, (uint32_t)state_identifier); 90 pos += 4; 91 event[pos++] = (uint8_t)reason; 92 event[pos++] = value; 93 (*event_handler)(HCI_EVENT_PACKET, 0, event, sizeof(event)); 94 } 95 96 void mesh_access_emit_state_update_int16(btstack_packet_handler_t event_handler, uint8_t element_index, uint32_t model_identifier, 97 model_state_id_t state_identifier, model_state_update_reason_t reason, int16_t value){ 98 if (event_handler == NULL) return; 99 uint8_t event[15] = {HCI_EVENT_MESH_META, 13, MESH_SUBEVENT_STATE_UPDATE_BOOL}; 100 int pos = 3; 101 event[pos++] = element_index; 102 little_endian_store_32(event, pos, model_identifier); 103 pos += 4; 104 little_endian_store_32(event, pos, (uint32_t)state_identifier); 105 pos += 4; 106 event[pos++] = (uint8_t)reason; 107 little_endian_store_16(event, pos, (uint16_t) value); 108 pos += 2; 109 (*event_handler)(HCI_EVENT_PACKET, 0, event, sizeof(event)); 110 } 111 112 uint8_t mesh_access_acknowledged_message_retransmissions(void){ 113 return 3; 114 } 115 116 uint32_t mesh_access_acknowledged_message_timeout_ms(void){ 117 return 30000; 118 } 119 120 #define MESH_ACCESS_OPCODE_INVALID 0xFFFFFFFFu 121 #define MESH_ACCESS_OPCODE_NOT_SET 0xFFFFFFFEu 122 123 void mesh_access_send_unacknowledged_pdu(mesh_pdu_t * pdu){ 124 ((mesh_upper_transport_pdu_t *) pdu)->ack_opcode = MESH_ACCESS_OPCODE_INVALID; 125 mesh_upper_transport_send_access_pdu(pdu); 126 } 127 128 void mesh_access_send_acknowledged_pdu(mesh_pdu_t * pdu, uint8_t retransmissions, uint32_t ack_opcode){ 129 ((mesh_upper_transport_pdu_t *) pdu)->retransmit_count = retransmissions; 130 ((mesh_upper_transport_pdu_t *) pdu)->ack_opcode = ack_opcode; 131 132 mesh_upper_transport_send_access_pdu(pdu); 133 } 134 135 #define MESH_SUBEVENT_MESSAGE_NOT_ACKNOWLEDGED 0x30 136 137 static void mesh_access_acknowledged_run(btstack_timer_source_t * ts){ 138 UNUSED(ts); 139 140 uint32_t now = btstack_run_loop_get_time_ms(); 141 142 // handle timeouts 143 btstack_linked_list_iterator_t ack_it; 144 btstack_linked_list_iterator_init(&ack_it, &mesh_access_acknowledged_messages); 145 while (btstack_linked_list_iterator_has_next(&ack_it)){ 146 mesh_pdu_t * pdu = (mesh_pdu_t *) btstack_linked_list_iterator_next(&ack_it); 147 uint32_t retransmit_timeout_ms = ((mesh_upper_transport_pdu_t *) pdu)->retransmit_timeout_ms; 148 if (btstack_time_delta(now, retransmit_timeout_ms) >= 0) { 149 // remove from list 150 btstack_linked_list_remove(&mesh_access_acknowledged_messages, (btstack_linked_item_t*) pdu); 151 // retransmit or report failure 152 uint8_t retransmit_count = ((mesh_upper_transport_pdu_t *) pdu)->retransmit_count; 153 if (retransmit_count){ 154 ((mesh_upper_transport_pdu_t *) pdu)->retransmit_count = retransmit_count - 1; 155 mesh_upper_transport_send_access_pdu(pdu); 156 } else { 157 // find correct model and emit error 158 uint16_t src = mesh_pdu_src(pdu); 159 uint16_t dst = mesh_pdu_dst(pdu); 160 mesh_element_t * element = mesh_node_element_for_unicast_address(src); 161 if (element){ 162 // find 163 mesh_model_iterator_t model_it; 164 mesh_model_iterator_init(&model_it, element); 165 while (mesh_model_iterator_has_next(&model_it)){ 166 mesh_model_t * model = mesh_model_iterator_next(&model_it); 167 // find opcode in table 168 uint32_t ack_opcode = ((mesh_upper_transport_pdu_t *) pdu)->ack_opcode; 169 const mesh_operation_t * operation = mesh_model_lookup_operation_by_opcode(model, ack_opcode); 170 if (operation == NULL) continue; 171 if (model->model_packet_handler == NULL) continue; 172 // emit event 173 uint8_t event[13]; 174 event[0] = HCI_EVENT_MESH_META; 175 event[1] = sizeof(event) - 2; 176 event[2] = element->element_index; 177 little_endian_store_32(event, 3, model->model_identifier); 178 little_endian_store_32(event, 7, ack_opcode); 179 little_endian_store_16(event, 11, dst); 180 (*model->model_packet_handler)(HCI_EVENT_PACKET, 0, event, sizeof(event)); 181 } 182 } 183 184 // free 185 mesh_upper_transport_pdu_free(pdu); 186 } 187 } 188 } 189 190 if (mesh_access_acknowledged_timer_active) return; 191 192 // find earliest timeout and set timer 193 btstack_linked_list_iterator_init(&ack_it, &mesh_access_acknowledged_messages); 194 int32_t next_timeout_ms = 0; 195 while (btstack_linked_list_iterator_has_next(&ack_it)){ 196 mesh_pdu_t * pdu = (mesh_pdu_t *) btstack_linked_list_iterator_next(&ack_it); 197 uint32_t retransmit_timeout_ms = ((mesh_upper_transport_pdu_t *) pdu)->retransmit_timeout_ms; 198 int32_t timeout_delta_ms = btstack_time_delta(retransmit_timeout_ms, now); 199 if (next_timeout_ms == 0 || timeout_delta_ms < next_timeout_ms){ 200 next_timeout_ms = timeout_delta_ms; 201 } 202 } 203 204 // set timer 205 if (next_timeout_ms == 0) return; 206 207 btstack_run_loop_set_timer(&mesh_access_acknowledged_timer, next_timeout_ms); 208 btstack_run_loop_set_timer_handler(&mesh_access_acknowledged_timer, mesh_access_acknowledged_run); 209 btstack_run_loop_add_timer(&mesh_access_acknowledged_timer); 210 mesh_access_acknowledged_timer_active = 1; 211 } 212 213 static void mesh_access_acknowledged_received(uint16_t rx_src, uint32_t opcode){ 214 // check if received src matches our dest 215 // free acknowledged messages if we were waiting for this message 216 217 btstack_linked_list_iterator_t ack_it; 218 btstack_linked_list_iterator_init(&ack_it, &mesh_access_acknowledged_messages); 219 while (btstack_linked_list_iterator_has_next(&ack_it)){ 220 mesh_pdu_t * tx_pdu = (mesh_pdu_t *) btstack_linked_list_iterator_next(&ack_it); 221 uint16_t tx_dest = mesh_pdu_dst(tx_pdu); 222 if (tx_dest != rx_src) continue; 223 if (((mesh_upper_transport_pdu_t *) tx_pdu)->ack_opcode != opcode) continue; 224 // got expected response from dest, remove from outgoing messages 225 mesh_upper_transport_pdu_free(tx_pdu); 226 return; 227 } 228 } 229 230 static void mesh_access_upper_transport_handler(mesh_transport_callback_type_t callback_type, mesh_transport_status_t status, mesh_pdu_t * pdu){ 231 UNUSED(status); 232 switch (callback_type){ 233 case MESH_TRANSPORT_PDU_RECEIVED: 234 mesh_access_message_process_handler(pdu); 235 break; 236 case MESH_TRANSPORT_PDU_SENT: 237 // unacknowledged -> free 238 { 239 if (((mesh_upper_transport_pdu_t *) pdu)->ack_opcode == MESH_ACCESS_OPCODE_INVALID){ 240 mesh_upper_transport_pdu_free(pdu); 241 break; 242 } 243 } 244 // setup timeout 245 uint32_t retransmitTimeoutMs = 246 btstack_run_loop_get_time_ms() + mesh_access_acknowledged_message_timeout_ms(); 247 ((mesh_upper_transport_pdu_t *) pdu)->retransmit_timeout_ms = retransmitTimeoutMs; 248 // add to mesh_access_acknowledged_messages 249 btstack_linked_list_add(&mesh_access_acknowledged_messages, (btstack_linked_item_t *) pdu); 250 // update timer 251 mesh_access_acknowledged_run(NULL); 252 break; 253 default: 254 break; 255 } 256 } 257 258 // Mesh Model Transitions 259 260 uint32_t mesh_access_time_gdtt2ms(uint8_t time_gdtt){ 261 uint8_t num_steps = mesh_access_transitions_num_steps_from_gdtt(time_gdtt); 262 if (num_steps > 0x3E) return 0; 263 264 return mesh_access_transitions_step_ms_from_gdtt(time_gdtt) * num_steps; 265 } 266 267 uint8_t mesh_access_transitions_num_steps_from_gdtt(uint8_t time_gdtt){ 268 return time_gdtt & 0x3fu; 269 } 270 271 uint32_t mesh_access_transitions_step_ms_from_gdtt(uint8_t time_gdtt){ 272 mesh_default_transition_step_resolution_t step_resolution = (mesh_default_transition_step_resolution_t) (time_gdtt >> 6); 273 switch (step_resolution){ 274 case MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_100ms: 275 return 100; 276 case MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_1s: 277 return 1000; 278 case MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_10s: 279 return 10000; 280 case MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_10min: 281 return 600000; 282 default: 283 return 0; 284 } 285 } 286 287 uint8_t mesh_access_transactions_get_next_transaction_id(void){ 288 mesh_transaction_id_counter++; 289 if (mesh_transaction_id_counter == 0){ 290 mesh_transaction_id_counter = 1; 291 } 292 return mesh_transaction_id_counter; 293 } 294 295 static int mesh_access_transitions_transaction_is_expired(mesh_transition_t * transition){ 296 return (btstack_run_loop_get_time_ms() - transition->transaction_timestamp_ms) > MEST_TRANSACTION_TIMEOUT_MS; 297 } 298 299 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){ 300 if (transition->src_address != src_address || transition->dst_address != dst_address) return MESH_TRANSACTION_STATUS_DIFFERENT_DST_OR_SRC; 301 302 if (transition->transaction_identifier == transaction_identifier && !mesh_access_transitions_transaction_is_expired(transition)){ 303 return MESH_TRANSACTION_STATUS_RETRANSMISSION; 304 } 305 return MESH_TRANSACTION_STATUS_NEW; 306 } 307 308 void mesh_access_transitions_init_transaction(mesh_transition_t * transition, uint8_t transaction_identifier, uint16_t src_address, uint16_t dst_address){ 309 transition->transaction_timestamp_ms = btstack_run_loop_get_time_ms(); 310 transition->transaction_identifier = transaction_identifier; 311 transition->src_address = src_address; 312 transition->dst_address = dst_address; 313 } 314 315 static void mesh_server_transition_timeout(btstack_timer_source_t * ts){ 316 mesh_transition_t * base_transition = (mesh_transition_t*) btstack_run_loop_get_timer_context(ts); 317 switch (base_transition->state){ 318 case MESH_TRANSITION_STATE_DELAYED: 319 base_transition->state = MESH_TRANSITION_STATE_ACTIVE; 320 (*base_transition->transition_callback)(base_transition, MODEL_STATE_UPDATE_REASON_TRANSITION_START); 321 if (base_transition->num_steps > 0){ 322 btstack_run_loop_set_timer(&base_transition->timer, base_transition->step_duration_ms); 323 btstack_run_loop_add_timer(&base_transition->timer); 324 return; 325 } 326 base_transition->state = MESH_TRANSITION_STATE_IDLE; 327 (*base_transition->transition_callback)(base_transition, MODEL_STATE_UPDATE_REASON_TRANSITION_END); 328 break; 329 case MESH_TRANSITION_STATE_ACTIVE: 330 if (base_transition->num_steps < MESH_TRANSITION_NUM_STEPS_INFINITE){ 331 base_transition->num_steps--; 332 } 333 (*base_transition->transition_callback)(base_transition, MODEL_STATE_UPDATE_REASON_TRANSITION_ACTIVE); 334 if (base_transition->num_steps > 0){ 335 btstack_run_loop_set_timer(&base_transition->timer, base_transition->step_duration_ms); 336 btstack_run_loop_add_timer(&base_transition->timer); 337 return; 338 } 339 base_transition->state = MESH_TRANSITION_STATE_IDLE; 340 (*base_transition->transition_callback)(base_transition, MODEL_STATE_UPDATE_REASON_TRANSITION_END); 341 break; 342 default: 343 break; 344 } 345 } 346 347 void mesh_access_transition_setup(mesh_model_t *mesh_model, mesh_transition_t * base_transition, uint8_t transition_time_gdtt, uint8_t delay_time_gdtt, void (*transition_callback)(mesh_transition_t * base_transition, model_state_update_reason_t event)){ 348 349 base_transition->mesh_model = mesh_model; 350 base_transition->num_steps = mesh_access_transitions_num_steps_from_gdtt(transition_time_gdtt); 351 base_transition->step_resolution = (mesh_default_transition_step_resolution_t) (transition_time_gdtt >> 6); 352 base_transition->step_duration_ms = mesh_access_transitions_step_ms_from_gdtt(transition_time_gdtt); 353 base_transition->transition_callback = transition_callback; 354 355 btstack_run_loop_set_timer_context(&base_transition->timer, base_transition); 356 btstack_run_loop_set_timer_handler(&base_transition->timer, &mesh_server_transition_timeout); 357 358 // delayed 359 if (delay_time_gdtt > 0){ 360 base_transition->state = MESH_TRANSITION_STATE_DELAYED; 361 btstack_run_loop_set_timer(&base_transition->timer, delay_time_gdtt * 5); 362 btstack_run_loop_add_timer(&base_transition->timer); 363 return; 364 } 365 366 // started 367 if (base_transition->num_steps > 0){ 368 base_transition->state = MESH_TRANSITION_STATE_ACTIVE; 369 btstack_run_loop_set_timer(&base_transition->timer, base_transition->step_duration_ms); 370 btstack_run_loop_add_timer(&base_transition->timer); 371 return; 372 } 373 374 // instanteneous update 375 base_transition->state = MESH_TRANSITION_STATE_IDLE; 376 (*transition_callback)(base_transition, MODEL_STATE_UPDATE_REASON_SET); 377 return; 378 } 379 380 void mesh_access_transitions_abort_transaction(mesh_transition_t * base_transition){ 381 btstack_run_loop_add_timer(&base_transition->timer); 382 } 383 384 static uint16_t mesh_access_src(mesh_access_pdu_t * access_pdu){ 385 return access_pdu->src; 386 } 387 388 uint16_t mesh_pdu_ctl(mesh_pdu_t * pdu){ 389 switch (pdu->pdu_type){ 390 case MESH_PDU_TYPE_NETWORK: 391 return mesh_network_control((mesh_network_pdu_t *) pdu); 392 default: 393 btstack_assert(false); 394 return 0; 395 } 396 } 397 398 uint16_t mesh_pdu_ttl(mesh_pdu_t * pdu){ 399 switch (pdu->pdu_type){ 400 case MESH_PDU_TYPE_NETWORK: 401 return mesh_network_ttl((mesh_network_pdu_t *) pdu); 402 default: 403 btstack_assert(false); 404 return 0; 405 } 406 } 407 408 uint16_t mesh_pdu_src(mesh_pdu_t * pdu){ 409 switch (pdu->pdu_type){ 410 case MESH_PDU_TYPE_ACCESS: 411 return mesh_access_src((mesh_access_pdu_t *) pdu); 412 case MESH_PDU_TYPE_NETWORK: 413 return mesh_network_src((mesh_network_pdu_t *) pdu); 414 default: 415 btstack_assert(false); 416 return MESH_ADDRESS_UNSASSIGNED; 417 } 418 } 419 420 uint16_t mesh_pdu_dst(mesh_pdu_t * pdu){ 421 switch (pdu->pdu_type){ 422 case MESH_PDU_TYPE_ACCESS: { 423 return ((mesh_access_pdu_t *) pdu)->dst; 424 } 425 case MESH_PDU_TYPE_NETWORK: 426 return mesh_network_dst((mesh_network_pdu_t *) pdu); 427 default: 428 btstack_assert(false); 429 return MESH_ADDRESS_UNSASSIGNED; 430 } 431 } 432 433 uint16_t mesh_pdu_netkey_index(mesh_pdu_t * pdu){ 434 switch (pdu->pdu_type){ 435 case MESH_PDU_TYPE_ACCESS: 436 return ((mesh_access_pdu_t*) pdu)->netkey_index; 437 case MESH_PDU_TYPE_NETWORK: 438 return ((mesh_network_pdu_t *) pdu)->netkey_index; 439 default: 440 btstack_assert(false); 441 return 0; 442 } 443 } 444 445 uint16_t mesh_pdu_appkey_index(mesh_pdu_t * pdu){ 446 switch (pdu->pdu_type){ 447 case MESH_PDU_TYPE_ACCESS: 448 return ((mesh_access_pdu_t*) pdu)->appkey_index; 449 default: 450 btstack_assert(false); 451 return 0; 452 } 453 } 454 455 uint16_t mesh_pdu_len(mesh_pdu_t * pdu){ 456 switch (pdu->pdu_type){ 457 case MESH_PDU_TYPE_ACCESS: 458 return ((mesh_access_pdu_t*) pdu)->len; 459 case MESH_PDU_TYPE_NETWORK: 460 return ((mesh_network_pdu_t *) pdu)->len - 10; 461 default: 462 btstack_assert(false); 463 return 0; 464 } 465 } 466 467 uint8_t * mesh_pdu_data(mesh_pdu_t * pdu){ 468 switch (pdu->pdu_type){ 469 case MESH_PDU_TYPE_ACCESS: 470 return ((mesh_access_pdu_t*) pdu)->data; 471 case MESH_PDU_TYPE_NETWORK: 472 return &((mesh_network_pdu_t *) pdu)->data[10]; 473 default: 474 btstack_assert(false); 475 return NULL; 476 } 477 } 478 479 uint8_t mesh_pdu_control_opcode(mesh_pdu_t * pdu){ 480 switch (pdu->pdu_type){ 481 case MESH_PDU_TYPE_NETWORK: 482 return mesh_network_control_opcode((mesh_network_pdu_t *) pdu); 483 default: 484 btstack_assert(false); 485 return 0xff; 486 } 487 } 488 489 // message parser 490 491 static int mesh_access_get_opcode(uint8_t * buffer, uint16_t buffer_size, uint32_t * opcode, uint16_t * opcode_size){ 492 switch (buffer[0] >> 6){ 493 case 0: 494 case 1: 495 if (buffer[0] == 0x7f) return 0; 496 *opcode = buffer[0]; 497 *opcode_size = 1; 498 return 1; 499 case 2: 500 if (buffer_size < 2) return 0; 501 *opcode = big_endian_read_16(buffer, 0); 502 *opcode_size = 2; 503 return 1; 504 case 3: 505 if (buffer_size < 3) return 0; 506 *opcode = (buffer[0] << 16) | little_endian_read_16(buffer, 1); 507 *opcode_size = 3; 508 return 1; 509 default: 510 return 0; 511 } 512 } 513 514 int mesh_access_pdu_get_opcode(mesh_pdu_t * pdu, uint32_t * opcode, uint16_t * opcode_size){ 515 btstack_assert(pdu->pdu_type == MESH_PDU_TYPE_ACCESS); 516 return mesh_access_get_opcode(((mesh_access_pdu_t *) pdu)->data, ((mesh_access_pdu_t *) pdu)->len, opcode, 517 opcode_size); 518 } 519 520 void mesh_access_parser_skip(mesh_access_parser_state_t * state, uint16_t bytes_to_skip){ 521 state->data += bytes_to_skip; 522 state->len -= bytes_to_skip; 523 } 524 525 int mesh_access_parser_init(mesh_access_parser_state_t * state, mesh_pdu_t * pdu){ 526 btstack_assert(pdu->pdu_type == MESH_PDU_TYPE_ACCESS); 527 state->data = mesh_pdu_data(pdu); 528 state->len = mesh_pdu_len(pdu); 529 530 uint16_t opcode_size = 0; 531 int ok = mesh_access_get_opcode(state->data, state->len, &state->opcode, &opcode_size); 532 if (ok){ 533 mesh_access_parser_skip(state, opcode_size); 534 } 535 return ok; 536 } 537 538 uint16_t mesh_access_parser_available(mesh_access_parser_state_t * state){ 539 return state->len; 540 } 541 542 uint8_t mesh_access_parser_get_uint8(mesh_access_parser_state_t * state){ 543 uint8_t value = *state->data; 544 mesh_access_parser_skip(state, 1); 545 return value; 546 } 547 548 uint16_t mesh_access_parser_get_uint16(mesh_access_parser_state_t * state){ 549 uint16_t value = little_endian_read_16(state->data, 0); 550 mesh_access_parser_skip(state, 2); 551 return value; 552 } 553 554 uint32_t mesh_access_parser_get_uint24(mesh_access_parser_state_t * state){ 555 uint32_t value = little_endian_read_24(state->data, 0); 556 mesh_access_parser_skip(state, 3); 557 return value; 558 } 559 560 uint32_t mesh_access_parser_get_uint32(mesh_access_parser_state_t * state){ 561 uint32_t value = little_endian_read_32(state->data, 0); 562 mesh_access_parser_skip(state, 4); 563 return value; 564 } 565 566 void mesh_access_parser_get_uint128(mesh_access_parser_state_t * state, uint8_t * dest){ 567 reverse_128( state->data, dest); 568 mesh_access_parser_skip(state, 16); 569 } 570 571 void mesh_access_parser_get_label_uuid(mesh_access_parser_state_t * state, uint8_t * dest){ 572 (void)memcpy(dest, state->data, 16); 573 mesh_access_parser_skip(state, 16); 574 } 575 576 void mesh_access_parser_get_key(mesh_access_parser_state_t * state, uint8_t * dest){ 577 (void)memcpy(dest, state->data, 16); 578 mesh_access_parser_skip(state, 16); 579 } 580 581 uint32_t mesh_access_parser_get_model_identifier(mesh_access_parser_state_t * parser){ 582 uint16_t vendor_id = BLUETOOTH_COMPANY_ID_BLUETOOTH_SIG_INC; 583 if (mesh_access_parser_available(parser) == 4){ 584 vendor_id = mesh_access_parser_get_uint16(parser); 585 } 586 uint16_t model_id = mesh_access_parser_get_uint16(parser); 587 return mesh_model_get_model_identifier(vendor_id, model_id); 588 } 589 590 uint32_t mesh_access_parser_get_sig_model_identifier(mesh_access_parser_state_t * parser){ 591 uint16_t model_id = mesh_access_parser_get_uint16(parser); 592 return mesh_model_get_model_identifier(BLUETOOTH_COMPANY_ID_BLUETOOTH_SIG_INC, model_id); 593 } 594 595 uint32_t mesh_access_parser_get_vendor_model_identifier(mesh_access_parser_state_t * parser){ 596 uint16_t vendor_id = mesh_access_parser_get_uint16(parser); 597 uint16_t model_id = mesh_access_parser_get_uint16(parser); 598 return mesh_model_get_model_identifier(vendor_id, model_id); 599 } 600 601 // Mesh Access Message Builder 602 603 // message builder 604 605 static int mesh_access_setup_opcode(uint8_t * buffer, uint32_t opcode){ 606 if (opcode < 0x100){ 607 buffer[0] = opcode; 608 return 1; 609 } 610 if (opcode < 0x10000){ 611 big_endian_store_16(buffer, 0, opcode); 612 return 2; 613 } 614 buffer[0] = opcode >> 16; 615 little_endian_store_16(buffer, 1, opcode & 0xffff); 616 return 3; 617 } 618 619 // mesh_message_t builder 620 void mesh_access_message_add_data(mesh_upper_transport_pdu_t * pdu, const uint8_t * data, uint16_t data_len){ 621 mesh_upper_transport_message_add_data(pdu, data, data_len); 622 } 623 624 mesh_upper_transport_pdu_t * mesh_access_message_init(uint32_t opcode) { 625 mesh_upper_transport_pdu_t * pdu = mesh_upper_transport_message_init(MESH_PDU_TYPE_UPPER_UNSEGMENTED_ACCESS); 626 if (!pdu) return NULL; 627 628 // add opcode 629 uint8_t opcode_buffer[3]; 630 uint8_t opcode_len = mesh_access_setup_opcode(opcode_buffer, opcode); 631 mesh_access_message_add_data(pdu, opcode_buffer, opcode_len); 632 return pdu; 633 } 634 635 void mesh_access_message_add_uint8(mesh_upper_transport_pdu_t * pdu, uint8_t value){ 636 mesh_upper_transport_message_add_uint8(pdu, value); 637 } 638 639 void mesh_access_message_add_uint16(mesh_upper_transport_pdu_t * pdu, uint16_t value){ 640 mesh_upper_transport_message_add_uint16(pdu, value); 641 } 642 643 void mesh_access_message_add_uint24(mesh_upper_transport_pdu_t * pdu, uint16_t value){ 644 mesh_upper_transport_message_add_uint24(pdu, value); 645 } 646 647 void mesh_access_message_add_uint32(mesh_upper_transport_pdu_t * pdu, uint16_t value){ 648 mesh_upper_transport_message_add_uint32(pdu, value); 649 } 650 651 void mesh_access_message_add_model_identifier(mesh_upper_transport_pdu_t * pdu, uint32_t model_identifier){ 652 if (mesh_model_is_bluetooth_sig(model_identifier)){ 653 return mesh_access_message_add_uint16( pdu, mesh_model_get_model_id(model_identifier) ); 654 } else { 655 return mesh_access_message_add_uint32( pdu, model_identifier ); 656 } 657 } 658 659 bool mesh_access_message_finalize(mesh_upper_transport_pdu_t * pdu){ 660 // upgrade to segmented if needed 661 if (pdu->pdu_header.pdu_type == MESH_PDU_TYPE_UPPER_UNSEGMENTED_ACCESS) { 662 if ((pdu->transmic_len == 8 ) || (pdu->len > 11)){ 663 pdu->pdu_header.pdu_type = MESH_PDU_TYPE_UPPER_SEGMENTED_ACCESS; 664 } 665 } 666 667 return mesh_upper_transport_message_finalize(pdu); 668 } 669 670 // access message template 671 mesh_upper_transport_pdu_t * mesh_access_setup_message(const mesh_access_message_t *message_template, ...){ 672 673 mesh_upper_transport_pdu_t * upper_pdu = mesh_access_message_init(message_template->opcode); 674 if (!upper_pdu) return NULL; 675 676 va_list argptr; 677 va_start(argptr, message_template); 678 679 // add params 680 const char * format = message_template->format; 681 uint16_t word; 682 uint32_t longword; 683 while (*format){ 684 switch (*format){ 685 case '1': 686 word = va_arg(argptr, int); // minimal va_arg is int: 2 bytes on 8+16 bit CPUs 687 mesh_access_message_add_uint8(upper_pdu, word); 688 break; 689 case '2': 690 word = va_arg(argptr, int); // minimal va_arg is int: 2 bytes on 8+16 bit CPUs 691 mesh_access_message_add_uint16(upper_pdu, word); 692 break; 693 case '3': 694 longword = va_arg(argptr, uint32_t); 695 mesh_access_message_add_uint24(upper_pdu, longword); 696 break; 697 case '4': 698 longword = va_arg(argptr, uint32_t); 699 mesh_access_message_add_uint32(upper_pdu, longword); 700 break; 701 case 'm': 702 longword = va_arg(argptr, uint32_t); 703 mesh_access_message_add_model_identifier(upper_pdu, longword); 704 break; 705 default: 706 btstack_assert(false); 707 break; 708 } 709 format++; 710 } 711 712 va_end(argptr); 713 714 bool ok = mesh_access_message_finalize(upper_pdu); 715 716 if (!ok){ 717 // memory alloc failed 718 mesh_upper_transport_pdu_free((mesh_pdu_t *) upper_pdu); 719 upper_pdu = NULL; 720 } 721 722 return upper_pdu; 723 } 724 725 static const mesh_operation_t * mesh_model_lookup_operation_by_opcode(mesh_model_t * model, uint32_t opcode){ 726 // find opcode in table 727 const mesh_operation_t * operation = model->operations; 728 if (operation == NULL) return NULL; 729 for ( ; operation->handler != NULL ; operation++){ 730 if (operation->opcode != opcode) continue; 731 return operation; 732 } 733 return NULL; 734 } 735 736 static const mesh_operation_t * mesh_model_lookup_operation(mesh_model_t * model, mesh_pdu_t * pdu){ 737 738 uint32_t opcode = 0; 739 uint16_t opcode_size = 0; 740 int ok = mesh_access_pdu_get_opcode( pdu, &opcode, &opcode_size); 741 if (!ok) return NULL; 742 743 uint16_t len = mesh_pdu_len(pdu); 744 745 // find opcode in table 746 const mesh_operation_t * operation = model->operations; 747 if (operation == NULL) return NULL; 748 for ( ; operation->handler != NULL ; operation++){ 749 if (operation->opcode != opcode) continue; 750 if ((opcode_size + operation->minimum_length) > len) continue; 751 return operation; 752 } 753 return NULL; 754 } 755 756 static int mesh_access_validate_appkey_index(mesh_model_t * model, uint16_t appkey_index){ 757 // DeviceKey is valid for all models 758 if (appkey_index == MESH_DEVICE_KEY_INDEX) return 1; 759 // check if AppKey that is bound to this particular model 760 return mesh_model_contains_appkey(model, appkey_index); 761 } 762 763 // decrease use count and report as free if done 764 void mesh_access_message_processed(mesh_pdu_t * pdu){ 765 if (mesh_access_received_pdu_refcount > 0){ 766 mesh_access_received_pdu_refcount--; 767 } 768 if (mesh_access_received_pdu_refcount == 0){ 769 mesh_upper_transport_message_processed_by_higher_layer(pdu); 770 } 771 } 772 773 static void mesh_access_message_process_handler(mesh_pdu_t * pdu){ 774 775 // init use count 776 mesh_access_received_pdu_refcount = 1; 777 778 // get opcode and size 779 uint32_t opcode = 0; 780 uint16_t opcode_size = 0; 781 782 int ok = mesh_access_pdu_get_opcode( pdu, &opcode, &opcode_size); 783 if (!ok) { 784 mesh_access_message_processed(pdu); 785 return; 786 } 787 788 uint16_t len = mesh_pdu_len(pdu); 789 printf("MESH Access Message, Opcode = %x: ", opcode); 790 printf_hexdump(mesh_pdu_data(pdu), len); 791 792 uint16_t src = mesh_pdu_src(pdu); 793 uint16_t dst = mesh_pdu_dst(pdu); 794 uint16_t appkey_index = mesh_pdu_appkey_index(pdu); 795 if (mesh_network_address_unicast(dst)){ 796 // loookup element by unicast address 797 mesh_element_t * element = mesh_node_element_for_unicast_address(dst); 798 if (element != NULL){ 799 // iterate over models, look for operation 800 mesh_model_iterator_t model_it; 801 mesh_model_iterator_init(&model_it, element); 802 while (mesh_model_iterator_has_next(&model_it)){ 803 mesh_model_t * model = mesh_model_iterator_next(&model_it); 804 // find opcode in table 805 const mesh_operation_t * operation = mesh_model_lookup_operation(model, pdu); 806 if (operation == NULL) continue; 807 if (mesh_access_validate_appkey_index(model, appkey_index) == 0) continue; 808 mesh_access_acknowledged_received(src, opcode); 809 mesh_access_received_pdu_refcount++; 810 operation->handler(model, pdu); 811 } 812 } 813 } 814 else if (mesh_network_address_group(dst)){ 815 816 // handle fixed group address 817 if (dst >= 0xff00){ 818 int deliver_to_primary_element = 1; 819 switch (dst){ 820 case MESH_ADDRESS_ALL_PROXIES: 821 if (mesh_foundation_gatt_proxy_get() == 1){ 822 deliver_to_primary_element = 1; 823 } 824 break; 825 case MESH_ADDRESS_ALL_FRIENDS: 826 // TODO: not implemented 827 break; 828 case MESH_ADDRESS_ALL_RELAYS: 829 if (mesh_foundation_relay_get() == 1){ 830 deliver_to_primary_element = 1; 831 } 832 break; 833 case MESH_ADDRESS_ALL_NODES: 834 deliver_to_primary_element = 1; 835 break; 836 default: 837 break; 838 } 839 if (deliver_to_primary_element){ 840 mesh_model_iterator_t model_it; 841 mesh_model_iterator_init(&model_it, mesh_node_get_primary_element()); 842 while (mesh_model_iterator_has_next(&model_it)){ 843 mesh_model_t * model = mesh_model_iterator_next(&model_it); 844 // find opcode in table 845 const mesh_operation_t * operation = mesh_model_lookup_operation(model, pdu); 846 if (operation == NULL) continue; 847 if (mesh_access_validate_appkey_index(model, appkey_index) == 0) continue; 848 mesh_access_acknowledged_received(src, opcode); 849 mesh_access_received_pdu_refcount++; 850 operation->handler(model, pdu); 851 } 852 } 853 } 854 else { 855 // iterate over all elements / models, check subscription list 856 mesh_element_iterator_t it; 857 mesh_element_iterator_init(&it); 858 while (mesh_element_iterator_has_next(&it)){ 859 mesh_element_t * element = (mesh_element_t *) mesh_element_iterator_next(&it); 860 mesh_model_iterator_t model_it; 861 mesh_model_iterator_init(&model_it, element); 862 while (mesh_model_iterator_has_next(&model_it)){ 863 mesh_model_t * model = mesh_model_iterator_next(&model_it); 864 if (mesh_model_contains_subscription(model, dst)){ 865 // find opcode in table 866 const mesh_operation_t * operation = mesh_model_lookup_operation(model, pdu); 867 if (operation == NULL) continue; 868 if (mesh_access_validate_appkey_index(model, appkey_index) == 0) continue; 869 mesh_access_acknowledged_received(src, opcode); 870 mesh_access_received_pdu_refcount++; 871 operation->handler(model, pdu); 872 } 873 } 874 } 875 } 876 } 877 878 // we're done 879 mesh_access_message_processed(pdu); 880 } 881 882 // Mesh Model Publication 883 static btstack_timer_source_t mesh_access_publication_timer; 884 885 static uint32_t mesh_model_publication_retransmit_count(uint8_t retransmit){ 886 return retransmit & 0x07u; 887 } 888 889 static uint32_t mesh_model_publication_retransmission_period_ms(uint8_t retransmit){ 890 return ((uint32_t)((retransmit >> 3) + 1)) * 50; 891 } 892 893 static void mesh_model_publication_setup_publication(mesh_publication_model_t * publication_model, uint32_t now){ 894 895 // set retransmit counter 896 publication_model->retransmit_count = mesh_model_publication_retransmit_count(publication_model->retransmit); 897 898 // schedule next publication or retransmission 899 uint32_t publication_period_ms = mesh_access_time_gdtt2ms(publication_model->period) >> publication_model->period_divisor; 900 901 // set next publication 902 if (publication_period_ms != 0){ 903 publication_model->next_publication_ms = now + publication_period_ms; 904 publication_model->state = MESH_MODEL_PUBLICATION_STATE_W4_PUBLICATION_MS; 905 } else { 906 publication_model->state = MESH_MODEL_PUBLICATION_STATE_IDLE; 907 } 908 } 909 910 // assumes retransmit_count is valid 911 static void mesh_model_publication_setup_retransmission(mesh_publication_model_t * publication_model, uint32_t now){ 912 uint32_t publication_period_ms = mesh_access_time_gdtt2ms(publication_model->period) >> publication_model->period_divisor; 913 914 // retransmission done 915 if (publication_model->retransmit_count == 0) { 916 // wait for next main event if periodic and retransmission complete 917 if (publication_period_ms != 0){ 918 publication_model->state = MESH_MODEL_PUBLICATION_STATE_W4_PUBLICATION_MS; 919 } else { 920 publication_model->state = MESH_MODEL_PUBLICATION_STATE_IDLE; 921 } 922 return; 923 } 924 925 // calc next retransmit time 926 uint32_t retransmission_period_ms = mesh_model_publication_retransmission_period_ms(publication_model->retransmit) >> publication_model->period_divisor; 927 uint32_t retransmission_ms = now + retransmission_period_ms; 928 929 // check next publication timeout is before next retransmission 930 if (publication_period_ms != 0){ 931 if (btstack_time_delta(retransmission_ms, publication_model->next_publication_ms) > 0) return; 932 } 933 934 // schedule next retransmission 935 publication_model->next_retransmit_ms = retransmission_ms; 936 publication_model->state = MESH_MODEL_PUBLICATION_STATE_W4_RETRANSMIT_MS; 937 } 938 939 static void mesh_model_publication_publish_now_model(mesh_model_t * mesh_model){ 940 mesh_publication_model_t * publication_model = mesh_model->publication_model; 941 if (publication_model == NULL) return; 942 if (publication_model->publish_state_fn == NULL) return; 943 uint16_t dest = publication_model->address; 944 if (dest == MESH_ADDRESS_UNSASSIGNED) return; 945 uint16_t appkey_index = publication_model->appkey_index; 946 mesh_transport_key_t * app_key = mesh_transport_key_get(appkey_index); 947 if (app_key == NULL) return; 948 949 // compose message 950 mesh_pdu_t * pdu = (*publication_model->publish_state_fn)(mesh_model); 951 if (pdu == NULL) return; 952 953 // handle ttl = default 954 uint8_t ttl = publication_model->ttl; 955 if (ttl == 0xff){ 956 ttl = mesh_foundation_default_ttl_get(); 957 } 958 959 mesh_upper_transport_setup_access_pdu_header(pdu, app_key->netkey_index, appkey_index, ttl, mesh_access_get_element_address(mesh_model), dest, 0); 960 mesh_access_send_unacknowledged_pdu(pdu); 961 } 962 963 static void mesh_model_publication_run(btstack_timer_source_t * ts){ 964 965 uint32_t now = btstack_run_loop_get_time_ms(); 966 967 // iterate over elements and models and handle time-based transitions 968 mesh_element_iterator_t element_it; 969 mesh_element_iterator_init(&element_it); 970 while (mesh_element_iterator_has_next(&element_it)){ 971 mesh_element_t * element = mesh_element_iterator_next(&element_it); 972 mesh_model_iterator_t model_it; 973 mesh_model_iterator_init(&model_it, element); 974 while (mesh_model_iterator_has_next(&model_it)){ 975 mesh_model_t * mesh_model = mesh_model_iterator_next(&model_it); 976 mesh_publication_model_t * publication_model = mesh_model->publication_model; 977 if (publication_model == NULL) continue; 978 979 // check if either timer fired 980 switch (publication_model->state){ 981 case MESH_MODEL_PUBLICATION_STATE_W4_PUBLICATION_MS: 982 if (btstack_time_delta(publication_model->next_publication_ms, now) > 0) break; 983 publication_model->state = MESH_MODEL_PUBLICATION_STATE_PUBLICATION_READY; 984 break; 985 case MESH_MODEL_PUBLICATION_STATE_W4_RETRANSMIT_MS: 986 if (btstack_time_delta(publication_model->next_retransmit_ms, now) > 0) break; 987 publication_model->state = MESH_MODEL_PUBLICATION_STATE_RETRANSMIT_READY; 988 break; 989 default: 990 break; 991 } 992 993 switch (publication_model->state){ 994 case MESH_MODEL_PUBLICATION_STATE_PUBLICATION_READY: 995 // schedule next publication and retransmission 996 mesh_model_publication_setup_publication(publication_model, now); 997 mesh_model_publication_setup_retransmission(publication_model, now); 998 mesh_model_publication_publish_now_model(mesh_model); 999 break; 1000 case MESH_MODEL_PUBLICATION_STATE_RETRANSMIT_READY: 1001 // schedule next retransmission 1002 publication_model->retransmit_count--; 1003 mesh_model_publication_setup_retransmission(publication_model, now); 1004 mesh_model_publication_publish_now_model(mesh_model); 1005 break; 1006 default: 1007 break; 1008 } 1009 } 1010 } 1011 1012 int32_t next_timeout_ms = 0; 1013 mesh_element_iterator_init(&element_it); 1014 while (mesh_element_iterator_has_next(&element_it)){ 1015 mesh_element_t * element = mesh_element_iterator_next(&element_it); 1016 mesh_model_iterator_t model_it; 1017 mesh_model_iterator_init(&model_it, element); 1018 while (mesh_model_iterator_has_next(&model_it)){ 1019 mesh_model_t * mesh_model = mesh_model_iterator_next(&model_it); 1020 mesh_publication_model_t * publication_model = mesh_model->publication_model; 1021 if (publication_model == NULL) continue; 1022 1023 // schedule next 1024 int32_t timeout_delta_ms; 1025 switch (publication_model->state){ 1026 case MESH_MODEL_PUBLICATION_STATE_W4_PUBLICATION_MS: 1027 timeout_delta_ms = btstack_time_delta(publication_model->next_publication_ms, now); 1028 if (next_timeout_ms == 0 || timeout_delta_ms < next_timeout_ms){ 1029 next_timeout_ms = timeout_delta_ms; 1030 } 1031 break; 1032 case MESH_MODEL_PUBLICATION_STATE_W4_RETRANSMIT_MS: 1033 timeout_delta_ms = btstack_time_delta(publication_model->next_retransmit_ms, now); 1034 if (next_timeout_ms == 0 || timeout_delta_ms < next_timeout_ms){ 1035 next_timeout_ms = timeout_delta_ms; 1036 } 1037 break; 1038 default: 1039 break; 1040 } 1041 } 1042 } 1043 1044 // remove current timer if active 1045 if (ts == NULL){ 1046 btstack_run_loop_remove_timer(&mesh_access_publication_timer); 1047 1048 } 1049 1050 // new timeout? 1051 if (next_timeout_ms == 0) return; 1052 1053 // set timer 1054 btstack_run_loop_set_timer(&mesh_access_publication_timer, next_timeout_ms); 1055 btstack_run_loop_set_timer_handler(&mesh_access_publication_timer, mesh_model_publication_run); 1056 btstack_run_loop_add_timer(&mesh_access_publication_timer); 1057 } 1058 1059 void mesh_model_publication_start(mesh_model_t * mesh_model){ 1060 mesh_publication_model_t * publication_model = mesh_model->publication_model; 1061 if (publication_model == NULL) return; 1062 1063 // publish right away 1064 publication_model->state = MESH_MODEL_PUBLICATION_STATE_PUBLICATION_READY; 1065 mesh_model_publication_run(NULL); 1066 } 1067 1068 void mesh_model_publication_stop(mesh_model_t * mesh_model){ 1069 mesh_publication_model_t * publication_model = mesh_model->publication_model; 1070 if (publication_model == NULL) return; 1071 1072 // reset state 1073 publication_model->state = MESH_MODEL_PUBLICATION_STATE_IDLE; 1074 } 1075 1076 void mesh_access_state_changed(mesh_model_t * mesh_model){ 1077 mesh_publication_model_t * publication_model = mesh_model->publication_model; 1078 if (publication_model == NULL) return; 1079 publication_model->state = MESH_MODEL_PUBLICATION_STATE_PUBLICATION_READY; 1080 mesh_model_publication_run(NULL); 1081 } 1082 1083