AM263Px MCU+ SDK: EventP.h Source File

| AM263Px MCU+ SDK 26.00.00 |

EventP.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 EVENTP_H
34 #define EVENTP_H
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 #include <stdint.h>
41 #include <kernel/dpl/SystemP.h>
42
55 #if defined (OS_NORTOS)
56 typedef struct EventP_Object_
57 {
58 volatile uint32_t eventMask;
59 } EventP_Object;
60 #elif defined (OS_FREERTOS) || defined (OS_FREERTOS_SMP) || defined (OS_FREERTOS_MPU)
61 #include <FreeRTOS.h>
62 #include <event_groups.h>
63 typedef struct EventP_Object_
64 {
65 StaticEventGroup_t eventObj;
66 EventGroupHandle_t eventHndl;
67 } EventP_Object;
68 #elif defined (OS_SAFERTOS)
69 #include <SafeRTOS.h>
70 #include <eventgroups.h>
71 typedef struct EventP_Object_
72 {
73 eventGroupType eventObj;
74 eventGroupHandleType eventHndl;
75 } EventP_Object;
76 #else
77 #error "Define OS_NORTOS, OS_FREERTOS or OS_SAFERTOS"
78 #endif
79
86 int32_t EventP_construct(EventP_Object *obj);
87
93 void EventP_destruct(EventP_Object *obj);
94
132 int32_t EventP_waitBits(EventP_Object *obj,
133 uint32_t bitsToWaitFor,
134 uint8_t clearOnExit,
135 uint8_t waitForAll,
136 uint32_t timeToWaitInTicks,
137 uint32_t *eventBits);
138
150 int32_t EventP_setBits(EventP_Object *obj, uint32_t bitsToSet);
151
162 int32_t EventP_clearBits(EventP_Object *obj, uint32_t bitsToClear);
163
178 int32_t EventP_getBits(EventP_Object *obj, uint32_t *eventBits);
179
182 #ifdef __cplusplus
183 }
184 #endif
185
186 #endif /* EVENTP_H */
EventP_clearBits
int32_t EventP_clearBits(EventP_Object *obj, uint32_t bitsToClear)
Clear a bit or multiple bits in the Event bits.
EventP_waitBits
int32_t EventP_waitBits(EventP_Object *obj, uint32_t bitsToWaitFor, uint8_t clearOnExit, uint8_t waitForAll, uint32_t timeToWaitInTicks, uint32_t *eventBits)
Read the Event bits, after optionally waiting for a bit or multiple bits to be set.
SystemP.h
EventP_getBits
int32_t EventP_getBits(EventP_Object *obj, uint32_t *eventBits)
Getting the current value of Event bits.
EventP_construct
int32_t EventP_construct(EventP_Object *obj)
Opaque Event object used with the Event APIs.
EventP_setBits
int32_t EventP_setBits(EventP_Object *obj, uint32_t bitsToSet)
Setting a bit or multiple bits in the Event bits.
EventP_destruct
void EventP_destruct(EventP_Object *obj)
Cleanup, delete, destruct an Event object.