1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * FU740 DesignWare PCIe Controller integration
4 * Copyright (C) 2019-2021 SiFive, Inc.
5 * Paul Walmsley
6 * Greentime Hu
7 *
8 * Based in part on the i.MX6 PCIe host controller shim which is:
9 *
10 * Copyright (C) 2013 Kosagi
11 * https://www.kosagi.com
12 */
13
14 #include <linux/clk.h>
15 #include <linux/delay.h>
16 #include <linux/gpio.h>
17 #include <linux/gpio/consumer.h>
18 #include <linux/kernel.h>
19 #include <linux/module.h>
20 #include <linux/pci.h>
21 #include <linux/platform_device.h>
22 #include <linux/resource.h>
23 #include <linux/types.h>
24 #include <linux/interrupt.h>
25 #include <linux/iopoll.h>
26 #include <linux/reset.h>
27
28 #include "pcie-designware.h"
29
30 #define to_fu740_pcie(x) dev_get_drvdata((x)->dev)
31
32 struct fu740_pcie {
33 struct dw_pcie pci;
34 void __iomem *mgmt_base;
35 struct gpio_desc *reset;
36 struct gpio_desc *pwren;
37 struct clk *pcie_aux;
38 struct reset_control *rst;
39 };
40
41 #define SIFIVE_DEVICESRESETREG 0x28
42
43 #define PCIEX8MGMT_PERST_N 0x0
44 #define PCIEX8MGMT_APP_LTSSM_ENABLE 0x10
45 #define PCIEX8MGMT_APP_HOLD_PHY_RST 0x18
46 #define PCIEX8MGMT_DEVICE_TYPE 0x708
47 #define PCIEX8MGMT_PHY0_CR_PARA_ADDR 0x860
48 #define PCIEX8MGMT_PHY0_CR_PARA_RD_EN 0x870
49 #define PCIEX8MGMT_PHY0_CR_PARA_RD_DATA 0x878
50 #define PCIEX8MGMT_PHY0_CR_PARA_SEL 0x880
51 #define PCIEX8MGMT_PHY0_CR_PARA_WR_DATA 0x888
52 #define PCIEX8MGMT_PHY0_CR_PARA_WR_EN 0x890
53 #define PCIEX8MGMT_PHY0_CR_PARA_ACK 0x898
54 #define PCIEX8MGMT_PHY1_CR_PARA_ADDR 0x8a0
55 #define PCIEX8MGMT_PHY1_CR_PARA_RD_EN 0x8b0
56 #define PCIEX8MGMT_PHY1_CR_PARA_RD_DATA 0x8b8
57 #define PCIEX8MGMT_PHY1_CR_PARA_SEL 0x8c0
58 #define PCIEX8MGMT_PHY1_CR_PARA_WR_DATA 0x8c8
59 #define PCIEX8MGMT_PHY1_CR_PARA_WR_EN 0x8d0
60 #define PCIEX8MGMT_PHY1_CR_PARA_ACK 0x8d8
61
62 #define PCIEX8MGMT_PHY_CDR_TRACK_EN BIT(0)
63 #define PCIEX8MGMT_PHY_LOS_THRSHLD BIT(5)
64 #define PCIEX8MGMT_PHY_TERM_EN BIT(9)
65 #define PCIEX8MGMT_PHY_TERM_ACDC BIT(10)
66 #define PCIEX8MGMT_PHY_EN BIT(11)
67 #define PCIEX8MGMT_PHY_INIT_VAL (PCIEX8MGMT_PHY_CDR_TRACK_EN|\
68 PCIEX8MGMT_PHY_LOS_THRSHLD|\
69 PCIEX8MGMT_PHY_TERM_EN|\
70 PCIEX8MGMT_PHY_TERM_ACDC|\
71 PCIEX8MGMT_PHY_EN)
72
73 #define PCIEX8MGMT_PHY_LANEN_DIG_ASIC_RX_OVRD_IN_3 0x1008
74 #define PCIEX8MGMT_PHY_LANE_OFF 0x100
75 #define PCIEX8MGMT_PHY_LANE0_BASE (PCIEX8MGMT_PHY_LANEN_DIG_ASIC_RX_OVRD_IN_3 + 0x100 * 0)
76 #define PCIEX8MGMT_PHY_LANE1_BASE (PCIEX8MGMT_PHY_LANEN_DIG_ASIC_RX_OVRD_IN_3 + 0x100 * 1)
77 #define PCIEX8MGMT_PHY_LANE2_BASE (PCIEX8MGMT_PHY_LANEN_DIG_ASIC_RX_OVRD_IN_3 + 0x100 * 2)
78 #define PCIEX8MGMT_PHY_LANE3_BASE (PCIEX8MGMT_PHY_LANEN_DIG_ASIC_RX_OVRD_IN_3 + 0x100 * 3)
79
fu740_pcie_assert_reset(struct fu740_pcie * afp)80 static void fu740_pcie_assert_reset(struct fu740_pcie *afp)
81 {
82 /* Assert PERST_N GPIO */
83 gpiod_set_value_cansleep(afp->reset, 0);
84 /* Assert controller PERST_N */
85 writel_relaxed(0x0, afp->mgmt_base + PCIEX8MGMT_PERST_N);
86 }
87
fu740_pcie_deassert_reset(struct fu740_pcie * afp)88 static void fu740_pcie_deassert_reset(struct fu740_pcie *afp)
89 {
90 /* Deassert controller PERST_N */
91 writel_relaxed(0x1, afp->mgmt_base + PCIEX8MGMT_PERST_N);
92 /* Deassert PERST_N GPIO */
93 gpiod_set_value_cansleep(afp->reset, 1);
94 }
95
fu740_pcie_power_on(struct fu740_pcie * afp)96 static void fu740_pcie_power_on(struct fu740_pcie *afp)
97 {
98 gpiod_set_value_cansleep(afp->pwren, 1);
99 /*
100 * Ensure that PERST has been asserted for at least 100 ms.
101 * Section 2.2 of PCI Express Card Electromechanical Specification
102 * Revision 3.0
103 */
104 msleep(100);
105 }
106
fu740_pcie_drive_reset(struct fu740_pcie * afp)107 static void fu740_pcie_drive_reset(struct fu740_pcie *afp)
108 {
109 fu740_pcie_assert_reset(afp);
110 fu740_pcie_power_on(afp);
111 fu740_pcie_deassert_reset(afp);
112 }
113
fu740_phyregwrite(const uint8_t phy,const uint16_t addr,const uint16_t wrdata,struct fu740_pcie * afp)114 static void fu740_phyregwrite(const uint8_t phy, const uint16_t addr,
115 const uint16_t wrdata, struct fu740_pcie *afp)
116 {
117 struct device *dev = afp->pci.dev;
118 void __iomem *phy_cr_para_addr;
119 void __iomem *phy_cr_para_wr_data;
120 void __iomem *phy_cr_para_wr_en;
121 void __iomem *phy_cr_para_ack;
122 int ret, val;
123
124 /* Setup */
125 if (phy) {
126 phy_cr_para_addr = afp->mgmt_base + PCIEX8MGMT_PHY1_CR_PARA_ADDR;
127 phy_cr_para_wr_data = afp->mgmt_base + PCIEX8MGMT_PHY1_CR_PARA_WR_DATA;
128 phy_cr_para_wr_en = afp->mgmt_base + PCIEX8MGMT_PHY1_CR_PARA_WR_EN;
129 phy_cr_para_ack = afp->mgmt_base + PCIEX8MGMT_PHY1_CR_PARA_ACK;
130 } else {
131 phy_cr_para_addr = afp->mgmt_base + PCIEX8MGMT_PHY0_CR_PARA_ADDR;
132 phy_cr_para_wr_data = afp->mgmt_base + PCIEX8MGMT_PHY0_CR_PARA_WR_DATA;
133 phy_cr_para_wr_en = afp->mgmt_base + PCIEX8MGMT_PHY0_CR_PARA_WR_EN;
134 phy_cr_para_ack = afp->mgmt_base + PCIEX8MGMT_PHY0_CR_PARA_ACK;
135 }
136
137 writel_relaxed(addr, phy_cr_para_addr);
138 writel_relaxed(wrdata, phy_cr_para_wr_data);
139 writel_relaxed(1, phy_cr_para_wr_en);
140
141 /* Wait for wait_idle */
142 ret = readl_poll_timeout(phy_cr_para_ack, val, val, 10, 5000);
143 if (ret)
144 dev_warn(dev, "Wait for wait_idle state failed!\n");
145
146 /* Clear */
147 writel_relaxed(0, phy_cr_para_wr_en);
148
149 /* Wait for ~wait_idle */
150 ret = readl_poll_timeout(phy_cr_para_ack, val, !val, 10, 5000);
151 if (ret)
152 dev_warn(dev, "Wait for !wait_idle state failed!\n");
153 }
154
fu740_pcie_init_phy(struct fu740_pcie * afp)155 static void fu740_pcie_init_phy(struct fu740_pcie *afp)
156 {
157 /* Enable phy cr_para_sel interfaces */
158 writel_relaxed(0x1, afp->mgmt_base + PCIEX8MGMT_PHY0_CR_PARA_SEL);
159 writel_relaxed(0x1, afp->mgmt_base + PCIEX8MGMT_PHY1_CR_PARA_SEL);
160
161 /*
162 * Wait 10 cr_para cycles to guarantee that the registers are ready
163 * to be edited.
164 */
165 ndelay(10);
166
167 /* Set PHY AC termination mode */
168 fu740_phyregwrite(0, PCIEX8MGMT_PHY_LANE0_BASE, PCIEX8MGMT_PHY_INIT_VAL, afp);
169 fu740_phyregwrite(0, PCIEX8MGMT_PHY_LANE1_BASE, PCIEX8MGMT_PHY_INIT_VAL, afp);
170 fu740_phyregwrite(0, PCIEX8MGMT_PHY_LANE2_BASE, PCIEX8MGMT_PHY_INIT_VAL, afp);
171 fu740_phyregwrite(0, PCIEX8MGMT_PHY_LANE3_BASE, PCIEX8MGMT_PHY_INIT_VAL, afp);
172 fu740_phyregwrite(1, PCIEX8MGMT_PHY_LANE0_BASE, PCIEX8MGMT_PHY_INIT_VAL, afp);
173 fu740_phyregwrite(1, PCIEX8MGMT_PHY_LANE1_BASE, PCIEX8MGMT_PHY_INIT_VAL, afp);
174 fu740_phyregwrite(1, PCIEX8MGMT_PHY_LANE2_BASE, PCIEX8MGMT_PHY_INIT_VAL, afp);
175 fu740_phyregwrite(1, PCIEX8MGMT_PHY_LANE3_BASE, PCIEX8MGMT_PHY_INIT_VAL, afp);
176 }
177
fu740_pcie_start_link(struct dw_pcie * pci)178 static int fu740_pcie_start_link(struct dw_pcie *pci)
179 {
180 struct device *dev = pci->dev;
181 struct fu740_pcie *afp = dev_get_drvdata(dev);
182 u8 cap_exp = dw_pcie_find_capability(pci, PCI_CAP_ID_EXP);
183 int ret;
184 u32 orig, tmp;
185
186 /*
187 * Force 2.5GT/s when starting the link, due to some devices not
188 * probing at higher speeds. This happens with the PCIe switch
189 * on the Unmatched board when U-Boot has not initialised the PCIe.
190 * The fix in U-Boot is to force 2.5GT/s, which then gets cleared
191 * by the soft reset done by this driver.
192 */
193 dev_dbg(dev, "cap_exp at %x\n", cap_exp);
194 dw_pcie_dbi_ro_wr_en(pci);
195
196 tmp = dw_pcie_readl_dbi(pci, cap_exp + PCI_EXP_LNKCAP);
197 orig = tmp & PCI_EXP_LNKCAP_SLS;
198 tmp &= ~PCI_EXP_LNKCAP_SLS;
199 tmp |= PCI_EXP_LNKCAP_SLS_2_5GB;
200 dw_pcie_writel_dbi(pci, cap_exp + PCI_EXP_LNKCAP, tmp);
201
202 /* Enable LTSSM */
203 writel_relaxed(0x1, afp->mgmt_base + PCIEX8MGMT_APP_LTSSM_ENABLE);
204
205 ret = dw_pcie_wait_for_link(pci);
206 if (ret) {
207 dev_err(dev, "error: link did not start\n");
208 goto err;
209 }
210
211 tmp = dw_pcie_readl_dbi(pci, cap_exp + PCI_EXP_LNKCAP);
212 if ((tmp & PCI_EXP_LNKCAP_SLS) != orig) {
213 dev_dbg(dev, "changing speed back to original\n");
214
215 tmp &= ~PCI_EXP_LNKCAP_SLS;
216 tmp |= orig;
217 dw_pcie_writel_dbi(pci, cap_exp + PCI_EXP_LNKCAP, tmp);
218
219 tmp = dw_pcie_readl_dbi(pci, PCIE_LINK_WIDTH_SPEED_CONTROL);
220 tmp |= PORT_LOGIC_SPEED_CHANGE;
221 dw_pcie_writel_dbi(pci, PCIE_LINK_WIDTH_SPEED_CONTROL, tmp);
222
223 ret = dw_pcie_wait_for_link(pci);
224 if (ret) {
225 dev_err(dev, "error: link did not start at new speed\n");
226 goto err;
227 }
228 }
229
230 ret = 0;
231 err:
232 WARN_ON(ret); /* we assume that errors will be very rare */
233 dw_pcie_dbi_ro_wr_dis(pci);
234 return ret;
235 }
236
fu740_pcie_host_init(struct dw_pcie_rp * pp)237 static int fu740_pcie_host_init(struct dw_pcie_rp *pp)
238 {
239 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
240 struct fu740_pcie *afp = to_fu740_pcie(pci);
241 struct device *dev = pci->dev;
242 int ret;
243
244 /* Power on reset */
245 fu740_pcie_drive_reset(afp);
246
247 /* Enable pcieauxclk */
248 ret = clk_prepare_enable(afp->pcie_aux);
249 if (ret) {
250 dev_err(dev, "unable to enable pcie_aux clock\n");
251 return ret;
252 }
253
254 /*
255 * Assert hold_phy_rst (hold the controller LTSSM in reset after
256 * power_up_rst_n for register programming with cr_para)
257 */
258 writel_relaxed(0x1, afp->mgmt_base + PCIEX8MGMT_APP_HOLD_PHY_RST);
259
260 /* Deassert power_up_rst_n */
261 ret = reset_control_deassert(afp->rst);
262 if (ret) {
263 dev_err(dev, "unable to deassert pcie_power_up_rst_n\n");
264 return ret;
265 }
266
267 fu740_pcie_init_phy(afp);
268
269 /* Disable pcieauxclk */
270 clk_disable_unprepare(afp->pcie_aux);
271 /* Clear hold_phy_rst */
272 writel_relaxed(0x0, afp->mgmt_base + PCIEX8MGMT_APP_HOLD_PHY_RST);
273 /* Enable pcieauxclk */
274 clk_prepare_enable(afp->pcie_aux);
275 /* Set RC mode */
276 writel_relaxed(0x4, afp->mgmt_base + PCIEX8MGMT_DEVICE_TYPE);
277
278 return 0;
279 }
280
281 static const struct dw_pcie_host_ops fu740_pcie_host_ops = {
282 .init = fu740_pcie_host_init,
283 };
284
285 static const struct dw_pcie_ops dw_pcie_ops = {
286 .start_link = fu740_pcie_start_link,
287 };
288
fu740_pcie_probe(struct platform_device * pdev)289 static int fu740_pcie_probe(struct platform_device *pdev)
290 {
291 struct device *dev = &pdev->dev;
292 struct dw_pcie *pci;
293 struct fu740_pcie *afp;
294
295 afp = devm_kzalloc(dev, sizeof(*afp), GFP_KERNEL);
296 if (!afp)
297 return -ENOMEM;
298 pci = &afp->pci;
299 pci->dev = dev;
300 pci->ops = &dw_pcie_ops;
301 pci->pp.ops = &fu740_pcie_host_ops;
302 pci->pp.num_vectors = MAX_MSI_IRQS;
303
304 /* SiFive specific region: mgmt */
305 afp->mgmt_base = devm_platform_ioremap_resource_byname(pdev, "mgmt");
306 if (IS_ERR(afp->mgmt_base))
307 return PTR_ERR(afp->mgmt_base);
308
309 /* Fetch GPIOs */
310 afp->reset = devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_LOW);
311 if (IS_ERR(afp->reset))
312 return dev_err_probe(dev, PTR_ERR(afp->reset), "unable to get reset-gpios\n");
313
314 afp->pwren = devm_gpiod_get_optional(dev, "pwren", GPIOD_OUT_LOW);
315 if (IS_ERR(afp->pwren))
316 return dev_err_probe(dev, PTR_ERR(afp->pwren), "unable to get pwren-gpios\n");
317
318 /* Fetch clocks */
319 afp->pcie_aux = devm_clk_get(dev, "pcie_aux");
320 if (IS_ERR(afp->pcie_aux))
321 return dev_err_probe(dev, PTR_ERR(afp->pcie_aux),
322 "pcie_aux clock source missing or invalid\n");
323
324 /* Fetch reset */
325 afp->rst = devm_reset_control_get_exclusive(dev, NULL);
326 if (IS_ERR(afp->rst))
327 return dev_err_probe(dev, PTR_ERR(afp->rst), "unable to get reset\n");
328
329 platform_set_drvdata(pdev, afp);
330
331 return dw_pcie_host_init(&pci->pp);
332 }
333
fu740_pcie_shutdown(struct platform_device * pdev)334 static void fu740_pcie_shutdown(struct platform_device *pdev)
335 {
336 struct fu740_pcie *afp = platform_get_drvdata(pdev);
337
338 /* Bring down link, so bootloader gets clean state in case of reboot */
339 fu740_pcie_assert_reset(afp);
340 }
341
342 static const struct of_device_id fu740_pcie_of_match[] = {
343 { .compatible = "sifive,fu740-pcie", },
344 {},
345 };
346
347 static struct platform_driver fu740_pcie_driver = {
348 .driver = {
349 .name = "fu740-pcie",
350 .of_match_table = fu740_pcie_of_match,
351 .suppress_bind_attrs = true,
352 },
353 .probe = fu740_pcie_probe,
354 .shutdown = fu740_pcie_shutdown,
355 };
356
357 builtin_platform_driver(fu740_pcie_driver);
358