GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / display / ssd1307fb.txt
1 * Solomon SSD1307 Framebuffer Driver
2
3 Required properties:
4   - compatible: Should be "solomon,<chip>fb-<bus>". The only supported bus for
5     now is i2c, and the supported chips are ssd1305, ssd1306, ssd1307 and
6     ssd1309.
7   - reg: Should contain address of the controller on the I2C bus. Most likely
8          0x3c or 0x3d
9   - pwm: Should contain the pwm to use according to the OF device tree PWM
10          specification [0]. Only required for the ssd1307.
11   - solomon,height: Height in pixel of the screen driven by the controller
12   - solomon,width: Width in pixel of the screen driven by the controller
13   - solomon,page-offset: Offset of pages (band of 8 pixels) that the screen is
14     mapped to.
15
16 Optional properties:
17   - reset-gpios: The GPIO used to reset the OLED display, if available. See
18                  Documentation/devicetree/bindings/gpio/gpio.txt for details.
19   - vbat-supply: The supply for VBAT
20   - solomon,segment-no-remap: Display needs normal (non-inverted) data column
21                               to segment mapping
22   - solomon,com-seq: Display uses sequential COM pin configuration
23   - solomon,com-lrremap: Display uses left-right COM pin remap
24   - solomon,com-invdir: Display uses inverted COM pin scan direction
25   - solomon,com-offset: Number of the COM pin wired to the first display line
26   - solomon,prechargep1: Length of deselect period (phase 1) in clock cycles.
27   - solomon,prechargep2: Length of precharge period (phase 2) in clock cycles.
28                          This needs to be the higher, the higher the capacitance
29                          of the OLED's pixels is
30
31 [0]: Documentation/devicetree/bindings/pwm/pwm.txt
32
33 Examples:
34 ssd1307: oled@3c {
35         compatible = "solomon,ssd1307fb-i2c";
36         reg = <0x3c>;
37         pwms = <&pwm 4 3000>;
38         reset-gpios = <&gpio2 7>;
39         reset-active-low;
40 };
41
42 ssd1306: oled@3c {
43         compatible = "solomon,ssd1306fb-i2c";
44         reg = <0x3c>;
45         pwms = <&pwm 4 3000>;
46         reset-gpios = <&gpio2 7>;
47         reset-active-low;
48         solomon,com-lrremap;
49         solomon,com-invdir;
50         solomon,com-offset = <32>;
51 };