GateMutexPri.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_GateMutexPri__include
#define ti_sysbios_gates_GateMutexPri__include

#include <stdbool.h>
#include <stddef.h>
#include <stdint.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_GateMutexPri_long_names
#include "GateMutexPri_defs.h"
#ifdef __cplusplus
extern "C" {
#endif

typedef struct GateMutexPri_Params GateMutexPri_Params;
typedef struct GateMutexPri_Struct GateMutexPri_Struct;
typedef struct GateMutexPri_Struct GateMutexPri_Object;
typedef GateMutexPri_Object* GateMutexPri_Handle;

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

struct GateMutexPri_Struct {
    Queue_Elem objElem;
    volatile unsigned int mutexCnt;
    volatile int ownerOrigPri;
    volatile Task_Handle owner;
    Queue_Object pendQ;
};

typedef struct {
    Queue_Struct objQ;
} GateMutexPri_Module_State;
extern bool GateMutexPri_canBePreempted(void);

extern bool GateMutexPri_canBlock(void);

extern GateMutexPri_Handle GateMutexPri_create(const GateMutexPri_Params *prms, Error_Block *eb);

extern GateMutexPri_Handle GateMutexPri_construct(GateMutexPri_Struct *obj, const GateMutexPri_Params *prms);

extern void GateMutexPri_delete(GateMutexPri_Handle *gate);

extern void GateMutexPri_destruct(GateMutexPri_Struct *obj);

extern void GateMutexPri_Params_init(GateMutexPri_Params *prms);

extern intptr_t GateMutexPri_enter(GateMutexPri_Handle gate);

extern void GateMutexPri_leave(GateMutexPri_Handle gate, intptr_t key);

extern GateMutexPri_Handle GateMutexPri_Object_first(void);

extern GateMutexPri_Handle GateMutexPri_Object_next(GateMutexPri_Handle gate);

extern bool GateMutexPri_query(int qual);
static inline GateMutexPri_Handle GateMutexPri_handle(GateMutexPri_Struct *str)
{
    return ((GateMutexPri_Handle)str);
}

static inline GateMutexPri_Struct * GateMutexPri_struct(GateMutexPri_Handle h)
{
    return ((GateMutexPri_Struct *)h);
}

#define GateMutexPri_module ((GateMutexPri_Module_State *) &(GateMutexPri_Module_state))

#ifdef __cplusplus
}
#endif

#endif /* ti_sysbios_gates_GateMutexPri__include */

#undef ti_sysbios_gates_GateMutexPri_long_names
#include "GateMutexPri_defs.h"