diff mbox series

[v6,3/3] usb: cdns3: imx: add glue layer runtime pm implementation

Message ID 20200821024836.4472-4-peter.chen@nxp.com (mailing list archive)
State Superseded
Headers show
Series usb: cdns3: add runtime pm support | expand

Commit Message

Peter Chen Aug. 21, 2020, 2:48 a.m. UTC
Add imx glue layer runtime pm implementation, and the runtime
pm is default off.

Reviewed-by: Pawel Laszczak <pawell@cadence.com>
Signed-off-by: Peter Chen <peter.chen@nxp.com>
---
 drivers/usb/cdns3/cdns3-imx.c | 203 ++++++++++++++++++++++++++++++++--
 1 file changed, 192 insertions(+), 11 deletions(-)

Comments

kernel test robot Aug. 24, 2020, 2:24 p.m. UTC | #1
Hi Peter,

I love your patch! Perhaps something to improve:

[auto build test WARNING on usb/usb-testing]
[also build test WARNING on balbi-usb/testing/next shawnguo/for-next peter.chen-usb/ci-for-usb-next v5.9-rc2 next-20200824]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url:    https://github.com/0day-ci/linux/commits/Peter-Chen/usb-cdns3-add-runtime-pm-support/20200821-105133
base:   https://git.kernel.org/pub/scm/linux/kernel/git/gregkh/usb.git usb-testing
config: i386-randconfig-s002-20200824 (attached as .config)
compiler: gcc-9 (Debian 9.3.0-15) 9.3.0
reproduce:
        # apt-get install sparse
        # sparse version: v0.6.2-191-g10164920-dirty
        # save the attached .config to linux build tree
        make W=1 C=1 CF='-fdiagnostic-prefix -D__CHECK_ENDIAN__' ARCH=i386 

If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <lkp@intel.com>


sparse warnings: (new ones prefixed by >>)

>> drivers/usb/cdns3/cdns3-imx.c:256:35: sparse: sparse: incorrect type in initializer (different address spaces) @@     expected void [noderef] __iomem *otg_regs @@     got void * @@
>> drivers/usb/cdns3/cdns3-imx.c:256:35: sparse:     expected void [noderef] __iomem *otg_regs
>> drivers/usb/cdns3/cdns3-imx.c:256:35: sparse:     got void *

