2 * Copyright (C) 2014 Hauke Mehrtens <hauke@hauke-m.de>
3 * Copyright (C) 2015 Broadcom Corporation
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
7 * published by the Free Software Foundation version 2.
9 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
10 * kind, whether express or implied; without even the implied warranty
11 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
15 #include <linux/kernel.h>
16 #include <linux/pci.h>
17 #include <linux/msi.h>
18 #include <linux/clk.h>
19 #include <linux/module.h>
20 #include <linux/mbus.h>
21 #include <linux/slab.h>
22 #include <linux/delay.h>
23 #include <linux/interrupt.h>
24 #include <linux/platform_device.h>
25 #include <linux/of_address.h>
26 #include <linux/of_pci.h>
27 #include <linux/of_irq.h>
28 #include <linux/of_platform.h>
29 #include <linux/phy/phy.h>
31 #include "pcie-iproc.h"
33 #define EP_PERST_SOURCE_SELECT_SHIFT 2
34 #define EP_PERST_SOURCE_SELECT BIT(EP_PERST_SOURCE_SELECT_SHIFT)
35 #define EP_MODE_SURVIVE_PERST_SHIFT 1
36 #define EP_MODE_SURVIVE_PERST BIT(EP_MODE_SURVIVE_PERST_SHIFT)
37 #define RC_PCIE_RST_OUTPUT_SHIFT 0
38 #define RC_PCIE_RST_OUTPUT BIT(RC_PCIE_RST_OUTPUT_SHIFT)
39 #define PAXC_RESET_MASK 0x7f
41 #define CFG_IND_ADDR_MASK 0x00001ffc
43 #define CFG_ADDR_BUS_NUM_SHIFT 20
44 #define CFG_ADDR_BUS_NUM_MASK 0x0ff00000
45 #define CFG_ADDR_DEV_NUM_SHIFT 15
46 #define CFG_ADDR_DEV_NUM_MASK 0x000f8000
47 #define CFG_ADDR_FUNC_NUM_SHIFT 12
48 #define CFG_ADDR_FUNC_NUM_MASK 0x00007000
49 #define CFG_ADDR_REG_NUM_SHIFT 2
50 #define CFG_ADDR_REG_NUM_MASK 0x00000ffc
51 #define CFG_ADDR_CFG_TYPE_SHIFT 0
52 #define CFG_ADDR_CFG_TYPE_MASK 0x00000003
54 #define SYS_RC_INTX_MASK 0xf
56 #define PCIE_PHYLINKUP_SHIFT 3
57 #define PCIE_PHYLINKUP BIT(PCIE_PHYLINKUP_SHIFT)
58 #define PCIE_DL_ACTIVE_SHIFT 2
59 #define PCIE_DL_ACTIVE BIT(PCIE_DL_ACTIVE_SHIFT)
61 #define OARR_VALID_SHIFT 0
62 #define OARR_VALID BIT(OARR_VALID_SHIFT)
63 #define OARR_SIZE_CFG_SHIFT 1
64 #define OARR_SIZE_CFG BIT(OARR_SIZE_CFG_SHIFT)
66 #define MAX_NUM_OB_WINDOWS 2
68 #define IPROC_PCIE_REG_INVALID 0xffff
71 IPROC_PCIE_CLK_CTRL = 0,
72 IPROC_PCIE_CFG_IND_ADDR,
73 IPROC_PCIE_CFG_IND_DATA,
81 IPROC_PCIE_LINK_STATUS,
84 /* iProc PCIe PAXB registers */
85 static const u16 iproc_pcie_reg_paxb[] = {
86 [IPROC_PCIE_CLK_CTRL] = 0x000,
87 [IPROC_PCIE_CFG_IND_ADDR] = 0x120,
88 [IPROC_PCIE_CFG_IND_DATA] = 0x124,
89 [IPROC_PCIE_CFG_ADDR] = 0x1f8,
90 [IPROC_PCIE_CFG_DATA] = 0x1fc,
91 [IPROC_PCIE_INTX_EN] = 0x330,
92 [IPROC_PCIE_OARR_LO] = 0xd20,
93 [IPROC_PCIE_OARR_HI] = 0xd24,
94 [IPROC_PCIE_OMAP_LO] = 0xd40,
95 [IPROC_PCIE_OMAP_HI] = 0xd44,
96 [IPROC_PCIE_LINK_STATUS] = 0xf0c,
99 /* iProc PCIe PAXC v1 registers */
100 static const u16 iproc_pcie_reg_paxc[] = {
101 [IPROC_PCIE_CLK_CTRL] = 0x000,
102 [IPROC_PCIE_CFG_IND_ADDR] = 0x1f0,
103 [IPROC_PCIE_CFG_IND_DATA] = 0x1f4,
104 [IPROC_PCIE_CFG_ADDR] = 0x1f8,
105 [IPROC_PCIE_CFG_DATA] = 0x1fc,
106 [IPROC_PCIE_INTX_EN] = IPROC_PCIE_REG_INVALID,
107 [IPROC_PCIE_OARR_LO] = IPROC_PCIE_REG_INVALID,
108 [IPROC_PCIE_OARR_HI] = IPROC_PCIE_REG_INVALID,
109 [IPROC_PCIE_OMAP_LO] = IPROC_PCIE_REG_INVALID,
110 [IPROC_PCIE_OMAP_HI] = IPROC_PCIE_REG_INVALID,
111 [IPROC_PCIE_LINK_STATUS] = IPROC_PCIE_REG_INVALID,
114 static inline struct iproc_pcie *iproc_data(struct pci_bus *bus)
116 struct iproc_pcie *pcie;
118 struct pci_sys_data *sys = bus->sysdata;
120 pcie = sys->private_data;
127 static inline bool iproc_pcie_reg_is_invalid(u16 reg_offset)
129 return !!(reg_offset == IPROC_PCIE_REG_INVALID);
132 static inline u16 iproc_pcie_reg_offset(struct iproc_pcie *pcie,
133 enum iproc_pcie_reg reg)
135 return pcie->reg_offsets[reg];
138 static inline u32 iproc_pcie_read_reg(struct iproc_pcie *pcie,
139 enum iproc_pcie_reg reg)
141 u16 offset = iproc_pcie_reg_offset(pcie, reg);
143 if (iproc_pcie_reg_is_invalid(offset))
146 return readl(pcie->base + offset);
149 static inline void iproc_pcie_write_reg(struct iproc_pcie *pcie,
150 enum iproc_pcie_reg reg, u32 val)
152 u16 offset = iproc_pcie_reg_offset(pcie, reg);
154 if (iproc_pcie_reg_is_invalid(offset))
157 writel(val, pcie->base + offset);
160 static inline void iproc_pcie_ob_write(struct iproc_pcie *pcie,
161 enum iproc_pcie_reg reg,
162 unsigned window, u32 val)
164 u16 offset = iproc_pcie_reg_offset(pcie, reg);
166 if (iproc_pcie_reg_is_invalid(offset))
169 writel(val, pcie->base + offset + (window * 8));
173 * Note access to the configuration registers are protected at the higher layer
174 * by 'pci_lock' in drivers/pci/access.c
176 static void __iomem *iproc_pcie_map_cfg_bus(struct pci_bus *bus,
180 struct iproc_pcie *pcie = iproc_data(bus);
181 unsigned slot = PCI_SLOT(devfn);
182 unsigned fn = PCI_FUNC(devfn);
183 unsigned busno = bus->number;
187 /* root complex access */
189 if (slot > 0 || fn > 0)
192 iproc_pcie_write_reg(pcie, IPROC_PCIE_CFG_IND_ADDR,
193 where & CFG_IND_ADDR_MASK);
194 offset = iproc_pcie_reg_offset(pcie, IPROC_PCIE_CFG_IND_DATA);
195 if (iproc_pcie_reg_is_invalid(offset))
198 return (pcie->base + offset);
202 * PAXC is connected to an internally emulated EP within the SoC. It
203 * allows only one device.
205 if (pcie->type == IPROC_PCIE_PAXC)
209 /* EP device access */
210 val = (busno << CFG_ADDR_BUS_NUM_SHIFT) |
211 (slot << CFG_ADDR_DEV_NUM_SHIFT) |
212 (fn << CFG_ADDR_FUNC_NUM_SHIFT) |
213 (where & CFG_ADDR_REG_NUM_MASK) |
214 (1 & CFG_ADDR_CFG_TYPE_MASK);
215 iproc_pcie_write_reg(pcie, IPROC_PCIE_CFG_ADDR, val);
216 offset = iproc_pcie_reg_offset(pcie, IPROC_PCIE_CFG_DATA);
217 if (iproc_pcie_reg_is_invalid(offset))
220 return (pcie->base + offset);
223 static struct pci_ops iproc_pcie_ops = {
224 .map_bus = iproc_pcie_map_cfg_bus,
225 .read = pci_generic_config_read32,
226 .write = pci_generic_config_write32,
229 static void iproc_pcie_reset(struct iproc_pcie *pcie)
233 if (pcie->type == IPROC_PCIE_PAXC) {
234 val = iproc_pcie_read_reg(pcie, IPROC_PCIE_CLK_CTRL);
235 val &= ~PAXC_RESET_MASK;
236 iproc_pcie_write_reg(pcie, IPROC_PCIE_CLK_CTRL, val);
238 val |= PAXC_RESET_MASK;
239 iproc_pcie_write_reg(pcie, IPROC_PCIE_CLK_CTRL, val);
245 * Select perst_b signal as reset source. Put the device into reset,
246 * and then bring it out of reset
248 val = iproc_pcie_read_reg(pcie, IPROC_PCIE_CLK_CTRL);
249 val &= ~EP_PERST_SOURCE_SELECT & ~EP_MODE_SURVIVE_PERST &
251 iproc_pcie_write_reg(pcie, IPROC_PCIE_CLK_CTRL, val);
254 val |= RC_PCIE_RST_OUTPUT;
255 iproc_pcie_write_reg(pcie, IPROC_PCIE_CLK_CTRL, val);
259 static int iproc_pcie_check_link(struct iproc_pcie *pcie, struct pci_bus *bus)
262 u32 link_ctrl, class, val;
263 u16 pos, link_status;
264 bool link_is_active = false;
267 * PAXC connects to emulated endpoint devices directly and does not
268 * have a Serdes. Therefore skip the link detection logic here.
270 if (pcie->type == IPROC_PCIE_PAXC)
273 val = iproc_pcie_read_reg(pcie, IPROC_PCIE_LINK_STATUS);
274 if (!(val & PCIE_PHYLINKUP) || !(val & PCIE_DL_ACTIVE)) {
275 dev_err(pcie->dev, "PHY or data link is INACTIVE!\n");
279 /* make sure we are not in EP mode */
280 pci_bus_read_config_byte(bus, 0, PCI_HEADER_TYPE, &hdr_type);
281 if ((hdr_type & 0x7f) != PCI_HEADER_TYPE_BRIDGE) {
282 dev_err(pcie->dev, "in EP mode, hdr=%#02x\n", hdr_type);
286 /* force class to PCI_CLASS_BRIDGE_PCI (0x0604) */
287 #define PCI_BRIDGE_CTRL_REG_OFFSET 0x43c
288 #define PCI_CLASS_BRIDGE_MASK 0xffff00
289 #define PCI_CLASS_BRIDGE_SHIFT 8
290 pci_bus_read_config_dword(bus, 0, PCI_BRIDGE_CTRL_REG_OFFSET, &class);
291 class &= ~PCI_CLASS_BRIDGE_MASK;
292 class |= (PCI_CLASS_BRIDGE_PCI << PCI_CLASS_BRIDGE_SHIFT);
293 pci_bus_write_config_dword(bus, 0, PCI_BRIDGE_CTRL_REG_OFFSET, class);
295 /* check link status to see if link is active */
296 pos = pci_bus_find_capability(bus, 0, PCI_CAP_ID_EXP);
297 pci_bus_read_config_word(bus, 0, pos + PCI_EXP_LNKSTA, &link_status);
298 if (link_status & PCI_EXP_LNKSTA_NLW)
299 link_is_active = true;
301 if (!link_is_active) {
302 /* try GEN 1 link speed */
303 #define PCI_LINK_STATUS_CTRL_2_OFFSET 0x0dc
304 #define PCI_TARGET_LINK_SPEED_MASK 0xf
305 #define PCI_TARGET_LINK_SPEED_GEN2 0x2
306 #define PCI_TARGET_LINK_SPEED_GEN1 0x1
307 pci_bus_read_config_dword(bus, 0,
308 PCI_LINK_STATUS_CTRL_2_OFFSET,
310 if ((link_ctrl & PCI_TARGET_LINK_SPEED_MASK) ==
311 PCI_TARGET_LINK_SPEED_GEN2) {
312 link_ctrl &= ~PCI_TARGET_LINK_SPEED_MASK;
313 link_ctrl |= PCI_TARGET_LINK_SPEED_GEN1;
314 pci_bus_write_config_dword(bus, 0,
315 PCI_LINK_STATUS_CTRL_2_OFFSET,
319 pos = pci_bus_find_capability(bus, 0, PCI_CAP_ID_EXP);
320 pci_bus_read_config_word(bus, 0, pos + PCI_EXP_LNKSTA,
322 if (link_status & PCI_EXP_LNKSTA_NLW)
323 link_is_active = true;
327 dev_info(pcie->dev, "link: %s\n", link_is_active ? "UP" : "DOWN");
329 return link_is_active ? 0 : -ENODEV;
332 static void iproc_pcie_enable(struct iproc_pcie *pcie)
334 iproc_pcie_write_reg(pcie, IPROC_PCIE_INTX_EN, SYS_RC_INTX_MASK);
338 * Some iProc SoCs require the SW to configure the outbound address mapping
340 * Outbound address translation:
342 * iproc_pcie_address = axi_address - axi_offset
343 * OARR = iproc_pcie_address
346 * axi_addr -> iproc_pcie_address -> OARR -> OMAP -> pci_address
348 static int iproc_pcie_setup_ob(struct iproc_pcie *pcie, u64 axi_addr,
349 u64 pci_addr, resource_size_t size)
351 struct iproc_pcie_ob *ob = &pcie->ob;
353 u64 max_size = (u64)ob->window_size * MAX_NUM_OB_WINDOWS;
356 if (size > max_size) {
358 "res size %pap exceeds max supported size 0x%llx\n",
363 div64_u64_rem(size, ob->window_size, &remainder);
366 "res size %pap needs to be multiple of window size %pap\n",
367 &size, &ob->window_size);
371 if (axi_addr < ob->axi_offset) {
373 "axi address %pap less than offset %pap\n",
374 &axi_addr, &ob->axi_offset);
379 * Translate the AXI address to the internal address used by the iProc
380 * PCIe core before programming the OARR
382 axi_addr -= ob->axi_offset;
384 for (i = 0; i < MAX_NUM_OB_WINDOWS; i++) {
385 iproc_pcie_ob_write(pcie, IPROC_PCIE_OARR_LO, i,
386 lower_32_bits(axi_addr) | OARR_VALID |
387 (ob->set_oarr_size ? 1 : 0));
388 iproc_pcie_ob_write(pcie, IPROC_PCIE_OARR_HI, i,
389 upper_32_bits(axi_addr));
390 iproc_pcie_ob_write(pcie, IPROC_PCIE_OMAP_LO, i,
391 lower_32_bits(pci_addr));
392 iproc_pcie_ob_write(pcie, IPROC_PCIE_OMAP_HI, i,
393 upper_32_bits(pci_addr));
395 size -= ob->window_size;
399 axi_addr += ob->window_size;
400 pci_addr += ob->window_size;
406 static int iproc_pcie_map_ranges(struct iproc_pcie *pcie,
407 struct list_head *resources)
409 struct resource_entry *window;
412 resource_list_for_each_entry(window, resources) {
413 struct resource *res = window->res;
414 u64 res_type = resource_type(res);
421 ret = iproc_pcie_setup_ob(pcie, res->start,
422 res->start - window->offset,
428 dev_err(pcie->dev, "invalid resource %pR\n", res);
436 static int iproc_pcie_msi_enable(struct iproc_pcie *pcie)
438 struct device_node *msi_node;
440 msi_node = of_parse_phandle(pcie->dev->of_node, "msi-parent", 0);
445 * If another MSI controller is being used, the call below should fail
448 return iproc_msi_init(pcie, msi_node);
451 static void iproc_pcie_msi_disable(struct iproc_pcie *pcie)
453 iproc_msi_exit(pcie);
456 int iproc_pcie_setup(struct iproc_pcie *pcie, struct list_head *res)
462 if (!pcie || !pcie->dev || !pcie->base)
465 ret = phy_init(pcie->phy);
467 dev_err(pcie->dev, "unable to initialize PCIe PHY\n");
471 ret = phy_power_on(pcie->phy);
473 dev_err(pcie->dev, "unable to power on PCIe PHY\n");
477 switch (pcie->type) {
478 case IPROC_PCIE_PAXB:
479 pcie->reg_offsets = iproc_pcie_reg_paxb;
481 case IPROC_PCIE_PAXC:
482 pcie->reg_offsets = iproc_pcie_reg_paxc;
485 dev_err(pcie->dev, "incompatible iProc PCIe interface\n");
487 goto err_power_off_phy;
490 iproc_pcie_reset(pcie);
492 if (pcie->need_ob_cfg) {
493 ret = iproc_pcie_map_ranges(pcie, res);
495 dev_err(pcie->dev, "map failed\n");
496 goto err_power_off_phy;
501 pcie->sysdata.private_data = pcie;
502 sysdata = &pcie->sysdata;
507 bus = pci_create_root_bus(pcie->dev, 0, &iproc_pcie_ops, sysdata, res);
509 dev_err(pcie->dev, "unable to create PCI root bus\n");
511 goto err_power_off_phy;
513 pcie->root_bus = bus;
515 ret = iproc_pcie_check_link(pcie, bus);
517 dev_err(pcie->dev, "no PCIe EP device detected\n");
518 goto err_rm_root_bus;
521 iproc_pcie_enable(pcie);
523 if (IS_ENABLED(CONFIG_PCI_MSI))
524 if (iproc_pcie_msi_enable(pcie))
525 dev_info(pcie->dev, "not using iProc MSI\n");
527 pci_scan_child_bus(bus);
528 pci_assign_unassigned_bus_resources(bus);
529 pci_fixup_irqs(pci_common_swizzle, pcie->map_irq);
530 pci_bus_add_devices(bus);
535 pci_stop_root_bus(bus);
536 pci_remove_root_bus(bus);
539 phy_power_off(pcie->phy);
544 EXPORT_SYMBOL(iproc_pcie_setup);
546 int iproc_pcie_remove(struct iproc_pcie *pcie)
548 pci_stop_root_bus(pcie->root_bus);
549 pci_remove_root_bus(pcie->root_bus);
551 iproc_pcie_msi_disable(pcie);
553 phy_power_off(pcie->phy);
558 EXPORT_SYMBOL(iproc_pcie_remove);
560 MODULE_AUTHOR("Ray Jui <rjui@broadcom.com>");
561 MODULE_DESCRIPTION("Broadcom iPROC PCIe common driver");
562 MODULE_LICENSE("GPL v2");