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 using 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 #ifdef ENABLE_CLASSIC 62 #include "classic/avdtp_sink.h" 63 #include "classic/avdtp_source.h" 64 #include "classic/avrcp.h" 65 #include "classic/bnep.h" 66 #include "classic/btstack_link_key_db.h" 67 #include "classic/btstack_link_key_db_memory.h" 68 #include "classic/hfp.h" 69 #include "classic/hid_host.h" 70 #include "classic/rfcomm.h" 71 #include "classic/sdp_server.h" 72 #endif 73 74 // BLE 75 #ifdef ENABLE_BLE 76 #include "ble/gatt-service/battery_service_client.h" 77 #include "ble/gatt-service/hids_client.h" 78 #include "ble/gatt-service/scan_parameters_service_client.h" 79 #include "ble/gatt_client.h" 80 #include "ble/sm.h" 81 #endif 82 83 #ifdef ENABLE_MESH 84 #include "mesh/mesh_network.h" 85 #include "mesh/mesh_keys.h" 86 #include "mesh/mesh_virtual_addresses.h" 87 #endif 88 89 /* API_START */ 90 91 /** 92 * @brief Initializes BTstack memory pools. 93 */ 94 void btstack_memory_init(void); 95 96 /** 97 * @brief Deinitialize BTstack memory pools 98 * @note if HAVE_MALLOC is defined, all previously allocated buffers are free'd 99 */ 100 void btstack_memory_deinit(void); 101 102 /* API_END */ 103 104 // hci_connection 105 hci_connection_t * btstack_memory_hci_connection_get(void); 106 void btstack_memory_hci_connection_free(hci_connection_t *hci_connection); 107 108 // l2cap_service, l2cap_channel 109 l2cap_service_t * btstack_memory_l2cap_service_get(void); 110 void btstack_memory_l2cap_service_free(l2cap_service_t *l2cap_service); 111 l2cap_channel_t * btstack_memory_l2cap_channel_get(void); 112 void btstack_memory_l2cap_channel_free(l2cap_channel_t *l2cap_channel); 113 114 #ifdef ENABLE_CLASSIC 115 // rfcomm_multiplexer, rfcomm_service, rfcomm_channel 116 rfcomm_multiplexer_t * btstack_memory_rfcomm_multiplexer_get(void); 117 void btstack_memory_rfcomm_multiplexer_free(rfcomm_multiplexer_t *rfcomm_multiplexer); 118 rfcomm_service_t * btstack_memory_rfcomm_service_get(void); 119 void btstack_memory_rfcomm_service_free(rfcomm_service_t *rfcomm_service); 120 rfcomm_channel_t * btstack_memory_rfcomm_channel_get(void); 121 void btstack_memory_rfcomm_channel_free(rfcomm_channel_t *rfcomm_channel); 122 123 // btstack_link_key_db_memory_entry 124 btstack_link_key_db_memory_entry_t * btstack_memory_btstack_link_key_db_memory_entry_get(void); 125 void btstack_memory_btstack_link_key_db_memory_entry_free(btstack_link_key_db_memory_entry_t *btstack_link_key_db_memory_entry); 126 127 // bnep_service, bnep_channel 128 bnep_service_t * btstack_memory_bnep_service_get(void); 129 void btstack_memory_bnep_service_free(bnep_service_t *bnep_service); 130 bnep_channel_t * btstack_memory_bnep_channel_get(void); 131 void btstack_memory_bnep_channel_free(bnep_channel_t *bnep_channel); 132 133 // hfp_connection 134 hfp_connection_t * btstack_memory_hfp_connection_get(void); 135 void btstack_memory_hfp_connection_free(hfp_connection_t *hfp_connection); 136 137 // hid_host_connection 138 hid_host_connection_t * btstack_memory_hid_host_connection_get(void); 139 void btstack_memory_hid_host_connection_free(hid_host_connection_t *hid_host_connection); 140 141 // service_record_item 142 service_record_item_t * btstack_memory_service_record_item_get(void); 143 void btstack_memory_service_record_item_free(service_record_item_t *service_record_item); 144 145 // avdtp_stream_endpoint 146 avdtp_stream_endpoint_t * btstack_memory_avdtp_stream_endpoint_get(void); 147 void btstack_memory_avdtp_stream_endpoint_free(avdtp_stream_endpoint_t *avdtp_stream_endpoint); 148 149 // avdtp_connection 150 avdtp_connection_t * btstack_memory_avdtp_connection_get(void); 151 void btstack_memory_avdtp_connection_free(avdtp_connection_t *avdtp_connection); 152 153 // avrcp_connection 154 avrcp_connection_t * btstack_memory_avrcp_connection_get(void); 155 void btstack_memory_avrcp_connection_free(avrcp_connection_t *avrcp_connection); 156 157 // avrcp_browsing_connection 158 avrcp_browsing_connection_t * btstack_memory_avrcp_browsing_connection_get(void); 159 void btstack_memory_avrcp_browsing_connection_free(avrcp_browsing_connection_t *avrcp_browsing_connection); 160 161 #endif 162 #ifdef ENABLE_BLE 163 // battery_service_client, gatt_client, hids_client, scan_parameters_service_client, sm_lookup_entry, whitelist_entry 164 battery_service_client_t * btstack_memory_battery_service_client_get(void); 165 void btstack_memory_battery_service_client_free(battery_service_client_t *battery_service_client); 166 gatt_client_t * btstack_memory_gatt_client_get(void); 167 void btstack_memory_gatt_client_free(gatt_client_t *gatt_client); 168 hids_client_t * btstack_memory_hids_client_get(void); 169 void btstack_memory_hids_client_free(hids_client_t *hids_client); 170 scan_parameters_service_client_t * btstack_memory_scan_parameters_service_client_get(void); 171 void btstack_memory_scan_parameters_service_client_free(scan_parameters_service_client_t *scan_parameters_service_client); 172 sm_lookup_entry_t * btstack_memory_sm_lookup_entry_get(void); 173 void btstack_memory_sm_lookup_entry_free(sm_lookup_entry_t *sm_lookup_entry); 174 whitelist_entry_t * btstack_memory_whitelist_entry_get(void); 175 void btstack_memory_whitelist_entry_free(whitelist_entry_t *whitelist_entry); 176 #endif 177 #ifdef ENABLE_MESH 178 // mesh_network_pdu, mesh_segmented_pdu, mesh_upper_transport_pdu, mesh_network_key, mesh_transport_key, mesh_virtual_address, mesh_subnet 179 mesh_network_pdu_t * btstack_memory_mesh_network_pdu_get(void); 180 void btstack_memory_mesh_network_pdu_free(mesh_network_pdu_t *mesh_network_pdu); 181 mesh_segmented_pdu_t * btstack_memory_mesh_segmented_pdu_get(void); 182 void btstack_memory_mesh_segmented_pdu_free(mesh_segmented_pdu_t *mesh_segmented_pdu); 183 mesh_upper_transport_pdu_t * btstack_memory_mesh_upper_transport_pdu_get(void); 184 void btstack_memory_mesh_upper_transport_pdu_free(mesh_upper_transport_pdu_t *mesh_upper_transport_pdu); 185 mesh_network_key_t * btstack_memory_mesh_network_key_get(void); 186 void btstack_memory_mesh_network_key_free(mesh_network_key_t *mesh_network_key); 187 mesh_transport_key_t * btstack_memory_mesh_transport_key_get(void); 188 void btstack_memory_mesh_transport_key_free(mesh_transport_key_t *mesh_transport_key); 189 mesh_virtual_address_t * btstack_memory_mesh_virtual_address_get(void); 190 void btstack_memory_mesh_virtual_address_free(mesh_virtual_address_t *mesh_virtual_address); 191 mesh_subnet_t * btstack_memory_mesh_subnet_get(void); 192 void btstack_memory_mesh_subnet_free(mesh_subnet_t *mesh_subnet); 193 #endif 194 195 #if defined __cplusplus 196 } 197 #endif 198 199 #endif // BTSTACK_MEMORY_H 200 201