SemaphoreP.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2021 Texas Instruments Incorporated
 *
 *  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 SEMAPHOREP_H
#define SEMAPHOREP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
 
#define SemaphoreP_OBJECT_SIZE_MAX    (96u)
 
typedef struct SemaphoreP_Object_ {
 
    uint32_t rsv[SemaphoreP_OBJECT_SIZE_MAX/sizeof(uint32_t)]; 
} SemaphoreP_Object;
 
typedef enum SemaphoreP_Type_ {
    SemaphoreP_TYPE_BINARY, 
    SemaphoreP_TYPE_COUNTING, 
    SemaphoreP_TYPE_MUTEX 
} SemaphoreP_Type;
 
typedef struct SemaphoreP_Params_ {
 
    uint32_t type; 
    uint32_t initCount; 
    uint32_t maxCount; 
} SemaphoreP_Params;
int32_t SemaphoreP_constructMutex(SemaphoreP_Object *obj);
 
void SemaphoreP_Params_init(SemaphoreP_Params *params);
 
int32_t SemaphoreP_constructBinary(SemaphoreP_Object *obj, uint32_t initValue);
int32_t SemaphoreP_construct(SemaphoreP_Object *obj, SemaphoreP_Params *params);
 
int32_t SemaphoreP_constructCounting(SemaphoreP_Object *obj, uint32_t initValue, uint32_t maxValue);
 
void SemaphoreP_destruct(SemaphoreP_Object *obj);
 
void SemaphoreP_post(SemaphoreP_Object *obj);
 
int32_t SemaphoreP_pend(SemaphoreP_Object *obj, uint32_t timeToWaitInTicks);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SEMAPHOREP_H */