Browse Source

ARM: imx: Add comments to tzic_enable_waker()

Add additional comments to the tzic_enable_wake() funciton to
clarify its intended usage.

Signed-off-by: Robert Lee <rob.lee@linaro.org>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Robert Lee 13 years ago
parent
commit
eee4f40038
1 changed files with 4 additions and 0 deletions
  1. 4 0
      arch/arm/plat-mxc/tzic.c

+ 4 - 0
arch/arm/plat-mxc/tzic.c

@@ -190,6 +190,10 @@ void __init tzic_init_irq(void __iomem *irqbase)
  * tzic_enable_wake() - enable wakeup interrupt
  *
  * @return			0 if successful; non-zero otherwise
+ *
+ * This function provides an interrupt synchronization point that is required
+ * by tzic enabled platforms before entering imx specific low power modes (ie,
+ * those low power modes beyond the WAIT_CLOCKED basic ARM WFI only mode).
  */
 int tzic_enable_wake(void)
 {