mesh_lpn.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 MESH_LPN_H__
#define MESH_LPN_H__

#include <stdint.h>
#include "mesh_friendship_types.h"
#include "nrf_mesh_events.h"

#define MESH_LPN_FRIEND_REQUEST_TIMEOUT_MIN_MS 100

#define MESH_LPN_FRIEND_REQUEST_TIMEOUT_MAX_MS 1000

#define MESH_LPN_POLL_TIMEOUT_MIN_MS 1000

#define MESH_LPN_POLL_TIMEOUT_MAX_MS 345599900

/* See @tagMeshSp section 3.6.5.3 Friend Request */
#define MESH_LPN_RECEIVE_DELAY_MIN_MS 10

#define MESH_LPN_RECEIVE_DELAY_MAX_MS 255

#ifndef MESH_LPN_POLL_RETRY_COUNT
#define MESH_LPN_POLL_RETRY_COUNT 5
#endif

#ifndef MESH_LPN_FRIEND_REQUEST_RETRY_COUNT
#define MESH_LPN_FRIEND_REQUEST_RETRY_COUNT 5
#endif

#ifndef MESH_LPN_POLL_SEPARATION_INTERVAL_MS
#define MESH_LPN_POLL_SEPARATION_INTERVAL_MS 50
#endif


typedef struct
{
 uint8_t rssi_factor : 2;
 uint8_t receive_window_factor : 2;
 uint8_t friend_queue_size_min_log : 3;
} friend_criteria_t;

typedef struct
{
 uint32_t receive_delay_ms;
 uint32_t poll_timeout_ms;
 friend_criteria_t friend_criteria;
} mesh_lpn_friend_request_t;

void mesh_lpn_init(void);

uint32_t mesh_lpn_friend_request(mesh_lpn_friend_request_t friend_params,
 uint32_t request_timeout_ms);

uint32_t mesh_lpn_friend_accept(const nrf_mesh_evt_lpn_friend_offer_t * p_friend_offer);

uint32_t mesh_lpn_friend_poll(uint32_t delay_ms);

uint32_t mesh_lpn_poll_interval_set(uint32_t poll_interval_ms);

uint32_t mesh_lpn_friendship_terminate(void);

bool mesh_lpn_is_in_friendship(void);

#endif /* MESH_LPN_H__ */