From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
To: Jia Jie Ho <jiajie.ho@starfivetech.com>,
Herbert Xu <herbert@gondor.apana.org.au>,
"David S . Miller" <davem@davemloft.net>,
Rob Herring <robh+dt@kernel.org>,
Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
Cc: linux-crypto@vger.kernel.org, devicetree@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-riscv@lists.infradead.org
Subject: Re: [PATCH 5/6] dt-bindings: crypto: Add bindings for Starfive crypto driver
Date: Wed, 30 Nov 2022 14:20:52 +0100 [thread overview]
Message-ID: <8a8f502e-e0ed-d638-0b56-74edcbca2134@linaro.org> (raw)
In-Reply-To: <20221130055214.2416888-6-jiajie.ho@starfivetech.com>
On 30/11/2022 06:52, Jia Jie Ho wrote:
> Add documentation to describe Starfive crypto
> driver bindings.
Please wrap commit message according to Linux coding style / submission
process:
https://elixir.bootlin.com/linux/v5.18-rc4/source/Documentation/process/submitting-patches.rst#L586
Subject: drop second, redundant "bindings".
>
> Signed-off-by: Jia Jie Ho <jiajie.ho@starfivetech.com>
> Signed-off-by: Huan Feng <huan.feng@starfivetech.com>
> ---
> .../bindings/crypto/starfive-crypto.yaml | 109 ++++++++++++++++++
> 1 file changed, 109 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/crypto/starfive-crypto.yaml
>
> diff --git a/Documentation/devicetree/bindings/crypto/starfive-crypto.yaml b/Documentation/devicetree/bindings/crypto/starfive-crypto.yaml
> new file mode 100644
> index 000000000000..6b852f774c32
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/crypto/starfive-crypto.yaml
Filename based on compatible, so starfive,jh7110-crypto.yaml
> @@ -0,0 +1,109 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/crypto/starfive-crypto.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: StarFive Crypto Controller Device Tree Bindings
Drop "Device Tree Bindings"
> +
> +maintainers:
> + - Jia Jie Ho <jiajie.ho@starfivetech.com>
> + - William Qiu <william.qiu@starfivetech.com>
> +
> +properties:
> + compatible:
> + const: starfive,jh7110-crypto
> +
> + reg:
> + maxItems: 1
> +
> + reg-names:
> + items:
> + - const: secreg
Why do you need reg-names for one entry?
> +
> + clocks:
> + items:
> + - description: Hardware reference clock
> + - description: AHB reference clock
> +
> + clock-names:
> + items:
> + - const: sec_hclk
> + - const: sec_ahb
sec seems redundant, so just "ahb". The first clock then "hclk" or "ref"?
> +
> + interrupts:
> + items:
> + - description: Interrupt pin for algo completion
> + - description: Interrupt pin for DMA transfer completion
> +
> + interrupt-names:
> + items:
> + - const: secirq
> + - const: dmairq
Drop "irq" from both.
> +
> + resets:
> + items:
> + - description: STG domain reset line
> +
> + reset-names:
> + items:
> + - const: sec_hre
Drop "sec". Why do you need the names for one entry?
> +
> + enable-side-channel-mitigation:
> + description: Enable side-channel-mitigation feature for AES module.
> + Enabling this feature will affect the speed performance of
> + crypto engine.
> + type: boolean
Why exactly this is a hardware (DT) property, not runtime?
> +
> + enable-dma:
> + description: Enable data transfer using dedicated DMA controller.
> + type: boolean
Usually the presence of dmas indicates whether to use or not to use DMA.
Do you expect a case where DMA channels are provided by you don't want
DMA? Explain such case and describe why it is a hardware/system
integration property.
> +
> + dmas:
> + items:
> + - description: TX DMA channel
> + - description: RX DMA channel
> +
> + dma-names:
> + items:
> + - const: sec_m
tx
> + - const: sec_p
rx
> +
> +required:
> + - compatible
> + - reg
> + - reg-names
> + - clocks
> + - clock-names
> + - resets
> + - reset-names
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/clock/starfive-jh7110.h>
> + #include <dt-bindings/reset/starfive-jh7110.h>
> +
> + soc {
> + #address-cells = <2>;
> + #size-cells = <2>;
Use 4 spaces for example indentation.
> +
Best regards,
Krzysztof
next prev parent reply other threads:[~2022-11-30 13:21 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-30 5:52 [PATCH 0/6] crypto: starfive: Add driver for cryptographic engine Jia Jie Ho
2022-11-30 5:52 ` [PATCH 1/6] crypto: starfive - Add StarFive crypto engine support Jia Jie Ho
2022-11-30 13:15 ` Krzysztof Kozlowski
2022-12-01 6:52 ` JiaJie Ho
2022-12-01 9:28 ` Krzysztof Kozlowski
2022-12-01 9:43 ` JiaJie Ho
2022-11-30 5:52 ` [PATCH 2/6] crypto: starfive - Add hash and HMAC support Jia Jie Ho
2022-11-30 5:52 ` [PATCH 3/6] crypto: starfive - Add AES skcipher and aead support Jia Jie Ho
2022-11-30 5:52 ` [PATCH 4/6] crypto: starfive - Add Public Key algo support Jia Jie Ho
2022-11-30 5:52 ` [PATCH 5/6] dt-bindings: crypto: Add bindings for Starfive crypto driver Jia Jie Ho
2022-11-30 13:20 ` Krzysztof Kozlowski [this message]
2022-12-01 9:01 ` JiaJie Ho
2022-12-01 9:27 ` Krzysztof Kozlowski
2022-12-06 8:35 ` JiaJie Ho
2022-11-30 13:47 ` Rob Herring
2022-12-06 3:48 ` JiaJie Ho
2022-12-06 8:26 ` Krzysztof Kozlowski
2022-12-06 8:32 ` JiaJie Ho
2022-11-30 5:52 ` [PATCH 6/6] riscv: dts: starfive: Add crypto and DMA node for VisionFive 2 Jia Jie Ho
2022-11-30 9:31 ` Conor.Dooley
2022-12-01 6:17 ` JiaJie Ho
2022-12-01 18:04 ` Conor Dooley
2022-12-06 3:55 ` JiaJie Ho
2022-11-30 13:21 ` Krzysztof Kozlowski
2022-12-01 7:25 ` JiaJie Ho
2022-12-08 9:09 ` [PATCH 0/6] crypto: starfive: Add driver for cryptographic engine JiaJie Ho
2022-12-08 9:28 ` Krzysztof Kozlowski
2022-12-08 9:35 ` JiaJie Ho
2022-12-13 6:20 ` Palmer Dabbelt
2022-12-13 6:32 ` JiaJie Ho
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8a8f502e-e0ed-d638-0b56-74edcbca2134@linaro.org \
--to=krzysztof.kozlowski@linaro.org \
--cc=davem@davemloft.net \
--cc=devicetree@vger.kernel.org \
--cc=herbert@gondor.apana.org.au \
--cc=jiajie.ho@starfivetech.com \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-riscv@lists.infradead.org \
--cc=robh+dt@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).