scanner.h

/* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into a Nordic
 * Semiconductor ASA integrated circuit in a product or a software update for
 * such product, must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other
 * materials provided with the distribution.
 *
 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 * Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 * engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef SCANNER_H__
#define SCANNER_H__

#include <stdint.h>
#include <stdbool.h>
#include "nrf_mesh.h"
#include "timeslot_timer.h"
#include "radio_config.h"
#include "packet.h"
#include "bearer_event.h"

#define SCANNER_CHANNELS_MAX (3)
#define SCANNER_ACCESS_ADDR_INVALID (0x00000000)
#define SCANNER_CHANNELS_DEFAULT {37, 38, 39}

typedef struct
{
 nrf_mesh_rx_metadata_scanner_t metadata; 
 packet_t packet; 
} scanner_packet_t;

typedef struct
{
 uint32_t successful_receives; 
 uint32_t crc_failures; 
 uint32_t length_out_of_bounds; 
 uint32_t out_of_memory; 
} scanner_stats_t;

typedef void (*scanner_rx_callback_t)(const scanner_packet_t * p_packet, ts_timestamp_t rx_timestamp_ts);

void scanner_init(bearer_event_flag_callback_t packet_process_cb);

void scanner_rx_callback_set(scanner_rx_callback_t callback);

void scanner_enable(void);

void scanner_disable(void);

bool scanner_is_enabled(void);

const scanner_packet_t * scanner_rx(void);

bool scanner_rx_pending(void);

void scanner_packet_release(const scanner_packet_t * p_packet);

const scanner_stats_t * scanner_stats_get(void);

void scanner_config_radio_mode_set(radio_mode_t radio_mode);

void scanner_config_scan_time_set(uint32_t scan_interval_us, uint32_t scan_window_us);

void scanner_config_channels_set(const uint8_t * p_channels, uint8_t channel_count);

void scanner_config_access_addresses_set(const uint32_t * p_access_addresses, uint8_t address_count);

void scanner_config_reset(void);

void scanner_radio_start(ts_timestamp_t start_time);

void scanner_radio_stop(void);

void scanner_radio_irq_handler(void);

void scanner_timer_irq_handler(void);

#endif /* SCANNER_H__ */