xref: /freebsd/sys/contrib/device-tree/Bindings/display/ssd1307fb.txt (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1* Solomon SSD1307 Framebuffer Driver
2
3Required 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
16Optional 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  - solomon,dclk-div: Clock divisor 1 to 16
31  - solomon,dclk-frq: Clock frequency 0 to 15, higher value means higher
32                      frequency
33  - solomon,lookup-table: 8 bit value array of current drive pulse widths for
34                          BANK0, and colors A, B, and C. Each value in range
35                          of 31 to 63 for pulse widths of 32 to 64. Color D
36                          is always width 64.
37  - solomon,area-color-enable: Display uses color mode
38  - solomon,low-power. Display runs in low power mode
39
40[0]: Documentation/devicetree/bindings/pwm/pwm.txt
41
42Examples:
43ssd1307: oled@3c {
44        compatible = "solomon,ssd1307fb-i2c";
45        reg = <0x3c>;
46        pwms = <&pwm 4 3000>;
47        reset-gpios = <&gpio2 7>;
48};
49
50ssd1306: oled@3c {
51        compatible = "solomon,ssd1306fb-i2c";
52        reg = <0x3c>;
53        pwms = <&pwm 4 3000>;
54        reset-gpios = <&gpio2 7>;
55        solomon,com-lrremap;
56        solomon,com-invdir;
57        solomon,com-offset = <32>;
58        solomon,lookup-table = /bits/ 8 <0x3f 0x3f 0x3f 0x3f>;
59};
60