2 * Amazon FreeRTOS Common V1.0.0
\r
3 * Copyright (C) 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
\r
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
\r
6 * this software and associated documentation files (the "Software"), to deal in
\r
7 * the Software without restriction, including without limitation the rights to
\r
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
\r
9 * the Software, and to permit persons to whom the Software is furnished to do so,
\r
10 * subject to the following conditions:
\r
12 * The above copyright notice and this permission notice shall be included in all
\r
13 * copies or substantial portions of the Software.
\r
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
\r
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
\r
17 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
\r
18 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
\r
19 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
\r
20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\r
22 * http://aws.amazon.com/freertos
\r
23 * http://www.FreeRTOS.org
\r
28 * @brief Provides function signatures for common intialization and cleanup of
\r
35 /* The config header is always included first. */
\r
36 #include "iot_config.h"
\r
38 /* Standard includes. */
\r
39 #include <stdbool.h>
\r
42 * @brief One-time initialization function for this SDK.
\r
44 * This function initializes common libraries, such as static memory and task
\r
45 * pool. <b>It must be called once (and only once) before calling any other
\r
46 * function in this SDK.</b> Calling this function more than once without first
\r
47 * calling `IotSdk_Cleanup` may result in a crash.
\r
49 * @return `true` if initialization succeeded; `false` otherwise. Logs may be
\r
50 * printed in case of failure.
\r
52 * @warning No thread-safety guarantees are provided for this function.
\r
54 bool IotSdk_Init( void );
\r
57 * @brief One-time deinitialization function for all common libraries.
\r
59 * This function frees resources taken in `IotSdk_Init`. No other function
\r
60 * in this SDK may be called after calling this function unless `IotSdk_Init`
\r
63 * @warning No thread-safety guarantees are provided for this function.
\r
65 void IotSdk_Cleanup( void );
\r
67 #endif /* IOT_INIT_H_ */
\r