2 * pin-controller/pin-mux/pin-config/gpio-driver for Samsung's SoC's.
4 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 * http://www.samsung.com
6 * Copyright (c) 2012 Linaro Ltd
7 * http://www.linaro.org
9 * Author: Thomas Abraham <thomas.ab@samsung.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This driver implements the Samsung pinctrl driver. It supports setting up of
17 * pinmux and pinconf configurations. The gpiolib interface is also included.
18 * External interrupt (gpio and wakeup) support are not included in this driver
19 * but provides extensions to which platform specific implementation of the gpio
20 * and wakeup interrupts can be hooked to.
23 #include <linux/module.h>
24 #include <linux/platform_device.h>
26 #include <linux/slab.h>
27 #include <linux/err.h>
28 #include <linux/gpio.h>
29 #include <linux/irqdomain.h>
30 #include <linux/spinlock.h>
31 #include <linux/syscore_ops.h>
34 #include "pinctrl-samsung.h"
36 #define GROUP_SUFFIX "-grp"
37 #define GSUFFIX_LEN sizeof(GROUP_SUFFIX)
38 #define FUNCTION_SUFFIX "-mux"
39 #define FSUFFIX_LEN sizeof(FUNCTION_SUFFIX)
41 /* list of all possible config options supported */
42 static struct pin_config {
44 enum pincfg_type param;
46 { "samsung,pin-pud", PINCFG_TYPE_PUD },
47 { "samsung,pin-drv", PINCFG_TYPE_DRV },
48 { "samsung,pin-con-pdn", PINCFG_TYPE_CON_PDN },
49 { "samsung,pin-pud-pdn", PINCFG_TYPE_PUD_PDN },
50 { "samsung,pin-val", PINCFG_TYPE_DAT },
53 /* Global list of devices (struct samsung_pinctrl_drv_data) */
54 static LIST_HEAD(drvdata_list);
56 static unsigned int pin_base;
58 static inline struct samsung_pin_bank *gc_to_pin_bank(struct gpio_chip *gc)
60 return container_of(gc, struct samsung_pin_bank, gpio_chip);
63 static int samsung_get_group_count(struct pinctrl_dev *pctldev)
65 struct samsung_pinctrl_drv_data *pmx = pinctrl_dev_get_drvdata(pctldev);
67 return pmx->nr_groups;
70 static const char *samsung_get_group_name(struct pinctrl_dev *pctldev,
73 struct samsung_pinctrl_drv_data *pmx = pinctrl_dev_get_drvdata(pctldev);
75 return pmx->pin_groups[group].name;
78 static int samsung_get_group_pins(struct pinctrl_dev *pctldev,
80 const unsigned **pins,
83 struct samsung_pinctrl_drv_data *pmx = pinctrl_dev_get_drvdata(pctldev);
85 *pins = pmx->pin_groups[group].pins;
86 *num_pins = pmx->pin_groups[group].num_pins;
91 static int reserve_map(struct device *dev, struct pinctrl_map **map,
92 unsigned *reserved_maps, unsigned *num_maps,
95 unsigned old_num = *reserved_maps;
96 unsigned new_num = *num_maps + reserve;
97 struct pinctrl_map *new_map;
99 if (old_num >= new_num)
102 new_map = krealloc(*map, sizeof(*new_map) * new_num, GFP_KERNEL);
104 dev_err(dev, "krealloc(map) failed\n");
108 memset(new_map + old_num, 0, (new_num - old_num) * sizeof(*new_map));
111 *reserved_maps = new_num;
116 static int add_map_mux(struct pinctrl_map **map, unsigned *reserved_maps,
117 unsigned *num_maps, const char *group,
118 const char *function)
120 if (WARN_ON(*num_maps == *reserved_maps))
123 (*map)[*num_maps].type = PIN_MAP_TYPE_MUX_GROUP;
124 (*map)[*num_maps].data.mux.group = group;
125 (*map)[*num_maps].data.mux.function = function;
131 static int add_map_configs(struct device *dev, struct pinctrl_map **map,
132 unsigned *reserved_maps, unsigned *num_maps,
133 const char *group, unsigned long *configs,
134 unsigned num_configs)
136 unsigned long *dup_configs;
138 if (WARN_ON(*num_maps == *reserved_maps))
141 dup_configs = kmemdup(configs, num_configs * sizeof(*dup_configs),
144 dev_err(dev, "kmemdup(configs) failed\n");
148 (*map)[*num_maps].type = PIN_MAP_TYPE_CONFIGS_GROUP;
149 (*map)[*num_maps].data.configs.group_or_pin = group;
150 (*map)[*num_maps].data.configs.configs = dup_configs;
151 (*map)[*num_maps].data.configs.num_configs = num_configs;
157 static int add_config(struct device *dev, unsigned long **configs,
158 unsigned *num_configs, unsigned long config)
160 unsigned old_num = *num_configs;
161 unsigned new_num = old_num + 1;
162 unsigned long *new_configs;
164 new_configs = krealloc(*configs, sizeof(*new_configs) * new_num,
167 dev_err(dev, "krealloc(configs) failed\n");
171 new_configs[old_num] = config;
173 *configs = new_configs;
174 *num_configs = new_num;
179 static void samsung_dt_free_map(struct pinctrl_dev *pctldev,
180 struct pinctrl_map *map,
185 for (i = 0; i < num_maps; i++)
186 if (map[i].type == PIN_MAP_TYPE_CONFIGS_GROUP)
187 kfree(map[i].data.configs.configs);
192 static int samsung_dt_subnode_to_map(struct samsung_pinctrl_drv_data *drvdata,
194 struct device_node *np,
195 struct pinctrl_map **map,
196 unsigned *reserved_maps,
201 unsigned long config;
202 unsigned long *configs = NULL;
203 unsigned num_configs = 0;
205 struct property *prop;
207 bool has_func = false;
209 ret = of_property_read_u32(np, "samsung,pin-function", &val);
213 for (i = 0; i < ARRAY_SIZE(cfg_params); i++) {
214 ret = of_property_read_u32(np, cfg_params[i].property, &val);
216 config = PINCFG_PACK(cfg_params[i].param, val);
217 ret = add_config(dev, &configs, &num_configs, config);
220 /* EINVAL=missing, which is fine since it's optional */
221 } else if (ret != -EINVAL) {
222 dev_err(dev, "could not parse property %s\n",
223 cfg_params[i].property);
232 ret = of_property_count_strings(np, "samsung,pins");
234 dev_err(dev, "could not parse property samsung,pins\n");
239 ret = reserve_map(dev, map, reserved_maps, num_maps, reserve);
243 of_property_for_each_string(np, "samsung,pins", prop, group) {
245 ret = add_map_mux(map, reserved_maps,
246 num_maps, group, np->full_name);
252 ret = add_map_configs(dev, map, reserved_maps,
253 num_maps, group, configs,
267 static int samsung_dt_node_to_map(struct pinctrl_dev *pctldev,
268 struct device_node *np_config,
269 struct pinctrl_map **map,
272 struct samsung_pinctrl_drv_data *drvdata;
273 unsigned reserved_maps;
274 struct device_node *np;
277 drvdata = pinctrl_dev_get_drvdata(pctldev);
283 if (!of_get_child_count(np_config))
284 return samsung_dt_subnode_to_map(drvdata, pctldev->dev,
289 for_each_child_of_node(np_config, np) {
290 ret = samsung_dt_subnode_to_map(drvdata, pctldev->dev, np, map,
291 &reserved_maps, num_maps);
293 samsung_dt_free_map(pctldev, *map, *num_maps);
301 /* list of pinctrl callbacks for the pinctrl core */
302 static const struct pinctrl_ops samsung_pctrl_ops = {
303 .get_groups_count = samsung_get_group_count,
304 .get_group_name = samsung_get_group_name,
305 .get_group_pins = samsung_get_group_pins,
306 .dt_node_to_map = samsung_dt_node_to_map,
307 .dt_free_map = samsung_dt_free_map,
310 /* check if the selector is a valid pin function selector */
311 static int samsung_get_functions_count(struct pinctrl_dev *pctldev)
313 struct samsung_pinctrl_drv_data *drvdata;
315 drvdata = pinctrl_dev_get_drvdata(pctldev);
316 return drvdata->nr_functions;
319 /* return the name of the pin function specified */
320 static const char *samsung_pinmux_get_fname(struct pinctrl_dev *pctldev,
323 struct samsung_pinctrl_drv_data *drvdata;
325 drvdata = pinctrl_dev_get_drvdata(pctldev);
326 return drvdata->pmx_functions[selector].name;
329 /* return the groups associated for the specified function selector */
330 static int samsung_pinmux_get_groups(struct pinctrl_dev *pctldev,
331 unsigned selector, const char * const **groups,
332 unsigned * const num_groups)
334 struct samsung_pinctrl_drv_data *drvdata;
336 drvdata = pinctrl_dev_get_drvdata(pctldev);
337 *groups = drvdata->pmx_functions[selector].groups;
338 *num_groups = drvdata->pmx_functions[selector].num_groups;
343 * given a pin number that is local to a pin controller, find out the pin bank
344 * and the register base of the pin bank.
346 static void pin_to_reg_bank(struct samsung_pinctrl_drv_data *drvdata,
347 unsigned pin, void __iomem **reg, u32 *offset,
348 struct samsung_pin_bank **bank)
350 struct samsung_pin_bank *b;
352 b = drvdata->pin_banks;
354 while ((pin >= b->pin_base) &&
355 ((b->pin_base + b->nr_pins - 1) < pin))
358 *reg = drvdata->virt_base + b->pctl_offset;
359 *offset = pin - b->pin_base;
364 /* enable or disable a pinmux function */
365 static void samsung_pinmux_setup(struct pinctrl_dev *pctldev, unsigned selector,
366 unsigned group, bool enable)
368 struct samsung_pinctrl_drv_data *drvdata;
369 const struct samsung_pin_bank_type *type;
370 struct samsung_pin_bank *bank;
372 u32 mask, shift, data, pin_offset;
374 const struct samsung_pmx_func *func;
375 const struct samsung_pin_group *grp;
377 drvdata = pinctrl_dev_get_drvdata(pctldev);
378 func = &drvdata->pmx_functions[selector];
379 grp = &drvdata->pin_groups[group];
381 pin_to_reg_bank(drvdata, grp->pins[0] - drvdata->pin_base,
382 ®, &pin_offset, &bank);
384 mask = (1 << type->fld_width[PINCFG_TYPE_FUNC]) - 1;
385 shift = pin_offset * type->fld_width[PINCFG_TYPE_FUNC];
387 /* Some banks have two config registers */
392 spin_lock_irqsave(&bank->slock, flags);
394 data = readl(reg + type->reg_offset[PINCFG_TYPE_FUNC]);
395 data &= ~(mask << shift);
397 data |= func->val << shift;
398 writel(data, reg + type->reg_offset[PINCFG_TYPE_FUNC]);
400 spin_unlock_irqrestore(&bank->slock, flags);
403 /* enable a specified pinmux by writing to registers */
404 static int samsung_pinmux_set_mux(struct pinctrl_dev *pctldev,
408 samsung_pinmux_setup(pctldev, selector, group, true);
412 /* list of pinmux callbacks for the pinmux vertical in pinctrl core */
413 static const struct pinmux_ops samsung_pinmux_ops = {
414 .get_functions_count = samsung_get_functions_count,
415 .get_function_name = samsung_pinmux_get_fname,
416 .get_function_groups = samsung_pinmux_get_groups,
417 .set_mux = samsung_pinmux_set_mux,
420 /* set or get the pin config settings for a specified pin */
421 static int samsung_pinconf_rw(struct pinctrl_dev *pctldev, unsigned int pin,
422 unsigned long *config, bool set)
424 struct samsung_pinctrl_drv_data *drvdata;
425 const struct samsung_pin_bank_type *type;
426 struct samsung_pin_bank *bank;
427 void __iomem *reg_base;
428 enum pincfg_type cfg_type = PINCFG_UNPACK_TYPE(*config);
429 u32 data, width, pin_offset, mask, shift;
430 u32 cfg_value, cfg_reg;
433 drvdata = pinctrl_dev_get_drvdata(pctldev);
434 pin_to_reg_bank(drvdata, pin - drvdata->pin_base, ®_base,
438 if (cfg_type >= PINCFG_TYPE_NUM || !type->fld_width[cfg_type])
441 width = type->fld_width[cfg_type];
442 cfg_reg = type->reg_offset[cfg_type];
444 spin_lock_irqsave(&bank->slock, flags);
446 mask = (1 << width) - 1;
447 shift = pin_offset * width;
448 data = readl(reg_base + cfg_reg);
451 cfg_value = PINCFG_UNPACK_VALUE(*config);
452 data &= ~(mask << shift);
453 data |= (cfg_value << shift);
454 writel(data, reg_base + cfg_reg);
458 *config = PINCFG_PACK(cfg_type, data);
461 spin_unlock_irqrestore(&bank->slock, flags);
466 /* set the pin config settings for a specified pin */
467 static int samsung_pinconf_set(struct pinctrl_dev *pctldev, unsigned int pin,
468 unsigned long *configs, unsigned num_configs)
472 for (i = 0; i < num_configs; i++) {
473 ret = samsung_pinconf_rw(pctldev, pin, &configs[i], true);
476 } /* for each config */
481 /* get the pin config settings for a specified pin */
482 static int samsung_pinconf_get(struct pinctrl_dev *pctldev, unsigned int pin,
483 unsigned long *config)
485 return samsung_pinconf_rw(pctldev, pin, config, false);
488 /* set the pin config settings for a specified pin group */
489 static int samsung_pinconf_group_set(struct pinctrl_dev *pctldev,
490 unsigned group, unsigned long *configs,
491 unsigned num_configs)
493 struct samsung_pinctrl_drv_data *drvdata;
494 const unsigned int *pins;
497 drvdata = pinctrl_dev_get_drvdata(pctldev);
498 pins = drvdata->pin_groups[group].pins;
500 for (cnt = 0; cnt < drvdata->pin_groups[group].num_pins; cnt++)
501 samsung_pinconf_set(pctldev, pins[cnt], configs, num_configs);
506 /* get the pin config settings for a specified pin group */
507 static int samsung_pinconf_group_get(struct pinctrl_dev *pctldev,
508 unsigned int group, unsigned long *config)
510 struct samsung_pinctrl_drv_data *drvdata;
511 const unsigned int *pins;
513 drvdata = pinctrl_dev_get_drvdata(pctldev);
514 pins = drvdata->pin_groups[group].pins;
515 samsung_pinconf_get(pctldev, pins[0], config);
519 /* list of pinconfig callbacks for pinconfig vertical in the pinctrl code */
520 static const struct pinconf_ops samsung_pinconf_ops = {
521 .pin_config_get = samsung_pinconf_get,
522 .pin_config_set = samsung_pinconf_set,
523 .pin_config_group_get = samsung_pinconf_group_get,
524 .pin_config_group_set = samsung_pinconf_group_set,
527 /* gpiolib gpio_set callback function */
528 static void samsung_gpio_set(struct gpio_chip *gc, unsigned offset, int value)
530 struct samsung_pin_bank *bank = gc_to_pin_bank(gc);
531 const struct samsung_pin_bank_type *type = bank->type;
536 reg = bank->drvdata->virt_base + bank->pctl_offset;
538 spin_lock_irqsave(&bank->slock, flags);
540 data = readl(reg + type->reg_offset[PINCFG_TYPE_DAT]);
541 data &= ~(1 << offset);
544 writel(data, reg + type->reg_offset[PINCFG_TYPE_DAT]);
546 spin_unlock_irqrestore(&bank->slock, flags);
549 /* gpiolib gpio_get callback function */
550 static int samsung_gpio_get(struct gpio_chip *gc, unsigned offset)
554 struct samsung_pin_bank *bank = gc_to_pin_bank(gc);
555 const struct samsung_pin_bank_type *type = bank->type;
557 reg = bank->drvdata->virt_base + bank->pctl_offset;
559 data = readl(reg + type->reg_offset[PINCFG_TYPE_DAT]);
566 * The calls to gpio_direction_output() and gpio_direction_input()
567 * leads to this function call.
569 static int samsung_gpio_set_direction(struct gpio_chip *gc,
570 unsigned offset, bool input)
572 const struct samsung_pin_bank_type *type;
573 struct samsung_pin_bank *bank;
574 struct samsung_pinctrl_drv_data *drvdata;
576 u32 data, mask, shift;
579 bank = gc_to_pin_bank(gc);
581 drvdata = bank->drvdata;
583 reg = drvdata->virt_base + bank->pctl_offset +
584 type->reg_offset[PINCFG_TYPE_FUNC];
586 mask = (1 << type->fld_width[PINCFG_TYPE_FUNC]) - 1;
587 shift = offset * type->fld_width[PINCFG_TYPE_FUNC];
589 /* Some banks have two config registers */
594 spin_lock_irqsave(&bank->slock, flags);
597 data &= ~(mask << shift);
599 data |= FUNC_OUTPUT << shift;
602 spin_unlock_irqrestore(&bank->slock, flags);
607 /* gpiolib gpio_direction_input callback function. */
608 static int samsung_gpio_direction_input(struct gpio_chip *gc, unsigned offset)
610 return samsung_gpio_set_direction(gc, offset, true);
613 /* gpiolib gpio_direction_output callback function. */
614 static int samsung_gpio_direction_output(struct gpio_chip *gc, unsigned offset,
617 samsung_gpio_set(gc, offset, value);
618 return samsung_gpio_set_direction(gc, offset, false);
622 * gpiolib gpio_to_irq callback function. Creates a mapping between a GPIO pin
623 * and a virtual IRQ, if not already present.
625 static int samsung_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
627 struct samsung_pin_bank *bank = gc_to_pin_bank(gc);
630 if (!bank->irq_domain)
633 virq = irq_create_mapping(bank->irq_domain, offset);
635 return (virq) ? : -ENXIO;
638 static struct samsung_pin_group *samsung_pinctrl_create_groups(
640 struct samsung_pinctrl_drv_data *drvdata,
643 struct pinctrl_desc *ctrldesc = &drvdata->pctl;
644 struct samsung_pin_group *groups, *grp;
645 const struct pinctrl_pin_desc *pdesc;
648 groups = devm_kzalloc(dev, ctrldesc->npins * sizeof(*groups),
651 return ERR_PTR(-EINVAL);
654 pdesc = ctrldesc->pins;
655 for (i = 0; i < ctrldesc->npins; ++i, ++pdesc, ++grp) {
656 grp->name = pdesc->name;
657 grp->pins = &pdesc->number;
661 *cnt = ctrldesc->npins;
665 static int samsung_pinctrl_create_function(struct device *dev,
666 struct samsung_pinctrl_drv_data *drvdata,
667 struct device_node *func_np,
668 struct samsung_pmx_func *func)
674 if (of_property_read_u32(func_np, "samsung,pin-function", &func->val))
677 npins = of_property_count_strings(func_np, "samsung,pins");
679 dev_err(dev, "invalid pin list in %s node", func_np->name);
683 func->name = func_np->full_name;
685 func->groups = devm_kzalloc(dev, npins * sizeof(char *), GFP_KERNEL);
689 for (i = 0; i < npins; ++i) {
692 ret = of_property_read_string_index(func_np, "samsung,pins",
696 "failed to read pin name %d from %s node\n",
701 func->groups[i] = gname;
704 func->num_groups = npins;
708 static struct samsung_pmx_func *samsung_pinctrl_create_functions(
710 struct samsung_pinctrl_drv_data *drvdata,
713 struct samsung_pmx_func *functions, *func;
714 struct device_node *dev_np = dev->of_node;
715 struct device_node *cfg_np;
716 unsigned int func_cnt = 0;
720 * Iterate over all the child nodes of the pin controller node
721 * and create pin groups and pin function lists.
723 for_each_child_of_node(dev_np, cfg_np) {
724 struct device_node *func_np;
726 if (!of_get_child_count(cfg_np)) {
727 if (!of_find_property(cfg_np,
728 "samsung,pin-function", NULL))
734 for_each_child_of_node(cfg_np, func_np) {
735 if (!of_find_property(func_np,
736 "samsung,pin-function", NULL))
742 functions = devm_kzalloc(dev, func_cnt * sizeof(*functions),
745 dev_err(dev, "failed to allocate memory for function list\n");
746 return ERR_PTR(-EINVAL);
751 * Iterate over all the child nodes of the pin controller node
752 * and create pin groups and pin function lists.
755 for_each_child_of_node(dev_np, cfg_np) {
756 struct device_node *func_np;
758 if (!of_get_child_count(cfg_np)) {
759 ret = samsung_pinctrl_create_function(dev, drvdata,
770 for_each_child_of_node(cfg_np, func_np) {
771 ret = samsung_pinctrl_create_function(dev, drvdata,
787 * Parse the information about all the available pin groups and pin functions
788 * from device node of the pin-controller. A pin group is formed with all
789 * the pins listed in the "samsung,pins" property.
792 static int samsung_pinctrl_parse_dt(struct platform_device *pdev,
793 struct samsung_pinctrl_drv_data *drvdata)
795 struct device *dev = &pdev->dev;
796 struct samsung_pin_group *groups;
797 struct samsung_pmx_func *functions;
798 unsigned int grp_cnt = 0, func_cnt = 0;
800 groups = samsung_pinctrl_create_groups(dev, drvdata, &grp_cnt);
801 if (IS_ERR(groups)) {
802 dev_err(dev, "failed to parse pin groups\n");
803 return PTR_ERR(groups);
806 functions = samsung_pinctrl_create_functions(dev, drvdata, &func_cnt);
807 if (IS_ERR(functions)) {
808 dev_err(dev, "failed to parse pin functions\n");
809 return PTR_ERR(functions);
812 drvdata->pin_groups = groups;
813 drvdata->nr_groups = grp_cnt;
814 drvdata->pmx_functions = functions;
815 drvdata->nr_functions = func_cnt;
820 /* register the pinctrl interface with the pinctrl subsystem */
821 static int samsung_pinctrl_register(struct platform_device *pdev,
822 struct samsung_pinctrl_drv_data *drvdata)
824 struct pinctrl_desc *ctrldesc = &drvdata->pctl;
825 struct pinctrl_pin_desc *pindesc, *pdesc;
826 struct samsung_pin_bank *pin_bank;
830 ctrldesc->name = "samsung-pinctrl";
831 ctrldesc->owner = THIS_MODULE;
832 ctrldesc->pctlops = &samsung_pctrl_ops;
833 ctrldesc->pmxops = &samsung_pinmux_ops;
834 ctrldesc->confops = &samsung_pinconf_ops;
836 pindesc = devm_kzalloc(&pdev->dev, sizeof(*pindesc) *
837 drvdata->nr_pins, GFP_KERNEL);
839 dev_err(&pdev->dev, "mem alloc for pin descriptors failed\n");
842 ctrldesc->pins = pindesc;
843 ctrldesc->npins = drvdata->nr_pins;
845 /* dynamically populate the pin number and pin name for pindesc */
846 for (pin = 0, pdesc = pindesc; pin < ctrldesc->npins; pin++, pdesc++)
847 pdesc->number = pin + drvdata->pin_base;
850 * allocate space for storing the dynamically generated names for all
851 * the pins which belong to this pin-controller.
853 pin_names = devm_kzalloc(&pdev->dev, sizeof(char) * PIN_NAME_LENGTH *
854 drvdata->nr_pins, GFP_KERNEL);
856 dev_err(&pdev->dev, "mem alloc for pin names failed\n");
860 /* for each pin, the name of the pin is pin-bank name + pin number */
861 for (bank = 0; bank < drvdata->nr_banks; bank++) {
862 pin_bank = &drvdata->pin_banks[bank];
863 for (pin = 0; pin < pin_bank->nr_pins; pin++) {
864 sprintf(pin_names, "%s-%d", pin_bank->name, pin);
865 pdesc = pindesc + pin_bank->pin_base + pin;
866 pdesc->name = pin_names;
867 pin_names += PIN_NAME_LENGTH;
871 ret = samsung_pinctrl_parse_dt(pdev, drvdata);
875 drvdata->pctl_dev = pinctrl_register(ctrldesc, &pdev->dev, drvdata);
876 if (IS_ERR(drvdata->pctl_dev)) {
877 dev_err(&pdev->dev, "could not register pinctrl driver\n");
878 return PTR_ERR(drvdata->pctl_dev);
881 for (bank = 0; bank < drvdata->nr_banks; ++bank) {
882 pin_bank = &drvdata->pin_banks[bank];
883 pin_bank->grange.name = pin_bank->name;
884 pin_bank->grange.id = bank;
885 pin_bank->grange.pin_base = drvdata->pin_base
886 + pin_bank->pin_base;
887 pin_bank->grange.base = pin_bank->gpio_chip.base;
888 pin_bank->grange.npins = pin_bank->gpio_chip.ngpio;
889 pin_bank->grange.gc = &pin_bank->gpio_chip;
890 pinctrl_add_gpio_range(drvdata->pctl_dev, &pin_bank->grange);
896 static int samsung_gpio_request(struct gpio_chip *chip, unsigned offset)
898 return pinctrl_request_gpio(chip->base + offset);
901 static void samsung_gpio_free(struct gpio_chip *chip, unsigned offset)
903 pinctrl_free_gpio(chip->base + offset);
906 static const struct gpio_chip samsung_gpiolib_chip = {
907 .request = samsung_gpio_request,
908 .free = samsung_gpio_free,
909 .set = samsung_gpio_set,
910 .get = samsung_gpio_get,
911 .direction_input = samsung_gpio_direction_input,
912 .direction_output = samsung_gpio_direction_output,
913 .to_irq = samsung_gpio_to_irq,
914 .owner = THIS_MODULE,
917 /* register the gpiolib interface with the gpiolib subsystem */
918 static int samsung_gpiolib_register(struct platform_device *pdev,
919 struct samsung_pinctrl_drv_data *drvdata)
921 struct samsung_pin_bank *bank = drvdata->pin_banks;
922 struct gpio_chip *gc;
926 for (i = 0; i < drvdata->nr_banks; ++i, ++bank) {
927 bank->gpio_chip = samsung_gpiolib_chip;
929 gc = &bank->gpio_chip;
930 gc->base = drvdata->pin_base + bank->pin_base;
931 gc->ngpio = bank->nr_pins;
932 gc->dev = &pdev->dev;
933 gc->of_node = bank->of_node;
934 gc->label = bank->name;
936 ret = gpiochip_add(gc);
938 dev_err(&pdev->dev, "failed to register gpio_chip %s, error code: %d\n",
947 for (--i, --bank; i >= 0; --i, --bank)
948 gpiochip_remove(&bank->gpio_chip);
952 /* unregister the gpiolib interface with the gpiolib subsystem */
953 static int samsung_gpiolib_unregister(struct platform_device *pdev,
954 struct samsung_pinctrl_drv_data *drvdata)
956 struct samsung_pin_bank *bank = drvdata->pin_banks;
959 for (i = 0; i < drvdata->nr_banks; ++i, ++bank)
960 gpiochip_remove(&bank->gpio_chip);
965 static const struct of_device_id samsung_pinctrl_dt_match[];
967 /* retrieve the soc specific data */
968 static const struct samsung_pin_ctrl *
969 samsung_pinctrl_get_soc_data(struct samsung_pinctrl_drv_data *d,
970 struct platform_device *pdev)
973 const struct of_device_id *match;
974 struct device_node *node = pdev->dev.of_node;
975 struct device_node *np;
976 const struct samsung_pin_bank_data *bdata;
977 const struct samsung_pin_ctrl *ctrl;
978 struct samsung_pin_bank *bank;
981 id = of_alias_get_id(node, "pinctrl");
983 dev_err(&pdev->dev, "failed to get alias id\n");
984 return ERR_PTR(-ENOENT);
986 match = of_match_node(samsung_pinctrl_dt_match, node);
987 ctrl = (struct samsung_pin_ctrl *)match->data + id;
989 d->suspend = ctrl->suspend;
990 d->resume = ctrl->resume;
991 d->nr_banks = ctrl->nr_banks;
992 d->pin_banks = devm_kcalloc(&pdev->dev, d->nr_banks,
993 sizeof(*d->pin_banks), GFP_KERNEL);
995 return ERR_PTR(-ENOMEM);
998 bdata = ctrl->pin_banks;
999 for (i = 0; i < ctrl->nr_banks; ++i, ++bdata, ++bank) {
1000 bank->type = bdata->type;
1001 bank->pctl_offset = bdata->pctl_offset;
1002 bank->nr_pins = bdata->nr_pins;
1003 bank->eint_func = bdata->eint_func;
1004 bank->eint_type = bdata->eint_type;
1005 bank->eint_mask = bdata->eint_mask;
1006 bank->eint_offset = bdata->eint_offset;
1007 bank->name = bdata->name;
1009 spin_lock_init(&bank->slock);
1011 bank->pin_base = d->nr_pins;
1012 d->nr_pins += bank->nr_pins;
1015 for_each_child_of_node(node, np) {
1016 if (!of_find_property(np, "gpio-controller", NULL))
1018 bank = d->pin_banks;
1019 for (i = 0; i < d->nr_banks; ++i, ++bank) {
1020 if (!strcmp(bank->name, np->name)) {
1027 d->pin_base = pin_base;
1028 pin_base += d->nr_pins;
1033 static int samsung_pinctrl_probe(struct platform_device *pdev)
1035 struct samsung_pinctrl_drv_data *drvdata;
1036 const struct samsung_pin_ctrl *ctrl;
1037 struct device *dev = &pdev->dev;
1038 struct resource *res;
1041 if (!dev->of_node) {
1042 dev_err(dev, "device tree node not found\n");
1046 drvdata = devm_kzalloc(dev, sizeof(*drvdata), GFP_KERNEL);
1048 dev_err(dev, "failed to allocate memory for driver's "
1053 ctrl = samsung_pinctrl_get_soc_data(drvdata, pdev);
1055 dev_err(&pdev->dev, "driver data not available\n");
1056 return PTR_ERR(ctrl);
1060 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1061 drvdata->virt_base = devm_ioremap_resource(&pdev->dev, res);
1062 if (IS_ERR(drvdata->virt_base))
1063 return PTR_ERR(drvdata->virt_base);
1065 res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
1067 drvdata->irq = res->start;
1069 ret = samsung_gpiolib_register(pdev, drvdata);
1073 ret = samsung_pinctrl_register(pdev, drvdata);
1075 samsung_gpiolib_unregister(pdev, drvdata);
1079 if (ctrl->eint_gpio_init)
1080 ctrl->eint_gpio_init(drvdata);
1081 if (ctrl->eint_wkup_init)
1082 ctrl->eint_wkup_init(drvdata);
1084 platform_set_drvdata(pdev, drvdata);
1086 /* Add to the global list */
1087 list_add_tail(&drvdata->node, &drvdata_list);
1095 * samsung_pinctrl_suspend_dev - save pinctrl state for suspend for a device
1097 * Save data for all banks handled by this device.
1099 static void samsung_pinctrl_suspend_dev(
1100 struct samsung_pinctrl_drv_data *drvdata)
1102 void __iomem *virt_base = drvdata->virt_base;
1105 for (i = 0; i < drvdata->nr_banks; i++) {
1106 struct samsung_pin_bank *bank = &drvdata->pin_banks[i];
1107 void __iomem *reg = virt_base + bank->pctl_offset;
1108 const u8 *offs = bank->type->reg_offset;
1109 const u8 *widths = bank->type->fld_width;
1110 enum pincfg_type type;
1112 /* Registers without a powerdown config aren't lost */
1113 if (!widths[PINCFG_TYPE_CON_PDN])
1116 for (type = 0; type < PINCFG_TYPE_NUM; type++)
1118 bank->pm_save[type] = readl(reg + offs[type]);
1120 if (widths[PINCFG_TYPE_FUNC] * bank->nr_pins > 32) {
1121 /* Some banks have two config registers */
1122 bank->pm_save[PINCFG_TYPE_NUM] =
1123 readl(reg + offs[PINCFG_TYPE_FUNC] + 4);
1124 pr_debug("Save %s @ %p (con %#010x %08x)\n",
1126 bank->pm_save[PINCFG_TYPE_FUNC],
1127 bank->pm_save[PINCFG_TYPE_NUM]);
1129 pr_debug("Save %s @ %p (con %#010x)\n", bank->name,
1130 reg, bank->pm_save[PINCFG_TYPE_FUNC]);
1134 if (drvdata->suspend)
1135 drvdata->suspend(drvdata);
1139 * samsung_pinctrl_resume_dev - restore pinctrl state from suspend for a device
1141 * Restore one of the banks that was saved during suspend.
1143 * We don't bother doing anything complicated to avoid glitching lines since
1144 * we're called before pad retention is turned off.
1146 static void samsung_pinctrl_resume_dev(struct samsung_pinctrl_drv_data *drvdata)
1148 void __iomem *virt_base = drvdata->virt_base;
1151 if (drvdata->resume)
1152 drvdata->resume(drvdata);
1154 for (i = 0; i < drvdata->nr_banks; i++) {
1155 struct samsung_pin_bank *bank = &drvdata->pin_banks[i];
1156 void __iomem *reg = virt_base + bank->pctl_offset;
1157 const u8 *offs = bank->type->reg_offset;
1158 const u8 *widths = bank->type->fld_width;
1159 enum pincfg_type type;
1161 /* Registers without a powerdown config aren't lost */
1162 if (!widths[PINCFG_TYPE_CON_PDN])
1165 if (widths[PINCFG_TYPE_FUNC] * bank->nr_pins > 32) {
1166 /* Some banks have two config registers */
1167 pr_debug("%s @ %p (con %#010x %08x => %#010x %08x)\n",
1169 readl(reg + offs[PINCFG_TYPE_FUNC]),
1170 readl(reg + offs[PINCFG_TYPE_FUNC] + 4),
1171 bank->pm_save[PINCFG_TYPE_FUNC],
1172 bank->pm_save[PINCFG_TYPE_NUM]);
1173 writel(bank->pm_save[PINCFG_TYPE_NUM],
1174 reg + offs[PINCFG_TYPE_FUNC] + 4);
1176 pr_debug("%s @ %p (con %#010x => %#010x)\n", bank->name,
1177 reg, readl(reg + offs[PINCFG_TYPE_FUNC]),
1178 bank->pm_save[PINCFG_TYPE_FUNC]);
1180 for (type = 0; type < PINCFG_TYPE_NUM; type++)
1182 writel(bank->pm_save[type], reg + offs[type]);
1187 * samsung_pinctrl_suspend - save pinctrl state for suspend
1189 * Save data for all banks across all devices.
1191 static int samsung_pinctrl_suspend(void)
1193 struct samsung_pinctrl_drv_data *drvdata;
1195 list_for_each_entry(drvdata, &drvdata_list, node) {
1196 samsung_pinctrl_suspend_dev(drvdata);
1203 * samsung_pinctrl_resume - restore pinctrl state for suspend
1205 * Restore data for all banks across all devices.
1207 static void samsung_pinctrl_resume(void)
1209 struct samsung_pinctrl_drv_data *drvdata;
1211 list_for_each_entry_reverse(drvdata, &drvdata_list, node) {
1212 samsung_pinctrl_resume_dev(drvdata);
1217 #define samsung_pinctrl_suspend NULL
1218 #define samsung_pinctrl_resume NULL
1221 static struct syscore_ops samsung_pinctrl_syscore_ops = {
1222 .suspend = samsung_pinctrl_suspend,
1223 .resume = samsung_pinctrl_resume,
1226 static const struct of_device_id samsung_pinctrl_dt_match[] = {
1227 #ifdef CONFIG_PINCTRL_EXYNOS
1228 { .compatible = "samsung,exynos3250-pinctrl",
1229 .data = (void *)exynos3250_pin_ctrl },
1230 { .compatible = "samsung,exynos4210-pinctrl",
1231 .data = (void *)exynos4210_pin_ctrl },
1232 { .compatible = "samsung,exynos4x12-pinctrl",
1233 .data = (void *)exynos4x12_pin_ctrl },
1234 { .compatible = "samsung,exynos4415-pinctrl",
1235 .data = (void *)exynos4415_pin_ctrl },
1236 { .compatible = "samsung,exynos5250-pinctrl",
1237 .data = (void *)exynos5250_pin_ctrl },
1238 { .compatible = "samsung,exynos5260-pinctrl",
1239 .data = (void *)exynos5260_pin_ctrl },
1240 { .compatible = "samsung,exynos5420-pinctrl",
1241 .data = (void *)exynos5420_pin_ctrl },
1242 { .compatible = "samsung,exynos5433-pinctrl",
1243 .data = (void *)exynos5433_pin_ctrl },
1244 { .compatible = "samsung,s5pv210-pinctrl",
1245 .data = (void *)s5pv210_pin_ctrl },
1246 { .compatible = "samsung,exynos7-pinctrl",
1247 .data = (void *)exynos7_pin_ctrl },
1249 #ifdef CONFIG_PINCTRL_S3C64XX
1250 { .compatible = "samsung,s3c64xx-pinctrl",
1251 .data = s3c64xx_pin_ctrl },
1253 #ifdef CONFIG_PINCTRL_S3C24XX
1254 { .compatible = "samsung,s3c2412-pinctrl",
1255 .data = s3c2412_pin_ctrl },
1256 { .compatible = "samsung,s3c2416-pinctrl",
1257 .data = s3c2416_pin_ctrl },
1258 { .compatible = "samsung,s3c2440-pinctrl",
1259 .data = s3c2440_pin_ctrl },
1260 { .compatible = "samsung,s3c2450-pinctrl",
1261 .data = s3c2450_pin_ctrl },
1265 MODULE_DEVICE_TABLE(of, samsung_pinctrl_dt_match);
1267 static struct platform_driver samsung_pinctrl_driver = {
1268 .probe = samsung_pinctrl_probe,
1270 .name = "samsung-pinctrl",
1271 .of_match_table = samsung_pinctrl_dt_match,
1275 static int __init samsung_pinctrl_drv_register(void)
1278 * Register syscore ops for save/restore of registers across suspend.
1279 * It's important to ensure that this driver is running at an earlier
1280 * initcall level than any arch-specific init calls that install syscore
1281 * ops that turn off pad retention (like exynos_pm_resume).
1283 register_syscore_ops(&samsung_pinctrl_syscore_ops);
1285 return platform_driver_register(&samsung_pinctrl_driver);
1287 postcore_initcall(samsung_pinctrl_drv_register);
1289 static void __exit samsung_pinctrl_drv_unregister(void)
1291 platform_driver_unregister(&samsung_pinctrl_driver);
1293 module_exit(samsung_pinctrl_drv_unregister);
1295 MODULE_AUTHOR("Thomas Abraham <thomas.ab@samsung.com>");
1296 MODULE_DESCRIPTION("Samsung pinctrl driver");
1297 MODULE_LICENSE("GPL v2");