162306a36Sopenharmony_ci// SPDX-License-Identifier: GPL-2.0+
262306a36Sopenharmony_ci/*
362306a36Sopenharmony_ci * StarFive JH7110 USB 2.0 PHY driver
462306a36Sopenharmony_ci *
562306a36Sopenharmony_ci * Copyright (C) 2023 StarFive Technology Co., Ltd.
662306a36Sopenharmony_ci * Author: Minda Chen <minda.chen@starfivetech.com>
762306a36Sopenharmony_ci */
862306a36Sopenharmony_ci
962306a36Sopenharmony_ci#include <linux/bits.h>
1062306a36Sopenharmony_ci#include <linux/clk.h>
1162306a36Sopenharmony_ci#include <linux/err.h>
1262306a36Sopenharmony_ci#include <linux/io.h>
1362306a36Sopenharmony_ci#include <linux/module.h>
1462306a36Sopenharmony_ci#include <linux/phy/phy.h>
1562306a36Sopenharmony_ci#include <linux/platform_device.h>
1662306a36Sopenharmony_ci#include <linux/usb/of.h>
1762306a36Sopenharmony_ci
1862306a36Sopenharmony_ci#define USB_125M_CLK_RATE		125000000
1962306a36Sopenharmony_ci#define USB_LS_KEEPALIVE_OFF		0x4
2062306a36Sopenharmony_ci#define USB_LS_KEEPALIVE_ENABLE		BIT(4)
2162306a36Sopenharmony_ci
2262306a36Sopenharmony_cistruct jh7110_usb2_phy {
2362306a36Sopenharmony_ci	struct phy *phy;
2462306a36Sopenharmony_ci	void __iomem *regs;
2562306a36Sopenharmony_ci	struct clk *usb_125m_clk;
2662306a36Sopenharmony_ci	struct clk *app_125m;
2762306a36Sopenharmony_ci	enum phy_mode mode;
2862306a36Sopenharmony_ci};
2962306a36Sopenharmony_ci
3062306a36Sopenharmony_cistatic void usb2_set_ls_keepalive(struct jh7110_usb2_phy *phy, bool set)
3162306a36Sopenharmony_ci{
3262306a36Sopenharmony_ci	unsigned int val;
3362306a36Sopenharmony_ci
3462306a36Sopenharmony_ci	/* Host mode enable the LS speed keep-alive signal */
3562306a36Sopenharmony_ci	val = readl(phy->regs + USB_LS_KEEPALIVE_OFF);
3662306a36Sopenharmony_ci	if (set)
3762306a36Sopenharmony_ci		val |= USB_LS_KEEPALIVE_ENABLE;
3862306a36Sopenharmony_ci	else
3962306a36Sopenharmony_ci		val &= ~USB_LS_KEEPALIVE_ENABLE;
4062306a36Sopenharmony_ci
4162306a36Sopenharmony_ci	writel(val, phy->regs + USB_LS_KEEPALIVE_OFF);
4262306a36Sopenharmony_ci}
4362306a36Sopenharmony_ci
4462306a36Sopenharmony_cistatic int usb2_phy_set_mode(struct phy *_phy,
4562306a36Sopenharmony_ci			     enum phy_mode mode, int submode)
4662306a36Sopenharmony_ci{
4762306a36Sopenharmony_ci	struct jh7110_usb2_phy *phy = phy_get_drvdata(_phy);
4862306a36Sopenharmony_ci
4962306a36Sopenharmony_ci	switch (mode) {
5062306a36Sopenharmony_ci	case PHY_MODE_USB_HOST:
5162306a36Sopenharmony_ci	case PHY_MODE_USB_DEVICE:
5262306a36Sopenharmony_ci	case PHY_MODE_USB_OTG:
5362306a36Sopenharmony_ci		break;
5462306a36Sopenharmony_ci	default:
5562306a36Sopenharmony_ci		return -EINVAL;
5662306a36Sopenharmony_ci	}
5762306a36Sopenharmony_ci
5862306a36Sopenharmony_ci	if (mode != phy->mode) {
5962306a36Sopenharmony_ci		dev_dbg(&_phy->dev, "Changing phy to %d\n", mode);
6062306a36Sopenharmony_ci		phy->mode = mode;
6162306a36Sopenharmony_ci		usb2_set_ls_keepalive(phy, (mode != PHY_MODE_USB_DEVICE));
6262306a36Sopenharmony_ci	}
6362306a36Sopenharmony_ci
6462306a36Sopenharmony_ci	return 0;
6562306a36Sopenharmony_ci}
6662306a36Sopenharmony_ci
6762306a36Sopenharmony_cistatic int jh7110_usb2_phy_init(struct phy *_phy)
6862306a36Sopenharmony_ci{
6962306a36Sopenharmony_ci	struct jh7110_usb2_phy *phy = phy_get_drvdata(_phy);
7062306a36Sopenharmony_ci	int ret;
7162306a36Sopenharmony_ci
7262306a36Sopenharmony_ci	ret = clk_set_rate(phy->usb_125m_clk, USB_125M_CLK_RATE);
7362306a36Sopenharmony_ci	if (ret)
7462306a36Sopenharmony_ci		return ret;
7562306a36Sopenharmony_ci
7662306a36Sopenharmony_ci	ret = clk_prepare_enable(phy->app_125m);
7762306a36Sopenharmony_ci	if (ret)
7862306a36Sopenharmony_ci		return ret;
7962306a36Sopenharmony_ci
8062306a36Sopenharmony_ci	return 0;
8162306a36Sopenharmony_ci}
8262306a36Sopenharmony_ci
8362306a36Sopenharmony_cistatic int jh7110_usb2_phy_exit(struct phy *_phy)
8462306a36Sopenharmony_ci{
8562306a36Sopenharmony_ci	struct jh7110_usb2_phy *phy = phy_get_drvdata(_phy);
8662306a36Sopenharmony_ci
8762306a36Sopenharmony_ci	clk_disable_unprepare(phy->app_125m);
8862306a36Sopenharmony_ci
8962306a36Sopenharmony_ci	return 0;
9062306a36Sopenharmony_ci}
9162306a36Sopenharmony_ci
9262306a36Sopenharmony_cistatic const struct phy_ops jh7110_usb2_phy_ops = {
9362306a36Sopenharmony_ci	.init		= jh7110_usb2_phy_init,
9462306a36Sopenharmony_ci	.exit		= jh7110_usb2_phy_exit,
9562306a36Sopenharmony_ci	.set_mode	= usb2_phy_set_mode,
9662306a36Sopenharmony_ci	.owner		= THIS_MODULE,
9762306a36Sopenharmony_ci};
9862306a36Sopenharmony_ci
9962306a36Sopenharmony_cistatic int jh7110_usb_phy_probe(struct platform_device *pdev)
10062306a36Sopenharmony_ci{
10162306a36Sopenharmony_ci	struct jh7110_usb2_phy *phy;
10262306a36Sopenharmony_ci	struct device *dev = &pdev->dev;
10362306a36Sopenharmony_ci	struct phy_provider *phy_provider;
10462306a36Sopenharmony_ci
10562306a36Sopenharmony_ci	phy = devm_kzalloc(dev, sizeof(*phy), GFP_KERNEL);
10662306a36Sopenharmony_ci	if (!phy)
10762306a36Sopenharmony_ci		return -ENOMEM;
10862306a36Sopenharmony_ci
10962306a36Sopenharmony_ci	phy->usb_125m_clk = devm_clk_get(dev, "125m");
11062306a36Sopenharmony_ci	if (IS_ERR(phy->usb_125m_clk))
11162306a36Sopenharmony_ci		return dev_err_probe(dev, PTR_ERR(phy->usb_125m_clk),
11262306a36Sopenharmony_ci			"Failed to get 125m clock\n");
11362306a36Sopenharmony_ci
11462306a36Sopenharmony_ci	phy->app_125m = devm_clk_get(dev, "app_125m");
11562306a36Sopenharmony_ci	if (IS_ERR(phy->app_125m))
11662306a36Sopenharmony_ci		return dev_err_probe(dev, PTR_ERR(phy->app_125m),
11762306a36Sopenharmony_ci			"Failed to get app 125m clock\n");
11862306a36Sopenharmony_ci
11962306a36Sopenharmony_ci	phy->regs = devm_platform_ioremap_resource(pdev, 0);
12062306a36Sopenharmony_ci	if (IS_ERR(phy->regs))
12162306a36Sopenharmony_ci		return dev_err_probe(dev, PTR_ERR(phy->regs),
12262306a36Sopenharmony_ci			"Failed to map phy base\n");
12362306a36Sopenharmony_ci
12462306a36Sopenharmony_ci	phy->phy = devm_phy_create(dev, NULL, &jh7110_usb2_phy_ops);
12562306a36Sopenharmony_ci	if (IS_ERR(phy->phy))
12662306a36Sopenharmony_ci		return dev_err_probe(dev, PTR_ERR(phy->phy),
12762306a36Sopenharmony_ci			"Failed to create phy\n");
12862306a36Sopenharmony_ci
12962306a36Sopenharmony_ci	phy_set_drvdata(phy->phy, phy);
13062306a36Sopenharmony_ci	phy_provider = devm_of_phy_provider_register(dev, of_phy_simple_xlate);
13162306a36Sopenharmony_ci
13262306a36Sopenharmony_ci	return PTR_ERR_OR_ZERO(phy_provider);
13362306a36Sopenharmony_ci}
13462306a36Sopenharmony_ci
13562306a36Sopenharmony_cistatic const struct of_device_id jh7110_usb_phy_of_match[] = {
13662306a36Sopenharmony_ci	{ .compatible = "starfive,jh7110-usb-phy" },
13762306a36Sopenharmony_ci	{ /* sentinel */ },
13862306a36Sopenharmony_ci};
13962306a36Sopenharmony_ciMODULE_DEVICE_TABLE(of, jh7110_usb_phy_of_match);
14062306a36Sopenharmony_ci
14162306a36Sopenharmony_cistatic struct platform_driver jh7110_usb_phy_driver = {
14262306a36Sopenharmony_ci	.probe	= jh7110_usb_phy_probe,
14362306a36Sopenharmony_ci	.driver = {
14462306a36Sopenharmony_ci		.of_match_table	= jh7110_usb_phy_of_match,
14562306a36Sopenharmony_ci		.name  = "jh7110-usb-phy",
14662306a36Sopenharmony_ci	}
14762306a36Sopenharmony_ci};
14862306a36Sopenharmony_cimodule_platform_driver(jh7110_usb_phy_driver);
14962306a36Sopenharmony_ci
15062306a36Sopenharmony_ciMODULE_DESCRIPTION("StarFive JH7110 USB 2.0 PHY driver");
15162306a36Sopenharmony_ciMODULE_AUTHOR("Minda Chen <minda.chen@starfivetech.com>");
15262306a36Sopenharmony_ciMODULE_LICENSE("GPL");
153