More minor coding convention fixes
[ipc/ipcdev.git] / packages / ti / ipc / MessageQ.h
index 4a6623d2f7a856f44452d29850b9659956f51b5a..9b23f1a0389266b8a69bbd813f284ff619a8f218 100644 (file)
  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-/** ============================================================================
- *  @file       MessageQ.h
+/**
+ *  @file       ti/ipc/MessageQ.h
  *
  *  @brief      MessageQ Manager
  *
  *  The MessageQ module supports the structured sending and receiving of
  *  variable length messages. This module can be used for homogeneous
- *  (DSP to DSP)  or heterogeneous (Arm to DSP) multi-processor messaging.
+ *  (e.g. DSP to DSP) or heterogeneous (e.g. ARM to DSP) multi-processor
+ *  messaging.
  *
  *  MessageQ provides more sophisticated messaging than other modules. It is
  *  typically used for complex situations such as multi-processor messaging.
  *
  *  MessageQ supports reads/writes of different thread models. This is
  *  accomplished by having the creator of the message queue specify a
- *  synchronizer via the #MessageQ_Params::synchronizer
+ *  synchronizer via the #MessageQ_Params.synchronizer
  *  configuration parameter. The synchronizer is signaled whenever the
  *  MessageQ_put() is called. The synchronizer waits if MessageQ_get() is called
  *  and there are no messages.
  *
  *  Since ISyncs are binary, the reader must drain the message queue of all
  *  messages before waiting for another signal. For example, if the reader
- *  was a SYSBIOS Swi, the synchronizer instance could be a SyncSwi.
- *  If a #MessageQ_put was called, the Swi_post() would
- *  be called. The Swi would run and it must call #MessageQ_get until no
+ *  was a SYS/BIOS Swi, the synchronizer instance could be a SyncSwi.
+ *  If a MessageQ_put() was called, the Swi_post() would
+ *  be called. The Swi would run and it must call MessageQ_get() until no
  *  messages are returned.
  *
  *  The MessageQ header should be included in an application as follows:
  *  @code
  *  #include <ti/ipc/MessageQ.h>
  *  @endcode
- *
- *  @version        0.00.01
- *
- *  ============================================================================
  */
 
 #ifndef ti_ipc_MessageQ__include
