EventP.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2021 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef EVENTP_H
#define EVENTP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
 
#if defined (OS_NORTOS)
typedef struct EventP_Object_
{
    volatile uint32_t eventMask;
} EventP_Object;
#elif defined (OS_FREERTOS) || defined (OS_FREERTOS_SMP) || defined (OS_FREERTOS_MPU)
#include <FreeRTOS.h>
#include <event_groups.h>
typedef struct EventP_Object_
{
    StaticEventGroup_t eventObj;
    EventGroupHandle_t eventHndl;
} EventP_Object;
#elif defined (OS_SAFERTOS)
#include <SafeRTOS.h>
#include <eventgroups.h>
typedef struct EventP_Object_
{
    eventGroupType eventObj;
    eventGroupHandleType eventHndl;
} EventP_Object;
#else 
#error "Define OS_NORTOS, OS_FREERTOS or OS_SAFERTOS"
#endif
 
int32_t EventP_construct(EventP_Object *obj);
 
void EventP_destruct(EventP_Object *obj);
 
int32_t EventP_waitBits(EventP_Object  *obj,
                        uint32_t       bitsToWaitFor,
                        uint8_t        clearOnExit,
                        uint8_t        waitForAll,
                        uint32_t       timeToWaitInTicks,
                        uint32_t       *eventBits);
 
int32_t EventP_setBits(EventP_Object *obj, uint32_t bitsToSet);
 
int32_t EventP_clearBits(EventP_Object *obj, uint32_t bitsToClear);
 
int32_t EventP_getBits(EventP_Object *obj, uint32_t *eventBits);
 
#ifdef __cplusplus
}
#endif
 
#endif /* EVENTP_H */