usb: chipidea: use common definition for USBMODE bits
[linux-2.6-block.git] / drivers / usb / chipidea / core.c
CommitLineData
e443b333
AS
1/*
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
46 * - Isochronous & Interrupt Traffic
47 * - Handle requests which spawns into several TDs
48 * - GET_STATUS(device) - always reports 0
49 * - Gadget API (majority of optional features)
50 * - Suspend & Remote Wakeup
51 */
52#include <linux/delay.h>
53#include <linux/device.h>
54#include <linux/dmapool.h>
55#include <linux/dma-mapping.h>
56#include <linux/init.h>
57#include <linux/platform_device.h>
58#include <linux/module.h>
59#include <linux/interrupt.h>
60#include <linux/io.h>
61#include <linux/irq.h>
62#include <linux/kernel.h>
63#include <linux/slab.h>
64#include <linux/pm_runtime.h>
65#include <linux/usb/ch9.h>
66#include <linux/usb/gadget.h>
67#include <linux/usb/otg.h>
68#include <linux/usb/chipidea.h>
69
70#include "ci.h"
71#include "udc.h"
72#include "bits.h"
73#include "debug.h"
74
5f36e231 75/* Controller register map */
e443b333
AS
76static uintptr_t ci_regs_nolpm[] = {
77 [CAP_CAPLENGTH] = 0x000UL,
78 [CAP_HCCPARAMS] = 0x008UL,
79 [CAP_DCCPARAMS] = 0x024UL,
80 [CAP_TESTMODE] = 0x038UL,
81 [OP_USBCMD] = 0x000UL,
82 [OP_USBSTS] = 0x004UL,
83 [OP_USBINTR] = 0x008UL,
84 [OP_DEVICEADDR] = 0x014UL,
85 [OP_ENDPTLISTADDR] = 0x018UL,
86 [OP_PORTSC] = 0x044UL,
87 [OP_DEVLC] = 0x084UL,
5f36e231 88 [OP_OTGSC] = 0x064UL,
e443b333
AS
89 [OP_USBMODE] = 0x068UL,
90 [OP_ENDPTSETUPSTAT] = 0x06CUL,
91 [OP_ENDPTPRIME] = 0x070UL,
92 [OP_ENDPTFLUSH] = 0x074UL,
93 [OP_ENDPTSTAT] = 0x078UL,
94 [OP_ENDPTCOMPLETE] = 0x07CUL,
95 [OP_ENDPTCTRL] = 0x080UL,
96};
97
98static uintptr_t ci_regs_lpm[] = {
99 [CAP_CAPLENGTH] = 0x000UL,
100 [CAP_HCCPARAMS] = 0x008UL,
101 [CAP_DCCPARAMS] = 0x024UL,
102 [CAP_TESTMODE] = 0x0FCUL,
103 [OP_USBCMD] = 0x000UL,
104 [OP_USBSTS] = 0x004UL,
105 [OP_USBINTR] = 0x008UL,
106 [OP_DEVICEADDR] = 0x014UL,
107 [OP_ENDPTLISTADDR] = 0x018UL,
108 [OP_PORTSC] = 0x044UL,
109 [OP_DEVLC] = 0x084UL,
5f36e231 110 [OP_OTGSC] = 0x0C4UL,
e443b333
AS
111 [OP_USBMODE] = 0x0C8UL,
112 [OP_ENDPTSETUPSTAT] = 0x0D8UL,
113 [OP_ENDPTPRIME] = 0x0DCUL,
114 [OP_ENDPTFLUSH] = 0x0E0UL,
115 [OP_ENDPTSTAT] = 0x0E4UL,
116 [OP_ENDPTCOMPLETE] = 0x0E8UL,
117 [OP_ENDPTCTRL] = 0x0ECUL,
118};
119
5f36e231 120static int hw_alloc_regmap(struct ci13xxx *ci, bool is_lpm)
e443b333
AS
121{
122 int i;
123
5f36e231 124 kfree(ci->hw_bank.regmap);
e443b333 125
5f36e231
AS
126 ci->hw_bank.regmap = kzalloc((OP_LAST + 1) * sizeof(void *),
127 GFP_KERNEL);
128 if (!ci->hw_bank.regmap)
e443b333
AS
129 return -ENOMEM;
130
131 for (i = 0; i < OP_ENDPTCTRL; i++)
5f36e231
AS
132 ci->hw_bank.regmap[i] =
133 (i <= CAP_LAST ? ci->hw_bank.cap : ci->hw_bank.op) +
e443b333
AS
134 (is_lpm ? ci_regs_lpm[i] : ci_regs_nolpm[i]);
135
136 for (; i <= OP_LAST; i++)
5f36e231 137 ci->hw_bank.regmap[i] = ci->hw_bank.op +
e443b333
AS
138 4 * (i - OP_ENDPTCTRL) +
139 (is_lpm
140 ? ci_regs_lpm[OP_ENDPTCTRL]
141 : ci_regs_nolpm[OP_ENDPTCTRL]);
142
143 return 0;
144}
145
146/**
147 * hw_port_test_set: writes port test mode (execute without interruption)
148 * @mode: new value
149 *
150 * This function returns an error code
151 */
152int hw_port_test_set(struct ci13xxx *ci, u8 mode)
153{
154 const u8 TEST_MODE_MAX = 7;
155
156 if (mode > TEST_MODE_MAX)
157 return -EINVAL;
158
159 hw_write(ci, OP_PORTSC, PORTSC_PTC, mode << ffs_nr(PORTSC_PTC));
160 return 0;
161}
162
163/**
164 * hw_port_test_get: reads port test mode value
165 *
166 * This function returns port test mode value
167 */
168u8 hw_port_test_get(struct ci13xxx *ci)
169{
170 return hw_read(ci, OP_PORTSC, PORTSC_PTC) >> ffs_nr(PORTSC_PTC);
171}
172
5f36e231 173static int hw_device_init(struct ci13xxx *ci, void __iomem *base)
e443b333
AS
174{
175 u32 reg;
176
177 /* bank is a module variable */
5f36e231 178 ci->hw_bank.abs = base;
e443b333 179
5f36e231
AS
180 ci->hw_bank.cap = ci->hw_bank.abs;
181 ci->hw_bank.cap += ci->udc_driver->capoffset;
182 ci->hw_bank.op = ci->hw_bank.cap + ioread8(ci->hw_bank.cap);
e443b333 183
5f36e231
AS
184 hw_alloc_regmap(ci, false);
185 reg = hw_read(ci, CAP_HCCPARAMS, HCCPARAMS_LEN) >>
e443b333 186 ffs_nr(HCCPARAMS_LEN);
5f36e231
AS
187 ci->hw_bank.lpm = reg;
188 hw_alloc_regmap(ci, !!reg);
189 ci->hw_bank.size = ci->hw_bank.op - ci->hw_bank.abs;
190 ci->hw_bank.size += OP_LAST;
191 ci->hw_bank.size /= sizeof(u32);
e443b333 192
5f36e231 193 reg = hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DEN) >>
e443b333 194 ffs_nr(DCCPARAMS_DEN);
5f36e231 195 ci->hw_ep_max = reg * 2; /* cache hw ENDPT_MAX */
e443b333 196
5f36e231 197 if (ci->hw_ep_max == 0 || ci->hw_ep_max > ENDPT_MAX)
e443b333
AS
198 return -ENODEV;
199
5f36e231
AS
200 dev_dbg(ci->dev, "ChipIdea HDRC found, lpm: %d; cap: %p op: %p\n",
201 ci->hw_bank.lpm, ci->hw_bank.cap, ci->hw_bank.op);
e443b333
AS
202
203 /* setup lock mode ? */
204
205 /* ENDPTSETUPSTAT is '0' by default */
206
207 /* HCSPARAMS.bf.ppc SHOULD BE zero for device */
208
209 return 0;
210}
211
212/**
213 * hw_device_reset: resets chip (execute without interruption)
214 * @ci: the controller
215 *
216 * This function returns an error code
217 */
218int hw_device_reset(struct ci13xxx *ci)
219{
220 /* should flush & stop before reset */
221 hw_write(ci, OP_ENDPTFLUSH, ~0, ~0);
222 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
223
224 hw_write(ci, OP_USBCMD, USBCMD_RST, USBCMD_RST);
225 while (hw_read(ci, OP_USBCMD, USBCMD_RST))
226 udelay(10); /* not RTOS friendly */
227
228
229 if (ci->udc_driver->notify_event)
230 ci->udc_driver->notify_event(ci,
231 CI13XXX_CONTROLLER_RESET_EVENT);
232
233 if (ci->udc_driver->flags & CI13XXX_DISABLE_STREAMING)
758fc986 234 hw_write(ci, OP_USBMODE, USBMODE_CI_SDIS, USBMODE_CI_SDIS);
e443b333
AS
235
236 /* USBMODE should be configured step by step */
237 hw_write(ci, OP_USBMODE, USBMODE_CM, USBMODE_CM_IDLE);
758fc986 238 hw_write(ci, OP_USBMODE, USBMODE_CM, USBMODE_CM_DC);
e443b333
AS
239 /* HW >= 2.3 */
240 hw_write(ci, OP_USBMODE, USBMODE_SLOM, USBMODE_SLOM);
241
758fc986 242 if (hw_read(ci, OP_USBMODE, USBMODE_CM) != USBMODE_CM_DC) {
e443b333
AS
243 pr_err("cannot enter in device mode");
244 pr_err("lpm = %i", ci->hw_bank.lpm);
245 return -ENODEV;
246 }
247
248 return 0;
249}
250
5f36e231
AS
251/**
252 * ci_otg_role - pick role based on ID pin state
253 * @ci: the controller
254 */
255static enum ci_role ci_otg_role(struct ci13xxx *ci)
256{
257 u32 sts = hw_read(ci, OP_OTGSC, ~0);
258 enum ci_role role = sts & OTGSC_ID
259 ? CI_ROLE_GADGET
260 : CI_ROLE_HOST;
261
262 return role;
263}
264
265/**
266 * ci_role_work - perform role changing based on ID pin
267 * @work: work struct
268 */
269static void ci_role_work(struct work_struct *work)
270{
271 struct ci13xxx *ci = container_of(work, struct ci13xxx, work);
272 enum ci_role role = ci_otg_role(ci);
273
274 hw_write(ci, OP_OTGSC, OTGSC_IDIS, OTGSC_IDIS);
275
276 if (role != ci->role) {
277 dev_dbg(ci->dev, "switching from %s to %s\n",
278 ci_role(ci)->name, ci->roles[role]->name);
279
280 ci_role_stop(ci);
281 ci_role_start(ci, role);
282 }
283}
284
285static ssize_t show_role(struct device *dev, struct device_attribute *attr,
286 char *buf)
287{
288 struct ci13xxx *ci = dev_get_drvdata(dev);
289
290 return sprintf(buf, "%s\n", ci_role(ci)->name);
291}
292
293static ssize_t store_role(struct device *dev, struct device_attribute *attr,
294 const char *buf, size_t count)
295{
296 struct ci13xxx *ci = dev_get_drvdata(dev);
297 enum ci_role role;
298 int ret;
299
300 for (role = CI_ROLE_HOST; role < CI_ROLE_END; role++)
301 if (ci->roles[role] && !strcmp(buf, ci->roles[role]->name))
302 break;
303
304 if (role == CI_ROLE_END || role == ci->role)
305 return -EINVAL;
306
307 ci_role_stop(ci);
308 ret = ci_role_start(ci, role);
309 if (ret)
310 return ret;
311
312 return count;
313}
314
315static DEVICE_ATTR(role, S_IRUSR | S_IWUSR, show_role, store_role);
316
317static irqreturn_t ci_irq(int irq, void *data)
318{
319 struct ci13xxx *ci = data;
320 irqreturn_t ret = IRQ_NONE;
321
322 if (ci->is_otg) {
323 u32 sts = hw_read(ci, OP_OTGSC, ~0);
324
325 if (sts & OTGSC_IDIS) {
326 queue_work(ci->wq, &ci->work);
327 ret = IRQ_HANDLED;
328 }
329 }
330
331 return ci->role == CI_ROLE_END ? ret : ci_role(ci)->irq(ci);
332}
333
334static int __devinit ci_hdrc_probe(struct platform_device *pdev)
e443b333
AS
335{
336 struct device *dev = &pdev->dev;
5f36e231 337 struct ci13xxx *ci;
e443b333
AS
338 struct resource *res;
339 void __iomem *base;
340 int ret;
341
5f36e231 342 if (!dev->platform_data) {
e443b333
AS
343 dev_err(dev, "platform data missing\n");
344 return -ENODEV;
345 }
346
347 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
348 if (!res) {
349 dev_err(dev, "missing resource\n");
350 return -ENODEV;
351 }
352
353 base = devm_request_and_ioremap(dev, res);
354 if (!res) {
355 dev_err(dev, "can't request and ioremap resource\n");
356 return -ENOMEM;
357 }
358
5f36e231
AS
359 ci = devm_kzalloc(dev, sizeof(*ci), GFP_KERNEL);
360 if (!ci) {
361 dev_err(dev, "can't allocate device\n");
362 return -ENOMEM;
363 }
364
365 ci->dev = dev;
366 ci->udc_driver = dev->platform_data;
367
368 ret = hw_device_init(ci, base);
369 if (ret < 0) {
370 dev_err(dev, "can't initialize hardware\n");
371 return -ENODEV;
372 }
e443b333 373
5f36e231
AS
374 ci->irq = platform_get_irq(pdev, 0);
375 if (ci->irq < 0) {
e443b333 376 dev_err(dev, "missing IRQ\n");
5f36e231
AS
377 return -ENODEV;
378 }
379
380 INIT_WORK(&ci->work, ci_role_work);
381 ci->wq = create_singlethread_workqueue("ci_otg");
382 if (!ci->wq) {
383 dev_err(dev, "can't create workqueue\n");
384 return -ENODEV;
385 }
386
387 /* initialize role(s) before the interrupt is requested */
388 ret = ci_hdrc_gadget_init(ci);
389 if (ret)
390 dev_info(dev, "doesn't support gadget\n");
391
392 if (!ci->roles[CI_ROLE_HOST] && !ci->roles[CI_ROLE_GADGET]) {
393 dev_err(dev, "no supported roles\n");
394 ret = -ENODEV;
395 goto rm_wq;
396 }
397
398 if (ci->roles[CI_ROLE_HOST] && ci->roles[CI_ROLE_GADGET]) {
399 ci->is_otg = true;
400 ci->role = ci_otg_role(ci);
401 } else {
402 ci->role = ci->roles[CI_ROLE_HOST]
403 ? CI_ROLE_HOST
404 : CI_ROLE_GADGET;
405 }
406
407 ret = ci_role_start(ci, ci->role);
408 if (ret) {
409 dev_err(dev, "can't start %s role\n", ci_role(ci)->name);
e443b333 410 ret = -ENODEV;
5f36e231 411 goto rm_wq;
e443b333
AS
412 }
413
5f36e231
AS
414 platform_set_drvdata(pdev, ci);
415 ret = request_irq(ci->irq, ci_irq, IRQF_SHARED, ci->udc_driver->name,
416 ci);
417 if (ret)
418 goto stop;
e443b333 419
5f36e231 420 ret = device_create_file(dev, &dev_attr_role);
e443b333 421 if (ret)
5f36e231
AS
422 goto rm_attr;
423
424 if (ci->is_otg)
425 hw_write(ci, OP_OTGSC, OTGSC_IDIE, OTGSC_IDIE);
426
427 return ret;
428
429rm_attr:
430 device_remove_file(dev, &dev_attr_role);
431stop:
432 ci_role_stop(ci);
433rm_wq:
434 flush_workqueue(ci->wq);
435 destroy_workqueue(ci->wq);
e443b333
AS
436
437 return ret;
438}
439
5f36e231 440static int __devexit ci_hdrc_remove(struct platform_device *pdev)
e443b333 441{
5f36e231 442 struct ci13xxx *ci = platform_get_drvdata(pdev);
e443b333 443
5f36e231
AS
444 flush_workqueue(ci->wq);
445 destroy_workqueue(ci->wq);
446 device_remove_file(ci->dev, &dev_attr_role);
447 free_irq(ci->irq, ci);
448 ci_role_stop(ci);
e443b333
AS
449
450 return 0;
451}
452
5f36e231
AS
453static struct platform_driver ci_hdrc_driver = {
454 .probe = ci_hdrc_probe,
455 .remove = __devexit_p(ci_hdrc_remove),
e443b333 456 .driver = {
5f36e231 457 .name = "ci_hdrc",
e443b333
AS
458 },
459};
460
5f36e231 461module_platform_driver(ci_hdrc_driver);
e443b333 462
5f36e231 463MODULE_ALIAS("platform:ci_hdrc");
e443b333
AS
464MODULE_ALIAS("platform:ci13xxx");
465MODULE_LICENSE("GPL v2");
466MODULE_AUTHOR("David Lopo <dlopo@chipidea.mips.com>");
5f36e231 467MODULE_DESCRIPTION("ChipIdea HDRC Driver");