diff mbox series

[1/5] dt-bindgins: display: Add Apple pre-DCP display controller bindings

Message ID 20241124-adpdrm-v1-1-3191d8e6e49a@gmail.com (mailing list archive)
State New
Headers show
Series Driver for pre-DCP apple display controller. | expand

Commit Message

Sasha Finkelstein via B4 Relay Nov. 24, 2024, 10:29 p.m. UTC
From: Sasha Finkelstein <fnkl.kernel@gmail.com>

Add bindings for a secondary display controller present on certain
Apple laptops.

Signed-off-by: Sasha Finkelstein <fnkl.kernel@gmail.com>
---
 .../bindings/display/apple,display-pipe.yaml       | 59 ++++++++++++++++++++++
 .../bindings/display/panel/apple,summit.yaml       | 24 +++++++++
 2 files changed, 83 insertions(+)

Comments

Rob Herring Nov. 25, 2024, 2:06 a.m. UTC | #1
On Sun, 24 Nov 2024 23:29:24 +0100, Sasha Finkelstein wrote:
> Add bindings for a secondary display controller present on certain
> Apple laptops.
> 
> Signed-off-by: Sasha Finkelstein <fnkl.kernel@gmail.com>
> ---
>  .../bindings/display/apple,display-pipe.yaml       | 59 ++++++++++++++++++++++
>  .../bindings/display/panel/apple,summit.yaml       | 24 +++++++++
>  2 files changed, 83 insertions(+)
> 

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:
./Documentation/devicetree/bindings/display/apple,display-pipe.yaml:21:9: [warning] wrong indentation: expected 10 but found 8 (indentation)

dtschema/dtc warnings/errors:

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20241124-adpdrm-v1-1-3191d8e6e49a@gmail.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
Krzysztof Kozlowski Nov. 25, 2024, 7:45 a.m. UTC | #2
On Sun, Nov 24, 2024 at 11:29:24PM +0100, Sasha Finkelstein wrote:
> Add bindings for a secondary display controller present on certain
> Apple laptops.
> 
> Signed-off-by: Sasha Finkelstein <fnkl.kernel@gmail.com>
> ---
>  .../bindings/display/apple,display-pipe.yaml       | 59 ++++++++++++++++++++++
>  .../bindings/display/panel/apple,summit.yaml       | 24 +++++++++
>  2 files changed, 83 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/display/apple,display-pipe.yaml b/Documentation/devicetree/bindings/display/apple,display-pipe.yaml
> new file mode 100644
> index 0000000000000000000000000000000000000000..bd25ddc6e09dd636c0221c854e594113f6011866
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/display/apple,display-pipe.yaml

No, use fallback compatible as filename.

> @@ -0,0 +1,59 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/display/apple,display-pipe.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Apple pre-DCP display controller.
> +
> +maintainers:
> +  - asahi@lists.linux.dev
> +  - Sasha Finkelstein <fnkl.kernel@gmail.com>
> +
> +description: |

Drop |

> +  A secondary display controller used to drive the "touchbar" on certain
> +  Apple laptops.
> +
> +properties:
> +  compatible:
> +    items:
> +      - enum:
> +        - "apple,t8112-display-pipe"
> +        - "apple,t8103-display-pipe"
> +      - const: "apple,h7-display-pipe"


This wasn't tested... Drop all quotes. Do you see any file with quotes?
Why doing things entirely different than everyone else?

> +
> +  reg:
> +    minItems: 3

Drop

> +    maxItems: 3
> +
> +  reg-names:
> +    items:
> +      - const: be
> +      - const: fe
> +      - const: mipi
> +
> +  power-domains: true

List the items instead or maxItems: 1.

> +
> +  interrupts:
> +    minItems: 2

Drop

> +    maxItems: 2
> +
> +  interrupt-names:
> +    items:
> +      - const: be
> +      - const: fe
> +
> +  iommus: true


maxItems: 1

> +
> +  "#address-cells":
> +    const: 1
> +
> +  "#size-cells":
> +    const: 0
> +
> +additionalProperties: true

This cannot be true. Must be false.

> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts

This goes before additionalProperties.

Missing example: that's a strong NAK and prove that this could not be
even tested.

Do you see any device schema without example? No. Do not develop things
differently, Apple is not unique, special or exceptional.


> diff --git a/Documentation/devicetree/bindings/display/panel/apple,summit.yaml b/Documentation/devicetree/bindings/display/panel/apple,summit.yaml
> new file mode 100644
> index 0000000000000000000000000000000000000000..dc281c1f52c1ed07cc2f7f804dcfd2f3b4239d89
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/display/panel/apple,summit.yaml
> @@ -0,0 +1,24 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/display/panel/apple,summit.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Apple "Summit" display panel.
> +
> +maintainers:
> +  - asahi@lists.linux.dev
> +  - Sasha Finkelstein <fnkl.kernel@gmail.com>
> +
> +properties:
> +  compatible:
> +    const: apple,summit

