packages/ti/ipc/ipcmgr/IpcMgr.c

   1 /*
   2  * Copyright (c) 2012-2013, 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  *  ======== IpcMgr.c ========
  34  *  Various IPC stack backplane startup fxns.
  35  */
  36
  37 #include <xdc/std.h>
  38 #include <xdc/runtime/Assert.h>
  39
  40 #include <ti/ipc/Ipc.h>
  41 #include <ti/ipc/MultiProc.h>
  42 #include <ti/ipc/namesrv/NameServerRemoteRpmsg.h>
  43 #include <ti/ipc/transports/TransportVirtioSetup.h>
  44 #include <ti/ipc/rpmsg/_MessageQCopy.h>
  45
  46 /*
  47  *  ======== IpcMgr_rpmsgStartup ========
  48  *  Initialize the RPMSG module.  This calls VirtQueue_startup().
  49  *
  50  *  Use for stacks built on RPMessage only.
  51  */
  52 Void IpcMgr_rpmsgStartup()
  53 {
  54     Assert_isTrue(MultiProc_self() != MultiProc_getId("HOST"), NULL);
  55     MessageQCopy_init(MultiProc_getId("HOST"));
  56 }
  57
  58 /*
  59  *  ======== IpcMgr_ipcStartup ========
  60  *  Initialize MessageQ Transport stack built over RPMSG.
  61  *  This ends up calling MessageQCopy_init().
  62  *
  63  *  Use for stacks built on MessageQ/TransportRpmsg only.
  64  */
  65 Void IpcMgr_ipcStartup()
  66 {
  67     UInt procId = MultiProc_getId("HOST");
  68     Int status;
  69
  70     /* TransportVirtioSetup will busy wait until host kicks ready to recv: */
  71     status = TransportVirtioSetup_attach(procId, 0);
  72     Assert_isTrue(status >= 0, NULL);
  73
  74     /* Sets up to comminicate with host's NameServer: */
  75     status = NameServerRemoteRpmsg_attach(procId, 0);
  76     Assert_isTrue(status >= 0, NULL);
  77 }
  78
  79 /*
  80  *  ======== IpcMgr_callIpcStart ========
  81  *  Initialize standard IPC module, which may use the RPMSG protocol as well.
  82  *
  83  *  Calls the Ipc_start command.  This must be done after IpcMgr_ipcStartup().
  84  *
  85  *  Use for stacks using a combination of TransportRpmsg and other Transports.
  86  */
  87 Void IpcMgr_callIpcStart()
  88 {
  89     Int status;
  90
  91     /*
  92      *  Ipc_start() calls Ipc_attach() to synchronize all remote processors
  93      *  if 'Ipc.procSync' is set to 'Ipc.ProcSync_ALL' in *.cfg
  94      *  HOST is skipped, thanks to overriding NotifySetup_numIntLines().
  95      */
  96     status = Ipc_start();
  97     Assert_isTrue(status >= 0, NULL);
  98 }