sdk_config.h

/* Copyright (c) 2013 Nordic Semiconductor. All Rights Reserved.
 *
 * The information contained herein is property of Nordic Semiconductor ASA.
 * Terms and conditions of usage are described in detail in NORDIC
 * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
 *
 * Licensees are granted free, non-transferable use of the information. NO
 * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
 * the file.
 *
 */
#ifndef SDK_CONFIG_H__
#define SDK_CONFIG_H__


#define APP_TIMER_PRESCALER 			0
#define APP_TIMER_MAX_TIMERS			4
#define APP_TIMER_OP_QUEUE_SIZE		4

#define HTONL(n) (((((unsigned long)(n) & 0xFF)) << 24) |       \
                  ((((unsigned long)(n) & 0xFF00)) << 8) |      \
                  ((((unsigned long)(n) & 0xFF0000)) >> 8) |    \
                  ((((unsigned long)(n) & 0xFF000000)) >> 24))

/**
 * @defgroup sdk_config SDK Configuration
 * @{
 * @ingroup sdk_common
 * @{
 * @details All parameters that allow configuring/tuning the SDK based on application/ use case
 *          are defined here.
 */


/**
 * @defgroup mem_manager_config Memory Manager Configuration
 * @{
 * @addtogroup sdk_config
 * @{
 * @details This section defines configuration of memory manager module.
 */

/**
 * @brief Maximum memory blocks identified as 'small' blocks.
 *
 * @details Maximum memory blocks identified as 'small' blocks.
 *          Minimum value : 0 (Setting to 0 disables all 'small' blocks)
 *          Maximum value : 255
 *          Dependencies  : None.
 */
#define  MEMORY_MANAGER_SMALL_BLOCK_COUNT                  8

/**
 * @brief Size of each memory blocks identified as 'small' block.
 *
 * @details Size of each memory blocks identified as 'small' block.
 *          Memory block are recommended to be word-sized.
 *          Minimum value : 32
 *          Maximum value : A value less than the next pool size. If only small pool is used, this
 *                          can be any value based on availability of RAM.
 *          Dependencies  : MEMORY_MANAGER_SMALL_BLOCK_COUNT is non-zero.
 */
#define  MEMORY_MANAGER_SMALL_BLOCK_SIZE                   128

/**
 * @brief Maximum memory blocks identified as 'medium' blocks.
 *
 * @details Maximum memory blocks identified as 'medium' blocks.
 *          Minimum value : 0 (Setting to 0 disables all 'medium' blocks)
 *          Maximum value : 255
 *          Dependencies  : None.
 */
#define  MEMORY_MANAGER_MEDIUM_BLOCK_COUNT                 4

/**
 * @brief Size of each memory blocks identified as 'medium' block.
 *
 * @details Size of each memory blocks identified as 'medium' block.
 *          Memory block are recommended to be word-sized.
 *          Minimum value : A value greater than the small pool size if defined, else 32.
 *          Maximum value : A value less than the next pool size. If only medium pool is used, this
 *                          can be any value based on availability of RAM.
 *          Dependencies  : MEMORY_MANAGER_MEDIUM_BLOCK_COUNT is non-zero.
 */
#define  MEMORY_MANAGER_MEDIUM_BLOCK_SIZE                  256

/**
 * @brief Maximum memory blocks identified as 'medium' blocks.
 *
 * @details Maximum memory blocks identified as 'medium' blocks.
 *          Minimum value : 0 (Setting to 0 disables all 'large' blocks)
 *          Maximum value : 255
 *          Dependencies  : None.
 */
#define  MEMORY_MANAGER_LARGE_BLOCK_COUNT                  3

/**
 * @brief Size of each memory blocks identified as 'medium' block.
 *
 * @details Size of each memory blocks identified as 'medium' block.
 *          Memory block are recommended to be word-sized.
 *          Minimum value : A value greater than the small &/ medium pool size if defined, else 32.
 *          Maximum value : Any value based on availability of RAM.
 *          Dependencies  : MEMORY_MANAGER_MEDIUM_BLOCK_COUNT is non-zero.
 */
