panel-common.txt 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. Common Properties for Display Panel
  2. ===================================
  3. This document defines device tree properties common to several classes of
  4. display panels. It doesn't constitue a device tree binding specification by
  5. itself but is meant to be referenced by device tree bindings.
  6. When referenced from panel device tree bindings the properties defined in this
  7. document are defined as follows. The panel device tree bindings are
  8. responsible for defining whether each property is required or optional.
  9. Descriptive Properties
  10. ----------------------
  11. - width-mm,
  12. - height-mm: The width-mm and height-mm specify the width and height of the
  13. physical area where images are displayed. These properties are expressed in
  14. millimeters and rounded to the closest unit.
  15. - label: The label property specifies a symbolic name for the panel as a
  16. string suitable for use by humans. It typically contains a name inscribed on
  17. the system (e.g. as an affixed label) or specified in the system's
  18. documentation (e.g. in the user's manual).
  19. If no such name exists, and unless the property is mandatory according to
  20. device tree bindings, it shall rather be omitted than constructed of
  21. non-descriptive information. For instance an LCD panel in a system that
  22. contains a single panel shall not be labelled "LCD" if that name is not
  23. inscribed on the system or used in a descriptive fashion in system
  24. documentation.
  25. Display Timings
  26. ---------------
  27. - panel-timing: Most display panels are restricted to a single resolution and
  28. require specific display timings. The panel-timing subnode expresses those
  29. timings as specified in the timing subnode section of the display timing
  30. bindings defined in
  31. Documentation/devicetree/bindings/display/panel/display-timing.txt.
  32. Connectivity
  33. ------------
  34. - ports: Panels receive video data through one or multiple connections. While
  35. the nature of those connections is specific to the panel type, the
  36. connectivity is expressed in a standard fashion using ports as specified in
  37. the device graph bindings defined in
  38. Documentation/devicetree/bindings/graph.txt.
  39. - ddc-i2c-bus: Some panels expose EDID information through an I2C-compatible
  40. bus such as DDC2 or E-DDC. For such panels the ddc-i2c-bus contains a
  41. phandle to the system I2C controller connected to that bus.
  42. Control I/Os
  43. ------------
  44. Many display panels can be controlled through pins driven by GPIOs. The nature
  45. and timing of those control signals are device-specific and left for panel
  46. device tree bindings to specify. The following GPIO specifiers can however be
  47. used for panels that implement compatible control signals.
  48. - enable-gpios: Specifier for a GPIO connected to the panel enable control
  49. signal. The enable signal is active high and enables operation of the panel.
  50. This property can also be used for panels implementing an active low power
  51. down signal, which is a negated version of the enable signal. Active low
  52. enable signals (or active high power down signals) can be supported by
  53. inverting the GPIO specifier polarity flag.
  54. Note that the enable signal control panel operation only and must not be
  55. confused with a backlight enable signal.
  56. - reset-gpios: Specifier for a GPIO coonnected to the panel reset control
  57. signal. The reset signal is active low and resets the panel internal logic
  58. while active. Active high reset signals can be supported by inverting the
  59. GPIO specifier polarity flag.
  60. Power
  61. -----
  62. - power-supply: display panels require power to be supplied. While several
  63. panels need more than one power supply with panel-specific constraints
  64. governing the order and timings of the power supplies, in many cases a single
  65. power supply is sufficient, either because the panel has a single power rail,
  66. or because all its power rails can be driven by the same supply. In that case
  67. the power-supply property specifies the supply powering the panel as a phandle
  68. to a regulator.
  69. Backlight
  70. ---------
  71. Most display panels include a backlight. Some of them also include a backlight
  72. controller exposed through a control bus such as I2C or DSI. Others expose
  73. backlight control through GPIO, PWM or other signals connected to an external
  74. backlight controller.
  75. - backlight: For panels whose backlight is controlled by an external backlight
  76. controller, this property contains a phandle that references the controller.