1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2017 Intel Corp.
4 * Copyright 2019 Google LLC
6 * Taken partly from coreboot gpio.c
8 * Pinctrl is modelled as a separate device-tree node and device for each
9 * 'community' (basically a set of GPIOs). The separate devices work together
10 * and many functions permit any PINCTRL device to be provided as a parameter,
11 * since the pad numbering is unique across all devices.
13 * Each pinctrl has a single child GPIO device to handle GPIO access and
14 * therefore there is a simple GPIO driver included in this file.
17 #define LOG_CATEGORY UCLASS_GPIO
26 #include <asm-generic/gpio.h>
27 #include <asm/intel_pinctrl.h>
28 #include <asm/intel_pinctrl_defs.h>
29 #include <asm/arch/gpio.h>
31 #include <dm/device-internal.h>
32 #include <dt-bindings/gpio/gpio.h>
33 #include <linux/err.h>
35 #define GPIO_DW_SIZE(x) (sizeof(u32) * (x))
36 #define PAD_CFG_OFFSET(x, dw_num) ((x) + GPIO_DW_SIZE(dw_num))
37 #define PAD_CFG0_OFFSET(x) PAD_CFG_OFFSET(x, 0)
38 #define PAD_CFG1_OFFSET(x) PAD_CFG_OFFSET(x, 1)
40 #define MISCCFG_GPE0_DW0_SHIFT 8
41 #define MISCCFG_GPE0_DW0_MASK (0xf << MISCCFG_GPE0_DW0_SHIFT)
42 #define MISCCFG_GPE0_DW1_SHIFT 12
43 #define MISCCFG_GPE0_DW1_MASK (0xf << MISCCFG_GPE0_DW1_SHIFT)
44 #define MISCCFG_GPE0_DW2_SHIFT 16
45 #define MISCCFG_GPE0_DW2_MASK (0xf << MISCCFG_GPE0_DW2_SHIFT)
47 #define GPI_SMI_STS_OFFSET(comm, group) ((comm)->gpi_smi_sts_reg_0 + \
48 ((group) * sizeof(u32)))
49 #define GPI_SMI_EN_OFFSET(comm, group) ((comm)->gpi_smi_en_reg_0 + \
50 ((group) * sizeof(u32)))
51 #define GPI_IS_OFFSET(comm, group) ((comm)->gpi_int_sts_reg_0 + \
52 ((group) * sizeof(uint32_t)))
53 #define GPI_IE_OFFSET(comm, group) ((comm)->gpi_int_en_reg_0 + \
54 ((group) * sizeof(uint32_t)))
57 * relative_pad_in_comm() - Get the relative position of a GPIO
59 * This finds the position of a GPIO within a community
61 * @comm: Community to search
62 * @gpio: Pad number to look up (assumed to be valid)
63 * @return offset, 0 for first GPIO in community
65 static size_t relative_pad_in_comm(const struct pad_community *comm,
68 return gpio - comm->first_pad;
72 * pinctrl_group_index() - Find group for a a pad
74 * Find the group within the community that the pad is a part of
76 * @comm: Community to search
77 * @relative_pad: Pad to look up
78 * @return group number if found (see community_n_groups, etc.), or
79 * -ESPIPE if no groups, or -ENOENT if not found
81 static int pinctrl_group_index(const struct pad_community *comm,
89 /* find the base pad number for this pad's group */
90 for (i = 0; i < comm->num_groups; i++) {
91 if (relative_pad >= comm->groups[i].first_pad &&
92 relative_pad < comm->groups[i].first_pad +
100 static int pinctrl_group_index_scaled(const struct pad_community *comm,
101 uint relative_pad, size_t scale)
105 ret = pinctrl_group_index(comm, relative_pad);
112 static int pinctrl_within_group(const struct pad_community *comm,
117 ret = pinctrl_group_index(comm, relative_pad);
121 return relative_pad - comm->groups[ret].first_pad;
124 static u32 pinctrl_bitmask_within_group(const struct pad_community *comm,
127 return 1U << pinctrl_within_group(comm, relative_pad);
131 * pinctrl_get_device() - Find the device for a particular pad
133 * Each pinctr, device is attached to one community and this supports a number
134 * of pads. This function finds the device which controls a particular pad.
137 * @devp: Returns the device for that pad
138 * @return 0 if OK, -ENOTBLK if no device was found for the given pin
140 static int pinctrl_get_device(uint pad, struct udevice **devp)
145 * We have to probe each one of these since the community link is only
146 * attached in intel_pinctrl_of_to_plat().
148 uclass_foreach_dev_probe(UCLASS_PINCTRL, dev) {
149 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
150 const struct pad_community *comm = priv->comm;
152 if (pad >= comm->first_pad && pad <= comm->last_pad) {
157 log_debug("pad %d not found\n", pad);
162 int intel_pinctrl_get_pad(uint pad, struct udevice **devp, uint *offsetp)
164 const struct pad_community *comm;
165 struct intel_pinctrl_priv *priv;
169 ret = pinctrl_get_device(pad, &dev);
171 return log_msg_ret("pad", ret);
172 priv = dev_get_priv(dev);
175 *offsetp = relative_pad_in_comm(comm, pad);
180 static int pinctrl_configure_owner(struct udevice *dev,
181 const struct pad_config *cfg,
182 const struct pad_community *comm)
185 u16 hostsw_own_offset;
189 pin = relative_pad_in_comm(comm, cfg->pad);
192 * Based on the gpio pin number configure the corresponding bit in
193 * HOSTSW_OWN register. Value of 0x1 indicates GPIO Driver onwership.
195 hostsw_own_offset = comm->host_own_reg_0;
196 ret = pinctrl_group_index_scaled(comm, pin, sizeof(u32));
199 hostsw_own_offset += ret;
201 hostsw_own = pcr_read32(dev, hostsw_own_offset);
204 *The 4th bit in pad_config 1 (RO) is used to indicate if the pad
205 * needs GPIO driver ownership. Set the bit if GPIO driver ownership
206 * requested, otherwise clear the bit.
208 if (cfg->pad_config[1] & PAD_CFG1_GPIO_DRIVER)
209 hostsw_own |= pinctrl_bitmask_within_group(comm, pin);
211 hostsw_own &= ~pinctrl_bitmask_within_group(comm, pin);
213 pcr_write32(dev, hostsw_own_offset, hostsw_own);
218 static int gpi_enable_smi(struct udevice *dev, const struct pad_config *cfg,
219 const struct pad_community *comm)
228 if ((cfg->pad_config[0] & PAD_CFG0_ROUTE_SMI) != PAD_CFG0_ROUTE_SMI)
231 pin = relative_pad_in_comm(comm, cfg->pad);
232 ret = pinctrl_group_index(comm, pin);
237 sts_reg = GPI_SMI_STS_OFFSET(comm, group);
238 value = pcr_read32(dev, sts_reg);
239 /* Write back 1 to reset the sts bits */
240 pcr_write32(dev, sts_reg, value);
242 /* Set enable bits */
243 en_reg = GPI_SMI_EN_OFFSET(comm, group);
244 pcr_setbits32(dev, en_reg, pinctrl_bitmask_within_group(comm, pin));
249 static int pinctrl_configure_itss(struct udevice *dev,
250 const struct pad_config *cfg,
253 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
255 if (!priv->itss_pol_cfg)
261 * Set up ITSS polarity if pad is routed to APIC.
263 * The ITSS takes only active high interrupt signals. Therefore,
264 * if the pad configuration indicates an inversion assume the
265 * intent is for the ITSS polarity. Before forwarding on the
266 * request to the APIC there's an inversion setting for how the
267 * signal is forwarded to the APIC. Honor the inversion setting
268 * in the GPIO pad configuration so that a hardware active low
269 * signal looks that way to the APIC (double inversion).
271 if (!(cfg->pad_config[0] & PAD_CFG0_ROUTE_IOAPIC))
274 irq = pcr_read32(dev, PAD_CFG1_OFFSET(pad_cfg_offset));
275 irq &= PAD_CFG1_IRQ_MASK;
277 if (spl_phase() > PHASE_TPL)
278 log_err("GPIO %u doesn't support APIC routing\n",
281 return -EPROTONOSUPPORT;
283 irq_set_polarity(priv->itss, irq,
284 cfg->pad_config[0] & PAD_CFG0_RX_POL_INVERT);
289 /* Number of DWx config registers can be different for different SOCs */
290 static uint pad_config_offset(struct intel_pinctrl_priv *priv, uint pad)
292 const struct pad_community *comm = priv->comm;
295 offset = relative_pad_in_comm(comm, pad);
296 offset *= GPIO_DW_SIZE(priv->num_cfgs);
298 return offset + comm->pad_cfg_base;
301 static int pinctrl_pad_reset_config_override(const struct pad_community *comm,
304 const struct reset_mapping *rst_map = comm->reset_map;
307 /* Logical reset values equal chipset values */
308 if (!rst_map || !comm->num_reset_vals)
311 for (i = 0; i < comm->num_reset_vals; i++, rst_map++) {
312 if ((config_value & PAD_CFG0_RESET_MASK) == rst_map->logical) {
313 config_value &= ~PAD_CFG0_RESET_MASK;
314 config_value |= rst_map->chipset;
319 if (spl_phase() > PHASE_TPL)
320 log_err("Logical-to-Chipset mapping not found\n");
325 static const int mask[4] = {
327 PAD_CFG0_TX_DISABLE | PAD_CFG0_RX_DISABLE | PAD_CFG0_MODE_MASK |
328 PAD_CFG0_ROUTE_MASK | PAD_CFG0_RXTENCFG_MASK |
329 PAD_CFG0_RXINV_MASK | PAD_CFG0_PREGFRXSEL |
330 PAD_CFG0_TRIG_MASK | PAD_CFG0_RXRAW1_MASK |
331 PAD_CFG0_RXPADSTSEL_MASK | PAD_CFG0_RESET_MASK,
333 #ifdef CONFIG_INTEL_PINCTRL_IOSTANDBY
334 PAD_CFG1_IOSTERM_MASK | PAD_CFG1_PULL_MASK | PAD_CFG1_IOSSTATE_MASK,
336 PAD_CFG1_IOSTERM_MASK | PAD_CFG1_PULL_MASK,
339 PAD_CFG2_DEBOUNCE_MASK,
345 * pinctrl_configure_pad() - Configure a pad
347 * @dev: Pinctrl device containing the pad (see pinctrl_get_device())
348 * @cfg: Configuration to apply
349 * @return 0 if OK, -ve on error
351 static int pinctrl_configure_pad(struct udevice *dev,
352 const struct pad_config *cfg)
354 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
355 const struct pad_community *comm = priv->comm;
357 u32 pad_conf, soc_pad_conf;
362 return PTR_ERR(comm);
363 config_offset = pad_config_offset(priv, cfg->pad);
364 for (i = 0; i < priv->num_cfgs; i++) {
365 pad_conf = pcr_read32(dev, PAD_CFG_OFFSET(config_offset, i));
367 soc_pad_conf = cfg->pad_config[i];
369 ret = pinctrl_pad_reset_config_override(comm,
375 soc_pad_conf &= mask[i];
376 soc_pad_conf |= pad_conf & ~mask[i];
378 log_debug("pinctrl_padcfg [0x%02x, %02zd] DW%d [0x%08x : 0x%08x : 0x%08x]\n",
379 comm->port, relative_pad_in_comm(comm, cfg->pad), i,
380 pad_conf,/* old value */
381 /* value passed from pinctrl table */
383 soc_pad_conf); /*new value*/
384 pcr_write32(dev, PAD_CFG_OFFSET(config_offset, i),
387 ret = pinctrl_configure_itss(dev, cfg, config_offset);
388 if (ret && ret != -ENOSYS)
389 return log_msg_ret("itss config failed", ret);
390 ret = pinctrl_configure_owner(dev, cfg, comm);
393 ret = gpi_enable_smi(dev, cfg, comm);
400 u32 intel_pinctrl_get_config_reg_offset(struct udevice *dev, uint offset)
402 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
403 const struct pad_community *comm = priv->comm;
406 assert(device_get_uclass_id(dev) == UCLASS_PINCTRL);
407 config_offset = comm->pad_cfg_base + offset *
408 GPIO_DW_SIZE(priv->num_cfgs);
410 return config_offset;
413 u32 intel_pinctrl_get_config_reg_addr(struct udevice *dev, uint offset)
415 uint config_offset = intel_pinctrl_get_config_reg_offset(dev, offset);
417 return (u32)(ulong)pcr_reg_address(dev, config_offset);
420 u32 intel_pinctrl_get_config_reg(struct udevice *dev, uint offset)
422 uint config_offset = intel_pinctrl_get_config_reg_offset(dev, offset);
424 return pcr_read32(dev, config_offset);
427 int intel_pinctrl_get_acpi_pin(struct udevice *dev, uint offset)
429 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
430 const struct pad_community *comm = priv->comm;
433 if (IS_ENABLED(CONFIG_INTEL_PINCTRL_MULTI_ACPI_DEVICES))
435 group = pinctrl_group_index(comm, offset);
437 /* If pad base is not set then use GPIO number as ACPI pin number */
438 if (comm->groups[group].acpi_pad_base == PAD_BASE_NONE)
439 return comm->first_pad + offset;
442 * If this group has a non-zero pad base then compute the ACPI pin
443 * number from the pad base and the relative pad in the group.
445 return comm->groups[group].acpi_pad_base +
446 pinctrl_within_group(comm, offset);
449 int pinctrl_route_gpe(struct udevice *itss, uint gpe0b, uint gpe0c, uint gpe0d)
451 struct udevice *pinctrl_dev;
457 * Get the group here for community specific MISCCFG register.
458 * If any of these returns -1 then there is some error in devicetree
459 * where the group is probably hardcoded and does not comply with the
460 * PMC group defines. So we return from here and MISCFG is set to
463 ret = irq_route_pmc_gpio_gpe(itss, gpe0b);
468 ret = irq_route_pmc_gpio_gpe(itss, gpe0c);
473 ret = irq_route_pmc_gpio_gpe(itss, gpe0d);
478 misccfg_value = gpe0b << MISCCFG_GPE0_DW0_SHIFT;
479 misccfg_value |= gpe0c << MISCCFG_GPE0_DW1_SHIFT;
480 misccfg_value |= gpe0d << MISCCFG_GPE0_DW2_SHIFT;
482 /* Program GPIO_MISCCFG */
483 misccfg_clr = MISCCFG_GPE0_DW2_MASK | MISCCFG_GPE0_DW1_MASK |
484 MISCCFG_GPE0_DW0_MASK;
486 log_debug("misccfg_clr:%x misccfg_value:%x\n", misccfg_clr,
488 uclass_foreach_dev_probe(UCLASS_PINCTRL, pinctrl_dev) {
489 pcr_clrsetbits32(pinctrl_dev, GPIO_MISCCFG, misccfg_clr,
496 int pinctrl_gpi_clear_int_cfg(void)
502 ret = uclass_get(UCLASS_PINCTRL, &uc);
504 return log_msg_ret("pinctrl uc", ret);
505 uclass_foreach_dev(dev, uc) {
506 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
507 const struct pad_community *comm = priv->comm;
511 for (group = 0; group < comm->num_gpi_regs; group++) {
512 /* Clear the enable register */
513 pcr_write32(dev, GPI_IE_OFFSET(comm, group), 0);
515 /* Read and clear the set status register bits*/
516 sts_value = pcr_read32(dev,
517 GPI_IS_OFFSET(comm, group));
518 pcr_write32(dev, GPI_IS_OFFSET(comm, group), sts_value);
525 int pinctrl_config_pads(struct udevice *dev, u32 *pads, int pads_count)
527 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
531 log_debug("%s: pads_count=%d\n", __func__, pads_count);
532 for (ptr = pads, i = 0; i < pads_count;
533 ptr += 1 + priv->num_cfgs, i++) {
534 struct udevice *pad_dev = NULL;
535 struct pad_config *cfg;
538 cfg = (struct pad_config *)ptr;
539 ret = pinctrl_get_device(cfg->pad, &pad_dev);
542 ret = pinctrl_configure_pad(pad_dev, cfg);
550 int pinctrl_read_pads(struct udevice *dev, ofnode node, const char *prop,
551 u32 **padsp, int *pad_countp)
553 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
560 size = ofnode_read_size(node, prop);
567 size /= sizeof(fdt32_t);
568 ret = ofnode_read_u32_array(node, prop, pads, size);
573 *pad_countp = size / (1 + priv->num_cfgs);
579 int pinctrl_count_pads(struct udevice *dev, u32 *pads, int size)
581 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
585 for (i = 0; i < size;) {
589 for (val = j = 0; j < priv->num_cfgs + 1; j++)
594 i += priv->num_cfgs + 1;
600 int pinctrl_config_pads_for_node(struct udevice *dev, ofnode node)
606 if (device_get_uclass_id(dev) != UCLASS_PINCTRL)
607 return log_msg_ret("uclass", -EPROTONOSUPPORT);
608 ret = pinctrl_read_pads(dev, node, "pads", &pads, &pads_count);
610 return log_msg_ret("no pads", ret);
611 ret = pinctrl_config_pads(dev, pads, pads_count);
614 return log_msg_ret("pad config", ret);
619 int intel_pinctrl_of_to_plat(struct udevice *dev,
620 const struct pad_community *comm, int num_cfgs)
622 struct p2sb_child_plat *pplat = dev_get_parent_plat(dev);
623 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
626 if (spl_phase() > PHASE_TPL)
627 log_err("Cannot find community for pid %d\n",
632 priv->num_cfgs = num_cfgs;
637 int intel_pinctrl_probe(struct udevice *dev)
639 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
642 priv->itss_pol_cfg = true;
643 ret = irq_first_device_type(X86_IRQT_ITSS, &priv->itss);
645 return log_msg_ret("Cannot find ITSS", ret);
650 const struct pinctrl_ops intel_pinctrl_ops = {
651 /* No operations are supported, but DM expects this to be present */