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 case MESH_PDU_TYPE_UPPER_UNSEGMENTED_ACCESS: 428 case MESH_PDU_TYPE_UPPER_SEGMENTED_ACCESS: 429 return ((mesh_upper_transport_pdu_t *) pdu)->dst; 430 default: 431 btstack_assert(false); 432 return MESH_ADDRESS_UNSASSIGNED; 433 } 434 } 435 436 uint16_t mesh_pdu_netkey_index(mesh_pdu_t * pdu){ 437 switch (pdu->pdu_type){ 438 case MESH_PDU_TYPE_ACCESS: 439 return ((mesh_access_pdu_t*) pdu)->netkey_index; 440 case MESH_PDU_TYPE_NETWORK: 441 return ((mesh_network_pdu_t *) pdu)->netkey_index; 442 default: 443 btstack_assert(false); 444 return 0; 445 } 446 } 447 448 uint16_t mesh_pdu_appkey_index(mesh_pdu_t * pdu){ 449 switch (pdu->pdu_type){ 450 case MESH_PDU_TYPE_ACCESS: 451 return ((mesh_access_pdu_t*) pdu)->appkey_index; 452 default: 453 btstack_assert(false); 454 return 0; 455 } 456 } 457 458 uint16_t mesh_pdu_len(mesh_pdu_t * pdu){ 459 switch (pdu->pdu_type){ 460 case MESH_PDU_TYPE_ACCESS: 461 return ((mesh_access_pdu_t*) pdu)->len; 462 case MESH_PDU_TYPE_NETWORK: 463 return ((mesh_network_pdu_t *) pdu)->len - 10; 464 default: 465 btstack_assert(false); 466 return 0; 467 } 468 } 469 470 uint8_t * mesh_pdu_data(mesh_pdu_t * pdu){ 471 switch (pdu->pdu_type){ 472 case MESH_PDU_TYPE_ACCESS: 473 return ((mesh_access_pdu_t*) pdu)->data; 474 case MESH_PDU_TYPE_NETWORK: 475 return &((mesh_network_pdu_t *) pdu)->data[10]; 476 default: 477 btstack_assert(false); 478 return NULL; 479 } 480 } 481 482 uint8_t mesh_pdu_control_opcode(mesh_pdu_t * pdu){ 483 switch (pdu->pdu_type){ 484 case MESH_PDU_TYPE_NETWORK: 485 return mesh_network_control_opcode((mesh_network_pdu_t *) pdu); 486 default: 487 btstack_assert(false); 488 return 0xff; 489 } 490 } 491 492 // message parser 493 494 static int mesh_access_get_opcode(uint8_t * buffer, uint16_t buffer_size, uint32_t * opcode, uint16_t * opcode_size){ 495 switch (buffer[0] >> 6){ 496 case 0: 497 case 1: 498 if (buffer[0] == 0x7f) return 0; 499 *opcode = buffer[0]; 500 *opcode_size = 1; 501 return 1; 502 case 2: 503 if (buffer_size < 2) return 0; 504 *opcode = big_endian_read_16(buffer, 0); 505 *opcode_size = 2; 506 return 1; 507 case 3: 508 if (buffer_size < 3) return 0; 509 *opcode = (buffer[0] << 16) | little_endian_read_16(buffer, 1); 510 *opcode_size = 3; 511 return 1; 512 default: 513 return 0; 514 } 515 } 516 517 int mesh_access_pdu_get_opcode(mesh_pdu_t * pdu, uint32_t * opcode, uint16_t * opcode_size){ 518 btstack_assert(pdu->pdu_type == MESH_PDU_TYPE_ACCESS); 519 return mesh_access_get_opcode(((mesh_access_pdu_t *) pdu)->data, ((mesh_access_pdu_t *) pdu)->len, opcode, 520 opcode_size); 521 } 522 523 void mesh_access_parser_skip(mesh_access_parser_state_t * state, uint16_t bytes_to_skip){ 524 state->data += bytes_to_skip; 525 state->len -= bytes_to_skip; 526 } 527 528 int mesh_access_parser_init(mesh_access_parser_state_t * state, mesh_pdu_t * pdu){ 529 btstack_assert(pdu->pdu_type == MESH_PDU_TYPE_ACCESS); 530 state->data = mesh_pdu_data(pdu); 531 state->len = mesh_pdu_len(pdu); 532 533 uint16_t opcode_size = 0; 534 int ok = mesh_access_get_opcode(state->data, state->len, &state->opcode, &opcode_size); 535 if (ok){ 536 mesh_access_parser_skip(state, opcode_size); 537 } 538 return ok; 539 } 540 541 uint16_t mesh_access_parser_available(mesh_access_parser_state_t * state){ 542 return state->len; 543 } 544 545 uint8_t mesh_access_parser_get_uint8(mesh_access_parser_state_t * state){ 546 uint8_t value = *state->data; 547 mesh_access_parser_skip(state, 1); 548 return value; 549 } 550 551 uint16_t mesh_access_parser_get_uint16(mesh_access_parser_state_t * state){ 552 uint16_t value = little_endian_read_16(state->data, 0); 553 mesh_access_parser_skip(state, 2); 554 return value; 555 } 556 557 uint32_t mesh_access_parser_get_uint24(mesh_access_parser_state_t * state){ 558 uint32_t value = little_endian_read_24(state->data, 0); 559 mesh_access_parser_skip(state, 3); 560 return value; 561 } 562 563 uint32_t mesh_access_parser_get_uint32(mesh_access_parser_state_t * state){ 564 uint32_t value = little_endian_read_32(state->data, 0); 565 mesh_access_parser_skip(state, 4); 566 return value; 567 } 568 569 void mesh_access_parser_get_uint128(mesh_access_parser_state_t * state, uint8_t * dest){ 570 reverse_128( state->data, dest); 571 mesh_access_parser_skip(state, 16); 572 } 573 574 void mesh_access_parser_get_label_uuid(mesh_access_parser_state_t * state, uint8_t * dest){ 575 (void)memcpy(dest, state->data, 16); 576 mesh_access_parser_skip(state, 16); 577 } 578 579 void mesh_access_parser_get_key(mesh_access_parser_state_t * state, uint8_t * dest){ 580 (void)memcpy(dest, state->data, 16); 581 mesh_access_parser_skip(state, 16); 582 } 583 584 uint32_t mesh_access_parser_get_model_identifier(mesh_access_parser_state_t * parser){ 585 uint16_t vendor_id = BLUETOOTH_COMPANY_ID_BLUETOOTH_SIG_INC; 586 if (mesh_access_parser_available(parser) == 4){ 587 vendor_id = mesh_access_parser_get_uint16(parser); 588 } 589 uint16_t model_id = mesh_access_parser_get_uint16(parser); 590 return mesh_model_get_model_identifier(vendor_id, model_id); 591 } 592 593 uint32_t mesh_access_parser_get_sig_model_identifier(mesh_access_parser_state_t * parser){ 594 uint16_t model_id = mesh_access_parser_get_uint16(parser); 595 return mesh_model_get_model_identifier(BLUETOOTH_COMPANY_ID_BLUETOOTH_SIG_INC, model_id); 596 } 597 598 uint32_t mesh_access_parser_get_vendor_model_identifier(mesh_access_parser_state_t * parser){ 599 uint16_t vendor_id = mesh_access_parser_get_uint16(parser); 600 uint16_t model_id = mesh_access_parser_get_uint16(parser); 601 return mesh_model_get_model_identifier(vendor_id, model_id); 602 } 603 604 // Mesh Access Message Builder 605 606 // message builder 607 608 static int mesh_access_setup_opcode(uint8_t * buffer, uint32_t opcode){ 609 if (opcode < 0x100){ 610 buffer[0] = opcode; 611 return 1; 612 } 613 if (opcode < 0x10000){ 614 big_endian_store_16(buffer, 0, opcode); 615 return 2; 616 } 617 buffer[0] = opcode >> 16; 618 little_endian_store_16(buffer, 1, opcode & 0xffff); 619 return 3; 620 } 621 622 // mesh_message_t builder 623 624 void mesh_access_message_init(mesh_upper_transport_builder_t * builder, uint32_t opcode) { 625 mesh_upper_transport_message_init(builder, MESH_PDU_TYPE_UPPER_UNSEGMENTED_ACCESS); 626 627 // add opcode 628 uint8_t opcode_buffer[3]; 629 uint8_t opcode_len = mesh_access_setup_opcode(opcode_buffer, opcode); 630 mesh_access_message_add_data(builder, opcode_buffer, opcode_len); 631 } 632 633 void mesh_access_message_add_data(mesh_upper_transport_builder_t * pdu, const uint8_t * data, uint16_t data_len){ 634 mesh_upper_transport_message_add_data(pdu, data, data_len); 635 } 636 637 void mesh_access_message_add_uint8(mesh_upper_transport_builder_t * builder, uint8_t value){ 638 mesh_upper_transport_message_add_uint8(builder, value); 639 } 640 641 void mesh_access_message_add_uint16(mesh_upper_transport_builder_t * builder, uint16_t value){ 642 mesh_upper_transport_message_add_uint16(builder, value); 643 } 644 645 void mesh_access_message_add_uint24(mesh_upper_transport_builder_t * builder, uint32_t value){ 646 mesh_upper_transport_message_add_uint24(builder, value); 647 } 648 649 void mesh_access_message_add_uint32(mesh_upper_transport_builder_t * builder, uint32_t value){ 650 mesh_upper_transport_message_add_uint32(builder, value); 651 } 652 653 void mesh_access_message_add_model_identifier(mesh_upper_transport_builder_t * builder, uint32_t model_identifier){ 654 if (mesh_model_is_bluetooth_sig(model_identifier)){ 655 return mesh_access_message_add_uint16(builder, mesh_model_get_model_id(model_identifier) ); 656 } else { 657 return mesh_access_message_add_uint32(builder, model_identifier ); 658 } 659 } 660 661 mesh_upper_transport_pdu_t * mesh_access_message_finalize(mesh_upper_transport_builder_t * builder){ 662 mesh_upper_transport_pdu_t * upper_pdu = mesh_upper_transport_message_finalize(builder); 663 if (upper_pdu == NULL) return NULL; 664 665 // upgrade to segmented if needed 666 if (upper_pdu->pdu_header.pdu_type == MESH_PDU_TYPE_UPPER_UNSEGMENTED_ACCESS) { 667 if (((upper_pdu->flags & MESH_TRANSPORT_FLAG_TRANSMIC_64) != 0) || (upper_pdu->len > 11)){ 668 upper_pdu->pdu_header.pdu_type = MESH_PDU_TYPE_UPPER_SEGMENTED_ACCESS; 669 } 670 } 671 return upper_pdu; 672 } 673 674 // access message template 675 mesh_upper_transport_pdu_t * mesh_access_setup_message(const mesh_access_message_t *message_template, ...){ 676 677 mesh_upper_transport_builder_t builder; 678 mesh_access_message_init(&builder, message_template->opcode); 679 680 va_list argptr; 681 va_start(argptr, message_template); 682 683 // add params 684 const char * format = message_template->format; 685 uint16_t word; 686 uint32_t longword; 687 while (*format){ 688 switch (*format){ 689 case '1': 690 word = va_arg(argptr, int); // minimal va_arg is int: 2 bytes on 8+16 bit CPUs 691 mesh_access_message_add_uint8(&builder, word); 692 break; 693 case '2': 694 word = va_arg(argptr, int); // minimal va_arg is int: 2 bytes on 8+16 bit CPUs 695 mesh_access_message_add_uint16(&builder, word); 696 break; 697 case '3': 698 longword = va_arg(argptr, uint32_t); 699 mesh_access_message_add_uint24(&builder, longword); 700 break; 701 case '4': 702 longword = va_arg(argptr, uint32_t); 703 mesh_access_message_add_uint32(&builder, longword); 704 break; 705 case 'm': 706 longword = va_arg(argptr, uint32_t); 707 mesh_access_message_add_model_identifier(&builder, longword); 708 break; 709 default: 710 btstack_assert(false); 711 break; 712 } 713 format++; 714 } 715 716 va_end(argptr); 717 718 return mesh_access_message_finalize(&builder); 719 } 720 721 static const mesh_operation_t * mesh_model_lookup_operation_by_opcode(mesh_model_t * model, uint32_t opcode){ 722 // find opcode in table 723 const mesh_operation_t * operation = model->operations; 724 if (operation == NULL) return NULL; 725 for ( ; operation->handler != NULL ; operation++){ 726 if (operation->opcode != opcode) continue; 727 return operation; 728 } 729 return NULL; 730 } 731 732 static const mesh_operation_t * mesh_model_lookup_operation(mesh_model_t * model, mesh_pdu_t * pdu){ 733 734 uint32_t opcode = 0; 735 uint16_t opcode_size = 0; 736 int ok = mesh_access_pdu_get_opcode( pdu, &opcode, &opcode_size); 737 if (!ok) return NULL; 738 739 uint16_t len = mesh_pdu_len(pdu); 740 741 // find opcode in table 742 const mesh_operation_t * operation = model->operations; 743 if (operation == NULL) return NULL; 744 for ( ; operation->handler != NULL ; operation++){ 745 if (operation->opcode != opcode) continue; 746 if ((opcode_size + operation->minimum_length) > len) continue; 747 return operation; 748 } 749 return NULL; 750 } 751 752 static int mesh_access_validate_appkey_index(mesh_model_t * model, uint16_t appkey_index){ 753 // DeviceKey is valid for all models 754 if (appkey_index == MESH_DEVICE_KEY_INDEX) return 1; 755 // check if AppKey that is bound to this particular model 756 return mesh_model_contains_appkey(model, appkey_index); 757 } 758 759 // decrease use count and report as free if done 760 void mesh_access_message_processed(mesh_pdu_t * pdu){ 761 if (mesh_access_received_pdu_refcount > 0){ 762 mesh_access_received_pdu_refcount--; 763 } 764 if (mesh_access_received_pdu_refcount == 0){ 765 mesh_upper_transport_message_processed_by_higher_layer(pdu); 766 } 767 } 768 769 static void mesh_access_message_process_handler(mesh_pdu_t * pdu){ 770 771 // init use count 772 mesh_access_received_pdu_refcount = 1; 773 774 // get opcode and size 775 uint32_t opcode = 0; 776 uint16_t opcode_size = 0; 777 778 int ok = mesh_access_pdu_get_opcode( pdu, &opcode, &opcode_size); 779 if (!ok) { 780 mesh_access_message_processed(pdu); 781 return; 782 } 783 784 uint16_t len = mesh_pdu_len(pdu); 785 printf("MESH Access Message, Opcode = %x: ", opcode); 786 printf_hexdump(mesh_pdu_data(pdu), len); 787 788 uint16_t src = mesh_pdu_src(pdu); 789 uint16_t dst = mesh_pdu_dst(pdu); 790 uint16_t appkey_index = mesh_pdu_appkey_index(pdu); 791 if (mesh_network_address_unicast(dst)){ 792 // loookup element by unicast address 793 mesh_element_t * element = mesh_node_element_for_unicast_address(dst); 794 if (element != NULL){ 795 // iterate over models, look for operation 796 mesh_model_iterator_t model_it; 797 mesh_model_iterator_init(&model_it, element); 798 while (mesh_model_iterator_has_next(&model_it)){ 799 mesh_model_t * model = mesh_model_iterator_next(&model_it); 800 // find opcode in table 801 const mesh_operation_t * operation = mesh_model_lookup_operation(model, pdu); 802 if (operation == NULL) continue; 803 if (mesh_access_validate_appkey_index(model, appkey_index) == 0) continue; 804 mesh_access_acknowledged_received(src, opcode); 805 mesh_access_received_pdu_refcount++; 806 operation->handler(model, pdu); 807 } 808 } 809 } 810 else if (mesh_network_address_group(dst)){ 811 812 // handle fixed group address 813 if (dst >= 0xff00){ 814 int deliver_to_primary_element = 1; 815 switch (dst){ 816 case MESH_ADDRESS_ALL_PROXIES: 817 if (mesh_foundation_gatt_proxy_get() == 1){ 818 deliver_to_primary_element = 1; 819 } 820 break; 821 case MESH_ADDRESS_ALL_FRIENDS: 822 // TODO: not implemented 823 break; 824 case MESH_ADDRESS_ALL_RELAYS: 825 if (mesh_foundation_relay_get() == 1){ 826 deliver_to_primary_element = 1; 827 } 828 break; 829 case MESH_ADDRESS_ALL_NODES: 830 deliver_to_primary_element = 1; 831 break; 832 default: 833 break; 834 } 835 if (deliver_to_primary_element){ 836 mesh_model_iterator_t model_it; 837 mesh_model_iterator_init(&model_it, mesh_node_get_primary_element()); 838 while (mesh_model_iterator_has_next(&model_it)){ 839 mesh_model_t * model = mesh_model_iterator_next(&model_it); 840 // find opcode in table 841 const mesh_operation_t * operation = mesh_model_lookup_operation(model, pdu); 842 if (operation == NULL) continue; 843 if (mesh_access_validate_appkey_index(model, appkey_index) == 0) continue; 844 mesh_access_acknowledged_received(src, opcode); 845 mesh_access_received_pdu_refcount++; 846 operation->handler(model, pdu); 847 } 848 } 849 } 850 else { 851 // iterate over all elements / models, check subscription list 852 mesh_element_iterator_t it; 853 mesh_element_iterator_init(&it); 854 while (mesh_element_iterator_has_next(&it)){ 855 mesh_element_t * element = (mesh_element_t *) mesh_element_iterator_next(&it); 856 mesh_model_iterator_t model_it; 857 mesh_model_iterator_init(&model_it, element); 858 while (mesh_model_iterator_has_next(&model_it)){ 859 mesh_model_t * model = mesh_model_iterator_next(&model_it); 860 if (mesh_model_contains_subscription(model, dst)){ 861 // find opcode in table 862 const mesh_operation_t * operation = mesh_model_lookup_operation(model, pdu); 863 if (operation == NULL) continue; 864 if (mesh_access_validate_appkey_index(model, appkey_index) == 0) continue; 865 mesh_access_acknowledged_received(src, opcode); 866 mesh_access_received_pdu_refcount++; 867 operation->handler(model, pdu); 868 } 869 } 870 } 871 } 872 } 873 874 // we're done 875 mesh_access_message_processed(pdu); 876 } 877 878 // Mesh Model Publication 879 static btstack_timer_source_t mesh_access_publication_timer; 880 881 static uint32_t mesh_model_publication_retransmit_count(uint8_t retransmit){ 882 return retransmit & 0x07u; 883 } 884 885 static uint32_t mesh_model_publication_retransmission_period_ms(uint8_t retransmit){ 886 return ((uint32_t)((retransmit >> 3) + 1)) * 50; 887 } 888 889 static void mesh_model_publication_setup_publication(mesh_publication_model_t * publication_model, uint32_t now){ 890 891 // set retransmit counter 892 publication_model->retransmit_count = mesh_model_publication_retransmit_count(publication_model->retransmit); 893 894 // schedule next publication or retransmission 895 uint32_t publication_period_ms = mesh_access_time_gdtt2ms(publication_model->period) >> publication_model->period_divisor; 896 897 // set next publication 898 if (publication_period_ms != 0){ 899 publication_model->next_publication_ms = now + publication_period_ms; 900 publication_model->state = MESH_MODEL_PUBLICATION_STATE_W4_PUBLICATION_MS; 901 } else { 902 publication_model->state = MESH_MODEL_PUBLICATION_STATE_IDLE; 903 } 904 } 905 906 // assumes retransmit_count is valid 907 static void mesh_model_publication_setup_retransmission(mesh_publication_model_t * publication_model, uint32_t now){ 908 uint32_t publication_period_ms = mesh_access_time_gdtt2ms(publication_model->period) >> publication_model->period_divisor; 909 910 // retransmission done 911 if (publication_model->retransmit_count == 0) { 912 // wait for next main event if periodic and retransmission complete 913 if (publication_period_ms != 0){ 914 publication_model->state = MESH_MODEL_PUBLICATION_STATE_W4_PUBLICATION_MS; 915 } else { 916 publication_model->state = MESH_MODEL_PUBLICATION_STATE_IDLE; 917 } 918 return; 919 } 920 921 // calc next retransmit time 922 uint32_t retransmission_period_ms = mesh_model_publication_retransmission_period_ms(publication_model->retransmit) >> publication_model->period_divisor; 923 uint32_t retransmission_ms = now + retransmission_period_ms; 924 925 // check next publication timeout is before next retransmission 926 if (publication_period_ms != 0){ 927 if (btstack_time_delta(retransmission_ms, publication_model->next_publication_ms) > 0) return; 928 } 929 930 // schedule next retransmission 931 publication_model->next_retransmit_ms = retransmission_ms; 932 publication_model->state = MESH_MODEL_PUBLICATION_STATE_W4_RETRANSMIT_MS; 933 } 934 935 static void mesh_model_publication_publish_now_model(void * arg){ 936 mesh_model_t * mesh_model = (mesh_model_t *) arg; 937 mesh_publication_model_t * publication_model = mesh_model->publication_model; 938 if (publication_model == NULL) return; 939 if (publication_model->publish_state_fn == NULL) return; 940 uint16_t dest = publication_model->address; 941 if (dest == MESH_ADDRESS_UNSASSIGNED) return; 942 uint16_t appkey_index = publication_model->appkey_index; 943 mesh_transport_key_t * app_key = mesh_transport_key_get(appkey_index); 944 if (app_key == NULL) return; 945 946 // compose message 947 mesh_pdu_t * pdu = (*publication_model->publish_state_fn)(mesh_model); 948 if (pdu == NULL) return; 949 950 // handle ttl = default 951 uint8_t ttl = publication_model->ttl; 952 if (ttl == 0xff){ 953 ttl = mesh_foundation_default_ttl_get(); 954 } 955 956 mesh_upper_transport_setup_access_pdu_header(pdu, app_key->netkey_index, appkey_index, ttl, mesh_access_get_element_address(mesh_model), dest, 0); 957 mesh_access_send_unacknowledged_pdu(pdu); 958 } 959 960 static void mesh_model_trigger_publication(mesh_model_t * mesh_model){ 961 // queue publication 962 mesh_publication_model_t * publication_model = mesh_model->publication_model; 963 publication_model->send_request.context = mesh_model; 964 publication_model->send_request.callback = &mesh_model_publication_publish_now_model; 965 mesh_upper_transport_request_to_send(&publication_model->send_request); 966 } 967 968 static void mesh_model_publication_run(btstack_timer_source_t * ts){ 969 970 uint32_t now = btstack_run_loop_get_time_ms(); 971 972 // iterate over elements and models and handle time-based transitions 973 mesh_element_iterator_t element_it; 974 mesh_element_iterator_init(&element_it); 975 while (mesh_element_iterator_has_next(&element_it)){ 976 mesh_element_t * element = mesh_element_iterator_next(&element_it); 977 mesh_model_iterator_t model_it; 978 mesh_model_iterator_init(&model_it, element); 979 while (mesh_model_iterator_has_next(&model_it)){ 980 mesh_model_t * mesh_model = mesh_model_iterator_next(&model_it); 981 mesh_publication_model_t * publication_model = mesh_model->publication_model; 982 if (publication_model == NULL) continue; 983 984 // check if either timer fired 985 switch (publication_model->state){ 986 case MESH_MODEL_PUBLICATION_STATE_W4_PUBLICATION_MS: 987 if (btstack_time_delta(publication_model->next_publication_ms, now) > 0) break; 988 publication_model->state = MESH_MODEL_PUBLICATION_STATE_PUBLICATION_READY; 989 break; 990 case MESH_MODEL_PUBLICATION_STATE_W4_RETRANSMIT_MS: 991 if (btstack_time_delta(publication_model->next_retransmit_ms, now) > 0) break; 992 publication_model->state = MESH_MODEL_PUBLICATION_STATE_RETRANSMIT_READY; 993 break; 994 default: 995 break; 996 } 997 998 switch (publication_model->state){ 999 case MESH_MODEL_PUBLICATION_STATE_PUBLICATION_READY: 1000 // schedule next publication and retransmission 1001 mesh_model_publication_setup_publication(publication_model, now); 1002 mesh_model_publication_setup_retransmission(publication_model, now); 1003 mesh_model_trigger_publication(mesh_model); 1004 break; 1005 case MESH_MODEL_PUBLICATION_STATE_RETRANSMIT_READY: 1006 // schedule next retransmission 1007 publication_model->retransmit_count--; 1008 mesh_model_publication_setup_retransmission(publication_model, now); 1009 mesh_model_trigger_publication(mesh_model); 1010 break; 1011 default: 1012 break; 1013 } 1014 } 1015 } 1016 1017 int32_t next_timeout_ms = 0; 1018 mesh_element_iterator_init(&element_it); 1019 while (mesh_element_iterator_has_next(&element_it)){ 1020 mesh_element_t * element = mesh_element_iterator_next(&element_it); 1021 mesh_model_iterator_t model_it; 1022 mesh_model_iterator_init(&model_it, element); 1023 while (mesh_model_iterator_has_next(&model_it)){ 1024 mesh_model_t * mesh_model = mesh_model_iterator_next(&model_it); 1025 mesh_publication_model_t * publication_model = mesh_model->publication_model; 1026 if (publication_model == NULL) continue; 1027 1028 // schedule next 1029 int32_t timeout_delta_ms; 1030 switch (publication_model->state){ 1031 case MESH_MODEL_PUBLICATION_STATE_W4_PUBLICATION_MS: 1032 timeout_delta_ms = btstack_time_delta(publication_model->next_publication_ms, now); 1033 if (next_timeout_ms == 0 || timeout_delta_ms < next_timeout_ms){ 1034 next_timeout_ms = timeout_delta_ms; 1035 } 1036 break; 1037 case MESH_MODEL_PUBLICATION_STATE_W4_RETRANSMIT_MS: 1038 timeout_delta_ms = btstack_time_delta(publication_model->next_retransmit_ms, now); 1039 if (next_timeout_ms == 0 || timeout_delta_ms < next_timeout_ms){ 1040 next_timeout_ms = timeout_delta_ms; 1041 } 1042 break; 1043 default: 1044 break; 1045 } 1046 } 1047 } 1048 1049 // remove current timer if active 1050 if (ts == NULL){ 1051 btstack_run_loop_remove_timer(&mesh_access_publication_timer); 1052 1053 } 1054 1055 // new timeout? 1056 if (next_timeout_ms == 0) return; 1057 1058 // set timer 1059 btstack_run_loop_set_timer(&mesh_access_publication_timer, next_timeout_ms); 1060 btstack_run_loop_set_timer_handler(&mesh_access_publication_timer, mesh_model_publication_run); 1061 btstack_run_loop_add_timer(&mesh_access_publication_timer); 1062 } 1063 1064 void mesh_model_publication_start(mesh_model_t * mesh_model){ 1065 mesh_publication_model_t * publication_model = mesh_model->publication_model; 1066 if (publication_model == NULL) return; 1067 1068 // publish right away 1069 publication_model->state = MESH_MODEL_PUBLICATION_STATE_PUBLICATION_READY; 1070 mesh_model_publication_run(NULL); 1071 } 1072 1073 void mesh_model_publication_stop(mesh_model_t * mesh_model){ 1074 mesh_publication_model_t * publication_model = mesh_model->publication_model; 1075 if (publication_model == NULL) return; 1076 1077 // reset state 1078 publication_model->state = MESH_MODEL_PUBLICATION_STATE_IDLE; 1079 } 1080 1081 void mesh_access_state_changed(mesh_model_t * mesh_model){ 1082 mesh_publication_model_t * publication_model = mesh_model->publication_model; 1083 if (publication_model == NULL) return; 1084 publication_model->state = MESH_MODEL_PUBLICATION_STATE_PUBLICATION_READY; 1085 mesh_model_publication_run(NULL); 1086 } 1087 1088