No, too generic. Panels need much more properties, this is heavily
incomplete. See other panel bindings.

Best regards,
Krzysztof
Hector Martin Nov. 25, 2024, 2:14 p.m. UTC | #3
On 2024/11/25 16:45, Krzysztof Kozlowski wrote:
> On Sun, Nov 24, 2024 at 11:29:24PM +0100, Sasha Finkelstein wrote:
>> Add bindings for a secondary display controller present on certain
>> Apple laptops.
>>
>> Signed-off-by: Sasha Finkelstein <fnkl.kernel@gmail.com>
>> ---
>>  .../bindings/display/apple,display-pipe.yaml       | 59 ++++++++++++++++++++++
>>  .../bindings/display/panel/apple,summit.yaml       | 24 +++++++++
>>  2 files changed, 83 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/display/apple,display-pipe.yaml b/Documentation/devicetree/bindings/display/apple,display-pipe.yaml
>> new file mode 100644
>> index 0000000000000000000000000000000000000000..bd25ddc6e09dd636c0221c854e594113f6011866
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/display/apple,display-pipe.yaml
> 
> No, use fallback compatible as filename.
> 
>> @@ -0,0 +1,59 @@
>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/display/apple,display-pipe.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Apple pre-DCP display controller.
>> +
>> +maintainers:
>> +  - asahi@lists.linux.dev
>> +  - Sasha Finkelstein <fnkl.kernel@gmail.com>
>> +
>> +description: |
> 
> Drop |
> 
>> +  A secondary display controller used to drive the "touchbar" on certain
>> +  Apple laptops.
>> +
>> +properties:
>> +  compatible:
>> +    items:
>> +      - enum:
>> +        - "apple,t8112-display-pipe"
>> +        - "apple,t8103-display-pipe"
>> +      - const: "apple,h7-display-pipe"
> 
> 
> This wasn't tested... Drop all quotes. Do you see any file with quotes?
> Why doing things entirely different than everyone else?
> 
>> +
>> +  reg:
>> +    minItems: 3
> 
> Drop
> 
>> +    maxItems: 3
>> +
>> +  reg-names:
>> +    items:
>> +      - const: be
>> +      - const: fe
>> +      - const: mipi
>> +
>> +  power-domains: true
> 
> List the items instead or maxItems: 1.
> 
>> +
>> +  interrupts:
>> +    minItems: 2
> 
> Drop
> 
>> +    maxItems: 2
>> +
>> +  interrupt-names:
>> +    items:
>> +      - const: be
>> +      - const: fe
>> +
>> +  iommus: true
> 
> 
> maxItems: 1
> 
>> +
>> +  "#address-cells":
>> +    const: 1
>> +
>> +  "#size-cells":
>> +    const: 0
>> +
>> +additionalProperties: true
> 
> This cannot be true. Must be false.
> 
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - interrupts
> 
> This goes before additionalProperties.
> 
> Missing example: that's a strong NAK and prove that this could not be
> even tested.
> 
> Do you see any device schema without example? No. Do not develop things
> differently, Apple is not unique, special or exceptional.

Krzysztof, it is entirely possible to express this same feedback without
being condescending and rude. I'm pretty sure you can do better than this.

> 
> 
>> diff --git a/Documentation/devicetree/bindings/display/panel/apple,summit.yaml b/Documentation/devicetree/bindings/display/panel/apple,summit.yaml
>> new file mode 100644
>> index 0000000000000000000000000000000000000000..dc281c1f52c1ed07cc2f7f804dcfd2f3b4239d89
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/display/panel/apple,summit.yaml
>> @@ -0,0 +1,24 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/display/panel/apple,summit.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Apple "Summit" display panel.
>> +
>> +maintainers:
>> +  - asahi@lists.linux.dev
>> +  - Sasha Finkelstein <fnkl.kernel@gmail.com>
>> +
>> +properties:
>> +  compatible:
>> +    const: apple,summit
> 
> No, too generic. Panels need much more properties, this is heavily
> incomplete. See other panel bindings.
> 
> Best regards,
> Krzysztof
> 
> 
> 

- Hector
Krzysztof Kozlowski Nov. 25, 2024, 2:53 p.m. UTC | #4
On 25/11/2024 15:14, Hector Martin wrote:
>>> +
>>> +  "#address-cells":
>>> +    const: 1
>>> +
>>> +  "#size-cells":
>>> +    const: 0
>>> +
>>> +additionalProperties: true
>>
>> This cannot be true. Must be false.
>>
>>> +
>>> +required:
>>> +  - compatible
>>> +  - reg
>>> +  - interrupts
>>
>> This goes before additionalProperties.
>>
>> Missing example: that's a strong NAK and prove that this could not be
>> even tested.
>>
>> Do you see any device schema without example? No. Do not develop things
>> differently, Apple is not unique, special or exceptional.
> 
> Krzysztof, it is entirely possible to express this same feedback without
> being condescending and rude. I'm pretty sure you can do better than this.

