Merge tag 'for-6.8/io_uring-2024-01-18' of git://git.kernel.dk/linux
[linux-block.git] / drivers / gpio / gpio-altera.c
CommitLineData
1ccea77e 1// SPDX-License-Identifier: GPL-2.0-or-later
c5abbba9
THL
2/*
3 * Copyright (C) 2013 Altera Corporation
4 * Based on gpio-mpc8xxx.c
c5abbba9
THL
5 */
6
7#include <linux/io.h>
7b5409ee 8#include <linux/module.h>
40a1f9b2 9#include <linux/gpio/driver.h>
a99cc668 10#include <linux/gpio/legacy-of-mm-gpiochip.h>
c5abbba9
THL
11#include <linux/platform_device.h>
12
13#define ALTERA_GPIO_MAX_NGPIO 32
14#define ALTERA_GPIO_DATA 0x0
15#define ALTERA_GPIO_DIR 0x4
16#define ALTERA_GPIO_IRQ_MASK 0x8
17#define ALTERA_GPIO_EDGE_CAP 0xc
18
19/**
20* struct altera_gpio_chip
21* @mmchip : memory mapped chip structure.
22* @gpio_lock : synchronization lock so that new irq/set/get requests
9ce01efe 23* will be blocked until the current one completes.
c5abbba9 24* @interrupt_trigger : specifies the hardware configured IRQ trigger type
9ce01efe 25* (rising, falling, both, high)
c5abbba9
THL
26* @mapped_irq : kernel mapped irq number.
27*/
28struct altera_gpio_chip {
29 struct of_mm_gpio_chip mmchip;
21d01c9c 30 raw_spinlock_t gpio_lock;
c5abbba9
THL
31 int interrupt_trigger;
32 int mapped_irq;
33};
34
35static void altera_gpio_irq_unmask(struct irq_data *d)
36{
37 struct altera_gpio_chip *altera_gc;
38 struct of_mm_gpio_chip *mm_gc;
39 unsigned long flags;
40 u32 intmask;
41
397d0773 42 altera_gc = gpiochip_get_data(irq_data_get_irq_chip_data(d));
c5abbba9 43 mm_gc = &altera_gc->mmchip;
5cd79816 44 gpiochip_enable_irq(&mm_gc->gc, irqd_to_hwirq(d));
c5abbba9 45
21d01c9c 46 raw_spin_lock_irqsave(&altera_gc->gpio_lock, flags);
c5abbba9
THL
47 intmask = readl(mm_gc->regs + ALTERA_GPIO_IRQ_MASK);
48 /* Set ALTERA_GPIO_IRQ_MASK bit to unmask */
49 intmask |= BIT(irqd_to_hwirq(d));
50 writel(intmask, mm_gc->regs + ALTERA_GPIO_IRQ_MASK);
21d01c9c 51 raw_spin_unlock_irqrestore(&altera_gc->gpio_lock, flags);
c5abbba9
THL
52}
53
54static void altera_gpio_irq_mask(struct irq_data *d)
55{
56 struct altera_gpio_chip *altera_gc;
57 struct of_mm_gpio_chip *mm_gc;
58 unsigned long flags;
59 u32 intmask;
60
397d0773 61 altera_gc = gpiochip_get_data(irq_data_get_irq_chip_data(d));
c5abbba9
THL
62 mm_gc = &altera_gc->mmchip;
63
21d01c9c 64 raw_spin_lock_irqsave(&altera_gc->gpio_lock, flags);
c5abbba9
THL
65 intmask = readl(mm_gc->regs + ALTERA_GPIO_IRQ_MASK);
66 /* Clear ALTERA_GPIO_IRQ_MASK bit to mask */
67 intmask &= ~BIT(irqd_to_hwirq(d));
68 writel(intmask, mm_gc->regs + ALTERA_GPIO_IRQ_MASK);
21d01c9c 69 raw_spin_unlock_irqrestore(&altera_gc->gpio_lock, flags);
5cd79816 70 gpiochip_disable_irq(&mm_gc->gc, irqd_to_hwirq(d));
c5abbba9
THL
71}
72
670647d7 73/*
c5abbba9
THL
74 * This controller's IRQ type is synthesized in hardware, so this function
75 * just checks if the requested set_type matches the synthesized IRQ type
76 */
77static int altera_gpio_irq_set_type(struct irq_data *d,
78 unsigned int type)
79{
80 struct altera_gpio_chip *altera_gc;
81
397d0773 82 altera_gc = gpiochip_get_data(irq_data_get_irq_chip_data(d));
c5abbba9 83
f759921c
PR
84 if (type == IRQ_TYPE_NONE) {
85 irq_set_handler_locked(d, handle_bad_irq);
c5abbba9 86 return 0;
f759921c
PR
87 }
88 if (type == altera_gc->interrupt_trigger) {
89 if (type == IRQ_TYPE_LEVEL_HIGH)
90 irq_set_handler_locked(d, handle_level_irq);
91 else
92 irq_set_handler_locked(d, handle_simple_irq);
c5abbba9 93 return 0;
f759921c
PR
94 }
95 irq_set_handler_locked(d, handle_bad_irq);
c5abbba9
THL
96 return -EINVAL;
97}
98
38e003f4
DL
99static unsigned int altera_gpio_irq_startup(struct irq_data *d)
100{
c5abbba9
THL
101 altera_gpio_irq_unmask(d);
102
103 return 0;
104}
105
c5abbba9
THL
106static int altera_gpio_get(struct gpio_chip *gc, unsigned offset)
107{
108 struct of_mm_gpio_chip *mm_gc;
109
110 mm_gc = to_of_mm_gpio_chip(gc);
111
112 return !!(readl(mm_gc->regs + ALTERA_GPIO_DATA) & BIT(offset));
113}
114
115static void altera_gpio_set(struct gpio_chip *gc, unsigned offset, int value)
116{
117 struct of_mm_gpio_chip *mm_gc;
118 struct altera_gpio_chip *chip;
119 unsigned long flags;
120 unsigned int data_reg;
121
122 mm_gc = to_of_mm_gpio_chip(gc);
397d0773 123 chip = gpiochip_get_data(gc);
c5abbba9 124
21d01c9c 125 raw_spin_lock_irqsave(&chip->gpio_lock, flags);
c5abbba9
THL
126 data_reg = readl(mm_gc->regs + ALTERA_GPIO_DATA);
127 if (value)
128 data_reg |= BIT(offset);
129 else
130 data_reg &= ~BIT(offset);
131 writel(data_reg, mm_gc->regs + ALTERA_GPIO_DATA);
21d01c9c 132 raw_spin_unlock_irqrestore(&chip->gpio_lock, flags);
c5abbba9
THL
133}
134
135static int altera_gpio_direction_input(struct gpio_chip *gc, unsigned offset)
136{
137 struct of_mm_gpio_chip *mm_gc;
138 struct altera_gpio_chip *chip;
139 unsigned long flags;
140 unsigned int gpio_ddr;
141
142 mm_gc = to_of_mm_gpio_chip(gc);
397d0773 143 chip = gpiochip_get_data(gc);
c5abbba9 144
21d01c9c 145 raw_spin_lock_irqsave(&chip->gpio_lock, flags);
c5abbba9
THL
146 /* Set pin as input, assumes software controlled IP */
147 gpio_ddr = readl(mm_gc->regs + ALTERA_GPIO_DIR);
148 gpio_ddr &= ~BIT(offset);
149 writel(gpio_ddr, mm_gc->regs + ALTERA_GPIO_DIR);
21d01c9c 150 raw_spin_unlock_irqrestore(&chip->gpio_lock, flags);
c5abbba9
THL
151
152 return 0;
153}
154
155static int altera_gpio_direction_output(struct gpio_chip *gc,
156 unsigned offset, int value)
157{
158 struct of_mm_gpio_chip *mm_gc;
159 struct altera_gpio_chip *chip;
160 unsigned long flags;
161 unsigned int data_reg, gpio_ddr;
162
163 mm_gc = to_of_mm_gpio_chip(gc);
397d0773 164 chip = gpiochip_get_data(gc);
c5abbba9 165
21d01c9c 166 raw_spin_lock_irqsave(&chip->gpio_lock, flags);
c5abbba9
THL
167 /* Sets the GPIO value */
168 data_reg = readl(mm_gc->regs + ALTERA_GPIO_DATA);
169 if (value)
170 data_reg |= BIT(offset);
171 else
172 data_reg &= ~BIT(offset);
173 writel(data_reg, mm_gc->regs + ALTERA_GPIO_DATA);
174
175 /* Set pin as output, assumes software controlled IP */
176 gpio_ddr = readl(mm_gc->regs + ALTERA_GPIO_DIR);
177 gpio_ddr |= BIT(offset);
178 writel(gpio_ddr, mm_gc->regs + ALTERA_GPIO_DIR);
21d01c9c 179 raw_spin_unlock_irqrestore(&chip->gpio_lock, flags);
c5abbba9
THL
180
181 return 0;
182}
183
bd0b9ac4 184static void altera_gpio_irq_edge_handler(struct irq_desc *desc)
c5abbba9
THL
185{
186 struct altera_gpio_chip *altera_gc;
187 struct irq_chip *chip;
188 struct of_mm_gpio_chip *mm_gc;
189 struct irq_domain *irqdomain;
190 unsigned long status;
191 int i;
192
397d0773 193 altera_gc = gpiochip_get_data(irq_desc_get_handler_data(desc));
c5abbba9
THL
194 chip = irq_desc_get_chip(desc);
195 mm_gc = &altera_gc->mmchip;
f0fbe7bc 196 irqdomain = altera_gc->mmchip.gc.irq.domain;
c5abbba9
THL
197
198 chained_irq_enter(chip, desc);
199
200 while ((status =
201 (readl(mm_gc->regs + ALTERA_GPIO_EDGE_CAP) &
202 readl(mm_gc->regs + ALTERA_GPIO_IRQ_MASK)))) {
203 writel(status, mm_gc->regs + ALTERA_GPIO_EDGE_CAP);
dbd1c54f
MZ
204 for_each_set_bit(i, &status, mm_gc->gc.ngpio)
205 generic_handle_domain_irq(irqdomain, i);
c5abbba9
THL
206 }
207
208 chained_irq_exit(chip, desc);
209}
210
bd0b9ac4 211static void altera_gpio_irq_leveL_high_handler(struct irq_desc *desc)
c5abbba9
THL
212{
213 struct altera_gpio_chip *altera_gc;
214 struct irq_chip *chip;
215 struct of_mm_gpio_chip *mm_gc;
216 struct irq_domain *irqdomain;
217 unsigned long status;
218 int i;
219
397d0773 220 altera_gc = gpiochip_get_data(irq_desc_get_handler_data(desc));
c5abbba9
THL
221 chip = irq_desc_get_chip(desc);
222 mm_gc = &altera_gc->mmchip;
f0fbe7bc 223 irqdomain = altera_gc->mmchip.gc.irq.domain;
c5abbba9
THL
224
225 chained_irq_enter(chip, desc);
226
227 status = readl(mm_gc->regs + ALTERA_GPIO_DATA);
228 status &= readl(mm_gc->regs + ALTERA_GPIO_IRQ_MASK);
229
dbd1c54f
MZ
230 for_each_set_bit(i, &status, mm_gc->gc.ngpio)
231 generic_handle_domain_irq(irqdomain, i);
232
c5abbba9
THL
233 chained_irq_exit(chip, desc);
234}
235
5cd79816
LW
236static const struct irq_chip altera_gpio_irq_chip = {
237 .name = "altera-gpio",
238 .irq_mask = altera_gpio_irq_mask,
239 .irq_unmask = altera_gpio_irq_unmask,
240 .irq_set_type = altera_gpio_irq_set_type,
241 .irq_startup = altera_gpio_irq_startup,
242 .irq_shutdown = altera_gpio_irq_mask,
243 .flags = IRQCHIP_IMMUTABLE,
244 GPIOCHIP_IRQ_RESOURCE_HELPERS,
245};
246
c4b40493 247static int altera_gpio_probe(struct platform_device *pdev)
c5abbba9
THL
248{
249 struct device_node *node = pdev->dev.of_node;
250 int reg, ret;
251 struct altera_gpio_chip *altera_gc;
2617790f 252 struct gpio_irq_chip *girq;
c5abbba9
THL
253
254 altera_gc = devm_kzalloc(&pdev->dev, sizeof(*altera_gc), GFP_KERNEL);
255 if (!altera_gc)
256 return -ENOMEM;
257
21d01c9c 258 raw_spin_lock_init(&altera_gc->gpio_lock);
c5abbba9
THL
259
260 if (of_property_read_u32(node, "altr,ngpio", &reg))
261 /* By default assume maximum ngpio */
262 altera_gc->mmchip.gc.ngpio = ALTERA_GPIO_MAX_NGPIO;
263 else
264 altera_gc->mmchip.gc.ngpio = reg;
265
266 if (altera_gc->mmchip.gc.ngpio > ALTERA_GPIO_MAX_NGPIO) {
267 dev_warn(&pdev->dev,
268 "ngpio is greater than %d, defaulting to %d\n",
269 ALTERA_GPIO_MAX_NGPIO, ALTERA_GPIO_MAX_NGPIO);
270 altera_gc->mmchip.gc.ngpio = ALTERA_GPIO_MAX_NGPIO;
271 }
272
273 altera_gc->mmchip.gc.direction_input = altera_gpio_direction_input;
274 altera_gc->mmchip.gc.direction_output = altera_gpio_direction_output;
275 altera_gc->mmchip.gc.get = altera_gpio_get;
276 altera_gc->mmchip.gc.set = altera_gpio_set;
277 altera_gc->mmchip.gc.owner = THIS_MODULE;
58383c78 278 altera_gc->mmchip.gc.parent = &pdev->dev;
c5abbba9 279
1e4d149e 280 altera_gc->mapped_irq = platform_get_irq_optional(pdev, 0);
c5abbba9
THL
281
282 if (altera_gc->mapped_irq < 0)
283 goto skip_irq;
284
285 if (of_property_read_u32(node, "altr,interrupt-type", &reg)) {
c5abbba9
THL
286 dev_err(&pdev->dev,
287 "altr,interrupt-type value not set in device tree\n");
2617790f 288 return -EINVAL;
c5abbba9
THL
289 }
290 altera_gc->interrupt_trigger = reg;
291
2617790f 292 girq = &altera_gc->mmchip.gc.irq;
5cd79816
LW
293 gpio_irq_chip_set_chip(girq, &altera_gpio_irq_chip);
294
2617790f
LW
295 if (altera_gc->interrupt_trigger == IRQ_TYPE_LEVEL_HIGH)
296 girq->parent_handler = altera_gpio_irq_leveL_high_handler;
297 else
298 girq->parent_handler = altera_gpio_irq_edge_handler;
299 girq->num_parents = 1;
300 girq->parents = devm_kcalloc(&pdev->dev, 1, sizeof(*girq->parents),
301 GFP_KERNEL);
302 if (!girq->parents)
303 return -ENOMEM;
304 girq->default_type = IRQ_TYPE_NONE;
305 girq->handler = handle_bad_irq;
306 girq->parents[0] = altera_gc->mapped_irq;
c5abbba9 307
2617790f
LW
308skip_irq:
309 ret = of_mm_gpiochip_add_data(node, &altera_gc->mmchip, altera_gc);
c5abbba9 310 if (ret) {
2617790f
LW
311 dev_err(&pdev->dev, "Failed adding memory mapped gpiochip\n");
312 return ret;
c5abbba9
THL
313 }
314
2617790f 315 platform_set_drvdata(pdev, altera_gc);
c5abbba9 316
c5abbba9 317 return 0;
c5abbba9
THL
318}
319
2ae6a45f 320static void altera_gpio_remove(struct platform_device *pdev)
c5abbba9
THL
321{
322 struct altera_gpio_chip *altera_gc = platform_get_drvdata(pdev);
323
41ec66c9 324 of_mm_gpiochip_remove(&altera_gc->mmchip);
c5abbba9
THL
325}
326
327static const struct of_device_id altera_gpio_of_match[] = {
328 { .compatible = "altr,pio-1.0", },
329 {},
330};
331MODULE_DEVICE_TABLE(of, altera_gpio_of_match);
332
333static struct platform_driver altera_gpio_driver = {
334 .driver = {
335 .name = "altera_gpio",
13577824 336 .of_match_table = altera_gpio_of_match,
c5abbba9
THL
337 },
338 .probe = altera_gpio_probe,
2ae6a45f 339 .remove_new = altera_gpio_remove,
c5abbba9
THL
340};
341
342static int __init altera_gpio_init(void)
343{
344 return platform_driver_register(&altera_gpio_driver);
345}
346subsys_initcall(altera_gpio_init);
347
348static void __exit altera_gpio_exit(void)
349{
350 platform_driver_unregister(&altera_gpio_driver);
351}
352module_exit(altera_gpio_exit);
353
354MODULE_AUTHOR("Tien Hock Loh <thloh@altera.com>");
355MODULE_DESCRIPTION("Altera GPIO driver");
356MODULE_LICENSE("GPL");