X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Fled.h;h=02766fa56fb62ffe2f77e99c8afc0b1076b503ff;hb=64cfeda8ae2e95751c5d2dfa4dc4a906478ae2f6;hp=a856b3d9ff78312e042bd04e892bc6302aa32b5a;hpb=56e19871dc2a05aa5508ea51af35df59bbdb6cf5;p=platform%2Fkernel%2Fu-boot.git diff --git a/include/led.h b/include/led.h index a856b3d..02766fa 100644 --- a/include/led.h +++ b/include/led.h @@ -1,13 +1,14 @@ +/* SPDX-License-Identifier: GPL-2.0+ */ /* * Copyright (c) 2015 Google, Inc * Written by Simon Glass - * - * SPDX-License-Identifier: GPL-2.0+ */ #ifndef __LED_H #define __LED_H +struct udevice; + /** * struct led_uc_plat - Platform data the uclass stores about each device * @@ -17,15 +18,57 @@ struct led_uc_plat { const char *label; }; +/** + * struct led_uc_priv - Private data the uclass stores about each device + * + * @period_ms: Flash period in milliseconds + */ +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_on() - set the state of an LED + * set_state() - set the state of an LED + * + * @dev: LED device to change + * @state: LED state to set + * @return 0 if OK, -ve on error + */ + int (*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 + */ + enum led_state_t (*get_state)(struct udevice *dev); + +#ifdef CONFIG_LED_BLINK + /** + * led_set_period() - set the blink period of an LED + * + * Thie records the period if supported, or returns -ENOSYS if not. + * To start the LED blinking, use set_state(). * * @dev: LED device to change - * @on: 1 to turn the LED on, 0 to turn it off + * @period_ms: LED blink period in milliseconds * @return 0 if OK, -ve on error */ - int (*set_on)(struct udevice *dev, int on); + int (*set_period)(struct udevice *dev, int period_ms); +#endif }; #define led_get_ops(dev) ((struct led_ops *)(dev)->driver->ops) @@ -40,12 +83,38 @@ struct led_ops { int led_get_by_label(const char *label, struct udevice **devp); /** - * led_set_on() - set the state of an LED + * led_set_state() - set the state of an LED + * + * @dev: LED device to change + * @state: LED state to set + * @return 0 if OK, -ve on error + */ +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 - * @on: 1 to turn the LED on, 0 to turn it off + * @return LED state led_state_t, or -ve on error + */ +enum led_state_t led_get_state(struct udevice *dev); + +/** + * led_set_period() - set the blink period of an LED + * + * @dev: LED device to change + * @period_ms: LED blink period in milliseconds * @return 0 if OK, -ve on error */ -int led_set_on(struct udevice *dev, int on); +int led_set_period(struct udevice *dev, int period_ms); + +/** + * led_default_state() - set the default state for all the LED + * + * This enables all leds which have default state. + * see Documentation/devicetree/bindings/leds/common.txt + * + */ +int led_default_state(void); #endif