2 * SuperH Pin Function Controller pinmux support.
4 * Copyright (C) 2012 Paul Mundt
6 * This file is subject to the terms and conditions of the GNU General Public
7 * License. See the file "COPYING" in the main directory of this archive
11 #define DRV_NAME "sh-pfc"
13 #include <linux/device.h>
14 #include <linux/err.h>
15 #include <linux/init.h>
16 #include <linux/module.h>
17 #include <linux/pinctrl/consumer.h>
18 #include <linux/pinctrl/pinconf.h>
19 #include <linux/pinctrl/pinconf-generic.h>
20 #include <linux/pinctrl/pinctrl.h>
21 #include <linux/pinctrl/pinmux.h>
22 #include <linux/slab.h>
23 #include <linux/spinlock.h>
27 #include "../pinconf.h"
29 struct sh_pfc_pin_config {
33 struct sh_pfc_pinctrl {
34 struct pinctrl_dev *pctl;
35 struct pinctrl_desc pctl_desc;
39 struct pinctrl_pin_desc *pins;
40 struct sh_pfc_pin_config *configs;
43 static int sh_pfc_get_groups_count(struct pinctrl_dev *pctldev)
45 struct sh_pfc_pinctrl *pmx = pinctrl_dev_get_drvdata(pctldev);
47 return pmx->pfc->info->nr_groups;
50 static const char *sh_pfc_get_group_name(struct pinctrl_dev *pctldev,
53 struct sh_pfc_pinctrl *pmx = pinctrl_dev_get_drvdata(pctldev);
55 return pmx->pfc->info->groups[selector].name;
58 static int sh_pfc_get_group_pins(struct pinctrl_dev *pctldev, unsigned selector,
59 const unsigned **pins, unsigned *num_pins)
61 struct sh_pfc_pinctrl *pmx = pinctrl_dev_get_drvdata(pctldev);
63 *pins = pmx->pfc->info->groups[selector].pins;
64 *num_pins = pmx->pfc->info->groups[selector].nr_pins;
69 static void sh_pfc_pin_dbg_show(struct pinctrl_dev *pctldev, struct seq_file *s,
72 seq_printf(s, "%s", DRV_NAME);
75 static const struct pinctrl_ops sh_pfc_pinctrl_ops = {
76 .get_groups_count = sh_pfc_get_groups_count,
77 .get_group_name = sh_pfc_get_group_name,
78 .get_group_pins = sh_pfc_get_group_pins,
79 .pin_dbg_show = sh_pfc_pin_dbg_show,
82 static int sh_pfc_get_functions_count(struct pinctrl_dev *pctldev)
84 struct sh_pfc_pinctrl *pmx = pinctrl_dev_get_drvdata(pctldev);
86 return pmx->pfc->info->nr_functions;
89 static const char *sh_pfc_get_function_name(struct pinctrl_dev *pctldev,
92 struct sh_pfc_pinctrl *pmx = pinctrl_dev_get_drvdata(pctldev);
94 return pmx->pfc->info->functions[selector].name;
97 static int sh_pfc_get_function_groups(struct pinctrl_dev *pctldev,
99 const char * const **groups,
100 unsigned * const num_groups)
102 struct sh_pfc_pinctrl *pmx = pinctrl_dev_get_drvdata(pctldev);
104 *groups = pmx->pfc->info->functions[selector].groups;
105 *num_groups = pmx->pfc->info->functions[selector].nr_groups;
110 static int sh_pfc_func_enable(struct pinctrl_dev *pctldev, unsigned selector,
113 struct sh_pfc_pinctrl *pmx = pinctrl_dev_get_drvdata(pctldev);
114 struct sh_pfc *pfc = pmx->pfc;
115 const struct sh_pfc_pin_group *grp = &pfc->info->groups[group];
120 spin_lock_irqsave(&pfc->lock, flags);
122 for (i = 0; i < grp->nr_pins; ++i) {
123 int idx = sh_pfc_get_pin_index(pfc, grp->pins[i]);
124 struct sh_pfc_pin_config *cfg = &pmx->configs[idx];
126 if (cfg->type != PINMUX_TYPE_NONE) {
132 for (i = 0; i < grp->nr_pins; ++i) {
133 ret = sh_pfc_config_mux(pfc, grp->mux[i], PINMUX_TYPE_FUNCTION);
139 spin_unlock_irqrestore(&pfc->lock, flags);
143 static void sh_pfc_func_disable(struct pinctrl_dev *pctldev, unsigned selector,
146 struct sh_pfc_pinctrl *pmx = pinctrl_dev_get_drvdata(pctldev);
147 struct sh_pfc *pfc = pmx->pfc;
148 const struct sh_pfc_pin_group *grp = &pfc->info->groups[group];
152 spin_lock_irqsave(&pfc->lock, flags);
154 for (i = 0; i < grp->nr_pins; ++i) {
155 int idx = sh_pfc_get_pin_index(pfc, grp->pins[i]);
156 struct sh_pfc_pin_config *cfg = &pmx->configs[idx];
158 cfg->type = PINMUX_TYPE_NONE;
161 spin_unlock_irqrestore(&pfc->lock, flags);
164 static int sh_pfc_gpio_request_enable(struct pinctrl_dev *pctldev,
165 struct pinctrl_gpio_range *range,
168 struct sh_pfc_pinctrl *pmx = pinctrl_dev_get_drvdata(pctldev);
169 struct sh_pfc *pfc = pmx->pfc;
170 int idx = sh_pfc_get_pin_index(pfc, offset);
171 struct sh_pfc_pin_config *cfg = &pmx->configs[idx];
175 spin_lock_irqsave(&pfc->lock, flags);
177 if (cfg->type != PINMUX_TYPE_NONE) {
179 "Pin %u is busy, can't configure it as GPIO.\n",
186 /* If GPIOs are handled externally the pin mux type need to be
189 const struct sh_pfc_pin *pin = &pfc->info->pins[idx];
191 ret = sh_pfc_config_mux(pfc, pin->enum_id, PINMUX_TYPE_GPIO);
196 cfg->type = PINMUX_TYPE_GPIO;
201 spin_unlock_irqrestore(&pfc->lock, flags);
206 static void sh_pfc_gpio_disable_free(struct pinctrl_dev *pctldev,
207 struct pinctrl_gpio_range *range,
210 struct sh_pfc_pinctrl *pmx = pinctrl_dev_get_drvdata(pctldev);
211 struct sh_pfc *pfc = pmx->pfc;
212 int idx = sh_pfc_get_pin_index(pfc, offset);
213 struct sh_pfc_pin_config *cfg = &pmx->configs[idx];
216 spin_lock_irqsave(&pfc->lock, flags);
217 cfg->type = PINMUX_TYPE_NONE;
218 spin_unlock_irqrestore(&pfc->lock, flags);
221 static int sh_pfc_gpio_set_direction(struct pinctrl_dev *pctldev,
222 struct pinctrl_gpio_range *range,
223 unsigned offset, bool input)
225 struct sh_pfc_pinctrl *pmx = pinctrl_dev_get_drvdata(pctldev);
226 struct sh_pfc *pfc = pmx->pfc;
227 int new_type = input ? PINMUX_TYPE_INPUT : PINMUX_TYPE_OUTPUT;
228 int idx = sh_pfc_get_pin_index(pfc, offset);
229 const struct sh_pfc_pin *pin = &pfc->info->pins[idx];
230 struct sh_pfc_pin_config *cfg = &pmx->configs[idx];
235 /* Check if the requested direction is supported by the pin. Not all SoC
236 * provide pin config data, so perform the check conditionally.
239 dir = input ? SH_PFC_PIN_CFG_INPUT : SH_PFC_PIN_CFG_OUTPUT;
240 if (!(pin->configs & dir))
244 spin_lock_irqsave(&pfc->lock, flags);
246 ret = sh_pfc_config_mux(pfc, pin->enum_id, new_type);
250 cfg->type = new_type;
253 spin_unlock_irqrestore(&pfc->lock, flags);
257 static const struct pinmux_ops sh_pfc_pinmux_ops = {
258 .get_functions_count = sh_pfc_get_functions_count,
259 .get_function_name = sh_pfc_get_function_name,
260 .get_function_groups = sh_pfc_get_function_groups,
261 .enable = sh_pfc_func_enable,
262 .disable = sh_pfc_func_disable,
263 .gpio_request_enable = sh_pfc_gpio_request_enable,
264 .gpio_disable_free = sh_pfc_gpio_disable_free,
265 .gpio_set_direction = sh_pfc_gpio_set_direction,
268 /* Check whether the requested parameter is supported for a pin. */
269 static bool sh_pfc_pinconf_validate(struct sh_pfc *pfc, unsigned int _pin,
270 enum pin_config_param param)
272 int idx = sh_pfc_get_pin_index(pfc, _pin);
273 const struct sh_pfc_pin *pin = &pfc->info->pins[idx];
276 case PIN_CONFIG_BIAS_DISABLE:
279 case PIN_CONFIG_BIAS_PULL_UP:
280 return pin->configs & SH_PFC_PIN_CFG_PULL_UP;
282 case PIN_CONFIG_BIAS_PULL_DOWN:
283 return pin->configs & SH_PFC_PIN_CFG_PULL_DOWN;
290 static int sh_pfc_pinconf_get(struct pinctrl_dev *pctldev, unsigned _pin,
291 unsigned long *config)
293 struct sh_pfc_pinctrl *pmx = pinctrl_dev_get_drvdata(pctldev);
294 struct sh_pfc *pfc = pmx->pfc;
295 enum pin_config_param param = pinconf_to_config_param(*config);
299 if (!sh_pfc_pinconf_validate(pfc, _pin, param))
303 case PIN_CONFIG_BIAS_DISABLE:
304 case PIN_CONFIG_BIAS_PULL_UP:
305 case PIN_CONFIG_BIAS_PULL_DOWN:
306 if (!pfc->info->ops || !pfc->info->ops->get_bias)
309 spin_lock_irqsave(&pfc->lock, flags);
310 bias = pfc->info->ops->get_bias(pfc, _pin);
311 spin_unlock_irqrestore(&pfc->lock, flags);
326 static int sh_pfc_pinconf_set(struct pinctrl_dev *pctldev, unsigned _pin,
327 unsigned long config)
329 struct sh_pfc_pinctrl *pmx = pinctrl_dev_get_drvdata(pctldev);
330 struct sh_pfc *pfc = pmx->pfc;
331 enum pin_config_param param = pinconf_to_config_param(config);
334 if (!sh_pfc_pinconf_validate(pfc, _pin, param))
338 case PIN_CONFIG_BIAS_PULL_UP:
339 case PIN_CONFIG_BIAS_PULL_DOWN:
340 case PIN_CONFIG_BIAS_DISABLE:
341 if (!pfc->info->ops || !pfc->info->ops->set_bias)
344 spin_lock_irqsave(&pfc->lock, flags);
345 pfc->info->ops->set_bias(pfc, _pin, param);
346 spin_unlock_irqrestore(&pfc->lock, flags);
357 static int sh_pfc_pinconf_group_set(struct pinctrl_dev *pctldev, unsigned group,
358 unsigned long config)
360 struct sh_pfc_pinctrl *pmx = pinctrl_dev_get_drvdata(pctldev);
361 const unsigned int *pins;
362 unsigned int num_pins;
365 pins = pmx->pfc->info->groups[group].pins;
366 num_pins = pmx->pfc->info->groups[group].nr_pins;
368 for (i = 0; i < num_pins; ++i)
369 sh_pfc_pinconf_set(pctldev, pins[i], config);
374 static const struct pinconf_ops sh_pfc_pinconf_ops = {
376 .pin_config_get = sh_pfc_pinconf_get,
377 .pin_config_set = sh_pfc_pinconf_set,
378 .pin_config_group_set = sh_pfc_pinconf_group_set,
379 .pin_config_config_dbg_show = pinconf_generic_dump_config,
382 /* PFC ranges -> pinctrl pin descs */
383 static int sh_pfc_map_pins(struct sh_pfc *pfc, struct sh_pfc_pinctrl *pmx)
385 const struct pinmux_range *ranges;
386 struct pinmux_range def_range;
387 unsigned int nr_ranges;
388 unsigned int nr_pins;
391 if (pfc->info->ranges == NULL) {
393 def_range.end = pfc->info->nr_pins - 1;
397 ranges = pfc->info->ranges;
398 nr_ranges = pfc->info->nr_ranges;
401 pmx->pins = devm_kzalloc(pfc->dev,
402 sizeof(*pmx->pins) * pfc->info->nr_pins,
404 if (unlikely(!pmx->pins))
407 pmx->configs = devm_kzalloc(pfc->dev,
408 sizeof(*pmx->configs) * pfc->info->nr_pins,
410 if (unlikely(!pmx->configs))
413 for (i = 0, nr_pins = 0; i < nr_ranges; ++i) {
414 const struct pinmux_range *range = &ranges[i];
417 for (number = range->begin; number <= range->end;
418 number++, nr_pins++) {
419 struct sh_pfc_pin_config *cfg = &pmx->configs[nr_pins];
420 struct pinctrl_pin_desc *pin = &pmx->pins[nr_pins];
421 const struct sh_pfc_pin *info =
422 &pfc->info->pins[nr_pins];
424 pin->number = number;
425 pin->name = info->name;
426 cfg->type = PINMUX_TYPE_NONE;
430 pfc->nr_pins = ranges[nr_ranges-1].end + 1;
435 int sh_pfc_register_pinctrl(struct sh_pfc *pfc)
437 struct sh_pfc_pinctrl *pmx;
440 pmx = devm_kzalloc(pfc->dev, sizeof(*pmx), GFP_KERNEL);
447 nr_ranges = sh_pfc_map_pins(pfc, pmx);
448 if (unlikely(nr_ranges < 0))
451 pmx->pctl_desc.name = DRV_NAME;
452 pmx->pctl_desc.owner = THIS_MODULE;
453 pmx->pctl_desc.pctlops = &sh_pfc_pinctrl_ops;
454 pmx->pctl_desc.pmxops = &sh_pfc_pinmux_ops;
455 pmx->pctl_desc.confops = &sh_pfc_pinconf_ops;
456 pmx->pctl_desc.pins = pmx->pins;
457 pmx->pctl_desc.npins = pfc->info->nr_pins;
459 pmx->pctl = pinctrl_register(&pmx->pctl_desc, pfc->dev, pmx);
460 if (pmx->pctl == NULL)
466 int sh_pfc_unregister_pinctrl(struct sh_pfc *pfc)
468 struct sh_pfc_pinctrl *pmx = pfc->pinctrl;
470 pinctrl_unregister(pmx->pctl);