/* * Copyright (C) 2014 BlueKitchen GmbH * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of the copyright holders nor the names of * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * 4. Any redistribution, use, or modification is done solely for * personal benefit and not for any commercial purpose or for * monetary gain. * * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * * Please inquire about commercial licensing options at * contact@bluekitchen-gmbh.com * */ #define BTSTACK_FILE__ "mesh_lower_transport.c" #include #include #include #include #include "btstack_memory.h" #include "btstack_util.h" #include "mesh/beacon.h" #include "mesh/mesh_iv_index_seq_number.h" #include "mesh/mesh_lower_transport.h" #include "mesh/mesh_node.h" #include "mesh/mesh_peer.h" #define LOG_LOWER_TRANSPORT static void (*higher_layer_handler)( mesh_transport_callback_type_t callback_type, mesh_transport_status_t status, mesh_pdu_t * pdu); static void mesh_print_hex(const char * name, const uint8_t * data, uint16_t len){ printf("%-20s ", name); printf_hexdump(data, len); } // static void mesh_print_x(const char * name, uint32_t value){ // printf("%20s: 0x%x", name, (int) value); // } // utility mesh_message_pdu_t * mesh_message_pdu_get(void){ mesh_message_pdu_t * message_pdu = btstack_memory_mesh_message_pdu_get(); if (message_pdu){ message_pdu->pdu_header.pdu_type = MESH_PDU_TYPE_MESSAGE; } return message_pdu; } void mesh_message_pdu_free(mesh_message_pdu_t * message_pdu){ while (message_pdu->segments){ mesh_network_pdu_t * segment = (mesh_network_pdu_t *) btstack_linked_list_pop(&message_pdu->segments); mesh_network_pdu_free(segment); } btstack_memory_mesh_message_pdu_free(message_pdu); } static void mesh_lower_transport_report_segments_as_processed(mesh_message_pdu_t * message_pdu) { while (message_pdu->segments){ mesh_network_pdu_t * segment = (mesh_network_pdu_t *) btstack_linked_list_pop(&message_pdu->segments); mesh_network_message_processed_by_higher_layer(segment); } } // Transport PDU Getter uint16_t mesh_transport_nid(mesh_transport_pdu_t * transport_pdu){ return transport_pdu->network_header[0] & 0x7f; } uint16_t mesh_transport_ctl(mesh_transport_pdu_t * transport_pdu){ return transport_pdu->network_header[1] >> 7; } uint16_t mesh_transport_ttl(mesh_transport_pdu_t * transport_pdu){ return transport_pdu->network_header[1] & 0x7f; } uint32_t mesh_transport_seq(mesh_transport_pdu_t * transport_pdu){ return big_endian_read_24(transport_pdu->network_header, 2); } uint16_t mesh_transport_src(mesh_transport_pdu_t * transport_pdu){ return big_endian_read_16(transport_pdu->network_header, 5); } uint16_t mesh_transport_dst(mesh_transport_pdu_t * transport_pdu){ return big_endian_read_16(transport_pdu->network_header, 7); } uint8_t mesh_transport_control_opcode(mesh_transport_pdu_t * transport_pdu){ return transport_pdu->akf_aid_control & 0x7f; } void mesh_transport_set_nid_ivi(mesh_transport_pdu_t * transport_pdu, uint8_t nid_ivi){ transport_pdu->network_header[0] = nid_ivi; } void mesh_transport_set_ctl_ttl(mesh_transport_pdu_t * transport_pdu, uint8_t ctl_ttl){ transport_pdu->network_header[1] = ctl_ttl; } void mesh_transport_set_seq(mesh_transport_pdu_t * transport_pdu, uint32_t seq){ big_endian_store_24(transport_pdu->network_header, 2, seq); } void mesh_transport_set_src(mesh_transport_pdu_t * transport_pdu, uint16_t src){ big_endian_store_16(transport_pdu->network_header, 5, src); } void mesh_transport_set_dest(mesh_transport_pdu_t * transport_pdu, uint16_t dest){ big_endian_store_16(transport_pdu->network_header, 7, dest); } uint16_t mesh_message_nid(mesh_message_pdu_t * message_pdu){ return message_pdu->network_header[0] & 0x7f; } uint16_t mesh_message_ctl(mesh_message_pdu_t * message_pdu){ return message_pdu->network_header[1] >> 7; } static uint16_t mesh_message_ttl(mesh_message_pdu_t * message_pdu){ return message_pdu->network_header[1] & 0x7f; } static uint32_t mesh_message_seq(mesh_message_pdu_t * message_pdu){ return big_endian_read_24(message_pdu->network_header, 2); } static uint16_t mesh_message_src(mesh_message_pdu_t * message_pdu){ return big_endian_read_16(message_pdu->network_header, 5); } static uint16_t mesh_message_dest(mesh_message_pdu_t * message_pdu){ return big_endian_read_16(message_pdu->network_header, 7); } static uint32_t mesh_message_seq_zero(mesh_message_pdu_t * message_pdu){ return message_pdu->seq_zero; } // lower transport // prototypes static void mesh_lower_transport_run(void); static void mesh_lower_transport_outgoing_complete(void); static void mesh_lower_transport_network_pdu_sent(mesh_network_pdu_t *network_pdu); static void mesh_lower_transport_segment_transmission_timeout(btstack_timer_source_t * ts); // state static int lower_transport_retry_count; // lower transport ougoing static btstack_linked_list_t lower_transport_outgoing; static mesh_network_pdu_t * lower_transport_outgoing_segment; static uint16_t lower_transport_outgoing_seg_o; static mesh_message_pdu_t lower_transport_outgoing_segmented_message_singleton; static mesh_message_pdu_t * lower_transport_outgoing_message; static mesh_unsegmented_pdu_t * lower_transport_outgoing_unsegmented_pdu; // segment at network layer static int lower_transport_outgoing_segment_queued; // transmission timeout occured (while outgoing segment queued at network layer) static int lower_transport_outgoing_transmission_timeout; // transmission completed either fully acked or remote aborted (while outgoing segment queued at network layer) static int lower_transport_outgoing_trasnmission_complete; // deliver to higher layer static mesh_pdu_t * mesh_lower_transport_higher_layer_pdu; static btstack_linked_list_t mesh_lower_transport_queued_for_higher_layer; static mesh_unsegmented_pdu_t lower_transport_access_incoming_singleton; static void mesh_lower_transport_process_segment_acknowledgement_message(mesh_network_pdu_t *network_pdu){ if (lower_transport_outgoing_message == NULL) return; uint8_t * lower_transport_pdu = mesh_network_pdu_data(network_pdu); uint16_t seq_zero_pdu = big_endian_read_16(lower_transport_pdu, 1) >> 2; uint16_t seq_zero_out = mesh_message_seq(lower_transport_outgoing_message) & 0x1fff; uint32_t block_ack = big_endian_read_32(lower_transport_pdu, 3); #ifdef LOG_LOWER_TRANSPORT printf("[+] Segment Acknowledgment message with seq_zero %06x, block_ack %08x - outgoing seq %06x, block_ack %08x\n", seq_zero_pdu, block_ack, seq_zero_out, lower_transport_outgoing_message->block_ack); #endif if (block_ack == 0){ // If a Segment Acknowledgment message with the BlockAck field set to 0x00000000 is received, // then the Upper Transport PDU shall be immediately cancelled and the higher layers shall be notified that // the Upper Transport PDU has been cancelled. #ifdef LOG_LOWER_TRANSPORT printf("[+] Block Ack == 0 => Abort\n"); #endif if (lower_transport_outgoing_segment_queued){ lower_transport_outgoing_trasnmission_complete = 1; } else { mesh_lower_transport_outgoing_complete(); } return; } if (seq_zero_pdu != seq_zero_out){ #ifdef LOG_LOWER_TRANSPORT printf("[!] Seq Zero doesn't match\n"); #endif return; } lower_transport_outgoing_message->block_ack &= ~block_ack; #ifdef LOG_LOWER_TRANSPORT printf("[+] Updated block_ack %08x\n", lower_transport_outgoing_message->block_ack); #endif if (lower_transport_outgoing_message->block_ack == 0){ #ifdef LOG_LOWER_TRANSPORT printf("[+] Sent complete\n"); #endif if (lower_transport_outgoing_segment_queued){ lower_transport_outgoing_trasnmission_complete = 1; } else { mesh_lower_transport_outgoing_complete(); } } } static void mesh_lower_transport_deliver_to_higher_layer(void){ if (mesh_lower_transport_higher_layer_pdu == NULL && !btstack_linked_list_empty(&mesh_lower_transport_queued_for_higher_layer)){ mesh_pdu_t * pdu = (mesh_pdu_t *) btstack_linked_list_pop(&mesh_lower_transport_queued_for_higher_layer); switch (pdu->pdu_type){ case MESH_MSG_TYPE_NETWORK_PDU: // unsegmented pdu mesh_lower_transport_higher_layer_pdu = (mesh_pdu_t *) &lower_transport_access_incoming_singleton; lower_transport_access_incoming_singleton.pdu_header.pdu_type = MESH_PDU_TYPE_UNSEGMENTED; lower_transport_access_incoming_singleton.segment = (mesh_network_pdu_t*) pdu; break; default: // segmented control or access pdu mesh_lower_transport_higher_layer_pdu = pdu; break; } higher_layer_handler(MESH_TRANSPORT_PDU_RECEIVED, MESH_TRANSPORT_STATUS_SUCCESS, mesh_lower_transport_higher_layer_pdu); } } static void mesh_lower_transport_queue_for_higher_layer(mesh_pdu_t * pdu){ btstack_linked_list_add_tail(&mesh_lower_transport_queued_for_higher_layer, (btstack_linked_item_t *) pdu); mesh_lower_transport_deliver_to_higher_layer(); } static void mesh_lower_transport_process_unsegmented_control_message(mesh_network_pdu_t *network_pdu){ uint8_t * lower_transport_pdu = mesh_network_pdu_data(network_pdu); uint8_t opcode = lower_transport_pdu[0]; #ifdef LOG_LOWER_TRANSPORT printf("Unsegmented Control message, outgoing message %p, opcode %x\n", lower_transport_outgoing_message, opcode); #endif switch (opcode){ case 0: mesh_lower_transport_process_segment_acknowledgement_message(network_pdu); mesh_network_message_processed_by_higher_layer(network_pdu); break; default: mesh_lower_transport_queue_for_higher_layer((mesh_pdu_t *) network_pdu); break; } } // ack / incomplete message static void mesh_lower_transport_setup_segmented_acknowledge_message(uint8_t * data, uint8_t obo, uint16_t seq_zero, uint32_t block_ack){ // printf("ACK Upper Transport, seq_zero %x\n", seq_zero); data[0] = 0; // SEG = 0, Opcode = 0 big_endian_store_16( data, 1, (obo << 15) | (seq_zero << 2) | 0); // OBO, SeqZero, RFU big_endian_store_32( data, 3, block_ack); #ifdef LOG_LOWER_TRANSPORT mesh_print_hex("ACK Upper Transport", data, 7); #endif } static void mesh_lower_transport_send_ack(uint16_t netkey_index, uint8_t ttl, uint16_t dest, uint16_t seq_zero, uint32_t block_ack){ // setup ack message uint8_t ack_msg[7]; mesh_lower_transport_setup_segmented_acknowledge_message(ack_msg, 0, seq_zero, block_ack); // // "3.4.5.2: The output filter of the interface connected to advertising or GATT bearers shall drop all messages with TTL value set to 1." // if (ttl <= 1) return 0; // TODO: check transport_pdu_len depending on ctl // lookup network by netkey_index const mesh_network_key_t * network_key = mesh_network_key_list_get(netkey_index); if (!network_key) return; // allocate network_pdu mesh_network_pdu_t * network_pdu = mesh_network_pdu_get(); if (!network_pdu) return; // setup network_pdu mesh_network_setup_pdu(network_pdu, netkey_index, network_key->nid, 1, ttl, mesh_sequence_number_next(), mesh_node_get_primary_element_address(), dest, ack_msg, sizeof(ack_msg)); // send network_pdu mesh_network_send_pdu(network_pdu); } static void mesh_lower_transport_send_ack_for_transport_pdu(mesh_message_pdu_t * message_pdu){ uint16_t seq_zero = mesh_message_seq_zero(message_pdu); uint8_t ttl = mesh_message_ttl(message_pdu); uint16_t dest = mesh_message_src(message_pdu); uint16_t netkey_index = message_pdu->netkey_index; #ifdef LOG_LOWER_TRANSPORT printf("mesh_transport_send_ack_for_transport_pdu %p with netkey_index %x, TTL = %u, SeqZero = %x, SRC = %x, DST = %x\n", message_pdu, netkey_index, ttl, seq_zero, mesh_node_get_primary_element_address(), dest); #endif mesh_lower_transport_send_ack(netkey_index, ttl, dest, seq_zero, message_pdu->block_ack); } static void mesh_lower_transport_send_ack_for_network_pdu(mesh_network_pdu_t *network_pdu, uint16_t seq_zero, uint32_t block_ack) { uint8_t ttl = mesh_network_ttl(network_pdu); uint16_t dest = mesh_network_src(network_pdu); uint16_t netkey_index = network_pdu->netkey_index; #ifdef LOG_LOWER_TRANSPORT printf("mesh_transport_send_ack_for_network_pdu %p with netkey_index %x, TTL = %u, SeqZero = %x, SRC = %x, DST = %x\n", network_pdu, netkey_index, ttl, seq_zero, mesh_node_get_primary_element_address(), dest); #endif mesh_lower_transport_send_ack(netkey_index, ttl, dest, seq_zero, block_ack); } static void mesh_lower_transport_incoming_stop_acknowledgment_timer(mesh_message_pdu_t *message_pdu){ if (!message_pdu->acknowledgement_timer_active) return; message_pdu->acknowledgement_timer_active = 0; btstack_run_loop_remove_timer(&message_pdu->acknowledgement_timer); } static void mesh_lower_transport_incoming_stop_incomplete_timer(mesh_message_pdu_t *message_pdu){ if (!message_pdu->incomplete_timer_active) return; message_pdu->incomplete_timer_active = 0; btstack_run_loop_remove_timer(&message_pdu->incomplete_timer); } static void mesh_lower_transport_outgoing_stop_acknowledgment_timer(mesh_message_pdu_t *message_pdu){ if (!message_pdu->acknowledgement_timer_active) return; message_pdu->acknowledgement_timer_active = 0; btstack_run_loop_remove_timer(&message_pdu->acknowledgement_timer); } static void mesh_lower_transport_outgoing_stop_incomplete_timer(mesh_message_pdu_t *message_pdu){ if (!message_pdu->incomplete_timer_active) return; message_pdu->incomplete_timer_active = 0; btstack_run_loop_remove_timer(&message_pdu->incomplete_timer); } // stops timers and updates reassembly engine static void mesh_lower_transport_rx_segmented_message_complete(mesh_message_pdu_t * message_pdu){ // set flag message_pdu->message_complete = 1; // stop timers mesh_lower_transport_incoming_stop_acknowledgment_timer(message_pdu); mesh_lower_transport_incoming_stop_incomplete_timer(message_pdu); // stop reassembly mesh_peer_t * peer = mesh_peer_for_addr(mesh_message_src(message_pdu)); if (peer){ peer->message_pdu = NULL; } } static void mesh_lower_transport_rx_ack_timeout(btstack_timer_source_t *ts){ mesh_message_pdu_t * message_pdu = (mesh_message_pdu_t *) btstack_run_loop_get_timer_context(ts); #ifdef LOG_LOWER_TRANSPORT printf("ACK: acknowledgement timer fired for %p, send ACK\n", message_pdu); #endif message_pdu->acknowledgement_timer_active = 0; mesh_lower_transport_send_ack_for_transport_pdu(message_pdu); } static void mesh_lower_transport_rx_incomplete_timeout(btstack_timer_source_t *ts){ mesh_message_pdu_t * message_pdu = (mesh_message_pdu_t *) btstack_run_loop_get_timer_context(ts); #ifdef LOG_LOWER_TRANSPORT printf("mesh_transport_rx_incomplete_timeout for %p - give up\n", message_pdu); #endif mesh_lower_transport_rx_segmented_message_complete(message_pdu); // free segments mesh_lower_transport_report_segments_as_processed(message_pdu); // free message btstack_memory_mesh_message_pdu_free(message_pdu); } static void mesh_lower_transport_start_rx_acknowledgment_timer(mesh_message_pdu_t * message_pdu, uint32_t timeout){ #ifdef LOG_LOWER_TRANSPORT printf("ACK: start rx ack timer for %p, timeout %u ms\n", message_pdu, (int) timeout); #endif btstack_run_loop_set_timer(&message_pdu->acknowledgement_timer, timeout); btstack_run_loop_set_timer_handler(&message_pdu->acknowledgement_timer, &mesh_lower_transport_rx_ack_timeout); btstack_run_loop_set_timer_context(&message_pdu->acknowledgement_timer, message_pdu); btstack_run_loop_add_timer(&message_pdu->acknowledgement_timer); message_pdu->acknowledgement_timer_active = 1; } static void mesh_lower_transport_tx_restart_segment_transmission_timer(void){ // restart segment transmission timer for unicast dst // - "This timer shall be set to a minimum of 200 + 50 * TTL milliseconds." uint32_t timeout = 200 + 50 * mesh_message_ttl(lower_transport_outgoing_message); if (lower_transport_outgoing_message->acknowledgement_timer_active){ btstack_run_loop_remove_timer(&lower_transport_outgoing_message->acknowledgement_timer); } #ifdef LOG_LOWER_TRANSPORT printf("[+] Lower transport, segmented pdu %p, seq %06x: setup transmission timeout %u ms\n", lower_transport_outgoing_message, mesh_message_seq(lower_transport_outgoing_message), (int) timeout); #endif btstack_run_loop_set_timer(&lower_transport_outgoing_message->acknowledgement_timer, timeout); btstack_run_loop_set_timer_handler(&lower_transport_outgoing_message->acknowledgement_timer, &mesh_lower_transport_segment_transmission_timeout); btstack_run_loop_add_timer(&lower_transport_outgoing_message->acknowledgement_timer); lower_transport_outgoing_message->acknowledgement_timer_active = 1; } static void mesh_lower_transport_incoming_restart_incomplete_timer(mesh_message_pdu_t * message_pdu, uint32_t timeout, void (*callback)(btstack_timer_source_t *ts)){ #ifdef LOG_LOWER_TRANSPORT printf("RX-(re)start incomplete timer for %p, timeout %u ms\n", message_pdu, (int) timeout); #endif if (message_pdu->incomplete_timer_active){ btstack_run_loop_remove_timer(&message_pdu->incomplete_timer); } btstack_run_loop_set_timer(&message_pdu->incomplete_timer, timeout); btstack_run_loop_set_timer_handler(&message_pdu->incomplete_timer, callback); btstack_run_loop_set_timer_context(&message_pdu->incomplete_timer, message_pdu); btstack_run_loop_add_timer(&message_pdu->incomplete_timer); message_pdu->incomplete_timer_active = 1; } static void mesh_lower_transport_outgoing_complete(void){ btstack_assert(lower_transport_outgoing_message != NULL); #ifdef LOG_LOWER_TRANSPORT printf("mesh_lower_transport_outgoing_complete %p, ack timer active %u, incomplete active %u\n", lower_transport_outgoing_message, lower_transport_outgoing_message->acknowledgement_timer_active, lower_transport_outgoing_message->incomplete_timer_active); #endif // stop timers mesh_lower_transport_outgoing_stop_acknowledgment_timer(lower_transport_outgoing_message); mesh_lower_transport_outgoing_stop_incomplete_timer(lower_transport_outgoing_message); lower_transport_outgoing_message = NULL; // notify upper transport mesh_message_pdu_t * pdu = lower_transport_outgoing_message; lower_transport_outgoing_message = NULL; higher_layer_handler(MESH_TRANSPORT_PDU_SENT, MESH_TRANSPORT_STATUS_SEND_ABORT_BY_REMOTE, (mesh_pdu_t *) pdu); } static mesh_message_pdu_t * mesh_lower_transport_pdu_for_segmented_message(mesh_network_pdu_t *network_pdu){ uint16_t src = mesh_network_src(network_pdu); uint16_t seq_zero = ( big_endian_read_16(mesh_network_pdu_data(network_pdu), 1) >> 2) & 0x1fff; #ifdef LOG_LOWER_TRANSPORT printf("mesh_transport_pdu_for_segmented_message: seq_zero %x\n", seq_zero); #endif mesh_peer_t * peer = mesh_peer_for_addr(src); if (!peer) { return NULL; } #ifdef LOG_LOWER_TRANSPORT printf("mesh_seq_zero_validate(%x, %x) -- last (%x, %x)\n", src, seq_zero, peer->address, peer->seq_zero); #endif // reception of transport message ongoing if (peer->message_pdu){ // check if segment for same seq zero uint16_t active_seq_zero = mesh_message_seq_zero(peer->message_pdu); if (active_seq_zero == seq_zero) { #ifdef LOG_LOWER_TRANSPORT printf("mesh_transport_pdu_for_segmented_message: segment for current transport pdu with SeqZero %x\n", active_seq_zero); #endif return peer->message_pdu; } else { // seq zero differs from current transport pdu, but current pdu is not complete #ifdef LOG_LOWER_TRANSPORT printf("mesh_transport_pdu_for_segmented_message: drop segment. current transport pdu SeqZero %x, now %x\n", active_seq_zero, seq_zero); #endif return NULL; } } // send ACK if segment for previously completed transport pdu (no ongoing reception, block ack is cleared) if ((seq_zero == peer->seq_zero) && (peer->block_ack != 0)){ #ifdef LOG_LOWER_TRANSPORT printf("mesh_transport_pdu_for_segmented_message: segment for last completed message. send ack\n"); #endif mesh_lower_transport_send_ack_for_network_pdu(network_pdu, seq_zero, peer->block_ack); return NULL; } // reconstruct lowest 24 bit of SeqAuth uint32_t seq = mesh_network_seq(network_pdu); uint32_t seq_auth = (seq & 0xffe000) | seq_zero; if (seq_auth > seq){ seq_auth -= 0x2000; } // no transport pdu active, check new message: seq auth is greater OR seq auth is same but no segments if (seq_auth > peer->seq_auth || (seq_auth == peer->seq_auth && peer->block_ack == 0)){ mesh_message_pdu_t * pdu = mesh_message_pdu_get(); if (!pdu) return NULL; // cache network pdu header (void)memcpy(pdu->network_header, network_pdu->data, 9); // store lower 24 bit of SeqAuth for App / Device Nonce big_endian_store_24(pdu->network_header, 2, seq_auth); // store meta data in new pdu pdu->netkey_index = network_pdu->netkey_index; pdu->block_ack = 0; pdu->acknowledgement_timer_active = 0; pdu->message_complete = 0; pdu->seq_zero = seq_zero; // update peer info peer->message_pdu = pdu; peer->seq_zero = seq_zero; peer->seq_auth = seq_auth; peer->block_ack = 0; #ifdef LOG_LOWER_TRANSPORT printf("mesh_transport_pdu_for_segmented_message: setup transport pdu %p for src %x, seq %06x, seq_zero %x\n", pdu, src, mesh_message_seq(pdu), seq_zero); #endif return peer->message_pdu; } else { // seq zero differs from current transport pdu #ifdef LOG_LOWER_TRANSPORT printf("mesh_transport_pdu_for_segmented_message: drop segment for old seq %x\n", seq_zero); #endif return NULL; } } static void mesh_lower_transport_process_segment( mesh_message_pdu_t * message_pdu, mesh_network_pdu_t * network_pdu){ uint8_t * lower_transport_pdu = mesh_network_pdu_data(network_pdu); uint8_t lower_transport_pdu_len = mesh_network_pdu_len(network_pdu); // get akf_aid & transmic message_pdu->akf_aid_control = lower_transport_pdu[0] & 0x7f; message_pdu->transmic_len = lower_transport_pdu[1] & 0x80 ? 8 : 4; // get seq_zero uint16_t seq_zero = ( big_endian_read_16(lower_transport_pdu, 1) >> 2) & 0x1fff; // get seg fields uint8_t seg_o = ( big_endian_read_16(lower_transport_pdu, 2) >> 5) & 0x001f; uint8_t seg_n = lower_transport_pdu[3] & 0x1f; uint8_t segment_len = lower_transport_pdu_len - 4; uint8_t * segment_data = &lower_transport_pdu[4]; #ifdef LOG_LOWER_TRANSPORT printf("mesh_lower_transport_process_segment: seq zero %04x, seg_o %02x, seg_n %02x, transmic len: %u\n", seq_zero, seg_o, seg_n, message_pdu->transmic_len * 8); mesh_print_hex("Segment", segment_data, segment_len); #endif // drop if already stored if ((message_pdu->block_ack & (1<block_ack |= (1<segments, (btstack_linked_item_t *) network_pdu); // last segment -> store len if (seg_o == seg_n){ message_pdu->len = (seg_n * 12) + segment_len; #ifdef LOG_LOWER_TRANSPORT printf("Assembled payload len %u\n", message_pdu->len); #endif } // check for complete int i; for (i=0;i<=seg_n;i++){ if ( (message_pdu->block_ack & (1<block_ack = message_pdu->block_ack; } // send ack mesh_lower_transport_send_ack_for_transport_pdu(message_pdu); // forward to upper transport mesh_lower_transport_queue_for_higher_layer((mesh_pdu_t *) message_pdu); // mark as done mesh_lower_transport_rx_segmented_message_complete(message_pdu); } static void mesh_lower_transport_process_network_pdu(mesh_network_pdu_t *network_pdu) {// segmented? if (mesh_network_segmented(network_pdu)){ mesh_message_pdu_t * message_pdu = mesh_lower_transport_pdu_for_segmented_message(network_pdu); if (message_pdu) { // start acknowledgment timer if inactive if (message_pdu->acknowledgement_timer_active == 0){ // - "The acknowledgment timer shall be set to a minimum of 150 + 50 * TTL milliseconds" uint32_t timeout = 150 + 50 * mesh_network_ttl(network_pdu); mesh_lower_transport_start_rx_acknowledgment_timer(message_pdu, timeout); } // restart incomplete timer mesh_lower_transport_incoming_restart_incomplete_timer(message_pdu, 10000, &mesh_lower_transport_rx_incomplete_timeout); mesh_lower_transport_process_segment(message_pdu, network_pdu); } else { mesh_network_message_processed_by_higher_layer(network_pdu); } } else { // control? if (mesh_network_control(network_pdu)){ // unsegmented control message (not encrypted) mesh_lower_transport_process_unsegmented_control_message(network_pdu); } else { // unsegmented access message (encrypted) mesh_lower_transport_queue_for_higher_layer((mesh_pdu_t *) network_pdu); } } } void mesh_lower_transport_message_processed_by_higher_layer(mesh_pdu_t * pdu){ btstack_assert(pdu == mesh_lower_transport_higher_layer_pdu); mesh_lower_transport_higher_layer_pdu = NULL; mesh_unsegmented_pdu_t * unsegmented_incoming_pdu = (mesh_unsegmented_pdu_t *) pdu; mesh_network_pdu_t * network_pdu; switch (pdu->pdu_type){ case MESH_PDU_TYPE_MESSAGE: // free segments mesh_lower_transport_report_segments_as_processed((mesh_message_pdu_t *) pdu); mesh_message_pdu_free((mesh_message_pdu_t *) pdu); break; case MESH_PDU_TYPE_UNSEGMENTED: network_pdu = unsegmented_incoming_pdu->segment; unsegmented_incoming_pdu->segment = NULL; mesh_network_message_processed_by_higher_layer(network_pdu); break; default: btstack_assert(0); break; } mesh_lower_transport_deliver_to_higher_layer(); } void mesh_lower_transport_received_message(mesh_network_callback_type_t callback_type, mesh_network_pdu_t *network_pdu){ mesh_peer_t * peer; uint16_t src; uint16_t seq; switch (callback_type){ case MESH_NETWORK_PDU_RECEIVED: src = mesh_network_src(network_pdu); seq = mesh_network_seq(network_pdu); peer = mesh_peer_for_addr(src); #ifdef LOG_LOWER_TRANSPORT printf("Transport: received message. SRC %x, SEQ %x\n", src, seq); #endif // validate seq if (peer && seq > peer->seq){ // track seq peer->seq = seq; // process mesh_lower_transport_process_network_pdu(network_pdu); mesh_lower_transport_run(); } else { // drop packet #ifdef LOG_LOWER_TRANSPORT printf("Transport: drop packet - src/seq auth failed\n"); #endif mesh_network_message_processed_by_higher_layer(network_pdu); } break; case MESH_NETWORK_PDU_SENT: mesh_lower_transport_network_pdu_sent(network_pdu); break; default: break; } } static void mesh_lower_transport_setup_segment(mesh_message_pdu_t *message_pdu, uint8_t seg_o, mesh_network_pdu_t *network_pdu){ int ctl = mesh_message_ctl(message_pdu); uint16_t max_segment_len = ctl ? 8 : 12; // control 8 bytes (64 bit NetMic), access 12 bytes (32 bit NetMIC) // use seq number from transport pdu once if MESH_TRANSPORT_FLAG_SEQ_RESERVED (to allow reserving seq number in upper transport while using all seq numbers) uint32_t seq; if ((message_pdu->flags & MESH_TRANSPORT_FLAG_SEQ_RESERVED) != 0){ message_pdu->flags &= ~(MESH_TRANSPORT_FLAG_SEQ_RESERVED); seq = mesh_message_seq(message_pdu); } else { seq = mesh_sequence_number_next(); } uint16_t seq_zero = mesh_message_seq(message_pdu) & 0x01fff; uint8_t seg_n = (message_pdu->len - 1) / max_segment_len; uint8_t szmic = ((!ctl) && (message_pdu->transmic_len == 8)) ? 1 : 0; // only 1 for access messages with 64 bit TransMIC uint8_t nid = mesh_message_nid(message_pdu); uint8_t ttl = mesh_message_ttl(message_pdu); uint16_t src = mesh_message_src(message_pdu); uint16_t dest = mesh_message_dest(message_pdu); // current segment. uint16_t seg_offset = seg_o * max_segment_len; uint8_t lower_transport_pdu_data[16]; lower_transport_pdu_data[0] = 0x80 | message_pdu->akf_aid_control; big_endian_store_24(lower_transport_pdu_data, 1, (szmic << 23) | (seq_zero << 10) | (seg_o << 5) | seg_n); uint16_t segment_len = btstack_min(message_pdu->len - seg_offset, max_segment_len); uint16_t lower_transport_pdu_len = 4 + segment_len; // find network-pdu with chunk for seg_offset mesh_network_pdu_t * chunk = (mesh_network_pdu_t *) lower_transport_outgoing_message->segments; uint16_t chunk_start = 0; while ((chunk_start + MESH_NETWORK_PAYLOAD_MAX) <= seg_offset){ chunk = (mesh_network_pdu_t *) chunk->pdu_header.item.next; chunk_start += MESH_NETWORK_PAYLOAD_MAX; } // first part uint16_t chunk_offset = seg_offset - chunk_start; uint16_t bytes_to_copy = btstack_min(MESH_NETWORK_PAYLOAD_MAX - chunk_offset, segment_len); (void)memcpy(&lower_transport_pdu_data[4], &chunk->data[chunk_offset], bytes_to_copy); segment_len -= bytes_to_copy; // second part if (segment_len > 0){ chunk = (mesh_network_pdu_t *) chunk->pdu_header.item.next; (void)memcpy(&lower_transport_pdu_data[4+bytes_to_copy], &chunk->data[0], segment_len); } mesh_network_setup_pdu(network_pdu, message_pdu->netkey_index, nid, 0, ttl, seq, src, dest, lower_transport_pdu_data, lower_transport_pdu_len); } static void mesh_lower_transport_send_next_segment(void){ if (!lower_transport_outgoing_message) return; #ifdef LOG_LOWER_TRANSPORT printf("[+] Lower Transport, segmented pdu %p, seq %06x: send next segment\n", lower_transport_outgoing_message, mesh_message_seq(lower_transport_outgoing_message)); #endif int ctl = mesh_message_ctl(lower_transport_outgoing_message); uint16_t max_segment_len = ctl ? 8 : 12; // control 8 bytes (64 bit NetMic), access 12 bytes (32 bit NetMIC) uint8_t seg_n = (lower_transport_outgoing_message->len - 1) / max_segment_len; // find next unacknowledged segement while ((lower_transport_outgoing_seg_o <= seg_n) && ((lower_transport_outgoing_message->block_ack & (1 << lower_transport_outgoing_seg_o)) == 0)){ lower_transport_outgoing_seg_o++; } if (lower_transport_outgoing_seg_o > seg_n){ #ifdef LOG_LOWER_TRANSPORT printf("[+] Lower Transport, segmented pdu %p, seq %06x: send complete (dst %x)\n", lower_transport_outgoing_message, mesh_message_seq(lower_transport_outgoing_message), mesh_message_dest(lower_transport_outgoing_message)); #endif lower_transport_outgoing_seg_o = 0; // done for unicast, ack timer already set, too if (mesh_network_address_unicast(mesh_message_dest(lower_transport_outgoing_message))) return; // done, more? if (lower_transport_retry_count == 0){ #ifdef LOG_LOWER_TRANSPORT printf("[+] Lower Transport, message unacknowledged -> free\n"); #endif // notify upper transport mesh_lower_transport_outgoing_complete(); return; } // start retry #ifdef LOG_LOWER_TRANSPORT printf("[+] Lower Transport, message unacknowledged retry count %u\n", lower_transport_retry_count); #endif lower_transport_retry_count--; } // restart segment transmission timer for unicast dst if (mesh_network_address_unicast(mesh_message_dest(lower_transport_outgoing_message))){ mesh_lower_transport_tx_restart_segment_transmission_timer(); } mesh_lower_transport_setup_segment(lower_transport_outgoing_message, lower_transport_outgoing_seg_o, lower_transport_outgoing_segment); #ifdef LOG_LOWER_TRANSPORT printf("[+] Lower Transport, segmented pdu %p, seq %06x: send seg_o %x, seg_n %x\n", lower_transport_outgoing_message, mesh_message_seq(lower_transport_outgoing_message), lower_transport_outgoing_seg_o, seg_n); mesh_print_hex("LowerTransportPDU", &lower_transport_outgoing_segment->data[9], lower_transport_outgoing_segment->len-9); #endif // next segment lower_transport_outgoing_seg_o++; // send network pdu lower_transport_outgoing_segment_queued = 1; mesh_network_send_pdu(lower_transport_outgoing_segment); } static void mesh_lower_transport_setup_sending_segmented_pdus(void){ printf("[+] Lower Transport, segmented pdu %p, seq %06x: send retry count %u\n", lower_transport_outgoing_message, mesh_message_seq(lower_transport_outgoing_message), lower_transport_retry_count); lower_transport_retry_count--; lower_transport_outgoing_seg_o = 0; } static void mesh_lower_transport_segment_transmission_fired(void){ // once more? if (lower_transport_retry_count == 0){ printf("[!] Lower transport, segmented pdu %p, seq %06x: send failed, retries exhausted\n", lower_transport_outgoing_message, mesh_message_seq(lower_transport_outgoing_message)); mesh_lower_transport_outgoing_complete(); return; } #ifdef LOG_LOWER_TRANSPORT printf("[+] Lower transport, segmented pdu %p, seq %06x: transmission fired\n", lower_transport_outgoing_message, mesh_message_seq(lower_transport_outgoing_message) ); #endif // send remaining segments again mesh_lower_transport_setup_sending_segmented_pdus(); // send next segment mesh_lower_transport_send_next_segment(); } static void mesh_lower_transport_network_pdu_sent(mesh_network_pdu_t *network_pdu){ // figure out what pdu was sent // single segment? if (lower_transport_outgoing_segment == network_pdu){ btstack_assert(lower_transport_outgoing_message != NULL); if (lower_transport_outgoing_message->segmented == false){ // of unsegmented message mesh_message_pdu_t * message_pdu = lower_transport_outgoing_message; lower_transport_outgoing_message = NULL; lower_transport_outgoing_segment = NULL; higher_layer_handler(MESH_TRANSPORT_PDU_SENT, MESH_TRANSPORT_STATUS_SUCCESS, (mesh_pdu_t *) message_pdu); return; } else { // of segmented message #ifdef LOG_LOWER_TRANSPORT printf("[+] Lower transport, segmented pdu %p, seq %06x: network pdu %p sent\n", lower_transport_outgoing_message, mesh_message_seq(lower_transport_outgoing_message), network_pdu); #endif lower_transport_outgoing_segment_queued = 0; if (lower_transport_outgoing_trasnmission_complete){ // handle complete lower_transport_outgoing_trasnmission_complete = 0; lower_transport_outgoing_transmission_timeout = 0; mesh_lower_transport_outgoing_complete(); return; } if (lower_transport_outgoing_transmission_timeout){ // handle timeout lower_transport_outgoing_transmission_timeout = 0; mesh_lower_transport_segment_transmission_fired(); return; } // send next segment mesh_lower_transport_send_next_segment(); } return; } // Segment Acknowledgment message sent by us? if (mesh_network_control(network_pdu) && network_pdu->data[0] == 0){ btstack_memory_mesh_network_pdu_free(network_pdu); return; } // Unsegmented message if (lower_transport_outgoing_unsegmented_pdu != NULL){ mesh_unsegmented_pdu_t * unsegmented_pdu = lower_transport_outgoing_unsegmented_pdu; lower_transport_outgoing_unsegmented_pdu = NULL; higher_layer_handler(MESH_TRANSPORT_PDU_SENT, MESH_TRANSPORT_STATUS_SUCCESS, (mesh_pdu_t *) unsegmented_pdu); return; } // other higher_layer_handler(MESH_TRANSPORT_PDU_SENT, MESH_TRANSPORT_STATUS_SUCCESS, (mesh_pdu_t *) network_pdu); } static void mesh_lower_transport_setup_block_ack(mesh_message_pdu_t *message_pdu){ // setup block ack - set bit for segment to send, will be cleared on ack int ctl = mesh_message_ctl(message_pdu); uint16_t max_segment_len = ctl ? 8 : 12; // control 8 bytes (64 bit NetMic), access 12 bytes (32 bit NetMIC) uint8_t seg_n = (message_pdu->len - 1) / max_segment_len; if (seg_n < 31){ message_pdu->block_ack = (1 << (seg_n+1)) - 1; } else { message_pdu->block_ack = 0xffffffff; } } void mesh_lower_transport_send_pdu(mesh_pdu_t *pdu){ mesh_unsegmented_pdu_t * unsegmented_pdu; mesh_network_pdu_t * network_pdu; switch (pdu->pdu_type){ case MESH_PDU_TYPE_UNSEGMENTED: unsegmented_pdu = (mesh_unsegmented_pdu_t *) pdu; network_pdu = unsegmented_pdu->segment; btstack_assert(network_pdu->len >= 9); break; case MESH_PDU_TYPE_MESSAGE: break; default: btstack_assert(false); break; } btstack_linked_list_add_tail(&lower_transport_outgoing, (btstack_linked_item_t*) pdu); mesh_lower_transport_run(); } static void mesh_lower_transport_segment_transmission_timeout(btstack_timer_source_t * ts){ UNUSED(ts); #ifdef LOG_LOWER_TRANSPORT printf("[+] Lower transport, segmented pdu %p, seq %06x: transmission timer fired\n", lower_transport_outgoing_message, mesh_message_seq(lower_transport_outgoing_message)); #endif lower_transport_outgoing_message->acknowledgement_timer_active = 0; if (lower_transport_outgoing_segment_queued){ lower_transport_outgoing_transmission_timeout = 1; } else { mesh_lower_transport_segment_transmission_fired(); } } static void mesh_lower_transport_run(void){ // check if outgoing segmented pdu is active if (lower_transport_outgoing_message) return; while(!btstack_linked_list_empty(&lower_transport_outgoing)) { // get next message mesh_network_pdu_t * network_pdu; mesh_message_pdu_t * message_pdu; mesh_pdu_t * pdu = (mesh_pdu_t *) btstack_linked_list_pop(&lower_transport_outgoing); switch (pdu->pdu_type) { case MESH_PDU_TYPE_UNSEGMENTED: lower_transport_outgoing_unsegmented_pdu = (mesh_unsegmented_pdu_t *) pdu; network_pdu = lower_transport_outgoing_unsegmented_pdu->segment; mesh_network_send_pdu(network_pdu); break; case MESH_PDU_TYPE_MESSAGE: message_pdu = (mesh_message_pdu_t *) pdu; if (message_pdu->segmented){ // printf("[+] Lower transport, segmented pdu %p, seq %06x: run start sending now\n", message_pdu, mesh_message_seq(message_pdu)); // start sending segmented pdu lower_transport_retry_count = 3; lower_transport_outgoing_message = message_pdu; lower_transport_outgoing_transmission_timeout = 0; lower_transport_outgoing_trasnmission_complete = 0; mesh_lower_transport_setup_block_ack(message_pdu); mesh_lower_transport_setup_sending_segmented_pdus(); mesh_lower_transport_send_next_segment(); } else { btstack_assert(false); network_pdu = (mesh_network_pdu_t *) btstack_linked_list_get_first_item(&message_pdu->segments); lower_transport_outgoing_message = message_pdu; lower_transport_outgoing_segment = network_pdu; mesh_network_send_pdu(network_pdu); } break; default: btstack_assert(false); break; } } } static void mesh_lower_transport_dump_network_pdus(const char *name, btstack_linked_list_t *list){ printf("List: %s:\n", name); btstack_linked_list_iterator_t it; btstack_linked_list_iterator_init(&it, list); while (btstack_linked_list_iterator_has_next(&it)){ mesh_network_pdu_t * network_pdu = (mesh_network_pdu_t*) btstack_linked_list_iterator_next(&it); printf("- %p: ", network_pdu); printf_hexdump(network_pdu->data, network_pdu->len); } } static void mesh_lower_transport_reset_network_pdus(btstack_linked_list_t *list){ while (!btstack_linked_list_empty(list)){ mesh_network_pdu_t * pdu = (mesh_network_pdu_t *) btstack_linked_list_pop(list); btstack_memory_mesh_network_pdu_free(pdu); } } bool mesh_lower_transport_can_send_to_dest(uint16_t dest){ UNUSED(dest); return (lower_transport_outgoing_message == NULL) && btstack_linked_list_empty(&lower_transport_outgoing); } void mesh_lower_transport_reserve_slot(void){ } void mesh_lower_transport_dump(void){ } void mesh_lower_transport_reset(void){ if (lower_transport_outgoing_message){ while (!btstack_linked_list_empty(&lower_transport_outgoing_message->segments)){ mesh_network_pdu_t * network_pdu = (mesh_network_pdu_t *) btstack_linked_list_pop(&lower_transport_outgoing_message->segments); mesh_network_pdu_free(network_pdu); } lower_transport_outgoing_message = NULL; } mesh_network_pdu_free(lower_transport_outgoing_segment); lower_transport_outgoing_segment_queued = 0; lower_transport_outgoing_segment = NULL; } void mesh_lower_transport_init(){ // register with network layer mesh_network_set_higher_layer_handler(&mesh_lower_transport_received_message); // allocate network_pdu for segmentation lower_transport_outgoing_segment_queued = 0; lower_transport_outgoing_segment = mesh_network_pdu_get(); } void mesh_lower_transport_set_higher_layer_handler(void (*pdu_handler)( mesh_transport_callback_type_t callback_type, mesh_transport_status_t status, mesh_pdu_t * pdu)){ higher_layer_handler = pdu_handler; } // buffer pool mesh_transport_pdu_t * mesh_transport_pdu_get(void){ mesh_transport_pdu_t * transport_pdu = btstack_memory_mesh_transport_pdu_get(); if (transport_pdu){ transport_pdu->pdu_header.pdu_type = MESH_PDU_TYPE_TRANSPORT; } return transport_pdu; } void mesh_transport_pdu_free(mesh_transport_pdu_t * transport_pdu){ btstack_memory_mesh_transport_pdu_free(transport_pdu); }