blob: ff38cf3674640d42970bd5463d2638cb9c9112f3 [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/**
Li Jun36304b02014-04-23 15:56:39 +0800143 * hw_read_intr_enable: returns interrupt enable register
144 *
145 * 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 *
155 * This function returns register data
156 */
157u32 hw_read_intr_status(struct ci_hdrc *ci)
158{
159 return hw_read(ci, OP_USBSTS, ~0);
160}
161
162/**
Alexander Shishkine443b332012-05-11 17:25:46 +0300163 * hw_port_test_set: writes port test mode (execute without interruption)
164 * @mode: new value
165 *
166 * This function returns an error code
167 */
Alexander Shishkin8e229782013-06-24 14:46:36 +0300168int hw_port_test_set(struct ci_hdrc *ci, u8 mode)
Alexander Shishkine443b332012-05-11 17:25:46 +0300169{
170 const u8 TEST_MODE_MAX = 7;
171
172 if (mode > TEST_MODE_MAX)
173 return -EINVAL;
174
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200175 hw_write(ci, OP_PORTSC, PORTSC_PTC, mode << __ffs(PORTSC_PTC));
Alexander Shishkine443b332012-05-11 17:25:46 +0300176 return 0;
177}
178
179/**
180 * hw_port_test_get: reads port test mode value
181 *
182 * This function returns port test mode value
183 */
Alexander Shishkin8e229782013-06-24 14:46:36 +0300184u8 hw_port_test_get(struct ci_hdrc *ci)
Alexander Shishkine443b332012-05-11 17:25:46 +0300185{
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200186 return hw_read(ci, OP_PORTSC, PORTSC_PTC) >> __ffs(PORTSC_PTC);
Alexander Shishkine443b332012-05-11 17:25:46 +0300187}
188
Peter Chen864cf942013-09-24 12:47:55 +0800189/* The PHY enters/leaves low power mode */
190static void ci_hdrc_enter_lpm(struct ci_hdrc *ci, bool enable)
191{
192 enum ci_hw_regs reg = ci->hw_bank.lpm ? OP_DEVLC : OP_PORTSC;
193 bool lpm = !!(hw_read(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm)));
194
195 if (enable && !lpm) {
196 hw_write(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm),
197 PORTSC_PHCD(ci->hw_bank.lpm));
198 } else if (!enable && lpm) {
199 hw_write(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm),
200 0);
201 /*
202 * The controller needs at least 1ms to reflect
203 * PHY's status, the PHY also needs some time (less
204 * than 1ms) to leave low power mode.
205 */
206 usleep_range(1500, 2000);
207 }
208}
209
Alexander Shishkin8e229782013-06-24 14:46:36 +0300210static int hw_device_init(struct ci_hdrc *ci, void __iomem *base)
Alexander Shishkine443b332012-05-11 17:25:46 +0300211{
212 u32 reg;
213
214 /* bank is a module variable */
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300215 ci->hw_bank.abs = base;
Alexander Shishkine443b332012-05-11 17:25:46 +0300216
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300217 ci->hw_bank.cap = ci->hw_bank.abs;
Richard Zhao77c44002012-06-29 17:48:53 +0800218 ci->hw_bank.cap += ci->platdata->capoffset;
Svetoslav Neykov938d3232013-03-30 12:54:03 +0200219 ci->hw_bank.op = ci->hw_bank.cap + (ioread32(ci->hw_bank.cap) & 0xff);
Alexander Shishkine443b332012-05-11 17:25:46 +0300220
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300221 hw_alloc_regmap(ci, false);
222 reg = hw_read(ci, CAP_HCCPARAMS, HCCPARAMS_LEN) >>
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200223 __ffs(HCCPARAMS_LEN);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300224 ci->hw_bank.lpm = reg;
Chris Ruehlaeb2c122013-12-06 16:35:12 +0800225 if (reg)
226 hw_alloc_regmap(ci, !!reg);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300227 ci->hw_bank.size = ci->hw_bank.op - ci->hw_bank.abs;
228 ci->hw_bank.size += OP_LAST;
229 ci->hw_bank.size /= sizeof(u32);
Alexander Shishkine443b332012-05-11 17:25:46 +0300230
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300231 reg = hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DEN) >>
Felipe Balbi727b4dd2013-03-30 12:53:55 +0200232 __ffs(DCCPARAMS_DEN);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300233 ci->hw_ep_max = reg * 2; /* cache hw ENDPT_MAX */
Alexander Shishkine443b332012-05-11 17:25:46 +0300234
Richard Zhao09c94e62012-05-15 21:58:18 +0800235 if (ci->hw_ep_max > ENDPT_MAX)
Alexander Shishkine443b332012-05-11 17:25:46 +0300236 return -ENODEV;
237
Peter Chen864cf942013-09-24 12:47:55 +0800238 ci_hdrc_enter_lpm(ci, false);
239
Peter Chenc344b512013-08-14 12:44:09 +0300240 /* Disable all interrupts bits */
241 hw_write(ci, OP_USBINTR, 0xffffffff, 0);
242
243 /* Clear all interrupts status bits*/
244 hw_write(ci, OP_USBSTS, 0xffffffff, 0xffffffff);
245
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300246 dev_dbg(ci->dev, "ChipIdea HDRC found, lpm: %d; cap: %p op: %p\n",
247 ci->hw_bank.lpm, ci->hw_bank.cap, ci->hw_bank.op);
Alexander Shishkine443b332012-05-11 17:25:46 +0300248
249 /* setup lock mode ? */
250
251 /* ENDPTSETUPSTAT is '0' by default */
252
253 /* HCSPARAMS.bf.ppc SHOULD BE zero for device */
254
255 return 0;
256}
257
Alexander Shishkin8e229782013-06-24 14:46:36 +0300258static void hw_phymode_configure(struct ci_hdrc *ci)
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300259{
Chris Ruehl3b5d3e62014-01-10 13:51:29 +0800260 u32 portsc, lpm, sts = 0;
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300261
262 switch (ci->platdata->phy_mode) {
263 case USBPHY_INTERFACE_MODE_UTMI:
264 portsc = PORTSC_PTS(PTS_UTMI);
265 lpm = DEVLC_PTS(PTS_UTMI);
266 break;
267 case USBPHY_INTERFACE_MODE_UTMIW:
268 portsc = PORTSC_PTS(PTS_UTMI) | PORTSC_PTW;
269 lpm = DEVLC_PTS(PTS_UTMI) | DEVLC_PTW;
270 break;
271 case USBPHY_INTERFACE_MODE_ULPI:
272 portsc = PORTSC_PTS(PTS_ULPI);
273 lpm = DEVLC_PTS(PTS_ULPI);
274 break;
275 case USBPHY_INTERFACE_MODE_SERIAL:
276 portsc = PORTSC_PTS(PTS_SERIAL);
277 lpm = DEVLC_PTS(PTS_SERIAL);
278 sts = 1;
279 break;
280 case USBPHY_INTERFACE_MODE_HSIC:
281 portsc = PORTSC_PTS(PTS_HSIC);
282 lpm = DEVLC_PTS(PTS_HSIC);
283 break;
284 default:
285 return;
286 }
287
288 if (ci->hw_bank.lpm) {
289 hw_write(ci, OP_DEVLC, DEVLC_PTS(7) | DEVLC_PTW, lpm);
Chris Ruehl3b5d3e62014-01-10 13:51:29 +0800290 if (sts)
291 hw_write(ci, OP_DEVLC, DEVLC_STS, DEVLC_STS);
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300292 } else {
293 hw_write(ci, OP_PORTSC, PORTSC_PTS(7) | PORTSC_PTW, portsc);
Chris Ruehl3b5d3e62014-01-10 13:51:29 +0800294 if (sts)
295 hw_write(ci, OP_PORTSC, PORTSC_STS, PORTSC_STS);
Michael Grzeschik40dcd0e2013-06-13 17:59:56 +0300296 }
297}
298
Alexander Shishkine443b332012-05-11 17:25:46 +0300299/**
Peter Chend03cccf2014-04-23 15:56:37 +0800300 * ci_usb_phy_init: initialize phy according to different phy type
301 * @ci: the controller
302 *
303 * This function returns an error code if usb_phy_init has failed
304 */
305static int ci_usb_phy_init(struct ci_hdrc *ci)
306{
307 int ret;
308
309 switch (ci->platdata->phy_mode) {
310 case USBPHY_INTERFACE_MODE_UTMI:
311 case USBPHY_INTERFACE_MODE_UTMIW:
312 case USBPHY_INTERFACE_MODE_HSIC:
313 ret = usb_phy_init(ci->transceiver);
314 if (ret)
315 return ret;
316 hw_phymode_configure(ci);
317 break;
318 case USBPHY_INTERFACE_MODE_ULPI:
319 case USBPHY_INTERFACE_MODE_SERIAL:
320 hw_phymode_configure(ci);
321 ret = usb_phy_init(ci->transceiver);
322 if (ret)
323 return ret;
324 break;
325 default:
326 ret = usb_phy_init(ci->transceiver);
327 }
328
329 return ret;
330}
331
332/**
Alexander Shishkine443b332012-05-11 17:25:46 +0300333 * hw_device_reset: resets chip (execute without interruption)
334 * @ci: the controller
335 *
336 * This function returns an error code
337 */
Alexander Shishkin8e229782013-06-24 14:46:36 +0300338int hw_device_reset(struct ci_hdrc *ci, u32 mode)
Alexander Shishkine443b332012-05-11 17:25:46 +0300339{
340 /* should flush & stop before reset */
341 hw_write(ci, OP_ENDPTFLUSH, ~0, ~0);
342 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
343
344 hw_write(ci, OP_USBCMD, USBCMD_RST, USBCMD_RST);
345 while (hw_read(ci, OP_USBCMD, USBCMD_RST))
346 udelay(10); /* not RTOS friendly */
347
Richard Zhao77c44002012-06-29 17:48:53 +0800348 if (ci->platdata->notify_event)
349 ci->platdata->notify_event(ci,
Alexander Shishkin8e229782013-06-24 14:46:36 +0300350 CI_HDRC_CONTROLLER_RESET_EVENT);
Alexander Shishkine443b332012-05-11 17:25:46 +0300351
Alexander Shishkin8e229782013-06-24 14:46:36 +0300352 if (ci->platdata->flags & CI_HDRC_DISABLE_STREAMING)
Alexander Shishkin758fc982012-05-11 17:25:53 +0300353 hw_write(ci, OP_USBMODE, USBMODE_CI_SDIS, USBMODE_CI_SDIS);
Alexander Shishkine443b332012-05-11 17:25:46 +0300354
Michael Grzeschik4f6743d2014-02-19 13:41:43 +0800355 if (ci->platdata->flags & CI_HDRC_FORCE_FULLSPEED) {
356 if (ci->hw_bank.lpm)
357 hw_write(ci, OP_DEVLC, DEVLC_PFSC, DEVLC_PFSC);
358 else
359 hw_write(ci, OP_PORTSC, PORTSC_PFSC, PORTSC_PFSC);
360 }
361
Alexander Shishkine443b332012-05-11 17:25:46 +0300362 /* USBMODE should be configured step by step */
363 hw_write(ci, OP_USBMODE, USBMODE_CM, USBMODE_CM_IDLE);
Alexander Shishkineb70e5a2012-05-11 17:25:54 +0300364 hw_write(ci, OP_USBMODE, USBMODE_CM, mode);
Alexander Shishkine443b332012-05-11 17:25:46 +0300365 /* HW >= 2.3 */
366 hw_write(ci, OP_USBMODE, USBMODE_SLOM, USBMODE_SLOM);
367
Alexander Shishkineb70e5a2012-05-11 17:25:54 +0300368 if (hw_read(ci, OP_USBMODE, USBMODE_CM) != mode) {
369 pr_err("cannot enter in %s mode", ci_role(ci)->name);
Alexander Shishkine443b332012-05-11 17:25:46 +0300370 pr_err("lpm = %i", ci->hw_bank.lpm);
371 return -ENODEV;
372 }
373
374 return 0;
375}
376
Peter Chen22fa8442013-08-14 12:44:12 +0300377/**
378 * hw_wait_reg: wait the register value
379 *
380 * Sometimes, it needs to wait register value before going on.
381 * Eg, when switch to device mode, the vbus value should be lower
382 * than OTGSC_BSV before connects to host.
383 *
384 * @ci: the controller
385 * @reg: register index
386 * @mask: mast bit
387 * @value: the bit value to wait
388 * @timeout_ms: timeout in millisecond
389 *
390 * This function returns an error code if timeout
391 */
392int hw_wait_reg(struct ci_hdrc *ci, enum ci_hw_regs reg, u32 mask,
393 u32 value, unsigned int timeout_ms)
394{
395 unsigned long elapse = jiffies + msecs_to_jiffies(timeout_ms);
396
397 while (hw_read(ci, reg, mask) != value) {
398 if (time_after(jiffies, elapse)) {
399 dev_err(ci->dev, "timeout waiting for %08x in %d\n",
400 mask, reg);
401 return -ETIMEDOUT;
402 }
403 msleep(20);
404 }
405
406 return 0;
407}
408
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300409static irqreturn_t ci_irq(int irq, void *data)
410{
Alexander Shishkin8e229782013-06-24 14:46:36 +0300411 struct ci_hdrc *ci = data;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300412 irqreturn_t ret = IRQ_NONE;
Richard Zhaob183c192012-09-12 14:58:11 +0300413 u32 otgsc = 0;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300414
Richard Zhaob183c192012-09-12 14:58:11 +0300415 if (ci->is_otg)
Li Jun0c33bf72014-04-23 15:56:38 +0800416 otgsc = hw_read_otgsc(ci, ~0);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300417
Peter Chena107f8c2013-08-14 12:44:11 +0300418 /*
419 * Handle id change interrupt, it indicates device/host function
420 * switch.
421 */
422 if (ci->is_otg && (otgsc & OTGSC_IDIE) && (otgsc & OTGSC_IDIS)) {
423 ci->id_event = true;
Li Jun0c33bf72014-04-23 15:56:38 +0800424 /* Clear ID change irq status */
425 hw_write_otgsc(ci, OTGSC_IDIS, OTGSC_IDIS);
Richard Zhaob183c192012-09-12 14:58:11 +0300426 disable_irq_nosync(ci->irq);
427 queue_work(ci->wq, &ci->work);
Peter Chena107f8c2013-08-14 12:44:11 +0300428 return IRQ_HANDLED;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300429 }
430
Peter Chena107f8c2013-08-14 12:44:11 +0300431 /*
432 * Handle vbus change interrupt, it indicates device connection
433 * and disconnection events.
434 */
435 if (ci->is_otg && (otgsc & OTGSC_BSVIE) && (otgsc & OTGSC_BSVIS)) {
436 ci->b_sess_valid_event = true;
Li Jun0c33bf72014-04-23 15:56:38 +0800437 /* Clear BSV irq */
438 hw_write_otgsc(ci, OTGSC_BSVIS, OTGSC_BSVIS);
Peter Chena107f8c2013-08-14 12:44:11 +0300439 disable_irq_nosync(ci->irq);
440 queue_work(ci->wq, &ci->work);
441 return IRQ_HANDLED;
442 }
443
444 /* Handle device/host interrupt */
445 if (ci->role != CI_ROLE_END)
446 ret = ci_role(ci)->irq(ci);
447
Richard Zhaob183c192012-09-12 14:58:11 +0300448 return ret;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300449}
450
Peter Chen1542d9c2013-08-14 12:44:03 +0300451static int ci_get_platdata(struct device *dev,
452 struct ci_hdrc_platform_data *platdata)
453{
Peter Chenc22600c2013-09-17 12:37:22 +0800454 if (!platdata->phy_mode)
455 platdata->phy_mode = of_usb_get_phy_mode(dev->of_node);
456
457 if (!platdata->dr_mode)
458 platdata->dr_mode = of_usb_get_dr_mode(dev->of_node);
459
460 if (platdata->dr_mode == USB_DR_MODE_UNKNOWN)
461 platdata->dr_mode = USB_DR_MODE_OTG;
462
Peter Chenc2ec3a72013-10-30 09:19:29 +0800463 if (platdata->dr_mode != USB_DR_MODE_PERIPHERAL) {
464 /* Get the vbus regulator */
465 platdata->reg_vbus = devm_regulator_get(dev, "vbus");
466 if (PTR_ERR(platdata->reg_vbus) == -EPROBE_DEFER) {
467 return -EPROBE_DEFER;
468 } else if (PTR_ERR(platdata->reg_vbus) == -ENODEV) {
469 /* no vbus regualator is needed */
470 platdata->reg_vbus = NULL;
471 } else if (IS_ERR(platdata->reg_vbus)) {
472 dev_err(dev, "Getting regulator error: %ld\n",
473 PTR_ERR(platdata->reg_vbus));
474 return PTR_ERR(platdata->reg_vbus);
475 }
476 }
477
Michael Grzeschik4f6743d2014-02-19 13:41:43 +0800478 if (of_usb_get_maximum_speed(dev->of_node) == USB_SPEED_FULL)
479 platdata->flags |= CI_HDRC_FORCE_FULLSPEED;
480
Peter Chen1542d9c2013-08-14 12:44:03 +0300481 return 0;
482}
483
Richard Zhaofe6e1252012-07-07 22:56:42 +0800484static DEFINE_IDA(ci_ida);
485
Alexander Shishkin8e229782013-06-24 14:46:36 +0300486struct platform_device *ci_hdrc_add_device(struct device *dev,
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800487 struct resource *res, int nres,
Alexander Shishkin8e229782013-06-24 14:46:36 +0300488 struct ci_hdrc_platform_data *platdata)
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800489{
490 struct platform_device *pdev;
Richard Zhaofe6e1252012-07-07 22:56:42 +0800491 int id, ret;
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800492
Peter Chen1542d9c2013-08-14 12:44:03 +0300493 ret = ci_get_platdata(dev, platdata);
494 if (ret)
495 return ERR_PTR(ret);
496
Richard Zhaofe6e1252012-07-07 22:56:42 +0800497 id = ida_simple_get(&ci_ida, 0, 0, GFP_KERNEL);
498 if (id < 0)
499 return ERR_PTR(id);
500
501 pdev = platform_device_alloc("ci_hdrc", id);
502 if (!pdev) {
503 ret = -ENOMEM;
504 goto put_id;
505 }
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800506
507 pdev->dev.parent = dev;
508 pdev->dev.dma_mask = dev->dma_mask;
509 pdev->dev.dma_parms = dev->dma_parms;
510 dma_set_coherent_mask(&pdev->dev, dev->coherent_dma_mask);
511
512 ret = platform_device_add_resources(pdev, res, nres);
513 if (ret)
514 goto err;
515
516 ret = platform_device_add_data(pdev, platdata, sizeof(*platdata));
517 if (ret)
518 goto err;
519
520 ret = platform_device_add(pdev);
521 if (ret)
522 goto err;
523
524 return pdev;
525
526err:
527 platform_device_put(pdev);
Richard Zhaofe6e1252012-07-07 22:56:42 +0800528put_id:
529 ida_simple_remove(&ci_ida, id);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800530 return ERR_PTR(ret);
531}
Alexander Shishkin8e229782013-06-24 14:46:36 +0300532EXPORT_SYMBOL_GPL(ci_hdrc_add_device);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800533
Alexander Shishkin8e229782013-06-24 14:46:36 +0300534void ci_hdrc_remove_device(struct platform_device *pdev)
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800535{
Lothar Waßmann98c35532012-11-22 10:11:25 +0100536 int id = pdev->id;
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800537 platform_device_unregister(pdev);
Lothar Waßmann98c35532012-11-22 10:11:25 +0100538 ida_simple_remove(&ci_ida, id);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800539}
Alexander Shishkin8e229782013-06-24 14:46:36 +0300540EXPORT_SYMBOL_GPL(ci_hdrc_remove_device);
Richard Zhaocbc6dc22012-07-07 22:56:41 +0800541
Peter Chen3f124d22013-08-14 12:44:07 +0300542static inline void ci_role_destroy(struct ci_hdrc *ci)
543{
544 ci_hdrc_gadget_destroy(ci);
545 ci_hdrc_host_destroy(ci);
Peter Chencbec6bd2013-08-14 12:44:10 +0300546 if (ci->is_otg)
547 ci_hdrc_otg_destroy(ci);
Peter Chen3f124d22013-08-14 12:44:07 +0300548}
549
Peter Chen577b2322013-08-14 12:44:08 +0300550static void ci_get_otg_capable(struct ci_hdrc *ci)
551{
552 if (ci->platdata->flags & CI_HDRC_DUAL_ROLE_NOT_OTG)
553 ci->is_otg = false;
554 else
555 ci->is_otg = (hw_read(ci, CAP_DCCPARAMS,
556 DCCPARAMS_DC | DCCPARAMS_HC)
557 == (DCCPARAMS_DC | DCCPARAMS_HC));
Peter Chenc344b512013-08-14 12:44:09 +0300558 if (ci->is_otg) {
Peter Chen577b2322013-08-14 12:44:08 +0300559 dev_dbg(ci->dev, "It is OTG capable controller\n");
Li Jun0c33bf72014-04-23 15:56:38 +0800560 /* Disable and clear all OTG irq */
561 hw_write_otgsc(ci, OTGSC_INT_EN_BITS | OTGSC_INT_STATUS_BITS,
562 OTGSC_INT_STATUS_BITS);
Peter Chenc344b512013-08-14 12:44:09 +0300563 }
Peter Chen577b2322013-08-14 12:44:08 +0300564}
565
Bill Pemberton41ac7b32012-11-19 13:21:48 -0500566static int ci_hdrc_probe(struct platform_device *pdev)
Alexander Shishkine443b332012-05-11 17:25:46 +0300567{
568 struct device *dev = &pdev->dev;
Alexander Shishkin8e229782013-06-24 14:46:36 +0300569 struct ci_hdrc *ci;
Alexander Shishkine443b332012-05-11 17:25:46 +0300570 struct resource *res;
571 void __iomem *base;
572 int ret;
Sascha Hauer691962d2013-06-13 17:59:57 +0300573 enum usb_dr_mode dr_mode;
Alexander Shishkine443b332012-05-11 17:25:46 +0300574
Jingoo Hanfad56742014-02-19 13:41:42 +0800575 if (!dev_get_platdata(dev)) {
Alexander Shishkine443b332012-05-11 17:25:46 +0300576 dev_err(dev, "platform data missing\n");
577 return -ENODEV;
578 }
579
580 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
Felipe Balbi19290812013-03-30 02:46:27 +0200581 base = devm_ioremap_resource(dev, res);
582 if (IS_ERR(base))
583 return PTR_ERR(base);
Alexander Shishkine443b332012-05-11 17:25:46 +0300584
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300585 ci = devm_kzalloc(dev, sizeof(*ci), GFP_KERNEL);
586 if (!ci) {
587 dev_err(dev, "can't allocate device\n");
588 return -ENOMEM;
Alexander Shishkine443b332012-05-11 17:25:46 +0300589 }
590
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300591 ci->dev = dev;
Jingoo Hanfad56742014-02-19 13:41:42 +0800592 ci->platdata = dev_get_platdata(dev);
Peter Chened8f8312014-01-10 13:51:27 +0800593 ci->imx28_write_fix = !!(ci->platdata->flags &
594 CI_HDRC_IMX28_WRITE_FIX);
Alexander Shishkine443b332012-05-11 17:25:46 +0300595
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300596 ret = hw_device_init(ci, base);
597 if (ret < 0) {
598 dev_err(dev, "can't initialize hardware\n");
599 return -ENODEV;
600 }
601
Peter Chenc859aa652014-02-19 13:41:40 +0800602 if (ci->platdata->phy)
603 ci->transceiver = ci->platdata->phy;
604 else
605 ci->transceiver = devm_usb_get_phy(dev, USB_PHY_TYPE_USB2);
606
607 if (IS_ERR(ci->transceiver)) {
608 ret = PTR_ERR(ci->transceiver);
609 /*
610 * if -ENXIO is returned, it means PHY layer wasn't
611 * enabled, so it makes no sense to return -EPROBE_DEFER
612 * in that case, since no PHY driver will ever probe.
613 */
614 if (ret == -ENXIO)
615 return ret;
616
617 dev_err(dev, "no usb2 phy configured\n");
618 return -EPROBE_DEFER;
619 }
620
Peter Chend03cccf2014-04-23 15:56:37 +0800621 ret = ci_usb_phy_init(ci);
Peter Chen74475ed2013-09-24 12:47:53 +0800622 if (ret) {
623 dev_err(dev, "unable to init phy: %d\n", ret);
624 return ret;
625 }
626
Alexander Shishkineb70e5a2012-05-11 17:25:54 +0300627 ci->hw_bank.phys = res->start;
628
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300629 ci->irq = platform_get_irq(pdev, 0);
630 if (ci->irq < 0) {
631 dev_err(dev, "missing IRQ\n");
Fabio Estevam42d18212014-02-19 13:41:44 +0800632 ret = ci->irq;
Peter Chenc859aa652014-02-19 13:41:40 +0800633 goto deinit_phy;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300634 }
635
Peter Chen577b2322013-08-14 12:44:08 +0300636 ci_get_otg_capable(ci);
637
Sascha Hauer691962d2013-06-13 17:59:57 +0300638 dr_mode = ci->platdata->dr_mode;
639 /* initialize role(s) before the interrupt is requested */
640 if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_HOST) {
641 ret = ci_hdrc_host_init(ci);
642 if (ret)
643 dev_info(dev, "doesn't support host\n");
644 }
645
646 if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_PERIPHERAL) {
647 ret = ci_hdrc_gadget_init(ci);
648 if (ret)
649 dev_info(dev, "doesn't support gadget\n");
650 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300651
652 if (!ci->roles[CI_ROLE_HOST] && !ci->roles[CI_ROLE_GADGET]) {
653 dev_err(dev, "no supported roles\n");
Peter Chen74475ed2013-09-24 12:47:53 +0800654 ret = -ENODEV;
Peter Chenc859aa652014-02-19 13:41:40 +0800655 goto deinit_phy;
Peter Chencbec6bd2013-08-14 12:44:10 +0300656 }
657
658 if (ci->is_otg) {
659 ret = ci_hdrc_otg_init(ci);
660 if (ret) {
661 dev_err(dev, "init otg fails, ret = %d\n", ret);
662 goto stop;
663 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300664 }
665
666 if (ci->roles[CI_ROLE_HOST] && ci->roles[CI_ROLE_GADGET]) {
Peter Chen577b2322013-08-14 12:44:08 +0300667 if (ci->is_otg) {
668 /*
669 * ID pin needs 1ms debouce time,
670 * we delay 2ms for safe.
671 */
672 mdelay(2);
673 ci->role = ci_otg_role(ci);
Li Jun0c33bf72014-04-23 15:56:38 +0800674 /* Enable ID change irq */
675 hw_write_otgsc(ci, OTGSC_IDIE, OTGSC_IDIE);
Peter Chen577b2322013-08-14 12:44:08 +0300676 } else {
677 /*
678 * If the controller is not OTG capable, but support
679 * role switch, the defalt role is gadget, and the
680 * user can switch it through debugfs.
681 */
682 ci->role = CI_ROLE_GADGET;
683 }
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300684 } else {
685 ci->role = ci->roles[CI_ROLE_HOST]
686 ? CI_ROLE_HOST
687 : CI_ROLE_GADGET;
688 }
689
Peter Chen5a1e1452013-12-05 15:20:50 +0800690 /* only update vbus status for peripheral */
691 if (ci->role == CI_ROLE_GADGET)
692 ci_handle_vbus_change(ci);
693
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300694 ret = ci_role_start(ci, ci->role);
695 if (ret) {
696 dev_err(dev, "can't start %s role\n", ci_role(ci)->name);
Peter Chencbec6bd2013-08-14 12:44:10 +0300697 goto stop;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300698 }
699
700 platform_set_drvdata(pdev, ci);
Richard Zhao77c44002012-06-29 17:48:53 +0800701 ret = request_irq(ci->irq, ci_irq, IRQF_SHARED, ci->platdata->name,
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300702 ci);
703 if (ret)
704 goto stop;
705
Alexander Shishkinadf0f732013-03-30 12:53:53 +0200706 ret = dbg_create_files(ci);
707 if (!ret)
708 return 0;
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300709
Alexander Shishkinadf0f732013-03-30 12:53:53 +0200710 free_irq(ci->irq, ci);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300711stop:
Peter Chen3f124d22013-08-14 12:44:07 +0300712 ci_role_destroy(ci);
Peter Chenc859aa652014-02-19 13:41:40 +0800713deinit_phy:
714 usb_phy_shutdown(ci->transceiver);
Alexander Shishkine443b332012-05-11 17:25:46 +0300715
716 return ret;
717}
718
Bill Pembertonfb4e98a2012-11-19 13:26:20 -0500719static int ci_hdrc_remove(struct platform_device *pdev)
Alexander Shishkine443b332012-05-11 17:25:46 +0300720{
Alexander Shishkin8e229782013-06-24 14:46:36 +0300721 struct ci_hdrc *ci = platform_get_drvdata(pdev);
Alexander Shishkine443b332012-05-11 17:25:46 +0300722
Alexander Shishkinadf0f732013-03-30 12:53:53 +0200723 dbg_remove_files(ci);
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300724 free_irq(ci->irq, ci);
Peter Chen3f124d22013-08-14 12:44:07 +0300725 ci_role_destroy(ci);
Peter Chen864cf942013-09-24 12:47:55 +0800726 ci_hdrc_enter_lpm(ci, true);
Peter Chenc859aa652014-02-19 13:41:40 +0800727 usb_phy_shutdown(ci->transceiver);
728 kfree(ci->hw_bank.regmap);
Alexander Shishkine443b332012-05-11 17:25:46 +0300729
730 return 0;
731}
732
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300733static struct platform_driver ci_hdrc_driver = {
734 .probe = ci_hdrc_probe,
Bill Pemberton76904172012-11-19 13:21:08 -0500735 .remove = ci_hdrc_remove,
Alexander Shishkine443b332012-05-11 17:25:46 +0300736 .driver = {
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300737 .name = "ci_hdrc",
Alexander Shishkine443b332012-05-11 17:25:46 +0300738 },
739};
740
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300741module_platform_driver(ci_hdrc_driver);
Alexander Shishkine443b332012-05-11 17:25:46 +0300742
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300743MODULE_ALIAS("platform:ci_hdrc");
Alexander Shishkine443b332012-05-11 17:25:46 +0300744MODULE_LICENSE("GPL v2");
745MODULE_AUTHOR("David Lopo <dlopo@chipidea.mips.com>");
Alexander Shishkin5f36e232012-05-11 17:25:47 +0300746MODULE_DESCRIPTION("ChipIdea HDRC Driver");