Event.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020, Texas Instruments Incorporated - http://www.ti.com
 * 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_sysbios_knl_Event__include
#define ti_sysbios_knl_Event__include

/* BIOS 6.x compatibility, use -Dxdc_std__include to disable */
#include <xdc/std.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

#include <ti/sysbios/knl/Queue.h>
#include <ti/sysbios/knl/Task.h>

#include <ti/sysbios/runtime/Error.h>

/* @cond NODOC */
#define ti_sysbios_knl_Event_long_names
#include "Event_defs.h"
#ifdef __cplusplus
extern "C" {
#endif

#define Event_A_nullEventMasks "orMask and andMask are null"

#define Event_A_nullEventId "posted eventId is null"

#define Event_A_eventInUse "event object already in use"

#define Event_A_badContext "bad calling context - must be called from a Task"

#define Event_A_pendTaskDisabled "cannot call Event_pend() while the Task or Swi scheduler is disabled"

#define Event_Id_00 (0x1)
#define Event_Id_01 (0x2)
#define Event_Id_02 (0x4)
#define Event_Id_03 (0x8)
#define Event_Id_04 (0x10)
#define Event_Id_05 (0x20)
#define Event_Id_06 (0x40)
#define Event_Id_07 (0x80)
#define Event_Id_08 (0x100)
#define Event_Id_09 (0x200)
#define Event_Id_10 (0x400)
#define Event_Id_11 (0x800)
#define Event_Id_12 (0x1000)
#define Event_Id_13 (0x2000)
#define Event_Id_14 (0x4000)
#define Event_Id_15 (0x8000)
#define Event_Id_16 (0x10000)
#define Event_Id_17 (0x20000)
#define Event_Id_18 (0x40000)
#define Event_Id_19 (0x80000)
#define Event_Id_20 (0x100000)
#define Event_Id_21 (0x200000)
#define Event_Id_22 (0x400000)
#define Event_Id_23 (0x800000)
#define Event_Id_24 (0x1000000)
#define Event_Id_25 (0x2000000)
#define Event_Id_26 (0x4000000)
#define Event_Id_27 (0x8000000)
#define Event_Id_28 (0x10000000)
#define Event_Id_29 (0x20000000)
#define Event_Id_30 (0x40000000)
#define Event_Id_31 (0x80000000)
#define Event_Id_NONE (0)


/*
 * ======== INTERNAL DEFINITIONS ========
 */

typedef enum {
    Event_PendState_TIMEOUT = 0,
    Event_PendState_POSTED = 1,
    Event_PendState_CLOCK_WAIT = 2,
    Event_PendState_WAIT_FOREVER = 3
} Event_PendState;

typedef struct {
    Task_PendElem tpElem;
    Event_PendState pendState;
    unsigned int matchingEvents;
    unsigned int andMask;
    unsigned int orMask;
} Event_PendElem;

struct Event_Params {
    unsigned int dummy;
};

struct Event_Struct {
    Queue_Elem objElem;
    volatile unsigned int postedEvents;
    Queue_Struct pendQ;
};

typedef struct Event_Params Event_Params;
typedef struct Event_Struct Event_Object;
typedef struct Event_Struct Event_Struct;
typedef struct Event_Struct *Event_Handle;

typedef struct {
    Queue_Struct objQ;
} Event_Module_State;
/*
 * ======== FUNCTION DECLARATIONS ========
 */

extern void Event_Instance_init(Event_Object *obj, const Event_Params *params);
extern Event_Handle Event_create(const Event_Params *params, Error_Block *eb);

extern Event_Handle Event_construct(Event_Struct *obj, const Event_Params *params);

void Event_delete(Event_Handle *event);

extern void Event_destruct(Event_Struct *obj);

extern unsigned int Event_pend(Event_Handle event, unsigned int andMask, unsigned int orMask, uint32_t timeout);

extern void Event_post(Event_Handle event, unsigned int eventMask);

extern unsigned int Event_getPostedEvents(Event_Handle event);

extern void Event_Params_init(Event_Params *prms);

extern Event_Handle Event_Object_first(void);

extern Event_Handle Event_Object_next(Event_Handle event);

extern void Event_sync(Event_Handle event, unsigned int eventId, unsigned int count);

extern void Event_pendTimeout__I(uintptr_t arg);
extern unsigned int Event_checkEvents(Event_Object *event, unsigned int andMask, unsigned int orMask);


static inline Event_Handle Event_handle(Event_Struct *str)
{
    return ((Event_Handle)str);
}

static inline Event_Struct * Event_struct(Event_Handle h)
{
    return ((Event_Struct *)h);
}

#define Event_module ((Event_Module_State *) &(Event_Module_state))

#ifdef __cplusplus
}
#endif

#endif /* ti_sysbios_knl_Event__include */

/* @cond NODOC */
#undef ti_sysbios_knl_Event_long_names
#include "Event_defs.h"