# https://github.com/0day-ci/linux/commit/7645672191d1842aa5744b38c0b8cc7df217dde3
git remote add linux-review https://github.com/0day-ci/linux
git fetch --no-tags linux-review Peter-Chen/usb-cdns3-add-runtime-pm-support/20200821-105133
git checkout 7645672191d1842aa5744b38c0b8cc7df217dde3
vim +256 drivers/usb/cdns3/cdns3-imx.c

   249	
   250	static int cdns_imx_platform_suspend(struct device *dev,
   251			bool suspend, bool wakeup)
   252	{
   253		struct cdns3 *cdns = dev_get_drvdata(dev);
   254		struct device *parent = dev->parent;
   255		struct cdns_imx *data = dev_get_drvdata(parent);
 > 256		void __iomem *otg_regs = (void *)(cdns->otg_regs);
   257		void __iomem *xhci_regs = cdns->xhci_regs;
   258		u32 value;
   259		int ret = 0;
   260	
   261		if (cdns->role != USB_ROLE_HOST)
   262			return 0;
   263	
   264		if (suspend) {
   265			/* SW request low power when all usb ports allow to it ??? */
   266			value = readl(xhci_regs + XECP_PM_PMCSR);
   267			value &= ~PS_MASK;
   268			value |= PS_D1;
   269			writel(value, xhci_regs + XECP_PM_PMCSR);
   270	
   271			/* mdctrl_clk_sel */
   272			value = cdns_imx_readl(data, USB3_CORE_CTRL1);
   273			value |= MDCTRL_CLK_SEL;
   274			cdns_imx_writel(data, USB3_CORE_CTRL1, value);
   275	
   276			/* wait for mdctrl_clk_status */
   277			value = cdns_imx_readl(data, USB3_CORE_STATUS);
   278			ret = readl_poll_timeout(data->noncore + USB3_CORE_STATUS, value,
   279				(value & MDCTRL_CLK_STATUS) == MDCTRL_CLK_STATUS,
   280				10, 100000);
   281			if (ret)
   282				dev_warn(parent, "wait mdctrl_clk_status timeout\n");
   283	
   284			/* wait lpm_clk_req to be 0 */
   285			value = cdns_imx_readl(data, USB3_INT_REG);
   286			ret = readl_poll_timeout(data->noncore + USB3_INT_REG, value,
   287				(value & LPM_CLK_REQ) != LPM_CLK_REQ,
   288				10, 100000);
   289			if (ret)
   290				dev_warn(parent, "wait lpm_clk_req timeout\n");
   291	
   292			/* wait phy_refclk_req to be 0 */
   293			value = cdns_imx_readl(data, USB3_SSPHY_STATUS);
   294			ret = readl_poll_timeout(data->noncore + USB3_SSPHY_STATUS, value,
   295				(value & PHY_REFCLK_REQ) != PHY_REFCLK_REQ,
   296				10, 100000);
   297			if (ret)
   298				dev_warn(parent, "wait phy_refclk_req timeout\n");
   299	
   300			cdns3_set_wakeup(data, wakeup);
   301		} else {
   302			cdns3_set_wakeup(data, false);
   303	
   304			/* SW request D0 */
   305			value = readl(xhci_regs + XECP_PM_PMCSR);
   306			value &= ~PS_MASK;
   307			value |= PS_D0;
   308			writel(value, xhci_regs + XECP_PM_PMCSR);
   309	
   310			/* clr CFG_RXDET_P3_EN */
   311			value = readl(xhci_regs + XECP_AUX_CTRL_REG1);
   312			value &= ~CFG_RXDET_P3_EN;
   313			writel(value, xhci_regs + XECP_AUX_CTRL_REG1);
   314	
   315			/* clear mdctrl_clk_sel */
   316			value = cdns_imx_readl(data, USB3_CORE_CTRL1);
   317			value &= ~MDCTRL_CLK_SEL;
   318			cdns_imx_writel(data, USB3_CORE_CTRL1, value);
   319	
   320			/* wait CLK_125_REQ to be 1 */
   321			value = cdns_imx_readl(data, USB3_INT_REG);
   322			ret = readl_poll_timeout(data->noncore + USB3_INT_REG, value,
   323				(value & CLK_125_REQ) == CLK_125_REQ,
   324				10, 100000);
   325			if (ret)
   326				dev_warn(parent, "wait CLK_125_REQ timeout\n");
   327	
   328			/* wait for mdctrl_clk_status is cleared */
   329			value = cdns_imx_readl(data, USB3_CORE_STATUS);
   330			ret = readl_poll_timeout(data->noncore + USB3_CORE_STATUS, value,
   331				(value & MDCTRL_CLK_STATUS) != MDCTRL_CLK_STATUS,
   332				10, 100000);
   333			if (ret)
   334				dev_warn(parent, "wait mdctrl_clk_status cleared timeout\n");
   335	
   336			/* Wait until OTG_NRDY is 0 */
   337			value = readl(otg_regs + OTGSTS);
   338			ret = readl_poll_timeout(otg_regs + OTGSTS, value,
   339				(value & OTG_NRDY) != OTG_NRDY,
   340				10, 100000);
   341			if (ret)
   342				dev_warn(parent, "wait OTG ready timeout\n");
   343		}
   344	
   345		return ret;
   346	

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all@lists.01.org
diff mbox series

Patch

diff --git a/drivers/usb/cdns3/cdns3-imx.c b/drivers/usb/cdns3/cdns3-imx.c
index aba988e71958..5d2a4e19fa83 100644
--- a/drivers/usb/cdns3/cdns3-imx.c
+++ b/drivers/usb/cdns3/cdns3-imx.c
@@ -15,6 +15,8 @@ 
 #include <linux/io.h>
 #include <linux/of_platform.h>
 #include <linux/iopoll.h>
+#include <linux/pm_runtime.h>
+#include "core.h"
 
 #define USB3_CORE_CTRL1    0x00
 #define USB3_CORE_CTRL2    0x04
@@ -32,7 +34,7 @@ 
 /* Register bits definition */
 
 /* USB3_CORE_CTRL1 */
-#define SW_RESET_MASK	(0x3f << 26)
+#define SW_RESET_MASK	GENMASK(31, 26)
 #define PWR_SW_RESET	BIT(31)
 #define APB_SW_RESET	BIT(30)
 #define AXI_SW_RESET	BIT(29)
@@ -44,17 +46,17 @@ 
 #define OC_DISABLE	BIT(9)
 #define MDCTRL_CLK_SEL	BIT(7)
 #define MODE_STRAP_MASK	(0x7)
-#define DEV_MODE	(1 << 2)
-#define HOST_MODE	(1 << 1)
-#define OTG_MODE	(1 << 0)
+#define DEV_MODE	BIT(2)
+#define HOST_MODE	BIT(1)
+#define OTG_MODE	BIT(0)
 
 /* USB3_INT_REG */
 #define CLK_125_REQ	BIT(29)
 #define LPM_CLK_REQ	BIT(28)
 #define DEVU3_WAEKUP_EN	BIT(14)
 #define OTG_WAKEUP_EN	BIT(12)
-#define DEV_INT_EN (3 << 8) /* DEV INT b9:8 */
-#define HOST_INT1_EN (1 << 0) /* HOST INT b7:0 */
+#define DEV_INT_EN	GENMASK(9, 8) /* DEV INT b9:8 */
+#define HOST_INT1_EN	BIT(0) /* HOST INT b7:0 */
 
 /* USB3_CORE_STATUS */
 #define MDCTRL_CLK_STATUS	BIT(15)
@@ -62,15 +64,34 @@ 
 #define HOST_POWER_ON_READY	BIT(12)
 
 /* USB3_SSPHY_STATUS */
-#define CLK_VALID_MASK		(0x3f << 26)
-#define CLK_VALID_COMPARE_BITS	(0xf << 28)
-#define PHY_REFCLK_REQ		(1 << 0)
+#define CLK_VALID_MASK		GENMASK(31, 26)
+#define CLK_VALID_COMPARE_BITS	GENMASK(31, 28)
+#define PHY_REFCLK_REQ		BIT(0)
+
+/* OTG registers definition */
+#define OTGSTS		0x4
+/* OTGSTS */
+#define OTG_NRDY	BIT(11)
+
+/* xHCI registers definition  */
+#define XECP_PM_PMCSR		0x8018
+#define XECP_AUX_CTRL_REG1	0x8120
+
+/* Register bits definition */
+/* XECP_AUX_CTRL_REG1 */
+#define CFG_RXDET_P3_EN		BIT(15)
+
+/* XECP_PM_PMCSR */
+#define PS_MASK			GENMASK(1, 0)
+#define PS_D0			0
+#define PS_D1			1
 
 struct cdns_imx {
 	struct device *dev;
 	void __iomem *noncore;
 	struct clk_bulk_data *clks;
 	int num_clks;
+	struct platform_device *cdns3_pdev;
 };
 
 static inline u32 cdns_imx_readl(struct cdns_imx *data, u32 offset)
@@ -126,6 +147,20 @@  static int cdns_imx_noncore_init(struct cdns_imx *data)
 	return ret;
 }
 
