xref: /btstack/src/mesh/mesh.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
1 /*
2  * Copyright (C) 2019 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 #ifndef __MESH_H
39 #define __MESH_H
40 
41 #include "btstack_defines.h"
42 #include "mesh/provisioning.h"
43 #include "mesh/mesh_keys.h"
44 #include "mesh/mesh_access.h"
45 #include "mesh/mesh_virtual_addresses.h"
46 
47 #if defined __cplusplus
48 extern "C" {
49 #endif
50 
51 /**
52  * Init Mesh network stack
53  */
54 void mesh_init(void);
55 
56 /**
57  * Register for Mesh Provisioning Device events
58  * @param packet_handler
59  */
60 void mesh_register_provisioning_device_packet_handler(btstack_packet_handler_t packet_handler);
61 
62 // Mesh Virtual Address Management
63 void mesh_load_virtual_addresses(void);
64 void mesh_delete_virtual_addresses(void);
65 void mesh_virtual_address_decrease_refcount(mesh_virtual_address_t * virtual_address);
66 void mesh_virtual_address_increase_refcount(mesh_virtual_address_t * virtual_address);
67 
68 // Foundation state
69 void mesh_foundation_state_load(void);
70 void mesh_foundation_state_store(void);
71 
72 // Mesh Model Subscriptions
73 void mesh_load_subscriptions(void);
74 void mesh_model_store_subscriptions(mesh_model_t * model);
75 void mesh_delete_subscriptions(void);
76 
77 // Mesh Model Publication
78 void mesh_load_publications(void);
79 void mesh_delete_publications(void);
80 void mesh_model_store_publication(mesh_model_t * mesh_model);
81 
82 // Mesh NetKey List
83 void mesh_store_network_key(mesh_network_key_t * network_key);
84 void mesh_delete_network_key(uint16_t internal_index);
85 void mesh_delete_network_keys(void);
86 void mesh_load_network_keys(void);
87 
88 // Mesh Appkeys
89 void mesh_store_app_key(mesh_transport_key_t * app_key);
90 void mesh_delete_app_key(uint16_t internal_index);
91 void mesh_delete_app_keys(void);
92 void mesh_load_app_keys(void);
93 
94 // Mesh Model to Appkey List
95 void mesh_load_appkey_lists(void);
96 void mesh_delete_appkey_lists(void);
97 uint8_t mesh_model_bind_appkey(mesh_model_t * mesh_model, uint16_t appkey_index);
98 void mesh_model_unbind_appkey(mesh_model_t * mesh_model, uint16_t appkey_index);
99 int mesh_model_contains_appkey(mesh_model_t * mesh_model, uint16_t appkey_index);
100 
101 // Mesh Node Reset
102 void mesh_node_reset(void);
103 
104 // Attention Timer
105 void    mesh_attention_timer_set(uint8_t timer_s);
106 uint8_t mesh_attention_timer_get(void);
107 
108 // temp
109 void mesh_access_key_refresh_revoke_keys(mesh_subnet_t * subnet);
110 void mesh_access_netkey_finalize(mesh_network_key_t * network_key);
111 void mesh_access_appkey_finalize(mesh_transport_key_t * transport_key);
112 
113 #if defined __cplusplus
114 }
115 #endif
116 
117 #endif //__MESH_H
118