xref: /btstack/src/mesh/mesh_upper_transport.h (revision 0561b2d8d5dba972c7daa57d5e677f7a1327edfd)
1 /*
2  * Copyright (C) 2018 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 #ifndef __MESH_TRANSPORT_H
39 #define __MESH_TRANSPORT_H
40 
41 #include <stdint.h>
42 
43 #include "mesh/mesh_network.h"
44 #include "mesh/mesh_lower_transport.h"
45 
46 #ifdef __cplusplus
47 extern "C"
48 {
49 #endif
50 
51 void mesh_upper_transport_init(void);
52 
53 void mesh_upper_transport_message_processed_by_higher_layer(mesh_pdu_t * pdu);
54 
55 void mesh_upper_transport_set_higher_layer_handler(void (*pdu_handler)( mesh_transport_callback_type_t callback_type, mesh_transport_status_t status, mesh_pdu_t * pdu));
56 
57 // Control PDUs
58 
59 void mesh_upper_transport_register_control_message_handler(void (*callback)(mesh_pdu_t * pdu));
60 
61 uint8_t mesh_upper_transport_setup_control_pdu(mesh_pdu_t * pdu, uint16_t netkey_index,
62         uint8_t ttl, uint16_t src, uint16_t dest, uint8_t opcode, const uint8_t * control_pdu_data, uint16_t control_pdu_len);
63 
64 void mesh_upper_transport_send_control_pdu(mesh_pdu_t * pdu);
65 
66 // Access PDUs
67 
68 
69 void mesh_upper_transport_register_access_message_handler(void (*callback)(mesh_pdu_t * pdu));
70 
71 uint8_t mesh_upper_transport_setup_access_pdu_header(mesh_pdu_t * pdu, uint16_t netkey_index, uint16_t appkey_index,
72                                                                uint8_t ttl, uint16_t src, uint16_t dest, uint8_t szmic);
73 
74 uint8_t mesh_upper_transport_setup_access_pdu(mesh_pdu_t * pdu, uint16_t netkey_index, uint16_t appkey_index,
75                                                           uint8_t ttl, uint16_t src, uint16_t dest, uint8_t szmic,
76                                                           const uint8_t * access_pdu_data, uint8_t access_pdu_len);
77 
78 void mesh_upper_transport_send_access_pdu(mesh_pdu_t * pdu);
79 
80 void mesh_upper_transport_pdu_free(mesh_pdu_t * pdu);
81 
82 // test
83 void mesh_upper_transport_dump(void);
84 void mesh_upper_transport_reset(void);
85 
86 #ifdef __cplusplus
87 } /* end of extern "C" */
88 #endif
89 
90 #endif
91