nRF5 SDK for Mesh v5.0.0
ad_listener.h
1 /* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without modification,
5  * are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form, except as embedded into a Nordic
11  * Semiconductor ASA integrated circuit in a product or a software update for
12  * such product, must reproduce the above copyright notice, this list of
13  * conditions and the following disclaimer in the documentation and/or other
14  * materials provided with the distribution.
15  *
16  * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
17  * contributors may be used to endorse or promote products derived from this
18  * software without specific prior written permission.
19  *
20  * 4. This software, with or without modification, must only be used with a
21  * Nordic Semiconductor ASA integrated circuit.
22  *
23  * 5. Any software provided in binary form under this license must not be reverse
24  * engineered, decompiled, modified and/or disassembled.
25  *
26  * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
27  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28  * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
29  * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
30  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
32  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
35  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 #ifndef AD_LISTENER_H_
38 #define AD_LISTENER_H_
39 
40 #include <stdint.h>
41 #include "packet.h"
42 #include "nrf_mesh.h"
43 #include "scanner.h"
44 #include "nrf_mesh_section.h"
45 
55 /* Wildcard value enables any AD type. */
56 #define ADL_WILDCARD_AD_TYPE 0u
57 /* Wildcard value enables any advertisement packet type. */
58 #define ADL_WILDCARD_ADV_TYPE (ble_packet_type_t)0xFFu
59 
60 typedef void (* ad_handler_t)(const uint8_t * p_packet,
61  uint32_t ad_packet_length,
62  const nrf_mesh_rx_metadata_t * p_metadata);
63 
64 typedef struct
65 {
66  /* AD value from the specification or ADL_WILDCARD_AD_TYPE. */
67  uint8_t ad_type;
68  ble_packet_type_t adv_packet_type;
69  ad_handler_t handler;
71 
84 #define AD_LISTENER(name) NRF_MESH_SECTION_ITEM_REGISTER_FLASH(ad_listeners, const ad_listener_t name)
85 
89 void ad_listener_init(void);
90 
104 void ad_listener_process(ble_packet_type_t adv_type, const uint8_t * p_payload, uint32_t payload_length, const nrf_mesh_rx_metadata_t * p_metadata);
105 
108 #endif /* AD_LISTENER_H_ */
RX packet metadata.
Definition: nrf_mesh.h:161
void ad_listener_process(ble_packet_type_t adv_type, const uint8_t *p_payload, uint32_t payload_length, const nrf_mesh_rx_metadata_t *p_metadata)
Process the incoming data from the scanner.
void ad_listener_init(void)
Initialize the AD listener module.

Documentation feedback | Developer Zone | Subscribe | Updated