2 * DesignWare application register space functions for Keystone PCI controller
4 * Copyright (C) 2013-2014 Texas Instruments., Ltd.
7 * Author: Murali Karicheri <m-karicheri2@ti.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
15 #include <linux/irq.h>
16 #include <linux/irqdomain.h>
17 #include <linux/irqreturn.h>
18 #include <linux/module.h>
20 #include <linux/of_pci.h>
21 #include <linux/pci.h>
22 #include <linux/platform_device.h>
24 #include "pcie-designware.h"
25 #include "pci-keystone.h"
27 /* Application register defines */
28 #define LTSSM_EN_VAL 1
29 #define LTSSM_STATE_MASK 0x1f
30 #define LTSSM_STATE_L0 0x11
31 #define DBI_CS2_EN_VAL 0x20
32 #define OB_XLAT_EN_VAL 2
34 /* Application registers */
35 #define CMD_STATUS 0x004
36 #define CFG_SETUP 0x008
38 #define CFG_PCIM_WIN_SZ_IDX 3
39 #define CFG_PCIM_WIN_CNT 32
40 #define SPACE0_REMOTE_CFG_OFFSET 0x1000
41 #define OB_OFFSET_INDEX(n) (0x200 + (8 * n))
42 #define OB_OFFSET_HI(n) (0x204 + (8 * n))
44 /* IRQ register defines */
46 #define IRQ_STATUS 0x184
47 #define IRQ_ENABLE_SET 0x188
48 #define IRQ_ENABLE_CLR 0x18c
51 #define MSI0_IRQ_STATUS 0x104
52 #define MSI0_IRQ_ENABLE_SET 0x108
53 #define MSI0_IRQ_ENABLE_CLR 0x10c
54 #define IRQ_STATUS 0x184
55 #define MSI_IRQ_OFFSET 4
58 #define ERR_AER BIT(5) /* ECRC error */
59 #define ERR_AXI BIT(4) /* AXI tag lookup fatal error */
60 #define ERR_CORR BIT(3) /* Correctable error */
61 #define ERR_NONFATAL BIT(2) /* Non-fatal error */
62 #define ERR_FATAL BIT(1) /* Fatal error */
63 #define ERR_SYS BIT(0) /* System (fatal, non-fatal, or correctable) */
64 #define ERR_IRQ_ALL (ERR_AER | ERR_AXI | ERR_CORR | \
65 ERR_NONFATAL | ERR_FATAL | ERR_SYS)
66 #define ERR_FATAL_IRQ (ERR_FATAL | ERR_AXI)
67 #define ERR_IRQ_STATUS_RAW 0x1c0
68 #define ERR_IRQ_STATUS 0x1c4
69 #define ERR_IRQ_ENABLE_SET 0x1c8
70 #define ERR_IRQ_ENABLE_CLR 0x1cc
72 /* Config space registers */
75 #define to_keystone_pcie(x) dev_get_drvdata((x)->dev)
77 static inline void update_reg_offset_bit_pos(u32 offset, u32 *reg_offset,
80 *reg_offset = offset % 8;
81 *bit_pos = offset >> 3;
84 phys_addr_t ks_dw_pcie_get_msi_addr(struct pcie_port *pp)
86 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
87 struct keystone_pcie *ks_pcie = to_keystone_pcie(pci);
89 return ks_pcie->app.start + MSI_IRQ;
92 static u32 ks_dw_app_readl(struct keystone_pcie *ks_pcie, u32 offset)
94 return readl(ks_pcie->va_app_base + offset);
97 static void ks_dw_app_writel(struct keystone_pcie *ks_pcie, u32 offset, u32 val)
99 writel(val, ks_pcie->va_app_base + offset);
102 void ks_dw_pcie_handle_msi_irq(struct keystone_pcie *ks_pcie, int offset)
104 struct dw_pcie *pci = ks_pcie->pci;
105 struct pcie_port *pp = &pci->pp;
106 struct device *dev = pci->dev;
110 pending = ks_dw_app_readl(ks_pcie, MSI0_IRQ_STATUS + (offset << 4));
113 * MSI0 status bit 0-3 shows vectors 0, 8, 16, 24, MSI1 status bit
114 * shows 1, 9, 17, 25 and so forth
116 for (src = 0; src < 4; src++) {
117 if (BIT(src) & pending) {
118 vector = offset + (src << 3);
119 virq = irq_linear_revmap(pp->irq_domain, vector);
120 dev_dbg(dev, "irq: bit %d, vector %d, virq %d\n",
122 generic_handle_irq(virq);
127 static void ks_dw_pcie_msi_irq_ack(struct irq_data *d)
129 u32 offset, reg_offset, bit_pos;
130 struct keystone_pcie *ks_pcie;
131 struct msi_desc *msi;
132 struct pcie_port *pp;
135 msi = irq_data_get_msi_desc(d);
136 pp = (struct pcie_port *) msi_desc_to_pci_sysdata(msi);
137 pci = to_dw_pcie_from_pp(pp);
138 ks_pcie = to_keystone_pcie(pci);
139 offset = d->irq - irq_linear_revmap(pp->irq_domain, 0);
140 update_reg_offset_bit_pos(offset, ®_offset, &bit_pos);
142 ks_dw_app_writel(ks_pcie, MSI0_IRQ_STATUS + (reg_offset << 4),
144 ks_dw_app_writel(ks_pcie, IRQ_EOI, reg_offset + MSI_IRQ_OFFSET);
147 void ks_dw_pcie_msi_set_irq(struct pcie_port *pp, int irq)
149 u32 reg_offset, bit_pos;
150 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
151 struct keystone_pcie *ks_pcie = to_keystone_pcie(pci);
153 update_reg_offset_bit_pos(irq, ®_offset, &bit_pos);
154 ks_dw_app_writel(ks_pcie, MSI0_IRQ_ENABLE_SET + (reg_offset << 4),
158 void ks_dw_pcie_msi_clear_irq(struct pcie_port *pp, int irq)
160 u32 reg_offset, bit_pos;
161 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
162 struct keystone_pcie *ks_pcie = to_keystone_pcie(pci);
164 update_reg_offset_bit_pos(irq, ®_offset, &bit_pos);
165 ks_dw_app_writel(ks_pcie, MSI0_IRQ_ENABLE_CLR + (reg_offset << 4),
169 static void ks_dw_pcie_msi_irq_mask(struct irq_data *d)
171 struct msi_desc *msi;
172 struct pcie_port *pp;
175 msi = irq_data_get_msi_desc(d);
176 pp = (struct pcie_port *) msi_desc_to_pci_sysdata(msi);
177 offset = d->irq - irq_linear_revmap(pp->irq_domain, 0);
179 /* Mask the end point if PVM implemented */
180 if (IS_ENABLED(CONFIG_PCI_MSI)) {
181 if (msi->msi_attrib.maskbit)
185 ks_dw_pcie_msi_clear_irq(pp, offset);
188 static void ks_dw_pcie_msi_irq_unmask(struct irq_data *d)
190 struct msi_desc *msi;
191 struct pcie_port *pp;
194 msi = irq_data_get_msi_desc(d);
195 pp = (struct pcie_port *) msi_desc_to_pci_sysdata(msi);
196 offset = d->irq - irq_linear_revmap(pp->irq_domain, 0);
198 /* Mask the end point if PVM implemented */
199 if (IS_ENABLED(CONFIG_PCI_MSI)) {
200 if (msi->msi_attrib.maskbit)
201 pci_msi_unmask_irq(d);
204 ks_dw_pcie_msi_set_irq(pp, offset);
207 static struct irq_chip ks_dw_pcie_msi_irq_chip = {
208 .name = "Keystone-PCIe-MSI-IRQ",
209 .irq_ack = ks_dw_pcie_msi_irq_ack,
210 .irq_mask = ks_dw_pcie_msi_irq_mask,
211 .irq_unmask = ks_dw_pcie_msi_irq_unmask,
214 static int ks_dw_pcie_msi_map(struct irq_domain *domain, unsigned int irq,
215 irq_hw_number_t hwirq)
217 irq_set_chip_and_handler(irq, &ks_dw_pcie_msi_irq_chip,
219 irq_set_chip_data(irq, domain->host_data);
224 static const struct irq_domain_ops ks_dw_pcie_msi_domain_ops = {
225 .map = ks_dw_pcie_msi_map,
228 int ks_dw_pcie_msi_host_init(struct pcie_port *pp, struct msi_controller *chip)
230 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
231 struct keystone_pcie *ks_pcie = to_keystone_pcie(pci);
232 struct device *dev = pci->dev;
235 pp->irq_domain = irq_domain_add_linear(ks_pcie->msi_intc_np,
237 &ks_dw_pcie_msi_domain_ops,
239 if (!pp->irq_domain) {
240 dev_err(dev, "irq domain init failed\n");
244 for (i = 0; i < MAX_MSI_IRQS; i++)
245 irq_create_mapping(pp->irq_domain, i);
250 void ks_dw_pcie_enable_legacy_irqs(struct keystone_pcie *ks_pcie)
254 for (i = 0; i < PCI_NUM_INTX; i++)
255 ks_dw_app_writel(ks_pcie, IRQ_ENABLE_SET + (i << 4), 0x1);
258 void ks_dw_pcie_handle_legacy_irq(struct keystone_pcie *ks_pcie, int offset)
260 struct dw_pcie *pci = ks_pcie->pci;
261 struct device *dev = pci->dev;
265 pending = ks_dw_app_readl(ks_pcie, IRQ_STATUS + (offset << 4));
267 if (BIT(0) & pending) {
268 virq = irq_linear_revmap(ks_pcie->legacy_irq_domain, offset);
269 dev_dbg(dev, ": irq: irq_offset %d, virq %d\n", offset, virq);
270 generic_handle_irq(virq);
273 /* EOI the INTx interrupt */
274 ks_dw_app_writel(ks_pcie, IRQ_EOI, offset);
277 void ks_dw_pcie_enable_error_irq(struct keystone_pcie *ks_pcie)
279 ks_dw_app_writel(ks_pcie, ERR_IRQ_ENABLE_SET, ERR_IRQ_ALL);
282 irqreturn_t ks_dw_pcie_handle_error_irq(struct keystone_pcie *ks_pcie)
286 status = ks_dw_app_readl(ks_pcie, ERR_IRQ_STATUS_RAW) & ERR_IRQ_ALL;
290 if (status & ERR_FATAL_IRQ)
291 dev_err(ks_pcie->pci->dev, "fatal error (status %#010x)\n",
294 /* Ack the IRQ; status bits are RW1C */
295 ks_dw_app_writel(ks_pcie, ERR_IRQ_STATUS, status);
299 static void ks_dw_pcie_ack_legacy_irq(struct irq_data *d)
303 static void ks_dw_pcie_mask_legacy_irq(struct irq_data *d)
307 static void ks_dw_pcie_unmask_legacy_irq(struct irq_data *d)
311 static struct irq_chip ks_dw_pcie_legacy_irq_chip = {
312 .name = "Keystone-PCI-Legacy-IRQ",
313 .irq_ack = ks_dw_pcie_ack_legacy_irq,
314 .irq_mask = ks_dw_pcie_mask_legacy_irq,
315 .irq_unmask = ks_dw_pcie_unmask_legacy_irq,
318 static int ks_dw_pcie_init_legacy_irq_map(struct irq_domain *d,
319 unsigned int irq, irq_hw_number_t hw_irq)
321 irq_set_chip_and_handler(irq, &ks_dw_pcie_legacy_irq_chip,
323 irq_set_chip_data(irq, d->host_data);
328 static const struct irq_domain_ops ks_dw_pcie_legacy_irq_domain_ops = {
329 .map = ks_dw_pcie_init_legacy_irq_map,
330 .xlate = irq_domain_xlate_onetwocell,
334 * ks_dw_pcie_set_dbi_mode() - Set DBI mode to access overlaid BAR mask
337 * Since modification of dbi_cs2 involves different clock domain, read the
338 * status back to ensure the transition is complete.
340 static void ks_dw_pcie_set_dbi_mode(struct keystone_pcie *ks_pcie)
344 val = ks_dw_app_readl(ks_pcie, CMD_STATUS);
345 ks_dw_app_writel(ks_pcie, CMD_STATUS, DBI_CS2_EN_VAL | val);
348 val = ks_dw_app_readl(ks_pcie, CMD_STATUS);
349 } while (!(val & DBI_CS2_EN_VAL));
353 * ks_dw_pcie_clear_dbi_mode() - Disable DBI mode
355 * Since modification of dbi_cs2 involves different clock domain, read the
356 * status back to ensure the transition is complete.
358 static void ks_dw_pcie_clear_dbi_mode(struct keystone_pcie *ks_pcie)
362 val = ks_dw_app_readl(ks_pcie, CMD_STATUS);
363 ks_dw_app_writel(ks_pcie, CMD_STATUS, ~DBI_CS2_EN_VAL & val);
366 val = ks_dw_app_readl(ks_pcie, CMD_STATUS);
367 } while (val & DBI_CS2_EN_VAL);
370 void ks_dw_pcie_setup_rc_app_regs(struct keystone_pcie *ks_pcie)
372 struct dw_pcie *pci = ks_pcie->pci;
373 struct pcie_port *pp = &pci->pp;
374 u32 start = pp->mem->start, end = pp->mem->end;
378 /* Disable BARs for inbound access */
379 ks_dw_pcie_set_dbi_mode(ks_pcie);
380 dw_pcie_writel_dbi(pci, PCI_BASE_ADDRESS_0, 0);
381 dw_pcie_writel_dbi(pci, PCI_BASE_ADDRESS_1, 0);
382 ks_dw_pcie_clear_dbi_mode(ks_pcie);
384 /* Set outbound translation size per window division */
385 ks_dw_app_writel(ks_pcie, OB_SIZE, CFG_PCIM_WIN_SZ_IDX & 0x7);
387 tr_size = (1 << (CFG_PCIM_WIN_SZ_IDX & 0x7)) * SZ_1M;
389 /* Using Direct 1:1 mapping of RC <-> PCI memory space */
390 for (i = 0; (i < CFG_PCIM_WIN_CNT) && (start < end); i++) {
391 ks_dw_app_writel(ks_pcie, OB_OFFSET_INDEX(i), start | 1);
392 ks_dw_app_writel(ks_pcie, OB_OFFSET_HI(i), 0);
396 /* Enable OB translation */
397 val = ks_dw_app_readl(ks_pcie, CMD_STATUS);
398 ks_dw_app_writel(ks_pcie, CMD_STATUS, OB_XLAT_EN_VAL | val);
402 * ks_pcie_cfg_setup() - Set up configuration space address for a device
404 * @ks_pcie: ptr to keystone_pcie structure
405 * @bus: Bus number the device is residing on
406 * @devfn: device, function number info
408 * Forms and returns the address of configuration space mapped in PCIESS
409 * address space 0. Also configures CFG_SETUP for remote configuration space
412 * The address space has two regions to access configuration - local and remote.
413 * We access local region for bus 0 (as RC is attached on bus 0) and remote
414 * region for others with TYPE 1 access when bus > 1. As for device on bus = 1,
415 * we will do TYPE 0 access as it will be on our secondary bus (logical).
416 * CFG_SETUP is needed only for remote configuration access.
418 static void __iomem *ks_pcie_cfg_setup(struct keystone_pcie *ks_pcie, u8 bus,
421 u8 device = PCI_SLOT(devfn), function = PCI_FUNC(devfn);
422 struct dw_pcie *pci = ks_pcie->pci;
423 struct pcie_port *pp = &pci->pp;
427 return pci->dbi_base;
429 regval = (bus << 16) | (device << 8) | function;
432 * Since Bus#1 will be a virtual bus, we need to have TYPE0
439 ks_dw_app_writel(ks_pcie, CFG_SETUP, regval);
440 return pp->va_cfg0_base;
443 int ks_dw_pcie_rd_other_conf(struct pcie_port *pp, struct pci_bus *bus,
444 unsigned int devfn, int where, int size, u32 *val)
446 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
447 struct keystone_pcie *ks_pcie = to_keystone_pcie(pci);
448 u8 bus_num = bus->number;
451 addr = ks_pcie_cfg_setup(ks_pcie, bus_num, devfn);
453 return dw_pcie_read(addr + where, size, val);
456 int ks_dw_pcie_wr_other_conf(struct pcie_port *pp, struct pci_bus *bus,
457 unsigned int devfn, int where, int size, u32 val)
459 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
460 struct keystone_pcie *ks_pcie = to_keystone_pcie(pci);
461 u8 bus_num = bus->number;
464 addr = ks_pcie_cfg_setup(ks_pcie, bus_num, devfn);
466 return dw_pcie_write(addr + where, size, val);
470 * ks_dw_pcie_v3_65_scan_bus() - keystone scan_bus post initialization
472 * This sets BAR0 to enable inbound access for MSI_IRQ register
474 void ks_dw_pcie_v3_65_scan_bus(struct pcie_port *pp)
476 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
477 struct keystone_pcie *ks_pcie = to_keystone_pcie(pci);
479 /* Configure and set up BAR0 */
480 ks_dw_pcie_set_dbi_mode(ks_pcie);
483 dw_pcie_writel_dbi(pci, PCI_BASE_ADDRESS_0, 1);
484 dw_pcie_writel_dbi(pci, PCI_BASE_ADDRESS_0, SZ_4K - 1);
486 ks_dw_pcie_clear_dbi_mode(ks_pcie);
489 * For BAR0, just setting bus address for inbound writes (MSI) should
490 * be sufficient. Use physical address to avoid any conflicts.
492 dw_pcie_writel_dbi(pci, PCI_BASE_ADDRESS_0, ks_pcie->app.start);
496 * ks_dw_pcie_link_up() - Check if link up
498 int ks_dw_pcie_link_up(struct dw_pcie *pci)
502 val = dw_pcie_readl_dbi(pci, DEBUG0);
503 return (val & LTSSM_STATE_MASK) == LTSSM_STATE_L0;
506 void ks_dw_pcie_initiate_link_train(struct keystone_pcie *ks_pcie)
510 /* Disable Link training */
511 val = ks_dw_app_readl(ks_pcie, CMD_STATUS);
512 val &= ~LTSSM_EN_VAL;
513 ks_dw_app_writel(ks_pcie, CMD_STATUS, val);
515 /* Initiate Link Training */
516 val = ks_dw_app_readl(ks_pcie, CMD_STATUS);
517 ks_dw_app_writel(ks_pcie, CMD_STATUS, LTSSM_EN_VAL | val);
521 * ks_dw_pcie_host_init() - initialize host for v3_65 dw hardware
523 * Ioremap the register resources, initialize legacy irq domain
524 * and call dw_pcie_v3_65_host_init() API to initialize the Keystone
525 * PCI host controller.
527 int __init ks_dw_pcie_host_init(struct keystone_pcie *ks_pcie,
528 struct device_node *msi_intc_np)
530 struct dw_pcie *pci = ks_pcie->pci;
531 struct pcie_port *pp = &pci->pp;
532 struct device *dev = pci->dev;
533 struct platform_device *pdev = to_platform_device(dev);
534 struct resource *res;
536 /* Index 0 is the config reg. space address */
537 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
538 pci->dbi_base = devm_pci_remap_cfg_resource(dev, res);
539 if (IS_ERR(pci->dbi_base))
540 return PTR_ERR(pci->dbi_base);
543 * We set these same and is used in pcie rd/wr_other_conf
546 pp->va_cfg0_base = pci->dbi_base + SPACE0_REMOTE_CFG_OFFSET;
547 pp->va_cfg1_base = pp->va_cfg0_base;
549 /* Index 1 is the application reg. space address */
550 res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
551 ks_pcie->va_app_base = devm_ioremap_resource(dev, res);
552 if (IS_ERR(ks_pcie->va_app_base))
553 return PTR_ERR(ks_pcie->va_app_base);
557 /* Create legacy IRQ domain */
558 ks_pcie->legacy_irq_domain =
559 irq_domain_add_linear(ks_pcie->legacy_intc_np,
561 &ks_dw_pcie_legacy_irq_domain_ops,
563 if (!ks_pcie->legacy_irq_domain) {
564 dev_err(dev, "Failed to add irq domain for legacy irqs\n");
568 return dw_pcie_host_init(pp);