Developer World
Spresense SDK Library v3.2.0-ebc0364
mpmq.h
Go to the documentation of this file.
1/****************************************************************************
2 * modules/include/asmp/mpmq.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_MPMQ_H
40#define __INCLUDE_ASMP_MPMQ_H
41
51#include <sys/types.h>
52#include <asmp/types.h>
53#include <asmp/mpsignal.h>
54
55/********************************************************************************
56 * Pre-processor Definitions
57 ********************************************************************************/
58
59/* Timeout definitions for mpmq_timedreceive() */
60
61#define MPMQ_NONBLOCK 0xfffffffful
63/********************************************************************************
64 * Public Type Declarations
65 ********************************************************************************/
76typedef struct mpmq
77{
80 uint32_t flags;
82
85#ifdef __cplusplus
86#define EXTERN extern "C"
87extern "C"
88{
89#else
90#define EXTERN extern
91#endif
92
93/********************************************************************************
94 * Public Function Prototypes
95 ********************************************************************************/
121int mpmq_init(mpmq_t *mq, key_t key, cpuid_t cpuid);
122
134
147int mpmq_send(mpmq_t *mq, int8_t msgid, uint32_t data);
148
162int mpmq_timedsend(mpmq_t *mq, int8_t msgid, uint32_t data,
163 uint32_t ms);
164
178int mpmq_trysend(mpmq_t *mq, int8_t msgid, uint32_t data);
179
191int mpmq_receive(mpmq_t *mq, uint32_t *data);
192
209int mpmq_timedreceive(mpmq_t *mq, uint32_t *data, uint32_t ms);
210
223int mpmq_tryreceive(mpmq_t *mq, uint32_t *data);
224
225
238int mpmq_notify(mpmq_t *mq, int signo, void *sigdata);
239
242#undef EXTERN
243#ifdef __cplusplus
244}
245#endif
246
249#endif
int16_t cpuid_t
Definition: types.h:64
struct mpmq mpmq_t
int mpmq_destroy(mpmq_t *mq)
int mpmq_init(mpmq_t *mq, key_t key, cpuid_t cpuid)
int mpmq_receive(mpmq_t *mq, uint32_t *data)
int mpmq_trysend(mpmq_t *mq, int8_t msgid, uint32_t data)
int mpmq_timedreceive(mpmq_t *mq, uint32_t *data, uint32_t ms)
int mpmq_tryreceive(mpmq_t *mq, uint32_t *data)
int mpmq_timedsend(mpmq_t *mq, int8_t msgid, uint32_t data, uint32_t ms)
int mpmq_send(mpmq_t *mq, int8_t msgid, uint32_t data)
int mpmq_notify(mpmq_t *mq, int signo, void *sigdata)
Definition: mpmq.h:77
cpuid_t cpuid
Definition: mpmq.h:79
uint32_t flags
Definition: mpmq.h:80
mpobj_t super
Definition: mpmq.h:78
Definition: types.h:84