1 // SPDX-License-Identifier: GPL-2.0-only
3 * Pin controller and GPIO driver for Amlogic Meson SoCs
9 * The available pins are organized in banks (A,B,C,D,E,X,Y,Z,AO,
10 * BOOT,CARD for meson6, X,Y,DV,H,Z,AO,BOOT,CARD for meson8 and
11 * X,Y,DV,H,AO,BOOT,CARD,DIF for meson8b) and each bank has a
12 * variable number of pins.
14 * The AO bank is special because it belongs to the Always-On power
15 * domain which can't be powered off; the bank also uses a set of
16 * registers different from the other banks.
18 * For each pin controller there are 4 different register ranges that
19 * control the following properties of the pins:
21 * 2) pull enable/disable
23 * 4) GPIO direction, output value, input value
25 * In some cases the register ranges for pull enable and pull
26 * direction are the same and thus there are only 3 register ranges.
28 * Since Meson G12A SoC, the ao register ranges for gpio, pull enable
29 * and pull direction are the same, so there are only 2 register ranges.
31 * For the pull and GPIO configuration every bank uses a contiguous
32 * set of bits in the register sets described above; the same register
33 * can be shared by more banks with different offsets.
35 * In addition to this there are some registers shared between all
36 * banks that control the IRQ functionality. This feature is not
37 * supported at the moment by the driver.
40 #include <linux/device.h>
41 #include <linux/gpio/driver.h>
42 #include <linux/init.h>
45 #include <linux/of_address.h>
46 #include <linux/of_device.h>
47 #include <linux/pinctrl/pinconf-generic.h>
48 #include <linux/pinctrl/pinconf.h>
49 #include <linux/pinctrl/pinctrl.h>
50 #include <linux/pinctrl/pinmux.h>
51 #include <linux/platform_device.h>
52 #include <linux/regmap.h>
53 #include <linux/seq_file.h>
56 #include "../pinctrl-utils.h"
57 #include "pinctrl-meson.h"
59 static const unsigned int meson_bit_strides[] = {
64 * meson_get_bank() - find the bank containing a given pin
66 * @pc: the pinctrl instance
67 * @pin: the pin number
68 * @bank: the found bank
70 * Return: 0 on success, a negative value on error
72 static int meson_get_bank(struct meson_pinctrl *pc, unsigned int pin,
73 struct meson_bank **bank)
77 for (i = 0; i < pc->data->num_banks; i++) {
78 if (pin >= pc->data->banks[i].first &&
79 pin <= pc->data->banks[i].last) {
80 *bank = &pc->data->banks[i];
89 * meson_calc_reg_and_bit() - calculate register and bit for a pin
91 * @bank: the bank containing the pin
92 * @pin: the pin number
93 * @reg_type: the type of register needed (pull-enable, pull, etc...)
94 * @reg: the computed register offset
95 * @bit: the computed bit
97 static void meson_calc_reg_and_bit(struct meson_bank *bank, unsigned int pin,
98 enum meson_reg_type reg_type,
99 unsigned int *reg, unsigned int *bit)
101 struct meson_reg_desc *desc = &bank->regs[reg_type];
103 *bit = (desc->bit + pin - bank->first) * meson_bit_strides[reg_type];
104 *reg = (desc->reg + (*bit / 32)) * 4;
108 static int meson_get_groups_count(struct pinctrl_dev *pcdev)
110 struct meson_pinctrl *pc = pinctrl_dev_get_drvdata(pcdev);
112 return pc->data->num_groups;
115 static const char *meson_get_group_name(struct pinctrl_dev *pcdev,
118 struct meson_pinctrl *pc = pinctrl_dev_get_drvdata(pcdev);
120 return pc->data->groups[selector].name;
123 static int meson_get_group_pins(struct pinctrl_dev *pcdev, unsigned selector,
124 const unsigned **pins, unsigned *num_pins)
126 struct meson_pinctrl *pc = pinctrl_dev_get_drvdata(pcdev);
128 *pins = pc->data->groups[selector].pins;
129 *num_pins = pc->data->groups[selector].num_pins;
134 static void meson_pin_dbg_show(struct pinctrl_dev *pcdev, struct seq_file *s,
137 seq_printf(s, " %s", dev_name(pcdev->dev));
140 static const struct pinctrl_ops meson_pctrl_ops = {
141 .get_groups_count = meson_get_groups_count,
142 .get_group_name = meson_get_group_name,
143 .get_group_pins = meson_get_group_pins,
144 .dt_node_to_map = pinconf_generic_dt_node_to_map_all,
145 .dt_free_map = pinctrl_utils_free_map,
146 .pin_dbg_show = meson_pin_dbg_show,
149 int meson_pmx_get_funcs_count(struct pinctrl_dev *pcdev)
151 struct meson_pinctrl *pc = pinctrl_dev_get_drvdata(pcdev);
153 return pc->data->num_funcs;
156 const char *meson_pmx_get_func_name(struct pinctrl_dev *pcdev,
159 struct meson_pinctrl *pc = pinctrl_dev_get_drvdata(pcdev);
161 return pc->data->funcs[selector].name;
164 int meson_pmx_get_groups(struct pinctrl_dev *pcdev, unsigned selector,
165 const char * const **groups,
166 unsigned * const num_groups)
168 struct meson_pinctrl *pc = pinctrl_dev_get_drvdata(pcdev);
170 *groups = pc->data->funcs[selector].groups;
171 *num_groups = pc->data->funcs[selector].num_groups;
176 static int meson_pinconf_set_gpio_bit(struct meson_pinctrl *pc,
178 unsigned int reg_type,
181 struct meson_bank *bank;
182 unsigned int reg, bit;
185 ret = meson_get_bank(pc, pin, &bank);
189 meson_calc_reg_and_bit(bank, pin, reg_type, ®, &bit);
190 return regmap_update_bits(pc->reg_gpio, reg, BIT(bit),
194 static int meson_pinconf_get_gpio_bit(struct meson_pinctrl *pc,
196 unsigned int reg_type)
198 struct meson_bank *bank;
199 unsigned int reg, bit, val;
202 ret = meson_get_bank(pc, pin, &bank);
206 meson_calc_reg_and_bit(bank, pin, reg_type, ®, &bit);
207 ret = regmap_read(pc->reg_gpio, reg, &val);
211 return BIT(bit) & val ? 1 : 0;
214 static int meson_pinconf_set_output(struct meson_pinctrl *pc,
218 return meson_pinconf_set_gpio_bit(pc, pin, REG_DIR, !out);
221 static int meson_pinconf_get_output(struct meson_pinctrl *pc,
224 int ret = meson_pinconf_get_gpio_bit(pc, pin, REG_DIR);
232 static int meson_pinconf_set_drive(struct meson_pinctrl *pc,
236 return meson_pinconf_set_gpio_bit(pc, pin, REG_OUT, high);
239 static int meson_pinconf_get_drive(struct meson_pinctrl *pc,
242 return meson_pinconf_get_gpio_bit(pc, pin, REG_OUT);
245 static int meson_pinconf_set_output_drive(struct meson_pinctrl *pc,
251 ret = meson_pinconf_set_output(pc, pin, true);
255 return meson_pinconf_set_drive(pc, pin, high);
258 static int meson_pinconf_disable_bias(struct meson_pinctrl *pc,
261 struct meson_bank *bank;
262 unsigned int reg, bit = 0;
265 ret = meson_get_bank(pc, pin, &bank);
269 meson_calc_reg_and_bit(bank, pin, REG_PULLEN, ®, &bit);
270 ret = regmap_update_bits(pc->reg_pullen, reg, BIT(bit), 0);
277 static int meson_pinconf_enable_bias(struct meson_pinctrl *pc, unsigned int pin,
280 struct meson_bank *bank;
281 unsigned int reg, bit, val = 0;
284 ret = meson_get_bank(pc, pin, &bank);
288 meson_calc_reg_and_bit(bank, pin, REG_PULL, ®, &bit);
292 ret = regmap_update_bits(pc->reg_pull, reg, BIT(bit), val);
296 meson_calc_reg_and_bit(bank, pin, REG_PULLEN, ®, &bit);
297 ret = regmap_update_bits(pc->reg_pullen, reg, BIT(bit), BIT(bit));
304 static int meson_pinconf_set_drive_strength(struct meson_pinctrl *pc,
306 u16 drive_strength_ua)
308 struct meson_bank *bank;
309 unsigned int reg, bit, ds_val;
313 dev_err(pc->dev, "drive-strength not supported\n");
317 ret = meson_get_bank(pc, pin, &bank);
321 meson_calc_reg_and_bit(bank, pin, REG_DS, ®, &bit);
323 if (drive_strength_ua <= 500) {
324 ds_val = MESON_PINCONF_DRV_500UA;
325 } else if (drive_strength_ua <= 2500) {
326 ds_val = MESON_PINCONF_DRV_2500UA;
327 } else if (drive_strength_ua <= 3000) {
328 ds_val = MESON_PINCONF_DRV_3000UA;
329 } else if (drive_strength_ua <= 4000) {
330 ds_val = MESON_PINCONF_DRV_4000UA;
332 dev_warn_once(pc->dev,
333 "pin %u: invalid drive-strength : %d , default to 4mA\n",
334 pin, drive_strength_ua);
335 ds_val = MESON_PINCONF_DRV_4000UA;
338 ret = regmap_update_bits(pc->reg_ds, reg, 0x3 << bit, ds_val << bit);
345 static int meson_pinconf_set(struct pinctrl_dev *pcdev, unsigned int pin,
346 unsigned long *configs, unsigned num_configs)
348 struct meson_pinctrl *pc = pinctrl_dev_get_drvdata(pcdev);
349 enum pin_config_param param;
350 unsigned int arg = 0;
353 for (i = 0; i < num_configs; i++) {
354 param = pinconf_to_config_param(configs[i]);
357 case PIN_CONFIG_DRIVE_STRENGTH_UA:
358 case PIN_CONFIG_OUTPUT_ENABLE:
359 case PIN_CONFIG_OUTPUT:
360 arg = pinconf_to_config_argument(configs[i]);
368 case PIN_CONFIG_BIAS_DISABLE:
369 ret = meson_pinconf_disable_bias(pc, pin);
371 case PIN_CONFIG_BIAS_PULL_UP:
372 ret = meson_pinconf_enable_bias(pc, pin, true);
374 case PIN_CONFIG_BIAS_PULL_DOWN:
375 ret = meson_pinconf_enable_bias(pc, pin, false);
377 case PIN_CONFIG_DRIVE_STRENGTH_UA:
378 ret = meson_pinconf_set_drive_strength(pc, pin, arg);
380 case PIN_CONFIG_OUTPUT_ENABLE:
381 ret = meson_pinconf_set_output(pc, pin, arg);
383 case PIN_CONFIG_OUTPUT:
384 ret = meson_pinconf_set_output_drive(pc, pin, arg);
397 static int meson_pinconf_get_pull(struct meson_pinctrl *pc, unsigned int pin)
399 struct meson_bank *bank;
400 unsigned int reg, bit, val;
403 ret = meson_get_bank(pc, pin, &bank);
407 meson_calc_reg_and_bit(bank, pin, REG_PULLEN, ®, &bit);
409 ret = regmap_read(pc->reg_pullen, reg, &val);
413 if (!(val & BIT(bit))) {
414 conf = PIN_CONFIG_BIAS_DISABLE;
416 meson_calc_reg_and_bit(bank, pin, REG_PULL, ®, &bit);
418 ret = regmap_read(pc->reg_pull, reg, &val);
423 conf = PIN_CONFIG_BIAS_PULL_UP;
425 conf = PIN_CONFIG_BIAS_PULL_DOWN;
431 static int meson_pinconf_get_drive_strength(struct meson_pinctrl *pc,
433 u16 *drive_strength_ua)
435 struct meson_bank *bank;
436 unsigned int reg, bit;
443 ret = meson_get_bank(pc, pin, &bank);
447 meson_calc_reg_and_bit(bank, pin, REG_DS, ®, &bit);
449 ret = regmap_read(pc->reg_ds, reg, &val);
453 switch ((val >> bit) & 0x3) {
454 case MESON_PINCONF_DRV_500UA:
455 *drive_strength_ua = 500;
457 case MESON_PINCONF_DRV_2500UA:
458 *drive_strength_ua = 2500;
460 case MESON_PINCONF_DRV_3000UA:
461 *drive_strength_ua = 3000;
463 case MESON_PINCONF_DRV_4000UA:
464 *drive_strength_ua = 4000;
473 static int meson_pinconf_get(struct pinctrl_dev *pcdev, unsigned int pin,
474 unsigned long *config)
476 struct meson_pinctrl *pc = pinctrl_dev_get_drvdata(pcdev);
477 enum pin_config_param param = pinconf_to_config_param(*config);
482 case PIN_CONFIG_BIAS_DISABLE:
483 case PIN_CONFIG_BIAS_PULL_DOWN:
484 case PIN_CONFIG_BIAS_PULL_UP:
485 if (meson_pinconf_get_pull(pc, pin) == param)
490 case PIN_CONFIG_DRIVE_STRENGTH_UA:
491 ret = meson_pinconf_get_drive_strength(pc, pin, &arg);
495 case PIN_CONFIG_OUTPUT_ENABLE:
496 ret = meson_pinconf_get_output(pc, pin);
501 case PIN_CONFIG_OUTPUT:
502 ret = meson_pinconf_get_output(pc, pin);
506 ret = meson_pinconf_get_drive(pc, pin);
517 *config = pinconf_to_config_packed(param, arg);
518 dev_dbg(pc->dev, "pinconf for pin %u is %lu\n", pin, *config);
523 static int meson_pinconf_group_set(struct pinctrl_dev *pcdev,
524 unsigned int num_group,
525 unsigned long *configs, unsigned num_configs)
527 struct meson_pinctrl *pc = pinctrl_dev_get_drvdata(pcdev);
528 struct meson_pmx_group *group = &pc->data->groups[num_group];
531 dev_dbg(pc->dev, "set pinconf for group %s\n", group->name);
533 for (i = 0; i < group->num_pins; i++) {
534 meson_pinconf_set(pcdev, group->pins[i], configs,
541 static int meson_pinconf_group_get(struct pinctrl_dev *pcdev,
542 unsigned int group, unsigned long *config)
547 static const struct pinconf_ops meson_pinconf_ops = {
548 .pin_config_get = meson_pinconf_get,
549 .pin_config_set = meson_pinconf_set,
550 .pin_config_group_get = meson_pinconf_group_get,
551 .pin_config_group_set = meson_pinconf_group_set,
555 static int meson_gpio_get_direction(struct gpio_chip *chip, unsigned gpio)
557 struct meson_pinctrl *pc = gpiochip_get_data(chip);
560 ret = meson_pinconf_get_output(pc, gpio);
564 return ret ? GPIO_LINE_DIRECTION_OUT : GPIO_LINE_DIRECTION_IN;
567 static int meson_gpio_direction_input(struct gpio_chip *chip, unsigned gpio)
569 return meson_pinconf_set_output(gpiochip_get_data(chip), gpio, false);
572 static int meson_gpio_direction_output(struct gpio_chip *chip, unsigned gpio,
575 return meson_pinconf_set_output_drive(gpiochip_get_data(chip),
579 static void meson_gpio_set(struct gpio_chip *chip, unsigned gpio, int value)
581 meson_pinconf_set_drive(gpiochip_get_data(chip), gpio, value);
584 static int meson_gpio_get(struct gpio_chip *chip, unsigned gpio)
586 struct meson_pinctrl *pc = gpiochip_get_data(chip);
587 unsigned int reg, bit, val;
588 struct meson_bank *bank;
591 ret = meson_get_bank(pc, gpio, &bank);
595 meson_calc_reg_and_bit(bank, gpio, REG_IN, ®, &bit);
596 regmap_read(pc->reg_gpio, reg, &val);
598 return !!(val & BIT(bit));
601 static int meson_gpiolib_register(struct meson_pinctrl *pc)
605 pc->chip.label = pc->data->name;
606 pc->chip.parent = pc->dev;
607 pc->chip.request = gpiochip_generic_request;
608 pc->chip.free = gpiochip_generic_free;
609 pc->chip.set_config = gpiochip_generic_config;
610 pc->chip.get_direction = meson_gpio_get_direction;
611 pc->chip.direction_input = meson_gpio_direction_input;
612 pc->chip.direction_output = meson_gpio_direction_output;
613 pc->chip.get = meson_gpio_get;
614 pc->chip.set = meson_gpio_set;
616 pc->chip.ngpio = pc->data->num_pins;
617 pc->chip.can_sleep = false;
618 pc->chip.of_node = pc->of_node;
619 pc->chip.of_gpio_n_cells = 2;
621 ret = gpiochip_add_data(&pc->chip, pc);
623 dev_err(pc->dev, "can't add gpio chip %s\n",
631 static struct regmap_config meson_regmap_config = {
637 static struct regmap *meson_map_resource(struct meson_pinctrl *pc,
638 struct device_node *node, char *name)
644 i = of_property_match_string(node, "reg-names", name);
645 if (of_address_to_resource(node, i, &res))
648 base = devm_ioremap_resource(pc->dev, &res);
650 return ERR_CAST(base);
652 meson_regmap_config.max_register = resource_size(&res) - 4;
653 meson_regmap_config.name = devm_kasprintf(pc->dev, GFP_KERNEL,
656 if (!meson_regmap_config.name)
657 return ERR_PTR(-ENOMEM);
659 return devm_regmap_init_mmio(pc->dev, base, &meson_regmap_config);
662 static int meson_pinctrl_parse_dt(struct meson_pinctrl *pc,
663 struct device_node *node)
665 struct device_node *np, *gpio_np = NULL;
667 for_each_child_of_node(node, np) {
668 if (!of_find_property(np, "gpio-controller", NULL))
671 dev_err(pc->dev, "multiple gpio nodes\n");
679 dev_err(pc->dev, "no gpio node found\n");
683 pc->of_node = gpio_np;
685 pc->reg_mux = meson_map_resource(pc, gpio_np, "mux");
686 if (IS_ERR_OR_NULL(pc->reg_mux)) {
687 dev_err(pc->dev, "mux registers not found\n");
688 return pc->reg_mux ? PTR_ERR(pc->reg_mux) : -ENOENT;
691 pc->reg_gpio = meson_map_resource(pc, gpio_np, "gpio");
692 if (IS_ERR_OR_NULL(pc->reg_gpio)) {
693 dev_err(pc->dev, "gpio registers not found\n");
694 return pc->reg_gpio ? PTR_ERR(pc->reg_gpio) : -ENOENT;
697 pc->reg_pull = meson_map_resource(pc, gpio_np, "pull");
698 if (IS_ERR(pc->reg_pull))
701 pc->reg_pullen = meson_map_resource(pc, gpio_np, "pull-enable");
702 if (IS_ERR(pc->reg_pullen))
703 pc->reg_pullen = NULL;
705 pc->reg_ds = meson_map_resource(pc, gpio_np, "ds");
706 if (IS_ERR(pc->reg_ds)) {
707 dev_dbg(pc->dev, "ds registers not found - skipping\n");
711 if (pc->data->parse_dt)
712 return pc->data->parse_dt(pc);
717 int meson8_aobus_parse_dt_extra(struct meson_pinctrl *pc)
722 pc->reg_pullen = pc->reg_pull;
727 int meson_a1_parse_dt_extra(struct meson_pinctrl *pc)
729 pc->reg_pull = pc->reg_gpio;
730 pc->reg_pullen = pc->reg_gpio;
731 pc->reg_ds = pc->reg_gpio;
736 int meson_pinctrl_probe(struct platform_device *pdev)
738 struct device *dev = &pdev->dev;
739 struct meson_pinctrl *pc;
742 pc = devm_kzalloc(dev, sizeof(struct meson_pinctrl), GFP_KERNEL);
747 pc->data = (struct meson_pinctrl_data *) of_device_get_match_data(dev);
749 ret = meson_pinctrl_parse_dt(pc, dev->of_node);
753 pc->desc.name = "pinctrl-meson";
754 pc->desc.owner = THIS_MODULE;
755 pc->desc.pctlops = &meson_pctrl_ops;
756 pc->desc.pmxops = pc->data->pmx_ops;
757 pc->desc.confops = &meson_pinconf_ops;
758 pc->desc.pins = pc->data->pins;
759 pc->desc.npins = pc->data->num_pins;
761 pc->pcdev = devm_pinctrl_register(pc->dev, &pc->desc, pc);
762 if (IS_ERR(pc->pcdev)) {
763 dev_err(pc->dev, "can't register pinctrl device");
764 return PTR_ERR(pc->pcdev);
767 return meson_gpiolib_register(pc);