config_messages.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 CONFIG_MESSAGES_H__
#define CONFIG_MESSAGES_H__

#include <stddef.h>
#include <stdint.h>

#include "nrf_mesh_assert.h"
#include "access.h"

#define CONFIG_RETRANSMIT_COUNT_MAX ((1 << 3) - 1)

#define CONFIG_RETRANSMIT_INTERVAL_STEPS_MAX ((1 << 5) - 1)

#define CONFIG_RETRANSMIT_INTERVAL_STEP_TO_MS(STEP) ((STEP) * 10)

#define CONFIG_RETRANSMIT_INTERVAL_MS_TO_STEP(MS) ((MS) / 10)

/*lint -align_max(push) -align_max(1) */

typedef struct __attribute((packed))
{
 uint8_t key_id_1_lsb; 
 uint8_t key_id_1_msb : 4; 
 uint8_t key_id_2_lsb : 4; 
 uint8_t key_id_2_msb; 
} config_msg_key_index_24_t;

/* Ensure the size of the above type is correct: */
NRF_MESH_STATIC_ASSERT(sizeof(config_msg_key_index_24_t) == 3);

static inline void config_msg_key_index_24_set(config_msg_key_index_24_t * p_idx24, uint16_t key_id_1, uint16_t key_id_2)
{
 p_idx24->key_id_1_lsb = key_id_1 & 0xff;
 p_idx24->key_id_1_msb = (key_id_1 >> 8) & 0xf;

 p_idx24->key_id_2_lsb = key_id_2 & 0xf;
 p_idx24->key_id_2_msb = (key_id_2 >> 4) & 0xff;
}

static inline void config_msg_key_index_24_get(const config_msg_key_index_24_t * p_idx24, uint16_t * p_key_id_1, uint16_t * p_key_id_2)
{
 if (p_key_id_1 != NULL)
 {
 *p_key_id_1 = p_idx24->key_id_1_lsb | (p_idx24->key_id_1_msb << 8);
 }

 if (p_key_id_2 != NULL)
 {
 *p_key_id_2 = p_idx24->key_id_2_lsb | (p_idx24->key_id_2_msb << 4);
 }
}

#define CONFIG_MSG_KEY_INDEX_12_MASK 0x0fff

typedef uint16_t config_msg_key_index_12_t;

typedef union __attribute((packed))
{
 struct __attribute((packed))
 {
 uint16_t model_id; 
 } sig;
 struct __attribute((packed))
 {
 uint16_t company_id; 
 uint16_t model_id; 
 } vendor;
} config_model_id_t;
NRF_MESH_STATIC_ASSERT(sizeof(config_model_id_t) == sizeof(uint32_t));

static inline void config_msg_model_id_set(config_model_id_t * p_dst, const access_model_id_t * p_src, bool is_sig)
{
 if (is_sig)
 {
 p_dst->sig.model_id = p_src->model_id;
 }
 else
 {
 p_dst->vendor.model_id = p_src->model_id;
 p_dst->vendor.company_id = p_src->company_id;
 }
}

typedef struct __attribute((packed))
{
 config_msg_key_index_24_t key_indexes; 
 uint8_t appkey[NRF_MESH_KEY_SIZE]; 
} config_msg_appkey_add_t;

typedef struct __attribute((packed))
{
 config_msg_key_index_24_t key_indexes; 
 uint8_t appkey[NRF_MESH_KEY_SIZE]; 
} config_msg_appkey_update_t;

typedef struct __attribute((packed))
{
 config_msg_key_index_24_t key_indexes; 
} config_msg_appkey_delete_t;

typedef struct __attribute((packed))
{
 uint8_t status; 
 config_msg_key_index_24_t key_indexes; 
} config_msg_appkey_status_t;

typedef struct __attribute((packed))
{
 config_msg_key_index_12_t netkey_index; 
} config_msg_appkey_get_t;

typedef struct __attribute((packed))
{
 uint8_t status; 
 config_msg_key_index_12_t netkey_index; 
 uint8_t packed_appkey_indexes[]; 
} config_msg_appkey_list_t;

typedef struct __attribute((packed))
{
 uint8_t ttl; 
} config_msg_default_ttl_set_t;

typedef struct __attribute((packed))
{
 uint8_t ttl; 
} config_msg_default_ttl_status_t;

typedef enum
{
 CONFIG_NET_BEACON_STATE_DISABLED = 0, 
 CONFIG_NET_BEACON_STATE_ENABLED = 1 
} config_net_beacon_state_t;

typedef struct __attribute((packed))
{
 uint8_t beacon_state; 
} config_msg_net_beacon_set_t;

typedef struct __attribute((packed))
{
 uint8_t beacon_state; 
} config_msg_net_beacon_status_t;

