config.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2024-2026 Carl Seifert
 * SPDX-FileCopyrightText: 2024-2026 TU Dresden
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once
 
#include <assert.h>
 
#include "modules.h"


 
/* MARK: - Essentials */
#if !defined(CONFIG_UNICOAP_CREATE_THREAD) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_CREATE_THREAD 1
#endif

#if !defined(CONFIG_UNICOAP_DEBUG_LOGGING) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_DEBUG_LOGGING 0
#endif

#if !defined(CONFIG_UNICOAP_ASSIST) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_ASSIST CONFIG_UNICOAP_DEBUG_LOGGING
#endif
 
#if CONFIG_UNICOAP_DEBUG_LOGGING && !CONFIG_UNICOAP_ASSIST
#  warning Disabling CONFIG_UNICOAP_ASSIST when CONFIG_UNICOAP_DEBUG_LOGGING is enabled has no effect because debug logging implies emitting asstistance diagnostics.
#endif
 
/* MARK: - Ports and Sockets */
#define UNICOAP_DEFAULT_COAP_PORT  (5683)

#define UNICOAP_DEFAULT_COAPS_PORT (5684)

#if !defined(CONFIG_UNICOAP_UDP_PORT) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_UDP_PORT UNICOAP_DEFAULT_COAP_PORT
#endif

#if !defined(CONFIG_UNICOAP_DTLS_PORT) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_DTLS_PORT UNICOAP_DEFAULT_COAPS_PORT
#endif

#if !defined(CONFIG_UNICOAP_SOCK_ZERO_COPY_GUARANTEES) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_SOCK_ZERO_COPY_GUARANTEES IS_USED(MODULE_GNRC_SOCK_UDP)
#endif

#if !defined(CONFIG_UNICOAP_GET_LOCAL_ENDPOINTS) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_GET_LOCAL_ENDPOINTS 1
#endif
 
/* MARK: - Limits */
#if !defined(CONFIG_UNICOAP_OPTIONS_MAX) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_OPTIONS_MAX (16)
#endif

#if !defined(CONFIG_UNICOAP_OPTIONS_BUFFER_DEFAULT_CAPACITY) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_OPTIONS_BUFFER_DEFAULT_CAPACITY (32)
#endif

#define UNICOAP_HEADER_SIZE_MAX (15)
/* MARK: unicoap_driver_extension_point */
/* Developer note: If you are adding another CoAP driver, you may need to increase this value. */

#if !defined(CONFIG_UNICOAP_EXTERNAL_TOKEN_LENGTH_MAX) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_EXTERNAL_TOKEN_LENGTH_MAX (8)
#endif
 
static_assert(CONFIG_UNICOAP_EXTERNAL_TOKEN_LENGTH_MAX > 0,
              "CONFIG_UNICOAP_EXTERNAL_TOKEN_LENGTH_MAX must not be zero");

#if !defined(CONFIG_UNICOAP_GENERATED_TOKEN_LENGTH) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_GENERATED_TOKEN_LENGTH (2)
#endif
 
static_assert(CONFIG_UNICOAP_GENERATED_TOKEN_LENGTH > 0,
              "CONFIG_UNICOAP_GENERATED_TOKEN_LENGTH must not be zero");

#define UNICOAP_ETAG_LENGTH_FIXED_WIDTH 4

#if !defined(CONFIG_UNICOAP_PDU_SIZE_MAX) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_PDU_SIZE_MAX (128)
#endif

#if !defined(CONFIG_UNICOAP_WELL_KNOWN_CORE_SIZE_MAX) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_WELL_KNOWN_CORE_SIZE_MAX (120)
#endif
 
/* MARK: - Timing */

#define UNICOAP_NSTART          (1)

#define UNICOAP_DEFAULT_LEISURE (5)
 
/* MARK: - Resource observation */
#if !defined(CONFIG_UNICOAP_OBSERVE_VALUE_WIDTH) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_OBSERVE_VALUE_WIDTH (3)
#endif

#if (CONFIG_UNICOAP_OBSERVE_VALUE_WIDTH == 3)
#  define UNICOAP_OBSERVE_TICK_EXPONENT (0)
#elif (CONFIG_UNICOAP_OBSERVE_VALUE_WIDTH == 2)
#  define UNICOAP_OBSERVE_TICK_EXPONENT (6)
#elif (CONFIG_UNICOAP_OBSERVE_VALUE_WIDTH == 1)
#  define UNICOAP_OBSERVE_TICK_EXPONENT (14)
#else
#  error CONFIG_UNICOAP_OBSERVE_VALUE_WIDTH must not exceed 3
#endif
 
/* MARK: - Server */
#if !defined(CONFIG_UNICOAP_PREVENT_OPTIONAL_RESPONSES) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_PREVENT_OPTIONAL_RESPONSES 0
#endif
#if !defined(CONFIG_UNICOAP_WELL_KNOWN_CORE) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_WELL_KNOWN_CORE (1)
#endif
 
