1/*
2Copyright (c) 2012, Broadcom Europe Ltd
3All rights reserved.
4
5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions are met:
7 * Redistributions of source code must retain the above copyright
8 notice, this list of conditions and the following disclaimer.
9 * Redistributions in binary form must reproduce the above copyright
10 notice, this list of conditions and the following disclaimer in the
11 documentation and/or other materials provided with the distribution.
12 * Neither the name of the copyright holder nor the
13 names of its contributors may be used to endorse or promote products
14 derived from this software without specific prior written permission.
15
16THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
20DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26*/
27
28/*=============================================================================
29VideoCore OS Abstraction Layer - reentrant mutex public header file
30=============================================================================*/
31
32#ifndef VCOS_REENTRANT_MUTEX_H
33#define VCOS_REENTRANT_MUTEX_H
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39#include "interface/vcos/vcos_types.h"
40#include "vcos.h"
41
42/**
43 * \file
44 *
45 * Reentrant Mutex API. You can take one of these mutexes even if you've already
46 * taken it. Just to make sure.
47 *
48 * A re-entrant mutex may be slower on some platforms than a regular one.
49 *
50 * \sa vcos_mutex.h
51 *
52 */
53
54/** Create a mutex.
55 *
56 * @param m Filled in with mutex on return
57 * @param name A non-null name for the mutex, used for diagnostics.
58 *
59 * @return VCOS_SUCCESS if mutex was created, or error code.
60 */
61VCOS_INLINE_DECL
62VCOS_STATUS_T vcos_reentrant_mutex_create(VCOS_REENTRANT_MUTEX_T *m, const char *name);
63
64/** Delete the mutex.
65 */
66VCOS_INLINE_DECL
67void vcos_reentrant_mutex_delete(VCOS_REENTRANT_MUTEX_T *m);
68
69/** Wait to claim the mutex. Must not have already been claimed by the current thread.
70 */
71#ifndef vcos_reentrant_mutexlock
72VCOS_INLINE_DECL
73void vcos_reentrant_mutex_lock(VCOS_REENTRANT_MUTEX_T *m);
74
75/** Release the mutex.
76 */
77VCOS_INLINE_DECL
78void vcos_reentrant_mutex_unlock(VCOS_REENTRANT_MUTEX_T *m);
79#endif
80
81
82#ifdef __cplusplus
83}
84#endif
85#endif
86
87