typedef struct __attribute((packed))
{
 uint16_t appkey_index : 12; 
 uint16_t credential_flag : 1; 
 uint16_t rfu : 3; 
 uint8_t publish_ttl; 
 uint8_t publish_period; 
 uint8_t retransmit_count : 3; 
 uint8_t retransmit_interval : 5; 
 config_model_id_t model_id; 
} config_publication_params_t;

typedef struct __attribute((packed))
{
 uint16_t element_address; 
 config_model_id_t model_id; 
} config_msg_publication_get_t;

typedef struct __attribute((packed))
{
 uint16_t element_address; 
 uint16_t publish_address; 
 config_publication_params_t state; 
} config_msg_publication_set_t;

typedef struct __attribute((packed))
{
 uint16_t element_address; 
 uint8_t publish_uuid[NRF_MESH_UUID_SIZE]; 
 config_publication_params_t state; 
} config_msg_publication_virtual_set_t;

typedef struct __attribute((packed))
{
 uint8_t status; 
 uint16_t element_address; 
 uint16_t publish_address; 
 config_publication_params_t state; 
} config_msg_publication_status_t;

typedef struct __attribute((packed))
{
 uint16_t element_address; 
 uint16_t address; 
 config_model_id_t model_id; 
} config_msg_subscription_add_del_owr_t;

typedef struct __attribute((packed))
{
 uint16_t element_address; 
 uint8_t virtual_uuid[NRF_MESH_UUID_SIZE]; 
 config_model_id_t model_id; 
} config_msg_subscription_virtual_add_del_owr_t;

typedef struct __attribute((packed))
{
 uint16_t element_address; 
 config_model_id_t model_id; 
} config_msg_subscription_delete_all_t;

typedef struct __attribute((packed))
{
 uint8_t status; 
 uint16_t element_address; 
 uint16_t address; 
 config_model_id_t model_id; 
} config_msg_subscription_status_t;

typedef struct __attribute((packed))
{
 config_msg_key_index_12_t netkey_index; 
 uint8_t netkey[NRF_MESH_KEY_SIZE]; 
} config_msg_netkey_add_update_t;

typedef struct __attribute((packed))
{
 config_msg_key_index_12_t netkey_index; 
} config_msg_netkey_delete_t;

typedef struct __attribute((packed))
{
 uint8_t status; 
 config_msg_key_index_12_t netkey_index; 
} config_msg_netkey_status_t;

typedef enum
{
 CONFIG_GATT_PROXY_STATE_RUNNING_DISABLED = 0x00, 
 CONFIG_GATT_PROXY_STATE_RUNNING_ENABLED = 0x01, 
 CONFIG_GATT_PROXY_STATE_UNSUPPORTED = 0x02 
} config_gatt_proxy_state_t;

typedef struct __attribute((packed))
{
 uint8_t proxy_state; 
} config_msg_proxy_status_t;

typedef struct __attribute((packed))
{
 uint8_t proxy_state; 
} config_msg_proxy_set_t;

typedef enum
{
 CONFIG_FRIEND_STATE_SUPPORTED_DISABLED = 0x00, 
 CONFIG_FRIEND_STATE_SUPPORTED_ENABLED = 0x01, 
 CONFIG_FRIEND_STATE_UNSUPPORTED = 0x02 
} config_friend_state_t;

typedef struct __attribute((packed))
{
 uint8_t friend_state; 
} config_msg_friend_set_t;

typedef struct __attribute((packed))
{
 uint8_t friend_state; 
} config_msg_friend_status_t;

typedef struct __attribute((packed))
{
 config_msg_key_index_12_t netkey_index; 
} config_msg_key_refresh_phase_get_t;

typedef struct __attribute((packed))
{
 config_msg_key_index_12_t netkey_index; 
 uint8_t transition; 
} config_msg_key_refresh_phase_set_t;

typedef struct __attribute((packed))
{
 uint8_t status; 
 config_msg_key_index_12_t netkey_index; 
 uint8_t phase; 
} config_msg_key_refresh_phase_status_t;

typedef struct __attribute((packed))
{
 uint16_t destination; 
 uint8_t count_log; 
 uint8_t period_log; 
 uint8_t ttl; 
 uint16_t features; 
 config_msg_key_index_12_t netkey_index; 
} config_msg_heartbeat_publication_set_t;

typedef struct __attribute((packed))
{
 uint8_t status; 
 uint16_t destination; 
 uint8_t count_log; 
 uint8_t period_log; 
 uint8_t ttl; 
 uint16_t features; 
 config_msg_key_index_12_t netkey_index; 
} config_msg_heartbeat_publication_status_t;

