usb: ChipIdea: add Nuvoton NPCM UDC support

Add a compatible string for Nuvoton BMC NPCM750 and Nuvoton BMC NPCM845.

Signed-off-by Tomer Maimon <[email protected]>

---

Quoted 4 lines · Tomer Maimon

Add a compatible string for Nuvoton BMC NPCM750 and Nuvoton BMC NPCM845.

Signed-off-by Tomer Maimon <[email protected]>

---

Please use scripts/get_maintainers.pl to get a list of necessary people and lists to CC. It might happen, that command when run on an older kernel, gives you outdated entries. Therefore please be sure you base your patches on recent Linux kernel.

You missed at least devicetree list (maybe more), so this won't be tested by automated tooling. Performing review on untested code might be a waste of time, thus I will skip this patch entirely till you follow the process allowing the patch to be tested.

Please kindly resend and include all necessary To/Cc entries.

Best regards,
Krzysztof

Add Nuvoton NPCM BMC SoCs support to USB ChipIdea driver. NPCM SoC include ChipIdea IP block that used for USB device controller

mode.

Signed-off-by Tomer Maimon <[email protected]>

Acked-by Peter Chen <[email protected]>

---
  drivers/usb/chipidea/Kconfig        |   4 +
  drivers/usb/chipidea/Makefile       |   1 +
  drivers/usb/chipidea/ci_hdrc_npcm.c | 114 ++++++++++++++++++++++++++++
  3 files changed, 119 insertions(+)

create mode 100644 drivers/usb/chipidea/ci_hdrc_npcm.c

drivers/usb/chipidea/Kconfig +4 -0

index c815824a0b2d..bab45bc62361 100644
@@ -43,6 +43,10 @@ config USB_CHIPIDEA_MSM
  	tristate "Enable MSM hsusb glue driver" if EXPERT
  	default USB_CHIPIDEA
 
+config USB_CHIPIDEA_NPCM
+	tristate "Enable NPCM hsusb glue driver" if EXPERT
+	default USB_CHIPIDEA
+
  config USB_CHIPIDEA_IMX
  	tristate "Enable i.MX USB glue driver" if EXPERT
  	depends on OF

drivers/usb/chipidea/Makefile +1 -0

index 71afeab97e83..718cb24603dd 100644
@@ -13,6 +13,7 @@ ci_hdrc-$(CONFIG_USB_OTG_FSM)		+= otg_fsm.o
 
  obj-$(CONFIG_USB_CHIPIDEA_GENERIC)	+= ci_hdrc_usb2.o
  obj-$(CONFIG_USB_CHIPIDEA_MSM)		+= ci_hdrc_msm.o
+obj-$(CONFIG_USB_CHIPIDEA_NPCM)		+= ci_hdrc_npcm.o
  obj-$(CONFIG_USB_CHIPIDEA_PCI)		+= ci_hdrc_pci.o
  obj-$(CONFIG_USB_CHIPIDEA_IMX)		+= usbmisc_imx.o ci_hdrc_imx.o
  obj-$(CONFIG_USB_CHIPIDEA_TEGRA)	+= ci_hdrc_tegra.o

drivers/usb/chipidea/ci_hdrc_npcm.c new file +21 -0

new file mode 100644
index 000000000000..37b64a3dbd96
@@ -0,0 +1,114 @@
+// SPDX-License-Identifier: GPL-2.0
+// Copyright (c) 2023 Nuvoton Technology corporation.
+
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/pm_runtime.h>
+#include <linux/usb/chipidea.h>
+#include <linux/clk.h>
+#include <linux/io.h>
+#include <linux/reset-controller.h>
+#include <linux/of.h>
+
+#include "ci.h"
+
+struct npcm_udc_data {
+	struct platform_device	*ci;
+	struct clk		*core_clk;
+	struct ci_hdrc_platform_data pdata;
+};
+
+static int npcm_udc_notify_event(struct ci_hdrc *ci, unsigned event)

drivers/usb/chipidea/ci_hdrc_npcm.c new file +72 -0

