ata: start separating SATA specific code from libata-core.c
[linux/fpc-iii.git] / drivers / pci / controller / pci-xgene.c
blobde195fd430dc02ad8242bf237ddd2b55703de5c6
1 // SPDX-License-Identifier: GPL-2.0+
2 /**
3 * APM X-Gene PCIe Driver
5 * Copyright (c) 2014 Applied Micro Circuits Corporation.
7 * Author: Tanmay Inamdar <tinamdar@apm.com>.
8 */
9 #include <linux/clk.h>
10 #include <linux/delay.h>
11 #include <linux/io.h>
12 #include <linux/jiffies.h>
13 #include <linux/memblock.h>
14 #include <linux/init.h>
15 #include <linux/of.h>
16 #include <linux/of_address.h>
17 #include <linux/of_irq.h>
18 #include <linux/of_pci.h>
19 #include <linux/pci.h>
20 #include <linux/pci-acpi.h>
21 #include <linux/pci-ecam.h>
22 #include <linux/platform_device.h>
23 #include <linux/slab.h>
25 #include "../pci.h"
27 #define PCIECORE_CTLANDSTATUS 0x50
28 #define PIM1_1L 0x80
29 #define IBAR2 0x98
30 #define IR2MSK 0x9c
31 #define PIM2_1L 0xa0
32 #define IBAR3L 0xb4
33 #define IR3MSKL 0xbc
34 #define PIM3_1L 0xc4
35 #define OMR1BARL 0x100
36 #define OMR2BARL 0x118
37 #define OMR3BARL 0x130
38 #define CFGBARL 0x154
39 #define CFGBARH 0x158
40 #define CFGCTL 0x15c
41 #define RTDID 0x160
42 #define BRIDGE_CFG_0 0x2000
43 #define BRIDGE_CFG_4 0x2010
44 #define BRIDGE_STATUS_0 0x2600
46 #define LINK_UP_MASK 0x00000100
47 #define AXI_EP_CFG_ACCESS 0x10000
48 #define EN_COHERENCY 0xF0000000
49 #define EN_REG 0x00000001
50 #define OB_LO_IO 0x00000002
51 #define XGENE_PCIE_VENDORID 0x10E8
52 #define XGENE_PCIE_DEVICEID 0xE004
53 #define SZ_1T (SZ_1G*1024ULL)
54 #define PIPE_PHY_RATE_RD(src) ((0xc000 & (u32)(src)) >> 0xe)
56 #define XGENE_V1_PCI_EXP_CAP 0x40
58 /* PCIe IP version */
59 #define XGENE_PCIE_IP_VER_UNKN 0
60 #define XGENE_PCIE_IP_VER_1 1
61 #define XGENE_PCIE_IP_VER_2 2
63 #if defined(CONFIG_PCI_XGENE) || (defined(CONFIG_ACPI) && defined(CONFIG_PCI_QUIRKS))
64 struct xgene_pcie_port {
65 struct device_node *node;
66 struct device *dev;
67 struct clk *clk;
68 void __iomem *csr_base;
69 void __iomem *cfg_base;
70 unsigned long cfg_addr;
71 bool link_up;
72 u32 version;
75 static u32 xgene_pcie_readl(struct xgene_pcie_port *port, u32 reg)
77 return readl(port->csr_base + reg);
80 static void xgene_pcie_writel(struct xgene_pcie_port *port, u32 reg, u32 val)
82 writel(val, port->csr_base + reg);
85 static inline u32 pcie_bar_low_val(u32 addr, u32 flags)
87 return (addr & PCI_BASE_ADDRESS_MEM_MASK) | flags;
90 static inline struct xgene_pcie_port *pcie_bus_to_port(struct pci_bus *bus)
92 struct pci_config_window *cfg;
94 if (acpi_disabled)
95 return (struct xgene_pcie_port *)(bus->sysdata);
97 cfg = bus->sysdata;
98 return (struct xgene_pcie_port *)(cfg->priv);
102 * When the address bit [17:16] is 2'b01, the Configuration access will be
103 * treated as Type 1 and it will be forwarded to external PCIe device.
105 static void __iomem *xgene_pcie_get_cfg_base(struct pci_bus *bus)
107 struct xgene_pcie_port *port = pcie_bus_to_port(bus);
109 if (bus->number >= (bus->primary + 1))
110 return port->cfg_base + AXI_EP_CFG_ACCESS;
112 return port->cfg_base;
116 * For Configuration request, RTDID register is used as Bus Number,
117 * Device Number and Function number of the header fields.
119 static void xgene_pcie_set_rtdid_reg(struct pci_bus *bus, uint devfn)
121 struct xgene_pcie_port *port = pcie_bus_to_port(bus);
122 unsigned int b, d, f;
123 u32 rtdid_val = 0;
125 b = bus->number;
126 d = PCI_SLOT(devfn);
127 f = PCI_FUNC(devfn);
129 if (!pci_is_root_bus(bus))
130 rtdid_val = (b << 8) | (d << 3) | f;
132 xgene_pcie_writel(port, RTDID, rtdid_val);
133 /* read the register back to ensure flush */
134 xgene_pcie_readl(port, RTDID);
138 * X-Gene PCIe port uses BAR0-BAR1 of RC's configuration space as
139 * the translation from PCI bus to native BUS. Entire DDR region
140 * is mapped into PCIe space using these registers, so it can be
141 * reached by DMA from EP devices. The BAR0/1 of bridge should be
142 * hidden during enumeration to avoid the sizing and resource allocation
143 * by PCIe core.
145 static bool xgene_pcie_hide_rc_bars(struct pci_bus *bus, int offset)
147 if (pci_is_root_bus(bus) && ((offset == PCI_BASE_ADDRESS_0) ||
148 (offset == PCI_BASE_ADDRESS_1)))
149 return true;
151 return false;
154 static void __iomem *xgene_pcie_map_bus(struct pci_bus *bus, unsigned int devfn,
155 int offset)
157 if ((pci_is_root_bus(bus) && devfn != 0) ||
158 xgene_pcie_hide_rc_bars(bus, offset))
159 return NULL;
161 xgene_pcie_set_rtdid_reg(bus, devfn);
162 return xgene_pcie_get_cfg_base(bus) + offset;
165 static int xgene_pcie_config_read32(struct pci_bus *bus, unsigned int devfn,
166 int where, int size, u32 *val)
168 struct xgene_pcie_port *port = pcie_bus_to_port(bus);
170 if (pci_generic_config_read32(bus, devfn, where & ~0x3, 4, val) !=
171 PCIBIOS_SUCCESSFUL)
172 return PCIBIOS_DEVICE_NOT_FOUND;
175 * The v1 controller has a bug in its Configuration Request
176 * Retry Status (CRS) logic: when CRS is enabled and we read the
177 * Vendor and Device ID of a non-existent device, the controller
178 * fabricates return data of 0xFFFF0001 ("device exists but is not
179 * ready") instead of 0xFFFFFFFF ("device does not exist"). This
180 * causes the PCI core to retry the read until it times out.
181 * Avoid this by not claiming to support CRS.
183 if (pci_is_root_bus(bus) && (port->version == XGENE_PCIE_IP_VER_1) &&
184 ((where & ~0x3) == XGENE_V1_PCI_EXP_CAP + PCI_EXP_RTCTL))
185 *val &= ~(PCI_EXP_RTCAP_CRSVIS << 16);
187 if (size <= 2)
188 *val = (*val >> (8 * (where & 3))) & ((1 << (size * 8)) - 1);
190 return PCIBIOS_SUCCESSFUL;
192 #endif
194 #if defined(CONFIG_ACPI) && defined(CONFIG_PCI_QUIRKS)
195 static int xgene_get_csr_resource(struct acpi_device *adev,
196 struct resource *res)
198 struct device *dev = &adev->dev;
199 struct resource_entry *entry;
200 struct list_head list;
201 unsigned long flags;
202 int ret;
204 INIT_LIST_HEAD(&list);
205 flags = IORESOURCE_MEM;
206 ret = acpi_dev_get_resources(adev, &list,
207 acpi_dev_filter_resource_type_cb,
208 (void *) flags);
209 if (ret < 0) {
210 dev_err(dev, "failed to parse _CRS method, error code %d\n",
211 ret);
212 return ret;
215 if (ret == 0) {
216 dev_err(dev, "no IO and memory resources present in _CRS\n");
217 return -EINVAL;
220 entry = list_first_entry(&list, struct resource_entry, node);
221 *res = *entry->res;
222 acpi_dev_free_resource_list(&list);
223 return 0;
226 static int xgene_pcie_ecam_init(struct pci_config_window *cfg, u32 ipversion)
228 struct device *dev = cfg->parent;
229 struct acpi_device *adev = to_acpi_device(dev);
230 struct xgene_pcie_port *port;
231 struct resource csr;
232 int ret;
234 port = devm_kzalloc(dev, sizeof(*port), GFP_KERNEL);
235 if (!port)
236 return -ENOMEM;
238 ret = xgene_get_csr_resource(adev, &csr);
239 if (ret) {
240 dev_err(dev, "can't get CSR resource\n");
241 return ret;
243 port->csr_base = devm_pci_remap_cfg_resource(dev, &csr);
244 if (IS_ERR(port->csr_base))
245 return PTR_ERR(port->csr_base);
247 port->cfg_base = cfg->win;
248 port->version = ipversion;
250 cfg->priv = port;
251 return 0;
254 static int xgene_v1_pcie_ecam_init(struct pci_config_window *cfg)
256 return xgene_pcie_ecam_init(cfg, XGENE_PCIE_IP_VER_1);
259 struct pci_ecam_ops xgene_v1_pcie_ecam_ops = {
260 .bus_shift = 16,
261 .init = xgene_v1_pcie_ecam_init,
262 .pci_ops = {
263 .map_bus = xgene_pcie_map_bus,
264 .read = xgene_pcie_config_read32,
265 .write = pci_generic_config_write,
269 static int xgene_v2_pcie_ecam_init(struct pci_config_window *cfg)
271 return xgene_pcie_ecam_init(cfg, XGENE_PCIE_IP_VER_2);
274 struct pci_ecam_ops xgene_v2_pcie_ecam_ops = {
275 .bus_shift = 16,
276 .init = xgene_v2_pcie_ecam_init,
277 .pci_ops = {
278 .map_bus = xgene_pcie_map_bus,
279 .read = xgene_pcie_config_read32,
280 .write = pci_generic_config_write,
283 #endif
285 #if defined(CONFIG_PCI_XGENE)
286 static u64 xgene_pcie_set_ib_mask(struct xgene_pcie_port *port, u32 addr,
287 u32 flags, u64 size)
289 u64 mask = (~(size - 1) & PCI_BASE_ADDRESS_MEM_MASK) | flags;
290 u32 val32 = 0;
291 u32 val;
293 val32 = xgene_pcie_readl(port, addr);
294 val = (val32 & 0x0000ffff) | (lower_32_bits(mask) << 16);
295 xgene_pcie_writel(port, addr, val);
297 val32 = xgene_pcie_readl(port, addr + 0x04);
298 val = (val32 & 0xffff0000) | (lower_32_bits(mask) >> 16);
299 xgene_pcie_writel(port, addr + 0x04, val);
301 val32 = xgene_pcie_readl(port, addr + 0x04);
302 val = (val32 & 0x0000ffff) | (upper_32_bits(mask) << 16);
303 xgene_pcie_writel(port, addr + 0x04, val);
305 val32 = xgene_pcie_readl(port, addr + 0x08);
306 val = (val32 & 0xffff0000) | (upper_32_bits(mask) >> 16);
307 xgene_pcie_writel(port, addr + 0x08, val);
309 return mask;
312 static void xgene_pcie_linkup(struct xgene_pcie_port *port,
313 u32 *lanes, u32 *speed)
315 u32 val32;
317 port->link_up = false;
318 val32 = xgene_pcie_readl(port, PCIECORE_CTLANDSTATUS);
319 if (val32 & LINK_UP_MASK) {
320 port->link_up = true;
321 *speed = PIPE_PHY_RATE_RD(val32);
322 val32 = xgene_pcie_readl(port, BRIDGE_STATUS_0);
323 *lanes = val32 >> 26;
327 static int xgene_pcie_init_port(struct xgene_pcie_port *port)
329 struct device *dev = port->dev;
330 int rc;
332 port->clk = clk_get(dev, NULL);
333 if (IS_ERR(port->clk)) {
334 dev_err(dev, "clock not available\n");
335 return -ENODEV;
338 rc = clk_prepare_enable(port->clk);
339 if (rc) {
340 dev_err(dev, "clock enable failed\n");
341 return rc;
344 return 0;
347 static int xgene_pcie_map_reg(struct xgene_pcie_port *port,
348 struct platform_device *pdev)
350 struct device *dev = port->dev;
351 struct resource *res;
353 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "csr");
354 port->csr_base = devm_pci_remap_cfg_resource(dev, res);
355 if (IS_ERR(port->csr_base))
356 return PTR_ERR(port->csr_base);
358 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "cfg");
359 port->cfg_base = devm_ioremap_resource(dev, res);
360 if (IS_ERR(port->cfg_base))
361 return PTR_ERR(port->cfg_base);
362 port->cfg_addr = res->start;
364 return 0;
367 static void xgene_pcie_setup_ob_reg(struct xgene_pcie_port *port,
368 struct resource *res, u32 offset,
369 u64 cpu_addr, u64 pci_addr)
371 struct device *dev = port->dev;
372 resource_size_t size = resource_size(res);
373 u64 restype = resource_type(res);
374 u64 mask = 0;
375 u32 min_size;
376 u32 flag = EN_REG;
378 if (restype == IORESOURCE_MEM) {
379 min_size = SZ_128M;
380 } else {
381 min_size = 128;
382 flag |= OB_LO_IO;
385 if (size >= min_size)
386 mask = ~(size - 1) | flag;
387 else
388 dev_warn(dev, "res size 0x%llx less than minimum 0x%x\n",
389 (u64)size, min_size);
391 xgene_pcie_writel(port, offset, lower_32_bits(cpu_addr));
392 xgene_pcie_writel(port, offset + 0x04, upper_32_bits(cpu_addr));
393 xgene_pcie_writel(port, offset + 0x08, lower_32_bits(mask));
394 xgene_pcie_writel(port, offset + 0x0c, upper_32_bits(mask));
395 xgene_pcie_writel(port, offset + 0x10, lower_32_bits(pci_addr));
396 xgene_pcie_writel(port, offset + 0x14, upper_32_bits(pci_addr));
399 static void xgene_pcie_setup_cfg_reg(struct xgene_pcie_port *port)
401 u64 addr = port->cfg_addr;
403 xgene_pcie_writel(port, CFGBARL, lower_32_bits(addr));
404 xgene_pcie_writel(port, CFGBARH, upper_32_bits(addr));
405 xgene_pcie_writel(port, CFGCTL, EN_REG);
408 static int xgene_pcie_map_ranges(struct xgene_pcie_port *port)
410 struct pci_host_bridge *bridge = pci_host_bridge_from_priv(port);
411 struct resource_entry *window;
412 struct device *dev = port->dev;
414 resource_list_for_each_entry(window, &bridge->windows) {
415 struct resource *res = window->res;
416 u64 restype = resource_type(res);
418 dev_dbg(dev, "%pR\n", res);
420 switch (restype) {
421 case IORESOURCE_IO:
422 xgene_pcie_setup_ob_reg(port, res, OMR3BARL,
423 pci_pio_to_address(res->start),
424 res->start - window->offset);
425 break;
426 case IORESOURCE_MEM:
427 if (res->flags & IORESOURCE_PREFETCH)
428 xgene_pcie_setup_ob_reg(port, res, OMR2BARL,
429 res->start,
430 res->start -
431 window->offset);
432 else
433 xgene_pcie_setup_ob_reg(port, res, OMR1BARL,
434 res->start,
435 res->start -
436 window->offset);
437 break;
438 case IORESOURCE_BUS:
439 break;
440 default:
441 dev_err(dev, "invalid resource %pR\n", res);
442 return -EINVAL;
445 xgene_pcie_setup_cfg_reg(port);
446 return 0;
449 static void xgene_pcie_setup_pims(struct xgene_pcie_port *port, u32 pim_reg,
450 u64 pim, u64 size)
452 xgene_pcie_writel(port, pim_reg, lower_32_bits(pim));
453 xgene_pcie_writel(port, pim_reg + 0x04,
454 upper_32_bits(pim) | EN_COHERENCY);
455 xgene_pcie_writel(port, pim_reg + 0x10, lower_32_bits(size));
456 xgene_pcie_writel(port, pim_reg + 0x14, upper_32_bits(size));
460 * X-Gene PCIe support maximum 3 inbound memory regions
461 * This function helps to select a region based on size of region
463 static int xgene_pcie_select_ib_reg(u8 *ib_reg_mask, u64 size)
465 if ((size > 4) && (size < SZ_16M) && !(*ib_reg_mask & (1 << 1))) {
466 *ib_reg_mask |= (1 << 1);
467 return 1;
470 if ((size > SZ_1K) && (size < SZ_1T) && !(*ib_reg_mask & (1 << 0))) {
471 *ib_reg_mask |= (1 << 0);
472 return 0;
475 if ((size > SZ_1M) && (size < SZ_1T) && !(*ib_reg_mask & (1 << 2))) {
476 *ib_reg_mask |= (1 << 2);
477 return 2;
480 return -EINVAL;
483 static void xgene_pcie_setup_ib_reg(struct xgene_pcie_port *port,
484 struct resource_entry *entry,
485 u8 *ib_reg_mask)
487 void __iomem *cfg_base = port->cfg_base;
488 struct device *dev = port->dev;
489 void *bar_addr;
490 u32 pim_reg;
491 u64 cpu_addr = entry->res->start;
492 u64 pci_addr = cpu_addr - entry->offset;
493 u64 size = resource_size(entry->res);
494 u64 mask = ~(size - 1) | EN_REG;
495 u32 flags = PCI_BASE_ADDRESS_MEM_TYPE_64;
496 u32 bar_low;
497 int region;
499 region = xgene_pcie_select_ib_reg(ib_reg_mask, size);
500 if (region < 0) {
501 dev_warn(dev, "invalid pcie dma-range config\n");
502 return;
505 if (entry->res->flags & IORESOURCE_PREFETCH)
506 flags |= PCI_BASE_ADDRESS_MEM_PREFETCH;
508 bar_low = pcie_bar_low_val((u32)cpu_addr, flags);
509 switch (region) {
510 case 0:
511 xgene_pcie_set_ib_mask(port, BRIDGE_CFG_4, flags, size);
512 bar_addr = cfg_base + PCI_BASE_ADDRESS_0;
513 writel(bar_low, bar_addr);
514 writel(upper_32_bits(cpu_addr), bar_addr + 0x4);
515 pim_reg = PIM1_1L;
516 break;
517 case 1:
518 xgene_pcie_writel(port, IBAR2, bar_low);
519 xgene_pcie_writel(port, IR2MSK, lower_32_bits(mask));
520 pim_reg = PIM2_1L;
521 break;
522 case 2:
523 xgene_pcie_writel(port, IBAR3L, bar_low);
524 xgene_pcie_writel(port, IBAR3L + 0x4, upper_32_bits(cpu_addr));
525 xgene_pcie_writel(port, IR3MSKL, lower_32_bits(mask));
526 xgene_pcie_writel(port, IR3MSKL + 0x4, upper_32_bits(mask));
527 pim_reg = PIM3_1L;
528 break;
531 xgene_pcie_setup_pims(port, pim_reg, pci_addr, ~(size - 1));
534 static int xgene_pcie_parse_map_dma_ranges(struct xgene_pcie_port *port)
536 struct pci_host_bridge *bridge = pci_host_bridge_from_priv(port);
537 struct resource_entry *entry;
538 u8 ib_reg_mask = 0;
540 resource_list_for_each_entry(entry, &bridge->dma_ranges)
541 xgene_pcie_setup_ib_reg(port, entry, &ib_reg_mask);
543 return 0;
546 /* clear BAR configuration which was done by firmware */
547 static void xgene_pcie_clear_config(struct xgene_pcie_port *port)
549 int i;
551 for (i = PIM1_1L; i <= CFGCTL; i += 4)
552 xgene_pcie_writel(port, i, 0);
555 static int xgene_pcie_setup(struct xgene_pcie_port *port)
557 struct device *dev = port->dev;
558 u32 val, lanes = 0, speed = 0;
559 int ret;
561 xgene_pcie_clear_config(port);
563 /* setup the vendor and device IDs correctly */
564 val = (XGENE_PCIE_DEVICEID << 16) | XGENE_PCIE_VENDORID;
565 xgene_pcie_writel(port, BRIDGE_CFG_0, val);
567 ret = xgene_pcie_map_ranges(port);
568 if (ret)
569 return ret;
571 ret = xgene_pcie_parse_map_dma_ranges(port);
572 if (ret)
573 return ret;
575 xgene_pcie_linkup(port, &lanes, &speed);
576 if (!port->link_up)
577 dev_info(dev, "(rc) link down\n");
578 else
579 dev_info(dev, "(rc) x%d gen-%d link up\n", lanes, speed + 1);
580 return 0;
583 static struct pci_ops xgene_pcie_ops = {
584 .map_bus = xgene_pcie_map_bus,
585 .read = xgene_pcie_config_read32,
586 .write = pci_generic_config_write32,
589 static int xgene_pcie_probe(struct platform_device *pdev)
591 struct device *dev = &pdev->dev;
592 struct device_node *dn = dev->of_node;
593 struct xgene_pcie_port *port;
594 struct pci_bus *bus, *child;
595 struct pci_host_bridge *bridge;
596 int ret;
598 bridge = devm_pci_alloc_host_bridge(dev, sizeof(*port));
599 if (!bridge)
600 return -ENOMEM;
602 port = pci_host_bridge_priv(bridge);
604 port->node = of_node_get(dn);
605 port->dev = dev;
607 port->version = XGENE_PCIE_IP_VER_UNKN;
608 if (of_device_is_compatible(port->node, "apm,xgene-pcie"))
609 port->version = XGENE_PCIE_IP_VER_1;
611 ret = xgene_pcie_map_reg(port, pdev);
612 if (ret)
613 return ret;
615 ret = xgene_pcie_init_port(port);
616 if (ret)
617 return ret;
619 ret = pci_parse_request_of_pci_ranges(dev, &bridge->windows,
620 &bridge->dma_ranges, NULL);
621 if (ret)
622 return ret;
624 ret = xgene_pcie_setup(port);
625 if (ret)
626 return ret;
628 bridge->dev.parent = dev;
629 bridge->sysdata = port;
630 bridge->busnr = 0;
631 bridge->ops = &xgene_pcie_ops;
632 bridge->map_irq = of_irq_parse_and_map_pci;
633 bridge->swizzle_irq = pci_common_swizzle;
635 ret = pci_scan_root_bus_bridge(bridge);
636 if (ret < 0)
637 return ret;
639 bus = bridge->bus;
641 pci_assign_unassigned_bus_resources(bus);
642 list_for_each_entry(child, &bus->children, node)
643 pcie_bus_configure_settings(child);
644 pci_bus_add_devices(bus);
645 return 0;
648 static const struct of_device_id xgene_pcie_match_table[] = {
649 {.compatible = "apm,xgene-pcie",},
653 static struct platform_driver xgene_pcie_driver = {
654 .driver = {
655 .name = "xgene-pcie",
656 .of_match_table = of_match_ptr(xgene_pcie_match_table),
657 .suppress_bind_attrs = true,
659 .probe = xgene_pcie_probe,
661 builtin_platform_driver(xgene_pcie_driver);
662 #endif