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/property.h>
18 #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 msix_entry
*msix_entries
; /* per line MSI-X */
57 struct thunderx_line
*line_entries
; /* per line irq info */
59 unsigned long invert_mask
[2];
60 unsigned long od_mask
[2];
64 static unsigned int bit_cfg_reg(unsigned int line
)
66 return 8 * line
+ GPIO_BIT_CFG
;
69 static unsigned int intr_reg(unsigned int line
)
71 return 8 * line
+ GPIO_INTR
;
74 static bool thunderx_gpio_is_gpio_nowarn(struct thunderx_gpio
*txgpio
,
77 u64 bit_cfg
= readq(txgpio
->register_base
+ bit_cfg_reg(line
));
79 return (bit_cfg
& GPIO_BIT_CFG_PIN_SEL_MASK
) == 0;
83 * Check (and WARN) that the pin is available for GPIO. We will not
84 * allow modification of the state of non-GPIO pins from this driver.
86 static bool thunderx_gpio_is_gpio(struct thunderx_gpio
*txgpio
,
89 bool rv
= thunderx_gpio_is_gpio_nowarn(txgpio
, line
);
91 WARN_RATELIMIT(!rv
, "Pin %d not available for GPIO\n", line
);
96 static int thunderx_gpio_request(struct gpio_chip
*chip
, unsigned int line
)
98 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
100 return thunderx_gpio_is_gpio(txgpio
, line
) ? 0 : -EIO
;
103 static int thunderx_gpio_dir_in(struct gpio_chip
*chip
, unsigned int line
)
105 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
107 if (!thunderx_gpio_is_gpio(txgpio
, line
))
110 raw_spin_lock(&txgpio
->lock
);
111 clear_bit(line
, txgpio
->invert_mask
);
112 clear_bit(line
, txgpio
->od_mask
);
113 writeq(txgpio
->line_entries
[line
].fil_bits
,
114 txgpio
->register_base
+ bit_cfg_reg(line
));
115 raw_spin_unlock(&txgpio
->lock
);
119 static void thunderx_gpio_set(struct gpio_chip
*chip
, unsigned int line
,
122 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
123 int bank
= line
/ 64;
124 int bank_bit
= line
% 64;
126 void __iomem
*reg
= txgpio
->register_base
+
127 (bank
* GPIO_2ND_BANK
) + (value
? GPIO_TX_SET
: GPIO_TX_CLR
);
129 writeq(BIT_ULL(bank_bit
), reg
);
132 static int thunderx_gpio_dir_out(struct gpio_chip
*chip
, unsigned int line
,
135 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
136 u64 bit_cfg
= txgpio
->line_entries
[line
].fil_bits
| GPIO_BIT_CFG_TX_OE
;
138 if (!thunderx_gpio_is_gpio(txgpio
, line
))
141 raw_spin_lock(&txgpio
->lock
);
143 thunderx_gpio_set(chip
, line
, value
);
145 if (test_bit(line
, txgpio
->invert_mask
))
146 bit_cfg
|= GPIO_BIT_CFG_PIN_XOR
;
148 if (test_bit(line
, txgpio
->od_mask
))
149 bit_cfg
|= GPIO_BIT_CFG_TX_OD
;
151 writeq(bit_cfg
, txgpio
->register_base
+ bit_cfg_reg(line
));
153 raw_spin_unlock(&txgpio
->lock
);
157 static int thunderx_gpio_get_direction(struct gpio_chip
*chip
, unsigned int line
)
159 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
162 if (!thunderx_gpio_is_gpio_nowarn(txgpio
, line
))
164 * Say it is input for now to avoid WARNing on
165 * gpiochip_add_data(). We will WARN if someone
166 * requests it or tries to use it.
170 bit_cfg
= readq(txgpio
->register_base
+ bit_cfg_reg(line
));
172 if (bit_cfg
& GPIO_BIT_CFG_TX_OE
)
173 return GPIO_LINE_DIRECTION_OUT
;
175 return GPIO_LINE_DIRECTION_IN
;
178 static int thunderx_gpio_set_config(struct gpio_chip
*chip
,
182 bool orig_invert
, orig_od
, orig_dat
, new_invert
, new_od
;
185 int bank
= line
/ 64;
186 int bank_bit
= line
% 64;
188 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
189 void __iomem
*reg
= txgpio
->register_base
+ (bank
* GPIO_2ND_BANK
) + GPIO_TX_SET
;
191 if (!thunderx_gpio_is_gpio(txgpio
, line
))
194 raw_spin_lock(&txgpio
->lock
);
195 orig_invert
= test_bit(line
, txgpio
->invert_mask
);
196 new_invert
= orig_invert
;
197 orig_od
= test_bit(line
, txgpio
->od_mask
);
199 orig_dat
= ((readq(reg
) >> bank_bit
) & 1) ^ orig_invert
;
200 bit_cfg
= readq(txgpio
->register_base
+ bit_cfg_reg(line
));
201 switch (pinconf_to_config_param(cfg
)) {
202 case PIN_CONFIG_DRIVE_OPEN_DRAIN
:
204 * Weird, setting open-drain mode causes signal
205 * inversion. Note this so we can compensate in the
208 set_bit(line
, txgpio
->invert_mask
);
210 set_bit(line
, txgpio
->od_mask
);
214 case PIN_CONFIG_DRIVE_PUSH_PULL
:
215 clear_bit(line
, txgpio
->invert_mask
);
217 clear_bit(line
, txgpio
->od_mask
);
221 case PIN_CONFIG_INPUT_DEBOUNCE
:
222 arg
= pinconf_to_config_argument(cfg
);
223 if (arg
> 1228) { /* 15 * 2^15 * 2.5nS maximum */
227 arg
*= 400; /* scale to 2.5nS clocks. */
231 arg
++; /* always round up */
234 txgpio
->line_entries
[line
].fil_bits
=
235 (sel
<< GPIO_BIT_CFG_FIL_SEL_SHIFT
) |
236 (arg
<< GPIO_BIT_CFG_FIL_CNT_SHIFT
);
237 bit_cfg
&= ~GPIO_BIT_CFG_FIL_MASK
;
238 bit_cfg
|= txgpio
->line_entries
[line
].fil_bits
;
239 writeq(bit_cfg
, txgpio
->register_base
+ bit_cfg_reg(line
));
245 raw_spin_unlock(&txgpio
->lock
);
248 * If currently output and OPEN_DRAIN changed, install the new
251 if ((new_invert
!= orig_invert
|| new_od
!= orig_od
) &&
252 (bit_cfg
& GPIO_BIT_CFG_TX_OE
))
253 ret
= thunderx_gpio_dir_out(chip
, line
, orig_dat
^ new_invert
);
258 static int thunderx_gpio_get(struct gpio_chip
*chip
, unsigned int line
)
260 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
261 int bank
= line
/ 64;
262 int bank_bit
= line
% 64;
263 u64 read_bits
= readq(txgpio
->register_base
+ (bank
* GPIO_2ND_BANK
) + GPIO_RX_DAT
);
264 u64 masked_bits
= read_bits
& BIT_ULL(bank_bit
);
266 if (test_bit(line
, txgpio
->invert_mask
))
267 return masked_bits
== 0;
269 return masked_bits
!= 0;
272 static void thunderx_gpio_set_multiple(struct gpio_chip
*chip
,
277 u64 set_bits
, clear_bits
;
278 struct thunderx_gpio
*txgpio
= gpiochip_get_data(chip
);
280 for (bank
= 0; bank
<= chip
->ngpio
/ 64; bank
++) {
281 set_bits
= bits
[bank
] & mask
[bank
];
282 clear_bits
= ~bits
[bank
] & mask
[bank
];
283 writeq(set_bits
, txgpio
->register_base
+ (bank
* GPIO_2ND_BANK
) + GPIO_TX_SET
);
284 writeq(clear_bits
, txgpio
->register_base
+ (bank
* GPIO_2ND_BANK
) + GPIO_TX_CLR
);
288 static void thunderx_gpio_irq_ack(struct irq_data
*d
)
290 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
291 struct thunderx_gpio
*txgpio
= gpiochip_get_data(gc
);
293 writeq(GPIO_INTR_INTR
,
294 txgpio
->register_base
+ intr_reg(irqd_to_hwirq(d
)));
297 static void thunderx_gpio_irq_mask(struct irq_data
*d
)
299 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
300 struct thunderx_gpio
*txgpio
= gpiochip_get_data(gc
);
302 writeq(GPIO_INTR_ENA_W1C
,
303 txgpio
->register_base
+ intr_reg(irqd_to_hwirq(d
)));
306 static void thunderx_gpio_irq_mask_ack(struct irq_data
*d
)
308 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
309 struct thunderx_gpio
*txgpio
= gpiochip_get_data(gc
);
311 writeq(GPIO_INTR_ENA_W1C
| GPIO_INTR_INTR
,
312 txgpio
->register_base
+ intr_reg(irqd_to_hwirq(d
)));
315 static void thunderx_gpio_irq_unmask(struct irq_data
*d
)
317 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
318 struct thunderx_gpio
*txgpio
= gpiochip_get_data(gc
);
320 writeq(GPIO_INTR_ENA_W1S
,
321 txgpio
->register_base
+ intr_reg(irqd_to_hwirq(d
)));
324 static int thunderx_gpio_irq_set_type(struct irq_data
*d
,
325 unsigned int flow_type
)
327 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
328 struct thunderx_gpio
*txgpio
= gpiochip_get_data(gc
);
329 struct thunderx_line
*txline
=
330 &txgpio
->line_entries
[irqd_to_hwirq(d
)];
333 irqd_set_trigger_type(d
, flow_type
);
335 bit_cfg
= txline
->fil_bits
| GPIO_BIT_CFG_INT_EN
;
337 if (flow_type
& IRQ_TYPE_EDGE_BOTH
) {
338 irq_set_handler_locked(d
, handle_fasteoi_ack_irq
);
339 bit_cfg
|= GPIO_BIT_CFG_INT_TYPE
;
341 irq_set_handler_locked(d
, handle_fasteoi_mask_irq
);
344 raw_spin_lock(&txgpio
->lock
);
345 if (flow_type
& (IRQ_TYPE_EDGE_FALLING
| IRQ_TYPE_LEVEL_LOW
)) {
346 bit_cfg
|= GPIO_BIT_CFG_PIN_XOR
;
347 set_bit(txline
->line
, txgpio
->invert_mask
);
349 clear_bit(txline
->line
, txgpio
->invert_mask
);
351 clear_bit(txline
->line
, txgpio
->od_mask
);
352 writeq(bit_cfg
, txgpio
->register_base
+ bit_cfg_reg(txline
->line
));
353 raw_spin_unlock(&txgpio
->lock
);
355 return IRQ_SET_MASK_OK
;
358 static void thunderx_gpio_irq_enable(struct irq_data
*d
)
360 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
362 gpiochip_enable_irq(gc
, irqd_to_hwirq(d
));
363 irq_chip_enable_parent(d
);
364 thunderx_gpio_irq_unmask(d
);
367 static void thunderx_gpio_irq_disable(struct irq_data
*d
)
369 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
371 thunderx_gpio_irq_mask(d
);
372 irq_chip_disable_parent(d
);
373 gpiochip_disable_irq(gc
, irqd_to_hwirq(d
));
377 * Interrupts are chained from underlying MSI-X vectors. We have
378 * these irq_chip functions to be able to handle level triggering
379 * semantics and other acknowledgment tasks associated with the GPIO
382 static const struct irq_chip thunderx_gpio_irq_chip
= {
384 .irq_enable
= thunderx_gpio_irq_enable
,
385 .irq_disable
= thunderx_gpio_irq_disable
,
386 .irq_ack
= thunderx_gpio_irq_ack
,
387 .irq_mask
= thunderx_gpio_irq_mask
,
388 .irq_mask_ack
= thunderx_gpio_irq_mask_ack
,
389 .irq_unmask
= thunderx_gpio_irq_unmask
,
390 .irq_eoi
= irq_chip_eoi_parent
,
391 .irq_set_affinity
= irq_chip_set_affinity_parent
,
392 .irq_set_type
= thunderx_gpio_irq_set_type
,
393 .flags
= IRQCHIP_SET_TYPE_MASKED
| IRQCHIP_IMMUTABLE
,
394 GPIOCHIP_IRQ_RESOURCE_HELPERS
,
397 static int thunderx_gpio_child_to_parent_hwirq(struct gpio_chip
*gc
,
399 unsigned int child_type
,
400 unsigned int *parent
,
401 unsigned int *parent_type
)
403 struct thunderx_gpio
*txgpio
= gpiochip_get_data(gc
);
404 struct irq_data
*irqd
;
407 irq
= txgpio
->msix_entries
[child
].vector
;
408 irqd
= irq_domain_get_irq_data(gc
->irq
.parent_domain
, irq
);
411 *parent
= irqd_to_hwirq(irqd
);
412 *parent_type
= IRQ_TYPE_LEVEL_HIGH
;
416 static int thunderx_gpio_populate_parent_alloc_info(struct gpio_chip
*chip
,
417 union gpio_irq_fwspec
*gfwspec
,
418 unsigned int parent_hwirq
,
419 unsigned int parent_type
)
421 msi_alloc_info_t
*info
= &gfwspec
->msiinfo
;
423 info
->hwirq
= parent_hwirq
;
427 static int thunderx_gpio_probe(struct pci_dev
*pdev
,
428 const struct pci_device_id
*id
)
430 void __iomem
* const *tbl
;
431 struct device
*dev
= &pdev
->dev
;
432 struct thunderx_gpio
*txgpio
;
433 struct gpio_chip
*chip
;
434 struct gpio_irq_chip
*girq
;
438 txgpio
= devm_kzalloc(dev
, sizeof(*txgpio
), GFP_KERNEL
);
442 raw_spin_lock_init(&txgpio
->lock
);
443 chip
= &txgpio
->chip
;
445 pci_set_drvdata(pdev
, txgpio
);
447 err
= pcim_enable_device(pdev
);
449 dev_err(dev
, "Failed to enable PCI device: err %d\n", err
);
453 err
= pcim_iomap_regions(pdev
, 1 << 0, KBUILD_MODNAME
);
455 dev_err(dev
, "Failed to iomap PCI device: err %d\n", err
);
459 tbl
= pcim_iomap_table(pdev
);
460 txgpio
->register_base
= tbl
[0];
461 if (!txgpio
->register_base
) {
462 dev_err(dev
, "Cannot map PCI resource\n");
467 if (pdev
->subsystem_device
== 0xa10a) {
468 /* CN88XX has no GPIO_CONST register*/
470 txgpio
->base_msi
= 48;
472 u64 c
= readq(txgpio
->register_base
+ GPIO_CONST
);
474 ngpio
= c
& GPIO_CONST_GPIOS_MASK
;
475 txgpio
->base_msi
= (c
>> 8) & 0xff;
478 txgpio
->msix_entries
= devm_kcalloc(dev
,
479 ngpio
, sizeof(struct msix_entry
),
481 if (!txgpio
->msix_entries
) {
486 txgpio
->line_entries
= devm_kcalloc(dev
,
488 sizeof(struct thunderx_line
),
490 if (!txgpio
->line_entries
) {
495 for (i
= 0; i
< ngpio
; i
++) {
496 u64 bit_cfg
= readq(txgpio
->register_base
+ bit_cfg_reg(i
));
498 txgpio
->msix_entries
[i
].entry
= txgpio
->base_msi
+ (2 * i
);
499 txgpio
->line_entries
[i
].line
= i
;
500 txgpio
->line_entries
[i
].txgpio
= txgpio
;
502 * If something has already programmed the pin, use
503 * the existing glitch filter settings, otherwise go
506 txgpio
->line_entries
[i
].fil_bits
= bit_cfg
?
507 (bit_cfg
& GPIO_BIT_CFG_FIL_MASK
) : GLITCH_FILTER_400NS
;
509 if ((bit_cfg
& GPIO_BIT_CFG_TX_OE
) && (bit_cfg
& GPIO_BIT_CFG_TX_OD
))
510 set_bit(i
, txgpio
->od_mask
);
511 if (bit_cfg
& GPIO_BIT_CFG_PIN_XOR
)
512 set_bit(i
, txgpio
->invert_mask
);
516 /* Enable all MSI-X for interrupts on all possible lines. */
517 err
= pci_enable_msix_range(pdev
, txgpio
->msix_entries
, ngpio
, ngpio
);
521 chip
->label
= KBUILD_MODNAME
;
523 chip
->owner
= THIS_MODULE
;
524 chip
->request
= thunderx_gpio_request
;
525 chip
->base
= -1; /* System allocated */
526 chip
->can_sleep
= false;
528 chip
->get_direction
= thunderx_gpio_get_direction
;
529 chip
->direction_input
= thunderx_gpio_dir_in
;
530 chip
->get
= thunderx_gpio_get
;
531 chip
->direction_output
= thunderx_gpio_dir_out
;
532 chip
->set
= thunderx_gpio_set
;
533 chip
->set_multiple
= thunderx_gpio_set_multiple
;
534 chip
->set_config
= thunderx_gpio_set_config
;
536 gpio_irq_chip_set_chip(girq
, &thunderx_gpio_irq_chip
);
537 girq
->fwnode
= dev_fwnode(dev
);
538 girq
->parent_domain
=
539 irq_get_irq_data(txgpio
->msix_entries
[0].vector
)->domain
;
540 girq
->child_to_parent_hwirq
= thunderx_gpio_child_to_parent_hwirq
;
541 girq
->populate_parent_alloc_arg
= thunderx_gpio_populate_parent_alloc_info
;
542 girq
->handler
= handle_bad_irq
;
543 girq
->default_type
= IRQ_TYPE_NONE
;
545 err
= devm_gpiochip_add_data(dev
, chip
, txgpio
);
549 /* Push on irq_data and the domain for each line. */
550 for (i
= 0; i
< ngpio
; i
++) {
551 struct irq_fwspec fwspec
;
553 fwspec
.fwnode
= dev_fwnode(dev
);
554 fwspec
.param_count
= 2;
556 fwspec
.param
[1] = IRQ_TYPE_NONE
;
557 err
= irq_domain_push_irq(girq
->domain
,
558 txgpio
->msix_entries
[i
].vector
,
561 dev_err(dev
, "irq_domain_push_irq: %d\n", err
);
564 dev_info(dev
, "ThunderX GPIO: %d lines with base %d.\n",
568 pci_set_drvdata(pdev
, NULL
);
572 static void thunderx_gpio_remove(struct pci_dev
*pdev
)
575 struct thunderx_gpio
*txgpio
= pci_get_drvdata(pdev
);
577 for (i
= 0; i
< txgpio
->chip
.ngpio
; i
++)
578 irq_domain_pop_irq(txgpio
->chip
.irq
.domain
,
579 txgpio
->msix_entries
[i
].vector
);
581 irq_domain_remove(txgpio
->chip
.irq
.domain
);
583 pci_set_drvdata(pdev
, NULL
);
586 static const struct pci_device_id thunderx_gpio_id_table
[] = {
587 { PCI_DEVICE(PCI_VENDOR_ID_CAVIUM
, 0xA00A) },
588 { 0, } /* end of table */
591 MODULE_DEVICE_TABLE(pci
, thunderx_gpio_id_table
);
593 static struct pci_driver thunderx_gpio_driver
= {
594 .name
= KBUILD_MODNAME
,
595 .id_table
= thunderx_gpio_id_table
,
596 .probe
= thunderx_gpio_probe
,
597 .remove
= thunderx_gpio_remove
,
600 module_pci_driver(thunderx_gpio_driver
);
602 MODULE_DESCRIPTION("Cavium Inc. ThunderX/OCTEON-TX GPIO Driver");
603 MODULE_LICENSE("GPL");