1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * PCIe controller driver for Intel Keem Bay 4 * Copyright (C) 2020 Intel Corporation 5 */ 6 7 #include <linux/bitfield.h> 8 #include <linux/bits.h> 9 #include <linux/clk.h> 10 #include <linux/delay.h> 11 #include <linux/err.h> 12 #include <linux/gpio/consumer.h> 13 #include <linux/init.h> 14 #include <linux/iopoll.h> 15 #include <linux/irqchip/chained_irq.h> 16 #include <linux/kernel.h> 17 #include <linux/mod_devicetable.h> 18 #include <linux/pci.h> 19 #include <linux/platform_device.h> 20 #include <linux/property.h> 21 22 #include "pcie-designware.h" 23 24 /* PCIE_REGS_APB_SLV Registers */ 25 #define PCIE_REGS_PCIE_CFG 0x0004 26 #define PCIE_DEVICE_TYPE BIT(8) 27 #define PCIE_RSTN BIT(0) 28 #define PCIE_REGS_PCIE_APP_CNTRL 0x0008 29 #define APP_LTSSM_ENABLE BIT(0) 30 #define PCIE_REGS_INTERRUPT_ENABLE 0x0028 31 #define MSI_CTRL_INT_EN BIT(8) 32 #define EDMA_INT_EN GENMASK(7, 0) 33 #define PCIE_REGS_INTERRUPT_STATUS 0x002c 34 #define MSI_CTRL_INT BIT(8) 35 #define PCIE_REGS_PCIE_SII_PM_STATE 0x00b0 36 #define SMLH_LINK_UP BIT(19) 37 #define RDLH_LINK_UP BIT(8) 38 #define PCIE_REGS_PCIE_SII_LINK_UP (SMLH_LINK_UP | RDLH_LINK_UP) 39 #define PCIE_REGS_PCIE_PHY_CNTL 0x0164 40 #define PHY0_SRAM_BYPASS BIT(8) 41 #define PCIE_REGS_PCIE_PHY_STAT 0x0168 42 #define PHY0_MPLLA_STATE BIT(1) 43 #define PCIE_REGS_LJPLL_STA 0x016c 44 #define LJPLL_LOCK BIT(0) 45 #define PCIE_REGS_LJPLL_CNTRL_0 0x0170 46 #define LJPLL_EN BIT(29) 47 #define LJPLL_FOUT_EN GENMASK(24, 21) 48 #define PCIE_REGS_LJPLL_CNTRL_2 0x0178 49 #define LJPLL_REF_DIV GENMASK(17, 12) 50 #define LJPLL_FB_DIV GENMASK(11, 0) 51 #define PCIE_REGS_LJPLL_CNTRL_3 0x017c 52 #define LJPLL_POST_DIV3A GENMASK(24, 22) 53 #define LJPLL_POST_DIV2A GENMASK(18, 16) 54 55 #define PERST_DELAY_US 1000 56 #define AUX_CLK_RATE_HZ 24000000 57 58 struct keembay_pcie { 59 struct dw_pcie pci; 60 void __iomem *apb_base; 61 enum dw_pcie_device_mode mode; 62 63 struct clk *clk_master; 64 struct clk *clk_aux; 65 struct gpio_desc *reset; 66 }; 67 68 struct keembay_pcie_of_data { 69 enum dw_pcie_device_mode mode; 70 }; 71 72 static void keembay_ep_reset_assert(struct keembay_pcie *pcie) 73 { 74 gpiod_set_value_cansleep(pcie->reset, 1); 75 usleep_range(PERST_DELAY_US, PERST_DELAY_US + 500); 76 } 77 78 static void keembay_ep_reset_deassert(struct keembay_pcie *pcie) 79 { 80 /* 81 * Ensure that PERST# is asserted for a minimum of 100ms. 82 * 83 * For more details, refer to PCI Express Card Electromechanical 84 * Specification Revision 1.1, Table-2.4. 85 */ 86 msleep(100); 87 88 gpiod_set_value_cansleep(pcie->reset, 0); 89 usleep_range(PERST_DELAY_US, PERST_DELAY_US + 500); 90 } 91 92 static void keembay_pcie_ltssm_set(struct keembay_pcie *pcie, bool enable) 93 { 94 u32 val; 95 96 val = readl(pcie->apb_base + PCIE_REGS_PCIE_APP_CNTRL); 97 if (enable) 98 val |= APP_LTSSM_ENABLE; 99 else 100 val &= ~APP_LTSSM_ENABLE; 101 writel(val, pcie->apb_base + PCIE_REGS_PCIE_APP_CNTRL); 102 } 103 104 static int keembay_pcie_link_up(struct dw_pcie *pci) 105 { 106 struct keembay_pcie *pcie = dev_get_drvdata(pci->dev); 107 u32 val; 108 109 val = readl(pcie->apb_base + PCIE_REGS_PCIE_SII_PM_STATE); 110 111 return (val & PCIE_REGS_PCIE_SII_LINK_UP) == PCIE_REGS_PCIE_SII_LINK_UP; 112 } 113 114 static int keembay_pcie_start_link(struct dw_pcie *pci) 115 { 116 struct keembay_pcie *pcie = dev_get_drvdata(pci->dev); 117 u32 val; 118 int ret; 119 120 if (pcie->mode == DW_PCIE_EP_TYPE) 121 return 0; 122 123 keembay_pcie_ltssm_set(pcie, false); 124 125 ret = readl_poll_timeout(pcie->apb_base + PCIE_REGS_PCIE_PHY_STAT, 126 val, val & PHY0_MPLLA_STATE, 20, 127 500 * USEC_PER_MSEC); 128 if (ret) { 129 dev_err(pci->dev, "MPLLA is not locked\n"); 130 return ret; 131 } 132 133 keembay_pcie_ltssm_set(pcie, true); 134 135 return 0; 136 } 137 138 static void keembay_pcie_stop_link(struct dw_pcie *pci) 139 { 140 struct keembay_pcie *pcie = dev_get_drvdata(pci->dev); 141 142 keembay_pcie_ltssm_set(pcie, false); 143 } 144 145 static const struct dw_pcie_ops keembay_pcie_ops = { 146 .link_up = keembay_pcie_link_up, 147 .start_link = keembay_pcie_start_link, 148 .stop_link = keembay_pcie_stop_link, 149 }; 150 151 static inline void keembay_pcie_disable_clock(void *data) 152 { 153 struct clk *clk = data; 154 155 clk_disable_unprepare(clk); 156 } 157 158 static inline struct clk *keembay_pcie_probe_clock(struct device *dev, 159 const char *id, u64 rate) 160 { 161 struct clk *clk; 162 int ret; 163 164 clk = devm_clk_get(dev, id); 165 if (IS_ERR(clk)) 166 return clk; 167 168 if (rate) { 169 ret = clk_set_rate(clk, rate); 170 if (ret) 171 return ERR_PTR(ret); 172 } 173 174 ret = clk_prepare_enable(clk); 175 if (ret) 176 return ERR_PTR(ret); 177 178 ret = devm_add_action_or_reset(dev, keembay_pcie_disable_clock, clk); 179 if (ret) 180 return ERR_PTR(ret); 181 182 return clk; 183 } 184 185 static int keembay_pcie_probe_clocks(struct keembay_pcie *pcie) 186 { 187 struct dw_pcie *pci = &pcie->pci; 188 struct device *dev = pci->dev; 189 190 pcie->clk_master = keembay_pcie_probe_clock(dev, "master", 0); 191 if (IS_ERR(pcie->clk_master)) 192 return dev_err_probe(dev, PTR_ERR(pcie->clk_master), 193 "Failed to enable master clock"); 194 195 pcie->clk_aux = keembay_pcie_probe_clock(dev, "aux", AUX_CLK_RATE_HZ); 196 if (IS_ERR(pcie->clk_aux)) 197 return dev_err_probe(dev, PTR_ERR(pcie->clk_aux), 198 "Failed to enable auxiliary clock"); 199 200 return 0; 201 } 202 203 /* 204 * Initialize the internal PCIe PLL in Host mode. 205 * See the following sections in Keem Bay data book, 206 * (1) 6.4.6.1 PCIe Subsystem Example Initialization, 207 * (2) 6.8 PCIe Low Jitter PLL for Ref Clk Generation. 208 */ 209 static int keembay_pcie_pll_init(struct keembay_pcie *pcie) 210 { 211 struct dw_pcie *pci = &pcie->pci; 212 u32 val; 213 int ret; 214 215 val = FIELD_PREP(LJPLL_REF_DIV, 0) | FIELD_PREP(LJPLL_FB_DIV, 0x32); 216 writel(val, pcie->apb_base + PCIE_REGS_LJPLL_CNTRL_2); 217 218 val = FIELD_PREP(LJPLL_POST_DIV3A, 0x2) | 219 FIELD_PREP(LJPLL_POST_DIV2A, 0x2); 220 writel(val, pcie->apb_base + PCIE_REGS_LJPLL_CNTRL_3); 221 222 val = FIELD_PREP(LJPLL_EN, 0x1) | FIELD_PREP(LJPLL_FOUT_EN, 0xc); 223 writel(val, pcie->apb_base + PCIE_REGS_LJPLL_CNTRL_0); 224 225 ret = readl_poll_timeout(pcie->apb_base + PCIE_REGS_LJPLL_STA, 226 val, val & LJPLL_LOCK, 20, 227 500 * USEC_PER_MSEC); 228 if (ret) 229 dev_err(pci->dev, "Low jitter PLL is not locked\n"); 230 231 return ret; 232 } 233 234 static void keembay_pcie_msi_irq_handler(struct irq_desc *desc) 235 { 236 struct keembay_pcie *pcie = irq_desc_get_handler_data(desc); 237 struct irq_chip *chip = irq_desc_get_chip(desc); 238 u32 val, mask, status; 239 struct dw_pcie_rp *pp; 240 241 /* 242 * Keem Bay PCIe Controller provides an additional IP logic on top of 243 * standard DWC IP to clear MSI IRQ by writing '1' to the respective 244 * bit of the status register. 245 * 246 * So, a chained irq handler is defined to handle this additional 247 * IP logic. 248 */ 249 250 chained_irq_enter(chip, desc); 251 252 pp = &pcie->pci.pp; 253 val = readl(pcie->apb_base + PCIE_REGS_INTERRUPT_STATUS); 254 mask = readl(pcie->apb_base + PCIE_REGS_INTERRUPT_ENABLE); 255 256 status = val & mask; 257 258 if (status & MSI_CTRL_INT) { 259 dw_handle_msi_irq(pp); 260 writel(status, pcie->apb_base + PCIE_REGS_INTERRUPT_STATUS); 261 } 262 263 chained_irq_exit(chip, desc); 264 } 265 266 static int keembay_pcie_setup_msi_irq(struct keembay_pcie *pcie) 267 { 268 struct dw_pcie *pci = &pcie->pci; 269 struct device *dev = pci->dev; 270 struct platform_device *pdev = to_platform_device(dev); 271 int irq; 272 273 irq = platform_get_irq_byname(pdev, "pcie"); 274 if (irq < 0) 275 return irq; 276 277 irq_set_chained_handler_and_data(irq, keembay_pcie_msi_irq_handler, 278 pcie); 279 280 return 0; 281 } 282 283 static void keembay_pcie_ep_init(struct dw_pcie_ep *ep) 284 { 285 struct dw_pcie *pci = to_dw_pcie_from_ep(ep); 286 struct keembay_pcie *pcie = dev_get_drvdata(pci->dev); 287 288 writel(EDMA_INT_EN, pcie->apb_base + PCIE_REGS_INTERRUPT_ENABLE); 289 } 290 291 static int keembay_pcie_ep_raise_irq(struct dw_pcie_ep *ep, u8 func_no, 292 enum pci_epc_irq_type type, 293 u16 interrupt_num) 294 { 295 struct dw_pcie *pci = to_dw_pcie_from_ep(ep); 296 297 switch (type) { 298 case PCI_EPC_IRQ_LEGACY: 299 /* Legacy interrupts are not supported in Keem Bay */ 300 dev_err(pci->dev, "Legacy IRQ is not supported\n"); 301 return -EINVAL; 302 case PCI_EPC_IRQ_MSI: 303 return dw_pcie_ep_raise_msi_irq(ep, func_no, interrupt_num); 304 case PCI_EPC_IRQ_MSIX: 305 return dw_pcie_ep_raise_msix_irq(ep, func_no, interrupt_num); 306 default: 307 dev_err(pci->dev, "Unknown IRQ type %d\n", type); 308 return -EINVAL; 309 } 310 } 311 312 static const struct pci_epc_features keembay_pcie_epc_features = { 313 .linkup_notifier = false, 314 .msi_capable = true, 315 .msix_capable = true, 316 .reserved_bar = BIT(BAR_1) | BIT(BAR_3) | BIT(BAR_5), 317 .bar_fixed_64bit = BIT(BAR_0) | BIT(BAR_2) | BIT(BAR_4), 318 .align = SZ_16K, 319 }; 320 321 static const struct pci_epc_features * 322 keembay_pcie_get_features(struct dw_pcie_ep *ep) 323 { 324 return &keembay_pcie_epc_features; 325 } 326 327 static const struct dw_pcie_ep_ops keembay_pcie_ep_ops = { 328 .ep_init = keembay_pcie_ep_init, 329 .raise_irq = keembay_pcie_ep_raise_irq, 330 .get_features = keembay_pcie_get_features, 331 }; 332 333 static const struct dw_pcie_host_ops keembay_pcie_host_ops = { 334 }; 335 336 static int keembay_pcie_add_pcie_port(struct keembay_pcie *pcie, 337 struct platform_device *pdev) 338 { 339 struct dw_pcie *pci = &pcie->pci; 340 struct dw_pcie_rp *pp = &pci->pp; 341 struct device *dev = &pdev->dev; 342 u32 val; 343 int ret; 344 345 pp->ops = &keembay_pcie_host_ops; 346 pp->msi_irq[0] = -ENODEV; 347 348 ret = keembay_pcie_setup_msi_irq(pcie); 349 if (ret) 350 return ret; 351 352 pcie->reset = devm_gpiod_get(dev, "reset", GPIOD_OUT_HIGH); 353 if (IS_ERR(pcie->reset)) 354 return PTR_ERR(pcie->reset); 355 356 ret = keembay_pcie_probe_clocks(pcie); 357 if (ret) 358 return ret; 359 360 val = readl(pcie->apb_base + PCIE_REGS_PCIE_PHY_CNTL); 361 val |= PHY0_SRAM_BYPASS; 362 writel(val, pcie->apb_base + PCIE_REGS_PCIE_PHY_CNTL); 363 364 writel(PCIE_DEVICE_TYPE, pcie->apb_base + PCIE_REGS_PCIE_CFG); 365 366 ret = keembay_pcie_pll_init(pcie); 367 if (ret) 368 return ret; 369 370 val = readl(pcie->apb_base + PCIE_REGS_PCIE_CFG); 371 writel(val | PCIE_RSTN, pcie->apb_base + PCIE_REGS_PCIE_CFG); 372 keembay_ep_reset_deassert(pcie); 373 374 ret = dw_pcie_host_init(pp); 375 if (ret) { 376 keembay_ep_reset_assert(pcie); 377 dev_err(dev, "Failed to initialize host: %d\n", ret); 378 return ret; 379 } 380 381 val = readl(pcie->apb_base + PCIE_REGS_INTERRUPT_ENABLE); 382 if (IS_ENABLED(CONFIG_PCI_MSI)) 383 val |= MSI_CTRL_INT_EN; 384 writel(val, pcie->apb_base + PCIE_REGS_INTERRUPT_ENABLE); 385 386 return 0; 387 } 388 389 static int keembay_pcie_probe(struct platform_device *pdev) 390 { 391 const struct keembay_pcie_of_data *data; 392 struct device *dev = &pdev->dev; 393 struct keembay_pcie *pcie; 394 struct dw_pcie *pci; 395 enum dw_pcie_device_mode mode; 396 397 data = device_get_match_data(dev); 398 if (!data) 399 return -ENODEV; 400 401 mode = (enum dw_pcie_device_mode)data->mode; 402 403 pcie = devm_kzalloc(dev, sizeof(*pcie), GFP_KERNEL); 404 if (!pcie) 405 return -ENOMEM; 406 407 pci = &pcie->pci; 408 pci->dev = dev; 409 pci->ops = &keembay_pcie_ops; 410 411 pcie->mode = mode; 412 413 pcie->apb_base = devm_platform_ioremap_resource_byname(pdev, "apb"); 414 if (IS_ERR(pcie->apb_base)) 415 return PTR_ERR(pcie->apb_base); 416 417 platform_set_drvdata(pdev, pcie); 418 419 switch (pcie->mode) { 420 case DW_PCIE_RC_TYPE: 421 if (!IS_ENABLED(CONFIG_PCIE_KEEMBAY_HOST)) 422 return -ENODEV; 423 424 return keembay_pcie_add_pcie_port(pcie, pdev); 425 case DW_PCIE_EP_TYPE: 426 if (!IS_ENABLED(CONFIG_PCIE_KEEMBAY_EP)) 427 return -ENODEV; 428 429 pci->ep.ops = &keembay_pcie_ep_ops; 430 return dw_pcie_ep_init(&pci->ep); 431 default: 432 dev_err(dev, "Invalid device type %d\n", pcie->mode); 433 return -ENODEV; 434 } 435 } 436 437 static const struct keembay_pcie_of_data keembay_pcie_rc_of_data = { 438 .mode = DW_PCIE_RC_TYPE, 439 }; 440 441 static const struct keembay_pcie_of_data keembay_pcie_ep_of_data = { 442 .mode = DW_PCIE_EP_TYPE, 443 }; 444 445 static const struct of_device_id keembay_pcie_of_match[] = { 446 { 447 .compatible = "intel,keembay-pcie", 448 .data = &keembay_pcie_rc_of_data, 449 }, 450 { 451 .compatible = "intel,keembay-pcie-ep", 452 .data = &keembay_pcie_ep_of_data, 453 }, 454 {} 455 }; 456 457 static struct platform_driver keembay_pcie_driver = { 458 .driver = { 459 .name = "keembay-pcie", 460 .of_match_table = keembay_pcie_of_match, 461 .suppress_bind_attrs = true, 462 }, 463 .probe = keembay_pcie_probe, 464 }; 465 builtin_platform_driver(keembay_pcie_driver); 466