xref: /btstack/src/btstack_debug.h (revision 8314c363bcd9f54e3b89cfc57caf8854074f1809)
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 // Avoid complaints of unused arguments when log levels are disabled.
58 static inline void __log_unused(const char *format, ...) {}
59 
60 #ifdef __AVR__
61 #define HCI_DUMP_LOG(log_level, format, ...) hci_dump_log_P(log_level, PSTR(format), ## __VA_ARGS__)
62 #define BTSTACK_PRINTF(format, ...)          printf_P(PSTR(format), ## __VA_ARGS__)
63 #else
64 #define HCI_DUMP_LOG(log_level, format, ...) hci_dump_log(log_level, format, ## __VA_ARGS__)
65 #define BTSTACK_PRINTF(format, ...)          printf(format, ## __VA_ARGS__)
66 #endif
67 
68 #ifdef ENABLE_LOG_DEBUG
69 #ifdef ENABLE_LOG_INTO_HCI_DUMP
70 #define log_debug(format, ...)  HCI_DUMP_LOG(LOG_LEVEL_DEBUG, format,  ## __VA_ARGS__)
71 #else
72 #define log_debug(format, ...)  BTSTACK_PRINTF(format "\n",  ## __VA_ARGS__)
73 #endif
74 #else
75 #define log_debug(...) __log_unused(__VA_ARGS__)
76 #endif
77 
78 #ifdef ENABLE_LOG_INFO
79 #ifdef ENABLE_LOG_INTO_HCI_DUMP
80 #define log_info(format, ...)  HCI_DUMP_LOG(LOG_LEVEL_INFO, format,  ## __VA_ARGS__)
81 #else
82 #define log_info(format, ...)  BTSTACK_PRINTF(format "\n",  ## __VA_ARGS__)
83 #endif
84 #else
85 #define log_info(...) __log_unused(__VA_ARGS__)
86 #endif
87 
88 #ifdef ENABLE_LOG_ERROR
89 #ifdef ENABLE_LOG_INTO_HCI_DUMP
90 #define log_error(format, ...)  HCI_DUMP_LOG(LOG_LEVEL_ERROR, format,  ## __VA_ARGS__)
91 #else
92 #define log_error(format, ...)  BTSTACK_PRINTF(format "\n",  ## __VA_ARGS__)
93 #endif
94 #else
95 #define log_error(...) __log_unused(__VA_ARGS__)
96 #endif
97 
98 /**
99  * @brief Log Security Manager key via log_info
100  * @param key to log
101  */
102 void log_info_key(const char * name, sm_key_t key);
103 
104 /**
105  * @brief Hexdump via log_info
106  * @param data
107  * @param size
108  */
109 void log_info_hexdump(const void *data, int size);
110 
111 #endif // __DEBUG_H
112