+static int cdns_imx_platform_suspend(struct device *dev,
+	bool suspend, bool wakeup);
+static struct cdns3_platform_data cdns_imx_pdata = {
+	.platform_suspend = cdns_imx_platform_suspend,
+};
+
+static struct of_dev_auxdata cdns_imx_auxdata[] = {
+	{
+	.compatible = "cdns,usb3",
+	.platform_data = &cdns_imx_pdata,
+	},
+	{},
+};
+
 static int cdns_imx_probe(struct platform_device *pdev)
 {
 	struct device *dev = &pdev->dev;
@@ -162,14 +197,18 @@  static int cdns_imx_probe(struct platform_device *pdev)
 	if (ret)
 		goto err;
 
-	ret = of_platform_populate(node, NULL, NULL, dev);
+	ret = of_platform_populate(node, NULL, cdns_imx_auxdata, dev);
 	if (ret) {
 		dev_err(dev, "failed to create children: %d\n", ret);
 		goto err;
 	}
 
-	return ret;
+	device_set_wakeup_capable(dev, true);
+	pm_runtime_set_active(dev);
+	pm_runtime_enable(dev);
+	pm_runtime_forbid(dev);
 
+	return ret;
 err:
 	clk_bulk_disable_unprepare(data->num_clks, data->clks);
 	return ret;
@@ -194,6 +233,147 @@  static int cdns_imx_remove(struct platform_device *pdev)
 	return 0;
 }
 
