Added pointer parameter and embedded pointers to mmrpc_test program.
[ipc/ipcdev.git] / packages / ti / ipc / mm / MmRpc.h
1 /*
2  * Copyright (c) 2012-2013, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * *  Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * *  Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * *  Neither the name of Texas Instruments Incorporated nor the names of
17  *    its contributors may be used to endorse or promote products derived
18  *    from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
33 /** ============================================================================
34  *  @file       MmRpc.h
35  *
36  *  @brief      Multi-Media derived Remote Procedure Call
37  *
38  *  ============================================================================
39  */
41 #ifndef ti_ipc_mm_MmRpc__include
42 #define ti_ipc_mm_MmRpc__include
44 /* add includes here */
45 #include <stddef.h>
46 #include <stdint.h>
48 #if defined (__cplusplus)
49 extern "C" {
50 #endif
52 /*!
53  *  @brief  Operation is successful
54  */
55 #define MmRpc_S_SUCCESS (0)
57 /*!
58  *  @brief  Operation failed
59  */
60 #define MmRpc_E_FAIL (-1)
62 /*!
63  *  @brief  Invalid parameter type
64  */
65 #define MmRpc_E_INVALIDPARAM (-2)
67 /*!
68  *  @brief  Size of parameter array in function context structure
69  */
70 #define MmRpc_MAX_PARAMS (10)
72 /*!
73  *  @brief  Maximum size of translation array in function context structure
74  */
75 #define MmRpc_MAX_TRANSLATIONS (1024)
77 /*!
78  *  @brief  Macro for computing offset to a field of a structure.
79  *
80  *          struct foobar {
81  *              int a;
82  *              int *p;
83  *          };
84  *
85  *          struct foobar *sp = ...;
86  *          offset = MmRpc_OFFSET(sp, &sp->p);
87  *          struct foobar st = ...;
88  *          offset = MmRpc_OFFSET(&st, &st.p);
89  */
90 #define MmRpc_OFFSET(base, field) ((unsigned int)(field)-(unsigned int)(base))
92 /*!
93  *  @brief      MmRpc_Handle type
94  */
95 typedef struct MmRpc_Object *MmRpc_Handle;
97 /*!
98  *  @brief      MmRpc_ParamType enum
99  */
100 typedef enum {
101     MmRpc_ParamType_Scalar = 1, /*!< pass by value */
102     MmRpc_ParamType_Ptr,        /*!< data pointer */
103     MmRpc_ParamType_Elem        /*!< array element */
104 } MmRpc_ParamType;
106 /*!
107  *  @brief      MmRpc_Param type
108  */
109 typedef struct {
110     MmRpc_ParamType     type;   /*!< parameter type */
112     union {
113         struct {
114             size_t      size;   /*!< size of the data */
115             size_t      data;   /*!< data (pass by value)*/
116         } scalar;
118         struct {
119             size_t      size;   /*!< size of the data referenced */
120             size_t      addr;   /*!< pointer value */
121             size_t      handle; /*!< memory allocator handle */
122         } ptr;
124 #if 0 /* TBD */
125         struct {
126             size_t      size;   /*!< size of the array element */
127             size_t      offset; /*!< offset to current array element */
128             size_t      base;   /*!< base address of array */
129             size_t      handle; /*!< memory allocator handle */
130         } elem;
131 #endif
132     } param;
133 } MmRpc_Param;
135 typedef struct {
136     uint32_t    index;  /*!< parameter index to base pointer */
137     ptrdiff_t   offset; /*!< offset from the base address to pointer */
138     size_t      base;   /*!< user virtual address */
139     size_t      handle; /*!< memory allocator handle */
140 } MmRpc_Xlt;
142 /*!
143  *  @brief      Function call context structure
144  */
145 typedef struct {
146     uint32_t    fxn_id;         /*!< function id to call */
147     uint32_t    num_params;     /*!< number of parameters in params array */
148     MmRpc_Param params[MmRpc_MAX_PARAMS];
149                                 /*!< the array of parameters */
150     uint32_t    num_xlts;       /*!< number of translations in xltAry */
151     MmRpc_Xlt * xltAry;         /*!< array of translations */
152 } MmRpc_FxnCtx;
154 /*!
155  *  @brief      Instance create parameters
156  */
157 typedef struct {
158     int reserved;
159 } MmRpc_Params;
161 /*!
162  *  @brief      Invoke a remote procedure call
163  *
164  */
165 int MmRpc_call(MmRpc_Handle handle, MmRpc_FxnCtx *ctx, int32_t *ret);
167 /*!
168  *  @brief      Create an MmRpc instance
169  *
170  */
171 int MmRpc_create(const char *service, const MmRpc_Params *params,
172         MmRpc_Handle *handlPtr);
174 /*!
175  *  @brief      Delete an MmRpc instance
176  *
177  */
178 int MmRpc_delete(MmRpc_Handle *handlePtr);
180 /*!
181  *  @brief      Initialize the instance create parameter structure
182  *
183  */
184 void MmRpc_Params_init(MmRpc_Params *params);
188 #if defined (__cplusplus)
190 #endif
191 #endif /* ti_ipc_mm_MmRpc__include */