esp-idf/components/esp_system/include/esp_task.h

/*
 * SPDX-FileCopyrightText: 2019-2022 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */

/* Notes:
 * 1. Put all task priority and stack size definition in this file
 * 2. If the task priority is less than 10, use ESP_TASK_PRIO_MIN + X style,
 *    otherwise use ESP_TASK_PRIO_MAX - X style
 * 3. If this is a daemon task, the macro prefix is ESP_TASKD_, otherwise
 *    it's ESP_TASK_
 * 4. If the configMAX_PRIORITIES is modified, please make all priority are
 *    greater than 0
 * 5. Make sure esp_task.h is consistent between wifi lib and idf
 * 6. If changing system task priorities, please check the values documented in /api-guides/performance/speed.rst
 * are up to date
 */

#ifndef _ESP_TASK_H_
#define _ESP_TASK_H_

#include "sdkconfig.h"
#include "freertos/FreeRTOS.h"
#include "freertos/FreeRTOSConfig.h"

#define ESP_TASK_PRIO_MAX (configMAX_PRIORITIES)
#define ESP_TASK_PRIO_MIN (0)

/* Bt contoller Task */
/* controller */
#define ESP_TASK_BT_CONTROLLER_PRIO   (ESP_TASK_PRIO_MAX - 2)
#ifdef CONFIG_NEWLIB_NANO_FORMAT
#define TASK_EXTRA_STACK_SIZE      (0)
#else
#define TASK_EXTRA_STACK_SIZE      (512)
#endif

#define BT_TASK_EXTRA_STACK_SIZE      TASK_EXTRA_STACK_SIZE
#define ESP_TASK_BT_CONTROLLER_STACK  (3584 + TASK_EXTRA_STACK_SIZE)

/* Ping Task */
#define ESP_TASK_PING_STACK             (2048 + TASK_EXTRA_STACK_SIZE)


/* idf task */
#define ESP_TASK_TIMER_PRIO           (ESP_TASK_PRIO_MAX - 3)
#define ESP_TASK_TIMER_STACK          (CONFIG_ESP_TIMER_TASK_STACK_SIZE +  TASK_EXTRA_STACK_SIZE)
#define ESP_TASKD_EVENT_PRIO          (ESP_TASK_PRIO_MAX - 5)
#if CONFIG_LWIP_TCPIP_CORE_LOCKING
#define ESP_TASKD_EVENT_STACK         (CONFIG_ESP_SYSTEM_EVENT_TASK_STACK_SIZE + TASK_EXTRA_STACK_SIZE + 2048)
#else
#define ESP_TASKD_EVENT_STACK         (CONFIG_ESP_SYSTEM_EVENT_TASK_STACK_SIZE + TASK_EXTRA_STACK_SIZE)
#endif /* CONFIG_LWIP_TCPIP_CORE_LOCKING */
#define ESP_TASK_TCPIP_PRIO           (CONFIG_LWIP_TCPIP_TASK_PRIO)
#define ESP_TASK_TCPIP_STACK          (CONFIG_LWIP_TCPIP_TASK_STACK_SIZE + TASK_EXTRA_STACK_SIZE)
#define ESP_TASK_MAIN_PRIO            (ESP_TASK_PRIO_MIN + 1)
#define ESP_TASK_MAIN_STACK           (CONFIG_ESP_MAIN_TASK_STACK_SIZE + TASK_EXTRA_STACK_SIZE)
#define ESP_TASK_MAIN_CORE            CONFIG_ESP_MAIN_TASK_AFFINITY

#endif
lwip:bugfix for increase ping task stack size 2022-10-18 16:40:32 +08:00			`/*`
			`* SPDX-FileCopyrightText: 2019-2022 Espressif Systems (Shanghai) CO LTD`
			`*`
			`* SPDX-License-Identifier: Apache-2.0`
			`*/`
components: esp32 Remove priority/stack definition of task that is freertos/lwip/app 2016-09-01 14:37:19 +08:00
components: esp32 add missing file esp_task.h 2016-09-01 14:18:16 +08:00			`/* Notes:`
			`* 1. Put all task priority and stack size definition in this file`
			`* 2. If the task priority is less than 10, use ESP_TASK_PRIO_MIN + X style,`
