gc/ogc/mutex.h

   1 /*-------------------------------------------------------------
   2
   3 mutex.h -- Thread subsystem III
   4
   5 Copyright (C) 2004
   6 Michael Wiedenbauer (shagkur)
   7 Dave Murphy (WinterMute)
   8
   9 This software is provided 'as-is', without any express or implied
  10 warranty.  In no event will the authors be held liable for any
  11 damages arising from the use of this software.
  12
  13 Permission is granted to anyone to use this software for any
  14 purpose, including commercial applications, and to alter it and
  15 redistribute it freely, subject to the following restrictions:
  16
  17 1.      The origin of this software must not be misrepresented; you
  18 must not claim that you wrote the original software. If you use
  19 this software in a product, an acknowledgment in the product
  20 documentation would be appreciated but is not required.
  21
  22 2.      Altered source versions must be plainly marked as such, and
  23 must not be misrepresented as being the original software.
  24
  25 3.      This notice may not be removed or altered from any source
  26 distribution.
  27
  28 -------------------------------------------------------------*/
  29
  30
  31 #ifndef __MUTEX_H__
  32 #define __MUTEX_H__
  33
  34 /*! \file mutex.h
  35 \brief Thread subsystem III
  36
  37 */
  38
  39 #include <gctypes.h>
  40
  41 #define LWP_MUTEX_NULL          0xffffffff
  42
  43 #ifdef __cplusplus
  44         extern "C" {
  45 #endif
  46
  47
  48 /*! \typedef u32 mutex_t
  49 \brief typedef for the mutex handle
  50 */
  51 typedef u32 mutex_t;
  52
  53
  54 /*! \fn s32 LWP_MutexInit(mutex_t *mutex,boolean use_recursive)
  55 \brief Initializes a mutex lock.
  56 \param[out] mutex pointer to a mutex_t handle.
  57 \param[in] use_recursive whether to allow the thread, whithin the same context, to enter multiple times the lock or not.
  58
  59 \return 0 on success, <0 on error
  60 */
  61 s32 LWP_MutexInit(mutex_t *mutex,boolean use_recursive);
  62
  63
  64 /*! \fn s32 LWP_MutexDestroy(mutex_t mutex)
  65 \brief Close mutex lock, release all threads and handles locked on this mutex.
  66 \param[in] mutex handle to the mutex_t structure.
  67
  68 \return 0 on success, <0 on error
  69 */
  70 s32 LWP_MutexDestroy(mutex_t mutex);
  71
  72
  73 /*! \fn s32 LWP_MutexLock(mutex_t mutex)
  74 \brief Enter the mutex lock.
  75 \param[in] mutex handle to the mutext_t structure.
  76
  77 \return 0 on success, <0 on error
  78 */
  79 s32 LWP_MutexLock(mutex_t mutex);
  80
  81
  82 /*! \fn s32 LWP_MutexTryLock(mutex_t mutex)
  83 \brief Try to enter the mutex lock.
  84 \param[in] mutex handle to the mutex_t structure.
  85
  86 \return 0: on first aquire, 1: would lock
  87 */
  88 s32 LWP_MutexTryLock(mutex_t mutex);
  89
  90
  91 /*! \fn s32 LWP_MutexUnlock(mutex_t mutex)
  92 \brief Release the mutex lock and let other threads process further on this mutex.
  93 \param[in] mutex handle to the mutex_t structure.
  94
  95 \return 0 on success, <0 on error
  96 */
  97 s32 LWP_MutexUnlock(mutex_t mutex);
  98
  99 #ifdef __cplusplus
 100         }
 101 #endif
 102
 103 #endif