xref: /btstack/src/btstack_memory.h (revision 0e826a176164f342e7049a881289eee255b51b64)
1a3b02b71Smatthias.ringwald /*
2a0c35809S[email protected]  * Copyright (C) 2014 BlueKitchen GmbH
3a3b02b71Smatthias.ringwald  *
4a3b02b71Smatthias.ringwald  * Redistribution and use in source and binary forms, with or without
5a3b02b71Smatthias.ringwald  * modification, are permitted provided that the following conditions
6a3b02b71Smatthias.ringwald  * are met:
7a3b02b71Smatthias.ringwald  *
8a3b02b71Smatthias.ringwald  * 1. Redistributions of source code must retain the above copyright
9a3b02b71Smatthias.ringwald  *    notice, this list of conditions and the following disclaimer.
10a3b02b71Smatthias.ringwald  * 2. Redistributions in binary form must reproduce the above copyright
11a3b02b71Smatthias.ringwald  *    notice, this list of conditions and the following disclaimer in the
12a3b02b71Smatthias.ringwald  *    documentation and/or other materials provided with the distribution.
13a3b02b71Smatthias.ringwald  * 3. Neither the name of the copyright holders nor the names of
14a3b02b71Smatthias.ringwald  *    contributors may be used to endorse or promote products derived
15a3b02b71Smatthias.ringwald  *    from this software without specific prior written permission.
166b64433eSmatthias.ringwald  * 4. Any redistribution, use, or modification is done solely for
176b64433eSmatthias.ringwald  *    personal benefit and not for any commercial purpose or for
186b64433eSmatthias.ringwald  *    monetary gain.
19a3b02b71Smatthias.ringwald  *
202e97c149S[email protected]  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21a3b02b71Smatthias.ringwald  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22a3b02b71Smatthias.ringwald  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23a3b02b71Smatthias.ringwald  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24a3b02b71Smatthias.ringwald  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25a3b02b71Smatthias.ringwald  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26a3b02b71Smatthias.ringwald  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27a3b02b71Smatthias.ringwald  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28a3b02b71Smatthias.ringwald  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29a3b02b71Smatthias.ringwald  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30a3b02b71Smatthias.ringwald  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31a3b02b71Smatthias.ringwald  * SUCH DAMAGE.
32a3b02b71Smatthias.ringwald  *
332e97c149S[email protected]  * Please inquire about commercial licensing options at
342e97c149S[email protected]  * [email protected]
356b64433eSmatthias.ringwald  *
36a3b02b71Smatthias.ringwald  */
37a3b02b71Smatthias.ringwald 
382e97c149S[email protected] 
392e97c149S[email protected] 
40a3b02b71Smatthias.ringwald /*
41cf49570bSMatthias Ringwald  *  btstack_memory.h
42a3b02b71Smatthias.ringwald  *
43a3b02b71Smatthias.ringwald  *  @brief BTstack memory management via configurable memory pools
44a3b02b71Smatthias.ringwald  *
45a3b02b71Smatthias.ringwald  */
46a3b02b71Smatthias.ringwald 
47f471afd8S[email protected] #ifndef __BTSTACK_MEMORY_H
48f471afd8S[email protected] #define __BTSTACK_MEMORY_H
49a3b02b71Smatthias.ringwald 
50bc64ca62S[email protected] #if defined __cplusplus
51bc64ca62S[email protected] extern "C" {
52bc64ca62S[email protected] #endif
53bc64ca62S[email protected] 
547907f069SMatthias Ringwald #include "btstack_config.h"
55d0fdae3cS[email protected] 
563edc84c5SMatthias Ringwald // Core
576527a633S[email protected] #include "hci.h"
586527a633S[email protected] #include "l2cap.h"
596527a633S[email protected] 
603edc84c5SMatthias Ringwald // Classic
613edc84c5SMatthias Ringwald #include "classic/bnep.h"
623edc84c5SMatthias Ringwald #include "classic/hfp.h"
63a98592bcSMatthias Ringwald #include "classic/btstack_link_key_db.h"
64a98592bcSMatthias Ringwald #include "classic/btstack_link_key_db_memory.h"
65cd9ee144SMatthias Ringwald #include "classic/rfcomm.h"
66746ccb7eSMatthias Ringwald #include "classic/sdp_server.h"
6727faf85aSMilanka Ringwald #include "../test/avdtp/avdtp_sink.h"
6827faf85aSMilanka Ringwald #include "../test/avdtp/avdtp_source.h"
693edc84c5SMatthias Ringwald 
703edc84c5SMatthias Ringwald // BLE
71a9a4c409SMatthias Ringwald #ifdef ENABLE_BLE
723edc84c5SMatthias Ringwald #include "ble/gatt_client.h"
733edc84c5SMatthias Ringwald #include "ble/sm.h"
74d0fdae3cS[email protected] #endif
75d0fdae3cS[email protected] 
76f8088037SMilanka Ringwald /* API_START */
77f8088037SMilanka Ringwald 
78f8088037SMilanka Ringwald /**
79f8088037SMilanka Ringwald  * @brief Initializes BTstack memory pools.
80f8088037SMilanka Ringwald  */
81a3b02b71Smatthias.ringwald void btstack_memory_init(void);
82a3b02b71Smatthias.ringwald 
83f8088037SMilanka Ringwald /* API_END */
84f8088037SMilanka Ringwald 
852e97c149S[email protected] // hci_connection
866527a633S[email protected] hci_connection_t * btstack_memory_hci_connection_get(void);
876527a633S[email protected] void   btstack_memory_hci_connection_free(hci_connection_t *hci_connection);
88fdb398c2S[email protected] 
892e97c149S[email protected] // l2cap_service, l2cap_channel
906527a633S[email protected] l2cap_service_t * btstack_memory_l2cap_service_get(void);
916527a633S[email protected] void   btstack_memory_l2cap_service_free(l2cap_service_t *l2cap_service);
926527a633S[email protected] l2cap_channel_t * btstack_memory_l2cap_channel_get(void);
936527a633S[email protected] void   btstack_memory_l2cap_channel_free(l2cap_channel_t *l2cap_channel);
94fdb398c2S[email protected] 
952e97c149S[email protected] // rfcomm_multiplexer, rfcomm_service, rfcomm_channel
966527a633S[email protected] rfcomm_multiplexer_t * btstack_memory_rfcomm_multiplexer_get(void);
976527a633S[email protected] void   btstack_memory_rfcomm_multiplexer_free(rfcomm_multiplexer_t *rfcomm_multiplexer);
986527a633S[email protected] rfcomm_service_t * btstack_memory_rfcomm_service_get(void);
996527a633S[email protected] void   btstack_memory_rfcomm_service_free(rfcomm_service_t *rfcomm_service);
1006527a633S[email protected] rfcomm_channel_t * btstack_memory_rfcomm_channel_get(void);
1016527a633S[email protected] void   btstack_memory_rfcomm_channel_free(rfcomm_channel_t *rfcomm_channel);
102fdb398c2S[email protected] 
1032c455dadSMatthias Ringwald // btstack_link_key_db_memory_entry
1042c455dadSMatthias Ringwald btstack_link_key_db_memory_entry_t * btstack_memory_btstack_link_key_db_memory_entry_get(void);
1052c455dadSMatthias Ringwald void   btstack_memory_btstack_link_key_db_memory_entry_free(btstack_link_key_db_memory_entry_t *btstack_link_key_db_memory_entry);
106bc64ca62S[email protected] 
1072e97c149S[email protected] // bnep_service, bnep_channel
1082e97c149S[email protected] bnep_service_t * btstack_memory_bnep_service_get(void);
1092e97c149S[email protected] void   btstack_memory_bnep_service_free(bnep_service_t *bnep_service);
1102e97c149S[email protected] bnep_channel_t * btstack_memory_bnep_channel_get(void);
1112e97c149S[email protected] void   btstack_memory_bnep_channel_free(bnep_channel_t *bnep_channel);
1122e97c149S[email protected] 
113ea5029c9SMilanka Ringwald // hfp_connection
114ea5029c9SMilanka Ringwald hfp_connection_t * btstack_memory_hfp_connection_get(void);
115ea5029c9SMilanka Ringwald void   btstack_memory_hfp_connection_free(hfp_connection_t *hfp_connection);
116ea5029c9SMilanka Ringwald 
117cd9ee144SMatthias Ringwald // service_record_item
118cd9ee144SMatthias Ringwald service_record_item_t * btstack_memory_service_record_item_get(void);
119cd9ee144SMatthias Ringwald void   btstack_memory_service_record_item_free(service_record_item_t *service_record_item);
120cd9ee144SMatthias Ringwald 
121*0e826a17SMilanka Ringwald // avdtp_stream_endpoint
122*0e826a17SMilanka Ringwald avdtp_stream_endpoint_t * btstack_memory_avdtp_stream_endpoint_get(void);
123*0e826a17SMilanka Ringwald void   btstack_memory_avdtp_stream_endpoint_free(avdtp_stream_endpoint_t *avdtp_stream_endpoint);
12427faf85aSMilanka Ringwald 
125a9a4c409SMatthias Ringwald #ifdef ENABLE_BLE
1269c662c9bSMatthias Ringwald // gatt_client, whitelist_entry, sm_lookup_entry
127d0fdae3cS[email protected] gatt_client_t * btstack_memory_gatt_client_get(void);
128d0fdae3cS[email protected] void   btstack_memory_gatt_client_free(gatt_client_t *gatt_client);
129656bec4fSMatthias Ringwald whitelist_entry_t * btstack_memory_whitelist_entry_get(void);
130656bec4fSMatthias Ringwald void   btstack_memory_whitelist_entry_free(whitelist_entry_t *whitelist_entry);
131cf49570bSMatthias Ringwald sm_lookup_entry_t * btstack_memory_sm_lookup_entry_get(void);
132cf49570bSMatthias Ringwald void   btstack_memory_sm_lookup_entry_free(sm_lookup_entry_t *sm_lookup_entry);
133d0fdae3cS[email protected] #endif
134d0fdae3cS[email protected] 
135bc64ca62S[email protected] #if defined __cplusplus
136bc64ca62S[email protected] }
137bc64ca62S[email protected] #endif
138f471afd8S[email protected] 
139f471afd8S[email protected] #endif // __BTSTACK_MEMORY_H
1402e97c149S[email protected] 
141