blob: d87caea261d978eea1ec7676bc9b20d5271d1b0c [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 Chen864cf942013-09-24 12:47:55 +0800193/* The PHY enters/leaves low power mode */
194static void ci_hdrc_enter_lpm(struct ci_hdrc *ci, bool enable)
195{
196 enum ci_hw_regs reg = ci->hw_bank.lpm ? OP_DEVLC : OP_PORTSC;
197 bool lpm = !!(hw_read(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm)));
198
Peter Chen6d037db2014-11-26 13:44:27 +0800199 if (enable && !lpm)
Peter Chen864cf942013-09-24 12:47:55 +0800200 hw_write(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm),
201 PORTSC_PHCD(ci->hw_bank.lpm));
Peter Chen6d037db2014-11-26 13:44:27 +0800202 else if (!enable && lpm)
Peter Chen864cf942013-09-24 12:47:55 +0800203 hw_write(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm),
204 0);
Peter Chen864cf942013-09-24 12:47:55 +0800205}
206
Alexander Shishkin8e229782013-06-24 14:46:36 +0300207static int hw_device_init(struct ci_hdrc *ci, void __iomem *base)
Alexander Shishkine443b332012-05-11 17:25:46 +0300208{
209 u32 reg;
210
211 /* bank is a module variable */
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300212 ci->hw_bank.abs = base;
Alexander Shishkine443b332012-05-11 17:25:46 +0300213
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300214 ci->hw_bank.cap = ci->hw_bank.abs;
Richard Zhao77c44002012-06-29 17:48:53 +0800215 ci->hw_bank.cap += ci->platdata->capoffset;
Svetoslav Neykov938d3232013-03-30 12:54:03 +0200216 ci->hw_bank.op = ci->hw_bank.cap + (ioread32(ci->hw_bank.cap) & 0xff);
Alexander Shishkine443b332012-05-11 17:25:46 +0300217
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300218 hw_alloc_regmap(ci, false);
219 reg = hw_read(ci, CAP_HCCPARAMS, HCCPARAMS_LEN) >>
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200220 __ffs(HCCPARAMS_LEN);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300221 ci->hw_bank.lpm = reg;
Chris Ruehlaeb2c122013-12-06 16:35:12 +0800222 if (reg)
223 hw_alloc_regmap(ci, !!reg);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300224 ci->hw_bank.size = ci->hw_bank.op - ci->hw_bank.abs;
225 ci->hw_bank.size += OP_LAST;
226 ci->hw_bank.size /= sizeof(u32);
Alexander Shishkine443b332012-05-11 17:25:46 +0300227
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300228 reg = hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DEN) >>
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200229 __ffs(DCCPARAMS_DEN);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300230 ci->hw_ep_max = reg * 2; /* cache hw ENDPT_MAX */
Alexander Shishkine443b332012-05-11 17:25:46 +0300231
Richard Zhao09c94e62012-05-15 21:58:18 +0800232 if (ci->hw_ep_max > ENDPT_MAX)
Alexander Shishkine443b332012-05-11 17:25:46 +0300233 return -ENODEV;
234
Peter Chen864cf942013-09-24 12:47:55 +0800235 ci_hdrc_enter_lpm(ci, false);
236
Peter Chenc344b512013-08-14 12:44:09 +0300237 /* Disable all interrupts bits */
238 hw_write(ci, OP_USBINTR, 0xffffffff, 0);
239
240 /* Clear all interrupts status bits*/
241 hw_write(ci, OP_USBSTS, 0xffffffff, 0xffffffff);
242
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300243 dev_dbg(ci->dev, "ChipIdea HDRC found, lpm: %d; cap: %p op: %p\n",
244 ci->hw_bank.lpm, ci->hw_bank.cap, ci->hw_bank.op);
Alexander Shishkine443b332012-05-11 17:25:46 +0300245
246 /* setup lock mode ? */
247
248 /* ENDPTSETUPSTAT is '0' by default */
249
250 /* HCSPARAMS.bf.ppc SHOULD BE zero for device */
251
252 return 0;
253}
254
Alexander Shishkin8e229782013-06-24 14:46:36 +0300255static void hw_phymode_configure(struct ci_hdrc *ci)
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300256{
Chris Ruehl3b5d3e62014-01-10 13:51:29 +0800257 u32 portsc, lpm, sts = 0;
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300258
259 switch (ci->platdata->phy_mode) {
260 case USBPHY_INTERFACE_MODE_UTMI:
261 portsc = PORTSC_PTS(PTS_UTMI);
262 lpm = DEVLC_PTS(PTS_UTMI);
263 break;
264 case USBPHY_INTERFACE_MODE_UTMIW:
265 portsc = PORTSC_PTS(PTS_UTMI) | PORTSC_PTW;
266 lpm = DEVLC_PTS(PTS_UTMI) | DEVLC_PTW;
267 break;
268 case USBPHY_INTERFACE_MODE_ULPI:
269 portsc = PORTSC_PTS(PTS_ULPI);
270 lpm = DEVLC_PTS(PTS_ULPI);
271 break;
272 case USBPHY_INTERFACE_MODE_SERIAL:
273 portsc = PORTSC_PTS(PTS_SERIAL);
274 lpm = DEVLC_PTS(PTS_SERIAL);
275 sts = 1;
276 break;
277 case USBPHY_INTERFACE_MODE_HSIC:
278 portsc = PORTSC_PTS(PTS_HSIC);
279 lpm = DEVLC_PTS(PTS_HSIC);
280 break;
281 default:
282 return;
283 }
284
285 if (ci->hw_bank.lpm) {
286 hw_write(ci, OP_DEVLC, DEVLC_PTS(7) | DEVLC_PTW, lpm);
Chris Ruehl3b5d3e62014-01-10 13:51:29 +0800287 if (sts)
288 hw_write(ci, OP_DEVLC, DEVLC_STS, DEVLC_STS);
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300289 } else {
290 hw_write(ci, OP_PORTSC, PORTSC_PTS(7) | PORTSC_PTW, portsc);
Chris Ruehl3b5d3e62014-01-10 13:51:29 +0800291 if (sts)
292 hw_write(ci, OP_PORTSC, PORTSC_STS, PORTSC_STS);
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300293 }
294}
295
Alexander Shishkine443b332012-05-11 17:25:46 +0300296/**
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100297 * _ci_usb_phy_init: initialize phy taking in account both phy and usb_phy
298 * interfaces
299 * @ci: the controller
300 *
301 * This function returns an error code if the phy failed to init
302 */
303static int _ci_usb_phy_init(struct ci_hdrc *ci)
304{
305 int ret;
306
307 if (ci->phy) {
308 ret = phy_init(ci->phy);
309 if (ret)
310 return ret;
311
312 ret = phy_power_on(ci->phy);
313 if (ret) {
314 phy_exit(ci->phy);
315 return ret;
316 }
317 } else {
318 ret = usb_phy_init(ci->usb_phy);
319 }
320
321 return ret;
322}
323
324/**
325 * _ci_usb_phy_exit: deinitialize phy taking in account both phy and usb_phy
326 * interfaces
327 * @ci: the controller
328 */
329static void ci_usb_phy_exit(struct ci_hdrc *ci)
330{
331 if (ci->phy) {
332 phy_power_off(ci->phy);
333 phy_exit(ci->phy);
334 } else {
335 usb_phy_shutdown(ci->usb_phy);
336 }
337}
338
339/**
Peter Chend03cccf2014-04-23 15:56:37 +0800340 * ci_usb_phy_init: initialize phy according to different phy type
341 * @ci: the controller
Peter Chen19353882014-09-22 08:14:17 +0800342 *
Peter Chend03cccf2014-04-23 15:56:37 +0800343 * This function returns an error code if usb_phy_init has failed
344 */
345static int ci_usb_phy_init(struct ci_hdrc *ci)
346{
347 int ret;
348
349 switch (ci->platdata->phy_mode) {
350 case USBPHY_INTERFACE_MODE_UTMI:
351 case USBPHY_INTERFACE_MODE_UTMIW:
352 case USBPHY_INTERFACE_MODE_HSIC:
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100353 ret = _ci_usb_phy_init(ci);
Peter Chend03cccf2014-04-23 15:56:37 +0800354 if (ret)
355 return ret;
356 hw_phymode_configure(ci);
357 break;
358 case USBPHY_INTERFACE_MODE_ULPI:
359 case USBPHY_INTERFACE_MODE_SERIAL:
360 hw_phymode_configure(ci);
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100361 ret = _ci_usb_phy_init(ci);
Peter Chend03cccf2014-04-23 15:56:37 +0800362 if (ret)
363 return ret;
364 break;
365 default:
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100366 ret = _ci_usb_phy_init(ci);
Peter Chend03cccf2014-04-23 15:56:37 +0800367 }
368
369 return ret;
370}
371
372/**
Alexander Shishkine443b332012-05-11 17:25:46 +0300373 * hw_device_reset: resets chip (execute without interruption)
374 * @ci: the controller
375 *
376 * This function returns an error code
377 */
Alexander Shishkin8e229782013-06-24 14:46:36 +0300378int hw_device_reset(struct ci_hdrc *ci, u32 mode)
Alexander Shishkine443b332012-05-11 17:25:46 +0300379{
380 /* should flush & stop before reset */
381 hw_write(ci, OP_ENDPTFLUSH, ~0, ~0);
382 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
383
384 hw_write(ci, OP_USBCMD, USBCMD_RST, USBCMD_RST);
385 while (hw_read(ci, OP_USBCMD, USBCMD_RST))
386 udelay(10); /* not RTOS friendly */
387
Richard Zhao77c44002012-06-29 17:48:53 +0800388 if (ci->platdata->notify_event)
389 ci->platdata->notify_event(ci,
Alexander Shishkin8e229782013-06-24 14:46:36 +0300390 CI_HDRC_CONTROLLER_RESET_EVENT);
Alexander Shishkine443b332012-05-11 17:25:46 +0300391
Alexander Shishkin8e229782013-06-24 14:46:36 +0300392 if (ci->platdata->flags & CI_HDRC_DISABLE_STREAMING)
Alexander Shishkin758fc982012-05-11 17:25:53 +0300393 hw_write(ci, OP_USBMODE, USBMODE_CI_SDIS, USBMODE_CI_SDIS);
Alexander Shishkine443b332012-05-11 17:25:46 +0300394
Michael Grzeschik4f6743d2014-02-19 13:41:43 +0800395 if (ci->platdata->flags & CI_HDRC_FORCE_FULLSPEED) {
396 if (ci->hw_bank.lpm)
397 hw_write(ci, OP_DEVLC, DEVLC_PFSC, DEVLC_PFSC);
398 else
399 hw_write(ci, OP_PORTSC, PORTSC_PFSC, PORTSC_PFSC);
400 }
401
Alexander Shishkine443b332012-05-11 17:25:46 +0300402 /* USBMODE should be configured step by step */
403 hw_write(ci, OP_USBMODE, USBMODE_CM, USBMODE_CM_IDLE);
Alexander Shishkineb70e5a2012-05-11 17:25:54 +0300404 hw_write(ci, OP_USBMODE, USBMODE_CM, mode);
Alexander Shishkine443b332012-05-11 17:25:46 +0300405 /* HW >= 2.3 */
406 hw_write(ci, OP_USBMODE, USBMODE_SLOM, USBMODE_SLOM);
407
Alexander Shishkineb70e5a2012-05-11 17:25:54 +0300408 if (hw_read(ci, OP_USBMODE, USBMODE_CM) != mode) {
409 pr_err("cannot enter in %s mode", ci_role(ci)->name);
Alexander Shishkine443b332012-05-11 17:25:46 +0300410 pr_err("lpm = %i", ci->hw_bank.lpm);
411 return -ENODEV;
412 }
413
414 return 0;
415}
416
Peter Chen22fa8442013-08-14 12:44:12 +0300417/**
418 * hw_wait_reg: wait the register value
419 *
420 * Sometimes, it needs to wait register value before going on.
421 * Eg, when switch to device mode, the vbus value should be lower
422 * than OTGSC_BSV before connects to host.
423 *
424 * @ci: the controller
425 * @reg: register index
426 * @mask: mast bit
427 * @value: the bit value to wait
428 * @timeout_ms: timeout in millisecond
429 *
430 * This function returns an error code if timeout
431 */
432int hw_wait_reg(struct ci_hdrc *ci, enum ci_hw_regs reg, u32 mask,
433 u32 value, unsigned int timeout_ms)
434{
435 unsigned long elapse = jiffies + msecs_to_jiffies(timeout_ms);
436
437 while (hw_read(ci, reg, mask) != value) {
438 if (time_after(jiffies, elapse)) {
439 dev_err(ci->dev, "timeout waiting for %08x in %d\n",
440 mask, reg);
441 return -ETIMEDOUT;
442 }
443 msleep(20);
444 }
445
446 return 0;
447}
448
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300449static irqreturn_t ci_irq(int irq, void *data)
450{
Alexander Shishkin8e229782013-06-24 14:46:36 +0300451 struct ci_hdrc *ci = data;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300452 irqreturn_t ret = IRQ_NONE;
Richard Zhaob183c192012-09-12 14:58:11 +0300453 u32 otgsc = 0;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300454
Li Jun4dcf7202014-04-23 15:56:50 +0800455 if (ci->is_otg) {
Li Jun0c33bf72014-04-23 15:56:38 +0800456 otgsc = hw_read_otgsc(ci, ~0);
Li Jun4dcf7202014-04-23 15:56:50 +0800457 if (ci_otg_is_fsm_mode(ci)) {
458 ret = ci_otg_fsm_irq(ci);
459 if (ret == IRQ_HANDLED)
460 return ret;
461 }
462 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300463
Peter Chena107f8c2013-08-14 12:44:11 +0300464 /*
465 * Handle id change interrupt, it indicates device/host function
466 * switch.
467 */
468 if (ci->is_otg && (otgsc & OTGSC_IDIE) && (otgsc & OTGSC_IDIS)) {
469 ci->id_event = true;
Li Jun0c33bf72014-04-23 15:56:38 +0800470 /* Clear ID change irq status */
471 hw_write_otgsc(ci, OTGSC_IDIS, OTGSC_IDIS);
Peter Chenbe6b0c12014-05-23 08:12:49 +0800472 ci_otg_queue_work(ci);
Peter Chena107f8c2013-08-14 12:44:11 +0300473 return IRQ_HANDLED;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300474 }
475
Peter Chena107f8c2013-08-14 12:44:11 +0300476 /*
477 * Handle vbus change interrupt, it indicates device connection
478 * and disconnection events.
479 */
480 if (ci->is_otg && (otgsc & OTGSC_BSVIE) && (otgsc & OTGSC_BSVIS)) {
481 ci->b_sess_valid_event = true;
Li Jun0c33bf72014-04-23 15:56:38 +0800482 /* Clear BSV irq */
483 hw_write_otgsc(ci, OTGSC_BSVIS, OTGSC_BSVIS);
Peter Chenbe6b0c12014-05-23 08:12:49 +0800484 ci_otg_queue_work(ci);
Peter Chena107f8c2013-08-14 12:44:11 +0300485 return IRQ_HANDLED;
486 }
487
488 /* Handle device/host interrupt */
489 if (ci->role != CI_ROLE_END)
490 ret = ci_role(ci)->irq(ci);
491
Richard Zhaob183c192012-09-12 14:58:11 +0300492 return ret;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300493}
494
Peter Chen1542d9c2013-08-14 12:44:03 +0300495static int ci_get_platdata(struct device *dev,
496 struct ci_hdrc_platform_data *platdata)
497{
Peter Chenc22600c2013-09-17 12:37:22 +0800498 if (!platdata->phy_mode)
499 platdata->phy_mode = of_usb_get_phy_mode(dev->of_node);
500
501 if (!platdata->dr_mode)
502 platdata->dr_mode = of_usb_get_dr_mode(dev->of_node);
503
504 if (platdata->dr_mode == USB_DR_MODE_UNKNOWN)
505 platdata->dr_mode = USB_DR_MODE_OTG;
506
Peter Chenc2ec3a72013-10-30 09:19:29 +0800507 if (platdata->dr_mode != USB_DR_MODE_PERIPHERAL) {
508 /* Get the vbus regulator */
509 platdata->reg_vbus = devm_regulator_get(dev, "vbus");
510 if (PTR_ERR(platdata->reg_vbus) == -EPROBE_DEFER) {
511 return -EPROBE_DEFER;
512 } else if (PTR_ERR(platdata->reg_vbus) == -ENODEV) {
513 /* no vbus regualator is needed */
514 platdata->reg_vbus = NULL;
515 } else if (IS_ERR(platdata->reg_vbus)) {
516 dev_err(dev, "Getting regulator error: %ld\n",
517 PTR_ERR(platdata->reg_vbus));
518 return PTR_ERR(platdata->reg_vbus);
519 }
Peter Chenf6a9ff02014-08-19 09:51:56 +0800520 /* Get TPL support */
521 if (!platdata->tpl_support)
522 platdata->tpl_support =
523 of_usb_host_tpl_support(dev->of_node);
Peter Chenc2ec3a72013-10-30 09:19:29 +0800524 }
525
Michael Grzeschik4f6743d2014-02-19 13:41:43 +0800526 if (of_usb_get_maximum_speed(dev->of_node) == USB_SPEED_FULL)
527 platdata->flags |= CI_HDRC_FORCE_FULLSPEED;
528
Peter Chen1542d9c2013-08-14 12:44:03 +0300529 return 0;
530}
531
Richard Zhaofe6e1252012-07-07 22:56:42 +0800532static DEFINE_IDA(ci_ida);
533
Alexander Shishkin8e229782013-06-24 14:46:36 +0300534struct platform_device *ci_hdrc_add_device(struct device *dev,
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800535 struct resource *res, int nres,
Alexander Shishkin8e229782013-06-24 14:46:36 +0300536 struct ci_hdrc_platform_data *platdata)
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800537{
538 struct platform_device *pdev;
Richard Zhaofe6e1252012-07-07 22:56:42 +0800539 int id, ret;
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800540
Peter Chen1542d9c2013-08-14 12:44:03 +0300541 ret = ci_get_platdata(dev, platdata);
542 if (ret)
543 return ERR_PTR(ret);
544
Richard Zhaofe6e1252012-07-07 22:56:42 +0800545 id = ida_simple_get(&ci_ida, 0, 0, GFP_KERNEL);
546 if (id < 0)
547 return ERR_PTR(id);
548
549 pdev = platform_device_alloc("ci_hdrc", id);
550 if (!pdev) {
551 ret = -ENOMEM;
552 goto put_id;
553 }
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800554
555 pdev->dev.parent = dev;
556 pdev->dev.dma_mask = dev->dma_mask;
557 pdev->dev.dma_parms = dev->dma_parms;
558 dma_set_coherent_mask(&pdev->dev, dev->coherent_dma_mask);
559
560 ret = platform_device_add_resources(pdev, res, nres);
561 if (ret)
562 goto err;
563
564 ret = platform_device_add_data(pdev, platdata, sizeof(*platdata));
565 if (ret)
566 goto err;
567
568 ret = platform_device_add(pdev);
569 if (ret)
570 goto err;
571
572 return pdev;
573
574err:
575 platform_device_put(pdev);
Richard Zhaofe6e1252012-07-07 22:56:42 +0800576put_id:
577 ida_simple_remove(&ci_ida, id);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800578 return ERR_PTR(ret);
579}
Alexander Shishkin8e229782013-06-24 14:46:36 +0300580EXPORT_SYMBOL_GPL(ci_hdrc_add_device);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800581
Alexander Shishkin8e229782013-06-24 14:46:36 +0300582void ci_hdrc_remove_device(struct platform_device *pdev)
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800583{
Lothar Waßmann98c35532012-11-22 10:11:25 +0100584 int id = pdev->id;
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800585 platform_device_unregister(pdev);
Lothar Waßmann98c35532012-11-22 10:11:25 +0100586 ida_simple_remove(&ci_ida, id);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800587}
Alexander Shishkin8e229782013-06-24 14:46:36 +0300588EXPORT_SYMBOL_GPL(ci_hdrc_remove_device);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800589
Peter Chen3f124d22013-08-14 12:44:07 +0300590static inline void ci_role_destroy(struct ci_hdrc *ci)
591{
592 ci_hdrc_gadget_destroy(ci);
593 ci_hdrc_host_destroy(ci);
Peter Chencbec6bd2013-08-14 12:44:10 +0300594 if (ci->is_otg)
595 ci_hdrc_otg_destroy(ci);
Peter Chen3f124d22013-08-14 12:44:07 +0300596}
597
Peter Chen577b2322013-08-14 12:44:08 +0300598static void ci_get_otg_capable(struct ci_hdrc *ci)
599{
600 if (ci->platdata->flags & CI_HDRC_DUAL_ROLE_NOT_OTG)
601 ci->is_otg = false;
602 else
603 ci->is_otg = (hw_read(ci, CAP_DCCPARAMS,
604 DCCPARAMS_DC | DCCPARAMS_HC)
605 == (DCCPARAMS_DC | DCCPARAMS_HC));
Peter Chen90893b92014-04-23 15:56:41 +0800606 if (ci->is_otg)
Peter Chen577b2322013-08-14 12:44:08 +0300607 dev_dbg(ci->dev, "It is OTG capable controller\n");
608}
609
Bill Pemberton41ac7b32012-11-19 13:21:48 -0500610static int ci_hdrc_probe(struct platform_device *pdev)
Alexander Shishkine443b332012-05-11 17:25:46 +0300611{
612 struct device *dev = &pdev->dev;
Alexander Shishkin8e229782013-06-24 14:46:36 +0300613 struct ci_hdrc *ci;
Alexander Shishkine443b332012-05-11 17:25:46 +0300614 struct resource *res;
615 void __iomem *base;
616 int ret;
Sascha Hauer691962d2013-06-13 17:59:57 +0300617 enum usb_dr_mode dr_mode;
Alexander Shishkine443b332012-05-11 17:25:46 +0300618
Jingoo Hanfad56742014-02-19 13:41:42 +0800619 if (!dev_get_platdata(dev)) {
Alexander Shishkine443b332012-05-11 17:25:46 +0300620 dev_err(dev, "platform data missing\n");
621 return -ENODEV;
622 }
623
624 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
Felipe Balbi19290812013-03-30 02:46:27 +0200625 base = devm_ioremap_resource(dev, res);
626 if (IS_ERR(base))
627 return PTR_ERR(base);
Alexander Shishkine443b332012-05-11 17:25:46 +0300628
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300629 ci = devm_kzalloc(dev, sizeof(*ci), GFP_KERNEL);
Fabio Estevamd0f99242014-11-26 13:44:23 +0800630 if (!ci)
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300631 return -ENOMEM;
Alexander Shishkine443b332012-05-11 17:25:46 +0300632
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300633 ci->dev = dev;
Jingoo Hanfad56742014-02-19 13:41:42 +0800634 ci->platdata = dev_get_platdata(dev);
Peter Chened8f8312014-01-10 13:51:27 +0800635 ci->imx28_write_fix = !!(ci->platdata->flags &
636 CI_HDRC_IMX28_WRITE_FIX);
Alexander Shishkine443b332012-05-11 17:25:46 +0300637
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300638 ret = hw_device_init(ci, base);
639 if (ret < 0) {
640 dev_err(dev, "can't initialize hardware\n");
641 return -ENODEV;
642 }
643
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100644 if (ci->platdata->phy) {
645 ci->phy = ci->platdata->phy;
646 } else if (ci->platdata->usb_phy) {
Antoine Tenartef44cb42014-10-30 18:41:16 +0100647 ci->usb_phy = ci->platdata->usb_phy;
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100648 } else {
649 ci->phy = devm_phy_get(dev, "usb-phy");
Antoine Tenartef44cb42014-10-30 18:41:16 +0100650 ci->usb_phy = devm_usb_get_phy(dev, USB_PHY_TYPE_USB2);
Peter Chenc859aa652014-02-19 13:41:40 +0800651
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100652 /* if both generic PHY and USB PHY layers aren't enabled */
653 if (PTR_ERR(ci->phy) == -ENOSYS &&
654 PTR_ERR(ci->usb_phy) == -ENXIO)
655 return -ENXIO;
Peter Chenc859aa652014-02-19 13:41:40 +0800656
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100657 if (IS_ERR(ci->phy) && IS_ERR(ci->usb_phy))
658 return -EPROBE_DEFER;
659
660 if (IS_ERR(ci->phy))
661 ci->phy = NULL;
662 else if (IS_ERR(ci->usb_phy))
663 ci->usb_phy = NULL;
Peter Chenc859aa652014-02-19 13:41:40 +0800664 }
665
Peter Chend03cccf2014-04-23 15:56:37 +0800666 ret = ci_usb_phy_init(ci);
Peter Chen74475ed2013-09-24 12:47:53 +0800667 if (ret) {
668 dev_err(dev, "unable to init phy: %d\n", ret);
669 return ret;
Peter Chen90893b92014-04-23 15:56:41 +0800670 } else {
671 /*
672 * The delay to sync PHY's status, the maximum delay is
673 * 2ms since the otgsc uses 1ms timer to debounce the
674 * PHY's input
675 */
676 usleep_range(2000, 2500);
Peter Chen74475ed2013-09-24 12:47:53 +0800677 }
678
Alexander Shishkineb70e5a2012-05-11 17:25:54 +0300679 ci->hw_bank.phys = res->start;
680
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300681 ci->irq = platform_get_irq(pdev, 0);
682 if (ci->irq < 0) {
683 dev_err(dev, "missing IRQ\n");
Fabio Estevam42d18212014-02-19 13:41:44 +0800684 ret = ci->irq;
Peter Chenc859aa652014-02-19 13:41:40 +0800685 goto deinit_phy;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300686 }
687
Peter Chen577b2322013-08-14 12:44:08 +0300688 ci_get_otg_capable(ci);
689
Sascha Hauer691962d2013-06-13 17:59:57 +0300690 dr_mode = ci->platdata->dr_mode;
691 /* initialize role(s) before the interrupt is requested */
692 if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_HOST) {
693 ret = ci_hdrc_host_init(ci);
694 if (ret)
695 dev_info(dev, "doesn't support host\n");
696 }
697
698 if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_PERIPHERAL) {
699 ret = ci_hdrc_gadget_init(ci);
700 if (ret)
701 dev_info(dev, "doesn't support gadget\n");
702 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300703
704 if (!ci->roles[CI_ROLE_HOST] && !ci->roles[CI_ROLE_GADGET]) {
705 dev_err(dev, "no supported roles\n");
Peter Chen74475ed2013-09-24 12:47:53 +0800706 ret = -ENODEV;
Peter Chenc859aa652014-02-19 13:41:40 +0800707 goto deinit_phy;
Peter Chencbec6bd2013-08-14 12:44:10 +0300708 }
709
Peter Chen27c62c22014-09-22 08:14:16 +0800710 if (ci->is_otg && ci->roles[CI_ROLE_GADGET]) {
Peter Chen90893b92014-04-23 15:56:41 +0800711 /* Disable and clear all OTG irq */
712 hw_write_otgsc(ci, OTGSC_INT_EN_BITS | OTGSC_INT_STATUS_BITS,
713 OTGSC_INT_STATUS_BITS);
Peter Chencbec6bd2013-08-14 12:44:10 +0300714 ret = ci_hdrc_otg_init(ci);
715 if (ret) {
716 dev_err(dev, "init otg fails, ret = %d\n", ret);
717 goto stop;
718 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300719 }
720
721 if (ci->roles[CI_ROLE_HOST] && ci->roles[CI_ROLE_GADGET]) {
Peter Chen577b2322013-08-14 12:44:08 +0300722 if (ci->is_otg) {
Peter Chen577b2322013-08-14 12:44:08 +0300723 ci->role = ci_otg_role(ci);
Li Jun0c33bf72014-04-23 15:56:38 +0800724 /* Enable ID change irq */
725 hw_write_otgsc(ci, OTGSC_IDIE, OTGSC_IDIE);
Peter Chen577b2322013-08-14 12:44:08 +0300726 } else {
727 /*
728 * If the controller is not OTG capable, but support
729 * role switch, the defalt role is gadget, and the
730 * user can switch it through debugfs.
731 */
732 ci->role = CI_ROLE_GADGET;
733 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300734 } else {
735 ci->role = ci->roles[CI_ROLE_HOST]
736 ? CI_ROLE_HOST
737 : CI_ROLE_GADGET;
738 }
739
Peter Chen5a1e1452013-12-05 15:20:50 +0800740 /* only update vbus status for peripheral */
741 if (ci->role == CI_ROLE_GADGET)
742 ci_handle_vbus_change(ci);
743
Li Jun4dcf7202014-04-23 15:56:50 +0800744 if (!ci_otg_is_fsm_mode(ci)) {
745 ret = ci_role_start(ci, ci->role);
746 if (ret) {
747 dev_err(dev, "can't start %s role\n",
748 ci_role(ci)->name);
749 goto stop;
750 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300751 }
752
753 platform_set_drvdata(pdev, ci);
Peter Chen4c503dd2014-11-26 13:44:22 +0800754 ret = devm_request_irq(dev, ci->irq, ci_irq, IRQF_SHARED,
755 ci->platdata->name, ci);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300756 if (ret)
757 goto stop;
758
Li Jun4dcf7202014-04-23 15:56:50 +0800759 if (ci_otg_is_fsm_mode(ci))
760 ci_hdrc_otg_fsm_start(ci);
761
Alexander Shishkinadf0f732013-03-30 12:53:53 +0200762 ret = dbg_create_files(ci);
763 if (!ret)
764 return 0;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300765
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300766stop:
Peter Chen3f124d22013-08-14 12:44:07 +0300767 ci_role_destroy(ci);
Peter Chenc859aa652014-02-19 13:41:40 +0800768deinit_phy:
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100769 ci_usb_phy_exit(ci);
Alexander Shishkine443b332012-05-11 17:25:46 +0300770
771 return ret;
772}
773
Bill Pembertonfb4e98a2012-11-19 13:26:20 -0500774static int ci_hdrc_remove(struct platform_device *pdev)
Alexander Shishkine443b332012-05-11 17:25:46 +0300775{
Alexander Shishkin8e229782013-06-24 14:46:36 +0300776 struct ci_hdrc *ci = platform_get_drvdata(pdev);
Alexander Shishkine443b332012-05-11 17:25:46 +0300777
Alexander Shishkinadf0f732013-03-30 12:53:53 +0200778 dbg_remove_files(ci);
Peter Chen3f124d22013-08-14 12:44:07 +0300779 ci_role_destroy(ci);
Peter Chen864cf942013-09-24 12:47:55 +0800780 ci_hdrc_enter_lpm(ci, true);
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100781 ci_usb_phy_exit(ci);
Alexander Shishkine443b332012-05-11 17:25:46 +0300782
783 return 0;
784}
785
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300786static struct platform_driver ci_hdrc_driver = {
787 .probe = ci_hdrc_probe,
Bill Pemberton76904172012-11-19 13:21:08 -0500788 .remove = ci_hdrc_remove,
Alexander Shishkine443b332012-05-11 17:25:46 +0300789 .driver = {
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300790 .name = "ci_hdrc",
Alexander Shiyan7cf2f862014-04-23 15:56:42 +0800791 .owner = THIS_MODULE,
Alexander Shishkine443b332012-05-11 17:25:46 +0300792 },
793};
794
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300795module_platform_driver(ci_hdrc_driver);
Alexander Shishkine443b332012-05-11 17:25:46 +0300796
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300797MODULE_ALIAS("platform:ci_hdrc");
Alexander Shishkine443b332012-05-11 17:25:46 +0300798MODULE_LICENSE("GPL v2");
799MODULE_AUTHOR("David Lopo <dlopo@chipidea.mips.com>");
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300800MODULE_DESCRIPTION("ChipIdea HDRC Driver");