Developer World
Spresense SDK Library v3.2.0-ebc0364
mpshm.h
Go to the documentation of this file.
1/****************************************************************************
2 * modules/include/asmp/mpshm.h
3 *
4 * Copyright 2018 Sony Semiconductor Solutions Corporation
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
15 * distribution.
16 * 3. Neither the name of Sony Semiconductor Solutions Corporation nor
17 * the names of its contributors may be used to endorse or promote
18 * products derived from this software without specific prior written
19 * permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
28 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *
34 ****************************************************************************/
39#ifndef __INCLUDE_ASMP_MPSHM_H
40#define __INCLUDE_ASMP_MPSHM_H
41
52#include <sys/types.h>
53#include <asmp/types.h>
54#include <semaphore.h>
55
56/* Command definitions for mpshm_control. */
57
58#define MPC_POWERON 1
59#define MPC_POWEROFF 2
60#define MPC_RETENTION 3
71typedef struct mpshm
72{
74 int8_t tag;
75 uintptr_t paddr;
76 size_t size;
77 sem_t exc;
79
82#ifdef __cplusplus
83#define EXTERN extern "C"
84extern "C"
85{
86#else
87#define EXTERN extern
88#endif
89
90/********************************************************************************
91 * Public Function Prototypes
92 ********************************************************************************/
117int mpshm_init(mpshm_t *shm, key_t key, size_t size);
118
130
146void *mpshm_attach(mpshm_t *shm, int shmflg);
147
159
184int mpshm_control(mpshm_t *shm, int cmd, void *buf);
185
198uintptr_t mpshm_virt2phys(mpshm_t *shm, void *vaddr);
199
210void *mpshm_phys2virt(mpshm_t *shm, uintptr_t paddr);
211
224int mpshm_remap(mpshm_t *shm, void *vaddr);
225
232#define mpshm_unmap(shm) mpshm_detach(shm);
233
236#undef EXTERN
237#ifdef __cplusplus
238}
239#endif
240
243#endif /* __INCLUDE_ASMP_MPSHM_H */
struct mpshm mpshm_t
int mpshm_remap(mpshm_t *shm, void *vaddr)
int mpshm_control(mpshm_t *shm, int cmd, void *buf)
int mpshm_destroy(mpshm_t *shm)
void * mpshm_attach(mpshm_t *shm, int shmflg)
uintptr_t mpshm_virt2phys(mpshm_t *shm, void *vaddr)
void * mpshm_phys2virt(mpshm_t *shm, uintptr_t paddr)
int mpshm_detach(mpshm_t *shm)
int mpshm_init(mpshm_t *shm, key_t key, size_t size)
Definition: types.h:84
Definition: mpshm.h:72
int8_t tag
Definition: mpshm.h:74
uintptr_t paddr
Definition: mpshm.h:75
size_t size
Definition: mpshm.h:76
mpobj_t super
Definition: mpshm.h:73
sem_t exc
Definition: mpshm.h:77