diff mbox series

[2/5] dt-bindings: panel: add documentation for oneplus6 panel

Message ID 20201007174736.292968-3-caleb@connolly.tech (mailing list archive)
State New, archived
Headers show
Series [1/5] drm/panel/oneplus6: Add panel-oneplus6 | expand

Commit Message

Caleb Connolly Oct. 7, 2020, 5:49 p.m. UTC 
Document the OnePlus 6/T common panel driver, example from
arch/arm64/boot/dts/qcom/sdm845-oneplus-common.dtsi

Signed-off-by: Caleb Connolly <caleb@connolly.tech>
---
 .../display/panel/panel-oneplus6.yaml         | 73 +++++++++++++++++++
 1 file changed, 73 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/display/panel/panel-oneplus6.yaml

Comments

Rob Herring Oct. 9, 2020, 2:02 p.m. UTC | #1 
On Wed, 07 Oct 2020 17:49:14 +0000, Caleb Connolly wrote:
> Document the OnePlus 6/T common panel driver, example from
> arch/arm64/boot/dts/qcom/sdm845-oneplus-common.dtsi
> 
> Signed-off-by: Caleb Connolly <caleb@connolly.tech>
> ---
>  .../display/panel/panel-oneplus6.yaml         | 73 +++++++++++++++++++
>  1 file changed, 73 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/display/panel/panel-oneplus6.yaml
> 


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

Error: Documentation/devicetree/bindings/display/panel/panel-oneplus6.example.dts:19.9-14 syntax error
FATAL ERROR: Unable to parse input tree
make[1]: *** [scripts/Makefile.lib:342: Documentation/devicetree/bindings/display/panel/panel-oneplus6.example.dt.yaml] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:1366: dt_binding_check] Error 2


See https://patchwork.ozlabs.org/patch/1378187

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

pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade

Please check and re-submit.
Rob Herring Oct. 9, 2020, 2:05 p.m. UTC | #2 
On Wed, Oct 07, 2020 at 05:49:14PM +0000, Caleb Connolly wrote:
> Document the OnePlus 6/T common panel driver, example from
> arch/arm64/boot/dts/qcom/sdm845-oneplus-common.dtsi
> 
> Signed-off-by: Caleb Connolly <caleb@connolly.tech>
> ---
>  .../display/panel/panel-oneplus6.yaml         | 73 +++++++++++++++++++
>  1 file changed, 73 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/display/panel/panel-oneplus6.yaml
> 
> diff --git a/Documentation/devicetree/bindings/display/panel/panel-oneplus6.yaml b/Documentation/devicetree/bindings/display/panel/panel-oneplus6.yaml
> new file mode 100644
> index 000000000000..23ba369cc2f5
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/display/panel/panel-oneplus6.yaml
> @@ -0,0 +1,73 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/display/panel/panel-oneplus6.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: OnePlus 6/T panel driver
> +
> +description: |
> +  The OnePlus 6 panel driver encompasses the display panels found in the
> +  OnePlus 6 and 6T devices, the panels have almost identical behaviour and
> +  are not used by any other devices.
> +
> +maintainers:
> +  - Caleb Connolly <caleb@connolly.tech>
> +
> +allOf:
> +  - $ref: panel-common.yaml#
> +
> +properties:
> +  compatible:
> +    enum:
> +      - samsung,sofef00
> +      - samsung,s6e3fc2x01
> +
> +  reg: true
> +  reset-gpios: true
> +  port: true
> +
> +  vddio-supply:
> +    description: VDDIO regulator

A panel with a single supply can use panel-simple-dsi.yaml.

'reset-gpios' was missing, but has been added recently.

Rob
Caleb Connolly Oct. 18, 2020, 12:33 p.m. UTC | #3 
On 2020-10-09 15:05, Rob Herring wrote:
> On Wed, Oct 07, 2020 at 05:49:14PM +0000, Caleb Connolly wrote:
>> Document the OnePlus 6/T common panel driver, example from
>> arch/arm64/boot/dts/qcom/sdm845-oneplus-common.dtsi
>>
>> Signed-off-by: Caleb Connolly <caleb@connolly.tech>
>> ---
>>   .../display/panel/panel-oneplus6.yaml         | 73 +++++++++++++++++++
>>   1 file changed, 73 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/display/panel/panel-oneplus6.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/display/panel/panel-oneplus6.yaml b/Documentation/devicetree/bindings/display/panel/panel-oneplus6.yaml
>> new file mode 100644
>> index 000000000000..23ba369cc2f5
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/display/panel/panel-oneplus6.yaml
>> @@ -0,0 +1,73 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/display/panel/panel-oneplus6.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: OnePlus 6/T panel driver
>> +
>> +description: |
>> +  The OnePlus 6 panel driver encompasses the display panels found in the
>> +  OnePlus 6 and 6T devices, the panels have almost identical behaviour and
>> +  are not used by any other devices.
>> +
>> +maintainers:
>> +  - Caleb Connolly <caleb@connolly.tech>
>> +
>> +allOf:
>> +  - $ref: panel-common.yaml#
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - samsung,sofef00
>> +      - samsung,s6e3fc2x01
>> +
>> +  reg: true
>> +  reset-gpios: true
>> +  port: true
>> +
>> +  vddio-supply:
>> +    description: VDDIO regulator
> A panel with a single supply can use panel-simple-dsi.yaml.
>
> 'reset-gpios' was missing, but has been added recently.
>
> Rob

Thanks, I'll move docs into panel-simple-dsi.yaml

Caleb
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/display/panel/panel-oneplus6.yaml b/Documentation/devicetree/bindings/display/panel/panel-oneplus6.yaml
new file mode 100644
index 000000000000..23ba369cc2f5
--- /dev/null
+++ b/Documentation/devicetree/bindings/display/panel/panel-oneplus6.yaml
@@ -0,0 +1,73 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/display/panel/panel-oneplus6.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: OnePlus 6/T panel driver
+
+description: |
+  The OnePlus 6 panel driver encompasses the display panels found in the
+  OnePlus 6 and 6T devices, the panels have almost identical behaviour and
+  are not used by any other devices.
+
+maintainers:
+  - Caleb Connolly <caleb@connolly.tech>
+
+allOf:
+  - $ref: panel-common.yaml#
+
+properties:
+  compatible:
+    enum:
+      - samsung,sofef00
+      - samsung,s6e3fc2x01
+
+  reg: true
+  reset-gpios: true
+  port: true
+
+  vddio-supply:
+    description: VDDIO regulator
+
+required:
+  - compatible
+  - reset-gpios
+  - vddio-supply
+  - port
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    &dsi0 {
+      status = "okay";
+      vdda-supply = <&vdda_mipi_dsi0_1p2>;
+
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      display_panel: panel@0 {
+        status = "okay";
+        compatible = "samsung,sofef00";
+
+        #address-cells = <1>;
+        #size-cells = <0>;
+        reg = <0>;
+
+        vddio-supply = <&vreg_l14a_1p88>;
+
+        reset-gpios = <&tlmm 6 GPIO_ACTIVE_HIGH>;
+
+        pinctrl-names = "default";
+        pinctrl-0 = <&panel_reset_pins &panel_te_pin &panel_esd_pin>;
+
+        port {
+          panel_in: endpoint {
+            remote-endpoint = <&dsi0_out>;
+          };
+        };
+      };
+    };
+
+...