git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/task_pool/iot_config.h

   1 /*\r
   2  * Copyright (C) 2018 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   3  *\r
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   5  * this software and associated documentation files (the "Software"), to deal in\r
   6  * the Software without restriction, including without limitation the rights to\r
   7  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   8  * the Software, and to permit persons to whom the Software is furnished to do so,\r
   9  * subject to the following conditions:\r
  10  *\r
  11  * The above copyright notice and this permission notice shall be included in all\r
  12  * copies or substantial portions of the Software.\r
  13  *\r
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  16  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  17  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  18  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  19  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  20  */\r
  21 \r
  22 /* This file contains configuration settings for the demos. */\r
  23 \r
  24 #ifndef IOT_CONFIG_H_\r
  25 #define IOT_CONFIG_H_\r
  26 \r
  27 \r
  28 /*\r
  29  * Set this to the number of recyclable tasks for the task pool to cache.\r
  30  *\r
  31  * Caching dynamically allocated tasks (recyclable tasks) helps the application\r
  32  * to limit the number of allocations at runtime. Caching recyclable tasks may\r
  33  * help making the application more responsive and predictable, by removing a\r
  34  * potential for memory allocation failures, but it may also have negative\r
  35  * repercussions on the amount of memory available at any given time. It is up\r
  36  * to the application developer to strike the correct balance these competing\r
  37  * needs. The task pool will cache when the application calling\r
  38  * IotTaskPool_RecycleJob. Any recycled tasks in excess of\r
  39  * IOT_TASKPOOL_JOBS_RECYCLE_LIMIT will be destroyed and its memory will be\r
  40  * release.\r
  41  *\r
  42  * Default value (if undefined): 8\r
  43  */\r
  44 #define IOT_TASKPOOL_JOBS_RECYCLE_LIMIT 8\r
  45 \r
  46 /*\r
  47  * Set this to 1 to perform sanity checks when using the task pool library.\r
  48  *\r
  49  * Asserts are useful for debugging, but should be disabled in production code.\r
  50  * If this is set to 1, IotTaskPool_Assert can be defined to set the assertion\r
  51  * function; otherwise, the standard library's assert function will be used.\r
  52  *\r
  53  * Possible values: 0 (asserts disabled) or 1 (asserts enabled)\r
  54  * Recommended values: 1 when debugging; 0 in production code.\r
  55  * Default value (if undefined): 0\r
  56  */\r
  57 #define IOT_TASKPOOL_ENABLE_ASSERTS 1\r
  58 \r
  59 /*\r
  60  * The full IoT Task Pool Library has many use cases, including Linux\r
  61  * development.  Typical FreeRTOS use cases do not require the full\r
  62  * functionality so an optimised implementation is provided specifically for use\r
  63  * with FreeRTOS.  The optimised version has a fixed number of tasks in the\r
  64  * pool, each of which uses statically allocated memory to ensure creation of\r
  65  * the pool is guaranteed (it does not run out of heap space).\r
  66  * IOT_TASKPOOL_NUMBER_OF_WORKERS sets the number of tasks in the pool.\r
  67  */\r
  68 #define IOT_TASKPOOL_NUMBER_OF_WORKERS               3\r
  69 \r
  70 /*\r
  71  * Set the log level of the task pool library.\r
  72  *\r
  73  * Log messages from the task pool library at or below this setting will be\r
  74  * printed.\r
  75  *\r
  76  * Possible values: One of the Log levels.\r
  77  * Default value (if undefined): IOT_LOG_LEVEL_GLOBAL; if that is undefined,\r
  78  * then IOT_LOG_NONE.\r
  79  */\r
  80 #define IOT_LOG_LEVEL_TASKPOOL IOT_LOG_INFO\r
  81 \r
  82 \r
  83 /**\r
  84  * @brief The stack size (in bytes) for each worker task in the task pool.\r
  85  * \r
  86  * The minimal version of the of task pool library only supports one task pool\r
  87  * and the configuration of each worker task fixed at the compile time.\r
  88  */\r
  89 #define IOT_TASKPOOL_WORKER_STACK_SIZE_BYTES        2048\r
  90 \r
  91 /* Include the common configuration file for FreeRTOS. */\r
  92 #include "iot_config_common.h"\r
  93 \r
  94 #endif /* ifndef IOT_CONFIG_H_ */\r