xref: /btstack/src/btstack_memory.h (revision 3edc84c5b6b1e23a3d103fe8ce1f6b5ad1df3498)
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/rfcomm.h"
62 #include "classic/bnep.h"
63 #include "classic/hfp.h"
64 #include "classic/remote_device_db.h"
65 
66 // BLE
67 #ifdef HAVE_BLE
68 #include "ble/gatt_client.h"
69 #include "ble/sm.h"
70 #endif
71 
72 /* API_START */
73 
74 /**
75  * @brief Initializes BTstack memory pools.
76  */
77 void btstack_memory_init(void);
78 
79 /* API_END */
80 
81 // hci_connection
82 hci_connection_t * btstack_memory_hci_connection_get(void);
83 void   btstack_memory_hci_connection_free(hci_connection_t *hci_connection);
84 
85 // l2cap_service, l2cap_channel
86 l2cap_service_t * btstack_memory_l2cap_service_get(void);
87 void   btstack_memory_l2cap_service_free(l2cap_service_t *l2cap_service);
88 l2cap_channel_t * btstack_memory_l2cap_channel_get(void);
89 void   btstack_memory_l2cap_channel_free(l2cap_channel_t *l2cap_channel);
90 
91 // rfcomm_multiplexer, rfcomm_service, rfcomm_channel
92 rfcomm_multiplexer_t * btstack_memory_rfcomm_multiplexer_get(void);
93 void   btstack_memory_rfcomm_multiplexer_free(rfcomm_multiplexer_t *rfcomm_multiplexer);
94 rfcomm_service_t * btstack_memory_rfcomm_service_get(void);
95 void   btstack_memory_rfcomm_service_free(rfcomm_service_t *rfcomm_service);
96 rfcomm_channel_t * btstack_memory_rfcomm_channel_get(void);
97 void   btstack_memory_rfcomm_channel_free(rfcomm_channel_t *rfcomm_channel);
98 
99 // db_mem_device_name, db_mem_device_link_key, db_mem_service
100 db_mem_device_name_t * btstack_memory_db_mem_device_name_get(void);
101 void   btstack_memory_db_mem_device_name_free(db_mem_device_name_t *db_mem_device_name);
102 db_mem_device_link_key_t * btstack_memory_db_mem_device_link_key_get(void);
103 void   btstack_memory_db_mem_device_link_key_free(db_mem_device_link_key_t *db_mem_device_link_key);
104 db_mem_service_t * btstack_memory_db_mem_service_get(void);
105 void   btstack_memory_db_mem_service_free(db_mem_service_t *db_mem_service);
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 #ifdef HAVE_BLE
118 // gatt_client, gatt_subclient, whitelist_entry, sm_lookup_entry
119 gatt_client_t * btstack_memory_gatt_client_get(void);
120 void   btstack_memory_gatt_client_free(gatt_client_t *gatt_client);
121 gatt_subclient_t * btstack_memory_gatt_subclient_get(void);
122 void   btstack_memory_gatt_subclient_free(gatt_subclient_t *gatt_subclient);
123 whitelist_entry_t * btstack_memory_whitelist_entry_get(void);
124 void   btstack_memory_whitelist_entry_free(whitelist_entry_t *whitelist_entry);
125 sm_lookup_entry_t * btstack_memory_sm_lookup_entry_get(void);
126 void   btstack_memory_sm_lookup_entry_free(sm_lookup_entry_t *sm_lookup_entry);
127 #endif
128 
129 #if defined __cplusplus
130 }
131 #endif
132 
133 #endif // __BTSTACK_MEMORY_H
134 
135