Linux Audio

Check our new training course

Loading...
v6.13.7
  1// SPDX-License-Identifier: GPL-2.0-only
  2/*
  3 * Broadcom Kona GPIO Driver
  4 *
  5 * Author: Broadcom Corporation <bcm-kernel-feedback-list@broadcom.com>
  6 * Copyright (C) 2012-2014 Broadcom Corporation
 
 
 
 
 
 
 
 
 
  7 */
  8
  9#include <linux/bitops.h>
 10#include <linux/err.h>
 11#include <linux/gpio/driver.h>
 12#include <linux/init.h>
 13#include <linux/io.h>
 
 
 
 
 14#include <linux/irqdomain.h>
 15#include <linux/irqchip/chained_irq.h>
 16#include <linux/mod_devicetable.h>
 17#include <linux/platform_device.h>
 18#include <linux/property.h>
 19
 20#define BCM_GPIO_PASSWD				0x00a5a501
 21#define GPIO_PER_BANK				32
 22#define GPIO_MAX_BANK_NUM			8
 23
 24#define GPIO_BANK(gpio)				((gpio) >> 5)
 25#define GPIO_BIT(gpio)				((gpio) & (GPIO_PER_BANK - 1))
 26
 27/* There is a GPIO control register for each GPIO */
 28#define GPIO_CONTROL(gpio)			(0x00000100 + ((gpio) << 2))
 29
 30/* The remaining registers are per GPIO bank */
 31#define GPIO_OUT_STATUS(bank)			(0x00000000 + ((bank) << 2))
 32#define GPIO_IN_STATUS(bank)			(0x00000020 + ((bank) << 2))
 33#define GPIO_OUT_SET(bank)			(0x00000040 + ((bank) << 2))
 34#define GPIO_OUT_CLEAR(bank)			(0x00000060 + ((bank) << 2))
 35#define GPIO_INT_STATUS(bank)			(0x00000080 + ((bank) << 2))
 36#define GPIO_INT_MASK(bank)			(0x000000a0 + ((bank) << 2))
 37#define GPIO_INT_MSKCLR(bank)			(0x000000c0 + ((bank) << 2))
 38#define GPIO_PWD_STATUS(bank)			(0x00000500 + ((bank) << 2))
 39
 40#define GPIO_GPPWR_OFFSET			0x00000520
 41
 42#define GPIO_GPCTR0_DBR_SHIFT			5
 43#define GPIO_GPCTR0_DBR_MASK			0x000001e0
 44
 45#define GPIO_GPCTR0_ITR_SHIFT			3
 46#define GPIO_GPCTR0_ITR_MASK			0x00000018
 47#define GPIO_GPCTR0_ITR_CMD_RISING_EDGE		0x00000001
 48#define GPIO_GPCTR0_ITR_CMD_FALLING_EDGE	0x00000002
 49#define GPIO_GPCTR0_ITR_CMD_BOTH_EDGE		0x00000003
 50
 51#define GPIO_GPCTR0_IOTR_MASK			0x00000001
 52#define GPIO_GPCTR0_IOTR_CMD_0UTPUT		0x00000000
 53#define GPIO_GPCTR0_IOTR_CMD_INPUT		0x00000001
 54
 55#define GPIO_GPCTR0_DB_ENABLE_MASK		0x00000100
 56
 57#define LOCK_CODE				0xffffffff
 58#define UNLOCK_CODE				0x00000000
 59
 60struct bcm_kona_gpio {
 61	void __iomem *reg_base;
 62	int num_bank;
 63	raw_spinlock_t lock;
 64	struct gpio_chip gpio_chip;
 65	struct irq_domain *irq_domain;
 66	struct bcm_kona_gpio_bank *banks;
 
 67};
 68
 69struct bcm_kona_gpio_bank {
 70	int id;
 71	int irq;
 72	/*
 73	 * Used to keep track of lock/unlock operations for each GPIO in the
 74	 * bank.
 75	 *
 76	 * All GPIOs are locked by default (see bcm_kona_gpio_reset), and the
 77	 * unlock count for all GPIOs is 0 by default. Each unlock increments
 78	 * the counter, and each lock decrements the counter.
 79	 *
 80	 * The lock function only locks the GPIO once its unlock counter is
 81	 * down to 0. This is necessary because the GPIO is unlocked in two
 82	 * places in this driver: once for requested GPIOs, and once for
 83	 * requested IRQs. Since it is possible for a GPIO to be requested
 84	 * as both a GPIO and an IRQ, we need to ensure that we don't lock it
 85	 * too early.
 86	 */
 87	u8 gpio_unlock_count[GPIO_PER_BANK];
 88	/* Used in the interrupt handler */
 89	struct bcm_kona_gpio *kona_gpio;
 90};
 91
 92static inline void bcm_kona_gpio_write_lock_regs(void __iomem *reg_base,
 93						int bank_id, u32 lockcode)
 94{
 95	writel(BCM_GPIO_PASSWD, reg_base + GPIO_GPPWR_OFFSET);
 96	writel(lockcode, reg_base + GPIO_PWD_STATUS(bank_id));
 97}
 98
 99static void bcm_kona_gpio_lock_gpio(struct bcm_kona_gpio *kona_gpio,
100					unsigned gpio)
101{
102	u32 val;
103	unsigned long flags;
104	int bank_id = GPIO_BANK(gpio);
105	int bit = GPIO_BIT(gpio);
106	struct bcm_kona_gpio_bank *bank = &kona_gpio->banks[bank_id];
107
108	if (bank->gpio_unlock_count[bit] == 0) {
109		dev_err(kona_gpio->gpio_chip.parent,
110			"Unbalanced locks for GPIO %u\n", gpio);
111		return;
112	}
113
114	if (--bank->gpio_unlock_count[bit] == 0) {
115		raw_spin_lock_irqsave(&kona_gpio->lock, flags);
116
117		val = readl(kona_gpio->reg_base + GPIO_PWD_STATUS(bank_id));
118		val |= BIT(bit);
119		bcm_kona_gpio_write_lock_regs(kona_gpio->reg_base, bank_id, val);
120
121		raw_spin_unlock_irqrestore(&kona_gpio->lock, flags);
122	}
123}
124
125static void bcm_kona_gpio_unlock_gpio(struct bcm_kona_gpio *kona_gpio,
126					unsigned gpio)
127{
128	u32 val;
129	unsigned long flags;
130	int bank_id = GPIO_BANK(gpio);
131	int bit = GPIO_BIT(gpio);
132	struct bcm_kona_gpio_bank *bank = &kona_gpio->banks[bank_id];
133
134	if (bank->gpio_unlock_count[bit] == 0) {
135		raw_spin_lock_irqsave(&kona_gpio->lock, flags);
136
137		val = readl(kona_gpio->reg_base + GPIO_PWD_STATUS(bank_id));
138		val &= ~BIT(bit);
139		bcm_kona_gpio_write_lock_regs(kona_gpio->reg_base, bank_id, val);
140
141		raw_spin_unlock_irqrestore(&kona_gpio->lock, flags);
142	}
143
144	++bank->gpio_unlock_count[bit];
145}
146
147static int bcm_kona_gpio_get_dir(struct gpio_chip *chip, unsigned gpio)
148{
149	struct bcm_kona_gpio *kona_gpio = gpiochip_get_data(chip);
150	void __iomem *reg_base = kona_gpio->reg_base;
151	u32 val;
152
153	val = readl(reg_base + GPIO_CONTROL(gpio)) & GPIO_GPCTR0_IOTR_MASK;
154	return val ? GPIO_LINE_DIRECTION_IN : GPIO_LINE_DIRECTION_OUT;
155}
156
157static void bcm_kona_gpio_set(struct gpio_chip *chip, unsigned gpio, int value)
158{
159	struct bcm_kona_gpio *kona_gpio;
160	void __iomem *reg_base;
161	int bank_id = GPIO_BANK(gpio);
162	int bit = GPIO_BIT(gpio);
163	u32 val, reg_offset;
164	unsigned long flags;
165
166	kona_gpio = gpiochip_get_data(chip);
167	reg_base = kona_gpio->reg_base;
168	raw_spin_lock_irqsave(&kona_gpio->lock, flags);
169
170	/* this function only applies to output pin */
171	if (bcm_kona_gpio_get_dir(chip, gpio) == GPIO_LINE_DIRECTION_IN)
172		goto out;
173
174	reg_offset = value ? GPIO_OUT_SET(bank_id) : GPIO_OUT_CLEAR(bank_id);
175
176	val = readl(reg_base + reg_offset);
177	val |= BIT(bit);
178	writel(val, reg_base + reg_offset);
179
180out:
181	raw_spin_unlock_irqrestore(&kona_gpio->lock, flags);
182}
183
184static int bcm_kona_gpio_get(struct gpio_chip *chip, unsigned gpio)
185{
186	struct bcm_kona_gpio *kona_gpio;
187	void __iomem *reg_base;
188	int bank_id = GPIO_BANK(gpio);
189	int bit = GPIO_BIT(gpio);
190	u32 val, reg_offset;
191	unsigned long flags;
192
193	kona_gpio = gpiochip_get_data(chip);
194	reg_base = kona_gpio->reg_base;
195	raw_spin_lock_irqsave(&kona_gpio->lock, flags);
196
197	if (bcm_kona_gpio_get_dir(chip, gpio) == GPIO_LINE_DIRECTION_IN)
198		reg_offset = GPIO_IN_STATUS(bank_id);
199	else
200		reg_offset = GPIO_OUT_STATUS(bank_id);
201
202	/* read the GPIO bank status */
203	val = readl(reg_base + reg_offset);
204
205	raw_spin_unlock_irqrestore(&kona_gpio->lock, flags);
206
207	/* return the specified bit status */
208	return !!(val & BIT(bit));
209}
210
211static int bcm_kona_gpio_request(struct gpio_chip *chip, unsigned gpio)
212{
213	struct bcm_kona_gpio *kona_gpio = gpiochip_get_data(chip);
214
215	bcm_kona_gpio_unlock_gpio(kona_gpio, gpio);
216	return 0;
217}
218
219static void bcm_kona_gpio_free(struct gpio_chip *chip, unsigned gpio)
220{
221	struct bcm_kona_gpio *kona_gpio = gpiochip_get_data(chip);
222
223	bcm_kona_gpio_lock_gpio(kona_gpio, gpio);
224}
225
226static int bcm_kona_gpio_direction_input(struct gpio_chip *chip, unsigned gpio)
227{
228	struct bcm_kona_gpio *kona_gpio;
229	void __iomem *reg_base;
230	u32 val;
231	unsigned long flags;
232
233	kona_gpio = gpiochip_get_data(chip);
234	reg_base = kona_gpio->reg_base;
235	raw_spin_lock_irqsave(&kona_gpio->lock, flags);
236
237	val = readl(reg_base + GPIO_CONTROL(gpio));
238	val &= ~GPIO_GPCTR0_IOTR_MASK;
239	val |= GPIO_GPCTR0_IOTR_CMD_INPUT;
240	writel(val, reg_base + GPIO_CONTROL(gpio));
241
242	raw_spin_unlock_irqrestore(&kona_gpio->lock, flags);
243
244	return 0;
245}
246
247static int bcm_kona_gpio_direction_output(struct gpio_chip *chip,
248					  unsigned gpio, int value)
249{
250	struct bcm_kona_gpio *kona_gpio;
251	void __iomem *reg_base;
252	int bank_id = GPIO_BANK(gpio);
253	int bit = GPIO_BIT(gpio);
254	u32 val, reg_offset;
255	unsigned long flags;
256
257	kona_gpio = gpiochip_get_data(chip);
258	reg_base = kona_gpio->reg_base;
259	raw_spin_lock_irqsave(&kona_gpio->lock, flags);
260
261	val = readl(reg_base + GPIO_CONTROL(gpio));
262	val &= ~GPIO_GPCTR0_IOTR_MASK;
263	val |= GPIO_GPCTR0_IOTR_CMD_0UTPUT;
264	writel(val, reg_base + GPIO_CONTROL(gpio));
265	reg_offset = value ? GPIO_OUT_SET(bank_id) : GPIO_OUT_CLEAR(bank_id);
266
267	val = readl(reg_base + reg_offset);
268	val |= BIT(bit);
269	writel(val, reg_base + reg_offset);
270
271	raw_spin_unlock_irqrestore(&kona_gpio->lock, flags);
272
273	return 0;
274}
275
276static int bcm_kona_gpio_to_irq(struct gpio_chip *chip, unsigned gpio)
277{
278	struct bcm_kona_gpio *kona_gpio;
279
280	kona_gpio = gpiochip_get_data(chip);
281	if (gpio >= kona_gpio->gpio_chip.ngpio)
282		return -ENXIO;
283	return irq_create_mapping(kona_gpio->irq_domain, gpio);
284}
285
286static int bcm_kona_gpio_set_debounce(struct gpio_chip *chip, unsigned gpio,
287				      unsigned debounce)
288{
289	struct bcm_kona_gpio *kona_gpio;
290	void __iomem *reg_base;
291	u32 val, res;
292	unsigned long flags;
293
294	kona_gpio = gpiochip_get_data(chip);
295	reg_base = kona_gpio->reg_base;
296	/* debounce must be 1-128ms (or 0) */
297	if ((debounce > 0 && debounce < 1000) || debounce > 128000) {
298		dev_err(chip->parent, "Debounce value %u not in range\n",
299			debounce);
300		return -EINVAL;
301	}
302
303	/* calculate debounce bit value */
304	if (debounce != 0) {
305		/* Convert to ms */
306		debounce /= 1000;
307		/* find the MSB */
308		res = fls(debounce) - 1;
309		/* Check if MSB-1 is set (round up or down) */
310		if (res > 0 && (debounce & BIT(res - 1)))
311			res++;
312	}
313
314	/* spin lock for read-modify-write of the GPIO register */
315	raw_spin_lock_irqsave(&kona_gpio->lock, flags);
316
317	val = readl(reg_base + GPIO_CONTROL(gpio));
318	val &= ~GPIO_GPCTR0_DBR_MASK;
319
320	if (debounce == 0) {
321		/* disable debounce */
322		val &= ~GPIO_GPCTR0_DB_ENABLE_MASK;
323	} else {
324		val |= GPIO_GPCTR0_DB_ENABLE_MASK |
325		    (res << GPIO_GPCTR0_DBR_SHIFT);
326	}
327
328	writel(val, reg_base + GPIO_CONTROL(gpio));
329
330	raw_spin_unlock_irqrestore(&kona_gpio->lock, flags);
331
332	return 0;
333}
334
335static int bcm_kona_gpio_set_config(struct gpio_chip *chip, unsigned gpio,
336				    unsigned long config)
337{
338	u32 debounce;
339
340	if (pinconf_to_config_param(config) != PIN_CONFIG_INPUT_DEBOUNCE)
341		return -ENOTSUPP;
342
343	debounce = pinconf_to_config_argument(config);
344	return bcm_kona_gpio_set_debounce(chip, gpio, debounce);
345}
346
347static const struct gpio_chip template_chip = {
348	.label = "bcm-kona-gpio",
349	.owner = THIS_MODULE,
350	.request = bcm_kona_gpio_request,
351	.free = bcm_kona_gpio_free,
352	.get_direction = bcm_kona_gpio_get_dir,
353	.direction_input = bcm_kona_gpio_direction_input,
354	.get = bcm_kona_gpio_get,
355	.direction_output = bcm_kona_gpio_direction_output,
356	.set = bcm_kona_gpio_set,
357	.set_config = bcm_kona_gpio_set_config,
358	.to_irq = bcm_kona_gpio_to_irq,
359	.base = 0,
360};
361
362static void bcm_kona_gpio_irq_ack(struct irq_data *d)
363{
364	struct bcm_kona_gpio *kona_gpio;
365	void __iomem *reg_base;
366	unsigned gpio = d->hwirq;
367	int bank_id = GPIO_BANK(gpio);
368	int bit = GPIO_BIT(gpio);
369	u32 val;
370	unsigned long flags;
371
372	kona_gpio = irq_data_get_irq_chip_data(d);
373	reg_base = kona_gpio->reg_base;
374	raw_spin_lock_irqsave(&kona_gpio->lock, flags);
375
376	val = readl(reg_base + GPIO_INT_STATUS(bank_id));
377	val |= BIT(bit);
378	writel(val, reg_base + GPIO_INT_STATUS(bank_id));
379
380	raw_spin_unlock_irqrestore(&kona_gpio->lock, flags);
381}
382
383static void bcm_kona_gpio_irq_mask(struct irq_data *d)
384{
385	struct bcm_kona_gpio *kona_gpio;
386	void __iomem *reg_base;
387	unsigned gpio = d->hwirq;
388	int bank_id = GPIO_BANK(gpio);
389	int bit = GPIO_BIT(gpio);
390	u32 val;
391	unsigned long flags;
392
393	kona_gpio = irq_data_get_irq_chip_data(d);
394	reg_base = kona_gpio->reg_base;
395
396	raw_spin_lock_irqsave(&kona_gpio->lock, flags);
397
398	val = readl(reg_base + GPIO_INT_MASK(bank_id));
399	val |= BIT(bit);
400	writel(val, reg_base + GPIO_INT_MASK(bank_id));
401	gpiochip_disable_irq(&kona_gpio->gpio_chip, gpio);
402
403	raw_spin_unlock_irqrestore(&kona_gpio->lock, flags);
404}
405
406static void bcm_kona_gpio_irq_unmask(struct irq_data *d)
407{
408	struct bcm_kona_gpio *kona_gpio;
409	void __iomem *reg_base;
410	unsigned gpio = d->hwirq;
411	int bank_id = GPIO_BANK(gpio);
412	int bit = GPIO_BIT(gpio);
413	u32 val;
414	unsigned long flags;
415
416	kona_gpio = irq_data_get_irq_chip_data(d);
417	reg_base = kona_gpio->reg_base;
418
419	raw_spin_lock_irqsave(&kona_gpio->lock, flags);
420
421	val = readl(reg_base + GPIO_INT_MSKCLR(bank_id));
422	val |= BIT(bit);
423	writel(val, reg_base + GPIO_INT_MSKCLR(bank_id));
424	gpiochip_enable_irq(&kona_gpio->gpio_chip, gpio);
425
426	raw_spin_unlock_irqrestore(&kona_gpio->lock, flags);
427}
428
429static int bcm_kona_gpio_irq_set_type(struct irq_data *d, unsigned int type)
430{
431	struct bcm_kona_gpio *kona_gpio;
432	void __iomem *reg_base;
433	unsigned gpio = d->hwirq;
434	u32 lvl_type;
435	u32 val;
436	unsigned long flags;
437
438	kona_gpio = irq_data_get_irq_chip_data(d);
439	reg_base = kona_gpio->reg_base;
440	switch (type & IRQ_TYPE_SENSE_MASK) {
441	case IRQ_TYPE_EDGE_RISING:
442		lvl_type = GPIO_GPCTR0_ITR_CMD_RISING_EDGE;
443		break;
444
445	case IRQ_TYPE_EDGE_FALLING:
446		lvl_type = GPIO_GPCTR0_ITR_CMD_FALLING_EDGE;
447		break;
448
449	case IRQ_TYPE_EDGE_BOTH:
450		lvl_type = GPIO_GPCTR0_ITR_CMD_BOTH_EDGE;
451		break;
452
453	case IRQ_TYPE_LEVEL_HIGH:
454	case IRQ_TYPE_LEVEL_LOW:
455		/* BCM GPIO doesn't support level triggering */
456	default:
457		dev_err(kona_gpio->gpio_chip.parent,
458			"Invalid BCM GPIO irq type 0x%x\n", type);
459		return -EINVAL;
460	}
461
462	raw_spin_lock_irqsave(&kona_gpio->lock, flags);
463
464	val = readl(reg_base + GPIO_CONTROL(gpio));
465	val &= ~GPIO_GPCTR0_ITR_MASK;
466	val |= lvl_type << GPIO_GPCTR0_ITR_SHIFT;
467	writel(val, reg_base + GPIO_CONTROL(gpio));
468
469	raw_spin_unlock_irqrestore(&kona_gpio->lock, flags);
470
471	return 0;
472}
473
474static void bcm_kona_gpio_irq_handler(struct irq_desc *desc)
475{
476	void __iomem *reg_base;
477	int bit, bank_id;
478	unsigned long sta;
479	struct bcm_kona_gpio_bank *bank = irq_desc_get_handler_data(desc);
480	struct irq_chip *chip = irq_desc_get_chip(desc);
481
482	chained_irq_enter(chip, desc);
483
484	/*
485	 * For bank interrupts, we can't use chip_data to store the kona_gpio
486	 * pointer, since GIC needs it for its own purposes. Therefore, we get
487	 * our pointer from the bank structure.
488	 */
489	reg_base = bank->kona_gpio->reg_base;
490	bank_id = bank->id;
491
492	while ((sta = readl(reg_base + GPIO_INT_STATUS(bank_id)) &
493		    (~(readl(reg_base + GPIO_INT_MASK(bank_id)))))) {
494		for_each_set_bit(bit, &sta, 32) {
495			int hwirq = GPIO_PER_BANK * bank_id + bit;
 
 
 
496			/*
497			 * Clear interrupt before handler is called so we don't
498			 * miss any interrupt occurred during executing them.
499			 */
500			writel(readl(reg_base + GPIO_INT_STATUS(bank_id)) |
501			       BIT(bit), reg_base + GPIO_INT_STATUS(bank_id));
502			/* Invoke interrupt handler */
503			generic_handle_domain_irq(bank->kona_gpio->irq_domain,
504						  hwirq);
505		}
506	}
507
508	chained_irq_exit(chip, desc);
509}
510
511static int bcm_kona_gpio_irq_reqres(struct irq_data *d)
512{
513	struct bcm_kona_gpio *kona_gpio = irq_data_get_irq_chip_data(d);
514	unsigned int gpio = d->hwirq;
515
516	/*
517	 * We need to unlock the GPIO before any other operations are performed
518	 * on the relevant GPIO configuration registers
519	 */
520	bcm_kona_gpio_unlock_gpio(kona_gpio, gpio);
521
522	return gpiochip_reqres_irq(&kona_gpio->gpio_chip, gpio);
523}
524
525static void bcm_kona_gpio_irq_relres(struct irq_data *d)
526{
527	struct bcm_kona_gpio *kona_gpio = irq_data_get_irq_chip_data(d);
528	unsigned int gpio = d->hwirq;
529
530	/* Once we no longer use it, lock the GPIO again */
531	bcm_kona_gpio_lock_gpio(kona_gpio, gpio);
532
533	gpiochip_relres_irq(&kona_gpio->gpio_chip, gpio);
534}
535
536static struct irq_chip bcm_gpio_irq_chip = {
537	.name = "bcm-kona-gpio",
538	.irq_ack = bcm_kona_gpio_irq_ack,
539	.irq_mask = bcm_kona_gpio_irq_mask,
540	.irq_unmask = bcm_kona_gpio_irq_unmask,
541	.irq_set_type = bcm_kona_gpio_irq_set_type,
542	.irq_request_resources = bcm_kona_gpio_irq_reqres,
543	.irq_release_resources = bcm_kona_gpio_irq_relres,
544};
545
546static struct of_device_id const bcm_kona_gpio_of_match[] = {
547	{ .compatible = "brcm,kona-gpio" },
548	{}
549};
550
 
 
551/*
552 * This lock class tells lockdep that GPIO irqs are in a different
553 * category than their parents, so it won't report false recursion.
554 */
555static struct lock_class_key gpio_lock_class;
556static struct lock_class_key gpio_request_class;
557
558static int bcm_kona_gpio_irq_map(struct irq_domain *d, unsigned int irq,
559				 irq_hw_number_t hwirq)
560{
561	int ret;
562
563	ret = irq_set_chip_data(irq, d->host_data);
564	if (ret < 0)
565		return ret;
566	irq_set_lockdep_class(irq, &gpio_lock_class, &gpio_request_class);
567	irq_set_chip_and_handler(irq, &bcm_gpio_irq_chip, handle_simple_irq);
568	irq_set_noprobe(irq);
569
570	return 0;
571}
572
573static void bcm_kona_gpio_irq_unmap(struct irq_domain *d, unsigned int irq)
574{
575	irq_set_chip_and_handler(irq, NULL, NULL);
576	irq_set_chip_data(irq, NULL);
577}
578
579static const struct irq_domain_ops bcm_kona_irq_ops = {
580	.map = bcm_kona_gpio_irq_map,
581	.unmap = bcm_kona_gpio_irq_unmap,
582	.xlate = irq_domain_xlate_twocell,
583};
584
585static void bcm_kona_gpio_reset(struct bcm_kona_gpio *kona_gpio)
586{
587	void __iomem *reg_base;
588	int i;
589
590	reg_base = kona_gpio->reg_base;
591	/* disable interrupts and clear status */
592	for (i = 0; i < kona_gpio->num_bank; i++) {
593		/* Unlock the entire bank first */
594		bcm_kona_gpio_write_lock_regs(reg_base, i, UNLOCK_CODE);
595		writel(0xffffffff, reg_base + GPIO_INT_MASK(i));
596		writel(0xffffffff, reg_base + GPIO_INT_STATUS(i));
597		/* Now re-lock the bank */
598		bcm_kona_gpio_write_lock_regs(reg_base, i, LOCK_CODE);
599	}
600}
601
602static int bcm_kona_gpio_probe(struct platform_device *pdev)
603{
604	struct device *dev = &pdev->dev;
 
 
605	struct bcm_kona_gpio_bank *bank;
606	struct bcm_kona_gpio *kona_gpio;
607	struct gpio_chip *chip;
608	int ret;
609	int i;
610
 
 
 
 
 
 
611	kona_gpio = devm_kzalloc(dev, sizeof(*kona_gpio), GFP_KERNEL);
612	if (!kona_gpio)
613		return -ENOMEM;
614
615	kona_gpio->gpio_chip = template_chip;
616	chip = &kona_gpio->gpio_chip;
617	ret = platform_irq_count(pdev);
618	if (!ret) {
619		dev_err(dev, "Couldn't determine # GPIO banks\n");
620		return -ENOENT;
621	} else if (ret < 0) {
622		return dev_err_probe(dev, ret, "Couldn't determine GPIO banks\n");
623	}
624	kona_gpio->num_bank = ret;
625
626	if (kona_gpio->num_bank > GPIO_MAX_BANK_NUM) {
627		dev_err(dev, "Too many GPIO banks configured (max=%d)\n",
628			GPIO_MAX_BANK_NUM);
629		return -ENXIO;
630	}
631	kona_gpio->banks = devm_kcalloc(dev,
632					kona_gpio->num_bank,
633					sizeof(*kona_gpio->banks),
634					GFP_KERNEL);
635	if (!kona_gpio->banks)
636		return -ENOMEM;
637
638	chip->parent = dev;
 
 
639	chip->ngpio = kona_gpio->num_bank * GPIO_PER_BANK;
640
641	kona_gpio->irq_domain = irq_domain_create_linear(dev_fwnode(dev),
642							 chip->ngpio,
643							 &bcm_kona_irq_ops,
644							 kona_gpio);
645	if (!kona_gpio->irq_domain) {
646		dev_err(dev, "Couldn't allocate IRQ domain\n");
647		return -ENXIO;
648	}
649
650	kona_gpio->reg_base = devm_platform_ioremap_resource(pdev, 0);
 
651	if (IS_ERR(kona_gpio->reg_base)) {
652		ret = PTR_ERR(kona_gpio->reg_base);
653		goto err_irq_domain;
654	}
655
656	for (i = 0; i < kona_gpio->num_bank; i++) {
657		bank = &kona_gpio->banks[i];
658		bank->id = i;
659		bank->irq = platform_get_irq(pdev, i);
660		bank->kona_gpio = kona_gpio;
661		if (bank->irq < 0) {
662			dev_err(dev, "Couldn't get IRQ for bank %d\n", i);
663			ret = -ENOENT;
664			goto err_irq_domain;
665		}
666	}
667
668	dev_info(&pdev->dev, "Setting up Kona GPIO\n");
669
670	bcm_kona_gpio_reset(kona_gpio);
671
672	ret = devm_gpiochip_add_data(dev, chip, kona_gpio);
673	if (ret < 0) {
674		dev_err(dev, "Couldn't add GPIO chip -- %d\n", ret);
675		goto err_irq_domain;
676	}
677	for (i = 0; i < kona_gpio->num_bank; i++) {
678		bank = &kona_gpio->banks[i];
679		irq_set_chained_handler_and_data(bank->irq,
680						 bcm_kona_gpio_irq_handler,
681						 bank);
682	}
683
684	raw_spin_lock_init(&kona_gpio->lock);
685
686	return 0;
687
688err_irq_domain:
689	irq_domain_remove(kona_gpio->irq_domain);
690
691	return ret;
692}
693
694static struct platform_driver bcm_kona_gpio_driver = {
695	.driver = {
696			.name = "bcm-kona-gpio",
697			.of_match_table = bcm_kona_gpio_of_match,
698	},
699	.probe = bcm_kona_gpio_probe,
700};
701builtin_platform_driver(bcm_kona_gpio_driver);
 
 
 
 
 
