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 /** 39 * @title Debug Messages 40 * 41 * Allow to funnel debug and error messages. 42 * 43 */ 44 45 #ifndef DEBUG_H 46 #define DEBUG_H 47 48 #include "btstack_config.h" 49 #include "btstack_defines.h" 50 #include "hci_dump.h" 51 52 #if defined __cplusplus 53 extern "C" { 54 #endif 55 56 #ifdef __AVR__ 57 #include <avr/pgmspace.h> 58 #endif 59 60 #ifdef HAVE_ASSERT 61 #ifndef btstack_assert 62 #include <assert.h> 63 #endif 64 #endif 65 66 // fallback to __FILE__ for untagged files 67 #ifndef BTSTACK_FILE__ 68 #define BTSTACK_FILE__ __FILE__ 69 #endif 70 71 #ifdef HAVE_ASSERT 72 // allow to override btstack_assert in btstack_config.h 73 #ifndef btstack_assert 74 // map to libc assert 75 #define btstack_assert(condition) assert(condition) 76 #endif /* btstack_assert */ 77 #else /* HAVE_ASSERT */ 78 #ifdef ENABLE_BTSTACK_ASSERT 79 #include <stdnoreturn.h> 80 noreturn void btstack_assert_failed(const char * file, uint16_t line_nr); 81 #ifndef btstack_assert 82 // use btstack macro that calls btstack_assert_failed() - provided by port 83 #define btstack_assert(condition) if (condition) {} else { btstack_assert_failed(BTSTACK_FILE__, __LINE__); } 84 #endif 85 #else /* ENABLE_BTSTACK_ASSERT */ 86 // asserts off 87 #define btstack_assert(condition) {(void)(condition);} 88 #endif /* btstack_assert */ 89 #endif /* HAVE_ASSERT */ 90 91 // mark code that should not be reached. Similar to assert, but mapped to NOP for coverage 92 #ifdef UNIT_TEST 93 #define btstack_unreachable() 94 #else 95 #define btstack_unreachable() btstack_assert(false) 96 #endif 97 98 // allow to provide port specific printf 99 #ifndef BTSTACK_PRINTF 100 #ifdef __AVR__ 101 #define BTSTACK_PRINTF(format, ...) printf_P(PSTR(format), ## __VA_ARGS__) 102 #else 103 #define BTSTACK_PRINTF(...) printf( __VA_ARGS__) 104 #endif 105 #endif 106 107 #ifdef __AVR__ 108 #define HCI_DUMP_LOG_PRINTF(log_level, format, ...) hci_dump_log_P(log_level, PSTR("%S.%u: " format), PSTR(BTSTACK_FILE__), __LINE__, ## __VA_ARGS__) 109 #define HCI_DUMP_LOG_PUTS(log_level, format) hci_dump_log_P(log_level, PSTR("%S.%u: " format), PSTR(BTSTACK_FILE__), __LINE__) 110 #else 111 #define HCI_DUMP_LOG_PRINTF(log_level, format, ...) hci_dump_log(log_level, "%s.%u: " format, BTSTACK_FILE__, __LINE__, ## __VA_ARGS__) 112 #define HCI_DUMP_LOG_PUTS(log_level, format) hci_dump_log(log_level, "%s.%u: " format, BTSTACK_FILE__, __LINE__); 113 #endif 114 115 #ifdef _MSC_VER 116 117 // original version that requires GNU Macro extensions, but works with Visual Studio 2022 118 119 #define HCI_DUMP_LOG HCI_DUMP_LOG_PRINTF 120 121 #ifdef ENABLE_LOG_DEBUG 122 #define log_debug(format, ...) HCI_DUMP_LOG(HCI_DUMP_LOG_LEVEL_DEBUG, format, ## __VA_ARGS__) 123 #else 124 #define log_debug(...) (void)(0) 125 #endif 126 127 #ifdef ENABLE_LOG_INFO 128 #define log_info(format, ...) HCI_DUMP_LOG(HCI_DUMP_LOG_LEVEL_INFO, format, ## __VA_ARGS__) 129 #else 130 #define log_info(...) (void)(0) 131 #endif 132 133 #ifdef ENABLE_LOG_ERROR 134 #define log_error(format, ...) HCI_DUMP_LOG(HCI_DUMP_LOG_LEVEL_ERROR, format, ## __VA_ARGS__) 135 #else 136 #define log_error(...) (void)(0) 137 #endif 138 139 #else /* _MSC_VER */ 140 141 // C99 Pedantic version - does not work for Visual Studio 2022 142 143 #define GET_LOGGER_TYPE_FOR_ARG_COUNT( _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, NAME, ... ) NAME 144 145 #define HCI_DUMP_LOG( ... ) GET_LOGGER_TYPE_FOR_ARG_COUNT(__VA_ARGS__, HCI_DUMP_LOG_PRINTF, HCI_DUMP_LOG_PRINTF, HCI_DUMP_LOG_PRINTF, HCI_DUMP_LOG_PRINTF, HCI_DUMP_LOG_PRINTF, HCI_DUMP_LOG_PRINTF, HCI_DUMP_LOG_PRINTF, HCI_DUMP_LOG_PRINTF, HCI_DUMP_LOG_PRINTF, HCI_DUMP_LOG_PRINTF, HCI_DUMP_LOG_PUTS, UNUSED)( __VA_ARGS__ ) 146 147 #ifdef ENABLE_LOG_DEBUG 148 #define log_debug(...) HCI_DUMP_LOG(HCI_DUMP_LOG_LEVEL_DEBUG, ## __VA_ARGS__) 149 #else 150 #define log_debug(...) (void)(0) 151 #endif 152 153 #ifdef ENABLE_LOG_INFO 154 #define log_info(...) HCI_DUMP_LOG(HCI_DUMP_LOG_LEVEL_INFO, ## __VA_ARGS__) 155 #else 156 #define log_info(...) (void)(0) 157 #endif 158 159 #ifdef ENABLE_LOG_ERROR 160 #define log_error(...) HCI_DUMP_LOG(HCI_DUMP_LOG_LEVEL_ERROR, ## __VA_ARGS__) 161 #else 162 #define log_error(...) (void)(0) 163 #endif 164 165 #endif /* _MSC_VER */ 166 167 168 /* API_START */ 169 170 /** 171 * @brief Log Security Manager key via log_info 172 * @param name 173 * @param key to log 174 */ 175 void log_info_key(const char * name, sm_key_t key); 176 177 /** 178 * @brief Hexdump via log_info 179 * @param data 180 * @param size 181 */ 182 void log_info_hexdump(const void *data, int size); 183 184 /** 185 * @brief Hexdump via log_debug 186 * @param data 187 * @param size 188 */ 189 void log_debug_hexdump(const void *data, int size); 190 191 /* API_END */ 192 193 #if defined __cplusplus 194 } 195 #endif 196 197 #endif // DEBUG_H 198