# Copyright 2022 The ChromiumOS Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

description: PWM LED pins parent node

compatible: "cros-ec,pwm-led-pins"

child-binding:
    description: |
      Each child node describes all the PWM pins that need to be altered to set
      a specific color.
      e.g. For blue and amber PWM channels, in order to set color amber, a node
      looks like this where 100 is PWM duty cycle in percentage.
      color-amber {
                   led-color = "LED_AMBER";
                   led-pins = <&pwm_led_y 100>,
                              <&pwm_led_b 0>;
                  };
    properties:
        led-color:
            type: string
            required: true
            description: |
              This property is used to identify pin nodes based on color enum.
              It is required by the EC_CMD_LED_CONTROL host command.
            enum:
                - LED_OFF
                - LED_RED
                - LED_GREEN
                - LED_BLUE
                - LED_YELLOW
                - LED_WHITE
                - LED_AMBER
        led-id:
            type: string
            required: true
            description: |
              This property is required by the EC_CMD_LED_CONTROL host command.
              It must match the enum names defined in ec_commands.h.
            enum:
                - EC_LED_ID_BATTERY_LED
                - EC_LED_ID_POWER_LED
                - EC_LED_ID_ADAPTER_LED
                - EC_LED_ID_LEFT_LED
                - EC_LED_ID_RIGHT_LED
                - EC_LED_ID_RECOVERY_HW_REINIT_LED
                - EC_LED_ID_SYSRQ_DEBUG_LED
        br-color:
            type: string
            required: false
            description: |
              This is used in the ectool brightness range APIs. It must match
              the enum names defined in ec_commands.h.
            enum:
                - EC_LED_COLOR_RED
                - EC_LED_COLOR_GREEN
                - EC_LED_COLOR_BLUE
                - EC_LED_COLOR_YELLOW
                - EC_LED_COLOR_WHITE
                - EC_LED_COLOR_AMBER
        led-pins:
            type: phandle-array
            required: true
            description: |
              This property is used to specify an array of PWM pins and
              corresponding values to enable a particular color.
              e.g. Amber color - led-pins = <&pwm_led_y 100>,
                                            <&pwm_led_b 0>;