Added pointer parameter and embedded pointers to mmrpc_test program.
[ipc/ipcdev.git] / packages / ti / ipc / mm / MmRpc.c
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  *  ======== MmRpc.c ========
35  */
37 #include <stdio.h>
38 #include <stdlib.h>
39 #include <sys/types.h>
40 #include <sys/stat.h>
41 #include <sys/ioctl.h>
42 #include <fcntl.h>
43 #include <unistd.h>
44 #include <string.h>
46 #include <stdint.h> /* should be in linux/rpmsg_rpc.h */
47 #include <stddef.h> /* should be in linux/rpmsg_rpc.h */
51 #if defined(KERNEL_INSTALL_DIR)
53 #ifdef linux
54 #define _linux_ linux
55 #undef linux
56 #endif
57 #define linux_include(kd,m) <kd/include/linux/m.h>
58 #include linux_include(KERNEL_INSTALL_DIR,rpmsg_rpc)
59 #ifdef _linux_
60 #define linux _linux
61 #undef _linux_
62 #endif
64 #define RPPC_MAX_INST_NAMELEN (48) /* in kernel part of rpmsg_rpc.h */
66 /* this should be in rpmsg_rpc.h, currently in rpmsg_rpc_internal.h */
67 struct rppc_create_instance {
68     char name[RPPC_MAX_INST_NAMELEN];
69 };
71 #elif defined(SYSLINK_BUILDOS_QNX)
73 #include <ti/ipc/rpmsg_rpc.h>
75 #else
76 #error Unsupported Operating System
77 #endif
79 #include "MmRpc.h"
82 /*
83  *  ======== MmRpc_Object ========
84  */
85 typedef struct {
86     int                         fd;         /* device file descriptor */
87     struct rppc_create_instance connect;    /* connection object */
88 } MmRpc_Object;
90 /*
91  *  ======== MmRpc_Params_init ========
92  */
93 void MmRpc_Params_init(MmRpc_Params *params)
94 {
95     params->reserved = 0;
96 }
98 /*
99  *  ======== MmRpc_create ========
100  */
101 int MmRpc_create(const char *service, const MmRpc_Params *params,
102         MmRpc_Handle *handlePtr)
104     int             status = MmRpc_S_SUCCESS;
105     MmRpc_Object *  obj;
106     char            cbuf[RPPC_MAX_INST_NAMELEN+16];
108     /* allocate the instance object */
109     obj = (MmRpc_Object *)calloc(1, sizeof(MmRpc_Object));
111     if (obj == NULL) {
112         status = MmRpc_E_FAIL;
113         goto leave;
114     }
116     /* open the driver */
117     sprintf(cbuf, "/dev/%s", service);
118     obj->fd = open(cbuf, O_RDWR);
120     if (obj->fd < 0) {
121         printf("MmRpc_create: Error: open failed\n");
122         status = MmRpc_E_FAIL;
123         goto leave;
124     }
126     strncpy(obj->connect.name, service, (RPPC_MAX_INST_NAMELEN - 1));
127     obj->connect.name[RPPC_MAX_INST_NAMELEN - 1] = '\0';
129     /* create a server instance, rebind its address to this file descriptor */
130     status = ioctl(obj->fd, RPPC_IOC_CREATE, &obj->connect);
132     if (status < 0) {
133         printf("MmRpc_create: Error: connect failed\n");
134         status = MmRpc_E_FAIL;
135         goto leave;
136     }
138 leave:
139     if (status < 0) {
140         if ((obj != NULL) && (obj->fd >= 0)) {
141             close(obj->fd);
142         }
143         if (obj != NULL) {
144             free(obj);
145         }
146         *handlePtr = NULL;
147     }
148     else {
149         *handlePtr = (MmRpc_Handle)obj;
150     }
152     return(status);
155 /*
156  *  ======== MmRpc_delete ========
157  */
158 int MmRpc_delete(MmRpc_Handle *handlePtr)
160     int status = MmRpc_S_SUCCESS;
161     MmRpc_Object *obj;
163     obj = (MmRpc_Object *)(*handlePtr);
165     /* close the device */
166     if ((obj != NULL) && (obj->fd >= 0)) {
167         close(obj->fd);
168     }
170     /* free the instance object */
171     free((void *)(*handlePtr));
172     *handlePtr = NULL;
174     return(status);
177 /*
178  *  ======== MmRpc_call ========
179  */
180 int MmRpc_call(MmRpc_Handle handle, MmRpc_FxnCtx *ctx, int32_t *ret)
182     int status = MmRpc_S_SUCCESS;
183     MmRpc_Object *obj = (MmRpc_Object *)handle;
184     struct rppc_function *rpfxn;
185     struct rppc_function_return reply_msg;
186     MmRpc_Param *param;
187     void *msg;
188     int len;
189     int i;
191     /* Combine function parameters and translation array into one contiguous
192      * message. TODO, modify driver to accept two separate buffers in order
193      * to eliminate this step. */
194     len = sizeof(struct rppc_function) +
195                 (ctx->num_xlts * sizeof(struct rppc_param_translation));
196     msg = (void *)calloc(len, sizeof(char));
198     if (msg == NULL) {
199         printf("MmRpc_call: Error: msg alloc failed\n");
200         status = MmRpc_E_FAIL;
201         goto leave;
202     }
204     /* copy function parameters into message */
205     rpfxn = (struct rppc_function *)msg;
206     rpfxn->fxn_id = ctx->fxn_id;
207     rpfxn->num_params = ctx->num_params;
209     for (i = 0; i < ctx->num_params; i++) {
210         param = &ctx->params[i];
212         switch (param->type) {
213             case MmRpc_ParamType_Scalar:
214                 rpfxn->params[i].type = RPPC_PARAM_TYPE_ATOMIC;
215                 rpfxn->params[i].size = param->param.scalar.size;
216                 rpfxn->params[i].data = param->param.scalar.data;
217                 rpfxn->params[i].base = 0;
218                 rpfxn->params[i].reserved = 0;
219                 break;
221             case MmRpc_ParamType_Ptr:
222                 rpfxn->params[i].type = RPPC_PARAM_TYPE_PTR;
223                 rpfxn->params[i].size = param->param.ptr.size;
224                 rpfxn->params[i].data = param->param.ptr.addr;
225                 rpfxn->params[i].base = param->param.ptr.addr;
226                 rpfxn->params[i].reserved = param->param.ptr.handle;
227                 break;
229 #if 0 /* TBD */
230             case MmRpc_ParamType_Elem:
231                 rpfxn->params[i].type = RPPC_PARAM_TYPE_PTR;
232                 rpfxn->params[i].size = param->param.elem.size;
233                 rpfxn->params[i].data = param->param.elem.offset;
234                 rpfxn->params[i].base = param->param.elem.base;
235                 rpfxn->params[i].reserved = param->param.elem.handle;
236                 break;
237 #endif
238             default:
239                 printf("MmRpc_call: Error: invalid parameter type\n");
240                 status = MmRpc_E_INVALIDPARAM;
241                 goto leave;
242                 break;
243         }
244     }
246     /* copy offset array into message */
247     rpfxn->num_translations = ctx->num_xlts;
249     for (i = 0; i < ctx->num_xlts; i++) {
250         rpfxn->translations[i].index    = ctx->xltAry[i].index;
251         rpfxn->translations[i].offset   = ctx->xltAry[i].offset;
252         rpfxn->translations[i].base     = ctx->xltAry[i].base;
253         rpfxn->translations[i].reserved = ctx->xltAry[i].handle;
254     }
256     /* send message for remote execution */
257     status = write(obj->fd, msg, len);
259     if (status < 0) {
260         printf("MmRpc_call: Error: write failed\n");
261         status = MmRpc_E_FAIL;
262         goto leave;
263     }
265     /* wait for return status from remote service */
266     status = read(obj->fd, &reply_msg, sizeof(struct rppc_function_return));
268     if (status < 0) {
269         printf("MmRpc_call: Error: read failed\n");
270         status = MmRpc_E_FAIL;
271         goto leave;
272     }
273     else if (status != sizeof(struct rppc_function_return)) {
274         printf("MmRpc_call: Error: reply bytes=%d, expected %d\n",
275                 status, sizeof(struct rppc_function_return));
276         status = MmRpc_E_FAIL;
277         goto leave;
278     }
279     else {
280         status = MmRpc_S_SUCCESS;
281     }
283     *ret = (int32_t)reply_msg.status;
285 leave:
286     if (msg != NULL) {
287         free(msg);
288     }
290     return(status);