Fix a handful of audit-related issue
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / display / panel / tpo,tpg110.txt
1 TPO TPG110 Panel
2 ================
3
4 This panel driver is a component that acts as an intermediary
5 between an RGB output and a variety of panels. The panel
6 driver is strapped up in electronics to the desired resolution
7 and other properties, and has a control interface over 3WIRE
8 SPI. By talking to the TPG110 over SPI, the strapped properties
9 can be discovered and the hardware is therefore mostly
10 self-describing.
11
12        +--------+
13 SPI -> |  TPO   | -> physical display
14 RGB -> | TPG110 |
15        +--------+
16
17 If some electrical strap or alternate resolution is desired,
18 this can be set up by taking software control of the display
19 over the SPI interface. The interface can also adjust
20 for properties of the display such as gamma correction and
21 certain electrical driving levels.
22
23 The TPG110 does not know the physical dimensions of the panel
24 connected, so this needs to be specified in the device tree.
25
26 It requires a GPIO line for control of its reset line.
27
28 The serial protocol has line names that resemble I2C but the
29 protocol is not I2C but 3WIRE SPI.
30
31 Required properties:
32 - compatible : one of:
33   "ste,nomadik-nhk15-display", "tpo,tpg110"
34   "tpo,tpg110"
35 - grestb-gpios : panel reset GPIO
36 - width-mm : see display/panel/panel-common.txt
37 - height-mm : see display/panel/panel-common.txt
38
39 The device needs to be a child of an SPI bus, see
40 spi/spi-bus.txt. The SPI child must set the following
41 properties:
42 - spi-3wire
43 - spi-max-frequency = <3000000>;
44 as these are characteristics of this device.
45
46 The device node can contain one 'port' child node with one child
47 'endpoint' node, according to the bindings defined in
48 media/video-interfaces.txt. This node should describe panel's video bus.
49
50 Example
51 -------
52
53 panel: display@0 {
54         compatible = "tpo,tpg110";
55         reg = <0>;
56         spi-3wire;
57         /* 320 ns min period ~= 3 MHz */
58         spi-max-frequency = <3000000>;
59         /* Width and height from data sheet */
60         width-mm = <116>;
61         height-mm = <87>;
62         grestb-gpios = <&foo_gpio 5 GPIO_ACTIVE_LOW>;
63         backlight = <&bl>;
64
65         port {
66                 nomadik_clcd_panel: endpoint {
67                         remote-endpoint = <&foo>;
68                 };
69         };
70 };