nrf_mesh.h

/* Copyright (c) 2010 - 2018, 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 NRF_MESH_H__
#define NRF_MESH_H__

#include <stdint.h>
#include <stdbool.h>

#include "timer.h"

#include "ble.h"
#include "ble_gap.h"

#include "nrf_mesh_defines.h"
#include "nrf_mesh_config_core.h"

#include "nrf.h"
#include "nrf_sdm.h"

#define NRF_MESH_INITIAL_TOKEN 0x00000000ul

#define NRF_MESH_SERVICE_BORDER_TOKEN 0xF0000000ul

#define NRF_MESH_FRIEND_POLL_TOKEN 0xFFFFFFF8ul
#define NRF_MESH_FRIEND_REQUEST_TOKEN 0xFFFFFFF9ul
#define NRF_MESH_FRIEND_CLEAR_TOKEN 0xFFFFFFFAul
#define NRF_MESH_SUBMAN_ADD_TOKEN 0xFFFFFFFBul
#define NRF_MESH_SUBMAN_REMOVE_TOKEN 0xFFFFFFFCul
#define NRF_MESH_HEARTBEAT_TOKEN 0xFFFFFFFDul
#define NRF_MESH_SAR_TOKEN 0xFFFFFFFEul
#define NRF_MESH_RELAY_TOKEN 0xFFFFFFFFul

typedef void (*nrf_mesh_assertion_handler_t)(uint32_t pc);

typedef uint32_t nrf_mesh_tx_token_t;

typedef enum
{
 NRF_MESH_RX_SOURCE_SCANNER, 
 NRF_MESH_RX_SOURCE_GATT, 
 NRF_MESH_RX_SOURCE_FRIEND, 
 NRF_MESH_RX_SOURCE_LOW_POWER, 
 NRF_MESH_RX_SOURCE_INSTABURST, 
 NRF_MESH_RX_SOURCE_LOOPBACK, 
} nrf_mesh_rx_source_t;

typedef struct
{
 timestamp_t timestamp; 
 uint32_t access_addr; 
 uint8_t channel; 
 int8_t rssi; 
 ble_gap_addr_t adv_addr; 
 uint8_t adv_type; 
} nrf_mesh_rx_metadata_scanner_t;

typedef struct
{
 uint16_t data_id; 
 uint8_t set_id; 
} nrf_mesh_instaburst_event_id_t;

typedef struct
{
 timestamp_t timestamp; 
 uint8_t channel; 
 int8_t rssi; 
 struct
 {
 nrf_mesh_instaburst_event_id_t id; 
 uint8_t packet_index; 
 bool is_last_in_chain; 
 } event;
} nrf_mesh_rx_metadata_instaburst_t;

typedef struct
{
 timestamp_t timestamp; 
 uint16_t connection_index; 
} nrf_mesh_rx_metadata_gatt_t;

typedef struct
{
 nrf_mesh_tx_token_t tx_token; 
} nrf_mesh_rx_metadata_loopback_t;

typedef struct
{
 nrf_mesh_rx_source_t source; 
 union
 {
 nrf_mesh_rx_metadata_scanner_t scanner;
 nrf_mesh_rx_metadata_instaburst_t instaburst;
 nrf_mesh_rx_metadata_gatt_t gatt;
 nrf_mesh_rx_metadata_loopback_t loopback;
 } params;
} nrf_mesh_rx_metadata_t;

typedef bool (*nrf_mesh_relay_check_cb_t)(uint16_t src, uint16_t dst, uint8_t ttl);

typedef struct
{
 uint8_t adv_type; 
 uint8_t length; 
 const uint8_t * p_payload; 
 const nrf_mesh_rx_metadata_t * p_metadata; 
} nrf_mesh_adv_packet_rx_data_t;

typedef void (*nrf_mesh_rx_cb_t)(const nrf_mesh_adv_packet_rx_data_t * p_rx_data);

typedef enum
{
 NRF_MESH_KEY_REFRESH_PHASE_0,
 NRF_MESH_KEY_REFRESH_PHASE_1,
 NRF_MESH_KEY_REFRESH_PHASE_2,
 NRF_MESH_KEY_REFRESH_PHASE_3,
} nrf_mesh_key_refresh_phase_t;

typedef struct
{
 bool is_device_key;
 uint8_t aid;
 uint8_t key[NRF_MESH_KEY_SIZE];
} nrf_mesh_application_secmat_t;

typedef struct
{
 uint8_t nid;
 uint8_t encryption_key[NRF_MESH_KEY_SIZE];
 uint8_t privacy_key[NRF_MESH_KEY_SIZE];
} nrf_mesh_network_secmat_t;

typedef struct
{
 uint8_t key[NRF_MESH_KEY_SIZE];
 uint8_t net_id[NRF_MESH_NETID_SIZE];
#if MESH_FEATURE_GATT_PROXY_ENABLED

 uint8_t identity_key[NRF_MESH_KEY_SIZE];
#endif
} nrf_mesh_beacon_secmat_t;

typedef struct
{
 uint16_t rx_count[NRF_MESH_BEACON_OBSERVATION_PERIODS];
 timestamp_t tx_timestamp;
} nrf_mesh_beacon_tx_info_t;

typedef struct
{
 bool iv_update_permitted;
 nrf_mesh_beacon_tx_info_t * p_tx_info;
 nrf_mesh_beacon_secmat_t secmat;
 nrf_mesh_beacon_secmat_t secmat_updated;
} nrf_mesh_beacon_info_t;

typedef struct
{
 const nrf_mesh_network_secmat_t * p_net;
 const nrf_mesh_application_secmat_t * p_app;
} nrf_mesh_secmat_t;

typedef enum
{
 NET_STATE_IV_UPDATE_NORMAL,
 NET_STATE_IV_UPDATE_IN_PROGRESS,
} net_state_iv_update_t;

typedef enum
{
 NRF_MESH_ADDRESS_TYPE_INVALID,
 NRF_MESH_ADDRESS_TYPE_UNICAST,
 NRF_MESH_ADDRESS_TYPE_VIRTUAL,
 NRF_MESH_ADDRESS_TYPE_GROUP,
} nrf_mesh_address_type_t;

typedef struct
{
 nrf_mesh_address_type_t type;
 uint16_t value;
 const uint8_t * p_virtual_uuid;
} nrf_mesh_address_t;

typedef enum
{
 NRF_MESH_TRANSMIC_SIZE_SMALL,
 NRF_MESH_TRANSMIC_SIZE_LARGE,
 NRF_MESH_TRANSMIC_SIZE_DEFAULT,
 NRF_MESH_TRANSMIC_SIZE_INVALID
} nrf_mesh_transmic_size_t;

typedef struct
{
 nrf_mesh_address_t dst;
 uint16_t src;
 uint8_t ttl;
 bool force_segmented;
 nrf_mesh_transmic_size_t transmic_size;
 const uint8_t * p_data;
 uint16_t data_len;
 nrf_mesh_secmat_t security_material;
 nrf_mesh_tx_token_t tx_token;
} nrf_mesh_tx_params_t;

typedef struct
{
#if (defined(S140) || defined(S130) || defined(S132) || defined(S112) || defined(HOST))
 nrf_clock_lf_cfg_t lfclksrc; 
#elif defined(S110)
 nrf_clock_lfclksrc_t lfclksrc; 
#else
 #error "Unknown target softdevice version"
#endif
 nrf_mesh_relay_check_cb_t relay_cb; 
 uint8_t irq_priority; 
 const uint8_t * p_uuid; 
} nrf_mesh_init_params_t;

uint32_t nrf_mesh_init(const nrf_mesh_init_params_t * p_init_params);

uint32_t nrf_mesh_enable(void);

uint32_t nrf_mesh_disable(void);

uint32_t nrf_mesh_packet_send(const nrf_mesh_tx_params_t * p_params,
 uint32_t * const p_packet_reference);

bool nrf_mesh_process(void);

uint32_t nrf_mesh_on_sd_evt(uint32_t sd_evt);

void nrf_mesh_rx_cb_set(nrf_mesh_rx_cb_t rx_cb);

void nrf_mesh_rx_cb_clear(void);

void nrf_mesh_subnet_added(uint16_t net_key_index, const uint8_t * p_network_id);

nrf_mesh_tx_token_t nrf_mesh_unique_token_get(void);

#endif /* NRF_MESH_H__ */