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/slab.h>
22 #include <linux/err.h>
23 #include <linux/gpio/driver.h>
24 #include <linux/irqdomain.h>
25 #include <linux/of_device.h>
26 #include <linux/spinlock.h>
28 #include <dt-bindings/pinctrl/samsung.h>
31 #include "pinctrl-samsung.h"
33 /* maximum number of the memory resources */
34 #define SAMSUNG_PINCTRL_NUM_RESOURCES 2
36 /* list of all possible config options supported */
37 static struct pin_config
{
39 enum pincfg_type param
;
41 { "samsung,pin-pud", PINCFG_TYPE_PUD
},
42 { "samsung,pin-drv", PINCFG_TYPE_DRV
},
43 { "samsung,pin-con-pdn", PINCFG_TYPE_CON_PDN
},
44 { "samsung,pin-pud-pdn", PINCFG_TYPE_PUD_PDN
},
45 { "samsung,pin-val", PINCFG_TYPE_DAT
},
48 static unsigned int pin_base
;
50 static int samsung_get_group_count(struct pinctrl_dev
*pctldev
)
52 struct samsung_pinctrl_drv_data
*pmx
= pinctrl_dev_get_drvdata(pctldev
);
54 return pmx
->nr_groups
;
57 static const char *samsung_get_group_name(struct pinctrl_dev
*pctldev
,
60 struct samsung_pinctrl_drv_data
*pmx
= pinctrl_dev_get_drvdata(pctldev
);
62 return pmx
->pin_groups
[group
].name
;
65 static int samsung_get_group_pins(struct pinctrl_dev
*pctldev
,
67 const unsigned **pins
,
70 struct samsung_pinctrl_drv_data
*pmx
= pinctrl_dev_get_drvdata(pctldev
);
72 *pins
= pmx
->pin_groups
[group
].pins
;
73 *num_pins
= pmx
->pin_groups
[group
].num_pins
;
78 static int reserve_map(struct device
*dev
, struct pinctrl_map
**map
,
79 unsigned *reserved_maps
, unsigned *num_maps
,
82 unsigned old_num
= *reserved_maps
;
83 unsigned new_num
= *num_maps
+ reserve
;
84 struct pinctrl_map
*new_map
;
86 if (old_num
>= new_num
)
89 new_map
= krealloc(*map
, sizeof(*new_map
) * new_num
, GFP_KERNEL
);
93 memset(new_map
+ old_num
, 0, (new_num
- old_num
) * sizeof(*new_map
));
96 *reserved_maps
= new_num
;
101 static int add_map_mux(struct pinctrl_map
**map
, unsigned *reserved_maps
,
102 unsigned *num_maps
, const char *group
,
103 const char *function
)
105 if (WARN_ON(*num_maps
== *reserved_maps
))
108 (*map
)[*num_maps
].type
= PIN_MAP_TYPE_MUX_GROUP
;
109 (*map
)[*num_maps
].data
.mux
.group
= group
;
110 (*map
)[*num_maps
].data
.mux
.function
= function
;
116 static int add_map_configs(struct device
*dev
, struct pinctrl_map
**map
,
117 unsigned *reserved_maps
, unsigned *num_maps
,
118 const char *group
, unsigned long *configs
,
119 unsigned num_configs
)
121 unsigned long *dup_configs
;
123 if (WARN_ON(*num_maps
== *reserved_maps
))
126 dup_configs
= kmemdup(configs
, num_configs
* sizeof(*dup_configs
),
131 (*map
)[*num_maps
].type
= PIN_MAP_TYPE_CONFIGS_GROUP
;
132 (*map
)[*num_maps
].data
.configs
.group_or_pin
= group
;
133 (*map
)[*num_maps
].data
.configs
.configs
= dup_configs
;
134 (*map
)[*num_maps
].data
.configs
.num_configs
= num_configs
;
140 static int add_config(struct device
*dev
, unsigned long **configs
,
141 unsigned *num_configs
, unsigned long config
)
143 unsigned old_num
= *num_configs
;
144 unsigned new_num
= old_num
+ 1;
145 unsigned long *new_configs
;
147 new_configs
= krealloc(*configs
, sizeof(*new_configs
) * new_num
,
152 new_configs
[old_num
] = config
;
154 *configs
= new_configs
;
155 *num_configs
= new_num
;
160 static void samsung_dt_free_map(struct pinctrl_dev
*pctldev
,
161 struct pinctrl_map
*map
,
166 for (i
= 0; i
< num_maps
; i
++)
167 if (map
[i
].type
== PIN_MAP_TYPE_CONFIGS_GROUP
)
168 kfree(map
[i
].data
.configs
.configs
);
173 static int samsung_dt_subnode_to_map(struct samsung_pinctrl_drv_data
*drvdata
,
175 struct device_node
*np
,
176 struct pinctrl_map
**map
,
177 unsigned *reserved_maps
,
182 unsigned long config
;
183 unsigned long *configs
= NULL
;
184 unsigned num_configs
= 0;
186 struct property
*prop
;
188 bool has_func
= false;
190 ret
= of_property_read_u32(np
, "samsung,pin-function", &val
);
194 for (i
= 0; i
< ARRAY_SIZE(cfg_params
); i
++) {
195 ret
= of_property_read_u32(np
, cfg_params
[i
].property
, &val
);
197 config
= PINCFG_PACK(cfg_params
[i
].param
, val
);
198 ret
= add_config(dev
, &configs
, &num_configs
, config
);
201 /* EINVAL=missing, which is fine since it's optional */
202 } else if (ret
!= -EINVAL
) {
203 dev_err(dev
, "could not parse property %s\n",
204 cfg_params
[i
].property
);
213 ret
= of_property_count_strings(np
, "samsung,pins");
215 dev_err(dev
, "could not parse property samsung,pins\n");
220 ret
= reserve_map(dev
, map
, reserved_maps
, num_maps
, reserve
);
224 of_property_for_each_string(np
, "samsung,pins", prop
, group
) {
226 ret
= add_map_mux(map
, reserved_maps
,
227 num_maps
, group
, np
->full_name
);
233 ret
= add_map_configs(dev
, map
, reserved_maps
,
234 num_maps
, group
, configs
,
248 static int samsung_dt_node_to_map(struct pinctrl_dev
*pctldev
,
249 struct device_node
*np_config
,
250 struct pinctrl_map
**map
,
253 struct samsung_pinctrl_drv_data
*drvdata
;
254 unsigned reserved_maps
;
255 struct device_node
*np
;
258 drvdata
= pinctrl_dev_get_drvdata(pctldev
);
264 if (!of_get_child_count(np_config
))
265 return samsung_dt_subnode_to_map(drvdata
, pctldev
->dev
,
270 for_each_child_of_node(np_config
, np
) {
271 ret
= samsung_dt_subnode_to_map(drvdata
, pctldev
->dev
, np
, map
,
272 &reserved_maps
, num_maps
);
274 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 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 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 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 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 spin_lock_irqsave(&bank
->slock
, flags
);
564 samsung_gpio_set_value(gc
, offset
, value
);
565 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
|= EXYNOS_PIN_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 spin_lock_irqsave(&bank
->slock
, flags
);
629 ret
= samsung_gpio_set_direction(gc
, offset
, true);
630 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 spin_lock_irqsave(&bank
->slock
, flags
);
643 samsung_gpio_set_value(gc
, offset
, value
);
644 ret
= samsung_gpio_set_direction(gc
, offset
, false);
645 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
,
797 for_each_child_of_node(cfg_np
, func_np
) {
798 ret
= samsung_pinctrl_create_function(dev
, drvdata
,
814 * Parse the information about all the available pin groups and pin functions
815 * from device node of the pin-controller. A pin group is formed with all
816 * the pins listed in the "samsung,pins" property.
819 static int samsung_pinctrl_parse_dt(struct platform_device
*pdev
,
820 struct samsung_pinctrl_drv_data
*drvdata
)
822 struct device
*dev
= &pdev
->dev
;
823 struct samsung_pin_group
*groups
;
824 struct samsung_pmx_func
*functions
;
825 unsigned int grp_cnt
= 0, func_cnt
= 0;
827 groups
= samsung_pinctrl_create_groups(dev
, drvdata
, &grp_cnt
);
828 if (IS_ERR(groups
)) {
829 dev_err(dev
, "failed to parse pin groups\n");
830 return PTR_ERR(groups
);
833 functions
= samsung_pinctrl_create_functions(dev
, drvdata
, &func_cnt
);
834 if (IS_ERR(functions
)) {
835 dev_err(dev
, "failed to parse pin functions\n");
836 return PTR_ERR(functions
);
839 drvdata
->pin_groups
= groups
;
840 drvdata
->nr_groups
= grp_cnt
;
841 drvdata
->pmx_functions
= functions
;
842 drvdata
->nr_functions
= func_cnt
;
847 /* register the pinctrl interface with the pinctrl subsystem */
848 static int samsung_pinctrl_register(struct platform_device
*pdev
,
849 struct samsung_pinctrl_drv_data
*drvdata
)
851 struct pinctrl_desc
*ctrldesc
= &drvdata
->pctl
;
852 struct pinctrl_pin_desc
*pindesc
, *pdesc
;
853 struct samsung_pin_bank
*pin_bank
;
857 ctrldesc
->name
= "samsung-pinctrl";
858 ctrldesc
->owner
= THIS_MODULE
;
859 ctrldesc
->pctlops
= &samsung_pctrl_ops
;
860 ctrldesc
->pmxops
= &samsung_pinmux_ops
;
861 ctrldesc
->confops
= &samsung_pinconf_ops
;
863 pindesc
= devm_kcalloc(&pdev
->dev
,
864 drvdata
->nr_pins
, sizeof(*pindesc
),
868 ctrldesc
->pins
= pindesc
;
869 ctrldesc
->npins
= drvdata
->nr_pins
;
871 /* dynamically populate the pin number and pin name for pindesc */
872 for (pin
= 0, pdesc
= pindesc
; pin
< ctrldesc
->npins
; pin
++, pdesc
++)
873 pdesc
->number
= pin
+ drvdata
->pin_base
;
876 * allocate space for storing the dynamically generated names for all
877 * the pins which belong to this pin-controller.
879 pin_names
= devm_kzalloc(&pdev
->dev
,
880 array3_size(sizeof(char), PIN_NAME_LENGTH
,
886 /* for each pin, the name of the pin is pin-bank name + pin number */
887 for (bank
= 0; bank
< drvdata
->nr_banks
; bank
++) {
888 pin_bank
= &drvdata
->pin_banks
[bank
];
889 for (pin
= 0; pin
< pin_bank
->nr_pins
; pin
++) {
890 sprintf(pin_names
, "%s-%d", pin_bank
->name
, pin
);
891 pdesc
= pindesc
+ pin_bank
->pin_base
+ pin
;
892 pdesc
->name
= pin_names
;
893 pin_names
+= PIN_NAME_LENGTH
;
897 ret
= samsung_pinctrl_parse_dt(pdev
, drvdata
);
901 drvdata
->pctl_dev
= devm_pinctrl_register(&pdev
->dev
, ctrldesc
,
903 if (IS_ERR(drvdata
->pctl_dev
)) {
904 dev_err(&pdev
->dev
, "could not register pinctrl driver\n");
905 return PTR_ERR(drvdata
->pctl_dev
);
908 for (bank
= 0; bank
< drvdata
->nr_banks
; ++bank
) {
909 pin_bank
= &drvdata
->pin_banks
[bank
];
910 pin_bank
->grange
.name
= pin_bank
->name
;
911 pin_bank
->grange
.id
= bank
;
912 pin_bank
->grange
.pin_base
= drvdata
->pin_base
913 + pin_bank
->pin_base
;
914 pin_bank
->grange
.base
= pin_bank
->grange
.pin_base
;
915 pin_bank
->grange
.npins
= pin_bank
->gpio_chip
.ngpio
;
916 pin_bank
->grange
.gc
= &pin_bank
->gpio_chip
;
917 pinctrl_add_gpio_range(drvdata
->pctl_dev
, &pin_bank
->grange
);
923 /* unregister the pinctrl interface with the pinctrl subsystem */
924 static int samsung_pinctrl_unregister(struct platform_device
*pdev
,
925 struct samsung_pinctrl_drv_data
*drvdata
)
927 struct samsung_pin_bank
*bank
= drvdata
->pin_banks
;
930 for (i
= 0; i
< drvdata
->nr_banks
; ++i
, ++bank
)
931 pinctrl_remove_gpio_range(drvdata
->pctl_dev
, &bank
->grange
);
936 static const struct gpio_chip samsung_gpiolib_chip
= {
937 .request
= gpiochip_generic_request
,
938 .free
= gpiochip_generic_free
,
939 .set
= samsung_gpio_set
,
940 .get
= samsung_gpio_get
,
941 .direction_input
= samsung_gpio_direction_input
,
942 .direction_output
= samsung_gpio_direction_output
,
943 .to_irq
= samsung_gpio_to_irq
,
944 .owner
= THIS_MODULE
,
947 /* register the gpiolib interface with the gpiolib subsystem */
948 static int samsung_gpiolib_register(struct platform_device
*pdev
,
949 struct samsung_pinctrl_drv_data
*drvdata
)
951 struct samsung_pin_bank
*bank
= drvdata
->pin_banks
;
952 struct gpio_chip
*gc
;
956 for (i
= 0; i
< drvdata
->nr_banks
; ++i
, ++bank
) {
957 bank
->gpio_chip
= samsung_gpiolib_chip
;
959 gc
= &bank
->gpio_chip
;
960 gc
->base
= bank
->grange
.base
;
961 gc
->ngpio
= bank
->nr_pins
;
962 gc
->parent
= &pdev
->dev
;
963 gc
->of_node
= bank
->of_node
;
964 gc
->label
= bank
->name
;
966 ret
= devm_gpiochip_add_data(&pdev
->dev
, gc
, bank
);
968 dev_err(&pdev
->dev
, "failed to register gpio_chip %s, error code: %d\n",
977 static const struct samsung_pin_ctrl
*
978 samsung_pinctrl_get_soc_data_for_of_alias(struct platform_device
*pdev
)
980 struct device_node
*node
= pdev
->dev
.of_node
;
981 const struct samsung_pinctrl_of_match_data
*of_data
;
984 id
= of_alias_get_id(node
, "pinctrl");
986 dev_err(&pdev
->dev
, "failed to get alias id\n");
990 of_data
= of_device_get_match_data(&pdev
->dev
);
991 if (id
>= of_data
->num_ctrl
) {
992 dev_err(&pdev
->dev
, "invalid alias id %d\n", id
);
996 return &(of_data
->ctrl
[id
]);
999 /* retrieve the soc specific data */
1000 static const struct samsung_pin_ctrl
*
1001 samsung_pinctrl_get_soc_data(struct samsung_pinctrl_drv_data
*d
,
1002 struct platform_device
*pdev
)
1004 struct device_node
*node
= pdev
->dev
.of_node
;
1005 struct device_node
*np
;
1006 const struct samsung_pin_bank_data
*bdata
;
1007 const struct samsung_pin_ctrl
*ctrl
;
1008 struct samsung_pin_bank
*bank
;
1009 struct resource
*res
;
1010 void __iomem
*virt_base
[SAMSUNG_PINCTRL_NUM_RESOURCES
];
1013 ctrl
= samsung_pinctrl_get_soc_data_for_of_alias(pdev
);
1015 return ERR_PTR(-ENOENT
);
1017 d
->suspend
= ctrl
->suspend
;
1018 d
->resume
= ctrl
->resume
;
1019 d
->nr_banks
= ctrl
->nr_banks
;
1020 d
->pin_banks
= devm_kcalloc(&pdev
->dev
, d
->nr_banks
,
1021 sizeof(*d
->pin_banks
), GFP_KERNEL
);
1023 return ERR_PTR(-ENOMEM
);
1025 if (ctrl
->nr_ext_resources
+ 1 > SAMSUNG_PINCTRL_NUM_RESOURCES
)
1026 return ERR_PTR(-EINVAL
);
1028 for (i
= 0; i
< ctrl
->nr_ext_resources
+ 1; i
++) {
1029 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, i
);
1031 dev_err(&pdev
->dev
, "failed to get mem%d resource\n", i
);
1032 return ERR_PTR(-EINVAL
);
1034 virt_base
[i
] = devm_ioremap(&pdev
->dev
, res
->start
,
1035 resource_size(res
));
1036 if (!virt_base
[i
]) {
1037 dev_err(&pdev
->dev
, "failed to ioremap %pR\n", res
);
1038 return ERR_PTR(-EIO
);
1042 bank
= d
->pin_banks
;
1043 bdata
= ctrl
->pin_banks
;
1044 for (i
= 0; i
< ctrl
->nr_banks
; ++i
, ++bdata
, ++bank
) {
1045 bank
->type
= bdata
->type
;
1046 bank
->pctl_offset
= bdata
->pctl_offset
;
1047 bank
->nr_pins
= bdata
->nr_pins
;
1048 bank
->eint_func
= bdata
->eint_func
;
1049 bank
->eint_type
= bdata
->eint_type
;
1050 bank
->eint_mask
= bdata
->eint_mask
;
1051 bank
->eint_offset
= bdata
->eint_offset
;
1052 bank
->name
= bdata
->name
;
1054 spin_lock_init(&bank
->slock
);
1056 bank
->pin_base
= d
->nr_pins
;
1057 d
->nr_pins
+= bank
->nr_pins
;
1059 bank
->eint_base
= virt_base
[0];
1060 bank
->pctl_base
= virt_base
[bdata
->pctl_res_idx
];
1063 * Legacy platforms should provide only one resource with IO memory.
1064 * Store it as virt_base because legacy driver needs to access it
1065 * through samsung_pinctrl_drv_data.
1067 d
->virt_base
= virt_base
[0];
1069 for_each_child_of_node(node
, np
) {
1070 if (!of_find_property(np
, "gpio-controller", NULL
))
1072 bank
= d
->pin_banks
;
1073 for (i
= 0; i
< d
->nr_banks
; ++i
, ++bank
) {
1074 if (of_node_name_eq(np
, bank
->name
)) {
1081 d
->pin_base
= pin_base
;
1082 pin_base
+= d
->nr_pins
;
1087 static int samsung_pinctrl_probe(struct platform_device
*pdev
)
1089 struct samsung_pinctrl_drv_data
*drvdata
;
1090 const struct samsung_pin_ctrl
*ctrl
;
1091 struct device
*dev
= &pdev
->dev
;
1092 struct resource
*res
;
1095 drvdata
= devm_kzalloc(dev
, sizeof(*drvdata
), GFP_KERNEL
);
1099 ctrl
= samsung_pinctrl_get_soc_data(drvdata
, pdev
);
1101 dev_err(&pdev
->dev
, "driver data not available\n");
1102 return PTR_ERR(ctrl
);
1106 res
= platform_get_resource(pdev
, IORESOURCE_IRQ
, 0);
1108 drvdata
->irq
= res
->start
;
1110 if (ctrl
->retention_data
) {
1111 drvdata
->retention_ctrl
= ctrl
->retention_data
->init(drvdata
,
1112 ctrl
->retention_data
);
1113 if (IS_ERR(drvdata
->retention_ctrl
))
1114 return PTR_ERR(drvdata
->retention_ctrl
);
1117 ret
= samsung_pinctrl_register(pdev
, drvdata
);
1121 ret
= samsung_gpiolib_register(pdev
, drvdata
);
1123 samsung_pinctrl_unregister(pdev
, drvdata
);
1127 if (ctrl
->eint_gpio_init
)
1128 ctrl
->eint_gpio_init(drvdata
);
1129 if (ctrl
->eint_wkup_init
)
1130 ctrl
->eint_wkup_init(drvdata
);
1132 platform_set_drvdata(pdev
, drvdata
);
1138 * samsung_pinctrl_suspend - save pinctrl state for suspend
1140 * Save data for all banks handled by this device.
1142 static int __maybe_unused
samsung_pinctrl_suspend(struct device
*dev
)
1144 struct samsung_pinctrl_drv_data
*drvdata
= dev_get_drvdata(dev
);
1147 for (i
= 0; i
< drvdata
->nr_banks
; i
++) {
1148 struct samsung_pin_bank
*bank
= &drvdata
->pin_banks
[i
];
1149 void __iomem
*reg
= bank
->pctl_base
+ bank
->pctl_offset
;
1150 const u8
*offs
= bank
->type
->reg_offset
;
1151 const u8
*widths
= bank
->type
->fld_width
;
1152 enum pincfg_type type
;
1154 /* Registers without a powerdown config aren't lost */
1155 if (!widths
[PINCFG_TYPE_CON_PDN
])
1158 for (type
= 0; type
< PINCFG_TYPE_NUM
; type
++)
1160 bank
->pm_save
[type
] = readl(reg
+ offs
[type
]);
1162 if (widths
[PINCFG_TYPE_FUNC
] * bank
->nr_pins
> 32) {
1163 /* Some banks have two config registers */
1164 bank
->pm_save
[PINCFG_TYPE_NUM
] =
1165 readl(reg
+ offs
[PINCFG_TYPE_FUNC
] + 4);
1166 pr_debug("Save %s @ %p (con %#010x %08x)\n",
1168 bank
->pm_save
[PINCFG_TYPE_FUNC
],
1169 bank
->pm_save
[PINCFG_TYPE_NUM
]);
1171 pr_debug("Save %s @ %p (con %#010x)\n", bank
->name
,
1172 reg
, bank
->pm_save
[PINCFG_TYPE_FUNC
]);
1176 if (drvdata
->suspend
)
1177 drvdata
->suspend(drvdata
);
1178 if (drvdata
->retention_ctrl
&& drvdata
->retention_ctrl
->enable
)
1179 drvdata
->retention_ctrl
->enable(drvdata
);
1185 * samsung_pinctrl_resume - restore pinctrl state from suspend
1187 * Restore one of the banks that was saved during suspend.
1189 * We don't bother doing anything complicated to avoid glitching lines since
1190 * we're called before pad retention is turned off.
1192 static int __maybe_unused
samsung_pinctrl_resume(struct device
*dev
)
1194 struct samsung_pinctrl_drv_data
*drvdata
= dev_get_drvdata(dev
);
1197 if (drvdata
->resume
)
1198 drvdata
->resume(drvdata
);
1200 for (i
= 0; i
< drvdata
->nr_banks
; i
++) {
1201 struct samsung_pin_bank
*bank
= &drvdata
->pin_banks
[i
];
1202 void __iomem
*reg
= bank
->pctl_base
+ bank
->pctl_offset
;
1203 const u8
*offs
= bank
->type
->reg_offset
;
1204 const u8
*widths
= bank
->type
->fld_width
;
1205 enum pincfg_type type
;
1207 /* Registers without a powerdown config aren't lost */
1208 if (!widths
[PINCFG_TYPE_CON_PDN
])
1211 if (widths
[PINCFG_TYPE_FUNC
] * bank
->nr_pins
> 32) {
1212 /* Some banks have two config registers */
1213 pr_debug("%s @ %p (con %#010x %08x => %#010x %08x)\n",
1215 readl(reg
+ offs
[PINCFG_TYPE_FUNC
]),
1216 readl(reg
+ offs
[PINCFG_TYPE_FUNC
] + 4),
1217 bank
->pm_save
[PINCFG_TYPE_FUNC
],
1218 bank
->pm_save
[PINCFG_TYPE_NUM
]);
1219 writel(bank
->pm_save
[PINCFG_TYPE_NUM
],
1220 reg
+ offs
[PINCFG_TYPE_FUNC
] + 4);
1222 pr_debug("%s @ %p (con %#010x => %#010x)\n", bank
->name
,
1223 reg
, readl(reg
+ offs
[PINCFG_TYPE_FUNC
]),
1224 bank
->pm_save
[PINCFG_TYPE_FUNC
]);
1226 for (type
= 0; type
< PINCFG_TYPE_NUM
; type
++)
1228 writel(bank
->pm_save
[type
], reg
+ offs
[type
]);
1231 if (drvdata
->retention_ctrl
&& drvdata
->retention_ctrl
->disable
)
1232 drvdata
->retention_ctrl
->disable(drvdata
);
1237 static const struct of_device_id samsung_pinctrl_dt_match
[] = {
1238 #ifdef CONFIG_PINCTRL_EXYNOS_ARM
1239 { .compatible
= "samsung,exynos3250-pinctrl",
1240 .data
= &exynos3250_of_data
},
1241 { .compatible
= "samsung,exynos4210-pinctrl",
1242 .data
= &exynos4210_of_data
},
1243 { .compatible
= "samsung,exynos4x12-pinctrl",
1244 .data
= &exynos4x12_of_data
},
1245 { .compatible
= "samsung,exynos5250-pinctrl",
1246 .data
= &exynos5250_of_data
},
1247 { .compatible
= "samsung,exynos5260-pinctrl",
1248 .data
= &exynos5260_of_data
},
1249 { .compatible
= "samsung,exynos5410-pinctrl",
1250 .data
= &exynos5410_of_data
},
1251 { .compatible
= "samsung,exynos5420-pinctrl",
1252 .data
= &exynos5420_of_data
},
1253 { .compatible
= "samsung,s5pv210-pinctrl",
1254 .data
= &s5pv210_of_data
},
1256 #ifdef CONFIG_PINCTRL_EXYNOS_ARM64
1257 { .compatible
= "samsung,exynos5433-pinctrl",
1258 .data
= &exynos5433_of_data
},
1259 { .compatible
= "samsung,exynos7-pinctrl",
1260 .data
= &exynos7_of_data
},
1262 #ifdef CONFIG_PINCTRL_S3C64XX
1263 { .compatible
= "samsung,s3c64xx-pinctrl",
1264 .data
= &s3c64xx_of_data
},
1266 #ifdef CONFIG_PINCTRL_S3C24XX
1267 { .compatible
= "samsung,s3c2412-pinctrl",
1268 .data
= &s3c2412_of_data
},
1269 { .compatible
= "samsung,s3c2416-pinctrl",
1270 .data
= &s3c2416_of_data
},
1271 { .compatible
= "samsung,s3c2440-pinctrl",
1272 .data
= &s3c2440_of_data
},
1273 { .compatible
= "samsung,s3c2450-pinctrl",
1274 .data
= &s3c2450_of_data
},
1279 static const struct dev_pm_ops samsung_pinctrl_pm_ops
= {
1280 SET_LATE_SYSTEM_SLEEP_PM_OPS(samsung_pinctrl_suspend
,
1281 samsung_pinctrl_resume
)
1284 static struct platform_driver samsung_pinctrl_driver
= {
1285 .probe
= samsung_pinctrl_probe
,
1287 .name
= "samsung-pinctrl",
1288 .of_match_table
= samsung_pinctrl_dt_match
,
1289 .suppress_bind_attrs
= true,
1290 .pm
= &samsung_pinctrl_pm_ops
,
1294 static int __init
samsung_pinctrl_drv_register(void)
1296 return platform_driver_register(&samsung_pinctrl_driver
);
1298 postcore_initcall(samsung_pinctrl_drv_register
);