libmetal
shmem.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015, Xilinx Inc. and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 /*
8  * @file shmem.h
9  * @brief Shared memory primitives for libmetal.
10  */
11 
12 #ifndef __METAL_SHMEM__H__
13 #define __METAL_SHMEM__H__
14 
15 #include <metal/io.h>
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
26  const char *name;
28  struct metal_list node;
29 };
30 
43 extern int metal_shmem_open(const char *name, size_t size,
44  struct metal_io_region **io);
45 
57 extern int metal_shmem_register_generic(struct metal_generic_shmem *shmem);
58 
59 #ifdef METAL_INTERNAL
60 
72 int metal_shmem_open_generic(const char *name, size_t size,
73  struct metal_io_region **result);
74 
75 #endif
76 
79 #ifdef __cplusplus
80 }
81 #endif
82 
83 #endif /* __METAL_SHMEM__H__ */
struct metal_list node
Definition: shmem.h:28
Definition: shmem.h:25
int metal_shmem_register_generic(struct metal_generic_shmem *shmem)
Statically register a generic shared memory region.
Definition: shmem.c:18
Definition: list.h:24
const char * name
Definition: shmem.h:26
struct metal_io_region io
Definition: shmem.h:27
Definition: io.h:68
int metal_shmem_open_generic(const char *name, size_t size, struct metal_io_region **result)
Definition: shmem.c:31
int metal_shmem_open(const char *name, size_t size, struct metal_io_region **io)
Open a libmetal shared memory segment.
Definition: shmem.c:14