| Tom Rini | 53633a8 | 2024-02-29 12:33:36 -0500 | [diff] [blame] | 1 | # SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause |
| 2 | %YAML 1.2 |
| 3 | --- |
| 4 | $id: http://devicetree.org/schemas/leds/maxim,max77693.yaml# |
| 5 | $schema: http://devicetree.org/meta-schemas/core.yaml# |
| 6 | |
| 7 | title: Maxim MAX77693 MicroUSB and Companion Power Management IC LEDs |
| 8 | |
| 9 | maintainers: |
| 10 | - Krzysztof Kozlowski <krzk@kernel.org> |
| 11 | |
| 12 | description: | |
| 13 | This is a part of device tree bindings for Maxim MAX77693 MicroUSB Integrated |
| 14 | Circuit (MUIC). |
| 15 | |
| 16 | There are two LED outputs available - FLED1 and FLED2. Each of them can |
| 17 | control a separate LED or they can be connected together to double the |
| 18 | maximum current for a single connected LED. One LED is represented by one |
| 19 | child node. |
| 20 | |
| 21 | See also Documentation/devicetree/bindings/mfd/maxim,max77693.yaml for |
| 22 | additional information and example. |
| 23 | |
| 24 | properties: |
| 25 | compatible: |
| 26 | const: maxim,max77693-led |
| 27 | |
| 28 | maxim,boost-mode: |
| 29 | description: |
| 30 | In boost mode the device can produce up to 1.2A of total current on both |
| 31 | outputs. The maximum current on each output is reduced to 625mA then. If |
| 32 | not enabled explicitly, boost setting defaults to LEDS_BOOST_FIXED in |
| 33 | case both current sources are used. |
| 34 | See LEDS_BOOST_* in include/dt-bindings/leds/common.h. |
| 35 | $ref: /schemas/types.yaml#/definitions/uint32 |
| 36 | enum: [0, 1, 2] |
| 37 | |
| 38 | maxim,boost-mvout: |
| 39 | description: | |
| 40 | Output voltage of the boost module in millivolts. |
| 41 | Valid values: 3300 - 5500, step by 25 (rounded down) |
| 42 | $ref: /schemas/types.yaml#/definitions/uint32 |
| 43 | minimum: 3300 |
| 44 | maximum: 5500 |
| 45 | default: 3300 |
| 46 | |
| 47 | maxim,mvsys-min: |
| 48 | description: | |
| 49 | Low input voltage level in millivolts. Flash is not fired if chip |
| 50 | estimates that system voltage could drop below this level due to flash |
| 51 | power consumption. |
| 52 | Valid values: 2400 - 3400, step by 33 (rounded down) |
| 53 | $ref: /schemas/types.yaml#/definitions/uint32 |
| 54 | minimum: 2400 |
| 55 | maximum: 3400 |
| 56 | default: 2400 |
| 57 | |
| 58 | patternProperties: |
| 59 | "^([a-z]+-)?led[01]?$": |
| 60 | type: object |
| 61 | $ref: common.yaml# |
| 62 | unevaluatedProperties: false |
| 63 | |
| 64 | properties: |
| 65 | led-sources: |
| 66 | allOf: |
| 67 | - minItems: 1 |
| 68 | maxItems: 2 |
| 69 | items: |
| 70 | minimum: 0 |
| 71 | maximum: 1 |
| 72 | |
| 73 | led-max-microamp: |
| 74 | description: | |
| 75 | Valid values for a LED connected to one FLED output: |
| 76 | 15625 - 250000, step by 15625 (rounded down) |
| 77 | Valid values for a LED connected to both FLED outputs: |
| 78 | 15625 - 500000, step by 15625 (rounded down) |
| 79 | |
| 80 | flash-max-microamp: |
| 81 | description: | |
| 82 | Valid values for a single LED connected to one FLED output |
| 83 | (boost mode must be turned off): |
| 84 | 15625 - 1000000, step by 15625 (rounded down) |
| 85 | Valid values for a single LED connected to both FLED outputs: |
| 86 | 15625 - 1250000, step by 15625 (rounded down) |
| 87 | Valid values for two LEDs case: |
| 88 | 15625 - 625000, step by 15625 (rounded down) |
| 89 | |
| 90 | flash-max-timeout-us: |
| 91 | description: | |
| 92 | Valid values: 62500 - 1000000, step by 62500 (rounded down) |
| 93 | minimum: 62500 |
| 94 | maximum: 1000000 |
| 95 | |
| 96 | required: |
| 97 | - flash-max-microamp |
| 98 | - flash-max-timeout-us |
| 99 | - led-max-microamp |
| 100 | - led-sources |
| 101 | |
| 102 | required: |
| 103 | - compatible |
| 104 | |
| 105 | additionalProperties: false |