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>
24 #include "pinctrl-intel.h"
26 /* Offset from regs */
28 #define REVID_SHIFT 16
29 #define REVID_MASK GENMASK(31, 16)
35 #define PADOWN_SHIFT(p) ((p) % 8 * PADOWN_BITS)
36 #define PADOWN_MASK(p) (0xf << PADOWN_SHIFT(p))
37 #define PADOWN_GPP(p) ((p) / 8)
39 /* Offset from pad_regs */
41 #define PADCFG0_RXEVCFG_SHIFT 25
42 #define PADCFG0_RXEVCFG_MASK (3 << PADCFG0_RXEVCFG_SHIFT)
43 #define PADCFG0_RXEVCFG_LEVEL 0
44 #define PADCFG0_RXEVCFG_EDGE 1
45 #define PADCFG0_RXEVCFG_DISABLED 2
46 #define PADCFG0_RXEVCFG_EDGE_BOTH 3
47 #define PADCFG0_PREGFRXSEL BIT(24)
48 #define PADCFG0_RXINV BIT(23)
49 #define PADCFG0_GPIROUTIOXAPIC BIT(20)
50 #define PADCFG0_GPIROUTSCI BIT(19)
51 #define PADCFG0_GPIROUTSMI BIT(18)
52 #define PADCFG0_GPIROUTNMI BIT(17)
53 #define PADCFG0_PMODE_SHIFT 10
54 #define PADCFG0_PMODE_MASK (0xf << PADCFG0_PMODE_SHIFT)
55 #define PADCFG0_GPIORXDIS BIT(9)
56 #define PADCFG0_GPIOTXDIS BIT(8)
57 #define PADCFG0_GPIORXSTATE BIT(1)
58 #define PADCFG0_GPIOTXSTATE BIT(0)
61 #define PADCFG1_TERM_UP BIT(13)
62 #define PADCFG1_TERM_SHIFT 10
63 #define PADCFG1_TERM_MASK (7 << PADCFG1_TERM_SHIFT)
64 #define PADCFG1_TERM_20K 4
65 #define PADCFG1_TERM_2K 3
66 #define PADCFG1_TERM_5K 2
67 #define PADCFG1_TERM_1K 1
70 #define PADCFG2_DEBEN BIT(0)
71 #define PADCFG2_DEBOUNCE_SHIFT 1
72 #define PADCFG2_DEBOUNCE_MASK GENMASK(4, 1)
74 #define DEBOUNCE_PERIOD 31250 /* ns */
76 struct intel_pad_context
{
82 struct intel_community_context
{
86 struct intel_pinctrl_context
{
87 struct intel_pad_context
*pads
;
88 struct intel_community_context
*communities
;
92 * struct intel_pinctrl - Intel pinctrl private structure
93 * @dev: Pointer to the device structure
94 * @lock: Lock to serialize register access
95 * @pctldesc: Pin controller description
96 * @pctldev: Pointer to the pin controller device
97 * @chip: GPIO chip in this pin controller
98 * @soc: SoC/PCH specific pin configuration data
99 * @communities: All communities in this pin controller
100 * @ncommunities: Number of communities in this pin controller
101 * @context: Configuration saved over system sleep
102 * @irq: pinctrl/GPIO chip irq number
104 struct intel_pinctrl
{
107 struct pinctrl_desc pctldesc
;
108 struct pinctrl_dev
*pctldev
;
109 struct gpio_chip chip
;
110 const struct intel_pinctrl_soc_data
*soc
;
111 struct intel_community
*communities
;
113 struct intel_pinctrl_context context
;
117 #define pin_to_padno(c, p) ((p) - (c)->pin_base)
118 #define padgroup_offset(g, p) ((p) - (g)->base)
120 static struct intel_community
*intel_get_community(struct intel_pinctrl
*pctrl
,
123 struct intel_community
*community
;
126 for (i
= 0; i
< pctrl
->ncommunities
; i
++) {
127 community
= &pctrl
->communities
[i
];
128 if (pin
>= community
->pin_base
&&
129 pin
< community
->pin_base
+ community
->npins
)
133 dev_warn(pctrl
->dev
, "failed to find community for pin %u\n", pin
);
137 static const struct intel_padgroup
*
138 intel_community_get_padgroup(const struct intel_community
*community
,
143 for (i
= 0; i
< community
->ngpps
; i
++) {
144 const struct intel_padgroup
*padgrp
= &community
->gpps
[i
];
146 if (pin
>= padgrp
->base
&& pin
< padgrp
->base
+ padgrp
->size
)
153 static void __iomem
*intel_get_padcfg(struct intel_pinctrl
*pctrl
, unsigned pin
,
156 const struct intel_community
*community
;
160 community
= intel_get_community(pctrl
, pin
);
164 padno
= pin_to_padno(community
, pin
);
165 nregs
= (community
->features
& PINCTRL_FEATURE_DEBOUNCE
) ? 4 : 2;
167 if (reg
== PADCFG2
&& !(community
->features
& PINCTRL_FEATURE_DEBOUNCE
))
170 return community
->pad_regs
+ reg
+ padno
* nregs
* 4;
173 static bool intel_pad_owned_by_host(struct intel_pinctrl
*pctrl
, unsigned pin
)
175 const struct intel_community
*community
;
176 const struct intel_padgroup
*padgrp
;
177 unsigned gpp
, offset
, gpp_offset
;
178 void __iomem
*padown
;
180 community
= intel_get_community(pctrl
, pin
);
183 if (!community
->padown_offset
)
186 padgrp
= intel_community_get_padgroup(community
, pin
);
190 gpp_offset
= padgroup_offset(padgrp
, pin
);
191 gpp
= PADOWN_GPP(gpp_offset
);
192 offset
= community
->padown_offset
+ padgrp
->padown_num
* 4 + gpp
* 4;
193 padown
= community
->regs
+ offset
;
195 return !(readl(padown
) & PADOWN_MASK(gpp_offset
));
198 static bool intel_pad_acpi_mode(struct intel_pinctrl
*pctrl
, unsigned pin
)
200 const struct intel_community
*community
;
201 const struct intel_padgroup
*padgrp
;
202 unsigned offset
, gpp_offset
;
203 void __iomem
*hostown
;
205 community
= intel_get_community(pctrl
, pin
);
208 if (!community
->hostown_offset
)
211 padgrp
= intel_community_get_padgroup(community
, pin
);
215 gpp_offset
= padgroup_offset(padgrp
, pin
);
216 offset
= community
->hostown_offset
+ padgrp
->reg_num
* 4;
217 hostown
= community
->regs
+ offset
;
219 return !(readl(hostown
) & BIT(gpp_offset
));
222 static bool intel_pad_locked(struct intel_pinctrl
*pctrl
, unsigned pin
)
224 struct intel_community
*community
;
225 const struct intel_padgroup
*padgrp
;
226 unsigned offset
, gpp_offset
;
229 community
= intel_get_community(pctrl
, pin
);
232 if (!community
->padcfglock_offset
)
235 padgrp
= intel_community_get_padgroup(community
, pin
);
239 gpp_offset
= padgroup_offset(padgrp
, pin
);
242 * If PADCFGLOCK and PADCFGLOCKTX bits are both clear for this pad,
243 * the pad is considered unlocked. Any other case means that it is
244 * either fully or partially locked and we don't touch it.
246 offset
= community
->padcfglock_offset
+ padgrp
->reg_num
* 8;
247 value
= readl(community
->regs
+ offset
);
248 if (value
& BIT(gpp_offset
))
251 offset
= community
->padcfglock_offset
+ 4 + padgrp
->reg_num
* 8;
252 value
= readl(community
->regs
+ offset
);
253 if (value
& BIT(gpp_offset
))
259 static bool intel_pad_usable(struct intel_pinctrl
*pctrl
, unsigned pin
)
261 return intel_pad_owned_by_host(pctrl
, pin
) &&
262 !intel_pad_locked(pctrl
, pin
);
265 static int intel_get_groups_count(struct pinctrl_dev
*pctldev
)
267 struct intel_pinctrl
*pctrl
= pinctrl_dev_get_drvdata(pctldev
);
269 return pctrl
->soc
->ngroups
;
272 static const char *intel_get_group_name(struct pinctrl_dev
*pctldev
,
275 struct intel_pinctrl
*pctrl
= pinctrl_dev_get_drvdata(pctldev
);
277 return pctrl
->soc
->groups
[group
].name
;
280 static int intel_get_group_pins(struct pinctrl_dev
*pctldev
, unsigned group
,
281 const unsigned **pins
, unsigned *npins
)
283 struct intel_pinctrl
*pctrl
= pinctrl_dev_get_drvdata(pctldev
);
285 *pins
= pctrl
->soc
->groups
[group
].pins
;
286 *npins
= pctrl
->soc
->groups
[group
].npins
;
290 static void intel_pin_dbg_show(struct pinctrl_dev
*pctldev
, struct seq_file
*s
,
293 struct intel_pinctrl
*pctrl
= pinctrl_dev_get_drvdata(pctldev
);
294 void __iomem
*padcfg
;
295 u32 cfg0
, cfg1
, mode
;
298 if (!intel_pad_owned_by_host(pctrl
, pin
)) {
299 seq_puts(s
, "not available");
303 cfg0
= readl(intel_get_padcfg(pctrl
, pin
, PADCFG0
));
304 cfg1
= readl(intel_get_padcfg(pctrl
, pin
, PADCFG1
));
306 mode
= (cfg0
& PADCFG0_PMODE_MASK
) >> PADCFG0_PMODE_SHIFT
;
308 seq_puts(s
, "GPIO ");
310 seq_printf(s
, "mode %d ", mode
);
312 seq_printf(s
, "0x%08x 0x%08x", cfg0
, cfg1
);
314 /* Dump the additional PADCFG registers if available */
315 padcfg
= intel_get_padcfg(pctrl
, pin
, PADCFG2
);
317 seq_printf(s
, " 0x%08x", readl(padcfg
));
319 locked
= intel_pad_locked(pctrl
, pin
);
320 acpi
= intel_pad_acpi_mode(pctrl
, pin
);
322 if (locked
|| acpi
) {
325 seq_puts(s
, "LOCKED");
335 static const struct pinctrl_ops intel_pinctrl_ops
= {
336 .get_groups_count
= intel_get_groups_count
,
337 .get_group_name
= intel_get_group_name
,
338 .get_group_pins
= intel_get_group_pins
,
339 .pin_dbg_show
= intel_pin_dbg_show
,
342 static int intel_get_functions_count(struct pinctrl_dev
*pctldev
)
344 struct intel_pinctrl
*pctrl
= pinctrl_dev_get_drvdata(pctldev
);
346 return pctrl
->soc
->nfunctions
;
349 static const char *intel_get_function_name(struct pinctrl_dev
*pctldev
,
352 struct intel_pinctrl
*pctrl
= pinctrl_dev_get_drvdata(pctldev
);
354 return pctrl
->soc
->functions
[function
].name
;
357 static int intel_get_function_groups(struct pinctrl_dev
*pctldev
,
359 const char * const **groups
,
360 unsigned * const ngroups
)
362 struct intel_pinctrl
*pctrl
= pinctrl_dev_get_drvdata(pctldev
);
364 *groups
= pctrl
->soc
->functions
[function
].groups
;
365 *ngroups
= pctrl
->soc
->functions
[function
].ngroups
;
369 static int intel_pinmux_set_mux(struct pinctrl_dev
*pctldev
, unsigned function
,
372 struct intel_pinctrl
*pctrl
= pinctrl_dev_get_drvdata(pctldev
);
373 const struct intel_pingroup
*grp
= &pctrl
->soc
->groups
[group
];
377 raw_spin_lock_irqsave(&pctrl
->lock
, flags
);
380 * All pins in the groups needs to be accessible and writable
381 * before we can enable the mux for this group.
383 for (i
= 0; i
< grp
->npins
; i
++) {
384 if (!intel_pad_usable(pctrl
, grp
->pins
[i
])) {
385 raw_spin_unlock_irqrestore(&pctrl
->lock
, flags
);
390 /* Now enable the mux setting for each pin in the group */
391 for (i
= 0; i
< grp
->npins
; i
++) {
392 void __iomem
*padcfg0
;
395 padcfg0
= intel_get_padcfg(pctrl
, grp
->pins
[i
], PADCFG0
);
396 value
= readl(padcfg0
);
398 value
&= ~PADCFG0_PMODE_MASK
;
401 value
|= grp
->modes
[i
] << PADCFG0_PMODE_SHIFT
;
403 value
|= grp
->mode
<< PADCFG0_PMODE_SHIFT
;
405 writel(value
, padcfg0
);
408 raw_spin_unlock_irqrestore(&pctrl
->lock
, flags
);
413 static void __intel_gpio_set_direction(void __iomem
*padcfg0
, bool input
)
417 value
= readl(padcfg0
);
419 value
&= ~PADCFG0_GPIORXDIS
;
420 value
|= PADCFG0_GPIOTXDIS
;
422 value
&= ~PADCFG0_GPIOTXDIS
;
423 value
|= PADCFG0_GPIORXDIS
;
425 writel(value
, padcfg0
);
428 static int intel_gpio_request_enable(struct pinctrl_dev
*pctldev
,
429 struct pinctrl_gpio_range
*range
,
432 struct intel_pinctrl
*pctrl
= pinctrl_dev_get_drvdata(pctldev
);
433 void __iomem
*padcfg0
;
437 raw_spin_lock_irqsave(&pctrl
->lock
, flags
);
439 if (!intel_pad_usable(pctrl
, pin
)) {
440 raw_spin_unlock_irqrestore(&pctrl
->lock
, flags
);
444 padcfg0
= intel_get_padcfg(pctrl
, pin
, PADCFG0
);
445 /* Put the pad into GPIO mode */
446 value
= readl(padcfg0
) & ~PADCFG0_PMODE_MASK
;
447 /* Disable SCI/SMI/NMI generation */
448 value
&= ~(PADCFG0_GPIROUTIOXAPIC
| PADCFG0_GPIROUTSCI
);
449 value
&= ~(PADCFG0_GPIROUTSMI
| PADCFG0_GPIROUTNMI
);
450 writel(value
, padcfg0
);
452 /* Disable TX buffer and enable RX (this will be input) */
453 __intel_gpio_set_direction(padcfg0
, true);
455 raw_spin_unlock_irqrestore(&pctrl
->lock
, flags
);
460 static int intel_gpio_set_direction(struct pinctrl_dev
*pctldev
,
461 struct pinctrl_gpio_range
*range
,
462 unsigned pin
, bool input
)
464 struct intel_pinctrl
*pctrl
= pinctrl_dev_get_drvdata(pctldev
);
465 void __iomem
*padcfg0
;
468 raw_spin_lock_irqsave(&pctrl
->lock
, flags
);
470 padcfg0
= intel_get_padcfg(pctrl
, pin
, PADCFG0
);
471 __intel_gpio_set_direction(padcfg0
, input
);
473 raw_spin_unlock_irqrestore(&pctrl
->lock
, flags
);
478 static const struct pinmux_ops intel_pinmux_ops
= {
479 .get_functions_count
= intel_get_functions_count
,
480 .get_function_name
= intel_get_function_name
,
481 .get_function_groups
= intel_get_function_groups
,
482 .set_mux
= intel_pinmux_set_mux
,
483 .gpio_request_enable
= intel_gpio_request_enable
,
484 .gpio_set_direction
= intel_gpio_set_direction
,
487 static int intel_config_get(struct pinctrl_dev
*pctldev
, unsigned pin
,
488 unsigned long *config
)
490 struct intel_pinctrl
*pctrl
= pinctrl_dev_get_drvdata(pctldev
);
491 enum pin_config_param param
= pinconf_to_config_param(*config
);
492 const struct intel_community
*community
;
496 if (!intel_pad_owned_by_host(pctrl
, pin
))
499 community
= intel_get_community(pctrl
, pin
);
500 value
= readl(intel_get_padcfg(pctrl
, pin
, PADCFG1
));
501 term
= (value
& PADCFG1_TERM_MASK
) >> PADCFG1_TERM_SHIFT
;
504 case PIN_CONFIG_BIAS_DISABLE
:
509 case PIN_CONFIG_BIAS_PULL_UP
:
510 if (!term
|| !(value
& PADCFG1_TERM_UP
))
514 case PADCFG1_TERM_1K
:
517 case PADCFG1_TERM_2K
:
520 case PADCFG1_TERM_5K
:
523 case PADCFG1_TERM_20K
:
530 case PIN_CONFIG_BIAS_PULL_DOWN
:
531 if (!term
|| value
& PADCFG1_TERM_UP
)
535 case PADCFG1_TERM_1K
:
536 if (!(community
->features
& PINCTRL_FEATURE_1K_PD
))
540 case PADCFG1_TERM_5K
:
543 case PADCFG1_TERM_20K
:
550 case PIN_CONFIG_INPUT_DEBOUNCE
: {
551 void __iomem
*padcfg2
;
554 padcfg2
= intel_get_padcfg(pctrl
, pin
, PADCFG2
);
559 if (!(v
& PADCFG2_DEBEN
))
562 v
= (v
& PADCFG2_DEBOUNCE_MASK
) >> PADCFG2_DEBOUNCE_SHIFT
;
563 arg
= BIT(v
) * DEBOUNCE_PERIOD
/ 1000;
572 *config
= pinconf_to_config_packed(param
, arg
);
576 static int intel_config_set_pull(struct intel_pinctrl
*pctrl
, unsigned pin
,
577 unsigned long config
)
579 unsigned param
= pinconf_to_config_param(config
);
580 unsigned arg
= pinconf_to_config_argument(config
);
581 const struct intel_community
*community
;
582 void __iomem
*padcfg1
;
587 raw_spin_lock_irqsave(&pctrl
->lock
, flags
);
589 community
= intel_get_community(pctrl
, pin
);
590 padcfg1
= intel_get_padcfg(pctrl
, pin
, PADCFG1
);
591 value
= readl(padcfg1
);
594 case PIN_CONFIG_BIAS_DISABLE
:
595 value
&= ~(PADCFG1_TERM_MASK
| PADCFG1_TERM_UP
);
598 case PIN_CONFIG_BIAS_PULL_UP
:
599 value
&= ~PADCFG1_TERM_MASK
;
601 value
|= PADCFG1_TERM_UP
;
605 value
|= PADCFG1_TERM_20K
<< PADCFG1_TERM_SHIFT
;
608 value
|= PADCFG1_TERM_5K
<< PADCFG1_TERM_SHIFT
;
611 value
|= PADCFG1_TERM_2K
<< PADCFG1_TERM_SHIFT
;
614 value
|= PADCFG1_TERM_1K
<< PADCFG1_TERM_SHIFT
;
622 case PIN_CONFIG_BIAS_PULL_DOWN
:
623 value
&= ~(PADCFG1_TERM_UP
| PADCFG1_TERM_MASK
);
627 value
|= PADCFG1_TERM_20K
<< PADCFG1_TERM_SHIFT
;
630 value
|= PADCFG1_TERM_5K
<< PADCFG1_TERM_SHIFT
;
633 if (!(community
->features
& PINCTRL_FEATURE_1K_PD
)) {
637 value
|= PADCFG1_TERM_1K
<< PADCFG1_TERM_SHIFT
;
647 writel(value
, padcfg1
);
649 raw_spin_unlock_irqrestore(&pctrl
->lock
, flags
);
654 static int intel_config_set_debounce(struct intel_pinctrl
*pctrl
, unsigned pin
,
657 void __iomem
*padcfg0
, *padcfg2
;
662 padcfg2
= intel_get_padcfg(pctrl
, pin
, PADCFG2
);
666 padcfg0
= intel_get_padcfg(pctrl
, pin
, PADCFG0
);
668 raw_spin_lock_irqsave(&pctrl
->lock
, flags
);
670 value0
= readl(padcfg0
);
671 value2
= readl(padcfg2
);
673 /* Disable glitch filter and debouncer */
674 value0
&= ~PADCFG0_PREGFRXSEL
;
675 value2
&= ~(PADCFG2_DEBEN
| PADCFG2_DEBOUNCE_MASK
);
680 v
= order_base_2(debounce
* 1000 / DEBOUNCE_PERIOD
);
681 if (v
< 3 || v
> 15) {
685 /* Enable glitch filter and debouncer */
686 value0
|= PADCFG0_PREGFRXSEL
;
687 value2
|= v
<< PADCFG2_DEBOUNCE_SHIFT
;
688 value2
|= PADCFG2_DEBEN
;
692 writel(value0
, padcfg0
);
693 writel(value2
, padcfg2
);
696 raw_spin_unlock_irqrestore(&pctrl
->lock
, flags
);
701 static int intel_config_set(struct pinctrl_dev
*pctldev
, unsigned pin
,
702 unsigned long *configs
, unsigned nconfigs
)
704 struct intel_pinctrl
*pctrl
= pinctrl_dev_get_drvdata(pctldev
);
707 if (!intel_pad_usable(pctrl
, pin
))
710 for (i
= 0; i
< nconfigs
; i
++) {
711 switch (pinconf_to_config_param(configs
[i
])) {
712 case PIN_CONFIG_BIAS_DISABLE
:
713 case PIN_CONFIG_BIAS_PULL_UP
:
714 case PIN_CONFIG_BIAS_PULL_DOWN
:
715 ret
= intel_config_set_pull(pctrl
, pin
, configs
[i
]);
720 case PIN_CONFIG_INPUT_DEBOUNCE
:
721 ret
= intel_config_set_debounce(pctrl
, pin
,
722 pinconf_to_config_argument(configs
[i
]));
735 static const struct pinconf_ops intel_pinconf_ops
= {
737 .pin_config_get
= intel_config_get
,
738 .pin_config_set
= intel_config_set
,
741 static const struct pinctrl_desc intel_pinctrl_desc
= {
742 .pctlops
= &intel_pinctrl_ops
,
743 .pmxops
= &intel_pinmux_ops
,
744 .confops
= &intel_pinconf_ops
,
745 .owner
= THIS_MODULE
,
748 static int intel_gpio_get(struct gpio_chip
*chip
, unsigned offset
)
750 struct intel_pinctrl
*pctrl
= gpiochip_get_data(chip
);
754 reg
= intel_get_padcfg(pctrl
, offset
, PADCFG0
);
758 padcfg0
= readl(reg
);
759 if (!(padcfg0
& PADCFG0_GPIOTXDIS
))
760 return !!(padcfg0
& PADCFG0_GPIOTXSTATE
);
762 return !!(padcfg0
& PADCFG0_GPIORXSTATE
);
765 static void intel_gpio_set(struct gpio_chip
*chip
, unsigned offset
, int value
)
767 struct intel_pinctrl
*pctrl
= gpiochip_get_data(chip
);
772 reg
= intel_get_padcfg(pctrl
, offset
, PADCFG0
);
776 raw_spin_lock_irqsave(&pctrl
->lock
, flags
);
777 padcfg0
= readl(reg
);
779 padcfg0
|= PADCFG0_GPIOTXSTATE
;
781 padcfg0
&= ~PADCFG0_GPIOTXSTATE
;
782 writel(padcfg0
, reg
);
783 raw_spin_unlock_irqrestore(&pctrl
->lock
, flags
);
786 static int intel_gpio_direction_input(struct gpio_chip
*chip
, unsigned offset
)
788 return pinctrl_gpio_direction_input(chip
->base
+ offset
);
791 static int intel_gpio_direction_output(struct gpio_chip
*chip
, unsigned offset
,
794 intel_gpio_set(chip
, offset
, value
);
795 return pinctrl_gpio_direction_output(chip
->base
+ offset
);
798 static const struct gpio_chip intel_gpio_chip
= {
799 .owner
= THIS_MODULE
,
800 .request
= gpiochip_generic_request
,
801 .free
= gpiochip_generic_free
,
802 .direction_input
= intel_gpio_direction_input
,
803 .direction_output
= intel_gpio_direction_output
,
804 .get
= intel_gpio_get
,
805 .set
= intel_gpio_set
,
806 .set_config
= gpiochip_generic_config
,
810 * intel_gpio_to_pin() - Translate from GPIO offset to pin number
811 * @pctrl: Pinctrl structure
812 * @offset: GPIO offset from gpiolib
813 * @commmunity: Community is filled here if not %NULL
814 * @padgrp: Pad group is filled here if not %NULL
816 * When coming through gpiolib irqchip, the GPIO offset is not
817 * automatically translated to pinctrl pin number. This function can be
818 * used to find out the corresponding pinctrl pin.
820 static int intel_gpio_to_pin(struct intel_pinctrl
*pctrl
, unsigned offset
,
821 const struct intel_community
**community
,
822 const struct intel_padgroup
**padgrp
)
826 for (i
= 0; i
< pctrl
->ncommunities
; i
++) {
827 const struct intel_community
*comm
= &pctrl
->communities
[i
];
830 for (j
= 0; j
< comm
->ngpps
; j
++) {
831 const struct intel_padgroup
*pgrp
= &comm
->gpps
[j
];
833 if (pgrp
->gpio_base
< 0)
836 if (offset
>= pgrp
->gpio_base
&&
837 offset
< pgrp
->gpio_base
+ pgrp
->size
) {
840 pin
= pgrp
->base
+ offset
- pgrp
->gpio_base
;
854 static void intel_gpio_irq_ack(struct irq_data
*d
)
856 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
857 struct intel_pinctrl
*pctrl
= gpiochip_get_data(gc
);
858 const struct intel_community
*community
;
859 const struct intel_padgroup
*padgrp
;
862 pin
= intel_gpio_to_pin(pctrl
, irqd_to_hwirq(d
), &community
, &padgrp
);
864 unsigned gpp
, gpp_offset
, is_offset
;
866 gpp
= padgrp
->reg_num
;
867 gpp_offset
= padgroup_offset(padgrp
, pin
);
868 is_offset
= community
->is_offset
+ gpp
* 4;
870 raw_spin_lock(&pctrl
->lock
);
871 writel(BIT(gpp_offset
), community
->regs
+ is_offset
);
872 raw_spin_unlock(&pctrl
->lock
);
876 static void intel_gpio_irq_enable(struct irq_data
*d
)
878 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
879 struct intel_pinctrl
*pctrl
= gpiochip_get_data(gc
);
880 const struct intel_community
*community
;
881 const struct intel_padgroup
*padgrp
;
884 pin
= intel_gpio_to_pin(pctrl
, irqd_to_hwirq(d
), &community
, &padgrp
);
886 unsigned gpp
, gpp_offset
, is_offset
;
890 gpp
= padgrp
->reg_num
;
891 gpp_offset
= padgroup_offset(padgrp
, pin
);
892 is_offset
= community
->is_offset
+ gpp
* 4;
894 raw_spin_lock_irqsave(&pctrl
->lock
, flags
);
895 /* Clear interrupt status first to avoid unexpected interrupt */
896 writel(BIT(gpp_offset
), community
->regs
+ is_offset
);
898 value
= readl(community
->regs
+ community
->ie_offset
+ gpp
* 4);
899 value
|= BIT(gpp_offset
);
900 writel(value
, community
->regs
+ community
->ie_offset
+ gpp
* 4);
901 raw_spin_unlock_irqrestore(&pctrl
->lock
, flags
);
905 static void intel_gpio_irq_mask_unmask(struct irq_data
*d
, bool mask
)
907 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
908 struct intel_pinctrl
*pctrl
= gpiochip_get_data(gc
);
909 const struct intel_community
*community
;
910 const struct intel_padgroup
*padgrp
;
913 pin
= intel_gpio_to_pin(pctrl
, irqd_to_hwirq(d
), &community
, &padgrp
);
915 unsigned gpp
, gpp_offset
;
920 gpp
= padgrp
->reg_num
;
921 gpp_offset
= padgroup_offset(padgrp
, pin
);
923 reg
= community
->regs
+ community
->ie_offset
+ gpp
* 4;
925 raw_spin_lock_irqsave(&pctrl
->lock
, flags
);
928 value
&= ~BIT(gpp_offset
);
930 value
|= BIT(gpp_offset
);
932 raw_spin_unlock_irqrestore(&pctrl
->lock
, flags
);
936 static void intel_gpio_irq_mask(struct irq_data
*d
)
938 intel_gpio_irq_mask_unmask(d
, true);
941 static void intel_gpio_irq_unmask(struct irq_data
*d
)
943 intel_gpio_irq_mask_unmask(d
, false);
946 static int intel_gpio_irq_type(struct irq_data
*d
, unsigned type
)
948 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
949 struct intel_pinctrl
*pctrl
= gpiochip_get_data(gc
);
950 unsigned pin
= intel_gpio_to_pin(pctrl
, irqd_to_hwirq(d
), NULL
, NULL
);
955 reg
= intel_get_padcfg(pctrl
, pin
, PADCFG0
);
960 * If the pin is in ACPI mode it is still usable as a GPIO but it
961 * cannot be used as IRQ because GPI_IS status bit will not be
962 * updated by the host controller hardware.
964 if (intel_pad_acpi_mode(pctrl
, pin
)) {
965 dev_warn(pctrl
->dev
, "pin %u cannot be used as IRQ\n", pin
);
969 raw_spin_lock_irqsave(&pctrl
->lock
, flags
);
973 value
&= ~(PADCFG0_RXEVCFG_MASK
| PADCFG0_RXINV
);
975 if ((type
& IRQ_TYPE_EDGE_BOTH
) == IRQ_TYPE_EDGE_BOTH
) {
976 value
|= PADCFG0_RXEVCFG_EDGE_BOTH
<< PADCFG0_RXEVCFG_SHIFT
;
977 } else if (type
& IRQ_TYPE_EDGE_FALLING
) {
978 value
|= PADCFG0_RXEVCFG_EDGE
<< PADCFG0_RXEVCFG_SHIFT
;
979 value
|= PADCFG0_RXINV
;
980 } else if (type
& IRQ_TYPE_EDGE_RISING
) {
981 value
|= PADCFG0_RXEVCFG_EDGE
<< PADCFG0_RXEVCFG_SHIFT
;
982 } else if (type
& IRQ_TYPE_LEVEL_MASK
) {
983 if (type
& IRQ_TYPE_LEVEL_LOW
)
984 value
|= PADCFG0_RXINV
;
986 value
|= PADCFG0_RXEVCFG_DISABLED
<< PADCFG0_RXEVCFG_SHIFT
;
991 if (type
& IRQ_TYPE_EDGE_BOTH
)
992 irq_set_handler_locked(d
, handle_edge_irq
);
993 else if (type
& IRQ_TYPE_LEVEL_MASK
)
994 irq_set_handler_locked(d
, handle_level_irq
);
996 raw_spin_unlock_irqrestore(&pctrl
->lock
, flags
);
1001 static int intel_gpio_irq_wake(struct irq_data
*d
, unsigned int on
)
1003 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
1004 struct intel_pinctrl
*pctrl
= gpiochip_get_data(gc
);
1005 unsigned pin
= intel_gpio_to_pin(pctrl
, irqd_to_hwirq(d
), NULL
, NULL
);
1008 enable_irq_wake(pctrl
->irq
);
1010 disable_irq_wake(pctrl
->irq
);
1012 dev_dbg(pctrl
->dev
, "%sable wake for pin %u\n", on
? "en" : "dis", pin
);
1016 static irqreturn_t
intel_gpio_community_irq_handler(struct intel_pinctrl
*pctrl
,
1017 const struct intel_community
*community
)
1019 struct gpio_chip
*gc
= &pctrl
->chip
;
1020 irqreturn_t ret
= IRQ_NONE
;
1023 for (gpp
= 0; gpp
< community
->ngpps
; gpp
++) {
1024 const struct intel_padgroup
*padgrp
= &community
->gpps
[gpp
];
1025 unsigned long pending
, enabled
, gpp_offset
;
1027 pending
= readl(community
->regs
+ community
->is_offset
+
1028 padgrp
->reg_num
* 4);
1029 enabled
= readl(community
->regs
+ community
->ie_offset
+
1030 padgrp
->reg_num
* 4);
1032 /* Only interrupts that are enabled */
1035 for_each_set_bit(gpp_offset
, &pending
, padgrp
->size
) {
1038 irq
= irq_find_mapping(gc
->irq
.domain
,
1039 padgrp
->gpio_base
+ gpp_offset
);
1040 generic_handle_irq(irq
);
1049 static irqreturn_t
intel_gpio_irq(int irq
, void *data
)
1051 const struct intel_community
*community
;
1052 struct intel_pinctrl
*pctrl
= data
;
1053 irqreturn_t ret
= IRQ_NONE
;
1056 /* Need to check all communities for pending interrupts */
1057 for (i
= 0; i
< pctrl
->ncommunities
; i
++) {
1058 community
= &pctrl
->communities
[i
];
1059 ret
|= intel_gpio_community_irq_handler(pctrl
, community
);
1065 static struct irq_chip intel_gpio_irqchip
= {
1066 .name
= "intel-gpio",
1067 .irq_enable
= intel_gpio_irq_enable
,
1068 .irq_ack
= intel_gpio_irq_ack
,
1069 .irq_mask
= intel_gpio_irq_mask
,
1070 .irq_unmask
= intel_gpio_irq_unmask
,
1071 .irq_set_type
= intel_gpio_irq_type
,
1072 .irq_set_wake
= intel_gpio_irq_wake
,
1073 .flags
= IRQCHIP_MASK_ON_SUSPEND
,
1076 static int intel_gpio_add_pin_ranges(struct intel_pinctrl
*pctrl
,
1077 const struct intel_community
*community
)
1081 for (i
= 0; i
< community
->ngpps
; i
++) {
1082 const struct intel_padgroup
*gpp
= &community
->gpps
[i
];
1084 if (gpp
->gpio_base
< 0)
1087 ret
= gpiochip_add_pin_range(&pctrl
->chip
, dev_name(pctrl
->dev
),
1088 gpp
->gpio_base
, gpp
->base
,
1097 static unsigned intel_gpio_ngpio(const struct intel_pinctrl
*pctrl
)
1099 const struct intel_community
*community
;
1103 for (i
= 0; i
< pctrl
->ncommunities
; i
++) {
1104 community
= &pctrl
->communities
[i
];
1105 for (j
= 0; j
< community
->ngpps
; j
++) {
1106 const struct intel_padgroup
*gpp
= &community
->gpps
[j
];
1108 if (gpp
->gpio_base
< 0)
1111 if (gpp
->gpio_base
+ gpp
->size
> ngpio
)
1112 ngpio
= gpp
->gpio_base
+ gpp
->size
;
1119 static int intel_gpio_probe(struct intel_pinctrl
*pctrl
, int irq
)
1123 pctrl
->chip
= intel_gpio_chip
;
1125 pctrl
->chip
.ngpio
= intel_gpio_ngpio(pctrl
);
1126 pctrl
->chip
.label
= dev_name(pctrl
->dev
);
1127 pctrl
->chip
.parent
= pctrl
->dev
;
1128 pctrl
->chip
.base
= -1;
1131 ret
= devm_gpiochip_add_data(pctrl
->dev
, &pctrl
->chip
, pctrl
);
1133 dev_err(pctrl
->dev
, "failed to register gpiochip\n");
1137 for (i
= 0; i
< pctrl
->ncommunities
; i
++) {
1138 struct intel_community
*community
= &pctrl
->communities
[i
];
1140 ret
= intel_gpio_add_pin_ranges(pctrl
, community
);
1142 dev_err(pctrl
->dev
, "failed to add GPIO pin range\n");
1148 * We need to request the interrupt here (instead of providing chip
1149 * to the irq directly) because on some platforms several GPIO
1150 * controllers share the same interrupt line.
1152 ret
= devm_request_irq(pctrl
->dev
, irq
, intel_gpio_irq
,
1153 IRQF_SHARED
| IRQF_NO_THREAD
,
1154 dev_name(pctrl
->dev
), pctrl
);
1156 dev_err(pctrl
->dev
, "failed to request interrupt\n");
1160 ret
= gpiochip_irqchip_add(&pctrl
->chip
, &intel_gpio_irqchip
, 0,
1161 handle_bad_irq
, IRQ_TYPE_NONE
);
1163 dev_err(pctrl
->dev
, "failed to add irqchip\n");
1167 gpiochip_set_chained_irqchip(&pctrl
->chip
, &intel_gpio_irqchip
, irq
,
1172 static int intel_pinctrl_add_padgroups(struct intel_pinctrl
*pctrl
,
1173 struct intel_community
*community
)
1175 struct intel_padgroup
*gpps
;
1176 unsigned npins
= community
->npins
;
1177 unsigned padown_num
= 0;
1180 if (community
->gpps
)
1181 ngpps
= community
->ngpps
;
1183 ngpps
= DIV_ROUND_UP(community
->npins
, community
->gpp_size
);
1185 gpps
= devm_kcalloc(pctrl
->dev
, ngpps
, sizeof(*gpps
), GFP_KERNEL
);
1189 for (i
= 0; i
< ngpps
; i
++) {
1190 if (community
->gpps
) {
1191 gpps
[i
] = community
->gpps
[i
];
1193 unsigned gpp_size
= community
->gpp_size
;
1195 gpps
[i
].reg_num
= i
;
1196 gpps
[i
].base
= community
->pin_base
+ i
* gpp_size
;
1197 gpps
[i
].size
= min(gpp_size
, npins
);
1198 npins
-= gpps
[i
].size
;
1201 if (gpps
[i
].size
> 32)
1204 if (!gpps
[i
].gpio_base
)
1205 gpps
[i
].gpio_base
= gpps
[i
].base
;
1207 gpps
[i
].padown_num
= padown_num
;
1210 * In older hardware the number of padown registers per
1211 * group is fixed regardless of the group size.
1213 if (community
->gpp_num_padown_regs
)
1214 padown_num
+= community
->gpp_num_padown_regs
;
1216 padown_num
+= DIV_ROUND_UP(gpps
[i
].size
* 4, 32);
1219 community
->ngpps
= ngpps
;
1220 community
->gpps
= gpps
;
1225 static int intel_pinctrl_pm_init(struct intel_pinctrl
*pctrl
)
1227 #ifdef CONFIG_PM_SLEEP
1228 const struct intel_pinctrl_soc_data
*soc
= pctrl
->soc
;
1229 struct intel_community_context
*communities
;
1230 struct intel_pad_context
*pads
;
1233 pads
= devm_kcalloc(pctrl
->dev
, soc
->npins
, sizeof(*pads
), GFP_KERNEL
);
1237 communities
= devm_kcalloc(pctrl
->dev
, pctrl
->ncommunities
,
1238 sizeof(*communities
), GFP_KERNEL
);
1243 for (i
= 0; i
< pctrl
->ncommunities
; i
++) {
1244 struct intel_community
*community
= &pctrl
->communities
[i
];
1247 intmask
= devm_kcalloc(pctrl
->dev
, community
->ngpps
,
1248 sizeof(*intmask
), GFP_KERNEL
);
1252 communities
[i
].intmask
= intmask
;
1255 pctrl
->context
.pads
= pads
;
1256 pctrl
->context
.communities
= communities
;
1262 int intel_pinctrl_probe(struct platform_device
*pdev
,
1263 const struct intel_pinctrl_soc_data
*soc_data
)
1265 struct intel_pinctrl
*pctrl
;
1271 pctrl
= devm_kzalloc(&pdev
->dev
, sizeof(*pctrl
), GFP_KERNEL
);
1275 pctrl
->dev
= &pdev
->dev
;
1276 pctrl
->soc
= soc_data
;
1277 raw_spin_lock_init(&pctrl
->lock
);
1280 * Make a copy of the communities which we can use to hold pointers
1283 pctrl
->ncommunities
= pctrl
->soc
->ncommunities
;
1284 pctrl
->communities
= devm_kcalloc(&pdev
->dev
, pctrl
->ncommunities
,
1285 sizeof(*pctrl
->communities
), GFP_KERNEL
);
1286 if (!pctrl
->communities
)
1289 for (i
= 0; i
< pctrl
->ncommunities
; i
++) {
1290 struct intel_community
*community
= &pctrl
->communities
[i
];
1291 struct resource
*res
;
1295 *community
= pctrl
->soc
->communities
[i
];
1297 res
= platform_get_resource(pdev
, IORESOURCE_MEM
,
1299 regs
= devm_ioremap_resource(&pdev
->dev
, res
);
1301 return PTR_ERR(regs
);
1304 * Determine community features based on the revision if
1305 * not specified already.
1307 if (!community
->features
) {
1310 rev
= (readl(regs
+ REVID
) & REVID_MASK
) >> REVID_SHIFT
;
1312 community
->features
|= PINCTRL_FEATURE_DEBOUNCE
;
1313 community
->features
|= PINCTRL_FEATURE_1K_PD
;
1317 /* Read offset of the pad configuration registers */
1318 padbar
= readl(regs
+ PADBAR
);
1320 community
->regs
= regs
;
1321 community
->pad_regs
= regs
+ padbar
;
1323 if (!community
->is_offset
)
1324 community
->is_offset
= GPI_IS
;
1326 ret
= intel_pinctrl_add_padgroups(pctrl
, community
);
1331 irq
= platform_get_irq(pdev
, 0);
1333 dev_err(&pdev
->dev
, "failed to get interrupt number\n");
1337 ret
= intel_pinctrl_pm_init(pctrl
);
1341 pctrl
->pctldesc
= intel_pinctrl_desc
;
1342 pctrl
->pctldesc
.name
= dev_name(&pdev
->dev
);
1343 pctrl
->pctldesc
.pins
= pctrl
->soc
->pins
;
1344 pctrl
->pctldesc
.npins
= pctrl
->soc
->npins
;
1346 pctrl
->pctldev
= devm_pinctrl_register(&pdev
->dev
, &pctrl
->pctldesc
,
1348 if (IS_ERR(pctrl
->pctldev
)) {
1349 dev_err(&pdev
->dev
, "failed to register pinctrl driver\n");
1350 return PTR_ERR(pctrl
->pctldev
);
1353 ret
= intel_gpio_probe(pctrl
, irq
);
1357 platform_set_drvdata(pdev
, pctrl
);
1361 EXPORT_SYMBOL_GPL(intel_pinctrl_probe
);
1363 #ifdef CONFIG_PM_SLEEP
1364 static bool intel_pinctrl_should_save(struct intel_pinctrl
*pctrl
, unsigned pin
)
1366 const struct pin_desc
*pd
= pin_desc_get(pctrl
->pctldev
, pin
);
1368 if (!pd
|| !intel_pad_usable(pctrl
, pin
))
1372 * Only restore the pin if it is actually in use by the kernel (or
1373 * by userspace). It is possible that some pins are used by the
1374 * BIOS during resume and those are not always locked down so leave
1377 if (pd
->mux_owner
|| pd
->gpio_owner
||
1378 gpiochip_line_is_irq(&pctrl
->chip
, pin
))
1384 int intel_pinctrl_suspend(struct device
*dev
)
1386 struct platform_device
*pdev
= to_platform_device(dev
);
1387 struct intel_pinctrl
*pctrl
= platform_get_drvdata(pdev
);
1388 struct intel_community_context
*communities
;
1389 struct intel_pad_context
*pads
;
1392 pads
= pctrl
->context
.pads
;
1393 for (i
= 0; i
< pctrl
->soc
->npins
; i
++) {
1394 const struct pinctrl_pin_desc
*desc
= &pctrl
->soc
->pins
[i
];
1395 void __iomem
*padcfg
;
1398 if (!intel_pinctrl_should_save(pctrl
, desc
->number
))
1401 val
= readl(intel_get_padcfg(pctrl
, desc
->number
, PADCFG0
));
1402 pads
[i
].padcfg0
= val
& ~PADCFG0_GPIORXSTATE
;
1403 val
= readl(intel_get_padcfg(pctrl
, desc
->number
, PADCFG1
));
1404 pads
[i
].padcfg1
= val
;
1406 padcfg
= intel_get_padcfg(pctrl
, desc
->number
, PADCFG2
);
1408 pads
[i
].padcfg2
= readl(padcfg
);
1411 communities
= pctrl
->context
.communities
;
1412 for (i
= 0; i
< pctrl
->ncommunities
; i
++) {
1413 struct intel_community
*community
= &pctrl
->communities
[i
];
1417 base
= community
->regs
+ community
->ie_offset
;
1418 for (gpp
= 0; gpp
< community
->ngpps
; gpp
++)
1419 communities
[i
].intmask
[gpp
] = readl(base
+ gpp
* 4);
1424 EXPORT_SYMBOL_GPL(intel_pinctrl_suspend
);
1426 static void intel_gpio_irq_init(struct intel_pinctrl
*pctrl
)
1430 for (i
= 0; i
< pctrl
->ncommunities
; i
++) {
1431 const struct intel_community
*community
;
1435 community
= &pctrl
->communities
[i
];
1436 base
= community
->regs
;
1438 for (gpp
= 0; gpp
< community
->ngpps
; gpp
++) {
1439 /* Mask and clear all interrupts */
1440 writel(0, base
+ community
->ie_offset
+ gpp
* 4);
1441 writel(0xffff, base
+ community
->is_offset
+ gpp
* 4);
1446 int intel_pinctrl_resume(struct device
*dev
)
1448 struct platform_device
*pdev
= to_platform_device(dev
);
1449 struct intel_pinctrl
*pctrl
= platform_get_drvdata(pdev
);
1450 const struct intel_community_context
*communities
;
1451 const struct intel_pad_context
*pads
;
1454 /* Mask all interrupts */
1455 intel_gpio_irq_init(pctrl
);
1457 pads
= pctrl
->context
.pads
;
1458 for (i
= 0; i
< pctrl
->soc
->npins
; i
++) {
1459 const struct pinctrl_pin_desc
*desc
= &pctrl
->soc
->pins
[i
];
1460 void __iomem
*padcfg
;
1463 if (!intel_pinctrl_should_save(pctrl
, desc
->number
))
1466 padcfg
= intel_get_padcfg(pctrl
, desc
->number
, PADCFG0
);
1467 val
= readl(padcfg
) & ~PADCFG0_GPIORXSTATE
;
1468 if (val
!= pads
[i
].padcfg0
) {
1469 writel(pads
[i
].padcfg0
, padcfg
);
1470 dev_dbg(dev
, "restored pin %u padcfg0 %#08x\n",
1471 desc
->number
, readl(padcfg
));
1474 padcfg
= intel_get_padcfg(pctrl
, desc
->number
, PADCFG1
);
1475 val
= readl(padcfg
);
1476 if (val
!= pads
[i
].padcfg1
) {
1477 writel(pads
[i
].padcfg1
, padcfg
);
1478 dev_dbg(dev
, "restored pin %u padcfg1 %#08x\n",
1479 desc
->number
, readl(padcfg
));
1482 padcfg
= intel_get_padcfg(pctrl
, desc
->number
, PADCFG2
);
1484 val
= readl(padcfg
);
1485 if (val
!= pads
[i
].padcfg2
) {
1486 writel(pads
[i
].padcfg2
, padcfg
);
1487 dev_dbg(dev
, "restored pin %u padcfg2 %#08x\n",
1488 desc
->number
, readl(padcfg
));
1493 communities
= pctrl
->context
.communities
;
1494 for (i
= 0; i
< pctrl
->ncommunities
; i
++) {
1495 struct intel_community
*community
= &pctrl
->communities
[i
];
1499 base
= community
->regs
+ community
->ie_offset
;
1500 for (gpp
= 0; gpp
< community
->ngpps
; gpp
++) {
1501 writel(communities
[i
].intmask
[gpp
], base
+ gpp
* 4);
1502 dev_dbg(dev
, "restored mask %d/%u %#08x\n", i
, gpp
,
1503 readl(base
+ gpp
* 4));
1509 EXPORT_SYMBOL_GPL(intel_pinctrl_resume
);
1512 MODULE_AUTHOR("Mathias Nyman <mathias.nyman@linux.intel.com>");
1513 MODULE_AUTHOR("Mika Westerberg <mika.westerberg@linux.intel.com>");
1514 MODULE_DESCRIPTION("Intel pinctrl/GPIO core driver");
1515 MODULE_LICENSE("GPL v2");