Re: [PATCH v2 2/2] dt-bindings: soc: add loongson2 guts

From: Krzysztof Kozlowski
Date: Tue Oct 25 2022 - 15:40:34 EST


On 24/10/2022 23:51, Yinbo Zhu wrote:
> Add the loongson2 soc guts driver binding with DT schema format
> using json-schema.
>
> Signed-off-by: Yinbo Zhu <zhuyinbo@xxxxxxxxxxx>
> ---
> .../soc/loongson/loongson,ls2k-guts.yaml | 37 +++++++++++++++++++

Looks like wrong location, although difficult to judge because you did
not describe the hardware at all. If this is chipinfo-like device, then
Documentation/devicetree/bindings/hwinfo/.


> MAINTAINERS | 1 +
> 2 files changed, 38 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/soc/loongson/loongson,ls2k-guts.yaml
>
> diff --git a/Documentation/devicetree/bindings/soc/loongson/loongson,ls2k-guts.yaml b/Documentation/devicetree/bindings/soc/loongson/loongson,ls2k-guts.yaml
> new file mode 100644
> index 000000000000..2502f8aeb74d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/soc/loongson/loongson,ls2k-guts.yaml
> @@ -0,0 +1,37 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/soc/loongson/loongson,ls2k-guts.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Loongson2 GUTS driver.

Drop "driver." unless you refer to some hardware (like motor driver?).

> +
> +maintainers:
> + - Yinbo Zhu <zhuyinbo@xxxxxxxxxxx>
> +
> +description: |
> + GUTS driver was to manage and access global utilities block. Initially

Drop "driver" and describe instead what is GUTS, including its acronym,

> + only reading SVR and registering soc device are supported.

Entire sentence describe Linux driver - drop it. Instead describe the
device, the hardware.

> +
> +properties:
> + compatible:
> + const: loongson,ls2k-guts
> +
> + reg:
> + maxItems: 1
> +
> + little-endian: true
> +
> +required:
> + - compatible
> + - reg
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + guts: guts@1fe00000 {

Node names should be generic.
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation


Best regards,
Krzysztof