xref: /btstack/platform/posix/hci_dump_posix_fs.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
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  *  Dump HCI trace in binary formats like PacketLogger and BlueZ (hcidump) into file
40  */
41 
42 #ifndef HCI_DUMP_POSIX_FS_H
43 #define HCI_DUMP_POSIX_FS_H
44 
45 #include <stdint.h>
46 #include <stdarg.h>       // for va_list
47 #include "hci_dump.h"
48 
49 #if defined __cplusplus
50 extern "C" {
51 #endif
52 
53 /**
54  * @brief Get HCI Dump POSIX FS Instance
55  * @return hci_dump_impl
56  */
57 const hci_dump_t * hci_dump_posix_fs_get_instance(void);
58 
59 /*
60  * @brief Open Log file
61  * @param filename or path
62  * @param format
63  * @returns 0 if ok, errno otherwise
64  */
65 int hci_dump_posix_fs_open(const char *filename, hci_dump_format_t format);
66 
67 /*
68  * @brief Close Log file
69  */
70 void hci_dump_posix_fs_close(void);
71 
72 /* API_END */
73 
74 #if defined __cplusplus
75 }
76 #endif
77 #endif // HCI_DUMP_POSIX_FS_H
78