led.h 2.6 KB

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