GateMutex.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020, 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_sysbios_gates_GateMutex__include
#define ti_sysbios_gates_GateMutex__include

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

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

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

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

#define ti_sysbios_gates_GateMutex_long_names
#include "GateMutex_defs.h"
#ifdef __cplusplus
extern "C" {
#endif

#define GateMutex_A_badContext "bad calling context"

typedef struct GateMutex_Params GateMutex_Params;
typedef struct GateMutex_Struct GateMutex_Struct;
typedef struct GateMutex_Struct GateMutex_Object;
typedef GateMutex_Object* GateMutex_Handle;

struct GateMutex_Params {
    uint32_t dummy;     /* to make IAR happy */
};

struct GateMutex_Struct {
    Queue_Elem objElem;
    Task_Handle owner;
    Semaphore_Struct sem;
};

typedef struct {
    Queue_Struct objQ;
} GateMutex_Module_State;
extern bool GateMutex_canBePreempted(void);

extern bool GateMutex_canBlock(void);

extern GateMutex_Handle GateMutex_create(const GateMutex_Params *prms, Error_Block *eb);

extern GateMutex_Handle GateMutex_construct(GateMutex_Struct *obj, const GateMutex_Params *prms);

extern void GateMutex_delete(GateMutex_Handle *gate);

extern void GateMutex_destruct(GateMutex_Struct *obj);

extern void GateMutex_Params_init(GateMutex_Params *prms);

extern intptr_t GateMutex_enter(GateMutex_Handle gate);

extern void GateMutex_leave(GateMutex_Handle gate, intptr_t key);

extern GateMutex_Handle GateMutex_Object_first(void);

extern GateMutex_Handle GateMutex_Object_next(GateMutex_Handle gate);

extern bool GateMutex_query(int qual);

static inline GateMutex_Handle GateMutex_handle(GateMutex_Struct *str)
{
    return ((GateMutex_Handle)str);
}

static inline GateMutex_Struct * GateMutex_struct(GateMutex_Handle h)
{
    return ((GateMutex_Struct *)h);
}

extern void GateMutex_Instance_init(GateMutex_Object *obj, const GateMutex_Params *prms);
extern void GateMutex_Instance_finalize(GateMutex_Object *obj);

#define GateMutex_module ((GateMutex_Module_State *) &(GateMutex_Module_state))

#ifdef __cplusplus
}
#endif

#endif /* ti_sysbios_gates_GateMutex__include */

#undef ti_sysbios_gates_GateMutex_long_names
#include "GateMutex_defs.h"