packages/ti/ipc/mm/MmServiceMgr.h

   1 /*
   2  * Copyright (c) 2013-2014, 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 /**
  34  *  @file       ti/ipc/mm/MmServiceMgr.h
  35  *
  36  *  @brief      Multi-Media Service Manager
  37  *
  38  *  @note       MmServiceMgr is currently only available for SYS/BIOS, when
  39  *              providing services for an MmRpc client on Linux or QNX.
  40  *
  41  */
  42
  43 #ifndef ti_ipc_mm_MmServiceMgr__include
  44 #define ti_ipc_mm_MmServiceMgr__include
  45
  46 #include <ti/grcm/RcmServer.h>
  47 #include <ti/ipc/mm/MmType.h>
  48 #include <ti/srvmgr/omaprpc/OmapRpc.h>
  49
  50 #if defined (__cplusplus)
  51 extern "C" {
  52 #endif
  53
  54 /*!
  55  *  @brief  Operation is successful
  56  */
  57 #define MmServiceMgr_S_SUCCESS (0)
  58
  59 /*!
  60  *  @brief  Operation failed
  61  */
  62 #define MmServiceMgr_E_FAIL (-1)
  63
  64 typedef Void (*MmServiceMgr_DelFxn)(Void);
  65
  66 /*!
  67  *  @brief      Initialize the MmServiceMgr module
  68  *
  69  */
  70 Int MmServiceMgr_init(Void);
  71
  72 /*!
  73  *  @brief      Finalize the MmServiceMgr module
  74  *
  75  */
  76 Void MmServiceMgr_exit(Void);
  77
  78 /*!
  79  *  @brief      Register a new service
  80  *
  81  */
  82 Int MmServiceMgr_register(const String name, RcmServer_Params *params,
  83         MmType_FxnSigTab *fxnSigTab, MmServiceMgr_DelFxn delFxn);
  84
  85 /*! @cond */
  86 /*!
  87  *  @brief      Start the service manager listener task
  88  *
  89  */
  90 Int MmServiceMgr_start(const String name, Int aryLen,
  91         OmapRpc_FuncSignature *sigAry);
  92 /*! @endcond */
  93
  94 /*!
  95  *  @brief      Get the ID of the current service instance
  96  *              This function can only be called in the context of skeleton
  97  *              functions or service deletion function registered for
  98  *              a service.
  99  *
 100  */
 101 UInt32 MmServiceMgr_getId();
 102
 103 #if defined (__cplusplus)
 104 }
 105 #endif
 106 #endif /* ti_ipc_mm_MmServiceMgr__include */