Merge remote-tracking branch 'origin/3.23' into ipc-3.30-next
[ipc/ipcdev.git] / linux / src / api / Ipc.c
1 /*
2  * Copyright (c) 2012-2014, 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  */
40 /* Standard headers */
41 #include <stdio.h>
42 #include <stdlib.h>
43 #include <signal.h>
45 /* Common IPC headers: */
46 #include <ti/ipc/Std.h>
47 #include <ti/ipc/Ipc.h>
48 #include <ti/ipc/NameServer.h>
50 /* User side headers */
51 #include <ladclient.h>
53 /* IPC startup/shutdown stuff: */
54 #include <ti/ipc/MultiProc.h>
55 #include <GateHWSpinlock.h>
56 #include <_GateMP.h>
57 #include <_MultiProc.h>
58 #include <_MessageQ.h>
59 #include <_NameServer.h>
61 GateHWSpinlock_Config _GateHWSpinlock_cfgParams;
63 static LAD_ClientHandle ladHandle;
65 static void cleanup(int arg);
67 /** ============================================================================
68  *  Functions
69  *  ============================================================================
70  */
71 /* Function to start Ipc */
72 Int Ipc_start (Void)
73 {
74     MessageQ_Config        msgqCfg;
75     MultiProc_Config       mpCfg;
76 #if defined(GATEMP_SUPPORT)
77     GateHWSpinlock_Config  gateHWCfg;
78 #endif
79     Int32                  status;
80     LAD_Status             ladStatus;
81     UInt16                 rprocId;
82     Int32                  attachedAny = 0;
84     /* Catch ctrl-C, and cleanup: */
85     (void) signal(SIGINT, cleanup);
87     if (getenv("IPC_DEBUG") != NULL) {
88         /* turn on tracing */
89         if (getenv("IPC_DEBUG")[0] == '1') {
90             /* level 1 enables typical user API tracing */
91             _MessageQ_verbose = TRUE;
92             _MultiProc_verbose = TRUE;
93             _NameServer_verbose = TRUE;
94 #if defined(GATEMP_SUPPORT)
95             _GateMP_verbose = TRUE;
97             _GateHWSpinlock_verbose = TRUE;
98 #endif
99         }
100         else if ((getenv("IPC_DEBUG")[0] == '2') ||
101                 (getenv("IPC_DEBUG")[0] == '3')) {
102             /* levels 2 and 3 add socket and LAD client tracing */
103             _MessageQ_verbose = TRUE;
104             _MultiProc_verbose = TRUE;
105             _NameServer_verbose = TRUE;
107 #if defined(GATEMP_SUPPORT)
108             _GateMP_verbose = TRUE;
110             _GateHWSpinlock_verbose = TRUE;
111 #endif
113             /* internals - should be declared in respective _*.h files */
114             extern Bool _SocketFxns_verbose;
115             extern Bool _LAD_Client_verbose;
117             _SocketFxns_verbose = TRUE;
118             _LAD_Client_verbose = TRUE;
119         }
120     }
122     ladStatus = LAD_connect(&ladHandle);
123     if (ladStatus != LAD_SUCCESS) {
124         printf("Ipc_start: LAD_connect() failed: %d\n", ladStatus);
125         status = Ipc_E_FAIL;
126         goto exit;
127     }
129     /*
130      * Get MultiProc configuration from LAD and initialize local MultiProc
131      * config structure.
132      */
133     MultiProc_getConfig(&mpCfg);
134     _MultiProc_initCfg(&mpCfg);
136     status = NameServer_setup();
137     if (status >= 0) {
138         MessageQ_getConfig(&msgqCfg);
139         MessageQ_setup(&msgqCfg);
141         /* Now attach to all remote processors, assuming they are up. */
142         for (rprocId = 0; rprocId < MultiProc_getNumProcessors(); rprocId++) {
143             if (0 == rprocId) {
144                 /* Skip host, which should always be 0th entry. */
145                 continue;
146             }
147             status = MessageQ_attach(rprocId, NULL);
148             if (status == MessageQ_E_RESOURCE) {
149                 continue;
150             }
151             if (status < 0) {
152                 printf("Ipc_start: MessageQ_attach(%d) failed: %d\n",
153                        rprocId, status);
154                 status = Ipc_E_FAIL;
156                 break;
157             }
158             else {
159                 attachedAny = 1;
160             }
161         }
162         if (attachedAny) {
163             status = Ipc_S_SUCCESS;
164         }
165     }
166     else {
167         printf("Ipc_start: NameServer_setup() failed: %d\n", status);
168         status = Ipc_E_FAIL;
169     }
171     /* Start GateMP only if device has support */
172 #if defined(GATEMP_SUPPORT)
173     if (GateMP_isSetup()) {
174         /*
175          * Get HWSpinlock base address and size from LAD and
176          * initialize the local config structure.
177          */
178         GateHWSpinlock_getConfig(&gateHWCfg);
179         _GateHWSpinlock_cfgParams = gateHWCfg;
181         status = GateHWSpinlock_start();
182         if (status < 0) {
183             printf("Ipc_start: GateHWSpinlock_start failed: %d\n",
184                 status);
185             status = Ipc_E_FAIL;
186             goto gatehwspinlockstart_fail;
187         }
188         else {
189             status = GateMP_start();
190             if (status < 0) {
191                 printf("Ipc_start: GateMP_start failed: %d\n",
192                 status);
193                 status = Ipc_E_FAIL;
194                 goto gatempstart_fail;
195             }
196         }
197     }
198 #endif
199     /* Success */
200     goto exit;
201 #if defined(GATEMP_SUPPORT)
202 gatempstart_fail:
203     GateHWSpinlock_stop();
204 gatehwspinlockstart_fail:
205     for (rprocId = rprocId - 1; (rprocId > 0) && (status >= 0); rprocId--) {
206         MessageQ_detach(rprocId);
207     }
208 #endif
210 exit:
211     return (status);
215 /* Function to stop Ipc */
216 Int Ipc_stop (Void)
218     Int32             status = Ipc_S_SUCCESS;
219     LAD_Status        ladStatus;
220     UInt16            rprocId;
222     /* Now detach from all remote processors, assuming they are up. */
223     for (rprocId = 0;
224          (rprocId < MultiProc_getNumProcessors()) && (status >= 0);
225          rprocId++) {
226         if (0 == rprocId) {
227           /* Skip host, which should always be 0th entry. */
228           continue;
229         }
230         status = MessageQ_detach(rprocId);
231         if (status < 0) {
232             printf("Ipc_stop: MessageQ_detach(%d) failed: %d\n",
233                 rprocId, status);
234             status = Ipc_E_FAIL;
235             goto exit;
236        }
237     }
239     status = MessageQ_destroy();
240     if (status < 0) {
241         printf("Ipc_stop: MessageQ_destroy() failed: %d\n", status);
242         status = Ipc_E_FAIL;
243         goto exit;
244     }
246     status = NameServer_destroy();
247     if (status < 0) {
248         printf("Ipc_stop: NameServer_destroy() failed: %d\n", status);
249         status = Ipc_E_FAIL;
250         goto exit;
251     }
253     ladStatus = LAD_disconnect(ladHandle);
254     if (ladStatus != LAD_SUCCESS) {
255         printf("LAD_disconnect() failed: %d\n", ladStatus);
256         status = Ipc_E_FAIL;
257         goto exit;
258     }
260 exit:
261     return (status);
264 static void cleanup(int arg)
266     printf("Ipc: Caught SIGINT, calling Ipc_stop...\n");
267     Ipc_stop();
268     exit(0);