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#ifndef MMAL_VC_SHM_H
28#define MMAL_VC_SHM_H
29
30/** @file
31 *
32 * Abstraction layer for MMAL VC shared memory.
33 * This API is only used by the MMAL VC component.
34 */
35
36#include "mmal_types.h"
37
38#ifdef __cplusplus
39extern "C" {
40#endif
41
42/** Initialise the shared memory system */
43MMAL_STATUS_T mmal_vc_shm_init(void);
44
45/** Release the shared memory system */
46void mmal_vc_shm_exit(void);
47
48/** Allocate a shared memory buffer */
49uint8_t *mmal_vc_shm_alloc(uint32_t size);
50
51/** Free a shared memory buffer */
52MMAL_STATUS_T mmal_vc_shm_free(uint8_t *mem);
53
54/** Lock a shared memory buffer */
55uint8_t *mmal_vc_shm_lock(uint8_t *mem, uint32_t workaround);
56
57/** Unlock a shared memory buffer */
58uint8_t *mmal_vc_shm_unlock(uint8_t *mem, uint32_t *length, uint32_t workaround);
59
60
61#ifdef __cplusplus
62}
63#endif
64
65#endif /* MMAL_VC_SHM_H */
66