1 // SPDX-License-Identifier: GPL-2.0-only
3 * regmap based generic GPIO driver
5 * Copyright 2020 Michael Walle <michael@walle.cc>
8 #include <linux/gpio/driver.h>
9 #include <linux/gpio/regmap.h>
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/regmap.h>
15 struct device *parent;
16 struct regmap *regmap;
17 struct gpio_chip gpio_chip;
21 unsigned int reg_dat_base;
22 unsigned int reg_set_base;
23 unsigned int reg_clr_base;
24 unsigned int reg_dir_in_base;
25 unsigned int reg_dir_out_base;
27 int (*reg_mask_xlate)(struct gpio_regmap *gpio, unsigned int base,
28 unsigned int offset, unsigned int *reg,
34 static unsigned int gpio_regmap_addr(unsigned int addr)
36 if (addr == GPIO_REGMAP_ADDR_ZERO)
42 static int gpio_regmap_simple_xlate(struct gpio_regmap *gpio,
43 unsigned int base, unsigned int offset,
44 unsigned int *reg, unsigned int *mask)
46 unsigned int line = offset % gpio->ngpio_per_reg;
47 unsigned int stride = offset / gpio->ngpio_per_reg;
49 *reg = base + stride * gpio->reg_stride;
55 static int gpio_regmap_get(struct gpio_chip *chip, unsigned int offset)
57 struct gpio_regmap *gpio = gpiochip_get_data(chip);
58 unsigned int base, val, reg, mask;
61 /* we might not have an output register if we are input only */
62 if (gpio->reg_dat_base)
63 base = gpio_regmap_addr(gpio->reg_dat_base);
65 base = gpio_regmap_addr(gpio->reg_set_base);
67 ret = gpio->reg_mask_xlate(gpio, base, offset, ®, &mask);
71 ret = regmap_read(gpio->regmap, reg, &val);
75 return !!(val & mask);
78 static void gpio_regmap_set(struct gpio_chip *chip, unsigned int offset,
81 struct gpio_regmap *gpio = gpiochip_get_data(chip);
82 unsigned int base = gpio_regmap_addr(gpio->reg_set_base);
83 unsigned int reg, mask;
85 gpio->reg_mask_xlate(gpio, base, offset, ®, &mask);
87 regmap_update_bits(gpio->regmap, reg, mask, mask);
89 regmap_update_bits(gpio->regmap, reg, mask, 0);
92 static void gpio_regmap_set_with_clear(struct gpio_chip *chip,
93 unsigned int offset, int val)
95 struct gpio_regmap *gpio = gpiochip_get_data(chip);
96 unsigned int base, reg, mask;
99 base = gpio_regmap_addr(gpio->reg_set_base);
101 base = gpio_regmap_addr(gpio->reg_clr_base);
103 gpio->reg_mask_xlate(gpio, base, offset, ®, &mask);
104 regmap_write(gpio->regmap, reg, mask);
107 static int gpio_regmap_get_direction(struct gpio_chip *chip,
110 struct gpio_regmap *gpio = gpiochip_get_data(chip);
111 unsigned int base, val, reg, mask;
114 if (gpio->reg_dat_base && !gpio->reg_set_base)
115 return GPIO_LINE_DIRECTION_IN;
116 if (gpio->reg_set_base && !gpio->reg_dat_base)
117 return GPIO_LINE_DIRECTION_OUT;
119 if (gpio->reg_dir_out_base) {
120 base = gpio_regmap_addr(gpio->reg_dir_out_base);
122 } else if (gpio->reg_dir_in_base) {
123 base = gpio_regmap_addr(gpio->reg_dir_in_base);
129 ret = gpio->reg_mask_xlate(gpio, base, offset, ®, &mask);
133 ret = regmap_read(gpio->regmap, reg, &val);
137 if (!!(val & mask) ^ invert)
138 return GPIO_LINE_DIRECTION_OUT;
140 return GPIO_LINE_DIRECTION_IN;
143 static int gpio_regmap_set_direction(struct gpio_chip *chip,
144 unsigned int offset, bool output)
146 struct gpio_regmap *gpio = gpiochip_get_data(chip);
147 unsigned int base, val, reg, mask;
150 if (gpio->reg_dir_out_base) {
151 base = gpio_regmap_addr(gpio->reg_dir_out_base);
153 } else if (gpio->reg_dir_in_base) {
154 base = gpio_regmap_addr(gpio->reg_dir_in_base);
160 ret = gpio->reg_mask_xlate(gpio, base, offset, ®, &mask);
165 val = output ? 0 : mask;
167 val = output ? mask : 0;
169 return regmap_update_bits(gpio->regmap, reg, mask, val);
172 static int gpio_regmap_direction_input(struct gpio_chip *chip,
175 return gpio_regmap_set_direction(chip, offset, false);
178 static int gpio_regmap_direction_output(struct gpio_chip *chip,
179 unsigned int offset, int value)
181 gpio_regmap_set(chip, offset, value);
183 return gpio_regmap_set_direction(chip, offset, true);
186 void *gpio_regmap_get_drvdata(struct gpio_regmap *gpio)
188 return gpio->driver_data;
190 EXPORT_SYMBOL_GPL(gpio_regmap_get_drvdata);
193 * gpio_regmap_register() - Register a generic regmap GPIO controller
194 * @config: configuration for gpio_regmap
196 * Return: A pointer to the registered gpio_regmap or ERR_PTR error value.
198 struct gpio_regmap *gpio_regmap_register(const struct gpio_regmap_config *config)
200 struct gpio_regmap *gpio;
201 struct gpio_chip *chip;
205 return ERR_PTR(-EINVAL);
208 return ERR_PTR(-EINVAL);
210 /* we need at least one */
211 if (!config->reg_dat_base && !config->reg_set_base)
212 return ERR_PTR(-EINVAL);
214 /* if we have a direction register we need both input and output */
215 if ((config->reg_dir_out_base || config->reg_dir_in_base) &&
216 (!config->reg_dat_base || !config->reg_set_base))
217 return ERR_PTR(-EINVAL);
219 /* we don't support having both registers simultaneously for now */
220 if (config->reg_dir_out_base && config->reg_dir_in_base)
221 return ERR_PTR(-EINVAL);
223 gpio = kzalloc(sizeof(*gpio), GFP_KERNEL);
225 return ERR_PTR(-ENOMEM);
227 gpio->parent = config->parent;
228 gpio->driver_data = config->drvdata;
229 gpio->regmap = config->regmap;
230 gpio->ngpio_per_reg = config->ngpio_per_reg;
231 gpio->reg_stride = config->reg_stride;
232 gpio->reg_mask_xlate = config->reg_mask_xlate;
233 gpio->reg_dat_base = config->reg_dat_base;
234 gpio->reg_set_base = config->reg_set_base;
235 gpio->reg_clr_base = config->reg_clr_base;
236 gpio->reg_dir_in_base = config->reg_dir_in_base;
237 gpio->reg_dir_out_base = config->reg_dir_out_base;
239 /* if not set, assume there is only one register */
240 if (!gpio->ngpio_per_reg)
241 gpio->ngpio_per_reg = config->ngpio;
243 /* if not set, assume they are consecutive */
244 if (!gpio->reg_stride)
245 gpio->reg_stride = 1;
247 if (!gpio->reg_mask_xlate)
248 gpio->reg_mask_xlate = gpio_regmap_simple_xlate;
250 chip = &gpio->gpio_chip;
251 chip->parent = config->parent;
252 chip->fwnode = config->fwnode;
254 chip->ngpio = config->ngpio;
255 chip->names = config->names;
256 chip->label = config->label ?: dev_name(config->parent);
257 chip->can_sleep = regmap_might_sleep(config->regmap);
259 chip->get = gpio_regmap_get;
260 if (gpio->reg_set_base && gpio->reg_clr_base)
261 chip->set = gpio_regmap_set_with_clear;
262 else if (gpio->reg_set_base)
263 chip->set = gpio_regmap_set;
265 chip->get_direction = gpio_regmap_get_direction;
266 if (gpio->reg_dir_in_base || gpio->reg_dir_out_base) {
267 chip->direction_input = gpio_regmap_direction_input;
268 chip->direction_output = gpio_regmap_direction_output;
271 ret = gpiochip_add_data(chip, gpio);
275 if (config->irq_domain) {
276 ret = gpiochip_irqchip_add_domain(chip, config->irq_domain);
278 goto err_remove_gpiochip;
284 gpiochip_remove(chip);
289 EXPORT_SYMBOL_GPL(gpio_regmap_register);
292 * gpio_regmap_unregister() - Unregister a generic regmap GPIO controller
293 * @gpio: gpio_regmap device to unregister
295 void gpio_regmap_unregister(struct gpio_regmap *gpio)
297 gpiochip_remove(&gpio->gpio_chip);
300 EXPORT_SYMBOL_GPL(gpio_regmap_unregister);
302 static void devm_gpio_regmap_unregister(void *res)
304 gpio_regmap_unregister(res);
308 * devm_gpio_regmap_register() - resource managed gpio_regmap_register()
309 * @dev: device that is registering this GPIO device
310 * @config: configuration for gpio_regmap
312 * Managed gpio_regmap_register(). For generic regmap GPIO device registered by
313 * this function, gpio_regmap_unregister() is automatically called on driver
314 * detach. See gpio_regmap_register() for more information.
316 * Return: A pointer to the registered gpio_regmap or ERR_PTR error value.
318 struct gpio_regmap *devm_gpio_regmap_register(struct device *dev,
319 const struct gpio_regmap_config *config)
321 struct gpio_regmap *gpio;
324 gpio = gpio_regmap_register(config);
329 ret = devm_add_action_or_reset(dev, devm_gpio_regmap_unregister, gpio);
335 EXPORT_SYMBOL_GPL(devm_gpio_regmap_register);
337 MODULE_AUTHOR("Michael Walle <michael@walle.cc>");
338 MODULE_DESCRIPTION("GPIO generic regmap driver core");
339 MODULE_LICENSE("GPL");