v2.0.0
async_context_freertos.h
1/*
2 * Copyright (c) 2022 Raspberry Pi (Trading) Ltd.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7#ifndef _PICO_ASYNC_CONTEXT_FREERTOS_H
8#define _PICO_ASYNC_CONTEXT_FREERTOS_H
9
17#include "pico/async_context.h"
18
19// FreeRTOS includes
20#include "FreeRTOS.h"
21#include "semphr.h"
22#include "timers.h"
23
24#ifdef __cplusplus
25extern "C" {
26#endif
27
28#ifndef ASYNC_CONTEXT_DEFAULT_FREERTOS_TASK_PRIORITY
29#define ASYNC_CONTEXT_DEFAULT_FREERTOS_TASK_PRIORITY ( tskIDLE_PRIORITY + 4)
30#endif
31
32#ifndef ASYNC_CONTEXT_DEFAULT_FREERTOS_TASK_STACK_SIZE
33#define ASYNC_CONTEXT_DEFAULT_FREERTOS_TASK_STACK_SIZE configMINIMAL_STACK_SIZE
34#endif
35
36typedef struct async_context_freertos async_context_freertos_t;
37
38#if !defined(configNUMBER_OF_CORES) && defined(configNUM_CORES)
39#if !portSUPPORT_SMP
40#error configNUMBER_OF_CORES is the new name for configNUM_CORES
41#else
42// portSUPPORT_SMP was defined in old smp branch
43#error configNUMBER_OF_CORES is the new name for configNUM_CORES, however it looks like you may need to define both as you are using an old SMP branch of FreeRTOS
44#endif
45#endif
46
50 typedef struct async_context_freertos_config {
54 UBaseType_t task_priority;
58 configSTACK_DEPTH_TYPE task_stack_size;
63#if configUSE_CORE_AFFINITY && configNUMBER_OF_CORES > 1
64 UBaseType_t task_core_id;
65#endif
66} async_context_freertos_config_t;
67
68 struct async_context_freertos {
69 async_context_t core;
70 SemaphoreHandle_t lock_mutex;
71 SemaphoreHandle_t work_needed_sem;
72 TimerHandle_t timer_handle;
73 TaskHandle_t task_handle;
74 uint8_t nesting;
75 volatile bool task_should_exit;
76};
77
89bool async_context_freertos_init(async_context_freertos_t *self, async_context_freertos_config_t *config);
90
98 static inline async_context_freertos_config_t async_context_freertos_default_config(void) {
99 async_context_freertos_config_t config = {
100 .task_priority = ASYNC_CONTEXT_DEFAULT_FREERTOS_TASK_PRIORITY,
101 .task_stack_size = ASYNC_CONTEXT_DEFAULT_FREERTOS_TASK_STACK_SIZE,
102#if configUSE_CORE_AFFINITY && configNUMBER_OF_CORES > 1
103 .task_core_id = (UBaseType_t)-1, // none
104#endif
105 };
106 return config;
107
108}
109
120 static inline bool async_context_freertos_init_with_defaults(async_context_freertos_t *self) {
121 async_context_freertos_config_t config = async_context_freertos_default_config();
122 return async_context_freertos_init(self, &config);
123}
124
125#ifdef __cplusplus
126}
127#endif
128
129#endif
async_context.h
async_context_freertos_init
bool async_context_freertos_init(async_context_freertos_t *self, async_context_freertos_config_t *config)
Initialize an async_context_freertos instance using the specified configuration.
Definition: async_context_freertos.c:107
async_context_freertos_init_with_defaults
static bool async_context_freertos_init_with_defaults(async_context_freertos_t *self)
Initialize an async_context_freertos instance with default values.
Definition: async_context_freertos.h:120
async_context_freertos_default_config
static async_context_freertos_config_t async_context_freertos_default_config(void)
Return a copy of the default configuration object used by async_context_freertos_init_with_defaults()
Definition: async_context_freertos.h:98
async_context_freertos_config
Configuration object for async_context_freertos instances.
Definition: async_context_freertos.h:50
async_context_freertos_config::task_priority
UBaseType_t task_priority
Task priority for the async_context task.
Definition: async_context_freertos.h:54
async_context_freertos_config::task_stack_size
configSTACK_DEPTH_TYPE task_stack_size
Stack size for the async_context task.
Definition: async_context_freertos.h:58
async_context_freertos
Definition: async_context_freertos.h:68
async_context
Base structure type of all async_contexts. For details about its use, see pico_async_context.
Definition: async_context.h:179