common.yaml 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
  2. %YAML 1.2
  3. ---
  4. $id: http://devicetree.org/schemas/leds/backlight/common.yaml#
  5. $schema: http://devicetree.org/meta-schemas/core.yaml#
  6. title: Common backlight properties
  7. maintainers:
  8. - Lee Jones <lee@kernel.org>
  9. - Daniel Thompson <daniel.thompson@linaro.org>
  10. - Jingoo Han <jingoohan1@gmail.com>
  11. description:
  12. Backlight devices provide backlight for different types of graphical
  13. displays. They are typically but not necessarily implemented using a white
  14. LED powered by a boost converter.
  15. properties:
  16. default-brightness:
  17. description:
  18. The default brightness that should be applied to the LED by the operating
  19. system on start-up. The brightness should not exceed the brightness the
  20. LED can provide.
  21. $ref: /schemas/types.yaml#/definitions/uint32
  22. max-brightness:
  23. description:
  24. Normally the maximum brightness is determined by the hardware and this
  25. property is not required. This property is used to put a software limit
  26. on the brightness apart from what the driver says, as it could happen
  27. that a LED can be made so bright that it gets damaged or causes damage
  28. due to restrictions in a specific system, such as mounting conditions.
  29. $ref: /schemas/types.yaml#/definitions/uint32
  30. brightness-levels:
  31. description:
  32. Array of distinct brightness levels. The levels must be in the range
  33. accepted by the underlying LED device. Typically these are in the range
  34. from 0 to 255, but any range starting at 0 will do, as long as they are
  35. accepted by the LED.
  36. The 0 value means a 0% of brightness (darkest/off), while the last value
  37. in the array represents a full 100% brightness (brightest).
  38. If this array is not provided, the driver default mapping is used.
  39. $ref: /schemas/types.yaml#/definitions/uint32-array
  40. default-brightness-level:
  41. description:
  42. The default brightness level (index into the array defined by the
  43. "brightness-levels" property).
  44. $ref: /schemas/types.yaml#/definitions/uint32
  45. additionalProperties: true