AM261x MCU+ SDK: SemaphoreP.h Source File

| AM261x MCU+ SDK 26.00.00 |

SemaphoreP.h
Go to the documentation of this file.
1 /*
2 * Copyright (C) 2018-2021 Texas Instruments Incorporated
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the
14 * distribution.
15 *
16 * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #ifndef SEMAPHOREP_H
34 #define SEMAPHOREP_H
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 #include <stdint.h>
41 #include <kernel/dpl/SystemP.h>
42
52 #if defined(OS_NORTOS)
53
56 typedef struct SemaphoreP_Object_ {
57 uint32_t type;
58 uint32_t maxCount;
59 volatile uint32_t count;
60 volatile uint32_t nestCount;
61 } SemaphoreP_Object;
62
63 #elif defined (OS_FREERTOS) || defined (OS_FREERTOS_SMP) || defined (OS_FREERTOS_MPU)
64
67 #include <FreeRTOS.h>
68 #include <task.h>
69 #include <semphr.h>
70 typedef struct SemaphoreP_Object_ {
71 StaticSemaphore_t semObj;
72 SemaphoreHandle_t semHndl;
73 uint32_t isRecursiveMutex;
74 } SemaphoreP_Object;
75
76 #elif defined(OS_SAFERTOS)
77
80 #include <SafeRTOS.h>
81 #include <queue.h>
82 #include <semaphore.h>
83 #include <mutex.h>
84 typedef struct SemaphoreP_Object_ {
85 uint64_t semObj[(safertosapiQUEUE_OVERHEAD_BYTES / sizeof(uint64_t) + 1)];
86 xSemaphoreHandle semHndl;
87 uint32_t isRecursiveMutex;
88 } SemaphoreP_Object;
89
90 #else
91 #error "Define OS_NORTOS, OS_FREERTOS, or OS_SAFERTOS"
92 #endif
93
101 int32_t SemaphoreP_constructMutex(SemaphoreP_Object *obj);
102
111 int32_t SemaphoreP_constructBinary(SemaphoreP_Object *obj, uint32_t initValue);
112
122 int32_t SemaphoreP_constructCounting(SemaphoreP_Object *obj, uint32_t initValue, uint32_t maxValue);
123
129 void SemaphoreP_destruct(SemaphoreP_Object *obj);
130
136 void SemaphoreP_post(SemaphoreP_Object *obj);
137
148 int32_t SemaphoreP_pend(SemaphoreP_Object *obj, uint32_t timeToWaitInTicks);
149
158 int32_t SemaphoreP_getCount(SemaphoreP_Object *obj);
161 #ifdef __cplusplus
162 }
163 #endif
164
165 #endif /* SEMAPHOREP_H */
166
SystemP.h
SemaphoreP_constructCounting
int32_t SemaphoreP_constructCounting(SemaphoreP_Object *obj, uint32_t initValue, uint32_t maxValue)
Create a counting semaphore object.
SemaphoreP_destruct
void SemaphoreP_destruct(SemaphoreP_Object *obj)
Cleanup, delete, destruct a semaphore object.
SemaphoreP_constructMutex
int32_t SemaphoreP_constructMutex(SemaphoreP_Object *obj)
Create a mutex semaphore object.
SemaphoreP_getCount
int32_t SemaphoreP_getCount(SemaphoreP_Object *obj)
Function to return the count of a semaphore.
SemaphoreP_post
void SemaphoreP_post(SemaphoreP_Object *obj)
Post a semaphore object or unlock a mutex.
SemaphoreP_constructBinary
int32_t SemaphoreP_constructBinary(SemaphoreP_Object *obj, uint32_t initValue)
Create a binary semaphore object.
SemaphoreP_pend
int32_t SemaphoreP_pend(SemaphoreP_Object *obj, uint32_t timeToWaitInTicks)
Pend on a semaphore object or lock a mutex.