1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * dwc3-imx8mp.c - NXP imx8mp Specific Glue layer 4 * 5 * Copyright (c) 2020 NXP. 6 */ 7 8 #include <linux/cleanup.h> 9 #include <linux/clk.h> 10 #include <linux/interrupt.h> 11 #include <linux/io.h> 12 #include <linux/kernel.h> 13 #include <linux/module.h> 14 #include <linux/of.h> 15 #include <linux/of_platform.h> 16 #include <linux/platform_device.h> 17 #include <linux/pm_runtime.h> 18 19 #include "core.h" 20 21 /* USB wakeup registers */ 22 #define USB_WAKEUP_CTRL 0x00 23 24 /* Global wakeup interrupt enable, also used to clear interrupt */ 25 #define USB_WAKEUP_EN BIT(31) 26 /* Wakeup from connect or disconnect, only for superspeed */ 27 #define USB_WAKEUP_SS_CONN BIT(5) 28 /* 0 select vbus_valid, 1 select sessvld */ 29 #define USB_WAKEUP_VBUS_SRC_SESS_VAL BIT(4) 30 /* Enable signal for wake up from u3 state */ 31 #define USB_WAKEUP_U3_EN BIT(3) 32 /* Enable signal for wake up from id change */ 33 #define USB_WAKEUP_ID_EN BIT(2) 34 /* Enable signal for wake up from vbus change */ 35 #define USB_WAKEUP_VBUS_EN BIT(1) 36 /* Enable signal for wake up from dp/dm change */ 37 #define USB_WAKEUP_DPDM_EN BIT(0) 38 39 #define USB_WAKEUP_EN_MASK GENMASK(5, 0) 40 41 /* USB glue registers */ 42 #define USB_CTRL0 0x00 43 #define USB_CTRL1 0x04 44 45 #define USB_CTRL0_PORTPWR_EN BIT(12) /* 1 - PPC enabled (default) */ 46 #define USB_CTRL0_USB3_FIXED BIT(22) /* 1 - USB3 permanent attached */ 47 #define USB_CTRL0_USB2_FIXED BIT(23) /* 1 - USB2 permanent attached */ 48 49 #define USB_CTRL1_OC_POLARITY BIT(16) /* 0 - HIGH / 1 - LOW */ 50 #define USB_CTRL1_PWR_POLARITY BIT(17) /* 0 - HIGH / 1 - LOW */ 51 52 struct dwc3_imx8mp { 53 struct device *dev; 54 struct platform_device *dwc3; 55 void __iomem *hsio_blk_base; 56 void __iomem *glue_base; 57 struct clk *hsio_clk; 58 struct clk *suspend_clk; 59 int irq; 60 bool pm_suspended; 61 bool wakeup_pending; 62 }; 63 imx8mp_configure_glue(struct dwc3_imx8mp * dwc3_imx)64 static void imx8mp_configure_glue(struct dwc3_imx8mp *dwc3_imx) 65 { 66 struct device *dev = dwc3_imx->dev; 67 u32 value; 68 69 if (!dwc3_imx->glue_base) 70 return; 71 72 value = readl(dwc3_imx->glue_base + USB_CTRL0); 73 74 if (device_property_read_bool(dev, "fsl,permanently-attached")) 75 value |= (USB_CTRL0_USB2_FIXED | USB_CTRL0_USB3_FIXED); 76 else 77 value &= ~(USB_CTRL0_USB2_FIXED | USB_CTRL0_USB3_FIXED); 78 79 if (device_property_read_bool(dev, "fsl,disable-port-power-control")) 80 value &= ~(USB_CTRL0_PORTPWR_EN); 81 else 82 value |= USB_CTRL0_PORTPWR_EN; 83 84 writel(value, dwc3_imx->glue_base + USB_CTRL0); 85 86 value = readl(dwc3_imx->glue_base + USB_CTRL1); 87 if (device_property_read_bool(dev, "fsl,over-current-active-low")) 88 value |= USB_CTRL1_OC_POLARITY; 89 else 90 value &= ~USB_CTRL1_OC_POLARITY; 91 92 if (device_property_read_bool(dev, "fsl,power-active-low")) 93 value |= USB_CTRL1_PWR_POLARITY; 94 else 95 value &= ~USB_CTRL1_PWR_POLARITY; 96 97 writel(value, dwc3_imx->glue_base + USB_CTRL1); 98 } 99 dwc3_imx8mp_wakeup_enable(struct dwc3_imx8mp * dwc3_imx,pm_message_t msg)100 static void dwc3_imx8mp_wakeup_enable(struct dwc3_imx8mp *dwc3_imx, 101 pm_message_t msg) 102 { 103 struct dwc3 *dwc3 = platform_get_drvdata(dwc3_imx->dwc3); 104 u32 val; 105 106 if (!dwc3) 107 return; 108 109 val = readl(dwc3_imx->hsio_blk_base + USB_WAKEUP_CTRL); 110 111 if ((dwc3->current_dr_role == DWC3_GCTL_PRTCAP_HOST) && dwc3->xhci) { 112 val |= USB_WAKEUP_EN | USB_WAKEUP_DPDM_EN; 113 if (PMSG_IS_AUTO(msg)) 114 val |= USB_WAKEUP_SS_CONN | USB_WAKEUP_U3_EN; 115 } else { 116 val |= USB_WAKEUP_EN | USB_WAKEUP_VBUS_EN | 117 USB_WAKEUP_VBUS_SRC_SESS_VAL; 118 } 119 120 writel(val, dwc3_imx->hsio_blk_base + USB_WAKEUP_CTRL); 121 } 122 dwc3_imx8mp_wakeup_disable(struct dwc3_imx8mp * dwc3_imx)123 static void dwc3_imx8mp_wakeup_disable(struct dwc3_imx8mp *dwc3_imx) 124 { 125 u32 val; 126 127 val = readl(dwc3_imx->hsio_blk_base + USB_WAKEUP_CTRL); 128 val &= ~(USB_WAKEUP_EN | USB_WAKEUP_EN_MASK); 129 writel(val, dwc3_imx->hsio_blk_base + USB_WAKEUP_CTRL); 130 } 131 dwc3_imx8mp_interrupt(int irq,void * _dwc3_imx)132 static irqreturn_t dwc3_imx8mp_interrupt(int irq, void *_dwc3_imx) 133 { 134 struct dwc3_imx8mp *dwc3_imx = _dwc3_imx; 135 struct dwc3 *dwc = platform_get_drvdata(dwc3_imx->dwc3); 136 137 if (!dwc3_imx->pm_suspended) 138 return IRQ_HANDLED; 139 140 disable_irq_nosync(dwc3_imx->irq); 141 dwc3_imx->wakeup_pending = true; 142 143 if ((dwc->current_dr_role == DWC3_GCTL_PRTCAP_HOST) && dwc->xhci) 144 pm_runtime_resume(&dwc->xhci->dev); 145 else if (dwc->current_dr_role == DWC3_GCTL_PRTCAP_DEVICE) 146 pm_runtime_get(dwc->dev); 147 148 return IRQ_HANDLED; 149 } 150 dwc3_imx8mp_set_software_node(struct device * dev)151 static int dwc3_imx8mp_set_software_node(struct device *dev) 152 { 153 struct property_entry props[3] = { 0 }; 154 int prop_idx = 0; 155 156 props[prop_idx++] = PROPERTY_ENTRY_BOOL("xhci-missing-cas-quirk"); 157 props[prop_idx++] = PROPERTY_ENTRY_BOOL("xhci-skip-phy-init-quirk"); 158 159 return device_create_managed_software_node(dev, props, NULL); 160 } 161 dwc3_imx8mp_probe(struct platform_device * pdev)162 static int dwc3_imx8mp_probe(struct platform_device *pdev) 163 { 164 struct device *dev = &pdev->dev; 165 struct device_node *node = dev->of_node; 166 struct dwc3_imx8mp *dwc3_imx; 167 struct resource *res; 168 int err, irq; 169 170 if (!node) { 171 dev_err(dev, "device node not found\n"); 172 return -EINVAL; 173 } 174 175 dwc3_imx = devm_kzalloc(dev, sizeof(*dwc3_imx), GFP_KERNEL); 176 if (!dwc3_imx) 177 return -ENOMEM; 178 179 platform_set_drvdata(pdev, dwc3_imx); 180 181 dwc3_imx->dev = dev; 182 183 dwc3_imx->hsio_blk_base = devm_platform_ioremap_resource(pdev, 0); 184 if (IS_ERR(dwc3_imx->hsio_blk_base)) 185 return PTR_ERR(dwc3_imx->hsio_blk_base); 186 187 res = platform_get_resource(pdev, IORESOURCE_MEM, 1); 188 if (!res) { 189 dev_warn(dev, "Base address for glue layer missing. Continuing without, some features are missing though."); 190 } else { 191 dwc3_imx->glue_base = devm_ioremap_resource(dev, res); 192 if (IS_ERR(dwc3_imx->glue_base)) 193 return PTR_ERR(dwc3_imx->glue_base); 194 } 195 196 dwc3_imx->hsio_clk = devm_clk_get_enabled(dev, "hsio"); 197 if (IS_ERR(dwc3_imx->hsio_clk)) 198 return dev_err_probe(dev, PTR_ERR(dwc3_imx->hsio_clk), 199 "Failed to get hsio clk\n"); 200 201 dwc3_imx->suspend_clk = devm_clk_get_enabled(dev, "suspend"); 202 if (IS_ERR(dwc3_imx->suspend_clk)) 203 return dev_err_probe(dev, PTR_ERR(dwc3_imx->suspend_clk), 204 "Failed to get suspend clk\n"); 205 206 irq = platform_get_irq(pdev, 0); 207 if (irq < 0) 208 return irq; 209 dwc3_imx->irq = irq; 210 211 struct device_node *dwc3_np __free(device_node) = of_get_compatible_child(node, 212 "snps,dwc3"); 213 if (!dwc3_np) 214 return dev_err_probe(dev, -ENODEV, "failed to find dwc3 core child\n"); 215 216 imx8mp_configure_glue(dwc3_imx); 217 218 pm_runtime_set_active(dev); 219 pm_runtime_enable(dev); 220 err = pm_runtime_get_sync(dev); 221 if (err < 0) 222 goto disable_rpm; 223 224 err = dwc3_imx8mp_set_software_node(dev); 225 if (err) { 226 err = -ENODEV; 227 dev_err(dev, "failed to create software node\n"); 228 goto disable_rpm; 229 } 230 231 err = of_platform_populate(node, NULL, NULL, dev); 232 if (err) { 233 dev_err(&pdev->dev, "failed to create dwc3 core\n"); 234 goto disable_rpm; 235 } 236 237 dwc3_imx->dwc3 = of_find_device_by_node(dwc3_np); 238 if (!dwc3_imx->dwc3) { 239 dev_err(dev, "failed to get dwc3 platform device\n"); 240 err = -ENODEV; 241 goto depopulate; 242 } 243 244 err = devm_request_threaded_irq(dev, irq, NULL, dwc3_imx8mp_interrupt, 245 IRQF_ONESHOT, dev_name(dev), dwc3_imx); 246 if (err) { 247 dev_err(dev, "failed to request IRQ #%d --> %d\n", irq, err); 248 goto depopulate; 249 } 250 251 device_set_wakeup_capable(dev, true); 252 pm_runtime_put(dev); 253 254 return 0; 255 256 depopulate: 257 of_platform_depopulate(dev); 258 disable_rpm: 259 pm_runtime_disable(dev); 260 pm_runtime_put_noidle(dev); 261 262 return err; 263 } 264 dwc3_imx8mp_remove(struct platform_device * pdev)265 static void dwc3_imx8mp_remove(struct platform_device *pdev) 266 { 267 struct device *dev = &pdev->dev; 268 269 pm_runtime_get_sync(dev); 270 of_platform_depopulate(dev); 271 272 pm_runtime_disable(dev); 273 pm_runtime_put_noidle(dev); 274 } 275 dwc3_imx8mp_suspend(struct dwc3_imx8mp * dwc3_imx,pm_message_t msg)276 static int dwc3_imx8mp_suspend(struct dwc3_imx8mp *dwc3_imx, pm_message_t msg) 277 { 278 if (dwc3_imx->pm_suspended) 279 return 0; 280 281 /* Wakeup enable */ 282 if (PMSG_IS_AUTO(msg) || device_may_wakeup(dwc3_imx->dev)) 283 dwc3_imx8mp_wakeup_enable(dwc3_imx, msg); 284 285 dwc3_imx->pm_suspended = true; 286 287 return 0; 288 } 289 dwc3_imx8mp_resume(struct dwc3_imx8mp * dwc3_imx,pm_message_t msg)290 static int dwc3_imx8mp_resume(struct dwc3_imx8mp *dwc3_imx, pm_message_t msg) 291 { 292 struct dwc3 *dwc = platform_get_drvdata(dwc3_imx->dwc3); 293 int ret = 0; 294 295 if (!dwc3_imx->pm_suspended) 296 return 0; 297 298 /* Wakeup disable */ 299 dwc3_imx8mp_wakeup_disable(dwc3_imx); 300 dwc3_imx->pm_suspended = false; 301 302 /* Upon power loss any previous configuration is lost, restore it */ 303 imx8mp_configure_glue(dwc3_imx); 304 305 if (dwc3_imx->wakeup_pending) { 306 dwc3_imx->wakeup_pending = false; 307 if (dwc->current_dr_role == DWC3_GCTL_PRTCAP_DEVICE) { 308 pm_runtime_mark_last_busy(dwc->dev); 309 pm_runtime_put_autosuspend(dwc->dev); 310 } else { 311 /* 312 * Add wait for xhci switch from suspend 313 * clock to normal clock to detect connection. 314 */ 315 usleep_range(9000, 10000); 316 } 317 enable_irq(dwc3_imx->irq); 318 } 319 320 return ret; 321 } 322 dwc3_imx8mp_pm_suspend(struct device * dev)323 static int dwc3_imx8mp_pm_suspend(struct device *dev) 324 { 325 struct dwc3_imx8mp *dwc3_imx = dev_get_drvdata(dev); 326 int ret; 327 328 ret = dwc3_imx8mp_suspend(dwc3_imx, PMSG_SUSPEND); 329 330 if (device_may_wakeup(dwc3_imx->dev)) 331 enable_irq_wake(dwc3_imx->irq); 332 else 333 clk_disable_unprepare(dwc3_imx->suspend_clk); 334 335 clk_disable_unprepare(dwc3_imx->hsio_clk); 336 dev_dbg(dev, "dwc3 imx8mp pm suspend.\n"); 337 338 return ret; 339 } 340 dwc3_imx8mp_pm_resume(struct device * dev)341 static int dwc3_imx8mp_pm_resume(struct device *dev) 342 { 343 struct dwc3_imx8mp *dwc3_imx = dev_get_drvdata(dev); 344 int ret; 345 346 if (device_may_wakeup(dwc3_imx->dev)) { 347 disable_irq_wake(dwc3_imx->irq); 348 } else { 349 ret = clk_prepare_enable(dwc3_imx->suspend_clk); 350 if (ret) 351 return ret; 352 } 353 354 ret = clk_prepare_enable(dwc3_imx->hsio_clk); 355 if (ret) { 356 clk_disable_unprepare(dwc3_imx->suspend_clk); 357 return ret; 358 } 359 360 ret = dwc3_imx8mp_resume(dwc3_imx, PMSG_RESUME); 361 362 pm_runtime_disable(dev); 363 pm_runtime_set_active(dev); 364 pm_runtime_enable(dev); 365 366 dev_dbg(dev, "dwc3 imx8mp pm resume.\n"); 367 368 return ret; 369 } 370 dwc3_imx8mp_runtime_suspend(struct device * dev)371 static int dwc3_imx8mp_runtime_suspend(struct device *dev) 372 { 373 struct dwc3_imx8mp *dwc3_imx = dev_get_drvdata(dev); 374 375 dev_dbg(dev, "dwc3 imx8mp runtime suspend.\n"); 376 377 return dwc3_imx8mp_suspend(dwc3_imx, PMSG_AUTO_SUSPEND); 378 } 379 dwc3_imx8mp_runtime_resume(struct device * dev)380 static int dwc3_imx8mp_runtime_resume(struct device *dev) 381 { 382 struct dwc3_imx8mp *dwc3_imx = dev_get_drvdata(dev); 383 384 dev_dbg(dev, "dwc3 imx8mp runtime resume.\n"); 385 386 return dwc3_imx8mp_resume(dwc3_imx, PMSG_AUTO_RESUME); 387 } 388 389 static const struct dev_pm_ops dwc3_imx8mp_dev_pm_ops = { 390 SYSTEM_SLEEP_PM_OPS(dwc3_imx8mp_pm_suspend, dwc3_imx8mp_pm_resume) 391 RUNTIME_PM_OPS(dwc3_imx8mp_runtime_suspend, dwc3_imx8mp_runtime_resume, 392 NULL) 393 }; 394 395 static const struct of_device_id dwc3_imx8mp_of_match[] = { 396 { .compatible = "fsl,imx8mp-dwc3", }, 397 {}, 398 }; 399 MODULE_DEVICE_TABLE(of, dwc3_imx8mp_of_match); 400 401 static struct platform_driver dwc3_imx8mp_driver = { 402 .probe = dwc3_imx8mp_probe, 403 .remove_new = dwc3_imx8mp_remove, 404 .driver = { 405 .name = "imx8mp-dwc3", 406 .pm = pm_ptr(&dwc3_imx8mp_dev_pm_ops), 407 .of_match_table = dwc3_imx8mp_of_match, 408 }, 409 }; 410 411 module_platform_driver(dwc3_imx8mp_driver); 412 413 MODULE_ALIAS("platform:imx8mp-dwc3"); 414 MODULE_AUTHOR("jun.li@nxp.com"); 415 MODULE_LICENSE("GPL v2"); 416 MODULE_DESCRIPTION("DesignWare USB3 imx8mp Glue Layer"); 417