EventP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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 ti_osal_EventP__include
#define ti_osal_EventP__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>

#define EventP_ID_NONE     0x0U

#define EventP_ID_00       0x1U

#define EventP_ID_01       0x2U

#define EventP_ID_02       0x4U

#define EventP_ID_03       0x8U

#define EventP_ID_04       0x10U

#define EventP_ID_05       0x20U

#define EventP_ID_06       0x40U

#define EventP_ID_07       0x80U

#define EventP_ID_08       0x100U

#define EventP_ID_09       0x200U

#define EventP_ID_10       0x400U

#define EventP_ID_11       0x800U

#define EventP_ID_12       0x1000U

#define EventP_ID_13       0x2000U

#define EventP_ID_14       0x4000U

#define EventP_ID_15       0x8000U

#define EventP_ID_16       0x10000U

#define EventP_ID_17       0x20000U

#define EventP_ID_18       0x40000U

#define EventP_ID_19       0x80000U

#define EventP_ID_20       0x100000U

#define EventP_ID_21       0x200000U

#define EventP_ID_22       0x400000U

#define EventP_ID_23       0x800000U
/* @} */

typedef enum EventP_Status_e
{
    EventP_OK         = 0,
    EventP_FAILURE    = (-(int32_t)1)
} EventP_Status;

typedef uint8_t EventP_WaitMode;
/* EventP_wait will return when ANY of the bits set in mask are set in the Event bits */
#define EventP_WaitMode_ANY                     ( (uint8_t) 0U)
/* EventP_wait will return when ALL the bits set in mask are set in the Event bits */
#define EventP_WaitMode_ALL                     ( (uint8_t) 1U)
/* @} */

#define EventP_WAIT_FOREVER (~((uint32_t)0U))

#define EventP_NO_WAIT       ((uint32_t)0U)


typedef  void *EventP_Handle;

typedef struct EventP_Params_s
{
    void *instance;          
} EventP_Params;

extern EventP_Handle EventP_create(EventP_Params *params);

extern EventP_Status EventP_delete(EventP_Handle *handle);

extern void EventP_Params_init(EventP_Params *params);

extern uint32_t EventP_wait(EventP_Handle handle, uint32_t eventMask,
                            uint8_t waitMode, uint32_t timeout);

extern EventP_Status EventP_post(EventP_Handle handle, uint32_t eventMask);

extern uint32_t EventP_getPostedEvents(EventP_Handle handle);

#ifdef __cplusplus
}
#endif

#endif /* ti_osal_EventP__include */
/* @} */