gc/ogc/cond.h

   1 /*-------------------------------------------------------------
   2
   3 cond.h -- Thread subsystem V
   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 __COND_H__
  32 #define __COND_H__
  33
  34 /*! \file cond.h
  35 \brief Thread subsystem V
  36
  37 */
  38
  39 #include <gctypes.h>
  40 #include <time.h>
  41
  42 #define LWP_COND_NULL           0xffffffff
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48
  49 /*! \typedef u32 cond_t
  50 \brief typedef for the condition variable handle
  51 */
  52 typedef u32 cond_t;
  53
  54
  55 /*! \fn s32 LWP_CondInit(cond_t *cond)
  56 \brief Initialize condition variable
  57 \param[out] cond pointer to the cond_t handle
  58
  59 \return 0 on success, <0 on error
  60 */
  61 s32 LWP_CondInit(cond_t *cond);
  62
  63
  64 /*! \fn s32 LWP_CondWait(cond_t cond,mutex_t mutex)
  65 \brief Wait on condition variable.
  66 \param[in] cond handle to the cond_t structure
  67 \param[in] mutex handle to the mutex_t structure
  68
  69 \return 0 on success, <0 on error
  70 */
  71 s32 LWP_CondWait(cond_t cond,mutex_t mutex);
  72
  73
  74 /*! \fn s32 LWP_CondSignal(cond_t cond)
  75 \brief Signal a specific thread waiting on this condition variable to wake up.
  76 \param[in] cond handle to the cond_t structure
  77
  78 \return 0 on success, <0 on error
  79 */
  80 s32 LWP_CondSignal(cond_t cond);
  81
  82
  83 /*! \fn s32 LWP_CondBroadcast(cond_t cond)
  84 \brief Broadcast all threads waiting on this condition variable to wake up.
  85 \param[in] cond handle to the cond_t structure
  86
  87 \return 0 on success, <0 on error
  88 */
  89 s32 LWP_CondBroadcast(cond_t cond);
  90
  91
  92 /*! \fn s32 LWP_CondTimedWait(cond_t cond,mutex_t mutex,const struct timespec *abstime)
  93 \brief Timed wait on a conditionvariable.
  94 \param[in] cond handle to the cond_t structure
  95 \param[in] mutex handle to the mutex_t structure
  96 \param[in] abstime pointer to a timespec structure holding the abs time for the timeout.
  97
  98 \return 0 on success, <0 on error
  99 */
 100 s32 LWP_CondTimedWait(cond_t cond,mutex_t mutex,const struct timespec *abstime);
 101
 102
 103 /*! \fn s32 LWP_CondDestroy(cond_t cond)
 104 \brief Destroy condition variable, release all threads and handles blocked on that condition variable.
 105 \param[in] cond handle to the cond_t structure
 106
 107 \return 0 on success, <0 on error
 108 */
 109 s32 LWP_CondDestroy(cond_t cond);
 110
 111 #ifdef __cplusplus
 112         }
 113 #endif
 114
 115 #endif