components/esp32,bt: fix typos in comments 2016-09-26 00:51:56 +08:00			`* otherwise use ESP_TASK_PRIO_MAX - X style`
			`* 3. If this is a daemon task, the macro prefix is ESP_TASKD_, otherwise`
components: esp32 add missing file esp_task.h 2016-09-01 14:18:16 +08:00			`* it's ESP_TASK_`
components/esp32,bt: fix typos in comments 2016-09-26 00:51:56 +08:00			`* 4. If the configMAX_PRIORITIES is modified, please make all priority are`
components: esp32 add missing file esp_task.h 2016-09-01 14:18:16 +08:00			`* greater than 0`
			`* 5. Make sure esp_task.h is consistent between wifi lib and idf`
doc: Add performance guides for execuion speed, binary size, RAM usage Closes https://github.com/espressif/esp-idf/issues/7007 Closes https://github.com/espressif/esp-idf/issues/6715 Closes https://github.com/espressif/esp-idf/issues/3781 Closes https://github.com/espressif/esp-idf/issues/2566 2021-02-19 18:39:26 +11:00			`* 6. If changing system task priorities, please check the values documented in /api-guides/performance/speed.rst`
			`* are up to date`
components: esp32 add missing file esp_task.h 2016-09-01 14:18:16 +08:00			`*/`

esp32: fix kconfig 2016-09-14 12:55:41 +08:00			`#ifndef _ESP_TASK_H_`
			`#define _ESP_TASK_H_`

			`#include "sdkconfig.h"`
test: fix several test build error 2020-11-06 17:19:51 +08:00			`#include "freertos/FreeRTOS.h"`
esp32: Add missing header file in esp_task.h This commit adds a missing header file in esp_task.h required for configMAX_PRIORITIES. Closes #2341 2018-09-25 11:21:23 +08:00			`#include "freertos/FreeRTOSConfig.h"`
esp32: fix kconfig 2016-09-14 12:55:41 +08:00
components: esp32 - fix build error 2016-09-01 15:48:59 +08:00			`#define ESP_TASK_PRIO_MAX (configMAX_PRIORITIES)`
components: esp32 add missing file esp_task.h 2016-09-01 14:18:16 +08:00			`#define ESP_TASK_PRIO_MIN (0)`

1. clean up the macro. 2. change component/bt/lib url to use new lib 2016-09-23 10:48:55 +08:00			`/* Bt contoller Task */`
			`/* controller */`
component/bt : modify bluetooth task priority 2017-04-01 17:17:57 +08:00			`#define ESP_TASK_BT_CONTROLLER_PRIO (ESP_TASK_PRIO_MAX - 2)`
component/bt: optimize stack size of Bluetooth Tasks and make them be configurable according to the CONFIG_NEWLIB_NANO_FORMAT option 2017-03-06 21:50:54 +08:00			`#ifdef CONFIG_NEWLIB_NANO_FORMAT`
esp32/lwip: adjust task stack size according 'nano' print 1. Adjust tcpip/main/event/timer task stack size according 'nano' print 2. If 'nano' print is disabled the task stack size reduces 512 bytes 2017-11-09 09:39:01 +08:00			`#define TASK_EXTRA_STACK_SIZE (0)`
component/bt: optimize stack size of Bluetooth Tasks and make them be configurable according to the CONFIG_NEWLIB_NANO_FORMAT option 2017-03-06 21:50:54 +08:00			`#else`
esp32/lwip: adjust task stack size according 'nano' print 1. Adjust tcpip/main/event/timer task stack size according 'nano' print 2. If 'nano' print is disabled the task stack size reduces 512 bytes 2017-11-09 09:39:01 +08:00			`#define TASK_EXTRA_STACK_SIZE (512)`
component/bt: optimize stack size of Bluetooth Tasks and make them be configurable according to the CONFIG_NEWLIB_NANO_FORMAT option 2017-03-06 21:50:54 +08:00			`#endif`
esp32/lwip: adjust task stack size according 'nano' print 1. Adjust tcpip/main/event/timer task stack size according 'nano' print 2. If 'nano' print is disabled the task stack size reduces 512 bytes 2017-11-09 09:39:01 +08:00
			`#define BT_TASK_EXTRA_STACK_SIZE TASK_EXTRA_STACK_SIZE`
			`#define ESP_TASK_BT_CONTROLLER_STACK (3584 + TASK_EXTRA_STACK_SIZE)`
