blob: 5de1507b798cde4ac0e8f5f4ac425899ff5b5306 [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
199 if (enable && !lpm) {
200 hw_write(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm),
201 PORTSC_PHCD(ci->hw_bank.lpm));
202 } else if (!enable && lpm) {
203 hw_write(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm),
204 0);
205 /*
Peter Chen90893b92014-04-23 15:56:41 +0800206 * the PHY needs some time (less
Peter Chen864cf942013-09-24 12:47:55 +0800207 * than 1ms) to leave low power mode.
208 */
Peter Chen90893b92014-04-23 15:56:41 +0800209 usleep_range(1000, 1100);
Peter Chen864cf942013-09-24 12:47:55 +0800210 }
211}
212
Alexander Shishkin8e229782013-06-24 14:46:36 +0300213static int hw_device_init(struct ci_hdrc *ci, void __iomem *base)
Alexander Shishkine443b332012-05-11 17:25:46 +0300214{
215 u32 reg;
216
217 /* bank is a module variable */
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300218 ci->hw_bank.abs = base;
Alexander Shishkine443b332012-05-11 17:25:46 +0300219
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300220 ci->hw_bank.cap = ci->hw_bank.abs;
Richard Zhao77c44002012-06-29 17:48:53 +0800221 ci->hw_bank.cap += ci->platdata->capoffset;
Svetoslav Neykov938d3232013-03-30 12:54:03 +0200222 ci->hw_bank.op = ci->hw_bank.cap + (ioread32(ci->hw_bank.cap) & 0xff);
Alexander Shishkine443b332012-05-11 17:25:46 +0300223
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300224 hw_alloc_regmap(ci, false);
225 reg = hw_read(ci, CAP_HCCPARAMS, HCCPARAMS_LEN) >>
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200226 __ffs(HCCPARAMS_LEN);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300227 ci->hw_bank.lpm = reg;
Chris Ruehlaeb2c122013-12-06 16:35:12 +0800228 if (reg)
229 hw_alloc_regmap(ci, !!reg);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300230 ci->hw_bank.size = ci->hw_bank.op - ci->hw_bank.abs;
231 ci->hw_bank.size += OP_LAST;
232 ci->hw_bank.size /= sizeof(u32);
Alexander Shishkine443b332012-05-11 17:25:46 +0300233
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300234 reg = hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DEN) >>
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200235 __ffs(DCCPARAMS_DEN);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300236 ci->hw_ep_max = reg * 2; /* cache hw ENDPT_MAX */
Alexander Shishkine443b332012-05-11 17:25:46 +0300237
Richard Zhao09c94e62012-05-15 21:58:18 +0800238 if (ci->hw_ep_max > ENDPT_MAX)
Alexander Shishkine443b332012-05-11 17:25:46 +0300239 return -ENODEV;
240
Peter Chen864cf942013-09-24 12:47:55 +0800241 ci_hdrc_enter_lpm(ci, false);
242
Peter Chenc344b512013-08-14 12:44:09 +0300243 /* Disable all interrupts bits */
244 hw_write(ci, OP_USBINTR, 0xffffffff, 0);
245
246 /* Clear all interrupts status bits*/
247 hw_write(ci, OP_USBSTS, 0xffffffff, 0xffffffff);
248
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300249 dev_dbg(ci->dev, "ChipIdea HDRC found, lpm: %d; cap: %p op: %p\n",
250 ci->hw_bank.lpm, ci->hw_bank.cap, ci->hw_bank.op);
Alexander Shishkine443b332012-05-11 17:25:46 +0300251
252 /* setup lock mode ? */
253
254 /* ENDPTSETUPSTAT is '0' by default */
255
256 /* HCSPARAMS.bf.ppc SHOULD BE zero for device */
257
258 return 0;
259}
260
Alexander Shishkin8e229782013-06-24 14:46:36 +0300261static void hw_phymode_configure(struct ci_hdrc *ci)
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300262{
Chris Ruehl3b5d3e62014-01-10 13:51:29 +0800263 u32 portsc, lpm, sts = 0;
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300264
265 switch (ci->platdata->phy_mode) {
266 case USBPHY_INTERFACE_MODE_UTMI:
267 portsc = PORTSC_PTS(PTS_UTMI);
268 lpm = DEVLC_PTS(PTS_UTMI);
269 break;
270 case USBPHY_INTERFACE_MODE_UTMIW:
271 portsc = PORTSC_PTS(PTS_UTMI) | PORTSC_PTW;
272 lpm = DEVLC_PTS(PTS_UTMI) | DEVLC_PTW;
273 break;
274 case USBPHY_INTERFACE_MODE_ULPI:
275 portsc = PORTSC_PTS(PTS_ULPI);
276 lpm = DEVLC_PTS(PTS_ULPI);
277 break;
278 case USBPHY_INTERFACE_MODE_SERIAL:
279 portsc = PORTSC_PTS(PTS_SERIAL);
280 lpm = DEVLC_PTS(PTS_SERIAL);
281 sts = 1;
282 break;
283 case USBPHY_INTERFACE_MODE_HSIC:
284 portsc = PORTSC_PTS(PTS_HSIC);
285 lpm = DEVLC_PTS(PTS_HSIC);
286 break;
287 default:
288 return;
289 }
290
291 if (ci->hw_bank.lpm) {
292 hw_write(ci, OP_DEVLC, DEVLC_PTS(7) | DEVLC_PTW, lpm);
Chris Ruehl3b5d3e62014-01-10 13:51:29 +0800293 if (sts)
294 hw_write(ci, OP_DEVLC, DEVLC_STS, DEVLC_STS);
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300295 } else {
296 hw_write(ci, OP_PORTSC, PORTSC_PTS(7) | PORTSC_PTW, portsc);
Chris Ruehl3b5d3e62014-01-10 13:51:29 +0800297 if (sts)
298 hw_write(ci, OP_PORTSC, PORTSC_STS, PORTSC_STS);
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300299 }
300}
301
Alexander Shishkine443b332012-05-11 17:25:46 +0300302/**
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100303 * _ci_usb_phy_init: initialize phy taking in account both phy and usb_phy
304 * interfaces
305 * @ci: the controller
306 *
307 * This function returns an error code if the phy failed to init
308 */
309static int _ci_usb_phy_init(struct ci_hdrc *ci)
310{
311 int ret;
312
313 if (ci->phy) {
314 ret = phy_init(ci->phy);
315 if (ret)
316 return ret;
317
318 ret = phy_power_on(ci->phy);
319 if (ret) {
320 phy_exit(ci->phy);
321 return ret;
322 }
323 } else {
324 ret = usb_phy_init(ci->usb_phy);
325 }
326
327 return ret;
328}
329
330/**
331 * _ci_usb_phy_exit: deinitialize phy taking in account both phy and usb_phy
332 * interfaces
333 * @ci: the controller
334 */
335static void ci_usb_phy_exit(struct ci_hdrc *ci)
336{
337 if (ci->phy) {
338 phy_power_off(ci->phy);
339 phy_exit(ci->phy);
340 } else {
341 usb_phy_shutdown(ci->usb_phy);
342 }
343}
344
345/**
Peter Chend03cccf2014-04-23 15:56:37 +0800346 * ci_usb_phy_init: initialize phy according to different phy type
347 * @ci: the controller
Peter Chen19353882014-09-22 08:14:17 +0800348 *
Peter Chend03cccf2014-04-23 15:56:37 +0800349 * This function returns an error code if usb_phy_init has failed
350 */
351static int ci_usb_phy_init(struct ci_hdrc *ci)
352{
353 int ret;
354
355 switch (ci->platdata->phy_mode) {
356 case USBPHY_INTERFACE_MODE_UTMI:
357 case USBPHY_INTERFACE_MODE_UTMIW:
358 case USBPHY_INTERFACE_MODE_HSIC:
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100359 ret = _ci_usb_phy_init(ci);
Peter Chend03cccf2014-04-23 15:56:37 +0800360 if (ret)
361 return ret;
362 hw_phymode_configure(ci);
363 break;
364 case USBPHY_INTERFACE_MODE_ULPI:
365 case USBPHY_INTERFACE_MODE_SERIAL:
366 hw_phymode_configure(ci);
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100367 ret = _ci_usb_phy_init(ci);
Peter Chend03cccf2014-04-23 15:56:37 +0800368 if (ret)
369 return ret;
370 break;
371 default:
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100372 ret = _ci_usb_phy_init(ci);
Peter Chend03cccf2014-04-23 15:56:37 +0800373 }
374
375 return ret;
376}
377
378/**
Alexander Shishkine443b332012-05-11 17:25:46 +0300379 * hw_device_reset: resets chip (execute without interruption)
380 * @ci: the controller
381 *
382 * This function returns an error code
383 */
Alexander Shishkin8e229782013-06-24 14:46:36 +0300384int hw_device_reset(struct ci_hdrc *ci, u32 mode)
Alexander Shishkine443b332012-05-11 17:25:46 +0300385{
386 /* should flush & stop before reset */
387 hw_write(ci, OP_ENDPTFLUSH, ~0, ~0);
388 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
389
390 hw_write(ci, OP_USBCMD, USBCMD_RST, USBCMD_RST);
391 while (hw_read(ci, OP_USBCMD, USBCMD_RST))
392 udelay(10); /* not RTOS friendly */
393
Richard Zhao77c44002012-06-29 17:48:53 +0800394 if (ci->platdata->notify_event)
395 ci->platdata->notify_event(ci,
Alexander Shishkin8e229782013-06-24 14:46:36 +0300396 CI_HDRC_CONTROLLER_RESET_EVENT);
Alexander Shishkine443b332012-05-11 17:25:46 +0300397
Alexander Shishkin8e229782013-06-24 14:46:36 +0300398 if (ci->platdata->flags & CI_HDRC_DISABLE_STREAMING)
Alexander Shishkin758fc982012-05-11 17:25:53 +0300399 hw_write(ci, OP_USBMODE, USBMODE_CI_SDIS, USBMODE_CI_SDIS);
Alexander Shishkine443b332012-05-11 17:25:46 +0300400
Michael Grzeschik4f6743d2014-02-19 13:41:43 +0800401 if (ci->platdata->flags & CI_HDRC_FORCE_FULLSPEED) {
402 if (ci->hw_bank.lpm)
403 hw_write(ci, OP_DEVLC, DEVLC_PFSC, DEVLC_PFSC);
404 else
405 hw_write(ci, OP_PORTSC, PORTSC_PFSC, PORTSC_PFSC);
406 }
407
Alexander Shishkine443b332012-05-11 17:25:46 +0300408 /* USBMODE should be configured step by step */
409 hw_write(ci, OP_USBMODE, USBMODE_CM, USBMODE_CM_IDLE);
Alexander Shishkineb70e5a2012-05-11 17:25:54 +0300410 hw_write(ci, OP_USBMODE, USBMODE_CM, mode);
Alexander Shishkine443b332012-05-11 17:25:46 +0300411 /* HW >= 2.3 */
412 hw_write(ci, OP_USBMODE, USBMODE_SLOM, USBMODE_SLOM);
413
Alexander Shishkineb70e5a2012-05-11 17:25:54 +0300414 if (hw_read(ci, OP_USBMODE, USBMODE_CM) != mode) {
415 pr_err("cannot enter in %s mode", ci_role(ci)->name);
Alexander Shishkine443b332012-05-11 17:25:46 +0300416 pr_err("lpm = %i", ci->hw_bank.lpm);
417 return -ENODEV;
418 }
419
420 return 0;
421}
422
Peter Chen22fa8442013-08-14 12:44:12 +0300423/**
424 * hw_wait_reg: wait the register value
425 *
426 * Sometimes, it needs to wait register value before going on.
427 * Eg, when switch to device mode, the vbus value should be lower
428 * than OTGSC_BSV before connects to host.
429 *
430 * @ci: the controller
431 * @reg: register index
432 * @mask: mast bit
433 * @value: the bit value to wait
434 * @timeout_ms: timeout in millisecond
435 *
436 * This function returns an error code if timeout
437 */
438int hw_wait_reg(struct ci_hdrc *ci, enum ci_hw_regs reg, u32 mask,
439 u32 value, unsigned int timeout_ms)
440{
441 unsigned long elapse = jiffies + msecs_to_jiffies(timeout_ms);
442
443 while (hw_read(ci, reg, mask) != value) {
444 if (time_after(jiffies, elapse)) {
445 dev_err(ci->dev, "timeout waiting for %08x in %d\n",
446 mask, reg);
447 return -ETIMEDOUT;
448 }
449 msleep(20);
450 }
451
452 return 0;
453}
454
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300455static irqreturn_t ci_irq(int irq, void *data)
456{
Alexander Shishkin8e229782013-06-24 14:46:36 +0300457 struct ci_hdrc *ci = data;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300458 irqreturn_t ret = IRQ_NONE;
Richard Zhaob183c192012-09-12 14:58:11 +0300459 u32 otgsc = 0;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300460
Li Jun4dcf7202014-04-23 15:56:50 +0800461 if (ci->is_otg) {
Li Jun0c33bf72014-04-23 15:56:38 +0800462 otgsc = hw_read_otgsc(ci, ~0);
Li Jun4dcf7202014-04-23 15:56:50 +0800463 if (ci_otg_is_fsm_mode(ci)) {
464 ret = ci_otg_fsm_irq(ci);
465 if (ret == IRQ_HANDLED)
466 return ret;
467 }
468 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300469
Peter Chena107f8c2013-08-14 12:44:11 +0300470 /*
471 * Handle id change interrupt, it indicates device/host function
472 * switch.
473 */
474 if (ci->is_otg && (otgsc & OTGSC_IDIE) && (otgsc & OTGSC_IDIS)) {
475 ci->id_event = true;
Li Jun0c33bf72014-04-23 15:56:38 +0800476 /* Clear ID change irq status */
477 hw_write_otgsc(ci, OTGSC_IDIS, OTGSC_IDIS);
Peter Chenbe6b0c12014-05-23 08:12:49 +0800478 ci_otg_queue_work(ci);
Peter Chena107f8c2013-08-14 12:44:11 +0300479 return IRQ_HANDLED;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300480 }
481
Peter Chena107f8c2013-08-14 12:44:11 +0300482 /*
483 * Handle vbus change interrupt, it indicates device connection
484 * and disconnection events.
485 */
486 if (ci->is_otg && (otgsc & OTGSC_BSVIE) && (otgsc & OTGSC_BSVIS)) {
487 ci->b_sess_valid_event = true;
Li Jun0c33bf72014-04-23 15:56:38 +0800488 /* Clear BSV irq */
489 hw_write_otgsc(ci, OTGSC_BSVIS, OTGSC_BSVIS);
Peter Chenbe6b0c12014-05-23 08:12:49 +0800490 ci_otg_queue_work(ci);
Peter Chena107f8c2013-08-14 12:44:11 +0300491 return IRQ_HANDLED;
492 }
493
494 /* Handle device/host interrupt */
495 if (ci->role != CI_ROLE_END)
496 ret = ci_role(ci)->irq(ci);
497
Richard Zhaob183c192012-09-12 14:58:11 +0300498 return ret;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300499}
500
Peter Chen1542d9c2013-08-14 12:44:03 +0300501static int ci_get_platdata(struct device *dev,
502 struct ci_hdrc_platform_data *platdata)
503{
Peter Chenc22600c2013-09-17 12:37:22 +0800504 if (!platdata->phy_mode)
505 platdata->phy_mode = of_usb_get_phy_mode(dev->of_node);
506
507 if (!platdata->dr_mode)
508 platdata->dr_mode = of_usb_get_dr_mode(dev->of_node);
509
510 if (platdata->dr_mode == USB_DR_MODE_UNKNOWN)
511 platdata->dr_mode = USB_DR_MODE_OTG;
512
Peter Chenc2ec3a72013-10-30 09:19:29 +0800513 if (platdata->dr_mode != USB_DR_MODE_PERIPHERAL) {
514 /* Get the vbus regulator */
515 platdata->reg_vbus = devm_regulator_get(dev, "vbus");
516 if (PTR_ERR(platdata->reg_vbus) == -EPROBE_DEFER) {
517 return -EPROBE_DEFER;
518 } else if (PTR_ERR(platdata->reg_vbus) == -ENODEV) {
519 /* no vbus regualator is needed */
520 platdata->reg_vbus = NULL;
521 } else if (IS_ERR(platdata->reg_vbus)) {
522 dev_err(dev, "Getting regulator error: %ld\n",
523 PTR_ERR(platdata->reg_vbus));
524 return PTR_ERR(platdata->reg_vbus);
525 }
Peter Chenf6a9ff02014-08-19 09:51:56 +0800526 /* Get TPL support */
527 if (!platdata->tpl_support)
528 platdata->tpl_support =
529 of_usb_host_tpl_support(dev->of_node);
Peter Chenc2ec3a72013-10-30 09:19:29 +0800530 }
531
Michael Grzeschik4f6743d2014-02-19 13:41:43 +0800532 if (of_usb_get_maximum_speed(dev->of_node) == USB_SPEED_FULL)
533 platdata->flags |= CI_HDRC_FORCE_FULLSPEED;
534
Peter Chen1542d9c2013-08-14 12:44:03 +0300535 return 0;
536}
537
Richard Zhaofe6e1252012-07-07 22:56:42 +0800538static DEFINE_IDA(ci_ida);
539
Alexander Shishkin8e229782013-06-24 14:46:36 +0300540struct platform_device *ci_hdrc_add_device(struct device *dev,
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800541 struct resource *res, int nres,
Alexander Shishkin8e229782013-06-24 14:46:36 +0300542 struct ci_hdrc_platform_data *platdata)
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800543{
544 struct platform_device *pdev;
Richard Zhaofe6e1252012-07-07 22:56:42 +0800545 int id, ret;
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800546
Peter Chen1542d9c2013-08-14 12:44:03 +0300547 ret = ci_get_platdata(dev, platdata);
548 if (ret)
549 return ERR_PTR(ret);
550
Richard Zhaofe6e1252012-07-07 22:56:42 +0800551 id = ida_simple_get(&ci_ida, 0, 0, GFP_KERNEL);
552 if (id < 0)
553 return ERR_PTR(id);
554
555 pdev = platform_device_alloc("ci_hdrc", id);
556 if (!pdev) {
557 ret = -ENOMEM;
558 goto put_id;
559 }
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800560
561 pdev->dev.parent = dev;
562 pdev->dev.dma_mask = dev->dma_mask;
563 pdev->dev.dma_parms = dev->dma_parms;
564 dma_set_coherent_mask(&pdev->dev, dev->coherent_dma_mask);
565
566 ret = platform_device_add_resources(pdev, res, nres);
567 if (ret)
568 goto err;
569
570 ret = platform_device_add_data(pdev, platdata, sizeof(*platdata));
571 if (ret)
572 goto err;
573
574 ret = platform_device_add(pdev);
575 if (ret)
576 goto err;
577
578 return pdev;
579
580err:
581 platform_device_put(pdev);
Richard Zhaofe6e1252012-07-07 22:56:42 +0800582put_id:
583 ida_simple_remove(&ci_ida, id);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800584 return ERR_PTR(ret);
585}
Alexander Shishkin8e229782013-06-24 14:46:36 +0300586EXPORT_SYMBOL_GPL(ci_hdrc_add_device);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800587
Alexander Shishkin8e229782013-06-24 14:46:36 +0300588void ci_hdrc_remove_device(struct platform_device *pdev)
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800589{
Lothar Waßmann98c35532012-11-22 10:11:25 +0100590 int id = pdev->id;
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800591 platform_device_unregister(pdev);
Lothar Waßmann98c35532012-11-22 10:11:25 +0100592 ida_simple_remove(&ci_ida, id);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800593}
Alexander Shishkin8e229782013-06-24 14:46:36 +0300594EXPORT_SYMBOL_GPL(ci_hdrc_remove_device);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800595
Peter Chen3f124d22013-08-14 12:44:07 +0300596static inline void ci_role_destroy(struct ci_hdrc *ci)
597{
598 ci_hdrc_gadget_destroy(ci);
599 ci_hdrc_host_destroy(ci);
Peter Chencbec6bd2013-08-14 12:44:10 +0300600 if (ci->is_otg)
601 ci_hdrc_otg_destroy(ci);
Peter Chen3f124d22013-08-14 12:44:07 +0300602}
603
Peter Chen577b2322013-08-14 12:44:08 +0300604static void ci_get_otg_capable(struct ci_hdrc *ci)
605{
606 if (ci->platdata->flags & CI_HDRC_DUAL_ROLE_NOT_OTG)
607 ci->is_otg = false;
608 else
609 ci->is_otg = (hw_read(ci, CAP_DCCPARAMS,
610 DCCPARAMS_DC | DCCPARAMS_HC)
611 == (DCCPARAMS_DC | DCCPARAMS_HC));
Peter Chen90893b92014-04-23 15:56:41 +0800612 if (ci->is_otg)
Peter Chen577b2322013-08-14 12:44:08 +0300613 dev_dbg(ci->dev, "It is OTG capable controller\n");
614}
615
Bill Pemberton41ac7b32012-11-19 13:21:48 -0500616static int ci_hdrc_probe(struct platform_device *pdev)
Alexander Shishkine443b332012-05-11 17:25:46 +0300617{
618 struct device *dev = &pdev->dev;
Alexander Shishkin8e229782013-06-24 14:46:36 +0300619 struct ci_hdrc *ci;
Alexander Shishkine443b332012-05-11 17:25:46 +0300620 struct resource *res;
621 void __iomem *base;
622 int ret;
Sascha Hauer691962d2013-06-13 17:59:57 +0300623 enum usb_dr_mode dr_mode;
Alexander Shishkine443b332012-05-11 17:25:46 +0300624
Jingoo Hanfad56742014-02-19 13:41:42 +0800625 if (!dev_get_platdata(dev)) {
Alexander Shishkine443b332012-05-11 17:25:46 +0300626 dev_err(dev, "platform data missing\n");
627 return -ENODEV;
628 }
629
630 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
Felipe Balbi19290812013-03-30 02:46:27 +0200631 base = devm_ioremap_resource(dev, res);
632 if (IS_ERR(base))
633 return PTR_ERR(base);
Alexander Shishkine443b332012-05-11 17:25:46 +0300634
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300635 ci = devm_kzalloc(dev, sizeof(*ci), GFP_KERNEL);
636 if (!ci) {
637 dev_err(dev, "can't allocate device\n");
638 return -ENOMEM;
Alexander Shishkine443b332012-05-11 17:25:46 +0300639 }
640
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300641 ci->dev = dev;
Jingoo Hanfad56742014-02-19 13:41:42 +0800642 ci->platdata = dev_get_platdata(dev);
Peter Chened8f8312014-01-10 13:51:27 +0800643 ci->imx28_write_fix = !!(ci->platdata->flags &
644 CI_HDRC_IMX28_WRITE_FIX);
Alexander Shishkine443b332012-05-11 17:25:46 +0300645
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300646 ret = hw_device_init(ci, base);
647 if (ret < 0) {
648 dev_err(dev, "can't initialize hardware\n");
649 return -ENODEV;
650 }
651
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100652 if (ci->platdata->phy) {
653 ci->phy = ci->platdata->phy;
654 } else if (ci->platdata->usb_phy) {
Antoine Tenartef44cb42014-10-30 18:41:16 +0100655 ci->usb_phy = ci->platdata->usb_phy;
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100656 } else {
657 ci->phy = devm_phy_get(dev, "usb-phy");
Antoine Tenartef44cb42014-10-30 18:41:16 +0100658 ci->usb_phy = devm_usb_get_phy(dev, USB_PHY_TYPE_USB2);
Peter Chenc859aa652014-02-19 13:41:40 +0800659
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100660 /* if both generic PHY and USB PHY layers aren't enabled */
661 if (PTR_ERR(ci->phy) == -ENOSYS &&
662 PTR_ERR(ci->usb_phy) == -ENXIO)
663 return -ENXIO;
Peter Chenc859aa652014-02-19 13:41:40 +0800664
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100665 if (IS_ERR(ci->phy) && IS_ERR(ci->usb_phy))
666 return -EPROBE_DEFER;
667
668 if (IS_ERR(ci->phy))
669 ci->phy = NULL;
670 else if (IS_ERR(ci->usb_phy))
671 ci->usb_phy = NULL;
Peter Chenc859aa652014-02-19 13:41:40 +0800672 }
673
Peter Chend03cccf2014-04-23 15:56:37 +0800674 ret = ci_usb_phy_init(ci);
Peter Chen74475ed2013-09-24 12:47:53 +0800675 if (ret) {
676 dev_err(dev, "unable to init phy: %d\n", ret);
677 return ret;
Peter Chen90893b92014-04-23 15:56:41 +0800678 } else {
679 /*
680 * The delay to sync PHY's status, the maximum delay is
681 * 2ms since the otgsc uses 1ms timer to debounce the
682 * PHY's input
683 */
684 usleep_range(2000, 2500);
Peter Chen74475ed2013-09-24 12:47:53 +0800685 }
686
Alexander Shishkineb70e5a2012-05-11 17:25:54 +0300687 ci->hw_bank.phys = res->start;
688
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300689 ci->irq = platform_get_irq(pdev, 0);
690 if (ci->irq < 0) {
691 dev_err(dev, "missing IRQ\n");
Fabio Estevam42d18212014-02-19 13:41:44 +0800692 ret = ci->irq;
Peter Chenc859aa652014-02-19 13:41:40 +0800693 goto deinit_phy;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300694 }
695
Peter Chen577b2322013-08-14 12:44:08 +0300696 ci_get_otg_capable(ci);
697
Sascha Hauer691962d2013-06-13 17:59:57 +0300698 dr_mode = ci->platdata->dr_mode;
699 /* initialize role(s) before the interrupt is requested */
700 if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_HOST) {
701 ret = ci_hdrc_host_init(ci);
702 if (ret)
703 dev_info(dev, "doesn't support host\n");
704 }
705
706 if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_PERIPHERAL) {
707 ret = ci_hdrc_gadget_init(ci);
708 if (ret)
709 dev_info(dev, "doesn't support gadget\n");
710 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300711
712 if (!ci->roles[CI_ROLE_HOST] && !ci->roles[CI_ROLE_GADGET]) {
713 dev_err(dev, "no supported roles\n");
Peter Chen74475ed2013-09-24 12:47:53 +0800714 ret = -ENODEV;
Peter Chenc859aa652014-02-19 13:41:40 +0800715 goto deinit_phy;
Peter Chencbec6bd2013-08-14 12:44:10 +0300716 }
717
Peter Chen27c62c22014-09-22 08:14:16 +0800718 if (ci->is_otg && ci->roles[CI_ROLE_GADGET]) {
Peter Chen90893b92014-04-23 15:56:41 +0800719 /* Disable and clear all OTG irq */
720 hw_write_otgsc(ci, OTGSC_INT_EN_BITS | OTGSC_INT_STATUS_BITS,
721 OTGSC_INT_STATUS_BITS);
Peter Chencbec6bd2013-08-14 12:44:10 +0300722 ret = ci_hdrc_otg_init(ci);
723 if (ret) {
724 dev_err(dev, "init otg fails, ret = %d\n", ret);
725 goto stop;
726 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300727 }
728
729 if (ci->roles[CI_ROLE_HOST] && ci->roles[CI_ROLE_GADGET]) {
Peter Chen577b2322013-08-14 12:44:08 +0300730 if (ci->is_otg) {
Peter Chen577b2322013-08-14 12:44:08 +0300731 ci->role = ci_otg_role(ci);
Li Jun0c33bf72014-04-23 15:56:38 +0800732 /* Enable ID change irq */
733 hw_write_otgsc(ci, OTGSC_IDIE, OTGSC_IDIE);
Peter Chen577b2322013-08-14 12:44:08 +0300734 } else {
735 /*
736 * If the controller is not OTG capable, but support
737 * role switch, the defalt role is gadget, and the
738 * user can switch it through debugfs.
739 */
740 ci->role = CI_ROLE_GADGET;
741 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300742 } else {
743 ci->role = ci->roles[CI_ROLE_HOST]
744 ? CI_ROLE_HOST
745 : CI_ROLE_GADGET;
746 }
747
Peter Chen5a1e1452013-12-05 15:20:50 +0800748 /* only update vbus status for peripheral */
749 if (ci->role == CI_ROLE_GADGET)
750 ci_handle_vbus_change(ci);
751
Li Jun4dcf7202014-04-23 15:56:50 +0800752 if (!ci_otg_is_fsm_mode(ci)) {
753 ret = ci_role_start(ci, ci->role);
754 if (ret) {
755 dev_err(dev, "can't start %s role\n",
756 ci_role(ci)->name);
757 goto stop;
758 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300759 }
760
761 platform_set_drvdata(pdev, ci);
Peter Chen4c503dd2014-11-26 13:44:22 +0800762 ret = devm_request_irq(dev, ci->irq, ci_irq, IRQF_SHARED,
763 ci->platdata->name, ci);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300764 if (ret)
765 goto stop;
766
Li Jun4dcf7202014-04-23 15:56:50 +0800767 if (ci_otg_is_fsm_mode(ci))
768 ci_hdrc_otg_fsm_start(ci);
769
Alexander Shishkinadf0f732013-03-30 12:53:53 +0200770 ret = dbg_create_files(ci);
771 if (!ret)
772 return 0;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300773
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300774stop:
Peter Chen3f124d22013-08-14 12:44:07 +0300775 ci_role_destroy(ci);
Peter Chenc859aa652014-02-19 13:41:40 +0800776deinit_phy:
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100777 ci_usb_phy_exit(ci);
Alexander Shishkine443b332012-05-11 17:25:46 +0300778
779 return ret;
780}
781
Bill Pembertonfb4e98a2012-11-19 13:26:20 -0500782static int ci_hdrc_remove(struct platform_device *pdev)
Alexander Shishkine443b332012-05-11 17:25:46 +0300783{
Alexander Shishkin8e229782013-06-24 14:46:36 +0300784 struct ci_hdrc *ci = platform_get_drvdata(pdev);
Alexander Shishkine443b332012-05-11 17:25:46 +0300785
Alexander Shishkinadf0f732013-03-30 12:53:53 +0200786 dbg_remove_files(ci);
Peter Chen3f124d22013-08-14 12:44:07 +0300787 ci_role_destroy(ci);
Peter Chen864cf942013-09-24 12:47:55 +0800788 ci_hdrc_enter_lpm(ci, true);
Antoine Tenart1e5e2d32014-10-30 18:41:19 +0100789 ci_usb_phy_exit(ci);
Alexander Shishkine443b332012-05-11 17:25:46 +0300790
791 return 0;
792}
793
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300794static struct platform_driver ci_hdrc_driver = {
795 .probe = ci_hdrc_probe,
Bill Pemberton76904172012-11-19 13:21:08 -0500796 .remove = ci_hdrc_remove,
Alexander Shishkine443b332012-05-11 17:25:46 +0300797 .driver = {
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300798 .name = "ci_hdrc",
Alexander Shiyan7cf2f862014-04-23 15:56:42 +0800799 .owner = THIS_MODULE,
Alexander Shishkine443b332012-05-11 17:25:46 +0300800 },
801};
802
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300803module_platform_driver(ci_hdrc_driver);
Alexander Shishkine443b332012-05-11 17:25:46 +0300804
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300805MODULE_ALIAS("platform:ci_hdrc");
Alexander Shishkine443b332012-05-11 17:25:46 +0300806MODULE_LICENSE("GPL v2");
807MODULE_AUTHOR("David Lopo <dlopo@chipidea.mips.com>");
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300808MODULE_DESCRIPTION("ChipIdea HDRC Driver");