xref: /btstack/src/mesh/gatt_bearer.h (revision 01122b73eef352aeca7441c8b29c15365f0d0177)
1 /*
2  * Copyright (C) 2017 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 #ifndef __GATT_BEARER_H
40 #define __GATT_BEARER_H
41 
42 #include <stdint.h>
43 #include "btstack_defines.h"
44 
45 #if defined __cplusplus
46 extern "C" {
47 #endif
48 
49 /**
50  * Initialize GATT Bearer
51  */
52 void gatt_bearer_init(void);
53 
54 /**
55  * Register listener for particular message types: Mesh Message, Mesh Beacon, proxy configuration
56  */
57 void gatt_bearer_register_for_network_pdu(btstack_packet_handler_t packet_handler);
58 void gatt_bearer_register_for_beacon(btstack_packet_handler_t packet_handler);
59 void gatt_bearer_register_for_mesh_proxy_configuration(btstack_packet_handler_t _packet_handler);
60 
61 /**
62  * Request can send now event for particular message type: Mesh Message, Mesh Beacon, proxy configuration
63  */
64 void gatt_bearer_request_can_send_now_for_network_pdu(void);
65 void gatt_bearer_request_can_send_now_for_beacon(void);
66 void gatt_bearer_request_can_send_now_for_mesh_proxy_configuration(void);
67 
68 /**
69  * Send particular message type: Mesh Message, Mesh Beacon, proxy configuration
70  * @param data to send
71  * @param data_len max 29 bytes
72  */
73 void gatt_bearer_send_network_pdu(const uint8_t * network_pdu, uint16_t size);
74 void gatt_bearer_send_beacon(const uint8_t * beacon_update, uint16_t size);
75 void gatt_bearer_send_mesh_proxy_configuration(const uint8_t * proxy_configuration, uint16_t size);
76 
77 /* Utility functions */
78 /**
79  * Setup Proxy Advertisement for given network id
80  * @param buffer (20 bytes)
81  * @param network_id (8 bytes)
82  */
83 uint8_t gatt_bearer_setup_advertising_with_network_id(uint8_t * buffer, uint8_t * network_id);
84 
85 #if defined __cplusplus
86 }
87 #endif
88 
89 #endif // __GATT_BEARER_H
90