ASoC: samsung: i2s: Document clocks macros

Document clocks macros with their description
from 'Documentation/devicetree/bindings/sound/samsung-i2s.txt'

Signed-off-by: Maciej Falkowski <m.falkowski@samsung.com>
Signed-off-by: Marek Szyprowski <m.szyprowski@samsung.com>
Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>
Link: https://lore.kernel.org/r/20190926110219.6144-1-m.szyprowski@samsung.com
Signed-off-by: Mark Brown <broonie@kernel.org>

diff --git a/include/dt-bindings/sound/samsung-i2s.h b/include/dt-bindings/sound/samsung-i2s.h
index 77545f14c379ad02e88d35cafe7709232f7132cc..250de0d6c7345a848f635d8b2fabdad9aa563361 100644 (file)
--- a/include/dt-bindings/sound/samsung-i2s.h
+++ b/include/dt-bindings/sound/samsung-i2s.h
@@ -2,8 +2,14 @@
 #ifndef _DT_BINDINGS_SAMSUNG_I2S_H
 #define _DT_BINDINGS_SAMSUNG_I2S_H
 
-#define CLK_I2S_CDCLK          0
-#define CLK_I2S_RCLK_SRC       1
-#define CLK_I2S_RCLK_PSR       2
+#define CLK_I2S_CDCLK          0 /* the CDCLK (CODECLKO) gate clock */
+
+#define CLK_I2S_RCLK_SRC       1 /* the RCLKSRC mux clock (corresponding to
+                                  * RCLKSRC bit in IISMOD register)
+                                  */
+
+#define CLK_I2S_RCLK_PSR       2 /* the RCLK prescaler divider clock
+                                  * (corresponding to the IISPSR register)
+                                  */
 
 #endif /* _DT_BINDINGS_SAMSUNG_I2S_H */