xref: /btstack/src/btstack_debug.h (revision a8d51f092f1b660d0f6921369ad2bc3f9368296c)
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 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 /*
39  *  btstack_debug.h
40  *
41  *  allow to funnel debug & error messages
42  */
43 
44 #ifndef DEBUG_H
45 #define DEBUG_H
46 
47 #include "btstack_config.h"
48 #include "btstack_defines.h"
49 #include "hci_dump.h"
50 
51 #include <stdio.h>
52 
53 #ifdef __AVR__
54 #include <avr/pgmspace.h>
55 #endif
56 
57 #ifdef HAVE_ASSERT
58 #include <assert.h>
59 #endif
60 
61 // fallback to __FILE__ for untagged files
62 #ifndef BTSTACK_FILE__
63 #define BTSTACK_FILE__ __FILE__
64 #endif
65 
66 #ifdef HAVE_ASSERT
67 // map to libc assert
68 #define btstack_assert(condition)  assert(condition)
69 #else /* HAVE_ASSERT */
70 #ifdef ENABLE_BTSTACK_ASSERT
71 void btstack_assert_failed(const char * file, uint16_t line_nr);
72 #ifndef btstack_assert
73 // use btstack macro that calls btstack_assert_failed() - provided by port
74 #define btstack_assert(condition)         if (condition) {} else { btstack_assert_failed(BTSTACK_FILE__, __LINE__);  }
75 #endif
76 #else /* btstack_assert */
77 // asserts off
78 #define btstack_assert(condition)         {}
79 #endif
80 #endif
81 
82 // allow to provide port specific printf
83 #ifndef BTSTACK_PRINTF
84 #ifdef __AVR__
85 #define BTSTACK_PRINTF(format, ...)          printf_P(PSTR(format), ## __VA_ARGS__)
86 #else
87 #define BTSTACK_PRINTF(format, ...)          printf(format, ## __VA_ARGS__)
88 #endif
89 #endif
90 
91 #ifdef __AVR__
92 #define HCI_DUMP_LOG(log_level, format, ...) hci_dump_log_P(log_level, PSTR("%s.%u: " format), BTSTACK_FILE__, __LINE__, ## __VA_ARGS__)
93 #else
94 #define HCI_DUMP_LOG(log_level, format, ...) hci_dump_log(log_level, "%s.%u: " format, BTSTACK_FILE__, __LINE__, ## __VA_ARGS__)
95 #endif
96 
97 #ifdef ENABLE_LOG_DEBUG
98 #define log_debug(format, ...)  HCI_DUMP_LOG(HCI_DUMP_LOG_LEVEL_DEBUG, format,  ## __VA_ARGS__)
99 #else
100 #define log_debug(...) (void)(0)
101 #endif
102 
103 #ifdef ENABLE_LOG_INFO
104 #define log_info(format, ...)  HCI_DUMP_LOG(HCI_DUMP_LOG_LEVEL_INFO, format,  ## __VA_ARGS__)
105 #else
106 #define log_info(...) (void)(0)
107 #endif
108 
109 #ifdef ENABLE_LOG_ERROR
110 #define log_error(format, ...)  HCI_DUMP_LOG(HCI_DUMP_LOG_LEVEL_ERROR, format,  ## __VA_ARGS__)
111 #else
112 #define log_error(...) (void)(0)
113 #endif
114 
115 /**
116  * @brief Log Security Manager key via log_info
117  * @param key to log
118  */
119 void log_info_key(const char * name, sm_key_t key);
120 
121 /**
122  * @brief Hexdump via log_info
123  * @param data
124  * @param size
125  */
126 void log_info_hexdump(const void *data, int size);
127 
128 /**
129  * @brief Hexdump via log_debug * @param data
130  * @param size
131  */
132 void log_debug_hexdump(const void *data, int size);
133 
134 #endif // DEBUG_H
135