Prepare v2023.10

[platform/kernel/u-boot.git] / include / led.h

diff --git a/include/led.h b/include/led.h
index c67af22..3290410 100644 (file)
--- a/include/led.h
+++ b/include/led.h
@@ -1,20 +1,34 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
 /*
  * Copyright (c) 2015 Google, Inc
  * Written by Simon Glass <sjg@chromium.org>
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #ifndef __LED_H
 #define __LED_H
 
+struct udevice;
+
+enum led_state_t {
+       LEDST_OFF = 0,
+       LEDST_ON = 1,
+       LEDST_TOGGLE,
+#ifdef CONFIG_LED_BLINK
+       LEDST_BLINK,
+#endif
+
+       LEDST_COUNT,
+};
+
 /**
  * struct led_uc_plat - Platform data the uclass stores about each device
  *
  * @label:     LED label
+ * @default_state:     LED default state
  */
 struct led_uc_plat {
        const char *label;
+       enum led_state_t default_state;
 };
 
 /**
@@ -26,17 +40,6 @@ struct led_uc_priv {
        int period_ms;
 };
 
-enum led_state_t {
-       LEDST_OFF = 0,
-       LEDST_ON = 1,
-       LEDST_TOGGLE,
-#ifdef CONFIG_LED_BLINK
-       LEDST_BLINK,
-#endif
-
-       LEDST_COUNT,
-};
-
 struct led_ops {
        /**
         * set_state() - set the state of an LED
@@ -77,7 +80,7 @@ struct led_ops {
  *
  * @label:     LED label to look up
  * @devp:      Returns the associated device, if found
- * @return 0 if found, -ENODEV if not found, other -ve on error
+ * Return: 0 if found, -ENODEV if not found, other -ve on error
  */
 int led_get_by_label(const char *label, struct udevice **devp);
 
@@ -86,7 +89,7 @@ int led_get_by_label(const char *label, struct udevice **devp);
  *
  * @dev:       LED device to change
  * @state:     LED state to set
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int led_set_state(struct udevice *dev, enum led_state_t state);
 
@@ -94,7 +97,7 @@ int led_set_state(struct udevice *dev, enum led_state_t state);
  * led_get_state() - get the state of an LED
  *
  * @dev:       LED device to change
- * @return LED state led_state_t, or -ve on error
+ * Return: LED state led_state_t, or -ve on error
  */
 enum led_state_t led_get_state(struct udevice *dev);
 
@@ -103,7 +106,7 @@ enum led_state_t led_get_state(struct udevice *dev);
  *
  * @dev:       LED device to change
  * @period_ms: LED blink period in milliseconds
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int led_set_period(struct udevice *dev, int period_ms);