xref: /btstack/src/mesh/pb_adv.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
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 BLUEKITCHEN
24  * GMBH 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 __PB_ADV_H
40 #define __PB_ADV_H
41 
42 #include <stdint.h>
43 
44 #include "btstack_defines.h"
45 #include "btstack_config.h"
46 
47 #if defined __cplusplus
48 extern "C" {
49 #endif
50 
51 /**
52  * Initialize Provisioning Bearer using Advertisement Bearer
53  */
54 void pb_adv_init(void);
55 
56 /**
57  * Register provisioning device listener for Provisioning PDUs and MESH_PBV_ADV_SEND_COMPLETE
58  */
59 void pb_adv_register_device_packet_handler(btstack_packet_handler_t packet_handler);
60 
61 /**
62  * Register provisioning provisioner listener for Provisioning PDUs and MESH_PBV_ADV_SEND_COMPLETE
63  */
64 void pb_adv_register_provisioner_packet_handler(btstack_packet_handler_t packet_handler);
65 
66 /**
67  * Send Provisioning PDU
68  * @param pb_adv_cid
69  * @param pdu
70  * @param pb_adv_cid
71  */
72 void pb_adv_send_pdu(uint16_t pb_adv_cid, const uint8_t * pdu, uint16_t pdu_size);
73 
74 /**
75  * Close Link
76  * @param pb_adv_cid
77  * @param reason 0 = success, 1 = timeout, 2 = fail
78  */
79 void pb_adv_close_link(uint16_t pb_adv_cid, uint8_t reason);
80 
81 #ifdef ENABLE_MESH_PROVISIONER
82 /**
83  * Setup Link with unprovisioned device
84  * @param DeviceUUID - data not copied
85  * @return pb_adv_cid or 0
86  */
87 uint16_t pb_adv_create_link(const uint8_t * device_uuid);
88 #endif
89 
90 #if defined __cplusplus
91 }
92 #endif
93 
94 #endif // __PB_ADV_H
95