common.txt 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. Common leds properties.
  2. LED and flash LED devices provide the same basic functionality as current
  3. regulators, but extended with LED and flash LED specific features like
  4. blinking patterns, flash timeout, flash faults and external flash strobe mode.
  5. Many LED devices expose more than one current output that can be connected
  6. to one or more discrete LED component. Since the arrangement of connections
  7. can influence the way of the LED device initialization, the LED components
  8. have to be tightly coupled with the LED device binding. They are represented
  9. by child nodes of the parent LED device binding.
  10. Optional properties for child nodes:
  11. - led-sources : List of device current outputs the LED is connected to. The
  12. outputs are identified by the numbers that must be defined
  13. in the LED device binding documentation.
  14. - label : The label for this LED. If omitted, the label is taken from the node
  15. name (excluding the unit address). It has to uniquely identify
  16. a device, i.e. no other LED class device can be assigned the same
  17. label.
  18. - default-state : The initial state of the LED. Valid values are "on", "off",
  19. and "keep". If the LED is already on or off and the default-state property is
  20. set the to same value, then no glitch should be produced where the LED
  21. momentarily turns off (or on). The "keep" setting will keep the LED at
  22. whatever its current state is, without producing a glitch. The default is
  23. off if this property is not present.
  24. - linux,default-trigger : This parameter, if present, is a
  25. string defining the trigger assigned to the LED. Current triggers are:
  26. "backlight" - LED will act as a back-light, controlled by the framebuffer
  27. system
  28. "default-on" - LED will turn on (but for leds-gpio see "default-state"
  29. property in Documentation/devicetree/bindings/gpio/led.txt)
  30. "heartbeat" - LED "double" flashes at a load average based rate
  31. "disk-activity" - LED indicates disk activity
  32. "ide-disk" - LED indicates IDE disk activity (deprecated),
  33. in new implementations use "disk-activity"
  34. "timer" - LED flashes at a fixed, configurable rate
  35. - led-max-microamp : Maximum LED supply current in microamperes. This property
  36. can be made mandatory for the board configurations
  37. introducing a risk of hardware damage in case an excessive
  38. current is set.
  39. For flash LED controllers with configurable current this
  40. property is mandatory for the LEDs in the non-flash modes
  41. (e.g. torch or indicator).
  42. - panic-indicator : This property specifies that the LED should be used,
  43. if at all possible, as a panic indicator.
  44. Required properties for flash LED child nodes:
  45. - flash-max-microamp : Maximum flash LED supply current in microamperes.
  46. - flash-max-timeout-us : Maximum timeout in microseconds after which the flash
  47. LED is turned off.
  48. For controllers that have no configurable current the flash-max-microamp
  49. property can be omitted.
  50. For controllers that have no configurable timeout the flash-max-timeout-us
  51. property can be omitted.
  52. Examples:
  53. system-status {
  54. label = "Status";
  55. linux,default-trigger = "heartbeat";
  56. ...
  57. };
  58. camera-flash {
  59. label = "Flash";
  60. led-sources = <0>, <1>;
  61. led-max-microamp = <50000>;
  62. flash-max-microamp = <320000>;
  63. flash-max-timeout-us = <500000>;
  64. };