blob: e43be34f04b9c40ede1bacef5e45e1fe1bffc3f5 [file] [log] [blame]
Alexander Shishkine443b332012-05-11 17:25:46 +03001/*
2 * core.c - ChipIdea USB IP core family device controller
3 *
4 * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
5 *
6 * Author: David Lopo
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13/*
14 * Description: ChipIdea USB IP core family device controller
15 *
16 * This driver is composed of several blocks:
17 * - HW: hardware interface
18 * - DBG: debug facilities (optional)
19 * - UTIL: utilities
20 * - ISR: interrupts handling
21 * - ENDPT: endpoint operations (Gadget API)
22 * - GADGET: gadget operations (Gadget API)
23 * - BUS: bus glue code, bus abstraction layer
24 *
25 * Compile Options
Peter Chen58ce8492014-05-23 08:12:47 +080026 * - CONFIG_USB_CHIPIDEA_DEBUG: enable debug facilities
Alexander Shishkine443b332012-05-11 17:25:46 +030027 * - STALL_IN: non-empty bulk-in pipes cannot be halted
28 * if defined mass storage compliance succeeds but with warnings
29 * => case 4: Hi > Dn
30 * => case 5: Hi > Di
31 * => case 8: Hi <> Do
32 * if undefined usbtest 13 fails
33 * - TRACE: enable function tracing (depends on DEBUG)
34 *
35 * Main Features
36 * - Chapter 9 & Mass Storage Compliance with Gadget File Storage
37 * - Chapter 9 Compliance with Gadget Zero (STALL_IN undefined)
38 * - Normal & LPM support
39 *
40 * USBTEST Report
41 * - OK: 0-12, 13 (STALL_IN defined) & 14
42 * - Not Supported: 15 & 16 (ISO)
43 *
44 * TODO List
Alexander Shishkine443b332012-05-11 17:25:46 +030045 * - Suspend & Remote Wakeup
46 */
47#include <linux/delay.h>
48#include <linux/device.h>
Alexander Shishkine443b332012-05-11 17:25:46 +030049#include <linux/dma-mapping.h>
Antoine Tenart1e5e2d32014-10-30 18:41:19 +010050#include <linux/phy/phy.h>
Alexander Shishkine443b332012-05-11 17:25:46 +030051#include <linux/platform_device.h>
52#include <linux/module.h>
Richard Zhaofe6e1252012-07-07 22:56:42 +080053#include <linux/idr.h>
Alexander Shishkine443b332012-05-11 17:25:46 +030054#include <linux/interrupt.h>
55#include <linux/io.h>
Alexander Shishkine443b332012-05-11 17:25:46 +030056#include <linux/kernel.h>
57#include <linux/slab.h>
58#include <linux/pm_runtime.h>
59#include <linux/usb/ch9.h>
60#include <linux/usb/gadget.h>
61#include <linux/usb/otg.h>
62#include <linux/usb/chipidea.h>
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +030063#include <linux/usb/of.h>
Michael Grzeschik4f6743d2014-02-19 13:41:43 +080064#include <linux/of.h>
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +030065#include <linux/phy.h>
Peter Chen1542d9c2013-08-14 12:44:03 +030066#include <linux/regulator/consumer.h>
Alexander Shishkine443b332012-05-11 17:25:46 +030067
68#include "ci.h"
69#include "udc.h"
70#include "bits.h"
Alexander Shishkineb70e5a2012-05-11 17:25:54 +030071#include "host.h"
Alexander Shishkine443b332012-05-11 17:25:46 +030072#include "debug.h"
Peter Chenc10b4f02013-08-14 12:44:06 +030073#include "otg.h"
Li Jun4dcf7202014-04-23 15:56:50 +080074#include "otg_fsm.h"
Alexander Shishkine443b332012-05-11 17:25:46 +030075
Alexander Shishkin5f36e232012-05-11 17:25:47 +030076/* Controller register map */
Marc Kleine-Budde987e7bc2014-01-06 10:10:39 +080077static const u8 ci_regs_nolpm[] = {
78 [CAP_CAPLENGTH] = 0x00U,
79 [CAP_HCCPARAMS] = 0x08U,
80 [CAP_DCCPARAMS] = 0x24U,
81 [CAP_TESTMODE] = 0x38U,
82 [OP_USBCMD] = 0x00U,
83 [OP_USBSTS] = 0x04U,
84 [OP_USBINTR] = 0x08U,
85 [OP_DEVICEADDR] = 0x14U,
86 [OP_ENDPTLISTADDR] = 0x18U,
87 [OP_PORTSC] = 0x44U,
88 [OP_DEVLC] = 0x84U,
89 [OP_OTGSC] = 0x64U,
90 [OP_USBMODE] = 0x68U,
91 [OP_ENDPTSETUPSTAT] = 0x6CU,
92 [OP_ENDPTPRIME] = 0x70U,
93 [OP_ENDPTFLUSH] = 0x74U,
94 [OP_ENDPTSTAT] = 0x78U,
95 [OP_ENDPTCOMPLETE] = 0x7CU,
96 [OP_ENDPTCTRL] = 0x80U,
Alexander Shishkine443b332012-05-11 17:25:46 +030097};
98
Marc Kleine-Budde987e7bc2014-01-06 10:10:39 +080099static const u8 ci_regs_lpm[] = {
100 [CAP_CAPLENGTH] = 0x00U,
101 [CAP_HCCPARAMS] = 0x08U,
102 [CAP_DCCPARAMS] = 0x24U,
103 [CAP_TESTMODE] = 0xFCU,
104 [OP_USBCMD] = 0x00U,
105 [OP_USBSTS] = 0x04U,
106 [OP_USBINTR] = 0x08U,
107 [OP_DEVICEADDR] = 0x14U,
108 [OP_ENDPTLISTADDR] = 0x18U,
109 [OP_PORTSC] = 0x44U,
110 [OP_DEVLC] = 0x84U,
111 [OP_OTGSC] = 0xC4U,
112 [OP_USBMODE] = 0xC8U,
113 [OP_ENDPTSETUPSTAT] = 0xD8U,
114 [OP_ENDPTPRIME] = 0xDCU,
115 [OP_ENDPTFLUSH] = 0xE0U,
116 [OP_ENDPTSTAT] = 0xE4U,
117 [OP_ENDPTCOMPLETE] = 0xE8U,
118 [OP_ENDPTCTRL] = 0xECU,
Alexander Shishkine443b332012-05-11 17:25:46 +0300119};
120
Alexander Shishkin8e229782013-06-24 14:46:36 +0300121static int hw_alloc_regmap(struct ci_hdrc *ci, bool is_lpm)
Alexander Shishkine443b332012-05-11 17:25:46 +0300122{
123 int i;
124
Alexander Shishkine443b332012-05-11 17:25:46 +0300125 for (i = 0; i < OP_ENDPTCTRL; i++)
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300126 ci->hw_bank.regmap[i] =
127 (i <= CAP_LAST ? ci->hw_bank.cap : ci->hw_bank.op) +
Alexander Shishkine443b332012-05-11 17:25:46 +0300128 (is_lpm ? ci_regs_lpm[i] : ci_regs_nolpm[i]);
129
130 for (; i <= OP_LAST; i++)
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300131 ci->hw_bank.regmap[i] = ci->hw_bank.op +
Alexander Shishkine443b332012-05-11 17:25:46 +0300132 4 * (i - OP_ENDPTCTRL) +
133 (is_lpm
134 ? ci_regs_lpm[OP_ENDPTCTRL]
135 : ci_regs_nolpm[OP_ENDPTCTRL]);
136
137 return 0;
138}
139
140/**
Li Jun36304b02014-04-23 15:56:39 +0800141 * hw_read_intr_enable: returns interrupt enable register
142 *
Peter Chen19353882014-09-22 08:14:17 +0800143 * @ci: the controller
144 *
Li Jun36304b02014-04-23 15:56:39 +0800145 * This function returns register data
146 */
147u32 hw_read_intr_enable(struct ci_hdrc *ci)
148{
149 return hw_read(ci, OP_USBINTR, ~0);
150}
151
152/**
153 * hw_read_intr_status: returns interrupt status register
154 *
Peter Chen19353882014-09-22 08:14:17 +0800155 * @ci: the controller
156 *
Li Jun36304b02014-04-23 15:56:39 +0800157 * This function returns register data
158 */
159u32 hw_read_intr_status(struct ci_hdrc *ci)
160{
161 return hw_read(ci, OP_USBSTS, ~0);
162}
163
164/**
Alexander Shishkine443b332012-05-11 17:25:46 +0300165 * hw_port_test_set: writes port test mode (execute without interruption)
166 * @mode: new value
167 *
168 * This function returns an error code
169 */
Alexander Shishkin8e229782013-06-24 14:46:36 +0300170int hw_port_test_set(struct ci_hdrc *ci, u8 mode)
Alexander Shishkine443b332012-05-11 17:25:46 +0300171{
172 const u8 TEST_MODE_MAX = 7;
173
174 if (mode > TEST_MODE_MAX)
175 return -EINVAL;
176
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200177 hw_write(ci, OP_PORTSC, PORTSC_PTC, mode << __ffs(PORTSC_PTC));
Alexander Shishkine443b332012-05-11 17:25:46 +0300178 return 0;
179}
180
181/**
182 * hw_port_test_get: reads port test mode value
183 *
Peter Chen19353882014-09-22 08:14:17 +0800184 * @ci: the controller
185 *
Alexander Shishkine443b332012-05-11 17:25:46 +0300186 * This function returns port test mode value
187 */
Alexander Shishkin8e229782013-06-24 14:46:36 +0300188u8 hw_port_test_get(struct ci_hdrc *ci)
Alexander Shishkine443b332012-05-11 17:25:46 +0300189{
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200190 return hw_read(ci, OP_PORTSC, PORTSC_PTC) >> __ffs(PORTSC_PTC);
Alexander Shishkine443b332012-05-11 17:25:46 +0300191}
192
Peter Chenb82613c2014-11-26 13:44:28 +0800193static void hw_wait_phy_stable(void)
194{
195 /*
196 * The phy needs some delay to output the stable status from low
197 * power mode. And for OTGSC, the status inputs are debounced
198 * using a 1 ms time constant, so, delay 2ms for controller to get
199 * the stable status, like vbus and id when the phy leaves low power.
200 */
201 usleep_range(2000, 2500);
202}
203
Peter Chen864cf942013-09-24 12:47:55 +0800204/* The PHY enters/leaves low power mode */
205static void ci_hdrc_enter_lpm(struct ci_hdrc *ci, bool enable)
206{
207 enum ci_hw_regs reg = ci->hw_bank.lpm ? OP_DEVLC : OP_PORTSC;
208 bool lpm = !!(hw_read(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm)));
209
Peter Chen6d037db2014-11-26 13:44:27 +0800210 if (enable && !lpm)
Peter Chen864cf942013-09-24 12:47:55 +0800211 hw_write(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm),
212 PORTSC_PHCD(ci->hw_bank.lpm));
Peter Chen6d037db2014-11-26 13:44:27 +0800213 else if (!enable && lpm)
Peter Chen864cf942013-09-24 12:47:55 +0800214 hw_write(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm),
215 0);
Peter Chen864cf942013-09-24 12:47:55 +0800216}
217
Alexander Shishkin8e229782013-06-24 14:46:36 +0300218static int hw_device_init(struct ci_hdrc *ci, void __iomem *base)
Alexander Shishkine443b332012-05-11 17:25:46 +0300219{
220 u32 reg;
221
222 /* bank is a module variable */
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300223 ci->hw_bank.abs = base;
Alexander Shishkine443b332012-05-11 17:25:46 +0300224
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300225 ci->hw_bank.cap = ci->hw_bank.abs;
Richard Zhao77c44002012-06-29 17:48:53 +0800226 ci->hw_bank.cap += ci->platdata->capoffset;
Svetoslav Neykov938d3232013-03-30 12:54:03 +0200227 ci->hw_bank.op = ci->hw_bank.cap + (ioread32(ci->hw_bank.cap) & 0xff);
Alexander Shishkine443b332012-05-11 17:25:46 +0300228
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300229 hw_alloc_regmap(ci, false);
230 reg = hw_read(ci, CAP_HCCPARAMS, HCCPARAMS_LEN) >>
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200231 __ffs(HCCPARAMS_LEN);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300232 ci->hw_bank.lpm = reg;
Chris Ruehlaeb2c122013-12-06 16:35:12 +0800233 if (reg)
234 hw_alloc_regmap(ci, !!reg);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300235 ci->hw_bank.size = ci->hw_bank.op - ci->hw_bank.abs;
236 ci->hw_bank.size += OP_LAST;
237 ci->hw_bank.size /= sizeof(u32);
Alexander Shishkine443b332012-05-11 17:25:46 +0300238
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300239 reg = hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DEN) >>
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200240 __ffs(DCCPARAMS_DEN);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300241 ci->hw_ep_max = reg * 2; /* cache hw ENDPT_MAX */
Alexander Shishkine443b332012-05-11 17:25:46 +0300242
Richard Zhao09c94e62012-05-15 21:58:18 +0800243 if (ci->hw_ep_max > ENDPT_MAX)
Alexander Shishkine443b332012-05-11 17:25:46 +0300244 return -ENODEV;
245
Peter Chen864cf942013-09-24 12:47:55 +0800246 ci_hdrc_enter_lpm(ci, false);
247
Peter Chenc344b512013-08-14 12:44:09 +0300248 /* Disable all interrupts bits */
249 hw_write(ci, OP_USBINTR, 0xffffffff, 0);
250
251 /* Clear all interrupts status bits*/
252 hw_write(ci, OP_USBSTS, 0xffffffff, 0xffffffff);
253
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300254 dev_dbg(ci->dev, "ChipIdea HDRC found, lpm: %d; cap: %p op: %p\n",
255 ci->hw_bank.lpm, ci->hw_bank.cap, ci->hw_bank.op);
Alexander Shishkine443b332012-05-11 17:25:46 +0300256
257 /* setup lock mode ? */
258
259 /* ENDPTSETUPSTAT is '0' by default */
260
261 /* HCSPARAMS.bf.ppc SHOULD BE zero for device */
262
263 return 0;
264}
265
Alexander Shishkin8e229782013-06-24 14:46:36 +0300266static void hw_phymode_configure(struct ci_hdrc *ci)
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300267{
Chris Ruehl3b5d3e62014-01-10 13:51:29 +0800268 u32 portsc, lpm, sts = 0;
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300269
270 switch (ci->platdata->phy_mode) {
271 case USBPHY_INTERFACE_MODE_UTMI:
272 portsc = PORTSC_PTS(PTS_UTMI);
273 lpm = DEVLC_PTS(PTS_UTMI);
274 break;
275 case USBPHY_INTERFACE_MODE_UTMIW:
276 portsc = PORTSC_PTS(PTS_UTMI) | PORTSC_PTW;
277 lpm = DEVLC_PTS(PTS_UTMI) | DEVLC_PTW;
278 break;
279 case USBPHY_INTERFACE_MODE_ULPI:
280 portsc = PORTSC_PTS(PTS_ULPI);
281 lpm = DEVLC_PTS(PTS_ULPI);
282 break;
283 case USBPHY_INTERFACE_MODE_SERIAL:
284 portsc = PORTSC_PTS(PTS_SERIAL);
285 lpm = DEVLC_PTS(PTS_SERIAL);
286 sts = 1;
287 break;
288 case USBPHY_INTERFACE_MODE_HSIC:
289 portsc = PORTSC_PTS(PTS_HSIC);
290 lpm = DEVLC_PTS(PTS_HSIC);
291 break;
292 default:
293 return;
294 }
295
296 if (ci->hw_bank.lpm) {
297 hw_write(ci, OP_DEVLC, DEVLC_PTS(7) | DEVLC_PTW, lpm);
Chris Ruehl3b5d3e62014-01-10 13:51:29 +0800298 if (sts)
299 hw_write(ci, OP_DEVLC, DEVLC_STS, DEVLC_STS);
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300300 } else {
301 hw_write(ci, OP_PORTSC, PORTSC_PTS(7) | PORTSC_PTW, portsc);
Chris Ruehl3b5d3e62014-01-10 13:51:29 +0800302 if (sts)
303 hw_write(ci, OP_PORTSC, PORTSC_STS, PORTSC_STS);
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300304 }
305}
306
Alexander Shishkine443b332012-05-11 17:25:46 +0300307/**
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100308 * _ci_usb_phy_init: initialize phy taking in account both phy and usb_phy
309 * interfaces
310 * @ci: the controller
311 *
312 * This function returns an error code if the phy failed to init
313 */
314static int _ci_usb_phy_init(struct ci_hdrc *ci)
315{
316 int ret;
317
318 if (ci->phy) {
319 ret = phy_init(ci->phy);
320 if (ret)
321 return ret;
322
323 ret = phy_power_on(ci->phy);
324 if (ret) {
325 phy_exit(ci->phy);
326 return ret;
327 }
328 } else {
329 ret = usb_phy_init(ci->usb_phy);
330 }
331
332 return ret;
333}
334
335/**
336 * _ci_usb_phy_exit: deinitialize phy taking in account both phy and usb_phy
337 * interfaces
338 * @ci: the controller
339 */
340static void ci_usb_phy_exit(struct ci_hdrc *ci)
341{
342 if (ci->phy) {
343 phy_power_off(ci->phy);
344 phy_exit(ci->phy);
345 } else {
346 usb_phy_shutdown(ci->usb_phy);
347 }
348}
349
350/**
Peter Chend03cccf2014-04-23 15:56:37 +0800351 * ci_usb_phy_init: initialize phy according to different phy type
352 * @ci: the controller
Peter Chen19353882014-09-22 08:14:17 +0800353 *
Peter Chend03cccf2014-04-23 15:56:37 +0800354 * This function returns an error code if usb_phy_init has failed
355 */
356static int ci_usb_phy_init(struct ci_hdrc *ci)
357{
358 int ret;
359
360 switch (ci->platdata->phy_mode) {
361 case USBPHY_INTERFACE_MODE_UTMI:
362 case USBPHY_INTERFACE_MODE_UTMIW:
363 case USBPHY_INTERFACE_MODE_HSIC:
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100364 ret = _ci_usb_phy_init(ci);
Peter Chenb82613c2014-11-26 13:44:28 +0800365 if (!ret)
366 hw_wait_phy_stable();
367 else
Peter Chend03cccf2014-04-23 15:56:37 +0800368 return ret;
369 hw_phymode_configure(ci);
370 break;
371 case USBPHY_INTERFACE_MODE_ULPI:
372 case USBPHY_INTERFACE_MODE_SERIAL:
373 hw_phymode_configure(ci);
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100374 ret = _ci_usb_phy_init(ci);
Peter Chend03cccf2014-04-23 15:56:37 +0800375 if (ret)
376 return ret;
377 break;
378 default:
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100379 ret = _ci_usb_phy_init(ci);
Peter Chenb82613c2014-11-26 13:44:28 +0800380 if (!ret)
381 hw_wait_phy_stable();
Peter Chend03cccf2014-04-23 15:56:37 +0800382 }
383
384 return ret;
385}
386
387/**
Peter Chencdd278f2014-11-26 13:44:32 +0800388 * hw_controller_reset: do controller reset
Alexander Shishkine443b332012-05-11 17:25:46 +0300389 * @ci: the controller
390 *
391 * This function returns an error code
392 */
Peter Chencdd278f2014-11-26 13:44:32 +0800393static int hw_controller_reset(struct ci_hdrc *ci)
394{
395 int count = 0;
396
397 hw_write(ci, OP_USBCMD, USBCMD_RST, USBCMD_RST);
398 while (hw_read(ci, OP_USBCMD, USBCMD_RST)) {
399 udelay(10);
400 if (count++ > 1000)
401 return -ETIMEDOUT;
402 }
403
404 return 0;
405}
406
407/**
408 * hw_device_reset: resets chip (execute without interruption)
409 * @ci: the controller
410 *
411 * This function returns an error code
412 */
Peter Chen5b157302014-11-26 13:44:33 +0800413int hw_device_reset(struct ci_hdrc *ci)
Alexander Shishkine443b332012-05-11 17:25:46 +0300414{
Peter Chencdd278f2014-11-26 13:44:32 +0800415 int ret;
416
Alexander Shishkine443b332012-05-11 17:25:46 +0300417 /* should flush & stop before reset */
418 hw_write(ci, OP_ENDPTFLUSH, ~0, ~0);
419 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
420
Peter Chencdd278f2014-11-26 13:44:32 +0800421 ret = hw_controller_reset(ci);
422 if (ret) {
423 dev_err(ci->dev, "error resetting controller, ret=%d\n", ret);
424 return ret;
425 }
Alexander Shishkine443b332012-05-11 17:25:46 +0300426
Richard Zhao77c44002012-06-29 17:48:53 +0800427 if (ci->platdata->notify_event)
428 ci->platdata->notify_event(ci,
Alexander Shishkin8e229782013-06-24 14:46:36 +0300429 CI_HDRC_CONTROLLER_RESET_EVENT);
Alexander Shishkine443b332012-05-11 17:25:46 +0300430
Alexander Shishkin8e229782013-06-24 14:46:36 +0300431 if (ci->platdata->flags & CI_HDRC_DISABLE_STREAMING)
Alexander Shishkin758fc982012-05-11 17:25:53 +0300432 hw_write(ci, OP_USBMODE, USBMODE_CI_SDIS, USBMODE_CI_SDIS);
Alexander Shishkine443b332012-05-11 17:25:46 +0300433
Michael Grzeschik4f6743d2014-02-19 13:41:43 +0800434 if (ci->platdata->flags & CI_HDRC_FORCE_FULLSPEED) {
435 if (ci->hw_bank.lpm)
436 hw_write(ci, OP_DEVLC, DEVLC_PFSC, DEVLC_PFSC);
437 else
438 hw_write(ci, OP_PORTSC, PORTSC_PFSC, PORTSC_PFSC);
439 }
440
Alexander Shishkine443b332012-05-11 17:25:46 +0300441 /* USBMODE should be configured step by step */
442 hw_write(ci, OP_USBMODE, USBMODE_CM, USBMODE_CM_IDLE);
Peter Chen5b157302014-11-26 13:44:33 +0800443 hw_write(ci, OP_USBMODE, USBMODE_CM, USBMODE_CM_DC);
Alexander Shishkine443b332012-05-11 17:25:46 +0300444 /* HW >= 2.3 */
445 hw_write(ci, OP_USBMODE, USBMODE_SLOM, USBMODE_SLOM);
446
Peter Chen5b157302014-11-26 13:44:33 +0800447 if (hw_read(ci, OP_USBMODE, USBMODE_CM) != USBMODE_CM_DC) {
448 pr_err("cannot enter in %s device mode", ci_role(ci)->name);
Alexander Shishkine443b332012-05-11 17:25:46 +0300449 pr_err("lpm = %i", ci->hw_bank.lpm);
450 return -ENODEV;
451 }
452
453 return 0;
454}
455
Peter Chen22fa8442013-08-14 12:44:12 +0300456/**
457 * hw_wait_reg: wait the register value
458 *
459 * Sometimes, it needs to wait register value before going on.
460 * Eg, when switch to device mode, the vbus value should be lower
461 * than OTGSC_BSV before connects to host.
462 *
463 * @ci: the controller
464 * @reg: register index
465 * @mask: mast bit
466 * @value: the bit value to wait
467 * @timeout_ms: timeout in millisecond
468 *
469 * This function returns an error code if timeout
470 */
471int hw_wait_reg(struct ci_hdrc *ci, enum ci_hw_regs reg, u32 mask,
472 u32 value, unsigned int timeout_ms)
473{
474 unsigned long elapse = jiffies + msecs_to_jiffies(timeout_ms);
475
476 while (hw_read(ci, reg, mask) != value) {
477 if (time_after(jiffies, elapse)) {
478 dev_err(ci->dev, "timeout waiting for %08x in %d\n",
479 mask, reg);
480 return -ETIMEDOUT;
481 }
482 msleep(20);
483 }
484
485 return 0;
486}
487
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300488static irqreturn_t ci_irq(int irq, void *data)
489{
Alexander Shishkin8e229782013-06-24 14:46:36 +0300490 struct ci_hdrc *ci = data;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300491 irqreturn_t ret = IRQ_NONE;
Richard Zhaob183c192012-09-12 14:58:11 +0300492 u32 otgsc = 0;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300493
Li Jun4dcf7202014-04-23 15:56:50 +0800494 if (ci->is_otg) {
Li Jun0c33bf72014-04-23 15:56:38 +0800495 otgsc = hw_read_otgsc(ci, ~0);
Li Jun4dcf7202014-04-23 15:56:50 +0800496 if (ci_otg_is_fsm_mode(ci)) {
497 ret = ci_otg_fsm_irq(ci);
498 if (ret == IRQ_HANDLED)
499 return ret;
500 }
501 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300502
Peter Chena107f8c2013-08-14 12:44:11 +0300503 /*
504 * Handle id change interrupt, it indicates device/host function
505 * switch.
506 */
507 if (ci->is_otg && (otgsc & OTGSC_IDIE) && (otgsc & OTGSC_IDIS)) {
508 ci->id_event = true;
Li Jun0c33bf72014-04-23 15:56:38 +0800509 /* Clear ID change irq status */
510 hw_write_otgsc(ci, OTGSC_IDIS, OTGSC_IDIS);
Peter Chenbe6b0c12014-05-23 08:12:49 +0800511 ci_otg_queue_work(ci);
Peter Chena107f8c2013-08-14 12:44:11 +0300512 return IRQ_HANDLED;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300513 }
514
Peter Chena107f8c2013-08-14 12:44:11 +0300515 /*
516 * Handle vbus change interrupt, it indicates device connection
517 * and disconnection events.
518 */
519 if (ci->is_otg && (otgsc & OTGSC_BSVIE) && (otgsc & OTGSC_BSVIS)) {
520 ci->b_sess_valid_event = true;
Li Jun0c33bf72014-04-23 15:56:38 +0800521 /* Clear BSV irq */
522 hw_write_otgsc(ci, OTGSC_BSVIS, OTGSC_BSVIS);
Peter Chenbe6b0c12014-05-23 08:12:49 +0800523 ci_otg_queue_work(ci);
Peter Chena107f8c2013-08-14 12:44:11 +0300524 return IRQ_HANDLED;
525 }
526
527 /* Handle device/host interrupt */
528 if (ci->role != CI_ROLE_END)
529 ret = ci_role(ci)->irq(ci);
530
Richard Zhaob183c192012-09-12 14:58:11 +0300531 return ret;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300532}
533
Peter Chen1542d9c2013-08-14 12:44:03 +0300534static int ci_get_platdata(struct device *dev,
535 struct ci_hdrc_platform_data *platdata)
536{
Peter Chenc22600c2013-09-17 12:37:22 +0800537 if (!platdata->phy_mode)
538 platdata->phy_mode = of_usb_get_phy_mode(dev->of_node);
539
540 if (!platdata->dr_mode)
541 platdata->dr_mode = of_usb_get_dr_mode(dev->of_node);
542
543 if (platdata->dr_mode == USB_DR_MODE_UNKNOWN)
544 platdata->dr_mode = USB_DR_MODE_OTG;
545
Peter Chenc2ec3a72013-10-30 09:19:29 +0800546 if (platdata->dr_mode != USB_DR_MODE_PERIPHERAL) {
547 /* Get the vbus regulator */
548 platdata->reg_vbus = devm_regulator_get(dev, "vbus");
549 if (PTR_ERR(platdata->reg_vbus) == -EPROBE_DEFER) {
550 return -EPROBE_DEFER;
551 } else if (PTR_ERR(platdata->reg_vbus) == -ENODEV) {
552 /* no vbus regualator is needed */
553 platdata->reg_vbus = NULL;
554 } else if (IS_ERR(platdata->reg_vbus)) {
555 dev_err(dev, "Getting regulator error: %ld\n",
556 PTR_ERR(platdata->reg_vbus));
557 return PTR_ERR(platdata->reg_vbus);
558 }
Peter Chenf6a9ff02014-08-19 09:51:56 +0800559 /* Get TPL support */
560 if (!platdata->tpl_support)
561 platdata->tpl_support =
562 of_usb_host_tpl_support(dev->of_node);
Peter Chenc2ec3a72013-10-30 09:19:29 +0800563 }
564
Michael Grzeschik4f6743d2014-02-19 13:41:43 +0800565 if (of_usb_get_maximum_speed(dev->of_node) == USB_SPEED_FULL)
566 platdata->flags |= CI_HDRC_FORCE_FULLSPEED;
567
Peter Chen1542d9c2013-08-14 12:44:03 +0300568 return 0;
569}
570
Richard Zhaofe6e1252012-07-07 22:56:42 +0800571static DEFINE_IDA(ci_ida);
572
Alexander Shishkin8e229782013-06-24 14:46:36 +0300573struct platform_device *ci_hdrc_add_device(struct device *dev,
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800574 struct resource *res, int nres,
Alexander Shishkin8e229782013-06-24 14:46:36 +0300575 struct ci_hdrc_platform_data *platdata)
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800576{
577 struct platform_device *pdev;
Richard Zhaofe6e1252012-07-07 22:56:42 +0800578 int id, ret;
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800579
Peter Chen1542d9c2013-08-14 12:44:03 +0300580 ret = ci_get_platdata(dev, platdata);
581 if (ret)
582 return ERR_PTR(ret);
583
Richard Zhaofe6e1252012-07-07 22:56:42 +0800584 id = ida_simple_get(&ci_ida, 0, 0, GFP_KERNEL);
585 if (id < 0)
586 return ERR_PTR(id);
587
588 pdev = platform_device_alloc("ci_hdrc", id);
589 if (!pdev) {
590 ret = -ENOMEM;
591 goto put_id;
592 }
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800593
594 pdev->dev.parent = dev;
595 pdev->dev.dma_mask = dev->dma_mask;
596 pdev->dev.dma_parms = dev->dma_parms;
597 dma_set_coherent_mask(&pdev->dev, dev->coherent_dma_mask);
598
599 ret = platform_device_add_resources(pdev, res, nres);
600 if (ret)
601 goto err;
602
603 ret = platform_device_add_data(pdev, platdata, sizeof(*platdata));
604 if (ret)
605 goto err;
606
607 ret = platform_device_add(pdev);
608 if (ret)
609 goto err;
610
611 return pdev;
612
613err:
614 platform_device_put(pdev);
Richard Zhaofe6e1252012-07-07 22:56:42 +0800615put_id:
616 ida_simple_remove(&ci_ida, id);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800617 return ERR_PTR(ret);
618}
Alexander Shishkin8e229782013-06-24 14:46:36 +0300619EXPORT_SYMBOL_GPL(ci_hdrc_add_device);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800620
Alexander Shishkin8e229782013-06-24 14:46:36 +0300621void ci_hdrc_remove_device(struct platform_device *pdev)
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800622{
Lothar Waßmann98c35532012-11-22 10:11:25 +0100623 int id = pdev->id;
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800624 platform_device_unregister(pdev);
Lothar Waßmann98c35532012-11-22 10:11:25 +0100625 ida_simple_remove(&ci_ida, id);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800626}
Alexander Shishkin8e229782013-06-24 14:46:36 +0300627EXPORT_SYMBOL_GPL(ci_hdrc_remove_device);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800628
Peter Chen3f124d22013-08-14 12:44:07 +0300629static inline void ci_role_destroy(struct ci_hdrc *ci)
630{
631 ci_hdrc_gadget_destroy(ci);
632 ci_hdrc_host_destroy(ci);
Peter Chencbec6bd2013-08-14 12:44:10 +0300633 if (ci->is_otg)
634 ci_hdrc_otg_destroy(ci);
Peter Chen3f124d22013-08-14 12:44:07 +0300635}
636
Peter Chen577b2322013-08-14 12:44:08 +0300637static void ci_get_otg_capable(struct ci_hdrc *ci)
638{
639 if (ci->platdata->flags & CI_HDRC_DUAL_ROLE_NOT_OTG)
640 ci->is_otg = false;
641 else
642 ci->is_otg = (hw_read(ci, CAP_DCCPARAMS,
643 DCCPARAMS_DC | DCCPARAMS_HC)
644 == (DCCPARAMS_DC | DCCPARAMS_HC));
Peter Chen90893b92014-04-23 15:56:41 +0800645 if (ci->is_otg)
Peter Chen577b2322013-08-14 12:44:08 +0300646 dev_dbg(ci->dev, "It is OTG capable controller\n");
647}
648
Bill Pemberton41ac7b32012-11-19 13:21:48 -0500649static int ci_hdrc_probe(struct platform_device *pdev)
Alexander Shishkine443b332012-05-11 17:25:46 +0300650{
651 struct device *dev = &pdev->dev;
Alexander Shishkin8e229782013-06-24 14:46:36 +0300652 struct ci_hdrc *ci;
Alexander Shishkine443b332012-05-11 17:25:46 +0300653 struct resource *res;
654 void __iomem *base;
655 int ret;
Sascha Hauer691962d2013-06-13 17:59:57 +0300656 enum usb_dr_mode dr_mode;
Alexander Shishkine443b332012-05-11 17:25:46 +0300657
Jingoo Hanfad56742014-02-19 13:41:42 +0800658 if (!dev_get_platdata(dev)) {
Alexander Shishkine443b332012-05-11 17:25:46 +0300659 dev_err(dev, "platform data missing\n");
660 return -ENODEV;
661 }
662
663 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
Felipe Balbi19290812013-03-30 02:46:27 +0200664 base = devm_ioremap_resource(dev, res);
665 if (IS_ERR(base))
666 return PTR_ERR(base);
Alexander Shishkine443b332012-05-11 17:25:46 +0300667
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300668 ci = devm_kzalloc(dev, sizeof(*ci), GFP_KERNEL);
Fabio Estevamd0f99242014-11-26 13:44:23 +0800669 if (!ci)
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300670 return -ENOMEM;
Alexander Shishkine443b332012-05-11 17:25:46 +0300671
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300672 ci->dev = dev;
Jingoo Hanfad56742014-02-19 13:41:42 +0800673 ci->platdata = dev_get_platdata(dev);
Peter Chened8f8312014-01-10 13:51:27 +0800674 ci->imx28_write_fix = !!(ci->platdata->flags &
675 CI_HDRC_IMX28_WRITE_FIX);
Alexander Shishkine443b332012-05-11 17:25:46 +0300676
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300677 ret = hw_device_init(ci, base);
678 if (ret < 0) {
679 dev_err(dev, "can't initialize hardware\n");
680 return -ENODEV;
681 }
682
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100683 if (ci->platdata->phy) {
684 ci->phy = ci->platdata->phy;
685 } else if (ci->platdata->usb_phy) {
Antoine Tenartef44cb42014-10-30 18:41:16 +0100686 ci->usb_phy = ci->platdata->usb_phy;
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100687 } else {
688 ci->phy = devm_phy_get(dev, "usb-phy");
Antoine Tenartef44cb42014-10-30 18:41:16 +0100689 ci->usb_phy = devm_usb_get_phy(dev, USB_PHY_TYPE_USB2);
Peter Chenc859aa652014-02-19 13:41:40 +0800690
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100691 /* if both generic PHY and USB PHY layers aren't enabled */
692 if (PTR_ERR(ci->phy) == -ENOSYS &&
693 PTR_ERR(ci->usb_phy) == -ENXIO)
694 return -ENXIO;
Peter Chenc859aa652014-02-19 13:41:40 +0800695
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100696 if (IS_ERR(ci->phy) && IS_ERR(ci->usb_phy))
697 return -EPROBE_DEFER;
698
699 if (IS_ERR(ci->phy))
700 ci->phy = NULL;
701 else if (IS_ERR(ci->usb_phy))
702 ci->usb_phy = NULL;
Peter Chenc859aa652014-02-19 13:41:40 +0800703 }
704
Peter Chend03cccf2014-04-23 15:56:37 +0800705 ret = ci_usb_phy_init(ci);
Peter Chen74475ed2013-09-24 12:47:53 +0800706 if (ret) {
707 dev_err(dev, "unable to init phy: %d\n", ret);
708 return ret;
709 }
710
Alexander Shishkineb70e5a2012-05-11 17:25:54 +0300711 ci->hw_bank.phys = res->start;
712
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300713 ci->irq = platform_get_irq(pdev, 0);
714 if (ci->irq < 0) {
715 dev_err(dev, "missing IRQ\n");
Fabio Estevam42d18212014-02-19 13:41:44 +0800716 ret = ci->irq;
Peter Chenc859aa652014-02-19 13:41:40 +0800717 goto deinit_phy;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300718 }
719
Peter Chen577b2322013-08-14 12:44:08 +0300720 ci_get_otg_capable(ci);
721
Sascha Hauer691962d2013-06-13 17:59:57 +0300722 dr_mode = ci->platdata->dr_mode;
723 /* initialize role(s) before the interrupt is requested */
724 if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_HOST) {
725 ret = ci_hdrc_host_init(ci);
726 if (ret)
727 dev_info(dev, "doesn't support host\n");
728 }
729
730 if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_PERIPHERAL) {
731 ret = ci_hdrc_gadget_init(ci);
732 if (ret)
733 dev_info(dev, "doesn't support gadget\n");
734 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300735
736 if (!ci->roles[CI_ROLE_HOST] && !ci->roles[CI_ROLE_GADGET]) {
737 dev_err(dev, "no supported roles\n");
Peter Chen74475ed2013-09-24 12:47:53 +0800738 ret = -ENODEV;
Peter Chenc859aa652014-02-19 13:41:40 +0800739 goto deinit_phy;
Peter Chencbec6bd2013-08-14 12:44:10 +0300740 }
741
Peter Chen27c62c22014-09-22 08:14:16 +0800742 if (ci->is_otg && ci->roles[CI_ROLE_GADGET]) {
Peter Chen90893b92014-04-23 15:56:41 +0800743 /* Disable and clear all OTG irq */
744 hw_write_otgsc(ci, OTGSC_INT_EN_BITS | OTGSC_INT_STATUS_BITS,
745 OTGSC_INT_STATUS_BITS);
Peter Chencbec6bd2013-08-14 12:44:10 +0300746 ret = ci_hdrc_otg_init(ci);
747 if (ret) {
748 dev_err(dev, "init otg fails, ret = %d\n", ret);
749 goto stop;
750 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300751 }
752
753 if (ci->roles[CI_ROLE_HOST] && ci->roles[CI_ROLE_GADGET]) {
Peter Chen577b2322013-08-14 12:44:08 +0300754 if (ci->is_otg) {
Peter Chen577b2322013-08-14 12:44:08 +0300755 ci->role = ci_otg_role(ci);
Li Jun0c33bf72014-04-23 15:56:38 +0800756 /* Enable ID change irq */
757 hw_write_otgsc(ci, OTGSC_IDIE, OTGSC_IDIE);
Peter Chen577b2322013-08-14 12:44:08 +0300758 } else {
759 /*
760 * If the controller is not OTG capable, but support
761 * role switch, the defalt role is gadget, and the
762 * user can switch it through debugfs.
763 */
764 ci->role = CI_ROLE_GADGET;
765 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300766 } else {
767 ci->role = ci->roles[CI_ROLE_HOST]
768 ? CI_ROLE_HOST
769 : CI_ROLE_GADGET;
770 }
771
Peter Chen5a1e1452013-12-05 15:20:50 +0800772 /* only update vbus status for peripheral */
773 if (ci->role == CI_ROLE_GADGET)
774 ci_handle_vbus_change(ci);
775
Li Jun4dcf7202014-04-23 15:56:50 +0800776 if (!ci_otg_is_fsm_mode(ci)) {
777 ret = ci_role_start(ci, ci->role);
778 if (ret) {
779 dev_err(dev, "can't start %s role\n",
780 ci_role(ci)->name);
781 goto stop;
782 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300783 }
784
785 platform_set_drvdata(pdev, ci);
Peter Chen4c503dd2014-11-26 13:44:22 +0800786 ret = devm_request_irq(dev, ci->irq, ci_irq, IRQF_SHARED,
787 ci->platdata->name, ci);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300788 if (ret)
789 goto stop;
790
Li Jun4dcf7202014-04-23 15:56:50 +0800791 if (ci_otg_is_fsm_mode(ci))
792 ci_hdrc_otg_fsm_start(ci);
793
Alexander Shishkinadf0f732013-03-30 12:53:53 +0200794 ret = dbg_create_files(ci);
795 if (!ret)
796 return 0;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300797
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300798stop:
Peter Chen3f124d22013-08-14 12:44:07 +0300799 ci_role_destroy(ci);
Peter Chenc859aa652014-02-19 13:41:40 +0800800deinit_phy:
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100801 ci_usb_phy_exit(ci);
Alexander Shishkine443b332012-05-11 17:25:46 +0300802
803 return ret;
804}
805
Bill Pembertonfb4e98a2012-11-19 13:26:20 -0500806static int ci_hdrc_remove(struct platform_device *pdev)
Alexander Shishkine443b332012-05-11 17:25:46 +0300807{
Alexander Shishkin8e229782013-06-24 14:46:36 +0300808 struct ci_hdrc *ci = platform_get_drvdata(pdev);
Alexander Shishkine443b332012-05-11 17:25:46 +0300809
Alexander Shishkinadf0f732013-03-30 12:53:53 +0200810 dbg_remove_files(ci);
Peter Chen3f124d22013-08-14 12:44:07 +0300811 ci_role_destroy(ci);
Peter Chen864cf942013-09-24 12:47:55 +0800812 ci_hdrc_enter_lpm(ci, true);
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100813 ci_usb_phy_exit(ci);
Alexander Shishkine443b332012-05-11 17:25:46 +0300814
815 return 0;
816}
817
Peter Chen80769322014-11-26 13:44:29 +0800818#ifdef CONFIG_PM_SLEEP
819static void ci_controller_suspend(struct ci_hdrc *ci)
820{
821 ci_hdrc_enter_lpm(ci, true);
822
823 if (ci->usb_phy)
824 usb_phy_set_suspend(ci->usb_phy, 1);
825}
826
827static int ci_controller_resume(struct device *dev)
828{
829 struct ci_hdrc *ci = dev_get_drvdata(dev);
830
831 dev_dbg(dev, "at %s\n", __func__);
832
833 ci_hdrc_enter_lpm(ci, false);
834
835 if (ci->usb_phy) {
836 usb_phy_set_suspend(ci->usb_phy, 0);
837 usb_phy_set_wakeup(ci->usb_phy, false);
838 hw_wait_phy_stable();
839 }
840
841 return 0;
842}
843
844static int ci_suspend(struct device *dev)
845{
846 struct ci_hdrc *ci = dev_get_drvdata(dev);
847
848 if (ci->wq)
849 flush_workqueue(ci->wq);
850
851 ci_controller_suspend(ci);
852
853 return 0;
854}
855
856static int ci_resume(struct device *dev)
857{
858 return ci_controller_resume(dev);
859}
860#endif /* CONFIG_PM_SLEEP */
861
862static const struct dev_pm_ops ci_pm_ops = {
863 SET_SYSTEM_SLEEP_PM_OPS(ci_suspend, ci_resume)
864};
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300865static struct platform_driver ci_hdrc_driver = {
866 .probe = ci_hdrc_probe,
Bill Pemberton76904172012-11-19 13:21:08 -0500867 .remove = ci_hdrc_remove,
Alexander Shishkine443b332012-05-11 17:25:46 +0300868 .driver = {
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300869 .name = "ci_hdrc",
Peter Chen80769322014-11-26 13:44:29 +0800870 .pm = &ci_pm_ops,
Alexander Shiyan7cf2f862014-04-23 15:56:42 +0800871 .owner = THIS_MODULE,
Alexander Shishkine443b332012-05-11 17:25:46 +0300872 },
873};
874
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300875module_platform_driver(ci_hdrc_driver);
Alexander Shishkine443b332012-05-11 17:25:46 +0300876
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300877MODULE_ALIAS("platform:ci_hdrc");
Alexander Shishkine443b332012-05-11 17:25:46 +0300878MODULE_LICENSE("GPL v2");
879MODULE_AUTHOR("David Lopo <dlopo@chipidea.mips.com>");
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300880MODULE_DESCRIPTION("ChipIdea HDRC Driver");