#define  MEMORY_MANAGER_LARGE_BLOCK_SIZE                   1024

/**
 * @brief Disable debug trace in the module.
 *
 * @details Set this define to 1 to enable debug trace in the module, else set to 0.
 *          Possible values : 0 or 1.
 *          Dependencies    : ENABLE_DEBUG_LOG_SUPPORT. If this flag is not defined, no
 *                            trace is observed even if this define is set to 1.
 */
#define MEM_MANAGER_DISABLE_LOGS                           1

/**
 * @brief Disables API parameter checks in the module.
 *
 * @details Set this define to 1 to disable checks on API parameters in the module.
 *          API parameter checks are added to ensure right parameters are passed to the
 *          module. These checks are useful during development phase but be redundant
 *          once application is developed. Disabling this can result in some code saving.
 *          Possible values : 0 or 1.
 *          Dependencies    : None.
 */
#define MEM_MANAGER_DISABLE_API_PARAM_CHECK                0
/** @} */
/** @} */


/**
 * @defgroup iot_pbuffer_config Memory Manager Configuration
 * @{
 * @addtogroup iot_config
 * @{
 * @details This section defines configuration of memory manager module.
 */

/**
 * @brief Maximum packet buffers managed by the module.
 *
 * @details Maximum packet buffers managed by the module.
 *          Minimum value : 1
 *          Maximum value : 255
 *          Dependencies  : None.
 */
#define IOT_PBUFFER_MAX_COUNT                              10

/**
 * @brief Disable debug trace in the module.
 *
 * @details Set this define to 1 to enable debug trace in the module, else set to 0.
 *          Possible values : 0 or 1.
 *          Dependencies    : ENABLE_DEBUG_LOG_SUPPORT. If this flag is not defined, no
 *                            trace is observed even if this define is set to 1.
 */
#define IOT_PBUFFER_DISABLE_LOGS                           1

/**
 * @brief Disables API parameter checks in the module.
 *
 * @details Set this define to 1 to disable checks on API parameters in the module.
 *          API parameter checks are added to ensure right parameters are passed to the
 *          module. These checks are useful during development phase but be redundant
 *          once application is developed. Disabling this can result in some code saving.
 *          Possible values : 0 or 1.
 *          Dependencies    : None.
 */
#define IOT_PBUFFER_DISABLE_API_PARAM_CHECK                0

/**
 * @defgroup iot_context_manager Context Manager Configurations.
 * @{
 * @addtogroup iot_config
 * @{
 * @details This section defines configuration of Context Manager.
 */
/**
 * @brief Disable debug trace in the module.
 *
 * @details Set this define to 1 to enable debug trace in the module, else set to 0.
 *          Possible values : 0 or 1.
 *          Dependencies    : ENABLE_DEBUG_LOG_SUPPORT. If this flag is not defined, no
 *                            trace is observed even if this define is set to 1.
 */
#define IOT_CONTEXT_MANAGER_DISABLE_LOGS                   1

/**
 * @brief Disables API parameter checks in the module.
 *
 * @details Set this define to 1 to disable checks on API parameters in the module.
 *          API parameter checks are added to ensure right parameters are passed to the
 *          module. These checks are useful during development phase but be redundant
 *          once application is developed. Disabling this can result in some code saving.
 *          Possible values : 0 or 1.
 *          Dependencies    : None.
 */
#define IOT_CONTEXT_MANAGER_DISABLE_API_PARAM_CHECK        0

/**
 * @brief Maximum number of supported context identifiers.
 *
 * @details Maximum value of 16 is preferable to correct decompression.
 *          Minimum value : 1
 *          Maximum value : 16
 *          Dependencies  : None.
 */
#define  IOT_CONTEXT_MANAGER_MAX_CONTEXTS                  16

/**
 * @brief Maximum number of supported context's table.
 *
 * @details If value is equal to BLE_IPSP_MAX_CHANNELS then all interface will have
 *          its own table which is preferable.
 *          Minimum value : 1
 *          Maximum value : BLE_IPSP_MAX_CHANNELS
 *          Dependencies  : None.
 */
