gc/ogc/arqmgr.h

   1 /*-------------------------------------------------------------
   2
   3
   4 arqmgr.h -- ARAM task queue management
   5
   6 Copyright (C) 2004
   7 Michael Wiedenbauer (shagkur)
   8 Dave Murphy (WinterMute)
   9
  10 This software is provided 'as-is', without any express or implied
  11 warranty.  In no event will the authors be held liable for any
  12 damages arising from the use of this software.
  13
  14 Permission is granted to anyone to use this software for any
  15 purpose, including commercial applications, and to alter it and
  16 redistribute it freely, subject to the following restrictions:
  17
  18 1.      The origin of this software must not be misrepresented; you
  19 must not claim that you wrote the original software. If you use
  20 this software in a product, an acknowledgment in the product
  21 documentation would be appreciated but is not required.
  22
  23 2.      Altered source versions must be plainly marked as such, and
  24 must not be misrepresented as being the original software.
  25
  26 3.      This notice may not be removed or altered from any source
  27 distribution.
  28
  29
  30 -------------------------------------------------------------*/
  31
  32
  33 #ifndef __ARQMGR_H__
  34 #define __ARQMGR_H__
  35
  36
  37 /*!
  38  * \file arqmgr.h
  39  * \brief ARAM queue managemnt subsystem
  40  *
  41  */
  42
  43
  44 #include <gctypes.h>
  45
  46 #ifdef __cplusplus
  47    extern "C" {
  48 #endif /* __cplusplus */
  49
  50
  51 /*!
  52  * \typedef void (*ARQMCallback)()
  53  * \brief function pointer typedef for the user's callback when ARAM operation has completed
  54  * \param none
  55  */
  56 typedef void (*ARQMCallback)(s32 result);
  57
  58
  59 /*!
  60  * \fn void ARQM_Init(u32 arambase,s32 len)
  61  * \brief Initialize the ARAM queue management system
  62  *
  63  * \param[in] arambase ARAM startaddress to take for the queue stack
  64  * \param[in] len maximum amount of memory to be reserved from the ARAM for the queue management
  65  *
  66  * \return none
  67  */
  68 void ARQM_Init(u32 arambase,s32 len);
  69
  70
  71 /*!
  72  * \fn u32 ARQM_PushData(void *buff,s32 len)
  73  * \brief Push the data onto the ARAM queue
  74  *
  75  * \param[in] buff startaddress of buffer to be pushed onto the queue. <b><i>NOTE:</i></b> Must be 32-bytealigned.
  76  * \param[in] len length of data to be pushed onto the queue.
  77  *
  78  * \return none
  79  */
  80 u32 ARQM_PushData(void *buffer,s32 len);
  81
  82
  83 /*!
  84  * \fn u32 ARQM_GetZeroBuffer()
  85  * \brief Returns ARAM address of 'zero buffer'
  86  *
  87  * \return See description
  88  */
  89 u32 ARQM_GetZeroBuffer();
  90
  91
  92 /*!
  93  * \fn u32 ARQM_GetStackPointer()
  94  * \brief Return the ARAM address of the next free stack pointer
  95  *
  96  * \return See description
  97  */
  98 u32 ARQM_GetStackPointer();
  99
 100
 101 /*!
 102  * \fn u32 ARQM_GetFreeSize()
 103  * \brief Return Returns remaining number of bytes on stack
 104  *
 105  * \return See description
 106  */
 107 u32 ARQM_GetFreeSize();
 108
 109 #ifdef __cplusplus
 110    }
 111 #endif /* __cplusplus */
 112
 113 #endif