eb31ed47a2834ceccc16f2f029e8f69f22b39e15
[platform/kernel/linux-rpi.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   - reset-gpios: Should contain the GPIO used to reset the OLED display
12   - solomon,height: Height in pixel of the screen driven by the controller
13   - solomon,width: Width in pixel of the screen driven by the controller
14   - solomon,page-offset: Offset of pages (band of 8 pixels) that the screen is
15     mapped to.
16
17 Optional properties:
18   - reset-active-low: Is the reset gpio is active on physical low?
19   - solomon,segment-no-remap: Display needs normal (non-inverted) data column
20                               to segment mapping
21   - solomon,com-seq: Display uses sequential COM pin configuration
22   - solomon,com-lrremap: Display uses left-right COM pin remap
23   - solomon,com-invdir: Display uses inverted COM pin scan direction
24   - solomon,com-offset: Number of the COM pin wired to the first display line
25   - solomon,prechargep1: Length of deselect period (phase 1) in clock cycles.
26   - solomon,prechargep2: Length of precharge period (phase 2) in clock cycles.
27                          This needs to be the higher, the higher the capacitance
28                          of the OLED's pixels is
29
30 [0]: Documentation/devicetree/bindings/pwm/pwm.txt
31
32 Examples:
33 ssd1307: oled@3c {
34         compatible = "solomon,ssd1307fb-i2c";
35         reg = <0x3c>;
36         pwms = <&pwm 4 3000>;
37         reset-gpios = <&gpio2 7>;
38         reset-active-low;
39 };
40
41 ssd1306: oled@3c {
42         compatible = "solomon,ssd1306fb-i2c";
43         reg = <0x3c>;
44         pwms = <&pwm 4 3000>;
45         reset-gpios = <&gpio2 7>;
46         reset-active-low;
47         solomon,com-lrremap;
48         solomon,com-invdir;
49         solomon,com-offset = <32>;
50 };