2 * EHCI HCD (Host Controller Driver) for USB.
4 * Bus Glue for Xilinx EHCI core on the of_platform bus
6 * Copyright (c) 2009 Xilinx, Inc.
8 * Based on "ehci-ppc-of.c" by Valentine Barshak <vbarshak@ru.mvista.com>
9 * and "ehci-ppc-soc.c" by Stefan Roese <sr@denx.de>
10 * and "ohci-ppc-of.c" by Sylvain Munaut <tnt@246tNt.com>
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version.
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software Foundation,
24 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #include <linux/err.h>
29 #include <linux/signal.h>
32 #include <linux/of_platform.h>
33 #include <linux/of_address.h>
36 * ehci_xilinx_port_handed_over - hand the port out if failed to enable it
37 * @hcd: Pointer to the usb_hcd device to which the host controller bound
38 * @portnum:Port number to which the device is attached.
40 * This function is used as a place to tell the user that the Xilinx USB host
41 * controller does support LS devices. And in an HS only configuration, it
42 * does not support FS devices either. It is hoped that this can help a
45 * There are cases when the host controller fails to enable the port due to,
46 * for example, insufficient power that can be supplied to the device from
47 * the USB bus. In those cases, the messages printed here are not helpful.
49 static int ehci_xilinx_port_handed_over(struct usb_hcd
*hcd
, int portnum
)
51 dev_warn(hcd
->self
.controller
, "port %d cannot be enabled\n", portnum
);
53 dev_warn(hcd
->self
.controller
,
54 "Maybe you have connected a low speed device?\n");
56 dev_warn(hcd
->self
.controller
,
57 "We do not support low speed devices\n");
59 dev_warn(hcd
->self
.controller
,
60 "Maybe your device is not a high speed device?\n");
61 dev_warn(hcd
->self
.controller
,
62 "The USB host controller does not support full speed "
63 "nor low speed devices\n");
64 dev_warn(hcd
->self
.controller
,
65 "You can reconfigure the host controller to have "
66 "full speed support\n");
73 static const struct hc_driver ehci_xilinx_of_hc_driver
= {
74 .description
= hcd_name
,
75 .product_desc
= "OF EHCI",
76 .hcd_priv_size
= sizeof(struct ehci_hcd
),
79 * generic hardware linkage
82 .flags
= HCD_MEMORY
| HCD_USB2
| HCD_BH
,
85 * basic lifecycle operations
90 .shutdown
= ehci_shutdown
,
93 * managing i/o requests and associated device resources
95 .urb_enqueue
= ehci_urb_enqueue
,
96 .urb_dequeue
= ehci_urb_dequeue
,
97 .endpoint_disable
= ehci_endpoint_disable
,
98 .endpoint_reset
= ehci_endpoint_reset
,
103 .get_frame_number
= ehci_get_frame
,
108 .hub_status_data
= ehci_hub_status_data
,
109 .hub_control
= ehci_hub_control
,
111 .bus_suspend
= ehci_bus_suspend
,
112 .bus_resume
= ehci_bus_resume
,
114 .relinquish_port
= NULL
,
115 .port_handed_over
= ehci_xilinx_port_handed_over
,
117 .clear_tt_buffer_complete
= ehci_clear_tt_buffer_complete
,
121 * ehci_hcd_xilinx_of_probe - Probe method for the USB host controller
122 * @op: pointer to the platform_device bound to the host controller
124 * This function requests resources and sets up appropriate properties for the
125 * host controller. Because the Xilinx USB host controller can be configured
126 * as HS only or HS/FS only, it checks the configuration in the device tree
127 * entry, and sets an appropriate value for hcd->has_tt.
129 static int ehci_hcd_xilinx_of_probe(struct platform_device
*op
)
131 struct device_node
*dn
= op
->dev
.of_node
;
133 struct ehci_hcd
*ehci
;
142 dev_dbg(&op
->dev
, "initializing XILINX-OF USB Controller\n");
144 rv
= of_address_to_resource(dn
, 0, &res
);
148 hcd
= usb_create_hcd(&ehci_xilinx_of_hc_driver
, &op
->dev
,
153 hcd
->rsrc_start
= res
.start
;
154 hcd
->rsrc_len
= resource_size(&res
);
156 irq
= irq_of_parse_and_map(dn
, 0);
158 dev_err(&op
->dev
, "%s: irq_of_parse_and_map failed\n",
164 hcd
->regs
= devm_ioremap_resource(&op
->dev
, &res
);
165 if (IS_ERR(hcd
->regs
)) {
166 rv
= PTR_ERR(hcd
->regs
);
170 ehci
= hcd_to_ehci(hcd
);
172 /* This core always has big-endian register interface and uses
173 * big-endian memory descriptors.
175 ehci
->big_endian_mmio
= 1;
176 ehci
->big_endian_desc
= 1;
178 /* Check whether the FS support option is selected in the hardware.
180 value
= (int *)of_get_property(dn
, "xlnx,support-usb-fs", NULL
);
181 if (value
&& (*value
== 1)) {
182 ehci_dbg(ehci
, "USB host controller supports FS devices\n");
186 "USB host controller is HS only\n");
190 /* Debug registers are at the first 0x100 region
192 ehci
->caps
= hcd
->regs
+ 0x100;
194 rv
= usb_add_hcd(hcd
, irq
, 0);
196 device_wakeup_enable(hcd
->self
.controller
);
207 * ehci_hcd_xilinx_of_remove - shutdown hcd and release resources
208 * @op: pointer to platform_device structure that is to be removed
210 * Remove the hcd structure, and release resources that has been requested
213 static int ehci_hcd_xilinx_of_remove(struct platform_device
*op
)
215 struct usb_hcd
*hcd
= platform_get_drvdata(op
);
217 dev_dbg(&op
->dev
, "stopping XILINX-OF USB Controller\n");
226 static const struct of_device_id ehci_hcd_xilinx_of_match
[] = {
227 {.compatible
= "xlnx,xps-usb-host-1.00.a",},
230 MODULE_DEVICE_TABLE(of
, ehci_hcd_xilinx_of_match
);
232 static struct platform_driver ehci_hcd_xilinx_of_driver
= {
233 .probe
= ehci_hcd_xilinx_of_probe
,
234 .remove
= ehci_hcd_xilinx_of_remove
,
235 .shutdown
= usb_hcd_platform_shutdown
,
237 .name
= "xilinx-of-ehci",
238 .owner
= THIS_MODULE
,
239 .of_match_table
= ehci_hcd_xilinx_of_match
,