#define  IOT_CONTEXT_MANAGER_MAX_TABLES                    1
/** @} */
/** @} */



/**
 * @defgroup ipv6_stack_config Noridc's IPv6 Stack configuration.
 * @{
 * @addtogroup iot_config
 * @{
 * @details This section defines configuration of Noridc's IPv6 Stack.
 */

/**
 * @brief Disable debug trace in the module.
 *
 * @details Set this define to 1 to enable debug trace in the module, else set to 0.
 *          Possible values : 0 or 1.
 *          Dependencies    : ENABLE_DEBUG_LOG_SUPPORT. If this flag is not defined, no
 *                            trace is observed even if this define is set to 1.
 */
#define IPV6_DISABLE_LOGS                                  1
/**
 * @brief Disables API parameter checks in the module.
 *
 * @details Set this define to 1 to disable checks on API parameters in the module.
 *          API parameter checks are added to ensure right parameters are passed to the
 *          module. These checks are useful during development phase but be redundant
 *          once application is developed. Disabling this can result in some code saving.
 *          Possible values : 0 or 1.
 *          Dependencies    : None.
 */
#define IPV6_DISABLE_API_PARAM_CHECK                       0

/**
 * @brief Maximum number of supported context identifiers.
 *
 * @details Maximum value of 16 is preferable to correct decompression.
 *          Minimum value : 1
 *          Maximum value : BLE_IPSP_MAX_CHANNELS
 *          Dependencies  : None.
 */
#define  IPV6_MAX_INTERFACE                                1

/**
 * @brief Default value of hop limit in IPv6 Header.
 *
 * @details This parameter indicates how many hops by default IPv6 packets can do. Each router
 *          which forward IPv6 packet to another host/router decrease this value by 1. When
 *          field become 0, packet is discarded.
 *          Hop limit value of 1,64 or 255 are prefarable in case of more efficient compression.
 *          Minimum value : 1
 *          Maximum value : 255
 *          Dependencies  : None.
 */
#define  IPV6_DEFAULT_HOP_LIMIT                            64

/**
 * @brief Enables call application event handler if getting unsupported transport protocols.
 *
 * @details Set this parameter to 1 to enable event while getting unsupported transport protocol.
 *          In current implementation, it means, all transport protocols besides ICMPv6 or UDP.
 *          Possible values : 0 or 1.
 *          Dependencies  : None.
 */
#define  IPV6_ENABLE_USNUPORTED_PROTOCOLS_TO_APPLICATION   1

/**
 * @brief Number of IPv6 addresses supported per interface.
 *
 * @details Number of IPv6 address supported including link local address.
 *          Minimum value      : 1
 *          Maximum value      : 255
 *          Recommended/default: 3
 *          Dependencies       : None.
 */
#define IPV6_MAX_ADDRESS_PER_INTERFACE                     3
/** @} */
/** @} */


/**
 * @defgroup icmp6_config Noridc's ICMPv6 module of IPv6 Stack configuration.
 * @{
 * @addtogroup iot_config
 * @{
 * @details This section defines configuration of ICMPv6 module of Noridc's IPv6 Stack.
 */

/**
 * @brief Disable debug trace in the module.
 *
 * @details Set this define to 1 to enable debug trace in the module, else set to 0.
 *          Possible values : 0 or 1.
 *          Dependencies    : ENABLE_DEBUG_LOG_SUPPORT. If this flag is not defined, no
 *                            trace is observed even if this define is set to 1.
 */
#define ICMP6_DISABLE_LOGS                                 1

/**
 * @brief Disables API parameter checks in the module.
 *
 * @details Set this define to 1 to disable checks on API parameters in the module.
 *          API parameter checks are added to ensure right parameters are passed to the
 *          module. These checks are useful during development phase but be redundant
 *          once application is developed. Disabling this can result in some code saving.
 *          Possible values : 0 or 1.
 *          Dependencies    : None.
 */
#define ICMP6_DISABLE_API_PARAM_CHECK                      0

