ohci-s3c2410.c revision 0ded36d91821620e4e8f50fb9e47440988e06366 
1/*
2 * OHCI HCD (Host Controller Driver) for USB.
3 *
4 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
5 * (C) Copyright 2000-2002 David Brownell <dbrownell@users.sourceforge.net>
6 * (C) Copyright 2002 Hewlett-Packard Company
7 *
8 * USB Bus Glue for Samsung S3C2410
9 *
10 * Written by Christopher Hoover <ch@hpl.hp.com>
11 * Based on fragments of previous driver by Russell King et al.
12 *
13 * Modified for S3C2410 from ohci-sa1111.c, ohci-omap.c and ohci-lh7a40.c
14 *	by Ben Dooks, <ben@simtec.co.uk>
15 *	Copyright (C) 2004 Simtec Electronics
16 *
17 * Thanks to basprog@mail.ru for updates to newer kernels
18 *
19 * This file is licenced under the GPL.
20*/
21
22#include <linux/clk.h>
23#include <linux/io.h>
24#include <linux/kernel.h>
25#include <linux/module.h>
26#include <linux/platform_device.h>
27#include <linux/platform_data/usb-ohci-s3c2410.h>
28#include <linux/usb.h>
29#include <linux/usb/hcd.h>
30
31#include "ohci.h"
32
33
34#define valid_port(idx) ((idx) == 1 || (idx) == 2)
35
36/* clock device associated with the hcd */
37
38
39#define DRIVER_DESC "OHCI S3C2410 driver"
40
41static const char hcd_name[] = "ohci-s3c2410";
42
43static struct clk *clk;
44static struct clk *usb_clk;
45
46/* forward definitions */
47
48static int (*orig_ohci_hub_control)(struct usb_hcd  *hcd, u16 typeReq,
49			u16 wValue, u16 wIndex, char *buf, u16 wLength);
50static int (*orig_ohci_hub_status_data)(struct usb_hcd *hcd, char *buf);
51
52static void s3c2410_hcd_oc(struct s3c2410_hcd_info *info, int port_oc);
53
54/* conversion functions */
55
56static struct s3c2410_hcd_info *to_s3c2410_info(struct usb_hcd *hcd)
57{
58	return dev_get_platdata(hcd->self.controller);
59}
60
61static void s3c2410_start_hc(struct platform_device *dev, struct usb_hcd *hcd)
62{
63	struct s3c2410_hcd_info *info = dev_get_platdata(&dev->dev);
64
65	dev_dbg(&dev->dev, "s3c2410_start_hc:\n");
66
67	clk_prepare_enable(usb_clk);
68	mdelay(2);			/* let the bus clock stabilise */
69
70	clk_prepare_enable(clk);
71
72	if (info != NULL) {
73		info->hcd	= hcd;
74		info->report_oc = s3c2410_hcd_oc;
75
76		if (info->enable_oc != NULL)
77			(info->enable_oc)(info, 1);
78	}
79}
80
81static void s3c2410_stop_hc(struct platform_device *dev)
82{
83	struct s3c2410_hcd_info *info = dev_get_platdata(&dev->dev);
84
85	dev_dbg(&dev->dev, "s3c2410_stop_hc:\n");
86
87	if (info != NULL) {
88		info->report_oc = NULL;
89		info->hcd	= NULL;
90
91		if (info->enable_oc != NULL)
92			(info->enable_oc)(info, 0);
93	}
94
95	clk_disable_unprepare(clk);
96	clk_disable_unprepare(usb_clk);
97}
98
99/* ohci_s3c2410_hub_status_data
100 *
101 * update the status data from the hub with anything that
102 * has been detected by our system
103*/
104
105static int
106ohci_s3c2410_hub_status_data(struct usb_hcd *hcd, char *buf)
107{
108	struct s3c2410_hcd_info *info = to_s3c2410_info(hcd);
109	struct s3c2410_hcd_port *port;
110	int orig;
111	int portno;
112
113	orig = orig_ohci_hub_status_data(hcd, buf);
114
115	if (info == NULL)
116		return orig;
117
118	port = &info->port[0];
119
120	/* mark any changed port as changed */
121
122	for (portno = 0; portno < 2; port++, portno++) {
123		if (port->oc_changed == 1 &&
124		    port->flags & S3C_HCDFLG_USED) {
125			dev_dbg(hcd->self.controller,
126				"oc change on port %d\n", portno);
127
128			if (orig < 1)
129				orig = 1;
130
131			buf[0] |= 1<<(portno+1);
132		}
133	}
134
135	return orig;
136}
137
138/* s3c2410_usb_set_power
139 *
140 * configure the power on a port, by calling the platform device
141 * routine registered with the platform device
142*/
143
144static void s3c2410_usb_set_power(struct s3c2410_hcd_info *info,
145				  int port, int to)
146{
147	if (info == NULL)
148		return;
149
150	if (info->power_control != NULL) {
151		info->port[port-1].power = to;
152		(info->power_control)(port-1, to);
153	}
154}
155
156/* ohci_s3c2410_hub_control
157 *
158 * look at control requests to the hub, and see if we need
159 * to take any action or over-ride the results from the
160 * request.
161*/
162
163static int ohci_s3c2410_hub_control(
164	struct usb_hcd	*hcd,
165	u16		typeReq,
166	u16		wValue,
167	u16		wIndex,
168	char		*buf,
169	u16		wLength)
170{
171	struct s3c2410_hcd_info *info = to_s3c2410_info(hcd);
172	struct usb_hub_descriptor *desc;
173	int ret = -EINVAL;
174	u32 *data = (u32 *)buf;
175
176	dev_dbg(hcd->self.controller,
177		"s3c2410_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
178		hcd, typeReq, wValue, wIndex, buf, wLength);
179
180	/* if we are only an humble host without any special capabilities
181	 * process the request straight away and exit */
182
183	if (info == NULL) {
184		ret = orig_ohci_hub_control(hcd, typeReq, wValue,
185				       wIndex, buf, wLength);
186		goto out;
187	}
188
189	/* check the request to see if it needs handling */
190
191	switch (typeReq) {
192	case SetPortFeature:
193		if (wValue == USB_PORT_FEAT_POWER) {
194			dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
195			s3c2410_usb_set_power(info, wIndex, 1);
196			goto out;
197		}
198		break;
199
200	case ClearPortFeature:
201		switch (wValue) {
202		case USB_PORT_FEAT_C_OVER_CURRENT:
203			dev_dbg(hcd->self.controller,
204				"ClearPortFeature: C_OVER_CURRENT\n");
205
206			if (valid_port(wIndex)) {
207				info->port[wIndex-1].oc_changed = 0;
208				info->port[wIndex-1].oc_status = 0;
209			}
210
211			goto out;
212
213		case USB_PORT_FEAT_OVER_CURRENT:
214			dev_dbg(hcd->self.controller,
215				"ClearPortFeature: OVER_CURRENT\n");
216
217			if (valid_port(wIndex))
218				info->port[wIndex-1].oc_status = 0;
219
220			goto out;
221
222		case USB_PORT_FEAT_POWER:
223			dev_dbg(hcd->self.controller,
224				"ClearPortFeature: POWER\n");
225
226			if (valid_port(wIndex)) {
227				s3c2410_usb_set_power(info, wIndex, 0);
228				return 0;
229			}
230		}
231		break;
232	}
233
234	ret = orig_ohci_hub_control(hcd, typeReq, wValue, wIndex, buf, wLength);
235	if (ret)
236		goto out;
237
238	switch (typeReq) {
239	case GetHubDescriptor:
240
241		/* update the hub's descriptor */
242
243		desc = (struct usb_hub_descriptor *)buf;
244
245		if (info->power_control == NULL)
246			return ret;
247
248		dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
249			desc->wHubCharacteristics);
250
251		/* remove the old configurations for power-switching, and
252		 * over-current protection, and insert our new configuration
253		 */
254
255		desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
256		desc->wHubCharacteristics |= cpu_to_le16(0x0001);
257
258		if (info->enable_oc) {
259			desc->wHubCharacteristics &= ~cpu_to_le16(
260				HUB_CHAR_OCPM);
261			desc->wHubCharacteristics |=  cpu_to_le16(
262				0x0008 |
263				0x0001);
264		}
265
266		dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
267			desc->wHubCharacteristics);
268
269		return ret;
270
271	case GetPortStatus:
272		/* check port status */
273
274		dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);
275
276		if (valid_port(wIndex)) {
277			if (info->port[wIndex-1].oc_changed)
278				*data |= cpu_to_le32(RH_PS_OCIC);
279
280			if (info->port[wIndex-1].oc_status)
281				*data |= cpu_to_le32(RH_PS_POCI);
282		}
283	}
284
285 out:
286	return ret;
287}
288
289/* s3c2410_hcd_oc
290 *
291 * handle an over-current report
292*/
293
294static void s3c2410_hcd_oc(struct s3c2410_hcd_info *info, int port_oc)
295{
296	struct s3c2410_hcd_port *port;
297	struct usb_hcd *hcd;
298	unsigned long flags;
299	int portno;
300
301	if (info == NULL)
302		return;
303
304	port = &info->port[0];
305	hcd = info->hcd;
306
307	local_irq_save(flags);
308
309	for (portno = 0; portno < 2; port++, portno++) {
310		if (port_oc & (1<<portno) &&
311		    port->flags & S3C_HCDFLG_USED) {
312			port->oc_status = 1;
313			port->oc_changed = 1;
314
315			/* ok, once over-current is detected,
316			   the port needs to be powered down */
317			s3c2410_usb_set_power(info, portno+1, 0);
318		}
319	}
320
321	local_irq_restore(flags);
322}
323
324/* may be called without controller electrically present */
325/* may be called with controller, bus, and devices active */
326
327/*
328 * usb_hcd_s3c2410_remove - shutdown processing for HCD
329 * @dev: USB Host Controller being removed
330 * Context: !in_interrupt()
331 *
332 * Reverses the effect of usb_hcd_3c2410_probe(), first invoking
333 * the HCD's stop() method.  It is always called from a thread
334 * context, normally "rmmod", "apmd", or something similar.
335 *
336*/
337
338static void
339usb_hcd_s3c2410_remove(struct usb_hcd *hcd, struct platform_device *dev)
340{
341	usb_remove_hcd(hcd);
342	s3c2410_stop_hc(dev);
343	usb_put_hcd(hcd);
344}
345
346/**
347 * usb_hcd_s3c2410_probe - initialize S3C2410-based HCDs
348 * Context: !in_interrupt()
349 *
350 * Allocates basic resources for this USB host controller, and
351 * then invokes the start() method for the HCD associated with it
352 * through the hotplug entry's driver_data.
353 *
354 */
355static int usb_hcd_s3c2410_probe(const struct hc_driver *driver,
356				  struct platform_device *dev)
357{
358	struct usb_hcd *hcd = NULL;
359	struct s3c2410_hcd_info *info = dev_get_platdata(&dev->dev);
360	int retval;
361
362	s3c2410_usb_set_power(info, 1, 1);
363	s3c2410_usb_set_power(info, 2, 1);
364
365	hcd = usb_create_hcd(driver, &dev->dev, "s3c24xx");
366	if (hcd == NULL)
367		return -ENOMEM;
368
369	hcd->rsrc_start = dev->resource[0].start;
370	hcd->rsrc_len	= resource_size(&dev->resource[0]);
371
372	hcd->regs = devm_ioremap_resource(&dev->dev, &dev->resource[0]);
373	if (IS_ERR(hcd->regs)) {
374		retval = PTR_ERR(hcd->regs);
375		goto err_put;
376	}
377
378	clk = devm_clk_get(&dev->dev, "usb-host");
379	if (IS_ERR(clk)) {
380		dev_err(&dev->dev, "cannot get usb-host clock\n");
381		retval = PTR_ERR(clk);
382		goto err_put;
383	}
384
385	usb_clk = devm_clk_get(&dev->dev, "usb-bus-host");
386	if (IS_ERR(usb_clk)) {
387		dev_err(&dev->dev, "cannot get usb-bus-host clock\n");
388		retval = PTR_ERR(usb_clk);
389		goto err_put;
390	}
391
392	s3c2410_start_hc(dev, hcd);
393
394	retval = usb_add_hcd(hcd, dev->resource[1].start, 0);
395	if (retval != 0)
396		goto err_ioremap;
397
398	return 0;
399
400 err_ioremap:
401	s3c2410_stop_hc(dev);
402
403 err_put:
404	usb_put_hcd(hcd);
405	return retval;
406}
407
408/*-------------------------------------------------------------------------*/
409
410static struct hc_driver __read_mostly ohci_s3c2410_hc_driver;
411
412static int ohci_hcd_s3c2410_drv_probe(struct platform_device *pdev)
413{
414	return usb_hcd_s3c2410_probe(&ohci_s3c2410_hc_driver, pdev);
415}
416
417static int ohci_hcd_s3c2410_drv_remove(struct platform_device *pdev)
418{
419	struct usb_hcd *hcd = platform_get_drvdata(pdev);
420
421	usb_hcd_s3c2410_remove(hcd, pdev);
422	return 0;
423}
424
425#ifdef CONFIG_PM
426static int ohci_hcd_s3c2410_drv_suspend(struct device *dev)
427{
428	struct usb_hcd *hcd = dev_get_drvdata(dev);
429	struct platform_device *pdev = to_platform_device(dev);
430	bool do_wakeup = device_may_wakeup(dev);
431	int rc = 0;
432
433	rc = ohci_suspend(hcd, do_wakeup);
434	if (rc)
435		return rc;
436
437	s3c2410_stop_hc(pdev);
438
439	return rc;
440}
441
442static int ohci_hcd_s3c2410_drv_resume(struct device *dev)
443{
444	struct usb_hcd *hcd = dev_get_drvdata(dev);
445	struct platform_device *pdev = to_platform_device(dev);
446
447	s3c2410_start_hc(pdev, hcd);
448
449	ohci_resume(hcd, false);
450
451	return 0;
452}
453#else
454#define ohci_hcd_s3c2410_drv_suspend	NULL
455#define ohci_hcd_s3c2410_drv_resume	NULL
456#endif
457
458static const struct dev_pm_ops ohci_hcd_s3c2410_pm_ops = {
459	.suspend	= ohci_hcd_s3c2410_drv_suspend,
460	.resume		= ohci_hcd_s3c2410_drv_resume,
461};
462
463static struct platform_driver ohci_hcd_s3c2410_driver = {
464	.probe		= ohci_hcd_s3c2410_drv_probe,
465	.remove		= ohci_hcd_s3c2410_drv_remove,
466	.shutdown	= usb_hcd_platform_shutdown,
467	.driver		= {
468		.owner	= THIS_MODULE,
469		.name	= "s3c2410-ohci",
470		.pm	= &ohci_hcd_s3c2410_pm_ops,
471	},
472};
473
474static int __init ohci_s3c2410_init(void)
475{
476	if (usb_disabled())
477		return -ENODEV;
478
479	pr_info("%s: " DRIVER_DESC "\n", hcd_name);
480	ohci_init_driver(&ohci_s3c2410_hc_driver, NULL);
481
482	/*
483	 * The Samsung HW has some unusual quirks, which require
484	 * Sumsung-specific workarounds. We override certain hc_driver
485	 * functions here to achieve that. We explicitly do not enhance
486	 * ohci_driver_overrides to allow this more easily, since this
487	 * is an unusual case, and we don't want to encourage others to
488	 * override these functions by making it too easy.
489	 */
490
491	orig_ohci_hub_control = ohci_s3c2410_hc_driver.hub_control;
492	orig_ohci_hub_status_data = ohci_s3c2410_hc_driver.hub_status_data;
493
494	ohci_s3c2410_hc_driver.hub_status_data	= ohci_s3c2410_hub_status_data;
495	ohci_s3c2410_hc_driver.hub_control	= ohci_s3c2410_hub_control;
496
497	return platform_driver_register(&ohci_hcd_s3c2410_driver);
498}
499module_init(ohci_s3c2410_init);
500
501static void __exit ohci_s3c2410_cleanup(void)
502{
503	platform_driver_unregister(&ohci_hcd_s3c2410_driver);
504}
505module_exit(ohci_s3c2410_cleanup);
506
507MODULE_DESCRIPTION(DRIVER_DESC);
508MODULE_LICENSE("GPL");
509MODULE_ALIAS("platform:s3c2410-ohci");
510