SDOCM00115428 Incorrect return status from NameServer_delete
[ipc/ipcdev.git] / linux / include / _lad.h
1 /*
2  * Copyright (c) 2012-2015 Texas Instruments Incorporated - http://www.ti.com
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  */
32 /*
33  *  ======== _lad.h ========
34  */
36 #ifndef _lad_
37 #define _lad_
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
43 #include <ti/ipc/MessageQ.h>
44 #include <_MessageQ.h>
45 #include <ti/ipc/NameServer.h>
46 #include <ti/ipc/MultiProc.h>
47 #include <_MultiProc.h>
48 #include <stdio.h>
49 #include <ti/ipc/GateMP.h>
50 #include <_GateMP.h>
51 #include <_Ipc.h>
52 #include <GateHWSpinlock.h>
53 #include <sys/time.h>
54 #include <ti/ipc/namesrv/_NameServerRemoteRpmsg.h>
56 extern Bool logFile;
57 extern FILE *logPtr;
58 extern struct timeval start_tv;
60 /*
61  * Macros for writing to log file.
62  *
63  * For the timestamp prefix, subtract the start time (which is established
64  * when the logFile is opened) so that the massive "since the epoch" value
65  * is not displayed.  For this, subtract only the timeval.tv_sec (seconds)
66  * value so we don't have to worry about the "borrow" that results when
67  * start_tv.tv_usec > tv.tv_usec.
68  */
69 #define LOG0(a)  \
70     if (logFile == TRUE) { \
71         struct timeval tv; \
72         gettimeofday(&tv, NULL); \
73         fprintf(logPtr, "[%d.%06d] " a, \
74                 (unsigned int)(tv.tv_sec - start_tv.tv_sec), \
75                 (unsigned int)tv.tv_usec); \
76         fflush(logPtr); \
77     }
79 #define LOG1(a, b)  \
80     if (logFile == TRUE) { \
81         struct timeval tv; \
82         gettimeofday(&tv, NULL); \
83         fprintf(logPtr, "[%d.%06d] " a, \
84                 (unsigned int)(tv.tv_sec - start_tv.tv_sec), \
85                 (unsigned int)tv.tv_usec, b); \
86         fflush(logPtr); \
87     }
89 #define LOG2(a, b, c)  \
90     if (logFile == TRUE) { \
91         struct timeval tv; \
92         gettimeofday(&tv, NULL); \
93         fprintf(logPtr, "[%d.%06d] " a, \
94                 (unsigned int)(tv.tv_sec - start_tv.tv_sec), \
95                 (unsigned int)tv.tv_usec, b, c); \
96         fflush(logPtr); \
97     }
99 #define LOG3(a, b, c, d)  \
100     if (logFile == TRUE) { \
101         struct timeval tv; \
102         gettimeofday(&tv, NULL); \
103         fprintf(logPtr, "[%d.%06d] " a, \
104                 (unsigned int)(tv.tv_sec - start_tv.tv_sec), \
105                 (unsigned int)tv.tv_usec, b, c, d); \
106         fflush(logPtr); \
107     }
109 /* macros for generating verbose output: */
110 #define PRINTVERBOSE0(a)  \
111     if (verbose == TRUE) {  printf(a); }
113 #define PRINTVERBOSE1(a, b)  \
114     if (verbose == TRUE) {  printf(a, b); }
116 #define PRINTVERBOSE2(a, b, c)  \
117     if (verbose == TRUE) {  printf(a, b, c); }
119 #define PRINTVERBOSE3(a, b, c, d)  \
120     if (verbose == TRUE) {  printf(a, b, c, d); }
123 /* LAD commmand FIFO strings: */
124 #if defined (IPC_BUILDOS_ANDROID)
125 #define LAD_COMMANDFIFO         "/data/lad/LAD/LADCMDS"
126 #define LAD_ROOTDIR             "/data/lad/"
127 #define LAD_WORKINGDIR          "/data/lad/LAD/"
128 #else
129 #define LAD_COMMANDFIFO         "/tmp/LAD/LADCMDS"
130 #define LAD_ROOTDIR             "/tmp/"
131 #define LAD_WORKINGDIR          "/tmp/LAD/"
132 #endif
134 #define LAD_RESPONSEFIFOPATH    LAD_WORKINGDIR
135 #define LAD_PROTOCOLVERSION     "03000000"    /*  MMSSRRRR */
137 #define LAD_MAXNUMCLIENTS  32      /* max simultaneous clients */
138 #define LAD_CONNECTTIMEOUT 5.0  /* LAD connect response timeout (sec) */
139 #define LAD_DISCONNECTTIMEOUT   5.0  /* LAD disconnect timeout (sec) */
140 #define LAD_MAXLENGTHFIFONAME   128  /* max length client FIFO name */
141 #define LAD_MAXLENGTHCOMMAND    512  /* size limit for LAD command string */
142 #define LAD_MAXLENGTHRESPONSE   512  /* size limit for LAD response string */
143 #define LAD_MAXLENGTHPROTOVERS  16   /* size limit for protocol version */
144 #define LAD_MAXLOGFILEPATH 256  /* size limit for LAD log file path */
145 #define LAD_COMMANDLENGTH       sizeof(struct LAD_CommandObj)
146 #define LAD_RESPONSELENGTH      sizeof(union LAD_ResponseObj)
148 #define LAD_MESSAGEQCREATEMAXNAMELEN 32
150 #define LAD_MAXENTRYNAMELEN  MAXNAMEINCHAR /* max for LAD NameServer name */
151 #define LAD_MAXENTRYVALUELEN 32  /* size limit for LAD NameServer value */
153 typedef enum {
154     LAD_CONNECT = 0,
155     LAD_DISCONNECT,
156     LAD_IPC_GETCONFIG,
157     LAD_NAMESERVER_SETUP,
158     LAD_NAMESERVER_DESTROY,
159     LAD_NAMESERVER_PARAMS_INIT,
160     LAD_NAMESERVER_CREATE,
161     LAD_NAMESERVER_DELETE,
162     LAD_NAMESERVER_ADD,
163     LAD_NAMESERVER_GET,
164     LAD_NAMESERVER_ADDUINT32,
165     LAD_NAMESERVER_GETUINT32,
166     LAD_NAMESERVER_GETLOCAL,
167     LAD_NAMESERVER_GETLOCALUINT32,
168     LAD_NAMESERVER_REMOVE,
169     LAD_NAMESERVER_REMOVEENTRY,
170     LAD_NAMESERVER_ATTACH,
171     LAD_NAMESERVER_DETACH,
172     LAD_MESSAGEQ_GETCONFIG,
173     LAD_MESSAGEQ_SETUP,
174     LAD_MESSAGEQ_DESTROY,
175     LAD_MESSAGEQ_CREATE,
176     LAD_MESSAGEQ_DELETE,
177     LAD_MESSAGEQ_MSGINIT,
178     LAD_MULTIPROC_GETCONFIG,
179     LAD_GATEMP_START,
180     LAD_GATEMP_GETNUMRESOURCES,
181     LAD_GATEMP_GETFREERESOURCE,
182     LAD_GATEMP_RELEASERESOURCE,
183     LAD_GATEMP_ISSETUP,
184     LAD_GATEHWSPINLOCK_GETCONFIG,
185     LAD_EXIT
186 } _LAD_Command;
188 struct LAD_CommandObj {
189     Int cmd;
190     Int clientId;
191     union {
192         struct {
193             Int pid;
194             Char name[LAD_MAXLENGTHFIFONAME];
195             Char protocol[LAD_MAXLENGTHPROTOVERS];
196         } connect;
197         struct {
198             Char name[LAD_MAXENTRYNAMELEN];
199             NameServer_Params params;
200         } create;
201         struct {
202             NameServer_Handle handle;
203         } nsdelete;
204         struct {
205             NameServer_Handle handle;
206             Char name[LAD_MAXENTRYNAMELEN];
207             UInt8 buf[LAD_MAXENTRYVALUELEN];
208             UInt32 len;
209         } add;
210         struct {
211             NameServer_Handle handle;
212             Char name[LAD_MAXENTRYNAMELEN];
213             UInt32 len;
214             UInt16 procId[MultiProc_MAXPROCESSORS];
215         } get;
216         struct {
217             NameServer_Handle handle;
218             Char name[LAD_MAXENTRYNAMELEN];
219             UInt32 val;
220         } addUInt32;
221         struct {
222             NameServer_Handle handle;
223             Char name[LAD_MAXENTRYNAMELEN];
224             UInt16 procId[MultiProc_MAXPROCESSORS];
225         } getUInt32;
226         struct {
227             NameServer_Handle handle;
228             Char name[LAD_MAXENTRYNAMELEN];
229             UInt32 len;
230         } getLocal;
231         struct {
232             NameServer_Handle handle;
233             Char name[LAD_MAXENTRYNAMELEN];
234         } getLocalUInt32;
235         struct {
236             NameServer_Handle handle;
237             Char name[LAD_MAXENTRYNAMELEN];
238         } remove;
239         struct {
240             NameServer_Handle handle;
241             Ptr entryPtr;
242         } removeEntry;
243         struct {
244             UInt16 procId;
245         } attach;
246         struct {
247             UInt16 procId;
248         } detach;
249         struct {
250             MessageQ_Config cfg;
251         } messageQSetup;
252         struct {
253             Char name[LAD_MESSAGEQCREATEMAXNAMELEN];
254             MessageQ_Params params;
255         } messageQCreate;
256         struct {
257             Void *serverHandle;
258         } messageQDelete;
259         struct {
260             GateMP_RemoteProtect type;
261         } gateMPGetNumResources;
262         struct {
263             GateMP_RemoteProtect type;
264         } gateMPGetFreeResource;
265         struct {
266             GateMP_RemoteProtect type;
267             Int32 id;
268         } gateMPReleaseResource;
269         struct {
270             Bool result;
271         } gateMPIsSetup;
272     } args;
273 };
275 union LAD_ResponseObj {
276     struct {
277        Int status;
278        UInt32 len;
279        UInt8 buf[LAD_MAXENTRYVALUELEN];
280     } get;
281     struct {
282        Int status;
283        UInt32 val;
284     } getUInt32;
285     struct {
286        Int status;
287        Int assignedId;
288     } connect;
289     struct {
290        Int status;
291        NameServer_Handle handle;
292     } nsdelete;
293     struct {
294        Int status;
295        NameServer_Handle nameServerHandle;
296     } setup;
297     struct {
298        Int status;
299        Int queueId;
300        Void *serverHandle;
301     } messageQCreate;
302     struct {
303        Int status;
304     } messageQDelete;
305     struct {
306        Int status;
307        MessageQ_MsgHeader msg;
308     } msgInit;
309     struct {
310        Int status;
311        MessageQ_Config cfg;
312     } messageQGetConfig;
313     struct {
314        Int status;
315        MultiProc_Config cfg;
316     } multiprocGetConfig;
317     struct {
318        Int status;
319        NameServer_Handle nameServerHandle;
320     } gateMPStart;
321     struct {
322        Int status;
323        Int32 value;
324     } gateMPGetNumResources;
325     struct {
326        Int status;
327        Int32 id;
328     } gateMPGetFreeResource;
329     struct {
330        Int status;
331     } gateMPReleaseResource;
332     struct {
333        Int status;
334        Bool result;
335     } gateMPIsSetup;
336     struct {
337        Int status;
338        GateHWSpinlock_Config cfgParams;
339     } gateHWSpinlockGetConfig;
340     Ipc_Config ipcConfig;
341     NameServer_Params params;
342     NameServer_Handle handle;
343     Ptr entryPtr;
344     Int status;
345 };
348 #ifdef __cplusplus
350 #endif
352 #endif