diff mbox series

dt-bindings: mips: lantiq: Document Lantiq SoC dt bindings

Message ID 20230326122942.870990-1-olek2@wp.pl (mailing list archive)
State Changes Requested
Headers show
Series dt-bindings: mips: lantiq: Document Lantiq SoC dt bindings | expand

Commit Message

Aleksander Jan Bajkowski March 26, 2023, 12:29 p.m. UTC 
Document the legacy Lantiq device tree bindings.
Compatible strings for xRX100 (ar9) and newer SoCs
should be renamed and will be added later.

Signed-off-by: Aleksander Jan Bajkowski <olek2@wp.pl>
---
 .../devicetree/bindings/mips/lantiq/soc.yaml  | 38 +++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mips/lantiq/soc.yaml

Comments

Krzysztof Kozlowski March 26, 2023, 2:54 p.m. UTC | #1 
On 26/03/2023 14:29, Aleksander Jan Bajkowski wrote:
> Document the legacy Lantiq device tree bindings.

This suggests you are documenting existing compatibles, but I do not see
them at all. Confusing.

> Compatible strings for xRX100 (ar9) and newer SoCs

Please wrap commit message according to Linux coding style / submission
process (neither too early nor over the limit):
https://elixir.bootlin.com/linux/v5.18-rc4/source/Documentation/process/submitting-patches.rst#L586

> should be renamed and will be added later.

Subject: drop second/last, redundant "dt bindings". The "dt-bindings"
prefix is already stating that these are bindings.

> 
> Signed-off-by: Aleksander Jan Bajkowski <olek2@wp.pl>
> ---
>  .../devicetree/bindings/mips/lantiq/soc.yaml  | 38 +++++++++++++++++++
>  1 file changed, 38 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mips/lantiq/soc.yaml
> 
> diff --git a/Documentation/devicetree/bindings/mips/lantiq/soc.yaml b/Documentation/devicetree/bindings/mips/lantiq/soc.yaml
> new file mode 100644
> index 000000000000..90e8148b111b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mips/lantiq/soc.yaml
> @@ -0,0 +1,38 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/mips/lantiq/soc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Lantiq SoC based Platform
> +
> +maintainers:
> +  - Aleksander Jan Bajkowski <olek2@wp.pl>
> +
> +description:
> +  Devices with a Lantiq CPU shall have the following properties.
> +
> +properties:
> +  $nodename:
> +    const: "/"
> +  compatible:
> +    oneOf:
> +      - description: Boards with Lantiq Amazon-SE SoC
> +        items:
> +          - const: lantiq,ase

This does not look like proper board compatible. Boards have almost
always minimum two compatibles - one for SoC and one for board. With
commit msg this just adds to confusion...


Best regards,
Krzysztof
Aleksander Jan Bajkowski March 27, 2023, 9:21 p.m. UTC | #2 
Hi Krzysztof,


On 26.03.2023 16:54, Krzysztof Kozlowski wrote:
> On 26/03/2023 14:29, Aleksander Jan Bajkowski wrote:
>> Document the legacy Lantiq device tree bindings.
> This suggests you are documenting existing compatibles, but I do not see
> them at all. Confusing.

The added compatible strings can be found in:
- arch/mips/lantiq/xway/sysctrl.c,
- arch/mips/lantiq/falcon/prom.c,
- arch/mips/lantiq/xway/prom.c.

Upstream only has one dts for danube development board. More dts
can be found in OpenWRT [1]. I have a bunch of these devices and
intend to send dts files upstream.

>
>> Compatible strings for xRX100 (ar9) and newer SoCs
> Please wrap commit message according to Linux coding style / submission
> process (neither too early nor over the limit):
> https://elixir.bootlin.com/linux/v5.18-rc4/source/Documentation/process/submitting-patches.rst#L586


Will be fixed in v2.


>> should be renamed and will be added later.
> Subject: drop second/last, redundant "dt bindings". The "dt-bindings"
> prefix is already stating that these are bindings.


Will be fixed in v2.


>
>> Signed-off-by: Aleksander Jan Bajkowski <olek2@wp.pl>
>> ---
>>  .../devicetree/bindings/mips/lantiq/soc.yaml  | 38 +++++++++++++++++++
>>  1 file changed, 38 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/mips/lantiq/soc.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/mips/lantiq/soc.yaml b/Documentation/devicetree/bindings/mips/lantiq/soc.yaml
>> new file mode 100644
>> index 000000000000..90e8148b111b
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/mips/lantiq/soc.yaml
>> @@ -0,0 +1,38 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/mips/lantiq/soc.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Lantiq SoC based Platform
>> +
>> +maintainers:
>> +  - Aleksander Jan Bajkowski <olek2@wp.pl>
>> +
>> +description:
>> +  Devices with a Lantiq CPU shall have the following properties.
>> +
>> +properties:
>> +  $nodename:
>> +    const: "/"
>> +  compatible:
>> +    oneOf:
>> +      - description: Boards with Lantiq Amazon-SE SoC
>> +        items:
>> +          - const: lantiq,ase
> This does not look like proper board compatible. Boards have almost
> always minimum two compatibles - one for SoC and one for board. With
> commit msg this just adds to confusion...
>

The added dt-binding contains only the SoC part. The compatible strings
for individual boards will be added later together with the dts files. Before
sending the dts files I want to document current bindings and clear
checkpach warnings about undocumented strings.


> Best regards,
> Krzysztof
>

1. https://github.com/openwrt/openwrt/tree/master/target/linux/lantiq/files/arch/mips/boot/dts/lantiq


Best Regards,
Aleksander
Krzysztof Kozlowski March 28, 2023, 6:32 a.m. UTC | #3 
On 27/03/2023 23:21, Aleksander Bajkowski wrote:
>>> +properties:
>>> +  $nodename:
>>> +    const: "/"
>>> +  compatible:
>>> +    oneOf:
>>> +      - description: Boards with Lantiq Amazon-SE SoC
>>> +        items:
>>> +          - const: lantiq,ase
>> This does not look like proper board compatible. Boards have almost
>> always minimum two compatibles - one for SoC and one for board. With
>> commit msg this just adds to confusion...
>>
> 
> The added dt-binding contains only the SoC part. The compatible strings
> for individual boards will be added later together with the dts files. Before
> sending the dts files I want to document current bindings and clear
> checkpach warnings about undocumented strings.

Which is incomplete and inaccurate documentation. Instead, document
proper, full compatibles.

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/mips/lantiq/soc.yaml b/Documentation/devicetree/bindings/mips/lantiq/soc.yaml
new file mode 100644
index 000000000000..90e8148b111b
--- /dev/null
+++ b/Documentation/devicetree/bindings/mips/lantiq/soc.yaml
@@ -0,0 +1,38 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mips/lantiq/soc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Lantiq SoC based Platform
+
+maintainers:
+  - Aleksander Jan Bajkowski <olek2@wp.pl>
+
+description:
+  Devices with a Lantiq CPU shall have the following properties.
+
+properties:
+  $nodename:
+    const: "/"
+  compatible:
+    oneOf:
+      - description: Boards with Lantiq Amazon-SE SoC
+        items:
+          - const: lantiq,ase
+
+      - description: Boards with Lantiq Danube SoC
+        items:
+          - const: lantiq,danube
+
+      - description: Boards with Lantiq Falcon SoC
+        items:
+          - const: lantiq,falcon
+
+      - description: Boards with Lantiq Twinpass SoC
+        items:
+          - const: lantiq,twinpass
+
+additionalProperties: true
+
+...