xref: /btstack/src/hci_dump_dispatch.h (revision 41e15c2ad20535494f3b27891c4d3112bfa37e0e)
1 /*
2  * Copyright (C) 2024 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  *  @brief HCI Dump Implementation that allows to use a set of HCI Dump Implementations
40  */
41 
42 #ifndef HCI_DUMP_DISPATCH_H
43 #define HCI_DUMP_DISPATCH_H
44 
45 #include "hci_dump.h"
46 #include "btstack_linked_list.h"
47 
48 #if defined __cplusplus
49 extern "C" {
50 #endif
51 
52 // memory provided by caller to keep hci_dump_t implementation in a list
53 typedef struct {
54     btstack_linked_item_t item;
55     const hci_dump_t * hci_dump;
56 } hci_dump_dispatch_item_t;
57 
58 /**
59  * @brief Init HCI Dump Dispatch
60  */
61 void hci_dump_dispatch_init(void);
62 
63 /**
64  * @brief Register HCI Dump (hci_dump_t *) implementation with dispatcher
65  * @param list_item
66  * @param dump
67  */
68 void hci_dump_dispatch_register(hci_dump_dispatch_item_t *list_item, const hci_dump_t *dump);
69 
70 /**
71  * @brief Unregister HCI Dump (hci_dump_t *) implementation from dispatcher
72  * @param dump
73  */
74 void hci_dump_dispatch_unregister(hci_dump_t *dump);
75 
76 /**
77  * @brief De-Init HCI Dump Dispatch
78  */
79 void hci_dump_dispatch_deinit(void);
80 
81 /**
82  * @brief Get HCI Dump Dispatch instance to be used with hci_dump
83  * @return
84  */
85 const hci_dump_t * hci_dump_dispatch_instance(void);
86 
87 #if defined __cplusplus
88 }
89 #endif
90 #endif // HCI_DUMP_DISPATCH_H
91