/**
 * @brief Enables call ICMPv6 event handler on getting Neighbour Discovery message.
 *
 * @details Set this parameter to 1 to enable call ICMPv6 event handler on receiveing
 *          one of Neighbour Discovery messages.
 *          Possible values : 0 or 1.
 *          Dependencies  : None.
 */
#define  ICMP6_ENABLE_ND6_MESSAGES_TO_APPLICATION          0

/**
 * @brief Enables call ICMPv6 event handler on getting any of ICMPv6 message.
 *
 * @details Set this parameter to 1 to enable call ICMPv6 event handler on receiveing
 *          any of ICMPv6 messages including error, neighbour discovery or ping messages.
 *          Possible values : 0 or 1.
 *          Dependencies  : None.
 */
#define  ICMP6_ENABLE_ALL_MESSAGES_TO_APPLICATION          0

/**
 * @brief Enables
 *
 * @details Set this parameter to 1 to disable internal ECHO RESPONSE sending after processing
 *          ICMP packet in application (if ICMP6_ENABLE_ALL_MESSAGES_TO_APPLICATION is set).
 *          Application then is responsible of processing ECHO REQUEST and should also generate
 *          ECHO RESPONSE by itself. Set this parameter to 0 to let automatically reply inside
 *          of ICMP6 module, after processing it by application.
 *          Possible values : 0 or 1.
 *          Dependencies  : None.
 */
#define  ICMP6_ENABLE_HANDLE_ECHO_REQUEST_TO_APPLICATION   0
/** @} */
/** @} */


/**
 * @defgroup iot_udp_config UDP Configuration
 * @{
 * @addtogroup iot_config
 * @{
 * @details This section defines configuration of UDP module.
 */

/**
 * @brief Maximum UDP sockets managed by the module.
 *
 * @details Maximum UDP sockets managed by the module.
 *          Minimum value : 1
 *          Maximum value : 255
 *          Dependencies  : None.
 */
#define UDP6_MAX_SOCKET_COUNT                              3

/**
 * @brief Disable debug trace in the module.
 *
 * @details Set this define to 1 to enable debug trace in the module, else set to 0.
 *          Possible values : 0 or 1.
 *          Dependencies    : ENABLE_DEBUG_LOG_SUPPORT. If this flag is not defined, no
 *                            trace is observed even if this define is set to 1.
 */
#define UDP6_DISABLE_LOGS                                  1

/**
 * @brief Disables API parameter checks in the module.
 *
 * @details Set this define to 1 to disable checks on API parameters in the module.
 *          API parameter checks are added to ensure right parameters are passed to the
 *          module. These checks are useful during development phase but be redundant
 *          once application is developed. Disabling this can result in some code saving.
 *          Possible values : 0 or 1.
 *          Dependencies    : None.
 */
#define UDP6_DISABLE_API_PARAM_CHECK                       0
/** @} */
/** @} */


/**
 * @defgroup iot_coap_config CoAP Configuration
 * @{
 * @addtogroup iot_config
 * @{
 * @details This section defines configuration of CoAP module.
 */

/*
 * @brief Disable debug trace in the module.
 *
 * @details Set this define to 1 to enable debug trace in the module, else set to 0.
 *          Possible values : 0 or 1.
 *          Dependencies    : ENABLE_DEBUG_LOG_SUPPORT. If this flag is not defined, no
 *                            trace is observed even if this define is set to 1.
 */
#define COAP_DISABLE_LOGS                                 1

/**
 * @brief Disables API parameter checks in the module.
 *
 * @details Set this define to 1 to disable checks on API parameters in the module.
 *          API parameter checks are added to ensure right parameters are passed to the
 *          module. These checks are useful during development phase but be redundant
 *          once application is developed. Disabling this can result in some code saving.
 *          Possible values : 0 or 1.
 *          Dependencies    : None.
 */
#define COAP_DISABLE_API_PARAM_CHECK                      0

/**
 * @brief CoAP version number.
 *
 * @details  The version of CoAP which all CoAP messages will be populated with.
 *           Minimum value     : 0
 *           Maximum value     : 3
 *           Recommended value : 1
 *           Dependencies      : None
 */