component/bt: optimize stack size of Bluetooth Tasks and make them be configurable according to the CONFIG_NEWLIB_NANO_FORMAT option 2017-03-06 21:50:54 +08:00
lwip:bugfix for increase ping task stack size 2022-10-18 16:40:32 +08:00			`/* Ping Task */`
			`#define ESP_TASK_PING_STACK (2048 + TASK_EXTRA_STACK_SIZE)`

1. clean up the macro. 2. change component/bt/lib url to use new lib 2016-09-23 10:48:55 +08:00
components: esp32 add missing file esp_task.h 2016-09-01 14:18:16 +08:00			`/* idf task */`
esp_timer: add high resolution software timer API 2017-08-08 04:21:19 +08:00			`#define ESP_TASK_TIMER_PRIO (ESP_TASK_PRIO_MAX - 3)`
Rename Kconfig options (components/esp32) 2019-04-30 12:51:55 +02:00			`#define ESP_TASK_TIMER_STACK (CONFIG_ESP_TIMER_TASK_STACK_SIZE + TASK_EXTRA_STACK_SIZE)`
components: esp32 add missing file esp_task.h 2016-09-01 14:18:16 +08:00			`#define ESP_TASKD_EVENT_PRIO (ESP_TASK_PRIO_MAX - 5)`
optimization config option LWIP_TCPIP_CORE_LOCKING 2020-12-29 16:10:37 +08:00			`#if CONFIG_LWIP_TCPIP_CORE_LOCKING`
			`#define ESP_TASKD_EVENT_STACK (CONFIG_ESP_SYSTEM_EVENT_TASK_STACK_SIZE + TASK_EXTRA_STACK_SIZE + 2048)`
			`#else`
Rename Kconfig options (components/esp32) 2019-04-30 12:51:55 +02:00			`#define ESP_TASKD_EVENT_STACK (CONFIG_ESP_SYSTEM_EVENT_TASK_STACK_SIZE + TASK_EXTRA_STACK_SIZE)`
optimization config option LWIP_TCPIP_CORE_LOCKING 2020-12-29 16:10:37 +08:00			`#endif /* CONFIG_LWIP_TCPIP_CORE_LOCKING */`
revert(lwip): Revert changes to LWIP task priority macro from MR 25020 2023-10-11 17:54:27 +08:00			`#define ESP_TASK_TCPIP_PRIO (CONFIG_LWIP_TCPIP_TASK_PRIO)`
Rename Kconfig options (components/lwip) 2019-04-29 14:30:13 +02:00			`#define ESP_TASK_TCPIP_STACK (CONFIG_LWIP_TCPIP_TASK_STACK_SIZE + TASK_EXTRA_STACK_SIZE)`
Startup flow refactoring This change removes implicit WiFi/BT initialization from startup code. "main" task is started once essential part of startup code is complete. This task calls application-provided "int main(void)" function, which can call WiFi/BT init functions if necessary. 2016-09-26 00:50:57 +08:00			`#define ESP_TASK_MAIN_PRIO (ESP_TASK_PRIO_MIN + 1)`
Rename Kconfig options (components/esp32) 2019-04-30 12:51:55 +02:00			`#define ESP_TASK_MAIN_STACK (CONFIG_ESP_MAIN_TASK_STACK_SIZE + TASK_EXTRA_STACK_SIZE)`
Allow selection of different core for main task Closes https://github.com/espressif/esp-idf/pull/6627 2021-02-27 20:13:01 +01:00			`#define ESP_TASK_MAIN_CORE CONFIG_ESP_MAIN_TASK_AFFINITY`
Startup flow refactoring This change removes implicit WiFi/BT initialization from startup code. "main" task is started once essential part of startup code is complete. This task calls application-provided "int main(void)" function, which can call WiFi/BT init functions if necessary. 2016-09-26 00:50:57 +08:00
components: esp32 add missing file esp_task.h 2016-09-01 14:18:16 +08:00			`#endif`