SDOCM00114354 IPC Manager needs a public header file
authorRamsey Harris <ramsey@ti.com>
Wed, 25 Feb 2015 18:33:21 +0000 (10:33 -0800)
committerRobert Tivy <rtivy@ti.com>
Wed, 25 Feb 2015 22:52:28 +0000 (14:52 -0800)
Added header file IpcMgr.h. The module is meta-only, so there is
no generated header file which might collide with this one. Added
two functions typically called by the application: rpmsgStartup,
and ipcStartup. Omitted callIpcStart because this is only used from
config script, not application source file.

packages/ti/ipc/ipcmgr/IpcMgr.c
packages/ti/ipc/ipcmgr/IpcMgr.h [new file with mode: 0644]

index 12976d5cacd88213f454591ac5c2f6be81063954..bfa9253de0cc3e731912030d77a0320a70fffd80 100644 (file)
@@ -1,5 +1,5 @@
 /*
 /*
- * Copyright (c) 2012-2014, Texas Instruments Incorporated
+ * Copyright (c) 2012-2015 Texas Instruments Incorporated - http://www.ti.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
 #endif
 #endif
 
 #endif
 #endif
 
+#include "IpcMgr.h"
+
+
 /*
  *  ======== IpcMgr_rpmsgStartup ========
 /*
  *  ======== IpcMgr_rpmsgStartup ========
- *  Initialize the RPMSG module.  This calls VirtQueue_startup().
+ *  Initialize the RPMSG module. This calls VirtQueue_startup().
  *
  *  Use for stacks built on RPMessage only.
  */
  *
  *  Use for stacks built on RPMessage only.
  */
-Void IpcMgr_rpmsgStartup()
+Void IpcMgr_rpmsgStartup(Void)
 {
     Assert_isTrue(MultiProc_self() != MultiProc_getId("HOST"), NULL);
     RPMessage_init(MultiProc_getId("HOST"));
 {
     Assert_isTrue(MultiProc_self() != MultiProc_getId("HOST"), NULL);
     RPMessage_init(MultiProc_getId("HOST"));
@@ -83,7 +86,7 @@ Void IpcMgr_rpmsgStartup()
  *
  *  Use for stacks built on MessageQ/TransportRpmsg only.
  */
  *
  *  Use for stacks built on MessageQ/TransportRpmsg only.
  */
-Void IpcMgr_ipcStartup()
+Void IpcMgr_ipcStartup(Void)
 {
     UInt procId = MultiProc_getId("HOST");
     Int status;
 {
     UInt procId = MultiProc_getId("HOST");
     Int status;
diff --git a/packages/ti/ipc/ipcmgr/IpcMgr.h b/packages/ti/ipc/ipcmgr/IpcMgr.h
new file mode 100644 (file)
index 0000000..2e45eff
--- /dev/null
@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2015 Texas Instruments Incorporated - http://www.ti.com
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * *  Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * *  Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * *  Neither the name of Texas Instruments Incorporated nor the names of
+ *    its contributors may be used to endorse or promote products derived
+ *    from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+ * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+ * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+ * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+/**
+ *  @file       ti/ipc/ipcmgr/IpcMgr.h
+ *
+ *  @brief      Ipc Manager
+ *
+ *  This header file should be included as follows:
+ *  @code
+ *  #include <ti/ipc/ipcmgr/IpcMgr.h>
+ *  @endcode
+ */
+
+#ifndef ti_ipc_ipcmgr_IpcMgr__include
+#define ti_ipc_ipcmgr_IpcMgr__include
+
+#if defined (__cplusplus)
+extern "C" {
+#endif
+
+/* =============================================================================
+ *  Ipc Module-wide Functions
+ * =============================================================================
+ */
+
+/*!
+ *  @brief      Initialize the RPMessage module
+ *
+ *  Use for stacks built on RPMessage.
+ */
+Void IpcMgr_rpmsgStartup(Void);
+
+/*!
+ *  @brief      Initialize MessageQ transport stack built over RPMessage
+ *
+ *  Use for stacks built on MessageQ/TransportRpmsg.
+ */
+Void IpcMgr_ipcStartup(Void);
+
+
+#if defined (__cplusplus)
+}
+#endif /* defined (__cplusplus) */
+
+#endif /* ti_ipc_ipcmgr_IpcMgr__include */