1 // SPDX-License-Identifier: GPL-2.0
2 // Copyright (C) 2022 Microchip Technology Inc.
3 // pci1xxxx gpio driver
5 #include <linux/module.h>
6 #include <linux/spinlock.h>
7 #include <linux/gpio/driver.h>
9 #include <linux/mutex.h>
10 #include <linux/kthread.h>
11 #include <linux/interrupt.h>
13 #include "mchp_pci1xxxx_gp.h"
15 #define PCI1XXXX_NR_PINS 93
16 #define PERI_GEN_RESET 0
17 #define OUT_EN_OFFSET(x) ((((x) / 32) * 4) + 0x400)
18 #define INP_EN_OFFSET(x) ((((x) / 32) * 4) + 0x400 + 0x10)
19 #define OUT_OFFSET(x) ((((x) / 32) * 4) + 0x400 + 0x20)
20 #define INP_OFFSET(x) ((((x) / 32) * 4) + 0x400 + 0x30)
21 #define PULLUP_OFFSET(x) ((((x) / 32) * 4) + 0x400 + 0x40)
22 #define PULLDOWN_OFFSET(x) ((((x) / 32) * 4) + 0x400 + 0x50)
23 #define OPENDRAIN_OFFSET(x) ((((x) / 32) * 4) + 0x400 + 0x60)
24 #define WAKEMASK_OFFSET(x) ((((x) / 32) * 4) + 0x400 + 0x70)
25 #define MODE_OFFSET(x) ((((x) / 32) * 4) + 0x400 + 0x80)
26 #define INTR_LO_TO_HI_EDGE_CONFIG(x) ((((x) / 32) * 4) + 0x400 + 0x90)
27 #define INTR_HI_TO_LO_EDGE_CONFIG(x) ((((x) / 32) * 4) + 0x400 + 0xA0)
28 #define INTR_LEVEL_CONFIG_OFFSET(x) ((((x) / 32) * 4) + 0x400 + 0xB0)
29 #define INTR_LEVEL_MASK_OFFSET(x) ((((x) / 32) * 4) + 0x400 + 0xC0)
30 #define INTR_STAT_OFFSET(x) ((((x) / 32) * 4) + 0x400 + 0xD0)
31 #define DEBOUNCE_OFFSET(x) ((((x) / 32) * 4) + 0x400 + 0xE0)
32 #define PIO_GLOBAL_CONFIG_OFFSET (0x400 + 0xF0)
33 #define PIO_PCI_CTRL_REG_OFFSET (0x400 + 0xF4)
34 #define INTR_MASK_OFFSET(x) ((((x) / 32) * 4) + 0x400 + 0x100)
35 #define INTR_STATUS_OFFSET(x) (((x) * 4) + 0x400 + 0xD0)
37 struct pci1xxxx_gpio {
38 struct auxiliary_device *aux_dev;
39 void __iomem *reg_base;
40 struct gpio_chip gpio;
45 static int pci1xxxx_gpio_get_direction(struct gpio_chip *gpio, unsigned int nr)
47 struct pci1xxxx_gpio *priv = gpiochip_get_data(gpio);
51 data = readl(priv->reg_base + INP_EN_OFFSET(nr));
52 if (data & BIT(nr % 32)) {
55 data = readl(priv->reg_base + OUT_EN_OFFSET(nr));
56 if (data & BIT(nr % 32))
63 static inline void pci1xxx_assign_bit(void __iomem *base_addr, unsigned int reg_offset,
64 unsigned int bitpos, bool set)
68 data = readl(base_addr + reg_offset);
73 writel(data, base_addr + reg_offset);
76 static int pci1xxxx_gpio_direction_input(struct gpio_chip *gpio, unsigned int nr)
78 struct pci1xxxx_gpio *priv = gpiochip_get_data(gpio);
81 spin_lock_irqsave(&priv->lock, flags);
82 pci1xxx_assign_bit(priv->reg_base, INP_EN_OFFSET(nr), (nr % 32), true);
83 pci1xxx_assign_bit(priv->reg_base, OUT_EN_OFFSET(nr), (nr % 32), false);
84 spin_unlock_irqrestore(&priv->lock, flags);
89 static int pci1xxxx_gpio_get(struct gpio_chip *gpio, unsigned int nr)
91 struct pci1xxxx_gpio *priv = gpiochip_get_data(gpio);
93 return (readl(priv->reg_base + INP_OFFSET(nr)) >> (nr % 32)) & 1;
96 static int pci1xxxx_gpio_direction_output(struct gpio_chip *gpio,
97 unsigned int nr, int val)
99 struct pci1xxxx_gpio *priv = gpiochip_get_data(gpio);
103 spin_lock_irqsave(&priv->lock, flags);
104 pci1xxx_assign_bit(priv->reg_base, INP_EN_OFFSET(nr), (nr % 32), false);
105 pci1xxx_assign_bit(priv->reg_base, OUT_EN_OFFSET(nr), (nr % 32), true);
106 data = readl(priv->reg_base + OUT_OFFSET(nr));
108 data |= (1 << (nr % 32));
110 data &= ~(1 << (nr % 32));
111 writel(data, priv->reg_base + OUT_OFFSET(nr));
112 spin_unlock_irqrestore(&priv->lock, flags);
117 static void pci1xxxx_gpio_set(struct gpio_chip *gpio,
118 unsigned int nr, int val)
120 struct pci1xxxx_gpio *priv = gpiochip_get_data(gpio);
123 spin_lock_irqsave(&priv->lock, flags);
124 pci1xxx_assign_bit(priv->reg_base, OUT_OFFSET(nr), (nr % 32), val);
125 spin_unlock_irqrestore(&priv->lock, flags);
128 static int pci1xxxx_gpio_set_config(struct gpio_chip *gpio, unsigned int offset,
129 unsigned long config)
131 struct pci1xxxx_gpio *priv = gpiochip_get_data(gpio);
135 spin_lock_irqsave(&priv->lock, flags);
136 switch (pinconf_to_config_param(config)) {
137 case PIN_CONFIG_BIAS_PULL_UP:
138 pci1xxx_assign_bit(priv->reg_base, PULLUP_OFFSET(offset), (offset % 32), true);
140 case PIN_CONFIG_BIAS_PULL_DOWN:
141 pci1xxx_assign_bit(priv->reg_base, PULLDOWN_OFFSET(offset), (offset % 32), true);
143 case PIN_CONFIG_BIAS_DISABLE:
144 pci1xxx_assign_bit(priv->reg_base, PULLUP_OFFSET(offset), (offset % 32), false);
145 pci1xxx_assign_bit(priv->reg_base, PULLDOWN_OFFSET(offset), (offset % 32), false);
147 case PIN_CONFIG_DRIVE_OPEN_DRAIN:
148 pci1xxx_assign_bit(priv->reg_base, OPENDRAIN_OFFSET(offset), (offset % 32), true);
154 spin_unlock_irqrestore(&priv->lock, flags);
159 static void pci1xxxx_gpio_irq_ack(struct irq_data *data)
161 struct gpio_chip *chip = irq_data_get_irq_chip_data(data);
162 struct pci1xxxx_gpio *priv = gpiochip_get_data(chip);
163 unsigned int gpio = irqd_to_hwirq(data);
166 spin_lock_irqsave(&priv->lock, flags);
167 pci1xxx_assign_bit(priv->reg_base, INTR_STAT_OFFSET(gpio), (gpio % 32), true);
168 spin_unlock_irqrestore(&priv->lock, flags);
171 static void pci1xxxx_gpio_irq_set_mask(struct irq_data *data, bool set)
173 struct gpio_chip *chip = irq_data_get_irq_chip_data(data);
174 struct pci1xxxx_gpio *priv = gpiochip_get_data(chip);
175 unsigned int gpio = irqd_to_hwirq(data);
179 gpiochip_enable_irq(chip, gpio);
180 spin_lock_irqsave(&priv->lock, flags);
181 pci1xxx_assign_bit(priv->reg_base, INTR_MASK_OFFSET(gpio), (gpio % 32), set);
182 spin_unlock_irqrestore(&priv->lock, flags);
184 gpiochip_disable_irq(chip, gpio);
187 static void pci1xxxx_gpio_irq_mask(struct irq_data *data)
189 pci1xxxx_gpio_irq_set_mask(data, true);
192 static void pci1xxxx_gpio_irq_unmask(struct irq_data *data)
194 pci1xxxx_gpio_irq_set_mask(data, false);
197 static int pci1xxxx_gpio_set_type(struct irq_data *data, unsigned int trigger_type)
199 struct gpio_chip *chip = irq_data_get_irq_chip_data(data);
200 struct pci1xxxx_gpio *priv = gpiochip_get_data(chip);
201 unsigned int gpio = irqd_to_hwirq(data);
202 unsigned int bitpos = gpio % 32;
204 if (trigger_type & IRQ_TYPE_EDGE_FALLING) {
205 pci1xxx_assign_bit(priv->reg_base, INTR_HI_TO_LO_EDGE_CONFIG(gpio),
207 pci1xxx_assign_bit(priv->reg_base, MODE_OFFSET(gpio),
209 irq_set_handler_locked(data, handle_edge_irq);
211 pci1xxx_assign_bit(priv->reg_base, INTR_HI_TO_LO_EDGE_CONFIG(gpio),
215 if (trigger_type & IRQ_TYPE_EDGE_RISING) {
216 pci1xxx_assign_bit(priv->reg_base, INTR_LO_TO_HI_EDGE_CONFIG(gpio),
218 pci1xxx_assign_bit(priv->reg_base, MODE_OFFSET(gpio), bitpos,
220 irq_set_handler_locked(data, handle_edge_irq);
222 pci1xxx_assign_bit(priv->reg_base, INTR_LO_TO_HI_EDGE_CONFIG(gpio),
226 if (trigger_type & IRQ_TYPE_LEVEL_LOW) {
227 pci1xxx_assign_bit(priv->reg_base, INTR_LEVEL_CONFIG_OFFSET(gpio),
229 pci1xxx_assign_bit(priv->reg_base, INTR_LEVEL_MASK_OFFSET(gpio),
231 pci1xxx_assign_bit(priv->reg_base, MODE_OFFSET(gpio), bitpos,
233 irq_set_handler_locked(data, handle_edge_irq);
236 if (trigger_type & IRQ_TYPE_LEVEL_HIGH) {
237 pci1xxx_assign_bit(priv->reg_base, INTR_LEVEL_CONFIG_OFFSET(gpio),
239 pci1xxx_assign_bit(priv->reg_base, INTR_LEVEL_MASK_OFFSET(gpio),
241 pci1xxx_assign_bit(priv->reg_base, MODE_OFFSET(gpio), bitpos,
243 irq_set_handler_locked(data, handle_edge_irq);
246 if ((!(trigger_type & IRQ_TYPE_LEVEL_LOW)) && (!(trigger_type & IRQ_TYPE_LEVEL_HIGH)))
247 pci1xxx_assign_bit(priv->reg_base, INTR_LEVEL_MASK_OFFSET(gpio), bitpos, true);
252 static irqreturn_t pci1xxxx_gpio_irq_handler(int irq, void *dev_id)
254 struct pci1xxxx_gpio *priv = dev_id;
255 struct gpio_chip *gc = &priv->gpio;
256 unsigned long int_status = 0;
262 spin_lock_irqsave(&priv->lock, flags);
263 pci1xxx_assign_bit(priv->reg_base, PIO_GLOBAL_CONFIG_OFFSET, 16, true);
264 spin_unlock_irqrestore(&priv->lock, flags);
265 for (gpiobank = 0; gpiobank < 3; gpiobank++) {
266 spin_lock_irqsave(&priv->lock, flags);
267 int_status = readl(priv->reg_base + INTR_STATUS_OFFSET(gpiobank));
268 spin_unlock_irqrestore(&priv->lock, flags);
273 for_each_set_bit(bit, &int_status, pincount) {
276 spin_lock_irqsave(&priv->lock, flags);
277 writel(BIT(bit), priv->reg_base + INTR_STATUS_OFFSET(gpiobank));
278 spin_unlock_irqrestore(&priv->lock, flags);
279 irq = irq_find_mapping(gc->irq.domain, (bit + (gpiobank * 32)));
280 generic_handle_irq(irq);
283 spin_lock_irqsave(&priv->lock, flags);
284 pci1xxx_assign_bit(priv->reg_base, PIO_GLOBAL_CONFIG_OFFSET, 16, false);
285 spin_unlock_irqrestore(&priv->lock, flags);
290 static const struct irq_chip pci1xxxx_gpio_irqchip = {
291 .name = "pci1xxxx_gpio",
292 .irq_ack = pci1xxxx_gpio_irq_ack,
293 .irq_mask = pci1xxxx_gpio_irq_mask,
294 .irq_unmask = pci1xxxx_gpio_irq_unmask,
295 .irq_set_type = pci1xxxx_gpio_set_type,
296 .flags = IRQCHIP_IMMUTABLE,
297 GPIOCHIP_IRQ_RESOURCE_HELPERS,
300 static int pci1xxxx_gpio_suspend(struct device *dev)
302 struct pci1xxxx_gpio *priv = dev_get_drvdata(dev);
305 spin_lock_irqsave(&priv->lock, flags);
306 pci1xxx_assign_bit(priv->reg_base, PIO_GLOBAL_CONFIG_OFFSET,
308 pci1xxx_assign_bit(priv->reg_base, PIO_GLOBAL_CONFIG_OFFSET,
310 pci1xxx_assign_bit(priv->reg_base, PERI_GEN_RESET, 16, true);
311 spin_unlock_irqrestore(&priv->lock, flags);
316 static int pci1xxxx_gpio_resume(struct device *dev)
318 struct pci1xxxx_gpio *priv = dev_get_drvdata(dev);
321 spin_lock_irqsave(&priv->lock, flags);
322 pci1xxx_assign_bit(priv->reg_base, PIO_GLOBAL_CONFIG_OFFSET,
324 pci1xxx_assign_bit(priv->reg_base, PIO_GLOBAL_CONFIG_OFFSET,
326 pci1xxx_assign_bit(priv->reg_base, PERI_GEN_RESET, 16, false);
327 spin_unlock_irqrestore(&priv->lock, flags);
332 static int pci1xxxx_gpio_setup(struct pci1xxxx_gpio *priv, int irq)
334 struct gpio_chip *gchip = &priv->gpio;
335 struct gpio_irq_chip *girq;
338 gchip->label = dev_name(&priv->aux_dev->dev);
339 gchip->parent = &priv->aux_dev->dev;
340 gchip->owner = THIS_MODULE;
341 gchip->direction_input = pci1xxxx_gpio_direction_input;
342 gchip->direction_output = pci1xxxx_gpio_direction_output;
343 gchip->get_direction = pci1xxxx_gpio_get_direction;
344 gchip->get = pci1xxxx_gpio_get;
345 gchip->set = pci1xxxx_gpio_set;
346 gchip->set_config = pci1xxxx_gpio_set_config;
347 gchip->dbg_show = NULL;
349 gchip->ngpio = PCI1XXXX_NR_PINS;
350 gchip->can_sleep = false;
352 retval = devm_request_threaded_irq(&priv->aux_dev->dev, irq,
353 NULL, pci1xxxx_gpio_irq_handler,
354 IRQF_ONESHOT, "PCI1xxxxGPIO", priv);
359 girq = &priv->gpio.irq;
360 gpio_irq_chip_set_chip(girq, &pci1xxxx_gpio_irqchip);
361 girq->parent_handler = NULL;
362 girq->num_parents = 0;
363 girq->parents = NULL;
364 girq->default_type = IRQ_TYPE_NONE;
365 girq->handler = handle_bad_irq;
370 static int pci1xxxx_gpio_probe(struct auxiliary_device *aux_dev,
371 const struct auxiliary_device_id *id)
374 struct auxiliary_device_wrapper *aux_dev_wrapper;
375 struct gp_aux_data_type *pdata;
376 struct pci1xxxx_gpio *priv;
379 aux_dev_wrapper = (struct auxiliary_device_wrapper *)
380 container_of(aux_dev, struct auxiliary_device_wrapper, aux_dev);
382 pdata = &aux_dev_wrapper->gp_aux_data;
387 priv = devm_kzalloc(&aux_dev->dev, sizeof(struct pci1xxxx_gpio), GFP_KERNEL);
391 spin_lock_init(&priv->lock);
392 priv->aux_dev = aux_dev;
394 if (!devm_request_mem_region(&aux_dev->dev, pdata->region_start, 0x800, aux_dev->name))
397 priv->reg_base = devm_ioremap(&aux_dev->dev, pdata->region_start, 0x800);
401 writel(0x0264, (priv->reg_base + 0x400 + 0xF0));
403 retval = pci1xxxx_gpio_setup(priv, pdata->irq_num);
408 dev_set_drvdata(&aux_dev->dev, priv);
410 return devm_gpiochip_add_data(&aux_dev->dev, &priv->gpio, priv);
413 static DEFINE_SIMPLE_DEV_PM_OPS(pci1xxxx_gpio_pm_ops, pci1xxxx_gpio_suspend, pci1xxxx_gpio_resume);
415 static const struct auxiliary_device_id pci1xxxx_gpio_auxiliary_id_table[] = {
416 {.name = "mchp_pci1xxxx_gp.gp_gpio"},
419 MODULE_DEVICE_TABLE(auxiliary, pci1xxxx_gpio_auxiliary_id_table);
421 static struct auxiliary_driver pci1xxxx_gpio_driver = {
423 .name = "PCI1xxxxGPIO",
424 .pm = &pci1xxxx_gpio_pm_ops,
426 .probe = pci1xxxx_gpio_probe,
427 .id_table = pci1xxxx_gpio_auxiliary_id_table
429 module_auxiliary_driver(pci1xxxx_gpio_driver);
431 MODULE_DESCRIPTION("Microchip Technology Inc. PCI1xxxx GPIO controller");
432 MODULE_AUTHOR("Kumaravel Thiagarajan <kumaravel.thiagarajan@microchip.com>");
433 MODULE_LICENSE("GPL");