v4.6
 
  1/*
 
 
 
  2 * Copyright (C) 2012-2014 Broadcom Corporation
  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/err.h>
 
 
 16#include <linux/io.h>
 17#include <linux/gpio.h>
 18#include <linux/of_device.h>
 19#include <linux/of_irq.h>
 20#include <linux/module.h>
 21#include <linux/irqdomain.h>
 22#include <linux/irqchip/chained_irq.h>
 
 
 
 23
 24#define BCM_GPIO_PASSWD				0x00a5a501
 25#define GPIO_PER_BANK				32
 26#define GPIO_MAX_BANK_NUM			8
 27
 28#define GPIO_BANK(gpio)				((gpio) >> 5)
 29#define GPIO_BIT(gpio)				((gpio) & (GPIO_PER_BANK - 1))
 30
 31/* There is a GPIO control register for each GPIO */
 32#define GPIO_CONTROL(gpio)			(0x00000100 + ((gpio) << 2))
 33
 34/* The remaining registers are per GPIO bank */
 35#define GPIO_OUT_STATUS(bank)			(0x00000000 + ((bank) << 2))
 36#define GPIO_IN_STATUS(bank)			(0x00000020 + ((bank) << 2))
 37#define GPIO_OUT_SET(bank)			(0x00000040 + ((bank) << 2))
 38#define GPIO_OUT_CLEAR(bank)			(0x00000060 + ((bank) << 2))
 39#define GPIO_INT_STATUS(bank)			(0x00000080 + ((bank) << 2))
 40#define GPIO_INT_MASK(bank)			(0x000000a0 + ((bank) << 2))
 41#define GPIO_INT_MSKCLR(bank)			(0x000000c0 + ((bank) << 2))
 42#define GPIO_PWD_STATUS(bank)			(0x00000500 + ((bank) << 2))
 43
 44#define GPIO_GPPWR_OFFSET			0x00000520
 45
 46#define GPIO_GPCTR0_DBR_SHIFT			5
 47#define GPIO_GPCTR0_DBR_MASK			0x000001e0
 48
 49#define GPIO_GPCTR0_ITR_SHIFT			3
 50#define GPIO_GPCTR0_ITR_MASK			0x00000018
 51#define GPIO_GPCTR0_ITR_CMD_RISING_EDGE		0x00000001
 52#define GPIO_GPCTR0_ITR_CMD_FALLING_EDGE	0x00000002
 53#define GPIO_GPCTR0_ITR_CMD_BOTH_EDGE		0x00000003
 54
 55#define GPIO_GPCTR0_IOTR_MASK			0x00000001
 56#define GPIO_GPCTR0_IOTR_CMD_0UTPUT		0x00000000
 57#define GPIO_GPCTR0_IOTR_CMD_INPUT		0x00000001
 58
 59#define GPIO_GPCTR0_DB_ENABLE_MASK		0x00000100
 60
 61#define LOCK_CODE				0xffffffff
 62#define UNLOCK_CODE				0x00000000
 63
 64struct bcm_kona_gpio {
 65	void __iomem *reg_base;
 66	int num_bank;
 67	spinlock_t lock;
 68	struct gpio_chip gpio_chip;
 69	struct irq_domain *irq_domain;
 70	struct bcm_kona_gpio_bank *banks;
 71	struct platform_device *pdev;
 72};
 73
 74struct bcm_kona_gpio_bank {
 75	int id;
 76	int irq;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 77	/* Used in the interrupt handler */
 78	struct bcm_kona_gpio *kona_gpio;
 79};
 80
 81static inline void bcm_kona_gpio_write_lock_regs(void __iomem *reg_base,
 82						int bank_id, u32 lockcode)
 83{
 84	writel(BCM_GPIO_PASSWD, reg_base + GPIO_GPPWR_OFFSET);
 85	writel(lockcode, reg_base + GPIO_PWD_STATUS(bank_id));
 86}
 87
 88static void bcm_kona_gpio_lock_gpio(struct bcm_kona_gpio *kona_gpio,
 89					unsigned gpio)
 90{
 91	u32 val;
 92	unsigned long flags;
 93	int bank_id = GPIO_BANK(gpio);
 
 
 
 
 
 
 
 
 94
 95	spin_lock_irqsave(&kona_gpio->lock, flags);
 
 96
 97	val = readl(kona_gpio->reg_base + GPIO_PWD_STATUS(bank_id));
 98	val |= BIT(gpio);
 99	bcm_kona_gpio_write_lock_regs(kona_gpio->reg_base, bank_id, val);
100
101	spin_unlock_irqrestore(&kona_gpio->lock, flags);
 
102}
103
104static void bcm_kona_gpio_unlock_gpio(struct bcm_kona_gpio *kona_gpio,
105					unsigned gpio)
106{
107	u32 val;
108	unsigned long flags;
109	int bank_id = GPIO_BANK(gpio);
 
 
110
111	spin_lock_irqsave(&kona_gpio->lock, flags);
 
112
113	val = readl(kona_gpio->reg_base + GPIO_PWD_STATUS(bank_id));
114	val &= ~BIT(gpio);
115	bcm_kona_gpio_write_lock_regs(kona_gpio->reg_base, bank_id, val);
116
117	spin_unlock_irqrestore(&kona_gpio->lock, flags);
 
 
 
118}
119
120static int bcm_kona_gpio_get_dir(struct gpio_chip *chip, unsigned gpio)
121{
122	struct bcm_kona_gpio *kona_gpio = gpiochip_get_data(chip);
123	void __iomem *reg_base = kona_gpio->reg_base;
124	u32 val;
125
126	val = readl(reg_base + GPIO_CONTROL(gpio)) & GPIO_GPCTR0_IOTR_MASK;
127	return val ? GPIOF_DIR_IN : GPIOF_DIR_OUT;
128}
129
130static void bcm_kona_gpio_set(struct gpio_chip *chip, unsigned gpio, int value)
131{
132	struct bcm_kona_gpio *kona_gpio;
133	void __iomem *reg_base;
134	int bank_id = GPIO_BANK(gpio);
135	int bit = GPIO_BIT(gpio);
136	u32 val, reg_offset;
137	unsigned long flags;
138
139	kona_gpio = gpiochip_get_data(chip);
140	reg_base = kona_gpio->reg_base;
141	spin_lock_irqsave(&kona_gpio->lock, flags);
142
143	/* this function only applies to output pin */
144	if (bcm_kona_gpio_get_dir(chip, gpio) == GPIOF_DIR_IN)
145		goto out;
146
147	reg_offset = value ? GPIO_OUT_SET(bank_id) : GPIO_OUT_CLEAR(bank_id);
148
149	val = readl(reg_base + reg_offset);
150	val |= BIT(bit);
151	writel(val, reg_base + reg_offset);
152
153out:
154	spin_unlock_irqrestore(&kona_gpio->lock, flags);
155}
156
157static int bcm_kona_gpio_get(struct gpio_chip *chip, unsigned gpio)
158{
159	struct bcm_kona_gpio *kona_gpio;
160	void __iomem *reg_base;
161	int bank_id = GPIO_BANK(gpio);
162	int bit = GPIO_BIT(gpio);
163	u32 val, reg_offset;
164	unsigned long flags;
165
166	kona_gpio = gpiochip_get_data(chip);
167	reg_base = kona_gpio->reg_base;
168	spin_lock_irqsave(&kona_gpio->lock, flags);
169
170	if (bcm_kona_gpio_get_dir(chip, gpio) == GPIOF_DIR_IN)
171		reg_offset = GPIO_IN_STATUS(bank_id);
172	else
173		reg_offset = GPIO_OUT_STATUS(bank_id);
174
175	/* read the GPIO bank status */
176	val = readl(reg_base + reg_offset);
177
178	spin_unlock_irqrestore(&kona_gpio->lock, flags);
179
180	/* return the specified bit status */
181	return !!(val & BIT(bit));
182}
183
184static int bcm_kona_gpio_request(struct gpio_chip *chip, unsigned gpio)
185{
186	struct bcm_kona_gpio *kona_gpio = gpiochip_get_data(chip);
187
188	bcm_kona_gpio_unlock_gpio(kona_gpio, gpio);
189	return 0;
190}
191
192static void bcm_kona_gpio_free(struct gpio_chip *chip, unsigned gpio)
193{
194	struct bcm_kona_gpio *kona_gpio = gpiochip_get_data(chip);
195
196	bcm_kona_gpio_lock_gpio(kona_gpio, gpio);
197}
198
199static int bcm_kona_gpio_direction_input(struct gpio_chip *chip, unsigned gpio)
200{
201	struct bcm_kona_gpio *kona_gpio;
202	void __iomem *reg_base;
203	u32 val;
204	unsigned long flags;
205
206	kona_gpio = gpiochip_get_data(chip);
207	reg_base = kona_gpio->reg_base;
208	spin_lock_irqsave(&kona_gpio->lock, flags);
209
210	val = readl(reg_base + GPIO_CONTROL(gpio));
211	val &= ~GPIO_GPCTR0_IOTR_MASK;
212	val |= GPIO_GPCTR0_IOTR_CMD_INPUT;
213	writel(val, reg_base + GPIO_CONTROL(gpio));
214
215	spin_unlock_irqrestore(&kona_gpio->lock, flags);
216
217	return 0;
218}
219
220static int bcm_kona_gpio_direction_output(struct gpio_chip *chip,
221					  unsigned gpio, int value)
222{
223	struct bcm_kona_gpio *kona_gpio;
224	void __iomem *reg_base;
225	int bank_id = GPIO_BANK(gpio);
226	int bit = GPIO_BIT(gpio);
227	u32 val, reg_offset;
228	unsigned long flags;
229
230	kona_gpio = gpiochip_get_data(chip);
231	reg_base = kona_gpio->reg_base;
232	spin_lock_irqsave(&kona_gpio->lock, flags);
233
234	val = readl(reg_base + GPIO_CONTROL(gpio));
235	val &= ~GPIO_GPCTR0_IOTR_MASK;
236	val |= GPIO_GPCTR0_IOTR_CMD_0UTPUT;
237	writel(val, reg_base + GPIO_CONTROL(gpio));
238	reg_offset = value ? GPIO_OUT_SET(bank_id) : GPIO_OUT_CLEAR(bank_id);
239
240	val = readl(reg_base + reg_offset);
241	val |= BIT(bit);
242	writel(val, reg_base + reg_offset);
243
244	spin_unlock_irqrestore(&kona_gpio->lock, flags);
245
246	return 0;
247}
248
249static int bcm_kona_gpio_to_irq(struct gpio_chip *chip, unsigned gpio)
250{
251	struct bcm_kona_gpio *kona_gpio;
252
253	kona_gpio = gpiochip_get_data(chip);
254	if (gpio >= kona_gpio->gpio_chip.ngpio)
255		return -ENXIO;
256	return irq_create_mapping(kona_gpio->irq_domain, gpio);
257}
258
259static int bcm_kona_gpio_set_debounce(struct gpio_chip *chip, unsigned gpio,
260				      unsigned debounce)
261{
262	struct bcm_kona_gpio *kona_gpio;
263	void __iomem *reg_base;
264	u32 val, res;
265	unsigned long flags;
266
267	kona_gpio = gpiochip_get_data(chip);
268	reg_base = kona_gpio->reg_base;
269	/* debounce must be 1-128ms (or 0) */
270	if ((debounce > 0 && debounce < 1000) || debounce > 128000) {
271		dev_err(chip->parent, "Debounce value %u not in range\n",
272			debounce);
273		return -EINVAL;
274	}
275
276	/* calculate debounce bit value */
277	if (debounce != 0) {
278		/* Convert to ms */
279		debounce /= 1000;
280		/* find the MSB */
281		res = fls(debounce) - 1;
282		/* Check if MSB-1 is set (round up or down) */
283		if (res > 0 && (debounce & BIT(res - 1)))
284			res++;
285	}
286
287	/* spin lock for read-modify-write of the GPIO register */
288	spin_lock_irqsave(&kona_gpio->lock, flags);
289
290	val = readl(reg_base + GPIO_CONTROL(gpio));
291	val &= ~GPIO_GPCTR0_DBR_MASK;
292
293	if (debounce == 0) {
294		/* disable debounce */
295		val &= ~GPIO_GPCTR0_DB_ENABLE_MASK;
296	} else {
297		val |= GPIO_GPCTR0_DB_ENABLE_MASK |
298		    (res << GPIO_GPCTR0_DBR_SHIFT);
299	}
300
301	writel(val, reg_base + GPIO_CONTROL(gpio));
302
303	spin_unlock_irqrestore(&kona_gpio->lock, flags);
304
305	return 0;
306}
307
308static struct gpio_chip template_chip = {
 
 
 
 
 
 
 
 
 
 
 
 
309	.label = "bcm-kona-gpio",
310	.owner = THIS_MODULE,
311	.request = bcm_kona_gpio_request,
312	.free = bcm_kona_gpio_free,
313	.get_direction = bcm_kona_gpio_get_dir,
314	.direction_input = bcm_kona_gpio_direction_input,
315	.get = bcm_kona_gpio_get,
316	.direction_output = bcm_kona_gpio_direction_output,
317	.set = bcm_kona_gpio_set,
318	.set_debounce = bcm_kona_gpio_set_debounce,
319	.to_irq = bcm_kona_gpio_to_irq,
320	.base = 0,
321};
322
323static void bcm_kona_gpio_irq_ack(struct irq_data *d)
324{
325	struct bcm_kona_gpio *kona_gpio;
326	void __iomem *reg_base;
327	unsigned gpio = d->hwirq;
328	int bank_id = GPIO_BANK(gpio);
329	int bit = GPIO_BIT(gpio);
330	u32 val;
331	unsigned long flags;
332
333	kona_gpio = irq_data_get_irq_chip_data(d);
334	reg_base = kona_gpio->reg_base;
335	spin_lock_irqsave(&kona_gpio->lock, flags);
336
337	val = readl(reg_base + GPIO_INT_STATUS(bank_id));
338	val |= BIT(bit);
339	writel(val, reg_base + GPIO_INT_STATUS(bank_id));
340
341	spin_unlock_irqrestore(&kona_gpio->lock, flags);
342}
343
344static void bcm_kona_gpio_irq_mask(struct irq_data *d)
345{
346	struct bcm_kona_gpio *kona_gpio;
347	void __iomem *reg_base;
348	unsigned gpio = d->hwirq;
349	int bank_id = GPIO_BANK(gpio);
350	int bit = GPIO_BIT(gpio);
351	u32 val;
352	unsigned long flags;
353
354	kona_gpio = irq_data_get_irq_chip_data(d);
355	reg_base = kona_gpio->reg_base;
356	spin_lock_irqsave(&kona_gpio->lock, flags);
 
357
358	val = readl(reg_base + GPIO_INT_MASK(bank_id));
359	val |= BIT(bit);
360	writel(val, reg_base + GPIO_INT_MASK(bank_id));
 
361
362	spin_unlock_irqrestore(&kona_gpio->lock, flags);
363}
364
365static void bcm_kona_gpio_irq_unmask(struct irq_data *d)
366{
367	struct bcm_kona_gpio *kona_gpio;
368	void __iomem *reg_base;
369	unsigned gpio = d->hwirq;
370	int bank_id = GPIO_BANK(gpio);
371	int bit = GPIO_BIT(gpio);
372	u32 val;
373	unsigned long flags;
374
375	kona_gpio = irq_data_get_irq_chip_data(d);
376	reg_base = kona_gpio->reg_base;
377	spin_lock_irqsave(&kona_gpio->lock, flags);
 
378
379	val = readl(reg_base + GPIO_INT_MSKCLR(bank_id));
380	val |= BIT(bit);
381	writel(val, reg_base + GPIO_INT_MSKCLR(bank_id));
 
382
383	spin_unlock_irqrestore(&kona_gpio->lock, flags);
384}
385
386static int bcm_kona_gpio_irq_set_type(struct irq_data *d, unsigned int type)
387{
388	struct bcm_kona_gpio *kona_gpio;
389	void __iomem *reg_base;
390	unsigned gpio = d->hwirq;
391	u32 lvl_type;
392	u32 val;
393	unsigned long flags;
394
395	kona_gpio = irq_data_get_irq_chip_data(d);
396	reg_base = kona_gpio->reg_base;
397	switch (type & IRQ_TYPE_SENSE_MASK) {
398	case IRQ_TYPE_EDGE_RISING:
399		lvl_type = GPIO_GPCTR0_ITR_CMD_RISING_EDGE;
400		break;
401
402	case IRQ_TYPE_EDGE_FALLING:
403		lvl_type = GPIO_GPCTR0_ITR_CMD_FALLING_EDGE;
404		break;
405
406	case IRQ_TYPE_EDGE_BOTH:
407		lvl_type = GPIO_GPCTR0_ITR_CMD_BOTH_EDGE;
408		break;
409
410	case IRQ_TYPE_LEVEL_HIGH:
411	case IRQ_TYPE_LEVEL_LOW:
412		/* BCM GPIO doesn't support level triggering */
413	default:
414		dev_err(kona_gpio->gpio_chip.parent,
415			"Invalid BCM GPIO irq type 0x%x\n", type);
416		return -EINVAL;
417	}
418
419	spin_lock_irqsave(&kona_gpio->lock, flags);
420
421	val = readl(reg_base + GPIO_CONTROL(gpio));
422	val &= ~GPIO_GPCTR0_ITR_MASK;
423	val |= lvl_type << GPIO_GPCTR0_ITR_SHIFT;
424	writel(val, reg_base + GPIO_CONTROL(gpio));
425
426	spin_unlock_irqrestore(&kona_gpio->lock, flags);
427
428	return 0;
429}
430
431static void bcm_kona_gpio_irq_handler(struct irq_desc *desc)
432{
433	void __iomem *reg_base;
434	int bit, bank_id;
435	unsigned long sta;
436	struct bcm_kona_gpio_bank *bank = irq_desc_get_handler_data(desc);
437	struct irq_chip *chip = irq_desc_get_chip(desc);
438
439	chained_irq_enter(chip, desc);
440
441	/*
442	 * For bank interrupts, we can't use chip_data to store the kona_gpio
443	 * pointer, since GIC needs it for its own purposes. Therefore, we get
444	 * our pointer from the bank structure.
445	 */
446	reg_base = bank->kona_gpio->reg_base;
447	bank_id = bank->id;
448
449	while ((sta = readl(reg_base + GPIO_INT_STATUS(bank_id)) &
450		    (~(readl(reg_base + GPIO_INT_MASK(bank_id)))))) {
451		for_each_set_bit(bit, &sta, 32) {
452			int hwirq = GPIO_PER_BANK * bank_id + bit;
453			int child_irq =
454				irq_find_mapping(bank->kona_gpio->irq_domain,
455						 hwirq);
456			/*
457			 * Clear interrupt before handler is called so we don't
458			 * miss any interrupt occurred during executing them.
459			 */
460			writel(readl(reg_base + GPIO_INT_STATUS(bank_id)) |
461			       BIT(bit), reg_base + GPIO_INT_STATUS(bank_id));
462			/* Invoke interrupt handler */
463			generic_handle_irq(child_irq);
 
464		}
465	}
466
467	chained_irq_exit(chip, desc);
468}
469
470static int bcm_kona_gpio_irq_reqres(struct irq_data *d)
471{
472	struct bcm_kona_gpio *kona_gpio = irq_data_get_irq_chip_data(d);
 
473
474	if (gpiochip_lock_as_irq(&kona_gpio->gpio_chip, d->hwirq)) {
475		dev_err(kona_gpio->gpio_chip.parent,
476			"unable to lock HW IRQ %lu for IRQ\n",
477			d->hwirq);
478		return -EINVAL;
479	}
480	return 0;
481}
482
483static void bcm_kona_gpio_irq_relres(struct irq_data *d)
484{
485	struct bcm_kona_gpio *kona_gpio = irq_data_get_irq_chip_data(d);
 
 
 
 
486
487	gpiochip_unlock_as_irq(&kona_gpio->gpio_chip, d->hwirq);
488}
489
490static struct irq_chip bcm_gpio_irq_chip = {
491	.name = "bcm-kona-gpio",
492	.irq_ack = bcm_kona_gpio_irq_ack,
493	.irq_mask = bcm_kona_gpio_irq_mask,
494	.irq_unmask = bcm_kona_gpio_irq_unmask,
495	.irq_set_type = bcm_kona_gpio_irq_set_type,
496	.irq_request_resources = bcm_kona_gpio_irq_reqres,
497	.irq_release_resources = bcm_kona_gpio_irq_relres,
498};
499
500static struct of_device_id const bcm_kona_gpio_of_match[] = {
501	{ .compatible = "brcm,kona-gpio" },
502	{}
503};
504
505MODULE_DEVICE_TABLE(of, bcm_kona_gpio_of_match);
506
507/*
508 * This lock class tells lockdep that GPIO irqs are in a different
509 * category than their parents, so it won't report false recursion.
510 */
511static struct lock_class_key gpio_lock_class;
 
