5 * Copyright (C) 2005-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
27 * Targetted at different downstream endpoints
29 * Descriptor: use to config the remote pipe.
31 * The number of blocks could be dynamic (wBlocks in descriptor is
32 * 0)--need to schedule them then.
34 * Each bit in wa->rpipe_bm represents if an rpipe is being used or
35 * not. Rpipes are represented with a 'struct wa_rpipe' that is
36 * attached to the hcpriv member of a 'struct usb_host_endpoint'.
38 * When you need to xfer data to an endpoint, you get an rpipe for it
39 * with wa_ep_rpipe_get(), which gives you a reference to the rpipe
40 * and keeps a single one (the first one) with the endpoint. When you
41 * are done transferring, you drop that reference. At the end the
42 * rpipe is always allocated and bound to the endpoint. There it might
43 * be recycled when not used.
47 * We use a 1:1 mapping mechanism between port address (0 based
48 * index, actually) and the address. The USB stack knows about this.
50 * USB Stack port number 4 (1 based)
51 * WUSB code port index 3 (0 based)
52 * USB Addresss 5 (2 based -- 0 is for default, 1 for root hub)
54 * Now, because we don't use the concept as default address exactly
55 * like the (wired) USB code does, we need to kind of skip it. So we
56 * never take addresses from the urb->pipe, but from the
57 * urb->dev->devnum, to make sure that we always have the right
58 * destination address.
60 #include <linux/init.h>
61 #include <asm/atomic.h>
62 #include <linux/bitmap.h>
67 #include <linux/uwb/debug.h>
70 static int __rpipe_get_descr(struct wahc
*wa
,
71 struct usb_rpipe_descriptor
*descr
, u16 index
)
74 struct device
*dev
= &wa
->usb_iface
->dev
;
76 /* Get the RPIPE descriptor -- we cannot use the usb_get_descriptor()
77 * function because the arguments are different.
79 d_printf(1, dev
, "rpipe %u: get descr\n", index
);
80 result
= usb_control_msg(
81 wa
->usb_dev
, usb_rcvctrlpipe(wa
->usb_dev
, 0),
82 USB_REQ_GET_DESCRIPTOR
,
83 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_RPIPE
,
84 USB_DT_RPIPE
<<8, index
, descr
, sizeof(*descr
),
85 1000 /* FIXME: arbitrary */);
87 dev_err(dev
, "rpipe %u: get descriptor failed: %d\n",
91 if (result
< sizeof(*descr
)) {
92 dev_err(dev
, "rpipe %u: got short descriptor "
93 "(%zd vs %zd bytes needed)\n",
94 index
, result
, sizeof(*descr
));
106 * The descriptor is assumed to be properly initialized (ie: you got
107 * it through __rpipe_get_descr()).
109 static int __rpipe_set_descr(struct wahc
*wa
,
110 struct usb_rpipe_descriptor
*descr
, u16 index
)
113 struct device
*dev
= &wa
->usb_iface
->dev
;
115 /* we cannot use the usb_get_descriptor() function because the
116 * arguments are different.
118 d_printf(1, dev
, "rpipe %u: set descr\n", index
);
119 result
= usb_control_msg(
120 wa
->usb_dev
, usb_sndctrlpipe(wa
->usb_dev
, 0),
121 USB_REQ_SET_DESCRIPTOR
,
122 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_RPIPE
,
123 USB_DT_RPIPE
<<8, index
, descr
, sizeof(*descr
),
126 dev_err(dev
, "rpipe %u: set descriptor failed: %d\n",
130 if (result
< sizeof(*descr
)) {
131 dev_err(dev
, "rpipe %u: sent short descriptor "
132 "(%zd vs %zd bytes required)\n",
133 index
, result
, sizeof(*descr
));
144 static void rpipe_init(struct wa_rpipe
*rpipe
)
146 kref_init(&rpipe
->refcnt
);
147 spin_lock_init(&rpipe
->seg_lock
);
148 INIT_LIST_HEAD(&rpipe
->seg_list
);
151 static unsigned rpipe_get_idx(struct wahc
*wa
, unsigned rpipe_idx
)
155 spin_lock_irqsave(&wa
->rpipe_bm_lock
, flags
);
156 rpipe_idx
= find_next_zero_bit(wa
->rpipe_bm
, wa
->rpipes
, rpipe_idx
);
157 if (rpipe_idx
< wa
->rpipes
)
158 set_bit(rpipe_idx
, wa
->rpipe_bm
);
159 spin_unlock_irqrestore(&wa
->rpipe_bm_lock
, flags
);
164 static void rpipe_put_idx(struct wahc
*wa
, unsigned rpipe_idx
)
168 spin_lock_irqsave(&wa
->rpipe_bm_lock
, flags
);
169 clear_bit(rpipe_idx
, wa
->rpipe_bm
);
170 spin_unlock_irqrestore(&wa
->rpipe_bm_lock
, flags
);
173 void rpipe_destroy(struct kref
*_rpipe
)
175 struct wa_rpipe
*rpipe
= container_of(_rpipe
, struct wa_rpipe
, refcnt
);
176 u8 index
= le16_to_cpu(rpipe
->descr
.wRPipeIndex
);
177 d_fnstart(1, NULL
, "(rpipe %p %u)\n", rpipe
, index
);
179 rpipe
->ep
->hcpriv
= NULL
;
180 rpipe_put_idx(rpipe
->wa
, index
);
183 d_fnend(1, NULL
, "(rpipe %p %u)\n", rpipe
, index
);
185 EXPORT_SYMBOL_GPL(rpipe_destroy
);
188 * Locate an idle rpipe, create an structure for it and return it
190 * @wa is referenced and unlocked
191 * @crs enum rpipe_attr, required endpoint characteristics
193 * The rpipe can be used only sequentially (not in parallel).
195 * The rpipe is moved into the "ready" state.
197 static int rpipe_get_idle(struct wa_rpipe
**prpipe
, struct wahc
*wa
, u8 crs
,
202 struct wa_rpipe
*rpipe
;
203 struct device
*dev
= &wa
->usb_iface
->dev
;
205 d_fnstart(3, dev
, "(wa %p crs 0x%02x)\n", wa
, crs
);
206 rpipe
= kzalloc(sizeof(*rpipe
), gfp
);
211 /* Look for an idle pipe */
212 for (rpipe_idx
= 0; rpipe_idx
< wa
->rpipes
; rpipe_idx
++) {
213 rpipe_idx
= rpipe_get_idx(wa
, rpipe_idx
);
214 if (rpipe_idx
>= wa
->rpipes
) /* no more pipes :( */
216 result
= __rpipe_get_descr(wa
, &rpipe
->descr
, rpipe_idx
);
218 dev_err(dev
, "Can't get descriptor for rpipe %u: %d\n",
220 else if ((rpipe
->descr
.bmCharacteristics
& crs
) != 0)
222 rpipe_put_idx(wa
, rpipe_idx
);
226 d_fnend(3, dev
, "(wa %p crs 0x%02x) = -ENXIO\n", wa
, crs
);
230 set_bit(rpipe_idx
, wa
->rpipe_bm
);
231 rpipe
->wa
= wa_get(wa
);
233 d_fnstart(3, dev
, "(wa %p crs 0x%02x) = 0\n", wa
, crs
);
237 static int __rpipe_reset(struct wahc
*wa
, unsigned index
)
240 struct device
*dev
= &wa
->usb_iface
->dev
;
242 d_printf(1, dev
, "rpipe %u: reset\n", index
);
243 result
= usb_control_msg(
244 wa
->usb_dev
, usb_sndctrlpipe(wa
->usb_dev
, 0),
246 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_RPIPE
,
247 0, index
, NULL
, 0, 1000 /* FIXME: arbitrary */);
249 dev_err(dev
, "rpipe %u: reset failed: %d\n",
255 * Fake companion descriptor for ep0
257 * See WUSB1.0[7.4.4], most of this is zero for bulk/int/ctl
259 static struct usb_wireless_ep_comp_descriptor epc0
= {
260 .bLength
= sizeof(epc0
),
261 .bDescriptorType
= USB_DT_WIRELESS_ENDPOINT_COMP
,
262 /* .bMaxBurst = 1, */
267 * Look for EP companion descriptor
269 * Get there, look for Inara in the endpoint's extra descriptors
271 static struct usb_wireless_ep_comp_descriptor
*rpipe_epc_find(
272 struct device
*dev
, struct usb_host_endpoint
*ep
)
276 struct usb_descriptor_header
*hdr
;
277 struct usb_wireless_ep_comp_descriptor
*epcd
;
279 d_fnstart(3, dev
, "(ep %p)\n", ep
);
280 if (ep
->desc
.bEndpointAddress
== 0) {
285 itr_size
= ep
->extralen
;
287 while (itr_size
> 0) {
288 if (itr_size
< sizeof(*hdr
)) {
289 dev_err(dev
, "HW Bug? ep 0x%02x: extra descriptors "
290 "at offset %zu: only %zu bytes left\n",
291 ep
->desc
.bEndpointAddress
,
292 itr
- (void *) ep
->extra
, itr_size
);
296 if (hdr
->bDescriptorType
== USB_DT_WIRELESS_ENDPOINT_COMP
) {
300 if (hdr
->bLength
> itr_size
) {
301 dev_err(dev
, "HW Bug? ep 0x%02x: extra descriptor "
302 "at offset %zu (type 0x%02x) "
303 "length %d but only %zu bytes left\n",
304 ep
->desc
.bEndpointAddress
,
305 itr
- (void *) ep
->extra
, hdr
->bDescriptorType
,
306 hdr
->bLength
, itr_size
);
310 itr_size
-= hdr
->bDescriptorType
;
313 d_fnend(3, dev
, "(ep %p) = %p\n", ep
, epcd
);
318 * Aim an rpipe to its device & endpoint destination
320 * Make sure we change the address to unauthenticathed if the device
321 * is WUSB and it is not authenticated.
323 static int rpipe_aim(struct wa_rpipe
*rpipe
, struct wahc
*wa
,
324 struct usb_host_endpoint
*ep
, struct urb
*urb
, gfp_t gfp
)
326 int result
= -ENOMSG
; /* better code for lack of companion? */
327 struct device
*dev
= &wa
->usb_iface
->dev
;
328 struct usb_device
*usb_dev
= urb
->dev
;
329 struct usb_wireless_ep_comp_descriptor
*epcd
;
332 d_fnstart(3, dev
, "(rpipe %p wa %p ep %p, urb %p)\n",
334 epcd
= rpipe_epc_find(dev
, ep
);
336 dev_err(dev
, "ep 0x%02x: can't find companion descriptor\n",
337 ep
->desc
.bEndpointAddress
);
340 unauth
= usb_dev
->wusb
&& !usb_dev
->authenticated
? 0x80 : 0;
341 __rpipe_reset(wa
, le16_to_cpu(rpipe
->descr
.wRPipeIndex
));
342 atomic_set(&rpipe
->segs_available
, le16_to_cpu(rpipe
->descr
.wRequests
));
343 /* FIXME: block allocation system; request with queuing and timeout */
344 /* FIXME: compute so seg_size > ep->maxpktsize */
345 rpipe
->descr
.wBlocks
= cpu_to_le16(16); /* given */
346 /* ep0 maxpktsize is 0x200 (WUSB1.0[4.8.1]) */
347 rpipe
->descr
.wMaxPacketSize
= cpu_to_le16(ep
->desc
.wMaxPacketSize
);
348 rpipe
->descr
.bHSHubAddress
= 0; /* reserved: zero */
349 rpipe
->descr
.bHSHubPort
= wusb_port_no_to_idx(urb
->dev
->portnum
);
350 /* FIXME: use maximum speed as supported or recommended by device */
351 rpipe
->descr
.bSpeed
= usb_pipeendpoint(urb
->pipe
) == 0 ?
352 UWB_PHY_RATE_53
: UWB_PHY_RATE_200
;
353 d_printf(2, dev
, "addr %u (0x%02x) rpipe #%u ep# %u speed %d\n",
354 urb
->dev
->devnum
, urb
->dev
->devnum
| unauth
,
355 le16_to_cpu(rpipe
->descr
.wRPipeIndex
),
356 usb_pipeendpoint(urb
->pipe
), rpipe
->descr
.bSpeed
);
357 /* see security.c:wusb_update_address() */
358 if (unlikely(urb
->dev
->devnum
== 0x80))
359 rpipe
->descr
.bDeviceAddress
= 0;
361 rpipe
->descr
.bDeviceAddress
= urb
->dev
->devnum
| unauth
;
362 rpipe
->descr
.bEndpointAddress
= ep
->desc
.bEndpointAddress
;
363 /* FIXME: bDataSequence */
364 rpipe
->descr
.bDataSequence
= 0;
365 /* FIXME: dwCurrentWindow */
366 rpipe
->descr
.dwCurrentWindow
= cpu_to_le32(1);
367 /* FIXME: bMaxDataSequence */
368 rpipe
->descr
.bMaxDataSequence
= epcd
->bMaxSequence
- 1;
369 rpipe
->descr
.bInterval
= ep
->desc
.bInterval
;
370 /* FIXME: bOverTheAirInterval */
371 rpipe
->descr
.bOverTheAirInterval
= 0; /* 0 if not isoc */
372 /* FIXME: xmit power & preamble blah blah */
373 rpipe
->descr
.bmAttribute
= ep
->desc
.bmAttributes
& 0x03;
374 /* rpipe->descr.bmCharacteristics RO */
375 /* FIXME: bmRetryOptions */
376 rpipe
->descr
.bmRetryOptions
= 15;
377 /* FIXME: use for assessing link quality? */
378 rpipe
->descr
.wNumTransactionErrors
= 0;
379 result
= __rpipe_set_descr(wa
, &rpipe
->descr
,
380 le16_to_cpu(rpipe
->descr
.wRPipeIndex
));
382 dev_err(dev
, "Cannot aim rpipe: %d\n", result
);
387 d_fnend(3, dev
, "(rpipe %p wa %p ep %p urb %p) = %d\n",
388 rpipe
, wa
, ep
, urb
, result
);
393 * Check an aimed rpipe to make sure it points to where we want
395 * We use bit 19 of the Linux USB pipe bitmap for unauth vs auth
396 * space; when it is like that, we or 0x80 to make an unauth address.
398 static int rpipe_check_aim(const struct wa_rpipe
*rpipe
, const struct wahc
*wa
,
399 const struct usb_host_endpoint
*ep
,
400 const struct urb
*urb
, gfp_t gfp
)
402 int result
= 0; /* better code for lack of companion? */
403 struct device
*dev
= &wa
->usb_iface
->dev
;
404 struct usb_device
*usb_dev
= urb
->dev
;
405 u8 unauth
= (usb_dev
->wusb
&& !usb_dev
->authenticated
) ? 0x80 : 0;
406 u8 portnum
= wusb_port_no_to_idx(urb
->dev
->portnum
);
408 d_fnstart(3, dev
, "(rpipe %p wa %p ep %p, urb %p)\n",
410 #define AIM_CHECK(rdf, val, text) \
412 if (rpipe->descr.rdf != (val)) { \
414 "rpipe aim discrepancy: " #rdf " " text "\n", \
415 rpipe->descr.rdf, (val)); \
420 AIM_CHECK(wMaxPacketSize
, cpu_to_le16(ep
->desc
.wMaxPacketSize
),
422 AIM_CHECK(bHSHubPort
, portnum
, "(%u vs %u)");
423 AIM_CHECK(bSpeed
, usb_pipeendpoint(urb
->pipe
) == 0 ?
424 UWB_PHY_RATE_53
: UWB_PHY_RATE_200
,
426 AIM_CHECK(bDeviceAddress
, urb
->dev
->devnum
| unauth
, "(%u vs %u)");
427 AIM_CHECK(bEndpointAddress
, ep
->desc
.bEndpointAddress
, "(%u vs %u)");
428 AIM_CHECK(bInterval
, ep
->desc
.bInterval
, "(%u vs %u)");
429 AIM_CHECK(bmAttribute
, ep
->desc
.bmAttributes
& 0x03, "(%u vs %u)");
439 * Make sure there is an rpipe allocated for an endpoint
441 * If already allocated, we just refcount it; if not, we get an
442 * idle one, aim it to the right location and take it.
444 * Attaches to ep->hcpriv and rpipe->ep to ep.
446 int rpipe_get_by_ep(struct wahc
*wa
, struct usb_host_endpoint
*ep
,
447 struct urb
*urb
, gfp_t gfp
)
450 struct device
*dev
= &wa
->usb_iface
->dev
;
451 struct wa_rpipe
*rpipe
;
454 d_fnstart(3, dev
, "(wa %p ep %p urb %p gfp 0x%08x)\n", wa
, ep
, urb
,
456 mutex_lock(&wa
->rpipe_mutex
);
459 if (CONFIG_BUG
== 1) {
460 result
= rpipe_check_aim(rpipe
, wa
, ep
, urb
, gfp
);
465 d_printf(2, dev
, "ep 0x%02x: reusing rpipe %u\n",
466 ep
->desc
.bEndpointAddress
,
467 le16_to_cpu(rpipe
->descr
.wRPipeIndex
));
469 /* hmm, assign idle rpipe, aim it */
471 eptype
= ep
->desc
.bmAttributes
& 0x03;
472 result
= rpipe_get_idle(&rpipe
, wa
, 1 << eptype
, gfp
);
475 result
= rpipe_aim(rpipe
, wa
, ep
, urb
, gfp
);
482 __rpipe_get(rpipe
); /* for caching into ep->hcpriv */
483 d_printf(2, dev
, "ep 0x%02x: using rpipe %u\n",
484 ep
->desc
.bEndpointAddress
,
485 le16_to_cpu(rpipe
->descr
.wRPipeIndex
));
487 d_dump(4, dev
, &rpipe
->descr
, sizeof(rpipe
->descr
));
489 mutex_unlock(&wa
->rpipe_mutex
);
490 d_fnend(3, dev
, "(wa %p ep %p urb %p gfp 0x%08x)\n", wa
, ep
, urb
, gfp
);
495 * Allocate the bitmap for each rpipe.
497 int wa_rpipes_create(struct wahc
*wa
)
499 wa
->rpipes
= wa
->wa_descr
->wNumRPipes
;
500 wa
->rpipe_bm
= kzalloc(BITS_TO_LONGS(wa
->rpipes
)*sizeof(unsigned long),
502 if (wa
->rpipe_bm
== NULL
)
507 void wa_rpipes_destroy(struct wahc
*wa
)
509 struct device
*dev
= &wa
->usb_iface
->dev
;
510 d_fnstart(3, dev
, "(wa %p)\n", wa
);
511 if (!bitmap_empty(wa
->rpipe_bm
, wa
->rpipes
)) {
514 bitmap_scnprintf(buf
, sizeof(buf
), wa
->rpipe_bm
, wa
->rpipes
);
515 dev_err(dev
, "BUG: pipes not released on exit: %s\n", buf
);
518 d_fnend(3, dev
, "(wa %p)\n", wa
);
522 * Release resources allocated for an endpoint
524 * If there is an associated rpipe to this endpoint, Abort any pending
525 * transfers and put it. If the rpipe ends up being destroyed,
526 * __rpipe_destroy() will cleanup ep->hcpriv.
528 * This is called before calling hcd->stop(), so you don't need to do
529 * anything else in there.
531 void rpipe_ep_disable(struct wahc
*wa
, struct usb_host_endpoint
*ep
)
533 struct device
*dev
= &wa
->usb_iface
->dev
;
534 struct wa_rpipe
*rpipe
;
535 d_fnstart(2, dev
, "(wa %p ep %p)\n", wa
, ep
);
536 mutex_lock(&wa
->rpipe_mutex
);
539 unsigned rc
= atomic_read(&rpipe
->refcnt
.refcount
);
541 u16 index
= le16_to_cpu(rpipe
->descr
.wRPipeIndex
);
544 d_printf(1, dev
, "(wa %p ep %p) rpipe %p refcnt %u\n",
547 d_printf(1, dev
, "rpipe %u: abort\n", index
);
548 result
= usb_control_msg(
549 wa
->usb_dev
, usb_rcvctrlpipe(wa
->usb_dev
, 0),
551 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_RPIPE
,
552 0, index
, NULL
, 0, 1000 /* FIXME: arbitrary */);
553 if (result
< 0 && result
!= -ENODEV
/* dev is gone */)
554 d_printf(1, dev
, "(wa %p rpipe %u): abort failed: %d\n",
558 mutex_unlock(&wa
->rpipe_mutex
);
559 d_fnend(2, dev
, "(wa %p ep %p)\n", wa
, ep
);
562 EXPORT_SYMBOL_GPL(rpipe_ep_disable
);