IpcMgr: Commented usage of various IPC startup functions.
authorG Anthony <a0783926@ti.com>
Fri, 1 Mar 2013 00:25:52 +0000 (16:25 -0800)
committerG Anthony <a0783926@ti.com>
Fri, 1 Mar 2013 00:25:52 +0000 (16:25 -0800)
Three startup functions need to be configured for IPC apps using RPMSG.
These have been better documented.

Signed-off-by: G Anthony <a0783926@ti.com>
packages/ti/ipc/ipcmgr/IpcMgr.c

index 381aae39c6c1f7af1a483581b1eb435d3cafb77b..b2b66281f00e7e68423697f52c096d2350bd4cca 100644 (file)
@@ -46,6 +46,8 @@
 /*
  *  ======== IpcMgr_rpmsgStartup ========
  *  Initialize the RPMSG module.  This calls VirtQueue_startup().
+ *
+ *  Use for stacks built on RPMessage only.
  */
 Void IpcMgr_rpmsgStartup()
 {
@@ -56,6 +58,9 @@ Void IpcMgr_rpmsgStartup()
 /*
  *  ======== IpcMgr_ipcStartup ========
  *  Initialize MessageQ Transport stack built over RPMSG.
+ *  This ends up calling MessageQCopy_init().
+ *
+ *  Use for stacks built on MessageQ/TransportRpmsg only.
  */
 Void IpcMgr_ipcStartup()
 {
@@ -75,8 +80,9 @@ Void IpcMgr_ipcStartup()
  *  ======== IpcMgr_callIpcStart ========
  *  Initialize standard IPC module, which may use the RPMSG protocol as well.
  *
- *  Calls the Ipc_start command.  This must be done
- *  after IpcMgr_ipcStartup().
+ *  Calls the Ipc_start command.  This must be done after IpcMgr_ipcStartup().
+ *
+ *  Use for stacks using a combination of TransportRpmsg and other Transports.
  */
 Void IpcMgr_callIpcStart()
 {