linux/Documentation/devicetree/bindings/leds/regulator-led.yaml
Krzysztof Kozlowski 9d69d47fd3 dt-bindings: drop redundant part of title (beginning)
The Devicetree bindings document does not have to say in the title that
it is a "Devicetree binding", but instead just describe the hardware.

Drop beginning "Devicetree bindings" in various forms:

  find Documentation/devicetree/bindings/ -type f -name '*.yaml' \
    -exec sed -i -e 's/^title: [dD]evice[ -]\?[tT]ree [bB]indings\? for \([tT]he \)\?\(.*\)$/title: \u\2/' {} \;

  find Documentation/devicetree/bindings/ -type f -name '*.yaml' \
    -exec sed -i -e 's/^title: [bB]indings\? for \([tT]he \)\?\(.*\)$/title: \u\2/' {} \;

  find Documentation/devicetree/bindings/ -type f -name '*.yaml' \
    -exec sed -i -e 's/^title: [dD][tT] [bB]indings\? for \([tT]he \)\?\(.*\)$/title: \u\2/' {} \;

Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Acked-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Acked-by: Ulf Hansson <ulf.hansson@linaro.org> # MMC
Acked-by: Stephen Boyd <sboyd@kernel.org> # clk
Acked-by: Dmitry Torokhov <dmitry.torokhov@gmail.com> # input
Acked-by: Mark Brown <broonie@kernel.org>
Acked-by: Sebastian Reichel <sre@kernel.org> # power
Link: https://lore.kernel.org/r/20221216163815.522628-8-krzysztof.kozlowski@linaro.org
Signed-off-by: Rob Herring <robh@kernel.org>
2022-12-16 11:41:49 -06:00

56 lines
1.2 KiB
YAML

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/leds/regulator-led.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#
title: Regulator LEDs
maintainers:
- Linus Walleij <linus.walleij@linaro.org>
description: |
Regulator LEDs are powered by a single regulator such that they can
be turned on or off by enabling or disabling the regulator. The available
brightness settings will be inferred from the available voltages on the
regulator, and any constraints on the voltage or current will need to be
specified on the regulator.
allOf:
- $ref: common.yaml#
properties:
$nodename:
pattern: '^led.*$'
compatible:
const: regulator-led
vled-supply:
description:
The regulator controlling the current to the LED.
function: true
color: true
linux,default-trigger: true
default-state: true
required:
- compatible
- vled-supply
additionalProperties: false
examples:
- |
#include <dt-bindings/leds/common.h>
led-heartbeat {
compatible = "regulator-led";
vled-supply = <&regulator>;
function = LED_FUNCTION_STATUS;
color = <LED_COLOR_ID_BLUE>;
linux,default-trigger = "heartbeat";
};
...