102ac6454SAndrew Thompson /* $FreeBSD$ */ 202ac6454SAndrew Thompson /*- 302ac6454SAndrew Thompson * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 402ac6454SAndrew Thompson * 502ac6454SAndrew Thompson * Redistribution and use in source and binary forms, with or without 602ac6454SAndrew Thompson * modification, are permitted provided that the following conditions 702ac6454SAndrew Thompson * are met: 802ac6454SAndrew Thompson * 1. Redistributions of source code must retain the above copyright 902ac6454SAndrew Thompson * notice, this list of conditions and the following disclaimer. 1002ac6454SAndrew Thompson * 2. Redistributions in binary form must reproduce the above copyright 1102ac6454SAndrew Thompson * notice, this list of conditions and the following disclaimer in the 1202ac6454SAndrew Thompson * documentation and/or other materials provided with the distribution. 1302ac6454SAndrew Thompson * 1402ac6454SAndrew Thompson * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1502ac6454SAndrew Thompson * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1602ac6454SAndrew Thompson * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1702ac6454SAndrew Thompson * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1802ac6454SAndrew Thompson * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1902ac6454SAndrew Thompson * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2002ac6454SAndrew Thompson * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2102ac6454SAndrew Thompson * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2202ac6454SAndrew Thompson * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2302ac6454SAndrew Thompson * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2402ac6454SAndrew Thompson * SUCH DAMAGE. 2502ac6454SAndrew Thompson */ 2602ac6454SAndrew Thompson 27ed6d949aSAndrew Thompson #include <sys/stdint.h> 28ed6d949aSAndrew Thompson #include <sys/stddef.h> 29ed6d949aSAndrew Thompson #include <sys/param.h> 30ed6d949aSAndrew Thompson #include <sys/queue.h> 31ed6d949aSAndrew Thompson #include <sys/types.h> 32ed6d949aSAndrew Thompson #include <sys/systm.h> 33ed6d949aSAndrew Thompson #include <sys/kernel.h> 34ed6d949aSAndrew Thompson #include <sys/bus.h> 35ed6d949aSAndrew Thompson #include <sys/module.h> 36ed6d949aSAndrew Thompson #include <sys/lock.h> 37ed6d949aSAndrew Thompson #include <sys/mutex.h> 38ed6d949aSAndrew Thompson #include <sys/condvar.h> 39ed6d949aSAndrew Thompson #include <sys/sysctl.h> 40ed6d949aSAndrew Thompson #include <sys/sx.h> 41ed6d949aSAndrew Thompson #include <sys/unistd.h> 42ed6d949aSAndrew Thompson #include <sys/callout.h> 43ed6d949aSAndrew Thompson #include <sys/malloc.h> 44ed6d949aSAndrew Thompson #include <sys/priv.h> 45ed6d949aSAndrew Thompson #include <sys/conf.h> 46ed6d949aSAndrew Thompson #include <sys/fcntl.h> 47ed6d949aSAndrew Thompson 4802ac6454SAndrew Thompson #include <dev/usb/usb.h> 49ed6d949aSAndrew Thompson #include <dev/usb/usbdi.h> 50ed6d949aSAndrew Thompson #include <dev/usb/usbdi_util.h> 5102ac6454SAndrew Thompson #include <dev/usb/usb_ioctl.h> 52963169b4SHans Petter Selasky 53963169b4SHans Petter Selasky #if USB_HAVE_UGEN 54963169b4SHans Petter Selasky #include <sys/sbuf.h> 55963169b4SHans Petter Selasky #endif 56963169b4SHans Petter Selasky 5702ac6454SAndrew Thompson #include "usbdevs.h" 5802ac6454SAndrew Thompson 59a593f6b8SAndrew Thompson #define USB_DEBUG_VAR usb_debug 6002ac6454SAndrew Thompson 6102ac6454SAndrew Thompson #include <dev/usb/usb_core.h> 6202ac6454SAndrew Thompson #include <dev/usb/usb_debug.h> 6302ac6454SAndrew Thompson #include <dev/usb/usb_process.h> 6402ac6454SAndrew Thompson #include <dev/usb/usb_device.h> 6502ac6454SAndrew Thompson #include <dev/usb/usb_busdma.h> 6602ac6454SAndrew Thompson #include <dev/usb/usb_transfer.h> 6702ac6454SAndrew Thompson #include <dev/usb/usb_request.h> 6802ac6454SAndrew Thompson #include <dev/usb/usb_dynamic.h> 6902ac6454SAndrew Thompson #include <dev/usb/usb_hub.h> 7002ac6454SAndrew Thompson #include <dev/usb/usb_util.h> 7102ac6454SAndrew Thompson #include <dev/usb/usb_msctest.h> 72bdc081c6SAndrew Thompson #if USB_HAVE_UGEN 73bdc081c6SAndrew Thompson #include <dev/usb/usb_dev.h> 7402ac6454SAndrew Thompson #include <dev/usb/usb_generic.h> 75bdc081c6SAndrew Thompson #endif 7602ac6454SAndrew Thompson 7702ac6454SAndrew Thompson #include <dev/usb/quirk/usb_quirk.h> 7802ac6454SAndrew Thompson 7902ac6454SAndrew Thompson #include <dev/usb/usb_controller.h> 8002ac6454SAndrew Thompson #include <dev/usb/usb_bus.h> 8102ac6454SAndrew Thompson 8202ac6454SAndrew Thompson /* function prototypes */ 8302ac6454SAndrew Thompson 84a593f6b8SAndrew Thompson static void usb_init_endpoint(struct usb_device *, uint8_t, 85963169b4SHans Petter Selasky struct usb_endpoint_descriptor *, 86963169b4SHans Petter Selasky struct usb_endpoint_ss_comp_descriptor *, 87963169b4SHans Petter Selasky struct usb_endpoint *); 88a593f6b8SAndrew Thompson static void usb_unconfigure(struct usb_device *, uint8_t); 89a593f6b8SAndrew Thompson static void usb_detach_device_sub(struct usb_device *, device_t *, 908427ed84SHans Petter Selasky char **, uint8_t); 91a593f6b8SAndrew Thompson static uint8_t usb_probe_and_attach_sub(struct usb_device *, 92760bc48eSAndrew Thompson struct usb_attach_arg *); 93a593f6b8SAndrew Thompson static void usb_init_attach_arg(struct usb_device *, 94760bc48eSAndrew Thompson struct usb_attach_arg *); 95a593f6b8SAndrew Thompson static void usb_suspend_resume_sub(struct usb_device *, device_t, 9602ac6454SAndrew Thompson uint8_t); 97a593f6b8SAndrew Thompson static void usbd_clear_stall_proc(struct usb_proc_msg *_pm); 98963169b4SHans Petter Selasky static usb_error_t usb_config_parse(struct usb_device *, uint8_t, uint8_t); 99a593f6b8SAndrew Thompson static void usbd_set_device_strings(struct usb_device *); 1008bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 101a593f6b8SAndrew Thompson static void usb_notify_addq(const char *type, struct usb_device *); 1028bb77249SHans Petter Selasky #endif 1038bb77249SHans Petter Selasky #if USB_HAVE_UGEN 104a593f6b8SAndrew Thompson static void usb_fifo_free_wrap(struct usb_device *, uint8_t, uint8_t); 105a593f6b8SAndrew Thompson static void usb_cdev_create(struct usb_device *); 106a593f6b8SAndrew Thompson static void usb_cdev_free(struct usb_device *); 1070f6e8f93SAndrew Thompson #endif 10802ac6454SAndrew Thompson 10902ac6454SAndrew Thompson /* This variable is global to allow easy access to it: */ 11002ac6454SAndrew Thompson 111a593f6b8SAndrew Thompson int usb_template = 0; 11202ac6454SAndrew Thompson 1137a918edfSAndrew Thompson TUNABLE_INT("hw.usb.usb_template", &usb_template); 1149360ae40SAndrew Thompson SYSCTL_INT(_hw_usb, OID_AUTO, template, CTLFLAG_RW, 115a593f6b8SAndrew Thompson &usb_template, 0, "Selected USB device side template"); 11602ac6454SAndrew Thompson 1177a918edfSAndrew Thompson /* English is default language */ 1187a918edfSAndrew Thompson 1197a918edfSAndrew Thompson static int usb_lang_id = 0x0009; 1207a918edfSAndrew Thompson static int usb_lang_mask = 0x00FF; 1217a918edfSAndrew Thompson 1227a918edfSAndrew Thompson TUNABLE_INT("hw.usb.usb_lang_id", &usb_lang_id); 1237a918edfSAndrew Thompson SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_id, CTLFLAG_RW, 1247a918edfSAndrew Thompson &usb_lang_id, 0, "Preferred USB language ID"); 1257a918edfSAndrew Thompson 1267a918edfSAndrew Thompson TUNABLE_INT("hw.usb.usb_lang_mask", &usb_lang_mask); 1277a918edfSAndrew Thompson SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_mask, CTLFLAG_RW, 1287a918edfSAndrew Thompson &usb_lang_mask, 0, "Preferred USB language mask"); 1297a918edfSAndrew Thompson 1304d4fa6edSAndrew Thompson static const char* statestr[USB_STATE_MAX] = { 1314d4fa6edSAndrew Thompson [USB_STATE_DETACHED] = "DETACHED", 1324d4fa6edSAndrew Thompson [USB_STATE_ATTACHED] = "ATTACHED", 1334d4fa6edSAndrew Thompson [USB_STATE_POWERED] = "POWERED", 1344d4fa6edSAndrew Thompson [USB_STATE_ADDRESSED] = "ADDRESSED", 1354d4fa6edSAndrew Thompson [USB_STATE_CONFIGURED] = "CONFIGURED", 1364d4fa6edSAndrew Thompson }; 1374d4fa6edSAndrew Thompson 1384d4fa6edSAndrew Thompson const char * 139a593f6b8SAndrew Thompson usb_statestr(enum usb_dev_state state) 1404d4fa6edSAndrew Thompson { 141ec8f3127SAndrew Thompson return ((state < USB_STATE_MAX) ? statestr[state] : "UNKNOWN"); 1424d4fa6edSAndrew Thompson } 14302ac6454SAndrew Thompson 144ae538d85SAndrew Thompson const char * 145ae538d85SAndrew Thompson usb_get_manufacturer(struct usb_device *udev) 146ae538d85SAndrew Thompson { 147ae538d85SAndrew Thompson return (udev->manufacturer ? udev->manufacturer : "Unknown"); 148ae538d85SAndrew Thompson } 149ae538d85SAndrew Thompson 150ae538d85SAndrew Thompson const char * 151ae538d85SAndrew Thompson usb_get_product(struct usb_device *udev) 152ae538d85SAndrew Thompson { 153ae538d85SAndrew Thompson return (udev->product ? udev->product : ""); 154ae538d85SAndrew Thompson } 155ae538d85SAndrew Thompson 156ae538d85SAndrew Thompson const char * 157ae538d85SAndrew Thompson usb_get_serial(struct usb_device *udev) 158ae538d85SAndrew Thompson { 159ae538d85SAndrew Thompson return (udev->serial ? udev->serial : ""); 160ae538d85SAndrew Thompson } 161ae538d85SAndrew Thompson 16202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 163a593f6b8SAndrew Thompson * usbd_get_ep_by_addr 16402ac6454SAndrew Thompson * 165ae60fdfbSAndrew Thompson * This function searches for an USB ep by endpoint address and 16602ac6454SAndrew Thompson * direction. 16702ac6454SAndrew Thompson * 16802ac6454SAndrew Thompson * Returns: 16902ac6454SAndrew Thompson * NULL: Failure 17002ac6454SAndrew Thompson * Else: Success 17102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 172ae60fdfbSAndrew Thompson struct usb_endpoint * 173a593f6b8SAndrew Thompson usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val) 17402ac6454SAndrew Thompson { 175ae60fdfbSAndrew Thompson struct usb_endpoint *ep = udev->endpoints; 176ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max; 17702ac6454SAndrew Thompson enum { 17802ac6454SAndrew Thompson EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR), 17902ac6454SAndrew Thompson }; 18002ac6454SAndrew Thompson 18102ac6454SAndrew Thompson /* 18202ac6454SAndrew Thompson * According to the USB specification not all bits are used 18302ac6454SAndrew Thompson * for the endpoint address. Keep defined bits only: 18402ac6454SAndrew Thompson */ 18502ac6454SAndrew Thompson ea_val &= EA_MASK; 18602ac6454SAndrew Thompson 18702ac6454SAndrew Thompson /* 188ae60fdfbSAndrew Thompson * Iterate accross all the USB endpoints searching for a match 18902ac6454SAndrew Thompson * based on the endpoint address: 19002ac6454SAndrew Thompson */ 191ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 19202ac6454SAndrew Thompson 193ae60fdfbSAndrew Thompson if (ep->edesc == NULL) { 19402ac6454SAndrew Thompson continue; 19502ac6454SAndrew Thompson } 19602ac6454SAndrew Thompson /* do the mask and check the value */ 197ae60fdfbSAndrew Thompson if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) { 19802ac6454SAndrew Thompson goto found; 19902ac6454SAndrew Thompson } 20002ac6454SAndrew Thompson } 20102ac6454SAndrew Thompson 20202ac6454SAndrew Thompson /* 203ae60fdfbSAndrew Thompson * The default endpoint is always present and is checked separately: 20402ac6454SAndrew Thompson */ 2055b3bb704SAndrew Thompson if ((udev->ctrl_ep.edesc) && 2065b3bb704SAndrew Thompson ((udev->ctrl_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) { 2075b3bb704SAndrew Thompson ep = &udev->ctrl_ep; 20802ac6454SAndrew Thompson goto found; 20902ac6454SAndrew Thompson } 21002ac6454SAndrew Thompson return (NULL); 21102ac6454SAndrew Thompson 21202ac6454SAndrew Thompson found: 213ae60fdfbSAndrew Thompson return (ep); 21402ac6454SAndrew Thompson } 21502ac6454SAndrew Thompson 21602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 217a593f6b8SAndrew Thompson * usbd_get_endpoint 21802ac6454SAndrew Thompson * 219ae60fdfbSAndrew Thompson * This function searches for an USB endpoint based on the information 220760bc48eSAndrew Thompson * given by the passed "struct usb_config" pointer. 22102ac6454SAndrew Thompson * 22202ac6454SAndrew Thompson * Return values: 22302ac6454SAndrew Thompson * NULL: No match. 224ae60fdfbSAndrew Thompson * Else: Pointer to "struct usb_endpoint". 22502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 226ae60fdfbSAndrew Thompson struct usb_endpoint * 227a593f6b8SAndrew Thompson usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index, 228760bc48eSAndrew Thompson const struct usb_config *setup) 22902ac6454SAndrew Thompson { 230ae60fdfbSAndrew Thompson struct usb_endpoint *ep = udev->endpoints; 231ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max; 23202ac6454SAndrew Thompson uint8_t index = setup->ep_index; 23302ac6454SAndrew Thompson uint8_t ea_mask; 23402ac6454SAndrew Thompson uint8_t ea_val; 23502ac6454SAndrew Thompson uint8_t type_mask; 23602ac6454SAndrew Thompson uint8_t type_val; 23702ac6454SAndrew Thompson 23802ac6454SAndrew Thompson DPRINTFN(10, "udev=%p iface_index=%d address=0x%x " 23902ac6454SAndrew Thompson "type=0x%x dir=0x%x index=%d\n", 24002ac6454SAndrew Thompson udev, iface_index, setup->endpoint, 24102ac6454SAndrew Thompson setup->type, setup->direction, setup->ep_index); 24202ac6454SAndrew Thompson 2434eae601eSAndrew Thompson /* check USB mode */ 2444eae601eSAndrew Thompson 245f29a0724SAndrew Thompson if (setup->usb_mode != USB_MODE_DUAL && 246f29a0724SAndrew Thompson udev->flags.usb_mode != setup->usb_mode) { 247ae60fdfbSAndrew Thompson /* wrong mode - no endpoint */ 2484eae601eSAndrew Thompson return (NULL); 2494eae601eSAndrew Thompson } 2504eae601eSAndrew Thompson 25102ac6454SAndrew Thompson /* setup expected endpoint direction mask and value */ 25202ac6454SAndrew Thompson 25351ec1603SAndrew Thompson if (setup->direction == UE_DIR_RX) { 25451ec1603SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 255f29a0724SAndrew Thompson ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ? 25651ec1603SAndrew Thompson UE_DIR_OUT : UE_DIR_IN; 25751ec1603SAndrew Thompson } else if (setup->direction == UE_DIR_TX) { 25851ec1603SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 259f29a0724SAndrew Thompson ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ? 26051ec1603SAndrew Thompson UE_DIR_IN : UE_DIR_OUT; 26151ec1603SAndrew Thompson } else if (setup->direction == UE_DIR_ANY) { 26202ac6454SAndrew Thompson /* match any endpoint direction */ 26302ac6454SAndrew Thompson ea_mask = 0; 26402ac6454SAndrew Thompson ea_val = 0; 26502ac6454SAndrew Thompson } else { 26602ac6454SAndrew Thompson /* match the given endpoint direction */ 26702ac6454SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 26802ac6454SAndrew Thompson ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT)); 26902ac6454SAndrew Thompson } 27002ac6454SAndrew Thompson 27102ac6454SAndrew Thompson /* setup expected endpoint address */ 27202ac6454SAndrew Thompson 27302ac6454SAndrew Thompson if (setup->endpoint == UE_ADDR_ANY) { 27402ac6454SAndrew Thompson /* match any endpoint address */ 27502ac6454SAndrew Thompson } else { 27602ac6454SAndrew Thompson /* match the given endpoint address */ 27702ac6454SAndrew Thompson ea_mask |= UE_ADDR; 27802ac6454SAndrew Thompson ea_val |= (setup->endpoint & UE_ADDR); 27902ac6454SAndrew Thompson } 28002ac6454SAndrew Thompson 28102ac6454SAndrew Thompson /* setup expected endpoint type */ 28202ac6454SAndrew Thompson 28302ac6454SAndrew Thompson if (setup->type == UE_BULK_INTR) { 28402ac6454SAndrew Thompson /* this will match BULK and INTERRUPT endpoints */ 28502ac6454SAndrew Thompson type_mask = 2; 28602ac6454SAndrew Thompson type_val = 2; 28702ac6454SAndrew Thompson } else if (setup->type == UE_TYPE_ANY) { 28802ac6454SAndrew Thompson /* match any endpoint type */ 28902ac6454SAndrew Thompson type_mask = 0; 29002ac6454SAndrew Thompson type_val = 0; 29102ac6454SAndrew Thompson } else { 29202ac6454SAndrew Thompson /* match the given endpoint type */ 29302ac6454SAndrew Thompson type_mask = UE_XFERTYPE; 29402ac6454SAndrew Thompson type_val = (setup->type & UE_XFERTYPE); 29502ac6454SAndrew Thompson } 29602ac6454SAndrew Thompson 29702ac6454SAndrew Thompson /* 298ae60fdfbSAndrew Thompson * Iterate accross all the USB endpoints searching for a match 29902ac6454SAndrew Thompson * based on the endpoint address. Note that we are searching 300ae60fdfbSAndrew Thompson * the endpoints from the beginning of the "udev->endpoints" array. 30102ac6454SAndrew Thompson */ 302ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 30302ac6454SAndrew Thompson 304ae60fdfbSAndrew Thompson if ((ep->edesc == NULL) || 305ae60fdfbSAndrew Thompson (ep->iface_index != iface_index)) { 30602ac6454SAndrew Thompson continue; 30702ac6454SAndrew Thompson } 30802ac6454SAndrew Thompson /* do the masks and check the values */ 30902ac6454SAndrew Thompson 310ae60fdfbSAndrew Thompson if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) && 311ae60fdfbSAndrew Thompson ((ep->edesc->bmAttributes & type_mask) == type_val)) { 31202ac6454SAndrew Thompson if (!index--) { 31302ac6454SAndrew Thompson goto found; 31402ac6454SAndrew Thompson } 31502ac6454SAndrew Thompson } 31602ac6454SAndrew Thompson } 31702ac6454SAndrew Thompson 31802ac6454SAndrew Thompson /* 319ae60fdfbSAndrew Thompson * Match against default endpoint last, so that "any endpoint", "any 320ae60fdfbSAndrew Thompson * address" and "any direction" returns the first endpoint of the 32102ac6454SAndrew Thompson * interface. "iface_index" and "direction" is ignored: 32202ac6454SAndrew Thompson */ 3235b3bb704SAndrew Thompson if ((udev->ctrl_ep.edesc) && 3245b3bb704SAndrew Thompson ((udev->ctrl_ep.edesc->bEndpointAddress & ea_mask) == ea_val) && 3255b3bb704SAndrew Thompson ((udev->ctrl_ep.edesc->bmAttributes & type_mask) == type_val) && 32602ac6454SAndrew Thompson (!index)) { 3275b3bb704SAndrew Thompson ep = &udev->ctrl_ep; 32802ac6454SAndrew Thompson goto found; 32902ac6454SAndrew Thompson } 33002ac6454SAndrew Thompson return (NULL); 33102ac6454SAndrew Thompson 33202ac6454SAndrew Thompson found: 333ae60fdfbSAndrew Thompson return (ep); 33402ac6454SAndrew Thompson } 33502ac6454SAndrew Thompson 33602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 337ed6d949aSAndrew Thompson * usbd_interface_count 33802ac6454SAndrew Thompson * 33902ac6454SAndrew Thompson * This function stores the number of USB interfaces excluding 34002ac6454SAndrew Thompson * alternate settings, which the USB config descriptor reports into 34102ac6454SAndrew Thompson * the unsigned 8-bit integer pointed to by "count". 34202ac6454SAndrew Thompson * 34302ac6454SAndrew Thompson * Returns: 34402ac6454SAndrew Thompson * 0: Success 34502ac6454SAndrew Thompson * Else: Failure 34602ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 347e0a69b51SAndrew Thompson usb_error_t 348ed6d949aSAndrew Thompson usbd_interface_count(struct usb_device *udev, uint8_t *count) 34902ac6454SAndrew Thompson { 35002ac6454SAndrew Thompson if (udev->cdesc == NULL) { 35102ac6454SAndrew Thompson *count = 0; 35202ac6454SAndrew Thompson return (USB_ERR_NOT_CONFIGURED); 35302ac6454SAndrew Thompson } 354bdd41206SAndrew Thompson *count = udev->ifaces_max; 35502ac6454SAndrew Thompson return (USB_ERR_NORMAL_COMPLETION); 35602ac6454SAndrew Thompson } 35702ac6454SAndrew Thompson 35802ac6454SAndrew Thompson 35902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 360a593f6b8SAndrew Thompson * usb_init_endpoint 36102ac6454SAndrew Thompson * 362ae60fdfbSAndrew Thompson * This function will initialise the USB endpoint structure pointed to by 363ae60fdfbSAndrew Thompson * the "endpoint" argument. The structure pointed to by "endpoint" must be 364bdd41206SAndrew Thompson * zeroed before calling this function. 36502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 36602ac6454SAndrew Thompson static void 367a593f6b8SAndrew Thompson usb_init_endpoint(struct usb_device *udev, uint8_t iface_index, 368963169b4SHans Petter Selasky struct usb_endpoint_descriptor *edesc, 369963169b4SHans Petter Selasky struct usb_endpoint_ss_comp_descriptor *ecomp, 370963169b4SHans Petter Selasky struct usb_endpoint *ep) 37102ac6454SAndrew Thompson { 372760bc48eSAndrew Thompson struct usb_bus_methods *methods; 373ee3e3ff5SAndrew Thompson 374bdd41206SAndrew Thompson methods = udev->bus->methods; 37502ac6454SAndrew Thompson 376ae60fdfbSAndrew Thompson (methods->endpoint_init) (udev, edesc, ep); 37702ac6454SAndrew Thompson 378ae60fdfbSAndrew Thompson /* initialise USB endpoint structure */ 379ae60fdfbSAndrew Thompson ep->edesc = edesc; 380963169b4SHans Petter Selasky ep->ecomp = ecomp; 381ae60fdfbSAndrew Thompson ep->iface_index = iface_index; 382ae60fdfbSAndrew Thompson TAILQ_INIT(&ep->endpoint_q.head); 383a593f6b8SAndrew Thompson ep->endpoint_q.command = &usbd_pipe_start; 38402ac6454SAndrew Thompson 38539307315SAndrew Thompson /* the pipe is not supported by the hardware */ 386ae60fdfbSAndrew Thompson if (ep->methods == NULL) 38739307315SAndrew Thompson return; 38839307315SAndrew Thompson 38902ac6454SAndrew Thompson /* clear stall, if any */ 390bdd41206SAndrew Thompson if (methods->clear_stall != NULL) { 39102ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 392ae60fdfbSAndrew Thompson (methods->clear_stall) (udev, ep); 39302ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 39402ac6454SAndrew Thompson } 39502ac6454SAndrew Thompson } 39602ac6454SAndrew Thompson 397bdd41206SAndrew Thompson /*-----------------------------------------------------------------------* 398a593f6b8SAndrew Thompson * usb_endpoint_foreach 39916589beaSAndrew Thompson * 40016589beaSAndrew Thompson * This function will iterate all the USB endpoints except the control 40116589beaSAndrew Thompson * endpoint. This function is NULL safe. 40216589beaSAndrew Thompson * 40316589beaSAndrew Thompson * Return values: 404ae60fdfbSAndrew Thompson * NULL: End of USB endpoints 405ae60fdfbSAndrew Thompson * Else: Pointer to next USB endpoint 40616589beaSAndrew Thompson *------------------------------------------------------------------------*/ 407ae60fdfbSAndrew Thompson struct usb_endpoint * 408a593f6b8SAndrew Thompson usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep) 40916589beaSAndrew Thompson { 410a9e26757SAndrew Thompson struct usb_endpoint *ep_end; 41116589beaSAndrew Thompson 41216589beaSAndrew Thompson /* be NULL safe */ 41316589beaSAndrew Thompson if (udev == NULL) 41416589beaSAndrew Thompson return (NULL); 41516589beaSAndrew Thompson 416a9e26757SAndrew Thompson ep_end = udev->endpoints + udev->endpoints_max; 417a9e26757SAndrew Thompson 418ae60fdfbSAndrew Thompson /* get next endpoint */ 419ae60fdfbSAndrew Thompson if (ep == NULL) 420ae60fdfbSAndrew Thompson ep = udev->endpoints; 42116589beaSAndrew Thompson else 422ae60fdfbSAndrew Thompson ep++; 42316589beaSAndrew Thompson 424ae60fdfbSAndrew Thompson /* find next allocated ep */ 425ae60fdfbSAndrew Thompson while (ep != ep_end) { 426ae60fdfbSAndrew Thompson if (ep->edesc != NULL) 427ae60fdfbSAndrew Thompson return (ep); 428ae60fdfbSAndrew Thompson ep++; 42916589beaSAndrew Thompson } 43016589beaSAndrew Thompson return (NULL); 43116589beaSAndrew Thompson } 43216589beaSAndrew Thompson 43316589beaSAndrew Thompson /*------------------------------------------------------------------------* 434a593f6b8SAndrew Thompson * usb_unconfigure 43502ac6454SAndrew Thompson * 436ae60fdfbSAndrew Thompson * This function will free all USB interfaces and USB endpoints belonging 43702ac6454SAndrew Thompson * to an USB device. 438bdd41206SAndrew Thompson * 439bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 44002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 44102ac6454SAndrew Thompson static void 442a593f6b8SAndrew Thompson usb_unconfigure(struct usb_device *udev, uint8_t flag) 44302ac6454SAndrew Thompson { 444bdd41206SAndrew Thompson uint8_t do_unlock; 44502ac6454SAndrew Thompson 446bdd41206SAndrew Thompson /* automatic locking */ 447cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 448bdd41206SAndrew Thompson do_unlock = 0; 449bdd41206SAndrew Thompson } else { 450bdd41206SAndrew Thompson do_unlock = 1; 451cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 452bdd41206SAndrew Thompson } 453bdd41206SAndrew Thompson 454bdd41206SAndrew Thompson /* detach all interface drivers */ 455a593f6b8SAndrew Thompson usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag); 456bdd41206SAndrew Thompson 457bdd41206SAndrew Thompson #if USB_HAVE_UGEN 458bdd41206SAndrew Thompson /* free all FIFOs except control endpoint FIFOs */ 459a593f6b8SAndrew Thompson usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag); 460bdd41206SAndrew Thompson 461bdd41206SAndrew Thompson /* 462bdd41206SAndrew Thompson * Free all cdev's, if any. 463bdd41206SAndrew Thompson */ 464a593f6b8SAndrew Thompson usb_cdev_free(udev); 465bdd41206SAndrew Thompson #endif 46602ac6454SAndrew Thompson 467bdc081c6SAndrew Thompson #if USB_HAVE_COMPAT_LINUX 46802ac6454SAndrew Thompson /* free Linux compat device, if any */ 469760bc48eSAndrew Thompson if (udev->linux_endpoint_start) { 470760bc48eSAndrew Thompson usb_linux_free_device(udev); 471760bc48eSAndrew Thompson udev->linux_endpoint_start = NULL; 47202ac6454SAndrew Thompson } 473bdc081c6SAndrew Thompson #endif 47402ac6454SAndrew Thompson 475a593f6b8SAndrew Thompson usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE); 47602ac6454SAndrew Thompson 477ae60fdfbSAndrew Thompson /* free "cdesc" after "ifaces" and "endpoints", if any */ 4787efaaa9aSAndrew Thompson if (udev->cdesc != NULL) { 479f29a0724SAndrew Thompson if (udev->flags.usb_mode != USB_MODE_DEVICE) 48002ac6454SAndrew Thompson free(udev->cdesc, M_USB); 48102ac6454SAndrew Thompson udev->cdesc = NULL; 48202ac6454SAndrew Thompson } 48302ac6454SAndrew Thompson /* set unconfigured state */ 48402ac6454SAndrew Thompson udev->curr_config_no = USB_UNCONFIG_NO; 48502ac6454SAndrew Thompson udev->curr_config_index = USB_UNCONFIG_INDEX; 486bdd41206SAndrew Thompson 487cb18f7d1SAlfred Perlstein if (do_unlock) 488cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 48902ac6454SAndrew Thompson } 49002ac6454SAndrew Thompson 49102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 492a593f6b8SAndrew Thompson * usbd_set_config_index 49302ac6454SAndrew Thompson * 49402ac6454SAndrew Thompson * This function selects configuration by index, independent of the 49502ac6454SAndrew Thompson * actual configuration number. This function should not be used by 49602ac6454SAndrew Thompson * USB drivers. 49702ac6454SAndrew Thompson * 49802ac6454SAndrew Thompson * Returns: 49902ac6454SAndrew Thompson * 0: Success 50002ac6454SAndrew Thompson * Else: Failure 50102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 502e0a69b51SAndrew Thompson usb_error_t 503a593f6b8SAndrew Thompson usbd_set_config_index(struct usb_device *udev, uint8_t index) 50402ac6454SAndrew Thompson { 505760bc48eSAndrew Thompson struct usb_status ds; 506760bc48eSAndrew Thompson struct usb_config_descriptor *cdp; 50702ac6454SAndrew Thompson uint16_t power; 50802ac6454SAndrew Thompson uint16_t max_power; 50902ac6454SAndrew Thompson uint8_t selfpowered; 51002ac6454SAndrew Thompson uint8_t do_unlock; 511e0a69b51SAndrew Thompson usb_error_t err; 51202ac6454SAndrew Thompson 51302ac6454SAndrew Thompson DPRINTFN(6, "udev=%p index=%d\n", udev, index); 51402ac6454SAndrew Thompson 51502ac6454SAndrew Thompson /* automatic locking */ 516cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 51702ac6454SAndrew Thompson do_unlock = 0; 51802ac6454SAndrew Thompson } else { 51902ac6454SAndrew Thompson do_unlock = 1; 520cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 52102ac6454SAndrew Thompson } 52202ac6454SAndrew Thompson 523d88688c7SAndrew Thompson usb_unconfigure(udev, 0); 52402ac6454SAndrew Thompson 52502ac6454SAndrew Thompson if (index == USB_UNCONFIG_INDEX) { 52602ac6454SAndrew Thompson /* 52702ac6454SAndrew Thompson * Leave unallocated when unconfiguring the 528a593f6b8SAndrew Thompson * device. "usb_unconfigure()" will also reset 52902ac6454SAndrew Thompson * the current config number and index. 53002ac6454SAndrew Thompson */ 531a593f6b8SAndrew Thompson err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO); 532bd216778SAndrew Thompson if (udev->state == USB_STATE_CONFIGURED) 533a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_ADDRESSED); 53402ac6454SAndrew Thompson goto done; 53502ac6454SAndrew Thompson } 53602ac6454SAndrew Thompson /* get the full config descriptor */ 537f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 5387efaaa9aSAndrew Thompson /* save some memory */ 539a593f6b8SAndrew Thompson err = usbd_req_get_descriptor_ptr(udev, &cdp, 540459d369eSAndrew Thompson (UDESC_CONFIG << 8) | index); 5417efaaa9aSAndrew Thompson } else { 5427efaaa9aSAndrew Thompson /* normal request */ 543a593f6b8SAndrew Thompson err = usbd_req_get_config_desc_full(udev, 544e2805033SAndrew Thompson NULL, &cdp, M_USB, index); 5457efaaa9aSAndrew Thompson } 54602ac6454SAndrew Thompson if (err) { 54702ac6454SAndrew Thompson goto done; 54802ac6454SAndrew Thompson } 54902ac6454SAndrew Thompson /* set the new config descriptor */ 55002ac6454SAndrew Thompson 55102ac6454SAndrew Thompson udev->cdesc = cdp; 55202ac6454SAndrew Thompson 55302ac6454SAndrew Thompson /* Figure out if the device is self or bus powered. */ 55402ac6454SAndrew Thompson selfpowered = 0; 55502ac6454SAndrew Thompson if ((!udev->flags.uq_bus_powered) && 55602ac6454SAndrew Thompson (cdp->bmAttributes & UC_SELF_POWERED) && 557f29a0724SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST)) { 55802ac6454SAndrew Thompson /* May be self powered. */ 55902ac6454SAndrew Thompson if (cdp->bmAttributes & UC_BUS_POWERED) { 56002ac6454SAndrew Thompson /* Must ask device. */ 561a593f6b8SAndrew Thompson err = usbd_req_get_device_status(udev, NULL, &ds); 56202ac6454SAndrew Thompson if (err) { 56302ac6454SAndrew Thompson DPRINTFN(0, "could not read " 56402ac6454SAndrew Thompson "device status: %s\n", 565a593f6b8SAndrew Thompson usbd_errstr(err)); 56602ac6454SAndrew Thompson } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) { 56702ac6454SAndrew Thompson selfpowered = 1; 56802ac6454SAndrew Thompson } 56902ac6454SAndrew Thompson DPRINTF("status=0x%04x \n", 57002ac6454SAndrew Thompson UGETW(ds.wStatus)); 57102ac6454SAndrew Thompson } else 57202ac6454SAndrew Thompson selfpowered = 1; 57302ac6454SAndrew Thompson } 57402ac6454SAndrew Thompson DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, " 57502ac6454SAndrew Thompson "selfpowered=%d, power=%d\n", 57602ac6454SAndrew Thompson udev, cdp, 57791f72cedSAndrew Thompson udev->address, cdp->bConfigurationValue, cdp->bmAttributes, 57802ac6454SAndrew Thompson selfpowered, cdp->bMaxPower * 2); 57902ac6454SAndrew Thompson 58002ac6454SAndrew Thompson /* Check if we have enough power. */ 58102ac6454SAndrew Thompson power = cdp->bMaxPower * 2; 58202ac6454SAndrew Thompson 58302ac6454SAndrew Thompson if (udev->parent_hub) { 58402ac6454SAndrew Thompson max_power = udev->parent_hub->hub->portpower; 58502ac6454SAndrew Thompson } else { 58602ac6454SAndrew Thompson max_power = USB_MAX_POWER; 58702ac6454SAndrew Thompson } 58802ac6454SAndrew Thompson 58902ac6454SAndrew Thompson if (power > max_power) { 59002ac6454SAndrew Thompson DPRINTFN(0, "power exceeded %d > %d\n", power, max_power); 59102ac6454SAndrew Thompson err = USB_ERR_NO_POWER; 59202ac6454SAndrew Thompson goto done; 59302ac6454SAndrew Thompson } 59402ac6454SAndrew Thompson /* Only update "self_powered" in USB Host Mode */ 595f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_HOST) { 59602ac6454SAndrew Thompson udev->flags.self_powered = selfpowered; 59702ac6454SAndrew Thompson } 59802ac6454SAndrew Thompson udev->power = power; 59902ac6454SAndrew Thompson udev->curr_config_no = cdp->bConfigurationValue; 60002ac6454SAndrew Thompson udev->curr_config_index = index; 601a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_CONFIGURED); 60202ac6454SAndrew Thompson 60302ac6454SAndrew Thompson /* Set the actual configuration value. */ 604a593f6b8SAndrew Thompson err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue); 60502ac6454SAndrew Thompson if (err) { 60602ac6454SAndrew Thompson goto done; 60702ac6454SAndrew Thompson } 608bdd41206SAndrew Thompson 609a593f6b8SAndrew Thompson err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC); 61002ac6454SAndrew Thompson if (err) { 61102ac6454SAndrew Thompson goto done; 61202ac6454SAndrew Thompson } 613bdd41206SAndrew Thompson 614a593f6b8SAndrew Thompson err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT); 615bdd41206SAndrew Thompson if (err) { 616bdd41206SAndrew Thompson goto done; 61702ac6454SAndrew Thompson } 618bdd41206SAndrew Thompson 6190f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 620ee3e3ff5SAndrew Thompson /* create device nodes for each endpoint */ 621a593f6b8SAndrew Thompson usb_cdev_create(udev); 6220f6e8f93SAndrew Thompson #endif 62302ac6454SAndrew Thompson 62402ac6454SAndrew Thompson done: 625a593f6b8SAndrew Thompson DPRINTF("error=%s\n", usbd_errstr(err)); 62602ac6454SAndrew Thompson if (err) { 627d88688c7SAndrew Thompson usb_unconfigure(udev, 0); 62802ac6454SAndrew Thompson } 629cb18f7d1SAlfred Perlstein if (do_unlock) 630cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 63102ac6454SAndrew Thompson return (err); 63202ac6454SAndrew Thompson } 63302ac6454SAndrew Thompson 63402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 635a593f6b8SAndrew Thompson * usb_config_parse 636bdd41206SAndrew Thompson * 637ae60fdfbSAndrew Thompson * This function will allocate and free USB interfaces and USB endpoints, 638ae60fdfbSAndrew Thompson * parse the USB configuration structure and initialise the USB endpoints 639bdd41206SAndrew Thompson * and interfaces. If "iface_index" is not equal to 640bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the 641bdd41206SAndrew Thompson * alternate_setting to be selected for the given interface. Else the 642bdd41206SAndrew Thompson * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be 643bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function 644bdd41206SAndrew Thompson * is typically called when setting the configuration or when setting 645bdd41206SAndrew Thompson * an alternate interface. 646bdd41206SAndrew Thompson * 647bdd41206SAndrew Thompson * Returns: 648bdd41206SAndrew Thompson * 0: Success 649bdd41206SAndrew Thompson * Else: Failure 650bdd41206SAndrew Thompson *------------------------------------------------------------------------*/ 651963169b4SHans Petter Selasky static usb_error_t 652a593f6b8SAndrew Thompson usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd) 653bdd41206SAndrew Thompson { 654760bc48eSAndrew Thompson struct usb_idesc_parse_state ips; 655760bc48eSAndrew Thompson struct usb_interface_descriptor *id; 656760bc48eSAndrew Thompson struct usb_endpoint_descriptor *ed; 657760bc48eSAndrew Thompson struct usb_interface *iface; 658ae60fdfbSAndrew Thompson struct usb_endpoint *ep; 659e0a69b51SAndrew Thompson usb_error_t err; 660bdd41206SAndrew Thompson uint8_t ep_curr; 661bdd41206SAndrew Thompson uint8_t ep_max; 662bdd41206SAndrew Thompson uint8_t temp; 663bdd41206SAndrew Thompson uint8_t do_init; 664bdd41206SAndrew Thompson uint8_t alt_index; 665bdd41206SAndrew Thompson 666bdd41206SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 667bdd41206SAndrew Thompson /* parameter overload */ 668bdd41206SAndrew Thompson alt_index = cmd; 669bdd41206SAndrew Thompson cmd = USB_CFG_INIT; 670bdd41206SAndrew Thompson } else { 671bdd41206SAndrew Thompson /* not used */ 672bdd41206SAndrew Thompson alt_index = 0; 673bdd41206SAndrew Thompson } 674bdd41206SAndrew Thompson 675bdd41206SAndrew Thompson err = 0; 676bdd41206SAndrew Thompson 677bdd41206SAndrew Thompson DPRINTFN(5, "iface_index=%d cmd=%d\n", 678bdd41206SAndrew Thompson iface_index, cmd); 679bdd41206SAndrew Thompson 680bdd41206SAndrew Thompson if (cmd == USB_CFG_FREE) 681bdd41206SAndrew Thompson goto cleanup; 682bdd41206SAndrew Thompson 683bdd41206SAndrew Thompson if (cmd == USB_CFG_INIT) { 68491cd9240SAndrew Thompson sx_assert(&udev->enum_sx, SA_LOCKED); 685bdd41206SAndrew Thompson 686ae60fdfbSAndrew Thompson /* check for in-use endpoints */ 687bdd41206SAndrew Thompson 688ae60fdfbSAndrew Thompson ep = udev->endpoints; 689ae60fdfbSAndrew Thompson ep_max = udev->endpoints_max; 690bdd41206SAndrew Thompson while (ep_max--) { 691ae60fdfbSAndrew Thompson /* look for matching endpoints */ 692bdd41206SAndrew Thompson if ((iface_index == USB_IFACE_INDEX_ANY) || 693ae60fdfbSAndrew Thompson (iface_index == ep->iface_index)) { 694f12c6c29SAndrew Thompson if (ep->refcount_alloc != 0) { 695bdd41206SAndrew Thompson /* 696bdd41206SAndrew Thompson * This typically indicates a 697bdd41206SAndrew Thompson * more serious error. 698bdd41206SAndrew Thompson */ 699bdd41206SAndrew Thompson err = USB_ERR_IN_USE; 700bdd41206SAndrew Thompson } else { 701ae60fdfbSAndrew Thompson /* reset endpoint */ 702ae60fdfbSAndrew Thompson memset(ep, 0, sizeof(*ep)); 703ae60fdfbSAndrew Thompson /* make sure we don't zero the endpoint again */ 704ae60fdfbSAndrew Thompson ep->iface_index = USB_IFACE_INDEX_ANY; 705bdd41206SAndrew Thompson } 706bdd41206SAndrew Thompson } 707ae60fdfbSAndrew Thompson ep++; 708bdd41206SAndrew Thompson } 709bdd41206SAndrew Thompson 710bdd41206SAndrew Thompson if (err) 711bdd41206SAndrew Thompson return (err); 712bdd41206SAndrew Thompson } 713bdd41206SAndrew Thompson 714bdd41206SAndrew Thompson memset(&ips, 0, sizeof(ips)); 715bdd41206SAndrew Thompson 716bdd41206SAndrew Thompson ep_curr = 0; 717bdd41206SAndrew Thompson ep_max = 0; 718bdd41206SAndrew Thompson 719a593f6b8SAndrew Thompson while ((id = usb_idesc_foreach(udev->cdesc, &ips))) { 720bdd41206SAndrew Thompson 721bdd41206SAndrew Thompson /* check for interface overflow */ 722bdd41206SAndrew Thompson if (ips.iface_index == USB_IFACE_MAX) 723bdd41206SAndrew Thompson break; /* crazy */ 724bdd41206SAndrew Thompson 725bdd41206SAndrew Thompson iface = udev->ifaces + ips.iface_index; 726bdd41206SAndrew Thompson 727bdd41206SAndrew Thompson /* check for specific interface match */ 728bdd41206SAndrew Thompson 729bdd41206SAndrew Thompson if (cmd == USB_CFG_INIT) { 730bdd41206SAndrew Thompson if ((iface_index != USB_IFACE_INDEX_ANY) && 731bdd41206SAndrew Thompson (iface_index != ips.iface_index)) { 732bdd41206SAndrew Thompson /* wrong interface */ 733bdd41206SAndrew Thompson do_init = 0; 734bdd41206SAndrew Thompson } else if (alt_index != ips.iface_index_alt) { 735bdd41206SAndrew Thompson /* wrong alternate setting */ 736bdd41206SAndrew Thompson do_init = 0; 737bdd41206SAndrew Thompson } else { 738bdd41206SAndrew Thompson /* initialise interface */ 739bdd41206SAndrew Thompson do_init = 1; 740bdd41206SAndrew Thompson } 741bdd41206SAndrew Thompson } else 742bdd41206SAndrew Thompson do_init = 0; 743bdd41206SAndrew Thompson 744bdd41206SAndrew Thompson /* check for new interface */ 745bdd41206SAndrew Thompson if (ips.iface_index_alt == 0) { 746bdd41206SAndrew Thompson /* update current number of endpoints */ 747bdd41206SAndrew Thompson ep_curr = ep_max; 748bdd41206SAndrew Thompson } 749bdd41206SAndrew Thompson /* check for init */ 750bdd41206SAndrew Thompson if (do_init) { 751bdd41206SAndrew Thompson /* setup the USB interface structure */ 752bdd41206SAndrew Thompson iface->idesc = id; 753bdd41206SAndrew Thompson /* default setting */ 754bdd41206SAndrew Thompson iface->parent_iface_index = USB_IFACE_INDEX_ANY; 755bdd41206SAndrew Thompson /* set alternate index */ 756bdd41206SAndrew Thompson iface->alt_index = alt_index; 757bdd41206SAndrew Thompson } 758bdd41206SAndrew Thompson 759bdd41206SAndrew Thompson DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints); 760bdd41206SAndrew Thompson 761760bc48eSAndrew Thompson ed = (struct usb_endpoint_descriptor *)id; 762bdd41206SAndrew Thompson 763bdd41206SAndrew Thompson temp = ep_curr; 764bdd41206SAndrew Thompson 765bdd41206SAndrew Thompson /* iterate all the endpoint descriptors */ 766a593f6b8SAndrew Thompson while ((ed = usb_edesc_foreach(udev->cdesc, ed))) { 767bdd41206SAndrew Thompson 768bdd41206SAndrew Thompson if (temp == USB_EP_MAX) 769bdd41206SAndrew Thompson break; /* crazy */ 770bdd41206SAndrew Thompson 771ae60fdfbSAndrew Thompson ep = udev->endpoints + temp; 772bdd41206SAndrew Thompson 773bdd41206SAndrew Thompson if (do_init) { 774963169b4SHans Petter Selasky void *ecomp; 775963169b4SHans Petter Selasky 776963169b4SHans Petter Selasky ecomp = usb_ed_comp_foreach(udev->cdesc, (void *)ed); 777963169b4SHans Petter Selasky if (ecomp != NULL) 778963169b4SHans Petter Selasky DPRINTFN(5, "Found endpoint companion descriptor\n"); 779963169b4SHans Petter Selasky 780a593f6b8SAndrew Thompson usb_init_endpoint(udev, 781963169b4SHans Petter Selasky ips.iface_index, ed, ecomp, ep); 782bdd41206SAndrew Thompson } 783bdd41206SAndrew Thompson 784bdd41206SAndrew Thompson temp ++; 785bdd41206SAndrew Thompson 786bdd41206SAndrew Thompson /* find maximum number of endpoints */ 787bdd41206SAndrew Thompson if (ep_max < temp) 788bdd41206SAndrew Thompson ep_max = temp; 789bdd41206SAndrew Thompson 790bdd41206SAndrew Thompson /* optimalisation */ 791760bc48eSAndrew Thompson id = (struct usb_interface_descriptor *)ed; 792bdd41206SAndrew Thompson } 793bdd41206SAndrew Thompson } 794bdd41206SAndrew Thompson 795bdd41206SAndrew Thompson /* NOTE: It is valid to have no interfaces and no endpoints! */ 796bdd41206SAndrew Thompson 797bdd41206SAndrew Thompson if (cmd == USB_CFG_ALLOC) { 798bdd41206SAndrew Thompson udev->ifaces_max = ips.iface_index; 799bdd41206SAndrew Thompson udev->ifaces = NULL; 800bdd41206SAndrew Thompson if (udev->ifaces_max != 0) { 801bdd41206SAndrew Thompson udev->ifaces = malloc(sizeof(*iface) * udev->ifaces_max, 802bdd41206SAndrew Thompson M_USB, M_WAITOK | M_ZERO); 803bdd41206SAndrew Thompson if (udev->ifaces == NULL) { 804bdd41206SAndrew Thompson err = USB_ERR_NOMEM; 805bdd41206SAndrew Thompson goto done; 806bdd41206SAndrew Thompson } 807bdd41206SAndrew Thompson } 8089469c929SAndrew Thompson if (ep_max != 0) { 809ae60fdfbSAndrew Thompson udev->endpoints = malloc(sizeof(*ep) * ep_max, 810bdd41206SAndrew Thompson M_USB, M_WAITOK | M_ZERO); 811ae60fdfbSAndrew Thompson if (udev->endpoints == NULL) { 812bdd41206SAndrew Thompson err = USB_ERR_NOMEM; 813bdd41206SAndrew Thompson goto done; 814bdd41206SAndrew Thompson } 8159469c929SAndrew Thompson } else { 816ae60fdfbSAndrew Thompson udev->endpoints = NULL; 817bdd41206SAndrew Thompson } 8189469c929SAndrew Thompson USB_BUS_LOCK(udev->bus); 819ae60fdfbSAndrew Thompson udev->endpoints_max = ep_max; 8209469c929SAndrew Thompson /* reset any ongoing clear-stall */ 821ae60fdfbSAndrew Thompson udev->ep_curr = NULL; 8229469c929SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 823bdd41206SAndrew Thompson } 824bdd41206SAndrew Thompson 825bdd41206SAndrew Thompson done: 826bdd41206SAndrew Thompson if (err) { 827bdd41206SAndrew Thompson if (cmd == USB_CFG_ALLOC) { 828bdd41206SAndrew Thompson cleanup: 8299469c929SAndrew Thompson USB_BUS_LOCK(udev->bus); 830ae60fdfbSAndrew Thompson udev->endpoints_max = 0; 8319469c929SAndrew Thompson /* reset any ongoing clear-stall */ 832ae60fdfbSAndrew Thompson udev->ep_curr = NULL; 8339469c929SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 8349469c929SAndrew Thompson 835bdd41206SAndrew Thompson /* cleanup */ 836bdd41206SAndrew Thompson if (udev->ifaces != NULL) 837bdd41206SAndrew Thompson free(udev->ifaces, M_USB); 838ae60fdfbSAndrew Thompson if (udev->endpoints != NULL) 839ae60fdfbSAndrew Thompson free(udev->endpoints, M_USB); 840bdd41206SAndrew Thompson 841bdd41206SAndrew Thompson udev->ifaces = NULL; 842ae60fdfbSAndrew Thompson udev->endpoints = NULL; 843bdd41206SAndrew Thompson udev->ifaces_max = 0; 844bdd41206SAndrew Thompson } 845bdd41206SAndrew Thompson } 846bdd41206SAndrew Thompson return (err); 847bdd41206SAndrew Thompson } 848bdd41206SAndrew Thompson 849bdd41206SAndrew Thompson /*------------------------------------------------------------------------* 850a593f6b8SAndrew Thompson * usbd_set_alt_interface_index 85102ac6454SAndrew Thompson * 85202ac6454SAndrew Thompson * This function will select an alternate interface index for the 85302ac6454SAndrew Thompson * given interface index. The interface should not be in use when this 854e2805033SAndrew Thompson * function is called. That means there should not be any open USB 855e2805033SAndrew Thompson * transfers. Else an error is returned. If the alternate setting is 856e2805033SAndrew Thompson * already set this function will simply return success. This function 857e2805033SAndrew Thompson * is called in Host mode and Device mode! 85802ac6454SAndrew Thompson * 85902ac6454SAndrew Thompson * Returns: 86002ac6454SAndrew Thompson * 0: Success 86102ac6454SAndrew Thompson * Else: Failure 86202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 863e0a69b51SAndrew Thompson usb_error_t 864a593f6b8SAndrew Thompson usbd_set_alt_interface_index(struct usb_device *udev, 86502ac6454SAndrew Thompson uint8_t iface_index, uint8_t alt_index) 86602ac6454SAndrew Thompson { 867a593f6b8SAndrew Thompson struct usb_interface *iface = usbd_get_iface(udev, iface_index); 868e0a69b51SAndrew Thompson usb_error_t err; 86902ac6454SAndrew Thompson uint8_t do_unlock; 87002ac6454SAndrew Thompson 87102ac6454SAndrew Thompson /* automatic locking */ 872cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 87302ac6454SAndrew Thompson do_unlock = 0; 87402ac6454SAndrew Thompson } else { 87502ac6454SAndrew Thompson do_unlock = 1; 876cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 87702ac6454SAndrew Thompson } 87802ac6454SAndrew Thompson if (iface == NULL) { 87902ac6454SAndrew Thompson err = USB_ERR_INVAL; 88002ac6454SAndrew Thompson goto done; 88102ac6454SAndrew Thompson } 882e2805033SAndrew Thompson if (iface->alt_index == alt_index) { 883e2805033SAndrew Thompson /* 884e2805033SAndrew Thompson * Optimise away duplicate setting of 885e2805033SAndrew Thompson * alternate setting in USB Host Mode! 886e2805033SAndrew Thompson */ 887e2805033SAndrew Thompson err = 0; 888e2805033SAndrew Thompson goto done; 889e2805033SAndrew Thompson } 8900f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 89102ac6454SAndrew Thompson /* 89202ac6454SAndrew Thompson * Free all generic FIFOs for this interface, except control 89302ac6454SAndrew Thompson * endpoint FIFOs: 89402ac6454SAndrew Thompson */ 895a593f6b8SAndrew Thompson usb_fifo_free_wrap(udev, iface_index, 0); 8960f6e8f93SAndrew Thompson #endif 897bdd41206SAndrew Thompson 898a593f6b8SAndrew Thompson err = usb_config_parse(udev, iface_index, alt_index); 89902ac6454SAndrew Thompson if (err) { 90002ac6454SAndrew Thompson goto done; 90102ac6454SAndrew Thompson } 902bd73b187SAlfred Perlstein if (iface->alt_index != alt_index) { 903bd73b187SAlfred Perlstein /* the alternate setting does not exist */ 904bd73b187SAlfred Perlstein err = USB_ERR_INVAL; 905bd73b187SAlfred Perlstein goto done; 906bd73b187SAlfred Perlstein } 907bd73b187SAlfred Perlstein 908a593f6b8SAndrew Thompson err = usbd_req_set_alt_interface_no(udev, NULL, iface_index, 90902ac6454SAndrew Thompson iface->idesc->bAlternateSetting); 91002ac6454SAndrew Thompson 91102ac6454SAndrew Thompson done: 912cb18f7d1SAlfred Perlstein if (do_unlock) 913cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 914cb18f7d1SAlfred Perlstein 91502ac6454SAndrew Thompson return (err); 91602ac6454SAndrew Thompson } 91702ac6454SAndrew Thompson 91802ac6454SAndrew Thompson /*------------------------------------------------------------------------* 919a593f6b8SAndrew Thompson * usbd_set_endpoint_stall 92002ac6454SAndrew Thompson * 921963169b4SHans Petter Selasky * This function is used to make a BULK or INTERRUPT endpoint send 922963169b4SHans Petter Selasky * STALL tokens in USB device mode. 92302ac6454SAndrew Thompson * 92402ac6454SAndrew Thompson * Returns: 92502ac6454SAndrew Thompson * 0: Success 92602ac6454SAndrew Thompson * Else: Failure 92702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 928e0a69b51SAndrew Thompson usb_error_t 929a593f6b8SAndrew Thompson usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep, 93002ac6454SAndrew Thompson uint8_t do_stall) 93102ac6454SAndrew Thompson { 932760bc48eSAndrew Thompson struct usb_xfer *xfer; 93302ac6454SAndrew Thompson uint8_t et; 93402ac6454SAndrew Thompson uint8_t was_stalled; 93502ac6454SAndrew Thompson 936ae60fdfbSAndrew Thompson if (ep == NULL) { 93702ac6454SAndrew Thompson /* nothing to do */ 93802ac6454SAndrew Thompson DPRINTF("Cannot find endpoint\n"); 93902ac6454SAndrew Thompson /* 94002ac6454SAndrew Thompson * Pretend that the clear or set stall request is 94102ac6454SAndrew Thompson * successful else some USB host stacks can do 94202ac6454SAndrew Thompson * strange things, especially when a control endpoint 94302ac6454SAndrew Thompson * stalls. 94402ac6454SAndrew Thompson */ 94502ac6454SAndrew Thompson return (0); 94602ac6454SAndrew Thompson } 947ae60fdfbSAndrew Thompson et = (ep->edesc->bmAttributes & UE_XFERTYPE); 94802ac6454SAndrew Thompson 94902ac6454SAndrew Thompson if ((et != UE_BULK) && 95002ac6454SAndrew Thompson (et != UE_INTERRUPT)) { 95102ac6454SAndrew Thompson /* 95202ac6454SAndrew Thompson * Should not stall control 95302ac6454SAndrew Thompson * nor isochronous endpoints. 95402ac6454SAndrew Thompson */ 95502ac6454SAndrew Thompson DPRINTF("Invalid endpoint\n"); 95602ac6454SAndrew Thompson return (0); 95702ac6454SAndrew Thompson } 95802ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 95902ac6454SAndrew Thompson 96002ac6454SAndrew Thompson /* store current stall state */ 961ae60fdfbSAndrew Thompson was_stalled = ep->is_stalled; 96202ac6454SAndrew Thompson 96302ac6454SAndrew Thompson /* check for no change */ 96402ac6454SAndrew Thompson if (was_stalled && do_stall) { 965ae60fdfbSAndrew Thompson /* if the endpoint is already stalled do nothing */ 96602ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 96702ac6454SAndrew Thompson DPRINTF("No change\n"); 96802ac6454SAndrew Thompson return (0); 96902ac6454SAndrew Thompson } 97002ac6454SAndrew Thompson /* set stalled state */ 971ae60fdfbSAndrew Thompson ep->is_stalled = 1; 97202ac6454SAndrew Thompson 97302ac6454SAndrew Thompson if (do_stall || (!was_stalled)) { 97402ac6454SAndrew Thompson if (!was_stalled) { 97502ac6454SAndrew Thompson /* lookup the current USB transfer, if any */ 976ae60fdfbSAndrew Thompson xfer = ep->endpoint_q.curr; 97702ac6454SAndrew Thompson } else { 97802ac6454SAndrew Thompson xfer = NULL; 97902ac6454SAndrew Thompson } 98002ac6454SAndrew Thompson 98102ac6454SAndrew Thompson /* 98202ac6454SAndrew Thompson * If "xfer" is non-NULL the "set_stall" method will 98302ac6454SAndrew Thompson * complete the USB transfer like in case of a timeout 98402ac6454SAndrew Thompson * setting the error code "USB_ERR_STALLED". 98502ac6454SAndrew Thompson */ 98629bd7d7eSAndrew Thompson (udev->bus->methods->set_stall) (udev, xfer, ep, &do_stall); 98702ac6454SAndrew Thompson } 98802ac6454SAndrew Thompson if (!do_stall) { 989ae60fdfbSAndrew Thompson ep->toggle_next = 0; /* reset data toggle */ 990ae60fdfbSAndrew Thompson ep->is_stalled = 0; /* clear stalled state */ 99102ac6454SAndrew Thompson 992ae60fdfbSAndrew Thompson (udev->bus->methods->clear_stall) (udev, ep); 99302ac6454SAndrew Thompson 99402ac6454SAndrew Thompson /* start up the current or next transfer, if any */ 995a593f6b8SAndrew Thompson usb_command_wrapper(&ep->endpoint_q, ep->endpoint_q.curr); 99602ac6454SAndrew Thompson } 99702ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 99802ac6454SAndrew Thompson return (0); 99902ac6454SAndrew Thompson } 100002ac6454SAndrew Thompson 100102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1002a593f6b8SAndrew Thompson * usb_reset_iface_endpoints - used in USB device side mode 100302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1004e0a69b51SAndrew Thompson usb_error_t 1005a593f6b8SAndrew Thompson usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index) 100602ac6454SAndrew Thompson { 1007ae60fdfbSAndrew Thompson struct usb_endpoint *ep; 1008ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end; 100902ac6454SAndrew Thompson 1010ae60fdfbSAndrew Thompson ep = udev->endpoints; 1011ae60fdfbSAndrew Thompson ep_end = udev->endpoints + udev->endpoints_max; 101202ac6454SAndrew Thompson 1013ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 101402ac6454SAndrew Thompson 1015ae60fdfbSAndrew Thompson if ((ep->edesc == NULL) || 1016ae60fdfbSAndrew Thompson (ep->iface_index != iface_index)) { 101702ac6454SAndrew Thompson continue; 101802ac6454SAndrew Thompson } 101902ac6454SAndrew Thompson /* simulate a clear stall from the peer */ 1020bd73b187SAlfred Perlstein usbd_set_endpoint_stall(udev, ep, 0); 102102ac6454SAndrew Thompson } 102202ac6454SAndrew Thompson return (0); 102302ac6454SAndrew Thompson } 102402ac6454SAndrew Thompson 102502ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1026a593f6b8SAndrew Thompson * usb_detach_device_sub 102702ac6454SAndrew Thompson * 102802ac6454SAndrew Thompson * This function will try to detach an USB device. If it fails a panic 102902ac6454SAndrew Thompson * will result. 1030bdd41206SAndrew Thompson * 1031bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 103202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 103302ac6454SAndrew Thompson static void 1034a593f6b8SAndrew Thompson usb_detach_device_sub(struct usb_device *udev, device_t *ppdev, 10358427ed84SHans Petter Selasky char **ppnpinfo, uint8_t flag) 103602ac6454SAndrew Thompson { 103702ac6454SAndrew Thompson device_t dev; 10388427ed84SHans Petter Selasky char *pnpinfo; 103902ac6454SAndrew Thompson int err; 104002ac6454SAndrew Thompson 1041d88688c7SAndrew Thompson dev = *ppdev; 1042d88688c7SAndrew Thompson if (dev) { 104302ac6454SAndrew Thompson /* 104402ac6454SAndrew Thompson * NOTE: It is important to clear "*ppdev" before deleting 104502ac6454SAndrew Thompson * the child due to some device methods being called late 104602ac6454SAndrew Thompson * during the delete process ! 104702ac6454SAndrew Thompson */ 104802ac6454SAndrew Thompson *ppdev = NULL; 104902ac6454SAndrew Thompson 105002ac6454SAndrew Thompson device_printf(dev, "at %s, port %d, addr %d " 105102ac6454SAndrew Thompson "(disconnected)\n", 105202ac6454SAndrew Thompson device_get_nameunit(udev->parent_dev), 105302ac6454SAndrew Thompson udev->port_no, udev->address); 105402ac6454SAndrew Thompson 105502ac6454SAndrew Thompson if (device_is_attached(dev)) { 1056ec8f3127SAndrew Thompson if (udev->flags.peer_suspended) { 105702ac6454SAndrew Thompson err = DEVICE_RESUME(dev); 105802ac6454SAndrew Thompson if (err) { 1059767cb2e2SAndrew Thompson device_printf(dev, "Resume failed\n"); 106002ac6454SAndrew Thompson } 106102ac6454SAndrew Thompson } 106202ac6454SAndrew Thompson if (device_detach(dev)) { 106302ac6454SAndrew Thompson goto error; 106402ac6454SAndrew Thompson } 106502ac6454SAndrew Thompson } 106602ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, dev)) { 106702ac6454SAndrew Thompson goto error; 106802ac6454SAndrew Thompson } 106902ac6454SAndrew Thompson } 10708427ed84SHans Petter Selasky 10718427ed84SHans Petter Selasky pnpinfo = *ppnpinfo; 10728427ed84SHans Petter Selasky if (pnpinfo != NULL) { 10738427ed84SHans Petter Selasky *ppnpinfo = NULL; 10748427ed84SHans Petter Selasky free(pnpinfo, M_USBDEV); 10758427ed84SHans Petter Selasky } 107602ac6454SAndrew Thompson return; 107702ac6454SAndrew Thompson 107802ac6454SAndrew Thompson error: 107902ac6454SAndrew Thompson /* Detach is not allowed to fail in the USB world */ 10808427ed84SHans Petter Selasky panic("usb_detach_device_sub: A USB driver would not detach\n"); 108102ac6454SAndrew Thompson } 108202ac6454SAndrew Thompson 108302ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1084a593f6b8SAndrew Thompson * usb_detach_device 108502ac6454SAndrew Thompson * 108602ac6454SAndrew Thompson * The following function will detach the matching interfaces. 108702ac6454SAndrew Thompson * This function is NULL safe. 1088bdd41206SAndrew Thompson * 1089bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 109002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 109102ac6454SAndrew Thompson void 1092a593f6b8SAndrew Thompson usb_detach_device(struct usb_device *udev, uint8_t iface_index, 1093bdd41206SAndrew Thompson uint8_t flag) 109402ac6454SAndrew Thompson { 1095760bc48eSAndrew Thompson struct usb_interface *iface; 109602ac6454SAndrew Thompson uint8_t i; 109702ac6454SAndrew Thompson 109802ac6454SAndrew Thompson if (udev == NULL) { 109902ac6454SAndrew Thompson /* nothing to do */ 110002ac6454SAndrew Thompson return; 110102ac6454SAndrew Thompson } 110202ac6454SAndrew Thompson DPRINTFN(4, "udev=%p\n", udev); 110302ac6454SAndrew Thompson 110491cd9240SAndrew Thompson sx_assert(&udev->enum_sx, SA_LOCKED); 110502ac6454SAndrew Thompson 110602ac6454SAndrew Thompson /* 110702ac6454SAndrew Thompson * First detach the child to give the child's detach routine a 110802ac6454SAndrew Thompson * chance to detach the sub-devices in the correct order. 110902ac6454SAndrew Thompson * Then delete the child using "device_delete_child()" which 111002ac6454SAndrew Thompson * will detach all sub-devices from the bottom and upwards! 111102ac6454SAndrew Thompson */ 111202ac6454SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 111302ac6454SAndrew Thompson i = iface_index; 111402ac6454SAndrew Thompson iface_index = i + 1; 111502ac6454SAndrew Thompson } else { 111602ac6454SAndrew Thompson i = 0; 111702ac6454SAndrew Thompson iface_index = USB_IFACE_MAX; 111802ac6454SAndrew Thompson } 111902ac6454SAndrew Thompson 112002ac6454SAndrew Thompson /* do the detach */ 112102ac6454SAndrew Thompson 112202ac6454SAndrew Thompson for (; i != iface_index; i++) { 112302ac6454SAndrew Thompson 1124a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 112502ac6454SAndrew Thompson if (iface == NULL) { 112602ac6454SAndrew Thompson /* looks like the end of the USB interfaces */ 112702ac6454SAndrew Thompson break; 112802ac6454SAndrew Thompson } 11298427ed84SHans Petter Selasky usb_detach_device_sub(udev, &iface->subdev, 11308427ed84SHans Petter Selasky &iface->pnpinfo, flag); 113102ac6454SAndrew Thompson } 113202ac6454SAndrew Thompson } 113302ac6454SAndrew Thompson 113402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1135a593f6b8SAndrew Thompson * usb_probe_and_attach_sub 113602ac6454SAndrew Thompson * 113702ac6454SAndrew Thompson * Returns: 113802ac6454SAndrew Thompson * 0: Success 113902ac6454SAndrew Thompson * Else: Failure 114002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 114102ac6454SAndrew Thompson static uint8_t 1142a593f6b8SAndrew Thompson usb_probe_and_attach_sub(struct usb_device *udev, 1143760bc48eSAndrew Thompson struct usb_attach_arg *uaa) 114402ac6454SAndrew Thompson { 1145760bc48eSAndrew Thompson struct usb_interface *iface; 114602ac6454SAndrew Thompson device_t dev; 114702ac6454SAndrew Thompson int err; 114802ac6454SAndrew Thompson 114902ac6454SAndrew Thompson iface = uaa->iface; 115002ac6454SAndrew Thompson if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) { 115102ac6454SAndrew Thompson /* leave interface alone */ 115202ac6454SAndrew Thompson return (0); 115302ac6454SAndrew Thompson } 115402ac6454SAndrew Thompson dev = iface->subdev; 115502ac6454SAndrew Thompson if (dev) { 115602ac6454SAndrew Thompson 115702ac6454SAndrew Thompson /* clean up after module unload */ 115802ac6454SAndrew Thompson 115902ac6454SAndrew Thompson if (device_is_attached(dev)) { 116002ac6454SAndrew Thompson /* already a device there */ 116102ac6454SAndrew Thompson return (0); 116202ac6454SAndrew Thompson } 116302ac6454SAndrew Thompson /* clear "iface->subdev" as early as possible */ 116402ac6454SAndrew Thompson 116502ac6454SAndrew Thompson iface->subdev = NULL; 116602ac6454SAndrew Thompson 116702ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, dev)) { 116802ac6454SAndrew Thompson 116902ac6454SAndrew Thompson /* 117002ac6454SAndrew Thompson * Panic here, else one can get a double call 117102ac6454SAndrew Thompson * to device_detach(). USB devices should 117202ac6454SAndrew Thompson * never fail on detach! 117302ac6454SAndrew Thompson */ 1174767cb2e2SAndrew Thompson panic("device_delete_child() failed\n"); 117502ac6454SAndrew Thompson } 117602ac6454SAndrew Thompson } 117702ac6454SAndrew Thompson if (uaa->temp_dev == NULL) { 117802ac6454SAndrew Thompson 117902ac6454SAndrew Thompson /* create a new child */ 118002ac6454SAndrew Thompson uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1); 118102ac6454SAndrew Thompson if (uaa->temp_dev == NULL) { 118202ac6454SAndrew Thompson device_printf(udev->parent_dev, 1183767cb2e2SAndrew Thompson "Device creation failed\n"); 118402ac6454SAndrew Thompson return (1); /* failure */ 118502ac6454SAndrew Thompson } 118602ac6454SAndrew Thompson device_set_ivars(uaa->temp_dev, uaa); 118702ac6454SAndrew Thompson device_quiet(uaa->temp_dev); 118802ac6454SAndrew Thompson } 118902ac6454SAndrew Thompson /* 119002ac6454SAndrew Thompson * Set "subdev" before probe and attach so that "devd" gets 119102ac6454SAndrew Thompson * the information it needs. 119202ac6454SAndrew Thompson */ 119302ac6454SAndrew Thompson iface->subdev = uaa->temp_dev; 119402ac6454SAndrew Thompson 119502ac6454SAndrew Thompson if (device_probe_and_attach(iface->subdev) == 0) { 119602ac6454SAndrew Thompson /* 119702ac6454SAndrew Thompson * The USB attach arguments are only available during probe 119802ac6454SAndrew Thompson * and attach ! 119902ac6454SAndrew Thompson */ 120002ac6454SAndrew Thompson uaa->temp_dev = NULL; 120102ac6454SAndrew Thompson device_set_ivars(iface->subdev, NULL); 120202ac6454SAndrew Thompson 1203ec8f3127SAndrew Thompson if (udev->flags.peer_suspended) { 120402ac6454SAndrew Thompson err = DEVICE_SUSPEND(iface->subdev); 120588b4e0abSAndrew Thompson if (err) 120602ac6454SAndrew Thompson device_printf(iface->subdev, "Suspend failed\n"); 120702ac6454SAndrew Thompson } 120802ac6454SAndrew Thompson return (0); /* success */ 120902ac6454SAndrew Thompson } else { 121002ac6454SAndrew Thompson /* No USB driver found */ 121102ac6454SAndrew Thompson iface->subdev = NULL; 121202ac6454SAndrew Thompson } 121302ac6454SAndrew Thompson return (1); /* failure */ 121402ac6454SAndrew Thompson } 121502ac6454SAndrew Thompson 121602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1217a593f6b8SAndrew Thompson * usbd_set_parent_iface 121802ac6454SAndrew Thompson * 121902ac6454SAndrew Thompson * Using this function will lock the alternate interface setting on an 122002ac6454SAndrew Thompson * interface. It is typically used for multi interface drivers. In USB 122102ac6454SAndrew Thompson * device side mode it is assumed that the alternate interfaces all 122202ac6454SAndrew Thompson * have the same endpoint descriptors. The default parent index value 122302ac6454SAndrew Thompson * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not 122402ac6454SAndrew Thompson * locked. 122502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 122602ac6454SAndrew Thompson void 1227a593f6b8SAndrew Thompson usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index, 122802ac6454SAndrew Thompson uint8_t parent_index) 122902ac6454SAndrew Thompson { 1230760bc48eSAndrew Thompson struct usb_interface *iface; 123102ac6454SAndrew Thompson 1232a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, iface_index); 123302ac6454SAndrew Thompson if (iface) { 123402ac6454SAndrew Thompson iface->parent_iface_index = parent_index; 123502ac6454SAndrew Thompson } 123602ac6454SAndrew Thompson } 123702ac6454SAndrew Thompson 123802ac6454SAndrew Thompson static void 1239a593f6b8SAndrew Thompson usb_init_attach_arg(struct usb_device *udev, 1240760bc48eSAndrew Thompson struct usb_attach_arg *uaa) 124102ac6454SAndrew Thompson { 124202ac6454SAndrew Thompson bzero(uaa, sizeof(*uaa)); 124302ac6454SAndrew Thompson 124402ac6454SAndrew Thompson uaa->device = udev; 1245f29a0724SAndrew Thompson uaa->usb_mode = udev->flags.usb_mode; 124602ac6454SAndrew Thompson uaa->port = udev->port_no; 12472a4c6157SAndrew Thompson uaa->dev_state = UAA_DEV_READY; 124802ac6454SAndrew Thompson 124902ac6454SAndrew Thompson uaa->info.idVendor = UGETW(udev->ddesc.idVendor); 125002ac6454SAndrew Thompson uaa->info.idProduct = UGETW(udev->ddesc.idProduct); 125102ac6454SAndrew Thompson uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice); 125202ac6454SAndrew Thompson uaa->info.bDeviceClass = udev->ddesc.bDeviceClass; 125302ac6454SAndrew Thompson uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass; 125402ac6454SAndrew Thompson uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol; 125502ac6454SAndrew Thompson uaa->info.bConfigIndex = udev->curr_config_index; 125602ac6454SAndrew Thompson uaa->info.bConfigNum = udev->curr_config_no; 125702ac6454SAndrew Thompson } 125802ac6454SAndrew Thompson 125902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1260a593f6b8SAndrew Thompson * usb_probe_and_attach 126102ac6454SAndrew Thompson * 126202ac6454SAndrew Thompson * This function is called from "uhub_explore_sub()", 1263a593f6b8SAndrew Thompson * "usb_handle_set_config()" and "usb_handle_request()". 126402ac6454SAndrew Thompson * 126502ac6454SAndrew Thompson * Returns: 126602ac6454SAndrew Thompson * 0: Success 126702ac6454SAndrew Thompson * Else: A control transfer failed 126802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1269e0a69b51SAndrew Thompson usb_error_t 1270a593f6b8SAndrew Thompson usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index) 127102ac6454SAndrew Thompson { 1272760bc48eSAndrew Thompson struct usb_attach_arg uaa; 1273760bc48eSAndrew Thompson struct usb_interface *iface; 127402ac6454SAndrew Thompson uint8_t i; 127502ac6454SAndrew Thompson uint8_t j; 127602ac6454SAndrew Thompson uint8_t do_unlock; 127702ac6454SAndrew Thompson 127802ac6454SAndrew Thompson if (udev == NULL) { 127902ac6454SAndrew Thompson DPRINTF("udev == NULL\n"); 128002ac6454SAndrew Thompson return (USB_ERR_INVAL); 128102ac6454SAndrew Thompson } 128202ac6454SAndrew Thompson /* automatic locking */ 1283cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 128402ac6454SAndrew Thompson do_unlock = 0; 128502ac6454SAndrew Thompson } else { 128602ac6454SAndrew Thompson do_unlock = 1; 1287cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 128802ac6454SAndrew Thompson } 128902ac6454SAndrew Thompson 129002ac6454SAndrew Thompson if (udev->curr_config_index == USB_UNCONFIG_INDEX) { 129102ac6454SAndrew Thompson /* do nothing - no configuration has been set */ 129202ac6454SAndrew Thompson goto done; 129302ac6454SAndrew Thompson } 129402ac6454SAndrew Thompson /* setup USB attach arguments */ 129502ac6454SAndrew Thompson 1296a593f6b8SAndrew Thompson usb_init_attach_arg(udev, &uaa); 129702ac6454SAndrew Thompson 1298a6b60150SHans Petter Selasky /* 1299a6b60150SHans Petter Selasky * If the whole USB device is targeted, invoke the USB event 1300a6b60150SHans Petter Selasky * handler(s): 1301a6b60150SHans Petter Selasky */ 1302a6b60150SHans Petter Selasky if (iface_index == USB_IFACE_INDEX_ANY) { 1303a6b60150SHans Petter Selasky 1304a6b60150SHans Petter Selasky EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa); 1305a6b60150SHans Petter Selasky 1306a6b60150SHans Petter Selasky if (uaa.dev_state != UAA_DEV_READY) { 1307a6b60150SHans Petter Selasky /* leave device unconfigured */ 1308a6b60150SHans Petter Selasky usb_unconfigure(udev, 0); 1309a6b60150SHans Petter Selasky goto done; 1310a6b60150SHans Petter Selasky } 1311a6b60150SHans Petter Selasky } 1312a6b60150SHans Petter Selasky 131302ac6454SAndrew Thompson /* Check if only one interface should be probed: */ 131402ac6454SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 131502ac6454SAndrew Thompson i = iface_index; 131602ac6454SAndrew Thompson j = i + 1; 131702ac6454SAndrew Thompson } else { 131802ac6454SAndrew Thompson i = 0; 131902ac6454SAndrew Thompson j = USB_IFACE_MAX; 132002ac6454SAndrew Thompson } 132102ac6454SAndrew Thompson 132202ac6454SAndrew Thompson /* Do the probe and attach */ 132302ac6454SAndrew Thompson for (; i != j; i++) { 132402ac6454SAndrew Thompson 1325a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 132602ac6454SAndrew Thompson if (iface == NULL) { 132702ac6454SAndrew Thompson /* 132802ac6454SAndrew Thompson * Looks like the end of the USB 132902ac6454SAndrew Thompson * interfaces ! 133002ac6454SAndrew Thompson */ 133102ac6454SAndrew Thompson DPRINTFN(2, "end of interfaces " 133202ac6454SAndrew Thompson "at %u\n", i); 133302ac6454SAndrew Thompson break; 133402ac6454SAndrew Thompson } 133502ac6454SAndrew Thompson if (iface->idesc == NULL) { 133602ac6454SAndrew Thompson /* no interface descriptor */ 133702ac6454SAndrew Thompson continue; 133802ac6454SAndrew Thompson } 133902ac6454SAndrew Thompson uaa.iface = iface; 134002ac6454SAndrew Thompson 134102ac6454SAndrew Thompson uaa.info.bInterfaceClass = 134202ac6454SAndrew Thompson iface->idesc->bInterfaceClass; 134302ac6454SAndrew Thompson uaa.info.bInterfaceSubClass = 134402ac6454SAndrew Thompson iface->idesc->bInterfaceSubClass; 134502ac6454SAndrew Thompson uaa.info.bInterfaceProtocol = 134602ac6454SAndrew Thompson iface->idesc->bInterfaceProtocol; 134702ac6454SAndrew Thompson uaa.info.bIfaceIndex = i; 134802ac6454SAndrew Thompson uaa.info.bIfaceNum = 134902ac6454SAndrew Thompson iface->idesc->bInterfaceNumber; 1350bd73b187SAlfred Perlstein uaa.driver_info = 0; /* reset driver_info */ 135102ac6454SAndrew Thompson 135202ac6454SAndrew Thompson DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n", 135302ac6454SAndrew Thompson uaa.info.bInterfaceClass, 135402ac6454SAndrew Thompson uaa.info.bInterfaceSubClass, 135502ac6454SAndrew Thompson uaa.info.bInterfaceProtocol, 135602ac6454SAndrew Thompson uaa.info.bIfaceIndex, 135702ac6454SAndrew Thompson uaa.info.bIfaceNum); 135802ac6454SAndrew Thompson 1359d43ffe94SHans Petter Selasky usb_probe_and_attach_sub(udev, &uaa); 136002ac6454SAndrew Thompson 1361d43ffe94SHans Petter Selasky /* 1362d43ffe94SHans Petter Selasky * Remove the leftover child, if any, to enforce that 1363d43ffe94SHans Petter Selasky * a new nomatch devd event is generated for the next 1364d43ffe94SHans Petter Selasky * interface if no driver is found: 1365d43ffe94SHans Petter Selasky */ 1366d43ffe94SHans Petter Selasky if (uaa.temp_dev == NULL) 1367d43ffe94SHans Petter Selasky continue; 1368d43ffe94SHans Petter Selasky if (device_delete_child(udev->parent_dev, uaa.temp_dev)) 1369767cb2e2SAndrew Thompson DPRINTFN(0, "device delete child failed\n"); 1370d43ffe94SHans Petter Selasky uaa.temp_dev = NULL; 137102ac6454SAndrew Thompson } 137202ac6454SAndrew Thompson done: 1373cb18f7d1SAlfred Perlstein if (do_unlock) 1374cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 1375cb18f7d1SAlfred Perlstein 137602ac6454SAndrew Thompson return (0); 137702ac6454SAndrew Thompson } 137802ac6454SAndrew Thompson 137902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1380a593f6b8SAndrew Thompson * usb_suspend_resume_sub 138102ac6454SAndrew Thompson * 138202ac6454SAndrew Thompson * This function is called when the suspend or resume methods should 138302ac6454SAndrew Thompson * be executed on an USB device. 138402ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 138502ac6454SAndrew Thompson static void 1386a593f6b8SAndrew Thompson usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend) 138702ac6454SAndrew Thompson { 138802ac6454SAndrew Thompson int err; 138902ac6454SAndrew Thompson 139002ac6454SAndrew Thompson if (dev == NULL) { 139102ac6454SAndrew Thompson return; 139202ac6454SAndrew Thompson } 139302ac6454SAndrew Thompson if (!device_is_attached(dev)) { 139402ac6454SAndrew Thompson return; 139502ac6454SAndrew Thompson } 139602ac6454SAndrew Thompson if (do_suspend) { 139702ac6454SAndrew Thompson err = DEVICE_SUSPEND(dev); 139802ac6454SAndrew Thompson } else { 139902ac6454SAndrew Thompson err = DEVICE_RESUME(dev); 140002ac6454SAndrew Thompson } 140102ac6454SAndrew Thompson if (err) { 1402767cb2e2SAndrew Thompson device_printf(dev, "%s failed\n", 140302ac6454SAndrew Thompson do_suspend ? "Suspend" : "Resume"); 140402ac6454SAndrew Thompson } 140502ac6454SAndrew Thompson } 140602ac6454SAndrew Thompson 140702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1408a593f6b8SAndrew Thompson * usb_suspend_resume 140902ac6454SAndrew Thompson * 141002ac6454SAndrew Thompson * The following function will suspend or resume the USB device. 141102ac6454SAndrew Thompson * 141202ac6454SAndrew Thompson * Returns: 141302ac6454SAndrew Thompson * 0: Success 141402ac6454SAndrew Thompson * Else: Failure 141502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1416e0a69b51SAndrew Thompson usb_error_t 1417a593f6b8SAndrew Thompson usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend) 141802ac6454SAndrew Thompson { 1419760bc48eSAndrew Thompson struct usb_interface *iface; 142002ac6454SAndrew Thompson uint8_t i; 142102ac6454SAndrew Thompson 142202ac6454SAndrew Thompson if (udev == NULL) { 142302ac6454SAndrew Thompson /* nothing to do */ 142402ac6454SAndrew Thompson return (0); 142502ac6454SAndrew Thompson } 142602ac6454SAndrew Thompson DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend); 142702ac6454SAndrew Thompson 14282df1e9a6SAndrew Thompson sx_assert(&udev->sr_sx, SA_LOCKED); 142902ac6454SAndrew Thompson 143002ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 143102ac6454SAndrew Thompson /* filter the suspend events */ 1432ec8f3127SAndrew Thompson if (udev->flags.peer_suspended == do_suspend) { 143302ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 143402ac6454SAndrew Thompson /* nothing to do */ 143502ac6454SAndrew Thompson return (0); 143602ac6454SAndrew Thompson } 1437ec8f3127SAndrew Thompson udev->flags.peer_suspended = do_suspend; 143802ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 143902ac6454SAndrew Thompson 144002ac6454SAndrew Thompson /* do the suspend or resume */ 144102ac6454SAndrew Thompson 144202ac6454SAndrew Thompson for (i = 0; i != USB_IFACE_MAX; i++) { 144302ac6454SAndrew Thompson 1444a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 144502ac6454SAndrew Thompson if (iface == NULL) { 144602ac6454SAndrew Thompson /* looks like the end of the USB interfaces */ 144702ac6454SAndrew Thompson break; 144802ac6454SAndrew Thompson } 1449a593f6b8SAndrew Thompson usb_suspend_resume_sub(udev, iface->subdev, do_suspend); 145002ac6454SAndrew Thompson } 145102ac6454SAndrew Thompson return (0); 145202ac6454SAndrew Thompson } 145302ac6454SAndrew Thompson 145402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1455a593f6b8SAndrew Thompson * usbd_clear_stall_proc 145602ac6454SAndrew Thompson * 145702ac6454SAndrew Thompson * This function performs generic USB clear stall operations. 145802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 145902ac6454SAndrew Thompson static void 1460a593f6b8SAndrew Thompson usbd_clear_stall_proc(struct usb_proc_msg *_pm) 146102ac6454SAndrew Thompson { 1462760bc48eSAndrew Thompson struct usb_clear_stall_msg *pm = (void *)_pm; 1463760bc48eSAndrew Thompson struct usb_device *udev = pm->udev; 146402ac6454SAndrew Thompson 146502ac6454SAndrew Thompson /* Change lock */ 146602ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 146791cd9240SAndrew Thompson mtx_lock(&udev->device_mtx); 146802ac6454SAndrew Thompson 146902ac6454SAndrew Thompson /* Start clear stall callback */ 14705b3bb704SAndrew Thompson usbd_transfer_start(udev->ctrl_xfer[1]); 147102ac6454SAndrew Thompson 147202ac6454SAndrew Thompson /* Change lock */ 147391cd9240SAndrew Thompson mtx_unlock(&udev->device_mtx); 147402ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 147502ac6454SAndrew Thompson } 147602ac6454SAndrew Thompson 147702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1478a593f6b8SAndrew Thompson * usb_alloc_device 147902ac6454SAndrew Thompson * 148002ac6454SAndrew Thompson * This function allocates a new USB device. This function is called 148102ac6454SAndrew Thompson * when a new device has been put in the powered state, but not yet in 148202ac6454SAndrew Thompson * the addressed state. Get initial descriptor, set the address, get 148302ac6454SAndrew Thompson * full descriptor and get strings. 148402ac6454SAndrew Thompson * 148502ac6454SAndrew Thompson * Return values: 148602ac6454SAndrew Thompson * 0: Failure 148702ac6454SAndrew Thompson * Else: Success 148802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1489760bc48eSAndrew Thompson struct usb_device * 1490a593f6b8SAndrew Thompson usb_alloc_device(device_t parent_dev, struct usb_bus *bus, 1491760bc48eSAndrew Thompson struct usb_device *parent_hub, uint8_t depth, uint8_t port_index, 14928d2dd5ddSAndrew Thompson uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode) 149302ac6454SAndrew Thompson { 1494760bc48eSAndrew Thompson struct usb_attach_arg uaa; 1495760bc48eSAndrew Thompson struct usb_device *udev; 1496760bc48eSAndrew Thompson struct usb_device *adev; 1497760bc48eSAndrew Thompson struct usb_device *hub; 149802ac6454SAndrew Thompson uint8_t *scratch_ptr; 14997a918edfSAndrew Thompson size_t scratch_size; 1500e0a69b51SAndrew Thompson usb_error_t err; 150102ac6454SAndrew Thompson uint8_t device_index; 15022a4c6157SAndrew Thompson uint8_t config_index; 15032a4c6157SAndrew Thompson uint8_t config_quirk; 15042a4c6157SAndrew Thompson uint8_t set_config_failed; 150502ac6454SAndrew Thompson 150602ac6454SAndrew Thompson DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, " 1507f29a0724SAndrew Thompson "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n", 150802ac6454SAndrew Thompson parent_dev, bus, parent_hub, depth, port_index, port_no, 1509f29a0724SAndrew Thompson speed, mode); 151002ac6454SAndrew Thompson 151102ac6454SAndrew Thompson /* 151202ac6454SAndrew Thompson * Find an unused device index. In USB Host mode this is the 151302ac6454SAndrew Thompson * same as the device address. 151402ac6454SAndrew Thompson * 151502ac6454SAndrew Thompson * Device index zero is not used and device index 1 should 151602ac6454SAndrew Thompson * always be the root hub. 151702ac6454SAndrew Thompson */ 151802ac6454SAndrew Thompson for (device_index = USB_ROOT_HUB_ADDR; 151902ac6454SAndrew Thompson (device_index != bus->devices_max) && 152002ac6454SAndrew Thompson (bus->devices[device_index] != NULL); 152102ac6454SAndrew Thompson device_index++) /* nop */; 152202ac6454SAndrew Thompson 152302ac6454SAndrew Thompson if (device_index == bus->devices_max) { 152402ac6454SAndrew Thompson device_printf(bus->bdev, 1525767cb2e2SAndrew Thompson "No free USB device index for new device\n"); 152602ac6454SAndrew Thompson return (NULL); 152702ac6454SAndrew Thompson } 152802ac6454SAndrew Thompson 152902ac6454SAndrew Thompson if (depth > 0x10) { 153002ac6454SAndrew Thompson device_printf(bus->bdev, 1531767cb2e2SAndrew Thompson "Invalid device depth\n"); 153202ac6454SAndrew Thompson return (NULL); 153302ac6454SAndrew Thompson } 153402ac6454SAndrew Thompson udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO); 153502ac6454SAndrew Thompson if (udev == NULL) { 153602ac6454SAndrew Thompson return (NULL); 153702ac6454SAndrew Thompson } 153802ac6454SAndrew Thompson /* initialise our SX-lock */ 153991cd9240SAndrew Thompson sx_init_flags(&udev->ctrl_sx, "USB device SX lock", SX_DUPOK); 154002ac6454SAndrew Thompson 154102ac6454SAndrew Thompson /* initialise our SX-lock */ 154291cd9240SAndrew Thompson sx_init_flags(&udev->enum_sx, "USB config SX lock", SX_DUPOK); 1543a6b60150SHans Petter Selasky sx_init_flags(&udev->sr_sx, "USB suspend and resume SX lock", SX_NOWITNESS); 154402ac6454SAndrew Thompson 154591cd9240SAndrew Thompson cv_init(&udev->ctrlreq_cv, "WCTRL"); 154691cd9240SAndrew Thompson cv_init(&udev->ref_cv, "UGONE"); 154702ac6454SAndrew Thompson 154802ac6454SAndrew Thompson /* initialise our mutex */ 154991cd9240SAndrew Thompson mtx_init(&udev->device_mtx, "USB device mutex", NULL, MTX_DEF); 155002ac6454SAndrew Thompson 155102ac6454SAndrew Thompson /* initialise generic clear stall */ 1552a593f6b8SAndrew Thompson udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc; 155302ac6454SAndrew Thompson udev->cs_msg[0].udev = udev; 1554a593f6b8SAndrew Thompson udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc; 155502ac6454SAndrew Thompson udev->cs_msg[1].udev = udev; 155602ac6454SAndrew Thompson 155702ac6454SAndrew Thompson /* initialise some USB device fields */ 155802ac6454SAndrew Thompson udev->parent_hub = parent_hub; 155902ac6454SAndrew Thompson udev->parent_dev = parent_dev; 156002ac6454SAndrew Thompson udev->port_index = port_index; 156102ac6454SAndrew Thompson udev->port_no = port_no; 156202ac6454SAndrew Thompson udev->depth = depth; 156302ac6454SAndrew Thompson udev->bus = bus; 156402ac6454SAndrew Thompson udev->address = USB_START_ADDR; /* default value */ 1565e0a69b51SAndrew Thompson udev->plugtime = (usb_ticks_t)ticks; 156602ac6454SAndrew Thompson /* 156702ac6454SAndrew Thompson * We need to force the power mode to "on" because there are plenty 156802ac6454SAndrew Thompson * of USB devices out there that do not work very well with 156902ac6454SAndrew Thompson * automatic suspend and resume! 157002ac6454SAndrew Thompson */ 1571d2d71ce7SAndrew Thompson udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON); 157202ac6454SAndrew Thompson udev->pwr_save.last_xfer_time = ticks; 157302ac6454SAndrew Thompson /* we are not ready yet */ 157402ac6454SAndrew Thompson udev->refcount = 1; 157502ac6454SAndrew Thompson 157602ac6454SAndrew Thompson /* set up default endpoint descriptor */ 15775b3bb704SAndrew Thompson udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc); 15785b3bb704SAndrew Thompson udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT; 15795b3bb704SAndrew Thompson udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT; 15805b3bb704SAndrew Thompson udev->ctrl_ep_desc.bmAttributes = UE_CONTROL; 15815b3bb704SAndrew Thompson udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET; 15825b3bb704SAndrew Thompson udev->ctrl_ep_desc.wMaxPacketSize[1] = 0; 15835b3bb704SAndrew Thompson udev->ctrl_ep_desc.bInterval = 0; 1584963169b4SHans Petter Selasky 1585963169b4SHans Petter Selasky /* set up default endpoint companion descriptor */ 1586963169b4SHans Petter Selasky udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc); 1587963169b4SHans Petter Selasky udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP; 1588963169b4SHans Petter Selasky 158902ac6454SAndrew Thompson udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET; 159002ac6454SAndrew Thompson 159102ac6454SAndrew Thompson udev->speed = speed; 1592f29a0724SAndrew Thompson udev->flags.usb_mode = mode; 159302ac6454SAndrew Thompson 159402ac6454SAndrew Thompson /* search for our High Speed USB HUB, if any */ 159502ac6454SAndrew Thompson 159602ac6454SAndrew Thompson adev = udev; 159702ac6454SAndrew Thompson hub = udev->parent_hub; 159802ac6454SAndrew Thompson 159902ac6454SAndrew Thompson while (hub) { 160002ac6454SAndrew Thompson if (hub->speed == USB_SPEED_HIGH) { 160102ac6454SAndrew Thompson udev->hs_hub_addr = hub->address; 1602495f25ceSAndrew Thompson udev->parent_hs_hub = hub; 160302ac6454SAndrew Thompson udev->hs_port_no = adev->port_no; 160402ac6454SAndrew Thompson break; 160502ac6454SAndrew Thompson } 160602ac6454SAndrew Thompson adev = hub; 160702ac6454SAndrew Thompson hub = hub->parent_hub; 160802ac6454SAndrew Thompson } 160902ac6454SAndrew Thompson 1610ae60fdfbSAndrew Thompson /* init the default endpoint */ 1611a593f6b8SAndrew Thompson usb_init_endpoint(udev, 0, 16125b3bb704SAndrew Thompson &udev->ctrl_ep_desc, 1613963169b4SHans Petter Selasky &udev->ctrl_ep_comp_desc, 16145b3bb704SAndrew Thompson &udev->ctrl_ep); 161502ac6454SAndrew Thompson 161602ac6454SAndrew Thompson /* set device index */ 161702ac6454SAndrew Thompson udev->device_index = device_index; 161802ac6454SAndrew Thompson 16198755859aSAndrew Thompson #if USB_HAVE_UGEN 16200f6e8f93SAndrew Thompson /* Create ugen name */ 1621ee3e3ff5SAndrew Thompson snprintf(udev->ugen_name, sizeof(udev->ugen_name), 1622ee3e3ff5SAndrew Thompson USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev), 1623ee3e3ff5SAndrew Thompson device_index); 16248755859aSAndrew Thompson LIST_INIT(&udev->pd_list); 16258755859aSAndrew Thompson 16260f6e8f93SAndrew Thompson /* Create the control endpoint device */ 16272ffd5fdcSHans Petter Selasky udev->ctrl_dev = usb_make_dev(udev, NULL, 0, 0, 16282ffd5fdcSHans Petter Selasky FREAD|FWRITE, UID_ROOT, GID_OPERATOR, 0600); 16290f6e8f93SAndrew Thompson 16300f6e8f93SAndrew Thompson /* Create a link from /dev/ugenX.X to the default endpoint */ 16312ffd5fdcSHans Petter Selasky if (udev->ctrl_dev != NULL) 16322ffd5fdcSHans Petter Selasky make_dev_alias(udev->ctrl_dev->cdev, "%s", udev->ugen_name); 16330f6e8f93SAndrew Thompson #endif 1634963169b4SHans Petter Selasky /* Initialise device */ 1635963169b4SHans Petter Selasky if (bus->methods->device_init != NULL) { 1636963169b4SHans Petter Selasky err = (bus->methods->device_init) (udev); 1637963169b4SHans Petter Selasky if (err != 0) { 1638963169b4SHans Petter Selasky DPRINTFN(0, "device init %d failed " 1639963169b4SHans Petter Selasky "(%s, ignored)\n", device_index, 1640963169b4SHans Petter Selasky usbd_errstr(err)); 1641963169b4SHans Petter Selasky goto done; 1642963169b4SHans Petter Selasky } 1643963169b4SHans Petter Selasky } 1644963169b4SHans Petter Selasky /* set powered device state after device init is complete */ 1645963169b4SHans Petter Selasky usb_set_device_state(udev, USB_STATE_POWERED); 1646963169b4SHans Petter Selasky 1647f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_HOST) { 164802ac6454SAndrew Thompson 1649a593f6b8SAndrew Thompson err = usbd_req_set_address(udev, NULL, device_index); 165002ac6454SAndrew Thompson 1651963169b4SHans Petter Selasky /* 1652963169b4SHans Petter Selasky * This is the new USB device address from now on, if 1653963169b4SHans Petter Selasky * the set address request didn't set it already. 1654963169b4SHans Petter Selasky */ 1655963169b4SHans Petter Selasky if (udev->address == USB_START_ADDR) 165602ac6454SAndrew Thompson udev->address = device_index; 165702ac6454SAndrew Thompson 165802ac6454SAndrew Thompson /* 165902ac6454SAndrew Thompson * We ignore any set-address errors, hence there are 166002ac6454SAndrew Thompson * buggy USB devices out there that actually receive 166102ac6454SAndrew Thompson * the SETUP PID, but manage to set the address before 166202ac6454SAndrew Thompson * the STATUS stage is ACK'ed. If the device responds 166302ac6454SAndrew Thompson * to the subsequent get-descriptor at the new 166402ac6454SAndrew Thompson * address, then we know that the set-address command 166502ac6454SAndrew Thompson * was successful. 166602ac6454SAndrew Thompson */ 166702ac6454SAndrew Thompson if (err) { 166802ac6454SAndrew Thompson DPRINTFN(0, "set address %d failed " 166903797f33SAndrew Thompson "(%s, ignored)\n", udev->address, 1670a593f6b8SAndrew Thompson usbd_errstr(err)); 167102ac6454SAndrew Thompson } 167202ac6454SAndrew Thompson } else { 167302ac6454SAndrew Thompson /* We are not self powered */ 167402ac6454SAndrew Thompson udev->flags.self_powered = 0; 167502ac6454SAndrew Thompson 167602ac6454SAndrew Thompson /* Set unconfigured state */ 167702ac6454SAndrew Thompson udev->curr_config_no = USB_UNCONFIG_NO; 167802ac6454SAndrew Thompson udev->curr_config_index = USB_UNCONFIG_INDEX; 167902ac6454SAndrew Thompson 168002ac6454SAndrew Thompson /* Setup USB descriptors */ 1681a593f6b8SAndrew Thompson err = (usb_temp_setup_by_index_p) (udev, usb_template); 168202ac6454SAndrew Thompson if (err) { 168302ac6454SAndrew Thompson DPRINTFN(0, "setting up USB template failed maybe the USB " 168402ac6454SAndrew Thompson "template module has not been loaded\n"); 168502ac6454SAndrew Thompson goto done; 168602ac6454SAndrew Thompson } 168702ac6454SAndrew Thompson } 1688a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_ADDRESSED); 168902ac6454SAndrew Thompson 1690963169b4SHans Petter Selasky /* setup the device descriptor and the initial "wMaxPacketSize" */ 1691963169b4SHans Petter Selasky err = usbd_setup_device_desc(udev, NULL); 1692963169b4SHans Petter Selasky 1693963169b4SHans Petter Selasky if (err != 0) { 169402ac6454SAndrew Thompson /* XXX try to re-enumerate the device */ 1695a593f6b8SAndrew Thompson err = usbd_req_re_enumerate(udev, NULL); 1696963169b4SHans Petter Selasky if (err) 169702ac6454SAndrew Thompson goto done; 169802ac6454SAndrew Thompson } 169902ac6454SAndrew Thompson 170002ac6454SAndrew Thompson /* 170102ac6454SAndrew Thompson * Setup temporary USB attach args so that we can figure out some 170202ac6454SAndrew Thompson * basic quirks for this device. 170302ac6454SAndrew Thompson */ 1704a593f6b8SAndrew Thompson usb_init_attach_arg(udev, &uaa); 170502ac6454SAndrew Thompson 1706a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) { 170702ac6454SAndrew Thompson udev->flags.uq_bus_powered = 1; 170802ac6454SAndrew Thompson } 1709a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) { 171002ac6454SAndrew Thompson udev->flags.no_strings = 1; 171102ac6454SAndrew Thompson } 171202ac6454SAndrew Thompson /* 171302ac6454SAndrew Thompson * Workaround for buggy USB devices. 171402ac6454SAndrew Thompson * 171502ac6454SAndrew Thompson * It appears that some string-less USB chips will crash and 171602ac6454SAndrew Thompson * disappear if any attempts are made to read any string 171702ac6454SAndrew Thompson * descriptors. 171802ac6454SAndrew Thompson * 171902ac6454SAndrew Thompson * Try to detect such chips by checking the strings in the USB 172002ac6454SAndrew Thompson * device descriptor. If no strings are present there we 172102ac6454SAndrew Thompson * simply disable all USB strings. 172202ac6454SAndrew Thompson */ 172302ac6454SAndrew Thompson scratch_ptr = udev->bus->scratch[0].data; 172402ac6454SAndrew Thompson scratch_size = sizeof(udev->bus->scratch[0].data); 172502ac6454SAndrew Thompson 172602ac6454SAndrew Thompson if (udev->ddesc.iManufacturer || 172702ac6454SAndrew Thompson udev->ddesc.iProduct || 172802ac6454SAndrew Thompson udev->ddesc.iSerialNumber) { 172902ac6454SAndrew Thompson /* read out the language ID string */ 1730a593f6b8SAndrew Thompson err = usbd_req_get_string_desc(udev, NULL, 1731c10e1453SAndrew Thompson (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE); 173202ac6454SAndrew Thompson } else { 173302ac6454SAndrew Thompson err = USB_ERR_INVAL; 173402ac6454SAndrew Thompson } 173502ac6454SAndrew Thompson 173602ac6454SAndrew Thompson if (err || (scratch_ptr[0] < 4)) { 173702ac6454SAndrew Thompson udev->flags.no_strings = 1; 173802ac6454SAndrew Thompson } else { 17397a918edfSAndrew Thompson uint16_t langid; 17407a918edfSAndrew Thompson uint16_t pref; 17417a918edfSAndrew Thompson uint16_t mask; 17427a918edfSAndrew Thompson uint8_t x; 17437a918edfSAndrew Thompson 17447a918edfSAndrew Thompson /* load preferred value and mask */ 17457a918edfSAndrew Thompson pref = usb_lang_id; 17467a918edfSAndrew Thompson mask = usb_lang_mask; 17477a918edfSAndrew Thompson 17487a918edfSAndrew Thompson /* align length correctly */ 17497a918edfSAndrew Thompson scratch_ptr[0] &= ~1; 17507a918edfSAndrew Thompson 17517a918edfSAndrew Thompson /* fix compiler warning */ 17527a918edfSAndrew Thompson langid = 0; 17537a918edfSAndrew Thompson 17547a918edfSAndrew Thompson /* search for preferred language */ 17557a918edfSAndrew Thompson for (x = 2; (x < scratch_ptr[0]); x += 2) { 17567a918edfSAndrew Thompson langid = UGETW(scratch_ptr + x); 17577a918edfSAndrew Thompson if ((langid & mask) == pref) 17587a918edfSAndrew Thompson break; 17597a918edfSAndrew Thompson } 17607a918edfSAndrew Thompson if (x >= scratch_ptr[0]) { 176102ac6454SAndrew Thompson /* pick the first language as the default */ 17627a918edfSAndrew Thompson DPRINTFN(1, "Using first language\n"); 17637a918edfSAndrew Thompson langid = UGETW(scratch_ptr + 2); 17647a918edfSAndrew Thompson } 17657a918edfSAndrew Thompson 17667a918edfSAndrew Thompson DPRINTFN(1, "Language selected: 0x%04x\n", langid); 17677a918edfSAndrew Thompson udev->langid = langid; 176802ac6454SAndrew Thompson } 176902ac6454SAndrew Thompson 177002ac6454SAndrew Thompson /* assume 100mA bus powered for now. Changed when configured. */ 177102ac6454SAndrew Thompson udev->power = USB_MIN_POWER; 1772c86aead6SAndrew Thompson /* fetch the vendor and product strings from the device */ 1773a593f6b8SAndrew Thompson usbd_set_device_strings(udev); 177402ac6454SAndrew Thompson 17752a4c6157SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 17762a4c6157SAndrew Thompson /* USB device mode setup is complete */ 17772a4c6157SAndrew Thompson err = 0; 17782a4c6157SAndrew Thompson goto config_done; 17792a4c6157SAndrew Thompson } 178002ac6454SAndrew Thompson 178102ac6454SAndrew Thompson /* 178202ac6454SAndrew Thompson * Most USB devices should attach to config index 0 by 178302ac6454SAndrew Thompson * default 178402ac6454SAndrew Thompson */ 1785a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) { 178602ac6454SAndrew Thompson config_index = 0; 178702ac6454SAndrew Thompson config_quirk = 1; 1788a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) { 178902ac6454SAndrew Thompson config_index = 1; 179002ac6454SAndrew Thompson config_quirk = 1; 1791a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) { 179202ac6454SAndrew Thompson config_index = 2; 179302ac6454SAndrew Thompson config_quirk = 1; 1794a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) { 179502ac6454SAndrew Thompson config_index = 3; 179602ac6454SAndrew Thompson config_quirk = 1; 1797a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) { 179802ac6454SAndrew Thompson config_index = 4; 179902ac6454SAndrew Thompson config_quirk = 1; 180002ac6454SAndrew Thompson } else { 180102ac6454SAndrew Thompson config_index = 0; 180202ac6454SAndrew Thompson config_quirk = 0; 180302ac6454SAndrew Thompson } 180402ac6454SAndrew Thompson 18052a4c6157SAndrew Thompson set_config_failed = 0; 180602ac6454SAndrew Thompson repeat_set_config: 180702ac6454SAndrew Thompson 180802ac6454SAndrew Thompson DPRINTF("setting config %u\n", config_index); 180902ac6454SAndrew Thompson 181002ac6454SAndrew Thompson /* get the USB device configured */ 1811a593f6b8SAndrew Thompson err = usbd_set_config_index(udev, config_index); 181202ac6454SAndrew Thompson if (err) { 181302ac6454SAndrew Thompson if (udev->ddesc.bNumConfigurations != 0) { 181402ac6454SAndrew Thompson if (!set_config_failed) { 181502ac6454SAndrew Thompson set_config_failed = 1; 181602ac6454SAndrew Thompson /* XXX try to re-enumerate the device */ 18172a4c6157SAndrew Thompson err = usbd_req_re_enumerate(udev, NULL); 181802ac6454SAndrew Thompson if (err == 0) 181902ac6454SAndrew Thompson goto repeat_set_config; 182002ac6454SAndrew Thompson } 18212a4c6157SAndrew Thompson DPRINTFN(0, "Failure selecting configuration index %u:" 18222a4c6157SAndrew Thompson "%s, port %u, addr %u (ignored)\n", 1823a593f6b8SAndrew Thompson config_index, usbd_errstr(err), udev->port_no, 182402ac6454SAndrew Thompson udev->address); 182502ac6454SAndrew Thompson } 182602ac6454SAndrew Thompson /* 18272a4c6157SAndrew Thompson * Some USB devices do not have any configurations. Ignore any 18282a4c6157SAndrew Thompson * set config failures! 182902ac6454SAndrew Thompson */ 183002ac6454SAndrew Thompson err = 0; 18312a4c6157SAndrew Thompson goto config_done; 18322a4c6157SAndrew Thompson } 18332a4c6157SAndrew Thompson if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) { 183402ac6454SAndrew Thompson if ((udev->cdesc->bNumInterface < 2) && 18352a4c6157SAndrew Thompson usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) { 18362a4c6157SAndrew Thompson DPRINTFN(0, "Found no endpoints, trying next config\n"); 183702ac6454SAndrew Thompson config_index++; 183802ac6454SAndrew Thompson goto repeat_set_config; 183902ac6454SAndrew Thompson } 184002ac6454SAndrew Thompson if (config_index == 0) { 184102ac6454SAndrew Thompson /* 184202ac6454SAndrew Thompson * Try to figure out if we have an 184302ac6454SAndrew Thompson * auto-install disk there: 184402ac6454SAndrew Thompson */ 1845d84a79e7SAndrew Thompson if (usb_iface_is_cdrom(udev, 0)) { 184602ac6454SAndrew Thompson DPRINTFN(0, "Found possible auto-install " 184702ac6454SAndrew Thompson "disk (trying next config)\n"); 184802ac6454SAndrew Thompson config_index++; 184902ac6454SAndrew Thompson goto repeat_set_config; 185002ac6454SAndrew Thompson } 185102ac6454SAndrew Thompson } 18522a4c6157SAndrew Thompson } 185302ac6454SAndrew Thompson 18542a4c6157SAndrew Thompson config_done: 185502ac6454SAndrew Thompson DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n", 185602ac6454SAndrew Thompson udev->address, udev, udev->parent_hub); 185702ac6454SAndrew Thompson 185802ac6454SAndrew Thompson /* register our device - we are ready */ 1859a593f6b8SAndrew Thompson usb_bus_port_set_device(bus, parent_hub ? 186002ac6454SAndrew Thompson parent_hub->hub->ports + port_index : NULL, udev, device_index); 186102ac6454SAndrew Thompson 18620f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 18638755859aSAndrew Thompson /* Symlink the ugen device name */ 1864a593f6b8SAndrew Thompson udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name); 18658755859aSAndrew Thompson 18668755859aSAndrew Thompson /* Announce device */ 1867ae538d85SAndrew Thompson printf("%s: <%s> at %s\n", udev->ugen_name, 1868ae538d85SAndrew Thompson usb_get_manufacturer(udev), 186902ac6454SAndrew Thompson device_get_nameunit(udev->bus->bdev)); 18708bb77249SHans Petter Selasky #endif 18717efaaa9aSAndrew Thompson 18728bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 18733acd904dSAndrew Thompson usb_notify_addq("ATTACH", udev); 18748755859aSAndrew Thompson #endif 187502ac6454SAndrew Thompson done: 187602ac6454SAndrew Thompson if (err) { 1877d88688c7SAndrew Thompson /* 1878d88688c7SAndrew Thompson * Free USB device and all subdevices, if any. 1879d88688c7SAndrew Thompson */ 1880d88688c7SAndrew Thompson usb_free_device(udev, 0); 188102ac6454SAndrew Thompson udev = NULL; 188202ac6454SAndrew Thompson } 188302ac6454SAndrew Thompson return (udev); 188402ac6454SAndrew Thompson } 188502ac6454SAndrew Thompson 18860f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 18872ffd5fdcSHans Petter Selasky struct usb_fs_privdata * 18882ffd5fdcSHans Petter Selasky usb_make_dev(struct usb_device *udev, const char *devname, int ep, 18892ffd5fdcSHans Petter Selasky int fi, int rwmode, uid_t uid, gid_t gid, int mode) 1890ee3e3ff5SAndrew Thompson { 1891760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 18922ffd5fdcSHans Petter Selasky char buffer[32]; 1893ee3e3ff5SAndrew Thompson 1894ee3e3ff5SAndrew Thompson /* Store information to locate ourselves again later */ 1895760bc48eSAndrew Thompson pd = malloc(sizeof(struct usb_fs_privdata), M_USBDEV, 1896ee3e3ff5SAndrew Thompson M_WAITOK | M_ZERO); 1897ee3e3ff5SAndrew Thompson pd->bus_index = device_get_unit(udev->bus->bdev); 1898ee3e3ff5SAndrew Thompson pd->dev_index = udev->device_index; 1899ee3e3ff5SAndrew Thompson pd->ep_addr = ep; 19002ffd5fdcSHans Petter Selasky pd->fifo_index = fi; 19012ffd5fdcSHans Petter Selasky pd->mode = rwmode; 1902ee3e3ff5SAndrew Thompson 1903ee3e3ff5SAndrew Thompson /* Now, create the device itself */ 19042ffd5fdcSHans Petter Selasky if (devname == NULL) { 19052ffd5fdcSHans Petter Selasky devname = buffer; 19062ffd5fdcSHans Petter Selasky snprintf(buffer, sizeof(buffer), USB_DEVICE_DIR "/%u.%u.%u", 1907f35aaff0SAndrew Thompson pd->bus_index, pd->dev_index, pd->ep_addr); 19082ffd5fdcSHans Petter Selasky } 19092ffd5fdcSHans Petter Selasky 19102ffd5fdcSHans Petter Selasky pd->cdev = make_dev(&usb_devsw, 0, uid, gid, mode, "%s", devname); 19112ffd5fdcSHans Petter Selasky 19122ffd5fdcSHans Petter Selasky if (pd->cdev == NULL) { 19132ffd5fdcSHans Petter Selasky DPRINTFN(0, "Failed to create device %s\n", devname); 19142ffd5fdcSHans Petter Selasky free(pd, M_USBDEV); 19152ffd5fdcSHans Petter Selasky return (NULL); 19162ffd5fdcSHans Petter Selasky } 19172ffd5fdcSHans Petter Selasky 19182ffd5fdcSHans Petter Selasky /* XXX setting si_drv1 and creating the device is not atomic! */ 1919ee3e3ff5SAndrew Thompson pd->cdev->si_drv1 = pd; 1920ee3e3ff5SAndrew Thompson 19212ffd5fdcSHans Petter Selasky return (pd); 19222ffd5fdcSHans Petter Selasky } 19232ffd5fdcSHans Petter Selasky 19242ffd5fdcSHans Petter Selasky void 19252ffd5fdcSHans Petter Selasky usb_destroy_dev(struct usb_fs_privdata *pd) 19262ffd5fdcSHans Petter Selasky { 19272ffd5fdcSHans Petter Selasky if (pd == NULL) 19282ffd5fdcSHans Petter Selasky return; 19292ffd5fdcSHans Petter Selasky 19302ffd5fdcSHans Petter Selasky destroy_dev(pd->cdev); 19312ffd5fdcSHans Petter Selasky 19322ffd5fdcSHans Petter Selasky free(pd, M_USBDEV); 1933ee3e3ff5SAndrew Thompson } 1934ee3e3ff5SAndrew Thompson 1935ee3e3ff5SAndrew Thompson static void 1936a593f6b8SAndrew Thompson usb_cdev_create(struct usb_device *udev) 1937ee3e3ff5SAndrew Thompson { 1938760bc48eSAndrew Thompson struct usb_config_descriptor *cd; 1939760bc48eSAndrew Thompson struct usb_endpoint_descriptor *ed; 1940760bc48eSAndrew Thompson struct usb_descriptor *desc; 1941760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 1942f5f145baSAndrew Thompson int inmode, outmode, inmask, outmask, mode; 1943f5f145baSAndrew Thompson uint8_t ep; 1944ee3e3ff5SAndrew Thompson 1945ee3e3ff5SAndrew Thompson KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries")); 1946ee3e3ff5SAndrew Thompson 1947ee3e3ff5SAndrew Thompson DPRINTFN(2, "Creating device nodes\n"); 1948ee3e3ff5SAndrew Thompson 1949a593f6b8SAndrew Thompson if (usbd_get_mode(udev) == USB_MODE_DEVICE) { 1950ee3e3ff5SAndrew Thompson inmode = FWRITE; 1951ee3e3ff5SAndrew Thompson outmode = FREAD; 1952ee3e3ff5SAndrew Thompson } else { /* USB_MODE_HOST */ 1953ee3e3ff5SAndrew Thompson inmode = FREAD; 1954ee3e3ff5SAndrew Thompson outmode = FWRITE; 1955ee3e3ff5SAndrew Thompson } 1956ee3e3ff5SAndrew Thompson 1957f5f145baSAndrew Thompson inmask = 0; 1958f5f145baSAndrew Thompson outmask = 0; 1959f5f145baSAndrew Thompson desc = NULL; 1960f5f145baSAndrew Thompson 1961f5f145baSAndrew Thompson /* 1962f5f145baSAndrew Thompson * Collect all used endpoint numbers instead of just 1963f5f145baSAndrew Thompson * generating 16 static endpoints. 1964f5f145baSAndrew Thompson */ 1965a593f6b8SAndrew Thompson cd = usbd_get_config_descriptor(udev); 1966a593f6b8SAndrew Thompson while ((desc = usb_desc_foreach(cd, desc))) { 1967f5f145baSAndrew Thompson /* filter out all endpoint descriptors */ 1968f5f145baSAndrew Thompson if ((desc->bDescriptorType == UDESC_ENDPOINT) && 1969f5f145baSAndrew Thompson (desc->bLength >= sizeof(*ed))) { 1970760bc48eSAndrew Thompson ed = (struct usb_endpoint_descriptor *)desc; 1971f5f145baSAndrew Thompson 1972f5f145baSAndrew Thompson /* update masks */ 1973f5f145baSAndrew Thompson ep = ed->bEndpointAddress; 1974f5f145baSAndrew Thompson if (UE_GET_DIR(ep) == UE_DIR_OUT) 1975f5f145baSAndrew Thompson outmask |= 1 << UE_GET_ADDR(ep); 1976f5f145baSAndrew Thompson else 1977f5f145baSAndrew Thompson inmask |= 1 << UE_GET_ADDR(ep); 1978f5f145baSAndrew Thompson } 1979f5f145baSAndrew Thompson } 1980ee3e3ff5SAndrew Thompson 1981ee3e3ff5SAndrew Thompson /* Create all available endpoints except EP0 */ 1982ee3e3ff5SAndrew Thompson for (ep = 1; ep < 16; ep++) { 19832ffd5fdcSHans Petter Selasky mode = (inmask & (1 << ep)) ? inmode : 0; 19842ffd5fdcSHans Petter Selasky mode |= (outmask & (1 << ep)) ? outmode : 0; 1985ee3e3ff5SAndrew Thompson if (mode == 0) 1986ee3e3ff5SAndrew Thompson continue; /* no IN or OUT endpoint */ 1987ee3e3ff5SAndrew Thompson 19882ffd5fdcSHans Petter Selasky pd = usb_make_dev(udev, NULL, ep, 0, 19892ffd5fdcSHans Petter Selasky mode, UID_ROOT, GID_OPERATOR, 0600); 19902ffd5fdcSHans Petter Selasky 19912ffd5fdcSHans Petter Selasky if (pd != NULL) 1992ee3e3ff5SAndrew Thompson LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next); 1993ee3e3ff5SAndrew Thompson } 1994ee3e3ff5SAndrew Thompson } 1995ee3e3ff5SAndrew Thompson 1996ee3e3ff5SAndrew Thompson static void 1997a593f6b8SAndrew Thompson usb_cdev_free(struct usb_device *udev) 1998ee3e3ff5SAndrew Thompson { 1999760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 2000ee3e3ff5SAndrew Thompson 2001ee3e3ff5SAndrew Thompson DPRINTFN(2, "Freeing device nodes\n"); 2002ee3e3ff5SAndrew Thompson 2003ee3e3ff5SAndrew Thompson while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) { 2004ee3e3ff5SAndrew Thompson KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt")); 2005ee3e3ff5SAndrew Thompson 2006ee3e3ff5SAndrew Thompson LIST_REMOVE(pd, pd_next); 2007ee3e3ff5SAndrew Thompson 20082ffd5fdcSHans Petter Selasky usb_destroy_dev(pd); 20092ffd5fdcSHans Petter Selasky } 2010ee3e3ff5SAndrew Thompson } 20110f6e8f93SAndrew Thompson #endif 2012ee3e3ff5SAndrew Thompson 201302ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2014a593f6b8SAndrew Thompson * usb_free_device 201502ac6454SAndrew Thompson * 2016d88688c7SAndrew Thompson * This function is NULL safe and will free an USB device and its 2017d88688c7SAndrew Thompson * children devices, if any. 2018bdd41206SAndrew Thompson * 2019d88688c7SAndrew Thompson * Flag values: Reserved, set to zero. 202002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 202102ac6454SAndrew Thompson void 2022a593f6b8SAndrew Thompson usb_free_device(struct usb_device *udev, uint8_t flag) 202302ac6454SAndrew Thompson { 2024760bc48eSAndrew Thompson struct usb_bus *bus; 2025bdd41206SAndrew Thompson 2026bdd41206SAndrew Thompson if (udev == NULL) 2027bdd41206SAndrew Thompson return; /* already freed */ 202802ac6454SAndrew Thompson 202902ac6454SAndrew Thompson DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no); 203002ac6454SAndrew Thompson 2031bd216778SAndrew Thompson bus = udev->bus; 2032a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_DETACHED); 2033bdd41206SAndrew Thompson 20348bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 20353acd904dSAndrew Thompson usb_notify_addq("DETACH", udev); 20368bb77249SHans Petter Selasky #endif 203702ac6454SAndrew Thompson 20388bb77249SHans Petter Selasky #if USB_HAVE_UGEN 2039ee3e3ff5SAndrew Thompson printf("%s: <%s> at %s (disconnected)\n", udev->ugen_name, 2040ae538d85SAndrew Thompson usb_get_manufacturer(udev), device_get_nameunit(bus->bdev)); 204102ac6454SAndrew Thompson 2042ee3e3ff5SAndrew Thompson /* Destroy UGEN symlink, if any */ 204302ac6454SAndrew Thompson if (udev->ugen_symlink) { 2044a593f6b8SAndrew Thompson usb_free_symlink(udev->ugen_symlink); 204502ac6454SAndrew Thompson udev->ugen_symlink = NULL; 204602ac6454SAndrew Thompson } 20478755859aSAndrew Thompson #endif 204802ac6454SAndrew Thompson /* 204902ac6454SAndrew Thompson * Unregister our device first which will prevent any further 205002ac6454SAndrew Thompson * references: 205102ac6454SAndrew Thompson */ 2052a593f6b8SAndrew Thompson usb_bus_port_set_device(bus, udev->parent_hub ? 205302ac6454SAndrew Thompson udev->parent_hub->hub->ports + udev->port_index : NULL, 205402ac6454SAndrew Thompson NULL, USB_ROOT_HUB_ADDR); 205502ac6454SAndrew Thompson 20560f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 205702ac6454SAndrew Thompson /* wait for all pending references to go away: */ 2058a593f6b8SAndrew Thompson mtx_lock(&usb_ref_lock); 205902ac6454SAndrew Thompson udev->refcount--; 206002ac6454SAndrew Thompson while (udev->refcount != 0) { 206191cd9240SAndrew Thompson cv_wait(&udev->ref_cv, &usb_ref_lock); 206202ac6454SAndrew Thompson } 2063a593f6b8SAndrew Thompson mtx_unlock(&usb_ref_lock); 2064bdd41206SAndrew Thompson 20652ffd5fdcSHans Petter Selasky usb_destroy_dev(udev->ctrl_dev); 20660f6e8f93SAndrew Thompson #endif 206702ac6454SAndrew Thompson 2068f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 206902ac6454SAndrew Thompson /* stop receiving any control transfers (Device Side Mode) */ 20705b3bb704SAndrew Thompson usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX); 207102ac6454SAndrew Thompson } 207202ac6454SAndrew Thompson 2073bdd41206SAndrew Thompson /* the following will get the device unconfigured in software */ 2074d88688c7SAndrew Thompson usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0); 207502ac6454SAndrew Thompson 207602ac6454SAndrew Thompson /* unsetup any leftover default USB transfers */ 20775b3bb704SAndrew Thompson usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX); 207802ac6454SAndrew Thompson 207902ac6454SAndrew Thompson /* template unsetup, if any */ 2080a593f6b8SAndrew Thompson (usb_temp_unsetup_p) (udev); 208102ac6454SAndrew Thompson 208202ac6454SAndrew Thompson /* 208302ac6454SAndrew Thompson * Make sure that our clear-stall messages are not queued 208402ac6454SAndrew Thompson * anywhere: 208502ac6454SAndrew Thompson */ 208602ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 2087a593f6b8SAndrew Thompson usb_proc_mwait(&udev->bus->non_giant_callback_proc, 208802ac6454SAndrew Thompson &udev->cs_msg[0], &udev->cs_msg[1]); 208902ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 209002ac6454SAndrew Thompson 209191cd9240SAndrew Thompson sx_destroy(&udev->ctrl_sx); 209291cd9240SAndrew Thompson sx_destroy(&udev->enum_sx); 20932df1e9a6SAndrew Thompson sx_destroy(&udev->sr_sx); 209402ac6454SAndrew Thompson 209591cd9240SAndrew Thompson cv_destroy(&udev->ctrlreq_cv); 209691cd9240SAndrew Thompson cv_destroy(&udev->ref_cv); 209702ac6454SAndrew Thompson 209891cd9240SAndrew Thompson mtx_destroy(&udev->device_mtx); 20998755859aSAndrew Thompson #if USB_HAVE_UGEN 2100ee3e3ff5SAndrew Thompson KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries")); 21018755859aSAndrew Thompson #endif 210202ac6454SAndrew Thompson 2103963169b4SHans Petter Selasky /* Uninitialise device */ 2104963169b4SHans Petter Selasky if (bus->methods->device_uninit != NULL) 2105963169b4SHans Petter Selasky (bus->methods->device_uninit) (udev); 2106963169b4SHans Petter Selasky 210702ac6454SAndrew Thompson /* free device */ 210828212de2SAndrew Thompson free(udev->serial, M_USB); 210928212de2SAndrew Thompson free(udev->manufacturer, M_USB); 211028212de2SAndrew Thompson free(udev->product, M_USB); 211102ac6454SAndrew Thompson free(udev, M_USB); 211202ac6454SAndrew Thompson } 211302ac6454SAndrew Thompson 211402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2115a593f6b8SAndrew Thompson * usbd_get_iface 211602ac6454SAndrew Thompson * 211702ac6454SAndrew Thompson * This function is the safe way to get the USB interface structure 211802ac6454SAndrew Thompson * pointer by interface index. 211902ac6454SAndrew Thompson * 212002ac6454SAndrew Thompson * Return values: 212102ac6454SAndrew Thompson * NULL: Interface not present. 212202ac6454SAndrew Thompson * Else: Pointer to USB interface structure. 212302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 2124760bc48eSAndrew Thompson struct usb_interface * 2125a593f6b8SAndrew Thompson usbd_get_iface(struct usb_device *udev, uint8_t iface_index) 212602ac6454SAndrew Thompson { 2127760bc48eSAndrew Thompson struct usb_interface *iface = udev->ifaces + iface_index; 212802ac6454SAndrew Thompson 2129bdd41206SAndrew Thompson if (iface_index >= udev->ifaces_max) 213002ac6454SAndrew Thompson return (NULL); 213102ac6454SAndrew Thompson return (iface); 213202ac6454SAndrew Thompson } 213302ac6454SAndrew Thompson 213402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 21353c8d24f4SAndrew Thompson * usbd_find_descriptor 213602ac6454SAndrew Thompson * 213702ac6454SAndrew Thompson * This function will lookup the first descriptor that matches the 213802ac6454SAndrew Thompson * criteria given by the arguments "type" and "subtype". Descriptors 213902ac6454SAndrew Thompson * will only be searched within the interface having the index 214002ac6454SAndrew Thompson * "iface_index". If the "id" argument points to an USB descriptor, 214102ac6454SAndrew Thompson * it will be skipped before the search is started. This allows 214202ac6454SAndrew Thompson * searching for multiple descriptors using the same criteria. Else 214302ac6454SAndrew Thompson * the search is started after the interface descriptor. 214402ac6454SAndrew Thompson * 214502ac6454SAndrew Thompson * Return values: 214602ac6454SAndrew Thompson * NULL: End of descriptors 214702ac6454SAndrew Thompson * Else: A descriptor matching the criteria 214802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 214902ac6454SAndrew Thompson void * 21503c8d24f4SAndrew Thompson usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index, 215102ac6454SAndrew Thompson uint8_t type, uint8_t type_mask, 215202ac6454SAndrew Thompson uint8_t subtype, uint8_t subtype_mask) 215302ac6454SAndrew Thompson { 2154760bc48eSAndrew Thompson struct usb_descriptor *desc; 2155760bc48eSAndrew Thompson struct usb_config_descriptor *cd; 2156760bc48eSAndrew Thompson struct usb_interface *iface; 215702ac6454SAndrew Thompson 2158a593f6b8SAndrew Thompson cd = usbd_get_config_descriptor(udev); 215902ac6454SAndrew Thompson if (cd == NULL) { 216002ac6454SAndrew Thompson return (NULL); 216102ac6454SAndrew Thompson } 216202ac6454SAndrew Thompson if (id == NULL) { 2163a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, iface_index); 216402ac6454SAndrew Thompson if (iface == NULL) { 216502ac6454SAndrew Thompson return (NULL); 216602ac6454SAndrew Thompson } 2167a593f6b8SAndrew Thompson id = usbd_get_interface_descriptor(iface); 216802ac6454SAndrew Thompson if (id == NULL) { 216902ac6454SAndrew Thompson return (NULL); 217002ac6454SAndrew Thompson } 217102ac6454SAndrew Thompson } 217202ac6454SAndrew Thompson desc = (void *)id; 217302ac6454SAndrew Thompson 2174a593f6b8SAndrew Thompson while ((desc = usb_desc_foreach(cd, desc))) { 217502ac6454SAndrew Thompson 217602ac6454SAndrew Thompson if (desc->bDescriptorType == UDESC_INTERFACE) { 217702ac6454SAndrew Thompson break; 217802ac6454SAndrew Thompson } 217902ac6454SAndrew Thompson if (((desc->bDescriptorType & type_mask) == type) && 218002ac6454SAndrew Thompson ((desc->bDescriptorSubtype & subtype_mask) == subtype)) { 218102ac6454SAndrew Thompson return (desc); 218202ac6454SAndrew Thompson } 218302ac6454SAndrew Thompson } 218402ac6454SAndrew Thompson return (NULL); 218502ac6454SAndrew Thompson } 218602ac6454SAndrew Thompson 218702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2188a593f6b8SAndrew Thompson * usb_devinfo 218902ac6454SAndrew Thompson * 219002ac6454SAndrew Thompson * This function will dump information from the device descriptor 219102ac6454SAndrew Thompson * belonging to the USB device pointed to by "udev", to the string 219202ac6454SAndrew Thompson * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes 219302ac6454SAndrew Thompson * including the terminating zero. 219402ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 219502ac6454SAndrew Thompson void 2196a593f6b8SAndrew Thompson usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len) 219702ac6454SAndrew Thompson { 2198760bc48eSAndrew Thompson struct usb_device_descriptor *udd = &udev->ddesc; 219902ac6454SAndrew Thompson uint16_t bcdDevice; 220002ac6454SAndrew Thompson uint16_t bcdUSB; 220102ac6454SAndrew Thompson 220202ac6454SAndrew Thompson bcdUSB = UGETW(udd->bcdUSB); 220302ac6454SAndrew Thompson bcdDevice = UGETW(udd->bcdDevice); 220402ac6454SAndrew Thompson 220502ac6454SAndrew Thompson if (udd->bDeviceClass != 0xFF) { 220602ac6454SAndrew Thompson snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/" 22078755859aSAndrew Thompson "%x.%02x, addr %d", 2208ae538d85SAndrew Thompson usb_get_manufacturer(udev), 2209ae538d85SAndrew Thompson usb_get_product(udev), 221002ac6454SAndrew Thompson udd->bDeviceClass, udd->bDeviceSubClass, 221102ac6454SAndrew Thompson (bcdUSB >> 8), bcdUSB & 0xFF, 221202ac6454SAndrew Thompson (bcdDevice >> 8), bcdDevice & 0xFF, 221302ac6454SAndrew Thompson udev->address); 221402ac6454SAndrew Thompson } else { 221502ac6454SAndrew Thompson snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/" 22168755859aSAndrew Thompson "%x.%02x, addr %d", 2217ae538d85SAndrew Thompson usb_get_manufacturer(udev), 2218ae538d85SAndrew Thompson usb_get_product(udev), 221902ac6454SAndrew Thompson (bcdUSB >> 8), bcdUSB & 0xFF, 222002ac6454SAndrew Thompson (bcdDevice >> 8), bcdDevice & 0xFF, 222102ac6454SAndrew Thompson udev->address); 222202ac6454SAndrew Thompson } 222302ac6454SAndrew Thompson } 222402ac6454SAndrew Thompson 2225ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 222602ac6454SAndrew Thompson /* 222702ac6454SAndrew Thompson * Descriptions of of known vendors and devices ("products"). 222802ac6454SAndrew Thompson */ 222902ac6454SAndrew Thompson struct usb_knowndev { 223002ac6454SAndrew Thompson uint16_t vendor; 223102ac6454SAndrew Thompson uint16_t product; 223202ac6454SAndrew Thompson uint32_t flags; 223302ac6454SAndrew Thompson const char *vendorname; 223402ac6454SAndrew Thompson const char *productname; 223502ac6454SAndrew Thompson }; 223602ac6454SAndrew Thompson 223702ac6454SAndrew Thompson #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */ 223802ac6454SAndrew Thompson 223902ac6454SAndrew Thompson #include "usbdevs.h" 224002ac6454SAndrew Thompson #include "usbdevs_data.h" 224102ac6454SAndrew Thompson #endif /* USB_VERBOSE */ 224202ac6454SAndrew Thompson 224302ac6454SAndrew Thompson static void 2244a593f6b8SAndrew Thompson usbd_set_device_strings(struct usb_device *udev) 224502ac6454SAndrew Thompson { 2246760bc48eSAndrew Thompson struct usb_device_descriptor *udd = &udev->ddesc; 2247ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 224802ac6454SAndrew Thompson const struct usb_knowndev *kdp; 224902ac6454SAndrew Thompson #endif 22502df1e9a6SAndrew Thompson char *temp_ptr; 22517a918edfSAndrew Thompson size_t temp_size; 225202ac6454SAndrew Thompson uint16_t vendor_id; 225302ac6454SAndrew Thompson uint16_t product_id; 225402ac6454SAndrew Thompson 22552df1e9a6SAndrew Thompson temp_ptr = (char *)udev->bus->scratch[0].data; 22567a918edfSAndrew Thompson temp_size = sizeof(udev->bus->scratch[0].data); 22577a918edfSAndrew Thompson 225802ac6454SAndrew Thompson vendor_id = UGETW(udd->idVendor); 225902ac6454SAndrew Thompson product_id = UGETW(udd->idProduct); 226002ac6454SAndrew Thompson 2261c86aead6SAndrew Thompson /* get serial number string */ 22627a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2263c86aead6SAndrew Thompson udev->ddesc.iSerialNumber); 22647a918edfSAndrew Thompson udev->serial = strdup(temp_ptr, M_USB); 226502ac6454SAndrew Thompson 2266c86aead6SAndrew Thompson /* get manufacturer string */ 22677a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2268c86aead6SAndrew Thompson udev->ddesc.iManufacturer); 22697a918edfSAndrew Thompson usb_trim_spaces(temp_ptr); 22707a918edfSAndrew Thompson if (temp_ptr[0] != '\0') 22717a918edfSAndrew Thompson udev->manufacturer = strdup(temp_ptr, M_USB); 2272c86aead6SAndrew Thompson 2273c86aead6SAndrew Thompson /* get product string */ 22747a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2275c86aead6SAndrew Thompson udev->ddesc.iProduct); 22767a918edfSAndrew Thompson usb_trim_spaces(temp_ptr); 22777a918edfSAndrew Thompson if (temp_ptr[0] != '\0') 22787a918edfSAndrew Thompson udev->product = strdup(temp_ptr, M_USB); 2279c86aead6SAndrew Thompson 2280ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 2281c86aead6SAndrew Thompson if (udev->manufacturer == NULL || udev->product == NULL) { 2282c86aead6SAndrew Thompson for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) { 228302ac6454SAndrew Thompson if (kdp->vendor == vendor_id && 228402ac6454SAndrew Thompson (kdp->product == product_id || 228502ac6454SAndrew Thompson (kdp->flags & USB_KNOWNDEV_NOPROD) != 0)) 228602ac6454SAndrew Thompson break; 228702ac6454SAndrew Thompson } 228802ac6454SAndrew Thompson if (kdp->vendorname != NULL) { 2289c86aead6SAndrew Thompson /* XXX should use pointer to knowndevs string */ 2290c86aead6SAndrew Thompson if (udev->manufacturer == NULL) { 2291c86aead6SAndrew Thompson udev->manufacturer = strdup(kdp->vendorname, 2292c86aead6SAndrew Thompson M_USB); 2293c86aead6SAndrew Thompson } 2294c86aead6SAndrew Thompson if (udev->product == NULL && 2295c86aead6SAndrew Thompson (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) { 2296c86aead6SAndrew Thompson udev->product = strdup(kdp->productname, 2297c86aead6SAndrew Thompson M_USB); 2298c86aead6SAndrew Thompson } 229902ac6454SAndrew Thompson } 230002ac6454SAndrew Thompson } 230102ac6454SAndrew Thompson #endif 2302c86aead6SAndrew Thompson /* Provide default strings if none were found */ 2303c86aead6SAndrew Thompson if (udev->manufacturer == NULL) { 23047a918edfSAndrew Thompson snprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id); 23057a918edfSAndrew Thompson udev->manufacturer = strdup(temp_ptr, M_USB); 230602ac6454SAndrew Thompson } 2307c86aead6SAndrew Thompson if (udev->product == NULL) { 23087a918edfSAndrew Thompson snprintf(temp_ptr, temp_size, "product 0x%04x", product_id); 23097a918edfSAndrew Thompson udev->product = strdup(temp_ptr, M_USB); 231002ac6454SAndrew Thompson } 231102ac6454SAndrew Thompson } 231202ac6454SAndrew Thompson 231302ac6454SAndrew Thompson /* 231402ac6454SAndrew Thompson * Returns: 231502ac6454SAndrew Thompson * See: USB_MODE_XXX 231602ac6454SAndrew Thompson */ 2317f29a0724SAndrew Thompson enum usb_hc_mode 2318a593f6b8SAndrew Thompson usbd_get_mode(struct usb_device *udev) 231902ac6454SAndrew Thompson { 2320f29a0724SAndrew Thompson return (udev->flags.usb_mode); 232102ac6454SAndrew Thompson } 232202ac6454SAndrew Thompson 232302ac6454SAndrew Thompson /* 232402ac6454SAndrew Thompson * Returns: 232502ac6454SAndrew Thompson * See: USB_SPEED_XXX 232602ac6454SAndrew Thompson */ 23278d2dd5ddSAndrew Thompson enum usb_dev_speed 2328a593f6b8SAndrew Thompson usbd_get_speed(struct usb_device *udev) 232902ac6454SAndrew Thompson { 233002ac6454SAndrew Thompson return (udev->speed); 233102ac6454SAndrew Thompson } 233202ac6454SAndrew Thompson 233302ac6454SAndrew Thompson uint32_t 2334a593f6b8SAndrew Thompson usbd_get_isoc_fps(struct usb_device *udev) 233502ac6454SAndrew Thompson { 233602ac6454SAndrew Thompson ; /* indent fix */ 233702ac6454SAndrew Thompson switch (udev->speed) { 233802ac6454SAndrew Thompson case USB_SPEED_LOW: 233902ac6454SAndrew Thompson case USB_SPEED_FULL: 234002ac6454SAndrew Thompson return (1000); 234102ac6454SAndrew Thompson default: 234202ac6454SAndrew Thompson return (8000); 234302ac6454SAndrew Thompson } 234402ac6454SAndrew Thompson } 234502ac6454SAndrew Thompson 2346760bc48eSAndrew Thompson struct usb_device_descriptor * 2347a593f6b8SAndrew Thompson usbd_get_device_descriptor(struct usb_device *udev) 234802ac6454SAndrew Thompson { 234902ac6454SAndrew Thompson if (udev == NULL) 235002ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 235102ac6454SAndrew Thompson return (&udev->ddesc); 235202ac6454SAndrew Thompson } 235302ac6454SAndrew Thompson 2354760bc48eSAndrew Thompson struct usb_config_descriptor * 2355a593f6b8SAndrew Thompson usbd_get_config_descriptor(struct usb_device *udev) 235602ac6454SAndrew Thompson { 235702ac6454SAndrew Thompson if (udev == NULL) 235802ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 235902ac6454SAndrew Thompson return (udev->cdesc); 236002ac6454SAndrew Thompson } 236102ac6454SAndrew Thompson 236202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2363a593f6b8SAndrew Thompson * usb_test_quirk - test a device for a given quirk 236402ac6454SAndrew Thompson * 236502ac6454SAndrew Thompson * Return values: 236602ac6454SAndrew Thompson * 0: The USB device does not have the given quirk. 236702ac6454SAndrew Thompson * Else: The USB device has the given quirk. 236802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 236902ac6454SAndrew Thompson uint8_t 2370a593f6b8SAndrew Thompson usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk) 237102ac6454SAndrew Thompson { 237202ac6454SAndrew Thompson uint8_t found; 237302ac6454SAndrew Thompson 2374a593f6b8SAndrew Thompson found = (usb_test_quirk_p) (&uaa->info, quirk); 237502ac6454SAndrew Thompson return (found); 237602ac6454SAndrew Thompson } 237702ac6454SAndrew Thompson 2378760bc48eSAndrew Thompson struct usb_interface_descriptor * 2379a593f6b8SAndrew Thompson usbd_get_interface_descriptor(struct usb_interface *iface) 238002ac6454SAndrew Thompson { 238102ac6454SAndrew Thompson if (iface == NULL) 238202ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 238302ac6454SAndrew Thompson return (iface->idesc); 238402ac6454SAndrew Thompson } 238502ac6454SAndrew Thompson 238602ac6454SAndrew Thompson uint8_t 2387a593f6b8SAndrew Thompson usbd_get_interface_altindex(struct usb_interface *iface) 238802ac6454SAndrew Thompson { 238902ac6454SAndrew Thompson return (iface->alt_index); 239002ac6454SAndrew Thompson } 239102ac6454SAndrew Thompson 239202ac6454SAndrew Thompson uint8_t 2393a593f6b8SAndrew Thompson usbd_get_bus_index(struct usb_device *udev) 239402ac6454SAndrew Thompson { 239502ac6454SAndrew Thompson return ((uint8_t)device_get_unit(udev->bus->bdev)); 239602ac6454SAndrew Thompson } 239702ac6454SAndrew Thompson 239802ac6454SAndrew Thompson uint8_t 2399a593f6b8SAndrew Thompson usbd_get_device_index(struct usb_device *udev) 240002ac6454SAndrew Thompson { 240102ac6454SAndrew Thompson return (udev->device_index); 240202ac6454SAndrew Thompson } 240302ac6454SAndrew Thompson 24048bb77249SHans Petter Selasky #if USB_HAVE_DEVCTL 24053acd904dSAndrew Thompson static void 24063acd904dSAndrew Thompson usb_notify_addq(const char *type, struct usb_device *udev) 24073acd904dSAndrew Thompson { 24083acd904dSAndrew Thompson struct usb_interface *iface; 24093acd904dSAndrew Thompson struct sbuf *sb; 24103acd904dSAndrew Thompson int i; 24113acd904dSAndrew Thompson 24123acd904dSAndrew Thompson /* announce the device */ 24133acd904dSAndrew Thompson sb = sbuf_new_auto(); 24143acd904dSAndrew Thompson sbuf_printf(sb, 24158bb77249SHans Petter Selasky #if USB_HAVE_UGEN 24168bb77249SHans Petter Selasky "ugen=%s " 241702c40241SHans Petter Selasky "cdev=%s " 24188bb77249SHans Petter Selasky #endif 24193acd904dSAndrew Thompson "vendor=0x%04x " 24203acd904dSAndrew Thompson "product=0x%04x " 24213acd904dSAndrew Thompson "devclass=0x%02x " 24223acd904dSAndrew Thompson "devsubclass=0x%02x " 24233acd904dSAndrew Thompson "sernum=\"%s\" " 24243acd904dSAndrew Thompson "release=0x%04x " 242566390216SAndrew Thompson "mode=%s " 24263acd904dSAndrew Thompson "port=%u " 24278bb77249SHans Petter Selasky #if USB_HAVE_UGEN 24286df3eebbSNick Hibma "parent=%s" 24298bb77249SHans Petter Selasky #endif 24308bb77249SHans Petter Selasky "", 24318bb77249SHans Petter Selasky #if USB_HAVE_UGEN 24323acd904dSAndrew Thompson udev->ugen_name, 243302c40241SHans Petter Selasky udev->ugen_name, 24348bb77249SHans Petter Selasky #endif 24353acd904dSAndrew Thompson UGETW(udev->ddesc.idVendor), 24363acd904dSAndrew Thompson UGETW(udev->ddesc.idProduct), 24373acd904dSAndrew Thompson udev->ddesc.bDeviceClass, 24383acd904dSAndrew Thompson udev->ddesc.bDeviceSubClass, 2439ae538d85SAndrew Thompson usb_get_serial(udev), 24403acd904dSAndrew Thompson UGETW(udev->ddesc.bcdDevice), 244166390216SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device", 24428bb77249SHans Petter Selasky udev->port_no 24438bb77249SHans Petter Selasky #if USB_HAVE_UGEN 24448bb77249SHans Petter Selasky , udev->parent_hub != NULL ? 24453acd904dSAndrew Thompson udev->parent_hub->ugen_name : 24468bb77249SHans Petter Selasky device_get_nameunit(device_get_parent(udev->bus->bdev)) 24478bb77249SHans Petter Selasky #endif 24488bb77249SHans Petter Selasky ); 24493acd904dSAndrew Thompson sbuf_finish(sb); 24503acd904dSAndrew Thompson devctl_notify("USB", "DEVICE", type, sbuf_data(sb)); 24513acd904dSAndrew Thompson sbuf_delete(sb); 24523acd904dSAndrew Thompson 24533acd904dSAndrew Thompson /* announce each interface */ 24543acd904dSAndrew Thompson for (i = 0; i < USB_IFACE_MAX; i++) { 24553acd904dSAndrew Thompson iface = usbd_get_iface(udev, i); 24563acd904dSAndrew Thompson if (iface == NULL) 24573acd904dSAndrew Thompson break; /* end of interfaces */ 24583acd904dSAndrew Thompson if (iface->idesc == NULL) 24593acd904dSAndrew Thompson continue; /* no interface descriptor */ 24603acd904dSAndrew Thompson 24613acd904dSAndrew Thompson sb = sbuf_new_auto(); 24623acd904dSAndrew Thompson sbuf_printf(sb, 24638bb77249SHans Petter Selasky #if USB_HAVE_UGEN 24648bb77249SHans Petter Selasky "ugen=%s " 246502c40241SHans Petter Selasky "cdev=%s " 24668bb77249SHans Petter Selasky #endif 24673acd904dSAndrew Thompson "vendor=0x%04x " 24683acd904dSAndrew Thompson "product=0x%04x " 24693acd904dSAndrew Thompson "devclass=0x%02x " 24703acd904dSAndrew Thompson "devsubclass=0x%02x " 24713acd904dSAndrew Thompson "sernum=\"%s\" " 24723acd904dSAndrew Thompson "release=0x%04x " 247366390216SAndrew Thompson "mode=%s " 24743acd904dSAndrew Thompson "interface=%d " 24753acd904dSAndrew Thompson "endpoints=%d " 24763acd904dSAndrew Thompson "intclass=0x%02x " 24773acd904dSAndrew Thompson "intsubclass=0x%02x " 24786df3eebbSNick Hibma "intprotocol=0x%02x", 24798bb77249SHans Petter Selasky #if USB_HAVE_UGEN 24803acd904dSAndrew Thompson udev->ugen_name, 248102c40241SHans Petter Selasky udev->ugen_name, 24828bb77249SHans Petter Selasky #endif 24833acd904dSAndrew Thompson UGETW(udev->ddesc.idVendor), 24843acd904dSAndrew Thompson UGETW(udev->ddesc.idProduct), 24853acd904dSAndrew Thompson udev->ddesc.bDeviceClass, 24863acd904dSAndrew Thompson udev->ddesc.bDeviceSubClass, 2487ae538d85SAndrew Thompson usb_get_serial(udev), 24883acd904dSAndrew Thompson UGETW(udev->ddesc.bcdDevice), 248966390216SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device", 24903acd904dSAndrew Thompson iface->idesc->bInterfaceNumber, 24913acd904dSAndrew Thompson iface->idesc->bNumEndpoints, 24923acd904dSAndrew Thompson iface->idesc->bInterfaceClass, 24933acd904dSAndrew Thompson iface->idesc->bInterfaceSubClass, 24943acd904dSAndrew Thompson iface->idesc->bInterfaceProtocol); 24953acd904dSAndrew Thompson sbuf_finish(sb); 24963acd904dSAndrew Thompson devctl_notify("USB", "INTERFACE", type, sbuf_data(sb)); 24973acd904dSAndrew Thompson sbuf_delete(sb); 24983acd904dSAndrew Thompson } 24993acd904dSAndrew Thompson } 25008bb77249SHans Petter Selasky #endif 250102ac6454SAndrew Thompson 25028bb77249SHans Petter Selasky #if USB_HAVE_UGEN 250302ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2504a593f6b8SAndrew Thompson * usb_fifo_free_wrap 250502ac6454SAndrew Thompson * 250602ac6454SAndrew Thompson * This function will free the FIFOs. 250702ac6454SAndrew Thompson * 2508bdd41206SAndrew Thompson * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag 2509bdd41206SAndrew Thompson * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free 2510bdd41206SAndrew Thompson * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and 2511bdd41206SAndrew Thompson * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non 2512bdd41206SAndrew Thompson * control endpoint FIFOs. If "iface_index" is not set to 2513bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" the flag has no effect. 251402ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 251502ac6454SAndrew Thompson static void 2516a593f6b8SAndrew Thompson usb_fifo_free_wrap(struct usb_device *udev, 251702ac6454SAndrew Thompson uint8_t iface_index, uint8_t flag) 251802ac6454SAndrew Thompson { 2519760bc48eSAndrew Thompson struct usb_fifo *f; 252002ac6454SAndrew Thompson uint16_t i; 252102ac6454SAndrew Thompson 252202ac6454SAndrew Thompson /* 252302ac6454SAndrew Thompson * Free any USB FIFOs on the given interface: 252402ac6454SAndrew Thompson */ 252502ac6454SAndrew Thompson for (i = 0; i != USB_FIFO_MAX; i++) { 252602ac6454SAndrew Thompson f = udev->fifo[i]; 252702ac6454SAndrew Thompson if (f == NULL) { 252802ac6454SAndrew Thompson continue; 252902ac6454SAndrew Thompson } 253002ac6454SAndrew Thompson /* Check if the interface index matches */ 253102ac6454SAndrew Thompson if (iface_index == f->iface_index) { 2532a593f6b8SAndrew Thompson if (f->methods != &usb_ugen_methods) { 253302ac6454SAndrew Thompson /* 253402ac6454SAndrew Thompson * Don't free any non-generic FIFOs in 253502ac6454SAndrew Thompson * this case. 253602ac6454SAndrew Thompson */ 253702ac6454SAndrew Thompson continue; 253802ac6454SAndrew Thompson } 253902ac6454SAndrew Thompson if ((f->dev_ep_index == 0) && 254002ac6454SAndrew Thompson (f->fs_xfer == NULL)) { 254102ac6454SAndrew Thompson /* no need to free this FIFO */ 254202ac6454SAndrew Thompson continue; 254302ac6454SAndrew Thompson } 254402ac6454SAndrew Thompson } else if (iface_index == USB_IFACE_INDEX_ANY) { 2545a593f6b8SAndrew Thompson if ((f->methods == &usb_ugen_methods) && 2546bdd41206SAndrew Thompson (f->dev_ep_index == 0) && 2547bdd41206SAndrew Thompson (!(flag & USB_UNCFG_FLAG_FREE_EP0)) && 254802ac6454SAndrew Thompson (f->fs_xfer == NULL)) { 254902ac6454SAndrew Thompson /* no need to free this FIFO */ 255002ac6454SAndrew Thompson continue; 255102ac6454SAndrew Thompson } 255202ac6454SAndrew Thompson } else { 255302ac6454SAndrew Thompson /* no need to free this FIFO */ 255402ac6454SAndrew Thompson continue; 255502ac6454SAndrew Thompson } 255602ac6454SAndrew Thompson /* free this FIFO */ 2557a593f6b8SAndrew Thompson usb_fifo_free(f); 255802ac6454SAndrew Thompson } 255902ac6454SAndrew Thompson } 25600f6e8f93SAndrew Thompson #endif 256102ac6454SAndrew Thompson 256202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2563a593f6b8SAndrew Thompson * usb_peer_can_wakeup 256402ac6454SAndrew Thompson * 256502ac6454SAndrew Thompson * Return values: 256602ac6454SAndrew Thompson * 0: Peer cannot do resume signalling. 256702ac6454SAndrew Thompson * Else: Peer can do resume signalling. 256802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 256902ac6454SAndrew Thompson uint8_t 2570a593f6b8SAndrew Thompson usb_peer_can_wakeup(struct usb_device *udev) 257102ac6454SAndrew Thompson { 2572760bc48eSAndrew Thompson const struct usb_config_descriptor *cdp; 257302ac6454SAndrew Thompson 257402ac6454SAndrew Thompson cdp = udev->cdesc; 2575f29a0724SAndrew Thompson if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) { 257602ac6454SAndrew Thompson return (cdp->bmAttributes & UC_REMOTE_WAKEUP); 257702ac6454SAndrew Thompson } 257802ac6454SAndrew Thompson return (0); /* not supported */ 257902ac6454SAndrew Thompson } 2580bd216778SAndrew Thompson 2581bd216778SAndrew Thompson void 2582a593f6b8SAndrew Thompson usb_set_device_state(struct usb_device *udev, enum usb_dev_state state) 2583bd216778SAndrew Thompson { 2584bd216778SAndrew Thompson 2585bd216778SAndrew Thompson KASSERT(state < USB_STATE_MAX, ("invalid udev state")); 2586bd216778SAndrew Thompson 2587bd216778SAndrew Thompson DPRINTF("udev %p state %s -> %s\n", udev, 2588a593f6b8SAndrew Thompson usb_statestr(udev->state), usb_statestr(state)); 2589bd216778SAndrew Thompson udev->state = state; 2590963169b4SHans Petter Selasky 2591963169b4SHans Petter Selasky if (udev->bus->methods->device_state_change != NULL) 2592963169b4SHans Petter Selasky (udev->bus->methods->device_state_change) (udev); 2593963169b4SHans Petter Selasky } 2594963169b4SHans Petter Selasky 2595963169b4SHans Petter Selasky enum usb_dev_state 2596963169b4SHans Petter Selasky usb_get_device_state(struct usb_device *udev) 2597963169b4SHans Petter Selasky { 2598963169b4SHans Petter Selasky if (udev == NULL) 2599963169b4SHans Petter Selasky return (USB_STATE_DETACHED); 2600963169b4SHans Petter Selasky return (udev->state); 2601bd216778SAndrew Thompson } 2602bd216778SAndrew Thompson 2603ec8f3127SAndrew Thompson uint8_t 2604a593f6b8SAndrew Thompson usbd_device_attached(struct usb_device *udev) 2605bd216778SAndrew Thompson { 2606bd216778SAndrew Thompson return (udev->state > USB_STATE_DETACHED); 2607bd216778SAndrew Thompson } 2608cb18f7d1SAlfred Perlstein 2609cb18f7d1SAlfred Perlstein /* The following function locks enumerating the given USB device. */ 2610cb18f7d1SAlfred Perlstein 2611cb18f7d1SAlfred Perlstein void 2612cb18f7d1SAlfred Perlstein usbd_enum_lock(struct usb_device *udev) 2613cb18f7d1SAlfred Perlstein { 261491cd9240SAndrew Thompson sx_xlock(&udev->enum_sx); 26152df1e9a6SAndrew Thompson sx_xlock(&udev->sr_sx); 2616cb18f7d1SAlfred Perlstein /* 2617cb18f7d1SAlfred Perlstein * NEWBUS LOCK NOTE: We should check if any parent SX locks 2618cb18f7d1SAlfred Perlstein * are locked before locking Giant. Else the lock can be 2619cb18f7d1SAlfred Perlstein * locked multiple times. 2620cb18f7d1SAlfred Perlstein */ 2621cb18f7d1SAlfred Perlstein mtx_lock(&Giant); 2622cb18f7d1SAlfred Perlstein } 2623cb18f7d1SAlfred Perlstein 2624cb18f7d1SAlfred Perlstein /* The following function unlocks enumerating the given USB device. */ 2625cb18f7d1SAlfred Perlstein 2626cb18f7d1SAlfred Perlstein void 2627cb18f7d1SAlfred Perlstein usbd_enum_unlock(struct usb_device *udev) 2628cb18f7d1SAlfred Perlstein { 2629cb18f7d1SAlfred Perlstein mtx_unlock(&Giant); 263091cd9240SAndrew Thompson sx_xunlock(&udev->enum_sx); 26312df1e9a6SAndrew Thompson sx_xunlock(&udev->sr_sx); 26322df1e9a6SAndrew Thompson } 26332df1e9a6SAndrew Thompson 26342df1e9a6SAndrew Thompson /* The following function locks suspend and resume. */ 26352df1e9a6SAndrew Thompson 26362df1e9a6SAndrew Thompson void 26372df1e9a6SAndrew Thompson usbd_sr_lock(struct usb_device *udev) 26382df1e9a6SAndrew Thompson { 26392df1e9a6SAndrew Thompson sx_xlock(&udev->sr_sx); 26402df1e9a6SAndrew Thompson /* 26412df1e9a6SAndrew Thompson * NEWBUS LOCK NOTE: We should check if any parent SX locks 26422df1e9a6SAndrew Thompson * are locked before locking Giant. Else the lock can be 26432df1e9a6SAndrew Thompson * locked multiple times. 26442df1e9a6SAndrew Thompson */ 26452df1e9a6SAndrew Thompson mtx_lock(&Giant); 26462df1e9a6SAndrew Thompson } 26472df1e9a6SAndrew Thompson 26482df1e9a6SAndrew Thompson /* The following function unlocks suspend and resume. */ 26492df1e9a6SAndrew Thompson 26502df1e9a6SAndrew Thompson void 26512df1e9a6SAndrew Thompson usbd_sr_unlock(struct usb_device *udev) 26522df1e9a6SAndrew Thompson { 26532df1e9a6SAndrew Thompson mtx_unlock(&Giant); 26542df1e9a6SAndrew Thompson sx_xunlock(&udev->sr_sx); 2655cb18f7d1SAlfred Perlstein } 2656cb18f7d1SAlfred Perlstein 2657cb18f7d1SAlfred Perlstein /* 2658cb18f7d1SAlfred Perlstein * The following function checks the enumerating lock for the given 2659cb18f7d1SAlfred Perlstein * USB device. 2660cb18f7d1SAlfred Perlstein */ 2661cb18f7d1SAlfred Perlstein 2662cb18f7d1SAlfred Perlstein uint8_t 2663cb18f7d1SAlfred Perlstein usbd_enum_is_locked(struct usb_device *udev) 2664cb18f7d1SAlfred Perlstein { 266591cd9240SAndrew Thompson return (sx_xlocked(&udev->enum_sx)); 2666cb18f7d1SAlfred Perlstein } 26678427ed84SHans Petter Selasky 26688427ed84SHans Petter Selasky /* 26698427ed84SHans Petter Selasky * The following function is used to set the per-interface specific 26708427ed84SHans Petter Selasky * plug and play information. The string referred to by the pnpinfo 26718427ed84SHans Petter Selasky * argument can safely be freed after calling this function. The 26728427ed84SHans Petter Selasky * pnpinfo of an interface will be reset at device detach or when 26738427ed84SHans Petter Selasky * passing a NULL argument to this function. This function 26748427ed84SHans Petter Selasky * returns zero on success, else a USB_ERR_XXX failure code. 26758427ed84SHans Petter Selasky */ 26768427ed84SHans Petter Selasky 26778427ed84SHans Petter Selasky usb_error_t 26788427ed84SHans Petter Selasky usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo) 26798427ed84SHans Petter Selasky { 26808427ed84SHans Petter Selasky struct usb_interface *iface; 26818427ed84SHans Petter Selasky 26828427ed84SHans Petter Selasky iface = usbd_get_iface(udev, iface_index); 26838427ed84SHans Petter Selasky if (iface == NULL) 26848427ed84SHans Petter Selasky return (USB_ERR_INVAL); 26858427ed84SHans Petter Selasky 26868427ed84SHans Petter Selasky if (iface->pnpinfo != NULL) { 26878427ed84SHans Petter Selasky free(iface->pnpinfo, M_USBDEV); 26888427ed84SHans Petter Selasky iface->pnpinfo = NULL; 26898427ed84SHans Petter Selasky } 26908427ed84SHans Petter Selasky 26918427ed84SHans Petter Selasky if (pnpinfo == NULL || pnpinfo[0] == 0) 26928427ed84SHans Petter Selasky return (0); /* success */ 26938427ed84SHans Petter Selasky 26948427ed84SHans Petter Selasky iface->pnpinfo = strdup(pnpinfo, M_USBDEV); 26958427ed84SHans Petter Selasky if (iface->pnpinfo == NULL) 26968427ed84SHans Petter Selasky return (USB_ERR_NOMEM); 26978427ed84SHans Petter Selasky 26988427ed84SHans Petter Selasky return (0); /* success */ 26998427ed84SHans Petter Selasky } 27008427ed84SHans Petter Selasky 2701