qnx/src/ipc3x_dev/ti/syslink/inc/_GateMP_daemon.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  *  ======== _GateMP_daemon.h ========
  35  *
  36  *  Internal header
  37  *
  38  */
  39
  40 #ifndef _GATEMP_DAEMON_H
  41 #define _GATEMP_DAEMON_H
  42
  43 #include <ti/ipc/GateMP.h>
  44 #include <ti/ipc/NameServer.h>
  45
  46 #if defined (__cplusplus)
  47 extern "C" {
  48 #endif
  49
  50 /*!
  51  * Setup the GateMP module. Return the procId of SR0 owner.
  52  */
  53 Int GateMP_setup(Int32 * sr0ProcId);
  54
  55 /*!
  56  * Function to destroy the GateMP module. If forced is set
  57  * we terminate the module regardless of whether there
  58  * are processes that are using GateMP on the host.
  59  */
  60 Int GateMP_destroy(Bool forced);
  61
  62 /*!
  63  * Find a free resource id for a particular protection type.
  64  */
  65 Int GateMP_getFreeResource(GateMP_RemoteProtect type);
  66
  67 /*!
  68  * Release a resource id for a particular protection type.
  69  */
  70 Int GateMP_releaseResource(UInt id, GateMP_RemoteProtect type);
  71
  72 /*!
  73  * Get the total number of resources for a particular protection type.
  74  */
  75 Int GateMP_getNumResources(GateMP_RemoteProtect type);
  76
  77 /*!
  78  * Get the NameServer handle for GateMP.
  79  */
  80 NameServer_Handle GateMP_getNameServer(Void);
  81
  82 /*!
  83  * Find out whether GateMP is setup
  84  */
  85 Bool GateMP_isSetup(Void);
  86
  87 #if defined (__cplusplus)
  88 }
  89 #endif /* defined (__cplusplus) */
  90
  91 #endif /* _GATEMP_DAEMONH */