nrf_mesh_defines.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 NRF_MESH_DEFINES_H__
#define NRF_MESH_DEFINES_H__

/* Check platform defines */
#if defined(NRF51)
 #if defined(NRF52_SERIES)
 #error "Both NRF51 and NRF52_SERIES should not be defined."
 #endif
#elif !defined(NRF52_SERIES) && !defined(HOST)
 #error "At least NRF51, NRF52_SERIES or HOST must be defined."
#endif

#define NRF_MESH_SEG_PAYLOAD_SIZE_MAX (380)

#define NRF_MESH_UPPER_TRANSPORT_PDU_SIZE_MAX (384)

#define NRF_MESH_UNSEG_PAYLOAD_SIZE_MAX (11)

#define NRF_MESH_ADV_CHAN_ALL {37, 38, 39}

#define NRF_MESH_ADV_CHAN_DEFAULT NRF_MESH_ADV_CHAN_ALL

#define NRF_MESH_KEY_SIZE (16)

#define NRF_MESH_NETID_SIZE (8)

#define NRF_MESH_UUID_SIZE (16)

#define NRF_MESH_TTL_BIT_COUNT (7)

#define NRF_MESH_TTL_MAX ((1 << NRF_MESH_TTL_BIT_COUNT) - 1)

#define NRF_MESH_GLOBAL_KEY_INDEX_MAX (0xFFF)

#define NRF_MESH_BEACON_SECURE_NET_BCAST_INTERVAL_SECONDS 10

#define NRF_MESH_BEACON_OBSERVATION_PERIODS 2

#define NRF_MESH_BEACON_UNPROV_URI_HASH_SIZE (4)

#define NRF_MESH_ECDH_PUBLIC_KEY_SIZE (64)

#define NRF_MESH_ECDH_PRIVATE_KEY_SIZE (32)

#define NRF_MESH_ECDH_SHARED_SECRET_SIZE (32)

#define NRF_MESH_ADDR_UNASSIGNED (0x0000)

#define NRF_MESH_ALL_PROXIES_ADDR (0xFFFC)

#define NRF_MESH_ALL_FRIENDS_ADDR (0xFFFD)

#define NRF_MESH_ALL_RELAYS_ADDR (0xFFFE)

#define NRF_MESH_ALL_NODES_ADDR (0xFFFF)

#define NRF_MESH_ADDR_TYPE_BITS_OFFSET (14)

#define NRF_MESH_ADDR_TYPE_BITS_MASK (0xC000)

#if defined(NRF51)
#define NRF_MESH_IRQ_PRIORITY_THREAD (4)
#else
#define NRF_MESH_IRQ_PRIORITY_THREAD (15)
#endif

#if defined(NRF51)
#define NRF_MESH_IRQ_PRIORITY_LOWEST (3)
#else
#define NRF_MESH_IRQ_PRIORITY_LOWEST (6)
#endif

#define NETWORK_SEQNUM_BITS 24

#define NETWORK_SEQNUM_MAX ((1 << NETWORK_SEQNUM_BITS) - 1)

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

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

#define NETWORK_RELAY_INTERVAL_MAX_MS ((NETWORK_RELAY_INTERVAL_STEPS_MAX + 1) * 10)

#define NETWORK_MIN_IV_UPDATE_INTERVAL_MINUTES (96 * 60)

#define NETWORK_IV_RECOVERY_LIMIT 42

#define NETWORK_BEARER BEARER_ADV_RADIO

#define TRANSPORT_SAR_RX_TIMEOUT_MIN MS_TO_US(10000)

#define TRANSPORT_SAR_RX_TIMEOUT_MAX MS_TO_US(120000)

#define TRANSPORT_SAR_RX_ACK_TIMEOUT_BASE_MIN MS_TO_US(150)

#define TRANSPORT_SAR_RX_ACK_TIMEOUT_BASE_MAX MS_TO_US(10000)

#define TRANSPORT_SAR_RX_ACK_TIMEOUT_PER_HOP_ADDITION_MIN MS_TO_US(50)

#define TRANSPORT_SAR_RX_ACK_TIMEOUT_PER_HOP_ADDITION_MAX MS_TO_US(10000)

#define TRANSPORT_SAR_TX_RETRY_TIMEOUT_BASE_MIN MS_TO_US(200)

#define TRANSPORT_SAR_TX_RETRY_TIMEOUT_BASE_MAX MS_TO_US(10000)

#define TRANSPORT_SAR_TX_RETRY_TIMEOUT_PER_HOP_ADDITION_MIN MS_TO_US(200)

#define TRANSPORT_SAR_TX_RETRY_TIMEOUT_PER_HOP_ADDITION_MAX MS_TO_US(10000)

#define TRANSPORT_SAR_TX_TIMEOUT_MIN MS_TO_US(150)

#define TRANSPORT_SAR_TX_TIMEOUT_MAX MS_TO_US(60000)

#define TRANSPORT_SAR_TX_RETRIES_MIN (2)

#define TRANSPORT_SAR_TX_RETRIES_MAX (255)

#define TRANSPORT_SAR_SEQNUM_DIFF_MAX (8191)

#define HEARTBEAT_TRIGGER_TYPE_RELAY 0x0001

#define HEARTBEAT_TRIGGER_TYPE_PROXY 0x0002

#define HEARTBEAT_TRIGGER_TYPE_FRIEND 0x0004

#define HEARTBEAT_TRIGGER_TYPE_LPN 0x0008

#define HEARTBEAT_TRIGGER_TYPE_RFU_MASK 0x000F

#endif /* NRF_MESH_DEFINES_H__ */