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
24 #include <asm-generic/gpio.h>
25 #include <asm/intel_pinctrl.h>
26 #include <asm/intel_pinctrl_defs.h>
27 #include <asm/arch/gpio.h>
29 #include <dm/device-internal.h>
30 #include <dt-bindings/gpio/gpio.h>
32 #define GPIO_DW_SIZE(x) (sizeof(u32) * (x))
33 #define PAD_CFG_OFFSET(x, dw_num) ((x) + GPIO_DW_SIZE(dw_num))
34 #define PAD_CFG0_OFFSET(x) PAD_CFG_OFFSET(x, 0)
35 #define PAD_CFG1_OFFSET(x) PAD_CFG_OFFSET(x, 1)
37 #define MISCCFG_GPE0_DW0_SHIFT 8
38 #define MISCCFG_GPE0_DW0_MASK (0xf << MISCCFG_GPE0_DW0_SHIFT)
39 #define MISCCFG_GPE0_DW1_SHIFT 12
40 #define MISCCFG_GPE0_DW1_MASK (0xf << MISCCFG_GPE0_DW1_SHIFT)
41 #define MISCCFG_GPE0_DW2_SHIFT 16
42 #define MISCCFG_GPE0_DW2_MASK (0xf << MISCCFG_GPE0_DW2_SHIFT)
44 #define GPI_SMI_STS_OFFSET(comm, group) ((comm)->gpi_smi_sts_reg_0 + \
45 ((group) * sizeof(u32)))
46 #define GPI_SMI_EN_OFFSET(comm, group) ((comm)->gpi_smi_en_reg_0 + \
47 ((group) * sizeof(u32)))
48 #define GPI_IS_OFFSET(comm, group) ((comm)->gpi_int_sts_reg_0 + \
49 ((group) * sizeof(uint32_t)))
50 #define GPI_IE_OFFSET(comm, group) ((comm)->gpi_int_en_reg_0 + \
51 ((group) * sizeof(uint32_t)))
54 * relative_pad_in_comm() - Get the relative position of a GPIO
56 * This finds the position of a GPIO within a community
58 * @comm: Community to search
59 * @gpio: Pad number to look up (assumed to be valid)
60 * @return offset, 0 for first GPIO in community
62 static size_t relative_pad_in_comm(const struct pad_community *comm,
65 return gpio - comm->first_pad;
69 * pinctrl_group_index() - Find group for a a pad
71 * Find the group within the community that the pad is a part of
73 * @comm: Community to search
74 * @relative_pad: Pad to look up
75 * @return group number if found (see community_n_groups, etc.), or
76 * -ESPIPE if no groups, or -ENOENT if not found
78 static int pinctrl_group_index(const struct pad_community *comm,
86 /* find the base pad number for this pad's group */
87 for (i = 0; i < comm->num_groups; i++) {
88 if (relative_pad >= comm->groups[i].first_pad &&
89 relative_pad < comm->groups[i].first_pad +
97 static int pinctrl_group_index_scaled(const struct pad_community *comm,
98 uint relative_pad, size_t scale)
102 ret = pinctrl_group_index(comm, relative_pad);
109 static int pinctrl_within_group(const struct pad_community *comm,
114 ret = pinctrl_group_index(comm, relative_pad);
118 return relative_pad - comm->groups[ret].first_pad;
121 static u32 pinctrl_bitmask_within_group(const struct pad_community *comm,
124 return 1U << pinctrl_within_group(comm, relative_pad);
128 * pinctrl_get_device() - Find the device for a particular pad
130 * Each pinctr, device is attached to one community and this supports a number
131 * of pads. This function finds the device which controls a particular pad.
134 * @devp: Returns the device for that pad
135 * @return 0 if OK, -ENOTBLK if no device was found for the given pin
137 static int pinctrl_get_device(uint pad, struct udevice **devp)
142 * We have to probe each one of these since the community link is only
143 * attached in intel_pinctrl_ofdata_to_platdata().
145 uclass_foreach_dev_probe(UCLASS_PINCTRL, dev) {
146 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
147 const struct pad_community *comm = priv->comm;
149 if (pad >= comm->first_pad && pad <= comm->last_pad) {
154 printf("pad %d not found\n", pad);
159 int intel_pinctrl_get_pad(uint pad, struct udevice **devp, uint *offsetp)
161 const struct pad_community *comm;
162 struct intel_pinctrl_priv *priv;
166 ret = pinctrl_get_device(pad, &dev);
168 return log_msg_ret("pad", ret);
169 priv = dev_get_priv(dev);
172 *offsetp = relative_pad_in_comm(comm, pad);
177 static int pinctrl_configure_owner(struct udevice *dev,
178 const struct pad_config *cfg,
179 const struct pad_community *comm)
182 u16 hostsw_own_offset;
186 pin = relative_pad_in_comm(comm, cfg->pad);
189 * Based on the gpio pin number configure the corresponding bit in
190 * HOSTSW_OWN register. Value of 0x1 indicates GPIO Driver onwership.
192 hostsw_own_offset = comm->host_own_reg_0;
193 ret = pinctrl_group_index_scaled(comm, pin, sizeof(u32));
196 hostsw_own_offset += ret;
198 hostsw_own = pcr_read32(dev, hostsw_own_offset);
201 *The 4th bit in pad_config 1 (RO) is used to indicate if the pad
202 * needs GPIO driver ownership. Set the bit if GPIO driver ownership
203 * requested, otherwise clear the bit.
205 if (cfg->pad_config[1] & PAD_CFG1_GPIO_DRIVER)
206 hostsw_own |= pinctrl_bitmask_within_group(comm, pin);
208 hostsw_own &= ~pinctrl_bitmask_within_group(comm, pin);
210 pcr_write32(dev, hostsw_own_offset, hostsw_own);
215 static int gpi_enable_smi(struct udevice *dev, const struct pad_config *cfg,
216 const struct pad_community *comm)
225 if ((cfg->pad_config[0] & PAD_CFG0_ROUTE_SMI) != PAD_CFG0_ROUTE_SMI)
228 pin = relative_pad_in_comm(comm, cfg->pad);
229 ret = pinctrl_group_index(comm, pin);
234 sts_reg = GPI_SMI_STS_OFFSET(comm, group);
235 value = pcr_read32(dev, sts_reg);
236 /* Write back 1 to reset the sts bits */
237 pcr_write32(dev, sts_reg, value);
239 /* Set enable bits */
240 en_reg = GPI_SMI_EN_OFFSET(comm, group);
241 pcr_setbits32(dev, en_reg, pinctrl_bitmask_within_group(comm, pin));
246 static int pinctrl_configure_itss(struct udevice *dev,
247 const struct pad_config *cfg,
250 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
252 if (!priv->itss_pol_cfg)
258 * Set up ITSS polarity if pad is routed to APIC.
260 * The ITSS takes only active high interrupt signals. Therefore,
261 * if the pad configuration indicates an inversion assume the
262 * intent is for the ITSS polarity. Before forwarding on the
263 * request to the APIC there's an inversion setting for how the
264 * signal is forwarded to the APIC. Honor the inversion setting
265 * in the GPIO pad configuration so that a hardware active low
266 * signal looks that way to the APIC (double inversion).
268 if (!(cfg->pad_config[0] & PAD_CFG0_ROUTE_IOAPIC))
271 irq = pcr_read32(dev, PAD_CFG1_OFFSET(pad_cfg_offset));
272 irq &= PAD_CFG1_IRQ_MASK;
274 log_err("GPIO %u doesn't support APIC routing\n", cfg->pad);
276 return -EPROTONOSUPPORT;
278 irq_set_polarity(priv->itss, irq,
279 cfg->pad_config[0] & PAD_CFG0_RX_POL_INVERT);
284 /* Number of DWx config registers can be different for different SOCs */
285 static uint pad_config_offset(struct intel_pinctrl_priv *priv, uint pad)
287 const struct pad_community *comm = priv->comm;
290 offset = relative_pad_in_comm(comm, pad);
291 offset *= GPIO_DW_SIZE(priv->num_cfgs);
293 return offset + comm->pad_cfg_base;
296 static int pinctrl_pad_reset_config_override(const struct pad_community *comm,
299 const struct reset_mapping *rst_map = comm->reset_map;
302 /* Logical reset values equal chipset values */
303 if (!rst_map || !comm->num_reset_vals)
306 for (i = 0; i < comm->num_reset_vals; i++, rst_map++) {
307 if ((config_value & PAD_CFG0_RESET_MASK) == rst_map->logical) {
308 config_value &= ~PAD_CFG0_RESET_MASK;
309 config_value |= rst_map->chipset;
314 log_err("Logical-to-Chipset mapping not found\n");
319 static const int mask[4] = {
321 PAD_CFG0_TX_DISABLE | PAD_CFG0_RX_DISABLE | PAD_CFG0_MODE_MASK |
322 PAD_CFG0_ROUTE_MASK | PAD_CFG0_RXTENCFG_MASK |
323 PAD_CFG0_RXINV_MASK | PAD_CFG0_PREGFRXSEL |
324 PAD_CFG0_TRIG_MASK | PAD_CFG0_RXRAW1_MASK |
325 PAD_CFG0_RXPADSTSEL_MASK | PAD_CFG0_RESET_MASK,
327 #ifdef CONFIG_INTEL_PINCTRL_IOSTANDBY
328 PAD_CFG1_IOSTERM_MASK | PAD_CFG1_PULL_MASK | PAD_CFG1_IOSSTATE_MASK,
330 PAD_CFG1_IOSTERM_MASK | PAD_CFG1_PULL_MASK,
333 PAD_CFG2_DEBOUNCE_MASK,
339 * pinctrl_configure_pad() - Configure a pad
341 * @dev: Pinctrl device containing the pad (see pinctrl_get_device())
342 * @cfg: Configuration to apply
343 * @return 0 if OK, -ve on error
345 static int pinctrl_configure_pad(struct udevice *dev,
346 const struct pad_config *cfg)
348 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
349 const struct pad_community *comm = priv->comm;
351 u32 pad_conf, soc_pad_conf;
356 return PTR_ERR(comm);
357 config_offset = pad_config_offset(priv, cfg->pad);
358 for (i = 0; i < priv->num_cfgs; i++) {
359 pad_conf = pcr_read32(dev, PAD_CFG_OFFSET(config_offset, i));
361 soc_pad_conf = cfg->pad_config[i];
363 ret = pinctrl_pad_reset_config_override(comm,
369 soc_pad_conf &= mask[i];
370 soc_pad_conf |= pad_conf & ~mask[i];
372 log_debug("pinctrl_padcfg [0x%02x, %02zd] DW%d [0x%08x : 0x%08x : 0x%08x]\n",
373 comm->port, relative_pad_in_comm(comm, cfg->pad), i,
374 pad_conf,/* old value */
375 /* value passed from pinctrl table */
377 soc_pad_conf); /*new value*/
378 pcr_write32(dev, PAD_CFG_OFFSET(config_offset, i),
381 ret = pinctrl_configure_itss(dev, cfg, config_offset);
382 if (ret && ret != -ENOSYS)
383 return log_msg_ret("itss config failed", ret);
384 ret = pinctrl_configure_owner(dev, cfg, comm);
387 ret = gpi_enable_smi(dev, cfg, comm);
394 u32 intel_pinctrl_get_config_reg_addr(struct udevice *dev, uint offset)
396 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
397 const struct pad_community *comm = priv->comm;
400 assert(device_get_uclass_id(dev) == UCLASS_PINCTRL);
401 config_offset = comm->pad_cfg_base + offset *
402 GPIO_DW_SIZE(priv->num_cfgs);
404 return config_offset;
407 u32 intel_pinctrl_get_config_reg(struct udevice *dev, uint offset)
409 uint config_offset = intel_pinctrl_get_config_reg_addr(dev, offset);
411 return pcr_read32(dev, config_offset);
414 int intel_pinctrl_get_acpi_pin(struct udevice *dev, uint offset)
416 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
417 const struct pad_community *comm = priv->comm;
420 group = pinctrl_group_index(comm, offset);
422 /* If pad base is not set then use GPIO number as ACPI pin number */
423 if (comm->groups[group].acpi_pad_base == PAD_BASE_NONE)
424 return comm->first_pad + offset;
427 * If this group has a non-zero pad base then compute the ACPI pin
428 * number from the pad base and the relative pad in the group.
430 return comm->groups[group].acpi_pad_base +
431 pinctrl_within_group(comm, offset);
434 int pinctrl_route_gpe(struct udevice *itss, uint gpe0b, uint gpe0c, uint gpe0d)
436 struct udevice *pinctrl_dev;
442 * Get the group here for community specific MISCCFG register.
443 * If any of these returns -1 then there is some error in devicetree
444 * where the group is probably hardcoded and does not comply with the
445 * PMC group defines. So we return from here and MISCFG is set to
448 ret = irq_route_pmc_gpio_gpe(itss, gpe0b);
453 ret = irq_route_pmc_gpio_gpe(itss, gpe0c);
458 ret = irq_route_pmc_gpio_gpe(itss, gpe0d);
463 misccfg_value = gpe0b << MISCCFG_GPE0_DW0_SHIFT;
464 misccfg_value |= gpe0c << MISCCFG_GPE0_DW1_SHIFT;
465 misccfg_value |= gpe0d << MISCCFG_GPE0_DW2_SHIFT;
467 /* Program GPIO_MISCCFG */
468 misccfg_clr = MISCCFG_GPE0_DW2_MASK | MISCCFG_GPE0_DW1_MASK |
469 MISCCFG_GPE0_DW0_MASK;
471 log_debug("misccfg_clr:%x misccfg_value:%x\n", misccfg_clr,
473 uclass_foreach_dev_probe(UCLASS_PINCTRL, pinctrl_dev) {
474 pcr_clrsetbits32(pinctrl_dev, GPIO_MISCCFG, misccfg_clr,
481 int pinctrl_gpi_clear_int_cfg(void)
487 ret = uclass_get(UCLASS_PINCTRL, &uc);
489 return log_msg_ret("pinctrl uc", ret);
490 uclass_foreach_dev(dev, uc) {
491 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
492 const struct pad_community *comm = priv->comm;
496 for (group = 0; group < comm->num_gpi_regs; group++) {
497 /* Clear the enable register */
498 pcr_write32(dev, GPI_IE_OFFSET(comm, group), 0);
500 /* Read and clear the set status register bits*/
501 sts_value = pcr_read32(dev,
502 GPI_IS_OFFSET(comm, group));
503 pcr_write32(dev, GPI_IS_OFFSET(comm, group), sts_value);
510 int pinctrl_config_pads(struct udevice *dev, u32 *pads, int pads_count)
512 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
516 log_debug("%s: pads_count=%d\n", __func__, pads_count);
517 for (ptr = pads, i = 0; i < pads_count;
518 ptr += 1 + priv->num_cfgs, i++) {
519 struct udevice *pad_dev = NULL;
520 struct pad_config *cfg;
523 cfg = (struct pad_config *)ptr;
524 ret = pinctrl_get_device(cfg->pad, &pad_dev);
527 ret = pinctrl_configure_pad(pad_dev, cfg);
535 int pinctrl_read_pads(struct udevice *dev, ofnode node, const char *prop,
536 u32 **padsp, int *pad_countp)
538 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
545 size = ofnode_read_size(node, prop);
552 size /= sizeof(fdt32_t);
553 ret = ofnode_read_u32_array(node, prop, pads, size);
558 *pad_countp = size / (1 + priv->num_cfgs);
564 int pinctrl_count_pads(struct udevice *dev, u32 *pads, int size)
566 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
570 for (i = 0; i < size;) {
574 for (val = j = 0; j < priv->num_cfgs + 1; j++)
579 i += priv->num_cfgs + 1;
585 int pinctrl_config_pads_for_node(struct udevice *dev, ofnode node)
591 if (device_get_uclass_id(dev) != UCLASS_PINCTRL)
592 return log_msg_ret("uclass", -EPROTONOSUPPORT);
593 ret = pinctrl_read_pads(dev, node, "pads", &pads, &pads_count);
595 return log_msg_ret("no pads", ret);
596 ret = pinctrl_config_pads(dev, pads, pads_count);
599 return log_msg_ret("pad config", ret);
604 int intel_pinctrl_ofdata_to_platdata(struct udevice *dev,
605 const struct pad_community *comm,
608 struct p2sb_child_platdata *pplat = dev_get_parent_platdata(dev);
609 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
613 log_err("Cannot find community for pid %d\n", pplat->pid);
616 ret = uclass_first_device_err(UCLASS_IRQ, &priv->itss);
618 return log_msg_ret("Cannot find ITSS", ret);
620 priv->num_cfgs = num_cfgs;
625 int intel_pinctrl_probe(struct udevice *dev)
627 struct intel_pinctrl_priv *priv = dev_get_priv(dev);
629 priv->itss_pol_cfg = true;
634 const struct pinctrl_ops intel_pinctrl_ops = {
635 /* No operations are supported, but DM expects this to be present */