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 - mutex public header file
30=============================================================================*/
31
32#ifndef VCOS_QUICKSLOW_MUTEX_H
33#define VCOS_QUICKSLOW_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 vcos_quickslow_mutex.h
44 *
45 * "Quick/Slow" Mutex API. This is a mutex which supports an additional "quick"
46 * (spinlock-based) locking mechanism. While in this quick locked state, other
47 * operating system commands will be unavailable and the caller should complete
48 * whatever it has to do in a short, bounded length of time (as the spinlock
49 * completely locks out other system activity).
50 *
51 * \sa vcos_mutex.h
52 *
53 */
54
55/** Create a mutex.
56 *
57 * @param m Filled in with mutex on return
58 * @param name A non-null name for the mutex, used for diagnostics.
59 *
60 * @return VCOS_SUCCESS if mutex was created, or error code.
61 */
62VCOS_INLINE_DECL
63VCOS_STATUS_T vcos_quickslow_mutex_create(VCOS_QUICKSLOW_MUTEX_T *m, const char *name);
64
65/** Delete the mutex.
66 */
67VCOS_INLINE_DECL
68void vcos_quickslow_mutex_delete(VCOS_QUICKSLOW_MUTEX_T *m);
69
70/**
71 * \brief Wait to claim the mutex ("slow" mode).
72 *
73 * Obtain the mutex.
74 */
75VCOS_INLINE_DECL
76void vcos_quickslow_mutex_lock(VCOS_QUICKSLOW_MUTEX_T *m);
77
78/** Release the mutex ("slow" mode).
79 */
80VCOS_INLINE_DECL
81void vcos_quickslow_mutex_unlock(VCOS_QUICKSLOW_MUTEX_T *m);
82
83/**
84 * \brief Wait to claim the mutex ("quick" mode).
85 *
86 * Obtain the mutex. The caller must not call any OS functions or do anything
87 * "slow" before the corresponding call to vcos_mutex_quickslow_unlock_quick.
88 */
89VCOS_INLINE_DECL
90void vcos_quickslow_mutex_lock_quick(VCOS_QUICKSLOW_MUTEX_T *m);
91
92/** Release the mutex ("quick" mode).
93 */
94VCOS_INLINE_DECL
95void vcos_quickslow_mutex_unlock_quick(VCOS_QUICKSLOW_MUTEX_T *m);
96
97
98#ifdef __cplusplus
99}
100#endif
101#endif
102