Loading...
1// SPDX-License-Identifier: GPL-1.0+
2/*
3 * OHCI HCD (Host Controller Driver) for USB.
4 *
5 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
6 * (C) Copyright 2000-2002 David Brownell <dbrownell@users.sourceforge.net>
7 * (C) Copyright 2002 Hewlett-Packard Company
8 *
9 * SA1111 Bus Glue
10 *
11 * Written by Christopher Hoover <ch@hpl.hp.com>
12 * Based on fragments of previous driver by Russell King et al.
13 *
14 * This file is licenced under the GPL.
15 */
16
17#include <asm/mach-types.h>
18#include <asm/hardware/sa1111.h>
19
20#ifndef CONFIG_SA1111
21#error "This file is SA-1111 bus glue. CONFIG_SA1111 must be defined."
22#endif
23
24#define USB_STATUS 0x0118
25#define USB_RESET 0x011c
26#define USB_IRQTEST 0x0120
27
28#define USB_RESET_FORCEIFRESET (1 << 0)
29#define USB_RESET_FORCEHCRESET (1 << 1)
30#define USB_RESET_CLKGENRESET (1 << 2)
31#define USB_RESET_SIMSCALEDOWN (1 << 3)
32#define USB_RESET_USBINTTEST (1 << 4)
33#define USB_RESET_SLEEPSTBYEN (1 << 5)
34#define USB_RESET_PWRSENSELOW (1 << 6)
35#define USB_RESET_PWRCTRLLOW (1 << 7)
36
37#define USB_STATUS_IRQHCIRMTWKUP (1 << 7)
38#define USB_STATUS_IRQHCIBUFFACC (1 << 8)
39#define USB_STATUS_NIRQHCIM (1 << 9)
40#define USB_STATUS_NHCIMFCLR (1 << 10)
41#define USB_STATUS_USBPWRSENSE (1 << 11)
42
43#if 0
44static void dump_hci_status(struct usb_hcd *hcd, const char *label)
45{
46 unsigned long status = readl_relaxed(hcd->regs + USB_STATUS);
47
48 printk(KERN_DEBUG "%s USB_STATUS = { %s%s%s%s%s}\n", label,
49 ((status & USB_STATUS_IRQHCIRMTWKUP) ? "IRQHCIRMTWKUP " : ""),
50 ((status & USB_STATUS_IRQHCIBUFFACC) ? "IRQHCIBUFFACC " : ""),
51 ((status & USB_STATUS_NIRQHCIM) ? "" : "IRQHCIM "),
52 ((status & USB_STATUS_NHCIMFCLR) ? "" : "HCIMFCLR "),
53 ((status & USB_STATUS_USBPWRSENSE) ? "USBPWRSENSE " : ""));
54}
55#endif
56
57static int ohci_sa1111_reset(struct usb_hcd *hcd)
58{
59 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
60
61 ohci_hcd_init(ohci);
62 return ohci_init(ohci);
63}
64
65static int ohci_sa1111_start(struct usb_hcd *hcd)
66{
67 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
68 int ret;
69
70 ret = ohci_run(ohci);
71 if (ret < 0) {
72 ohci_err(ohci, "can't start\n");
73 ohci_stop(hcd);
74 }
75 return ret;
76}
77
78static const struct hc_driver ohci_sa1111_hc_driver = {
79 .description = hcd_name,
80 .product_desc = "SA-1111 OHCI",
81 .hcd_priv_size = sizeof(struct ohci_hcd),
82
83 /*
84 * generic hardware linkage
85 */
86 .irq = ohci_irq,
87 .flags = HCD_USB11 | HCD_DMA | HCD_MEMORY,
88
89 /*
90 * basic lifecycle operations
91 */
92 .reset = ohci_sa1111_reset,
93 .start = ohci_sa1111_start,
94 .stop = ohci_stop,
95 .shutdown = ohci_shutdown,
96
97 /*
98 * managing i/o requests and associated device resources
99 */
100 .urb_enqueue = ohci_urb_enqueue,
101 .urb_dequeue = ohci_urb_dequeue,
102 .endpoint_disable = ohci_endpoint_disable,
103
104 /*
105 * scheduling support
106 */
107 .get_frame_number = ohci_get_frame,
108
109 /*
110 * root hub support
111 */
112 .hub_status_data = ohci_hub_status_data,
113 .hub_control = ohci_hub_control,
114#ifdef CONFIG_PM
115 .bus_suspend = ohci_bus_suspend,
116 .bus_resume = ohci_bus_resume,
117#endif
118 .start_port_reset = ohci_start_port_reset,
119};
120
121static int sa1111_start_hc(struct sa1111_dev *dev)
122{
123 unsigned int usb_rst = 0;
124 int ret;
125
126 dev_dbg(&dev->dev, "starting SA-1111 OHCI USB Controller\n");
127
128 if (machine_is_assabet())
129 usb_rst = USB_RESET_PWRSENSELOW | USB_RESET_PWRCTRLLOW;
130
131 /*
132 * Configure the power sense and control lines. Place the USB
133 * host controller in reset.
134 */
135 writel_relaxed(usb_rst | USB_RESET_FORCEIFRESET | USB_RESET_FORCEHCRESET,
136 dev->mapbase + USB_RESET);
137
138 /*
139 * Now, carefully enable the USB clock, and take
140 * the USB host controller out of reset.
141 */
142 ret = sa1111_enable_device(dev);
143 if (ret == 0) {
144 udelay(11);
145 writel_relaxed(usb_rst, dev->mapbase + USB_RESET);
146 }
147
148 return ret;
149}
150
151static void sa1111_stop_hc(struct sa1111_dev *dev)
152{
153 unsigned int usb_rst;
154
155 dev_dbg(&dev->dev, "stopping SA-1111 OHCI USB Controller\n");
156
157 /*
158 * Put the USB host controller into reset.
159 */
160 usb_rst = readl_relaxed(dev->mapbase + USB_RESET);
161 writel_relaxed(usb_rst | USB_RESET_FORCEIFRESET | USB_RESET_FORCEHCRESET,
162 dev->mapbase + USB_RESET);
163
164 /*
165 * Stop the USB clock.
166 */
167 sa1111_disable_device(dev);
168}
169
170/**
171 * ohci_hcd_sa1111_probe - initialize SA-1111-based HCDs
172 *
173 * Allocates basic resources for this USB host controller, and
174 * then invokes the start() method for the HCD associated with it.
175 */
176static int ohci_hcd_sa1111_probe(struct sa1111_dev *dev)
177{
178 struct usb_hcd *hcd;
179 int ret, irq;
180
181 if (usb_disabled())
182 return -ENODEV;
183
184 /*
185 * We don't call dma_set_mask_and_coherent() here because the
186 * DMA mask has already been appropraitely setup by the core
187 * SA-1111 bus code (which includes bug workarounds.)
188 */
189
190 hcd = usb_create_hcd(&ohci_sa1111_hc_driver, &dev->dev, "sa1111");
191 if (!hcd)
192 return -ENOMEM;
193
194 hcd->rsrc_start = dev->res.start;
195 hcd->rsrc_len = resource_size(&dev->res);
196
197 irq = sa1111_get_irq(dev, 1);
198 if (irq <= 0) {
199 ret = irq ? : -ENXIO;
200 goto err1;
201 }
202
203 /*
204 * According to the "Intel StrongARM SA-1111 Microprocessor Companion
205 * Chip Specification Update" (June 2000), erratum #7, there is a
206 * significant bug in the SA1111 SDRAM shared memory controller. If
207 * an access to a region of memory above 1MB relative to the bank base,
208 * it is important that address bit 10 _NOT_ be asserted. Depending
209 * on the configuration of the RAM, bit 10 may correspond to one
210 * of several different (processor-relative) address bits.
211 *
212 * Section 4.6 of the "Intel StrongARM SA-1111 Development Module
213 * User's Guide" mentions that jumpers R51 and R52 control the
214 * target of SA-1111 DMA (either SDRAM bank 0 on Assabet, or
215 * SDRAM bank 1 on Neponset). The default configuration selects
216 * Assabet, so any address in bank 1 is necessarily invalid.
217 *
218 * As a workaround, use a bounce buffer in addressable memory
219 * as local_mem, relying on ZONE_DMA to provide an area that
220 * fits within the above constraints.
221 *
222 * SZ_64K is an estimate for what size this might need.
223 */
224 ret = usb_hcd_setup_local_mem(hcd, 0, 0, SZ_64K);
225 if (ret)
226 goto err1;
227
228 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
229 dev_dbg(&dev->dev, "request_mem_region failed\n");
230 ret = -EBUSY;
231 goto err1;
232 }
233
234 hcd->regs = dev->mapbase;
235
236 ret = sa1111_start_hc(dev);
237 if (ret)
238 goto err2;
239
240 ret = usb_add_hcd(hcd, irq, 0);
241 if (ret == 0) {
242 device_wakeup_enable(hcd->self.controller);
243 return ret;
244 }
245
246 sa1111_stop_hc(dev);
247 err2:
248 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
249 err1:
250 usb_put_hcd(hcd);
251 return ret;
252}
253
254/**
255 * ohci_hcd_sa1111_remove - shutdown processing for SA-1111-based HCDs
256 * @dev: USB Host Controller being removed
257 *
258 * Reverses the effect of ohci_hcd_sa1111_probe(), first invoking
259 * the HCD's stop() method.
260 */
261static void ohci_hcd_sa1111_remove(struct sa1111_dev *dev)
262{
263 struct usb_hcd *hcd = sa1111_get_drvdata(dev);
264
265 usb_remove_hcd(hcd);
266 sa1111_stop_hc(dev);
267 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
268 usb_put_hcd(hcd);
269}
270
271static void ohci_hcd_sa1111_shutdown(struct device *_dev)
272{
273 struct sa1111_dev *dev = to_sa1111_device(_dev);
274 struct usb_hcd *hcd = sa1111_get_drvdata(dev);
275
276 if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)) {
277 hcd->driver->shutdown(hcd);
278 sa1111_stop_hc(dev);
279 }
280}
281
282static struct sa1111_driver ohci_hcd_sa1111_driver = {
283 .drv = {
284 .name = "sa1111-ohci",
285 .owner = THIS_MODULE,
286 .shutdown = ohci_hcd_sa1111_shutdown,
287 },
288 .devid = SA1111_DEVID_USB,
289 .probe = ohci_hcd_sa1111_probe,
290 .remove = ohci_hcd_sa1111_remove,
291};
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 * SA1111 Bus Glue
9 *
10 * Written by Christopher Hoover <ch@hpl.hp.com>
11 * Based on fragments of previous driver by Russell King et al.
12 *
13 * This file is licenced under the GPL.
14 */
15
16#include <mach/hardware.h>
17#include <asm/mach-types.h>
18#include <mach/assabet.h>
19#include <mach/badge4.h>
20#include <asm/hardware/sa1111.h>
21
22#ifndef CONFIG_SA1111
23#error "This file is SA-1111 bus glue. CONFIG_SA1111 must be defined."
24#endif
25
26extern int usb_disabled(void);
27
28/*-------------------------------------------------------------------------*/
29
30static void sa1111_start_hc(struct sa1111_dev *dev)
31{
32 unsigned int usb_rst = 0;
33
34 printk(KERN_DEBUG "%s: starting SA-1111 OHCI USB Controller\n",
35 __FILE__);
36
37#ifdef CONFIG_SA1100_BADGE4
38 if (machine_is_badge4()) {
39 badge4_set_5V(BADGE4_5V_USB, 1);
40 }
41#endif
42
43 if (machine_is_xp860() ||
44 machine_has_neponset() ||
45 machine_is_pfs168() ||
46 machine_is_badge4())
47 usb_rst = USB_RESET_PWRSENSELOW | USB_RESET_PWRCTRLLOW;
48
49 /*
50 * Configure the power sense and control lines. Place the USB
51 * host controller in reset.
52 */
53 sa1111_writel(usb_rst | USB_RESET_FORCEIFRESET | USB_RESET_FORCEHCRESET,
54 dev->mapbase + SA1111_USB_RESET);
55
56 /*
57 * Now, carefully enable the USB clock, and take
58 * the USB host controller out of reset.
59 */
60 sa1111_enable_device(dev);
61 udelay(11);
62 sa1111_writel(usb_rst, dev->mapbase + SA1111_USB_RESET);
63}
64
65static void sa1111_stop_hc(struct sa1111_dev *dev)
66{
67 unsigned int usb_rst;
68 printk(KERN_DEBUG "%s: stopping SA-1111 OHCI USB Controller\n",
69 __FILE__);
70
71 /*
72 * Put the USB host controller into reset.
73 */
74 usb_rst = sa1111_readl(dev->mapbase + SA1111_USB_RESET);
75 sa1111_writel(usb_rst | USB_RESET_FORCEIFRESET | USB_RESET_FORCEHCRESET,
76 dev->mapbase + SA1111_USB_RESET);
77
78 /*
79 * Stop the USB clock.
80 */
81 sa1111_disable_device(dev);
82
83#ifdef CONFIG_SA1100_BADGE4
84 if (machine_is_badge4()) {
85 /* Disable power to the USB bus */
86 badge4_set_5V(BADGE4_5V_USB, 0);
87 }
88#endif
89}
90
91
92/*-------------------------------------------------------------------------*/
93
94#if 0
95static void dump_hci_status(struct usb_hcd *hcd, const char *label)
96{
97 unsigned long status = sa1111_readl(hcd->regs + SA1111_USB_STATUS);
98
99 dbg ("%s USB_STATUS = { %s%s%s%s%s}", label,
100 ((status & USB_STATUS_IRQHCIRMTWKUP) ? "IRQHCIRMTWKUP " : ""),
101 ((status & USB_STATUS_IRQHCIBUFFACC) ? "IRQHCIBUFFACC " : ""),
102 ((status & USB_STATUS_NIRQHCIM) ? "" : "IRQHCIM "),
103 ((status & USB_STATUS_NHCIMFCLR) ? "" : "HCIMFCLR "),
104 ((status & USB_STATUS_USBPWRSENSE) ? "USBPWRSENSE " : ""));
105}
106#endif
107
108/*-------------------------------------------------------------------------*/
109
110/* configure so an HC device and id are always provided */
111/* always called with process context; sleeping is OK */
112
113
114/**
115 * usb_hcd_sa1111_probe - initialize SA-1111-based HCDs
116 * Context: !in_interrupt()
117 *
118 * Allocates basic resources for this USB host controller, and
119 * then invokes the start() method for the HCD associated with it
120 * through the hotplug entry's driver_data.
121 *
122 * Store this function in the HCD's struct pci_driver as probe().
123 */
124int usb_hcd_sa1111_probe (const struct hc_driver *driver,
125 struct sa1111_dev *dev)
126{
127 struct usb_hcd *hcd;
128 int retval;
129
130 hcd = usb_create_hcd (driver, &dev->dev, "sa1111");
131 if (!hcd)
132 return -ENOMEM;
133 hcd->rsrc_start = dev->res.start;
134 hcd->rsrc_len = resource_size(&dev->res);
135
136 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
137 dbg("request_mem_region failed");
138 retval = -EBUSY;
139 goto err1;
140 }
141 hcd->regs = dev->mapbase;
142
143 sa1111_start_hc(dev);
144 ohci_hcd_init(hcd_to_ohci(hcd));
145
146 retval = usb_add_hcd(hcd, dev->irq[1], IRQF_DISABLED);
147 if (retval == 0)
148 return retval;
149
150 sa1111_stop_hc(dev);
151 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
152 err1:
153 usb_put_hcd(hcd);
154 return retval;
155}
156
157
158/* may be called without controller electrically present */
159/* may be called with controller, bus, and devices active */
160
161/**
162 * usb_hcd_sa1111_remove - shutdown processing for SA-1111-based HCDs
163 * @dev: USB Host Controller being removed
164 * Context: !in_interrupt()
165 *
166 * Reverses the effect of usb_hcd_sa1111_probe(), first invoking
167 * the HCD's stop() method. It is always called from a thread
168 * context, normally "rmmod", "apmd", or something similar.
169 *
170 */
171void usb_hcd_sa1111_remove (struct usb_hcd *hcd, struct sa1111_dev *dev)
172{
173 usb_remove_hcd(hcd);
174 sa1111_stop_hc(dev);
175 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
176 usb_put_hcd(hcd);
177}
178
179/*-------------------------------------------------------------------------*/
180
181static int __devinit
182ohci_sa1111_start (struct usb_hcd *hcd)
183{
184 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
185 int ret;
186
187 if ((ret = ohci_init(ohci)) < 0)
188 return ret;
189
190 if ((ret = ohci_run (ohci)) < 0) {
191 err ("can't start %s", hcd->self.bus_name);
192 ohci_stop (hcd);
193 return ret;
194 }
195 return 0;
196}
197
198/*-------------------------------------------------------------------------*/
199
200static const struct hc_driver ohci_sa1111_hc_driver = {
201 .description = hcd_name,
202 .product_desc = "SA-1111 OHCI",
203 .hcd_priv_size = sizeof(struct ohci_hcd),
204
205 /*
206 * generic hardware linkage
207 */
208 .irq = ohci_irq,
209 .flags = HCD_USB11 | HCD_MEMORY,
210
211 /*
212 * basic lifecycle operations
213 */
214 .start = ohci_sa1111_start,
215 .stop = ohci_stop,
216
217 /*
218 * managing i/o requests and associated device resources
219 */
220 .urb_enqueue = ohci_urb_enqueue,
221 .urb_dequeue = ohci_urb_dequeue,
222 .endpoint_disable = ohci_endpoint_disable,
223
224 /*
225 * scheduling support
226 */
227 .get_frame_number = ohci_get_frame,
228
229 /*
230 * root hub support
231 */
232 .hub_status_data = ohci_hub_status_data,
233 .hub_control = ohci_hub_control,
234#ifdef CONFIG_PM
235 .bus_suspend = ohci_bus_suspend,
236 .bus_resume = ohci_bus_resume,
237#endif
238 .start_port_reset = ohci_start_port_reset,
239};
240
241/*-------------------------------------------------------------------------*/
242
243static int ohci_hcd_sa1111_drv_probe(struct sa1111_dev *dev)
244{
245 int ret;
246
247 if (usb_disabled())
248 return -ENODEV;
249
250 ret = usb_hcd_sa1111_probe(&ohci_sa1111_hc_driver, dev);
251 return ret;
252}
253
254static int ohci_hcd_sa1111_drv_remove(struct sa1111_dev *dev)
255{
256 struct usb_hcd *hcd = sa1111_get_drvdata(dev);
257
258 usb_hcd_sa1111_remove(hcd, dev);
259 return 0;
260}
261
262static struct sa1111_driver ohci_hcd_sa1111_driver = {
263 .drv = {
264 .name = "sa1111-ohci",
265 },
266 .devid = SA1111_DEVID_USB,
267 .probe = ohci_hcd_sa1111_drv_probe,
268 .remove = ohci_hcd_sa1111_drv_remove,
269};
270