gpio.h 4.41 KB
Newer Older
David Brownell's avatar
David Brownell committed
1 2 3
#ifndef _ASM_GENERIC_GPIO_H
#define _ASM_GENERIC_GPIO_H

4
#include <linux/kernel.h>
David Brownell's avatar
David Brownell committed
5
#include <linux/types.h>
6
#include <linux/errno.h>
7
#include <linux/of.h>
David Brownell's avatar
David Brownell committed
8

9
#ifdef CONFIG_GPIOLIB
10

David Brownell's avatar
David Brownell committed
11
#include <linux/compiler.h>
12 13
#include <linux/gpio/driver.h>
#include <linux/gpio/consumer.h>
David Brownell's avatar
David Brownell committed
14

15 16 17 18 19 20
/* Platforms may implement their GPIO interface with library code,
 * at a small performance cost for non-inlined operations and some
 * extra memory (for code and for per-GPIO table entries).
 *
 * While the GPIO programming interface defines valid GPIO numbers
 * to be in the range 0..MAX_INT, this library restricts them to the
21
 * smaller range 0..ARCH_NR_GPIOS-1.
David Brownell's avatar
David Brownell committed
22 23 24 25
 *
 * ARCH_NR_GPIOS is somewhat arbitrary; it usually reflects the sum of
 * builtin/SoC GPIOs plus a number of GPIOs on expanders; the latter is
 * actually an estimate of a board-specific value.
26 27 28
 */

#ifndef ARCH_NR_GPIOS
29 30 31
#if defined(CONFIG_ARCH_NR_GPIO) && CONFIG_ARCH_NR_GPIO > 0
#define ARCH_NR_GPIOS CONFIG_ARCH_NR_GPIO
#else
32
#define ARCH_NR_GPIOS		512
33
#endif
34
#endif
35

David Brownell's avatar
David Brownell committed
36 37 38 39 40 41 42 43 44
/*
 * "valid" GPIO numbers are nonnegative and may be passed to
 * setup routines like gpio_request().  only some valid numbers
 * can successfully be requested and used.
 *
 * Invalid GPIO numbers are useful for indicating no-such-GPIO in
 * platform data and other tables.
 */

45
static inline bool gpio_is_valid(int number)
46
{
47
	return number >= 0 && number < ARCH_NR_GPIOS;
48 49
}

50
struct device;
51
struct gpio;
52
struct seq_file;
53
struct module;
54
struct device_node;
55
struct gpio_desc;
56

57 58 59 60 61
/* caller holds gpio_lock *OR* gpio is marked as requested */
static inline struct gpio_chip *gpio_to_chip(unsigned gpio)
{
	return gpiod_to_chip(gpio_to_desc(gpio));
}
62 63 64 65

/* Always use the library code for GPIO management calls,
 * or when sleeping may be involved.
 */
66
extern int gpio_request(unsigned gpio, const char *label);
67 68
extern void gpio_free(unsigned gpio);

69 70 71 72 73 74 75 76
static inline int gpio_direction_input(unsigned gpio)
{
	return gpiod_direction_input(gpio_to_desc(gpio));
}
static inline int gpio_direction_output(unsigned gpio, int value)
{
	return gpiod_direction_output_raw(gpio_to_desc(gpio), value);
}
77

78 79 80 81
static inline int gpio_set_debounce(unsigned gpio, unsigned debounce)
{
	return gpiod_set_debounce(gpio_to_desc(gpio), debounce);
}
82

83 84 85 86 87 88 89 90
static inline int gpio_get_value_cansleep(unsigned gpio)
{
	return gpiod_get_raw_value_cansleep(gpio_to_desc(gpio));
}
static inline void gpio_set_value_cansleep(unsigned gpio, int value)
{
	return gpiod_set_raw_value_cansleep(gpio_to_desc(gpio), value);
}
91 92 93 94 95 96


/* A platform's <asm/gpio.h> code may want to inline the I/O calls when
 * the GPIO is constant and refers to some always-present controller,
 * giving direct access to chip registers and tight bitbanging loops.
 */
97 98 99 100 101 102 103 104
static inline int __gpio_get_value(unsigned gpio)
{
	return gpiod_get_raw_value(gpio_to_desc(gpio));
}
static inline void __gpio_set_value(unsigned gpio, int value)
{
	return gpiod_set_raw_value(gpio_to_desc(gpio), value);
}
105

106 107 108 109
static inline int __gpio_cansleep(unsigned gpio)
{
	return gpiod_cansleep(gpio_to_desc(gpio));
}
110

111 112 113 114
static inline int __gpio_to_irq(unsigned gpio)
{
	return gpiod_to_irq(gpio_to_desc(gpio));
}
115

116
extern int gpio_request_one(unsigned gpio, unsigned long flags, const char *label);
117 118
extern int gpio_request_array(const struct gpio *array, size_t num);
extern void gpio_free_array(const struct gpio *array, size_t num);
119

David Brownell's avatar
David Brownell committed
120 121 122 123
/*
 * A sysfs interface can be exported by individual drivers if they want,
 * but more typically is configured entirely from userspace.
 */
124 125 126 127
static inline int gpio_export(unsigned gpio, bool direction_may_change)
{
	return gpiod_export(gpio_to_desc(gpio), direction_may_change);
}
David Brownell's avatar
David Brownell committed
128

129 130 131 132 133 134 135 136 137 138
static inline int gpio_export_link(struct device *dev, const char *name,
				   unsigned gpio)
{
	return gpiod_export_link(dev, name, gpio_to_desc(gpio));
}

static inline void gpio_unexport(unsigned gpio)
{
	gpiod_unexport(gpio_to_desc(gpio));
}
David Brownell's avatar
David Brownell committed
139

140
#else	/* !CONFIG_GPIOLIB */
141

142
static inline bool gpio_is_valid(int number)
143 144 145 146 147
{
	/* only non-negative numbers are valid */
	return number >= 0;
}

David Brownell's avatar
David Brownell committed
148 149 150 151 152 153 154 155 156 157 158 159
/* platforms that don't directly support access to GPIOs through I2C, SPI,
 * or other blocking infrastructure can use these wrappers.
 */

static inline int gpio_cansleep(unsigned gpio)
{
	return 0;
}

static inline int gpio_get_value_cansleep(unsigned gpio)
{
	might_sleep();
160
	return __gpio_get_value(gpio);
David Brownell's avatar
David Brownell committed
161 162 163 164 165
}

static inline void gpio_set_value_cansleep(unsigned gpio, int value)
{
	might_sleep();
166
	__gpio_set_value(gpio, value);
David Brownell's avatar
David Brownell committed
167 168
}

169
#endif /* !CONFIG_GPIOLIB */
David Brownell's avatar
David Brownell committed
170

David Brownell's avatar
David Brownell committed
171
#endif /* _ASM_GENERIC_GPIO_H */