blob: 1cd5d0ba587c8ebaf49c876a086570be4cabd8c9 [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
26 * - CONFIG_USB_GADGET_DEBUG_FILES: enable debug facilities
27 * - 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
45 * - OTG
Michael Grzeschike4ce4ec2013-06-13 17:59:47 +030046 * - Interrupt Traffic
Alexander Shishkine443b332012-05-11 17:25:46 +030047 * - GET_STATUS(device) - always reports 0
48 * - Gadget API (majority of optional features)
49 * - Suspend & Remote Wakeup
50 */
51#include <linux/delay.h>
52#include <linux/device.h>
Alexander Shishkine443b332012-05-11 17:25:46 +030053#include <linux/dma-mapping.h>
Alexander Shishkine443b332012-05-11 17:25:46 +030054#include <linux/platform_device.h>
55#include <linux/module.h>
Richard Zhaofe6e1252012-07-07 22:56:42 +080056#include <linux/idr.h>
Alexander Shishkine443b332012-05-11 17:25:46 +030057#include <linux/interrupt.h>
58#include <linux/io.h>
Alexander Shishkine443b332012-05-11 17:25:46 +030059#include <linux/kernel.h>
60#include <linux/slab.h>
61#include <linux/pm_runtime.h>
62#include <linux/usb/ch9.h>
63#include <linux/usb/gadget.h>
64#include <linux/usb/otg.h>
65#include <linux/usb/chipidea.h>
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +030066#include <linux/usb/of.h>
Michael Grzeschik4f6743d2014-02-19 13:41:43 +080067#include <linux/of.h>
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +030068#include <linux/phy.h>
Peter Chen1542d9c2013-08-14 12:44:03 +030069#include <linux/regulator/consumer.h>
Alexander Shishkine443b332012-05-11 17:25:46 +030070
71#include "ci.h"
72#include "udc.h"
73#include "bits.h"
Alexander Shishkineb70e5a2012-05-11 17:25:54 +030074#include "host.h"
Alexander Shishkine443b332012-05-11 17:25:46 +030075#include "debug.h"
Peter Chenc10b4f02013-08-14 12:44:06 +030076#include "otg.h"
Alexander Shishkine443b332012-05-11 17:25:46 +030077
Alexander Shishkin5f36e232012-05-11 17:25:47 +030078/* Controller register map */
Marc Kleine-Budde987e7bc2014-01-06 10:10:39 +080079static const u8 ci_regs_nolpm[] = {
80 [CAP_CAPLENGTH] = 0x00U,
81 [CAP_HCCPARAMS] = 0x08U,
82 [CAP_DCCPARAMS] = 0x24U,
83 [CAP_TESTMODE] = 0x38U,
84 [OP_USBCMD] = 0x00U,
85 [OP_USBSTS] = 0x04U,
86 [OP_USBINTR] = 0x08U,
87 [OP_DEVICEADDR] = 0x14U,
88 [OP_ENDPTLISTADDR] = 0x18U,
89 [OP_PORTSC] = 0x44U,
90 [OP_DEVLC] = 0x84U,
91 [OP_OTGSC] = 0x64U,
92 [OP_USBMODE] = 0x68U,
93 [OP_ENDPTSETUPSTAT] = 0x6CU,
94 [OP_ENDPTPRIME] = 0x70U,
95 [OP_ENDPTFLUSH] = 0x74U,
96 [OP_ENDPTSTAT] = 0x78U,
97 [OP_ENDPTCOMPLETE] = 0x7CU,
98 [OP_ENDPTCTRL] = 0x80U,
Alexander Shishkine443b332012-05-11 17:25:46 +030099};
100
Marc Kleine-Budde987e7bc2014-01-06 10:10:39 +0800101static const u8 ci_regs_lpm[] = {
102 [CAP_CAPLENGTH] = 0x00U,
103 [CAP_HCCPARAMS] = 0x08U,
104 [CAP_DCCPARAMS] = 0x24U,
105 [CAP_TESTMODE] = 0xFCU,
106 [OP_USBCMD] = 0x00U,
107 [OP_USBSTS] = 0x04U,
108 [OP_USBINTR] = 0x08U,
109 [OP_DEVICEADDR] = 0x14U,
110 [OP_ENDPTLISTADDR] = 0x18U,
111 [OP_PORTSC] = 0x44U,
112 [OP_DEVLC] = 0x84U,
113 [OP_OTGSC] = 0xC4U,
114 [OP_USBMODE] = 0xC8U,
115 [OP_ENDPTSETUPSTAT] = 0xD8U,
116 [OP_ENDPTPRIME] = 0xDCU,
117 [OP_ENDPTFLUSH] = 0xE0U,
118 [OP_ENDPTSTAT] = 0xE4U,
119 [OP_ENDPTCOMPLETE] = 0xE8U,
120 [OP_ENDPTCTRL] = 0xECU,
Alexander Shishkine443b332012-05-11 17:25:46 +0300121};
122
Alexander Shishkin8e229782013-06-24 14:46:36 +0300123static int hw_alloc_regmap(struct ci_hdrc *ci, bool is_lpm)
Alexander Shishkine443b332012-05-11 17:25:46 +0300124{
125 int i;
126
Alexander Shishkine443b332012-05-11 17:25:46 +0300127 for (i = 0; i < OP_ENDPTCTRL; i++)
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300128 ci->hw_bank.regmap[i] =
129 (i <= CAP_LAST ? ci->hw_bank.cap : ci->hw_bank.op) +
Alexander Shishkine443b332012-05-11 17:25:46 +0300130 (is_lpm ? ci_regs_lpm[i] : ci_regs_nolpm[i]);
131
132 for (; i <= OP_LAST; i++)
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300133 ci->hw_bank.regmap[i] = ci->hw_bank.op +
Alexander Shishkine443b332012-05-11 17:25:46 +0300134 4 * (i - OP_ENDPTCTRL) +
135 (is_lpm
136 ? ci_regs_lpm[OP_ENDPTCTRL]
137 : ci_regs_nolpm[OP_ENDPTCTRL]);
138
139 return 0;
140}
141
142/**
143 * hw_port_test_set: writes port test mode (execute without interruption)
144 * @mode: new value
145 *
146 * This function returns an error code
147 */
Alexander Shishkin8e229782013-06-24 14:46:36 +0300148int hw_port_test_set(struct ci_hdrc *ci, u8 mode)
Alexander Shishkine443b332012-05-11 17:25:46 +0300149{
150 const u8 TEST_MODE_MAX = 7;
151
152 if (mode > TEST_MODE_MAX)
153 return -EINVAL;
154
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200155 hw_write(ci, OP_PORTSC, PORTSC_PTC, mode << __ffs(PORTSC_PTC));
Alexander Shishkine443b332012-05-11 17:25:46 +0300156 return 0;
157}
158
159/**
160 * hw_port_test_get: reads port test mode value
161 *
162 * This function returns port test mode value
163 */
Alexander Shishkin8e229782013-06-24 14:46:36 +0300164u8 hw_port_test_get(struct ci_hdrc *ci)
Alexander Shishkine443b332012-05-11 17:25:46 +0300165{
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200166 return hw_read(ci, OP_PORTSC, PORTSC_PTC) >> __ffs(PORTSC_PTC);
Alexander Shishkine443b332012-05-11 17:25:46 +0300167}
168
Peter Chen864cf942013-09-24 12:47:55 +0800169/* The PHY enters/leaves low power mode */
170static void ci_hdrc_enter_lpm(struct ci_hdrc *ci, bool enable)
171{
172 enum ci_hw_regs reg = ci->hw_bank.lpm ? OP_DEVLC : OP_PORTSC;
173 bool lpm = !!(hw_read(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm)));
174
175 if (enable && !lpm) {
176 hw_write(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm),
177 PORTSC_PHCD(ci->hw_bank.lpm));
178 } else if (!enable && lpm) {
179 hw_write(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm),
180 0);
181 /*
182 * The controller needs at least 1ms to reflect
183 * PHY's status, the PHY also needs some time (less
184 * than 1ms) to leave low power mode.
185 */
186 usleep_range(1500, 2000);
187 }
188}
189
Alexander Shishkin8e229782013-06-24 14:46:36 +0300190static int hw_device_init(struct ci_hdrc *ci, void __iomem *base)
Alexander Shishkine443b332012-05-11 17:25:46 +0300191{
192 u32 reg;
193
194 /* bank is a module variable */
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300195 ci->hw_bank.abs = base;
Alexander Shishkine443b332012-05-11 17:25:46 +0300196
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300197 ci->hw_bank.cap = ci->hw_bank.abs;
Richard Zhao77c44002012-06-29 17:48:53 +0800198 ci->hw_bank.cap += ci->platdata->capoffset;
Svetoslav Neykov938d3232013-03-30 12:54:03 +0200199 ci->hw_bank.op = ci->hw_bank.cap + (ioread32(ci->hw_bank.cap) & 0xff);
Alexander Shishkine443b332012-05-11 17:25:46 +0300200
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300201 hw_alloc_regmap(ci, false);
202 reg = hw_read(ci, CAP_HCCPARAMS, HCCPARAMS_LEN) >>
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200203 __ffs(HCCPARAMS_LEN);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300204 ci->hw_bank.lpm = reg;
Chris Ruehlaeb2c122013-12-06 16:35:12 +0800205 if (reg)
206 hw_alloc_regmap(ci, !!reg);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300207 ci->hw_bank.size = ci->hw_bank.op - ci->hw_bank.abs;
208 ci->hw_bank.size += OP_LAST;
209 ci->hw_bank.size /= sizeof(u32);
Alexander Shishkine443b332012-05-11 17:25:46 +0300210
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300211 reg = hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DEN) >>
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200212 __ffs(DCCPARAMS_DEN);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300213 ci->hw_ep_max = reg * 2; /* cache hw ENDPT_MAX */
Alexander Shishkine443b332012-05-11 17:25:46 +0300214
Richard Zhao09c94e62012-05-15 21:58:18 +0800215 if (ci->hw_ep_max > ENDPT_MAX)
Alexander Shishkine443b332012-05-11 17:25:46 +0300216 return -ENODEV;
217
Peter Chen864cf942013-09-24 12:47:55 +0800218 ci_hdrc_enter_lpm(ci, false);
219
Peter Chenc344b512013-08-14 12:44:09 +0300220 /* Disable all interrupts bits */
221 hw_write(ci, OP_USBINTR, 0xffffffff, 0);
222
223 /* Clear all interrupts status bits*/
224 hw_write(ci, OP_USBSTS, 0xffffffff, 0xffffffff);
225
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300226 dev_dbg(ci->dev, "ChipIdea HDRC found, lpm: %d; cap: %p op: %p\n",
227 ci->hw_bank.lpm, ci->hw_bank.cap, ci->hw_bank.op);
Alexander Shishkine443b332012-05-11 17:25:46 +0300228
229 /* setup lock mode ? */
230
231 /* ENDPTSETUPSTAT is '0' by default */
232
233 /* HCSPARAMS.bf.ppc SHOULD BE zero for device */
234
235 return 0;
236}
237
Alexander Shishkin8e229782013-06-24 14:46:36 +0300238static void hw_phymode_configure(struct ci_hdrc *ci)
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300239{
Chris Ruehl3b5d3e62014-01-10 13:51:29 +0800240 u32 portsc, lpm, sts = 0;
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300241
242 switch (ci->platdata->phy_mode) {
243 case USBPHY_INTERFACE_MODE_UTMI:
244 portsc = PORTSC_PTS(PTS_UTMI);
245 lpm = DEVLC_PTS(PTS_UTMI);
246 break;
247 case USBPHY_INTERFACE_MODE_UTMIW:
248 portsc = PORTSC_PTS(PTS_UTMI) | PORTSC_PTW;
249 lpm = DEVLC_PTS(PTS_UTMI) | DEVLC_PTW;
250 break;
251 case USBPHY_INTERFACE_MODE_ULPI:
252 portsc = PORTSC_PTS(PTS_ULPI);
253 lpm = DEVLC_PTS(PTS_ULPI);
254 break;
255 case USBPHY_INTERFACE_MODE_SERIAL:
256 portsc = PORTSC_PTS(PTS_SERIAL);
257 lpm = DEVLC_PTS(PTS_SERIAL);
258 sts = 1;
259 break;
260 case USBPHY_INTERFACE_MODE_HSIC:
261 portsc = PORTSC_PTS(PTS_HSIC);
262 lpm = DEVLC_PTS(PTS_HSIC);
263 break;
264 default:
265 return;
266 }
267
268 if (ci->hw_bank.lpm) {
269 hw_write(ci, OP_DEVLC, DEVLC_PTS(7) | DEVLC_PTW, lpm);
Chris Ruehl3b5d3e62014-01-10 13:51:29 +0800270 if (sts)
271 hw_write(ci, OP_DEVLC, DEVLC_STS, DEVLC_STS);
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300272 } else {
273 hw_write(ci, OP_PORTSC, PORTSC_PTS(7) | PORTSC_PTW, portsc);
Chris Ruehl3b5d3e62014-01-10 13:51:29 +0800274 if (sts)
275 hw_write(ci, OP_PORTSC, PORTSC_STS, PORTSC_STS);
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300276 }
277}
278
Alexander Shishkine443b332012-05-11 17:25:46 +0300279/**
Peter Chend03cccf2014-04-23 15:56:37 +0800280 * ci_usb_phy_init: initialize phy according to different phy type
281 * @ci: the controller
282 *
283 * This function returns an error code if usb_phy_init has failed
284 */
285static int ci_usb_phy_init(struct ci_hdrc *ci)
286{
287 int ret;
288
289 switch (ci->platdata->phy_mode) {
290 case USBPHY_INTERFACE_MODE_UTMI:
291 case USBPHY_INTERFACE_MODE_UTMIW:
292 case USBPHY_INTERFACE_MODE_HSIC:
293 ret = usb_phy_init(ci->transceiver);
294 if (ret)
295 return ret;
296 hw_phymode_configure(ci);
297 break;
298 case USBPHY_INTERFACE_MODE_ULPI:
299 case USBPHY_INTERFACE_MODE_SERIAL:
300 hw_phymode_configure(ci);
301 ret = usb_phy_init(ci->transceiver);
302 if (ret)
303 return ret;
304 break;
305 default:
306 ret = usb_phy_init(ci->transceiver);
307 }
308
309 return ret;
310}
311
312/**
Alexander Shishkine443b332012-05-11 17:25:46 +0300313 * hw_device_reset: resets chip (execute without interruption)
314 * @ci: the controller
315 *
316 * This function returns an error code
317 */
Alexander Shishkin8e229782013-06-24 14:46:36 +0300318int hw_device_reset(struct ci_hdrc *ci, u32 mode)
Alexander Shishkine443b332012-05-11 17:25:46 +0300319{
320 /* should flush & stop before reset */
321 hw_write(ci, OP_ENDPTFLUSH, ~0, ~0);
322 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
323
324 hw_write(ci, OP_USBCMD, USBCMD_RST, USBCMD_RST);
325 while (hw_read(ci, OP_USBCMD, USBCMD_RST))
326 udelay(10); /* not RTOS friendly */
327
Richard Zhao77c44002012-06-29 17:48:53 +0800328 if (ci->platdata->notify_event)
329 ci->platdata->notify_event(ci,
Alexander Shishkin8e229782013-06-24 14:46:36 +0300330 CI_HDRC_CONTROLLER_RESET_EVENT);
Alexander Shishkine443b332012-05-11 17:25:46 +0300331
Alexander Shishkin8e229782013-06-24 14:46:36 +0300332 if (ci->platdata->flags & CI_HDRC_DISABLE_STREAMING)
Alexander Shishkin758fc982012-05-11 17:25:53 +0300333 hw_write(ci, OP_USBMODE, USBMODE_CI_SDIS, USBMODE_CI_SDIS);
Alexander Shishkine443b332012-05-11 17:25:46 +0300334
Michael Grzeschik4f6743d2014-02-19 13:41:43 +0800335 if (ci->platdata->flags & CI_HDRC_FORCE_FULLSPEED) {
336 if (ci->hw_bank.lpm)
337 hw_write(ci, OP_DEVLC, DEVLC_PFSC, DEVLC_PFSC);
338 else
339 hw_write(ci, OP_PORTSC, PORTSC_PFSC, PORTSC_PFSC);
340 }
341
Alexander Shishkine443b332012-05-11 17:25:46 +0300342 /* USBMODE should be configured step by step */
343 hw_write(ci, OP_USBMODE, USBMODE_CM, USBMODE_CM_IDLE);
Alexander Shishkineb70e5a2012-05-11 17:25:54 +0300344 hw_write(ci, OP_USBMODE, USBMODE_CM, mode);
Alexander Shishkine443b332012-05-11 17:25:46 +0300345 /* HW >= 2.3 */
346 hw_write(ci, OP_USBMODE, USBMODE_SLOM, USBMODE_SLOM);
347
Alexander Shishkineb70e5a2012-05-11 17:25:54 +0300348 if (hw_read(ci, OP_USBMODE, USBMODE_CM) != mode) {
349 pr_err("cannot enter in %s mode", ci_role(ci)->name);
Alexander Shishkine443b332012-05-11 17:25:46 +0300350 pr_err("lpm = %i", ci->hw_bank.lpm);
351 return -ENODEV;
352 }
353
354 return 0;
355}
356
Peter Chen22fa8442013-08-14 12:44:12 +0300357/**
358 * hw_wait_reg: wait the register value
359 *
360 * Sometimes, it needs to wait register value before going on.
361 * Eg, when switch to device mode, the vbus value should be lower
362 * than OTGSC_BSV before connects to host.
363 *
364 * @ci: the controller
365 * @reg: register index
366 * @mask: mast bit
367 * @value: the bit value to wait
368 * @timeout_ms: timeout in millisecond
369 *
370 * This function returns an error code if timeout
371 */
372int hw_wait_reg(struct ci_hdrc *ci, enum ci_hw_regs reg, u32 mask,
373 u32 value, unsigned int timeout_ms)
374{
375 unsigned long elapse = jiffies + msecs_to_jiffies(timeout_ms);
376
377 while (hw_read(ci, reg, mask) != value) {
378 if (time_after(jiffies, elapse)) {
379 dev_err(ci->dev, "timeout waiting for %08x in %d\n",
380 mask, reg);
381 return -ETIMEDOUT;
382 }
383 msleep(20);
384 }
385
386 return 0;
387}
388
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300389static irqreturn_t ci_irq(int irq, void *data)
390{
Alexander Shishkin8e229782013-06-24 14:46:36 +0300391 struct ci_hdrc *ci = data;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300392 irqreturn_t ret = IRQ_NONE;
Richard Zhaob183c192012-09-12 14:58:11 +0300393 u32 otgsc = 0;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300394
Richard Zhaob183c192012-09-12 14:58:11 +0300395 if (ci->is_otg)
396 otgsc = hw_read(ci, OP_OTGSC, ~0);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300397
Peter Chena107f8c2013-08-14 12:44:11 +0300398 /*
399 * Handle id change interrupt, it indicates device/host function
400 * switch.
401 */
402 if (ci->is_otg && (otgsc & OTGSC_IDIE) && (otgsc & OTGSC_IDIS)) {
403 ci->id_event = true;
404 ci_clear_otg_interrupt(ci, OTGSC_IDIS);
Richard Zhaob183c192012-09-12 14:58:11 +0300405 disable_irq_nosync(ci->irq);
406 queue_work(ci->wq, &ci->work);
Peter Chena107f8c2013-08-14 12:44:11 +0300407 return IRQ_HANDLED;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300408 }
409
Peter Chena107f8c2013-08-14 12:44:11 +0300410 /*
411 * Handle vbus change interrupt, it indicates device connection
412 * and disconnection events.
413 */
414 if (ci->is_otg && (otgsc & OTGSC_BSVIE) && (otgsc & OTGSC_BSVIS)) {
415 ci->b_sess_valid_event = true;
416 ci_clear_otg_interrupt(ci, OTGSC_BSVIS);
417 disable_irq_nosync(ci->irq);
418 queue_work(ci->wq, &ci->work);
419 return IRQ_HANDLED;
420 }
421
422 /* Handle device/host interrupt */
423 if (ci->role != CI_ROLE_END)
424 ret = ci_role(ci)->irq(ci);
425
Richard Zhaob183c192012-09-12 14:58:11 +0300426 return ret;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300427}
428
Peter Chen1542d9c2013-08-14 12:44:03 +0300429static int ci_get_platdata(struct device *dev,
430 struct ci_hdrc_platform_data *platdata)
431{
Peter Chenc22600c2013-09-17 12:37:22 +0800432 if (!platdata->phy_mode)
433 platdata->phy_mode = of_usb_get_phy_mode(dev->of_node);
434
435 if (!platdata->dr_mode)
436 platdata->dr_mode = of_usb_get_dr_mode(dev->of_node);
437
438 if (platdata->dr_mode == USB_DR_MODE_UNKNOWN)
439 platdata->dr_mode = USB_DR_MODE_OTG;
440
Peter Chenc2ec3a72013-10-30 09:19:29 +0800441 if (platdata->dr_mode != USB_DR_MODE_PERIPHERAL) {
442 /* Get the vbus regulator */
443 platdata->reg_vbus = devm_regulator_get(dev, "vbus");
444 if (PTR_ERR(platdata->reg_vbus) == -EPROBE_DEFER) {
445 return -EPROBE_DEFER;
446 } else if (PTR_ERR(platdata->reg_vbus) == -ENODEV) {
447 /* no vbus regualator is needed */
448 platdata->reg_vbus = NULL;
449 } else if (IS_ERR(platdata->reg_vbus)) {
450 dev_err(dev, "Getting regulator error: %ld\n",
451 PTR_ERR(platdata->reg_vbus));
452 return PTR_ERR(platdata->reg_vbus);
453 }
454 }
455
Michael Grzeschik4f6743d2014-02-19 13:41:43 +0800456 if (of_usb_get_maximum_speed(dev->of_node) == USB_SPEED_FULL)
457 platdata->flags |= CI_HDRC_FORCE_FULLSPEED;
458
Peter Chen1542d9c2013-08-14 12:44:03 +0300459 return 0;
460}
461
Richard Zhaofe6e1252012-07-07 22:56:42 +0800462static DEFINE_IDA(ci_ida);
463
Alexander Shishkin8e229782013-06-24 14:46:36 +0300464struct platform_device *ci_hdrc_add_device(struct device *dev,
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800465 struct resource *res, int nres,
Alexander Shishkin8e229782013-06-24 14:46:36 +0300466 struct ci_hdrc_platform_data *platdata)
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800467{
468 struct platform_device *pdev;
Richard Zhaofe6e1252012-07-07 22:56:42 +0800469 int id, ret;
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800470
Peter Chen1542d9c2013-08-14 12:44:03 +0300471 ret = ci_get_platdata(dev, platdata);
472 if (ret)
473 return ERR_PTR(ret);
474
Richard Zhaofe6e1252012-07-07 22:56:42 +0800475 id = ida_simple_get(&ci_ida, 0, 0, GFP_KERNEL);
476 if (id < 0)
477 return ERR_PTR(id);
478
479 pdev = platform_device_alloc("ci_hdrc", id);
480 if (!pdev) {
481 ret = -ENOMEM;
482 goto put_id;
483 }
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800484
485 pdev->dev.parent = dev;
486 pdev->dev.dma_mask = dev->dma_mask;
487 pdev->dev.dma_parms = dev->dma_parms;
488 dma_set_coherent_mask(&pdev->dev, dev->coherent_dma_mask);
489
490 ret = platform_device_add_resources(pdev, res, nres);
491 if (ret)
492 goto err;
493
494 ret = platform_device_add_data(pdev, platdata, sizeof(*platdata));
495 if (ret)
496 goto err;
497
498 ret = platform_device_add(pdev);
499 if (ret)
500 goto err;
501
502 return pdev;
503
504err:
505 platform_device_put(pdev);
Richard Zhaofe6e1252012-07-07 22:56:42 +0800506put_id:
507 ida_simple_remove(&ci_ida, id);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800508 return ERR_PTR(ret);
509}
Alexander Shishkin8e229782013-06-24 14:46:36 +0300510EXPORT_SYMBOL_GPL(ci_hdrc_add_device);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800511
Alexander Shishkin8e229782013-06-24 14:46:36 +0300512void ci_hdrc_remove_device(struct platform_device *pdev)
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800513{
Lothar Waßmann98c35532012-11-22 10:11:25 +0100514 int id = pdev->id;
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800515 platform_device_unregister(pdev);
Lothar Waßmann98c35532012-11-22 10:11:25 +0100516 ida_simple_remove(&ci_ida, id);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800517}
Alexander Shishkin8e229782013-06-24 14:46:36 +0300518EXPORT_SYMBOL_GPL(ci_hdrc_remove_device);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800519
Peter Chen3f124d22013-08-14 12:44:07 +0300520static inline void ci_role_destroy(struct ci_hdrc *ci)
521{
522 ci_hdrc_gadget_destroy(ci);
523 ci_hdrc_host_destroy(ci);
Peter Chencbec6bd2013-08-14 12:44:10 +0300524 if (ci->is_otg)
525 ci_hdrc_otg_destroy(ci);
Peter Chen3f124d22013-08-14 12:44:07 +0300526}
527
Peter Chen577b2322013-08-14 12:44:08 +0300528static void ci_get_otg_capable(struct ci_hdrc *ci)
529{
530 if (ci->platdata->flags & CI_HDRC_DUAL_ROLE_NOT_OTG)
531 ci->is_otg = false;
532 else
533 ci->is_otg = (hw_read(ci, CAP_DCCPARAMS,
534 DCCPARAMS_DC | DCCPARAMS_HC)
535 == (DCCPARAMS_DC | DCCPARAMS_HC));
Peter Chenc344b512013-08-14 12:44:09 +0300536 if (ci->is_otg) {
Peter Chen577b2322013-08-14 12:44:08 +0300537 dev_dbg(ci->dev, "It is OTG capable controller\n");
Peter Chenc344b512013-08-14 12:44:09 +0300538 ci_disable_otg_interrupt(ci, OTGSC_INT_EN_BITS);
539 ci_clear_otg_interrupt(ci, OTGSC_INT_STATUS_BITS);
540 }
Peter Chen577b2322013-08-14 12:44:08 +0300541}
542
Bill Pemberton41ac7b32012-11-19 13:21:48 -0500543static int ci_hdrc_probe(struct platform_device *pdev)
Alexander Shishkine443b332012-05-11 17:25:46 +0300544{
545 struct device *dev = &pdev->dev;
Alexander Shishkin8e229782013-06-24 14:46:36 +0300546 struct ci_hdrc *ci;
Alexander Shishkine443b332012-05-11 17:25:46 +0300547 struct resource *res;
548 void __iomem *base;
549 int ret;
Sascha Hauer691962d2013-06-13 17:59:57 +0300550 enum usb_dr_mode dr_mode;
Alexander Shishkine443b332012-05-11 17:25:46 +0300551
Jingoo Hanfad56742014-02-19 13:41:42 +0800552 if (!dev_get_platdata(dev)) {
Alexander Shishkine443b332012-05-11 17:25:46 +0300553 dev_err(dev, "platform data missing\n");
554 return -ENODEV;
555 }
556
557 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
Felipe Balbi19290812013-03-30 02:46:27 +0200558 base = devm_ioremap_resource(dev, res);
559 if (IS_ERR(base))
560 return PTR_ERR(base);
Alexander Shishkine443b332012-05-11 17:25:46 +0300561
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300562 ci = devm_kzalloc(dev, sizeof(*ci), GFP_KERNEL);
563 if (!ci) {
564 dev_err(dev, "can't allocate device\n");
565 return -ENOMEM;
Alexander Shishkine443b332012-05-11 17:25:46 +0300566 }
567
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300568 ci->dev = dev;
Jingoo Hanfad56742014-02-19 13:41:42 +0800569 ci->platdata = dev_get_platdata(dev);
Peter Chened8f8312014-01-10 13:51:27 +0800570 ci->imx28_write_fix = !!(ci->platdata->flags &
571 CI_HDRC_IMX28_WRITE_FIX);
Alexander Shishkine443b332012-05-11 17:25:46 +0300572
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300573 ret = hw_device_init(ci, base);
574 if (ret < 0) {
575 dev_err(dev, "can't initialize hardware\n");
576 return -ENODEV;
577 }
578
Peter Chenc859aa652014-02-19 13:41:40 +0800579 if (ci->platdata->phy)
580 ci->transceiver = ci->platdata->phy;
581 else
582 ci->transceiver = devm_usb_get_phy(dev, USB_PHY_TYPE_USB2);
583
584 if (IS_ERR(ci->transceiver)) {
585 ret = PTR_ERR(ci->transceiver);
586 /*
587 * if -ENXIO is returned, it means PHY layer wasn't
588 * enabled, so it makes no sense to return -EPROBE_DEFER
589 * in that case, since no PHY driver will ever probe.
590 */
591 if (ret == -ENXIO)
592 return ret;
593
594 dev_err(dev, "no usb2 phy configured\n");
595 return -EPROBE_DEFER;
596 }
597
Peter Chend03cccf2014-04-23 15:56:37 +0800598 ret = ci_usb_phy_init(ci);
Peter Chen74475ed2013-09-24 12:47:53 +0800599 if (ret) {
600 dev_err(dev, "unable to init phy: %d\n", ret);
601 return ret;
602 }
603
Alexander Shishkineb70e5a2012-05-11 17:25:54 +0300604 ci->hw_bank.phys = res->start;
605
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300606 ci->irq = platform_get_irq(pdev, 0);
607 if (ci->irq < 0) {
608 dev_err(dev, "missing IRQ\n");
Fabio Estevam42d18212014-02-19 13:41:44 +0800609 ret = ci->irq;
Peter Chenc859aa652014-02-19 13:41:40 +0800610 goto deinit_phy;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300611 }
612
Peter Chen577b2322013-08-14 12:44:08 +0300613 ci_get_otg_capable(ci);
614
Sascha Hauer691962d2013-06-13 17:59:57 +0300615 dr_mode = ci->platdata->dr_mode;
616 /* initialize role(s) before the interrupt is requested */
617 if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_HOST) {
618 ret = ci_hdrc_host_init(ci);
619 if (ret)
620 dev_info(dev, "doesn't support host\n");
621 }
622
623 if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_PERIPHERAL) {
624 ret = ci_hdrc_gadget_init(ci);
625 if (ret)
626 dev_info(dev, "doesn't support gadget\n");
627 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300628
629 if (!ci->roles[CI_ROLE_HOST] && !ci->roles[CI_ROLE_GADGET]) {
630 dev_err(dev, "no supported roles\n");
Peter Chen74475ed2013-09-24 12:47:53 +0800631 ret = -ENODEV;
Peter Chenc859aa652014-02-19 13:41:40 +0800632 goto deinit_phy;
Peter Chencbec6bd2013-08-14 12:44:10 +0300633 }
634
635 if (ci->is_otg) {
636 ret = ci_hdrc_otg_init(ci);
637 if (ret) {
638 dev_err(dev, "init otg fails, ret = %d\n", ret);
639 goto stop;
640 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300641 }
642
643 if (ci->roles[CI_ROLE_HOST] && ci->roles[CI_ROLE_GADGET]) {
Peter Chen577b2322013-08-14 12:44:08 +0300644 if (ci->is_otg) {
645 /*
646 * ID pin needs 1ms debouce time,
647 * we delay 2ms for safe.
648 */
649 mdelay(2);
650 ci->role = ci_otg_role(ci);
Peter Chencbec6bd2013-08-14 12:44:10 +0300651 ci_enable_otg_interrupt(ci, OTGSC_IDIE);
Peter Chen577b2322013-08-14 12:44:08 +0300652 } else {
653 /*
654 * If the controller is not OTG capable, but support
655 * role switch, the defalt role is gadget, and the
656 * user can switch it through debugfs.
657 */
658 ci->role = CI_ROLE_GADGET;
659 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300660 } else {
661 ci->role = ci->roles[CI_ROLE_HOST]
662 ? CI_ROLE_HOST
663 : CI_ROLE_GADGET;
664 }
665
Peter Chen5a1e1452013-12-05 15:20:50 +0800666 /* only update vbus status for peripheral */
667 if (ci->role == CI_ROLE_GADGET)
668 ci_handle_vbus_change(ci);
669
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300670 ret = ci_role_start(ci, ci->role);
671 if (ret) {
672 dev_err(dev, "can't start %s role\n", ci_role(ci)->name);
Peter Chencbec6bd2013-08-14 12:44:10 +0300673 goto stop;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300674 }
675
676 platform_set_drvdata(pdev, ci);
Richard Zhao77c44002012-06-29 17:48:53 +0800677 ret = request_irq(ci->irq, ci_irq, IRQF_SHARED, ci->platdata->name,
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300678 ci);
679 if (ret)
680 goto stop;
681
Alexander Shishkinadf0f732013-03-30 12:53:53 +0200682 ret = dbg_create_files(ci);
683 if (!ret)
684 return 0;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300685
Alexander Shishkinadf0f732013-03-30 12:53:53 +0200686 free_irq(ci->irq, ci);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300687stop:
Peter Chen3f124d22013-08-14 12:44:07 +0300688 ci_role_destroy(ci);
Peter Chenc859aa652014-02-19 13:41:40 +0800689deinit_phy:
690 usb_phy_shutdown(ci->transceiver);
Alexander Shishkine443b332012-05-11 17:25:46 +0300691
692 return ret;
693}
694
Bill Pembertonfb4e98a2012-11-19 13:26:20 -0500695static int ci_hdrc_remove(struct platform_device *pdev)
Alexander Shishkine443b332012-05-11 17:25:46 +0300696{
Alexander Shishkin8e229782013-06-24 14:46:36 +0300697 struct ci_hdrc *ci = platform_get_drvdata(pdev);
Alexander Shishkine443b332012-05-11 17:25:46 +0300698
Alexander Shishkinadf0f732013-03-30 12:53:53 +0200699 dbg_remove_files(ci);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300700 free_irq(ci->irq, ci);
Peter Chen3f124d22013-08-14 12:44:07 +0300701 ci_role_destroy(ci);
Peter Chen864cf942013-09-24 12:47:55 +0800702 ci_hdrc_enter_lpm(ci, true);
Peter Chenc859aa652014-02-19 13:41:40 +0800703 usb_phy_shutdown(ci->transceiver);
704 kfree(ci->hw_bank.regmap);
Alexander Shishkine443b332012-05-11 17:25:46 +0300705
706 return 0;
707}
708
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300709static struct platform_driver ci_hdrc_driver = {
710 .probe = ci_hdrc_probe,
Bill Pemberton76904172012-11-19 13:21:08 -0500711 .remove = ci_hdrc_remove,
Alexander Shishkine443b332012-05-11 17:25:46 +0300712 .driver = {
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300713 .name = "ci_hdrc",
Alexander Shishkine443b332012-05-11 17:25:46 +0300714 },
715};
716
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300717module_platform_driver(ci_hdrc_driver);
Alexander Shishkine443b332012-05-11 17:25:46 +0300718
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300719MODULE_ALIAS("platform:ci_hdrc");
Alexander Shishkine443b332012-05-11 17:25:46 +0300720MODULE_LICENSE("GPL v2");
721MODULE_AUTHOR("David Lopo <dlopo@chipidea.mips.com>");
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300722MODULE_DESCRIPTION("ChipIdea HDRC Driver");