gc/ogc/message.h

   1 /*-------------------------------------------------------------
   2
   3 message.h -- Thread subsystem II
   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 __MESSAGE_H__
  32 #define __MESSAGE_H__
  33
  34 /*! \file message.h
  35 \brief Thread subsystem II
  36
  37 */
  38
  39 #include <gctypes.h>
  40
  41 #define MQ_BOX_NULL                             0xffffffff
  42
  43 #define MQ_ERROR_SUCCESSFUL             0
  44 #define MQ_ERROR_TOOMANY                -5
  45
  46 #define MQ_MSG_BLOCK                    0
  47 #define MQ_MSG_NOBLOCK                  1
  48
  49
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53
  54
  55 /*! \typedef u32 mqbox_t
  56 \brief typedef for the message queue handle
  57 */
  58 typedef u32 mqbox_t;
  59
  60
  61 /*! \typedef void* mqmsg_t
  62 \brief typedef for the message pointer
  63 */
  64 typedef void* mqmsg_t;
  65
  66
  67
  68 /*! \fn u32 MQ_Init(mqbox_t *mqbox,u32 count)
  69 \brief Initializes a message queue
  70 \param[out] mqbox pointer to the mqbox_t handle.
  71 \param[in] count maximum number of messages the queue can hold
  72
  73 \return 0 on success, <0 on error
  74 */
  75 s32 MQ_Init(mqbox_t *mqbox,u32 count);
  76
  77
  78 /*! \fn void MQ_Close(mqbox_t mqbox)
  79 \brief Closes the message queue and releases all memory.
  80 \param[in] mqbox handle to the mqbox_t structure.
  81
  82 \return none
  83 */
  84 void MQ_Close(mqbox_t mqbox);
  85
  86
  87 /*! \fn BOOL MQ_Send(mqbox_t mqbox,mqmsg_t msg,u32 flags)
  88 \brief Sends a message to the given message queue.
  89 \param[in] mqbox mqbox_t handle to the message queue
  90 \param[in] msg message to send
  91 \param[in] flags message flags (MQ_MSG_BLOCK, MQ_MSG_NOBLOCK)
  92
  93 \return bool result
  94 */
  95 BOOL MQ_Send(mqbox_t mqbox,mqmsg_t msg,u32 flags);
  96
  97
  98 /*! \fn BOOL MQ_Jam(mqbox_t mqbox,mqmsg_t msg,u32 flags)
  99 \brief Sends a message to the given message queue and jams it in front of the queue.
 100 \param[in] mqbox mqbox_t handle to the message queue
 101 \param[in] msg message to send
 102 \param[in] flags message flags (MQ_MSG_BLOCK, MQ_MSG_NOBLOCK)
 103
 104 \return bool result
 105 */
 106 BOOL MQ_Jam(mqbox_t mqbox,mqmsg_t msg,u32 flags);
 107
 108
 109 /*! \fn BOOL MQ_Receive(mqbox_t mqbox,mqmsg_t *msg,u32 flags)
 110 \brief Sends a message to the given message queue.
 111 \param[in] mqbox mqbox_t handle to the message queue
 112 \param[in] msg pointer to a mqmsg_t_t-type message to receive.
 113 \param[in] flags message flags (MQ_MSG_BLOCK, MQ_MSG_NOBLOCK)
 114
 115 \return bool result
 116 */
 117 BOOL MQ_Receive(mqbox_t mqbox,mqmsg_t *msg,u32 flags);
 118
 119 #ifdef __cplusplus
 120         }
 121 #endif
 122
 123 #endif