+		break;
+	}
+
+	return 0;
+}
+
+static int npcm_udc_probe(struct platform_device *pdev)
+{
+	int ret;
+	struct npcm_udc_data *ci;
+	struct platform_device *plat_ci;
+	struct device *dev = &pdev->dev;
+
+	ci = devm_kzalloc(&pdev->dev, sizeof(*ci), GFP_KERNEL);
+	if (!ci)
+		return -ENOMEM;
+	platform_set_drvdata(pdev, ci);
+
+	ci->core_clk = devm_clk_get_optional(dev, NULL);
+	if (IS_ERR(ci->core_clk))
+		return PTR_ERR(ci->core_clk);
+
+	ret = clk_prepare_enable(ci->core_clk);
+	if (ret)
+		return dev_err_probe(dev, ret, "failed to enable the clock: %d\n", ret);
+
+	ci->pdata.name = dev_name(dev);
+	ci->pdata.capoffset = DEF_CAPOFFSET;
+	ci->pdata.flags	= CI_HDRC_REQUIRES_ALIGNED_DMA |
+		CI_HDRC_FORCE_VBUS_ACTIVE_ALWAYS;
+	ci->pdata.phy_mode = USBPHY_INTERFACE_MODE_UTMI;
+	ci->pdata.notify_event = npcm_udc_notify_event;
+
+	plat_ci = ci_hdrc_add_device(dev, pdev->resource, pdev->num_resources,
+				     &ci->pdata);
+	if (IS_ERR(plat_ci)) {
+		ret = PTR_ERR(plat_ci);
+		dev_err(dev, "failed to register HDRC NPCM device: %d\n", ret);
+		goto clk_err;
+	}
+
+	pm_runtime_no_callbacks(dev);
+	pm_runtime_enable(dev);
+
+	return 0;
+
+clk_err:
+	clk_disable_unprepare(ci->core_clk);
+	return ret;
+}
+
+static int npcm_udc_remove(struct platform_device *pdev)
+{
+	struct npcm_udc_data *ci = platform_get_drvdata(pdev);
+
+	pm_runtime_disable(&pdev->dev);
+	ci_hdrc_remove_device(ci->ci);
+	clk_disable_unprepare(ci->core_clk);
+
+	return 0;
+}
+
+static const struct of_device_id npcm_udc_dt_match[] = {
+	{ .compatible = "nuvoton,npcm750-udc", },
+	{ .compatible = "nuvoton,npcm845-udc", },
+	{ }
+};
+MODULE_DEVICE_TABLE(of, npcm_udc_dt_match);
+
+static struct platform_driver npcm_udc_driver = {
+	.probe = npcm_udc_probe,
+	.remove = npcm_udc_remove,

Dear Tomer,

Thank you for your patch.

Am 13.10.23 um 01:00 schrieb Tomer Maimon:

Quoted 2 lines

Add Nuvoton NPCM BMC SoCs support to USB ChipIdea driver. NPCM SoC include ChipIdea IP block that used for USB device controller

include*s*
“that *is* used” or just “… used for”

Quoted 2 lines

mode.

Please add a line, how you tested this patch.

Quoted 68 lines

Signed-off-by Tomer Maimon <[email protected]>

Acked-by Peter Chen <[email protected]>

---
  drivers/usb/chipidea/Kconfig        |   4 +
  drivers/usb/chipidea/Makefile       |   1 +
  drivers/usb/chipidea/ci_hdrc_npcm.c | 114 ++++++++++++++++++++++++++++
  3 files changed, 119 insertions(+)

create mode 100644 drivers/usb/chipidea/ci_hdrc_npcm.c

drivers/usb/chipidea/Kconfig +4 -0

index c815824a0b2d..bab45bc62361 100644
@@ -43,6 +43,10 @@ config USB_CHIPIDEA_MSM
      tristate "Enable MSM hsusb glue driver" if EXPERT
      default USB_CHIPIDEA
 
+config USB_CHIPIDEA_NPCM
+     tristate "Enable NPCM hsusb glue driver" if EXPERT
+     default USB_CHIPIDEA
+
  config USB_CHIPIDEA_IMX
      tristate "Enable i.MX USB glue driver" if EXPERT
      depends on OF

drivers/usb/chipidea/Makefile +1 -0

index 71afeab97e83..718cb24603dd 100644
@@ -13,6 +13,7 @@ ci_hdrc-$(CONFIG_USB_OTG_FSM)               += otg_fsm.o
 
  obj-$(CONFIG_USB_CHIPIDEA_GENERIC)  += ci_hdrc_usb2.o
  obj-$(CONFIG_USB_CHIPIDEA_MSM)              += ci_hdrc_msm.o
+obj-$(CONFIG_USB_CHIPIDEA_NPCM)              += ci_hdrc_npcm.o
  obj-$(CONFIG_USB_CHIPIDEA_PCI)              += ci_hdrc_pci.o
  obj-$(CONFIG_USB_CHIPIDEA_IMX)              += usbmisc_imx.o ci_hdrc_imx.o
  obj-$(CONFIG_USB_CHIPIDEA_TEGRA)    += ci_hdrc_tegra.o

drivers/usb/chipidea/ci_hdrc_npcm.c new file +25 -0

new file mode 100644
index 000000000000..37b64a3dbd96
@@ -0,0 +1,114 @@
+// SPDX-License-Identifier: GPL-2.0
+// Copyright (c) 2023 Nuvoton Technology corporation.
+
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/pm_runtime.h>
+#include <linux/usb/chipidea.h>
+#include <linux/clk.h>
+#include <linux/io.h>
+#include <linux/reset-controller.h>
+#include <linux/of.h>
+
+#include "ci.h"
+
+struct npcm_udc_data {
+     struct platform_device  *ci;
+     struct clk              *core_clk;
+     struct ci_hdrc_platform_data pdata;
+};
+
+static int npcm_udc_notify_event(struct ci_hdrc *ci, unsigned event)
+{
+     struct device *dev = ci->dev->parent;
+
+     switch (event) {

drivers/usb/chipidea/ci_hdrc_npcm.c line 31

Quoted 6 lines

drivers/usb/chipidea/ci_hdrc_npcm.c new file +6 -0

+     case CI_HDRC_CONTROLLER_RESET_EVENT:
+             /* clear all mode bits */
+             hw_write(ci, OP_USBMODE, 0xffffffff, 0x0);
+             break;
+     default:
+             dev_dbg(dev, "unknown ci_hdrc event\n");

Please print it out.

Quoted 77 lines

drivers/usb/chipidea/ci_hdrc_npcm.c new file +76 -0

+             break;
+     }
+
+     return 0;
+}
+
+static int npcm_udc_probe(struct platform_device *pdev)
+{
+     int ret;
+     struct npcm_udc_data *ci;
+     struct platform_device *plat_ci;
+     struct device *dev = &pdev->dev;
+
+     ci = devm_kzalloc(&pdev->dev, sizeof(*ci), GFP_KERNEL);
+     if (!ci)
+             return -ENOMEM;
+     platform_set_drvdata(pdev, ci);
+
+     ci->core_clk = devm_clk_get_optional(dev, NULL);
+     if (IS_ERR(ci->core_clk))
+             return PTR_ERR(ci->core_clk);
+
+     ret = clk_prepare_enable(ci->core_clk);
+     if (ret)
+             return dev_err_probe(dev, ret, "failed to enable the clock: %d\n", ret);
+
+     ci->pdata.name = dev_name(dev);
+     ci->pdata.capoffset = DEF_CAPOFFSET;
+     ci->pdata.flags = CI_HDRC_REQUIRES_ALIGNED_DMA |
+             CI_HDRC_FORCE_VBUS_ACTIVE_ALWAYS;
+     ci->pdata.phy_mode = USBPHY_INTERFACE_MODE_UTMI;
+     ci->pdata.notify_event = npcm_udc_notify_event;
+
+     plat_ci = ci_hdrc_add_device(dev, pdev->resource, pdev->num_resources,
+                                  &ci->pdata);
+     if (IS_ERR(plat_ci)) {
+             ret = PTR_ERR(plat_ci);
+             dev_err(dev, "failed to register HDRC NPCM device: %d\n", ret);
+             goto clk_err;
+     }
+
+     pm_runtime_no_callbacks(dev);
+     pm_runtime_enable(dev);
+
+     return 0;
+
+clk_err:
+     clk_disable_unprepare(ci->core_clk);
+     return ret;
+}
+
+static int npcm_udc_remove(struct platform_device *pdev)
+{
+     struct npcm_udc_data *ci = platform_get_drvdata(pdev);
+
+     pm_runtime_disable(&pdev->dev);
+     ci_hdrc_remove_device(ci->ci);
+     clk_disable_unprepare(ci->core_clk);
+
+     return 0;
+}
+
+static const struct of_device_id npcm_udc_dt_match[] = {
+     { .compatible = "nuvoton,npcm750-udc", },
+     { .compatible = "nuvoton,npcm845-udc", },
+     { }
+};
+MODULE_DEVICE_TABLE(of, npcm_udc_dt_match);
+
+static struct platform_driver npcm_udc_driver = {
+     .probe = npcm_udc_probe,
+     .remove = npcm_udc_remove,
+     .driver = {
+             .name = "npcm_udc",
+             .of_match_table = npcm_udc_dt_match,
+     },

drivers/usb/chipidea/ci_hdrc_npcm.c line 113

Quoted 6 lines

drivers/usb/chipidea/ci_hdrc_npcm.c new file +6 -0

+};
+
+module_platform_driver(npcm_udc_driver);
+
+MODULE_DESCRIPTION("NPCM USB device controller driver");
+MODULE_AUTHOR("Tomer Maimon <[email protected]>");

Should that address also be recorded as the patch author?

drivers/usb/chipidea/ci_hdrc_npcm.c line 114

Quoted 2 lines

drivers/usb/chipidea/ci_hdrc_npcm.c new file +1 -0

+MODULE_LICENSE("GPL v2");

Kind regards,

Paul

Quoted 7 lines

Am 13.10.23 um 01:00 schrieb Tomer Maimon:

Quoted 2 lines

Add Nuvoton NPCM BMC SoCs support to USB ChipIdea driver. NPCM SoC include ChipIdea IP block that used for USB device controller

include*s*
“that *is* used” or just “… used for”

Will do

Quoted 4 lines

Quoted 2 lines

mode.

Please add a line, how you tested this patch.

I don't recall "how you tested the patch" done in the commit message, I can add it in the cover letter

Quoted 67 lines

Quoted 67 lines

Signed-off-by Tomer Maimon <[email protected]>

Acked-by Peter Chen <[email protected]>

---
   drivers/usb/chipidea/Kconfig        |   4 +
   drivers/usb/chipidea/Makefile       |   1 +
   drivers/usb/chipidea/ci_hdrc_npcm.c | 114 ++++++++++++++++++++++++++++
   3 files changed, 119 insertions(+)

create mode 100644 drivers/usb/chipidea/ci_hdrc_npcm.c

drivers/usb/chipidea/Kconfig +4 -0

index c815824a0b2d..bab45bc62361 100644
@@ -43,6 +43,10 @@ config USB_CHIPIDEA_MSM
       tristate "Enable MSM hsusb glue driver" if EXPERT
       default USB_CHIPIDEA
 
+config USB_CHIPIDEA_NPCM
+     tristate "Enable NPCM hsusb glue driver" if EXPERT
+     default USB_CHIPIDEA
+
   config USB_CHIPIDEA_IMX
       tristate "Enable i.MX USB glue driver" if EXPERT
       depends on OF

drivers/usb/chipidea/Makefile +1 -0

index 71afeab97e83..718cb24603dd 100644
@@ -13,6 +13,7 @@ ci_hdrc-$(CONFIG_USB_OTG_FSM)               += otg_fsm.o
 
   obj-$(CONFIG_USB_CHIPIDEA_GENERIC)  += ci_hdrc_usb2.o
   obj-$(CONFIG_USB_CHIPIDEA_MSM)              += ci_hdrc_msm.o
+obj-$(CONFIG_USB_CHIPIDEA_NPCM)              += ci_hdrc_npcm.o
   obj-$(CONFIG_USB_CHIPIDEA_PCI)              += ci_hdrc_pci.o
   obj-$(CONFIG_USB_CHIPIDEA_IMX)              += usbmisc_imx.o ci_hdrc_imx.o
   obj-$(CONFIG_USB_CHIPIDEA_TEGRA)    += ci_hdrc_tegra.o

drivers/usb/chipidea/ci_hdrc_npcm.c new file +25 -0

new file mode 100644
index 000000000000..37b64a3dbd96
@@ -0,0 +1,114 @@
+// SPDX-License-Identifier: GPL-2.0
+// Copyright (c) 2023 Nuvoton Technology corporation.
+
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/pm_runtime.h>
+#include <linux/usb/chipidea.h>
+#include <linux/clk.h>
+#include <linux/io.h>
+#include <linux/reset-controller.h>
+#include <linux/of.h>
+
+#include "ci.h"
+
+struct npcm_udc_data {
+     struct platform_device  *ci;
+     struct clk              *core_clk;
+     struct ci_hdrc_platform_data pdata;
+};
+
+static int npcm_udc_notify_event(struct ci_hdrc *ci, unsigned event)
+{
+     struct device *dev = ci->dev->parent;
+
+     switch (event) {

Quoted 8 lines

drivers/usb/chipidea/ci_hdrc_npcm.c line 31

Quoted 6 lines

drivers/usb/chipidea/ci_hdrc_npcm.c new file +6 -0

+     case CI_HDRC_CONTROLLER_RESET_EVENT:
+             /* clear all mode bits */
+             hw_write(ci, OP_USBMODE, 0xffffffff, 0x0);
+             break;
+     default:
+             dev_dbg(dev, "unknown ci_hdrc event\n");

Please print it out.

Do you mean instead dev_dbg to use dev_info? in that case, each event that didnt handled will cause a print.

Quoted 76 lines

Quoted 76 lines

drivers/usb/chipidea/ci_hdrc_npcm.c new file +76 -0

+             break;
+     }
+
+     return 0;
+}
+
+static int npcm_udc_probe(struct platform_device *pdev)
+{
+     int ret;
+     struct npcm_udc_data *ci;
+     struct platform_device *plat_ci;
+     struct device *dev = &pdev->dev;
+
+     ci = devm_kzalloc(&pdev->dev, sizeof(*ci), GFP_KERNEL);
+     if (!ci)
+             return -ENOMEM;
+     platform_set_drvdata(pdev, ci);
+
+     ci->core_clk = devm_clk_get_optional(dev, NULL);
+     if (IS_ERR(ci->core_clk))
+             return PTR_ERR(ci->core_clk);
+
+     ret = clk_prepare_enable(ci->core_clk);
+     if (ret)
+             return dev_err_probe(dev, ret, "failed to enable the clock: %d\n", ret);
+
+     ci->pdata.name = dev_name(dev);
+     ci->pdata.capoffset = DEF_CAPOFFSET;
+     ci->pdata.flags = CI_HDRC_REQUIRES_ALIGNED_DMA |
+             CI_HDRC_FORCE_VBUS_ACTIVE_ALWAYS;
+     ci->pdata.phy_mode = USBPHY_INTERFACE_MODE_UTMI;
+     ci->pdata.notify_event = npcm_udc_notify_event;
+
+     plat_ci = ci_hdrc_add_device(dev, pdev->resource, pdev->num_resources,
+                                  &ci->pdata);
+     if (IS_ERR(plat_ci)) {
+             ret = PTR_ERR(plat_ci);
+             dev_err(dev, "failed to register HDRC NPCM device: %d\n", ret);
+             goto clk_err;
+     }
+
+     pm_runtime_no_callbacks(dev);
+     pm_runtime_enable(dev);
+
+     return 0;
+
+clk_err:
+     clk_disable_unprepare(ci->core_clk);
+     return ret;
+}
+
+static int npcm_udc_remove(struct platform_device *pdev)
+{
+     struct npcm_udc_data *ci = platform_get_drvdata(pdev);
+
+     pm_runtime_disable(&pdev->dev);
+     ci_hdrc_remove_device(ci->ci);
+     clk_disable_unprepare(ci->core_clk);
+
+     return 0;
+}
+
+static const struct of_device_id npcm_udc_dt_match[] = {
+     { .compatible = "nuvoton,npcm750-udc", },
+     { .compatible = "nuvoton,npcm845-udc", },
+     { }
+};
+MODULE_DEVICE_TABLE(of, npcm_udc_dt_match);
+
+static struct platform_driver npcm_udc_driver = {
+     .probe = npcm_udc_probe,
+     .remove = npcm_udc_remove,
+     .driver = {
+             .name = "npcm_udc",
+             .of_match_table = npcm_udc_dt_match,
+     },

Quoted 8 lines

drivers/usb/chipidea/ci_hdrc_npcm.c line 113

Quoted 6 lines

drivers/usb/chipidea/ci_hdrc_npcm.c new file +6 -0

+};
+
+module_platform_driver(npcm_udc_driver);
+
+MODULE_DESCRIPTION("NPCM USB device controller driver");
+MODULE_AUTHOR("Tomer Maimon <[email protected]>");

Should that address also be recorded as the patch author?

I prefer to use this e-mail since this is my main e-mail.

Quoted 1 line

drivers/usb/chipidea/ci_hdrc_npcm.c line 114

Quoted 1 line

drivers/usb/chipidea/ci_hdrc_npcm.c new file +1 -0

+MODULE_LICENSE("GPL v2");