diff mbox

[4/5] ARM: MCPM: add references to the available documentation in the code

Message ID 1430496392-15956-5-git-send-email-nicolas.pitre@linaro.org
State Accepted
Commit 1c2c7d51c8101ab3c5d8585713d2dcd52d77d33e
Headers show

Commit Message

Nicolas Pitre May 1, 2015, 4:06 p.m. UTC
Signed-off-by: Nicolas Pitre <nico@linaro.org>
---
 arch/arm/common/mcpm_entry.c | 5 +++++
 1 file changed, 5 insertions(+)
diff mbox

Patch

diff --git a/arch/arm/common/mcpm_entry.c b/arch/arm/common/mcpm_entry.c
index c5fe2e33e6..492467587c 100644
--- a/arch/arm/common/mcpm_entry.c
+++ b/arch/arm/common/mcpm_entry.c
@@ -20,6 +20,11 @@ 
 #include <asm/cputype.h>
 #include <asm/suspend.h>
 
+/*
+ * The public API for this code is documented in arch/arm/include/asm/mcpm.h.
+ * For a comprehensive description of the main algorithm used here, please
+ * see Documentation/arm/cluster-pm-race-avoidance.txt.
+ */
 
 struct sync_struct mcpm_sync;