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 621 void mesh_access_message_init(mesh_upper_transport_builder_t * builder, uint32_t opcode) { 622 mesh_upper_transport_message_init(builder, MESH_PDU_TYPE_UPPER_UNSEGMENTED_ACCESS); 623 624 // add opcode 625 uint8_t opcode_buffer[3]; 626 uint8_t opcode_len = mesh_access_setup_opcode(opcode_buffer, opcode); 627 mesh_access_message_add_data(builder, opcode_buffer, opcode_len); 628 } 629 630 void mesh_access_message_add_data(mesh_upper_transport_builder_t * pdu, const uint8_t * data, uint16_t data_len){ 631 mesh_upper_transport_message_add_data(pdu, data, data_len); 632 } 633 634 void mesh_access_message_add_uint8(mesh_upper_transport_builder_t * builder, uint8_t value){ 635 mesh_upper_transport_message_add_uint8(builder, value); 636 } 637 638 void mesh_access_message_add_uint16(mesh_upper_transport_builder_t * builder, uint16_t value){ 639 mesh_upper_transport_message_add_uint16(builder, value); 640 } 641 642 void mesh_access_message_add_uint24(mesh_upper_transport_builder_t * builder, uint16_t value){ 643 mesh_upper_transport_message_add_uint24(builder, value); 644 } 645 646 void mesh_access_message_add_uint32(mesh_upper_transport_builder_t * builder, uint16_t value){ 647 mesh_upper_transport_message_add_uint32(builder, value); 648 } 649 650 void mesh_access_message_add_model_identifier(mesh_upper_transport_builder_t * builder, uint32_t model_identifier){ 651 if (mesh_model_is_bluetooth_sig(model_identifier)){ 652 return mesh_access_message_add_uint16(builder, mesh_model_get_model_id(model_identifier) ); 653 } else { 654 return mesh_access_message_add_uint32(builder, model_identifier ); 655 } 656 } 657 658 mesh_upper_transport_pdu_t * mesh_access_message_finalize(mesh_upper_transport_builder_t * builder){ 659 mesh_upper_transport_pdu_t * upper_pdu = mesh_upper_transport_message_finalize(builder); 660 if (upper_pdu == NULL) return NULL; 661 662 // upgrade to segmented if needed 663 if (upper_pdu->pdu_header.pdu_type == MESH_PDU_TYPE_UPPER_UNSEGMENTED_ACCESS) { 664 if (((upper_pdu->flags & MESH_TRANSPORT_FLAG_TRANSMIC_64) != 0) || (upper_pdu->len > 11)){ 665 upper_pdu->pdu_header.pdu_type = MESH_PDU_TYPE_UPPER_SEGMENTED_ACCESS; 666 } 667 } 668 return upper_pdu; 669 } 670 671 // access message template 672 mesh_upper_transport_pdu_t * mesh_access_setup_message(const mesh_access_message_t *message_template, ...){ 673 674 mesh_upper_transport_builder_t builder; 675 mesh_access_message_init(&builder, message_template->opcode); 676 677 va_list argptr; 678 va_start(argptr, message_template); 679 680 // add params 681 const char * format = message_template->format; 682 uint16_t word; 683 uint32_t longword; 684 while (*format){ 685 switch (*format){ 686 case '1': 687 word = va_arg(argptr, int); // minimal va_arg is int: 2 bytes on 8+16 bit CPUs 688 mesh_access_message_add_uint8(&builder, word); 689 break; 690 case '2': 691 word = va_arg(argptr, int); // minimal va_arg is int: 2 bytes on 8+16 bit CPUs 692 mesh_access_message_add_uint16(&builder, word); 693 break; 694 case '3': 695 longword = va_arg(argptr, uint32_t); 696 mesh_access_message_add_uint24(&builder, longword); 697 break; 698 case '4': 699 longword = va_arg(argptr, uint32_t); 700 mesh_access_message_add_uint32(&builder, longword); 701 break; 702 case 'm': 703 longword = va_arg(argptr, uint32_t); 704 mesh_access_message_add_model_identifier(&builder, longword); 705 break; 706 default: 707 btstack_assert(false); 708 break; 709 } 710 format++; 711 } 712 713 va_end(argptr); 714 715 return mesh_access_message_finalize(&builder); 716 } 717 718 static const mesh_operation_t * mesh_model_lookup_operation_by_opcode(mesh_model_t * model, uint32_t opcode){ 719 // find opcode in table 720 const mesh_operation_t * operation = model->operations; 721 if (operation == NULL) return NULL; 722 for ( ; operation->handler != NULL ; operation++){ 723 if (operation->opcode != opcode) continue; 724 return operation; 725 } 726 return NULL; 727 } 728 729 static const mesh_operation_t * mesh_model_lookup_operation(mesh_model_t * model, mesh_pdu_t * pdu){ 730 731 uint32_t opcode = 0; 732 uint16_t opcode_size = 0; 733 int ok = mesh_access_pdu_get_opcode( pdu, &opcode, &opcode_size); 734 if (!ok) return NULL; 735 736 uint16_t len = mesh_pdu_len(pdu); 737 738 // find opcode in table 739 const mesh_operation_t * operation = model->operations; 740 if (operation == NULL) return NULL; 741 for ( ; operation->handler != NULL ; operation++){ 742 if (operation->opcode != opcode) continue; 743 if ((opcode_size + operation->minimum_length) > len) continue; 744 return operation; 745 } 746 return NULL; 747 } 748 749 static int mesh_access_validate_appkey_index(mesh_model_t * model, uint16_t appkey_index){ 750 // DeviceKey is valid for all models 751 if (appkey_index == MESH_DEVICE_KEY_INDEX) return 1; 752 // check if AppKey that is bound to this particular model 753 return mesh_model_contains_appkey(model, appkey_index); 754 } 755 756 // decrease use count and report as free if done 757 void mesh_access_message_processed(mesh_pdu_t * pdu){ 758 if (mesh_access_received_pdu_refcount > 0){ 759 mesh_access_received_pdu_refcount--; 760 } 761 if (mesh_access_received_pdu_refcount == 0){ 762 mesh_upper_transport_message_processed_by_higher_layer(pdu); 763 } 764 } 765 766 static void mesh_access_message_process_handler(mesh_pdu_t * pdu){ 767 768 // init use count 769 mesh_access_received_pdu_refcount = 1; 770 771 // get opcode and size 772 uint32_t opcode = 0; 773 uint16_t opcode_size = 0; 774 775 int ok = mesh_access_pdu_get_opcode( pdu, &opcode, &opcode_size); 776 if (!ok) { 777 mesh_access_message_processed(pdu); 778 return; 779 } 780 781 uint16_t len = mesh_pdu_len(pdu); 782 printf("MESH Access Message, Opcode = %x: ", opcode); 783 printf_hexdump(mesh_pdu_data(pdu), len); 784 785 uint16_t src = mesh_pdu_src(pdu); 786 uint16_t dst = mesh_pdu_dst(pdu); 787 uint16_t appkey_index = mesh_pdu_appkey_index(pdu); 788 if (mesh_network_address_unicast(dst)){ 789 // loookup element by unicast address 790 mesh_element_t * element = mesh_node_element_for_unicast_address(dst); 791 if (element != NULL){ 792 // iterate over models, look for operation 793 mesh_model_iterator_t model_it; 794 mesh_model_iterator_init(&model_it, element); 795 while (mesh_model_iterator_has_next(&model_it)){ 796 mesh_model_t * model = mesh_model_iterator_next(&model_it); 797 // find opcode in table 798 const mesh_operation_t * operation = mesh_model_lookup_operation(model, pdu); 799 if (operation == NULL) continue; 800 if (mesh_access_validate_appkey_index(model, appkey_index) == 0) continue; 801 mesh_access_acknowledged_received(src, opcode); 802 mesh_access_received_pdu_refcount++; 803 operation->handler(model, pdu); 804 } 805 } 806 } 807 else if (mesh_network_address_group(dst)){ 808 809 // handle fixed group address 810 if (dst >= 0xff00){ 811 int deliver_to_primary_element = 1; 812 switch (dst){ 813 case MESH_ADDRESS_ALL_PROXIES: 814 if (mesh_foundation_gatt_proxy_get() == 1){ 815 deliver_to_primary_element = 1; 816 } 817 break; 818 case MESH_ADDRESS_ALL_FRIENDS: 819 // TODO: not implemented 820 break; 821 case MESH_ADDRESS_ALL_RELAYS: 822 if (mesh_foundation_relay_get() == 1){ 823 deliver_to_primary_element = 1; 824 } 825 break; 826 case MESH_ADDRESS_ALL_NODES: 827 deliver_to_primary_element = 1; 828 break; 829 default: 830 break; 831 } 832 if (deliver_to_primary_element){ 833 mesh_model_iterator_t model_it; 834 mesh_model_iterator_init(&model_it, mesh_node_get_primary_element()); 835 while (mesh_model_iterator_has_next(&model_it)){ 836 mesh_model_t * model = mesh_model_iterator_next(&model_it); 837 // find opcode in table 838 const mesh_operation_t * operation = mesh_model_lookup_operation(model, pdu); 839 if (operation == NULL) continue; 840 if (mesh_access_validate_appkey_index(model, appkey_index) == 0) continue; 841 mesh_access_acknowledged_received(src, opcode); 842 mesh_access_received_pdu_refcount++; 843 operation->handler(model, pdu); 844 } 845 } 846 } 847 else { 848 // iterate over all elements / models, check subscription list 849 mesh_element_iterator_t it; 850 mesh_element_iterator_init(&it); 851 while (mesh_element_iterator_has_next(&it)){ 852 mesh_element_t * element = (mesh_element_t *) mesh_element_iterator_next(&it); 853 mesh_model_iterator_t model_it; 854 mesh_model_iterator_init(&model_it, element); 855 while (mesh_model_iterator_has_next(&model_it)){ 856 mesh_model_t * model = mesh_model_iterator_next(&model_it); 857 if (mesh_model_contains_subscription(model, dst)){ 858 // find opcode in table 859 const mesh_operation_t * operation = mesh_model_lookup_operation(model, pdu); 860 if (operation == NULL) continue; 861 if (mesh_access_validate_appkey_index(model, appkey_index) == 0) continue; 862 mesh_access_acknowledged_received(src, opcode); 863 mesh_access_received_pdu_refcount++; 864 operation->handler(model, pdu); 865 } 866 } 867 } 868 } 869 } 870 871 // we're done 872 mesh_access_message_processed(pdu); 873 } 874 875 // Mesh Model Publication 876 static btstack_timer_source_t mesh_access_publication_timer; 877 878 static uint32_t mesh_model_publication_retransmit_count(uint8_t retransmit){ 879 return retransmit & 0x07u; 880 } 881 882 static uint32_t mesh_model_publication_retransmission_period_ms(uint8_t retransmit){ 883 return ((uint32_t)((retransmit >> 3) + 1)) * 50; 884 } 885 886 static void mesh_model_publication_setup_publication(mesh_publication_model_t * publication_model, uint32_t now){ 887 888 // set retransmit counter 889 publication_model->retransmit_count = mesh_model_publication_retransmit_count(publication_model->retransmit); 890 891 // schedule next publication or retransmission 892 uint32_t publication_period_ms = mesh_access_time_gdtt2ms(publication_model->period) >> publication_model->period_divisor; 893 894 // set next publication 895 if (publication_period_ms != 0){ 896 publication_model->next_publication_ms = now + publication_period_ms; 897 publication_model->state = MESH_MODEL_PUBLICATION_STATE_W4_PUBLICATION_MS; 898 } else { 899 publication_model->state = MESH_MODEL_PUBLICATION_STATE_IDLE; 900 } 901 } 902 903 // assumes retransmit_count is valid 904 static void mesh_model_publication_setup_retransmission(mesh_publication_model_t * publication_model, uint32_t now){ 905 uint32_t publication_period_ms = mesh_access_time_gdtt2ms(publication_model->period) >> publication_model->period_divisor; 906 907 // retransmission done 908 if (publication_model->retransmit_count == 0) { 909 // wait for next main event if periodic and retransmission complete 910 if (publication_period_ms != 0){ 911 publication_model->state = MESH_MODEL_PUBLICATION_STATE_W4_PUBLICATION_MS; 912 } else { 913 publication_model->state = MESH_MODEL_PUBLICATION_STATE_IDLE; 914 } 915 return; 916 } 917 918 // calc next retransmit time 919 uint32_t retransmission_period_ms = mesh_model_publication_retransmission_period_ms(publication_model->retransmit) >> publication_model->period_divisor; 920 uint32_t retransmission_ms = now + retransmission_period_ms; 921 922 // check next publication timeout is before next retransmission 923 if (publication_period_ms != 0){ 924 if (btstack_time_delta(retransmission_ms, publication_model->next_publication_ms) > 0) return; 925 } 926 927 // schedule next retransmission 928 publication_model->next_retransmit_ms = retransmission_ms; 929 publication_model->state = MESH_MODEL_PUBLICATION_STATE_W4_RETRANSMIT_MS; 930 } 931 932 static void mesh_model_publication_publish_now_model(mesh_model_t * mesh_model){ 933 mesh_publication_model_t * publication_model = mesh_model->publication_model; 934 if (publication_model == NULL) return; 935 if (publication_model->publish_state_fn == NULL) return; 936 uint16_t dest = publication_model->address; 937 if (dest == MESH_ADDRESS_UNSASSIGNED) return; 938 uint16_t appkey_index = publication_model->appkey_index; 939 mesh_transport_key_t * app_key = mesh_transport_key_get(appkey_index); 940 if (app_key == NULL) return; 941 942 // compose message 943 mesh_pdu_t * pdu = (*publication_model->publish_state_fn)(mesh_model); 944 if (pdu == NULL) return; 945 946 // handle ttl = default 947 uint8_t ttl = publication_model->ttl; 948 if (ttl == 0xff){ 949 ttl = mesh_foundation_default_ttl_get(); 950 } 951 952 mesh_upper_transport_setup_access_pdu_header(pdu, app_key->netkey_index, appkey_index, ttl, mesh_access_get_element_address(mesh_model), dest, 0); 953 mesh_access_send_unacknowledged_pdu(pdu); 954 } 955 956 static void mesh_model_publication_run(btstack_timer_source_t * ts){ 957 958 uint32_t now = btstack_run_loop_get_time_ms(); 959 960 // iterate over elements and models and handle time-based transitions 961 mesh_element_iterator_t element_it; 962 mesh_element_iterator_init(&element_it); 963 while (mesh_element_iterator_has_next(&element_it)){ 964 mesh_element_t * element = mesh_element_iterator_next(&element_it); 965 mesh_model_iterator_t model_it; 966 mesh_model_iterator_init(&model_it, element); 967 while (mesh_model_iterator_has_next(&model_it)){ 968 mesh_model_t * mesh_model = mesh_model_iterator_next(&model_it); 969 mesh_publication_model_t * publication_model = mesh_model->publication_model; 970 if (publication_model == NULL) continue; 971 972 // check if either timer fired 973 switch (publication_model->state){ 974 case MESH_MODEL_PUBLICATION_STATE_W4_PUBLICATION_MS: 975 if (btstack_time_delta(publication_model->next_publication_ms, now) > 0) break; 976 publication_model->state = MESH_MODEL_PUBLICATION_STATE_PUBLICATION_READY; 977 break; 978 case MESH_MODEL_PUBLICATION_STATE_W4_RETRANSMIT_MS: 979 if (btstack_time_delta(publication_model->next_retransmit_ms, now) > 0) break; 980 publication_model->state = MESH_MODEL_PUBLICATION_STATE_RETRANSMIT_READY; 981 break; 982 default: 983 break; 984 } 985 986 switch (publication_model->state){ 987 case MESH_MODEL_PUBLICATION_STATE_PUBLICATION_READY: 988 // schedule next publication and retransmission 989 mesh_model_publication_setup_publication(publication_model, now); 990 mesh_model_publication_setup_retransmission(publication_model, now); 991 mesh_model_publication_publish_now_model(mesh_model); 992 break; 993 case MESH_MODEL_PUBLICATION_STATE_RETRANSMIT_READY: 994 // schedule next retransmission 995 publication_model->retransmit_count--; 996 mesh_model_publication_setup_retransmission(publication_model, now); 997 mesh_model_publication_publish_now_model(mesh_model); 998 break; 999 default: 1000 break; 1001 } 1002 } 1003 } 1004 1005 int32_t next_timeout_ms = 0; 1006 mesh_element_iterator_init(&element_it); 1007 while (mesh_element_iterator_has_next(&element_it)){ 1008 mesh_element_t * element = mesh_element_iterator_next(&element_it); 1009 mesh_model_iterator_t model_it; 1010 mesh_model_iterator_init(&model_it, element); 1011 while (mesh_model_iterator_has_next(&model_it)){ 1012 mesh_model_t * mesh_model = mesh_model_iterator_next(&model_it); 1013 mesh_publication_model_t * publication_model = mesh_model->publication_model; 1014 if (publication_model == NULL) continue; 1015 1016 // schedule next 1017 int32_t timeout_delta_ms; 1018 switch (publication_model->state){ 1019 case MESH_MODEL_PUBLICATION_STATE_W4_PUBLICATION_MS: 1020 timeout_delta_ms = btstack_time_delta(publication_model->next_publication_ms, now); 1021 if (next_timeout_ms == 0 || timeout_delta_ms < next_timeout_ms){ 1022 next_timeout_ms = timeout_delta_ms; 1023 } 1024 break; 1025 case MESH_MODEL_PUBLICATION_STATE_W4_RETRANSMIT_MS: 1026 timeout_delta_ms = btstack_time_delta(publication_model->next_retransmit_ms, now); 1027 if (next_timeout_ms == 0 || timeout_delta_ms < next_timeout_ms){ 1028 next_timeout_ms = timeout_delta_ms; 1029 } 1030 break; 1031 default: 1032 break; 1033 } 1034 } 1035 } 1036 1037 // remove current timer if active 1038 if (ts == NULL){ 1039 btstack_run_loop_remove_timer(&mesh_access_publication_timer); 1040 1041 } 1042 1043 // new timeout? 1044 if (next_timeout_ms == 0) return; 1045 1046 // set timer 1047 btstack_run_loop_set_timer(&mesh_access_publication_timer, next_timeout_ms); 1048 btstack_run_loop_set_timer_handler(&mesh_access_publication_timer, mesh_model_publication_run); 1049 btstack_run_loop_add_timer(&mesh_access_publication_timer); 1050 } 1051 1052 void mesh_model_publication_start(mesh_model_t * mesh_model){ 1053 mesh_publication_model_t * publication_model = mesh_model->publication_model; 1054 if (publication_model == NULL) return; 1055 1056 // publish right away 1057 publication_model->state = MESH_MODEL_PUBLICATION_STATE_PUBLICATION_READY; 1058 mesh_model_publication_run(NULL); 1059 } 1060 1061 void mesh_model_publication_stop(mesh_model_t * mesh_model){ 1062 mesh_publication_model_t * publication_model = mesh_model->publication_model; 1063 if (publication_model == NULL) return; 1064 1065 // reset state 1066 publication_model->state = MESH_MODEL_PUBLICATION_STATE_IDLE; 1067 } 1068 1069 void mesh_access_state_changed(mesh_model_t * mesh_model){ 1070 mesh_publication_model_t * publication_model = mesh_model->publication_model; 1071 if (publication_model == NULL) return; 1072 publication_model->state = MESH_MODEL_PUBLICATION_STATE_PUBLICATION_READY; 1073 mesh_model_publication_run(NULL); 1074 } 1075 1076