Received-SPF: pass (google.com: domain of linux-crypto-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Lukasz Stelmach <l.stelmach@samsung.com>
To:     Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>
Cc:     Thomas Gleixner <tglx@linutronix.de>,
        Marc Zyngier <maz@kernel.org>,
        Rob Herring <robh+dt@kernel.org>,
        Matt Mackall <mpm@selenic.com>,
        Herbert Xu <herbert@gondor.apana.org.au>,
        linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
        linux-arm-kernel@lists.infradead.org,
        linux-samsung-soc@vger.kernel.org, linux-crypto@vger.kernel.org
Subject: Re: [PATCH 2/2] dt-bindings: rng: convert Samsung Exynos TRNG to
 dtschema
Date:   Wed, 18 Aug 2021 00:17:24 +0200
In-Reply-To: <da43d243-35b0-2cc6-f8a0-a5d02c997301@canonical.com> (Krzysztof
        Kozlowski's message of "Tue, 17 Aug 2021 16:07:20 +0200")
Message-ID: <dleftjtujnemx7.fsf%l.stelmach@samsung.com>
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.1 (gnu/linux)
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="=-=-="; micalg="pgp-sha256";
        protocol="application/pgp-signature"
CMS-TYPE: 201P
References: <da43d243-35b0-2cc6-f8a0-a5d02c997301@canonical.com>
        <CGME20210817221734eucas1p2e4a0aa41406137b90e49230371b92ac6@eucas1p2.samsung.com>
Precedence: bulk

--=-=-=
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable

It was <2021-08-17 wto 16:07>, when Krzysztof Kozlowski wrote:
> On 17/08/2021 14:34, Lukasz Stelmach wrote:
>> It was <2021-08-17 wto 12:05>, when Krzysztof Kozlowski wrote:
>>> On 17/08/2021 11:55, Lukasz Stelmach wrote:
>>>> It was <2021-08-11 =C5=9Bro 10:43>, when Krzysztof Kozlowski wrote:
>>>>> Convert Samsung Exynos SoC True Random Number Generator bindings to DT
>>>>> schema format using json-schema.
>>>>>
>>>>> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>
>>>>> ---
>>>>>  .../bindings/rng/samsung,exynos5250-trng.txt  | 17 -------
>>>>>  .../bindings/rng/samsung,exynos5250-trng.yaml | 44 +++++++++++++++++=
++
>>>>>  MAINTAINERS                                   |  2 +-
>>>>>  3 files changed, 45 insertions(+), 18 deletions(-)
>>>>>  delete mode 100644 Documentation/devicetree/bindings/rng/samsung,exy=
nos5250-trng.txt
>>>>>  create mode 100644 Documentation/devicetree/bindings/rng/samsung,exy=
nos5250-trng.yaml
>>>>>
>>>>> diff --git
>>>>> a/Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt
>>>>> b/Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt
>>>>> deleted file mode 100644
>>>>> index 5a613a4ec780..000000000000
>>>>> --- a/Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.t=
xt
>>>>> +++ /dev/null
>>>>> @@ -1,17 +0,0 @@
>>>>> -Exynos True Random Number Generator
>>>>> -
>>>>> -Required properties:
>>>>> -
>>>>> -- compatible  : Should be "samsung,exynos5250-trng".
>>>>> -- reg         : Specifies base physical address and size of the regi=
sters map.
>>>>> -- clocks      : Phandle to clock-controller plus clock-specifier pai=
r.
>>>>> -- clock-names : "secss" as a clock name.
>>>>> -
>>>>> -Example:
>>>>> -
>>>>> -	rng@10830600 {
>>>>> -		compatible =3D "samsung,exynos5250-trng";
>>>>> -		reg =3D <0x10830600 0x100>;
>>>>> -		clocks =3D <&clock CLK_SSS>;
>>>>> -		clock-names =3D "secss";
>>>>> -	};
>>>>> diff --git
>>>>> a/Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.yaml
>>>>> b/Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.yaml
>>>>> new file mode 100644
>>>>> index 000000000000..a50c34d5d199
>>>>> --- /dev/null
>>>>> +++ b/Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.y=
aml
>>>>> @@ -0,0 +1,44 @@
>>>>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
>>>>> +%YAML 1.2
>>>>> +---
>>>>> +$id:
>>>>> https://protect2.fireeye.com/v1/url?k=3Df38ca35b-ac179a0d-f38d2814-0c=
c47a31ce52-1faa1ecb65482b8a&q=3D1&e=3D8b3490f9-a5fc-4da0-b2ee-7b0aec781403&=
u=3Dhttp%3A%2F%2Fdevicetree.org%2Fschemas%2Frng%2Fsamsung%2Cexynos5250-trng=
.yaml%23
>>>>> +$schema:
>>>>> https://protect2.fireeye.com/v1/url?k=3D9409519d-cb9268cb-9408dad2-0c=
c47a31ce52-12394c4409905980&q=3D1&e=3D8b3490f9-a5fc-4da0-b2ee-7b0aec781403&=
u=3Dhttp%3A%2F%2Fdevicetree.org%2Fmeta-schemas%2Fcore.yaml%23
>>>>> +
>>>>> +title: Samsung Exynos SoC True Random Number Generator
>>>>> +
>>>>> +maintainers:
>>>>> +  - Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>
>>>>> +  - =C5=81ukasz Stelmach <l.stelmach@samsung.com>
>>>>> +
>>>>> +properties:
>>>>> +  compatible:
>>>>> +    const: samsung,exynos5250-trng
>>>>> +
>>>>> +  clocks:
>>>>> +    maxItems: 1
>>>>
>>>> How about copying description from above into the description: propert=
y?
>>>
>>> But what to copy? There is no description except generic clock bindings.
>>>
>>=20
>> The description that "was" in the txt file.
>
> But there was no description of fields except copy&paste of the core
> schema. Do you describe C code like:
>
> ...
> /* unsigned int is a integer number greater or equal 0 */
> unsigned int i;
> ...

I believe having descriptions for reg and clocks

>>>>> -- reg         : Specifies base physical address and size of the regi=
sters map.
>>>>> -- clocks      : Phandle to clock-controller plus clock-specifier pai=
r.

right next to properties' formal definitions is beneficial for anyone
browsing the YAML file. If you think otherwise, oh well, I am fine with
that.

=2D-=20
=C5=81ukasz Stelmach
Samsung R&D Institute Poland
Samsung Electronics

--=-=-=
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQEzBAEBCAAdFiEEXpuyqjq9kGEVr9UQsK4enJilgBAFAmEcNXQACgkQsK4enJil
gBDdVgf/T8FGoSclFmMA0UY0LD4A2cLtKIyg2z2DuF3Qxr3X9rURYRLxXvPf/T37
kwNa4Jiz4n+v/oDskk6B9u4VhalLpOfW8oCKPSKBwYkurStwdgPxbEQ3/veC+yRE
Kii4jxX8UF3e0Utx8ZuQ6N6sCWvi9hWTvM2wem8TYhtEcHxxE3u6VPc6yBX6fFtS
nKKENMHrCjE4eyCNFuyBlm6m5uSqZanClWjhS2UE0RB1UEULToEsToYUfPEpwyV5
sE1BO1OC4nbexCdyyBAt+hXjOKKL9bYP1q2q7YUInz77SFxooRBnxB3UabItPiDd
Bvk9LzNArYskZxHv6qpv6zK4ozOmVg==
=4+0h
-----END PGP SIGNATURE-----
--=-=-=--