[RFC PATCH 1/2] dt-bindings: leds: Document TI LM3643 dual LED flash driver
Rillian Grant <[email protected]>
| Newsgroups | org.kernel.vger.linux-leds,org.kernel.vger.linux-devicetree,org.kernel.vger.linux-kernel |
|---|---|
| Message-ID | <[email protected]> |
Document Texas Instruments LM3643 dual LED flash driver devicetree bindings. Signed-off-by: Rillian Grant <[email protected]> --- .../devicetree/bindings/leds/ti,lm3643.yaml | 126 ++++++++++++++++++ 1 file changed, 126 insertions(+) create mode 100644 Documentation/devicetree/bindings/leds/ti,lm3643.yaml diff --git a/Documentation/devicetree/bindings/leds/ti,lm3643.yaml b/Documentation/devicetree/bindings/leds/ti,lm3643.yaml new file mode 100644 index 000000000000..18b08a79512f --- /dev/null +++ b/Documentation/devicetree/bindings/leds/ti,lm3643.yaml @@ -0,0 +1,126 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/leds/ti,lm3643.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Texas Instruments LM3643 1500mA dual LED Flash Driver + +maintainers: + - Rillian Grant <[email protected]> + +description: | + The LM3643 is a dual LED flash driver utilizing a synchronous boost converter + to provide power to two current sources. + + The dual high-side current sources can be tied together to provide flash + currents up to 1.5A through a single LED. + + Datasheet: https://www.ti.com/lit/ds/symlink/lm3643.pdf + +properties: + compatible: + enum: + - ti,lm3643 + + reg: + maxItems: 1 + + "#address-cells": + const: 1 + + "#size-cells": + const: 0 + +patternProperties: + "^led@[0-1]$": + type: object + $ref: common.yaml# + unevaluatedProperties: false + + properties: + reg: + description: Index of the LED. + minimum: 0 + maximum: 1 + + led-sources: + minItems: 1 + maxItems: 2 + items: + minimum: 0 + maximum: 1 + + flash-max-microamp: + description: | + Maximum flash current through this LED. Each high-side current source + can provide up to 1.5A. The maximum current the boost can deliver is + 1.5A across both sources. + + Valid values for an LED connected to one source: + 10900 - 1500000, step by 11725 (rounded down) + Valid values for an LED connected to both sources: + 21800 - 1500000, step by 23450 (rounded down) + + minimum: 10900 + maximum: 1500000 + + led-max-microamp: + description: | + Maximum torch current through this LED. In torch mode each high-side + current source can provide up to 179mA. + + Valid values for an LED connected to one source: + 977 - 179000, step by 1400 (rounded down) + Valid values for an LED connected to both sources: + 1954 - 358000, step by 2800 (rounded down) + + minimum: 977 + maximum: 358000 + + flash-max-timeout-us: + description: | + The chip supports timeouts from 10ms to 100ms in increments of 10ms + and from 100ms to 400ms in increments of 50ms. The provided value + will be rounded down to a supported value. + + minimum: 10000 + maximum: 400000 + + required: + - reg + - led-sources + +required: + - compatible + - reg + - "#address-cells" + - "#size-cells" + +additionalProperties: false + +examples: + - | + #include <dt-bindings/leds/common.h> + + i2c { + #address-cells = <1>; + #size-cells = <0>; + + flash-led-controller@63 { + compatible = "ti,lm3643"; + reg = <0x63>; + #address-cells = <1>; + #size-cells = <0>; + + led@0 { + reg = <0>; + led-sources = <0>, <1>; + function = LED_FUNCTION_FLASH; + color = <LED_COLOR_ID_IR>; + flash-max-microamp = <750000>; + led-max-microamp = <180000>; + flash-max-timeout-us = <150000>; + }; + }; + }; -- 2.55.0