xref: /btstack/src/btstack_memory.h (revision 01e2bf948960b11d2fac746ae210179d7de5c429)
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 "classic/avdtp_sink.h"
68 #include "classic/avdtp_source.h"
69 #include "classic/avrcp.h"
70 
71 // BLE
72 #ifdef ENABLE_BLE
73 #include "ble/gatt_client.h"
74 #include "ble/sm.h"
75 #endif
76 
77 #ifdef ENABLE_MESH
78 #include "ble/mesh/mesh_network.h"
79 #include "mesh_keys.h"
80 #endif
81 
82 /* API_START */
83 
84 /**
85  * @brief Initializes BTstack memory pools.
86  */
87 void btstack_memory_init(void);
88 
89 /* API_END */
90 
91 // hci_connection
92 hci_connection_t * btstack_memory_hci_connection_get(void);
93 void   btstack_memory_hci_connection_free(hci_connection_t *hci_connection);
94 
95 // l2cap_service, l2cap_channel
96 l2cap_service_t * btstack_memory_l2cap_service_get(void);
97 void   btstack_memory_l2cap_service_free(l2cap_service_t *l2cap_service);
98 l2cap_channel_t * btstack_memory_l2cap_channel_get(void);
99 void   btstack_memory_l2cap_channel_free(l2cap_channel_t *l2cap_channel);
100 
101 #ifdef ENABLE_CLASSIC
102 // rfcomm_multiplexer, rfcomm_service, rfcomm_channel
103 rfcomm_multiplexer_t * btstack_memory_rfcomm_multiplexer_get(void);
104 void   btstack_memory_rfcomm_multiplexer_free(rfcomm_multiplexer_t *rfcomm_multiplexer);
105 rfcomm_service_t * btstack_memory_rfcomm_service_get(void);
106 void   btstack_memory_rfcomm_service_free(rfcomm_service_t *rfcomm_service);
107 rfcomm_channel_t * btstack_memory_rfcomm_channel_get(void);
108 void   btstack_memory_rfcomm_channel_free(rfcomm_channel_t *rfcomm_channel);
109 
110 // btstack_link_key_db_memory_entry
111 btstack_link_key_db_memory_entry_t * btstack_memory_btstack_link_key_db_memory_entry_get(void);
112 void   btstack_memory_btstack_link_key_db_memory_entry_free(btstack_link_key_db_memory_entry_t *btstack_link_key_db_memory_entry);
113 
114 // bnep_service, bnep_channel
115 bnep_service_t * btstack_memory_bnep_service_get(void);
116 void   btstack_memory_bnep_service_free(bnep_service_t *bnep_service);
117 bnep_channel_t * btstack_memory_bnep_channel_get(void);
118 void   btstack_memory_bnep_channel_free(bnep_channel_t *bnep_channel);
119 
120 // hfp_connection
121 hfp_connection_t * btstack_memory_hfp_connection_get(void);
122 void   btstack_memory_hfp_connection_free(hfp_connection_t *hfp_connection);
123 
124 // service_record_item
125 service_record_item_t * btstack_memory_service_record_item_get(void);
126 void   btstack_memory_service_record_item_free(service_record_item_t *service_record_item);
127 
128 // avdtp_stream_endpoint
129 avdtp_stream_endpoint_t * btstack_memory_avdtp_stream_endpoint_get(void);
130 void   btstack_memory_avdtp_stream_endpoint_free(avdtp_stream_endpoint_t *avdtp_stream_endpoint);
131 
132 // avdtp_connection
133 avdtp_connection_t * btstack_memory_avdtp_connection_get(void);
134 void   btstack_memory_avdtp_connection_free(avdtp_connection_t *avdtp_connection);
135 
136 // avrcp_connection
137 avrcp_connection_t * btstack_memory_avrcp_connection_get(void);
138 void   btstack_memory_avrcp_connection_free(avrcp_connection_t *avrcp_connection);
139 
140 // avrcp_browsing_connection
141 avrcp_browsing_connection_t * btstack_memory_avrcp_browsing_connection_get(void);
142 void   btstack_memory_avrcp_browsing_connection_free(avrcp_browsing_connection_t *avrcp_browsing_connection);
143 
144 #endif
145 #ifdef ENABLE_BLE
146 // gatt_client, whitelist_entry, sm_lookup_entry
147 gatt_client_t * btstack_memory_gatt_client_get(void);
148 void   btstack_memory_gatt_client_free(gatt_client_t *gatt_client);
149 whitelist_entry_t * btstack_memory_whitelist_entry_get(void);
150 void   btstack_memory_whitelist_entry_free(whitelist_entry_t *whitelist_entry);
151 sm_lookup_entry_t * btstack_memory_sm_lookup_entry_get(void);
152 void   btstack_memory_sm_lookup_entry_free(sm_lookup_entry_t *sm_lookup_entry);
153 #endif
154 #ifdef ENABLE_MESH
155 // mesh_network_pdu, mesh_transport_pdu, mesh_network_key, mesh_transport_key
156 mesh_network_pdu_t * btstack_memory_mesh_network_pdu_get(void);
157 void   btstack_memory_mesh_network_pdu_free(mesh_network_pdu_t *mesh_network_pdu);
158 mesh_transport_pdu_t * btstack_memory_mesh_transport_pdu_get(void);
159 void   btstack_memory_mesh_transport_pdu_free(mesh_transport_pdu_t *mesh_transport_pdu);
160 mesh_network_key_t * btstack_memory_mesh_network_key_get(void);
161 void   btstack_memory_mesh_network_key_free(mesh_network_key_t *mesh_network_key);
162 mesh_transport_key_t * btstack_memory_mesh_transport_key_get(void);
163 void   btstack_memory_mesh_transport_key_free(mesh_transport_key_t *mesh_transport_key);
164 #endif
165 
166 #if defined __cplusplus
167 }
168 #endif
169 
170 #endif // BTSTACK_MEMORY_H
171 
172