#define COAP_VERSION                                      1

/**
 * @brief Number of local ports used by CoAP.
 *
 * @details  The max number of client/server ports used by the application. One socket
 *           will be created for each port.
 *           Minimum value : 0
 *           Maximum value : UDP6_MAX_SOCKET_COUNT
 *           Dependencies  : UDP6_MAX_SOCKET_COUNT
 */
#define COAP_PORT_COUNT                                   2

/**
 * @brief The port number used for a CoAP server.
 *
 * @details  Minimum value : 1
 *           Maximum value : 65535
 *           Dependencies  : None
 */
#define COAP_SERVER_PORT                                  5683

/**
 * @brief The port number used for a CoAP client.
 *
 * @details  Minimum value : 1
 *           Maximum value : 65535
 *           Dependencies  : None
 */
#define COAP_CLIENT_PORT                                  9999

/**
 * @brief Maximum number of CoAP message options.
 *
 * @details Maximum number of CoAP options that could be present in a message.
 *          Minimum value : 1
 *          Maximum value : 255
 *          Dependencies  : None.
 */
#define COAP_MAX_NUMBER_OF_OPTIONS                        8

/**
 * @brief The maximum size of a smartCoAP message excluding the mandatory CoAP header.
 *
 * @details  Minimum value : 1
 *           Maximum value : 65535
 *           Dependencies  : None
 */
#define COAP_MESSAGE_DATA_MAX_SIZE                        256

/**
 * @brief Maximum number of smartCoAP messages that can be in transmission at a time.
 *
 * @details  smartCoAP uses the Memory Manager that is also used by the underlying transport
 *           protocol. Therefore, if you increase this value, you should also increase the number
 *           of buffers. Depending on the COAP_MESSAGE_DATA_MAX_SIZE + 4 byte CoAP header, you
 *           must increase either MEMORY_MANAGER_SMALL_BLOCK_COUNT or MEMORY_MANAGER_MEDIUM_BLOCK_COUNT
 *           to ensure that there are additional buffers for the CoAP message queue. Which macro
 *           must be increased, depends on the size of the buffer that is sufficient for the CoAP message.
 *
 *           Minimum value     : 1
 *           Maximum value     : 65535
 *           Recommended value : 4
 *           Dependencies      : MEMORY_MANAGER_SMALL_BLOCK_COUNT
 *                               MEMORY_MANAGER_MEDIUM_BLOCK_COUNT
 *                               MEMORY_MANAGER_SMALL_BLOCK_SIZE
 *                               MEMORY_MANAGER_MEDIUM_BLOCK_SIZE
 */
#define COAP_MESSAGE_QUEUE_SIZE                           4

/**
 * @brief Maximum length of CoAP resource verbose name.
 *
 * @details  The maximum length of resource name that can be supplied from the application.
 *           Minimum value : 1
 *           Maximum value : 65535
 *           Dependencies  : None
 *
 * @note: 1 extra byte will be added to the resource name to make sure the string provided
 *        is zero terminated.
 */
#define COAP_RESOURCE_MAX_NAME_LEN                        19

/**
 * @brief Maximum number of CoAP resource levels.
 *
 * @details  The maximum number of resource depth levels uCoAP will use. The number will be used
 *           when adding resource to the resource structure, or when traversing the resources for
 *           a matching resource name given in a request. Each level added will increase the stack
 *           usage runtime with 4 bytes.
 *           Minimum value     : 1
 *           Maximum value     : 255
 *           Recommended value : 1 - 10
 *           Dependencies      : None
 */
#define COAP_RESOURCE_MAX_DEPTH                           5

/**
 * @brief Enable CoAP observe server role.
 *
 * @details If enabled, the coap_observe module has to be included. It will enable the module with
 *          a table to store observers, and provide access to functions to register and unregister
 *          observers. The list can be traversed in order to send notifications to the observers.
 *
 *          Possible values : 0 or 1.
 *          Dependencies    : COAP_OBSERVE_MAX_NUM_OBSERVERS.
 */
#define COAP_ENABLE_OBSERVE_SERVER                        0

