?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
kernel: Remove unused *.h files from SRCS in kernel module Makefiles. (2)
[dragonfly.git] / sys / bus / u4b / usb_device.c
bloba6c9fbe316ba4bb38e984136f6884e81df7efbf5
1 /* $FreeBSD: head/sys/dev/usb/usb_device.c 269566 2014-08-05 06:38:21Z hselasky $ */
2 /*-
3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27 #include <sys/stdint.h>
28 #include <sys/param.h>
29 #include <sys/queue.h>
30 #include <sys/types.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/bus.h>
34 #include <sys/module.h>
35 #include <sys/lock.h>
36 #include <sys/mutex.h>
37 #include <sys/condvar.h>
38 #include <sys/sysctl.h>
39 #include <sys/unistd.h>
40 #include <sys/callout.h>
41 #include <sys/malloc.h>
42 #include <sys/priv.h>
43 #include <sys/conf.h>
44 #include <sys/fcntl.h>
45 #include <sys/devfs.h>
46
47 #include <bus/u4b/usb.h>
48 #include <bus/u4b/usbdi.h>
49 #include <bus/u4b/usbdi_util.h>
50 #include <bus/u4b/usb_ioctl.h>
51
52 #if USB_HAVE_UGEN
53 #include <sys/sbuf.h>
54 #endif
55
56 #include "usbdevs.h"
57
58 #define USB_DEBUG_VAR usb_debug
59
60 #include <bus/u4b/usb_core.h>
61 #include <bus/u4b/usb_debug.h>
62 #include <bus/u4b/usb_process.h>
63 #include <bus/u4b/usb_device.h>
64 #include <bus/u4b/usb_busdma.h>
65 #include <bus/u4b/usb_transfer.h>
66 #include <bus/u4b/usb_request.h>
67 #include <bus/u4b/usb_dynamic.h>
68 #include <bus/u4b/usb_hub.h>
69 #include <bus/u4b/usb_util.h>
70 #include <bus/u4b/usb_msctest.h>
71 #if USB_HAVE_UGEN
72 #include <bus/u4b/usb_dev.h>
73 #include <bus/u4b/usb_generic.h>
74 #endif
75
76 #include <bus/u4b/quirk/usb_quirk.h>
77
78 #include <bus/u4b/usb_controller.h>
79 #include <bus/u4b/usb_bus.h>
80
81 /* function prototypes */
82
83 static void usb_init_endpoint(struct usb_device *, uint8_t,
84 struct usb_endpoint_descriptor *,
85 struct usb_endpoint_ss_comp_descriptor *,
86 struct usb_endpoint *);
87 static void usb_unconfigure(struct usb_device *, uint8_t);
88 static void usb_detach_device_sub(struct usb_device *, device_t *,
89 char **, uint8_t);
90 static uint8_t usb_probe_and_attach_sub(struct usb_device *,
91 struct usb_attach_arg *);
92 static void usb_init_attach_arg(struct usb_device *,
93 struct usb_attach_arg *);
94 static void usb_suspend_resume_sub(struct usb_device *, device_t,
95 uint8_t);
96 static usb_proc_callback_t usbd_clear_stall_proc;
97 static usb_error_t usb_config_parse(struct usb_device *, uint8_t, uint8_t);
98 static void usbd_set_device_strings(struct usb_device *);
99 #if USB_HAVE_DEVCTL
100 static void usb_notify_addq(const char *type, struct usb_device *);
101 #endif
102 #if USB_HAVE_UGEN
103 static void usb_fifo_free_wrap(struct usb_device *, uint8_t, uint8_t);
104 static void usb_cdev_create(struct usb_device *);
105 static void usb_cdev_free(struct usb_device *);
106 #endif
107
108 /* This variable is global to allow easy access to it: */
109
110 #ifdef USB_TEMPLATE
111 int usb_template = USB_TEMPLATE;
112 #else
113 int usb_template;
114 #endif
115
116 TUNABLE_INT("hw.usb.usb_template", &usb_template);
117 SYSCTL_INT(_hw_usb, OID_AUTO, template, CTLFLAG_RW,
118 &usb_template, 0, "Selected USB device side template");
119
120 /* English is default language */
121
122 static int usb_lang_id = 0x0009;
123 static int usb_lang_mask = 0x00FF;
124
125 TUNABLE_INT("hw.usb.usb_lang_id", &usb_lang_id);
126 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_id, CTLFLAG_RW,
127 &usb_lang_id, 0, "Preferred USB language ID");
128
129 TUNABLE_INT("hw.usb.usb_lang_mask", &usb_lang_mask);
130 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_mask, CTLFLAG_RW,
131 &usb_lang_mask, 0, "Preferred USB language mask");
132
133 static const char* statestr[USB_STATE_MAX] = {
134 [USB_STATE_DETACHED] = "DETACHED",
135 [USB_STATE_ATTACHED] = "ATTACHED",
136 [USB_STATE_POWERED] = "POWERED",
137 [USB_STATE_ADDRESSED] = "ADDRESSED",
138 [USB_STATE_CONFIGURED] = "CONFIGURED",
139 };
140
141 const char *
142 usb_statestr(enum usb_dev_state state)
143 {
144 return ((state < USB_STATE_MAX) ? statestr[state] : "UNKNOWN");
145 }
146
147 const char *
148 usb_get_manufacturer(struct usb_device *udev)
149 {
150 return (udev->manufacturer ? udev->manufacturer : "Unknown");
151 }
152
153 const char *
154 usb_get_product(struct usb_device *udev)
155 {
156 return (udev->product ? udev->product : "");
157 }
158
159 const char *
160 usb_get_serial(struct usb_device *udev)
161 {
162 return (udev->serial ? udev->serial : "");
163 }
164
165 /*------------------------------------------------------------------------*
166 * usbd_get_ep_by_addr
167 *
168 * This function searches for an USB ep by endpoint address and
169 * direction.
170 *
171 * Returns:
172 * NULL: Failure
173 * Else: Success
174 *------------------------------------------------------------------------*/
175 struct usb_endpoint *
176 usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val)
177 {
178 struct usb_endpoint *ep = udev->endpoints;
179 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
180 enum {
181 EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR),
182 };
183
184 /*
185 * According to the USB specification not all bits are used
186 * for the endpoint address. Keep defined bits only:
187 */
188 ea_val &= EA_MASK;
189
190 /*
191 * Iterate accross all the USB endpoints searching for a match
192 * based on the endpoint address:
193 */
194 for (; ep != ep_end; ep++) {
195
196 if (ep->edesc == NULL) {
197 continue;
198 }
199 /* do the mask and check the value */
200 if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) {
201 goto found;
202 }
203 }
204
205 /*
206 * The default endpoint is always present and is checked separately:
207 */
208 if ((udev->ctrl_ep.edesc != NULL) &&
209 ((udev->ctrl_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) {
210 ep = &udev->ctrl_ep;
211 goto found;
212 }
213 return (NULL);
214
215 found:
216 return (ep);
217 }
218
219 /*------------------------------------------------------------------------*
220 * usbd_get_endpoint
221 *
222 * This function searches for an USB endpoint based on the information
223 * given by the passed "struct usb_config" pointer.
224 *
225 * Return values:
226 * NULL: No match.
227 * Else: Pointer to "struct usb_endpoint".
228 *------------------------------------------------------------------------*/
229 struct usb_endpoint *
230 usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
231 const struct usb_config *setup)
232 {
233 struct usb_endpoint *ep = udev->endpoints;
234 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
235 uint8_t index = setup->ep_index;
236 uint8_t ea_mask;
237 uint8_t ea_val;
238 uint8_t type_mask;
239 uint8_t type_val;
240
241 DPRINTFN(10, "udev=%p iface_index=%d address=0x%x "
242 "type=0x%x dir=0x%x index=%d\n",
243 udev, iface_index, setup->endpoint,
244 setup->type, setup->direction, setup->ep_index);
245
246 /* check USB mode */
247
248 if (setup->usb_mode != USB_MODE_DUAL &&
249 udev->flags.usb_mode != setup->usb_mode) {
250 /* wrong mode - no endpoint */
251 return (NULL);
252 }
253
254 /* setup expected endpoint direction mask and value */
255
256 if (setup->direction == UE_DIR_RX) {
257 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
258 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
259 UE_DIR_OUT : UE_DIR_IN;
260 } else if (setup->direction == UE_DIR_TX) {
261 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
262 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
263 UE_DIR_IN : UE_DIR_OUT;
264 } else if (setup->direction == UE_DIR_ANY) {
265 /* match any endpoint direction */
266 ea_mask = 0;
267 ea_val = 0;
268 } else {
269 /* match the given endpoint direction */
270 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
271 ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT));
272 }
273
274 /* setup expected endpoint address */
275
276 if (setup->endpoint == UE_ADDR_ANY) {
277 /* match any endpoint address */
278 } else {
279 /* match the given endpoint address */
280 ea_mask |= UE_ADDR;
281 ea_val |= (setup->endpoint & UE_ADDR);
282 }
283
284 /* setup expected endpoint type */
285
286 if (setup->type == UE_BULK_INTR) {
287 /* this will match BULK and INTERRUPT endpoints */
288 type_mask = 2;
289 type_val = 2;
290 } else if (setup->type == UE_TYPE_ANY) {
291 /* match any endpoint type */
292 type_mask = 0;
293 type_val = 0;
294 } else {
295 /* match the given endpoint type */
296 type_mask = UE_XFERTYPE;
297 type_val = (setup->type & UE_XFERTYPE);
298 }
299
300 /*
301 * Iterate accross all the USB endpoints searching for a match
302 * based on the endpoint address. Note that we are searching
303 * the endpoints from the beginning of the "udev->endpoints" array.
304 */
305 for (; ep != ep_end; ep++) {
306
307 if ((ep->edesc == NULL) ||
308 (ep->iface_index != iface_index)) {
309 continue;
310 }
311 /* do the masks and check the values */
312
313 if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) &&
314 ((ep->edesc->bmAttributes & type_mask) == type_val)) {
315 if (!index--) {
316 goto found;
317 }
318 }
319 }
320
321 /*
322 * Match against default endpoint last, so that "any endpoint", "any
323 * address" and "any direction" returns the first endpoint of the
324 * interface. "iface_index" and "direction" is ignored:
325 */
326 if ((udev->ctrl_ep.edesc != NULL) &&
327 ((udev->ctrl_ep.edesc->bEndpointAddress & ea_mask) == ea_val) &&
328 ((udev->ctrl_ep.edesc->bmAttributes & type_mask) == type_val) &&
329 (!index)) {
330 ep = &udev->ctrl_ep;
331 goto found;
332 }
333 return (NULL);
334
335 found:
336 return (ep);
337 }
338
339 /*------------------------------------------------------------------------*
340 * usbd_interface_count
341 *
342 * This function stores the number of USB interfaces excluding
343 * alternate settings, which the USB config descriptor reports into
344 * the unsigned 8-bit integer pointed to by "count".
345 *
346 * Returns:
347 * 0: Success
348 * Else: Failure
349 *------------------------------------------------------------------------*/
350 usb_error_t
351 usbd_interface_count(struct usb_device *udev, uint8_t *count)
352 {
353 if (udev->cdesc == NULL) {
354 *count = 0;
355 return (USB_ERR_NOT_CONFIGURED);
356 }
357 *count = udev->ifaces_max;
358 return (USB_ERR_NORMAL_COMPLETION);
359 }
360
361 /*------------------------------------------------------------------------*
362 * usb_init_endpoint
363 *
364 * This function will initialise the USB endpoint structure pointed to by
365 * the "endpoint" argument. The structure pointed to by "endpoint" must be
366 * zeroed before calling this function.
367 *------------------------------------------------------------------------*/
368 static void
369 usb_init_endpoint(struct usb_device *udev, uint8_t iface_index,
370 struct usb_endpoint_descriptor *edesc,
371 struct usb_endpoint_ss_comp_descriptor *ecomp,
372 struct usb_endpoint *ep)
373 {
374 const struct usb_bus_methods *methods;
375 usb_stream_t x;
376
377 methods = udev->bus->methods;
378
379 (methods->endpoint_init) (udev, edesc, ep);
380
381 /* initialise USB endpoint structure */
382 ep->edesc = edesc;
383 ep->ecomp = ecomp;
384 ep->iface_index = iface_index;
385
386 /* setup USB stream queues */
387 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
388 TAILQ_INIT(&ep->endpoint_q[x].head);
389 ep->endpoint_q[x].command = &usbd_pipe_start;
390 }
391
392 /* the pipe is not supported by the hardware */
393 if (ep->methods == NULL)
394 return;
395
396 /* check for SUPER-speed streams mode endpoint */
397 if (udev->speed == USB_SPEED_SUPER && ecomp != NULL &&
398 (edesc->bmAttributes & UE_XFERTYPE) == UE_BULK &&
399 (UE_GET_BULK_STREAMS(ecomp->bmAttributes) != 0)) {
400 usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_STREAMS);
401 } else {
402 usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_DEFAULT);
403 }
404
405 /* clear stall, if any */
406 if (methods->clear_stall != NULL) {
407 USB_BUS_LOCK(udev->bus);
408 (methods->clear_stall) (udev, ep);
409 USB_BUS_UNLOCK(udev->bus);
410 }
411 }
412
413 /*-----------------------------------------------------------------------*
414 * usb_endpoint_foreach
415 *
416 * This function will iterate all the USB endpoints except the control
417 * endpoint. This function is NULL safe.
418 *
419 * Return values:
420 * NULL: End of USB endpoints
421 * Else: Pointer to next USB endpoint
422 *------------------------------------------------------------------------*/
423 struct usb_endpoint *
424 usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep)
425 {
426 struct usb_endpoint *ep_end;
427
428 /* be NULL safe */
429 if (udev == NULL)
430 return (NULL);
431
432 ep_end = udev->endpoints + udev->endpoints_max;
433
434 /* get next endpoint */
435 if (ep == NULL)
436 ep = udev->endpoints;
437 else
438 ep++;
439
440 /* find next allocated ep */
441 while (ep != ep_end) {
442 if (ep->edesc != NULL)
443 return (ep);
444 ep++;
445 }
446 return (NULL);
447 }
448
449 /*------------------------------------------------------------------------*
450 * usb_wait_pending_refs
451 *
452 * This function will wait for any USB references to go away before
453 * returning. This function is used before freeing a USB device.
454 *------------------------------------------------------------------------*/
455 static void
456 usb_wait_pending_refs(struct usb_device *udev)
457 {
458 #if USB_HAVE_UGEN
459 DPRINTF("Refcount = %d\n", (int)udev->refcount);
460
461 lockmgr(&usb_ref_lock, LK_EXCLUSIVE);
462 udev->refcount--;
463 while (1) {
464 /* wait for any pending references to go away */
465 if (udev->refcount == 0) {
466 /* prevent further refs being taken, if any */
467 udev->refcount = USB_DEV_REF_MAX;
468 break;
469 }
470 cv_wait(&udev->ref_cv, &usb_ref_lock);
471 }
472 lockmgr(&usb_ref_lock, LK_RELEASE);
473 #endif
474 }
475
476 /*------------------------------------------------------------------------*
477 * usb_unconfigure
478 *
479 * This function will free all USB interfaces and USB endpoints belonging
480 * to an USB device.
481 *
482 * Flag values, see "USB_UNCFG_FLAG_XXX".
483 *------------------------------------------------------------------------*/
484 static void
485 usb_unconfigure(struct usb_device *udev, uint8_t flag)
486 {
487 uint8_t do_unlock;
488
489 /* Prevent re-enumeration */
490 do_unlock = usbd_enum_lock(udev);
491
492 /* detach all interface drivers */
493 usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag);
494
495 #if USB_HAVE_UGEN
496 /* free all FIFOs except control endpoint FIFOs */
497 usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag);
498
499 /*
500 * Free all cdev's, if any.
501 */
502 usb_cdev_free(udev);
503 #endif
504
505 #if USB_HAVE_COMPAT_LINUX
506 /* free Linux compat device, if any */
507 if (udev->linux_endpoint_start) {
508 usb_linux_free_device(udev);
509 udev->linux_endpoint_start = NULL;
510 }
511 #endif
512
513 usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE);
514
515 /* free "cdesc" after "ifaces" and "endpoints", if any */
516 if (udev->cdesc != NULL) {
517 if (udev->flags.usb_mode != USB_MODE_DEVICE)
518 usbd_free_config_desc(udev, udev->cdesc);
519 udev->cdesc = NULL;
520 }
521 /* set unconfigured state */
522 udev->curr_config_no = USB_UNCONFIG_NO;
523 udev->curr_config_index = USB_UNCONFIG_INDEX;
524
525 if (do_unlock)
526 usbd_enum_unlock(udev);
527 }
528
529 /*------------------------------------------------------------------------*
530 * usbd_set_config_index
531 *
532 * This function selects configuration by index, independent of the
533 * actual configuration number. This function should not be used by
534 * USB drivers.
535 *
536 * Returns:
537 * 0: Success
538 * Else: Failure
539 *------------------------------------------------------------------------*/
540 usb_error_t
541 usbd_set_config_index(struct usb_device *udev, uint8_t index)
542 {
543 struct usb_status ds;
544 struct usb_config_descriptor *cdp;
545 uint16_t power;
546 uint16_t max_power;
547 uint8_t selfpowered;
548 uint8_t do_unlock;
549 usb_error_t err;
550
551 DPRINTFN(6, "udev=%p index=%d\n", udev, index);
552
553 /* Prevent re-enumeration */
554 do_unlock = usbd_enum_lock(udev);
555
556 usb_unconfigure(udev, 0);
557
558 if (index == USB_UNCONFIG_INDEX) {
559 /*
560 * Leave unallocated when unconfiguring the
561 * device. "usb_unconfigure()" will also reset
562 * the current config number and index.
563 */
564 err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO);
565 if (udev->state == USB_STATE_CONFIGURED)
566 usb_set_device_state(udev, USB_STATE_ADDRESSED);
567 goto done;
568 }
569 /* get the full config descriptor */
570 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
571 /* save some memory */
572 err = usbd_req_get_descriptor_ptr(udev, &cdp,
573 (UDESC_CONFIG << 8) | index);
574 } else {
575 /* normal request */
576 err = usbd_req_get_config_desc_full(udev,
577 NULL, &cdp, index);
578 }
579 if (err) {
580 goto done;
581 }
582 /* set the new config descriptor */
583
584 udev->cdesc = cdp;
585
586 /* Figure out if the device is self or bus powered. */
587 selfpowered = 0;
588 if ((!udev->flags.uq_bus_powered) &&
589 (cdp->bmAttributes & UC_SELF_POWERED) &&
590 (udev->flags.usb_mode == USB_MODE_HOST)) {
591 /* May be self powered. */
592 if (cdp->bmAttributes & UC_BUS_POWERED) {
593 /* Must ask device. */
594 err = usbd_req_get_device_status(udev, NULL, &ds);
595 if (err) {
596 DPRINTFN(0, "could not read "
597 "device status: %s\n",
598 usbd_errstr(err));
599 } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) {
600 selfpowered = 1;
601 }
602 DPRINTF("status=0x%04x \n",
603 UGETW(ds.wStatus));
604 } else
605 selfpowered = 1;
606 }
607 DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, "
608 "selfpowered=%d, power=%d\n",
609 udev, cdp,
610 udev->address, cdp->bConfigurationValue, cdp->bmAttributes,
611 selfpowered, cdp->bMaxPower * 2);
612
613 /* Check if we have enough power. */
614 power = cdp->bMaxPower * 2;
615
616 if (udev->parent_hub) {
617 max_power = udev->parent_hub->hub->portpower;
618 } else {
619 max_power = USB_MAX_POWER;
620 }
621
622 if (power > max_power) {
623 DPRINTFN(0, "power exceeded %d > %d\n", power, max_power);
624 err = USB_ERR_NO_POWER;
625 goto done;
626 }
627 /* Only update "self_powered" in USB Host Mode */
628 if (udev->flags.usb_mode == USB_MODE_HOST) {
629 udev->flags.self_powered = selfpowered;
630 }
631 udev->power = power;
632 udev->curr_config_no = cdp->bConfigurationValue;
633 udev->curr_config_index = index;
634 usb_set_device_state(udev, USB_STATE_CONFIGURED);
635
636 /* Set the actual configuration value. */
637 err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue);
638 if (err) {
639 goto done;
640 }
641
642 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC);
643 if (err) {
644 goto done;
645 }
646
647 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT);
648 if (err) {
649 goto done;
650 }
651
652 #if USB_HAVE_UGEN
653 /* create device nodes for each endpoint */
654 usb_cdev_create(udev);
655 #endif
656
657 done:
658 DPRINTF("error=%s\n", usbd_errstr(err));
659 if (err) {
660 usb_unconfigure(udev, 0);
661 }
662 if (do_unlock)
663 usbd_enum_unlock(udev);
664 return (err);
665 }
666
667 /*------------------------------------------------------------------------*
668 * usb_config_parse
669 *
670 * This function will allocate and free USB interfaces and USB endpoints,
671 * parse the USB configuration structure and initialise the USB endpoints
672 * and interfaces. If "iface_index" is not equal to
673 * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the
674 * alternate_setting to be selected for the given interface. Else the
675 * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be
676 * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function
677 * is typically called when setting the configuration or when setting
678 * an alternate interface.
679 *
680 * Returns:
681 * 0: Success
682 * Else: Failure
683 *------------------------------------------------------------------------*/
684 static usb_error_t
685 usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd)
686 {
687 struct usb_idesc_parse_state ips;
688 struct usb_interface_descriptor *id;
689 struct usb_endpoint_descriptor *ed;
690 struct usb_interface *iface;
691 struct usb_endpoint *ep;
692 usb_error_t err;
693 uint8_t ep_curr;
694 uint8_t ep_max;
695 uint8_t temp;
696 uint8_t do_init;
697 uint8_t alt_index;
698
699 if (iface_index != USB_IFACE_INDEX_ANY) {
700 /* parameter overload */
701 alt_index = cmd;
702 cmd = USB_CFG_INIT;
703 } else {
704 /* not used */
705 alt_index = 0;
706 }
707
708 err = 0;
709
710 DPRINTFN(5, "iface_index=%d cmd=%d\n",
711 iface_index, cmd);
712
713 if (cmd == USB_CFG_FREE)
714 goto cleanup;
715
716 if (cmd == USB_CFG_INIT) {
717 KKASSERT(lockowned(&udev->enum_lock));
718
719 /* check for in-use endpoints */
720
721 ep = udev->endpoints;
722 ep_max = udev->endpoints_max;
723 while (ep_max--) {
724 /* look for matching endpoints */
725 if ((iface_index == USB_IFACE_INDEX_ANY) ||
726 (iface_index == ep->iface_index)) {
727 if (ep->refcount_alloc != 0) {
728 /*
729 * This typically indicates a
730 * more serious error.
731 */
732 err = USB_ERR_IN_USE;
733 } else {
734 /* reset endpoint */
735 memset(ep, 0, sizeof(*ep));
736 /* make sure we don't zero the endpoint again */
737 ep->iface_index = USB_IFACE_INDEX_ANY;
738 }
739 }
740 ep++;
741 }
742
743 if (err)
744 return (err);
745 }
746
747 memset(&ips, 0, sizeof(ips));
748
749 ep_curr = 0;
750 ep_max = 0;
751
752 while ((id = usb_idesc_foreach(udev->cdesc, &ips))) {
753
754 iface = udev->ifaces + ips.iface_index;
755
756 /* check for specific interface match */
757
758 if (cmd == USB_CFG_INIT) {
759 if ((iface_index != USB_IFACE_INDEX_ANY) &&
760 (iface_index != ips.iface_index)) {
761 /* wrong interface */
762 do_init = 0;
763 } else if (alt_index != ips.iface_index_alt) {
764 /* wrong alternate setting */
765 do_init = 0;
766 } else {
767 /* initialise interface */
768 do_init = 1;
769 }
770 } else
771 do_init = 0;
772
773 /* check for new interface */
774 if (ips.iface_index_alt == 0) {
775 /* update current number of endpoints */
776 ep_curr = ep_max;
777 }
778 /* check for init */
779 if (do_init) {
780 /* setup the USB interface structure */
781 iface->idesc = id;
782 /* set alternate index */
783 iface->alt_index = alt_index;
784 /* set default interface parent */
785 if (iface_index == USB_IFACE_INDEX_ANY) {
786 iface->parent_iface_index =
787 USB_IFACE_INDEX_ANY;
788 }
789 }
790
791 DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints);
792
793 ed = (struct usb_endpoint_descriptor *)id;
794
795 temp = ep_curr;
796
797 /* iterate all the endpoint descriptors */
798 while ((ed = usb_edesc_foreach(udev->cdesc, ed))) {
799
800 /* check if endpoint limit has been reached */
801 if (temp >= USB_MAX_EP_UNITS) {
802 DPRINTF("Endpoint limit reached\n");
803 break;
804 }
805
806 ep = udev->endpoints + temp;
807
808 if (do_init) {
809 void *ecomp;
810
811 ecomp = usb_ed_comp_foreach(udev->cdesc, (void *)ed);
812 if (ecomp != NULL)
813 DPRINTFN(5, "Found endpoint companion descriptor\n");
814
815 usb_init_endpoint(udev,
816 ips.iface_index, ed, ecomp, ep);
817 }
818
819 temp ++;
820
821 /* find maximum number of endpoints */
822 if (ep_max < temp)
823 ep_max = temp;
824 }
825 }
826
827 /* NOTE: It is valid to have no interfaces and no endpoints! */
828
829 if (cmd == USB_CFG_ALLOC) {
830 udev->ifaces_max = ips.iface_index;
831 #if (USB_HAVE_FIXED_IFACE == 0)
832 udev->ifaces = NULL;
833 if (udev->ifaces_max != 0) {
834 udev->ifaces = kmalloc(sizeof(*iface) * udev->ifaces_max,
835 M_USB, M_WAITOK | M_ZERO);
836 if (udev->ifaces == NULL) {
837 err = USB_ERR_NOMEM;
838 goto done;
839 }
840 }
841 #endif
842 #if (USB_HAVE_FIXED_ENDPOINT == 0)
843 if (ep_max != 0) {
844 udev->endpoints = kmalloc(sizeof(*ep) * ep_max,
845 M_USB, M_WAITOK | M_ZERO);
846 if (udev->endpoints == NULL) {
847 err = USB_ERR_NOMEM;
848 goto done;
849 }
850 } else {
851 udev->endpoints = NULL;
852 }
853 #endif
854 USB_BUS_LOCK(udev->bus);
855 udev->endpoints_max = ep_max;
856 /* reset any ongoing clear-stall */
857 udev->ep_curr = NULL;
858 USB_BUS_UNLOCK(udev->bus);
859 }
860 #if (USB_HAVE_FIXED_IFACE == 0) || (USB_HAVE_FIXED_ENDPOINT == 0)
861 done:
862 #endif
863 if (err) {
864 if (cmd == USB_CFG_ALLOC) {
865 cleanup:
866 USB_BUS_LOCK(udev->bus);
867 udev->endpoints_max = 0;
868 /* reset any ongoing clear-stall */
869 udev->ep_curr = NULL;
870 USB_BUS_UNLOCK(udev->bus);
871
872 #if (USB_HAVE_FIXED_IFACE == 0)
873 if(udev->ifaces != NULL) {
874 kfree(udev->ifaces, M_USB);
875 udev->ifaces = NULL;
876 }
877 #endif
878 #if (USB_HAVE_FIXED_ENDPOINT == 0)
879 if(udev->endpoints != NULL) {
880 kfree(udev->endpoints, M_USB);
881 udev->endpoints = NULL;
882 }
883 #endif
884 udev->ifaces_max = 0;
885 }
886 }
887 return (err);
888 }
889
890 /*------------------------------------------------------------------------*
891 * usbd_set_alt_interface_index
892 *
893 * This function will select an alternate interface index for the
894 * given interface index. The interface should not be in use when this
895 * function is called. That means there should not be any open USB
896 * transfers. Else an error is returned. If the alternate setting is
897 * already set this function will simply return success. This function
898 * is called in Host mode and Device mode!
899 *
900 * Returns:
901 * 0: Success
902 * Else: Failure
903 *------------------------------------------------------------------------*/
904 usb_error_t
905 usbd_set_alt_interface_index(struct usb_device *udev,
906 uint8_t iface_index, uint8_t alt_index)
907 {
908 struct usb_interface *iface = usbd_get_iface(udev, iface_index);
909 usb_error_t err;
910 uint8_t do_unlock;
911
912 /* Prevent re-enumeration */
913 do_unlock = usbd_enum_lock(udev);
914
915 if (iface == NULL) {
916 err = USB_ERR_INVAL;
917 goto done;
918 }
919 if (iface->alt_index == alt_index) {
920 /*
921 * Optimise away duplicate setting of
922 * alternate setting in USB Host Mode!
923 */
924 err = 0;
925 goto done;
926 }
927 #if USB_HAVE_UGEN
928 /*
929 * Free all generic FIFOs for this interface, except control
930 * endpoint FIFOs:
931 */
932 usb_fifo_free_wrap(udev, iface_index, 0);
933 #endif
934
935 err = usb_config_parse(udev, iface_index, alt_index);
936 if (err) {
937 goto done;
938 }
939 if (iface->alt_index != alt_index) {
940 /* the alternate setting does not exist */
941 err = USB_ERR_INVAL;
942 goto done;
943 }
944
945 err = usbd_req_set_alt_interface_no(udev, NULL, iface_index,
946 iface->idesc->bAlternateSetting);
947
948 done:
949 if (do_unlock)
950 usbd_enum_unlock(udev);
951 return (err);
952 }
953
954 /*------------------------------------------------------------------------*
955 * usbd_set_endpoint_stall
956 *
957 * This function is used to make a BULK or INTERRUPT endpoint send
958 * STALL tokens in USB device mode.
959 *
960 * Returns:
961 * 0: Success
962 * Else: Failure
963 *------------------------------------------------------------------------*/
964 usb_error_t
965 usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep,
966 uint8_t do_stall)
967 {
968 struct usb_xfer *xfer;
969 usb_stream_t x;
970 uint8_t et;
971 uint8_t was_stalled;
972
973 if (ep == NULL) {
974 /* nothing to do */
975 DPRINTF("Cannot find endpoint\n");
976 /*
977 * Pretend that the clear or set stall request is
978 * successful else some USB host stacks can do
979 * strange things, especially when a control endpoint
980 * stalls.
981 */
982 return (0);
983 }
984 et = (ep->edesc->bmAttributes & UE_XFERTYPE);
985
986 if ((et != UE_BULK) &&
987 (et != UE_INTERRUPT)) {
988 /*
989 * Should not stall control
990 * nor isochronous endpoints.
991 */
992 DPRINTF("Invalid endpoint\n");
993 return (0);
994 }
995 USB_BUS_LOCK(udev->bus);
996
997 /* store current stall state */
998 was_stalled = ep->is_stalled;
999
1000 /* check for no change */
1001 if (was_stalled && do_stall) {
1002 /* if the endpoint is already stalled do nothing */
1003 USB_BUS_UNLOCK(udev->bus);
1004 DPRINTF("No change\n");
1005 return (0);
1006 }
1007 /* set stalled state */
1008 ep->is_stalled = 1;
1009
1010 if (do_stall || (!was_stalled)) {
1011 if (!was_stalled) {
1012 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
1013 /* lookup the current USB transfer, if any */
1014 xfer = ep->endpoint_q[x].curr;
1015 if (xfer != NULL) {
1016 /*
1017 * The "xfer_stall" method
1018 * will complete the USB
1019 * transfer like in case of a
1020 * timeout setting the error
1021 * code "USB_ERR_STALLED".
1022 */
1023 (udev->bus->methods->xfer_stall) (xfer);
1024 }
1025 }
1026 }
1027 (udev->bus->methods->set_stall) (udev, ep, &do_stall);
1028 }
1029 if (!do_stall) {
1030 ep->toggle_next = 0; /* reset data toggle */
1031 ep->is_stalled = 0; /* clear stalled state */
1032
1033 (udev->bus->methods->clear_stall) (udev, ep);
1034
1035 /* start the current or next transfer, if any */
1036 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
1037 usb_command_wrapper(&ep->endpoint_q[x],
1038 ep->endpoint_q[x].curr);
1039 }
1040 }
1041 USB_BUS_UNLOCK(udev->bus);
1042 return (0);
1043 }
1044
1045 /*------------------------------------------------------------------------*
1046 * usb_reset_iface_endpoints - used in USB device side mode
1047 *------------------------------------------------------------------------*/
1048 usb_error_t
1049 usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index)
1050 {
1051 struct usb_endpoint *ep;
1052 struct usb_endpoint *ep_end;
1053
1054 ep = udev->endpoints;
1055 ep_end = udev->endpoints + udev->endpoints_max;
1056
1057 for (; ep != ep_end; ep++) {
1058
1059 if ((ep->edesc == NULL) ||
1060 (ep->iface_index != iface_index)) {
1061 continue;
1062 }
1063 /* simulate a clear stall from the peer */
1064 usbd_set_endpoint_stall(udev, ep, 0);
1065 }
1066 return (0);
1067 }
1068
1069 /*------------------------------------------------------------------------*
1070 * usb_detach_device_sub
1071 *
1072 * This function will try to detach an USB device. If it fails a panic
1073 * will result.
1074 *
1075 * Flag values, see "USB_UNCFG_FLAG_XXX".
1076 *------------------------------------------------------------------------*/
1077 static void
1078 usb_detach_device_sub(struct usb_device *udev, device_t *ppdev,
1079 char **ppnpinfo, uint8_t flag)
1080 {
1081 device_t dev;
1082 char *pnpinfo;
1083 int err;
1084
1085 dev = *ppdev;
1086 if (dev) {
1087 /*
1088 * NOTE: It is important to clear "*ppdev" before deleting
1089 * the child due to some device methods being called late
1090 * during the delete process !
1091 */
1092 *ppdev = NULL;
1093
1094 device_printf(dev, "at %s, port %d, addr %d "
1095 "(disconnected)\n",
1096 device_get_nameunit(udev->parent_dev),
1097 udev->port_no, udev->address);
1098
1099 if (device_is_attached(dev)) {
1100 if (udev->flags.peer_suspended) {
1101 err = DEVICE_RESUME(dev);
1102 if (err) {
1103 device_printf(dev, "Resume failed\n");
1104 }
1105 }
1106 if (device_detach(dev)) {
1107 goto error;
1108 }
1109 }
1110 if (device_delete_child(udev->parent_dev, dev)) {
1111 goto error;
1112 }
1113 }
1114
1115 pnpinfo = *ppnpinfo;
1116 if (pnpinfo != NULL) {
1117 *ppnpinfo = NULL;
1118 kfree(pnpinfo, M_USBDEV);
1119 }
1120 return;
1121
1122 error:
1123 /* Detach is not allowed to fail in the USB world */
1124 panic("usb_detach_device_sub: A USB driver would not detach\n");
1125 }
1126
1127 /*------------------------------------------------------------------------*
1128 * usb_detach_device
1129 *
1130 * The following function will detach the matching interfaces.
1131 * This function is NULL safe.
1132 *
1133 * Flag values, see "USB_UNCFG_FLAG_XXX".
1134 *------------------------------------------------------------------------*/
1135 void
1136 usb_detach_device(struct usb_device *udev, uint8_t iface_index,
1137 uint8_t flag)
1138 {
1139 struct usb_interface *iface;
1140 uint8_t i;
1141
1142 if (udev == NULL) {
1143 /* nothing to do */
1144 return;
1145 }
1146 DPRINTFN(4, "udev=%p\n", udev);
1147
1148 KKASSERT(lockowned(&udev->enum_lock));
1149
1150 /*
1151 * First detach the child to give the child's detach routine a
1152 * chance to detach the sub-devices in the correct order.
1153 * Then delete the child using "device_delete_child()" which
1154 * will detach all sub-devices from the bottom and upwards!
1155 */
1156 if (iface_index != USB_IFACE_INDEX_ANY) {
1157 i = iface_index;
1158 iface_index = i + 1;
1159 } else {
1160 i = 0;
1161 iface_index = USB_IFACE_MAX;
1162 }
1163
1164 /* do the detach */
1165
1166 for (; i != iface_index; i++) {
1167
1168 iface = usbd_get_iface(udev, i);
1169 if (iface == NULL) {
1170 /* looks like the end of the USB interfaces */
1171 break;
1172 }
1173 usb_detach_device_sub(udev, &iface->subdev,
1174 &iface->pnpinfo, flag);
1175 }
1176 }
1177
1178 /*------------------------------------------------------------------------*
1179 * usb_probe_and_attach_sub
1180 *
1181 * Returns:
1182 * 0: Success
1183 * Else: Failure
1184 *------------------------------------------------------------------------*/
1185 static uint8_t
1186 usb_probe_and_attach_sub(struct usb_device *udev,
1187 struct usb_attach_arg *uaa)
1188 {
1189 struct usb_interface *iface;
1190 device_t dev;
1191 int err;
1192
1193 iface = uaa->iface;
1194 if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) {
1195 /* leave interface alone */
1196 return (0);
1197 }
1198 dev = iface->subdev;
1199 if (dev) {
1200
1201 /* clean up after module unload */
1202
1203 if (device_is_attached(dev)) {
1204 /* already a device there */
1205 return (0);
1206 }
1207 /* clear "iface->subdev" as early as possible */
1208
1209 iface->subdev = NULL;
1210
1211 if (device_delete_child(udev->parent_dev, dev)) {
1212
1213 /*
1214 * Panic here, else one can get a double call
1215 * to device_detach(). USB devices should
1216 * never fail on detach!
1217 */
1218 panic("device_delete_child() failed\n");
1219 }
1220 }
1221 if (uaa->temp_dev == NULL) {
1222
1223 /* create a new child */
1224 uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1);
1225 if (uaa->temp_dev == NULL) {
1226 device_printf(udev->parent_dev,
1227 "Device creation failed\n");
1228 return (1); /* failure */
1229 }
1230 device_set_ivars(uaa->temp_dev, uaa);
1231 device_quiet(uaa->temp_dev);
1232 }
1233 /*
1234 * Set "subdev" before probe and attach so that "devd" gets
1235 * the information it needs.
1236 */
1237 iface->subdev = uaa->temp_dev;
1238
1239 if (device_probe_and_attach(iface->subdev) == 0) {
1240 /*
1241 * The USB attach arguments are only available during probe
1242 * and attach !
1243 */
1244 uaa->temp_dev = NULL;
1245 device_set_ivars(iface->subdev, NULL);
1246
1247 if (udev->flags.peer_suspended) {
1248 err = DEVICE_SUSPEND(iface->subdev);
1249 if (err)
1250 device_printf(iface->subdev, "Suspend failed\n");
1251 }
1252 return (0); /* success */
1253 } else {
1254 /* No USB driver found */
1255 iface->subdev = NULL;
1256 }
1257 return (1); /* failure */
1258 }
1259
1260 /*------------------------------------------------------------------------*
1261 * usbd_set_parent_iface
1262 *
1263 * Using this function will lock the alternate interface setting on an
1264 * interface. It is typically used for multi interface drivers. In USB
1265 * device side mode it is assumed that the alternate interfaces all
1266 * have the same endpoint descriptors. The default parent index value
1267 * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not
1268 * locked.
1269 *------------------------------------------------------------------------*/
1270 void
1271 usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
1272 uint8_t parent_index)
1273 {
1274 struct usb_interface *iface;
1275
1276 if (udev == NULL) {
1277 /* nothing to do */
1278 return;
1279 }
1280 iface = usbd_get_iface(udev, iface_index);
1281 if (iface != NULL)
1282 iface->parent_iface_index = parent_index;
1283 }
1284
1285 static void
1286 usb_init_attach_arg(struct usb_device *udev,
1287 struct usb_attach_arg *uaa)
1288 {
1289 memset(uaa, 0, sizeof(*uaa));
1290
1291 uaa->device = udev;
1292 uaa->usb_mode = udev->flags.usb_mode;
1293 uaa->port = udev->port_no;
1294 uaa->dev_state = UAA_DEV_READY;
1295
1296 uaa->info.idVendor = UGETW(udev->ddesc.idVendor);
1297 uaa->info.idProduct = UGETW(udev->ddesc.idProduct);
1298 uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice);
1299 uaa->info.bDeviceClass = udev->ddesc.bDeviceClass;
1300 uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass;
1301 uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol;
1302 uaa->info.bConfigIndex = udev->curr_config_index;
1303 uaa->info.bConfigNum = udev->curr_config_no;
1304 }
1305
1306 /*------------------------------------------------------------------------*
1307 * usb_probe_and_attach
1308 *
1309 * This function is called from "uhub_explore_sub()",
1310 * "usb_handle_set_config()" and "usb_handle_request()".
1311 *
1312 * Returns:
1313 * 0: Success
1314 * Else: A control transfer failed
1315 *------------------------------------------------------------------------*/
1316 usb_error_t
1317 usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index)
1318 {
1319 struct usb_attach_arg uaa;
1320 struct usb_interface *iface;
1321 uint8_t i;
1322 uint8_t j;
1323 uint8_t do_unlock;
1324
1325 if (udev == NULL) {
1326 DPRINTF("udev == NULL\n");
1327 return (USB_ERR_INVAL);
1328 }
1329 /* Prevent re-enumeration */
1330 do_unlock = usbd_enum_lock(udev);
1331
1332 if (udev->curr_config_index == USB_UNCONFIG_INDEX) {
1333 /* do nothing - no configuration has been set */
1334 goto done;
1335 }
1336 /* setup USB attach arguments */
1337
1338 usb_init_attach_arg(udev, &uaa);
1339
1340 /*
1341 * If the whole USB device is targeted, invoke the USB event
1342 * handler(s):
1343 */
1344 if (iface_index == USB_IFACE_INDEX_ANY) {
1345
1346 if (usb_test_quirk(&uaa, UQ_MSC_DYMO_EJECT) != 0 &&
1347 usb_dymo_eject(udev, 0) == 0) {
1348 /* success, mark the udev as disappearing */
1349 uaa.dev_state = UAA_DEV_EJECTING;
1350 }
1351
1352 EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa);
1353
1354 if (uaa.dev_state != UAA_DEV_READY) {
1355 /* leave device unconfigured */
1356 usb_unconfigure(udev, 0);
1357 goto done;
1358 }
1359 }
1360
1361 /* Check if only one interface should be probed: */
1362 if (iface_index != USB_IFACE_INDEX_ANY) {
1363 i = iface_index;
1364 j = i + 1;
1365 } else {
1366 i = 0;
1367 j = USB_IFACE_MAX;
1368 }
1369
1370 /* Do the probe and attach */
1371 for (; i != j; i++) {
1372
1373 iface = usbd_get_iface(udev, i);
1374 if (iface == NULL) {
1375 /*
1376 * Looks like the end of the USB
1377 * interfaces !
1378 */
1379 DPRINTFN(2, "end of interfaces "
1380 "at %u\n", i);
1381 break;
1382 }
1383 if (iface->idesc == NULL) {
1384 /* no interface descriptor */
1385 continue;
1386 }
1387 uaa.iface = iface;
1388
1389 uaa.info.bInterfaceClass =
1390 iface->idesc->bInterfaceClass;
1391 uaa.info.bInterfaceSubClass =
1392 iface->idesc->bInterfaceSubClass;
1393 uaa.info.bInterfaceProtocol =
1394 iface->idesc->bInterfaceProtocol;
1395 uaa.info.bIfaceIndex = i;
1396 uaa.info.bIfaceNum =
1397 iface->idesc->bInterfaceNumber;
1398 uaa.driver_info = 0; /* reset driver_info */
1399
1400 DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n",
1401 uaa.info.bInterfaceClass,
1402 uaa.info.bInterfaceSubClass,
1403 uaa.info.bInterfaceProtocol,
1404 uaa.info.bIfaceIndex,
1405 uaa.info.bIfaceNum);
1406
1407 usb_probe_and_attach_sub(udev, &uaa);
1408
1409 /*
1410 * Remove the leftover child, if any, to enforce that
1411 * a new nomatch devd event is generated for the next
1412 * interface if no driver is found:
1413 */
1414 if (uaa.temp_dev == NULL)
1415 continue;
1416 if (device_delete_child(udev->parent_dev, uaa.temp_dev))
1417 DPRINTFN(0, "device delete child failed\n");
1418 uaa.temp_dev = NULL;
1419 }
1420 done:
1421 if (do_unlock)
1422 usbd_enum_unlock(udev);
1423 return (0);
1424 }
1425
1426 /*------------------------------------------------------------------------*
1427 * usb_suspend_resume_sub
1428 *
1429 * This function is called when the suspend or resume methods should
1430 * be executed on an USB device.
1431 *------------------------------------------------------------------------*/
1432 static void
1433 usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend)
1434 {
1435 int err;
1436
1437 if (dev == NULL) {
1438 return;
1439 }
1440 if (!device_is_attached(dev)) {
1441 return;
1442 }
1443 if (do_suspend) {
1444 err = DEVICE_SUSPEND(dev);
1445 } else {
1446 err = DEVICE_RESUME(dev);
1447 }
1448 if (err) {
1449 device_printf(dev, "%s failed\n",
1450 do_suspend ? "Suspend" : "Resume");
1451 }
1452 }
1453
1454 /*------------------------------------------------------------------------*
1455 * usb_suspend_resume
1456 *
1457 * The following function will suspend or resume the USB device.
1458 *
1459 * Returns:
1460 * 0: Success
1461 * Else: Failure
1462 *------------------------------------------------------------------------*/
1463 usb_error_t
1464 usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend)
1465 {
1466 struct usb_interface *iface;
1467 uint8_t i;
1468
1469 if (udev == NULL) {
1470 /* nothing to do */
1471 return (0);
1472 }
1473 DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend);
1474
1475 KKASSERT(lockowned(&udev->sr_lock));
1476
1477 USB_BUS_LOCK(udev->bus);
1478 /* filter the suspend events */
1479 if (udev->flags.peer_suspended == do_suspend) {
1480 USB_BUS_UNLOCK(udev->bus);
1481 /* nothing to do */
1482 return (0);
1483 }
1484 udev->flags.peer_suspended = do_suspend;
1485 USB_BUS_UNLOCK(udev->bus);
1486
1487 /* do the suspend or resume */
1488
1489 for (i = 0; i != USB_IFACE_MAX; i++) {
1490
1491 iface = usbd_get_iface(udev, i);
1492 if (iface == NULL) {
1493 /* looks like the end of the USB interfaces */
1494 break;
1495 }
1496 usb_suspend_resume_sub(udev, iface->subdev, do_suspend);
1497 }
1498 return (0);
1499 }
1500
1501 /*------------------------------------------------------------------------*
1502 * usbd_clear_stall_proc
1503 *
1504 * This function performs generic USB clear stall operations.
1505 *------------------------------------------------------------------------*/
1506 static void
1507 usbd_clear_stall_proc(struct usb_proc_msg *_pm)
1508 {
1509 struct usb_udev_msg *pm = (void *)_pm;
1510 struct usb_device *udev = pm->udev;
1511
1512 /* Change lock */
1513 USB_BUS_UNLOCK(udev->bus);
1514 lockmgr(&udev->device_lock, LK_EXCLUSIVE);
1515
1516 /* Start clear stall callback */
1517 usbd_transfer_start(udev->ctrl_xfer[1]);
1518
1519 /* Change lock */
1520 lockmgr(&udev->device_lock, LK_RELEASE);
1521 USB_BUS_LOCK(udev->bus);
1522 }
1523
1524 /*------------------------------------------------------------------------*
1525 * usb_alloc_device
1526 *
1527 * This function allocates a new USB device. This function is called
1528 * when a new device has been put in the powered state, but not yet in
1529 * the addressed state. Get initial descriptor, set the address, get
1530 * full descriptor and get strings.
1531 *
1532 * Return values:
1533 * 0: Failure
1534 * Else: Success
1535 *------------------------------------------------------------------------*/
1536 struct usb_device *
1537 usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
1538 struct usb_device *parent_hub, uint8_t depth, uint8_t port_index,
1539 uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode)
1540 {
1541 struct usb_attach_arg uaa;
1542 struct usb_device *udev;
1543 struct usb_device *adev;
1544 struct usb_device *hub;
1545 uint8_t *scratch_ptr;
1546 usb_error_t err;
1547 uint8_t device_index;
1548 uint8_t config_index;
1549 uint8_t config_quirk;
1550 uint8_t set_config_failed;
1551 uint8_t do_unlock;
1552
1553 DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, "
1554 "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n",
1555 parent_dev, bus, parent_hub, depth, port_index, port_no,
1556 speed, mode);
1557
1558 /*
1559 * Find an unused device index. In USB Host mode this is the
1560 * same as the device address.
1561 *
1562 * Device index zero is not used and device index 1 should
1563 * always be the root hub.
1564 */
1565 for (device_index = USB_ROOT_HUB_ADDR;
1566 (device_index != bus->devices_max) &&
1567 (bus->devices[device_index] != NULL);
1568 device_index++) /* nop */;
1569
1570 if (device_index == bus->devices_max) {
1571 device_printf(bus->bdev,
1572 "No free USB device index for new device\n");
1573 return (NULL);
1574 }
1575
1576 if (depth > 0x10) {
1577 device_printf(bus->bdev,
1578 "Invalid device depth\n");
1579 return (NULL);
1580 }
1581 udev = kmalloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO);
1582
1583 if (udev == NULL) {
1584 return (NULL);
1585 }
1586 /* Initialise SX-locks */
1587 lockinit(&udev->enum_lock, "USB config SX lock", 0, LK_CANRECURSE);
1588 /* XXX (mp) is this LK_CANRECURSE necessary? */
1589 lockinit(&udev->sr_lock, "USB suspend and resume SX lock", 0, LK_CANRECURSE);
1590
1591 cv_init(&udev->ctrlreq_cv, "WCTRL");
1592 cv_init(&udev->ref_cv, "UGONE");
1593
1594 /* initialise our mutex */
1595 lockinit(&udev->device_lock, "USB device mutex", 0, 0);
1596
1597 /* initialise generic clear stall */
1598 udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc;
1599 udev->cs_msg[0].udev = udev;
1600 udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc;
1601 udev->cs_msg[1].udev = udev;
1602
1603 /* initialise some USB device fields */
1604 udev->parent_hub = parent_hub;
1605 udev->parent_dev = parent_dev;
1606 udev->port_index = port_index;
1607 udev->port_no = port_no;
1608 udev->depth = depth;
1609 udev->bus = bus;
1610 udev->address = USB_START_ADDR; /* default value */
1611 udev->plugtime = (usb_ticks_t)ticks;
1612 /*
1613 * We need to force the power mode to "on" because there are plenty
1614 * of USB devices out there that do not work very well with
1615 * automatic suspend and resume!
1616 */
1617 udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON);
1618 udev->pwr_save.last_xfer_time = ticks;
1619 /* we are not ready yet */
1620 udev->refcount = 1;
1621
1622 /* set up default endpoint descriptor */
1623 udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc);
1624 udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT;
1625 udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT;
1626 udev->ctrl_ep_desc.bmAttributes = UE_CONTROL;
1627 udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET;
1628 udev->ctrl_ep_desc.wMaxPacketSize[1] = 0;
1629 udev->ctrl_ep_desc.bInterval = 0;
1630
1631 /* set up default endpoint companion descriptor */
1632 udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc);
1633 udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP;
1634
1635 udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET;
1636
1637 udev->speed = speed;
1638 udev->flags.usb_mode = mode;
1639
1640 /* search for our High Speed USB HUB, if any */
1641
1642 adev = udev;
1643 hub = udev->parent_hub;
1644
1645 while (hub) {
1646 if (hub->speed == USB_SPEED_HIGH) {
1647 udev->hs_hub_addr = hub->address;
1648 udev->parent_hs_hub = hub;
1649 udev->hs_port_no = adev->port_no;
1650 break;
1651 }
1652 adev = hub;
1653 hub = hub->parent_hub;
1654 }
1655
1656 /* init the default endpoint */
1657 usb_init_endpoint(udev, 0,
1658 &udev->ctrl_ep_desc,
1659 &udev->ctrl_ep_comp_desc,
1660 &udev->ctrl_ep);
1661
1662 /* set device index */
1663 udev->device_index = device_index;
1664
1665 #if USB_HAVE_UGEN
1666 /* Create ugen name */
1667 ksnprintf(udev->ugen_name, sizeof(udev->ugen_name),
1668 USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev),
1669 device_index);
1670 LIST_INIT(&udev->pd_list);
1671
1672 /* Create the control endpoint device */
1673 udev->ctrl_dev = usb_make_dev(udev, NULL, 0, 0,
1674 FREAD|FWRITE, UID_ROOT, GID_OPERATOR, 0600);
1675
1676 /* Create a link from /dev/ugenX.X to the default endpoint */
1677 if (udev->ctrl_dev != NULL)
1678 make_dev_alias(udev->ctrl_dev->cdev, "%s", udev->ugen_name);
1679 #endif
1680 /* Initialise device */
1681 if (bus->methods->device_init != NULL) {
1682 err = (bus->methods->device_init) (udev);
1683 if (err != 0) {
1684 DPRINTFN(0, "device init %d failed "
1685 "(%s, ignored)\n", device_index,
1686 usbd_errstr(err));
1687 goto done;
1688 }
1689 }
1690 /* set powered device state after device init is complete */
1691 usb_set_device_state(udev, USB_STATE_POWERED);
1692
1693 if (udev->flags.usb_mode == USB_MODE_HOST) {
1694
1695 err = usbd_req_set_address(udev, NULL, device_index);
1696
1697 /*
1698 * This is the new USB device address from now on, if
1699 * the set address request didn't set it already.
1700 */
1701 if (udev->address == USB_START_ADDR)
1702 udev->address = device_index;
1703
1704 /*
1705 * We ignore any set-address errors, hence there are
1706 * buggy USB devices out there that actually receive
1707 * the SETUP PID, but manage to set the address before
1708 * the STATUS stage is ACK'ed. If the device responds
1709 * to the subsequent get-descriptor at the new
1710 * address, then we know that the set-address command
1711 * was successful.
1712 */
1713 if (err) {
1714 DPRINTFN(0, "set address %d failed "
1715 "(%s, ignored)\n", udev->address,
1716 usbd_errstr(err));
1717 }
1718 } else {
1719 /* We are not self powered */
1720 udev->flags.self_powered = 0;
1721
1722 /* Set unconfigured state */
1723 udev->curr_config_no = USB_UNCONFIG_NO;
1724 udev->curr_config_index = USB_UNCONFIG_INDEX;
1725
1726 /* Setup USB descriptors */
1727 err = (usb_temp_setup_by_index_p) (udev, usb_template);
1728 if (err) {
1729 DPRINTFN(0, "setting up USB template failed maybe the USB "
1730 "template module has not been loaded\n");
1731 goto done;
1732 }
1733 }
1734 usb_set_device_state(udev, USB_STATE_ADDRESSED);
1735
1736 /* setup the device descriptor and the initial "wMaxPacketSize" */
1737 err = usbd_setup_device_desc(udev, NULL);
1738
1739 if (err != 0) {
1740 /* try to enumerate two more times */
1741 err = usbd_req_re_enumerate(udev, NULL);
1742 if (err != 0) {
1743 err = usbd_req_re_enumerate(udev, NULL);
1744 if (err != 0) {
1745 goto done;
1746 }
1747 }
1748 }
1749
1750 /*
1751 * Setup temporary USB attach args so that we can figure out some
1752 * basic quirks for this device.
1753 */
1754 usb_init_attach_arg(udev, &uaa);
1755
1756 if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) {
1757 udev->flags.uq_bus_powered = 1;
1758 }
1759 if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) {
1760 udev->flags.no_strings = 1;
1761 }
1762 /*
1763 * Workaround for buggy USB devices.
1764 *
1765 * It appears that some string-less USB chips will crash and
1766 * disappear if any attempts are made to read any string
1767 * descriptors.
1768 *
1769 * Try to detect such chips by checking the strings in the USB
1770 * device descriptor. If no strings are present there we
1771 * simply disable all USB strings.
1772 */
1773
1774 /* Protect scratch area */
1775 do_unlock = usbd_enum_lock(udev);
1776
1777 scratch_ptr = udev->scratch.data;
1778
1779 if (udev->ddesc.iManufacturer ||
1780 udev->ddesc.iProduct ||
1781 udev->ddesc.iSerialNumber) {
1782 /* read out the language ID string */
1783 err = usbd_req_get_string_desc(udev, NULL,
1784 (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE);
1785 } else {
1786 err = USB_ERR_INVAL;
1787 }
1788
1789 if (err || (scratch_ptr[0] < 4)) {
1790 udev->flags.no_strings = 1;
1791 } else {
1792 uint16_t langid;
1793 uint16_t pref;
1794 uint16_t mask;
1795 uint8_t x;
1796
1797 /* load preferred value and mask */
1798 pref = usb_lang_id;
1799 mask = usb_lang_mask;
1800
1801 /* align length correctly */
1802 scratch_ptr[0] &= ~1U;
1803
1804 /* fix compiler warning */
1805 langid = 0;
1806
1807 /* search for preferred language */
1808 for (x = 2; (x < scratch_ptr[0]); x += 2) {
1809 langid = UGETW(scratch_ptr + x);
1810 if ((langid & mask) == pref)
1811 break;
1812 }
1813 if (x >= scratch_ptr[0]) {
1814 /* pick the first language as the default */
1815 DPRINTFN(1, "Using first language\n");
1816 langid = UGETW(scratch_ptr + 2);
1817 }
1818
1819 DPRINTFN(1, "Language selected: 0x%04x\n", langid);
1820 udev->langid = langid;
1821 }
1822
1823 if (do_unlock)
1824 usbd_enum_unlock(udev);
1825
1826 /* assume 100mA bus powered for now. Changed when configured. */
1827 udev->power = USB_MIN_POWER;
1828 /* fetch the vendor and product strings from the device */
1829 usbd_set_device_strings(udev);
1830
1831 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
1832 /* USB device mode setup is complete */
1833 err = 0;
1834 goto config_done;
1835 }
1836
1837 /*
1838 * Most USB devices should attach to config index 0 by
1839 * default
1840 */
1841 if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) {
1842 config_index = 0;
1843 config_quirk = 1;
1844 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) {
1845 config_index = 1;
1846 config_quirk = 1;
1847 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) {
1848 config_index = 2;
1849 config_quirk = 1;
1850 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) {
1851 config_index = 3;
1852 config_quirk = 1;
1853 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) {
1854 config_index = 4;
1855 config_quirk = 1;
1856 } else {
1857 config_index = 0;
1858 config_quirk = 0;
1859 }
1860
1861 set_config_failed = 0;
1862 repeat_set_config:
1863
1864 DPRINTF("setting config %u\n", config_index);
1865
1866 /* get the USB device configured */
1867 err = usbd_set_config_index(udev, config_index);
1868 if (err) {
1869 if (udev->ddesc.bNumConfigurations != 0) {
1870 if (!set_config_failed) {
1871 set_config_failed = 1;
1872 /* XXX try to re-enumerate the device */
1873 err = usbd_req_re_enumerate(udev, NULL);
1874 if (err == 0)
1875 goto repeat_set_config;
1876 }
1877 DPRINTFN(0, "Failure selecting configuration index %u:"
1878 "%s, port %u, addr %u (ignored)\n",
1879 config_index, usbd_errstr(err), udev->port_no,
1880 udev->address);
1881 }
1882 /*
1883 * Some USB devices do not have any configurations. Ignore any
1884 * set config failures!
1885 */
1886 err = 0;
1887 goto config_done;
1888 }
1889 if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) {
1890 if ((udev->cdesc->bNumInterface < 2) &&
1891 usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) {
1892 DPRINTFN(0, "Found no endpoints, trying next config\n");
1893 config_index++;
1894 goto repeat_set_config;
1895 }
1896 #if USB_HAVE_MSCTEST
1897 if (config_index == 0) {
1898 /*
1899 * Try to figure out if we have an
1900 * auto-install disk there:
1901 */
1902 if (usb_iface_is_cdrom(udev, 0)) {
1903 DPRINTFN(0, "Found possible auto-install "
1904 "disk (trying next config)\n");
1905 config_index++;
1906 goto repeat_set_config;
1907 }
1908 }
1909 #endif
1910 }
1911 #if USB_HAVE_MSCTEST
1912 if (set_config_failed == 0 && config_index == 0 &&
1913 usb_test_quirk(&uaa, UQ_MSC_NO_SYNC_CACHE) == 0 &&
1914 usb_test_quirk(&uaa, UQ_MSC_NO_GETMAXLUN) == 0) {
1915
1916 /*
1917 * Try to figure out if there are any MSC quirks we
1918 * should apply automatically:
1919 */
1920 err = usb_msc_auto_quirk(udev, 0);
1921
1922 if (err != 0) {
1923 set_config_failed = 1;
1924 goto repeat_set_config;
1925 }
1926 }
1927 #endif
1928
1929 config_done:
1930 DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n",
1931 udev->address, udev, udev->parent_hub);
1932
1933 /* register our device - we are ready */
1934 usb_bus_port_set_device(bus, parent_hub ?
1935 parent_hub->hub->ports + port_index : NULL, udev, device_index);
1936
1937 #if USB_HAVE_UGEN
1938 /* Symlink the ugen device name */
1939 udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name);
1940
1941 /* Announce device */
1942 kprintf("%s: <%s> at %s\n", udev->ugen_name,
1943 usb_get_manufacturer(udev),
1944 device_get_nameunit(udev->bus->bdev));
1945 #endif
1946
1947 #if USB_HAVE_DEVCTL
1948 usb_notify_addq("ATTACH", udev);
1949 #endif
1950 done:
1951 if (err) {
1952 /*
1953 * Free USB device and all subdevices, if any.
1954 */
1955 usb_free_device(udev, 0);
1956 udev = NULL;
1957 }
1958 return (udev);
1959 }
1960
1961 #if USB_HAVE_UGEN
1962 struct usb_fs_privdata *
1963 usb_make_dev(struct usb_device *udev, const char *devname, int ep,
1964 int fi, int rwmode, uid_t uid, gid_t gid, int mode)
1965 {
1966 struct usb_fs_privdata* pd;
1967 char buffer[32];
1968
1969 /* Store information to locate ourselves again later */
1970 pd = kmalloc(sizeof(struct usb_fs_privdata), M_USBDEV,
1971 M_WAITOK | M_ZERO);
1972 pd->bus_index = device_get_unit(udev->bus->bdev);
1973 pd->dev_index = udev->device_index;
1974 pd->ep_addr = ep;
1975 pd->fifo_index = fi;
1976 pd->mode = rwmode;
1977
1978 /* Now, create the device itself */
1979 if (devname == NULL) {
1980 devname = buffer;
1981 ksnprintf(buffer, sizeof(buffer), USB_DEVICE_DIR "/%u.%u.%u",
1982 pd->bus_index, pd->dev_index, pd->ep_addr);
1983 }
1984
1985 pd->cdev = make_dev(&usb_ops, 0, uid, gid, mode, "%s", devname);
1986
1987 if (pd->cdev == NULL) {
1988 DPRINTFN(0, "Failed to create device %s\n", devname);
1989 kfree(pd, M_USBDEV);
1990 return (NULL);
1991 }
1992
1993 /* XXX setting si_drv1 and creating the device is not atomic! */
1994 pd->cdev->si_drv1 = pd;
1995
1996 return (pd);
1997 }
1998
1999 void
2000 usb_destroy_dev_sync(struct usb_fs_privdata *pd)
2001 {
2002 DPRINTFN(1, "Destroying device at ugen%d.%d\n",
2003 pd->bus_index, pd->dev_index);
2004
2005 /*
2006 * Destroy character device synchronously. After this
2007 * all system calls are returned. Can block.
2008 */
2009 destroy_dev(pd->cdev);
2010
2011 kfree(pd, M_USBDEV);
2012 }
2013
2014 void
2015 usb_destroy_dev(struct usb_fs_privdata *pd)
2016 {
2017 struct usb_bus *bus;
2018
2019 if (pd == NULL)
2020 return;
2021
2022 lockmgr(&usb_ref_lock, LK_EXCLUSIVE);
2023 bus = devclass_get_softc(usb_devclass_ptr, pd->bus_index);
2024 lockmgr(&usb_ref_lock, LK_RELEASE);
2025
2026 if (bus == NULL) {
2027 usb_destroy_dev_sync(pd);
2028 return;
2029 }
2030
2031 #if 0
2032 /* XXX what is FreeBSD doing here? */
2033 /* make sure we can re-use the device name */
2034 delist_dev(pd->cdev);
2035 #endif
2036
2037 USB_BUS_LOCK(bus);
2038 LIST_INSERT_HEAD(&bus->pd_cleanup_list, pd, pd_next);
2039 /* get cleanup going */
2040 usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus),
2041 &bus->cleanup_msg[0], &bus->cleanup_msg[1]);
2042 USB_BUS_UNLOCK(bus);
2043 }
2044
2045 static void
2046 usb_cdev_create(struct usb_device *udev)
2047 {
2048 struct usb_config_descriptor *cd;
2049 struct usb_endpoint_descriptor *ed;
2050 struct usb_descriptor *desc;
2051 struct usb_fs_privdata* pd;
2052 int inmode, outmode, inmask, outmask, mode;
2053 uint8_t ep;
2054
2055 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries"));
2056
2057 DPRINTFN(2, "Creating device nodes\n");
2058
2059 if (usbd_get_mode(udev) == USB_MODE_DEVICE) {
2060 inmode = FWRITE;
2061 outmode = FREAD;
2062 } else { /* USB_MODE_HOST */
2063 inmode = FREAD;
2064 outmode = FWRITE;
2065 }
2066
2067 inmask = 0;
2068 outmask = 0;
2069 desc = NULL;
2070
2071 /*
2072 * Collect all used endpoint numbers instead of just
2073 * generating 16 static endpoints.
2074 */
2075 cd = usbd_get_config_descriptor(udev);
2076 while ((desc = usb_desc_foreach(cd, desc))) {
2077 /* filter out all endpoint descriptors */
2078 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
2079 (desc->bLength >= sizeof(*ed))) {
2080 ed = (struct usb_endpoint_descriptor *)desc;
2081
2082 /* update masks */
2083 ep = ed->bEndpointAddress;
2084 if (UE_GET_DIR(ep) == UE_DIR_OUT)
2085 outmask |= 1 << UE_GET_ADDR(ep);
2086 else
2087 inmask |= 1 << UE_GET_ADDR(ep);
2088 }
2089 }
2090
2091 /* Create all available endpoints except EP0 */
2092 for (ep = 1; ep < 16; ep++) {
2093 mode = (inmask & (1 << ep)) ? inmode : 0;
2094 mode |= (outmask & (1 << ep)) ? outmode : 0;
2095 if (mode == 0)
2096 continue; /* no IN or OUT endpoint */
2097
2098 pd = usb_make_dev(udev, NULL, ep, 0,
2099 mode, UID_ROOT, GID_OPERATOR, 0600);
2100
2101 if (pd != NULL)
2102 LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next);
2103 }
2104 }
2105
2106 static void
2107 usb_cdev_free(struct usb_device *udev)
2108 {
2109 struct usb_fs_privdata* pd;
2110
2111 DPRINTFN(2, "Freeing device nodes\n");
2112
2113 while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) {
2114 KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt"));
2115
2116 LIST_REMOVE(pd, pd_next);
2117
2118 usb_destroy_dev(pd);
2119 }
2120 }
2121 #endif
2122
2123 /*------------------------------------------------------------------------*
2124 * usb_free_device
2125 *
2126 * This function is NULL safe and will free an USB device and its
2127 * children devices, if any.
2128 *
2129 * Flag values: Reserved, set to zero.
2130 *------------------------------------------------------------------------*/
2131 void
2132 usb_free_device(struct usb_device *udev, uint8_t flag)
2133 {
2134 struct usb_bus *bus;
2135
2136 if (udev == NULL)
2137 return; /* already freed */
2138
2139 DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no);
2140
2141 bus = udev->bus;
2142
2143 /* set DETACHED state to prevent any further references */
2144 usb_set_device_state(udev, USB_STATE_DETACHED);
2145
2146 #if USB_HAVE_DEVCTL
2147 usb_notify_addq("DETACH", udev);
2148 #endif
2149
2150 #if USB_HAVE_UGEN
2151 kprintf("%s: <%s> at %s (disconnected)\n", udev->ugen_name,
2152 usb_get_manufacturer(udev), device_get_nameunit(bus->bdev));
2153
2154 /* Destroy UGEN symlink, if any */
2155 if (udev->ugen_symlink) {
2156 usb_free_symlink(udev->ugen_symlink);
2157 udev->ugen_symlink = NULL;
2158 }
2159
2160 usb_destroy_dev(udev->ctrl_dev);
2161 #endif
2162
2163 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2164 /* stop receiving any control transfers (Device Side Mode) */
2165 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2166 }
2167
2168 /* the following will get the device unconfigured in software */
2169 usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0);
2170
2171 /* final device unregister after all character devices are closed */
2172 usb_bus_port_set_device(bus, udev->parent_hub ?
2173 udev->parent_hub->hub->ports + udev->port_index : NULL,
2174 NULL, USB_ROOT_HUB_ADDR);
2175
2176 /* unsetup any leftover default USB transfers */
2177 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2178
2179 /* template unsetup, if any */
2180 (usb_temp_unsetup_p) (udev);
2181
2182 /*
2183 * Make sure that our clear-stall messages are not queued
2184 * anywhere:
2185 */
2186 USB_BUS_LOCK(udev->bus);
2187 usb_proc_mwait(USB_BUS_NON_GIANT_PROC(udev->bus),
2188 &udev->cs_msg[0], &udev->cs_msg[1]);
2189 USB_BUS_UNLOCK(udev->bus);
2190
2191 /* wait for all references to go away */
2192 usb_wait_pending_refs(udev);
2193
2194 lockuninit(&udev->enum_lock);
2195 lockuninit(&udev->sr_lock);
2196
2197 cv_destroy(&udev->ctrlreq_cv);
2198 cv_destroy(&udev->ref_cv);
2199
2200 lockuninit(&udev->device_lock);
2201 #if USB_HAVE_UGEN
2202 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries"));
2203 #endif
2204
2205 /* Uninitialise device */
2206 if (bus->methods->device_uninit != NULL)
2207 (bus->methods->device_uninit) (udev);
2208
2209 /* free device */
2210 if(udev->serial)
2211 kfree(udev->serial, M_USB);
2212 if(udev->manufacturer)
2213 kfree(udev->manufacturer, M_USB);
2214 if(udev->product)
2215 kfree(udev->product, M_USB);
2216 kfree(udev, M_USB);
2217 }
2218
2219 /*------------------------------------------------------------------------*
2220 * usbd_get_iface
2221 *
2222 * This function is the safe way to get the USB interface structure
2223 * pointer by interface index.
2224 *
2225 * Return values:
2226 * NULL: Interface not present.
2227 * Else: Pointer to USB interface structure.
2228 *------------------------------------------------------------------------*/
2229 struct usb_interface *
2230 usbd_get_iface(struct usb_device *udev, uint8_t iface_index)
2231 {
2232 struct usb_interface *iface = udev->ifaces + iface_index;
2233
2234 if (iface_index >= udev->ifaces_max)
2235 return (NULL);
2236 return (iface);
2237 }
2238
2239 /*------------------------------------------------------------------------*
2240 * usbd_find_descriptor
2241 *
2242 * This function will lookup the first descriptor that matches the
2243 * criteria given by the arguments "type" and "subtype". Descriptors
2244 * will only be searched within the interface having the index
2245 * "iface_index". If the "id" argument points to an USB descriptor,
2246 * it will be skipped before the search is started. This allows
2247 * searching for multiple descriptors using the same criteria. Else
2248 * the search is started after the interface descriptor.
2249 *
2250 * Return values:
2251 * NULL: End of descriptors
2252 * Else: A descriptor matching the criteria
2253 *------------------------------------------------------------------------*/
2254 void *
2255 usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index,
2256 uint8_t type, uint8_t type_mask,
2257 uint8_t subtype, uint8_t subtype_mask)
2258 {
2259 struct usb_descriptor *desc;
2260 struct usb_config_descriptor *cd;
2261 struct usb_interface *iface;
2262
2263 cd = usbd_get_config_descriptor(udev);
2264 if (cd == NULL) {
2265 return (NULL);
2266 }
2267 if (id == NULL) {
2268 iface = usbd_get_iface(udev, iface_index);
2269 if (iface == NULL) {
2270 return (NULL);
2271 }
2272 id = usbd_get_interface_descriptor(iface);
2273 if (id == NULL) {
2274 return (NULL);
2275 }
2276 }
2277 desc = (void *)id;
2278
2279 while ((desc = usb_desc_foreach(cd, desc))) {
2280
2281 if (desc->bDescriptorType == UDESC_INTERFACE) {
2282 break;
2283 }
2284 if (((desc->bDescriptorType & type_mask) == type) &&
2285 ((desc->bDescriptorSubtype & subtype_mask) == subtype)) {
2286 return (desc);
2287 }
2288 }
2289 return (NULL);
2290 }
2291
2292 /*------------------------------------------------------------------------*
2293 * usb_devinfo
2294 *
2295 * This function will dump information from the device descriptor
2296 * belonging to the USB device pointed to by "udev", to the string
2297 * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes
2298 * including the terminating zero.
2299 *------------------------------------------------------------------------*/
2300 void
2301 usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len)
2302 {
2303 struct usb_device_descriptor *udd = &udev->ddesc;
2304 uint16_t bcdDevice;
2305 uint16_t bcdUSB;
2306
2307 bcdUSB = UGETW(udd->bcdUSB);
2308 bcdDevice = UGETW(udd->bcdDevice);
2309
2310 if (udd->bDeviceClass != 0xFF) {
2311 ksnprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/"
2312 "%x.%02x, addr %d",
2313 usb_get_manufacturer(udev),
2314 usb_get_product(udev),
2315 udd->bDeviceClass, udd->bDeviceSubClass,
2316 (bcdUSB >> 8), bcdUSB & 0xFF,
2317 (bcdDevice >> 8), bcdDevice & 0xFF,
2318 udev->address);
2319 } else {
2320 ksnprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/"
2321 "%x.%02x, addr %d",
2322 usb_get_manufacturer(udev),
2323 usb_get_product(udev),
2324 (bcdUSB >> 8), bcdUSB & 0xFF,
2325 (bcdDevice >> 8), bcdDevice & 0xFF,
2326 udev->address);
2327 }
2328 }
2329
2330 #ifdef USB_VERBOSE
2331 /*
2332 * Descriptions of of known vendors and devices ("products").
2333 */
2334 struct usb_knowndev {
2335 uint16_t vendor;
2336 uint16_t product;
2337 uint32_t flags;
2338 const char *vendorname;
2339 const char *productname;
2340 };
2341
2342 #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */
2343
2344 #include "usbdevs.h"
2345 #include "usbdevs_data.h"
2346 #endif /* USB_VERBOSE */
2347
2348 static void
2349 usbd_set_device_strings(struct usb_device *udev)
2350 {
2351 struct usb_device_descriptor *udd = &udev->ddesc;
2352 #ifdef USB_VERBOSE
2353 const struct usb_knowndev *kdp;
2354 #endif
2355 char *temp_ptr;
2356 size_t temp_size;
2357 uint16_t vendor_id;
2358 uint16_t product_id;
2359 uint8_t do_unlock;
2360
2361 /* Protect scratch area */
2362 do_unlock = usbd_enum_lock(udev);
2363
2364 temp_ptr = (char *)udev->scratch.data;
2365 temp_size = sizeof(udev->scratch.data);
2366
2367 vendor_id = UGETW(udd->idVendor);
2368 product_id = UGETW(udd->idProduct);
2369
2370 /* get serial number string */
2371 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2372 udev->ddesc.iSerialNumber);
2373 udev->serial = kstrdup(temp_ptr, M_USB);
2374
2375 /* get manufacturer string */
2376 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2377 udev->ddesc.iManufacturer);
2378 usb_trim_spaces(temp_ptr);
2379 if (temp_ptr[0] != '\0')
2380 udev->manufacturer = kstrdup(temp_ptr, M_USB);
2381
2382 /* get product string */
2383 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2384 udev->ddesc.iProduct);
2385 usb_trim_spaces(temp_ptr);
2386 if (temp_ptr[0] != '\0')
2387 udev->product = kstrdup(temp_ptr, M_USB);
2388
2389 #ifdef USB_VERBOSE
2390 if (udev->manufacturer == NULL || udev->product == NULL) {
2391 for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) {
2392 if (kdp->vendor == vendor_id &&
2393 (kdp->product == product_id ||
2394 (kdp->flags & USB_KNOWNDEV_NOPROD) != 0))
2395 break;
2396 }
2397 if (kdp->vendorname != NULL) {
2398 /* XXX should use pointer to knowndevs string */
2399 if (udev->manufacturer == NULL) {
2400 udev->manufacturer = kstrdup(kdp->vendorname,
2401 M_USB);
2402 }
2403 if (udev->product == NULL &&
2404 (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) {
2405 udev->product = kstrdup(kdp->productname,
2406 M_USB);
2407 }
2408 }
2409 }
2410 #endif
2411 /* Provide default strings if none were found */
2412 if (udev->manufacturer == NULL) {
2413 ksnprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id);
2414 udev->manufacturer = kstrdup(temp_ptr, M_USB);
2415 }
2416 if (udev->product == NULL) {
2417 ksnprintf(temp_ptr, temp_size, "product 0x%04x", product_id);
2418 udev->product = kstrdup(temp_ptr, M_USB);
2419 }
2420
2421 if (do_unlock)
2422 usbd_enum_unlock(udev);
2423 }
2424
2425 /*
2426 * Returns:
2427 * See: USB_MODE_XXX
2428 */
2429 enum usb_hc_mode
2430 usbd_get_mode(struct usb_device *udev)
2431 {
2432 return (udev->flags.usb_mode);
2433 }
2434
2435 /*
2436 * Returns:
2437 * See: USB_SPEED_XXX
2438 */
2439 enum usb_dev_speed
2440 usbd_get_speed(struct usb_device *udev)
2441 {
2442 return (udev->speed);
2443 }
2444
2445 uint32_t
2446 usbd_get_isoc_fps(struct usb_device *udev)
2447 {
2448 ; /* indent fix */
2449 switch (udev->speed) {
2450 case USB_SPEED_LOW:
2451 case USB_SPEED_FULL:
2452 return (1000);
2453 default:
2454 return (8000);
2455 }
2456 }
2457
2458 struct usb_device_descriptor *
2459 usbd_get_device_descriptor(struct usb_device *udev)
2460 {
2461 if (udev == NULL)
2462 return (NULL); /* be NULL safe */
2463 return (&udev->ddesc);
2464 }
2465
2466 struct usb_config_descriptor *
2467 usbd_get_config_descriptor(struct usb_device *udev)
2468 {
2469 if (udev == NULL)
2470 return (NULL); /* be NULL safe */
2471 return (udev->cdesc);
2472 }
2473
2474 /*------------------------------------------------------------------------*
2475 * usb_test_quirk - test a device for a given quirk
2476 *
2477 * Return values:
2478 * 0: The USB device does not have the given quirk.
2479 * Else: The USB device has the given quirk.
2480 *------------------------------------------------------------------------*/
2481 uint8_t
2482 usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk)
2483 {
2484 uint8_t found;
2485 uint8_t x;
2486
2487 if (quirk == UQ_NONE)
2488 return (0);
2489
2490 /* search the automatic per device quirks first */
2491
2492 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2493 if (uaa->device->autoQuirk[x] == quirk)
2494 return (1);
2495 }
2496
2497 /* search global quirk table, if any */
2498
2499 found = (usb_test_quirk_p) (&uaa->info, quirk);
2500
2501 return (found);
2502 }
2503
2504 struct usb_interface_descriptor *
2505 usbd_get_interface_descriptor(struct usb_interface *iface)
2506 {
2507 if (iface == NULL)
2508 return (NULL); /* be NULL safe */
2509 return (iface->idesc);
2510 }
2511
2512 uint8_t
2513 usbd_get_interface_altindex(struct usb_interface *iface)
2514 {
2515 return (iface->alt_index);
2516 }
2517
2518 uint8_t
2519 usbd_get_bus_index(struct usb_device *udev)
2520 {
2521 return ((uint8_t)device_get_unit(udev->bus->bdev));
2522 }
2523
2524 uint8_t
2525 usbd_get_device_index(struct usb_device *udev)
2526 {
2527 return (udev->device_index);
2528 }
2529
2530 #if USB_HAVE_DEVCTL
2531 static void
2532 usb_notify_addq(const char *type, struct usb_device *udev)
2533 {
2534 struct usb_interface *iface;
2535 struct sbuf *sb;
2536 int i;
2537
2538 /* announce the device */
2539 sb = sbuf_new(NULL, NULL, 4096, SBUF_AUTOEXTEND);
2540 sbuf_printf(sb,
2541 #if USB_HAVE_UGEN
2542 "ugen=%s "
2543 "cdev=%s "
2544 #endif
2545 "vendor=0x%04x "
2546 "product=0x%04x "
2547 "devclass=0x%02x "
2548 "devsubclass=0x%02x "
2549 "sernum=\"%s\" "
2550 "release=0x%04x "
2551 "mode=%s "
2552 "port=%u "
2553 #if USB_HAVE_UGEN
2554 "parent=%s"
2555 #endif
2556 "",
2557 #if USB_HAVE_UGEN
2558 udev->ugen_name,
2559 udev->ugen_name,
2560 #endif
2561 UGETW(udev->ddesc.idVendor),
2562 UGETW(udev->ddesc.idProduct),
2563 udev->ddesc.bDeviceClass,
2564 udev->ddesc.bDeviceSubClass,
2565 usb_get_serial(udev),
2566 UGETW(udev->ddesc.bcdDevice),
2567 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2568 udev->port_no
2569 #if USB_HAVE_UGEN
2570 , udev->parent_hub != NULL ?
2571 udev->parent_hub->ugen_name :
2572 device_get_nameunit(device_get_parent(udev->bus->bdev))
2573 #endif
2574 );
2575 sbuf_finish(sb);
2576 devctl_notify("USB", "DEVICE", type, sbuf_data(sb));
2577 sbuf_delete(sb);
2578
2579 /* announce each interface */
2580 for (i = 0; i < USB_IFACE_MAX; i++) {
2581 iface = usbd_get_iface(udev, i);
2582 if (iface == NULL)
2583 break; /* end of interfaces */
2584 if (iface->idesc == NULL)
2585 continue; /* no interface descriptor */
2586
2587 sb = NULL;
2588 sb = sbuf_new(NULL, NULL, 4096, SBUF_AUTOEXTEND);
2589 sbuf_printf(sb,
2590 #if USB_HAVE_UGEN
2591 "ugen=%s "
2592 "cdev=%s "
2593 #endif
2594 "vendor=0x%04x "
2595 "product=0x%04x "
2596 "devclass=0x%02x "
2597 "devsubclass=0x%02x "
2598 "sernum=\"%s\" "
2599 "release=0x%04x "
2600 "mode=%s "
2601 "interface=%d "
2602 "endpoints=%d "
2603 "intclass=0x%02x "
2604 "intsubclass=0x%02x "
2605 "intprotocol=0x%02x",
2606 #if USB_HAVE_UGEN
2607 udev->ugen_name,
2608 udev->ugen_name,
2609 #endif
2610 UGETW(udev->ddesc.idVendor),
2611 UGETW(udev->ddesc.idProduct),
2612 udev->ddesc.bDeviceClass,
2613 udev->ddesc.bDeviceSubClass,
2614 usb_get_serial(udev),
2615 UGETW(udev->ddesc.bcdDevice),
2616 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2617 iface->idesc->bInterfaceNumber,
2618 iface->idesc->bNumEndpoints,
2619 iface->idesc->bInterfaceClass,
2620 iface->idesc->bInterfaceSubClass,
2621 iface->idesc->bInterfaceProtocol);
2622 sbuf_finish(sb);
2623 devctl_notify("USB", "INTERFACE", type, sbuf_data(sb));
2624 sbuf_delete(sb);
2625 }
2626 }
2627 #endif
2628
2629 #if USB_HAVE_UGEN
2630 /*------------------------------------------------------------------------*
2631 * usb_fifo_free_wrap
2632 *
2633 * This function will free the FIFOs.
2634 *
2635 * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag
2636 * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free
2637 * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and
2638 * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non
2639 * control endpoint FIFOs. If "iface_index" is not set to
2640 * "USB_IFACE_INDEX_ANY" the flag has no effect.
2641 *------------------------------------------------------------------------*/
2642 static void
2643 usb_fifo_free_wrap(struct usb_device *udev,
2644 uint8_t iface_index, uint8_t flag)
2645 {
2646 struct usb_fifo *f;
2647 uint16_t i;
2648
2649 /*
2650 * Free any USB FIFOs on the given interface:
2651 */
2652 for (i = 0; i != USB_FIFO_MAX; i++) {
2653 f = udev->fifo[i];
2654 if (f == NULL) {
2655 continue;
2656 }
2657 /* Check if the interface index matches */
2658 if (iface_index == f->iface_index) {
2659 if (f->methods != &usb_ugen_methods) {
2660 /*
2661 * Don't free any non-generic FIFOs in
2662 * this case.
2663 */
2664 continue;
2665 }
2666 if ((f->dev_ep_index == 0) &&
2667 (f->fs_xfer == NULL)) {
2668 /* no need to free this FIFO */
2669 continue;
2670 }
2671 } else if (iface_index == USB_IFACE_INDEX_ANY) {
2672 if ((f->methods == &usb_ugen_methods) &&
2673 (f->dev_ep_index == 0) &&
2674 (!(flag & USB_UNCFG_FLAG_FREE_EP0)) &&
2675 (f->fs_xfer == NULL)) {
2676 /* no need to free this FIFO */
2677 continue;
2678 }
2679 } else {
2680 /* no need to free this FIFO */
2681 continue;
2682 }
2683 /* free this FIFO */
2684 usb_fifo_free(f);
2685 }
2686 }
2687 #endif
2688
2689 /*------------------------------------------------------------------------*
2690 * usb_peer_can_wakeup
2691 *
2692 * Return values:
2693 * 0: Peer cannot do resume signalling.
2694 * Else: Peer can do resume signalling.
2695 *------------------------------------------------------------------------*/
2696 uint8_t
2697 usb_peer_can_wakeup(struct usb_device *udev)
2698 {
2699 const struct usb_config_descriptor *cdp;
2700
2701 cdp = udev->cdesc;
2702 if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) {
2703 return (cdp->bmAttributes & UC_REMOTE_WAKEUP);
2704 }
2705 return (0); /* not supported */
2706 }
2707
2708 void
2709 usb_set_device_state(struct usb_device *udev, enum usb_dev_state state)
2710 {
2711
2712 KASSERT(state < USB_STATE_MAX, ("invalid udev state"));
2713
2714 DPRINTF("udev %p state %s -> %s\n", udev,
2715 usb_statestr(udev->state), usb_statestr(state));
2716
2717 #if USB_HAVE_UGEN
2718 lockmgr(&usb_ref_lock, LK_EXCLUSIVE);
2719 #endif
2720 udev->state = state;
2721 #if USB_HAVE_UGEN
2722 lockmgr(&usb_ref_lock, LK_RELEASE);
2723 #endif
2724 if (udev->bus->methods->device_state_change != NULL)
2725 (udev->bus->methods->device_state_change) (udev);
2726 }
2727
2728 enum usb_dev_state
2729 usb_get_device_state(struct usb_device *udev)
2730 {
2731 if (udev == NULL)
2732 return (USB_STATE_DETACHED);
2733 return (udev->state);
2734 }
2735
2736 uint8_t
2737 usbd_device_attached(struct usb_device *udev)
2738 {
2739 return (udev->state > USB_STATE_DETACHED);
2740 }
2741
2742 /*
2743 * The following function locks enumerating the given USB device. If
2744 * the lock is already grabbed this function returns zero. Else a
2745 * non-zero value is returned.
2746 */
2747 uint8_t
2748 usbd_enum_lock(struct usb_device *udev)
2749 {
2750 if (lockstatus(&udev->enum_lock, curthread)==LK_EXCLUSIVE)
2751 return (0);
2752
2753 lockmgr(&udev->enum_lock, LK_EXCLUSIVE);
2754 lockmgr(&udev->sr_lock, LK_EXCLUSIVE);
2755 /*
2756 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2757 * are locked before locking Giant. Else the lock can be
2758 * locked multiple times.
2759 */
2760 return (1);
2761 }
2762
2763 /* The following function unlocks enumerating the given USB device. */
2764
2765 void
2766 usbd_enum_unlock(struct usb_device *udev)
2767 {
2768 lockmgr(&udev->enum_lock, LK_RELEASE);
2769 lockmgr(&udev->sr_lock, LK_RELEASE);
2770 }
2771
2772 /* The following function locks suspend and resume. */
2773
2774 void
2775 usbd_sr_lock(struct usb_device *udev)
2776 {
2777 lockmgr(&udev->sr_lock, LK_EXCLUSIVE);
2778 /*
2779 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2780 * are locked before locking Giant. Else the lock can be
2781 * locked multiple times.
2782 */
2783 }
2784
2785 /* The following function unlocks suspend and resume. */
2786
2787 void
2788 usbd_sr_unlock(struct usb_device *udev)
2789 {
2790 lockmgr(&udev->sr_lock, LK_RELEASE);
2791 }
2792
2793 /*
2794 * The following function checks the enumerating lock for the given
2795 * USB device.
2796 */
2797
2798 uint8_t
2799 usbd_enum_is_locked(struct usb_device *udev)
2800 {
2801 /* XXX: Make sure that we return a correct value here */
2802 return (lockowned(&udev->enum_lock));
2803 }
2804
2805 /*
2806 * The following function is used to set the per-interface specific
2807 * plug and play information. The string referred to by the pnpinfo
2808 * argument can safely be freed after calling this function. The
2809 * pnpinfo of an interface will be reset at device detach or when
2810 * passing a NULL argument to this function. This function
2811 * returns zero on success, else a USB_ERR_XXX failure code.
2812 */
2813
2814 usb_error_t
2815 usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo)
2816 {
2817 struct usb_interface *iface;
2818
2819 iface = usbd_get_iface(udev, iface_index);
2820 if (iface == NULL)
2821 return (USB_ERR_INVAL);
2822
2823 if (iface->pnpinfo != NULL) {
2824 kfree(iface->pnpinfo, M_USBDEV);
2825 iface->pnpinfo = NULL;
2826 }
2827
2828 if (pnpinfo == NULL || pnpinfo[0] == 0)
2829 return (0); /* success */
2830
2831 iface->pnpinfo = kstrdup(pnpinfo, M_USBDEV);
2832 if (iface->pnpinfo == NULL)
2833 return (USB_ERR_NOMEM);
2834
2835 return (0); /* success */
2836 }
2837
2838 usb_error_t
2839 usbd_add_dynamic_quirk(struct usb_device *udev, uint16_t quirk)
2840 {
2841 uint8_t x;
2842
2843 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2844 if (udev->autoQuirk[x] == 0 ||
2845 udev->autoQuirk[x] == quirk) {
2846 udev->autoQuirk[x] = quirk;
2847 return (0); /* success */
2848 }
2849 }
2850 return (USB_ERR_NOMEM);
2851 }
2852
2853 /*
2854 * The following function is used to select the endpoint mode. It
2855 * should not be called outside enumeration context.
2856 */
2857
2858 usb_error_t
2859 usbd_set_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep,
2860 uint8_t ep_mode)
2861 {
2862 usb_error_t error;
2863 uint8_t do_unlock;
2864
2865 /* Prevent re-enumeration */
2866 do_unlock = usbd_enum_lock(udev);
2867
2868 if (udev->bus->methods->set_endpoint_mode != NULL) {
2869 error = (udev->bus->methods->set_endpoint_mode) (
2870 udev, ep, ep_mode);
2871 } else if (ep_mode != USB_EP_MODE_DEFAULT) {
2872 error = USB_ERR_INVAL;
2873 } else {
2874 error = 0;
2875 }
2876
2877 /* only set new mode regardless of error */
2878 ep->ep_mode = ep_mode;
2879
2880 if (do_unlock)
2881 usbd_enum_unlock(udev);
2882 return (error);
2883 }
2884
2885 uint8_t
2886 usbd_get_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep)
2887 {
2888 return (ep->ep_mode);
2889 }
DragonFly BSD