ext/amazon-freertos/libraries/c_sdk/standard/common/iot_init.c

/*
 * FreeRTOS Common V1.1.1
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * 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.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */

/**
 * @file iot_init.c
 * @brief Implements functions for common initialization and cleanup of this SDK.
 */

/* The config header is always included first. */
#include "iot_config.h"

/* SDK initialization include. */
#include "iot_init.h"

/* Task pool include. */
#include "iot_taskpool.h"

/* Atomic include. */
#include "iot_atomic.h"

/* Static memory include (if dynamic memory allocation is disabled). */
#include "private/iot_static_memory.h"

/* Error handling include. */
#include "private/iot_error.h"

/* Configure logs for the functions in this file. */
#ifdef IOT_LOG_LEVEL_GLOBAL
    #define LIBRARY_LOG_LEVEL    IOT_LOG_LEVEL_GLOBAL
#else
    #define LIBRARY_LOG_LEVEL    IOT_LOG_NONE
#endif

#define LIBRARY_LOG_NAME         ( "INIT" )
#include "iot_logging_setup.h"

/*-----------------------------------------------------------*/

#if IOT_ATOMIC_GENERIC == 1

/**
 * @brief Provides atomic operations with thread safety.
 */
    IotMutex_t IotAtomicMutex;
#endif

/*-----------------------------------------------------------*/

bool IotSdk_Init( void )
{
    IOT_FUNCTION_ENTRY( bool, true );
    IotTaskPoolError_t taskPoolStatus = IOT_TASKPOOL_SUCCESS;
    IotTaskPoolInfo_t taskPoolInfo = IOT_TASKPOOL_INFO_INITIALIZER_LARGE;

    /* Initialize the mutex for generic atomic operations if needed. */
    #if IOT_ATOMIC_GENERIC == 1
        bool genericAtomicInitialized = IotMutex_Create( &IotAtomicMutex, false );

        if( genericAtomicInitialized == false )
        {
            IotLogError( "Failed to initialize atomic operations." );
            IOT_SET_AND_GOTO_CLEANUP( false );
        }
    #endif

    /* Initialize static memory if dynamic memory allocation is disabled. */
    #if IOT_STATIC_MEMORY_ONLY == 1
        bool staticMemoryInitialized = IotStaticMemory_Init();

        if( staticMemoryInitialized == false )
        {
            IotLogError( "Failed to initialize static memory." );
            IOT_SET_AND_GOTO_CLEANUP( false );
        }
    #endif

    /* Create system task pool. */
    taskPoolStatus = IotTaskPool_CreateSystemTaskPool( &taskPoolInfo );

    if( taskPoolStatus != IOT_TASKPOOL_SUCCESS )
    {
        IotLogError( "Failed to create system task pool." );
        IOT_SET_AND_GOTO_CLEANUP( false );
    }

    IOT_FUNCTION_CLEANUP_BEGIN();

    if( status == false )
    {
        #if IOT_ATOMIC_GENERIC == 1
            if( genericAtomicInitialized == true )
            {
                IotMutex_Destroy( &IotAtomicMutex );
            }
        #endif
        #if IOT_STATIC_MEMORY_ONLY == 1
            if( staticMemoryInitialized == true )
            {
                IotStaticMemory_Cleanup();
            }
        #endif
    }
    else
    {
        IotLogInfo( "SDK successfully initialized." );
    }

    IOT_FUNCTION_CLEANUP_END();
}

/*-----------------------------------------------------------*/

void IotSdk_Cleanup( void )
{
    IotTaskPool_Destroy( IOT_SYSTEM_TASKPOOL );

    /* This log message must be printed before static memory management is
     * cleaned up. */
    IotLogInfo( "SDK cleanup done." );

    /* Cleanup static memory if dynamic memory allocation is disabled. */
    #if IOT_STATIC_MEMORY_ONLY == 1
        IotStaticMemory_Cleanup();
    #endif

    /* Clean up the mutex for generic atomic operations if needed. */
    #if IOT_ATOMIC_GENERIC == 1
        IotMutex_Destroy( &IotAtomicMutex );
    #endif
}

/*-----------------------------------------------------------*/