/* MARK: - RFC 7252 messaging */
#if !defined(CONFIG_UNICOAP_RANDOM_FACTOR_1000) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_RANDOM_FACTOR_1000 (1500)
#endif

#define UNICOAP_TIMEOUT_ACK_RANGE_UPPER \
    ((uint32_t)CONFIG_UNICOAP_TIMEOUT_ACK_MS * CONFIG_UNICOAP_RANDOM_FACTOR_1000 / 1000)

#if !defined(CONFIG_UNICOAP_TIMEOUT_ACK_MS) || DOXYGEN
#  define CONFIG_UNICOAP_TIMEOUT_ACK_MS (2000)
#endif

#if !defined(CONFIG_UNICOAP_RETRANSMISSIONS_MAX) || DOXYGEN
#  define CONFIG_UNICOAP_RETRANSMISSIONS_MAX (4)
#endif
 
static_assert(CONFIG_UNICOAP_RETRANSMISSIONS_MAX < 32,
              "CONFIG_UNICOAP_RETRANSMISSIONS_MAX must not exceed 31");

#if !defined(CONFIG_UNICOAP_RFC7252_TRANSMISSIONS_MAX) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_RFC7252_TRANSMISSIONS_MAX 2
#endif
 
/* TODO: Client and advanced server features: Limit to exchange-layer state objects */

#if !defined(CONFIG_UNICOAP_CARBON_COPIES_MAX) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_CARBON_COPIES_MAX (2)
#endif
 
/* MARK: - DTLS */
#if !defined(CONFIG_UNICOAP_DTLS_HANDSHAKE_TIMEOUT_MS) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_DTLS_HANDSHAKE_TIMEOUT_MS (3 * MS_PER_SEC)
#endif

#if !defined(CONFIG_UNICOAP_DTLS_MINIMUM_AVAILABLE_SESSION_SLOTS) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_DTLS_MINIMUM_AVAILABLE_SESSION_SLOTS (1)
#endif

#if !defined(CONFIG_UNICOAP_DTLS_MINIMUM_AVAILABLE_SESSION_SLOTS_TIMEOUT_MS) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_DTLS_MINIMUM_AVAILABLE_SESSION_SLOTS_TIMEOUT_MS (15 * MS_PER_SEC)
#endif
 
/* MARK: - Stack sizes */
#if !defined(UNICOAP_STACK_SIZE) || defined(DOXYGEN)

#  if IS_USED(MODULE_UNICOAP_DRIVER_DTLS)
#    define UNICOAP_DTLS_EXTRA_STACKSIZE (THREAD_STACKSIZE_DEFAULT)
#  else
#    define UNICOAP_DTLS_EXTRA_STACKSIZE (0)
#  endif

#  define UNICOAP_STACK_SIZE (THREAD_STACKSIZE_DEFAULT + DEBUG_EXTRA_STACKSIZE + \
       CONFIG_UNICOAP_OPTIONS_BUFFER_DEFAULT_CAPACITY + UNICOAP_DTLS_EXTRA_STACKSIZE)
#endif
 
/* TODO: Put the following into the Automatic Block-wise Transfers Group once available */

#if !defined(CONFIG_UNICOAP_BLOCK_SIZE) || defined(DOXYGEN)
#  define CONFIG_UNICOAP_BLOCK_SIZE (32)
#endif
 
#ifndef DOXYGEN
#  ifdef CONFIG_UNICOAP_BLOCK_SZX
#    error CONFIG_UNICOAP_BLOCK_SZX must not be configured manually.
#  endif
#  if CONFIG_UNICOAP_BLOCK_SIZE == 1024
#    define CONFIG_UNICOAP_BLOCK_SZX (6)
#  elif CONFIG_UNICOAP_BLOCK_SIZE == 512
#    define CONFIG_UNICOAP_BLOCK_SZX (5)
#  elif CONFIG_UNICOAP_BLOCK_SIZE == 256
#    define CONFIG_UNICOAP_BLOCK_SZX (4)
#  elif CONFIG_UNICOAP_BLOCK_SIZE == 128
#    define CONFIG_UNICOAP_BLOCK_SZX (3)
#  elif CONFIG_UNICOAP_BLOCK_SIZE == 64
#    define CONFIG_UNICOAP_BLOCK_SZX (2)
#  elif CONFIG_UNICOAP_BLOCK_SIZE == 32
#    define CONFIG_UNICOAP_BLOCK_SZX (1)
#  elif CONFIG_UNICOAP_BLOCK_SIZE == 16
#    define CONFIG_UNICOAP_BLOCK_SZX (0)
#  else
#    error CONFIG_UNICOAP_BLOCK_SIZE must be 1024, 512, 256, 128, 64, 32, or 16
#  endif
#endif
 
/* TODO: Add static_asserts once other Block-wise parameters are available */
 
#ifdef __cplusplus
extern "C" {
}
#endif