1 // SPDX-License-Identifier: GPL-2.0-only
3 * Driver for the NVIDIA Tegra pinmux
5 * Copyright (c) 2011-2012, NVIDIA CORPORATION. All rights reserved.
8 * Copyright (C) 2010 Google, Inc.
9 * Copyright (C) 2010 NVIDIA Corporation
10 * Copyright (C) 2009-2011 ST-Ericsson AB
13 #include <linux/err.h>
14 #include <linux/init.h>
17 #include <linux/platform_device.h>
18 #include <linux/pinctrl/machine.h>
19 #include <linux/pinctrl/pinctrl.h>
20 #include <linux/pinctrl/pinmux.h>
21 #include <linux/pinctrl/pinconf.h>
22 #include <linux/slab.h>
25 #include "../pinctrl-utils.h"
26 #include "pinctrl-tegra.h"
28 static inline u32 pmx_readl(struct tegra_pmx *pmx, u32 bank, u32 reg)
30 return readl(pmx->regs[bank] + reg);
33 static inline void pmx_writel(struct tegra_pmx *pmx, u32 val, u32 bank, u32 reg)
35 writel_relaxed(val, pmx->regs[bank] + reg);
36 /* make sure pinmux register write completed */
37 pmx_readl(pmx, bank, reg);
40 static int tegra_pinctrl_get_groups_count(struct pinctrl_dev *pctldev)
42 struct tegra_pmx *pmx = pinctrl_dev_get_drvdata(pctldev);
44 return pmx->soc->ngroups;
47 static const char *tegra_pinctrl_get_group_name(struct pinctrl_dev *pctldev,
50 struct tegra_pmx *pmx = pinctrl_dev_get_drvdata(pctldev);
52 return pmx->soc->groups[group].name;
55 static int tegra_pinctrl_get_group_pins(struct pinctrl_dev *pctldev,
57 const unsigned **pins,
60 struct tegra_pmx *pmx = pinctrl_dev_get_drvdata(pctldev);
62 *pins = pmx->soc->groups[group].pins;
63 *num_pins = pmx->soc->groups[group].npins;
68 #ifdef CONFIG_DEBUG_FS
69 static void tegra_pinctrl_pin_dbg_show(struct pinctrl_dev *pctldev,
73 seq_printf(s, " %s", dev_name(pctldev->dev));
77 static const struct cfg_param {
79 enum tegra_pinconf_param param;
81 {"nvidia,pull", TEGRA_PINCONF_PARAM_PULL},
82 {"nvidia,tristate", TEGRA_PINCONF_PARAM_TRISTATE},
83 {"nvidia,enable-input", TEGRA_PINCONF_PARAM_ENABLE_INPUT},
84 {"nvidia,open-drain", TEGRA_PINCONF_PARAM_OPEN_DRAIN},
85 {"nvidia,lock", TEGRA_PINCONF_PARAM_LOCK},
86 {"nvidia,io-reset", TEGRA_PINCONF_PARAM_IORESET},
87 {"nvidia,rcv-sel", TEGRA_PINCONF_PARAM_RCV_SEL},
88 {"nvidia,io-hv", TEGRA_PINCONF_PARAM_RCV_SEL},
89 {"nvidia,high-speed-mode", TEGRA_PINCONF_PARAM_HIGH_SPEED_MODE},
90 {"nvidia,schmitt", TEGRA_PINCONF_PARAM_SCHMITT},
91 {"nvidia,low-power-mode", TEGRA_PINCONF_PARAM_LOW_POWER_MODE},
92 {"nvidia,pull-down-strength", TEGRA_PINCONF_PARAM_DRIVE_DOWN_STRENGTH},
93 {"nvidia,pull-up-strength", TEGRA_PINCONF_PARAM_DRIVE_UP_STRENGTH},
94 {"nvidia,slew-rate-falling", TEGRA_PINCONF_PARAM_SLEW_RATE_FALLING},
95 {"nvidia,slew-rate-rising", TEGRA_PINCONF_PARAM_SLEW_RATE_RISING},
96 {"nvidia,drive-type", TEGRA_PINCONF_PARAM_DRIVE_TYPE},
99 static int tegra_pinctrl_dt_subnode_to_map(struct pinctrl_dev *pctldev,
100 struct device_node *np,
101 struct pinctrl_map **map,
102 unsigned *reserved_maps,
105 struct device *dev = pctldev->dev;
107 const char *function;
109 unsigned long config;
110 unsigned long *configs = NULL;
111 unsigned num_configs = 0;
113 struct property *prop;
116 ret = of_property_read_string(np, "nvidia,function", &function);
118 /* EINVAL=missing, which is fine since it's optional */
121 "could not parse property nvidia,function\n");
125 for (i = 0; i < ARRAY_SIZE(cfg_params); i++) {
126 ret = of_property_read_u32(np, cfg_params[i].property, &val);
128 config = TEGRA_PINCONF_PACK(cfg_params[i].param, val);
129 ret = pinctrl_utils_add_config(pctldev, &configs,
130 &num_configs, config);
133 /* EINVAL=missing, which is fine since it's optional */
134 } else if (ret != -EINVAL) {
135 dev_err(dev, "could not parse property %s\n",
136 cfg_params[i].property);
141 if (function != NULL)
145 ret = of_property_count_strings(np, "nvidia,pins");
147 dev_err(dev, "could not parse property nvidia,pins\n");
152 ret = pinctrl_utils_reserve_map(pctldev, map, reserved_maps,
157 of_property_for_each_string(np, "nvidia,pins", prop, group) {
159 ret = pinctrl_utils_add_map_mux(pctldev, map,
160 reserved_maps, num_maps, group,
167 ret = pinctrl_utils_add_map_configs(pctldev, map,
168 reserved_maps, num_maps, group,
169 configs, num_configs,
170 PIN_MAP_TYPE_CONFIGS_GROUP);
183 static int tegra_pinctrl_dt_node_to_map(struct pinctrl_dev *pctldev,
184 struct device_node *np_config,
185 struct pinctrl_map **map,
188 unsigned reserved_maps;
189 struct device_node *np;
196 for_each_child_of_node(np_config, np) {
197 ret = tegra_pinctrl_dt_subnode_to_map(pctldev, np, map,
198 &reserved_maps, num_maps);
200 pinctrl_utils_free_map(pctldev, *map,
210 static const struct pinctrl_ops tegra_pinctrl_ops = {
211 .get_groups_count = tegra_pinctrl_get_groups_count,
212 .get_group_name = tegra_pinctrl_get_group_name,
213 .get_group_pins = tegra_pinctrl_get_group_pins,
214 #ifdef CONFIG_DEBUG_FS
215 .pin_dbg_show = tegra_pinctrl_pin_dbg_show,
217 .dt_node_to_map = tegra_pinctrl_dt_node_to_map,
218 .dt_free_map = pinctrl_utils_free_map,
221 static int tegra_pinctrl_get_funcs_count(struct pinctrl_dev *pctldev)
223 struct tegra_pmx *pmx = pinctrl_dev_get_drvdata(pctldev);
225 return pmx->soc->nfunctions;
228 static const char *tegra_pinctrl_get_func_name(struct pinctrl_dev *pctldev,
231 struct tegra_pmx *pmx = pinctrl_dev_get_drvdata(pctldev);
233 return pmx->soc->functions[function].name;
236 static int tegra_pinctrl_get_func_groups(struct pinctrl_dev *pctldev,
238 const char * const **groups,
239 unsigned * const num_groups)
241 struct tegra_pmx *pmx = pinctrl_dev_get_drvdata(pctldev);
243 *groups = pmx->soc->functions[function].groups;
244 *num_groups = pmx->soc->functions[function].ngroups;
249 static int tegra_pinctrl_set_mux(struct pinctrl_dev *pctldev,
253 struct tegra_pmx *pmx = pinctrl_dev_get_drvdata(pctldev);
254 const struct tegra_pingroup *g;
258 g = &pmx->soc->groups[group];
260 if (WARN_ON(g->mux_reg < 0))
263 for (i = 0; i < ARRAY_SIZE(g->funcs); i++) {
264 if (g->funcs[i] == function)
267 if (WARN_ON(i == ARRAY_SIZE(g->funcs)))
270 val = pmx_readl(pmx, g->mux_bank, g->mux_reg);
271 val &= ~(0x3 << g->mux_bit);
272 val |= i << g->mux_bit;
273 pmx_writel(pmx, val, g->mux_bank, g->mux_reg);
278 static const struct tegra_pingroup *tegra_pinctrl_get_group(struct pinctrl_dev *pctldev,
281 struct tegra_pmx *pmx = pinctrl_dev_get_drvdata(pctldev);
282 unsigned int group, num_pins, j;
283 const unsigned int *pins;
286 for (group = 0; group < pmx->soc->ngroups; ++group) {
287 ret = tegra_pinctrl_get_group_pins(pctldev, group, &pins, &num_pins);
290 for (j = 0; j < num_pins; j++) {
291 if (offset == pins[j])
292 return &pmx->soc->groups[group];
296 dev_err(pctldev->dev, "Pingroup not found for pin %u\n", offset);
300 static int tegra_pinctrl_gpio_request_enable(struct pinctrl_dev *pctldev,
301 struct pinctrl_gpio_range *range,
304 struct tegra_pmx *pmx = pinctrl_dev_get_drvdata(pctldev);
305 const struct tegra_pingroup *group;
308 if (!pmx->soc->sfsel_in_mux)
311 group = tegra_pinctrl_get_group(pctldev, offset);
316 if (group->mux_reg < 0 || group->sfsel_bit < 0)
319 value = pmx_readl(pmx, group->mux_bank, group->mux_reg);
320 value &= ~BIT(group->sfsel_bit);
321 pmx_writel(pmx, value, group->mux_bank, group->mux_reg);
326 static void tegra_pinctrl_gpio_disable_free(struct pinctrl_dev *pctldev,
327 struct pinctrl_gpio_range *range,
330 struct tegra_pmx *pmx = pinctrl_dev_get_drvdata(pctldev);
331 const struct tegra_pingroup *group;
334 if (!pmx->soc->sfsel_in_mux)
337 group = tegra_pinctrl_get_group(pctldev, offset);
342 if (group->mux_reg < 0 || group->sfsel_bit < 0)
345 value = pmx_readl(pmx, group->mux_bank, group->mux_reg);
346 value |= BIT(group->sfsel_bit);
347 pmx_writel(pmx, value, group->mux_bank, group->mux_reg);
350 static const struct pinmux_ops tegra_pinmux_ops = {
351 .get_functions_count = tegra_pinctrl_get_funcs_count,
352 .get_function_name = tegra_pinctrl_get_func_name,
353 .get_function_groups = tegra_pinctrl_get_func_groups,
354 .set_mux = tegra_pinctrl_set_mux,
355 .gpio_request_enable = tegra_pinctrl_gpio_request_enable,
356 .gpio_disable_free = tegra_pinctrl_gpio_disable_free,
359 static int tegra_pinconf_reg(struct tegra_pmx *pmx,
360 const struct tegra_pingroup *g,
361 enum tegra_pinconf_param param,
363 s8 *bank, s32 *reg, s8 *bit, s8 *width)
366 case TEGRA_PINCONF_PARAM_PULL:
367 *bank = g->pupd_bank;
372 case TEGRA_PINCONF_PARAM_TRISTATE:
378 case TEGRA_PINCONF_PARAM_ENABLE_INPUT:
381 *bit = g->einput_bit;
384 case TEGRA_PINCONF_PARAM_OPEN_DRAIN:
387 *bit = g->odrain_bit;
390 case TEGRA_PINCONF_PARAM_LOCK:
396 case TEGRA_PINCONF_PARAM_IORESET:
399 *bit = g->ioreset_bit;
402 case TEGRA_PINCONF_PARAM_RCV_SEL:
405 *bit = g->rcv_sel_bit;
408 case TEGRA_PINCONF_PARAM_HIGH_SPEED_MODE:
409 if (pmx->soc->hsm_in_mux) {
419 case TEGRA_PINCONF_PARAM_SCHMITT:
420 if (pmx->soc->schmitt_in_mux) {
427 *bit = g->schmitt_bit;
430 case TEGRA_PINCONF_PARAM_LOW_POWER_MODE:
436 case TEGRA_PINCONF_PARAM_DRIVE_DOWN_STRENGTH:
440 *width = g->drvdn_width;
442 case TEGRA_PINCONF_PARAM_DRIVE_UP_STRENGTH:
446 *width = g->drvup_width;
448 case TEGRA_PINCONF_PARAM_SLEW_RATE_FALLING:
452 *width = g->slwf_width;
454 case TEGRA_PINCONF_PARAM_SLEW_RATE_RISING:
458 *width = g->slwr_width;
460 case TEGRA_PINCONF_PARAM_DRIVE_TYPE:
461 if (pmx->soc->drvtype_in_mux) {
468 *bit = g->drvtype_bit;
472 dev_err(pmx->dev, "Invalid config param %04x\n", param);
476 if (*reg < 0 || *bit < 0) {
478 const char *prop = "unknown";
481 for (i = 0; i < ARRAY_SIZE(cfg_params); i++) {
482 if (cfg_params[i].param == param) {
483 prop = cfg_params[i].property;
489 "Config param %04x (%s) not supported on group %s\n",
490 param, prop, g->name);
498 static int tegra_pinconf_get(struct pinctrl_dev *pctldev,
499 unsigned pin, unsigned long *config)
501 dev_err(pctldev->dev, "pin_config_get op not supported\n");
505 static int tegra_pinconf_set(struct pinctrl_dev *pctldev,
506 unsigned pin, unsigned long *configs,
507 unsigned num_configs)
509 dev_err(pctldev->dev, "pin_config_set op not supported\n");
513 static int tegra_pinconf_group_get(struct pinctrl_dev *pctldev,
514 unsigned group, unsigned long *config)
516 struct tegra_pmx *pmx = pinctrl_dev_get_drvdata(pctldev);
517 enum tegra_pinconf_param param = TEGRA_PINCONF_UNPACK_PARAM(*config);
519 const struct tegra_pingroup *g;
525 g = &pmx->soc->groups[group];
527 ret = tegra_pinconf_reg(pmx, g, param, true, &bank, ®, &bit,
532 val = pmx_readl(pmx, bank, reg);
533 mask = (1 << width) - 1;
534 arg = (val >> bit) & mask;
536 *config = TEGRA_PINCONF_PACK(param, arg);
541 static int tegra_pinconf_group_set(struct pinctrl_dev *pctldev,
542 unsigned group, unsigned long *configs,
543 unsigned num_configs)
545 struct tegra_pmx *pmx = pinctrl_dev_get_drvdata(pctldev);
546 enum tegra_pinconf_param param;
548 const struct tegra_pingroup *g;
554 g = &pmx->soc->groups[group];
556 for (i = 0; i < num_configs; i++) {
557 param = TEGRA_PINCONF_UNPACK_PARAM(configs[i]);
558 arg = TEGRA_PINCONF_UNPACK_ARG(configs[i]);
560 ret = tegra_pinconf_reg(pmx, g, param, true, &bank, ®, &bit,
565 val = pmx_readl(pmx, bank, reg);
567 /* LOCK can't be cleared */
568 if (param == TEGRA_PINCONF_PARAM_LOCK) {
569 if ((val & BIT(bit)) && !arg) {
570 dev_err(pctldev->dev, "LOCK bit cannot be cleared\n");
575 /* Special-case Boolean values; allow any non-zero as true */
579 /* Range-check user-supplied value */
580 mask = (1 << width) - 1;
582 dev_err(pctldev->dev,
583 "config %lx: %x too big for %d bit register\n",
584 configs[i], arg, width);
588 /* Update register */
589 val &= ~(mask << bit);
591 pmx_writel(pmx, val, bank, reg);
592 } /* for each config */
597 #ifdef CONFIG_DEBUG_FS
598 static void tegra_pinconf_dbg_show(struct pinctrl_dev *pctldev,
599 struct seq_file *s, unsigned offset)
603 static const char *strip_prefix(const char *s)
605 const char *comma = strchr(s, ',');
612 static void tegra_pinconf_group_dbg_show(struct pinctrl_dev *pctldev,
613 struct seq_file *s, unsigned group)
615 struct tegra_pmx *pmx = pinctrl_dev_get_drvdata(pctldev);
616 const struct tegra_pingroup *g;
622 g = &pmx->soc->groups[group];
624 for (i = 0; i < ARRAY_SIZE(cfg_params); i++) {
625 ret = tegra_pinconf_reg(pmx, g, cfg_params[i].param, false,
626 &bank, ®, &bit, &width);
630 val = pmx_readl(pmx, bank, reg);
632 val &= (1 << width) - 1;
634 seq_printf(s, "\n\t%s=%u",
635 strip_prefix(cfg_params[i].property), val);
639 static void tegra_pinconf_config_dbg_show(struct pinctrl_dev *pctldev,
641 unsigned long config)
643 enum tegra_pinconf_param param = TEGRA_PINCONF_UNPACK_PARAM(config);
644 u16 arg = TEGRA_PINCONF_UNPACK_ARG(config);
645 const char *pname = "unknown";
648 for (i = 0; i < ARRAY_SIZE(cfg_params); i++) {
649 if (cfg_params[i].param == param) {
650 pname = cfg_params[i].property;
655 seq_printf(s, "%s=%d", strip_prefix(pname), arg);
659 static const struct pinconf_ops tegra_pinconf_ops = {
660 .pin_config_get = tegra_pinconf_get,
661 .pin_config_set = tegra_pinconf_set,
662 .pin_config_group_get = tegra_pinconf_group_get,
663 .pin_config_group_set = tegra_pinconf_group_set,
664 #ifdef CONFIG_DEBUG_FS
665 .pin_config_dbg_show = tegra_pinconf_dbg_show,
666 .pin_config_group_dbg_show = tegra_pinconf_group_dbg_show,
667 .pin_config_config_dbg_show = tegra_pinconf_config_dbg_show,
671 static struct pinctrl_gpio_range tegra_pinctrl_gpio_range = {
672 .name = "Tegra GPIOs",
677 static struct pinctrl_desc tegra_pinctrl_desc = {
678 .pctlops = &tegra_pinctrl_ops,
679 .pmxops = &tegra_pinmux_ops,
680 .confops = &tegra_pinconf_ops,
681 .owner = THIS_MODULE,
684 static void tegra_pinctrl_clear_parked_bits(struct tegra_pmx *pmx)
687 const struct tegra_pingroup *g;
690 for (i = 0; i < pmx->soc->ngroups; ++i) {
691 g = &pmx->soc->groups[i];
692 if (g->parked_bitmask > 0) {
693 unsigned int bank, reg;
695 if (g->mux_reg != -1) {
703 val = pmx_readl(pmx, bank, reg);
704 val &= ~g->parked_bitmask;
705 pmx_writel(pmx, val, bank, reg);
710 static size_t tegra_pinctrl_get_bank_size(struct device *dev,
711 unsigned int bank_id)
713 struct platform_device *pdev = to_platform_device(dev);
714 struct resource *res;
716 res = platform_get_resource(pdev, IORESOURCE_MEM, bank_id);
718 return resource_size(res) / 4;
721 static int tegra_pinctrl_suspend(struct device *dev)
723 struct tegra_pmx *pmx = dev_get_drvdata(dev);
724 u32 *backup_regs = pmx->backup_regs;
729 for (i = 0; i < pmx->nbanks; i++) {
730 bank_size = tegra_pinctrl_get_bank_size(dev, i);
732 for (k = 0; k < bank_size; k++)
733 *backup_regs++ = readl_relaxed(regs++);
736 return pinctrl_force_sleep(pmx->pctl);
739 static int tegra_pinctrl_resume(struct device *dev)
741 struct tegra_pmx *pmx = dev_get_drvdata(dev);
742 u32 *backup_regs = pmx->backup_regs;
747 for (i = 0; i < pmx->nbanks; i++) {
748 bank_size = tegra_pinctrl_get_bank_size(dev, i);
750 for (k = 0; k < bank_size; k++)
751 writel_relaxed(*backup_regs++, regs++);
754 /* flush all the prior writes */
755 readl_relaxed(pmx->regs[0]);
756 /* wait for pinctrl register read to complete */
761 const struct dev_pm_ops tegra_pinctrl_pm = {
762 .suspend_noirq = &tegra_pinctrl_suspend,
763 .resume_noirq = &tegra_pinctrl_resume
766 static bool tegra_pinctrl_gpio_node_has_range(struct tegra_pmx *pmx)
768 struct device_node *np;
769 bool has_prop = false;
771 np = of_find_compatible_node(NULL, NULL, pmx->soc->gpio_compatible);
775 has_prop = of_find_property(np, "gpio-ranges", NULL);
782 int tegra_pinctrl_probe(struct platform_device *pdev,
783 const struct tegra_pinctrl_soc_data *soc_data)
785 struct tegra_pmx *pmx;
786 struct resource *res;
788 const char **group_pins;
790 unsigned long backup_regs_size = 0;
792 pmx = devm_kzalloc(&pdev->dev, sizeof(*pmx), GFP_KERNEL);
796 pmx->dev = &pdev->dev;
800 * Each mux group will appear in 4 functions' list of groups.
801 * This over-allocates slightly, since not all groups are mux groups.
803 pmx->group_pins = devm_kcalloc(&pdev->dev,
804 soc_data->ngroups * 4, sizeof(*pmx->group_pins),
806 if (!pmx->group_pins)
809 group_pins = pmx->group_pins;
810 for (fn = 0; fn < soc_data->nfunctions; fn++) {
811 struct tegra_function *func = &soc_data->functions[fn];
813 func->groups = group_pins;
815 for (gn = 0; gn < soc_data->ngroups; gn++) {
816 const struct tegra_pingroup *g = &soc_data->groups[gn];
818 if (g->mux_reg == -1)
821 for (gfn = 0; gfn < 4; gfn++)
822 if (g->funcs[gfn] == fn)
827 BUG_ON(group_pins - pmx->group_pins >=
828 soc_data->ngroups * 4);
829 *group_pins++ = g->name;
834 tegra_pinctrl_gpio_range.npins = pmx->soc->ngpios;
835 tegra_pinctrl_desc.name = dev_name(&pdev->dev);
836 tegra_pinctrl_desc.pins = pmx->soc->pins;
837 tegra_pinctrl_desc.npins = pmx->soc->npins;
840 res = platform_get_resource(pdev, IORESOURCE_MEM, i);
843 backup_regs_size += resource_size(res);
847 pmx->regs = devm_kcalloc(&pdev->dev, pmx->nbanks, sizeof(*pmx->regs),
852 pmx->backup_regs = devm_kzalloc(&pdev->dev, backup_regs_size,
854 if (!pmx->backup_regs)
857 for (i = 0; i < pmx->nbanks; i++) {
858 pmx->regs[i] = devm_platform_ioremap_resource(pdev, i);
859 if (IS_ERR(pmx->regs[i]))
860 return PTR_ERR(pmx->regs[i]);
863 pmx->pctl = devm_pinctrl_register(&pdev->dev, &tegra_pinctrl_desc, pmx);
864 if (IS_ERR(pmx->pctl)) {
865 dev_err(&pdev->dev, "Couldn't register pinctrl driver\n");
866 return PTR_ERR(pmx->pctl);
869 tegra_pinctrl_clear_parked_bits(pmx);
871 if (pmx->soc->ngpios > 0 && !tegra_pinctrl_gpio_node_has_range(pmx))
872 pinctrl_add_gpio_range(pmx->pctl, &tegra_pinctrl_gpio_range);
874 platform_set_drvdata(pdev, pmx);
876 dev_dbg(&pdev->dev, "Probed Tegra pinctrl driver\n");