xref: /rk3399_rockchip-uboot/include/led.h (revision 9413ad4f0def2e06a5042106a6e1650a1aa03a5a)
1 /*
2  * Copyright (c) 2015 Google, Inc
3  * Written by Simon Glass <sjg@chromium.org>
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 
8 #ifndef __LED_H
9 #define __LED_H
10 
11 /**
12  * struct led_uc_plat - Platform data the uclass stores about each device
13  *
14  * @label:	LED label
15  */
16 struct led_uc_plat {
17 	const char *label;
18 };
19 
20 enum led_state_t {
21 	LEDST_OFF = 0,
22 	LEDST_ON = 1,
23 	LEDST_TOGGLE,
24 
25 	LEDST_COUNT,
26 };
27 
28 struct led_ops {
29 	/**
30 	 * set_state() - set the state of an LED
31 	 *
32 	 * @dev:	LED device to change
33 	 * @state:	LED state to set
34 	 * @return 0 if OK, -ve on error
35 	 */
36 	int (*set_state)(struct udevice *dev, enum led_state_t state);
37 
38 	/**
39 	 * led_get_state() - get the state of an LED
40 	 *
41 	 * @dev:	LED device to change
42 	 * @return LED state led_state_t, or -ve on error
43 	 */
44 	enum led_state_t (*get_state)(struct udevice *dev);
45 };
46 
47 #define led_get_ops(dev)	((struct led_ops *)(dev)->driver->ops)
48 
49 /**
50  * led_get_by_label() - Find an LED device by label
51  *
52  * @label:	LED label to look up
53  * @devp:	Returns the associated device, if found
54  * @return 0 if found, -ENODEV if not found, other -ve on error
55  */
56 int led_get_by_label(const char *label, struct udevice **devp);
57 
58 /**
59  * led_set_state() - set the state of an LED
60  *
61  * @dev:	LED device to change
62  * @state:	LED state to set
63  * @return 0 if OK, -ve on error
64  */
65 int led_set_state(struct udevice *dev, enum led_state_t state);
66 
67 /**
68  * led_get_state() - get the state of an LED
69  *
70  * @dev:	LED device to change
71  * @return LED state led_state_t, or -ve on error
72  */
73 enum led_state_t led_get_state(struct udevice *dev);
74 
75 #endif
76