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 139ae538d85SAndrew Thompson const char * 140ae538d85SAndrew Thompson usb_get_manufacturer(struct usb_device *udev) 141ae538d85SAndrew Thompson { 142ae538d85SAndrew Thompson return (udev->manufacturer ? udev->manufacturer : "Unknown"); 143ae538d85SAndrew Thompson } 144ae538d85SAndrew Thompson 145ae538d85SAndrew Thompson const char * 146ae538d85SAndrew Thompson usb_get_product(struct usb_device *udev) 147ae538d85SAndrew Thompson { 148ae538d85SAndrew Thompson return (udev->product ? udev->product : ""); 149ae538d85SAndrew Thompson } 150ae538d85SAndrew Thompson 151ae538d85SAndrew Thompson const char * 152ae538d85SAndrew Thompson usb_get_serial(struct usb_device *udev) 153ae538d85SAndrew Thompson { 154ae538d85SAndrew Thompson return (udev->serial ? udev->serial : ""); 155ae538d85SAndrew Thompson } 156ae538d85SAndrew Thompson 15702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 158a593f6b8SAndrew Thompson * usbd_get_ep_by_addr 15902ac6454SAndrew Thompson * 160ae60fdfbSAndrew Thompson * This function searches for an USB ep by endpoint address and 16102ac6454SAndrew Thompson * direction. 16202ac6454SAndrew Thompson * 16302ac6454SAndrew Thompson * Returns: 16402ac6454SAndrew Thompson * NULL: Failure 16502ac6454SAndrew Thompson * Else: Success 16602ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 167ae60fdfbSAndrew Thompson struct usb_endpoint * 168a593f6b8SAndrew Thompson usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val) 16902ac6454SAndrew Thompson { 170ae60fdfbSAndrew Thompson struct usb_endpoint *ep = udev->endpoints; 171ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max; 17202ac6454SAndrew Thompson enum { 17302ac6454SAndrew Thompson EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR), 17402ac6454SAndrew Thompson }; 17502ac6454SAndrew Thompson 17602ac6454SAndrew Thompson /* 17702ac6454SAndrew Thompson * According to the USB specification not all bits are used 17802ac6454SAndrew Thompson * for the endpoint address. Keep defined bits only: 17902ac6454SAndrew Thompson */ 18002ac6454SAndrew Thompson ea_val &= EA_MASK; 18102ac6454SAndrew Thompson 18202ac6454SAndrew Thompson /* 183ae60fdfbSAndrew Thompson * Iterate accross all the USB endpoints searching for a match 18402ac6454SAndrew Thompson * based on the endpoint address: 18502ac6454SAndrew Thompson */ 186ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 18702ac6454SAndrew Thompson 188ae60fdfbSAndrew Thompson if (ep->edesc == NULL) { 18902ac6454SAndrew Thompson continue; 19002ac6454SAndrew Thompson } 19102ac6454SAndrew Thompson /* do the mask and check the value */ 192ae60fdfbSAndrew Thompson if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) { 19302ac6454SAndrew Thompson goto found; 19402ac6454SAndrew Thompson } 19502ac6454SAndrew Thompson } 19602ac6454SAndrew Thompson 19702ac6454SAndrew Thompson /* 198ae60fdfbSAndrew Thompson * The default endpoint is always present and is checked separately: 19902ac6454SAndrew Thompson */ 2005b3bb704SAndrew Thompson if ((udev->ctrl_ep.edesc) && 2015b3bb704SAndrew Thompson ((udev->ctrl_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) { 2025b3bb704SAndrew Thompson ep = &udev->ctrl_ep; 20302ac6454SAndrew Thompson goto found; 20402ac6454SAndrew Thompson } 20502ac6454SAndrew Thompson return (NULL); 20602ac6454SAndrew Thompson 20702ac6454SAndrew Thompson found: 208ae60fdfbSAndrew Thompson return (ep); 20902ac6454SAndrew Thompson } 21002ac6454SAndrew Thompson 21102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 212a593f6b8SAndrew Thompson * usbd_get_endpoint 21302ac6454SAndrew Thompson * 214ae60fdfbSAndrew Thompson * This function searches for an USB endpoint based on the information 215760bc48eSAndrew Thompson * given by the passed "struct usb_config" pointer. 21602ac6454SAndrew Thompson * 21702ac6454SAndrew Thompson * Return values: 21802ac6454SAndrew Thompson * NULL: No match. 219ae60fdfbSAndrew Thompson * Else: Pointer to "struct usb_endpoint". 22002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 221ae60fdfbSAndrew Thompson struct usb_endpoint * 222a593f6b8SAndrew Thompson usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index, 223760bc48eSAndrew Thompson const struct usb_config *setup) 22402ac6454SAndrew Thompson { 225ae60fdfbSAndrew Thompson struct usb_endpoint *ep = udev->endpoints; 226ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max; 22702ac6454SAndrew Thompson uint8_t index = setup->ep_index; 22802ac6454SAndrew Thompson uint8_t ea_mask; 22902ac6454SAndrew Thompson uint8_t ea_val; 23002ac6454SAndrew Thompson uint8_t type_mask; 23102ac6454SAndrew Thompson uint8_t type_val; 23202ac6454SAndrew Thompson 23302ac6454SAndrew Thompson DPRINTFN(10, "udev=%p iface_index=%d address=0x%x " 23402ac6454SAndrew Thompson "type=0x%x dir=0x%x index=%d\n", 23502ac6454SAndrew Thompson udev, iface_index, setup->endpoint, 23602ac6454SAndrew Thompson setup->type, setup->direction, setup->ep_index); 23702ac6454SAndrew Thompson 2384eae601eSAndrew Thompson /* check USB mode */ 2394eae601eSAndrew Thompson 240f29a0724SAndrew Thompson if (setup->usb_mode != USB_MODE_DUAL && 241f29a0724SAndrew Thompson udev->flags.usb_mode != setup->usb_mode) { 242ae60fdfbSAndrew Thompson /* wrong mode - no endpoint */ 2434eae601eSAndrew Thompson return (NULL); 2444eae601eSAndrew Thompson } 2454eae601eSAndrew Thompson 24602ac6454SAndrew Thompson /* setup expected endpoint direction mask and value */ 24702ac6454SAndrew Thompson 24851ec1603SAndrew Thompson if (setup->direction == UE_DIR_RX) { 24951ec1603SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 250f29a0724SAndrew Thompson ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ? 25151ec1603SAndrew Thompson UE_DIR_OUT : UE_DIR_IN; 25251ec1603SAndrew Thompson } else if (setup->direction == UE_DIR_TX) { 25351ec1603SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 254f29a0724SAndrew Thompson ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ? 25551ec1603SAndrew Thompson UE_DIR_IN : UE_DIR_OUT; 25651ec1603SAndrew Thompson } else if (setup->direction == UE_DIR_ANY) { 25702ac6454SAndrew Thompson /* match any endpoint direction */ 25802ac6454SAndrew Thompson ea_mask = 0; 25902ac6454SAndrew Thompson ea_val = 0; 26002ac6454SAndrew Thompson } else { 26102ac6454SAndrew Thompson /* match the given endpoint direction */ 26202ac6454SAndrew Thompson ea_mask = (UE_DIR_IN | UE_DIR_OUT); 26302ac6454SAndrew Thompson ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT)); 26402ac6454SAndrew Thompson } 26502ac6454SAndrew Thompson 26602ac6454SAndrew Thompson /* setup expected endpoint address */ 26702ac6454SAndrew Thompson 26802ac6454SAndrew Thompson if (setup->endpoint == UE_ADDR_ANY) { 26902ac6454SAndrew Thompson /* match any endpoint address */ 27002ac6454SAndrew Thompson } else { 27102ac6454SAndrew Thompson /* match the given endpoint address */ 27202ac6454SAndrew Thompson ea_mask |= UE_ADDR; 27302ac6454SAndrew Thompson ea_val |= (setup->endpoint & UE_ADDR); 27402ac6454SAndrew Thompson } 27502ac6454SAndrew Thompson 27602ac6454SAndrew Thompson /* setup expected endpoint type */ 27702ac6454SAndrew Thompson 27802ac6454SAndrew Thompson if (setup->type == UE_BULK_INTR) { 27902ac6454SAndrew Thompson /* this will match BULK and INTERRUPT endpoints */ 28002ac6454SAndrew Thompson type_mask = 2; 28102ac6454SAndrew Thompson type_val = 2; 28202ac6454SAndrew Thompson } else if (setup->type == UE_TYPE_ANY) { 28302ac6454SAndrew Thompson /* match any endpoint type */ 28402ac6454SAndrew Thompson type_mask = 0; 28502ac6454SAndrew Thompson type_val = 0; 28602ac6454SAndrew Thompson } else { 28702ac6454SAndrew Thompson /* match the given endpoint type */ 28802ac6454SAndrew Thompson type_mask = UE_XFERTYPE; 28902ac6454SAndrew Thompson type_val = (setup->type & UE_XFERTYPE); 29002ac6454SAndrew Thompson } 29102ac6454SAndrew Thompson 29202ac6454SAndrew Thompson /* 293ae60fdfbSAndrew Thompson * Iterate accross all the USB endpoints searching for a match 29402ac6454SAndrew Thompson * based on the endpoint address. Note that we are searching 295ae60fdfbSAndrew Thompson * the endpoints from the beginning of the "udev->endpoints" array. 29602ac6454SAndrew Thompson */ 297ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 29802ac6454SAndrew Thompson 299ae60fdfbSAndrew Thompson if ((ep->edesc == NULL) || 300ae60fdfbSAndrew Thompson (ep->iface_index != iface_index)) { 30102ac6454SAndrew Thompson continue; 30202ac6454SAndrew Thompson } 30302ac6454SAndrew Thompson /* do the masks and check the values */ 30402ac6454SAndrew Thompson 305ae60fdfbSAndrew Thompson if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) && 306ae60fdfbSAndrew Thompson ((ep->edesc->bmAttributes & type_mask) == type_val)) { 30702ac6454SAndrew Thompson if (!index--) { 30802ac6454SAndrew Thompson goto found; 30902ac6454SAndrew Thompson } 31002ac6454SAndrew Thompson } 31102ac6454SAndrew Thompson } 31202ac6454SAndrew Thompson 31302ac6454SAndrew Thompson /* 314ae60fdfbSAndrew Thompson * Match against default endpoint last, so that "any endpoint", "any 315ae60fdfbSAndrew Thompson * address" and "any direction" returns the first endpoint of the 31602ac6454SAndrew Thompson * interface. "iface_index" and "direction" is ignored: 31702ac6454SAndrew Thompson */ 3185b3bb704SAndrew Thompson if ((udev->ctrl_ep.edesc) && 3195b3bb704SAndrew Thompson ((udev->ctrl_ep.edesc->bEndpointAddress & ea_mask) == ea_val) && 3205b3bb704SAndrew Thompson ((udev->ctrl_ep.edesc->bmAttributes & type_mask) == type_val) && 32102ac6454SAndrew Thompson (!index)) { 3225b3bb704SAndrew Thompson ep = &udev->ctrl_ep; 32302ac6454SAndrew Thompson goto found; 32402ac6454SAndrew Thompson } 32502ac6454SAndrew Thompson return (NULL); 32602ac6454SAndrew Thompson 32702ac6454SAndrew Thompson found: 328ae60fdfbSAndrew Thompson return (ep); 32902ac6454SAndrew Thompson } 33002ac6454SAndrew Thompson 33102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 332ed6d949aSAndrew Thompson * usbd_interface_count 33302ac6454SAndrew Thompson * 33402ac6454SAndrew Thompson * This function stores the number of USB interfaces excluding 33502ac6454SAndrew Thompson * alternate settings, which the USB config descriptor reports into 33602ac6454SAndrew Thompson * the unsigned 8-bit integer pointed to by "count". 33702ac6454SAndrew Thompson * 33802ac6454SAndrew Thompson * Returns: 33902ac6454SAndrew Thompson * 0: Success 34002ac6454SAndrew Thompson * Else: Failure 34102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 342e0a69b51SAndrew Thompson usb_error_t 343ed6d949aSAndrew Thompson usbd_interface_count(struct usb_device *udev, uint8_t *count) 34402ac6454SAndrew Thompson { 34502ac6454SAndrew Thompson if (udev->cdesc == NULL) { 34602ac6454SAndrew Thompson *count = 0; 34702ac6454SAndrew Thompson return (USB_ERR_NOT_CONFIGURED); 34802ac6454SAndrew Thompson } 349bdd41206SAndrew Thompson *count = udev->ifaces_max; 35002ac6454SAndrew Thompson return (USB_ERR_NORMAL_COMPLETION); 35102ac6454SAndrew Thompson } 35202ac6454SAndrew Thompson 35302ac6454SAndrew Thompson 35402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 355a593f6b8SAndrew Thompson * usb_init_endpoint 35602ac6454SAndrew Thompson * 357ae60fdfbSAndrew Thompson * This function will initialise the USB endpoint structure pointed to by 358ae60fdfbSAndrew Thompson * the "endpoint" argument. The structure pointed to by "endpoint" must be 359bdd41206SAndrew Thompson * zeroed before calling this function. 36002ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 36102ac6454SAndrew Thompson static void 362a593f6b8SAndrew Thompson usb_init_endpoint(struct usb_device *udev, uint8_t iface_index, 363ae60fdfbSAndrew Thompson struct usb_endpoint_descriptor *edesc, struct usb_endpoint *ep) 36402ac6454SAndrew Thompson { 365760bc48eSAndrew Thompson struct usb_bus_methods *methods; 366ee3e3ff5SAndrew Thompson 367bdd41206SAndrew Thompson methods = udev->bus->methods; 36802ac6454SAndrew Thompson 369ae60fdfbSAndrew Thompson (methods->endpoint_init) (udev, edesc, ep); 37002ac6454SAndrew Thompson 371ae60fdfbSAndrew Thompson /* initialise USB endpoint structure */ 372ae60fdfbSAndrew Thompson ep->edesc = edesc; 373ae60fdfbSAndrew Thompson ep->iface_index = iface_index; 374ae60fdfbSAndrew Thompson TAILQ_INIT(&ep->endpoint_q.head); 375a593f6b8SAndrew Thompson ep->endpoint_q.command = &usbd_pipe_start; 37602ac6454SAndrew Thompson 37739307315SAndrew Thompson /* the pipe is not supported by the hardware */ 378ae60fdfbSAndrew Thompson if (ep->methods == NULL) 37939307315SAndrew Thompson return; 38039307315SAndrew Thompson 38102ac6454SAndrew Thompson /* clear stall, if any */ 382bdd41206SAndrew Thompson if (methods->clear_stall != NULL) { 38302ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 384ae60fdfbSAndrew Thompson (methods->clear_stall) (udev, ep); 38502ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 38602ac6454SAndrew Thompson } 38702ac6454SAndrew Thompson } 38802ac6454SAndrew Thompson 389bdd41206SAndrew Thompson /*-----------------------------------------------------------------------* 390a593f6b8SAndrew Thompson * usb_endpoint_foreach 39116589beaSAndrew Thompson * 39216589beaSAndrew Thompson * This function will iterate all the USB endpoints except the control 39316589beaSAndrew Thompson * endpoint. This function is NULL safe. 39416589beaSAndrew Thompson * 39516589beaSAndrew Thompson * Return values: 396ae60fdfbSAndrew Thompson * NULL: End of USB endpoints 397ae60fdfbSAndrew Thompson * Else: Pointer to next USB endpoint 39816589beaSAndrew Thompson *------------------------------------------------------------------------*/ 399ae60fdfbSAndrew Thompson struct usb_endpoint * 400a593f6b8SAndrew Thompson usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep) 40116589beaSAndrew Thompson { 402a9e26757SAndrew Thompson struct usb_endpoint *ep_end; 40316589beaSAndrew Thompson 40416589beaSAndrew Thompson /* be NULL safe */ 40516589beaSAndrew Thompson if (udev == NULL) 40616589beaSAndrew Thompson return (NULL); 40716589beaSAndrew Thompson 408a9e26757SAndrew Thompson ep_end = udev->endpoints + udev->endpoints_max; 409a9e26757SAndrew Thompson 410ae60fdfbSAndrew Thompson /* get next endpoint */ 411ae60fdfbSAndrew Thompson if (ep == NULL) 412ae60fdfbSAndrew Thompson ep = udev->endpoints; 41316589beaSAndrew Thompson else 414ae60fdfbSAndrew Thompson ep++; 41516589beaSAndrew Thompson 416ae60fdfbSAndrew Thompson /* find next allocated ep */ 417ae60fdfbSAndrew Thompson while (ep != ep_end) { 418ae60fdfbSAndrew Thompson if (ep->edesc != NULL) 419ae60fdfbSAndrew Thompson return (ep); 420ae60fdfbSAndrew Thompson ep++; 42116589beaSAndrew Thompson } 42216589beaSAndrew Thompson return (NULL); 42316589beaSAndrew Thompson } 42416589beaSAndrew Thompson 42516589beaSAndrew Thompson /*------------------------------------------------------------------------* 426a593f6b8SAndrew Thompson * usb_unconfigure 42702ac6454SAndrew Thompson * 428ae60fdfbSAndrew Thompson * This function will free all USB interfaces and USB endpoints belonging 42902ac6454SAndrew Thompson * to an USB device. 430bdd41206SAndrew Thompson * 431bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 43202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 43302ac6454SAndrew Thompson static void 434a593f6b8SAndrew Thompson usb_unconfigure(struct usb_device *udev, uint8_t flag) 43502ac6454SAndrew Thompson { 436bdd41206SAndrew Thompson uint8_t do_unlock; 43702ac6454SAndrew Thompson 438bdd41206SAndrew Thompson /* automatic locking */ 439cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 440bdd41206SAndrew Thompson do_unlock = 0; 441bdd41206SAndrew Thompson } else { 442bdd41206SAndrew Thompson do_unlock = 1; 443cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 444bdd41206SAndrew Thompson } 445bdd41206SAndrew Thompson 446bdd41206SAndrew Thompson /* detach all interface drivers */ 447a593f6b8SAndrew Thompson usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag); 448bdd41206SAndrew Thompson 449bdd41206SAndrew Thompson #if USB_HAVE_UGEN 450bdd41206SAndrew Thompson /* free all FIFOs except control endpoint FIFOs */ 451a593f6b8SAndrew Thompson usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag); 452bdd41206SAndrew Thompson 453bdd41206SAndrew Thompson /* 454bdd41206SAndrew Thompson * Free all cdev's, if any. 455bdd41206SAndrew Thompson */ 456a593f6b8SAndrew Thompson usb_cdev_free(udev); 457bdd41206SAndrew Thompson #endif 45802ac6454SAndrew Thompson 459bdc081c6SAndrew Thompson #if USB_HAVE_COMPAT_LINUX 46002ac6454SAndrew Thompson /* free Linux compat device, if any */ 461760bc48eSAndrew Thompson if (udev->linux_endpoint_start) { 462760bc48eSAndrew Thompson usb_linux_free_device(udev); 463760bc48eSAndrew Thompson udev->linux_endpoint_start = NULL; 46402ac6454SAndrew Thompson } 465bdc081c6SAndrew Thompson #endif 46602ac6454SAndrew Thompson 467a593f6b8SAndrew Thompson usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE); 46802ac6454SAndrew Thompson 469ae60fdfbSAndrew Thompson /* free "cdesc" after "ifaces" and "endpoints", if any */ 4707efaaa9aSAndrew Thompson if (udev->cdesc != NULL) { 471f29a0724SAndrew Thompson if (udev->flags.usb_mode != USB_MODE_DEVICE) 47202ac6454SAndrew Thompson free(udev->cdesc, M_USB); 47302ac6454SAndrew Thompson udev->cdesc = NULL; 47402ac6454SAndrew Thompson } 47502ac6454SAndrew Thompson /* set unconfigured state */ 47602ac6454SAndrew Thompson udev->curr_config_no = USB_UNCONFIG_NO; 47702ac6454SAndrew Thompson udev->curr_config_index = USB_UNCONFIG_INDEX; 478bdd41206SAndrew Thompson 479cb18f7d1SAlfred Perlstein if (do_unlock) 480cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 48102ac6454SAndrew Thompson } 48202ac6454SAndrew Thompson 48302ac6454SAndrew Thompson /*------------------------------------------------------------------------* 484a593f6b8SAndrew Thompson * usbd_set_config_index 48502ac6454SAndrew Thompson * 48602ac6454SAndrew Thompson * This function selects configuration by index, independent of the 48702ac6454SAndrew Thompson * actual configuration number. This function should not be used by 48802ac6454SAndrew Thompson * USB drivers. 48902ac6454SAndrew Thompson * 49002ac6454SAndrew Thompson * Returns: 49102ac6454SAndrew Thompson * 0: Success 49202ac6454SAndrew Thompson * Else: Failure 49302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 494e0a69b51SAndrew Thompson usb_error_t 495a593f6b8SAndrew Thompson usbd_set_config_index(struct usb_device *udev, uint8_t index) 49602ac6454SAndrew Thompson { 497760bc48eSAndrew Thompson struct usb_status ds; 498760bc48eSAndrew Thompson struct usb_config_descriptor *cdp; 49902ac6454SAndrew Thompson uint16_t power; 50002ac6454SAndrew Thompson uint16_t max_power; 50102ac6454SAndrew Thompson uint8_t selfpowered; 50202ac6454SAndrew Thompson uint8_t do_unlock; 503e0a69b51SAndrew Thompson usb_error_t err; 50402ac6454SAndrew Thompson 50502ac6454SAndrew Thompson DPRINTFN(6, "udev=%p index=%d\n", udev, index); 50602ac6454SAndrew Thompson 50702ac6454SAndrew Thompson /* automatic locking */ 508cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 50902ac6454SAndrew Thompson do_unlock = 0; 51002ac6454SAndrew Thompson } else { 51102ac6454SAndrew Thompson do_unlock = 1; 512cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 51302ac6454SAndrew Thompson } 51402ac6454SAndrew Thompson 515d88688c7SAndrew Thompson usb_unconfigure(udev, 0); 51602ac6454SAndrew Thompson 51702ac6454SAndrew Thompson if (index == USB_UNCONFIG_INDEX) { 51802ac6454SAndrew Thompson /* 51902ac6454SAndrew Thompson * Leave unallocated when unconfiguring the 520a593f6b8SAndrew Thompson * device. "usb_unconfigure()" will also reset 52102ac6454SAndrew Thompson * the current config number and index. 52202ac6454SAndrew Thompson */ 523a593f6b8SAndrew Thompson err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO); 524bd216778SAndrew Thompson if (udev->state == USB_STATE_CONFIGURED) 525a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_ADDRESSED); 52602ac6454SAndrew Thompson goto done; 52702ac6454SAndrew Thompson } 52802ac6454SAndrew Thompson /* get the full config descriptor */ 529f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 5307efaaa9aSAndrew Thompson /* save some memory */ 531a593f6b8SAndrew Thompson err = usbd_req_get_descriptor_ptr(udev, &cdp, 532459d369eSAndrew Thompson (UDESC_CONFIG << 8) | index); 5337efaaa9aSAndrew Thompson } else { 5347efaaa9aSAndrew Thompson /* normal request */ 535a593f6b8SAndrew Thompson err = usbd_req_get_config_desc_full(udev, 536e2805033SAndrew Thompson NULL, &cdp, M_USB, index); 5377efaaa9aSAndrew Thompson } 53802ac6454SAndrew Thompson if (err) { 53902ac6454SAndrew Thompson goto done; 54002ac6454SAndrew Thompson } 54102ac6454SAndrew Thompson /* set the new config descriptor */ 54202ac6454SAndrew Thompson 54302ac6454SAndrew Thompson udev->cdesc = cdp; 54402ac6454SAndrew Thompson 54502ac6454SAndrew Thompson /* Figure out if the device is self or bus powered. */ 54602ac6454SAndrew Thompson selfpowered = 0; 54702ac6454SAndrew Thompson if ((!udev->flags.uq_bus_powered) && 54802ac6454SAndrew Thompson (cdp->bmAttributes & UC_SELF_POWERED) && 549f29a0724SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST)) { 55002ac6454SAndrew Thompson /* May be self powered. */ 55102ac6454SAndrew Thompson if (cdp->bmAttributes & UC_BUS_POWERED) { 55202ac6454SAndrew Thompson /* Must ask device. */ 553a593f6b8SAndrew Thompson err = usbd_req_get_device_status(udev, NULL, &ds); 55402ac6454SAndrew Thompson if (err) { 55502ac6454SAndrew Thompson DPRINTFN(0, "could not read " 55602ac6454SAndrew Thompson "device status: %s\n", 557a593f6b8SAndrew Thompson usbd_errstr(err)); 55802ac6454SAndrew Thompson } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) { 55902ac6454SAndrew Thompson selfpowered = 1; 56002ac6454SAndrew Thompson } 56102ac6454SAndrew Thompson DPRINTF("status=0x%04x \n", 56202ac6454SAndrew Thompson UGETW(ds.wStatus)); 56302ac6454SAndrew Thompson } else 56402ac6454SAndrew Thompson selfpowered = 1; 56502ac6454SAndrew Thompson } 56602ac6454SAndrew Thompson DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, " 56702ac6454SAndrew Thompson "selfpowered=%d, power=%d\n", 56802ac6454SAndrew Thompson udev, cdp, 56991f72cedSAndrew Thompson udev->address, cdp->bConfigurationValue, cdp->bmAttributes, 57002ac6454SAndrew Thompson selfpowered, cdp->bMaxPower * 2); 57102ac6454SAndrew Thompson 57202ac6454SAndrew Thompson /* Check if we have enough power. */ 57302ac6454SAndrew Thompson power = cdp->bMaxPower * 2; 57402ac6454SAndrew Thompson 57502ac6454SAndrew Thompson if (udev->parent_hub) { 57602ac6454SAndrew Thompson max_power = udev->parent_hub->hub->portpower; 57702ac6454SAndrew Thompson } else { 57802ac6454SAndrew Thompson max_power = USB_MAX_POWER; 57902ac6454SAndrew Thompson } 58002ac6454SAndrew Thompson 58102ac6454SAndrew Thompson if (power > max_power) { 58202ac6454SAndrew Thompson DPRINTFN(0, "power exceeded %d > %d\n", power, max_power); 58302ac6454SAndrew Thompson err = USB_ERR_NO_POWER; 58402ac6454SAndrew Thompson goto done; 58502ac6454SAndrew Thompson } 58602ac6454SAndrew Thompson /* Only update "self_powered" in USB Host Mode */ 587f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_HOST) { 58802ac6454SAndrew Thompson udev->flags.self_powered = selfpowered; 58902ac6454SAndrew Thompson } 59002ac6454SAndrew Thompson udev->power = power; 59102ac6454SAndrew Thompson udev->curr_config_no = cdp->bConfigurationValue; 59202ac6454SAndrew Thompson udev->curr_config_index = index; 593a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_CONFIGURED); 59402ac6454SAndrew Thompson 59502ac6454SAndrew Thompson /* Set the actual configuration value. */ 596a593f6b8SAndrew Thompson err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue); 59702ac6454SAndrew Thompson if (err) { 59802ac6454SAndrew Thompson goto done; 59902ac6454SAndrew Thompson } 600bdd41206SAndrew Thompson 601a593f6b8SAndrew Thompson err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC); 60202ac6454SAndrew Thompson if (err) { 60302ac6454SAndrew Thompson goto done; 60402ac6454SAndrew Thompson } 605bdd41206SAndrew Thompson 606a593f6b8SAndrew Thompson err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT); 607bdd41206SAndrew Thompson if (err) { 608bdd41206SAndrew Thompson goto done; 60902ac6454SAndrew Thompson } 610bdd41206SAndrew Thompson 6110f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 612ee3e3ff5SAndrew Thompson /* create device nodes for each endpoint */ 613a593f6b8SAndrew Thompson usb_cdev_create(udev); 6140f6e8f93SAndrew Thompson #endif 61502ac6454SAndrew Thompson 61602ac6454SAndrew Thompson done: 617a593f6b8SAndrew Thompson DPRINTF("error=%s\n", usbd_errstr(err)); 61802ac6454SAndrew Thompson if (err) { 619d88688c7SAndrew Thompson usb_unconfigure(udev, 0); 62002ac6454SAndrew Thompson } 621cb18f7d1SAlfred Perlstein if (do_unlock) 622cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 62302ac6454SAndrew Thompson return (err); 62402ac6454SAndrew Thompson } 62502ac6454SAndrew Thompson 62602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 627a593f6b8SAndrew Thompson * usb_config_parse 628bdd41206SAndrew Thompson * 629ae60fdfbSAndrew Thompson * This function will allocate and free USB interfaces and USB endpoints, 630ae60fdfbSAndrew Thompson * parse the USB configuration structure and initialise the USB endpoints 631bdd41206SAndrew Thompson * and interfaces. If "iface_index" is not equal to 632bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the 633bdd41206SAndrew Thompson * alternate_setting to be selected for the given interface. Else the 634bdd41206SAndrew Thompson * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be 635bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function 636bdd41206SAndrew Thompson * is typically called when setting the configuration or when setting 637bdd41206SAndrew Thompson * an alternate interface. 638bdd41206SAndrew Thompson * 639bdd41206SAndrew Thompson * Returns: 640bdd41206SAndrew Thompson * 0: Success 641bdd41206SAndrew Thompson * Else: Failure 642bdd41206SAndrew Thompson *------------------------------------------------------------------------*/ 643e0a69b51SAndrew Thompson usb_error_t 644a593f6b8SAndrew Thompson usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd) 645bdd41206SAndrew Thompson { 646760bc48eSAndrew Thompson struct usb_idesc_parse_state ips; 647760bc48eSAndrew Thompson struct usb_interface_descriptor *id; 648760bc48eSAndrew Thompson struct usb_endpoint_descriptor *ed; 649760bc48eSAndrew Thompson struct usb_interface *iface; 650ae60fdfbSAndrew Thompson struct usb_endpoint *ep; 651e0a69b51SAndrew Thompson usb_error_t err; 652bdd41206SAndrew Thompson uint8_t ep_curr; 653bdd41206SAndrew Thompson uint8_t ep_max; 654bdd41206SAndrew Thompson uint8_t temp; 655bdd41206SAndrew Thompson uint8_t do_init; 656bdd41206SAndrew Thompson uint8_t alt_index; 657bdd41206SAndrew Thompson 658bdd41206SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 659bdd41206SAndrew Thompson /* parameter overload */ 660bdd41206SAndrew Thompson alt_index = cmd; 661bdd41206SAndrew Thompson cmd = USB_CFG_INIT; 662bdd41206SAndrew Thompson } else { 663bdd41206SAndrew Thompson /* not used */ 664bdd41206SAndrew Thompson alt_index = 0; 665bdd41206SAndrew Thompson } 666bdd41206SAndrew Thompson 667bdd41206SAndrew Thompson err = 0; 668bdd41206SAndrew Thompson 669bdd41206SAndrew Thompson DPRINTFN(5, "iface_index=%d cmd=%d\n", 670bdd41206SAndrew Thompson iface_index, cmd); 671bdd41206SAndrew Thompson 672bdd41206SAndrew Thompson if (cmd == USB_CFG_FREE) 673bdd41206SAndrew Thompson goto cleanup; 674bdd41206SAndrew Thompson 675bdd41206SAndrew Thompson if (cmd == USB_CFG_INIT) { 67691cd9240SAndrew Thompson sx_assert(&udev->enum_sx, SA_LOCKED); 677bdd41206SAndrew Thompson 678ae60fdfbSAndrew Thompson /* check for in-use endpoints */ 679bdd41206SAndrew Thompson 680ae60fdfbSAndrew Thompson ep = udev->endpoints; 681ae60fdfbSAndrew Thompson ep_max = udev->endpoints_max; 682bdd41206SAndrew Thompson while (ep_max--) { 683ae60fdfbSAndrew Thompson /* look for matching endpoints */ 684bdd41206SAndrew Thompson if ((iface_index == USB_IFACE_INDEX_ANY) || 685ae60fdfbSAndrew Thompson (iface_index == ep->iface_index)) { 686f12c6c29SAndrew Thompson if (ep->refcount_alloc != 0) { 687bdd41206SAndrew Thompson /* 688bdd41206SAndrew Thompson * This typically indicates a 689bdd41206SAndrew Thompson * more serious error. 690bdd41206SAndrew Thompson */ 691bdd41206SAndrew Thompson err = USB_ERR_IN_USE; 692bdd41206SAndrew Thompson } else { 693ae60fdfbSAndrew Thompson /* reset endpoint */ 694ae60fdfbSAndrew Thompson memset(ep, 0, sizeof(*ep)); 695ae60fdfbSAndrew Thompson /* make sure we don't zero the endpoint again */ 696ae60fdfbSAndrew Thompson ep->iface_index = USB_IFACE_INDEX_ANY; 697bdd41206SAndrew Thompson } 698bdd41206SAndrew Thompson } 699ae60fdfbSAndrew Thompson ep++; 700bdd41206SAndrew Thompson } 701bdd41206SAndrew Thompson 702bdd41206SAndrew Thompson if (err) 703bdd41206SAndrew Thompson return (err); 704bdd41206SAndrew Thompson } 705bdd41206SAndrew Thompson 706bdd41206SAndrew Thompson memset(&ips, 0, sizeof(ips)); 707bdd41206SAndrew Thompson 708bdd41206SAndrew Thompson ep_curr = 0; 709bdd41206SAndrew Thompson ep_max = 0; 710bdd41206SAndrew Thompson 711a593f6b8SAndrew Thompson while ((id = usb_idesc_foreach(udev->cdesc, &ips))) { 712bdd41206SAndrew Thompson 713bdd41206SAndrew Thompson /* check for interface overflow */ 714bdd41206SAndrew Thompson if (ips.iface_index == USB_IFACE_MAX) 715bdd41206SAndrew Thompson break; /* crazy */ 716bdd41206SAndrew Thompson 717bdd41206SAndrew Thompson iface = udev->ifaces + ips.iface_index; 718bdd41206SAndrew Thompson 719bdd41206SAndrew Thompson /* check for specific interface match */ 720bdd41206SAndrew Thompson 721bdd41206SAndrew Thompson if (cmd == USB_CFG_INIT) { 722bdd41206SAndrew Thompson if ((iface_index != USB_IFACE_INDEX_ANY) && 723bdd41206SAndrew Thompson (iface_index != ips.iface_index)) { 724bdd41206SAndrew Thompson /* wrong interface */ 725bdd41206SAndrew Thompson do_init = 0; 726bdd41206SAndrew Thompson } else if (alt_index != ips.iface_index_alt) { 727bdd41206SAndrew Thompson /* wrong alternate setting */ 728bdd41206SAndrew Thompson do_init = 0; 729bdd41206SAndrew Thompson } else { 730bdd41206SAndrew Thompson /* initialise interface */ 731bdd41206SAndrew Thompson do_init = 1; 732bdd41206SAndrew Thompson } 733bdd41206SAndrew Thompson } else 734bdd41206SAndrew Thompson do_init = 0; 735bdd41206SAndrew Thompson 736bdd41206SAndrew Thompson /* check for new interface */ 737bdd41206SAndrew Thompson if (ips.iface_index_alt == 0) { 738bdd41206SAndrew Thompson /* update current number of endpoints */ 739bdd41206SAndrew Thompson ep_curr = ep_max; 740bdd41206SAndrew Thompson } 741bdd41206SAndrew Thompson /* check for init */ 742bdd41206SAndrew Thompson if (do_init) { 743bdd41206SAndrew Thompson /* setup the USB interface structure */ 744bdd41206SAndrew Thompson iface->idesc = id; 745bdd41206SAndrew Thompson /* default setting */ 746bdd41206SAndrew Thompson iface->parent_iface_index = USB_IFACE_INDEX_ANY; 747bdd41206SAndrew Thompson /* set alternate index */ 748bdd41206SAndrew Thompson iface->alt_index = alt_index; 749bdd41206SAndrew Thompson } 750bdd41206SAndrew Thompson 751bdd41206SAndrew Thompson DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints); 752bdd41206SAndrew Thompson 753760bc48eSAndrew Thompson ed = (struct usb_endpoint_descriptor *)id; 754bdd41206SAndrew Thompson 755bdd41206SAndrew Thompson temp = ep_curr; 756bdd41206SAndrew Thompson 757bdd41206SAndrew Thompson /* iterate all the endpoint descriptors */ 758a593f6b8SAndrew Thompson while ((ed = usb_edesc_foreach(udev->cdesc, ed))) { 759bdd41206SAndrew Thompson 760bdd41206SAndrew Thompson if (temp == USB_EP_MAX) 761bdd41206SAndrew Thompson break; /* crazy */ 762bdd41206SAndrew Thompson 763ae60fdfbSAndrew Thompson ep = udev->endpoints + temp; 764bdd41206SAndrew Thompson 765bdd41206SAndrew Thompson if (do_init) { 766a593f6b8SAndrew Thompson usb_init_endpoint(udev, 767ae60fdfbSAndrew Thompson ips.iface_index, ed, ep); 768bdd41206SAndrew Thompson } 769bdd41206SAndrew Thompson 770bdd41206SAndrew Thompson temp ++; 771bdd41206SAndrew Thompson 772bdd41206SAndrew Thompson /* find maximum number of endpoints */ 773bdd41206SAndrew Thompson if (ep_max < temp) 774bdd41206SAndrew Thompson ep_max = temp; 775bdd41206SAndrew Thompson 776bdd41206SAndrew Thompson /* optimalisation */ 777760bc48eSAndrew Thompson id = (struct usb_interface_descriptor *)ed; 778bdd41206SAndrew Thompson } 779bdd41206SAndrew Thompson } 780bdd41206SAndrew Thompson 781bdd41206SAndrew Thompson /* NOTE: It is valid to have no interfaces and no endpoints! */ 782bdd41206SAndrew Thompson 783bdd41206SAndrew Thompson if (cmd == USB_CFG_ALLOC) { 784bdd41206SAndrew Thompson udev->ifaces_max = ips.iface_index; 785bdd41206SAndrew Thompson udev->ifaces = NULL; 786bdd41206SAndrew Thompson if (udev->ifaces_max != 0) { 787bdd41206SAndrew Thompson udev->ifaces = malloc(sizeof(*iface) * udev->ifaces_max, 788bdd41206SAndrew Thompson M_USB, M_WAITOK | M_ZERO); 789bdd41206SAndrew Thompson if (udev->ifaces == NULL) { 790bdd41206SAndrew Thompson err = USB_ERR_NOMEM; 791bdd41206SAndrew Thompson goto done; 792bdd41206SAndrew Thompson } 793bdd41206SAndrew Thompson } 7949469c929SAndrew Thompson if (ep_max != 0) { 795ae60fdfbSAndrew Thompson udev->endpoints = malloc(sizeof(*ep) * ep_max, 796bdd41206SAndrew Thompson M_USB, M_WAITOK | M_ZERO); 797ae60fdfbSAndrew Thompson if (udev->endpoints == NULL) { 798bdd41206SAndrew Thompson err = USB_ERR_NOMEM; 799bdd41206SAndrew Thompson goto done; 800bdd41206SAndrew Thompson } 8019469c929SAndrew Thompson } else { 802ae60fdfbSAndrew Thompson udev->endpoints = NULL; 803bdd41206SAndrew Thompson } 8049469c929SAndrew Thompson USB_BUS_LOCK(udev->bus); 805ae60fdfbSAndrew Thompson udev->endpoints_max = ep_max; 8069469c929SAndrew Thompson /* reset any ongoing clear-stall */ 807ae60fdfbSAndrew Thompson udev->ep_curr = NULL; 8089469c929SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 809bdd41206SAndrew Thompson } 810bdd41206SAndrew Thompson 811bdd41206SAndrew Thompson done: 812bdd41206SAndrew Thompson if (err) { 813bdd41206SAndrew Thompson if (cmd == USB_CFG_ALLOC) { 814bdd41206SAndrew Thompson cleanup: 8159469c929SAndrew Thompson USB_BUS_LOCK(udev->bus); 816ae60fdfbSAndrew Thompson udev->endpoints_max = 0; 8179469c929SAndrew Thompson /* reset any ongoing clear-stall */ 818ae60fdfbSAndrew Thompson udev->ep_curr = NULL; 8199469c929SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 8209469c929SAndrew Thompson 821bdd41206SAndrew Thompson /* cleanup */ 822bdd41206SAndrew Thompson if (udev->ifaces != NULL) 823bdd41206SAndrew Thompson free(udev->ifaces, M_USB); 824ae60fdfbSAndrew Thompson if (udev->endpoints != NULL) 825ae60fdfbSAndrew Thompson free(udev->endpoints, M_USB); 826bdd41206SAndrew Thompson 827bdd41206SAndrew Thompson udev->ifaces = NULL; 828ae60fdfbSAndrew Thompson udev->endpoints = NULL; 829bdd41206SAndrew Thompson udev->ifaces_max = 0; 830bdd41206SAndrew Thompson } 831bdd41206SAndrew Thompson } 832bdd41206SAndrew Thompson return (err); 833bdd41206SAndrew Thompson } 834bdd41206SAndrew Thompson 835bdd41206SAndrew Thompson /*------------------------------------------------------------------------* 836a593f6b8SAndrew Thompson * usbd_set_alt_interface_index 83702ac6454SAndrew Thompson * 83802ac6454SAndrew Thompson * This function will select an alternate interface index for the 83902ac6454SAndrew Thompson * given interface index. The interface should not be in use when this 840e2805033SAndrew Thompson * function is called. That means there should not be any open USB 841e2805033SAndrew Thompson * transfers. Else an error is returned. If the alternate setting is 842e2805033SAndrew Thompson * already set this function will simply return success. This function 843e2805033SAndrew Thompson * is called in Host mode and Device mode! 84402ac6454SAndrew Thompson * 84502ac6454SAndrew Thompson * Returns: 84602ac6454SAndrew Thompson * 0: Success 84702ac6454SAndrew Thompson * Else: Failure 84802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 849e0a69b51SAndrew Thompson usb_error_t 850a593f6b8SAndrew Thompson usbd_set_alt_interface_index(struct usb_device *udev, 85102ac6454SAndrew Thompson uint8_t iface_index, uint8_t alt_index) 85202ac6454SAndrew Thompson { 853a593f6b8SAndrew Thompson struct usb_interface *iface = usbd_get_iface(udev, iface_index); 854e0a69b51SAndrew Thompson usb_error_t err; 85502ac6454SAndrew Thompson uint8_t do_unlock; 85602ac6454SAndrew Thompson 85702ac6454SAndrew Thompson /* automatic locking */ 858cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 85902ac6454SAndrew Thompson do_unlock = 0; 86002ac6454SAndrew Thompson } else { 86102ac6454SAndrew Thompson do_unlock = 1; 862cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 86302ac6454SAndrew Thompson } 86402ac6454SAndrew Thompson if (iface == NULL) { 86502ac6454SAndrew Thompson err = USB_ERR_INVAL; 86602ac6454SAndrew Thompson goto done; 86702ac6454SAndrew Thompson } 868e2805033SAndrew Thompson if (iface->alt_index == alt_index) { 869e2805033SAndrew Thompson /* 870e2805033SAndrew Thompson * Optimise away duplicate setting of 871e2805033SAndrew Thompson * alternate setting in USB Host Mode! 872e2805033SAndrew Thompson */ 873e2805033SAndrew Thompson err = 0; 874e2805033SAndrew Thompson goto done; 875e2805033SAndrew Thompson } 8760f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 87702ac6454SAndrew Thompson /* 87802ac6454SAndrew Thompson * Free all generic FIFOs for this interface, except control 87902ac6454SAndrew Thompson * endpoint FIFOs: 88002ac6454SAndrew Thompson */ 881a593f6b8SAndrew Thompson usb_fifo_free_wrap(udev, iface_index, 0); 8820f6e8f93SAndrew Thompson #endif 883bdd41206SAndrew Thompson 884a593f6b8SAndrew Thompson err = usb_config_parse(udev, iface_index, alt_index); 88502ac6454SAndrew Thompson if (err) { 88602ac6454SAndrew Thompson goto done; 88702ac6454SAndrew Thompson } 888bd73b187SAlfred Perlstein if (iface->alt_index != alt_index) { 889bd73b187SAlfred Perlstein /* the alternate setting does not exist */ 890bd73b187SAlfred Perlstein err = USB_ERR_INVAL; 891bd73b187SAlfred Perlstein goto done; 892bd73b187SAlfred Perlstein } 893bd73b187SAlfred Perlstein 894a593f6b8SAndrew Thompson err = usbd_req_set_alt_interface_no(udev, NULL, iface_index, 89502ac6454SAndrew Thompson iface->idesc->bAlternateSetting); 89602ac6454SAndrew Thompson 89702ac6454SAndrew Thompson done: 898cb18f7d1SAlfred Perlstein if (do_unlock) 899cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 900cb18f7d1SAlfred Perlstein 90102ac6454SAndrew Thompson return (err); 90202ac6454SAndrew Thompson } 90302ac6454SAndrew Thompson 90402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 905a593f6b8SAndrew Thompson * usbd_set_endpoint_stall 90602ac6454SAndrew Thompson * 90702ac6454SAndrew Thompson * This function is used to make a BULK or INTERRUPT endpoint 90802ac6454SAndrew Thompson * send STALL tokens. 90902ac6454SAndrew Thompson * 91002ac6454SAndrew Thompson * Returns: 91102ac6454SAndrew Thompson * 0: Success 91202ac6454SAndrew Thompson * Else: Failure 91302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 914e0a69b51SAndrew Thompson usb_error_t 915a593f6b8SAndrew Thompson usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep, 91602ac6454SAndrew Thompson uint8_t do_stall) 91702ac6454SAndrew Thompson { 918760bc48eSAndrew Thompson struct usb_xfer *xfer; 91902ac6454SAndrew Thompson uint8_t et; 92002ac6454SAndrew Thompson uint8_t was_stalled; 92102ac6454SAndrew Thompson 922ae60fdfbSAndrew Thompson if (ep == NULL) { 92302ac6454SAndrew Thompson /* nothing to do */ 92402ac6454SAndrew Thompson DPRINTF("Cannot find endpoint\n"); 92502ac6454SAndrew Thompson /* 92602ac6454SAndrew Thompson * Pretend that the clear or set stall request is 92702ac6454SAndrew Thompson * successful else some USB host stacks can do 92802ac6454SAndrew Thompson * strange things, especially when a control endpoint 92902ac6454SAndrew Thompson * stalls. 93002ac6454SAndrew Thompson */ 93102ac6454SAndrew Thompson return (0); 93202ac6454SAndrew Thompson } 933ae60fdfbSAndrew Thompson et = (ep->edesc->bmAttributes & UE_XFERTYPE); 93402ac6454SAndrew Thompson 93502ac6454SAndrew Thompson if ((et != UE_BULK) && 93602ac6454SAndrew Thompson (et != UE_INTERRUPT)) { 93702ac6454SAndrew Thompson /* 93802ac6454SAndrew Thompson * Should not stall control 93902ac6454SAndrew Thompson * nor isochronous endpoints. 94002ac6454SAndrew Thompson */ 94102ac6454SAndrew Thompson DPRINTF("Invalid endpoint\n"); 94202ac6454SAndrew Thompson return (0); 94302ac6454SAndrew Thompson } 94402ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 94502ac6454SAndrew Thompson 94602ac6454SAndrew Thompson /* store current stall state */ 947ae60fdfbSAndrew Thompson was_stalled = ep->is_stalled; 94802ac6454SAndrew Thompson 94902ac6454SAndrew Thompson /* check for no change */ 95002ac6454SAndrew Thompson if (was_stalled && do_stall) { 951ae60fdfbSAndrew Thompson /* if the endpoint is already stalled do nothing */ 95202ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 95302ac6454SAndrew Thompson DPRINTF("No change\n"); 95402ac6454SAndrew Thompson return (0); 95502ac6454SAndrew Thompson } 95602ac6454SAndrew Thompson /* set stalled state */ 957ae60fdfbSAndrew Thompson ep->is_stalled = 1; 95802ac6454SAndrew Thompson 95902ac6454SAndrew Thompson if (do_stall || (!was_stalled)) { 96002ac6454SAndrew Thompson if (!was_stalled) { 96102ac6454SAndrew Thompson /* lookup the current USB transfer, if any */ 962ae60fdfbSAndrew Thompson xfer = ep->endpoint_q.curr; 96302ac6454SAndrew Thompson } else { 96402ac6454SAndrew Thompson xfer = NULL; 96502ac6454SAndrew Thompson } 96602ac6454SAndrew Thompson 96702ac6454SAndrew Thompson /* 96802ac6454SAndrew Thompson * If "xfer" is non-NULL the "set_stall" method will 96902ac6454SAndrew Thompson * complete the USB transfer like in case of a timeout 97002ac6454SAndrew Thompson * setting the error code "USB_ERR_STALLED". 97102ac6454SAndrew Thompson */ 97229bd7d7eSAndrew Thompson (udev->bus->methods->set_stall) (udev, xfer, ep, &do_stall); 97302ac6454SAndrew Thompson } 97402ac6454SAndrew Thompson if (!do_stall) { 975ae60fdfbSAndrew Thompson ep->toggle_next = 0; /* reset data toggle */ 976ae60fdfbSAndrew Thompson ep->is_stalled = 0; /* clear stalled state */ 97702ac6454SAndrew Thompson 978ae60fdfbSAndrew Thompson (udev->bus->methods->clear_stall) (udev, ep); 97902ac6454SAndrew Thompson 98002ac6454SAndrew Thompson /* start up the current or next transfer, if any */ 981a593f6b8SAndrew Thompson usb_command_wrapper(&ep->endpoint_q, ep->endpoint_q.curr); 98202ac6454SAndrew Thompson } 98302ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 98402ac6454SAndrew Thompson return (0); 98502ac6454SAndrew Thompson } 98602ac6454SAndrew Thompson 98702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 988a593f6b8SAndrew Thompson * usb_reset_iface_endpoints - used in USB device side mode 98902ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 990e0a69b51SAndrew Thompson usb_error_t 991a593f6b8SAndrew Thompson usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index) 99202ac6454SAndrew Thompson { 993ae60fdfbSAndrew Thompson struct usb_endpoint *ep; 994ae60fdfbSAndrew Thompson struct usb_endpoint *ep_end; 99502ac6454SAndrew Thompson 996ae60fdfbSAndrew Thompson ep = udev->endpoints; 997ae60fdfbSAndrew Thompson ep_end = udev->endpoints + udev->endpoints_max; 99802ac6454SAndrew Thompson 999ae60fdfbSAndrew Thompson for (; ep != ep_end; ep++) { 100002ac6454SAndrew Thompson 1001ae60fdfbSAndrew Thompson if ((ep->edesc == NULL) || 1002ae60fdfbSAndrew Thompson (ep->iface_index != iface_index)) { 100302ac6454SAndrew Thompson continue; 100402ac6454SAndrew Thompson } 100502ac6454SAndrew Thompson /* simulate a clear stall from the peer */ 1006bd73b187SAlfred Perlstein usbd_set_endpoint_stall(udev, ep, 0); 100702ac6454SAndrew Thompson } 100802ac6454SAndrew Thompson return (0); 100902ac6454SAndrew Thompson } 101002ac6454SAndrew Thompson 101102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1012a593f6b8SAndrew Thompson * usb_detach_device_sub 101302ac6454SAndrew Thompson * 101402ac6454SAndrew Thompson * This function will try to detach an USB device. If it fails a panic 101502ac6454SAndrew Thompson * will result. 1016bdd41206SAndrew Thompson * 1017bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 101802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 101902ac6454SAndrew Thompson static void 1020a593f6b8SAndrew Thompson usb_detach_device_sub(struct usb_device *udev, device_t *ppdev, 1021bdd41206SAndrew Thompson uint8_t flag) 102202ac6454SAndrew Thompson { 102302ac6454SAndrew Thompson device_t dev; 102402ac6454SAndrew Thompson int err; 102502ac6454SAndrew Thompson 1026d88688c7SAndrew Thompson dev = *ppdev; 1027d88688c7SAndrew Thompson if (dev) { 102802ac6454SAndrew Thompson /* 102902ac6454SAndrew Thompson * NOTE: It is important to clear "*ppdev" before deleting 103002ac6454SAndrew Thompson * the child due to some device methods being called late 103102ac6454SAndrew Thompson * during the delete process ! 103202ac6454SAndrew Thompson */ 103302ac6454SAndrew Thompson *ppdev = NULL; 103402ac6454SAndrew Thompson 103502ac6454SAndrew Thompson device_printf(dev, "at %s, port %d, addr %d " 103602ac6454SAndrew Thompson "(disconnected)\n", 103702ac6454SAndrew Thompson device_get_nameunit(udev->parent_dev), 103802ac6454SAndrew Thompson udev->port_no, udev->address); 103902ac6454SAndrew Thompson 104002ac6454SAndrew Thompson if (device_is_attached(dev)) { 1041ec8f3127SAndrew Thompson if (udev->flags.peer_suspended) { 104202ac6454SAndrew Thompson err = DEVICE_RESUME(dev); 104302ac6454SAndrew Thompson if (err) { 1044767cb2e2SAndrew Thompson device_printf(dev, "Resume failed\n"); 104502ac6454SAndrew Thompson } 104602ac6454SAndrew Thompson } 104702ac6454SAndrew Thompson if (device_detach(dev)) { 104802ac6454SAndrew Thompson goto error; 104902ac6454SAndrew Thompson } 105002ac6454SAndrew Thompson } 105102ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, dev)) { 105202ac6454SAndrew Thompson goto error; 105302ac6454SAndrew Thompson } 105402ac6454SAndrew Thompson } 105502ac6454SAndrew Thompson return; 105602ac6454SAndrew Thompson 105702ac6454SAndrew Thompson error: 105802ac6454SAndrew Thompson /* Detach is not allowed to fail in the USB world */ 1059767cb2e2SAndrew Thompson panic("A USB driver would not detach\n"); 106002ac6454SAndrew Thompson } 106102ac6454SAndrew Thompson 106202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1063a593f6b8SAndrew Thompson * usb_detach_device 106402ac6454SAndrew Thompson * 106502ac6454SAndrew Thompson * The following function will detach the matching interfaces. 106602ac6454SAndrew Thompson * This function is NULL safe. 1067bdd41206SAndrew Thompson * 1068bdd41206SAndrew Thompson * Flag values, see "USB_UNCFG_FLAG_XXX". 106902ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 107002ac6454SAndrew Thompson void 1071a593f6b8SAndrew Thompson usb_detach_device(struct usb_device *udev, uint8_t iface_index, 1072bdd41206SAndrew Thompson uint8_t flag) 107302ac6454SAndrew Thompson { 1074760bc48eSAndrew Thompson struct usb_interface *iface; 107502ac6454SAndrew Thompson uint8_t i; 107602ac6454SAndrew Thompson 107702ac6454SAndrew Thompson if (udev == NULL) { 107802ac6454SAndrew Thompson /* nothing to do */ 107902ac6454SAndrew Thompson return; 108002ac6454SAndrew Thompson } 108102ac6454SAndrew Thompson DPRINTFN(4, "udev=%p\n", udev); 108202ac6454SAndrew Thompson 108391cd9240SAndrew Thompson sx_assert(&udev->enum_sx, SA_LOCKED); 108402ac6454SAndrew Thompson 108502ac6454SAndrew Thompson /* 108602ac6454SAndrew Thompson * First detach the child to give the child's detach routine a 108702ac6454SAndrew Thompson * chance to detach the sub-devices in the correct order. 108802ac6454SAndrew Thompson * Then delete the child using "device_delete_child()" which 108902ac6454SAndrew Thompson * will detach all sub-devices from the bottom and upwards! 109002ac6454SAndrew Thompson */ 109102ac6454SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 109202ac6454SAndrew Thompson i = iface_index; 109302ac6454SAndrew Thompson iface_index = i + 1; 109402ac6454SAndrew Thompson } else { 109502ac6454SAndrew Thompson i = 0; 109602ac6454SAndrew Thompson iface_index = USB_IFACE_MAX; 109702ac6454SAndrew Thompson } 109802ac6454SAndrew Thompson 109902ac6454SAndrew Thompson /* do the detach */ 110002ac6454SAndrew Thompson 110102ac6454SAndrew Thompson for (; i != iface_index; i++) { 110202ac6454SAndrew Thompson 1103a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 110402ac6454SAndrew Thompson if (iface == NULL) { 110502ac6454SAndrew Thompson /* looks like the end of the USB interfaces */ 110602ac6454SAndrew Thompson break; 110702ac6454SAndrew Thompson } 1108a593f6b8SAndrew Thompson usb_detach_device_sub(udev, &iface->subdev, flag); 110902ac6454SAndrew Thompson } 111002ac6454SAndrew Thompson } 111102ac6454SAndrew Thompson 111202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1113a593f6b8SAndrew Thompson * usb_probe_and_attach_sub 111402ac6454SAndrew Thompson * 111502ac6454SAndrew Thompson * Returns: 111602ac6454SAndrew Thompson * 0: Success 111702ac6454SAndrew Thompson * Else: Failure 111802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 111902ac6454SAndrew Thompson static uint8_t 1120a593f6b8SAndrew Thompson usb_probe_and_attach_sub(struct usb_device *udev, 1121760bc48eSAndrew Thompson struct usb_attach_arg *uaa) 112202ac6454SAndrew Thompson { 1123760bc48eSAndrew Thompson struct usb_interface *iface; 112402ac6454SAndrew Thompson device_t dev; 112502ac6454SAndrew Thompson int err; 112602ac6454SAndrew Thompson 112702ac6454SAndrew Thompson iface = uaa->iface; 112802ac6454SAndrew Thompson if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) { 112902ac6454SAndrew Thompson /* leave interface alone */ 113002ac6454SAndrew Thompson return (0); 113102ac6454SAndrew Thompson } 113202ac6454SAndrew Thompson dev = iface->subdev; 113302ac6454SAndrew Thompson if (dev) { 113402ac6454SAndrew Thompson 113502ac6454SAndrew Thompson /* clean up after module unload */ 113602ac6454SAndrew Thompson 113702ac6454SAndrew Thompson if (device_is_attached(dev)) { 113802ac6454SAndrew Thompson /* already a device there */ 113902ac6454SAndrew Thompson return (0); 114002ac6454SAndrew Thompson } 114102ac6454SAndrew Thompson /* clear "iface->subdev" as early as possible */ 114202ac6454SAndrew Thompson 114302ac6454SAndrew Thompson iface->subdev = NULL; 114402ac6454SAndrew Thompson 114502ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, dev)) { 114602ac6454SAndrew Thompson 114702ac6454SAndrew Thompson /* 114802ac6454SAndrew Thompson * Panic here, else one can get a double call 114902ac6454SAndrew Thompson * to device_detach(). USB devices should 115002ac6454SAndrew Thompson * never fail on detach! 115102ac6454SAndrew Thompson */ 1152767cb2e2SAndrew Thompson panic("device_delete_child() failed\n"); 115302ac6454SAndrew Thompson } 115402ac6454SAndrew Thompson } 115502ac6454SAndrew Thompson if (uaa->temp_dev == NULL) { 115602ac6454SAndrew Thompson 115702ac6454SAndrew Thompson /* create a new child */ 115802ac6454SAndrew Thompson uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1); 115902ac6454SAndrew Thompson if (uaa->temp_dev == NULL) { 116002ac6454SAndrew Thompson device_printf(udev->parent_dev, 1161767cb2e2SAndrew Thompson "Device creation failed\n"); 116202ac6454SAndrew Thompson return (1); /* failure */ 116302ac6454SAndrew Thompson } 116402ac6454SAndrew Thompson device_set_ivars(uaa->temp_dev, uaa); 116502ac6454SAndrew Thompson device_quiet(uaa->temp_dev); 116602ac6454SAndrew Thompson } 116702ac6454SAndrew Thompson /* 116802ac6454SAndrew Thompson * Set "subdev" before probe and attach so that "devd" gets 116902ac6454SAndrew Thompson * the information it needs. 117002ac6454SAndrew Thompson */ 117102ac6454SAndrew Thompson iface->subdev = uaa->temp_dev; 117202ac6454SAndrew Thompson 117302ac6454SAndrew Thompson if (device_probe_and_attach(iface->subdev) == 0) { 117402ac6454SAndrew Thompson /* 117502ac6454SAndrew Thompson * The USB attach arguments are only available during probe 117602ac6454SAndrew Thompson * and attach ! 117702ac6454SAndrew Thompson */ 117802ac6454SAndrew Thompson uaa->temp_dev = NULL; 117902ac6454SAndrew Thompson device_set_ivars(iface->subdev, NULL); 118002ac6454SAndrew Thompson 1181ec8f3127SAndrew Thompson if (udev->flags.peer_suspended) { 118202ac6454SAndrew Thompson err = DEVICE_SUSPEND(iface->subdev); 118388b4e0abSAndrew Thompson if (err) 118402ac6454SAndrew Thompson device_printf(iface->subdev, "Suspend failed\n"); 118502ac6454SAndrew Thompson } 118602ac6454SAndrew Thompson return (0); /* success */ 118702ac6454SAndrew Thompson } else { 118802ac6454SAndrew Thompson /* No USB driver found */ 118902ac6454SAndrew Thompson iface->subdev = NULL; 119002ac6454SAndrew Thompson } 119102ac6454SAndrew Thompson return (1); /* failure */ 119202ac6454SAndrew Thompson } 119302ac6454SAndrew Thompson 119402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1195a593f6b8SAndrew Thompson * usbd_set_parent_iface 119602ac6454SAndrew Thompson * 119702ac6454SAndrew Thompson * Using this function will lock the alternate interface setting on an 119802ac6454SAndrew Thompson * interface. It is typically used for multi interface drivers. In USB 119902ac6454SAndrew Thompson * device side mode it is assumed that the alternate interfaces all 120002ac6454SAndrew Thompson * have the same endpoint descriptors. The default parent index value 120102ac6454SAndrew Thompson * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not 120202ac6454SAndrew Thompson * locked. 120302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 120402ac6454SAndrew Thompson void 1205a593f6b8SAndrew Thompson usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index, 120602ac6454SAndrew Thompson uint8_t parent_index) 120702ac6454SAndrew Thompson { 1208760bc48eSAndrew Thompson struct usb_interface *iface; 120902ac6454SAndrew Thompson 1210a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, iface_index); 121102ac6454SAndrew Thompson if (iface) { 121202ac6454SAndrew Thompson iface->parent_iface_index = parent_index; 121302ac6454SAndrew Thompson } 121402ac6454SAndrew Thompson } 121502ac6454SAndrew Thompson 121602ac6454SAndrew Thompson static void 1217a593f6b8SAndrew Thompson usb_init_attach_arg(struct usb_device *udev, 1218760bc48eSAndrew Thompson struct usb_attach_arg *uaa) 121902ac6454SAndrew Thompson { 122002ac6454SAndrew Thompson bzero(uaa, sizeof(*uaa)); 122102ac6454SAndrew Thompson 122202ac6454SAndrew Thompson uaa->device = udev; 1223f29a0724SAndrew Thompson uaa->usb_mode = udev->flags.usb_mode; 122402ac6454SAndrew Thompson uaa->port = udev->port_no; 12252a4c6157SAndrew Thompson uaa->dev_state = UAA_DEV_READY; 122602ac6454SAndrew Thompson 122702ac6454SAndrew Thompson uaa->info.idVendor = UGETW(udev->ddesc.idVendor); 122802ac6454SAndrew Thompson uaa->info.idProduct = UGETW(udev->ddesc.idProduct); 122902ac6454SAndrew Thompson uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice); 123002ac6454SAndrew Thompson uaa->info.bDeviceClass = udev->ddesc.bDeviceClass; 123102ac6454SAndrew Thompson uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass; 123202ac6454SAndrew Thompson uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol; 123302ac6454SAndrew Thompson uaa->info.bConfigIndex = udev->curr_config_index; 123402ac6454SAndrew Thompson uaa->info.bConfigNum = udev->curr_config_no; 123502ac6454SAndrew Thompson } 123602ac6454SAndrew Thompson 123702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1238a593f6b8SAndrew Thompson * usb_probe_and_attach 123902ac6454SAndrew Thompson * 124002ac6454SAndrew Thompson * This function is called from "uhub_explore_sub()", 1241a593f6b8SAndrew Thompson * "usb_handle_set_config()" and "usb_handle_request()". 124202ac6454SAndrew Thompson * 124302ac6454SAndrew Thompson * Returns: 124402ac6454SAndrew Thompson * 0: Success 124502ac6454SAndrew Thompson * Else: A control transfer failed 124602ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1247e0a69b51SAndrew Thompson usb_error_t 1248a593f6b8SAndrew Thompson usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index) 124902ac6454SAndrew Thompson { 1250760bc48eSAndrew Thompson struct usb_attach_arg uaa; 1251760bc48eSAndrew Thompson struct usb_interface *iface; 125202ac6454SAndrew Thompson uint8_t i; 125302ac6454SAndrew Thompson uint8_t j; 125402ac6454SAndrew Thompson uint8_t do_unlock; 125502ac6454SAndrew Thompson 125602ac6454SAndrew Thompson if (udev == NULL) { 125702ac6454SAndrew Thompson DPRINTF("udev == NULL\n"); 125802ac6454SAndrew Thompson return (USB_ERR_INVAL); 125902ac6454SAndrew Thompson } 126002ac6454SAndrew Thompson /* automatic locking */ 1261cb18f7d1SAlfred Perlstein if (usbd_enum_is_locked(udev)) { 126202ac6454SAndrew Thompson do_unlock = 0; 126302ac6454SAndrew Thompson } else { 126402ac6454SAndrew Thompson do_unlock = 1; 1265cb18f7d1SAlfred Perlstein usbd_enum_lock(udev); 126602ac6454SAndrew Thompson } 126702ac6454SAndrew Thompson 126802ac6454SAndrew Thompson if (udev->curr_config_index == USB_UNCONFIG_INDEX) { 126902ac6454SAndrew Thompson /* do nothing - no configuration has been set */ 127002ac6454SAndrew Thompson goto done; 127102ac6454SAndrew Thompson } 127202ac6454SAndrew Thompson /* setup USB attach arguments */ 127302ac6454SAndrew Thompson 1274a593f6b8SAndrew Thompson usb_init_attach_arg(udev, &uaa); 127502ac6454SAndrew Thompson 127602ac6454SAndrew Thompson /* Check if only one interface should be probed: */ 127702ac6454SAndrew Thompson if (iface_index != USB_IFACE_INDEX_ANY) { 127802ac6454SAndrew Thompson i = iface_index; 127902ac6454SAndrew Thompson j = i + 1; 128002ac6454SAndrew Thompson } else { 128102ac6454SAndrew Thompson i = 0; 128202ac6454SAndrew Thompson j = USB_IFACE_MAX; 128302ac6454SAndrew Thompson } 128402ac6454SAndrew Thompson 128502ac6454SAndrew Thompson /* Do the probe and attach */ 128602ac6454SAndrew Thompson for (; i != j; i++) { 128702ac6454SAndrew Thompson 1288a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 128902ac6454SAndrew Thompson if (iface == NULL) { 129002ac6454SAndrew Thompson /* 129102ac6454SAndrew Thompson * Looks like the end of the USB 129202ac6454SAndrew Thompson * interfaces ! 129302ac6454SAndrew Thompson */ 129402ac6454SAndrew Thompson DPRINTFN(2, "end of interfaces " 129502ac6454SAndrew Thompson "at %u\n", i); 129602ac6454SAndrew Thompson break; 129702ac6454SAndrew Thompson } 129802ac6454SAndrew Thompson if (iface->idesc == NULL) { 129902ac6454SAndrew Thompson /* no interface descriptor */ 130002ac6454SAndrew Thompson continue; 130102ac6454SAndrew Thompson } 130202ac6454SAndrew Thompson uaa.iface = iface; 130302ac6454SAndrew Thompson 130402ac6454SAndrew Thompson uaa.info.bInterfaceClass = 130502ac6454SAndrew Thompson iface->idesc->bInterfaceClass; 130602ac6454SAndrew Thompson uaa.info.bInterfaceSubClass = 130702ac6454SAndrew Thompson iface->idesc->bInterfaceSubClass; 130802ac6454SAndrew Thompson uaa.info.bInterfaceProtocol = 130902ac6454SAndrew Thompson iface->idesc->bInterfaceProtocol; 131002ac6454SAndrew Thompson uaa.info.bIfaceIndex = i; 131102ac6454SAndrew Thompson uaa.info.bIfaceNum = 131202ac6454SAndrew Thompson iface->idesc->bInterfaceNumber; 131302ac6454SAndrew Thompson uaa.use_generic = 0; 1314bd73b187SAlfred Perlstein uaa.driver_info = 0; /* reset driver_info */ 131502ac6454SAndrew Thompson 131602ac6454SAndrew Thompson DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n", 131702ac6454SAndrew Thompson uaa.info.bInterfaceClass, 131802ac6454SAndrew Thompson uaa.info.bInterfaceSubClass, 131902ac6454SAndrew Thompson uaa.info.bInterfaceProtocol, 132002ac6454SAndrew Thompson uaa.info.bIfaceIndex, 132102ac6454SAndrew Thompson uaa.info.bIfaceNum); 132202ac6454SAndrew Thompson 132302ac6454SAndrew Thompson /* try specific interface drivers first */ 132402ac6454SAndrew Thompson 1325a593f6b8SAndrew Thompson if (usb_probe_and_attach_sub(udev, &uaa)) { 132602ac6454SAndrew Thompson /* ignore */ 132702ac6454SAndrew Thompson } 132802ac6454SAndrew Thompson /* try generic interface drivers last */ 132902ac6454SAndrew Thompson 133002ac6454SAndrew Thompson uaa.use_generic = 1; 1331bd73b187SAlfred Perlstein uaa.driver_info = 0; /* reset driver_info */ 133202ac6454SAndrew Thompson 1333a593f6b8SAndrew Thompson if (usb_probe_and_attach_sub(udev, &uaa)) { 133402ac6454SAndrew Thompson /* ignore */ 133502ac6454SAndrew Thompson } 133602ac6454SAndrew Thompson } 133702ac6454SAndrew Thompson 133802ac6454SAndrew Thompson if (uaa.temp_dev) { 133902ac6454SAndrew Thompson /* remove the last created child; it is unused */ 134002ac6454SAndrew Thompson 134102ac6454SAndrew Thompson if (device_delete_child(udev->parent_dev, uaa.temp_dev)) { 1342767cb2e2SAndrew Thompson DPRINTFN(0, "device delete child failed\n"); 134302ac6454SAndrew Thompson } 134402ac6454SAndrew Thompson } 134502ac6454SAndrew Thompson done: 1346cb18f7d1SAlfred Perlstein if (do_unlock) 1347cb18f7d1SAlfred Perlstein usbd_enum_unlock(udev); 1348cb18f7d1SAlfred Perlstein 134902ac6454SAndrew Thompson return (0); 135002ac6454SAndrew Thompson } 135102ac6454SAndrew Thompson 135202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1353a593f6b8SAndrew Thompson * usb_suspend_resume_sub 135402ac6454SAndrew Thompson * 135502ac6454SAndrew Thompson * This function is called when the suspend or resume methods should 135602ac6454SAndrew Thompson * be executed on an USB device. 135702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 135802ac6454SAndrew Thompson static void 1359a593f6b8SAndrew Thompson usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend) 136002ac6454SAndrew Thompson { 136102ac6454SAndrew Thompson int err; 136202ac6454SAndrew Thompson 136302ac6454SAndrew Thompson if (dev == NULL) { 136402ac6454SAndrew Thompson return; 136502ac6454SAndrew Thompson } 136602ac6454SAndrew Thompson if (!device_is_attached(dev)) { 136702ac6454SAndrew Thompson return; 136802ac6454SAndrew Thompson } 136902ac6454SAndrew Thompson if (do_suspend) { 137002ac6454SAndrew Thompson err = DEVICE_SUSPEND(dev); 137102ac6454SAndrew Thompson } else { 137202ac6454SAndrew Thompson err = DEVICE_RESUME(dev); 137302ac6454SAndrew Thompson } 137402ac6454SAndrew Thompson if (err) { 1375767cb2e2SAndrew Thompson device_printf(dev, "%s failed\n", 137602ac6454SAndrew Thompson do_suspend ? "Suspend" : "Resume"); 137702ac6454SAndrew Thompson } 137802ac6454SAndrew Thompson } 137902ac6454SAndrew Thompson 138002ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1381a593f6b8SAndrew Thompson * usb_suspend_resume 138202ac6454SAndrew Thompson * 138302ac6454SAndrew Thompson * The following function will suspend or resume the USB device. 138402ac6454SAndrew Thompson * 138502ac6454SAndrew Thompson * Returns: 138602ac6454SAndrew Thompson * 0: Success 138702ac6454SAndrew Thompson * Else: Failure 138802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1389e0a69b51SAndrew Thompson usb_error_t 1390a593f6b8SAndrew Thompson usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend) 139102ac6454SAndrew Thompson { 1392760bc48eSAndrew Thompson struct usb_interface *iface; 139302ac6454SAndrew Thompson uint8_t i; 139402ac6454SAndrew Thompson 139502ac6454SAndrew Thompson if (udev == NULL) { 139602ac6454SAndrew Thompson /* nothing to do */ 139702ac6454SAndrew Thompson return (0); 139802ac6454SAndrew Thompson } 139902ac6454SAndrew Thompson DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend); 140002ac6454SAndrew Thompson 14012df1e9a6SAndrew Thompson sx_assert(&udev->sr_sx, SA_LOCKED); 140202ac6454SAndrew Thompson 140302ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 140402ac6454SAndrew Thompson /* filter the suspend events */ 1405ec8f3127SAndrew Thompson if (udev->flags.peer_suspended == do_suspend) { 140602ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 140702ac6454SAndrew Thompson /* nothing to do */ 140802ac6454SAndrew Thompson return (0); 140902ac6454SAndrew Thompson } 1410ec8f3127SAndrew Thompson udev->flags.peer_suspended = do_suspend; 141102ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 141202ac6454SAndrew Thompson 141302ac6454SAndrew Thompson /* do the suspend or resume */ 141402ac6454SAndrew Thompson 141502ac6454SAndrew Thompson for (i = 0; i != USB_IFACE_MAX; i++) { 141602ac6454SAndrew Thompson 1417a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, i); 141802ac6454SAndrew Thompson if (iface == NULL) { 141902ac6454SAndrew Thompson /* looks like the end of the USB interfaces */ 142002ac6454SAndrew Thompson break; 142102ac6454SAndrew Thompson } 1422a593f6b8SAndrew Thompson usb_suspend_resume_sub(udev, iface->subdev, do_suspend); 142302ac6454SAndrew Thompson } 142402ac6454SAndrew Thompson return (0); 142502ac6454SAndrew Thompson } 142602ac6454SAndrew Thompson 142702ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1428a593f6b8SAndrew Thompson * usbd_clear_stall_proc 142902ac6454SAndrew Thompson * 143002ac6454SAndrew Thompson * This function performs generic USB clear stall operations. 143102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 143202ac6454SAndrew Thompson static void 1433a593f6b8SAndrew Thompson usbd_clear_stall_proc(struct usb_proc_msg *_pm) 143402ac6454SAndrew Thompson { 1435760bc48eSAndrew Thompson struct usb_clear_stall_msg *pm = (void *)_pm; 1436760bc48eSAndrew Thompson struct usb_device *udev = pm->udev; 143702ac6454SAndrew Thompson 143802ac6454SAndrew Thompson /* Change lock */ 143902ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 144091cd9240SAndrew Thompson mtx_lock(&udev->device_mtx); 144102ac6454SAndrew Thompson 144202ac6454SAndrew Thompson /* Start clear stall callback */ 14435b3bb704SAndrew Thompson usbd_transfer_start(udev->ctrl_xfer[1]); 144402ac6454SAndrew Thompson 144502ac6454SAndrew Thompson /* Change lock */ 144691cd9240SAndrew Thompson mtx_unlock(&udev->device_mtx); 144702ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 144802ac6454SAndrew Thompson } 144902ac6454SAndrew Thompson 145002ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1451a593f6b8SAndrew Thompson * usb_alloc_device 145202ac6454SAndrew Thompson * 145302ac6454SAndrew Thompson * This function allocates a new USB device. This function is called 145402ac6454SAndrew Thompson * when a new device has been put in the powered state, but not yet in 145502ac6454SAndrew Thompson * the addressed state. Get initial descriptor, set the address, get 145602ac6454SAndrew Thompson * full descriptor and get strings. 145702ac6454SAndrew Thompson * 145802ac6454SAndrew Thompson * Return values: 145902ac6454SAndrew Thompson * 0: Failure 146002ac6454SAndrew Thompson * Else: Success 146102ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 1462760bc48eSAndrew Thompson struct usb_device * 1463a593f6b8SAndrew Thompson usb_alloc_device(device_t parent_dev, struct usb_bus *bus, 1464760bc48eSAndrew Thompson struct usb_device *parent_hub, uint8_t depth, uint8_t port_index, 14658d2dd5ddSAndrew Thompson uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode) 146602ac6454SAndrew Thompson { 1467760bc48eSAndrew Thompson struct usb_attach_arg uaa; 1468760bc48eSAndrew Thompson struct usb_device *udev; 1469760bc48eSAndrew Thompson struct usb_device *adev; 1470760bc48eSAndrew Thompson struct usb_device *hub; 147102ac6454SAndrew Thompson uint8_t *scratch_ptr; 14727a918edfSAndrew Thompson size_t scratch_size; 1473e0a69b51SAndrew Thompson usb_error_t err; 147402ac6454SAndrew Thompson uint8_t device_index; 14752a4c6157SAndrew Thompson uint8_t config_index; 14762a4c6157SAndrew Thompson uint8_t config_quirk; 14772a4c6157SAndrew Thompson uint8_t set_config_failed; 147802ac6454SAndrew Thompson 147902ac6454SAndrew Thompson DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, " 1480f29a0724SAndrew Thompson "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n", 148102ac6454SAndrew Thompson parent_dev, bus, parent_hub, depth, port_index, port_no, 1482f29a0724SAndrew Thompson speed, mode); 148302ac6454SAndrew Thompson 148402ac6454SAndrew Thompson /* 148502ac6454SAndrew Thompson * Find an unused device index. In USB Host mode this is the 148602ac6454SAndrew Thompson * same as the device address. 148702ac6454SAndrew Thompson * 148802ac6454SAndrew Thompson * Device index zero is not used and device index 1 should 148902ac6454SAndrew Thompson * always be the root hub. 149002ac6454SAndrew Thompson */ 149102ac6454SAndrew Thompson for (device_index = USB_ROOT_HUB_ADDR; 149202ac6454SAndrew Thompson (device_index != bus->devices_max) && 149302ac6454SAndrew Thompson (bus->devices[device_index] != NULL); 149402ac6454SAndrew Thompson device_index++) /* nop */; 149502ac6454SAndrew Thompson 149602ac6454SAndrew Thompson if (device_index == bus->devices_max) { 149702ac6454SAndrew Thompson device_printf(bus->bdev, 1498767cb2e2SAndrew Thompson "No free USB device index for new device\n"); 149902ac6454SAndrew Thompson return (NULL); 150002ac6454SAndrew Thompson } 150102ac6454SAndrew Thompson 150202ac6454SAndrew Thompson if (depth > 0x10) { 150302ac6454SAndrew Thompson device_printf(bus->bdev, 1504767cb2e2SAndrew Thompson "Invalid device depth\n"); 150502ac6454SAndrew Thompson return (NULL); 150602ac6454SAndrew Thompson } 150702ac6454SAndrew Thompson udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO); 150802ac6454SAndrew Thompson if (udev == NULL) { 150902ac6454SAndrew Thompson return (NULL); 151002ac6454SAndrew Thompson } 151102ac6454SAndrew Thompson /* initialise our SX-lock */ 151291cd9240SAndrew Thompson sx_init_flags(&udev->ctrl_sx, "USB device SX lock", SX_DUPOK); 151302ac6454SAndrew Thompson 151402ac6454SAndrew Thompson /* initialise our SX-lock */ 151591cd9240SAndrew Thompson sx_init_flags(&udev->enum_sx, "USB config SX lock", SX_DUPOK); 15162df1e9a6SAndrew Thompson sx_init_flags(&udev->sr_sx, "USB suspend and resume SX lock", SX_DUPOK); 151702ac6454SAndrew Thompson 151891cd9240SAndrew Thompson cv_init(&udev->ctrlreq_cv, "WCTRL"); 151991cd9240SAndrew Thompson cv_init(&udev->ref_cv, "UGONE"); 152002ac6454SAndrew Thompson 152102ac6454SAndrew Thompson /* initialise our mutex */ 152291cd9240SAndrew Thompson mtx_init(&udev->device_mtx, "USB device mutex", NULL, MTX_DEF); 152302ac6454SAndrew Thompson 152402ac6454SAndrew Thompson /* initialise generic clear stall */ 1525a593f6b8SAndrew Thompson udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc; 152602ac6454SAndrew Thompson udev->cs_msg[0].udev = udev; 1527a593f6b8SAndrew Thompson udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc; 152802ac6454SAndrew Thompson udev->cs_msg[1].udev = udev; 152902ac6454SAndrew Thompson 153002ac6454SAndrew Thompson /* initialise some USB device fields */ 153102ac6454SAndrew Thompson udev->parent_hub = parent_hub; 153202ac6454SAndrew Thompson udev->parent_dev = parent_dev; 153302ac6454SAndrew Thompson udev->port_index = port_index; 153402ac6454SAndrew Thompson udev->port_no = port_no; 153502ac6454SAndrew Thompson udev->depth = depth; 153602ac6454SAndrew Thompson udev->bus = bus; 153702ac6454SAndrew Thompson udev->address = USB_START_ADDR; /* default value */ 1538e0a69b51SAndrew Thompson udev->plugtime = (usb_ticks_t)ticks; 1539a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_POWERED); 154002ac6454SAndrew Thompson /* 154102ac6454SAndrew Thompson * We need to force the power mode to "on" because there are plenty 154202ac6454SAndrew Thompson * of USB devices out there that do not work very well with 154302ac6454SAndrew Thompson * automatic suspend and resume! 154402ac6454SAndrew Thompson */ 1545d2d71ce7SAndrew Thompson udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON); 154602ac6454SAndrew Thompson udev->pwr_save.last_xfer_time = ticks; 154702ac6454SAndrew Thompson /* we are not ready yet */ 154802ac6454SAndrew Thompson udev->refcount = 1; 154902ac6454SAndrew Thompson 155002ac6454SAndrew Thompson /* set up default endpoint descriptor */ 15515b3bb704SAndrew Thompson udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc); 15525b3bb704SAndrew Thompson udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT; 15535b3bb704SAndrew Thompson udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT; 15545b3bb704SAndrew Thompson udev->ctrl_ep_desc.bmAttributes = UE_CONTROL; 15555b3bb704SAndrew Thompson udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET; 15565b3bb704SAndrew Thompson udev->ctrl_ep_desc.wMaxPacketSize[1] = 0; 15575b3bb704SAndrew Thompson udev->ctrl_ep_desc.bInterval = 0; 155802ac6454SAndrew Thompson udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET; 155902ac6454SAndrew Thompson 156002ac6454SAndrew Thompson udev->speed = speed; 1561f29a0724SAndrew Thompson udev->flags.usb_mode = mode; 156202ac6454SAndrew Thompson 156302ac6454SAndrew Thompson /* search for our High Speed USB HUB, if any */ 156402ac6454SAndrew Thompson 156502ac6454SAndrew Thompson adev = udev; 156602ac6454SAndrew Thompson hub = udev->parent_hub; 156702ac6454SAndrew Thompson 156802ac6454SAndrew Thompson while (hub) { 156902ac6454SAndrew Thompson if (hub->speed == USB_SPEED_HIGH) { 157002ac6454SAndrew Thompson udev->hs_hub_addr = hub->address; 1571495f25ceSAndrew Thompson udev->parent_hs_hub = hub; 157202ac6454SAndrew Thompson udev->hs_port_no = adev->port_no; 157302ac6454SAndrew Thompson break; 157402ac6454SAndrew Thompson } 157502ac6454SAndrew Thompson adev = hub; 157602ac6454SAndrew Thompson hub = hub->parent_hub; 157702ac6454SAndrew Thompson } 157802ac6454SAndrew Thompson 1579ae60fdfbSAndrew Thompson /* init the default endpoint */ 1580a593f6b8SAndrew Thompson usb_init_endpoint(udev, 0, 15815b3bb704SAndrew Thompson &udev->ctrl_ep_desc, 15825b3bb704SAndrew Thompson &udev->ctrl_ep); 158302ac6454SAndrew Thompson 158402ac6454SAndrew Thompson /* set device index */ 158502ac6454SAndrew Thompson udev->device_index = device_index; 158602ac6454SAndrew Thompson 15878755859aSAndrew Thompson #if USB_HAVE_UGEN 15880f6e8f93SAndrew Thompson /* Create ugen name */ 1589ee3e3ff5SAndrew Thompson snprintf(udev->ugen_name, sizeof(udev->ugen_name), 1590ee3e3ff5SAndrew Thompson USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev), 1591ee3e3ff5SAndrew Thompson device_index); 15928755859aSAndrew Thompson LIST_INIT(&udev->pd_list); 15938755859aSAndrew Thompson 15940f6e8f93SAndrew Thompson /* Create the control endpoint device */ 15955b3bb704SAndrew Thompson udev->ctrl_dev = usb_make_dev(udev, 0, FREAD|FWRITE); 15960f6e8f93SAndrew Thompson 15970f6e8f93SAndrew Thompson /* Create a link from /dev/ugenX.X to the default endpoint */ 15981bdfff22SAndriy Gapon make_dev_alias(udev->ctrl_dev, "%s", udev->ugen_name); 15990f6e8f93SAndrew Thompson #endif 1600f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_HOST) { 160102ac6454SAndrew Thompson 1602a593f6b8SAndrew Thompson err = usbd_req_set_address(udev, NULL, device_index); 160302ac6454SAndrew Thompson 160402ac6454SAndrew Thompson /* This is the new USB device address from now on */ 160502ac6454SAndrew Thompson 160602ac6454SAndrew Thompson udev->address = device_index; 160702ac6454SAndrew Thompson 160802ac6454SAndrew Thompson /* 160902ac6454SAndrew Thompson * We ignore any set-address errors, hence there are 161002ac6454SAndrew Thompson * buggy USB devices out there that actually receive 161102ac6454SAndrew Thompson * the SETUP PID, but manage to set the address before 161202ac6454SAndrew Thompson * the STATUS stage is ACK'ed. If the device responds 161302ac6454SAndrew Thompson * to the subsequent get-descriptor at the new 161402ac6454SAndrew Thompson * address, then we know that the set-address command 161502ac6454SAndrew Thompson * was successful. 161602ac6454SAndrew Thompson */ 161702ac6454SAndrew Thompson if (err) { 161802ac6454SAndrew Thompson DPRINTFN(0, "set address %d failed " 161903797f33SAndrew Thompson "(%s, ignored)\n", udev->address, 1620a593f6b8SAndrew Thompson usbd_errstr(err)); 162102ac6454SAndrew Thompson } 162202ac6454SAndrew Thompson /* allow device time to set new address */ 1623a593f6b8SAndrew Thompson usb_pause_mtx(NULL, 162402ac6454SAndrew Thompson USB_MS_TO_TICKS(USB_SET_ADDRESS_SETTLE)); 162502ac6454SAndrew Thompson } else { 162602ac6454SAndrew Thompson /* We are not self powered */ 162702ac6454SAndrew Thompson udev->flags.self_powered = 0; 162802ac6454SAndrew Thompson 162902ac6454SAndrew Thompson /* Set unconfigured state */ 163002ac6454SAndrew Thompson udev->curr_config_no = USB_UNCONFIG_NO; 163102ac6454SAndrew Thompson udev->curr_config_index = USB_UNCONFIG_INDEX; 163202ac6454SAndrew Thompson 163302ac6454SAndrew Thompson /* Setup USB descriptors */ 1634a593f6b8SAndrew Thompson err = (usb_temp_setup_by_index_p) (udev, usb_template); 163502ac6454SAndrew Thompson if (err) { 163602ac6454SAndrew Thompson DPRINTFN(0, "setting up USB template failed maybe the USB " 163702ac6454SAndrew Thompson "template module has not been loaded\n"); 163802ac6454SAndrew Thompson goto done; 163902ac6454SAndrew Thompson } 164002ac6454SAndrew Thompson } 1641a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_ADDRESSED); 164202ac6454SAndrew Thompson 164302ac6454SAndrew Thompson /* 164402ac6454SAndrew Thompson * Get the first 8 bytes of the device descriptor ! 164502ac6454SAndrew Thompson * 1646a593f6b8SAndrew Thompson * NOTE: "usbd_do_request" will check the device descriptor 164702ac6454SAndrew Thompson * next time we do a request to see if the maximum packet size 164802ac6454SAndrew Thompson * changed! The 8 first bytes of the device descriptor 164902ac6454SAndrew Thompson * contains the maximum packet size to use on control endpoint 165002ac6454SAndrew Thompson * 0. If this value is different from "USB_MAX_IPACKET" a new 165102ac6454SAndrew Thompson * USB control request will be setup! 165202ac6454SAndrew Thompson */ 1653a593f6b8SAndrew Thompson err = usbd_req_get_desc(udev, NULL, NULL, &udev->ddesc, 165402ac6454SAndrew Thompson USB_MAX_IPACKET, USB_MAX_IPACKET, 0, UDESC_DEVICE, 0, 0); 165502ac6454SAndrew Thompson if (err) { 165602ac6454SAndrew Thompson DPRINTFN(0, "getting device descriptor " 1657767cb2e2SAndrew Thompson "at addr %d failed, %s\n", udev->address, 1658a593f6b8SAndrew Thompson usbd_errstr(err)); 165902ac6454SAndrew Thompson /* XXX try to re-enumerate the device */ 1660a593f6b8SAndrew Thompson err = usbd_req_re_enumerate(udev, NULL); 166102ac6454SAndrew Thompson if (err) { 166202ac6454SAndrew Thompson goto done; 166302ac6454SAndrew Thompson } 166402ac6454SAndrew Thompson } 166502ac6454SAndrew Thompson DPRINTF("adding unit addr=%d, rev=%02x, class=%d, " 166602ac6454SAndrew Thompson "subclass=%d, protocol=%d, maxpacket=%d, len=%d, speed=%d\n", 166702ac6454SAndrew Thompson udev->address, UGETW(udev->ddesc.bcdUSB), 166802ac6454SAndrew Thompson udev->ddesc.bDeviceClass, 166902ac6454SAndrew Thompson udev->ddesc.bDeviceSubClass, 167002ac6454SAndrew Thompson udev->ddesc.bDeviceProtocol, 167102ac6454SAndrew Thompson udev->ddesc.bMaxPacketSize, 167202ac6454SAndrew Thompson udev->ddesc.bLength, 167302ac6454SAndrew Thompson udev->speed); 167402ac6454SAndrew Thompson 167502ac6454SAndrew Thompson /* get the full device descriptor */ 1676a593f6b8SAndrew Thompson err = usbd_req_get_device_desc(udev, NULL, &udev->ddesc); 167702ac6454SAndrew Thompson if (err) { 167802ac6454SAndrew Thompson DPRINTF("addr=%d, getting full desc failed\n", 167902ac6454SAndrew Thompson udev->address); 168002ac6454SAndrew Thompson goto done; 168102ac6454SAndrew Thompson } 168202ac6454SAndrew Thompson /* 168302ac6454SAndrew Thompson * Setup temporary USB attach args so that we can figure out some 168402ac6454SAndrew Thompson * basic quirks for this device. 168502ac6454SAndrew Thompson */ 1686a593f6b8SAndrew Thompson usb_init_attach_arg(udev, &uaa); 168702ac6454SAndrew Thompson 1688a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) { 168902ac6454SAndrew Thompson udev->flags.uq_bus_powered = 1; 169002ac6454SAndrew Thompson } 1691a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) { 169202ac6454SAndrew Thompson udev->flags.no_strings = 1; 169302ac6454SAndrew Thompson } 169402ac6454SAndrew Thompson /* 169502ac6454SAndrew Thompson * Workaround for buggy USB devices. 169602ac6454SAndrew Thompson * 169702ac6454SAndrew Thompson * It appears that some string-less USB chips will crash and 169802ac6454SAndrew Thompson * disappear if any attempts are made to read any string 169902ac6454SAndrew Thompson * descriptors. 170002ac6454SAndrew Thompson * 170102ac6454SAndrew Thompson * Try to detect such chips by checking the strings in the USB 170202ac6454SAndrew Thompson * device descriptor. If no strings are present there we 170302ac6454SAndrew Thompson * simply disable all USB strings. 170402ac6454SAndrew Thompson */ 170502ac6454SAndrew Thompson scratch_ptr = udev->bus->scratch[0].data; 170602ac6454SAndrew Thompson scratch_size = sizeof(udev->bus->scratch[0].data); 170702ac6454SAndrew Thompson 170802ac6454SAndrew Thompson if (udev->ddesc.iManufacturer || 170902ac6454SAndrew Thompson udev->ddesc.iProduct || 171002ac6454SAndrew Thompson udev->ddesc.iSerialNumber) { 171102ac6454SAndrew Thompson /* read out the language ID string */ 1712a593f6b8SAndrew Thompson err = usbd_req_get_string_desc(udev, NULL, 1713c10e1453SAndrew Thompson (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE); 171402ac6454SAndrew Thompson } else { 171502ac6454SAndrew Thompson err = USB_ERR_INVAL; 171602ac6454SAndrew Thompson } 171702ac6454SAndrew Thompson 171802ac6454SAndrew Thompson if (err || (scratch_ptr[0] < 4)) { 171902ac6454SAndrew Thompson udev->flags.no_strings = 1; 172002ac6454SAndrew Thompson } else { 17217a918edfSAndrew Thompson uint16_t langid; 17227a918edfSAndrew Thompson uint16_t pref; 17237a918edfSAndrew Thompson uint16_t mask; 17247a918edfSAndrew Thompson uint8_t x; 17257a918edfSAndrew Thompson 17267a918edfSAndrew Thompson /* load preferred value and mask */ 17277a918edfSAndrew Thompson pref = usb_lang_id; 17287a918edfSAndrew Thompson mask = usb_lang_mask; 17297a918edfSAndrew Thompson 17307a918edfSAndrew Thompson /* align length correctly */ 17317a918edfSAndrew Thompson scratch_ptr[0] &= ~1; 17327a918edfSAndrew Thompson 17337a918edfSAndrew Thompson /* fix compiler warning */ 17347a918edfSAndrew Thompson langid = 0; 17357a918edfSAndrew Thompson 17367a918edfSAndrew Thompson /* search for preferred language */ 17377a918edfSAndrew Thompson for (x = 2; (x < scratch_ptr[0]); x += 2) { 17387a918edfSAndrew Thompson langid = UGETW(scratch_ptr + x); 17397a918edfSAndrew Thompson if ((langid & mask) == pref) 17407a918edfSAndrew Thompson break; 17417a918edfSAndrew Thompson } 17427a918edfSAndrew Thompson if (x >= scratch_ptr[0]) { 174302ac6454SAndrew Thompson /* pick the first language as the default */ 17447a918edfSAndrew Thompson DPRINTFN(1, "Using first language\n"); 17457a918edfSAndrew Thompson langid = UGETW(scratch_ptr + 2); 17467a918edfSAndrew Thompson } 17477a918edfSAndrew Thompson 17487a918edfSAndrew Thompson DPRINTFN(1, "Language selected: 0x%04x\n", langid); 17497a918edfSAndrew Thompson udev->langid = langid; 175002ac6454SAndrew Thompson } 175102ac6454SAndrew Thompson 175202ac6454SAndrew Thompson /* assume 100mA bus powered for now. Changed when configured. */ 175302ac6454SAndrew Thompson udev->power = USB_MIN_POWER; 1754c86aead6SAndrew Thompson /* fetch the vendor and product strings from the device */ 1755a593f6b8SAndrew Thompson usbd_set_device_strings(udev); 175602ac6454SAndrew Thompson 17572a4c6157SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 17582a4c6157SAndrew Thompson /* USB device mode setup is complete */ 17592a4c6157SAndrew Thompson err = 0; 17602a4c6157SAndrew Thompson goto config_done; 17612a4c6157SAndrew Thompson } 176202ac6454SAndrew Thompson 176302ac6454SAndrew Thompson /* 176402ac6454SAndrew Thompson * Most USB devices should attach to config index 0 by 176502ac6454SAndrew Thompson * default 176602ac6454SAndrew Thompson */ 1767a593f6b8SAndrew Thompson if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) { 176802ac6454SAndrew Thompson config_index = 0; 176902ac6454SAndrew Thompson config_quirk = 1; 1770a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) { 177102ac6454SAndrew Thompson config_index = 1; 177202ac6454SAndrew Thompson config_quirk = 1; 1773a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) { 177402ac6454SAndrew Thompson config_index = 2; 177502ac6454SAndrew Thompson config_quirk = 1; 1776a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) { 177702ac6454SAndrew Thompson config_index = 3; 177802ac6454SAndrew Thompson config_quirk = 1; 1779a593f6b8SAndrew Thompson } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) { 178002ac6454SAndrew Thompson config_index = 4; 178102ac6454SAndrew Thompson config_quirk = 1; 178202ac6454SAndrew Thompson } else { 178302ac6454SAndrew Thompson config_index = 0; 178402ac6454SAndrew Thompson config_quirk = 0; 178502ac6454SAndrew Thompson } 178602ac6454SAndrew Thompson 17872a4c6157SAndrew Thompson set_config_failed = 0; 178802ac6454SAndrew Thompson repeat_set_config: 178902ac6454SAndrew Thompson 179002ac6454SAndrew Thompson DPRINTF("setting config %u\n", config_index); 179102ac6454SAndrew Thompson 179202ac6454SAndrew Thompson /* get the USB device configured */ 1793a593f6b8SAndrew Thompson err = usbd_set_config_index(udev, config_index); 179402ac6454SAndrew Thompson if (err) { 179502ac6454SAndrew Thompson if (udev->ddesc.bNumConfigurations != 0) { 179602ac6454SAndrew Thompson if (!set_config_failed) { 179702ac6454SAndrew Thompson set_config_failed = 1; 179802ac6454SAndrew Thompson /* XXX try to re-enumerate the device */ 17992a4c6157SAndrew Thompson err = usbd_req_re_enumerate(udev, NULL); 180002ac6454SAndrew Thompson if (err == 0) 180102ac6454SAndrew Thompson goto repeat_set_config; 180202ac6454SAndrew Thompson } 18032a4c6157SAndrew Thompson DPRINTFN(0, "Failure selecting configuration index %u:" 18042a4c6157SAndrew Thompson "%s, port %u, addr %u (ignored)\n", 1805a593f6b8SAndrew Thompson config_index, usbd_errstr(err), udev->port_no, 180602ac6454SAndrew Thompson udev->address); 180702ac6454SAndrew Thompson } 180802ac6454SAndrew Thompson /* 18092a4c6157SAndrew Thompson * Some USB devices do not have any configurations. Ignore any 18102a4c6157SAndrew Thompson * set config failures! 181102ac6454SAndrew Thompson */ 181202ac6454SAndrew Thompson err = 0; 18132a4c6157SAndrew Thompson goto config_done; 18142a4c6157SAndrew Thompson } 18152a4c6157SAndrew Thompson if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) { 181602ac6454SAndrew Thompson if ((udev->cdesc->bNumInterface < 2) && 18172a4c6157SAndrew Thompson usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) { 18182a4c6157SAndrew Thompson DPRINTFN(0, "Found no endpoints, trying next config\n"); 181902ac6454SAndrew Thompson config_index++; 182002ac6454SAndrew Thompson goto repeat_set_config; 182102ac6454SAndrew Thompson } 182202ac6454SAndrew Thompson if (config_index == 0) { 182302ac6454SAndrew Thompson /* 182402ac6454SAndrew Thompson * Try to figure out if we have an 182502ac6454SAndrew Thompson * auto-install disk there: 182602ac6454SAndrew Thompson */ 1827d84a79e7SAndrew Thompson if (usb_iface_is_cdrom(udev, 0)) { 182802ac6454SAndrew Thompson DPRINTFN(0, "Found possible auto-install " 182902ac6454SAndrew Thompson "disk (trying next config)\n"); 183002ac6454SAndrew Thompson config_index++; 183102ac6454SAndrew Thompson goto repeat_set_config; 183202ac6454SAndrew Thompson } 183302ac6454SAndrew Thompson } 18342a4c6157SAndrew Thompson } 18352a4c6157SAndrew Thompson EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa); 18362a4c6157SAndrew Thompson if (uaa.dev_state != UAA_DEV_READY) { 1837cb18f7d1SAlfred Perlstein /* leave device unconfigured */ 1838d88688c7SAndrew Thompson usb_unconfigure(udev, 0); 183902ac6454SAndrew Thompson } 184002ac6454SAndrew Thompson 18412a4c6157SAndrew Thompson config_done: 184202ac6454SAndrew Thompson DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n", 184302ac6454SAndrew Thompson udev->address, udev, udev->parent_hub); 184402ac6454SAndrew Thompson 184502ac6454SAndrew Thompson /* register our device - we are ready */ 1846a593f6b8SAndrew Thompson usb_bus_port_set_device(bus, parent_hub ? 184702ac6454SAndrew Thompson parent_hub->hub->ports + port_index : NULL, udev, device_index); 184802ac6454SAndrew Thompson 18490f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 18508755859aSAndrew Thompson /* Symlink the ugen device name */ 1851a593f6b8SAndrew Thompson udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name); 18528755859aSAndrew Thompson 18538755859aSAndrew Thompson /* Announce device */ 1854ae538d85SAndrew Thompson printf("%s: <%s> at %s\n", udev->ugen_name, 1855ae538d85SAndrew Thompson usb_get_manufacturer(udev), 185602ac6454SAndrew Thompson device_get_nameunit(udev->bus->bdev)); 18577efaaa9aSAndrew Thompson 18583acd904dSAndrew Thompson usb_notify_addq("ATTACH", udev); 18598755859aSAndrew Thompson #endif 186002ac6454SAndrew Thompson done: 186102ac6454SAndrew Thompson if (err) { 1862d88688c7SAndrew Thompson /* 1863d88688c7SAndrew Thompson * Free USB device and all subdevices, if any. 1864d88688c7SAndrew Thompson */ 1865d88688c7SAndrew Thompson usb_free_device(udev, 0); 186602ac6454SAndrew Thompson udev = NULL; 186702ac6454SAndrew Thompson } 186802ac6454SAndrew Thompson return (udev); 186902ac6454SAndrew Thompson } 187002ac6454SAndrew Thompson 18710f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 1872ee3e3ff5SAndrew Thompson static struct cdev * 1873a593f6b8SAndrew Thompson usb_make_dev(struct usb_device *udev, int ep, int mode) 1874ee3e3ff5SAndrew Thompson { 1875760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 1876ee3e3ff5SAndrew Thompson char devname[20]; 1877ee3e3ff5SAndrew Thompson 1878ee3e3ff5SAndrew Thompson /* Store information to locate ourselves again later */ 1879760bc48eSAndrew Thompson pd = malloc(sizeof(struct usb_fs_privdata), M_USBDEV, 1880ee3e3ff5SAndrew Thompson M_WAITOK | M_ZERO); 1881ee3e3ff5SAndrew Thompson pd->bus_index = device_get_unit(udev->bus->bdev); 1882ee3e3ff5SAndrew Thompson pd->dev_index = udev->device_index; 1883ee3e3ff5SAndrew Thompson pd->ep_addr = ep; 1884ee3e3ff5SAndrew Thompson pd->mode = mode; 1885ee3e3ff5SAndrew Thompson 1886ee3e3ff5SAndrew Thompson /* Now, create the device itself */ 1887f5f145baSAndrew Thompson snprintf(devname, sizeof(devname), "%u.%u.%u", 1888f35aaff0SAndrew Thompson pd->bus_index, pd->dev_index, pd->ep_addr); 1889a593f6b8SAndrew Thompson pd->cdev = make_dev(&usb_devsw, 0, UID_ROOT, 1890ee3e3ff5SAndrew Thompson GID_OPERATOR, 0600, USB_DEVICE_DIR "/%s", devname); 1891ee3e3ff5SAndrew Thompson pd->cdev->si_drv1 = pd; 1892ee3e3ff5SAndrew Thompson 1893ee3e3ff5SAndrew Thompson return (pd->cdev); 1894ee3e3ff5SAndrew Thompson } 1895ee3e3ff5SAndrew Thompson 1896ee3e3ff5SAndrew Thompson static void 1897a593f6b8SAndrew Thompson usb_cdev_create(struct usb_device *udev) 1898ee3e3ff5SAndrew Thompson { 1899760bc48eSAndrew Thompson struct usb_config_descriptor *cd; 1900760bc48eSAndrew Thompson struct usb_endpoint_descriptor *ed; 1901760bc48eSAndrew Thompson struct usb_descriptor *desc; 1902760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 1903ee3e3ff5SAndrew Thompson struct cdev *dev; 1904f5f145baSAndrew Thompson int inmode, outmode, inmask, outmask, mode; 1905f5f145baSAndrew Thompson uint8_t ep; 1906ee3e3ff5SAndrew Thompson 1907ee3e3ff5SAndrew Thompson KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries")); 1908ee3e3ff5SAndrew Thompson 1909ee3e3ff5SAndrew Thompson DPRINTFN(2, "Creating device nodes\n"); 1910ee3e3ff5SAndrew Thompson 1911a593f6b8SAndrew Thompson if (usbd_get_mode(udev) == USB_MODE_DEVICE) { 1912ee3e3ff5SAndrew Thompson inmode = FWRITE; 1913ee3e3ff5SAndrew Thompson outmode = FREAD; 1914ee3e3ff5SAndrew Thompson } else { /* USB_MODE_HOST */ 1915ee3e3ff5SAndrew Thompson inmode = FREAD; 1916ee3e3ff5SAndrew Thompson outmode = FWRITE; 1917ee3e3ff5SAndrew Thompson } 1918ee3e3ff5SAndrew Thompson 1919f5f145baSAndrew Thompson inmask = 0; 1920f5f145baSAndrew Thompson outmask = 0; 1921f5f145baSAndrew Thompson desc = NULL; 1922f5f145baSAndrew Thompson 1923f5f145baSAndrew Thompson /* 1924f5f145baSAndrew Thompson * Collect all used endpoint numbers instead of just 1925f5f145baSAndrew Thompson * generating 16 static endpoints. 1926f5f145baSAndrew Thompson */ 1927a593f6b8SAndrew Thompson cd = usbd_get_config_descriptor(udev); 1928a593f6b8SAndrew Thompson while ((desc = usb_desc_foreach(cd, desc))) { 1929f5f145baSAndrew Thompson /* filter out all endpoint descriptors */ 1930f5f145baSAndrew Thompson if ((desc->bDescriptorType == UDESC_ENDPOINT) && 1931f5f145baSAndrew Thompson (desc->bLength >= sizeof(*ed))) { 1932760bc48eSAndrew Thompson ed = (struct usb_endpoint_descriptor *)desc; 1933f5f145baSAndrew Thompson 1934f5f145baSAndrew Thompson /* update masks */ 1935f5f145baSAndrew Thompson ep = ed->bEndpointAddress; 1936f5f145baSAndrew Thompson if (UE_GET_DIR(ep) == UE_DIR_OUT) 1937f5f145baSAndrew Thompson outmask |= 1 << UE_GET_ADDR(ep); 1938f5f145baSAndrew Thompson else 1939f5f145baSAndrew Thompson inmask |= 1 << UE_GET_ADDR(ep); 1940f5f145baSAndrew Thompson } 1941f5f145baSAndrew Thompson } 1942ee3e3ff5SAndrew Thompson 1943ee3e3ff5SAndrew Thompson /* Create all available endpoints except EP0 */ 1944ee3e3ff5SAndrew Thompson for (ep = 1; ep < 16; ep++) { 1945f5f145baSAndrew Thompson mode = inmask & (1 << ep) ? inmode : 0; 1946f5f145baSAndrew Thompson mode |= outmask & (1 << ep) ? outmode : 0; 1947ee3e3ff5SAndrew Thompson if (mode == 0) 1948ee3e3ff5SAndrew Thompson continue; /* no IN or OUT endpoint */ 1949ee3e3ff5SAndrew Thompson 1950a593f6b8SAndrew Thompson dev = usb_make_dev(udev, ep, mode); 1951ee3e3ff5SAndrew Thompson pd = dev->si_drv1; 1952ee3e3ff5SAndrew Thompson LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next); 1953ee3e3ff5SAndrew Thompson } 1954ee3e3ff5SAndrew Thompson } 1955ee3e3ff5SAndrew Thompson 1956ee3e3ff5SAndrew Thompson static void 1957a593f6b8SAndrew Thompson usb_cdev_free(struct usb_device *udev) 1958ee3e3ff5SAndrew Thompson { 1959760bc48eSAndrew Thompson struct usb_fs_privdata* pd; 1960cb18f7d1SAlfred Perlstein struct cdev* pcdev; 1961ee3e3ff5SAndrew Thompson 1962ee3e3ff5SAndrew Thompson DPRINTFN(2, "Freeing device nodes\n"); 1963ee3e3ff5SAndrew Thompson 1964ee3e3ff5SAndrew Thompson while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) { 1965ee3e3ff5SAndrew Thompson KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt")); 1966ee3e3ff5SAndrew Thompson 1967cb18f7d1SAlfred Perlstein pcdev = pd->cdev; 1968ee3e3ff5SAndrew Thompson pd->cdev = NULL; 1969ee3e3ff5SAndrew Thompson LIST_REMOVE(pd, pd_next); 1970cb18f7d1SAlfred Perlstein if (pcdev != NULL) 1971cb18f7d1SAlfred Perlstein destroy_dev_sched_cb(pcdev, usb_cdev_cleanup, pd); 1972ee3e3ff5SAndrew Thompson } 1973ee3e3ff5SAndrew Thompson } 1974ee3e3ff5SAndrew Thompson 1975ee3e3ff5SAndrew Thompson static void 1976a593f6b8SAndrew Thompson usb_cdev_cleanup(void* arg) 1977ee3e3ff5SAndrew Thompson { 1978ee3e3ff5SAndrew Thompson free(arg, M_USBDEV); 1979ee3e3ff5SAndrew Thompson } 19800f6e8f93SAndrew Thompson #endif 1981ee3e3ff5SAndrew Thompson 198202ac6454SAndrew Thompson /*------------------------------------------------------------------------* 1983a593f6b8SAndrew Thompson * usb_free_device 198402ac6454SAndrew Thompson * 1985d88688c7SAndrew Thompson * This function is NULL safe and will free an USB device and its 1986d88688c7SAndrew Thompson * children devices, if any. 1987bdd41206SAndrew Thompson * 1988d88688c7SAndrew Thompson * Flag values: Reserved, set to zero. 198902ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 199002ac6454SAndrew Thompson void 1991a593f6b8SAndrew Thompson usb_free_device(struct usb_device *udev, uint8_t flag) 199202ac6454SAndrew Thompson { 1993760bc48eSAndrew Thompson struct usb_bus *bus; 1994bdd41206SAndrew Thompson 1995bdd41206SAndrew Thompson if (udev == NULL) 1996bdd41206SAndrew Thompson return; /* already freed */ 199702ac6454SAndrew Thompson 199802ac6454SAndrew Thompson DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no); 199902ac6454SAndrew Thompson 2000bd216778SAndrew Thompson bus = udev->bus; 2001a593f6b8SAndrew Thompson usb_set_device_state(udev, USB_STATE_DETACHED); 2002bdd41206SAndrew Thompson 20038755859aSAndrew Thompson #if USB_HAVE_UGEN 20043acd904dSAndrew Thompson usb_notify_addq("DETACH", udev); 200502ac6454SAndrew Thompson 2006ee3e3ff5SAndrew Thompson printf("%s: <%s> at %s (disconnected)\n", udev->ugen_name, 2007ae538d85SAndrew Thompson usb_get_manufacturer(udev), device_get_nameunit(bus->bdev)); 200802ac6454SAndrew Thompson 2009ee3e3ff5SAndrew Thompson /* Destroy UGEN symlink, if any */ 201002ac6454SAndrew Thompson if (udev->ugen_symlink) { 2011a593f6b8SAndrew Thompson usb_free_symlink(udev->ugen_symlink); 201202ac6454SAndrew Thompson udev->ugen_symlink = NULL; 201302ac6454SAndrew Thompson } 20148755859aSAndrew Thompson #endif 201502ac6454SAndrew Thompson /* 201602ac6454SAndrew Thompson * Unregister our device first which will prevent any further 201702ac6454SAndrew Thompson * references: 201802ac6454SAndrew Thompson */ 2019a593f6b8SAndrew Thompson usb_bus_port_set_device(bus, udev->parent_hub ? 202002ac6454SAndrew Thompson udev->parent_hub->hub->ports + udev->port_index : NULL, 202102ac6454SAndrew Thompson NULL, USB_ROOT_HUB_ADDR); 202202ac6454SAndrew Thompson 20230f6e8f93SAndrew Thompson #if USB_HAVE_UGEN 202402ac6454SAndrew Thompson /* wait for all pending references to go away: */ 2025a593f6b8SAndrew Thompson mtx_lock(&usb_ref_lock); 202602ac6454SAndrew Thompson udev->refcount--; 202702ac6454SAndrew Thompson while (udev->refcount != 0) { 202891cd9240SAndrew Thompson cv_wait(&udev->ref_cv, &usb_ref_lock); 202902ac6454SAndrew Thompson } 2030a593f6b8SAndrew Thompson mtx_unlock(&usb_ref_lock); 2031bdd41206SAndrew Thompson 20325b3bb704SAndrew Thompson destroy_dev_sched_cb(udev->ctrl_dev, usb_cdev_cleanup, 20335b3bb704SAndrew Thompson udev->ctrl_dev->si_drv1); 20340f6e8f93SAndrew Thompson #endif 203502ac6454SAndrew Thompson 2036f29a0724SAndrew Thompson if (udev->flags.usb_mode == USB_MODE_DEVICE) { 203702ac6454SAndrew Thompson /* stop receiving any control transfers (Device Side Mode) */ 20385b3bb704SAndrew Thompson usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX); 203902ac6454SAndrew Thompson } 204002ac6454SAndrew Thompson 2041bdd41206SAndrew Thompson /* the following will get the device unconfigured in software */ 2042d88688c7SAndrew Thompson usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0); 204302ac6454SAndrew Thompson 204402ac6454SAndrew Thompson /* unsetup any leftover default USB transfers */ 20455b3bb704SAndrew Thompson usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX); 204602ac6454SAndrew Thompson 204702ac6454SAndrew Thompson /* template unsetup, if any */ 2048a593f6b8SAndrew Thompson (usb_temp_unsetup_p) (udev); 204902ac6454SAndrew Thompson 205002ac6454SAndrew Thompson /* 205102ac6454SAndrew Thompson * Make sure that our clear-stall messages are not queued 205202ac6454SAndrew Thompson * anywhere: 205302ac6454SAndrew Thompson */ 205402ac6454SAndrew Thompson USB_BUS_LOCK(udev->bus); 2055a593f6b8SAndrew Thompson usb_proc_mwait(&udev->bus->non_giant_callback_proc, 205602ac6454SAndrew Thompson &udev->cs_msg[0], &udev->cs_msg[1]); 205702ac6454SAndrew Thompson USB_BUS_UNLOCK(udev->bus); 205802ac6454SAndrew Thompson 205991cd9240SAndrew Thompson sx_destroy(&udev->ctrl_sx); 206091cd9240SAndrew Thompson sx_destroy(&udev->enum_sx); 20612df1e9a6SAndrew Thompson sx_destroy(&udev->sr_sx); 206202ac6454SAndrew Thompson 206391cd9240SAndrew Thompson cv_destroy(&udev->ctrlreq_cv); 206491cd9240SAndrew Thompson cv_destroy(&udev->ref_cv); 206502ac6454SAndrew Thompson 206691cd9240SAndrew Thompson mtx_destroy(&udev->device_mtx); 20678755859aSAndrew Thompson #if USB_HAVE_UGEN 2068ee3e3ff5SAndrew Thompson KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries")); 20698755859aSAndrew Thompson #endif 207002ac6454SAndrew Thompson 207102ac6454SAndrew Thompson /* free device */ 207228212de2SAndrew Thompson free(udev->serial, M_USB); 207328212de2SAndrew Thompson free(udev->manufacturer, M_USB); 207428212de2SAndrew Thompson free(udev->product, M_USB); 207502ac6454SAndrew Thompson free(udev, M_USB); 207602ac6454SAndrew Thompson } 207702ac6454SAndrew Thompson 207802ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2079a593f6b8SAndrew Thompson * usbd_get_iface 208002ac6454SAndrew Thompson * 208102ac6454SAndrew Thompson * This function is the safe way to get the USB interface structure 208202ac6454SAndrew Thompson * pointer by interface index. 208302ac6454SAndrew Thompson * 208402ac6454SAndrew Thompson * Return values: 208502ac6454SAndrew Thompson * NULL: Interface not present. 208602ac6454SAndrew Thompson * Else: Pointer to USB interface structure. 208702ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 2088760bc48eSAndrew Thompson struct usb_interface * 2089a593f6b8SAndrew Thompson usbd_get_iface(struct usb_device *udev, uint8_t iface_index) 209002ac6454SAndrew Thompson { 2091760bc48eSAndrew Thompson struct usb_interface *iface = udev->ifaces + iface_index; 209202ac6454SAndrew Thompson 2093bdd41206SAndrew Thompson if (iface_index >= udev->ifaces_max) 209402ac6454SAndrew Thompson return (NULL); 209502ac6454SAndrew Thompson return (iface); 209602ac6454SAndrew Thompson } 209702ac6454SAndrew Thompson 209802ac6454SAndrew Thompson /*------------------------------------------------------------------------* 20993c8d24f4SAndrew Thompson * usbd_find_descriptor 210002ac6454SAndrew Thompson * 210102ac6454SAndrew Thompson * This function will lookup the first descriptor that matches the 210202ac6454SAndrew Thompson * criteria given by the arguments "type" and "subtype". Descriptors 210302ac6454SAndrew Thompson * will only be searched within the interface having the index 210402ac6454SAndrew Thompson * "iface_index". If the "id" argument points to an USB descriptor, 210502ac6454SAndrew Thompson * it will be skipped before the search is started. This allows 210602ac6454SAndrew Thompson * searching for multiple descriptors using the same criteria. Else 210702ac6454SAndrew Thompson * the search is started after the interface descriptor. 210802ac6454SAndrew Thompson * 210902ac6454SAndrew Thompson * Return values: 211002ac6454SAndrew Thompson * NULL: End of descriptors 211102ac6454SAndrew Thompson * Else: A descriptor matching the criteria 211202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 211302ac6454SAndrew Thompson void * 21143c8d24f4SAndrew Thompson usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index, 211502ac6454SAndrew Thompson uint8_t type, uint8_t type_mask, 211602ac6454SAndrew Thompson uint8_t subtype, uint8_t subtype_mask) 211702ac6454SAndrew Thompson { 2118760bc48eSAndrew Thompson struct usb_descriptor *desc; 2119760bc48eSAndrew Thompson struct usb_config_descriptor *cd; 2120760bc48eSAndrew Thompson struct usb_interface *iface; 212102ac6454SAndrew Thompson 2122a593f6b8SAndrew Thompson cd = usbd_get_config_descriptor(udev); 212302ac6454SAndrew Thompson if (cd == NULL) { 212402ac6454SAndrew Thompson return (NULL); 212502ac6454SAndrew Thompson } 212602ac6454SAndrew Thompson if (id == NULL) { 2127a593f6b8SAndrew Thompson iface = usbd_get_iface(udev, iface_index); 212802ac6454SAndrew Thompson if (iface == NULL) { 212902ac6454SAndrew Thompson return (NULL); 213002ac6454SAndrew Thompson } 2131a593f6b8SAndrew Thompson id = usbd_get_interface_descriptor(iface); 213202ac6454SAndrew Thompson if (id == NULL) { 213302ac6454SAndrew Thompson return (NULL); 213402ac6454SAndrew Thompson } 213502ac6454SAndrew Thompson } 213602ac6454SAndrew Thompson desc = (void *)id; 213702ac6454SAndrew Thompson 2138a593f6b8SAndrew Thompson while ((desc = usb_desc_foreach(cd, desc))) { 213902ac6454SAndrew Thompson 214002ac6454SAndrew Thompson if (desc->bDescriptorType == UDESC_INTERFACE) { 214102ac6454SAndrew Thompson break; 214202ac6454SAndrew Thompson } 214302ac6454SAndrew Thompson if (((desc->bDescriptorType & type_mask) == type) && 214402ac6454SAndrew Thompson ((desc->bDescriptorSubtype & subtype_mask) == subtype)) { 214502ac6454SAndrew Thompson return (desc); 214602ac6454SAndrew Thompson } 214702ac6454SAndrew Thompson } 214802ac6454SAndrew Thompson return (NULL); 214902ac6454SAndrew Thompson } 215002ac6454SAndrew Thompson 215102ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2152a593f6b8SAndrew Thompson * usb_devinfo 215302ac6454SAndrew Thompson * 215402ac6454SAndrew Thompson * This function will dump information from the device descriptor 215502ac6454SAndrew Thompson * belonging to the USB device pointed to by "udev", to the string 215602ac6454SAndrew Thompson * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes 215702ac6454SAndrew Thompson * including the terminating zero. 215802ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 215902ac6454SAndrew Thompson void 2160a593f6b8SAndrew Thompson usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len) 216102ac6454SAndrew Thompson { 2162760bc48eSAndrew Thompson struct usb_device_descriptor *udd = &udev->ddesc; 216302ac6454SAndrew Thompson uint16_t bcdDevice; 216402ac6454SAndrew Thompson uint16_t bcdUSB; 216502ac6454SAndrew Thompson 216602ac6454SAndrew Thompson bcdUSB = UGETW(udd->bcdUSB); 216702ac6454SAndrew Thompson bcdDevice = UGETW(udd->bcdDevice); 216802ac6454SAndrew Thompson 216902ac6454SAndrew Thompson if (udd->bDeviceClass != 0xFF) { 217002ac6454SAndrew Thompson snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/" 21718755859aSAndrew Thompson "%x.%02x, addr %d", 2172ae538d85SAndrew Thompson usb_get_manufacturer(udev), 2173ae538d85SAndrew Thompson usb_get_product(udev), 217402ac6454SAndrew Thompson udd->bDeviceClass, udd->bDeviceSubClass, 217502ac6454SAndrew Thompson (bcdUSB >> 8), bcdUSB & 0xFF, 217602ac6454SAndrew Thompson (bcdDevice >> 8), bcdDevice & 0xFF, 217702ac6454SAndrew Thompson udev->address); 217802ac6454SAndrew Thompson } else { 217902ac6454SAndrew Thompson snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/" 21808755859aSAndrew Thompson "%x.%02x, addr %d", 2181ae538d85SAndrew Thompson usb_get_manufacturer(udev), 2182ae538d85SAndrew Thompson usb_get_product(udev), 218302ac6454SAndrew Thompson (bcdUSB >> 8), bcdUSB & 0xFF, 218402ac6454SAndrew Thompson (bcdDevice >> 8), bcdDevice & 0xFF, 218502ac6454SAndrew Thompson udev->address); 218602ac6454SAndrew Thompson } 218702ac6454SAndrew Thompson } 218802ac6454SAndrew Thompson 2189ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 219002ac6454SAndrew Thompson /* 219102ac6454SAndrew Thompson * Descriptions of of known vendors and devices ("products"). 219202ac6454SAndrew Thompson */ 219302ac6454SAndrew Thompson struct usb_knowndev { 219402ac6454SAndrew Thompson uint16_t vendor; 219502ac6454SAndrew Thompson uint16_t product; 219602ac6454SAndrew Thompson uint32_t flags; 219702ac6454SAndrew Thompson const char *vendorname; 219802ac6454SAndrew Thompson const char *productname; 219902ac6454SAndrew Thompson }; 220002ac6454SAndrew Thompson 220102ac6454SAndrew Thompson #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */ 220202ac6454SAndrew Thompson 220302ac6454SAndrew Thompson #include "usbdevs.h" 220402ac6454SAndrew Thompson #include "usbdevs_data.h" 220502ac6454SAndrew Thompson #endif /* USB_VERBOSE */ 220602ac6454SAndrew Thompson 220702ac6454SAndrew Thompson static void 2208a593f6b8SAndrew Thompson usbd_set_device_strings(struct usb_device *udev) 220902ac6454SAndrew Thompson { 2210760bc48eSAndrew Thompson struct usb_device_descriptor *udd = &udev->ddesc; 2211ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 221202ac6454SAndrew Thompson const struct usb_knowndev *kdp; 221302ac6454SAndrew Thompson #endif 22142df1e9a6SAndrew Thompson char *temp_ptr; 22157a918edfSAndrew Thompson size_t temp_size; 221602ac6454SAndrew Thompson uint16_t vendor_id; 221702ac6454SAndrew Thompson uint16_t product_id; 221802ac6454SAndrew Thompson 22192df1e9a6SAndrew Thompson temp_ptr = (char *)udev->bus->scratch[0].data; 22207a918edfSAndrew Thompson temp_size = sizeof(udev->bus->scratch[0].data); 22217a918edfSAndrew Thompson 222202ac6454SAndrew Thompson vendor_id = UGETW(udd->idVendor); 222302ac6454SAndrew Thompson product_id = UGETW(udd->idProduct); 222402ac6454SAndrew Thompson 2225c86aead6SAndrew Thompson /* get serial number string */ 22267a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2227c86aead6SAndrew Thompson udev->ddesc.iSerialNumber); 22287a918edfSAndrew Thompson udev->serial = strdup(temp_ptr, M_USB); 222902ac6454SAndrew Thompson 2230c86aead6SAndrew Thompson /* get manufacturer string */ 22317a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2232c86aead6SAndrew Thompson udev->ddesc.iManufacturer); 22337a918edfSAndrew Thompson usb_trim_spaces(temp_ptr); 22347a918edfSAndrew Thompson if (temp_ptr[0] != '\0') 22357a918edfSAndrew Thompson udev->manufacturer = strdup(temp_ptr, M_USB); 2236c86aead6SAndrew Thompson 2237c86aead6SAndrew Thompson /* get product string */ 22387a918edfSAndrew Thompson usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size, 2239c86aead6SAndrew Thompson udev->ddesc.iProduct); 22407a918edfSAndrew Thompson usb_trim_spaces(temp_ptr); 22417a918edfSAndrew Thompson if (temp_ptr[0] != '\0') 22427a918edfSAndrew Thompson udev->product = strdup(temp_ptr, M_USB); 2243c86aead6SAndrew Thompson 2244ed6d949aSAndrew Thompson #ifdef USB_VERBOSE 2245c86aead6SAndrew Thompson if (udev->manufacturer == NULL || udev->product == NULL) { 2246c86aead6SAndrew Thompson for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) { 224702ac6454SAndrew Thompson if (kdp->vendor == vendor_id && 224802ac6454SAndrew Thompson (kdp->product == product_id || 224902ac6454SAndrew Thompson (kdp->flags & USB_KNOWNDEV_NOPROD) != 0)) 225002ac6454SAndrew Thompson break; 225102ac6454SAndrew Thompson } 225202ac6454SAndrew Thompson if (kdp->vendorname != NULL) { 2253c86aead6SAndrew Thompson /* XXX should use pointer to knowndevs string */ 2254c86aead6SAndrew Thompson if (udev->manufacturer == NULL) { 2255c86aead6SAndrew Thompson udev->manufacturer = strdup(kdp->vendorname, 2256c86aead6SAndrew Thompson M_USB); 2257c86aead6SAndrew Thompson } 2258c86aead6SAndrew Thompson if (udev->product == NULL && 2259c86aead6SAndrew Thompson (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) { 2260c86aead6SAndrew Thompson udev->product = strdup(kdp->productname, 2261c86aead6SAndrew Thompson M_USB); 2262c86aead6SAndrew Thompson } 226302ac6454SAndrew Thompson } 226402ac6454SAndrew Thompson } 226502ac6454SAndrew Thompson #endif 2266c86aead6SAndrew Thompson /* Provide default strings if none were found */ 2267c86aead6SAndrew Thompson if (udev->manufacturer == NULL) { 22687a918edfSAndrew Thompson snprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id); 22697a918edfSAndrew Thompson udev->manufacturer = strdup(temp_ptr, M_USB); 227002ac6454SAndrew Thompson } 2271c86aead6SAndrew Thompson if (udev->product == NULL) { 22727a918edfSAndrew Thompson snprintf(temp_ptr, temp_size, "product 0x%04x", product_id); 22737a918edfSAndrew Thompson udev->product = strdup(temp_ptr, M_USB); 227402ac6454SAndrew Thompson } 227502ac6454SAndrew Thompson } 227602ac6454SAndrew Thompson 227702ac6454SAndrew Thompson /* 227802ac6454SAndrew Thompson * Returns: 227902ac6454SAndrew Thompson * See: USB_MODE_XXX 228002ac6454SAndrew Thompson */ 2281f29a0724SAndrew Thompson enum usb_hc_mode 2282a593f6b8SAndrew Thompson usbd_get_mode(struct usb_device *udev) 228302ac6454SAndrew Thompson { 2284f29a0724SAndrew Thompson return (udev->flags.usb_mode); 228502ac6454SAndrew Thompson } 228602ac6454SAndrew Thompson 228702ac6454SAndrew Thompson /* 228802ac6454SAndrew Thompson * Returns: 228902ac6454SAndrew Thompson * See: USB_SPEED_XXX 229002ac6454SAndrew Thompson */ 22918d2dd5ddSAndrew Thompson enum usb_dev_speed 2292a593f6b8SAndrew Thompson usbd_get_speed(struct usb_device *udev) 229302ac6454SAndrew Thompson { 229402ac6454SAndrew Thompson return (udev->speed); 229502ac6454SAndrew Thompson } 229602ac6454SAndrew Thompson 229702ac6454SAndrew Thompson uint32_t 2298a593f6b8SAndrew Thompson usbd_get_isoc_fps(struct usb_device *udev) 229902ac6454SAndrew Thompson { 230002ac6454SAndrew Thompson ; /* indent fix */ 230102ac6454SAndrew Thompson switch (udev->speed) { 230202ac6454SAndrew Thompson case USB_SPEED_LOW: 230302ac6454SAndrew Thompson case USB_SPEED_FULL: 230402ac6454SAndrew Thompson return (1000); 230502ac6454SAndrew Thompson default: 230602ac6454SAndrew Thompson return (8000); 230702ac6454SAndrew Thompson } 230802ac6454SAndrew Thompson } 230902ac6454SAndrew Thompson 2310760bc48eSAndrew Thompson struct usb_device_descriptor * 2311a593f6b8SAndrew Thompson usbd_get_device_descriptor(struct usb_device *udev) 231202ac6454SAndrew Thompson { 231302ac6454SAndrew Thompson if (udev == NULL) 231402ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 231502ac6454SAndrew Thompson return (&udev->ddesc); 231602ac6454SAndrew Thompson } 231702ac6454SAndrew Thompson 2318760bc48eSAndrew Thompson struct usb_config_descriptor * 2319a593f6b8SAndrew Thompson usbd_get_config_descriptor(struct usb_device *udev) 232002ac6454SAndrew Thompson { 232102ac6454SAndrew Thompson if (udev == NULL) 232202ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 232302ac6454SAndrew Thompson return (udev->cdesc); 232402ac6454SAndrew Thompson } 232502ac6454SAndrew Thompson 232602ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2327a593f6b8SAndrew Thompson * usb_test_quirk - test a device for a given quirk 232802ac6454SAndrew Thompson * 232902ac6454SAndrew Thompson * Return values: 233002ac6454SAndrew Thompson * 0: The USB device does not have the given quirk. 233102ac6454SAndrew Thompson * Else: The USB device has the given quirk. 233202ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 233302ac6454SAndrew Thompson uint8_t 2334a593f6b8SAndrew Thompson usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk) 233502ac6454SAndrew Thompson { 233602ac6454SAndrew Thompson uint8_t found; 233702ac6454SAndrew Thompson 2338a593f6b8SAndrew Thompson found = (usb_test_quirk_p) (&uaa->info, quirk); 233902ac6454SAndrew Thompson return (found); 234002ac6454SAndrew Thompson } 234102ac6454SAndrew Thompson 2342760bc48eSAndrew Thompson struct usb_interface_descriptor * 2343a593f6b8SAndrew Thompson usbd_get_interface_descriptor(struct usb_interface *iface) 234402ac6454SAndrew Thompson { 234502ac6454SAndrew Thompson if (iface == NULL) 234602ac6454SAndrew Thompson return (NULL); /* be NULL safe */ 234702ac6454SAndrew Thompson return (iface->idesc); 234802ac6454SAndrew Thompson } 234902ac6454SAndrew Thompson 235002ac6454SAndrew Thompson uint8_t 2351a593f6b8SAndrew Thompson usbd_get_interface_altindex(struct usb_interface *iface) 235202ac6454SAndrew Thompson { 235302ac6454SAndrew Thompson return (iface->alt_index); 235402ac6454SAndrew Thompson } 235502ac6454SAndrew Thompson 235602ac6454SAndrew Thompson uint8_t 2357a593f6b8SAndrew Thompson usbd_get_bus_index(struct usb_device *udev) 235802ac6454SAndrew Thompson { 235902ac6454SAndrew Thompson return ((uint8_t)device_get_unit(udev->bus->bdev)); 236002ac6454SAndrew Thompson } 236102ac6454SAndrew Thompson 236202ac6454SAndrew Thompson uint8_t 2363a593f6b8SAndrew Thompson usbd_get_device_index(struct usb_device *udev) 236402ac6454SAndrew Thompson { 236502ac6454SAndrew Thompson return (udev->device_index); 236602ac6454SAndrew Thompson } 236702ac6454SAndrew Thompson 23688755859aSAndrew Thompson #if USB_HAVE_UGEN 236902ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2370a593f6b8SAndrew Thompson * usb_notify_addq 237102ac6454SAndrew Thompson * 237202ac6454SAndrew Thompson * This function will generate events for dev. 237302ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 23743acd904dSAndrew Thompson #ifndef BURN_BRIDGES 237502ac6454SAndrew Thompson static void 23763acd904dSAndrew Thompson usb_notify_addq_compat(const char *type, struct usb_device *udev) 237702ac6454SAndrew Thompson { 237802ac6454SAndrew Thompson char *data = NULL; 23793acd904dSAndrew Thompson const char *ntype; 238002ac6454SAndrew Thompson struct malloc_type *mt; 238135e0e603SAndrew Thompson const size_t buf_size = 512; 238202ac6454SAndrew Thompson 23833acd904dSAndrew Thompson /* Convert notify type */ 23843acd904dSAndrew Thompson if (strcmp(type, "ATTACH") == 0) 23853acd904dSAndrew Thompson ntype = "+"; 23863acd904dSAndrew Thompson else if (strcmp(type, "DETACH") == 0) 23873acd904dSAndrew Thompson ntype = "-"; 23883acd904dSAndrew Thompson else 23893acd904dSAndrew Thompson return; 23903acd904dSAndrew Thompson 239102ac6454SAndrew Thompson mtx_lock(&malloc_mtx); 239202ac6454SAndrew Thompson mt = malloc_desc2type("bus"); /* XXX M_BUS */ 239302ac6454SAndrew Thompson mtx_unlock(&malloc_mtx); 239402ac6454SAndrew Thompson if (mt == NULL) 239502ac6454SAndrew Thompson return; 239602ac6454SAndrew Thompson 239735e0e603SAndrew Thompson data = malloc(buf_size, mt, M_NOWAIT); 239802ac6454SAndrew Thompson if (data == NULL) 239902ac6454SAndrew Thompson return; 240002ac6454SAndrew Thompson 240102ac6454SAndrew Thompson /* String it all together. */ 240235e0e603SAndrew Thompson snprintf(data, buf_size, 240302ac6454SAndrew Thompson "%s" 2404ee3e3ff5SAndrew Thompson "%s " 240502ac6454SAndrew Thompson "vendor=0x%04x " 240602ac6454SAndrew Thompson "product=0x%04x " 240702ac6454SAndrew Thompson "devclass=0x%02x " 240802ac6454SAndrew Thompson "devsubclass=0x%02x " 240902ac6454SAndrew Thompson "sernum=\"%s\" " 2410bd73b187SAlfred Perlstein "release=0x%04x " 241102ac6454SAndrew Thompson "at " 241202ac6454SAndrew Thompson "port=%u " 241302ac6454SAndrew Thompson "on " 2414ee3e3ff5SAndrew Thompson "%s\n", 24153acd904dSAndrew Thompson ntype, 2416ee3e3ff5SAndrew Thompson udev->ugen_name, 241702ac6454SAndrew Thompson UGETW(udev->ddesc.idVendor), 241802ac6454SAndrew Thompson UGETW(udev->ddesc.idProduct), 241902ac6454SAndrew Thompson udev->ddesc.bDeviceClass, 242002ac6454SAndrew Thompson udev->ddesc.bDeviceSubClass, 2421ae538d85SAndrew Thompson usb_get_serial(udev), 2422bd73b187SAlfred Perlstein UGETW(udev->ddesc.bcdDevice), 242302ac6454SAndrew Thompson udev->port_no, 24248755859aSAndrew Thompson udev->parent_hub != NULL ? 24258755859aSAndrew Thompson udev->parent_hub->ugen_name : 242602ac6454SAndrew Thompson device_get_nameunit(device_get_parent(udev->bus->bdev))); 242762a5f394SAlexander Kabaev 242802ac6454SAndrew Thompson devctl_queue_data(data); 242902ac6454SAndrew Thompson } 24303acd904dSAndrew Thompson #endif 24313acd904dSAndrew Thompson 24323acd904dSAndrew Thompson static void 24333acd904dSAndrew Thompson usb_notify_addq(const char *type, struct usb_device *udev) 24343acd904dSAndrew Thompson { 24353acd904dSAndrew Thompson struct usb_interface *iface; 24363acd904dSAndrew Thompson struct sbuf *sb; 24373acd904dSAndrew Thompson int i; 24383acd904dSAndrew Thompson 24393acd904dSAndrew Thompson #ifndef BURN_BRIDGES 24403acd904dSAndrew Thompson usb_notify_addq_compat(type, udev); 24413acd904dSAndrew Thompson #endif 24423acd904dSAndrew Thompson 24433acd904dSAndrew Thompson /* announce the device */ 24443acd904dSAndrew Thompson sb = sbuf_new_auto(); 24453acd904dSAndrew Thompson sbuf_printf(sb, 24463acd904dSAndrew Thompson "cdev=%s " 24473acd904dSAndrew Thompson "vendor=0x%04x " 24483acd904dSAndrew Thompson "product=0x%04x " 24493acd904dSAndrew Thompson "devclass=0x%02x " 24503acd904dSAndrew Thompson "devsubclass=0x%02x " 24513acd904dSAndrew Thompson "sernum=\"%s\" " 24523acd904dSAndrew Thompson "release=0x%04x " 245366390216SAndrew Thompson "mode=%s " 24543acd904dSAndrew Thompson "port=%u " 24553acd904dSAndrew Thompson "parent=%s\n", 24563acd904dSAndrew Thompson udev->ugen_name, 24573acd904dSAndrew Thompson UGETW(udev->ddesc.idVendor), 24583acd904dSAndrew Thompson UGETW(udev->ddesc.idProduct), 24593acd904dSAndrew Thompson udev->ddesc.bDeviceClass, 24603acd904dSAndrew Thompson udev->ddesc.bDeviceSubClass, 2461ae538d85SAndrew Thompson usb_get_serial(udev), 24623acd904dSAndrew Thompson UGETW(udev->ddesc.bcdDevice), 246366390216SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device", 24643acd904dSAndrew Thompson udev->port_no, 24653acd904dSAndrew Thompson udev->parent_hub != NULL ? 24663acd904dSAndrew Thompson udev->parent_hub->ugen_name : 24673acd904dSAndrew Thompson device_get_nameunit(device_get_parent(udev->bus->bdev))); 24683acd904dSAndrew Thompson sbuf_finish(sb); 24693acd904dSAndrew Thompson devctl_notify("USB", "DEVICE", type, sbuf_data(sb)); 24703acd904dSAndrew Thompson sbuf_delete(sb); 24713acd904dSAndrew Thompson 24723acd904dSAndrew Thompson /* announce each interface */ 24733acd904dSAndrew Thompson for (i = 0; i < USB_IFACE_MAX; i++) { 24743acd904dSAndrew Thompson iface = usbd_get_iface(udev, i); 24753acd904dSAndrew Thompson if (iface == NULL) 24763acd904dSAndrew Thompson break; /* end of interfaces */ 24773acd904dSAndrew Thompson if (iface->idesc == NULL) 24783acd904dSAndrew Thompson continue; /* no interface descriptor */ 24793acd904dSAndrew Thompson 24803acd904dSAndrew Thompson sb = sbuf_new_auto(); 24813acd904dSAndrew Thompson sbuf_printf(sb, 24823acd904dSAndrew Thompson "cdev=%s " 24833acd904dSAndrew Thompson "vendor=0x%04x " 24843acd904dSAndrew Thompson "product=0x%04x " 24853acd904dSAndrew Thompson "devclass=0x%02x " 24863acd904dSAndrew Thompson "devsubclass=0x%02x " 24873acd904dSAndrew Thompson "sernum=\"%s\" " 24883acd904dSAndrew Thompson "release=0x%04x " 248966390216SAndrew Thompson "mode=%s " 24903acd904dSAndrew Thompson "interface=%d " 24913acd904dSAndrew Thompson "endpoints=%d " 24923acd904dSAndrew Thompson "intclass=0x%02x " 24933acd904dSAndrew Thompson "intsubclass=0x%02x " 24943acd904dSAndrew Thompson "intprotocol=0x%02x\n", 24953acd904dSAndrew Thompson udev->ugen_name, 24963acd904dSAndrew Thompson UGETW(udev->ddesc.idVendor), 24973acd904dSAndrew Thompson UGETW(udev->ddesc.idProduct), 24983acd904dSAndrew Thompson udev->ddesc.bDeviceClass, 24993acd904dSAndrew Thompson udev->ddesc.bDeviceSubClass, 2500ae538d85SAndrew Thompson usb_get_serial(udev), 25013acd904dSAndrew Thompson UGETW(udev->ddesc.bcdDevice), 250266390216SAndrew Thompson (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device", 25033acd904dSAndrew Thompson iface->idesc->bInterfaceNumber, 25043acd904dSAndrew Thompson iface->idesc->bNumEndpoints, 25053acd904dSAndrew Thompson iface->idesc->bInterfaceClass, 25063acd904dSAndrew Thompson iface->idesc->bInterfaceSubClass, 25073acd904dSAndrew Thompson iface->idesc->bInterfaceProtocol); 25083acd904dSAndrew Thompson sbuf_finish(sb); 25093acd904dSAndrew Thompson devctl_notify("USB", "INTERFACE", type, sbuf_data(sb)); 25103acd904dSAndrew Thompson sbuf_delete(sb); 25113acd904dSAndrew Thompson } 25123acd904dSAndrew Thompson } 251302ac6454SAndrew Thompson 251402ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2515a593f6b8SAndrew Thompson * usb_fifo_free_wrap 251602ac6454SAndrew Thompson * 251702ac6454SAndrew Thompson * This function will free the FIFOs. 251802ac6454SAndrew Thompson * 2519bdd41206SAndrew Thompson * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag 2520bdd41206SAndrew Thompson * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free 2521bdd41206SAndrew Thompson * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and 2522bdd41206SAndrew Thompson * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non 2523bdd41206SAndrew Thompson * control endpoint FIFOs. If "iface_index" is not set to 2524bdd41206SAndrew Thompson * "USB_IFACE_INDEX_ANY" the flag has no effect. 252502ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 252602ac6454SAndrew Thompson static void 2527a593f6b8SAndrew Thompson usb_fifo_free_wrap(struct usb_device *udev, 252802ac6454SAndrew Thompson uint8_t iface_index, uint8_t flag) 252902ac6454SAndrew Thompson { 2530760bc48eSAndrew Thompson struct usb_fifo *f; 253102ac6454SAndrew Thompson uint16_t i; 253202ac6454SAndrew Thompson 253302ac6454SAndrew Thompson /* 253402ac6454SAndrew Thompson * Free any USB FIFOs on the given interface: 253502ac6454SAndrew Thompson */ 253602ac6454SAndrew Thompson for (i = 0; i != USB_FIFO_MAX; i++) { 253702ac6454SAndrew Thompson f = udev->fifo[i]; 253802ac6454SAndrew Thompson if (f == NULL) { 253902ac6454SAndrew Thompson continue; 254002ac6454SAndrew Thompson } 254102ac6454SAndrew Thompson /* Check if the interface index matches */ 254202ac6454SAndrew Thompson if (iface_index == f->iface_index) { 2543a593f6b8SAndrew Thompson if (f->methods != &usb_ugen_methods) { 254402ac6454SAndrew Thompson /* 254502ac6454SAndrew Thompson * Don't free any non-generic FIFOs in 254602ac6454SAndrew Thompson * this case. 254702ac6454SAndrew Thompson */ 254802ac6454SAndrew Thompson continue; 254902ac6454SAndrew Thompson } 255002ac6454SAndrew Thompson if ((f->dev_ep_index == 0) && 255102ac6454SAndrew Thompson (f->fs_xfer == NULL)) { 255202ac6454SAndrew Thompson /* no need to free this FIFO */ 255302ac6454SAndrew Thompson continue; 255402ac6454SAndrew Thompson } 255502ac6454SAndrew Thompson } else if (iface_index == USB_IFACE_INDEX_ANY) { 2556a593f6b8SAndrew Thompson if ((f->methods == &usb_ugen_methods) && 2557bdd41206SAndrew Thompson (f->dev_ep_index == 0) && 2558bdd41206SAndrew Thompson (!(flag & USB_UNCFG_FLAG_FREE_EP0)) && 255902ac6454SAndrew Thompson (f->fs_xfer == NULL)) { 256002ac6454SAndrew Thompson /* no need to free this FIFO */ 256102ac6454SAndrew Thompson continue; 256202ac6454SAndrew Thompson } 256302ac6454SAndrew Thompson } else { 256402ac6454SAndrew Thompson /* no need to free this FIFO */ 256502ac6454SAndrew Thompson continue; 256602ac6454SAndrew Thompson } 256702ac6454SAndrew Thompson /* free this FIFO */ 2568a593f6b8SAndrew Thompson usb_fifo_free(f); 256902ac6454SAndrew Thompson } 257002ac6454SAndrew Thompson } 25710f6e8f93SAndrew Thompson #endif 257202ac6454SAndrew Thompson 257302ac6454SAndrew Thompson /*------------------------------------------------------------------------* 2574a593f6b8SAndrew Thompson * usb_peer_can_wakeup 257502ac6454SAndrew Thompson * 257602ac6454SAndrew Thompson * Return values: 257702ac6454SAndrew Thompson * 0: Peer cannot do resume signalling. 257802ac6454SAndrew Thompson * Else: Peer can do resume signalling. 257902ac6454SAndrew Thompson *------------------------------------------------------------------------*/ 258002ac6454SAndrew Thompson uint8_t 2581a593f6b8SAndrew Thompson usb_peer_can_wakeup(struct usb_device *udev) 258202ac6454SAndrew Thompson { 2583760bc48eSAndrew Thompson const struct usb_config_descriptor *cdp; 258402ac6454SAndrew Thompson 258502ac6454SAndrew Thompson cdp = udev->cdesc; 2586f29a0724SAndrew Thompson if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) { 258702ac6454SAndrew Thompson return (cdp->bmAttributes & UC_REMOTE_WAKEUP); 258802ac6454SAndrew Thompson } 258902ac6454SAndrew Thompson return (0); /* not supported */ 259002ac6454SAndrew Thompson } 2591bd216778SAndrew Thompson 2592bd216778SAndrew Thompson void 2593a593f6b8SAndrew Thompson usb_set_device_state(struct usb_device *udev, enum usb_dev_state state) 2594bd216778SAndrew Thompson { 2595bd216778SAndrew Thompson 2596bd216778SAndrew Thompson KASSERT(state < USB_STATE_MAX, ("invalid udev state")); 2597bd216778SAndrew Thompson 2598bd216778SAndrew Thompson DPRINTF("udev %p state %s -> %s\n", udev, 2599a593f6b8SAndrew Thompson usb_statestr(udev->state), usb_statestr(state)); 2600bd216778SAndrew Thompson udev->state = state; 2601bd216778SAndrew Thompson } 2602bd216778SAndrew Thompson 2603ec8f3127SAndrew Thompson uint8_t 2604a593f6b8SAndrew Thompson usbd_device_attached(struct usb_device *udev) 2605bd216778SAndrew Thompson { 2606bd216778SAndrew Thompson return (udev->state > USB_STATE_DETACHED); 2607bd216778SAndrew Thompson } 2608cb18f7d1SAlfred Perlstein 2609cb18f7d1SAlfred Perlstein /* The following function locks enumerating the given USB device. */ 2610cb18f7d1SAlfred Perlstein 2611cb18f7d1SAlfred Perlstein void 2612cb18f7d1SAlfred Perlstein usbd_enum_lock(struct usb_device *udev) 2613cb18f7d1SAlfred Perlstein { 261491cd9240SAndrew Thompson sx_xlock(&udev->enum_sx); 26152df1e9a6SAndrew Thompson sx_xlock(&udev->sr_sx); 2616cb18f7d1SAlfred Perlstein /* 2617cb18f7d1SAlfred Perlstein * NEWBUS LOCK NOTE: We should check if any parent SX locks 2618cb18f7d1SAlfred Perlstein * are locked before locking Giant. Else the lock can be 2619cb18f7d1SAlfred Perlstein * locked multiple times. 2620cb18f7d1SAlfred Perlstein */ 2621cb18f7d1SAlfred Perlstein mtx_lock(&Giant); 2622cb18f7d1SAlfred Perlstein } 2623cb18f7d1SAlfred Perlstein 2624cb18f7d1SAlfred Perlstein /* The following function unlocks enumerating the given USB device. */ 2625cb18f7d1SAlfred Perlstein 2626cb18f7d1SAlfred Perlstein void 2627cb18f7d1SAlfred Perlstein usbd_enum_unlock(struct usb_device *udev) 2628cb18f7d1SAlfred Perlstein { 2629cb18f7d1SAlfred Perlstein mtx_unlock(&Giant); 263091cd9240SAndrew Thompson sx_xunlock(&udev->enum_sx); 26312df1e9a6SAndrew Thompson sx_xunlock(&udev->sr_sx); 26322df1e9a6SAndrew Thompson } 26332df1e9a6SAndrew Thompson 26342df1e9a6SAndrew Thompson /* The following function locks suspend and resume. */ 26352df1e9a6SAndrew Thompson 26362df1e9a6SAndrew Thompson void 26372df1e9a6SAndrew Thompson usbd_sr_lock(struct usb_device *udev) 26382df1e9a6SAndrew Thompson { 26392df1e9a6SAndrew Thompson sx_xlock(&udev->sr_sx); 26402df1e9a6SAndrew Thompson /* 26412df1e9a6SAndrew Thompson * NEWBUS LOCK NOTE: We should check if any parent SX locks 26422df1e9a6SAndrew Thompson * are locked before locking Giant. Else the lock can be 26432df1e9a6SAndrew Thompson * locked multiple times. 26442df1e9a6SAndrew Thompson */ 26452df1e9a6SAndrew Thompson mtx_lock(&Giant); 26462df1e9a6SAndrew Thompson } 26472df1e9a6SAndrew Thompson 26482df1e9a6SAndrew Thompson /* The following function unlocks suspend and resume. */ 26492df1e9a6SAndrew Thompson 26502df1e9a6SAndrew Thompson void 26512df1e9a6SAndrew Thompson usbd_sr_unlock(struct usb_device *udev) 26522df1e9a6SAndrew Thompson { 26532df1e9a6SAndrew Thompson mtx_unlock(&Giant); 26542df1e9a6SAndrew Thompson sx_xunlock(&udev->sr_sx); 2655cb18f7d1SAlfred Perlstein } 2656cb18f7d1SAlfred Perlstein 2657cb18f7d1SAlfred Perlstein /* 2658cb18f7d1SAlfred Perlstein * The following function checks the enumerating lock for the given 2659cb18f7d1SAlfred Perlstein * USB device. 2660cb18f7d1SAlfred Perlstein */ 2661cb18f7d1SAlfred Perlstein 2662cb18f7d1SAlfred Perlstein uint8_t 2663cb18f7d1SAlfred Perlstein usbd_enum_is_locked(struct usb_device *udev) 2664cb18f7d1SAlfred Perlstein { 266591cd9240SAndrew Thompson return (sx_xlocked(&udev->enum_sx)); 2666cb18f7d1SAlfred Perlstein } 2667