qnx/src/ipc3x_dev/ti/syslink/utils/GateMutex.h

   1 /**
   2  *  @file   GateMutex.h
   3  *
   4  *  @brief      Gate based on Mutex.
   5  *
   6  *
   7  */
   8 /*
   9  *  ============================================================================
  10  *
  11  *  Copyright (c) 2008-2012, Texas Instruments Incorporated
  12  *
  13  *  Redistribution and use in source and binary forms, with or without
  14  *  modification, are permitted provided that the following conditions
  15  *  are met:
  16  *
  17  *  *  Redistributions of source code must retain the above copyright
  18  *     notice, this list of conditions and the following disclaimer.
  19  *
  20  *  *  Redistributions in binary form must reproduce the above copyright
  21  *     notice, this list of conditions and the following disclaimer in the
  22  *     documentation and/or other materials provided with the distribution.
  23  *
  24  *  *  Neither the name of Texas Instruments Incorporated nor the names of
  25  *     its contributors may be used to endorse or promote products derived
  26  *     from this software without specific prior written permission.
  27  *
  28  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  29  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  30  *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  31  *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  32  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  33  *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  34  *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  35  *  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  36  *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  37  *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  38  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  39  *  Contact information for paper mail:
  40  *  Texas Instruments
  41  *  Post Office Box 655303
  42  *  Dallas, Texas 75265
  43  *  Contact information:
  44  *  http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm?
  45  *  DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact
  46  *  ============================================================================
  47  *
  48  */
  49
  50
  51
  52 #ifndef GATEMUTEX_H_0x72D0
  53 #define GATEMUTEX_H_0x72D0
  54
  55
  56 #if defined (__cplusplus)
  57 extern "C" {
  58 #endif
  59
  60
  61 /* =============================================================================
  62  *  Status codes
  63  * =============================================================================
  64  */
  65 /*!
  66  *  @def    GateMutex_E_INVALIDARG
  67  *  @brief  Argument passed to a function is invalid.
  68  */
  69 #define GateMutex_E_INVALIDARG       -1
  70
  71 /*!
  72  *  @def    GateMutex_E_MEMORY
  73  *  @brief  Memory allocation failed.
  74  */
  75 #define GateMutex_E_MEMORY           -2
  76
  77 /*!
  78  *  @def    GateMutex_E_BUSY
  79  *  @brief  The name is already registered or not.
  80  */
  81 #define GateMutex_E_BUSY             -3
  82
  83 /*!
  84  *  @def    GateMutex_E_FAIL
  85  *  @brief  Generic failure.
  86  */
  87 #define GateMutex_E_FAIL             -4
  88
  89 /*!
  90  *  @def    GateMutex_E_NOTFOUND
  91  *  @brief  Name not found in the nameserver.
  92  */
  93 #define GateMutex_E_NOTFOUND         -5
  94
  95 /*!
  96  *  @def    GateMutex_E_INVALIDSTATE
  97  *  @brief  Module is not initialized.
  98  */
  99 #define GateMutex_E_INVALIDSTATE     -6
 100
 101 /*!
 102  *  @def    GateMutex_E_INUSE
 103  *  @brief  Indicates that the instance is in use.
 104  */
 105 #define GateMutex_E_INUSE            -7
 106
 107 /*!
 108  *  @def    GateMutex_S_SUCCESS
 109  *  @brief  Operation successful.
 110  */
 111 #define GateMutex_S_SUCCESS          0
 112
 113
 114 /* =============================================================================
 115  *  Macros and types
 116  * =============================================================================
 117  */
 118 /*! @brief  Object for Gate Mutex */
 119 typedef struct GateMutex_Object GateMutex_Object;
 120
 121 /*! @brief  Handle for Gate Mutex */
 122 typedef struct GateMutex_Object * GateMutex_Handle;
 123
 124 /*! No parameters for GateMutex creation */
 125 typedef Void GateMutex_Params;
 126
 127 /* =============================================================================
 128  *  APIs
 129  * =============================================================================
 130  */
 131 /* Function to create a GateMutex */
 132 GateMutex_Handle
 133 GateMutex_create (const GateMutex_Params * params, Error_Block *eb);
 134
 135 /* Function to delete a Gate Mutex */
 136 Int GateMutex_delete (GateMutex_Handle * gmHandle);
 137
 138
 139 #if defined (__cplusplus)
 140 }
 141 #endif /* defined (__cplusplus) */
 142
 143 #endif /* GATEMUTEX_H_0x72D0 */