ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#include <stdbool.h>
#include "esp_err.h"
#include "freertos/FreeRTOSConfig.h"
#define PTHREAD_STACK_MIN
esp_pthread_cfg_t
esp_pthread_get_default_config();
esp_pthread_set_cfg(const esp_pthread_cfg_t *);
esp_pthread_get_cfg(esp_pthread_cfg_t *);
esp_pthread_init();
Files
loading...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/pthread/include/esp_pthread.h
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2018-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ #pragma once #include <stdbool.h> #include "esp_err.h" #include "freertos/FreeRTOSConfig.h" #ifdef __cplusplus extern "C" { #endif #ifndef PTHREAD_STACK_MIN #define PTHREAD_STACK_MIN CONFIG_PTHREAD_STACK_MIN #endif /** 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. *//* ... */ 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; /** * @brief Creates a default pthread configuration based * on the values set via menuconfig. * * @return * A default configuration structure. *//* ... */ esp_pthread_cfg_t esp_pthread_get_default_config(void); /** * @brief Configure parameters for creating pthread * * This API allows you to configure how the subsequent * pthread_create() call will behave. This call can be used to setup * configuration parameters like stack size, priority, configuration * inheritance etc. * * If the 'inherit' flag in the configuration structure is enabled, * 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 * * @param cfg The pthread config parameters * * @return * - ESP_OK if configuration was successfully set * - ESP_ERR_NO_MEM if out of memory * - ESP_ERR_INVALID_ARG if cfg is NULL * - 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); /** * @brief Get current pthread creation configuration * * This will retrieve the current configuration that will be used for * creating threads. * * @param p Pointer to the pthread config structure that will be * updated with the currently configured parameters * * @return * - ESP_OK if the configuration was available * - ESP_ERR_INVALID_ARG if p is NULL * - ESP_ERR_NOT_FOUND if a configuration wasn't previously set *//* ... */ esp_err_t esp_pthread_get_cfg(esp_pthread_cfg_t *p); /** * @brief Initialize pthread library *//* ... */ esp_err_t esp_pthread_init(void); #ifdef __cplusplus }{...} #endif
Details
Show:
from
Types: Columns: