2 * Pin controller and GPIO driver for Amlogic Meson SoCs
4 * Copyright (C) 2014 Beniamino Galvani <b.galvani@gmail.com>
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * version 2 as published by the Free Software Foundation.
10 * You should have received a copy of the GNU General Public License
11 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 * The available pins are organized in banks (A,B,C,D,E,X,Y,Z,AO,
16 * BOOT,CARD for meson6, X,Y,DV,H,Z,AO,BOOT,CARD for meson8 and
17 * X,Y,DV,H,AO,BOOT,CARD,DIF for meson8b) and each bank has a
18 * variable number of pins.
20 * The AO bank is special because it belongs to the Always-On power
21 * domain which can't be powered off; the bank also uses a set of
22 * registers different from the other banks.
24 * For each pin controller there are 4 different register ranges that
25 * control the following properties of the pins:
27 * 2) pull enable/disable
29 * 4) GPIO direction, output value, input value
31 * In some cases the register ranges for pull enable and pull
32 * direction are the same and thus there are only 3 register ranges.
34 * Every pinmux group can be enabled by a specific bit in the first
35 * register range; when all groups for a given pin are disabled the
38 * For the pull and GPIO configuration every bank uses a contiguous
39 * set of bits in the register sets described above; the same register
40 * can be shared by more banks with different offsets.
42 * In addition to this there are some registers shared between all
43 * banks that control the IRQ functionality. This feature is not
44 * supported at the moment by the driver.
47 #include <linux/device.h>
48 #include <linux/gpio.h>
49 #include <linux/init.h>
52 #include <linux/of_address.h>
53 #include <linux/pinctrl/pinconf-generic.h>
54 #include <linux/pinctrl/pinconf.h>
55 #include <linux/pinctrl/pinctrl.h>
56 #include <linux/pinctrl/pinmux.h>
57 #include <linux/platform_device.h>
58 #include <linux/regmap.h>
59 #include <linux/seq_file.h>
62 #include "../pinctrl-utils.h"
63 #include "pinctrl-meson.h"
66 * meson_get_bank() - find the bank containing a given pin
68 * @pc: the pinctrl instance
69 * @pin: the pin number
70 * @bank: the found bank
72 * Return: 0 on success, a negative value on error
74 static int meson_get_bank(struct meson_pinctrl
*pc
, unsigned int pin
,
75 struct meson_bank
**bank
)
79 for (i
= 0; i
< pc
->data
->num_banks
; i
++) {
80 if (pin
>= pc
->data
->banks
[i
].first
&&
81 pin
<= pc
->data
->banks
[i
].last
) {
82 *bank
= &pc
->data
->banks
[i
];
91 * meson_calc_reg_and_bit() - calculate register and bit for a pin
93 * @bank: the bank containing the pin
94 * @pin: the pin number
95 * @reg_type: the type of register needed (pull-enable, pull, etc...)
96 * @reg: the computed register offset
97 * @bit: the computed bit
99 static void meson_calc_reg_and_bit(struct meson_bank
*bank
, unsigned int pin
,
100 enum meson_reg_type reg_type
,
101 unsigned int *reg
, unsigned int *bit
)
103 struct meson_reg_desc
*desc
= &bank
->regs
[reg_type
];
105 *reg
= desc
->reg
* 4;
106 *bit
= desc
->bit
+ pin
- bank
->first
;
109 static int meson_get_groups_count(struct pinctrl_dev
*pcdev
)
111 struct meson_pinctrl
*pc
= pinctrl_dev_get_drvdata(pcdev
);
113 return pc
->data
->num_groups
;
116 static const char *meson_get_group_name(struct pinctrl_dev
*pcdev
,
119 struct meson_pinctrl
*pc
= pinctrl_dev_get_drvdata(pcdev
);
121 return pc
->data
->groups
[selector
].name
;
124 static int meson_get_group_pins(struct pinctrl_dev
*pcdev
, unsigned selector
,
125 const unsigned **pins
, unsigned *num_pins
)
127 struct meson_pinctrl
*pc
= pinctrl_dev_get_drvdata(pcdev
);
129 *pins
= pc
->data
->groups
[selector
].pins
;
130 *num_pins
= pc
->data
->groups
[selector
].num_pins
;
135 static void meson_pin_dbg_show(struct pinctrl_dev
*pcdev
, struct seq_file
*s
,
138 seq_printf(s
, " %s", dev_name(pcdev
->dev
));
141 static const struct pinctrl_ops meson_pctrl_ops
= {
142 .get_groups_count
= meson_get_groups_count
,
143 .get_group_name
= meson_get_group_name
,
144 .get_group_pins
= meson_get_group_pins
,
145 .dt_node_to_map
= pinconf_generic_dt_node_to_map_all
,
146 .dt_free_map
= pinctrl_utils_free_map
,
147 .pin_dbg_show
= meson_pin_dbg_show
,
151 * meson_pmx_disable_other_groups() - disable other groups using a given pin
153 * @pc: meson pin controller device
154 * @pin: number of the pin
155 * @sel_group: index of the selected group, or -1 if none
157 * The function disables all pinmux groups using a pin except the
158 * selected one. If @sel_group is -1 all groups are disabled, leaving
159 * the pin in GPIO mode.
161 static void meson_pmx_disable_other_groups(struct meson_pinctrl
*pc
,
162 unsigned int pin
, int sel_group
)
164 struct meson_pmx_group
*group
;
167 for (i
= 0; i
< pc
->data
->num_groups
; i
++) {
168 group
= &pc
->data
->groups
[i
];
169 if (group
->is_gpio
|| i
== sel_group
)
172 for (j
= 0; j
< group
->num_pins
; j
++) {
173 if (group
->pins
[j
] == pin
) {
174 /* We have found a group using the pin */
175 regmap_update_bits(pc
->reg_mux
,
183 static int meson_pmx_set_mux(struct pinctrl_dev
*pcdev
, unsigned func_num
,
186 struct meson_pinctrl
*pc
= pinctrl_dev_get_drvdata(pcdev
);
187 struct meson_pmx_func
*func
= &pc
->data
->funcs
[func_num
];
188 struct meson_pmx_group
*group
= &pc
->data
->groups
[group_num
];
191 dev_dbg(pc
->dev
, "enable function %s, group %s\n", func
->name
,
195 * Disable groups using the same pin.
196 * The selected group is not disabled to avoid glitches.
198 for (i
= 0; i
< group
->num_pins
; i
++)
199 meson_pmx_disable_other_groups(pc
, group
->pins
[i
], group_num
);
201 /* Function 0 (GPIO) doesn't need any additional setting */
203 ret
= regmap_update_bits(pc
->reg_mux
, group
->reg
* 4,
204 BIT(group
->bit
), BIT(group
->bit
));
209 static int meson_pmx_request_gpio(struct pinctrl_dev
*pcdev
,
210 struct pinctrl_gpio_range
*range
,
213 struct meson_pinctrl
*pc
= pinctrl_dev_get_drvdata(pcdev
);
215 meson_pmx_disable_other_groups(pc
, offset
, -1);
220 static int meson_pmx_get_funcs_count(struct pinctrl_dev
*pcdev
)
222 struct meson_pinctrl
*pc
= pinctrl_dev_get_drvdata(pcdev
);
224 return pc
->data
->num_funcs
;
227 static const char *meson_pmx_get_func_name(struct pinctrl_dev
*pcdev
,
230 struct meson_pinctrl
*pc
= pinctrl_dev_get_drvdata(pcdev
);
232 return pc
->data
->funcs
[selector
].name
;
235 static int meson_pmx_get_groups(struct pinctrl_dev
*pcdev
, unsigned selector
,
236 const char * const **groups
,
237 unsigned * const num_groups
)
239 struct meson_pinctrl
*pc
= pinctrl_dev_get_drvdata(pcdev
);
241 *groups
= pc
->data
->funcs
[selector
].groups
;
242 *num_groups
= pc
->data
->funcs
[selector
].num_groups
;
247 static const struct pinmux_ops meson_pmx_ops
= {
248 .set_mux
= meson_pmx_set_mux
,
249 .get_functions_count
= meson_pmx_get_funcs_count
,
250 .get_function_name
= meson_pmx_get_func_name
,
251 .get_function_groups
= meson_pmx_get_groups
,
252 .gpio_request_enable
= meson_pmx_request_gpio
,
255 static int meson_pinconf_set(struct pinctrl_dev
*pcdev
, unsigned int pin
,
256 unsigned long *configs
, unsigned num_configs
)
258 struct meson_pinctrl
*pc
= pinctrl_dev_get_drvdata(pcdev
);
259 struct meson_bank
*bank
;
260 enum pin_config_param param
;
261 unsigned int reg
, bit
;
264 ret
= meson_get_bank(pc
, pin
, &bank
);
268 for (i
= 0; i
< num_configs
; i
++) {
269 param
= pinconf_to_config_param(configs
[i
]);
272 case PIN_CONFIG_BIAS_DISABLE
:
273 dev_dbg(pc
->dev
, "pin %u: disable bias\n", pin
);
275 meson_calc_reg_and_bit(bank
, pin
, REG_PULL
, ®
, &bit
);
276 ret
= regmap_update_bits(pc
->reg_pull
, reg
,
281 case PIN_CONFIG_BIAS_PULL_UP
:
282 dev_dbg(pc
->dev
, "pin %u: enable pull-up\n", pin
);
284 meson_calc_reg_and_bit(bank
, pin
, REG_PULLEN
,
286 ret
= regmap_update_bits(pc
->reg_pullen
, reg
,
291 meson_calc_reg_and_bit(bank
, pin
, REG_PULL
, ®
, &bit
);
292 ret
= regmap_update_bits(pc
->reg_pull
, reg
,
297 case PIN_CONFIG_BIAS_PULL_DOWN
:
298 dev_dbg(pc
->dev
, "pin %u: enable pull-down\n", pin
);
300 meson_calc_reg_and_bit(bank
, pin
, REG_PULLEN
,
302 ret
= regmap_update_bits(pc
->reg_pullen
, reg
,
307 meson_calc_reg_and_bit(bank
, pin
, REG_PULL
, ®
, &bit
);
308 ret
= regmap_update_bits(pc
->reg_pull
, reg
,
321 static int meson_pinconf_get_pull(struct meson_pinctrl
*pc
, unsigned int pin
)
323 struct meson_bank
*bank
;
324 unsigned int reg
, bit
, val
;
327 ret
= meson_get_bank(pc
, pin
, &bank
);
331 meson_calc_reg_and_bit(bank
, pin
, REG_PULLEN
, ®
, &bit
);
333 ret
= regmap_read(pc
->reg_pullen
, reg
, &val
);
337 if (!(val
& BIT(bit
))) {
338 conf
= PIN_CONFIG_BIAS_DISABLE
;
340 meson_calc_reg_and_bit(bank
, pin
, REG_PULL
, ®
, &bit
);
342 ret
= regmap_read(pc
->reg_pull
, reg
, &val
);
347 conf
= PIN_CONFIG_BIAS_PULL_UP
;
349 conf
= PIN_CONFIG_BIAS_PULL_DOWN
;
355 static int meson_pinconf_get(struct pinctrl_dev
*pcdev
, unsigned int pin
,
356 unsigned long *config
)
358 struct meson_pinctrl
*pc
= pinctrl_dev_get_drvdata(pcdev
);
359 enum pin_config_param param
= pinconf_to_config_param(*config
);
363 case PIN_CONFIG_BIAS_DISABLE
:
364 case PIN_CONFIG_BIAS_PULL_DOWN
:
365 case PIN_CONFIG_BIAS_PULL_UP
:
366 if (meson_pinconf_get_pull(pc
, pin
) == param
)
375 *config
= pinconf_to_config_packed(param
, arg
);
376 dev_dbg(pc
->dev
, "pinconf for pin %u is %lu\n", pin
, *config
);
381 static int meson_pinconf_group_set(struct pinctrl_dev
*pcdev
,
382 unsigned int num_group
,
383 unsigned long *configs
, unsigned num_configs
)
385 struct meson_pinctrl
*pc
= pinctrl_dev_get_drvdata(pcdev
);
386 struct meson_pmx_group
*group
= &pc
->data
->groups
[num_group
];
389 dev_dbg(pc
->dev
, "set pinconf for group %s\n", group
->name
);
391 for (i
= 0; i
< group
->num_pins
; i
++) {
392 meson_pinconf_set(pcdev
, group
->pins
[i
], configs
,
399 static int meson_pinconf_group_get(struct pinctrl_dev
*pcdev
,
400 unsigned int group
, unsigned long *config
)
405 static const struct pinconf_ops meson_pinconf_ops
= {
406 .pin_config_get
= meson_pinconf_get
,
407 .pin_config_set
= meson_pinconf_set
,
408 .pin_config_group_get
= meson_pinconf_group_get
,
409 .pin_config_group_set
= meson_pinconf_group_set
,
413 static int meson_gpio_request(struct gpio_chip
*chip
, unsigned gpio
)
415 return pinctrl_request_gpio(chip
->base
+ gpio
);
418 static void meson_gpio_free(struct gpio_chip
*chip
, unsigned gpio
)
420 struct meson_pinctrl
*pc
= gpiochip_get_data(chip
);
422 pinctrl_free_gpio(pc
->data
->pin_base
+ gpio
);
425 static int meson_gpio_direction_input(struct gpio_chip
*chip
, unsigned gpio
)
427 struct meson_pinctrl
*pc
= gpiochip_get_data(chip
);
428 unsigned int reg
, bit
, pin
;
429 struct meson_bank
*bank
;
432 pin
= pc
->data
->pin_base
+ gpio
;
433 ret
= meson_get_bank(pc
, pin
, &bank
);
437 meson_calc_reg_and_bit(bank
, pin
, REG_DIR
, ®
, &bit
);
439 return regmap_update_bits(pc
->reg_gpio
, reg
, BIT(bit
), BIT(bit
));
442 static int meson_gpio_direction_output(struct gpio_chip
*chip
, unsigned gpio
,
445 struct meson_pinctrl
*pc
= gpiochip_get_data(chip
);
446 unsigned int reg
, bit
, pin
;
447 struct meson_bank
*bank
;
450 pin
= pc
->data
->pin_base
+ gpio
;
451 ret
= meson_get_bank(pc
, pin
, &bank
);
455 meson_calc_reg_and_bit(bank
, pin
, REG_DIR
, ®
, &bit
);
456 ret
= regmap_update_bits(pc
->reg_gpio
, reg
, BIT(bit
), 0);
460 meson_calc_reg_and_bit(bank
, pin
, REG_OUT
, ®
, &bit
);
461 return regmap_update_bits(pc
->reg_gpio
, reg
, BIT(bit
),
462 value
? BIT(bit
) : 0);
465 static void meson_gpio_set(struct gpio_chip
*chip
, unsigned gpio
, int value
)
467 struct meson_pinctrl
*pc
= gpiochip_get_data(chip
);
468 unsigned int reg
, bit
, pin
;
469 struct meson_bank
*bank
;
472 pin
= pc
->data
->pin_base
+ gpio
;
473 ret
= meson_get_bank(pc
, pin
, &bank
);
477 meson_calc_reg_and_bit(bank
, pin
, REG_OUT
, ®
, &bit
);
478 regmap_update_bits(pc
->reg_gpio
, reg
, BIT(bit
),
479 value
? BIT(bit
) : 0);
482 static int meson_gpio_get(struct gpio_chip
*chip
, unsigned gpio
)
484 struct meson_pinctrl
*pc
= gpiochip_get_data(chip
);
485 unsigned int reg
, bit
, val
, pin
;
486 struct meson_bank
*bank
;
489 pin
= pc
->data
->pin_base
+ gpio
;
490 ret
= meson_get_bank(pc
, pin
, &bank
);
494 meson_calc_reg_and_bit(bank
, pin
, REG_IN
, ®
, &bit
);
495 regmap_read(pc
->reg_gpio
, reg
, &val
);
497 return !!(val
& BIT(bit
));
500 static const struct of_device_id meson_pinctrl_dt_match
[] = {
502 .compatible
= "amlogic,meson8-cbus-pinctrl",
503 .data
= &meson8_cbus_pinctrl_data
,
506 .compatible
= "amlogic,meson8b-cbus-pinctrl",
507 .data
= &meson8b_cbus_pinctrl_data
,
510 .compatible
= "amlogic,meson8-aobus-pinctrl",
511 .data
= &meson8_aobus_pinctrl_data
,
514 .compatible
= "amlogic,meson8b-aobus-pinctrl",
515 .data
= &meson8b_aobus_pinctrl_data
,
518 .compatible
= "amlogic,meson-gxbb-periphs-pinctrl",
519 .data
= &meson_gxbb_periphs_pinctrl_data
,
522 .compatible
= "amlogic,meson-gxbb-aobus-pinctrl",
523 .data
= &meson_gxbb_aobus_pinctrl_data
,
526 .compatible
= "amlogic,meson-gxl-periphs-pinctrl",
527 .data
= &meson_gxl_periphs_pinctrl_data
,
530 .compatible
= "amlogic,meson-gxl-aobus-pinctrl",
531 .data
= &meson_gxl_aobus_pinctrl_data
,
536 static int meson_gpiolib_register(struct meson_pinctrl
*pc
)
540 pc
->chip
.label
= pc
->data
->name
;
541 pc
->chip
.parent
= pc
->dev
;
542 pc
->chip
.request
= meson_gpio_request
;
543 pc
->chip
.free
= meson_gpio_free
;
544 pc
->chip
.direction_input
= meson_gpio_direction_input
;
545 pc
->chip
.direction_output
= meson_gpio_direction_output
;
546 pc
->chip
.get
= meson_gpio_get
;
547 pc
->chip
.set
= meson_gpio_set
;
548 pc
->chip
.base
= pc
->data
->pin_base
;
549 pc
->chip
.ngpio
= pc
->data
->num_pins
;
550 pc
->chip
.can_sleep
= false;
551 pc
->chip
.of_node
= pc
->of_node
;
552 pc
->chip
.of_gpio_n_cells
= 2;
554 ret
= gpiochip_add_data(&pc
->chip
, pc
);
556 dev_err(pc
->dev
, "can't add gpio chip %s\n",
564 static struct regmap_config meson_regmap_config
= {
570 static struct regmap
*meson_map_resource(struct meson_pinctrl
*pc
,
571 struct device_node
*node
, char *name
)
577 i
= of_property_match_string(node
, "reg-names", name
);
578 if (of_address_to_resource(node
, i
, &res
))
579 return ERR_PTR(-ENOENT
);
581 base
= devm_ioremap_resource(pc
->dev
, &res
);
583 return ERR_CAST(base
);
585 meson_regmap_config
.max_register
= resource_size(&res
) - 4;
586 meson_regmap_config
.name
= devm_kasprintf(pc
->dev
, GFP_KERNEL
,
589 if (!meson_regmap_config
.name
)
590 return ERR_PTR(-ENOMEM
);
592 return devm_regmap_init_mmio(pc
->dev
, base
, &meson_regmap_config
);
595 static int meson_pinctrl_parse_dt(struct meson_pinctrl
*pc
,
596 struct device_node
*node
)
598 struct device_node
*np
, *gpio_np
= NULL
;
600 for_each_child_of_node(node
, np
) {
601 if (!of_find_property(np
, "gpio-controller", NULL
))
604 dev_err(pc
->dev
, "multiple gpio nodes\n");
611 dev_err(pc
->dev
, "no gpio node found\n");
615 pc
->of_node
= gpio_np
;
617 pc
->reg_mux
= meson_map_resource(pc
, gpio_np
, "mux");
618 if (IS_ERR(pc
->reg_mux
)) {
619 dev_err(pc
->dev
, "mux registers not found\n");
620 return PTR_ERR(pc
->reg_mux
);
623 pc
->reg_pull
= meson_map_resource(pc
, gpio_np
, "pull");
624 if (IS_ERR(pc
->reg_pull
)) {
625 dev_err(pc
->dev
, "pull registers not found\n");
626 return PTR_ERR(pc
->reg_pull
);
629 pc
->reg_pullen
= meson_map_resource(pc
, gpio_np
, "pull-enable");
630 /* Use pull region if pull-enable one is not present */
631 if (IS_ERR(pc
->reg_pullen
))
632 pc
->reg_pullen
= pc
->reg_pull
;
634 pc
->reg_gpio
= meson_map_resource(pc
, gpio_np
, "gpio");
635 if (IS_ERR(pc
->reg_gpio
)) {
636 dev_err(pc
->dev
, "gpio registers not found\n");
637 return PTR_ERR(pc
->reg_gpio
);
643 static int meson_pinctrl_probe(struct platform_device
*pdev
)
645 const struct of_device_id
*match
;
646 struct device
*dev
= &pdev
->dev
;
647 struct meson_pinctrl
*pc
;
650 pc
= devm_kzalloc(dev
, sizeof(struct meson_pinctrl
), GFP_KERNEL
);
655 match
= of_match_node(meson_pinctrl_dt_match
, pdev
->dev
.of_node
);
656 pc
->data
= (struct meson_pinctrl_data
*) match
->data
;
658 ret
= meson_pinctrl_parse_dt(pc
, pdev
->dev
.of_node
);
662 pc
->desc
.name
= "pinctrl-meson";
663 pc
->desc
.owner
= THIS_MODULE
;
664 pc
->desc
.pctlops
= &meson_pctrl_ops
;
665 pc
->desc
.pmxops
= &meson_pmx_ops
;
666 pc
->desc
.confops
= &meson_pinconf_ops
;
667 pc
->desc
.pins
= pc
->data
->pins
;
668 pc
->desc
.npins
= pc
->data
->num_pins
;
670 pc
->pcdev
= devm_pinctrl_register(pc
->dev
, &pc
->desc
, pc
);
671 if (IS_ERR(pc
->pcdev
)) {
672 dev_err(pc
->dev
, "can't register pinctrl device");
673 return PTR_ERR(pc
->pcdev
);
676 return meson_gpiolib_register(pc
);
679 static struct platform_driver meson_pinctrl_driver
= {
680 .probe
= meson_pinctrl_probe
,
682 .name
= "meson-pinctrl",
683 .of_match_table
= meson_pinctrl_dt_match
,
686 builtin_platform_driver(meson_pinctrl_driver
);