1 // SPDX-License-Identifier: GPL-2.0+
3 // pin-controller/pin-mux/pin-config/gpio-driver for Samsung's SoC's.
5 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
6 // http://www.samsung.com
7 // Copyright (c) 2012 Linaro Ltd
8 // http://www.linaro.org
10 // Author: Thomas Abraham <thomas.ab@samsung.com>
12 // This driver implements the Samsung pinctrl driver. It supports setting up of
13 // pinmux and pinconf configurations. The gpiolib interface is also included.
14 // External interrupt (gpio and wakeup) support are not included in this driver
15 // but provides extensions to which platform specific implementation of the gpio
16 // and wakeup interrupts can be hooked to.
18 #include <linux/init.h>
19 #include <linux/platform_device.h>
21 #include <linux/property.h>
22 #include <linux/slab.h>
23 #include <linux/err.h>
24 #include <linux/gpio/driver.h>
25 #include <linux/irqdomain.h>
26 #include <linux/of_device.h>
27 #include <linux/spinlock.h>
30 #include "pinctrl-samsung.h"
32 /* maximum number of the memory resources */
33 #define SAMSUNG_PINCTRL_NUM_RESOURCES 2
35 /* list of all possible config options supported */
36 static struct pin_config {
38 enum pincfg_type param;
40 { "samsung,pin-pud", PINCFG_TYPE_PUD },
41 { "samsung,pin-drv", PINCFG_TYPE_DRV },
42 { "samsung,pin-con-pdn", PINCFG_TYPE_CON_PDN },
43 { "samsung,pin-pud-pdn", PINCFG_TYPE_PUD_PDN },
44 { "samsung,pin-val", PINCFG_TYPE_DAT },
47 static unsigned int pin_base;
49 static int samsung_get_group_count(struct pinctrl_dev *pctldev)
51 struct samsung_pinctrl_drv_data *pmx = pinctrl_dev_get_drvdata(pctldev);
53 return pmx->nr_groups;
56 static const char *samsung_get_group_name(struct pinctrl_dev *pctldev,
59 struct samsung_pinctrl_drv_data *pmx = pinctrl_dev_get_drvdata(pctldev);
61 return pmx->pin_groups[group].name;
64 static int samsung_get_group_pins(struct pinctrl_dev *pctldev,
66 const unsigned **pins,
69 struct samsung_pinctrl_drv_data *pmx = pinctrl_dev_get_drvdata(pctldev);
71 *pins = pmx->pin_groups[group].pins;
72 *num_pins = pmx->pin_groups[group].num_pins;
77 static int reserve_map(struct device *dev, struct pinctrl_map **map,
78 unsigned *reserved_maps, unsigned *num_maps,
81 unsigned old_num = *reserved_maps;
82 unsigned new_num = *num_maps + reserve;
83 struct pinctrl_map *new_map;
85 if (old_num >= new_num)
88 new_map = krealloc(*map, sizeof(*new_map) * new_num, GFP_KERNEL);
92 memset(new_map + old_num, 0, (new_num - old_num) * sizeof(*new_map));
95 *reserved_maps = new_num;
100 static int add_map_mux(struct pinctrl_map **map, unsigned *reserved_maps,
101 unsigned *num_maps, const char *group,
102 const char *function)
104 if (WARN_ON(*num_maps == *reserved_maps))
107 (*map)[*num_maps].type = PIN_MAP_TYPE_MUX_GROUP;
108 (*map)[*num_maps].data.mux.group = group;
109 (*map)[*num_maps].data.mux.function = function;
115 static int add_map_configs(struct device *dev, struct pinctrl_map **map,
116 unsigned *reserved_maps, unsigned *num_maps,
117 const char *group, unsigned long *configs,
118 unsigned num_configs)
120 unsigned long *dup_configs;
122 if (WARN_ON(*num_maps == *reserved_maps))
125 dup_configs = kmemdup(configs, num_configs * sizeof(*dup_configs),
130 (*map)[*num_maps].type = PIN_MAP_TYPE_CONFIGS_GROUP;
131 (*map)[*num_maps].data.configs.group_or_pin = group;
132 (*map)[*num_maps].data.configs.configs = dup_configs;
133 (*map)[*num_maps].data.configs.num_configs = num_configs;
139 static int add_config(struct device *dev, unsigned long **configs,
140 unsigned *num_configs, unsigned long config)
142 unsigned old_num = *num_configs;
143 unsigned new_num = old_num + 1;
144 unsigned long *new_configs;
146 new_configs = krealloc(*configs, sizeof(*new_configs) * new_num,
151 new_configs[old_num] = config;
153 *configs = new_configs;
154 *num_configs = new_num;
159 static void samsung_dt_free_map(struct pinctrl_dev *pctldev,
160 struct pinctrl_map *map,
165 for (i = 0; i < num_maps; i++)
166 if (map[i].type == PIN_MAP_TYPE_CONFIGS_GROUP)
167 kfree(map[i].data.configs.configs);
172 static int samsung_dt_subnode_to_map(struct samsung_pinctrl_drv_data *drvdata,
174 struct device_node *np,
175 struct pinctrl_map **map,
176 unsigned *reserved_maps,
181 unsigned long config;
182 unsigned long *configs = NULL;
183 unsigned num_configs = 0;
185 struct property *prop;
187 bool has_func = false;
189 ret = of_property_read_u32(np, "samsung,pin-function", &val);
193 for (i = 0; i < ARRAY_SIZE(cfg_params); i++) {
194 ret = of_property_read_u32(np, cfg_params[i].property, &val);
196 config = PINCFG_PACK(cfg_params[i].param, val);
197 ret = add_config(dev, &configs, &num_configs, config);
200 /* EINVAL=missing, which is fine since it's optional */
201 } else if (ret != -EINVAL) {
202 dev_err(dev, "could not parse property %s\n",
203 cfg_params[i].property);
212 ret = of_property_count_strings(np, "samsung,pins");
214 dev_err(dev, "could not parse property samsung,pins\n");
219 ret = reserve_map(dev, map, reserved_maps, num_maps, reserve);
223 of_property_for_each_string(np, "samsung,pins", prop, group) {
225 ret = add_map_mux(map, reserved_maps,
226 num_maps, group, np->full_name);
232 ret = add_map_configs(dev, map, reserved_maps,
233 num_maps, group, configs,
247 static int samsung_dt_node_to_map(struct pinctrl_dev *pctldev,
248 struct device_node *np_config,
249 struct pinctrl_map **map,
252 struct samsung_pinctrl_drv_data *drvdata;
253 unsigned reserved_maps;
254 struct device_node *np;
257 drvdata = pinctrl_dev_get_drvdata(pctldev);
263 if (!of_get_child_count(np_config))
264 return samsung_dt_subnode_to_map(drvdata, pctldev->dev,
269 for_each_child_of_node(np_config, np) {
270 ret = samsung_dt_subnode_to_map(drvdata, pctldev->dev, np, map,
271 &reserved_maps, num_maps);
273 samsung_dt_free_map(pctldev, *map, *num_maps);
282 #ifdef CONFIG_DEBUG_FS
283 /* Forward declaration which can be used by samsung_pin_dbg_show */
284 static int samsung_pinconf_get(struct pinctrl_dev *pctldev, unsigned int pin,
285 unsigned long *config);
286 static const char * const reg_names[] = {"CON", "DAT", "PUD", "DRV", "CON_PDN",
289 static void samsung_pin_dbg_show(struct pinctrl_dev *pctldev,
290 struct seq_file *s, unsigned int pin)
292 enum pincfg_type cfg_type;
293 unsigned long config;
296 for (cfg_type = 0; cfg_type < PINCFG_TYPE_NUM; cfg_type++) {
297 config = PINCFG_PACK(cfg_type, 0);
298 ret = samsung_pinconf_get(pctldev, pin, &config);
302 seq_printf(s, " %s(0x%lx)", reg_names[cfg_type],
303 PINCFG_UNPACK_VALUE(config));
308 /* list of pinctrl callbacks for the pinctrl core */
309 static const struct pinctrl_ops samsung_pctrl_ops = {
310 .get_groups_count = samsung_get_group_count,
311 .get_group_name = samsung_get_group_name,
312 .get_group_pins = samsung_get_group_pins,
313 .dt_node_to_map = samsung_dt_node_to_map,
314 .dt_free_map = samsung_dt_free_map,
315 #ifdef CONFIG_DEBUG_FS
316 .pin_dbg_show = samsung_pin_dbg_show,
320 /* check if the selector is a valid pin function selector */
321 static int samsung_get_functions_count(struct pinctrl_dev *pctldev)
323 struct samsung_pinctrl_drv_data *drvdata;
325 drvdata = pinctrl_dev_get_drvdata(pctldev);
326 return drvdata->nr_functions;
329 /* return the name of the pin function specified */
330 static const char *samsung_pinmux_get_fname(struct pinctrl_dev *pctldev,
333 struct samsung_pinctrl_drv_data *drvdata;
335 drvdata = pinctrl_dev_get_drvdata(pctldev);
336 return drvdata->pmx_functions[selector].name;
339 /* return the groups associated for the specified function selector */
340 static int samsung_pinmux_get_groups(struct pinctrl_dev *pctldev,
341 unsigned selector, const char * const **groups,
342 unsigned * const num_groups)
344 struct samsung_pinctrl_drv_data *drvdata;
346 drvdata = pinctrl_dev_get_drvdata(pctldev);
347 *groups = drvdata->pmx_functions[selector].groups;
348 *num_groups = drvdata->pmx_functions[selector].num_groups;
353 * given a pin number that is local to a pin controller, find out the pin bank
354 * and the register base of the pin bank.
356 static void pin_to_reg_bank(struct samsung_pinctrl_drv_data *drvdata,
357 unsigned pin, void __iomem **reg, u32 *offset,
358 struct samsung_pin_bank **bank)
360 struct samsung_pin_bank *b;
362 b = drvdata->pin_banks;
364 while ((pin >= b->pin_base) &&
365 ((b->pin_base + b->nr_pins - 1) < pin))
368 *reg = b->pctl_base + b->pctl_offset;
369 *offset = pin - b->pin_base;
374 /* enable or disable a pinmux function */
375 static void samsung_pinmux_setup(struct pinctrl_dev *pctldev, unsigned selector,
378 struct samsung_pinctrl_drv_data *drvdata;
379 const struct samsung_pin_bank_type *type;
380 struct samsung_pin_bank *bank;
382 u32 mask, shift, data, pin_offset;
384 const struct samsung_pmx_func *func;
385 const struct samsung_pin_group *grp;
387 drvdata = pinctrl_dev_get_drvdata(pctldev);
388 func = &drvdata->pmx_functions[selector];
389 grp = &drvdata->pin_groups[group];
391 pin_to_reg_bank(drvdata, grp->pins[0] - drvdata->pin_base,
392 ®, &pin_offset, &bank);
394 mask = (1 << type->fld_width[PINCFG_TYPE_FUNC]) - 1;
395 shift = pin_offset * type->fld_width[PINCFG_TYPE_FUNC];
397 /* Some banks have two config registers */
402 raw_spin_lock_irqsave(&bank->slock, flags);
404 data = readl(reg + type->reg_offset[PINCFG_TYPE_FUNC]);
405 data &= ~(mask << shift);
406 data |= func->val << shift;
407 writel(data, reg + type->reg_offset[PINCFG_TYPE_FUNC]);
409 raw_spin_unlock_irqrestore(&bank->slock, flags);
412 /* enable a specified pinmux by writing to registers */
413 static int samsung_pinmux_set_mux(struct pinctrl_dev *pctldev,
417 samsung_pinmux_setup(pctldev, selector, group);
421 /* list of pinmux callbacks for the pinmux vertical in pinctrl core */
422 static const struct pinmux_ops samsung_pinmux_ops = {
423 .get_functions_count = samsung_get_functions_count,
424 .get_function_name = samsung_pinmux_get_fname,
425 .get_function_groups = samsung_pinmux_get_groups,
426 .set_mux = samsung_pinmux_set_mux,
429 /* set or get the pin config settings for a specified pin */
430 static int samsung_pinconf_rw(struct pinctrl_dev *pctldev, unsigned int pin,
431 unsigned long *config, bool set)
433 struct samsung_pinctrl_drv_data *drvdata;
434 const struct samsung_pin_bank_type *type;
435 struct samsung_pin_bank *bank;
436 void __iomem *reg_base;
437 enum pincfg_type cfg_type = PINCFG_UNPACK_TYPE(*config);
438 u32 data, width, pin_offset, mask, shift;
439 u32 cfg_value, cfg_reg;
442 drvdata = pinctrl_dev_get_drvdata(pctldev);
443 pin_to_reg_bank(drvdata, pin - drvdata->pin_base, ®_base,
447 if (cfg_type >= PINCFG_TYPE_NUM || !type->fld_width[cfg_type])
450 width = type->fld_width[cfg_type];
451 cfg_reg = type->reg_offset[cfg_type];
453 raw_spin_lock_irqsave(&bank->slock, flags);
455 mask = (1 << width) - 1;
456 shift = pin_offset * width;
457 data = readl(reg_base + cfg_reg);
460 cfg_value = PINCFG_UNPACK_VALUE(*config);
461 data &= ~(mask << shift);
462 data |= (cfg_value << shift);
463 writel(data, reg_base + cfg_reg);
467 *config = PINCFG_PACK(cfg_type, data);
470 raw_spin_unlock_irqrestore(&bank->slock, flags);
475 /* set the pin config settings for a specified pin */
476 static int samsung_pinconf_set(struct pinctrl_dev *pctldev, unsigned int pin,
477 unsigned long *configs, unsigned num_configs)
481 for (i = 0; i < num_configs; i++) {
482 ret = samsung_pinconf_rw(pctldev, pin, &configs[i], true);
485 } /* for each config */
490 /* get the pin config settings for a specified pin */
491 static int samsung_pinconf_get(struct pinctrl_dev *pctldev, unsigned int pin,
492 unsigned long *config)
494 return samsung_pinconf_rw(pctldev, pin, config, false);
497 /* set the pin config settings for a specified pin group */
498 static int samsung_pinconf_group_set(struct pinctrl_dev *pctldev,
499 unsigned group, unsigned long *configs,
500 unsigned num_configs)
502 struct samsung_pinctrl_drv_data *drvdata;
503 const unsigned int *pins;
506 drvdata = pinctrl_dev_get_drvdata(pctldev);
507 pins = drvdata->pin_groups[group].pins;
509 for (cnt = 0; cnt < drvdata->pin_groups[group].num_pins; cnt++)
510 samsung_pinconf_set(pctldev, pins[cnt], configs, num_configs);
515 /* get the pin config settings for a specified pin group */
516 static int samsung_pinconf_group_get(struct pinctrl_dev *pctldev,
517 unsigned int group, unsigned long *config)
519 struct samsung_pinctrl_drv_data *drvdata;
520 const unsigned int *pins;
522 drvdata = pinctrl_dev_get_drvdata(pctldev);
523 pins = drvdata->pin_groups[group].pins;
524 samsung_pinconf_get(pctldev, pins[0], config);
528 /* list of pinconfig callbacks for pinconfig vertical in the pinctrl code */
529 static const struct pinconf_ops samsung_pinconf_ops = {
530 .pin_config_get = samsung_pinconf_get,
531 .pin_config_set = samsung_pinconf_set,
532 .pin_config_group_get = samsung_pinconf_group_get,
533 .pin_config_group_set = samsung_pinconf_group_set,
537 * The samsung_gpio_set_vlaue() should be called with "bank->slock" held
538 * to avoid race condition.
540 static void samsung_gpio_set_value(struct gpio_chip *gc,
541 unsigned offset, int value)
543 struct samsung_pin_bank *bank = gpiochip_get_data(gc);
544 const struct samsung_pin_bank_type *type = bank->type;
548 reg = bank->pctl_base + bank->pctl_offset;
550 data = readl(reg + type->reg_offset[PINCFG_TYPE_DAT]);
551 data &= ~(1 << offset);
554 writel(data, reg + type->reg_offset[PINCFG_TYPE_DAT]);
557 /* gpiolib gpio_set callback function */
558 static void samsung_gpio_set(struct gpio_chip *gc, unsigned offset, int value)
560 struct samsung_pin_bank *bank = gpiochip_get_data(gc);
563 raw_spin_lock_irqsave(&bank->slock, flags);
564 samsung_gpio_set_value(gc, offset, value);
565 raw_spin_unlock_irqrestore(&bank->slock, flags);
568 /* gpiolib gpio_get callback function */
569 static int samsung_gpio_get(struct gpio_chip *gc, unsigned offset)
573 struct samsung_pin_bank *bank = gpiochip_get_data(gc);
574 const struct samsung_pin_bank_type *type = bank->type;
576 reg = bank->pctl_base + bank->pctl_offset;
578 data = readl(reg + type->reg_offset[PINCFG_TYPE_DAT]);
585 * The samsung_gpio_set_direction() should be called with "bank->slock" held
586 * to avoid race condition.
587 * The calls to gpio_direction_output() and gpio_direction_input()
588 * leads to this function call.
590 static int samsung_gpio_set_direction(struct gpio_chip *gc,
591 unsigned offset, bool input)
593 const struct samsung_pin_bank_type *type;
594 struct samsung_pin_bank *bank;
596 u32 data, mask, shift;
598 bank = gpiochip_get_data(gc);
601 reg = bank->pctl_base + bank->pctl_offset
602 + type->reg_offset[PINCFG_TYPE_FUNC];
604 mask = (1 << type->fld_width[PINCFG_TYPE_FUNC]) - 1;
605 shift = offset * type->fld_width[PINCFG_TYPE_FUNC];
607 /* Some banks have two config registers */
613 data &= ~(mask << shift);
615 data |= PIN_CON_FUNC_OUTPUT << shift;
621 /* gpiolib gpio_direction_input callback function. */
622 static int samsung_gpio_direction_input(struct gpio_chip *gc, unsigned offset)
624 struct samsung_pin_bank *bank = gpiochip_get_data(gc);
628 raw_spin_lock_irqsave(&bank->slock, flags);
629 ret = samsung_gpio_set_direction(gc, offset, true);
630 raw_spin_unlock_irqrestore(&bank->slock, flags);
634 /* gpiolib gpio_direction_output callback function. */
635 static int samsung_gpio_direction_output(struct gpio_chip *gc, unsigned offset,
638 struct samsung_pin_bank *bank = gpiochip_get_data(gc);
642 raw_spin_lock_irqsave(&bank->slock, flags);
643 samsung_gpio_set_value(gc, offset, value);
644 ret = samsung_gpio_set_direction(gc, offset, false);
645 raw_spin_unlock_irqrestore(&bank->slock, flags);
651 * gpiolib gpio_to_irq callback function. Creates a mapping between a GPIO pin
652 * and a virtual IRQ, if not already present.
654 static int samsung_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
656 struct samsung_pin_bank *bank = gpiochip_get_data(gc);
659 if (!bank->irq_domain)
662 virq = irq_create_mapping(bank->irq_domain, offset);
664 return (virq) ? : -ENXIO;
667 static struct samsung_pin_group *samsung_pinctrl_create_groups(
669 struct samsung_pinctrl_drv_data *drvdata,
672 struct pinctrl_desc *ctrldesc = &drvdata->pctl;
673 struct samsung_pin_group *groups, *grp;
674 const struct pinctrl_pin_desc *pdesc;
677 groups = devm_kcalloc(dev, ctrldesc->npins, sizeof(*groups),
680 return ERR_PTR(-EINVAL);
683 pdesc = ctrldesc->pins;
684 for (i = 0; i < ctrldesc->npins; ++i, ++pdesc, ++grp) {
685 grp->name = pdesc->name;
686 grp->pins = &pdesc->number;
690 *cnt = ctrldesc->npins;
694 static int samsung_pinctrl_create_function(struct device *dev,
695 struct samsung_pinctrl_drv_data *drvdata,
696 struct device_node *func_np,
697 struct samsung_pmx_func *func)
703 if (of_property_read_u32(func_np, "samsung,pin-function", &func->val))
706 npins = of_property_count_strings(func_np, "samsung,pins");
708 dev_err(dev, "invalid pin list in %pOFn node", func_np);
712 func->name = func_np->full_name;
714 func->groups = devm_kcalloc(dev, npins, sizeof(char *), GFP_KERNEL);
718 for (i = 0; i < npins; ++i) {
721 ret = of_property_read_string_index(func_np, "samsung,pins",
725 "failed to read pin name %d from %pOFn node\n",
730 func->groups[i] = gname;
733 func->num_groups = npins;
737 static struct samsung_pmx_func *samsung_pinctrl_create_functions(
739 struct samsung_pinctrl_drv_data *drvdata,
742 struct samsung_pmx_func *functions, *func;
743 struct device_node *dev_np = dev->of_node;
744 struct device_node *cfg_np;
745 unsigned int func_cnt = 0;
749 * Iterate over all the child nodes of the pin controller node
750 * and create pin groups and pin function lists.
752 for_each_child_of_node(dev_np, cfg_np) {
753 struct device_node *func_np;
755 if (!of_get_child_count(cfg_np)) {
756 if (!of_find_property(cfg_np,
757 "samsung,pin-function", NULL))
763 for_each_child_of_node(cfg_np, func_np) {
764 if (!of_find_property(func_np,
765 "samsung,pin-function", NULL))
771 functions = devm_kcalloc(dev, func_cnt, sizeof(*functions),
774 return ERR_PTR(-ENOMEM);
778 * Iterate over all the child nodes of the pin controller node
779 * and create pin groups and pin function lists.
782 for_each_child_of_node(dev_np, cfg_np) {
783 struct device_node *func_np;
785 if (!of_get_child_count(cfg_np)) {
786 ret = samsung_pinctrl_create_function(dev, drvdata,
799 for_each_child_of_node(cfg_np, func_np) {
800 ret = samsung_pinctrl_create_function(dev, drvdata,
803 of_node_put(func_np);
819 * Parse the information about all the available pin groups and pin functions
820 * from device node of the pin-controller. A pin group is formed with all
821 * the pins listed in the "samsung,pins" property.
824 static int samsung_pinctrl_parse_dt(struct platform_device *pdev,
825 struct samsung_pinctrl_drv_data *drvdata)
827 struct device *dev = &pdev->dev;
828 struct samsung_pin_group *groups;
829 struct samsung_pmx_func *functions;
830 unsigned int grp_cnt = 0, func_cnt = 0;
832 groups = samsung_pinctrl_create_groups(dev, drvdata, &grp_cnt);
833 if (IS_ERR(groups)) {
834 dev_err(dev, "failed to parse pin groups\n");
835 return PTR_ERR(groups);
838 functions = samsung_pinctrl_create_functions(dev, drvdata, &func_cnt);
839 if (IS_ERR(functions)) {
840 dev_err(dev, "failed to parse pin functions\n");
841 return PTR_ERR(functions);
844 drvdata->pin_groups = groups;
845 drvdata->nr_groups = grp_cnt;
846 drvdata->pmx_functions = functions;
847 drvdata->nr_functions = func_cnt;
852 /* register the pinctrl interface with the pinctrl subsystem */
853 static int samsung_pinctrl_register(struct platform_device *pdev,
854 struct samsung_pinctrl_drv_data *drvdata)
856 struct pinctrl_desc *ctrldesc = &drvdata->pctl;
857 struct pinctrl_pin_desc *pindesc, *pdesc;
858 struct samsung_pin_bank *pin_bank;
862 ctrldesc->name = "samsung-pinctrl";
863 ctrldesc->owner = THIS_MODULE;
864 ctrldesc->pctlops = &samsung_pctrl_ops;
865 ctrldesc->pmxops = &samsung_pinmux_ops;
866 ctrldesc->confops = &samsung_pinconf_ops;
868 pindesc = devm_kcalloc(&pdev->dev,
869 drvdata->nr_pins, sizeof(*pindesc),
873 ctrldesc->pins = pindesc;
874 ctrldesc->npins = drvdata->nr_pins;
876 /* dynamically populate the pin number and pin name for pindesc */
877 for (pin = 0, pdesc = pindesc; pin < ctrldesc->npins; pin++, pdesc++)
878 pdesc->number = pin + drvdata->pin_base;
881 * allocate space for storing the dynamically generated names for all
882 * the pins which belong to this pin-controller.
884 pin_names = devm_kzalloc(&pdev->dev,
885 array3_size(sizeof(char), PIN_NAME_LENGTH,
891 /* for each pin, the name of the pin is pin-bank name + pin number */
892 for (bank = 0; bank < drvdata->nr_banks; bank++) {
893 pin_bank = &drvdata->pin_banks[bank];
894 for (pin = 0; pin < pin_bank->nr_pins; pin++) {
895 sprintf(pin_names, "%s-%d", pin_bank->name, pin);
896 pdesc = pindesc + pin_bank->pin_base + pin;
897 pdesc->name = pin_names;
898 pin_names += PIN_NAME_LENGTH;
902 ret = samsung_pinctrl_parse_dt(pdev, drvdata);
906 drvdata->pctl_dev = devm_pinctrl_register(&pdev->dev, ctrldesc,
908 if (IS_ERR(drvdata->pctl_dev)) {
909 dev_err(&pdev->dev, "could not register pinctrl driver\n");
910 return PTR_ERR(drvdata->pctl_dev);
913 for (bank = 0; bank < drvdata->nr_banks; ++bank) {
914 pin_bank = &drvdata->pin_banks[bank];
915 pin_bank->grange.name = pin_bank->name;
916 pin_bank->grange.id = bank;
917 pin_bank->grange.pin_base = drvdata->pin_base
918 + pin_bank->pin_base;
919 pin_bank->grange.base = pin_bank->grange.pin_base;
920 pin_bank->grange.npins = pin_bank->nr_pins;
921 pin_bank->grange.gc = &pin_bank->gpio_chip;
922 pinctrl_add_gpio_range(drvdata->pctl_dev, &pin_bank->grange);
928 /* unregister the pinctrl interface with the pinctrl subsystem */
929 static int samsung_pinctrl_unregister(struct platform_device *pdev,
930 struct samsung_pinctrl_drv_data *drvdata)
932 struct samsung_pin_bank *bank = drvdata->pin_banks;
935 for (i = 0; i < drvdata->nr_banks; ++i, ++bank)
936 pinctrl_remove_gpio_range(drvdata->pctl_dev, &bank->grange);
941 static const struct gpio_chip samsung_gpiolib_chip = {
942 .request = gpiochip_generic_request,
943 .free = gpiochip_generic_free,
944 .set = samsung_gpio_set,
945 .get = samsung_gpio_get,
946 .direction_input = samsung_gpio_direction_input,
947 .direction_output = samsung_gpio_direction_output,
948 .to_irq = samsung_gpio_to_irq,
949 .owner = THIS_MODULE,
952 /* register the gpiolib interface with the gpiolib subsystem */
953 static int samsung_gpiolib_register(struct platform_device *pdev,
954 struct samsung_pinctrl_drv_data *drvdata)
956 struct samsung_pin_bank *bank = drvdata->pin_banks;
957 struct gpio_chip *gc;
961 for (i = 0; i < drvdata->nr_banks; ++i, ++bank) {
962 bank->gpio_chip = samsung_gpiolib_chip;
964 gc = &bank->gpio_chip;
965 gc->base = bank->grange.base;
966 gc->ngpio = bank->nr_pins;
967 gc->parent = &pdev->dev;
968 gc->fwnode = bank->fwnode;
969 gc->label = bank->name;
971 ret = devm_gpiochip_add_data(&pdev->dev, gc, bank);
973 dev_err(&pdev->dev, "failed to register gpio_chip %s, error code: %d\n",
982 static const struct samsung_pin_ctrl *
983 samsung_pinctrl_get_soc_data_for_of_alias(struct platform_device *pdev)
985 struct device_node *node = pdev->dev.of_node;
986 const struct samsung_pinctrl_of_match_data *of_data;
989 id = of_alias_get_id(node, "pinctrl");
991 dev_err(&pdev->dev, "failed to get alias id\n");
995 of_data = of_device_get_match_data(&pdev->dev);
996 if (id >= of_data->num_ctrl) {
997 dev_err(&pdev->dev, "invalid alias id %d\n", id);
1001 return &(of_data->ctrl[id]);
1004 static void samsung_banks_node_put(struct samsung_pinctrl_drv_data *d)
1006 struct samsung_pin_bank *bank;
1009 bank = d->pin_banks;
1010 for (i = 0; i < d->nr_banks; ++i, ++bank)
1011 fwnode_handle_put(bank->fwnode);
1015 * Iterate over all driver pin banks to find one matching the name of node,
1016 * skipping optional "-gpio" node suffix. When found, assign node to the bank.
1018 static void samsung_banks_node_get(struct device *dev, struct samsung_pinctrl_drv_data *d)
1020 const char *suffix = "-gpio-bank";
1021 struct samsung_pin_bank *bank;
1022 struct fwnode_handle *child;
1023 /* Pin bank names are up to 4 characters */
1028 bank = d->pin_banks;
1029 for (i = 0; i < d->nr_banks; ++i, ++bank) {
1030 strscpy(node_name, bank->name, sizeof(node_name));
1031 len = strlcat(node_name, suffix, sizeof(node_name));
1032 if (len >= sizeof(node_name)) {
1033 dev_err(dev, "Too long pin bank name '%s', ignoring\n",
1038 for_each_gpiochip_node(dev, child) {
1039 struct device_node *np = to_of_node(child);
1041 if (of_node_name_eq(np, node_name))
1043 if (of_node_name_eq(np, bank->name))
1048 bank->fwnode = child;
1050 dev_warn(dev, "Missing node for bank %s - invalid DTB\n",
1052 /* child reference dropped in samsung_drop_banks_of_node() */
1056 /* retrieve the soc specific data */
1057 static const struct samsung_pin_ctrl *
1058 samsung_pinctrl_get_soc_data(struct samsung_pinctrl_drv_data *d,
1059 struct platform_device *pdev)
1061 const struct samsung_pin_bank_data *bdata;
1062 const struct samsung_pin_ctrl *ctrl;
1063 struct samsung_pin_bank *bank;
1064 struct resource *res;
1065 void __iomem *virt_base[SAMSUNG_PINCTRL_NUM_RESOURCES];
1068 ctrl = samsung_pinctrl_get_soc_data_for_of_alias(pdev);
1070 return ERR_PTR(-ENOENT);
1072 d->suspend = ctrl->suspend;
1073 d->resume = ctrl->resume;
1074 d->nr_banks = ctrl->nr_banks;
1075 d->pin_banks = devm_kcalloc(&pdev->dev, d->nr_banks,
1076 sizeof(*d->pin_banks), GFP_KERNEL);
1078 return ERR_PTR(-ENOMEM);
1080 if (ctrl->nr_ext_resources + 1 > SAMSUNG_PINCTRL_NUM_RESOURCES)
1081 return ERR_PTR(-EINVAL);
1083 for (i = 0; i < ctrl->nr_ext_resources + 1; i++) {
1084 res = platform_get_resource(pdev, IORESOURCE_MEM, i);
1086 dev_err(&pdev->dev, "failed to get mem%d resource\n", i);
1087 return ERR_PTR(-EINVAL);
1089 virt_base[i] = devm_ioremap(&pdev->dev, res->start,
1090 resource_size(res));
1091 if (!virt_base[i]) {
1092 dev_err(&pdev->dev, "failed to ioremap %pR\n", res);
1093 return ERR_PTR(-EIO);
1097 bank = d->pin_banks;
1098 bdata = ctrl->pin_banks;
1099 for (i = 0; i < ctrl->nr_banks; ++i, ++bdata, ++bank) {
1100 bank->type = bdata->type;
1101 bank->pctl_offset = bdata->pctl_offset;
1102 bank->nr_pins = bdata->nr_pins;
1103 bank->eint_func = bdata->eint_func;
1104 bank->eint_type = bdata->eint_type;
1105 bank->eint_mask = bdata->eint_mask;
1106 bank->eint_offset = bdata->eint_offset;
1107 bank->name = bdata->name;
1109 raw_spin_lock_init(&bank->slock);
1111 bank->pin_base = d->nr_pins;
1112 d->nr_pins += bank->nr_pins;
1114 bank->eint_base = virt_base[0];
1115 bank->pctl_base = virt_base[bdata->pctl_res_idx];
1118 * Legacy platforms should provide only one resource with IO memory.
1119 * Store it as virt_base because legacy driver needs to access it
1120 * through samsung_pinctrl_drv_data.
1122 d->virt_base = virt_base[0];
1124 samsung_banks_node_get(&pdev->dev, d);
1126 d->pin_base = pin_base;
1127 pin_base += d->nr_pins;
1132 static int samsung_pinctrl_probe(struct platform_device *pdev)
1134 struct samsung_pinctrl_drv_data *drvdata;
1135 const struct samsung_pin_ctrl *ctrl;
1136 struct device *dev = &pdev->dev;
1139 drvdata = devm_kzalloc(dev, sizeof(*drvdata), GFP_KERNEL);
1143 ctrl = samsung_pinctrl_get_soc_data(drvdata, pdev);
1145 dev_err(&pdev->dev, "driver data not available\n");
1146 return PTR_ERR(ctrl);
1150 ret = platform_get_irq_optional(pdev, 0);
1151 if (ret < 0 && ret != -ENXIO)
1156 if (ctrl->retention_data) {
1157 drvdata->retention_ctrl = ctrl->retention_data->init(drvdata,
1158 ctrl->retention_data);
1159 if (IS_ERR(drvdata->retention_ctrl)) {
1160 ret = PTR_ERR(drvdata->retention_ctrl);
1165 ret = samsung_pinctrl_register(pdev, drvdata);
1169 if (ctrl->eint_gpio_init)
1170 ctrl->eint_gpio_init(drvdata);
1171 if (ctrl->eint_wkup_init)
1172 ctrl->eint_wkup_init(drvdata);
1174 ret = samsung_gpiolib_register(pdev, drvdata);
1176 goto err_unregister;
1178 platform_set_drvdata(pdev, drvdata);
1183 samsung_pinctrl_unregister(pdev, drvdata);
1185 samsung_banks_node_put(drvdata);
1190 * samsung_pinctrl_suspend - save pinctrl state for suspend
1192 * Save data for all banks handled by this device.
1194 static int __maybe_unused samsung_pinctrl_suspend(struct device *dev)
1196 struct samsung_pinctrl_drv_data *drvdata = dev_get_drvdata(dev);
1199 for (i = 0; i < drvdata->nr_banks; i++) {
1200 struct samsung_pin_bank *bank = &drvdata->pin_banks[i];
1201 void __iomem *reg = bank->pctl_base + bank->pctl_offset;
1202 const u8 *offs = bank->type->reg_offset;
1203 const u8 *widths = bank->type->fld_width;
1204 enum pincfg_type type;
1206 /* Registers without a powerdown config aren't lost */
1207 if (!widths[PINCFG_TYPE_CON_PDN])
1210 for (type = 0; type < PINCFG_TYPE_NUM; type++)
1212 bank->pm_save[type] = readl(reg + offs[type]);
1214 if (widths[PINCFG_TYPE_FUNC] * bank->nr_pins > 32) {
1215 /* Some banks have two config registers */
1216 bank->pm_save[PINCFG_TYPE_NUM] =
1217 readl(reg + offs[PINCFG_TYPE_FUNC] + 4);
1218 pr_debug("Save %s @ %p (con %#010x %08x)\n",
1220 bank->pm_save[PINCFG_TYPE_FUNC],
1221 bank->pm_save[PINCFG_TYPE_NUM]);
1223 pr_debug("Save %s @ %p (con %#010x)\n", bank->name,
1224 reg, bank->pm_save[PINCFG_TYPE_FUNC]);
1228 if (drvdata->suspend)
1229 drvdata->suspend(drvdata);
1230 if (drvdata->retention_ctrl && drvdata->retention_ctrl->enable)
1231 drvdata->retention_ctrl->enable(drvdata);
1237 * samsung_pinctrl_resume - restore pinctrl state from suspend
1239 * Restore one of the banks that was saved during suspend.
1241 * We don't bother doing anything complicated to avoid glitching lines since
1242 * we're called before pad retention is turned off.
1244 static int __maybe_unused samsung_pinctrl_resume(struct device *dev)
1246 struct samsung_pinctrl_drv_data *drvdata = dev_get_drvdata(dev);
1249 if (drvdata->resume)
1250 drvdata->resume(drvdata);
1252 for (i = 0; i < drvdata->nr_banks; i++) {
1253 struct samsung_pin_bank *bank = &drvdata->pin_banks[i];
1254 void __iomem *reg = bank->pctl_base + bank->pctl_offset;
1255 const u8 *offs = bank->type->reg_offset;
1256 const u8 *widths = bank->type->fld_width;
1257 enum pincfg_type type;
1259 /* Registers without a powerdown config aren't lost */
1260 if (!widths[PINCFG_TYPE_CON_PDN])
1263 if (widths[PINCFG_TYPE_FUNC] * bank->nr_pins > 32) {
1264 /* Some banks have two config registers */
1265 pr_debug("%s @ %p (con %#010x %08x => %#010x %08x)\n",
1267 readl(reg + offs[PINCFG_TYPE_FUNC]),
1268 readl(reg + offs[PINCFG_TYPE_FUNC] + 4),
1269 bank->pm_save[PINCFG_TYPE_FUNC],
1270 bank->pm_save[PINCFG_TYPE_NUM]);
1271 writel(bank->pm_save[PINCFG_TYPE_NUM],
1272 reg + offs[PINCFG_TYPE_FUNC] + 4);
1274 pr_debug("%s @ %p (con %#010x => %#010x)\n", bank->name,
1275 reg, readl(reg + offs[PINCFG_TYPE_FUNC]),
1276 bank->pm_save[PINCFG_TYPE_FUNC]);
1278 for (type = 0; type < PINCFG_TYPE_NUM; type++)
1280 writel(bank->pm_save[type], reg + offs[type]);
1283 if (drvdata->retention_ctrl && drvdata->retention_ctrl->disable)
1284 drvdata->retention_ctrl->disable(drvdata);
1289 static const struct of_device_id samsung_pinctrl_dt_match[] = {
1290 #ifdef CONFIG_PINCTRL_EXYNOS_ARM
1291 { .compatible = "samsung,exynos3250-pinctrl",
1292 .data = &exynos3250_of_data },
1293 { .compatible = "samsung,exynos4210-pinctrl",
1294 .data = &exynos4210_of_data },
1295 { .compatible = "samsung,exynos4x12-pinctrl",
1296 .data = &exynos4x12_of_data },
1297 { .compatible = "samsung,exynos5250-pinctrl",
1298 .data = &exynos5250_of_data },
1299 { .compatible = "samsung,exynos5260-pinctrl",
1300 .data = &exynos5260_of_data },
1301 { .compatible = "samsung,exynos5410-pinctrl",
1302 .data = &exynos5410_of_data },
1303 { .compatible = "samsung,exynos5420-pinctrl",
1304 .data = &exynos5420_of_data },
1305 { .compatible = "samsung,s5pv210-pinctrl",
1306 .data = &s5pv210_of_data },
1308 #ifdef CONFIG_PINCTRL_EXYNOS_ARM64
1309 { .compatible = "samsung,exynos5433-pinctrl",
1310 .data = &exynos5433_of_data },
1311 { .compatible = "samsung,exynos7-pinctrl",
1312 .data = &exynos7_of_data },
1313 { .compatible = "samsung,exynos7885-pinctrl",
1314 .data = &exynos7885_of_data },
1315 { .compatible = "samsung,exynos850-pinctrl",
1316 .data = &exynos850_of_data },
1317 { .compatible = "samsung,exynosautov9-pinctrl",
1318 .data = &exynosautov9_of_data },
1319 { .compatible = "tesla,fsd-pinctrl",
1320 .data = &fsd_of_data },
1322 #ifdef CONFIG_PINCTRL_S3C64XX
1323 { .compatible = "samsung,s3c64xx-pinctrl",
1324 .data = &s3c64xx_of_data },
1326 #ifdef CONFIG_PINCTRL_S3C24XX
1327 { .compatible = "samsung,s3c2412-pinctrl",
1328 .data = &s3c2412_of_data },
1329 { .compatible = "samsung,s3c2416-pinctrl",
1330 .data = &s3c2416_of_data },
1331 { .compatible = "samsung,s3c2440-pinctrl",
1332 .data = &s3c2440_of_data },
1333 { .compatible = "samsung,s3c2450-pinctrl",
1334 .data = &s3c2450_of_data },
1339 static const struct dev_pm_ops samsung_pinctrl_pm_ops = {
1340 SET_LATE_SYSTEM_SLEEP_PM_OPS(samsung_pinctrl_suspend,
1341 samsung_pinctrl_resume)
1344 static struct platform_driver samsung_pinctrl_driver = {
1345 .probe = samsung_pinctrl_probe,
1347 .name = "samsung-pinctrl",
1348 .of_match_table = samsung_pinctrl_dt_match,
1349 .suppress_bind_attrs = true,
1350 .pm = &samsung_pinctrl_pm_ops,
1354 static int __init samsung_pinctrl_drv_register(void)
1356 return platform_driver_register(&samsung_pinctrl_driver);
1358 postcore_initcall(samsung_pinctrl_drv_register);