512
513static int bcm_kona_gpio_irq_map(struct irq_domain *d, unsigned int irq,
514				 irq_hw_number_t hwirq)
515{
516	int ret;
517
518	ret = irq_set_chip_data(irq, d->host_data);
519	if (ret < 0)
520		return ret;
521	irq_set_lockdep_class(irq, &gpio_lock_class);
522	irq_set_chip_and_handler(irq, &bcm_gpio_irq_chip, handle_simple_irq);
523	irq_set_noprobe(irq);
524
525	return 0;
526}
527
528static void bcm_kona_gpio_irq_unmap(struct irq_domain *d, unsigned int irq)
529{
530	irq_set_chip_and_handler(irq, NULL, NULL);
531	irq_set_chip_data(irq, NULL);
532}
533
534static const struct irq_domain_ops bcm_kona_irq_ops = {
535	.map = bcm_kona_gpio_irq_map,
536	.unmap = bcm_kona_gpio_irq_unmap,
537	.xlate = irq_domain_xlate_twocell,
538};
539
540static void bcm_kona_gpio_reset(struct bcm_kona_gpio *kona_gpio)
541{
542	void __iomem *reg_base;
543	int i;
544
545	reg_base = kona_gpio->reg_base;
546	/* disable interrupts and clear status */
547	for (i = 0; i < kona_gpio->num_bank; i++) {
548		/* Unlock the entire bank first */
549		bcm_kona_gpio_write_lock_regs(kona_gpio, i, UNLOCK_CODE);
550		writel(0xffffffff, reg_base + GPIO_INT_MASK(i));
551		writel(0xffffffff, reg_base + GPIO_INT_STATUS(i));
552		/* Now re-lock the bank */
553		bcm_kona_gpio_write_lock_regs(kona_gpio, i, LOCK_CODE);
554	}
555}
556
557static int bcm_kona_gpio_probe(struct platform_device *pdev)
558{
559	struct device *dev = &pdev->dev;
560	const struct of_device_id *match;
561	struct resource *res;
562	struct bcm_kona_gpio_bank *bank;
563	struct bcm_kona_gpio *kona_gpio;
564	struct gpio_chip *chip;
565	int ret;
566	int i;
567
568	match = of_match_device(bcm_kona_gpio_of_match, dev);
569	if (!match) {
570		dev_err(dev, "Failed to find gpio controller\n");
571		return -ENODEV;
572	}
573
574	kona_gpio = devm_kzalloc(dev, sizeof(*kona_gpio), GFP_KERNEL);
575	if (!kona_gpio)
576		return -ENOMEM;
577
578	kona_gpio->gpio_chip = template_chip;
579	chip = &kona_gpio->gpio_chip;
580	kona_gpio->num_bank = of_irq_count(dev->of_node);
581	if (kona_gpio->num_bank == 0) {
582		dev_err(dev, "Couldn't determine # GPIO banks\n");
583		return -ENOENT;
 
 
584	}
 
 
585	if (kona_gpio->num_bank > GPIO_MAX_BANK_NUM) {
586		dev_err(dev, "Too many GPIO banks configured (max=%d)\n",
587			GPIO_MAX_BANK_NUM);
588		return -ENXIO;
589	}
590	kona_gpio->banks = devm_kzalloc(dev,
591					kona_gpio->num_bank *
592					sizeof(*kona_gpio->banks), GFP_KERNEL);
 
593	if (!kona_gpio->banks)
594		return -ENOMEM;
595
596	kona_gpio->pdev = pdev;
597	platform_set_drvdata(pdev, kona_gpio);
598	chip->of_node = dev->of_node;
599	chip->ngpio = kona_gpio->num_bank * GPIO_PER_BANK;
600
601	kona_gpio->irq_domain = irq_domain_add_linear(dev->of_node,
602						      chip->ngpio,
603						      &bcm_kona_irq_ops,
604						      kona_gpio);
605	if (!kona_gpio->irq_domain) {
606		dev_err(dev, "Couldn't allocate IRQ domain\n");
607		return -ENXIO;
608	}
609
610	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
611	kona_gpio->reg_base = devm_ioremap_resource(dev, res);
612	if (IS_ERR(kona_gpio->reg_base)) {
613		ret = -ENXIO;
614		goto err_irq_domain;
615	}
616
617	for (i = 0; i < kona_gpio->num_bank; i++) {
618		bank = &kona_gpio->banks[i];
619		bank->id = i;
620		bank->irq = platform_get_irq(pdev, i);
621		bank->kona_gpio = kona_gpio;
622		if (bank->irq < 0) {
623			dev_err(dev, "Couldn't get IRQ for bank %d", i);
624			ret = -ENOENT;
625			goto err_irq_domain;
626		}
627	}
628
629	dev_info(&pdev->dev, "Setting up Kona GPIO\n");
630
631	bcm_kona_gpio_reset(kona_gpio);
632
633	ret = devm_gpiochip_add_data(dev, chip, kona_gpio);
634	if (ret < 0) {
635		dev_err(dev, "Couldn't add GPIO chip -- %d\n", ret);
636		goto err_irq_domain;
637	}
638	for (i = 0; i < kona_gpio->num_bank; i++) {
639		bank = &kona_gpio->banks[i];
640		irq_set_chained_handler_and_data(bank->irq,
641						 bcm_kona_gpio_irq_handler,
642						 bank);
643	}
644
645	spin_lock_init(&kona_gpio->lock);
646
647	return 0;
648
649err_irq_domain:
650	irq_domain_remove(kona_gpio->irq_domain);
651
652	return ret;
653}
654
655static struct platform_driver bcm_kona_gpio_driver = {
656	.driver = {
657			.name = "bcm-kona-gpio",
658			.of_match_table = bcm_kona_gpio_of_match,
659	},
660	.probe = bcm_kona_gpio_probe,
661};
662
663module_platform_driver(bcm_kona_gpio_driver);
664
665MODULE_AUTHOR("Broadcom Corporation <bcm-kernel-feedback-list@broadcom.com>");
666MODULE_DESCRIPTION("Broadcom Kona GPIO Driver");
667MODULE_LICENSE("GPL v2");