xref: /btstack/src/hci_dump.h (revision 8257e5f9e1a9f15ac2fe1e69adc5d2eeeadf3fff)
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  *  hci_dump.h
40  *
41  *  Dump HCI trace as BlueZ's hcidump format, Apple's PacketLogger, or stdout
42  *
43  *  Created by Matthias Ringwald on 5/26/09.
44  */
45 
46 #ifndef __HCI_DUMP_H
47 #define __HCI_DUMP_H
48 
49 #include <stdint.h>
50 
51 #ifdef __AVR__
52 #include <avr/pgmspace.h>
53 #endif
54 
55 #if defined __cplusplus
56 extern "C" {
57 #endif
58 
59 #define LOG_LEVEL_DEBUG 0
60 #define LOG_LEVEL_INFO  1
61 #define LOG_LEVEL_ERROR 2
62 
63 /* API_START */
64 
65 typedef enum {
66     HCI_DUMP_BLUEZ = 0,
67     HCI_DUMP_PACKETLOGGER,
68     HCI_DUMP_STDOUT
69 } hci_dump_format_t;
70 
71 /*
72  * @brief
73  */
74 void hci_dump_open(const char *filename, hci_dump_format_t format);
75 
76 /*
77  * @brief
78  */
79 void hci_dump_set_max_packets(int packets); // -1 for unlimited
80 
81 /*
82  * @brief
83  */
84 void hci_dump_packet(uint8_t packet_type, uint8_t in, uint8_t *packet, uint16_t len);
85 
86 /*
87  * @brief
88  */
89 void hci_dump_log(int log_level, const char * format, ...)
90 #ifdef __GNUC__
91 __attribute__ ((format (__printf__, 2, 3)));
92 #endif
93 ;
94 
95 /*
96  * @brief
97  */
98 void hci_dump_enable_log_level(int log_level, int enable);
99 
100 /*
101  * @brief
102  */
103 void hci_dump_close(void);
104 
105 /* API_END */
106 
107 #ifdef __AVR__
108 void hci_dump_log_P(int log_level, PGM_P format, ...);
109 #endif
110 
111 #if defined __cplusplus
112 }
113 #endif
114 #endif // __HCI_DUMP_H
115