2 * WUSB Wire Adapter: Control/Data Streaming Interface (WUSB[8])
3 * Device Connect handling
5 * Copyright (C) 2006 Intel Corporation
6 * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License version
10 * 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 * FIXME: this file needs to be broken up, it's grown too big
27 * WUSB1.0[7.1, 7.5.1, ]
29 * WUSB device connection is kind of messy. Some background:
31 * When a device wants to connect it scans the UWB radio channels
32 * looking for a WUSB Channel; a WUSB channel is defined by MMCs
33 * (Micro Managed Commands or something like that) [see
34 * Design-overview for more on this] .
36 * So, device scans the radio, finds MMCs and thus a host and checks
37 * when the next DNTS is. It sends a Device Notification Connect
38 * (DN_Connect); the host picks it up (through nep.c and notif.c, ends
39 * up in wusb_devconnect_ack(), which creates a wusb_dev structure in
40 * wusbhc->port[port_number].wusb_dev), assigns an unauth address
41 * to the device (this means from 0x80 to 0xfe) and sends, in the MMC
42 * a Connect Ack Information Element (ConnAck IE).
44 * So now the device now has a WUSB address. From now on, we use
45 * that to talk to it in the RPipes.
49 * - We use the the as device address the port number where it is
50 * connected (port 0 doesn't exist). For unauth, it is 128 + that.
54 * This file contains the logic for doing that--entry points:
56 * wusb_devconnect_ack() Ack a device until _acked() called.
57 * Called by notif.c:wusb_handle_dn_connect()
58 * when a DN_Connect is received.
60 * wusb_devconnect_acked() Ack done, release resources.
62 * wusb_handle_dn_alive() Called by notif.c:wusb_handle_dn()
63 * for processing a DN_Alive pong from a device.
65 * wusb_handle_dn_disconnect()Called by notif.c:wusb_handle_dn() to
66 * process a disconenct request from a
69 * __wusb_dev_disable() Called by rh.c:wusbhc_rh_clear_port_feat() when
72 * wusb_devconnect_create() Called when creating the host by
73 * lc.c:wusbhc_create().
75 * wusb_devconnect_destroy() Cleanup called removing the host. Called
76 * by lc.c:wusbhc_destroy().
78 * Each Wireless USB host maintains a list of DN_Connect requests
79 * (actually we maintain a list of pending Connect Acks, the
82 * LIFE CYCLE OF port->wusb_dev
84 * Before the @wusbhc structure put()s the reference it owns for
85 * port->wusb_dev [and clean the wusb_dev pointer], it needs to
86 * lock @wusbhc->mutex.
89 #include <linux/jiffies.h>
90 #include <linux/ctype.h>
91 #include <linux/workqueue.h>
94 static void wusbhc_devconnect_acked_work(struct work_struct
*work
);
96 static void wusb_dev_free(struct wusb_dev
*wusb_dev
)
99 kfree(wusb_dev
->set_gtk_req
);
100 usb_free_urb(wusb_dev
->set_gtk_urb
);
105 static struct wusb_dev
*wusb_dev_alloc(struct wusbhc
*wusbhc
)
107 struct wusb_dev
*wusb_dev
;
109 struct usb_ctrlrequest
*req
;
111 wusb_dev
= kzalloc(sizeof(*wusb_dev
), GFP_KERNEL
);
112 if (wusb_dev
== NULL
)
115 wusb_dev
->wusbhc
= wusbhc
;
117 INIT_WORK(&wusb_dev
->devconnect_acked_work
, wusbhc_devconnect_acked_work
);
119 urb
= usb_alloc_urb(0, GFP_KERNEL
);
122 wusb_dev
->set_gtk_urb
= urb
;
124 req
= kmalloc(sizeof(*req
), GFP_KERNEL
);
127 wusb_dev
->set_gtk_req
= req
;
129 req
->bRequestType
= USB_DIR_OUT
| USB_TYPE_STANDARD
| USB_RECIP_DEVICE
;
130 req
->bRequest
= USB_REQ_SET_DESCRIPTOR
;
131 req
->wValue
= cpu_to_le16(USB_DT_KEY
<< 8 | wusbhc
->gtk_index
);
133 req
->wLength
= cpu_to_le16(wusbhc
->gtk
.descr
.bLength
);
137 wusb_dev_free(wusb_dev
);
143 * Using the Connect-Ack list, fill out the @wusbhc Connect-Ack WUSB IE
144 * properly so that it can be added to the MMC.
146 * We just get the @wusbhc->ca_list and fill out the first four ones or
147 * less (per-spec WUSB1.0[7.5, before T7-38). If the ConnectAck WUSB
148 * IE is not allocated, we alloc it.
150 * @wusbhc->mutex must be taken
152 static void wusbhc_fill_cack_ie(struct wusbhc
*wusbhc
)
155 struct wusb_dev
*dev_itr
;
156 struct wuie_connect_ack
*cack_ie
;
158 cack_ie
= &wusbhc
->cack_ie
;
160 list_for_each_entry(dev_itr
, &wusbhc
->cack_list
, cack_node
) {
161 cack_ie
->blk
[cnt
].CDID
= dev_itr
->cdid
;
162 cack_ie
->blk
[cnt
].bDeviceAddress
= dev_itr
->addr
;
163 if (++cnt
>= WUIE_ELT_MAX
)
166 cack_ie
->hdr
.bLength
= sizeof(cack_ie
->hdr
)
167 + cnt
* sizeof(cack_ie
->blk
[0]);
171 * Register a new device that wants to connect
173 * A new device wants to connect, so we add it to the Connect-Ack
174 * list. We give it an address in the unauthorized range (bit 8 set);
175 * user space will have to drive authorization further on.
177 * @dev_addr: address to use for the device (which is also the port
180 * @wusbhc->mutex must be taken
182 static struct wusb_dev
*wusbhc_cack_add(struct wusbhc
*wusbhc
,
183 struct wusb_dn_connect
*dnc
,
184 const char *pr_cdid
, u8 port_idx
)
186 struct device
*dev
= wusbhc
->dev
;
187 struct wusb_dev
*wusb_dev
;
188 int new_connection
= wusb_dn_connect_new_connection(dnc
);
192 /* Is it registered already? */
193 list_for_each_entry(wusb_dev
, &wusbhc
->cack_list
, cack_node
)
194 if (!memcmp(&wusb_dev
->cdid
, &dnc
->CDID
,
195 sizeof(wusb_dev
->cdid
)))
197 /* We don't have it, create an entry, register it */
198 wusb_dev
= wusb_dev_alloc(wusbhc
);
199 if (wusb_dev
== NULL
)
201 wusb_dev_init(wusb_dev
);
202 wusb_dev
->cdid
= dnc
->CDID
;
203 wusb_dev
->port_idx
= port_idx
;
206 * Devices are always available within the cluster reservation
207 * and since the hardware will take the intersection of the
208 * per-device availability and the cluster reservation, the
209 * per-device availability can simply be set to always
212 bitmap_fill(wusb_dev
->availability
.bm
, UWB_NUM_MAS
);
214 /* FIXME: handle reconnects instead of assuming connects are
216 if (1 && new_connection
== 0)
218 if (new_connection
) {
219 dev_addr
= (port_idx
+ 2) | WUSB_DEV_ADDR_UNAUTH
;
221 dev_info(dev
, "Connecting new WUSB device to address %u, "
222 "port %u\n", dev_addr
, port_idx
);
224 result
= wusb_set_dev_addr(wusbhc
, wusb_dev
, dev_addr
);
228 wusb_dev
->entry_ts
= jiffies
;
229 list_add_tail(&wusb_dev
->cack_node
, &wusbhc
->cack_list
);
230 wusbhc
->cack_count
++;
231 wusbhc_fill_cack_ie(wusbhc
);
237 * Remove a Connect-Ack context entry from the HCs view
239 * @wusbhc->mutex must be taken
241 static void wusbhc_cack_rm(struct wusbhc
*wusbhc
, struct wusb_dev
*wusb_dev
)
243 list_del_init(&wusb_dev
->cack_node
);
244 wusbhc
->cack_count
--;
245 wusbhc_fill_cack_ie(wusbhc
);
249 * @wusbhc->mutex must be taken */
251 void wusbhc_devconnect_acked(struct wusbhc
*wusbhc
, struct wusb_dev
*wusb_dev
)
253 wusbhc_cack_rm(wusbhc
, wusb_dev
);
254 if (wusbhc
->cack_count
)
255 wusbhc_mmcie_set(wusbhc
, 0, 0, &wusbhc
->cack_ie
.hdr
);
257 wusbhc_mmcie_rm(wusbhc
, &wusbhc
->cack_ie
.hdr
);
260 static void wusbhc_devconnect_acked_work(struct work_struct
*work
)
262 struct wusb_dev
*wusb_dev
= container_of(work
, struct wusb_dev
,
263 devconnect_acked_work
);
264 struct wusbhc
*wusbhc
= wusb_dev
->wusbhc
;
266 mutex_lock(&wusbhc
->mutex
);
267 wusbhc_devconnect_acked(wusbhc
, wusb_dev
);
268 mutex_unlock(&wusbhc
->mutex
);
270 wusb_dev_put(wusb_dev
);
274 * Ack a device for connection
278 * @pr_cdid: Printable CDID...hex Use @dnc->cdid for the real deal.
280 * So we get the connect ack IE (may have been allocated already),
281 * find an empty connect block, an empty virtual port, create an
282 * address with it (see below), make it an unauth addr [bit 7 set] and
285 * Addresses: because WUSB hosts have no downstream hubs, we can do a
286 * 1:1 mapping between 'port number' and device
287 * address. This simplifies many things, as during this
288 * initial connect phase the USB stack has no knoledge of
289 * the device and hasn't assigned an address yet--we know
290 * USB's choose_address() will use the same euristics we
291 * use here, so we can assume which address will be assigned.
293 * USB stack always assigns address 1 to the root hub, so
294 * to the port number we add 2 (thus virtual port #0 is
297 * @wusbhc shall be referenced
300 void wusbhc_devconnect_ack(struct wusbhc
*wusbhc
, struct wusb_dn_connect
*dnc
,
304 struct device
*dev
= wusbhc
->dev
;
305 struct wusb_dev
*wusb_dev
;
306 struct wusb_port
*port
;
307 unsigned idx
, devnum
;
309 mutex_lock(&wusbhc
->mutex
);
311 /* Check we are not handling it already */
312 for (idx
= 0; idx
< wusbhc
->ports_max
; idx
++) {
313 port
= wusb_port_by_idx(wusbhc
, idx
);
315 && memcmp(&dnc
->CDID
, &port
->wusb_dev
->cdid
, sizeof(dnc
->CDID
)) == 0)
318 /* Look up those fake ports we have for a free one */
319 for (idx
= 0; idx
< wusbhc
->ports_max
; idx
++) {
320 port
= wusb_port_by_idx(wusbhc
, idx
);
321 if ((port
->status
& USB_PORT_STAT_POWER
)
322 && !(port
->status
& USB_PORT_STAT_CONNECTION
))
325 if (idx
>= wusbhc
->ports_max
) {
326 dev_err(dev
, "Host controller can't connect more devices "
327 "(%u already connected); device %s rejected\n",
328 wusbhc
->ports_max
, pr_cdid
);
329 /* NOTE: we could send a WUIE_Disconnect here, but we haven't
330 * event acked, so the device will eventually timeout the
331 * connection, right? */
337 /* Make sure we are using no crypto on that "virtual port" */
338 wusbhc
->set_ptk(wusbhc
, idx
, 0, NULL
, 0);
340 /* Grab a filled in Connect-Ack context, fill out the
341 * Connect-Ack Wireless USB IE, set the MMC */
342 wusb_dev
= wusbhc_cack_add(wusbhc
, dnc
, pr_cdid
, idx
);
343 if (wusb_dev
== NULL
)
345 result
= wusbhc_mmcie_set(wusbhc
, 0, 0, &wusbhc
->cack_ie
.hdr
);
348 /* Give the device at least 2ms (WUSB1.0[7.5.1p3]), let's do
349 * three for a good measure */
351 port
->wusb_dev
= wusb_dev
;
352 port
->status
|= USB_PORT_STAT_CONNECTION
;
353 port
->change
|= USB_PORT_STAT_C_CONNECTION
;
354 /* Now the port status changed to connected; khubd will
355 * pick the change up and try to reset the port to bring it to
356 * the enabled state--so this process returns up to the stack
357 * and it calls back into wusbhc_rh_port_reset().
360 mutex_unlock(&wusbhc
->mutex
);
366 * Disconnect a Wireless USB device from its fake port
368 * Marks the port as disconnected so that khubd can pick up the change
369 * and drops our knowledge about the device.
371 * Assumes there is a device connected
373 * @port_index: zero based port number
375 * NOTE: @wusbhc->mutex is locked
377 * WARNING: From here it is not very safe to access anything hanging off
380 static void __wusbhc_dev_disconnect(struct wusbhc
*wusbhc
,
381 struct wusb_port
*port
)
383 struct wusb_dev
*wusb_dev
= port
->wusb_dev
;
385 port
->status
&= ~(USB_PORT_STAT_CONNECTION
| USB_PORT_STAT_ENABLE
386 | USB_PORT_STAT_SUSPEND
| USB_PORT_STAT_RESET
387 | USB_PORT_STAT_LOW_SPEED
| USB_PORT_STAT_HIGH_SPEED
);
388 port
->change
|= USB_PORT_STAT_C_CONNECTION
| USB_PORT_STAT_C_ENABLE
;
390 dev_dbg(wusbhc
->dev
, "disconnecting device from port %d\n", wusb_dev
->port_idx
);
391 if (!list_empty(&wusb_dev
->cack_node
))
392 list_del_init(&wusb_dev
->cack_node
);
393 /* For the one in cack_add() */
394 wusb_dev_put(wusb_dev
);
396 port
->wusb_dev
= NULL
;
398 /* After a device disconnects, change the GTK (see [WUSB]
399 * section 6.2.11.2). */
401 wusbhc_gtk_rekey(wusbhc
);
403 /* The Wireless USB part has forgotten about the device already; now
404 * khubd's timer will pick up the disconnection and remove the USB
405 * device from the system
410 * Refresh the list of keep alives to emit in the MMC
412 * Some devices don't respond to keep alives unless they've been
413 * authenticated, so skip unauthenticated devices.
415 * We only publish the first four devices that have a coming timeout
416 * condition. Then when we are done processing those, we go for the
417 * next ones. We ignore the ones that have timed out already (they'll
420 * This might cause the first devices to timeout the last devices in
421 * the port array...FIXME: come up with a better algorithm?
423 * Note we can't do much about MMC's ops errors; we hope next refresh
424 * will kind of handle it.
426 * NOTE: @wusbhc->mutex is locked
428 static void __wusbhc_keep_alive(struct wusbhc
*wusbhc
)
430 struct device
*dev
= wusbhc
->dev
;
432 struct wusb_dev
*wusb_dev
;
433 struct wusb_port
*wusb_port
;
434 struct wuie_keep_alive
*ie
= &wusbhc
->keep_alive_ie
;
435 unsigned keep_alives
, old_keep_alives
;
437 old_keep_alives
= ie
->hdr
.bLength
- sizeof(ie
->hdr
);
440 keep_alives
<= WUIE_ELT_MAX
&& cnt
< wusbhc
->ports_max
;
442 unsigned tt
= msecs_to_jiffies(wusbhc
->trust_timeout
);
444 wusb_port
= wusb_port_by_idx(wusbhc
, cnt
);
445 wusb_dev
= wusb_port
->wusb_dev
;
447 if (wusb_dev
== NULL
)
449 if (wusb_dev
->usb_dev
== NULL
|| !wusb_dev
->usb_dev
->authenticated
)
452 if (time_after(jiffies
, wusb_dev
->entry_ts
+ tt
)) {
453 dev_err(dev
, "KEEPALIVE: device %u timed out\n",
455 __wusbhc_dev_disconnect(wusbhc
, wusb_port
);
456 } else if (time_after(jiffies
, wusb_dev
->entry_ts
+ tt
/2)) {
457 /* Approaching timeout cut out, need to refresh */
458 ie
->bDeviceAddress
[keep_alives
++] = wusb_dev
->addr
;
461 if (keep_alives
& 0x1) /* pad to even number ([WUSB] section 7.5.9) */
462 ie
->bDeviceAddress
[keep_alives
++] = 0x7f;
463 ie
->hdr
.bLength
= sizeof(ie
->hdr
) +
464 keep_alives
*sizeof(ie
->bDeviceAddress
[0]);
466 wusbhc_mmcie_set(wusbhc
, 10, 5, &ie
->hdr
);
467 else if (old_keep_alives
!= 0)
468 wusbhc_mmcie_rm(wusbhc
, &ie
->hdr
);
472 * Do a run through all devices checking for timeouts
474 static void wusbhc_keep_alive_run(struct work_struct
*ws
)
476 struct delayed_work
*dw
= to_delayed_work(ws
);
477 struct wusbhc
*wusbhc
= container_of(dw
, struct wusbhc
, keep_alive_timer
);
479 mutex_lock(&wusbhc
->mutex
);
480 __wusbhc_keep_alive(wusbhc
);
481 mutex_unlock(&wusbhc
->mutex
);
483 queue_delayed_work(wusbd
, &wusbhc
->keep_alive_timer
,
484 msecs_to_jiffies(wusbhc
->trust_timeout
/ 2));
488 * Find the wusb_dev from its device address.
490 * The device can be found directly from the address (see
491 * wusb_cack_add() for where the device address is set to port_idx
492 * +2), except when the address is zero.
494 static struct wusb_dev
*wusbhc_find_dev_by_addr(struct wusbhc
*wusbhc
, u8 addr
)
498 if (addr
== 0xff) /* unconnected */
502 int port
= (addr
& ~0x80) - 2;
503 if (port
< 0 || port
>= wusbhc
->ports_max
)
505 return wusb_port_by_idx(wusbhc
, port
)->wusb_dev
;
508 /* Look for the device with address 0. */
509 for (p
= 0; p
< wusbhc
->ports_max
; p
++) {
510 struct wusb_dev
*wusb_dev
= wusb_port_by_idx(wusbhc
, p
)->wusb_dev
;
511 if (wusb_dev
&& wusb_dev
->addr
== addr
)
518 * Handle a DN_Alive notification (WUSB1.0[7.6.1])
520 * This just updates the device activity timestamp and then refreshes
523 * @wusbhc shall be referenced and unlocked
525 static void wusbhc_handle_dn_alive(struct wusbhc
*wusbhc
, struct wusb_dev
*wusb_dev
)
527 mutex_lock(&wusbhc
->mutex
);
528 wusb_dev
->entry_ts
= jiffies
;
529 __wusbhc_keep_alive(wusbhc
);
530 mutex_unlock(&wusbhc
->mutex
);
534 * Handle a DN_Connect notification (WUSB1.0[7.6.1])
538 * @size: Size of the buffer where the notification resides; if the
539 * notification data suggests there should be more data than
540 * available, an error will be signaled and the whole buffer
543 * @wusbhc->mutex shall be held
545 static void wusbhc_handle_dn_connect(struct wusbhc
*wusbhc
,
546 struct wusb_dn_hdr
*dn_hdr
,
549 struct device
*dev
= wusbhc
->dev
;
550 struct wusb_dn_connect
*dnc
;
551 char pr_cdid
[WUSB_CKHDID_STRSIZE
];
552 static const char *beacon_behaviour
[] = {
559 if (size
< sizeof(*dnc
)) {
560 dev_err(dev
, "DN CONNECT: short notification (%zu < %zu)\n",
565 dnc
= container_of(dn_hdr
, struct wusb_dn_connect
, hdr
);
566 ckhdid_printf(pr_cdid
, sizeof(pr_cdid
), &dnc
->CDID
);
567 dev_info(dev
, "DN CONNECT: device %s @ %x (%s) wants to %s\n",
569 wusb_dn_connect_prev_dev_addr(dnc
),
570 beacon_behaviour
[wusb_dn_connect_beacon_behavior(dnc
)],
571 wusb_dn_connect_new_connection(dnc
) ? "connect" : "reconnect");
572 /* ACK the connect */
573 wusbhc_devconnect_ack(wusbhc
, dnc
, pr_cdid
);
577 * Handle a DN_Disconnect notification (WUSB1.0[7.6.1])
579 * Device is going down -- do the disconnect.
581 * @wusbhc shall be referenced and unlocked
583 static void wusbhc_handle_dn_disconnect(struct wusbhc
*wusbhc
, struct wusb_dev
*wusb_dev
)
585 struct device
*dev
= wusbhc
->dev
;
587 dev_info(dev
, "DN DISCONNECT: device 0x%02x going down\n", wusb_dev
->addr
);
589 mutex_lock(&wusbhc
->mutex
);
590 __wusbhc_dev_disconnect(wusbhc
, wusb_port_by_idx(wusbhc
, wusb_dev
->port_idx
));
591 mutex_unlock(&wusbhc
->mutex
);
595 * Handle a Device Notification coming a host
597 * The Device Notification comes from a host (HWA, DWA or WHCI)
598 * wrapped in a set of headers. Somebody else has peeled off those
599 * headers for us and we just get one Device Notifications.
601 * Invalid DNs (e.g., too short) are discarded.
603 * @wusbhc shall be referenced
606 * - implement priorities as in WUSB1.0[Table 7-55]?
608 void wusbhc_handle_dn(struct wusbhc
*wusbhc
, u8 srcaddr
,
609 struct wusb_dn_hdr
*dn_hdr
, size_t size
)
611 struct device
*dev
= wusbhc
->dev
;
612 struct wusb_dev
*wusb_dev
;
614 if (size
< sizeof(struct wusb_dn_hdr
)) {
615 dev_err(dev
, "DN data shorter than DN header (%d < %d)\n",
616 (int)size
, (int)sizeof(struct wusb_dn_hdr
));
620 wusb_dev
= wusbhc_find_dev_by_addr(wusbhc
, srcaddr
);
621 if (wusb_dev
== NULL
&& dn_hdr
->bType
!= WUSB_DN_CONNECT
) {
622 dev_dbg(dev
, "ignoring DN %d from unconnected device %02x\n",
623 dn_hdr
->bType
, srcaddr
);
627 switch (dn_hdr
->bType
) {
628 case WUSB_DN_CONNECT
:
629 wusbhc_handle_dn_connect(wusbhc
, dn_hdr
, size
);
632 wusbhc_handle_dn_alive(wusbhc
, wusb_dev
);
634 case WUSB_DN_DISCONNECT
:
635 wusbhc_handle_dn_disconnect(wusbhc
, wusb_dev
);
637 case WUSB_DN_MASAVAILCHANGED
:
640 /* FIXME: handle these DNs. */
643 /* The hardware handles these. */
646 dev_warn(dev
, "unknown DN %u (%d octets) from %u\n",
647 dn_hdr
->bType
, (int)size
, srcaddr
);
650 EXPORT_SYMBOL_GPL(wusbhc_handle_dn
);
653 * Disconnect a WUSB device from a the cluster
656 * @port Fake port where the device is (wusbhc index, not USB port number).
658 * In Wireless USB, a disconnect is basically telling the device he is
659 * being disconnected and forgetting about him.
661 * We send the device a Device Disconnect IE (WUSB1.0[7.5.11]) for 100
662 * ms and then keep going.
664 * We don't do much in case of error; we always pretend we disabled
665 * the port and disconnected the device. If physically the request
666 * didn't get there (many things can fail in the way there), the stack
667 * will reject the device's communication attempts.
669 * @wusbhc should be refcounted and locked
671 void __wusbhc_dev_disable(struct wusbhc
*wusbhc
, u8 port_idx
)
674 struct device
*dev
= wusbhc
->dev
;
675 struct wusb_dev
*wusb_dev
;
676 struct wuie_disconnect
*ie
;
678 wusb_dev
= wusb_port_by_idx(wusbhc
, port_idx
)->wusb_dev
;
679 if (wusb_dev
== NULL
) {
680 /* reset no device? ignore */
681 dev_dbg(dev
, "DISCONNECT: no device at port %u, ignoring\n",
685 __wusbhc_dev_disconnect(wusbhc
, wusb_port_by_idx(wusbhc
, port_idx
));
687 ie
= kzalloc(sizeof(*ie
), GFP_KERNEL
);
690 ie
->hdr
.bLength
= sizeof(*ie
);
691 ie
->hdr
.bIEIdentifier
= WUIE_ID_DEVICE_DISCONNECT
;
692 ie
->bDeviceAddress
= wusb_dev
->addr
;
693 result
= wusbhc_mmcie_set(wusbhc
, 0, 0, &ie
->hdr
);
695 dev_err(dev
, "DISCONNECT: can't set MMC: %d\n", result
);
697 /* At least 6 MMCs, assuming at least 1 MMC per zone. */
699 wusbhc_mmcie_rm(wusbhc
, &ie
->hdr
);
705 * Walk over the BOS descriptor, verify and grok it
707 * @usb_dev: referenced
708 * @wusb_dev: referenced and unlocked
710 * The BOS descriptor is defined at WUSB1.0[7.4.1], and it defines a
711 * "flexible" way to wrap all kinds of descriptors inside an standard
712 * descriptor (wonder why they didn't use normal descriptors,
713 * btw). Not like they lack code.
715 * At the end we go to look for the WUSB Device Capabilities
716 * (WUSB1.0[7.4.1.1]) that is wrapped in a device capability descriptor
717 * that is part of the BOS descriptor set. That tells us what does the
718 * device support (dual role, beacon type, UWB PHY rates).
720 static int wusb_dev_bos_grok(struct usb_device
*usb_dev
,
721 struct wusb_dev
*wusb_dev
,
722 struct usb_bos_descriptor
*bos
, size_t desc_size
)
725 struct device
*dev
= &usb_dev
->dev
;
728 /* Walk over BOS capabilities, verify them */
729 itr
= (void *)bos
+ sizeof(*bos
);
730 top
= itr
+ desc_size
- sizeof(*bos
);
732 struct usb_dev_cap_header
*cap_hdr
= itr
;
735 if (top
- itr
< sizeof(*cap_hdr
)) {
736 dev_err(dev
, "Device BUG? premature end of BOS header "
737 "data [offset 0x%02x]: only %zu bytes left\n",
738 (int)(itr
- (void *)bos
), top
- itr
);
742 cap_size
= cap_hdr
->bLength
;
743 cap_type
= cap_hdr
->bDevCapabilityType
;
746 if (cap_size
> top
- itr
) {
747 dev_err(dev
, "Device BUG? premature end of BOS data "
748 "[offset 0x%02x cap %02x %zu bytes]: "
749 "only %zu bytes left\n",
750 (int)(itr
- (void *)bos
),
751 cap_type
, cap_size
, top
- itr
);
756 case USB_CAP_TYPE_WIRELESS_USB
:
757 if (cap_size
!= sizeof(*wusb_dev
->wusb_cap_descr
))
758 dev_err(dev
, "Device BUG? WUSB Capability "
759 "descriptor is %zu bytes vs %zu "
760 "needed\n", cap_size
,
761 sizeof(*wusb_dev
->wusb_cap_descr
));
763 wusb_dev
->wusb_cap_descr
= itr
;
766 dev_err(dev
, "BUG? Unknown BOS capability 0x%02x "
767 "(%zu bytes) at offset 0x%02x\n", cap_type
,
768 cap_size
, (int)(itr
- (void *)bos
));
778 * Add information from the BOS descriptors to the device
780 * @usb_dev: referenced
781 * @wusb_dev: referenced and unlocked
783 * So what we do is we alloc a space for the BOS descriptor of 64
784 * bytes; read the first four bytes which include the wTotalLength
785 * field (WUSB1.0[T7-26]) and if it fits in those 64 bytes, read the
786 * whole thing. If not we realloc to that size.
788 * Then we call the groking function, that will fill up
789 * wusb_dev->wusb_cap_descr, which is what we'll need later on.
791 static int wusb_dev_bos_add(struct usb_device
*usb_dev
,
792 struct wusb_dev
*wusb_dev
)
795 struct device
*dev
= &usb_dev
->dev
;
796 struct usb_bos_descriptor
*bos
;
797 size_t alloc_size
= 32, desc_size
= 4;
799 bos
= kmalloc(alloc_size
, GFP_KERNEL
);
802 result
= usb_get_descriptor(usb_dev
, USB_DT_BOS
, 0, bos
, desc_size
);
804 dev_err(dev
, "Can't get BOS descriptor or too short: %zd\n",
806 goto error_get_descriptor
;
808 desc_size
= le16_to_cpu(bos
->wTotalLength
);
809 if (desc_size
>= alloc_size
) {
811 alloc_size
= desc_size
;
812 bos
= kmalloc(alloc_size
, GFP_KERNEL
);
816 result
= usb_get_descriptor(usb_dev
, USB_DT_BOS
, 0, bos
, desc_size
);
817 if (result
< 0 || result
!= desc_size
) {
818 dev_err(dev
, "Can't get BOS descriptor or too short (need "
819 "%zu bytes): %zd\n", desc_size
, result
);
820 goto error_get_descriptor
;
822 if (result
< sizeof(*bos
)
823 || le16_to_cpu(bos
->wTotalLength
) != desc_size
) {
824 dev_err(dev
, "Can't get BOS descriptor or too short (need "
825 "%zu bytes): %zd\n", desc_size
, result
);
826 goto error_get_descriptor
;
829 result
= wusb_dev_bos_grok(usb_dev
, wusb_dev
, bos
, result
);
836 error_get_descriptor
:
838 wusb_dev
->wusb_cap_descr
= NULL
;
842 static void wusb_dev_bos_rm(struct wusb_dev
*wusb_dev
)
844 kfree(wusb_dev
->bos
);
845 wusb_dev
->wusb_cap_descr
= NULL
;
848 static struct usb_wireless_cap_descriptor wusb_cap_descr_default
= {
849 .bLength
= sizeof(wusb_cap_descr_default
),
850 .bDescriptorType
= USB_DT_DEVICE_CAPABILITY
,
851 .bDevCapabilityType
= USB_CAP_TYPE_WIRELESS_USB
,
853 .bmAttributes
= USB_WIRELESS_BEACON_NONE
,
854 .wPHYRates
= cpu_to_le16(USB_WIRELESS_PHY_53
),
855 .bmTFITXPowerInfo
= 0,
856 .bmFFITXPowerInfo
= 0,
857 .bmBandGroup
= cpu_to_le16(0x0001), /* WUSB1.0[7.4.1] bottom */
862 * USB stack's device addition Notifier Callback
864 * Called from drivers/usb/core/hub.c when a new device is added; we
865 * use this hook to perform certain WUSB specific setup work on the
866 * new device. As well, it is the first time we can connect the
867 * wusb_dev and the usb_dev. So we note it down in wusb_dev and take a
868 * reference that we'll drop.
870 * First we need to determine if the device is a WUSB device (else we
871 * ignore it). For that we use the speed setting (USB_SPEED_VARIABLE)
872 * [FIXME: maybe we'd need something more definitive]. If so, we track
873 * it's usb_busd and from there, the WUSB HC.
875 * Because all WUSB HCs are contained in a 'struct wusbhc', voila, we
876 * get the wusbhc for the device.
878 * We have a reference on @usb_dev (as we are called at the end of its
881 * NOTE: @usb_dev locked
883 static void wusb_dev_add_ncb(struct usb_device
*usb_dev
)
886 struct wusb_dev
*wusb_dev
;
887 struct wusbhc
*wusbhc
;
888 struct device
*dev
= &usb_dev
->dev
;
891 if (usb_dev
->wusb
== 0 || usb_dev
->devnum
== 1)
892 return; /* skip non wusb and wusb RHs */
894 usb_set_device_state(usb_dev
, USB_STATE_UNAUTHENTICATED
);
896 wusbhc
= wusbhc_get_by_usb_dev(usb_dev
);
899 mutex_lock(&wusbhc
->mutex
);
900 wusb_dev
= __wusb_dev_get_by_usb_dev(wusbhc
, usb_dev
);
901 port_idx
= wusb_port_no_to_idx(usb_dev
->portnum
);
902 mutex_unlock(&wusbhc
->mutex
);
903 if (wusb_dev
== NULL
)
905 wusb_dev
->usb_dev
= usb_get_dev(usb_dev
);
906 usb_dev
->wusb_dev
= wusb_dev_get(wusb_dev
);
907 result
= wusb_dev_sec_add(wusbhc
, usb_dev
, wusb_dev
);
909 dev_err(dev
, "Cannot enable security: %d\n", result
);
912 /* Now query the device for it's BOS and attach it to wusb_dev */
913 result
= wusb_dev_bos_add(usb_dev
, wusb_dev
);
915 dev_err(dev
, "Cannot get BOS descriptors: %d\n", result
);
918 result
= wusb_dev_sysfs_add(wusbhc
, usb_dev
, wusb_dev
);
920 goto error_add_sysfs
;
922 wusb_dev_put(wusb_dev
);
927 wusb_dev_sysfs_rm(wusb_dev
);
929 wusb_dev_bos_rm(wusb_dev
);
931 wusb_dev_sec_rm(wusb_dev
);
933 mutex_lock(&wusbhc
->mutex
);
934 __wusbhc_dev_disconnect(wusbhc
, wusb_port_by_idx(wusbhc
, port_idx
));
935 mutex_unlock(&wusbhc
->mutex
);
940 * Undo all the steps done at connection by the notifier callback
942 * NOTE: @usb_dev locked
944 static void wusb_dev_rm_ncb(struct usb_device
*usb_dev
)
946 struct wusb_dev
*wusb_dev
= usb_dev
->wusb_dev
;
948 if (usb_dev
->wusb
== 0 || usb_dev
->devnum
== 1)
949 return; /* skip non wusb and wusb RHs */
951 wusb_dev_sysfs_rm(wusb_dev
);
952 wusb_dev_bos_rm(wusb_dev
);
953 wusb_dev_sec_rm(wusb_dev
);
954 wusb_dev
->usb_dev
= NULL
;
955 usb_dev
->wusb_dev
= NULL
;
956 wusb_dev_put(wusb_dev
);
957 usb_put_dev(usb_dev
);
961 * Handle notifications from the USB stack (notifier call back)
963 * This is called when the USB stack does a
964 * usb_{bus,device}_{add,remove}() so we can do WUSB specific
965 * handling. It is called with [for the case of
966 * USB_DEVICE_{ADD,REMOVE} with the usb_dev locked.
968 int wusb_usb_ncb(struct notifier_block
*nb
, unsigned long val
,
971 int result
= NOTIFY_OK
;
975 wusb_dev_add_ncb(priv
);
977 case USB_DEVICE_REMOVE
:
978 wusb_dev_rm_ncb(priv
);
981 /* ignore (for now) */
992 * Return a referenced wusb_dev given a @wusbhc and @usb_dev
994 struct wusb_dev
*__wusb_dev_get_by_usb_dev(struct wusbhc
*wusbhc
,
995 struct usb_device
*usb_dev
)
997 struct wusb_dev
*wusb_dev
;
1000 port_idx
= wusb_port_no_to_idx(usb_dev
->portnum
);
1001 BUG_ON(port_idx
> wusbhc
->ports_max
);
1002 wusb_dev
= wusb_port_by_idx(wusbhc
, port_idx
)->wusb_dev
;
1003 if (wusb_dev
!= NULL
) /* ops, device is gone */
1004 wusb_dev_get(wusb_dev
);
1007 EXPORT_SYMBOL_GPL(__wusb_dev_get_by_usb_dev
);
1009 void wusb_dev_destroy(struct kref
*_wusb_dev
)
1011 struct wusb_dev
*wusb_dev
= container_of(_wusb_dev
, struct wusb_dev
, refcnt
);
1013 list_del_init(&wusb_dev
->cack_node
);
1014 wusb_dev_free(wusb_dev
);
1016 EXPORT_SYMBOL_GPL(wusb_dev_destroy
);
1019 * Create all the device connect handling infrastructure
1021 * This is basically the device info array, Connect Acknowledgement
1022 * (cack) lists, keep-alive timers (and delayed work thread).
1024 int wusbhc_devconnect_create(struct wusbhc
*wusbhc
)
1026 wusbhc
->keep_alive_ie
.hdr
.bIEIdentifier
= WUIE_ID_KEEP_ALIVE
;
1027 wusbhc
->keep_alive_ie
.hdr
.bLength
= sizeof(wusbhc
->keep_alive_ie
.hdr
);
1028 INIT_DELAYED_WORK(&wusbhc
->keep_alive_timer
, wusbhc_keep_alive_run
);
1030 wusbhc
->cack_ie
.hdr
.bIEIdentifier
= WUIE_ID_CONNECTACK
;
1031 wusbhc
->cack_ie
.hdr
.bLength
= sizeof(wusbhc
->cack_ie
.hdr
);
1032 INIT_LIST_HEAD(&wusbhc
->cack_list
);
1038 * Release all resources taken by the devconnect stuff
1040 void wusbhc_devconnect_destroy(struct wusbhc
*wusbhc
)
1046 * wusbhc_devconnect_start - start accepting device connections
1047 * @wusbhc: the WUSB HC
1049 * Sets the Host Info IE to accept all new connections.
1051 * FIXME: This also enables the keep alives but this is not necessary
1052 * until there are connected and authenticated devices.
1054 int wusbhc_devconnect_start(struct wusbhc
*wusbhc
)
1056 struct device
*dev
= wusbhc
->dev
;
1057 struct wuie_host_info
*hi
;
1060 hi
= kzalloc(sizeof(*hi
), GFP_KERNEL
);
1064 hi
->hdr
.bLength
= sizeof(*hi
);
1065 hi
->hdr
.bIEIdentifier
= WUIE_ID_HOST_INFO
;
1066 hi
->attributes
= cpu_to_le16((wusbhc
->rsv
->stream
<< 3) | WUIE_HI_CAP_ALL
);
1067 hi
->CHID
= wusbhc
->chid
;
1068 result
= wusbhc_mmcie_set(wusbhc
, 0, 0, &hi
->hdr
);
1070 dev_err(dev
, "Cannot add Host Info MMCIE: %d\n", result
);
1071 goto error_mmcie_set
;
1073 wusbhc
->wuie_host_info
= hi
;
1075 queue_delayed_work(wusbd
, &wusbhc
->keep_alive_timer
,
1076 (wusbhc
->trust_timeout
*CONFIG_HZ
)/1000/2);
1086 * wusbhc_devconnect_stop - stop managing connected devices
1087 * @wusbhc: the WUSB HC
1089 * Disconnects any devices still connected, stops the keep alives and
1090 * removes the Host Info IE.
1092 void wusbhc_devconnect_stop(struct wusbhc
*wusbhc
)
1096 mutex_lock(&wusbhc
->mutex
);
1097 for (i
= 0; i
< wusbhc
->ports_max
; i
++) {
1098 if (wusbhc
->port
[i
].wusb_dev
)
1099 __wusbhc_dev_disconnect(wusbhc
, &wusbhc
->port
[i
]);
1101 mutex_unlock(&wusbhc
->mutex
);
1103 cancel_delayed_work_sync(&wusbhc
->keep_alive_timer
);
1104 wusbhc_mmcie_rm(wusbhc
, &wusbhc
->wuie_host_info
->hdr
);
1105 kfree(wusbhc
->wuie_host_info
);
1106 wusbhc
->wuie_host_info
= NULL
;
1110 * wusb_set_dev_addr - set the WUSB device address used by the host
1111 * @wusbhc: the WUSB HC the device is connect to
1112 * @wusb_dev: the WUSB device
1113 * @addr: new device address
1115 int wusb_set_dev_addr(struct wusbhc
*wusbhc
, struct wusb_dev
*wusb_dev
, u8 addr
)
1119 wusb_dev
->addr
= addr
;
1120 result
= wusbhc
->dev_info_set(wusbhc
, wusb_dev
);
1122 dev_err(wusbhc
->dev
, "device %d: failed to set device "
1123 "address\n", wusb_dev
->port_idx
);
1125 dev_info(wusbhc
->dev
, "device %d: %s addr %u\n",
1127 (addr
& WUSB_DEV_ADDR_UNAUTH
) ? "unauth" : "auth",