SDOCM00114354 IPC Manager needs a public header file
[ipc/ipcdev.git] / packages / ti / ipc / ipcmgr / IpcMgr.c
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  *  ======== IpcMgr.c ========
34  *  Various IPC stack backplane startup fxns.
35  */
37 #include <xdc/std.h>
38 #include <xdc/runtime/Assert.h>
40 #include <ti/ipc/Ipc.h>
41 #include <ti/ipc/MultiProc.h>
42 #include <ti/ipc/namesrv/NameServerRemoteRpmsg.h>
43 #include <ti/ipc/transports/TransportRpmsgSetup.h>
44 #include <ti/ipc/rpmsg/_RPMessage.h>
46 #ifdef IpcMgr_USEDEH
47 #include <ti/deh/Watchdog.h>
48 #ifdef DSP
49 #include <ti/sysbios/family/c64p/Exception.h>
50 #elif IPU
51 #include <ti/sysbios/family/arm/m3/Hwi.h>
52 #endif
53 #endif
55 #include "IpcMgr.h"
58 /*
59  *  ======== IpcMgr_rpmsgStartup ========
60  *  Initialize the RPMSG module. This calls VirtQueue_startup().
61  *
62  *  Use for stacks built on RPMessage only.
63  */
64 Void IpcMgr_rpmsgStartup(Void)
65 {
66     Assert_isTrue(MultiProc_self() != MultiProc_getId("HOST"), NULL);
67     RPMessage_init(MultiProc_getId("HOST"));
69 #ifdef IpcMgr_USEDEH
70     /*
71      * When using DEH, initialize the Watchdog timers if not already done
72      * (i.e. late-attach)
73      */
74 #ifdef DSP
75     Watchdog_init((Void (*)(Void))ti_sysbios_family_c64p_Exception_handler);
76 #elif IPU
77     Watchdog_init(ti_sysbios_family_arm_m3_Hwi_excHandlerAsm__I);
78 #endif
79 #endif
80 }
82 /*
83  *  ======== IpcMgr_ipcStartup ========
84  *  Initialize MessageQ Transport stack built over RPMSG.
85  *  This ends up calling RPMessage_init().
86  *
87  *  Use for stacks built on MessageQ/TransportRpmsg only.
88  */
89 Void IpcMgr_ipcStartup(Void)
90 {
91     UInt procId = MultiProc_getId("HOST");
92     Int status;
94     /* TransportRpmsgSetup will busy wait until host kicks ready to recv: */
95     status = TransportRpmsgSetup_attach(procId, 0);
96     Assert_isTrue(status >= 0, NULL);
98     /* Sets up to communicate with host's NameServer: */
99     status = NameServerRemoteRpmsg_attach(procId, 0);
100     Assert_isTrue(status >= 0, NULL);
102 #ifdef IpcMgr_USEDEH
103     /*
104      * When using DEH, initialize the Watchdog timers if not already done
105      * (i.e. late-attach)
106      */
107 #ifdef DSP
108     Watchdog_init((Void (*)(Void))ti_sysbios_family_c64p_Exception_handler);
109 #elif IPU
110     Watchdog_init(ti_sysbios_family_arm_m3_Hwi_excHandlerAsm__I);
111 #endif
112 #endif
115 /*
116  *  ======== IpcMgr_callIpcStart ========
117  *  Initialize standard IPC module, which may use the RPMSG protocol as well.
118  *
119  *  Calls the Ipc_start command.  This must be done after IpcMgr_ipcStartup().
120  *
121  *  Use for stacks using a combination of TransportRpmsg and other Transports.
122  */
123 Void IpcMgr_callIpcStart()
125     Int status;
127     /*
128      *  Ipc_start() calls Ipc_attach() to synchronize all remote processors
129      *  if 'Ipc.procSync' is set to 'Ipc.ProcSync_ALL' in *.cfg
130      *  HOST is skipped, thanks to overriding NotifySetup_numIntLines().
131      */
132     status = Ipc_start();
133     Assert_isTrue(status >= 0, NULL);