1 /* 2 * Copyright (C) 2014-2020 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__ "hci_dump_segger_rtt_binary.c" 39 40 /** 41 * Dump HCI trace on SEGGER RTT Logging Channel #1 42 */ 43 #include "btstack_config.h" 44 45 #include "hci_dump_segger_rtt_binary.h" 46 47 #include "btstack_debug.h" 48 #include "hci.h" 49 50 #include "SEGGER_RTT.h" 51 52 // allow to configure mode, channel, up buffer size in btstack_config.h 53 #ifndef SEGGER_RTT_PACKETLOG_MODE 54 #define SEGGER_RTT_PACKETLOG_MODE SEGGER_RTT_MODE_DEFAULT 55 #endif 56 #ifndef SEGGER_RTT_PACKETLOG_BUFFER_SIZE 57 #define SEGGER_RTT_PACKETLOG_BUFFER_SIZE 1024 58 #endif 59 #ifndef SEGGER_RTT_PACKETLOG_CHANNEL 60 #define SEGGER_RTT_PACKETLOG_CHANNEL 1 61 #endif 62 63 static char segger_rtt_packetlog_buffer[SEGGER_RTT_PACKETLOG_BUFFER_SIZE]; 64 65 static int dump_format; 66 static char log_message_buffer[256]; 67 68 static void hci_dump_segger_rtt_binary_log_packet(uint8_t packet_type, uint8_t in, uint8_t *packet, uint16_t len) { 69 if (dump_format == HCI_DUMP_INVALID) return; 70 71 static union { 72 uint8_t header_bluez[HCI_DUMP_HEADER_SIZE_BLUEZ]; 73 uint8_t header_packetlogger[HCI_DUMP_HEADER_SIZE_PACKETLOGGER]; 74 } header; 75 76 uint32_t time_ms = btstack_run_loop_get_time_ms(); 77 uint32_t tv_sec = time_ms / 1000u; 78 uint32_t tv_us = (time_ms - (tv_sec * 1000)) * 1000; 79 // Saturday, January 1, 2000 12:00:00 80 tv_sec += 946728000UL; 81 82 #if (SEGGER_RTT_PACKETLOG_MODE == SEGGER_RTT_MODE_NO_BLOCK_SKIP) 83 static const char rtt_warning[] = "RTT buffer full - packet(s) skipped"; 84 static bool rtt_packet_skipped = false; 85 if (rtt_packet_skipped){ 86 // try to write warning log message 87 rtt_packet_skipped = false; 88 packet_type = LOG_MESSAGE_PACKET; 89 packet = (uint8_t *) &rtt_warning[0]; 90 len = sizeof(rtt_warning)-1; 91 } 92 #endif 93 94 uint16_t header_len = 0; 95 switch (dump_format){ 96 case HCI_DUMP_BLUEZ: 97 hci_dump_setup_header_bluez(header.header_bluez, tv_sec, tv_us, packet_type, in, len); 98 header_len = HCI_DUMP_HEADER_SIZE_BLUEZ; 99 break; 100 case HCI_DUMP_PACKETLOGGER: 101 hci_dump_setup_header_packetlogger(header.header_packetlogger, tv_sec, tv_us, packet_type, in, len); 102 header_len = HCI_DUMP_HEADER_SIZE_PACKETLOGGER; 103 break; 104 default: 105 return; 106 } 107 108 #if (SEGGER_RTT_PACKETLOG_MODE == SEGGER_RTT_MODE_NO_BLOCK_SKIP) 109 // check available space in buffer to avoid writing header but not packet 110 unsigned space_free = SEGGER_RTT_GetAvailWriteSpace(SEGGER_RTT_PACKETLOG_CHANNEL); 111 if ((header_len + len) > space_free) { 112 rtt_packet_skipped = true; 113 return; 114 } 115 #endif 116 117 // write complete header and payload 118 SEGGER_RTT_Write(SEGGER_RTT_PACKETLOG_CHANNEL, &header, header_len); 119 SEGGER_RTT_Write(SEGGER_RTT_PACKETLOG_CHANNEL, packet, len); 120 } 121 122 static void hci_dump_segger_rtt_binary_log_message(const char * format, va_list argptr){ 123 if (dump_format == HCI_DUMP_INVALID) return; 124 int len = vsnprintf(log_message_buffer, sizeof(log_message_buffer), format, argptr); 125 hci_dump_segger_rtt_binary_log_packet(LOG_MESSAGE_PACKET, 0, (uint8_t*) log_message_buffer, len); 126 } 127 128 // 129 130 void hci_dump_segger_rtt_binary_open(hci_dump_format_t format){ 131 btstack_assert(format == HCI_DUMP_BLUEZ || format == HCI_DUMP_PACKETLOGGER); 132 dump_format = format; 133 SEGGER_RTT_ConfigUpBuffer(SEGGER_RTT_PACKETLOG_CHANNEL, "hci_dump", &segger_rtt_packetlog_buffer[0], SEGGER_RTT_PACKETLOG_BUFFER_SIZE, SEGGER_RTT_PACKETLOG_MODE); 134 } 135 136 const hci_dump_t * hci_dump_segger_rtt_binary_get_instance(void){ 137 static const hci_dump_t hci_dump_instance = { 138 // void (*reset)(void); 139 NULL, 140 // void (*log_packet)(uint8_t packet_type, uint8_t in, uint8_t *packet, uint16_t len); 141 &hci_dump_segger_rtt_binary_log_packet, 142 // void (*log_message)(int log_level, const char * format, va_list argptr); 143 &hci_dump_segger_rtt_binary_log_message, 144 }; 145 return &hci_dump_instance; 146 } 147