c5a51af8f76edc79afd856327f59d2d1fb88850a
[sfrench/cifs-2.6.git] / include / linux / gpio / driver.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __LINUX_GPIO_DRIVER_H
3 #define __LINUX_GPIO_DRIVER_H
4
5 #include <linux/device.h>
6 #include <linux/types.h>
7 #include <linux/irq.h>
8 #include <linux/irqchip/chained_irq.h>
9 #include <linux/irqdomain.h>
10 #include <linux/lockdep.h>
11 #include <linux/pinctrl/pinctrl.h>
12 #include <linux/pinctrl/pinconf-generic.h>
13
14 struct gpio_desc;
15 struct of_phandle_args;
16 struct device_node;
17 struct seq_file;
18 struct gpio_device;
19 struct module;
20
21 #ifdef CONFIG_GPIOLIB
22
23 #ifdef CONFIG_GPIOLIB_IRQCHIP
24 /**
25  * struct gpio_irq_chip - GPIO interrupt controller
26  */
27 struct gpio_irq_chip {
28         /**
29          * @chip:
30          *
31          * GPIO IRQ chip implementation, provided by GPIO driver.
32          */
33         struct irq_chip *chip;
34
35         /**
36          * @domain:
37          *
38          * Interrupt translation domain; responsible for mapping between GPIO
39          * hwirq number and Linux IRQ number.
40          */
41         struct irq_domain *domain;
42
43         /**
44          * @domain_ops:
45          *
46          * Table of interrupt domain operations for this IRQ chip.
47          */
48         const struct irq_domain_ops *domain_ops;
49
50         /**
51          * @handler:
52          *
53          * The IRQ handler to use (often a predefined IRQ core function) for
54          * GPIO IRQs, provided by GPIO driver.
55          */
56         irq_flow_handler_t handler;
57
58         /**
59          * @default_type:
60          *
61          * Default IRQ triggering type applied during GPIO driver
62          * initialization, provided by GPIO driver.
63          */
64         unsigned int default_type;
65
66         /**
67          * @lock_key:
68          *
69          * Per GPIO IRQ chip lockdep class for IRQ lock.
70          */
71         struct lock_class_key *lock_key;
72
73         /**
74          * @request_key:
75          *
76          * Per GPIO IRQ chip lockdep class for IRQ request.
77          */
78         struct lock_class_key *request_key;
79
80         /**
81          * @parent_handler:
82          *
83          * The interrupt handler for the GPIO chip's parent interrupts, may be
84          * NULL if the parent interrupts are nested rather than cascaded.
85          */
86         irq_flow_handler_t parent_handler;
87
88         /**
89          * @parent_handler_data:
90          *
91          * Data associated, and passed to, the handler for the parent
92          * interrupt.
93          */
94         void *parent_handler_data;
95
96         /**
97          * @num_parents:
98          *
99          * The number of interrupt parents of a GPIO chip.
100          */
101         unsigned int num_parents;
102
103         /**
104          * @parents:
105          *
106          * A list of interrupt parents of a GPIO chip. This is owned by the
107          * driver, so the core will only reference this list, not modify it.
108          */
109         unsigned int *parents;
110
111         /**
112          * @map:
113          *
114          * A list of interrupt parents for each line of a GPIO chip.
115          */
116         unsigned int *map;
117
118         /**
119          * @threaded:
120          *
121          * True if set the interrupt handling uses nested threads.
122          */
123         bool threaded;
124
125         /**
126          * @need_valid_mask:
127          *
128          * If set core allocates @valid_mask with all bits set to one.
129          */
130         bool need_valid_mask;
131
132         /**
133          * @valid_mask:
134          *
135          * If not %NULL holds bitmask of GPIOs which are valid to be included
136          * in IRQ domain of the chip.
137          */
138         unsigned long *valid_mask;
139
140         /**
141          * @first:
142          *
143          * Required for static IRQ allocation. If set, irq_domain_add_simple()
144          * will allocate and map all IRQs during initialization.
145          */
146         unsigned int first;
147
148         /**
149          * @irq_enable:
150          *
151          * Store old irq_chip irq_enable callback
152          */
153         void            (*irq_enable)(struct irq_data *data);
154
155         /**
156          * @irq_disable:
157          *
158          * Store old irq_chip irq_disable callback
159          */
160         void            (*irq_disable)(struct irq_data *data);
161 };
162
163 static inline struct gpio_irq_chip *to_gpio_irq_chip(struct irq_chip *chip)
164 {
165         return container_of(chip, struct gpio_irq_chip, chip);
166 }
167 #endif
168
169 /**
170  * struct gpio_chip - abstract a GPIO controller
171  * @label: a functional name for the GPIO device, such as a part
172  *      number or the name of the SoC IP-block implementing it.
173  * @gpiodev: the internal state holder, opaque struct
174  * @parent: optional parent device providing the GPIOs
175  * @owner: helps prevent removal of modules exporting active GPIOs
176  * @request: optional hook for chip-specific activation, such as
177  *      enabling module power and clock; may sleep
178  * @free: optional hook for chip-specific deactivation, such as
179  *      disabling module power and clock; may sleep
180  * @get_direction: returns direction for signal "offset", 0=out, 1=in,
181  *      (same as GPIOF_DIR_XXX), or negative error.
182  *      It is recommended to always implement this function, even on
183  *      input-only or output-only gpio chips.
184  * @direction_input: configures signal "offset" as input, or returns error
185  *      This can be omitted on input-only or output-only gpio chips.
186  * @direction_output: configures signal "offset" as output, or returns error
187  *      This can be omitted on input-only or output-only gpio chips.
188  * @get: returns value for signal "offset", 0=low, 1=high, or negative error
189  * @get_multiple: reads values for multiple signals defined by "mask" and
190  *      stores them in "bits", returns 0 on success or negative error
191  * @set: assigns output value for signal "offset"
192  * @set_multiple: assigns output values for multiple signals defined by "mask"
193  * @set_config: optional hook for all kinds of settings. Uses the same
194  *      packed config format as generic pinconf.
195  * @to_irq: optional hook supporting non-static gpio_to_irq() mappings;
196  *      implementation may not sleep
197  * @dbg_show: optional routine to show contents in debugfs; default code
198  *      will be used when this is omitted, but custom code can show extra
199  *      state (such as pullup/pulldown configuration).
200  * @base: identifies the first GPIO number handled by this chip;
201  *      or, if negative during registration, requests dynamic ID allocation.
202  *      DEPRECATION: providing anything non-negative and nailing the base
203  *      offset of GPIO chips is deprecated. Please pass -1 as base to
204  *      let gpiolib select the chip base in all possible cases. We want to
205  *      get rid of the static GPIO number space in the long run.
206  * @ngpio: the number of GPIOs handled by this controller; the last GPIO
207  *      handled is (base + ngpio - 1).
208  * @names: if set, must be an array of strings to use as alternative
209  *      names for the GPIOs in this chip. Any entry in the array
210  *      may be NULL if there is no alias for the GPIO, however the
211  *      array must be @ngpio entries long.  A name can include a single printk
212  *      format specifier for an unsigned int.  It is substituted by the actual
213  *      number of the gpio.
214  * @can_sleep: flag must be set iff get()/set() methods sleep, as they
215  *      must while accessing GPIO expander chips over I2C or SPI. This
216  *      implies that if the chip supports IRQs, these IRQs need to be threaded
217  *      as the chip access may sleep when e.g. reading out the IRQ status
218  *      registers.
219  * @read_reg: reader function for generic GPIO
220  * @write_reg: writer function for generic GPIO
221  * @be_bits: if the generic GPIO has big endian bit order (bit 31 is representing
222  *      line 0, bit 30 is line 1 ... bit 0 is line 31) this is set to true by the
223  *      generic GPIO core. It is for internal housekeeping only.
224  * @reg_dat: data (in) register for generic GPIO
225  * @reg_set: output set register (out=high) for generic GPIO
226  * @reg_clr: output clear register (out=low) for generic GPIO
227  * @reg_dir: direction setting register for generic GPIO
228  * @bgpio_dir_inverted: indicates that the direction register is inverted
229  *      (gpiolib private state variable)
230  * @bgpio_bits: number of register bits used for a generic GPIO i.e.
231  *      <register width> * 8
232  * @bgpio_lock: used to lock chip->bgpio_data. Also, this is needed to keep
233  *      shadowed and real data registers writes together.
234  * @bgpio_data: shadowed data register for generic GPIO to clear/set bits
235  *      safely.
236  * @bgpio_dir: shadowed direction register for generic GPIO to clear/set
237  *      direction safely.
238  *
239  * A gpio_chip can help platforms abstract various sources of GPIOs so
240  * they can all be accessed through a common programing interface.
241  * Example sources would be SOC controllers, FPGAs, multifunction
242  * chips, dedicated GPIO expanders, and so on.
243  *
244  * Each chip controls a number of signals, identified in method calls
245  * by "offset" values in the range 0..(@ngpio - 1).  When those signals
246  * are referenced through calls like gpio_get_value(gpio), the offset
247  * is calculated by subtracting @base from the gpio number.
248  */
249 struct gpio_chip {
250         const char              *label;
251         struct gpio_device      *gpiodev;
252         struct device           *parent;
253         struct module           *owner;
254
255         int                     (*request)(struct gpio_chip *chip,
256                                                 unsigned offset);
257         void                    (*free)(struct gpio_chip *chip,
258                                                 unsigned offset);
259         int                     (*get_direction)(struct gpio_chip *chip,
260                                                 unsigned offset);
261         int                     (*direction_input)(struct gpio_chip *chip,
262                                                 unsigned offset);
263         int                     (*direction_output)(struct gpio_chip *chip,
264                                                 unsigned offset, int value);
265         int                     (*get)(struct gpio_chip *chip,
266                                                 unsigned offset);
267         int                     (*get_multiple)(struct gpio_chip *chip,
268                                                 unsigned long *mask,
269                                                 unsigned long *bits);
270         void                    (*set)(struct gpio_chip *chip,
271                                                 unsigned offset, int value);
272         void                    (*set_multiple)(struct gpio_chip *chip,
273                                                 unsigned long *mask,
274                                                 unsigned long *bits);
275         int                     (*set_config)(struct gpio_chip *chip,
276                                               unsigned offset,
277                                               unsigned long config);
278         int                     (*to_irq)(struct gpio_chip *chip,
279                                                 unsigned offset);
280
281         void                    (*dbg_show)(struct seq_file *s,
282                                                 struct gpio_chip *chip);
283
284         int                     (*init_valid_mask)(struct gpio_chip *chip);
285
286         int                     base;
287         u16                     ngpio;
288         const char              *const *names;
289         bool                    can_sleep;
290
291 #if IS_ENABLED(CONFIG_GPIO_GENERIC)
292         unsigned long (*read_reg)(void __iomem *reg);
293         void (*write_reg)(void __iomem *reg, unsigned long data);
294         bool be_bits;
295         void __iomem *reg_dat;
296         void __iomem *reg_set;
297         void __iomem *reg_clr;
298         void __iomem *reg_dir;
299         bool bgpio_dir_inverted;
300         int bgpio_bits;
301         spinlock_t bgpio_lock;
302         unsigned long bgpio_data;
303         unsigned long bgpio_dir;
304 #endif
305
306 #ifdef CONFIG_GPIOLIB_IRQCHIP
307         /*
308          * With CONFIG_GPIOLIB_IRQCHIP we get an irqchip inside the gpiolib
309          * to handle IRQs for most practical cases.
310          */
311
312         /**
313          * @irq:
314          *
315          * Integrates interrupt chip functionality with the GPIO chip. Can be
316          * used to handle IRQs for most practical cases.
317          */
318         struct gpio_irq_chip irq;
319 #endif
320
321         /**
322          * @need_valid_mask:
323          *
324          * If set core allocates @valid_mask with all its values initialized
325          * with init_valid_mask() or set to one if init_valid_mask() is not
326          * defined
327          */
328         bool need_valid_mask;
329
330         /**
331          * @valid_mask:
332          *
333          * If not %NULL holds bitmask of GPIOs which are valid to be used
334          * from the chip.
335          */
336         unsigned long *valid_mask;
337
338 #if defined(CONFIG_OF_GPIO)
339         /*
340          * If CONFIG_OF is enabled, then all GPIO controllers described in the
341          * device tree automatically may have an OF translation
342          */
343
344         /**
345          * @of_node:
346          *
347          * Pointer to a device tree node representing this GPIO controller.
348          */
349         struct device_node *of_node;
350
351         /**
352          * @of_gpio_n_cells:
353          *
354          * Number of cells used to form the GPIO specifier.
355          */
356         unsigned int of_gpio_n_cells;
357
358         /**
359          * @of_xlate:
360          *
361          * Callback to translate a device tree GPIO specifier into a chip-
362          * relative GPIO number and flags.
363          */
364         int (*of_xlate)(struct gpio_chip *gc,
365                         const struct of_phandle_args *gpiospec, u32 *flags);
366 #endif
367 };
368
369 extern const char *gpiochip_is_requested(struct gpio_chip *chip,
370                         unsigned offset);
371
372 /* add/remove chips */
373 extern int gpiochip_add_data_with_key(struct gpio_chip *chip, void *data,
374                                       struct lock_class_key *lock_key,
375                                       struct lock_class_key *request_key);
376
377 /**
378  * gpiochip_add_data() - register a gpio_chip
379  * @chip: the chip to register, with chip->base initialized
380  * @data: driver-private data associated with this chip
381  *
382  * Context: potentially before irqs will work
383  *
384  * When gpiochip_add_data() is called very early during boot, so that GPIOs
385  * can be freely used, the chip->parent device must be registered before
386  * the gpio framework's arch_initcall().  Otherwise sysfs initialization
387  * for GPIOs will fail rudely.
388  *
389  * gpiochip_add_data() must only be called after gpiolib initialization,
390  * ie after core_initcall().
391  *
392  * If chip->base is negative, this requests dynamic assignment of
393  * a range of valid GPIOs.
394  *
395  * Returns:
396  * A negative errno if the chip can't be registered, such as because the
397  * chip->base is invalid or already associated with a different chip.
398  * Otherwise it returns zero as a success code.
399  */
400 #ifdef CONFIG_LOCKDEP
401 #define gpiochip_add_data(chip, data) ({                \
402                 static struct lock_class_key lock_key;  \
403                 static struct lock_class_key request_key;         \
404                 gpiochip_add_data_with_key(chip, data, &lock_key, \
405                                            &request_key);         \
406         })
407 #else
408 #define gpiochip_add_data(chip, data) gpiochip_add_data_with_key(chip, data, NULL, NULL)
409 #endif
410
411 static inline int gpiochip_add(struct gpio_chip *chip)
412 {
413         return gpiochip_add_data(chip, NULL);
414 }
415 extern void gpiochip_remove(struct gpio_chip *chip);
416 extern int devm_gpiochip_add_data(struct device *dev, struct gpio_chip *chip,
417                                   void *data);
418 extern void devm_gpiochip_remove(struct device *dev, struct gpio_chip *chip);
419
420 extern struct gpio_chip *gpiochip_find(void *data,
421                               int (*match)(struct gpio_chip *chip, void *data));
422
423 /* lock/unlock as IRQ */
424 int gpiochip_lock_as_irq(struct gpio_chip *chip, unsigned int offset);
425 void gpiochip_unlock_as_irq(struct gpio_chip *chip, unsigned int offset);
426 bool gpiochip_line_is_irq(struct gpio_chip *chip, unsigned int offset);
427 int gpiochip_reqres_irq(struct gpio_chip *chip, unsigned int offset);
428 void gpiochip_relres_irq(struct gpio_chip *chip, unsigned int offset);
429 void gpiochip_disable_irq(struct gpio_chip *chip, unsigned int offset);
430 void gpiochip_enable_irq(struct gpio_chip *chip, unsigned int offset);
431
432 /* Line status inquiry for drivers */
433 bool gpiochip_line_is_open_drain(struct gpio_chip *chip, unsigned int offset);
434 bool gpiochip_line_is_open_source(struct gpio_chip *chip, unsigned int offset);
435
436 /* Sleep persistence inquiry for drivers */
437 bool gpiochip_line_is_persistent(struct gpio_chip *chip, unsigned int offset);
438 bool gpiochip_line_is_valid(const struct gpio_chip *chip, unsigned int offset);
439
440 /* get driver data */
441 void *gpiochip_get_data(struct gpio_chip *chip);
442
443 struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc);
444
445 struct bgpio_pdata {
446         const char *label;
447         int base;
448         int ngpio;
449 };
450
451 #if IS_ENABLED(CONFIG_GPIO_GENERIC)
452
453 int bgpio_init(struct gpio_chip *gc, struct device *dev,
454                unsigned long sz, void __iomem *dat, void __iomem *set,
455                void __iomem *clr, void __iomem *dirout, void __iomem *dirin,
456                unsigned long flags);
457
458 #define BGPIOF_BIG_ENDIAN               BIT(0)
459 #define BGPIOF_UNREADABLE_REG_SET       BIT(1) /* reg_set is unreadable */
460 #define BGPIOF_UNREADABLE_REG_DIR       BIT(2) /* reg_dir is unreadable */
461 #define BGPIOF_BIG_ENDIAN_BYTE_ORDER    BIT(3)
462 #define BGPIOF_READ_OUTPUT_REG_SET      BIT(4) /* reg_set stores output value */
463 #define BGPIOF_NO_OUTPUT                BIT(5) /* only input */
464
465 #endif
466
467 #ifdef CONFIG_GPIOLIB_IRQCHIP
468
469 int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
470                      irq_hw_number_t hwirq);
471 void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq);
472
473 void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
474                 struct irq_chip *irqchip,
475                 unsigned int parent_irq,
476                 irq_flow_handler_t parent_handler);
477
478 void gpiochip_set_nested_irqchip(struct gpio_chip *gpiochip,
479                 struct irq_chip *irqchip,
480                 unsigned int parent_irq);
481
482 int gpiochip_irqchip_add_key(struct gpio_chip *gpiochip,
483                              struct irq_chip *irqchip,
484                              unsigned int first_irq,
485                              irq_flow_handler_t handler,
486                              unsigned int type,
487                              bool threaded,
488                              struct lock_class_key *lock_key,
489                              struct lock_class_key *request_key);
490
491 bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gpiochip,
492                                 unsigned int offset);
493
494 #ifdef CONFIG_LOCKDEP
495
496 /*
497  * Lockdep requires that each irqchip instance be created with a
498  * unique key so as to avoid unnecessary warnings. This upfront
499  * boilerplate static inlines provides such a key for each
500  * unique instance.
501  */
502 static inline int gpiochip_irqchip_add(struct gpio_chip *gpiochip,
503                                        struct irq_chip *irqchip,
504                                        unsigned int first_irq,
505                                        irq_flow_handler_t handler,
506                                        unsigned int type)
507 {
508         static struct lock_class_key lock_key;
509         static struct lock_class_key request_key;
510
511         return gpiochip_irqchip_add_key(gpiochip, irqchip, first_irq,
512                                         handler, type, false,
513                                         &lock_key, &request_key);
514 }
515
516 static inline int gpiochip_irqchip_add_nested(struct gpio_chip *gpiochip,
517                           struct irq_chip *irqchip,
518                           unsigned int first_irq,
519                           irq_flow_handler_t handler,
520                           unsigned int type)
521 {
522
523         static struct lock_class_key lock_key;
524         static struct lock_class_key request_key;
525
526         return gpiochip_irqchip_add_key(gpiochip, irqchip, first_irq,
527                                         handler, type, true,
528                                         &lock_key, &request_key);
529 }
530 #else
531 static inline int gpiochip_irqchip_add(struct gpio_chip *gpiochip,
532                                        struct irq_chip *irqchip,
533                                        unsigned int first_irq,
534                                        irq_flow_handler_t handler,
535                                        unsigned int type)
536 {
537         return gpiochip_irqchip_add_key(gpiochip, irqchip, first_irq,
538                                         handler, type, false, NULL, NULL);
539 }
540
541 static inline int gpiochip_irqchip_add_nested(struct gpio_chip *gpiochip,
542                           struct irq_chip *irqchip,
543                           unsigned int first_irq,
544                           irq_flow_handler_t handler,
545                           unsigned int type)
546 {
547         return gpiochip_irqchip_add_key(gpiochip, irqchip, first_irq,
548                                         handler, type, true, NULL, NULL);
549 }
550 #endif /* CONFIG_LOCKDEP */
551
552 #endif /* CONFIG_GPIOLIB_IRQCHIP */
553
554 int gpiochip_generic_request(struct gpio_chip *chip, unsigned offset);
555 void gpiochip_generic_free(struct gpio_chip *chip, unsigned offset);
556 int gpiochip_generic_config(struct gpio_chip *chip, unsigned offset,
557                             unsigned long config);
558
559 #ifdef CONFIG_PINCTRL
560
561 /**
562  * struct gpio_pin_range - pin range controlled by a gpio chip
563  * @node: list for maintaining set of pin ranges, used internally
564  * @pctldev: pinctrl device which handles corresponding pins
565  * @range: actual range of pins controlled by a gpio controller
566  */
567 struct gpio_pin_range {
568         struct list_head node;
569         struct pinctrl_dev *pctldev;
570         struct pinctrl_gpio_range range;
571 };
572
573 int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
574                            unsigned int gpio_offset, unsigned int pin_offset,
575                            unsigned int npins);
576 int gpiochip_add_pingroup_range(struct gpio_chip *chip,
577                         struct pinctrl_dev *pctldev,
578                         unsigned int gpio_offset, const char *pin_group);
579 void gpiochip_remove_pin_ranges(struct gpio_chip *chip);
580
581 #else
582
583 static inline int
584 gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
585                        unsigned int gpio_offset, unsigned int pin_offset,
586                        unsigned int npins)
587 {
588         return 0;
589 }
590 static inline int
591 gpiochip_add_pingroup_range(struct gpio_chip *chip,
592                         struct pinctrl_dev *pctldev,
593                         unsigned int gpio_offset, const char *pin_group)
594 {
595         return 0;
596 }
597
598 static inline void
599 gpiochip_remove_pin_ranges(struct gpio_chip *chip)
600 {
601 }
602
603 #endif /* CONFIG_PINCTRL */
604
605 struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *chip, u16 hwnum,
606                                             const char *label);
607 void gpiochip_free_own_desc(struct gpio_desc *desc);
608
609 #else /* CONFIG_GPIOLIB */
610
611 static inline struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
612 {
613         /* GPIO can never have been requested */
614         WARN_ON(1);
615         return ERR_PTR(-ENODEV);
616 }
617
618 #endif /* CONFIG_GPIOLIB */
619
620 #endif