xref: /btstack/src/ad_parser.h (revision 360243be41f47158adff357b9fead2686419a2df)
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 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 // *****************************************************************************
39 //
40 // Advertising Data Parser
41 //
42 // *****************************************************************************
43 
44 #ifndef __AD_PARSER_H
45 #define __AD_PARSER_H
46 
47 #include "btstack_config.h"
48 #include <stdint.h>
49 
50 #if defined __cplusplus
51 extern "C" {
52 #endif
53 
54 /* API_START */
55 
56 typedef struct ad_context {
57      const uint8_t * data;
58      uint8_t   offset;
59      uint8_t   length;
60 } ad_context_t;
61 
62 // Advertising or Scan Response data iterator
63 void ad_iterator_init(ad_context_t *context, uint8_t ad_len, const uint8_t * ad_data);
64 int  ad_iterator_has_more(const ad_context_t * context);
65 void ad_iterator_next(ad_context_t * context);
66 
67 // Access functions
68 uint8_t         ad_iterator_get_data_type(const ad_context_t * context);
69 uint8_t         ad_iterator_get_data_len(const ad_context_t * context);
70 const uint8_t * ad_iterator_get_data(const ad_context_t * context);
71 
72 // convenience function on complete advertisements
73 int ad_data_contains_uuid16(uint8_t ad_len, const uint8_t * ad_data, uint16_t uuid);
74 int ad_data_contains_uuid128(uint8_t ad_len, const uint8_t * ad_data, const uint8_t * uuid128);
75 
76 /* API_END */
77 
78 #if defined __cplusplus
79 }
80 #endif
81 #endif // __AD_PARSER_H
82