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 #ifdef __AVR__ 53 #include <avr/pgmspace.h> 54 #endif 55 56 #ifdef HAVE_ASSERT 57 #ifndef btstack_assert 58 #include <assert.h> 59 #endif 60 #endif 61 62 // fallback to __FILE__ for untagged files 63 #ifndef BTSTACK_FILE__ 64 #define BTSTACK_FILE__ __FILE__ 65 #endif 66 67 #ifdef HAVE_ASSERT 68 // allow to override btstack_assert in btstack_config.h 69 #ifndef btstack_assert 70 // map to libc assert 71 #define btstack_assert(condition) assert(condition) 72 #endif /* btstack_assert */ 73 #else /* HAVE_ASSERT */ 74 #ifdef ENABLE_BTSTACK_ASSERT 75 void btstack_assert_failed(const char * file, uint16_t line_nr); 76 #ifndef btstack_assert 77 // use btstack macro that calls btstack_assert_failed() - provided by port 78 #define btstack_assert(condition) if (condition) {} else { btstack_assert_failed(BTSTACK_FILE__, __LINE__); } 79 #endif 80 #else /* ENABLE_BTSTACK_ASSERT */ 81 // asserts off 82 #define btstack_assert(condition) {} 83 #endif /* btstack_assert */ 84 #endif /* HAVE_ASSERT */ 85 86 // mark code that should not be reached. Similar to assert, but mapped to NOP for coverage 87 #ifdef UNIT_TEST 88 #define btstack_unreachable() 89 #else 90 #define btstack_unreachable() btstack_assert(false) 91 #endif 92 93 // allow to provide port specific printf 94 #ifndef BTSTACK_PRINTF 95 #ifdef __AVR__ 96 #define BTSTACK_PRINTF(format, ...) printf_P(PSTR(format), ## __VA_ARGS__) 97 #else 98 #define BTSTACK_PRINTF(format, ...) printf(format, ## __VA_ARGS__) 99 #endif 100 #endif 101 102 #ifdef __AVR__ 103 #define HCI_DUMP_LOG(log_level, format, ...) hci_dump_log_P(log_level, PSTR("%S.%u: " format), PSTR(BTSTACK_FILE__), __LINE__, ## __VA_ARGS__) 104 #else 105 #define HCI_DUMP_LOG(log_level, format, ...) hci_dump_log(log_level, "%s.%u: " format, BTSTACK_FILE__, __LINE__, ## __VA_ARGS__) 106 #endif 107 108 #ifdef ENABLE_LOG_DEBUG 109 #define log_debug(format, ...) HCI_DUMP_LOG(HCI_DUMP_LOG_LEVEL_DEBUG, format, ## __VA_ARGS__) 110 #else 111 #define log_debug(...) (void)(0) 112 #endif 113 114 #ifdef ENABLE_LOG_INFO 115 #define log_info(format, ...) HCI_DUMP_LOG(HCI_DUMP_LOG_LEVEL_INFO, format, ## __VA_ARGS__) 116 #else 117 #define log_info(...) (void)(0) 118 #endif 119 120 #ifdef ENABLE_LOG_ERROR 121 #define log_error(format, ...) HCI_DUMP_LOG(HCI_DUMP_LOG_LEVEL_ERROR, format, ## __VA_ARGS__) 122 #else 123 #define log_error(...) (void)(0) 124 #endif 125 126 /* API_START */ 127 128 /** 129 * @brief Log Security Manager key via log_info 130 * @param name 131 * @param key to log 132 */ 133 void log_info_key(const char * name, sm_key_t key); 134 135 /** 136 * @brief Hexdump via log_info 137 * @param data 138 * @param size 139 */ 140 void log_info_hexdump(const void *data, int size); 141 142 /** 143 * @brief Hexdump via log_debug 144 * @param data 145 * @param size 146 */ 147 void log_debug_hexdump(const void *data, int size); 148 149 /* API_END */ 150 151 #endif // DEBUG_H 152