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/pinctrl/pinconf-generic.h>
47 #include <linux/pinctrl/pinconf.h>
48 #include <linux/pinctrl/pinctrl.h>
49 #include <linux/pinctrl/pinmux.h>
50 #include <linux/platform_device.h>
51 #include <linux/property.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 const 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(const struct meson_bank *bank,
99 enum meson_reg_type reg_type,
100 unsigned int *reg, unsigned int *bit)
102 const struct meson_reg_desc *desc = &bank->regs[reg_type];
104 *bit = (desc->bit + pin - bank->first) * meson_bit_strides[reg_type];
105 *reg = (desc->reg + (*bit / 32)) * 4;
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,
150 int meson_pmx_get_funcs_count(struct pinctrl_dev *pcdev)
152 struct meson_pinctrl *pc = pinctrl_dev_get_drvdata(pcdev);
154 return pc->data->num_funcs;
156 EXPORT_SYMBOL_GPL(meson_pmx_get_funcs_count);
158 const char *meson_pmx_get_func_name(struct pinctrl_dev *pcdev,
161 struct meson_pinctrl *pc = pinctrl_dev_get_drvdata(pcdev);
163 return pc->data->funcs[selector].name;
165 EXPORT_SYMBOL_GPL(meson_pmx_get_func_name);
167 int meson_pmx_get_groups(struct pinctrl_dev *pcdev, unsigned selector,
168 const char * const **groups,
169 unsigned * const num_groups)
171 struct meson_pinctrl *pc = pinctrl_dev_get_drvdata(pcdev);
173 *groups = pc->data->funcs[selector].groups;
174 *num_groups = pc->data->funcs[selector].num_groups;
178 EXPORT_SYMBOL_GPL(meson_pmx_get_groups);
180 static int meson_pinconf_set_gpio_bit(struct meson_pinctrl *pc,
182 unsigned int reg_type,
185 const struct meson_bank *bank;
186 unsigned int reg, bit;
189 ret = meson_get_bank(pc, pin, &bank);
193 meson_calc_reg_and_bit(bank, pin, reg_type, ®, &bit);
194 return regmap_update_bits(pc->reg_gpio, reg, BIT(bit),
198 static int meson_pinconf_get_gpio_bit(struct meson_pinctrl *pc,
200 unsigned int reg_type)
202 const struct meson_bank *bank;
203 unsigned int reg, bit, val;
206 ret = meson_get_bank(pc, pin, &bank);
210 meson_calc_reg_and_bit(bank, pin, reg_type, ®, &bit);
211 ret = regmap_read(pc->reg_gpio, reg, &val);
215 return BIT(bit) & val ? 1 : 0;
218 static int meson_pinconf_set_output(struct meson_pinctrl *pc,
222 return meson_pinconf_set_gpio_bit(pc, pin, MESON_REG_DIR, !out);
225 static int meson_pinconf_get_output(struct meson_pinctrl *pc,
228 int ret = meson_pinconf_get_gpio_bit(pc, pin, MESON_REG_DIR);
236 static int meson_pinconf_set_drive(struct meson_pinctrl *pc,
240 return meson_pinconf_set_gpio_bit(pc, pin, MESON_REG_OUT, high);
243 static int meson_pinconf_get_drive(struct meson_pinctrl *pc,
246 return meson_pinconf_get_gpio_bit(pc, pin, MESON_REG_OUT);
249 static int meson_pinconf_set_output_drive(struct meson_pinctrl *pc,
255 ret = meson_pinconf_set_output(pc, pin, true);
259 return meson_pinconf_set_drive(pc, pin, high);
262 static int meson_pinconf_disable_bias(struct meson_pinctrl *pc,
265 const struct meson_bank *bank;
266 unsigned int reg, bit = 0;
269 ret = meson_get_bank(pc, pin, &bank);
273 meson_calc_reg_and_bit(bank, pin, MESON_REG_PULLEN, ®, &bit);
274 ret = regmap_update_bits(pc->reg_pullen, reg, BIT(bit), 0);
281 static int meson_pinconf_enable_bias(struct meson_pinctrl *pc, unsigned int pin,
284 const struct meson_bank *bank;
285 unsigned int reg, bit, val = 0;
288 ret = meson_get_bank(pc, pin, &bank);
292 meson_calc_reg_and_bit(bank, pin, MESON_REG_PULL, ®, &bit);
296 ret = regmap_update_bits(pc->reg_pull, reg, BIT(bit), val);
300 meson_calc_reg_and_bit(bank, pin, MESON_REG_PULLEN, ®, &bit);
301 ret = regmap_update_bits(pc->reg_pullen, reg, BIT(bit), BIT(bit));
308 static int meson_pinconf_set_drive_strength(struct meson_pinctrl *pc,
310 u16 drive_strength_ua)
312 const struct meson_bank *bank;
313 unsigned int reg, bit, ds_val;
317 dev_err(pc->dev, "drive-strength not supported\n");
321 ret = meson_get_bank(pc, pin, &bank);
325 meson_calc_reg_and_bit(bank, pin, MESON_REG_DS, ®, &bit);
327 if (drive_strength_ua <= 500) {
328 ds_val = MESON_PINCONF_DRV_500UA;
329 } else if (drive_strength_ua <= 2500) {
330 ds_val = MESON_PINCONF_DRV_2500UA;
331 } else if (drive_strength_ua <= 3000) {
332 ds_val = MESON_PINCONF_DRV_3000UA;
333 } else if (drive_strength_ua <= 4000) {
334 ds_val = MESON_PINCONF_DRV_4000UA;
336 dev_warn_once(pc->dev,
337 "pin %u: invalid drive-strength : %d , default to 4mA\n",
338 pin, drive_strength_ua);
339 ds_val = MESON_PINCONF_DRV_4000UA;
342 ret = regmap_update_bits(pc->reg_ds, reg, 0x3 << bit, ds_val << bit);
349 static int meson_pinconf_set(struct pinctrl_dev *pcdev, unsigned int pin,
350 unsigned long *configs, unsigned num_configs)
352 struct meson_pinctrl *pc = pinctrl_dev_get_drvdata(pcdev);
353 enum pin_config_param param;
354 unsigned int arg = 0;
357 for (i = 0; i < num_configs; i++) {
358 param = pinconf_to_config_param(configs[i]);
361 case PIN_CONFIG_DRIVE_STRENGTH_UA:
362 case PIN_CONFIG_OUTPUT_ENABLE:
363 case PIN_CONFIG_OUTPUT:
364 arg = pinconf_to_config_argument(configs[i]);
372 case PIN_CONFIG_BIAS_DISABLE:
373 ret = meson_pinconf_disable_bias(pc, pin);
375 case PIN_CONFIG_BIAS_PULL_UP:
376 ret = meson_pinconf_enable_bias(pc, pin, true);
378 case PIN_CONFIG_BIAS_PULL_DOWN:
379 ret = meson_pinconf_enable_bias(pc, pin, false);
381 case PIN_CONFIG_DRIVE_STRENGTH_UA:
382 ret = meson_pinconf_set_drive_strength(pc, pin, arg);
384 case PIN_CONFIG_OUTPUT_ENABLE:
385 ret = meson_pinconf_set_output(pc, pin, arg);
387 case PIN_CONFIG_OUTPUT:
388 ret = meson_pinconf_set_output_drive(pc, pin, arg);
401 static int meson_pinconf_get_pull(struct meson_pinctrl *pc, unsigned int pin)
403 const struct meson_bank *bank;
404 unsigned int reg, bit, val;
407 ret = meson_get_bank(pc, pin, &bank);
411 meson_calc_reg_and_bit(bank, pin, MESON_REG_PULLEN, ®, &bit);
413 ret = regmap_read(pc->reg_pullen, reg, &val);
417 if (!(val & BIT(bit))) {
418 conf = PIN_CONFIG_BIAS_DISABLE;
420 meson_calc_reg_and_bit(bank, pin, MESON_REG_PULL, ®, &bit);
422 ret = regmap_read(pc->reg_pull, reg, &val);
427 conf = PIN_CONFIG_BIAS_PULL_UP;
429 conf = PIN_CONFIG_BIAS_PULL_DOWN;
435 static int meson_pinconf_get_drive_strength(struct meson_pinctrl *pc,
437 u16 *drive_strength_ua)
439 const struct meson_bank *bank;
440 unsigned int reg, bit;
447 ret = meson_get_bank(pc, pin, &bank);
451 meson_calc_reg_and_bit(bank, pin, MESON_REG_DS, ®, &bit);
453 ret = regmap_read(pc->reg_ds, reg, &val);
457 switch ((val >> bit) & 0x3) {
458 case MESON_PINCONF_DRV_500UA:
459 *drive_strength_ua = 500;
461 case MESON_PINCONF_DRV_2500UA:
462 *drive_strength_ua = 2500;
464 case MESON_PINCONF_DRV_3000UA:
465 *drive_strength_ua = 3000;
467 case MESON_PINCONF_DRV_4000UA:
468 *drive_strength_ua = 4000;
477 static int meson_pinconf_get(struct pinctrl_dev *pcdev, unsigned int pin,
478 unsigned long *config)
480 struct meson_pinctrl *pc = pinctrl_dev_get_drvdata(pcdev);
481 enum pin_config_param param = pinconf_to_config_param(*config);
486 case PIN_CONFIG_BIAS_DISABLE:
487 case PIN_CONFIG_BIAS_PULL_DOWN:
488 case PIN_CONFIG_BIAS_PULL_UP:
489 if (meson_pinconf_get_pull(pc, pin) == param)
494 case PIN_CONFIG_DRIVE_STRENGTH_UA:
495 ret = meson_pinconf_get_drive_strength(pc, pin, &arg);
499 case PIN_CONFIG_OUTPUT_ENABLE:
500 ret = meson_pinconf_get_output(pc, pin);
505 case PIN_CONFIG_OUTPUT:
506 ret = meson_pinconf_get_output(pc, pin);
510 ret = meson_pinconf_get_drive(pc, pin);
521 *config = pinconf_to_config_packed(param, arg);
522 dev_dbg(pc->dev, "pinconf for pin %u is %lu\n", pin, *config);
527 static int meson_pinconf_group_set(struct pinctrl_dev *pcdev,
528 unsigned int num_group,
529 unsigned long *configs, unsigned num_configs)
531 struct meson_pinctrl *pc = pinctrl_dev_get_drvdata(pcdev);
532 const struct meson_pmx_group *group = &pc->data->groups[num_group];
535 dev_dbg(pc->dev, "set pinconf for group %s\n", group->name);
537 for (i = 0; i < group->num_pins; i++) {
538 meson_pinconf_set(pcdev, group->pins[i], configs,
545 static int meson_pinconf_group_get(struct pinctrl_dev *pcdev,
546 unsigned int group, unsigned long *config)
551 static const struct pinconf_ops meson_pinconf_ops = {
552 .pin_config_get = meson_pinconf_get,
553 .pin_config_set = meson_pinconf_set,
554 .pin_config_group_get = meson_pinconf_group_get,
555 .pin_config_group_set = meson_pinconf_group_set,
559 static int meson_gpio_get_direction(struct gpio_chip *chip, unsigned gpio)
561 struct meson_pinctrl *pc = gpiochip_get_data(chip);
564 ret = meson_pinconf_get_output(pc, gpio);
568 return ret ? GPIO_LINE_DIRECTION_OUT : GPIO_LINE_DIRECTION_IN;
571 static int meson_gpio_direction_input(struct gpio_chip *chip, unsigned gpio)
573 return meson_pinconf_set_output(gpiochip_get_data(chip), gpio, false);
576 static int meson_gpio_direction_output(struct gpio_chip *chip, unsigned gpio,
579 return meson_pinconf_set_output_drive(gpiochip_get_data(chip),
583 static void meson_gpio_set(struct gpio_chip *chip, unsigned gpio, int value)
585 meson_pinconf_set_drive(gpiochip_get_data(chip), gpio, value);
588 static int meson_gpio_get(struct gpio_chip *chip, unsigned gpio)
590 struct meson_pinctrl *pc = gpiochip_get_data(chip);
591 const struct meson_bank *bank;
592 unsigned int reg, bit, val;
595 ret = meson_get_bank(pc, gpio, &bank);
599 meson_calc_reg_and_bit(bank, gpio, MESON_REG_IN, ®, &bit);
600 regmap_read(pc->reg_gpio, reg, &val);
602 return !!(val & BIT(bit));
605 static int meson_gpiolib_register(struct meson_pinctrl *pc)
609 pc->chip.label = pc->data->name;
610 pc->chip.parent = pc->dev;
611 pc->chip.fwnode = pc->fwnode;
612 pc->chip.request = gpiochip_generic_request;
613 pc->chip.free = gpiochip_generic_free;
614 pc->chip.set_config = gpiochip_generic_config;
615 pc->chip.get_direction = meson_gpio_get_direction;
616 pc->chip.direction_input = meson_gpio_direction_input;
617 pc->chip.direction_output = meson_gpio_direction_output;
618 pc->chip.get = meson_gpio_get;
619 pc->chip.set = meson_gpio_set;
621 pc->chip.ngpio = pc->data->num_pins;
622 pc->chip.can_sleep = false;
624 ret = gpiochip_add_data(&pc->chip, pc);
626 dev_err(pc->dev, "can't add gpio chip %s\n",
634 static struct regmap_config meson_regmap_config = {
640 static struct regmap *meson_map_resource(struct meson_pinctrl *pc,
641 struct device_node *node, char *name)
647 i = of_property_match_string(node, "reg-names", name);
648 if (of_address_to_resource(node, i, &res))
651 base = devm_ioremap_resource(pc->dev, &res);
653 return ERR_CAST(base);
655 meson_regmap_config.max_register = resource_size(&res) - 4;
656 meson_regmap_config.name = devm_kasprintf(pc->dev, GFP_KERNEL,
659 if (!meson_regmap_config.name)
660 return ERR_PTR(-ENOMEM);
662 return devm_regmap_init_mmio(pc->dev, base, &meson_regmap_config);
665 static int meson_pinctrl_parse_dt(struct meson_pinctrl *pc)
667 struct device_node *gpio_np;
670 chips = gpiochip_node_count(pc->dev);
672 dev_err(pc->dev, "no gpio node found\n");
676 dev_err(pc->dev, "multiple gpio nodes\n");
680 pc->fwnode = gpiochip_node_get_first(pc->dev);
681 gpio_np = to_of_node(pc->fwnode);
683 pc->reg_mux = meson_map_resource(pc, gpio_np, "mux");
684 if (IS_ERR_OR_NULL(pc->reg_mux)) {
685 dev_err(pc->dev, "mux registers not found\n");
686 return pc->reg_mux ? PTR_ERR(pc->reg_mux) : -ENOENT;
689 pc->reg_gpio = meson_map_resource(pc, gpio_np, "gpio");
690 if (IS_ERR_OR_NULL(pc->reg_gpio)) {
691 dev_err(pc->dev, "gpio registers not found\n");
692 return pc->reg_gpio ? PTR_ERR(pc->reg_gpio) : -ENOENT;
695 pc->reg_pull = meson_map_resource(pc, gpio_np, "pull");
696 if (IS_ERR(pc->reg_pull))
699 pc->reg_pullen = meson_map_resource(pc, gpio_np, "pull-enable");
700 if (IS_ERR(pc->reg_pullen))
701 pc->reg_pullen = NULL;
703 pc->reg_ds = meson_map_resource(pc, gpio_np, "ds");
704 if (IS_ERR(pc->reg_ds)) {
705 dev_dbg(pc->dev, "ds registers not found - skipping\n");
709 if (pc->data->parse_dt)
710 return pc->data->parse_dt(pc);
715 int meson8_aobus_parse_dt_extra(struct meson_pinctrl *pc)
720 pc->reg_pullen = pc->reg_pull;
724 EXPORT_SYMBOL_GPL(meson8_aobus_parse_dt_extra);
726 int meson_a1_parse_dt_extra(struct meson_pinctrl *pc)
728 pc->reg_pull = pc->reg_gpio;
729 pc->reg_pullen = pc->reg_gpio;
730 pc->reg_ds = pc->reg_gpio;
734 EXPORT_SYMBOL_GPL(meson_a1_parse_dt_extra);
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);
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);
769 EXPORT_SYMBOL_GPL(meson_pinctrl_probe);
771 MODULE_DESCRIPTION("Amlogic Meson SoCs core pinctrl driver");
772 MODULE_LICENSE("GPL v2");