| Message ID | 20220208104918.226156-4-tudor.ambarus@microchip.com |
|---|---|
| State | Accepted |
| Commit | 44c75c9e3d08b430a9f002a087f2da255909b8ff |
| Headers | show |
| Series | None | expand |
On 08/02/2022 11:49, Tudor Ambarus wrote: > Convert Atmel SHA documentation to yaml format. With the conversion the > clock and clock-names properties are made mandatory. The driver returns > -EINVAL if "sha_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: Tudor Ambarus <tudor.ambarus@microchip.com> > --- > .../crypto/atmel,at91sam9g46-sha.yaml | 59 +++++++++++++++++++ > .../bindings/crypto/atmel-crypto.txt | 25 -------- > 2 files changed, 59 insertions(+), 25 deletions(-) > create mode 100644 Documentation/devicetree/bindings/crypto/atmel,at91sam9g46-sha.yaml > delete mode 100644 Documentation/devicetree/bindings/crypto/atmel-crypto.txt > > diff --git a/Documentation/devicetree/bindings/crypto/atmel,at91sam9g46-sha.yaml b/Documentation/devicetree/bindings/crypto/atmel,at91sam9g46-sha.yaml > new file mode 100644 > index 000000000000..e454f4468dc5 > --- /dev/null > +++ b/Documentation/devicetree/bindings/crypto/atmel,at91sam9g46-sha.yaml > @@ -0,0 +1,59 @@ > +# SPDX-License-Identifier: GPL-2.0-only > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/crypto/atmel,at91sam9g46-sha.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Atmel Secure Hash Algorithm (SHA) HW cryptographic accelerator > + > +maintainers: > + - Tudor Ambarus <tudor.ambarus@microchip.com> > + > +properties: > + compatible: > + const: atmel,at91sam9g46-sha > + > + reg: > + maxItems: 1 > + > + interrupts: > + maxItems: 1 > + > + clocks: > + maxItems: 1 > + > + clock-names: > + const: sha_clk > + > + dmas: > + maxItems: 1 > + description: TX DMA Channel > + One-item-description should work as well, so if you are going to resend: + dmas: + items: + - description: TX DMA Channel but the code looks equivalent, so: Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com> Best regards, Krzysztof
diff --git a/Documentation/devicetree/bindings/crypto/atmel,at91sam9g46-sha.yaml b/Documentation/devicetree/bindings/crypto/atmel,at91sam9g46-sha.yaml new file mode 100644 index 000000000000..e454f4468dc5 --- /dev/null +++ b/Documentation/devicetree/bindings/crypto/atmel,at91sam9g46-sha.yaml @@ -0,0 +1,59 @@ +# SPDX-License-Identifier: GPL-2.0-only +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/crypto/atmel,at91sam9g46-sha.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Atmel Secure Hash Algorithm (SHA) HW cryptographic accelerator + +maintainers: + - Tudor Ambarus <tudor.ambarus@microchip.com> + +properties: + compatible: + const: atmel,at91sam9g46-sha + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + clocks: + maxItems: 1 + + clock-names: + const: sha_clk + + dmas: + maxItems: 1 + description: TX DMA Channel + + dma-names: + const: tx + +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> + + sha: crypto@e1814000 { + compatible = "atmel,at91sam9g46-sha"; + reg = <0xe1814000 0x100>; + interrupts = <GIC_SPI 83 IRQ_TYPE_LEVEL_HIGH>; + clocks = <&pmc PMC_TYPE_PERIPHERAL 83>; + clock-names = "sha_clk"; + dmas = <&dma0 AT91_XDMAC_DT_PERID(48)>; + dma-names = "tx"; + }; diff --git a/Documentation/devicetree/bindings/crypto/atmel-crypto.txt b/Documentation/devicetree/bindings/crypto/atmel-crypto.txt deleted file mode 100644 index 5c6541cfcc4a..000000000000 --- a/Documentation/devicetree/bindings/crypto/atmel-crypto.txt +++ /dev/null @@ -1,25 +0,0 @@ -* Atmel HW cryptographic accelerators - -These are the HW cryptographic accelerators found on some Atmel products. - -* Secure Hash Algorithm (SHA) - -Required properties: -- compatible : Should be "atmel,at91sam9g46-sha". -- reg: Should contain SHA registers location and length. -- interrupts: Should contain the IRQ line for the SHA. - -Optional properties: -- dmas: One 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. Only one "tx" string needed. - -Example: -sha@f8034000 { - compatible = "atmel,at91sam9g46-sha"; - reg = <0xf8034000 0x100>; - interrupts = <42 4 0>; - dmas = <&dma1 2 17>; - dma-names = "tx"; -};
Convert Atmel SHA documentation to yaml format. With the conversion the clock and clock-names properties are made mandatory. The driver returns -EINVAL if "sha_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: Tudor Ambarus <tudor.ambarus@microchip.com> --- .../crypto/atmel,at91sam9g46-sha.yaml | 59 +++++++++++++++++++ .../bindings/crypto/atmel-crypto.txt | 25 -------- 2 files changed, 59 insertions(+), 25 deletions(-) create mode 100644 Documentation/devicetree/bindings/crypto/atmel,at91sam9g46-sha.yaml delete mode 100644 Documentation/devicetree/bindings/crypto/atmel-crypto.txt