libmetal  latest
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 
27  const char *name;
28  struct metal_io_region io;
29  struct metal_list node;
30 };
31 
44 int metal_shmem_open(const char *name, size_t size,
45  struct metal_io_region **io);
46 
59 
60 #ifdef METAL_INTERNAL
61 
73 int metal_shmem_open_generic(const char *name, size_t size,
74  struct metal_io_region **result);
75 
76 #endif
77 
80 #ifdef __cplusplus
81 }
82 #endif
83 
84 #endif /* __METAL_SHMEM__H__ */
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
int metal_shmem_register_generic(struct metal_generic_shmem *shmem)
Statically register a generic shared memory region.
Definition: shmem.c:18
int metal_shmem_open_generic(const char *name, size_t size, struct metal_io_region **result)
Definition: shmem.c:31
Generic shared memory data structure.
Definition: shmem.h:26
const char * name
Definition: shmem.h:27
struct metal_io_region io
Definition: shmem.h:28
struct metal_list node
Definition: shmem.h:29
Libmetal I/O region structure.
Definition: io.h:73
Definition: list.h:26