xref: /linux/Documentation/devicetree/bindings/display/mayqueen,pixpaper.yaml (revision d30c1683aaecb93d2ab95685dc4300a33d3cea7a) 
1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/display/mayqueen,pixpaper.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Mayqueen Pixpaper e-ink display panel
8
9maintainers:
10  - LiangCheng Wang <zaq14760@gmail.com>
11
12description:
13  The Pixpaper is an e-ink display panel controlled via an SPI interface.
14  The panel has a resolution of 122x250 pixels and requires GPIO pins for
15  reset, busy, and data/command control.
16
17allOf:
18  - $ref: /schemas/spi/spi-peripheral-props.yaml#
19
20properties:
21  compatible:
22    const: mayqueen,pixpaper
23
24  reg:
25    maxItems: 1
26
27  spi-max-frequency:
28    maximum: 1000000
29    default: 1000000
30
31  reset-gpios:
32    maxItems: 1
33
34  busy-gpios:
35    maxItems: 1
36
37  dc-gpios:
38    maxItems: 1
39
40required:
41  - compatible
42  - reg
43  - reset-gpios
44  - busy-gpios
45  - dc-gpios
46
47unevaluatedProperties: false
48
49examples:
50  - |
51    #include <dt-bindings/gpio/gpio.h>
52    spi {
53        #address-cells = <1>;
54        #size-cells = <0>;
55        display@0 {
56            compatible = "mayqueen,pixpaper";
57            reg = <0>;
58            spi-max-frequency = <1000000>;
59            reset-gpios = <&gpio1 17 GPIO_ACTIVE_HIGH>;
60            busy-gpios = <&gpio1 18 GPIO_ACTIVE_HIGH>;
61            dc-gpios = <&gpio1 19 GPIO_ACTIVE_HIGH>;
62        };
63    };
64