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