1
2#ifndef __LINUX_GPIO_CONSUMER_H
3#define __LINUX_GPIO_CONSUMER_H
4
5#include <linux/bits.h>
6#include <linux/bug.h>
7#include <linux/compiler_types.h>
8#include <linux/err.h>
9
10struct device;
11
12
13
14
15
16
17
18
19struct gpio_desc;
20
21
22
23
24
25
26
27struct gpio_array;
28
29
30
31
32
33struct gpio_descs {
34 struct gpio_array *info;
35 unsigned int ndescs;
36 struct gpio_desc *desc[];
37};
38
39#define GPIOD_FLAGS_BIT_DIR_SET BIT(0)
40#define GPIOD_FLAGS_BIT_DIR_OUT BIT(1)
41#define GPIOD_FLAGS_BIT_DIR_VAL BIT(2)
42#define GPIOD_FLAGS_BIT_OPEN_DRAIN BIT(3)
43#define GPIOD_FLAGS_BIT_NONEXCLUSIVE BIT(4)
44
45
46
47
48
49enum gpiod_flags {
50 GPIOD_ASIS = 0,
51 GPIOD_IN = GPIOD_FLAGS_BIT_DIR_SET,
52 GPIOD_OUT_LOW = GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT,
53 GPIOD_OUT_HIGH = GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT |
54 GPIOD_FLAGS_BIT_DIR_VAL,
55 GPIOD_OUT_LOW_OPEN_DRAIN = GPIOD_OUT_LOW | GPIOD_FLAGS_BIT_OPEN_DRAIN,
56 GPIOD_OUT_HIGH_OPEN_DRAIN = GPIOD_OUT_HIGH | GPIOD_FLAGS_BIT_OPEN_DRAIN,
57};
58
59#ifdef CONFIG_GPIOLIB
60
61
62int gpiod_count(struct device *dev, const char *con_id);
63
64
65struct gpio_desc *__must_check gpiod_get(struct device *dev,
66 const char *con_id,
67 enum gpiod_flags flags);
68struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
69 const char *con_id,
70 unsigned int idx,
71 enum gpiod_flags flags);
72struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
73 const char *con_id,
74 enum gpiod_flags flags);
75struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
76 const char *con_id,
77 unsigned int index,
78 enum gpiod_flags flags);
79struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
80 const char *con_id,
81 enum gpiod_flags flags);
82struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
83 const char *con_id,
84 enum gpiod_flags flags);
85void gpiod_put(struct gpio_desc *desc);
86void gpiod_put_array(struct gpio_descs *descs);
87
88struct gpio_desc *__must_check devm_gpiod_get(struct device *dev,
89 const char *con_id,
90 enum gpiod_flags flags);
91struct gpio_desc *__must_check devm_gpiod_get_index(struct device *dev,
92 const char *con_id,
93 unsigned int idx,
94 enum gpiod_flags flags);
95struct gpio_desc *__must_check devm_gpiod_get_optional(struct device *dev,
96 const char *con_id,
97 enum gpiod_flags flags);
98struct gpio_desc *__must_check
99devm_gpiod_get_index_optional(struct device *dev, const char *con_id,
100 unsigned int index, enum gpiod_flags flags);
101struct gpio_descs *__must_check devm_gpiod_get_array(struct device *dev,
102 const char *con_id,
103 enum gpiod_flags flags);
104struct gpio_descs *__must_check
105devm_gpiod_get_array_optional(struct device *dev, const char *con_id,
106 enum gpiod_flags flags);
107void devm_gpiod_put(struct device *dev, struct gpio_desc *desc);
108void devm_gpiod_unhinge(struct device *dev, struct gpio_desc *desc);
109void devm_gpiod_put_array(struct device *dev, struct gpio_descs *descs);
110
111int gpiod_get_direction(struct gpio_desc *desc);
112int gpiod_direction_input(struct gpio_desc *desc);
113int gpiod_direction_output(struct gpio_desc *desc, int value);
114int gpiod_direction_output_raw(struct gpio_desc *desc, int value);
115
116
117int gpiod_get_value(const struct gpio_desc *desc);
118int gpiod_get_array_value(unsigned int array_size,
119 struct gpio_desc **desc_array,
120 struct gpio_array *array_info,
121 unsigned long *value_bitmap);
122void gpiod_set_value(struct gpio_desc *desc, int value);
123int gpiod_set_array_value(unsigned int array_size,
124 struct gpio_desc **desc_array,
125 struct gpio_array *array_info,
126 unsigned long *value_bitmap);
127int gpiod_get_raw_value(const struct gpio_desc *desc);
128int gpiod_get_raw_array_value(unsigned int array_size,
129 struct gpio_desc **desc_array,
130 struct gpio_array *array_info,
131 unsigned long *value_bitmap);
132void gpiod_set_raw_value(struct gpio_desc *desc, int value);
133int gpiod_set_raw_array_value(unsigned int array_size,
134 struct gpio_desc **desc_array,
135 struct gpio_array *array_info,
136 unsigned long *value_bitmap);
137
138
139int gpiod_get_value_cansleep(const struct gpio_desc *desc);
140int gpiod_get_array_value_cansleep(unsigned int array_size,
141 struct gpio_desc **desc_array,
142 struct gpio_array *array_info,
143 unsigned long *value_bitmap);
144void gpiod_set_value_cansleep(struct gpio_desc *desc, int value);
145int gpiod_set_array_value_cansleep(unsigned int array_size,
146 struct gpio_desc **desc_array,
147 struct gpio_array *array_info,
148 unsigned long *value_bitmap);
149int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc);
150int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
151 struct gpio_desc **desc_array,
152 struct gpio_array *array_info,
153 unsigned long *value_bitmap);
154void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value);
155int gpiod_set_raw_array_value_cansleep(unsigned int array_size,
156 struct gpio_desc **desc_array,
157 struct gpio_array *array_info,
158 unsigned long *value_bitmap);
159
160int gpiod_set_config(struct gpio_desc *desc, unsigned long config);
161int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce);
162int gpiod_set_transitory(struct gpio_desc *desc, bool transitory);
163void gpiod_toggle_active_low(struct gpio_desc *desc);
164
165int gpiod_is_active_low(const struct gpio_desc *desc);
166int gpiod_cansleep(const struct gpio_desc *desc);
167
168int gpiod_to_irq(const struct gpio_desc *desc);
169int gpiod_set_consumer_name(struct gpio_desc *desc, const char *name);
170
171
172struct gpio_desc *gpio_to_desc(unsigned gpio);
173int desc_to_gpio(const struct gpio_desc *desc);
174
175
176struct fwnode_handle;
177
178struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
179 const char *propname, int index,
180 enum gpiod_flags dflags,
181 const char *label);
182struct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode,
183 const char *con_id, int index,
184 enum gpiod_flags flags,
185 const char *label);
186struct gpio_desc *devm_fwnode_gpiod_get_index(struct device *dev,
187 struct fwnode_handle *child,
188 const char *con_id, int index,
189 enum gpiod_flags flags,
190 const char *label);
191
192#else
193
194#include <linux/kernel.h>
195
196static inline int gpiod_count(struct device *dev, const char *con_id)
197{
198 return 0;
199}
200
201static inline struct gpio_desc *__must_check gpiod_get(struct device *dev,
202 const char *con_id,
203 enum gpiod_flags flags)
204{
205 return ERR_PTR(-ENOSYS);
206}
207static inline struct gpio_desc *__must_check
208gpiod_get_index(struct device *dev,
209 const char *con_id,
210 unsigned int idx,
211 enum gpiod_flags flags)
212{
213 return ERR_PTR(-ENOSYS);
214}
215
216static inline struct gpio_desc *__must_check
217gpiod_get_optional(struct device *dev, const char *con_id,
218 enum gpiod_flags flags)
219{
220 return NULL;
221}
222
223static inline struct gpio_desc *__must_check
224gpiod_get_index_optional(struct device *dev, const char *con_id,
225 unsigned int index, enum gpiod_flags flags)
226{
227 return NULL;
228}
229
230static inline struct gpio_descs *__must_check
231gpiod_get_array(struct device *dev, const char *con_id,
232 enum gpiod_flags flags)
233{
234 return ERR_PTR(-ENOSYS);
235}
236
237static inline struct gpio_descs *__must_check
238gpiod_get_array_optional(struct device *dev, const char *con_id,
239 enum gpiod_flags flags)
240{
241 return NULL;
242}
243
244static inline void gpiod_put(struct gpio_desc *desc)
245{
246 might_sleep();
247
248
249 WARN_ON(desc);
250}
251
252static inline void devm_gpiod_unhinge(struct device *dev,
253 struct gpio_desc *desc)
254{
255 might_sleep();
256
257
258 WARN_ON(desc);
259}
260
261static inline void gpiod_put_array(struct gpio_descs *descs)
262{
263 might_sleep();
264
265
266 WARN_ON(descs);
267}
268
269static inline struct gpio_desc *__must_check
270devm_gpiod_get(struct device *dev,
271 const char *con_id,
272 enum gpiod_flags flags)
273{
274 return ERR_PTR(-ENOSYS);
275}
276static inline
277struct gpio_desc *__must_check
278devm_gpiod_get_index(struct device *dev,
279 const char *con_id,
280 unsigned int idx,
281 enum gpiod_flags flags)
282{
283 return ERR_PTR(-ENOSYS);
284}
285
286static inline struct gpio_desc *__must_check
287devm_gpiod_get_optional(struct device *dev, const char *con_id,
288 enum gpiod_flags flags)
289{
290 return NULL;
291}
292
293static inline struct gpio_desc *__must_check
294devm_gpiod_get_index_optional(struct device *dev, const char *con_id,
295 unsigned int index, enum gpiod_flags flags)
296{
297 return NULL;
298}
299
300static inline struct gpio_descs *__must_check
301devm_gpiod_get_array(struct device *dev, const char *con_id,
302 enum gpiod_flags flags)
303{
304 return ERR_PTR(-ENOSYS);
305}
306
307static inline struct gpio_descs *__must_check
308devm_gpiod_get_array_optional(struct device *dev, const char *con_id,
309 enum gpiod_flags flags)
310{
311 return NULL;
312}
313
314static inline void devm_gpiod_put(struct device *dev, struct gpio_desc *desc)
315{
316 might_sleep();
317
318
319 WARN_ON(desc);
320}
321
322static inline void devm_gpiod_put_array(struct device *dev,
323 struct gpio_descs *descs)
324{
325 might_sleep();
326
327
328 WARN_ON(descs);
329}
330
331
332static inline int gpiod_get_direction(const struct gpio_desc *desc)
333{
334
335 WARN_ON(desc);
336 return -ENOSYS;
337}
338static inline int gpiod_direction_input(struct gpio_desc *desc)
339{
340
341 WARN_ON(desc);
342 return -ENOSYS;
343}
344static inline int gpiod_direction_output(struct gpio_desc *desc, int value)
345{
346
347 WARN_ON(desc);
348 return -ENOSYS;
349}
350static inline int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
351{
352
353 WARN_ON(desc);
354 return -ENOSYS;
355}
356
357
358static inline int gpiod_get_value(const struct gpio_desc *desc)
359{
360
361 WARN_ON(desc);
362 return 0;
363}
364static inline int gpiod_get_array_value(unsigned int array_size,
365 struct gpio_desc **desc_array,
366 struct gpio_array *array_info,
367 unsigned long *value_bitmap)
368{
369
370 WARN_ON(desc_array);
371 return 0;
372}
373static inline void gpiod_set_value(struct gpio_desc *desc, int value)
374{
375
376 WARN_ON(desc);
377}
378static inline int gpiod_set_array_value(unsigned int array_size,
379 struct gpio_desc **desc_array,
380 struct gpio_array *array_info,
381 unsigned long *value_bitmap)
382{
383
384 WARN_ON(desc_array);
385 return 0;
386}
387static inline int gpiod_get_raw_value(const struct gpio_desc *desc)
388{
389
390 WARN_ON(desc);
391 return 0;
392}
393static inline int gpiod_get_raw_array_value(unsigned int array_size,
394 struct gpio_desc **desc_array,
395 struct gpio_array *array_info,
396 unsigned long *value_bitmap)
397{
398
399 WARN_ON(desc_array);
400 return 0;
401}
402static inline void gpiod_set_raw_value(struct gpio_desc *desc, int value)
403{
404
405 WARN_ON(desc);
406}
407static inline int gpiod_set_raw_array_value(unsigned int array_size,
408 struct gpio_desc **desc_array,
409 struct gpio_array *array_info,
410 unsigned long *value_bitmap)
411{
412
413 WARN_ON(desc_array);
414 return 0;
415}
416
417static inline int gpiod_get_value_cansleep(const struct gpio_desc *desc)
418{
419
420 WARN_ON(desc);
421 return 0;
422}
423static inline int gpiod_get_array_value_cansleep(unsigned int array_size,
424 struct gpio_desc **desc_array,
425 struct gpio_array *array_info,
426 unsigned long *value_bitmap)
427{
428
429 WARN_ON(desc_array);
430 return 0;
431}
432static inline void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
433{
434
435 WARN_ON(desc);
436}
437static inline int gpiod_set_array_value_cansleep(unsigned int array_size,
438 struct gpio_desc **desc_array,
439 struct gpio_array *array_info,
440 unsigned long *value_bitmap)
441{
442
443 WARN_ON(desc_array);
444 return 0;
445}
446static inline int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
447{
448
449 WARN_ON(desc);
450 return 0;
451}
452static inline int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
453 struct gpio_desc **desc_array,
454 struct gpio_array *array_info,
455 unsigned long *value_bitmap)
456{
457
458 WARN_ON(desc_array);
459 return 0;
460}
461static inline void gpiod_set_raw_value_cansleep(struct gpio_desc *desc,
462 int value)
463{
464
465 WARN_ON(desc);
466}
467static inline int gpiod_set_raw_array_value_cansleep(unsigned int array_size,
468 struct gpio_desc **desc_array,
469 struct gpio_array *array_info,
470 unsigned long *value_bitmap)
471{
472
473 WARN_ON(desc_array);
474 return 0;
475}
476
477static inline int gpiod_set_config(struct gpio_desc *desc, unsigned long config)
478{
479
480 WARN_ON(desc);
481 return -ENOSYS;
482}
483
484static inline int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
485{
486
487 WARN_ON(desc);
488 return -ENOSYS;
489}
490
491static inline int gpiod_set_transitory(struct gpio_desc *desc, bool transitory)
492{
493
494 WARN_ON(desc);
495 return -ENOSYS;
496}
497
498static inline void gpiod_toggle_active_low(struct gpio_desc *desc)
499{
500
501 WARN_ON(desc);
502}
503
504static inline int gpiod_is_active_low(const struct gpio_desc *desc)
505{
506
507 WARN_ON(desc);
508 return 0;
509}
510static inline int gpiod_cansleep(const struct gpio_desc *desc)
511{
512
513 WARN_ON(desc);
514 return 0;
515}
516
517static inline int gpiod_to_irq(const struct gpio_desc *desc)
518{
519
520 WARN_ON(desc);
521 return -EINVAL;
522}
523
524static inline int gpiod_set_consumer_name(struct gpio_desc *desc,
525 const char *name)
526{
527
528 WARN_ON(desc);
529 return -EINVAL;
530}
531
532static inline struct gpio_desc *gpio_to_desc(unsigned gpio)
533{
534 return NULL;
535}
536
537static inline int desc_to_gpio(const struct gpio_desc *desc)
538{
539
540 WARN_ON(desc);
541 return -EINVAL;
542}
543
544
545struct fwnode_handle;
546
547static inline
548struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
549 const char *propname, int index,
550 enum gpiod_flags dflags,
551 const char *label)
552{
553 return ERR_PTR(-ENOSYS);
554}
555
556static inline
557struct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode,
558 const char *con_id, int index,
559 enum gpiod_flags flags,
560 const char *label)
561{
562 return ERR_PTR(-ENOSYS);
563}
564
565static inline
566struct gpio_desc *devm_fwnode_gpiod_get_index(struct device *dev,
567 struct fwnode_handle *fwnode,
568 const char *con_id, int index,
569 enum gpiod_flags flags,
570 const char *label)
571{
572 return ERR_PTR(-ENOSYS);
573}
574
575#endif
576
577static inline
578struct gpio_desc *devm_fwnode_gpiod_get(struct device *dev,
579 struct fwnode_handle *fwnode,
580 const char *con_id,
581 enum gpiod_flags flags,
582 const char *label)
583{
584 return devm_fwnode_gpiod_get_index(dev, fwnode, con_id, 0,
585 flags, label);
586}
587
588static inline
589struct gpio_desc *devm_fwnode_get_index_gpiod_from_child(struct device *dev,
590 const char *con_id, int index,
591 struct fwnode_handle *child,
592 enum gpiod_flags flags,
593 const char *label)
594{
595 return devm_fwnode_gpiod_get_index(dev, child, con_id, index,
596 flags, label);
597}
598
599static inline
600struct gpio_desc *devm_fwnode_get_gpiod_from_child(struct device *dev,
601 const char *con_id,
602 struct fwnode_handle *child,
603 enum gpiod_flags flags,
604 const char *label)
605{
606 return devm_fwnode_gpiod_get_index(dev, child, con_id, 0, flags, label);
607}
608
609#if IS_ENABLED(CONFIG_GPIOLIB) && IS_ENABLED(CONFIG_OF_GPIO)
610struct device_node;
611
612struct gpio_desc *gpiod_get_from_of_node(struct device_node *node,
613 const char *propname, int index,
614 enum gpiod_flags dflags,
615 const char *label);
616
617#else
618
619struct device_node;
620
621static inline
622struct gpio_desc *gpiod_get_from_of_node(struct device_node *node,
623 const char *propname, int index,
624 enum gpiod_flags dflags,
625 const char *label)
626{
627 return ERR_PTR(-ENOSYS);
628}
629
630#endif
631
632#ifdef CONFIG_GPIOLIB
633struct device_node;
634
635struct gpio_desc *devm_gpiod_get_from_of_node(struct device *dev,
636 struct device_node *node,
637 const char *propname, int index,
638 enum gpiod_flags dflags,
639 const char *label);
640
641#else
642
643struct device_node;
644
645static inline
646struct gpio_desc *devm_gpiod_get_from_of_node(struct device *dev,
647 struct device_node *node,
648 const char *propname, int index,
649 enum gpiod_flags dflags,
650 const char *label)
651{
652 return ERR_PTR(-ENOSYS);
653}
654
655#endif
656
657struct acpi_gpio_params {
658 unsigned int crs_entry_index;
659 unsigned int line_index;
660 bool active_low;
661};
662
663struct acpi_gpio_mapping {
664 const char *name;
665 const struct acpi_gpio_params *data;
666 unsigned int size;
667
668
669#define ACPI_GPIO_QUIRK_NO_IO_RESTRICTION BIT(0)
670
671
672
673
674
675
676#define ACPI_GPIO_QUIRK_ONLY_GPIOIO BIT(1)
677
678 unsigned int quirks;
679};
680
681#if IS_ENABLED(CONFIG_GPIOLIB) && IS_ENABLED(CONFIG_ACPI)
682
683struct acpi_device;
684
685int acpi_dev_add_driver_gpios(struct acpi_device *adev,
686 const struct acpi_gpio_mapping *gpios);
687void acpi_dev_remove_driver_gpios(struct acpi_device *adev);
688
689int devm_acpi_dev_add_driver_gpios(struct device *dev,
690 const struct acpi_gpio_mapping *gpios);
691void devm_acpi_dev_remove_driver_gpios(struct device *dev);
692
693#else
694
695struct acpi_device;
696
697static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev,
698 const struct acpi_gpio_mapping *gpios)
699{
700 return -ENXIO;
701}
702static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev) {}
703
704static inline int devm_acpi_dev_add_driver_gpios(struct device *dev,
705 const struct acpi_gpio_mapping *gpios)
706{
707 return -ENXIO;
708}
709static inline void devm_acpi_dev_remove_driver_gpios(struct device *dev) {}
710
711#endif
712
713
714#if IS_ENABLED(CONFIG_GPIOLIB) && IS_ENABLED(CONFIG_GPIO_SYSFS)
715
716int gpiod_export(struct gpio_desc *desc, bool direction_may_change);
717int gpiod_export_link(struct device *dev, const char *name,
718 struct gpio_desc *desc);
719void gpiod_unexport(struct gpio_desc *desc);
720
721#else
722
723static inline int gpiod_export(struct gpio_desc *desc,
724 bool direction_may_change)
725{
726 return -ENOSYS;
727}
728
729static inline int gpiod_export_link(struct device *dev, const char *name,
730 struct gpio_desc *desc)
731{
732 return -ENOSYS;
733}
734
735static inline void gpiod_unexport(struct gpio_desc *desc)
736{
737}
738
739#endif
740
741#endif
742