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/linker_set.h> 36ed6d949aSAndrew Thompson #include <sys/module.h> 37ed6d949aSAndrew Thompson #include <sys/lock.h> 38ed6d949aSAndrew Thompson #include <sys/mutex.h> 39ed6d949aSAndrew Thompson #include <sys/condvar.h> 40ed6d949aSAndrew Thompson #include <sys/sysctl.h> 41ed6d949aSAndrew Thompson #include <sys/sx.h> 42ed6d949aSAndrew Thompson #include <sys/unistd.h> 43ed6d949aSAndrew Thompson #include <sys/callout.h> 44ed6d949aSAndrew Thompson #include <sys/malloc.h> 45ed6d949aSAndrew Thompson #include <sys/priv.h> 46ed6d949aSAndrew Thompson #include <sys/conf.h> 47ed6d949aSAndrew Thompson #include <sys/fcntl.h> 483acd904dSAndrew Thompson #include <sys/sbuf.h> 49ed6d949aSAndrew Thompson 5002ac6454SAndrew Thompson #include <dev/usb/usb.h> 51ed6d949aSAndrew Thompson #include <dev/usb/usbdi.h> 52ed6d949aSAndrew Thompson #include <dev/usb/usbdi_util.h> 5302ac6454SAndrew Thompson #include <dev/usb/usb_ioctl.h> 5402ac6454SAndrew Thompson #include "usbdevs.h" 5502ac6454SAndrew Thompson 56a593f6b8SAndrew Thompson #define USB_DEBUG_VAR usb_debug 5702ac6454SAndrew Thompson 5802ac6454SAndrew Thompson #include <dev/usb/usb_core.h> 5902ac6454SAndrew Thompson #include <dev/usb/usb_debug.h> 6002ac6454SAndrew Thompson #include <dev/usb/usb_process.h> 6102ac6454SAndrew Thompson #include <dev/usb/usb_device.h> 6202ac6454SAndrew Thompson #include <dev/usb/usb_busdma.h> 6302ac6454SAndrew Thompson #include <dev/usb/usb_transfer.h> 6402ac6454SAndrew Thompson #include <dev/usb/usb_request.h> 6502ac6454SAndrew Thompson #include <dev/usb/usb_dynamic.h> 6602ac6454SAndrew Thompson #include <dev/usb/usb_hub.h> 6702ac6454SAndrew Thompson #include <dev/usb/usb_util.h> 6802ac6454SAndrew Thompson #include <dev/usb/usb_msctest.h> 69bdc081c6SAndrew Thompson #if USB_HAVE_UGEN 70bdc081c6SAndrew Thompson #include <dev/usb/usb_dev.h> 7102ac6454SAndrew Thompson #include <dev/usb/usb_generic.h> 72bdc081c6SAndrew Thompson #endif 7302ac6454SAndrew Thompson 7402ac6454SAndrew Thompson #include <dev/usb/quirk/usb_quirk.h> 7502ac6454SAndrew Thompson 7602ac6454SAndrew Thompson #include <dev/usb/usb_controller.h> 7702ac6454SAndrew Thompson #include <dev/usb/usb_bus.h> 7802ac6454SAndrew Thompson 7902ac6454SAndrew Thompson /* function prototypes */ 8002ac6454SAndrew Thompson 81a593f6b8SAndrew Thompson static void usb_init_endpoint(struct usb_device *, uint8_t, 82ae60fdfbSAndrew Thompson struct usb_endpoint_descriptor *, struct usb_endpoint *); 83a593f6b8SAndrew Thompson static void usb_unconfigure(struct usb_device *, uint8_t); 84a593f6b8SAndrew Thompson static void usb_detach_device_sub(struct usb_device *, device_t *, 8502ac6454SAndrew Thompson uint8_t); 86a593f6b8SAndrew Thompson static uint8_t usb_probe_and_attach_sub(struct usb_device *, 87760bc48eSAndrew Thompson struct usb_attach_arg *); 88a593f6b8SAndrew Thompson static void usb_init_attach_arg(struct usb_device *, 89760bc48eSAndrew Thompson struct usb_attach_arg *); 90a593f6b8SAndrew Thompson static void usb_suspend_resume_sub(struct usb_device *, device_t, 9102ac6454SAndrew Thompson uint8_t); 92a593f6b8SAndrew Thompson static void usbd_clear_stall_proc(struct usb_proc_msg *_pm); 93a593f6b8SAndrew Thompson usb_error_t usb_config_parse(struct usb_device *, uint8_t, uint8_t); 94a593f6b8SAndrew Thompson static void usbd_set_device_strings(struct usb_device *); 950f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 96a593f6b8SAndrew Thompson static void usb_notify_addq(const char *type, struct usb_device *); 97a593f6b8SAndrew Thompson static void usb_fifo_free_wrap(struct usb_device *, uint8_t, uint8_t); 98a593f6b8SAndrew Thompson static struct cdev *usb_make_dev(struct usb_device *, int, int); 99a593f6b8SAndrew Thompson static void usb_cdev_create(struct usb_device *); 100a593f6b8SAndrew Thompson static void usb_cdev_free(struct usb_device *); 101a593f6b8SAndrew Thompson static void usb_cdev_cleanup(void *); 1020f6e8f93SAndrew Thompson #endif 10302ac6454SAndrew Thompson 10402ac6454SAndrew Thompson /* This variable is global to allow easy access to it: */ 10502ac6454SAndrew Thompson 106a593f6b8SAndrew Thompson int usb_template = 0; 10702ac6454SAndrew Thompson 1087a918edfSAndrew Thompson TUNABLE_INT("hw.usb.usb_template", &usb_template); 1099360ae40SAndrew Thompson SYSCTL_INT(_hw_usb, OID_AUTO, template, CTLFLAG_RW, 110a593f6b8SAndrew Thompson &usb_template, 0, "Selected USB device side template"); 11102ac6454SAndrew Thompson 1127a918edfSAndrew Thompson /* English is default language */ 1137a918edfSAndrew Thompson 1147a918edfSAndrew Thompson static int usb_lang_id = 0x0009; 1157a918edfSAndrew Thompson static int usb_lang_mask = 0x00FF; 1167a918edfSAndrew Thompson 1177a918edfSAndrew Thompson TUNABLE_INT("hw.usb.usb_lang_id", &usb_lang_id); 1187a918edfSAndrew Thompson SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_id, CTLFLAG_RW, 1197a918edfSAndrew Thompson &usb_lang_id, 0, "Preferred USB language ID"); 1207a918edfSAndrew Thompson 1217a918edfSAndrew Thompson TUNABLE_INT("hw.usb.usb_lang_mask", &usb_lang_mask); 1227a918edfSAndrew Thompson SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_mask, CTLFLAG_RW, 1237a918edfSAndrew Thompson &usb_lang_mask, 0, "Preferred USB language mask"); 1247a918edfSAndrew Thompson 1254d4fa6edSAndrew Thompson static const char* statestr[USB_STATE_MAX] = { 1264d4fa6edSAndrew Thompson [USB_STATE_DETACHED] = "DETACHED", 1274d4fa6edSAndrew Thompson [USB_STATE_ATTACHED] = "ATTACHED", 1284d4fa6edSAndrew Thompson [USB_STATE_POWERED] = "POWERED", 1294d4fa6edSAndrew Thompson [USB_STATE_ADDRESSED] = "ADDRESSED", 1304d4fa6edSAndrew Thompson [USB_STATE_CONFIGURED] = "CONFIGURED", 1314d4fa6edSAndrew Thompson }; 1324d4fa6edSAndrew Thompson 1334d4fa6edSAndrew Thompson const char * 134a593f6b8SAndrew Thompson usb_statestr(enum usb_dev_state state) 1354d4fa6edSAndrew Thompson { 136ec8f3127SAndrew Thompson return ((state < USB_STATE_MAX) ? statestr[state] : "UNKNOWN"); 1374d4fa6edSAndrew Thompson } 13802ac6454SAndrew Thompson 13902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 140a593f6b8SAndrew Thompson * usbd_get_ep_by_addr 14102ac6454SAndrew Thompson * 142ae60fdfbSAndrew Thompson * This function searches for an USB ep by endpoint address and 14302ac6454SAndrew Thompson * direction. 14402ac6454SAndrew Thompson * 14502ac6454SAndrew Thompson * Returns: 14602ac6454SAndrew Thompson * NULL: Failure 14702ac6454SAndrew Thompson * Else: Success 14802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 149ae60fdfbSAndrew Thompson struct usb_endpoint * 150a593f6b8SAndrew Thompson usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val) 15102ac6454SAndrew Thompson { 152ae60fdfbSAndrew Thompson struct usb_endpoint *ep = udev->endpoints; 153ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max; 15402ac6454SAndrew Thompson enum { 15502ac6454SAndrew Thompson EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR), 15602ac6454SAndrew Thompson }; 15702ac6454SAndrew Thompson 15802ac6454SAndrew Thompson /* 15902ac6454SAndrew Thompson * According to the USB specification not all bits are used 16002ac6454SAndrew Thompson * for the endpoint address. Keep defined bits only: 16102ac6454SAndrew Thompson */ 16202ac6454SAndrew Thompson ea_val &= EA_MASK; 16302ac6454SAndrew Thompson 16402ac6454SAndrew Thompson /* 165ae60fdfbSAndrew Thompson * Iterate accross all the USB endpoints searching for a match 16602ac6454SAndrew Thompson * based on the endpoint address: 16702ac6454SAndrew Thompson */ 168ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 16902ac6454SAndrew Thompson 170ae60fdfbSAndrew Thompson if (ep->edesc == NULL) { 17102ac6454SAndrew Thompson continue; 17202ac6454SAndrew Thompson } 17302ac6454SAndrew Thompson /* do the mask and check the value */ 174ae60fdfbSAndrew Thompson if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) { 17502ac6454SAndrew Thompson goto found; 17602ac6454SAndrew Thompson } 17702ac6454SAndrew Thompson } 17802ac6454SAndrew Thompson 17902ac6454SAndrew Thompson /* 180ae60fdfbSAndrew Thompson * The default endpoint is always present and is checked separately: 18102ac6454SAndrew Thompson */ 182ae60fdfbSAndrew Thompson if ((udev->default_ep.edesc) && 183ae60fdfbSAndrew Thompson ((udev->default_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) { 184ae60fdfbSAndrew Thompson ep = &udev->default_ep; 18502ac6454SAndrew Thompson goto found; 18602ac6454SAndrew Thompson } 18702ac6454SAndrew Thompson return (NULL); 18802ac6454SAndrew Thompson 18902ac6454SAndrew Thompson found: 190ae60fdfbSAndrew Thompson return (ep); 19102ac6454SAndrew Thompson } 19202ac6454SAndrew Thompson 19302ac6454SAndrew Thompson /*------------------------------------------------------------------------* 194a593f6b8SAndrew Thompson * usbd_get_endpoint 19502ac6454SAndrew Thompson * 196ae60fdfbSAndrew Thompson * This function searches for an USB endpoint based on the information 197760bc48eSAndrew Thompson * given by the passed "struct usb_config" pointer. 19802ac6454SAndrew Thompson * 19902ac6454SAndrew Thompson * Return values: 20002ac6454SAndrew Thompson * NULL: No match. 201ae60fdfbSAndrew Thompson * Else: Pointer to "struct usb_endpoint". 20202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 203ae60fdfbSAndrew Thompson struct usb_endpoint * 204a593f6b8SAndrew Thompson usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index, 205760bc48eSAndrew Thompson const struct usb_config *setup) 20602ac6454SAndrew Thompson { 207ae60fdfbSAndrew Thompson struct usb_endpoint *ep = udev->endpoints; 208ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max; 20902ac6454SAndrew Thompson uint8_t index = setup->ep_index; 21002ac6454SAndrew Thompson uint8_t ea_mask; 21102ac6454SAndrew Thompson uint8_t ea_val; 21202ac6454SAndrew Thompson uint8_t type_mask; 21302ac6454SAndrew Thompson uint8_t type_val; 21402ac6454SAndrew Thompson 21502ac6454SAndrew Thompson DPRINTFN(10, "udev=%p iface_index=%d address=0x%x " 21602ac6454SAndrew Thompson "type=0x%x dir=0x%x index=%d\n", 21702ac6454SAndrew Thompson udev, iface_index, setup->endpoint, 21802ac6454SAndrew Thompson setup->type, setup->direction, setup->ep_index); 21902ac6454SAndrew Thompson 2204eae601eSAndrew Thompson /* check USB mode */ 2214eae601eSAndrew Thompson 222f29a0724SAndrew Thompson if (setup->usb_mode != USB_MODE_DUAL && 223f29a0724SAndrew Thompson udev->flags.usb_mode != setup->usb_mode) { 224ae60fdfbSAndrew Thompson /* wrong mode - no endpoint */ 2254eae601eSAndrew Thompson return (NULL); 2264eae601eSAndrew Thompson } 2274eae601eSAndrew Thompson 22802ac6454SAndrew Thompson /* setup expected endpoint direction mask and value */ 22902ac6454SAndrew Thompson 23051ec1603SAndrew Thompson if (setup->direction == UE_DIR_RX) { 23151ec1603SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 232f29a0724SAndrew Thompson ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ? 23351ec1603SAndrew Thompson UE_DIR_OUT : UE_DIR_IN; 23451ec1603SAndrew Thompson } else if (setup->direction == UE_DIR_TX) { 23551ec1603SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 236f29a0724SAndrew Thompson ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ? 23751ec1603SAndrew Thompson UE_DIR_IN : UE_DIR_OUT; 23851ec1603SAndrew Thompson } else if (setup->direction == UE_DIR_ANY) { 23902ac6454SAndrew Thompson /* match any endpoint direction */ 24002ac6454SAndrew Thompson ea_mask = 0; 24102ac6454SAndrew Thompson ea_val = 0; 24202ac6454SAndrew Thompson } else { 24302ac6454SAndrew Thompson /* match the given endpoint direction */ 24402ac6454SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 24502ac6454SAndrew Thompson ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT)); 24602ac6454SAndrew Thompson } 24702ac6454SAndrew Thompson 24802ac6454SAndrew Thompson /* setup expected endpoint address */ 24902ac6454SAndrew Thompson 25002ac6454SAndrew Thompson if (setup->endpoint == UE_ADDR_ANY) { 25102ac6454SAndrew Thompson /* match any endpoint address */ 25202ac6454SAndrew Thompson } else { 25302ac6454SAndrew Thompson /* match the given endpoint address */ 25402ac6454SAndrew Thompson ea_mask |= UE_ADDR; 25502ac6454SAndrew Thompson ea_val |= (setup->endpoint & UE_ADDR); 25602ac6454SAndrew Thompson } 25702ac6454SAndrew Thompson 25802ac6454SAndrew Thompson /* setup expected endpoint type */ 25902ac6454SAndrew Thompson 26002ac6454SAndrew Thompson if (setup->type == UE_BULK_INTR) { 26102ac6454SAndrew Thompson /* this will match BULK and INTERRUPT endpoints */ 26202ac6454SAndrew Thompson type_mask = 2; 26302ac6454SAndrew Thompson type_val = 2; 26402ac6454SAndrew Thompson } else if (setup->type == UE_TYPE_ANY) { 26502ac6454SAndrew Thompson /* match any endpoint type */ 26602ac6454SAndrew Thompson type_mask = 0; 26702ac6454SAndrew Thompson type_val = 0; 26802ac6454SAndrew Thompson } else { 26902ac6454SAndrew Thompson /* match the given endpoint type */ 27002ac6454SAndrew Thompson type_mask = UE_XFERTYPE; 27102ac6454SAndrew Thompson type_val = (setup->type & UE_XFERTYPE); 27202ac6454SAndrew Thompson } 27302ac6454SAndrew Thompson 27402ac6454SAndrew Thompson /* 275ae60fdfbSAndrew Thompson * Iterate accross all the USB endpoints searching for a match 27602ac6454SAndrew Thompson * based on the endpoint address. Note that we are searching 277ae60fdfbSAndrew Thompson * the endpoints from the beginning of the "udev->endpoints" array. 27802ac6454SAndrew Thompson */ 279ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 28002ac6454SAndrew Thompson 281ae60fdfbSAndrew Thompson if ((ep->edesc == NULL) || 282ae60fdfbSAndrew Thompson (ep->iface_index != iface_index)) { 28302ac6454SAndrew Thompson continue; 28402ac6454SAndrew Thompson } 28502ac6454SAndrew Thompson /* do the masks and check the values */ 28602ac6454SAndrew Thompson 287ae60fdfbSAndrew Thompson if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) && 288ae60fdfbSAndrew Thompson ((ep->edesc->bmAttributes & type_mask) == type_val)) { 28902ac6454SAndrew Thompson if (!index--) { 29002ac6454SAndrew Thompson goto found; 29102ac6454SAndrew Thompson } 29202ac6454SAndrew Thompson } 29302ac6454SAndrew Thompson } 29402ac6454SAndrew Thompson 29502ac6454SAndrew Thompson /* 296ae60fdfbSAndrew Thompson * Match against default endpoint last, so that "any endpoint", "any 297ae60fdfbSAndrew Thompson * address" and "any direction" returns the first endpoint of the 29802ac6454SAndrew Thompson * interface. "iface_index" and "direction" is ignored: 29902ac6454SAndrew Thompson */ 300ae60fdfbSAndrew Thompson if ((udev->default_ep.edesc) && 301ae60fdfbSAndrew Thompson ((udev->default_ep.edesc->bEndpointAddress & ea_mask) == ea_val) && 302ae60fdfbSAndrew Thompson ((udev->default_ep.edesc->bmAttributes & type_mask) == type_val) && 30302ac6454SAndrew Thompson (!index)) { 304ae60fdfbSAndrew Thompson ep = &udev->default_ep; 30502ac6454SAndrew Thompson goto found; 30602ac6454SAndrew Thompson } 30702ac6454SAndrew Thompson return (NULL); 30802ac6454SAndrew Thompson 30902ac6454SAndrew Thompson found: 310ae60fdfbSAndrew Thompson return (ep); 31102ac6454SAndrew Thompson } 31202ac6454SAndrew Thompson 31302ac6454SAndrew Thompson /*------------------------------------------------------------------------* 314ed6d949aSAndrew Thompson * usbd_interface_count 31502ac6454SAndrew Thompson * 31602ac6454SAndrew Thompson * This function stores the number of USB interfaces excluding 31702ac6454SAndrew Thompson * alternate settings, which the USB config descriptor reports into 31802ac6454SAndrew Thompson * the unsigned 8-bit integer pointed to by "count". 31902ac6454SAndrew Thompson * 32002ac6454SAndrew Thompson * Returns: 32102ac6454SAndrew Thompson * 0: Success 32202ac6454SAndrew Thompson * Else: Failure 32302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 324e0a69b51SAndrew Thompson usb_error_t 325ed6d949aSAndrew Thompson usbd_interface_count(struct usb_device *udev, uint8_t *count) 32602ac6454SAndrew Thompson { 32702ac6454SAndrew Thompson if (udev->cdesc == NULL) { 32802ac6454SAndrew Thompson *count = 0; 32902ac6454SAndrew Thompson return (USB_ERR_NOT_CONFIGURED); 33002ac6454SAndrew Thompson } 331bdd41206SAndrew Thompson *count = udev->ifaces_max; 33202ac6454SAndrew Thompson return (USB_ERR_NORMAL_COMPLETION); 33302ac6454SAndrew Thompson } 33402ac6454SAndrew Thompson 33502ac6454SAndrew Thompson 33602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 337a593f6b8SAndrew Thompson * usb_init_endpoint 33802ac6454SAndrew Thompson * 339ae60fdfbSAndrew Thompson * This function will initialise the USB endpoint structure pointed to by 340ae60fdfbSAndrew Thompson * the "endpoint" argument. The structure pointed to by "endpoint" must be 341bdd41206SAndrew Thompson * zeroed before calling this function. 34202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 34302ac6454SAndrew Thompson static void 344a593f6b8SAndrew Thompson usb_init_endpoint(struct usb_device *udev, uint8_t iface_index, 345ae60fdfbSAndrew Thompson struct usb_endpoint_descriptor *edesc, struct usb_endpoint *ep) 34602ac6454SAndrew Thompson { 347760bc48eSAndrew Thompson struct usb_bus_methods *methods; 348ee3e3ff5SAndrew Thompson 349bdd41206SAndrew Thompson methods = udev->bus->methods; 35002ac6454SAndrew Thompson 351ae60fdfbSAndrew Thompson (methods->endpoint_init) (udev, edesc, ep); 35202ac6454SAndrew Thompson 353ae60fdfbSAndrew Thompson /* initialise USB endpoint structure */ 354ae60fdfbSAndrew Thompson ep->edesc = edesc; 355ae60fdfbSAndrew Thompson ep->iface_index = iface_index; 356ae60fdfbSAndrew Thompson TAILQ_INIT(&ep->endpoint_q.head); 357a593f6b8SAndrew Thompson ep->endpoint_q.command = &usbd_pipe_start; 35802ac6454SAndrew Thompson 35939307315SAndrew Thompson /* the pipe is not supported by the hardware */ 360ae60fdfbSAndrew Thompson if (ep->methods == NULL) 36139307315SAndrew Thompson return; 36239307315SAndrew Thompson 36302ac6454SAndrew Thompson /* clear stall, if any */ 364bdd41206SAndrew Thompson if (methods->clear_stall != NULL) { 36502ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 366ae60fdfbSAndrew Thompson (methods->clear_stall) (udev, ep); 36702ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 36802ac6454SAndrew Thompson } 36902ac6454SAndrew Thompson } 37002ac6454SAndrew Thompson 371bdd41206SAndrew Thompson /*-----------------------------------------------------------------------* 372a593f6b8SAndrew Thompson * usb_endpoint_foreach 37316589beaSAndrew Thompson * 37416589beaSAndrew Thompson * This function will iterate all the USB endpoints except the control 37516589beaSAndrew Thompson * endpoint. This function is NULL safe. 37616589beaSAndrew Thompson * 37716589beaSAndrew Thompson * Return values: 378ae60fdfbSAndrew Thompson * NULL: End of USB endpoints 379ae60fdfbSAndrew Thompson * Else: Pointer to next USB endpoint 38016589beaSAndrew Thompson *------------------------------------------------------------------------*/ 381ae60fdfbSAndrew Thompson struct usb_endpoint * 382a593f6b8SAndrew Thompson usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep) 38316589beaSAndrew Thompson { 384a9e26757SAndrew Thompson struct usb_endpoint *ep_end; 38516589beaSAndrew Thompson 38616589beaSAndrew Thompson /* be NULL safe */ 38716589beaSAndrew Thompson if (udev == NULL) 38816589beaSAndrew Thompson return (NULL); 38916589beaSAndrew Thompson 390a9e26757SAndrew Thompson ep_end = udev->endpoints + udev->endpoints_max; 391a9e26757SAndrew Thompson 392ae60fdfbSAndrew Thompson /* get next endpoint */ 393ae60fdfbSAndrew Thompson if (ep == NULL) 394ae60fdfbSAndrew Thompson ep = udev->endpoints; 39516589beaSAndrew Thompson else 396ae60fdfbSAndrew Thompson ep++; 39716589beaSAndrew Thompson 398ae60fdfbSAndrew Thompson /* find next allocated ep */ 399ae60fdfbSAndrew Thompson while (ep != ep_end) { 400ae60fdfbSAndrew Thompson if (ep->edesc != NULL) 401ae60fdfbSAndrew Thompson return (ep); 402ae60fdfbSAndrew Thompson ep++; 40316589beaSAndrew Thompson } 40416589beaSAndrew Thompson return (NULL); 40516589beaSAndrew Thompson } 40616589beaSAndrew Thompson 40716589beaSAndrew Thompson /*------------------------------------------------------------------------* 408a593f6b8SAndrew Thompson * usb_unconfigure 40902ac6454SAndrew Thompson * 410ae60fdfbSAndrew Thompson * This function will free all USB interfaces and USB endpoints belonging 41102ac6454SAndrew Thompson * to an USB device. 412bdd41206SAndrew Thompson * 413bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 41402ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 41502ac6454SAndrew Thompson static void 416a593f6b8SAndrew Thompson usb_unconfigure(struct usb_device *udev, uint8_t flag) 41702ac6454SAndrew Thompson { 418bdd41206SAndrew Thompson uint8_t do_unlock; 41902ac6454SAndrew Thompson 420bdd41206SAndrew Thompson /* automatic locking */ 421cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 422bdd41206SAndrew Thompson do_unlock = 0; 423bdd41206SAndrew Thompson } else { 424bdd41206SAndrew Thompson do_unlock = 1; 425cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 426bdd41206SAndrew Thompson } 427bdd41206SAndrew Thompson 428bdd41206SAndrew Thompson /* detach all interface drivers */ 429a593f6b8SAndrew Thompson usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag); 430bdd41206SAndrew Thompson 431bdd41206SAndrew Thompson #if USB_HAVE_UGEN 432bdd41206SAndrew Thompson /* free all FIFOs except control endpoint FIFOs */ 433a593f6b8SAndrew Thompson usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag); 434bdd41206SAndrew Thompson 435bdd41206SAndrew Thompson /* 436bdd41206SAndrew Thompson * Free all cdev's, if any. 437bdd41206SAndrew Thompson */ 438a593f6b8SAndrew Thompson usb_cdev_free(udev); 439bdd41206SAndrew Thompson #endif 44002ac6454SAndrew Thompson 441bdc081c6SAndrew Thompson #if USB_HAVE_COMPAT_LINUX 44202ac6454SAndrew Thompson /* free Linux compat device, if any */ 443760bc48eSAndrew Thompson if (udev->linux_endpoint_start) { 444760bc48eSAndrew Thompson usb_linux_free_device(udev); 445760bc48eSAndrew Thompson udev->linux_endpoint_start = NULL; 44602ac6454SAndrew Thompson } 447bdc081c6SAndrew Thompson #endif 44802ac6454SAndrew Thompson 449a593f6b8SAndrew Thompson usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE); 45002ac6454SAndrew Thompson 451ae60fdfbSAndrew Thompson /* free "cdesc" after "ifaces" and "endpoints", if any */ 4527efaaa9aSAndrew Thompson if (udev->cdesc != NULL) { 453f29a0724SAndrew Thompson if (udev->flags.usb_mode != USB_MODE_DEVICE) 45402ac6454SAndrew Thompson free(udev->cdesc, M_USB); 45502ac6454SAndrew Thompson udev->cdesc = NULL; 45602ac6454SAndrew Thompson } 45702ac6454SAndrew Thompson /* set unconfigured state */ 45802ac6454SAndrew Thompson udev->curr_config_no = USB_UNCONFIG_NO; 45902ac6454SAndrew Thompson udev->curr_config_index = USB_UNCONFIG_INDEX; 460bdd41206SAndrew Thompson 461cb18f7d1SAlfred Perlstein if (do_unlock) 462cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 46302ac6454SAndrew Thompson } 46402ac6454SAndrew Thompson 46502ac6454SAndrew Thompson /*------------------------------------------------------------------------* 466a593f6b8SAndrew Thompson * usbd_set_config_index 46702ac6454SAndrew Thompson * 46802ac6454SAndrew Thompson * This function selects configuration by index, independent of the 46902ac6454SAndrew Thompson * actual configuration number. This function should not be used by 47002ac6454SAndrew Thompson * USB drivers. 47102ac6454SAndrew Thompson * 47202ac6454SAndrew Thompson * Returns: 47302ac6454SAndrew Thompson * 0: Success 47402ac6454SAndrew Thompson * Else: Failure 47502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 476e0a69b51SAndrew Thompson usb_error_t 477a593f6b8SAndrew Thompson usbd_set_config_index(struct usb_device *udev, uint8_t index) 47802ac6454SAndrew Thompson { 479760bc48eSAndrew Thompson struct usb_status ds; 480760bc48eSAndrew Thompson struct usb_config_descriptor *cdp; 48102ac6454SAndrew Thompson uint16_t power; 48202ac6454SAndrew Thompson uint16_t max_power; 48302ac6454SAndrew Thompson uint8_t selfpowered; 48402ac6454SAndrew Thompson uint8_t do_unlock; 485e0a69b51SAndrew Thompson usb_error_t err; 48602ac6454SAndrew Thompson 48702ac6454SAndrew Thompson DPRINTFN(6, "udev=%p index=%d\n", udev, index); 48802ac6454SAndrew Thompson 48902ac6454SAndrew Thompson /* automatic locking */ 490cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 49102ac6454SAndrew Thompson do_unlock = 0; 49202ac6454SAndrew Thompson } else { 49302ac6454SAndrew Thompson do_unlock = 1; 494cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 49502ac6454SAndrew Thompson } 49602ac6454SAndrew Thompson 497d88688c7SAndrew Thompson usb_unconfigure(udev, 0); 49802ac6454SAndrew Thompson 49902ac6454SAndrew Thompson if (index == USB_UNCONFIG_INDEX) { 50002ac6454SAndrew Thompson /* 50102ac6454SAndrew Thompson * Leave unallocated when unconfiguring the 502a593f6b8SAndrew Thompson * device. "usb_unconfigure()" will also reset 50302ac6454SAndrew Thompson * the current config number and index. 50402ac6454SAndrew Thompson */ 505a593f6b8SAndrew Thompson err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO); 506bd216778SAndrew Thompson if (udev->state == USB_STATE_CONFIGURED) 507a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_ADDRESSED); 50802ac6454SAndrew Thompson goto done; 50902ac6454SAndrew Thompson } 51002ac6454SAndrew Thompson /* get the full config descriptor */ 511f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 5127efaaa9aSAndrew Thompson /* save some memory */ 513a593f6b8SAndrew Thompson err = usbd_req_get_descriptor_ptr(udev, &cdp, 514459d369eSAndrew Thompson (UDESC_CONFIG << 8) | index); 5157efaaa9aSAndrew Thompson } else { 5167efaaa9aSAndrew Thompson /* normal request */ 517a593f6b8SAndrew Thompson err = usbd_req_get_config_desc_full(udev, 518e2805033SAndrew Thompson NULL, &cdp, M_USB, index); 5197efaaa9aSAndrew Thompson } 52002ac6454SAndrew Thompson if (err) { 52102ac6454SAndrew Thompson goto done; 52202ac6454SAndrew Thompson } 52302ac6454SAndrew Thompson /* set the new config descriptor */ 52402ac6454SAndrew Thompson 52502ac6454SAndrew Thompson udev->cdesc = cdp; 52602ac6454SAndrew Thompson 52702ac6454SAndrew Thompson /* Figure out if the device is self or bus powered. */ 52802ac6454SAndrew Thompson selfpowered = 0; 52902ac6454SAndrew Thompson if ((!udev->flags.uq_bus_powered) && 53002ac6454SAndrew Thompson (cdp->bmAttributes & UC_SELF_POWERED) && 531f29a0724SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST)) { 53202ac6454SAndrew Thompson /* May be self powered. */ 53302ac6454SAndrew Thompson if (cdp->bmAttributes & UC_BUS_POWERED) { 53402ac6454SAndrew Thompson /* Must ask device. */ 535a593f6b8SAndrew Thompson err = usbd_req_get_device_status(udev, NULL, &ds); 53602ac6454SAndrew Thompson if (err) { 53702ac6454SAndrew Thompson DPRINTFN(0, "could not read " 53802ac6454SAndrew Thompson "device status: %s\n", 539a593f6b8SAndrew Thompson usbd_errstr(err)); 54002ac6454SAndrew Thompson } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) { 54102ac6454SAndrew Thompson selfpowered = 1; 54202ac6454SAndrew Thompson } 54302ac6454SAndrew Thompson DPRINTF("status=0x%04x \n", 54402ac6454SAndrew Thompson UGETW(ds.wStatus)); 54502ac6454SAndrew Thompson } else 54602ac6454SAndrew Thompson selfpowered = 1; 54702ac6454SAndrew Thompson } 54802ac6454SAndrew Thompson DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, " 54902ac6454SAndrew Thompson "selfpowered=%d, power=%d\n", 55002ac6454SAndrew Thompson udev, cdp, 55191f72cedSAndrew Thompson udev->address, cdp->bConfigurationValue, cdp->bmAttributes, 55202ac6454SAndrew Thompson selfpowered, cdp->bMaxPower * 2); 55302ac6454SAndrew Thompson 55402ac6454SAndrew Thompson /* Check if we have enough power. */ 55502ac6454SAndrew Thompson power = cdp->bMaxPower * 2; 55602ac6454SAndrew Thompson 55702ac6454SAndrew Thompson if (udev->parent_hub) { 55802ac6454SAndrew Thompson max_power = udev->parent_hub->hub->portpower; 55902ac6454SAndrew Thompson } else { 56002ac6454SAndrew Thompson max_power = USB_MAX_POWER; 56102ac6454SAndrew Thompson } 56202ac6454SAndrew Thompson 56302ac6454SAndrew Thompson if (power > max_power) { 56402ac6454SAndrew Thompson DPRINTFN(0, "power exceeded %d > %d\n", power, max_power); 56502ac6454SAndrew Thompson err = USB_ERR_NO_POWER; 56602ac6454SAndrew Thompson goto done; 56702ac6454SAndrew Thompson } 56802ac6454SAndrew Thompson /* Only update "self_powered" in USB Host Mode */ 569f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_HOST) { 57002ac6454SAndrew Thompson udev->flags.self_powered = selfpowered; 57102ac6454SAndrew Thompson } 57202ac6454SAndrew Thompson udev->power = power; 57302ac6454SAndrew Thompson udev->curr_config_no = cdp->bConfigurationValue; 57402ac6454SAndrew Thompson udev->curr_config_index = index; 575a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_CONFIGURED); 57602ac6454SAndrew Thompson 57702ac6454SAndrew Thompson /* Set the actual configuration value. */ 578a593f6b8SAndrew Thompson err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue); 57902ac6454SAndrew Thompson if (err) { 58002ac6454SAndrew Thompson goto done; 58102ac6454SAndrew Thompson } 582bdd41206SAndrew Thompson 583a593f6b8SAndrew Thompson err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC); 58402ac6454SAndrew Thompson if (err) { 58502ac6454SAndrew Thompson goto done; 58602ac6454SAndrew Thompson } 587bdd41206SAndrew Thompson 588a593f6b8SAndrew Thompson err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT); 589bdd41206SAndrew Thompson if (err) { 590bdd41206SAndrew Thompson goto done; 59102ac6454SAndrew Thompson } 592bdd41206SAndrew Thompson 5930f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 594ee3e3ff5SAndrew Thompson /* create device nodes for each endpoint */ 595a593f6b8SAndrew Thompson usb_cdev_create(udev); 5960f6e8f93SAndrew Thompson #endif 59702ac6454SAndrew Thompson 59802ac6454SAndrew Thompson done: 599a593f6b8SAndrew Thompson DPRINTF("error=%s\n", usbd_errstr(err)); 60002ac6454SAndrew Thompson if (err) { 601d88688c7SAndrew Thompson usb_unconfigure(udev, 0); 60202ac6454SAndrew Thompson } 603cb18f7d1SAlfred Perlstein if (do_unlock) 604cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 60502ac6454SAndrew Thompson return (err); 60602ac6454SAndrew Thompson } 60702ac6454SAndrew Thompson 60802ac6454SAndrew Thompson /*------------------------------------------------------------------------* 609a593f6b8SAndrew Thompson * usb_config_parse 610bdd41206SAndrew Thompson * 611ae60fdfbSAndrew Thompson * This function will allocate and free USB interfaces and USB endpoints, 612ae60fdfbSAndrew Thompson * parse the USB configuration structure and initialise the USB endpoints 613bdd41206SAndrew Thompson * and interfaces. If "iface_index" is not equal to 614bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the 615bdd41206SAndrew Thompson * alternate_setting to be selected for the given interface. Else the 616bdd41206SAndrew Thompson * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be 617bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function 618bdd41206SAndrew Thompson * is typically called when setting the configuration or when setting 619bdd41206SAndrew Thompson * an alternate interface. 620bdd41206SAndrew Thompson * 621bdd41206SAndrew Thompson * Returns: 622bdd41206SAndrew Thompson * 0: Success 623bdd41206SAndrew Thompson * Else: Failure 624bdd41206SAndrew Thompson *------------------------------------------------------------------------*/ 625e0a69b51SAndrew Thompson usb_error_t 626a593f6b8SAndrew Thompson usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd) 627bdd41206SAndrew Thompson { 628760bc48eSAndrew Thompson struct usb_idesc_parse_state ips; 629760bc48eSAndrew Thompson struct usb_interface_descriptor *id; 630760bc48eSAndrew Thompson struct usb_endpoint_descriptor *ed; 631760bc48eSAndrew Thompson struct usb_interface *iface; 632ae60fdfbSAndrew Thompson struct usb_endpoint *ep; 633e0a69b51SAndrew Thompson usb_error_t err; 634bdd41206SAndrew Thompson uint8_t ep_curr; 635bdd41206SAndrew Thompson uint8_t ep_max; 636bdd41206SAndrew Thompson uint8_t temp; 637bdd41206SAndrew Thompson uint8_t do_init; 638bdd41206SAndrew Thompson uint8_t alt_index; 639bdd41206SAndrew Thompson 640bdd41206SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 641bdd41206SAndrew Thompson /* parameter overload */ 642bdd41206SAndrew Thompson alt_index = cmd; 643bdd41206SAndrew Thompson cmd = USB_CFG_INIT; 644bdd41206SAndrew Thompson } else { 645bdd41206SAndrew Thompson /* not used */ 646bdd41206SAndrew Thompson alt_index = 0; 647bdd41206SAndrew Thompson } 648bdd41206SAndrew Thompson 649bdd41206SAndrew Thompson err = 0; 650bdd41206SAndrew Thompson 651bdd41206SAndrew Thompson DPRINTFN(5, "iface_index=%d cmd=%d\n", 652bdd41206SAndrew Thompson iface_index, cmd); 653bdd41206SAndrew Thompson 654bdd41206SAndrew Thompson if (cmd == USB_CFG_FREE) 655bdd41206SAndrew Thompson goto cleanup; 656bdd41206SAndrew Thompson 657bdd41206SAndrew Thompson if (cmd == USB_CFG_INIT) { 65891cd9240SAndrew Thompson sx_assert(&udev->enum_sx, SA_LOCKED); 659bdd41206SAndrew Thompson 660ae60fdfbSAndrew Thompson /* check for in-use endpoints */ 661bdd41206SAndrew Thompson 662ae60fdfbSAndrew Thompson ep = udev->endpoints; 663ae60fdfbSAndrew Thompson ep_max = udev->endpoints_max; 664bdd41206SAndrew Thompson while (ep_max--) { 665ae60fdfbSAndrew Thompson /* look for matching endpoints */ 666bdd41206SAndrew Thompson if ((iface_index == USB_IFACE_INDEX_ANY) || 667ae60fdfbSAndrew Thompson (iface_index == ep->iface_index)) { 668f12c6c29SAndrew Thompson if (ep->refcount_alloc != 0) { 669bdd41206SAndrew Thompson /* 670bdd41206SAndrew Thompson * This typically indicates a 671bdd41206SAndrew Thompson * more serious error. 672bdd41206SAndrew Thompson */ 673bdd41206SAndrew Thompson err = USB_ERR_IN_USE; 674bdd41206SAndrew Thompson } else { 675ae60fdfbSAndrew Thompson /* reset endpoint */ 676ae60fdfbSAndrew Thompson memset(ep, 0, sizeof(*ep)); 677ae60fdfbSAndrew Thompson /* make sure we don't zero the endpoint again */ 678ae60fdfbSAndrew Thompson ep->iface_index = USB_IFACE_INDEX_ANY; 679bdd41206SAndrew Thompson } 680bdd41206SAndrew Thompson } 681ae60fdfbSAndrew Thompson ep++; 682bdd41206SAndrew Thompson } 683bdd41206SAndrew Thompson 684bdd41206SAndrew Thompson if (err) 685bdd41206SAndrew Thompson return (err); 686bdd41206SAndrew Thompson } 687bdd41206SAndrew Thompson 688bdd41206SAndrew Thompson memset(&ips, 0, sizeof(ips)); 689bdd41206SAndrew Thompson 690bdd41206SAndrew Thompson ep_curr = 0; 691bdd41206SAndrew Thompson ep_max = 0; 692bdd41206SAndrew Thompson 693a593f6b8SAndrew Thompson while ((id = usb_idesc_foreach(udev->cdesc, &ips))) { 694bdd41206SAndrew Thompson 695bdd41206SAndrew Thompson /* check for interface overflow */ 696bdd41206SAndrew Thompson if (ips.iface_index == USB_IFACE_MAX) 697bdd41206SAndrew Thompson break; /* crazy */ 698bdd41206SAndrew Thompson 699bdd41206SAndrew Thompson iface = udev->ifaces + ips.iface_index; 700bdd41206SAndrew Thompson 701bdd41206SAndrew Thompson /* check for specific interface match */ 702bdd41206SAndrew Thompson 703bdd41206SAndrew Thompson if (cmd == USB_CFG_INIT) { 704bdd41206SAndrew Thompson if ((iface_index != USB_IFACE_INDEX_ANY) && 705bdd41206SAndrew Thompson (iface_index != ips.iface_index)) { 706bdd41206SAndrew Thompson /* wrong interface */ 707bdd41206SAndrew Thompson do_init = 0; 708bdd41206SAndrew Thompson } else if (alt_index != ips.iface_index_alt) { 709bdd41206SAndrew Thompson /* wrong alternate setting */ 710bdd41206SAndrew Thompson do_init = 0; 711bdd41206SAndrew Thompson } else { 712bdd41206SAndrew Thompson /* initialise interface */ 713bdd41206SAndrew Thompson do_init = 1; 714bdd41206SAndrew Thompson } 715bdd41206SAndrew Thompson } else 716bdd41206SAndrew Thompson do_init = 0; 717bdd41206SAndrew Thompson 718bdd41206SAndrew Thompson /* check for new interface */ 719bdd41206SAndrew Thompson if (ips.iface_index_alt == 0) { 720bdd41206SAndrew Thompson /* update current number of endpoints */ 721bdd41206SAndrew Thompson ep_curr = ep_max; 722bdd41206SAndrew Thompson } 723bdd41206SAndrew Thompson /* check for init */ 724bdd41206SAndrew Thompson if (do_init) { 725bdd41206SAndrew Thompson /* setup the USB interface structure */ 726bdd41206SAndrew Thompson iface->idesc = id; 727bdd41206SAndrew Thompson /* default setting */ 728bdd41206SAndrew Thompson iface->parent_iface_index = USB_IFACE_INDEX_ANY; 729bdd41206SAndrew Thompson /* set alternate index */ 730bdd41206SAndrew Thompson iface->alt_index = alt_index; 731bdd41206SAndrew Thompson } 732bdd41206SAndrew Thompson 733bdd41206SAndrew Thompson DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints); 734bdd41206SAndrew Thompson 735760bc48eSAndrew Thompson ed = (struct usb_endpoint_descriptor *)id; 736bdd41206SAndrew Thompson 737bdd41206SAndrew Thompson temp = ep_curr; 738bdd41206SAndrew Thompson 739bdd41206SAndrew Thompson /* iterate all the endpoint descriptors */ 740a593f6b8SAndrew Thompson while ((ed = usb_edesc_foreach(udev->cdesc, ed))) { 741bdd41206SAndrew Thompson 742bdd41206SAndrew Thompson if (temp == USB_EP_MAX) 743bdd41206SAndrew Thompson break; /* crazy */ 744bdd41206SAndrew Thompson 745ae60fdfbSAndrew Thompson ep = udev->endpoints + temp; 746bdd41206SAndrew Thompson 747bdd41206SAndrew Thompson if (do_init) { 748a593f6b8SAndrew Thompson usb_init_endpoint(udev, 749ae60fdfbSAndrew Thompson ips.iface_index, ed, ep); 750bdd41206SAndrew Thompson } 751bdd41206SAndrew Thompson 752bdd41206SAndrew Thompson temp ++; 753bdd41206SAndrew Thompson 754bdd41206SAndrew Thompson /* find maximum number of endpoints */ 755bdd41206SAndrew Thompson if (ep_max < temp) 756bdd41206SAndrew Thompson ep_max = temp; 757bdd41206SAndrew Thompson 758bdd41206SAndrew Thompson /* optimalisation */ 759760bc48eSAndrew Thompson id = (struct usb_interface_descriptor *)ed; 760bdd41206SAndrew Thompson } 761bdd41206SAndrew Thompson } 762bdd41206SAndrew Thompson 763bdd41206SAndrew Thompson /* NOTE: It is valid to have no interfaces and no endpoints! */ 764bdd41206SAndrew Thompson 765bdd41206SAndrew Thompson if (cmd == USB_CFG_ALLOC) { 766bdd41206SAndrew Thompson udev->ifaces_max = ips.iface_index; 767bdd41206SAndrew Thompson udev->ifaces = NULL; 768bdd41206SAndrew Thompson if (udev->ifaces_max != 0) { 769bdd41206SAndrew Thompson udev->ifaces = malloc(sizeof(*iface) * udev->ifaces_max, 770bdd41206SAndrew Thompson M_USB, M_WAITOK | M_ZERO); 771bdd41206SAndrew Thompson if (udev->ifaces == NULL) { 772bdd41206SAndrew Thompson err = USB_ERR_NOMEM; 773bdd41206SAndrew Thompson goto done; 774bdd41206SAndrew Thompson } 775bdd41206SAndrew Thompson } 7769469c929SAndrew Thompson if (ep_max != 0) { 777ae60fdfbSAndrew Thompson udev->endpoints = malloc(sizeof(*ep) * ep_max, 778bdd41206SAndrew Thompson M_USB, M_WAITOK | M_ZERO); 779ae60fdfbSAndrew Thompson if (udev->endpoints == NULL) { 780bdd41206SAndrew Thompson err = USB_ERR_NOMEM; 781bdd41206SAndrew Thompson goto done; 782bdd41206SAndrew Thompson } 7839469c929SAndrew Thompson } else { 784ae60fdfbSAndrew Thompson udev->endpoints = NULL; 785bdd41206SAndrew Thompson } 7869469c929SAndrew Thompson USB_BUS_LOCK(udev->bus); 787ae60fdfbSAndrew Thompson udev->endpoints_max = ep_max; 7889469c929SAndrew Thompson /* reset any ongoing clear-stall */ 789ae60fdfbSAndrew Thompson udev->ep_curr = NULL; 7909469c929SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 791bdd41206SAndrew Thompson } 792bdd41206SAndrew Thompson 793bdd41206SAndrew Thompson done: 794bdd41206SAndrew Thompson if (err) { 795bdd41206SAndrew Thompson if (cmd == USB_CFG_ALLOC) { 796bdd41206SAndrew Thompson cleanup: 7979469c929SAndrew Thompson USB_BUS_LOCK(udev->bus); 798ae60fdfbSAndrew Thompson udev->endpoints_max = 0; 7999469c929SAndrew Thompson /* reset any ongoing clear-stall */ 800ae60fdfbSAndrew Thompson udev->ep_curr = NULL; 8019469c929SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 8029469c929SAndrew Thompson 803bdd41206SAndrew Thompson /* cleanup */ 804bdd41206SAndrew Thompson if (udev->ifaces != NULL) 805bdd41206SAndrew Thompson free(udev->ifaces, M_USB); 806ae60fdfbSAndrew Thompson if (udev->endpoints != NULL) 807ae60fdfbSAndrew Thompson free(udev->endpoints, M_USB); 808bdd41206SAndrew Thompson 809bdd41206SAndrew Thompson udev->ifaces = NULL; 810ae60fdfbSAndrew Thompson udev->endpoints = NULL; 811bdd41206SAndrew Thompson udev->ifaces_max = 0; 812bdd41206SAndrew Thompson } 813bdd41206SAndrew Thompson } 814bdd41206SAndrew Thompson return (err); 815bdd41206SAndrew Thompson } 816bdd41206SAndrew Thompson 817bdd41206SAndrew Thompson /*------------------------------------------------------------------------* 818a593f6b8SAndrew Thompson * usbd_set_alt_interface_index 81902ac6454SAndrew Thompson * 82002ac6454SAndrew Thompson * This function will select an alternate interface index for the 82102ac6454SAndrew Thompson * given interface index. The interface should not be in use when this 822e2805033SAndrew Thompson * function is called. That means there should not be any open USB 823e2805033SAndrew Thompson * transfers. Else an error is returned. If the alternate setting is 824e2805033SAndrew Thompson * already set this function will simply return success. This function 825e2805033SAndrew Thompson * is called in Host mode and Device mode! 82602ac6454SAndrew Thompson * 82702ac6454SAndrew Thompson * Returns: 82802ac6454SAndrew Thompson * 0: Success 82902ac6454SAndrew Thompson * Else: Failure 83002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 831e0a69b51SAndrew Thompson usb_error_t 832a593f6b8SAndrew Thompson usbd_set_alt_interface_index(struct usb_device *udev, 83302ac6454SAndrew Thompson uint8_t iface_index, uint8_t alt_index) 83402ac6454SAndrew Thompson { 835a593f6b8SAndrew Thompson struct usb_interface *iface = usbd_get_iface(udev, iface_index); 836e0a69b51SAndrew Thompson usb_error_t err; 83702ac6454SAndrew Thompson uint8_t do_unlock; 83802ac6454SAndrew Thompson 83902ac6454SAndrew Thompson /* automatic locking */ 840cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 84102ac6454SAndrew Thompson do_unlock = 0; 84202ac6454SAndrew Thompson } else { 84302ac6454SAndrew Thompson do_unlock = 1; 844cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 84502ac6454SAndrew Thompson } 84602ac6454SAndrew Thompson if (iface == NULL) { 84702ac6454SAndrew Thompson err = USB_ERR_INVAL; 84802ac6454SAndrew Thompson goto done; 84902ac6454SAndrew Thompson } 850e2805033SAndrew Thompson if (iface->alt_index == alt_index) { 851e2805033SAndrew Thompson /* 852e2805033SAndrew Thompson * Optimise away duplicate setting of 853e2805033SAndrew Thompson * alternate setting in USB Host Mode! 854e2805033SAndrew Thompson */ 855e2805033SAndrew Thompson err = 0; 856e2805033SAndrew Thompson goto done; 857e2805033SAndrew Thompson } 8580f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 85902ac6454SAndrew Thompson /* 86002ac6454SAndrew Thompson * Free all generic FIFOs for this interface, except control 86102ac6454SAndrew Thompson * endpoint FIFOs: 86202ac6454SAndrew Thompson */ 863a593f6b8SAndrew Thompson usb_fifo_free_wrap(udev, iface_index, 0); 8640f6e8f93SAndrew Thompson #endif 865bdd41206SAndrew Thompson 866a593f6b8SAndrew Thompson err = usb_config_parse(udev, iface_index, alt_index); 86702ac6454SAndrew Thompson if (err) { 86802ac6454SAndrew Thompson goto done; 86902ac6454SAndrew Thompson } 870bd73b187SAlfred Perlstein if (iface->alt_index != alt_index) { 871bd73b187SAlfred Perlstein /* the alternate setting does not exist */ 872bd73b187SAlfred Perlstein err = USB_ERR_INVAL; 873bd73b187SAlfred Perlstein goto done; 874bd73b187SAlfred Perlstein } 875bd73b187SAlfred Perlstein 876a593f6b8SAndrew Thompson err = usbd_req_set_alt_interface_no(udev, NULL, iface_index, 87702ac6454SAndrew Thompson iface->idesc->bAlternateSetting); 87802ac6454SAndrew Thompson 87902ac6454SAndrew Thompson done: 880cb18f7d1SAlfred Perlstein if (do_unlock) 881cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 882cb18f7d1SAlfred Perlstein 88302ac6454SAndrew Thompson return (err); 88402ac6454SAndrew Thompson } 88502ac6454SAndrew Thompson 88602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 887a593f6b8SAndrew Thompson * usbd_set_endpoint_stall 88802ac6454SAndrew Thompson * 88902ac6454SAndrew Thompson * This function is used to make a BULK or INTERRUPT endpoint 89002ac6454SAndrew Thompson * send STALL tokens. 89102ac6454SAndrew Thompson * 89202ac6454SAndrew Thompson * Returns: 89302ac6454SAndrew Thompson * 0: Success 89402ac6454SAndrew Thompson * Else: Failure 89502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 896e0a69b51SAndrew Thompson usb_error_t 897a593f6b8SAndrew Thompson usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep, 89802ac6454SAndrew Thompson uint8_t do_stall) 89902ac6454SAndrew Thompson { 900760bc48eSAndrew Thompson struct usb_xfer *xfer; 90102ac6454SAndrew Thompson uint8_t et; 90202ac6454SAndrew Thompson uint8_t was_stalled; 90302ac6454SAndrew Thompson 904ae60fdfbSAndrew Thompson if (ep == NULL) { 90502ac6454SAndrew Thompson /* nothing to do */ 90602ac6454SAndrew Thompson DPRINTF("Cannot find endpoint\n"); 90702ac6454SAndrew Thompson /* 90802ac6454SAndrew Thompson * Pretend that the clear or set stall request is 90902ac6454SAndrew Thompson * successful else some USB host stacks can do 91002ac6454SAndrew Thompson * strange things, especially when a control endpoint 91102ac6454SAndrew Thompson * stalls. 91202ac6454SAndrew Thompson */ 91302ac6454SAndrew Thompson return (0); 91402ac6454SAndrew Thompson } 915ae60fdfbSAndrew Thompson et = (ep->edesc->bmAttributes & UE_XFERTYPE); 91602ac6454SAndrew Thompson 91702ac6454SAndrew Thompson if ((et != UE_BULK) && 91802ac6454SAndrew Thompson (et != UE_INTERRUPT)) { 91902ac6454SAndrew Thompson /* 92002ac6454SAndrew Thompson * Should not stall control 92102ac6454SAndrew Thompson * nor isochronous endpoints. 92202ac6454SAndrew Thompson */ 92302ac6454SAndrew Thompson DPRINTF("Invalid endpoint\n"); 92402ac6454SAndrew Thompson return (0); 92502ac6454SAndrew Thompson } 92602ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 92702ac6454SAndrew Thompson 92802ac6454SAndrew Thompson /* store current stall state */ 929ae60fdfbSAndrew Thompson was_stalled = ep->is_stalled; 93002ac6454SAndrew Thompson 93102ac6454SAndrew Thompson /* check for no change */ 93202ac6454SAndrew Thompson if (was_stalled && do_stall) { 933ae60fdfbSAndrew Thompson /* if the endpoint is already stalled do nothing */ 93402ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 93502ac6454SAndrew Thompson DPRINTF("No change\n"); 93602ac6454SAndrew Thompson return (0); 93702ac6454SAndrew Thompson } 93802ac6454SAndrew Thompson /* set stalled state */ 939ae60fdfbSAndrew Thompson ep->is_stalled = 1; 94002ac6454SAndrew Thompson 94102ac6454SAndrew Thompson if (do_stall || (!was_stalled)) { 94202ac6454SAndrew Thompson if (!was_stalled) { 94302ac6454SAndrew Thompson /* lookup the current USB transfer, if any */ 944ae60fdfbSAndrew Thompson xfer = ep->endpoint_q.curr; 94502ac6454SAndrew Thompson } else { 94602ac6454SAndrew Thompson xfer = NULL; 94702ac6454SAndrew Thompson } 94802ac6454SAndrew Thompson 94902ac6454SAndrew Thompson /* 95002ac6454SAndrew Thompson * If "xfer" is non-NULL the "set_stall" method will 95102ac6454SAndrew Thompson * complete the USB transfer like in case of a timeout 95202ac6454SAndrew Thompson * setting the error code "USB_ERR_STALLED". 95302ac6454SAndrew Thompson */ 95429bd7d7eSAndrew Thompson (udev->bus->methods->set_stall) (udev, xfer, ep, &do_stall); 95502ac6454SAndrew Thompson } 95602ac6454SAndrew Thompson if (!do_stall) { 957ae60fdfbSAndrew Thompson ep->toggle_next = 0; /* reset data toggle */ 958ae60fdfbSAndrew Thompson ep->is_stalled = 0; /* clear stalled state */ 95902ac6454SAndrew Thompson 960ae60fdfbSAndrew Thompson (udev->bus->methods->clear_stall) (udev, ep); 96102ac6454SAndrew Thompson 96202ac6454SAndrew Thompson /* start up the current or next transfer, if any */ 963a593f6b8SAndrew Thompson usb_command_wrapper(&ep->endpoint_q, ep->endpoint_q.curr); 96402ac6454SAndrew Thompson } 96502ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 96602ac6454SAndrew Thompson return (0); 96702ac6454SAndrew Thompson } 96802ac6454SAndrew Thompson 96902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 970a593f6b8SAndrew Thompson * usb_reset_iface_endpoints - used in USB device side mode 97102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 972e0a69b51SAndrew Thompson usb_error_t 973a593f6b8SAndrew Thompson usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index) 97402ac6454SAndrew Thompson { 975ae60fdfbSAndrew Thompson struct usb_endpoint *ep; 976ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end; 97702ac6454SAndrew Thompson 978ae60fdfbSAndrew Thompson ep = udev->endpoints; 979ae60fdfbSAndrew Thompson ep_end = udev->endpoints + udev->endpoints_max; 98002ac6454SAndrew Thompson 981ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 98202ac6454SAndrew Thompson 983ae60fdfbSAndrew Thompson if ((ep->edesc == NULL) || 984ae60fdfbSAndrew Thompson (ep->iface_index != iface_index)) { 98502ac6454SAndrew Thompson continue; 98602ac6454SAndrew Thompson } 98702ac6454SAndrew Thompson /* simulate a clear stall from the peer */ 988bd73b187SAlfred Perlstein usbd_set_endpoint_stall(udev, ep, 0); 98902ac6454SAndrew Thompson } 99002ac6454SAndrew Thompson return (0); 99102ac6454SAndrew Thompson } 99202ac6454SAndrew Thompson 99302ac6454SAndrew Thompson /*------------------------------------------------------------------------* 994a593f6b8SAndrew Thompson * usb_detach_device_sub 99502ac6454SAndrew Thompson * 99602ac6454SAndrew Thompson * This function will try to detach an USB device. If it fails a panic 99702ac6454SAndrew Thompson * will result. 998bdd41206SAndrew Thompson * 999bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 100002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 100102ac6454SAndrew Thompson static void 1002a593f6b8SAndrew Thompson usb_detach_device_sub(struct usb_device *udev, device_t *ppdev, 1003bdd41206SAndrew Thompson uint8_t flag) 100402ac6454SAndrew Thompson { 100502ac6454SAndrew Thompson device_t dev; 100602ac6454SAndrew Thompson int err; 100702ac6454SAndrew Thompson 1008d88688c7SAndrew Thompson dev = *ppdev; 1009d88688c7SAndrew Thompson if (dev) { 101002ac6454SAndrew Thompson /* 101102ac6454SAndrew Thompson * NOTE: It is important to clear "*ppdev" before deleting 101202ac6454SAndrew Thompson * the child due to some device methods being called late 101302ac6454SAndrew Thompson * during the delete process ! 101402ac6454SAndrew Thompson */ 101502ac6454SAndrew Thompson *ppdev = NULL; 101602ac6454SAndrew Thompson 101702ac6454SAndrew Thompson device_printf(dev, "at %s, port %d, addr %d " 101802ac6454SAndrew Thompson "(disconnected)\n", 101902ac6454SAndrew Thompson device_get_nameunit(udev->parent_dev), 102002ac6454SAndrew Thompson udev->port_no, udev->address); 102102ac6454SAndrew Thompson 102202ac6454SAndrew Thompson if (device_is_attached(dev)) { 1023ec8f3127SAndrew Thompson if (udev->flags.peer_suspended) { 102402ac6454SAndrew Thompson err = DEVICE_RESUME(dev); 102502ac6454SAndrew Thompson if (err) { 1026767cb2e2SAndrew Thompson device_printf(dev, "Resume failed\n"); 102702ac6454SAndrew Thompson } 102802ac6454SAndrew Thompson } 102902ac6454SAndrew Thompson if (device_detach(dev)) { 103002ac6454SAndrew Thompson goto error; 103102ac6454SAndrew Thompson } 103202ac6454SAndrew Thompson } 103302ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, dev)) { 103402ac6454SAndrew Thompson goto error; 103502ac6454SAndrew Thompson } 103602ac6454SAndrew Thompson } 103702ac6454SAndrew Thompson return; 103802ac6454SAndrew Thompson 103902ac6454SAndrew Thompson error: 104002ac6454SAndrew Thompson /* Detach is not allowed to fail in the USB world */ 1041767cb2e2SAndrew Thompson panic("A USB driver would not detach\n"); 104202ac6454SAndrew Thompson } 104302ac6454SAndrew Thompson 104402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1045a593f6b8SAndrew Thompson * usb_detach_device 104602ac6454SAndrew Thompson * 104702ac6454SAndrew Thompson * The following function will detach the matching interfaces. 104802ac6454SAndrew Thompson * This function is NULL safe. 1049bdd41206SAndrew Thompson * 1050bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 105102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 105202ac6454SAndrew Thompson void 1053a593f6b8SAndrew Thompson usb_detach_device(struct usb_device *udev, uint8_t iface_index, 1054bdd41206SAndrew Thompson uint8_t flag) 105502ac6454SAndrew Thompson { 1056760bc48eSAndrew Thompson struct usb_interface *iface; 105702ac6454SAndrew Thompson uint8_t i; 105802ac6454SAndrew Thompson 105902ac6454SAndrew Thompson if (udev == NULL) { 106002ac6454SAndrew Thompson /* nothing to do */ 106102ac6454SAndrew Thompson return; 106202ac6454SAndrew Thompson } 106302ac6454SAndrew Thompson DPRINTFN(4, "udev=%p\n", udev); 106402ac6454SAndrew Thompson 106591cd9240SAndrew Thompson sx_assert(&udev->enum_sx, SA_LOCKED); 106602ac6454SAndrew Thompson 106702ac6454SAndrew Thompson /* 106802ac6454SAndrew Thompson * First detach the child to give the child's detach routine a 106902ac6454SAndrew Thompson * chance to detach the sub-devices in the correct order. 107002ac6454SAndrew Thompson * Then delete the child using "device_delete_child()" which 107102ac6454SAndrew Thompson * will detach all sub-devices from the bottom and upwards! 107202ac6454SAndrew Thompson */ 107302ac6454SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 107402ac6454SAndrew Thompson i = iface_index; 107502ac6454SAndrew Thompson iface_index = i + 1; 107602ac6454SAndrew Thompson } else { 107702ac6454SAndrew Thompson i = 0; 107802ac6454SAndrew Thompson iface_index = USB_IFACE_MAX; 107902ac6454SAndrew Thompson } 108002ac6454SAndrew Thompson 108102ac6454SAndrew Thompson /* do the detach */ 108202ac6454SAndrew Thompson 108302ac6454SAndrew Thompson for (; i != iface_index; i++) { 108402ac6454SAndrew Thompson 1085a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 108602ac6454SAndrew Thompson if (iface == NULL) { 108702ac6454SAndrew Thompson /* looks like the end of the USB interfaces */ 108802ac6454SAndrew Thompson break; 108902ac6454SAndrew Thompson } 1090a593f6b8SAndrew Thompson usb_detach_device_sub(udev, &iface->subdev, flag); 109102ac6454SAndrew Thompson } 109202ac6454SAndrew Thompson } 109302ac6454SAndrew Thompson 109402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1095a593f6b8SAndrew Thompson * usb_probe_and_attach_sub 109602ac6454SAndrew Thompson * 109702ac6454SAndrew Thompson * Returns: 109802ac6454SAndrew Thompson * 0: Success 109902ac6454SAndrew Thompson * Else: Failure 110002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 110102ac6454SAndrew Thompson static uint8_t 1102a593f6b8SAndrew Thompson usb_probe_and_attach_sub(struct usb_device *udev, 1103760bc48eSAndrew Thompson struct usb_attach_arg *uaa) 110402ac6454SAndrew Thompson { 1105760bc48eSAndrew Thompson struct usb_interface *iface; 110602ac6454SAndrew Thompson device_t dev; 110702ac6454SAndrew Thompson int err; 110802ac6454SAndrew Thompson 110902ac6454SAndrew Thompson iface = uaa->iface; 111002ac6454SAndrew Thompson if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) { 111102ac6454SAndrew Thompson /* leave interface alone */ 111202ac6454SAndrew Thompson return (0); 111302ac6454SAndrew Thompson } 111402ac6454SAndrew Thompson dev = iface->subdev; 111502ac6454SAndrew Thompson if (dev) { 111602ac6454SAndrew Thompson 111702ac6454SAndrew Thompson /* clean up after module unload */ 111802ac6454SAndrew Thompson 111902ac6454SAndrew Thompson if (device_is_attached(dev)) { 112002ac6454SAndrew Thompson /* already a device there */ 112102ac6454SAndrew Thompson return (0); 112202ac6454SAndrew Thompson } 112302ac6454SAndrew Thompson /* clear "iface->subdev" as early as possible */ 112402ac6454SAndrew Thompson 112502ac6454SAndrew Thompson iface->subdev = NULL; 112602ac6454SAndrew Thompson 112702ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, dev)) { 112802ac6454SAndrew Thompson 112902ac6454SAndrew Thompson /* 113002ac6454SAndrew Thompson * Panic here, else one can get a double call 113102ac6454SAndrew Thompson * to device_detach(). USB devices should 113202ac6454SAndrew Thompson * never fail on detach! 113302ac6454SAndrew Thompson */ 1134767cb2e2SAndrew Thompson panic("device_delete_child() failed\n"); 113502ac6454SAndrew Thompson } 113602ac6454SAndrew Thompson } 113702ac6454SAndrew Thompson if (uaa->temp_dev == NULL) { 113802ac6454SAndrew Thompson 113902ac6454SAndrew Thompson /* create a new child */ 114002ac6454SAndrew Thompson uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1); 114102ac6454SAndrew Thompson if (uaa->temp_dev == NULL) { 114202ac6454SAndrew Thompson device_printf(udev->parent_dev, 1143767cb2e2SAndrew Thompson "Device creation failed\n"); 114402ac6454SAndrew Thompson return (1); /* failure */ 114502ac6454SAndrew Thompson } 114602ac6454SAndrew Thompson device_set_ivars(uaa->temp_dev, uaa); 114702ac6454SAndrew Thompson device_quiet(uaa->temp_dev); 114802ac6454SAndrew Thompson } 114902ac6454SAndrew Thompson /* 115002ac6454SAndrew Thompson * Set "subdev" before probe and attach so that "devd" gets 115102ac6454SAndrew Thompson * the information it needs. 115202ac6454SAndrew Thompson */ 115302ac6454SAndrew Thompson iface->subdev = uaa->temp_dev; 115402ac6454SAndrew Thompson 115502ac6454SAndrew Thompson if (device_probe_and_attach(iface->subdev) == 0) { 115602ac6454SAndrew Thompson /* 115702ac6454SAndrew Thompson * The USB attach arguments are only available during probe 115802ac6454SAndrew Thompson * and attach ! 115902ac6454SAndrew Thompson */ 116002ac6454SAndrew Thompson uaa->temp_dev = NULL; 116102ac6454SAndrew Thompson device_set_ivars(iface->subdev, NULL); 116202ac6454SAndrew Thompson 1163ec8f3127SAndrew Thompson if (udev->flags.peer_suspended) { 116402ac6454SAndrew Thompson err = DEVICE_SUSPEND(iface->subdev); 116588b4e0abSAndrew Thompson if (err) 116602ac6454SAndrew Thompson device_printf(iface->subdev, "Suspend failed\n"); 116702ac6454SAndrew Thompson } 116802ac6454SAndrew Thompson return (0); /* success */ 116902ac6454SAndrew Thompson } else { 117002ac6454SAndrew Thompson /* No USB driver found */ 117102ac6454SAndrew Thompson iface->subdev = NULL; 117202ac6454SAndrew Thompson } 117302ac6454SAndrew Thompson return (1); /* failure */ 117402ac6454SAndrew Thompson } 117502ac6454SAndrew Thompson 117602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1177a593f6b8SAndrew Thompson * usbd_set_parent_iface 117802ac6454SAndrew Thompson * 117902ac6454SAndrew Thompson * Using this function will lock the alternate interface setting on an 118002ac6454SAndrew Thompson * interface. It is typically used for multi interface drivers. In USB 118102ac6454SAndrew Thompson * device side mode it is assumed that the alternate interfaces all 118202ac6454SAndrew Thompson * have the same endpoint descriptors. The default parent index value 118302ac6454SAndrew Thompson * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not 118402ac6454SAndrew Thompson * locked. 118502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 118602ac6454SAndrew Thompson void 1187a593f6b8SAndrew Thompson usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index, 118802ac6454SAndrew Thompson uint8_t parent_index) 118902ac6454SAndrew Thompson { 1190760bc48eSAndrew Thompson struct usb_interface *iface; 119102ac6454SAndrew Thompson 1192a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, iface_index); 119302ac6454SAndrew Thompson if (iface) { 119402ac6454SAndrew Thompson iface->parent_iface_index = parent_index; 119502ac6454SAndrew Thompson } 119602ac6454SAndrew Thompson } 119702ac6454SAndrew Thompson 119802ac6454SAndrew Thompson static void 1199a593f6b8SAndrew Thompson usb_init_attach_arg(struct usb_device *udev, 1200760bc48eSAndrew Thompson struct usb_attach_arg *uaa) 120102ac6454SAndrew Thompson { 120202ac6454SAndrew Thompson bzero(uaa, sizeof(*uaa)); 120302ac6454SAndrew Thompson 120402ac6454SAndrew Thompson uaa->device = udev; 1205f29a0724SAndrew Thompson uaa->usb_mode = udev->flags.usb_mode; 120602ac6454SAndrew Thompson uaa->port = udev->port_no; 12072a4c6157SAndrew Thompson uaa->dev_state = UAA_DEV_READY; 120802ac6454SAndrew Thompson 120902ac6454SAndrew Thompson uaa->info.idVendor = UGETW(udev->ddesc.idVendor); 121002ac6454SAndrew Thompson uaa->info.idProduct = UGETW(udev->ddesc.idProduct); 121102ac6454SAndrew Thompson uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice); 121202ac6454SAndrew Thompson uaa->info.bDeviceClass = udev->ddesc.bDeviceClass; 121302ac6454SAndrew Thompson uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass; 121402ac6454SAndrew Thompson uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol; 121502ac6454SAndrew Thompson uaa->info.bConfigIndex = udev->curr_config_index; 121602ac6454SAndrew Thompson uaa->info.bConfigNum = udev->curr_config_no; 121702ac6454SAndrew Thompson } 121802ac6454SAndrew Thompson 121902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1220a593f6b8SAndrew Thompson * usb_probe_and_attach 122102ac6454SAndrew Thompson * 122202ac6454SAndrew Thompson * This function is called from "uhub_explore_sub()", 1223a593f6b8SAndrew Thompson * "usb_handle_set_config()" and "usb_handle_request()". 122402ac6454SAndrew Thompson * 122502ac6454SAndrew Thompson * Returns: 122602ac6454SAndrew Thompson * 0: Success 122702ac6454SAndrew Thompson * Else: A control transfer failed 122802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1229e0a69b51SAndrew Thompson usb_error_t 1230a593f6b8SAndrew Thompson usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index) 123102ac6454SAndrew Thompson { 1232760bc48eSAndrew Thompson struct usb_attach_arg uaa; 1233760bc48eSAndrew Thompson struct usb_interface *iface; 123402ac6454SAndrew Thompson uint8_t i; 123502ac6454SAndrew Thompson uint8_t j; 123602ac6454SAndrew Thompson uint8_t do_unlock; 123702ac6454SAndrew Thompson 123802ac6454SAndrew Thompson if (udev == NULL) { 123902ac6454SAndrew Thompson DPRINTF("udev == NULL\n"); 124002ac6454SAndrew Thompson return (USB_ERR_INVAL); 124102ac6454SAndrew Thompson } 124202ac6454SAndrew Thompson /* automatic locking */ 1243cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 124402ac6454SAndrew Thompson do_unlock = 0; 124502ac6454SAndrew Thompson } else { 124602ac6454SAndrew Thompson do_unlock = 1; 1247cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 124802ac6454SAndrew Thompson } 124902ac6454SAndrew Thompson 125002ac6454SAndrew Thompson if (udev->curr_config_index == USB_UNCONFIG_INDEX) { 125102ac6454SAndrew Thompson /* do nothing - no configuration has been set */ 125202ac6454SAndrew Thompson goto done; 125302ac6454SAndrew Thompson } 125402ac6454SAndrew Thompson /* setup USB attach arguments */ 125502ac6454SAndrew Thompson 1256a593f6b8SAndrew Thompson usb_init_attach_arg(udev, &uaa); 125702ac6454SAndrew Thompson 125802ac6454SAndrew Thompson /* Check if only one interface should be probed: */ 125902ac6454SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 126002ac6454SAndrew Thompson i = iface_index; 126102ac6454SAndrew Thompson j = i + 1; 126202ac6454SAndrew Thompson } else { 126302ac6454SAndrew Thompson i = 0; 126402ac6454SAndrew Thompson j = USB_IFACE_MAX; 126502ac6454SAndrew Thompson } 126602ac6454SAndrew Thompson 126702ac6454SAndrew Thompson /* Do the probe and attach */ 126802ac6454SAndrew Thompson for (; i != j; i++) { 126902ac6454SAndrew Thompson 1270a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 127102ac6454SAndrew Thompson if (iface == NULL) { 127202ac6454SAndrew Thompson /* 127302ac6454SAndrew Thompson * Looks like the end of the USB 127402ac6454SAndrew Thompson * interfaces ! 127502ac6454SAndrew Thompson */ 127602ac6454SAndrew Thompson DPRINTFN(2, "end of interfaces " 127702ac6454SAndrew Thompson "at %u\n", i); 127802ac6454SAndrew Thompson break; 127902ac6454SAndrew Thompson } 128002ac6454SAndrew Thompson if (iface->idesc == NULL) { 128102ac6454SAndrew Thompson /* no interface descriptor */ 128202ac6454SAndrew Thompson continue; 128302ac6454SAndrew Thompson } 128402ac6454SAndrew Thompson uaa.iface = iface; 128502ac6454SAndrew Thompson 128602ac6454SAndrew Thompson uaa.info.bInterfaceClass = 128702ac6454SAndrew Thompson iface->idesc->bInterfaceClass; 128802ac6454SAndrew Thompson uaa.info.bInterfaceSubClass = 128902ac6454SAndrew Thompson iface->idesc->bInterfaceSubClass; 129002ac6454SAndrew Thompson uaa.info.bInterfaceProtocol = 129102ac6454SAndrew Thompson iface->idesc->bInterfaceProtocol; 129202ac6454SAndrew Thompson uaa.info.bIfaceIndex = i; 129302ac6454SAndrew Thompson uaa.info.bIfaceNum = 129402ac6454SAndrew Thompson iface->idesc->bInterfaceNumber; 129502ac6454SAndrew Thompson uaa.use_generic = 0; 1296bd73b187SAlfred Perlstein uaa.driver_info = 0; /* reset driver_info */ 129702ac6454SAndrew Thompson 129802ac6454SAndrew Thompson DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n", 129902ac6454SAndrew Thompson uaa.info.bInterfaceClass, 130002ac6454SAndrew Thompson uaa.info.bInterfaceSubClass, 130102ac6454SAndrew Thompson uaa.info.bInterfaceProtocol, 130202ac6454SAndrew Thompson uaa.info.bIfaceIndex, 130302ac6454SAndrew Thompson uaa.info.bIfaceNum); 130402ac6454SAndrew Thompson 130502ac6454SAndrew Thompson /* try specific interface drivers first */ 130602ac6454SAndrew Thompson 1307a593f6b8SAndrew Thompson if (usb_probe_and_attach_sub(udev, &uaa)) { 130802ac6454SAndrew Thompson /* ignore */ 130902ac6454SAndrew Thompson } 131002ac6454SAndrew Thompson /* try generic interface drivers last */ 131102ac6454SAndrew Thompson 131202ac6454SAndrew Thompson uaa.use_generic = 1; 1313bd73b187SAlfred Perlstein uaa.driver_info = 0; /* reset driver_info */ 131402ac6454SAndrew Thompson 1315a593f6b8SAndrew Thompson if (usb_probe_and_attach_sub(udev, &uaa)) { 131602ac6454SAndrew Thompson /* ignore */ 131702ac6454SAndrew Thompson } 131802ac6454SAndrew Thompson } 131902ac6454SAndrew Thompson 132002ac6454SAndrew Thompson if (uaa.temp_dev) { 132102ac6454SAndrew Thompson /* remove the last created child; it is unused */ 132202ac6454SAndrew Thompson 132302ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, uaa.temp_dev)) { 1324767cb2e2SAndrew Thompson DPRINTFN(0, "device delete child failed\n"); 132502ac6454SAndrew Thompson } 132602ac6454SAndrew Thompson } 132702ac6454SAndrew Thompson done: 1328cb18f7d1SAlfred Perlstein if (do_unlock) 1329cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 1330cb18f7d1SAlfred Perlstein 133102ac6454SAndrew Thompson return (0); 133202ac6454SAndrew Thompson } 133302ac6454SAndrew Thompson 133402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1335a593f6b8SAndrew Thompson * usb_suspend_resume_sub 133602ac6454SAndrew Thompson * 133702ac6454SAndrew Thompson * This function is called when the suspend or resume methods should 133802ac6454SAndrew Thompson * be executed on an USB device. 133902ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 134002ac6454SAndrew Thompson static void 1341a593f6b8SAndrew Thompson usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend) 134202ac6454SAndrew Thompson { 134302ac6454SAndrew Thompson int err; 134402ac6454SAndrew Thompson 134502ac6454SAndrew Thompson if (dev == NULL) { 134602ac6454SAndrew Thompson return; 134702ac6454SAndrew Thompson } 134802ac6454SAndrew Thompson if (!device_is_attached(dev)) { 134902ac6454SAndrew Thompson return; 135002ac6454SAndrew Thompson } 135102ac6454SAndrew Thompson if (do_suspend) { 135202ac6454SAndrew Thompson err = DEVICE_SUSPEND(dev); 135302ac6454SAndrew Thompson } else { 135402ac6454SAndrew Thompson err = DEVICE_RESUME(dev); 135502ac6454SAndrew Thompson } 135602ac6454SAndrew Thompson if (err) { 1357767cb2e2SAndrew Thompson device_printf(dev, "%s failed\n", 135802ac6454SAndrew Thompson do_suspend ? "Suspend" : "Resume"); 135902ac6454SAndrew Thompson } 136002ac6454SAndrew Thompson } 136102ac6454SAndrew Thompson 136202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1363a593f6b8SAndrew Thompson * usb_suspend_resume 136402ac6454SAndrew Thompson * 136502ac6454SAndrew Thompson * The following function will suspend or resume the USB device. 136602ac6454SAndrew Thompson * 136702ac6454SAndrew Thompson * Returns: 136802ac6454SAndrew Thompson * 0: Success 136902ac6454SAndrew Thompson * Else: Failure 137002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1371e0a69b51SAndrew Thompson usb_error_t 1372a593f6b8SAndrew Thompson usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend) 137302ac6454SAndrew Thompson { 1374760bc48eSAndrew Thompson struct usb_interface *iface; 137502ac6454SAndrew Thompson uint8_t i; 137602ac6454SAndrew Thompson 137702ac6454SAndrew Thompson if (udev == NULL) { 137802ac6454SAndrew Thompson /* nothing to do */ 137902ac6454SAndrew Thompson return (0); 138002ac6454SAndrew Thompson } 138102ac6454SAndrew Thompson DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend); 138202ac6454SAndrew Thompson 138391cd9240SAndrew Thompson sx_assert(&udev->enum_sx, SA_LOCKED); 138402ac6454SAndrew Thompson 138502ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 138602ac6454SAndrew Thompson /* filter the suspend events */ 1387ec8f3127SAndrew Thompson if (udev->flags.peer_suspended == do_suspend) { 138802ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 138902ac6454SAndrew Thompson /* nothing to do */ 139002ac6454SAndrew Thompson return (0); 139102ac6454SAndrew Thompson } 1392ec8f3127SAndrew Thompson udev->flags.peer_suspended = do_suspend; 139302ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 139402ac6454SAndrew Thompson 139502ac6454SAndrew Thompson /* do the suspend or resume */ 139602ac6454SAndrew Thompson 139702ac6454SAndrew Thompson for (i = 0; i != USB_IFACE_MAX; i++) { 139802ac6454SAndrew Thompson 1399a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 140002ac6454SAndrew Thompson if (iface == NULL) { 140102ac6454SAndrew Thompson /* looks like the end of the USB interfaces */ 140202ac6454SAndrew Thompson break; 140302ac6454SAndrew Thompson } 1404a593f6b8SAndrew Thompson usb_suspend_resume_sub(udev, iface->subdev, do_suspend); 140502ac6454SAndrew Thompson } 140602ac6454SAndrew Thompson return (0); 140702ac6454SAndrew Thompson } 140802ac6454SAndrew Thompson 140902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1410a593f6b8SAndrew Thompson * usbd_clear_stall_proc 141102ac6454SAndrew Thompson * 141202ac6454SAndrew Thompson * This function performs generic USB clear stall operations. 141302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 141402ac6454SAndrew Thompson static void 1415a593f6b8SAndrew Thompson usbd_clear_stall_proc(struct usb_proc_msg *_pm) 141602ac6454SAndrew Thompson { 1417760bc48eSAndrew Thompson struct usb_clear_stall_msg *pm = (void *)_pm; 1418760bc48eSAndrew Thompson struct usb_device *udev = pm->udev; 141902ac6454SAndrew Thompson 142002ac6454SAndrew Thompson /* Change lock */ 142102ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 142291cd9240SAndrew Thompson mtx_lock(&udev->device_mtx); 142302ac6454SAndrew Thompson 142402ac6454SAndrew Thompson /* Start clear stall callback */ 1425a593f6b8SAndrew Thompson usbd_transfer_start(udev->default_xfer[1]); 142602ac6454SAndrew Thompson 142702ac6454SAndrew Thompson /* Change lock */ 142891cd9240SAndrew Thompson mtx_unlock(&udev->device_mtx); 142902ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 143002ac6454SAndrew Thompson } 143102ac6454SAndrew Thompson 143202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1433a593f6b8SAndrew Thompson * usb_alloc_device 143402ac6454SAndrew Thompson * 143502ac6454SAndrew Thompson * This function allocates a new USB device. This function is called 143602ac6454SAndrew Thompson * when a new device has been put in the powered state, but not yet in 143702ac6454SAndrew Thompson * the addressed state. Get initial descriptor, set the address, get 143802ac6454SAndrew Thompson * full descriptor and get strings. 143902ac6454SAndrew Thompson * 144002ac6454SAndrew Thompson * Return values: 144102ac6454SAndrew Thompson * 0: Failure 144202ac6454SAndrew Thompson * Else: Success 144302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1444760bc48eSAndrew Thompson struct usb_device * 1445a593f6b8SAndrew Thompson usb_alloc_device(device_t parent_dev, struct usb_bus *bus, 1446760bc48eSAndrew Thompson struct usb_device *parent_hub, uint8_t depth, uint8_t port_index, 14478d2dd5ddSAndrew Thompson uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode) 144802ac6454SAndrew Thompson { 1449760bc48eSAndrew Thompson struct usb_attach_arg uaa; 1450760bc48eSAndrew Thompson struct usb_device *udev; 1451760bc48eSAndrew Thompson struct usb_device *adev; 1452760bc48eSAndrew Thompson struct usb_device *hub; 145302ac6454SAndrew Thompson uint8_t *scratch_ptr; 14547a918edfSAndrew Thompson size_t scratch_size; 1455e0a69b51SAndrew Thompson usb_error_t err; 145602ac6454SAndrew Thompson uint8_t device_index; 14572a4c6157SAndrew Thompson uint8_t config_index; 14582a4c6157SAndrew Thompson uint8_t config_quirk; 14592a4c6157SAndrew Thompson uint8_t set_config_failed; 146002ac6454SAndrew Thompson 146102ac6454SAndrew Thompson DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, " 1462f29a0724SAndrew Thompson "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n", 146302ac6454SAndrew Thompson parent_dev, bus, parent_hub, depth, port_index, port_no, 1464f29a0724SAndrew Thompson speed, mode); 146502ac6454SAndrew Thompson 146602ac6454SAndrew Thompson /* 146702ac6454SAndrew Thompson * Find an unused device index. In USB Host mode this is the 146802ac6454SAndrew Thompson * same as the device address. 146902ac6454SAndrew Thompson * 147002ac6454SAndrew Thompson * Device index zero is not used and device index 1 should 147102ac6454SAndrew Thompson * always be the root hub. 147202ac6454SAndrew Thompson */ 147302ac6454SAndrew Thompson for (device_index = USB_ROOT_HUB_ADDR; 147402ac6454SAndrew Thompson (device_index != bus->devices_max) && 147502ac6454SAndrew Thompson (bus->devices[device_index] != NULL); 147602ac6454SAndrew Thompson device_index++) /* nop */; 147702ac6454SAndrew Thompson 147802ac6454SAndrew Thompson if (device_index == bus->devices_max) { 147902ac6454SAndrew Thompson device_printf(bus->bdev, 1480767cb2e2SAndrew Thompson "No free USB device index for new device\n"); 148102ac6454SAndrew Thompson return (NULL); 148202ac6454SAndrew Thompson } 148302ac6454SAndrew Thompson 148402ac6454SAndrew Thompson if (depth > 0x10) { 148502ac6454SAndrew Thompson device_printf(bus->bdev, 1486767cb2e2SAndrew Thompson "Invalid device depth\n"); 148702ac6454SAndrew Thompson return (NULL); 148802ac6454SAndrew Thompson } 148902ac6454SAndrew Thompson udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO); 149002ac6454SAndrew Thompson if (udev == NULL) { 149102ac6454SAndrew Thompson return (NULL); 149202ac6454SAndrew Thompson } 149302ac6454SAndrew Thompson /* initialise our SX-lock */ 149491cd9240SAndrew Thompson sx_init_flags(&udev->ctrl_sx, "USB device SX lock", SX_DUPOK); 149502ac6454SAndrew Thompson 149602ac6454SAndrew Thompson /* initialise our SX-lock */ 149791cd9240SAndrew Thompson sx_init_flags(&udev->enum_sx, "USB config SX lock", SX_DUPOK); 149802ac6454SAndrew Thompson 149991cd9240SAndrew Thompson cv_init(&udev->ctrlreq_cv, "WCTRL"); 150091cd9240SAndrew Thompson cv_init(&udev->ref_cv, "UGONE"); 150102ac6454SAndrew Thompson 150202ac6454SAndrew Thompson /* initialise our mutex */ 150391cd9240SAndrew Thompson mtx_init(&udev->device_mtx, "USB device mutex", NULL, MTX_DEF); 150402ac6454SAndrew Thompson 150502ac6454SAndrew Thompson /* initialise generic clear stall */ 1506a593f6b8SAndrew Thompson udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc; 150702ac6454SAndrew Thompson udev->cs_msg[0].udev = udev; 1508a593f6b8SAndrew Thompson udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc; 150902ac6454SAndrew Thompson udev->cs_msg[1].udev = udev; 151002ac6454SAndrew Thompson 151102ac6454SAndrew Thompson /* initialise some USB device fields */ 151202ac6454SAndrew Thompson udev->parent_hub = parent_hub; 151302ac6454SAndrew Thompson udev->parent_dev = parent_dev; 151402ac6454SAndrew Thompson udev->port_index = port_index; 151502ac6454SAndrew Thompson udev->port_no = port_no; 151602ac6454SAndrew Thompson udev->depth = depth; 151702ac6454SAndrew Thompson udev->bus = bus; 151802ac6454SAndrew Thompson udev->address = USB_START_ADDR; /* default value */ 1519e0a69b51SAndrew Thompson udev->plugtime = (usb_ticks_t)ticks; 1520a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_POWERED); 152102ac6454SAndrew Thompson /* 152202ac6454SAndrew Thompson * We need to force the power mode to "on" because there are plenty 152302ac6454SAndrew Thompson * of USB devices out there that do not work very well with 152402ac6454SAndrew Thompson * automatic suspend and resume! 152502ac6454SAndrew Thompson */ 152602ac6454SAndrew Thompson udev->power_mode = USB_POWER_MODE_ON; 152702ac6454SAndrew Thompson udev->pwr_save.last_xfer_time = ticks; 152802ac6454SAndrew Thompson /* we are not ready yet */ 152902ac6454SAndrew Thompson udev->refcount = 1; 153002ac6454SAndrew Thompson 153102ac6454SAndrew Thompson /* set up default endpoint descriptor */ 153202ac6454SAndrew Thompson udev->default_ep_desc.bLength = sizeof(udev->default_ep_desc); 153302ac6454SAndrew Thompson udev->default_ep_desc.bDescriptorType = UDESC_ENDPOINT; 153402ac6454SAndrew Thompson udev->default_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT; 153502ac6454SAndrew Thompson udev->default_ep_desc.bmAttributes = UE_CONTROL; 153602ac6454SAndrew Thompson udev->default_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET; 153702ac6454SAndrew Thompson udev->default_ep_desc.wMaxPacketSize[1] = 0; 153802ac6454SAndrew Thompson udev->default_ep_desc.bInterval = 0; 153902ac6454SAndrew Thompson udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET; 154002ac6454SAndrew Thompson 154102ac6454SAndrew Thompson udev->speed = speed; 1542f29a0724SAndrew Thompson udev->flags.usb_mode = mode; 154302ac6454SAndrew Thompson 154402ac6454SAndrew Thompson /* search for our High Speed USB HUB, if any */ 154502ac6454SAndrew Thompson 154602ac6454SAndrew Thompson adev = udev; 154702ac6454SAndrew Thompson hub = udev->parent_hub; 154802ac6454SAndrew Thompson 154902ac6454SAndrew Thompson while (hub) { 155002ac6454SAndrew Thompson if (hub->speed == USB_SPEED_HIGH) { 155102ac6454SAndrew Thompson udev->hs_hub_addr = hub->address; 1552495f25ceSAndrew Thompson udev->parent_hs_hub = hub; 155302ac6454SAndrew Thompson udev->hs_port_no = adev->port_no; 155402ac6454SAndrew Thompson break; 155502ac6454SAndrew Thompson } 155602ac6454SAndrew Thompson adev = hub; 155702ac6454SAndrew Thompson hub = hub->parent_hub; 155802ac6454SAndrew Thompson } 155902ac6454SAndrew Thompson 1560ae60fdfbSAndrew Thompson /* init the default endpoint */ 1561a593f6b8SAndrew Thompson usb_init_endpoint(udev, 0, 156202ac6454SAndrew Thompson &udev->default_ep_desc, 1563ae60fdfbSAndrew Thompson &udev->default_ep); 156402ac6454SAndrew Thompson 156502ac6454SAndrew Thompson /* set device index */ 156602ac6454SAndrew Thompson udev->device_index = device_index; 156702ac6454SAndrew Thompson 15688755859aSAndrew Thompson #if USB_HAVE_UGEN 15690f6e8f93SAndrew Thompson /* Create ugen name */ 1570ee3e3ff5SAndrew Thompson snprintf(udev->ugen_name, sizeof(udev->ugen_name), 1571ee3e3ff5SAndrew Thompson USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev), 1572ee3e3ff5SAndrew Thompson device_index); 15738755859aSAndrew Thompson LIST_INIT(&udev->pd_list); 15748755859aSAndrew Thompson 15750f6e8f93SAndrew Thompson /* Create the control endpoint device */ 1576a593f6b8SAndrew Thompson udev->default_dev = usb_make_dev(udev, 0, FREAD|FWRITE); 15770f6e8f93SAndrew Thompson 15780f6e8f93SAndrew Thompson /* Create a link from /dev/ugenX.X to the default endpoint */ 1579ee3e3ff5SAndrew Thompson make_dev_alias(udev->default_dev, udev->ugen_name); 15800f6e8f93SAndrew Thompson #endif 1581f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_HOST) { 158202ac6454SAndrew Thompson 1583a593f6b8SAndrew Thompson err = usbd_req_set_address(udev, NULL, device_index); 158402ac6454SAndrew Thompson 158502ac6454SAndrew Thompson /* This is the new USB device address from now on */ 158602ac6454SAndrew Thompson 158702ac6454SAndrew Thompson udev->address = device_index; 158802ac6454SAndrew Thompson 158902ac6454SAndrew Thompson /* 159002ac6454SAndrew Thompson * We ignore any set-address errors, hence there are 159102ac6454SAndrew Thompson * buggy USB devices out there that actually receive 159202ac6454SAndrew Thompson * the SETUP PID, but manage to set the address before 159302ac6454SAndrew Thompson * the STATUS stage is ACK'ed. If the device responds 159402ac6454SAndrew Thompson * to the subsequent get-descriptor at the new 159502ac6454SAndrew Thompson * address, then we know that the set-address command 159602ac6454SAndrew Thompson * was successful. 159702ac6454SAndrew Thompson */ 159802ac6454SAndrew Thompson if (err) { 159902ac6454SAndrew Thompson DPRINTFN(0, "set address %d failed " 160003797f33SAndrew Thompson "(%s, ignored)\n", udev->address, 1601a593f6b8SAndrew Thompson usbd_errstr(err)); 160202ac6454SAndrew Thompson } 160302ac6454SAndrew Thompson /* allow device time to set new address */ 1604a593f6b8SAndrew Thompson usb_pause_mtx(NULL, 160502ac6454SAndrew Thompson USB_MS_TO_TICKS(USB_SET_ADDRESS_SETTLE)); 160602ac6454SAndrew Thompson } else { 160702ac6454SAndrew Thompson /* We are not self powered */ 160802ac6454SAndrew Thompson udev->flags.self_powered = 0; 160902ac6454SAndrew Thompson 161002ac6454SAndrew Thompson /* Set unconfigured state */ 161102ac6454SAndrew Thompson udev->curr_config_no = USB_UNCONFIG_NO; 161202ac6454SAndrew Thompson udev->curr_config_index = USB_UNCONFIG_INDEX; 161302ac6454SAndrew Thompson 161402ac6454SAndrew Thompson /* Setup USB descriptors */ 1615a593f6b8SAndrew Thompson err = (usb_temp_setup_by_index_p) (udev, usb_template); 161602ac6454SAndrew Thompson if (err) { 161702ac6454SAndrew Thompson DPRINTFN(0, "setting up USB template failed maybe the USB " 161802ac6454SAndrew Thompson "template module has not been loaded\n"); 161902ac6454SAndrew Thompson goto done; 162002ac6454SAndrew Thompson } 162102ac6454SAndrew Thompson } 1622a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_ADDRESSED); 162302ac6454SAndrew Thompson 162402ac6454SAndrew Thompson /* 162502ac6454SAndrew Thompson * Get the first 8 bytes of the device descriptor ! 162602ac6454SAndrew Thompson * 1627a593f6b8SAndrew Thompson * NOTE: "usbd_do_request" will check the device descriptor 162802ac6454SAndrew Thompson * next time we do a request to see if the maximum packet size 162902ac6454SAndrew Thompson * changed! The 8 first bytes of the device descriptor 163002ac6454SAndrew Thompson * contains the maximum packet size to use on control endpoint 163102ac6454SAndrew Thompson * 0. If this value is different from "USB_MAX_IPACKET" a new 163202ac6454SAndrew Thompson * USB control request will be setup! 163302ac6454SAndrew Thompson */ 1634a593f6b8SAndrew Thompson err = usbd_req_get_desc(udev, NULL, NULL, &udev->ddesc, 163502ac6454SAndrew Thompson USB_MAX_IPACKET, USB_MAX_IPACKET, 0, UDESC_DEVICE, 0, 0); 163602ac6454SAndrew Thompson if (err) { 163702ac6454SAndrew Thompson DPRINTFN(0, "getting device descriptor " 1638767cb2e2SAndrew Thompson "at addr %d failed, %s\n", udev->address, 1639a593f6b8SAndrew Thompson usbd_errstr(err)); 164002ac6454SAndrew Thompson /* XXX try to re-enumerate the device */ 1641a593f6b8SAndrew Thompson err = usbd_req_re_enumerate(udev, NULL); 164202ac6454SAndrew Thompson if (err) { 164302ac6454SAndrew Thompson goto done; 164402ac6454SAndrew Thompson } 164502ac6454SAndrew Thompson } 164602ac6454SAndrew Thompson DPRINTF("adding unit addr=%d, rev=%02x, class=%d, " 164702ac6454SAndrew Thompson "subclass=%d, protocol=%d, maxpacket=%d, len=%d, speed=%d\n", 164802ac6454SAndrew Thompson udev->address, UGETW(udev->ddesc.bcdUSB), 164902ac6454SAndrew Thompson udev->ddesc.bDeviceClass, 165002ac6454SAndrew Thompson udev->ddesc.bDeviceSubClass, 165102ac6454SAndrew Thompson udev->ddesc.bDeviceProtocol, 165202ac6454SAndrew Thompson udev->ddesc.bMaxPacketSize, 165302ac6454SAndrew Thompson udev->ddesc.bLength, 165402ac6454SAndrew Thompson udev->speed); 165502ac6454SAndrew Thompson 165602ac6454SAndrew Thompson /* get the full device descriptor */ 1657a593f6b8SAndrew Thompson err = usbd_req_get_device_desc(udev, NULL, &udev->ddesc); 165802ac6454SAndrew Thompson if (err) { 165902ac6454SAndrew Thompson DPRINTF("addr=%d, getting full desc failed\n", 166002ac6454SAndrew Thompson udev->address); 166102ac6454SAndrew Thompson goto done; 166202ac6454SAndrew Thompson } 166302ac6454SAndrew Thompson /* 166402ac6454SAndrew Thompson * Setup temporary USB attach args so that we can figure out some 166502ac6454SAndrew Thompson * basic quirks for this device. 166602ac6454SAndrew Thompson */ 1667a593f6b8SAndrew Thompson usb_init_attach_arg(udev, &uaa); 166802ac6454SAndrew Thompson 1669a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) { 167002ac6454SAndrew Thompson udev->flags.uq_bus_powered = 1; 167102ac6454SAndrew Thompson } 1672a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) { 167302ac6454SAndrew Thompson udev->flags.no_strings = 1; 167402ac6454SAndrew Thompson } 167502ac6454SAndrew Thompson /* 167602ac6454SAndrew Thompson * Workaround for buggy USB devices. 167702ac6454SAndrew Thompson * 167802ac6454SAndrew Thompson * It appears that some string-less USB chips will crash and 167902ac6454SAndrew Thompson * disappear if any attempts are made to read any string 168002ac6454SAndrew Thompson * descriptors. 168102ac6454SAndrew Thompson * 168202ac6454SAndrew Thompson * Try to detect such chips by checking the strings in the USB 168302ac6454SAndrew Thompson * device descriptor. If no strings are present there we 168402ac6454SAndrew Thompson * simply disable all USB strings. 168502ac6454SAndrew Thompson */ 168602ac6454SAndrew Thompson scratch_ptr = udev->bus->scratch[0].data; 168702ac6454SAndrew Thompson scratch_size = sizeof(udev->bus->scratch[0].data); 168802ac6454SAndrew Thompson 168902ac6454SAndrew Thompson if (udev->ddesc.iManufacturer || 169002ac6454SAndrew Thompson udev->ddesc.iProduct || 169102ac6454SAndrew Thompson udev->ddesc.iSerialNumber) { 169202ac6454SAndrew Thompson /* read out the language ID string */ 1693a593f6b8SAndrew Thompson err = usbd_req_get_string_desc(udev, NULL, 1694c10e1453SAndrew Thompson (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE); 169502ac6454SAndrew Thompson } else { 169602ac6454SAndrew Thompson err = USB_ERR_INVAL; 169702ac6454SAndrew Thompson } 169802ac6454SAndrew Thompson 169902ac6454SAndrew Thompson if (err || (scratch_ptr[0] < 4)) { 170002ac6454SAndrew Thompson udev->flags.no_strings = 1; 170102ac6454SAndrew Thompson } else { 17027a918edfSAndrew Thompson uint16_t langid; 17037a918edfSAndrew Thompson uint16_t pref; 17047a918edfSAndrew Thompson uint16_t mask; 17057a918edfSAndrew Thompson uint8_t x; 17067a918edfSAndrew Thompson 17077a918edfSAndrew Thompson /* load preferred value and mask */ 17087a918edfSAndrew Thompson pref = usb_lang_id; 17097a918edfSAndrew Thompson mask = usb_lang_mask; 17107a918edfSAndrew Thompson 17117a918edfSAndrew Thompson /* align length correctly */ 17127a918edfSAndrew Thompson scratch_ptr[0] &= ~1; 17137a918edfSAndrew Thompson 17147a918edfSAndrew Thompson /* fix compiler warning */ 17157a918edfSAndrew Thompson langid = 0; 17167a918edfSAndrew Thompson 17177a918edfSAndrew Thompson /* search for preferred language */ 17187a918edfSAndrew Thompson for (x = 2; (x < scratch_ptr[0]); x += 2) { 17197a918edfSAndrew Thompson langid = UGETW(scratch_ptr + x); 17207a918edfSAndrew Thompson if ((langid & mask) == pref) 17217a918edfSAndrew Thompson break; 17227a918edfSAndrew Thompson } 17237a918edfSAndrew Thompson if (x >= scratch_ptr[0]) { 172402ac6454SAndrew Thompson /* pick the first language as the default */ 17257a918edfSAndrew Thompson DPRINTFN(1, "Using first language\n"); 17267a918edfSAndrew Thompson langid = UGETW(scratch_ptr + 2); 17277a918edfSAndrew Thompson } 17287a918edfSAndrew Thompson 17297a918edfSAndrew Thompson DPRINTFN(1, "Language selected: 0x%04x\n", langid); 17307a918edfSAndrew Thompson udev->langid = langid; 173102ac6454SAndrew Thompson } 173202ac6454SAndrew Thompson 173302ac6454SAndrew Thompson /* assume 100mA bus powered for now. Changed when configured. */ 173402ac6454SAndrew Thompson udev->power = USB_MIN_POWER; 1735c86aead6SAndrew Thompson /* fetch the vendor and product strings from the device */ 1736a593f6b8SAndrew Thompson usbd_set_device_strings(udev); 173702ac6454SAndrew Thompson 17382a4c6157SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 17392a4c6157SAndrew Thompson /* USB device mode setup is complete */ 17402a4c6157SAndrew Thompson err = 0; 17412a4c6157SAndrew Thompson goto config_done; 17422a4c6157SAndrew Thompson } 174302ac6454SAndrew Thompson 174402ac6454SAndrew Thompson /* 174502ac6454SAndrew Thompson * Most USB devices should attach to config index 0 by 174602ac6454SAndrew Thompson * default 174702ac6454SAndrew Thompson */ 1748a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) { 174902ac6454SAndrew Thompson config_index = 0; 175002ac6454SAndrew Thompson config_quirk = 1; 1751a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) { 175202ac6454SAndrew Thompson config_index = 1; 175302ac6454SAndrew Thompson config_quirk = 1; 1754a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) { 175502ac6454SAndrew Thompson config_index = 2; 175602ac6454SAndrew Thompson config_quirk = 1; 1757a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) { 175802ac6454SAndrew Thompson config_index = 3; 175902ac6454SAndrew Thompson config_quirk = 1; 1760a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) { 176102ac6454SAndrew Thompson config_index = 4; 176202ac6454SAndrew Thompson config_quirk = 1; 176302ac6454SAndrew Thompson } else { 176402ac6454SAndrew Thompson config_index = 0; 176502ac6454SAndrew Thompson config_quirk = 0; 176602ac6454SAndrew Thompson } 176702ac6454SAndrew Thompson 17682a4c6157SAndrew Thompson set_config_failed = 0; 176902ac6454SAndrew Thompson repeat_set_config: 177002ac6454SAndrew Thompson 177102ac6454SAndrew Thompson DPRINTF("setting config %u\n", config_index); 177202ac6454SAndrew Thompson 177302ac6454SAndrew Thompson /* get the USB device configured */ 1774a593f6b8SAndrew Thompson err = usbd_set_config_index(udev, config_index); 177502ac6454SAndrew Thompson if (err) { 177602ac6454SAndrew Thompson if (udev->ddesc.bNumConfigurations != 0) { 177702ac6454SAndrew Thompson if (!set_config_failed) { 177802ac6454SAndrew Thompson set_config_failed = 1; 177902ac6454SAndrew Thompson /* XXX try to re-enumerate the device */ 17802a4c6157SAndrew Thompson err = usbd_req_re_enumerate(udev, NULL); 178102ac6454SAndrew Thompson if (err == 0) 178202ac6454SAndrew Thompson goto repeat_set_config; 178302ac6454SAndrew Thompson } 17842a4c6157SAndrew Thompson DPRINTFN(0, "Failure selecting configuration index %u:" 17852a4c6157SAndrew Thompson "%s, port %u, addr %u (ignored)\n", 1786a593f6b8SAndrew Thompson config_index, usbd_errstr(err), udev->port_no, 178702ac6454SAndrew Thompson udev->address); 178802ac6454SAndrew Thompson } 178902ac6454SAndrew Thompson /* 17902a4c6157SAndrew Thompson * Some USB devices do not have any configurations. Ignore any 17912a4c6157SAndrew Thompson * set config failures! 179202ac6454SAndrew Thompson */ 179302ac6454SAndrew Thompson err = 0; 17942a4c6157SAndrew Thompson goto config_done; 17952a4c6157SAndrew Thompson } 17962a4c6157SAndrew Thompson if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) { 179702ac6454SAndrew Thompson if ((udev->cdesc->bNumInterface < 2) && 17982a4c6157SAndrew Thompson usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) { 17992a4c6157SAndrew Thompson DPRINTFN(0, "Found no endpoints, trying next config\n"); 180002ac6454SAndrew Thompson config_index++; 180102ac6454SAndrew Thompson goto repeat_set_config; 180202ac6454SAndrew Thompson } 180302ac6454SAndrew Thompson if (config_index == 0) { 180402ac6454SAndrew Thompson /* 180502ac6454SAndrew Thompson * Try to figure out if we have an 180602ac6454SAndrew Thompson * auto-install disk there: 180702ac6454SAndrew Thompson */ 1808d84a79e7SAndrew Thompson if (usb_iface_is_cdrom(udev, 0)) { 180902ac6454SAndrew Thompson DPRINTFN(0, "Found possible auto-install " 181002ac6454SAndrew Thompson "disk (trying next config)\n"); 181102ac6454SAndrew Thompson config_index++; 181202ac6454SAndrew Thompson goto repeat_set_config; 181302ac6454SAndrew Thompson } 181402ac6454SAndrew Thompson } 18152a4c6157SAndrew Thompson } 18162a4c6157SAndrew Thompson EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa); 18172a4c6157SAndrew Thompson if (uaa.dev_state != UAA_DEV_READY) { 1818cb18f7d1SAlfred Perlstein /* leave device unconfigured */ 1819d88688c7SAndrew Thompson usb_unconfigure(udev, 0); 182002ac6454SAndrew Thompson } 182102ac6454SAndrew Thompson 18222a4c6157SAndrew Thompson config_done: 182302ac6454SAndrew Thompson DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n", 182402ac6454SAndrew Thompson udev->address, udev, udev->parent_hub); 182502ac6454SAndrew Thompson 182602ac6454SAndrew Thompson /* register our device - we are ready */ 1827a593f6b8SAndrew Thompson usb_bus_port_set_device(bus, parent_hub ? 182802ac6454SAndrew Thompson parent_hub->hub->ports + port_index : NULL, udev, device_index); 182902ac6454SAndrew Thompson 18300f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 18318755859aSAndrew Thompson /* Symlink the ugen device name */ 1832a593f6b8SAndrew Thompson udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name); 18338755859aSAndrew Thompson 18348755859aSAndrew Thompson /* Announce device */ 1835ee3e3ff5SAndrew Thompson printf("%s: <%s> at %s\n", udev->ugen_name, udev->manufacturer, 183602ac6454SAndrew Thompson device_get_nameunit(udev->bus->bdev)); 18377efaaa9aSAndrew Thompson 18383acd904dSAndrew Thompson usb_notify_addq("ATTACH", udev); 18398755859aSAndrew Thompson #endif 184002ac6454SAndrew Thompson done: 184102ac6454SAndrew Thompson if (err) { 1842d88688c7SAndrew Thompson /* 1843d88688c7SAndrew Thompson * Free USB device and all subdevices, if any. 1844d88688c7SAndrew Thompson */ 1845d88688c7SAndrew Thompson usb_free_device(udev, 0); 184602ac6454SAndrew Thompson udev = NULL; 184702ac6454SAndrew Thompson } 184802ac6454SAndrew Thompson return (udev); 184902ac6454SAndrew Thompson } 185002ac6454SAndrew Thompson 18510f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 1852ee3e3ff5SAndrew Thompson static struct cdev * 1853a593f6b8SAndrew Thompson usb_make_dev(struct usb_device *udev, int ep, int mode) 1854ee3e3ff5SAndrew Thompson { 1855760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 1856ee3e3ff5SAndrew Thompson char devname[20]; 1857ee3e3ff5SAndrew Thompson 1858ee3e3ff5SAndrew Thompson /* Store information to locate ourselves again later */ 1859760bc48eSAndrew Thompson pd = malloc(sizeof(struct usb_fs_privdata), M_USBDEV, 1860ee3e3ff5SAndrew Thompson M_WAITOK | M_ZERO); 1861ee3e3ff5SAndrew Thompson pd->bus_index = device_get_unit(udev->bus->bdev); 1862ee3e3ff5SAndrew Thompson pd->dev_index = udev->device_index; 1863ee3e3ff5SAndrew Thompson pd->ep_addr = ep; 1864ee3e3ff5SAndrew Thompson pd->mode = mode; 1865ee3e3ff5SAndrew Thompson 1866ee3e3ff5SAndrew Thompson /* Now, create the device itself */ 1867f5f145baSAndrew Thompson snprintf(devname, sizeof(devname), "%u.%u.%u", 1868f35aaff0SAndrew Thompson pd->bus_index, pd->dev_index, pd->ep_addr); 1869a593f6b8SAndrew Thompson pd->cdev = make_dev(&usb_devsw, 0, UID_ROOT, 1870ee3e3ff5SAndrew Thompson GID_OPERATOR, 0600, USB_DEVICE_DIR "/%s", devname); 1871ee3e3ff5SAndrew Thompson pd->cdev->si_drv1 = pd; 1872ee3e3ff5SAndrew Thompson 1873ee3e3ff5SAndrew Thompson return (pd->cdev); 1874ee3e3ff5SAndrew Thompson } 1875ee3e3ff5SAndrew Thompson 1876ee3e3ff5SAndrew Thompson static void 1877a593f6b8SAndrew Thompson usb_cdev_create(struct usb_device *udev) 1878ee3e3ff5SAndrew Thompson { 1879760bc48eSAndrew Thompson struct usb_config_descriptor *cd; 1880760bc48eSAndrew Thompson struct usb_endpoint_descriptor *ed; 1881760bc48eSAndrew Thompson struct usb_descriptor *desc; 1882760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 1883ee3e3ff5SAndrew Thompson struct cdev *dev; 1884f5f145baSAndrew Thompson int inmode, outmode, inmask, outmask, mode; 1885f5f145baSAndrew Thompson uint8_t ep; 1886ee3e3ff5SAndrew Thompson 1887ee3e3ff5SAndrew Thompson KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries")); 1888ee3e3ff5SAndrew Thompson 1889ee3e3ff5SAndrew Thompson DPRINTFN(2, "Creating device nodes\n"); 1890ee3e3ff5SAndrew Thompson 1891a593f6b8SAndrew Thompson if (usbd_get_mode(udev) == USB_MODE_DEVICE) { 1892ee3e3ff5SAndrew Thompson inmode = FWRITE; 1893ee3e3ff5SAndrew Thompson outmode = FREAD; 1894ee3e3ff5SAndrew Thompson } else { /* USB_MODE_HOST */ 1895ee3e3ff5SAndrew Thompson inmode = FREAD; 1896ee3e3ff5SAndrew Thompson outmode = FWRITE; 1897ee3e3ff5SAndrew Thompson } 1898ee3e3ff5SAndrew Thompson 1899f5f145baSAndrew Thompson inmask = 0; 1900f5f145baSAndrew Thompson outmask = 0; 1901f5f145baSAndrew Thompson desc = NULL; 1902f5f145baSAndrew Thompson 1903f5f145baSAndrew Thompson /* 1904f5f145baSAndrew Thompson * Collect all used endpoint numbers instead of just 1905f5f145baSAndrew Thompson * generating 16 static endpoints. 1906f5f145baSAndrew Thompson */ 1907a593f6b8SAndrew Thompson cd = usbd_get_config_descriptor(udev); 1908a593f6b8SAndrew Thompson while ((desc = usb_desc_foreach(cd, desc))) { 1909f5f145baSAndrew Thompson /* filter out all endpoint descriptors */ 1910f5f145baSAndrew Thompson if ((desc->bDescriptorType == UDESC_ENDPOINT) && 1911f5f145baSAndrew Thompson (desc->bLength >= sizeof(*ed))) { 1912760bc48eSAndrew Thompson ed = (struct usb_endpoint_descriptor *)desc; 1913f5f145baSAndrew Thompson 1914f5f145baSAndrew Thompson /* update masks */ 1915f5f145baSAndrew Thompson ep = ed->bEndpointAddress; 1916f5f145baSAndrew Thompson if (UE_GET_DIR(ep) == UE_DIR_OUT) 1917f5f145baSAndrew Thompson outmask |= 1 << UE_GET_ADDR(ep); 1918f5f145baSAndrew Thompson else 1919f5f145baSAndrew Thompson inmask |= 1 << UE_GET_ADDR(ep); 1920f5f145baSAndrew Thompson } 1921f5f145baSAndrew Thompson } 1922ee3e3ff5SAndrew Thompson 1923ee3e3ff5SAndrew Thompson /* Create all available endpoints except EP0 */ 1924ee3e3ff5SAndrew Thompson for (ep = 1; ep < 16; ep++) { 1925f5f145baSAndrew Thompson mode = inmask & (1 << ep) ? inmode : 0; 1926f5f145baSAndrew Thompson mode |= outmask & (1 << ep) ? outmode : 0; 1927ee3e3ff5SAndrew Thompson if (mode == 0) 1928ee3e3ff5SAndrew Thompson continue; /* no IN or OUT endpoint */ 1929ee3e3ff5SAndrew Thompson 1930a593f6b8SAndrew Thompson dev = usb_make_dev(udev, ep, mode); 1931ee3e3ff5SAndrew Thompson pd = dev->si_drv1; 1932ee3e3ff5SAndrew Thompson LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next); 1933ee3e3ff5SAndrew Thompson } 1934ee3e3ff5SAndrew Thompson } 1935ee3e3ff5SAndrew Thompson 1936ee3e3ff5SAndrew Thompson static void 1937a593f6b8SAndrew Thompson usb_cdev_free(struct usb_device *udev) 1938ee3e3ff5SAndrew Thompson { 1939760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 1940cb18f7d1SAlfred Perlstein struct cdev* pcdev; 1941ee3e3ff5SAndrew Thompson 1942ee3e3ff5SAndrew Thompson DPRINTFN(2, "Freeing device nodes\n"); 1943ee3e3ff5SAndrew Thompson 1944ee3e3ff5SAndrew Thompson while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) { 1945ee3e3ff5SAndrew Thompson KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt")); 1946ee3e3ff5SAndrew Thompson 1947cb18f7d1SAlfred Perlstein pcdev = pd->cdev; 1948ee3e3ff5SAndrew Thompson pd->cdev = NULL; 1949ee3e3ff5SAndrew Thompson LIST_REMOVE(pd, pd_next); 1950cb18f7d1SAlfred Perlstein if (pcdev != NULL) 1951cb18f7d1SAlfred Perlstein destroy_dev_sched_cb(pcdev, usb_cdev_cleanup, pd); 1952ee3e3ff5SAndrew Thompson } 1953ee3e3ff5SAndrew Thompson } 1954ee3e3ff5SAndrew Thompson 1955ee3e3ff5SAndrew Thompson static void 1956a593f6b8SAndrew Thompson usb_cdev_cleanup(void* arg) 1957ee3e3ff5SAndrew Thompson { 1958ee3e3ff5SAndrew Thompson free(arg, M_USBDEV); 1959ee3e3ff5SAndrew Thompson } 19600f6e8f93SAndrew Thompson #endif 1961ee3e3ff5SAndrew Thompson 196202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1963a593f6b8SAndrew Thompson * usb_free_device 196402ac6454SAndrew Thompson * 1965d88688c7SAndrew Thompson * This function is NULL safe and will free an USB device and its 1966d88688c7SAndrew Thompson * children devices, if any. 1967bdd41206SAndrew Thompson * 1968d88688c7SAndrew Thompson * Flag values: Reserved, set to zero. 196902ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 197002ac6454SAndrew Thompson void 1971a593f6b8SAndrew Thompson usb_free_device(struct usb_device *udev, uint8_t flag) 197202ac6454SAndrew Thompson { 1973760bc48eSAndrew Thompson struct usb_bus *bus; 1974bdd41206SAndrew Thompson 1975bdd41206SAndrew Thompson if (udev == NULL) 1976bdd41206SAndrew Thompson return; /* already freed */ 197702ac6454SAndrew Thompson 197802ac6454SAndrew Thompson DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no); 197902ac6454SAndrew Thompson 1980bd216778SAndrew Thompson bus = udev->bus; 1981a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_DETACHED); 1982bdd41206SAndrew Thompson 19838755859aSAndrew Thompson #if USB_HAVE_UGEN 19843acd904dSAndrew Thompson usb_notify_addq("DETACH", udev); 198502ac6454SAndrew Thompson 1986ee3e3ff5SAndrew Thompson printf("%s: <%s> at %s (disconnected)\n", udev->ugen_name, 1987ee3e3ff5SAndrew Thompson udev->manufacturer, device_get_nameunit(bus->bdev)); 198802ac6454SAndrew Thompson 1989ee3e3ff5SAndrew Thompson /* Destroy UGEN symlink, if any */ 199002ac6454SAndrew Thompson if (udev->ugen_symlink) { 1991a593f6b8SAndrew Thompson usb_free_symlink(udev->ugen_symlink); 199202ac6454SAndrew Thompson udev->ugen_symlink = NULL; 199302ac6454SAndrew Thompson } 19948755859aSAndrew Thompson #endif 199502ac6454SAndrew Thompson /* 199602ac6454SAndrew Thompson * Unregister our device first which will prevent any further 199702ac6454SAndrew Thompson * references: 199802ac6454SAndrew Thompson */ 1999a593f6b8SAndrew Thompson usb_bus_port_set_device(bus, udev->parent_hub ? 200002ac6454SAndrew Thompson udev->parent_hub->hub->ports + udev->port_index : NULL, 200102ac6454SAndrew Thompson NULL, USB_ROOT_HUB_ADDR); 200202ac6454SAndrew Thompson 20030f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 200402ac6454SAndrew Thompson /* wait for all pending references to go away: */ 2005a593f6b8SAndrew Thompson mtx_lock(&usb_ref_lock); 200602ac6454SAndrew Thompson udev->refcount--; 200702ac6454SAndrew Thompson while (udev->refcount != 0) { 200891cd9240SAndrew Thompson cv_wait(&udev->ref_cv, &usb_ref_lock); 200902ac6454SAndrew Thompson } 2010a593f6b8SAndrew Thompson mtx_unlock(&usb_ref_lock); 2011bdd41206SAndrew Thompson 2012a593f6b8SAndrew Thompson destroy_dev_sched_cb(udev->default_dev, usb_cdev_cleanup, 2013bdd41206SAndrew Thompson udev->default_dev->si_drv1); 20140f6e8f93SAndrew Thompson #endif 201502ac6454SAndrew Thompson 2016f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 201702ac6454SAndrew Thompson /* stop receiving any control transfers (Device Side Mode) */ 2018a593f6b8SAndrew Thompson usbd_transfer_unsetup(udev->default_xfer, USB_DEFAULT_XFER_MAX); 201902ac6454SAndrew Thompson } 202002ac6454SAndrew Thompson 2021bdd41206SAndrew Thompson /* the following will get the device unconfigured in software */ 2022d88688c7SAndrew Thompson usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0); 202302ac6454SAndrew Thompson 202402ac6454SAndrew Thompson /* unsetup any leftover default USB transfers */ 2025a593f6b8SAndrew Thompson usbd_transfer_unsetup(udev->default_xfer, USB_DEFAULT_XFER_MAX); 202602ac6454SAndrew Thompson 202702ac6454SAndrew Thompson /* template unsetup, if any */ 2028a593f6b8SAndrew Thompson (usb_temp_unsetup_p) (udev); 202902ac6454SAndrew Thompson 203002ac6454SAndrew Thompson /* 203102ac6454SAndrew Thompson * Make sure that our clear-stall messages are not queued 203202ac6454SAndrew Thompson * anywhere: 203302ac6454SAndrew Thompson */ 203402ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 2035a593f6b8SAndrew Thompson usb_proc_mwait(&udev->bus->non_giant_callback_proc, 203602ac6454SAndrew Thompson &udev->cs_msg[0], &udev->cs_msg[1]); 203702ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 203802ac6454SAndrew Thompson 203991cd9240SAndrew Thompson sx_destroy(&udev->ctrl_sx); 204091cd9240SAndrew Thompson sx_destroy(&udev->enum_sx); 204102ac6454SAndrew Thompson 204291cd9240SAndrew Thompson cv_destroy(&udev->ctrlreq_cv); 204391cd9240SAndrew Thompson cv_destroy(&udev->ref_cv); 204402ac6454SAndrew Thompson 204591cd9240SAndrew Thompson mtx_destroy(&udev->device_mtx); 20468755859aSAndrew Thompson #if USB_HAVE_UGEN 2047ee3e3ff5SAndrew Thompson KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries")); 20488755859aSAndrew Thompson #endif 204902ac6454SAndrew Thompson 205002ac6454SAndrew Thompson /* free device */ 205128212de2SAndrew Thompson free(udev->serial, M_USB); 205228212de2SAndrew Thompson free(udev->manufacturer, M_USB); 205328212de2SAndrew Thompson free(udev->product, M_USB); 205402ac6454SAndrew Thompson free(udev, M_USB); 205502ac6454SAndrew Thompson } 205602ac6454SAndrew Thompson 205702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2058a593f6b8SAndrew Thompson * usbd_get_iface 205902ac6454SAndrew Thompson * 206002ac6454SAndrew Thompson * This function is the safe way to get the USB interface structure 206102ac6454SAndrew Thompson * pointer by interface index. 206202ac6454SAndrew Thompson * 206302ac6454SAndrew Thompson * Return values: 206402ac6454SAndrew Thompson * NULL: Interface not present. 206502ac6454SAndrew Thompson * Else: Pointer to USB interface structure. 206602ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 2067760bc48eSAndrew Thompson struct usb_interface * 2068a593f6b8SAndrew Thompson usbd_get_iface(struct usb_device *udev, uint8_t iface_index) 206902ac6454SAndrew Thompson { 2070760bc48eSAndrew Thompson struct usb_interface *iface = udev->ifaces + iface_index; 207102ac6454SAndrew Thompson 2072bdd41206SAndrew Thompson if (iface_index >= udev->ifaces_max) 207302ac6454SAndrew Thompson return (NULL); 207402ac6454SAndrew Thompson return (iface); 207502ac6454SAndrew Thompson } 207602ac6454SAndrew Thompson 207702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 20783c8d24f4SAndrew Thompson * usbd_find_descriptor 207902ac6454SAndrew Thompson * 208002ac6454SAndrew Thompson * This function will lookup the first descriptor that matches the 208102ac6454SAndrew Thompson * criteria given by the arguments "type" and "subtype". Descriptors 208202ac6454SAndrew Thompson * will only be searched within the interface having the index 208302ac6454SAndrew Thompson * "iface_index". If the "id" argument points to an USB descriptor, 208402ac6454SAndrew Thompson * it will be skipped before the search is started. This allows 208502ac6454SAndrew Thompson * searching for multiple descriptors using the same criteria. Else 208602ac6454SAndrew Thompson * the search is started after the interface descriptor. 208702ac6454SAndrew Thompson * 208802ac6454SAndrew Thompson * Return values: 208902ac6454SAndrew Thompson * NULL: End of descriptors 209002ac6454SAndrew Thompson * Else: A descriptor matching the criteria 209102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 209202ac6454SAndrew Thompson void * 20933c8d24f4SAndrew Thompson usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index, 209402ac6454SAndrew Thompson uint8_t type, uint8_t type_mask, 209502ac6454SAndrew Thompson uint8_t subtype, uint8_t subtype_mask) 209602ac6454SAndrew Thompson { 2097760bc48eSAndrew Thompson struct usb_descriptor *desc; 2098760bc48eSAndrew Thompson struct usb_config_descriptor *cd; 2099760bc48eSAndrew Thompson struct usb_interface *iface; 210002ac6454SAndrew Thompson 2101a593f6b8SAndrew Thompson cd = usbd_get_config_descriptor(udev); 210202ac6454SAndrew Thompson if (cd == NULL) { 210302ac6454SAndrew Thompson return (NULL); 210402ac6454SAndrew Thompson } 210502ac6454SAndrew Thompson if (id == NULL) { 2106a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, iface_index); 210702ac6454SAndrew Thompson if (iface == NULL) { 210802ac6454SAndrew Thompson return (NULL); 210902ac6454SAndrew Thompson } 2110a593f6b8SAndrew Thompson id = usbd_get_interface_descriptor(iface); 211102ac6454SAndrew Thompson if (id == NULL) { 211202ac6454SAndrew Thompson return (NULL); 211302ac6454SAndrew Thompson } 211402ac6454SAndrew Thompson } 211502ac6454SAndrew Thompson desc = (void *)id; 211602ac6454SAndrew Thompson 2117a593f6b8SAndrew Thompson while ((desc = usb_desc_foreach(cd, desc))) { 211802ac6454SAndrew Thompson 211902ac6454SAndrew Thompson if (desc->bDescriptorType == UDESC_INTERFACE) { 212002ac6454SAndrew Thompson break; 212102ac6454SAndrew Thompson } 212202ac6454SAndrew Thompson if (((desc->bDescriptorType & type_mask) == type) && 212302ac6454SAndrew Thompson ((desc->bDescriptorSubtype & subtype_mask) == subtype)) { 212402ac6454SAndrew Thompson return (desc); 212502ac6454SAndrew Thompson } 212602ac6454SAndrew Thompson } 212702ac6454SAndrew Thompson return (NULL); 212802ac6454SAndrew Thompson } 212902ac6454SAndrew Thompson 213002ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2131a593f6b8SAndrew Thompson * usb_devinfo 213202ac6454SAndrew Thompson * 213302ac6454SAndrew Thompson * This function will dump information from the device descriptor 213402ac6454SAndrew Thompson * belonging to the USB device pointed to by "udev", to the string 213502ac6454SAndrew Thompson * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes 213602ac6454SAndrew Thompson * including the terminating zero. 213702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 213802ac6454SAndrew Thompson void 2139a593f6b8SAndrew Thompson usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len) 214002ac6454SAndrew Thompson { 2141760bc48eSAndrew Thompson struct usb_device_descriptor *udd = &udev->ddesc; 214202ac6454SAndrew Thompson uint16_t bcdDevice; 214302ac6454SAndrew Thompson uint16_t bcdUSB; 214402ac6454SAndrew Thompson 214502ac6454SAndrew Thompson bcdUSB = UGETW(udd->bcdUSB); 214602ac6454SAndrew Thompson bcdDevice = UGETW(udd->bcdDevice); 214702ac6454SAndrew Thompson 214802ac6454SAndrew Thompson if (udd->bDeviceClass != 0xFF) { 214902ac6454SAndrew Thompson snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/" 21508755859aSAndrew Thompson "%x.%02x, addr %d", 21518755859aSAndrew Thompson udev->manufacturer, udev->product, 215202ac6454SAndrew Thompson udd->bDeviceClass, udd->bDeviceSubClass, 215302ac6454SAndrew Thompson (bcdUSB >> 8), bcdUSB & 0xFF, 215402ac6454SAndrew Thompson (bcdDevice >> 8), bcdDevice & 0xFF, 215502ac6454SAndrew Thompson udev->address); 215602ac6454SAndrew Thompson } else { 215702ac6454SAndrew Thompson snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/" 21588755859aSAndrew Thompson "%x.%02x, addr %d", 21598755859aSAndrew Thompson udev->manufacturer, udev->product, 216002ac6454SAndrew Thompson (bcdUSB >> 8), bcdUSB & 0xFF, 216102ac6454SAndrew Thompson (bcdDevice >> 8), bcdDevice & 0xFF, 216202ac6454SAndrew Thompson udev->address); 216302ac6454SAndrew Thompson } 216402ac6454SAndrew Thompson } 216502ac6454SAndrew Thompson 2166ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 216702ac6454SAndrew Thompson /* 216802ac6454SAndrew Thompson * Descriptions of of known vendors and devices ("products"). 216902ac6454SAndrew Thompson */ 217002ac6454SAndrew Thompson struct usb_knowndev { 217102ac6454SAndrew Thompson uint16_t vendor; 217202ac6454SAndrew Thompson uint16_t product; 217302ac6454SAndrew Thompson uint32_t flags; 217402ac6454SAndrew Thompson const char *vendorname; 217502ac6454SAndrew Thompson const char *productname; 217602ac6454SAndrew Thompson }; 217702ac6454SAndrew Thompson 217802ac6454SAndrew Thompson #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */ 217902ac6454SAndrew Thompson 218002ac6454SAndrew Thompson #include "usbdevs.h" 218102ac6454SAndrew Thompson #include "usbdevs_data.h" 218202ac6454SAndrew Thompson #endif /* USB_VERBOSE */ 218302ac6454SAndrew Thompson 218402ac6454SAndrew Thompson static void 2185a593f6b8SAndrew Thompson usbd_set_device_strings(struct usb_device *udev) 218602ac6454SAndrew Thompson { 2187760bc48eSAndrew Thompson struct usb_device_descriptor *udd = &udev->ddesc; 2188ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 218902ac6454SAndrew Thompson const struct usb_knowndev *kdp; 219002ac6454SAndrew Thompson #endif 21917a918edfSAndrew Thompson uint8_t *temp_ptr; 21927a918edfSAndrew Thompson size_t temp_size; 219302ac6454SAndrew Thompson uint16_t vendor_id; 219402ac6454SAndrew Thompson uint16_t product_id; 219502ac6454SAndrew Thompson 21967a918edfSAndrew Thompson temp_ptr = udev->bus->scratch[0].data; 21977a918edfSAndrew Thompson temp_size = sizeof(udev->bus->scratch[0].data); 21987a918edfSAndrew Thompson 219902ac6454SAndrew Thompson vendor_id = UGETW(udd->idVendor); 220002ac6454SAndrew Thompson product_id = UGETW(udd->idProduct); 220102ac6454SAndrew Thompson 2202c86aead6SAndrew Thompson /* get serial number string */ 22037a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2204c86aead6SAndrew Thompson udev->ddesc.iSerialNumber); 22057a918edfSAndrew Thompson udev->serial = strdup(temp_ptr, M_USB); 220602ac6454SAndrew Thompson 2207c86aead6SAndrew Thompson /* get manufacturer string */ 22087a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2209c86aead6SAndrew Thompson udev->ddesc.iManufacturer); 22107a918edfSAndrew Thompson usb_trim_spaces(temp_ptr); 22117a918edfSAndrew Thompson if (temp_ptr[0] != '\0') 22127a918edfSAndrew Thompson udev->manufacturer = strdup(temp_ptr, M_USB); 2213c86aead6SAndrew Thompson 2214c86aead6SAndrew Thompson /* get product string */ 22157a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2216c86aead6SAndrew Thompson udev->ddesc.iProduct); 22177a918edfSAndrew Thompson usb_trim_spaces(temp_ptr); 22187a918edfSAndrew Thompson if (temp_ptr[0] != '\0') 22197a918edfSAndrew Thompson udev->product = strdup(temp_ptr, M_USB); 2220c86aead6SAndrew Thompson 2221ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 2222c86aead6SAndrew Thompson if (udev->manufacturer == NULL || udev->product == NULL) { 2223c86aead6SAndrew Thompson for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) { 222402ac6454SAndrew Thompson if (kdp->vendor == vendor_id && 222502ac6454SAndrew Thompson (kdp->product == product_id || 222602ac6454SAndrew Thompson (kdp->flags & USB_KNOWNDEV_NOPROD) != 0)) 222702ac6454SAndrew Thompson break; 222802ac6454SAndrew Thompson } 222902ac6454SAndrew Thompson if (kdp->vendorname != NULL) { 2230c86aead6SAndrew Thompson /* XXX should use pointer to knowndevs string */ 2231c86aead6SAndrew Thompson if (udev->manufacturer == NULL) { 2232c86aead6SAndrew Thompson udev->manufacturer = strdup(kdp->vendorname, 2233c86aead6SAndrew Thompson M_USB); 2234c86aead6SAndrew Thompson } 2235c86aead6SAndrew Thompson if (udev->product == NULL && 2236c86aead6SAndrew Thompson (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) { 2237c86aead6SAndrew Thompson udev->product = strdup(kdp->productname, 2238c86aead6SAndrew Thompson M_USB); 2239c86aead6SAndrew Thompson } 224002ac6454SAndrew Thompson } 224102ac6454SAndrew Thompson } 224202ac6454SAndrew Thompson #endif 2243c86aead6SAndrew Thompson /* Provide default strings if none were found */ 2244c86aead6SAndrew Thompson if (udev->manufacturer == NULL) { 22457a918edfSAndrew Thompson snprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id); 22467a918edfSAndrew Thompson udev->manufacturer = strdup(temp_ptr, M_USB); 224702ac6454SAndrew Thompson } 2248c86aead6SAndrew Thompson if (udev->product == NULL) { 22497a918edfSAndrew Thompson snprintf(temp_ptr, temp_size, "product 0x%04x", product_id); 22507a918edfSAndrew Thompson udev->product = strdup(temp_ptr, M_USB); 225102ac6454SAndrew Thompson } 225202ac6454SAndrew Thompson } 225302ac6454SAndrew Thompson 225402ac6454SAndrew Thompson /* 225502ac6454SAndrew Thompson * Returns: 225602ac6454SAndrew Thompson * See: USB_MODE_XXX 225702ac6454SAndrew Thompson */ 2258f29a0724SAndrew Thompson enum usb_hc_mode 2259a593f6b8SAndrew Thompson usbd_get_mode(struct usb_device *udev) 226002ac6454SAndrew Thompson { 2261f29a0724SAndrew Thompson return (udev->flags.usb_mode); 226202ac6454SAndrew Thompson } 226302ac6454SAndrew Thompson 226402ac6454SAndrew Thompson /* 226502ac6454SAndrew Thompson * Returns: 226602ac6454SAndrew Thompson * See: USB_SPEED_XXX 226702ac6454SAndrew Thompson */ 22688d2dd5ddSAndrew Thompson enum usb_dev_speed 2269a593f6b8SAndrew Thompson usbd_get_speed(struct usb_device *udev) 227002ac6454SAndrew Thompson { 227102ac6454SAndrew Thompson return (udev->speed); 227202ac6454SAndrew Thompson } 227302ac6454SAndrew Thompson 227402ac6454SAndrew Thompson uint32_t 2275a593f6b8SAndrew Thompson usbd_get_isoc_fps(struct usb_device *udev) 227602ac6454SAndrew Thompson { 227702ac6454SAndrew Thompson ; /* indent fix */ 227802ac6454SAndrew Thompson switch (udev->speed) { 227902ac6454SAndrew Thompson case USB_SPEED_LOW: 228002ac6454SAndrew Thompson case USB_SPEED_FULL: 228102ac6454SAndrew Thompson return (1000); 228202ac6454SAndrew Thompson default: 228302ac6454SAndrew Thompson return (8000); 228402ac6454SAndrew Thompson } 228502ac6454SAndrew Thompson } 228602ac6454SAndrew Thompson 2287760bc48eSAndrew Thompson struct usb_device_descriptor * 2288a593f6b8SAndrew Thompson usbd_get_device_descriptor(struct usb_device *udev) 228902ac6454SAndrew Thompson { 229002ac6454SAndrew Thompson if (udev == NULL) 229102ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 229202ac6454SAndrew Thompson return (&udev->ddesc); 229302ac6454SAndrew Thompson } 229402ac6454SAndrew Thompson 2295760bc48eSAndrew Thompson struct usb_config_descriptor * 2296a593f6b8SAndrew Thompson usbd_get_config_descriptor(struct usb_device *udev) 229702ac6454SAndrew Thompson { 229802ac6454SAndrew Thompson if (udev == NULL) 229902ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 230002ac6454SAndrew Thompson return (udev->cdesc); 230102ac6454SAndrew Thompson } 230202ac6454SAndrew Thompson 230302ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2304a593f6b8SAndrew Thompson * usb_test_quirk - test a device for a given quirk 230502ac6454SAndrew Thompson * 230602ac6454SAndrew Thompson * Return values: 230702ac6454SAndrew Thompson * 0: The USB device does not have the given quirk. 230802ac6454SAndrew Thompson * Else: The USB device has the given quirk. 230902ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 231002ac6454SAndrew Thompson uint8_t 2311a593f6b8SAndrew Thompson usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk) 231202ac6454SAndrew Thompson { 231302ac6454SAndrew Thompson uint8_t found; 231402ac6454SAndrew Thompson 2315a593f6b8SAndrew Thompson found = (usb_test_quirk_p) (&uaa->info, quirk); 231602ac6454SAndrew Thompson return (found); 231702ac6454SAndrew Thompson } 231802ac6454SAndrew Thompson 2319760bc48eSAndrew Thompson struct usb_interface_descriptor * 2320a593f6b8SAndrew Thompson usbd_get_interface_descriptor(struct usb_interface *iface) 232102ac6454SAndrew Thompson { 232202ac6454SAndrew Thompson if (iface == NULL) 232302ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 232402ac6454SAndrew Thompson return (iface->idesc); 232502ac6454SAndrew Thompson } 232602ac6454SAndrew Thompson 232702ac6454SAndrew Thompson uint8_t 2328a593f6b8SAndrew Thompson usbd_get_interface_altindex(struct usb_interface *iface) 232902ac6454SAndrew Thompson { 233002ac6454SAndrew Thompson return (iface->alt_index); 233102ac6454SAndrew Thompson } 233202ac6454SAndrew Thompson 233302ac6454SAndrew Thompson uint8_t 2334a593f6b8SAndrew Thompson usbd_get_bus_index(struct usb_device *udev) 233502ac6454SAndrew Thompson { 233602ac6454SAndrew Thompson return ((uint8_t)device_get_unit(udev->bus->bdev)); 233702ac6454SAndrew Thompson } 233802ac6454SAndrew Thompson 233902ac6454SAndrew Thompson uint8_t 2340a593f6b8SAndrew Thompson usbd_get_device_index(struct usb_device *udev) 234102ac6454SAndrew Thompson { 234202ac6454SAndrew Thompson return (udev->device_index); 234302ac6454SAndrew Thompson } 234402ac6454SAndrew Thompson 23458755859aSAndrew Thompson #if USB_HAVE_UGEN 234602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2347a593f6b8SAndrew Thompson * usb_notify_addq 234802ac6454SAndrew Thompson * 234902ac6454SAndrew Thompson * This function will generate events for dev. 235002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 23513acd904dSAndrew Thompson #ifndef BURN_BRIDGES 235202ac6454SAndrew Thompson static void 23533acd904dSAndrew Thompson usb_notify_addq_compat(const char *type, struct usb_device *udev) 235402ac6454SAndrew Thompson { 235502ac6454SAndrew Thompson char *data = NULL; 23563acd904dSAndrew Thompson const char *ntype; 235702ac6454SAndrew Thompson struct malloc_type *mt; 235835e0e603SAndrew Thompson const size_t buf_size = 512; 235902ac6454SAndrew Thompson 23603acd904dSAndrew Thompson /* Convert notify type */ 23613acd904dSAndrew Thompson if (strcmp(type, "ATTACH") == 0) 23623acd904dSAndrew Thompson ntype = "+"; 23633acd904dSAndrew Thompson else if (strcmp(type, "DETACH") == 0) 23643acd904dSAndrew Thompson ntype = "-"; 23653acd904dSAndrew Thompson else 23663acd904dSAndrew Thompson return; 23673acd904dSAndrew Thompson 236802ac6454SAndrew Thompson mtx_lock(&malloc_mtx); 236902ac6454SAndrew Thompson mt = malloc_desc2type("bus"); /* XXX M_BUS */ 237002ac6454SAndrew Thompson mtx_unlock(&malloc_mtx); 237102ac6454SAndrew Thompson if (mt == NULL) 237202ac6454SAndrew Thompson return; 237302ac6454SAndrew Thompson 237435e0e603SAndrew Thompson data = malloc(buf_size, mt, M_NOWAIT); 237502ac6454SAndrew Thompson if (data == NULL) 237602ac6454SAndrew Thompson return; 237702ac6454SAndrew Thompson 237802ac6454SAndrew Thompson /* String it all together. */ 237935e0e603SAndrew Thompson snprintf(data, buf_size, 238002ac6454SAndrew Thompson "%s" 2381ee3e3ff5SAndrew Thompson "%s " 238202ac6454SAndrew Thompson "vendor=0x%04x " 238302ac6454SAndrew Thompson "product=0x%04x " 238402ac6454SAndrew Thompson "devclass=0x%02x " 238502ac6454SAndrew Thompson "devsubclass=0x%02x " 238602ac6454SAndrew Thompson "sernum=\"%s\" " 2387bd73b187SAlfred Perlstein "release=0x%04x " 238802ac6454SAndrew Thompson "at " 238902ac6454SAndrew Thompson "port=%u " 239002ac6454SAndrew Thompson "on " 2391ee3e3ff5SAndrew Thompson "%s\n", 23923acd904dSAndrew Thompson ntype, 2393ee3e3ff5SAndrew Thompson udev->ugen_name, 239402ac6454SAndrew Thompson UGETW(udev->ddesc.idVendor), 239502ac6454SAndrew Thompson UGETW(udev->ddesc.idProduct), 239602ac6454SAndrew Thompson udev->ddesc.bDeviceClass, 239702ac6454SAndrew Thompson udev->ddesc.bDeviceSubClass, 239802ac6454SAndrew Thompson udev->serial, 2399bd73b187SAlfred Perlstein UGETW(udev->ddesc.bcdDevice), 240002ac6454SAndrew Thompson udev->port_no, 24018755859aSAndrew Thompson udev->parent_hub != NULL ? 24028755859aSAndrew Thompson udev->parent_hub->ugen_name : 240302ac6454SAndrew Thompson device_get_nameunit(device_get_parent(udev->bus->bdev))); 240462a5f394SAlexander Kabaev 240502ac6454SAndrew Thompson devctl_queue_data(data); 240602ac6454SAndrew Thompson } 24073acd904dSAndrew Thompson #endif 24083acd904dSAndrew Thompson 24093acd904dSAndrew Thompson static void 24103acd904dSAndrew Thompson usb_notify_addq(const char *type, struct usb_device *udev) 24113acd904dSAndrew Thompson { 24123acd904dSAndrew Thompson struct usb_interface *iface; 24133acd904dSAndrew Thompson struct sbuf *sb; 24143acd904dSAndrew Thompson int i; 24153acd904dSAndrew Thompson 24163acd904dSAndrew Thompson #ifndef BURN_BRIDGES 24173acd904dSAndrew Thompson usb_notify_addq_compat(type, udev); 24183acd904dSAndrew Thompson #endif 24193acd904dSAndrew Thompson 24203acd904dSAndrew Thompson /* announce the device */ 24213acd904dSAndrew Thompson sb = sbuf_new_auto(); 24223acd904dSAndrew Thompson sbuf_printf(sb, 24233acd904dSAndrew Thompson "cdev=%s " 24243acd904dSAndrew Thompson "vendor=0x%04x " 24253acd904dSAndrew Thompson "product=0x%04x " 24263acd904dSAndrew Thompson "devclass=0x%02x " 24273acd904dSAndrew Thompson "devsubclass=0x%02x " 24283acd904dSAndrew Thompson "sernum=\"%s\" " 24293acd904dSAndrew Thompson "release=0x%04x " 243066390216SAndrew Thompson "mode=%s " 24313acd904dSAndrew Thompson "port=%u " 24323acd904dSAndrew Thompson "parent=%s\n", 24333acd904dSAndrew Thompson udev->ugen_name, 24343acd904dSAndrew Thompson UGETW(udev->ddesc.idVendor), 24353acd904dSAndrew Thompson UGETW(udev->ddesc.idProduct), 24363acd904dSAndrew Thompson udev->ddesc.bDeviceClass, 24373acd904dSAndrew Thompson udev->ddesc.bDeviceSubClass, 24383acd904dSAndrew Thompson udev->serial, 24393acd904dSAndrew Thompson UGETW(udev->ddesc.bcdDevice), 244066390216SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device", 24413acd904dSAndrew Thompson udev->port_no, 24423acd904dSAndrew Thompson udev->parent_hub != NULL ? 24433acd904dSAndrew Thompson udev->parent_hub->ugen_name : 24443acd904dSAndrew Thompson device_get_nameunit(device_get_parent(udev->bus->bdev))); 24453acd904dSAndrew Thompson sbuf_finish(sb); 24463acd904dSAndrew Thompson devctl_notify("USB", "DEVICE", type, sbuf_data(sb)); 24473acd904dSAndrew Thompson sbuf_delete(sb); 24483acd904dSAndrew Thompson 24493acd904dSAndrew Thompson /* announce each interface */ 24503acd904dSAndrew Thompson for (i = 0; i < USB_IFACE_MAX; i++) { 24513acd904dSAndrew Thompson iface = usbd_get_iface(udev, i); 24523acd904dSAndrew Thompson if (iface == NULL) 24533acd904dSAndrew Thompson break; /* end of interfaces */ 24543acd904dSAndrew Thompson if (iface->idesc == NULL) 24553acd904dSAndrew Thompson continue; /* no interface descriptor */ 24563acd904dSAndrew Thompson 24573acd904dSAndrew Thompson sb = sbuf_new_auto(); 24583acd904dSAndrew Thompson sbuf_printf(sb, 24593acd904dSAndrew Thompson "cdev=%s " 24603acd904dSAndrew Thompson "vendor=0x%04x " 24613acd904dSAndrew Thompson "product=0x%04x " 24623acd904dSAndrew Thompson "devclass=0x%02x " 24633acd904dSAndrew Thompson "devsubclass=0x%02x " 24643acd904dSAndrew Thompson "sernum=\"%s\" " 24653acd904dSAndrew Thompson "release=0x%04x " 246666390216SAndrew Thompson "mode=%s " 24673acd904dSAndrew Thompson "interface=%d " 24683acd904dSAndrew Thompson "endpoints=%d " 24693acd904dSAndrew Thompson "intclass=0x%02x " 24703acd904dSAndrew Thompson "intsubclass=0x%02x " 24713acd904dSAndrew Thompson "intprotocol=0x%02x\n", 24723acd904dSAndrew Thompson udev->ugen_name, 24733acd904dSAndrew Thompson UGETW(udev->ddesc.idVendor), 24743acd904dSAndrew Thompson UGETW(udev->ddesc.idProduct), 24753acd904dSAndrew Thompson udev->ddesc.bDeviceClass, 24763acd904dSAndrew Thompson udev->ddesc.bDeviceSubClass, 24773acd904dSAndrew Thompson udev->serial, 24783acd904dSAndrew Thompson UGETW(udev->ddesc.bcdDevice), 247966390216SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device", 24803acd904dSAndrew Thompson iface->idesc->bInterfaceNumber, 24813acd904dSAndrew Thompson iface->idesc->bNumEndpoints, 24823acd904dSAndrew Thompson iface->idesc->bInterfaceClass, 24833acd904dSAndrew Thompson iface->idesc->bInterfaceSubClass, 24843acd904dSAndrew Thompson iface->idesc->bInterfaceProtocol); 24853acd904dSAndrew Thompson sbuf_finish(sb); 24863acd904dSAndrew Thompson devctl_notify("USB", "INTERFACE", type, sbuf_data(sb)); 24873acd904dSAndrew Thompson sbuf_delete(sb); 24883acd904dSAndrew Thompson } 24893acd904dSAndrew Thompson } 249002ac6454SAndrew Thompson 249102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2492a593f6b8SAndrew Thompson * usb_fifo_free_wrap 249302ac6454SAndrew Thompson * 249402ac6454SAndrew Thompson * This function will free the FIFOs. 249502ac6454SAndrew Thompson * 2496bdd41206SAndrew Thompson * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag 2497bdd41206SAndrew Thompson * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free 2498bdd41206SAndrew Thompson * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and 2499bdd41206SAndrew Thompson * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non 2500bdd41206SAndrew Thompson * control endpoint FIFOs. If "iface_index" is not set to 2501bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" the flag has no effect. 250202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 250302ac6454SAndrew Thompson static void 2504a593f6b8SAndrew Thompson usb_fifo_free_wrap(struct usb_device *udev, 250502ac6454SAndrew Thompson uint8_t iface_index, uint8_t flag) 250602ac6454SAndrew Thompson { 2507760bc48eSAndrew Thompson struct usb_fifo *f; 250802ac6454SAndrew Thompson uint16_t i; 250902ac6454SAndrew Thompson 251002ac6454SAndrew Thompson /* 251102ac6454SAndrew Thompson * Free any USB FIFOs on the given interface: 251202ac6454SAndrew Thompson */ 251302ac6454SAndrew Thompson for (i = 0; i != USB_FIFO_MAX; i++) { 251402ac6454SAndrew Thompson f = udev->fifo[i]; 251502ac6454SAndrew Thompson if (f == NULL) { 251602ac6454SAndrew Thompson continue; 251702ac6454SAndrew Thompson } 251802ac6454SAndrew Thompson /* Check if the interface index matches */ 251902ac6454SAndrew Thompson if (iface_index == f->iface_index) { 2520a593f6b8SAndrew Thompson if (f->methods != &usb_ugen_methods) { 252102ac6454SAndrew Thompson /* 252202ac6454SAndrew Thompson * Don't free any non-generic FIFOs in 252302ac6454SAndrew Thompson * this case. 252402ac6454SAndrew Thompson */ 252502ac6454SAndrew Thompson continue; 252602ac6454SAndrew Thompson } 252702ac6454SAndrew Thompson if ((f->dev_ep_index == 0) && 252802ac6454SAndrew Thompson (f->fs_xfer == NULL)) { 252902ac6454SAndrew Thompson /* no need to free this FIFO */ 253002ac6454SAndrew Thompson continue; 253102ac6454SAndrew Thompson } 253202ac6454SAndrew Thompson } else if (iface_index == USB_IFACE_INDEX_ANY) { 2533a593f6b8SAndrew Thompson if ((f->methods == &usb_ugen_methods) && 2534bdd41206SAndrew Thompson (f->dev_ep_index == 0) && 2535bdd41206SAndrew Thompson (!(flag & USB_UNCFG_FLAG_FREE_EP0)) && 253602ac6454SAndrew Thompson (f->fs_xfer == NULL)) { 253702ac6454SAndrew Thompson /* no need to free this FIFO */ 253802ac6454SAndrew Thompson continue; 253902ac6454SAndrew Thompson } 254002ac6454SAndrew Thompson } else { 254102ac6454SAndrew Thompson /* no need to free this FIFO */ 254202ac6454SAndrew Thompson continue; 254302ac6454SAndrew Thompson } 254402ac6454SAndrew Thompson /* free this FIFO */ 2545a593f6b8SAndrew Thompson usb_fifo_free(f); 254602ac6454SAndrew Thompson } 254702ac6454SAndrew Thompson } 25480f6e8f93SAndrew Thompson #endif 254902ac6454SAndrew Thompson 255002ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2551a593f6b8SAndrew Thompson * usb_peer_can_wakeup 255202ac6454SAndrew Thompson * 255302ac6454SAndrew Thompson * Return values: 255402ac6454SAndrew Thompson * 0: Peer cannot do resume signalling. 255502ac6454SAndrew Thompson * Else: Peer can do resume signalling. 255602ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 255702ac6454SAndrew Thompson uint8_t 2558a593f6b8SAndrew Thompson usb_peer_can_wakeup(struct usb_device *udev) 255902ac6454SAndrew Thompson { 2560760bc48eSAndrew Thompson const struct usb_config_descriptor *cdp; 256102ac6454SAndrew Thompson 256202ac6454SAndrew Thompson cdp = udev->cdesc; 2563f29a0724SAndrew Thompson if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) { 256402ac6454SAndrew Thompson return (cdp->bmAttributes & UC_REMOTE_WAKEUP); 256502ac6454SAndrew Thompson } 256602ac6454SAndrew Thompson return (0); /* not supported */ 256702ac6454SAndrew Thompson } 2568bd216778SAndrew Thompson 2569bd216778SAndrew Thompson void 2570a593f6b8SAndrew Thompson usb_set_device_state(struct usb_device *udev, enum usb_dev_state state) 2571bd216778SAndrew Thompson { 2572bd216778SAndrew Thompson 2573bd216778SAndrew Thompson KASSERT(state < USB_STATE_MAX, ("invalid udev state")); 2574bd216778SAndrew Thompson 2575bd216778SAndrew Thompson DPRINTF("udev %p state %s -> %s\n", udev, 2576a593f6b8SAndrew Thompson usb_statestr(udev->state), usb_statestr(state)); 2577bd216778SAndrew Thompson udev->state = state; 2578bd216778SAndrew Thompson } 2579bd216778SAndrew Thompson 2580ec8f3127SAndrew Thompson uint8_t 2581a593f6b8SAndrew Thompson usbd_device_attached(struct usb_device *udev) 2582bd216778SAndrew Thompson { 2583bd216778SAndrew Thompson return (udev->state > USB_STATE_DETACHED); 2584bd216778SAndrew Thompson } 2585cb18f7d1SAlfred Perlstein 2586cb18f7d1SAlfred Perlstein /* The following function locks enumerating the given USB device. */ 2587cb18f7d1SAlfred Perlstein 2588cb18f7d1SAlfred Perlstein void 2589cb18f7d1SAlfred Perlstein usbd_enum_lock(struct usb_device *udev) 2590cb18f7d1SAlfred Perlstein { 259191cd9240SAndrew Thompson sx_xlock(&udev->enum_sx); 2592cb18f7d1SAlfred Perlstein /* 2593cb18f7d1SAlfred Perlstein * NEWBUS LOCK NOTE: We should check if any parent SX locks 2594cb18f7d1SAlfred Perlstein * are locked before locking Giant. Else the lock can be 2595cb18f7d1SAlfred Perlstein * locked multiple times. 2596cb18f7d1SAlfred Perlstein */ 2597cb18f7d1SAlfred Perlstein mtx_lock(&Giant); 2598cb18f7d1SAlfred Perlstein } 2599cb18f7d1SAlfred Perlstein 2600cb18f7d1SAlfred Perlstein /* The following function unlocks enumerating the given USB device. */ 2601cb18f7d1SAlfred Perlstein 2602cb18f7d1SAlfred Perlstein void 2603cb18f7d1SAlfred Perlstein usbd_enum_unlock(struct usb_device *udev) 2604cb18f7d1SAlfred Perlstein { 2605cb18f7d1SAlfred Perlstein mtx_unlock(&Giant); 260691cd9240SAndrew Thompson sx_xunlock(&udev->enum_sx); 2607cb18f7d1SAlfred Perlstein } 2608cb18f7d1SAlfred Perlstein 2609cb18f7d1SAlfred Perlstein /* 2610cb18f7d1SAlfred Perlstein * The following function checks the enumerating lock for the given 2611cb18f7d1SAlfred Perlstein * USB device. 2612cb18f7d1SAlfred Perlstein */ 2613cb18f7d1SAlfred Perlstein 2614cb18f7d1SAlfred Perlstein uint8_t 2615cb18f7d1SAlfred Perlstein usbd_enum_is_locked(struct usb_device *udev) 2616cb18f7d1SAlfred Perlstein { 261791cd9240SAndrew Thompson return (sx_xlocked(&udev->enum_sx)); 2618cb18f7d1SAlfred Perlstein } 2619