linux-kernel - Re: [PATCH V6 1/3] Add DT bindings documentation for hi6220 SoC reset controller.

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <1446135286.3274.66.camel@pengutronix.de>
Date:	Thu, 29 Oct 2015 17:14:46 +0100
From:	Philipp Zabel <p.zabel@...gutronix.de>
To:	Chen Feng <puck.chen@...ilicon.com>
Cc:	linux-kernel@...r.kernel.org, puck.chen@...yun.com,
	robh+dt@...nel.org, pawel.moll@....com, mark.rutland@....com,
	ijc+devicetree@...lion.org.uk
Subject: Re: [PATCH V6 1/3] Add DT bindings documentation for hi6220 SoC
 reset controller.

Hi,

A few small issues remaining. 

Am Donnerstag, den 29.10.2015, 20:55 +0800 schrieb Chen Feng:
> docs: dts: Added documentation for hi6220 Reset Controller

Better to switch the description and the Subject of the e-mail.
Actually, the subject line and patch description already was fine in V4.
Prefixes like "reset: ..." and "dt-bindings: ..." should be in the
subject instead of the commit message body.

> Signed-off-by: Chen Feng <puck.chen@...ilicon.com>
> ---
>  .../bindings/reset/hisilicon,hi6220-reset.txt      | 32 ++++++++++++++++++++++
>  1 file changed, 32 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/reset/hisilicon,hi6220-reset.txt
> 
> diff --git a/Documentation/devicetree/bindings/reset/hisilicon,hi6220-reset.txt b/Documentation/devicetree/bindings/reset/hisilicon,hi6220-reset.txt
> new file mode 100644
> index 0000000..be06352
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/reset/hisilicon,hi6220-reset.txt
> @@ -0,0 +1,32 @@
> +Hisilicon System Reset Controller
> +======================================
> +
> +Please also refer to reset.txt in this directory for common reset
> +controller binding usage.
> +
> +The reset controller registers are part of the system-ctl block on
> +hi6220 SoC.
> +
> +Required properties:
> +- compatible: may be "hisilicon,hi6220-sysctrl"
> +- reg: should be register base and length as documented in the
> +  datasheet
> +- #reset-cells: 1, see below
> +
> +Example:
> +sys_ctrl: sys_ctrl@...30000 {
> +	compatible = "hisilicon,hi6220-sysctrl", "syscon";
> +	reg = <0x0 0xf7030000 0x0 0x2000>;
> +	#clock-cells = <1>;
> +	#reset-cells = <1>;
> +};

This example is not indented. That is ok, but the example below is
indented by a tab. Please choose one style for both.

> +
> +Specifying reset lines connected to IP modules
> +==============================================
> +example:

That probably should be "Example:".

> +
> +        uart1: uart1@..... {

That should be "uart1: serial@...", as Rob already pointed out.

> +                ...
> +                resets = <&sys_ctrl 0x305>;

Better use PERIPH_RSTEN3_UART1 instead of 0x305 here.

> +                ...
> +        };

Also add a pointer to the hisi,hi6220-resets.h here, for example:

A list of valid reset signals can be found in:
include/dt-bindings/reset/hisi,hi6220-resets.h

Also, that header file should be part of this patch, instead of the
driver patch.

best regards
Philipp

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/