/**
 * @brief Maximum number of CoAP observers that a server can have active at any point of time.
 *
 * @details The maximum number of observers to be registered by a server. For each observer added,
 *          it will increase the memory consumption of one coap_observer_t struct.
 *
 *          Minimum value      : 0
 *          Maximum value      : 255
 *          Recommended value  : 1 - 10
 *          Dependencies       : COAP_ENABLE_OBSERVE_SERVER
 *
 */
#define COAP_OBSERVE_MAX_NUM_OBSERVERS                    0

/**
 * @brief Enable CoAP observe client role.
 *
 * @details If enabled, the coap_observe module has to be included. It will enable the module with
 *          a table to store observable resources, and provide access to functions to register and
 *          unregister observable resources. The observable resources list is used to match
 *          incomming notifications to an application callback function.
 *
 *          Possible values : 0 or 1.
 *          Dependencies    : COAP_OBSERVE_MAX_NUM_OBSERVABLES.
 */
#define COAP_ENABLE_OBSERVE_CLIENT                        0

/**
 * @brief Maximum number of CoAP observable resources that a client can have active at any point
 *        of time.
 *
 * @details The maximum number of observable resources to be registered by a client. For each
 *          observable resource added, it will increase the memory consumption of one
 *          coap_observable_t struct.
 *
 *          Minimum value      : 0
 *          Maximum value      : 255
 *          Recommended value  : 1 - 10
 *          Dependencies       : COAP_ENABLE_OBSERVE_CLIENT
 *
 */
#define COAP_OBSERVE_MAX_NUM_OBSERVABLES                  0

/**
 * @brief Maximum number of transmit attempts for a Confirmable messages.
 *
 * @details Minimum value      : 0
 *          Maximum value      : 255
 *          Recommended value  : 4
 *          Dependencies       : None
 */
#define COAP_MAX_RETRANSMIT_COUNT                         1

/**
 * @brief Maximum time from the first transmission of a Confirmable message to its last
 *        retransmission.
 *
 * @details Minimum value      : 0
 *          Maximum value      : 65535
 *          Recommended value  : 45
 *          Dependencies       : None
 */
#define COAP_MAX_TRANSMISSION_SPAN                        10

/**
 * @brief Minimum spacing before another retransmission.
 *
 * @details Minimum value      : 0
 *          Maximum value      : COAP_MAX_TRANSMISSION_SPAN / COAP_MAX_RETRANSMIT_COUNT
 *          Recommended value  : 2
 *          Dependencies       : None
 */
#define COAP_ACK_TIMEOUT                                  2

/**
 * @brief Random factor to calculate the initial time-out value for a Confirmable message.
 *
 * @details Minimum value      : 0
 *          Maximum value      : COAP_MAX_TRANSMISSION_SPAN / COAP_MAX_RETRANSMIT_COUNT / COAP_ACK_TIMEOUT
 *          Recommended value  : 1.5
 *          Dependencies       : None
 */
#define COAP_ACK_RANDOM_FACTOR                            1

/** @} */
/** @} */

/**
 * @defgroup iot_timer IoT SDK Timer
 * @{
 * @addtogroup iot_config
 * @{
 * @details This section defines configuration of the IoT Timer.
 */

/**
 * @brief Wall clock resolution in milliseconds.
 *
 * @details The wall clock of the IoT Timer module has to be updated from an external source at
 *          regular intervals. This define needs to be set to the interval between updates.
 *          Minimum value   : 1.
 *          Dependencies    : None.
 *
 */
#define IOT_TIMER_RESOLUTION_IN_MS                       100

/**
 * @brief Disables API parameter checks in the module.
 *
 * @details Set this define to 1 to disable checks on API parameters in the module.
 *          API parameter checks are added to ensure right parameters are passed to the
 *          module. These checks are useful during development phase but be redundant
 *          once application is developed. Disabling this can result in some code saving.
 *          Possible values : 0 or 1.
 *          Dependencies    : None.
 */
#define IOT_TIMER_DISABLE_API_PARAM_CHECK                  0
/** @} */
/** @} */

#endif // SDK_CONFIG_H__