183d290c5STom Rini /* SPDX-License-Identifier: GPL-2.0+ */ 25917112cSSimon Glass /* 35917112cSSimon Glass * Copyright (c) 2015 Google, Inc 45917112cSSimon Glass * Written by Simon Glass <sjg@chromium.org> 55917112cSSimon Glass */ 65917112cSSimon Glass 75917112cSSimon Glass #ifndef __LED_H 85917112cSSimon Glass #define __LED_H 95917112cSSimon Glass 105917112cSSimon Glass /** 1156e19871SSimon Glass * struct led_uc_plat - Platform data the uclass stores about each device 125917112cSSimon Glass * 135917112cSSimon Glass * @label: LED label 145917112cSSimon Glass */ 1556e19871SSimon Glass struct led_uc_plat { 165917112cSSimon Glass const char *label; 175917112cSSimon Glass }; 185917112cSSimon Glass 1953378dacSSimon Glass /** 2053378dacSSimon Glass * struct led_uc_priv - Private data the uclass stores about each device 2153378dacSSimon Glass * 2253378dacSSimon Glass * @period_ms: Flash period in milliseconds 2353378dacSSimon Glass */ 2453378dacSSimon Glass struct led_uc_priv { 2553378dacSSimon Glass int period_ms; 2653378dacSSimon Glass }; 2753378dacSSimon Glass 28ddae9fcdSSimon Glass enum led_state_t { 29ddae9fcdSSimon Glass LEDST_OFF = 0, 30ddae9fcdSSimon Glass LEDST_ON = 1, 319413ad4fSSimon Glass LEDST_TOGGLE, 3253378dacSSimon Glass #ifdef CONFIG_LED_BLINK 3353378dacSSimon Glass LEDST_BLINK, 3453378dacSSimon Glass #endif 35ddae9fcdSSimon Glass 36ddae9fcdSSimon Glass LEDST_COUNT, 37ddae9fcdSSimon Glass }; 38ddae9fcdSSimon Glass 395917112cSSimon Glass struct led_ops { 405917112cSSimon Glass /** 41ddae9fcdSSimon Glass * set_state() - set the state of an LED 425917112cSSimon Glass * 435917112cSSimon Glass * @dev: LED device to change 44ddae9fcdSSimon Glass * @state: LED state to set 455917112cSSimon Glass * @return 0 if OK, -ve on error 465917112cSSimon Glass */ 47ddae9fcdSSimon Glass int (*set_state)(struct udevice *dev, enum led_state_t state); 488f4b6123SSimon Glass 498f4b6123SSimon Glass /** 508f4b6123SSimon Glass * led_get_state() - get the state of an LED 518f4b6123SSimon Glass * 528f4b6123SSimon Glass * @dev: LED device to change 538f4b6123SSimon Glass * @return LED state led_state_t, or -ve on error 548f4b6123SSimon Glass */ 558f4b6123SSimon Glass enum led_state_t (*get_state)(struct udevice *dev); 5653378dacSSimon Glass 5753378dacSSimon Glass #ifdef CONFIG_LED_BLINK 5853378dacSSimon Glass /** 5953378dacSSimon Glass * led_set_period() - set the blink period of an LED 6053378dacSSimon Glass * 6153378dacSSimon Glass * Thie records the period if supported, or returns -ENOSYS if not. 6253378dacSSimon Glass * To start the LED blinking, use set_state(). 6353378dacSSimon Glass * 6453378dacSSimon Glass * @dev: LED device to change 6553378dacSSimon Glass * @period_ms: LED blink period in milliseconds 6653378dacSSimon Glass * @return 0 if OK, -ve on error 6753378dacSSimon Glass */ 6853378dacSSimon Glass int (*set_period)(struct udevice *dev, int period_ms); 6953378dacSSimon Glass #endif 705917112cSSimon Glass }; 715917112cSSimon Glass 725917112cSSimon Glass #define led_get_ops(dev) ((struct led_ops *)(dev)->driver->ops) 735917112cSSimon Glass 745917112cSSimon Glass /** 755917112cSSimon Glass * led_get_by_label() - Find an LED device by label 765917112cSSimon Glass * 775917112cSSimon Glass * @label: LED label to look up 785917112cSSimon Glass * @devp: Returns the associated device, if found 79fb8a5ffcSSimon Glass * @return 0 if found, -ENODEV if not found, other -ve on error 805917112cSSimon Glass */ 815917112cSSimon Glass int led_get_by_label(const char *label, struct udevice **devp); 825917112cSSimon Glass 835917112cSSimon Glass /** 84ddae9fcdSSimon Glass * led_set_state() - set the state of an LED 855917112cSSimon Glass * 865917112cSSimon Glass * @dev: LED device to change 87ddae9fcdSSimon Glass * @state: LED state to set 885917112cSSimon Glass * @return 0 if OK, -ve on error 895917112cSSimon Glass */ 90ddae9fcdSSimon Glass int led_set_state(struct udevice *dev, enum led_state_t state); 915917112cSSimon Glass 928f4b6123SSimon Glass /** 938f4b6123SSimon Glass * led_get_state() - get the state of an LED 948f4b6123SSimon Glass * 958f4b6123SSimon Glass * @dev: LED device to change 968f4b6123SSimon Glass * @return LED state led_state_t, or -ve on error 978f4b6123SSimon Glass */ 988f4b6123SSimon Glass enum led_state_t led_get_state(struct udevice *dev); 998f4b6123SSimon Glass 10053378dacSSimon Glass /** 10153378dacSSimon Glass * led_set_period() - set the blink period of an LED 10253378dacSSimon Glass * 10353378dacSSimon Glass * @dev: LED device to change 10453378dacSSimon Glass * @period_ms: LED blink period in milliseconds 10553378dacSSimon Glass * @return 0 if OK, -ve on error 10653378dacSSimon Glass */ 10753378dacSSimon Glass int led_set_period(struct udevice *dev, int period_ms); 10853378dacSSimon Glass 109*d7a435a2SPatrick Delaunay /** 110*d7a435a2SPatrick Delaunay * led_default_state() - set the default state for all the LED 111*d7a435a2SPatrick Delaunay * 112*d7a435a2SPatrick Delaunay * This enables all leds which have default state. 113*d7a435a2SPatrick Delaunay * see Documentation/devicetree/bindings/leds/common.txt 114*d7a435a2SPatrick Delaunay * 115*d7a435a2SPatrick Delaunay */ 116*d7a435a2SPatrick Delaunay int led_default_state(void); 117*d7a435a2SPatrick Delaunay 1185917112cSSimon Glass #endif 119