treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / drivers / pci / controller / dwc / pci-meson.c
blob3772b02a5c55deffcd10a6536f0e99f647b8c778
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * PCIe host controller driver for Amlogic MESON SoCs
5 * Copyright (c) 2018 Amlogic, inc.
6 * Author: Yue Wang <yue.wang@amlogic.com>
7 */
9 #include <linux/clk.h>
10 #include <linux/delay.h>
11 #include <linux/gpio/consumer.h>
12 #include <linux/of_device.h>
13 #include <linux/of_gpio.h>
14 #include <linux/pci.h>
15 #include <linux/platform_device.h>
16 #include <linux/reset.h>
17 #include <linux/resource.h>
18 #include <linux/types.h>
19 #include <linux/phy/phy.h>
21 #include "pcie-designware.h"
23 #define to_meson_pcie(x) dev_get_drvdata((x)->dev)
25 /* External local bus interface registers */
26 #define PLR_OFFSET 0x700
27 #define PCIE_PORT_LINK_CTRL_OFF (PLR_OFFSET + 0x10)
28 #define FAST_LINK_MODE BIT(7)
29 #define LINK_CAPABLE_MASK GENMASK(21, 16)
30 #define LINK_CAPABLE_X1 BIT(16)
32 #define PCIE_GEN2_CTRL_OFF (PLR_OFFSET + 0x10c)
33 #define NUM_OF_LANES_MASK GENMASK(12, 8)
34 #define NUM_OF_LANES_X1 BIT(8)
35 #define DIRECT_SPEED_CHANGE BIT(17)
37 #define TYPE1_HDR_OFFSET 0x0
38 #define PCIE_STATUS_COMMAND (TYPE1_HDR_OFFSET + 0x04)
39 #define PCI_IO_EN BIT(0)
40 #define PCI_MEM_SPACE_EN BIT(1)
41 #define PCI_BUS_MASTER_EN BIT(2)
43 #define PCIE_BASE_ADDR0 (TYPE1_HDR_OFFSET + 0x10)
44 #define PCIE_BASE_ADDR1 (TYPE1_HDR_OFFSET + 0x14)
46 #define PCIE_CAP_OFFSET 0x70
47 #define PCIE_DEV_CTRL_DEV_STUS (PCIE_CAP_OFFSET + 0x08)
48 #define PCIE_CAP_MAX_PAYLOAD_MASK GENMASK(7, 5)
49 #define PCIE_CAP_MAX_PAYLOAD_SIZE(x) ((x) << 5)
50 #define PCIE_CAP_MAX_READ_REQ_MASK GENMASK(14, 12)
51 #define PCIE_CAP_MAX_READ_REQ_SIZE(x) ((x) << 12)
53 /* PCIe specific config registers */
54 #define PCIE_CFG0 0x0
55 #define APP_LTSSM_ENABLE BIT(7)
57 #define PCIE_CFG_STATUS12 0x30
58 #define IS_SMLH_LINK_UP(x) ((x) & (1 << 6))
59 #define IS_RDLH_LINK_UP(x) ((x) & (1 << 16))
60 #define IS_LTSSM_UP(x) ((((x) >> 10) & 0x1f) == 0x11)
62 #define PCIE_CFG_STATUS17 0x44
63 #define PM_CURRENT_STATE(x) (((x) >> 7) & 0x1)
65 #define WAIT_LINKUP_TIMEOUT 4000
66 #define PORT_CLK_RATE 100000000UL
67 #define MAX_PAYLOAD_SIZE 256
68 #define MAX_READ_REQ_SIZE 256
69 #define MESON_PCIE_PHY_POWERUP 0x1c
70 #define PCIE_RESET_DELAY 500
71 #define PCIE_SHARED_RESET 1
72 #define PCIE_NORMAL_RESET 0
74 enum pcie_data_rate {
75 PCIE_GEN1,
76 PCIE_GEN2,
77 PCIE_GEN3,
78 PCIE_GEN4
81 struct meson_pcie_mem_res {
82 void __iomem *elbi_base;
83 void __iomem *cfg_base;
84 void __iomem *phy_base;
87 struct meson_pcie_clk_res {
88 struct clk *clk;
89 struct clk *mipi_gate;
90 struct clk *port_clk;
91 struct clk *general_clk;
94 struct meson_pcie_rc_reset {
95 struct reset_control *phy;
96 struct reset_control *port;
97 struct reset_control *apb;
100 struct meson_pcie_param {
101 bool has_shared_phy;
104 struct meson_pcie {
105 struct dw_pcie pci;
106 struct meson_pcie_mem_res mem_res;
107 struct meson_pcie_clk_res clk_res;
108 struct meson_pcie_rc_reset mrst;
109 struct gpio_desc *reset_gpio;
110 struct phy *phy;
111 const struct meson_pcie_param *param;
114 static struct reset_control *meson_pcie_get_reset(struct meson_pcie *mp,
115 const char *id,
116 u32 reset_type)
118 struct device *dev = mp->pci.dev;
119 struct reset_control *reset;
121 if (reset_type == PCIE_SHARED_RESET)
122 reset = devm_reset_control_get_shared(dev, id);
123 else
124 reset = devm_reset_control_get(dev, id);
126 return reset;
129 static int meson_pcie_get_resets(struct meson_pcie *mp)
131 struct meson_pcie_rc_reset *mrst = &mp->mrst;
133 if (!mp->param->has_shared_phy) {
134 mrst->phy = meson_pcie_get_reset(mp, "phy", PCIE_SHARED_RESET);
135 if (IS_ERR(mrst->phy))
136 return PTR_ERR(mrst->phy);
137 reset_control_deassert(mrst->phy);
140 mrst->port = meson_pcie_get_reset(mp, "port", PCIE_NORMAL_RESET);
141 if (IS_ERR(mrst->port))
142 return PTR_ERR(mrst->port);
143 reset_control_deassert(mrst->port);
145 mrst->apb = meson_pcie_get_reset(mp, "apb", PCIE_SHARED_RESET);
146 if (IS_ERR(mrst->apb))
147 return PTR_ERR(mrst->apb);
148 reset_control_deassert(mrst->apb);
150 return 0;
153 static void __iomem *meson_pcie_get_mem(struct platform_device *pdev,
154 struct meson_pcie *mp,
155 const char *id)
157 struct device *dev = mp->pci.dev;
158 struct resource *res;
160 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, id);
162 return devm_ioremap_resource(dev, res);
165 static void __iomem *meson_pcie_get_mem_shared(struct platform_device *pdev,
166 struct meson_pcie *mp,
167 const char *id)
169 struct device *dev = mp->pci.dev;
170 struct resource *res;
172 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, id);
173 if (!res) {
174 dev_err(dev, "No REG resource %s\n", id);
175 return ERR_PTR(-ENXIO);
178 return devm_ioremap(dev, res->start, resource_size(res));
181 static int meson_pcie_get_mems(struct platform_device *pdev,
182 struct meson_pcie *mp)
184 mp->mem_res.elbi_base = meson_pcie_get_mem(pdev, mp, "elbi");
185 if (IS_ERR(mp->mem_res.elbi_base))
186 return PTR_ERR(mp->mem_res.elbi_base);
188 mp->mem_res.cfg_base = meson_pcie_get_mem(pdev, mp, "cfg");
189 if (IS_ERR(mp->mem_res.cfg_base))
190 return PTR_ERR(mp->mem_res.cfg_base);
192 /* Meson AXG SoC has two PCI controllers use same phy register */
193 if (!mp->param->has_shared_phy) {
194 mp->mem_res.phy_base =
195 meson_pcie_get_mem_shared(pdev, mp, "phy");
196 if (IS_ERR(mp->mem_res.phy_base))
197 return PTR_ERR(mp->mem_res.phy_base);
200 return 0;
203 static int meson_pcie_power_on(struct meson_pcie *mp)
205 int ret = 0;
207 if (mp->param->has_shared_phy) {
208 ret = phy_init(mp->phy);
209 if (ret)
210 return ret;
212 ret = phy_power_on(mp->phy);
213 if (ret) {
214 phy_exit(mp->phy);
215 return ret;
217 } else
218 writel(MESON_PCIE_PHY_POWERUP, mp->mem_res.phy_base);
220 return 0;
223 static int meson_pcie_reset(struct meson_pcie *mp)
225 struct meson_pcie_rc_reset *mrst = &mp->mrst;
226 int ret = 0;
228 if (mp->param->has_shared_phy) {
229 ret = phy_reset(mp->phy);
230 if (ret)
231 return ret;
232 } else {
233 reset_control_assert(mrst->phy);
234 udelay(PCIE_RESET_DELAY);
235 reset_control_deassert(mrst->phy);
236 udelay(PCIE_RESET_DELAY);
239 reset_control_assert(mrst->port);
240 reset_control_assert(mrst->apb);
241 udelay(PCIE_RESET_DELAY);
242 reset_control_deassert(mrst->port);
243 reset_control_deassert(mrst->apb);
244 udelay(PCIE_RESET_DELAY);
246 return 0;
249 static inline struct clk *meson_pcie_probe_clock(struct device *dev,
250 const char *id, u64 rate)
252 struct clk *clk;
253 int ret;
255 clk = devm_clk_get(dev, id);
256 if (IS_ERR(clk))
257 return clk;
259 if (rate) {
260 ret = clk_set_rate(clk, rate);
261 if (ret) {
262 dev_err(dev, "set clk rate failed, ret = %d\n", ret);
263 return ERR_PTR(ret);
267 ret = clk_prepare_enable(clk);
268 if (ret) {
269 dev_err(dev, "couldn't enable clk\n");
270 return ERR_PTR(ret);
273 devm_add_action_or_reset(dev,
274 (void (*) (void *))clk_disable_unprepare,
275 clk);
277 return clk;
280 static int meson_pcie_probe_clocks(struct meson_pcie *mp)
282 struct device *dev = mp->pci.dev;
283 struct meson_pcie_clk_res *res = &mp->clk_res;
285 res->port_clk = meson_pcie_probe_clock(dev, "port", PORT_CLK_RATE);
286 if (IS_ERR(res->port_clk))
287 return PTR_ERR(res->port_clk);
289 if (!mp->param->has_shared_phy) {
290 res->mipi_gate = meson_pcie_probe_clock(dev, "mipi", 0);
291 if (IS_ERR(res->mipi_gate))
292 return PTR_ERR(res->mipi_gate);
295 res->general_clk = meson_pcie_probe_clock(dev, "general", 0);
296 if (IS_ERR(res->general_clk))
297 return PTR_ERR(res->general_clk);
299 res->clk = meson_pcie_probe_clock(dev, "pclk", 0);
300 if (IS_ERR(res->clk))
301 return PTR_ERR(res->clk);
303 return 0;
306 static inline void meson_elb_writel(struct meson_pcie *mp, u32 val, u32 reg)
308 writel(val, mp->mem_res.elbi_base + reg);
311 static inline u32 meson_elb_readl(struct meson_pcie *mp, u32 reg)
313 return readl(mp->mem_res.elbi_base + reg);
316 static inline u32 meson_cfg_readl(struct meson_pcie *mp, u32 reg)
318 return readl(mp->mem_res.cfg_base + reg);
321 static inline void meson_cfg_writel(struct meson_pcie *mp, u32 val, u32 reg)
323 writel(val, mp->mem_res.cfg_base + reg);
326 static void meson_pcie_assert_reset(struct meson_pcie *mp)
328 gpiod_set_value_cansleep(mp->reset_gpio, 1);
329 udelay(500);
330 gpiod_set_value_cansleep(mp->reset_gpio, 0);
333 static void meson_pcie_init_dw(struct meson_pcie *mp)
335 u32 val;
337 val = meson_cfg_readl(mp, PCIE_CFG0);
338 val |= APP_LTSSM_ENABLE;
339 meson_cfg_writel(mp, val, PCIE_CFG0);
341 val = meson_elb_readl(mp, PCIE_PORT_LINK_CTRL_OFF);
342 val &= ~LINK_CAPABLE_MASK;
343 meson_elb_writel(mp, val, PCIE_PORT_LINK_CTRL_OFF);
345 val = meson_elb_readl(mp, PCIE_PORT_LINK_CTRL_OFF);
346 val |= LINK_CAPABLE_X1 | FAST_LINK_MODE;
347 meson_elb_writel(mp, val, PCIE_PORT_LINK_CTRL_OFF);
349 val = meson_elb_readl(mp, PCIE_GEN2_CTRL_OFF);
350 val &= ~NUM_OF_LANES_MASK;
351 meson_elb_writel(mp, val, PCIE_GEN2_CTRL_OFF);
353 val = meson_elb_readl(mp, PCIE_GEN2_CTRL_OFF);
354 val |= NUM_OF_LANES_X1 | DIRECT_SPEED_CHANGE;
355 meson_elb_writel(mp, val, PCIE_GEN2_CTRL_OFF);
357 meson_elb_writel(mp, 0x0, PCIE_BASE_ADDR0);
358 meson_elb_writel(mp, 0x0, PCIE_BASE_ADDR1);
361 static int meson_size_to_payload(struct meson_pcie *mp, int size)
363 struct device *dev = mp->pci.dev;
366 * dwc supports 2^(val+7) payload size, which val is 0~5 default to 1.
367 * So if input size is not 2^order alignment or less than 2^7 or bigger
368 * than 2^12, just set to default size 2^(1+7).
370 if (!is_power_of_2(size) || size < 128 || size > 4096) {
371 dev_warn(dev, "payload size %d, set to default 256\n", size);
372 return 1;
375 return fls(size) - 8;
378 static void meson_set_max_payload(struct meson_pcie *mp, int size)
380 u32 val;
381 int max_payload_size = meson_size_to_payload(mp, size);
383 val = meson_elb_readl(mp, PCIE_DEV_CTRL_DEV_STUS);
384 val &= ~PCIE_CAP_MAX_PAYLOAD_MASK;
385 meson_elb_writel(mp, val, PCIE_DEV_CTRL_DEV_STUS);
387 val = meson_elb_readl(mp, PCIE_DEV_CTRL_DEV_STUS);
388 val |= PCIE_CAP_MAX_PAYLOAD_SIZE(max_payload_size);
389 meson_elb_writel(mp, val, PCIE_DEV_CTRL_DEV_STUS);
392 static void meson_set_max_rd_req_size(struct meson_pcie *mp, int size)
394 u32 val;
395 int max_rd_req_size = meson_size_to_payload(mp, size);
397 val = meson_elb_readl(mp, PCIE_DEV_CTRL_DEV_STUS);
398 val &= ~PCIE_CAP_MAX_READ_REQ_MASK;
399 meson_elb_writel(mp, val, PCIE_DEV_CTRL_DEV_STUS);
401 val = meson_elb_readl(mp, PCIE_DEV_CTRL_DEV_STUS);
402 val |= PCIE_CAP_MAX_READ_REQ_SIZE(max_rd_req_size);
403 meson_elb_writel(mp, val, PCIE_DEV_CTRL_DEV_STUS);
406 static inline void meson_enable_memory_space(struct meson_pcie *mp)
408 /* Set the RC Bus Master, Memory Space and I/O Space enables */
409 meson_elb_writel(mp, PCI_IO_EN | PCI_MEM_SPACE_EN | PCI_BUS_MASTER_EN,
410 PCIE_STATUS_COMMAND);
413 static int meson_pcie_establish_link(struct meson_pcie *mp)
415 struct dw_pcie *pci = &mp->pci;
416 struct pcie_port *pp = &pci->pp;
418 meson_pcie_init_dw(mp);
419 meson_set_max_payload(mp, MAX_PAYLOAD_SIZE);
420 meson_set_max_rd_req_size(mp, MAX_READ_REQ_SIZE);
422 dw_pcie_setup_rc(pp);
423 meson_enable_memory_space(mp);
425 meson_pcie_assert_reset(mp);
427 return dw_pcie_wait_for_link(pci);
430 static void meson_pcie_enable_interrupts(struct meson_pcie *mp)
432 if (IS_ENABLED(CONFIG_PCI_MSI))
433 dw_pcie_msi_init(&mp->pci.pp);
436 static int meson_pcie_rd_own_conf(struct pcie_port *pp, int where, int size,
437 u32 *val)
439 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
440 int ret;
442 ret = dw_pcie_read(pci->dbi_base + where, size, val);
443 if (ret != PCIBIOS_SUCCESSFUL)
444 return ret;
447 * There is a bug in the MESON AXG PCIe controller whereby software
448 * cannot program the PCI_CLASS_DEVICE register, so we must fabricate
449 * the return value in the config accessors.
451 if (where == PCI_CLASS_REVISION && size == 4)
452 *val = (PCI_CLASS_BRIDGE_PCI << 16) | (*val & 0xffff);
453 else if (where == PCI_CLASS_DEVICE && size == 2)
454 *val = PCI_CLASS_BRIDGE_PCI;
455 else if (where == PCI_CLASS_DEVICE && size == 1)
456 *val = PCI_CLASS_BRIDGE_PCI & 0xff;
457 else if (where == PCI_CLASS_DEVICE + 1 && size == 1)
458 *val = (PCI_CLASS_BRIDGE_PCI >> 8) & 0xff;
460 return PCIBIOS_SUCCESSFUL;
463 static int meson_pcie_wr_own_conf(struct pcie_port *pp, int where,
464 int size, u32 val)
466 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
468 return dw_pcie_write(pci->dbi_base + where, size, val);
471 static int meson_pcie_link_up(struct dw_pcie *pci)
473 struct meson_pcie *mp = to_meson_pcie(pci);
474 struct device *dev = pci->dev;
475 u32 speed_okay = 0;
476 u32 cnt = 0;
477 u32 state12, state17, smlh_up, ltssm_up, rdlh_up;
479 do {
480 state12 = meson_cfg_readl(mp, PCIE_CFG_STATUS12);
481 state17 = meson_cfg_readl(mp, PCIE_CFG_STATUS17);
482 smlh_up = IS_SMLH_LINK_UP(state12);
483 rdlh_up = IS_RDLH_LINK_UP(state12);
484 ltssm_up = IS_LTSSM_UP(state12);
486 if (PM_CURRENT_STATE(state17) < PCIE_GEN3)
487 speed_okay = 1;
489 if (smlh_up)
490 dev_dbg(dev, "smlh_link_up is on\n");
491 if (rdlh_up)
492 dev_dbg(dev, "rdlh_link_up is on\n");
493 if (ltssm_up)
494 dev_dbg(dev, "ltssm_up is on\n");
495 if (speed_okay)
496 dev_dbg(dev, "speed_okay\n");
498 if (smlh_up && rdlh_up && ltssm_up && speed_okay)
499 return 1;
501 cnt++;
503 udelay(10);
504 } while (cnt < WAIT_LINKUP_TIMEOUT);
506 dev_err(dev, "error: wait linkup timeout\n");
507 return 0;
510 static int meson_pcie_host_init(struct pcie_port *pp)
512 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
513 struct meson_pcie *mp = to_meson_pcie(pci);
514 int ret;
516 ret = meson_pcie_establish_link(mp);
517 if (ret)
518 return ret;
520 meson_pcie_enable_interrupts(mp);
522 return 0;
525 static const struct dw_pcie_host_ops meson_pcie_host_ops = {
526 .rd_own_conf = meson_pcie_rd_own_conf,
527 .wr_own_conf = meson_pcie_wr_own_conf,
528 .host_init = meson_pcie_host_init,
531 static int meson_add_pcie_port(struct meson_pcie *mp,
532 struct platform_device *pdev)
534 struct dw_pcie *pci = &mp->pci;
535 struct pcie_port *pp = &pci->pp;
536 struct device *dev = &pdev->dev;
537 int ret;
539 if (IS_ENABLED(CONFIG_PCI_MSI)) {
540 pp->msi_irq = platform_get_irq(pdev, 0);
541 if (pp->msi_irq < 0) {
542 dev_err(dev, "failed to get MSI IRQ\n");
543 return pp->msi_irq;
547 pp->ops = &meson_pcie_host_ops;
548 pci->dbi_base = mp->mem_res.elbi_base;
550 ret = dw_pcie_host_init(pp);
551 if (ret) {
552 dev_err(dev, "failed to initialize host\n");
553 return ret;
556 return 0;
559 static const struct dw_pcie_ops dw_pcie_ops = {
560 .link_up = meson_pcie_link_up,
563 static int meson_pcie_probe(struct platform_device *pdev)
565 const struct meson_pcie_param *match_data;
566 struct device *dev = &pdev->dev;
567 struct dw_pcie *pci;
568 struct meson_pcie *mp;
569 int ret;
571 mp = devm_kzalloc(dev, sizeof(*mp), GFP_KERNEL);
572 if (!mp)
573 return -ENOMEM;
575 pci = &mp->pci;
576 pci->dev = dev;
577 pci->ops = &dw_pcie_ops;
579 match_data = of_device_get_match_data(dev);
580 if (!match_data) {
581 dev_err(dev, "failed to get match data\n");
582 return -ENODEV;
584 mp->param = match_data;
586 if (mp->param->has_shared_phy) {
587 mp->phy = devm_phy_get(dev, "pcie");
588 if (IS_ERR(mp->phy))
589 return PTR_ERR(mp->phy);
592 mp->reset_gpio = devm_gpiod_get(dev, "reset", GPIOD_OUT_LOW);
593 if (IS_ERR(mp->reset_gpio)) {
594 dev_err(dev, "get reset gpio failed\n");
595 return PTR_ERR(mp->reset_gpio);
598 ret = meson_pcie_get_resets(mp);
599 if (ret) {
600 dev_err(dev, "get reset resource failed, %d\n", ret);
601 return ret;
604 ret = meson_pcie_get_mems(pdev, mp);
605 if (ret) {
606 dev_err(dev, "get memory resource failed, %d\n", ret);
607 return ret;
610 ret = meson_pcie_power_on(mp);
611 if (ret) {
612 dev_err(dev, "phy power on failed, %d\n", ret);
613 return ret;
616 ret = meson_pcie_reset(mp);
617 if (ret) {
618 dev_err(dev, "reset failed, %d\n", ret);
619 goto err_phy;
622 ret = meson_pcie_probe_clocks(mp);
623 if (ret) {
624 dev_err(dev, "init clock resources failed, %d\n", ret);
625 goto err_phy;
628 platform_set_drvdata(pdev, mp);
630 ret = meson_add_pcie_port(mp, pdev);
631 if (ret < 0) {
632 dev_err(dev, "Add PCIe port failed, %d\n", ret);
633 goto err_phy;
636 return 0;
638 err_phy:
639 if (mp->param->has_shared_phy) {
640 phy_power_off(mp->phy);
641 phy_exit(mp->phy);
644 return ret;
647 static struct meson_pcie_param meson_pcie_axg_param = {
648 .has_shared_phy = false,
651 static struct meson_pcie_param meson_pcie_g12a_param = {
652 .has_shared_phy = true,
655 static const struct of_device_id meson_pcie_of_match[] = {
657 .compatible = "amlogic,axg-pcie",
658 .data = &meson_pcie_axg_param,
661 .compatible = "amlogic,g12a-pcie",
662 .data = &meson_pcie_g12a_param,
667 static struct platform_driver meson_pcie_driver = {
668 .probe = meson_pcie_probe,
669 .driver = {
670 .name = "meson-pcie",
671 .of_match_table = meson_pcie_of_match,
675 builtin_platform_driver(meson_pcie_driver);