Blame view
include/led.h
2.35 KB
5917112c9
|
1 2 3 4 5 6 7 8 9 10 11 |
/* * Copyright (c) 2015 Google, Inc * Written by Simon Glass <sjg@chromium.org> * * SPDX-License-Identifier: GPL-2.0+ */ #ifndef __LED_H #define __LED_H /** |
56e19871d
|
12 |
* struct led_uc_plat - Platform data the uclass stores about each device |
5917112c9
|
13 14 15 |
* * @label: LED label */ |
56e19871d
|
16 |
struct led_uc_plat { |
5917112c9
|
17 18 |
const char *label; }; |
53378dac8
|
19 20 21 22 23 24 25 26 |
/** * 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; }; |
ddae9fcdd
|
27 28 29 |
enum led_state_t { LEDST_OFF = 0, LEDST_ON = 1, |
9413ad4f0
|
30 |
LEDST_TOGGLE, |
53378dac8
|
31 32 33 |
#ifdef CONFIG_LED_BLINK LEDST_BLINK, #endif |
ddae9fcdd
|
34 35 36 |
LEDST_COUNT, }; |
5917112c9
|
37 38 |
struct led_ops { /** |
ddae9fcdd
|
39 |
* set_state() - set the state of an LED |
5917112c9
|
40 41 |
* * @dev: LED device to change |
ddae9fcdd
|
42 |
* @state: LED state to set |
5917112c9
|
43 44 |
* @return 0 if OK, -ve on error */ |
ddae9fcdd
|
45 |
int (*set_state)(struct udevice *dev, enum led_state_t state); |
8f4b61233
|
46 47 48 49 50 51 52 53 |
/** * 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); |
53378dac8
|
54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
#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 |
5917112c9
|
68 69 70 71 72 73 74 75 76 |
}; #define led_get_ops(dev) ((struct led_ops *)(dev)->driver->ops) /** * led_get_by_label() - Find an LED device by label * * @label: LED label to look up * @devp: Returns the associated device, if found |
fb8a5ffc7
|
77 |
* @return 0 if found, -ENODEV if not found, other -ve on error |
5917112c9
|
78 79 80 81 |
*/ int led_get_by_label(const char *label, struct udevice **devp); /** |
ddae9fcdd
|
82 |
* led_set_state() - set the state of an LED |
5917112c9
|
83 84 |
* * @dev: LED device to change |
ddae9fcdd
|
85 |
* @state: LED state to set |
5917112c9
|
86 87 |
* @return 0 if OK, -ve on error */ |
ddae9fcdd
|
88 |
int led_set_state(struct udevice *dev, enum led_state_t state); |
5917112c9
|
89 |
|
8f4b61233
|
90 91 92 93 94 95 96 |
/** * 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 led_get_state(struct udevice *dev); |
53378dac8
|
97 98 99 100 101 102 103 104 |
/** * 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_period(struct udevice *dev, int period_ms); |
5917112c9
|
105 |
#endif |