From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <linux-kernel-owner@vger.kernel.org>
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
	id S966400AbbJ3ODs (ORCPT <rfc822;w@1wt.eu>);
	Fri, 30 Oct 2015 10:03:48 -0400
Received: from foss.arm.com ([217.140.101.70]:43872 "EHLO foss.arm.com"
	rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP
	id S964769AbbJ3ODq (ORCPT <rfc822;linux-kernel@vger.kernel.org>);
	Fri, 30 Oct 2015 10:03:46 -0400
Date: Fri, 30 Oct 2015 14:03:34 +0000
From: Mark Rutland <mark.rutland@arm.com>
To: Zain Wang <zain.wang@rock-chips.com>
Cc: zhengsq@rock-chips.com, hl@rock-chips.com, herbert@gondor.apana.org.au,
        davem@davemloft.net, mturquette@baylibre.com, heiko@sntech.de,
        pawel.moll@arm.com, ijc+devicetree@hellion.org.uk, robh+dt@kernel.org,
        galak@codeaurora.org, linux@arm.linux.org.uk,
        linux-kernel@vger.kernel.org, linux-crypto@vger.kernel.org,
        linux-rockchip@lists.infradead.org, devicetree@vger.kernel.org,
        eddie.cai@rock-chips.com
Subject: Re: [RESEND PATCH 4/4] crypto: rk_crypto - add DT bindings
 documentation
Message-ID: <20151030140334.GB31073@leverpostej>
References: <1446193369-4453-1-git-send-email-zain.wang@rock-chips.com>
 <1446193369-4453-5-git-send-email-zain.wang@rock-chips.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <1446193369-4453-5-git-send-email-zain.wang@rock-chips.com>
User-Agent: Mutt/1.5.21 (2010-09-15)
Sender: linux-kernel-owner@vger.kernel.org
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On Fri, Oct 30, 2015 at 04:22:49PM +0800, Zain Wang wrote:
> Add DT bindings documentation for the rk3288 crypto drivers.
> 
> Signed-off-by: Zain Wang <zain.wang@rock-chips.com>
> ---
>  .../devicetree/bindings/crypto/rk-crypto.txt       | 31 ++++++++++++++++++++++
>  1 file changed, 31 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/crypto/rk-crypto.txt
> 
> diff --git a/Documentation/devicetree/bindings/crypto/rk-crypto.txt b/Documentation/devicetree/bindings/crypto/rk-crypto.txt
> new file mode 100644
> index 0000000..1e50768
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/crypto/rk-crypto.txt
> @@ -0,0 +1,31 @@
> +Rockchip Electronics And Security Accelerator
> +
> +Required properties:
> +- compatible: should be "rockchip,crypto"

Choose a more specific name. Rockchip could easily come up with another
crypto accelerator later.

> +- reg: base physical address of the engine and length of memory mapped
> +       region.
> +- interrupts: interrupt number
> +- clocks: clock specifiers
> +- clock-names: "aclk_crypto" used to clock data
> +			   "hclk_crypto" used to clock data
> +			   "srst_crypto" used to clock crypto accelerator
> +			   "apb_pclk"    used to clock dma
> +-status: Enable

No need to mention the status property.

Thanks,
Mark.

> +
> +Examples:
> +
> +	crypto: cypto-controller@ff8a0000 {
> +		compatible = "rockchip,crypto";
> +		reg = <0xff8a0000 0x4000>;
> +		interrupts = <GIC_SPI 48 IRQ_TYPE_LEVEL_HIGH>;
> +		clocks = <&cru ACLK_CRYPTO>,
> +			 <&cru HCLK_CRYPTO>,
> +			 <&cru SRST_CRYPTO>,
> +			 <&cru ACLK_DMAC1>;
> +
> +		clock-names = "aclk_crypto",
> +			      "hclk_crypto",
> +			      "srst_crypto",
> +				  "apb_pclk";
> +		status = "okay";
> +	};
> -- 
> 1.9.1
> 
>