pal_configuration.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// Copyright 2016-2020 ARM Ltd.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------------------------------------------------------

#ifndef _PAL_COFIGURATION_H
#define _PAL_COFIGURATION_H
#include "limits.h"

#if 0
// This block is useful when building on new environment and one needs to find out,
// how to pass the "include-file.h" macro value via multiple layers of scripts
// and different reserved char escaping conventions.
#define XSTR(x) STR(x)
#define STR(x) #x

#pragma message "The value of PAL_USER_DEFINED_CONFIGURATION: " XSTR(PAL_USER_DEFINED_CONFIGURATION)
#endif

#ifdef PAL_USER_DEFINED_CONFIGURATION
    #include PAL_USER_DEFINED_CONFIGURATION
#endif

/* If you need any board-specific configuration, please include this define
*/
#ifdef PAL_BOARD_SPECIFIC_CONFIG
    #include PAL_BOARD_SPECIFIC_CONFIG
#endif

/* Lets the user choose the platform configuration file.
    \note If the user does not specify a platform configuration file,
    \note PAL uses a default configuration set that can be found at Configs/pal_config folder
  */

#ifdef PAL_PLATFORM_DEFINED_CONFIGURATION
    #include PAL_PLATFORM_DEFINED_CONFIGURATION
#elif defined(__linux__) || defined(__LINUX__)
    #include "Linux_default.h"
#elif defined(__FREERTOS__)
    #include "FreeRTOS_default.h"
#elif defined(__NXP_FREERTOS__)
    #include "NXP_default.h"
#elif defined(__RENESAS_EK_RA6M3__)
    #include "Renesas/Renesas_default.h"
#elif defined(__RENESAS_RX65N_CK__)
    #include "Renesas/Renesas_RX65N-CK_default.h"
#elif defined(__MBED__)
    #include "mbedOS_default.h"
#elif defined(__SXOS__)
    #include "sxos_default.h"
#elif defined(__RTX)
    #include "RTX_MW_default.h"
#else
    #error "Please specify the platform PAL_PLATFORM_DEFINED_CONFIGURATION"
#endif

#ifndef PAL_USE_HW_ROT
    #define PAL_USE_HW_ROT     1
#endif

#ifndef PAL_USE_HW_RTC
    #define PAL_USE_HW_RTC    1
#endif

#ifndef PAL_USE_HW_TRNG
    #define PAL_USE_HW_TRNG    1
#endif

#ifndef PAL_USE_SECURE_TIME
    #define PAL_USE_SECURE_TIME    1
#endif

#ifndef PAL_SIMULATOR_FILE_SYSTEM_OVER_RAM
    #define PAL_SIMULATOR_FILE_SYSTEM_OVER_RAM 0
#endif

#ifndef PAL_SIMULATOR_FLASH_OVER_FILE_SYSTEM
    #define PAL_SIMULATOR_FLASH_OVER_FILE_SYSTEM 0
#endif

#ifndef PAL_USE_INTERNAL_FLASH
    #define PAL_USE_INTERNAL_FLASH 0
#endif

/*
 * Network configuration
 */
// PAL configuration options
#ifndef PAL_NET_TCP_AND_TLS_SUPPORT
    #define PAL_NET_TCP_AND_TLS_SUPPORT         true 
#endif

#ifndef PAL_NET_DNS_SUPPORT
    #define PAL_NET_DNS_SUPPORT                 true 
#endif

#if (PAL_NET_DNS_SUPPORT == true) && !(defined(PAL_DNS_API_VERSION))
#define PAL_DNS_API_VERSION 0 
#endif

#ifndef PAL_NET_SERVER_SOCKET_API
    #define PAL_NET_SERVER_SOCKET_API                 true 
#endif

#ifndef PAL_SUPPORT_IP_V4
    #define PAL_SUPPORT_IP_V4                 1 
#endif
#ifndef PAL_SUPPORT_IP_V6
    #define PAL_SUPPORT_IP_V6                 1 
#endif

//values for PAL_NET_DNS_IP_SUPPORT
#define PAL_NET_DNS_ANY          0    
#define PAL_NET_DNS_IPV4_ONLY    2    
#define PAL_NET_DNS_IPV6_ONLY    4    

#ifndef PAL_NET_DNS_IP_SUPPORT
#if (PAL_SUPPORT_IP_V6 == 1) && (PAL_SUPPORT_IP_V4 == 1)
    #define PAL_NET_DNS_IP_SUPPORT  0 
#elif (PAL_SUPPORT_IP_V6 == 1)
    #define PAL_NET_DNS_IP_SUPPORT  4 
#else
    #define PAL_NET_DNS_IP_SUPPORT  2 
#endif
#endif

#ifndef PAL_MAX_SUPORTED_NET_INTERFACES
    #define PAL_MAX_SUPORTED_NET_INTERFACES 1
