led.h 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * Copyright (c) 2015 Google, Inc
  4. * Written by Simon Glass <sjg@chromium.org>
  5. */
  6. #ifndef __LED_H
  7. #define __LED_H
  8. struct udevice;
  9. /**
  10. * struct led_uc_plat - Platform data the uclass stores about each device
  11. *
  12. * @label: LED label
  13. */
  14. struct led_uc_plat {
  15. const char *label;
  16. };
  17. /**
  18. * struct led_uc_priv - Private data the uclass stores about each device
  19. *
  20. * @period_ms: Flash period in milliseconds
  21. */
  22. struct led_uc_priv {
  23. int period_ms;
  24. };
  25. enum led_state_t {
  26. LEDST_OFF = 0,
  27. LEDST_ON = 1,
  28. LEDST_TOGGLE,
  29. #ifdef CONFIG_LED_BLINK
  30. LEDST_BLINK,
  31. #endif
  32. LEDST_COUNT,
  33. };
  34. struct led_ops {
  35. /**
  36. * set_state() - set the state of an LED
  37. *
  38. * @dev: LED device to change
  39. * @state: LED state to set
  40. * @return 0 if OK, -ve on error
  41. */
  42. int (*set_state)(struct udevice *dev, enum led_state_t state);
  43. /**
  44. * led_get_state() - get the state of an LED
  45. *
  46. * @dev: LED device to change
  47. * @return LED state led_state_t, or -ve on error
  48. */
  49. enum led_state_t (*get_state)(struct udevice *dev);
  50. #ifdef CONFIG_LED_BLINK
  51. /**
  52. * led_set_period() - set the blink period of an LED
  53. *
  54. * Thie records the period if supported, or returns -ENOSYS if not.
  55. * To start the LED blinking, use set_state().
  56. *
  57. * @dev: LED device to change
  58. * @period_ms: LED blink period in milliseconds
  59. * @return 0 if OK, -ve on error
  60. */
  61. int (*set_period)(struct udevice *dev, int period_ms);
  62. #endif
  63. };
  64. #define led_get_ops(dev) ((struct led_ops *)(dev)->driver->ops)
  65. /**
  66. * led_get_by_label() - Find an LED device by label
  67. *
  68. * @label: LED label to look up
  69. * @devp: Returns the associated device, if found
  70. * @return 0 if found, -ENODEV if not found, other -ve on error
  71. */
  72. int led_get_by_label(const char *label, struct udevice **devp);
  73. /**
  74. * led_set_state() - set the state of an LED
  75. *
  76. * @dev: LED device to change
  77. * @state: LED state to set
  78. * @return 0 if OK, -ve on error
  79. */
  80. int led_set_state(struct udevice *dev, enum led_state_t state);
  81. /**
  82. * led_get_state() - get the state of an LED
  83. *
  84. * @dev: LED device to change
  85. * @return LED state led_state_t, or -ve on error
  86. */
  87. enum led_state_t led_get_state(struct udevice *dev);
  88. /**
  89. * led_set_period() - set the blink period of an LED
  90. *
  91. * @dev: LED device to change
  92. * @period_ms: LED blink period in milliseconds
  93. * @return 0 if OK, -ve on error
  94. */
  95. int led_set_period(struct udevice *dev, int period_ms);
  96. /**
  97. * led_default_state() - set the default state for all the LED
  98. *
  99. * This enables all leds which have default state.
  100. * see Documentation/devicetree/bindings/leds/common.txt
  101. *
  102. */
  103. int led_default_state(void);
  104. #endif