/* $NetBSD: usb_subr.c,v 1.7 1998/08/02 22:30:53 augustss Exp $ */ /* * Copyright (c) 1998 The NetBSD Foundation, Inc. * All rights reserved. * * Author: Lennart Augustsson * Carlstedt Research & Technology * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. All advertising materials mentioning features or use of this software * must display the following acknowledgement: * This product includes software developed by the NetBSD * Foundation, Inc. and its contributors. * 4. Neither the name of The NetBSD Foundation nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include "opt_usbverbose.h" #ifdef USB_DEBUG #define DPRINTF(x) if (usbdebug) printf x #define DPRINTFN(n,x) if (usbdebug>(n)) printf x extern int usbdebug; #else #define DPRINTF(x) #define DPRINTFN(n,x) #endif static usbd_status usbd_set_config __P((usbd_device_handle, int)); char *usbd_get_string __P((usbd_device_handle, int, char *)); usbd_status usbd_get_desc __P((usbd_device_handle dev, int type, int index, int len, void *desc)); int usbd_getnewaddr __P((usbd_bus_handle bus)); int usbd_print __P((void *aux, const char *pnp)); int usbd_submatch __P((struct device *, struct cfdata *cf, void *)); usb_interface_descriptor_t *usbd_find_idesc __P((usb_config_descriptor_t *cd, int ino, int ano)); usbd_status usbd_fill_iface_data __P((usbd_device_handle dev, int i, int a)); void usbd_free_iface_data __P((usbd_device_handle dev, int ifcno)); void usbd_kill_pipe __P((usbd_pipe_handle)); #ifdef USBVERBOSE typedef u_int16_t usb_vendor_id_t; typedef u_int16_t usb_product_id_t; /* * Descriptions of of known vendors and devices ("products"). */ struct usb_knowndev { usb_vendor_id_t vendor; usb_product_id_t product; int flags; char *vendorname, *productname; }; #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */ #include #endif /* USBVERBOSE */ char * usbd_get_string(dev, si, buf) usbd_device_handle dev; int si; char *buf; { int swap = dev->quirks->uq_flags & UQ_SWAP_UNICODE; usb_device_request_t req; usb_string_descriptor_t us; char *s; int i, n; u_int16_t c; usbd_status r; if (si == 0) return 0; req.bmRequestType = UT_READ_DEVICE; req.bRequest = UR_GET_DESCRIPTOR; USETW2(req.wValue, UDESC_STRING, si); USETW(req.wIndex, 0); USETW(req.wLength, 1); /* only size byte first */ r = usbd_do_request(dev, &req, &us); if (r != USBD_NORMAL_COMPLETION) return 0; USETW(req.wLength, us.bLength); /* the whole string */ r = usbd_do_request(dev, &req, &us); if (r != USBD_NORMAL_COMPLETION) return 0; s = buf; n = us.bLength / 2 - 1; for (i = 0; i < n; i++) { c = UGETW(us.bString[i]); /* Convert from Unicode, handle buggy strings. */ if ((c & 0xff00) == 0) *s++ = c; else if ((c & 0x00ff) == 0 && swap) *s++ = c >> 8; else *s++ = '?'; } *s++ = 0; return buf; } void usbd_devinfo_vp(dev, v, p) usbd_device_handle dev; char *v, *p; { usb_device_descriptor_t *udd = &dev->ddesc; char *vendor = 0, *product = 0; #ifdef USBVERBOSE struct usb_knowndev *kdp; #endif vendor = usbd_get_string(dev, udd->iManufacturer, v); product = usbd_get_string(dev, udd->iProduct, p); #ifdef USBVERBOSE if (!vendor) { for(kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) { if (kdp->vendor == UGETW(udd->idVendor) && (kdp->product == UGETW(udd->idProduct) || (kdp->flags & USB_KNOWNDEV_NOPROD) != 0)) break; } if (kdp->vendorname == NULL) vendor = product = NULL; else { vendor = kdp->vendorname; product = (kdp->flags & USB_KNOWNDEV_NOPROD) == 0 ? kdp->productname : NULL; } } #endif if (vendor) strcpy(v, vendor); else sprintf(v, "vendor 0x%04x", UGETW(udd->idVendor)); if (product) strcpy(p, product); else sprintf(p, "product 0x%04x", UGETW(udd->idProduct)); } int usbd_printBCD(cp, bcd) char *cp; int bcd; { return (sprintf(cp, "%x.%02x", bcd >> 8, bcd & 0xff)); } void usbd_devinfo(dev, showclass, cp) usbd_device_handle dev; int showclass; char *cp; { usb_device_descriptor_t *udd = &dev->ddesc; char vendor[USB_MAX_STRING_LEN]; char product[USB_MAX_STRING_LEN]; int bcdDevice, bcdUSB; usbd_devinfo_vp(dev, vendor, product); cp += sprintf(cp, "%s", vendor); cp += sprintf(cp, " %s", product); if (showclass) cp += sprintf(cp, " (class %d/%d)", udd->bDeviceClass, udd->bDeviceSubClass); bcdUSB = UGETW(udd->bcdUSB); bcdDevice = UGETW(udd->bcdDevice); cp += sprintf(cp, " (rev "); cp += usbd_printBCD(cp, bcdUSB); *cp++ = '/'; cp += usbd_printBCD(cp, bcdDevice); *cp++ = ')'; cp += sprintf(cp, " (addr %d)", dev->address); } /* Delay for a certain number of ms */ void usbd_delay_ms(bus, ms) usbd_bus_handle bus; int ms; { /* Wait at least two clock ticks so we know the time has passed. */ if (bus->use_polling) delay((ms+1) * 1000); else tsleep(&ms, PRIBIO, "usbdly", (ms*hz+999)/1000 + 1); } usbd_status usbd_reset_port(dev, port, ps) usbd_device_handle dev; int port; usb_port_status_t *ps; { usb_device_request_t req; usbd_status r; int n; req.bmRequestType = UT_WRITE_CLASS_OTHER; req.bRequest = UR_SET_FEATURE; USETW(req.wValue, UHF_PORT_RESET); USETW(req.wIndex, port); USETW(req.wLength, 0); r = usbd_do_request(dev, &req, 0); DPRINTFN(1,("usbd_reset_port: port %d reset done, error=%d\n", port, r)); if (r != USBD_NORMAL_COMPLETION) return (r); n = 10; do { /* Wait for device to recover from reset. */ usbd_delay_ms(dev->bus, USB_PORT_RESET_DELAY); r = usbd_get_port_status(dev, port, ps); if (r != USBD_NORMAL_COMPLETION) { DPRINTF(("usbd_reset_port: get status failed %d\n",r)); return (r); } } while ((UGETW(ps->wPortChange) & UPS_C_PORT_RESET) == 0 && --n > 0); if (n == 0) { printf("usbd_reset_port: timeout\n"); return (USBD_IOERROR); } r = usbd_clear_port_feature(dev, port, UHF_C_PORT_RESET); #ifdef USB_DEBUG if (r != USBD_NORMAL_COMPLETION) DPRINTF(("usbd_reset_port: clear port feature failed %d\n",r)); #endif return (r); } usb_interface_descriptor_t * usbd_find_idesc(cd, ino, ano) usb_config_descriptor_t *cd; int ino; int ano; { char *p = (char *)cd; char *end = p + UGETW(cd->wTotalLength); usb_interface_descriptor_t *d; for (; p < end; p += d->bLength) { d = (usb_interface_descriptor_t *)p; if (p + d->bLength <= end && d->bDescriptorType == UDESC_INTERFACE && d->bInterfaceNumber == ino && d->bAlternateSetting == ano) return (d); } return (0); } usbd_status usbd_fill_iface_data(dev, ino, ano) usbd_device_handle dev; int ino; int ano; { usbd_interface_handle ifc = &dev->ifaces[ino]; usb_endpoint_descriptor_t *ed; char *p, *end; int endpt, nendpt; usbd_status r; DPRINTFN(5,("usbd_fill_iface_data: ino=%d ano=%d\n", ino, ano)); ifc->device = dev; ifc->state = USBD_INTERFACE_ACTIVE; ifc->idesc = usbd_find_idesc(dev->cdesc, ino, ano); if (ifc->idesc == 0) return (USBD_INVAL); nendpt = ifc->idesc->bNumEndpoints; DPRINTFN(10,("usbd_fill_iface_data: found idesc n=%d\n", nendpt)); if (nendpt != 0) { ifc->endpoints = malloc(nendpt * sizeof(struct usbd_endpoint), M_USB, M_NOWAIT); if (ifc->endpoints == 0) return (USBD_NOMEM); } else ifc->endpoints = 0; ifc->priv = 0; p = (char *)ifc->idesc + ifc->idesc->bLength; end = (char *)dev->cdesc + UGETW(dev->cdesc->wTotalLength); for (endpt = 0; endpt < nendpt; endpt++) { DPRINTFN(10,("usbd_fill_iface_data: endpt=%d\n", endpt)); for (; p < end; p += ed->bLength) { ed = (usb_endpoint_descriptor_t *)p; DPRINTFN(10,("usbd_fill_iface_data: p=%p end=%p len=%d type=%d\n", p, end, ed->bLength, ed->bDescriptorType)); if (p + ed->bLength <= end && ed->bDescriptorType == UDESC_ENDPOINT) goto found; if (ed->bDescriptorType == UDESC_INTERFACE) break; } r = USBD_INVAL; goto bad; found: ifc->endpoints[endpt].edesc = ed; ifc->endpoints[endpt].state = USBD_ENDPOINT_ACTIVE; ifc->endpoints[endpt].refcnt = 0; ifc->endpoints[endpt].toggle = 0; } LIST_INIT(&ifc->pipes); return (USBD_NORMAL_COMPLETION); bad: free(ifc->endpoints, M_USB); return (r); } void usbd_free_iface_data(dev, ifcno) usbd_device_handle dev; int ifcno; { usbd_interface_handle ifc = &dev->ifaces[ifcno]; if (ifc->endpoints) free(ifc->endpoints, M_USB); } static usbd_status usbd_set_config(dev, conf) usbd_device_handle dev; int conf; { usb_device_request_t req; req.bmRequestType = UT_WRITE_DEVICE; req.bRequest = UR_SET_CONFIG; USETW(req.wValue, conf); USETW(req.wIndex, 0); USETW(req.wLength, 0); return (usbd_do_request(dev, &req, 0)); } usbd_status usbd_set_config_no(dev, no, msg) usbd_device_handle dev; int no; int msg; { usb_status_t ds; usb_hub_status_t hs; usb_config_descriptor_t cd, *cdp; usbd_status r; int ifcno, nifc, len, selfpowered, power; DPRINTFN(5, ("usbd_set_config_no: dev=%p no=%d\n", dev, no)); /* XXX check that all interfaces are idle */ if (dev->config != 0) { DPRINTF(("usbd_set_config_no: free old config\n")); /* Free all configuration data structures. */ nifc = dev->cdesc->bNumInterface; for (ifcno = 0; ifcno < nifc; ifcno++) usbd_free_iface_data(dev, ifcno); free(dev->ifaces, M_USB); free(dev->cdesc, M_USB); dev->ifaces = 0; dev->cdesc = 0; dev->config = 0; dev->state = USBD_DEVICE_ADDRESSED; } /* Figure out what config number to use. */ r = usbd_get_config_desc(dev, no, &cd); if (r != USBD_NORMAL_COMPLETION) return (r); len = UGETW(cd.wTotalLength); cdp = malloc(len, M_USB, M_NOWAIT); if (cdp == 0) return (USBD_NOMEM); r = usbd_get_desc(dev, UDESC_CONFIG, no, len, cdp); if (r != USBD_NORMAL_COMPLETION) goto bad; selfpowered = 0; if (cdp->bmAttributes & UC_SELF_POWERED) { /* May be self powered. */ if (cdp->bmAttributes & UC_BUS_POWERED) { /* Must ask device. */ if (dev->quirks->uq_flags & UQ_HUB_POWER) { /* Buggy hub, use hub descriptor. */ r = usbd_get_hub_status(dev, &hs); if (r == USBD_NORMAL_COMPLETION && !(UGETW(hs.wHubStatus) & UHS_LOCAL_POWER)) selfpowered = 1; } else { r = usbd_get_device_status(dev, &ds); if (r == USBD_NORMAL_COMPLETION && (UGETW(ds.wStatus) & UDS_SELF_POWERED)) selfpowered = 1; } DPRINTF(("usbd_set_config_no: status=0x%04x, error=%d\n", UGETW(ds.wStatus), r)); } else selfpowered = 1; } DPRINTF(("usbd_set_config_no: (addr %d) attr=0x%02x, selfpowered=%d, power=%d, powerquirk=%x\n", dev->address, cdp->bmAttributes, selfpowered, cdp->bMaxPower * 2, dev->quirks->uq_flags & UQ_HUB_POWER)); #ifdef USB_DEBUG if (!dev->powersrc) { printf("usbd_set_config_no: No power source?\n"); return (EIO); } #endif power = cdp->bMaxPower * 2; if (power > dev->powersrc->power) { /* XXX print nicer message. */ if (msg) printf("%s: device addr %d (config %d) exceeds power budget, %d mA > %d mA\n", dev->bus->bdev.dv_xname, dev->address, cdp->bConfigurationValue, power, dev->powersrc->power); r = USBD_NO_POWER; goto bad; } dev->power = power; dev->self_powered = selfpowered; r = usbd_set_config(dev, cdp->bConfigurationValue); if (r != USBD_NORMAL_COMPLETION) { DPRINTF(("usbd_set_config_no: setting config=%d failed, error=%d\n", cdp->bConfigurationValue, r)); goto bad; } DPRINTF(("usbd_set_config_no: setting new config %d\n", cdp->bConfigurationValue)); nifc = cdp->bNumInterface; dev->ifaces = malloc(nifc * sizeof(struct usbd_interface), M_USB, M_NOWAIT); if (dev->ifaces == 0) { r = USBD_NOMEM; goto bad; } DPRINTFN(5,("usbd_set_config_no: dev=%p cdesc=%p\n", dev, cdp)); dev->cdesc = cdp; dev->config = cdp->bConfigurationValue; dev->state = USBD_DEVICE_CONFIGURED; for (ifcno = 0; ifcno < nifc; ifcno++) { r = usbd_fill_iface_data(dev, ifcno, 0); if (r != USBD_NORMAL_COMPLETION) { while (--ifcno >= 0) usbd_free_iface_data(dev, ifcno); goto bad; } } return (USBD_NORMAL_COMPLETION); bad: free(cdp, M_USB); return (r); } /* XXX add function for alternate settings */ usbd_status usbd_setup_pipe(dev, iface, ep, pipe) usbd_device_handle dev; usbd_interface_handle iface; struct usbd_endpoint *ep; usbd_pipe_handle *pipe; { usbd_pipe_handle p; usbd_status r; DPRINTFN(1,("usbd_setup_pipe: dev=%p iface=%p ep=%p pipe=%p\n", dev, iface, ep, pipe)); p = malloc(dev->bus->pipe_size, M_USB, M_NOWAIT); if (p == 0) return (USBD_NOMEM); p->device = dev; p->iface = iface; p->state = USBD_PIPE_ACTIVE; p->endpoint = ep; ep->refcnt++; p->refcnt = 1; p->intrreqh = 0; p->running = 0; SIMPLEQ_INIT(&p->queue); r = dev->bus->open_pipe(p); if (r != USBD_NORMAL_COMPLETION) { DPRINTF(("usbd_setup_pipe: endpoint=%d failed, error=%d\n", ep->edesc->bEndpointAddress, r)); free(p, M_USB); return (r); } *pipe = p; return (USBD_NORMAL_COMPLETION); } /* Abort the device control pipe. */ void usbd_kill_pipe(pipe) usbd_pipe_handle pipe; { pipe->methods->close(pipe); pipe->endpoint->refcnt--; free(pipe, M_USB); } int usbd_getnewaddr(bus) usbd_bus_handle bus; { int i; for (i = 1; i < USB_MAX_DEVICES; i++) if (bus->devices[i] == 0) return (i); return (-1); } /* * Called when a new device has been put in the powered state, * but not yet in the addressed state. * Get initial descriptor, set the address, get full descriptor, * and attach a driver. */ usbd_status usbd_new_device(parent, bus, depth, lowspeed, port, up) struct device *parent; usbd_bus_handle bus; int depth; int lowspeed; int port; struct usbd_port *up; { usbd_device_handle dev; usb_device_descriptor_t *d; usbd_status r; struct usb_attach_arg uaa; int addr; int found, i, confi; DPRINTF(("usbd_new_device bus=%p depth=%d lowspeed=%d\n", bus, depth, lowspeed)); addr = usbd_getnewaddr(bus); if (addr < 0) { printf("%s: No free USB addresses, new device ignored.\n", bus->bdev.dv_xname); return (USBD_NO_ADDR); } dev = malloc(sizeof *dev, M_USB, M_NOWAIT); if (dev == 0) return (USBD_NOMEM); memset(dev, 0, sizeof(*dev)); dev->bus = bus; /* Set up default endpoint handle. */ dev->def_ep.edesc = &dev->def_ep_desc; dev->def_ep.state = USBD_ENDPOINT_ACTIVE; dev->def_ep.refcnt = 0; dev->def_ep.toggle = 0; /* XXX */ /* Set up default endpoint descriptor. */ dev->def_ep_desc.bLength = USB_ENDPOINT_DESCRIPTOR_SIZE; dev->def_ep_desc.bDescriptorType = UDESC_ENDPOINT; dev->def_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT; dev->def_ep_desc.bmAttributes = UE_CONTROL; USETW(dev->def_ep_desc.wMaxPacketSize, USB_MAX_IPACKET); dev->def_ep_desc.bInterval = 0; dev->state = USBD_DEVICE_DEFAULT; dev->quirks = &usbd_no_quirk; dev->address = USB_START_ADDR; dev->ddesc.bMaxPacketSize = 0; dev->lowspeed = lowspeed != 0; dev->depth = depth; dev->powersrc = up; /* Establish the the default pipe. */ r = usbd_setup_pipe(dev, 0, &dev->def_ep, &dev->default_pipe); if (r != USBD_NORMAL_COMPLETION) goto bad1; up->device = dev; d = &dev->ddesc; /* Try a few times in case the device is slow (i.e. outside specs.) */ for (i = 0; i < 5; i++) { /* Get the first 8 bytes of the device descriptor. */ r = usbd_get_desc(dev, UDESC_DEVICE, 0, USB_MAX_IPACKET, d); if (r == USBD_NORMAL_COMPLETION) break; usbd_delay_ms(dev->bus, 200); } if (r != USBD_NORMAL_COMPLETION) { DPRINTFN(-1, ("usbd_new_device: addr=%d, getting first desc failed\n", addr)); goto bad; } DPRINTF(("usbd_new_device: adding unit addr=%d, rev=%02x, class=%d, subclass=%d, protocol=%d, maxpacket=%d, ls=%d\n", addr, UGETW(d->bcdUSB), d->bDeviceClass, d->bDeviceSubClass, d->bDeviceProtocol, d->bMaxPacketSize, dev->lowspeed)); USETW(dev->def_ep_desc.wMaxPacketSize, d->bMaxPacketSize); /* Get the full device descriptor. */ r = usbd_get_device_desc(dev, d); if (r != USBD_NORMAL_COMPLETION) { DPRINTFN(-1, ("usbd_new_device: addr=%d, getting full desc failed\n", addr)); goto bad; } /* Figure out what's wrong with this device. */ dev->quirks = usbd_find_quirk(d); /* Set the address */ r = usbd_set_address(dev, addr); if (r != USBD_NORMAL_COMPLETION) { DPRINTFN(-1,("usb_new_device: set address %d failed\n",addr)); r = USBD_SET_ADDR_FAILED; goto bad; } dev->address = addr; /* New device address now */ dev->state = USBD_DEVICE_ADDRESSED; bus->devices[addr] = dev; /* Assume 100mA bus powered for now. Changed when configured. */ dev->power = USB_MIN_POWER; dev->self_powered = 0; DPRINTF(("usbd_new_device: new dev (addr %d), dev=%p, parent=%p\n", addr, dev, parent)); uaa.device = dev; uaa.iface = 0; uaa.usegeneric = 0; uaa.port = port; /* First try with device specific drivers. */ if (config_found_sm(parent, &uaa, usbd_print, usbd_submatch) != 0) return (USBD_NORMAL_COMPLETION); DPRINTF(("usbd_new_device: no device driver found\n")); /* Next try with interface drivers. */ for (confi = 0; confi < d->bNumConfigurations; confi++) { r = usbd_set_config_no(dev, confi, 1); if (r != USBD_NORMAL_COMPLETION) { printf("%s: set config at addr %d failed, error=%d\n", parent->dv_xname, addr, r); goto bad; } for (found = i = 0; i < dev->cdesc->bNumInterface; i++) { uaa.iface = &dev->ifaces[i]; if (config_found_sm(parent, &uaa, usbd_print, usbd_submatch)) found++; } if (found != 0) return (USBD_NORMAL_COMPLETION); } /* No interfaces were attach in any of the configurations. */ if (d->bNumConfigurations > 0) usbd_set_config_no(dev, 0, 0); DPRINTF(("usbd_new_device: no interface drivers found\n")); /* Finally try the generic driver. */ uaa.iface = 0; uaa.usegeneric = 1; if (config_found_sm(parent, &uaa, usbd_print, usbd_submatch) != 0) return (USBD_NORMAL_COMPLETION); DPRINTF(("usbd_new_device: generic attach failed\n")); return (USBD_NORMAL_COMPLETION); bad: usbd_kill_pipe(dev->default_pipe); bad1: up->device = 0; bus->devices[addr] = 0; free(dev, M_USB); return (r); } int usbd_print(aux, pnp) void *aux; const char *pnp; { struct usb_attach_arg *uaa = aux; char devinfo[1024]; DPRINTFN(15, ("usbd_print dev=%p\n", uaa->device)); if (pnp) { if (!uaa->usegeneric) return (QUIET); usbd_devinfo(uaa->device, 1, devinfo); printf("%s at %s", devinfo, pnp); } if (uaa->port != 0) printf(" port %d", uaa->port); return (UNCONF); } int usbd_submatch(parent, cf, aux) struct device *parent; struct cfdata *cf; void *aux; { struct usb_attach_arg *uaa = aux; if (uaa->port != 0 && cf->uhubcf_port != UHUB_UNK_PORT && cf->uhubcf_port != uaa->port) return 0; return ((*cf->cf_attach->ca_match)(parent, cf, aux)); }