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