Re: [PATCHv2 1/7] dt-bindings: crypto: Add TI SA2UL crypto accelerator documentation

[Tero Kristo <t-kristo@ti.com>]

On 12/05/2020 00:53, Rob Herring wrote:
> On Fri, Apr 24, 2020 at 07:44:24PM +0300, Tero Kristo wrote:
>> From: Keerthy <j-keerthy@ti.com>
>>
>> The Security Accelerator Ultra Lite (SA2UL) subsystem provides hardware
>> cryptographic acceleration for the following use cases:
>>
>> * Encryption and authentication for secure boot
>> * Encryption and authentication of content in applications
>>    requiring DRM (digital rights management) and
>>    content/asset protection
>>
>> SA2UL provides support for number of different cryptographic algorithms
>> including SHA1, SHA256, SHA512, AES, 3DES, and various combinations of
>> the previous for AEAD use.
>>
>> Cc: Rob Herring <robh@kernel.org>
>> Cc: devicetree@vger.kernel.org
>> Signed-off-by: Keerthy <j-keerthy@ti.com>
>> [t-kristo@ti.com: converted documentation to yaml]
>> Signed-off-by: Tero Kristo <t-kristo@ti.com>
>> ---
>>   .../devicetree/bindings/crypto/ti,sa2ul.yaml  | 76 +++++++++++++++++++
>>   1 file changed, 76 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/crypto/ti,sa2ul.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/crypto/ti,sa2ul.yaml b/Documentation/devicetree/bindings/crypto/ti,sa2ul.yaml
>> new file mode 100644
>> index 000000000000..27bb3a7e2b87
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/crypto/ti,sa2ul.yaml
>> @@ -0,0 +1,76 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/crypto/ti,sa2ul.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: K3 SoC SA2UL crypto module
>> +
>> +maintainers:
>> +  - Tero Kristo <t-kristo@ti.com>
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - ti,j721e-sa2ul
>> +      - ti,am654-sa2ul
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  power-domains:
>> +    maxItems: 1
>> +
>> +  dmas:
>> +    items:
>> +      - description: TX DMA Channel
>> +      - description: RX DMA Channel #1
>> +      - description: RX DMA Channel #2
>> +
>> +  dma-names:
>> +    items:
>> +      - const: tx
>> +      - const: rx1
>> +      - const: rx2
>> +
>> +  dma-coherent: true
>> +
>> +  "#address-cells":
>> +    const: 2
>> +
>> +  "#size-cells":
>> +    const: 2
>> +
>> +  ranges:
>> +    description:
>> +      Address translation for the possible RNG child node for SA2UL
>> +
>> +patternProperties:
>> +  "^rng@[a-lf0-9]+$":
> 
> a-l?

Ooops, thats a typo right here. Will fix that.

> 
>> +    type: object
>> +    description:
>> +      Child RNG node for SA2UL
> 
> Does this child node have a binding?

Yes, it is here:

Documentation/devicetree/bindings/rng/omap_rng.txt.

It is an old one so not converted to yaml yet though.

-Tero

> 
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - power-domains
>> +  - dmas
>> +  - dma-names
>> +  - dma-coherent
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    #include <dt-bindings/soc/ti,sci_pm_domain.h>
>> +
>> +    main_crypto: crypto@4e00000 {
>> +        compatible = "ti,j721-sa2ul";
>> +        reg = <0x0 0x4e00000 0x0 0x1200>;
>> +        power-domains = <&k3_pds 264 TI_SCI_PD_EXCLUSIVE>;
>> +        dmas = <&main_udmap 0xc000>, <&main_udmap 0x4000>,
>> +               <&main_udmap 0x4001>;
>> +        dma-names = "tx", "rx1", "rx2";
>> +        dma-coherent;
>> +    };
>> -- 
>> 2.17.1
>>
>> --

--
Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki. Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki