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 // fallback to __FILE__ for untagged files 58 #ifndef __BTSTACK_FILE__ 59 #define __BTSTACK_FILE__ __FILE__ 60 #endif 61 62 // Avoid complaints of unused arguments when log levels are disabled. 63 static inline void __log_unused(const char *format, ...) { 64 UNUSED(format); 65 } 66 67 // allow to provide port specific printf 68 #ifndef BTSTACK_PRINTF 69 #ifdef __AVR__ 70 #define BTSTACK_PRINTF(format, ...) printf_P(PSTR(format), ## __VA_ARGS__) 71 #else 72 #define BTSTACK_PRINTF(format, ...) printf(format, ## __VA_ARGS__) 73 #endif 74 #endif 75 76 #ifdef __AVR__ 77 #define HCI_DUMP_LOG(log_level, format, ...) hci_dump_log_P(log_level, PSTR("%s.%u: " format), __BTSTACK_FILE__, __LINE__, ## __VA_ARGS__) 78 #else 79 #define HCI_DUMP_LOG(log_level, format, ...) hci_dump_log(log_level, "%s.%u: " format, __BTSTACK_FILE__, __LINE__, ## __VA_ARGS__) 80 #endif 81 82 #ifdef ENABLE_LOG_DEBUG 83 #define log_debug(format, ...) HCI_DUMP_LOG(HCI_DUMP_LOG_LEVEL_DEBUG, format, ## __VA_ARGS__) 84 #else 85 #define log_debug(...) __log_unused(__VA_ARGS__) 86 #endif 87 88 #ifdef ENABLE_LOG_INFO 89 #define log_info(format, ...) HCI_DUMP_LOG(HCI_DUMP_LOG_LEVEL_INFO, format, ## __VA_ARGS__) 90 #else 91 #define log_info(...) __log_unused(__VA_ARGS__) 92 #endif 93 94 #ifdef ENABLE_LOG_ERROR 95 #define log_error(format, ...) HCI_DUMP_LOG(HCI_DUMP_LOG_LEVEL_ERROR, format, ## __VA_ARGS__) 96 #else 97 #define log_error(...) __log_unused(__VA_ARGS__) 98 #endif 99 100 /** 101 * @brief Log Security Manager key via log_info 102 * @param key to log 103 */ 104 void log_info_key(const char * name, sm_key_t key); 105 106 /** 107 * @brief Hexdump via log_info 108 * @param data 109 * @param size 110 */ 111 void log_info_hexdump(const void *data, int size); 112 113 /** 114 * @brief Hexdump via log_debug * @param data 115 * @param size 116 */ 117 void log_debug_hexdump(const void *data, int size); 118 119 #endif // __DEBUG_H 120