#endif

#ifndef PAL_NET_ASYNC_DNS_THREAD_STACK_SIZE
    #define PAL_NET_ASYNC_DNS_THREAD_STACK_SIZE (1024 * 2)
#endif

#ifndef PAL_CLEANUP_ON_INIT_FAILURE
    #define PAL_CLEANUP_ON_INIT_FAILURE true
#endif

/*
 * RTOS configuration
 */

#ifndef PAL_THREAD_SAFETY
    #define PAL_THREAD_SAFETY 1
#endif

#ifndef PAL_RTOS_THREAD_CLEANUP_TIMER_MILISEC
    #define PAL_RTOS_THREAD_CLEANUP_TIMER_MILISEC 200
#endif

#ifndef PAL_INITIAL_RANDOM_SIZE
    #define PAL_INITIAL_RANDOM_SIZE 48
#endif

#ifndef PAL_RTOS_WAIT_FOREVER
    #define PAL_RTOS_WAIT_FOREVER UINT_MAX
#endif

/*
 * TLS configuration
 */

#ifndef PAL_MAX_ALLOWED_CIPHER_SUITES
    #define PAL_MAX_ALLOWED_CIPHER_SUITES 1
#endif


#ifndef PAL_TLS_DEBUG_THRESHOLD
    #define PAL_TLS_DEBUG_THRESHOLD 5
#endif

#ifndef PAL_CERT_ID_SIZE
    #define PAL_CERT_ID_SIZE 33
#endif

#ifndef PAL_ENABLE_PSK
    #define PAL_ENABLE_PSK 0
#endif

#ifndef PAL_ENABLE_X509
    #define PAL_ENABLE_X509 1
#endif

// Defines the cipher suites for TLS. Only one cipher suite per device available.
#define PAL_TLS_PSK_WITH_AES_128_CCM_8_SUITE                    0x01
#define PAL_TLS_PSK_WITH_AES_256_CCM_8_SUITE                    0x02
#define PAL_TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8_SUITE            0x04
#define PAL_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256_SUITE       0x08
#define PAL_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384_SUITE       0x10
#define PAL_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256_SUITE      0x20

#if (PAL_ENABLE_X509 == 1)
    #ifndef PAL_TLS_CIPHER_SUITE
        #define PAL_TLS_CIPHER_SUITE PAL_TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8_SUITE
    #endif
#elif (PAL_ENABLE_PSK == 1)
    #ifndef PAL_TLS_CIPHER_SUITE
        #define PAL_TLS_CIPHER_SUITE PAL_TLS_PSK_WITH_AES_128_CCM_8_SUITE
    #endif
#endif

#ifndef PAL_CMAC_SUPPORT
    #define PAL_CMAC_SUPPORT 1
#endif //PAL_CMAC_SUPPORT

/*
 * UPDATE configuration
 */

#define PAL_UPDATE_USE_FLASH 1
#define PAL_UPDATE_USE_FS    2

#ifndef PAL_UPDATE_IMAGE_LOCATION
    #define PAL_UPDATE_IMAGE_LOCATION PAL_UPDATE_USE_FS     
#endif

#ifndef PAL_CRYPTO_CERT_DATE_LENGTH
    #define PAL_CRYPTO_CERT_DATE_LENGTH sizeof(uint64_t)
#endif

/*
 * File system configuration
 */


#ifndef PAL_USE_FILESYSTEM
    #define PAL_USE_FILESYSTEM 0
#endif

#ifndef PAL_NUMBER_OF_PARTITIONS
    #define PAL_NUMBER_OF_PARTITIONS 1 // Default partitions
#endif

#if (PAL_NUMBER_OF_PARTITIONS > 2)
    #error "PAL_NUMBER_OF_PARTITIONS cannot be more then 2"
#endif

#ifndef PAL_PRIMARY_PARTITION_PRIVATE
    #define PAL_PRIMARY_PARTITION_PRIVATE 0
#endif

#ifndef PAL_SECONDARY_PARTITION_PRIVATE
    #define PAL_SECONDARY_PARTITION_PRIVATE 0
#endif

#ifndef PAL_FS_MOUNT_POINT_PRIMARY
    #define PAL_FS_MOUNT_POINT_PRIMARY  ""
#endif

#ifndef PAL_FS_MOUNT_POINT_SECONDARY
    #define PAL_FS_MOUNT_POINT_SECONDARY ""
#endif

// Update

#ifndef PAL_UPDATE_FIRMWARE_MOUNT_POINT
    #define PAL_UPDATE_FIRMWARE_MOUNT_POINT PAL_FS_MOUNT_POINT_PRIMARY
#endif

#ifndef PAL_UPDATE_FIRMWARE_DIR
#ifdef __NANOSIMULATOR__
    #define PAL_UPDATE_FIRMWARE_DIR "/firmware"
