lwpa_lock.h

/******************************************************************************
 * Copyright 2018 ETC Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************
 * This file is a part of lwpa. For more information, go to:
 * https://github.com/ETCLabs/lwpa
 ******************************************************************************/
 
#ifndef _LWPA_LOCK_H_
#define _LWPA_LOCK_H_
 
#include "FreeRTOS.h"
#include "semphr.h"
#include "lwpa_common.h"
#include "lwpa_bool.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef SemaphoreHandle_t lwpa_mutex_t;
 
bool lwpa_mutex_create(lwpa_mutex_t *id);
bool lwpa_mutex_take(lwpa_mutex_t *id, int wait_ms);
void lwpa_mutex_give(lwpa_mutex_t *id);
void lwpa_mutex_destroy(lwpa_mutex_t *id);
 
typedef SemaphoreHandle_t lwpa_signal_t;
 
bool lwpa_signal_create(lwpa_signal_t *id);
bool lwpa_signal_wait(lwpa_signal_t *id, int wait_ms);
void lwpa_signal_post(lwpa_signal_t *id);
void lwpa_signal_destroy(lwpa_signal_t *id);
 
typedef struct
{
  SemaphoreHandle_t sem;
  unsigned int reader_count;
} lwpa_rwlock_t;
 
bool lwpa_rwlock_create(lwpa_rwlock_t *id);
bool lwpa_rwlock_readlock(lwpa_rwlock_t *id, int wait_ms);
void lwpa_rwlock_readunlock(lwpa_rwlock_t *id);
bool lwpa_rwlock_writelock(lwpa_rwlock_t *id, int wait_ms);
void lwpa_rwlock_writeunlock(lwpa_rwlock_t *id);
void lwpa_rwlock_destroy(lwpa_rwlock_t *id);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _LWPA_LOCK_H_ */