consumer.h 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Consumer interface the pin control subsystem
  4. *
  5. * Copyright (C) 2012 ST-Ericsson SA
  6. * Written on behalf of Linaro for ST-Ericsson
  7. * Based on bits of regulator core, gpio core and clk core
  8. *
  9. * Author: Linus Walleij <[email protected]>
  10. */
  11. #ifndef __LINUX_PINCTRL_CONSUMER_H
  12. #define __LINUX_PINCTRL_CONSUMER_H
  13. #include <linux/err.h>
  14. #include <linux/list.h>
  15. #include <linux/seq_file.h>
  16. #include <linux/pinctrl/pinctrl-state.h>
  17. /* This struct is private to the core and should be regarded as a cookie */
  18. struct pinctrl;
  19. struct pinctrl_state;
  20. struct device;
  21. #ifdef CONFIG_PINCTRL
  22. /* External interface to pin control */
  23. extern bool pinctrl_gpio_can_use_line(unsigned gpio);
  24. extern int pinctrl_gpio_request(unsigned gpio);
  25. extern void pinctrl_gpio_free(unsigned gpio);
  26. extern int pinctrl_gpio_direction_input(unsigned gpio);
  27. extern int pinctrl_gpio_direction_output(unsigned gpio);
  28. extern int pinctrl_gpio_set_config(unsigned gpio, unsigned long config);
  29. extern struct pinctrl * __must_check pinctrl_get(struct device *dev);
  30. extern void pinctrl_put(struct pinctrl *p);
  31. extern struct pinctrl_state * __must_check pinctrl_lookup_state(
  32. struct pinctrl *p,
  33. const char *name);
  34. extern int pinctrl_select_state(struct pinctrl *p, struct pinctrl_state *s);
  35. extern struct pinctrl * __must_check devm_pinctrl_get(struct device *dev);
  36. extern void devm_pinctrl_put(struct pinctrl *p);
  37. extern int pinctrl_select_default_state(struct device *dev);
  38. #ifdef CONFIG_PM
  39. extern int pinctrl_pm_select_default_state(struct device *dev);
  40. extern int pinctrl_pm_select_sleep_state(struct device *dev);
  41. extern int pinctrl_pm_select_idle_state(struct device *dev);
  42. #else
  43. static inline int pinctrl_pm_select_default_state(struct device *dev)
  44. {
  45. return 0;
  46. }
  47. static inline int pinctrl_pm_select_sleep_state(struct device *dev)
  48. {
  49. return 0;
  50. }
  51. static inline int pinctrl_pm_select_idle_state(struct device *dev)
  52. {
  53. return 0;
  54. }
  55. #endif
  56. #else /* !CONFIG_PINCTRL */
  57. static inline bool pinctrl_gpio_can_use_line(unsigned gpio)
  58. {
  59. return true;
  60. }
  61. static inline int pinctrl_gpio_request(unsigned gpio)
  62. {
  63. return 0;
  64. }
  65. static inline void pinctrl_gpio_free(unsigned gpio)
  66. {
  67. }
  68. static inline int pinctrl_gpio_direction_input(unsigned gpio)
  69. {
  70. return 0;
  71. }
  72. static inline int pinctrl_gpio_direction_output(unsigned gpio)
  73. {
  74. return 0;
  75. }
  76. static inline int pinctrl_gpio_set_config(unsigned gpio, unsigned long config)
  77. {
  78. return 0;
  79. }
  80. static inline struct pinctrl * __must_check pinctrl_get(struct device *dev)
  81. {
  82. return NULL;
  83. }
  84. static inline void pinctrl_put(struct pinctrl *p)
  85. {
  86. }
  87. static inline struct pinctrl_state * __must_check pinctrl_lookup_state(
  88. struct pinctrl *p,
  89. const char *name)
  90. {
  91. return NULL;
  92. }
  93. static inline int pinctrl_select_state(struct pinctrl *p,
  94. struct pinctrl_state *s)
  95. {
  96. return 0;
  97. }
  98. static inline struct pinctrl * __must_check devm_pinctrl_get(struct device *dev)
  99. {
  100. return NULL;
  101. }
  102. static inline void devm_pinctrl_put(struct pinctrl *p)
  103. {
  104. }
  105. static inline int pinctrl_select_default_state(struct device *dev)
  106. {
  107. return 0;
  108. }
  109. static inline int pinctrl_pm_select_default_state(struct device *dev)
  110. {
  111. return 0;
  112. }
  113. static inline int pinctrl_pm_select_sleep_state(struct device *dev)
  114. {
  115. return 0;
  116. }
  117. static inline int pinctrl_pm_select_idle_state(struct device *dev)
  118. {
  119. return 0;
  120. }
  121. #endif /* CONFIG_PINCTRL */
  122. static inline struct pinctrl * __must_check pinctrl_get_select(
  123. struct device *dev, const char *name)
  124. {
  125. struct pinctrl *p;
  126. struct pinctrl_state *s;
  127. int ret;
  128. p = pinctrl_get(dev);
  129. if (IS_ERR(p))
  130. return p;
  131. s = pinctrl_lookup_state(p, name);
  132. if (IS_ERR(s)) {
  133. pinctrl_put(p);
  134. return ERR_CAST(s);
  135. }
  136. ret = pinctrl_select_state(p, s);
  137. if (ret < 0) {
  138. pinctrl_put(p);
  139. return ERR_PTR(ret);
  140. }
  141. return p;
  142. }
  143. static inline struct pinctrl * __must_check pinctrl_get_select_default(
  144. struct device *dev)
  145. {
  146. return pinctrl_get_select(dev, PINCTRL_STATE_DEFAULT);
  147. }
  148. static inline struct pinctrl * __must_check devm_pinctrl_get_select(
  149. struct device *dev, const char *name)
  150. {
  151. struct pinctrl *p;
  152. struct pinctrl_state *s;
  153. int ret;
  154. p = devm_pinctrl_get(dev);
  155. if (IS_ERR(p))
  156. return p;
  157. s = pinctrl_lookup_state(p, name);
  158. if (IS_ERR(s)) {
  159. devm_pinctrl_put(p);
  160. return ERR_CAST(s);
  161. }
  162. ret = pinctrl_select_state(p, s);
  163. if (ret < 0) {
  164. devm_pinctrl_put(p);
  165. return ERR_PTR(ret);
  166. }
  167. return p;
  168. }
  169. static inline struct pinctrl * __must_check devm_pinctrl_get_select_default(
  170. struct device *dev)
  171. {
  172. return devm_pinctrl_get_select(dev, PINCTRL_STATE_DEFAULT);
  173. }
  174. #endif /* __LINUX_PINCTRL_CONSUMER_H */