1// SPDX-License-Identifier: GPL-2.0+
  2/*
  3 * SAMSUNG EXYNOS USB HOST OHCI Controller
  4 *
  5 * Copyright (C) 2011 Samsung Electronics Co.Ltd
  6 * Author: Jingoo Han <jg1.han@samsung.com>
  7 */
  8
  9#include <linux/clk.h>
 10#include <linux/dma-mapping.h>
 11#include <linux/io.h>
 12#include <linux/kernel.h>
 13#include <linux/module.h>
 14#include <linux/of.h>
 15#include <linux/platform_device.h>
 16#include <linux/phy/phy.h>
 17#include <linux/usb.h>
 18#include <linux/usb/hcd.h>
 19
 20#include "ohci.h"
 21
 22#define DRIVER_DESC "OHCI EXYNOS driver"
 23
 24static const char hcd_name[] = "ohci-exynos";
 25static struct hc_driver __read_mostly exynos_ohci_hc_driver;
 26
 27#define to_exynos_ohci(hcd) (struct exynos_ohci_hcd *)(hcd_to_ohci(hcd)->priv)
 28
 29#define PHY_NUMBER 3
 30
 31struct exynos_ohci_hcd {
 32	struct clk *clk;
 33	struct phy *phy[PHY_NUMBER];
 34};
 35
 36static int exynos_ohci_get_phy(struct device *dev,
 37				struct exynos_ohci_hcd *exynos_ohci)
 38{
 39	struct device_node *child;
 40	struct phy *phy;
 41	int phy_number;
 42	int ret;
 43
 44	/* Get PHYs for the controller */
 45	for_each_available_child_of_node(dev->of_node, child) {
 46		ret = of_property_read_u32(child, "reg", &phy_number);
 47		if (ret) {
 48			dev_err(dev, "Failed to parse device tree\n");
 49			of_node_put(child);
 50			return ret;
 51		}
 52
 53		if (phy_number >= PHY_NUMBER) {
 54			dev_err(dev, "Invalid number of PHYs\n");
 55			of_node_put(child);
 56			return -EINVAL;
 57		}
 58
 59		phy = devm_of_phy_get(dev, child, NULL);
 60		exynos_ohci->phy[phy_number] = phy;
 61		if (IS_ERR(phy)) {
 62			ret = PTR_ERR(phy);
 63			if (ret == -EPROBE_DEFER) {
 64				of_node_put(child);
 65				return ret;
 66			} else if (ret != -ENOSYS && ret != -ENODEV) {
 67				dev_err(dev,
 68					"Error retrieving usb2 phy: %d\n", ret);
 69				of_node_put(child);
 70				return ret;
 71			}
 72		}
 73	}
 74
 75	return 0;
 76}
 77
 78static int exynos_ohci_phy_enable(struct device *dev)
 79{
 80	struct usb_hcd *hcd = dev_get_drvdata(dev);
 81	struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd);
 82	int i;
 83	int ret = 0;
 84
 85	for (i = 0; ret == 0 && i < PHY_NUMBER; i++)
 86		if (!IS_ERR(exynos_ohci->phy[i]))
 87			ret = phy_power_on(exynos_ohci->phy[i]);
 88	if (ret)
 89		for (i--; i >= 0; i--)
 90			if (!IS_ERR(exynos_ohci->phy[i]))
 91				phy_power_off(exynos_ohci->phy[i]);
 92
 93	return ret;
 94}
 95
 96static void exynos_ohci_phy_disable(struct device *dev)
 97{
 98	struct usb_hcd *hcd = dev_get_drvdata(dev);
 99	struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd);
