libmetal
mutex.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, Xilinx Inc. and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * 3. Neither the name of Xilinx nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without
16  * specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 /*
32  * @file freertos/mutex.h
33  * @brief FreeRTOS mutex primitives for libmetal.
34  */
35 
36 #ifndef __METAL_MUTEX__H__
37 #error "Include metal/mutex.h instead of metal/freertos/mutex.h"
38 #endif
39 
40 #ifndef __METAL_FREERTOS_MUTEX__H__
41 #define __METAL_FREERTOS_MUTEX__H__
42 
43 #include <assert.h>
44 #include "FreeRTOS.h"
45 #include "semphr.h"
46 
47 
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 typedef struct {
53  SemaphoreHandle_t m;
55 
56 #define METAL_MUTEX_INIT { NULL }
57 
58 static inline void metal_mutex_init(metal_mutex_t *mutex)
59 {
60  assert(mutex);
61  mutex->m = xSemaphoreCreateMutex();
62  assert(mutex->m != NULL);
63 }
64 
65 static inline void metal_mutex_deinit(metal_mutex_t *mutex)
66 {
67  assert(mutex && mutex->m != NULL);
68  vSemaphoreDelete(mutex->m);
69  mutex->m=NULL;
70 }
71 
72 static inline int metal_mutex_try_acquire(metal_mutex_t *mutex)
73 {
74  assert(mutex && mutex->m != NULL);
75  return xSemaphoreTake(mutex->m, ( TickType_t ) 0 );
76 }
77 
78 static inline void metal_mutex_acquire(metal_mutex_t *mutex)
79 {
80  assert(mutex && mutex->m != NULL);
81  xSemaphoreTake(mutex->m, portMAX_DELAY);
82 }
83 
84 static inline void metal_mutex_release(metal_mutex_t *mutex)
85 {
86  assert(mutex && mutex->m != NULL);
87  xSemaphoreGive(mutex->m);
88 }
89 
90 static inline int metal_mutex_is_acquired(metal_mutex_t *mutex)
91 {
92  assert(mutex && mutex->m != NULL);
93  return (NULL == xSemaphoreGetMutexHolder(mutex->m)) ? 0 : 1;
94 }
95 
96 #ifdef __cplusplus
97 }
98 #endif
99 
100 #endif /* __METAL_FREERTOS_MUTEX__H__ */
static int metal_mutex_is_acquired(metal_mutex_t *mutex)
Definition: mutex.h:90
static void metal_mutex_acquire(metal_mutex_t *mutex)
Definition: mutex.h:78
static int metal_mutex_try_acquire(metal_mutex_t *mutex)
Definition: mutex.h:72
static void metal_mutex_release(metal_mutex_t *mutex)
Definition: mutex.h:84
Definition: mutex.h:52
static void metal_mutex_init(metal_mutex_t *mutex)
Definition: mutex.h:58
SemaphoreHandle_t m
Definition: mutex.h:53
static void metal_mutex_deinit(metal_mutex_t *mutex)
Definition: mutex.h:65