#else
    #define PAL_UPDATE_FIRMWARE_DIR PAL_UPDATE_FIRMWARE_MOUNT_POINT "/firmware"
#endif
#endif

#ifndef PAL_INT_FLASH_NUM_SECTIONS
    #define PAL_INT_FLASH_NUM_SECTIONS 0
#endif

#if PAL_USE_HW_TRNG
    #ifndef PAL_NOISE_TRNG_THREAD_DELAY_MILLI_SEC
        #define PAL_NOISE_TRNG_THREAD_DELAY_MILLI_SEC (1000 * 60) // one minute
    #endif
    #ifndef PAL_NOISE_TRNG_THREAD_STACK_SIZE
        #define PAL_NOISE_TRNG_THREAD_STACK_SIZE 1536 // 1.5K
    #endif
#endif

#ifndef PAL_DEVICE_KEY_DERIVATION_BACKWARD_COMPATIBILITY_CALC
    #define PAL_DEVICE_KEY_DERIVATION_BACKWARD_COMPATIBILITY_CALC 0
#endif

#ifndef PAL_INTERNAL_FLASH_SECTION_1_ADDRESS
    #define PAL_INTERNAL_FLASH_SECTION_1_ADDRESS    0
#endif

#ifndef PAL_INTERNAL_FLASH_SECTION_2_ADDRESS
    #define PAL_INTERNAL_FLASH_SECTION_2_ADDRESS    0
#endif
#ifndef PAL_INTERNAL_FLASH_SECTION_1_SIZE
    #define PAL_INTERNAL_FLASH_SECTION_1_SIZE       0
#endif
#ifndef PAL_INTERNAL_FLASH_SECTION_2_SIZE
    #define PAL_INTERNAL_FLASH_SECTION_2_SIZE       0
#endif

#ifndef PAL_SIMULATOR_TEST_ENABLE
    #define PAL_SIMULATOR_TEST_ENABLE    0
#endif

#if (PAL_SIMULATOR_TEST_ENABLE == 1)

    #undef PAL_SIMULATE_RTOS_REBOOT
    #define PAL_SIMULATE_RTOS_REBOOT 1

    #undef PAL_SIMULATOR_FLASH_OVER_FILE_SYSTEM
    #define PAL_SIMULATOR_FLASH_OVER_FILE_SYSTEM    1

    #undef PAL_SIMULATOR_FS_RM_INSTEAD_OF_FORMAT
    #define PAL_SIMULATOR_FS_RM_INSTEAD_OF_FORMAT 1
#endif //PAL_SIMULATOR_TEST_ENABLE

#ifndef PAL_SIMULATOR_FLASH_OVER_FILE_SYSTEM
    #define PAL_SIMULATOR_FLASH_OVER_FILE_SYSTEM    0
#endif

#if PAL_SIMULATOR_FLASH_OVER_FILE_SYSTEM

    #undef PAL_USE_INTERNAL_FLASH
    #define PAL_USE_INTERNAL_FLASH  1

    #undef PAL_INT_FLASH_NUM_SECTIONS
    #define PAL_INT_FLASH_NUM_SECTIONS 2

    #ifndef PAL_SIMULATOR_SOTP_AREA_SIZE
        #define PAL_SIMULATOR_SOTP_AREA_SIZE    4096 
    #endif

    #ifndef SIMULATE_FLASH_SECTOR_SIZE
        #define SIMULATE_FLASH_SECTOR_SIZE      4096 
    #endif

    #ifndef SIMULATE_FLASH_DIR
        #define SIMULATE_FLASH_DIR              "" 
    #endif

    #ifndef SIMULATE_FLASH_FILE_NAME
        #define SIMULATE_FLASH_FILE_NAME        SIMULATE_FLASH_DIR"/flashSim" 
    #endif

    #ifndef SIMULATE_FLASH_PAGE_SIZE
        #define SIMULATE_FLASH_PAGE_SIZE        8 
    #endif

    #if PAL_SIMULATOR_SOTP_AREA_SIZE < 4096
        #error Minimum Size of 4K
    #endif

    /* Note - In simulator mode all flash areas are overrided with the simulation sizes and address*/

/* \brief Size for section 1
 *
 * Minimum required size is 1KB and section must be consecutive sectors
 */
    #undef PAL_INTERNAL_FLASH_SECTION_1_SIZE
    #define PAL_INTERNAL_FLASH_SECTION_1_SIZE       PAL_SIMULATOR_SOTP_AREA_SIZE

    #undef PAL_INTERNAL_FLASH_SECTION_2_SIZE

    #define PAL_INTERNAL_FLASH_SECTION_2_SIZE       PAL_SIMULATOR_SOTP_AREA_SIZE

    #undef PAL_INTERNAL_FLASH_SECTION_1_ADDRESS
    #define PAL_INTERNAL_FLASH_SECTION_1_ADDRESS    0

    #undef PAL_INTERNAL_FLASH_SECTION_2_ADDRESS
    #define PAL_INTERNAL_FLASH_SECTION_2_ADDRESS    PAL_INTERNAL_FLASH_SECTION_1_SIZE

