xref: /btstack/src/btstack_memory.h (revision 8caefee39d444df6d8908a96a844825f10fbdaa4)
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 #include "hci.h"
57 #include "l2cap.h"
58 #include "rfcomm.h"
59 #include "bnep.h"
60 #include "hfp.h"
61 #include "remote_device_db.h"
62 
63 #ifdef HAVE_BLE
64 #include "gatt_client.h"
65 #include "sm.h"
66 #endif
67 
68 /* API_START */
69 
70 /**
71  * @brief Initializes BTstack memory pools.
72  */
73 void btstack_memory_init(void);
74 
75 /* API_END */
76 
77 // hci_connection
78 hci_connection_t * btstack_memory_hci_connection_get(void);
79 void   btstack_memory_hci_connection_free(hci_connection_t *hci_connection);
80 
81 // l2cap_service, l2cap_channel
82 l2cap_service_t * btstack_memory_l2cap_service_get(void);
83 void   btstack_memory_l2cap_service_free(l2cap_service_t *l2cap_service);
84 l2cap_channel_t * btstack_memory_l2cap_channel_get(void);
85 void   btstack_memory_l2cap_channel_free(l2cap_channel_t *l2cap_channel);
86 
87 // rfcomm_multiplexer, rfcomm_service, rfcomm_channel
88 rfcomm_multiplexer_t * btstack_memory_rfcomm_multiplexer_get(void);
89 void   btstack_memory_rfcomm_multiplexer_free(rfcomm_multiplexer_t *rfcomm_multiplexer);
90 rfcomm_service_t * btstack_memory_rfcomm_service_get(void);
91 void   btstack_memory_rfcomm_service_free(rfcomm_service_t *rfcomm_service);
92 rfcomm_channel_t * btstack_memory_rfcomm_channel_get(void);
93 void   btstack_memory_rfcomm_channel_free(rfcomm_channel_t *rfcomm_channel);
94 
95 // db_mem_device_name, db_mem_device_link_key, db_mem_service
96 db_mem_device_name_t * btstack_memory_db_mem_device_name_get(void);
97 void   btstack_memory_db_mem_device_name_free(db_mem_device_name_t *db_mem_device_name);
98 db_mem_device_link_key_t * btstack_memory_db_mem_device_link_key_get(void);
99 void   btstack_memory_db_mem_device_link_key_free(db_mem_device_link_key_t *db_mem_device_link_key);
100 db_mem_service_t * btstack_memory_db_mem_service_get(void);
101 void   btstack_memory_db_mem_service_free(db_mem_service_t *db_mem_service);
102 
103 // bnep_service, bnep_channel
104 bnep_service_t * btstack_memory_bnep_service_get(void);
105 void   btstack_memory_bnep_service_free(bnep_service_t *bnep_service);
106 bnep_channel_t * btstack_memory_bnep_channel_get(void);
107 void   btstack_memory_bnep_channel_free(bnep_channel_t *bnep_channel);
108 
109 // hfp_connection
110 hfp_connection_t * btstack_memory_hfp_connection_get(void);
111 void   btstack_memory_hfp_connection_free(hfp_connection_t *hfp_connection);
112 
113 #ifdef HAVE_BLE
114 // gatt_client, gatt_subclient, whitelist_entry, sm_lookup_entry
115 gatt_client_t * btstack_memory_gatt_client_get(void);
116 void   btstack_memory_gatt_client_free(gatt_client_t *gatt_client);
117 gatt_subclient_t * btstack_memory_gatt_subclient_get(void);
118 void   btstack_memory_gatt_subclient_free(gatt_subclient_t *gatt_subclient);
119 whitelist_entry_t * btstack_memory_whitelist_entry_get(void);
120 void   btstack_memory_whitelist_entry_free(whitelist_entry_t *whitelist_entry);
121 sm_lookup_entry_t * btstack_memory_sm_lookup_entry_get(void);
122 void   btstack_memory_sm_lookup_entry_free(sm_lookup_entry_t *sm_lookup_entry);
123 #endif
124 
125 #if defined __cplusplus
126 }
127 #endif
128 
129 #endif // __BTSTACK_MEMORY_H
130 
131