Add documentation for "novatek,nt35596s" panel.
Signed-off-by: MollySophia <[email protected]>
---
.../display/panel/novatek,nt35596s.yaml | 83 +++++++++++++++++++
1 file changed, 83 insertions(+)
create mode 100644 Documentation/devicetree/bindings/display/panel/novatek,nt35596s.yaml
diff --git a/Documentation/devicetree/bindings/display/panel/novatek,nt35596s.yaml b/Documentation/devicetree/bindings/display/panel/novatek,nt35596s.yaml
new file mode 100644
index 000000000000..f724f101a6fd
--- /dev/null
+++ b/Documentation/devicetree/bindings/display/panel/novatek,nt35596s.yaml
@@ -0,0 +1,83 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/display/panel/novatek,nt35596s.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Novatek NT35596S based DSI display Panels
+
+maintainers:
+ - Molly Sophia <[email protected]>
+
+description: |
+ The nt35596s IC from Novatek is a generic DSI Panel IC used to drive dsi
+ panels.
+ Right now, support is added only for a JDI FHD+ LCD display panel with a
+ resolution of 1080x2160. It is a video mode DSI panel.
+
+allOf:
+ - $ref: panel-common.yaml#
+
+properties:
+ compatible:
+ items:
+ - enum:
+ - jdi,fhd-nt35596s
+ - const: novatek,nt35596s
+ description: This indicates the panel manufacturer of the panel that is
+ in turn using the NT35596S panel driver. This compatible string
+ determines how the NT35596S panel driver is configured for the indicated
+ panel. The novatek,nt35596s compatible shall always be provided as a fallback.
+
+ vddi0-supply:
+ description: regulator that provides the supply voltage
+ Power IC supply
+
+ vddpos-supply:
+ description: positive boost supply regulator
+
+ vddneg-supply:
+ description: negative boost supply regulator
+
+ reg: true
+ port: true
+ backlight: true
+
+required:
+ - compatible
+ - reg
+ - vddi0-supply
+ - vddpos-supply
+ - vddneg-supply
+ - reset-gpios
+ - port
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+
+ dsi {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ panel@0 {
+ compatible = "jdi,fhd-nt35596s", "novatek,nt35596s";
+ reg = <0>;
+ vddi0-supply = <&vreg_l14a_1p88>;
+ vddpos-supply = <&lab>;
+ vddneg-supply = <&ibb>;
+
+ backlight = <&pmi8998_wled>;
+ reset-gpios = <&tlmm 6 GPIO_ACTIVE_HIGH>;
+
+ port {
+ jdi_nt35596s_in_0: endpoint {
+ remote-endpoint = <&dsi0_out>;
+ };
+ };
+ };
+ };
+
+...
--
2.37.0
On 09/07/2022 16:04, MollySophia wrote:
> Add documentation for "novatek,nt35596s" panel.
>
> Signed-off-by: MollySophia <[email protected]>
> ---
> .../display/panel/novatek,nt35596s.yaml | 83 +++++++++++++++++++
> 1 file changed, 83 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/display/panel/novatek,nt35596s.yaml
>
> diff --git a/Documentation/devicetree/bindings/display/panel/novatek,nt35596s.yaml b/Documentation/devicetree/bindings/display/panel/novatek,nt35596s.yaml
> new file mode 100644
> index 000000000000..f724f101a6fd
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/display/panel/novatek,nt35596s.yaml
> @@ -0,0 +1,83 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/display/panel/novatek,nt35596s.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Novatek NT35596S based DSI display Panels
> +
> +maintainers:
> + - Molly Sophia <[email protected]>
> +
> +description: |
> + The nt35596s IC from Novatek is a generic DSI Panel IC used to drive dsi
> + panels.
> + Right now, support is added only for a JDI FHD+ LCD display panel with a
> + resolution of 1080x2160. It is a video mode DSI panel.
> +
> +allOf:
> + - $ref: panel-common.yaml#
> +
> +properties:
> + compatible:
> + items:
> + - enum:
> + - jdi,fhd-nt35596s
> + - const: novatek,nt35596s
You need to document the novatek and idi vendor prefix in vendor-prefixes.
> + description: This indicates the panel manufacturer of the panel that is
> + in turn using the NT35596S panel driver. This compatible string
> + determines how the NT35596S panel driver is configured for the indicated
> + panel. The novatek,nt35596s compatible shall always be provided as a fallback.
Drop description, it does not make sense and last sentence duplicates
the schema.
> +
> + vddi0-supply:
> + description: regulator that provides the supply voltage
> + Power IC supply
"regulator that provides the supply voltage" is redundant, drop it.
Instead what is it supplying?
> +
> + vddpos-supply:
> + description: positive boost supply regulator
> +
> + vddneg-supply:
> + description: negative boost supply regulator
> +
> + reg: true
Any reg is accepted or is there only one reg? Does it come from other
schema?
Best regards,
Krzysztof