X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Fled.h;h=02766fa56fb62ffe2f77e99c8afc0b1076b503ff;hb=64cfeda8ae2e95751c5d2dfa4dc4a906478ae2f6;hp=57c2b4a3777729bb02c4fb93ba47013d82f1ef3b;hpb=b706d63559aeec352bc72dd86d7d5423c15f6a60;p=platform%2Fkernel%2Fu-boot.git diff --git a/include/led.h b/include/led.h index 57c2b4a..02766fa 100644 --- a/include/led.h +++ b/include/led.h @@ -1,45 +1,120 @@ +/* SPDX-License-Identifier: GPL-2.0+ */ /* - * (C) Copyright 2006 - * Atmel Nordic AB - * Ulf Samuelsson + * Copyright (c) 2015 Google, Inc + * Written by Simon Glass + */ + +#ifndef __LED_H +#define __LED_H + +struct udevice; + +/** + * struct led_uc_plat - Platform data the uclass stores about each device + * + * @label: LED label + */ +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_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 + * @period_ms: LED blink period in milliseconds + * @return 0 if OK, -ve on error + */ + int (*set_period)(struct udevice *dev, int period_ms); +#endif +}; + +#define led_get_ops(dev) ((struct led_ops *)(dev)->driver->ops) + +/** + * led_get_by_label() - Find an LED device by label * - * See file CREDITS for list of people who contributed to this - * project. + * @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 + */ +int led_get_by_label(const char *label, struct udevice **devp); + +/** + * led_set_state() - set the state of an LED * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation; either version 2 of - * the License, or (at your option) any later version. + * @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 * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * @dev: LED device to change + * @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 * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, - * MA 02111-1307 USA + * @dev: LED device to change + * @period_ms: LED blink period in milliseconds + * @return 0 if OK, -ve on error */ +int led_set_period(struct udevice *dev, int period_ms); -#ifndef __LED_H -#define __LED_H +/** + * 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); -#ifndef __ASSEMBLY__ -extern void LED_init (void); -extern void red_LED_on(void); -extern void red_LED_off(void); -extern void green_LED_on(void); -extern void green_LED_off(void); -extern void yellow_LED_on(void); -extern void yellow_LED_off(void); -#else - .extern LED_init - .extern red_LED_on - .extern red_LED_off - .extern yellow_LED_on - .extern yellow_LED_off - .extern green_LED_on - .extern green_LED_off -#endif #endif