2 * This file is subject to the terms and conditions of the GNU General Public
3 * License. See the file "COPYING" in the main directory of this archive
6 * Copyright (C) 2016, 2017 Cavium Inc.
9 #include <linux/bitops.h>
10 #include <linux/gpio/driver.h>
11 #include <linux/interrupt.h>
13 #include <linux/irq.h>
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/pci.h>
17 #include <linux/spinlock.h>
20 #define GPIO_RX_DAT 0x0
21 #define GPIO_TX_SET 0x8
22 #define GPIO_TX_CLR 0x10
23 #define GPIO_CONST 0x90
24 #define GPIO_CONST_GPIOS_MASK 0xff
25 #define GPIO_BIT_CFG 0x400
26 #define GPIO_BIT_CFG_TX_OE BIT(0)
27 #define GPIO_BIT_CFG_PIN_XOR BIT(1)
28 #define GPIO_BIT_CFG_INT_EN BIT(2)
29 #define GPIO_BIT_CFG_INT_TYPE BIT(3)
30 #define GPIO_BIT_CFG_FIL_MASK GENMASK(11, 4)
31 #define GPIO_BIT_CFG_FIL_CNT_SHIFT 4
32 #define GPIO_BIT_CFG_FIL_SEL_SHIFT 8
33 #define GPIO_BIT_CFG_TX_OD BIT(12)
34 #define GPIO_BIT_CFG_PIN_SEL_MASK GENMASK(25, 16)
35 #define GPIO_INTR 0x800
36 #define GPIO_INTR_INTR BIT(0)
37 #define GPIO_INTR_INTR_W1S BIT(1)
38 #define GPIO_INTR_ENA_W1C BIT(2)
39 #define GPIO_INTR_ENA_W1S BIT(3)
40 #define GPIO_2ND_BANK 0x1400
42 #define GLITCH_FILTER_400NS ((4u << GPIO_BIT_CFG_FIL_SEL_SHIFT) | \
43 (9u << GPIO_BIT_CFG_FIL_CNT_SHIFT))
47 struct thunderx_line
{
48 struct thunderx_gpio
*txgpio
;
50 unsigned int fil_bits
;
53 struct thunderx_gpio
{
54 struct gpio_chip chip
;
55 u8 __iomem
*register_base
;
56 struct irq_domain
*irqd
;
57 struct msix_entry
*msix_entries
; /* per line MSI-X */
58 struct thunderx_line
*line_entries
; /* per line irq info */
60 unsigned long invert_mask
[2];
61 unsigned long od_mask
[2];
65 static unsigned int bit_cfg_reg(unsigned int line
)
67 return 8 * line
+ GPIO_BIT_CFG
;
70 static unsigned int intr_reg(unsigned int line
)
72 return 8 * line
+ GPIO_INTR
;
75 static bool thunderx_gpio_is_gpio_nowarn(struct thunderx_gpio
*txgpio
,
78 u64 bit_cfg
= readq(txgpio
->register_base
+ bit_cfg_reg(line
));
80 return (bit_cfg
& GPIO_BIT_CFG_PIN_SEL_MASK
) == 0;
84 * Check (and WARN) that the pin is available for GPIO. We will not
85 * allow modification of the state of non-GPIO pins from this driver.
87 static bool thunderx_gpio_is_gpio(struct thunderx_gpio
*txgpio
,
90 bool rv
= thunderx_gpio_is_gpio_nowarn(txgpio
, line
);
92 WARN_RATELIMIT(!rv
, "Pin %d not available for GPIO\n", line
);
97 static int thunderx_gpio_request(struct gpio_chip
*chip
, unsigned int line
)
99 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
101 return thunderx_gpio_is_gpio(txgpio
, line
) ? 0 : -EIO
;
104 static int thunderx_gpio_dir_in(struct gpio_chip
*chip
, unsigned int line
)
106 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
108 if (!thunderx_gpio_is_gpio(txgpio
, line
))
111 raw_spin_lock(&txgpio
->lock
);
112 clear_bit(line
, txgpio
->invert_mask
);
113 clear_bit(line
, txgpio
->od_mask
);
114 writeq(txgpio
->line_entries
[line
].fil_bits
,
115 txgpio
->register_base
+ bit_cfg_reg(line
));
116 raw_spin_unlock(&txgpio
->lock
);
120 static void thunderx_gpio_set(struct gpio_chip
*chip
, unsigned int line
,
123 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
124 int bank
= line
/ 64;
125 int bank_bit
= line
% 64;
127 void __iomem
*reg
= txgpio
->register_base
+
128 (bank
* GPIO_2ND_BANK
) + (value
? GPIO_TX_SET
: GPIO_TX_CLR
);
130 writeq(BIT_ULL(bank_bit
), reg
);
133 static int thunderx_gpio_dir_out(struct gpio_chip
*chip
, unsigned int line
,
136 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
137 u64 bit_cfg
= txgpio
->line_entries
[line
].fil_bits
| GPIO_BIT_CFG_TX_OE
;
139 if (!thunderx_gpio_is_gpio(txgpio
, line
))
142 raw_spin_lock(&txgpio
->lock
);
144 thunderx_gpio_set(chip
, line
, value
);
146 if (test_bit(line
, txgpio
->invert_mask
))
147 bit_cfg
|= GPIO_BIT_CFG_PIN_XOR
;
149 if (test_bit(line
, txgpio
->od_mask
))
150 bit_cfg
|= GPIO_BIT_CFG_TX_OD
;
152 writeq(bit_cfg
, txgpio
->register_base
+ bit_cfg_reg(line
));
154 raw_spin_unlock(&txgpio
->lock
);
158 static int thunderx_gpio_get_direction(struct gpio_chip
*chip
, unsigned int line
)
160 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
163 if (!thunderx_gpio_is_gpio_nowarn(txgpio
, line
))
165 * Say it is input for now to avoid WARNing on
166 * gpiochip_add_data(). We will WARN if someone
167 * requests it or tries to use it.
171 bit_cfg
= readq(txgpio
->register_base
+ bit_cfg_reg(line
));
173 return !(bit_cfg
& GPIO_BIT_CFG_TX_OE
);
176 static int thunderx_gpio_set_config(struct gpio_chip
*chip
,
180 bool orig_invert
, orig_od
, orig_dat
, new_invert
, new_od
;
183 int bank
= line
/ 64;
184 int bank_bit
= line
% 64;
186 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
187 void __iomem
*reg
= txgpio
->register_base
+ (bank
* GPIO_2ND_BANK
) + GPIO_TX_SET
;
189 if (!thunderx_gpio_is_gpio(txgpio
, line
))
192 raw_spin_lock(&txgpio
->lock
);
193 orig_invert
= test_bit(line
, txgpio
->invert_mask
);
194 new_invert
= orig_invert
;
195 orig_od
= test_bit(line
, txgpio
->od_mask
);
197 orig_dat
= ((readq(reg
) >> bank_bit
) & 1) ^ orig_invert
;
198 bit_cfg
= readq(txgpio
->register_base
+ bit_cfg_reg(line
));
199 switch (pinconf_to_config_param(cfg
)) {
200 case PIN_CONFIG_DRIVE_OPEN_DRAIN
:
202 * Weird, setting open-drain mode causes signal
203 * inversion. Note this so we can compensate in the
206 set_bit(line
, txgpio
->invert_mask
);
208 set_bit(line
, txgpio
->od_mask
);
212 case PIN_CONFIG_DRIVE_PUSH_PULL
:
213 clear_bit(line
, txgpio
->invert_mask
);
215 clear_bit(line
, txgpio
->od_mask
);
219 case PIN_CONFIG_INPUT_DEBOUNCE
:
220 arg
= pinconf_to_config_argument(cfg
);
221 if (arg
> 1228) { /* 15 * 2^15 * 2.5nS maximum */
225 arg
*= 400; /* scale to 2.5nS clocks. */
229 arg
++; /* always round up */
232 txgpio
->line_entries
[line
].fil_bits
=
233 (sel
<< GPIO_BIT_CFG_FIL_SEL_SHIFT
) |
234 (arg
<< GPIO_BIT_CFG_FIL_CNT_SHIFT
);
235 bit_cfg
&= ~GPIO_BIT_CFG_FIL_MASK
;
236 bit_cfg
|= txgpio
->line_entries
[line
].fil_bits
;
237 writeq(bit_cfg
, txgpio
->register_base
+ bit_cfg_reg(line
));
243 raw_spin_unlock(&txgpio
->lock
);
246 * If currently output and OPEN_DRAIN changed, install the new
249 if ((new_invert
!= orig_invert
|| new_od
!= orig_od
) &&
250 (bit_cfg
& GPIO_BIT_CFG_TX_OE
))
251 ret
= thunderx_gpio_dir_out(chip
, line
, orig_dat
^ new_invert
);
256 static int thunderx_gpio_get(struct gpio_chip
*chip
, unsigned int line
)
258 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
259 int bank
= line
/ 64;
260 int bank_bit
= line
% 64;
261 u64 read_bits
= readq(txgpio
->register_base
+ (bank
* GPIO_2ND_BANK
) + GPIO_RX_DAT
);
262 u64 masked_bits
= read_bits
& BIT_ULL(bank_bit
);
264 if (test_bit(line
, txgpio
->invert_mask
))
265 return masked_bits
== 0;
267 return masked_bits
!= 0;
270 static void thunderx_gpio_set_multiple(struct gpio_chip
*chip
,
275 u64 set_bits
, clear_bits
;
276 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
278 for (bank
= 0; bank
<= chip
->ngpio
/ 64; bank
++) {
279 set_bits
= bits
[bank
] & mask
[bank
];
280 clear_bits
= ~bits
[bank
] & mask
[bank
];
281 writeq(set_bits
, txgpio
->register_base
+ (bank
* GPIO_2ND_BANK
) + GPIO_TX_SET
);
282 writeq(clear_bits
, txgpio
->register_base
+ (bank
* GPIO_2ND_BANK
) + GPIO_TX_CLR
);
286 static void thunderx_gpio_irq_ack(struct irq_data
*data
)
288 struct thunderx_line
*txline
= irq_data_get_irq_chip_data(data
);
290 writeq(GPIO_INTR_INTR
,
291 txline
->txgpio
->register_base
+ intr_reg(txline
->line
));
294 static void thunderx_gpio_irq_mask(struct irq_data
*data
)
296 struct thunderx_line
*txline
= irq_data_get_irq_chip_data(data
);
298 writeq(GPIO_INTR_ENA_W1C
,
299 txline
->txgpio
->register_base
+ intr_reg(txline
->line
));
302 static void thunderx_gpio_irq_mask_ack(struct irq_data
*data
)
304 struct thunderx_line
*txline
= irq_data_get_irq_chip_data(data
);
306 writeq(GPIO_INTR_ENA_W1C
| GPIO_INTR_INTR
,
307 txline
->txgpio
->register_base
+ intr_reg(txline
->line
));
310 static void thunderx_gpio_irq_unmask(struct irq_data
*data
)
312 struct thunderx_line
*txline
= irq_data_get_irq_chip_data(data
);
314 writeq(GPIO_INTR_ENA_W1S
,
315 txline
->txgpio
->register_base
+ intr_reg(txline
->line
));
318 static int thunderx_gpio_irq_set_type(struct irq_data
*data
,
319 unsigned int flow_type
)
321 struct thunderx_line
*txline
= irq_data_get_irq_chip_data(data
);
322 struct thunderx_gpio
*txgpio
= txline
->txgpio
;
325 irqd_set_trigger_type(data
, flow_type
);
327 bit_cfg
= txline
->fil_bits
| GPIO_BIT_CFG_INT_EN
;
329 if (flow_type
& IRQ_TYPE_EDGE_BOTH
) {
330 irq_set_handler_locked(data
, handle_fasteoi_ack_irq
);
331 bit_cfg
|= GPIO_BIT_CFG_INT_TYPE
;
333 irq_set_handler_locked(data
, handle_fasteoi_mask_irq
);
336 raw_spin_lock(&txgpio
->lock
);
337 if (flow_type
& (IRQ_TYPE_EDGE_FALLING
| IRQ_TYPE_LEVEL_LOW
)) {
338 bit_cfg
|= GPIO_BIT_CFG_PIN_XOR
;
339 set_bit(txline
->line
, txgpio
->invert_mask
);
341 clear_bit(txline
->line
, txgpio
->invert_mask
);
343 clear_bit(txline
->line
, txgpio
->od_mask
);
344 writeq(bit_cfg
, txgpio
->register_base
+ bit_cfg_reg(txline
->line
));
345 raw_spin_unlock(&txgpio
->lock
);
347 return IRQ_SET_MASK_OK
;
350 static void thunderx_gpio_irq_enable(struct irq_data
*data
)
352 irq_chip_enable_parent(data
);
353 thunderx_gpio_irq_unmask(data
);
356 static void thunderx_gpio_irq_disable(struct irq_data
*data
)
358 thunderx_gpio_irq_mask(data
);
359 irq_chip_disable_parent(data
);
362 static int thunderx_gpio_irq_request_resources(struct irq_data
*data
)
364 struct thunderx_line
*txline
= irq_data_get_irq_chip_data(data
);
365 struct thunderx_gpio
*txgpio
= txline
->txgpio
;
366 struct irq_data
*parent_data
= data
->parent_data
;
369 r
= gpiochip_lock_as_irq(&txgpio
->chip
, txline
->line
);
373 if (parent_data
&& parent_data
->chip
->irq_request_resources
) {
374 r
= parent_data
->chip
->irq_request_resources(parent_data
);
381 gpiochip_unlock_as_irq(&txgpio
->chip
, txline
->line
);
385 static void thunderx_gpio_irq_release_resources(struct irq_data
*data
)
387 struct thunderx_line
*txline
= irq_data_get_irq_chip_data(data
);
388 struct thunderx_gpio
*txgpio
= txline
->txgpio
;
389 struct irq_data
*parent_data
= data
->parent_data
;
391 if (parent_data
&& parent_data
->chip
->irq_release_resources
)
392 parent_data
->chip
->irq_release_resources(parent_data
);
394 gpiochip_unlock_as_irq(&txgpio
->chip
, txline
->line
);
398 * Interrupts are chained from underlying MSI-X vectors. We have
399 * these irq_chip functions to be able to handle level triggering
400 * semantics and other acknowledgment tasks associated with the GPIO
403 static struct irq_chip thunderx_gpio_irq_chip
= {
405 .irq_enable
= thunderx_gpio_irq_enable
,
406 .irq_disable
= thunderx_gpio_irq_disable
,
407 .irq_ack
= thunderx_gpio_irq_ack
,
408 .irq_mask
= thunderx_gpio_irq_mask
,
409 .irq_mask_ack
= thunderx_gpio_irq_mask_ack
,
410 .irq_unmask
= thunderx_gpio_irq_unmask
,
411 .irq_eoi
= irq_chip_eoi_parent
,
412 .irq_set_affinity
= irq_chip_set_affinity_parent
,
413 .irq_request_resources
= thunderx_gpio_irq_request_resources
,
414 .irq_release_resources
= thunderx_gpio_irq_release_resources
,
415 .irq_set_type
= thunderx_gpio_irq_set_type
,
417 .flags
= IRQCHIP_SET_TYPE_MASKED
420 static int thunderx_gpio_irq_translate(struct irq_domain
*d
,
421 struct irq_fwspec
*fwspec
,
422 irq_hw_number_t
*hwirq
,
425 struct thunderx_gpio
*txgpio
= d
->host_data
;
427 if (WARN_ON(fwspec
->param_count
< 2))
429 if (fwspec
->param
[0] >= txgpio
->chip
.ngpio
)
431 *hwirq
= fwspec
->param
[0];
432 *type
= fwspec
->param
[1] & IRQ_TYPE_SENSE_MASK
;
436 static int thunderx_gpio_irq_alloc(struct irq_domain
*d
, unsigned int virq
,
437 unsigned int nr_irqs
, void *arg
)
439 struct thunderx_line
*txline
= arg
;
441 return irq_domain_set_hwirq_and_chip(d
, virq
, txline
->line
,
442 &thunderx_gpio_irq_chip
, txline
);
445 static const struct irq_domain_ops thunderx_gpio_irqd_ops
= {
446 .alloc
= thunderx_gpio_irq_alloc
,
447 .translate
= thunderx_gpio_irq_translate
450 static int thunderx_gpio_to_irq(struct gpio_chip
*chip
, unsigned int offset
)
452 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
454 return irq_find_mapping(txgpio
->irqd
, offset
);
457 static int thunderx_gpio_probe(struct pci_dev
*pdev
,
458 const struct pci_device_id
*id
)
460 void __iomem
* const *tbl
;
461 struct device
*dev
= &pdev
->dev
;
462 struct thunderx_gpio
*txgpio
;
463 struct gpio_chip
*chip
;
467 txgpio
= devm_kzalloc(dev
, sizeof(*txgpio
), GFP_KERNEL
);
471 raw_spin_lock_init(&txgpio
->lock
);
472 chip
= &txgpio
->chip
;
474 pci_set_drvdata(pdev
, txgpio
);
476 err
= pcim_enable_device(pdev
);
478 dev_err(dev
, "Failed to enable PCI device: err %d\n", err
);
482 err
= pcim_iomap_regions(pdev
, 1 << 0, KBUILD_MODNAME
);
484 dev_err(dev
, "Failed to iomap PCI device: err %d\n", err
);
488 tbl
= pcim_iomap_table(pdev
);
489 txgpio
->register_base
= tbl
[0];
490 if (!txgpio
->register_base
) {
491 dev_err(dev
, "Cannot map PCI resource\n");
496 if (pdev
->subsystem_device
== 0xa10a) {
497 /* CN88XX has no GPIO_CONST register*/
499 txgpio
->base_msi
= 48;
501 u64 c
= readq(txgpio
->register_base
+ GPIO_CONST
);
503 ngpio
= c
& GPIO_CONST_GPIOS_MASK
;
504 txgpio
->base_msi
= (c
>> 8) & 0xff;
507 txgpio
->msix_entries
= devm_kcalloc(dev
,
508 ngpio
, sizeof(struct msix_entry
),
510 if (!txgpio
->msix_entries
) {
515 txgpio
->line_entries
= devm_kcalloc(dev
,
517 sizeof(struct thunderx_line
),
519 if (!txgpio
->line_entries
) {
524 for (i
= 0; i
< ngpio
; i
++) {
525 u64 bit_cfg
= readq(txgpio
->register_base
+ bit_cfg_reg(i
));
527 txgpio
->msix_entries
[i
].entry
= txgpio
->base_msi
+ (2 * i
);
528 txgpio
->line_entries
[i
].line
= i
;
529 txgpio
->line_entries
[i
].txgpio
= txgpio
;
531 * If something has already programmed the pin, use
532 * the existing glitch filter settings, otherwise go
535 txgpio
->line_entries
[i
].fil_bits
= bit_cfg
?
536 (bit_cfg
& GPIO_BIT_CFG_FIL_MASK
) : GLITCH_FILTER_400NS
;
538 if ((bit_cfg
& GPIO_BIT_CFG_TX_OE
) && (bit_cfg
& GPIO_BIT_CFG_TX_OD
))
539 set_bit(i
, txgpio
->od_mask
);
540 if (bit_cfg
& GPIO_BIT_CFG_PIN_XOR
)
541 set_bit(i
, txgpio
->invert_mask
);
545 /* Enable all MSI-X for interrupts on all possible lines. */
546 err
= pci_enable_msix_range(pdev
, txgpio
->msix_entries
, ngpio
, ngpio
);
551 * Push GPIO specific irqdomain on hierarchy created as a side
552 * effect of the pci_enable_msix()
554 txgpio
->irqd
= irq_domain_create_hierarchy(irq_get_irq_data(txgpio
->msix_entries
[0].vector
)->domain
,
555 0, 0, of_node_to_fwnode(dev
->of_node
),
556 &thunderx_gpio_irqd_ops
, txgpio
);
562 /* Push on irq_data and the domain for each line. */
563 for (i
= 0; i
< ngpio
; i
++) {
564 err
= irq_domain_push_irq(txgpio
->irqd
,
565 txgpio
->msix_entries
[i
].vector
,
566 &txgpio
->line_entries
[i
]);
568 dev_err(dev
, "irq_domain_push_irq: %d\n", err
);
571 chip
->label
= KBUILD_MODNAME
;
573 chip
->owner
= THIS_MODULE
;
574 chip
->request
= thunderx_gpio_request
;
575 chip
->base
= -1; /* System allocated */
576 chip
->can_sleep
= false;
578 chip
->get_direction
= thunderx_gpio_get_direction
;
579 chip
->direction_input
= thunderx_gpio_dir_in
;
580 chip
->get
= thunderx_gpio_get
;
581 chip
->direction_output
= thunderx_gpio_dir_out
;
582 chip
->set
= thunderx_gpio_set
;
583 chip
->set_multiple
= thunderx_gpio_set_multiple
;
584 chip
->set_config
= thunderx_gpio_set_config
;
585 chip
->to_irq
= thunderx_gpio_to_irq
;
586 err
= devm_gpiochip_add_data(dev
, chip
, txgpio
);
590 dev_info(dev
, "ThunderX GPIO: %d lines with base %d.\n",
594 pci_set_drvdata(pdev
, NULL
);
598 static void thunderx_gpio_remove(struct pci_dev
*pdev
)
601 struct thunderx_gpio
*txgpio
= pci_get_drvdata(pdev
);
603 for (i
= 0; i
< txgpio
->chip
.ngpio
; i
++)
604 irq_domain_pop_irq(txgpio
->irqd
,
605 txgpio
->msix_entries
[i
].vector
);
607 irq_domain_remove(txgpio
->irqd
);
609 pci_set_drvdata(pdev
, NULL
);
612 static const struct pci_device_id thunderx_gpio_id_table
[] = {
613 { PCI_DEVICE(PCI_VENDOR_ID_CAVIUM
, 0xA00A) },
614 { 0, } /* end of table */
617 MODULE_DEVICE_TABLE(pci
, thunderx_gpio_id_table
);
619 static struct pci_driver thunderx_gpio_driver
= {
620 .name
= KBUILD_MODNAME
,
621 .id_table
= thunderx_gpio_id_table
,
622 .probe
= thunderx_gpio_probe
,
623 .remove
= thunderx_gpio_remove
,
626 module_pci_driver(thunderx_gpio_driver
);
628 MODULE_DESCRIPTION("Cavium Inc. ThunderX/OCTEON-TX GPIO Driver");
629 MODULE_LICENSE("GPL");