typedef struct __attribute((packed))
{
 uint16_t source; 
 uint16_t destination; 
 uint8_t period_log; 
} config_msg_heartbeat_subscription_set_t;

typedef struct __attribute((packed))
{
 uint8_t status; 
 uint16_t source; 
 uint16_t destination; 
 uint8_t period_log; 
 uint8_t count_log; 
 uint8_t min_hops; 
 uint8_t max_hops; 
} config_msg_heartbeat_subscription_status_t;

typedef struct __attribute((packed))
{
 uint16_t element_address; 
 config_msg_key_index_12_t appkey_index; 
 config_model_id_t model_id; 
} config_msg_app_bind_unbind_t;

typedef struct __attribute((packed))
{
 uint8_t status; 
 uint16_t element_address; 
 config_msg_key_index_12_t appkey_index; 
 config_model_id_t model_id; 
} config_msg_app_status_t;

typedef enum
{
 CONFIG_IDENTITY_STATE_STOPPED = 0x00, 
 CONFIG_IDENTITY_STATE_RUNNING = 0x01, 
 CONFIG_IDENTITY_STATE_UNSUPPORTED = 0x02 
} config_identity_state_t;

typedef struct __attribute((packed))
{
 config_msg_key_index_12_t netkey_index; 
} config_msg_identity_get_t;

typedef struct __attribute((packed))
{
 config_msg_key_index_12_t netkey_index; 
 uint8_t identity_state; 
} config_msg_identity_set_t;

typedef struct __attribute((packed))
{
 uint8_t status; 
 config_msg_key_index_12_t netkey_index; 
 uint8_t identity_state; 
} config_msg_identity_status_t;

typedef struct __attribute((packed))
{
 uint8_t page_number; 
} config_msg_composition_data_get_t;

typedef struct __attribute((packed))
{
 uint8_t page_number; 
 uint8_t data[]; 
} config_msg_composition_data_status_t;

typedef enum
{
 CONFIG_RELAY_STATE_SUPPORTED_DISABLED = 0x00, 
 CONFIG_RELAY_STATE_SUPPORTED_ENABLED = 0x01, 
 CONFIG_RELAY_STATE_UNSUPPORTED = 0x02 
} config_relay_state_t;

typedef struct __attribute((packed))
{
 uint8_t relay_state; 
 uint8_t relay_retransmit_count : 3; 
 uint8_t relay_retransmit_interval_steps : 5; 
} config_msg_relay_status_t;

typedef struct __attribute((packed))
{
 uint8_t relay_state; 
 uint8_t relay_retransmit_count : 3; 
 uint8_t relay_retransmit_interval_steps : 5; 
} config_msg_relay_set_t;

typedef struct __attribute((packed))
{
 uint8_t network_transmit_count : 3; 
 uint8_t network_transmit_interval_steps : 5; 
} config_msg_network_transmit_set_t;

typedef struct __attribute((packed))
{
 uint8_t network_transmit_count : 3; 
 uint8_t network_transmit_interval_steps : 5; 
} config_msg_network_transmit_status_t;

typedef struct __attribute((packed))
{
 uint16_t element_address; 
 config_model_id_t model_id; 
} config_msg_model_app_get_t;

typedef struct __attribute((packed))
{
 uint8_t status; 
 uint16_t element_address; 
 uint16_t sig_model_id; 
 uint8_t key_indexes[]; 
} config_msg_sig_model_app_list_t;

typedef struct __attribute((packed))
{
 uint8_t status; 
 uint16_t element_address; 
 uint16_t vendor_company_id; 
 uint16_t vendor_model_id; 
 uint8_t key_indexes[]; 
} config_msg_vendor_model_app_list_t;

typedef struct __attribute((packed))
{
 uint16_t element_address; 
 config_model_id_t model_id; 
} config_msg_model_subscription_get_t;

typedef struct __attribute((packed))
{
 uint8_t status; 
 uint16_t element_address; 
 uint16_t sig_model_id; 
 uint16_t subscriptions[]; 
} config_msg_sig_model_subscription_list_t;

typedef struct __attribute((packed))
{
 uint8_t status; 
 uint16_t element_address; 
 uint16_t vendor_company_id; 
 uint16_t vendor_model_id; 
 uint16_t subscriptions[]; 
} config_msg_vendor_model_subscription_list_t;

typedef struct __attribute((packed))
{
 uint16_t lpn_address; 
} config_msg_low_power_node_polltimeout_get_t;

typedef struct __attribute((packed))
{
 uint16_t lpn_address; 
 uint8_t polltimeout[3]; 
} config_msg_low_power_node_polltimeout_status_t;

/*lint -align_max(pop) */
#endif