cellular_config_defaults.h

Go to the documentation of this file.

/*
 * FreeRTOS-Cellular-Interface v1.4.0
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * https://www.FreeRTOS.org
 * https://github.com/FreeRTOS
 */
 
#ifndef __CELLULAR_CONFIG_DEFAULTS_H__
#define __CELLULAR_CONFIG_DEFAULTS_H__
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    extern "C" {
#endif
/* *INDENT-ON* */
 
/* The macro definition for CELLULAR_DO_NOT_USE_CUSTOM_CONFIG is for Doxygen
 * documentation only. */
 
#ifdef DOXYGEN
    #define CELLULAR_DO_NOT_USE_CUSTOM_CONFIG
#endif
 
#ifndef CELLULAR_MCC_MAX_SIZE
    #define CELLULAR_MCC_MAX_SIZE    ( 3U )
#endif
 
#ifndef CELLULAR_MNC_MAX_SIZE
    #define CELLULAR_MNC_MAX_SIZE    ( 3U )
#endif
 
#ifndef CELLULAR_ICCID_MAX_SIZE
    #define CELLULAR_ICCID_MAX_SIZE    ( 20U )
#endif
 
#ifndef CELLULAR_IMSI_MAX_SIZE
    #define CELLULAR_IMSI_MAX_SIZE    ( 15U )
#endif
 
#ifndef CELLULAR_FW_VERSION_MAX_SIZE
    #define CELLULAR_FW_VERSION_MAX_SIZE    ( 32U )
#endif
 
#ifndef CELLULAR_HW_VERSION_MAX_SIZE
    #define CELLULAR_HW_VERSION_MAX_SIZE    ( 12U )
#endif
 
#ifndef CELLULAR_SERIAL_NUM_MAX_SIZE
    #define CELLULAR_SERIAL_NUM_MAX_SIZE    ( 12U )
#endif
 
#ifndef CELLULAR_IMEI_MAX_SIZE
    #define CELLULAR_IMEI_MAX_SIZE    ( 15U )
#endif
 
#ifndef CELLULAR_NETWORK_NAME_MAX_SIZE
    #define CELLULAR_NETWORK_NAME_MAX_SIZE    ( 32U )
#endif
 
#ifndef CELLULAR_APN_MAX_SIZE
    #define CELLULAR_APN_MAX_SIZE    ( 64U )
#endif
 
#ifndef CELLULAR_PDN_USERNAME_MAX_SIZE
    #define CELLULAR_PDN_USERNAME_MAX_SIZE    ( 32U )
#endif
 
#ifndef CELLULAR_PDN_PASSWORD_MAX_SIZE
    #define CELLULAR_PDN_PASSWORD_MAX_SIZE    ( 32u )
#endif
 
#ifndef CELLULAR_IP_ADDRESS_MAX_SIZE
    #define CELLULAR_IP_ADDRESS_MAX_SIZE    ( 40U )
#endif
 
#ifndef CELLULAR_AT_CMD_MAX_SIZE
    #define CELLULAR_AT_CMD_MAX_SIZE    ( 200U )
#endif
 
#ifndef CELLULAR_NUM_SOCKET_MAX
    #define CELLULAR_NUM_SOCKET_MAX    ( 12U )
#endif
 
#ifndef CELLULAR_MANUFACTURE_ID_MAX_SIZE
    #define CELLULAR_MANUFACTURE_ID_MAX_SIZE    ( 20U )
#endif
 
#ifndef CELLULAR_MODEL_ID_MAX_SIZE
    #define CELLULAR_MODEL_ID_MAX_SIZE    ( 10U )
#endif
 
#ifndef CELLULAR_EDRX_LIST_MAX_SIZE
    #define CELLULAR_EDRX_LIST_MAX_SIZE    ( 4U )
#endif
 
#ifndef CELLULAR_PDN_CONTEXT_ID_MIN
    #define CELLULAR_PDN_CONTEXT_ID_MIN    ( 1U )
#endif
 
#ifndef CELLULAR_PDN_CONTEXT_ID_MAX
    #define CELLULAR_PDN_CONTEXT_ID_MAX    ( 16U )
#endif
 
#ifndef CELLULAR_MAX_RAT_PRIORITY_COUNT
    #define CELLULAR_MAX_RAT_PRIORITY_COUNT    ( 3U )
#endif
 
#ifndef CELLULAR_MAX_SEND_DATA_LEN
    #define CELLULAR_MAX_SEND_DATA_LEN    ( 1460U )
#endif
 
#ifndef CELLULAR_MAX_RECV_DATA_LEN
    #define CELLULAR_MAX_RECV_DATA_LEN    ( 1500U )
#endif
 
#ifndef CELLULAR_SUPPORT_GETHOSTBYNAME
    #define CELLULAR_SUPPORT_GETHOSTBYNAME    ( 1U )
#endif
 
#ifndef CELLULAR_COMM_IF_SEND_TIMEOUT_MS
    #define CELLULAR_COMM_IF_SEND_TIMEOUT_MS    ( 1000U )
#endif
 
#ifndef CELLULAR_COMM_IF_RECV_TIMEOUT_MS
    #define CELLULAR_COMM_IF_RECV_TIMEOUT_MS    ( 1000U )
#endif
 
#ifndef CELLULAR_CONFIG_STATIC_ALLOCATION_CONTEXT
    #define CELLULAR_CONFIG_STATIC_ALLOCATION_CONTEXT    ( 0U )
#endif
 
#ifndef CELLULAR_CONFIG_STATIC_COMM_CONTEXT_ALLOCATION
    #define CELLULAR_CONFIG_STATIC_COMM_CONTEXT_ALLOCATION    ( 0U )
#endif
 
#ifndef CELLULAR_CONFIG_DEFAULT_RAT
    #define CELLULAR_CONFIG_DEFAULT_RAT    ( 8 )   /* Set default RAT to CELLULAR_RAT_CATM1 @ref CellularRat_t. */
#endif
 
#ifndef CELLULAR_CONFIG_STATIC_SOCKET_CONTEXT_ALLOCATION
    #define CELLULAR_CONFIG_STATIC_SOCKET_CONTEXT_ALLOCATION    ( 0 )
#endif
 
#ifndef CELLULAR_COMMON_AT_COMMAND_TIMEOUT_MS
    #define CELLULAR_COMMON_AT_COMMAND_TIMEOUT_MS    ( 5000U )
#endif
 
#ifndef CELLULAR_AT_COMMAND_RAW_TIMEOUT_MS
    #define CELLULAR_AT_COMMAND_RAW_TIMEOUT_MS    ( 5000U )
#endif
 
#ifndef CELLULAR_CONFIG_MAX_PREFIX_STRING_LENGTH
    #define CELLULAR_CONFIG_MAX_PREFIX_STRING_LENGTH    ( 32U )
#endif
 
#ifndef CELLULAR_CHECK_IS_PREFIX_LEADING_CHAR
    #define CELLULAR_CHECK_IS_PREFIX_LEADING_CHAR( x )    ( ( x ) == '+' )
#endif
 
#ifndef CELLULAR_CHECK_IS_PREFIX_CHAR
    #define CELLULAR_CHECK_IS_PREFIX_CHAR( inputChar )                    \
    ( ( ( ( int32_t ) isalpha( ( ( int8_t ) ( inputChar ) ) ) ) == 0 ) && \
      ( ( ( int32_t ) isdigit( ( ( int8_t ) ( inputChar ) ) ) ) == 0 ) && \
      ( ( inputChar ) != '_' ) &&                                         \
      ( !( CELLULAR_CHECK_IS_PREFIX_LEADING_CHAR( inputChar ) ) ) )
#endif
 
#ifndef CELLULAR_AT_MAX_STRING_SIZE
    #define CELLULAR_AT_MAX_STRING_SIZE    ( 256U )
#endif
 
#ifndef CELLULAR_CONFIG_USE_CCID_COMMAND
    #define CELLULAR_CONFIG_USE_CCID_COMMAND    1
#endif
 
#ifndef CELLULAR_CONFIG_ASSERT
    #define CELLULAR_CONFIG_ASSERT( X )    configASSERT( X )
#endif
 
#ifndef CELLULAR_CONFIG_PLATFORM_FREERTOS
    #define CELLULAR_CONFIG_PLATFORM_FREERTOS    1
#endif
 
#if CELLULAR_CONFIG_PLATFORM_FREERTOS
    #define PlatformQueueHandle_t    QueueHandle_t
    #define PlatformEventBits_t      EventBits_t
    #define PlatformBaseType_t       BaseType_t
    #define PlatformTickType_t       TickType_t
    #define platformTRUE             pdTRUE
    #define platformFALSE            pdFALSE
    #define platformPASS             pdPASS
    #define platformFAIL             pdFAIL
    #define platformMAX_DELAY        portMAX_DELAY
    #define PlatformQueue_Create     xQueueCreate
    #define PlatformQueue_Send       xQueueSend
    #define PlatformQueue_Receive    xQueueReceive
    #define PlatformQueue_Delete     vQueueDelete
#endif /* if CELLULAR_CONFIG_PLATFORM_FREERTOS */
 
#ifndef CELLULAR_CONFIG_PKTIO_READ_BUFFER_SIZE
    #define CELLULAR_CONFIG_PKTIO_READ_BUFFER_SIZE    1600U
#endif
 
#ifndef LogError
    #define LogError( message )
#endif
 
#ifndef LogWarn
    #define LogWarn( message )
#endif
 
#ifndef LogInfo
    #define LogInfo( message )
#endif
 
#ifndef LogDebug
    #define LogDebug( message )
#endif
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    }
#endif
/* *INDENT-ON* */
 
#endif /* __CELLULAR_CONFIG_DEFAULTS_H__ */