rpmsg_rpc.h
3.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/*
* Remote Processor Procedure Call Driver
*
* Copyright (C) 2012-2016 Texas Instruments Incorporated - http://www.ti.com/
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name Texas Instruments nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _LINUX_RPMSG_RPC_H_
#define _LINUX_RPMSG_RPC_H_
#include <uapi/linux/rpmsg_rpc.h>
#define RPPC_MAX_NUM_FUNCS (1024)
#define RPPC_MAX_CHANNEL_NAMELEN (64)
#define RPPC_MAX_FUNC_NAMELEN (64)
#define RPPC_MAX_NUM_PARAMS (10)
/**
* enum rppc_param_direction - direction of the function parameter
* @RPPC_PARAMDIR_IN: input argument
* @RPPC_PARAMDIR_OUT: output argument
* @RPPC_PARAMDIR_BI: an in and out argument
* @RPPC_PARAMDIR_MAX: limit value for the direction type
*
* The parameter direction is described as relative to the function.
*/
enum rppc_param_direction {
RPPC_PARAMDIR_IN = 0,
RPPC_PARAMDIR_OUT,
RPPC_PARAMDIR_BI,
RPPC_PARAMDIR_MAX
};
/**
* enum rppc_param_datatype - parameter data type and descriptor flags
* @RPPC_PARAM_VOID: parameter is of type 'void'
* @RPPC_PARAM_S08: parameter is of type 's8'
* @RPPC_PARAM_U08: parameter is of type 'u8'
* @RPPC_PARAM_S16: parameter is of type 's16'
* @RPPC_PARAM_U16: parameter is of type 'u16'
* @RPPC_PARAM_S32: parameter is of type 's32'
* @RPPC_PARAM_U32: parameter is of type 'u32'
* @RPPC_PARAM_S64: parameter is of type 's64'
* @RPPC_PARAM_U64: parameter is of type 'u64'
* @RPPC_PARAM_ATOMIC_MAX: limit value for scalar data types
* @RPPC_PARAM_MASK: mask field for retrieving the scalar data type
* @RPPC_PARAM_PTR: flag to indicate the data type is a pointer
* @RPPC_PARAM_MAX: max limit value used as a marker
*
* This enum is used to describe the data type for the parameters.
* A pointer of a data type is reflected by using an additional bit
* mask field.
*/
enum rppc_param_datatype {
RPPC_PARAM_VOID = 0,
RPPC_PARAM_S08,
RPPC_PARAM_U08,
RPPC_PARAM_S16,
RPPC_PARAM_U16,
RPPC_PARAM_S32,
RPPC_PARAM_U32,
RPPC_PARAM_S64,
RPPC_PARAM_U64,
RPPC_PARAM_ATOMIC_MAX,
RPPC_PARAM_MASK = 0x7F,
RPPC_PARAM_PTR = 0x80,
RPPC_PARAM_MAX
};
/*
* helper macros to deal with parameter types
*/
#define RPPC_PTR_TYPE(type) ((type) | RPPC_PARAM_PTR)
#define RPPC_IS_PTR(type) ((type) & RPPC_PARAM_PTR)
#define RPPC_IS_ATOMIC(type) (((type) > RPPC_PARAM_VOID) && \
((type) < RPPC_PARAM_ATOMIC_MAX))
#endif /* _LINUX_RPMSG_RPC_H_ */