xref: /btstack/src/mesh/mesh_iv_index_seq_number.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_IV_INDEX_SEQ_NUMBER_H
39 #define __MESH_IV_INDEX_SEQ_NUMBER_H
40 
41 #include <stdint.h>
42 
43 #ifdef __cplusplus
44 extern "C"
45 {
46 #endif
47 
48 /**
49  * IV Index
50  */
51 
52 void     mesh_set_iv_index(uint32_t iv_index);
53 uint32_t mesh_get_iv_index(void);
54 
55 uint32_t mesh_get_iv_index_for_tx(void);
56 
57 /**
58  * @brief Get IV Update state
59  */
60 int mesh_iv_update_active(void);
61 
62 /**
63  * @brief Trigger IV Update
64  */
65 void mesh_trigger_iv_update(void);
66 
67 /**
68  * @breif IV update was completed
69  */
70 void mesh_iv_update_completed(void);
71 
72 /**
73  * @brief IV Index was recovered
74  * @param iv_update_active
75  * @param iv_index
76  */
77 void mesh_iv_index_recovered(uint8_t iv_update_active, uint32_t iv_index);
78 
79 /**
80  * @brief Set callback for sequence number update
81  */
82 void mesh_sequence_number_set_update_callback(void (*callback)(void));
83 
84 /**
85  * Sequence Number
86  */
87 void     mesh_sequence_number_set(uint32_t seq);
88 uint32_t mesh_sequence_number_peek(void);
89 uint32_t mesh_sequence_number_next(void);
90 
91 
92 #ifdef __cplusplus
93 } /* end of extern "C" */
94 #endif
95 
96 #endif
97