linux-kernel - Re: [PATCH v1 1/3] ASoC: zx-96p22: add documentation for zte's aud96p22 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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <20170216110012.GC8398@dragon>
Date:   Thu, 16 Feb 2017 19:00:13 +0800
From:   Shawn Guo <shawnguo@...nel.org>
To:     Baoyou Xie <baoyou.xie@...aro.org>
Cc:     jun.nie@...aro.org, lgirdwood@...il.com, broonie@...nel.org,
        robh+dt@...nel.org, mark.rutland@....com, perex@...ex.cz,
        tiwai@...e.com, lars@...afoo.de, arnd@...db.de,
        kuninori.morimoto.gx@...esas.com,
        ckeepax@...nsource.wolfsonmicro.com, bardliao@...ltek.com,
        nh6z@...z.net, Paul.Handrigan@...rus.com, oder_chiou@...ltek.com,
        axel.lin@...ics.com, petr@...ix.com, yesanishhere@...il.com,
        srinivas.kandagatla@...aro.org,
        linux-arm-kernel@...ts.infradead.org, alsa-devel@...a-project.org,
        devicetree@...r.kernel.org, linux-kernel@...r.kernel.org,
        xie.baoyou@....com.cn, chen.chaokai@....com.cn,
        wang.qiang01@....com.cn
Subject: Re: [PATCH v1 1/3] ASoC: zx-96p22: add documentation for zte's
 aud96p22 controller

On Wed, Feb 15, 2017 at 06:55:08PM +0800, Baoyou Xie wrote:
> This patch adds dt-binding documentation for zte's aud96p22 controller.
> 
> Signed-off-by: Baoyou Xie <baoyou.xie@...aro.org>

Suggest to replace "documentation" with "bindings doc" in patch subject.

> ---
>  .../devicetree/bindings/sound/zte,zx-96p22.txt     | 24 ++++++++++++++++++++++
>  1 file changed, 24 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/zte,zx-96p22.txt
> 
> diff --git a/Documentation/devicetree/bindings/sound/zte,zx-96p22.txt b/Documentation/devicetree/bindings/sound/zte,zx-96p22.txt
> new file mode 100644
> index 0000000..4184566
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/zte,zx-96p22.txt
> @@ -0,0 +1,24 @@
> +ZTE zx96p22 controller
> +
> +Required properties:
> + - compatible : Must be "zte,zx-aud96p22"
> + - #sound-dai-cells: Should be 0
> + - reg : Offset of I2C register for zx96p22

"zte,zx-96p22.txt", "zte,zx-aud96p22" and "zx96p22".  Can we make these
names consistent?

> +
> +Example:
> +
> +	audio_i2c0: audio_i2c0@...6000 {

Node name should be as generic as possible.  I think the following one
is what we want.

	audio_i2c0: i2c@...6000 {

> +		compatible = "zte,zx296718-i2c";
> +		reg = <0x01486000 0x1000>;
> +		interrupts = <GIC_SPI 35 IRQ_TYPE_LEVEL_HIGH>;
> +		#address-cells = <1>;
> +		#size-cells = <0>;
> +		clocks = <&audiocrm AUDIO_I2C0_WCLK>;
> +		clock-frequency = <1600000>;
> +		status = "ok";

Drop this 'status' property, which is not so meaningful for example in
bindings doc.

And have a newline between properties and child node.

> +		inner_codec: aud96p22@22 {

		aud96p22: codec@22 {

Shawn

> +			compatible = "zte,zx-aud96p22";
> +			#sound-dai-cells = <0>;
> +			reg = <0x22>;
> +		};
> +	};
> -- 
> 2.7.4
>