led.h 2.4 KB

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