102ac6454SAndrew Thompson /* $FreeBSD$ */ 202ac6454SAndrew Thompson /*- 3718cf2ccSPedro F. Giffuni * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 4718cf2ccSPedro F. Giffuni * 502ac6454SAndrew Thompson * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 602ac6454SAndrew Thompson * 702ac6454SAndrew Thompson * Redistribution and use in source and binary forms, with or without 802ac6454SAndrew Thompson * modification, are permitted provided that the following conditions 902ac6454SAndrew Thompson * are met: 1002ac6454SAndrew Thompson * 1. Redistributions of source code must retain the above copyright 1102ac6454SAndrew Thompson * notice, this list of conditions and the following disclaimer. 1202ac6454SAndrew Thompson * 2. Redistributions in binary form must reproduce the above copyright 1302ac6454SAndrew Thompson * notice, this list of conditions and the following disclaimer in the 1402ac6454SAndrew Thompson * documentation and/or other materials provided with the distribution. 1502ac6454SAndrew Thompson * 1602ac6454SAndrew Thompson * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1702ac6454SAndrew Thompson * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1802ac6454SAndrew Thompson * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1902ac6454SAndrew Thompson * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 2002ac6454SAndrew Thompson * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2102ac6454SAndrew Thompson * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2202ac6454SAndrew Thompson * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2302ac6454SAndrew Thompson * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2402ac6454SAndrew Thompson * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2502ac6454SAndrew Thompson * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2602ac6454SAndrew Thompson * SUCH DAMAGE. 2702ac6454SAndrew Thompson */ 2802ac6454SAndrew Thompson 29d2b99310SHans Petter Selasky #ifdef USB_GLOBAL_INCLUDE_FILE 30d2b99310SHans Petter Selasky #include USB_GLOBAL_INCLUDE_FILE 31d2b99310SHans Petter Selasky #else 32ed6d949aSAndrew Thompson #include <sys/stdint.h> 33ed6d949aSAndrew Thompson #include <sys/stddef.h> 34ed6d949aSAndrew Thompson #include <sys/param.h> 35e2e050c8SConrad Meyer #include <sys/eventhandler.h> 36ed6d949aSAndrew Thompson #include <sys/queue.h> 37ed6d949aSAndrew Thompson #include <sys/systm.h> 38ed6d949aSAndrew Thompson #include <sys/kernel.h> 39ed6d949aSAndrew Thompson #include <sys/bus.h> 40ed6d949aSAndrew Thompson #include <sys/module.h> 41ed6d949aSAndrew Thompson #include <sys/lock.h> 42ed6d949aSAndrew Thompson #include <sys/mutex.h> 43ed6d949aSAndrew Thompson #include <sys/condvar.h> 44ed6d949aSAndrew Thompson #include <sys/sysctl.h> 45ed6d949aSAndrew Thompson #include <sys/sx.h> 46ed6d949aSAndrew Thompson #include <sys/unistd.h> 47ed6d949aSAndrew Thompson #include <sys/callout.h> 48ed6d949aSAndrew Thompson #include <sys/malloc.h> 49ed6d949aSAndrew Thompson #include <sys/priv.h> 50ed6d949aSAndrew Thompson #include <sys/conf.h> 51ed6d949aSAndrew Thompson #include <sys/fcntl.h> 52ed6d949aSAndrew Thompson 5302ac6454SAndrew Thompson #include <dev/usb/usb.h> 54ed6d949aSAndrew Thompson #include <dev/usb/usbdi.h> 55ed6d949aSAndrew Thompson #include <dev/usb/usbdi_util.h> 5602ac6454SAndrew Thompson #include <dev/usb/usb_ioctl.h> 57963169b4SHans Petter Selasky 58963169b4SHans Petter Selasky #if USB_HAVE_UGEN 59963169b4SHans Petter Selasky #include <sys/sbuf.h> 60963169b4SHans Petter Selasky #endif 61963169b4SHans Petter Selasky 6202ac6454SAndrew Thompson #include "usbdevs.h" 6302ac6454SAndrew Thompson 64a593f6b8SAndrew Thompson #define USB_DEBUG_VAR usb_debug 6502ac6454SAndrew Thompson 6602ac6454SAndrew Thompson #include <dev/usb/usb_core.h> 6702ac6454SAndrew Thompson #include <dev/usb/usb_debug.h> 6802ac6454SAndrew Thompson #include <dev/usb/usb_process.h> 6902ac6454SAndrew Thompson #include <dev/usb/usb_device.h> 7002ac6454SAndrew Thompson #include <dev/usb/usb_busdma.h> 7102ac6454SAndrew Thompson #include <dev/usb/usb_transfer.h> 7202ac6454SAndrew Thompson #include <dev/usb/usb_request.h> 7302ac6454SAndrew Thompson #include <dev/usb/usb_dynamic.h> 7402ac6454SAndrew Thompson #include <dev/usb/usb_hub.h> 7502ac6454SAndrew Thompson #include <dev/usb/usb_util.h> 7602ac6454SAndrew Thompson #include <dev/usb/usb_msctest.h> 77bdc081c6SAndrew Thompson #if USB_HAVE_UGEN 78bdc081c6SAndrew Thompson #include <dev/usb/usb_dev.h> 7902ac6454SAndrew Thompson #include <dev/usb/usb_generic.h> 80bdc081c6SAndrew Thompson #endif 8102ac6454SAndrew Thompson 8202ac6454SAndrew Thompson #include <dev/usb/quirk/usb_quirk.h> 8302ac6454SAndrew Thompson 8402ac6454SAndrew Thompson #include <dev/usb/usb_controller.h> 8502ac6454SAndrew Thompson #include <dev/usb/usb_bus.h> 86d2b99310SHans Petter Selasky #endif /* USB_GLOBAL_INCLUDE_FILE */ 8702ac6454SAndrew Thompson 8802ac6454SAndrew Thompson /* function prototypes */ 8902ac6454SAndrew Thompson 90f66c3cfcSEdward Tomasz Napierala static int sysctl_hw_usb_template(SYSCTL_HANDLER_ARGS); 91a593f6b8SAndrew Thompson static void usb_init_endpoint(struct usb_device *, uint8_t, 92963169b4SHans Petter Selasky struct usb_endpoint_descriptor *, 93963169b4SHans Petter Selasky struct usb_endpoint_ss_comp_descriptor *, 94963169b4SHans Petter Selasky struct usb_endpoint *); 95a593f6b8SAndrew Thompson static void usb_unconfigure(struct usb_device *, uint8_t); 96a593f6b8SAndrew Thompson static void usb_detach_device_sub(struct usb_device *, device_t *, 978427ed84SHans Petter Selasky char **, uint8_t); 98a593f6b8SAndrew Thompson static uint8_t usb_probe_and_attach_sub(struct usb_device *, 99760bc48eSAndrew Thompson struct usb_attach_arg *); 100a593f6b8SAndrew Thompson static void usb_init_attach_arg(struct usb_device *, 101760bc48eSAndrew Thompson struct usb_attach_arg *); 102a593f6b8SAndrew Thompson static void usb_suspend_resume_sub(struct usb_device *, device_t, 10302ac6454SAndrew Thompson uint8_t); 104a0d53e0bSHans Petter Selasky static usb_proc_callback_t usbd_clear_stall_proc; 105963169b4SHans Petter Selasky static usb_error_t usb_config_parse(struct usb_device *, uint8_t, uint8_t); 106a593f6b8SAndrew Thompson static void usbd_set_device_strings(struct usb_device *); 1078bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 108a593f6b8SAndrew Thompson static void usb_notify_addq(const char *type, struct usb_device *); 1098bb77249SHans Petter Selasky #endif 1108bb77249SHans Petter Selasky #if USB_HAVE_UGEN 111a593f6b8SAndrew Thompson static void usb_fifo_free_wrap(struct usb_device *, uint8_t, uint8_t); 112a593f6b8SAndrew Thompson static void usb_cdev_create(struct usb_device *); 113a593f6b8SAndrew Thompson static void usb_cdev_free(struct usb_device *); 1140f6e8f93SAndrew Thompson #endif 11502ac6454SAndrew Thompson 11602ac6454SAndrew Thompson /* This variable is global to allow easy access to it: */ 11702ac6454SAndrew Thompson 118fa49bce5SHans Petter Selasky #ifdef USB_TEMPLATE 119fa49bce5SHans Petter Selasky int usb_template = USB_TEMPLATE; 120fa49bce5SHans Petter Selasky #else 121c140287aSEdward Tomasz Napierala int usb_template = -1; 122fa49bce5SHans Petter Selasky #endif 12302ac6454SAndrew Thompson 124f66c3cfcSEdward Tomasz Napierala SYSCTL_PROC(_hw_usb, OID_AUTO, template, 125f66c3cfcSEdward Tomasz Napierala CTLTYPE_INT | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, 126f66c3cfcSEdward Tomasz Napierala NULL, 0, sysctl_hw_usb_template, 127f66c3cfcSEdward Tomasz Napierala "I", "Selected USB device side template"); 128f66c3cfcSEdward Tomasz Napierala 129f66c3cfcSEdward Tomasz Napierala /*------------------------------------------------------------------------* 130f66c3cfcSEdward Tomasz Napierala * usb_trigger_reprobe_on_off 131f66c3cfcSEdward Tomasz Napierala * 132f66c3cfcSEdward Tomasz Napierala * This function sets the pull up resistors for all ports currently 133f66c3cfcSEdward Tomasz Napierala * operating in device mode either on (when on_not_off is 1), or off 134f66c3cfcSEdward Tomasz Napierala * (when it's 0). 135f66c3cfcSEdward Tomasz Napierala *------------------------------------------------------------------------*/ 136f66c3cfcSEdward Tomasz Napierala static void 137f66c3cfcSEdward Tomasz Napierala usb_trigger_reprobe_on_off(int on_not_off) 138f66c3cfcSEdward Tomasz Napierala { 139f66c3cfcSEdward Tomasz Napierala struct usb_port_status ps; 140f66c3cfcSEdward Tomasz Napierala struct usb_bus *bus; 141f66c3cfcSEdward Tomasz Napierala struct usb_device *udev; 142f66c3cfcSEdward Tomasz Napierala usb_error_t err; 143f66c3cfcSEdward Tomasz Napierala int do_unlock, max; 144f66c3cfcSEdward Tomasz Napierala 145f66c3cfcSEdward Tomasz Napierala max = devclass_get_maxunit(usb_devclass_ptr); 146f66c3cfcSEdward Tomasz Napierala while (max >= 0) { 147f66c3cfcSEdward Tomasz Napierala mtx_lock(&usb_ref_lock); 148f66c3cfcSEdward Tomasz Napierala bus = devclass_get_softc(usb_devclass_ptr, max); 149f66c3cfcSEdward Tomasz Napierala max--; 150f66c3cfcSEdward Tomasz Napierala 151f66c3cfcSEdward Tomasz Napierala if (bus == NULL || bus->devices == NULL || 152f66c3cfcSEdward Tomasz Napierala bus->devices[USB_ROOT_HUB_ADDR] == NULL) { 153f66c3cfcSEdward Tomasz Napierala mtx_unlock(&usb_ref_lock); 154f66c3cfcSEdward Tomasz Napierala continue; 155f66c3cfcSEdward Tomasz Napierala } 156f66c3cfcSEdward Tomasz Napierala 157f66c3cfcSEdward Tomasz Napierala udev = bus->devices[USB_ROOT_HUB_ADDR]; 158f66c3cfcSEdward Tomasz Napierala 159f66c3cfcSEdward Tomasz Napierala if (udev->refcount == USB_DEV_REF_MAX) { 160f66c3cfcSEdward Tomasz Napierala mtx_unlock(&usb_ref_lock); 161f66c3cfcSEdward Tomasz Napierala continue; 162f66c3cfcSEdward Tomasz Napierala } 163f66c3cfcSEdward Tomasz Napierala 164f66c3cfcSEdward Tomasz Napierala udev->refcount++; 165f66c3cfcSEdward Tomasz Napierala mtx_unlock(&usb_ref_lock); 166f66c3cfcSEdward Tomasz Napierala 167f66c3cfcSEdward Tomasz Napierala do_unlock = usbd_enum_lock(udev); 168f66c3cfcSEdward Tomasz Napierala if (do_unlock > 1) { 169f66c3cfcSEdward Tomasz Napierala do_unlock = 0; 170f66c3cfcSEdward Tomasz Napierala goto next; 171f66c3cfcSEdward Tomasz Napierala } 172f66c3cfcSEdward Tomasz Napierala 173f66c3cfcSEdward Tomasz Napierala err = usbd_req_get_port_status(udev, NULL, &ps, 1); 174f66c3cfcSEdward Tomasz Napierala if (err != 0) { 175f66c3cfcSEdward Tomasz Napierala DPRINTF("usbd_req_get_port_status() " 176f66c3cfcSEdward Tomasz Napierala "failed: %s\n", usbd_errstr(err)); 177f66c3cfcSEdward Tomasz Napierala goto next; 178f66c3cfcSEdward Tomasz Napierala } 179f66c3cfcSEdward Tomasz Napierala 180f66c3cfcSEdward Tomasz Napierala if ((UGETW(ps.wPortStatus) & UPS_PORT_MODE_DEVICE) == 0) 181f66c3cfcSEdward Tomasz Napierala goto next; 182f66c3cfcSEdward Tomasz Napierala 183f66c3cfcSEdward Tomasz Napierala if (on_not_off) { 184f66c3cfcSEdward Tomasz Napierala err = usbd_req_set_port_feature(udev, NULL, 1, 185f66c3cfcSEdward Tomasz Napierala UHF_PORT_POWER); 186f66c3cfcSEdward Tomasz Napierala if (err != 0) { 187f66c3cfcSEdward Tomasz Napierala DPRINTF("usbd_req_set_port_feature() " 188f66c3cfcSEdward Tomasz Napierala "failed: %s\n", usbd_errstr(err)); 189f66c3cfcSEdward Tomasz Napierala } 190f66c3cfcSEdward Tomasz Napierala } else { 191f66c3cfcSEdward Tomasz Napierala err = usbd_req_clear_port_feature(udev, NULL, 1, 192f66c3cfcSEdward Tomasz Napierala UHF_PORT_POWER); 193f66c3cfcSEdward Tomasz Napierala if (err != 0) { 194f66c3cfcSEdward Tomasz Napierala DPRINTF("usbd_req_clear_port_feature() " 195f66c3cfcSEdward Tomasz Napierala "failed: %s\n", usbd_errstr(err)); 196f66c3cfcSEdward Tomasz Napierala } 197f66c3cfcSEdward Tomasz Napierala } 198f66c3cfcSEdward Tomasz Napierala 199f66c3cfcSEdward Tomasz Napierala next: 200f66c3cfcSEdward Tomasz Napierala mtx_lock(&usb_ref_lock); 201f66c3cfcSEdward Tomasz Napierala if (do_unlock) 202f66c3cfcSEdward Tomasz Napierala usbd_enum_unlock(udev); 203f66c3cfcSEdward Tomasz Napierala if (--(udev->refcount) == 0) 204f66c3cfcSEdward Tomasz Napierala cv_broadcast(&udev->ref_cv); 205f66c3cfcSEdward Tomasz Napierala mtx_unlock(&usb_ref_lock); 206f66c3cfcSEdward Tomasz Napierala } 207f66c3cfcSEdward Tomasz Napierala } 208f66c3cfcSEdward Tomasz Napierala 209f66c3cfcSEdward Tomasz Napierala /*------------------------------------------------------------------------* 210f66c3cfcSEdward Tomasz Napierala * usb_trigger_reprobe_all 211f66c3cfcSEdward Tomasz Napierala * 212f66c3cfcSEdward Tomasz Napierala * This function toggles the pull up resistors for all ports currently 213f66c3cfcSEdward Tomasz Napierala * operating in device mode, causing the host machine to reenumerate them. 214f66c3cfcSEdward Tomasz Napierala *------------------------------------------------------------------------*/ 215f66c3cfcSEdward Tomasz Napierala static void 216f66c3cfcSEdward Tomasz Napierala usb_trigger_reprobe_all(void) 217f66c3cfcSEdward Tomasz Napierala { 218f66c3cfcSEdward Tomasz Napierala 219f66c3cfcSEdward Tomasz Napierala /* 220f66c3cfcSEdward Tomasz Napierala * Set the pull up resistors off for all ports in device mode. 221f66c3cfcSEdward Tomasz Napierala */ 222f66c3cfcSEdward Tomasz Napierala usb_trigger_reprobe_on_off(0); 223f66c3cfcSEdward Tomasz Napierala 224f66c3cfcSEdward Tomasz Napierala /* 225f66c3cfcSEdward Tomasz Napierala * According to the DWC OTG spec this must be at least 3ms. 226f66c3cfcSEdward Tomasz Napierala */ 227f66c3cfcSEdward Tomasz Napierala usb_pause_mtx(NULL, USB_MS_TO_TICKS(USB_POWER_DOWN_TIME)); 228f66c3cfcSEdward Tomasz Napierala 229f66c3cfcSEdward Tomasz Napierala /* 230f66c3cfcSEdward Tomasz Napierala * Set the pull up resistors back on. 231f66c3cfcSEdward Tomasz Napierala */ 232f66c3cfcSEdward Tomasz Napierala usb_trigger_reprobe_on_off(1); 233f66c3cfcSEdward Tomasz Napierala } 234f66c3cfcSEdward Tomasz Napierala 235f66c3cfcSEdward Tomasz Napierala static int 236f66c3cfcSEdward Tomasz Napierala sysctl_hw_usb_template(SYSCTL_HANDLER_ARGS) 237f66c3cfcSEdward Tomasz Napierala { 238f66c3cfcSEdward Tomasz Napierala int error, val; 239f66c3cfcSEdward Tomasz Napierala 240f66c3cfcSEdward Tomasz Napierala val = usb_template; 241f66c3cfcSEdward Tomasz Napierala error = sysctl_handle_int(oidp, &val, 0, req); 242f66c3cfcSEdward Tomasz Napierala if (error != 0 || req->newptr == NULL || usb_template == val) 243f66c3cfcSEdward Tomasz Napierala return (error); 244f66c3cfcSEdward Tomasz Napierala 245f66c3cfcSEdward Tomasz Napierala usb_template = val; 246f66c3cfcSEdward Tomasz Napierala 247f66c3cfcSEdward Tomasz Napierala if (usb_template < 0) { 248f66c3cfcSEdward Tomasz Napierala usb_trigger_reprobe_on_off(0); 249f66c3cfcSEdward Tomasz Napierala } else { 250f66c3cfcSEdward Tomasz Napierala usb_trigger_reprobe_all(); 251f66c3cfcSEdward Tomasz Napierala } 252f66c3cfcSEdward Tomasz Napierala 253f66c3cfcSEdward Tomasz Napierala return (0); 254f66c3cfcSEdward Tomasz Napierala } 25502ac6454SAndrew Thompson 2567a918edfSAndrew Thompson /* English is default language */ 2577a918edfSAndrew Thompson 2587a918edfSAndrew Thompson static int usb_lang_id = 0x0009; 2597a918edfSAndrew Thompson static int usb_lang_mask = 0x00FF; 2607a918edfSAndrew Thompson 261af3b2549SHans Petter Selasky SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_id, CTLFLAG_RWTUN, 2627a918edfSAndrew Thompson &usb_lang_id, 0, "Preferred USB language ID"); 2637a918edfSAndrew Thompson 264af3b2549SHans Petter Selasky SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_mask, CTLFLAG_RWTUN, 2657a918edfSAndrew Thompson &usb_lang_mask, 0, "Preferred USB language mask"); 2667a918edfSAndrew Thompson 2674d4fa6edSAndrew Thompson static const char* statestr[USB_STATE_MAX] = { 2684d4fa6edSAndrew Thompson [USB_STATE_DETACHED] = "DETACHED", 2694d4fa6edSAndrew Thompson [USB_STATE_ATTACHED] = "ATTACHED", 2704d4fa6edSAndrew Thompson [USB_STATE_POWERED] = "POWERED", 2714d4fa6edSAndrew Thompson [USB_STATE_ADDRESSED] = "ADDRESSED", 2724d4fa6edSAndrew Thompson [USB_STATE_CONFIGURED] = "CONFIGURED", 2734d4fa6edSAndrew Thompson }; 2744d4fa6edSAndrew Thompson 2754d4fa6edSAndrew Thompson const char * 276a593f6b8SAndrew Thompson usb_statestr(enum usb_dev_state state) 2774d4fa6edSAndrew Thompson { 278ec8f3127SAndrew Thompson return ((state < USB_STATE_MAX) ? statestr[state] : "UNKNOWN"); 2794d4fa6edSAndrew Thompson } 28002ac6454SAndrew Thompson 281ae538d85SAndrew Thompson const char * 282ae538d85SAndrew Thompson usb_get_manufacturer(struct usb_device *udev) 283ae538d85SAndrew Thompson { 284ae538d85SAndrew Thompson return (udev->manufacturer ? udev->manufacturer : "Unknown"); 285ae538d85SAndrew Thompson } 286ae538d85SAndrew Thompson 287ae538d85SAndrew Thompson const char * 288ae538d85SAndrew Thompson usb_get_product(struct usb_device *udev) 289ae538d85SAndrew Thompson { 290ae538d85SAndrew Thompson return (udev->product ? udev->product : ""); 291ae538d85SAndrew Thompson } 292ae538d85SAndrew Thompson 293ae538d85SAndrew Thompson const char * 294ae538d85SAndrew Thompson usb_get_serial(struct usb_device *udev) 295ae538d85SAndrew Thompson { 296ae538d85SAndrew Thompson return (udev->serial ? udev->serial : ""); 297ae538d85SAndrew Thompson } 298ae538d85SAndrew Thompson 29902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 300a593f6b8SAndrew Thompson * usbd_get_ep_by_addr 30102ac6454SAndrew Thompson * 302ae60fdfbSAndrew Thompson * This function searches for an USB ep by endpoint address and 30302ac6454SAndrew Thompson * direction. 30402ac6454SAndrew Thompson * 30502ac6454SAndrew Thompson * Returns: 30602ac6454SAndrew Thompson * NULL: Failure 30702ac6454SAndrew Thompson * Else: Success 30802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 309ae60fdfbSAndrew Thompson struct usb_endpoint * 310a593f6b8SAndrew Thompson usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val) 31102ac6454SAndrew Thompson { 312ae60fdfbSAndrew Thompson struct usb_endpoint *ep = udev->endpoints; 313ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max; 31402ac6454SAndrew Thompson enum { 31502ac6454SAndrew Thompson EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR), 31602ac6454SAndrew Thompson }; 31702ac6454SAndrew Thompson 31802ac6454SAndrew Thompson /* 31902ac6454SAndrew Thompson * According to the USB specification not all bits are used 32002ac6454SAndrew Thompson * for the endpoint address. Keep defined bits only: 32102ac6454SAndrew Thompson */ 32202ac6454SAndrew Thompson ea_val &= EA_MASK; 32302ac6454SAndrew Thompson 32402ac6454SAndrew Thompson /* 32520733245SPedro F. Giffuni * Iterate across all the USB endpoints searching for a match 32602ac6454SAndrew Thompson * based on the endpoint address: 32702ac6454SAndrew Thompson */ 328ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 32902ac6454SAndrew Thompson 330ae60fdfbSAndrew Thompson if (ep->edesc == NULL) { 33102ac6454SAndrew Thompson continue; 33202ac6454SAndrew Thompson } 33302ac6454SAndrew Thompson /* do the mask and check the value */ 334ae60fdfbSAndrew Thompson if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) { 33502ac6454SAndrew Thompson goto found; 33602ac6454SAndrew Thompson } 33702ac6454SAndrew Thompson } 33802ac6454SAndrew Thompson 33902ac6454SAndrew Thompson /* 340ae60fdfbSAndrew Thompson * The default endpoint is always present and is checked separately: 34102ac6454SAndrew Thompson */ 34222039494SHans Petter Selasky if ((udev->ctrl_ep.edesc != NULL) && 3435b3bb704SAndrew Thompson ((udev->ctrl_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) { 3445b3bb704SAndrew Thompson ep = &udev->ctrl_ep; 34502ac6454SAndrew Thompson goto found; 34602ac6454SAndrew Thompson } 34702ac6454SAndrew Thompson return (NULL); 34802ac6454SAndrew Thompson 34902ac6454SAndrew Thompson found: 350ae60fdfbSAndrew Thompson return (ep); 35102ac6454SAndrew Thompson } 35202ac6454SAndrew Thompson 35302ac6454SAndrew Thompson /*------------------------------------------------------------------------* 354a593f6b8SAndrew Thompson * usbd_get_endpoint 35502ac6454SAndrew Thompson * 356ae60fdfbSAndrew Thompson * This function searches for an USB endpoint based on the information 357760bc48eSAndrew Thompson * given by the passed "struct usb_config" pointer. 35802ac6454SAndrew Thompson * 35902ac6454SAndrew Thompson * Return values: 36002ac6454SAndrew Thompson * NULL: No match. 361ae60fdfbSAndrew Thompson * Else: Pointer to "struct usb_endpoint". 36202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 363ae60fdfbSAndrew Thompson struct usb_endpoint * 364a593f6b8SAndrew Thompson usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index, 365760bc48eSAndrew Thompson const struct usb_config *setup) 36602ac6454SAndrew Thompson { 367ae60fdfbSAndrew Thompson struct usb_endpoint *ep = udev->endpoints; 368ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max; 36902ac6454SAndrew Thompson uint8_t index = setup->ep_index; 37002ac6454SAndrew Thompson uint8_t ea_mask; 37102ac6454SAndrew Thompson uint8_t ea_val; 37202ac6454SAndrew Thompson uint8_t type_mask; 37302ac6454SAndrew Thompson uint8_t type_val; 37402ac6454SAndrew Thompson 37502ac6454SAndrew Thompson DPRINTFN(10, "udev=%p iface_index=%d address=0x%x " 37602ac6454SAndrew Thompson "type=0x%x dir=0x%x index=%d\n", 37702ac6454SAndrew Thompson udev, iface_index, setup->endpoint, 37802ac6454SAndrew Thompson setup->type, setup->direction, setup->ep_index); 37902ac6454SAndrew Thompson 3804eae601eSAndrew Thompson /* check USB mode */ 3814eae601eSAndrew Thompson 382f29a0724SAndrew Thompson if (setup->usb_mode != USB_MODE_DUAL && 383f29a0724SAndrew Thompson udev->flags.usb_mode != setup->usb_mode) { 384ae60fdfbSAndrew Thompson /* wrong mode - no endpoint */ 3854eae601eSAndrew Thompson return (NULL); 3864eae601eSAndrew Thompson } 3874eae601eSAndrew Thompson 38802ac6454SAndrew Thompson /* setup expected endpoint direction mask and value */ 38902ac6454SAndrew Thompson 39051ec1603SAndrew Thompson if (setup->direction == UE_DIR_RX) { 39151ec1603SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 392f29a0724SAndrew Thompson ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ? 39351ec1603SAndrew Thompson UE_DIR_OUT : UE_DIR_IN; 39451ec1603SAndrew Thompson } else if (setup->direction == UE_DIR_TX) { 39551ec1603SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 396f29a0724SAndrew Thompson ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ? 39751ec1603SAndrew Thompson UE_DIR_IN : UE_DIR_OUT; 39851ec1603SAndrew Thompson } else if (setup->direction == UE_DIR_ANY) { 39902ac6454SAndrew Thompson /* match any endpoint direction */ 40002ac6454SAndrew Thompson ea_mask = 0; 40102ac6454SAndrew Thompson ea_val = 0; 40202ac6454SAndrew Thompson } else { 40302ac6454SAndrew Thompson /* match the given endpoint direction */ 40402ac6454SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 40502ac6454SAndrew Thompson ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT)); 40602ac6454SAndrew Thompson } 40702ac6454SAndrew Thompson 40802ac6454SAndrew Thompson /* setup expected endpoint address */ 40902ac6454SAndrew Thompson 41002ac6454SAndrew Thompson if (setup->endpoint == UE_ADDR_ANY) { 41102ac6454SAndrew Thompson /* match any endpoint address */ 41202ac6454SAndrew Thompson } else { 41302ac6454SAndrew Thompson /* match the given endpoint address */ 41402ac6454SAndrew Thompson ea_mask |= UE_ADDR; 41502ac6454SAndrew Thompson ea_val |= (setup->endpoint & UE_ADDR); 41602ac6454SAndrew Thompson } 41702ac6454SAndrew Thompson 41802ac6454SAndrew Thompson /* setup expected endpoint type */ 41902ac6454SAndrew Thompson 42002ac6454SAndrew Thompson if (setup->type == UE_BULK_INTR) { 42102ac6454SAndrew Thompson /* this will match BULK and INTERRUPT endpoints */ 42202ac6454SAndrew Thompson type_mask = 2; 42302ac6454SAndrew Thompson type_val = 2; 42402ac6454SAndrew Thompson } else if (setup->type == UE_TYPE_ANY) { 42502ac6454SAndrew Thompson /* match any endpoint type */ 42602ac6454SAndrew Thompson type_mask = 0; 42702ac6454SAndrew Thompson type_val = 0; 42802ac6454SAndrew Thompson } else { 42902ac6454SAndrew Thompson /* match the given endpoint type */ 43002ac6454SAndrew Thompson type_mask = UE_XFERTYPE; 43102ac6454SAndrew Thompson type_val = (setup->type & UE_XFERTYPE); 43202ac6454SAndrew Thompson } 43302ac6454SAndrew Thompson 43402ac6454SAndrew Thompson /* 43520733245SPedro F. Giffuni * Iterate across all the USB endpoints searching for a match 43602ac6454SAndrew Thompson * based on the endpoint address. Note that we are searching 437ae60fdfbSAndrew Thompson * the endpoints from the beginning of the "udev->endpoints" array. 43802ac6454SAndrew Thompson */ 439ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 44002ac6454SAndrew Thompson 441ae60fdfbSAndrew Thompson if ((ep->edesc == NULL) || 442ae60fdfbSAndrew Thompson (ep->iface_index != iface_index)) { 44302ac6454SAndrew Thompson continue; 44402ac6454SAndrew Thompson } 44502ac6454SAndrew Thompson /* do the masks and check the values */ 44602ac6454SAndrew Thompson 447ae60fdfbSAndrew Thompson if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) && 448ae60fdfbSAndrew Thompson ((ep->edesc->bmAttributes & type_mask) == type_val)) { 44902ac6454SAndrew Thompson if (!index--) { 45002ac6454SAndrew Thompson goto found; 45102ac6454SAndrew Thompson } 45202ac6454SAndrew Thompson } 45302ac6454SAndrew Thompson } 45402ac6454SAndrew Thompson 45502ac6454SAndrew Thompson /* 456ae60fdfbSAndrew Thompson * Match against default endpoint last, so that "any endpoint", "any 457ae60fdfbSAndrew Thompson * address" and "any direction" returns the first endpoint of the 45802ac6454SAndrew Thompson * interface. "iface_index" and "direction" is ignored: 45902ac6454SAndrew Thompson */ 46022039494SHans Petter Selasky if ((udev->ctrl_ep.edesc != NULL) && 4615b3bb704SAndrew Thompson ((udev->ctrl_ep.edesc->bEndpointAddress & ea_mask) == ea_val) && 4625b3bb704SAndrew Thompson ((udev->ctrl_ep.edesc->bmAttributes & type_mask) == type_val) && 46302ac6454SAndrew Thompson (!index)) { 4645b3bb704SAndrew Thompson ep = &udev->ctrl_ep; 46502ac6454SAndrew Thompson goto found; 46602ac6454SAndrew Thompson } 46702ac6454SAndrew Thompson return (NULL); 46802ac6454SAndrew Thompson 46902ac6454SAndrew Thompson found: 470ae60fdfbSAndrew Thompson return (ep); 47102ac6454SAndrew Thompson } 47202ac6454SAndrew Thompson 47302ac6454SAndrew Thompson /*------------------------------------------------------------------------* 474ed6d949aSAndrew Thompson * usbd_interface_count 47502ac6454SAndrew Thompson * 47602ac6454SAndrew Thompson * This function stores the number of USB interfaces excluding 47702ac6454SAndrew Thompson * alternate settings, which the USB config descriptor reports into 47802ac6454SAndrew Thompson * the unsigned 8-bit integer pointed to by "count". 47902ac6454SAndrew Thompson * 48002ac6454SAndrew Thompson * Returns: 48102ac6454SAndrew Thompson * 0: Success 48202ac6454SAndrew Thompson * Else: Failure 48302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 484e0a69b51SAndrew Thompson usb_error_t 485ed6d949aSAndrew Thompson usbd_interface_count(struct usb_device *udev, uint8_t *count) 48602ac6454SAndrew Thompson { 48702ac6454SAndrew Thompson if (udev->cdesc == NULL) { 48802ac6454SAndrew Thompson *count = 0; 48902ac6454SAndrew Thompson return (USB_ERR_NOT_CONFIGURED); 49002ac6454SAndrew Thompson } 491bdd41206SAndrew Thompson *count = udev->ifaces_max; 49202ac6454SAndrew Thompson return (USB_ERR_NORMAL_COMPLETION); 49302ac6454SAndrew Thompson } 49402ac6454SAndrew Thompson 49502ac6454SAndrew Thompson /*------------------------------------------------------------------------* 496a593f6b8SAndrew Thompson * usb_init_endpoint 49702ac6454SAndrew Thompson * 498ae60fdfbSAndrew Thompson * This function will initialise the USB endpoint structure pointed to by 499ae60fdfbSAndrew Thompson * the "endpoint" argument. The structure pointed to by "endpoint" must be 500bdd41206SAndrew Thompson * zeroed before calling this function. 50102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 50202ac6454SAndrew Thompson static void 503a593f6b8SAndrew Thompson usb_init_endpoint(struct usb_device *udev, uint8_t iface_index, 504963169b4SHans Petter Selasky struct usb_endpoint_descriptor *edesc, 505963169b4SHans Petter Selasky struct usb_endpoint_ss_comp_descriptor *ecomp, 506963169b4SHans Petter Selasky struct usb_endpoint *ep) 50702ac6454SAndrew Thompson { 508e892b3feSHans Petter Selasky const struct usb_bus_methods *methods; 509a5cf1aaaSHans Petter Selasky usb_stream_t x; 510ee3e3ff5SAndrew Thompson 511bdd41206SAndrew Thompson methods = udev->bus->methods; 51202ac6454SAndrew Thompson 513ae60fdfbSAndrew Thompson (methods->endpoint_init) (udev, edesc, ep); 51402ac6454SAndrew Thompson 515ae60fdfbSAndrew Thompson /* initialise USB endpoint structure */ 516ae60fdfbSAndrew Thompson ep->edesc = edesc; 517963169b4SHans Petter Selasky ep->ecomp = ecomp; 518ae60fdfbSAndrew Thompson ep->iface_index = iface_index; 519a5cf1aaaSHans Petter Selasky 520a5cf1aaaSHans Petter Selasky /* setup USB stream queues */ 521a5cf1aaaSHans Petter Selasky for (x = 0; x != USB_MAX_EP_STREAMS; x++) { 522a5cf1aaaSHans Petter Selasky TAILQ_INIT(&ep->endpoint_q[x].head); 523a5cf1aaaSHans Petter Selasky ep->endpoint_q[x].command = &usbd_pipe_start; 524a5cf1aaaSHans Petter Selasky } 52502ac6454SAndrew Thompson 52639307315SAndrew Thompson /* the pipe is not supported by the hardware */ 527ae60fdfbSAndrew Thompson if (ep->methods == NULL) 52839307315SAndrew Thompson return; 52939307315SAndrew Thompson 530a5cf1aaaSHans Petter Selasky /* check for SUPER-speed streams mode endpoint */ 531a5cf1aaaSHans Petter Selasky if (udev->speed == USB_SPEED_SUPER && ecomp != NULL && 532a5cf1aaaSHans Petter Selasky (edesc->bmAttributes & UE_XFERTYPE) == UE_BULK && 533a5cf1aaaSHans Petter Selasky (UE_GET_BULK_STREAMS(ecomp->bmAttributes) != 0)) { 534a5cf1aaaSHans Petter Selasky usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_STREAMS); 535a5cf1aaaSHans Petter Selasky } else { 536a5cf1aaaSHans Petter Selasky usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_DEFAULT); 537a5cf1aaaSHans Petter Selasky } 538a5cf1aaaSHans Petter Selasky 53902ac6454SAndrew Thompson /* clear stall, if any */ 540bdd41206SAndrew Thompson if (methods->clear_stall != NULL) { 54102ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 542ae60fdfbSAndrew Thompson (methods->clear_stall) (udev, ep); 54302ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 54402ac6454SAndrew Thompson } 54502ac6454SAndrew Thompson } 54602ac6454SAndrew Thompson 547bdd41206SAndrew Thompson /*-----------------------------------------------------------------------* 548a593f6b8SAndrew Thompson * usb_endpoint_foreach 54916589beaSAndrew Thompson * 55016589beaSAndrew Thompson * This function will iterate all the USB endpoints except the control 55116589beaSAndrew Thompson * endpoint. This function is NULL safe. 55216589beaSAndrew Thompson * 55316589beaSAndrew Thompson * Return values: 554ae60fdfbSAndrew Thompson * NULL: End of USB endpoints 555ae60fdfbSAndrew Thompson * Else: Pointer to next USB endpoint 55616589beaSAndrew Thompson *------------------------------------------------------------------------*/ 557ae60fdfbSAndrew Thompson struct usb_endpoint * 558a593f6b8SAndrew Thompson usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep) 55916589beaSAndrew Thompson { 560a9e26757SAndrew Thompson struct usb_endpoint *ep_end; 56116589beaSAndrew Thompson 56216589beaSAndrew Thompson /* be NULL safe */ 56316589beaSAndrew Thompson if (udev == NULL) 56416589beaSAndrew Thompson return (NULL); 56516589beaSAndrew Thompson 566a9e26757SAndrew Thompson ep_end = udev->endpoints + udev->endpoints_max; 567a9e26757SAndrew Thompson 568ae60fdfbSAndrew Thompson /* get next endpoint */ 569ae60fdfbSAndrew Thompson if (ep == NULL) 570ae60fdfbSAndrew Thompson ep = udev->endpoints; 57116589beaSAndrew Thompson else 572ae60fdfbSAndrew Thompson ep++; 57316589beaSAndrew Thompson 574ae60fdfbSAndrew Thompson /* find next allocated ep */ 575ae60fdfbSAndrew Thompson while (ep != ep_end) { 576ae60fdfbSAndrew Thompson if (ep->edesc != NULL) 577ae60fdfbSAndrew Thompson return (ep); 578ae60fdfbSAndrew Thompson ep++; 57916589beaSAndrew Thompson } 58016589beaSAndrew Thompson return (NULL); 58116589beaSAndrew Thompson } 58216589beaSAndrew Thompson 58316589beaSAndrew Thompson /*------------------------------------------------------------------------* 584b78e84d1SHans Petter Selasky * usb_wait_pending_refs 585d008478eSHans Petter Selasky * 586d008478eSHans Petter Selasky * This function will wait for any USB references to go away before 587b78e84d1SHans Petter Selasky * returning. This function is used before freeing a USB device. 588d008478eSHans Petter Selasky *------------------------------------------------------------------------*/ 589d008478eSHans Petter Selasky static void 590b78e84d1SHans Petter Selasky usb_wait_pending_refs(struct usb_device *udev) 591d008478eSHans Petter Selasky { 592d008478eSHans Petter Selasky #if USB_HAVE_UGEN 593b78e84d1SHans Petter Selasky DPRINTF("Refcount = %d\n", (int)udev->refcount); 594d008478eSHans Petter Selasky 595b78e84d1SHans Petter Selasky mtx_lock(&usb_ref_lock); 596b78e84d1SHans Petter Selasky udev->refcount--; 597d008478eSHans Petter Selasky while (1) { 598d008478eSHans Petter Selasky /* wait for any pending references to go away */ 599b78e84d1SHans Petter Selasky if (udev->refcount == 0) { 600b78e84d1SHans Petter Selasky /* prevent further refs being taken, if any */ 601d008478eSHans Petter Selasky udev->refcount = USB_DEV_REF_MAX; 602d008478eSHans Petter Selasky break; 603d008478eSHans Petter Selasky } 604d008478eSHans Petter Selasky cv_wait(&udev->ref_cv, &usb_ref_lock); 605d008478eSHans Petter Selasky } 606d008478eSHans Petter Selasky mtx_unlock(&usb_ref_lock); 607d008478eSHans Petter Selasky #endif 608d008478eSHans Petter Selasky } 609d008478eSHans Petter Selasky 610d008478eSHans Petter Selasky /*------------------------------------------------------------------------* 611a593f6b8SAndrew Thompson * usb_unconfigure 61202ac6454SAndrew Thompson * 613ae60fdfbSAndrew Thompson * This function will free all USB interfaces and USB endpoints belonging 61402ac6454SAndrew Thompson * to an USB device. 615bdd41206SAndrew Thompson * 616bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 61702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 61802ac6454SAndrew Thompson static void 619a593f6b8SAndrew Thompson usb_unconfigure(struct usb_device *udev, uint8_t flag) 62002ac6454SAndrew Thompson { 621bdd41206SAndrew Thompson uint8_t do_unlock; 62202ac6454SAndrew Thompson 6236950c75fSHans Petter Selasky /* Prevent re-enumeration */ 6246950c75fSHans Petter Selasky do_unlock = usbd_enum_lock(udev); 625bdd41206SAndrew Thompson 626bdd41206SAndrew Thompson /* detach all interface drivers */ 627a593f6b8SAndrew Thompson usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag); 628bdd41206SAndrew Thompson 629bdd41206SAndrew Thompson #if USB_HAVE_UGEN 630bdd41206SAndrew Thompson /* free all FIFOs except control endpoint FIFOs */ 631a593f6b8SAndrew Thompson usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag); 632bdd41206SAndrew Thompson 633bdd41206SAndrew Thompson /* 634bdd41206SAndrew Thompson * Free all cdev's, if any. 635bdd41206SAndrew Thompson */ 636a593f6b8SAndrew Thompson usb_cdev_free(udev); 637bdd41206SAndrew Thompson #endif 63802ac6454SAndrew Thompson 639bdc081c6SAndrew Thompson #if USB_HAVE_COMPAT_LINUX 64002ac6454SAndrew Thompson /* free Linux compat device, if any */ 6418d59ecb2SHans Petter Selasky if (udev->linux_endpoint_start != NULL) { 6428d59ecb2SHans Petter Selasky usb_linux_free_device_p(udev); 643760bc48eSAndrew Thompson udev->linux_endpoint_start = NULL; 64402ac6454SAndrew Thompson } 645bdc081c6SAndrew Thompson #endif 64602ac6454SAndrew Thompson 647a593f6b8SAndrew Thompson usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE); 64802ac6454SAndrew Thompson 649ae60fdfbSAndrew Thompson /* free "cdesc" after "ifaces" and "endpoints", if any */ 6507efaaa9aSAndrew Thompson if (udev->cdesc != NULL) { 651f29a0724SAndrew Thompson if (udev->flags.usb_mode != USB_MODE_DEVICE) 6522c79a775SHans Petter Selasky usbd_free_config_desc(udev, udev->cdesc); 65302ac6454SAndrew Thompson udev->cdesc = NULL; 65402ac6454SAndrew Thompson } 65502ac6454SAndrew Thompson /* set unconfigured state */ 65602ac6454SAndrew Thompson udev->curr_config_no = USB_UNCONFIG_NO; 65702ac6454SAndrew Thompson udev->curr_config_index = USB_UNCONFIG_INDEX; 658bdd41206SAndrew Thompson 659cb18f7d1SAlfred Perlstein if (do_unlock) 660cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 66102ac6454SAndrew Thompson } 66202ac6454SAndrew Thompson 66302ac6454SAndrew Thompson /*------------------------------------------------------------------------* 664a593f6b8SAndrew Thompson * usbd_set_config_index 66502ac6454SAndrew Thompson * 66602ac6454SAndrew Thompson * This function selects configuration by index, independent of the 66702ac6454SAndrew Thompson * actual configuration number. This function should not be used by 66802ac6454SAndrew Thompson * USB drivers. 66902ac6454SAndrew Thompson * 67002ac6454SAndrew Thompson * Returns: 67102ac6454SAndrew Thompson * 0: Success 67202ac6454SAndrew Thompson * Else: Failure 67302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 674e0a69b51SAndrew Thompson usb_error_t 675a593f6b8SAndrew Thompson usbd_set_config_index(struct usb_device *udev, uint8_t index) 67602ac6454SAndrew Thompson { 677760bc48eSAndrew Thompson struct usb_status ds; 678760bc48eSAndrew Thompson struct usb_config_descriptor *cdp; 67902ac6454SAndrew Thompson uint16_t power; 68002ac6454SAndrew Thompson uint16_t max_power; 68102ac6454SAndrew Thompson uint8_t selfpowered; 68202ac6454SAndrew Thompson uint8_t do_unlock; 683e0a69b51SAndrew Thompson usb_error_t err; 68402ac6454SAndrew Thompson 68502ac6454SAndrew Thompson DPRINTFN(6, "udev=%p index=%d\n", udev, index); 68602ac6454SAndrew Thompson 6876950c75fSHans Petter Selasky /* Prevent re-enumeration */ 6886950c75fSHans Petter Selasky do_unlock = usbd_enum_lock(udev); 68902ac6454SAndrew Thompson 690d88688c7SAndrew Thompson usb_unconfigure(udev, 0); 69102ac6454SAndrew Thompson 69202ac6454SAndrew Thompson if (index == USB_UNCONFIG_INDEX) { 69302ac6454SAndrew Thompson /* 69402ac6454SAndrew Thompson * Leave unallocated when unconfiguring the 695a593f6b8SAndrew Thompson * device. "usb_unconfigure()" will also reset 69602ac6454SAndrew Thompson * the current config number and index. 69702ac6454SAndrew Thompson */ 698a593f6b8SAndrew Thompson err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO); 699bd216778SAndrew Thompson if (udev->state == USB_STATE_CONFIGURED) 700a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_ADDRESSED); 70102ac6454SAndrew Thompson goto done; 70202ac6454SAndrew Thompson } 70302ac6454SAndrew Thompson /* get the full config descriptor */ 704f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 7057efaaa9aSAndrew Thompson /* save some memory */ 706a593f6b8SAndrew Thompson err = usbd_req_get_descriptor_ptr(udev, &cdp, 707459d369eSAndrew Thompson (UDESC_CONFIG << 8) | index); 7087efaaa9aSAndrew Thompson } else { 7097efaaa9aSAndrew Thompson /* normal request */ 710a593f6b8SAndrew Thompson err = usbd_req_get_config_desc_full(udev, 7112c79a775SHans Petter Selasky NULL, &cdp, index); 7127efaaa9aSAndrew Thompson } 71302ac6454SAndrew Thompson if (err) { 71402ac6454SAndrew Thompson goto done; 71502ac6454SAndrew Thompson } 71602ac6454SAndrew Thompson /* set the new config descriptor */ 71702ac6454SAndrew Thompson 71802ac6454SAndrew Thompson udev->cdesc = cdp; 71902ac6454SAndrew Thompson 72002ac6454SAndrew Thompson /* Figure out if the device is self or bus powered. */ 72102ac6454SAndrew Thompson selfpowered = 0; 72202ac6454SAndrew Thompson if ((!udev->flags.uq_bus_powered) && 72302ac6454SAndrew Thompson (cdp->bmAttributes & UC_SELF_POWERED) && 724f29a0724SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST)) { 72502ac6454SAndrew Thompson /* May be self powered. */ 72602ac6454SAndrew Thompson if (cdp->bmAttributes & UC_BUS_POWERED) { 72702ac6454SAndrew Thompson /* Must ask device. */ 728a593f6b8SAndrew Thompson err = usbd_req_get_device_status(udev, NULL, &ds); 72902ac6454SAndrew Thompson if (err) { 73002ac6454SAndrew Thompson DPRINTFN(0, "could not read " 73102ac6454SAndrew Thompson "device status: %s\n", 732a593f6b8SAndrew Thompson usbd_errstr(err)); 73302ac6454SAndrew Thompson } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) { 73402ac6454SAndrew Thompson selfpowered = 1; 73502ac6454SAndrew Thompson } 73602ac6454SAndrew Thompson DPRINTF("status=0x%04x \n", 73702ac6454SAndrew Thompson UGETW(ds.wStatus)); 73802ac6454SAndrew Thompson } else 73902ac6454SAndrew Thompson selfpowered = 1; 74002ac6454SAndrew Thompson } 74102ac6454SAndrew Thompson DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, " 74202ac6454SAndrew Thompson "selfpowered=%d, power=%d\n", 74302ac6454SAndrew Thompson udev, cdp, 74491f72cedSAndrew Thompson udev->address, cdp->bConfigurationValue, cdp->bmAttributes, 74502ac6454SAndrew Thompson selfpowered, cdp->bMaxPower * 2); 74602ac6454SAndrew Thompson 74702ac6454SAndrew Thompson /* Check if we have enough power. */ 74802ac6454SAndrew Thompson power = cdp->bMaxPower * 2; 74902ac6454SAndrew Thompson 75002ac6454SAndrew Thompson if (udev->parent_hub) { 75102ac6454SAndrew Thompson max_power = udev->parent_hub->hub->portpower; 75202ac6454SAndrew Thompson } else { 75302ac6454SAndrew Thompson max_power = USB_MAX_POWER; 75402ac6454SAndrew Thompson } 75502ac6454SAndrew Thompson 75602ac6454SAndrew Thompson if (power > max_power) { 75702ac6454SAndrew Thompson DPRINTFN(0, "power exceeded %d > %d\n", power, max_power); 75802ac6454SAndrew Thompson err = USB_ERR_NO_POWER; 75902ac6454SAndrew Thompson goto done; 76002ac6454SAndrew Thompson } 76102ac6454SAndrew Thompson /* Only update "self_powered" in USB Host Mode */ 762f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_HOST) { 76302ac6454SAndrew Thompson udev->flags.self_powered = selfpowered; 76402ac6454SAndrew Thompson } 76502ac6454SAndrew Thompson udev->power = power; 76602ac6454SAndrew Thompson udev->curr_config_no = cdp->bConfigurationValue; 76702ac6454SAndrew Thompson udev->curr_config_index = index; 768a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_CONFIGURED); 76902ac6454SAndrew Thompson 77002ac6454SAndrew Thompson /* Set the actual configuration value. */ 771a593f6b8SAndrew Thompson err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue); 77202ac6454SAndrew Thompson if (err) { 77302ac6454SAndrew Thompson goto done; 77402ac6454SAndrew Thompson } 775bdd41206SAndrew Thompson 776a593f6b8SAndrew Thompson err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC); 77702ac6454SAndrew Thompson if (err) { 77802ac6454SAndrew Thompson goto done; 77902ac6454SAndrew Thompson } 780bdd41206SAndrew Thompson 781a593f6b8SAndrew Thompson err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT); 782bdd41206SAndrew Thompson if (err) { 783bdd41206SAndrew Thompson goto done; 78402ac6454SAndrew Thompson } 785bdd41206SAndrew Thompson 7860f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 787ee3e3ff5SAndrew Thompson /* create device nodes for each endpoint */ 788a593f6b8SAndrew Thompson usb_cdev_create(udev); 7890f6e8f93SAndrew Thompson #endif 79002ac6454SAndrew Thompson 79102ac6454SAndrew Thompson done: 792a593f6b8SAndrew Thompson DPRINTF("error=%s\n", usbd_errstr(err)); 79302ac6454SAndrew Thompson if (err) { 794d88688c7SAndrew Thompson usb_unconfigure(udev, 0); 79502ac6454SAndrew Thompson } 796cb18f7d1SAlfred Perlstein if (do_unlock) 797cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 79802ac6454SAndrew Thompson return (err); 79902ac6454SAndrew Thompson } 80002ac6454SAndrew Thompson 80102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 802a593f6b8SAndrew Thompson * usb_config_parse 803bdd41206SAndrew Thompson * 804ae60fdfbSAndrew Thompson * This function will allocate and free USB interfaces and USB endpoints, 805ae60fdfbSAndrew Thompson * parse the USB configuration structure and initialise the USB endpoints 806bdd41206SAndrew Thompson * and interfaces. If "iface_index" is not equal to 807bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the 808bdd41206SAndrew Thompson * alternate_setting to be selected for the given interface. Else the 809bdd41206SAndrew Thompson * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be 810bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function 811bdd41206SAndrew Thompson * is typically called when setting the configuration or when setting 812bdd41206SAndrew Thompson * an alternate interface. 813bdd41206SAndrew Thompson * 814bdd41206SAndrew Thompson * Returns: 815bdd41206SAndrew Thompson * 0: Success 816bdd41206SAndrew Thompson * Else: Failure 817bdd41206SAndrew Thompson *------------------------------------------------------------------------*/ 818963169b4SHans Petter Selasky static usb_error_t 819a593f6b8SAndrew Thompson usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd) 820bdd41206SAndrew Thompson { 821760bc48eSAndrew Thompson struct usb_idesc_parse_state ips; 822760bc48eSAndrew Thompson struct usb_interface_descriptor *id; 823760bc48eSAndrew Thompson struct usb_endpoint_descriptor *ed; 824760bc48eSAndrew Thompson struct usb_interface *iface; 825ae60fdfbSAndrew Thompson struct usb_endpoint *ep; 826e0a69b51SAndrew Thompson usb_error_t err; 827bdd41206SAndrew Thompson uint8_t ep_curr; 828bdd41206SAndrew Thompson uint8_t ep_max; 829bdd41206SAndrew Thompson uint8_t temp; 830bdd41206SAndrew Thompson uint8_t do_init; 831bdd41206SAndrew Thompson uint8_t alt_index; 832bdd41206SAndrew Thompson 833bdd41206SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 834bdd41206SAndrew Thompson /* parameter overload */ 835bdd41206SAndrew Thompson alt_index = cmd; 836bdd41206SAndrew Thompson cmd = USB_CFG_INIT; 837bdd41206SAndrew Thompson } else { 838bdd41206SAndrew Thompson /* not used */ 839bdd41206SAndrew Thompson alt_index = 0; 840bdd41206SAndrew Thompson } 841bdd41206SAndrew Thompson 842bdd41206SAndrew Thompson err = 0; 843bdd41206SAndrew Thompson 844bdd41206SAndrew Thompson DPRINTFN(5, "iface_index=%d cmd=%d\n", 845bdd41206SAndrew Thompson iface_index, cmd); 846bdd41206SAndrew Thompson 847bdd41206SAndrew Thompson if (cmd == USB_CFG_FREE) 848bdd41206SAndrew Thompson goto cleanup; 849bdd41206SAndrew Thompson 850bdd41206SAndrew Thompson if (cmd == USB_CFG_INIT) { 85191cd9240SAndrew Thompson sx_assert(&udev->enum_sx, SA_LOCKED); 852bdd41206SAndrew Thompson 853ae60fdfbSAndrew Thompson /* check for in-use endpoints */ 854bdd41206SAndrew Thompson 855ae60fdfbSAndrew Thompson ep = udev->endpoints; 856ae60fdfbSAndrew Thompson ep_max = udev->endpoints_max; 857bdd41206SAndrew Thompson while (ep_max--) { 858ae60fdfbSAndrew Thompson /* look for matching endpoints */ 859bdd41206SAndrew Thompson if ((iface_index == USB_IFACE_INDEX_ANY) || 860ae60fdfbSAndrew Thompson (iface_index == ep->iface_index)) { 861f12c6c29SAndrew Thompson if (ep->refcount_alloc != 0) { 862bdd41206SAndrew Thompson /* 863bdd41206SAndrew Thompson * This typically indicates a 864bdd41206SAndrew Thompson * more serious error. 865bdd41206SAndrew Thompson */ 866bdd41206SAndrew Thompson err = USB_ERR_IN_USE; 867bdd41206SAndrew Thompson } else { 868ae60fdfbSAndrew Thompson /* reset endpoint */ 869ae60fdfbSAndrew Thompson memset(ep, 0, sizeof(*ep)); 870ae60fdfbSAndrew Thompson /* make sure we don't zero the endpoint again */ 871ae60fdfbSAndrew Thompson ep->iface_index = USB_IFACE_INDEX_ANY; 872bdd41206SAndrew Thompson } 873bdd41206SAndrew Thompson } 874ae60fdfbSAndrew Thompson ep++; 875bdd41206SAndrew Thompson } 876bdd41206SAndrew Thompson 877bdd41206SAndrew Thompson if (err) 878bdd41206SAndrew Thompson return (err); 879bdd41206SAndrew Thompson } 880bdd41206SAndrew Thompson 881bdd41206SAndrew Thompson memset(&ips, 0, sizeof(ips)); 882bdd41206SAndrew Thompson 883bdd41206SAndrew Thompson ep_curr = 0; 884bdd41206SAndrew Thompson ep_max = 0; 885bdd41206SAndrew Thompson 886a593f6b8SAndrew Thompson while ((id = usb_idesc_foreach(udev->cdesc, &ips))) { 887bdd41206SAndrew Thompson 888bdd41206SAndrew Thompson iface = udev->ifaces + ips.iface_index; 889bdd41206SAndrew Thompson 890bdd41206SAndrew Thompson /* check for specific interface match */ 891bdd41206SAndrew Thompson 892bdd41206SAndrew Thompson if (cmd == USB_CFG_INIT) { 893bdd41206SAndrew Thompson if ((iface_index != USB_IFACE_INDEX_ANY) && 894bdd41206SAndrew Thompson (iface_index != ips.iface_index)) { 895bdd41206SAndrew Thompson /* wrong interface */ 896bdd41206SAndrew Thompson do_init = 0; 897bdd41206SAndrew Thompson } else if (alt_index != ips.iface_index_alt) { 898bdd41206SAndrew Thompson /* wrong alternate setting */ 899bdd41206SAndrew Thompson do_init = 0; 900bdd41206SAndrew Thompson } else { 901bdd41206SAndrew Thompson /* initialise interface */ 902bdd41206SAndrew Thompson do_init = 1; 903bdd41206SAndrew Thompson } 904bdd41206SAndrew Thompson } else 905bdd41206SAndrew Thompson do_init = 0; 906bdd41206SAndrew Thompson 907bdd41206SAndrew Thompson /* check for new interface */ 908bdd41206SAndrew Thompson if (ips.iface_index_alt == 0) { 909bdd41206SAndrew Thompson /* update current number of endpoints */ 910bdd41206SAndrew Thompson ep_curr = ep_max; 911bdd41206SAndrew Thompson } 912bdd41206SAndrew Thompson /* check for init */ 913bdd41206SAndrew Thompson if (do_init) { 914bdd41206SAndrew Thompson /* setup the USB interface structure */ 915bdd41206SAndrew Thompson iface->idesc = id; 916bdd41206SAndrew Thompson /* set alternate index */ 917bdd41206SAndrew Thompson iface->alt_index = alt_index; 918d9073c1eSHans Petter Selasky /* set default interface parent */ 919d9073c1eSHans Petter Selasky if (iface_index == USB_IFACE_INDEX_ANY) { 920d9073c1eSHans Petter Selasky iface->parent_iface_index = 921d9073c1eSHans Petter Selasky USB_IFACE_INDEX_ANY; 922d9073c1eSHans Petter Selasky } 923bdd41206SAndrew Thompson } 924bdd41206SAndrew Thompson 925bdd41206SAndrew Thompson DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints); 926bdd41206SAndrew Thompson 927760bc48eSAndrew Thompson ed = (struct usb_endpoint_descriptor *)id; 928bdd41206SAndrew Thompson 929bdd41206SAndrew Thompson temp = ep_curr; 930bdd41206SAndrew Thompson 931bdd41206SAndrew Thompson /* iterate all the endpoint descriptors */ 932a593f6b8SAndrew Thompson while ((ed = usb_edesc_foreach(udev->cdesc, ed))) { 933bdd41206SAndrew Thompson 9345b0752bbSHans Petter Selasky /* check if endpoint limit has been reached */ 9355b0752bbSHans Petter Selasky if (temp >= USB_MAX_EP_UNITS) { 9365b0752bbSHans Petter Selasky DPRINTF("Endpoint limit reached\n"); 9375b0752bbSHans Petter Selasky break; 9385b0752bbSHans Petter Selasky } 939bdd41206SAndrew Thompson 940ae60fdfbSAndrew Thompson ep = udev->endpoints + temp; 941bdd41206SAndrew Thompson 942bdd41206SAndrew Thompson if (do_init) { 943963169b4SHans Petter Selasky void *ecomp; 944963169b4SHans Petter Selasky 945963169b4SHans Petter Selasky ecomp = usb_ed_comp_foreach(udev->cdesc, (void *)ed); 946963169b4SHans Petter Selasky if (ecomp != NULL) 947963169b4SHans Petter Selasky DPRINTFN(5, "Found endpoint companion descriptor\n"); 948963169b4SHans Petter Selasky 949a593f6b8SAndrew Thompson usb_init_endpoint(udev, 950963169b4SHans Petter Selasky ips.iface_index, ed, ecomp, ep); 951bdd41206SAndrew Thompson } 952bdd41206SAndrew Thompson 953bdd41206SAndrew Thompson temp ++; 954bdd41206SAndrew Thompson 955bdd41206SAndrew Thompson /* find maximum number of endpoints */ 956bdd41206SAndrew Thompson if (ep_max < temp) 957bdd41206SAndrew Thompson ep_max = temp; 958bdd41206SAndrew Thompson } 959bdd41206SAndrew Thompson } 960bdd41206SAndrew Thompson 961bdd41206SAndrew Thompson /* NOTE: It is valid to have no interfaces and no endpoints! */ 962bdd41206SAndrew Thompson 963bdd41206SAndrew Thompson if (cmd == USB_CFG_ALLOC) { 964bdd41206SAndrew Thompson udev->ifaces_max = ips.iface_index; 9655b0752bbSHans Petter Selasky #if (USB_HAVE_FIXED_IFACE == 0) 966bdd41206SAndrew Thompson udev->ifaces = NULL; 967bdd41206SAndrew Thompson if (udev->ifaces_max != 0) { 968bdd41206SAndrew Thompson udev->ifaces = malloc(sizeof(*iface) * udev->ifaces_max, 969bdd41206SAndrew Thompson M_USB, M_WAITOK | M_ZERO); 970bdd41206SAndrew Thompson if (udev->ifaces == NULL) { 971bdd41206SAndrew Thompson err = USB_ERR_NOMEM; 972bdd41206SAndrew Thompson goto done; 973bdd41206SAndrew Thompson } 974bdd41206SAndrew Thompson } 9755b0752bbSHans Petter Selasky #endif 9765b0752bbSHans Petter Selasky #if (USB_HAVE_FIXED_ENDPOINT == 0) 9779469c929SAndrew Thompson if (ep_max != 0) { 978ae60fdfbSAndrew Thompson udev->endpoints = malloc(sizeof(*ep) * ep_max, 979bdd41206SAndrew Thompson M_USB, M_WAITOK | M_ZERO); 980ae60fdfbSAndrew Thompson if (udev->endpoints == NULL) { 981bdd41206SAndrew Thompson err = USB_ERR_NOMEM; 982bdd41206SAndrew Thompson goto done; 983bdd41206SAndrew Thompson } 9849469c929SAndrew Thompson } else { 985ae60fdfbSAndrew Thompson udev->endpoints = NULL; 986bdd41206SAndrew Thompson } 9875b0752bbSHans Petter Selasky #endif 9889469c929SAndrew Thompson USB_BUS_LOCK(udev->bus); 989ae60fdfbSAndrew Thompson udev->endpoints_max = ep_max; 9909469c929SAndrew Thompson /* reset any ongoing clear-stall */ 991ae60fdfbSAndrew Thompson udev->ep_curr = NULL; 9929469c929SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 993bdd41206SAndrew Thompson } 9946c218933SHans Petter Selasky #if (USB_HAVE_FIXED_IFACE == 0) || (USB_HAVE_FIXED_ENDPOINT == 0) 995bdd41206SAndrew Thompson done: 9966c218933SHans Petter Selasky #endif 997bdd41206SAndrew Thompson if (err) { 998bdd41206SAndrew Thompson if (cmd == USB_CFG_ALLOC) { 999bdd41206SAndrew Thompson cleanup: 10009469c929SAndrew Thompson USB_BUS_LOCK(udev->bus); 1001ae60fdfbSAndrew Thompson udev->endpoints_max = 0; 10029469c929SAndrew Thompson /* reset any ongoing clear-stall */ 1003ae60fdfbSAndrew Thompson udev->ep_curr = NULL; 10049469c929SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 10059469c929SAndrew Thompson 10065b0752bbSHans Petter Selasky #if (USB_HAVE_FIXED_IFACE == 0) 1007bdd41206SAndrew Thompson free(udev->ifaces, M_USB); 1008bdd41206SAndrew Thompson udev->ifaces = NULL; 10095b0752bbSHans Petter Selasky #endif 10105b0752bbSHans Petter Selasky #if (USB_HAVE_FIXED_ENDPOINT == 0) 10115b0752bbSHans Petter Selasky free(udev->endpoints, M_USB); 1012ae60fdfbSAndrew Thompson udev->endpoints = NULL; 10135b0752bbSHans Petter Selasky #endif 1014bdd41206SAndrew Thompson udev->ifaces_max = 0; 1015bdd41206SAndrew Thompson } 1016bdd41206SAndrew Thompson } 1017bdd41206SAndrew Thompson return (err); 1018bdd41206SAndrew Thompson } 1019bdd41206SAndrew Thompson 1020bdd41206SAndrew Thompson /*------------------------------------------------------------------------* 1021a593f6b8SAndrew Thompson * usbd_set_alt_interface_index 102202ac6454SAndrew Thompson * 102302ac6454SAndrew Thompson * This function will select an alternate interface index for the 102402ac6454SAndrew Thompson * given interface index. The interface should not be in use when this 1025e2805033SAndrew Thompson * function is called. That means there should not be any open USB 1026e2805033SAndrew Thompson * transfers. Else an error is returned. If the alternate setting is 1027e2805033SAndrew Thompson * already set this function will simply return success. This function 1028e2805033SAndrew Thompson * is called in Host mode and Device mode! 102902ac6454SAndrew Thompson * 103002ac6454SAndrew Thompson * Returns: 103102ac6454SAndrew Thompson * 0: Success 103202ac6454SAndrew Thompson * Else: Failure 103302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1034e0a69b51SAndrew Thompson usb_error_t 1035a593f6b8SAndrew Thompson usbd_set_alt_interface_index(struct usb_device *udev, 103602ac6454SAndrew Thompson uint8_t iface_index, uint8_t alt_index) 103702ac6454SAndrew Thompson { 1038a593f6b8SAndrew Thompson struct usb_interface *iface = usbd_get_iface(udev, iface_index); 1039e0a69b51SAndrew Thompson usb_error_t err; 104002ac6454SAndrew Thompson uint8_t do_unlock; 104102ac6454SAndrew Thompson 10426950c75fSHans Petter Selasky /* Prevent re-enumeration */ 10436950c75fSHans Petter Selasky do_unlock = usbd_enum_lock(udev); 10446950c75fSHans Petter Selasky 104502ac6454SAndrew Thompson if (iface == NULL) { 104602ac6454SAndrew Thompson err = USB_ERR_INVAL; 104702ac6454SAndrew Thompson goto done; 104802ac6454SAndrew Thompson } 1049e2805033SAndrew Thompson if (iface->alt_index == alt_index) { 1050e2805033SAndrew Thompson /* 1051e2805033SAndrew Thompson * Optimise away duplicate setting of 1052e2805033SAndrew Thompson * alternate setting in USB Host Mode! 1053e2805033SAndrew Thompson */ 1054e2805033SAndrew Thompson err = 0; 1055e2805033SAndrew Thompson goto done; 1056e2805033SAndrew Thompson } 10570f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 105802ac6454SAndrew Thompson /* 105902ac6454SAndrew Thompson * Free all generic FIFOs for this interface, except control 106002ac6454SAndrew Thompson * endpoint FIFOs: 106102ac6454SAndrew Thompson */ 1062a593f6b8SAndrew Thompson usb_fifo_free_wrap(udev, iface_index, 0); 10630f6e8f93SAndrew Thompson #endif 1064bdd41206SAndrew Thompson 1065a593f6b8SAndrew Thompson err = usb_config_parse(udev, iface_index, alt_index); 106602ac6454SAndrew Thompson if (err) { 106702ac6454SAndrew Thompson goto done; 106802ac6454SAndrew Thompson } 1069bd73b187SAlfred Perlstein if (iface->alt_index != alt_index) { 1070bd73b187SAlfred Perlstein /* the alternate setting does not exist */ 1071bd73b187SAlfred Perlstein err = USB_ERR_INVAL; 1072bd73b187SAlfred Perlstein goto done; 1073bd73b187SAlfred Perlstein } 1074bd73b187SAlfred Perlstein 1075a593f6b8SAndrew Thompson err = usbd_req_set_alt_interface_no(udev, NULL, iface_index, 107602ac6454SAndrew Thompson iface->idesc->bAlternateSetting); 107702ac6454SAndrew Thompson 107802ac6454SAndrew Thompson done: 1079cb18f7d1SAlfred Perlstein if (do_unlock) 1080cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 108102ac6454SAndrew Thompson return (err); 108202ac6454SAndrew Thompson } 108302ac6454SAndrew Thompson 108402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1085a593f6b8SAndrew Thompson * usbd_set_endpoint_stall 108602ac6454SAndrew Thompson * 1087963169b4SHans Petter Selasky * This function is used to make a BULK or INTERRUPT endpoint send 1088963169b4SHans Petter Selasky * STALL tokens in USB device mode. 108902ac6454SAndrew Thompson * 109002ac6454SAndrew Thompson * Returns: 109102ac6454SAndrew Thompson * 0: Success 109202ac6454SAndrew Thompson * Else: Failure 109302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1094e0a69b51SAndrew Thompson usb_error_t 1095a593f6b8SAndrew Thompson usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep, 109602ac6454SAndrew Thompson uint8_t do_stall) 109702ac6454SAndrew Thompson { 1098760bc48eSAndrew Thompson struct usb_xfer *xfer; 1099a5cf1aaaSHans Petter Selasky usb_stream_t x; 110002ac6454SAndrew Thompson uint8_t et; 110102ac6454SAndrew Thompson uint8_t was_stalled; 110202ac6454SAndrew Thompson 1103ae60fdfbSAndrew Thompson if (ep == NULL) { 110402ac6454SAndrew Thompson /* nothing to do */ 110502ac6454SAndrew Thompson DPRINTF("Cannot find endpoint\n"); 110602ac6454SAndrew Thompson /* 110702ac6454SAndrew Thompson * Pretend that the clear or set stall request is 110802ac6454SAndrew Thompson * successful else some USB host stacks can do 110902ac6454SAndrew Thompson * strange things, especially when a control endpoint 111002ac6454SAndrew Thompson * stalls. 111102ac6454SAndrew Thompson */ 111202ac6454SAndrew Thompson return (0); 111302ac6454SAndrew Thompson } 1114ae60fdfbSAndrew Thompson et = (ep->edesc->bmAttributes & UE_XFERTYPE); 111502ac6454SAndrew Thompson 111602ac6454SAndrew Thompson if ((et != UE_BULK) && 111702ac6454SAndrew Thompson (et != UE_INTERRUPT)) { 111802ac6454SAndrew Thompson /* 111902ac6454SAndrew Thompson * Should not stall control 112002ac6454SAndrew Thompson * nor isochronous endpoints. 112102ac6454SAndrew Thompson */ 112202ac6454SAndrew Thompson DPRINTF("Invalid endpoint\n"); 112302ac6454SAndrew Thompson return (0); 112402ac6454SAndrew Thompson } 112502ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 112602ac6454SAndrew Thompson 112702ac6454SAndrew Thompson /* store current stall state */ 1128ae60fdfbSAndrew Thompson was_stalled = ep->is_stalled; 112902ac6454SAndrew Thompson 113002ac6454SAndrew Thompson /* check for no change */ 113102ac6454SAndrew Thompson if (was_stalled && do_stall) { 1132ae60fdfbSAndrew Thompson /* if the endpoint is already stalled do nothing */ 113302ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 113402ac6454SAndrew Thompson DPRINTF("No change\n"); 113502ac6454SAndrew Thompson return (0); 113602ac6454SAndrew Thompson } 113702ac6454SAndrew Thompson /* set stalled state */ 1138ae60fdfbSAndrew Thompson ep->is_stalled = 1; 113902ac6454SAndrew Thompson 114002ac6454SAndrew Thompson if (do_stall || (!was_stalled)) { 114102ac6454SAndrew Thompson if (!was_stalled) { 1142a5cf1aaaSHans Petter Selasky for (x = 0; x != USB_MAX_EP_STREAMS; x++) { 114302ac6454SAndrew Thompson /* lookup the current USB transfer, if any */ 1144a5cf1aaaSHans Petter Selasky xfer = ep->endpoint_q[x].curr; 1145a5cf1aaaSHans Petter Selasky if (xfer != NULL) { 114602ac6454SAndrew Thompson /* 1147a5cf1aaaSHans Petter Selasky * The "xfer_stall" method 1148a5cf1aaaSHans Petter Selasky * will complete the USB 1149a5cf1aaaSHans Petter Selasky * transfer like in case of a 1150a5cf1aaaSHans Petter Selasky * timeout setting the error 1151a5cf1aaaSHans Petter Selasky * code "USB_ERR_STALLED". 115202ac6454SAndrew Thompson */ 1153a5cf1aaaSHans Petter Selasky (udev->bus->methods->xfer_stall) (xfer); 1154a5cf1aaaSHans Petter Selasky } 1155a5cf1aaaSHans Petter Selasky } 1156a5cf1aaaSHans Petter Selasky } 1157a5cf1aaaSHans Petter Selasky (udev->bus->methods->set_stall) (udev, ep, &do_stall); 115802ac6454SAndrew Thompson } 115902ac6454SAndrew Thompson if (!do_stall) { 1160ae60fdfbSAndrew Thompson ep->toggle_next = 0; /* reset data toggle */ 1161ae60fdfbSAndrew Thompson ep->is_stalled = 0; /* clear stalled state */ 116202ac6454SAndrew Thompson 1163ae60fdfbSAndrew Thompson (udev->bus->methods->clear_stall) (udev, ep); 116402ac6454SAndrew Thompson 1165a5cf1aaaSHans Petter Selasky /* start the current or next transfer, if any */ 1166a5cf1aaaSHans Petter Selasky for (x = 0; x != USB_MAX_EP_STREAMS; x++) { 1167a5cf1aaaSHans Petter Selasky usb_command_wrapper(&ep->endpoint_q[x], 1168a5cf1aaaSHans Petter Selasky ep->endpoint_q[x].curr); 1169a5cf1aaaSHans Petter Selasky } 117002ac6454SAndrew Thompson } 117102ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 117202ac6454SAndrew Thompson return (0); 117302ac6454SAndrew Thompson } 117402ac6454SAndrew Thompson 117502ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1176a593f6b8SAndrew Thompson * usb_reset_iface_endpoints - used in USB device side mode 117702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1178e0a69b51SAndrew Thompson usb_error_t 1179a593f6b8SAndrew Thompson usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index) 118002ac6454SAndrew Thompson { 1181ae60fdfbSAndrew Thompson struct usb_endpoint *ep; 1182ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end; 118302ac6454SAndrew Thompson 1184ae60fdfbSAndrew Thompson ep = udev->endpoints; 1185ae60fdfbSAndrew Thompson ep_end = udev->endpoints + udev->endpoints_max; 118602ac6454SAndrew Thompson 1187ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 118802ac6454SAndrew Thompson 1189ae60fdfbSAndrew Thompson if ((ep->edesc == NULL) || 1190ae60fdfbSAndrew Thompson (ep->iface_index != iface_index)) { 119102ac6454SAndrew Thompson continue; 119202ac6454SAndrew Thompson } 119302ac6454SAndrew Thompson /* simulate a clear stall from the peer */ 1194bd73b187SAlfred Perlstein usbd_set_endpoint_stall(udev, ep, 0); 119502ac6454SAndrew Thompson } 119602ac6454SAndrew Thompson return (0); 119702ac6454SAndrew Thompson } 119802ac6454SAndrew Thompson 119902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1200a593f6b8SAndrew Thompson * usb_detach_device_sub 120102ac6454SAndrew Thompson * 120202ac6454SAndrew Thompson * This function will try to detach an USB device. If it fails a panic 120302ac6454SAndrew Thompson * will result. 1204bdd41206SAndrew Thompson * 1205bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 120602ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 120702ac6454SAndrew Thompson static void 1208a593f6b8SAndrew Thompson usb_detach_device_sub(struct usb_device *udev, device_t *ppdev, 12098427ed84SHans Petter Selasky char **ppnpinfo, uint8_t flag) 121002ac6454SAndrew Thompson { 121102ac6454SAndrew Thompson device_t dev; 12128427ed84SHans Petter Selasky char *pnpinfo; 121302ac6454SAndrew Thompson int err; 121402ac6454SAndrew Thompson 1215d88688c7SAndrew Thompson dev = *ppdev; 1216d88688c7SAndrew Thompson if (dev) { 121702ac6454SAndrew Thompson /* 121802ac6454SAndrew Thompson * NOTE: It is important to clear "*ppdev" before deleting 121902ac6454SAndrew Thompson * the child due to some device methods being called late 122002ac6454SAndrew Thompson * during the delete process ! 122102ac6454SAndrew Thompson */ 122202ac6454SAndrew Thompson *ppdev = NULL; 122302ac6454SAndrew Thompson 1224cabe79d9SMarius Strobl if (!rebooting) { 122502ac6454SAndrew Thompson device_printf(dev, "at %s, port %d, addr %d " 122602ac6454SAndrew Thompson "(disconnected)\n", 122702ac6454SAndrew Thompson device_get_nameunit(udev->parent_dev), 122802ac6454SAndrew Thompson udev->port_no, udev->address); 1229cabe79d9SMarius Strobl } 123002ac6454SAndrew Thompson 123102ac6454SAndrew Thompson if (device_is_attached(dev)) { 1232ec8f3127SAndrew Thompson if (udev->flags.peer_suspended) { 123302ac6454SAndrew Thompson err = DEVICE_RESUME(dev); 123402ac6454SAndrew Thompson if (err) { 1235767cb2e2SAndrew Thompson device_printf(dev, "Resume failed\n"); 123602ac6454SAndrew Thompson } 123702ac6454SAndrew Thompson } 123802ac6454SAndrew Thompson } 1239d3bf5efcSHans Petter Selasky /* detach and delete child */ 124002ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, dev)) { 124102ac6454SAndrew Thompson goto error; 124202ac6454SAndrew Thompson } 124302ac6454SAndrew Thompson } 12448427ed84SHans Petter Selasky 12458427ed84SHans Petter Selasky pnpinfo = *ppnpinfo; 12468427ed84SHans Petter Selasky if (pnpinfo != NULL) { 12478427ed84SHans Petter Selasky *ppnpinfo = NULL; 12488427ed84SHans Petter Selasky free(pnpinfo, M_USBDEV); 12498427ed84SHans Petter Selasky } 125002ac6454SAndrew Thompson return; 125102ac6454SAndrew Thompson 125202ac6454SAndrew Thompson error: 125302ac6454SAndrew Thompson /* Detach is not allowed to fail in the USB world */ 12548427ed84SHans Petter Selasky panic("usb_detach_device_sub: A USB driver would not detach\n"); 125502ac6454SAndrew Thompson } 125602ac6454SAndrew Thompson 125702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1258a593f6b8SAndrew Thompson * usb_detach_device 125902ac6454SAndrew Thompson * 126002ac6454SAndrew Thompson * The following function will detach the matching interfaces. 126102ac6454SAndrew Thompson * This function is NULL safe. 1262bdd41206SAndrew Thompson * 1263bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 126402ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 126502ac6454SAndrew Thompson void 1266a593f6b8SAndrew Thompson usb_detach_device(struct usb_device *udev, uint8_t iface_index, 1267bdd41206SAndrew Thompson uint8_t flag) 126802ac6454SAndrew Thompson { 1269760bc48eSAndrew Thompson struct usb_interface *iface; 127002ac6454SAndrew Thompson uint8_t i; 127102ac6454SAndrew Thompson 127202ac6454SAndrew Thompson if (udev == NULL) { 127302ac6454SAndrew Thompson /* nothing to do */ 127402ac6454SAndrew Thompson return; 127502ac6454SAndrew Thompson } 127602ac6454SAndrew Thompson DPRINTFN(4, "udev=%p\n", udev); 127702ac6454SAndrew Thompson 127891cd9240SAndrew Thompson sx_assert(&udev->enum_sx, SA_LOCKED); 127902ac6454SAndrew Thompson 128002ac6454SAndrew Thompson /* 128102ac6454SAndrew Thompson * First detach the child to give the child's detach routine a 128202ac6454SAndrew Thompson * chance to detach the sub-devices in the correct order. 128302ac6454SAndrew Thompson * Then delete the child using "device_delete_child()" which 128402ac6454SAndrew Thompson * will detach all sub-devices from the bottom and upwards! 128502ac6454SAndrew Thompson */ 128602ac6454SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 128702ac6454SAndrew Thompson i = iface_index; 128802ac6454SAndrew Thompson iface_index = i + 1; 128902ac6454SAndrew Thompson } else { 129002ac6454SAndrew Thompson i = 0; 129102ac6454SAndrew Thompson iface_index = USB_IFACE_MAX; 129202ac6454SAndrew Thompson } 129302ac6454SAndrew Thompson 129402ac6454SAndrew Thompson /* do the detach */ 129502ac6454SAndrew Thompson 129602ac6454SAndrew Thompson for (; i != iface_index; i++) { 129702ac6454SAndrew Thompson 1298a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 129902ac6454SAndrew Thompson if (iface == NULL) { 130002ac6454SAndrew Thompson /* looks like the end of the USB interfaces */ 130102ac6454SAndrew Thompson break; 130202ac6454SAndrew Thompson } 13038427ed84SHans Petter Selasky usb_detach_device_sub(udev, &iface->subdev, 13048427ed84SHans Petter Selasky &iface->pnpinfo, flag); 130502ac6454SAndrew Thompson } 130602ac6454SAndrew Thompson } 130702ac6454SAndrew Thompson 130802ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1309a593f6b8SAndrew Thompson * usb_probe_and_attach_sub 131002ac6454SAndrew Thompson * 131102ac6454SAndrew Thompson * Returns: 131202ac6454SAndrew Thompson * 0: Success 131302ac6454SAndrew Thompson * Else: Failure 131402ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 131502ac6454SAndrew Thompson static uint8_t 1316a593f6b8SAndrew Thompson usb_probe_and_attach_sub(struct usb_device *udev, 1317760bc48eSAndrew Thompson struct usb_attach_arg *uaa) 131802ac6454SAndrew Thompson { 1319760bc48eSAndrew Thompson struct usb_interface *iface; 132002ac6454SAndrew Thompson device_t dev; 132102ac6454SAndrew Thompson int err; 132202ac6454SAndrew Thompson 132302ac6454SAndrew Thompson iface = uaa->iface; 132402ac6454SAndrew Thompson if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) { 132502ac6454SAndrew Thompson /* leave interface alone */ 132602ac6454SAndrew Thompson return (0); 132702ac6454SAndrew Thompson } 132802ac6454SAndrew Thompson dev = iface->subdev; 132902ac6454SAndrew Thompson if (dev) { 133002ac6454SAndrew Thompson 133102ac6454SAndrew Thompson /* clean up after module unload */ 133202ac6454SAndrew Thompson 133302ac6454SAndrew Thompson if (device_is_attached(dev)) { 133402ac6454SAndrew Thompson /* already a device there */ 133502ac6454SAndrew Thompson return (0); 133602ac6454SAndrew Thompson } 133702ac6454SAndrew Thompson /* clear "iface->subdev" as early as possible */ 133802ac6454SAndrew Thompson 133902ac6454SAndrew Thompson iface->subdev = NULL; 134002ac6454SAndrew Thompson 134102ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, dev)) { 134202ac6454SAndrew Thompson 134302ac6454SAndrew Thompson /* 134402ac6454SAndrew Thompson * Panic here, else one can get a double call 134502ac6454SAndrew Thompson * to device_detach(). USB devices should 134602ac6454SAndrew Thompson * never fail on detach! 134702ac6454SAndrew Thompson */ 1348767cb2e2SAndrew Thompson panic("device_delete_child() failed\n"); 134902ac6454SAndrew Thompson } 135002ac6454SAndrew Thompson } 135102ac6454SAndrew Thompson if (uaa->temp_dev == NULL) { 135202ac6454SAndrew Thompson 135302ac6454SAndrew Thompson /* create a new child */ 135402ac6454SAndrew Thompson uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1); 135502ac6454SAndrew Thompson if (uaa->temp_dev == NULL) { 135602ac6454SAndrew Thompson device_printf(udev->parent_dev, 1357767cb2e2SAndrew Thompson "Device creation failed\n"); 135802ac6454SAndrew Thompson return (1); /* failure */ 135902ac6454SAndrew Thompson } 136002ac6454SAndrew Thompson device_set_ivars(uaa->temp_dev, uaa); 136102ac6454SAndrew Thompson device_quiet(uaa->temp_dev); 136202ac6454SAndrew Thompson } 136302ac6454SAndrew Thompson /* 136402ac6454SAndrew Thompson * Set "subdev" before probe and attach so that "devd" gets 136502ac6454SAndrew Thompson * the information it needs. 136602ac6454SAndrew Thompson */ 136702ac6454SAndrew Thompson iface->subdev = uaa->temp_dev; 136802ac6454SAndrew Thompson 136902ac6454SAndrew Thompson if (device_probe_and_attach(iface->subdev) == 0) { 137002ac6454SAndrew Thompson /* 137102ac6454SAndrew Thompson * The USB attach arguments are only available during probe 137202ac6454SAndrew Thompson * and attach ! 137302ac6454SAndrew Thompson */ 137402ac6454SAndrew Thompson uaa->temp_dev = NULL; 137502ac6454SAndrew Thompson device_set_ivars(iface->subdev, NULL); 137602ac6454SAndrew Thompson 1377ec8f3127SAndrew Thompson if (udev->flags.peer_suspended) { 137802ac6454SAndrew Thompson err = DEVICE_SUSPEND(iface->subdev); 137988b4e0abSAndrew Thompson if (err) 138002ac6454SAndrew Thompson device_printf(iface->subdev, "Suspend failed\n"); 138102ac6454SAndrew Thompson } 138202ac6454SAndrew Thompson return (0); /* success */ 138302ac6454SAndrew Thompson } else { 138402ac6454SAndrew Thompson /* No USB driver found */ 138502ac6454SAndrew Thompson iface->subdev = NULL; 138602ac6454SAndrew Thompson } 138702ac6454SAndrew Thompson return (1); /* failure */ 138802ac6454SAndrew Thompson } 138902ac6454SAndrew Thompson 139002ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1391a593f6b8SAndrew Thompson * usbd_set_parent_iface 139202ac6454SAndrew Thompson * 139302ac6454SAndrew Thompson * Using this function will lock the alternate interface setting on an 139402ac6454SAndrew Thompson * interface. It is typically used for multi interface drivers. In USB 139502ac6454SAndrew Thompson * device side mode it is assumed that the alternate interfaces all 139602ac6454SAndrew Thompson * have the same endpoint descriptors. The default parent index value 139702ac6454SAndrew Thompson * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not 139802ac6454SAndrew Thompson * locked. 139902ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 140002ac6454SAndrew Thompson void 1401a593f6b8SAndrew Thompson usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index, 140202ac6454SAndrew Thompson uint8_t parent_index) 140302ac6454SAndrew Thompson { 1404760bc48eSAndrew Thompson struct usb_interface *iface; 140502ac6454SAndrew Thompson 1406d9073c1eSHans Petter Selasky if (udev == NULL) { 1407d9073c1eSHans Petter Selasky /* nothing to do */ 1408d9073c1eSHans Petter Selasky return; 140902ac6454SAndrew Thompson } 1410d9073c1eSHans Petter Selasky iface = usbd_get_iface(udev, iface_index); 1411d9073c1eSHans Petter Selasky if (iface != NULL) 1412d9073c1eSHans Petter Selasky iface->parent_iface_index = parent_index; 141302ac6454SAndrew Thompson } 141402ac6454SAndrew Thompson 141502ac6454SAndrew Thompson static void 1416a593f6b8SAndrew Thompson usb_init_attach_arg(struct usb_device *udev, 1417760bc48eSAndrew Thompson struct usb_attach_arg *uaa) 141802ac6454SAndrew Thompson { 1419d46dc4adSHans Petter Selasky memset(uaa, 0, sizeof(*uaa)); 142002ac6454SAndrew Thompson 142102ac6454SAndrew Thompson uaa->device = udev; 1422f29a0724SAndrew Thompson uaa->usb_mode = udev->flags.usb_mode; 142302ac6454SAndrew Thompson uaa->port = udev->port_no; 14242a4c6157SAndrew Thompson uaa->dev_state = UAA_DEV_READY; 142502ac6454SAndrew Thompson 142602ac6454SAndrew Thompson uaa->info.idVendor = UGETW(udev->ddesc.idVendor); 142702ac6454SAndrew Thompson uaa->info.idProduct = UGETW(udev->ddesc.idProduct); 142802ac6454SAndrew Thompson uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice); 142902ac6454SAndrew Thompson uaa->info.bDeviceClass = udev->ddesc.bDeviceClass; 143002ac6454SAndrew Thompson uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass; 143102ac6454SAndrew Thompson uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol; 143202ac6454SAndrew Thompson uaa->info.bConfigIndex = udev->curr_config_index; 143302ac6454SAndrew Thompson uaa->info.bConfigNum = udev->curr_config_no; 143402ac6454SAndrew Thompson } 143502ac6454SAndrew Thompson 143602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1437a593f6b8SAndrew Thompson * usb_probe_and_attach 143802ac6454SAndrew Thompson * 143902ac6454SAndrew Thompson * This function is called from "uhub_explore_sub()", 1440a593f6b8SAndrew Thompson * "usb_handle_set_config()" and "usb_handle_request()". 144102ac6454SAndrew Thompson * 144202ac6454SAndrew Thompson * Returns: 144302ac6454SAndrew Thompson * 0: Success 144402ac6454SAndrew Thompson * Else: A control transfer failed 144502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1446e0a69b51SAndrew Thompson usb_error_t 1447a593f6b8SAndrew Thompson usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index) 144802ac6454SAndrew Thompson { 1449760bc48eSAndrew Thompson struct usb_attach_arg uaa; 1450760bc48eSAndrew Thompson struct usb_interface *iface; 145102ac6454SAndrew Thompson uint8_t i; 145202ac6454SAndrew Thompson uint8_t j; 145302ac6454SAndrew Thompson uint8_t do_unlock; 145402ac6454SAndrew Thompson 145502ac6454SAndrew Thompson if (udev == NULL) { 145602ac6454SAndrew Thompson DPRINTF("udev == NULL\n"); 145702ac6454SAndrew Thompson return (USB_ERR_INVAL); 145802ac6454SAndrew Thompson } 14596950c75fSHans Petter Selasky /* Prevent re-enumeration */ 14606950c75fSHans Petter Selasky do_unlock = usbd_enum_lock(udev); 146102ac6454SAndrew Thompson 146202ac6454SAndrew Thompson if (udev->curr_config_index == USB_UNCONFIG_INDEX) { 146302ac6454SAndrew Thompson /* do nothing - no configuration has been set */ 146402ac6454SAndrew Thompson goto done; 146502ac6454SAndrew Thompson } 146602ac6454SAndrew Thompson /* setup USB attach arguments */ 146702ac6454SAndrew Thompson 1468a593f6b8SAndrew Thompson usb_init_attach_arg(udev, &uaa); 146902ac6454SAndrew Thompson 1470a6b60150SHans Petter Selasky /* 1471a6b60150SHans Petter Selasky * If the whole USB device is targeted, invoke the USB event 1472a6b60150SHans Petter Selasky * handler(s): 1473a6b60150SHans Petter Selasky */ 1474a6b60150SHans Petter Selasky if (iface_index == USB_IFACE_INDEX_ANY) { 1475a6b60150SHans Petter Selasky 1476415bcd89SHans Petter Selasky if (usb_test_quirk(&uaa, UQ_MSC_DYMO_EJECT) != 0 && 1477415bcd89SHans Petter Selasky usb_dymo_eject(udev, 0) == 0) { 1478415bcd89SHans Petter Selasky /* success, mark the udev as disappearing */ 1479415bcd89SHans Petter Selasky uaa.dev_state = UAA_DEV_EJECTING; 1480415bcd89SHans Petter Selasky } 1481415bcd89SHans Petter Selasky 1482a6b60150SHans Petter Selasky EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa); 1483a6b60150SHans Petter Selasky 1484a6b60150SHans Petter Selasky if (uaa.dev_state != UAA_DEV_READY) { 1485a6b60150SHans Petter Selasky /* leave device unconfigured */ 1486a6b60150SHans Petter Selasky usb_unconfigure(udev, 0); 1487a6b60150SHans Petter Selasky goto done; 1488a6b60150SHans Petter Selasky } 1489a6b60150SHans Petter Selasky } 1490a6b60150SHans Petter Selasky 149102ac6454SAndrew Thompson /* Check if only one interface should be probed: */ 149202ac6454SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 149302ac6454SAndrew Thompson i = iface_index; 149402ac6454SAndrew Thompson j = i + 1; 149502ac6454SAndrew Thompson } else { 149602ac6454SAndrew Thompson i = 0; 149702ac6454SAndrew Thompson j = USB_IFACE_MAX; 149802ac6454SAndrew Thompson } 149902ac6454SAndrew Thompson 150002ac6454SAndrew Thompson /* Do the probe and attach */ 150102ac6454SAndrew Thompson for (; i != j; i++) { 150202ac6454SAndrew Thompson 1503a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 150402ac6454SAndrew Thompson if (iface == NULL) { 150502ac6454SAndrew Thompson /* 150602ac6454SAndrew Thompson * Looks like the end of the USB 150702ac6454SAndrew Thompson * interfaces ! 150802ac6454SAndrew Thompson */ 150902ac6454SAndrew Thompson DPRINTFN(2, "end of interfaces " 151002ac6454SAndrew Thompson "at %u\n", i); 151102ac6454SAndrew Thompson break; 151202ac6454SAndrew Thompson } 151302ac6454SAndrew Thompson if (iface->idesc == NULL) { 151402ac6454SAndrew Thompson /* no interface descriptor */ 151502ac6454SAndrew Thompson continue; 151602ac6454SAndrew Thompson } 151702ac6454SAndrew Thompson uaa.iface = iface; 151802ac6454SAndrew Thompson 151902ac6454SAndrew Thompson uaa.info.bInterfaceClass = 152002ac6454SAndrew Thompson iface->idesc->bInterfaceClass; 152102ac6454SAndrew Thompson uaa.info.bInterfaceSubClass = 152202ac6454SAndrew Thompson iface->idesc->bInterfaceSubClass; 152302ac6454SAndrew Thompson uaa.info.bInterfaceProtocol = 152402ac6454SAndrew Thompson iface->idesc->bInterfaceProtocol; 152502ac6454SAndrew Thompson uaa.info.bIfaceIndex = i; 152602ac6454SAndrew Thompson uaa.info.bIfaceNum = 152702ac6454SAndrew Thompson iface->idesc->bInterfaceNumber; 1528bd73b187SAlfred Perlstein uaa.driver_info = 0; /* reset driver_info */ 152902ac6454SAndrew Thompson 153002ac6454SAndrew Thompson DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n", 153102ac6454SAndrew Thompson uaa.info.bInterfaceClass, 153202ac6454SAndrew Thompson uaa.info.bInterfaceSubClass, 153302ac6454SAndrew Thompson uaa.info.bInterfaceProtocol, 153402ac6454SAndrew Thompson uaa.info.bIfaceIndex, 153502ac6454SAndrew Thompson uaa.info.bIfaceNum); 153602ac6454SAndrew Thompson 1537d43ffe94SHans Petter Selasky usb_probe_and_attach_sub(udev, &uaa); 153802ac6454SAndrew Thompson 1539d43ffe94SHans Petter Selasky /* 1540d43ffe94SHans Petter Selasky * Remove the leftover child, if any, to enforce that 1541d43ffe94SHans Petter Selasky * a new nomatch devd event is generated for the next 1542d43ffe94SHans Petter Selasky * interface if no driver is found: 1543d43ffe94SHans Petter Selasky */ 1544d43ffe94SHans Petter Selasky if (uaa.temp_dev == NULL) 1545d43ffe94SHans Petter Selasky continue; 1546d43ffe94SHans Petter Selasky if (device_delete_child(udev->parent_dev, uaa.temp_dev)) 1547767cb2e2SAndrew Thompson DPRINTFN(0, "device delete child failed\n"); 1548d43ffe94SHans Petter Selasky uaa.temp_dev = NULL; 154902ac6454SAndrew Thompson } 155002ac6454SAndrew Thompson done: 1551cb18f7d1SAlfred Perlstein if (do_unlock) 1552cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 155302ac6454SAndrew Thompson return (0); 155402ac6454SAndrew Thompson } 155502ac6454SAndrew Thompson 155602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1557a593f6b8SAndrew Thompson * usb_suspend_resume_sub 155802ac6454SAndrew Thompson * 155902ac6454SAndrew Thompson * This function is called when the suspend or resume methods should 156002ac6454SAndrew Thompson * be executed on an USB device. 156102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 156202ac6454SAndrew Thompson static void 1563a593f6b8SAndrew Thompson usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend) 156402ac6454SAndrew Thompson { 156502ac6454SAndrew Thompson int err; 156602ac6454SAndrew Thompson 156702ac6454SAndrew Thompson if (dev == NULL) { 156802ac6454SAndrew Thompson return; 156902ac6454SAndrew Thompson } 157002ac6454SAndrew Thompson if (!device_is_attached(dev)) { 157102ac6454SAndrew Thompson return; 157202ac6454SAndrew Thompson } 157302ac6454SAndrew Thompson if (do_suspend) { 157402ac6454SAndrew Thompson err = DEVICE_SUSPEND(dev); 157502ac6454SAndrew Thompson } else { 157602ac6454SAndrew Thompson err = DEVICE_RESUME(dev); 157702ac6454SAndrew Thompson } 157802ac6454SAndrew Thompson if (err) { 1579767cb2e2SAndrew Thompson device_printf(dev, "%s failed\n", 158002ac6454SAndrew Thompson do_suspend ? "Suspend" : "Resume"); 158102ac6454SAndrew Thompson } 158202ac6454SAndrew Thompson } 158302ac6454SAndrew Thompson 158402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1585a593f6b8SAndrew Thompson * usb_suspend_resume 158602ac6454SAndrew Thompson * 158702ac6454SAndrew Thompson * The following function will suspend or resume the USB device. 158802ac6454SAndrew Thompson * 158902ac6454SAndrew Thompson * Returns: 159002ac6454SAndrew Thompson * 0: Success 159102ac6454SAndrew Thompson * Else: Failure 159202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1593e0a69b51SAndrew Thompson usb_error_t 1594a593f6b8SAndrew Thompson usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend) 159502ac6454SAndrew Thompson { 1596760bc48eSAndrew Thompson struct usb_interface *iface; 159702ac6454SAndrew Thompson uint8_t i; 159802ac6454SAndrew Thompson 159902ac6454SAndrew Thompson if (udev == NULL) { 160002ac6454SAndrew Thompson /* nothing to do */ 160102ac6454SAndrew Thompson return (0); 160202ac6454SAndrew Thompson } 160302ac6454SAndrew Thompson DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend); 160402ac6454SAndrew Thompson 16052df1e9a6SAndrew Thompson sx_assert(&udev->sr_sx, SA_LOCKED); 160602ac6454SAndrew Thompson 160702ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 160802ac6454SAndrew Thompson /* filter the suspend events */ 1609ec8f3127SAndrew Thompson if (udev->flags.peer_suspended == do_suspend) { 161002ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 161102ac6454SAndrew Thompson /* nothing to do */ 161202ac6454SAndrew Thompson return (0); 161302ac6454SAndrew Thompson } 1614ec8f3127SAndrew Thompson udev->flags.peer_suspended = do_suspend; 161502ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 161602ac6454SAndrew Thompson 161702ac6454SAndrew Thompson /* do the suspend or resume */ 161802ac6454SAndrew Thompson 161902ac6454SAndrew Thompson for (i = 0; i != USB_IFACE_MAX; i++) { 162002ac6454SAndrew Thompson 1621a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 162202ac6454SAndrew Thompson if (iface == NULL) { 162302ac6454SAndrew Thompson /* looks like the end of the USB interfaces */ 162402ac6454SAndrew Thompson break; 162502ac6454SAndrew Thompson } 1626a593f6b8SAndrew Thompson usb_suspend_resume_sub(udev, iface->subdev, do_suspend); 162702ac6454SAndrew Thompson } 162802ac6454SAndrew Thompson return (0); 162902ac6454SAndrew Thompson } 163002ac6454SAndrew Thompson 163102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1632a593f6b8SAndrew Thompson * usbd_clear_stall_proc 163302ac6454SAndrew Thompson * 163402ac6454SAndrew Thompson * This function performs generic USB clear stall operations. 163502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 163602ac6454SAndrew Thompson static void 1637a593f6b8SAndrew Thompson usbd_clear_stall_proc(struct usb_proc_msg *_pm) 163802ac6454SAndrew Thompson { 1639a0d53e0bSHans Petter Selasky struct usb_udev_msg *pm = (void *)_pm; 1640760bc48eSAndrew Thompson struct usb_device *udev = pm->udev; 164102ac6454SAndrew Thompson 164202ac6454SAndrew Thompson /* Change lock */ 164302ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 16440eb8d462SHans Petter Selasky USB_MTX_LOCK(&udev->device_mtx); 164502ac6454SAndrew Thompson 164602ac6454SAndrew Thompson /* Start clear stall callback */ 16475b3bb704SAndrew Thompson usbd_transfer_start(udev->ctrl_xfer[1]); 164802ac6454SAndrew Thompson 164902ac6454SAndrew Thompson /* Change lock */ 16500eb8d462SHans Petter Selasky USB_MTX_UNLOCK(&udev->device_mtx); 165102ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 165202ac6454SAndrew Thompson } 165302ac6454SAndrew Thompson 165402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1655a593f6b8SAndrew Thompson * usb_alloc_device 165602ac6454SAndrew Thompson * 165702ac6454SAndrew Thompson * This function allocates a new USB device. This function is called 165802ac6454SAndrew Thompson * when a new device has been put in the powered state, but not yet in 165902ac6454SAndrew Thompson * the addressed state. Get initial descriptor, set the address, get 166002ac6454SAndrew Thompson * full descriptor and get strings. 166102ac6454SAndrew Thompson * 166202ac6454SAndrew Thompson * Return values: 166302ac6454SAndrew Thompson * 0: Failure 166402ac6454SAndrew Thompson * Else: Success 166502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1666760bc48eSAndrew Thompson struct usb_device * 1667a593f6b8SAndrew Thompson usb_alloc_device(device_t parent_dev, struct usb_bus *bus, 1668760bc48eSAndrew Thompson struct usb_device *parent_hub, uint8_t depth, uint8_t port_index, 16698d2dd5ddSAndrew Thompson uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode) 167002ac6454SAndrew Thompson { 1671760bc48eSAndrew Thompson struct usb_attach_arg uaa; 1672760bc48eSAndrew Thompson struct usb_device *udev; 1673760bc48eSAndrew Thompson struct usb_device *adev; 1674760bc48eSAndrew Thompson struct usb_device *hub; 167502ac6454SAndrew Thompson uint8_t *scratch_ptr; 1676e0a69b51SAndrew Thompson usb_error_t err; 167702ac6454SAndrew Thompson uint8_t device_index; 16782a4c6157SAndrew Thompson uint8_t config_index; 16792a4c6157SAndrew Thompson uint8_t config_quirk; 16802a4c6157SAndrew Thompson uint8_t set_config_failed; 16816950c75fSHans Petter Selasky uint8_t do_unlock; 168202ac6454SAndrew Thompson 168302ac6454SAndrew Thompson DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, " 1684f29a0724SAndrew Thompson "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n", 168502ac6454SAndrew Thompson parent_dev, bus, parent_hub, depth, port_index, port_no, 1686f29a0724SAndrew Thompson speed, mode); 168702ac6454SAndrew Thompson 168802ac6454SAndrew Thompson /* 168902ac6454SAndrew Thompson * Find an unused device index. In USB Host mode this is the 169002ac6454SAndrew Thompson * same as the device address. 169102ac6454SAndrew Thompson * 169202ac6454SAndrew Thompson * Device index zero is not used and device index 1 should 169302ac6454SAndrew Thompson * always be the root hub. 169402ac6454SAndrew Thompson */ 169502ac6454SAndrew Thompson for (device_index = USB_ROOT_HUB_ADDR; 169602ac6454SAndrew Thompson (device_index != bus->devices_max) && 169702ac6454SAndrew Thompson (bus->devices[device_index] != NULL); 169802ac6454SAndrew Thompson device_index++) /* nop */; 169902ac6454SAndrew Thompson 170002ac6454SAndrew Thompson if (device_index == bus->devices_max) { 170102ac6454SAndrew Thompson device_printf(bus->bdev, 1702767cb2e2SAndrew Thompson "No free USB device index for new device\n"); 170302ac6454SAndrew Thompson return (NULL); 170402ac6454SAndrew Thompson } 170502ac6454SAndrew Thompson 170602ac6454SAndrew Thompson if (depth > 0x10) { 170702ac6454SAndrew Thompson device_printf(bus->bdev, 1708767cb2e2SAndrew Thompson "Invalid device depth\n"); 170902ac6454SAndrew Thompson return (NULL); 171002ac6454SAndrew Thompson } 171102ac6454SAndrew Thompson udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO); 171202ac6454SAndrew Thompson if (udev == NULL) { 171302ac6454SAndrew Thompson return (NULL); 171402ac6454SAndrew Thompson } 171502ac6454SAndrew Thompson /* initialise our SX-lock */ 171691cd9240SAndrew Thompson sx_init_flags(&udev->enum_sx, "USB config SX lock", SX_DUPOK); 1717a6b60150SHans Petter Selasky sx_init_flags(&udev->sr_sx, "USB suspend and resume SX lock", SX_NOWITNESS); 171864cb5e2aSHans Petter Selasky sx_init_flags(&udev->ctrl_sx, "USB control transfer SX lock", SX_DUPOK); 171902ac6454SAndrew Thompson 172091cd9240SAndrew Thompson cv_init(&udev->ctrlreq_cv, "WCTRL"); 172191cd9240SAndrew Thompson cv_init(&udev->ref_cv, "UGONE"); 172202ac6454SAndrew Thompson 172302ac6454SAndrew Thompson /* initialise our mutex */ 172491cd9240SAndrew Thompson mtx_init(&udev->device_mtx, "USB device mutex", NULL, MTX_DEF); 172502ac6454SAndrew Thompson 172602ac6454SAndrew Thompson /* initialise generic clear stall */ 1727a593f6b8SAndrew Thompson udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc; 172802ac6454SAndrew Thompson udev->cs_msg[0].udev = udev; 1729a593f6b8SAndrew Thompson udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc; 173002ac6454SAndrew Thompson udev->cs_msg[1].udev = udev; 173102ac6454SAndrew Thompson 173202ac6454SAndrew Thompson /* initialise some USB device fields */ 173302ac6454SAndrew Thompson udev->parent_hub = parent_hub; 173402ac6454SAndrew Thompson udev->parent_dev = parent_dev; 173502ac6454SAndrew Thompson udev->port_index = port_index; 173602ac6454SAndrew Thompson udev->port_no = port_no; 173702ac6454SAndrew Thompson udev->depth = depth; 173802ac6454SAndrew Thompson udev->bus = bus; 173902ac6454SAndrew Thompson udev->address = USB_START_ADDR; /* default value */ 1740e0a69b51SAndrew Thompson udev->plugtime = (usb_ticks_t)ticks; 174102ac6454SAndrew Thompson /* 174202ac6454SAndrew Thompson * We need to force the power mode to "on" because there are plenty 174302ac6454SAndrew Thompson * of USB devices out there that do not work very well with 174402ac6454SAndrew Thompson * automatic suspend and resume! 174502ac6454SAndrew Thompson */ 1746d2d71ce7SAndrew Thompson udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON); 174702ac6454SAndrew Thompson udev->pwr_save.last_xfer_time = ticks; 174802ac6454SAndrew Thompson /* we are not ready yet */ 174902ac6454SAndrew Thompson udev->refcount = 1; 175002ac6454SAndrew Thompson 175102ac6454SAndrew Thompson /* set up default endpoint descriptor */ 17525b3bb704SAndrew Thompson udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc); 17535b3bb704SAndrew Thompson udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT; 17545b3bb704SAndrew Thompson udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT; 17555b3bb704SAndrew Thompson udev->ctrl_ep_desc.bmAttributes = UE_CONTROL; 17565b3bb704SAndrew Thompson udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET; 17575b3bb704SAndrew Thompson udev->ctrl_ep_desc.wMaxPacketSize[1] = 0; 17585b3bb704SAndrew Thompson udev->ctrl_ep_desc.bInterval = 0; 1759963169b4SHans Petter Selasky 1760963169b4SHans Petter Selasky /* set up default endpoint companion descriptor */ 1761963169b4SHans Petter Selasky udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc); 1762963169b4SHans Petter Selasky udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP; 1763963169b4SHans Petter Selasky 176402ac6454SAndrew Thompson udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET; 176502ac6454SAndrew Thompson 176602ac6454SAndrew Thompson udev->speed = speed; 1767f29a0724SAndrew Thompson udev->flags.usb_mode = mode; 176802ac6454SAndrew Thompson 176902ac6454SAndrew Thompson /* search for our High Speed USB HUB, if any */ 177002ac6454SAndrew Thompson 177102ac6454SAndrew Thompson adev = udev; 177202ac6454SAndrew Thompson hub = udev->parent_hub; 177302ac6454SAndrew Thompson 177402ac6454SAndrew Thompson while (hub) { 177502ac6454SAndrew Thompson if (hub->speed == USB_SPEED_HIGH) { 177602ac6454SAndrew Thompson udev->hs_hub_addr = hub->address; 1777495f25ceSAndrew Thompson udev->parent_hs_hub = hub; 177802ac6454SAndrew Thompson udev->hs_port_no = adev->port_no; 177902ac6454SAndrew Thompson break; 178002ac6454SAndrew Thompson } 178102ac6454SAndrew Thompson adev = hub; 178202ac6454SAndrew Thompson hub = hub->parent_hub; 178302ac6454SAndrew Thompson } 178402ac6454SAndrew Thompson 1785ae60fdfbSAndrew Thompson /* init the default endpoint */ 1786a593f6b8SAndrew Thompson usb_init_endpoint(udev, 0, 17875b3bb704SAndrew Thompson &udev->ctrl_ep_desc, 1788963169b4SHans Petter Selasky &udev->ctrl_ep_comp_desc, 17895b3bb704SAndrew Thompson &udev->ctrl_ep); 179002ac6454SAndrew Thompson 179102ac6454SAndrew Thompson /* set device index */ 179202ac6454SAndrew Thompson udev->device_index = device_index; 179302ac6454SAndrew Thompson 17948755859aSAndrew Thompson #if USB_HAVE_UGEN 17950f6e8f93SAndrew Thompson /* Create ugen name */ 1796ee3e3ff5SAndrew Thompson snprintf(udev->ugen_name, sizeof(udev->ugen_name), 1797ee3e3ff5SAndrew Thompson USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev), 1798ee3e3ff5SAndrew Thompson device_index); 17998755859aSAndrew Thompson LIST_INIT(&udev->pd_list); 18008755859aSAndrew Thompson 18010f6e8f93SAndrew Thompson /* Create the control endpoint device */ 18022ffd5fdcSHans Petter Selasky udev->ctrl_dev = usb_make_dev(udev, NULL, 0, 0, 18032ffd5fdcSHans Petter Selasky FREAD|FWRITE, UID_ROOT, GID_OPERATOR, 0600); 18040f6e8f93SAndrew Thompson 18050f6e8f93SAndrew Thompson /* Create a link from /dev/ugenX.X to the default endpoint */ 18062ffd5fdcSHans Petter Selasky if (udev->ctrl_dev != NULL) 18072ffd5fdcSHans Petter Selasky make_dev_alias(udev->ctrl_dev->cdev, "%s", udev->ugen_name); 18080f6e8f93SAndrew Thompson #endif 1809963169b4SHans Petter Selasky /* Initialise device */ 1810963169b4SHans Petter Selasky if (bus->methods->device_init != NULL) { 1811963169b4SHans Petter Selasky err = (bus->methods->device_init) (udev); 1812963169b4SHans Petter Selasky if (err != 0) { 1813963169b4SHans Petter Selasky DPRINTFN(0, "device init %d failed " 1814963169b4SHans Petter Selasky "(%s, ignored)\n", device_index, 1815963169b4SHans Petter Selasky usbd_errstr(err)); 1816963169b4SHans Petter Selasky goto done; 1817963169b4SHans Petter Selasky } 1818963169b4SHans Petter Selasky } 1819963169b4SHans Petter Selasky /* set powered device state after device init is complete */ 1820963169b4SHans Petter Selasky usb_set_device_state(udev, USB_STATE_POWERED); 1821963169b4SHans Petter Selasky 1822f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_HOST) { 182302ac6454SAndrew Thompson 1824a593f6b8SAndrew Thompson err = usbd_req_set_address(udev, NULL, device_index); 182502ac6454SAndrew Thompson 1826963169b4SHans Petter Selasky /* 1827963169b4SHans Petter Selasky * This is the new USB device address from now on, if 1828963169b4SHans Petter Selasky * the set address request didn't set it already. 1829963169b4SHans Petter Selasky */ 1830963169b4SHans Petter Selasky if (udev->address == USB_START_ADDR) 183102ac6454SAndrew Thompson udev->address = device_index; 183202ac6454SAndrew Thompson 183302ac6454SAndrew Thompson /* 183402ac6454SAndrew Thompson * We ignore any set-address errors, hence there are 183502ac6454SAndrew Thompson * buggy USB devices out there that actually receive 183602ac6454SAndrew Thompson * the SETUP PID, but manage to set the address before 183702ac6454SAndrew Thompson * the STATUS stage is ACK'ed. If the device responds 183802ac6454SAndrew Thompson * to the subsequent get-descriptor at the new 183902ac6454SAndrew Thompson * address, then we know that the set-address command 184002ac6454SAndrew Thompson * was successful. 184102ac6454SAndrew Thompson */ 184202ac6454SAndrew Thompson if (err) { 184302ac6454SAndrew Thompson DPRINTFN(0, "set address %d failed " 184403797f33SAndrew Thompson "(%s, ignored)\n", udev->address, 1845a593f6b8SAndrew Thompson usbd_errstr(err)); 184602ac6454SAndrew Thompson } 184702ac6454SAndrew Thompson } else { 184802ac6454SAndrew Thompson /* We are not self powered */ 184902ac6454SAndrew Thompson udev->flags.self_powered = 0; 185002ac6454SAndrew Thompson 185102ac6454SAndrew Thompson /* Set unconfigured state */ 185202ac6454SAndrew Thompson udev->curr_config_no = USB_UNCONFIG_NO; 185302ac6454SAndrew Thompson udev->curr_config_index = USB_UNCONFIG_INDEX; 185402ac6454SAndrew Thompson 185502ac6454SAndrew Thompson /* Setup USB descriptors */ 1856a593f6b8SAndrew Thompson err = (usb_temp_setup_by_index_p) (udev, usb_template); 185702ac6454SAndrew Thompson if (err) { 18586be75992SEdward Tomasz Napierala DPRINTFN(0, "setting up USB template failed - " 18596be75992SEdward Tomasz Napierala "usb_template(4) not loaded?\n"); 186002ac6454SAndrew Thompson goto done; 186102ac6454SAndrew Thompson } 186202ac6454SAndrew Thompson } 1863a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_ADDRESSED); 186402ac6454SAndrew Thompson 1865963169b4SHans Petter Selasky /* setup the device descriptor and the initial "wMaxPacketSize" */ 1866963169b4SHans Petter Selasky err = usbd_setup_device_desc(udev, NULL); 1867963169b4SHans Petter Selasky 1868963169b4SHans Petter Selasky if (err != 0) { 186923de050bSHans Petter Selasky /* try to enumerate two more times */ 1870a593f6b8SAndrew Thompson err = usbd_req_re_enumerate(udev, NULL); 187123de050bSHans Petter Selasky if (err != 0) { 187223de050bSHans Petter Selasky err = usbd_req_re_enumerate(udev, NULL); 187323de050bSHans Petter Selasky if (err != 0) { 187402ac6454SAndrew Thompson goto done; 187502ac6454SAndrew Thompson } 187623de050bSHans Petter Selasky } 187723de050bSHans Petter Selasky } 187802ac6454SAndrew Thompson 187902ac6454SAndrew Thompson /* 188002ac6454SAndrew Thompson * Setup temporary USB attach args so that we can figure out some 188102ac6454SAndrew Thompson * basic quirks for this device. 188202ac6454SAndrew Thompson */ 1883a593f6b8SAndrew Thompson usb_init_attach_arg(udev, &uaa); 188402ac6454SAndrew Thompson 1885a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) { 188602ac6454SAndrew Thompson udev->flags.uq_bus_powered = 1; 188702ac6454SAndrew Thompson } 1888a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) { 188902ac6454SAndrew Thompson udev->flags.no_strings = 1; 189002ac6454SAndrew Thompson } 189102ac6454SAndrew Thompson /* 189202ac6454SAndrew Thompson * Workaround for buggy USB devices. 189302ac6454SAndrew Thompson * 189402ac6454SAndrew Thompson * It appears that some string-less USB chips will crash and 189502ac6454SAndrew Thompson * disappear if any attempts are made to read any string 189602ac6454SAndrew Thompson * descriptors. 189702ac6454SAndrew Thompson * 189802ac6454SAndrew Thompson * Try to detect such chips by checking the strings in the USB 189902ac6454SAndrew Thompson * device descriptor. If no strings are present there we 190002ac6454SAndrew Thompson * simply disable all USB strings. 190102ac6454SAndrew Thompson */ 19026950c75fSHans Petter Selasky 19036950c75fSHans Petter Selasky /* Protect scratch area */ 190464cb5e2aSHans Petter Selasky do_unlock = usbd_ctrl_lock(udev); 19056950c75fSHans Petter Selasky 19066950c75fSHans Petter Selasky scratch_ptr = udev->scratch.data; 190702ac6454SAndrew Thompson 1908869df733SHans Petter Selasky if (udev->flags.no_strings) { 1909869df733SHans Petter Selasky err = USB_ERR_INVAL; 1910869df733SHans Petter Selasky } else if (udev->ddesc.iManufacturer || 191102ac6454SAndrew Thompson udev->ddesc.iProduct || 191202ac6454SAndrew Thompson udev->ddesc.iSerialNumber) { 191302ac6454SAndrew Thompson /* read out the language ID string */ 1914a593f6b8SAndrew Thompson err = usbd_req_get_string_desc(udev, NULL, 1915c10e1453SAndrew Thompson (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE); 191602ac6454SAndrew Thompson } else { 191702ac6454SAndrew Thompson err = USB_ERR_INVAL; 191802ac6454SAndrew Thompson } 191902ac6454SAndrew Thompson 192002ac6454SAndrew Thompson if (err || (scratch_ptr[0] < 4)) { 192102ac6454SAndrew Thompson udev->flags.no_strings = 1; 192202ac6454SAndrew Thompson } else { 19237a918edfSAndrew Thompson uint16_t langid; 19247a918edfSAndrew Thompson uint16_t pref; 19257a918edfSAndrew Thompson uint16_t mask; 19267a918edfSAndrew Thompson uint8_t x; 19277a918edfSAndrew Thompson 19287a918edfSAndrew Thompson /* load preferred value and mask */ 19297a918edfSAndrew Thompson pref = usb_lang_id; 19307a918edfSAndrew Thompson mask = usb_lang_mask; 19317a918edfSAndrew Thompson 19327a918edfSAndrew Thompson /* align length correctly */ 19336950c75fSHans Petter Selasky scratch_ptr[0] &= ~1U; 19347a918edfSAndrew Thompson 19357a918edfSAndrew Thompson /* fix compiler warning */ 19367a918edfSAndrew Thompson langid = 0; 19377a918edfSAndrew Thompson 19387a918edfSAndrew Thompson /* search for preferred language */ 19397a918edfSAndrew Thompson for (x = 2; (x < scratch_ptr[0]); x += 2) { 19407a918edfSAndrew Thompson langid = UGETW(scratch_ptr + x); 19417a918edfSAndrew Thompson if ((langid & mask) == pref) 19427a918edfSAndrew Thompson break; 19437a918edfSAndrew Thompson } 19447a918edfSAndrew Thompson if (x >= scratch_ptr[0]) { 194502ac6454SAndrew Thompson /* pick the first language as the default */ 19467a918edfSAndrew Thompson DPRINTFN(1, "Using first language\n"); 19477a918edfSAndrew Thompson langid = UGETW(scratch_ptr + 2); 19487a918edfSAndrew Thompson } 19497a918edfSAndrew Thompson 19507a918edfSAndrew Thompson DPRINTFN(1, "Language selected: 0x%04x\n", langid); 19517a918edfSAndrew Thompson udev->langid = langid; 195202ac6454SAndrew Thompson } 195302ac6454SAndrew Thompson 19546950c75fSHans Petter Selasky if (do_unlock) 195564cb5e2aSHans Petter Selasky usbd_ctrl_unlock(udev); 19566950c75fSHans Petter Selasky 195702ac6454SAndrew Thompson /* assume 100mA bus powered for now. Changed when configured. */ 195802ac6454SAndrew Thompson udev->power = USB_MIN_POWER; 1959c86aead6SAndrew Thompson /* fetch the vendor and product strings from the device */ 1960a593f6b8SAndrew Thompson usbd_set_device_strings(udev); 196102ac6454SAndrew Thompson 19622a4c6157SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 19632a4c6157SAndrew Thompson /* USB device mode setup is complete */ 19642a4c6157SAndrew Thompson err = 0; 19652a4c6157SAndrew Thompson goto config_done; 19662a4c6157SAndrew Thompson } 196702ac6454SAndrew Thompson 196802ac6454SAndrew Thompson /* 196902ac6454SAndrew Thompson * Most USB devices should attach to config index 0 by 197002ac6454SAndrew Thompson * default 197102ac6454SAndrew Thompson */ 1972a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) { 197302ac6454SAndrew Thompson config_index = 0; 197402ac6454SAndrew Thompson config_quirk = 1; 1975a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) { 197602ac6454SAndrew Thompson config_index = 1; 197702ac6454SAndrew Thompson config_quirk = 1; 1978a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) { 197902ac6454SAndrew Thompson config_index = 2; 198002ac6454SAndrew Thompson config_quirk = 1; 1981a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) { 198202ac6454SAndrew Thompson config_index = 3; 198302ac6454SAndrew Thompson config_quirk = 1; 1984a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) { 198502ac6454SAndrew Thompson config_index = 4; 198602ac6454SAndrew Thompson config_quirk = 1; 198702ac6454SAndrew Thompson } else { 198802ac6454SAndrew Thompson config_index = 0; 198902ac6454SAndrew Thompson config_quirk = 0; 199002ac6454SAndrew Thompson } 199102ac6454SAndrew Thompson 19922a4c6157SAndrew Thompson set_config_failed = 0; 199302ac6454SAndrew Thompson repeat_set_config: 199402ac6454SAndrew Thompson 199502ac6454SAndrew Thompson DPRINTF("setting config %u\n", config_index); 199602ac6454SAndrew Thompson 199702ac6454SAndrew Thompson /* get the USB device configured */ 1998a593f6b8SAndrew Thompson err = usbd_set_config_index(udev, config_index); 199902ac6454SAndrew Thompson if (err) { 200002ac6454SAndrew Thompson if (udev->ddesc.bNumConfigurations != 0) { 200102ac6454SAndrew Thompson if (!set_config_failed) { 200202ac6454SAndrew Thompson set_config_failed = 1; 200302ac6454SAndrew Thompson /* XXX try to re-enumerate the device */ 20042a4c6157SAndrew Thompson err = usbd_req_re_enumerate(udev, NULL); 200502ac6454SAndrew Thompson if (err == 0) 200602ac6454SAndrew Thompson goto repeat_set_config; 200702ac6454SAndrew Thompson } 20082a4c6157SAndrew Thompson DPRINTFN(0, "Failure selecting configuration index %u:" 20092a4c6157SAndrew Thompson "%s, port %u, addr %u (ignored)\n", 2010a593f6b8SAndrew Thompson config_index, usbd_errstr(err), udev->port_no, 201102ac6454SAndrew Thompson udev->address); 201202ac6454SAndrew Thompson } 201302ac6454SAndrew Thompson /* 20142a4c6157SAndrew Thompson * Some USB devices do not have any configurations. Ignore any 20152a4c6157SAndrew Thompson * set config failures! 201602ac6454SAndrew Thompson */ 201702ac6454SAndrew Thompson err = 0; 20182a4c6157SAndrew Thompson goto config_done; 20192a4c6157SAndrew Thompson } 20202a4c6157SAndrew Thompson if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) { 202102ac6454SAndrew Thompson if ((udev->cdesc->bNumInterface < 2) && 20222a4c6157SAndrew Thompson usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) { 20232a4c6157SAndrew Thompson DPRINTFN(0, "Found no endpoints, trying next config\n"); 202402ac6454SAndrew Thompson config_index++; 202502ac6454SAndrew Thompson goto repeat_set_config; 202602ac6454SAndrew Thompson } 202715d4edd3SHans Petter Selasky #if USB_HAVE_MSCTEST 202802ac6454SAndrew Thompson if (config_index == 0) { 202902ac6454SAndrew Thompson /* 203002ac6454SAndrew Thompson * Try to figure out if we have an 203102ac6454SAndrew Thompson * auto-install disk there: 203202ac6454SAndrew Thompson */ 2033d84a79e7SAndrew Thompson if (usb_iface_is_cdrom(udev, 0)) { 203402ac6454SAndrew Thompson DPRINTFN(0, "Found possible auto-install " 203502ac6454SAndrew Thompson "disk (trying next config)\n"); 203602ac6454SAndrew Thompson config_index++; 203702ac6454SAndrew Thompson goto repeat_set_config; 203802ac6454SAndrew Thompson } 203902ac6454SAndrew Thompson } 204015d4edd3SHans Petter Selasky #endif 20412a4c6157SAndrew Thompson } 204215d4edd3SHans Petter Selasky #if USB_HAVE_MSCTEST 2043d46dc4adSHans Petter Selasky if (set_config_failed == 0 && config_index == 0 && 20449157ad4bSHans Petter Selasky usb_test_quirk(&uaa, UQ_MSC_NO_SYNC_CACHE) == 0 && 20459157ad4bSHans Petter Selasky usb_test_quirk(&uaa, UQ_MSC_NO_GETMAXLUN) == 0) { 2046d46dc4adSHans Petter Selasky 2047d46dc4adSHans Petter Selasky /* 2048d46dc4adSHans Petter Selasky * Try to figure out if there are any MSC quirks we 2049d46dc4adSHans Petter Selasky * should apply automatically: 2050d46dc4adSHans Petter Selasky */ 2051d46dc4adSHans Petter Selasky err = usb_msc_auto_quirk(udev, 0); 2052d46dc4adSHans Petter Selasky 2053d46dc4adSHans Petter Selasky if (err != 0) { 2054d46dc4adSHans Petter Selasky set_config_failed = 1; 2055d46dc4adSHans Petter Selasky goto repeat_set_config; 2056d46dc4adSHans Petter Selasky } 2057d46dc4adSHans Petter Selasky } 205815d4edd3SHans Petter Selasky #endif 205902ac6454SAndrew Thompson 20602a4c6157SAndrew Thompson config_done: 206102ac6454SAndrew Thompson DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n", 206202ac6454SAndrew Thompson udev->address, udev, udev->parent_hub); 206302ac6454SAndrew Thompson 206402ac6454SAndrew Thompson /* register our device - we are ready */ 2065a593f6b8SAndrew Thompson usb_bus_port_set_device(bus, parent_hub ? 206602ac6454SAndrew Thompson parent_hub->hub->ports + port_index : NULL, udev, device_index); 206702ac6454SAndrew Thompson 20680f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 20698755859aSAndrew Thompson /* Symlink the ugen device name */ 2070a593f6b8SAndrew Thompson udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name); 20718755859aSAndrew Thompson 20728755859aSAndrew Thompson /* Announce device */ 207388f9a4ffSEdward Tomasz Napierala printf("%s: <%s %s> at %s\n", udev->ugen_name, 207488f9a4ffSEdward Tomasz Napierala usb_get_manufacturer(udev), usb_get_product(udev), 207502ac6454SAndrew Thompson device_get_nameunit(udev->bus->bdev)); 20768bb77249SHans Petter Selasky #endif 20777efaaa9aSAndrew Thompson 20788bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 20793acd904dSAndrew Thompson usb_notify_addq("ATTACH", udev); 20808755859aSAndrew Thompson #endif 208102ac6454SAndrew Thompson done: 208202ac6454SAndrew Thompson if (err) { 2083d88688c7SAndrew Thompson /* 2084d88688c7SAndrew Thompson * Free USB device and all subdevices, if any. 2085d88688c7SAndrew Thompson */ 2086d88688c7SAndrew Thompson usb_free_device(udev, 0); 208702ac6454SAndrew Thompson udev = NULL; 208802ac6454SAndrew Thompson } 208902ac6454SAndrew Thompson return (udev); 209002ac6454SAndrew Thompson } 209102ac6454SAndrew Thompson 20920f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 20932ffd5fdcSHans Petter Selasky struct usb_fs_privdata * 20942ffd5fdcSHans Petter Selasky usb_make_dev(struct usb_device *udev, const char *devname, int ep, 20952ffd5fdcSHans Petter Selasky int fi, int rwmode, uid_t uid, gid_t gid, int mode) 2096ee3e3ff5SAndrew Thompson { 2097760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 2098ac3490fdSHans Petter Selasky struct make_dev_args args; 20992ffd5fdcSHans Petter Selasky char buffer[32]; 2100ee3e3ff5SAndrew Thompson 2101ee3e3ff5SAndrew Thompson /* Store information to locate ourselves again later */ 2102760bc48eSAndrew Thompson pd = malloc(sizeof(struct usb_fs_privdata), M_USBDEV, 2103ee3e3ff5SAndrew Thompson M_WAITOK | M_ZERO); 2104ee3e3ff5SAndrew Thompson pd->bus_index = device_get_unit(udev->bus->bdev); 2105ee3e3ff5SAndrew Thompson pd->dev_index = udev->device_index; 2106ee3e3ff5SAndrew Thompson pd->ep_addr = ep; 21072ffd5fdcSHans Petter Selasky pd->fifo_index = fi; 21082ffd5fdcSHans Petter Selasky pd->mode = rwmode; 2109ee3e3ff5SAndrew Thompson 2110ee3e3ff5SAndrew Thompson /* Now, create the device itself */ 21112ffd5fdcSHans Petter Selasky if (devname == NULL) { 21122ffd5fdcSHans Petter Selasky devname = buffer; 21132ffd5fdcSHans Petter Selasky snprintf(buffer, sizeof(buffer), USB_DEVICE_DIR "/%u.%u.%u", 2114f35aaff0SAndrew Thompson pd->bus_index, pd->dev_index, pd->ep_addr); 21152ffd5fdcSHans Petter Selasky } 21162ffd5fdcSHans Petter Selasky 2117ac3490fdSHans Petter Selasky /* Setup arguments for make_dev_s() */ 2118ac3490fdSHans Petter Selasky make_dev_args_init(&args); 2119ac3490fdSHans Petter Selasky args.mda_devsw = &usb_devsw; 2120ac3490fdSHans Petter Selasky args.mda_uid = uid; 2121ac3490fdSHans Petter Selasky args.mda_gid = gid; 2122ac3490fdSHans Petter Selasky args.mda_mode = mode; 2123ac3490fdSHans Petter Selasky args.mda_si_drv1 = pd; 21242ffd5fdcSHans Petter Selasky 2125ac3490fdSHans Petter Selasky if (make_dev_s(&args, &pd->cdev, "%s", devname) != 0) { 21262ffd5fdcSHans Petter Selasky DPRINTFN(0, "Failed to create device %s\n", devname); 21272ffd5fdcSHans Petter Selasky free(pd, M_USBDEV); 21282ffd5fdcSHans Petter Selasky return (NULL); 21292ffd5fdcSHans Petter Selasky } 21302ffd5fdcSHans Petter Selasky return (pd); 21312ffd5fdcSHans Petter Selasky } 21322ffd5fdcSHans Petter Selasky 21332ffd5fdcSHans Petter Selasky void 2134b78e84d1SHans Petter Selasky usb_destroy_dev_sync(struct usb_fs_privdata *pd) 21352ffd5fdcSHans Petter Selasky { 2136b78e84d1SHans Petter Selasky DPRINTFN(1, "Destroying device at ugen%d.%d\n", 2137b78e84d1SHans Petter Selasky pd->bus_index, pd->dev_index); 21382ffd5fdcSHans Petter Selasky 2139b78e84d1SHans Petter Selasky /* 2140b78e84d1SHans Petter Selasky * Destroy character device synchronously. After this 2141b78e84d1SHans Petter Selasky * all system calls are returned. Can block. 2142b78e84d1SHans Petter Selasky */ 21432ffd5fdcSHans Petter Selasky destroy_dev(pd->cdev); 21442ffd5fdcSHans Petter Selasky 21452ffd5fdcSHans Petter Selasky free(pd, M_USBDEV); 2146ee3e3ff5SAndrew Thompson } 2147ee3e3ff5SAndrew Thompson 2148b78e84d1SHans Petter Selasky void 2149b78e84d1SHans Petter Selasky usb_destroy_dev(struct usb_fs_privdata *pd) 2150b78e84d1SHans Petter Selasky { 2151b78e84d1SHans Petter Selasky struct usb_bus *bus; 2152b78e84d1SHans Petter Selasky 2153b78e84d1SHans Petter Selasky if (pd == NULL) 2154b78e84d1SHans Petter Selasky return; 2155b78e84d1SHans Petter Selasky 2156b78e84d1SHans Petter Selasky mtx_lock(&usb_ref_lock); 2157b78e84d1SHans Petter Selasky bus = devclass_get_softc(usb_devclass_ptr, pd->bus_index); 2158b78e84d1SHans Petter Selasky mtx_unlock(&usb_ref_lock); 2159b78e84d1SHans Petter Selasky 2160b78e84d1SHans Petter Selasky if (bus == NULL) { 2161b78e84d1SHans Petter Selasky usb_destroy_dev_sync(pd); 2162b78e84d1SHans Petter Selasky return; 2163b78e84d1SHans Petter Selasky } 2164b78e84d1SHans Petter Selasky 216507dbde67SHans Petter Selasky /* make sure we can re-use the device name */ 216607dbde67SHans Petter Selasky delist_dev(pd->cdev); 216707dbde67SHans Petter Selasky 2168b78e84d1SHans Petter Selasky USB_BUS_LOCK(bus); 2169b78e84d1SHans Petter Selasky LIST_INSERT_HEAD(&bus->pd_cleanup_list, pd, pd_next); 2170b78e84d1SHans Petter Selasky /* get cleanup going */ 2171b78e84d1SHans Petter Selasky usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus), 2172b78e84d1SHans Petter Selasky &bus->cleanup_msg[0], &bus->cleanup_msg[1]); 2173b78e84d1SHans Petter Selasky USB_BUS_UNLOCK(bus); 2174b78e84d1SHans Petter Selasky } 2175b78e84d1SHans Petter Selasky 2176ee3e3ff5SAndrew Thompson static void 2177a593f6b8SAndrew Thompson usb_cdev_create(struct usb_device *udev) 2178ee3e3ff5SAndrew Thompson { 2179760bc48eSAndrew Thompson struct usb_config_descriptor *cd; 2180760bc48eSAndrew Thompson struct usb_endpoint_descriptor *ed; 2181760bc48eSAndrew Thompson struct usb_descriptor *desc; 2182760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 2183f5f145baSAndrew Thompson int inmode, outmode, inmask, outmask, mode; 2184f5f145baSAndrew Thompson uint8_t ep; 2185ee3e3ff5SAndrew Thompson 2186ee3e3ff5SAndrew Thompson KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries")); 2187ee3e3ff5SAndrew Thompson 2188ee3e3ff5SAndrew Thompson DPRINTFN(2, "Creating device nodes\n"); 2189ee3e3ff5SAndrew Thompson 2190a593f6b8SAndrew Thompson if (usbd_get_mode(udev) == USB_MODE_DEVICE) { 2191ee3e3ff5SAndrew Thompson inmode = FWRITE; 2192ee3e3ff5SAndrew Thompson outmode = FREAD; 2193ee3e3ff5SAndrew Thompson } else { /* USB_MODE_HOST */ 2194ee3e3ff5SAndrew Thompson inmode = FREAD; 2195ee3e3ff5SAndrew Thompson outmode = FWRITE; 2196ee3e3ff5SAndrew Thompson } 2197ee3e3ff5SAndrew Thompson 2198f5f145baSAndrew Thompson inmask = 0; 2199f5f145baSAndrew Thompson outmask = 0; 2200f5f145baSAndrew Thompson desc = NULL; 2201f5f145baSAndrew Thompson 2202f5f145baSAndrew Thompson /* 2203f5f145baSAndrew Thompson * Collect all used endpoint numbers instead of just 2204f5f145baSAndrew Thompson * generating 16 static endpoints. 2205f5f145baSAndrew Thompson */ 2206a593f6b8SAndrew Thompson cd = usbd_get_config_descriptor(udev); 2207a593f6b8SAndrew Thompson while ((desc = usb_desc_foreach(cd, desc))) { 2208f5f145baSAndrew Thompson /* filter out all endpoint descriptors */ 2209f5f145baSAndrew Thompson if ((desc->bDescriptorType == UDESC_ENDPOINT) && 2210f5f145baSAndrew Thompson (desc->bLength >= sizeof(*ed))) { 2211760bc48eSAndrew Thompson ed = (struct usb_endpoint_descriptor *)desc; 2212f5f145baSAndrew Thompson 2213f5f145baSAndrew Thompson /* update masks */ 2214f5f145baSAndrew Thompson ep = ed->bEndpointAddress; 2215f5f145baSAndrew Thompson if (UE_GET_DIR(ep) == UE_DIR_OUT) 2216f5f145baSAndrew Thompson outmask |= 1 << UE_GET_ADDR(ep); 2217f5f145baSAndrew Thompson else 2218f5f145baSAndrew Thompson inmask |= 1 << UE_GET_ADDR(ep); 2219f5f145baSAndrew Thompson } 2220f5f145baSAndrew Thompson } 2221ee3e3ff5SAndrew Thompson 2222ee3e3ff5SAndrew Thompson /* Create all available endpoints except EP0 */ 2223ee3e3ff5SAndrew Thompson for (ep = 1; ep < 16; ep++) { 22242ffd5fdcSHans Petter Selasky mode = (inmask & (1 << ep)) ? inmode : 0; 22252ffd5fdcSHans Petter Selasky mode |= (outmask & (1 << ep)) ? outmode : 0; 2226ee3e3ff5SAndrew Thompson if (mode == 0) 2227ee3e3ff5SAndrew Thompson continue; /* no IN or OUT endpoint */ 2228ee3e3ff5SAndrew Thompson 22292ffd5fdcSHans Petter Selasky pd = usb_make_dev(udev, NULL, ep, 0, 22302ffd5fdcSHans Petter Selasky mode, UID_ROOT, GID_OPERATOR, 0600); 22312ffd5fdcSHans Petter Selasky 22322ffd5fdcSHans Petter Selasky if (pd != NULL) 2233ee3e3ff5SAndrew Thompson LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next); 2234ee3e3ff5SAndrew Thompson } 2235ee3e3ff5SAndrew Thompson } 2236ee3e3ff5SAndrew Thompson 2237ee3e3ff5SAndrew Thompson static void 2238a593f6b8SAndrew Thompson usb_cdev_free(struct usb_device *udev) 2239ee3e3ff5SAndrew Thompson { 2240760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 2241ee3e3ff5SAndrew Thompson 2242ee3e3ff5SAndrew Thompson DPRINTFN(2, "Freeing device nodes\n"); 2243ee3e3ff5SAndrew Thompson 2244ee3e3ff5SAndrew Thompson while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) { 2245ee3e3ff5SAndrew Thompson KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt")); 2246ee3e3ff5SAndrew Thompson 2247ee3e3ff5SAndrew Thompson LIST_REMOVE(pd, pd_next); 2248ee3e3ff5SAndrew Thompson 22492ffd5fdcSHans Petter Selasky usb_destroy_dev(pd); 22502ffd5fdcSHans Petter Selasky } 2251ee3e3ff5SAndrew Thompson } 22520f6e8f93SAndrew Thompson #endif 2253ee3e3ff5SAndrew Thompson 225402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2255a593f6b8SAndrew Thompson * usb_free_device 225602ac6454SAndrew Thompson * 2257d88688c7SAndrew Thompson * This function is NULL safe and will free an USB device and its 2258d88688c7SAndrew Thompson * children devices, if any. 2259bdd41206SAndrew Thompson * 2260d88688c7SAndrew Thompson * Flag values: Reserved, set to zero. 226102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 226202ac6454SAndrew Thompson void 2263a593f6b8SAndrew Thompson usb_free_device(struct usb_device *udev, uint8_t flag) 226402ac6454SAndrew Thompson { 2265760bc48eSAndrew Thompson struct usb_bus *bus; 2266bdd41206SAndrew Thompson 2267bdd41206SAndrew Thompson if (udev == NULL) 2268bdd41206SAndrew Thompson return; /* already freed */ 226902ac6454SAndrew Thompson 227002ac6454SAndrew Thompson DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no); 227102ac6454SAndrew Thompson 2272bd216778SAndrew Thompson bus = udev->bus; 2273f97da128SHans Petter Selasky 2274f97da128SHans Petter Selasky /* set DETACHED state to prevent any further references */ 2275a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_DETACHED); 2276bdd41206SAndrew Thompson 22778bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 22783acd904dSAndrew Thompson usb_notify_addq("DETACH", udev); 22798bb77249SHans Petter Selasky #endif 228002ac6454SAndrew Thompson 22818bb77249SHans Petter Selasky #if USB_HAVE_UGEN 2282cabe79d9SMarius Strobl if (!rebooting) { 228388f9a4ffSEdward Tomasz Napierala printf("%s: <%s %s> at %s (disconnected)\n", udev->ugen_name, 228488f9a4ffSEdward Tomasz Napierala usb_get_manufacturer(udev), usb_get_product(udev), 228588f9a4ffSEdward Tomasz Napierala device_get_nameunit(bus->bdev)); 2286cabe79d9SMarius Strobl } 228702ac6454SAndrew Thompson 2288ee3e3ff5SAndrew Thompson /* Destroy UGEN symlink, if any */ 228902ac6454SAndrew Thompson if (udev->ugen_symlink) { 2290a593f6b8SAndrew Thompson usb_free_symlink(udev->ugen_symlink); 229102ac6454SAndrew Thompson udev->ugen_symlink = NULL; 229202ac6454SAndrew Thompson } 229302ac6454SAndrew Thompson 22942ffd5fdcSHans Petter Selasky usb_destroy_dev(udev->ctrl_dev); 22950f6e8f93SAndrew Thompson #endif 229602ac6454SAndrew Thompson 2297f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 229802ac6454SAndrew Thompson /* stop receiving any control transfers (Device Side Mode) */ 22995b3bb704SAndrew Thompson usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX); 230002ac6454SAndrew Thompson } 230102ac6454SAndrew Thompson 2302bdd41206SAndrew Thompson /* the following will get the device unconfigured in software */ 2303d88688c7SAndrew Thompson usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0); 230402ac6454SAndrew Thompson 2305f97da128SHans Petter Selasky /* final device unregister after all character devices are closed */ 2306f97da128SHans Petter Selasky usb_bus_port_set_device(bus, udev->parent_hub ? 2307f97da128SHans Petter Selasky udev->parent_hub->hub->ports + udev->port_index : NULL, 2308f97da128SHans Petter Selasky NULL, USB_ROOT_HUB_ADDR); 2309f97da128SHans Petter Selasky 231002ac6454SAndrew Thompson /* unsetup any leftover default USB transfers */ 23115b3bb704SAndrew Thompson usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX); 231202ac6454SAndrew Thompson 231302ac6454SAndrew Thompson /* template unsetup, if any */ 2314a593f6b8SAndrew Thompson (usb_temp_unsetup_p) (udev); 231502ac6454SAndrew Thompson 231602ac6454SAndrew Thompson /* 231702ac6454SAndrew Thompson * Make sure that our clear-stall messages are not queued 231802ac6454SAndrew Thompson * anywhere: 231902ac6454SAndrew Thompson */ 232002ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 232143ea03d7SHans Petter Selasky usb_proc_mwait(USB_BUS_CS_PROC(udev->bus), 232202ac6454SAndrew Thompson &udev->cs_msg[0], &udev->cs_msg[1]); 232302ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 232402ac6454SAndrew Thompson 2325b78e84d1SHans Petter Selasky /* wait for all references to go away */ 2326b78e84d1SHans Petter Selasky usb_wait_pending_refs(udev); 2327b78e84d1SHans Petter Selasky 232891cd9240SAndrew Thompson sx_destroy(&udev->enum_sx); 23292df1e9a6SAndrew Thompson sx_destroy(&udev->sr_sx); 233064cb5e2aSHans Petter Selasky sx_destroy(&udev->ctrl_sx); 233102ac6454SAndrew Thompson 233291cd9240SAndrew Thompson cv_destroy(&udev->ctrlreq_cv); 233391cd9240SAndrew Thompson cv_destroy(&udev->ref_cv); 233402ac6454SAndrew Thompson 233591cd9240SAndrew Thompson mtx_destroy(&udev->device_mtx); 23368755859aSAndrew Thompson #if USB_HAVE_UGEN 2337ee3e3ff5SAndrew Thompson KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries")); 23388755859aSAndrew Thompson #endif 233902ac6454SAndrew Thompson 2340963169b4SHans Petter Selasky /* Uninitialise device */ 2341963169b4SHans Petter Selasky if (bus->methods->device_uninit != NULL) 2342963169b4SHans Petter Selasky (bus->methods->device_uninit) (udev); 2343963169b4SHans Petter Selasky 234402ac6454SAndrew Thompson /* free device */ 234528212de2SAndrew Thompson free(udev->serial, M_USB); 234628212de2SAndrew Thompson free(udev->manufacturer, M_USB); 234728212de2SAndrew Thompson free(udev->product, M_USB); 234802ac6454SAndrew Thompson free(udev, M_USB); 234902ac6454SAndrew Thompson } 235002ac6454SAndrew Thompson 235102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2352a593f6b8SAndrew Thompson * usbd_get_iface 235302ac6454SAndrew Thompson * 235402ac6454SAndrew Thompson * This function is the safe way to get the USB interface structure 235502ac6454SAndrew Thompson * pointer by interface index. 235602ac6454SAndrew Thompson * 235702ac6454SAndrew Thompson * Return values: 235802ac6454SAndrew Thompson * NULL: Interface not present. 235902ac6454SAndrew Thompson * Else: Pointer to USB interface structure. 236002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 2361760bc48eSAndrew Thompson struct usb_interface * 2362a593f6b8SAndrew Thompson usbd_get_iface(struct usb_device *udev, uint8_t iface_index) 236302ac6454SAndrew Thompson { 2364760bc48eSAndrew Thompson struct usb_interface *iface = udev->ifaces + iface_index; 236502ac6454SAndrew Thompson 2366bdd41206SAndrew Thompson if (iface_index >= udev->ifaces_max) 236702ac6454SAndrew Thompson return (NULL); 236802ac6454SAndrew Thompson return (iface); 236902ac6454SAndrew Thompson } 237002ac6454SAndrew Thompson 237102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 23723c8d24f4SAndrew Thompson * usbd_find_descriptor 237302ac6454SAndrew Thompson * 237402ac6454SAndrew Thompson * This function will lookup the first descriptor that matches the 237502ac6454SAndrew Thompson * criteria given by the arguments "type" and "subtype". Descriptors 237602ac6454SAndrew Thompson * will only be searched within the interface having the index 237702ac6454SAndrew Thompson * "iface_index". If the "id" argument points to an USB descriptor, 237802ac6454SAndrew Thompson * it will be skipped before the search is started. This allows 237902ac6454SAndrew Thompson * searching for multiple descriptors using the same criteria. Else 238002ac6454SAndrew Thompson * the search is started after the interface descriptor. 238102ac6454SAndrew Thompson * 238202ac6454SAndrew Thompson * Return values: 238302ac6454SAndrew Thompson * NULL: End of descriptors 238402ac6454SAndrew Thompson * Else: A descriptor matching the criteria 238502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 238602ac6454SAndrew Thompson void * 23873c8d24f4SAndrew Thompson usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index, 238802ac6454SAndrew Thompson uint8_t type, uint8_t type_mask, 238902ac6454SAndrew Thompson uint8_t subtype, uint8_t subtype_mask) 239002ac6454SAndrew Thompson { 2391760bc48eSAndrew Thompson struct usb_descriptor *desc; 2392760bc48eSAndrew Thompson struct usb_config_descriptor *cd; 2393760bc48eSAndrew Thompson struct usb_interface *iface; 239402ac6454SAndrew Thompson 2395a593f6b8SAndrew Thompson cd = usbd_get_config_descriptor(udev); 239602ac6454SAndrew Thompson if (cd == NULL) { 239702ac6454SAndrew Thompson return (NULL); 239802ac6454SAndrew Thompson } 239902ac6454SAndrew Thompson if (id == NULL) { 2400a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, iface_index); 240102ac6454SAndrew Thompson if (iface == NULL) { 240202ac6454SAndrew Thompson return (NULL); 240302ac6454SAndrew Thompson } 2404a593f6b8SAndrew Thompson id = usbd_get_interface_descriptor(iface); 240502ac6454SAndrew Thompson if (id == NULL) { 240602ac6454SAndrew Thompson return (NULL); 240702ac6454SAndrew Thompson } 240802ac6454SAndrew Thompson } 240902ac6454SAndrew Thompson desc = (void *)id; 241002ac6454SAndrew Thompson 2411a593f6b8SAndrew Thompson while ((desc = usb_desc_foreach(cd, desc))) { 241202ac6454SAndrew Thompson 241302ac6454SAndrew Thompson if (desc->bDescriptorType == UDESC_INTERFACE) { 241402ac6454SAndrew Thompson break; 241502ac6454SAndrew Thompson } 241602ac6454SAndrew Thompson if (((desc->bDescriptorType & type_mask) == type) && 241702ac6454SAndrew Thompson ((desc->bDescriptorSubtype & subtype_mask) == subtype)) { 241802ac6454SAndrew Thompson return (desc); 241902ac6454SAndrew Thompson } 242002ac6454SAndrew Thompson } 242102ac6454SAndrew Thompson return (NULL); 242202ac6454SAndrew Thompson } 242302ac6454SAndrew Thompson 242402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2425a593f6b8SAndrew Thompson * usb_devinfo 242602ac6454SAndrew Thompson * 242702ac6454SAndrew Thompson * This function will dump information from the device descriptor 242802ac6454SAndrew Thompson * belonging to the USB device pointed to by "udev", to the string 242902ac6454SAndrew Thompson * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes 243002ac6454SAndrew Thompson * including the terminating zero. 243102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 243202ac6454SAndrew Thompson void 2433a593f6b8SAndrew Thompson usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len) 243402ac6454SAndrew Thompson { 2435760bc48eSAndrew Thompson struct usb_device_descriptor *udd = &udev->ddesc; 243602ac6454SAndrew Thompson uint16_t bcdDevice; 243702ac6454SAndrew Thompson uint16_t bcdUSB; 243802ac6454SAndrew Thompson 243902ac6454SAndrew Thompson bcdUSB = UGETW(udd->bcdUSB); 244002ac6454SAndrew Thompson bcdDevice = UGETW(udd->bcdDevice); 244102ac6454SAndrew Thompson 244202ac6454SAndrew Thompson if (udd->bDeviceClass != 0xFF) { 244302ac6454SAndrew Thompson snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/" 24448755859aSAndrew Thompson "%x.%02x, addr %d", 2445ae538d85SAndrew Thompson usb_get_manufacturer(udev), 2446ae538d85SAndrew Thompson usb_get_product(udev), 244702ac6454SAndrew Thompson udd->bDeviceClass, udd->bDeviceSubClass, 244802ac6454SAndrew Thompson (bcdUSB >> 8), bcdUSB & 0xFF, 244902ac6454SAndrew Thompson (bcdDevice >> 8), bcdDevice & 0xFF, 245002ac6454SAndrew Thompson udev->address); 245102ac6454SAndrew Thompson } else { 245202ac6454SAndrew Thompson snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/" 24538755859aSAndrew Thompson "%x.%02x, addr %d", 2454ae538d85SAndrew Thompson usb_get_manufacturer(udev), 2455ae538d85SAndrew Thompson usb_get_product(udev), 245602ac6454SAndrew Thompson (bcdUSB >> 8), bcdUSB & 0xFF, 245702ac6454SAndrew Thompson (bcdDevice >> 8), bcdDevice & 0xFF, 245802ac6454SAndrew Thompson udev->address); 245902ac6454SAndrew Thompson } 246002ac6454SAndrew Thompson } 246102ac6454SAndrew Thompson 2462ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 246302ac6454SAndrew Thompson /* 246402ac6454SAndrew Thompson * Descriptions of of known vendors and devices ("products"). 246502ac6454SAndrew Thompson */ 246602ac6454SAndrew Thompson struct usb_knowndev { 246702ac6454SAndrew Thompson uint16_t vendor; 246802ac6454SAndrew Thompson uint16_t product; 246902ac6454SAndrew Thompson uint32_t flags; 247002ac6454SAndrew Thompson const char *vendorname; 247102ac6454SAndrew Thompson const char *productname; 247202ac6454SAndrew Thompson }; 247302ac6454SAndrew Thompson 247402ac6454SAndrew Thompson #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */ 247502ac6454SAndrew Thompson 247602ac6454SAndrew Thompson #include "usbdevs.h" 247702ac6454SAndrew Thompson #include "usbdevs_data.h" 247802ac6454SAndrew Thompson #endif /* USB_VERBOSE */ 247902ac6454SAndrew Thompson 248002ac6454SAndrew Thompson static void 2481a593f6b8SAndrew Thompson usbd_set_device_strings(struct usb_device *udev) 248202ac6454SAndrew Thompson { 2483760bc48eSAndrew Thompson struct usb_device_descriptor *udd = &udev->ddesc; 2484ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 248502ac6454SAndrew Thompson const struct usb_knowndev *kdp; 248602ac6454SAndrew Thompson #endif 24872df1e9a6SAndrew Thompson char *temp_ptr; 24887a918edfSAndrew Thompson size_t temp_size; 248902ac6454SAndrew Thompson uint16_t vendor_id; 249002ac6454SAndrew Thompson uint16_t product_id; 24916950c75fSHans Petter Selasky uint8_t do_unlock; 249202ac6454SAndrew Thompson 24936950c75fSHans Petter Selasky /* Protect scratch area */ 249464cb5e2aSHans Petter Selasky do_unlock = usbd_ctrl_lock(udev); 24956950c75fSHans Petter Selasky 24966950c75fSHans Petter Selasky temp_ptr = (char *)udev->scratch.data; 24976950c75fSHans Petter Selasky temp_size = sizeof(udev->scratch.data); 24987a918edfSAndrew Thompson 249902ac6454SAndrew Thompson vendor_id = UGETW(udd->idVendor); 250002ac6454SAndrew Thompson product_id = UGETW(udd->idProduct); 250102ac6454SAndrew Thompson 2502c86aead6SAndrew Thompson /* get serial number string */ 25037a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2504c86aead6SAndrew Thompson udev->ddesc.iSerialNumber); 25057a918edfSAndrew Thompson udev->serial = strdup(temp_ptr, M_USB); 250602ac6454SAndrew Thompson 2507c86aead6SAndrew Thompson /* get manufacturer string */ 25087a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2509c86aead6SAndrew Thompson udev->ddesc.iManufacturer); 25107a918edfSAndrew Thompson usb_trim_spaces(temp_ptr); 25117a918edfSAndrew Thompson if (temp_ptr[0] != '\0') 25127a918edfSAndrew Thompson udev->manufacturer = strdup(temp_ptr, M_USB); 2513c86aead6SAndrew Thompson 2514c86aead6SAndrew Thompson /* get product string */ 25157a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2516c86aead6SAndrew Thompson udev->ddesc.iProduct); 25177a918edfSAndrew Thompson usb_trim_spaces(temp_ptr); 25187a918edfSAndrew Thompson if (temp_ptr[0] != '\0') 25197a918edfSAndrew Thompson udev->product = strdup(temp_ptr, M_USB); 2520c86aead6SAndrew Thompson 2521ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 2522c86aead6SAndrew Thompson if (udev->manufacturer == NULL || udev->product == NULL) { 2523c86aead6SAndrew Thompson for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) { 252402ac6454SAndrew Thompson if (kdp->vendor == vendor_id && 252502ac6454SAndrew Thompson (kdp->product == product_id || 252602ac6454SAndrew Thompson (kdp->flags & USB_KNOWNDEV_NOPROD) != 0)) 252702ac6454SAndrew Thompson break; 252802ac6454SAndrew Thompson } 252902ac6454SAndrew Thompson if (kdp->vendorname != NULL) { 2530c86aead6SAndrew Thompson /* XXX should use pointer to knowndevs string */ 2531c86aead6SAndrew Thompson if (udev->manufacturer == NULL) { 2532c86aead6SAndrew Thompson udev->manufacturer = strdup(kdp->vendorname, 2533c86aead6SAndrew Thompson M_USB); 2534c86aead6SAndrew Thompson } 2535c86aead6SAndrew Thompson if (udev->product == NULL && 2536c86aead6SAndrew Thompson (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) { 2537c86aead6SAndrew Thompson udev->product = strdup(kdp->productname, 2538c86aead6SAndrew Thompson M_USB); 2539c86aead6SAndrew Thompson } 254002ac6454SAndrew Thompson } 254102ac6454SAndrew Thompson } 254202ac6454SAndrew Thompson #endif 2543c86aead6SAndrew Thompson /* Provide default strings if none were found */ 2544c86aead6SAndrew Thompson if (udev->manufacturer == NULL) { 25457a918edfSAndrew Thompson snprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id); 25467a918edfSAndrew Thompson udev->manufacturer = strdup(temp_ptr, M_USB); 254702ac6454SAndrew Thompson } 2548c86aead6SAndrew Thompson if (udev->product == NULL) { 25497a918edfSAndrew Thompson snprintf(temp_ptr, temp_size, "product 0x%04x", product_id); 25507a918edfSAndrew Thompson udev->product = strdup(temp_ptr, M_USB); 255102ac6454SAndrew Thompson } 25526950c75fSHans Petter Selasky 25536950c75fSHans Petter Selasky if (do_unlock) 255464cb5e2aSHans Petter Selasky usbd_ctrl_unlock(udev); 255502ac6454SAndrew Thompson } 255602ac6454SAndrew Thompson 255702ac6454SAndrew Thompson /* 255802ac6454SAndrew Thompson * Returns: 255902ac6454SAndrew Thompson * See: USB_MODE_XXX 256002ac6454SAndrew Thompson */ 2561f29a0724SAndrew Thompson enum usb_hc_mode 2562a593f6b8SAndrew Thompson usbd_get_mode(struct usb_device *udev) 256302ac6454SAndrew Thompson { 2564f29a0724SAndrew Thompson return (udev->flags.usb_mode); 256502ac6454SAndrew Thompson } 256602ac6454SAndrew Thompson 256702ac6454SAndrew Thompson /* 256802ac6454SAndrew Thompson * Returns: 256902ac6454SAndrew Thompson * See: USB_SPEED_XXX 257002ac6454SAndrew Thompson */ 25718d2dd5ddSAndrew Thompson enum usb_dev_speed 2572a593f6b8SAndrew Thompson usbd_get_speed(struct usb_device *udev) 257302ac6454SAndrew Thompson { 257402ac6454SAndrew Thompson return (udev->speed); 257502ac6454SAndrew Thompson } 257602ac6454SAndrew Thompson 257702ac6454SAndrew Thompson uint32_t 2578a593f6b8SAndrew Thompson usbd_get_isoc_fps(struct usb_device *udev) 257902ac6454SAndrew Thompson { 258002ac6454SAndrew Thompson ; /* indent fix */ 258102ac6454SAndrew Thompson switch (udev->speed) { 258202ac6454SAndrew Thompson case USB_SPEED_LOW: 258302ac6454SAndrew Thompson case USB_SPEED_FULL: 258402ac6454SAndrew Thompson return (1000); 258502ac6454SAndrew Thompson default: 258602ac6454SAndrew Thompson return (8000); 258702ac6454SAndrew Thompson } 258802ac6454SAndrew Thompson } 258902ac6454SAndrew Thompson 2590760bc48eSAndrew Thompson struct usb_device_descriptor * 2591a593f6b8SAndrew Thompson usbd_get_device_descriptor(struct usb_device *udev) 259202ac6454SAndrew Thompson { 259302ac6454SAndrew Thompson if (udev == NULL) 259402ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 259502ac6454SAndrew Thompson return (&udev->ddesc); 259602ac6454SAndrew Thompson } 259702ac6454SAndrew Thompson 2598760bc48eSAndrew Thompson struct usb_config_descriptor * 2599a593f6b8SAndrew Thompson usbd_get_config_descriptor(struct usb_device *udev) 260002ac6454SAndrew Thompson { 260102ac6454SAndrew Thompson if (udev == NULL) 260202ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 260302ac6454SAndrew Thompson return (udev->cdesc); 260402ac6454SAndrew Thompson } 260502ac6454SAndrew Thompson 260602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2607a593f6b8SAndrew Thompson * usb_test_quirk - test a device for a given quirk 260802ac6454SAndrew Thompson * 260902ac6454SAndrew Thompson * Return values: 261002ac6454SAndrew Thompson * 0: The USB device does not have the given quirk. 261102ac6454SAndrew Thompson * Else: The USB device has the given quirk. 261202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 261302ac6454SAndrew Thompson uint8_t 2614a593f6b8SAndrew Thompson usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk) 261502ac6454SAndrew Thompson { 261602ac6454SAndrew Thompson uint8_t found; 26173f37fb62SHans Petter Selasky uint8_t x; 26183f37fb62SHans Petter Selasky 26193f37fb62SHans Petter Selasky if (quirk == UQ_NONE) 26203f37fb62SHans Petter Selasky return (0); 26213f37fb62SHans Petter Selasky 26223f37fb62SHans Petter Selasky /* search the automatic per device quirks first */ 26233f37fb62SHans Petter Selasky 26243f37fb62SHans Petter Selasky for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) { 26253f37fb62SHans Petter Selasky if (uaa->device->autoQuirk[x] == quirk) 26263f37fb62SHans Petter Selasky return (1); 26273f37fb62SHans Petter Selasky } 26283f37fb62SHans Petter Selasky 26293f37fb62SHans Petter Selasky /* search global quirk table, if any */ 263002ac6454SAndrew Thompson 2631a593f6b8SAndrew Thompson found = (usb_test_quirk_p) (&uaa->info, quirk); 26323f37fb62SHans Petter Selasky 263302ac6454SAndrew Thompson return (found); 263402ac6454SAndrew Thompson } 263502ac6454SAndrew Thompson 2636760bc48eSAndrew Thompson struct usb_interface_descriptor * 2637a593f6b8SAndrew Thompson usbd_get_interface_descriptor(struct usb_interface *iface) 263802ac6454SAndrew Thompson { 263902ac6454SAndrew Thompson if (iface == NULL) 264002ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 264102ac6454SAndrew Thompson return (iface->idesc); 264202ac6454SAndrew Thompson } 264302ac6454SAndrew Thompson 264402ac6454SAndrew Thompson uint8_t 2645a593f6b8SAndrew Thompson usbd_get_interface_altindex(struct usb_interface *iface) 264602ac6454SAndrew Thompson { 264702ac6454SAndrew Thompson return (iface->alt_index); 264802ac6454SAndrew Thompson } 264902ac6454SAndrew Thompson 265002ac6454SAndrew Thompson uint8_t 2651a593f6b8SAndrew Thompson usbd_get_bus_index(struct usb_device *udev) 265202ac6454SAndrew Thompson { 265302ac6454SAndrew Thompson return ((uint8_t)device_get_unit(udev->bus->bdev)); 265402ac6454SAndrew Thompson } 265502ac6454SAndrew Thompson 265602ac6454SAndrew Thompson uint8_t 2657a593f6b8SAndrew Thompson usbd_get_device_index(struct usb_device *udev) 265802ac6454SAndrew Thompson { 265902ac6454SAndrew Thompson return (udev->device_index); 266002ac6454SAndrew Thompson } 266102ac6454SAndrew Thompson 26628bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 26633acd904dSAndrew Thompson static void 26643acd904dSAndrew Thompson usb_notify_addq(const char *type, struct usb_device *udev) 26653acd904dSAndrew Thompson { 26663acd904dSAndrew Thompson struct usb_interface *iface; 26673acd904dSAndrew Thompson struct sbuf *sb; 26683acd904dSAndrew Thompson int i; 26693acd904dSAndrew Thompson 26703acd904dSAndrew Thompson /* announce the device */ 26713acd904dSAndrew Thompson sb = sbuf_new_auto(); 26723acd904dSAndrew Thompson sbuf_printf(sb, 26738bb77249SHans Petter Selasky #if USB_HAVE_UGEN 26748bb77249SHans Petter Selasky "ugen=%s " 267502c40241SHans Petter Selasky "cdev=%s " 26768bb77249SHans Petter Selasky #endif 26773acd904dSAndrew Thompson "vendor=0x%04x " 26783acd904dSAndrew Thompson "product=0x%04x " 26793acd904dSAndrew Thompson "devclass=0x%02x " 26803acd904dSAndrew Thompson "devsubclass=0x%02x " 26813acd904dSAndrew Thompson "sernum=\"%s\" " 26823acd904dSAndrew Thompson "release=0x%04x " 268366390216SAndrew Thompson "mode=%s " 26843acd904dSAndrew Thompson "port=%u " 26858bb77249SHans Petter Selasky #if USB_HAVE_UGEN 26866df3eebbSNick Hibma "parent=%s" 26878bb77249SHans Petter Selasky #endif 26888bb77249SHans Petter Selasky "", 26898bb77249SHans Petter Selasky #if USB_HAVE_UGEN 26903acd904dSAndrew Thompson udev->ugen_name, 269102c40241SHans Petter Selasky udev->ugen_name, 26928bb77249SHans Petter Selasky #endif 26933acd904dSAndrew Thompson UGETW(udev->ddesc.idVendor), 26943acd904dSAndrew Thompson UGETW(udev->ddesc.idProduct), 26953acd904dSAndrew Thompson udev->ddesc.bDeviceClass, 26963acd904dSAndrew Thompson udev->ddesc.bDeviceSubClass, 2697ae538d85SAndrew Thompson usb_get_serial(udev), 26983acd904dSAndrew Thompson UGETW(udev->ddesc.bcdDevice), 269966390216SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device", 27008bb77249SHans Petter Selasky udev->port_no 27018bb77249SHans Petter Selasky #if USB_HAVE_UGEN 27028bb77249SHans Petter Selasky , udev->parent_hub != NULL ? 27033acd904dSAndrew Thompson udev->parent_hub->ugen_name : 27048bb77249SHans Petter Selasky device_get_nameunit(device_get_parent(udev->bus->bdev)) 27058bb77249SHans Petter Selasky #endif 27068bb77249SHans Petter Selasky ); 27073acd904dSAndrew Thompson sbuf_finish(sb); 27083acd904dSAndrew Thompson devctl_notify("USB", "DEVICE", type, sbuf_data(sb)); 27093acd904dSAndrew Thompson sbuf_delete(sb); 27103acd904dSAndrew Thompson 27113acd904dSAndrew Thompson /* announce each interface */ 27123acd904dSAndrew Thompson for (i = 0; i < USB_IFACE_MAX; i++) { 27133acd904dSAndrew Thompson iface = usbd_get_iface(udev, i); 27143acd904dSAndrew Thompson if (iface == NULL) 27153acd904dSAndrew Thompson break; /* end of interfaces */ 27163acd904dSAndrew Thompson if (iface->idesc == NULL) 27173acd904dSAndrew Thompson continue; /* no interface descriptor */ 27183acd904dSAndrew Thompson 27193acd904dSAndrew Thompson sb = sbuf_new_auto(); 27203acd904dSAndrew Thompson sbuf_printf(sb, 27218bb77249SHans Petter Selasky #if USB_HAVE_UGEN 27228bb77249SHans Petter Selasky "ugen=%s " 272302c40241SHans Petter Selasky "cdev=%s " 27248bb77249SHans Petter Selasky #endif 27253acd904dSAndrew Thompson "vendor=0x%04x " 27263acd904dSAndrew Thompson "product=0x%04x " 27273acd904dSAndrew Thompson "devclass=0x%02x " 27283acd904dSAndrew Thompson "devsubclass=0x%02x " 27293acd904dSAndrew Thompson "sernum=\"%s\" " 27303acd904dSAndrew Thompson "release=0x%04x " 273166390216SAndrew Thompson "mode=%s " 27323acd904dSAndrew Thompson "interface=%d " 27333acd904dSAndrew Thompson "endpoints=%d " 27343acd904dSAndrew Thompson "intclass=0x%02x " 27353acd904dSAndrew Thompson "intsubclass=0x%02x " 27366df3eebbSNick Hibma "intprotocol=0x%02x", 27378bb77249SHans Petter Selasky #if USB_HAVE_UGEN 27383acd904dSAndrew Thompson udev->ugen_name, 273902c40241SHans Petter Selasky udev->ugen_name, 27408bb77249SHans Petter Selasky #endif 27413acd904dSAndrew Thompson UGETW(udev->ddesc.idVendor), 27423acd904dSAndrew Thompson UGETW(udev->ddesc.idProduct), 27433acd904dSAndrew Thompson udev->ddesc.bDeviceClass, 27443acd904dSAndrew Thompson udev->ddesc.bDeviceSubClass, 2745ae538d85SAndrew Thompson usb_get_serial(udev), 27463acd904dSAndrew Thompson UGETW(udev->ddesc.bcdDevice), 274766390216SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device", 27483acd904dSAndrew Thompson iface->idesc->bInterfaceNumber, 27493acd904dSAndrew Thompson iface->idesc->bNumEndpoints, 27503acd904dSAndrew Thompson iface->idesc->bInterfaceClass, 27513acd904dSAndrew Thompson iface->idesc->bInterfaceSubClass, 27523acd904dSAndrew Thompson iface->idesc->bInterfaceProtocol); 27533acd904dSAndrew Thompson sbuf_finish(sb); 27543acd904dSAndrew Thompson devctl_notify("USB", "INTERFACE", type, sbuf_data(sb)); 27553acd904dSAndrew Thompson sbuf_delete(sb); 27563acd904dSAndrew Thompson } 27573acd904dSAndrew Thompson } 27588bb77249SHans Petter Selasky #endif 275902ac6454SAndrew Thompson 27608bb77249SHans Petter Selasky #if USB_HAVE_UGEN 276102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2762a593f6b8SAndrew Thompson * usb_fifo_free_wrap 276302ac6454SAndrew Thompson * 276402ac6454SAndrew Thompson * This function will free the FIFOs. 276502ac6454SAndrew Thompson * 2766bdd41206SAndrew Thompson * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag 2767bdd41206SAndrew Thompson * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free 2768bdd41206SAndrew Thompson * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and 2769bdd41206SAndrew Thompson * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non 2770bdd41206SAndrew Thompson * control endpoint FIFOs. If "iface_index" is not set to 2771bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" the flag has no effect. 277202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 277302ac6454SAndrew Thompson static void 2774a593f6b8SAndrew Thompson usb_fifo_free_wrap(struct usb_device *udev, 277502ac6454SAndrew Thompson uint8_t iface_index, uint8_t flag) 277602ac6454SAndrew Thompson { 2777760bc48eSAndrew Thompson struct usb_fifo *f; 277802ac6454SAndrew Thompson uint16_t i; 277902ac6454SAndrew Thompson 278002ac6454SAndrew Thompson /* 278102ac6454SAndrew Thompson * Free any USB FIFOs on the given interface: 278202ac6454SAndrew Thompson */ 278302ac6454SAndrew Thompson for (i = 0; i != USB_FIFO_MAX; i++) { 278402ac6454SAndrew Thompson f = udev->fifo[i]; 278502ac6454SAndrew Thompson if (f == NULL) { 278602ac6454SAndrew Thompson continue; 278702ac6454SAndrew Thompson } 278802ac6454SAndrew Thompson /* Check if the interface index matches */ 278902ac6454SAndrew Thompson if (iface_index == f->iface_index) { 2790a593f6b8SAndrew Thompson if (f->methods != &usb_ugen_methods) { 279102ac6454SAndrew Thompson /* 279202ac6454SAndrew Thompson * Don't free any non-generic FIFOs in 279302ac6454SAndrew Thompson * this case. 279402ac6454SAndrew Thompson */ 279502ac6454SAndrew Thompson continue; 279602ac6454SAndrew Thompson } 279702ac6454SAndrew Thompson if ((f->dev_ep_index == 0) && 279802ac6454SAndrew Thompson (f->fs_xfer == NULL)) { 279902ac6454SAndrew Thompson /* no need to free this FIFO */ 280002ac6454SAndrew Thompson continue; 280102ac6454SAndrew Thompson } 280202ac6454SAndrew Thompson } else if (iface_index == USB_IFACE_INDEX_ANY) { 2803a593f6b8SAndrew Thompson if ((f->methods == &usb_ugen_methods) && 2804bdd41206SAndrew Thompson (f->dev_ep_index == 0) && 2805bdd41206SAndrew Thompson (!(flag & USB_UNCFG_FLAG_FREE_EP0)) && 280602ac6454SAndrew Thompson (f->fs_xfer == NULL)) { 280702ac6454SAndrew Thompson /* no need to free this FIFO */ 280802ac6454SAndrew Thompson continue; 280902ac6454SAndrew Thompson } 281002ac6454SAndrew Thompson } else { 281102ac6454SAndrew Thompson /* no need to free this FIFO */ 281202ac6454SAndrew Thompson continue; 281302ac6454SAndrew Thompson } 281402ac6454SAndrew Thompson /* free this FIFO */ 2815a593f6b8SAndrew Thompson usb_fifo_free(f); 281602ac6454SAndrew Thompson } 281702ac6454SAndrew Thompson } 28180f6e8f93SAndrew Thompson #endif 281902ac6454SAndrew Thompson 282002ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2821a593f6b8SAndrew Thompson * usb_peer_can_wakeup 282202ac6454SAndrew Thompson * 282302ac6454SAndrew Thompson * Return values: 282402ac6454SAndrew Thompson * 0: Peer cannot do resume signalling. 282502ac6454SAndrew Thompson * Else: Peer can do resume signalling. 282602ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 282702ac6454SAndrew Thompson uint8_t 2828a593f6b8SAndrew Thompson usb_peer_can_wakeup(struct usb_device *udev) 282902ac6454SAndrew Thompson { 2830760bc48eSAndrew Thompson const struct usb_config_descriptor *cdp; 283102ac6454SAndrew Thompson 283202ac6454SAndrew Thompson cdp = udev->cdesc; 2833f29a0724SAndrew Thompson if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) { 283402ac6454SAndrew Thompson return (cdp->bmAttributes & UC_REMOTE_WAKEUP); 283502ac6454SAndrew Thompson } 283602ac6454SAndrew Thompson return (0); /* not supported */ 283702ac6454SAndrew Thompson } 2838bd216778SAndrew Thompson 2839bd216778SAndrew Thompson void 2840a593f6b8SAndrew Thompson usb_set_device_state(struct usb_device *udev, enum usb_dev_state state) 2841bd216778SAndrew Thompson { 2842bd216778SAndrew Thompson 2843bd216778SAndrew Thompson KASSERT(state < USB_STATE_MAX, ("invalid udev state")); 2844bd216778SAndrew Thompson 2845bd216778SAndrew Thompson DPRINTF("udev %p state %s -> %s\n", udev, 2846a593f6b8SAndrew Thompson usb_statestr(udev->state), usb_statestr(state)); 2847963169b4SHans Petter Selasky 2848f97da128SHans Petter Selasky #if USB_HAVE_UGEN 2849f97da128SHans Petter Selasky mtx_lock(&usb_ref_lock); 2850f97da128SHans Petter Selasky #endif 2851f97da128SHans Petter Selasky udev->state = state; 2852f97da128SHans Petter Selasky #if USB_HAVE_UGEN 2853f97da128SHans Petter Selasky mtx_unlock(&usb_ref_lock); 2854f97da128SHans Petter Selasky #endif 2855963169b4SHans Petter Selasky if (udev->bus->methods->device_state_change != NULL) 2856963169b4SHans Petter Selasky (udev->bus->methods->device_state_change) (udev); 2857963169b4SHans Petter Selasky } 2858963169b4SHans Petter Selasky 2859963169b4SHans Petter Selasky enum usb_dev_state 2860963169b4SHans Petter Selasky usb_get_device_state(struct usb_device *udev) 2861963169b4SHans Petter Selasky { 2862963169b4SHans Petter Selasky if (udev == NULL) 2863963169b4SHans Petter Selasky return (USB_STATE_DETACHED); 2864963169b4SHans Petter Selasky return (udev->state); 2865bd216778SAndrew Thompson } 2866bd216778SAndrew Thompson 2867ec8f3127SAndrew Thompson uint8_t 2868a593f6b8SAndrew Thompson usbd_device_attached(struct usb_device *udev) 2869bd216778SAndrew Thompson { 2870bd216778SAndrew Thompson return (udev->state > USB_STATE_DETACHED); 2871bd216778SAndrew Thompson } 2872cb18f7d1SAlfred Perlstein 28736950c75fSHans Petter Selasky /* 28746950c75fSHans Petter Selasky * The following function locks enumerating the given USB device. If 28756950c75fSHans Petter Selasky * the lock is already grabbed this function returns zero. Else a 287610aab8b6SHans Petter Selasky * a value of one is returned. 28776950c75fSHans Petter Selasky */ 28786950c75fSHans Petter Selasky uint8_t 2879cb18f7d1SAlfred Perlstein usbd_enum_lock(struct usb_device *udev) 2880cb18f7d1SAlfred Perlstein { 28816950c75fSHans Petter Selasky if (sx_xlocked(&udev->enum_sx)) 28826950c75fSHans Petter Selasky return (0); 28836950c75fSHans Petter Selasky 288491cd9240SAndrew Thompson sx_xlock(&udev->enum_sx); 28852df1e9a6SAndrew Thompson sx_xlock(&udev->sr_sx); 2886cb18f7d1SAlfred Perlstein /* 2887cb18f7d1SAlfred Perlstein * NEWBUS LOCK NOTE: We should check if any parent SX locks 2888cb18f7d1SAlfred Perlstein * are locked before locking Giant. Else the lock can be 2889cb18f7d1SAlfred Perlstein * locked multiple times. 2890cb18f7d1SAlfred Perlstein */ 2891cb18f7d1SAlfred Perlstein mtx_lock(&Giant); 28926950c75fSHans Petter Selasky return (1); 2893cb18f7d1SAlfred Perlstein } 2894cb18f7d1SAlfred Perlstein 289510aab8b6SHans Petter Selasky #if USB_HAVE_UGEN 289610aab8b6SHans Petter Selasky /* 289710aab8b6SHans Petter Selasky * This function is the same like usbd_enum_lock() except a value of 289810aab8b6SHans Petter Selasky * 255 is returned when a signal is pending: 289910aab8b6SHans Petter Selasky */ 290010aab8b6SHans Petter Selasky uint8_t 290110aab8b6SHans Petter Selasky usbd_enum_lock_sig(struct usb_device *udev) 290210aab8b6SHans Petter Selasky { 290310aab8b6SHans Petter Selasky if (sx_xlocked(&udev->enum_sx)) 290410aab8b6SHans Petter Selasky return (0); 290510aab8b6SHans Petter Selasky if (sx_xlock_sig(&udev->enum_sx)) 290610aab8b6SHans Petter Selasky return (255); 290710aab8b6SHans Petter Selasky if (sx_xlock_sig(&udev->sr_sx)) { 290810aab8b6SHans Petter Selasky sx_xunlock(&udev->enum_sx); 290910aab8b6SHans Petter Selasky return (255); 291010aab8b6SHans Petter Selasky } 291110aab8b6SHans Petter Selasky mtx_lock(&Giant); 291210aab8b6SHans Petter Selasky return (1); 291310aab8b6SHans Petter Selasky } 291410aab8b6SHans Petter Selasky #endif 291510aab8b6SHans Petter Selasky 2916cb18f7d1SAlfred Perlstein /* The following function unlocks enumerating the given USB device. */ 2917cb18f7d1SAlfred Perlstein 2918cb18f7d1SAlfred Perlstein void 2919cb18f7d1SAlfred Perlstein usbd_enum_unlock(struct usb_device *udev) 2920cb18f7d1SAlfred Perlstein { 2921cb18f7d1SAlfred Perlstein mtx_unlock(&Giant); 292291cd9240SAndrew Thompson sx_xunlock(&udev->enum_sx); 29232df1e9a6SAndrew Thompson sx_xunlock(&udev->sr_sx); 29242df1e9a6SAndrew Thompson } 29252df1e9a6SAndrew Thompson 29262df1e9a6SAndrew Thompson /* The following function locks suspend and resume. */ 29272df1e9a6SAndrew Thompson 29282df1e9a6SAndrew Thompson void 29292df1e9a6SAndrew Thompson usbd_sr_lock(struct usb_device *udev) 29302df1e9a6SAndrew Thompson { 29312df1e9a6SAndrew Thompson sx_xlock(&udev->sr_sx); 29322df1e9a6SAndrew Thompson /* 29332df1e9a6SAndrew Thompson * NEWBUS LOCK NOTE: We should check if any parent SX locks 29342df1e9a6SAndrew Thompson * are locked before locking Giant. Else the lock can be 29352df1e9a6SAndrew Thompson * locked multiple times. 29362df1e9a6SAndrew Thompson */ 29372df1e9a6SAndrew Thompson mtx_lock(&Giant); 29382df1e9a6SAndrew Thompson } 29392df1e9a6SAndrew Thompson 29402df1e9a6SAndrew Thompson /* The following function unlocks suspend and resume. */ 29412df1e9a6SAndrew Thompson 29422df1e9a6SAndrew Thompson void 29432df1e9a6SAndrew Thompson usbd_sr_unlock(struct usb_device *udev) 29442df1e9a6SAndrew Thompson { 29452df1e9a6SAndrew Thompson mtx_unlock(&Giant); 29462df1e9a6SAndrew Thompson sx_xunlock(&udev->sr_sx); 2947cb18f7d1SAlfred Perlstein } 2948cb18f7d1SAlfred Perlstein 2949cb18f7d1SAlfred Perlstein /* 2950cb18f7d1SAlfred Perlstein * The following function checks the enumerating lock for the given 2951cb18f7d1SAlfred Perlstein * USB device. 2952cb18f7d1SAlfred Perlstein */ 2953cb18f7d1SAlfred Perlstein 2954cb18f7d1SAlfred Perlstein uint8_t 2955cb18f7d1SAlfred Perlstein usbd_enum_is_locked(struct usb_device *udev) 2956cb18f7d1SAlfred Perlstein { 295791cd9240SAndrew Thompson return (sx_xlocked(&udev->enum_sx)); 2958cb18f7d1SAlfred Perlstein } 29598427ed84SHans Petter Selasky 29608427ed84SHans Petter Selasky /* 296164cb5e2aSHans Petter Selasky * The following function is used to serialize access to USB control 296264cb5e2aSHans Petter Selasky * transfers and the USB scratch area. If the lock is already grabbed 296364cb5e2aSHans Petter Selasky * this function returns zero. Else a value of one is returned. 296464cb5e2aSHans Petter Selasky */ 296564cb5e2aSHans Petter Selasky uint8_t 296664cb5e2aSHans Petter Selasky usbd_ctrl_lock(struct usb_device *udev) 296764cb5e2aSHans Petter Selasky { 296864cb5e2aSHans Petter Selasky if (sx_xlocked(&udev->ctrl_sx)) 296964cb5e2aSHans Petter Selasky return (0); 297064cb5e2aSHans Petter Selasky sx_xlock(&udev->ctrl_sx); 297164cb5e2aSHans Petter Selasky 297264cb5e2aSHans Petter Selasky /* 297364cb5e2aSHans Petter Selasky * We need to allow suspend and resume at this point, else the 297464cb5e2aSHans Petter Selasky * control transfer will timeout if the device is suspended! 297564cb5e2aSHans Petter Selasky */ 297664cb5e2aSHans Petter Selasky if (usbd_enum_is_locked(udev)) 297764cb5e2aSHans Petter Selasky usbd_sr_unlock(udev); 297864cb5e2aSHans Petter Selasky return (1); 297964cb5e2aSHans Petter Selasky } 298064cb5e2aSHans Petter Selasky 298164cb5e2aSHans Petter Selasky void 298264cb5e2aSHans Petter Selasky usbd_ctrl_unlock(struct usb_device *udev) 298364cb5e2aSHans Petter Selasky { 298464cb5e2aSHans Petter Selasky sx_xunlock(&udev->ctrl_sx); 298564cb5e2aSHans Petter Selasky 298664cb5e2aSHans Petter Selasky /* 298764cb5e2aSHans Petter Selasky * Restore the suspend and resume lock after we have unlocked 298864cb5e2aSHans Petter Selasky * the USB control transfer lock to avoid LOR: 298964cb5e2aSHans Petter Selasky */ 299064cb5e2aSHans Petter Selasky if (usbd_enum_is_locked(udev)) 299164cb5e2aSHans Petter Selasky usbd_sr_lock(udev); 299264cb5e2aSHans Petter Selasky } 299364cb5e2aSHans Petter Selasky 299464cb5e2aSHans Petter Selasky /* 29958427ed84SHans Petter Selasky * The following function is used to set the per-interface specific 29968427ed84SHans Petter Selasky * plug and play information. The string referred to by the pnpinfo 29978427ed84SHans Petter Selasky * argument can safely be freed after calling this function. The 29988427ed84SHans Petter Selasky * pnpinfo of an interface will be reset at device detach or when 29998427ed84SHans Petter Selasky * passing a NULL argument to this function. This function 30008427ed84SHans Petter Selasky * returns zero on success, else a USB_ERR_XXX failure code. 30018427ed84SHans Petter Selasky */ 30028427ed84SHans Petter Selasky 30038427ed84SHans Petter Selasky usb_error_t 30048427ed84SHans Petter Selasky usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo) 30058427ed84SHans Petter Selasky { 30068427ed84SHans Petter Selasky struct usb_interface *iface; 30078427ed84SHans Petter Selasky 30088427ed84SHans Petter Selasky iface = usbd_get_iface(udev, iface_index); 30098427ed84SHans Petter Selasky if (iface == NULL) 30108427ed84SHans Petter Selasky return (USB_ERR_INVAL); 30118427ed84SHans Petter Selasky 30128427ed84SHans Petter Selasky if (iface->pnpinfo != NULL) { 30138427ed84SHans Petter Selasky free(iface->pnpinfo, M_USBDEV); 30148427ed84SHans Petter Selasky iface->pnpinfo = NULL; 30158427ed84SHans Petter Selasky } 30168427ed84SHans Petter Selasky 30178427ed84SHans Petter Selasky if (pnpinfo == NULL || pnpinfo[0] == 0) 30188427ed84SHans Petter Selasky return (0); /* success */ 30198427ed84SHans Petter Selasky 30208427ed84SHans Petter Selasky iface->pnpinfo = strdup(pnpinfo, M_USBDEV); 30218427ed84SHans Petter Selasky if (iface->pnpinfo == NULL) 30228427ed84SHans Petter Selasky return (USB_ERR_NOMEM); 30238427ed84SHans Petter Selasky 30248427ed84SHans Petter Selasky return (0); /* success */ 30258427ed84SHans Petter Selasky } 30268427ed84SHans Petter Selasky 3027d46dc4adSHans Petter Selasky usb_error_t 3028d46dc4adSHans Petter Selasky usbd_add_dynamic_quirk(struct usb_device *udev, uint16_t quirk) 3029d46dc4adSHans Petter Selasky { 3030d46dc4adSHans Petter Selasky uint8_t x; 3031d46dc4adSHans Petter Selasky 3032d46dc4adSHans Petter Selasky for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) { 30333f37fb62SHans Petter Selasky if (udev->autoQuirk[x] == 0 || 30343f37fb62SHans Petter Selasky udev->autoQuirk[x] == quirk) { 3035d46dc4adSHans Petter Selasky udev->autoQuirk[x] = quirk; 3036d46dc4adSHans Petter Selasky return (0); /* success */ 3037d46dc4adSHans Petter Selasky } 3038d46dc4adSHans Petter Selasky } 3039d46dc4adSHans Petter Selasky return (USB_ERR_NOMEM); 3040d46dc4adSHans Petter Selasky } 3041a5cf1aaaSHans Petter Selasky 3042a5cf1aaaSHans Petter Selasky /* 3043a5cf1aaaSHans Petter Selasky * The following function is used to select the endpoint mode. It 3044a5cf1aaaSHans Petter Selasky * should not be called outside enumeration context. 3045a5cf1aaaSHans Petter Selasky */ 3046a5cf1aaaSHans Petter Selasky 3047a5cf1aaaSHans Petter Selasky usb_error_t 3048a5cf1aaaSHans Petter Selasky usbd_set_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep, 3049a5cf1aaaSHans Petter Selasky uint8_t ep_mode) 3050a5cf1aaaSHans Petter Selasky { 3051a5cf1aaaSHans Petter Selasky usb_error_t error; 3052f61fc4bdSHans Petter Selasky uint8_t do_unlock; 3053a5cf1aaaSHans Petter Selasky 30546950c75fSHans Petter Selasky /* Prevent re-enumeration */ 30556950c75fSHans Petter Selasky do_unlock = usbd_enum_lock(udev); 3056a5cf1aaaSHans Petter Selasky 3057a5cf1aaaSHans Petter Selasky if (udev->bus->methods->set_endpoint_mode != NULL) { 3058a5cf1aaaSHans Petter Selasky error = (udev->bus->methods->set_endpoint_mode) ( 3059a5cf1aaaSHans Petter Selasky udev, ep, ep_mode); 3060a5cf1aaaSHans Petter Selasky } else if (ep_mode != USB_EP_MODE_DEFAULT) { 3061a5cf1aaaSHans Petter Selasky error = USB_ERR_INVAL; 3062a5cf1aaaSHans Petter Selasky } else { 3063a5cf1aaaSHans Petter Selasky error = 0; 3064a5cf1aaaSHans Petter Selasky } 3065a5cf1aaaSHans Petter Selasky 3066a5cf1aaaSHans Petter Selasky /* only set new mode regardless of error */ 3067a5cf1aaaSHans Petter Selasky ep->ep_mode = ep_mode; 3068a5cf1aaaSHans Petter Selasky 3069f61fc4bdSHans Petter Selasky if (do_unlock) 3070f61fc4bdSHans Petter Selasky usbd_enum_unlock(udev); 3071a5cf1aaaSHans Petter Selasky return (error); 3072a5cf1aaaSHans Petter Selasky } 3073a5cf1aaaSHans Petter Selasky 3074a5cf1aaaSHans Petter Selasky uint8_t 3075a5cf1aaaSHans Petter Selasky usbd_get_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep) 3076a5cf1aaaSHans Petter Selasky { 3077a5cf1aaaSHans Petter Selasky return (ep->ep_mode); 3078a5cf1aaaSHans Petter Selasky } 3079