+#ifdef CONFIG_PM
+static void cdns3_set_wakeup(struct cdns_imx *data, bool enable)
+{
+	u32 value;
+
+	value = cdns_imx_readl(data, USB3_INT_REG);
+	if (enable)
+		value |= OTG_WAKEUP_EN | DEVU3_WAEKUP_EN;
+	else
+		value &= ~(OTG_WAKEUP_EN | DEVU3_WAEKUP_EN);
+
+	cdns_imx_writel(data, USB3_INT_REG, value);
+}
+
+static int cdns_imx_platform_suspend(struct device *dev,
+		bool suspend, bool wakeup)
+{
+	struct cdns3 *cdns = dev_get_drvdata(dev);
+	struct device *parent = dev->parent;
+	struct cdns_imx *data = dev_get_drvdata(parent);
+	void __iomem *otg_regs = (void *)(cdns->otg_regs);
+	void __iomem *xhci_regs = cdns->xhci_regs;
+	u32 value;
+	int ret = 0;
+
+	if (cdns->role != USB_ROLE_HOST)
+		return 0;
+
+	if (suspend) {
+		/* SW request low power when all usb ports allow to it ??? */
+		value = readl(xhci_regs + XECP_PM_PMCSR);
+		value &= ~PS_MASK;
+		value |= PS_D1;
+		writel(value, xhci_regs + XECP_PM_PMCSR);
+
+		/* mdctrl_clk_sel */
+		value = cdns_imx_readl(data, USB3_CORE_CTRL1);
+		value |= MDCTRL_CLK_SEL;
+		cdns_imx_writel(data, USB3_CORE_CTRL1, value);
+
+		/* wait for mdctrl_clk_status */
+		value = cdns_imx_readl(data, USB3_CORE_STATUS);
+		ret = readl_poll_timeout(data->noncore + USB3_CORE_STATUS, value,
+			(value & MDCTRL_CLK_STATUS) == MDCTRL_CLK_STATUS,
+			10, 100000);
+		if (ret)
+			dev_warn(parent, "wait mdctrl_clk_status timeout\n");
+
+		/* wait lpm_clk_req to be 0 */
+		value = cdns_imx_readl(data, USB3_INT_REG);
+		ret = readl_poll_timeout(data->noncore + USB3_INT_REG, value,
+			(value & LPM_CLK_REQ) != LPM_CLK_REQ,
+			10, 100000);
+		if (ret)
+			dev_warn(parent, "wait lpm_clk_req timeout\n");
+
+		/* wait phy_refclk_req to be 0 */
+		value = cdns_imx_readl(data, USB3_SSPHY_STATUS);
+		ret = readl_poll_timeout(data->noncore + USB3_SSPHY_STATUS, value,
+			(value & PHY_REFCLK_REQ) != PHY_REFCLK_REQ,
+			10, 100000);
+		if (ret)
+			dev_warn(parent, "wait phy_refclk_req timeout\n");
+
+		cdns3_set_wakeup(data, wakeup);
+	} else {
+		cdns3_set_wakeup(data, false);
+
+		/* SW request D0 */
+		value = readl(xhci_regs + XECP_PM_PMCSR);
+		value &= ~PS_MASK;
+		value |= PS_D0;
+		writel(value, xhci_regs + XECP_PM_PMCSR);
+
+		/* clr CFG_RXDET_P3_EN */
+		value = readl(xhci_regs + XECP_AUX_CTRL_REG1);
+		value &= ~CFG_RXDET_P3_EN;
+		writel(value, xhci_regs + XECP_AUX_CTRL_REG1);
+
+		/* clear mdctrl_clk_sel */
+		value = cdns_imx_readl(data, USB3_CORE_CTRL1);
+		value &= ~MDCTRL_CLK_SEL;
+		cdns_imx_writel(data, USB3_CORE_CTRL1, value);
+
+		/* wait CLK_125_REQ to be 1 */
+		value = cdns_imx_readl(data, USB3_INT_REG);
+		ret = readl_poll_timeout(data->noncore + USB3_INT_REG, value,
+			(value & CLK_125_REQ) == CLK_125_REQ,
+			10, 100000);
+		if (ret)
+			dev_warn(parent, "wait CLK_125_REQ timeout\n");
+
+		/* wait for mdctrl_clk_status is cleared */
+		value = cdns_imx_readl(data, USB3_CORE_STATUS);
+		ret = readl_poll_timeout(data->noncore + USB3_CORE_STATUS, value,
+			(value & MDCTRL_CLK_STATUS) != MDCTRL_CLK_STATUS,
+			10, 100000);
+		if (ret)
+			dev_warn(parent, "wait mdctrl_clk_status cleared timeout\n");
+
+		/* Wait until OTG_NRDY is 0 */
+		value = readl(otg_regs + OTGSTS);
+		ret = readl_poll_timeout(otg_regs + OTGSTS, value,
+			(value & OTG_NRDY) != OTG_NRDY,
+			10, 100000);
+		if (ret)
+			dev_warn(parent, "wait OTG ready timeout\n");
+	}
+
+	return ret;
+
+}
+
+static int cdns_imx_resume(struct device *dev)
+{
+	struct cdns_imx *data = dev_get_drvdata(dev);
+
+	return clk_bulk_prepare_enable(data->num_clks, data->clks);
+}
+
+static int cdns_imx_suspend(struct device *dev)
+{
+	struct cdns_imx *data = dev_get_drvdata(dev);
+
+	clk_bulk_disable_unprepare(data->num_clks, data->clks);
+
+	return 0;
+}
+#else
+static int cdns_imx_platform_suspend(struct device *dev,
+	bool suspend, bool wakeup)
+{
+	return 0;
+}
+
+#endif /* CONFIG_PM */
+
+static const struct dev_pm_ops cdns_imx_pm_ops = {
+	SET_RUNTIME_PM_OPS(cdns_imx_suspend, cdns_imx_resume, NULL)
+};
+
 static const struct of_device_id cdns_imx_of_match[] = {
 	{ .compatible = "fsl,imx8qm-usb3", },
 	{},
@@ -206,6 +386,7 @@  static struct platform_driver cdns_imx_driver = {
 	.driver		= {
 		.name	= "cdns3-imx",
 		.of_match_table	= cdns_imx_of_match,
+		.pm	= &cdns_imx_pm_ops,
 	},
 };
 module_platform_driver(cdns_imx_driver);