arch/arm/include/asm/arch-sc8830/asm_generic_gpio.h

   1 #ifndef _ASM_GENERIC_GPIO_H
   2 #define _ASM_GENERIC_GPIO_H
   3
   4 //#include <linux/kernel.h>
   5 #include <linux/types.h>
   6 //#include <linux/errno.h>
   7 #include <errno.h>
   8 typedef enum{false, true} bool;
   9
  10 #ifdef CONFIG_GPIOLIB
  11
  12 //#include <linux/compiler.h>
  13
  14 /* Platforms may implement their GPIO interface with library code,
  15  * at a small performance cost for non-inlined operations and some
  16  * extra memory (for code and for per-GPIO table entries).
  17  *
  18  * While the GPIO programming interface defines valid GPIO numbers
  19  * to be in the range 0..MAX_INT, this library restricts them to the
  20  * smaller range 0..ARCH_NR_GPIOS-1.
  21  */
  22
  23 #ifndef ARCH_NR_GPIOS
  24 #define ARCH_NR_GPIOS           256
  25 #endif
  26
  27 static inline int gpio_is_valid(int number)
  28 {
  29         /* only some non-negative numbers are valid */
  30         return ((unsigned)number) < ARCH_NR_GPIOS;
  31 }
  32
  33 struct seq_file;
  34 struct module;
  35
  36 /**
  37  * struct gpio_chip - abstract a GPIO controller
  38  * @label: for diagnostics
  39  * @dev: optional device providing the GPIOs
  40  * @owner: helps prevent removal of modules exporting active GPIOs
  41  * @request: optional hook for chip-specific activation, such as
  42  *      enabling module power and clock; may sleep
  43  * @free: optional hook for chip-specific deactivation, such as
  44  *      disabling module power and clock; may sleep
  45  * @direction_input: configures signal "offset" as input, or returns error
  46  * @get: returns value for signal "offset"; for output signals this
  47  *      returns either the value actually sensed, or zero
  48  * @direction_output: configures signal "offset" as output, or returns error
  49  * @set: assigns output value for signal "offset"
  50  * @to_irq: optional hook supporting non-static gpio_to_irq() mappings;
  51  *      implementation may not sleep
  52  * @dbg_show: optional routine to show contents in debugfs; default code
  53  *      will be used when this is omitted, but custom code can show extra
  54  *      state (such as pullup/pulldown configuration).
  55  * @base: identifies the first GPIO number handled by this chip; or, if
  56  *      negative during registration, requests dynamic ID allocation.
  57  * @ngpio: the number of GPIOs handled by this controller; the last GPIO
  58  *      handled is (base + ngpio - 1).
  59  * @can_sleep: flag must be set iff get()/set() methods sleep, as they
  60  *      must while accessing GPIO expander chips over I2C or SPI
  61  * @names: if set, must be an array of strings to use as alternative
  62  *      names for the GPIOs in this chip. Any entry in the array
  63  *      may be NULL if there is no alias for the GPIO, however the
  64  *      array must be @ngpio entries long.
  65  *
  66  * A gpio_chip can help platforms abstract various sources of GPIOs so
  67  * they can all be accessed through a common programing interface.
  68  * Example sources would be SOC controllers, FPGAs, multifunction
  69  * chips, dedicated GPIO expanders, and so on.
  70  *
  71  * Each chip controls a number of signals, identified in method calls
  72  * by "offset" values in the range 0..(@ngpio - 1).  When those signals
  73  * are referenced through calls like gpio_get_value(gpio), the offset
  74  * is calculated by subtracting @base from the gpio number.
  75  */
  76 struct gpio_chip {
  77         const char              *label;
  78         struct device           *dev;
  79         struct module           *owner;
  80
  81         int                     (*request)(struct gpio_chip *chip,
  82                                                 unsigned offset);
  83         void                    (*free)(struct gpio_chip *chip,
  84                                                 unsigned offset);
  85
  86         int                     (*direction_input)(struct gpio_chip *chip,
  87                                                 unsigned offset);
  88         int                     (*get)(struct gpio_chip *chip,
  89                                                 unsigned offset);
  90         int                     (*direction_output)(struct gpio_chip *chip,
  91                                                 unsigned offset, int value);
  92         void                    (*set)(struct gpio_chip *chip,
  93                                                 unsigned offset, int value);
  94
  95         int                     (*to_irq)(struct gpio_chip *chip,
  96                                                 unsigned offset);
  97
  98         void                    (*dbg_show)(struct seq_file *s,
  99                                                 struct gpio_chip *chip);
 100         int                     base;
 101         u16                     ngpio;
 102         char                    **names;
 103         unsigned                can_sleep:1;
 104         unsigned                exported:1;
 105 };
 106
 107 extern const char *gpiochip_is_requested(struct gpio_chip *chip,
 108                         unsigned offset);
 109 extern int gpiochip_reserve(int start, int ngpio);
 110
 111 /* add/remove chips */
 112 extern int gpiochip_add(struct gpio_chip *chip);
 113 extern int gpiochip_remove(struct gpio_chip *chip);
 114
 115
 116 /* Always use the library code for GPIO management calls,
 117  * or when sleeping may be involved.
 118  */
 119 extern int gpio_request(unsigned gpio, const char *label);
 120 extern void gpio_free(unsigned gpio);
 121
 122 extern int gpio_direction_input(unsigned gpio);
 123 extern int gpio_direction_output(unsigned gpio, int value);
 124
 125 extern int gpio_get_value_cansleep(unsigned gpio);
 126 extern void gpio_set_value_cansleep(unsigned gpio, int value);
 127
 128
 129 /* A platform's <asm/gpio.h> code may want to inline the I/O calls when
 130  * the GPIO is constant and refers to some always-present controller,
 131  * giving direct access to chip registers and tight bitbanging loops.
 132  */
 133 extern int __gpio_get_value(unsigned gpio);
 134 extern void __gpio_set_value(unsigned gpio, int value);
 135
 136 extern int __gpio_cansleep(unsigned gpio);
 137
 138 extern int __gpio_to_irq(unsigned gpio);
 139
 140 #ifdef CONFIG_GPIO_SYSFS
 141
 142 /*
 143  * A sysfs interface can be exported by individual drivers if they want,
 144  * but more typically is configured entirely from userspace.
 145  */
 146 extern int gpio_export(unsigned gpio, bool direction_may_change);
 147 extern int gpio_export_link(struct device *dev, const char *name,
 148                         unsigned gpio);
 149 extern void gpio_unexport(unsigned gpio);
 150
 151 #endif  /* CONFIG_GPIO_SYSFS */
 152
 153 #else   /* !CONFIG_HAVE_GPIO_LIB */
 154
 155 static inline int gpio_is_valid(int number)
 156 {
 157         /* only non-negative numbers are valid */
 158         return number >= 0;
 159 }
 160
 161 /* platforms that don't directly support access to GPIOs through I2C, SPI,
 162  * or other blocking infrastructure can use these wrappers.
 163  */
 164
 165 static inline int gpio_cansleep(unsigned gpio)
 166 {
 167         return 0;
 168 }
 169
 170 static inline int gpio_get_value_cansleep(unsigned gpio)
 171 {
 172         might_sleep();
 173         return gpio_get_value(gpio);
 174 }
 175
 176 static inline void gpio_set_value_cansleep(unsigned gpio, int value)
 177 {
 178         might_sleep();
 179         gpio_set_value(gpio, value);
 180 }
 181
 182 #endif /* !CONFIG_HAVE_GPIO_LIB */
 183
 184 #ifndef CONFIG_GPIO_SYSFS
 185
 186 /* sysfs support is only available with gpiolib, where it's optional */
 187
 188 static inline int gpio_export(unsigned gpio, bool direction_may_change)
 189 {
 190         return -ENOSYS;
 191 }
 192
 193 static inline int gpio_export_link(struct device *dev, const char *name,
 194                                 unsigned gpio)
 195 {
 196         return -ENOSYS;
 197 }
 198
 199 static inline void gpio_unexport(unsigned gpio)
 200 {
 201 }
 202 #endif  /* CONFIG_GPIO_SYSFS */
 203
 204 #endif /* _ASM_GENERIC_GPIO_H */