Documentation/devicetree/bindings/display/sitronix,st7567.yaml

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/display/sitronix,st7567.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Sitronix ST7567 Display Controller

maintainers:
  - Javier Martinez Canillas <javierm@redhat.com>

description:
  Sitronix ST7567 is a driver and controller for monochrome
  dot matrix LCD panels.

allOf:
  - $ref: panel/panel-common.yaml#

properties:
  compatible:
    const: sitronix,st7567

  reg:
    maxItems: 1

  sitronix,inverted:
    type: boolean
    description:
      Display pixels are inverted, i.e. 0 is white and 1 is black.

  width-mm: true
  height-mm: true
  panel-timing: true

required:
  - compatible
  - reg
  - width-mm
  - height-mm
  - panel-timing

additionalProperties: false

examples:
  - |
    i2c {
        #address-cells = <1>;
        #size-cells = <0>;

        display@3f {
            compatible = "sitronix,st7567";
            reg = <0x3f>;
            width-mm = <37>;
            height-mm = <27>;

            panel-timing {
                hactive = <128>;
                vactive = <64>;
                hback-porch = <0>;
                vback-porch = <0>;
                clock-frequency = <0>;
                hfront-porch = <0>;
                hsync-len = <0>;
                vfront-porch = <0>;
                vsync-len = <0>;
            };
          };
     };