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