diff mbox

[v4,1/4] mfd: Add DT bindings documentation for Samsung Exynos LPASS

Message ID 1467738785-31410-1-git-send-email-s.nawrocki@samsung.com
State Not Applicable, archived
Headers show

Commit Message

Sylwester Nawrocki July 5, 2016, 5:13 p.m. UTC 
This patch adds documentation of the DT bindings for the Samsung
Exynos SoC Low Power Audio Subsystem.

Signed-off-by: Sylwester Nawrocki <s.nawrocki@samsung.com>
---

There were few rather significant additions since v3 and I had to drop tags:
 Acked-by: Rob Herring <robh@kernel.org>
 Acked-by: Krzysztof Kozlowski <k.kozlowski@samsung.com>

Changes since v3:
 - moved to Documentation/devicetree/bindings/mfd,
 - added #address-cells, #size-cells, ranges as required
   properties,
 - added description of the IP block subnodes and links
   to their binding's documentation.

Changes since v2:
 - none.
---
 .../bindings/mfd/samsung,exynos5433-lpass.txt       | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/samsung,exynos5433-lpass.txt

Comments

Rob Herring July 11, 2016, 2:32 p.m. UTC | #1 
On Tue, Jul 05, 2016 at 07:13:05PM +0200, Sylwester Nawrocki wrote:
> This patch adds documentation of the DT bindings for the Samsung
> Exynos SoC Low Power Audio Subsystem.
> 
> Signed-off-by: Sylwester Nawrocki <s.nawrocki@samsung.com>
> ---
> 
> There were few rather significant additions since v3 and I had to drop tags:
>  Acked-by: Rob Herring <robh@kernel.org>
>  Acked-by: Krzysztof Kozlowski <k.kozlowski@samsung.com>
> 
> Changes since v3:
>  - moved to Documentation/devicetree/bindings/mfd,
>  - added #address-cells, #size-cells, ranges as required
>    properties,
>  - added description of the IP block subnodes and links
>    to their binding's documentation.
> 
> Changes since v2:
>  - none.
> ---
>  .../bindings/mfd/samsung,exynos5433-lpass.txt       | 21 +++++++++++++++++++++
>  1 file changed, 21 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mfd/samsung,exynos5433-lpass.txt

Acked-by: Rob Herring <robh@kernel.org>
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Lee Jones Aug. 5, 2016, 1:36 p.m. UTC | #2 
On Tue, 05 Jul 2016, Sylwester Nawrocki wrote:

> This patch adds documentation of the DT bindings for the Samsung
> Exynos SoC Low Power Audio Subsystem.
> 
> Signed-off-by: Sylwester Nawrocki <s.nawrocki@samsung.com>
> ---
> 
> There were few rather significant additions since v3 and I had to drop tags:
>  Acked-by: Rob Herring <robh@kernel.org>
>  Acked-by: Krzysztof Kozlowski <k.kozlowski@samsung.com>
> 
> Changes since v3:
>  - moved to Documentation/devicetree/bindings/mfd,
>  - added #address-cells, #size-cells, ranges as required
>    properties,
>  - added description of the IP block subnodes and links
>    to their binding's documentation.
> 
> Changes since v2:
>  - none.
> ---
>  .../bindings/mfd/samsung,exynos5433-lpass.txt       | 21 +++++++++++++++++++++
>  1 file changed, 21 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mfd/samsung,exynos5433-lpass.txt
> 
> diff --git a/Documentation/devicetree/bindings/mfd/samsung,exynos5433-lpass.txt b/Documentation/devicetree/bindings/mfd/samsung,exynos5433-lpass.txt
> new file mode 100644
> index 0000000..7e97c0d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/samsung,exynos5433-lpass.txt
> @@ -0,0 +1,21 @@
> +

Nit: This line is superfluous.

> +Samsung Exynos SoC Low Power Audio Subsystem (LPASS)
> +
> +Required properties:
> +
> + - compatible : "samsung,exynos5433-lpass"
> + - reg : should contain the LPASS top SFR region location and size
> + - samsung,pmu-syscon : the phandle to the Power Management Unit node
> + - #address-cells: should be 1
> + - #size-cells: should be 1
> + - ranges: must be present

These look so much better like:

- compatible  	   	  : "samsung,exynos5433-lpass"
- reg		   	  : should contain the LPASS top SFR region location and size
- samsung,pmu-syscon 	  : the phandle to the Power Management Unit node
- #address-cells	  : should be 1
- #size-cells		  : should be 1
- ranges		  : must be present

> +Each IP block of the Low Power Audio Subsystem should be specified
> +as an optional sub-node. For "samsung,exynos5433-lpass" compatible
> +this includes: UART, SLIMBUS, PCM, I2S, DMAC, Timers 0...4, WDT 0...1
> +devices.
> +
> +Bindings of the sub-nodes are described in:
> + Documentation/devicetree/bindings/serial/samsung_uart.txt
> + Documentation/devicetree/bindings/sound/samsung-i2s.txt
> + Documentation/devicetree/bindings/dma/arm-pl330.txt

Use relative path names:

../serial/samsung_uart.txt
../sound/samsung-i2s.txt
../dma/arm-pl330.txt

