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 27d2b99310SHans Petter Selasky #ifdef USB_GLOBAL_INCLUDE_FILE 28d2b99310SHans Petter Selasky #include USB_GLOBAL_INCLUDE_FILE 29d2b99310SHans Petter Selasky #else 30ed6d949aSAndrew Thompson #include <sys/stdint.h> 31ed6d949aSAndrew Thompson #include <sys/stddef.h> 32ed6d949aSAndrew Thompson #include <sys/param.h> 33ed6d949aSAndrew Thompson #include <sys/queue.h> 34ed6d949aSAndrew Thompson #include <sys/types.h> 35ed6d949aSAndrew Thompson #include <sys/systm.h> 36ed6d949aSAndrew Thompson #include <sys/kernel.h> 37ed6d949aSAndrew Thompson #include <sys/bus.h> 38ed6d949aSAndrew Thompson #include <sys/module.h> 39ed6d949aSAndrew Thompson #include <sys/lock.h> 40ed6d949aSAndrew Thompson #include <sys/mutex.h> 41ed6d949aSAndrew Thompson #include <sys/condvar.h> 42ed6d949aSAndrew Thompson #include <sys/sysctl.h> 43ed6d949aSAndrew Thompson #include <sys/sx.h> 44ed6d949aSAndrew Thompson #include <sys/unistd.h> 45ed6d949aSAndrew Thompson #include <sys/callout.h> 46ed6d949aSAndrew Thompson #include <sys/malloc.h> 47ed6d949aSAndrew Thompson #include <sys/priv.h> 48ed6d949aSAndrew Thompson #include <sys/conf.h> 49ed6d949aSAndrew Thompson #include <sys/fcntl.h> 50ed6d949aSAndrew Thompson 5102ac6454SAndrew Thompson #include <dev/usb/usb.h> 52ed6d949aSAndrew Thompson #include <dev/usb/usbdi.h> 53ed6d949aSAndrew Thompson #include <dev/usb/usbdi_util.h> 5402ac6454SAndrew Thompson #include <dev/usb/usb_ioctl.h> 55963169b4SHans Petter Selasky 56963169b4SHans Petter Selasky #if USB_HAVE_UGEN 57963169b4SHans Petter Selasky #include <sys/sbuf.h> 58963169b4SHans Petter Selasky #endif 59963169b4SHans Petter Selasky 6002ac6454SAndrew Thompson #include "usbdevs.h" 6102ac6454SAndrew Thompson 62a593f6b8SAndrew Thompson #define USB_DEBUG_VAR usb_debug 6302ac6454SAndrew Thompson 6402ac6454SAndrew Thompson #include <dev/usb/usb_core.h> 6502ac6454SAndrew Thompson #include <dev/usb/usb_debug.h> 6602ac6454SAndrew Thompson #include <dev/usb/usb_process.h> 6702ac6454SAndrew Thompson #include <dev/usb/usb_device.h> 6802ac6454SAndrew Thompson #include <dev/usb/usb_busdma.h> 6902ac6454SAndrew Thompson #include <dev/usb/usb_transfer.h> 7002ac6454SAndrew Thompson #include <dev/usb/usb_request.h> 7102ac6454SAndrew Thompson #include <dev/usb/usb_dynamic.h> 7202ac6454SAndrew Thompson #include <dev/usb/usb_hub.h> 7302ac6454SAndrew Thompson #include <dev/usb/usb_util.h> 7402ac6454SAndrew Thompson #include <dev/usb/usb_msctest.h> 75bdc081c6SAndrew Thompson #if USB_HAVE_UGEN 76bdc081c6SAndrew Thompson #include <dev/usb/usb_dev.h> 7702ac6454SAndrew Thompson #include <dev/usb/usb_generic.h> 78bdc081c6SAndrew Thompson #endif 7902ac6454SAndrew Thompson 8002ac6454SAndrew Thompson #include <dev/usb/quirk/usb_quirk.h> 8102ac6454SAndrew Thompson 8202ac6454SAndrew Thompson #include <dev/usb/usb_controller.h> 8302ac6454SAndrew Thompson #include <dev/usb/usb_bus.h> 84d2b99310SHans Petter Selasky #endif /* USB_GLOBAL_INCLUDE_FILE */ 8502ac6454SAndrew Thompson 8602ac6454SAndrew Thompson /* function prototypes */ 8702ac6454SAndrew Thompson 88a593f6b8SAndrew Thompson static void usb_init_endpoint(struct usb_device *, uint8_t, 89963169b4SHans Petter Selasky struct usb_endpoint_descriptor *, 90963169b4SHans Petter Selasky struct usb_endpoint_ss_comp_descriptor *, 91963169b4SHans Petter Selasky struct usb_endpoint *); 92a593f6b8SAndrew Thompson static void usb_unconfigure(struct usb_device *, uint8_t); 93a593f6b8SAndrew Thompson static void usb_detach_device_sub(struct usb_device *, device_t *, 948427ed84SHans Petter Selasky char **, uint8_t); 95a593f6b8SAndrew Thompson static uint8_t usb_probe_and_attach_sub(struct usb_device *, 96760bc48eSAndrew Thompson struct usb_attach_arg *); 97a593f6b8SAndrew Thompson static void usb_init_attach_arg(struct usb_device *, 98760bc48eSAndrew Thompson struct usb_attach_arg *); 99a593f6b8SAndrew Thompson static void usb_suspend_resume_sub(struct usb_device *, device_t, 10002ac6454SAndrew Thompson uint8_t); 101a593f6b8SAndrew Thompson static void usbd_clear_stall_proc(struct usb_proc_msg *_pm); 102963169b4SHans Petter Selasky static usb_error_t usb_config_parse(struct usb_device *, uint8_t, uint8_t); 103a593f6b8SAndrew Thompson static void usbd_set_device_strings(struct usb_device *); 1048bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 105a593f6b8SAndrew Thompson static void usb_notify_addq(const char *type, struct usb_device *); 1068bb77249SHans Petter Selasky #endif 1078bb77249SHans Petter Selasky #if USB_HAVE_UGEN 108a593f6b8SAndrew Thompson static void usb_fifo_free_wrap(struct usb_device *, uint8_t, uint8_t); 109a593f6b8SAndrew Thompson static void usb_cdev_create(struct usb_device *); 110a593f6b8SAndrew Thompson static void usb_cdev_free(struct usb_device *); 1110f6e8f93SAndrew Thompson #endif 11202ac6454SAndrew Thompson 11302ac6454SAndrew Thompson /* This variable is global to allow easy access to it: */ 11402ac6454SAndrew Thompson 115fa49bce5SHans Petter Selasky #ifdef USB_TEMPLATE 116fa49bce5SHans Petter Selasky int usb_template = USB_TEMPLATE; 117fa49bce5SHans Petter Selasky #else 118fa49bce5SHans Petter Selasky int usb_template; 119fa49bce5SHans Petter Selasky #endif 12002ac6454SAndrew Thompson 1217a918edfSAndrew Thompson TUNABLE_INT("hw.usb.usb_template", &usb_template); 12283cadd7dSHans Petter Selasky SYSCTL_INT(_hw_usb, OID_AUTO, template, CTLFLAG_RW | CTLFLAG_TUN, 123a593f6b8SAndrew Thompson &usb_template, 0, "Selected USB device side template"); 12402ac6454SAndrew Thompson 1257a918edfSAndrew Thompson /* English is default language */ 1267a918edfSAndrew Thompson 1277a918edfSAndrew Thompson static int usb_lang_id = 0x0009; 1287a918edfSAndrew Thompson static int usb_lang_mask = 0x00FF; 1297a918edfSAndrew Thompson 1307a918edfSAndrew Thompson TUNABLE_INT("hw.usb.usb_lang_id", &usb_lang_id); 13183cadd7dSHans Petter Selasky SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_id, CTLFLAG_RW | CTLFLAG_TUN, 1327a918edfSAndrew Thompson &usb_lang_id, 0, "Preferred USB language ID"); 1337a918edfSAndrew Thompson 1347a918edfSAndrew Thompson TUNABLE_INT("hw.usb.usb_lang_mask", &usb_lang_mask); 13583cadd7dSHans Petter Selasky SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_mask, CTLFLAG_RW | CTLFLAG_TUN, 1367a918edfSAndrew Thompson &usb_lang_mask, 0, "Preferred USB language mask"); 1377a918edfSAndrew Thompson 1384d4fa6edSAndrew Thompson static const char* statestr[USB_STATE_MAX] = { 1394d4fa6edSAndrew Thompson [USB_STATE_DETACHED] = "DETACHED", 1404d4fa6edSAndrew Thompson [USB_STATE_ATTACHED] = "ATTACHED", 1414d4fa6edSAndrew Thompson [USB_STATE_POWERED] = "POWERED", 1424d4fa6edSAndrew Thompson [USB_STATE_ADDRESSED] = "ADDRESSED", 1434d4fa6edSAndrew Thompson [USB_STATE_CONFIGURED] = "CONFIGURED", 1444d4fa6edSAndrew Thompson }; 1454d4fa6edSAndrew Thompson 1464d4fa6edSAndrew Thompson const char * 147a593f6b8SAndrew Thompson usb_statestr(enum usb_dev_state state) 1484d4fa6edSAndrew Thompson { 149ec8f3127SAndrew Thompson return ((state < USB_STATE_MAX) ? statestr[state] : "UNKNOWN"); 1504d4fa6edSAndrew Thompson } 15102ac6454SAndrew Thompson 152ae538d85SAndrew Thompson const char * 153ae538d85SAndrew Thompson usb_get_manufacturer(struct usb_device *udev) 154ae538d85SAndrew Thompson { 155ae538d85SAndrew Thompson return (udev->manufacturer ? udev->manufacturer : "Unknown"); 156ae538d85SAndrew Thompson } 157ae538d85SAndrew Thompson 158ae538d85SAndrew Thompson const char * 159ae538d85SAndrew Thompson usb_get_product(struct usb_device *udev) 160ae538d85SAndrew Thompson { 161ae538d85SAndrew Thompson return (udev->product ? udev->product : ""); 162ae538d85SAndrew Thompson } 163ae538d85SAndrew Thompson 164ae538d85SAndrew Thompson const char * 165ae538d85SAndrew Thompson usb_get_serial(struct usb_device *udev) 166ae538d85SAndrew Thompson { 167ae538d85SAndrew Thompson return (udev->serial ? udev->serial : ""); 168ae538d85SAndrew Thompson } 169ae538d85SAndrew Thompson 17002ac6454SAndrew Thompson /*------------------------------------------------------------------------* 171a593f6b8SAndrew Thompson * usbd_get_ep_by_addr 17202ac6454SAndrew Thompson * 173ae60fdfbSAndrew Thompson * This function searches for an USB ep by endpoint address and 17402ac6454SAndrew Thompson * direction. 17502ac6454SAndrew Thompson * 17602ac6454SAndrew Thompson * Returns: 17702ac6454SAndrew Thompson * NULL: Failure 17802ac6454SAndrew Thompson * Else: Success 17902ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 180ae60fdfbSAndrew Thompson struct usb_endpoint * 181a593f6b8SAndrew Thompson usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val) 18202ac6454SAndrew Thompson { 183ae60fdfbSAndrew Thompson struct usb_endpoint *ep = udev->endpoints; 184ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max; 18502ac6454SAndrew Thompson enum { 18602ac6454SAndrew Thompson EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR), 18702ac6454SAndrew Thompson }; 18802ac6454SAndrew Thompson 18902ac6454SAndrew Thompson /* 19002ac6454SAndrew Thompson * According to the USB specification not all bits are used 19102ac6454SAndrew Thompson * for the endpoint address. Keep defined bits only: 19202ac6454SAndrew Thompson */ 19302ac6454SAndrew Thompson ea_val &= EA_MASK; 19402ac6454SAndrew Thompson 19502ac6454SAndrew Thompson /* 196ae60fdfbSAndrew Thompson * Iterate accross all the USB endpoints searching for a match 19702ac6454SAndrew Thompson * based on the endpoint address: 19802ac6454SAndrew Thompson */ 199ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 20002ac6454SAndrew Thompson 201ae60fdfbSAndrew Thompson if (ep->edesc == NULL) { 20202ac6454SAndrew Thompson continue; 20302ac6454SAndrew Thompson } 20402ac6454SAndrew Thompson /* do the mask and check the value */ 205ae60fdfbSAndrew Thompson if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) { 20602ac6454SAndrew Thompson goto found; 20702ac6454SAndrew Thompson } 20802ac6454SAndrew Thompson } 20902ac6454SAndrew Thompson 21002ac6454SAndrew Thompson /* 211ae60fdfbSAndrew Thompson * The default endpoint is always present and is checked separately: 21202ac6454SAndrew Thompson */ 21322039494SHans Petter Selasky if ((udev->ctrl_ep.edesc != NULL) && 2145b3bb704SAndrew Thompson ((udev->ctrl_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) { 2155b3bb704SAndrew Thompson ep = &udev->ctrl_ep; 21602ac6454SAndrew Thompson goto found; 21702ac6454SAndrew Thompson } 21802ac6454SAndrew Thompson return (NULL); 21902ac6454SAndrew Thompson 22002ac6454SAndrew Thompson found: 221ae60fdfbSAndrew Thompson return (ep); 22202ac6454SAndrew Thompson } 22302ac6454SAndrew Thompson 22402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 225a593f6b8SAndrew Thompson * usbd_get_endpoint 22602ac6454SAndrew Thompson * 227ae60fdfbSAndrew Thompson * This function searches for an USB endpoint based on the information 228760bc48eSAndrew Thompson * given by the passed "struct usb_config" pointer. 22902ac6454SAndrew Thompson * 23002ac6454SAndrew Thompson * Return values: 23102ac6454SAndrew Thompson * NULL: No match. 232ae60fdfbSAndrew Thompson * Else: Pointer to "struct usb_endpoint". 23302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 234ae60fdfbSAndrew Thompson struct usb_endpoint * 235a593f6b8SAndrew Thompson usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index, 236760bc48eSAndrew Thompson const struct usb_config *setup) 23702ac6454SAndrew Thompson { 238ae60fdfbSAndrew Thompson struct usb_endpoint *ep = udev->endpoints; 239ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max; 24002ac6454SAndrew Thompson uint8_t index = setup->ep_index; 24102ac6454SAndrew Thompson uint8_t ea_mask; 24202ac6454SAndrew Thompson uint8_t ea_val; 24302ac6454SAndrew Thompson uint8_t type_mask; 24402ac6454SAndrew Thompson uint8_t type_val; 24502ac6454SAndrew Thompson 24602ac6454SAndrew Thompson DPRINTFN(10, "udev=%p iface_index=%d address=0x%x " 24702ac6454SAndrew Thompson "type=0x%x dir=0x%x index=%d\n", 24802ac6454SAndrew Thompson udev, iface_index, setup->endpoint, 24902ac6454SAndrew Thompson setup->type, setup->direction, setup->ep_index); 25002ac6454SAndrew Thompson 2514eae601eSAndrew Thompson /* check USB mode */ 2524eae601eSAndrew Thompson 253f29a0724SAndrew Thompson if (setup->usb_mode != USB_MODE_DUAL && 254f29a0724SAndrew Thompson udev->flags.usb_mode != setup->usb_mode) { 255ae60fdfbSAndrew Thompson /* wrong mode - no endpoint */ 2564eae601eSAndrew Thompson return (NULL); 2574eae601eSAndrew Thompson } 2584eae601eSAndrew Thompson 25902ac6454SAndrew Thompson /* setup expected endpoint direction mask and value */ 26002ac6454SAndrew Thompson 26151ec1603SAndrew Thompson if (setup->direction == UE_DIR_RX) { 26251ec1603SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 263f29a0724SAndrew Thompson ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ? 26451ec1603SAndrew Thompson UE_DIR_OUT : UE_DIR_IN; 26551ec1603SAndrew Thompson } else if (setup->direction == UE_DIR_TX) { 26651ec1603SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 267f29a0724SAndrew Thompson ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ? 26851ec1603SAndrew Thompson UE_DIR_IN : UE_DIR_OUT; 26951ec1603SAndrew Thompson } else if (setup->direction == UE_DIR_ANY) { 27002ac6454SAndrew Thompson /* match any endpoint direction */ 27102ac6454SAndrew Thompson ea_mask = 0; 27202ac6454SAndrew Thompson ea_val = 0; 27302ac6454SAndrew Thompson } else { 27402ac6454SAndrew Thompson /* match the given endpoint direction */ 27502ac6454SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 27602ac6454SAndrew Thompson ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT)); 27702ac6454SAndrew Thompson } 27802ac6454SAndrew Thompson 27902ac6454SAndrew Thompson /* setup expected endpoint address */ 28002ac6454SAndrew Thompson 28102ac6454SAndrew Thompson if (setup->endpoint == UE_ADDR_ANY) { 28202ac6454SAndrew Thompson /* match any endpoint address */ 28302ac6454SAndrew Thompson } else { 28402ac6454SAndrew Thompson /* match the given endpoint address */ 28502ac6454SAndrew Thompson ea_mask |= UE_ADDR; 28602ac6454SAndrew Thompson ea_val |= (setup->endpoint & UE_ADDR); 28702ac6454SAndrew Thompson } 28802ac6454SAndrew Thompson 28902ac6454SAndrew Thompson /* setup expected endpoint type */ 29002ac6454SAndrew Thompson 29102ac6454SAndrew Thompson if (setup->type == UE_BULK_INTR) { 29202ac6454SAndrew Thompson /* this will match BULK and INTERRUPT endpoints */ 29302ac6454SAndrew Thompson type_mask = 2; 29402ac6454SAndrew Thompson type_val = 2; 29502ac6454SAndrew Thompson } else if (setup->type == UE_TYPE_ANY) { 29602ac6454SAndrew Thompson /* match any endpoint type */ 29702ac6454SAndrew Thompson type_mask = 0; 29802ac6454SAndrew Thompson type_val = 0; 29902ac6454SAndrew Thompson } else { 30002ac6454SAndrew Thompson /* match the given endpoint type */ 30102ac6454SAndrew Thompson type_mask = UE_XFERTYPE; 30202ac6454SAndrew Thompson type_val = (setup->type & UE_XFERTYPE); 30302ac6454SAndrew Thompson } 30402ac6454SAndrew Thompson 30502ac6454SAndrew Thompson /* 306ae60fdfbSAndrew Thompson * Iterate accross all the USB endpoints searching for a match 30702ac6454SAndrew Thompson * based on the endpoint address. Note that we are searching 308ae60fdfbSAndrew Thompson * the endpoints from the beginning of the "udev->endpoints" array. 30902ac6454SAndrew Thompson */ 310ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 31102ac6454SAndrew Thompson 312ae60fdfbSAndrew Thompson if ((ep->edesc == NULL) || 313ae60fdfbSAndrew Thompson (ep->iface_index != iface_index)) { 31402ac6454SAndrew Thompson continue; 31502ac6454SAndrew Thompson } 31602ac6454SAndrew Thompson /* do the masks and check the values */ 31702ac6454SAndrew Thompson 318ae60fdfbSAndrew Thompson if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) && 319ae60fdfbSAndrew Thompson ((ep->edesc->bmAttributes & type_mask) == type_val)) { 32002ac6454SAndrew Thompson if (!index--) { 32102ac6454SAndrew Thompson goto found; 32202ac6454SAndrew Thompson } 32302ac6454SAndrew Thompson } 32402ac6454SAndrew Thompson } 32502ac6454SAndrew Thompson 32602ac6454SAndrew Thompson /* 327ae60fdfbSAndrew Thompson * Match against default endpoint last, so that "any endpoint", "any 328ae60fdfbSAndrew Thompson * address" and "any direction" returns the first endpoint of the 32902ac6454SAndrew Thompson * interface. "iface_index" and "direction" is ignored: 33002ac6454SAndrew Thompson */ 33122039494SHans Petter Selasky if ((udev->ctrl_ep.edesc != NULL) && 3325b3bb704SAndrew Thompson ((udev->ctrl_ep.edesc->bEndpointAddress & ea_mask) == ea_val) && 3335b3bb704SAndrew Thompson ((udev->ctrl_ep.edesc->bmAttributes & type_mask) == type_val) && 33402ac6454SAndrew Thompson (!index)) { 3355b3bb704SAndrew Thompson ep = &udev->ctrl_ep; 33602ac6454SAndrew Thompson goto found; 33702ac6454SAndrew Thompson } 33802ac6454SAndrew Thompson return (NULL); 33902ac6454SAndrew Thompson 34002ac6454SAndrew Thompson found: 341ae60fdfbSAndrew Thompson return (ep); 34202ac6454SAndrew Thompson } 34302ac6454SAndrew Thompson 34402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 345ed6d949aSAndrew Thompson * usbd_interface_count 34602ac6454SAndrew Thompson * 34702ac6454SAndrew Thompson * This function stores the number of USB interfaces excluding 34802ac6454SAndrew Thompson * alternate settings, which the USB config descriptor reports into 34902ac6454SAndrew Thompson * the unsigned 8-bit integer pointed to by "count". 35002ac6454SAndrew Thompson * 35102ac6454SAndrew Thompson * Returns: 35202ac6454SAndrew Thompson * 0: Success 35302ac6454SAndrew Thompson * Else: Failure 35402ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 355e0a69b51SAndrew Thompson usb_error_t 356ed6d949aSAndrew Thompson usbd_interface_count(struct usb_device *udev, uint8_t *count) 35702ac6454SAndrew Thompson { 35802ac6454SAndrew Thompson if (udev->cdesc == NULL) { 35902ac6454SAndrew Thompson *count = 0; 36002ac6454SAndrew Thompson return (USB_ERR_NOT_CONFIGURED); 36102ac6454SAndrew Thompson } 362bdd41206SAndrew Thompson *count = udev->ifaces_max; 36302ac6454SAndrew Thompson return (USB_ERR_NORMAL_COMPLETION); 36402ac6454SAndrew Thompson } 36502ac6454SAndrew Thompson 36602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 367a593f6b8SAndrew Thompson * usb_init_endpoint 36802ac6454SAndrew Thompson * 369ae60fdfbSAndrew Thompson * This function will initialise the USB endpoint structure pointed to by 370ae60fdfbSAndrew Thompson * the "endpoint" argument. The structure pointed to by "endpoint" must be 371bdd41206SAndrew Thompson * zeroed before calling this function. 37202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 37302ac6454SAndrew Thompson static void 374a593f6b8SAndrew Thompson usb_init_endpoint(struct usb_device *udev, uint8_t iface_index, 375963169b4SHans Petter Selasky struct usb_endpoint_descriptor *edesc, 376963169b4SHans Petter Selasky struct usb_endpoint_ss_comp_descriptor *ecomp, 377963169b4SHans Petter Selasky struct usb_endpoint *ep) 37802ac6454SAndrew Thompson { 379760bc48eSAndrew Thompson struct usb_bus_methods *methods; 380a5cf1aaaSHans Petter Selasky usb_stream_t x; 381ee3e3ff5SAndrew Thompson 382bdd41206SAndrew Thompson methods = udev->bus->methods; 38302ac6454SAndrew Thompson 384ae60fdfbSAndrew Thompson (methods->endpoint_init) (udev, edesc, ep); 38502ac6454SAndrew Thompson 386ae60fdfbSAndrew Thompson /* initialise USB endpoint structure */ 387ae60fdfbSAndrew Thompson ep->edesc = edesc; 388963169b4SHans Petter Selasky ep->ecomp = ecomp; 389ae60fdfbSAndrew Thompson ep->iface_index = iface_index; 390a5cf1aaaSHans Petter Selasky 391a5cf1aaaSHans Petter Selasky /* setup USB stream queues */ 392a5cf1aaaSHans Petter Selasky for (x = 0; x != USB_MAX_EP_STREAMS; x++) { 393a5cf1aaaSHans Petter Selasky TAILQ_INIT(&ep->endpoint_q[x].head); 394a5cf1aaaSHans Petter Selasky ep->endpoint_q[x].command = &usbd_pipe_start; 395a5cf1aaaSHans Petter Selasky } 39602ac6454SAndrew Thompson 39739307315SAndrew Thompson /* the pipe is not supported by the hardware */ 398ae60fdfbSAndrew Thompson if (ep->methods == NULL) 39939307315SAndrew Thompson return; 40039307315SAndrew Thompson 401a5cf1aaaSHans Petter Selasky /* check for SUPER-speed streams mode endpoint */ 402a5cf1aaaSHans Petter Selasky if (udev->speed == USB_SPEED_SUPER && ecomp != NULL && 403a5cf1aaaSHans Petter Selasky (edesc->bmAttributes & UE_XFERTYPE) == UE_BULK && 404a5cf1aaaSHans Petter Selasky (UE_GET_BULK_STREAMS(ecomp->bmAttributes) != 0)) { 405a5cf1aaaSHans Petter Selasky usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_STREAMS); 406a5cf1aaaSHans Petter Selasky } else { 407a5cf1aaaSHans Petter Selasky usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_DEFAULT); 408a5cf1aaaSHans Petter Selasky } 409a5cf1aaaSHans Petter Selasky 41002ac6454SAndrew Thompson /* clear stall, if any */ 411bdd41206SAndrew Thompson if (methods->clear_stall != NULL) { 41202ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 413ae60fdfbSAndrew Thompson (methods->clear_stall) (udev, ep); 41402ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 41502ac6454SAndrew Thompson } 41602ac6454SAndrew Thompson } 41702ac6454SAndrew Thompson 418bdd41206SAndrew Thompson /*-----------------------------------------------------------------------* 419a593f6b8SAndrew Thompson * usb_endpoint_foreach 42016589beaSAndrew Thompson * 42116589beaSAndrew Thompson * This function will iterate all the USB endpoints except the control 42216589beaSAndrew Thompson * endpoint. This function is NULL safe. 42316589beaSAndrew Thompson * 42416589beaSAndrew Thompson * Return values: 425ae60fdfbSAndrew Thompson * NULL: End of USB endpoints 426ae60fdfbSAndrew Thompson * Else: Pointer to next USB endpoint 42716589beaSAndrew Thompson *------------------------------------------------------------------------*/ 428ae60fdfbSAndrew Thompson struct usb_endpoint * 429a593f6b8SAndrew Thompson usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep) 43016589beaSAndrew Thompson { 431a9e26757SAndrew Thompson struct usb_endpoint *ep_end; 43216589beaSAndrew Thompson 43316589beaSAndrew Thompson /* be NULL safe */ 43416589beaSAndrew Thompson if (udev == NULL) 43516589beaSAndrew Thompson return (NULL); 43616589beaSAndrew Thompson 437a9e26757SAndrew Thompson ep_end = udev->endpoints + udev->endpoints_max; 438a9e26757SAndrew Thompson 439ae60fdfbSAndrew Thompson /* get next endpoint */ 440ae60fdfbSAndrew Thompson if (ep == NULL) 441ae60fdfbSAndrew Thompson ep = udev->endpoints; 44216589beaSAndrew Thompson else 443ae60fdfbSAndrew Thompson ep++; 44416589beaSAndrew Thompson 445ae60fdfbSAndrew Thompson /* find next allocated ep */ 446ae60fdfbSAndrew Thompson while (ep != ep_end) { 447ae60fdfbSAndrew Thompson if (ep->edesc != NULL) 448ae60fdfbSAndrew Thompson return (ep); 449ae60fdfbSAndrew Thompson ep++; 45016589beaSAndrew Thompson } 45116589beaSAndrew Thompson return (NULL); 45216589beaSAndrew Thompson } 45316589beaSAndrew Thompson 45416589beaSAndrew Thompson /*------------------------------------------------------------------------* 455a593f6b8SAndrew Thompson * usb_unconfigure 45602ac6454SAndrew Thompson * 457ae60fdfbSAndrew Thompson * This function will free all USB interfaces and USB endpoints belonging 45802ac6454SAndrew Thompson * to an USB device. 459bdd41206SAndrew Thompson * 460bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 46102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 46202ac6454SAndrew Thompson static void 463a593f6b8SAndrew Thompson usb_unconfigure(struct usb_device *udev, uint8_t flag) 46402ac6454SAndrew Thompson { 465bdd41206SAndrew Thompson uint8_t do_unlock; 46602ac6454SAndrew Thompson 4676950c75fSHans Petter Selasky /* Prevent re-enumeration */ 4686950c75fSHans Petter Selasky do_unlock = usbd_enum_lock(udev); 469bdd41206SAndrew Thompson 470bdd41206SAndrew Thompson /* detach all interface drivers */ 471a593f6b8SAndrew Thompson usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag); 472bdd41206SAndrew Thompson 473bdd41206SAndrew Thompson #if USB_HAVE_UGEN 474bdd41206SAndrew Thompson /* free all FIFOs except control endpoint FIFOs */ 475a593f6b8SAndrew Thompson usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag); 476bdd41206SAndrew Thompson 477bdd41206SAndrew Thompson /* 478bdd41206SAndrew Thompson * Free all cdev's, if any. 479bdd41206SAndrew Thompson */ 480a593f6b8SAndrew Thompson usb_cdev_free(udev); 481bdd41206SAndrew Thompson #endif 48202ac6454SAndrew Thompson 483bdc081c6SAndrew Thompson #if USB_HAVE_COMPAT_LINUX 48402ac6454SAndrew Thompson /* free Linux compat device, if any */ 485760bc48eSAndrew Thompson if (udev->linux_endpoint_start) { 486760bc48eSAndrew Thompson usb_linux_free_device(udev); 487760bc48eSAndrew Thompson udev->linux_endpoint_start = NULL; 48802ac6454SAndrew Thompson } 489bdc081c6SAndrew Thompson #endif 49002ac6454SAndrew Thompson 491a593f6b8SAndrew Thompson usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE); 49202ac6454SAndrew Thompson 493ae60fdfbSAndrew Thompson /* free "cdesc" after "ifaces" and "endpoints", if any */ 4947efaaa9aSAndrew Thompson if (udev->cdesc != NULL) { 495f29a0724SAndrew Thompson if (udev->flags.usb_mode != USB_MODE_DEVICE) 49602ac6454SAndrew Thompson free(udev->cdesc, M_USB); 49702ac6454SAndrew Thompson udev->cdesc = NULL; 49802ac6454SAndrew Thompson } 49902ac6454SAndrew Thompson /* set unconfigured state */ 50002ac6454SAndrew Thompson udev->curr_config_no = USB_UNCONFIG_NO; 50102ac6454SAndrew Thompson udev->curr_config_index = USB_UNCONFIG_INDEX; 502bdd41206SAndrew Thompson 503cb18f7d1SAlfred Perlstein if (do_unlock) 504cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 50502ac6454SAndrew Thompson } 50602ac6454SAndrew Thompson 50702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 508a593f6b8SAndrew Thompson * usbd_set_config_index 50902ac6454SAndrew Thompson * 51002ac6454SAndrew Thompson * This function selects configuration by index, independent of the 51102ac6454SAndrew Thompson * actual configuration number. This function should not be used by 51202ac6454SAndrew Thompson * USB drivers. 51302ac6454SAndrew Thompson * 51402ac6454SAndrew Thompson * Returns: 51502ac6454SAndrew Thompson * 0: Success 51602ac6454SAndrew Thompson * Else: Failure 51702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 518e0a69b51SAndrew Thompson usb_error_t 519a593f6b8SAndrew Thompson usbd_set_config_index(struct usb_device *udev, uint8_t index) 52002ac6454SAndrew Thompson { 521760bc48eSAndrew Thompson struct usb_status ds; 522760bc48eSAndrew Thompson struct usb_config_descriptor *cdp; 52302ac6454SAndrew Thompson uint16_t power; 52402ac6454SAndrew Thompson uint16_t max_power; 52502ac6454SAndrew Thompson uint8_t selfpowered; 52602ac6454SAndrew Thompson uint8_t do_unlock; 527e0a69b51SAndrew Thompson usb_error_t err; 52802ac6454SAndrew Thompson 52902ac6454SAndrew Thompson DPRINTFN(6, "udev=%p index=%d\n", udev, index); 53002ac6454SAndrew Thompson 5316950c75fSHans Petter Selasky /* Prevent re-enumeration */ 5326950c75fSHans Petter Selasky do_unlock = usbd_enum_lock(udev); 53302ac6454SAndrew Thompson 534d88688c7SAndrew Thompson usb_unconfigure(udev, 0); 53502ac6454SAndrew Thompson 53602ac6454SAndrew Thompson if (index == USB_UNCONFIG_INDEX) { 53702ac6454SAndrew Thompson /* 53802ac6454SAndrew Thompson * Leave unallocated when unconfiguring the 539a593f6b8SAndrew Thompson * device. "usb_unconfigure()" will also reset 54002ac6454SAndrew Thompson * the current config number and index. 54102ac6454SAndrew Thompson */ 542a593f6b8SAndrew Thompson err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO); 543bd216778SAndrew Thompson if (udev->state == USB_STATE_CONFIGURED) 544a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_ADDRESSED); 54502ac6454SAndrew Thompson goto done; 54602ac6454SAndrew Thompson } 54702ac6454SAndrew Thompson /* get the full config descriptor */ 548f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 5497efaaa9aSAndrew Thompson /* save some memory */ 550a593f6b8SAndrew Thompson err = usbd_req_get_descriptor_ptr(udev, &cdp, 551459d369eSAndrew Thompson (UDESC_CONFIG << 8) | index); 5527efaaa9aSAndrew Thompson } else { 5537efaaa9aSAndrew Thompson /* normal request */ 554a593f6b8SAndrew Thompson err = usbd_req_get_config_desc_full(udev, 555e2805033SAndrew Thompson NULL, &cdp, M_USB, index); 5567efaaa9aSAndrew Thompson } 55702ac6454SAndrew Thompson if (err) { 55802ac6454SAndrew Thompson goto done; 55902ac6454SAndrew Thompson } 56002ac6454SAndrew Thompson /* set the new config descriptor */ 56102ac6454SAndrew Thompson 56202ac6454SAndrew Thompson udev->cdesc = cdp; 56302ac6454SAndrew Thompson 56402ac6454SAndrew Thompson /* Figure out if the device is self or bus powered. */ 56502ac6454SAndrew Thompson selfpowered = 0; 56602ac6454SAndrew Thompson if ((!udev->flags.uq_bus_powered) && 56702ac6454SAndrew Thompson (cdp->bmAttributes & UC_SELF_POWERED) && 568f29a0724SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST)) { 56902ac6454SAndrew Thompson /* May be self powered. */ 57002ac6454SAndrew Thompson if (cdp->bmAttributes & UC_BUS_POWERED) { 57102ac6454SAndrew Thompson /* Must ask device. */ 572a593f6b8SAndrew Thompson err = usbd_req_get_device_status(udev, NULL, &ds); 57302ac6454SAndrew Thompson if (err) { 57402ac6454SAndrew Thompson DPRINTFN(0, "could not read " 57502ac6454SAndrew Thompson "device status: %s\n", 576a593f6b8SAndrew Thompson usbd_errstr(err)); 57702ac6454SAndrew Thompson } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) { 57802ac6454SAndrew Thompson selfpowered = 1; 57902ac6454SAndrew Thompson } 58002ac6454SAndrew Thompson DPRINTF("status=0x%04x \n", 58102ac6454SAndrew Thompson UGETW(ds.wStatus)); 58202ac6454SAndrew Thompson } else 58302ac6454SAndrew Thompson selfpowered = 1; 58402ac6454SAndrew Thompson } 58502ac6454SAndrew Thompson DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, " 58602ac6454SAndrew Thompson "selfpowered=%d, power=%d\n", 58702ac6454SAndrew Thompson udev, cdp, 58891f72cedSAndrew Thompson udev->address, cdp->bConfigurationValue, cdp->bmAttributes, 58902ac6454SAndrew Thompson selfpowered, cdp->bMaxPower * 2); 59002ac6454SAndrew Thompson 59102ac6454SAndrew Thompson /* Check if we have enough power. */ 59202ac6454SAndrew Thompson power = cdp->bMaxPower * 2; 59302ac6454SAndrew Thompson 59402ac6454SAndrew Thompson if (udev->parent_hub) { 59502ac6454SAndrew Thompson max_power = udev->parent_hub->hub->portpower; 59602ac6454SAndrew Thompson } else { 59702ac6454SAndrew Thompson max_power = USB_MAX_POWER; 59802ac6454SAndrew Thompson } 59902ac6454SAndrew Thompson 60002ac6454SAndrew Thompson if (power > max_power) { 60102ac6454SAndrew Thompson DPRINTFN(0, "power exceeded %d > %d\n", power, max_power); 60202ac6454SAndrew Thompson err = USB_ERR_NO_POWER; 60302ac6454SAndrew Thompson goto done; 60402ac6454SAndrew Thompson } 60502ac6454SAndrew Thompson /* Only update "self_powered" in USB Host Mode */ 606f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_HOST) { 60702ac6454SAndrew Thompson udev->flags.self_powered = selfpowered; 60802ac6454SAndrew Thompson } 60902ac6454SAndrew Thompson udev->power = power; 61002ac6454SAndrew Thompson udev->curr_config_no = cdp->bConfigurationValue; 61102ac6454SAndrew Thompson udev->curr_config_index = index; 612a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_CONFIGURED); 61302ac6454SAndrew Thompson 61402ac6454SAndrew Thompson /* Set the actual configuration value. */ 615a593f6b8SAndrew Thompson err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue); 61602ac6454SAndrew Thompson if (err) { 61702ac6454SAndrew Thompson goto done; 61802ac6454SAndrew Thompson } 619bdd41206SAndrew Thompson 620a593f6b8SAndrew Thompson err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC); 62102ac6454SAndrew Thompson if (err) { 62202ac6454SAndrew Thompson goto done; 62302ac6454SAndrew Thompson } 624bdd41206SAndrew Thompson 625a593f6b8SAndrew Thompson err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT); 626bdd41206SAndrew Thompson if (err) { 627bdd41206SAndrew Thompson goto done; 62802ac6454SAndrew Thompson } 629bdd41206SAndrew Thompson 6300f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 631ee3e3ff5SAndrew Thompson /* create device nodes for each endpoint */ 632a593f6b8SAndrew Thompson usb_cdev_create(udev); 6330f6e8f93SAndrew Thompson #endif 63402ac6454SAndrew Thompson 63502ac6454SAndrew Thompson done: 636a593f6b8SAndrew Thompson DPRINTF("error=%s\n", usbd_errstr(err)); 63702ac6454SAndrew Thompson if (err) { 638d88688c7SAndrew Thompson usb_unconfigure(udev, 0); 63902ac6454SAndrew Thompson } 640cb18f7d1SAlfred Perlstein if (do_unlock) 641cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 64202ac6454SAndrew Thompson return (err); 64302ac6454SAndrew Thompson } 64402ac6454SAndrew Thompson 64502ac6454SAndrew Thompson /*------------------------------------------------------------------------* 646a593f6b8SAndrew Thompson * usb_config_parse 647bdd41206SAndrew Thompson * 648ae60fdfbSAndrew Thompson * This function will allocate and free USB interfaces and USB endpoints, 649ae60fdfbSAndrew Thompson * parse the USB configuration structure and initialise the USB endpoints 650bdd41206SAndrew Thompson * and interfaces. If "iface_index" is not equal to 651bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the 652bdd41206SAndrew Thompson * alternate_setting to be selected for the given interface. Else the 653bdd41206SAndrew Thompson * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be 654bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function 655bdd41206SAndrew Thompson * is typically called when setting the configuration or when setting 656bdd41206SAndrew Thompson * an alternate interface. 657bdd41206SAndrew Thompson * 658bdd41206SAndrew Thompson * Returns: 659bdd41206SAndrew Thompson * 0: Success 660bdd41206SAndrew Thompson * Else: Failure 661bdd41206SAndrew Thompson *------------------------------------------------------------------------*/ 662963169b4SHans Petter Selasky static usb_error_t 663a593f6b8SAndrew Thompson usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd) 664bdd41206SAndrew Thompson { 665760bc48eSAndrew Thompson struct usb_idesc_parse_state ips; 666760bc48eSAndrew Thompson struct usb_interface_descriptor *id; 667760bc48eSAndrew Thompson struct usb_endpoint_descriptor *ed; 668760bc48eSAndrew Thompson struct usb_interface *iface; 669ae60fdfbSAndrew Thompson struct usb_endpoint *ep; 670e0a69b51SAndrew Thompson usb_error_t err; 671bdd41206SAndrew Thompson uint8_t ep_curr; 672bdd41206SAndrew Thompson uint8_t ep_max; 673bdd41206SAndrew Thompson uint8_t temp; 674bdd41206SAndrew Thompson uint8_t do_init; 675bdd41206SAndrew Thompson uint8_t alt_index; 676bdd41206SAndrew Thompson 677bdd41206SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 678bdd41206SAndrew Thompson /* parameter overload */ 679bdd41206SAndrew Thompson alt_index = cmd; 680bdd41206SAndrew Thompson cmd = USB_CFG_INIT; 681bdd41206SAndrew Thompson } else { 682bdd41206SAndrew Thompson /* not used */ 683bdd41206SAndrew Thompson alt_index = 0; 684bdd41206SAndrew Thompson } 685bdd41206SAndrew Thompson 686bdd41206SAndrew Thompson err = 0; 687bdd41206SAndrew Thompson 688bdd41206SAndrew Thompson DPRINTFN(5, "iface_index=%d cmd=%d\n", 689bdd41206SAndrew Thompson iface_index, cmd); 690bdd41206SAndrew Thompson 691bdd41206SAndrew Thompson if (cmd == USB_CFG_FREE) 692bdd41206SAndrew Thompson goto cleanup; 693bdd41206SAndrew Thompson 694bdd41206SAndrew Thompson if (cmd == USB_CFG_INIT) { 69591cd9240SAndrew Thompson sx_assert(&udev->enum_sx, SA_LOCKED); 696bdd41206SAndrew Thompson 697ae60fdfbSAndrew Thompson /* check for in-use endpoints */ 698bdd41206SAndrew Thompson 699ae60fdfbSAndrew Thompson ep = udev->endpoints; 700ae60fdfbSAndrew Thompson ep_max = udev->endpoints_max; 701bdd41206SAndrew Thompson while (ep_max--) { 702ae60fdfbSAndrew Thompson /* look for matching endpoints */ 703bdd41206SAndrew Thompson if ((iface_index == USB_IFACE_INDEX_ANY) || 704ae60fdfbSAndrew Thompson (iface_index == ep->iface_index)) { 705f12c6c29SAndrew Thompson if (ep->refcount_alloc != 0) { 706bdd41206SAndrew Thompson /* 707bdd41206SAndrew Thompson * This typically indicates a 708bdd41206SAndrew Thompson * more serious error. 709bdd41206SAndrew Thompson */ 710bdd41206SAndrew Thompson err = USB_ERR_IN_USE; 711bdd41206SAndrew Thompson } else { 712ae60fdfbSAndrew Thompson /* reset endpoint */ 713ae60fdfbSAndrew Thompson memset(ep, 0, sizeof(*ep)); 714ae60fdfbSAndrew Thompson /* make sure we don't zero the endpoint again */ 715ae60fdfbSAndrew Thompson ep->iface_index = USB_IFACE_INDEX_ANY; 716bdd41206SAndrew Thompson } 717bdd41206SAndrew Thompson } 718ae60fdfbSAndrew Thompson ep++; 719bdd41206SAndrew Thompson } 720bdd41206SAndrew Thompson 721bdd41206SAndrew Thompson if (err) 722bdd41206SAndrew Thompson return (err); 723bdd41206SAndrew Thompson } 724bdd41206SAndrew Thompson 725bdd41206SAndrew Thompson memset(&ips, 0, sizeof(ips)); 726bdd41206SAndrew Thompson 727bdd41206SAndrew Thompson ep_curr = 0; 728bdd41206SAndrew Thompson ep_max = 0; 729bdd41206SAndrew Thompson 730a593f6b8SAndrew Thompson while ((id = usb_idesc_foreach(udev->cdesc, &ips))) { 731bdd41206SAndrew Thompson 732bdd41206SAndrew Thompson iface = udev->ifaces + ips.iface_index; 733bdd41206SAndrew Thompson 734bdd41206SAndrew Thompson /* check for specific interface match */ 735bdd41206SAndrew Thompson 736bdd41206SAndrew Thompson if (cmd == USB_CFG_INIT) { 737bdd41206SAndrew Thompson if ((iface_index != USB_IFACE_INDEX_ANY) && 738bdd41206SAndrew Thompson (iface_index != ips.iface_index)) { 739bdd41206SAndrew Thompson /* wrong interface */ 740bdd41206SAndrew Thompson do_init = 0; 741bdd41206SAndrew Thompson } else if (alt_index != ips.iface_index_alt) { 742bdd41206SAndrew Thompson /* wrong alternate setting */ 743bdd41206SAndrew Thompson do_init = 0; 744bdd41206SAndrew Thompson } else { 745bdd41206SAndrew Thompson /* initialise interface */ 746bdd41206SAndrew Thompson do_init = 1; 747bdd41206SAndrew Thompson } 748bdd41206SAndrew Thompson } else 749bdd41206SAndrew Thompson do_init = 0; 750bdd41206SAndrew Thompson 751bdd41206SAndrew Thompson /* check for new interface */ 752bdd41206SAndrew Thompson if (ips.iface_index_alt == 0) { 753bdd41206SAndrew Thompson /* update current number of endpoints */ 754bdd41206SAndrew Thompson ep_curr = ep_max; 755bdd41206SAndrew Thompson } 756bdd41206SAndrew Thompson /* check for init */ 757bdd41206SAndrew Thompson if (do_init) { 758bdd41206SAndrew Thompson /* setup the USB interface structure */ 759bdd41206SAndrew Thompson iface->idesc = id; 760bdd41206SAndrew Thompson /* set alternate index */ 761bdd41206SAndrew Thompson iface->alt_index = alt_index; 762d9073c1eSHans Petter Selasky /* set default interface parent */ 763d9073c1eSHans Petter Selasky if (iface_index == USB_IFACE_INDEX_ANY) { 764d9073c1eSHans Petter Selasky iface->parent_iface_index = 765d9073c1eSHans Petter Selasky USB_IFACE_INDEX_ANY; 766d9073c1eSHans Petter Selasky } 767bdd41206SAndrew Thompson } 768bdd41206SAndrew Thompson 769bdd41206SAndrew Thompson DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints); 770bdd41206SAndrew Thompson 771760bc48eSAndrew Thompson ed = (struct usb_endpoint_descriptor *)id; 772bdd41206SAndrew Thompson 773bdd41206SAndrew Thompson temp = ep_curr; 774bdd41206SAndrew Thompson 775bdd41206SAndrew Thompson /* iterate all the endpoint descriptors */ 776a593f6b8SAndrew Thompson while ((ed = usb_edesc_foreach(udev->cdesc, ed))) { 777bdd41206SAndrew Thompson 7785b0752bbSHans Petter Selasky /* check if endpoint limit has been reached */ 7795b0752bbSHans Petter Selasky if (temp >= USB_MAX_EP_UNITS) { 7805b0752bbSHans Petter Selasky DPRINTF("Endpoint limit reached\n"); 7815b0752bbSHans Petter Selasky break; 7825b0752bbSHans Petter Selasky } 783bdd41206SAndrew Thompson 784ae60fdfbSAndrew Thompson ep = udev->endpoints + temp; 785bdd41206SAndrew Thompson 786bdd41206SAndrew Thompson if (do_init) { 787963169b4SHans Petter Selasky void *ecomp; 788963169b4SHans Petter Selasky 789963169b4SHans Petter Selasky ecomp = usb_ed_comp_foreach(udev->cdesc, (void *)ed); 790963169b4SHans Petter Selasky if (ecomp != NULL) 791963169b4SHans Petter Selasky DPRINTFN(5, "Found endpoint companion descriptor\n"); 792963169b4SHans Petter Selasky 793a593f6b8SAndrew Thompson usb_init_endpoint(udev, 794963169b4SHans Petter Selasky ips.iface_index, ed, ecomp, ep); 795bdd41206SAndrew Thompson } 796bdd41206SAndrew Thompson 797bdd41206SAndrew Thompson temp ++; 798bdd41206SAndrew Thompson 799bdd41206SAndrew Thompson /* find maximum number of endpoints */ 800bdd41206SAndrew Thompson if (ep_max < temp) 801bdd41206SAndrew Thompson ep_max = temp; 802bdd41206SAndrew Thompson 803bdd41206SAndrew Thompson /* optimalisation */ 804760bc48eSAndrew Thompson id = (struct usb_interface_descriptor *)ed; 805bdd41206SAndrew Thompson } 806bdd41206SAndrew Thompson } 807bdd41206SAndrew Thompson 808bdd41206SAndrew Thompson /* NOTE: It is valid to have no interfaces and no endpoints! */ 809bdd41206SAndrew Thompson 810bdd41206SAndrew Thompson if (cmd == USB_CFG_ALLOC) { 811bdd41206SAndrew Thompson udev->ifaces_max = ips.iface_index; 8125b0752bbSHans Petter Selasky #if (USB_HAVE_FIXED_IFACE == 0) 813bdd41206SAndrew Thompson udev->ifaces = NULL; 814bdd41206SAndrew Thompson if (udev->ifaces_max != 0) { 815bdd41206SAndrew Thompson udev->ifaces = malloc(sizeof(*iface) * udev->ifaces_max, 816bdd41206SAndrew Thompson M_USB, M_WAITOK | M_ZERO); 817bdd41206SAndrew Thompson if (udev->ifaces == NULL) { 818bdd41206SAndrew Thompson err = USB_ERR_NOMEM; 819bdd41206SAndrew Thompson goto done; 820bdd41206SAndrew Thompson } 821bdd41206SAndrew Thompson } 8225b0752bbSHans Petter Selasky #endif 8235b0752bbSHans Petter Selasky #if (USB_HAVE_FIXED_ENDPOINT == 0) 8249469c929SAndrew Thompson if (ep_max != 0) { 825ae60fdfbSAndrew Thompson udev->endpoints = malloc(sizeof(*ep) * ep_max, 826bdd41206SAndrew Thompson M_USB, M_WAITOK | M_ZERO); 827ae60fdfbSAndrew Thompson if (udev->endpoints == NULL) { 828bdd41206SAndrew Thompson err = USB_ERR_NOMEM; 829bdd41206SAndrew Thompson goto done; 830bdd41206SAndrew Thompson } 8319469c929SAndrew Thompson } else { 832ae60fdfbSAndrew Thompson udev->endpoints = NULL; 833bdd41206SAndrew Thompson } 8345b0752bbSHans Petter Selasky #endif 8359469c929SAndrew Thompson USB_BUS_LOCK(udev->bus); 836ae60fdfbSAndrew Thompson udev->endpoints_max = ep_max; 8379469c929SAndrew Thompson /* reset any ongoing clear-stall */ 838ae60fdfbSAndrew Thompson udev->ep_curr = NULL; 8399469c929SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 840bdd41206SAndrew Thompson } 841bdd41206SAndrew Thompson 842bdd41206SAndrew Thompson done: 843bdd41206SAndrew Thompson if (err) { 844bdd41206SAndrew Thompson if (cmd == USB_CFG_ALLOC) { 845bdd41206SAndrew Thompson cleanup: 8469469c929SAndrew Thompson USB_BUS_LOCK(udev->bus); 847ae60fdfbSAndrew Thompson udev->endpoints_max = 0; 8489469c929SAndrew Thompson /* reset any ongoing clear-stall */ 849ae60fdfbSAndrew Thompson udev->ep_curr = NULL; 8509469c929SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 8519469c929SAndrew Thompson 8525b0752bbSHans Petter Selasky #if (USB_HAVE_FIXED_IFACE == 0) 853bdd41206SAndrew Thompson free(udev->ifaces, M_USB); 854bdd41206SAndrew Thompson udev->ifaces = NULL; 8555b0752bbSHans Petter Selasky #endif 8565b0752bbSHans Petter Selasky #if (USB_HAVE_FIXED_ENDPOINT == 0) 8575b0752bbSHans Petter Selasky free(udev->endpoints, M_USB); 858ae60fdfbSAndrew Thompson udev->endpoints = NULL; 8595b0752bbSHans Petter Selasky #endif 860bdd41206SAndrew Thompson udev->ifaces_max = 0; 861bdd41206SAndrew Thompson } 862bdd41206SAndrew Thompson } 863bdd41206SAndrew Thompson return (err); 864bdd41206SAndrew Thompson } 865bdd41206SAndrew Thompson 866bdd41206SAndrew Thompson /*------------------------------------------------------------------------* 867a593f6b8SAndrew Thompson * usbd_set_alt_interface_index 86802ac6454SAndrew Thompson * 86902ac6454SAndrew Thompson * This function will select an alternate interface index for the 87002ac6454SAndrew Thompson * given interface index. The interface should not be in use when this 871e2805033SAndrew Thompson * function is called. That means there should not be any open USB 872e2805033SAndrew Thompson * transfers. Else an error is returned. If the alternate setting is 873e2805033SAndrew Thompson * already set this function will simply return success. This function 874e2805033SAndrew Thompson * is called in Host mode and Device mode! 87502ac6454SAndrew Thompson * 87602ac6454SAndrew Thompson * Returns: 87702ac6454SAndrew Thompson * 0: Success 87802ac6454SAndrew Thompson * Else: Failure 87902ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 880e0a69b51SAndrew Thompson usb_error_t 881a593f6b8SAndrew Thompson usbd_set_alt_interface_index(struct usb_device *udev, 88202ac6454SAndrew Thompson uint8_t iface_index, uint8_t alt_index) 88302ac6454SAndrew Thompson { 884a593f6b8SAndrew Thompson struct usb_interface *iface = usbd_get_iface(udev, iface_index); 885e0a69b51SAndrew Thompson usb_error_t err; 88602ac6454SAndrew Thompson uint8_t do_unlock; 88702ac6454SAndrew Thompson 8886950c75fSHans Petter Selasky /* Prevent re-enumeration */ 8896950c75fSHans Petter Selasky do_unlock = usbd_enum_lock(udev); 8906950c75fSHans Petter Selasky 89102ac6454SAndrew Thompson if (iface == NULL) { 89202ac6454SAndrew Thompson err = USB_ERR_INVAL; 89302ac6454SAndrew Thompson goto done; 89402ac6454SAndrew Thompson } 895e2805033SAndrew Thompson if (iface->alt_index == alt_index) { 896e2805033SAndrew Thompson /* 897e2805033SAndrew Thompson * Optimise away duplicate setting of 898e2805033SAndrew Thompson * alternate setting in USB Host Mode! 899e2805033SAndrew Thompson */ 900e2805033SAndrew Thompson err = 0; 901e2805033SAndrew Thompson goto done; 902e2805033SAndrew Thompson } 9030f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 90402ac6454SAndrew Thompson /* 90502ac6454SAndrew Thompson * Free all generic FIFOs for this interface, except control 90602ac6454SAndrew Thompson * endpoint FIFOs: 90702ac6454SAndrew Thompson */ 908a593f6b8SAndrew Thompson usb_fifo_free_wrap(udev, iface_index, 0); 9090f6e8f93SAndrew Thompson #endif 910bdd41206SAndrew Thompson 911a593f6b8SAndrew Thompson err = usb_config_parse(udev, iface_index, alt_index); 91202ac6454SAndrew Thompson if (err) { 91302ac6454SAndrew Thompson goto done; 91402ac6454SAndrew Thompson } 915bd73b187SAlfred Perlstein if (iface->alt_index != alt_index) { 916bd73b187SAlfred Perlstein /* the alternate setting does not exist */ 917bd73b187SAlfred Perlstein err = USB_ERR_INVAL; 918bd73b187SAlfred Perlstein goto done; 919bd73b187SAlfred Perlstein } 920bd73b187SAlfred Perlstein 921a593f6b8SAndrew Thompson err = usbd_req_set_alt_interface_no(udev, NULL, iface_index, 92202ac6454SAndrew Thompson iface->idesc->bAlternateSetting); 92302ac6454SAndrew Thompson 92402ac6454SAndrew Thompson done: 925cb18f7d1SAlfred Perlstein if (do_unlock) 926cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 92702ac6454SAndrew Thompson return (err); 92802ac6454SAndrew Thompson } 92902ac6454SAndrew Thompson 93002ac6454SAndrew Thompson /*------------------------------------------------------------------------* 931a593f6b8SAndrew Thompson * usbd_set_endpoint_stall 93202ac6454SAndrew Thompson * 933963169b4SHans Petter Selasky * This function is used to make a BULK or INTERRUPT endpoint send 934963169b4SHans Petter Selasky * STALL tokens in USB device mode. 93502ac6454SAndrew Thompson * 93602ac6454SAndrew Thompson * Returns: 93702ac6454SAndrew Thompson * 0: Success 93802ac6454SAndrew Thompson * Else: Failure 93902ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 940e0a69b51SAndrew Thompson usb_error_t 941a593f6b8SAndrew Thompson usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep, 94202ac6454SAndrew Thompson uint8_t do_stall) 94302ac6454SAndrew Thompson { 944760bc48eSAndrew Thompson struct usb_xfer *xfer; 945a5cf1aaaSHans Petter Selasky usb_stream_t x; 94602ac6454SAndrew Thompson uint8_t et; 94702ac6454SAndrew Thompson uint8_t was_stalled; 94802ac6454SAndrew Thompson 949ae60fdfbSAndrew Thompson if (ep == NULL) { 95002ac6454SAndrew Thompson /* nothing to do */ 95102ac6454SAndrew Thompson DPRINTF("Cannot find endpoint\n"); 95202ac6454SAndrew Thompson /* 95302ac6454SAndrew Thompson * Pretend that the clear or set stall request is 95402ac6454SAndrew Thompson * successful else some USB host stacks can do 95502ac6454SAndrew Thompson * strange things, especially when a control endpoint 95602ac6454SAndrew Thompson * stalls. 95702ac6454SAndrew Thompson */ 95802ac6454SAndrew Thompson return (0); 95902ac6454SAndrew Thompson } 960ae60fdfbSAndrew Thompson et = (ep->edesc->bmAttributes & UE_XFERTYPE); 96102ac6454SAndrew Thompson 96202ac6454SAndrew Thompson if ((et != UE_BULK) && 96302ac6454SAndrew Thompson (et != UE_INTERRUPT)) { 96402ac6454SAndrew Thompson /* 96502ac6454SAndrew Thompson * Should not stall control 96602ac6454SAndrew Thompson * nor isochronous endpoints. 96702ac6454SAndrew Thompson */ 96802ac6454SAndrew Thompson DPRINTF("Invalid endpoint\n"); 96902ac6454SAndrew Thompson return (0); 97002ac6454SAndrew Thompson } 97102ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 97202ac6454SAndrew Thompson 97302ac6454SAndrew Thompson /* store current stall state */ 974ae60fdfbSAndrew Thompson was_stalled = ep->is_stalled; 97502ac6454SAndrew Thompson 97602ac6454SAndrew Thompson /* check for no change */ 97702ac6454SAndrew Thompson if (was_stalled && do_stall) { 978ae60fdfbSAndrew Thompson /* if the endpoint is already stalled do nothing */ 97902ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 98002ac6454SAndrew Thompson DPRINTF("No change\n"); 98102ac6454SAndrew Thompson return (0); 98202ac6454SAndrew Thompson } 98302ac6454SAndrew Thompson /* set stalled state */ 984ae60fdfbSAndrew Thompson ep->is_stalled = 1; 98502ac6454SAndrew Thompson 98602ac6454SAndrew Thompson if (do_stall || (!was_stalled)) { 98702ac6454SAndrew Thompson if (!was_stalled) { 988a5cf1aaaSHans Petter Selasky for (x = 0; x != USB_MAX_EP_STREAMS; x++) { 98902ac6454SAndrew Thompson /* lookup the current USB transfer, if any */ 990a5cf1aaaSHans Petter Selasky xfer = ep->endpoint_q[x].curr; 991a5cf1aaaSHans Petter Selasky if (xfer != NULL) { 99202ac6454SAndrew Thompson /* 993a5cf1aaaSHans Petter Selasky * The "xfer_stall" method 994a5cf1aaaSHans Petter Selasky * will complete the USB 995a5cf1aaaSHans Petter Selasky * transfer like in case of a 996a5cf1aaaSHans Petter Selasky * timeout setting the error 997a5cf1aaaSHans Petter Selasky * code "USB_ERR_STALLED". 99802ac6454SAndrew Thompson */ 999a5cf1aaaSHans Petter Selasky (udev->bus->methods->xfer_stall) (xfer); 1000a5cf1aaaSHans Petter Selasky } 1001a5cf1aaaSHans Petter Selasky } 1002a5cf1aaaSHans Petter Selasky } 1003a5cf1aaaSHans Petter Selasky (udev->bus->methods->set_stall) (udev, ep, &do_stall); 100402ac6454SAndrew Thompson } 100502ac6454SAndrew Thompson if (!do_stall) { 1006ae60fdfbSAndrew Thompson ep->toggle_next = 0; /* reset data toggle */ 1007ae60fdfbSAndrew Thompson ep->is_stalled = 0; /* clear stalled state */ 100802ac6454SAndrew Thompson 1009ae60fdfbSAndrew Thompson (udev->bus->methods->clear_stall) (udev, ep); 101002ac6454SAndrew Thompson 1011a5cf1aaaSHans Petter Selasky /* start the current or next transfer, if any */ 1012a5cf1aaaSHans Petter Selasky for (x = 0; x != USB_MAX_EP_STREAMS; x++) { 1013a5cf1aaaSHans Petter Selasky usb_command_wrapper(&ep->endpoint_q[x], 1014a5cf1aaaSHans Petter Selasky ep->endpoint_q[x].curr); 1015a5cf1aaaSHans Petter Selasky } 101602ac6454SAndrew Thompson } 101702ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 101802ac6454SAndrew Thompson return (0); 101902ac6454SAndrew Thompson } 102002ac6454SAndrew Thompson 102102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1022a593f6b8SAndrew Thompson * usb_reset_iface_endpoints - used in USB device side mode 102302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1024e0a69b51SAndrew Thompson usb_error_t 1025a593f6b8SAndrew Thompson usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index) 102602ac6454SAndrew Thompson { 1027ae60fdfbSAndrew Thompson struct usb_endpoint *ep; 1028ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end; 102902ac6454SAndrew Thompson 1030ae60fdfbSAndrew Thompson ep = udev->endpoints; 1031ae60fdfbSAndrew Thompson ep_end = udev->endpoints + udev->endpoints_max; 103202ac6454SAndrew Thompson 1033ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 103402ac6454SAndrew Thompson 1035ae60fdfbSAndrew Thompson if ((ep->edesc == NULL) || 1036ae60fdfbSAndrew Thompson (ep->iface_index != iface_index)) { 103702ac6454SAndrew Thompson continue; 103802ac6454SAndrew Thompson } 103902ac6454SAndrew Thompson /* simulate a clear stall from the peer */ 1040bd73b187SAlfred Perlstein usbd_set_endpoint_stall(udev, ep, 0); 104102ac6454SAndrew Thompson } 104202ac6454SAndrew Thompson return (0); 104302ac6454SAndrew Thompson } 104402ac6454SAndrew Thompson 104502ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1046a593f6b8SAndrew Thompson * usb_detach_device_sub 104702ac6454SAndrew Thompson * 104802ac6454SAndrew Thompson * This function will try to detach an USB device. If it fails a panic 104902ac6454SAndrew Thompson * will result. 1050bdd41206SAndrew Thompson * 1051bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 105202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 105302ac6454SAndrew Thompson static void 1054a593f6b8SAndrew Thompson usb_detach_device_sub(struct usb_device *udev, device_t *ppdev, 10558427ed84SHans Petter Selasky char **ppnpinfo, uint8_t flag) 105602ac6454SAndrew Thompson { 105702ac6454SAndrew Thompson device_t dev; 10588427ed84SHans Petter Selasky char *pnpinfo; 105902ac6454SAndrew Thompson int err; 106002ac6454SAndrew Thompson 1061d88688c7SAndrew Thompson dev = *ppdev; 1062d88688c7SAndrew Thompson if (dev) { 106302ac6454SAndrew Thompson /* 106402ac6454SAndrew Thompson * NOTE: It is important to clear "*ppdev" before deleting 106502ac6454SAndrew Thompson * the child due to some device methods being called late 106602ac6454SAndrew Thompson * during the delete process ! 106702ac6454SAndrew Thompson */ 106802ac6454SAndrew Thompson *ppdev = NULL; 106902ac6454SAndrew Thompson 107002ac6454SAndrew Thompson device_printf(dev, "at %s, port %d, addr %d " 107102ac6454SAndrew Thompson "(disconnected)\n", 107202ac6454SAndrew Thompson device_get_nameunit(udev->parent_dev), 107302ac6454SAndrew Thompson udev->port_no, udev->address); 107402ac6454SAndrew Thompson 107502ac6454SAndrew Thompson if (device_is_attached(dev)) { 1076ec8f3127SAndrew Thompson if (udev->flags.peer_suspended) { 107702ac6454SAndrew Thompson err = DEVICE_RESUME(dev); 107802ac6454SAndrew Thompson if (err) { 1079767cb2e2SAndrew Thompson device_printf(dev, "Resume failed\n"); 108002ac6454SAndrew Thompson } 108102ac6454SAndrew Thompson } 108202ac6454SAndrew Thompson if (device_detach(dev)) { 108302ac6454SAndrew Thompson goto error; 108402ac6454SAndrew Thompson } 108502ac6454SAndrew Thompson } 108602ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, dev)) { 108702ac6454SAndrew Thompson goto error; 108802ac6454SAndrew Thompson } 108902ac6454SAndrew Thompson } 10908427ed84SHans Petter Selasky 10918427ed84SHans Petter Selasky pnpinfo = *ppnpinfo; 10928427ed84SHans Petter Selasky if (pnpinfo != NULL) { 10938427ed84SHans Petter Selasky *ppnpinfo = NULL; 10948427ed84SHans Petter Selasky free(pnpinfo, M_USBDEV); 10958427ed84SHans Petter Selasky } 109602ac6454SAndrew Thompson return; 109702ac6454SAndrew Thompson 109802ac6454SAndrew Thompson error: 109902ac6454SAndrew Thompson /* Detach is not allowed to fail in the USB world */ 11008427ed84SHans Petter Selasky panic("usb_detach_device_sub: A USB driver would not detach\n"); 110102ac6454SAndrew Thompson } 110202ac6454SAndrew Thompson 110302ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1104a593f6b8SAndrew Thompson * usb_detach_device 110502ac6454SAndrew Thompson * 110602ac6454SAndrew Thompson * The following function will detach the matching interfaces. 110702ac6454SAndrew Thompson * This function is NULL safe. 1108bdd41206SAndrew Thompson * 1109bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 111002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 111102ac6454SAndrew Thompson void 1112a593f6b8SAndrew Thompson usb_detach_device(struct usb_device *udev, uint8_t iface_index, 1113bdd41206SAndrew Thompson uint8_t flag) 111402ac6454SAndrew Thompson { 1115760bc48eSAndrew Thompson struct usb_interface *iface; 111602ac6454SAndrew Thompson uint8_t i; 111702ac6454SAndrew Thompson 111802ac6454SAndrew Thompson if (udev == NULL) { 111902ac6454SAndrew Thompson /* nothing to do */ 112002ac6454SAndrew Thompson return; 112102ac6454SAndrew Thompson } 112202ac6454SAndrew Thompson DPRINTFN(4, "udev=%p\n", udev); 112302ac6454SAndrew Thompson 112491cd9240SAndrew Thompson sx_assert(&udev->enum_sx, SA_LOCKED); 112502ac6454SAndrew Thompson 112602ac6454SAndrew Thompson /* 112702ac6454SAndrew Thompson * First detach the child to give the child's detach routine a 112802ac6454SAndrew Thompson * chance to detach the sub-devices in the correct order. 112902ac6454SAndrew Thompson * Then delete the child using "device_delete_child()" which 113002ac6454SAndrew Thompson * will detach all sub-devices from the bottom and upwards! 113102ac6454SAndrew Thompson */ 113202ac6454SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 113302ac6454SAndrew Thompson i = iface_index; 113402ac6454SAndrew Thompson iface_index = i + 1; 113502ac6454SAndrew Thompson } else { 113602ac6454SAndrew Thompson i = 0; 113702ac6454SAndrew Thompson iface_index = USB_IFACE_MAX; 113802ac6454SAndrew Thompson } 113902ac6454SAndrew Thompson 114002ac6454SAndrew Thompson /* do the detach */ 114102ac6454SAndrew Thompson 114202ac6454SAndrew Thompson for (; i != iface_index; i++) { 114302ac6454SAndrew Thompson 1144a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 114502ac6454SAndrew Thompson if (iface == NULL) { 114602ac6454SAndrew Thompson /* looks like the end of the USB interfaces */ 114702ac6454SAndrew Thompson break; 114802ac6454SAndrew Thompson } 11498427ed84SHans Petter Selasky usb_detach_device_sub(udev, &iface->subdev, 11508427ed84SHans Petter Selasky &iface->pnpinfo, flag); 115102ac6454SAndrew Thompson } 115202ac6454SAndrew Thompson } 115302ac6454SAndrew Thompson 115402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1155a593f6b8SAndrew Thompson * usb_probe_and_attach_sub 115602ac6454SAndrew Thompson * 115702ac6454SAndrew Thompson * Returns: 115802ac6454SAndrew Thompson * 0: Success 115902ac6454SAndrew Thompson * Else: Failure 116002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 116102ac6454SAndrew Thompson static uint8_t 1162a593f6b8SAndrew Thompson usb_probe_and_attach_sub(struct usb_device *udev, 1163760bc48eSAndrew Thompson struct usb_attach_arg *uaa) 116402ac6454SAndrew Thompson { 1165760bc48eSAndrew Thompson struct usb_interface *iface; 116602ac6454SAndrew Thompson device_t dev; 116702ac6454SAndrew Thompson int err; 116802ac6454SAndrew Thompson 116902ac6454SAndrew Thompson iface = uaa->iface; 117002ac6454SAndrew Thompson if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) { 117102ac6454SAndrew Thompson /* leave interface alone */ 117202ac6454SAndrew Thompson return (0); 117302ac6454SAndrew Thompson } 117402ac6454SAndrew Thompson dev = iface->subdev; 117502ac6454SAndrew Thompson if (dev) { 117602ac6454SAndrew Thompson 117702ac6454SAndrew Thompson /* clean up after module unload */ 117802ac6454SAndrew Thompson 117902ac6454SAndrew Thompson if (device_is_attached(dev)) { 118002ac6454SAndrew Thompson /* already a device there */ 118102ac6454SAndrew Thompson return (0); 118202ac6454SAndrew Thompson } 118302ac6454SAndrew Thompson /* clear "iface->subdev" as early as possible */ 118402ac6454SAndrew Thompson 118502ac6454SAndrew Thompson iface->subdev = NULL; 118602ac6454SAndrew Thompson 118702ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, dev)) { 118802ac6454SAndrew Thompson 118902ac6454SAndrew Thompson /* 119002ac6454SAndrew Thompson * Panic here, else one can get a double call 119102ac6454SAndrew Thompson * to device_detach(). USB devices should 119202ac6454SAndrew Thompson * never fail on detach! 119302ac6454SAndrew Thompson */ 1194767cb2e2SAndrew Thompson panic("device_delete_child() failed\n"); 119502ac6454SAndrew Thompson } 119602ac6454SAndrew Thompson } 119702ac6454SAndrew Thompson if (uaa->temp_dev == NULL) { 119802ac6454SAndrew Thompson 119902ac6454SAndrew Thompson /* create a new child */ 120002ac6454SAndrew Thompson uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1); 120102ac6454SAndrew Thompson if (uaa->temp_dev == NULL) { 120202ac6454SAndrew Thompson device_printf(udev->parent_dev, 1203767cb2e2SAndrew Thompson "Device creation failed\n"); 120402ac6454SAndrew Thompson return (1); /* failure */ 120502ac6454SAndrew Thompson } 120602ac6454SAndrew Thompson device_set_ivars(uaa->temp_dev, uaa); 120702ac6454SAndrew Thompson device_quiet(uaa->temp_dev); 120802ac6454SAndrew Thompson } 120902ac6454SAndrew Thompson /* 121002ac6454SAndrew Thompson * Set "subdev" before probe and attach so that "devd" gets 121102ac6454SAndrew Thompson * the information it needs. 121202ac6454SAndrew Thompson */ 121302ac6454SAndrew Thompson iface->subdev = uaa->temp_dev; 121402ac6454SAndrew Thompson 121502ac6454SAndrew Thompson if (device_probe_and_attach(iface->subdev) == 0) { 121602ac6454SAndrew Thompson /* 121702ac6454SAndrew Thompson * The USB attach arguments are only available during probe 121802ac6454SAndrew Thompson * and attach ! 121902ac6454SAndrew Thompson */ 122002ac6454SAndrew Thompson uaa->temp_dev = NULL; 122102ac6454SAndrew Thompson device_set_ivars(iface->subdev, NULL); 122202ac6454SAndrew Thompson 1223ec8f3127SAndrew Thompson if (udev->flags.peer_suspended) { 122402ac6454SAndrew Thompson err = DEVICE_SUSPEND(iface->subdev); 122588b4e0abSAndrew Thompson if (err) 122602ac6454SAndrew Thompson device_printf(iface->subdev, "Suspend failed\n"); 122702ac6454SAndrew Thompson } 122802ac6454SAndrew Thompson return (0); /* success */ 122902ac6454SAndrew Thompson } else { 123002ac6454SAndrew Thompson /* No USB driver found */ 123102ac6454SAndrew Thompson iface->subdev = NULL; 123202ac6454SAndrew Thompson } 123302ac6454SAndrew Thompson return (1); /* failure */ 123402ac6454SAndrew Thompson } 123502ac6454SAndrew Thompson 123602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1237a593f6b8SAndrew Thompson * usbd_set_parent_iface 123802ac6454SAndrew Thompson * 123902ac6454SAndrew Thompson * Using this function will lock the alternate interface setting on an 124002ac6454SAndrew Thompson * interface. It is typically used for multi interface drivers. In USB 124102ac6454SAndrew Thompson * device side mode it is assumed that the alternate interfaces all 124202ac6454SAndrew Thompson * have the same endpoint descriptors. The default parent index value 124302ac6454SAndrew Thompson * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not 124402ac6454SAndrew Thompson * locked. 124502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 124602ac6454SAndrew Thompson void 1247a593f6b8SAndrew Thompson usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index, 124802ac6454SAndrew Thompson uint8_t parent_index) 124902ac6454SAndrew Thompson { 1250760bc48eSAndrew Thompson struct usb_interface *iface; 125102ac6454SAndrew Thompson 1252d9073c1eSHans Petter Selasky if (udev == NULL) { 1253d9073c1eSHans Petter Selasky /* nothing to do */ 1254d9073c1eSHans Petter Selasky return; 125502ac6454SAndrew Thompson } 1256d9073c1eSHans Petter Selasky iface = usbd_get_iface(udev, iface_index); 1257d9073c1eSHans Petter Selasky if (iface != NULL) 1258d9073c1eSHans Petter Selasky iface->parent_iface_index = parent_index; 125902ac6454SAndrew Thompson } 126002ac6454SAndrew Thompson 126102ac6454SAndrew Thompson static void 1262a593f6b8SAndrew Thompson usb_init_attach_arg(struct usb_device *udev, 1263760bc48eSAndrew Thompson struct usb_attach_arg *uaa) 126402ac6454SAndrew Thompson { 1265d46dc4adSHans Petter Selasky memset(uaa, 0, sizeof(*uaa)); 126602ac6454SAndrew Thompson 126702ac6454SAndrew Thompson uaa->device = udev; 1268f29a0724SAndrew Thompson uaa->usb_mode = udev->flags.usb_mode; 126902ac6454SAndrew Thompson uaa->port = udev->port_no; 12702a4c6157SAndrew Thompson uaa->dev_state = UAA_DEV_READY; 127102ac6454SAndrew Thompson 127202ac6454SAndrew Thompson uaa->info.idVendor = UGETW(udev->ddesc.idVendor); 127302ac6454SAndrew Thompson uaa->info.idProduct = UGETW(udev->ddesc.idProduct); 127402ac6454SAndrew Thompson uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice); 127502ac6454SAndrew Thompson uaa->info.bDeviceClass = udev->ddesc.bDeviceClass; 127602ac6454SAndrew Thompson uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass; 127702ac6454SAndrew Thompson uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol; 127802ac6454SAndrew Thompson uaa->info.bConfigIndex = udev->curr_config_index; 127902ac6454SAndrew Thompson uaa->info.bConfigNum = udev->curr_config_no; 128002ac6454SAndrew Thompson } 128102ac6454SAndrew Thompson 128202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1283a593f6b8SAndrew Thompson * usb_probe_and_attach 128402ac6454SAndrew Thompson * 128502ac6454SAndrew Thompson * This function is called from "uhub_explore_sub()", 1286a593f6b8SAndrew Thompson * "usb_handle_set_config()" and "usb_handle_request()". 128702ac6454SAndrew Thompson * 128802ac6454SAndrew Thompson * Returns: 128902ac6454SAndrew Thompson * 0: Success 129002ac6454SAndrew Thompson * Else: A control transfer failed 129102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1292e0a69b51SAndrew Thompson usb_error_t 1293a593f6b8SAndrew Thompson usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index) 129402ac6454SAndrew Thompson { 1295760bc48eSAndrew Thompson struct usb_attach_arg uaa; 1296760bc48eSAndrew Thompson struct usb_interface *iface; 129702ac6454SAndrew Thompson uint8_t i; 129802ac6454SAndrew Thompson uint8_t j; 129902ac6454SAndrew Thompson uint8_t do_unlock; 130002ac6454SAndrew Thompson 130102ac6454SAndrew Thompson if (udev == NULL) { 130202ac6454SAndrew Thompson DPRINTF("udev == NULL\n"); 130302ac6454SAndrew Thompson return (USB_ERR_INVAL); 130402ac6454SAndrew Thompson } 13056950c75fSHans Petter Selasky /* Prevent re-enumeration */ 13066950c75fSHans Petter Selasky do_unlock = usbd_enum_lock(udev); 130702ac6454SAndrew Thompson 130802ac6454SAndrew Thompson if (udev->curr_config_index == USB_UNCONFIG_INDEX) { 130902ac6454SAndrew Thompson /* do nothing - no configuration has been set */ 131002ac6454SAndrew Thompson goto done; 131102ac6454SAndrew Thompson } 131202ac6454SAndrew Thompson /* setup USB attach arguments */ 131302ac6454SAndrew Thompson 1314a593f6b8SAndrew Thompson usb_init_attach_arg(udev, &uaa); 131502ac6454SAndrew Thompson 1316a6b60150SHans Petter Selasky /* 1317a6b60150SHans Petter Selasky * If the whole USB device is targeted, invoke the USB event 1318a6b60150SHans Petter Selasky * handler(s): 1319a6b60150SHans Petter Selasky */ 1320a6b60150SHans Petter Selasky if (iface_index == USB_IFACE_INDEX_ANY) { 1321a6b60150SHans Petter Selasky 1322a6b60150SHans Petter Selasky EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa); 1323a6b60150SHans Petter Selasky 1324a6b60150SHans Petter Selasky if (uaa.dev_state != UAA_DEV_READY) { 1325a6b60150SHans Petter Selasky /* leave device unconfigured */ 1326a6b60150SHans Petter Selasky usb_unconfigure(udev, 0); 1327a6b60150SHans Petter Selasky goto done; 1328a6b60150SHans Petter Selasky } 1329a6b60150SHans Petter Selasky } 1330a6b60150SHans Petter Selasky 133102ac6454SAndrew Thompson /* Check if only one interface should be probed: */ 133202ac6454SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 133302ac6454SAndrew Thompson i = iface_index; 133402ac6454SAndrew Thompson j = i + 1; 133502ac6454SAndrew Thompson } else { 133602ac6454SAndrew Thompson i = 0; 133702ac6454SAndrew Thompson j = USB_IFACE_MAX; 133802ac6454SAndrew Thompson } 133902ac6454SAndrew Thompson 134002ac6454SAndrew Thompson /* Do the probe and attach */ 134102ac6454SAndrew Thompson for (; i != j; i++) { 134202ac6454SAndrew Thompson 1343a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 134402ac6454SAndrew Thompson if (iface == NULL) { 134502ac6454SAndrew Thompson /* 134602ac6454SAndrew Thompson * Looks like the end of the USB 134702ac6454SAndrew Thompson * interfaces ! 134802ac6454SAndrew Thompson */ 134902ac6454SAndrew Thompson DPRINTFN(2, "end of interfaces " 135002ac6454SAndrew Thompson "at %u\n", i); 135102ac6454SAndrew Thompson break; 135202ac6454SAndrew Thompson } 135302ac6454SAndrew Thompson if (iface->idesc == NULL) { 135402ac6454SAndrew Thompson /* no interface descriptor */ 135502ac6454SAndrew Thompson continue; 135602ac6454SAndrew Thompson } 135702ac6454SAndrew Thompson uaa.iface = iface; 135802ac6454SAndrew Thompson 135902ac6454SAndrew Thompson uaa.info.bInterfaceClass = 136002ac6454SAndrew Thompson iface->idesc->bInterfaceClass; 136102ac6454SAndrew Thompson uaa.info.bInterfaceSubClass = 136202ac6454SAndrew Thompson iface->idesc->bInterfaceSubClass; 136302ac6454SAndrew Thompson uaa.info.bInterfaceProtocol = 136402ac6454SAndrew Thompson iface->idesc->bInterfaceProtocol; 136502ac6454SAndrew Thompson uaa.info.bIfaceIndex = i; 136602ac6454SAndrew Thompson uaa.info.bIfaceNum = 136702ac6454SAndrew Thompson iface->idesc->bInterfaceNumber; 1368bd73b187SAlfred Perlstein uaa.driver_info = 0; /* reset driver_info */ 136902ac6454SAndrew Thompson 137002ac6454SAndrew Thompson DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n", 137102ac6454SAndrew Thompson uaa.info.bInterfaceClass, 137202ac6454SAndrew Thompson uaa.info.bInterfaceSubClass, 137302ac6454SAndrew Thompson uaa.info.bInterfaceProtocol, 137402ac6454SAndrew Thompson uaa.info.bIfaceIndex, 137502ac6454SAndrew Thompson uaa.info.bIfaceNum); 137602ac6454SAndrew Thompson 1377d43ffe94SHans Petter Selasky usb_probe_and_attach_sub(udev, &uaa); 137802ac6454SAndrew Thompson 1379d43ffe94SHans Petter Selasky /* 1380d43ffe94SHans Petter Selasky * Remove the leftover child, if any, to enforce that 1381d43ffe94SHans Petter Selasky * a new nomatch devd event is generated for the next 1382d43ffe94SHans Petter Selasky * interface if no driver is found: 1383d43ffe94SHans Petter Selasky */ 1384d43ffe94SHans Petter Selasky if (uaa.temp_dev == NULL) 1385d43ffe94SHans Petter Selasky continue; 1386d43ffe94SHans Petter Selasky if (device_delete_child(udev->parent_dev, uaa.temp_dev)) 1387767cb2e2SAndrew Thompson DPRINTFN(0, "device delete child failed\n"); 1388d43ffe94SHans Petter Selasky uaa.temp_dev = NULL; 138902ac6454SAndrew Thompson } 139002ac6454SAndrew Thompson done: 1391cb18f7d1SAlfred Perlstein if (do_unlock) 1392cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 139302ac6454SAndrew Thompson return (0); 139402ac6454SAndrew Thompson } 139502ac6454SAndrew Thompson 139602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1397a593f6b8SAndrew Thompson * usb_suspend_resume_sub 139802ac6454SAndrew Thompson * 139902ac6454SAndrew Thompson * This function is called when the suspend or resume methods should 140002ac6454SAndrew Thompson * be executed on an USB device. 140102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 140202ac6454SAndrew Thompson static void 1403a593f6b8SAndrew Thompson usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend) 140402ac6454SAndrew Thompson { 140502ac6454SAndrew Thompson int err; 140602ac6454SAndrew Thompson 140702ac6454SAndrew Thompson if (dev == NULL) { 140802ac6454SAndrew Thompson return; 140902ac6454SAndrew Thompson } 141002ac6454SAndrew Thompson if (!device_is_attached(dev)) { 141102ac6454SAndrew Thompson return; 141202ac6454SAndrew Thompson } 141302ac6454SAndrew Thompson if (do_suspend) { 141402ac6454SAndrew Thompson err = DEVICE_SUSPEND(dev); 141502ac6454SAndrew Thompson } else { 141602ac6454SAndrew Thompson err = DEVICE_RESUME(dev); 141702ac6454SAndrew Thompson } 141802ac6454SAndrew Thompson if (err) { 1419767cb2e2SAndrew Thompson device_printf(dev, "%s failed\n", 142002ac6454SAndrew Thompson do_suspend ? "Suspend" : "Resume"); 142102ac6454SAndrew Thompson } 142202ac6454SAndrew Thompson } 142302ac6454SAndrew Thompson 142402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1425a593f6b8SAndrew Thompson * usb_suspend_resume 142602ac6454SAndrew Thompson * 142702ac6454SAndrew Thompson * The following function will suspend or resume the USB device. 142802ac6454SAndrew Thompson * 142902ac6454SAndrew Thompson * Returns: 143002ac6454SAndrew Thompson * 0: Success 143102ac6454SAndrew Thompson * Else: Failure 143202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1433e0a69b51SAndrew Thompson usb_error_t 1434a593f6b8SAndrew Thompson usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend) 143502ac6454SAndrew Thompson { 1436760bc48eSAndrew Thompson struct usb_interface *iface; 143702ac6454SAndrew Thompson uint8_t i; 143802ac6454SAndrew Thompson 143902ac6454SAndrew Thompson if (udev == NULL) { 144002ac6454SAndrew Thompson /* nothing to do */ 144102ac6454SAndrew Thompson return (0); 144202ac6454SAndrew Thompson } 144302ac6454SAndrew Thompson DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend); 144402ac6454SAndrew Thompson 14452df1e9a6SAndrew Thompson sx_assert(&udev->sr_sx, SA_LOCKED); 144602ac6454SAndrew Thompson 144702ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 144802ac6454SAndrew Thompson /* filter the suspend events */ 1449ec8f3127SAndrew Thompson if (udev->flags.peer_suspended == do_suspend) { 145002ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 145102ac6454SAndrew Thompson /* nothing to do */ 145202ac6454SAndrew Thompson return (0); 145302ac6454SAndrew Thompson } 1454ec8f3127SAndrew Thompson udev->flags.peer_suspended = do_suspend; 145502ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 145602ac6454SAndrew Thompson 145702ac6454SAndrew Thompson /* do the suspend or resume */ 145802ac6454SAndrew Thompson 145902ac6454SAndrew Thompson for (i = 0; i != USB_IFACE_MAX; i++) { 146002ac6454SAndrew Thompson 1461a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 146202ac6454SAndrew Thompson if (iface == NULL) { 146302ac6454SAndrew Thompson /* looks like the end of the USB interfaces */ 146402ac6454SAndrew Thompson break; 146502ac6454SAndrew Thompson } 1466a593f6b8SAndrew Thompson usb_suspend_resume_sub(udev, iface->subdev, do_suspend); 146702ac6454SAndrew Thompson } 146802ac6454SAndrew Thompson return (0); 146902ac6454SAndrew Thompson } 147002ac6454SAndrew Thompson 147102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1472a593f6b8SAndrew Thompson * usbd_clear_stall_proc 147302ac6454SAndrew Thompson * 147402ac6454SAndrew Thompson * This function performs generic USB clear stall operations. 147502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 147602ac6454SAndrew Thompson static void 1477a593f6b8SAndrew Thompson usbd_clear_stall_proc(struct usb_proc_msg *_pm) 147802ac6454SAndrew Thompson { 1479760bc48eSAndrew Thompson struct usb_clear_stall_msg *pm = (void *)_pm; 1480760bc48eSAndrew Thompson struct usb_device *udev = pm->udev; 148102ac6454SAndrew Thompson 148202ac6454SAndrew Thompson /* Change lock */ 148302ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 148491cd9240SAndrew Thompson mtx_lock(&udev->device_mtx); 148502ac6454SAndrew Thompson 148602ac6454SAndrew Thompson /* Start clear stall callback */ 14875b3bb704SAndrew Thompson usbd_transfer_start(udev->ctrl_xfer[1]); 148802ac6454SAndrew Thompson 148902ac6454SAndrew Thompson /* Change lock */ 149091cd9240SAndrew Thompson mtx_unlock(&udev->device_mtx); 149102ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 149202ac6454SAndrew Thompson } 149302ac6454SAndrew Thompson 149402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1495a593f6b8SAndrew Thompson * usb_alloc_device 149602ac6454SAndrew Thompson * 149702ac6454SAndrew Thompson * This function allocates a new USB device. This function is called 149802ac6454SAndrew Thompson * when a new device has been put in the powered state, but not yet in 149902ac6454SAndrew Thompson * the addressed state. Get initial descriptor, set the address, get 150002ac6454SAndrew Thompson * full descriptor and get strings. 150102ac6454SAndrew Thompson * 150202ac6454SAndrew Thompson * Return values: 150302ac6454SAndrew Thompson * 0: Failure 150402ac6454SAndrew Thompson * Else: Success 150502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1506760bc48eSAndrew Thompson struct usb_device * 1507a593f6b8SAndrew Thompson usb_alloc_device(device_t parent_dev, struct usb_bus *bus, 1508760bc48eSAndrew Thompson struct usb_device *parent_hub, uint8_t depth, uint8_t port_index, 15098d2dd5ddSAndrew Thompson uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode) 151002ac6454SAndrew Thompson { 1511760bc48eSAndrew Thompson struct usb_attach_arg uaa; 1512760bc48eSAndrew Thompson struct usb_device *udev; 1513760bc48eSAndrew Thompson struct usb_device *adev; 1514760bc48eSAndrew Thompson struct usb_device *hub; 151502ac6454SAndrew Thompson uint8_t *scratch_ptr; 1516e0a69b51SAndrew Thompson usb_error_t err; 151702ac6454SAndrew Thompson uint8_t device_index; 15182a4c6157SAndrew Thompson uint8_t config_index; 15192a4c6157SAndrew Thompson uint8_t config_quirk; 15202a4c6157SAndrew Thompson uint8_t set_config_failed; 15216950c75fSHans Petter Selasky uint8_t do_unlock; 152202ac6454SAndrew Thompson 152302ac6454SAndrew Thompson DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, " 1524f29a0724SAndrew Thompson "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n", 152502ac6454SAndrew Thompson parent_dev, bus, parent_hub, depth, port_index, port_no, 1526f29a0724SAndrew Thompson speed, mode); 152702ac6454SAndrew Thompson 152802ac6454SAndrew Thompson /* 152902ac6454SAndrew Thompson * Find an unused device index. In USB Host mode this is the 153002ac6454SAndrew Thompson * same as the device address. 153102ac6454SAndrew Thompson * 153202ac6454SAndrew Thompson * Device index zero is not used and device index 1 should 153302ac6454SAndrew Thompson * always be the root hub. 153402ac6454SAndrew Thompson */ 153502ac6454SAndrew Thompson for (device_index = USB_ROOT_HUB_ADDR; 153602ac6454SAndrew Thompson (device_index != bus->devices_max) && 153702ac6454SAndrew Thompson (bus->devices[device_index] != NULL); 153802ac6454SAndrew Thompson device_index++) /* nop */; 153902ac6454SAndrew Thompson 154002ac6454SAndrew Thompson if (device_index == bus->devices_max) { 154102ac6454SAndrew Thompson device_printf(bus->bdev, 1542767cb2e2SAndrew Thompson "No free USB device index for new device\n"); 154302ac6454SAndrew Thompson return (NULL); 154402ac6454SAndrew Thompson } 154502ac6454SAndrew Thompson 154602ac6454SAndrew Thompson if (depth > 0x10) { 154702ac6454SAndrew Thompson device_printf(bus->bdev, 1548767cb2e2SAndrew Thompson "Invalid device depth\n"); 154902ac6454SAndrew Thompson return (NULL); 155002ac6454SAndrew Thompson } 155102ac6454SAndrew Thompson udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO); 155202ac6454SAndrew Thompson if (udev == NULL) { 155302ac6454SAndrew Thompson return (NULL); 155402ac6454SAndrew Thompson } 155502ac6454SAndrew Thompson /* initialise our SX-lock */ 155691cd9240SAndrew Thompson sx_init_flags(&udev->enum_sx, "USB config SX lock", SX_DUPOK); 1557a6b60150SHans Petter Selasky sx_init_flags(&udev->sr_sx, "USB suspend and resume SX lock", SX_NOWITNESS); 155802ac6454SAndrew Thompson 155991cd9240SAndrew Thompson cv_init(&udev->ctrlreq_cv, "WCTRL"); 156091cd9240SAndrew Thompson cv_init(&udev->ref_cv, "UGONE"); 156102ac6454SAndrew Thompson 156202ac6454SAndrew Thompson /* initialise our mutex */ 156391cd9240SAndrew Thompson mtx_init(&udev->device_mtx, "USB device mutex", NULL, MTX_DEF); 156402ac6454SAndrew Thompson 156502ac6454SAndrew Thompson /* initialise generic clear stall */ 1566a593f6b8SAndrew Thompson udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc; 156702ac6454SAndrew Thompson udev->cs_msg[0].udev = udev; 1568a593f6b8SAndrew Thompson udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc; 156902ac6454SAndrew Thompson udev->cs_msg[1].udev = udev; 157002ac6454SAndrew Thompson 157102ac6454SAndrew Thompson /* initialise some USB device fields */ 157202ac6454SAndrew Thompson udev->parent_hub = parent_hub; 157302ac6454SAndrew Thompson udev->parent_dev = parent_dev; 157402ac6454SAndrew Thompson udev->port_index = port_index; 157502ac6454SAndrew Thompson udev->port_no = port_no; 157602ac6454SAndrew Thompson udev->depth = depth; 157702ac6454SAndrew Thompson udev->bus = bus; 157802ac6454SAndrew Thompson udev->address = USB_START_ADDR; /* default value */ 1579e0a69b51SAndrew Thompson udev->plugtime = (usb_ticks_t)ticks; 158002ac6454SAndrew Thompson /* 158102ac6454SAndrew Thompson * We need to force the power mode to "on" because there are plenty 158202ac6454SAndrew Thompson * of USB devices out there that do not work very well with 158302ac6454SAndrew Thompson * automatic suspend and resume! 158402ac6454SAndrew Thompson */ 1585d2d71ce7SAndrew Thompson udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON); 158602ac6454SAndrew Thompson udev->pwr_save.last_xfer_time = ticks; 158702ac6454SAndrew Thompson /* we are not ready yet */ 158802ac6454SAndrew Thompson udev->refcount = 1; 158902ac6454SAndrew Thompson 159002ac6454SAndrew Thompson /* set up default endpoint descriptor */ 15915b3bb704SAndrew Thompson udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc); 15925b3bb704SAndrew Thompson udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT; 15935b3bb704SAndrew Thompson udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT; 15945b3bb704SAndrew Thompson udev->ctrl_ep_desc.bmAttributes = UE_CONTROL; 15955b3bb704SAndrew Thompson udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET; 15965b3bb704SAndrew Thompson udev->ctrl_ep_desc.wMaxPacketSize[1] = 0; 15975b3bb704SAndrew Thompson udev->ctrl_ep_desc.bInterval = 0; 1598963169b4SHans Petter Selasky 1599963169b4SHans Petter Selasky /* set up default endpoint companion descriptor */ 1600963169b4SHans Petter Selasky udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc); 1601963169b4SHans Petter Selasky udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP; 1602963169b4SHans Petter Selasky 160302ac6454SAndrew Thompson udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET; 160402ac6454SAndrew Thompson 160502ac6454SAndrew Thompson udev->speed = speed; 1606f29a0724SAndrew Thompson udev->flags.usb_mode = mode; 160702ac6454SAndrew Thompson 160802ac6454SAndrew Thompson /* search for our High Speed USB HUB, if any */ 160902ac6454SAndrew Thompson 161002ac6454SAndrew Thompson adev = udev; 161102ac6454SAndrew Thompson hub = udev->parent_hub; 161202ac6454SAndrew Thompson 161302ac6454SAndrew Thompson while (hub) { 161402ac6454SAndrew Thompson if (hub->speed == USB_SPEED_HIGH) { 161502ac6454SAndrew Thompson udev->hs_hub_addr = hub->address; 1616495f25ceSAndrew Thompson udev->parent_hs_hub = hub; 161702ac6454SAndrew Thompson udev->hs_port_no = adev->port_no; 161802ac6454SAndrew Thompson break; 161902ac6454SAndrew Thompson } 162002ac6454SAndrew Thompson adev = hub; 162102ac6454SAndrew Thompson hub = hub->parent_hub; 162202ac6454SAndrew Thompson } 162302ac6454SAndrew Thompson 1624ae60fdfbSAndrew Thompson /* init the default endpoint */ 1625a593f6b8SAndrew Thompson usb_init_endpoint(udev, 0, 16265b3bb704SAndrew Thompson &udev->ctrl_ep_desc, 1627963169b4SHans Petter Selasky &udev->ctrl_ep_comp_desc, 16285b3bb704SAndrew Thompson &udev->ctrl_ep); 162902ac6454SAndrew Thompson 163002ac6454SAndrew Thompson /* set device index */ 163102ac6454SAndrew Thompson udev->device_index = device_index; 163202ac6454SAndrew Thompson 16338755859aSAndrew Thompson #if USB_HAVE_UGEN 16340f6e8f93SAndrew Thompson /* Create ugen name */ 1635ee3e3ff5SAndrew Thompson snprintf(udev->ugen_name, sizeof(udev->ugen_name), 1636ee3e3ff5SAndrew Thompson USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev), 1637ee3e3ff5SAndrew Thompson device_index); 16388755859aSAndrew Thompson LIST_INIT(&udev->pd_list); 16398755859aSAndrew Thompson 16400f6e8f93SAndrew Thompson /* Create the control endpoint device */ 16412ffd5fdcSHans Petter Selasky udev->ctrl_dev = usb_make_dev(udev, NULL, 0, 0, 16422ffd5fdcSHans Petter Selasky FREAD|FWRITE, UID_ROOT, GID_OPERATOR, 0600); 16430f6e8f93SAndrew Thompson 16440f6e8f93SAndrew Thompson /* Create a link from /dev/ugenX.X to the default endpoint */ 16452ffd5fdcSHans Petter Selasky if (udev->ctrl_dev != NULL) 16462ffd5fdcSHans Petter Selasky make_dev_alias(udev->ctrl_dev->cdev, "%s", udev->ugen_name); 16470f6e8f93SAndrew Thompson #endif 1648963169b4SHans Petter Selasky /* Initialise device */ 1649963169b4SHans Petter Selasky if (bus->methods->device_init != NULL) { 1650963169b4SHans Petter Selasky err = (bus->methods->device_init) (udev); 1651963169b4SHans Petter Selasky if (err != 0) { 1652963169b4SHans Petter Selasky DPRINTFN(0, "device init %d failed " 1653963169b4SHans Petter Selasky "(%s, ignored)\n", device_index, 1654963169b4SHans Petter Selasky usbd_errstr(err)); 1655963169b4SHans Petter Selasky goto done; 1656963169b4SHans Petter Selasky } 1657963169b4SHans Petter Selasky } 1658963169b4SHans Petter Selasky /* set powered device state after device init is complete */ 1659963169b4SHans Petter Selasky usb_set_device_state(udev, USB_STATE_POWERED); 1660963169b4SHans Petter Selasky 1661f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_HOST) { 166202ac6454SAndrew Thompson 1663a593f6b8SAndrew Thompson err = usbd_req_set_address(udev, NULL, device_index); 166402ac6454SAndrew Thompson 1665963169b4SHans Petter Selasky /* 1666963169b4SHans Petter Selasky * This is the new USB device address from now on, if 1667963169b4SHans Petter Selasky * the set address request didn't set it already. 1668963169b4SHans Petter Selasky */ 1669963169b4SHans Petter Selasky if (udev->address == USB_START_ADDR) 167002ac6454SAndrew Thompson udev->address = device_index; 167102ac6454SAndrew Thompson 167202ac6454SAndrew Thompson /* 167302ac6454SAndrew Thompson * We ignore any set-address errors, hence there are 167402ac6454SAndrew Thompson * buggy USB devices out there that actually receive 167502ac6454SAndrew Thompson * the SETUP PID, but manage to set the address before 167602ac6454SAndrew Thompson * the STATUS stage is ACK'ed. If the device responds 167702ac6454SAndrew Thompson * to the subsequent get-descriptor at the new 167802ac6454SAndrew Thompson * address, then we know that the set-address command 167902ac6454SAndrew Thompson * was successful. 168002ac6454SAndrew Thompson */ 168102ac6454SAndrew Thompson if (err) { 168202ac6454SAndrew Thompson DPRINTFN(0, "set address %d failed " 168303797f33SAndrew Thompson "(%s, ignored)\n", udev->address, 1684a593f6b8SAndrew Thompson usbd_errstr(err)); 168502ac6454SAndrew Thompson } 168602ac6454SAndrew Thompson } else { 168702ac6454SAndrew Thompson /* We are not self powered */ 168802ac6454SAndrew Thompson udev->flags.self_powered = 0; 168902ac6454SAndrew Thompson 169002ac6454SAndrew Thompson /* Set unconfigured state */ 169102ac6454SAndrew Thompson udev->curr_config_no = USB_UNCONFIG_NO; 169202ac6454SAndrew Thompson udev->curr_config_index = USB_UNCONFIG_INDEX; 169302ac6454SAndrew Thompson 169402ac6454SAndrew Thompson /* Setup USB descriptors */ 1695a593f6b8SAndrew Thompson err = (usb_temp_setup_by_index_p) (udev, usb_template); 169602ac6454SAndrew Thompson if (err) { 169702ac6454SAndrew Thompson DPRINTFN(0, "setting up USB template failed maybe the USB " 169802ac6454SAndrew Thompson "template module has not been loaded\n"); 169902ac6454SAndrew Thompson goto done; 170002ac6454SAndrew Thompson } 170102ac6454SAndrew Thompson } 1702a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_ADDRESSED); 170302ac6454SAndrew Thompson 1704963169b4SHans Petter Selasky /* setup the device descriptor and the initial "wMaxPacketSize" */ 1705963169b4SHans Petter Selasky err = usbd_setup_device_desc(udev, NULL); 1706963169b4SHans Petter Selasky 1707963169b4SHans Petter Selasky if (err != 0) { 170823de050bSHans Petter Selasky /* try to enumerate two more times */ 1709a593f6b8SAndrew Thompson err = usbd_req_re_enumerate(udev, NULL); 171023de050bSHans Petter Selasky if (err != 0) { 171123de050bSHans Petter Selasky err = usbd_req_re_enumerate(udev, NULL); 171223de050bSHans Petter Selasky if (err != 0) { 171302ac6454SAndrew Thompson goto done; 171402ac6454SAndrew Thompson } 171523de050bSHans Petter Selasky } 171623de050bSHans Petter Selasky } 171702ac6454SAndrew Thompson 171802ac6454SAndrew Thompson /* 171902ac6454SAndrew Thompson * Setup temporary USB attach args so that we can figure out some 172002ac6454SAndrew Thompson * basic quirks for this device. 172102ac6454SAndrew Thompson */ 1722a593f6b8SAndrew Thompson usb_init_attach_arg(udev, &uaa); 172302ac6454SAndrew Thompson 1724a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) { 172502ac6454SAndrew Thompson udev->flags.uq_bus_powered = 1; 172602ac6454SAndrew Thompson } 1727a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) { 172802ac6454SAndrew Thompson udev->flags.no_strings = 1; 172902ac6454SAndrew Thompson } 173002ac6454SAndrew Thompson /* 173102ac6454SAndrew Thompson * Workaround for buggy USB devices. 173202ac6454SAndrew Thompson * 173302ac6454SAndrew Thompson * It appears that some string-less USB chips will crash and 173402ac6454SAndrew Thompson * disappear if any attempts are made to read any string 173502ac6454SAndrew Thompson * descriptors. 173602ac6454SAndrew Thompson * 173702ac6454SAndrew Thompson * Try to detect such chips by checking the strings in the USB 173802ac6454SAndrew Thompson * device descriptor. If no strings are present there we 173902ac6454SAndrew Thompson * simply disable all USB strings. 174002ac6454SAndrew Thompson */ 17416950c75fSHans Petter Selasky 17426950c75fSHans Petter Selasky /* Protect scratch area */ 17436950c75fSHans Petter Selasky do_unlock = usbd_enum_lock(udev); 17446950c75fSHans Petter Selasky 17456950c75fSHans Petter Selasky scratch_ptr = udev->scratch.data; 174602ac6454SAndrew Thompson 174702ac6454SAndrew Thompson if (udev->ddesc.iManufacturer || 174802ac6454SAndrew Thompson udev->ddesc.iProduct || 174902ac6454SAndrew Thompson udev->ddesc.iSerialNumber) { 175002ac6454SAndrew Thompson /* read out the language ID string */ 1751a593f6b8SAndrew Thompson err = usbd_req_get_string_desc(udev, NULL, 1752c10e1453SAndrew Thompson (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE); 175302ac6454SAndrew Thompson } else { 175402ac6454SAndrew Thompson err = USB_ERR_INVAL; 175502ac6454SAndrew Thompson } 175602ac6454SAndrew Thompson 175702ac6454SAndrew Thompson if (err || (scratch_ptr[0] < 4)) { 175802ac6454SAndrew Thompson udev->flags.no_strings = 1; 175902ac6454SAndrew Thompson } else { 17607a918edfSAndrew Thompson uint16_t langid; 17617a918edfSAndrew Thompson uint16_t pref; 17627a918edfSAndrew Thompson uint16_t mask; 17637a918edfSAndrew Thompson uint8_t x; 17647a918edfSAndrew Thompson 17657a918edfSAndrew Thompson /* load preferred value and mask */ 17667a918edfSAndrew Thompson pref = usb_lang_id; 17677a918edfSAndrew Thompson mask = usb_lang_mask; 17687a918edfSAndrew Thompson 17697a918edfSAndrew Thompson /* align length correctly */ 17706950c75fSHans Petter Selasky scratch_ptr[0] &= ~1U; 17717a918edfSAndrew Thompson 17727a918edfSAndrew Thompson /* fix compiler warning */ 17737a918edfSAndrew Thompson langid = 0; 17747a918edfSAndrew Thompson 17757a918edfSAndrew Thompson /* search for preferred language */ 17767a918edfSAndrew Thompson for (x = 2; (x < scratch_ptr[0]); x += 2) { 17777a918edfSAndrew Thompson langid = UGETW(scratch_ptr + x); 17787a918edfSAndrew Thompson if ((langid & mask) == pref) 17797a918edfSAndrew Thompson break; 17807a918edfSAndrew Thompson } 17817a918edfSAndrew Thompson if (x >= scratch_ptr[0]) { 178202ac6454SAndrew Thompson /* pick the first language as the default */ 17837a918edfSAndrew Thompson DPRINTFN(1, "Using first language\n"); 17847a918edfSAndrew Thompson langid = UGETW(scratch_ptr + 2); 17857a918edfSAndrew Thompson } 17867a918edfSAndrew Thompson 17877a918edfSAndrew Thompson DPRINTFN(1, "Language selected: 0x%04x\n", langid); 17887a918edfSAndrew Thompson udev->langid = langid; 178902ac6454SAndrew Thompson } 179002ac6454SAndrew Thompson 17916950c75fSHans Petter Selasky if (do_unlock) 17926950c75fSHans Petter Selasky usbd_enum_unlock(udev); 17936950c75fSHans Petter Selasky 179402ac6454SAndrew Thompson /* assume 100mA bus powered for now. Changed when configured. */ 179502ac6454SAndrew Thompson udev->power = USB_MIN_POWER; 1796c86aead6SAndrew Thompson /* fetch the vendor and product strings from the device */ 1797a593f6b8SAndrew Thompson usbd_set_device_strings(udev); 179802ac6454SAndrew Thompson 17992a4c6157SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 18002a4c6157SAndrew Thompson /* USB device mode setup is complete */ 18012a4c6157SAndrew Thompson err = 0; 18022a4c6157SAndrew Thompson goto config_done; 18032a4c6157SAndrew Thompson } 180402ac6454SAndrew Thompson 180502ac6454SAndrew Thompson /* 180602ac6454SAndrew Thompson * Most USB devices should attach to config index 0 by 180702ac6454SAndrew Thompson * default 180802ac6454SAndrew Thompson */ 1809a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) { 181002ac6454SAndrew Thompson config_index = 0; 181102ac6454SAndrew Thompson config_quirk = 1; 1812a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) { 181302ac6454SAndrew Thompson config_index = 1; 181402ac6454SAndrew Thompson config_quirk = 1; 1815a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) { 181602ac6454SAndrew Thompson config_index = 2; 181702ac6454SAndrew Thompson config_quirk = 1; 1818a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) { 181902ac6454SAndrew Thompson config_index = 3; 182002ac6454SAndrew Thompson config_quirk = 1; 1821a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) { 182202ac6454SAndrew Thompson config_index = 4; 182302ac6454SAndrew Thompson config_quirk = 1; 182402ac6454SAndrew Thompson } else { 182502ac6454SAndrew Thompson config_index = 0; 182602ac6454SAndrew Thompson config_quirk = 0; 182702ac6454SAndrew Thompson } 182802ac6454SAndrew Thompson 18292a4c6157SAndrew Thompson set_config_failed = 0; 183002ac6454SAndrew Thompson repeat_set_config: 183102ac6454SAndrew Thompson 183202ac6454SAndrew Thompson DPRINTF("setting config %u\n", config_index); 183302ac6454SAndrew Thompson 183402ac6454SAndrew Thompson /* get the USB device configured */ 1835a593f6b8SAndrew Thompson err = usbd_set_config_index(udev, config_index); 183602ac6454SAndrew Thompson if (err) { 183702ac6454SAndrew Thompson if (udev->ddesc.bNumConfigurations != 0) { 183802ac6454SAndrew Thompson if (!set_config_failed) { 183902ac6454SAndrew Thompson set_config_failed = 1; 184002ac6454SAndrew Thompson /* XXX try to re-enumerate the device */ 18412a4c6157SAndrew Thompson err = usbd_req_re_enumerate(udev, NULL); 184202ac6454SAndrew Thompson if (err == 0) 184302ac6454SAndrew Thompson goto repeat_set_config; 184402ac6454SAndrew Thompson } 18452a4c6157SAndrew Thompson DPRINTFN(0, "Failure selecting configuration index %u:" 18462a4c6157SAndrew Thompson "%s, port %u, addr %u (ignored)\n", 1847a593f6b8SAndrew Thompson config_index, usbd_errstr(err), udev->port_no, 184802ac6454SAndrew Thompson udev->address); 184902ac6454SAndrew Thompson } 185002ac6454SAndrew Thompson /* 18512a4c6157SAndrew Thompson * Some USB devices do not have any configurations. Ignore any 18522a4c6157SAndrew Thompson * set config failures! 185302ac6454SAndrew Thompson */ 185402ac6454SAndrew Thompson err = 0; 18552a4c6157SAndrew Thompson goto config_done; 18562a4c6157SAndrew Thompson } 18572a4c6157SAndrew Thompson if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) { 185802ac6454SAndrew Thompson if ((udev->cdesc->bNumInterface < 2) && 18592a4c6157SAndrew Thompson usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) { 18602a4c6157SAndrew Thompson DPRINTFN(0, "Found no endpoints, trying next config\n"); 186102ac6454SAndrew Thompson config_index++; 186202ac6454SAndrew Thompson goto repeat_set_config; 186302ac6454SAndrew Thompson } 186415d4edd3SHans Petter Selasky #if USB_HAVE_MSCTEST 186502ac6454SAndrew Thompson if (config_index == 0) { 186602ac6454SAndrew Thompson /* 186702ac6454SAndrew Thompson * Try to figure out if we have an 186802ac6454SAndrew Thompson * auto-install disk there: 186902ac6454SAndrew Thompson */ 1870d84a79e7SAndrew Thompson if (usb_iface_is_cdrom(udev, 0)) { 187102ac6454SAndrew Thompson DPRINTFN(0, "Found possible auto-install " 187202ac6454SAndrew Thompson "disk (trying next config)\n"); 187302ac6454SAndrew Thompson config_index++; 187402ac6454SAndrew Thompson goto repeat_set_config; 187502ac6454SAndrew Thompson } 187602ac6454SAndrew Thompson } 187715d4edd3SHans Petter Selasky #endif 18782a4c6157SAndrew Thompson } 187915d4edd3SHans Petter Selasky #if USB_HAVE_MSCTEST 1880d46dc4adSHans Petter Selasky if (set_config_failed == 0 && config_index == 0 && 18819157ad4bSHans Petter Selasky usb_test_quirk(&uaa, UQ_MSC_NO_SYNC_CACHE) == 0 && 18829157ad4bSHans Petter Selasky usb_test_quirk(&uaa, UQ_MSC_NO_GETMAXLUN) == 0) { 1883d46dc4adSHans Petter Selasky 1884d46dc4adSHans Petter Selasky /* 1885d46dc4adSHans Petter Selasky * Try to figure out if there are any MSC quirks we 1886d46dc4adSHans Petter Selasky * should apply automatically: 1887d46dc4adSHans Petter Selasky */ 1888d46dc4adSHans Petter Selasky err = usb_msc_auto_quirk(udev, 0); 1889d46dc4adSHans Petter Selasky 1890d46dc4adSHans Petter Selasky if (err != 0) { 1891d46dc4adSHans Petter Selasky set_config_failed = 1; 1892d46dc4adSHans Petter Selasky goto repeat_set_config; 1893d46dc4adSHans Petter Selasky } 1894d46dc4adSHans Petter Selasky } 189515d4edd3SHans Petter Selasky #endif 189602ac6454SAndrew Thompson 18972a4c6157SAndrew Thompson config_done: 189802ac6454SAndrew Thompson DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n", 189902ac6454SAndrew Thompson udev->address, udev, udev->parent_hub); 190002ac6454SAndrew Thompson 190102ac6454SAndrew Thompson /* register our device - we are ready */ 1902a593f6b8SAndrew Thompson usb_bus_port_set_device(bus, parent_hub ? 190302ac6454SAndrew Thompson parent_hub->hub->ports + port_index : NULL, udev, device_index); 190402ac6454SAndrew Thompson 19050f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 19068755859aSAndrew Thompson /* Symlink the ugen device name */ 1907a593f6b8SAndrew Thompson udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name); 19088755859aSAndrew Thompson 19098755859aSAndrew Thompson /* Announce device */ 1910ae538d85SAndrew Thompson printf("%s: <%s> at %s\n", udev->ugen_name, 1911ae538d85SAndrew Thompson usb_get_manufacturer(udev), 191202ac6454SAndrew Thompson device_get_nameunit(udev->bus->bdev)); 19138bb77249SHans Petter Selasky #endif 19147efaaa9aSAndrew Thompson 19158bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 19163acd904dSAndrew Thompson usb_notify_addq("ATTACH", udev); 19178755859aSAndrew Thompson #endif 191802ac6454SAndrew Thompson done: 191902ac6454SAndrew Thompson if (err) { 1920d88688c7SAndrew Thompson /* 1921d88688c7SAndrew Thompson * Free USB device and all subdevices, if any. 1922d88688c7SAndrew Thompson */ 1923d88688c7SAndrew Thompson usb_free_device(udev, 0); 192402ac6454SAndrew Thompson udev = NULL; 192502ac6454SAndrew Thompson } 192602ac6454SAndrew Thompson return (udev); 192702ac6454SAndrew Thompson } 192802ac6454SAndrew Thompson 19290f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 19302ffd5fdcSHans Petter Selasky struct usb_fs_privdata * 19312ffd5fdcSHans Petter Selasky usb_make_dev(struct usb_device *udev, const char *devname, int ep, 19322ffd5fdcSHans Petter Selasky int fi, int rwmode, uid_t uid, gid_t gid, int mode) 1933ee3e3ff5SAndrew Thompson { 1934760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 19352ffd5fdcSHans Petter Selasky char buffer[32]; 1936ee3e3ff5SAndrew Thompson 1937ee3e3ff5SAndrew Thompson /* Store information to locate ourselves again later */ 1938760bc48eSAndrew Thompson pd = malloc(sizeof(struct usb_fs_privdata), M_USBDEV, 1939ee3e3ff5SAndrew Thompson M_WAITOK | M_ZERO); 1940ee3e3ff5SAndrew Thompson pd->bus_index = device_get_unit(udev->bus->bdev); 1941ee3e3ff5SAndrew Thompson pd->dev_index = udev->device_index; 1942ee3e3ff5SAndrew Thompson pd->ep_addr = ep; 19432ffd5fdcSHans Petter Selasky pd->fifo_index = fi; 19442ffd5fdcSHans Petter Selasky pd->mode = rwmode; 1945ee3e3ff5SAndrew Thompson 1946ee3e3ff5SAndrew Thompson /* Now, create the device itself */ 19472ffd5fdcSHans Petter Selasky if (devname == NULL) { 19482ffd5fdcSHans Petter Selasky devname = buffer; 19492ffd5fdcSHans Petter Selasky snprintf(buffer, sizeof(buffer), USB_DEVICE_DIR "/%u.%u.%u", 1950f35aaff0SAndrew Thompson pd->bus_index, pd->dev_index, pd->ep_addr); 19512ffd5fdcSHans Petter Selasky } 19522ffd5fdcSHans Petter Selasky 19532ffd5fdcSHans Petter Selasky pd->cdev = make_dev(&usb_devsw, 0, uid, gid, mode, "%s", devname); 19542ffd5fdcSHans Petter Selasky 19552ffd5fdcSHans Petter Selasky if (pd->cdev == NULL) { 19562ffd5fdcSHans Petter Selasky DPRINTFN(0, "Failed to create device %s\n", devname); 19572ffd5fdcSHans Petter Selasky free(pd, M_USBDEV); 19582ffd5fdcSHans Petter Selasky return (NULL); 19592ffd5fdcSHans Petter Selasky } 19602ffd5fdcSHans Petter Selasky 19612ffd5fdcSHans Petter Selasky /* XXX setting si_drv1 and creating the device is not atomic! */ 1962ee3e3ff5SAndrew Thompson pd->cdev->si_drv1 = pd; 1963ee3e3ff5SAndrew Thompson 19642ffd5fdcSHans Petter Selasky return (pd); 19652ffd5fdcSHans Petter Selasky } 19662ffd5fdcSHans Petter Selasky 19672ffd5fdcSHans Petter Selasky void 19682ffd5fdcSHans Petter Selasky usb_destroy_dev(struct usb_fs_privdata *pd) 19692ffd5fdcSHans Petter Selasky { 19702ffd5fdcSHans Petter Selasky if (pd == NULL) 19712ffd5fdcSHans Petter Selasky return; 19722ffd5fdcSHans Petter Selasky 19732ffd5fdcSHans Petter Selasky destroy_dev(pd->cdev); 19742ffd5fdcSHans Petter Selasky 19752ffd5fdcSHans Petter Selasky free(pd, M_USBDEV); 1976ee3e3ff5SAndrew Thompson } 1977ee3e3ff5SAndrew Thompson 1978ee3e3ff5SAndrew Thompson static void 1979a593f6b8SAndrew Thompson usb_cdev_create(struct usb_device *udev) 1980ee3e3ff5SAndrew Thompson { 1981760bc48eSAndrew Thompson struct usb_config_descriptor *cd; 1982760bc48eSAndrew Thompson struct usb_endpoint_descriptor *ed; 1983760bc48eSAndrew Thompson struct usb_descriptor *desc; 1984760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 1985f5f145baSAndrew Thompson int inmode, outmode, inmask, outmask, mode; 1986f5f145baSAndrew Thompson uint8_t ep; 1987ee3e3ff5SAndrew Thompson 1988ee3e3ff5SAndrew Thompson KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries")); 1989ee3e3ff5SAndrew Thompson 1990ee3e3ff5SAndrew Thompson DPRINTFN(2, "Creating device nodes\n"); 1991ee3e3ff5SAndrew Thompson 1992a593f6b8SAndrew Thompson if (usbd_get_mode(udev) == USB_MODE_DEVICE) { 1993ee3e3ff5SAndrew Thompson inmode = FWRITE; 1994ee3e3ff5SAndrew Thompson outmode = FREAD; 1995ee3e3ff5SAndrew Thompson } else { /* USB_MODE_HOST */ 1996ee3e3ff5SAndrew Thompson inmode = FREAD; 1997ee3e3ff5SAndrew Thompson outmode = FWRITE; 1998ee3e3ff5SAndrew Thompson } 1999ee3e3ff5SAndrew Thompson 2000f5f145baSAndrew Thompson inmask = 0; 2001f5f145baSAndrew Thompson outmask = 0; 2002f5f145baSAndrew Thompson desc = NULL; 2003f5f145baSAndrew Thompson 2004f5f145baSAndrew Thompson /* 2005f5f145baSAndrew Thompson * Collect all used endpoint numbers instead of just 2006f5f145baSAndrew Thompson * generating 16 static endpoints. 2007f5f145baSAndrew Thompson */ 2008a593f6b8SAndrew Thompson cd = usbd_get_config_descriptor(udev); 2009a593f6b8SAndrew Thompson while ((desc = usb_desc_foreach(cd, desc))) { 2010f5f145baSAndrew Thompson /* filter out all endpoint descriptors */ 2011f5f145baSAndrew Thompson if ((desc->bDescriptorType == UDESC_ENDPOINT) && 2012f5f145baSAndrew Thompson (desc->bLength >= sizeof(*ed))) { 2013760bc48eSAndrew Thompson ed = (struct usb_endpoint_descriptor *)desc; 2014f5f145baSAndrew Thompson 2015f5f145baSAndrew Thompson /* update masks */ 2016f5f145baSAndrew Thompson ep = ed->bEndpointAddress; 2017f5f145baSAndrew Thompson if (UE_GET_DIR(ep) == UE_DIR_OUT) 2018f5f145baSAndrew Thompson outmask |= 1 << UE_GET_ADDR(ep); 2019f5f145baSAndrew Thompson else 2020f5f145baSAndrew Thompson inmask |= 1 << UE_GET_ADDR(ep); 2021f5f145baSAndrew Thompson } 2022f5f145baSAndrew Thompson } 2023ee3e3ff5SAndrew Thompson 2024ee3e3ff5SAndrew Thompson /* Create all available endpoints except EP0 */ 2025ee3e3ff5SAndrew Thompson for (ep = 1; ep < 16; ep++) { 20262ffd5fdcSHans Petter Selasky mode = (inmask & (1 << ep)) ? inmode : 0; 20272ffd5fdcSHans Petter Selasky mode |= (outmask & (1 << ep)) ? outmode : 0; 2028ee3e3ff5SAndrew Thompson if (mode == 0) 2029ee3e3ff5SAndrew Thompson continue; /* no IN or OUT endpoint */ 2030ee3e3ff5SAndrew Thompson 20312ffd5fdcSHans Petter Selasky pd = usb_make_dev(udev, NULL, ep, 0, 20322ffd5fdcSHans Petter Selasky mode, UID_ROOT, GID_OPERATOR, 0600); 20332ffd5fdcSHans Petter Selasky 20342ffd5fdcSHans Petter Selasky if (pd != NULL) 2035ee3e3ff5SAndrew Thompson LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next); 2036ee3e3ff5SAndrew Thompson } 2037ee3e3ff5SAndrew Thompson } 2038ee3e3ff5SAndrew Thompson 2039ee3e3ff5SAndrew Thompson static void 2040a593f6b8SAndrew Thompson usb_cdev_free(struct usb_device *udev) 2041ee3e3ff5SAndrew Thompson { 2042760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 2043ee3e3ff5SAndrew Thompson 2044ee3e3ff5SAndrew Thompson DPRINTFN(2, "Freeing device nodes\n"); 2045ee3e3ff5SAndrew Thompson 2046ee3e3ff5SAndrew Thompson while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) { 2047ee3e3ff5SAndrew Thompson KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt")); 2048ee3e3ff5SAndrew Thompson 2049ee3e3ff5SAndrew Thompson LIST_REMOVE(pd, pd_next); 2050ee3e3ff5SAndrew Thompson 20512ffd5fdcSHans Petter Selasky usb_destroy_dev(pd); 20522ffd5fdcSHans Petter Selasky } 2053ee3e3ff5SAndrew Thompson } 20540f6e8f93SAndrew Thompson #endif 2055ee3e3ff5SAndrew Thompson 205602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2057a593f6b8SAndrew Thompson * usb_free_device 205802ac6454SAndrew Thompson * 2059d88688c7SAndrew Thompson * This function is NULL safe and will free an USB device and its 2060d88688c7SAndrew Thompson * children devices, if any. 2061bdd41206SAndrew Thompson * 2062d88688c7SAndrew Thompson * Flag values: Reserved, set to zero. 206302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 206402ac6454SAndrew Thompson void 2065a593f6b8SAndrew Thompson usb_free_device(struct usb_device *udev, uint8_t flag) 206602ac6454SAndrew Thompson { 2067760bc48eSAndrew Thompson struct usb_bus *bus; 2068bdd41206SAndrew Thompson 2069bdd41206SAndrew Thompson if (udev == NULL) 2070bdd41206SAndrew Thompson return; /* already freed */ 207102ac6454SAndrew Thompson 207202ac6454SAndrew Thompson DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no); 207302ac6454SAndrew Thompson 2074bd216778SAndrew Thompson bus = udev->bus; 2075a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_DETACHED); 2076bdd41206SAndrew Thompson 20778bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 20783acd904dSAndrew Thompson usb_notify_addq("DETACH", udev); 20798bb77249SHans Petter Selasky #endif 208002ac6454SAndrew Thompson 20818bb77249SHans Petter Selasky #if USB_HAVE_UGEN 2082ee3e3ff5SAndrew Thompson printf("%s: <%s> at %s (disconnected)\n", udev->ugen_name, 2083ae538d85SAndrew Thompson usb_get_manufacturer(udev), device_get_nameunit(bus->bdev)); 208402ac6454SAndrew Thompson 2085ee3e3ff5SAndrew Thompson /* Destroy UGEN symlink, if any */ 208602ac6454SAndrew Thompson if (udev->ugen_symlink) { 2087a593f6b8SAndrew Thompson usb_free_symlink(udev->ugen_symlink); 208802ac6454SAndrew Thompson udev->ugen_symlink = NULL; 208902ac6454SAndrew Thompson } 20908755859aSAndrew Thompson #endif 209102ac6454SAndrew Thompson /* 209202ac6454SAndrew Thompson * Unregister our device first which will prevent any further 209302ac6454SAndrew Thompson * references: 209402ac6454SAndrew Thompson */ 2095a593f6b8SAndrew Thompson usb_bus_port_set_device(bus, udev->parent_hub ? 209602ac6454SAndrew Thompson udev->parent_hub->hub->ports + udev->port_index : NULL, 209702ac6454SAndrew Thompson NULL, USB_ROOT_HUB_ADDR); 209802ac6454SAndrew Thompson 20990f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 210002ac6454SAndrew Thompson /* wait for all pending references to go away: */ 2101a593f6b8SAndrew Thompson mtx_lock(&usb_ref_lock); 210202ac6454SAndrew Thompson udev->refcount--; 210302ac6454SAndrew Thompson while (udev->refcount != 0) { 210491cd9240SAndrew Thompson cv_wait(&udev->ref_cv, &usb_ref_lock); 210502ac6454SAndrew Thompson } 2106a593f6b8SAndrew Thompson mtx_unlock(&usb_ref_lock); 2107bdd41206SAndrew Thompson 21082ffd5fdcSHans Petter Selasky usb_destroy_dev(udev->ctrl_dev); 21090f6e8f93SAndrew Thompson #endif 211002ac6454SAndrew Thompson 2111f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 211202ac6454SAndrew Thompson /* stop receiving any control transfers (Device Side Mode) */ 21135b3bb704SAndrew Thompson usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX); 211402ac6454SAndrew Thompson } 211502ac6454SAndrew Thompson 2116bdd41206SAndrew Thompson /* the following will get the device unconfigured in software */ 2117d88688c7SAndrew Thompson usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0); 211802ac6454SAndrew Thompson 211902ac6454SAndrew Thompson /* unsetup any leftover default USB transfers */ 21205b3bb704SAndrew Thompson usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX); 212102ac6454SAndrew Thompson 212202ac6454SAndrew Thompson /* template unsetup, if any */ 2123a593f6b8SAndrew Thompson (usb_temp_unsetup_p) (udev); 212402ac6454SAndrew Thompson 212502ac6454SAndrew Thompson /* 212602ac6454SAndrew Thompson * Make sure that our clear-stall messages are not queued 212702ac6454SAndrew Thompson * anywhere: 212802ac6454SAndrew Thompson */ 212902ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 21309b3a48eeSHans Petter Selasky usb_proc_mwait(USB_BUS_NON_GIANT_PROC(udev->bus), 213102ac6454SAndrew Thompson &udev->cs_msg[0], &udev->cs_msg[1]); 213202ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 213302ac6454SAndrew Thompson 213491cd9240SAndrew Thompson sx_destroy(&udev->enum_sx); 21352df1e9a6SAndrew Thompson sx_destroy(&udev->sr_sx); 213602ac6454SAndrew Thompson 213791cd9240SAndrew Thompson cv_destroy(&udev->ctrlreq_cv); 213891cd9240SAndrew Thompson cv_destroy(&udev->ref_cv); 213902ac6454SAndrew Thompson 214091cd9240SAndrew Thompson mtx_destroy(&udev->device_mtx); 21418755859aSAndrew Thompson #if USB_HAVE_UGEN 2142ee3e3ff5SAndrew Thompson KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries")); 21438755859aSAndrew Thompson #endif 214402ac6454SAndrew Thompson 2145963169b4SHans Petter Selasky /* Uninitialise device */ 2146963169b4SHans Petter Selasky if (bus->methods->device_uninit != NULL) 2147963169b4SHans Petter Selasky (bus->methods->device_uninit) (udev); 2148963169b4SHans Petter Selasky 214902ac6454SAndrew Thompson /* free device */ 215028212de2SAndrew Thompson free(udev->serial, M_USB); 215128212de2SAndrew Thompson free(udev->manufacturer, M_USB); 215228212de2SAndrew Thompson free(udev->product, M_USB); 215302ac6454SAndrew Thompson free(udev, M_USB); 215402ac6454SAndrew Thompson } 215502ac6454SAndrew Thompson 215602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2157a593f6b8SAndrew Thompson * usbd_get_iface 215802ac6454SAndrew Thompson * 215902ac6454SAndrew Thompson * This function is the safe way to get the USB interface structure 216002ac6454SAndrew Thompson * pointer by interface index. 216102ac6454SAndrew Thompson * 216202ac6454SAndrew Thompson * Return values: 216302ac6454SAndrew Thompson * NULL: Interface not present. 216402ac6454SAndrew Thompson * Else: Pointer to USB interface structure. 216502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 2166760bc48eSAndrew Thompson struct usb_interface * 2167a593f6b8SAndrew Thompson usbd_get_iface(struct usb_device *udev, uint8_t iface_index) 216802ac6454SAndrew Thompson { 2169760bc48eSAndrew Thompson struct usb_interface *iface = udev->ifaces + iface_index; 217002ac6454SAndrew Thompson 2171bdd41206SAndrew Thompson if (iface_index >= udev->ifaces_max) 217202ac6454SAndrew Thompson return (NULL); 217302ac6454SAndrew Thompson return (iface); 217402ac6454SAndrew Thompson } 217502ac6454SAndrew Thompson 217602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 21773c8d24f4SAndrew Thompson * usbd_find_descriptor 217802ac6454SAndrew Thompson * 217902ac6454SAndrew Thompson * This function will lookup the first descriptor that matches the 218002ac6454SAndrew Thompson * criteria given by the arguments "type" and "subtype". Descriptors 218102ac6454SAndrew Thompson * will only be searched within the interface having the index 218202ac6454SAndrew Thompson * "iface_index". If the "id" argument points to an USB descriptor, 218302ac6454SAndrew Thompson * it will be skipped before the search is started. This allows 218402ac6454SAndrew Thompson * searching for multiple descriptors using the same criteria. Else 218502ac6454SAndrew Thompson * the search is started after the interface descriptor. 218602ac6454SAndrew Thompson * 218702ac6454SAndrew Thompson * Return values: 218802ac6454SAndrew Thompson * NULL: End of descriptors 218902ac6454SAndrew Thompson * Else: A descriptor matching the criteria 219002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 219102ac6454SAndrew Thompson void * 21923c8d24f4SAndrew Thompson usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index, 219302ac6454SAndrew Thompson uint8_t type, uint8_t type_mask, 219402ac6454SAndrew Thompson uint8_t subtype, uint8_t subtype_mask) 219502ac6454SAndrew Thompson { 2196760bc48eSAndrew Thompson struct usb_descriptor *desc; 2197760bc48eSAndrew Thompson struct usb_config_descriptor *cd; 2198760bc48eSAndrew Thompson struct usb_interface *iface; 219902ac6454SAndrew Thompson 2200a593f6b8SAndrew Thompson cd = usbd_get_config_descriptor(udev); 220102ac6454SAndrew Thompson if (cd == NULL) { 220202ac6454SAndrew Thompson return (NULL); 220302ac6454SAndrew Thompson } 220402ac6454SAndrew Thompson if (id == NULL) { 2205a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, iface_index); 220602ac6454SAndrew Thompson if (iface == NULL) { 220702ac6454SAndrew Thompson return (NULL); 220802ac6454SAndrew Thompson } 2209a593f6b8SAndrew Thompson id = usbd_get_interface_descriptor(iface); 221002ac6454SAndrew Thompson if (id == NULL) { 221102ac6454SAndrew Thompson return (NULL); 221202ac6454SAndrew Thompson } 221302ac6454SAndrew Thompson } 221402ac6454SAndrew Thompson desc = (void *)id; 221502ac6454SAndrew Thompson 2216a593f6b8SAndrew Thompson while ((desc = usb_desc_foreach(cd, desc))) { 221702ac6454SAndrew Thompson 221802ac6454SAndrew Thompson if (desc->bDescriptorType == UDESC_INTERFACE) { 221902ac6454SAndrew Thompson break; 222002ac6454SAndrew Thompson } 222102ac6454SAndrew Thompson if (((desc->bDescriptorType & type_mask) == type) && 222202ac6454SAndrew Thompson ((desc->bDescriptorSubtype & subtype_mask) == subtype)) { 222302ac6454SAndrew Thompson return (desc); 222402ac6454SAndrew Thompson } 222502ac6454SAndrew Thompson } 222602ac6454SAndrew Thompson return (NULL); 222702ac6454SAndrew Thompson } 222802ac6454SAndrew Thompson 222902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2230a593f6b8SAndrew Thompson * usb_devinfo 223102ac6454SAndrew Thompson * 223202ac6454SAndrew Thompson * This function will dump information from the device descriptor 223302ac6454SAndrew Thompson * belonging to the USB device pointed to by "udev", to the string 223402ac6454SAndrew Thompson * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes 223502ac6454SAndrew Thompson * including the terminating zero. 223602ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 223702ac6454SAndrew Thompson void 2238a593f6b8SAndrew Thompson usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len) 223902ac6454SAndrew Thompson { 2240760bc48eSAndrew Thompson struct usb_device_descriptor *udd = &udev->ddesc; 224102ac6454SAndrew Thompson uint16_t bcdDevice; 224202ac6454SAndrew Thompson uint16_t bcdUSB; 224302ac6454SAndrew Thompson 224402ac6454SAndrew Thompson bcdUSB = UGETW(udd->bcdUSB); 224502ac6454SAndrew Thompson bcdDevice = UGETW(udd->bcdDevice); 224602ac6454SAndrew Thompson 224702ac6454SAndrew Thompson if (udd->bDeviceClass != 0xFF) { 224802ac6454SAndrew Thompson snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/" 22498755859aSAndrew Thompson "%x.%02x, addr %d", 2250ae538d85SAndrew Thompson usb_get_manufacturer(udev), 2251ae538d85SAndrew Thompson usb_get_product(udev), 225202ac6454SAndrew Thompson udd->bDeviceClass, udd->bDeviceSubClass, 225302ac6454SAndrew Thompson (bcdUSB >> 8), bcdUSB & 0xFF, 225402ac6454SAndrew Thompson (bcdDevice >> 8), bcdDevice & 0xFF, 225502ac6454SAndrew Thompson udev->address); 225602ac6454SAndrew Thompson } else { 225702ac6454SAndrew Thompson snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/" 22588755859aSAndrew Thompson "%x.%02x, addr %d", 2259ae538d85SAndrew Thompson usb_get_manufacturer(udev), 2260ae538d85SAndrew Thompson usb_get_product(udev), 226102ac6454SAndrew Thompson (bcdUSB >> 8), bcdUSB & 0xFF, 226202ac6454SAndrew Thompson (bcdDevice >> 8), bcdDevice & 0xFF, 226302ac6454SAndrew Thompson udev->address); 226402ac6454SAndrew Thompson } 226502ac6454SAndrew Thompson } 226602ac6454SAndrew Thompson 2267ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 226802ac6454SAndrew Thompson /* 226902ac6454SAndrew Thompson * Descriptions of of known vendors and devices ("products"). 227002ac6454SAndrew Thompson */ 227102ac6454SAndrew Thompson struct usb_knowndev { 227202ac6454SAndrew Thompson uint16_t vendor; 227302ac6454SAndrew Thompson uint16_t product; 227402ac6454SAndrew Thompson uint32_t flags; 227502ac6454SAndrew Thompson const char *vendorname; 227602ac6454SAndrew Thompson const char *productname; 227702ac6454SAndrew Thompson }; 227802ac6454SAndrew Thompson 227902ac6454SAndrew Thompson #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */ 228002ac6454SAndrew Thompson 228102ac6454SAndrew Thompson #include "usbdevs.h" 228202ac6454SAndrew Thompson #include "usbdevs_data.h" 228302ac6454SAndrew Thompson #endif /* USB_VERBOSE */ 228402ac6454SAndrew Thompson 228502ac6454SAndrew Thompson static void 2286a593f6b8SAndrew Thompson usbd_set_device_strings(struct usb_device *udev) 228702ac6454SAndrew Thompson { 2288760bc48eSAndrew Thompson struct usb_device_descriptor *udd = &udev->ddesc; 2289ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 229002ac6454SAndrew Thompson const struct usb_knowndev *kdp; 229102ac6454SAndrew Thompson #endif 22922df1e9a6SAndrew Thompson char *temp_ptr; 22937a918edfSAndrew Thompson size_t temp_size; 229402ac6454SAndrew Thompson uint16_t vendor_id; 229502ac6454SAndrew Thompson uint16_t product_id; 22966950c75fSHans Petter Selasky uint8_t do_unlock; 229702ac6454SAndrew Thompson 22986950c75fSHans Petter Selasky /* Protect scratch area */ 22996950c75fSHans Petter Selasky do_unlock = usbd_enum_lock(udev); 23006950c75fSHans Petter Selasky 23016950c75fSHans Petter Selasky temp_ptr = (char *)udev->scratch.data; 23026950c75fSHans Petter Selasky temp_size = sizeof(udev->scratch.data); 23037a918edfSAndrew Thompson 230402ac6454SAndrew Thompson vendor_id = UGETW(udd->idVendor); 230502ac6454SAndrew Thompson product_id = UGETW(udd->idProduct); 230602ac6454SAndrew Thompson 2307c86aead6SAndrew Thompson /* get serial number string */ 23087a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2309c86aead6SAndrew Thompson udev->ddesc.iSerialNumber); 23107a918edfSAndrew Thompson udev->serial = strdup(temp_ptr, M_USB); 231102ac6454SAndrew Thompson 2312c86aead6SAndrew Thompson /* get manufacturer string */ 23137a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2314c86aead6SAndrew Thompson udev->ddesc.iManufacturer); 23157a918edfSAndrew Thompson usb_trim_spaces(temp_ptr); 23167a918edfSAndrew Thompson if (temp_ptr[0] != '\0') 23177a918edfSAndrew Thompson udev->manufacturer = strdup(temp_ptr, M_USB); 2318c86aead6SAndrew Thompson 2319c86aead6SAndrew Thompson /* get product string */ 23207a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2321c86aead6SAndrew Thompson udev->ddesc.iProduct); 23227a918edfSAndrew Thompson usb_trim_spaces(temp_ptr); 23237a918edfSAndrew Thompson if (temp_ptr[0] != '\0') 23247a918edfSAndrew Thompson udev->product = strdup(temp_ptr, M_USB); 2325c86aead6SAndrew Thompson 2326ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 2327c86aead6SAndrew Thompson if (udev->manufacturer == NULL || udev->product == NULL) { 2328c86aead6SAndrew Thompson for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) { 232902ac6454SAndrew Thompson if (kdp->vendor == vendor_id && 233002ac6454SAndrew Thompson (kdp->product == product_id || 233102ac6454SAndrew Thompson (kdp->flags & USB_KNOWNDEV_NOPROD) != 0)) 233202ac6454SAndrew Thompson break; 233302ac6454SAndrew Thompson } 233402ac6454SAndrew Thompson if (kdp->vendorname != NULL) { 2335c86aead6SAndrew Thompson /* XXX should use pointer to knowndevs string */ 2336c86aead6SAndrew Thompson if (udev->manufacturer == NULL) { 2337c86aead6SAndrew Thompson udev->manufacturer = strdup(kdp->vendorname, 2338c86aead6SAndrew Thompson M_USB); 2339c86aead6SAndrew Thompson } 2340c86aead6SAndrew Thompson if (udev->product == NULL && 2341c86aead6SAndrew Thompson (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) { 2342c86aead6SAndrew Thompson udev->product = strdup(kdp->productname, 2343c86aead6SAndrew Thompson M_USB); 2344c86aead6SAndrew Thompson } 234502ac6454SAndrew Thompson } 234602ac6454SAndrew Thompson } 234702ac6454SAndrew Thompson #endif 2348c86aead6SAndrew Thompson /* Provide default strings if none were found */ 2349c86aead6SAndrew Thompson if (udev->manufacturer == NULL) { 23507a918edfSAndrew Thompson snprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id); 23517a918edfSAndrew Thompson udev->manufacturer = strdup(temp_ptr, M_USB); 235202ac6454SAndrew Thompson } 2353c86aead6SAndrew Thompson if (udev->product == NULL) { 23547a918edfSAndrew Thompson snprintf(temp_ptr, temp_size, "product 0x%04x", product_id); 23557a918edfSAndrew Thompson udev->product = strdup(temp_ptr, M_USB); 235602ac6454SAndrew Thompson } 23576950c75fSHans Petter Selasky 23586950c75fSHans Petter Selasky if (do_unlock) 23596950c75fSHans Petter Selasky usbd_enum_unlock(udev); 236002ac6454SAndrew Thompson } 236102ac6454SAndrew Thompson 236202ac6454SAndrew Thompson /* 236302ac6454SAndrew Thompson * Returns: 236402ac6454SAndrew Thompson * See: USB_MODE_XXX 236502ac6454SAndrew Thompson */ 2366f29a0724SAndrew Thompson enum usb_hc_mode 2367a593f6b8SAndrew Thompson usbd_get_mode(struct usb_device *udev) 236802ac6454SAndrew Thompson { 2369f29a0724SAndrew Thompson return (udev->flags.usb_mode); 237002ac6454SAndrew Thompson } 237102ac6454SAndrew Thompson 237202ac6454SAndrew Thompson /* 237302ac6454SAndrew Thompson * Returns: 237402ac6454SAndrew Thompson * See: USB_SPEED_XXX 237502ac6454SAndrew Thompson */ 23768d2dd5ddSAndrew Thompson enum usb_dev_speed 2377a593f6b8SAndrew Thompson usbd_get_speed(struct usb_device *udev) 237802ac6454SAndrew Thompson { 237902ac6454SAndrew Thompson return (udev->speed); 238002ac6454SAndrew Thompson } 238102ac6454SAndrew Thompson 238202ac6454SAndrew Thompson uint32_t 2383a593f6b8SAndrew Thompson usbd_get_isoc_fps(struct usb_device *udev) 238402ac6454SAndrew Thompson { 238502ac6454SAndrew Thompson ; /* indent fix */ 238602ac6454SAndrew Thompson switch (udev->speed) { 238702ac6454SAndrew Thompson case USB_SPEED_LOW: 238802ac6454SAndrew Thompson case USB_SPEED_FULL: 238902ac6454SAndrew Thompson return (1000); 239002ac6454SAndrew Thompson default: 239102ac6454SAndrew Thompson return (8000); 239202ac6454SAndrew Thompson } 239302ac6454SAndrew Thompson } 239402ac6454SAndrew Thompson 2395760bc48eSAndrew Thompson struct usb_device_descriptor * 2396a593f6b8SAndrew Thompson usbd_get_device_descriptor(struct usb_device *udev) 239702ac6454SAndrew Thompson { 239802ac6454SAndrew Thompson if (udev == NULL) 239902ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 240002ac6454SAndrew Thompson return (&udev->ddesc); 240102ac6454SAndrew Thompson } 240202ac6454SAndrew Thompson 2403760bc48eSAndrew Thompson struct usb_config_descriptor * 2404a593f6b8SAndrew Thompson usbd_get_config_descriptor(struct usb_device *udev) 240502ac6454SAndrew Thompson { 240602ac6454SAndrew Thompson if (udev == NULL) 240702ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 240802ac6454SAndrew Thompson return (udev->cdesc); 240902ac6454SAndrew Thompson } 241002ac6454SAndrew Thompson 241102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2412a593f6b8SAndrew Thompson * usb_test_quirk - test a device for a given quirk 241302ac6454SAndrew Thompson * 241402ac6454SAndrew Thompson * Return values: 241502ac6454SAndrew Thompson * 0: The USB device does not have the given quirk. 241602ac6454SAndrew Thompson * Else: The USB device has the given quirk. 241702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 241802ac6454SAndrew Thompson uint8_t 2419a593f6b8SAndrew Thompson usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk) 242002ac6454SAndrew Thompson { 242102ac6454SAndrew Thompson uint8_t found; 24223f37fb62SHans Petter Selasky uint8_t x; 24233f37fb62SHans Petter Selasky 24243f37fb62SHans Petter Selasky if (quirk == UQ_NONE) 24253f37fb62SHans Petter Selasky return (0); 24263f37fb62SHans Petter Selasky 24273f37fb62SHans Petter Selasky /* search the automatic per device quirks first */ 24283f37fb62SHans Petter Selasky 24293f37fb62SHans Petter Selasky for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) { 24303f37fb62SHans Petter Selasky if (uaa->device->autoQuirk[x] == quirk) 24313f37fb62SHans Petter Selasky return (1); 24323f37fb62SHans Petter Selasky } 24333f37fb62SHans Petter Selasky 24343f37fb62SHans Petter Selasky /* search global quirk table, if any */ 243502ac6454SAndrew Thompson 2436a593f6b8SAndrew Thompson found = (usb_test_quirk_p) (&uaa->info, quirk); 24373f37fb62SHans Petter Selasky 243802ac6454SAndrew Thompson return (found); 243902ac6454SAndrew Thompson } 244002ac6454SAndrew Thompson 2441760bc48eSAndrew Thompson struct usb_interface_descriptor * 2442a593f6b8SAndrew Thompson usbd_get_interface_descriptor(struct usb_interface *iface) 244302ac6454SAndrew Thompson { 244402ac6454SAndrew Thompson if (iface == NULL) 244502ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 244602ac6454SAndrew Thompson return (iface->idesc); 244702ac6454SAndrew Thompson } 244802ac6454SAndrew Thompson 244902ac6454SAndrew Thompson uint8_t 2450a593f6b8SAndrew Thompson usbd_get_interface_altindex(struct usb_interface *iface) 245102ac6454SAndrew Thompson { 245202ac6454SAndrew Thompson return (iface->alt_index); 245302ac6454SAndrew Thompson } 245402ac6454SAndrew Thompson 245502ac6454SAndrew Thompson uint8_t 2456a593f6b8SAndrew Thompson usbd_get_bus_index(struct usb_device *udev) 245702ac6454SAndrew Thompson { 245802ac6454SAndrew Thompson return ((uint8_t)device_get_unit(udev->bus->bdev)); 245902ac6454SAndrew Thompson } 246002ac6454SAndrew Thompson 246102ac6454SAndrew Thompson uint8_t 2462a593f6b8SAndrew Thompson usbd_get_device_index(struct usb_device *udev) 246302ac6454SAndrew Thompson { 246402ac6454SAndrew Thompson return (udev->device_index); 246502ac6454SAndrew Thompson } 246602ac6454SAndrew Thompson 24678bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 24683acd904dSAndrew Thompson static void 24693acd904dSAndrew Thompson usb_notify_addq(const char *type, struct usb_device *udev) 24703acd904dSAndrew Thompson { 24713acd904dSAndrew Thompson struct usb_interface *iface; 24723acd904dSAndrew Thompson struct sbuf *sb; 24733acd904dSAndrew Thompson int i; 24743acd904dSAndrew Thompson 24753acd904dSAndrew Thompson /* announce the device */ 24763acd904dSAndrew Thompson sb = sbuf_new_auto(); 24773acd904dSAndrew Thompson sbuf_printf(sb, 24788bb77249SHans Petter Selasky #if USB_HAVE_UGEN 24798bb77249SHans Petter Selasky "ugen=%s " 248002c40241SHans Petter Selasky "cdev=%s " 24818bb77249SHans Petter Selasky #endif 24823acd904dSAndrew Thompson "vendor=0x%04x " 24833acd904dSAndrew Thompson "product=0x%04x " 24843acd904dSAndrew Thompson "devclass=0x%02x " 24853acd904dSAndrew Thompson "devsubclass=0x%02x " 24863acd904dSAndrew Thompson "sernum=\"%s\" " 24873acd904dSAndrew Thompson "release=0x%04x " 248866390216SAndrew Thompson "mode=%s " 24893acd904dSAndrew Thompson "port=%u " 24908bb77249SHans Petter Selasky #if USB_HAVE_UGEN 24916df3eebbSNick Hibma "parent=%s" 24928bb77249SHans Petter Selasky #endif 24938bb77249SHans Petter Selasky "", 24948bb77249SHans Petter Selasky #if USB_HAVE_UGEN 24953acd904dSAndrew Thompson udev->ugen_name, 249602c40241SHans Petter Selasky udev->ugen_name, 24978bb77249SHans Petter Selasky #endif 24983acd904dSAndrew Thompson UGETW(udev->ddesc.idVendor), 24993acd904dSAndrew Thompson UGETW(udev->ddesc.idProduct), 25003acd904dSAndrew Thompson udev->ddesc.bDeviceClass, 25013acd904dSAndrew Thompson udev->ddesc.bDeviceSubClass, 2502ae538d85SAndrew Thompson usb_get_serial(udev), 25033acd904dSAndrew Thompson UGETW(udev->ddesc.bcdDevice), 250466390216SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device", 25058bb77249SHans Petter Selasky udev->port_no 25068bb77249SHans Petter Selasky #if USB_HAVE_UGEN 25078bb77249SHans Petter Selasky , udev->parent_hub != NULL ? 25083acd904dSAndrew Thompson udev->parent_hub->ugen_name : 25098bb77249SHans Petter Selasky device_get_nameunit(device_get_parent(udev->bus->bdev)) 25108bb77249SHans Petter Selasky #endif 25118bb77249SHans Petter Selasky ); 25123acd904dSAndrew Thompson sbuf_finish(sb); 25133acd904dSAndrew Thompson devctl_notify("USB", "DEVICE", type, sbuf_data(sb)); 25143acd904dSAndrew Thompson sbuf_delete(sb); 25153acd904dSAndrew Thompson 25163acd904dSAndrew Thompson /* announce each interface */ 25173acd904dSAndrew Thompson for (i = 0; i < USB_IFACE_MAX; i++) { 25183acd904dSAndrew Thompson iface = usbd_get_iface(udev, i); 25193acd904dSAndrew Thompson if (iface == NULL) 25203acd904dSAndrew Thompson break; /* end of interfaces */ 25213acd904dSAndrew Thompson if (iface->idesc == NULL) 25223acd904dSAndrew Thompson continue; /* no interface descriptor */ 25233acd904dSAndrew Thompson 25243acd904dSAndrew Thompson sb = sbuf_new_auto(); 25253acd904dSAndrew Thompson sbuf_printf(sb, 25268bb77249SHans Petter Selasky #if USB_HAVE_UGEN 25278bb77249SHans Petter Selasky "ugen=%s " 252802c40241SHans Petter Selasky "cdev=%s " 25298bb77249SHans Petter Selasky #endif 25303acd904dSAndrew Thompson "vendor=0x%04x " 25313acd904dSAndrew Thompson "product=0x%04x " 25323acd904dSAndrew Thompson "devclass=0x%02x " 25333acd904dSAndrew Thompson "devsubclass=0x%02x " 25343acd904dSAndrew Thompson "sernum=\"%s\" " 25353acd904dSAndrew Thompson "release=0x%04x " 253666390216SAndrew Thompson "mode=%s " 25373acd904dSAndrew Thompson "interface=%d " 25383acd904dSAndrew Thompson "endpoints=%d " 25393acd904dSAndrew Thompson "intclass=0x%02x " 25403acd904dSAndrew Thompson "intsubclass=0x%02x " 25416df3eebbSNick Hibma "intprotocol=0x%02x", 25428bb77249SHans Petter Selasky #if USB_HAVE_UGEN 25433acd904dSAndrew Thompson udev->ugen_name, 254402c40241SHans Petter Selasky udev->ugen_name, 25458bb77249SHans Petter Selasky #endif 25463acd904dSAndrew Thompson UGETW(udev->ddesc.idVendor), 25473acd904dSAndrew Thompson UGETW(udev->ddesc.idProduct), 25483acd904dSAndrew Thompson udev->ddesc.bDeviceClass, 25493acd904dSAndrew Thompson udev->ddesc.bDeviceSubClass, 2550ae538d85SAndrew Thompson usb_get_serial(udev), 25513acd904dSAndrew Thompson UGETW(udev->ddesc.bcdDevice), 255266390216SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device", 25533acd904dSAndrew Thompson iface->idesc->bInterfaceNumber, 25543acd904dSAndrew Thompson iface->idesc->bNumEndpoints, 25553acd904dSAndrew Thompson iface->idesc->bInterfaceClass, 25563acd904dSAndrew Thompson iface->idesc->bInterfaceSubClass, 25573acd904dSAndrew Thompson iface->idesc->bInterfaceProtocol); 25583acd904dSAndrew Thompson sbuf_finish(sb); 25593acd904dSAndrew Thompson devctl_notify("USB", "INTERFACE", type, sbuf_data(sb)); 25603acd904dSAndrew Thompson sbuf_delete(sb); 25613acd904dSAndrew Thompson } 25623acd904dSAndrew Thompson } 25638bb77249SHans Petter Selasky #endif 256402ac6454SAndrew Thompson 25658bb77249SHans Petter Selasky #if USB_HAVE_UGEN 256602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2567a593f6b8SAndrew Thompson * usb_fifo_free_wrap 256802ac6454SAndrew Thompson * 256902ac6454SAndrew Thompson * This function will free the FIFOs. 257002ac6454SAndrew Thompson * 2571bdd41206SAndrew Thompson * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag 2572bdd41206SAndrew Thompson * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free 2573bdd41206SAndrew Thompson * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and 2574bdd41206SAndrew Thompson * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non 2575bdd41206SAndrew Thompson * control endpoint FIFOs. If "iface_index" is not set to 2576bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" the flag has no effect. 257702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 257802ac6454SAndrew Thompson static void 2579a593f6b8SAndrew Thompson usb_fifo_free_wrap(struct usb_device *udev, 258002ac6454SAndrew Thompson uint8_t iface_index, uint8_t flag) 258102ac6454SAndrew Thompson { 2582760bc48eSAndrew Thompson struct usb_fifo *f; 258302ac6454SAndrew Thompson uint16_t i; 258402ac6454SAndrew Thompson 258502ac6454SAndrew Thompson /* 258602ac6454SAndrew Thompson * Free any USB FIFOs on the given interface: 258702ac6454SAndrew Thompson */ 258802ac6454SAndrew Thompson for (i = 0; i != USB_FIFO_MAX; i++) { 258902ac6454SAndrew Thompson f = udev->fifo[i]; 259002ac6454SAndrew Thompson if (f == NULL) { 259102ac6454SAndrew Thompson continue; 259202ac6454SAndrew Thompson } 259302ac6454SAndrew Thompson /* Check if the interface index matches */ 259402ac6454SAndrew Thompson if (iface_index == f->iface_index) { 2595a593f6b8SAndrew Thompson if (f->methods != &usb_ugen_methods) { 259602ac6454SAndrew Thompson /* 259702ac6454SAndrew Thompson * Don't free any non-generic FIFOs in 259802ac6454SAndrew Thompson * this case. 259902ac6454SAndrew Thompson */ 260002ac6454SAndrew Thompson continue; 260102ac6454SAndrew Thompson } 260202ac6454SAndrew Thompson if ((f->dev_ep_index == 0) && 260302ac6454SAndrew Thompson (f->fs_xfer == NULL)) { 260402ac6454SAndrew Thompson /* no need to free this FIFO */ 260502ac6454SAndrew Thompson continue; 260602ac6454SAndrew Thompson } 260702ac6454SAndrew Thompson } else if (iface_index == USB_IFACE_INDEX_ANY) { 2608a593f6b8SAndrew Thompson if ((f->methods == &usb_ugen_methods) && 2609bdd41206SAndrew Thompson (f->dev_ep_index == 0) && 2610bdd41206SAndrew Thompson (!(flag & USB_UNCFG_FLAG_FREE_EP0)) && 261102ac6454SAndrew Thompson (f->fs_xfer == NULL)) { 261202ac6454SAndrew Thompson /* no need to free this FIFO */ 261302ac6454SAndrew Thompson continue; 261402ac6454SAndrew Thompson } 261502ac6454SAndrew Thompson } else { 261602ac6454SAndrew Thompson /* no need to free this FIFO */ 261702ac6454SAndrew Thompson continue; 261802ac6454SAndrew Thompson } 261902ac6454SAndrew Thompson /* free this FIFO */ 2620a593f6b8SAndrew Thompson usb_fifo_free(f); 262102ac6454SAndrew Thompson } 262202ac6454SAndrew Thompson } 26230f6e8f93SAndrew Thompson #endif 262402ac6454SAndrew Thompson 262502ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2626a593f6b8SAndrew Thompson * usb_peer_can_wakeup 262702ac6454SAndrew Thompson * 262802ac6454SAndrew Thompson * Return values: 262902ac6454SAndrew Thompson * 0: Peer cannot do resume signalling. 263002ac6454SAndrew Thompson * Else: Peer can do resume signalling. 263102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 263202ac6454SAndrew Thompson uint8_t 2633a593f6b8SAndrew Thompson usb_peer_can_wakeup(struct usb_device *udev) 263402ac6454SAndrew Thompson { 2635760bc48eSAndrew Thompson const struct usb_config_descriptor *cdp; 263602ac6454SAndrew Thompson 263702ac6454SAndrew Thompson cdp = udev->cdesc; 2638f29a0724SAndrew Thompson if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) { 263902ac6454SAndrew Thompson return (cdp->bmAttributes & UC_REMOTE_WAKEUP); 264002ac6454SAndrew Thompson } 264102ac6454SAndrew Thompson return (0); /* not supported */ 264202ac6454SAndrew Thompson } 2643bd216778SAndrew Thompson 2644bd216778SAndrew Thompson void 2645a593f6b8SAndrew Thompson usb_set_device_state(struct usb_device *udev, enum usb_dev_state state) 2646bd216778SAndrew Thompson { 2647bd216778SAndrew Thompson 2648bd216778SAndrew Thompson KASSERT(state < USB_STATE_MAX, ("invalid udev state")); 2649bd216778SAndrew Thompson 2650bd216778SAndrew Thompson DPRINTF("udev %p state %s -> %s\n", udev, 2651a593f6b8SAndrew Thompson usb_statestr(udev->state), usb_statestr(state)); 2652bd216778SAndrew Thompson udev->state = state; 2653963169b4SHans Petter Selasky 2654963169b4SHans Petter Selasky if (udev->bus->methods->device_state_change != NULL) 2655963169b4SHans Petter Selasky (udev->bus->methods->device_state_change) (udev); 2656963169b4SHans Petter Selasky } 2657963169b4SHans Petter Selasky 2658963169b4SHans Petter Selasky enum usb_dev_state 2659963169b4SHans Petter Selasky usb_get_device_state(struct usb_device *udev) 2660963169b4SHans Petter Selasky { 2661963169b4SHans Petter Selasky if (udev == NULL) 2662963169b4SHans Petter Selasky return (USB_STATE_DETACHED); 2663963169b4SHans Petter Selasky return (udev->state); 2664bd216778SAndrew Thompson } 2665bd216778SAndrew Thompson 2666ec8f3127SAndrew Thompson uint8_t 2667a593f6b8SAndrew Thompson usbd_device_attached(struct usb_device *udev) 2668bd216778SAndrew Thompson { 2669bd216778SAndrew Thompson return (udev->state > USB_STATE_DETACHED); 2670bd216778SAndrew Thompson } 2671cb18f7d1SAlfred Perlstein 26726950c75fSHans Petter Selasky /* 26736950c75fSHans Petter Selasky * The following function locks enumerating the given USB device. If 26746950c75fSHans Petter Selasky * the lock is already grabbed this function returns zero. Else a 26756950c75fSHans Petter Selasky * non-zero value is returned. 26766950c75fSHans Petter Selasky */ 26776950c75fSHans Petter Selasky uint8_t 2678cb18f7d1SAlfred Perlstein usbd_enum_lock(struct usb_device *udev) 2679cb18f7d1SAlfred Perlstein { 26806950c75fSHans Petter Selasky if (sx_xlocked(&udev->enum_sx)) 26816950c75fSHans Petter Selasky return (0); 26826950c75fSHans Petter Selasky 268391cd9240SAndrew Thompson sx_xlock(&udev->enum_sx); 26842df1e9a6SAndrew Thompson sx_xlock(&udev->sr_sx); 2685cb18f7d1SAlfred Perlstein /* 2686cb18f7d1SAlfred Perlstein * NEWBUS LOCK NOTE: We should check if any parent SX locks 2687cb18f7d1SAlfred Perlstein * are locked before locking Giant. Else the lock can be 2688cb18f7d1SAlfred Perlstein * locked multiple times. 2689cb18f7d1SAlfred Perlstein */ 2690cb18f7d1SAlfred Perlstein mtx_lock(&Giant); 26916950c75fSHans Petter Selasky return (1); 2692cb18f7d1SAlfred Perlstein } 2693cb18f7d1SAlfred Perlstein 2694cb18f7d1SAlfred Perlstein /* The following function unlocks enumerating the given USB device. */ 2695cb18f7d1SAlfred Perlstein 2696cb18f7d1SAlfred Perlstein void 2697cb18f7d1SAlfred Perlstein usbd_enum_unlock(struct usb_device *udev) 2698cb18f7d1SAlfred Perlstein { 2699cb18f7d1SAlfred Perlstein mtx_unlock(&Giant); 270091cd9240SAndrew Thompson sx_xunlock(&udev->enum_sx); 27012df1e9a6SAndrew Thompson sx_xunlock(&udev->sr_sx); 27022df1e9a6SAndrew Thompson } 27032df1e9a6SAndrew Thompson 27042df1e9a6SAndrew Thompson /* The following function locks suspend and resume. */ 27052df1e9a6SAndrew Thompson 27062df1e9a6SAndrew Thompson void 27072df1e9a6SAndrew Thompson usbd_sr_lock(struct usb_device *udev) 27082df1e9a6SAndrew Thompson { 27092df1e9a6SAndrew Thompson sx_xlock(&udev->sr_sx); 27102df1e9a6SAndrew Thompson /* 27112df1e9a6SAndrew Thompson * NEWBUS LOCK NOTE: We should check if any parent SX locks 27122df1e9a6SAndrew Thompson * are locked before locking Giant. Else the lock can be 27132df1e9a6SAndrew Thompson * locked multiple times. 27142df1e9a6SAndrew Thompson */ 27152df1e9a6SAndrew Thompson mtx_lock(&Giant); 27162df1e9a6SAndrew Thompson } 27172df1e9a6SAndrew Thompson 27182df1e9a6SAndrew Thompson /* The following function unlocks suspend and resume. */ 27192df1e9a6SAndrew Thompson 27202df1e9a6SAndrew Thompson void 27212df1e9a6SAndrew Thompson usbd_sr_unlock(struct usb_device *udev) 27222df1e9a6SAndrew Thompson { 27232df1e9a6SAndrew Thompson mtx_unlock(&Giant); 27242df1e9a6SAndrew Thompson sx_xunlock(&udev->sr_sx); 2725cb18f7d1SAlfred Perlstein } 2726cb18f7d1SAlfred Perlstein 2727cb18f7d1SAlfred Perlstein /* 2728cb18f7d1SAlfred Perlstein * The following function checks the enumerating lock for the given 2729cb18f7d1SAlfred Perlstein * USB device. 2730cb18f7d1SAlfred Perlstein */ 2731cb18f7d1SAlfred Perlstein 2732cb18f7d1SAlfred Perlstein uint8_t 2733cb18f7d1SAlfred Perlstein usbd_enum_is_locked(struct usb_device *udev) 2734cb18f7d1SAlfred Perlstein { 273591cd9240SAndrew Thompson return (sx_xlocked(&udev->enum_sx)); 2736cb18f7d1SAlfred Perlstein } 27378427ed84SHans Petter Selasky 27388427ed84SHans Petter Selasky /* 27398427ed84SHans Petter Selasky * The following function is used to set the per-interface specific 27408427ed84SHans Petter Selasky * plug and play information. The string referred to by the pnpinfo 27418427ed84SHans Petter Selasky * argument can safely be freed after calling this function. The 27428427ed84SHans Petter Selasky * pnpinfo of an interface will be reset at device detach or when 27438427ed84SHans Petter Selasky * passing a NULL argument to this function. This function 27448427ed84SHans Petter Selasky * returns zero on success, else a USB_ERR_XXX failure code. 27458427ed84SHans Petter Selasky */ 27468427ed84SHans Petter Selasky 27478427ed84SHans Petter Selasky usb_error_t 27488427ed84SHans Petter Selasky usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo) 27498427ed84SHans Petter Selasky { 27508427ed84SHans Petter Selasky struct usb_interface *iface; 27518427ed84SHans Petter Selasky 27528427ed84SHans Petter Selasky iface = usbd_get_iface(udev, iface_index); 27538427ed84SHans Petter Selasky if (iface == NULL) 27548427ed84SHans Petter Selasky return (USB_ERR_INVAL); 27558427ed84SHans Petter Selasky 27568427ed84SHans Petter Selasky if (iface->pnpinfo != NULL) { 27578427ed84SHans Petter Selasky free(iface->pnpinfo, M_USBDEV); 27588427ed84SHans Petter Selasky iface->pnpinfo = NULL; 27598427ed84SHans Petter Selasky } 27608427ed84SHans Petter Selasky 27618427ed84SHans Petter Selasky if (pnpinfo == NULL || pnpinfo[0] == 0) 27628427ed84SHans Petter Selasky return (0); /* success */ 27638427ed84SHans Petter Selasky 27648427ed84SHans Petter Selasky iface->pnpinfo = strdup(pnpinfo, M_USBDEV); 27658427ed84SHans Petter Selasky if (iface->pnpinfo == NULL) 27668427ed84SHans Petter Selasky return (USB_ERR_NOMEM); 27678427ed84SHans Petter Selasky 27688427ed84SHans Petter Selasky return (0); /* success */ 27698427ed84SHans Petter Selasky } 27708427ed84SHans Petter Selasky 2771d46dc4adSHans Petter Selasky usb_error_t 2772d46dc4adSHans Petter Selasky usbd_add_dynamic_quirk(struct usb_device *udev, uint16_t quirk) 2773d46dc4adSHans Petter Selasky { 2774d46dc4adSHans Petter Selasky uint8_t x; 2775d46dc4adSHans Petter Selasky 2776d46dc4adSHans Petter Selasky for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) { 27773f37fb62SHans Petter Selasky if (udev->autoQuirk[x] == 0 || 27783f37fb62SHans Petter Selasky udev->autoQuirk[x] == quirk) { 2779d46dc4adSHans Petter Selasky udev->autoQuirk[x] = quirk; 2780d46dc4adSHans Petter Selasky return (0); /* success */ 2781d46dc4adSHans Petter Selasky } 2782d46dc4adSHans Petter Selasky } 2783d46dc4adSHans Petter Selasky return (USB_ERR_NOMEM); 2784d46dc4adSHans Petter Selasky } 2785a5cf1aaaSHans Petter Selasky 2786a5cf1aaaSHans Petter Selasky /* 2787a5cf1aaaSHans Petter Selasky * The following function is used to select the endpoint mode. It 2788a5cf1aaaSHans Petter Selasky * should not be called outside enumeration context. 2789a5cf1aaaSHans Petter Selasky */ 2790a5cf1aaaSHans Petter Selasky 2791a5cf1aaaSHans Petter Selasky usb_error_t 2792a5cf1aaaSHans Petter Selasky usbd_set_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep, 2793a5cf1aaaSHans Petter Selasky uint8_t ep_mode) 2794a5cf1aaaSHans Petter Selasky { 2795a5cf1aaaSHans Petter Selasky usb_error_t error; 2796f61fc4bdSHans Petter Selasky uint8_t do_unlock; 2797a5cf1aaaSHans Petter Selasky 27986950c75fSHans Petter Selasky /* Prevent re-enumeration */ 27996950c75fSHans Petter Selasky do_unlock = usbd_enum_lock(udev); 2800a5cf1aaaSHans Petter Selasky 2801a5cf1aaaSHans Petter Selasky if (udev->bus->methods->set_endpoint_mode != NULL) { 2802a5cf1aaaSHans Petter Selasky error = (udev->bus->methods->set_endpoint_mode) ( 2803a5cf1aaaSHans Petter Selasky udev, ep, ep_mode); 2804a5cf1aaaSHans Petter Selasky } else if (ep_mode != USB_EP_MODE_DEFAULT) { 2805a5cf1aaaSHans Petter Selasky error = USB_ERR_INVAL; 2806a5cf1aaaSHans Petter Selasky } else { 2807a5cf1aaaSHans Petter Selasky error = 0; 2808a5cf1aaaSHans Petter Selasky } 2809a5cf1aaaSHans Petter Selasky 2810a5cf1aaaSHans Petter Selasky /* only set new mode regardless of error */ 2811a5cf1aaaSHans Petter Selasky ep->ep_mode = ep_mode; 2812a5cf1aaaSHans Petter Selasky 2813f61fc4bdSHans Petter Selasky if (do_unlock) 2814f61fc4bdSHans Petter Selasky usbd_enum_unlock(udev); 2815a5cf1aaaSHans Petter Selasky return (error); 2816a5cf1aaaSHans Petter Selasky } 2817a5cf1aaaSHans Petter Selasky 2818a5cf1aaaSHans Petter Selasky uint8_t 2819a5cf1aaaSHans Petter Selasky usbd_get_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep) 2820a5cf1aaaSHans Petter Selasky { 2821a5cf1aaaSHans Petter Selasky return (ep->ep_mode); 2822a5cf1aaaSHans Petter Selasky } 2823