Fix doxygen comment (@Returns -> @return)

[ipc/ipcdev.git] / packages / ti / pm / IpcPower.h

diff --git a/packages/ti/pm/IpcPower.h b/packages/ti/pm/IpcPower.h
index bf3cd8553b903b21840a372393f1f430bf09f56d..97a8ad76814950ff5f0b0f012060e85c1a3a6435 100644 (file)
--- a/packages/ti/pm/IpcPower.h
+++ b/packages/ti/pm/IpcPower.h
@@ -78,6 +78,16 @@ typedef enum IpcPower_Event {
  */
 typedef Void (*IpcPower_CallbackFuncPtr)(Int event, Ptr data);
 
+/*!
+ *  @brief  Type representing OMAP's WUGEN_MEVT[0|1] registers
+ *
+ *  For APIs IpcPower_getWugenEvtMask() and IpcPower_setWugenEvtMask()
+ */
+typedef struct IpcPower_WugenEvtMask {
+    UInt32 mevt0;
+    UInt32 mevt1;
+} IpcPower_WugenEvtMask;
+
 /* =============================================================================
  *  IpcPower Functions:
  * =============================================================================
@@ -144,7 +154,7 @@ Bool IpcPower_canHibernate();
  *  @param[in]  fxn    Function being registered.
  *  @param[in]  data   Data to be passed as argument to function.
  *
- *  @Returns    Returns SUCCESS or FAIL
+ *  @return     SUCCESS or FAIL
  *
  *  @sa         IpcPower_registerCallback
  */
@@ -157,12 +167,35 @@ Int IpcPower_registerCallback(Int event, IpcPower_CallbackFuncPtr fxn,
  *  @param[in]  event  Power Management callback event type.
  *  @param[in]  fxn    Function being unregistered.
  *
- *  @Returns    Returns SUCCESS or FAIL
+ *  @return     SUCCESS or FAIL
  *
  *  @sa         IpcPower_unregisterCallback
  */
 Int IpcPower_unregisterCallback(Int event, IpcPower_CallbackFuncPtr fxn);
 
+/*!
+ *  @brief      Retrieve current WUGEN mask used for suspend
+ *
+ *  @param[in]  mask  Pointer to structure for holding WUGEN event mask
+ *
+ *  @sa         IpcPower_suspend, IpcPower_setWugenEvtMask
+ */
+Void IpcPower_getWugenEvtMask(IpcPower_WugenEvtMask *mask);
+
+/*!
+ *  @brief      Set WUGEN mask used for suspend
+ *
+ *  The values in the passed structure are copied into the internal
+ *  WUGEN event mask. To achieve an ORing of certain bits in the mask,
+ *  first retrieve the current mask with IpcPower_getWugenEvtMask() and
+ *  then OR in the bits you want to enable.
+ *
+ *  @param[in]  mask  Pointer to WUGEN event mask structure
+ *
+ *  @sa         IpcPower_suspend, IpcPower_getWugenEvtMask
+ */
+Void IpcPower_setWugenEvtMask(IpcPower_WugenEvtMask *mask);
+
 #if defined (__cplusplus)
 }
 #endif /* defined (__cplusplus) */