SDOCM00114354 IPC Manager needs a public header file
[ipc/ipcdev.git] / packages / ti / ipc / ipcmgr / IpcMgr.h
1 /*
2  * Copyright (c) 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  *  @file       ti/ipc/ipcmgr/IpcMgr.h
34  *
35  *  @brief      Ipc Manager
36  *
37  *  This header file should be included as follows:
38  *  @code
39  *  #include <ti/ipc/ipcmgr/IpcMgr.h>
40  *  @endcode
41  */
43 #ifndef ti_ipc_ipcmgr_IpcMgr__include
44 #define ti_ipc_ipcmgr_IpcMgr__include
46 #if defined (__cplusplus)
47 extern "C" {
48 #endif
50 /* =============================================================================
51  *  Ipc Module-wide Functions
52  * =============================================================================
53  */
55 /*!
56  *  @brief      Initialize the RPMessage module
57  *
58  *  Use for stacks built on RPMessage.
59  */
60 Void IpcMgr_rpmsgStartup(Void);
62 /*!
63  *  @brief      Initialize MessageQ transport stack built over RPMessage
64  *
65  *  Use for stacks built on MessageQ/TransportRpmsg.
66  */
67 Void IpcMgr_ipcStartup(Void);
70 #if defined (__cplusplus)
71 }
72 #endif /* defined (__cplusplus) */
74 #endif /* ti_ipc_ipcmgr_IpcMgr__include */