102ac6454SAndrew Thompson /* $FreeBSD$ */ 202ac6454SAndrew Thompson /*- 302ac6454SAndrew Thompson * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 402ac6454SAndrew Thompson * 502ac6454SAndrew Thompson * Redistribution and use in source and binary forms, with or without 602ac6454SAndrew Thompson * modification, are permitted provided that the following conditions 702ac6454SAndrew Thompson * are met: 802ac6454SAndrew Thompson * 1. Redistributions of source code must retain the above copyright 902ac6454SAndrew Thompson * notice, this list of conditions and the following disclaimer. 1002ac6454SAndrew Thompson * 2. Redistributions in binary form must reproduce the above copyright 1102ac6454SAndrew Thompson * notice, this list of conditions and the following disclaimer in the 1202ac6454SAndrew Thompson * documentation and/or other materials provided with the distribution. 1302ac6454SAndrew Thompson * 1402ac6454SAndrew Thompson * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1502ac6454SAndrew Thompson * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1602ac6454SAndrew Thompson * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1702ac6454SAndrew Thompson * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1802ac6454SAndrew Thompson * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1902ac6454SAndrew Thompson * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2002ac6454SAndrew Thompson * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2102ac6454SAndrew Thompson * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2202ac6454SAndrew Thompson * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2302ac6454SAndrew Thompson * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2402ac6454SAndrew Thompson * SUCH DAMAGE. 2502ac6454SAndrew Thompson */ 2602ac6454SAndrew Thompson 2702ac6454SAndrew Thompson #include <dev/usb/usb_mfunc.h> 2802ac6454SAndrew Thompson #include <dev/usb/usb_error.h> 2902ac6454SAndrew Thompson #include <dev/usb/usb.h> 3002ac6454SAndrew Thompson #include <dev/usb/usb_ioctl.h> 3102ac6454SAndrew Thompson #include "usbdevs.h" 3202ac6454SAndrew Thompson 3302ac6454SAndrew Thompson #define USB_DEBUG_VAR usb2_debug 3402ac6454SAndrew Thompson 3502ac6454SAndrew Thompson #include <dev/usb/usb_core.h> 3602ac6454SAndrew Thompson #include <dev/usb/usb_debug.h> 3702ac6454SAndrew Thompson #include <dev/usb/usb_process.h> 3802ac6454SAndrew Thompson #include <dev/usb/usb_device.h> 3902ac6454SAndrew Thompson #include <dev/usb/usb_busdma.h> 4002ac6454SAndrew Thompson #include <dev/usb/usb_transfer.h> 4102ac6454SAndrew Thompson #include <dev/usb/usb_parse.h> 4202ac6454SAndrew Thompson #include <dev/usb/usb_request.h> 4302ac6454SAndrew Thompson #include <dev/usb/usb_dynamic.h> 4402ac6454SAndrew Thompson #include <dev/usb/usb_hub.h> 4502ac6454SAndrew Thompson #include <dev/usb/usb_util.h> 4602ac6454SAndrew Thompson #include <dev/usb/usb_mbuf.h> 4702ac6454SAndrew Thompson #include <dev/usb/usb_msctest.h> 48bdc081c6SAndrew Thompson #if USB_HAVE_UGEN 49bdc081c6SAndrew Thompson #include <dev/usb/usb_dev.h> 5002ac6454SAndrew Thompson #include <dev/usb/usb_generic.h> 51bdc081c6SAndrew Thompson #endif 5202ac6454SAndrew Thompson 5302ac6454SAndrew Thompson #include <dev/usb/quirk/usb_quirk.h> 5402ac6454SAndrew Thompson 5502ac6454SAndrew Thompson #include <dev/usb/usb_controller.h> 5602ac6454SAndrew Thompson #include <dev/usb/usb_bus.h> 5702ac6454SAndrew Thompson 5802ac6454SAndrew Thompson /* function prototypes */ 5902ac6454SAndrew Thompson 60bdd41206SAndrew Thompson static void usb2_init_pipe(struct usb2_device *, uint8_t, 6102ac6454SAndrew Thompson struct usb2_endpoint_descriptor *, struct usb2_pipe *); 62bdd41206SAndrew Thompson static void usb2_unconfigure(struct usb2_device *, uint8_t); 63bdd41206SAndrew Thompson static void usb2_detach_device(struct usb2_device *, uint8_t, uint8_t); 6402ac6454SAndrew Thompson static void usb2_detach_device_sub(struct usb2_device *, device_t *, 6502ac6454SAndrew Thompson uint8_t); 6602ac6454SAndrew Thompson static uint8_t usb2_probe_and_attach_sub(struct usb2_device *, 6702ac6454SAndrew Thompson struct usb2_attach_arg *); 6802ac6454SAndrew Thompson static void usb2_init_attach_arg(struct usb2_device *, 6902ac6454SAndrew Thompson struct usb2_attach_arg *); 7002ac6454SAndrew Thompson static void usb2_suspend_resume_sub(struct usb2_device *, device_t, 7102ac6454SAndrew Thompson uint8_t); 7202ac6454SAndrew Thompson static void usb2_clear_stall_proc(struct usb2_proc_msg *_pm); 73bdd41206SAndrew Thompson usb2_error_t usb2_config_parse(struct usb2_device *, uint8_t, uint8_t); 74bdc081c6SAndrew Thompson #if USB_HAVE_STRINGS 7502ac6454SAndrew Thompson static void usb2_check_strings(struct usb2_device *); 76bdc081c6SAndrew Thompson #endif 770f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 788755859aSAndrew Thompson static void usb2_notify_addq(const char *type, struct usb2_device *); 7902ac6454SAndrew Thompson static void usb2_fifo_free_wrap(struct usb2_device *, uint8_t, uint8_t); 80f5f145baSAndrew Thompson static struct cdev *usb2_make_dev(struct usb2_device *, int, int); 81ee3e3ff5SAndrew Thompson static void usb2_cdev_create(struct usb2_device *); 82ee3e3ff5SAndrew Thompson static void usb2_cdev_free(struct usb2_device *); 83ee3e3ff5SAndrew Thompson static void usb2_cdev_cleanup(void *); 840f6e8f93SAndrew Thompson #endif 8502ac6454SAndrew Thompson 8602ac6454SAndrew Thompson /* This variable is global to allow easy access to it: */ 8702ac6454SAndrew Thompson 8802ac6454SAndrew Thompson int usb2_template = 0; 8902ac6454SAndrew Thompson 9002ac6454SAndrew Thompson SYSCTL_INT(_hw_usb2, OID_AUTO, template, CTLFLAG_RW, 9102ac6454SAndrew Thompson &usb2_template, 0, "Selected USB device side template"); 9202ac6454SAndrew Thompson 9302ac6454SAndrew Thompson 9402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 9502ac6454SAndrew Thompson * usb2_get_pipe_by_addr 9602ac6454SAndrew Thompson * 9702ac6454SAndrew Thompson * This function searches for an USB pipe by endpoint address and 9802ac6454SAndrew Thompson * direction. 9902ac6454SAndrew Thompson * 10002ac6454SAndrew Thompson * Returns: 10102ac6454SAndrew Thompson * NULL: Failure 10202ac6454SAndrew Thompson * Else: Success 10302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 10402ac6454SAndrew Thompson struct usb2_pipe * 10502ac6454SAndrew Thompson usb2_get_pipe_by_addr(struct usb2_device *udev, uint8_t ea_val) 10602ac6454SAndrew Thompson { 10702ac6454SAndrew Thompson struct usb2_pipe *pipe = udev->pipes; 10863521bbcSAndrew Thompson struct usb2_pipe *pipe_end = udev->pipes + udev->pipes_max; 10902ac6454SAndrew Thompson enum { 11002ac6454SAndrew Thompson EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR), 11102ac6454SAndrew Thompson }; 11202ac6454SAndrew Thompson 11302ac6454SAndrew Thompson /* 11402ac6454SAndrew Thompson * According to the USB specification not all bits are used 11502ac6454SAndrew Thompson * for the endpoint address. Keep defined bits only: 11602ac6454SAndrew Thompson */ 11702ac6454SAndrew Thompson ea_val &= EA_MASK; 11802ac6454SAndrew Thompson 11902ac6454SAndrew Thompson /* 12002ac6454SAndrew Thompson * Iterate accross all the USB pipes searching for a match 12102ac6454SAndrew Thompson * based on the endpoint address: 12202ac6454SAndrew Thompson */ 12302ac6454SAndrew Thompson for (; pipe != pipe_end; pipe++) { 12402ac6454SAndrew Thompson 12502ac6454SAndrew Thompson if (pipe->edesc == NULL) { 12602ac6454SAndrew Thompson continue; 12702ac6454SAndrew Thompson } 12802ac6454SAndrew Thompson /* do the mask and check the value */ 12902ac6454SAndrew Thompson if ((pipe->edesc->bEndpointAddress & EA_MASK) == ea_val) { 13002ac6454SAndrew Thompson goto found; 13102ac6454SAndrew Thompson } 13202ac6454SAndrew Thompson } 13302ac6454SAndrew Thompson 13402ac6454SAndrew Thompson /* 13502ac6454SAndrew Thompson * The default pipe is always present and is checked separately: 13602ac6454SAndrew Thompson */ 13702ac6454SAndrew Thompson if ((udev->default_pipe.edesc) && 13802ac6454SAndrew Thompson ((udev->default_pipe.edesc->bEndpointAddress & EA_MASK) == ea_val)) { 13902ac6454SAndrew Thompson pipe = &udev->default_pipe; 14002ac6454SAndrew Thompson goto found; 14102ac6454SAndrew Thompson } 14202ac6454SAndrew Thompson return (NULL); 14302ac6454SAndrew Thompson 14402ac6454SAndrew Thompson found: 14502ac6454SAndrew Thompson return (pipe); 14602ac6454SAndrew Thompson } 14702ac6454SAndrew Thompson 14802ac6454SAndrew Thompson /*------------------------------------------------------------------------* 14902ac6454SAndrew Thompson * usb2_get_pipe 15002ac6454SAndrew Thompson * 15102ac6454SAndrew Thompson * This function searches for an USB pipe based on the information 15202ac6454SAndrew Thompson * given by the passed "struct usb2_config" pointer. 15302ac6454SAndrew Thompson * 15402ac6454SAndrew Thompson * Return values: 15502ac6454SAndrew Thompson * NULL: No match. 15602ac6454SAndrew Thompson * Else: Pointer to "struct usb2_pipe". 15702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 15802ac6454SAndrew Thompson struct usb2_pipe * 15902ac6454SAndrew Thompson usb2_get_pipe(struct usb2_device *udev, uint8_t iface_index, 16002ac6454SAndrew Thompson const struct usb2_config *setup) 16102ac6454SAndrew Thompson { 16202ac6454SAndrew Thompson struct usb2_pipe *pipe = udev->pipes; 16363521bbcSAndrew Thompson struct usb2_pipe *pipe_end = udev->pipes + udev->pipes_max; 16402ac6454SAndrew Thompson uint8_t index = setup->ep_index; 16502ac6454SAndrew Thompson uint8_t ea_mask; 16602ac6454SAndrew Thompson uint8_t ea_val; 16702ac6454SAndrew Thompson uint8_t type_mask; 16802ac6454SAndrew Thompson uint8_t type_val; 16902ac6454SAndrew Thompson 17002ac6454SAndrew Thompson DPRINTFN(10, "udev=%p iface_index=%d address=0x%x " 17102ac6454SAndrew Thompson "type=0x%x dir=0x%x index=%d\n", 17202ac6454SAndrew Thompson udev, iface_index, setup->endpoint, 17302ac6454SAndrew Thompson setup->type, setup->direction, setup->ep_index); 17402ac6454SAndrew Thompson 1754eae601eSAndrew Thompson /* check USB mode */ 1764eae601eSAndrew Thompson 1774eae601eSAndrew Thompson if ((setup->usb_mode != USB_MODE_MAX) && 1784eae601eSAndrew Thompson (udev->flags.usb2_mode != setup->usb_mode)) { 1794eae601eSAndrew Thompson /* wrong mode - no pipe */ 1804eae601eSAndrew Thompson return (NULL); 1814eae601eSAndrew Thompson } 1824eae601eSAndrew Thompson 18302ac6454SAndrew Thompson /* setup expected endpoint direction mask and value */ 18402ac6454SAndrew Thompson 18551ec1603SAndrew Thompson if (setup->direction == UE_DIR_RX) { 18651ec1603SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 18751ec1603SAndrew Thompson ea_val = (udev->flags.usb2_mode == USB_MODE_DEVICE) ? 18851ec1603SAndrew Thompson UE_DIR_OUT : UE_DIR_IN; 18951ec1603SAndrew Thompson } else if (setup->direction == UE_DIR_TX) { 19051ec1603SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 19151ec1603SAndrew Thompson ea_val = (udev->flags.usb2_mode == USB_MODE_DEVICE) ? 19251ec1603SAndrew Thompson UE_DIR_IN : UE_DIR_OUT; 19351ec1603SAndrew Thompson } else if (setup->direction == UE_DIR_ANY) { 19402ac6454SAndrew Thompson /* match any endpoint direction */ 19502ac6454SAndrew Thompson ea_mask = 0; 19602ac6454SAndrew Thompson ea_val = 0; 19702ac6454SAndrew Thompson } else { 19802ac6454SAndrew Thompson /* match the given endpoint direction */ 19902ac6454SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 20002ac6454SAndrew Thompson ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT)); 20102ac6454SAndrew Thompson } 20202ac6454SAndrew Thompson 20302ac6454SAndrew Thompson /* setup expected endpoint address */ 20402ac6454SAndrew Thompson 20502ac6454SAndrew Thompson if (setup->endpoint == UE_ADDR_ANY) { 20602ac6454SAndrew Thompson /* match any endpoint address */ 20702ac6454SAndrew Thompson } else { 20802ac6454SAndrew Thompson /* match the given endpoint address */ 20902ac6454SAndrew Thompson ea_mask |= UE_ADDR; 21002ac6454SAndrew Thompson ea_val |= (setup->endpoint & UE_ADDR); 21102ac6454SAndrew Thompson } 21202ac6454SAndrew Thompson 21302ac6454SAndrew Thompson /* setup expected endpoint type */ 21402ac6454SAndrew Thompson 21502ac6454SAndrew Thompson if (setup->type == UE_BULK_INTR) { 21602ac6454SAndrew Thompson /* this will match BULK and INTERRUPT endpoints */ 21702ac6454SAndrew Thompson type_mask = 2; 21802ac6454SAndrew Thompson type_val = 2; 21902ac6454SAndrew Thompson } else if (setup->type == UE_TYPE_ANY) { 22002ac6454SAndrew Thompson /* match any endpoint type */ 22102ac6454SAndrew Thompson type_mask = 0; 22202ac6454SAndrew Thompson type_val = 0; 22302ac6454SAndrew Thompson } else { 22402ac6454SAndrew Thompson /* match the given endpoint type */ 22502ac6454SAndrew Thompson type_mask = UE_XFERTYPE; 22602ac6454SAndrew Thompson type_val = (setup->type & UE_XFERTYPE); 22702ac6454SAndrew Thompson } 22802ac6454SAndrew Thompson 22902ac6454SAndrew Thompson /* 23002ac6454SAndrew Thompson * Iterate accross all the USB pipes searching for a match 23102ac6454SAndrew Thompson * based on the endpoint address. Note that we are searching 23202ac6454SAndrew Thompson * the pipes from the beginning of the "udev->pipes" array. 23302ac6454SAndrew Thompson */ 23402ac6454SAndrew Thompson for (; pipe != pipe_end; pipe++) { 23502ac6454SAndrew Thompson 23602ac6454SAndrew Thompson if ((pipe->edesc == NULL) || 23702ac6454SAndrew Thompson (pipe->iface_index != iface_index)) { 23802ac6454SAndrew Thompson continue; 23902ac6454SAndrew Thompson } 24002ac6454SAndrew Thompson /* do the masks and check the values */ 24102ac6454SAndrew Thompson 24202ac6454SAndrew Thompson if (((pipe->edesc->bEndpointAddress & ea_mask) == ea_val) && 24302ac6454SAndrew Thompson ((pipe->edesc->bmAttributes & type_mask) == type_val)) { 24402ac6454SAndrew Thompson if (!index--) { 24502ac6454SAndrew Thompson goto found; 24602ac6454SAndrew Thompson } 24702ac6454SAndrew Thompson } 24802ac6454SAndrew Thompson } 24902ac6454SAndrew Thompson 25002ac6454SAndrew Thompson /* 25102ac6454SAndrew Thompson * Match against default pipe last, so that "any pipe", "any 25202ac6454SAndrew Thompson * address" and "any direction" returns the first pipe of the 25302ac6454SAndrew Thompson * interface. "iface_index" and "direction" is ignored: 25402ac6454SAndrew Thompson */ 25502ac6454SAndrew Thompson if ((udev->default_pipe.edesc) && 25602ac6454SAndrew Thompson ((udev->default_pipe.edesc->bEndpointAddress & ea_mask) == ea_val) && 25702ac6454SAndrew Thompson ((udev->default_pipe.edesc->bmAttributes & type_mask) == type_val) && 25802ac6454SAndrew Thompson (!index)) { 25902ac6454SAndrew Thompson pipe = &udev->default_pipe; 26002ac6454SAndrew Thompson goto found; 26102ac6454SAndrew Thompson } 26202ac6454SAndrew Thompson return (NULL); 26302ac6454SAndrew Thompson 26402ac6454SAndrew Thompson found: 26502ac6454SAndrew Thompson return (pipe); 26602ac6454SAndrew Thompson } 26702ac6454SAndrew Thompson 26802ac6454SAndrew Thompson /*------------------------------------------------------------------------* 26902ac6454SAndrew Thompson * usb2_interface_count 27002ac6454SAndrew Thompson * 27102ac6454SAndrew Thompson * This function stores the number of USB interfaces excluding 27202ac6454SAndrew Thompson * alternate settings, which the USB config descriptor reports into 27302ac6454SAndrew Thompson * the unsigned 8-bit integer pointed to by "count". 27402ac6454SAndrew Thompson * 27502ac6454SAndrew Thompson * Returns: 27602ac6454SAndrew Thompson * 0: Success 27702ac6454SAndrew Thompson * Else: Failure 27802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 27902ac6454SAndrew Thompson usb2_error_t 28002ac6454SAndrew Thompson usb2_interface_count(struct usb2_device *udev, uint8_t *count) 28102ac6454SAndrew Thompson { 28202ac6454SAndrew Thompson if (udev->cdesc == NULL) { 28302ac6454SAndrew Thompson *count = 0; 28402ac6454SAndrew Thompson return (USB_ERR_NOT_CONFIGURED); 28502ac6454SAndrew Thompson } 286bdd41206SAndrew Thompson *count = udev->ifaces_max; 28702ac6454SAndrew Thompson return (USB_ERR_NORMAL_COMPLETION); 28802ac6454SAndrew Thompson } 28902ac6454SAndrew Thompson 29002ac6454SAndrew Thompson 29102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 292bdd41206SAndrew Thompson * usb2_init_pipe 29302ac6454SAndrew Thompson * 29402ac6454SAndrew Thompson * This function will initialise the USB pipe structure pointed to by 295bdd41206SAndrew Thompson * the "pipe" argument. The structure pointed to by "pipe" must be 296bdd41206SAndrew Thompson * zeroed before calling this function. 29702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 29802ac6454SAndrew Thompson static void 299bdd41206SAndrew Thompson usb2_init_pipe(struct usb2_device *udev, uint8_t iface_index, 30002ac6454SAndrew Thompson struct usb2_endpoint_descriptor *edesc, struct usb2_pipe *pipe) 30102ac6454SAndrew Thompson { 302bdd41206SAndrew Thompson struct usb2_bus_methods *methods; 303ee3e3ff5SAndrew Thompson 304bdd41206SAndrew Thompson methods = udev->bus->methods; 30502ac6454SAndrew Thompson 306bdd41206SAndrew Thompson (methods->pipe_init) (udev, edesc, pipe); 30702ac6454SAndrew Thompson 30802ac6454SAndrew Thompson /* initialise USB pipe structure */ 30902ac6454SAndrew Thompson pipe->edesc = edesc; 31002ac6454SAndrew Thompson pipe->iface_index = iface_index; 31102ac6454SAndrew Thompson TAILQ_INIT(&pipe->pipe_q.head); 31202ac6454SAndrew Thompson pipe->pipe_q.command = &usb2_pipe_start; 31302ac6454SAndrew Thompson 31439307315SAndrew Thompson /* the pipe is not supported by the hardware */ 31539307315SAndrew Thompson if (pipe->methods == NULL) 31639307315SAndrew Thompson return; 31739307315SAndrew Thompson 31802ac6454SAndrew Thompson /* clear stall, if any */ 319bdd41206SAndrew Thompson if (methods->clear_stall != NULL) { 32002ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 321bdd41206SAndrew Thompson (methods->clear_stall) (udev, pipe); 32202ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 32302ac6454SAndrew Thompson } 32402ac6454SAndrew Thompson } 32502ac6454SAndrew Thompson 326bdd41206SAndrew Thompson /*-----------------------------------------------------------------------* 32716589beaSAndrew Thompson * usb2_pipe_foreach 32816589beaSAndrew Thompson * 32916589beaSAndrew Thompson * This function will iterate all the USB endpoints except the control 33016589beaSAndrew Thompson * endpoint. This function is NULL safe. 33116589beaSAndrew Thompson * 33216589beaSAndrew Thompson * Return values: 33316589beaSAndrew Thompson * NULL: End of USB pipes 33416589beaSAndrew Thompson * Else: Pointer to next USB pipe 33516589beaSAndrew Thompson *------------------------------------------------------------------------*/ 33616589beaSAndrew Thompson struct usb2_pipe * 33716589beaSAndrew Thompson usb2_pipe_foreach(struct usb2_device *udev, struct usb2_pipe *pipe) 33816589beaSAndrew Thompson { 33963521bbcSAndrew Thompson struct usb2_pipe *pipe_end = udev->pipes + udev->pipes_max; 34016589beaSAndrew Thompson 34116589beaSAndrew Thompson /* be NULL safe */ 34216589beaSAndrew Thompson if (udev == NULL) 34316589beaSAndrew Thompson return (NULL); 34416589beaSAndrew Thompson 34516589beaSAndrew Thompson /* get next pipe */ 34616589beaSAndrew Thompson if (pipe == NULL) 34716589beaSAndrew Thompson pipe = udev->pipes; 34816589beaSAndrew Thompson else 34916589beaSAndrew Thompson pipe++; 35016589beaSAndrew Thompson 35116589beaSAndrew Thompson /* find next allocated pipe */ 35216589beaSAndrew Thompson while (pipe != pipe_end) { 35316589beaSAndrew Thompson if (pipe->edesc != NULL) 35416589beaSAndrew Thompson return (pipe); 35516589beaSAndrew Thompson pipe++; 35616589beaSAndrew Thompson } 35716589beaSAndrew Thompson return (NULL); 35816589beaSAndrew Thompson } 35916589beaSAndrew Thompson 36016589beaSAndrew Thompson /*------------------------------------------------------------------------* 361bdd41206SAndrew Thompson * usb2_unconfigure 36202ac6454SAndrew Thompson * 36302ac6454SAndrew Thompson * This function will free all USB interfaces and USB pipes belonging 36402ac6454SAndrew Thompson * to an USB device. 365bdd41206SAndrew Thompson * 366bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 36702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 36802ac6454SAndrew Thompson static void 369bdd41206SAndrew Thompson usb2_unconfigure(struct usb2_device *udev, uint8_t flag) 37002ac6454SAndrew Thompson { 371bdd41206SAndrew Thompson uint8_t do_unlock; 37202ac6454SAndrew Thompson 373bdd41206SAndrew Thompson /* automatic locking */ 374bdd41206SAndrew Thompson if (sx_xlocked(udev->default_sx + 1)) { 375bdd41206SAndrew Thompson do_unlock = 0; 376bdd41206SAndrew Thompson } else { 377bdd41206SAndrew Thompson do_unlock = 1; 378bdd41206SAndrew Thompson sx_xlock(udev->default_sx + 1); 379bdd41206SAndrew Thompson } 380bdd41206SAndrew Thompson 381bdd41206SAndrew Thompson /* detach all interface drivers */ 382bdd41206SAndrew Thompson usb2_detach_device(udev, USB_IFACE_INDEX_ANY, flag); 383bdd41206SAndrew Thompson 384bdd41206SAndrew Thompson #if USB_HAVE_UGEN 385bdd41206SAndrew Thompson /* free all FIFOs except control endpoint FIFOs */ 386bdd41206SAndrew Thompson usb2_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag); 387bdd41206SAndrew Thompson 388bdd41206SAndrew Thompson /* 389bdd41206SAndrew Thompson * Free all cdev's, if any. 390bdd41206SAndrew Thompson */ 391bdd41206SAndrew Thompson usb2_cdev_free(udev); 392bdd41206SAndrew Thompson #endif 39302ac6454SAndrew Thompson 394bdc081c6SAndrew Thompson #if USB_HAVE_COMPAT_LINUX 39502ac6454SAndrew Thompson /* free Linux compat device, if any */ 39602ac6454SAndrew Thompson if (udev->linux_dev) { 39702ac6454SAndrew Thompson usb_linux_free_device(udev->linux_dev); 39802ac6454SAndrew Thompson udev->linux_dev = NULL; 39902ac6454SAndrew Thompson } 400bdc081c6SAndrew Thompson #endif 40102ac6454SAndrew Thompson 402bdd41206SAndrew Thompson usb2_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE); 40302ac6454SAndrew Thompson 404bdd41206SAndrew Thompson /* free "cdesc" after "ifaces" and "pipes", if any */ 4057efaaa9aSAndrew Thompson if (udev->cdesc != NULL) { 4067efaaa9aSAndrew Thompson if (udev->flags.usb2_mode != USB_MODE_DEVICE) 40702ac6454SAndrew Thompson free(udev->cdesc, M_USB); 40802ac6454SAndrew Thompson udev->cdesc = NULL; 40902ac6454SAndrew Thompson } 41002ac6454SAndrew Thompson /* set unconfigured state */ 41102ac6454SAndrew Thompson udev->curr_config_no = USB_UNCONFIG_NO; 41202ac6454SAndrew Thompson udev->curr_config_index = USB_UNCONFIG_INDEX; 413bdd41206SAndrew Thompson 414bdd41206SAndrew Thompson if (do_unlock) { 415bdd41206SAndrew Thompson sx_unlock(udev->default_sx + 1); 416bdd41206SAndrew Thompson } 41702ac6454SAndrew Thompson } 41802ac6454SAndrew Thompson 41902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 42002ac6454SAndrew Thompson * usb2_set_config_index 42102ac6454SAndrew Thompson * 42202ac6454SAndrew Thompson * This function selects configuration by index, independent of the 42302ac6454SAndrew Thompson * actual configuration number. This function should not be used by 42402ac6454SAndrew Thompson * USB drivers. 42502ac6454SAndrew Thompson * 42602ac6454SAndrew Thompson * Returns: 42702ac6454SAndrew Thompson * 0: Success 42802ac6454SAndrew Thompson * Else: Failure 42902ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 43002ac6454SAndrew Thompson usb2_error_t 43102ac6454SAndrew Thompson usb2_set_config_index(struct usb2_device *udev, uint8_t index) 43202ac6454SAndrew Thompson { 43302ac6454SAndrew Thompson struct usb2_status ds; 43402ac6454SAndrew Thompson struct usb2_hub_descriptor hd; 43502ac6454SAndrew Thompson struct usb2_config_descriptor *cdp; 43602ac6454SAndrew Thompson uint16_t power; 43702ac6454SAndrew Thompson uint16_t max_power; 43802ac6454SAndrew Thompson uint8_t selfpowered; 43902ac6454SAndrew Thompson uint8_t do_unlock; 44002ac6454SAndrew Thompson usb2_error_t err; 44102ac6454SAndrew Thompson 44202ac6454SAndrew Thompson DPRINTFN(6, "udev=%p index=%d\n", udev, index); 44302ac6454SAndrew Thompson 44402ac6454SAndrew Thompson /* automatic locking */ 44502ac6454SAndrew Thompson if (sx_xlocked(udev->default_sx + 1)) { 44602ac6454SAndrew Thompson do_unlock = 0; 44702ac6454SAndrew Thompson } else { 44802ac6454SAndrew Thompson do_unlock = 1; 44902ac6454SAndrew Thompson sx_xlock(udev->default_sx + 1); 45002ac6454SAndrew Thompson } 45102ac6454SAndrew Thompson 452bdd41206SAndrew Thompson usb2_unconfigure(udev, USB_UNCFG_FLAG_FREE_SUBDEV); 45302ac6454SAndrew Thompson 45402ac6454SAndrew Thompson if (index == USB_UNCONFIG_INDEX) { 45502ac6454SAndrew Thompson /* 45602ac6454SAndrew Thompson * Leave unallocated when unconfiguring the 457bdd41206SAndrew Thompson * device. "usb2_unconfigure()" will also reset 45802ac6454SAndrew Thompson * the current config number and index. 45902ac6454SAndrew Thompson */ 460e2805033SAndrew Thompson err = usb2_req_set_config(udev, NULL, USB_UNCONFIG_NO); 46102ac6454SAndrew Thompson goto done; 46202ac6454SAndrew Thompson } 46302ac6454SAndrew Thompson /* get the full config descriptor */ 4647efaaa9aSAndrew Thompson if (udev->flags.usb2_mode == USB_MODE_DEVICE) { 4657efaaa9aSAndrew Thompson /* save some memory */ 4667efaaa9aSAndrew Thompson err = usb2_req_get_config_desc_ptr(udev, &cdp, index); 4677efaaa9aSAndrew Thompson } else { 4687efaaa9aSAndrew Thompson /* normal request */ 46902ac6454SAndrew Thompson err = usb2_req_get_config_desc_full(udev, 470e2805033SAndrew Thompson NULL, &cdp, M_USB, index); 4717efaaa9aSAndrew Thompson } 47202ac6454SAndrew Thompson if (err) { 47302ac6454SAndrew Thompson goto done; 47402ac6454SAndrew Thompson } 47502ac6454SAndrew Thompson /* set the new config descriptor */ 47602ac6454SAndrew Thompson 47702ac6454SAndrew Thompson udev->cdesc = cdp; 47802ac6454SAndrew Thompson 47902ac6454SAndrew Thompson /* Figure out if the device is self or bus powered. */ 48002ac6454SAndrew Thompson selfpowered = 0; 48102ac6454SAndrew Thompson if ((!udev->flags.uq_bus_powered) && 48202ac6454SAndrew Thompson (cdp->bmAttributes & UC_SELF_POWERED) && 48302ac6454SAndrew Thompson (udev->flags.usb2_mode == USB_MODE_HOST)) { 48402ac6454SAndrew Thompson /* May be self powered. */ 48502ac6454SAndrew Thompson if (cdp->bmAttributes & UC_BUS_POWERED) { 48602ac6454SAndrew Thompson /* Must ask device. */ 48702ac6454SAndrew Thompson if (udev->flags.uq_power_claim) { 48802ac6454SAndrew Thompson /* 48902ac6454SAndrew Thompson * HUB claims to be self powered, but isn't. 49002ac6454SAndrew Thompson * It seems that the power status can be 49102ac6454SAndrew Thompson * determined by the HUB characteristics. 49202ac6454SAndrew Thompson */ 49302ac6454SAndrew Thompson err = usb2_req_get_hub_descriptor 494e2805033SAndrew Thompson (udev, NULL, &hd, 1); 49502ac6454SAndrew Thompson if (err) { 49602ac6454SAndrew Thompson DPRINTFN(0, "could not read " 49702ac6454SAndrew Thompson "HUB descriptor: %s\n", 49802ac6454SAndrew Thompson usb2_errstr(err)); 49902ac6454SAndrew Thompson 50002ac6454SAndrew Thompson } else if (UGETW(hd.wHubCharacteristics) & 50102ac6454SAndrew Thompson UHD_PWR_INDIVIDUAL) { 50202ac6454SAndrew Thompson selfpowered = 1; 50302ac6454SAndrew Thompson } 50402ac6454SAndrew Thompson DPRINTF("characteristics=0x%04x\n", 50502ac6454SAndrew Thompson UGETW(hd.wHubCharacteristics)); 50602ac6454SAndrew Thompson } else { 50702ac6454SAndrew Thompson err = usb2_req_get_device_status 508e2805033SAndrew Thompson (udev, NULL, &ds); 50902ac6454SAndrew Thompson if (err) { 51002ac6454SAndrew Thompson DPRINTFN(0, "could not read " 51102ac6454SAndrew Thompson "device status: %s\n", 51202ac6454SAndrew Thompson usb2_errstr(err)); 51302ac6454SAndrew Thompson } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) { 51402ac6454SAndrew Thompson selfpowered = 1; 51502ac6454SAndrew Thompson } 51602ac6454SAndrew Thompson DPRINTF("status=0x%04x \n", 51702ac6454SAndrew Thompson UGETW(ds.wStatus)); 51802ac6454SAndrew Thompson } 51902ac6454SAndrew Thompson } else 52002ac6454SAndrew Thompson selfpowered = 1; 52102ac6454SAndrew Thompson } 52202ac6454SAndrew Thompson DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, " 52302ac6454SAndrew Thompson "selfpowered=%d, power=%d\n", 52402ac6454SAndrew Thompson udev, cdp, 52591f72cedSAndrew Thompson udev->address, cdp->bConfigurationValue, cdp->bmAttributes, 52602ac6454SAndrew Thompson selfpowered, cdp->bMaxPower * 2); 52702ac6454SAndrew Thompson 52802ac6454SAndrew Thompson /* Check if we have enough power. */ 52902ac6454SAndrew Thompson power = cdp->bMaxPower * 2; 53002ac6454SAndrew Thompson 53102ac6454SAndrew Thompson if (udev->parent_hub) { 53202ac6454SAndrew Thompson max_power = udev->parent_hub->hub->portpower; 53302ac6454SAndrew Thompson } else { 53402ac6454SAndrew Thompson max_power = USB_MAX_POWER; 53502ac6454SAndrew Thompson } 53602ac6454SAndrew Thompson 53702ac6454SAndrew Thompson if (power > max_power) { 53802ac6454SAndrew Thompson DPRINTFN(0, "power exceeded %d > %d\n", power, max_power); 53902ac6454SAndrew Thompson err = USB_ERR_NO_POWER; 54002ac6454SAndrew Thompson goto done; 54102ac6454SAndrew Thompson } 54202ac6454SAndrew Thompson /* Only update "self_powered" in USB Host Mode */ 54302ac6454SAndrew Thompson if (udev->flags.usb2_mode == USB_MODE_HOST) { 54402ac6454SAndrew Thompson udev->flags.self_powered = selfpowered; 54502ac6454SAndrew Thompson } 54602ac6454SAndrew Thompson udev->power = power; 54702ac6454SAndrew Thompson udev->curr_config_no = cdp->bConfigurationValue; 54802ac6454SAndrew Thompson udev->curr_config_index = index; 54902ac6454SAndrew Thompson 55002ac6454SAndrew Thompson /* Set the actual configuration value. */ 551e2805033SAndrew Thompson err = usb2_req_set_config(udev, NULL, cdp->bConfigurationValue); 55202ac6454SAndrew Thompson if (err) { 55302ac6454SAndrew Thompson goto done; 55402ac6454SAndrew Thompson } 555bdd41206SAndrew Thompson 556bdd41206SAndrew Thompson err = usb2_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC); 55702ac6454SAndrew Thompson if (err) { 55802ac6454SAndrew Thompson goto done; 55902ac6454SAndrew Thompson } 560bdd41206SAndrew Thompson 561bdd41206SAndrew Thompson err = usb2_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT); 562bdd41206SAndrew Thompson if (err) { 563bdd41206SAndrew Thompson goto done; 56402ac6454SAndrew Thompson } 565bdd41206SAndrew Thompson 5660f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 567ee3e3ff5SAndrew Thompson /* create device nodes for each endpoint */ 568ee3e3ff5SAndrew Thompson usb2_cdev_create(udev); 5690f6e8f93SAndrew Thompson #endif 57002ac6454SAndrew Thompson 57102ac6454SAndrew Thompson done: 57202ac6454SAndrew Thompson DPRINTF("error=%s\n", usb2_errstr(err)); 57302ac6454SAndrew Thompson if (err) { 574bdd41206SAndrew Thompson usb2_unconfigure(udev, USB_UNCFG_FLAG_FREE_SUBDEV); 57502ac6454SAndrew Thompson } 57602ac6454SAndrew Thompson if (do_unlock) { 57702ac6454SAndrew Thompson sx_unlock(udev->default_sx + 1); 57802ac6454SAndrew Thompson } 57902ac6454SAndrew Thompson return (err); 58002ac6454SAndrew Thompson } 58102ac6454SAndrew Thompson 58202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 583bdd41206SAndrew Thompson * usb2_config_parse 584bdd41206SAndrew Thompson * 585bdd41206SAndrew Thompson * This function will allocate and free USB interfaces and USB pipes, 586bdd41206SAndrew Thompson * parse the USB configuration structure and initialise the USB pipes 587bdd41206SAndrew Thompson * and interfaces. If "iface_index" is not equal to 588bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the 589bdd41206SAndrew Thompson * alternate_setting to be selected for the given interface. Else the 590bdd41206SAndrew Thompson * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be 591bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function 592bdd41206SAndrew Thompson * is typically called when setting the configuration or when setting 593bdd41206SAndrew Thompson * an alternate interface. 594bdd41206SAndrew Thompson * 595bdd41206SAndrew Thompson * Returns: 596bdd41206SAndrew Thompson * 0: Success 597bdd41206SAndrew Thompson * Else: Failure 598bdd41206SAndrew Thompson *------------------------------------------------------------------------*/ 599bdd41206SAndrew Thompson usb2_error_t 600bdd41206SAndrew Thompson usb2_config_parse(struct usb2_device *udev, uint8_t iface_index, uint8_t cmd) 601bdd41206SAndrew Thompson { 602bdd41206SAndrew Thompson struct usb2_idesc_parse_state ips; 603bdd41206SAndrew Thompson struct usb2_interface_descriptor *id; 604bdd41206SAndrew Thompson struct usb2_endpoint_descriptor *ed; 605bdd41206SAndrew Thompson struct usb2_interface *iface; 606bdd41206SAndrew Thompson struct usb2_pipe *pipe; 607bdd41206SAndrew Thompson usb2_error_t err; 608bdd41206SAndrew Thompson uint8_t ep_curr; 609bdd41206SAndrew Thompson uint8_t ep_max; 610bdd41206SAndrew Thompson uint8_t temp; 611bdd41206SAndrew Thompson uint8_t do_init; 612bdd41206SAndrew Thompson uint8_t alt_index; 613bdd41206SAndrew Thompson 614bdd41206SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 615bdd41206SAndrew Thompson /* parameter overload */ 616bdd41206SAndrew Thompson alt_index = cmd; 617bdd41206SAndrew Thompson cmd = USB_CFG_INIT; 618bdd41206SAndrew Thompson } else { 619bdd41206SAndrew Thompson /* not used */ 620bdd41206SAndrew Thompson alt_index = 0; 621bdd41206SAndrew Thompson } 622bdd41206SAndrew Thompson 623bdd41206SAndrew Thompson err = 0; 624bdd41206SAndrew Thompson 625bdd41206SAndrew Thompson DPRINTFN(5, "iface_index=%d cmd=%d\n", 626bdd41206SAndrew Thompson iface_index, cmd); 627bdd41206SAndrew Thompson 628bdd41206SAndrew Thompson if (cmd == USB_CFG_FREE) 629bdd41206SAndrew Thompson goto cleanup; 630bdd41206SAndrew Thompson 631bdd41206SAndrew Thompson if (cmd == USB_CFG_INIT) { 632bdd41206SAndrew Thompson sx_assert(udev->default_sx + 1, SA_LOCKED); 633bdd41206SAndrew Thompson 634bdd41206SAndrew Thompson /* check for in-use pipes */ 635bdd41206SAndrew Thompson 636bdd41206SAndrew Thompson pipe = udev->pipes; 637bdd41206SAndrew Thompson ep_max = udev->pipes_max; 638bdd41206SAndrew Thompson while (ep_max--) { 639bdd41206SAndrew Thompson /* look for matching pipes */ 640bdd41206SAndrew Thompson if ((iface_index == USB_IFACE_INDEX_ANY) || 641bdd41206SAndrew Thompson (iface_index == pipe->iface_index)) { 642bdd41206SAndrew Thompson if (pipe->refcount != 0) { 643bdd41206SAndrew Thompson /* 644bdd41206SAndrew Thompson * This typically indicates a 645bdd41206SAndrew Thompson * more serious error. 646bdd41206SAndrew Thompson */ 647bdd41206SAndrew Thompson err = USB_ERR_IN_USE; 648bdd41206SAndrew Thompson } else { 649bdd41206SAndrew Thompson /* reset pipe */ 650bdd41206SAndrew Thompson memset(pipe, 0, sizeof(*pipe)); 651bdd41206SAndrew Thompson /* make sure we don't zero the pipe again */ 652bdd41206SAndrew Thompson pipe->iface_index = USB_IFACE_INDEX_ANY; 653bdd41206SAndrew Thompson } 654bdd41206SAndrew Thompson } 655bdd41206SAndrew Thompson pipe++; 656bdd41206SAndrew Thompson } 657bdd41206SAndrew Thompson 658bdd41206SAndrew Thompson if (err) 659bdd41206SAndrew Thompson return (err); 660bdd41206SAndrew Thompson } 661bdd41206SAndrew Thompson 662bdd41206SAndrew Thompson memset(&ips, 0, sizeof(ips)); 663bdd41206SAndrew Thompson 664bdd41206SAndrew Thompson ep_curr = 0; 665bdd41206SAndrew Thompson ep_max = 0; 666bdd41206SAndrew Thompson 667bdd41206SAndrew Thompson while ((id = usb2_idesc_foreach(udev->cdesc, &ips))) { 668bdd41206SAndrew Thompson 669bdd41206SAndrew Thompson /* check for interface overflow */ 670bdd41206SAndrew Thompson if (ips.iface_index == USB_IFACE_MAX) 671bdd41206SAndrew Thompson break; /* crazy */ 672bdd41206SAndrew Thompson 673bdd41206SAndrew Thompson iface = udev->ifaces + ips.iface_index; 674bdd41206SAndrew Thompson 675bdd41206SAndrew Thompson /* check for specific interface match */ 676bdd41206SAndrew Thompson 677bdd41206SAndrew Thompson if (cmd == USB_CFG_INIT) { 678bdd41206SAndrew Thompson if ((iface_index != USB_IFACE_INDEX_ANY) && 679bdd41206SAndrew Thompson (iface_index != ips.iface_index)) { 680bdd41206SAndrew Thompson /* wrong interface */ 681bdd41206SAndrew Thompson do_init = 0; 682bdd41206SAndrew Thompson } else if (alt_index != ips.iface_index_alt) { 683bdd41206SAndrew Thompson /* wrong alternate setting */ 684bdd41206SAndrew Thompson do_init = 0; 685bdd41206SAndrew Thompson } else { 686bdd41206SAndrew Thompson /* initialise interface */ 687bdd41206SAndrew Thompson do_init = 1; 688bdd41206SAndrew Thompson } 689bdd41206SAndrew Thompson } else 690bdd41206SAndrew Thompson do_init = 0; 691bdd41206SAndrew Thompson 692bdd41206SAndrew Thompson /* check for new interface */ 693bdd41206SAndrew Thompson if (ips.iface_index_alt == 0) { 694bdd41206SAndrew Thompson /* update current number of endpoints */ 695bdd41206SAndrew Thompson ep_curr = ep_max; 696bdd41206SAndrew Thompson } 697bdd41206SAndrew Thompson /* check for init */ 698bdd41206SAndrew Thompson if (do_init) { 699bdd41206SAndrew Thompson /* setup the USB interface structure */ 700bdd41206SAndrew Thompson iface->idesc = id; 701bdd41206SAndrew Thompson /* default setting */ 702bdd41206SAndrew Thompson iface->parent_iface_index = USB_IFACE_INDEX_ANY; 703bdd41206SAndrew Thompson /* set alternate index */ 704bdd41206SAndrew Thompson iface->alt_index = alt_index; 705bdd41206SAndrew Thompson } 706bdd41206SAndrew Thompson 707bdd41206SAndrew Thompson DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints); 708bdd41206SAndrew Thompson 709bdd41206SAndrew Thompson ed = (struct usb2_endpoint_descriptor *)id; 710bdd41206SAndrew Thompson 711bdd41206SAndrew Thompson temp = ep_curr; 712bdd41206SAndrew Thompson 713bdd41206SAndrew Thompson /* iterate all the endpoint descriptors */ 714bdd41206SAndrew Thompson while ((ed = usb2_edesc_foreach(udev->cdesc, ed))) { 715bdd41206SAndrew Thompson 716bdd41206SAndrew Thompson if (temp == USB_EP_MAX) 717bdd41206SAndrew Thompson break; /* crazy */ 718bdd41206SAndrew Thompson 719bdd41206SAndrew Thompson pipe = udev->pipes + temp; 720bdd41206SAndrew Thompson 721bdd41206SAndrew Thompson if (do_init) { 722bdd41206SAndrew Thompson usb2_init_pipe(udev, 723bdd41206SAndrew Thompson ips.iface_index, ed, pipe); 724bdd41206SAndrew Thompson } 725bdd41206SAndrew Thompson 726bdd41206SAndrew Thompson temp ++; 727bdd41206SAndrew Thompson 728bdd41206SAndrew Thompson /* find maximum number of endpoints */ 729bdd41206SAndrew Thompson if (ep_max < temp) 730bdd41206SAndrew Thompson ep_max = temp; 731bdd41206SAndrew Thompson 732bdd41206SAndrew Thompson /* optimalisation */ 733bdd41206SAndrew Thompson id = (struct usb2_interface_descriptor *)ed; 734bdd41206SAndrew Thompson } 735bdd41206SAndrew Thompson } 736bdd41206SAndrew Thompson 737bdd41206SAndrew Thompson /* NOTE: It is valid to have no interfaces and no endpoints! */ 738bdd41206SAndrew Thompson 739bdd41206SAndrew Thompson if (cmd == USB_CFG_ALLOC) { 740bdd41206SAndrew Thompson udev->ifaces_max = ips.iface_index; 741bdd41206SAndrew Thompson udev->ifaces = NULL; 742bdd41206SAndrew Thompson if (udev->ifaces_max != 0) { 743bdd41206SAndrew Thompson udev->ifaces = malloc(sizeof(*iface) * udev->ifaces_max, 744bdd41206SAndrew Thompson M_USB, M_WAITOK | M_ZERO); 745bdd41206SAndrew Thompson if (udev->ifaces == NULL) { 746bdd41206SAndrew Thompson err = USB_ERR_NOMEM; 747bdd41206SAndrew Thompson goto done; 748bdd41206SAndrew Thompson } 749bdd41206SAndrew Thompson } 750bdd41206SAndrew Thompson udev->pipes_max = ep_max; 751bdd41206SAndrew Thompson udev->pipes = NULL; 752bdd41206SAndrew Thompson if (udev->pipes_max != 0) { 753bdd41206SAndrew Thompson udev->pipes = malloc(sizeof(*pipe) * udev->pipes_max, 754bdd41206SAndrew Thompson M_USB, M_WAITOK | M_ZERO); 755bdd41206SAndrew Thompson if (udev->pipes == NULL) { 756bdd41206SAndrew Thompson err = USB_ERR_NOMEM; 757bdd41206SAndrew Thompson goto done; 758bdd41206SAndrew Thompson } 759bdd41206SAndrew Thompson } 760bdd41206SAndrew Thompson } 761bdd41206SAndrew Thompson 762bdd41206SAndrew Thompson done: 763bdd41206SAndrew Thompson if (err) { 764bdd41206SAndrew Thompson if (cmd == USB_CFG_ALLOC) { 765bdd41206SAndrew Thompson cleanup: 766bdd41206SAndrew Thompson /* cleanup */ 767bdd41206SAndrew Thompson if (udev->ifaces != NULL) 768bdd41206SAndrew Thompson free(udev->ifaces, M_USB); 769bdd41206SAndrew Thompson if (udev->pipes != NULL) 770bdd41206SAndrew Thompson free(udev->pipes, M_USB); 771bdd41206SAndrew Thompson 772bdd41206SAndrew Thompson udev->ifaces = NULL; 773bdd41206SAndrew Thompson udev->pipes = NULL; 774bdd41206SAndrew Thompson udev->ifaces_max = 0; 775bdd41206SAndrew Thompson udev->pipes_max = 0; 776bdd41206SAndrew Thompson } 777bdd41206SAndrew Thompson } 778bdd41206SAndrew Thompson return (err); 779bdd41206SAndrew Thompson } 780bdd41206SAndrew Thompson 781bdd41206SAndrew Thompson /*------------------------------------------------------------------------* 78202ac6454SAndrew Thompson * usb2_set_alt_interface_index 78302ac6454SAndrew Thompson * 78402ac6454SAndrew Thompson * This function will select an alternate interface index for the 78502ac6454SAndrew Thompson * given interface index. The interface should not be in use when this 786e2805033SAndrew Thompson * function is called. That means there should not be any open USB 787e2805033SAndrew Thompson * transfers. Else an error is returned. If the alternate setting is 788e2805033SAndrew Thompson * already set this function will simply return success. This function 789e2805033SAndrew Thompson * is called in Host mode and Device mode! 79002ac6454SAndrew Thompson * 79102ac6454SAndrew Thompson * Returns: 79202ac6454SAndrew Thompson * 0: Success 79302ac6454SAndrew Thompson * Else: Failure 79402ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 79502ac6454SAndrew Thompson usb2_error_t 79602ac6454SAndrew Thompson usb2_set_alt_interface_index(struct usb2_device *udev, 79702ac6454SAndrew Thompson uint8_t iface_index, uint8_t alt_index) 79802ac6454SAndrew Thompson { 79902ac6454SAndrew Thompson struct usb2_interface *iface = usb2_get_iface(udev, iface_index); 80002ac6454SAndrew Thompson usb2_error_t err; 80102ac6454SAndrew Thompson uint8_t do_unlock; 80202ac6454SAndrew Thompson 80302ac6454SAndrew Thompson /* automatic locking */ 80402ac6454SAndrew Thompson if (sx_xlocked(udev->default_sx + 1)) { 80502ac6454SAndrew Thompson do_unlock = 0; 80602ac6454SAndrew Thompson } else { 80702ac6454SAndrew Thompson do_unlock = 1; 80802ac6454SAndrew Thompson sx_xlock(udev->default_sx + 1); 80902ac6454SAndrew Thompson } 81002ac6454SAndrew Thompson if (iface == NULL) { 81102ac6454SAndrew Thompson err = USB_ERR_INVAL; 81202ac6454SAndrew Thompson goto done; 81302ac6454SAndrew Thompson } 81402ac6454SAndrew Thompson if (udev->flags.usb2_mode == USB_MODE_DEVICE) { 815bdd41206SAndrew Thompson usb2_detach_device(udev, iface_index, 816bdd41206SAndrew Thompson USB_UNCFG_FLAG_FREE_SUBDEV); 817e2805033SAndrew Thompson } else { 818e2805033SAndrew Thompson if (iface->alt_index == alt_index) { 819e2805033SAndrew Thompson /* 820e2805033SAndrew Thompson * Optimise away duplicate setting of 821e2805033SAndrew Thompson * alternate setting in USB Host Mode! 822e2805033SAndrew Thompson */ 823e2805033SAndrew Thompson err = 0; 824e2805033SAndrew Thompson goto done; 825e2805033SAndrew Thompson } 82602ac6454SAndrew Thompson } 8270f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 82802ac6454SAndrew Thompson /* 82902ac6454SAndrew Thompson * Free all generic FIFOs for this interface, except control 83002ac6454SAndrew Thompson * endpoint FIFOs: 83102ac6454SAndrew Thompson */ 83202ac6454SAndrew Thompson usb2_fifo_free_wrap(udev, iface_index, 0); 8330f6e8f93SAndrew Thompson #endif 834bdd41206SAndrew Thompson 835bdd41206SAndrew Thompson err = usb2_config_parse(udev, iface_index, alt_index); 83602ac6454SAndrew Thompson if (err) { 83702ac6454SAndrew Thompson goto done; 83802ac6454SAndrew Thompson } 839e2805033SAndrew Thompson err = usb2_req_set_alt_interface_no(udev, NULL, iface_index, 84002ac6454SAndrew Thompson iface->idesc->bAlternateSetting); 84102ac6454SAndrew Thompson 84202ac6454SAndrew Thompson done: 84302ac6454SAndrew Thompson if (do_unlock) { 84402ac6454SAndrew Thompson sx_unlock(udev->default_sx + 1); 84502ac6454SAndrew Thompson } 84602ac6454SAndrew Thompson return (err); 84702ac6454SAndrew Thompson } 84802ac6454SAndrew Thompson 84902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 85002ac6454SAndrew Thompson * usb2_set_endpoint_stall 85102ac6454SAndrew Thompson * 85202ac6454SAndrew Thompson * This function is used to make a BULK or INTERRUPT endpoint 85302ac6454SAndrew Thompson * send STALL tokens. 85402ac6454SAndrew Thompson * 85502ac6454SAndrew Thompson * Returns: 85602ac6454SAndrew Thompson * 0: Success 85702ac6454SAndrew Thompson * Else: Failure 85802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 85902ac6454SAndrew Thompson usb2_error_t 86002ac6454SAndrew Thompson usb2_set_endpoint_stall(struct usb2_device *udev, struct usb2_pipe *pipe, 86102ac6454SAndrew Thompson uint8_t do_stall) 86202ac6454SAndrew Thompson { 86302ac6454SAndrew Thompson struct usb2_xfer *xfer; 86402ac6454SAndrew Thompson uint8_t et; 86502ac6454SAndrew Thompson uint8_t was_stalled; 86602ac6454SAndrew Thompson 86702ac6454SAndrew Thompson if (pipe == NULL) { 86802ac6454SAndrew Thompson /* nothing to do */ 86902ac6454SAndrew Thompson DPRINTF("Cannot find endpoint\n"); 87002ac6454SAndrew Thompson /* 87102ac6454SAndrew Thompson * Pretend that the clear or set stall request is 87202ac6454SAndrew Thompson * successful else some USB host stacks can do 87302ac6454SAndrew Thompson * strange things, especially when a control endpoint 87402ac6454SAndrew Thompson * stalls. 87502ac6454SAndrew Thompson */ 87602ac6454SAndrew Thompson return (0); 87702ac6454SAndrew Thompson } 87802ac6454SAndrew Thompson et = (pipe->edesc->bmAttributes & UE_XFERTYPE); 87902ac6454SAndrew Thompson 88002ac6454SAndrew Thompson if ((et != UE_BULK) && 88102ac6454SAndrew Thompson (et != UE_INTERRUPT)) { 88202ac6454SAndrew Thompson /* 88302ac6454SAndrew Thompson * Should not stall control 88402ac6454SAndrew Thompson * nor isochronous endpoints. 88502ac6454SAndrew Thompson */ 88602ac6454SAndrew Thompson DPRINTF("Invalid endpoint\n"); 88702ac6454SAndrew Thompson return (0); 88802ac6454SAndrew Thompson } 88902ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 89002ac6454SAndrew Thompson 89102ac6454SAndrew Thompson /* store current stall state */ 89202ac6454SAndrew Thompson was_stalled = pipe->is_stalled; 89302ac6454SAndrew Thompson 89402ac6454SAndrew Thompson /* check for no change */ 89502ac6454SAndrew Thompson if (was_stalled && do_stall) { 89602ac6454SAndrew Thompson /* if the pipe is already stalled do nothing */ 89702ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 89802ac6454SAndrew Thompson DPRINTF("No change\n"); 89902ac6454SAndrew Thompson return (0); 90002ac6454SAndrew Thompson } 90102ac6454SAndrew Thompson /* set stalled state */ 90202ac6454SAndrew Thompson pipe->is_stalled = 1; 90302ac6454SAndrew Thompson 90402ac6454SAndrew Thompson if (do_stall || (!was_stalled)) { 90502ac6454SAndrew Thompson if (!was_stalled) { 90602ac6454SAndrew Thompson /* lookup the current USB transfer, if any */ 90702ac6454SAndrew Thompson xfer = pipe->pipe_q.curr; 90802ac6454SAndrew Thompson } else { 90902ac6454SAndrew Thompson xfer = NULL; 91002ac6454SAndrew Thompson } 91102ac6454SAndrew Thompson 91202ac6454SAndrew Thompson /* 91302ac6454SAndrew Thompson * If "xfer" is non-NULL the "set_stall" method will 91402ac6454SAndrew Thompson * complete the USB transfer like in case of a timeout 91502ac6454SAndrew Thompson * setting the error code "USB_ERR_STALLED". 91602ac6454SAndrew Thompson */ 91702ac6454SAndrew Thompson (udev->bus->methods->set_stall) (udev, xfer, pipe); 91802ac6454SAndrew Thompson } 91902ac6454SAndrew Thompson if (!do_stall) { 92002ac6454SAndrew Thompson pipe->toggle_next = 0; /* reset data toggle */ 92102ac6454SAndrew Thompson pipe->is_stalled = 0; /* clear stalled state */ 92202ac6454SAndrew Thompson 92302ac6454SAndrew Thompson (udev->bus->methods->clear_stall) (udev, pipe); 92402ac6454SAndrew Thompson 92502ac6454SAndrew Thompson /* start up the current or next transfer, if any */ 92602ac6454SAndrew Thompson usb2_command_wrapper(&pipe->pipe_q, pipe->pipe_q.curr); 92702ac6454SAndrew Thompson } 92802ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 92902ac6454SAndrew Thompson return (0); 93002ac6454SAndrew Thompson } 93102ac6454SAndrew Thompson 93202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 93302ac6454SAndrew Thompson * usb2_reset_iface_endpoints - used in USB device side mode 93402ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 93502ac6454SAndrew Thompson usb2_error_t 93602ac6454SAndrew Thompson usb2_reset_iface_endpoints(struct usb2_device *udev, uint8_t iface_index) 93702ac6454SAndrew Thompson { 93802ac6454SAndrew Thompson struct usb2_pipe *pipe; 93902ac6454SAndrew Thompson struct usb2_pipe *pipe_end; 94002ac6454SAndrew Thompson usb2_error_t err; 94102ac6454SAndrew Thompson 94202ac6454SAndrew Thompson pipe = udev->pipes; 94363521bbcSAndrew Thompson pipe_end = udev->pipes + udev->pipes_max; 94402ac6454SAndrew Thompson 94502ac6454SAndrew Thompson for (; pipe != pipe_end; pipe++) { 94602ac6454SAndrew Thompson 94702ac6454SAndrew Thompson if ((pipe->edesc == NULL) || 94802ac6454SAndrew Thompson (pipe->iface_index != iface_index)) { 94902ac6454SAndrew Thompson continue; 95002ac6454SAndrew Thompson } 95102ac6454SAndrew Thompson /* simulate a clear stall from the peer */ 95202ac6454SAndrew Thompson err = usb2_set_endpoint_stall(udev, pipe, 0); 95302ac6454SAndrew Thompson if (err) { 95402ac6454SAndrew Thompson /* just ignore */ 95502ac6454SAndrew Thompson } 95602ac6454SAndrew Thompson } 95702ac6454SAndrew Thompson return (0); 95802ac6454SAndrew Thompson } 95902ac6454SAndrew Thompson 96002ac6454SAndrew Thompson /*------------------------------------------------------------------------* 96102ac6454SAndrew Thompson * usb2_detach_device_sub 96202ac6454SAndrew Thompson * 96302ac6454SAndrew Thompson * This function will try to detach an USB device. If it fails a panic 96402ac6454SAndrew Thompson * will result. 965bdd41206SAndrew Thompson * 966bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 96702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 96802ac6454SAndrew Thompson static void 96902ac6454SAndrew Thompson usb2_detach_device_sub(struct usb2_device *udev, device_t *ppdev, 970bdd41206SAndrew Thompson uint8_t flag) 97102ac6454SAndrew Thompson { 97202ac6454SAndrew Thompson device_t dev; 97302ac6454SAndrew Thompson int err; 97402ac6454SAndrew Thompson 975bdd41206SAndrew Thompson if (!(flag & USB_UNCFG_FLAG_FREE_SUBDEV)) { 97602ac6454SAndrew Thompson 97702ac6454SAndrew Thompson *ppdev = NULL; 97802ac6454SAndrew Thompson 97902ac6454SAndrew Thompson } else if (*ppdev) { 98002ac6454SAndrew Thompson 98102ac6454SAndrew Thompson /* 98202ac6454SAndrew Thompson * NOTE: It is important to clear "*ppdev" before deleting 98302ac6454SAndrew Thompson * the child due to some device methods being called late 98402ac6454SAndrew Thompson * during the delete process ! 98502ac6454SAndrew Thompson */ 98602ac6454SAndrew Thompson dev = *ppdev; 98702ac6454SAndrew Thompson *ppdev = NULL; 98802ac6454SAndrew Thompson 98902ac6454SAndrew Thompson device_printf(dev, "at %s, port %d, addr %d " 99002ac6454SAndrew Thompson "(disconnected)\n", 99102ac6454SAndrew Thompson device_get_nameunit(udev->parent_dev), 99202ac6454SAndrew Thompson udev->port_no, udev->address); 99302ac6454SAndrew Thompson 99402ac6454SAndrew Thompson if (device_is_attached(dev)) { 99502ac6454SAndrew Thompson if (udev->flags.suspended) { 99602ac6454SAndrew Thompson err = DEVICE_RESUME(dev); 99702ac6454SAndrew Thompson if (err) { 99802ac6454SAndrew Thompson device_printf(dev, "Resume failed!\n"); 99902ac6454SAndrew Thompson } 100002ac6454SAndrew Thompson } 100102ac6454SAndrew Thompson if (device_detach(dev)) { 100202ac6454SAndrew Thompson goto error; 100302ac6454SAndrew Thompson } 100402ac6454SAndrew Thompson } 100502ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, dev)) { 100602ac6454SAndrew Thompson goto error; 100702ac6454SAndrew Thompson } 100802ac6454SAndrew Thompson } 100902ac6454SAndrew Thompson return; 101002ac6454SAndrew Thompson 101102ac6454SAndrew Thompson error: 101202ac6454SAndrew Thompson /* Detach is not allowed to fail in the USB world */ 101302ac6454SAndrew Thompson panic("An USB driver would not detach!\n"); 101402ac6454SAndrew Thompson } 101502ac6454SAndrew Thompson 101602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 101702ac6454SAndrew Thompson * usb2_detach_device 101802ac6454SAndrew Thompson * 101902ac6454SAndrew Thompson * The following function will detach the matching interfaces. 102002ac6454SAndrew Thompson * This function is NULL safe. 1021bdd41206SAndrew Thompson * 1022bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 102302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 102402ac6454SAndrew Thompson void 102502ac6454SAndrew Thompson usb2_detach_device(struct usb2_device *udev, uint8_t iface_index, 1026bdd41206SAndrew Thompson uint8_t flag) 102702ac6454SAndrew Thompson { 102802ac6454SAndrew Thompson struct usb2_interface *iface; 102902ac6454SAndrew Thompson uint8_t i; 103002ac6454SAndrew Thompson 103102ac6454SAndrew Thompson if (udev == NULL) { 103202ac6454SAndrew Thompson /* nothing to do */ 103302ac6454SAndrew Thompson return; 103402ac6454SAndrew Thompson } 103502ac6454SAndrew Thompson DPRINTFN(4, "udev=%p\n", udev); 103602ac6454SAndrew Thompson 1037bdd41206SAndrew Thompson sx_assert(udev->default_sx + 1, SA_LOCKED); 103802ac6454SAndrew Thompson 103902ac6454SAndrew Thompson /* 104002ac6454SAndrew Thompson * First detach the child to give the child's detach routine a 104102ac6454SAndrew Thompson * chance to detach the sub-devices in the correct order. 104202ac6454SAndrew Thompson * Then delete the child using "device_delete_child()" which 104302ac6454SAndrew Thompson * will detach all sub-devices from the bottom and upwards! 104402ac6454SAndrew Thompson */ 104502ac6454SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 104602ac6454SAndrew Thompson i = iface_index; 104702ac6454SAndrew Thompson iface_index = i + 1; 104802ac6454SAndrew Thompson } else { 104902ac6454SAndrew Thompson i = 0; 105002ac6454SAndrew Thompson iface_index = USB_IFACE_MAX; 105102ac6454SAndrew Thompson } 105202ac6454SAndrew Thompson 105302ac6454SAndrew Thompson /* do the detach */ 105402ac6454SAndrew Thompson 105502ac6454SAndrew Thompson for (; i != iface_index; i++) { 105602ac6454SAndrew Thompson 105702ac6454SAndrew Thompson iface = usb2_get_iface(udev, i); 105802ac6454SAndrew Thompson if (iface == NULL) { 105902ac6454SAndrew Thompson /* looks like the end of the USB interfaces */ 106002ac6454SAndrew Thompson break; 106102ac6454SAndrew Thompson } 1062bdd41206SAndrew Thompson usb2_detach_device_sub(udev, &iface->subdev, flag); 106302ac6454SAndrew Thompson } 106402ac6454SAndrew Thompson } 106502ac6454SAndrew Thompson 106602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 106702ac6454SAndrew Thompson * usb2_probe_and_attach_sub 106802ac6454SAndrew Thompson * 106902ac6454SAndrew Thompson * Returns: 107002ac6454SAndrew Thompson * 0: Success 107102ac6454SAndrew Thompson * Else: Failure 107202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 107302ac6454SAndrew Thompson static uint8_t 107402ac6454SAndrew Thompson usb2_probe_and_attach_sub(struct usb2_device *udev, 107502ac6454SAndrew Thompson struct usb2_attach_arg *uaa) 107602ac6454SAndrew Thompson { 107702ac6454SAndrew Thompson struct usb2_interface *iface; 107802ac6454SAndrew Thompson device_t dev; 107902ac6454SAndrew Thompson int err; 108002ac6454SAndrew Thompson 108102ac6454SAndrew Thompson iface = uaa->iface; 108202ac6454SAndrew Thompson if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) { 108302ac6454SAndrew Thompson /* leave interface alone */ 108402ac6454SAndrew Thompson return (0); 108502ac6454SAndrew Thompson } 108602ac6454SAndrew Thompson dev = iface->subdev; 108702ac6454SAndrew Thompson if (dev) { 108802ac6454SAndrew Thompson 108902ac6454SAndrew Thompson /* clean up after module unload */ 109002ac6454SAndrew Thompson 109102ac6454SAndrew Thompson if (device_is_attached(dev)) { 109202ac6454SAndrew Thompson /* already a device there */ 109302ac6454SAndrew Thompson return (0); 109402ac6454SAndrew Thompson } 109502ac6454SAndrew Thompson /* clear "iface->subdev" as early as possible */ 109602ac6454SAndrew Thompson 109702ac6454SAndrew Thompson iface->subdev = NULL; 109802ac6454SAndrew Thompson 109902ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, dev)) { 110002ac6454SAndrew Thompson 110102ac6454SAndrew Thompson /* 110202ac6454SAndrew Thompson * Panic here, else one can get a double call 110302ac6454SAndrew Thompson * to device_detach(). USB devices should 110402ac6454SAndrew Thompson * never fail on detach! 110502ac6454SAndrew Thompson */ 110602ac6454SAndrew Thompson panic("device_delete_child() failed!\n"); 110702ac6454SAndrew Thompson } 110802ac6454SAndrew Thompson } 110902ac6454SAndrew Thompson if (uaa->temp_dev == NULL) { 111002ac6454SAndrew Thompson 111102ac6454SAndrew Thompson /* create a new child */ 111202ac6454SAndrew Thompson uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1); 111302ac6454SAndrew Thompson if (uaa->temp_dev == NULL) { 111402ac6454SAndrew Thompson device_printf(udev->parent_dev, 111502ac6454SAndrew Thompson "Device creation failed!\n"); 111602ac6454SAndrew Thompson return (1); /* failure */ 111702ac6454SAndrew Thompson } 111802ac6454SAndrew Thompson device_set_ivars(uaa->temp_dev, uaa); 111902ac6454SAndrew Thompson device_quiet(uaa->temp_dev); 112002ac6454SAndrew Thompson } 112102ac6454SAndrew Thompson /* 112202ac6454SAndrew Thompson * Set "subdev" before probe and attach so that "devd" gets 112302ac6454SAndrew Thompson * the information it needs. 112402ac6454SAndrew Thompson */ 112502ac6454SAndrew Thompson iface->subdev = uaa->temp_dev; 112602ac6454SAndrew Thompson 112702ac6454SAndrew Thompson if (device_probe_and_attach(iface->subdev) == 0) { 112802ac6454SAndrew Thompson /* 112902ac6454SAndrew Thompson * The USB attach arguments are only available during probe 113002ac6454SAndrew Thompson * and attach ! 113102ac6454SAndrew Thompson */ 113202ac6454SAndrew Thompson uaa->temp_dev = NULL; 113302ac6454SAndrew Thompson device_set_ivars(iface->subdev, NULL); 113402ac6454SAndrew Thompson 113502ac6454SAndrew Thompson if (udev->flags.suspended) { 113602ac6454SAndrew Thompson err = DEVICE_SUSPEND(iface->subdev); 113702ac6454SAndrew Thompson device_printf(iface->subdev, "Suspend failed\n"); 113802ac6454SAndrew Thompson } 113902ac6454SAndrew Thompson return (0); /* success */ 114002ac6454SAndrew Thompson } else { 114102ac6454SAndrew Thompson /* No USB driver found */ 114202ac6454SAndrew Thompson iface->subdev = NULL; 114302ac6454SAndrew Thompson } 114402ac6454SAndrew Thompson return (1); /* failure */ 114502ac6454SAndrew Thompson } 114602ac6454SAndrew Thompson 114702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 114802ac6454SAndrew Thompson * usb2_set_parent_iface 114902ac6454SAndrew Thompson * 115002ac6454SAndrew Thompson * Using this function will lock the alternate interface setting on an 115102ac6454SAndrew Thompson * interface. It is typically used for multi interface drivers. In USB 115202ac6454SAndrew Thompson * device side mode it is assumed that the alternate interfaces all 115302ac6454SAndrew Thompson * have the same endpoint descriptors. The default parent index value 115402ac6454SAndrew Thompson * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not 115502ac6454SAndrew Thompson * locked. 115602ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 115702ac6454SAndrew Thompson void 115802ac6454SAndrew Thompson usb2_set_parent_iface(struct usb2_device *udev, uint8_t iface_index, 115902ac6454SAndrew Thompson uint8_t parent_index) 116002ac6454SAndrew Thompson { 116102ac6454SAndrew Thompson struct usb2_interface *iface; 116202ac6454SAndrew Thompson 116302ac6454SAndrew Thompson iface = usb2_get_iface(udev, iface_index); 116402ac6454SAndrew Thompson if (iface) { 116502ac6454SAndrew Thompson iface->parent_iface_index = parent_index; 116602ac6454SAndrew Thompson } 116702ac6454SAndrew Thompson } 116802ac6454SAndrew Thompson 116902ac6454SAndrew Thompson static void 117002ac6454SAndrew Thompson usb2_init_attach_arg(struct usb2_device *udev, 117102ac6454SAndrew Thompson struct usb2_attach_arg *uaa) 117202ac6454SAndrew Thompson { 117302ac6454SAndrew Thompson bzero(uaa, sizeof(*uaa)); 117402ac6454SAndrew Thompson 117502ac6454SAndrew Thompson uaa->device = udev; 117602ac6454SAndrew Thompson uaa->usb2_mode = udev->flags.usb2_mode; 117702ac6454SAndrew Thompson uaa->port = udev->port_no; 117802ac6454SAndrew Thompson 117902ac6454SAndrew Thompson uaa->info.idVendor = UGETW(udev->ddesc.idVendor); 118002ac6454SAndrew Thompson uaa->info.idProduct = UGETW(udev->ddesc.idProduct); 118102ac6454SAndrew Thompson uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice); 118202ac6454SAndrew Thompson uaa->info.bDeviceClass = udev->ddesc.bDeviceClass; 118302ac6454SAndrew Thompson uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass; 118402ac6454SAndrew Thompson uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol; 118502ac6454SAndrew Thompson uaa->info.bConfigIndex = udev->curr_config_index; 118602ac6454SAndrew Thompson uaa->info.bConfigNum = udev->curr_config_no; 118702ac6454SAndrew Thompson } 118802ac6454SAndrew Thompson 118902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 119002ac6454SAndrew Thompson * usb2_probe_and_attach 119102ac6454SAndrew Thompson * 119202ac6454SAndrew Thompson * This function is called from "uhub_explore_sub()", 119302ac6454SAndrew Thompson * "usb2_handle_set_config()" and "usb2_handle_request()". 119402ac6454SAndrew Thompson * 119502ac6454SAndrew Thompson * Returns: 119602ac6454SAndrew Thompson * 0: Success 119702ac6454SAndrew Thompson * Else: A control transfer failed 119802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 119902ac6454SAndrew Thompson usb2_error_t 120002ac6454SAndrew Thompson usb2_probe_and_attach(struct usb2_device *udev, uint8_t iface_index) 120102ac6454SAndrew Thompson { 120202ac6454SAndrew Thompson struct usb2_attach_arg uaa; 120302ac6454SAndrew Thompson struct usb2_interface *iface; 120402ac6454SAndrew Thompson uint8_t i; 120502ac6454SAndrew Thompson uint8_t j; 120602ac6454SAndrew Thompson uint8_t do_unlock; 120702ac6454SAndrew Thompson 120802ac6454SAndrew Thompson if (udev == NULL) { 120902ac6454SAndrew Thompson DPRINTF("udev == NULL\n"); 121002ac6454SAndrew Thompson return (USB_ERR_INVAL); 121102ac6454SAndrew Thompson } 121202ac6454SAndrew Thompson /* automatic locking */ 121302ac6454SAndrew Thompson if (sx_xlocked(udev->default_sx + 1)) { 121402ac6454SAndrew Thompson do_unlock = 0; 121502ac6454SAndrew Thompson } else { 121602ac6454SAndrew Thompson do_unlock = 1; 121702ac6454SAndrew Thompson sx_xlock(udev->default_sx + 1); 121802ac6454SAndrew Thompson } 121902ac6454SAndrew Thompson 122002ac6454SAndrew Thompson if (udev->curr_config_index == USB_UNCONFIG_INDEX) { 122102ac6454SAndrew Thompson /* do nothing - no configuration has been set */ 122202ac6454SAndrew Thompson goto done; 122302ac6454SAndrew Thompson } 122402ac6454SAndrew Thompson /* setup USB attach arguments */ 122502ac6454SAndrew Thompson 122602ac6454SAndrew Thompson usb2_init_attach_arg(udev, &uaa); 122702ac6454SAndrew Thompson 122802ac6454SAndrew Thompson /* Check if only one interface should be probed: */ 122902ac6454SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 123002ac6454SAndrew Thompson i = iface_index; 123102ac6454SAndrew Thompson j = i + 1; 123202ac6454SAndrew Thompson } else { 123302ac6454SAndrew Thompson i = 0; 123402ac6454SAndrew Thompson j = USB_IFACE_MAX; 123502ac6454SAndrew Thompson } 123602ac6454SAndrew Thompson 123702ac6454SAndrew Thompson /* Do the probe and attach */ 123802ac6454SAndrew Thompson for (; i != j; i++) { 123902ac6454SAndrew Thompson 124002ac6454SAndrew Thompson iface = usb2_get_iface(udev, i); 124102ac6454SAndrew Thompson if (iface == NULL) { 124202ac6454SAndrew Thompson /* 124302ac6454SAndrew Thompson * Looks like the end of the USB 124402ac6454SAndrew Thompson * interfaces ! 124502ac6454SAndrew Thompson */ 124602ac6454SAndrew Thompson DPRINTFN(2, "end of interfaces " 124702ac6454SAndrew Thompson "at %u\n", i); 124802ac6454SAndrew Thompson break; 124902ac6454SAndrew Thompson } 125002ac6454SAndrew Thompson if (iface->idesc == NULL) { 125102ac6454SAndrew Thompson /* no interface descriptor */ 125202ac6454SAndrew Thompson continue; 125302ac6454SAndrew Thompson } 125402ac6454SAndrew Thompson uaa.iface = iface; 125502ac6454SAndrew Thompson 125602ac6454SAndrew Thompson uaa.info.bInterfaceClass = 125702ac6454SAndrew Thompson iface->idesc->bInterfaceClass; 125802ac6454SAndrew Thompson uaa.info.bInterfaceSubClass = 125902ac6454SAndrew Thompson iface->idesc->bInterfaceSubClass; 126002ac6454SAndrew Thompson uaa.info.bInterfaceProtocol = 126102ac6454SAndrew Thompson iface->idesc->bInterfaceProtocol; 126202ac6454SAndrew Thompson uaa.info.bIfaceIndex = i; 126302ac6454SAndrew Thompson uaa.info.bIfaceNum = 126402ac6454SAndrew Thompson iface->idesc->bInterfaceNumber; 126502ac6454SAndrew Thompson uaa.use_generic = 0; 126602ac6454SAndrew Thompson 126702ac6454SAndrew Thompson DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n", 126802ac6454SAndrew Thompson uaa.info.bInterfaceClass, 126902ac6454SAndrew Thompson uaa.info.bInterfaceSubClass, 127002ac6454SAndrew Thompson uaa.info.bInterfaceProtocol, 127102ac6454SAndrew Thompson uaa.info.bIfaceIndex, 127202ac6454SAndrew Thompson uaa.info.bIfaceNum); 127302ac6454SAndrew Thompson 127402ac6454SAndrew Thompson /* try specific interface drivers first */ 127502ac6454SAndrew Thompson 127602ac6454SAndrew Thompson if (usb2_probe_and_attach_sub(udev, &uaa)) { 127702ac6454SAndrew Thompson /* ignore */ 127802ac6454SAndrew Thompson } 127902ac6454SAndrew Thompson /* try generic interface drivers last */ 128002ac6454SAndrew Thompson 128102ac6454SAndrew Thompson uaa.use_generic = 1; 128202ac6454SAndrew Thompson 128302ac6454SAndrew Thompson if (usb2_probe_and_attach_sub(udev, &uaa)) { 128402ac6454SAndrew Thompson /* ignore */ 128502ac6454SAndrew Thompson } 128602ac6454SAndrew Thompson } 128702ac6454SAndrew Thompson 128802ac6454SAndrew Thompson if (uaa.temp_dev) { 128902ac6454SAndrew Thompson /* remove the last created child; it is unused */ 129002ac6454SAndrew Thompson 129102ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, uaa.temp_dev)) { 129202ac6454SAndrew Thompson DPRINTFN(0, "device delete child failed!\n"); 129302ac6454SAndrew Thompson } 129402ac6454SAndrew Thompson } 129502ac6454SAndrew Thompson done: 129602ac6454SAndrew Thompson if (do_unlock) { 129702ac6454SAndrew Thompson sx_unlock(udev->default_sx + 1); 129802ac6454SAndrew Thompson } 129902ac6454SAndrew Thompson return (0); 130002ac6454SAndrew Thompson } 130102ac6454SAndrew Thompson 130202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 130302ac6454SAndrew Thompson * usb2_suspend_resume_sub 130402ac6454SAndrew Thompson * 130502ac6454SAndrew Thompson * This function is called when the suspend or resume methods should 130602ac6454SAndrew Thompson * be executed on an USB device. 130702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 130802ac6454SAndrew Thompson static void 130902ac6454SAndrew Thompson usb2_suspend_resume_sub(struct usb2_device *udev, device_t dev, uint8_t do_suspend) 131002ac6454SAndrew Thompson { 131102ac6454SAndrew Thompson int err; 131202ac6454SAndrew Thompson 131302ac6454SAndrew Thompson if (dev == NULL) { 131402ac6454SAndrew Thompson return; 131502ac6454SAndrew Thompson } 131602ac6454SAndrew Thompson if (!device_is_attached(dev)) { 131702ac6454SAndrew Thompson return; 131802ac6454SAndrew Thompson } 131902ac6454SAndrew Thompson if (do_suspend) { 132002ac6454SAndrew Thompson err = DEVICE_SUSPEND(dev); 132102ac6454SAndrew Thompson } else { 132202ac6454SAndrew Thompson err = DEVICE_RESUME(dev); 132302ac6454SAndrew Thompson } 132402ac6454SAndrew Thompson if (err) { 132502ac6454SAndrew Thompson device_printf(dev, "%s failed!\n", 132602ac6454SAndrew Thompson do_suspend ? "Suspend" : "Resume"); 132702ac6454SAndrew Thompson } 132802ac6454SAndrew Thompson } 132902ac6454SAndrew Thompson 133002ac6454SAndrew Thompson /*------------------------------------------------------------------------* 133102ac6454SAndrew Thompson * usb2_suspend_resume 133202ac6454SAndrew Thompson * 133302ac6454SAndrew Thompson * The following function will suspend or resume the USB device. 133402ac6454SAndrew Thompson * 133502ac6454SAndrew Thompson * Returns: 133602ac6454SAndrew Thompson * 0: Success 133702ac6454SAndrew Thompson * Else: Failure 133802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 133902ac6454SAndrew Thompson usb2_error_t 134002ac6454SAndrew Thompson usb2_suspend_resume(struct usb2_device *udev, uint8_t do_suspend) 134102ac6454SAndrew Thompson { 134202ac6454SAndrew Thompson struct usb2_interface *iface; 134302ac6454SAndrew Thompson uint8_t i; 134402ac6454SAndrew Thompson 134502ac6454SAndrew Thompson if (udev == NULL) { 134602ac6454SAndrew Thompson /* nothing to do */ 134702ac6454SAndrew Thompson return (0); 134802ac6454SAndrew Thompson } 134902ac6454SAndrew Thompson DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend); 135002ac6454SAndrew Thompson 135102ac6454SAndrew Thompson sx_assert(udev->default_sx + 1, SA_LOCKED); 135202ac6454SAndrew Thompson 135302ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 135402ac6454SAndrew Thompson /* filter the suspend events */ 135502ac6454SAndrew Thompson if (udev->flags.suspended == do_suspend) { 135602ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 135702ac6454SAndrew Thompson /* nothing to do */ 135802ac6454SAndrew Thompson return (0); 135902ac6454SAndrew Thompson } 136002ac6454SAndrew Thompson udev->flags.suspended = do_suspend; 136102ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 136202ac6454SAndrew Thompson 136302ac6454SAndrew Thompson /* do the suspend or resume */ 136402ac6454SAndrew Thompson 136502ac6454SAndrew Thompson for (i = 0; i != USB_IFACE_MAX; i++) { 136602ac6454SAndrew Thompson 136702ac6454SAndrew Thompson iface = usb2_get_iface(udev, i); 136802ac6454SAndrew Thompson if (iface == NULL) { 136902ac6454SAndrew Thompson /* looks like the end of the USB interfaces */ 137002ac6454SAndrew Thompson break; 137102ac6454SAndrew Thompson } 137202ac6454SAndrew Thompson usb2_suspend_resume_sub(udev, iface->subdev, do_suspend); 137302ac6454SAndrew Thompson } 137402ac6454SAndrew Thompson return (0); 137502ac6454SAndrew Thompson } 137602ac6454SAndrew Thompson 137702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 137802ac6454SAndrew Thompson * usb2_clear_stall_proc 137902ac6454SAndrew Thompson * 138002ac6454SAndrew Thompson * This function performs generic USB clear stall operations. 138102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 138202ac6454SAndrew Thompson static void 138302ac6454SAndrew Thompson usb2_clear_stall_proc(struct usb2_proc_msg *_pm) 138402ac6454SAndrew Thompson { 138502ac6454SAndrew Thompson struct usb2_clear_stall_msg *pm = (void *)_pm; 138602ac6454SAndrew Thompson struct usb2_device *udev = pm->udev; 138702ac6454SAndrew Thompson 138802ac6454SAndrew Thompson /* Change lock */ 138902ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 139002ac6454SAndrew Thompson mtx_lock(udev->default_mtx); 139102ac6454SAndrew Thompson 139202ac6454SAndrew Thompson /* Start clear stall callback */ 139302ac6454SAndrew Thompson usb2_transfer_start(udev->default_xfer[1]); 139402ac6454SAndrew Thompson 139502ac6454SAndrew Thompson /* Change lock */ 139602ac6454SAndrew Thompson mtx_unlock(udev->default_mtx); 139702ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 139802ac6454SAndrew Thompson } 139902ac6454SAndrew Thompson 140002ac6454SAndrew Thompson /*------------------------------------------------------------------------* 140102ac6454SAndrew Thompson * usb2_alloc_device 140202ac6454SAndrew Thompson * 140302ac6454SAndrew Thompson * This function allocates a new USB device. This function is called 140402ac6454SAndrew Thompson * when a new device has been put in the powered state, but not yet in 140502ac6454SAndrew Thompson * the addressed state. Get initial descriptor, set the address, get 140602ac6454SAndrew Thompson * full descriptor and get strings. 140702ac6454SAndrew Thompson * 140802ac6454SAndrew Thompson * Return values: 140902ac6454SAndrew Thompson * 0: Failure 141002ac6454SAndrew Thompson * Else: Success 141102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 141202ac6454SAndrew Thompson struct usb2_device * 141302ac6454SAndrew Thompson usb2_alloc_device(device_t parent_dev, struct usb2_bus *bus, 141402ac6454SAndrew Thompson struct usb2_device *parent_hub, uint8_t depth, 141502ac6454SAndrew Thompson uint8_t port_index, uint8_t port_no, uint8_t speed, uint8_t usb2_mode) 141602ac6454SAndrew Thompson { 141702ac6454SAndrew Thompson struct usb2_attach_arg uaa; 141802ac6454SAndrew Thompson struct usb2_device *udev; 141902ac6454SAndrew Thompson struct usb2_device *adev; 142002ac6454SAndrew Thompson struct usb2_device *hub; 142102ac6454SAndrew Thompson uint8_t *scratch_ptr; 142202ac6454SAndrew Thompson uint32_t scratch_size; 142302ac6454SAndrew Thompson usb2_error_t err; 142402ac6454SAndrew Thompson uint8_t device_index; 142502ac6454SAndrew Thompson 142602ac6454SAndrew Thompson DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, " 142702ac6454SAndrew Thompson "port_index=%u, port_no=%u, speed=%u, usb2_mode=%u\n", 142802ac6454SAndrew Thompson parent_dev, bus, parent_hub, depth, port_index, port_no, 142902ac6454SAndrew Thompson speed, usb2_mode); 143002ac6454SAndrew Thompson 143102ac6454SAndrew Thompson /* 143202ac6454SAndrew Thompson * Find an unused device index. In USB Host mode this is the 143302ac6454SAndrew Thompson * same as the device address. 143402ac6454SAndrew Thompson * 143502ac6454SAndrew Thompson * Device index zero is not used and device index 1 should 143602ac6454SAndrew Thompson * always be the root hub. 143702ac6454SAndrew Thompson */ 143802ac6454SAndrew Thompson for (device_index = USB_ROOT_HUB_ADDR; 143902ac6454SAndrew Thompson (device_index != bus->devices_max) && 144002ac6454SAndrew Thompson (bus->devices[device_index] != NULL); 144102ac6454SAndrew Thompson device_index++) /* nop */; 144202ac6454SAndrew Thompson 144302ac6454SAndrew Thompson if (device_index == bus->devices_max) { 144402ac6454SAndrew Thompson device_printf(bus->bdev, 144502ac6454SAndrew Thompson "No free USB device index for new device!\n"); 144602ac6454SAndrew Thompson return (NULL); 144702ac6454SAndrew Thompson } 144802ac6454SAndrew Thompson 144902ac6454SAndrew Thompson if (depth > 0x10) { 145002ac6454SAndrew Thompson device_printf(bus->bdev, 145102ac6454SAndrew Thompson "Invalid device depth!\n"); 145202ac6454SAndrew Thompson return (NULL); 145302ac6454SAndrew Thompson } 145402ac6454SAndrew Thompson udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO); 145502ac6454SAndrew Thompson if (udev == NULL) { 145602ac6454SAndrew Thompson return (NULL); 145702ac6454SAndrew Thompson } 145802ac6454SAndrew Thompson /* initialise our SX-lock */ 145902ac6454SAndrew Thompson sx_init(udev->default_sx, "0123456789ABCDEF - USB device SX lock" + depth); 146002ac6454SAndrew Thompson 146102ac6454SAndrew Thompson /* initialise our SX-lock */ 146202ac6454SAndrew Thompson sx_init(udev->default_sx + 1, "0123456789ABCDEF - USB config SX lock" + depth); 146302ac6454SAndrew Thompson 146402ac6454SAndrew Thompson usb2_cv_init(udev->default_cv, "WCTRL"); 146502ac6454SAndrew Thompson usb2_cv_init(udev->default_cv + 1, "UGONE"); 146602ac6454SAndrew Thompson 146702ac6454SAndrew Thompson /* initialise our mutex */ 146802ac6454SAndrew Thompson mtx_init(udev->default_mtx, "USB device mutex", NULL, MTX_DEF); 146902ac6454SAndrew Thompson 147002ac6454SAndrew Thompson /* initialise generic clear stall */ 147102ac6454SAndrew Thompson udev->cs_msg[0].hdr.pm_callback = &usb2_clear_stall_proc; 147202ac6454SAndrew Thompson udev->cs_msg[0].udev = udev; 147302ac6454SAndrew Thompson udev->cs_msg[1].hdr.pm_callback = &usb2_clear_stall_proc; 147402ac6454SAndrew Thompson udev->cs_msg[1].udev = udev; 147502ac6454SAndrew Thompson 147602ac6454SAndrew Thompson /* initialise some USB device fields */ 147702ac6454SAndrew Thompson udev->parent_hub = parent_hub; 147802ac6454SAndrew Thompson udev->parent_dev = parent_dev; 147902ac6454SAndrew Thompson udev->port_index = port_index; 148002ac6454SAndrew Thompson udev->port_no = port_no; 148102ac6454SAndrew Thompson udev->depth = depth; 148202ac6454SAndrew Thompson udev->bus = bus; 148302ac6454SAndrew Thompson udev->address = USB_START_ADDR; /* default value */ 1484578d0effSAndrew Thompson udev->plugtime = (usb2_ticks_t)ticks; 148502ac6454SAndrew Thompson /* 148602ac6454SAndrew Thompson * We need to force the power mode to "on" because there are plenty 148702ac6454SAndrew Thompson * of USB devices out there that do not work very well with 148802ac6454SAndrew Thompson * automatic suspend and resume! 148902ac6454SAndrew Thompson */ 149002ac6454SAndrew Thompson udev->power_mode = USB_POWER_MODE_ON; 149102ac6454SAndrew Thompson udev->pwr_save.last_xfer_time = ticks; 149202ac6454SAndrew Thompson /* we are not ready yet */ 149302ac6454SAndrew Thompson udev->refcount = 1; 149402ac6454SAndrew Thompson 149502ac6454SAndrew Thompson /* set up default endpoint descriptor */ 149602ac6454SAndrew Thompson udev->default_ep_desc.bLength = sizeof(udev->default_ep_desc); 149702ac6454SAndrew Thompson udev->default_ep_desc.bDescriptorType = UDESC_ENDPOINT; 149802ac6454SAndrew Thompson udev->default_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT; 149902ac6454SAndrew Thompson udev->default_ep_desc.bmAttributes = UE_CONTROL; 150002ac6454SAndrew Thompson udev->default_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET; 150102ac6454SAndrew Thompson udev->default_ep_desc.wMaxPacketSize[1] = 0; 150202ac6454SAndrew Thompson udev->default_ep_desc.bInterval = 0; 150302ac6454SAndrew Thompson udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET; 150402ac6454SAndrew Thompson 150502ac6454SAndrew Thompson udev->speed = speed; 150602ac6454SAndrew Thompson udev->flags.usb2_mode = usb2_mode; 150702ac6454SAndrew Thompson 150802ac6454SAndrew Thompson /* search for our High Speed USB HUB, if any */ 150902ac6454SAndrew Thompson 151002ac6454SAndrew Thompson adev = udev; 151102ac6454SAndrew Thompson hub = udev->parent_hub; 151202ac6454SAndrew Thompson 151302ac6454SAndrew Thompson while (hub) { 151402ac6454SAndrew Thompson if (hub->speed == USB_SPEED_HIGH) { 151502ac6454SAndrew Thompson udev->hs_hub_addr = hub->address; 151602ac6454SAndrew Thompson udev->hs_port_no = adev->port_no; 151702ac6454SAndrew Thompson break; 151802ac6454SAndrew Thompson } 151902ac6454SAndrew Thompson adev = hub; 152002ac6454SAndrew Thompson hub = hub->parent_hub; 152102ac6454SAndrew Thompson } 152202ac6454SAndrew Thompson 152302ac6454SAndrew Thompson /* init the default pipe */ 1524bdd41206SAndrew Thompson usb2_init_pipe(udev, 0, 152502ac6454SAndrew Thompson &udev->default_ep_desc, 152602ac6454SAndrew Thompson &udev->default_pipe); 152702ac6454SAndrew Thompson 152802ac6454SAndrew Thompson /* set device index */ 152902ac6454SAndrew Thompson udev->device_index = device_index; 153002ac6454SAndrew Thompson 15318755859aSAndrew Thompson #if USB_HAVE_UGEN 15320f6e8f93SAndrew Thompson /* Create ugen name */ 1533ee3e3ff5SAndrew Thompson snprintf(udev->ugen_name, sizeof(udev->ugen_name), 1534ee3e3ff5SAndrew Thompson USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev), 1535ee3e3ff5SAndrew Thompson device_index); 15368755859aSAndrew Thompson LIST_INIT(&udev->pd_list); 15378755859aSAndrew Thompson 15380f6e8f93SAndrew Thompson /* Create the control endpoint device */ 15390f6e8f93SAndrew Thompson udev->default_dev = usb2_make_dev(udev, 0, FREAD|FWRITE); 15400f6e8f93SAndrew Thompson 15410f6e8f93SAndrew Thompson /* Create a link from /dev/ugenX.X to the default endpoint */ 1542ee3e3ff5SAndrew Thompson make_dev_alias(udev->default_dev, udev->ugen_name); 15430f6e8f93SAndrew Thompson #endif 154402ac6454SAndrew Thompson if (udev->flags.usb2_mode == USB_MODE_HOST) { 154502ac6454SAndrew Thompson 1546e2805033SAndrew Thompson err = usb2_req_set_address(udev, NULL, device_index); 154702ac6454SAndrew Thompson 154802ac6454SAndrew Thompson /* This is the new USB device address from now on */ 154902ac6454SAndrew Thompson 155002ac6454SAndrew Thompson udev->address = device_index; 155102ac6454SAndrew Thompson 155202ac6454SAndrew Thompson /* 155302ac6454SAndrew Thompson * We ignore any set-address errors, hence there are 155402ac6454SAndrew Thompson * buggy USB devices out there that actually receive 155502ac6454SAndrew Thompson * the SETUP PID, but manage to set the address before 155602ac6454SAndrew Thompson * the STATUS stage is ACK'ed. If the device responds 155702ac6454SAndrew Thompson * to the subsequent get-descriptor at the new 155802ac6454SAndrew Thompson * address, then we know that the set-address command 155902ac6454SAndrew Thompson * was successful. 156002ac6454SAndrew Thompson */ 156102ac6454SAndrew Thompson if (err) { 156202ac6454SAndrew Thompson DPRINTFN(0, "set address %d failed " 156303797f33SAndrew Thompson "(%s, ignored)\n", udev->address, 156403797f33SAndrew Thompson usb2_errstr(err)); 156502ac6454SAndrew Thompson } 156602ac6454SAndrew Thompson /* allow device time to set new address */ 1567e2805033SAndrew Thompson usb2_pause_mtx(NULL, 156802ac6454SAndrew Thompson USB_MS_TO_TICKS(USB_SET_ADDRESS_SETTLE)); 156902ac6454SAndrew Thompson } else { 157002ac6454SAndrew Thompson /* We are not self powered */ 157102ac6454SAndrew Thompson udev->flags.self_powered = 0; 157202ac6454SAndrew Thompson 157302ac6454SAndrew Thompson /* Set unconfigured state */ 157402ac6454SAndrew Thompson udev->curr_config_no = USB_UNCONFIG_NO; 157502ac6454SAndrew Thompson udev->curr_config_index = USB_UNCONFIG_INDEX; 157602ac6454SAndrew Thompson 157702ac6454SAndrew Thompson /* Setup USB descriptors */ 157802ac6454SAndrew Thompson err = (usb2_temp_setup_by_index_p) (udev, usb2_template); 157902ac6454SAndrew Thompson if (err) { 158002ac6454SAndrew Thompson DPRINTFN(0, "setting up USB template failed maybe the USB " 158102ac6454SAndrew Thompson "template module has not been loaded\n"); 158202ac6454SAndrew Thompson goto done; 158302ac6454SAndrew Thompson } 158402ac6454SAndrew Thompson } 158502ac6454SAndrew Thompson 158602ac6454SAndrew Thompson /* 158702ac6454SAndrew Thompson * Get the first 8 bytes of the device descriptor ! 158802ac6454SAndrew Thompson * 158902ac6454SAndrew Thompson * NOTE: "usb2_do_request" will check the device descriptor 159002ac6454SAndrew Thompson * next time we do a request to see if the maximum packet size 159102ac6454SAndrew Thompson * changed! The 8 first bytes of the device descriptor 159202ac6454SAndrew Thompson * contains the maximum packet size to use on control endpoint 159302ac6454SAndrew Thompson * 0. If this value is different from "USB_MAX_IPACKET" a new 159402ac6454SAndrew Thompson * USB control request will be setup! 159502ac6454SAndrew Thompson */ 1596e2805033SAndrew Thompson err = usb2_req_get_desc(udev, NULL, NULL, &udev->ddesc, 159702ac6454SAndrew Thompson USB_MAX_IPACKET, USB_MAX_IPACKET, 0, UDESC_DEVICE, 0, 0); 159802ac6454SAndrew Thompson if (err) { 159902ac6454SAndrew Thompson DPRINTFN(0, "getting device descriptor " 160003797f33SAndrew Thompson "at addr %d failed, %s!\n", udev->address, 160103797f33SAndrew Thompson usb2_errstr(err)); 160202ac6454SAndrew Thompson /* XXX try to re-enumerate the device */ 1603e2805033SAndrew Thompson err = usb2_req_re_enumerate(udev, NULL); 160402ac6454SAndrew Thompson if (err) { 160502ac6454SAndrew Thompson goto done; 160602ac6454SAndrew Thompson } 160702ac6454SAndrew Thompson } 160802ac6454SAndrew Thompson DPRINTF("adding unit addr=%d, rev=%02x, class=%d, " 160902ac6454SAndrew Thompson "subclass=%d, protocol=%d, maxpacket=%d, len=%d, speed=%d\n", 161002ac6454SAndrew Thompson udev->address, UGETW(udev->ddesc.bcdUSB), 161102ac6454SAndrew Thompson udev->ddesc.bDeviceClass, 161202ac6454SAndrew Thompson udev->ddesc.bDeviceSubClass, 161302ac6454SAndrew Thompson udev->ddesc.bDeviceProtocol, 161402ac6454SAndrew Thompson udev->ddesc.bMaxPacketSize, 161502ac6454SAndrew Thompson udev->ddesc.bLength, 161602ac6454SAndrew Thompson udev->speed); 161702ac6454SAndrew Thompson 161802ac6454SAndrew Thompson /* get the full device descriptor */ 1619e2805033SAndrew Thompson err = usb2_req_get_device_desc(udev, NULL, &udev->ddesc); 162002ac6454SAndrew Thompson if (err) { 162102ac6454SAndrew Thompson DPRINTF("addr=%d, getting full desc failed\n", 162202ac6454SAndrew Thompson udev->address); 162302ac6454SAndrew Thompson goto done; 162402ac6454SAndrew Thompson } 162502ac6454SAndrew Thompson /* 162602ac6454SAndrew Thompson * Setup temporary USB attach args so that we can figure out some 162702ac6454SAndrew Thompson * basic quirks for this device. 162802ac6454SAndrew Thompson */ 162902ac6454SAndrew Thompson usb2_init_attach_arg(udev, &uaa); 163002ac6454SAndrew Thompson 163102ac6454SAndrew Thompson if (usb2_test_quirk(&uaa, UQ_BUS_POWERED)) { 163202ac6454SAndrew Thompson udev->flags.uq_bus_powered = 1; 163302ac6454SAndrew Thompson } 163402ac6454SAndrew Thompson if (usb2_test_quirk(&uaa, UQ_POWER_CLAIM)) { 163502ac6454SAndrew Thompson udev->flags.uq_power_claim = 1; 163602ac6454SAndrew Thompson } 163702ac6454SAndrew Thompson if (usb2_test_quirk(&uaa, UQ_NO_STRINGS)) { 163802ac6454SAndrew Thompson udev->flags.no_strings = 1; 163902ac6454SAndrew Thompson } 164002ac6454SAndrew Thompson /* 164102ac6454SAndrew Thompson * Workaround for buggy USB devices. 164202ac6454SAndrew Thompson * 164302ac6454SAndrew Thompson * It appears that some string-less USB chips will crash and 164402ac6454SAndrew Thompson * disappear if any attempts are made to read any string 164502ac6454SAndrew Thompson * descriptors. 164602ac6454SAndrew Thompson * 164702ac6454SAndrew Thompson * Try to detect such chips by checking the strings in the USB 164802ac6454SAndrew Thompson * device descriptor. If no strings are present there we 164902ac6454SAndrew Thompson * simply disable all USB strings. 165002ac6454SAndrew Thompson */ 165102ac6454SAndrew Thompson scratch_ptr = udev->bus->scratch[0].data; 165202ac6454SAndrew Thompson scratch_size = sizeof(udev->bus->scratch[0].data); 165302ac6454SAndrew Thompson 165402ac6454SAndrew Thompson if (udev->ddesc.iManufacturer || 165502ac6454SAndrew Thompson udev->ddesc.iProduct || 165602ac6454SAndrew Thompson udev->ddesc.iSerialNumber) { 165702ac6454SAndrew Thompson /* read out the language ID string */ 1658e2805033SAndrew Thompson err = usb2_req_get_string_desc(udev, NULL, 165902ac6454SAndrew Thompson (char *)scratch_ptr, 4, scratch_size, 166002ac6454SAndrew Thompson USB_LANGUAGE_TABLE); 166102ac6454SAndrew Thompson } else { 166202ac6454SAndrew Thompson err = USB_ERR_INVAL; 166302ac6454SAndrew Thompson } 166402ac6454SAndrew Thompson 166502ac6454SAndrew Thompson if (err || (scratch_ptr[0] < 4)) { 166602ac6454SAndrew Thompson udev->flags.no_strings = 1; 166702ac6454SAndrew Thompson } else { 166802ac6454SAndrew Thompson /* pick the first language as the default */ 166902ac6454SAndrew Thompson udev->langid = UGETW(scratch_ptr + 2); 167002ac6454SAndrew Thompson } 167102ac6454SAndrew Thompson 167202ac6454SAndrew Thompson /* assume 100mA bus powered for now. Changed when configured. */ 167302ac6454SAndrew Thompson udev->power = USB_MIN_POWER; 167402ac6454SAndrew Thompson 1675bdc081c6SAndrew Thompson #if USB_HAVE_STRINGS 167602ac6454SAndrew Thompson /* get serial number string */ 167702ac6454SAndrew Thompson err = usb2_req_get_string_any 1678e2805033SAndrew Thompson (udev, NULL, (char *)scratch_ptr, 167902ac6454SAndrew Thompson scratch_size, udev->ddesc.iSerialNumber); 168002ac6454SAndrew Thompson 168102ac6454SAndrew Thompson strlcpy(udev->serial, (char *)scratch_ptr, sizeof(udev->serial)); 168202ac6454SAndrew Thompson 168302ac6454SAndrew Thompson /* get manufacturer string */ 168402ac6454SAndrew Thompson err = usb2_req_get_string_any 1685e2805033SAndrew Thompson (udev, NULL, (char *)scratch_ptr, 168602ac6454SAndrew Thompson scratch_size, udev->ddesc.iManufacturer); 168702ac6454SAndrew Thompson 168802ac6454SAndrew Thompson strlcpy(udev->manufacturer, (char *)scratch_ptr, sizeof(udev->manufacturer)); 168902ac6454SAndrew Thompson 169002ac6454SAndrew Thompson /* get product string */ 169102ac6454SAndrew Thompson err = usb2_req_get_string_any 1692e2805033SAndrew Thompson (udev, NULL, (char *)scratch_ptr, 169302ac6454SAndrew Thompson scratch_size, udev->ddesc.iProduct); 169402ac6454SAndrew Thompson 169502ac6454SAndrew Thompson strlcpy(udev->product, (char *)scratch_ptr, sizeof(udev->product)); 169602ac6454SAndrew Thompson 169702ac6454SAndrew Thompson /* finish up all the strings */ 169802ac6454SAndrew Thompson usb2_check_strings(udev); 1699bdc081c6SAndrew Thompson #endif 170002ac6454SAndrew Thompson 170102ac6454SAndrew Thompson if (udev->flags.usb2_mode == USB_MODE_HOST) { 170202ac6454SAndrew Thompson uint8_t config_index; 170302ac6454SAndrew Thompson uint8_t config_quirk; 170402ac6454SAndrew Thompson uint8_t set_config_failed = 0; 170502ac6454SAndrew Thompson 170602ac6454SAndrew Thompson /* 170702ac6454SAndrew Thompson * Most USB devices should attach to config index 0 by 170802ac6454SAndrew Thompson * default 170902ac6454SAndrew Thompson */ 171002ac6454SAndrew Thompson if (usb2_test_quirk(&uaa, UQ_CFG_INDEX_0)) { 171102ac6454SAndrew Thompson config_index = 0; 171202ac6454SAndrew Thompson config_quirk = 1; 171302ac6454SAndrew Thompson } else if (usb2_test_quirk(&uaa, UQ_CFG_INDEX_1)) { 171402ac6454SAndrew Thompson config_index = 1; 171502ac6454SAndrew Thompson config_quirk = 1; 171602ac6454SAndrew Thompson } else if (usb2_test_quirk(&uaa, UQ_CFG_INDEX_2)) { 171702ac6454SAndrew Thompson config_index = 2; 171802ac6454SAndrew Thompson config_quirk = 1; 171902ac6454SAndrew Thompson } else if (usb2_test_quirk(&uaa, UQ_CFG_INDEX_3)) { 172002ac6454SAndrew Thompson config_index = 3; 172102ac6454SAndrew Thompson config_quirk = 1; 172202ac6454SAndrew Thompson } else if (usb2_test_quirk(&uaa, UQ_CFG_INDEX_4)) { 172302ac6454SAndrew Thompson config_index = 4; 172402ac6454SAndrew Thompson config_quirk = 1; 172502ac6454SAndrew Thompson } else { 172602ac6454SAndrew Thompson config_index = 0; 172702ac6454SAndrew Thompson config_quirk = 0; 172802ac6454SAndrew Thompson } 172902ac6454SAndrew Thompson 173002ac6454SAndrew Thompson repeat_set_config: 173102ac6454SAndrew Thompson 173202ac6454SAndrew Thompson DPRINTF("setting config %u\n", config_index); 173302ac6454SAndrew Thompson 173402ac6454SAndrew Thompson /* get the USB device configured */ 173502ac6454SAndrew Thompson err = usb2_set_config_index(udev, config_index); 173602ac6454SAndrew Thompson if (err) { 173702ac6454SAndrew Thompson if (udev->ddesc.bNumConfigurations != 0) { 173802ac6454SAndrew Thompson if (!set_config_failed) { 173902ac6454SAndrew Thompson set_config_failed = 1; 174002ac6454SAndrew Thompson /* XXX try to re-enumerate the device */ 174102ac6454SAndrew Thompson err = usb2_req_re_enumerate( 1742e2805033SAndrew Thompson udev, NULL); 174302ac6454SAndrew Thompson if (err == 0) 174402ac6454SAndrew Thompson goto repeat_set_config; 174502ac6454SAndrew Thompson } 174602ac6454SAndrew Thompson DPRINTFN(0, "Failure selecting " 174702ac6454SAndrew Thompson "configuration index %u: %s, port %u, " 174802ac6454SAndrew Thompson "addr %u (ignored)\n", 174902ac6454SAndrew Thompson config_index, usb2_errstr(err), udev->port_no, 175002ac6454SAndrew Thompson udev->address); 175102ac6454SAndrew Thompson } 175202ac6454SAndrew Thompson /* 175302ac6454SAndrew Thompson * Some USB devices do not have any 175402ac6454SAndrew Thompson * configurations. Ignore any set config 175502ac6454SAndrew Thompson * failures! 175602ac6454SAndrew Thompson */ 175702ac6454SAndrew Thompson err = 0; 175802ac6454SAndrew Thompson } else if (config_quirk) { 175902ac6454SAndrew Thompson /* user quirk selects configuration index */ 176002ac6454SAndrew Thompson } else if ((config_index + 1) < udev->ddesc.bNumConfigurations) { 176102ac6454SAndrew Thompson 176202ac6454SAndrew Thompson if ((udev->cdesc->bNumInterface < 2) && 1763bdd41206SAndrew Thompson (usb2_get_no_descriptors(udev->cdesc, 1764bdd41206SAndrew Thompson UDESC_ENDPOINT) == 0)) { 176502ac6454SAndrew Thompson DPRINTFN(0, "Found no endpoints " 176602ac6454SAndrew Thompson "(trying next config)!\n"); 176702ac6454SAndrew Thompson config_index++; 176802ac6454SAndrew Thompson goto repeat_set_config; 176902ac6454SAndrew Thompson } 177002ac6454SAndrew Thompson if (config_index == 0) { 177102ac6454SAndrew Thompson /* 177202ac6454SAndrew Thompson * Try to figure out if we have an 177302ac6454SAndrew Thompson * auto-install disk there: 177402ac6454SAndrew Thompson */ 177502ac6454SAndrew Thompson if (usb2_test_autoinstall(udev, 0, 0) == 0) { 177602ac6454SAndrew Thompson DPRINTFN(0, "Found possible auto-install " 177702ac6454SAndrew Thompson "disk (trying next config)\n"); 177802ac6454SAndrew Thompson config_index++; 177902ac6454SAndrew Thompson goto repeat_set_config; 178002ac6454SAndrew Thompson } 178102ac6454SAndrew Thompson } 178202ac6454SAndrew Thompson } else if (usb2_test_huawei_autoinst_p(udev, &uaa) == 0) { 178302ac6454SAndrew Thompson DPRINTFN(0, "Found Huawei auto-install disk!\n"); 178402ac6454SAndrew Thompson err = USB_ERR_STALLED; /* fake an error */ 178502ac6454SAndrew Thompson } 178602ac6454SAndrew Thompson } else { 178702ac6454SAndrew Thompson err = 0; /* set success */ 178802ac6454SAndrew Thompson } 178902ac6454SAndrew Thompson 179002ac6454SAndrew Thompson DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n", 179102ac6454SAndrew Thompson udev->address, udev, udev->parent_hub); 179202ac6454SAndrew Thompson 179302ac6454SAndrew Thompson /* register our device - we are ready */ 179402ac6454SAndrew Thompson usb2_bus_port_set_device(bus, parent_hub ? 179502ac6454SAndrew Thompson parent_hub->hub->ports + port_index : NULL, udev, device_index); 179602ac6454SAndrew Thompson 17970f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 17988755859aSAndrew Thompson /* Symlink the ugen device name */ 1799ee3e3ff5SAndrew Thompson udev->ugen_symlink = usb2_alloc_symlink(udev->ugen_name); 18008755859aSAndrew Thompson 18018755859aSAndrew Thompson /* Announce device */ 1802ee3e3ff5SAndrew Thompson printf("%s: <%s> at %s\n", udev->ugen_name, udev->manufacturer, 180302ac6454SAndrew Thompson device_get_nameunit(udev->bus->bdev)); 18047efaaa9aSAndrew Thompson 180502ac6454SAndrew Thompson usb2_notify_addq("+", udev); 18068755859aSAndrew Thompson #endif 180702ac6454SAndrew Thompson done: 180802ac6454SAndrew Thompson if (err) { 180902ac6454SAndrew Thompson /* free device */ 1810bdd41206SAndrew Thompson usb2_free_device(udev, 1811bdd41206SAndrew Thompson USB_UNCFG_FLAG_FREE_SUBDEV | 1812bdd41206SAndrew Thompson USB_UNCFG_FLAG_FREE_EP0); 181302ac6454SAndrew Thompson udev = NULL; 181402ac6454SAndrew Thompson } 181502ac6454SAndrew Thompson return (udev); 181602ac6454SAndrew Thompson } 181702ac6454SAndrew Thompson 18180f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 1819ee3e3ff5SAndrew Thompson static struct cdev * 1820f5f145baSAndrew Thompson usb2_make_dev(struct usb2_device *udev, int ep, int mode) 1821ee3e3ff5SAndrew Thompson { 1822ee3e3ff5SAndrew Thompson struct usb2_fs_privdata* pd; 1823ee3e3ff5SAndrew Thompson char devname[20]; 1824ee3e3ff5SAndrew Thompson 1825ee3e3ff5SAndrew Thompson /* Store information to locate ourselves again later */ 1826ee3e3ff5SAndrew Thompson pd = malloc(sizeof(struct usb2_fs_privdata), M_USBDEV, 1827ee3e3ff5SAndrew Thompson M_WAITOK | M_ZERO); 1828ee3e3ff5SAndrew Thompson pd->bus_index = device_get_unit(udev->bus->bdev); 1829ee3e3ff5SAndrew Thompson pd->dev_index = udev->device_index; 1830ee3e3ff5SAndrew Thompson pd->ep_addr = ep; 1831ee3e3ff5SAndrew Thompson pd->mode = mode; 1832ee3e3ff5SAndrew Thompson 1833ee3e3ff5SAndrew Thompson /* Now, create the device itself */ 1834f5f145baSAndrew Thompson snprintf(devname, sizeof(devname), "%u.%u.%u", 1835f35aaff0SAndrew Thompson pd->bus_index, pd->dev_index, pd->ep_addr); 1836ee3e3ff5SAndrew Thompson pd->cdev = make_dev(&usb2_devsw, 0, UID_ROOT, 1837ee3e3ff5SAndrew Thompson GID_OPERATOR, 0600, USB_DEVICE_DIR "/%s", devname); 1838ee3e3ff5SAndrew Thompson pd->cdev->si_drv1 = pd; 1839ee3e3ff5SAndrew Thompson 1840ee3e3ff5SAndrew Thompson return (pd->cdev); 1841ee3e3ff5SAndrew Thompson } 1842ee3e3ff5SAndrew Thompson 1843ee3e3ff5SAndrew Thompson static void 1844ee3e3ff5SAndrew Thompson usb2_cdev_create(struct usb2_device *udev) 1845ee3e3ff5SAndrew Thompson { 1846f35aaff0SAndrew Thompson struct usb2_config_descriptor *cd; 1847f5f145baSAndrew Thompson struct usb2_endpoint_descriptor *ed; 1848f5f145baSAndrew Thompson struct usb2_descriptor *desc; 1849ee3e3ff5SAndrew Thompson struct usb2_fs_privdata* pd; 1850ee3e3ff5SAndrew Thompson struct cdev *dev; 1851f5f145baSAndrew Thompson int inmode, outmode, inmask, outmask, mode; 1852f5f145baSAndrew Thompson uint8_t ep; 1853ee3e3ff5SAndrew Thompson 1854ee3e3ff5SAndrew Thompson KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries")); 1855ee3e3ff5SAndrew Thompson 1856ee3e3ff5SAndrew Thompson DPRINTFN(2, "Creating device nodes\n"); 1857ee3e3ff5SAndrew Thompson 1858ee3e3ff5SAndrew Thompson if (usb2_get_mode(udev) == USB_MODE_DEVICE) { 1859ee3e3ff5SAndrew Thompson inmode = FWRITE; 1860ee3e3ff5SAndrew Thompson outmode = FREAD; 1861ee3e3ff5SAndrew Thompson } else { /* USB_MODE_HOST */ 1862ee3e3ff5SAndrew Thompson inmode = FREAD; 1863ee3e3ff5SAndrew Thompson outmode = FWRITE; 1864ee3e3ff5SAndrew Thompson } 1865ee3e3ff5SAndrew Thompson 1866f5f145baSAndrew Thompson inmask = 0; 1867f5f145baSAndrew Thompson outmask = 0; 1868f5f145baSAndrew Thompson desc = NULL; 1869f5f145baSAndrew Thompson 1870f5f145baSAndrew Thompson /* 1871f5f145baSAndrew Thompson * Collect all used endpoint numbers instead of just 1872f5f145baSAndrew Thompson * generating 16 static endpoints. 1873f5f145baSAndrew Thompson */ 1874f35aaff0SAndrew Thompson cd = usb2_get_config_descriptor(udev); 1875f5f145baSAndrew Thompson while ((desc = usb2_desc_foreach(cd, desc))) { 1876f5f145baSAndrew Thompson /* filter out all endpoint descriptors */ 1877f5f145baSAndrew Thompson if ((desc->bDescriptorType == UDESC_ENDPOINT) && 1878f5f145baSAndrew Thompson (desc->bLength >= sizeof(*ed))) { 1879f5f145baSAndrew Thompson ed = (struct usb2_endpoint_descriptor *)desc; 1880f5f145baSAndrew Thompson 1881f5f145baSAndrew Thompson /* update masks */ 1882f5f145baSAndrew Thompson ep = ed->bEndpointAddress; 1883f5f145baSAndrew Thompson if (UE_GET_DIR(ep) == UE_DIR_OUT) 1884f5f145baSAndrew Thompson outmask |= 1 << UE_GET_ADDR(ep); 1885f5f145baSAndrew Thompson else 1886f5f145baSAndrew Thompson inmask |= 1 << UE_GET_ADDR(ep); 1887f5f145baSAndrew Thompson } 1888f5f145baSAndrew Thompson } 1889ee3e3ff5SAndrew Thompson 1890ee3e3ff5SAndrew Thompson /* Create all available endpoints except EP0 */ 1891ee3e3ff5SAndrew Thompson for (ep = 1; ep < 16; ep++) { 1892f5f145baSAndrew Thompson mode = inmask & (1 << ep) ? inmode : 0; 1893f5f145baSAndrew Thompson mode |= outmask & (1 << ep) ? outmode : 0; 1894ee3e3ff5SAndrew Thompson if (mode == 0) 1895ee3e3ff5SAndrew Thompson continue; /* no IN or OUT endpoint */ 1896ee3e3ff5SAndrew Thompson 1897f5f145baSAndrew Thompson dev = usb2_make_dev(udev, ep, mode); 1898ee3e3ff5SAndrew Thompson pd = dev->si_drv1; 1899ee3e3ff5SAndrew Thompson LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next); 1900ee3e3ff5SAndrew Thompson } 1901ee3e3ff5SAndrew Thompson } 1902ee3e3ff5SAndrew Thompson 1903ee3e3ff5SAndrew Thompson static void 1904ee3e3ff5SAndrew Thompson usb2_cdev_free(struct usb2_device *udev) 1905ee3e3ff5SAndrew Thompson { 1906ee3e3ff5SAndrew Thompson struct usb2_fs_privdata* pd; 1907ee3e3ff5SAndrew Thompson 1908ee3e3ff5SAndrew Thompson DPRINTFN(2, "Freeing device nodes\n"); 1909ee3e3ff5SAndrew Thompson 1910ee3e3ff5SAndrew Thompson while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) { 1911ee3e3ff5SAndrew Thompson KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt")); 1912ee3e3ff5SAndrew Thompson 1913ee3e3ff5SAndrew Thompson destroy_dev_sched_cb(pd->cdev, usb2_cdev_cleanup, pd); 1914ee3e3ff5SAndrew Thompson pd->cdev = NULL; 1915ee3e3ff5SAndrew Thompson LIST_REMOVE(pd, pd_next); 1916ee3e3ff5SAndrew Thompson } 1917ee3e3ff5SAndrew Thompson } 1918ee3e3ff5SAndrew Thompson 1919ee3e3ff5SAndrew Thompson static void 1920ee3e3ff5SAndrew Thompson usb2_cdev_cleanup(void* arg) 1921ee3e3ff5SAndrew Thompson { 1922ee3e3ff5SAndrew Thompson free(arg, M_USBDEV); 1923ee3e3ff5SAndrew Thompson } 19240f6e8f93SAndrew Thompson #endif 1925ee3e3ff5SAndrew Thompson 192602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 192702ac6454SAndrew Thompson * usb2_free_device 192802ac6454SAndrew Thompson * 192902ac6454SAndrew Thompson * This function is NULL safe and will free an USB device. 1930bdd41206SAndrew Thompson * 1931bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 193202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 193302ac6454SAndrew Thompson void 1934bdd41206SAndrew Thompson usb2_free_device(struct usb2_device *udev, uint8_t flag) 193502ac6454SAndrew Thompson { 1936bdd41206SAndrew Thompson struct usb2_bus *bus; 1937bdd41206SAndrew Thompson 1938bdd41206SAndrew Thompson if (udev == NULL) 1939bdd41206SAndrew Thompson return; /* already freed */ 194002ac6454SAndrew Thompson 194102ac6454SAndrew Thompson DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no); 194202ac6454SAndrew Thompson 1943bdd41206SAndrew Thompson bus = udev->bus;; 1944bdd41206SAndrew Thompson 19458755859aSAndrew Thompson #if USB_HAVE_UGEN 194602ac6454SAndrew Thompson usb2_notify_addq("-", udev); 194702ac6454SAndrew Thompson 1948ee3e3ff5SAndrew Thompson printf("%s: <%s> at %s (disconnected)\n", udev->ugen_name, 1949ee3e3ff5SAndrew Thompson udev->manufacturer, device_get_nameunit(bus->bdev)); 195002ac6454SAndrew Thompson 1951ee3e3ff5SAndrew Thompson /* Destroy UGEN symlink, if any */ 195202ac6454SAndrew Thompson if (udev->ugen_symlink) { 195302ac6454SAndrew Thompson usb2_free_symlink(udev->ugen_symlink); 195402ac6454SAndrew Thompson udev->ugen_symlink = NULL; 195502ac6454SAndrew Thompson } 19568755859aSAndrew Thompson #endif 195702ac6454SAndrew Thompson /* 195802ac6454SAndrew Thompson * Unregister our device first which will prevent any further 195902ac6454SAndrew Thompson * references: 196002ac6454SAndrew Thompson */ 196102ac6454SAndrew Thompson usb2_bus_port_set_device(bus, udev->parent_hub ? 196202ac6454SAndrew Thompson udev->parent_hub->hub->ports + udev->port_index : NULL, 196302ac6454SAndrew Thompson NULL, USB_ROOT_HUB_ADDR); 196402ac6454SAndrew Thompson 19650f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 196602ac6454SAndrew Thompson /* wait for all pending references to go away: */ 196702ac6454SAndrew Thompson mtx_lock(&usb2_ref_lock); 196802ac6454SAndrew Thompson udev->refcount--; 196902ac6454SAndrew Thompson while (udev->refcount != 0) { 197002ac6454SAndrew Thompson usb2_cv_wait(udev->default_cv + 1, &usb2_ref_lock); 197102ac6454SAndrew Thompson } 197202ac6454SAndrew Thompson mtx_unlock(&usb2_ref_lock); 1973bdd41206SAndrew Thompson 1974bdd41206SAndrew Thompson destroy_dev_sched_cb(udev->default_dev, usb2_cdev_cleanup, 1975bdd41206SAndrew Thompson udev->default_dev->si_drv1); 19760f6e8f93SAndrew Thompson #endif 197702ac6454SAndrew Thompson 197802ac6454SAndrew Thompson if (udev->flags.usb2_mode == USB_MODE_DEVICE) { 197902ac6454SAndrew Thompson /* stop receiving any control transfers (Device Side Mode) */ 198002ac6454SAndrew Thompson usb2_transfer_unsetup(udev->default_xfer, USB_DEFAULT_XFER_MAX); 198102ac6454SAndrew Thompson } 198202ac6454SAndrew Thompson 1983bdd41206SAndrew Thompson /* the following will get the device unconfigured in software */ 1984bdd41206SAndrew Thompson usb2_unconfigure(udev, flag); 198502ac6454SAndrew Thompson 198602ac6454SAndrew Thompson /* unsetup any leftover default USB transfers */ 198702ac6454SAndrew Thompson usb2_transfer_unsetup(udev->default_xfer, USB_DEFAULT_XFER_MAX); 198802ac6454SAndrew Thompson 198902ac6454SAndrew Thompson /* template unsetup, if any */ 199002ac6454SAndrew Thompson (usb2_temp_unsetup_p) (udev); 199102ac6454SAndrew Thompson 199202ac6454SAndrew Thompson /* 199302ac6454SAndrew Thompson * Make sure that our clear-stall messages are not queued 199402ac6454SAndrew Thompson * anywhere: 199502ac6454SAndrew Thompson */ 199602ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 199702ac6454SAndrew Thompson usb2_proc_mwait(&udev->bus->non_giant_callback_proc, 199802ac6454SAndrew Thompson &udev->cs_msg[0], &udev->cs_msg[1]); 199902ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 200002ac6454SAndrew Thompson 200102ac6454SAndrew Thompson sx_destroy(udev->default_sx); 200202ac6454SAndrew Thompson sx_destroy(udev->default_sx + 1); 200302ac6454SAndrew Thompson 200402ac6454SAndrew Thompson usb2_cv_destroy(udev->default_cv); 200502ac6454SAndrew Thompson usb2_cv_destroy(udev->default_cv + 1); 200602ac6454SAndrew Thompson 200702ac6454SAndrew Thompson mtx_destroy(udev->default_mtx); 20088755859aSAndrew Thompson #if USB_HAVE_UGEN 2009ee3e3ff5SAndrew Thompson KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries")); 20108755859aSAndrew Thompson #endif 201102ac6454SAndrew Thompson 201202ac6454SAndrew Thompson /* free device */ 201302ac6454SAndrew Thompson free(udev, M_USB); 201402ac6454SAndrew Thompson } 201502ac6454SAndrew Thompson 201602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 201702ac6454SAndrew Thompson * usb2_get_iface 201802ac6454SAndrew Thompson * 201902ac6454SAndrew Thompson * This function is the safe way to get the USB interface structure 202002ac6454SAndrew Thompson * pointer by interface index. 202102ac6454SAndrew Thompson * 202202ac6454SAndrew Thompson * Return values: 202302ac6454SAndrew Thompson * NULL: Interface not present. 202402ac6454SAndrew Thompson * Else: Pointer to USB interface structure. 202502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 202602ac6454SAndrew Thompson struct usb2_interface * 202702ac6454SAndrew Thompson usb2_get_iface(struct usb2_device *udev, uint8_t iface_index) 202802ac6454SAndrew Thompson { 202902ac6454SAndrew Thompson struct usb2_interface *iface = udev->ifaces + iface_index; 203002ac6454SAndrew Thompson 2031bdd41206SAndrew Thompson if (iface_index >= udev->ifaces_max) 203202ac6454SAndrew Thompson return (NULL); 203302ac6454SAndrew Thompson return (iface); 203402ac6454SAndrew Thompson } 203502ac6454SAndrew Thompson 203602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 203702ac6454SAndrew Thompson * usb2_find_descriptor 203802ac6454SAndrew Thompson * 203902ac6454SAndrew Thompson * This function will lookup the first descriptor that matches the 204002ac6454SAndrew Thompson * criteria given by the arguments "type" and "subtype". Descriptors 204102ac6454SAndrew Thompson * will only be searched within the interface having the index 204202ac6454SAndrew Thompson * "iface_index". If the "id" argument points to an USB descriptor, 204302ac6454SAndrew Thompson * it will be skipped before the search is started. This allows 204402ac6454SAndrew Thompson * searching for multiple descriptors using the same criteria. Else 204502ac6454SAndrew Thompson * the search is started after the interface descriptor. 204602ac6454SAndrew Thompson * 204702ac6454SAndrew Thompson * Return values: 204802ac6454SAndrew Thompson * NULL: End of descriptors 204902ac6454SAndrew Thompson * Else: A descriptor matching the criteria 205002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 205102ac6454SAndrew Thompson void * 205202ac6454SAndrew Thompson usb2_find_descriptor(struct usb2_device *udev, void *id, uint8_t iface_index, 205302ac6454SAndrew Thompson uint8_t type, uint8_t type_mask, 205402ac6454SAndrew Thompson uint8_t subtype, uint8_t subtype_mask) 205502ac6454SAndrew Thompson { 205602ac6454SAndrew Thompson struct usb2_descriptor *desc; 205702ac6454SAndrew Thompson struct usb2_config_descriptor *cd; 205802ac6454SAndrew Thompson struct usb2_interface *iface; 205902ac6454SAndrew Thompson 206002ac6454SAndrew Thompson cd = usb2_get_config_descriptor(udev); 206102ac6454SAndrew Thompson if (cd == NULL) { 206202ac6454SAndrew Thompson return (NULL); 206302ac6454SAndrew Thompson } 206402ac6454SAndrew Thompson if (id == NULL) { 206502ac6454SAndrew Thompson iface = usb2_get_iface(udev, iface_index); 206602ac6454SAndrew Thompson if (iface == NULL) { 206702ac6454SAndrew Thompson return (NULL); 206802ac6454SAndrew Thompson } 206902ac6454SAndrew Thompson id = usb2_get_interface_descriptor(iface); 207002ac6454SAndrew Thompson if (id == NULL) { 207102ac6454SAndrew Thompson return (NULL); 207202ac6454SAndrew Thompson } 207302ac6454SAndrew Thompson } 207402ac6454SAndrew Thompson desc = (void *)id; 207502ac6454SAndrew Thompson 207602ac6454SAndrew Thompson while ((desc = usb2_desc_foreach(cd, desc))) { 207702ac6454SAndrew Thompson 207802ac6454SAndrew Thompson if (desc->bDescriptorType == UDESC_INTERFACE) { 207902ac6454SAndrew Thompson break; 208002ac6454SAndrew Thompson } 208102ac6454SAndrew Thompson if (((desc->bDescriptorType & type_mask) == type) && 208202ac6454SAndrew Thompson ((desc->bDescriptorSubtype & subtype_mask) == subtype)) { 208302ac6454SAndrew Thompson return (desc); 208402ac6454SAndrew Thompson } 208502ac6454SAndrew Thompson } 208602ac6454SAndrew Thompson return (NULL); 208702ac6454SAndrew Thompson } 208802ac6454SAndrew Thompson 208902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 209002ac6454SAndrew Thompson * usb2_devinfo 209102ac6454SAndrew Thompson * 209202ac6454SAndrew Thompson * This function will dump information from the device descriptor 209302ac6454SAndrew Thompson * belonging to the USB device pointed to by "udev", to the string 209402ac6454SAndrew Thompson * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes 209502ac6454SAndrew Thompson * including the terminating zero. 209602ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 209702ac6454SAndrew Thompson void 209802ac6454SAndrew Thompson usb2_devinfo(struct usb2_device *udev, char *dst_ptr, uint16_t dst_len) 209902ac6454SAndrew Thompson { 210002ac6454SAndrew Thompson struct usb2_device_descriptor *udd = &udev->ddesc; 210102ac6454SAndrew Thompson uint16_t bcdDevice; 210202ac6454SAndrew Thompson uint16_t bcdUSB; 210302ac6454SAndrew Thompson 210402ac6454SAndrew Thompson bcdUSB = UGETW(udd->bcdUSB); 210502ac6454SAndrew Thompson bcdDevice = UGETW(udd->bcdDevice); 210602ac6454SAndrew Thompson 210702ac6454SAndrew Thompson if (udd->bDeviceClass != 0xFF) { 210802ac6454SAndrew Thompson snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/" 21098755859aSAndrew Thompson "%x.%02x, addr %d", 21108755859aSAndrew Thompson #if USB_HAVE_STRINGS 21118755859aSAndrew Thompson udev->manufacturer, udev->product, 21128755859aSAndrew Thompson #else 21138755859aSAndrew Thompson "-", "-", 21148755859aSAndrew Thompson #endif 211502ac6454SAndrew Thompson udd->bDeviceClass, udd->bDeviceSubClass, 211602ac6454SAndrew Thompson (bcdUSB >> 8), bcdUSB & 0xFF, 211702ac6454SAndrew Thompson (bcdDevice >> 8), bcdDevice & 0xFF, 211802ac6454SAndrew Thompson udev->address); 211902ac6454SAndrew Thompson } else { 212002ac6454SAndrew Thompson snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/" 21218755859aSAndrew Thompson "%x.%02x, addr %d", 21228755859aSAndrew Thompson #if USB_HAVE_STRINGS 21238755859aSAndrew Thompson udev->manufacturer, udev->product, 21248755859aSAndrew Thompson #else 21258755859aSAndrew Thompson "-", "-", 21268755859aSAndrew Thompson #endif 212702ac6454SAndrew Thompson (bcdUSB >> 8), bcdUSB & 0xFF, 212802ac6454SAndrew Thompson (bcdDevice >> 8), bcdDevice & 0xFF, 212902ac6454SAndrew Thompson udev->address); 213002ac6454SAndrew Thompson } 213102ac6454SAndrew Thompson } 213202ac6454SAndrew Thompson 2133bdc081c6SAndrew Thompson #if USB_HAVE_STRINGS 213402ac6454SAndrew Thompson #if USB_VERBOSE 213502ac6454SAndrew Thompson /* 213602ac6454SAndrew Thompson * Descriptions of of known vendors and devices ("products"). 213702ac6454SAndrew Thompson */ 213802ac6454SAndrew Thompson struct usb_knowndev { 213902ac6454SAndrew Thompson uint16_t vendor; 214002ac6454SAndrew Thompson uint16_t product; 214102ac6454SAndrew Thompson uint32_t flags; 214202ac6454SAndrew Thompson const char *vendorname; 214302ac6454SAndrew Thompson const char *productname; 214402ac6454SAndrew Thompson }; 214502ac6454SAndrew Thompson 214602ac6454SAndrew Thompson #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */ 214702ac6454SAndrew Thompson 214802ac6454SAndrew Thompson #include "usbdevs.h" 214902ac6454SAndrew Thompson #include "usbdevs_data.h" 215002ac6454SAndrew Thompson #endif /* USB_VERBOSE */ 215102ac6454SAndrew Thompson 215202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 215302ac6454SAndrew Thompson * usb2_check_strings 215402ac6454SAndrew Thompson * 215502ac6454SAndrew Thompson * This function checks the manufacturer and product strings and will 215602ac6454SAndrew Thompson * fill in defaults for missing strings. 215702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 215802ac6454SAndrew Thompson static void 215902ac6454SAndrew Thompson usb2_check_strings(struct usb2_device *udev) 216002ac6454SAndrew Thompson { 216102ac6454SAndrew Thompson struct usb2_device_descriptor *udd = &udev->ddesc; 216202ac6454SAndrew Thompson const char *vendor; 216302ac6454SAndrew Thompson const char *product; 216402ac6454SAndrew Thompson 216502ac6454SAndrew Thompson #if USB_VERBOSE 216602ac6454SAndrew Thompson const struct usb_knowndev *kdp; 216702ac6454SAndrew Thompson 216802ac6454SAndrew Thompson #endif 216902ac6454SAndrew Thompson uint16_t vendor_id; 217002ac6454SAndrew Thompson uint16_t product_id; 217102ac6454SAndrew Thompson 217202ac6454SAndrew Thompson usb2_trim_spaces(udev->manufacturer); 217302ac6454SAndrew Thompson usb2_trim_spaces(udev->product); 217402ac6454SAndrew Thompson 217502ac6454SAndrew Thompson if (udev->manufacturer[0]) { 217602ac6454SAndrew Thompson vendor = udev->manufacturer; 217702ac6454SAndrew Thompson } else { 217802ac6454SAndrew Thompson vendor = NULL; 217902ac6454SAndrew Thompson } 218002ac6454SAndrew Thompson 218102ac6454SAndrew Thompson if (udev->product[0]) { 218202ac6454SAndrew Thompson product = udev->product; 218302ac6454SAndrew Thompson } else { 218402ac6454SAndrew Thompson product = NULL; 218502ac6454SAndrew Thompson } 218602ac6454SAndrew Thompson 218702ac6454SAndrew Thompson vendor_id = UGETW(udd->idVendor); 218802ac6454SAndrew Thompson product_id = UGETW(udd->idProduct); 218902ac6454SAndrew Thompson 219002ac6454SAndrew Thompson #if USB_VERBOSE 219102ac6454SAndrew Thompson if (vendor == NULL || product == NULL) { 219202ac6454SAndrew Thompson 219302ac6454SAndrew Thompson for (kdp = usb_knowndevs; 219402ac6454SAndrew Thompson kdp->vendorname != NULL; 219502ac6454SAndrew Thompson kdp++) { 219602ac6454SAndrew Thompson if (kdp->vendor == vendor_id && 219702ac6454SAndrew Thompson (kdp->product == product_id || 219802ac6454SAndrew Thompson (kdp->flags & USB_KNOWNDEV_NOPROD) != 0)) 219902ac6454SAndrew Thompson break; 220002ac6454SAndrew Thompson } 220102ac6454SAndrew Thompson if (kdp->vendorname != NULL) { 220202ac6454SAndrew Thompson if (vendor == NULL) 220302ac6454SAndrew Thompson vendor = kdp->vendorname; 220402ac6454SAndrew Thompson if (product == NULL) 220502ac6454SAndrew Thompson product = (kdp->flags & USB_KNOWNDEV_NOPROD) == 0 ? 220602ac6454SAndrew Thompson kdp->productname : NULL; 220702ac6454SAndrew Thompson } 220802ac6454SAndrew Thompson } 220902ac6454SAndrew Thompson #endif 221002ac6454SAndrew Thompson if (vendor && *vendor) { 221102ac6454SAndrew Thompson if (udev->manufacturer != vendor) { 221202ac6454SAndrew Thompson strlcpy(udev->manufacturer, vendor, 221302ac6454SAndrew Thompson sizeof(udev->manufacturer)); 221402ac6454SAndrew Thompson } 221502ac6454SAndrew Thompson } else { 221602ac6454SAndrew Thompson snprintf(udev->manufacturer, 221702ac6454SAndrew Thompson sizeof(udev->manufacturer), "vendor 0x%04x", vendor_id); 221802ac6454SAndrew Thompson } 221902ac6454SAndrew Thompson 222002ac6454SAndrew Thompson if (product && *product) { 222102ac6454SAndrew Thompson if (udev->product != product) { 222202ac6454SAndrew Thompson strlcpy(udev->product, product, 222302ac6454SAndrew Thompson sizeof(udev->product)); 222402ac6454SAndrew Thompson } 222502ac6454SAndrew Thompson } else { 222602ac6454SAndrew Thompson snprintf(udev->product, 222702ac6454SAndrew Thompson sizeof(udev->product), "product 0x%04x", product_id); 222802ac6454SAndrew Thompson } 222902ac6454SAndrew Thompson } 2230bdc081c6SAndrew Thompson #endif 223102ac6454SAndrew Thompson 223202ac6454SAndrew Thompson /* 223302ac6454SAndrew Thompson * Returns: 223402ac6454SAndrew Thompson * See: USB_MODE_XXX 223502ac6454SAndrew Thompson */ 223602ac6454SAndrew Thompson uint8_t 223702ac6454SAndrew Thompson usb2_get_mode(struct usb2_device *udev) 223802ac6454SAndrew Thompson { 223902ac6454SAndrew Thompson return (udev->flags.usb2_mode); 224002ac6454SAndrew Thompson } 224102ac6454SAndrew Thompson 224202ac6454SAndrew Thompson /* 224302ac6454SAndrew Thompson * Returns: 224402ac6454SAndrew Thompson * See: USB_SPEED_XXX 224502ac6454SAndrew Thompson */ 224602ac6454SAndrew Thompson uint8_t 224702ac6454SAndrew Thompson usb2_get_speed(struct usb2_device *udev) 224802ac6454SAndrew Thompson { 224902ac6454SAndrew Thompson return (udev->speed); 225002ac6454SAndrew Thompson } 225102ac6454SAndrew Thompson 225202ac6454SAndrew Thompson uint32_t 225302ac6454SAndrew Thompson usb2_get_isoc_fps(struct usb2_device *udev) 225402ac6454SAndrew Thompson { 225502ac6454SAndrew Thompson ; /* indent fix */ 225602ac6454SAndrew Thompson switch (udev->speed) { 225702ac6454SAndrew Thompson case USB_SPEED_LOW: 225802ac6454SAndrew Thompson case USB_SPEED_FULL: 225902ac6454SAndrew Thompson return (1000); 226002ac6454SAndrew Thompson default: 226102ac6454SAndrew Thompson return (8000); 226202ac6454SAndrew Thompson } 226302ac6454SAndrew Thompson } 226402ac6454SAndrew Thompson 226502ac6454SAndrew Thompson struct usb2_device_descriptor * 226602ac6454SAndrew Thompson usb2_get_device_descriptor(struct usb2_device *udev) 226702ac6454SAndrew Thompson { 226802ac6454SAndrew Thompson if (udev == NULL) 226902ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 227002ac6454SAndrew Thompson return (&udev->ddesc); 227102ac6454SAndrew Thompson } 227202ac6454SAndrew Thompson 227302ac6454SAndrew Thompson struct usb2_config_descriptor * 227402ac6454SAndrew Thompson usb2_get_config_descriptor(struct usb2_device *udev) 227502ac6454SAndrew Thompson { 227602ac6454SAndrew Thompson if (udev == NULL) 227702ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 227802ac6454SAndrew Thompson return (udev->cdesc); 227902ac6454SAndrew Thompson } 228002ac6454SAndrew Thompson 228102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 228202ac6454SAndrew Thompson * usb2_test_quirk - test a device for a given quirk 228302ac6454SAndrew Thompson * 228402ac6454SAndrew Thompson * Return values: 228502ac6454SAndrew Thompson * 0: The USB device does not have the given quirk. 228602ac6454SAndrew Thompson * Else: The USB device has the given quirk. 228702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 228802ac6454SAndrew Thompson uint8_t 228902ac6454SAndrew Thompson usb2_test_quirk(const struct usb2_attach_arg *uaa, uint16_t quirk) 229002ac6454SAndrew Thompson { 229102ac6454SAndrew Thompson uint8_t found; 229202ac6454SAndrew Thompson 229302ac6454SAndrew Thompson found = (usb2_test_quirk_p) (&uaa->info, quirk); 229402ac6454SAndrew Thompson return (found); 229502ac6454SAndrew Thompson } 229602ac6454SAndrew Thompson 229702ac6454SAndrew Thompson struct usb2_interface_descriptor * 229802ac6454SAndrew Thompson usb2_get_interface_descriptor(struct usb2_interface *iface) 229902ac6454SAndrew Thompson { 230002ac6454SAndrew Thompson if (iface == NULL) 230102ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 230202ac6454SAndrew Thompson return (iface->idesc); 230302ac6454SAndrew Thompson } 230402ac6454SAndrew Thompson 230502ac6454SAndrew Thompson uint8_t 230602ac6454SAndrew Thompson usb2_get_interface_altindex(struct usb2_interface *iface) 230702ac6454SAndrew Thompson { 230802ac6454SAndrew Thompson return (iface->alt_index); 230902ac6454SAndrew Thompson } 231002ac6454SAndrew Thompson 231102ac6454SAndrew Thompson uint8_t 231202ac6454SAndrew Thompson usb2_get_bus_index(struct usb2_device *udev) 231302ac6454SAndrew Thompson { 231402ac6454SAndrew Thompson return ((uint8_t)device_get_unit(udev->bus->bdev)); 231502ac6454SAndrew Thompson } 231602ac6454SAndrew Thompson 231702ac6454SAndrew Thompson uint8_t 231802ac6454SAndrew Thompson usb2_get_device_index(struct usb2_device *udev) 231902ac6454SAndrew Thompson { 232002ac6454SAndrew Thompson return (udev->device_index); 232102ac6454SAndrew Thompson } 232202ac6454SAndrew Thompson 23238755859aSAndrew Thompson #if USB_HAVE_UGEN 232402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 232502ac6454SAndrew Thompson * usb2_notify_addq 232602ac6454SAndrew Thompson * 232702ac6454SAndrew Thompson * This function will generate events for dev. 232802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 232902ac6454SAndrew Thompson static void 233002ac6454SAndrew Thompson usb2_notify_addq(const char *type, struct usb2_device *udev) 233102ac6454SAndrew Thompson { 233202ac6454SAndrew Thompson char *data = NULL; 233302ac6454SAndrew Thompson struct malloc_type *mt; 233402ac6454SAndrew Thompson 233502ac6454SAndrew Thompson mtx_lock(&malloc_mtx); 233602ac6454SAndrew Thompson mt = malloc_desc2type("bus"); /* XXX M_BUS */ 233702ac6454SAndrew Thompson mtx_unlock(&malloc_mtx); 233802ac6454SAndrew Thompson if (mt == NULL) 233902ac6454SAndrew Thompson return; 234002ac6454SAndrew Thompson 234102ac6454SAndrew Thompson data = malloc(512, mt, M_NOWAIT); 234202ac6454SAndrew Thompson if (data == NULL) 234302ac6454SAndrew Thompson return; 234402ac6454SAndrew Thompson 234502ac6454SAndrew Thompson /* String it all together. */ 234602ac6454SAndrew Thompson snprintf(data, 1024, 234702ac6454SAndrew Thompson "%s" 2348ee3e3ff5SAndrew Thompson "%s " 234902ac6454SAndrew Thompson "vendor=0x%04x " 235002ac6454SAndrew Thompson "product=0x%04x " 235102ac6454SAndrew Thompson "devclass=0x%02x " 235202ac6454SAndrew Thompson "devsubclass=0x%02x " 235302ac6454SAndrew Thompson "sernum=\"%s\" " 235402ac6454SAndrew Thompson "at " 235502ac6454SAndrew Thompson "port=%u " 235602ac6454SAndrew Thompson "on " 2357ee3e3ff5SAndrew Thompson "%s\n", 235802ac6454SAndrew Thompson type, 2359ee3e3ff5SAndrew Thompson udev->ugen_name, 236002ac6454SAndrew Thompson UGETW(udev->ddesc.idVendor), 236102ac6454SAndrew Thompson UGETW(udev->ddesc.idProduct), 236202ac6454SAndrew Thompson udev->ddesc.bDeviceClass, 236302ac6454SAndrew Thompson udev->ddesc.bDeviceSubClass, 23648755859aSAndrew Thompson #if USB_HAVE_STRINGS 236502ac6454SAndrew Thompson udev->serial, 23668755859aSAndrew Thompson #else 23678755859aSAndrew Thompson "", 23688755859aSAndrew Thompson #endif 236902ac6454SAndrew Thompson udev->port_no, 23708755859aSAndrew Thompson udev->parent_hub != NULL ? 23718755859aSAndrew Thompson udev->parent_hub->ugen_name : 237202ac6454SAndrew Thompson device_get_nameunit(device_get_parent(udev->bus->bdev))); 237362a5f394SAlexander Kabaev 237402ac6454SAndrew Thompson devctl_queue_data(data); 237502ac6454SAndrew Thompson } 237602ac6454SAndrew Thompson 237702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 237802ac6454SAndrew Thompson * usb2_fifo_free_wrap 237902ac6454SAndrew Thompson * 238002ac6454SAndrew Thompson * This function will free the FIFOs. 238102ac6454SAndrew Thompson * 2382bdd41206SAndrew Thompson * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag 2383bdd41206SAndrew Thompson * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free 2384bdd41206SAndrew Thompson * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and 2385bdd41206SAndrew Thompson * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non 2386bdd41206SAndrew Thompson * control endpoint FIFOs. If "iface_index" is not set to 2387bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" the flag has no effect. 238802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 238902ac6454SAndrew Thompson static void 239002ac6454SAndrew Thompson usb2_fifo_free_wrap(struct usb2_device *udev, 239102ac6454SAndrew Thompson uint8_t iface_index, uint8_t flag) 239202ac6454SAndrew Thompson { 239302ac6454SAndrew Thompson struct usb2_fifo *f; 239402ac6454SAndrew Thompson uint16_t i; 239502ac6454SAndrew Thompson 239602ac6454SAndrew Thompson /* 239702ac6454SAndrew Thompson * Free any USB FIFOs on the given interface: 239802ac6454SAndrew Thompson */ 239902ac6454SAndrew Thompson for (i = 0; i != USB_FIFO_MAX; i++) { 240002ac6454SAndrew Thompson f = udev->fifo[i]; 240102ac6454SAndrew Thompson if (f == NULL) { 240202ac6454SAndrew Thompson continue; 240302ac6454SAndrew Thompson } 240402ac6454SAndrew Thompson /* Check if the interface index matches */ 240502ac6454SAndrew Thompson if (iface_index == f->iface_index) { 240602ac6454SAndrew Thompson if (f->methods != &usb2_ugen_methods) { 240702ac6454SAndrew Thompson /* 240802ac6454SAndrew Thompson * Don't free any non-generic FIFOs in 240902ac6454SAndrew Thompson * this case. 241002ac6454SAndrew Thompson */ 241102ac6454SAndrew Thompson continue; 241202ac6454SAndrew Thompson } 241302ac6454SAndrew Thompson if ((f->dev_ep_index == 0) && 241402ac6454SAndrew Thompson (f->fs_xfer == NULL)) { 241502ac6454SAndrew Thompson /* no need to free this FIFO */ 241602ac6454SAndrew Thompson continue; 241702ac6454SAndrew Thompson } 241802ac6454SAndrew Thompson } else if (iface_index == USB_IFACE_INDEX_ANY) { 241902ac6454SAndrew Thompson if ((f->methods == &usb2_ugen_methods) && 2420bdd41206SAndrew Thompson (f->dev_ep_index == 0) && 2421bdd41206SAndrew Thompson (!(flag & USB_UNCFG_FLAG_FREE_EP0)) && 242202ac6454SAndrew Thompson (f->fs_xfer == NULL)) { 242302ac6454SAndrew Thompson /* no need to free this FIFO */ 242402ac6454SAndrew Thompson continue; 242502ac6454SAndrew Thompson } 242602ac6454SAndrew Thompson } else { 242702ac6454SAndrew Thompson /* no need to free this FIFO */ 242802ac6454SAndrew Thompson continue; 242902ac6454SAndrew Thompson } 243002ac6454SAndrew Thompson /* free this FIFO */ 243102ac6454SAndrew Thompson usb2_fifo_free(f); 243202ac6454SAndrew Thompson } 243302ac6454SAndrew Thompson } 24340f6e8f93SAndrew Thompson #endif 243502ac6454SAndrew Thompson 243602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 243702ac6454SAndrew Thompson * usb2_peer_can_wakeup 243802ac6454SAndrew Thompson * 243902ac6454SAndrew Thompson * Return values: 244002ac6454SAndrew Thompson * 0: Peer cannot do resume signalling. 244102ac6454SAndrew Thompson * Else: Peer can do resume signalling. 244202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 244302ac6454SAndrew Thompson uint8_t 244402ac6454SAndrew Thompson usb2_peer_can_wakeup(struct usb2_device *udev) 244502ac6454SAndrew Thompson { 244602ac6454SAndrew Thompson const struct usb2_config_descriptor *cdp; 244702ac6454SAndrew Thompson 244802ac6454SAndrew Thompson cdp = udev->cdesc; 244902ac6454SAndrew Thompson if ((cdp != NULL) && (udev->flags.usb2_mode == USB_MODE_HOST)) { 245002ac6454SAndrew Thompson return (cdp->bmAttributes & UC_REMOTE_WAKEUP); 245102ac6454SAndrew Thompson } 245202ac6454SAndrew Thompson return (0); /* not supported */ 245302ac6454SAndrew Thompson } 2454