x86/speculation/mds: Fix documentation typo
[linux/fpc-iii.git] / drivers / pinctrl / intel / pinctrl-intel.c
blob71df0f70b61f01c51484c87f35bdba9a1158cdbc
1 /*
2 * Intel pinctrl/GPIO core driver.
4 * Copyright (C) 2015, Intel Corporation
5 * Authors: Mathias Nyman <mathias.nyman@linux.intel.com>
6 * Mika Westerberg <mika.westerberg@linux.intel.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/module.h>
14 #include <linux/interrupt.h>
15 #include <linux/gpio/driver.h>
16 #include <linux/log2.h>
17 #include <linux/platform_device.h>
18 #include <linux/pinctrl/pinctrl.h>
19 #include <linux/pinctrl/pinmux.h>
20 #include <linux/pinctrl/pinconf.h>
21 #include <linux/pinctrl/pinconf-generic.h>
23 #include "../core.h"
24 #include "pinctrl-intel.h"
26 /* Offset from regs */
27 #define REVID 0x000
28 #define REVID_SHIFT 16
29 #define REVID_MASK GENMASK(31, 16)
31 #define PADBAR 0x00c
32 #define GPI_IS 0x100
33 #define GPI_GPE_STS 0x140
34 #define GPI_GPE_EN 0x160
36 #define PADOWN_BITS 4
37 #define PADOWN_SHIFT(p) ((p) % 8 * PADOWN_BITS)
38 #define PADOWN_MASK(p) (0xf << PADOWN_SHIFT(p))
39 #define PADOWN_GPP(p) ((p) / 8)
41 /* Offset from pad_regs */
42 #define PADCFG0 0x000
43 #define PADCFG0_RXEVCFG_SHIFT 25
44 #define PADCFG0_RXEVCFG_MASK (3 << PADCFG0_RXEVCFG_SHIFT)
45 #define PADCFG0_RXEVCFG_LEVEL 0
46 #define PADCFG0_RXEVCFG_EDGE 1
47 #define PADCFG0_RXEVCFG_DISABLED 2
48 #define PADCFG0_RXEVCFG_EDGE_BOTH 3
49 #define PADCFG0_PREGFRXSEL BIT(24)
50 #define PADCFG0_RXINV BIT(23)
51 #define PADCFG0_GPIROUTIOXAPIC BIT(20)
52 #define PADCFG0_GPIROUTSCI BIT(19)
53 #define PADCFG0_GPIROUTSMI BIT(18)
54 #define PADCFG0_GPIROUTNMI BIT(17)
55 #define PADCFG0_PMODE_SHIFT 10
56 #define PADCFG0_PMODE_MASK (0xf << PADCFG0_PMODE_SHIFT)
57 #define PADCFG0_GPIORXDIS BIT(9)
58 #define PADCFG0_GPIOTXDIS BIT(8)
59 #define PADCFG0_GPIORXSTATE BIT(1)
60 #define PADCFG0_GPIOTXSTATE BIT(0)
62 #define PADCFG1 0x004
63 #define PADCFG1_TERM_UP BIT(13)
64 #define PADCFG1_TERM_SHIFT 10
65 #define PADCFG1_TERM_MASK (7 << PADCFG1_TERM_SHIFT)
66 #define PADCFG1_TERM_20K 4
67 #define PADCFG1_TERM_2K 3
68 #define PADCFG1_TERM_5K 2
69 #define PADCFG1_TERM_1K 1
71 #define PADCFG2 0x008
72 #define PADCFG2_DEBEN BIT(0)
73 #define PADCFG2_DEBOUNCE_SHIFT 1
74 #define PADCFG2_DEBOUNCE_MASK GENMASK(4, 1)
76 #define DEBOUNCE_PERIOD 31250 /* ns */
78 struct intel_pad_context {
79 u32 padcfg0;
80 u32 padcfg1;
81 u32 padcfg2;
84 struct intel_community_context {
85 u32 *intmask;
88 struct intel_pinctrl_context {
89 struct intel_pad_context *pads;
90 struct intel_community_context *communities;
93 /**
94 * struct intel_pinctrl - Intel pinctrl private structure
95 * @dev: Pointer to the device structure
96 * @lock: Lock to serialize register access
97 * @pctldesc: Pin controller description
98 * @pctldev: Pointer to the pin controller device
99 * @chip: GPIO chip in this pin controller
100 * @soc: SoC/PCH specific pin configuration data
101 * @communities: All communities in this pin controller
102 * @ncommunities: Number of communities in this pin controller
103 * @context: Configuration saved over system sleep
104 * @irq: pinctrl/GPIO chip irq number
106 struct intel_pinctrl {
107 struct device *dev;
108 raw_spinlock_t lock;
109 struct pinctrl_desc pctldesc;
110 struct pinctrl_dev *pctldev;
111 struct gpio_chip chip;
112 const struct intel_pinctrl_soc_data *soc;
113 struct intel_community *communities;
114 size_t ncommunities;
115 struct intel_pinctrl_context context;
116 int irq;
119 #define pin_to_padno(c, p) ((p) - (c)->pin_base)
120 #define padgroup_offset(g, p) ((p) - (g)->base)
122 static struct intel_community *intel_get_community(struct intel_pinctrl *pctrl,
123 unsigned pin)
125 struct intel_community *community;
126 int i;
128 for (i = 0; i < pctrl->ncommunities; i++) {
129 community = &pctrl->communities[i];
130 if (pin >= community->pin_base &&
131 pin < community->pin_base + community->npins)
132 return community;
135 dev_warn(pctrl->dev, "failed to find community for pin %u\n", pin);
136 return NULL;
139 static const struct intel_padgroup *
140 intel_community_get_padgroup(const struct intel_community *community,
141 unsigned pin)
143 int i;
145 for (i = 0; i < community->ngpps; i++) {
146 const struct intel_padgroup *padgrp = &community->gpps[i];
148 if (pin >= padgrp->base && pin < padgrp->base + padgrp->size)
149 return padgrp;
152 return NULL;
155 static void __iomem *intel_get_padcfg(struct intel_pinctrl *pctrl, unsigned pin,
156 unsigned reg)
158 const struct intel_community *community;
159 unsigned padno;
160 size_t nregs;
162 community = intel_get_community(pctrl, pin);
163 if (!community)
164 return NULL;
166 padno = pin_to_padno(community, pin);
167 nregs = (community->features & PINCTRL_FEATURE_DEBOUNCE) ? 4 : 2;
169 if (reg == PADCFG2 && !(community->features & PINCTRL_FEATURE_DEBOUNCE))
170 return NULL;
172 return community->pad_regs + reg + padno * nregs * 4;
175 static bool intel_pad_owned_by_host(struct intel_pinctrl *pctrl, unsigned pin)
177 const struct intel_community *community;
178 const struct intel_padgroup *padgrp;
179 unsigned gpp, offset, gpp_offset;
180 void __iomem *padown;
182 community = intel_get_community(pctrl, pin);
183 if (!community)
184 return false;
185 if (!community->padown_offset)
186 return true;
188 padgrp = intel_community_get_padgroup(community, pin);
189 if (!padgrp)
190 return false;
192 gpp_offset = padgroup_offset(padgrp, pin);
193 gpp = PADOWN_GPP(gpp_offset);
194 offset = community->padown_offset + padgrp->padown_num * 4 + gpp * 4;
195 padown = community->regs + offset;
197 return !(readl(padown) & PADOWN_MASK(gpp_offset));
200 static bool intel_pad_acpi_mode(struct intel_pinctrl *pctrl, unsigned pin)
202 const struct intel_community *community;
203 const struct intel_padgroup *padgrp;
204 unsigned offset, gpp_offset;
205 void __iomem *hostown;
207 community = intel_get_community(pctrl, pin);
208 if (!community)
209 return true;
210 if (!community->hostown_offset)
211 return false;
213 padgrp = intel_community_get_padgroup(community, pin);
214 if (!padgrp)
215 return true;
217 gpp_offset = padgroup_offset(padgrp, pin);
218 offset = community->hostown_offset + padgrp->reg_num * 4;
219 hostown = community->regs + offset;
221 return !(readl(hostown) & BIT(gpp_offset));
224 static bool intel_pad_locked(struct intel_pinctrl *pctrl, unsigned pin)
226 struct intel_community *community;
227 const struct intel_padgroup *padgrp;
228 unsigned offset, gpp_offset;
229 u32 value;
231 community = intel_get_community(pctrl, pin);
232 if (!community)
233 return true;
234 if (!community->padcfglock_offset)
235 return false;
237 padgrp = intel_community_get_padgroup(community, pin);
238 if (!padgrp)
239 return true;
241 gpp_offset = padgroup_offset(padgrp, pin);
244 * If PADCFGLOCK and PADCFGLOCKTX bits are both clear for this pad,
245 * the pad is considered unlocked. Any other case means that it is
246 * either fully or partially locked and we don't touch it.
248 offset = community->padcfglock_offset + padgrp->reg_num * 8;
249 value = readl(community->regs + offset);
250 if (value & BIT(gpp_offset))
251 return true;
253 offset = community->padcfglock_offset + 4 + padgrp->reg_num * 8;
254 value = readl(community->regs + offset);
255 if (value & BIT(gpp_offset))
256 return true;
258 return false;
261 static bool intel_pad_usable(struct intel_pinctrl *pctrl, unsigned pin)
263 return intel_pad_owned_by_host(pctrl, pin) &&
264 !intel_pad_locked(pctrl, pin);
267 static int intel_get_groups_count(struct pinctrl_dev *pctldev)
269 struct intel_pinctrl *pctrl = pinctrl_dev_get_drvdata(pctldev);
271 return pctrl->soc->ngroups;
274 static const char *intel_get_group_name(struct pinctrl_dev *pctldev,
275 unsigned group)
277 struct intel_pinctrl *pctrl = pinctrl_dev_get_drvdata(pctldev);
279 return pctrl->soc->groups[group].name;
282 static int intel_get_group_pins(struct pinctrl_dev *pctldev, unsigned group,
283 const unsigned **pins, unsigned *npins)
285 struct intel_pinctrl *pctrl = pinctrl_dev_get_drvdata(pctldev);
287 *pins = pctrl->soc->groups[group].pins;
288 *npins = pctrl->soc->groups[group].npins;
289 return 0;
292 static void intel_pin_dbg_show(struct pinctrl_dev *pctldev, struct seq_file *s,
293 unsigned pin)
295 struct intel_pinctrl *pctrl = pinctrl_dev_get_drvdata(pctldev);
296 void __iomem *padcfg;
297 u32 cfg0, cfg1, mode;
298 bool locked, acpi;
300 if (!intel_pad_owned_by_host(pctrl, pin)) {
301 seq_puts(s, "not available");
302 return;
305 cfg0 = readl(intel_get_padcfg(pctrl, pin, PADCFG0));
306 cfg1 = readl(intel_get_padcfg(pctrl, pin, PADCFG1));
308 mode = (cfg0 & PADCFG0_PMODE_MASK) >> PADCFG0_PMODE_SHIFT;
309 if (!mode)
310 seq_puts(s, "GPIO ");
311 else
312 seq_printf(s, "mode %d ", mode);
314 seq_printf(s, "0x%08x 0x%08x", cfg0, cfg1);
316 /* Dump the additional PADCFG registers if available */
317 padcfg = intel_get_padcfg(pctrl, pin, PADCFG2);
318 if (padcfg)
319 seq_printf(s, " 0x%08x", readl(padcfg));
321 locked = intel_pad_locked(pctrl, pin);
322 acpi = intel_pad_acpi_mode(pctrl, pin);
324 if (locked || acpi) {
325 seq_puts(s, " [");
326 if (locked) {
327 seq_puts(s, "LOCKED");
328 if (acpi)
329 seq_puts(s, ", ");
331 if (acpi)
332 seq_puts(s, "ACPI");
333 seq_puts(s, "]");
337 static const struct pinctrl_ops intel_pinctrl_ops = {
338 .get_groups_count = intel_get_groups_count,
339 .get_group_name = intel_get_group_name,
340 .get_group_pins = intel_get_group_pins,
341 .pin_dbg_show = intel_pin_dbg_show,
344 static int intel_get_functions_count(struct pinctrl_dev *pctldev)
346 struct intel_pinctrl *pctrl = pinctrl_dev_get_drvdata(pctldev);
348 return pctrl->soc->nfunctions;
351 static const char *intel_get_function_name(struct pinctrl_dev *pctldev,
352 unsigned function)
354 struct intel_pinctrl *pctrl = pinctrl_dev_get_drvdata(pctldev);
356 return pctrl->soc->functions[function].name;
359 static int intel_get_function_groups(struct pinctrl_dev *pctldev,
360 unsigned function,
361 const char * const **groups,
362 unsigned * const ngroups)
364 struct intel_pinctrl *pctrl = pinctrl_dev_get_drvdata(pctldev);
366 *groups = pctrl->soc->functions[function].groups;
367 *ngroups = pctrl->soc->functions[function].ngroups;
368 return 0;
371 static int intel_pinmux_set_mux(struct pinctrl_dev *pctldev, unsigned function,
372 unsigned group)
374 struct intel_pinctrl *pctrl = pinctrl_dev_get_drvdata(pctldev);
375 const struct intel_pingroup *grp = &pctrl->soc->groups[group];
376 unsigned long flags;
377 int i;
379 raw_spin_lock_irqsave(&pctrl->lock, flags);
382 * All pins in the groups needs to be accessible and writable
383 * before we can enable the mux for this group.
385 for (i = 0; i < grp->npins; i++) {
386 if (!intel_pad_usable(pctrl, grp->pins[i])) {
387 raw_spin_unlock_irqrestore(&pctrl->lock, flags);
388 return -EBUSY;
392 /* Now enable the mux setting for each pin in the group */
393 for (i = 0; i < grp->npins; i++) {
394 void __iomem *padcfg0;
395 u32 value;
397 padcfg0 = intel_get_padcfg(pctrl, grp->pins[i], PADCFG0);
398 value = readl(padcfg0);
400 value &= ~PADCFG0_PMODE_MASK;
402 if (grp->modes)
403 value |= grp->modes[i] << PADCFG0_PMODE_SHIFT;
404 else
405 value |= grp->mode << PADCFG0_PMODE_SHIFT;
407 writel(value, padcfg0);
410 raw_spin_unlock_irqrestore(&pctrl->lock, flags);
412 return 0;
415 static void __intel_gpio_set_direction(void __iomem *padcfg0, bool input)
417 u32 value;
419 value = readl(padcfg0);
420 if (input) {
421 value &= ~PADCFG0_GPIORXDIS;
422 value |= PADCFG0_GPIOTXDIS;
423 } else {
424 value &= ~PADCFG0_GPIOTXDIS;
425 value |= PADCFG0_GPIORXDIS;
427 writel(value, padcfg0);
430 static int intel_gpio_request_enable(struct pinctrl_dev *pctldev,
431 struct pinctrl_gpio_range *range,
432 unsigned pin)
434 struct intel_pinctrl *pctrl = pinctrl_dev_get_drvdata(pctldev);
435 void __iomem *padcfg0;
436 unsigned long flags;
437 u32 value;
439 raw_spin_lock_irqsave(&pctrl->lock, flags);
441 if (!intel_pad_usable(pctrl, pin)) {
442 raw_spin_unlock_irqrestore(&pctrl->lock, flags);
443 return -EBUSY;
446 padcfg0 = intel_get_padcfg(pctrl, pin, PADCFG0);
447 /* Put the pad into GPIO mode */
448 value = readl(padcfg0) & ~PADCFG0_PMODE_MASK;
449 /* Disable SCI/SMI/NMI generation */
450 value &= ~(PADCFG0_GPIROUTIOXAPIC | PADCFG0_GPIROUTSCI);
451 value &= ~(PADCFG0_GPIROUTSMI | PADCFG0_GPIROUTNMI);
452 writel(value, padcfg0);
454 /* Disable TX buffer and enable RX (this will be input) */
455 __intel_gpio_set_direction(padcfg0, true);
457 raw_spin_unlock_irqrestore(&pctrl->lock, flags);
459 return 0;
462 static int intel_gpio_set_direction(struct pinctrl_dev *pctldev,
463 struct pinctrl_gpio_range *range,
464 unsigned pin, bool input)
466 struct intel_pinctrl *pctrl = pinctrl_dev_get_drvdata(pctldev);
467 void __iomem *padcfg0;
468 unsigned long flags;
470 raw_spin_lock_irqsave(&pctrl->lock, flags);
472 padcfg0 = intel_get_padcfg(pctrl, pin, PADCFG0);
473 __intel_gpio_set_direction(padcfg0, input);
475 raw_spin_unlock_irqrestore(&pctrl->lock, flags);
477 return 0;
480 static const struct pinmux_ops intel_pinmux_ops = {
481 .get_functions_count = intel_get_functions_count,
482 .get_function_name = intel_get_function_name,
483 .get_function_groups = intel_get_function_groups,
484 .set_mux = intel_pinmux_set_mux,
485 .gpio_request_enable = intel_gpio_request_enable,
486 .gpio_set_direction = intel_gpio_set_direction,
489 static int intel_config_get(struct pinctrl_dev *pctldev, unsigned pin,
490 unsigned long *config)
492 struct intel_pinctrl *pctrl = pinctrl_dev_get_drvdata(pctldev);
493 enum pin_config_param param = pinconf_to_config_param(*config);
494 const struct intel_community *community;
495 u32 value, term;
496 u32 arg = 0;
498 if (!intel_pad_owned_by_host(pctrl, pin))
499 return -ENOTSUPP;
501 community = intel_get_community(pctrl, pin);
502 value = readl(intel_get_padcfg(pctrl, pin, PADCFG1));
503 term = (value & PADCFG1_TERM_MASK) >> PADCFG1_TERM_SHIFT;
505 switch (param) {
506 case PIN_CONFIG_BIAS_DISABLE:
507 if (term)
508 return -EINVAL;
509 break;
511 case PIN_CONFIG_BIAS_PULL_UP:
512 if (!term || !(value & PADCFG1_TERM_UP))
513 return -EINVAL;
515 switch (term) {
516 case PADCFG1_TERM_1K:
517 arg = 1000;
518 break;
519 case PADCFG1_TERM_2K:
520 arg = 2000;
521 break;
522 case PADCFG1_TERM_5K:
523 arg = 5000;
524 break;
525 case PADCFG1_TERM_20K:
526 arg = 20000;
527 break;
530 break;
532 case PIN_CONFIG_BIAS_PULL_DOWN:
533 if (!term || value & PADCFG1_TERM_UP)
534 return -EINVAL;
536 switch (term) {
537 case PADCFG1_TERM_1K:
538 if (!(community->features & PINCTRL_FEATURE_1K_PD))
539 return -EINVAL;
540 arg = 1000;
541 break;
542 case PADCFG1_TERM_5K:
543 arg = 5000;
544 break;
545 case PADCFG1_TERM_20K:
546 arg = 20000;
547 break;
550 break;
552 case PIN_CONFIG_INPUT_DEBOUNCE: {
553 void __iomem *padcfg2;
554 u32 v;
556 padcfg2 = intel_get_padcfg(pctrl, pin, PADCFG2);
557 if (!padcfg2)
558 return -ENOTSUPP;
560 v = readl(padcfg2);
561 if (!(v & PADCFG2_DEBEN))
562 return -EINVAL;
564 v = (v & PADCFG2_DEBOUNCE_MASK) >> PADCFG2_DEBOUNCE_SHIFT;
565 arg = BIT(v) * DEBOUNCE_PERIOD / 1000;
567 break;
570 default:
571 return -ENOTSUPP;
574 *config = pinconf_to_config_packed(param, arg);
575 return 0;
578 static int intel_config_set_pull(struct intel_pinctrl *pctrl, unsigned pin,
579 unsigned long config)
581 unsigned param = pinconf_to_config_param(config);
582 unsigned arg = pinconf_to_config_argument(config);
583 const struct intel_community *community;
584 void __iomem *padcfg1;
585 unsigned long flags;
586 int ret = 0;
587 u32 value;
589 raw_spin_lock_irqsave(&pctrl->lock, flags);
591 community = intel_get_community(pctrl, pin);
592 padcfg1 = intel_get_padcfg(pctrl, pin, PADCFG1);
593 value = readl(padcfg1);
595 switch (param) {
596 case PIN_CONFIG_BIAS_DISABLE:
597 value &= ~(PADCFG1_TERM_MASK | PADCFG1_TERM_UP);
598 break;
600 case PIN_CONFIG_BIAS_PULL_UP:
601 value &= ~PADCFG1_TERM_MASK;
603 value |= PADCFG1_TERM_UP;
605 switch (arg) {
606 case 20000:
607 value |= PADCFG1_TERM_20K << PADCFG1_TERM_SHIFT;
608 break;
609 case 5000:
610 value |= PADCFG1_TERM_5K << PADCFG1_TERM_SHIFT;
611 break;
612 case 2000:
613 value |= PADCFG1_TERM_2K << PADCFG1_TERM_SHIFT;
614 break;
615 case 1000:
616 value |= PADCFG1_TERM_1K << PADCFG1_TERM_SHIFT;
617 break;
618 default:
619 ret = -EINVAL;
622 break;
624 case PIN_CONFIG_BIAS_PULL_DOWN:
625 value &= ~(PADCFG1_TERM_UP | PADCFG1_TERM_MASK);
627 switch (arg) {
628 case 20000:
629 value |= PADCFG1_TERM_20K << PADCFG1_TERM_SHIFT;
630 break;
631 case 5000:
632 value |= PADCFG1_TERM_5K << PADCFG1_TERM_SHIFT;
633 break;
634 case 1000:
635 if (!(community->features & PINCTRL_FEATURE_1K_PD)) {
636 ret = -EINVAL;
637 break;
639 value |= PADCFG1_TERM_1K << PADCFG1_TERM_SHIFT;
640 break;
641 default:
642 ret = -EINVAL;
645 break;
648 if (!ret)
649 writel(value, padcfg1);
651 raw_spin_unlock_irqrestore(&pctrl->lock, flags);
653 return ret;
656 static int intel_config_set_debounce(struct intel_pinctrl *pctrl, unsigned pin,
657 unsigned debounce)
659 void __iomem *padcfg0, *padcfg2;
660 unsigned long flags;
661 u32 value0, value2;
662 int ret = 0;
664 padcfg2 = intel_get_padcfg(pctrl, pin, PADCFG2);
665 if (!padcfg2)
666 return -ENOTSUPP;
668 padcfg0 = intel_get_padcfg(pctrl, pin, PADCFG0);
670 raw_spin_lock_irqsave(&pctrl->lock, flags);
672 value0 = readl(padcfg0);
673 value2 = readl(padcfg2);
675 /* Disable glitch filter and debouncer */
676 value0 &= ~PADCFG0_PREGFRXSEL;
677 value2 &= ~(PADCFG2_DEBEN | PADCFG2_DEBOUNCE_MASK);
679 if (debounce) {
680 unsigned long v;
682 v = order_base_2(debounce * 1000 / DEBOUNCE_PERIOD);
683 if (v < 3 || v > 15) {
684 ret = -EINVAL;
685 goto exit_unlock;
686 } else {
687 /* Enable glitch filter and debouncer */
688 value0 |= PADCFG0_PREGFRXSEL;
689 value2 |= v << PADCFG2_DEBOUNCE_SHIFT;
690 value2 |= PADCFG2_DEBEN;
694 writel(value0, padcfg0);
695 writel(value2, padcfg2);
697 exit_unlock:
698 raw_spin_unlock_irqrestore(&pctrl->lock, flags);
700 return ret;
703 static int intel_config_set(struct pinctrl_dev *pctldev, unsigned pin,
704 unsigned long *configs, unsigned nconfigs)
706 struct intel_pinctrl *pctrl = pinctrl_dev_get_drvdata(pctldev);
707 int i, ret;
709 if (!intel_pad_usable(pctrl, pin))
710 return -ENOTSUPP;
712 for (i = 0; i < nconfigs; i++) {
713 switch (pinconf_to_config_param(configs[i])) {
714 case PIN_CONFIG_BIAS_DISABLE:
715 case PIN_CONFIG_BIAS_PULL_UP:
716 case PIN_CONFIG_BIAS_PULL_DOWN:
717 ret = intel_config_set_pull(pctrl, pin, configs[i]);
718 if (ret)
719 return ret;
720 break;
722 case PIN_CONFIG_INPUT_DEBOUNCE:
723 ret = intel_config_set_debounce(pctrl, pin,
724 pinconf_to_config_argument(configs[i]));
725 if (ret)
726 return ret;
727 break;
729 default:
730 return -ENOTSUPP;
734 return 0;
737 static const struct pinconf_ops intel_pinconf_ops = {
738 .is_generic = true,
739 .pin_config_get = intel_config_get,
740 .pin_config_set = intel_config_set,
743 static const struct pinctrl_desc intel_pinctrl_desc = {
744 .pctlops = &intel_pinctrl_ops,
745 .pmxops = &intel_pinmux_ops,
746 .confops = &intel_pinconf_ops,
747 .owner = THIS_MODULE,
750 static int intel_gpio_get(struct gpio_chip *chip, unsigned offset)
752 struct intel_pinctrl *pctrl = gpiochip_get_data(chip);
753 void __iomem *reg;
754 u32 padcfg0;
756 reg = intel_get_padcfg(pctrl, offset, PADCFG0);
757 if (!reg)
758 return -EINVAL;
760 padcfg0 = readl(reg);
761 if (!(padcfg0 & PADCFG0_GPIOTXDIS))
762 return !!(padcfg0 & PADCFG0_GPIOTXSTATE);
764 return !!(padcfg0 & PADCFG0_GPIORXSTATE);
767 static void intel_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
769 struct intel_pinctrl *pctrl = gpiochip_get_data(chip);
770 unsigned long flags;
771 void __iomem *reg;
772 u32 padcfg0;
774 reg = intel_get_padcfg(pctrl, offset, PADCFG0);
775 if (!reg)
776 return;
778 raw_spin_lock_irqsave(&pctrl->lock, flags);
779 padcfg0 = readl(reg);
780 if (value)
781 padcfg0 |= PADCFG0_GPIOTXSTATE;
782 else
783 padcfg0 &= ~PADCFG0_GPIOTXSTATE;
784 writel(padcfg0, reg);
785 raw_spin_unlock_irqrestore(&pctrl->lock, flags);
788 static int intel_gpio_direction_input(struct gpio_chip *chip, unsigned offset)
790 return pinctrl_gpio_direction_input(chip->base + offset);
793 static int intel_gpio_direction_output(struct gpio_chip *chip, unsigned offset,
794 int value)
796 intel_gpio_set(chip, offset, value);
797 return pinctrl_gpio_direction_output(chip->base + offset);
800 static const struct gpio_chip intel_gpio_chip = {
801 .owner = THIS_MODULE,
802 .request = gpiochip_generic_request,
803 .free = gpiochip_generic_free,
804 .direction_input = intel_gpio_direction_input,
805 .direction_output = intel_gpio_direction_output,
806 .get = intel_gpio_get,
807 .set = intel_gpio_set,
808 .set_config = gpiochip_generic_config,
811 static void intel_gpio_irq_ack(struct irq_data *d)
813 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
814 struct intel_pinctrl *pctrl = gpiochip_get_data(gc);
815 const struct intel_community *community;
816 unsigned pin = irqd_to_hwirq(d);
818 community = intel_get_community(pctrl, pin);
819 if (community) {
820 const struct intel_padgroup *padgrp;
821 unsigned gpp, gpp_offset;
823 padgrp = intel_community_get_padgroup(community, pin);
824 if (!padgrp)
825 return;
827 gpp = padgrp->reg_num;
828 gpp_offset = padgroup_offset(padgrp, pin);
830 raw_spin_lock(&pctrl->lock);
831 writel(BIT(gpp_offset), community->regs + GPI_IS + gpp * 4);
832 raw_spin_unlock(&pctrl->lock);
836 static void intel_gpio_irq_enable(struct irq_data *d)
838 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
839 struct intel_pinctrl *pctrl = gpiochip_get_data(gc);
840 const struct intel_community *community;
841 unsigned pin = irqd_to_hwirq(d);
843 community = intel_get_community(pctrl, pin);
844 if (community) {
845 const struct intel_padgroup *padgrp;
846 unsigned gpp, gpp_offset;
847 unsigned long flags;
848 u32 value;
850 padgrp = intel_community_get_padgroup(community, pin);
851 if (!padgrp)
852 return;
854 gpp = padgrp->reg_num;
855 gpp_offset = padgroup_offset(padgrp, pin);
857 raw_spin_lock_irqsave(&pctrl->lock, flags);
858 /* Clear interrupt status first to avoid unexpected interrupt */
859 writel(BIT(gpp_offset), community->regs + GPI_IS + gpp * 4);
861 value = readl(community->regs + community->ie_offset + gpp * 4);
862 value |= BIT(gpp_offset);
863 writel(value, community->regs + community->ie_offset + gpp * 4);
864 raw_spin_unlock_irqrestore(&pctrl->lock, flags);
868 static void intel_gpio_irq_mask_unmask(struct irq_data *d, bool mask)
870 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
871 struct intel_pinctrl *pctrl = gpiochip_get_data(gc);
872 const struct intel_community *community;
873 unsigned pin = irqd_to_hwirq(d);
875 community = intel_get_community(pctrl, pin);
876 if (community) {
877 const struct intel_padgroup *padgrp;
878 unsigned gpp, gpp_offset;
879 unsigned long flags;
880 void __iomem *reg;
881 u32 value;
883 padgrp = intel_community_get_padgroup(community, pin);
884 if (!padgrp)
885 return;
887 gpp = padgrp->reg_num;
888 gpp_offset = padgroup_offset(padgrp, pin);
890 reg = community->regs + community->ie_offset + gpp * 4;
892 raw_spin_lock_irqsave(&pctrl->lock, flags);
893 value = readl(reg);
894 if (mask)
895 value &= ~BIT(gpp_offset);
896 else
897 value |= BIT(gpp_offset);
898 writel(value, reg);
899 raw_spin_unlock_irqrestore(&pctrl->lock, flags);
903 static void intel_gpio_irq_mask(struct irq_data *d)
905 intel_gpio_irq_mask_unmask(d, true);
908 static void intel_gpio_irq_unmask(struct irq_data *d)
910 intel_gpio_irq_mask_unmask(d, false);
913 static int intel_gpio_irq_type(struct irq_data *d, unsigned type)
915 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
916 struct intel_pinctrl *pctrl = gpiochip_get_data(gc);
917 unsigned pin = irqd_to_hwirq(d);
918 unsigned long flags;
919 void __iomem *reg;
920 u32 value;
922 reg = intel_get_padcfg(pctrl, pin, PADCFG0);
923 if (!reg)
924 return -EINVAL;
927 * If the pin is in ACPI mode it is still usable as a GPIO but it
928 * cannot be used as IRQ because GPI_IS status bit will not be
929 * updated by the host controller hardware.
931 if (intel_pad_acpi_mode(pctrl, pin)) {
932 dev_warn(pctrl->dev, "pin %u cannot be used as IRQ\n", pin);
933 return -EPERM;
936 raw_spin_lock_irqsave(&pctrl->lock, flags);
938 value = readl(reg);
940 value &= ~(PADCFG0_RXEVCFG_MASK | PADCFG0_RXINV);
942 if ((type & IRQ_TYPE_EDGE_BOTH) == IRQ_TYPE_EDGE_BOTH) {
943 value |= PADCFG0_RXEVCFG_EDGE_BOTH << PADCFG0_RXEVCFG_SHIFT;
944 } else if (type & IRQ_TYPE_EDGE_FALLING) {
945 value |= PADCFG0_RXEVCFG_EDGE << PADCFG0_RXEVCFG_SHIFT;
946 value |= PADCFG0_RXINV;
947 } else if (type & IRQ_TYPE_EDGE_RISING) {
948 value |= PADCFG0_RXEVCFG_EDGE << PADCFG0_RXEVCFG_SHIFT;
949 } else if (type & IRQ_TYPE_LEVEL_MASK) {
950 if (type & IRQ_TYPE_LEVEL_LOW)
951 value |= PADCFG0_RXINV;
952 } else {
953 value |= PADCFG0_RXEVCFG_DISABLED << PADCFG0_RXEVCFG_SHIFT;
956 writel(value, reg);
958 if (type & IRQ_TYPE_EDGE_BOTH)
959 irq_set_handler_locked(d, handle_edge_irq);
960 else if (type & IRQ_TYPE_LEVEL_MASK)
961 irq_set_handler_locked(d, handle_level_irq);
963 raw_spin_unlock_irqrestore(&pctrl->lock, flags);
965 return 0;
968 static int intel_gpio_irq_wake(struct irq_data *d, unsigned int on)
970 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
971 struct intel_pinctrl *pctrl = gpiochip_get_data(gc);
972 unsigned pin = irqd_to_hwirq(d);
974 if (on)
975 enable_irq_wake(pctrl->irq);
976 else
977 disable_irq_wake(pctrl->irq);
979 dev_dbg(pctrl->dev, "%sable wake for pin %u\n", on ? "en" : "dis", pin);
980 return 0;
983 static irqreturn_t intel_gpio_community_irq_handler(struct intel_pinctrl *pctrl,
984 const struct intel_community *community)
986 struct gpio_chip *gc = &pctrl->chip;
987 irqreturn_t ret = IRQ_NONE;
988 int gpp;
990 for (gpp = 0; gpp < community->ngpps; gpp++) {
991 const struct intel_padgroup *padgrp = &community->gpps[gpp];
992 unsigned long pending, enabled, gpp_offset;
994 pending = readl(community->regs + GPI_IS + padgrp->reg_num * 4);
995 enabled = readl(community->regs + community->ie_offset +
996 padgrp->reg_num * 4);
998 /* Only interrupts that are enabled */
999 pending &= enabled;
1001 for_each_set_bit(gpp_offset, &pending, padgrp->size) {
1002 unsigned padno, irq;
1004 padno = padgrp->base - community->pin_base + gpp_offset;
1005 if (padno >= community->npins)
1006 break;
1008 irq = irq_find_mapping(gc->irqdomain,
1009 community->pin_base + padno);
1010 generic_handle_irq(irq);
1012 ret |= IRQ_HANDLED;
1016 return ret;
1019 static irqreturn_t intel_gpio_irq(int irq, void *data)
1021 const struct intel_community *community;
1022 struct intel_pinctrl *pctrl = data;
1023 irqreturn_t ret = IRQ_NONE;
1024 int i;
1026 /* Need to check all communities for pending interrupts */
1027 for (i = 0; i < pctrl->ncommunities; i++) {
1028 community = &pctrl->communities[i];
1029 ret |= intel_gpio_community_irq_handler(pctrl, community);
1032 return ret;
1035 static struct irq_chip intel_gpio_irqchip = {
1036 .name = "intel-gpio",
1037 .irq_enable = intel_gpio_irq_enable,
1038 .irq_ack = intel_gpio_irq_ack,
1039 .irq_mask = intel_gpio_irq_mask,
1040 .irq_unmask = intel_gpio_irq_unmask,
1041 .irq_set_type = intel_gpio_irq_type,
1042 .irq_set_wake = intel_gpio_irq_wake,
1043 .flags = IRQCHIP_MASK_ON_SUSPEND,
1046 static int intel_gpio_probe(struct intel_pinctrl *pctrl, int irq)
1048 int ret;
1050 pctrl->chip = intel_gpio_chip;
1052 pctrl->chip.ngpio = pctrl->soc->npins;
1053 pctrl->chip.label = dev_name(pctrl->dev);
1054 pctrl->chip.parent = pctrl->dev;
1055 pctrl->chip.base = -1;
1056 pctrl->irq = irq;
1058 ret = devm_gpiochip_add_data(pctrl->dev, &pctrl->chip, pctrl);
1059 if (ret) {
1060 dev_err(pctrl->dev, "failed to register gpiochip\n");
1061 return ret;
1064 ret = gpiochip_add_pin_range(&pctrl->chip, dev_name(pctrl->dev),
1065 0, 0, pctrl->soc->npins);
1066 if (ret) {
1067 dev_err(pctrl->dev, "failed to add GPIO pin range\n");
1068 return ret;
1072 * We need to request the interrupt here (instead of providing chip
1073 * to the irq directly) because on some platforms several GPIO
1074 * controllers share the same interrupt line.
1076 ret = devm_request_irq(pctrl->dev, irq, intel_gpio_irq,
1077 IRQF_SHARED | IRQF_NO_THREAD,
1078 dev_name(pctrl->dev), pctrl);
1079 if (ret) {
1080 dev_err(pctrl->dev, "failed to request interrupt\n");
1081 return ret;
1084 ret = gpiochip_irqchip_add(&pctrl->chip, &intel_gpio_irqchip, 0,
1085 handle_bad_irq, IRQ_TYPE_NONE);
1086 if (ret) {
1087 dev_err(pctrl->dev, "failed to add irqchip\n");
1088 return ret;
1091 gpiochip_set_chained_irqchip(&pctrl->chip, &intel_gpio_irqchip, irq,
1092 NULL);
1093 return 0;
1096 static int intel_pinctrl_add_padgroups(struct intel_pinctrl *pctrl,
1097 struct intel_community *community)
1099 struct intel_padgroup *gpps;
1100 unsigned npins = community->npins;
1101 unsigned padown_num = 0;
1102 size_t ngpps, i;
1104 if (community->gpps)
1105 ngpps = community->ngpps;
1106 else
1107 ngpps = DIV_ROUND_UP(community->npins, community->gpp_size);
1109 gpps = devm_kcalloc(pctrl->dev, ngpps, sizeof(*gpps), GFP_KERNEL);
1110 if (!gpps)
1111 return -ENOMEM;
1113 for (i = 0; i < ngpps; i++) {
1114 if (community->gpps) {
1115 gpps[i] = community->gpps[i];
1116 } else {
1117 unsigned gpp_size = community->gpp_size;
1119 gpps[i].reg_num = i;
1120 gpps[i].base = community->pin_base + i * gpp_size;
1121 gpps[i].size = min(gpp_size, npins);
1122 npins -= gpps[i].size;
1125 if (gpps[i].size > 32)
1126 return -EINVAL;
1128 gpps[i].padown_num = padown_num;
1131 * In older hardware the number of padown registers per
1132 * group is fixed regardless of the group size.
1134 if (community->gpp_num_padown_regs)
1135 padown_num += community->gpp_num_padown_regs;
1136 else
1137 padown_num += DIV_ROUND_UP(gpps[i].size * 4, 32);
1140 community->ngpps = ngpps;
1141 community->gpps = gpps;
1143 return 0;
1146 static int intel_pinctrl_pm_init(struct intel_pinctrl *pctrl)
1148 #ifdef CONFIG_PM_SLEEP
1149 const struct intel_pinctrl_soc_data *soc = pctrl->soc;
1150 struct intel_community_context *communities;
1151 struct intel_pad_context *pads;
1152 int i;
1154 pads = devm_kcalloc(pctrl->dev, soc->npins, sizeof(*pads), GFP_KERNEL);
1155 if (!pads)
1156 return -ENOMEM;
1158 communities = devm_kcalloc(pctrl->dev, pctrl->ncommunities,
1159 sizeof(*communities), GFP_KERNEL);
1160 if (!communities)
1161 return -ENOMEM;
1164 for (i = 0; i < pctrl->ncommunities; i++) {
1165 struct intel_community *community = &pctrl->communities[i];
1166 u32 *intmask;
1168 intmask = devm_kcalloc(pctrl->dev, community->ngpps,
1169 sizeof(*intmask), GFP_KERNEL);
1170 if (!intmask)
1171 return -ENOMEM;
1173 communities[i].intmask = intmask;
1176 pctrl->context.pads = pads;
1177 pctrl->context.communities = communities;
1178 #endif
1180 return 0;
1183 int intel_pinctrl_probe(struct platform_device *pdev,
1184 const struct intel_pinctrl_soc_data *soc_data)
1186 struct intel_pinctrl *pctrl;
1187 int i, ret, irq;
1189 if (!soc_data)
1190 return -EINVAL;
1192 pctrl = devm_kzalloc(&pdev->dev, sizeof(*pctrl), GFP_KERNEL);
1193 if (!pctrl)
1194 return -ENOMEM;
1196 pctrl->dev = &pdev->dev;
1197 pctrl->soc = soc_data;
1198 raw_spin_lock_init(&pctrl->lock);
1201 * Make a copy of the communities which we can use to hold pointers
1202 * to the registers.
1204 pctrl->ncommunities = pctrl->soc->ncommunities;
1205 pctrl->communities = devm_kcalloc(&pdev->dev, pctrl->ncommunities,
1206 sizeof(*pctrl->communities), GFP_KERNEL);
1207 if (!pctrl->communities)
1208 return -ENOMEM;
1210 for (i = 0; i < pctrl->ncommunities; i++) {
1211 struct intel_community *community = &pctrl->communities[i];
1212 struct resource *res;
1213 void __iomem *regs;
1214 u32 padbar;
1216 *community = pctrl->soc->communities[i];
1218 res = platform_get_resource(pdev, IORESOURCE_MEM,
1219 community->barno);
1220 regs = devm_ioremap_resource(&pdev->dev, res);
1221 if (IS_ERR(regs))
1222 return PTR_ERR(regs);
1225 * Determine community features based on the revision if
1226 * not specified already.
1228 if (!community->features) {
1229 u32 rev;
1231 rev = (readl(regs + REVID) & REVID_MASK) >> REVID_SHIFT;
1232 if (rev >= 0x94) {
1233 community->features |= PINCTRL_FEATURE_DEBOUNCE;
1234 community->features |= PINCTRL_FEATURE_1K_PD;
1238 /* Read offset of the pad configuration registers */
1239 padbar = readl(regs + PADBAR);
1241 community->regs = regs;
1242 community->pad_regs = regs + padbar;
1244 ret = intel_pinctrl_add_padgroups(pctrl, community);
1245 if (ret)
1246 return ret;
1249 irq = platform_get_irq(pdev, 0);
1250 if (irq < 0) {
1251 dev_err(&pdev->dev, "failed to get interrupt number\n");
1252 return irq;
1255 ret = intel_pinctrl_pm_init(pctrl);
1256 if (ret)
1257 return ret;
1259 pctrl->pctldesc = intel_pinctrl_desc;
1260 pctrl->pctldesc.name = dev_name(&pdev->dev);
1261 pctrl->pctldesc.pins = pctrl->soc->pins;
1262 pctrl->pctldesc.npins = pctrl->soc->npins;
1264 pctrl->pctldev = devm_pinctrl_register(&pdev->dev, &pctrl->pctldesc,
1265 pctrl);
1266 if (IS_ERR(pctrl->pctldev)) {
1267 dev_err(&pdev->dev, "failed to register pinctrl driver\n");
1268 return PTR_ERR(pctrl->pctldev);
1271 ret = intel_gpio_probe(pctrl, irq);
1272 if (ret)
1273 return ret;
1275 platform_set_drvdata(pdev, pctrl);
1277 return 0;
1279 EXPORT_SYMBOL_GPL(intel_pinctrl_probe);
1281 #ifdef CONFIG_PM_SLEEP
1282 static bool intel_pinctrl_should_save(struct intel_pinctrl *pctrl, unsigned pin)
1284 const struct pin_desc *pd = pin_desc_get(pctrl->pctldev, pin);
1286 if (!pd || !intel_pad_usable(pctrl, pin))
1287 return false;
1290 * Only restore the pin if it is actually in use by the kernel (or
1291 * by userspace). It is possible that some pins are used by the
1292 * BIOS during resume and those are not always locked down so leave
1293 * them alone.
1295 if (pd->mux_owner || pd->gpio_owner ||
1296 gpiochip_line_is_irq(&pctrl->chip, pin))
1297 return true;
1299 return false;
1302 int intel_pinctrl_suspend(struct device *dev)
1304 struct platform_device *pdev = to_platform_device(dev);
1305 struct intel_pinctrl *pctrl = platform_get_drvdata(pdev);
1306 struct intel_community_context *communities;
1307 struct intel_pad_context *pads;
1308 int i;
1310 pads = pctrl->context.pads;
1311 for (i = 0; i < pctrl->soc->npins; i++) {
1312 const struct pinctrl_pin_desc *desc = &pctrl->soc->pins[i];
1313 void __iomem *padcfg;
1314 u32 val;
1316 if (!intel_pinctrl_should_save(pctrl, desc->number))
1317 continue;
1319 val = readl(intel_get_padcfg(pctrl, desc->number, PADCFG0));
1320 pads[i].padcfg0 = val & ~PADCFG0_GPIORXSTATE;
1321 val = readl(intel_get_padcfg(pctrl, desc->number, PADCFG1));
1322 pads[i].padcfg1 = val;
1324 padcfg = intel_get_padcfg(pctrl, desc->number, PADCFG2);
1325 if (padcfg)
1326 pads[i].padcfg2 = readl(padcfg);
1329 communities = pctrl->context.communities;
1330 for (i = 0; i < pctrl->ncommunities; i++) {
1331 struct intel_community *community = &pctrl->communities[i];
1332 void __iomem *base;
1333 unsigned gpp;
1335 base = community->regs + community->ie_offset;
1336 for (gpp = 0; gpp < community->ngpps; gpp++)
1337 communities[i].intmask[gpp] = readl(base + gpp * 4);
1340 return 0;
1342 EXPORT_SYMBOL_GPL(intel_pinctrl_suspend);
1344 static void intel_gpio_irq_init(struct intel_pinctrl *pctrl)
1346 size_t i;
1348 for (i = 0; i < pctrl->ncommunities; i++) {
1349 const struct intel_community *community;
1350 void __iomem *base;
1351 unsigned gpp;
1353 community = &pctrl->communities[i];
1354 base = community->regs;
1356 for (gpp = 0; gpp < community->ngpps; gpp++) {
1357 /* Mask and clear all interrupts */
1358 writel(0, base + community->ie_offset + gpp * 4);
1359 writel(0xffff, base + GPI_IS + gpp * 4);
1364 int intel_pinctrl_resume(struct device *dev)
1366 struct platform_device *pdev = to_platform_device(dev);
1367 struct intel_pinctrl *pctrl = platform_get_drvdata(pdev);
1368 const struct intel_community_context *communities;
1369 const struct intel_pad_context *pads;
1370 int i;
1372 /* Mask all interrupts */
1373 intel_gpio_irq_init(pctrl);
1375 pads = pctrl->context.pads;
1376 for (i = 0; i < pctrl->soc->npins; i++) {
1377 const struct pinctrl_pin_desc *desc = &pctrl->soc->pins[i];
1378 void __iomem *padcfg;
1379 u32 val;
1381 if (!intel_pinctrl_should_save(pctrl, desc->number))
1382 continue;
1384 padcfg = intel_get_padcfg(pctrl, desc->number, PADCFG0);
1385 val = readl(padcfg) & ~PADCFG0_GPIORXSTATE;
1386 if (val != pads[i].padcfg0) {
1387 writel(pads[i].padcfg0, padcfg);
1388 dev_dbg(dev, "restored pin %u padcfg0 %#08x\n",
1389 desc->number, readl(padcfg));
1392 padcfg = intel_get_padcfg(pctrl, desc->number, PADCFG1);
1393 val = readl(padcfg);
1394 if (val != pads[i].padcfg1) {
1395 writel(pads[i].padcfg1, padcfg);
1396 dev_dbg(dev, "restored pin %u padcfg1 %#08x\n",
1397 desc->number, readl(padcfg));
1400 padcfg = intel_get_padcfg(pctrl, desc->number, PADCFG2);
1401 if (padcfg) {
1402 val = readl(padcfg);
1403 if (val != pads[i].padcfg2) {
1404 writel(pads[i].padcfg2, padcfg);
1405 dev_dbg(dev, "restored pin %u padcfg2 %#08x\n",
1406 desc->number, readl(padcfg));
1411 communities = pctrl->context.communities;
1412 for (i = 0; i < pctrl->ncommunities; i++) {
1413 struct intel_community *community = &pctrl->communities[i];
1414 void __iomem *base;
1415 unsigned gpp;
1417 base = community->regs + community->ie_offset;
1418 for (gpp = 0; gpp < community->ngpps; gpp++) {
1419 writel(communities[i].intmask[gpp], base + gpp * 4);
1420 dev_dbg(dev, "restored mask %d/%u %#08x\n", i, gpp,
1421 readl(base + gpp * 4));
1425 return 0;
1427 EXPORT_SYMBOL_GPL(intel_pinctrl_resume);
1428 #endif
1430 MODULE_AUTHOR("Mathias Nyman <mathias.nyman@linux.intel.com>");
1431 MODULE_AUTHOR("Mika Westerberg <mika.westerberg@linux.intel.com>");
1432 MODULE_DESCRIPTION("Intel pinctrl/GPIO core driver");
1433 MODULE_LICENSE("GPL v2");