Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2// Copyright (C) 2015-2017 Broadcom
3
4#include <linux/bitops.h>
5#include <linux/gpio/driver.h>
6#include <linux/of.h>
7#include <linux/module.h>
8#include <linux/irqdomain.h>
9#include <linux/irqchip/chained_irq.h>
10#include <linux/interrupt.h>
11#include <linux/platform_device.h>
12
13enum gio_reg_index {
14 GIO_REG_ODEN = 0,
15 GIO_REG_DATA,
16 GIO_REG_IODIR,
17 GIO_REG_EC,
18 GIO_REG_EI,
19 GIO_REG_MASK,
20 GIO_REG_LEVEL,
21 GIO_REG_STAT,
22 NUMBER_OF_GIO_REGISTERS
23};
24
25#define GIO_BANK_SIZE (NUMBER_OF_GIO_REGISTERS * sizeof(u32))
26#define GIO_BANK_OFF(bank, off) (((bank) * GIO_BANK_SIZE) + (off * sizeof(u32)))
27#define GIO_ODEN(bank) GIO_BANK_OFF(bank, GIO_REG_ODEN)
28#define GIO_DATA(bank) GIO_BANK_OFF(bank, GIO_REG_DATA)
29#define GIO_IODIR(bank) GIO_BANK_OFF(bank, GIO_REG_IODIR)
30#define GIO_EC(bank) GIO_BANK_OFF(bank, GIO_REG_EC)
31#define GIO_EI(bank) GIO_BANK_OFF(bank, GIO_REG_EI)
32#define GIO_MASK(bank) GIO_BANK_OFF(bank, GIO_REG_MASK)
33#define GIO_LEVEL(bank) GIO_BANK_OFF(bank, GIO_REG_LEVEL)
34#define GIO_STAT(bank) GIO_BANK_OFF(bank, GIO_REG_STAT)
35
36struct brcmstb_gpio_bank {
37 struct list_head node;
38 int id;
39 struct gpio_chip gc;
40 struct brcmstb_gpio_priv *parent_priv;
41 u32 width;
42 u32 wake_active;
43 u32 saved_regs[GIO_REG_STAT]; /* Don't save and restore GIO_REG_STAT */
44};
45
46struct brcmstb_gpio_priv {
47 struct list_head bank_list;
48 void __iomem *reg_base;
49 struct platform_device *pdev;
50 struct irq_domain *irq_domain;
51 struct irq_chip irq_chip;
52 int parent_irq;
53 int num_gpios;
54 int parent_wake_irq;
55};
56
57#define MAX_GPIO_PER_BANK 32
58#define GPIO_BANK(gpio) ((gpio) >> 5)
59/* assumes MAX_GPIO_PER_BANK is a multiple of 2 */
60#define GPIO_BIT(gpio) ((gpio) & (MAX_GPIO_PER_BANK - 1))
61
62static inline struct brcmstb_gpio_priv *
63brcmstb_gpio_gc_to_priv(struct gpio_chip *gc)
64{
65 struct brcmstb_gpio_bank *bank = gpiochip_get_data(gc);
66 return bank->parent_priv;
67}
68
69static unsigned long
70__brcmstb_gpio_get_active_irqs(struct brcmstb_gpio_bank *bank)
71{
72 void __iomem *reg_base = bank->parent_priv->reg_base;
73
74 return bank->gc.read_reg(reg_base + GIO_STAT(bank->id)) &
75 bank->gc.read_reg(reg_base + GIO_MASK(bank->id));
76}
77
78static unsigned long
79brcmstb_gpio_get_active_irqs(struct brcmstb_gpio_bank *bank)
80{
81 unsigned long status;
82 unsigned long flags;
83
84 raw_spin_lock_irqsave(&bank->gc.bgpio_lock, flags);
85 status = __brcmstb_gpio_get_active_irqs(bank);
86 raw_spin_unlock_irqrestore(&bank->gc.bgpio_lock, flags);
87
88 return status;
89}
90
91static int brcmstb_gpio_hwirq_to_offset(irq_hw_number_t hwirq,
92 struct brcmstb_gpio_bank *bank)
93{
94 return hwirq - bank->gc.offset;
95}
96
97static void brcmstb_gpio_set_imask(struct brcmstb_gpio_bank *bank,
98 unsigned int hwirq, bool enable)
99{
100 struct gpio_chip *gc = &bank->gc;
101 struct brcmstb_gpio_priv *priv = bank->parent_priv;
102 u32 mask = BIT(brcmstb_gpio_hwirq_to_offset(hwirq, bank));
103 u32 imask;
104 unsigned long flags;
105
106 raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
107 imask = gc->read_reg(priv->reg_base + GIO_MASK(bank->id));
108 if (enable)
109 imask |= mask;
110 else
111 imask &= ~mask;
112 gc->write_reg(priv->reg_base + GIO_MASK(bank->id), imask);
113 raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
114}
115
116static int brcmstb_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
117{
118 struct brcmstb_gpio_priv *priv = brcmstb_gpio_gc_to_priv(gc);
119 /* gc_offset is relative to this gpio_chip; want real offset */
120 int hwirq = offset + gc->offset;
121
122 if (hwirq >= priv->num_gpios)
123 return -ENXIO;
124 return irq_create_mapping(priv->irq_domain, hwirq);
125}
126
127/* -------------------- IRQ chip functions -------------------- */
128
129static void brcmstb_gpio_irq_mask(struct irq_data *d)
130{
131 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
132 struct brcmstb_gpio_bank *bank = gpiochip_get_data(gc);
133
134 brcmstb_gpio_set_imask(bank, d->hwirq, false);
135}
136
137static void brcmstb_gpio_irq_unmask(struct irq_data *d)
138{
139 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
140 struct brcmstb_gpio_bank *bank = gpiochip_get_data(gc);
141
142 brcmstb_gpio_set_imask(bank, d->hwirq, true);
143}
144
145static void brcmstb_gpio_irq_ack(struct irq_data *d)
146{
147 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
148 struct brcmstb_gpio_bank *bank = gpiochip_get_data(gc);
149 struct brcmstb_gpio_priv *priv = bank->parent_priv;
150 u32 mask = BIT(brcmstb_gpio_hwirq_to_offset(d->hwirq, bank));
151
152 gc->write_reg(priv->reg_base + GIO_STAT(bank->id), mask);
153}
154
155static int brcmstb_gpio_irq_set_type(struct irq_data *d, unsigned int type)
156{
157 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
158 struct brcmstb_gpio_bank *bank = gpiochip_get_data(gc);
159 struct brcmstb_gpio_priv *priv = bank->parent_priv;
160 u32 mask = BIT(brcmstb_gpio_hwirq_to_offset(d->hwirq, bank));
161 u32 edge_insensitive, iedge_insensitive;
162 u32 edge_config, iedge_config;
163 u32 level, ilevel;
164 unsigned long flags;
165
166 switch (type) {
167 case IRQ_TYPE_LEVEL_LOW:
168 level = mask;
169 edge_config = 0;
170 edge_insensitive = 0;
171 break;
172 case IRQ_TYPE_LEVEL_HIGH:
173 level = mask;
174 edge_config = mask;
175 edge_insensitive = 0;
176 break;
177 case IRQ_TYPE_EDGE_FALLING:
178 level = 0;
179 edge_config = 0;
180 edge_insensitive = 0;
181 break;
182 case IRQ_TYPE_EDGE_RISING:
183 level = 0;
184 edge_config = mask;
185 edge_insensitive = 0;
186 break;
187 case IRQ_TYPE_EDGE_BOTH:
188 level = 0;
189 edge_config = 0; /* don't care, but want known value */
190 edge_insensitive = mask;
191 break;
192 default:
193 return -EINVAL;
194 }
195
196 raw_spin_lock_irqsave(&bank->gc.bgpio_lock, flags);
197
198 iedge_config = bank->gc.read_reg(priv->reg_base +
199 GIO_EC(bank->id)) & ~mask;
200 iedge_insensitive = bank->gc.read_reg(priv->reg_base +
201 GIO_EI(bank->id)) & ~mask;
202 ilevel = bank->gc.read_reg(priv->reg_base +
203 GIO_LEVEL(bank->id)) & ~mask;
204
205 bank->gc.write_reg(priv->reg_base + GIO_EC(bank->id),
206 iedge_config | edge_config);
207 bank->gc.write_reg(priv->reg_base + GIO_EI(bank->id),
208 iedge_insensitive | edge_insensitive);
209 bank->gc.write_reg(priv->reg_base + GIO_LEVEL(bank->id),
210 ilevel | level);
211
212 raw_spin_unlock_irqrestore(&bank->gc.bgpio_lock, flags);
213 return 0;
214}
215
216static int brcmstb_gpio_priv_set_wake(struct brcmstb_gpio_priv *priv,
217 unsigned int enable)
218{
219 int ret = 0;
220
221 if (enable)
222 ret = enable_irq_wake(priv->parent_wake_irq);
223 else
224 ret = disable_irq_wake(priv->parent_wake_irq);
225 if (ret)
226 dev_err(&priv->pdev->dev, "failed to %s wake-up interrupt\n",
227 enable ? "enable" : "disable");
228 return ret;
229}
230
231static int brcmstb_gpio_irq_set_wake(struct irq_data *d, unsigned int enable)
232{
233 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
234 struct brcmstb_gpio_bank *bank = gpiochip_get_data(gc);
235 struct brcmstb_gpio_priv *priv = bank->parent_priv;
236 u32 mask = BIT(brcmstb_gpio_hwirq_to_offset(d->hwirq, bank));
237
238 /*
239 * Do not do anything specific for now, suspend/resume callbacks will
240 * configure the interrupt mask appropriately
241 */
242 if (enable)
243 bank->wake_active |= mask;
244 else
245 bank->wake_active &= ~mask;
246
247 return brcmstb_gpio_priv_set_wake(priv, enable);
248}
249
250static irqreturn_t brcmstb_gpio_wake_irq_handler(int irq, void *data)
251{
252 struct brcmstb_gpio_priv *priv = data;
253
254 if (!priv || irq != priv->parent_wake_irq)
255 return IRQ_NONE;
256
257 /* Nothing to do */
258 return IRQ_HANDLED;
259}
260
261static void brcmstb_gpio_irq_bank_handler(struct brcmstb_gpio_bank *bank)
262{
263 struct brcmstb_gpio_priv *priv = bank->parent_priv;
264 struct irq_domain *domain = priv->irq_domain;
265 int hwbase = bank->gc.offset;
266 unsigned long status;
267
268 while ((status = brcmstb_gpio_get_active_irqs(bank))) {
269 unsigned int offset;
270
271 for_each_set_bit(offset, &status, 32) {
272 if (offset >= bank->width)
273 dev_warn(&priv->pdev->dev,
274 "IRQ for invalid GPIO (bank=%d, offset=%d)\n",
275 bank->id, offset);
276 generic_handle_domain_irq(domain, hwbase + offset);
277 }
278 }
279}
280
281/* Each UPG GIO block has one IRQ for all banks */
282static void brcmstb_gpio_irq_handler(struct irq_desc *desc)
283{
284 struct brcmstb_gpio_priv *priv = irq_desc_get_handler_data(desc);
285 struct irq_chip *chip = irq_desc_get_chip(desc);
286 struct brcmstb_gpio_bank *bank;
287
288 /* Interrupts weren't properly cleared during probe */
289 BUG_ON(!priv || !chip);
290
291 chained_irq_enter(chip, desc);
292 list_for_each_entry(bank, &priv->bank_list, node)
293 brcmstb_gpio_irq_bank_handler(bank);
294 chained_irq_exit(chip, desc);
295}
296
297static struct brcmstb_gpio_bank *brcmstb_gpio_hwirq_to_bank(
298 struct brcmstb_gpio_priv *priv, irq_hw_number_t hwirq)
299{
300 struct brcmstb_gpio_bank *bank;
301 int i = 0;
302
303 /* banks are in descending order */
304 list_for_each_entry_reverse(bank, &priv->bank_list, node) {
305 i += bank->gc.ngpio;
306 if (hwirq < i)
307 return bank;
308 }
309 return NULL;
310}
311
312/*
313 * This lock class tells lockdep that GPIO irqs are in a different
314 * category than their parents, so it won't report false recursion.
315 */
316static struct lock_class_key brcmstb_gpio_irq_lock_class;
317static struct lock_class_key brcmstb_gpio_irq_request_class;
318
319
320static int brcmstb_gpio_irq_map(struct irq_domain *d, unsigned int irq,
321 irq_hw_number_t hwirq)
322{
323 struct brcmstb_gpio_priv *priv = d->host_data;
324 struct brcmstb_gpio_bank *bank =
325 brcmstb_gpio_hwirq_to_bank(priv, hwirq);
326 struct platform_device *pdev = priv->pdev;
327 int ret;
328
329 if (!bank)
330 return -EINVAL;
331
332 dev_dbg(&pdev->dev, "Mapping irq %d for gpio line %d (bank %d)\n",
333 irq, (int)hwirq, bank->id);
334 ret = irq_set_chip_data(irq, &bank->gc);
335 if (ret < 0)
336 return ret;
337 irq_set_lockdep_class(irq, &brcmstb_gpio_irq_lock_class,
338 &brcmstb_gpio_irq_request_class);
339 irq_set_chip_and_handler(irq, &priv->irq_chip, handle_level_irq);
340 irq_set_noprobe(irq);
341 return 0;
342}
343
344static void brcmstb_gpio_irq_unmap(struct irq_domain *d, unsigned int irq)
345{
346 irq_set_chip_and_handler(irq, NULL, NULL);
347 irq_set_chip_data(irq, NULL);
348}
349
350static const struct irq_domain_ops brcmstb_gpio_irq_domain_ops = {
351 .map = brcmstb_gpio_irq_map,
352 .unmap = brcmstb_gpio_irq_unmap,
353 .xlate = irq_domain_xlate_twocell,
354};
355
356/* Make sure that the number of banks matches up between properties */
357static int brcmstb_gpio_sanity_check_banks(struct device *dev,
358 struct device_node *np, struct resource *res)
359{
360 int res_num_banks = resource_size(res) / GIO_BANK_SIZE;
361 int num_banks =
362 of_property_count_u32_elems(np, "brcm,gpio-bank-widths");
363
364 if (res_num_banks != num_banks) {
365 dev_err(dev, "Mismatch in banks: res had %d, bank-widths had %d\n",
366 res_num_banks, num_banks);
367 return -EINVAL;
368 } else {
369 return 0;
370 }
371}
372
373static void brcmstb_gpio_remove(struct platform_device *pdev)
374{
375 struct brcmstb_gpio_priv *priv = platform_get_drvdata(pdev);
376 struct brcmstb_gpio_bank *bank;
377 int offset, virq;
378
379 if (priv->parent_irq > 0)
380 irq_set_chained_handler_and_data(priv->parent_irq, NULL, NULL);
381
382 /* Remove all IRQ mappings and delete the domain */
383 if (priv->irq_domain) {
384 for (offset = 0; offset < priv->num_gpios; offset++) {
385 virq = irq_find_mapping(priv->irq_domain, offset);
386 irq_dispose_mapping(virq);
387 }
388 irq_domain_remove(priv->irq_domain);
389 }
390
391 /*
392 * You can lose return values below, but we report all errors, and it's
393 * more important to actually perform all of the steps.
394 */
395 list_for_each_entry(bank, &priv->bank_list, node)
396 gpiochip_remove(&bank->gc);
397}
398
399static int brcmstb_gpio_of_xlate(struct gpio_chip *gc,
400 const struct of_phandle_args *gpiospec, u32 *flags)
401{
402 struct brcmstb_gpio_priv *priv = brcmstb_gpio_gc_to_priv(gc);
403 struct brcmstb_gpio_bank *bank = gpiochip_get_data(gc);
404 int offset;
405
406 if (gc->of_gpio_n_cells != 2) {
407 WARN_ON(1);
408 return -EINVAL;
409 }
410
411 if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells))
412 return -EINVAL;
413
414 offset = gpiospec->args[0] - bank->gc.offset;
415 if (offset >= gc->ngpio || offset < 0)
416 return -EINVAL;
417
418 if (unlikely(offset >= bank->width)) {
419 dev_warn_ratelimited(&priv->pdev->dev,
420 "Received request for invalid GPIO offset %d\n",
421 gpiospec->args[0]);
422 }
423
424 if (flags)
425 *flags = gpiospec->args[1];
426
427 return offset;
428}
429
430/* priv->parent_irq and priv->num_gpios must be set before calling */
431static int brcmstb_gpio_irq_setup(struct platform_device *pdev,
432 struct brcmstb_gpio_priv *priv)
433{
434 struct device *dev = &pdev->dev;
435 struct device_node *np = dev->of_node;
436 int err;
437
438 priv->irq_domain =
439 irq_domain_add_linear(np, priv->num_gpios,
440 &brcmstb_gpio_irq_domain_ops,
441 priv);
442 if (!priv->irq_domain) {
443 dev_err(dev, "Couldn't allocate IRQ domain\n");
444 return -ENXIO;
445 }
446
447 if (of_property_read_bool(np, "wakeup-source")) {
448 priv->parent_wake_irq = platform_get_irq(pdev, 1);
449 if (priv->parent_wake_irq < 0) {
450 priv->parent_wake_irq = 0;
451 dev_warn(dev,
452 "Couldn't get wake IRQ - GPIOs will not be able to wake from sleep");
453 } else {
454 /*
455 * Set wakeup capability so we can process boot-time
456 * "wakeups" (e.g., from S5 cold boot)
457 */
458 device_set_wakeup_capable(dev, true);
459 device_wakeup_enable(dev);
460 err = devm_request_irq(dev, priv->parent_wake_irq,
461 brcmstb_gpio_wake_irq_handler,
462 IRQF_SHARED,
463 "brcmstb-gpio-wake", priv);
464
465 if (err < 0) {
466 dev_err(dev, "Couldn't request wake IRQ");
467 goto out_free_domain;
468 }
469 }
470 }
471
472 priv->irq_chip.name = dev_name(dev);
473 priv->irq_chip.irq_disable = brcmstb_gpio_irq_mask;
474 priv->irq_chip.irq_mask = brcmstb_gpio_irq_mask;
475 priv->irq_chip.irq_unmask = brcmstb_gpio_irq_unmask;
476 priv->irq_chip.irq_ack = brcmstb_gpio_irq_ack;
477 priv->irq_chip.irq_set_type = brcmstb_gpio_irq_set_type;
478
479 if (priv->parent_wake_irq)
480 priv->irq_chip.irq_set_wake = brcmstb_gpio_irq_set_wake;
481
482 irq_set_chained_handler_and_data(priv->parent_irq,
483 brcmstb_gpio_irq_handler, priv);
484 irq_set_status_flags(priv->parent_irq, IRQ_DISABLE_UNLAZY);
485
486 return 0;
487
488out_free_domain:
489 irq_domain_remove(priv->irq_domain);
490
491 return err;
492}
493
494static void brcmstb_gpio_bank_save(struct brcmstb_gpio_priv *priv,
495 struct brcmstb_gpio_bank *bank)
496{
497 struct gpio_chip *gc = &bank->gc;
498 unsigned int i;
499
500 for (i = 0; i < GIO_REG_STAT; i++)
501 bank->saved_regs[i] = gc->read_reg(priv->reg_base +
502 GIO_BANK_OFF(bank->id, i));
503}
504
505static void brcmstb_gpio_quiesce(struct device *dev, bool save)
506{
507 struct brcmstb_gpio_priv *priv = dev_get_drvdata(dev);
508 struct brcmstb_gpio_bank *bank;
509 struct gpio_chip *gc;
510 u32 imask;
511
512 /* disable non-wake interrupt */
513 if (priv->parent_irq >= 0)
514 disable_irq(priv->parent_irq);
515
516 list_for_each_entry(bank, &priv->bank_list, node) {
517 gc = &bank->gc;
518
519 if (save)
520 brcmstb_gpio_bank_save(priv, bank);
521
522 /* Unmask GPIOs which have been flagged as wake-up sources */
523 if (priv->parent_wake_irq)
524 imask = bank->wake_active;
525 else
526 imask = 0;
527 gc->write_reg(priv->reg_base + GIO_MASK(bank->id),
528 imask);
529 }
530}
531
532static void brcmstb_gpio_shutdown(struct platform_device *pdev)
533{
534 /* Enable GPIO for S5 cold boot */
535 brcmstb_gpio_quiesce(&pdev->dev, false);
536}
537
538#ifdef CONFIG_PM_SLEEP
539static void brcmstb_gpio_bank_restore(struct brcmstb_gpio_priv *priv,
540 struct brcmstb_gpio_bank *bank)
541{
542 struct gpio_chip *gc = &bank->gc;
543 unsigned int i;
544
545 for (i = 0; i < GIO_REG_STAT; i++)
546 gc->write_reg(priv->reg_base + GIO_BANK_OFF(bank->id, i),
547 bank->saved_regs[i]);
548}
549
550static int brcmstb_gpio_suspend(struct device *dev)
551{
552 brcmstb_gpio_quiesce(dev, true);
553 return 0;
554}
555
556static int brcmstb_gpio_resume(struct device *dev)
557{
558 struct brcmstb_gpio_priv *priv = dev_get_drvdata(dev);
559 struct brcmstb_gpio_bank *bank;
560 bool need_wakeup_event = false;
561
562 list_for_each_entry(bank, &priv->bank_list, node) {
563 need_wakeup_event |= !!__brcmstb_gpio_get_active_irqs(bank);
564 brcmstb_gpio_bank_restore(priv, bank);
565 }
566
567 if (priv->parent_wake_irq && need_wakeup_event)
568 pm_wakeup_event(dev, 0);
569
570 /* enable non-wake interrupt */
571 if (priv->parent_irq >= 0)
572 enable_irq(priv->parent_irq);
573
574 return 0;
575}
576
577#else
578#define brcmstb_gpio_suspend NULL
579#define brcmstb_gpio_resume NULL
580#endif /* CONFIG_PM_SLEEP */
581
582static const struct dev_pm_ops brcmstb_gpio_pm_ops = {
583 .suspend_noirq = brcmstb_gpio_suspend,
584 .resume_noirq = brcmstb_gpio_resume,
585};
586
587static int brcmstb_gpio_probe(struct platform_device *pdev)
588{
589 struct device *dev = &pdev->dev;
590 struct device_node *np = dev->of_node;
591 void __iomem *reg_base;
592 struct brcmstb_gpio_priv *priv;
593 struct resource *res;
594 u32 bank_width;
595 int num_banks = 0;
596 int num_gpios = 0;
597 int err;
598 unsigned long flags = 0;
599 bool need_wakeup_event = false;
600
601 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
602 if (!priv)
603 return -ENOMEM;
604 platform_set_drvdata(pdev, priv);
605 INIT_LIST_HEAD(&priv->bank_list);
606
607 reg_base = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
608 if (IS_ERR(reg_base))
609 return PTR_ERR(reg_base);
610
611 priv->reg_base = reg_base;
612 priv->pdev = pdev;
613
614 if (of_property_read_bool(np, "interrupt-controller")) {
615 priv->parent_irq = platform_get_irq(pdev, 0);
616 if (priv->parent_irq <= 0)
617 return -ENOENT;
618 } else {
619 priv->parent_irq = -ENOENT;
620 }
621
622 if (brcmstb_gpio_sanity_check_banks(dev, np, res))
623 return -EINVAL;
624
625 /*
626 * MIPS endianness is configured by boot strap, which also reverses all
627 * bus endianness (i.e., big-endian CPU + big endian bus ==> native
628 * endian I/O).
629 *
630 * Other architectures (e.g., ARM) either do not support big endian, or
631 * else leave I/O in little endian mode.
632 */
633#if defined(CONFIG_MIPS) && defined(__BIG_ENDIAN)
634 flags = BGPIOF_BIG_ENDIAN_BYTE_ORDER;
635#endif
636
637 of_property_for_each_u32(np, "brcm,gpio-bank-widths", bank_width) {
638 struct brcmstb_gpio_bank *bank;
639 struct gpio_chip *gc;
640
641 /*
642 * If bank_width is 0, then there is an empty bank in the
643 * register block. Special handling for this case.
644 */
645 if (bank_width == 0) {
646 dev_dbg(dev, "Width 0 found: Empty bank @ %d\n",
647 num_banks);
648 num_banks++;
649 num_gpios += MAX_GPIO_PER_BANK;
650 continue;
651 }
652
653 bank = devm_kzalloc(dev, sizeof(*bank), GFP_KERNEL);
654 if (!bank) {
655 err = -ENOMEM;
656 goto fail;
657 }
658
659 bank->parent_priv = priv;
660 bank->id = num_banks;
661 if (bank_width <= 0 || bank_width > MAX_GPIO_PER_BANK) {
662 dev_err(dev, "Invalid bank width %d\n", bank_width);
663 err = -EINVAL;
664 goto fail;
665 } else {
666 bank->width = bank_width;
667 }
668
669 /*
670 * Regs are 4 bytes wide, have data reg, no set/clear regs,
671 * and direction bits have 0 = output and 1 = input
672 */
673 gc = &bank->gc;
674 err = bgpio_init(gc, dev, 4,
675 reg_base + GIO_DATA(bank->id),
676 NULL, NULL, NULL,
677 reg_base + GIO_IODIR(bank->id), flags);
678 if (err) {
679 dev_err(dev, "bgpio_init() failed\n");
680 goto fail;
681 }
682
683 gc->owner = THIS_MODULE;
684 gc->label = devm_kasprintf(dev, GFP_KERNEL, "%pOF", np);
685 if (!gc->label) {
686 err = -ENOMEM;
687 goto fail;
688 }
689 gc->of_gpio_n_cells = 2;
690 gc->of_xlate = brcmstb_gpio_of_xlate;
691 /* not all ngpio lines are valid, will use bank width later */
692 gc->ngpio = MAX_GPIO_PER_BANK;
693 gc->offset = bank->id * MAX_GPIO_PER_BANK;
694 gc->request = gpiochip_generic_request;
695 gc->free = gpiochip_generic_free;
696 if (priv->parent_irq > 0)
697 gc->to_irq = brcmstb_gpio_to_irq;
698
699 /*
700 * Mask all interrupts by default, since wakeup interrupts may
701 * be retained from S5 cold boot
702 */
703 need_wakeup_event |= !!__brcmstb_gpio_get_active_irqs(bank);
704 gc->write_reg(reg_base + GIO_MASK(bank->id), 0);
705
706 err = gpiochip_add_data(gc, bank);
707 if (err) {
708 dev_err(dev, "Could not add gpiochip for bank %d\n",
709 bank->id);
710 goto fail;
711 }
712 num_gpios += gc->ngpio;
713
714 dev_dbg(dev, "bank=%d, base=%d, ngpio=%d, width=%d\n", bank->id,
715 gc->base, gc->ngpio, bank->width);
716
717 /* Everything looks good, so add bank to list */
718 list_add(&bank->node, &priv->bank_list);
719
720 num_banks++;
721 }
722
723 priv->num_gpios = num_gpios;
724 if (priv->parent_irq > 0) {
725 err = brcmstb_gpio_irq_setup(pdev, priv);
726 if (err)
727 goto fail;
728 }
729
730 if (priv->parent_wake_irq && need_wakeup_event)
731 pm_wakeup_event(dev, 0);
732
733 return 0;
734
735fail:
736 (void) brcmstb_gpio_remove(pdev);
737 return err;
738}
739
740static const struct of_device_id brcmstb_gpio_of_match[] = {
741 { .compatible = "brcm,brcmstb-gpio" },
742 {},
743};
744
745MODULE_DEVICE_TABLE(of, brcmstb_gpio_of_match);
746
747static struct platform_driver brcmstb_gpio_driver = {
748 .driver = {
749 .name = "brcmstb-gpio",
750 .of_match_table = brcmstb_gpio_of_match,
751 .pm = &brcmstb_gpio_pm_ops,
752 },
753 .probe = brcmstb_gpio_probe,
754 .remove = brcmstb_gpio_remove,
755 .shutdown = brcmstb_gpio_shutdown,
756};
757module_platform_driver(brcmstb_gpio_driver);
758
759MODULE_AUTHOR("Gregory Fong");
760MODULE_DESCRIPTION("Driver for Broadcom BRCMSTB SoC UPG GPIO");
761MODULE_LICENSE("GPL v2");
1/*
2 * Copyright (C) 2015-2017 Broadcom
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License as
6 * published by the Free Software Foundation version 2.
7 *
8 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
9 * kind, whether express or implied; without even the implied warranty
10 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 */
13
14#include <linux/bitops.h>
15#include <linux/gpio/driver.h>
16#include <linux/of_device.h>
17#include <linux/of_irq.h>
18#include <linux/module.h>
19#include <linux/irqdomain.h>
20#include <linux/irqchip/chained_irq.h>
21#include <linux/interrupt.h>
22
23enum gio_reg_index {
24 GIO_REG_ODEN = 0,
25 GIO_REG_DATA,
26 GIO_REG_IODIR,
27 GIO_REG_EC,
28 GIO_REG_EI,
29 GIO_REG_MASK,
30 GIO_REG_LEVEL,
31 GIO_REG_STAT,
32 NUMBER_OF_GIO_REGISTERS
33};
34
35#define GIO_BANK_SIZE (NUMBER_OF_GIO_REGISTERS * sizeof(u32))
36#define GIO_BANK_OFF(bank, off) (((bank) * GIO_BANK_SIZE) + (off * sizeof(u32)))
37#define GIO_ODEN(bank) GIO_BANK_OFF(bank, GIO_REG_ODEN)
38#define GIO_DATA(bank) GIO_BANK_OFF(bank, GIO_REG_DATA)
39#define GIO_IODIR(bank) GIO_BANK_OFF(bank, GIO_REG_IODIR)
40#define GIO_EC(bank) GIO_BANK_OFF(bank, GIO_REG_EC)
41#define GIO_EI(bank) GIO_BANK_OFF(bank, GIO_REG_EI)
42#define GIO_MASK(bank) GIO_BANK_OFF(bank, GIO_REG_MASK)
43#define GIO_LEVEL(bank) GIO_BANK_OFF(bank, GIO_REG_LEVEL)
44#define GIO_STAT(bank) GIO_BANK_OFF(bank, GIO_REG_STAT)
45
46struct brcmstb_gpio_bank {
47 struct list_head node;
48 int id;
49 struct gpio_chip gc;
50 struct brcmstb_gpio_priv *parent_priv;
51 u32 width;
52 u32 wake_active;
53 u32 saved_regs[GIO_REG_STAT]; /* Don't save and restore GIO_REG_STAT */
54};
55
56struct brcmstb_gpio_priv {
57 struct list_head bank_list;
58 void __iomem *reg_base;
59 struct platform_device *pdev;
60 struct irq_domain *irq_domain;
61 struct irq_chip irq_chip;
62 int parent_irq;
63 int gpio_base;
64 int num_gpios;
65 int parent_wake_irq;
66};
67
68#define MAX_GPIO_PER_BANK 32
69#define GPIO_BANK(gpio) ((gpio) >> 5)
70/* assumes MAX_GPIO_PER_BANK is a multiple of 2 */
71#define GPIO_BIT(gpio) ((gpio) & (MAX_GPIO_PER_BANK - 1))
72
73static inline struct brcmstb_gpio_priv *
74brcmstb_gpio_gc_to_priv(struct gpio_chip *gc)
75{
76 struct brcmstb_gpio_bank *bank = gpiochip_get_data(gc);
77 return bank->parent_priv;
78}
79
80static unsigned long
81__brcmstb_gpio_get_active_irqs(struct brcmstb_gpio_bank *bank)
82{
83 void __iomem *reg_base = bank->parent_priv->reg_base;
84
85 return bank->gc.read_reg(reg_base + GIO_STAT(bank->id)) &
86 bank->gc.read_reg(reg_base + GIO_MASK(bank->id));
87}
88
89static unsigned long
90brcmstb_gpio_get_active_irqs(struct brcmstb_gpio_bank *bank)
91{
92 unsigned long status;
93 unsigned long flags;
94
95 spin_lock_irqsave(&bank->gc.bgpio_lock, flags);
96 status = __brcmstb_gpio_get_active_irqs(bank);
97 spin_unlock_irqrestore(&bank->gc.bgpio_lock, flags);
98
99 return status;
100}
101
102static int brcmstb_gpio_hwirq_to_offset(irq_hw_number_t hwirq,
103 struct brcmstb_gpio_bank *bank)
104{
105 return hwirq - (bank->gc.base - bank->parent_priv->gpio_base);
106}
107
108static void brcmstb_gpio_set_imask(struct brcmstb_gpio_bank *bank,
109 unsigned int hwirq, bool enable)
110{
111 struct gpio_chip *gc = &bank->gc;
112 struct brcmstb_gpio_priv *priv = bank->parent_priv;
113 u32 mask = BIT(brcmstb_gpio_hwirq_to_offset(hwirq, bank));
114 u32 imask;
115 unsigned long flags;
116
117 spin_lock_irqsave(&gc->bgpio_lock, flags);
118 imask = gc->read_reg(priv->reg_base + GIO_MASK(bank->id));
119 if (enable)
120 imask |= mask;
121 else
122 imask &= ~mask;
123 gc->write_reg(priv->reg_base + GIO_MASK(bank->id), imask);
124 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
125}
126
127static int brcmstb_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
128{
129 struct brcmstb_gpio_priv *priv = brcmstb_gpio_gc_to_priv(gc);
130 /* gc_offset is relative to this gpio_chip; want real offset */
131 int hwirq = offset + (gc->base - priv->gpio_base);
132
133 if (hwirq >= priv->num_gpios)
134 return -ENXIO;
135 return irq_create_mapping(priv->irq_domain, hwirq);
136}
137
138/* -------------------- IRQ chip functions -------------------- */
139
140static void brcmstb_gpio_irq_mask(struct irq_data *d)
141{
142 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
143 struct brcmstb_gpio_bank *bank = gpiochip_get_data(gc);
144
145 brcmstb_gpio_set_imask(bank, d->hwirq, false);
146}
147
148static void brcmstb_gpio_irq_unmask(struct irq_data *d)
149{
150 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
151 struct brcmstb_gpio_bank *bank = gpiochip_get_data(gc);
152
153 brcmstb_gpio_set_imask(bank, d->hwirq, true);
154}
155
156static void brcmstb_gpio_irq_ack(struct irq_data *d)
157{
158 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
159 struct brcmstb_gpio_bank *bank = gpiochip_get_data(gc);
160 struct brcmstb_gpio_priv *priv = bank->parent_priv;
161 u32 mask = BIT(brcmstb_gpio_hwirq_to_offset(d->hwirq, bank));
162
163 gc->write_reg(priv->reg_base + GIO_STAT(bank->id), mask);
164}
165
166static int brcmstb_gpio_irq_set_type(struct irq_data *d, unsigned int type)
167{
168 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
169 struct brcmstb_gpio_bank *bank = gpiochip_get_data(gc);
170 struct brcmstb_gpio_priv *priv = bank->parent_priv;
171 u32 mask = BIT(brcmstb_gpio_hwirq_to_offset(d->hwirq, bank));
172 u32 edge_insensitive, iedge_insensitive;
173 u32 edge_config, iedge_config;
174 u32 level, ilevel;
175 unsigned long flags;
176
177 switch (type) {
178 case IRQ_TYPE_LEVEL_LOW:
179 level = mask;
180 edge_config = 0;
181 edge_insensitive = 0;
182 break;
183 case IRQ_TYPE_LEVEL_HIGH:
184 level = mask;
185 edge_config = mask;
186 edge_insensitive = 0;
187 break;
188 case IRQ_TYPE_EDGE_FALLING:
189 level = 0;
190 edge_config = 0;
191 edge_insensitive = 0;
192 break;
193 case IRQ_TYPE_EDGE_RISING:
194 level = 0;
195 edge_config = mask;
196 edge_insensitive = 0;
197 break;
198 case IRQ_TYPE_EDGE_BOTH:
199 level = 0;
200 edge_config = 0; /* don't care, but want known value */
201 edge_insensitive = mask;
202 break;
203 default:
204 return -EINVAL;
205 }
206
207 spin_lock_irqsave(&bank->gc.bgpio_lock, flags);
208
209 iedge_config = bank->gc.read_reg(priv->reg_base +
210 GIO_EC(bank->id)) & ~mask;
211 iedge_insensitive = bank->gc.read_reg(priv->reg_base +
212 GIO_EI(bank->id)) & ~mask;
213 ilevel = bank->gc.read_reg(priv->reg_base +
214 GIO_LEVEL(bank->id)) & ~mask;
215
216 bank->gc.write_reg(priv->reg_base + GIO_EC(bank->id),
217 iedge_config | edge_config);
218 bank->gc.write_reg(priv->reg_base + GIO_EI(bank->id),
219 iedge_insensitive | edge_insensitive);
220 bank->gc.write_reg(priv->reg_base + GIO_LEVEL(bank->id),
221 ilevel | level);
222
223 spin_unlock_irqrestore(&bank->gc.bgpio_lock, flags);
224 return 0;
225}
226
227static int brcmstb_gpio_priv_set_wake(struct brcmstb_gpio_priv *priv,
228 unsigned int enable)
229{
230 int ret = 0;
231
232 if (enable)
233 ret = enable_irq_wake(priv->parent_wake_irq);
234 else
235 ret = disable_irq_wake(priv->parent_wake_irq);
236 if (ret)
237 dev_err(&priv->pdev->dev, "failed to %s wake-up interrupt\n",
238 enable ? "enable" : "disable");
239 return ret;
240}
241
242static int brcmstb_gpio_irq_set_wake(struct irq_data *d, unsigned int enable)
243{
244 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
245 struct brcmstb_gpio_bank *bank = gpiochip_get_data(gc);
246 struct brcmstb_gpio_priv *priv = bank->parent_priv;
247 u32 mask = BIT(brcmstb_gpio_hwirq_to_offset(d->hwirq, bank));
248
249 /*
250 * Do not do anything specific for now, suspend/resume callbacks will
251 * configure the interrupt mask appropriately
252 */
253 if (enable)
254 bank->wake_active |= mask;
255 else
256 bank->wake_active &= ~mask;
257
258 return brcmstb_gpio_priv_set_wake(priv, enable);
259}
260
261static irqreturn_t brcmstb_gpio_wake_irq_handler(int irq, void *data)
262{
263 struct brcmstb_gpio_priv *priv = data;
264
265 if (!priv || irq != priv->parent_wake_irq)
266 return IRQ_NONE;
267
268 /* Nothing to do */
269 return IRQ_HANDLED;
270}
271
272static void brcmstb_gpio_irq_bank_handler(struct brcmstb_gpio_bank *bank)
273{
274 struct brcmstb_gpio_priv *priv = bank->parent_priv;
275 struct irq_domain *domain = priv->irq_domain;
276 int hwbase = bank->gc.base - priv->gpio_base;
277 unsigned long status;
278
279 while ((status = brcmstb_gpio_get_active_irqs(bank))) {
280 unsigned int irq, offset;
281
282 for_each_set_bit(offset, &status, 32) {
283 if (offset >= bank->width)
284 dev_warn(&priv->pdev->dev,
285 "IRQ for invalid GPIO (bank=%d, offset=%d)\n",
286 bank->id, offset);
287 irq = irq_linear_revmap(domain, hwbase + offset);
288 generic_handle_irq(irq);
289 }
290 }
291}
292
293/* Each UPG GIO block has one IRQ for all banks */
294static void brcmstb_gpio_irq_handler(struct irq_desc *desc)
295{
296 struct brcmstb_gpio_priv *priv = irq_desc_get_handler_data(desc);
297 struct irq_chip *chip = irq_desc_get_chip(desc);
298 struct brcmstb_gpio_bank *bank;
299
300 /* Interrupts weren't properly cleared during probe */
301 BUG_ON(!priv || !chip);
302
303 chained_irq_enter(chip, desc);
304 list_for_each_entry(bank, &priv->bank_list, node)
305 brcmstb_gpio_irq_bank_handler(bank);
306 chained_irq_exit(chip, desc);
307}
308
309static struct brcmstb_gpio_bank *brcmstb_gpio_hwirq_to_bank(
310 struct brcmstb_gpio_priv *priv, irq_hw_number_t hwirq)
311{
312 struct brcmstb_gpio_bank *bank;
313 int i = 0;
314
315 /* banks are in descending order */
316 list_for_each_entry_reverse(bank, &priv->bank_list, node) {
317 i += bank->gc.ngpio;
318 if (hwirq < i)
319 return bank;
320 }
321 return NULL;
322}
323
324/*
325 * This lock class tells lockdep that GPIO irqs are in a different
326 * category than their parents, so it won't report false recursion.
327 */
328static struct lock_class_key brcmstb_gpio_irq_lock_class;
329static struct lock_class_key brcmstb_gpio_irq_request_class;
330
331
332static int brcmstb_gpio_irq_map(struct irq_domain *d, unsigned int irq,
333 irq_hw_number_t hwirq)
334{
335 struct brcmstb_gpio_priv *priv = d->host_data;
336 struct brcmstb_gpio_bank *bank =
337 brcmstb_gpio_hwirq_to_bank(priv, hwirq);
338 struct platform_device *pdev = priv->pdev;
339 int ret;
340
341 if (!bank)
342 return -EINVAL;
343
344 dev_dbg(&pdev->dev, "Mapping irq %d for gpio line %d (bank %d)\n",
345 irq, (int)hwirq, bank->id);
346 ret = irq_set_chip_data(irq, &bank->gc);
347 if (ret < 0)
348 return ret;
349 irq_set_lockdep_class(irq, &brcmstb_gpio_irq_lock_class,
350 &brcmstb_gpio_irq_request_class);
351 irq_set_chip_and_handler(irq, &priv->irq_chip, handle_level_irq);
352 irq_set_noprobe(irq);
353 return 0;
354}
355
356static void brcmstb_gpio_irq_unmap(struct irq_domain *d, unsigned int irq)
357{
358 irq_set_chip_and_handler(irq, NULL, NULL);
359 irq_set_chip_data(irq, NULL);
360}
361
362static const struct irq_domain_ops brcmstb_gpio_irq_domain_ops = {
363 .map = brcmstb_gpio_irq_map,
364 .unmap = brcmstb_gpio_irq_unmap,
365 .xlate = irq_domain_xlate_twocell,
366};
367
368/* Make sure that the number of banks matches up between properties */
369static int brcmstb_gpio_sanity_check_banks(struct device *dev,
370 struct device_node *np, struct resource *res)
371{
372 int res_num_banks = resource_size(res) / GIO_BANK_SIZE;
373 int num_banks =
374 of_property_count_u32_elems(np, "brcm,gpio-bank-widths");
375
376 if (res_num_banks != num_banks) {
377 dev_err(dev, "Mismatch in banks: res had %d, bank-widths had %d\n",
378 res_num_banks, num_banks);
379 return -EINVAL;
380 } else {
381 return 0;
382 }
383}
384
385static int brcmstb_gpio_remove(struct platform_device *pdev)
386{
387 struct brcmstb_gpio_priv *priv = platform_get_drvdata(pdev);
388 struct brcmstb_gpio_bank *bank;
389 int offset, ret = 0, virq;
390
391 if (!priv) {
392 dev_err(&pdev->dev, "called %s without drvdata!\n", __func__);
393 return -EFAULT;
394 }
395
396 if (priv->parent_irq > 0)
397 irq_set_chained_handler_and_data(priv->parent_irq, NULL, NULL);
398
399 /* Remove all IRQ mappings and delete the domain */
400 if (priv->irq_domain) {
401 for (offset = 0; offset < priv->num_gpios; offset++) {
402 virq = irq_find_mapping(priv->irq_domain, offset);
403 irq_dispose_mapping(virq);
404 }
405 irq_domain_remove(priv->irq_domain);
406 }
407
408 /*
409 * You can lose return values below, but we report all errors, and it's
410 * more important to actually perform all of the steps.
411 */
412 list_for_each_entry(bank, &priv->bank_list, node)
413 gpiochip_remove(&bank->gc);
414
415 return ret;
416}
417
418static int brcmstb_gpio_of_xlate(struct gpio_chip *gc,
419 const struct of_phandle_args *gpiospec, u32 *flags)
420{
421 struct brcmstb_gpio_priv *priv = brcmstb_gpio_gc_to_priv(gc);
422 struct brcmstb_gpio_bank *bank = gpiochip_get_data(gc);
423 int offset;
424
425 if (gc->of_gpio_n_cells != 2) {
426 WARN_ON(1);
427 return -EINVAL;
428 }
429
430 if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells))
431 return -EINVAL;
432
433 offset = gpiospec->args[0] - (gc->base - priv->gpio_base);
434 if (offset >= gc->ngpio || offset < 0)
435 return -EINVAL;
436
437 if (unlikely(offset >= bank->width)) {
438 dev_warn_ratelimited(&priv->pdev->dev,
439 "Received request for invalid GPIO offset %d\n",
440 gpiospec->args[0]);
441 }
442
443 if (flags)
444 *flags = gpiospec->args[1];
445
446 return offset;
447}
448
449/* priv->parent_irq and priv->num_gpios must be set before calling */
450static int brcmstb_gpio_irq_setup(struct platform_device *pdev,
451 struct brcmstb_gpio_priv *priv)
452{
453 struct device *dev = &pdev->dev;
454 struct device_node *np = dev->of_node;
455 int err;
456
457 priv->irq_domain =
458 irq_domain_add_linear(np, priv->num_gpios,
459 &brcmstb_gpio_irq_domain_ops,
460 priv);
461 if (!priv->irq_domain) {
462 dev_err(dev, "Couldn't allocate IRQ domain\n");
463 return -ENXIO;
464 }
465
466 if (of_property_read_bool(np, "wakeup-source")) {
467 priv->parent_wake_irq = platform_get_irq(pdev, 1);
468 if (priv->parent_wake_irq < 0) {
469 priv->parent_wake_irq = 0;
470 dev_warn(dev,
471 "Couldn't get wake IRQ - GPIOs will not be able to wake from sleep");
472 } else {
473 /*
474 * Set wakeup capability so we can process boot-time
475 * "wakeups" (e.g., from S5 cold boot)
476 */
477 device_set_wakeup_capable(dev, true);
478 device_wakeup_enable(dev);
479 err = devm_request_irq(dev, priv->parent_wake_irq,
480 brcmstb_gpio_wake_irq_handler,
481 IRQF_SHARED,
482 "brcmstb-gpio-wake", priv);
483
484 if (err < 0) {
485 dev_err(dev, "Couldn't request wake IRQ");
486 goto out_free_domain;
487 }
488 }
489 }
490
491 priv->irq_chip.name = dev_name(dev);
492 priv->irq_chip.irq_disable = brcmstb_gpio_irq_mask;
493 priv->irq_chip.irq_mask = brcmstb_gpio_irq_mask;
494 priv->irq_chip.irq_unmask = brcmstb_gpio_irq_unmask;
495 priv->irq_chip.irq_ack = brcmstb_gpio_irq_ack;
496 priv->irq_chip.irq_set_type = brcmstb_gpio_irq_set_type;
497
498 if (priv->parent_wake_irq)
499 priv->irq_chip.irq_set_wake = brcmstb_gpio_irq_set_wake;
500
501 irq_set_chained_handler_and_data(priv->parent_irq,
502 brcmstb_gpio_irq_handler, priv);
503 irq_set_status_flags(priv->parent_irq, IRQ_DISABLE_UNLAZY);
504
505 return 0;
506
507out_free_domain:
508 irq_domain_remove(priv->irq_domain);
509
510 return err;
511}
512
513static void brcmstb_gpio_bank_save(struct brcmstb_gpio_priv *priv,
514 struct brcmstb_gpio_bank *bank)
515{
516 struct gpio_chip *gc = &bank->gc;
517 unsigned int i;
518
519 for (i = 0; i < GIO_REG_STAT; i++)
520 bank->saved_regs[i] = gc->read_reg(priv->reg_base +
521 GIO_BANK_OFF(bank->id, i));
522}
523
524static void brcmstb_gpio_quiesce(struct device *dev, bool save)
525{
526 struct brcmstb_gpio_priv *priv = dev_get_drvdata(dev);
527 struct brcmstb_gpio_bank *bank;
528 struct gpio_chip *gc;
529 u32 imask;
530
531 /* disable non-wake interrupt */
532 if (priv->parent_irq >= 0)
533 disable_irq(priv->parent_irq);
534
535 list_for_each_entry(bank, &priv->bank_list, node) {
536 gc = &bank->gc;
537
538 if (save)
539 brcmstb_gpio_bank_save(priv, bank);
540
541 /* Unmask GPIOs which have been flagged as wake-up sources */
542 if (priv->parent_wake_irq)
543 imask = bank->wake_active;
544 else
545 imask = 0;
546 gc->write_reg(priv->reg_base + GIO_MASK(bank->id),
547 imask);
548 }
549}
550
551static void brcmstb_gpio_shutdown(struct platform_device *pdev)
552{
553 /* Enable GPIO for S5 cold boot */
554 brcmstb_gpio_quiesce(&pdev->dev, false);
555}
556
557#ifdef CONFIG_PM_SLEEP
558static void brcmstb_gpio_bank_restore(struct brcmstb_gpio_priv *priv,
559 struct brcmstb_gpio_bank *bank)
560{
561 struct gpio_chip *gc = &bank->gc;
562 unsigned int i;
563
564 for (i = 0; i < GIO_REG_STAT; i++)
565 gc->write_reg(priv->reg_base + GIO_BANK_OFF(bank->id, i),
566 bank->saved_regs[i]);
567}
568
569static int brcmstb_gpio_suspend(struct device *dev)
570{
571 brcmstb_gpio_quiesce(dev, true);
572 return 0;
573}
574
575static int brcmstb_gpio_resume(struct device *dev)
576{
577 struct brcmstb_gpio_priv *priv = dev_get_drvdata(dev);
578 struct brcmstb_gpio_bank *bank;
579 bool need_wakeup_event = false;
580
581 list_for_each_entry(bank, &priv->bank_list, node) {
582 need_wakeup_event |= !!__brcmstb_gpio_get_active_irqs(bank);
583 brcmstb_gpio_bank_restore(priv, bank);
584 }
585
586 if (priv->parent_wake_irq && need_wakeup_event)
587 pm_wakeup_event(dev, 0);
588
589 /* enable non-wake interrupt */
590 if (priv->parent_irq >= 0)
591 enable_irq(priv->parent_irq);
592
593 return 0;
594}
595
596#else
597#define brcmstb_gpio_suspend NULL
598#define brcmstb_gpio_resume NULL
599#endif /* CONFIG_PM_SLEEP */
600
601static const struct dev_pm_ops brcmstb_gpio_pm_ops = {
602 .suspend_noirq = brcmstb_gpio_suspend,
603 .resume_noirq = brcmstb_gpio_resume,
604};
605
606static int brcmstb_gpio_probe(struct platform_device *pdev)
607{
608 struct device *dev = &pdev->dev;
609 struct device_node *np = dev->of_node;
610 void __iomem *reg_base;
611 struct brcmstb_gpio_priv *priv;
612 struct resource *res;
613 struct property *prop;
614 const __be32 *p;
615 u32 bank_width;
616 int num_banks = 0;
617 int err;
618 static int gpio_base;
619 unsigned long flags = 0;
620 bool need_wakeup_event = false;
621
622 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
623 if (!priv)
624 return -ENOMEM;
625 platform_set_drvdata(pdev, priv);
626 INIT_LIST_HEAD(&priv->bank_list);
627
628 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
629 reg_base = devm_ioremap_resource(dev, res);
630 if (IS_ERR(reg_base))
631 return PTR_ERR(reg_base);
632
633 priv->gpio_base = gpio_base;
634 priv->reg_base = reg_base;
635 priv->pdev = pdev;
636
637 if (of_property_read_bool(np, "interrupt-controller")) {
638 priv->parent_irq = platform_get_irq(pdev, 0);
639 if (priv->parent_irq <= 0) {
640 dev_err(dev, "Couldn't get IRQ");
641 return -ENOENT;
642 }
643 } else {
644 priv->parent_irq = -ENOENT;
645 }
646
647 if (brcmstb_gpio_sanity_check_banks(dev, np, res))
648 return -EINVAL;
649
650 /*
651 * MIPS endianness is configured by boot strap, which also reverses all
652 * bus endianness (i.e., big-endian CPU + big endian bus ==> native
653 * endian I/O).
654 *
655 * Other architectures (e.g., ARM) either do not support big endian, or
656 * else leave I/O in little endian mode.
657 */
658#if defined(CONFIG_MIPS) && defined(__BIG_ENDIAN)
659 flags = BGPIOF_BIG_ENDIAN_BYTE_ORDER;
660#endif
661
662 of_property_for_each_u32(np, "brcm,gpio-bank-widths", prop, p,
663 bank_width) {
664 struct brcmstb_gpio_bank *bank;
665 struct gpio_chip *gc;
666
667 bank = devm_kzalloc(dev, sizeof(*bank), GFP_KERNEL);
668 if (!bank) {
669 err = -ENOMEM;
670 goto fail;
671 }
672
673 bank->parent_priv = priv;
674 bank->id = num_banks;
675 if (bank_width <= 0 || bank_width > MAX_GPIO_PER_BANK) {
676 dev_err(dev, "Invalid bank width %d\n", bank_width);
677 err = -EINVAL;
678 goto fail;
679 } else {
680 bank->width = bank_width;
681 }
682
683 /*
684 * Regs are 4 bytes wide, have data reg, no set/clear regs,
685 * and direction bits have 0 = output and 1 = input
686 */
687 gc = &bank->gc;
688 err = bgpio_init(gc, dev, 4,
689 reg_base + GIO_DATA(bank->id),
690 NULL, NULL, NULL,
691 reg_base + GIO_IODIR(bank->id), flags);
692 if (err) {
693 dev_err(dev, "bgpio_init() failed\n");
694 goto fail;
695 }
696
697 gc->of_node = np;
698 gc->owner = THIS_MODULE;
699 gc->label = devm_kasprintf(dev, GFP_KERNEL, "%pOF", dev->of_node);
700 if (!gc->label) {
701 err = -ENOMEM;
702 goto fail;
703 }
704 gc->base = gpio_base;
705 gc->of_gpio_n_cells = 2;
706 gc->of_xlate = brcmstb_gpio_of_xlate;
707 /* not all ngpio lines are valid, will use bank width later */
708 gc->ngpio = MAX_GPIO_PER_BANK;
709 if (priv->parent_irq > 0)
710 gc->to_irq = brcmstb_gpio_to_irq;
711
712 /*
713 * Mask all interrupts by default, since wakeup interrupts may
714 * be retained from S5 cold boot
715 */
716 need_wakeup_event |= !!__brcmstb_gpio_get_active_irqs(bank);
717 gc->write_reg(reg_base + GIO_MASK(bank->id), 0);
718
719 err = gpiochip_add_data(gc, bank);
720 if (err) {
721 dev_err(dev, "Could not add gpiochip for bank %d\n",
722 bank->id);
723 goto fail;
724 }
725 gpio_base += gc->ngpio;
726
727 dev_dbg(dev, "bank=%d, base=%d, ngpio=%d, width=%d\n", bank->id,
728 gc->base, gc->ngpio, bank->width);
729
730 /* Everything looks good, so add bank to list */
731 list_add(&bank->node, &priv->bank_list);
732
733 num_banks++;
734 }
735
736 priv->num_gpios = gpio_base - priv->gpio_base;
737 if (priv->parent_irq > 0) {
738 err = brcmstb_gpio_irq_setup(pdev, priv);
739 if (err)
740 goto fail;
741 }
742
743 dev_info(dev, "Registered %d banks (GPIO(s): %d-%d)\n",
744 num_banks, priv->gpio_base, gpio_base - 1);
745
746 if (priv->parent_wake_irq && need_wakeup_event)
747 pm_wakeup_event(dev, 0);
748
749 return 0;
750
751fail:
752 (void) brcmstb_gpio_remove(pdev);
753 return err;
754}
755
756static const struct of_device_id brcmstb_gpio_of_match[] = {
757 { .compatible = "brcm,brcmstb-gpio" },
758 {},
759};
760
761MODULE_DEVICE_TABLE(of, brcmstb_gpio_of_match);
762
763static struct platform_driver brcmstb_gpio_driver = {
764 .driver = {
765 .name = "brcmstb-gpio",
766 .of_match_table = brcmstb_gpio_of_match,
767 .pm = &brcmstb_gpio_pm_ops,
768 },
769 .probe = brcmstb_gpio_probe,
770 .remove = brcmstb_gpio_remove,
771 .shutdown = brcmstb_gpio_shutdown,
772};
773module_platform_driver(brcmstb_gpio_driver);
774
775MODULE_AUTHOR("Gregory Fong");
776MODULE_DESCRIPTION("Driver for Broadcom BRCMSTB SoC UPG GPIO");
777MODULE_LICENSE("GPL v2");