feat(pthread): Pthread can now use PSRAM as stack

Closes https://github.com/espressif/esp-idf/pull/10623
Closes https://github.com/espressif/esp-idf/issues/8662

Thanks to f-hoepfinger-hr-agrartechnik for the contribution
in https://github.com/espressif/esp-idf/pull/10623
This commit is contained in:
Jakob Hasse
2023-06-30 11:21:12 +08:00
parent 261651fc19
commit be59c94917
13 changed files with 304 additions and 17 deletions

View File

@@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: 2018-2022 Espressif Systems (Shanghai) CO LTD
* SPDX-FileCopyrightText: 2018-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
@@ -20,11 +20,15 @@ extern "C" {
/** pthread configuration structure that influences pthread creation */
typedef struct {
size_t stack_size; ///< The stack size of the pthread
size_t prio; ///< The thread's priority
bool inherit_cfg; ///< Inherit this configuration further
const char* thread_name; ///< The thread name.
int pin_to_core; ///< The core id to pin the thread to. Has the same value range as xCoreId argument of xTaskCreatePinnedToCore.
size_t stack_size; /**< The stack size of the pthread */
size_t prio; /**< The thread's priority */
bool inherit_cfg; /**< Inherit this configuration further */
const char* thread_name; /**< The thread name. */
int pin_to_core; /**< The core id to pin the thread to. Has the same value range as xCoreId
argument of xTaskCreatePinnedToCore. */
uint32_t stack_alloc_caps; /**< A bit mask of memory capabilities (MALLOC_CAPS*) to use when
allocating the stack. The memory must be 8 bit accessible (MALLOC_CAP_8BIT).
The developer is responsible for the correctenss of \c stack_alloc_caps. */
} esp_pthread_cfg_t;
/**
@@ -48,6 +52,9 @@ esp_pthread_cfg_t esp_pthread_get_default_config(void);
* then the same configuration is also inherited in the thread
* subtree.
*
* @note If cfg->stack_alloc_caps is 0, it is automatically set to valid default stack memory
* capabilities. If cfg->stack_alloc_caps is non-zero, the developer is responsible for its correctenss.
* This function only checks that the capabilities are MALLOC_CAP_8BIT, the rest is unchecked.
* @note Passing non-NULL attributes to pthread_create() will override
* the stack_size parameter set using this API
*
@@ -57,6 +64,7 @@ esp_pthread_cfg_t esp_pthread_get_default_config(void);
* - ESP_OK if configuration was successfully set
* - ESP_ERR_NO_MEM if out of memory
* - ESP_ERR_INVALID_ARG if stack_size is less than PTHREAD_STACK_MIN
* - ESP_ERR_INVALID_ARG if stack_alloc_caps does not include MALLOC_CAP_8BIT
*/
esp_err_t esp_pthread_set_cfg(const esp_pthread_cfg_t *cfg);