Commit d63b583f authored by Tudor Ambarus's avatar Tudor Ambarus Committed by Rob Herring
Browse files

dt-bindings: crypto: Convert Atmel TDES to yaml 



Convert Atmel TDES documentation to yaml format. With the conversion the
clock and clock-names properties are made mandatory. The driver returns
-EINVAL if "tdes_clk" is not found, reflect that in the bindings and make
the clock and clock-names properties mandatory. Update the example to
better describe how one should define the dt node.

Signed-off-by: default avatarTudor Ambarus <tudor.ambarus@microchip.com>
Reviewed-by: default avatarKrzysztof Kozlowski <krzysztof.kozlowski@canonical.com>
Signed-off-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20220211093922.456634-3-tudor.ambarus@microchip.com
parent c8f2ad68

Documentation/devicetree/bindings/crypto/atmel,at91sam9g46-tdes.yaml

0 → 100644
+64 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

# Copyright (C) 2022 Microchip Technology, Inc. and its subsidiaries

%YAML 1.2

---

$id: http://devicetree.org/schemas/crypto/atmel,at91sam9g46-tdes.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Atmel Triple Data Encryption Standard (TDES) HW cryptographic accelerator



maintainers:

  - Tudor Ambarus <tudor.ambarus@microchip.com>



properties:

  compatible:

    const: atmel,at91sam9g46-tdes



  reg:

    maxItems: 1



  interrupts:

    maxItems: 1



  clocks:

    maxItems: 1



  clock-names:

    const: tdes_clk



  dmas:

    items:

      - description: TX DMA Channel

      - description: RX DMA Channel



  dma-names:

    items:

      - const: tx

      - const: rx



required:

  - compatible

  - reg

  - interrupts

  - clocks

  - clock-names



additionalProperties: false



examples:

  - |

    #include <dt-bindings/interrupt-controller/irq.h>

    #include <dt-bindings/interrupt-controller/arm-gic.h>

    #include <dt-bindings/clock/at91.h>

    #include <dt-bindings/dma/at91.h>



    tdes: crypto@e2014000 {

      compatible = "atmel,at91sam9g46-tdes";

      reg = <0xe2014000 0x100>;

      interrupts = <GIC_SPI 96 IRQ_TYPE_LEVEL_HIGH>;

      clocks = <&pmc PMC_TYPE_PERIPHERAL 96>;

      clock-names = "tdes_clk";

      dmas = <&dma0 AT91_XDMAC_DT_PERID(54)>,

             <&dma0 AT91_XDMAC_DT_PERID(53)>;

      dma-names = "tx", "rx";

    };

Documentation/devicetree/bindings/crypto/atmel-crypto.txt

+0 −23
Original line number Diff line number Diff line
@@ -2,29 +2,6 @@ 


These are the HW cryptographic accelerators found on some Atmel products.



* Triple Data Encryption Standard (Triple DES)



Required properties:

- compatible : Should be "atmel,at91sam9g46-tdes".

- reg: Should contain TDES registers location and length.

- interrupts: Should contain the IRQ line for the TDES.



Optional properties:

- dmas: List of two DMA specifiers as described in

        atmel-dma.txt and dma.txt files.

- dma-names: Contains one identifier string for each DMA specifier

             in the dmas property.



Example:

tdes@f803c000 {

	compatible = "atmel,at91sam9g46-tdes";

	reg = <0xf803c000 0x100>;

	interrupts = <44 4 0>;

	dmas = <&dma1 2 20>,

	       <&dma1 2 21>;

	dma-names = "tx", "rx";

};



* Secure Hash Algorithm (SHA)



Required properties: