61989b8af794a3815b4715a5d85221434b7cf825
[ipc/ipcdev.git] / qnx / src / api / Ipc.c
1 /*
2  * Copyright (c) 2013-2015, 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  */
32 /*!
33  *  @file       Ipc.c
34  *
35  *  @brief      Starts and stops user side Ipc
36  *              All setup/destroy APIs on user side will be call from this
37  *              module.
38  *
39  *  @ver        0002
40  *
41  */
43 /* Standard headers */
44 #include <stdio.h>
45 #include <stdlib.h>
46 #include <signal.h>
47 #include <ti/ipc/Std.h>
49 /* Common IPC headers: */
50 #include <ti/ipc/Ipc.h>
51 #include <ti/ipc/NameServer.h>
53 /* User side headers */
54 #include <ti/syslink/inc/usr/Qnx/IpcDrv.h>
56 /* IPC startup/shutdown stuff: */
57 #include <ti/ipc/MultiProc.h>
58 #include <ti/ipc/MessageQ.h>
59 #include <ti/ipc/NameServer.h>
60 #include <_MessageQ.h>
61 #include <_NameServer.h>
62 #include <_GateMP.h>
63 #include <_GateMP_usr.h>
64 #include <_TiIpcFxns.h>
65 #include <ti/syslink/inc/_GateHWSpinlock.h>
66 #include <ti/syslink/inc/_MultiProc.h>
68 MultiProc_Config _MultiProc_cfg;
71 static void cleanup(int arg);
73 /** ============================================================================
74  *  Functions
75  *  ============================================================================
76  */
77 /* Function to start Ipc */
78 Int Ipc_start (Void)
79 {
80     MessageQ_Config   msgqCfg;
81     MultiProc_Config  mpCfg;
82     Int32             status = Ipc_S_SUCCESS;
83     UInt16            rprocId;
85     /* Catch ctrl-C, and cleanup: */
86     (void) signal(SIGINT, cleanup);
88     if (getenv("IPC_DEBUG") != NULL) {
89         /* turn on tracing */
90         if (getenv("IPC_DEBUG")[0] == '1') {
91             /* level 1 enables typical user API tracing */
92             _MessageQ_verbose = TRUE;
93             _MultiProc_verbose = TRUE;
94             _NameServer_verbose = TRUE;
95 #if defined(GATEMP_SUPPORT)
96             _GateMP_verbose = TRUE;
98             _GateHWSpinlock_verbose = TRUE;
99 #endif
100         }
101         else if ((getenv("IPC_DEBUG")[0] == '2') ||
102                 (getenv("IPC_DEBUG")[0] == '3')) {
103             /* levels 2 and 3 add TiIpcFxns tracing */
104             _MessageQ_verbose = TRUE;
105             _MultiProc_verbose = TRUE;
106             _NameServer_verbose = TRUE;
108 #if defined(GATEMP_SUPPORT)
109             _GateMP_verbose = TRUE;
111             _GateHWSpinlock_verbose = TRUE;
112 #endif
114             _TiIpcFxns_verbose = TRUE;
115         }
116     }
118     status = IpcDrv_open();
119     if (status < 0) {
120         printf("Ipc_start: IpcDrv_open() failed: %d\n", status);
121         status = Ipc_E_FAIL;
122         goto exit;
123     }
125     status = NameServer_setup();
126     if (status >= 0) {
127         MessageQ_getConfig(&msgqCfg);
128         MessageQ_setup(&msgqCfg);
130         /* Setup and get MultiProc configuration from resource manager */
131         MultiProc_getConfig(&mpCfg);
132         _MultiProc_cfg = mpCfg;
134         /* Now attach to all remote processors, assuming they are up. */
135         for (rprocId = 0;
136              (rprocId < MultiProc_getNumProcessors()) && (status >= 0);
137              rprocId++) {
138            if (0 == rprocId) {
139                /* Skip host, which should always be 0th entry. */
140                continue;
141            }
142            status = MessageQ_attach (rprocId, NULL);
143            if (status < 0) {
144               printf("Ipc_start: MessageQ_attach(%d) failed: %d\n",
145                      rprocId, status);
146               status = Ipc_E_FAIL;
147               goto messageqattach_fail;
148            }
149         }
150     }
151     else {
152         printf("Ipc_start: NameServer_setup() failed: %d\n", status);
153         status = Ipc_E_FAIL;
154         goto nameserversetup_fail;
155     }
157     /* Start GateMP only if it is setup in the resource manager */
158 #if defined(GATEMP_SUPPORT)
159     if (GateMP_isSetup()) {
160         /* Get GateHWSpinlock configuration from resource manager */
161         status = GateHWSpinlock_start();
162         if (status < 0) {
163             printf("Ipc_start: GateHWSpinlock_start failed: %d\n",
164                 status);
165             status = Ipc_E_FAIL;
166             goto gatehwspinlockstart_fail;
167         }
168         else {
169             status = GateMP_start();
170             if (status < 0) {
171                 printf("Ipc_start: GateMP_start failed: %d\n",
172                 status);
173                 status = Ipc_E_FAIL;
174                 goto gatempstart_fail;
175             }
176         }
177     }
178 #endif
179     /* Success */
180     goto exit;
181 #if defined(GATEMP_SUPPORT)
182 gatempstart_fail:
183     GateHWSpinlock_stop();
184 gatehwspinlockstart_fail:
185     for (rprocId = rprocId - 1; (rprocId > 0) && (status >= 0); rprocId--) {
186        MessageQ_detach(rprocId);
187     }
188 #endif
189 messageqattach_fail:
190     MessageQ_destroy();
191     NameServer_destroy();
192 nameserversetup_fail:
193     IpcDrv_close();
195 exit:
196     return (status);
200 /* Function to stop Ipc */
201 Int Ipc_stop (Void)
203     Int32             status = Ipc_S_SUCCESS;
204     UInt16            rprocId;
205 #if defined(GATEMP_SUPPORT)
206     if (GateMP_isSetup()) {
207         /* Stop GateMP */
208         status = GateMP_stop();
209         if (status < 0) {
210             printf("Ipc_stop: GateMP_stop() failed: %d\n", status);
211             status = Ipc_E_FAIL;
212             goto exit;
213         }
215         /* Finalize GateHWSpinlock */
216         status = GateHWSpinlock_stop();
217         if (status < 0) {
218             printf("Ipc_stop: GateHWSpinlock_stop() failed: %d\n", status);
219             status = Ipc_E_FAIL;
220             goto exit;
221         }
222     }
223 #endif
224     /* Now detach from all remote processors, assuming they are up. */
225     for (rprocId = 0;
226          (rprocId < MultiProc_getNumProcessors()) && (status >= 0);
227          rprocId++) {
228        if (0 == rprocId) {
229           /* Skip host, which should always be 0th entry. */
230           continue;
231        }
232        status = MessageQ_detach(rprocId);
233        if (status < 0) {
234             printf("Ipc_stop: MessageQ_detach(%d) failed: %d\n",
235                  rprocId, status);
236             status = Ipc_E_FAIL;
237             goto exit;
238        }
239     }
241     status = MessageQ_destroy();
242     if (status < 0) {
243         printf("Ipc_stop: MessageQ_destroy() failed: %d\n", status);
244         status = Ipc_E_FAIL;
245         goto exit;
246     }
248     status = NameServer_destroy();
249     if (status < 0) {
250         printf("Ipc_stop: NameServer_destroy() failed: %d\n", status);
251         status = Ipc_E_FAIL;
252         goto exit;
253     }
255     IpcDrv_close();
257 exit:
258     return (status);
261 static void cleanup(int arg)
263     printf("Ipc: Caught SIGINT, calling Ipc_stop...\n");
264     Ipc_stop();
265     exit(0);