From: ChiYuan Huang <cy_huang@richtek.com>
Add chip level mt6370 tcpci driver.
Signed-off-by: ChiYuan Huang <cy_huang@richtek.com>
---
v4:
- Replace text "Mediatek" with "MediaTek" in Kconfig
- Replace "first ret=regulator_(dis/en)able and then return"
with "return directly" in "mt6370_tcpc_set_vbus()"
- Replace header file <linux/of.h> with <linux/mod_devicetable.h>
- Add Copyright in the source code
- Add module name related description in Kconfig helptext
- Remove header file <linux/of.h>
- Refine all probe error by using dev_err_probe()
---
drivers/usb/typec/tcpm/Kconfig | 11 ++
drivers/usb/typec/tcpm/Makefile | 1 +
drivers/usb/typec/tcpm/tcpci_mt6370.c | 207 ++++++++++++++++++++++++++++++++++
3 files changed, 219 insertions(+)
create mode 100644 drivers/usb/typec/tcpm/tcpci_mt6370.c
diff --git a/drivers/usb/typec/tcpm/Kconfig b/drivers/usb/typec/tcpm/Kconfig
index 073fd2e..ccdd791 100644
--- a/drivers/usb/typec/tcpm/Kconfig
+++ b/drivers/usb/typec/tcpm/Kconfig
@@ -35,6 +35,17 @@ config TYPEC_MT6360
USB Type-C. It works with Type-C Port Controller Manager
to provide USB PD and USB Type-C functionalities.
+config TYPEC_TCPCI_MT6370
+ tristate "MediaTek MT6370 Type-C driver"
+ depends on MFD_MT6370
+ help
+ MediaTek MT6370 is a multi-functional IC that includes
+ USB Type-C. It works with Type-C Port Controller Manager
+ to provide USB PD and USB Type-C functionalities.
+
+ This driver can also be built as a module. If so the module
+ will be called "tcpci_mt6370.ko".
+
config TYPEC_TCPCI_MAXIM
tristate "Maxim TCPCI based Type-C chip driver"
help
diff --git a/drivers/usb/typec/tcpm/Makefile b/drivers/usb/typec/tcpm/Makefile
index 7d499f3..906d9dc 100644
--- a/drivers/usb/typec/tcpm/Makefile
+++ b/drivers/usb/typec/tcpm/Makefile
@@ -6,4 +6,5 @@ typec_wcove-y := wcove.o
obj-$(CONFIG_TYPEC_TCPCI) += tcpci.o
obj-$(CONFIG_TYPEC_RT1711H) += tcpci_rt1711h.o
obj-$(CONFIG_TYPEC_MT6360) += tcpci_mt6360.o
+obj-$(CONFIG_TYPEC_TCPCI_MT6370) += tcpci_mt6370.o
obj-$(CONFIG_TYPEC_TCPCI_MAXIM) += tcpci_maxim.o
diff --git a/drivers/usb/typec/tcpm/tcpci_mt6370.c b/drivers/usb/typec/tcpm/tcpci_mt6370.c
new file mode 100644
index 0000000..12336ca
--- /dev/null
+++ b/drivers/usb/typec/tcpm/tcpci_mt6370.c
@@ -0,0 +1,207 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Copyright (C) 2022 Richtek Technology Corp.
+ *
+ * Author: ChiYuan Huang <cy_huang@richtek.com>
+ */
+
+#include <linux/bits.h>
+#include <linux/interrupt.h>
+#include <linux/kernel.h>
+#include <linux/mod_devicetable.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/pm_wakeup.h>
+#include <linux/pm_wakeirq.h>
+#include <linux/regmap.h>
+#include <linux/regulator/consumer.h>
+#include <linux/usb/tcpm.h>
+#include "tcpci.h"
+
+#define MT6370_REG_SYSCTRL8 0x9B
+
+#define MT6370_AUTOIDLE_MASK BIT(3)
+
+#define MT6370_VENDOR_ID 0x29CF
+#define MT6370_TCPC_DID_A 0x2170
+
+struct mt6370_priv {
+ struct device *dev;
+ struct regulator *vbus;
+ struct tcpci *tcpci;
+ struct tcpci_data tcpci_data;
+ int irq;
+};
+
+static const struct reg_sequence mt6370_reg_init[] = {
+ REG_SEQ(0xA0, 0x1, 1000),
+ REG_SEQ(0x81, 0x38, 0),
+ REG_SEQ(0x82, 0x82, 0),
+ REG_SEQ(0xBA, 0xFC, 0),
+ REG_SEQ(0xBB, 0x50, 0),
+ REG_SEQ(0x9E, 0x8F, 0),
+ REG_SEQ(0xA1, 0x5, 0),
+ REG_SEQ(0xA2, 0x4, 0),
+ REG_SEQ(0xA3, 0x4A, 0),
+ REG_SEQ(0xA4, 0x01, 0),
+ REG_SEQ(0x95, 0x01, 0),
+ REG_SEQ(0x80, 0x71, 0),
+ REG_SEQ(0x9B, 0x3A, 1000)
+};
+
+static int mt6370_tcpc_init(struct tcpci *tcpci, struct tcpci_data *data)
+{
+ u16 did;
+ int ret;
+
+ ret = regmap_register_patch(data->regmap, mt6370_reg_init,
+ ARRAY_SIZE(mt6370_reg_init));
+ if (ret)
+ return ret;
+
+ ret = regmap_raw_read(data->regmap, TCPC_BCD_DEV, &did, sizeof(u16));
+ if (ret)
+ return ret;
+
+ if (did == MT6370_TCPC_DID_A)
+ return regmap_write(data->regmap, TCPC_FAULT_CTRL, 0x80);
+
+ return 0;
+}
+
+static int mt6370_tcpc_set_vconn(struct tcpci *tcpci, struct tcpci_data *data,
+ bool enable)
+{
+ return regmap_update_bits(data->regmap, MT6370_REG_SYSCTRL8,
+ MT6370_AUTOIDLE_MASK,
+ !enable ? MT6370_AUTOIDLE_MASK : 0);
+}
+
+static int mt6370_tcpc_set_vbus(struct tcpci *tcpci, struct tcpci_data *data,
+ bool source, bool sink)
+{
+ struct mt6370_priv *priv = container_of(data, struct mt6370_priv,
+ tcpci_data);
+ int ret;
+
+ ret = regulator_is_enabled(priv->vbus);
+ if (ret < 0)
+ return ret;
+
+ if (ret && !source)
+ return regulator_disable(priv->vbus);
+ else if (!ret && source)
+ return regulator_enable(priv->vbus);
+ else
+ return 0;
+}
+
+static irqreturn_t mt6370_irq_handler(int irq, void *dev_id)
+{
+ struct mt6370_priv *priv = dev_id;
+
+ return tcpci_irq(priv->tcpci);
+}
+
+static int mt6370_check_vendor_info(struct mt6370_priv *priv)
+{
+ struct regmap *regmap = priv->tcpci_data.regmap;
+ u16 vid;
+ int ret;
+
+ ret = regmap_raw_read(regmap, TCPC_VENDOR_ID, &vid, sizeof(u16));
+ if (ret)
+ return ret;
+
+ if (vid != MT6370_VENDOR_ID) {
+ dev_err(priv->dev, "Vendor ID not correct 0x%02x\n", vid);
+ return -ENODEV;
+ }
+
+ return 0;
+}
+
+static int mt6370_tcpc_probe(struct platform_device *pdev)
+{
+ struct mt6370_priv *priv;
+ int ret;
+
+ priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
+ if (!priv)
+ return -ENOMEM;
+
+ priv->dev = &pdev->dev;
+ platform_set_drvdata(pdev, priv);
+
+ priv->tcpci_data.regmap = dev_get_regmap(pdev->dev.parent, NULL);
+ if (!priv->tcpci_data.regmap)
+ return dev_err_probe(&pdev->dev, -ENODEV,
+ "Failed to init regmap\n");
+
+ ret = mt6370_check_vendor_info(priv);
+ if (ret)
+ return dev_err_probe(&pdev->dev, ret,
+ "Failed to check vendor info\n");
+
+ priv->irq = platform_get_irq(pdev, 0);
+ if (priv->irq < 0)
+ return priv->irq;
+
+ /* Assign TCPCI feature and ops */
+ priv->tcpci_data.auto_discharge_disconnect = 1;
+ priv->tcpci_data.init = mt6370_tcpc_init;
+ priv->tcpci_data.set_vconn = mt6370_tcpc_set_vconn;
+
+ priv->vbus = devm_regulator_get_optional(&pdev->dev, "vbus");
+ if (!IS_ERR(priv->vbus))
+ priv->tcpci_data.set_vbus = mt6370_tcpc_set_vbus;
+
+ priv->tcpci = tcpci_register_port(&pdev->dev, &priv->tcpci_data);
+ if (IS_ERR(priv->tcpci))
+ return dev_err_probe(&pdev->dev, PTR_ERR(priv->tcpci),
+ "Failed to register tcpci port\n");
+
+ ret = devm_request_threaded_irq(&pdev->dev, priv->irq, NULL,
+ mt6370_irq_handler, IRQF_ONESHOT,
+ dev_name(&pdev->dev), priv);
+ if (ret) {
+ tcpci_unregister_port(priv->tcpci);
+ return dev_err_probe(&pdev->dev, ret,
+ "Failed to allocate irq\n");
+ }
+
+ device_init_wakeup(&pdev->dev, true);
+ dev_pm_set_wake_irq(&pdev->dev, priv->irq);
+ return 0;
+}
+
+static int mt6370_tcpc_remove(struct platform_device *pdev)
+{
+ struct mt6370_priv *priv = platform_get_drvdata(pdev);
+
+ disable_irq(priv->irq);
+ tcpci_unregister_port(priv->tcpci);
+ dev_pm_clear_wake_irq(&pdev->dev);
+ device_init_wakeup(&pdev->dev, false);
+ return 0;
+}
+
+static const struct of_device_id mt6370_tcpc_devid_table[] = {
+ { .compatible = "mediatek,mt6370-tcpc", },
+ {}
+};
+MODULE_DEVICE_TABLE(of, mt6370_tcpc_devid_table);
+
+static struct platform_driver mt6370_tcpc_driver = {
+ .driver = {
+ .name = "mt6370-tcpc",
+ .of_match_table = mt6370_tcpc_devid_table,
+ },
+ .probe = mt6370_tcpc_probe,
+ .remove = mt6370_tcpc_remove,
+};
+module_platform_driver(mt6370_tcpc_driver);
+
+MODULE_AUTHOR("ChiYuan Huang <cy_huang@richtek.com>");
+MODULE_DESCRIPTION("MT6370 USB Type-C Port Controller Interface Driver");
+MODULE_LICENSE("GPL v2");
--
2.7.4
On Mon, Jul 4, 2022 at 7:42 AM ChiaEn Wu <peterwu.pub@gmail.com> wrote: > > Add chip level mt6370 tcpci driver. ... > +static const struct reg_sequence mt6370_reg_init[] = { > + REG_SEQ(0xA0, 0x1, 1000), > + REG_SEQ(0x81, 0x38, 0), > + REG_SEQ(0x82, 0x82, 0), > + REG_SEQ(0xBA, 0xFC, 0), > + REG_SEQ(0xBB, 0x50, 0), > + REG_SEQ(0x9E, 0x8F, 0), > + REG_SEQ(0xA1, 0x5, 0), > + REG_SEQ(0xA2, 0x4, 0), > + REG_SEQ(0xA3, 0x4A, 0), > + REG_SEQ(0xA4, 0x01, 0), > + REG_SEQ(0x95, 0x01, 0), > + REG_SEQ(0x80, 0x71, 0), > + REG_SEQ(0x9B, 0x3A, 1000) Keep a comma here in case something would be added later on. > +}; ... > + if (ret && !source) > + return regulator_disable(priv->vbus); > + else if (!ret && source) > + return regulator_enable(priv->vbus); > + else > + return 0; 'else' is redundant in both cases. ... > +static int mt6370_check_vendor_info(struct mt6370_priv *priv) > +{ > + struct regmap *regmap = priv->tcpci_data.regmap; > + u16 vid; > + int ret; > + > + ret = regmap_raw_read(regmap, TCPC_VENDOR_ID, &vid, sizeof(u16)); > + if (ret) > + return ret; > + > + if (vid != MT6370_VENDOR_ID) { > + dev_err(priv->dev, "Vendor ID not correct 0x%02x\n", vid); > + return -ENODEV; return dev_err_probe(...); > + } > + > + return 0; > +} > + > +static int mt6370_tcpc_probe(struct platform_device *pdev) > +{ > + struct mt6370_priv *priv; > + int ret; > + > + priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL); > + if (!priv) > + return -ENOMEM; > + > + priv->dev = &pdev->dev; > + platform_set_drvdata(pdev, priv); > + > + priv->tcpci_data.regmap = dev_get_regmap(pdev->dev.parent, NULL); > + if (!priv->tcpci_data.regmap) > + return dev_err_probe(&pdev->dev, -ENODEV, > + "Failed to init regmap\n"); You may save some LoCs by introducing a temporary variable struct device *dev = &pdev->dev; and here on a single line return dev_err_probe(dev, ...); Ditto for the rest. ... > + ret = mt6370_check_vendor_info(priv); > + if (ret) > + return dev_err_probe(&pdev->dev, ret, > + "Failed to check vendor info\n"); This duplicates (with less info given) the message from the callee. ... > + { .compatible = "mediatek,mt6370-tcpc", }, Inner comma is not needed. -- With Best Regards, Andy Shevchenko
On Mon, Jul 04, 2022 at 01:38:56PM +0800, ChiaEn Wu wrote: > From: ChiYuan Huang <cy_huang@richtek.com> > > Add chip level mt6370 tcpci driver. What does this mean? Please provide more information about the hardware being supported here so we know how to review this. thanks, greg k-h
Greg KH <gregkh@linuxfoundation.org> 於 2022年7月4日 週一 下午3:32寫道: > > On Mon, Jul 04, 2022 at 01:38:56PM +0800, ChiaEn Wu wrote: > > From: ChiYuan Huang <cy_huang@richtek.com> > > > > Add chip level mt6370 tcpci driver. > > What does this mean? Please provide more information about the hardware > being supported here so we know how to review this. Dear Greg, MediaTek MT6370 is a highly-integrated smart power management IC, which includes a single cell Li-Ion/Li-Polymer switching battery charger, a USB Type-C & Power Delivery (PD) controller, dual flash LED current sources, a RGB LED driver, a backlight WLED driver, a display bias driver and a general LDO for portable devices. This driver is used for the Type-C & Power Delivery controller in MediaTek MT6370 IC. If we change the commit message to "Add MediaTek MT6370 tcpci driver. MediaTek MT6370 is a multi-functional IC that includes USB Type-C. It works with Type-C Port Controller Manager to provide USB PD and USB Type-C functionalities." does this meet your requirements? Or “Add tcpci driver for Mediatek MT6370 IC” is enough? Sincerely, Alice Chen
On Mon, Jul 04, 2022 at 05:31:29PM +0800, szuni chen wrote: > Greg KH <gregkh@linuxfoundation.org> 於 2022年7月4日 週一 下午3:32寫道: > > > > On Mon, Jul 04, 2022 at 01:38:56PM +0800, ChiaEn Wu wrote: > > > From: ChiYuan Huang <cy_huang@richtek.com> > > > > > > Add chip level mt6370 tcpci driver. > > > > What does this mean? Please provide more information about the hardware > > being supported here so we know how to review this. > > Dear Greg, > > MediaTek MT6370 is a highly-integrated smart power management IC, > which includes a single cell Li-Ion/Li-Polymer switching battery charger, > a USB Type-C & Power Delivery (PD) controller, dual flash LED current sources, > a RGB LED driver, a backlight WLED driver, a display bias driver and a > general LDO for portable devices. > > This driver is used for the Type-C & Power Delivery controller in > MediaTek MT6370 IC. > > If we change the commit message to > > "Add MediaTek MT6370 tcpci driver. > MediaTek MT6370 is a multi-functional IC that includes USB Type-C. > It works with Type-C Port Controller Manager to provide USB PD and USB > Type-C functionalities." > > does this meet your requirements? What would you want to see if you were reading a changelog text for an unfamiliar hardware device? More text is always better! thanks, greg k-h
© 2016 - 2024 Red Hat, Inc.