Vision Apps User Guide
app_rtos.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (c) 2023 Texas Instruments Incorporated
4  *
5  * All rights reserved not granted herein.
6  *
7  * Limited License.
8  *
9  * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
10  * license under copyrights and patents it now or hereafter owns or controls to make,
11  * have made, use, import, offer to sell and sell ("Utilize") this software subject to the
12  * terms herein. With respect to the foregoing patent license, such license is granted
13  * solely to the extent that any such patent is necessary to Utilize the software alone.
14  * The patent license shall not apply to any combinations which include this software,
15  * other than combinations with devices manufactured by or for TI ("TI Devices").
16  * No hardware patent is licensed hereunder.
17  *
18  * Redistributions must preserve existing copyright notices and reproduce this license
19  * (including the above copyright notice and the disclaimer and (if applicable) source
20  * code license limitations below) in the documentation and/or other materials provided
21  * with the distribution
22  *
23  * Redistribution and use in binary form, without modification, are permitted provided
24  * that the following conditions are met:
25  *
26  * * No reverse engineering, decompilation, or disassembly of this software is
27  * permitted with respect to any software provided in binary form.
28  *
29  * * any redistribution and use are licensed by TI for use only with TI Devices.
30  *
31  * * Nothing shall obligate TI to provide you with source code for the software
32  * licensed and provided to you in object code.
33  *
34  * If software source code is provided to you, modification and redistribution of the
35  * source code are permitted provided that the following conditions are met:
36  *
37  * * any redistribution and use of the source code, including any resulting derivative
38  * works, are licensed by TI for use only with TI Devices.
39  *
40  * * any redistribution and use of any object code compiled from the source code
41  * and any resulting derivative works, are licensed by TI for use only with TI Devices.
42  *
43  * Neither the name of Texas Instruments Incorporated nor the names of its suppliers
44  *
45  * may be used to endorse or promote products derived from this software without
46  * specific prior written permission.
47  *
48  * DISCLAIMER.
49  *
50  * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
51  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
55  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
57  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
58  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
59  * OF THE POSSIBILITY OF SUCH DAMAGE.
60  *
61  */
62 
63 #ifndef _APP_RTOS_H_
64 #define _APP_RTOS_H_
65 
66 #include <stdint.h>
67 
77 #ifdef __cplusplus
78 extern "C" {
79 #endif /* __cplusplus */
80 
89 typedef int32_t app_rtos_status_t;
90 #define APP_RTOS_STATUS_SUCCESS (0)
91 
92 #define APP_RTOS_STATUS_FAILURE (-(int32_t)1)
93 
94 #define APP_RTOS_STATUS_TIMEOUT (-(int32_t)2)
95 
96 /* @} */
97 
106 typedef uint32_t app_rtos_semaphore_mode_t;
107 #define APP_RTOS_SEMAPHORE_MODE_COUNTING (0x0U)
108 #define APP_RTOS_SEMAPHORE_MODE_BINARY (0x1U)
109 #define APP_RTOS_SEMAPHORE_MODE_MUTEX (0x2U)
110 /* @} */
111 
115 #define APP_RTOS_SEMAPHORE_WAIT_FOREVER (~((uint32_t)0U))
116 
120 #define APP_RTOS_SEMAPHORE_NO_WAIT ((uint32_t)0U)
121 
122 
127 typedef struct {
128 
130  uint32_t initValue;
131  uint32_t maxValue;
133 
138 typedef struct {
139 
140  const char *name;
141  uint32_t stacksize;
142  uint8_t *stack;
143  uint32_t priority;
144  void *arg0;
145  void *arg1;
146  void (*taskfxn)(void *, void*);
147  void *userData;
149 
154 
159 
171 
180 
191 
206  uint32_t timeout);
207 
218 
229 
230 
237 
246 
257 
266 
270 void appRtosTaskYield(void);
271 
277 void appRtosTaskSleep(uint32_t timeout);
278 
279 
285 void appRtosTaskSleepInMsecs(uint32_t timeoutInMsecs);
286 
287 
288 #ifdef __cplusplus
289 }
290 #endif /* __cplusplus */
291 
292 /* \} */
293 
294 #endif
295 
Task parameters.
Definition: app_rtos.h:138
const char * name
Definition: app_rtos.h:140
uint32_t appRtosTaskIsTerminated(app_rtos_task_handle_t handle)
Check if task is terminated.
void * userData
Definition: app_rtos.h:147
app_rtos_semaphore_handle_t appRtosSemaphoreCreate(app_rtos_semaphore_params_t params)
Creates a semaphore instance.
app_rtos_status_t appRtosSemaphoreReset(app_rtos_semaphore_handle_t semhandle)
Function to clear a semaphore for reuse.
void * app_rtos_task_handle_t
Opaque client reference to an instance of a task.
Definition: app_rtos.h:158
void appRtosTaskYield(void)
Function for Task yield.
void * arg0
Definition: app_rtos.h:144
app_rtos_status_t appRtosTaskDelete(app_rtos_task_handle_t *handle)
Function to delete a task.
void * app_rtos_semaphore_handle_t
Opaque client reference to an instance of a semaphore.
Definition: app_rtos.h:153
uint32_t maxValue
Definition: app_rtos.h:131
app_rtos_status_t appRtosSemaphorePost(app_rtos_semaphore_handle_t semhandle)
Function to post (signal) a semaphore.
void appRtosSemaphoreParamsInit(app_rtos_semaphore_params_t *params)
Initialize params structure to default values.
void appRtosTaskSleepInMsecs(uint32_t timeoutInMsecs)
Function for Task sleep in units of msecs.
int32_t app_rtos_status_t
Status codes for App Rtos APIs.
Definition: app_rtos.h:89
void appRtosTaskParamsInit(app_rtos_task_params_t *params)
Initialize params structure to default values.
uint32_t priority
Definition: app_rtos.h:143
void appRtosTaskSleep(uint32_t timeout)
Function for Task sleep in units of OS tick.
app_rtos_status_t appRtosSemaphoreDelete(app_rtos_semaphore_handle_t *semhandle)
Function to delete a semaphore.
uint8_t * stack
Definition: app_rtos.h:142
app_rtos_status_t appRtosSemaphorePend(app_rtos_semaphore_handle_t semhandle, uint32_t timeout)
Function to pend (wait) on a semaphore.
uint32_t app_rtos_semaphore_mode_t
Mode of the semaphore.
Definition: app_rtos.h:106
uint32_t initValue
Definition: app_rtos.h:130
app_rtos_semaphore_mode_t mode
Definition: app_rtos.h:129
void * arg1
Definition: app_rtos.h:145
app_rtos_task_handle_t appRtosTaskCreate(const app_rtos_task_params_t *params)
Function to create a task.
Semaphore parameters.
Definition: app_rtos.h:127
uint32_t stacksize
Definition: app_rtos.h:141