Loading...
1/*
2 * Renesas USB driver
3 *
4 * Copyright (C) 2011 Renesas Solutions Corp.
5 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
15 *
16 */
17#include <linux/io.h>
18#include <linux/module.h>
19#include <linux/pm_runtime.h>
20#include <linux/slab.h>
21#include <linux/sysfs.h>
22#include "./common.h"
23
24/*
25 * image of renesas_usbhs
26 *
27 * ex) gadget case
28
29 * mod.c
30 * mod_gadget.c
31 * mod_host.c pipe.c fifo.c
32 *
33 * +-------+ +-----------+
34 * | pipe0 |------>| fifo pio |
35 * +------------+ +-------+ +-----------+
36 * | mod_gadget |=====> | pipe1 |--+
37 * +------------+ +-------+ | +-----------+
38 * | pipe2 | | +-| fifo dma0 |
39 * +------------+ +-------+ | | +-----------+
40 * | mod_host | | pipe3 |<-|--+
41 * +------------+ +-------+ | +-----------+
42 * | .... | +--->| fifo dma1 |
43 * | .... | +-----------+
44 */
45
46
47#define USBHSF_RUNTIME_PWCTRL (1 << 0)
48
49/* status */
50#define usbhsc_flags_init(p) do {(p)->flags = 0; } while (0)
51#define usbhsc_flags_set(p, b) ((p)->flags |= (b))
52#define usbhsc_flags_clr(p, b) ((p)->flags &= ~(b))
53#define usbhsc_flags_has(p, b) ((p)->flags & (b))
54
55/*
56 * platform call back
57 *
58 * renesas usb support platform callback function.
59 * Below macro call it.
60 * if platform doesn't have callback, it return 0 (no error)
61 */
62#define usbhs_platform_call(priv, func, args...)\
63 (!(priv) ? -ENODEV : \
64 !((priv)->pfunc->func) ? 0 : \
65 (priv)->pfunc->func(args))
66
67/*
68 * common functions
69 */
70u16 usbhs_read(struct usbhs_priv *priv, u32 reg)
71{
72 return ioread16(priv->base + reg);
73}
74
75void usbhs_write(struct usbhs_priv *priv, u32 reg, u16 data)
76{
77 iowrite16(data, priv->base + reg);
78}
79
80void usbhs_bset(struct usbhs_priv *priv, u32 reg, u16 mask, u16 data)
81{
82 u16 val = usbhs_read(priv, reg);
83
84 val &= ~mask;
85 val |= data & mask;
86
87 usbhs_write(priv, reg, val);
88}
89
90struct usbhs_priv *usbhs_pdev_to_priv(struct platform_device *pdev)
91{
92 return dev_get_drvdata(&pdev->dev);
93}
94
95/*
96 * syscfg functions
97 */
98void usbhs_sys_clock_ctrl(struct usbhs_priv *priv, int enable)
99{
100 usbhs_bset(priv, SYSCFG, SCKE, enable ? SCKE : 0);
101}
102
103void usbhs_sys_hispeed_ctrl(struct usbhs_priv *priv, int enable)
104{
105 usbhs_bset(priv, SYSCFG, HSE, enable ? HSE : 0);
106}
107
108void usbhs_sys_usb_ctrl(struct usbhs_priv *priv, int enable)
109{
110 usbhs_bset(priv, SYSCFG, USBE, enable ? USBE : 0);
111}
112
113void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable)
114{
115 u16 mask = DCFM | DRPD | DPRPU;
116 u16 val = DCFM | DRPD;
117
118 /*
119 * if enable
120 *
121 * - select Host mode
122 * - D+ Line/D- Line Pull-down
123 */
124 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
125}
126
127void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable)
128{
129 u16 mask = DCFM | DRPD | DPRPU;
130 u16 val = DPRPU;
131
132 /*
133 * if enable
134 *
135 * - select Function mode
136 * - D+ Line Pull-up
137 */
138 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
139}
140
141/*
142 * frame functions
143 */
144int usbhs_frame_get_num(struct usbhs_priv *priv)
145{
146 return usbhs_read(priv, FRMNUM) & FRNM_MASK;
147}
148
149/*
150 * local functions
151 */
152static void usbhsc_bus_ctrl(struct usbhs_priv *priv, int enable)
153{
154 int wait = usbhs_get_dparam(priv, buswait_bwait);
155 u16 data = 0;
156
157 if (enable) {
158 /* set bus wait if platform have */
159 if (wait)
160 usbhs_bset(priv, BUSWAIT, 0x000F, wait);
161 }
162 usbhs_write(priv, DVSTCTR, data);
163}
164
165/*
166 * platform default param
167 */
168static u32 usbhsc_default_pipe_type[] = {
169 USB_ENDPOINT_XFER_CONTROL,
170 USB_ENDPOINT_XFER_ISOC,
171 USB_ENDPOINT_XFER_ISOC,
172 USB_ENDPOINT_XFER_BULK,
173 USB_ENDPOINT_XFER_BULK,
174 USB_ENDPOINT_XFER_BULK,
175 USB_ENDPOINT_XFER_INT,
176 USB_ENDPOINT_XFER_INT,
177 USB_ENDPOINT_XFER_INT,
178 USB_ENDPOINT_XFER_INT,
179};
180
181/*
182 * power control
183 */
184static void usbhsc_power_ctrl(struct usbhs_priv *priv, int enable)
185{
186 struct device *dev = usbhs_priv_to_dev(priv);
187
188 if (enable) {
189 /* enable PM */
190 pm_runtime_get_sync(dev);
191
192 /* USB on */
193 usbhs_sys_clock_ctrl(priv, enable);
194 usbhsc_bus_ctrl(priv, enable);
195 } else {
196 /* USB off */
197 usbhsc_bus_ctrl(priv, enable);
198 usbhs_sys_clock_ctrl(priv, enable);
199
200 /* disable PM */
201 pm_runtime_put_sync(dev);
202 }
203}
204
205/*
206 * notify hotplug
207 */
208static void usbhsc_notify_hotplug(struct work_struct *work)
209{
210 struct usbhs_priv *priv = container_of(work,
211 struct usbhs_priv,
212 notify_hotplug_work.work);
213 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
214 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
215 int id;
216 int enable;
217 int ret;
218
219 /*
220 * get vbus status from platform
221 */
222 enable = usbhs_platform_call(priv, get_vbus, pdev);
223
224 /*
225 * get id from platform
226 */
227 id = usbhs_platform_call(priv, get_id, pdev);
228
229 if (enable && !mod) {
230 ret = usbhs_mod_change(priv, id);
231 if (ret < 0)
232 return;
233
234 dev_dbg(&pdev->dev, "%s enable\n", __func__);
235
236 /* power on */
237 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
238 usbhsc_power_ctrl(priv, enable);
239
240 /* module start */
241 usbhs_mod_call(priv, start, priv);
242
243 } else if (!enable && mod) {
244 dev_dbg(&pdev->dev, "%s disable\n", __func__);
245
246 /* module stop */
247 usbhs_mod_call(priv, stop, priv);
248
249 /* power off */
250 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
251 usbhsc_power_ctrl(priv, enable);
252
253 usbhs_mod_change(priv, -1);
254
255 /* reset phy for next connection */
256 usbhs_platform_call(priv, phy_reset, pdev);
257 }
258}
259
260int usbhsc_drvcllbck_notify_hotplug(struct platform_device *pdev)
261{
262 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
263 int delay = usbhs_get_dparam(priv, detection_delay);
264
265 /*
266 * This functions will be called in interrupt.
267 * To make sure safety context,
268 * use workqueue for usbhs_notify_hotplug
269 */
270 schedule_delayed_work(&priv->notify_hotplug_work, delay);
271 return 0;
272}
273
274/*
275 * platform functions
276 */
277static int __devinit usbhs_probe(struct platform_device *pdev)
278{
279 struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
280 struct renesas_usbhs_driver_callback *dfunc;
281 struct usbhs_priv *priv;
282 struct resource *res;
283 unsigned int irq;
284 int ret;
285
286 /* check platform information */
287 if (!info ||
288 !info->platform_callback.get_id) {
289 dev_err(&pdev->dev, "no platform information\n");
290 return -EINVAL;
291 }
292
293 /* platform data */
294 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
295 irq = platform_get_irq(pdev, 0);
296 if (!res || (int)irq <= 0) {
297 dev_err(&pdev->dev, "Not enough Renesas USB platform resources.\n");
298 return -ENODEV;
299 }
300
301 /* usb private data */
302 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
303 if (!priv) {
304 dev_err(&pdev->dev, "Could not allocate priv\n");
305 return -ENOMEM;
306 }
307
308 priv->base = ioremap_nocache(res->start, resource_size(res));
309 if (!priv->base) {
310 dev_err(&pdev->dev, "ioremap error.\n");
311 ret = -ENOMEM;
312 goto probe_end_kfree;
313 }
314
315 /*
316 * care platform info
317 */
318 priv->pfunc = &info->platform_callback;
319 priv->dparam = &info->driver_param;
320
321 /* set driver callback functions for platform */
322 dfunc = &info->driver_callback;
323 dfunc->notify_hotplug = usbhsc_drvcllbck_notify_hotplug;
324
325 /* set default param if platform doesn't have */
326 if (!priv->dparam->pipe_type) {
327 priv->dparam->pipe_type = usbhsc_default_pipe_type;
328 priv->dparam->pipe_size = ARRAY_SIZE(usbhsc_default_pipe_type);
329 }
330 if (!priv->dparam->pio_dma_border)
331 priv->dparam->pio_dma_border = 64; /* 64byte */
332
333 /* FIXME */
334 /* runtime power control ? */
335 if (priv->pfunc->get_vbus)
336 usbhsc_flags_set(priv, USBHSF_RUNTIME_PWCTRL);
337
338 /*
339 * priv settings
340 */
341 priv->irq = irq;
342 priv->pdev = pdev;
343 INIT_DELAYED_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
344 spin_lock_init(usbhs_priv_to_lock(priv));
345
346 /* call pipe and module init */
347 ret = usbhs_pipe_probe(priv);
348 if (ret < 0)
349 goto probe_end_iounmap;
350
351 ret = usbhs_fifo_probe(priv);
352 if (ret < 0)
353 goto probe_end_pipe_exit;
354
355 ret = usbhs_mod_probe(priv);
356 if (ret < 0)
357 goto probe_end_fifo_exit;
358
359 /* dev_set_drvdata should be called after usbhs_mod_init */
360 dev_set_drvdata(&pdev->dev, priv);
361
362 /*
363 * deviece reset here because
364 * USB device might be used in boot loader.
365 */
366 usbhs_sys_clock_ctrl(priv, 0);
367
368 /*
369 * platform call
370 *
371 * USB phy setup might depend on CPU/Board.
372 * If platform has its callback functions,
373 * call it here.
374 */
375 ret = usbhs_platform_call(priv, hardware_init, pdev);
376 if (ret < 0) {
377 dev_err(&pdev->dev, "platform prove failed.\n");
378 goto probe_end_mod_exit;
379 }
380
381 /* reset phy for connection */
382 usbhs_platform_call(priv, phy_reset, pdev);
383
384 /* power control */
385 pm_runtime_enable(&pdev->dev);
386 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL)) {
387 usbhsc_power_ctrl(priv, 1);
388 usbhs_mod_autonomy_mode(priv);
389 }
390
391 /*
392 * manual call notify_hotplug for cold plug
393 */
394 ret = usbhsc_drvcllbck_notify_hotplug(pdev);
395 if (ret < 0)
396 goto probe_end_call_remove;
397
398 dev_info(&pdev->dev, "probed\n");
399
400 return ret;
401
402probe_end_call_remove:
403 usbhs_platform_call(priv, hardware_exit, pdev);
404probe_end_mod_exit:
405 usbhs_mod_remove(priv);
406probe_end_fifo_exit:
407 usbhs_fifo_remove(priv);
408probe_end_pipe_exit:
409 usbhs_pipe_remove(priv);
410probe_end_iounmap:
411 iounmap(priv->base);
412probe_end_kfree:
413 kfree(priv);
414
415 dev_info(&pdev->dev, "probe failed\n");
416
417 return ret;
418}
419
420static int __devexit usbhs_remove(struct platform_device *pdev)
421{
422 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
423 struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
424 struct renesas_usbhs_driver_callback *dfunc = &info->driver_callback;
425
426 dev_dbg(&pdev->dev, "usb remove\n");
427
428 dfunc->notify_hotplug = NULL;
429
430 /* power off */
431 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
432 usbhsc_power_ctrl(priv, 0);
433
434 pm_runtime_disable(&pdev->dev);
435
436 usbhs_platform_call(priv, hardware_exit, pdev);
437 usbhs_mod_remove(priv);
438 usbhs_fifo_remove(priv);
439 usbhs_pipe_remove(priv);
440 iounmap(priv->base);
441 kfree(priv);
442
443 return 0;
444}
445
446static struct platform_driver renesas_usbhs_driver = {
447 .driver = {
448 .name = "renesas_usbhs",
449 },
450 .probe = usbhs_probe,
451 .remove = __devexit_p(usbhs_remove),
452};
453
454static int __init usbhs_init(void)
455{
456 return platform_driver_register(&renesas_usbhs_driver);
457}
458
459static void __exit usbhs_exit(void)
460{
461 platform_driver_unregister(&renesas_usbhs_driver);
462}
463
464module_init(usbhs_init);
465module_exit(usbhs_exit);
466
467MODULE_LICENSE("GPL");
468MODULE_DESCRIPTION("Renesas USB driver");
469MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
1// SPDX-License-Identifier: GPL-1.0+
2/*
3 * Renesas USB driver
4 *
5 * Copyright (C) 2011 Renesas Solutions Corp.
6 * Copyright (C) 2019 Renesas Electronics Corporation
7 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
8 */
9#include <linux/clk.h>
10#include <linux/err.h>
11#include <linux/gpio.h>
12#include <linux/io.h>
13#include <linux/module.h>
14#include <linux/of_device.h>
15#include <linux/of_gpio.h>
16#include <linux/pm_runtime.h>
17#include <linux/reset.h>
18#include <linux/slab.h>
19#include <linux/sysfs.h>
20#include "common.h"
21#include "rcar2.h"
22#include "rcar3.h"
23#include "rza.h"
24
25/*
26 * image of renesas_usbhs
27 *
28 * ex) gadget case
29
30 * mod.c
31 * mod_gadget.c
32 * mod_host.c pipe.c fifo.c
33 *
34 * +-------+ +-----------+
35 * | pipe0 |------>| fifo pio |
36 * +------------+ +-------+ +-----------+
37 * | mod_gadget |=====> | pipe1 |--+
38 * +------------+ +-------+ | +-----------+
39 * | pipe2 | | +-| fifo dma0 |
40 * +------------+ +-------+ | | +-----------+
41 * | mod_host | | pipe3 |<-|--+
42 * +------------+ +-------+ | +-----------+
43 * | .... | +--->| fifo dma1 |
44 * | .... | +-----------+
45 */
46
47/*
48 * platform call back
49 *
50 * renesas usb support platform callback function.
51 * Below macro call it.
52 * if platform doesn't have callback, it return 0 (no error)
53 */
54#define usbhs_platform_call(priv, func, args...)\
55 (!(priv) ? -ENODEV : \
56 !((priv)->pfunc->func) ? 0 : \
57 (priv)->pfunc->func(args))
58
59/*
60 * common functions
61 */
62u16 usbhs_read(struct usbhs_priv *priv, u32 reg)
63{
64 return ioread16(priv->base + reg);
65}
66
67void usbhs_write(struct usbhs_priv *priv, u32 reg, u16 data)
68{
69 iowrite16(data, priv->base + reg);
70}
71
72void usbhs_bset(struct usbhs_priv *priv, u32 reg, u16 mask, u16 data)
73{
74 u16 val = usbhs_read(priv, reg);
75
76 val &= ~mask;
77 val |= data & mask;
78
79 usbhs_write(priv, reg, val);
80}
81
82struct usbhs_priv *usbhs_pdev_to_priv(struct platform_device *pdev)
83{
84 return dev_get_drvdata(&pdev->dev);
85}
86
87int usbhs_get_id_as_gadget(struct platform_device *pdev)
88{
89 return USBHS_GADGET;
90}
91
92/*
93 * syscfg functions
94 */
95static void usbhs_sys_clock_ctrl(struct usbhs_priv *priv, int enable)
96{
97 usbhs_bset(priv, SYSCFG, SCKE, enable ? SCKE : 0);
98}
99
100void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable)
101{
102 u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
103 u16 val = DCFM | DRPD | HSE | USBE;
104
105 /*
106 * if enable
107 *
108 * - select Host mode
109 * - D+ Line/D- Line Pull-down
110 */
111 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
112}
113
114void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable)
115{
116 u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
117 u16 val = HSE | USBE;
118
119 /* CNEN bit is required for function operation */
120 if (usbhs_get_dparam(priv, has_cnen)) {
121 mask |= CNEN;
122 val |= CNEN;
123 }
124
125 /*
126 * if enable
127 *
128 * - select Function mode
129 * - D+ Line Pull-up is disabled
130 * When D+ Line Pull-up is enabled,
131 * calling usbhs_sys_function_pullup(,1)
132 */
133 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
134}
135
136void usbhs_sys_function_pullup(struct usbhs_priv *priv, int enable)
137{
138 usbhs_bset(priv, SYSCFG, DPRPU, enable ? DPRPU : 0);
139}
140
141void usbhs_sys_set_test_mode(struct usbhs_priv *priv, u16 mode)
142{
143 usbhs_write(priv, TESTMODE, mode);
144}
145
146/*
147 * frame functions
148 */
149int usbhs_frame_get_num(struct usbhs_priv *priv)
150{
151 return usbhs_read(priv, FRMNUM) & FRNM_MASK;
152}
153
154/*
155 * usb request functions
156 */
157void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
158{
159 u16 val;
160
161 val = usbhs_read(priv, USBREQ);
162 req->bRequest = (val >> 8) & 0xFF;
163 req->bRequestType = (val >> 0) & 0xFF;
164
165 req->wValue = cpu_to_le16(usbhs_read(priv, USBVAL));
166 req->wIndex = cpu_to_le16(usbhs_read(priv, USBINDX));
167 req->wLength = cpu_to_le16(usbhs_read(priv, USBLENG));
168}
169
170void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
171{
172 usbhs_write(priv, USBREQ, (req->bRequest << 8) | req->bRequestType);
173 usbhs_write(priv, USBVAL, le16_to_cpu(req->wValue));
174 usbhs_write(priv, USBINDX, le16_to_cpu(req->wIndex));
175 usbhs_write(priv, USBLENG, le16_to_cpu(req->wLength));
176
177 usbhs_bset(priv, DCPCTR, SUREQ, SUREQ);
178}
179
180/*
181 * bus/vbus functions
182 */
183void usbhs_bus_send_sof_enable(struct usbhs_priv *priv)
184{
185 u16 status = usbhs_read(priv, DVSTCTR) & (USBRST | UACT);
186
187 if (status != USBRST) {
188 struct device *dev = usbhs_priv_to_dev(priv);
189 dev_err(dev, "usbhs should be reset\n");
190 }
191
192 usbhs_bset(priv, DVSTCTR, (USBRST | UACT), UACT);
193}
194
195void usbhs_bus_send_reset(struct usbhs_priv *priv)
196{
197 usbhs_bset(priv, DVSTCTR, (USBRST | UACT), USBRST);
198}
199
200int usbhs_bus_get_speed(struct usbhs_priv *priv)
201{
202 u16 dvstctr = usbhs_read(priv, DVSTCTR);
203
204 switch (RHST & dvstctr) {
205 case RHST_LOW_SPEED:
206 return USB_SPEED_LOW;
207 case RHST_FULL_SPEED:
208 return USB_SPEED_FULL;
209 case RHST_HIGH_SPEED:
210 return USB_SPEED_HIGH;
211 }
212
213 return USB_SPEED_UNKNOWN;
214}
215
216int usbhs_vbus_ctrl(struct usbhs_priv *priv, int enable)
217{
218 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
219
220 return usbhs_platform_call(priv, set_vbus, pdev, enable);
221}
222
223static void usbhsc_bus_init(struct usbhs_priv *priv)
224{
225 usbhs_write(priv, DVSTCTR, 0);
226
227 usbhs_vbus_ctrl(priv, 0);
228}
229
230/*
231 * device configuration
232 */
233int usbhs_set_device_config(struct usbhs_priv *priv, int devnum,
234 u16 upphub, u16 hubport, u16 speed)
235{
236 struct device *dev = usbhs_priv_to_dev(priv);
237 u16 usbspd = 0;
238 u32 reg = DEVADD0 + (2 * devnum);
239
240 if (devnum > 10) {
241 dev_err(dev, "cannot set speed to unknown device %d\n", devnum);
242 return -EIO;
243 }
244
245 if (upphub > 0xA) {
246 dev_err(dev, "unsupported hub number %d\n", upphub);
247 return -EIO;
248 }
249
250 switch (speed) {
251 case USB_SPEED_LOW:
252 usbspd = USBSPD_SPEED_LOW;
253 break;
254 case USB_SPEED_FULL:
255 usbspd = USBSPD_SPEED_FULL;
256 break;
257 case USB_SPEED_HIGH:
258 usbspd = USBSPD_SPEED_HIGH;
259 break;
260 default:
261 dev_err(dev, "unsupported speed %d\n", speed);
262 return -EIO;
263 }
264
265 usbhs_write(priv, reg, UPPHUB(upphub) |
266 HUBPORT(hubport)|
267 USBSPD(usbspd));
268
269 return 0;
270}
271
272/*
273 * interrupt functions
274 */
275void usbhs_xxxsts_clear(struct usbhs_priv *priv, u16 sts_reg, u16 bit)
276{
277 u16 pipe_mask = (u16)GENMASK(usbhs_get_dparam(priv, pipe_size), 0);
278
279 usbhs_write(priv, sts_reg, ~(1 << bit) & pipe_mask);
280}
281
282/*
283 * local functions
284 */
285static void usbhsc_set_buswait(struct usbhs_priv *priv)
286{
287 int wait = usbhs_get_dparam(priv, buswait_bwait);
288
289 /* set bus wait if platform have */
290 if (wait)
291 usbhs_bset(priv, BUSWAIT, 0x000F, wait);
292}
293
294static bool usbhsc_is_multi_clks(struct usbhs_priv *priv)
295{
296 return priv->dparam.multi_clks;
297}
298
299static int usbhsc_clk_get(struct device *dev, struct usbhs_priv *priv)
300{
301 if (!usbhsc_is_multi_clks(priv))
302 return 0;
303
304 /* The first clock should exist */
305 priv->clks[0] = of_clk_get(dev_of_node(dev), 0);
306 if (IS_ERR(priv->clks[0]))
307 return PTR_ERR(priv->clks[0]);
308
309 /*
310 * To backward compatibility with old DT, this driver checks the return
311 * value if it's -ENOENT or not.
312 */
313 priv->clks[1] = of_clk_get(dev_of_node(dev), 1);
314 if (PTR_ERR(priv->clks[1]) == -ENOENT)
315 priv->clks[1] = NULL;
316 else if (IS_ERR(priv->clks[1]))
317 return PTR_ERR(priv->clks[1]);
318
319 return 0;
320}
321
322static void usbhsc_clk_put(struct usbhs_priv *priv)
323{
324 int i;
325
326 if (!usbhsc_is_multi_clks(priv))
327 return;
328
329 for (i = 0; i < ARRAY_SIZE(priv->clks); i++)
330 clk_put(priv->clks[i]);
331}
332
333static int usbhsc_clk_prepare_enable(struct usbhs_priv *priv)
334{
335 int i, ret;
336
337 if (!usbhsc_is_multi_clks(priv))
338 return 0;
339
340 for (i = 0; i < ARRAY_SIZE(priv->clks); i++) {
341 ret = clk_prepare_enable(priv->clks[i]);
342 if (ret) {
343 while (--i >= 0)
344 clk_disable_unprepare(priv->clks[i]);
345 return ret;
346 }
347 }
348
349 return ret;
350}
351
352static void usbhsc_clk_disable_unprepare(struct usbhs_priv *priv)
353{
354 int i;
355
356 if (!usbhsc_is_multi_clks(priv))
357 return;
358
359 for (i = 0; i < ARRAY_SIZE(priv->clks); i++)
360 clk_disable_unprepare(priv->clks[i]);
361}
362
363/*
364 * platform default param
365 */
366
367/* commonly used on old SH-Mobile SoCs */
368static struct renesas_usbhs_driver_pipe_config usbhsc_default_pipe[] = {
369 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_CONTROL, 64, 0x00, false),
370 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x08, false),
371 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x18, false),
372 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x28, true),
373 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x38, true),
374 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x48, true),
375 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x04, false),
376 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x05, false),
377 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x06, false),
378 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x07, false),
379};
380
381/* commonly used on newer SH-Mobile and R-Car SoCs */
382static struct renesas_usbhs_driver_pipe_config usbhsc_new_pipe[] = {
383 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_CONTROL, 64, 0x00, false),
384 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x08, true),
385 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_ISOC, 1024, 0x28, true),
386 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x48, true),
387 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x58, true),
388 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x68, true),
389 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x04, false),
390 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x05, false),
391 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_INT, 64, 0x06, false),
392 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x78, true),
393 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x88, true),
394 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0x98, true),
395 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xa8, true),
396 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xb8, true),
397 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xc8, true),
398 RENESAS_USBHS_PIPE(USB_ENDPOINT_XFER_BULK, 512, 0xd8, true),
399};
400
401/*
402 * power control
403 */
404static void usbhsc_power_ctrl(struct usbhs_priv *priv, int enable)
405{
406 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
407 struct device *dev = usbhs_priv_to_dev(priv);
408
409 if (enable) {
410 /* enable PM */
411 pm_runtime_get_sync(dev);
412
413 /* enable clks */
414 if (usbhsc_clk_prepare_enable(priv))
415 return;
416
417 /* enable platform power */
418 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
419
420 /* USB on */
421 usbhs_sys_clock_ctrl(priv, enable);
422 } else {
423 /* USB off */
424 usbhs_sys_clock_ctrl(priv, enable);
425
426 /* disable platform power */
427 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
428
429 /* disable clks */
430 usbhsc_clk_disable_unprepare(priv);
431
432 /* disable PM */
433 pm_runtime_put_sync(dev);
434 }
435}
436
437/*
438 * hotplug
439 */
440static void usbhsc_hotplug(struct usbhs_priv *priv)
441{
442 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
443 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
444 int id;
445 int enable;
446 int cable;
447 int ret;
448
449 /*
450 * get vbus status from platform
451 */
452 enable = usbhs_mod_info_call(priv, get_vbus, pdev);
453
454 /*
455 * get id from platform
456 */
457 id = usbhs_platform_call(priv, get_id, pdev);
458
459 if (enable && !mod) {
460 if (priv->edev) {
461 cable = extcon_get_state(priv->edev, EXTCON_USB_HOST);
462 if ((cable > 0 && id != USBHS_HOST) ||
463 (!cable && id != USBHS_GADGET)) {
464 dev_info(&pdev->dev,
465 "USB cable plugged in doesn't match the selected role!\n");
466 return;
467 }
468 }
469
470 ret = usbhs_mod_change(priv, id);
471 if (ret < 0)
472 return;
473
474 dev_dbg(&pdev->dev, "%s enable\n", __func__);
475
476 /* power on */
477 if (usbhs_get_dparam(priv, runtime_pwctrl))
478 usbhsc_power_ctrl(priv, enable);
479
480 /* bus init */
481 usbhsc_set_buswait(priv);
482 usbhsc_bus_init(priv);
483
484 /* module start */
485 usbhs_mod_call(priv, start, priv);
486
487 } else if (!enable && mod) {
488 dev_dbg(&pdev->dev, "%s disable\n", __func__);
489
490 /* module stop */
491 usbhs_mod_call(priv, stop, priv);
492
493 /* bus init */
494 usbhsc_bus_init(priv);
495
496 /* power off */
497 if (usbhs_get_dparam(priv, runtime_pwctrl))
498 usbhsc_power_ctrl(priv, enable);
499
500 usbhs_mod_change(priv, -1);
501
502 /* reset phy for next connection */
503 usbhs_platform_call(priv, phy_reset, pdev);
504 }
505}
506
507/*
508 * notify hotplug
509 */
510static void usbhsc_notify_hotplug(struct work_struct *work)
511{
512 struct usbhs_priv *priv = container_of(work,
513 struct usbhs_priv,
514 notify_hotplug_work.work);
515 usbhsc_hotplug(priv);
516}
517
518int usbhsc_schedule_notify_hotplug(struct platform_device *pdev)
519{
520 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
521 int delay = usbhs_get_dparam(priv, detection_delay);
522
523 /*
524 * This functions will be called in interrupt.
525 * To make sure safety context,
526 * use workqueue for usbhs_notify_hotplug
527 */
528 schedule_delayed_work(&priv->notify_hotplug_work,
529 msecs_to_jiffies(delay));
530 return 0;
531}
532
533/*
534 * platform functions
535 */
536static const struct of_device_id usbhs_of_match[] = {
537 {
538 .compatible = "renesas,usbhs-r8a774c0",
539 .data = &usbhs_rcar_gen3_with_pll_plat_info,
540 },
541 {
542 .compatible = "renesas,usbhs-r8a7790",
543 .data = &usbhs_rcar_gen2_plat_info,
544 },
545 {
546 .compatible = "renesas,usbhs-r8a7791",
547 .data = &usbhs_rcar_gen2_plat_info,
548 },
549 {
550 .compatible = "renesas,usbhs-r8a7794",
551 .data = &usbhs_rcar_gen2_plat_info,
552 },
553 {
554 .compatible = "renesas,usbhs-r8a7795",
555 .data = &usbhs_rcar_gen3_plat_info,
556 },
557 {
558 .compatible = "renesas,usbhs-r8a7796",
559 .data = &usbhs_rcar_gen3_plat_info,
560 },
561 {
562 .compatible = "renesas,usbhs-r8a77990",
563 .data = &usbhs_rcar_gen3_with_pll_plat_info,
564 },
565 {
566 .compatible = "renesas,usbhs-r8a77995",
567 .data = &usbhs_rcar_gen3_with_pll_plat_info,
568 },
569 {
570 .compatible = "renesas,rcar-gen2-usbhs",
571 .data = &usbhs_rcar_gen2_plat_info,
572 },
573 {
574 .compatible = "renesas,rcar-gen3-usbhs",
575 .data = &usbhs_rcar_gen3_plat_info,
576 },
577 {
578 .compatible = "renesas,rza1-usbhs",
579 .data = &usbhs_rza1_plat_info,
580 },
581 {
582 .compatible = "renesas,rza2-usbhs",
583 .data = &usbhs_rza2_plat_info,
584 },
585 { },
586};
587MODULE_DEVICE_TABLE(of, usbhs_of_match);
588
589static int usbhs_probe(struct platform_device *pdev)
590{
591 const struct renesas_usbhs_platform_info *info;
592 struct usbhs_priv *priv;
593 struct resource *res, *irq_res;
594 struct device *dev = &pdev->dev;
595 int ret, gpio;
596 u32 tmp;
597
598 /* check device node */
599 if (dev_of_node(dev))
600 info = of_device_get_match_data(dev);
601 else
602 info = renesas_usbhs_get_info(pdev);
603
604 /* check platform information */
605 if (!info) {
606 dev_err(dev, "no platform information\n");
607 return -EINVAL;
608 }
609
610 /* platform data */
611 irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
612 if (!irq_res) {
613 dev_err(dev, "Not enough Renesas USB platform resources.\n");
614 return -ENODEV;
615 }
616
617 /* usb private data */
618 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
619 if (!priv)
620 return -ENOMEM;
621
622 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
623 priv->base = devm_ioremap_resource(&pdev->dev, res);
624 if (IS_ERR(priv->base))
625 return PTR_ERR(priv->base);
626
627 if (of_property_read_bool(dev_of_node(dev), "extcon")) {
628 priv->edev = extcon_get_edev_by_phandle(dev, 0);
629 if (IS_ERR(priv->edev))
630 return PTR_ERR(priv->edev);
631 }
632
633 priv->rsts = devm_reset_control_array_get_optional_shared(dev);
634 if (IS_ERR(priv->rsts))
635 return PTR_ERR(priv->rsts);
636
637 /*
638 * care platform info
639 */
640
641 priv->dparam = info->driver_param;
642
643 if (!info->platform_callback.get_id) {
644 dev_err(dev, "no platform callbacks\n");
645 return -EINVAL;
646 }
647 priv->pfunc = &info->platform_callback;
648
649 /* set default param if platform doesn't have */
650 if (usbhs_get_dparam(priv, has_new_pipe_configs)) {
651 priv->dparam.pipe_configs = usbhsc_new_pipe;
652 priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_new_pipe);
653 } else if (!priv->dparam.pipe_configs) {
654 priv->dparam.pipe_configs = usbhsc_default_pipe;
655 priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_default_pipe);
656 }
657 if (!priv->dparam.pio_dma_border)
658 priv->dparam.pio_dma_border = 64; /* 64byte */
659 if (!of_property_read_u32(dev_of_node(dev), "renesas,buswait", &tmp))
660 priv->dparam.buswait_bwait = tmp;
661 gpio = of_get_named_gpio_flags(dev_of_node(dev), "renesas,enable-gpio",
662 0, NULL);
663 if (gpio > 0)
664 priv->dparam.enable_gpio = gpio;
665
666 /* FIXME */
667 /* runtime power control ? */
668 if (priv->pfunc->get_vbus)
669 usbhs_get_dparam(priv, runtime_pwctrl) = 1;
670
671 /*
672 * priv settings
673 */
674 priv->irq = irq_res->start;
675 if (irq_res->flags & IORESOURCE_IRQ_SHAREABLE)
676 priv->irqflags = IRQF_SHARED;
677 priv->pdev = pdev;
678 INIT_DELAYED_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
679 spin_lock_init(usbhs_priv_to_lock(priv));
680
681 /* call pipe and module init */
682 ret = usbhs_pipe_probe(priv);
683 if (ret < 0)
684 return ret;
685
686 ret = usbhs_fifo_probe(priv);
687 if (ret < 0)
688 goto probe_end_pipe_exit;
689
690 ret = usbhs_mod_probe(priv);
691 if (ret < 0)
692 goto probe_end_fifo_exit;
693
694 /* dev_set_drvdata should be called after usbhs_mod_init */
695 platform_set_drvdata(pdev, priv);
696
697 ret = reset_control_deassert(priv->rsts);
698 if (ret)
699 goto probe_fail_rst;
700
701 ret = usbhsc_clk_get(dev, priv);
702 if (ret)
703 goto probe_fail_clks;
704
705 /*
706 * deviece reset here because
707 * USB device might be used in boot loader.
708 */
709 usbhs_sys_clock_ctrl(priv, 0);
710
711 /* check GPIO determining if USB function should be enabled */
712 if (priv->dparam.enable_gpio) {
713 gpio_request_one(priv->dparam.enable_gpio, GPIOF_IN, NULL);
714 ret = !gpio_get_value(priv->dparam.enable_gpio);
715 gpio_free(priv->dparam.enable_gpio);
716 if (ret) {
717 dev_warn(dev, "USB function not selected (GPIO %d)\n",
718 priv->dparam.enable_gpio);
719 ret = -ENOTSUPP;
720 goto probe_end_mod_exit;
721 }
722 }
723
724 /*
725 * platform call
726 *
727 * USB phy setup might depend on CPU/Board.
728 * If platform has its callback functions,
729 * call it here.
730 */
731 ret = usbhs_platform_call(priv, hardware_init, pdev);
732 if (ret < 0) {
733 dev_err(dev, "platform init failed.\n");
734 goto probe_end_mod_exit;
735 }
736
737 /* reset phy for connection */
738 usbhs_platform_call(priv, phy_reset, pdev);
739
740 /* power control */
741 pm_runtime_enable(dev);
742 if (!usbhs_get_dparam(priv, runtime_pwctrl)) {
743 usbhsc_power_ctrl(priv, 1);
744 usbhs_mod_autonomy_mode(priv);
745 } else {
746 usbhs_mod_non_autonomy_mode(priv);
747 }
748
749 /*
750 * manual call notify_hotplug for cold plug
751 */
752 usbhsc_schedule_notify_hotplug(pdev);
753
754 dev_info(dev, "probed\n");
755
756 return ret;
757
758probe_end_mod_exit:
759 usbhsc_clk_put(priv);
760probe_fail_clks:
761 reset_control_assert(priv->rsts);
762probe_fail_rst:
763 usbhs_mod_remove(priv);
764probe_end_fifo_exit:
765 usbhs_fifo_remove(priv);
766probe_end_pipe_exit:
767 usbhs_pipe_remove(priv);
768
769 dev_info(dev, "probe failed (%d)\n", ret);
770
771 return ret;
772}
773
774static int usbhs_remove(struct platform_device *pdev)
775{
776 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
777
778 dev_dbg(&pdev->dev, "usb remove\n");
779
780 /* power off */
781 if (!usbhs_get_dparam(priv, runtime_pwctrl))
782 usbhsc_power_ctrl(priv, 0);
783
784 pm_runtime_disable(&pdev->dev);
785
786 usbhs_platform_call(priv, hardware_exit, pdev);
787 usbhsc_clk_put(priv);
788 reset_control_assert(priv->rsts);
789 usbhs_mod_remove(priv);
790 usbhs_fifo_remove(priv);
791 usbhs_pipe_remove(priv);
792
793 return 0;
794}
795
796static __maybe_unused int usbhsc_suspend(struct device *dev)
797{
798 struct usbhs_priv *priv = dev_get_drvdata(dev);
799 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
800
801 if (mod) {
802 usbhs_mod_call(priv, stop, priv);
803 usbhs_mod_change(priv, -1);
804 }
805
806 if (mod || !usbhs_get_dparam(priv, runtime_pwctrl))
807 usbhsc_power_ctrl(priv, 0);
808
809 return 0;
810}
811
812static __maybe_unused int usbhsc_resume(struct device *dev)
813{
814 struct usbhs_priv *priv = dev_get_drvdata(dev);
815 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
816
817 if (!usbhs_get_dparam(priv, runtime_pwctrl)) {
818 usbhsc_power_ctrl(priv, 1);
819 usbhs_mod_autonomy_mode(priv);
820 }
821
822 usbhs_platform_call(priv, phy_reset, pdev);
823
824 usbhsc_schedule_notify_hotplug(pdev);
825
826 return 0;
827}
828
829static SIMPLE_DEV_PM_OPS(usbhsc_pm_ops, usbhsc_suspend, usbhsc_resume);
830
831static struct platform_driver renesas_usbhs_driver = {
832 .driver = {
833 .name = "renesas_usbhs",
834 .pm = &usbhsc_pm_ops,
835 .of_match_table = of_match_ptr(usbhs_of_match),
836 },
837 .probe = usbhs_probe,
838 .remove = usbhs_remove,
839};
840
841module_platform_driver(renesas_usbhs_driver);
842
843MODULE_LICENSE("GPL");
844MODULE_DESCRIPTION("Renesas USB driver");
845MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");