2 * Wireless USB Host Controller
6 * Copyright (C) 2005-2006 Intel Corporation
7 * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License version
11 * 2 as published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 * We fake a root hub that has fake ports (as many as simultaneous
25 * devices the Wireless USB Host Controller can deal with). For each
26 * port we keep an state in @wusbhc->port[index] identical to the one
27 * specified in the USB2.0[ch11] spec and some extra device
28 * information that complements the one in 'struct usb_device' (as
29 * this lacs a hcpriv pointer).
31 * Note this is common to WHCI and HWA host controllers.
33 * Through here we enable most of the state changes that the USB stack
34 * will use to connect or disconnect devices. We need to do some
35 * forced adaptation of Wireless USB device states vs. wired:
39 * Port Powered-off port slot n/a
40 * Powered-on port slot available
41 * Disconnected port slot available
42 * Connected port slot assigned device
43 * device sent DN_Connect
44 * device was authenticated
45 * Enabled device is authenticated, transitioned
46 * from unauth -> auth -> default address
51 * This maps the standard USB port states with the WUSB device states
52 * so we can fake ports without having to modify the USB stack.
54 * FIXME: this process will change in the future
59 * Our entry points into here are, as in hcd.c, the USB stack root hub
60 * ops defined in the usb_hcd struct:
62 * wusbhc_rh_status_data() Provide hub and port status data bitmap
64 * wusbhc_rh_control() Execution of all the major requests
65 * you can do to a hub (Set|Clear
66 * features, get descriptors, status, etc).
68 * wusbhc_rh_[suspend|resume]() That
70 * wusbhc_rh_start_port_reset() ??? unimplemented
75 #include <linux/uwb/debug.h>
80 * This can be called to reset a port from any other state or to reset
81 * it when connecting. In Wireless USB they are different; when doing
82 * a new connect that involves going over the authentication. When
83 * just reseting, its a different story.
85 * The Linux USB stack resets a port twice before it considers it
86 * enabled, so we have to detect and ignore that.
88 * @wusbhc is assumed referenced and @wusbhc->mutex unlocked.
90 * Supposedly we are the only thread accesing @wusbhc->port; in any
91 * case, maybe we should move the mutex locking from
92 * wusbhc_devconnect_auth() to here.
94 * @port_idx refers to the wusbhc's port index, not the USB port number
96 static int wusbhc_rh_port_reset(struct wusbhc
*wusbhc
, u8 port_idx
)
99 struct wusb_port
*port
= wusb_port_by_idx(wusbhc
, port_idx
);
101 d_fnstart(3, wusbhc
->dev
, "(wusbhc %p port_idx %u)\n",
103 if (port
->reset_count
== 0) {
104 wusbhc_devconnect_auth(wusbhc
, port_idx
);
106 } else if (port
->reset_count
== 1)
108 d_printf(2, wusbhc
->dev
, "Ignoring second reset on port_idx "
111 result
= wusbhc_dev_reset(wusbhc
, port_idx
);
112 d_fnend(3, wusbhc
->dev
, "(wusbhc %p port_idx %u) = %d\n",
113 wusbhc
, port_idx
, result
);
118 * Return the hub change status bitmap
120 * The bits in the change status bitmap are cleared when a
121 * ClearPortFeature request is issued (USB2.0[11.12.3,11.12.4].
123 * @wusbhc is assumed referenced and @wusbhc->mutex unlocked.
125 * WARNING!! This gets called from atomic context; we cannot get the
126 * mutex--the only race condition we can find is some bit
127 * changing just after we copy it, which shouldn't be too
128 * big of a problem [and we can't make it an spinlock
129 * because other parts need to take it and sleep] .
131 * @usb_hcd is refcounted, so it won't dissapear under us
132 * and before killing a host, the polling of the root hub
133 * would be stopped anyway.
135 int wusbhc_rh_status_data(struct usb_hcd
*usb_hcd
, char *_buf
)
137 struct wusbhc
*wusbhc
= usb_hcd_to_wusbhc(usb_hcd
);
139 unsigned long *buf
= (unsigned long *) _buf
;
141 d_fnstart(1, wusbhc
->dev
, "(wusbhc %p)\n", wusbhc
);
142 /* WE DON'T LOCK, see comment */
143 size
= wusbhc
->ports_max
+ 1 /* hub bit */;
144 size
= (size
+ 8 - 1) / 8; /* round to bytes */
145 for (cnt
= 0; cnt
< wusbhc
->ports_max
; cnt
++)
146 if (wusb_port_by_idx(wusbhc
, cnt
)->change
)
147 set_bit(cnt
+ 1, buf
);
149 clear_bit(cnt
+ 1, buf
);
150 d_fnend(1, wusbhc
->dev
, "(wusbhc %p) %u, buffer:\n", wusbhc
, (int)size
);
151 d_dump(1, wusbhc
->dev
, _buf
, size
);
154 EXPORT_SYMBOL_GPL(wusbhc_rh_status_data
);
157 * Return the hub's desciptor
159 * NOTE: almost cut and paste from ehci-hub.c
161 * @wusbhc is assumed referenced and @wusbhc->mutex unlocked
163 static int wusbhc_rh_get_hub_descr(struct wusbhc
*wusbhc
, u16 wValue
,
165 struct usb_hub_descriptor
*descr
,
168 u16 temp
= 1 + (wusbhc
->ports_max
/ 8);
169 u8 length
= 7 + 2 * temp
;
171 if (wLength
< length
)
173 descr
->bDescLength
= 7 + 2 * temp
;
174 descr
->bDescriptorType
= 0x29; /* HUB type */
175 descr
->bNbrPorts
= wusbhc
->ports_max
;
176 descr
->wHubCharacteristics
= cpu_to_le16(
177 0x00 /* All ports power at once */
178 | 0x00 /* not part of compound device */
179 | 0x10 /* No overcurrent protection */
180 | 0x00 /* 8 FS think time FIXME ?? */
181 | 0x00); /* No port indicators */
182 descr
->bPwrOn2PwrGood
= 0;
183 descr
->bHubContrCurrent
= 0;
184 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
185 memset(&descr
->bitmap
[0], 0, temp
);
186 memset(&descr
->bitmap
[temp
], 0xff, temp
);
191 * Clear a hub feature
193 * @wusbhc is assumed referenced and @wusbhc->mutex unlocked.
195 * Nothing to do, so no locking needed ;)
197 static int wusbhc_rh_clear_hub_feat(struct wusbhc
*wusbhc
, u16 feature
)
200 struct device
*dev
= wusbhc
->dev
;
202 d_fnstart(4, dev
, "(%p, feature 0x%04u)\n", wusbhc
, feature
);
204 case C_HUB_LOCAL_POWER
:
205 /* FIXME: maybe plug bit 0 to the power input status,
207 * see wusbhc_rh_get_hub_status() */
208 case C_HUB_OVER_CURRENT
:
214 d_fnend(4, dev
, "(%p, feature 0x%04u), %d\n", wusbhc
, feature
, result
);
219 * Return hub status (it is always zero...)
221 * @wusbhc is assumed referenced and @wusbhc->mutex unlocked.
223 * Nothing to do, so no locking needed ;)
225 static int wusbhc_rh_get_hub_status(struct wusbhc
*wusbhc
, u32
*buf
,
228 /* FIXME: maybe plug bit 0 to the power input status (if any)? */
236 * @wusbhc is assumed referenced and @wusbhc->mutex unlocked.
238 static int wusbhc_rh_set_port_feat(struct wusbhc
*wusbhc
, u16 feature
,
239 u8 selector
, u8 port_idx
)
241 int result
= -EINVAL
;
242 struct device
*dev
= wusbhc
->dev
;
244 d_fnstart(4, dev
, "(feat 0x%04u, selector 0x%u, port_idx %d)\n",
245 feature
, selector
, port_idx
);
247 if (port_idx
> wusbhc
->ports_max
)
251 /* According to USB2.0[11.24.2.13]p2, these features
252 * are not required to be implemented. */
253 case USB_PORT_FEAT_C_OVER_CURRENT
:
254 case USB_PORT_FEAT_C_ENABLE
:
255 case USB_PORT_FEAT_C_SUSPEND
:
256 case USB_PORT_FEAT_C_CONNECTION
:
257 case USB_PORT_FEAT_C_RESET
:
261 case USB_PORT_FEAT_POWER
:
262 /* No such thing, but we fake it works */
263 mutex_lock(&wusbhc
->mutex
);
264 wusb_port_by_idx(wusbhc
, port_idx
)->status
|= USB_PORT_STAT_POWER
;
265 mutex_unlock(&wusbhc
->mutex
);
268 case USB_PORT_FEAT_RESET
:
269 result
= wusbhc_rh_port_reset(wusbhc
, port_idx
);
271 case USB_PORT_FEAT_ENABLE
:
272 case USB_PORT_FEAT_SUSPEND
:
273 dev_err(dev
, "(port_idx %d) set feat %d/%d UNIMPLEMENTED\n",
274 port_idx
, feature
, selector
);
278 dev_err(dev
, "(port_idx %d) set feat %d/%d UNKNOWN\n",
279 port_idx
, feature
, selector
);
284 d_fnend(4, dev
, "(feat 0x%04u, selector 0x%u, port_idx %d) = %d\n",
285 feature
, selector
, port_idx
, result
);
290 * Clear a port feature...
292 * @wusbhc is assumed referenced and @wusbhc->mutex unlocked.
294 static int wusbhc_rh_clear_port_feat(struct wusbhc
*wusbhc
, u16 feature
,
295 u8 selector
, u8 port_idx
)
297 int result
= -EINVAL
;
298 struct device
*dev
= wusbhc
->dev
;
300 d_fnstart(4, dev
, "(wusbhc %p feat 0x%04x selector %d port_idx %d)\n",
301 wusbhc
, feature
, selector
, port_idx
);
303 if (port_idx
> wusbhc
->ports_max
)
306 mutex_lock(&wusbhc
->mutex
);
309 case USB_PORT_FEAT_POWER
: /* fake port always on */
310 /* According to USB2.0[11.24.2.7.1.4], no need to implement? */
311 case USB_PORT_FEAT_C_OVER_CURRENT
:
313 case USB_PORT_FEAT_C_RESET
:
314 wusb_port_by_idx(wusbhc
, port_idx
)->change
&= ~USB_PORT_STAT_C_RESET
;
316 case USB_PORT_FEAT_C_CONNECTION
:
317 wusb_port_by_idx(wusbhc
, port_idx
)->change
&= ~USB_PORT_STAT_C_CONNECTION
;
319 case USB_PORT_FEAT_ENABLE
:
320 __wusbhc_dev_disable(wusbhc
, port_idx
);
322 case USB_PORT_FEAT_C_ENABLE
:
323 wusb_port_by_idx(wusbhc
, port_idx
)->change
&= ~USB_PORT_STAT_C_ENABLE
;
325 case USB_PORT_FEAT_SUSPEND
:
326 case USB_PORT_FEAT_C_SUSPEND
:
327 case 0xffff: /* ??? FIXME */
328 dev_err(dev
, "(port_idx %d) Clear feat %d/%d UNIMPLEMENTED\n",
329 port_idx
, feature
, selector
);
334 dev_err(dev
, "(port_idx %d) Clear feat %d/%d UNKNOWN\n",
335 port_idx
, feature
, selector
);
339 mutex_unlock(&wusbhc
->mutex
);
341 d_fnend(4, dev
, "(wusbhc %p feat 0x%04x selector %d port_idx %d) = "
342 "%d\n", wusbhc
, feature
, selector
, port_idx
, result
);
347 * Return the port's status
349 * @wusbhc is assumed referenced and @wusbhc->mutex unlocked.
351 static int wusbhc_rh_get_port_status(struct wusbhc
*wusbhc
, u16 port_idx
,
352 u32
*_buf
, u16 wLength
)
354 int result
= -EINVAL
;
355 u16
*buf
= (u16
*) _buf
;
357 d_fnstart(1, wusbhc
->dev
, "(wusbhc %p port_idx %u wLength %u)\n",
358 wusbhc
, port_idx
, wLength
);
359 if (port_idx
> wusbhc
->ports_max
)
361 mutex_lock(&wusbhc
->mutex
);
362 buf
[0] = cpu_to_le16(wusb_port_by_idx(wusbhc
, port_idx
)->status
);
363 buf
[1] = cpu_to_le16(wusb_port_by_idx(wusbhc
, port_idx
)->change
);
365 mutex_unlock(&wusbhc
->mutex
);
367 d_fnend(1, wusbhc
->dev
, "(wusbhc %p) = %d, buffer:\n", wusbhc
, result
);
368 d_dump(1, wusbhc
->dev
, _buf
, wLength
);
373 * Entry point for Root Hub operations
375 * @wusbhc is assumed referenced and @wusbhc->mutex unlocked.
377 int wusbhc_rh_control(struct usb_hcd
*usb_hcd
, u16 reqntype
, u16 wValue
,
378 u16 wIndex
, char *buf
, u16 wLength
)
380 int result
= -ENOSYS
;
381 struct wusbhc
*wusbhc
= usb_hcd_to_wusbhc(usb_hcd
);
384 case GetHubDescriptor
:
385 result
= wusbhc_rh_get_hub_descr(
386 wusbhc
, wValue
, wIndex
,
387 (struct usb_hub_descriptor
*) buf
, wLength
);
389 case ClearHubFeature
:
390 result
= wusbhc_rh_clear_hub_feat(wusbhc
, wValue
);
393 result
= wusbhc_rh_get_hub_status(wusbhc
, (u32
*)buf
, wLength
);
397 result
= wusbhc_rh_set_port_feat(wusbhc
, wValue
, wIndex
>> 8,
398 (wIndex
& 0xff) - 1);
400 case ClearPortFeature
:
401 result
= wusbhc_rh_clear_port_feat(wusbhc
, wValue
, wIndex
>> 8,
402 (wIndex
& 0xff) - 1);
405 result
= wusbhc_rh_get_port_status(wusbhc
, wIndex
- 1,
406 (u32
*)buf
, wLength
);
411 dev_err(wusbhc
->dev
, "%s (%p [%p], %x, %x, %x, %p, %x) "
412 "UNIMPLEMENTED\n", __func__
, usb_hcd
, wusbhc
, reqntype
,
413 wValue
, wIndex
, buf
, wLength
);
419 EXPORT_SYMBOL_GPL(wusbhc_rh_control
);
421 int wusbhc_rh_suspend(struct usb_hcd
*usb_hcd
)
423 struct wusbhc
*wusbhc
= usb_hcd_to_wusbhc(usb_hcd
);
424 dev_err(wusbhc
->dev
, "%s (%p [%p]) UNIMPLEMENTED\n", __func__
,
429 EXPORT_SYMBOL_GPL(wusbhc_rh_suspend
);
431 int wusbhc_rh_resume(struct usb_hcd
*usb_hcd
)
433 struct wusbhc
*wusbhc
= usb_hcd_to_wusbhc(usb_hcd
);
434 dev_err(wusbhc
->dev
, "%s (%p [%p]) UNIMPLEMENTED\n", __func__
,
439 EXPORT_SYMBOL_GPL(wusbhc_rh_resume
);
441 int wusbhc_rh_start_port_reset(struct usb_hcd
*usb_hcd
, unsigned port_idx
)
443 struct wusbhc
*wusbhc
= usb_hcd_to_wusbhc(usb_hcd
);
444 dev_err(wusbhc
->dev
, "%s (%p [%p], port_idx %u) UNIMPLEMENTED\n",
445 __func__
, usb_hcd
, wusbhc
, port_idx
);
449 EXPORT_SYMBOL_GPL(wusbhc_rh_start_port_reset
);
451 static void wusb_port_init(struct wusb_port
*port
)
453 port
->status
|= USB_PORT_STAT_HIGH_SPEED
;
457 * Alloc fake port specific fields and status.
459 int wusbhc_rh_create(struct wusbhc
*wusbhc
)
461 int result
= -ENOMEM
;
462 size_t port_size
, itr
;
463 port_size
= wusbhc
->ports_max
* sizeof(wusbhc
->port
[0]);
464 wusbhc
->port
= kzalloc(port_size
, GFP_KERNEL
);
465 if (wusbhc
->port
== NULL
)
466 goto error_port_alloc
;
467 for (itr
= 0; itr
< wusbhc
->ports_max
; itr
++)
468 wusb_port_init(&wusbhc
->port
[itr
]);
474 void wusbhc_rh_destroy(struct wusbhc
*wusbhc
)