blob: 940b97f58c00e0dde4c5969eeffe150b25da6f31 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass59171122015-06-23 15:38:45 -06002/*
3 * Copyright (c) 2015 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
Simon Glass59171122015-06-23 15:38:45 -06005 */
6
7#ifndef __LED_H
8#define __LED_H
9
10/**
Simon Glass56e19872017-04-10 11:34:53 -060011 * struct led_uc_plat - Platform data the uclass stores about each device
Simon Glass59171122015-06-23 15:38:45 -060012 *
13 * @label: LED label
14 */
Simon Glass56e19872017-04-10 11:34:53 -060015struct led_uc_plat {
Simon Glass59171122015-06-23 15:38:45 -060016 const char *label;
17};
18
Simon Glass53378da2017-04-10 11:34:57 -060019/**
20 * struct led_uc_priv - Private data the uclass stores about each device
21 *
22 * @period_ms: Flash period in milliseconds
23 */
24struct led_uc_priv {
25 int period_ms;
26};
27
Simon Glassddae9fc2017-04-10 11:34:54 -060028enum led_state_t {
29 LEDST_OFF = 0,
30 LEDST_ON = 1,
Simon Glass9413ad42017-04-10 11:34:56 -060031 LEDST_TOGGLE,
Simon Glass53378da2017-04-10 11:34:57 -060032#ifdef CONFIG_LED_BLINK
33 LEDST_BLINK,
34#endif
Simon Glassddae9fc2017-04-10 11:34:54 -060035
36 LEDST_COUNT,
37};
38
Simon Glass59171122015-06-23 15:38:45 -060039struct led_ops {
40 /**
Simon Glassddae9fc2017-04-10 11:34:54 -060041 * set_state() - set the state of an LED
Simon Glass59171122015-06-23 15:38:45 -060042 *
43 * @dev: LED device to change
Simon Glassddae9fc2017-04-10 11:34:54 -060044 * @state: LED state to set
Simon Glass59171122015-06-23 15:38:45 -060045 * @return 0 if OK, -ve on error
46 */
Simon Glassddae9fc2017-04-10 11:34:54 -060047 int (*set_state)(struct udevice *dev, enum led_state_t state);
Simon Glass8f4b6122017-04-10 11:34:55 -060048
49 /**
50 * led_get_state() - get the state of an LED
51 *
52 * @dev: LED device to change
53 * @return LED state led_state_t, or -ve on error
54 */
55 enum led_state_t (*get_state)(struct udevice *dev);
Simon Glass53378da2017-04-10 11:34:57 -060056
57#ifdef CONFIG_LED_BLINK
58 /**
59 * led_set_period() - set the blink period of an LED
60 *
61 * Thie records the period if supported, or returns -ENOSYS if not.
62 * To start the LED blinking, use set_state().
63 *
64 * @dev: LED device to change
65 * @period_ms: LED blink period in milliseconds
66 * @return 0 if OK, -ve on error
67 */
68 int (*set_period)(struct udevice *dev, int period_ms);
69#endif
Simon Glass59171122015-06-23 15:38:45 -060070};
71
72#define led_get_ops(dev) ((struct led_ops *)(dev)->driver->ops)
73
74/**
75 * led_get_by_label() - Find an LED device by label
76 *
77 * @label: LED label to look up
78 * @devp: Returns the associated device, if found
Simon Glassfb8a5ff2015-07-06 12:54:33 -060079 * @return 0 if found, -ENODEV if not found, other -ve on error
Simon Glass59171122015-06-23 15:38:45 -060080 */
81int led_get_by_label(const char *label, struct udevice **devp);
82
83/**
Simon Glassddae9fc2017-04-10 11:34:54 -060084 * led_set_state() - set the state of an LED
Simon Glass59171122015-06-23 15:38:45 -060085 *
86 * @dev: LED device to change
Simon Glassddae9fc2017-04-10 11:34:54 -060087 * @state: LED state to set
Simon Glass59171122015-06-23 15:38:45 -060088 * @return 0 if OK, -ve on error
89 */
Simon Glassddae9fc2017-04-10 11:34:54 -060090int led_set_state(struct udevice *dev, enum led_state_t state);
Simon Glass59171122015-06-23 15:38:45 -060091
Simon Glass8f4b6122017-04-10 11:34:55 -060092/**
93 * led_get_state() - get the state of an LED
94 *
95 * @dev: LED device to change
96 * @return LED state led_state_t, or -ve on error
97 */
98enum led_state_t led_get_state(struct udevice *dev);
99
Simon Glass53378da2017-04-10 11:34:57 -0600100/**
101 * led_set_period() - set the blink period of an LED
102 *
103 * @dev: LED device to change
104 * @period_ms: LED blink period in milliseconds
105 * @return 0 if OK, -ve on error
106 */
107int led_set_period(struct udevice *dev, int period_ms);
108
Simon Glass59171122015-06-23 15:38:45 -0600109#endif