xref: /btstack/platform/embedded/hci_dump_embedded_stdout.c (revision c824d78c0a34df89b57d535abafcc7dacf30bb06)
1 /*
2  * Copyright (C) 2014 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_embedded_stdout.c"
39 
40 /*
41  *  Dump HCI trace on stdout
42  */
43 
44 #include "btstack_config.h"
45 
46 #include "hci_dump_embedded_stdout.h"
47 #include "btstack_run_loop.h"
48 #include "hci.h"
49 
50 #include <stdio.h>
51 
52 #ifndef ENABLE_PRINTF_HEXDUMP
53 #error "HCI Dump on stdout requires ENABLE_PRINTF_HEXDUMP to be defined. Use different hci dump implementation or add ENABLE_PRINTF_HEXDUMP to btstack_config.h"
54 #endif
55 
56 static char log_message_buffer[256];
57 
58 static void hci_dump_embedded_stdout_timestamp(void){
59     uint32_t time_ms = btstack_run_loop_get_time_ms();
60     int      seconds = time_ms / 1000u;
61     int      minutes = seconds / 60;
62     unsigned int hours = minutes / 60;
63 
64     uint16_t p_ms      = time_ms - (seconds * 1000u);
65     uint16_t p_seconds = seconds - (minutes * 60);
66     uint16_t p_minutes = minutes - (hours   * 60u);
67     printf("[%02u:%02u:%02u.%03u] ", hours, p_minutes, p_seconds, p_ms);
68 }
69 
70 static void hci_dump_embedded_stdout_packet(uint8_t packet_type, uint8_t in, uint8_t * packet, uint16_t len){
71     switch (packet_type){
72         case HCI_COMMAND_DATA_PACKET:
73             printf("CMD => ");
74             break;
75         case HCI_EVENT_PACKET:
76             printf("EVT <= ");
77             break;
78         case HCI_ACL_DATA_PACKET:
79 #ifdef HCI_DUMP_STDOUT_MAX_SIZE_ACL
80             if (len > HCI_DUMP_STDOUT_MAX_SIZE_ACL){
81                 printf("LOG -- ACL %s, size %u\n", in ? "in" : "out", len);
82                 return;
83             }
84 #endif
85             if (in) {
86                 printf("ACL <= ");
87             } else {
88                 printf("ACL => ");
89             }
90             break;
91         case HCI_SCO_DATA_PACKET:
92 #ifdef HCI_DUMP_STDOUT_MAX_SIZE_SCO
93             if (len > HCI_DUMP_STDOUT_MAX_SIZE_SCO){
94                 printf("LOG -- SCO %s, size %u\n", in ? "in" : "out", len);
95                 return;
96             }
97 #endif
98             if (in) {
99                 printf("SCO <= ");
100             } else {
101                 printf("SCO => ");
102             }
103             break;
104         case HCI_ISO_DATA_PACKET:
105 #ifdef HCI_DUMP_STDOUT_MAX_SIZE_ISO
106             if (len > HCI_DUMP_STDOUT_MAX_SIZE_ISO){
107                 printf("LOG -- ISO %s, size %u\n", in ? "in" : "out", len);
108                 return;
109             }
110 #endif
111             if (in) {
112                 printf("ISO <= ");
113             } else {
114                 printf("ISO => ");
115             }
116             break;
117         case LOG_MESSAGE_PACKET:
118             printf("LOG -- %s\n", (char*) packet);
119             return;
120         default:
121             return;
122     }
123     printf_hexdump(packet, len);
124 }
125 
126 static void hci_dump_embedded_stdout_log_packet(uint8_t packet_type, uint8_t in, uint8_t *packet, uint16_t len) {
127     hci_dump_embedded_stdout_timestamp();
128     hci_dump_embedded_stdout_packet(packet_type, in, packet, len);
129 }
130 
131 static void hci_dump_embedded_stdout_log_message(int log_level, const char * format, va_list argptr){
132     UNUSED(log_level);
133     int len = vsnprintf(log_message_buffer, sizeof(log_message_buffer), format, argptr);
134     hci_dump_embedded_stdout_log_packet(LOG_MESSAGE_PACKET, 0, (uint8_t*) log_message_buffer, len);
135 }
136 
137 #ifdef __AVR__
138 void hci_dump_embedded_stdout_log_message_P(int log_level, PGM_P * format, va_list argptr){
139     hci_dump_embedded_stdout_timestamp();
140     printf_P(PSTR("LOG -- "));
141     vfprintf_P(stdout, format, argptr);
142     printf_P(PSTR("\n"));
143 }
144 #endif
145 
146 const hci_dump_t * hci_dump_embedded_stdout_get_instance(void){
147     static const hci_dump_t hci_dump_instance = {
148         // void (*reset)(void);
149         NULL,
150         // void (*log_packet)(uint8_t packet_type, uint8_t in, uint8_t *packet, uint16_t len);
151         &hci_dump_embedded_stdout_log_packet,
152         // void (*log_message)(int log_level, const char * format, va_list argptr);
153         &hci_dump_embedded_stdout_log_message,
154 #ifdef __AVR__ \
155         // void (*log_message_P)(int log_level, PGM_P * format, va_list argptr);
156         &hci_dump_embedded_stdout_log_message_P,
157 #endif
158     };
159     return &hci_dump_instance;
160 }
161