100	int i;
101
102	for (i = 0; i < PHY_NUMBER; i++)
103		if (!IS_ERR(exynos_ohci->phy[i]))
104			phy_power_off(exynos_ohci->phy[i]);
105}
106
107static int exynos_ohci_probe(struct platform_device *pdev)
108{
109	struct exynos_ohci_hcd *exynos_ohci;
110	struct usb_hcd *hcd;
111	struct resource *res;
112	int irq;
113	int err;
114
115	/*
116	 * Right now device-tree probed devices don't get dma_mask set.
117	 * Since shared usb code relies on it, set it here for now.
118	 * Once we move to full device tree support this will vanish off.
119	 */
120	err = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
121	if (err)
122		return err;
123
124	hcd = usb_create_hcd(&exynos_ohci_hc_driver,
125				&pdev->dev, dev_name(&pdev->dev));
126	if (!hcd) {
127		dev_err(&pdev->dev, "Unable to create HCD\n");
128		return -ENOMEM;
129	}
130
131	exynos_ohci = to_exynos_ohci(hcd);
132
133	if (of_device_is_compatible(pdev->dev.of_node,
134					"samsung,exynos5440-ohci"))
135		goto skip_phy;
136
137	err = exynos_ohci_get_phy(&pdev->dev, exynos_ohci);
138	if (err)
139		goto fail_clk;
140
141skip_phy:
142	exynos_ohci->clk = devm_clk_get(&pdev->dev, "usbhost");
143
144	if (IS_ERR(exynos_ohci->clk)) {
145		dev_err(&pdev->dev, "Failed to get usbhost clock\n");
146		err = PTR_ERR(exynos_ohci->clk);
147		goto fail_clk;
148	}
149
150	err = clk_prepare_enable(exynos_ohci->clk);
151	if (err)
152		goto fail_clk;
153
154	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
155	hcd->regs = devm_ioremap_resource(&pdev->dev, res);
156	if (IS_ERR(hcd->regs)) {
157		err = PTR_ERR(hcd->regs);
158		goto fail_io;
159	}
160	hcd->rsrc_start = res->start;
161	hcd->rsrc_len = resource_size(res);
162
163	irq = platform_get_irq(pdev, 0);
164	if (!irq) {
165		dev_err(&pdev->dev, "Failed to get IRQ\n");
166		err = -ENODEV;
167		goto fail_io;
168	}
169
170	platform_set_drvdata(pdev, hcd);
171
172	err = exynos_ohci_phy_enable(&pdev->dev);
173	if (err) {
174		dev_err(&pdev->dev, "Failed to enable USB phy\n");
175		goto fail_io;
176	}
177
178	err = usb_add_hcd(hcd, irq, IRQF_SHARED);
179	if (err) {
180		dev_err(&pdev->dev, "Failed to add USB HCD\n");
181		goto fail_add_hcd;
182	}
183	device_wakeup_enable(hcd->self.controller);
184	return 0;
185
186fail_add_hcd:
187	exynos_ohci_phy_disable(&pdev->dev);
188fail_io:
189	clk_disable_unprepare(exynos_ohci->clk);
190fail_clk:
191	usb_put_hcd(hcd);
192	return err;
193}
194
195static int exynos_ohci_remove(struct platform_device *pdev)
196{
197	struct usb_hcd *hcd = platform_get_drvdata(pdev);
198	struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd);
199
200	usb_remove_hcd(hcd);
201
202	exynos_ohci_phy_disable(&pdev->dev);
203
204	clk_disable_unprepare(exynos_ohci->clk);
205
206	usb_put_hcd(hcd);
207
208	return 0;
209}
210
211static void exynos_ohci_shutdown(struct platform_device *pdev)
212{
213	struct usb_hcd *hcd = platform_get_drvdata(pdev);
214
215	if (hcd->driver->shutdown)
216		hcd->driver->shutdown(hcd);
217}
218
219#ifdef CONFIG_PM
220static int exynos_ohci_suspend(struct device *dev)
221{
222	struct usb_hcd *hcd = dev_get_drvdata(dev);
223	struct exynos_ohci_hcd *exynos_ohci = to_exynos_ohci(hcd);
224	bool do_wakeup = device_may_wakeup(dev);
225	int rc = ohci_suspend(hcd, do_wakeup);
226
227	if (rc)
228		return rc;
229
230	exynos_ohci_phy_disable(dev);
231
232	clk_disable_unprepare(exynos_ohci->clk);
233
234	return 0;
235}
236
237static int exynos_ohci_resume(struct device *dev)
238{
239	struct usb_hcd *hcd			= dev_get_drvdata(dev);
240	struct exynos_ohci_hcd *exynos_ohci	= to_exynos_ohci(hcd);
241	int ret;
242
243	clk_prepare_enable(exynos_ohci->clk);
244
245	ret = exynos_ohci_phy_enable(dev);
246	if (ret) {
247		dev_err(dev, "Failed to enable USB phy\n");
248		clk_disable_unprepare(exynos_ohci->clk);
249		return ret;
250	}
251
252	ohci_resume(hcd, false);
253
254	return 0;
255}
256#else
257#define exynos_ohci_suspend	NULL
258#define exynos_ohci_resume	NULL
259#endif
260
261static const struct ohci_driver_overrides exynos_overrides __initconst = {
262	.extra_priv_size =	sizeof(struct exynos_ohci_hcd),
263};
264
265static const struct dev_pm_ops exynos_ohci_pm_ops = {
266	.suspend	= exynos_ohci_suspend,
267	.resume		= exynos_ohci_resume,
268};
269
270#ifdef CONFIG_OF
271static const struct of_device_id exynos_ohci_match[] = {
272	{ .compatible = "samsung,exynos4210-ohci" },
273	{ .compatible = "samsung,exynos5440-ohci" },
274	{},
275};
276MODULE_DEVICE_TABLE(of, exynos_ohci_match);
277#endif
278
279static struct platform_driver exynos_ohci_driver = {
280	.probe		= exynos_ohci_probe,
281	.remove		= exynos_ohci_remove,
282	.shutdown	= exynos_ohci_shutdown,
283	.driver = {
284		.name	= "exynos-ohci",
285		.pm	= &exynos_ohci_pm_ops,
286		.of_match_table	= of_match_ptr(exynos_ohci_match),
287	}
288};
289static int __init ohci_exynos_init(void)
290{
291	if (usb_disabled())
292		return -ENODEV;
293
294	pr_info("%s: " DRIVER_DESC "\n", hcd_name);
295	ohci_init_driver(&exynos_ohci_hc_driver, &exynos_overrides);
296	return platform_driver_register(&exynos_ohci_driver);
297}
298module_init(ohci_exynos_init);
299
300static void __exit ohci_exynos_cleanup(void)
301{
302	platform_driver_unregister(&exynos_ohci_driver);
303}
304module_exit(ohci_exynos_cleanup);
305
306MODULE_ALIAS("platform:exynos-ohci");
307MODULE_AUTHOR("Jingoo Han <jg1.han@samsung.com>");
308MODULE_LICENSE("GPL v2");