[v6,4/8] Documentation: bindings: add dt documentation for dfi controller
diff mbox

Message ID 1471386989-9541-5-git-send-email-hl@rock-chips.com
State New
Headers show

Commit Message

huang lin Aug. 16, 2016, 10:36 p.m. UTC
This patch adds the documentation for rockchip dfi devfreq-event driver.

Signed-off-by: Lin Huang <hl@rock-chips.com>
---
Changes in v6:
-None

Changes in v5:
-None

Changes in v4:
-None

Changes in v3:
-None

Changes in v2:
-None 

Changes in v1:
-None

 .../bindings/devfreq/event/rockchip-dfi.txt          | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/devfreq/event/rockchip-dfi.txt

Comments

Chanwoo Choi Aug. 17, 2016, 12:31 a.m. UTC | #1
Hi Lin,

I add one minor comment.

After fixing it, looks good to me.
Acked-by: Chanwoo Choi <cw00.choi@samsung.com>

On 2016년 08월 17일 07:36, Lin Huang wrote:
> This patch adds the documentation for rockchip dfi devfreq-event driver.
> 
> Signed-off-by: Lin Huang <hl@rock-chips.com>
> ---
> Changes in v6:
> -None
> 
> Changes in v5:
> -None
> 
> Changes in v4:
> -None
> 
> Changes in v3:
> -None
> 
> Changes in v2:
> -None 
> 
> Changes in v1:
> -None
> 
>  .../bindings/devfreq/event/rockchip-dfi.txt          | 20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/devfreq/event/rockchip-dfi.txt
> 
> diff --git a/Documentation/devicetree/bindings/devfreq/event/rockchip-dfi.txt b/Documentation/devicetree/bindings/devfreq/event/rockchip-dfi.txt
> new file mode 100644
> index 0000000..bf42255
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/devfreq/event/rockchip-dfi.txt
> @@ -0,0 +1,20 @@
> +
> +* Rockchip rk3399 DFI device
> +
> +Required properties:
> +- compatible: Must be "rockchip,rk3399-dfi".
> +- reg: physical base address of each DFI and length of memory mapped region
> +- rockchip,pmu: phandle to the syscon managing the "pmu general register files"
> +- clocks: phandles for clock specified in "clock-names" property
> +- clock-names : the name of clock used by the DFI, must be "pclk_ddr_mon";
> +
> +Example:
> +	dfi: dfi@0xff630000 {
> +		reg = <0x00 0xff630000 0x00 0x4000>;
> +		compatible = "rockchip,rk3399-dfi";
> +		rockchip,pmu = <&pmugrf>;
> +		clocks = <&cru PCLK_DDR_MON>;
> +		clock-names = "pclk_ddr_mon";
> +		status = "disabled";
> +	};
> +

Remove the blank line.

Thanks,
Chanwoo Choi
Chanwoo Choi Aug. 17, 2016, 12:41 a.m. UTC | #2
Hi Lin,

I add the additional comment.

On 2016년 08월 17일 09:31, Chanwoo Choi wrote:
> Hi Lin,
> 
> I add one minor comment.
> 
> After fixing it, looks good to me.
> Acked-by: Chanwoo Choi <cw00.choi@samsung.com>
> 
> On 2016년 08월 17일 07:36, Lin Huang wrote:
>> This patch adds the documentation for rockchip dfi devfreq-event driver.
>>
>> Signed-off-by: Lin Huang <hl@rock-chips.com>
>> ---
>> Changes in v6:
>> -None
>>
>> Changes in v5:
>> -None
>>
>> Changes in v4:
>> -None
>>
>> Changes in v3:
>> -None
>>
>> Changes in v2:
>> -None 
>>
>> Changes in v1:
>> -None
>>
>>  .../bindings/devfreq/event/rockchip-dfi.txt          | 20 ++++++++++++++++++++
>>  1 file changed, 20 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/devfreq/event/rockchip-dfi.txt
>>
>> diff --git a/Documentation/devicetree/bindings/devfreq/event/rockchip-dfi.txt b/Documentation/devicetree/bindings/devfreq/event/rockchip-dfi.txt
>> new file mode 100644
>> index 0000000..bf42255
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/devfreq/event/rockchip-dfi.txt
>> @@ -0,0 +1,20 @@
>> +
>> +* Rockchip rk3399 DFI device
>> +
>> +Required properties:
>> +- compatible: Must be "rockchip,rk3399-dfi".
>> +- reg: physical base address of each DFI and length of memory mapped region
>> +- rockchip,pmu: phandle to the syscon managing the "pmu general register files"
>> +- clocks: phandles for clock specified in "clock-names" property
>> +- clock-names : the name of clock used by the DFI, must be "pclk_ddr_mon";
>> +
>> +Example:
>> +	dfi: dfi@0xff630000 {
>> +		reg = <0x00 0xff630000 0x00 0x4000>;
>> +		compatible = "rockchip,rk3399-dfi";

As I said on previous mail-thread, the 'compatible' property
is first usually. You better to change the order as following:

		compatible = "rockchip,rk3399-dfi";
		reg = <0x00 0xff630000 0x00 0x4000>;

>> +		rockchip,pmu = <&pmugrf>;
>> +		clocks = <&cru PCLK_DDR_MON>;
>> +		clock-names = "pclk_ddr_mon";
>> +		status = "disabled";
>> +	};
>> +
> 
> Remove the blank line.
> 
> Thanks,
> Chanwoo Choi

Thanks,
Chanwoo Choi

Patch
diff mbox

diff --git a/Documentation/devicetree/bindings/devfreq/event/rockchip-dfi.txt b/Documentation/devicetree/bindings/devfreq/event/rockchip-dfi.txt
new file mode 100644
index 0000000..bf42255
--- /dev/null
+++ b/Documentation/devicetree/bindings/devfreq/event/rockchip-dfi.txt
@@ -0,0 +1,20 @@ 
+
+* Rockchip rk3399 DFI device
+
+Required properties:
+- compatible: Must be "rockchip,rk3399-dfi".
+- reg: physical base address of each DFI and length of memory mapped region
+- rockchip,pmu: phandle to the syscon managing the "pmu general register files"
+- clocks: phandles for clock specified in "clock-names" property
+- clock-names : the name of clock used by the DFI, must be "pclk_ddr_mon";
+
+Example:
+	dfi: dfi@0xff630000 {
+		reg = <0x00 0xff630000 0x00 0x4000>;
+		compatible = "rockchip,rk3399-dfi";
+		rockchip,pmu = <&pmugrf>;
+		clocks = <&cru PCLK_DDR_MON>;
+		clock-names = "pclk_ddr_mon";
+		status = "disabled";
+	};
+