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 <mathias.nyman@linux.intel.com> 7 * Mika Westerberg <mika.westerberg@linux.intel.com> 8 */ 9 10 #ifndef PINCTRL_INTEL_H 11 #define PINCTRL_INTEL_H 12 13 #include <linux/bits.h> 14 #include <linux/compiler_types.h> 15 #include <linux/gpio/driver.h> 16 #include <linux/irq.h> 17 #include <linux/kernel.h> 18 #include <linux/pm.h> 19 #include <linux/pinctrl/pinctrl.h> 20 #include <linux/spinlock_types.h> 21 22 struct platform_device; 23 struct device; 24 25 /** 26 * struct intel_pingroup - Description about group of pins 27 * @grp: Generic data of the pin group (name and pins) 28 * @mode: Native mode in which the group is muxed out @pins. Used if @modes is %NULL. 29 * @modes: If not %NULL this will hold mode for each pin in @pins 30 */ 31 struct intel_pingroup { 32 struct pingroup grp; 33 unsigned short mode; 34 const unsigned int *modes; 35 }; 36 37 /** 38 * struct intel_function - Description about a function 39 * @func: Generic data of the pin function (name and groups of pins) 40 */ 41 struct intel_function { 42 struct pinfunction func; 43 }; 44 45 #define INTEL_PINCTRL_MAX_GPP_SIZE 32 46 47 /** 48 * struct intel_padgroup - Hardware pad group information 49 * @reg_num: GPI_IS register number 50 * @base: Starting pin of this group 51 * @size: Size of this group (maximum is %INTEL_PINCTRL_MAX_GPP_SIZE). 52 * @gpio_base: Starting GPIO base of this group 53 * @padown_num: PAD_OWN register number (assigned by the core driver) 54 * 55 * If pad groups of a community are not the same size, use this structure 56 * to specify them. 57 */ 58 struct intel_padgroup { 59 unsigned int reg_num; 60 unsigned int base; 61 unsigned int size; 62 int gpio_base; 63 unsigned int padown_num; 64 }; 65 66 /** 67 * enum - Special treatment for GPIO base in pad group 68 * 69 * @INTEL_GPIO_BASE_ZERO: force GPIO base to be 0 70 * @INTEL_GPIO_BASE_NOMAP: no GPIO mapping should be created 71 * @INTEL_GPIO_BASE_MATCH: matches with starting pin number 72 */ 73 enum { 74 INTEL_GPIO_BASE_ZERO = -2, 75 INTEL_GPIO_BASE_NOMAP = -1, 76 INTEL_GPIO_BASE_MATCH = 0, 77 }; 78 79 /** 80 * struct intel_community - Intel pin community description 81 * @barno: MMIO BAR number where registers for this community reside 82 * @padown_offset: Register offset of PAD_OWN register from @regs. If %0 83 * then there is no support for owner. 84 * @padcfglock_offset: Register offset of PADCFGLOCK from @regs. If %0 then 85 * locking is not supported. 86 * @hostown_offset: Register offset of HOSTSW_OWN from @regs. If %0 then it 87 * is assumed that the host owns the pin (rather than 88 * ACPI). 89 * @is_offset: Register offset of GPI_IS from @regs. 90 * @ie_offset: Register offset of GPI_IE from @regs. 91 * @features: Additional features supported by the hardware 92 * @pin_base: Starting pin of pins in this community 93 * @npins: Number of pins in this community 94 * @gpp_size: Maximum number of pads in each group, such as PADCFGLOCK, 95 * HOSTSW_OWN, GPI_IS, GPI_IE. Used when @gpps is %NULL. 96 * @gpp_num_padown_regs: Number of pad registers each pad group consumes at 97 * minimum. Used when @gpps is %NULL. 98 * @gpps: Pad groups if the controller has variable size pad groups 99 * @ngpps: Number of pad groups in this community 100 * @pad_map: Optional non-linear mapping of the pads 101 * @nirqs: Optional total number of IRQs this community can generate 102 * @acpi_space_id: Optional address space ID for ACPI OpRegion handler 103 * @regs: Community specific common registers (reserved for core driver) 104 * @pad_regs: Community specific pad registers (reserved for core driver) 105 * 106 * In older Intel GPIO host controllers, this driver supports, each pad group 107 * is of equal size (except the last one). In that case the driver can just 108 * fill in @gpp_size and @gpp_num_padown_regs fields and let the core driver 109 * to handle the rest. 110 * 111 * In newer Intel GPIO host controllers each pad group is of variable size, 112 * so the client driver can pass custom @gpps and @ngpps instead. 113 */ 114 struct intel_community { 115 unsigned int barno; 116 unsigned int padown_offset; 117 unsigned int padcfglock_offset; 118 unsigned int hostown_offset; 119 unsigned int is_offset; 120 unsigned int ie_offset; 121 unsigned int features; 122 unsigned int pin_base; 123 size_t npins; 124 unsigned int gpp_size; 125 unsigned int gpp_num_padown_regs; 126 const struct intel_padgroup *gpps; 127 size_t ngpps; 128 const unsigned int *pad_map; 129 unsigned short nirqs; 130 unsigned short acpi_space_id; 131 132 /* Reserved for the core driver */ 133 void __iomem *regs; 134 void __iomem *pad_regs; 135 }; 136 137 /* Additional features supported by the hardware */ 138 #define PINCTRL_FEATURE_DEBOUNCE BIT(0) 139 #define PINCTRL_FEATURE_1K_PD BIT(1) 140 #define PINCTRL_FEATURE_GPIO_HW_INFO BIT(2) 141 #define PINCTRL_FEATURE_PWM BIT(3) 142 #define PINCTRL_FEATURE_BLINK BIT(4) 143 #define PINCTRL_FEATURE_EXP BIT(5) 144 145 #define __INTEL_COMMUNITY(b, s, e, g, n, gs, gn, soc) \ 146 { \ 147 .barno = (b), \ 148 .padown_offset = soc ## _PAD_OWN, \ 149 .padcfglock_offset = soc ## _PADCFGLOCK, \ 150 .hostown_offset = soc ## _HOSTSW_OWN, \ 151 .is_offset = soc ## _GPI_IS, \ 152 .ie_offset = soc ## _GPI_IE, \ 153 .gpp_size = (gs), \ 154 .gpp_num_padown_regs = (gn), \ 155 .pin_base = (s), \ 156 .npins = ((e) - (s) + 1), \ 157 .gpps = (g), \ 158 .ngpps = (n), \ 159 } 160 161 #define INTEL_COMMUNITY_GPPS(b, s, e, g, soc) \ 162 __INTEL_COMMUNITY(b, s, e, g, ARRAY_SIZE(g), 0, 0, soc) 163 164 #define INTEL_COMMUNITY_SIZE(b, s, e, gs, gn, soc) \ 165 __INTEL_COMMUNITY(b, s, e, NULL, 0, gs, gn, soc) 166 167 /** 168 * PIN_GROUP - Declare a pin group 169 * @n: Name of the group 170 * @p: An array of pins this group consists 171 * @m: Mode which the pins are put when this group is active. Can be either 172 * a single integer or an array of integers in which case mode is per 173 * pin. 174 */ 175 #define PIN_GROUP(n, p, m) \ 176 { \ 177 .grp = PINCTRL_PINGROUP((n), (p), ARRAY_SIZE((p))), \ 178 .mode = __builtin_choose_expr(__builtin_constant_p((m)), (m), 0), \ 179 .modes = __builtin_choose_expr(__builtin_constant_p((m)), NULL, (m)), \ 180 } 181 182 #define FUNCTION(n, g) \ 183 { \ 184 .func = PINCTRL_PINFUNCTION((n), (g), ARRAY_SIZE(g)), \ 185 } 186 187 /** 188 * struct intel_pinctrl_soc_data - Intel pin controller per-SoC configuration 189 * @uid: ACPI _UID for the probe driver use if needed 190 * @pins: Array if pins this pinctrl controls 191 * @npins: Number of pins in the array 192 * @groups: Array of pin groups 193 * @ngroups: Number of groups in the array 194 * @functions: Array of functions 195 * @nfunctions: Number of functions in the array 196 * @communities: Array of communities this pinctrl handles 197 * @ncommunities: Number of communities in the array 198 * 199 * The @communities is used as a template by the core driver. It will make 200 * copy of all communities and fill in rest of the information. 201 */ 202 struct intel_pinctrl_soc_data { 203 const char *uid; 204 const struct pinctrl_pin_desc *pins; 205 size_t npins; 206 const struct intel_pingroup *groups; 207 size_t ngroups; 208 const struct intel_function *functions; 209 size_t nfunctions; 210 const struct intel_community *communities; 211 size_t ncommunities; 212 }; 213 214 const struct intel_pinctrl_soc_data *intel_pinctrl_get_soc_data(struct platform_device *pdev); 215 216 struct intel_pad_context; 217 struct intel_community_context; 218 219 /** 220 * struct intel_pinctrl_context - context to be saved during suspend-resume 221 * @pads: Opaque context per pad (driver dependent) 222 * @communities: Opaque context per community (driver dependent) 223 */ 224 struct intel_pinctrl_context { 225 struct intel_pad_context *pads; 226 struct intel_community_context *communities; 227 }; 228 229 /** 230 * struct intel_pinctrl - Intel pinctrl private structure 231 * @dev: Pointer to the device structure 232 * @lock: Lock to serialize register access 233 * @pctldesc: Pin controller description 234 * @pctldev: Pointer to the pin controller device 235 * @chip: GPIO chip in this pin controller 236 * @soc: SoC/PCH specific pin configuration data 237 * @communities: All communities in this pin controller 238 * @ncommunities: Number of communities in this pin controller 239 * @context: Configuration saved over system sleep 240 * @irq: pinctrl/GPIO chip irq number 241 */ 242 struct intel_pinctrl { 243 struct device *dev; 244 raw_spinlock_t lock; 245 struct pinctrl_desc pctldesc; 246 struct pinctrl_dev *pctldev; 247 struct gpio_chip chip; 248 const struct intel_pinctrl_soc_data *soc; 249 struct intel_community *communities; 250 size_t ncommunities; 251 struct intel_pinctrl_context context; 252 int irq; 253 }; 254 255 int intel_pinctrl_probe_by_hid(struct platform_device *pdev); 256 int intel_pinctrl_probe_by_uid(struct platform_device *pdev); 257 258 #ifdef CONFIG_PM_SLEEP 259 int intel_pinctrl_suspend_noirq(struct device *dev); 260 int intel_pinctrl_resume_noirq(struct device *dev); 261 #endif 262 263 #define INTEL_PINCTRL_PM_OPS(_name) \ 264 const struct dev_pm_ops _name = { \ 265 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(intel_pinctrl_suspend_noirq, \ 266 intel_pinctrl_resume_noirq) \ 267 } 268 269 struct intel_community *intel_get_community(struct intel_pinctrl *pctrl, unsigned int pin); 270 271 int intel_get_groups_count(struct pinctrl_dev *pctldev); 272 const char *intel_get_group_name(struct pinctrl_dev *pctldev, unsigned int group); 273 int intel_get_group_pins(struct pinctrl_dev *pctldev, unsigned int group, 274 const unsigned int **pins, unsigned int *npins); 275 276 int intel_get_functions_count(struct pinctrl_dev *pctldev); 277 const char *intel_get_function_name(struct pinctrl_dev *pctldev, unsigned int function); 278 int intel_get_function_groups(struct pinctrl_dev *pctldev, unsigned int function, 279 const char * const **groups, unsigned int * const ngroups); 280 281 #endif /* PINCTRL_INTEL_H */ 282