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