xref: /btstack/src/btstack_memory.h (revision bc37f7b0d0a3eaa5763a873c5730bc14b849aaa0)
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 
40 /*
41  *  btstack_memory.h
42  *
43  *  @brief BTstack memory management via configurable memory pools
44  *
45  */
46 
47 #ifndef __BTSTACK_MEMORY_H
48 #define __BTSTACK_MEMORY_H
49 
50 #if defined __cplusplus
51 extern "C" {
52 #endif
53 
54 #include "btstack_config.h"
55 
56 // Core
57 #include "hci.h"
58 #include "l2cap.h"
59 
60 // Classic
61 #include "classic/bnep.h"
62 #include "classic/hfp.h"
63 #include "classic/btstack_link_key_db.h"
64 #include "classic/btstack_link_key_db_memory.h"
65 #include "classic/rfcomm.h"
66 #include "classic/sdp_server.h"
67 #include "../test/avdtp/avdtp_sink.h"
68 #include "../test/avdtp/avdtp_source.h"
69 
70 // BLE
71 #ifdef ENABLE_BLE
72 #include "ble/gatt_client.h"
73 #include "ble/sm.h"
74 #endif
75 
76 /* API_START */
77 
78 /**
79  * @brief Initializes BTstack memory pools.
80  */
81 void btstack_memory_init(void);
82 
83 /* API_END */
84 
85 // hci_connection
86 hci_connection_t * btstack_memory_hci_connection_get(void);
87 void   btstack_memory_hci_connection_free(hci_connection_t *hci_connection);
88 
89 // l2cap_service, l2cap_channel
90 l2cap_service_t * btstack_memory_l2cap_service_get(void);
91 void   btstack_memory_l2cap_service_free(l2cap_service_t *l2cap_service);
92 l2cap_channel_t * btstack_memory_l2cap_channel_get(void);
93 void   btstack_memory_l2cap_channel_free(l2cap_channel_t *l2cap_channel);
94 
95 // rfcomm_multiplexer, rfcomm_service, rfcomm_channel
96 rfcomm_multiplexer_t * btstack_memory_rfcomm_multiplexer_get(void);
97 void   btstack_memory_rfcomm_multiplexer_free(rfcomm_multiplexer_t *rfcomm_multiplexer);
98 rfcomm_service_t * btstack_memory_rfcomm_service_get(void);
99 void   btstack_memory_rfcomm_service_free(rfcomm_service_t *rfcomm_service);
100 rfcomm_channel_t * btstack_memory_rfcomm_channel_get(void);
101 void   btstack_memory_rfcomm_channel_free(rfcomm_channel_t *rfcomm_channel);
102 
103 // btstack_link_key_db_memory_entry
104 btstack_link_key_db_memory_entry_t * btstack_memory_btstack_link_key_db_memory_entry_get(void);
105 void   btstack_memory_btstack_link_key_db_memory_entry_free(btstack_link_key_db_memory_entry_t *btstack_link_key_db_memory_entry);
106 
107 // bnep_service, bnep_channel
108 bnep_service_t * btstack_memory_bnep_service_get(void);
109 void   btstack_memory_bnep_service_free(bnep_service_t *bnep_service);
110 bnep_channel_t * btstack_memory_bnep_channel_get(void);
111 void   btstack_memory_bnep_channel_free(bnep_channel_t *bnep_channel);
112 
113 // hfp_connection
114 hfp_connection_t * btstack_memory_hfp_connection_get(void);
115 void   btstack_memory_hfp_connection_free(hfp_connection_t *hfp_connection);
116 
117 // service_record_item
118 service_record_item_t * btstack_memory_service_record_item_get(void);
119 void   btstack_memory_service_record_item_free(service_record_item_t *service_record_item);
120 
121 // avdtp_sink_connection
122 avdtp_sink_connection_t * btstack_memory_avdtp_sink_connection_get(void);
123 void   btstack_memory_avdtp_sink_connection_free(avdtp_sink_connection_t *avdtp_sink_connection);
124 
125 #ifdef ENABLE_BLE
126 // gatt_client, whitelist_entry, sm_lookup_entry
127 gatt_client_t * btstack_memory_gatt_client_get(void);
128 void   btstack_memory_gatt_client_free(gatt_client_t *gatt_client);
129 whitelist_entry_t * btstack_memory_whitelist_entry_get(void);
130 void   btstack_memory_whitelist_entry_free(whitelist_entry_t *whitelist_entry);
131 sm_lookup_entry_t * btstack_memory_sm_lookup_entry_get(void);
132 void   btstack_memory_sm_lookup_entry_free(sm_lookup_entry_t *sm_lookup_entry);
133 #endif
134 
135 #if defined __cplusplus
136 }
137 #endif
138 
139 #endif // __BTSTACK_MEMORY_H
140 
141