124a71afeSRob Herring# SPDX-License-Identifier: GPL-2.0-only 224a71afeSRob Herring%YAML 1.2 324a71afeSRob Herring--- 424a71afeSRob Herring$id: http://devicetree.org/schemas/leds/common.yaml# 524a71afeSRob Herring$schema: http://devicetree.org/meta-schemas/core.yaml# 624a71afeSRob Herring 724a71afeSRob Herringtitle: Common leds properties 824a71afeSRob Herring 924a71afeSRob Herringmaintainers: 1024a71afeSRob Herring - Jacek Anaszewski <jacek.anaszewski@gmail.com> 1124a71afeSRob Herring - Pavel Machek <pavel@ucw.cz> 1224a71afeSRob Herring 1324a71afeSRob Herringdescription: 1424a71afeSRob Herring LED and flash LED devices provide the same basic functionality as current 1524a71afeSRob Herring regulators, but extended with LED and flash LED specific features like 1624a71afeSRob Herring blinking patterns, flash timeout, flash faults and external flash strobe mode. 1724a71afeSRob Herring 1824a71afeSRob Herring Many LED devices expose more than one current output that can be connected 1924a71afeSRob Herring to one or more discrete LED component. Since the arrangement of connections 2024a71afeSRob Herring can influence the way of the LED device initialization, the LED components 2124a71afeSRob Herring have to be tightly coupled with the LED device binding. They are represented 2224a71afeSRob Herring by child nodes of the parent LED device binding. 2324a71afeSRob Herring 2424a71afeSRob Herringproperties: 2524a71afeSRob Herring led-sources: 2624a71afeSRob Herring description: 2724a71afeSRob Herring List of device current outputs the LED is connected to. The outputs are 2824a71afeSRob Herring identified by the numbers that must be defined in the LED device binding 2924a71afeSRob Herring documentation. 30d69c6dddSRob Herring $ref: /schemas/types.yaml#/definitions/uint32-array 3124a71afeSRob Herring 3224a71afeSRob Herring function: 3324a71afeSRob Herring description: 3424a71afeSRob Herring LED function. Use one of the LED_FUNCTION_* prefixed definitions 3524a71afeSRob Herring from the header include/dt-bindings/leds/common.h. If there is no 3624a71afeSRob Herring matching LED_FUNCTION available, add a new one. 37d69c6dddSRob Herring $ref: /schemas/types.yaml#/definitions/string 3824a71afeSRob Herring 3924a71afeSRob Herring color: 4024a71afeSRob Herring description: 4124a71afeSRob Herring Color of the LED. Use one of the LED_COLOR_ID_* prefixed definitions from 4224a71afeSRob Herring the header include/dt-bindings/leds/common.h. If there is no matching 4324a71afeSRob Herring LED_COLOR_ID available, add a new one. 44d69c6dddSRob Herring $ref: /schemas/types.yaml#/definitions/uint32 4524a71afeSRob Herring minimum: 0 46194810f7SDan Murphy maximum: 9 4724a71afeSRob Herring 4824a71afeSRob Herring function-enumerator: 4924a71afeSRob Herring description: 5024a71afeSRob Herring Integer to be used when more than one instance of the same function is 5124a71afeSRob Herring needed, differing only with an ordinal number. 52d69c6dddSRob Herring $ref: /schemas/types.yaml#/definitions/uint32 5324a71afeSRob Herring 5424a71afeSRob Herring label: 5524a71afeSRob Herring description: 5624a71afeSRob Herring The label for this LED. If omitted, the label is taken from the node name 5724a71afeSRob Herring (excluding the unit address). It has to uniquely identify a device, i.e. 5824a71afeSRob Herring no other LED class device can be assigned the same label. This property is 5924a71afeSRob Herring deprecated - use 'function' and 'color' properties instead. 6024a71afeSRob Herring function-enumerator has no effect when this property is present. 6124a71afeSRob Herring 6224a71afeSRob Herring default-state: 6324a71afeSRob Herring description: 6424a71afeSRob Herring The initial state of the LED. If the LED is already on or off and the 6524a71afeSRob Herring default-state property is set the to same value, then no glitch should be 6624a71afeSRob Herring produced where the LED momentarily turns off (or on). The "keep" setting 6724a71afeSRob Herring will keep the LED at whatever its current state is, without producing a 6824a71afeSRob Herring glitch. 69d69c6dddSRob Herring $ref: /schemas/types.yaml#/definitions/string 7024a71afeSRob Herring enum: 7124a71afeSRob Herring - on 7224a71afeSRob Herring - off 7324a71afeSRob Herring - keep 7424a71afeSRob Herring default: off 7524a71afeSRob Herring 7624a71afeSRob Herring linux,default-trigger: 7724a71afeSRob Herring description: 7824a71afeSRob Herring This parameter, if present, is a string defining the trigger assigned to 7924a71afeSRob Herring the LED. 80d69c6dddSRob Herring $ref: /schemas/types.yaml#/definitions/string 813d21a460SRob Herring 82*31fd7108SMarek Vasut oneOf: 83*31fd7108SMarek Vasut - enum: 8424a71afeSRob Herring # LED will act as a back-light, controlled by the framebuffer system 8524a71afeSRob Herring - backlight 8624a71afeSRob Herring # LED will turn on (but for leds-gpio see "default-state" property in 8754b3719dSMauro Carvalho Chehab # Documentation/devicetree/bindings/leds/leds-gpio.yaml) 8824a71afeSRob Herring - default-on 8924a71afeSRob Herring # LED "double" flashes at a load average based rate 9024a71afeSRob Herring - heartbeat 9124a71afeSRob Herring # LED indicates disk activity 9224a71afeSRob Herring - disk-activity 9324a71afeSRob Herring # LED indicates IDE disk activity (deprecated), in new implementations 9424a71afeSRob Herring # use "disk-activity" 9524a71afeSRob Herring - ide-disk 9624a71afeSRob Herring # LED flashes at a fixed, configurable rate 9724a71afeSRob Herring - timer 9824a71afeSRob Herring # LED alters the brightness for the specified duration with one software 9924a71afeSRob Herring # timer (requires "led-pattern" property) 10024a71afeSRob Herring - pattern 101*31fd7108SMarek Vasut # LED is triggered by SD/MMC activity 102*31fd7108SMarek Vasut - pattern: "^mmc[0-9]+$" 10324a71afeSRob Herring 10424a71afeSRob Herring led-pattern: 10524a71afeSRob Herring description: | 10624a71afeSRob Herring Array of integers with default pattern for certain triggers. 10724a71afeSRob Herring 10824a71afeSRob Herring Each trigger may parse this property differently: 10924a71afeSRob Herring - one-shot : two numbers specifying delay on and delay off (in ms), 11024a71afeSRob Herring - timer : two numbers specifying delay on and delay off (in ms), 11124a71afeSRob Herring - pattern : the pattern is given by a series of tuples, of 11224a71afeSRob Herring brightness and duration (in ms). The exact format is 11324a71afeSRob Herring described in: 11424a71afeSRob Herring Documentation/devicetree/bindings/leds/leds-trigger-pattern.txt 115d69c6dddSRob Herring $ref: /schemas/types.yaml#/definitions/uint32-matrix 11624a71afeSRob Herring items: 11724a71afeSRob Herring minItems: 2 11824a71afeSRob Herring maxItems: 2 11924a71afeSRob Herring 12024a71afeSRob Herring led-max-microamp: 12124a71afeSRob Herring description: 12224a71afeSRob Herring Maximum LED supply current in microamperes. This property can be made 12324a71afeSRob Herring mandatory for the board configurations introducing a risk of hardware 12424a71afeSRob Herring damage in case an excessive current is set. 12524a71afeSRob Herring For flash LED controllers with configurable current this property is 12624a71afeSRob Herring mandatory for the LEDs in the non-flash modes (e.g. torch or indicator). 12724a71afeSRob Herring 12824a71afeSRob Herring panic-indicator: 12924a71afeSRob Herring description: 13024a71afeSRob Herring This property specifies that the LED should be used, if at all possible, 13124a71afeSRob Herring as a panic indicator. 13224a71afeSRob Herring type: boolean 13324a71afeSRob Herring 1345d823d6dSEddie James retain-state-shutdown: 1355d823d6dSEddie James description: 1365d823d6dSEddie James This property specifies that the LED should not be turned off or changed 1375d823d6dSEddie James when the system shuts down. 1385d823d6dSEddie James type: boolean 1395d823d6dSEddie James 14024a71afeSRob Herring trigger-sources: 14124a71afeSRob Herring description: | 14224a71afeSRob Herring List of devices which should be used as a source triggering this LED 14324a71afeSRob Herring activity. Some LEDs can be related to a specific device and should somehow 14424a71afeSRob Herring indicate its state. E.g. USB 2.0 LED may react to device(s) in a USB 2.0 14524a71afeSRob Herring port(s). 14624a71afeSRob Herring Another common example is switch or router with multiple Ethernet ports 14724a71afeSRob Herring each of them having its own LED assigned (assuming they are not 14824a71afeSRob Herring hardwired). In such cases this property should contain phandle(s) of 14924a71afeSRob Herring related source device(s). 15024a71afeSRob Herring In many cases LED can be related to more than one device (e.g. one USB LED 15124a71afeSRob Herring vs. multiple USB ports). Each source should be represented by a node in 15224a71afeSRob Herring the device tree and be referenced by a phandle and a set of phandle 15324a71afeSRob Herring arguments. A length of arguments should be specified by the 15424a71afeSRob Herring #trigger-source-cells property in the source node. 155d69c6dddSRob Herring $ref: /schemas/types.yaml#/definitions/phandle-array 15624a71afeSRob Herring 15724a71afeSRob Herring # Required properties for flash LED child nodes: 15824a71afeSRob Herring flash-max-microamp: 15924a71afeSRob Herring description: 16024a71afeSRob Herring Maximum flash LED supply current in microamperes. Required for flash LED 16124a71afeSRob Herring nodes with configurable current. 16224a71afeSRob Herring 16324a71afeSRob Herring flash-max-timeout-us: 16424a71afeSRob Herring description: 16524a71afeSRob Herring Maximum timeout in microseconds after which the flash LED is turned off. 16624a71afeSRob Herring Required for flash LED nodes with configurable timeout. 16724a71afeSRob Herring 1686a0e321eSRob HerringadditionalProperties: true 1696a0e321eSRob Herring 17024a71afeSRob Herringexamples: 17124a71afeSRob Herring - | 17224a71afeSRob Herring #include <dt-bindings/gpio/gpio.h> 17324a71afeSRob Herring #include <dt-bindings/leds/common.h> 17424a71afeSRob Herring 17524a71afeSRob Herring led-controller { 17624a71afeSRob Herring compatible = "gpio-leds"; 17724a71afeSRob Herring 1787a3a2a64SJohan Jonker led-0 { 17924a71afeSRob Herring function = LED_FUNCTION_STATUS; 18024a71afeSRob Herring linux,default-trigger = "heartbeat"; 18124a71afeSRob Herring gpios = <&gpio0 0 GPIO_ACTIVE_HIGH>; 18224a71afeSRob Herring }; 18324a71afeSRob Herring 1847a3a2a64SJohan Jonker led-1 { 18524a71afeSRob Herring function = LED_FUNCTION_USB; 18624a71afeSRob Herring gpios = <&gpio0 1 GPIO_ACTIVE_HIGH>; 18724a71afeSRob Herring trigger-sources = <&ohci_port1>, <&ehci_port1>; 18824a71afeSRob Herring }; 18924a71afeSRob Herring }; 19024a71afeSRob Herring 191114fa138SKrzysztof Kozlowski - | 192114fa138SKrzysztof Kozlowski #include <dt-bindings/leds/common.h> 193114fa138SKrzysztof Kozlowski 194114fa138SKrzysztof Kozlowski led-controller { 19524a71afeSRob Herring compatible = "maxim,max77693-led"; 19624a71afeSRob Herring 19724a71afeSRob Herring led { 19824a71afeSRob Herring function = LED_FUNCTION_FLASH; 19924a71afeSRob Herring color = <LED_COLOR_ID_WHITE>; 20024a71afeSRob Herring led-sources = <0>, <1>; 20124a71afeSRob Herring led-max-microamp = <50000>; 20224a71afeSRob Herring flash-max-microamp = <320000>; 20324a71afeSRob Herring flash-max-timeout-us = <500000>; 20424a71afeSRob Herring }; 20524a71afeSRob Herring }; 20624a71afeSRob Herring 207114fa138SKrzysztof Kozlowski - | 208114fa138SKrzysztof Kozlowski #include <dt-bindings/leds/common.h> 209114fa138SKrzysztof Kozlowski 21024a71afeSRob Herring i2c { 21124a71afeSRob Herring #address-cells = <1>; 21224a71afeSRob Herring #size-cells = <0>; 21324a71afeSRob Herring 21424a71afeSRob Herring led-controller@30 { 21524a71afeSRob Herring compatible = "panasonic,an30259a"; 21624a71afeSRob Herring reg = <0x30>; 21724a71afeSRob Herring #address-cells = <1>; 21824a71afeSRob Herring #size-cells = <0>; 21924a71afeSRob Herring 22024a71afeSRob Herring led@1 { 22124a71afeSRob Herring reg = <1>; 22224a71afeSRob Herring linux,default-trigger = "heartbeat"; 22324a71afeSRob Herring function = LED_FUNCTION_INDICATOR; 22424a71afeSRob Herring function-enumerator = <1>; 22524a71afeSRob Herring }; 22624a71afeSRob Herring 22724a71afeSRob Herring led@2 { 22824a71afeSRob Herring reg = <2>; 22924a71afeSRob Herring function = LED_FUNCTION_INDICATOR; 23024a71afeSRob Herring function-enumerator = <2>; 23124a71afeSRob Herring }; 23224a71afeSRob Herring 23324a71afeSRob Herring led@3 { 23424a71afeSRob Herring reg = <3>; 23524a71afeSRob Herring function = LED_FUNCTION_INDICATOR; 23624a71afeSRob Herring function-enumerator = <3>; 23724a71afeSRob Herring }; 23824a71afeSRob Herring }; 23924a71afeSRob Herring }; 24024a71afeSRob Herring 24124a71afeSRob Herring... 242