Missing example?
Sylwester Nawrocki Aug. 5, 2016, 3:44 p.m. UTC | #3 
On 08/05/2016 03:36 PM, Lee Jones wrote:
> On Tue, 05 Jul 2016, Sylwester Nawrocki wrote:
> 
>> This patch adds documentation of the DT bindings for the Samsung
>> Exynos SoC Low Power Audio Subsystem.
>>
>> Signed-off-by: Sylwester Nawrocki <s.nawrocki@samsung.com>

>> new file mode 100644
>> index 0000000..7e97c0d
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/mfd/samsung,exynos5433-lpass.txt
>> @@ -0,0 +1,21 @@
>> +
> 
> Nit: This line is superfluous.
>
>> +Samsung Exynos SoC Low Power Audio Subsystem (LPASS)
>> +
>> +Required properties:
>> +
>> + - compatible : "samsung,exynos5433-lpass"
>> + - reg : should contain the LPASS top SFR region location and size
>> + - samsung,pmu-syscon : the phandle to the Power Management Unit node
>> + - #address-cells: should be 1
>> + - #size-cells: should be 1
>> + - ranges: must be present
> 
> These look so much better like:
> 
> - compatible  	  : "samsung,exynos5433-lpass"
> - reg		   	  : should contain the LPASS top SFR region location and size
> - samsung,pmu-syscon 	  : the phandle to the Power Management Unit node
> - #address-cells	  : should be 1
> - #size-cells		  : should be 1
> - ranges		  : must be present

OK, will rewrite it this way.

>> +Each IP block of the Low Power Audio Subsystem should be specified
>> +as an optional sub-node. For "samsung,exynos5433-lpass" compatible
>> +this includes: UART, SLIMBUS, PCM, I2S, DMAC, Timers 0...4, WDT 0...1
>> +devices.
>> +
>> +Bindings of the sub-nodes are described in:
>> + Documentation/devicetree/bindings/serial/samsung_uart.txt
>> + Documentation/devicetree/bindings/sound/samsung-i2s.txt
>> + Documentation/devicetree/bindings/dma/arm-pl330.txt
> 
> Use relative path names:
> 
> ../serial/samsung_uart.txt
> ../sound/samsung-i2s.txt
> ../dma/arm-pl330.txt

OK, actually I had it this way in one of the versions but somehow
with full paths it appeared better to me.

> Missing example?

Yes, omitted deliberately as that appeared quite many more lines
with fully specified subnodes.  Perhaps I will add it with omitted
all properties of the subnodes but compatible.


 audio-subsystem {
	compatible = "samsung,exynos5433-lpass";
	reg = <0x11400000 0x100>, <0x11500000 0x08>;
	samsung,pmu-syscon = <&pmu_system_controller>;
	#address-cells = <1>;
	#size-cells = <1>;
	ranges;

	adma: adma@11420000 {
		compatible = "arm,pl330", "arm,primecell";
		reg = <0x11420000 0x1000>;
		interrupts = <0 73 0>;
		clocks = <&cmu_aud CLK_ACLK_DMAC>;
		clock-names = "apb_pclk";
		#dma-cells = <1>;
		#dma-channels = <8>;
		#dma-requests = <32>;
        };

	i2s0: i2s0@11440000 {
		compatible = "samsung,exynos7-i2s";
		reg = <0x11440000 0x100>;
		dmas = <&adma 0 &adma 2>;
		dma-names = "tx", "rx";
		interrupts = <0 70 0>;
		clocks = <&cmu_aud CLK_PCLK_AUD_I2S>,
			 <&cmu_aud CLK_SCLK_AUD_I2S>,
			 <&cmu_aud CLK_SCLK_I2S_BCLK>;
		clock-names = "iis", "i2s_opclk0", "i2s_opclk1";
		pinctrl-names = "default";
		pinctrl-0 = <&i2s0_bus>;
		status = "disabled";
	};

	serial_3: serial@11460000 {
		compatible = "samsung,exynos5433-uart";
		reg = <0x11460000 0x100>;
		interrupts = <0 67 0>;
		clocks = <&cmu_aud CLK_PCLK_AUD_UART>,
			 <&cmu_aud CLK_SCLK_AUD_UART>;
		clock-names = "uart", "clk_uart_baud0";
		pinctrl-names = "default";
		pinctrl-0 = <&uart_aud_bus>;
		status = "disabled";
	};
 };
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/mfd/samsung,exynos5433-lpass.txt b/Documentation/devicetree/bindings/mfd/samsung,exynos5433-lpass.txt
new file mode 100644
index 0000000..7e97c0d
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/samsung,exynos5433-lpass.txt
@@ -0,0 +1,21 @@ 
+
+Samsung Exynos SoC Low Power Audio Subsystem (LPASS)
+
+Required properties:
+
+ - compatible : "samsung,exynos5433-lpass"
+ - reg : should contain the LPASS top SFR region location and size
+ - samsung,pmu-syscon : the phandle to the Power Management Unit node
+ - #address-cells: should be 1
+ - #size-cells: should be 1
+ - ranges: must be present
+
+Each IP block of the Low Power Audio Subsystem should be specified
+as an optional sub-node. For "samsung,exynos5433-lpass" compatible
+this includes: UART, SLIMBUS, PCM, I2S, DMAC, Timers 0...4, WDT 0...1
+devices.
+
+Bindings of the sub-nodes are described in:
+ Documentation/devicetree/bindings/serial/samsung_uart.txt
+ Documentation/devicetree/bindings/sound/samsung-i2s.txt
+ Documentation/devicetree/bindings/dma/arm-pl330.txt