Please kindly trim the replies from unnecessary context. It makes it
much easier to find new content.

Instead of patronizing, note that this was just pure observation - this
was done entirely than other bindings, which should be taken as an
example. Or example-schema should be taken as example... Pointing out
issues and inconsistencies is not rude or condescending. Basically now
you are condescending people's feedback which further restricts review
process allowing comments which you approve.

You got here one day review, enjoy that.

Best regards,
Krzysztof
Hector Martin Nov. 25, 2024, 3:29 p.m. UTC | #5
On 2024/11/25 23:53, Krzysztof Kozlowski wrote:
> On 25/11/2024 15:14, Hector Martin wrote:
>>>> +
>>>> +  "#address-cells":
>>>> +    const: 1
>>>> +
>>>> +  "#size-cells":
>>>> +    const: 0
>>>> +
>>>> +additionalProperties: true
>>>
>>> This cannot be true. Must be false.
>>>
>>>> +
>>>> +required:
>>>> +  - compatible
>>>> +  - reg
>>>> +  - interrupts
>>>
>>> This goes before additionalProperties.
>>>
>>> Missing example: that's a strong NAK and prove that this could not be
>>> even tested.
>>>
>>> Do you see any device schema without example? No. Do not develop things
>>> differently, Apple is not unique, special or exceptional.
>>
>> Krzysztof, it is entirely possible to express this same feedback without
>> being condescending and rude. I'm pretty sure you can do better than this.
> 
> Please kindly trim the replies from unnecessary context. It makes it
> much easier to find new content.

Noted.
 > Instead of patronizing, note that this was just pure observation - this
> was done entirely than other bindings, which should be taken as an
> example. Or example-schema should be taken as example... Pointing out
> issues and inconsistencies is not rude or condescending. Basically now
> you are condescending people's feedback which further restricts review
> process allowing comments which you approve.
> 

No, that was certainly not pure observation. The observation is that the
schema was inconsistent with other schemas, and was missing an example.
The way you *expressed* that observation was unnecessarily rude and
condescending, both in tone and message. Usage of "NAK" is strongly
confrontational and discouraging to newcomers, and completely
inappropriate here because the intent of the patch is clearly fine and
it just needs some style and procedural issues fixed. "Do you ...? No."
wording is condescending, like you're talking down to a child. The
gratuitous Apple reference is completely unnecessary, implying we're
attempting to be a special snowflake in any (non-technically-justified)
way, never mind that none of us works nor has any professional
relationship with Apple.

Your observation and feedback could have been conveyed much more
appropriately, kindly, and effectively, such as:

==
The schema is missing an example. Examples are required for schemas, as
they are part of how the schema is tested by the automated tooling.
Please see other schemas and `example-schema.yaml` for examples on how
to do this, and `writing-schema.rst` for more information and how to run
the checks.
==

- Hector
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/display/apple,display-pipe.yaml b/Documentation/devicetree/bindings/display/apple,display-pipe.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..bd25ddc6e09dd636c0221c854e594113f6011866
--- /dev/null
+++ b/Documentation/devicetree/bindings/display/apple,display-pipe.yaml
@@ -0,0 +1,59 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/display/apple,display-pipe.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Apple pre-DCP display controller.
+
+maintainers:
+  - asahi@lists.linux.dev
+  - Sasha Finkelstein <fnkl.kernel@gmail.com>
+
+description: |
+  A secondary display controller used to drive the "touchbar" on certain
+  Apple laptops.
+
+properties:
+  compatible:
+    items:
+      - enum:
+        - "apple,t8112-display-pipe"
+        - "apple,t8103-display-pipe"
+      - const: "apple,h7-display-pipe"
+
+  reg:
+    minItems: 3
+    maxItems: 3
+
+  reg-names:
+    items:
+      - const: be
+      - const: fe
+      - const: mipi
+
+  power-domains: true
+
+  interrupts:
+    minItems: 2
+    maxItems: 2
+
+  interrupt-names:
+    items:
+      - const: be
+      - const: fe
+
+  iommus: true
+
+  "#address-cells":
+    const: 1
+
+  "#size-cells":
+    const: 0
+
+additionalProperties: true
+
+required:
+  - compatible
+  - reg
+  - interrupts
diff --git a/Documentation/devicetree/bindings/display/panel/apple,summit.yaml b/Documentation/devicetree/bindings/display/panel/apple,summit.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..dc281c1f52c1ed07cc2f7f804dcfd2f3b4239d89
--- /dev/null
+++ b/Documentation/devicetree/bindings/display/panel/apple,summit.yaml
@@ -0,0 +1,24 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/display/panel/apple,summit.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Apple "Summit" display panel.
+
+maintainers:
+  - asahi@lists.linux.dev
+  - Sasha Finkelstein <fnkl.kernel@gmail.com>
+
+properties:
+  compatible:
+    const: apple,summit
+
+  reg:
+    maxItems: 1
+
+additionalProperties: false
+
+required:
+  - compatible
+  - reg