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 27ed6d949aSAndrew Thompson #include <sys/stdint.h> 28ed6d949aSAndrew Thompson #include <sys/stddef.h> 29ed6d949aSAndrew Thompson #include <sys/param.h> 30ed6d949aSAndrew Thompson #include <sys/queue.h> 31ed6d949aSAndrew Thompson #include <sys/types.h> 32ed6d949aSAndrew Thompson #include <sys/systm.h> 33ed6d949aSAndrew Thompson #include <sys/kernel.h> 34ed6d949aSAndrew Thompson #include <sys/bus.h> 35ed6d949aSAndrew Thompson #include <sys/module.h> 36ed6d949aSAndrew Thompson #include <sys/lock.h> 37ed6d949aSAndrew Thompson #include <sys/mutex.h> 38ed6d949aSAndrew Thompson #include <sys/condvar.h> 39ed6d949aSAndrew Thompson #include <sys/sysctl.h> 40ed6d949aSAndrew Thompson #include <sys/sx.h> 41ed6d949aSAndrew Thompson #include <sys/unistd.h> 42ed6d949aSAndrew Thompson #include <sys/callout.h> 43ed6d949aSAndrew Thompson #include <sys/malloc.h> 44ed6d949aSAndrew Thompson #include <sys/priv.h> 45ed6d949aSAndrew Thompson #include <sys/conf.h> 46ed6d949aSAndrew Thompson #include <sys/fcntl.h> 47ed6d949aSAndrew Thompson 4802ac6454SAndrew Thompson #include <dev/usb/usb.h> 49ed6d949aSAndrew Thompson #include <dev/usb/usbdi.h> 50ed6d949aSAndrew Thompson #include <dev/usb/usbdi_util.h> 5102ac6454SAndrew Thompson #include <dev/usb/usb_ioctl.h> 52963169b4SHans Petter Selasky 53963169b4SHans Petter Selasky #if USB_HAVE_UGEN 54963169b4SHans Petter Selasky #include <sys/sbuf.h> 55963169b4SHans Petter Selasky #endif 56963169b4SHans Petter Selasky 5702ac6454SAndrew Thompson #include "usbdevs.h" 5802ac6454SAndrew Thompson 59a593f6b8SAndrew Thompson #define USB_DEBUG_VAR usb_debug 6002ac6454SAndrew Thompson 6102ac6454SAndrew Thompson #include <dev/usb/usb_core.h> 6202ac6454SAndrew Thompson #include <dev/usb/usb_debug.h> 6302ac6454SAndrew Thompson #include <dev/usb/usb_process.h> 6402ac6454SAndrew Thompson #include <dev/usb/usb_device.h> 6502ac6454SAndrew Thompson #include <dev/usb/usb_busdma.h> 6602ac6454SAndrew Thompson #include <dev/usb/usb_transfer.h> 6702ac6454SAndrew Thompson #include <dev/usb/usb_request.h> 6802ac6454SAndrew Thompson #include <dev/usb/usb_dynamic.h> 6902ac6454SAndrew Thompson #include <dev/usb/usb_hub.h> 7002ac6454SAndrew Thompson #include <dev/usb/usb_util.h> 7102ac6454SAndrew Thompson #include <dev/usb/usb_msctest.h> 72bdc081c6SAndrew Thompson #if USB_HAVE_UGEN 73bdc081c6SAndrew Thompson #include <dev/usb/usb_dev.h> 7402ac6454SAndrew Thompson #include <dev/usb/usb_generic.h> 75bdc081c6SAndrew Thompson #endif 7602ac6454SAndrew Thompson 7702ac6454SAndrew Thompson #include <dev/usb/quirk/usb_quirk.h> 7802ac6454SAndrew Thompson 7902ac6454SAndrew Thompson #include <dev/usb/usb_controller.h> 8002ac6454SAndrew Thompson #include <dev/usb/usb_bus.h> 8102ac6454SAndrew Thompson 8202ac6454SAndrew Thompson /* function prototypes */ 8302ac6454SAndrew Thompson 84a593f6b8SAndrew Thompson static void usb_init_endpoint(struct usb_device *, uint8_t, 85963169b4SHans Petter Selasky struct usb_endpoint_descriptor *, 86963169b4SHans Petter Selasky struct usb_endpoint_ss_comp_descriptor *, 87963169b4SHans Petter Selasky struct usb_endpoint *); 88a593f6b8SAndrew Thompson static void usb_unconfigure(struct usb_device *, uint8_t); 89a593f6b8SAndrew Thompson static void usb_detach_device_sub(struct usb_device *, device_t *, 908427ed84SHans Petter Selasky char **, uint8_t); 91a593f6b8SAndrew Thompson static uint8_t usb_probe_and_attach_sub(struct usb_device *, 92760bc48eSAndrew Thompson struct usb_attach_arg *); 93a593f6b8SAndrew Thompson static void usb_init_attach_arg(struct usb_device *, 94760bc48eSAndrew Thompson struct usb_attach_arg *); 95a593f6b8SAndrew Thompson static void usb_suspend_resume_sub(struct usb_device *, device_t, 9602ac6454SAndrew Thompson uint8_t); 97a593f6b8SAndrew Thompson static void usbd_clear_stall_proc(struct usb_proc_msg *_pm); 98963169b4SHans Petter Selasky static usb_error_t usb_config_parse(struct usb_device *, uint8_t, uint8_t); 99a593f6b8SAndrew Thompson static void usbd_set_device_strings(struct usb_device *); 1008bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 101a593f6b8SAndrew Thompson static void usb_notify_addq(const char *type, struct usb_device *); 1028bb77249SHans Petter Selasky #endif 1038bb77249SHans Petter Selasky #if USB_HAVE_UGEN 104a593f6b8SAndrew Thompson static void usb_fifo_free_wrap(struct usb_device *, uint8_t, uint8_t); 105a593f6b8SAndrew Thompson static void usb_cdev_create(struct usb_device *); 106a593f6b8SAndrew Thompson static void usb_cdev_free(struct usb_device *); 1070f6e8f93SAndrew Thompson #endif 10802ac6454SAndrew Thompson 10902ac6454SAndrew Thompson /* This variable is global to allow easy access to it: */ 11002ac6454SAndrew Thompson 111a593f6b8SAndrew Thompson int usb_template = 0; 11202ac6454SAndrew Thompson 1137a918edfSAndrew Thompson TUNABLE_INT("hw.usb.usb_template", &usb_template); 1149360ae40SAndrew Thompson SYSCTL_INT(_hw_usb, OID_AUTO, template, CTLFLAG_RW, 115a593f6b8SAndrew Thompson &usb_template, 0, "Selected USB device side template"); 11602ac6454SAndrew Thompson 1177a918edfSAndrew Thompson /* English is default language */ 1187a918edfSAndrew Thompson 1197a918edfSAndrew Thompson static int usb_lang_id = 0x0009; 1207a918edfSAndrew Thompson static int usb_lang_mask = 0x00FF; 1217a918edfSAndrew Thompson 1227a918edfSAndrew Thompson TUNABLE_INT("hw.usb.usb_lang_id", &usb_lang_id); 1237a918edfSAndrew Thompson SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_id, CTLFLAG_RW, 1247a918edfSAndrew Thompson &usb_lang_id, 0, "Preferred USB language ID"); 1257a918edfSAndrew Thompson 1267a918edfSAndrew Thompson TUNABLE_INT("hw.usb.usb_lang_mask", &usb_lang_mask); 1277a918edfSAndrew Thompson SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_mask, CTLFLAG_RW, 1287a918edfSAndrew Thompson &usb_lang_mask, 0, "Preferred USB language mask"); 1297a918edfSAndrew Thompson 1304d4fa6edSAndrew Thompson static const char* statestr[USB_STATE_MAX] = { 1314d4fa6edSAndrew Thompson [USB_STATE_DETACHED] = "DETACHED", 1324d4fa6edSAndrew Thompson [USB_STATE_ATTACHED] = "ATTACHED", 1334d4fa6edSAndrew Thompson [USB_STATE_POWERED] = "POWERED", 1344d4fa6edSAndrew Thompson [USB_STATE_ADDRESSED] = "ADDRESSED", 1354d4fa6edSAndrew Thompson [USB_STATE_CONFIGURED] = "CONFIGURED", 1364d4fa6edSAndrew Thompson }; 1374d4fa6edSAndrew Thompson 1384d4fa6edSAndrew Thompson const char * 139a593f6b8SAndrew Thompson usb_statestr(enum usb_dev_state state) 1404d4fa6edSAndrew Thompson { 141ec8f3127SAndrew Thompson return ((state < USB_STATE_MAX) ? statestr[state] : "UNKNOWN"); 1424d4fa6edSAndrew Thompson } 14302ac6454SAndrew Thompson 144ae538d85SAndrew Thompson const char * 145ae538d85SAndrew Thompson usb_get_manufacturer(struct usb_device *udev) 146ae538d85SAndrew Thompson { 147ae538d85SAndrew Thompson return (udev->manufacturer ? udev->manufacturer : "Unknown"); 148ae538d85SAndrew Thompson } 149ae538d85SAndrew Thompson 150ae538d85SAndrew Thompson const char * 151ae538d85SAndrew Thompson usb_get_product(struct usb_device *udev) 152ae538d85SAndrew Thompson { 153ae538d85SAndrew Thompson return (udev->product ? udev->product : ""); 154ae538d85SAndrew Thompson } 155ae538d85SAndrew Thompson 156ae538d85SAndrew Thompson const char * 157ae538d85SAndrew Thompson usb_get_serial(struct usb_device *udev) 158ae538d85SAndrew Thompson { 159ae538d85SAndrew Thompson return (udev->serial ? udev->serial : ""); 160ae538d85SAndrew Thompson } 161ae538d85SAndrew Thompson 16202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 163a593f6b8SAndrew Thompson * usbd_get_ep_by_addr 16402ac6454SAndrew Thompson * 165ae60fdfbSAndrew Thompson * This function searches for an USB ep by endpoint address and 16602ac6454SAndrew Thompson * direction. 16702ac6454SAndrew Thompson * 16802ac6454SAndrew Thompson * Returns: 16902ac6454SAndrew Thompson * NULL: Failure 17002ac6454SAndrew Thompson * Else: Success 17102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 172ae60fdfbSAndrew Thompson struct usb_endpoint * 173a593f6b8SAndrew Thompson usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val) 17402ac6454SAndrew Thompson { 175ae60fdfbSAndrew Thompson struct usb_endpoint *ep = udev->endpoints; 176ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max; 17702ac6454SAndrew Thompson enum { 17802ac6454SAndrew Thompson EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR), 17902ac6454SAndrew Thompson }; 18002ac6454SAndrew Thompson 18102ac6454SAndrew Thompson /* 18202ac6454SAndrew Thompson * According to the USB specification not all bits are used 18302ac6454SAndrew Thompson * for the endpoint address. Keep defined bits only: 18402ac6454SAndrew Thompson */ 18502ac6454SAndrew Thompson ea_val &= EA_MASK; 18602ac6454SAndrew Thompson 18702ac6454SAndrew Thompson /* 188ae60fdfbSAndrew Thompson * Iterate accross all the USB endpoints searching for a match 18902ac6454SAndrew Thompson * based on the endpoint address: 19002ac6454SAndrew Thompson */ 191ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 19202ac6454SAndrew Thompson 193ae60fdfbSAndrew Thompson if (ep->edesc == NULL) { 19402ac6454SAndrew Thompson continue; 19502ac6454SAndrew Thompson } 19602ac6454SAndrew Thompson /* do the mask and check the value */ 197ae60fdfbSAndrew Thompson if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) { 19802ac6454SAndrew Thompson goto found; 19902ac6454SAndrew Thompson } 20002ac6454SAndrew Thompson } 20102ac6454SAndrew Thompson 20202ac6454SAndrew Thompson /* 203ae60fdfbSAndrew Thompson * The default endpoint is always present and is checked separately: 20402ac6454SAndrew Thompson */ 20522039494SHans Petter Selasky if ((udev->ctrl_ep.edesc != NULL) && 2065b3bb704SAndrew Thompson ((udev->ctrl_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) { 2075b3bb704SAndrew Thompson ep = &udev->ctrl_ep; 20802ac6454SAndrew Thompson goto found; 20902ac6454SAndrew Thompson } 21002ac6454SAndrew Thompson return (NULL); 21102ac6454SAndrew Thompson 21202ac6454SAndrew Thompson found: 213ae60fdfbSAndrew Thompson return (ep); 21402ac6454SAndrew Thompson } 21502ac6454SAndrew Thompson 21602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 217a593f6b8SAndrew Thompson * usbd_get_endpoint 21802ac6454SAndrew Thompson * 219ae60fdfbSAndrew Thompson * This function searches for an USB endpoint based on the information 220760bc48eSAndrew Thompson * given by the passed "struct usb_config" pointer. 22102ac6454SAndrew Thompson * 22202ac6454SAndrew Thompson * Return values: 22302ac6454SAndrew Thompson * NULL: No match. 224ae60fdfbSAndrew Thompson * Else: Pointer to "struct usb_endpoint". 22502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 226ae60fdfbSAndrew Thompson struct usb_endpoint * 227a593f6b8SAndrew Thompson usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index, 228760bc48eSAndrew Thompson const struct usb_config *setup) 22902ac6454SAndrew Thompson { 230ae60fdfbSAndrew Thompson struct usb_endpoint *ep = udev->endpoints; 231ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max; 23202ac6454SAndrew Thompson uint8_t index = setup->ep_index; 23302ac6454SAndrew Thompson uint8_t ea_mask; 23402ac6454SAndrew Thompson uint8_t ea_val; 23502ac6454SAndrew Thompson uint8_t type_mask; 23602ac6454SAndrew Thompson uint8_t type_val; 23702ac6454SAndrew Thompson 23802ac6454SAndrew Thompson DPRINTFN(10, "udev=%p iface_index=%d address=0x%x " 23902ac6454SAndrew Thompson "type=0x%x dir=0x%x index=%d\n", 24002ac6454SAndrew Thompson udev, iface_index, setup->endpoint, 24102ac6454SAndrew Thompson setup->type, setup->direction, setup->ep_index); 24202ac6454SAndrew Thompson 2434eae601eSAndrew Thompson /* check USB mode */ 2444eae601eSAndrew Thompson 245f29a0724SAndrew Thompson if (setup->usb_mode != USB_MODE_DUAL && 246f29a0724SAndrew Thompson udev->flags.usb_mode != setup->usb_mode) { 247ae60fdfbSAndrew Thompson /* wrong mode - no endpoint */ 2484eae601eSAndrew Thompson return (NULL); 2494eae601eSAndrew Thompson } 2504eae601eSAndrew Thompson 25102ac6454SAndrew Thompson /* setup expected endpoint direction mask and value */ 25202ac6454SAndrew Thompson 25351ec1603SAndrew Thompson if (setup->direction == UE_DIR_RX) { 25451ec1603SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 255f29a0724SAndrew Thompson ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ? 25651ec1603SAndrew Thompson UE_DIR_OUT : UE_DIR_IN; 25751ec1603SAndrew Thompson } else if (setup->direction == UE_DIR_TX) { 25851ec1603SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 259f29a0724SAndrew Thompson ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ? 26051ec1603SAndrew Thompson UE_DIR_IN : UE_DIR_OUT; 26151ec1603SAndrew Thompson } else if (setup->direction == UE_DIR_ANY) { 26202ac6454SAndrew Thompson /* match any endpoint direction */ 26302ac6454SAndrew Thompson ea_mask = 0; 26402ac6454SAndrew Thompson ea_val = 0; 26502ac6454SAndrew Thompson } else { 26602ac6454SAndrew Thompson /* match the given endpoint direction */ 26702ac6454SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 26802ac6454SAndrew Thompson ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT)); 26902ac6454SAndrew Thompson } 27002ac6454SAndrew Thompson 27102ac6454SAndrew Thompson /* setup expected endpoint address */ 27202ac6454SAndrew Thompson 27302ac6454SAndrew Thompson if (setup->endpoint == UE_ADDR_ANY) { 27402ac6454SAndrew Thompson /* match any endpoint address */ 27502ac6454SAndrew Thompson } else { 27602ac6454SAndrew Thompson /* match the given endpoint address */ 27702ac6454SAndrew Thompson ea_mask |= UE_ADDR; 27802ac6454SAndrew Thompson ea_val |= (setup->endpoint & UE_ADDR); 27902ac6454SAndrew Thompson } 28002ac6454SAndrew Thompson 28102ac6454SAndrew Thompson /* setup expected endpoint type */ 28202ac6454SAndrew Thompson 28302ac6454SAndrew Thompson if (setup->type == UE_BULK_INTR) { 28402ac6454SAndrew Thompson /* this will match BULK and INTERRUPT endpoints */ 28502ac6454SAndrew Thompson type_mask = 2; 28602ac6454SAndrew Thompson type_val = 2; 28702ac6454SAndrew Thompson } else if (setup->type == UE_TYPE_ANY) { 28802ac6454SAndrew Thompson /* match any endpoint type */ 28902ac6454SAndrew Thompson type_mask = 0; 29002ac6454SAndrew Thompson type_val = 0; 29102ac6454SAndrew Thompson } else { 29202ac6454SAndrew Thompson /* match the given endpoint type */ 29302ac6454SAndrew Thompson type_mask = UE_XFERTYPE; 29402ac6454SAndrew Thompson type_val = (setup->type & UE_XFERTYPE); 29502ac6454SAndrew Thompson } 29602ac6454SAndrew Thompson 29702ac6454SAndrew Thompson /* 298ae60fdfbSAndrew Thompson * Iterate accross all the USB endpoints searching for a match 29902ac6454SAndrew Thompson * based on the endpoint address. Note that we are searching 300ae60fdfbSAndrew Thompson * the endpoints from the beginning of the "udev->endpoints" array. 30102ac6454SAndrew Thompson */ 302ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 30302ac6454SAndrew Thompson 304ae60fdfbSAndrew Thompson if ((ep->edesc == NULL) || 305ae60fdfbSAndrew Thompson (ep->iface_index != iface_index)) { 30602ac6454SAndrew Thompson continue; 30702ac6454SAndrew Thompson } 30802ac6454SAndrew Thompson /* do the masks and check the values */ 30902ac6454SAndrew Thompson 310ae60fdfbSAndrew Thompson if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) && 311ae60fdfbSAndrew Thompson ((ep->edesc->bmAttributes & type_mask) == type_val)) { 31202ac6454SAndrew Thompson if (!index--) { 31302ac6454SAndrew Thompson goto found; 31402ac6454SAndrew Thompson } 31502ac6454SAndrew Thompson } 31602ac6454SAndrew Thompson } 31702ac6454SAndrew Thompson 31802ac6454SAndrew Thompson /* 319ae60fdfbSAndrew Thompson * Match against default endpoint last, so that "any endpoint", "any 320ae60fdfbSAndrew Thompson * address" and "any direction" returns the first endpoint of the 32102ac6454SAndrew Thompson * interface. "iface_index" and "direction" is ignored: 32202ac6454SAndrew Thompson */ 32322039494SHans Petter Selasky if ((udev->ctrl_ep.edesc != NULL) && 3245b3bb704SAndrew Thompson ((udev->ctrl_ep.edesc->bEndpointAddress & ea_mask) == ea_val) && 3255b3bb704SAndrew Thompson ((udev->ctrl_ep.edesc->bmAttributes & type_mask) == type_val) && 32602ac6454SAndrew Thompson (!index)) { 3275b3bb704SAndrew Thompson ep = &udev->ctrl_ep; 32802ac6454SAndrew Thompson goto found; 32902ac6454SAndrew Thompson } 33002ac6454SAndrew Thompson return (NULL); 33102ac6454SAndrew Thompson 33202ac6454SAndrew Thompson found: 333ae60fdfbSAndrew Thompson return (ep); 33402ac6454SAndrew Thompson } 33502ac6454SAndrew Thompson 33602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 337ed6d949aSAndrew Thompson * usbd_interface_count 33802ac6454SAndrew Thompson * 33902ac6454SAndrew Thompson * This function stores the number of USB interfaces excluding 34002ac6454SAndrew Thompson * alternate settings, which the USB config descriptor reports into 34102ac6454SAndrew Thompson * the unsigned 8-bit integer pointed to by "count". 34202ac6454SAndrew Thompson * 34302ac6454SAndrew Thompson * Returns: 34402ac6454SAndrew Thompson * 0: Success 34502ac6454SAndrew Thompson * Else: Failure 34602ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 347e0a69b51SAndrew Thompson usb_error_t 348ed6d949aSAndrew Thompson usbd_interface_count(struct usb_device *udev, uint8_t *count) 34902ac6454SAndrew Thompson { 35002ac6454SAndrew Thompson if (udev->cdesc == NULL) { 35102ac6454SAndrew Thompson *count = 0; 35202ac6454SAndrew Thompson return (USB_ERR_NOT_CONFIGURED); 35302ac6454SAndrew Thompson } 354bdd41206SAndrew Thompson *count = udev->ifaces_max; 35502ac6454SAndrew Thompson return (USB_ERR_NORMAL_COMPLETION); 35602ac6454SAndrew Thompson } 35702ac6454SAndrew Thompson 35802ac6454SAndrew Thompson /*------------------------------------------------------------------------* 359a593f6b8SAndrew Thompson * usb_init_endpoint 36002ac6454SAndrew Thompson * 361ae60fdfbSAndrew Thompson * This function will initialise the USB endpoint structure pointed to by 362ae60fdfbSAndrew Thompson * the "endpoint" argument. The structure pointed to by "endpoint" must be 363bdd41206SAndrew Thompson * zeroed before calling this function. 36402ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 36502ac6454SAndrew Thompson static void 366a593f6b8SAndrew Thompson usb_init_endpoint(struct usb_device *udev, uint8_t iface_index, 367963169b4SHans Petter Selasky struct usb_endpoint_descriptor *edesc, 368963169b4SHans Petter Selasky struct usb_endpoint_ss_comp_descriptor *ecomp, 369963169b4SHans Petter Selasky struct usb_endpoint *ep) 37002ac6454SAndrew Thompson { 371760bc48eSAndrew Thompson struct usb_bus_methods *methods; 372a5cf1aaaSHans Petter Selasky usb_stream_t x; 373ee3e3ff5SAndrew Thompson 374bdd41206SAndrew Thompson methods = udev->bus->methods; 37502ac6454SAndrew Thompson 376ae60fdfbSAndrew Thompson (methods->endpoint_init) (udev, edesc, ep); 37702ac6454SAndrew Thompson 378ae60fdfbSAndrew Thompson /* initialise USB endpoint structure */ 379ae60fdfbSAndrew Thompson ep->edesc = edesc; 380963169b4SHans Petter Selasky ep->ecomp = ecomp; 381ae60fdfbSAndrew Thompson ep->iface_index = iface_index; 382a5cf1aaaSHans Petter Selasky 383a5cf1aaaSHans Petter Selasky /* setup USB stream queues */ 384a5cf1aaaSHans Petter Selasky for (x = 0; x != USB_MAX_EP_STREAMS; x++) { 385a5cf1aaaSHans Petter Selasky TAILQ_INIT(&ep->endpoint_q[x].head); 386a5cf1aaaSHans Petter Selasky ep->endpoint_q[x].command = &usbd_pipe_start; 387a5cf1aaaSHans Petter Selasky } 38802ac6454SAndrew Thompson 38939307315SAndrew Thompson /* the pipe is not supported by the hardware */ 390ae60fdfbSAndrew Thompson if (ep->methods == NULL) 39139307315SAndrew Thompson return; 39239307315SAndrew Thompson 393a5cf1aaaSHans Petter Selasky /* check for SUPER-speed streams mode endpoint */ 394a5cf1aaaSHans Petter Selasky if (udev->speed == USB_SPEED_SUPER && ecomp != NULL && 395a5cf1aaaSHans Petter Selasky (edesc->bmAttributes & UE_XFERTYPE) == UE_BULK && 396a5cf1aaaSHans Petter Selasky (UE_GET_BULK_STREAMS(ecomp->bmAttributes) != 0)) { 397a5cf1aaaSHans Petter Selasky usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_STREAMS); 398a5cf1aaaSHans Petter Selasky } else { 399a5cf1aaaSHans Petter Selasky usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_DEFAULT); 400a5cf1aaaSHans Petter Selasky } 401a5cf1aaaSHans Petter Selasky 40202ac6454SAndrew Thompson /* clear stall, if any */ 403bdd41206SAndrew Thompson if (methods->clear_stall != NULL) { 40402ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 405ae60fdfbSAndrew Thompson (methods->clear_stall) (udev, ep); 40602ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 40702ac6454SAndrew Thompson } 40802ac6454SAndrew Thompson } 40902ac6454SAndrew Thompson 410bdd41206SAndrew Thompson /*-----------------------------------------------------------------------* 411a593f6b8SAndrew Thompson * usb_endpoint_foreach 41216589beaSAndrew Thompson * 41316589beaSAndrew Thompson * This function will iterate all the USB endpoints except the control 41416589beaSAndrew Thompson * endpoint. This function is NULL safe. 41516589beaSAndrew Thompson * 41616589beaSAndrew Thompson * Return values: 417ae60fdfbSAndrew Thompson * NULL: End of USB endpoints 418ae60fdfbSAndrew Thompson * Else: Pointer to next USB endpoint 41916589beaSAndrew Thompson *------------------------------------------------------------------------*/ 420ae60fdfbSAndrew Thompson struct usb_endpoint * 421a593f6b8SAndrew Thompson usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep) 42216589beaSAndrew Thompson { 423a9e26757SAndrew Thompson struct usb_endpoint *ep_end; 42416589beaSAndrew Thompson 42516589beaSAndrew Thompson /* be NULL safe */ 42616589beaSAndrew Thompson if (udev == NULL) 42716589beaSAndrew Thompson return (NULL); 42816589beaSAndrew Thompson 429a9e26757SAndrew Thompson ep_end = udev->endpoints + udev->endpoints_max; 430a9e26757SAndrew Thompson 431ae60fdfbSAndrew Thompson /* get next endpoint */ 432ae60fdfbSAndrew Thompson if (ep == NULL) 433ae60fdfbSAndrew Thompson ep = udev->endpoints; 43416589beaSAndrew Thompson else 435ae60fdfbSAndrew Thompson ep++; 43616589beaSAndrew Thompson 437ae60fdfbSAndrew Thompson /* find next allocated ep */ 438ae60fdfbSAndrew Thompson while (ep != ep_end) { 439ae60fdfbSAndrew Thompson if (ep->edesc != NULL) 440ae60fdfbSAndrew Thompson return (ep); 441ae60fdfbSAndrew Thompson ep++; 44216589beaSAndrew Thompson } 44316589beaSAndrew Thompson return (NULL); 44416589beaSAndrew Thompson } 44516589beaSAndrew Thompson 44616589beaSAndrew Thompson /*------------------------------------------------------------------------* 447a593f6b8SAndrew Thompson * usb_unconfigure 44802ac6454SAndrew Thompson * 449ae60fdfbSAndrew Thompson * This function will free all USB interfaces and USB endpoints belonging 45002ac6454SAndrew Thompson * to an USB device. 451bdd41206SAndrew Thompson * 452bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 45302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 45402ac6454SAndrew Thompson static void 455a593f6b8SAndrew Thompson usb_unconfigure(struct usb_device *udev, uint8_t flag) 45602ac6454SAndrew Thompson { 457bdd41206SAndrew Thompson uint8_t do_unlock; 45802ac6454SAndrew Thompson 459bdd41206SAndrew Thompson /* automatic locking */ 460cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 461bdd41206SAndrew Thompson do_unlock = 0; 462bdd41206SAndrew Thompson } else { 463bdd41206SAndrew Thompson do_unlock = 1; 464cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 465bdd41206SAndrew Thompson } 466bdd41206SAndrew Thompson 467bdd41206SAndrew Thompson /* detach all interface drivers */ 468a593f6b8SAndrew Thompson usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag); 469bdd41206SAndrew Thompson 470bdd41206SAndrew Thompson #if USB_HAVE_UGEN 471bdd41206SAndrew Thompson /* free all FIFOs except control endpoint FIFOs */ 472a593f6b8SAndrew Thompson usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag); 473bdd41206SAndrew Thompson 474bdd41206SAndrew Thompson /* 475bdd41206SAndrew Thompson * Free all cdev's, if any. 476bdd41206SAndrew Thompson */ 477a593f6b8SAndrew Thompson usb_cdev_free(udev); 478bdd41206SAndrew Thompson #endif 47902ac6454SAndrew Thompson 480bdc081c6SAndrew Thompson #if USB_HAVE_COMPAT_LINUX 48102ac6454SAndrew Thompson /* free Linux compat device, if any */ 482760bc48eSAndrew Thompson if (udev->linux_endpoint_start) { 483760bc48eSAndrew Thompson usb_linux_free_device(udev); 484760bc48eSAndrew Thompson udev->linux_endpoint_start = NULL; 48502ac6454SAndrew Thompson } 486bdc081c6SAndrew Thompson #endif 48702ac6454SAndrew Thompson 488a593f6b8SAndrew Thompson usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE); 48902ac6454SAndrew Thompson 490ae60fdfbSAndrew Thompson /* free "cdesc" after "ifaces" and "endpoints", if any */ 4917efaaa9aSAndrew Thompson if (udev->cdesc != NULL) { 492f29a0724SAndrew Thompson if (udev->flags.usb_mode != USB_MODE_DEVICE) 49302ac6454SAndrew Thompson free(udev->cdesc, M_USB); 49402ac6454SAndrew Thompson udev->cdesc = NULL; 49502ac6454SAndrew Thompson } 49602ac6454SAndrew Thompson /* set unconfigured state */ 49702ac6454SAndrew Thompson udev->curr_config_no = USB_UNCONFIG_NO; 49802ac6454SAndrew Thompson udev->curr_config_index = USB_UNCONFIG_INDEX; 499bdd41206SAndrew Thompson 500cb18f7d1SAlfred Perlstein if (do_unlock) 501cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 50202ac6454SAndrew Thompson } 50302ac6454SAndrew Thompson 50402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 505a593f6b8SAndrew Thompson * usbd_set_config_index 50602ac6454SAndrew Thompson * 50702ac6454SAndrew Thompson * This function selects configuration by index, independent of the 50802ac6454SAndrew Thompson * actual configuration number. This function should not be used by 50902ac6454SAndrew Thompson * USB drivers. 51002ac6454SAndrew Thompson * 51102ac6454SAndrew Thompson * Returns: 51202ac6454SAndrew Thompson * 0: Success 51302ac6454SAndrew Thompson * Else: Failure 51402ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 515e0a69b51SAndrew Thompson usb_error_t 516a593f6b8SAndrew Thompson usbd_set_config_index(struct usb_device *udev, uint8_t index) 51702ac6454SAndrew Thompson { 518760bc48eSAndrew Thompson struct usb_status ds; 519760bc48eSAndrew Thompson struct usb_config_descriptor *cdp; 52002ac6454SAndrew Thompson uint16_t power; 52102ac6454SAndrew Thompson uint16_t max_power; 52202ac6454SAndrew Thompson uint8_t selfpowered; 52302ac6454SAndrew Thompson uint8_t do_unlock; 524e0a69b51SAndrew Thompson usb_error_t err; 52502ac6454SAndrew Thompson 52602ac6454SAndrew Thompson DPRINTFN(6, "udev=%p index=%d\n", udev, index); 52702ac6454SAndrew Thompson 52802ac6454SAndrew Thompson /* automatic locking */ 529cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 53002ac6454SAndrew Thompson do_unlock = 0; 53102ac6454SAndrew Thompson } else { 53202ac6454SAndrew Thompson do_unlock = 1; 533cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 53402ac6454SAndrew Thompson } 53502ac6454SAndrew Thompson 536d88688c7SAndrew Thompson usb_unconfigure(udev, 0); 53702ac6454SAndrew Thompson 53802ac6454SAndrew Thompson if (index == USB_UNCONFIG_INDEX) { 53902ac6454SAndrew Thompson /* 54002ac6454SAndrew Thompson * Leave unallocated when unconfiguring the 541a593f6b8SAndrew Thompson * device. "usb_unconfigure()" will also reset 54202ac6454SAndrew Thompson * the current config number and index. 54302ac6454SAndrew Thompson */ 544a593f6b8SAndrew Thompson err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO); 545bd216778SAndrew Thompson if (udev->state == USB_STATE_CONFIGURED) 546a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_ADDRESSED); 54702ac6454SAndrew Thompson goto done; 54802ac6454SAndrew Thompson } 54902ac6454SAndrew Thompson /* get the full config descriptor */ 550f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 5517efaaa9aSAndrew Thompson /* save some memory */ 552a593f6b8SAndrew Thompson err = usbd_req_get_descriptor_ptr(udev, &cdp, 553459d369eSAndrew Thompson (UDESC_CONFIG << 8) | index); 5547efaaa9aSAndrew Thompson } else { 5557efaaa9aSAndrew Thompson /* normal request */ 556a593f6b8SAndrew Thompson err = usbd_req_get_config_desc_full(udev, 557e2805033SAndrew Thompson NULL, &cdp, M_USB, index); 5587efaaa9aSAndrew Thompson } 55902ac6454SAndrew Thompson if (err) { 56002ac6454SAndrew Thompson goto done; 56102ac6454SAndrew Thompson } 56202ac6454SAndrew Thompson /* set the new config descriptor */ 56302ac6454SAndrew Thompson 56402ac6454SAndrew Thompson udev->cdesc = cdp; 56502ac6454SAndrew Thompson 56602ac6454SAndrew Thompson /* Figure out if the device is self or bus powered. */ 56702ac6454SAndrew Thompson selfpowered = 0; 56802ac6454SAndrew Thompson if ((!udev->flags.uq_bus_powered) && 56902ac6454SAndrew Thompson (cdp->bmAttributes & UC_SELF_POWERED) && 570f29a0724SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST)) { 57102ac6454SAndrew Thompson /* May be self powered. */ 57202ac6454SAndrew Thompson if (cdp->bmAttributes & UC_BUS_POWERED) { 57302ac6454SAndrew Thompson /* Must ask device. */ 574a593f6b8SAndrew Thompson err = usbd_req_get_device_status(udev, NULL, &ds); 57502ac6454SAndrew Thompson if (err) { 57602ac6454SAndrew Thompson DPRINTFN(0, "could not read " 57702ac6454SAndrew Thompson "device status: %s\n", 578a593f6b8SAndrew Thompson usbd_errstr(err)); 57902ac6454SAndrew Thompson } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) { 58002ac6454SAndrew Thompson selfpowered = 1; 58102ac6454SAndrew Thompson } 58202ac6454SAndrew Thompson DPRINTF("status=0x%04x \n", 58302ac6454SAndrew Thompson UGETW(ds.wStatus)); 58402ac6454SAndrew Thompson } else 58502ac6454SAndrew Thompson selfpowered = 1; 58602ac6454SAndrew Thompson } 58702ac6454SAndrew Thompson DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, " 58802ac6454SAndrew Thompson "selfpowered=%d, power=%d\n", 58902ac6454SAndrew Thompson udev, cdp, 59091f72cedSAndrew Thompson udev->address, cdp->bConfigurationValue, cdp->bmAttributes, 59102ac6454SAndrew Thompson selfpowered, cdp->bMaxPower * 2); 59202ac6454SAndrew Thompson 59302ac6454SAndrew Thompson /* Check if we have enough power. */ 59402ac6454SAndrew Thompson power = cdp->bMaxPower * 2; 59502ac6454SAndrew Thompson 59602ac6454SAndrew Thompson if (udev->parent_hub) { 59702ac6454SAndrew Thompson max_power = udev->parent_hub->hub->portpower; 59802ac6454SAndrew Thompson } else { 59902ac6454SAndrew Thompson max_power = USB_MAX_POWER; 60002ac6454SAndrew Thompson } 60102ac6454SAndrew Thompson 60202ac6454SAndrew Thompson if (power > max_power) { 60302ac6454SAndrew Thompson DPRINTFN(0, "power exceeded %d > %d\n", power, max_power); 60402ac6454SAndrew Thompson err = USB_ERR_NO_POWER; 60502ac6454SAndrew Thompson goto done; 60602ac6454SAndrew Thompson } 60702ac6454SAndrew Thompson /* Only update "self_powered" in USB Host Mode */ 608f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_HOST) { 60902ac6454SAndrew Thompson udev->flags.self_powered = selfpowered; 61002ac6454SAndrew Thompson } 61102ac6454SAndrew Thompson udev->power = power; 61202ac6454SAndrew Thompson udev->curr_config_no = cdp->bConfigurationValue; 61302ac6454SAndrew Thompson udev->curr_config_index = index; 614a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_CONFIGURED); 61502ac6454SAndrew Thompson 61602ac6454SAndrew Thompson /* Set the actual configuration value. */ 617a593f6b8SAndrew Thompson err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue); 61802ac6454SAndrew Thompson if (err) { 61902ac6454SAndrew Thompson goto done; 62002ac6454SAndrew Thompson } 621bdd41206SAndrew Thompson 622a593f6b8SAndrew Thompson err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC); 62302ac6454SAndrew Thompson if (err) { 62402ac6454SAndrew Thompson goto done; 62502ac6454SAndrew Thompson } 626bdd41206SAndrew Thompson 627a593f6b8SAndrew Thompson err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT); 628bdd41206SAndrew Thompson if (err) { 629bdd41206SAndrew Thompson goto done; 63002ac6454SAndrew Thompson } 631bdd41206SAndrew Thompson 6320f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 633ee3e3ff5SAndrew Thompson /* create device nodes for each endpoint */ 634a593f6b8SAndrew Thompson usb_cdev_create(udev); 6350f6e8f93SAndrew Thompson #endif 63602ac6454SAndrew Thompson 63702ac6454SAndrew Thompson done: 638a593f6b8SAndrew Thompson DPRINTF("error=%s\n", usbd_errstr(err)); 63902ac6454SAndrew Thompson if (err) { 640d88688c7SAndrew Thompson usb_unconfigure(udev, 0); 64102ac6454SAndrew Thompson } 642cb18f7d1SAlfred Perlstein if (do_unlock) 643cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 64402ac6454SAndrew Thompson return (err); 64502ac6454SAndrew Thompson } 64602ac6454SAndrew Thompson 64702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 648a593f6b8SAndrew Thompson * usb_config_parse 649bdd41206SAndrew Thompson * 650ae60fdfbSAndrew Thompson * This function will allocate and free USB interfaces and USB endpoints, 651ae60fdfbSAndrew Thompson * parse the USB configuration structure and initialise the USB endpoints 652bdd41206SAndrew Thompson * and interfaces. If "iface_index" is not equal to 653bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the 654bdd41206SAndrew Thompson * alternate_setting to be selected for the given interface. Else the 655bdd41206SAndrew Thompson * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be 656bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function 657bdd41206SAndrew Thompson * is typically called when setting the configuration or when setting 658bdd41206SAndrew Thompson * an alternate interface. 659bdd41206SAndrew Thompson * 660bdd41206SAndrew Thompson * Returns: 661bdd41206SAndrew Thompson * 0: Success 662bdd41206SAndrew Thompson * Else: Failure 663bdd41206SAndrew Thompson *------------------------------------------------------------------------*/ 664963169b4SHans Petter Selasky static usb_error_t 665a593f6b8SAndrew Thompson usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd) 666bdd41206SAndrew Thompson { 667760bc48eSAndrew Thompson struct usb_idesc_parse_state ips; 668760bc48eSAndrew Thompson struct usb_interface_descriptor *id; 669760bc48eSAndrew Thompson struct usb_endpoint_descriptor *ed; 670760bc48eSAndrew Thompson struct usb_interface *iface; 671ae60fdfbSAndrew Thompson struct usb_endpoint *ep; 672e0a69b51SAndrew Thompson usb_error_t err; 673bdd41206SAndrew Thompson uint8_t ep_curr; 674bdd41206SAndrew Thompson uint8_t ep_max; 675bdd41206SAndrew Thompson uint8_t temp; 676bdd41206SAndrew Thompson uint8_t do_init; 677bdd41206SAndrew Thompson uint8_t alt_index; 678bdd41206SAndrew Thompson 679bdd41206SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 680bdd41206SAndrew Thompson /* parameter overload */ 681bdd41206SAndrew Thompson alt_index = cmd; 682bdd41206SAndrew Thompson cmd = USB_CFG_INIT; 683bdd41206SAndrew Thompson } else { 684bdd41206SAndrew Thompson /* not used */ 685bdd41206SAndrew Thompson alt_index = 0; 686bdd41206SAndrew Thompson } 687bdd41206SAndrew Thompson 688bdd41206SAndrew Thompson err = 0; 689bdd41206SAndrew Thompson 690bdd41206SAndrew Thompson DPRINTFN(5, "iface_index=%d cmd=%d\n", 691bdd41206SAndrew Thompson iface_index, cmd); 692bdd41206SAndrew Thompson 693bdd41206SAndrew Thompson if (cmd == USB_CFG_FREE) 694bdd41206SAndrew Thompson goto cleanup; 695bdd41206SAndrew Thompson 696bdd41206SAndrew Thompson if (cmd == USB_CFG_INIT) { 69791cd9240SAndrew Thompson sx_assert(&udev->enum_sx, SA_LOCKED); 698bdd41206SAndrew Thompson 699ae60fdfbSAndrew Thompson /* check for in-use endpoints */ 700bdd41206SAndrew Thompson 701ae60fdfbSAndrew Thompson ep = udev->endpoints; 702ae60fdfbSAndrew Thompson ep_max = udev->endpoints_max; 703bdd41206SAndrew Thompson while (ep_max--) { 704ae60fdfbSAndrew Thompson /* look for matching endpoints */ 705bdd41206SAndrew Thompson if ((iface_index == USB_IFACE_INDEX_ANY) || 706ae60fdfbSAndrew Thompson (iface_index == ep->iface_index)) { 707f12c6c29SAndrew Thompson if (ep->refcount_alloc != 0) { 708bdd41206SAndrew Thompson /* 709bdd41206SAndrew Thompson * This typically indicates a 710bdd41206SAndrew Thompson * more serious error. 711bdd41206SAndrew Thompson */ 712bdd41206SAndrew Thompson err = USB_ERR_IN_USE; 713bdd41206SAndrew Thompson } else { 714ae60fdfbSAndrew Thompson /* reset endpoint */ 715ae60fdfbSAndrew Thompson memset(ep, 0, sizeof(*ep)); 716ae60fdfbSAndrew Thompson /* make sure we don't zero the endpoint again */ 717ae60fdfbSAndrew Thompson ep->iface_index = USB_IFACE_INDEX_ANY; 718bdd41206SAndrew Thompson } 719bdd41206SAndrew Thompson } 720ae60fdfbSAndrew Thompson ep++; 721bdd41206SAndrew Thompson } 722bdd41206SAndrew Thompson 723bdd41206SAndrew Thompson if (err) 724bdd41206SAndrew Thompson return (err); 725bdd41206SAndrew Thompson } 726bdd41206SAndrew Thompson 727bdd41206SAndrew Thompson memset(&ips, 0, sizeof(ips)); 728bdd41206SAndrew Thompson 729bdd41206SAndrew Thompson ep_curr = 0; 730bdd41206SAndrew Thompson ep_max = 0; 731bdd41206SAndrew Thompson 732a593f6b8SAndrew Thompson while ((id = usb_idesc_foreach(udev->cdesc, &ips))) { 733bdd41206SAndrew Thompson 734bdd41206SAndrew Thompson /* check for interface overflow */ 735bdd41206SAndrew Thompson if (ips.iface_index == USB_IFACE_MAX) 736bdd41206SAndrew Thompson break; /* crazy */ 737bdd41206SAndrew Thompson 738bdd41206SAndrew Thompson iface = udev->ifaces + ips.iface_index; 739bdd41206SAndrew Thompson 740bdd41206SAndrew Thompson /* check for specific interface match */ 741bdd41206SAndrew Thompson 742bdd41206SAndrew Thompson if (cmd == USB_CFG_INIT) { 743bdd41206SAndrew Thompson if ((iface_index != USB_IFACE_INDEX_ANY) && 744bdd41206SAndrew Thompson (iface_index != ips.iface_index)) { 745bdd41206SAndrew Thompson /* wrong interface */ 746bdd41206SAndrew Thompson do_init = 0; 747bdd41206SAndrew Thompson } else if (alt_index != ips.iface_index_alt) { 748bdd41206SAndrew Thompson /* wrong alternate setting */ 749bdd41206SAndrew Thompson do_init = 0; 750bdd41206SAndrew Thompson } else { 751bdd41206SAndrew Thompson /* initialise interface */ 752bdd41206SAndrew Thompson do_init = 1; 753bdd41206SAndrew Thompson } 754bdd41206SAndrew Thompson } else 755bdd41206SAndrew Thompson do_init = 0; 756bdd41206SAndrew Thompson 757bdd41206SAndrew Thompson /* check for new interface */ 758bdd41206SAndrew Thompson if (ips.iface_index_alt == 0) { 759bdd41206SAndrew Thompson /* update current number of endpoints */ 760bdd41206SAndrew Thompson ep_curr = ep_max; 761bdd41206SAndrew Thompson } 762bdd41206SAndrew Thompson /* check for init */ 763bdd41206SAndrew Thompson if (do_init) { 764bdd41206SAndrew Thompson /* setup the USB interface structure */ 765bdd41206SAndrew Thompson iface->idesc = id; 766bdd41206SAndrew Thompson /* set alternate index */ 767bdd41206SAndrew Thompson iface->alt_index = alt_index; 768d9073c1eSHans Petter Selasky /* set default interface parent */ 769d9073c1eSHans Petter Selasky if (iface_index == USB_IFACE_INDEX_ANY) { 770d9073c1eSHans Petter Selasky iface->parent_iface_index = 771d9073c1eSHans Petter Selasky USB_IFACE_INDEX_ANY; 772d9073c1eSHans Petter Selasky } 773bdd41206SAndrew Thompson } 774bdd41206SAndrew Thompson 775bdd41206SAndrew Thompson DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints); 776bdd41206SAndrew Thompson 777760bc48eSAndrew Thompson ed = (struct usb_endpoint_descriptor *)id; 778bdd41206SAndrew Thompson 779bdd41206SAndrew Thompson temp = ep_curr; 780bdd41206SAndrew Thompson 781bdd41206SAndrew Thompson /* iterate all the endpoint descriptors */ 782a593f6b8SAndrew Thompson while ((ed = usb_edesc_foreach(udev->cdesc, ed))) { 783bdd41206SAndrew Thompson 784bdd41206SAndrew Thompson if (temp == USB_EP_MAX) 785bdd41206SAndrew Thompson break; /* crazy */ 786bdd41206SAndrew Thompson 787ae60fdfbSAndrew Thompson ep = udev->endpoints + temp; 788bdd41206SAndrew Thompson 789bdd41206SAndrew Thompson if (do_init) { 790963169b4SHans Petter Selasky void *ecomp; 791963169b4SHans Petter Selasky 792963169b4SHans Petter Selasky ecomp = usb_ed_comp_foreach(udev->cdesc, (void *)ed); 793963169b4SHans Petter Selasky if (ecomp != NULL) 794963169b4SHans Petter Selasky DPRINTFN(5, "Found endpoint companion descriptor\n"); 795963169b4SHans Petter Selasky 796a593f6b8SAndrew Thompson usb_init_endpoint(udev, 797963169b4SHans Petter Selasky ips.iface_index, ed, ecomp, ep); 798bdd41206SAndrew Thompson } 799bdd41206SAndrew Thompson 800bdd41206SAndrew Thompson temp ++; 801bdd41206SAndrew Thompson 802bdd41206SAndrew Thompson /* find maximum number of endpoints */ 803bdd41206SAndrew Thompson if (ep_max < temp) 804bdd41206SAndrew Thompson ep_max = temp; 805bdd41206SAndrew Thompson 806bdd41206SAndrew Thompson /* optimalisation */ 807760bc48eSAndrew Thompson id = (struct usb_interface_descriptor *)ed; 808bdd41206SAndrew Thompson } 809bdd41206SAndrew Thompson } 810bdd41206SAndrew Thompson 811bdd41206SAndrew Thompson /* NOTE: It is valid to have no interfaces and no endpoints! */ 812bdd41206SAndrew Thompson 813bdd41206SAndrew Thompson if (cmd == USB_CFG_ALLOC) { 814bdd41206SAndrew Thompson udev->ifaces_max = ips.iface_index; 815bdd41206SAndrew Thompson udev->ifaces = NULL; 816bdd41206SAndrew Thompson if (udev->ifaces_max != 0) { 817bdd41206SAndrew Thompson udev->ifaces = malloc(sizeof(*iface) * udev->ifaces_max, 818bdd41206SAndrew Thompson M_USB, M_WAITOK | M_ZERO); 819bdd41206SAndrew Thompson if (udev->ifaces == NULL) { 820bdd41206SAndrew Thompson err = USB_ERR_NOMEM; 821bdd41206SAndrew Thompson goto done; 822bdd41206SAndrew Thompson } 823bdd41206SAndrew Thompson } 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 } 8349469c929SAndrew Thompson USB_BUS_LOCK(udev->bus); 835ae60fdfbSAndrew Thompson udev->endpoints_max = ep_max; 8369469c929SAndrew Thompson /* reset any ongoing clear-stall */ 837ae60fdfbSAndrew Thompson udev->ep_curr = NULL; 8389469c929SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 839bdd41206SAndrew Thompson } 840bdd41206SAndrew Thompson 841bdd41206SAndrew Thompson done: 842bdd41206SAndrew Thompson if (err) { 843bdd41206SAndrew Thompson if (cmd == USB_CFG_ALLOC) { 844bdd41206SAndrew Thompson cleanup: 8459469c929SAndrew Thompson USB_BUS_LOCK(udev->bus); 846ae60fdfbSAndrew Thompson udev->endpoints_max = 0; 8479469c929SAndrew Thompson /* reset any ongoing clear-stall */ 848ae60fdfbSAndrew Thompson udev->ep_curr = NULL; 8499469c929SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 8509469c929SAndrew Thompson 851bdd41206SAndrew Thompson /* cleanup */ 852bdd41206SAndrew Thompson if (udev->ifaces != NULL) 853bdd41206SAndrew Thompson free(udev->ifaces, M_USB); 854ae60fdfbSAndrew Thompson if (udev->endpoints != NULL) 855ae60fdfbSAndrew Thompson free(udev->endpoints, M_USB); 856bdd41206SAndrew Thompson 857bdd41206SAndrew Thompson udev->ifaces = NULL; 858ae60fdfbSAndrew Thompson udev->endpoints = NULL; 859bdd41206SAndrew Thompson udev->ifaces_max = 0; 860bdd41206SAndrew Thompson } 861bdd41206SAndrew Thompson } 862bdd41206SAndrew Thompson return (err); 863bdd41206SAndrew Thompson } 864bdd41206SAndrew Thompson 865bdd41206SAndrew Thompson /*------------------------------------------------------------------------* 866a593f6b8SAndrew Thompson * usbd_set_alt_interface_index 86702ac6454SAndrew Thompson * 86802ac6454SAndrew Thompson * This function will select an alternate interface index for the 86902ac6454SAndrew Thompson * given interface index. The interface should not be in use when this 870e2805033SAndrew Thompson * function is called. That means there should not be any open USB 871e2805033SAndrew Thompson * transfers. Else an error is returned. If the alternate setting is 872e2805033SAndrew Thompson * already set this function will simply return success. This function 873e2805033SAndrew Thompson * is called in Host mode and Device mode! 87402ac6454SAndrew Thompson * 87502ac6454SAndrew Thompson * Returns: 87602ac6454SAndrew Thompson * 0: Success 87702ac6454SAndrew Thompson * Else: Failure 87802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 879e0a69b51SAndrew Thompson usb_error_t 880a593f6b8SAndrew Thompson usbd_set_alt_interface_index(struct usb_device *udev, 88102ac6454SAndrew Thompson uint8_t iface_index, uint8_t alt_index) 88202ac6454SAndrew Thompson { 883a593f6b8SAndrew Thompson struct usb_interface *iface = usbd_get_iface(udev, iface_index); 884e0a69b51SAndrew Thompson usb_error_t err; 88502ac6454SAndrew Thompson uint8_t do_unlock; 88602ac6454SAndrew Thompson 88702ac6454SAndrew Thompson /* automatic locking */ 888cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 88902ac6454SAndrew Thompson do_unlock = 0; 89002ac6454SAndrew Thompson } else { 89102ac6454SAndrew Thompson do_unlock = 1; 892cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 89302ac6454SAndrew Thompson } 89402ac6454SAndrew Thompson if (iface == NULL) { 89502ac6454SAndrew Thompson err = USB_ERR_INVAL; 89602ac6454SAndrew Thompson goto done; 89702ac6454SAndrew Thompson } 898e2805033SAndrew Thompson if (iface->alt_index == alt_index) { 899e2805033SAndrew Thompson /* 900e2805033SAndrew Thompson * Optimise away duplicate setting of 901e2805033SAndrew Thompson * alternate setting in USB Host Mode! 902e2805033SAndrew Thompson */ 903e2805033SAndrew Thompson err = 0; 904e2805033SAndrew Thompson goto done; 905e2805033SAndrew Thompson } 9060f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 90702ac6454SAndrew Thompson /* 90802ac6454SAndrew Thompson * Free all generic FIFOs for this interface, except control 90902ac6454SAndrew Thompson * endpoint FIFOs: 91002ac6454SAndrew Thompson */ 911a593f6b8SAndrew Thompson usb_fifo_free_wrap(udev, iface_index, 0); 9120f6e8f93SAndrew Thompson #endif 913bdd41206SAndrew Thompson 914a593f6b8SAndrew Thompson err = usb_config_parse(udev, iface_index, alt_index); 91502ac6454SAndrew Thompson if (err) { 91602ac6454SAndrew Thompson goto done; 91702ac6454SAndrew Thompson } 918bd73b187SAlfred Perlstein if (iface->alt_index != alt_index) { 919bd73b187SAlfred Perlstein /* the alternate setting does not exist */ 920bd73b187SAlfred Perlstein err = USB_ERR_INVAL; 921bd73b187SAlfred Perlstein goto done; 922bd73b187SAlfred Perlstein } 923bd73b187SAlfred Perlstein 924a593f6b8SAndrew Thompson err = usbd_req_set_alt_interface_no(udev, NULL, iface_index, 92502ac6454SAndrew Thompson iface->idesc->bAlternateSetting); 92602ac6454SAndrew Thompson 92702ac6454SAndrew Thompson done: 928cb18f7d1SAlfred Perlstein if (do_unlock) 929cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 930cb18f7d1SAlfred Perlstein 93102ac6454SAndrew Thompson return (err); 93202ac6454SAndrew Thompson } 93302ac6454SAndrew Thompson 93402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 935a593f6b8SAndrew Thompson * usbd_set_endpoint_stall 93602ac6454SAndrew Thompson * 937963169b4SHans Petter Selasky * This function is used to make a BULK or INTERRUPT endpoint send 938963169b4SHans Petter Selasky * STALL tokens in USB device mode. 93902ac6454SAndrew Thompson * 94002ac6454SAndrew Thompson * Returns: 94102ac6454SAndrew Thompson * 0: Success 94202ac6454SAndrew Thompson * Else: Failure 94302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 944e0a69b51SAndrew Thompson usb_error_t 945a593f6b8SAndrew Thompson usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep, 94602ac6454SAndrew Thompson uint8_t do_stall) 94702ac6454SAndrew Thompson { 948760bc48eSAndrew Thompson struct usb_xfer *xfer; 949a5cf1aaaSHans Petter Selasky usb_stream_t x; 95002ac6454SAndrew Thompson uint8_t et; 95102ac6454SAndrew Thompson uint8_t was_stalled; 95202ac6454SAndrew Thompson 953ae60fdfbSAndrew Thompson if (ep == NULL) { 95402ac6454SAndrew Thompson /* nothing to do */ 95502ac6454SAndrew Thompson DPRINTF("Cannot find endpoint\n"); 95602ac6454SAndrew Thompson /* 95702ac6454SAndrew Thompson * Pretend that the clear or set stall request is 95802ac6454SAndrew Thompson * successful else some USB host stacks can do 95902ac6454SAndrew Thompson * strange things, especially when a control endpoint 96002ac6454SAndrew Thompson * stalls. 96102ac6454SAndrew Thompson */ 96202ac6454SAndrew Thompson return (0); 96302ac6454SAndrew Thompson } 964ae60fdfbSAndrew Thompson et = (ep->edesc->bmAttributes & UE_XFERTYPE); 96502ac6454SAndrew Thompson 96602ac6454SAndrew Thompson if ((et != UE_BULK) && 96702ac6454SAndrew Thompson (et != UE_INTERRUPT)) { 96802ac6454SAndrew Thompson /* 96902ac6454SAndrew Thompson * Should not stall control 97002ac6454SAndrew Thompson * nor isochronous endpoints. 97102ac6454SAndrew Thompson */ 97202ac6454SAndrew Thompson DPRINTF("Invalid endpoint\n"); 97302ac6454SAndrew Thompson return (0); 97402ac6454SAndrew Thompson } 97502ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 97602ac6454SAndrew Thompson 97702ac6454SAndrew Thompson /* store current stall state */ 978ae60fdfbSAndrew Thompson was_stalled = ep->is_stalled; 97902ac6454SAndrew Thompson 98002ac6454SAndrew Thompson /* check for no change */ 98102ac6454SAndrew Thompson if (was_stalled && do_stall) { 982ae60fdfbSAndrew Thompson /* if the endpoint is already stalled do nothing */ 98302ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 98402ac6454SAndrew Thompson DPRINTF("No change\n"); 98502ac6454SAndrew Thompson return (0); 98602ac6454SAndrew Thompson } 98702ac6454SAndrew Thompson /* set stalled state */ 988ae60fdfbSAndrew Thompson ep->is_stalled = 1; 98902ac6454SAndrew Thompson 99002ac6454SAndrew Thompson if (do_stall || (!was_stalled)) { 99102ac6454SAndrew Thompson if (!was_stalled) { 992a5cf1aaaSHans Petter Selasky for (x = 0; x != USB_MAX_EP_STREAMS; x++) { 99302ac6454SAndrew Thompson /* lookup the current USB transfer, if any */ 994a5cf1aaaSHans Petter Selasky xfer = ep->endpoint_q[x].curr; 995a5cf1aaaSHans Petter Selasky if (xfer != NULL) { 99602ac6454SAndrew Thompson /* 997a5cf1aaaSHans Petter Selasky * The "xfer_stall" method 998a5cf1aaaSHans Petter Selasky * will complete the USB 999a5cf1aaaSHans Petter Selasky * transfer like in case of a 1000a5cf1aaaSHans Petter Selasky * timeout setting the error 1001a5cf1aaaSHans Petter Selasky * code "USB_ERR_STALLED". 100202ac6454SAndrew Thompson */ 1003a5cf1aaaSHans Petter Selasky (udev->bus->methods->xfer_stall) (xfer); 1004a5cf1aaaSHans Petter Selasky } 1005a5cf1aaaSHans Petter Selasky } 1006a5cf1aaaSHans Petter Selasky } 1007a5cf1aaaSHans Petter Selasky (udev->bus->methods->set_stall) (udev, ep, &do_stall); 100802ac6454SAndrew Thompson } 100902ac6454SAndrew Thompson if (!do_stall) { 1010ae60fdfbSAndrew Thompson ep->toggle_next = 0; /* reset data toggle */ 1011ae60fdfbSAndrew Thompson ep->is_stalled = 0; /* clear stalled state */ 101202ac6454SAndrew Thompson 1013ae60fdfbSAndrew Thompson (udev->bus->methods->clear_stall) (udev, ep); 101402ac6454SAndrew Thompson 1015a5cf1aaaSHans Petter Selasky /* start the current or next transfer, if any */ 1016a5cf1aaaSHans Petter Selasky for (x = 0; x != USB_MAX_EP_STREAMS; x++) { 1017a5cf1aaaSHans Petter Selasky usb_command_wrapper(&ep->endpoint_q[x], 1018a5cf1aaaSHans Petter Selasky ep->endpoint_q[x].curr); 1019a5cf1aaaSHans Petter Selasky } 102002ac6454SAndrew Thompson } 102102ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 102202ac6454SAndrew Thompson return (0); 102302ac6454SAndrew Thompson } 102402ac6454SAndrew Thompson 102502ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1026a593f6b8SAndrew Thompson * usb_reset_iface_endpoints - used in USB device side mode 102702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1028e0a69b51SAndrew Thompson usb_error_t 1029a593f6b8SAndrew Thompson usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index) 103002ac6454SAndrew Thompson { 1031ae60fdfbSAndrew Thompson struct usb_endpoint *ep; 1032ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end; 103302ac6454SAndrew Thompson 1034ae60fdfbSAndrew Thompson ep = udev->endpoints; 1035ae60fdfbSAndrew Thompson ep_end = udev->endpoints + udev->endpoints_max; 103602ac6454SAndrew Thompson 1037ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 103802ac6454SAndrew Thompson 1039ae60fdfbSAndrew Thompson if ((ep->edesc == NULL) || 1040ae60fdfbSAndrew Thompson (ep->iface_index != iface_index)) { 104102ac6454SAndrew Thompson continue; 104202ac6454SAndrew Thompson } 104302ac6454SAndrew Thompson /* simulate a clear stall from the peer */ 1044bd73b187SAlfred Perlstein usbd_set_endpoint_stall(udev, ep, 0); 104502ac6454SAndrew Thompson } 104602ac6454SAndrew Thompson return (0); 104702ac6454SAndrew Thompson } 104802ac6454SAndrew Thompson 104902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1050a593f6b8SAndrew Thompson * usb_detach_device_sub 105102ac6454SAndrew Thompson * 105202ac6454SAndrew Thompson * This function will try to detach an USB device. If it fails a panic 105302ac6454SAndrew Thompson * will result. 1054bdd41206SAndrew Thompson * 1055bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 105602ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 105702ac6454SAndrew Thompson static void 1058a593f6b8SAndrew Thompson usb_detach_device_sub(struct usb_device *udev, device_t *ppdev, 10598427ed84SHans Petter Selasky char **ppnpinfo, uint8_t flag) 106002ac6454SAndrew Thompson { 106102ac6454SAndrew Thompson device_t dev; 10628427ed84SHans Petter Selasky char *pnpinfo; 106302ac6454SAndrew Thompson int err; 106402ac6454SAndrew Thompson 1065d88688c7SAndrew Thompson dev = *ppdev; 1066d88688c7SAndrew Thompson if (dev) { 106702ac6454SAndrew Thompson /* 106802ac6454SAndrew Thompson * NOTE: It is important to clear "*ppdev" before deleting 106902ac6454SAndrew Thompson * the child due to some device methods being called late 107002ac6454SAndrew Thompson * during the delete process ! 107102ac6454SAndrew Thompson */ 107202ac6454SAndrew Thompson *ppdev = NULL; 107302ac6454SAndrew Thompson 107402ac6454SAndrew Thompson device_printf(dev, "at %s, port %d, addr %d " 107502ac6454SAndrew Thompson "(disconnected)\n", 107602ac6454SAndrew Thompson device_get_nameunit(udev->parent_dev), 107702ac6454SAndrew Thompson udev->port_no, udev->address); 107802ac6454SAndrew Thompson 107902ac6454SAndrew Thompson if (device_is_attached(dev)) { 1080ec8f3127SAndrew Thompson if (udev->flags.peer_suspended) { 108102ac6454SAndrew Thompson err = DEVICE_RESUME(dev); 108202ac6454SAndrew Thompson if (err) { 1083767cb2e2SAndrew Thompson device_printf(dev, "Resume failed\n"); 108402ac6454SAndrew Thompson } 108502ac6454SAndrew Thompson } 108602ac6454SAndrew Thompson if (device_detach(dev)) { 108702ac6454SAndrew Thompson goto error; 108802ac6454SAndrew Thompson } 108902ac6454SAndrew Thompson } 109002ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, dev)) { 109102ac6454SAndrew Thompson goto error; 109202ac6454SAndrew Thompson } 109302ac6454SAndrew Thompson } 10948427ed84SHans Petter Selasky 10958427ed84SHans Petter Selasky pnpinfo = *ppnpinfo; 10968427ed84SHans Petter Selasky if (pnpinfo != NULL) { 10978427ed84SHans Petter Selasky *ppnpinfo = NULL; 10988427ed84SHans Petter Selasky free(pnpinfo, M_USBDEV); 10998427ed84SHans Petter Selasky } 110002ac6454SAndrew Thompson return; 110102ac6454SAndrew Thompson 110202ac6454SAndrew Thompson error: 110302ac6454SAndrew Thompson /* Detach is not allowed to fail in the USB world */ 11048427ed84SHans Petter Selasky panic("usb_detach_device_sub: A USB driver would not detach\n"); 110502ac6454SAndrew Thompson } 110602ac6454SAndrew Thompson 110702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1108a593f6b8SAndrew Thompson * usb_detach_device 110902ac6454SAndrew Thompson * 111002ac6454SAndrew Thompson * The following function will detach the matching interfaces. 111102ac6454SAndrew Thompson * This function is NULL safe. 1112bdd41206SAndrew Thompson * 1113bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 111402ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 111502ac6454SAndrew Thompson void 1116a593f6b8SAndrew Thompson usb_detach_device(struct usb_device *udev, uint8_t iface_index, 1117bdd41206SAndrew Thompson uint8_t flag) 111802ac6454SAndrew Thompson { 1119760bc48eSAndrew Thompson struct usb_interface *iface; 112002ac6454SAndrew Thompson uint8_t i; 112102ac6454SAndrew Thompson 112202ac6454SAndrew Thompson if (udev == NULL) { 112302ac6454SAndrew Thompson /* nothing to do */ 112402ac6454SAndrew Thompson return; 112502ac6454SAndrew Thompson } 112602ac6454SAndrew Thompson DPRINTFN(4, "udev=%p\n", udev); 112702ac6454SAndrew Thompson 112891cd9240SAndrew Thompson sx_assert(&udev->enum_sx, SA_LOCKED); 112902ac6454SAndrew Thompson 113002ac6454SAndrew Thompson /* 113102ac6454SAndrew Thompson * First detach the child to give the child's detach routine a 113202ac6454SAndrew Thompson * chance to detach the sub-devices in the correct order. 113302ac6454SAndrew Thompson * Then delete the child using "device_delete_child()" which 113402ac6454SAndrew Thompson * will detach all sub-devices from the bottom and upwards! 113502ac6454SAndrew Thompson */ 113602ac6454SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 113702ac6454SAndrew Thompson i = iface_index; 113802ac6454SAndrew Thompson iface_index = i + 1; 113902ac6454SAndrew Thompson } else { 114002ac6454SAndrew Thompson i = 0; 114102ac6454SAndrew Thompson iface_index = USB_IFACE_MAX; 114202ac6454SAndrew Thompson } 114302ac6454SAndrew Thompson 114402ac6454SAndrew Thompson /* do the detach */ 114502ac6454SAndrew Thompson 114602ac6454SAndrew Thompson for (; i != iface_index; i++) { 114702ac6454SAndrew Thompson 1148a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 114902ac6454SAndrew Thompson if (iface == NULL) { 115002ac6454SAndrew Thompson /* looks like the end of the USB interfaces */ 115102ac6454SAndrew Thompson break; 115202ac6454SAndrew Thompson } 11538427ed84SHans Petter Selasky usb_detach_device_sub(udev, &iface->subdev, 11548427ed84SHans Petter Selasky &iface->pnpinfo, flag); 115502ac6454SAndrew Thompson } 115602ac6454SAndrew Thompson } 115702ac6454SAndrew Thompson 115802ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1159a593f6b8SAndrew Thompson * usb_probe_and_attach_sub 116002ac6454SAndrew Thompson * 116102ac6454SAndrew Thompson * Returns: 116202ac6454SAndrew Thompson * 0: Success 116302ac6454SAndrew Thompson * Else: Failure 116402ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 116502ac6454SAndrew Thompson static uint8_t 1166a593f6b8SAndrew Thompson usb_probe_and_attach_sub(struct usb_device *udev, 1167760bc48eSAndrew Thompson struct usb_attach_arg *uaa) 116802ac6454SAndrew Thompson { 1169760bc48eSAndrew Thompson struct usb_interface *iface; 117002ac6454SAndrew Thompson device_t dev; 117102ac6454SAndrew Thompson int err; 117202ac6454SAndrew Thompson 117302ac6454SAndrew Thompson iface = uaa->iface; 117402ac6454SAndrew Thompson if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) { 117502ac6454SAndrew Thompson /* leave interface alone */ 117602ac6454SAndrew Thompson return (0); 117702ac6454SAndrew Thompson } 117802ac6454SAndrew Thompson dev = iface->subdev; 117902ac6454SAndrew Thompson if (dev) { 118002ac6454SAndrew Thompson 118102ac6454SAndrew Thompson /* clean up after module unload */ 118202ac6454SAndrew Thompson 118302ac6454SAndrew Thompson if (device_is_attached(dev)) { 118402ac6454SAndrew Thompson /* already a device there */ 118502ac6454SAndrew Thompson return (0); 118602ac6454SAndrew Thompson } 118702ac6454SAndrew Thompson /* clear "iface->subdev" as early as possible */ 118802ac6454SAndrew Thompson 118902ac6454SAndrew Thompson iface->subdev = NULL; 119002ac6454SAndrew Thompson 119102ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, dev)) { 119202ac6454SAndrew Thompson 119302ac6454SAndrew Thompson /* 119402ac6454SAndrew Thompson * Panic here, else one can get a double call 119502ac6454SAndrew Thompson * to device_detach(). USB devices should 119602ac6454SAndrew Thompson * never fail on detach! 119702ac6454SAndrew Thompson */ 1198767cb2e2SAndrew Thompson panic("device_delete_child() failed\n"); 119902ac6454SAndrew Thompson } 120002ac6454SAndrew Thompson } 120102ac6454SAndrew Thompson if (uaa->temp_dev == NULL) { 120202ac6454SAndrew Thompson 120302ac6454SAndrew Thompson /* create a new child */ 120402ac6454SAndrew Thompson uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1); 120502ac6454SAndrew Thompson if (uaa->temp_dev == NULL) { 120602ac6454SAndrew Thompson device_printf(udev->parent_dev, 1207767cb2e2SAndrew Thompson "Device creation failed\n"); 120802ac6454SAndrew Thompson return (1); /* failure */ 120902ac6454SAndrew Thompson } 121002ac6454SAndrew Thompson device_set_ivars(uaa->temp_dev, uaa); 121102ac6454SAndrew Thompson device_quiet(uaa->temp_dev); 121202ac6454SAndrew Thompson } 121302ac6454SAndrew Thompson /* 121402ac6454SAndrew Thompson * Set "subdev" before probe and attach so that "devd" gets 121502ac6454SAndrew Thompson * the information it needs. 121602ac6454SAndrew Thompson */ 121702ac6454SAndrew Thompson iface->subdev = uaa->temp_dev; 121802ac6454SAndrew Thompson 121902ac6454SAndrew Thompson if (device_probe_and_attach(iface->subdev) == 0) { 122002ac6454SAndrew Thompson /* 122102ac6454SAndrew Thompson * The USB attach arguments are only available during probe 122202ac6454SAndrew Thompson * and attach ! 122302ac6454SAndrew Thompson */ 122402ac6454SAndrew Thompson uaa->temp_dev = NULL; 122502ac6454SAndrew Thompson device_set_ivars(iface->subdev, NULL); 122602ac6454SAndrew Thompson 1227ec8f3127SAndrew Thompson if (udev->flags.peer_suspended) { 122802ac6454SAndrew Thompson err = DEVICE_SUSPEND(iface->subdev); 122988b4e0abSAndrew Thompson if (err) 123002ac6454SAndrew Thompson device_printf(iface->subdev, "Suspend failed\n"); 123102ac6454SAndrew Thompson } 123202ac6454SAndrew Thompson return (0); /* success */ 123302ac6454SAndrew Thompson } else { 123402ac6454SAndrew Thompson /* No USB driver found */ 123502ac6454SAndrew Thompson iface->subdev = NULL; 123602ac6454SAndrew Thompson } 123702ac6454SAndrew Thompson return (1); /* failure */ 123802ac6454SAndrew Thompson } 123902ac6454SAndrew Thompson 124002ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1241a593f6b8SAndrew Thompson * usbd_set_parent_iface 124202ac6454SAndrew Thompson * 124302ac6454SAndrew Thompson * Using this function will lock the alternate interface setting on an 124402ac6454SAndrew Thompson * interface. It is typically used for multi interface drivers. In USB 124502ac6454SAndrew Thompson * device side mode it is assumed that the alternate interfaces all 124602ac6454SAndrew Thompson * have the same endpoint descriptors. The default parent index value 124702ac6454SAndrew Thompson * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not 124802ac6454SAndrew Thompson * locked. 124902ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 125002ac6454SAndrew Thompson void 1251a593f6b8SAndrew Thompson usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index, 125202ac6454SAndrew Thompson uint8_t parent_index) 125302ac6454SAndrew Thompson { 1254760bc48eSAndrew Thompson struct usb_interface *iface; 125502ac6454SAndrew Thompson 1256d9073c1eSHans Petter Selasky if (udev == NULL) { 1257d9073c1eSHans Petter Selasky /* nothing to do */ 1258d9073c1eSHans Petter Selasky return; 125902ac6454SAndrew Thompson } 1260d9073c1eSHans Petter Selasky iface = usbd_get_iface(udev, iface_index); 1261d9073c1eSHans Petter Selasky if (iface != NULL) 1262d9073c1eSHans Petter Selasky iface->parent_iface_index = parent_index; 126302ac6454SAndrew Thompson } 126402ac6454SAndrew Thompson 126502ac6454SAndrew Thompson static void 1266a593f6b8SAndrew Thompson usb_init_attach_arg(struct usb_device *udev, 1267760bc48eSAndrew Thompson struct usb_attach_arg *uaa) 126802ac6454SAndrew Thompson { 1269d46dc4adSHans Petter Selasky memset(uaa, 0, sizeof(*uaa)); 127002ac6454SAndrew Thompson 127102ac6454SAndrew Thompson uaa->device = udev; 1272f29a0724SAndrew Thompson uaa->usb_mode = udev->flags.usb_mode; 127302ac6454SAndrew Thompson uaa->port = udev->port_no; 12742a4c6157SAndrew Thompson uaa->dev_state = UAA_DEV_READY; 127502ac6454SAndrew Thompson 127602ac6454SAndrew Thompson uaa->info.idVendor = UGETW(udev->ddesc.idVendor); 127702ac6454SAndrew Thompson uaa->info.idProduct = UGETW(udev->ddesc.idProduct); 127802ac6454SAndrew Thompson uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice); 127902ac6454SAndrew Thompson uaa->info.bDeviceClass = udev->ddesc.bDeviceClass; 128002ac6454SAndrew Thompson uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass; 128102ac6454SAndrew Thompson uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol; 128202ac6454SAndrew Thompson uaa->info.bConfigIndex = udev->curr_config_index; 128302ac6454SAndrew Thompson uaa->info.bConfigNum = udev->curr_config_no; 128402ac6454SAndrew Thompson } 128502ac6454SAndrew Thompson 128602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1287a593f6b8SAndrew Thompson * usb_probe_and_attach 128802ac6454SAndrew Thompson * 128902ac6454SAndrew Thompson * This function is called from "uhub_explore_sub()", 1290a593f6b8SAndrew Thompson * "usb_handle_set_config()" and "usb_handle_request()". 129102ac6454SAndrew Thompson * 129202ac6454SAndrew Thompson * Returns: 129302ac6454SAndrew Thompson * 0: Success 129402ac6454SAndrew Thompson * Else: A control transfer failed 129502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1296e0a69b51SAndrew Thompson usb_error_t 1297a593f6b8SAndrew Thompson usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index) 129802ac6454SAndrew Thompson { 1299760bc48eSAndrew Thompson struct usb_attach_arg uaa; 1300760bc48eSAndrew Thompson struct usb_interface *iface; 130102ac6454SAndrew Thompson uint8_t i; 130202ac6454SAndrew Thompson uint8_t j; 130302ac6454SAndrew Thompson uint8_t do_unlock; 130402ac6454SAndrew Thompson 130502ac6454SAndrew Thompson if (udev == NULL) { 130602ac6454SAndrew Thompson DPRINTF("udev == NULL\n"); 130702ac6454SAndrew Thompson return (USB_ERR_INVAL); 130802ac6454SAndrew Thompson } 130902ac6454SAndrew Thompson /* automatic locking */ 1310cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 131102ac6454SAndrew Thompson do_unlock = 0; 131202ac6454SAndrew Thompson } else { 131302ac6454SAndrew Thompson do_unlock = 1; 1314cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 131502ac6454SAndrew Thompson } 131602ac6454SAndrew Thompson 131702ac6454SAndrew Thompson if (udev->curr_config_index == USB_UNCONFIG_INDEX) { 131802ac6454SAndrew Thompson /* do nothing - no configuration has been set */ 131902ac6454SAndrew Thompson goto done; 132002ac6454SAndrew Thompson } 132102ac6454SAndrew Thompson /* setup USB attach arguments */ 132202ac6454SAndrew Thompson 1323a593f6b8SAndrew Thompson usb_init_attach_arg(udev, &uaa); 132402ac6454SAndrew Thompson 1325a6b60150SHans Petter Selasky /* 1326a6b60150SHans Petter Selasky * If the whole USB device is targeted, invoke the USB event 1327a6b60150SHans Petter Selasky * handler(s): 1328a6b60150SHans Petter Selasky */ 1329a6b60150SHans Petter Selasky if (iface_index == USB_IFACE_INDEX_ANY) { 1330a6b60150SHans Petter Selasky 1331a6b60150SHans Petter Selasky EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa); 1332a6b60150SHans Petter Selasky 1333a6b60150SHans Petter Selasky if (uaa.dev_state != UAA_DEV_READY) { 1334a6b60150SHans Petter Selasky /* leave device unconfigured */ 1335a6b60150SHans Petter Selasky usb_unconfigure(udev, 0); 1336a6b60150SHans Petter Selasky goto done; 1337a6b60150SHans Petter Selasky } 1338a6b60150SHans Petter Selasky } 1339a6b60150SHans Petter Selasky 134002ac6454SAndrew Thompson /* Check if only one interface should be probed: */ 134102ac6454SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 134202ac6454SAndrew Thompson i = iface_index; 134302ac6454SAndrew Thompson j = i + 1; 134402ac6454SAndrew Thompson } else { 134502ac6454SAndrew Thompson i = 0; 134602ac6454SAndrew Thompson j = USB_IFACE_MAX; 134702ac6454SAndrew Thompson } 134802ac6454SAndrew Thompson 134902ac6454SAndrew Thompson /* Do the probe and attach */ 135002ac6454SAndrew Thompson for (; i != j; i++) { 135102ac6454SAndrew Thompson 1352a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 135302ac6454SAndrew Thompson if (iface == NULL) { 135402ac6454SAndrew Thompson /* 135502ac6454SAndrew Thompson * Looks like the end of the USB 135602ac6454SAndrew Thompson * interfaces ! 135702ac6454SAndrew Thompson */ 135802ac6454SAndrew Thompson DPRINTFN(2, "end of interfaces " 135902ac6454SAndrew Thompson "at %u\n", i); 136002ac6454SAndrew Thompson break; 136102ac6454SAndrew Thompson } 136202ac6454SAndrew Thompson if (iface->idesc == NULL) { 136302ac6454SAndrew Thompson /* no interface descriptor */ 136402ac6454SAndrew Thompson continue; 136502ac6454SAndrew Thompson } 136602ac6454SAndrew Thompson uaa.iface = iface; 136702ac6454SAndrew Thompson 136802ac6454SAndrew Thompson uaa.info.bInterfaceClass = 136902ac6454SAndrew Thompson iface->idesc->bInterfaceClass; 137002ac6454SAndrew Thompson uaa.info.bInterfaceSubClass = 137102ac6454SAndrew Thompson iface->idesc->bInterfaceSubClass; 137202ac6454SAndrew Thompson uaa.info.bInterfaceProtocol = 137302ac6454SAndrew Thompson iface->idesc->bInterfaceProtocol; 137402ac6454SAndrew Thompson uaa.info.bIfaceIndex = i; 137502ac6454SAndrew Thompson uaa.info.bIfaceNum = 137602ac6454SAndrew Thompson iface->idesc->bInterfaceNumber; 1377bd73b187SAlfred Perlstein uaa.driver_info = 0; /* reset driver_info */ 137802ac6454SAndrew Thompson 137902ac6454SAndrew Thompson DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n", 138002ac6454SAndrew Thompson uaa.info.bInterfaceClass, 138102ac6454SAndrew Thompson uaa.info.bInterfaceSubClass, 138202ac6454SAndrew Thompson uaa.info.bInterfaceProtocol, 138302ac6454SAndrew Thompson uaa.info.bIfaceIndex, 138402ac6454SAndrew Thompson uaa.info.bIfaceNum); 138502ac6454SAndrew Thompson 1386d43ffe94SHans Petter Selasky usb_probe_and_attach_sub(udev, &uaa); 138702ac6454SAndrew Thompson 1388d43ffe94SHans Petter Selasky /* 1389d43ffe94SHans Petter Selasky * Remove the leftover child, if any, to enforce that 1390d43ffe94SHans Petter Selasky * a new nomatch devd event is generated for the next 1391d43ffe94SHans Petter Selasky * interface if no driver is found: 1392d43ffe94SHans Petter Selasky */ 1393d43ffe94SHans Petter Selasky if (uaa.temp_dev == NULL) 1394d43ffe94SHans Petter Selasky continue; 1395d43ffe94SHans Petter Selasky if (device_delete_child(udev->parent_dev, uaa.temp_dev)) 1396767cb2e2SAndrew Thompson DPRINTFN(0, "device delete child failed\n"); 1397d43ffe94SHans Petter Selasky uaa.temp_dev = NULL; 139802ac6454SAndrew Thompson } 139902ac6454SAndrew Thompson done: 1400cb18f7d1SAlfred Perlstein if (do_unlock) 1401cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 1402cb18f7d1SAlfred Perlstein 140302ac6454SAndrew Thompson return (0); 140402ac6454SAndrew Thompson } 140502ac6454SAndrew Thompson 140602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1407a593f6b8SAndrew Thompson * usb_suspend_resume_sub 140802ac6454SAndrew Thompson * 140902ac6454SAndrew Thompson * This function is called when the suspend or resume methods should 141002ac6454SAndrew Thompson * be executed on an USB device. 141102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 141202ac6454SAndrew Thompson static void 1413a593f6b8SAndrew Thompson usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend) 141402ac6454SAndrew Thompson { 141502ac6454SAndrew Thompson int err; 141602ac6454SAndrew Thompson 141702ac6454SAndrew Thompson if (dev == NULL) { 141802ac6454SAndrew Thompson return; 141902ac6454SAndrew Thompson } 142002ac6454SAndrew Thompson if (!device_is_attached(dev)) { 142102ac6454SAndrew Thompson return; 142202ac6454SAndrew Thompson } 142302ac6454SAndrew Thompson if (do_suspend) { 142402ac6454SAndrew Thompson err = DEVICE_SUSPEND(dev); 142502ac6454SAndrew Thompson } else { 142602ac6454SAndrew Thompson err = DEVICE_RESUME(dev); 142702ac6454SAndrew Thompson } 142802ac6454SAndrew Thompson if (err) { 1429767cb2e2SAndrew Thompson device_printf(dev, "%s failed\n", 143002ac6454SAndrew Thompson do_suspend ? "Suspend" : "Resume"); 143102ac6454SAndrew Thompson } 143202ac6454SAndrew Thompson } 143302ac6454SAndrew Thompson 143402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1435a593f6b8SAndrew Thompson * usb_suspend_resume 143602ac6454SAndrew Thompson * 143702ac6454SAndrew Thompson * The following function will suspend or resume the USB device. 143802ac6454SAndrew Thompson * 143902ac6454SAndrew Thompson * Returns: 144002ac6454SAndrew Thompson * 0: Success 144102ac6454SAndrew Thompson * Else: Failure 144202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1443e0a69b51SAndrew Thompson usb_error_t 1444a593f6b8SAndrew Thompson usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend) 144502ac6454SAndrew Thompson { 1446760bc48eSAndrew Thompson struct usb_interface *iface; 144702ac6454SAndrew Thompson uint8_t i; 144802ac6454SAndrew Thompson 144902ac6454SAndrew Thompson if (udev == NULL) { 145002ac6454SAndrew Thompson /* nothing to do */ 145102ac6454SAndrew Thompson return (0); 145202ac6454SAndrew Thompson } 145302ac6454SAndrew Thompson DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend); 145402ac6454SAndrew Thompson 14552df1e9a6SAndrew Thompson sx_assert(&udev->sr_sx, SA_LOCKED); 145602ac6454SAndrew Thompson 145702ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 145802ac6454SAndrew Thompson /* filter the suspend events */ 1459ec8f3127SAndrew Thompson if (udev->flags.peer_suspended == do_suspend) { 146002ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 146102ac6454SAndrew Thompson /* nothing to do */ 146202ac6454SAndrew Thompson return (0); 146302ac6454SAndrew Thompson } 1464ec8f3127SAndrew Thompson udev->flags.peer_suspended = do_suspend; 146502ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 146602ac6454SAndrew Thompson 146702ac6454SAndrew Thompson /* do the suspend or resume */ 146802ac6454SAndrew Thompson 146902ac6454SAndrew Thompson for (i = 0; i != USB_IFACE_MAX; i++) { 147002ac6454SAndrew Thompson 1471a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 147202ac6454SAndrew Thompson if (iface == NULL) { 147302ac6454SAndrew Thompson /* looks like the end of the USB interfaces */ 147402ac6454SAndrew Thompson break; 147502ac6454SAndrew Thompson } 1476a593f6b8SAndrew Thompson usb_suspend_resume_sub(udev, iface->subdev, do_suspend); 147702ac6454SAndrew Thompson } 147802ac6454SAndrew Thompson return (0); 147902ac6454SAndrew Thompson } 148002ac6454SAndrew Thompson 148102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1482a593f6b8SAndrew Thompson * usbd_clear_stall_proc 148302ac6454SAndrew Thompson * 148402ac6454SAndrew Thompson * This function performs generic USB clear stall operations. 148502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 148602ac6454SAndrew Thompson static void 1487a593f6b8SAndrew Thompson usbd_clear_stall_proc(struct usb_proc_msg *_pm) 148802ac6454SAndrew Thompson { 1489760bc48eSAndrew Thompson struct usb_clear_stall_msg *pm = (void *)_pm; 1490760bc48eSAndrew Thompson struct usb_device *udev = pm->udev; 149102ac6454SAndrew Thompson 149202ac6454SAndrew Thompson /* Change lock */ 149302ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 149491cd9240SAndrew Thompson mtx_lock(&udev->device_mtx); 149502ac6454SAndrew Thompson 149602ac6454SAndrew Thompson /* Start clear stall callback */ 14975b3bb704SAndrew Thompson usbd_transfer_start(udev->ctrl_xfer[1]); 149802ac6454SAndrew Thompson 149902ac6454SAndrew Thompson /* Change lock */ 150091cd9240SAndrew Thompson mtx_unlock(&udev->device_mtx); 150102ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 150202ac6454SAndrew Thompson } 150302ac6454SAndrew Thompson 150402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1505a593f6b8SAndrew Thompson * usb_alloc_device 150602ac6454SAndrew Thompson * 150702ac6454SAndrew Thompson * This function allocates a new USB device. This function is called 150802ac6454SAndrew Thompson * when a new device has been put in the powered state, but not yet in 150902ac6454SAndrew Thompson * the addressed state. Get initial descriptor, set the address, get 151002ac6454SAndrew Thompson * full descriptor and get strings. 151102ac6454SAndrew Thompson * 151202ac6454SAndrew Thompson * Return values: 151302ac6454SAndrew Thompson * 0: Failure 151402ac6454SAndrew Thompson * Else: Success 151502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1516760bc48eSAndrew Thompson struct usb_device * 1517a593f6b8SAndrew Thompson usb_alloc_device(device_t parent_dev, struct usb_bus *bus, 1518760bc48eSAndrew Thompson struct usb_device *parent_hub, uint8_t depth, uint8_t port_index, 15198d2dd5ddSAndrew Thompson uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode) 152002ac6454SAndrew Thompson { 1521760bc48eSAndrew Thompson struct usb_attach_arg uaa; 1522760bc48eSAndrew Thompson struct usb_device *udev; 1523760bc48eSAndrew Thompson struct usb_device *adev; 1524760bc48eSAndrew Thompson struct usb_device *hub; 152502ac6454SAndrew Thompson uint8_t *scratch_ptr; 1526e0a69b51SAndrew Thompson usb_error_t err; 152702ac6454SAndrew Thompson uint8_t device_index; 15282a4c6157SAndrew Thompson uint8_t config_index; 15292a4c6157SAndrew Thompson uint8_t config_quirk; 15302a4c6157SAndrew Thompson uint8_t set_config_failed; 153102ac6454SAndrew Thompson 153202ac6454SAndrew Thompson DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, " 1533f29a0724SAndrew Thompson "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n", 153402ac6454SAndrew Thompson parent_dev, bus, parent_hub, depth, port_index, port_no, 1535f29a0724SAndrew Thompson speed, mode); 153602ac6454SAndrew Thompson 153702ac6454SAndrew Thompson /* 153802ac6454SAndrew Thompson * Find an unused device index. In USB Host mode this is the 153902ac6454SAndrew Thompson * same as the device address. 154002ac6454SAndrew Thompson * 154102ac6454SAndrew Thompson * Device index zero is not used and device index 1 should 154202ac6454SAndrew Thompson * always be the root hub. 154302ac6454SAndrew Thompson */ 154402ac6454SAndrew Thompson for (device_index = USB_ROOT_HUB_ADDR; 154502ac6454SAndrew Thompson (device_index != bus->devices_max) && 154602ac6454SAndrew Thompson (bus->devices[device_index] != NULL); 154702ac6454SAndrew Thompson device_index++) /* nop */; 154802ac6454SAndrew Thompson 154902ac6454SAndrew Thompson if (device_index == bus->devices_max) { 155002ac6454SAndrew Thompson device_printf(bus->bdev, 1551767cb2e2SAndrew Thompson "No free USB device index for new device\n"); 155202ac6454SAndrew Thompson return (NULL); 155302ac6454SAndrew Thompson } 155402ac6454SAndrew Thompson 155502ac6454SAndrew Thompson if (depth > 0x10) { 155602ac6454SAndrew Thompson device_printf(bus->bdev, 1557767cb2e2SAndrew Thompson "Invalid device depth\n"); 155802ac6454SAndrew Thompson return (NULL); 155902ac6454SAndrew Thompson } 156002ac6454SAndrew Thompson udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO); 156102ac6454SAndrew Thompson if (udev == NULL) { 156202ac6454SAndrew Thompson return (NULL); 156302ac6454SAndrew Thompson } 156402ac6454SAndrew Thompson /* initialise our SX-lock */ 156591cd9240SAndrew Thompson sx_init_flags(&udev->ctrl_sx, "USB device SX lock", SX_DUPOK); 156602ac6454SAndrew Thompson 156702ac6454SAndrew Thompson /* initialise our SX-lock */ 156891cd9240SAndrew Thompson sx_init_flags(&udev->enum_sx, "USB config SX lock", SX_DUPOK); 1569a6b60150SHans Petter Selasky sx_init_flags(&udev->sr_sx, "USB suspend and resume SX lock", SX_NOWITNESS); 157002ac6454SAndrew Thompson 157191cd9240SAndrew Thompson cv_init(&udev->ctrlreq_cv, "WCTRL"); 157291cd9240SAndrew Thompson cv_init(&udev->ref_cv, "UGONE"); 157302ac6454SAndrew Thompson 157402ac6454SAndrew Thompson /* initialise our mutex */ 157591cd9240SAndrew Thompson mtx_init(&udev->device_mtx, "USB device mutex", NULL, MTX_DEF); 157602ac6454SAndrew Thompson 157702ac6454SAndrew Thompson /* initialise generic clear stall */ 1578a593f6b8SAndrew Thompson udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc; 157902ac6454SAndrew Thompson udev->cs_msg[0].udev = udev; 1580a593f6b8SAndrew Thompson udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc; 158102ac6454SAndrew Thompson udev->cs_msg[1].udev = udev; 158202ac6454SAndrew Thompson 158302ac6454SAndrew Thompson /* initialise some USB device fields */ 158402ac6454SAndrew Thompson udev->parent_hub = parent_hub; 158502ac6454SAndrew Thompson udev->parent_dev = parent_dev; 158602ac6454SAndrew Thompson udev->port_index = port_index; 158702ac6454SAndrew Thompson udev->port_no = port_no; 158802ac6454SAndrew Thompson udev->depth = depth; 158902ac6454SAndrew Thompson udev->bus = bus; 159002ac6454SAndrew Thompson udev->address = USB_START_ADDR; /* default value */ 1591e0a69b51SAndrew Thompson udev->plugtime = (usb_ticks_t)ticks; 159202ac6454SAndrew Thompson /* 159302ac6454SAndrew Thompson * We need to force the power mode to "on" because there are plenty 159402ac6454SAndrew Thompson * of USB devices out there that do not work very well with 159502ac6454SAndrew Thompson * automatic suspend and resume! 159602ac6454SAndrew Thompson */ 1597d2d71ce7SAndrew Thompson udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON); 159802ac6454SAndrew Thompson udev->pwr_save.last_xfer_time = ticks; 159902ac6454SAndrew Thompson /* we are not ready yet */ 160002ac6454SAndrew Thompson udev->refcount = 1; 160102ac6454SAndrew Thompson 160202ac6454SAndrew Thompson /* set up default endpoint descriptor */ 16035b3bb704SAndrew Thompson udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc); 16045b3bb704SAndrew Thompson udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT; 16055b3bb704SAndrew Thompson udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT; 16065b3bb704SAndrew Thompson udev->ctrl_ep_desc.bmAttributes = UE_CONTROL; 16075b3bb704SAndrew Thompson udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET; 16085b3bb704SAndrew Thompson udev->ctrl_ep_desc.wMaxPacketSize[1] = 0; 16095b3bb704SAndrew Thompson udev->ctrl_ep_desc.bInterval = 0; 1610963169b4SHans Petter Selasky 1611963169b4SHans Petter Selasky /* set up default endpoint companion descriptor */ 1612963169b4SHans Petter Selasky udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc); 1613963169b4SHans Petter Selasky udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP; 1614963169b4SHans Petter Selasky 161502ac6454SAndrew Thompson udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET; 161602ac6454SAndrew Thompson 161702ac6454SAndrew Thompson udev->speed = speed; 1618f29a0724SAndrew Thompson udev->flags.usb_mode = mode; 161902ac6454SAndrew Thompson 162002ac6454SAndrew Thompson /* search for our High Speed USB HUB, if any */ 162102ac6454SAndrew Thompson 162202ac6454SAndrew Thompson adev = udev; 162302ac6454SAndrew Thompson hub = udev->parent_hub; 162402ac6454SAndrew Thompson 162502ac6454SAndrew Thompson while (hub) { 162602ac6454SAndrew Thompson if (hub->speed == USB_SPEED_HIGH) { 162702ac6454SAndrew Thompson udev->hs_hub_addr = hub->address; 1628495f25ceSAndrew Thompson udev->parent_hs_hub = hub; 162902ac6454SAndrew Thompson udev->hs_port_no = adev->port_no; 163002ac6454SAndrew Thompson break; 163102ac6454SAndrew Thompson } 163202ac6454SAndrew Thompson adev = hub; 163302ac6454SAndrew Thompson hub = hub->parent_hub; 163402ac6454SAndrew Thompson } 163502ac6454SAndrew Thompson 1636ae60fdfbSAndrew Thompson /* init the default endpoint */ 1637a593f6b8SAndrew Thompson usb_init_endpoint(udev, 0, 16385b3bb704SAndrew Thompson &udev->ctrl_ep_desc, 1639963169b4SHans Petter Selasky &udev->ctrl_ep_comp_desc, 16405b3bb704SAndrew Thompson &udev->ctrl_ep); 164102ac6454SAndrew Thompson 164202ac6454SAndrew Thompson /* set device index */ 164302ac6454SAndrew Thompson udev->device_index = device_index; 164402ac6454SAndrew Thompson 16458755859aSAndrew Thompson #if USB_HAVE_UGEN 16460f6e8f93SAndrew Thompson /* Create ugen name */ 1647ee3e3ff5SAndrew Thompson snprintf(udev->ugen_name, sizeof(udev->ugen_name), 1648ee3e3ff5SAndrew Thompson USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev), 1649ee3e3ff5SAndrew Thompson device_index); 16508755859aSAndrew Thompson LIST_INIT(&udev->pd_list); 16518755859aSAndrew Thompson 16520f6e8f93SAndrew Thompson /* Create the control endpoint device */ 16532ffd5fdcSHans Petter Selasky udev->ctrl_dev = usb_make_dev(udev, NULL, 0, 0, 16542ffd5fdcSHans Petter Selasky FREAD|FWRITE, UID_ROOT, GID_OPERATOR, 0600); 16550f6e8f93SAndrew Thompson 16560f6e8f93SAndrew Thompson /* Create a link from /dev/ugenX.X to the default endpoint */ 16572ffd5fdcSHans Petter Selasky if (udev->ctrl_dev != NULL) 16582ffd5fdcSHans Petter Selasky make_dev_alias(udev->ctrl_dev->cdev, "%s", udev->ugen_name); 16590f6e8f93SAndrew Thompson #endif 1660963169b4SHans Petter Selasky /* Initialise device */ 1661963169b4SHans Petter Selasky if (bus->methods->device_init != NULL) { 1662963169b4SHans Petter Selasky err = (bus->methods->device_init) (udev); 1663963169b4SHans Petter Selasky if (err != 0) { 1664963169b4SHans Petter Selasky DPRINTFN(0, "device init %d failed " 1665963169b4SHans Petter Selasky "(%s, ignored)\n", device_index, 1666963169b4SHans Petter Selasky usbd_errstr(err)); 1667963169b4SHans Petter Selasky goto done; 1668963169b4SHans Petter Selasky } 1669963169b4SHans Petter Selasky } 1670963169b4SHans Petter Selasky /* set powered device state after device init is complete */ 1671963169b4SHans Petter Selasky usb_set_device_state(udev, USB_STATE_POWERED); 1672963169b4SHans Petter Selasky 1673f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_HOST) { 167402ac6454SAndrew Thompson 1675a593f6b8SAndrew Thompson err = usbd_req_set_address(udev, NULL, device_index); 167602ac6454SAndrew Thompson 1677963169b4SHans Petter Selasky /* 1678963169b4SHans Petter Selasky * This is the new USB device address from now on, if 1679963169b4SHans Petter Selasky * the set address request didn't set it already. 1680963169b4SHans Petter Selasky */ 1681963169b4SHans Petter Selasky if (udev->address == USB_START_ADDR) 168202ac6454SAndrew Thompson udev->address = device_index; 168302ac6454SAndrew Thompson 168402ac6454SAndrew Thompson /* 168502ac6454SAndrew Thompson * We ignore any set-address errors, hence there are 168602ac6454SAndrew Thompson * buggy USB devices out there that actually receive 168702ac6454SAndrew Thompson * the SETUP PID, but manage to set the address before 168802ac6454SAndrew Thompson * the STATUS stage is ACK'ed. If the device responds 168902ac6454SAndrew Thompson * to the subsequent get-descriptor at the new 169002ac6454SAndrew Thompson * address, then we know that the set-address command 169102ac6454SAndrew Thompson * was successful. 169202ac6454SAndrew Thompson */ 169302ac6454SAndrew Thompson if (err) { 169402ac6454SAndrew Thompson DPRINTFN(0, "set address %d failed " 169503797f33SAndrew Thompson "(%s, ignored)\n", udev->address, 1696a593f6b8SAndrew Thompson usbd_errstr(err)); 169702ac6454SAndrew Thompson } 169802ac6454SAndrew Thompson } else { 169902ac6454SAndrew Thompson /* We are not self powered */ 170002ac6454SAndrew Thompson udev->flags.self_powered = 0; 170102ac6454SAndrew Thompson 170202ac6454SAndrew Thompson /* Set unconfigured state */ 170302ac6454SAndrew Thompson udev->curr_config_no = USB_UNCONFIG_NO; 170402ac6454SAndrew Thompson udev->curr_config_index = USB_UNCONFIG_INDEX; 170502ac6454SAndrew Thompson 170602ac6454SAndrew Thompson /* Setup USB descriptors */ 1707a593f6b8SAndrew Thompson err = (usb_temp_setup_by_index_p) (udev, usb_template); 170802ac6454SAndrew Thompson if (err) { 170902ac6454SAndrew Thompson DPRINTFN(0, "setting up USB template failed maybe the USB " 171002ac6454SAndrew Thompson "template module has not been loaded\n"); 171102ac6454SAndrew Thompson goto done; 171202ac6454SAndrew Thompson } 171302ac6454SAndrew Thompson } 1714a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_ADDRESSED); 171502ac6454SAndrew Thompson 1716963169b4SHans Petter Selasky /* setup the device descriptor and the initial "wMaxPacketSize" */ 1717963169b4SHans Petter Selasky err = usbd_setup_device_desc(udev, NULL); 1718963169b4SHans Petter Selasky 1719963169b4SHans Petter Selasky if (err != 0) { 172002ac6454SAndrew Thompson /* XXX try to re-enumerate the device */ 1721a593f6b8SAndrew Thompson err = usbd_req_re_enumerate(udev, NULL); 1722963169b4SHans Petter Selasky if (err) 172302ac6454SAndrew Thompson goto done; 172402ac6454SAndrew Thompson } 172502ac6454SAndrew Thompson 172602ac6454SAndrew Thompson /* 172702ac6454SAndrew Thompson * Setup temporary USB attach args so that we can figure out some 172802ac6454SAndrew Thompson * basic quirks for this device. 172902ac6454SAndrew Thompson */ 1730a593f6b8SAndrew Thompson usb_init_attach_arg(udev, &uaa); 173102ac6454SAndrew Thompson 1732a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) { 173302ac6454SAndrew Thompson udev->flags.uq_bus_powered = 1; 173402ac6454SAndrew Thompson } 1735a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) { 173602ac6454SAndrew Thompson udev->flags.no_strings = 1; 173702ac6454SAndrew Thompson } 173802ac6454SAndrew Thompson /* 173902ac6454SAndrew Thompson * Workaround for buggy USB devices. 174002ac6454SAndrew Thompson * 174102ac6454SAndrew Thompson * It appears that some string-less USB chips will crash and 174202ac6454SAndrew Thompson * disappear if any attempts are made to read any string 174302ac6454SAndrew Thompson * descriptors. 174402ac6454SAndrew Thompson * 174502ac6454SAndrew Thompson * Try to detect such chips by checking the strings in the USB 174602ac6454SAndrew Thompson * device descriptor. If no strings are present there we 174702ac6454SAndrew Thompson * simply disable all USB strings. 174802ac6454SAndrew Thompson */ 174902ac6454SAndrew Thompson scratch_ptr = udev->bus->scratch[0].data; 175002ac6454SAndrew Thompson 175102ac6454SAndrew Thompson if (udev->ddesc.iManufacturer || 175202ac6454SAndrew Thompson udev->ddesc.iProduct || 175302ac6454SAndrew Thompson udev->ddesc.iSerialNumber) { 175402ac6454SAndrew Thompson /* read out the language ID string */ 1755a593f6b8SAndrew Thompson err = usbd_req_get_string_desc(udev, NULL, 1756c10e1453SAndrew Thompson (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE); 175702ac6454SAndrew Thompson } else { 175802ac6454SAndrew Thompson err = USB_ERR_INVAL; 175902ac6454SAndrew Thompson } 176002ac6454SAndrew Thompson 176102ac6454SAndrew Thompson if (err || (scratch_ptr[0] < 4)) { 176202ac6454SAndrew Thompson udev->flags.no_strings = 1; 176302ac6454SAndrew Thompson } else { 17647a918edfSAndrew Thompson uint16_t langid; 17657a918edfSAndrew Thompson uint16_t pref; 17667a918edfSAndrew Thompson uint16_t mask; 17677a918edfSAndrew Thompson uint8_t x; 17687a918edfSAndrew Thompson 17697a918edfSAndrew Thompson /* load preferred value and mask */ 17707a918edfSAndrew Thompson pref = usb_lang_id; 17717a918edfSAndrew Thompson mask = usb_lang_mask; 17727a918edfSAndrew Thompson 17737a918edfSAndrew Thompson /* align length correctly */ 17747a918edfSAndrew Thompson scratch_ptr[0] &= ~1; 17757a918edfSAndrew Thompson 17767a918edfSAndrew Thompson /* fix compiler warning */ 17777a918edfSAndrew Thompson langid = 0; 17787a918edfSAndrew Thompson 17797a918edfSAndrew Thompson /* search for preferred language */ 17807a918edfSAndrew Thompson for (x = 2; (x < scratch_ptr[0]); x += 2) { 17817a918edfSAndrew Thompson langid = UGETW(scratch_ptr + x); 17827a918edfSAndrew Thompson if ((langid & mask) == pref) 17837a918edfSAndrew Thompson break; 17847a918edfSAndrew Thompson } 17857a918edfSAndrew Thompson if (x >= scratch_ptr[0]) { 178602ac6454SAndrew Thompson /* pick the first language as the default */ 17877a918edfSAndrew Thompson DPRINTFN(1, "Using first language\n"); 17887a918edfSAndrew Thompson langid = UGETW(scratch_ptr + 2); 17897a918edfSAndrew Thompson } 17907a918edfSAndrew Thompson 17917a918edfSAndrew Thompson DPRINTFN(1, "Language selected: 0x%04x\n", langid); 17927a918edfSAndrew Thompson udev->langid = langid; 179302ac6454SAndrew Thompson } 179402ac6454SAndrew Thompson 179502ac6454SAndrew Thompson /* assume 100mA bus powered for now. Changed when configured. */ 179602ac6454SAndrew Thompson udev->power = USB_MIN_POWER; 1797c86aead6SAndrew Thompson /* fetch the vendor and product strings from the device */ 1798a593f6b8SAndrew Thompson usbd_set_device_strings(udev); 179902ac6454SAndrew Thompson 18002a4c6157SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 18012a4c6157SAndrew Thompson /* USB device mode setup is complete */ 18022a4c6157SAndrew Thompson err = 0; 18032a4c6157SAndrew Thompson goto config_done; 18042a4c6157SAndrew Thompson } 180502ac6454SAndrew Thompson 180602ac6454SAndrew Thompson /* 180702ac6454SAndrew Thompson * Most USB devices should attach to config index 0 by 180802ac6454SAndrew Thompson * default 180902ac6454SAndrew Thompson */ 1810a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) { 181102ac6454SAndrew Thompson config_index = 0; 181202ac6454SAndrew Thompson config_quirk = 1; 1813a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) { 181402ac6454SAndrew Thompson config_index = 1; 181502ac6454SAndrew Thompson config_quirk = 1; 1816a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) { 181702ac6454SAndrew Thompson config_index = 2; 181802ac6454SAndrew Thompson config_quirk = 1; 1819a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) { 182002ac6454SAndrew Thompson config_index = 3; 182102ac6454SAndrew Thompson config_quirk = 1; 1822a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) { 182302ac6454SAndrew Thompson config_index = 4; 182402ac6454SAndrew Thompson config_quirk = 1; 182502ac6454SAndrew Thompson } else { 182602ac6454SAndrew Thompson config_index = 0; 182702ac6454SAndrew Thompson config_quirk = 0; 182802ac6454SAndrew Thompson } 182902ac6454SAndrew Thompson 18302a4c6157SAndrew Thompson set_config_failed = 0; 183102ac6454SAndrew Thompson repeat_set_config: 183202ac6454SAndrew Thompson 183302ac6454SAndrew Thompson DPRINTF("setting config %u\n", config_index); 183402ac6454SAndrew Thompson 183502ac6454SAndrew Thompson /* get the USB device configured */ 1836a593f6b8SAndrew Thompson err = usbd_set_config_index(udev, config_index); 183702ac6454SAndrew Thompson if (err) { 183802ac6454SAndrew Thompson if (udev->ddesc.bNumConfigurations != 0) { 183902ac6454SAndrew Thompson if (!set_config_failed) { 184002ac6454SAndrew Thompson set_config_failed = 1; 184102ac6454SAndrew Thompson /* XXX try to re-enumerate the device */ 18422a4c6157SAndrew Thompson err = usbd_req_re_enumerate(udev, NULL); 184302ac6454SAndrew Thompson if (err == 0) 184402ac6454SAndrew Thompson goto repeat_set_config; 184502ac6454SAndrew Thompson } 18462a4c6157SAndrew Thompson DPRINTFN(0, "Failure selecting configuration index %u:" 18472a4c6157SAndrew Thompson "%s, port %u, addr %u (ignored)\n", 1848a593f6b8SAndrew Thompson config_index, usbd_errstr(err), udev->port_no, 184902ac6454SAndrew Thompson udev->address); 185002ac6454SAndrew Thompson } 185102ac6454SAndrew Thompson /* 18522a4c6157SAndrew Thompson * Some USB devices do not have any configurations. Ignore any 18532a4c6157SAndrew Thompson * set config failures! 185402ac6454SAndrew Thompson */ 185502ac6454SAndrew Thompson err = 0; 18562a4c6157SAndrew Thompson goto config_done; 18572a4c6157SAndrew Thompson } 18582a4c6157SAndrew Thompson if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) { 185902ac6454SAndrew Thompson if ((udev->cdesc->bNumInterface < 2) && 18602a4c6157SAndrew Thompson usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) { 18612a4c6157SAndrew Thompson DPRINTFN(0, "Found no endpoints, trying next config\n"); 186202ac6454SAndrew Thompson config_index++; 186302ac6454SAndrew Thompson goto repeat_set_config; 186402ac6454SAndrew Thompson } 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 } 18772a4c6157SAndrew Thompson } 1878d46dc4adSHans Petter Selasky if (set_config_failed == 0 && config_index == 0 && 18799157ad4bSHans Petter Selasky usb_test_quirk(&uaa, UQ_MSC_NO_SYNC_CACHE) == 0 && 18809157ad4bSHans Petter Selasky usb_test_quirk(&uaa, UQ_MSC_NO_GETMAXLUN) == 0) { 1881d46dc4adSHans Petter Selasky 1882d46dc4adSHans Petter Selasky /* 1883d46dc4adSHans Petter Selasky * Try to figure out if there are any MSC quirks we 1884d46dc4adSHans Petter Selasky * should apply automatically: 1885d46dc4adSHans Petter Selasky */ 1886d46dc4adSHans Petter Selasky err = usb_msc_auto_quirk(udev, 0); 1887d46dc4adSHans Petter Selasky 1888d46dc4adSHans Petter Selasky if (err != 0) { 1889d46dc4adSHans Petter Selasky set_config_failed = 1; 1890d46dc4adSHans Petter Selasky goto repeat_set_config; 1891d46dc4adSHans Petter Selasky } 1892d46dc4adSHans Petter Selasky } 189302ac6454SAndrew Thompson 18942a4c6157SAndrew Thompson config_done: 189502ac6454SAndrew Thompson DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n", 189602ac6454SAndrew Thompson udev->address, udev, udev->parent_hub); 189702ac6454SAndrew Thompson 189802ac6454SAndrew Thompson /* register our device - we are ready */ 1899a593f6b8SAndrew Thompson usb_bus_port_set_device(bus, parent_hub ? 190002ac6454SAndrew Thompson parent_hub->hub->ports + port_index : NULL, udev, device_index); 190102ac6454SAndrew Thompson 19020f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 19038755859aSAndrew Thompson /* Symlink the ugen device name */ 1904a593f6b8SAndrew Thompson udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name); 19058755859aSAndrew Thompson 19068755859aSAndrew Thompson /* Announce device */ 1907ae538d85SAndrew Thompson printf("%s: <%s> at %s\n", udev->ugen_name, 1908ae538d85SAndrew Thompson usb_get_manufacturer(udev), 190902ac6454SAndrew Thompson device_get_nameunit(udev->bus->bdev)); 19108bb77249SHans Petter Selasky #endif 19117efaaa9aSAndrew Thompson 19128bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 19133acd904dSAndrew Thompson usb_notify_addq("ATTACH", udev); 19148755859aSAndrew Thompson #endif 191502ac6454SAndrew Thompson done: 191602ac6454SAndrew Thompson if (err) { 1917d88688c7SAndrew Thompson /* 1918d88688c7SAndrew Thompson * Free USB device and all subdevices, if any. 1919d88688c7SAndrew Thompson */ 1920d88688c7SAndrew Thompson usb_free_device(udev, 0); 192102ac6454SAndrew Thompson udev = NULL; 192202ac6454SAndrew Thompson } 192302ac6454SAndrew Thompson return (udev); 192402ac6454SAndrew Thompson } 192502ac6454SAndrew Thompson 19260f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 19272ffd5fdcSHans Petter Selasky struct usb_fs_privdata * 19282ffd5fdcSHans Petter Selasky usb_make_dev(struct usb_device *udev, const char *devname, int ep, 19292ffd5fdcSHans Petter Selasky int fi, int rwmode, uid_t uid, gid_t gid, int mode) 1930ee3e3ff5SAndrew Thompson { 1931760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 19322ffd5fdcSHans Petter Selasky char buffer[32]; 1933ee3e3ff5SAndrew Thompson 1934ee3e3ff5SAndrew Thompson /* Store information to locate ourselves again later */ 1935760bc48eSAndrew Thompson pd = malloc(sizeof(struct usb_fs_privdata), M_USBDEV, 1936ee3e3ff5SAndrew Thompson M_WAITOK | M_ZERO); 1937ee3e3ff5SAndrew Thompson pd->bus_index = device_get_unit(udev->bus->bdev); 1938ee3e3ff5SAndrew Thompson pd->dev_index = udev->device_index; 1939ee3e3ff5SAndrew Thompson pd->ep_addr = ep; 19402ffd5fdcSHans Petter Selasky pd->fifo_index = fi; 19412ffd5fdcSHans Petter Selasky pd->mode = rwmode; 1942ee3e3ff5SAndrew Thompson 1943ee3e3ff5SAndrew Thompson /* Now, create the device itself */ 19442ffd5fdcSHans Petter Selasky if (devname == NULL) { 19452ffd5fdcSHans Petter Selasky devname = buffer; 19462ffd5fdcSHans Petter Selasky snprintf(buffer, sizeof(buffer), USB_DEVICE_DIR "/%u.%u.%u", 1947f35aaff0SAndrew Thompson pd->bus_index, pd->dev_index, pd->ep_addr); 19482ffd5fdcSHans Petter Selasky } 19492ffd5fdcSHans Petter Selasky 19502ffd5fdcSHans Petter Selasky pd->cdev = make_dev(&usb_devsw, 0, uid, gid, mode, "%s", devname); 19512ffd5fdcSHans Petter Selasky 19522ffd5fdcSHans Petter Selasky if (pd->cdev == NULL) { 19532ffd5fdcSHans Petter Selasky DPRINTFN(0, "Failed to create device %s\n", devname); 19542ffd5fdcSHans Petter Selasky free(pd, M_USBDEV); 19552ffd5fdcSHans Petter Selasky return (NULL); 19562ffd5fdcSHans Petter Selasky } 19572ffd5fdcSHans Petter Selasky 19582ffd5fdcSHans Petter Selasky /* XXX setting si_drv1 and creating the device is not atomic! */ 1959ee3e3ff5SAndrew Thompson pd->cdev->si_drv1 = pd; 1960ee3e3ff5SAndrew Thompson 19612ffd5fdcSHans Petter Selasky return (pd); 19622ffd5fdcSHans Petter Selasky } 19632ffd5fdcSHans Petter Selasky 19642ffd5fdcSHans Petter Selasky void 19652ffd5fdcSHans Petter Selasky usb_destroy_dev(struct usb_fs_privdata *pd) 19662ffd5fdcSHans Petter Selasky { 19672ffd5fdcSHans Petter Selasky if (pd == NULL) 19682ffd5fdcSHans Petter Selasky return; 19692ffd5fdcSHans Petter Selasky 19702ffd5fdcSHans Petter Selasky destroy_dev(pd->cdev); 19712ffd5fdcSHans Petter Selasky 19722ffd5fdcSHans Petter Selasky free(pd, M_USBDEV); 1973ee3e3ff5SAndrew Thompson } 1974ee3e3ff5SAndrew Thompson 1975ee3e3ff5SAndrew Thompson static void 1976a593f6b8SAndrew Thompson usb_cdev_create(struct usb_device *udev) 1977ee3e3ff5SAndrew Thompson { 1978760bc48eSAndrew Thompson struct usb_config_descriptor *cd; 1979760bc48eSAndrew Thompson struct usb_endpoint_descriptor *ed; 1980760bc48eSAndrew Thompson struct usb_descriptor *desc; 1981760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 1982f5f145baSAndrew Thompson int inmode, outmode, inmask, outmask, mode; 1983f5f145baSAndrew Thompson uint8_t ep; 1984ee3e3ff5SAndrew Thompson 1985ee3e3ff5SAndrew Thompson KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries")); 1986ee3e3ff5SAndrew Thompson 1987ee3e3ff5SAndrew Thompson DPRINTFN(2, "Creating device nodes\n"); 1988ee3e3ff5SAndrew Thompson 1989a593f6b8SAndrew Thompson if (usbd_get_mode(udev) == USB_MODE_DEVICE) { 1990ee3e3ff5SAndrew Thompson inmode = FWRITE; 1991ee3e3ff5SAndrew Thompson outmode = FREAD; 1992ee3e3ff5SAndrew Thompson } else { /* USB_MODE_HOST */ 1993ee3e3ff5SAndrew Thompson inmode = FREAD; 1994ee3e3ff5SAndrew Thompson outmode = FWRITE; 1995ee3e3ff5SAndrew Thompson } 1996ee3e3ff5SAndrew Thompson 1997f5f145baSAndrew Thompson inmask = 0; 1998f5f145baSAndrew Thompson outmask = 0; 1999f5f145baSAndrew Thompson desc = NULL; 2000f5f145baSAndrew Thompson 2001f5f145baSAndrew Thompson /* 2002f5f145baSAndrew Thompson * Collect all used endpoint numbers instead of just 2003f5f145baSAndrew Thompson * generating 16 static endpoints. 2004f5f145baSAndrew Thompson */ 2005a593f6b8SAndrew Thompson cd = usbd_get_config_descriptor(udev); 2006a593f6b8SAndrew Thompson while ((desc = usb_desc_foreach(cd, desc))) { 2007f5f145baSAndrew Thompson /* filter out all endpoint descriptors */ 2008f5f145baSAndrew Thompson if ((desc->bDescriptorType == UDESC_ENDPOINT) && 2009f5f145baSAndrew Thompson (desc->bLength >= sizeof(*ed))) { 2010760bc48eSAndrew Thompson ed = (struct usb_endpoint_descriptor *)desc; 2011f5f145baSAndrew Thompson 2012f5f145baSAndrew Thompson /* update masks */ 2013f5f145baSAndrew Thompson ep = ed->bEndpointAddress; 2014f5f145baSAndrew Thompson if (UE_GET_DIR(ep) == UE_DIR_OUT) 2015f5f145baSAndrew Thompson outmask |= 1 << UE_GET_ADDR(ep); 2016f5f145baSAndrew Thompson else 2017f5f145baSAndrew Thompson inmask |= 1 << UE_GET_ADDR(ep); 2018f5f145baSAndrew Thompson } 2019f5f145baSAndrew Thompson } 2020ee3e3ff5SAndrew Thompson 2021ee3e3ff5SAndrew Thompson /* Create all available endpoints except EP0 */ 2022ee3e3ff5SAndrew Thompson for (ep = 1; ep < 16; ep++) { 20232ffd5fdcSHans Petter Selasky mode = (inmask & (1 << ep)) ? inmode : 0; 20242ffd5fdcSHans Petter Selasky mode |= (outmask & (1 << ep)) ? outmode : 0; 2025ee3e3ff5SAndrew Thompson if (mode == 0) 2026ee3e3ff5SAndrew Thompson continue; /* no IN or OUT endpoint */ 2027ee3e3ff5SAndrew Thompson 20282ffd5fdcSHans Petter Selasky pd = usb_make_dev(udev, NULL, ep, 0, 20292ffd5fdcSHans Petter Selasky mode, UID_ROOT, GID_OPERATOR, 0600); 20302ffd5fdcSHans Petter Selasky 20312ffd5fdcSHans Petter Selasky if (pd != NULL) 2032ee3e3ff5SAndrew Thompson LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next); 2033ee3e3ff5SAndrew Thompson } 2034ee3e3ff5SAndrew Thompson } 2035ee3e3ff5SAndrew Thompson 2036ee3e3ff5SAndrew Thompson static void 2037a593f6b8SAndrew Thompson usb_cdev_free(struct usb_device *udev) 2038ee3e3ff5SAndrew Thompson { 2039760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 2040ee3e3ff5SAndrew Thompson 2041ee3e3ff5SAndrew Thompson DPRINTFN(2, "Freeing device nodes\n"); 2042ee3e3ff5SAndrew Thompson 2043ee3e3ff5SAndrew Thompson while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) { 2044ee3e3ff5SAndrew Thompson KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt")); 2045ee3e3ff5SAndrew Thompson 2046ee3e3ff5SAndrew Thompson LIST_REMOVE(pd, pd_next); 2047ee3e3ff5SAndrew Thompson 20482ffd5fdcSHans Petter Selasky usb_destroy_dev(pd); 20492ffd5fdcSHans Petter Selasky } 2050ee3e3ff5SAndrew Thompson } 20510f6e8f93SAndrew Thompson #endif 2052ee3e3ff5SAndrew Thompson 205302ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2054a593f6b8SAndrew Thompson * usb_free_device 205502ac6454SAndrew Thompson * 2056d88688c7SAndrew Thompson * This function is NULL safe and will free an USB device and its 2057d88688c7SAndrew Thompson * children devices, if any. 2058bdd41206SAndrew Thompson * 2059d88688c7SAndrew Thompson * Flag values: Reserved, set to zero. 206002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 206102ac6454SAndrew Thompson void 2062a593f6b8SAndrew Thompson usb_free_device(struct usb_device *udev, uint8_t flag) 206302ac6454SAndrew Thompson { 2064760bc48eSAndrew Thompson struct usb_bus *bus; 2065bdd41206SAndrew Thompson 2066bdd41206SAndrew Thompson if (udev == NULL) 2067bdd41206SAndrew Thompson return; /* already freed */ 206802ac6454SAndrew Thompson 206902ac6454SAndrew Thompson DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no); 207002ac6454SAndrew Thompson 2071bd216778SAndrew Thompson bus = udev->bus; 2072a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_DETACHED); 2073bdd41206SAndrew Thompson 20748bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 20753acd904dSAndrew Thompson usb_notify_addq("DETACH", udev); 20768bb77249SHans Petter Selasky #endif 207702ac6454SAndrew Thompson 20788bb77249SHans Petter Selasky #if USB_HAVE_UGEN 2079ee3e3ff5SAndrew Thompson printf("%s: <%s> at %s (disconnected)\n", udev->ugen_name, 2080ae538d85SAndrew Thompson usb_get_manufacturer(udev), device_get_nameunit(bus->bdev)); 208102ac6454SAndrew Thompson 2082ee3e3ff5SAndrew Thompson /* Destroy UGEN symlink, if any */ 208302ac6454SAndrew Thompson if (udev->ugen_symlink) { 2084a593f6b8SAndrew Thompson usb_free_symlink(udev->ugen_symlink); 208502ac6454SAndrew Thompson udev->ugen_symlink = NULL; 208602ac6454SAndrew Thompson } 20878755859aSAndrew Thompson #endif 208802ac6454SAndrew Thompson /* 208902ac6454SAndrew Thompson * Unregister our device first which will prevent any further 209002ac6454SAndrew Thompson * references: 209102ac6454SAndrew Thompson */ 2092a593f6b8SAndrew Thompson usb_bus_port_set_device(bus, udev->parent_hub ? 209302ac6454SAndrew Thompson udev->parent_hub->hub->ports + udev->port_index : NULL, 209402ac6454SAndrew Thompson NULL, USB_ROOT_HUB_ADDR); 209502ac6454SAndrew Thompson 20960f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 209702ac6454SAndrew Thompson /* wait for all pending references to go away: */ 2098a593f6b8SAndrew Thompson mtx_lock(&usb_ref_lock); 209902ac6454SAndrew Thompson udev->refcount--; 210002ac6454SAndrew Thompson while (udev->refcount != 0) { 210191cd9240SAndrew Thompson cv_wait(&udev->ref_cv, &usb_ref_lock); 210202ac6454SAndrew Thompson } 2103a593f6b8SAndrew Thompson mtx_unlock(&usb_ref_lock); 2104bdd41206SAndrew Thompson 21052ffd5fdcSHans Petter Selasky usb_destroy_dev(udev->ctrl_dev); 21060f6e8f93SAndrew Thompson #endif 210702ac6454SAndrew Thompson 2108f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 210902ac6454SAndrew Thompson /* stop receiving any control transfers (Device Side Mode) */ 21105b3bb704SAndrew Thompson usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX); 211102ac6454SAndrew Thompson } 211202ac6454SAndrew Thompson 2113bdd41206SAndrew Thompson /* the following will get the device unconfigured in software */ 2114d88688c7SAndrew Thompson usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0); 211502ac6454SAndrew Thompson 211602ac6454SAndrew Thompson /* unsetup any leftover default USB transfers */ 21175b3bb704SAndrew Thompson usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX); 211802ac6454SAndrew Thompson 211902ac6454SAndrew Thompson /* template unsetup, if any */ 2120a593f6b8SAndrew Thompson (usb_temp_unsetup_p) (udev); 212102ac6454SAndrew Thompson 212202ac6454SAndrew Thompson /* 212302ac6454SAndrew Thompson * Make sure that our clear-stall messages are not queued 212402ac6454SAndrew Thompson * anywhere: 212502ac6454SAndrew Thompson */ 212602ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 2127a593f6b8SAndrew Thompson usb_proc_mwait(&udev->bus->non_giant_callback_proc, 212802ac6454SAndrew Thompson &udev->cs_msg[0], &udev->cs_msg[1]); 212902ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 213002ac6454SAndrew Thompson 213191cd9240SAndrew Thompson sx_destroy(&udev->ctrl_sx); 213291cd9240SAndrew Thompson sx_destroy(&udev->enum_sx); 21332df1e9a6SAndrew Thompson sx_destroy(&udev->sr_sx); 213402ac6454SAndrew Thompson 213591cd9240SAndrew Thompson cv_destroy(&udev->ctrlreq_cv); 213691cd9240SAndrew Thompson cv_destroy(&udev->ref_cv); 213702ac6454SAndrew Thompson 213891cd9240SAndrew Thompson mtx_destroy(&udev->device_mtx); 21398755859aSAndrew Thompson #if USB_HAVE_UGEN 2140ee3e3ff5SAndrew Thompson KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries")); 21418755859aSAndrew Thompson #endif 214202ac6454SAndrew Thompson 2143963169b4SHans Petter Selasky /* Uninitialise device */ 2144963169b4SHans Petter Selasky if (bus->methods->device_uninit != NULL) 2145963169b4SHans Petter Selasky (bus->methods->device_uninit) (udev); 2146963169b4SHans Petter Selasky 214702ac6454SAndrew Thompson /* free device */ 214828212de2SAndrew Thompson free(udev->serial, M_USB); 214928212de2SAndrew Thompson free(udev->manufacturer, M_USB); 215028212de2SAndrew Thompson free(udev->product, M_USB); 215102ac6454SAndrew Thompson free(udev, M_USB); 215202ac6454SAndrew Thompson } 215302ac6454SAndrew Thompson 215402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2155a593f6b8SAndrew Thompson * usbd_get_iface 215602ac6454SAndrew Thompson * 215702ac6454SAndrew Thompson * This function is the safe way to get the USB interface structure 215802ac6454SAndrew Thompson * pointer by interface index. 215902ac6454SAndrew Thompson * 216002ac6454SAndrew Thompson * Return values: 216102ac6454SAndrew Thompson * NULL: Interface not present. 216202ac6454SAndrew Thompson * Else: Pointer to USB interface structure. 216302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 2164760bc48eSAndrew Thompson struct usb_interface * 2165a593f6b8SAndrew Thompson usbd_get_iface(struct usb_device *udev, uint8_t iface_index) 216602ac6454SAndrew Thompson { 2167760bc48eSAndrew Thompson struct usb_interface *iface = udev->ifaces + iface_index; 216802ac6454SAndrew Thompson 2169bdd41206SAndrew Thompson if (iface_index >= udev->ifaces_max) 217002ac6454SAndrew Thompson return (NULL); 217102ac6454SAndrew Thompson return (iface); 217202ac6454SAndrew Thompson } 217302ac6454SAndrew Thompson 217402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 21753c8d24f4SAndrew Thompson * usbd_find_descriptor 217602ac6454SAndrew Thompson * 217702ac6454SAndrew Thompson * This function will lookup the first descriptor that matches the 217802ac6454SAndrew Thompson * criteria given by the arguments "type" and "subtype". Descriptors 217902ac6454SAndrew Thompson * will only be searched within the interface having the index 218002ac6454SAndrew Thompson * "iface_index". If the "id" argument points to an USB descriptor, 218102ac6454SAndrew Thompson * it will be skipped before the search is started. This allows 218202ac6454SAndrew Thompson * searching for multiple descriptors using the same criteria. Else 218302ac6454SAndrew Thompson * the search is started after the interface descriptor. 218402ac6454SAndrew Thompson * 218502ac6454SAndrew Thompson * Return values: 218602ac6454SAndrew Thompson * NULL: End of descriptors 218702ac6454SAndrew Thompson * Else: A descriptor matching the criteria 218802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 218902ac6454SAndrew Thompson void * 21903c8d24f4SAndrew Thompson usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index, 219102ac6454SAndrew Thompson uint8_t type, uint8_t type_mask, 219202ac6454SAndrew Thompson uint8_t subtype, uint8_t subtype_mask) 219302ac6454SAndrew Thompson { 2194760bc48eSAndrew Thompson struct usb_descriptor *desc; 2195760bc48eSAndrew Thompson struct usb_config_descriptor *cd; 2196760bc48eSAndrew Thompson struct usb_interface *iface; 219702ac6454SAndrew Thompson 2198a593f6b8SAndrew Thompson cd = usbd_get_config_descriptor(udev); 219902ac6454SAndrew Thompson if (cd == NULL) { 220002ac6454SAndrew Thompson return (NULL); 220102ac6454SAndrew Thompson } 220202ac6454SAndrew Thompson if (id == NULL) { 2203a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, iface_index); 220402ac6454SAndrew Thompson if (iface == NULL) { 220502ac6454SAndrew Thompson return (NULL); 220602ac6454SAndrew Thompson } 2207a593f6b8SAndrew Thompson id = usbd_get_interface_descriptor(iface); 220802ac6454SAndrew Thompson if (id == NULL) { 220902ac6454SAndrew Thompson return (NULL); 221002ac6454SAndrew Thompson } 221102ac6454SAndrew Thompson } 221202ac6454SAndrew Thompson desc = (void *)id; 221302ac6454SAndrew Thompson 2214a593f6b8SAndrew Thompson while ((desc = usb_desc_foreach(cd, desc))) { 221502ac6454SAndrew Thompson 221602ac6454SAndrew Thompson if (desc->bDescriptorType == UDESC_INTERFACE) { 221702ac6454SAndrew Thompson break; 221802ac6454SAndrew Thompson } 221902ac6454SAndrew Thompson if (((desc->bDescriptorType & type_mask) == type) && 222002ac6454SAndrew Thompson ((desc->bDescriptorSubtype & subtype_mask) == subtype)) { 222102ac6454SAndrew Thompson return (desc); 222202ac6454SAndrew Thompson } 222302ac6454SAndrew Thompson } 222402ac6454SAndrew Thompson return (NULL); 222502ac6454SAndrew Thompson } 222602ac6454SAndrew Thompson 222702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2228a593f6b8SAndrew Thompson * usb_devinfo 222902ac6454SAndrew Thompson * 223002ac6454SAndrew Thompson * This function will dump information from the device descriptor 223102ac6454SAndrew Thompson * belonging to the USB device pointed to by "udev", to the string 223202ac6454SAndrew Thompson * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes 223302ac6454SAndrew Thompson * including the terminating zero. 223402ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 223502ac6454SAndrew Thompson void 2236a593f6b8SAndrew Thompson usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len) 223702ac6454SAndrew Thompson { 2238760bc48eSAndrew Thompson struct usb_device_descriptor *udd = &udev->ddesc; 223902ac6454SAndrew Thompson uint16_t bcdDevice; 224002ac6454SAndrew Thompson uint16_t bcdUSB; 224102ac6454SAndrew Thompson 224202ac6454SAndrew Thompson bcdUSB = UGETW(udd->bcdUSB); 224302ac6454SAndrew Thompson bcdDevice = UGETW(udd->bcdDevice); 224402ac6454SAndrew Thompson 224502ac6454SAndrew Thompson if (udd->bDeviceClass != 0xFF) { 224602ac6454SAndrew Thompson snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/" 22478755859aSAndrew Thompson "%x.%02x, addr %d", 2248ae538d85SAndrew Thompson usb_get_manufacturer(udev), 2249ae538d85SAndrew Thompson usb_get_product(udev), 225002ac6454SAndrew Thompson udd->bDeviceClass, udd->bDeviceSubClass, 225102ac6454SAndrew Thompson (bcdUSB >> 8), bcdUSB & 0xFF, 225202ac6454SAndrew Thompson (bcdDevice >> 8), bcdDevice & 0xFF, 225302ac6454SAndrew Thompson udev->address); 225402ac6454SAndrew Thompson } else { 225502ac6454SAndrew Thompson snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/" 22568755859aSAndrew Thompson "%x.%02x, addr %d", 2257ae538d85SAndrew Thompson usb_get_manufacturer(udev), 2258ae538d85SAndrew Thompson usb_get_product(udev), 225902ac6454SAndrew Thompson (bcdUSB >> 8), bcdUSB & 0xFF, 226002ac6454SAndrew Thompson (bcdDevice >> 8), bcdDevice & 0xFF, 226102ac6454SAndrew Thompson udev->address); 226202ac6454SAndrew Thompson } 226302ac6454SAndrew Thompson } 226402ac6454SAndrew Thompson 2265ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 226602ac6454SAndrew Thompson /* 226702ac6454SAndrew Thompson * Descriptions of of known vendors and devices ("products"). 226802ac6454SAndrew Thompson */ 226902ac6454SAndrew Thompson struct usb_knowndev { 227002ac6454SAndrew Thompson uint16_t vendor; 227102ac6454SAndrew Thompson uint16_t product; 227202ac6454SAndrew Thompson uint32_t flags; 227302ac6454SAndrew Thompson const char *vendorname; 227402ac6454SAndrew Thompson const char *productname; 227502ac6454SAndrew Thompson }; 227602ac6454SAndrew Thompson 227702ac6454SAndrew Thompson #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */ 227802ac6454SAndrew Thompson 227902ac6454SAndrew Thompson #include "usbdevs.h" 228002ac6454SAndrew Thompson #include "usbdevs_data.h" 228102ac6454SAndrew Thompson #endif /* USB_VERBOSE */ 228202ac6454SAndrew Thompson 228302ac6454SAndrew Thompson static void 2284a593f6b8SAndrew Thompson usbd_set_device_strings(struct usb_device *udev) 228502ac6454SAndrew Thompson { 2286760bc48eSAndrew Thompson struct usb_device_descriptor *udd = &udev->ddesc; 2287ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 228802ac6454SAndrew Thompson const struct usb_knowndev *kdp; 228902ac6454SAndrew Thompson #endif 22902df1e9a6SAndrew Thompson char *temp_ptr; 22917a918edfSAndrew Thompson size_t temp_size; 229202ac6454SAndrew Thompson uint16_t vendor_id; 229302ac6454SAndrew Thompson uint16_t product_id; 229402ac6454SAndrew Thompson 22952df1e9a6SAndrew Thompson temp_ptr = (char *)udev->bus->scratch[0].data; 22967a918edfSAndrew Thompson temp_size = sizeof(udev->bus->scratch[0].data); 22977a918edfSAndrew Thompson 229802ac6454SAndrew Thompson vendor_id = UGETW(udd->idVendor); 229902ac6454SAndrew Thompson product_id = UGETW(udd->idProduct); 230002ac6454SAndrew Thompson 2301c86aead6SAndrew Thompson /* get serial number string */ 23027a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2303c86aead6SAndrew Thompson udev->ddesc.iSerialNumber); 23047a918edfSAndrew Thompson udev->serial = strdup(temp_ptr, M_USB); 230502ac6454SAndrew Thompson 2306c86aead6SAndrew Thompson /* get manufacturer string */ 23077a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2308c86aead6SAndrew Thompson udev->ddesc.iManufacturer); 23097a918edfSAndrew Thompson usb_trim_spaces(temp_ptr); 23107a918edfSAndrew Thompson if (temp_ptr[0] != '\0') 23117a918edfSAndrew Thompson udev->manufacturer = strdup(temp_ptr, M_USB); 2312c86aead6SAndrew Thompson 2313c86aead6SAndrew Thompson /* get product string */ 23147a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2315c86aead6SAndrew Thompson udev->ddesc.iProduct); 23167a918edfSAndrew Thompson usb_trim_spaces(temp_ptr); 23177a918edfSAndrew Thompson if (temp_ptr[0] != '\0') 23187a918edfSAndrew Thompson udev->product = strdup(temp_ptr, M_USB); 2319c86aead6SAndrew Thompson 2320ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 2321c86aead6SAndrew Thompson if (udev->manufacturer == NULL || udev->product == NULL) { 2322c86aead6SAndrew Thompson for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) { 232302ac6454SAndrew Thompson if (kdp->vendor == vendor_id && 232402ac6454SAndrew Thompson (kdp->product == product_id || 232502ac6454SAndrew Thompson (kdp->flags & USB_KNOWNDEV_NOPROD) != 0)) 232602ac6454SAndrew Thompson break; 232702ac6454SAndrew Thompson } 232802ac6454SAndrew Thompson if (kdp->vendorname != NULL) { 2329c86aead6SAndrew Thompson /* XXX should use pointer to knowndevs string */ 2330c86aead6SAndrew Thompson if (udev->manufacturer == NULL) { 2331c86aead6SAndrew Thompson udev->manufacturer = strdup(kdp->vendorname, 2332c86aead6SAndrew Thompson M_USB); 2333c86aead6SAndrew Thompson } 2334c86aead6SAndrew Thompson if (udev->product == NULL && 2335c86aead6SAndrew Thompson (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) { 2336c86aead6SAndrew Thompson udev->product = strdup(kdp->productname, 2337c86aead6SAndrew Thompson M_USB); 2338c86aead6SAndrew Thompson } 233902ac6454SAndrew Thompson } 234002ac6454SAndrew Thompson } 234102ac6454SAndrew Thompson #endif 2342c86aead6SAndrew Thompson /* Provide default strings if none were found */ 2343c86aead6SAndrew Thompson if (udev->manufacturer == NULL) { 23447a918edfSAndrew Thompson snprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id); 23457a918edfSAndrew Thompson udev->manufacturer = strdup(temp_ptr, M_USB); 234602ac6454SAndrew Thompson } 2347c86aead6SAndrew Thompson if (udev->product == NULL) { 23487a918edfSAndrew Thompson snprintf(temp_ptr, temp_size, "product 0x%04x", product_id); 23497a918edfSAndrew Thompson udev->product = strdup(temp_ptr, M_USB); 235002ac6454SAndrew Thompson } 235102ac6454SAndrew Thompson } 235202ac6454SAndrew Thompson 235302ac6454SAndrew Thompson /* 235402ac6454SAndrew Thompson * Returns: 235502ac6454SAndrew Thompson * See: USB_MODE_XXX 235602ac6454SAndrew Thompson */ 2357f29a0724SAndrew Thompson enum usb_hc_mode 2358a593f6b8SAndrew Thompson usbd_get_mode(struct usb_device *udev) 235902ac6454SAndrew Thompson { 2360f29a0724SAndrew Thompson return (udev->flags.usb_mode); 236102ac6454SAndrew Thompson } 236202ac6454SAndrew Thompson 236302ac6454SAndrew Thompson /* 236402ac6454SAndrew Thompson * Returns: 236502ac6454SAndrew Thompson * See: USB_SPEED_XXX 236602ac6454SAndrew Thompson */ 23678d2dd5ddSAndrew Thompson enum usb_dev_speed 2368a593f6b8SAndrew Thompson usbd_get_speed(struct usb_device *udev) 236902ac6454SAndrew Thompson { 237002ac6454SAndrew Thompson return (udev->speed); 237102ac6454SAndrew Thompson } 237202ac6454SAndrew Thompson 237302ac6454SAndrew Thompson uint32_t 2374a593f6b8SAndrew Thompson usbd_get_isoc_fps(struct usb_device *udev) 237502ac6454SAndrew Thompson { 237602ac6454SAndrew Thompson ; /* indent fix */ 237702ac6454SAndrew Thompson switch (udev->speed) { 237802ac6454SAndrew Thompson case USB_SPEED_LOW: 237902ac6454SAndrew Thompson case USB_SPEED_FULL: 238002ac6454SAndrew Thompson return (1000); 238102ac6454SAndrew Thompson default: 238202ac6454SAndrew Thompson return (8000); 238302ac6454SAndrew Thompson } 238402ac6454SAndrew Thompson } 238502ac6454SAndrew Thompson 2386760bc48eSAndrew Thompson struct usb_device_descriptor * 2387a593f6b8SAndrew Thompson usbd_get_device_descriptor(struct usb_device *udev) 238802ac6454SAndrew Thompson { 238902ac6454SAndrew Thompson if (udev == NULL) 239002ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 239102ac6454SAndrew Thompson return (&udev->ddesc); 239202ac6454SAndrew Thompson } 239302ac6454SAndrew Thompson 2394760bc48eSAndrew Thompson struct usb_config_descriptor * 2395a593f6b8SAndrew Thompson usbd_get_config_descriptor(struct usb_device *udev) 239602ac6454SAndrew Thompson { 239702ac6454SAndrew Thompson if (udev == NULL) 239802ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 239902ac6454SAndrew Thompson return (udev->cdesc); 240002ac6454SAndrew Thompson } 240102ac6454SAndrew Thompson 240202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2403a593f6b8SAndrew Thompson * usb_test_quirk - test a device for a given quirk 240402ac6454SAndrew Thompson * 240502ac6454SAndrew Thompson * Return values: 240602ac6454SAndrew Thompson * 0: The USB device does not have the given quirk. 240702ac6454SAndrew Thompson * Else: The USB device has the given quirk. 240802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 240902ac6454SAndrew Thompson uint8_t 2410a593f6b8SAndrew Thompson usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk) 241102ac6454SAndrew Thompson { 241202ac6454SAndrew Thompson uint8_t found; 24133f37fb62SHans Petter Selasky uint8_t x; 24143f37fb62SHans Petter Selasky 24153f37fb62SHans Petter Selasky if (quirk == UQ_NONE) 24163f37fb62SHans Petter Selasky return (0); 24173f37fb62SHans Petter Selasky 24183f37fb62SHans Petter Selasky /* search the automatic per device quirks first */ 24193f37fb62SHans Petter Selasky 24203f37fb62SHans Petter Selasky for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) { 24213f37fb62SHans Petter Selasky if (uaa->device->autoQuirk[x] == quirk) 24223f37fb62SHans Petter Selasky return (1); 24233f37fb62SHans Petter Selasky } 24243f37fb62SHans Petter Selasky 24253f37fb62SHans Petter Selasky /* search global quirk table, if any */ 242602ac6454SAndrew Thompson 2427a593f6b8SAndrew Thompson found = (usb_test_quirk_p) (&uaa->info, quirk); 24283f37fb62SHans Petter Selasky 242902ac6454SAndrew Thompson return (found); 243002ac6454SAndrew Thompson } 243102ac6454SAndrew Thompson 2432760bc48eSAndrew Thompson struct usb_interface_descriptor * 2433a593f6b8SAndrew Thompson usbd_get_interface_descriptor(struct usb_interface *iface) 243402ac6454SAndrew Thompson { 243502ac6454SAndrew Thompson if (iface == NULL) 243602ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 243702ac6454SAndrew Thompson return (iface->idesc); 243802ac6454SAndrew Thompson } 243902ac6454SAndrew Thompson 244002ac6454SAndrew Thompson uint8_t 2441a593f6b8SAndrew Thompson usbd_get_interface_altindex(struct usb_interface *iface) 244202ac6454SAndrew Thompson { 244302ac6454SAndrew Thompson return (iface->alt_index); 244402ac6454SAndrew Thompson } 244502ac6454SAndrew Thompson 244602ac6454SAndrew Thompson uint8_t 2447a593f6b8SAndrew Thompson usbd_get_bus_index(struct usb_device *udev) 244802ac6454SAndrew Thompson { 244902ac6454SAndrew Thompson return ((uint8_t)device_get_unit(udev->bus->bdev)); 245002ac6454SAndrew Thompson } 245102ac6454SAndrew Thompson 245202ac6454SAndrew Thompson uint8_t 2453a593f6b8SAndrew Thompson usbd_get_device_index(struct usb_device *udev) 245402ac6454SAndrew Thompson { 245502ac6454SAndrew Thompson return (udev->device_index); 245602ac6454SAndrew Thompson } 245702ac6454SAndrew Thompson 24588bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 24593acd904dSAndrew Thompson static void 24603acd904dSAndrew Thompson usb_notify_addq(const char *type, struct usb_device *udev) 24613acd904dSAndrew Thompson { 24623acd904dSAndrew Thompson struct usb_interface *iface; 24633acd904dSAndrew Thompson struct sbuf *sb; 24643acd904dSAndrew Thompson int i; 24653acd904dSAndrew Thompson 24663acd904dSAndrew Thompson /* announce the device */ 24673acd904dSAndrew Thompson sb = sbuf_new_auto(); 24683acd904dSAndrew Thompson sbuf_printf(sb, 24698bb77249SHans Petter Selasky #if USB_HAVE_UGEN 24708bb77249SHans Petter Selasky "ugen=%s " 247102c40241SHans Petter Selasky "cdev=%s " 24728bb77249SHans Petter Selasky #endif 24733acd904dSAndrew Thompson "vendor=0x%04x " 24743acd904dSAndrew Thompson "product=0x%04x " 24753acd904dSAndrew Thompson "devclass=0x%02x " 24763acd904dSAndrew Thompson "devsubclass=0x%02x " 24773acd904dSAndrew Thompson "sernum=\"%s\" " 24783acd904dSAndrew Thompson "release=0x%04x " 247966390216SAndrew Thompson "mode=%s " 24803acd904dSAndrew Thompson "port=%u " 24818bb77249SHans Petter Selasky #if USB_HAVE_UGEN 24826df3eebbSNick Hibma "parent=%s" 24838bb77249SHans Petter Selasky #endif 24848bb77249SHans Petter Selasky "", 24858bb77249SHans Petter Selasky #if USB_HAVE_UGEN 24863acd904dSAndrew Thompson udev->ugen_name, 248702c40241SHans Petter Selasky udev->ugen_name, 24888bb77249SHans Petter Selasky #endif 24893acd904dSAndrew Thompson UGETW(udev->ddesc.idVendor), 24903acd904dSAndrew Thompson UGETW(udev->ddesc.idProduct), 24913acd904dSAndrew Thompson udev->ddesc.bDeviceClass, 24923acd904dSAndrew Thompson udev->ddesc.bDeviceSubClass, 2493ae538d85SAndrew Thompson usb_get_serial(udev), 24943acd904dSAndrew Thompson UGETW(udev->ddesc.bcdDevice), 249566390216SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device", 24968bb77249SHans Petter Selasky udev->port_no 24978bb77249SHans Petter Selasky #if USB_HAVE_UGEN 24988bb77249SHans Petter Selasky , udev->parent_hub != NULL ? 24993acd904dSAndrew Thompson udev->parent_hub->ugen_name : 25008bb77249SHans Petter Selasky device_get_nameunit(device_get_parent(udev->bus->bdev)) 25018bb77249SHans Petter Selasky #endif 25028bb77249SHans Petter Selasky ); 25033acd904dSAndrew Thompson sbuf_finish(sb); 25043acd904dSAndrew Thompson devctl_notify("USB", "DEVICE", type, sbuf_data(sb)); 25053acd904dSAndrew Thompson sbuf_delete(sb); 25063acd904dSAndrew Thompson 25073acd904dSAndrew Thompson /* announce each interface */ 25083acd904dSAndrew Thompson for (i = 0; i < USB_IFACE_MAX; i++) { 25093acd904dSAndrew Thompson iface = usbd_get_iface(udev, i); 25103acd904dSAndrew Thompson if (iface == NULL) 25113acd904dSAndrew Thompson break; /* end of interfaces */ 25123acd904dSAndrew Thompson if (iface->idesc == NULL) 25133acd904dSAndrew Thompson continue; /* no interface descriptor */ 25143acd904dSAndrew Thompson 25153acd904dSAndrew Thompson sb = sbuf_new_auto(); 25163acd904dSAndrew Thompson sbuf_printf(sb, 25178bb77249SHans Petter Selasky #if USB_HAVE_UGEN 25188bb77249SHans Petter Selasky "ugen=%s " 251902c40241SHans Petter Selasky "cdev=%s " 25208bb77249SHans Petter Selasky #endif 25213acd904dSAndrew Thompson "vendor=0x%04x " 25223acd904dSAndrew Thompson "product=0x%04x " 25233acd904dSAndrew Thompson "devclass=0x%02x " 25243acd904dSAndrew Thompson "devsubclass=0x%02x " 25253acd904dSAndrew Thompson "sernum=\"%s\" " 25263acd904dSAndrew Thompson "release=0x%04x " 252766390216SAndrew Thompson "mode=%s " 25283acd904dSAndrew Thompson "interface=%d " 25293acd904dSAndrew Thompson "endpoints=%d " 25303acd904dSAndrew Thompson "intclass=0x%02x " 25313acd904dSAndrew Thompson "intsubclass=0x%02x " 25326df3eebbSNick Hibma "intprotocol=0x%02x", 25338bb77249SHans Petter Selasky #if USB_HAVE_UGEN 25343acd904dSAndrew Thompson udev->ugen_name, 253502c40241SHans Petter Selasky udev->ugen_name, 25368bb77249SHans Petter Selasky #endif 25373acd904dSAndrew Thompson UGETW(udev->ddesc.idVendor), 25383acd904dSAndrew Thompson UGETW(udev->ddesc.idProduct), 25393acd904dSAndrew Thompson udev->ddesc.bDeviceClass, 25403acd904dSAndrew Thompson udev->ddesc.bDeviceSubClass, 2541ae538d85SAndrew Thompson usb_get_serial(udev), 25423acd904dSAndrew Thompson UGETW(udev->ddesc.bcdDevice), 254366390216SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device", 25443acd904dSAndrew Thompson iface->idesc->bInterfaceNumber, 25453acd904dSAndrew Thompson iface->idesc->bNumEndpoints, 25463acd904dSAndrew Thompson iface->idesc->bInterfaceClass, 25473acd904dSAndrew Thompson iface->idesc->bInterfaceSubClass, 25483acd904dSAndrew Thompson iface->idesc->bInterfaceProtocol); 25493acd904dSAndrew Thompson sbuf_finish(sb); 25503acd904dSAndrew Thompson devctl_notify("USB", "INTERFACE", type, sbuf_data(sb)); 25513acd904dSAndrew Thompson sbuf_delete(sb); 25523acd904dSAndrew Thompson } 25533acd904dSAndrew Thompson } 25548bb77249SHans Petter Selasky #endif 255502ac6454SAndrew Thompson 25568bb77249SHans Petter Selasky #if USB_HAVE_UGEN 255702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2558a593f6b8SAndrew Thompson * usb_fifo_free_wrap 255902ac6454SAndrew Thompson * 256002ac6454SAndrew Thompson * This function will free the FIFOs. 256102ac6454SAndrew Thompson * 2562bdd41206SAndrew Thompson * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag 2563bdd41206SAndrew Thompson * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free 2564bdd41206SAndrew Thompson * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and 2565bdd41206SAndrew Thompson * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non 2566bdd41206SAndrew Thompson * control endpoint FIFOs. If "iface_index" is not set to 2567bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" the flag has no effect. 256802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 256902ac6454SAndrew Thompson static void 2570a593f6b8SAndrew Thompson usb_fifo_free_wrap(struct usb_device *udev, 257102ac6454SAndrew Thompson uint8_t iface_index, uint8_t flag) 257202ac6454SAndrew Thompson { 2573760bc48eSAndrew Thompson struct usb_fifo *f; 257402ac6454SAndrew Thompson uint16_t i; 257502ac6454SAndrew Thompson 257602ac6454SAndrew Thompson /* 257702ac6454SAndrew Thompson * Free any USB FIFOs on the given interface: 257802ac6454SAndrew Thompson */ 257902ac6454SAndrew Thompson for (i = 0; i != USB_FIFO_MAX; i++) { 258002ac6454SAndrew Thompson f = udev->fifo[i]; 258102ac6454SAndrew Thompson if (f == NULL) { 258202ac6454SAndrew Thompson continue; 258302ac6454SAndrew Thompson } 258402ac6454SAndrew Thompson /* Check if the interface index matches */ 258502ac6454SAndrew Thompson if (iface_index == f->iface_index) { 2586a593f6b8SAndrew Thompson if (f->methods != &usb_ugen_methods) { 258702ac6454SAndrew Thompson /* 258802ac6454SAndrew Thompson * Don't free any non-generic FIFOs in 258902ac6454SAndrew Thompson * this case. 259002ac6454SAndrew Thompson */ 259102ac6454SAndrew Thompson continue; 259202ac6454SAndrew Thompson } 259302ac6454SAndrew Thompson if ((f->dev_ep_index == 0) && 259402ac6454SAndrew Thompson (f->fs_xfer == NULL)) { 259502ac6454SAndrew Thompson /* no need to free this FIFO */ 259602ac6454SAndrew Thompson continue; 259702ac6454SAndrew Thompson } 259802ac6454SAndrew Thompson } else if (iface_index == USB_IFACE_INDEX_ANY) { 2599a593f6b8SAndrew Thompson if ((f->methods == &usb_ugen_methods) && 2600bdd41206SAndrew Thompson (f->dev_ep_index == 0) && 2601bdd41206SAndrew Thompson (!(flag & USB_UNCFG_FLAG_FREE_EP0)) && 260202ac6454SAndrew Thompson (f->fs_xfer == NULL)) { 260302ac6454SAndrew Thompson /* no need to free this FIFO */ 260402ac6454SAndrew Thompson continue; 260502ac6454SAndrew Thompson } 260602ac6454SAndrew Thompson } else { 260702ac6454SAndrew Thompson /* no need to free this FIFO */ 260802ac6454SAndrew Thompson continue; 260902ac6454SAndrew Thompson } 261002ac6454SAndrew Thompson /* free this FIFO */ 2611a593f6b8SAndrew Thompson usb_fifo_free(f); 261202ac6454SAndrew Thompson } 261302ac6454SAndrew Thompson } 26140f6e8f93SAndrew Thompson #endif 261502ac6454SAndrew Thompson 261602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2617a593f6b8SAndrew Thompson * usb_peer_can_wakeup 261802ac6454SAndrew Thompson * 261902ac6454SAndrew Thompson * Return values: 262002ac6454SAndrew Thompson * 0: Peer cannot do resume signalling. 262102ac6454SAndrew Thompson * Else: Peer can do resume signalling. 262202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 262302ac6454SAndrew Thompson uint8_t 2624a593f6b8SAndrew Thompson usb_peer_can_wakeup(struct usb_device *udev) 262502ac6454SAndrew Thompson { 2626760bc48eSAndrew Thompson const struct usb_config_descriptor *cdp; 262702ac6454SAndrew Thompson 262802ac6454SAndrew Thompson cdp = udev->cdesc; 2629f29a0724SAndrew Thompson if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) { 263002ac6454SAndrew Thompson return (cdp->bmAttributes & UC_REMOTE_WAKEUP); 263102ac6454SAndrew Thompson } 263202ac6454SAndrew Thompson return (0); /* not supported */ 263302ac6454SAndrew Thompson } 2634bd216778SAndrew Thompson 2635bd216778SAndrew Thompson void 2636a593f6b8SAndrew Thompson usb_set_device_state(struct usb_device *udev, enum usb_dev_state state) 2637bd216778SAndrew Thompson { 2638bd216778SAndrew Thompson 2639bd216778SAndrew Thompson KASSERT(state < USB_STATE_MAX, ("invalid udev state")); 2640bd216778SAndrew Thompson 2641bd216778SAndrew Thompson DPRINTF("udev %p state %s -> %s\n", udev, 2642a593f6b8SAndrew Thompson usb_statestr(udev->state), usb_statestr(state)); 2643bd216778SAndrew Thompson udev->state = state; 2644963169b4SHans Petter Selasky 2645963169b4SHans Petter Selasky if (udev->bus->methods->device_state_change != NULL) 2646963169b4SHans Petter Selasky (udev->bus->methods->device_state_change) (udev); 2647963169b4SHans Petter Selasky } 2648963169b4SHans Petter Selasky 2649963169b4SHans Petter Selasky enum usb_dev_state 2650963169b4SHans Petter Selasky usb_get_device_state(struct usb_device *udev) 2651963169b4SHans Petter Selasky { 2652963169b4SHans Petter Selasky if (udev == NULL) 2653963169b4SHans Petter Selasky return (USB_STATE_DETACHED); 2654963169b4SHans Petter Selasky return (udev->state); 2655bd216778SAndrew Thompson } 2656bd216778SAndrew Thompson 2657ec8f3127SAndrew Thompson uint8_t 2658a593f6b8SAndrew Thompson usbd_device_attached(struct usb_device *udev) 2659bd216778SAndrew Thompson { 2660bd216778SAndrew Thompson return (udev->state > USB_STATE_DETACHED); 2661bd216778SAndrew Thompson } 2662cb18f7d1SAlfred Perlstein 2663cb18f7d1SAlfred Perlstein /* The following function locks enumerating the given USB device. */ 2664cb18f7d1SAlfred Perlstein 2665cb18f7d1SAlfred Perlstein void 2666cb18f7d1SAlfred Perlstein usbd_enum_lock(struct usb_device *udev) 2667cb18f7d1SAlfred Perlstein { 266891cd9240SAndrew Thompson sx_xlock(&udev->enum_sx); 26692df1e9a6SAndrew Thompson sx_xlock(&udev->sr_sx); 2670cb18f7d1SAlfred Perlstein /* 2671cb18f7d1SAlfred Perlstein * NEWBUS LOCK NOTE: We should check if any parent SX locks 2672cb18f7d1SAlfred Perlstein * are locked before locking Giant. Else the lock can be 2673cb18f7d1SAlfred Perlstein * locked multiple times. 2674cb18f7d1SAlfred Perlstein */ 2675cb18f7d1SAlfred Perlstein mtx_lock(&Giant); 2676cb18f7d1SAlfred Perlstein } 2677cb18f7d1SAlfred Perlstein 2678cb18f7d1SAlfred Perlstein /* The following function unlocks enumerating the given USB device. */ 2679cb18f7d1SAlfred Perlstein 2680cb18f7d1SAlfred Perlstein void 2681cb18f7d1SAlfred Perlstein usbd_enum_unlock(struct usb_device *udev) 2682cb18f7d1SAlfred Perlstein { 2683cb18f7d1SAlfred Perlstein mtx_unlock(&Giant); 268491cd9240SAndrew Thompson sx_xunlock(&udev->enum_sx); 26852df1e9a6SAndrew Thompson sx_xunlock(&udev->sr_sx); 26862df1e9a6SAndrew Thompson } 26872df1e9a6SAndrew Thompson 26882df1e9a6SAndrew Thompson /* The following function locks suspend and resume. */ 26892df1e9a6SAndrew Thompson 26902df1e9a6SAndrew Thompson void 26912df1e9a6SAndrew Thompson usbd_sr_lock(struct usb_device *udev) 26922df1e9a6SAndrew Thompson { 26932df1e9a6SAndrew Thompson sx_xlock(&udev->sr_sx); 26942df1e9a6SAndrew Thompson /* 26952df1e9a6SAndrew Thompson * NEWBUS LOCK NOTE: We should check if any parent SX locks 26962df1e9a6SAndrew Thompson * are locked before locking Giant. Else the lock can be 26972df1e9a6SAndrew Thompson * locked multiple times. 26982df1e9a6SAndrew Thompson */ 26992df1e9a6SAndrew Thompson mtx_lock(&Giant); 27002df1e9a6SAndrew Thompson } 27012df1e9a6SAndrew Thompson 27022df1e9a6SAndrew Thompson /* The following function unlocks suspend and resume. */ 27032df1e9a6SAndrew Thompson 27042df1e9a6SAndrew Thompson void 27052df1e9a6SAndrew Thompson usbd_sr_unlock(struct usb_device *udev) 27062df1e9a6SAndrew Thompson { 27072df1e9a6SAndrew Thompson mtx_unlock(&Giant); 27082df1e9a6SAndrew Thompson sx_xunlock(&udev->sr_sx); 2709cb18f7d1SAlfred Perlstein } 2710cb18f7d1SAlfred Perlstein 2711cb18f7d1SAlfred Perlstein /* 2712cb18f7d1SAlfred Perlstein * The following function checks the enumerating lock for the given 2713cb18f7d1SAlfred Perlstein * USB device. 2714cb18f7d1SAlfred Perlstein */ 2715cb18f7d1SAlfred Perlstein 2716cb18f7d1SAlfred Perlstein uint8_t 2717cb18f7d1SAlfred Perlstein usbd_enum_is_locked(struct usb_device *udev) 2718cb18f7d1SAlfred Perlstein { 271991cd9240SAndrew Thompson return (sx_xlocked(&udev->enum_sx)); 2720cb18f7d1SAlfred Perlstein } 27218427ed84SHans Petter Selasky 27228427ed84SHans Petter Selasky /* 27238427ed84SHans Petter Selasky * The following function is used to set the per-interface specific 27248427ed84SHans Petter Selasky * plug and play information. The string referred to by the pnpinfo 27258427ed84SHans Petter Selasky * argument can safely be freed after calling this function. The 27268427ed84SHans Petter Selasky * pnpinfo of an interface will be reset at device detach or when 27278427ed84SHans Petter Selasky * passing a NULL argument to this function. This function 27288427ed84SHans Petter Selasky * returns zero on success, else a USB_ERR_XXX failure code. 27298427ed84SHans Petter Selasky */ 27308427ed84SHans Petter Selasky 27318427ed84SHans Petter Selasky usb_error_t 27328427ed84SHans Petter Selasky usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo) 27338427ed84SHans Petter Selasky { 27348427ed84SHans Petter Selasky struct usb_interface *iface; 27358427ed84SHans Petter Selasky 27368427ed84SHans Petter Selasky iface = usbd_get_iface(udev, iface_index); 27378427ed84SHans Petter Selasky if (iface == NULL) 27388427ed84SHans Petter Selasky return (USB_ERR_INVAL); 27398427ed84SHans Petter Selasky 27408427ed84SHans Petter Selasky if (iface->pnpinfo != NULL) { 27418427ed84SHans Petter Selasky free(iface->pnpinfo, M_USBDEV); 27428427ed84SHans Petter Selasky iface->pnpinfo = NULL; 27438427ed84SHans Petter Selasky } 27448427ed84SHans Petter Selasky 27458427ed84SHans Petter Selasky if (pnpinfo == NULL || pnpinfo[0] == 0) 27468427ed84SHans Petter Selasky return (0); /* success */ 27478427ed84SHans Petter Selasky 27488427ed84SHans Petter Selasky iface->pnpinfo = strdup(pnpinfo, M_USBDEV); 27498427ed84SHans Petter Selasky if (iface->pnpinfo == NULL) 27508427ed84SHans Petter Selasky return (USB_ERR_NOMEM); 27518427ed84SHans Petter Selasky 27528427ed84SHans Petter Selasky return (0); /* success */ 27538427ed84SHans Petter Selasky } 27548427ed84SHans Petter Selasky 2755d46dc4adSHans Petter Selasky usb_error_t 2756d46dc4adSHans Petter Selasky usbd_add_dynamic_quirk(struct usb_device *udev, uint16_t quirk) 2757d46dc4adSHans Petter Selasky { 2758d46dc4adSHans Petter Selasky uint8_t x; 2759d46dc4adSHans Petter Selasky 2760d46dc4adSHans Petter Selasky for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) { 27613f37fb62SHans Petter Selasky if (udev->autoQuirk[x] == 0 || 27623f37fb62SHans Petter Selasky udev->autoQuirk[x] == quirk) { 2763d46dc4adSHans Petter Selasky udev->autoQuirk[x] = quirk; 2764d46dc4adSHans Petter Selasky return (0); /* success */ 2765d46dc4adSHans Petter Selasky } 2766d46dc4adSHans Petter Selasky } 2767d46dc4adSHans Petter Selasky return (USB_ERR_NOMEM); 2768d46dc4adSHans Petter Selasky } 2769a5cf1aaaSHans Petter Selasky 2770a5cf1aaaSHans Petter Selasky /* 2771a5cf1aaaSHans Petter Selasky * The following function is used to select the endpoint mode. It 2772a5cf1aaaSHans Petter Selasky * should not be called outside enumeration context. 2773a5cf1aaaSHans Petter Selasky */ 2774a5cf1aaaSHans Petter Selasky 2775a5cf1aaaSHans Petter Selasky usb_error_t 2776a5cf1aaaSHans Petter Selasky usbd_set_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep, 2777a5cf1aaaSHans Petter Selasky uint8_t ep_mode) 2778a5cf1aaaSHans Petter Selasky { 2779a5cf1aaaSHans Petter Selasky usb_error_t error; 2780a5cf1aaaSHans Petter Selasky 2781a5cf1aaaSHans Petter Selasky sx_assert(&udev->enum_sx, SA_LOCKED); 2782a5cf1aaaSHans Petter Selasky 2783a5cf1aaaSHans Petter Selasky if (udev->bus->methods->set_endpoint_mode != NULL) { 2784a5cf1aaaSHans Petter Selasky error = (udev->bus->methods->set_endpoint_mode) ( 2785a5cf1aaaSHans Petter Selasky udev, ep, ep_mode); 2786a5cf1aaaSHans Petter Selasky } else if (ep_mode != USB_EP_MODE_DEFAULT) { 2787a5cf1aaaSHans Petter Selasky error = USB_ERR_INVAL; 2788a5cf1aaaSHans Petter Selasky } else { 2789a5cf1aaaSHans Petter Selasky error = 0; 2790a5cf1aaaSHans Petter Selasky } 2791a5cf1aaaSHans Petter Selasky 2792a5cf1aaaSHans Petter Selasky /* only set new mode regardless of error */ 2793a5cf1aaaSHans Petter Selasky ep->ep_mode = ep_mode; 2794a5cf1aaaSHans Petter Selasky 2795a5cf1aaaSHans Petter Selasky return (error); 2796a5cf1aaaSHans Petter Selasky } 2797a5cf1aaaSHans Petter Selasky 2798a5cf1aaaSHans Petter Selasky uint8_t 2799a5cf1aaaSHans Petter Selasky usbd_get_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep) 2800a5cf1aaaSHans Petter Selasky { 2801a5cf1aaaSHans Petter Selasky return (ep->ep_mode); 2802a5cf1aaaSHans Petter Selasky } 2803