drivers/pinctrl/intel/pinctrl-intel.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Core pinctrl/GPIO driver for Intel GPIO controllers
   4  *
   5  * Copyright (C) 2015, Intel Corporation
   6  * Authors: Mathias Nyman <[email protected]>
   7  *          Mika Westerberg <[email protected]>
   8  */
   9
  10 #ifndef PINCTRL_INTEL_H
  11 #define PINCTRL_INTEL_H
  12
  13 #include <linux/pm.h>
  14
  15 struct pinctrl_pin_desc;
  16 struct platform_device;
  17 struct device;
  18
  19 /**
  20  * struct intel_pingroup - Description about group of pins
  21  * @name: Name of the groups
  22  * @pins: All pins in this group
  23  * @npins: Number of pins in this groups
  24  * @mode: Native mode in which the group is muxed out @pins. Used if @modes
  25  *        is %NULL.
  26  * @modes: If not %NULL this will hold mode for each pin in @pins
  27  */
  28 struct intel_pingroup {
  29         const char *name;
  30         const unsigned int *pins;
  31         size_t npins;
  32         unsigned short mode;
  33         const unsigned int *modes;
  34 };
  35
  36 /**
  37  * struct intel_function - Description about a function
  38  * @name: Name of the function
  39  * @groups: An array of groups for this function
  40  * @ngroups: Number of groups in @groups
  41  */
  42 struct intel_function {
  43         const char *name;
  44         const char * const *groups;
  45         size_t ngroups;
  46 };
  47
  48 /**
  49  * struct intel_padgroup - Hardware pad group information
  50  * @reg_num: GPI_IS register number
  51  * @base: Starting pin of this group
  52  * @size: Size of this group (maximum is 32).
  53  * @gpio_base: Starting GPIO base of this group (%0 if matches with @base,
  54  *             and %-1 if no GPIO mapping should be created)
  55  * @padown_num: PAD_OWN register number (assigned by the core driver)
  56  *
  57  * If pad groups of a community are not the same size, use this structure
  58  * to specify them.
  59  */
  60 struct intel_padgroup {
  61         unsigned int reg_num;
  62         unsigned int base;
  63         unsigned int size;
  64         int gpio_base;
  65         unsigned int padown_num;
  66 };
  67
  68 /**
  69  * struct intel_community - Intel pin community description
  70  * @barno: MMIO BAR number where registers for this community reside
  71  * @padown_offset: Register offset of PAD_OWN register from @regs. If %0
  72  *                 then there is no support for owner.
  73  * @padcfglock_offset: Register offset of PADCFGLOCK from @regs. If %0 then
  74  *                     locking is not supported.
  75  * @hostown_offset: Register offset of HOSTSW_OWN from @regs. If %0 then it
  76  *                  is assumed that the host owns the pin (rather than
  77  *                  ACPI).
  78  * @is_offset: Register offset of GPI_IS from @regs.
  79  * @ie_offset: Register offset of GPI_IE from @regs.
  80  * @features: Additional features supported by the hardware
  81  * @pin_base: Starting pin of pins in this community
  82  * @gpp_size: Maximum number of pads in each group, such as PADCFGLOCK,
  83  *            HOSTSW_OWN,  GPI_IS, GPI_IE, etc. Used when @gpps is %NULL.
  84  * @gpp_num_padown_regs: Number of pad registers each pad group consumes at
  85  *                       minimum. Use %0 if the number of registers can be
  86  *                       determined by the size of the group.
  87  * @npins: Number of pins in this community
  88  * @gpps: Pad groups if the controller has variable size pad groups
  89  * @ngpps: Number of pad groups in this community
  90  * @pad_map: Optional non-linear mapping of the pads
  91  * @regs: Community specific common registers (reserved for core driver)
  92  * @pad_regs: Community specific pad registers (reserved for core driver)
  93  *
  94  * Most Intel GPIO host controllers this driver supports each pad group is
  95  * of equal size (except the last one). In that case the driver can just
  96  * fill in @gpp_size field and let the core driver to handle the rest. If
  97  * the controller has pad groups of variable size the client driver can
  98  * pass custom @gpps and @ngpps instead.
  99  */
 100 struct intel_community {
 101         unsigned int barno;
 102         unsigned int padown_offset;
 103         unsigned int padcfglock_offset;
 104         unsigned int hostown_offset;
 105         unsigned int is_offset;
 106         unsigned int ie_offset;
 107         unsigned int features;
 108         unsigned int pin_base;
 109         unsigned int gpp_size;
 110         unsigned int gpp_num_padown_regs;
 111         size_t npins;
 112         const struct intel_padgroup *gpps;
 113         size_t ngpps;
 114         const unsigned int *pad_map;
 115         /* Reserved for the core driver */
 116         void __iomem *regs;
 117         void __iomem *pad_regs;
 118 };
 119
 120 /* Additional features supported by the hardware */
 121 #define PINCTRL_FEATURE_DEBOUNCE        BIT(0)
 122 #define PINCTRL_FEATURE_1K_PD           BIT(1)
 123
 124 /**
 125  * PIN_GROUP - Declare a pin group
 126  * @n: Name of the group
 127  * @p: An array of pins this group consists
 128  * @m: Mode which the pins are put when this group is active. Can be either
 129  *     a single integer or an array of integers in which case mode is per
 130  *     pin.
 131  */
 132 #define PIN_GROUP(n, p, m)                                      \
 133         {                                                       \
 134                 .name = (n),                                    \
 135                 .pins = (p),                                    \
 136                 .npins = ARRAY_SIZE((p)),                       \
 137                 .mode = __builtin_choose_expr(                  \
 138                         __builtin_constant_p((m)), (m), 0),     \
 139                 .modes = __builtin_choose_expr(                 \
 140                         __builtin_constant_p((m)), NULL, (m)),  \
 141         }
 142
 143 #define FUNCTION(n, g)                          \
 144         {                                       \
 145                 .name = (n),                    \
 146                 .groups = (g),                  \
 147                 .ngroups = ARRAY_SIZE((g)),     \
 148         }
 149
 150 /**
 151  * struct intel_pinctrl_soc_data - Intel pin controller per-SoC configuration
 152  * @uid: ACPI _UID for the probe driver use if needed
 153  * @pins: Array if pins this pinctrl controls
 154  * @npins: Number of pins in the array
 155  * @groups: Array of pin groups
 156  * @ngroups: Number of groups in the array
 157  * @functions: Array of functions
 158  * @nfunctions: Number of functions in the array
 159  * @communities: Array of communities this pinctrl handles
 160  * @ncommunities: Number of communities in the array
 161  *
 162  * The @communities is used as a template by the core driver. It will make
 163  * copy of all communities and fill in rest of the information.
 164  */
 165 struct intel_pinctrl_soc_data {
 166         const char *uid;
 167         const struct pinctrl_pin_desc *pins;
 168         size_t npins;
 169         const struct intel_pingroup *groups;
 170         size_t ngroups;
 171         const struct intel_function *functions;
 172         size_t nfunctions;
 173         const struct intel_community *communities;
 174         size_t ncommunities;
 175 };
 176
 177 int intel_pinctrl_probe_by_hid(struct platform_device *pdev);
 178 int intel_pinctrl_probe_by_uid(struct platform_device *pdev);
 179
 180 #ifdef CONFIG_PM_SLEEP
 181 int intel_pinctrl_suspend_noirq(struct device *dev);
 182 int intel_pinctrl_resume_noirq(struct device *dev);
 183 #endif
 184
 185 #define INTEL_PINCTRL_PM_OPS(_name)                                     \
 186 const struct dev_pm_ops _name = {                                       \
 187         SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(intel_pinctrl_suspend_noirq,      \
 188                                       intel_pinctrl_resume_noirq)       \
 189 }
 190
 191 #endif /* PINCTRL_INTEL_H */