Linux: Quiet "unused variable" build warning
[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  *
39  *  @ver        0002
40  *
41  */
43 /* Standard headers */
44 #include <stdio.h>
45 #include <stdlib.h>
46 #include <signal.h>
48 /* Common IPC headers: */
49 #include <ti/ipc/Std.h>
50 #include <ti/ipc/Ipc.h>
51 #include <ti/ipc/NameServer.h>
53 /* User side headers */
54 #include <ladclient.h>
56 /* IPC startup/shutdown stuff: */
57 #include <ti/ipc/MultiProc.h>
58 #include <GateHWSpinlock.h>
59 #include <_GateMP.h>
60 #include <_MultiProc.h>
61 #include <_MessageQ.h>
62 #include <_NameServer.h>
64 GateHWSpinlock_Config _GateHWSpinlock_cfgParams;
66 static LAD_ClientHandle ladHandle;
68 static void cleanup(int arg);
70 /** ============================================================================
71  *  Functions
72  *  ============================================================================
73  */
74 /* Function to start Ipc */
75 Int Ipc_start (Void)
76 {
77     MessageQ_Config        msgqCfg;
78     MultiProc_Config       mpCfg;
79 #if defined(GATEMP_SUPPORT)
80     GateHWSpinlock_Config  gateHWCfg;
81 #endif
82     Int32                  status;
83     LAD_Status             ladStatus;
84     UInt16                 rprocId;
85     Int32                  attachedAny = 0;
87     /* Catch ctrl-C, and cleanup: */
88     (void) signal(SIGINT, cleanup);
90     ladStatus = LAD_connect(&ladHandle);
91     if (ladStatus != LAD_SUCCESS) {
92         printf("Ipc_start: LAD_connect() failed: %d\n", ladStatus);
93         status = Ipc_E_FAIL;
94         goto exit;
95     }
97     /*
98      * Get MultiProc configuration from LAD and initialize local MultiProc
99      * config structure.
100      */
101     MultiProc_getConfig(&mpCfg);
102     _MultiProc_initCfg(&mpCfg);
104     status = NameServer_setup();
105     if (status >= 0) {
106         MessageQ_getConfig(&msgqCfg);
107         MessageQ_setup(&msgqCfg);
109         /* Now attach to all remote processors, assuming they are up. */
110         for (rprocId = 0; rprocId < MultiProc_getNumProcessors(); rprocId++) {
111             if (0 == rprocId) {
112                 /* Skip host, which should always be 0th entry. */
113                 continue;
114             }
115             status = MessageQ_attach(rprocId, NULL);
116             if (status == MessageQ_E_RESOURCE) {
117                 continue;
118             }
119             if (status < 0) {
120                 printf("Ipc_start: MessageQ_attach(%d) failed: %d\n",
121                        rprocId, status);
122                 status = Ipc_E_FAIL;
124                 break;
125             }
126             else {
127                 attachedAny = 1;
128             }
129         }
130         if (attachedAny) {
131             status = Ipc_S_SUCCESS;
132         }
133     }
134     else {
135         printf("Ipc_start: NameServer_setup() failed: %d\n", status);
136         status = Ipc_E_FAIL;
137     }
139     /* Start GateMP only if device has support */
140 #if defined(GATEMP_SUPPORT)
141     if (GateMP_isSetup()) {
142         /*
143          * Get HWSpinlock base address and size from LAD and
144          * initialize the local config structure.
145          */
146         GateHWSpinlock_getConfig(&gateHWCfg);
147         _GateHWSpinlock_cfgParams = gateHWCfg;
149         status = GateHWSpinlock_start();
150         if (status < 0) {
151             printf("Ipc_start: GateHWSpinlock_start failed: %d\n",
152                 status);
153             status = Ipc_E_FAIL;
154             goto gatehwspinlockstart_fail;
155         }
156         else {
157             status = GateMP_start();
158             if (status < 0) {
159                 printf("Ipc_start: GateMP_start failed: %d\n",
160                 status);
161                 status = Ipc_E_FAIL;
162                 goto gatempstart_fail;
163             }
164         }
165     }
166 #endif
167     /* Success */
168     goto exit;
169 #if defined(GATEMP_SUPPORT)
170 gatempstart_fail:
171     GateHWSpinlock_stop();
172 gatehwspinlockstart_fail:
173     for (rprocId = rprocId - 1; (rprocId > 0) && (status >= 0); rprocId--) {
174         MessageQ_detach(rprocId);
175     }
176 #endif
178 exit:
179     return (status);
183 /* Function to stop Ipc */
184 Int Ipc_stop (Void)
186     Int32             status = Ipc_S_SUCCESS;
187     LAD_Status        ladStatus;
188     UInt16            rprocId;
190     /* Now detach from all remote processors, assuming they are up. */
191     for (rprocId = 0;
192          (rprocId < MultiProc_getNumProcessors()) && (status >= 0);
193          rprocId++) {
194         if (0 == rprocId) {
195           /* Skip host, which should always be 0th entry. */
196           continue;
197         }
198         status = MessageQ_detach(rprocId);
199         if (status < 0) {
200             printf("Ipc_stop: MessageQ_detach(%d) failed: %d\n",
201                 rprocId, status);
202             status = Ipc_E_FAIL;
203             goto exit;
204        }
205     }
207     status = MessageQ_destroy();
208     if (status < 0) {
209         printf("Ipc_stop: MessageQ_destroy() failed: %d\n", status);
210         status = Ipc_E_FAIL;
211         goto exit;
212     }
214     status = NameServer_destroy();
215     if (status < 0) {
216         printf("Ipc_stop: NameServer_destroy() failed: %d\n", status);
217         status = Ipc_E_FAIL;
218         goto exit;
219     }
221     ladStatus = LAD_disconnect(ladHandle);
222     if (ladStatus != LAD_SUCCESS) {
223         printf("LAD_disconnect() failed: %d\n", ladStatus);
224         status = Ipc_E_FAIL;
225         goto exit;
226     }
228 exit:
229     return (status);
232 static void cleanup(int arg)
234     printf("Ipc: Caught SIGINT, calling Ipc_stop...\n");
235     Ipc_stop();
236     exit(0);