@@ -150,112 +147,112 @@ extern "C" {
 /*!
  *  @brief  The resource is still in use
  */
-#define MessageQ_S_BUSY                  2
+#define MessageQ_S_BUSY                  (2)
 
 /*!
  *  @brief  The module has been already setup
  */
-#define MessageQ_S_ALREADYSETUP          1
+#define MessageQ_S_ALREADYSETUP          (1)
 
 /*!
  *  @brief  Operation is successful.
  */
-#define MessageQ_S_SUCCESS               0
+#define MessageQ_S_SUCCESS               (0)
 
 /*!
  *  @brief  Operation is not successful.
  */
-#define MessageQ_E_FAIL                 -1
+#define MessageQ_E_FAIL                 (-1)
 
 /*!
  *  @brief  There is an invalid argument.
  */
-#define MessageQ_E_INVALIDARG           -2
+#define MessageQ_E_INVALIDARG           (-2)
 
 /*!
  *  @brief  Operation resulted in memory failure.
  */
-#define MessageQ_E_MEMORY               -3
+#define MessageQ_E_MEMORY               (-3)
 
 /*!
  *  @brief  The specified entity already exists.
  */
-#define MessageQ_E_ALREADYEXISTS        -4
+#define MessageQ_E_ALREADYEXISTS        (-4)
 
 /*!
  *  @brief  Unable to find the specified entity.
  */
-#define MessageQ_E_NOTFOUND             -5
+#define MessageQ_E_NOTFOUND             (-5)
 
 /*!
  *  @brief  Operation timed out.
  */
-#define MessageQ_E_TIMEOUT              -6
+#define MessageQ_E_TIMEOUT              (-6)
 
 /*!
  *  @brief  Module is not initialized.
  */
-#define MessageQ_E_INVALIDSTATE         -7
+#define MessageQ_E_INVALIDSTATE         (-7)
 
 /*!
  *  @brief  A failure occurred in an OS-specific call
  */
-#define MessageQ_E_OSFAILURE            -8
+#define MessageQ_E_OSFAILURE            (-8)
 
 /*!
  *  @brief  Specified resource is not available
  */
-#define MessageQ_E_RESOURCE             -9
+#define MessageQ_E_RESOURCE             (-9)
 
 /*!
  *  @brief  Operation was interrupted. Please restart the operation
  */
-#define MessageQ_E_RESTART              -10
+#define MessageQ_E_RESTART              (-10)
 
 /*!
  *  @brief  An invalid message was encountered
  */
-#define MessageQ_E_INVALIDMSG           -11
+#define MessageQ_E_INVALIDMSG           (-11)
 
 /*!
  *  @brief  Not the owner
  */
-#define MessageQ_E_NOTOWNER             -12
+#define MessageQ_E_NOTOWNER             (-12)
 
 /*!
  *  @brief  Operation resulted in error
  */
-#define MessageQ_E_REMOTEACTIVE         -13
+#define MessageQ_E_REMOTEACTIVE         (-13)
 
 /*!
  *  @brief  An invalid heap id was encountered
  */
-#define MessageQ_E_INVALIDHEAPID        -14
+#define MessageQ_E_INVALIDHEAPID        (-14)
 
 /*!
  *  @brief  An invalid MultiProc id was encountered
  */
-#define MessageQ_E_INVALIDPROCID        -15
+#define MessageQ_E_INVALIDPROCID        (-15)
 
 /*!
  *  @brief  The max has been reached.
  */
-#define MessageQ_E_MAXREACHED           -16
+#define MessageQ_E_MAXREACHED           (-16)
 
 /*!
  *  @brief  Attempting to use an unregistered heap id.
  */
-#define MessageQ_E_UNREGISTEREDHEAPID   -17
+#define MessageQ_E_UNREGISTEREDHEAPID   (-17)
 
 /*!
  *  @brief  Trying to free a statically initialized message
  */
-#define MessageQ_E_CANNOTFREESTATICMSG  -18
+#define MessageQ_E_CANNOTFREESTATICMSG  (-18)
 
 /*!
  *  @brief  MessageQ was unblocked
  */
-#define MessageQ_E_UNBLOCKED            -19
+#define MessageQ_E_UNBLOCKED            (-19)
 
 /* =============================================================================
  *  Macros
@@ -265,22 +262,22 @@ extern "C" {
 /*!
  *  @brief      Used as the timeout value to specify wait forever
  */
-#define MessageQ_FOREVER                ~(0)
+#define MessageQ_FOREVER                (~(0))
 
 /*!
  *  @brief      Invalid message id
  */
-#define MessageQ_INVALIDMSGID           0xffff
+#define MessageQ_INVALIDMSGID           (0xffff)
 
 /*!
  *  @brief      Invalid message queue
  */
-#define MessageQ_INVALIDMESSAGEQ        0xffff
+#define MessageQ_INVALIDMESSAGEQ        (0xffff)
 
 /*!
  *  @brief      Mask to extract priority setting
  */
-#define MessageQ_PRIORITYMASK           0x3
+#define MessageQ_PRIORITYMASK           (0x3)
 
 /*!
  *  @brief      Extract the destination queue ID from a message.
@@ -356,7 +353,7 @@ extern "C" {
  *  into the message with the MessageQ_setReplyQueue() function. The receiver of
  *  the message can extract the message queue ID with this function.
  *
- *  This method is particularing useful in a client/server relationship where
+ *  This method is particularly useful in a client/server relationship where
  *  the server does not want to know who the clients are. The clients can embed
  *  their message queue into the message to the server and the server extracts
  *  it and uses it to reply.
@@ -457,7 +454,7 @@ typedef MessageQ_MsgHeader *MessageQ_Msg;
 typedef enum {
     MessageQ_NORMALPRI      = 0,    /*!< Normal Priority                  */
     MessageQ_HIGHPRI        = 1,    /*!< High Priority                    */
-    MessageQ_RESERVEDPRI    = 2,    /*!< Reserved Priorit                 */
+    MessageQ_RESERVEDPRI    = 2,    /*!< Reserved Priority                 */
     MessageQ_URGENTPRI      = 3     /*!< Urgent Priority                  */
 } MessageQ_Priority;
 
@@ -710,7 +707,7 @@ Int MessageQ_get(MessageQ_Handle handle, MessageQ_Msg *msg, UInt timeout);
  *  - MessageQ_getDstQueue()
  *
  *  After the message is placed onto the final destination, the queue's
- *  #MessageQ_Params::synchronizer signal function is called.
+ *  #MessageQ_Params.synchronizer signal function is called.
  *
  *  The application loses ownership of the message once MessageQ_put() is called.
  *