#endif //PAL_SIMULATOR_FLASH_OVER_FILE_SYSTEM

#define VALUE_TO_STRING(x) #x
#define VALUE(x) VALUE_TO_STRING(x)
#define VAR_NAME_VALUE(var) #var " = "  VALUE(var)

#if (((!PAL_USE_INTERNAL_FLASH && (!PAL_USE_HW_ROT || !PAL_USE_HW_RTC || !PAL_USE_HW_TRNG))  \
        || ((PAL_INT_FLASH_NUM_SECTIONS == 1) && PAL_USE_INTERNAL_FLASH && (!PAL_USE_HW_RTC || !PAL_USE_HW_TRNG)))  \
        && !defined MBED_CONF_MBED_CLOUD_CLIENT_EXTERNAL_SST_SUPPORT)
        #pragma message(VAR_NAME_VALUE(PAL_USE_INTERNAL_FLASH))
        #pragma message(VAR_NAME_VALUE(PAL_USE_HW_ROT))
        #pragma message(VAR_NAME_VALUE(PAL_USE_HW_RTC))
        #pragma message(VAR_NAME_VALUE(PAL_USE_HW_TRNG))
        #pragma message(VAR_NAME_VALUE(PAL_INT_FLASH_NUM_SECTIONS))
    #error Minimum configuration setting does not meet the requirements
#endif

#if (((PAL_ENABLE_PSK == 1) && (PAL_ENABLE_X509 == 1)) && !(defined(__linux__) || defined(__LINUX__)))
    #error "Please select only one option: PSK or X509"
#endif

#if ((PAL_ENABLE_PSK == 0) && (PAL_ENABLE_X509 == 0))
    #error "Please select one option: PSK or X509"
#endif

#if ((PAL_ENABLE_PSK == 1) && (PAL_USE_SECURE_TIME == 1))
    #error "PSK feature cannot be configured when using secure time"
#endif

#ifndef PAL_TRNG_COLLECT_DELAY_MILLI_SEC
    #define PAL_TRNG_COLLECT_DELAY_MILLI_SEC 1000
#endif // PAL_TRNG_COLLECT_DELAY_MILLI_SEC

#ifndef IMAGE_COUNT_MAX
    #define IMAGE_COUNT_MAX             1
#endif

#define PAL_NOISE_SIZE_BYTES 48 
#define PAL_NOISE_SIZE_BITS (PAL_NOISE_SIZE_BYTES * CHAR_BIT) 
#define PAL_NOISE_BUFFER_LEN (PAL_NOISE_SIZE_BYTES / sizeof(int32_t)) 

// This requires Mbed TLS 2.19.0d1 or later.
#ifndef PAL_USE_SSL_SESSION_RESUME
    #define PAL_USE_SSL_SESSION_RESUME 0
#endif

// Sanity check for using static memory buffer with mbedtls.
#ifdef PAL_USE_STATIC_MEMBUF_FOR_MBEDTLS

#if !defined(PAL_STATIC_MEMBUF_SIZE_FOR_MBEDTLS)
    #error "When using PAL_USE_STATIC_MEMBUF_FOR_MBEDTLS, you must also define the size for the static memory buffer with PAL_STATIC_MEMBUF_SIZE_FOR_MBEDTLS."
#endif

#endif // #ifdef PAL_USE_STATIC_MEMBUF_FOR_MBEDTLS

// For platforms that do not support dynamic fetching of network stagger (pal_getStaggerEstimate()), this default value will be used.
// This parameter is relevant when large number of clients is expected to connect through a single constrained backbone connection.
// As of now dynamic implementation exists only for Mbed OS Wi-SUN stack.
#ifndef PAL_DEFAULT_STAGGER_ESTIMATE
#define PAL_DEFAULT_STAGGER_ESTIMATE 0
#endif

// For platforms that do not support dynamic fetching of network stagger (pal_getRttEstimate()), this default value will be used.
// This value controls network latency related parameters and represents the expected packet round-trip total times.
// This value is used to control client retransmission timers and DTLS timers.
#ifndef PAL_DEFAULT_RTT_ESTIMATE
#define PAL_DEFAULT_RTT_ESTIMATE 10
#endif

#if PAL_DEFAULT_RTT_ESTIMATE < 1
#error "PAL_DEFAULT_RTT_ESTIMATE must be at least 1"
#endif

#endif //_PAL_COFIGURATION_H