SemaphoreP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2023, 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_dpl_SemaphoreP__include
#define ti_dpl_SemaphoreP__include

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

#ifdef __cplusplus
extern "C" {
#endif

#define SemaphoreP_STRUCT_SIZE (80)

typedef union SemaphoreP_Struct
{
    uint32_t dummy; 
    uint8_t data[SemaphoreP_STRUCT_SIZE];
} SemaphoreP_Struct;

#define SemaphoreP_WAIT_FOREVER ~(0)

#define SemaphoreP_NO_WAIT (0)

typedef enum
{
    SemaphoreP_OK      = 0,
    SemaphoreP_TIMEOUT = -1
} SemaphoreP_Status;

typedef void *SemaphoreP_Handle;

typedef enum
{
    SemaphoreP_Mode_COUNTING = 0x0,
    SemaphoreP_Mode_BINARY   = 0x1
} SemaphoreP_Mode;

typedef struct
{
    SemaphoreP_Mode mode;   
    void (*callback)(void); 
} SemaphoreP_Params;

extern SemaphoreP_Params SemaphoreP_defaultParams;

/*
 *  SemaphoreP construct APIs can only be used if one of the OS's
 *  is defined.  For FreeRTOS, configSUPPORT_STATIC_ALLOCATION also
 *  has to be set to 1 in FreeRTOSConfig.h.
 */
extern SemaphoreP_Handle SemaphoreP_construct(SemaphoreP_Struct *handle, unsigned int count, SemaphoreP_Params *params);

extern SemaphoreP_Handle SemaphoreP_constructBinary(SemaphoreP_Struct *handle, unsigned int count);

extern void SemaphoreP_destruct(SemaphoreP_Struct *semP);

extern SemaphoreP_Handle SemaphoreP_create(unsigned int count, SemaphoreP_Params *params);

extern SemaphoreP_Handle SemaphoreP_createBinary(unsigned int count);

extern SemaphoreP_Handle SemaphoreP_createBinaryCallback(unsigned int count, void (*callback)(void));

extern void SemaphoreP_delete(SemaphoreP_Handle handle);

extern void SemaphoreP_Params_init(SemaphoreP_Params *params);

extern SemaphoreP_Status SemaphoreP_pend(SemaphoreP_Handle handle, uint32_t timeout);

extern void SemaphoreP_post(SemaphoreP_Handle handle);

#ifdef __cplusplus
}
#endif

#endif /* ti_dpl_SemaphoreP__include */