AM263Px MCU+ SDK  10.01.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 
55 #define SemaphoreP_OBJECT_SIZE_MAX (152U)
56 
59 typedef struct SemaphoreP_Object_ {
60 
61  /* uintptr_t translates to uint64_t for A53 and uint32_t for R5 and M4 */
62  /* This accounts for the 64bit pointer in A53 and 32bit pointer in R5 and M4 */
63  uintptr_t rsv[SemaphoreP_OBJECT_SIZE_MAX/sizeof(uint32_t)];
65 } SemaphoreP_Object;
66 
74 int32_t SemaphoreP_constructMutex(SemaphoreP_Object *obj);
75 
84 int32_t SemaphoreP_constructBinary(SemaphoreP_Object *obj, uint32_t initValue);
85 
95 int32_t SemaphoreP_constructCounting(SemaphoreP_Object *obj, uint32_t initValue, uint32_t maxValue);
96 
102 void SemaphoreP_destruct(SemaphoreP_Object *obj);
103 
109 void SemaphoreP_post(SemaphoreP_Object *obj);
110 
121 int32_t SemaphoreP_pend(SemaphoreP_Object *obj, uint32_t timeToWaitInTicks);
122 
131 int32_t SemaphoreP_getCount(SemaphoreP_Object *obj);
134 #ifdef __cplusplus
135 }
136 #endif
137 
138 #endif /* SEMAPHOREP_H */
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_Object
Opaque semaphore object used with the semaphore APIs.
Definition: SemaphoreP.h:59
SemaphoreP_constructBinary
int32_t SemaphoreP_constructBinary(SemaphoreP_Object *obj, uint32_t initValue)
Create a binary semaphore object.
SemaphoreP_OBJECT_SIZE_MAX
#define SemaphoreP_OBJECT_SIZE_MAX
Max size of semaphore object across no-RTOS and all OS's.
Definition: SemaphoreP.h:55
SemaphoreP_pend
int32_t SemaphoreP_pend(SemaphoreP_Object *obj, uint32_t timeToWaitInTicks)
Pend on a semaphore object or lock a mutex.