[v2] ASoC: samsung: i2s: Document clocks macros

Message ID 20190926110219.6144-1-m.szyprowski@samsung.com
State New
Headers show
Series
  • [v2] ASoC: samsung: i2s: Document clocks macros
Related show

Commit Message

Marek Szyprowski Sept. 26, 2019, 11:02 a.m.
From: Maciej Falkowski <m.falkowski@samsung.com>


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>

---
v2:
- Added proper commit message and description
- Moved comments to the right side

Best regards,
Maciej Falkowski
---
 include/dt-bindings/sound/samsung-i2s.h | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

-- 
2.17.1

Comments

Rob Herring Oct. 10, 2019, 9:51 p.m. | #1
On Thu, 26 Sep 2019 13:02:19 +0200, Marek Szyprowski wrote:
> From: Maciej Falkowski <m.falkowski@samsung.com>

> 

> 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>

> ---

> v2:

> - Added proper commit message and description

> - Moved comments to the right side

> 

> Best regards,

> Maciej Falkowski

> ---

>  include/dt-bindings/sound/samsung-i2s.h | 12 +++++++++---

>  1 file changed, 9 insertions(+), 3 deletions(-)

> 


Applied, thanks.

Rob

Patch

diff --git a/include/dt-bindings/sound/samsung-i2s.h b/include/dt-bindings/sound/samsung-i2s.h
index 77545f14c379..250de0d6c734 100644
--- 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 */