xref: /btstack/src/mesh/mesh_virtual_addresses.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_VIRTUAL_ADDRESSES_H
39 #define __MESH_VIRTUAL_ADDRESSES_H
40 
41 #include <stdint.h>
42 
43 #include "btstack_linked_list.h"
44 
45 #ifdef __cplusplus
46 extern "C"
47 {
48 #endif
49 
50 typedef struct {
51 	btstack_linked_item_t item;
52     uint16_t pseudo_dst;
53     uint16_t hash;
54     uint16_t ref_count;
55     uint8_t  label_uuid[16];
56 } mesh_virtual_address_t;
57 
58 typedef struct {
59 	btstack_linked_list_iterator_t it;
60 	uint16_t hash;
61 	mesh_virtual_address_t * address;
62 } mesh_virtual_address_iterator_t;
63 
64 // virtual address management
65 
66 uint16_t mesh_virtual_addresses_get_free_pseudo_dst(void);
67 
68 void mesh_virtual_address_add(mesh_virtual_address_t * virtual_address);
69 
70 void mesh_virtual_address_remove(mesh_virtual_address_t * virtual_address);
71 
72 mesh_virtual_address_t * mesh_virtual_address_register(uint8_t * label_uuid, uint16_t hash);
73 
74 mesh_virtual_address_t * mesh_virtual_address_for_pseudo_dst(uint16_t pseudo_dst);
75 
76 mesh_virtual_address_t * mesh_virtual_address_for_label_uuid(uint8_t * label_uuid);
77 
78 // virtual address iterator
79 
80 void mesh_virtual_address_iterator_init(mesh_virtual_address_iterator_t * it, uint16_t hash);
81 
82 int mesh_virtual_address_iterator_has_more(mesh_virtual_address_iterator_t * it);
83 
84 const mesh_virtual_address_t * mesh_virtual_address_iterator_get_next(mesh_virtual_address_iterator_t * it);
85 
86 
87 #ifdef __cplusplus
88 } /* end of extern "C" */
89 #endif
90 
91 #endif
92