1 /*
2  * Copyright 2012 Freescale Semiconductor, Inc.
3  * Copyright (C) 2012 Marek Vasut <marex@denx.de>
4  * on behalf of DENX Software Engineering GmbH
5  *
6  * The code contained herein is licensed under the GNU General Public
7  * License. You may obtain a copy of the GNU General Public License
8  * Version 2 or later at the following locations:
9  *
10  * http://www.opensource.org/licenses/gpl-license.html
11  * http://www.gnu.org/copyleft/gpl.html
12  */
13 
14 #include <linux/module.h>
15 #include <linux/of_platform.h>
16 #include <linux/of_gpio.h>
17 #include <linux/platform_device.h>
18 #include <linux/pm_runtime.h>
19 #include <linux/dma-mapping.h>
20 #include <linux/usb/chipidea.h>
21 #include <linux/clk.h>
22 
23 #include "ci.h"
24 #include "ci_hdrc_imx.h"
25 
26 #define CI_HDRC_IMX_IMX28_WRITE_FIX BIT(0)
27 
28 struct ci_hdrc_imx_platform_flag {
29 	unsigned int flags;
30 };
31 
32 static const struct ci_hdrc_imx_platform_flag imx27_usb_data = {
33 };
34 
35 static const struct ci_hdrc_imx_platform_flag imx28_usb_data = {
36 	.flags = CI_HDRC_IMX_IMX28_WRITE_FIX,
37 };
38 
39 static const struct of_device_id ci_hdrc_imx_dt_ids[] = {
40 	{ .compatible = "fsl,imx28-usb", .data = &imx28_usb_data},
41 	{ .compatible = "fsl,imx27-usb", .data = &imx27_usb_data},
42 	{ /* sentinel */ }
43 };
44 MODULE_DEVICE_TABLE(of, ci_hdrc_imx_dt_ids);
45 
46 struct ci_hdrc_imx_data {
47 	struct usb_phy *phy;
48 	struct platform_device *ci_pdev;
49 	struct clk *clk;
50 	struct imx_usbmisc_data *usbmisc_data;
51 };
52 
53 /* Common functions shared by usbmisc drivers */
54 
55 static struct imx_usbmisc_data *usbmisc_get_init_data(struct device *dev)
56 {
57 	struct device_node *np = dev->of_node;
58 	struct of_phandle_args args;
59 	struct imx_usbmisc_data *data;
60 	int ret;
61 
62 	/*
63 	 * In case the fsl,usbmisc property is not present this device doesn't
64 	 * need usbmisc. Return NULL (which is no error here)
65 	 */
66 	if (!of_get_property(np, "fsl,usbmisc", NULL))
67 		return NULL;
68 
69 	data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
70 	if (!data)
71 		return ERR_PTR(-ENOMEM);
72 
73 	ret = of_parse_phandle_with_args(np, "fsl,usbmisc", "#index-cells",
74 					0, &args);
75 	if (ret) {
76 		dev_err(dev, "Failed to parse property fsl,usbmisc, errno %d\n",
77 			ret);
78 		return ERR_PTR(ret);
79 	}
80 
81 	data->index = args.args[0];
82 	of_node_put(args.np);
83 
84 	if (of_find_property(np, "disable-over-current", NULL))
85 		data->disable_oc = 1;
86 
87 	if (of_find_property(np, "external-vbus-divider", NULL))
88 		data->evdo = 1;
89 
90 	return data;
91 }
92 
93 /* End of common functions shared by usbmisc drivers*/
94 
95 static int ci_hdrc_imx_probe(struct platform_device *pdev)
96 {
97 	struct ci_hdrc_imx_data *data;
98 	struct ci_hdrc_platform_data pdata = {
99 		.name		= dev_name(&pdev->dev),
100 		.capoffset	= DEF_CAPOFFSET,
101 		.flags		= CI_HDRC_REQUIRE_TRANSCEIVER |
102 				  CI_HDRC_DISABLE_STREAMING,
103 	};
104 	int ret;
105 	const struct of_device_id *of_id =
106 			of_match_device(ci_hdrc_imx_dt_ids, &pdev->dev);
107 	const struct ci_hdrc_imx_platform_flag *imx_platform_flag = of_id->data;
108 
109 	data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
110 	if (!data) {
111 		dev_err(&pdev->dev, "Failed to allocate ci_hdrc-imx data!\n");
112 		return -ENOMEM;
113 	}
114 
115 	data->usbmisc_data = usbmisc_get_init_data(&pdev->dev);
116 	if (IS_ERR(data->usbmisc_data))
117 		return PTR_ERR(data->usbmisc_data);
118 
119 	data->clk = devm_clk_get(&pdev->dev, NULL);
120 	if (IS_ERR(data->clk)) {
121 		dev_err(&pdev->dev,
122 			"Failed to get clock, err=%ld\n", PTR_ERR(data->clk));
123 		return PTR_ERR(data->clk);
124 	}
125 
126 	ret = clk_prepare_enable(data->clk);
127 	if (ret) {
128 		dev_err(&pdev->dev,
129 			"Failed to prepare or enable clock, err=%d\n", ret);
130 		return ret;
131 	}
132 
133 	data->phy = devm_usb_get_phy_by_phandle(&pdev->dev, "fsl,usbphy", 0);
134 	if (IS_ERR(data->phy)) {
135 		ret = PTR_ERR(data->phy);
136 		/* Return -EINVAL if no usbphy is available */
137 		if (ret == -ENODEV)
138 			ret = -EINVAL;
139 		goto err_clk;
140 	}
141 
142 	pdata.phy = data->phy;
143 
144 	if (imx_platform_flag->flags & CI_HDRC_IMX_IMX28_WRITE_FIX)
145 		pdata.flags |= CI_HDRC_IMX28_WRITE_FIX;
146 
147 	ret = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
148 	if (ret)
149 		goto err_clk;
150 
151 	if (data->usbmisc_data) {
152 		ret = imx_usbmisc_init(data->usbmisc_data);
153 		if (ret) {
154 			dev_err(&pdev->dev, "usbmisc init failed, ret=%d\n",
155 					ret);
156 			goto err_clk;
157 		}
158 	}
159 
160 	data->ci_pdev = ci_hdrc_add_device(&pdev->dev,
161 				pdev->resource, pdev->num_resources,
162 				&pdata);
163 	if (IS_ERR(data->ci_pdev)) {
164 		ret = PTR_ERR(data->ci_pdev);
165 		dev_err(&pdev->dev,
166 			"Can't register ci_hdrc platform device, err=%d\n",
167 			ret);
168 		goto err_clk;
169 	}
170 
171 	if (data->usbmisc_data) {
172 		ret = imx_usbmisc_init_post(data->usbmisc_data);
173 		if (ret) {
174 			dev_err(&pdev->dev, "usbmisc post failed, ret=%d\n",
175 					ret);
176 			goto disable_device;
177 		}
178 	}
179 
180 	platform_set_drvdata(pdev, data);
181 
182 	pm_runtime_no_callbacks(&pdev->dev);
183 	pm_runtime_enable(&pdev->dev);
184 
185 	return 0;
186 
187 disable_device:
188 	ci_hdrc_remove_device(data->ci_pdev);
189 err_clk:
190 	clk_disable_unprepare(data->clk);
191 	return ret;
192 }
193 
194 static int ci_hdrc_imx_remove(struct platform_device *pdev)
195 {
196 	struct ci_hdrc_imx_data *data = platform_get_drvdata(pdev);
197 
198 	pm_runtime_disable(&pdev->dev);
199 	ci_hdrc_remove_device(data->ci_pdev);
200 	clk_disable_unprepare(data->clk);
201 
202 	return 0;
203 }
204 
205 static struct platform_driver ci_hdrc_imx_driver = {
206 	.probe = ci_hdrc_imx_probe,
207 	.remove = ci_hdrc_imx_remove,
208 	.driver = {
209 		.name = "imx_usb",
210 		.owner = THIS_MODULE,
211 		.of_match_table = ci_hdrc_imx_dt_ids,
212 	 },
213 };
214 
215 module_platform_driver(ci_hdrc_imx_driver);
216 
217 MODULE_ALIAS("platform:imx-usb");
218 MODULE_LICENSE("GPL v2");
219 MODULE_DESCRIPTION("CI HDRC i.MX USB binding");
220 MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
221 MODULE_AUTHOR("Richard Zhao <richard.zhao@freescale.com>");
222