device_state_manager.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 DEVICE_STATE_MANAGER_H__
#define DEVICE_STATE_MANAGER_H__

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

#include "nrf_mesh_config_app.h"
#include "toolchain.h"

#define DSM_ADDR_MAX (DSM_VIRTUAL_ADDR_MAX + DSM_NONVIRTUAL_ADDR_MAX)

#define DSM_HANDLE_INVALID (0xFFFF)

#define DSM_KEY_INDEX_MAX (NRF_MESH_GLOBAL_KEY_INDEX_MAX)

#define DSM_APP_MAX_LIMIT (247)

#define DSM_SUBNET_MAX_LIMIT (252)

#define DSM_ADDR_MAX_LIMIT (185)

typedef uint16_t mesh_key_index_t;
typedef uint16_t dsm_handle_t;

typedef struct
{
 uint16_t address_start; 
 uint16_t count; 
} dsm_local_unicast_address_t;

void dsm_init(void);

uint32_t dsm_load_config_apply(void);

void dsm_clear(void);

uint32_t dsm_address_publish_add(uint16_t raw_address, dsm_handle_t * p_address_handle);

uint32_t dsm_address_publish_add_handle(dsm_handle_t address_handle);

uint32_t dsm_address_publish_virtual_add(const uint8_t * p_label_uuid, dsm_handle_t * p_address_handle);

uint32_t dsm_address_publish_remove(dsm_handle_t address_handle);

uint32_t dsm_local_unicast_addresses_set(const dsm_local_unicast_address_t * p_address);

void dsm_local_unicast_addresses_get(dsm_local_unicast_address_t * p_address);

uint32_t dsm_address_subscription_add(uint16_t raw_address, dsm_handle_t * p_address_handle);

uint32_t dsm_address_subscription_virtual_add(const uint8_t * p_label_uuid, dsm_handle_t * p_address_handle);

uint32_t dsm_address_subscription_add_handle(dsm_handle_t address_handle);


_DEPRECATED bool dsm_address_subscription_get(dsm_handle_t address_handle);

_DEPRECATED bool dsm_address_is_rx(const nrf_mesh_address_t * p_addr);

uint32_t dsm_address_subscription_count_get(dsm_handle_t address_handle, uint16_t * p_count);

uint32_t dsm_address_subscription_remove(dsm_handle_t address_handle);

uint32_t dsm_address_get(dsm_handle_t address_handle, nrf_mesh_address_t * p_address);

uint32_t dsm_address_get_all(dsm_handle_t * p_address_handle_list, uint32_t * p_count);

uint32_t dsm_address_handle_get(const nrf_mesh_address_t * p_address, dsm_handle_t * p_address_handle);

dsm_handle_t dsm_net_key_index_to_subnet_handle(mesh_key_index_t net_key_index);

dsm_handle_t dsm_subnet_handle_get(const nrf_mesh_network_secmat_t * p_secmat);

uint32_t dsm_subnet_handle_to_netkey_index(dsm_handle_t subnet_handle, mesh_key_index_t * p_netkey_index);

uint32_t dsm_subnet_add(mesh_key_index_t net_key_id, const uint8_t * p_key, dsm_handle_t * p_subnet_handle);

uint32_t dsm_subnet_kr_phase_get(dsm_handle_t subnet_handle, nrf_mesh_key_refresh_phase_t * p_phase);

uint32_t dsm_subnet_update(dsm_handle_t subnet_handle, const uint8_t * p_key);

uint32_t dsm_subnet_update_swap_keys(dsm_handle_t subnet_handle);

uint32_t dsm_subnet_update_commit(dsm_handle_t subnet_handle);

uint32_t dsm_subnet_delete(dsm_handle_t subnet_handle);

uint32_t dsm_subnet_get_all(mesh_key_index_t * p_key_list, uint32_t * p_count);

uint32_t dsm_subnet_key_get(dsm_handle_t subnet_handle, uint8_t * p_key);

uint32_t dsm_devkey_add(uint16_t raw_unicast_addr, dsm_handle_t subnet_handle, const uint8_t * p_key, dsm_handle_t * p_devkey_handle);

uint32_t dsm_devkey_delete(dsm_handle_t dev_handle);

uint32_t dsm_devkey_handle_get(uint16_t unicast_address, dsm_handle_t * p_devkey_handle);

dsm_handle_t dsm_appkey_index_to_appkey_handle(mesh_key_index_t appkey_index);

dsm_handle_t dsm_appkey_handle_get(const nrf_mesh_application_secmat_t * p_secmat);

uint32_t dsm_appkey_handle_to_appkey_index(dsm_handle_t appkey_handle, mesh_key_index_t * p_index);

uint32_t dsm_appkey_handle_to_subnet_handle(dsm_handle_t appkey_handle, dsm_handle_t * p_netkey_handle);

uint32_t dsm_appkey_add(mesh_key_index_t app_key_id, dsm_handle_t subnet_handle, const uint8_t * p_key, dsm_handle_t * p_app_handle);

uint32_t dsm_appkey_update(dsm_handle_t app_handle, const uint8_t * p_key);

uint32_t dsm_appkey_delete(dsm_handle_t app_handle);

uint32_t dsm_appkey_get_all(dsm_handle_t subnet_handle, mesh_key_index_t * p_key_list, uint32_t * p_count);

uint32_t dsm_tx_secmat_get(dsm_handle_t subnet_handle, dsm_handle_t app_handle, nrf_mesh_secmat_t * p_secmat);

#if (MESH_FEATURE_LPN_ENABLED || MESH_FEATURE_FRIEND_ENABLED)

uint32_t dsm_tx_friendship_secmat_get(dsm_handle_t subnet_handle, dsm_handle_t app_handle, nrf_mesh_secmat_t * p_secmat);
#endif

uint32_t dsm_beacon_info_get(dsm_handle_t subnet_handle,
 const nrf_mesh_beacon_info_t ** pp_beacon_info);

uint32_t dsm_proxy_identity_get(dsm_handle_t subnet_handle, const uint8_t ** pp_identity);

uint32_t dsm_net_secmat_from_keyindex_get(mesh_key_index_t net_key_index,
 const nrf_mesh_network_secmat_t ** pp_net);

#endif /* DEVICE_STATE_MANAGER_H__ */