xref: /btstack/src/classic/pan.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
1 /*
2  * Copyright (C) 2014 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 /**
40  * @title Personal Area Network (PAN)
41  *
42  */
43 
44 #ifndef PAN_H
45 #define PAN_H
46 
47 #include <stdint.h>
48 #include "bluetooth.h"
49 
50 #if defined __cplusplus
51 extern "C" {
52 #endif
53 
54 /* API_START */
55 
56 /**
57  * @brief Creates SDP record for PANU BNEP service in provided empty buffer.
58  * @note Make sure the buffer is big enough.
59  *
60  * @param service is an empty buffer to store service record
61  * @param service_record_handle for new service
62  * @param network_packet_types array of types terminated by a 0x0000 entry
63  * @param name if NULL, the default service name will be assigned
64  * @param description if NULL, the default service description will be assigned
65  * @param security_desc
66  */
67 void pan_create_panu_sdp_record(uint8_t *service, uint32_t service_record_handle, uint16_t * network_packet_types, const char *name,
68 	const char *description, security_description_t security_desc);
69 
70 /**
71  * @brief Creates SDP record for GN BNEP service in provided empty buffer.
72  * @note Make sure the buffer is big enough.
73  *
74  * @param service is an empty buffer to store service record
75  * @param service_record_handle for new service
76  * @param network_packet_types array of types terminated by a 0x0000 entry
77  * @param name if NULL, the default service name will be assigned
78  * @param description if NULL, the default service description will be assigned
79  * @param security_desc
80  * @param IPv4Subnet is optional subnet definition, e.g. "10.0.0.0/8"
81  * @param IPv6Subnet is optional subnet definition given in the standard IETF format with the absolute attribute IDs
82  */
83 void pan_create_gn_sdp_record(uint8_t *service, uint32_t service_record_handle, uint16_t * network_packet_types, const char *name,
84 	const char *description, security_description_t security_desc, const char *IPv4Subnet,
85 	const char *IPv6Subnet);
86 
87 /**
88  * @brief Creates SDP record for NAP BNEP service in provided empty buffer.
89  * @note Make sure the buffer is big enough.
90  *
91  * @param service is an empty buffer to store service record
92  * @param service_record_handle for new service
93  * @param name if NULL, the default service name will be assigned
94  * @param network_packet_types array of types terminated by a 0x0000 entry
95  * @param description if NULL, the default service description will be assigned
96  * @param security_desc
97  * @param net_access_type type of available network access
98  * @param max_net_access_rate based on net_access_type measured in byte/s
99  * @param IPv4Subnet is optional subnet definition, e.g. "10.0.0.0/8"
100  * @param IPv6Subnet is optional subnet definition given in the standard IETF format with the absolute attribute IDs
101  */
102 void pan_create_nap_sdp_record(uint8_t *service, uint32_t service_record_handle, uint16_t * network_packet_types, const char *name,
103 	const char *description, security_description_t security_desc, net_access_type_t net_access_type,
104 	uint32_t max_net_access_rate, const char *IPv4Subnet, const char *IPv6Subnet);
105 
106 /* API_END */
107 
108 #if defined __cplusplus
109 }
110 #endif
111 #endif // PAN_H
112