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