/* ChibiOS - Copyright (C) 2006..2017 Giovanni Di Sirio Copyright (C) 2015..2019 Diego Ismirlian, (dismirlian(at)google's mail) Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ #include "hal.h" #if HAL_USE_USBH #include "usbh/internal.h" #include "usbh/dev/hub.h" #include #define _USBH_DEBUG_HELPER_ENABLE_TRACE USBH_DEBUG_ENABLE_TRACE #define _USBH_DEBUG_HELPER_ENABLE_INFO USBH_DEBUG_ENABLE_INFO #define _USBH_DEBUG_HELPER_ENABLE_WARNINGS USBH_DEBUG_ENABLE_WARNINGS #define _USBH_DEBUG_HELPER_ENABLE_ERRORS USBH_DEBUG_ENABLE_ERRORS #include "usbh/debug_helpers.h" #if USBH_DEBUG_ENABLE && !USBH_DEBUG_MULTI_HOST /* debug */ struct usbh_debug_helper usbh_debug; #endif static void _classdriver_process_device(usbh_device_t *dev); static bool _classdriver_load(usbh_device_t *dev, uint8_t *descbuff, uint16_t rem); #if HAL_USBH_USE_ADDITIONAL_CLASS_DRIVERS #include "usbh_additional_class_drivers.h" #ifndef HAL_USBH_ADDITIONAL_CLASS_DRIVERS #error "Must define HAL_USBH_ADDITIONAL_CLASS_DRIVERS" #endif #endif /*===========================================================================*/ /* Checks. */ /*===========================================================================*/ static inline void _check_dev(usbh_device_t *dev) { osalDbgCheck(dev); //TODO: add more checks. } static inline void _check_ep(usbh_ep_t *ep) { osalDbgCheck(ep != 0); _check_dev(ep->device); osalDbgCheck(ep->type <= 3); //TODO: add more checks. } static inline void _check_urb(usbh_urb_t *urb) { osalDbgCheck(urb != 0); _check_ep(urb->ep); osalDbgCheck((urb->buff != NULL) || (urb->requestedLength == 0)); //TODO: add more checks. } /*===========================================================================*/ /* Main driver API. */ /*===========================================================================*/ void usbhObjectInit(USBHDriver *usbh) { memset(usbh, 0, sizeof(*usbh)); usbh->status = USBH_STATUS_STOPPED; #if HAL_USBH_USE_HUB INIT_LIST_HEAD(&usbh->hubs); _usbhub_port_object_init(&usbh->rootport, usbh, 0, 1); #else _usbhub_port_object_init(&usbh->rootport, usbh, 1); #endif } void usbhStart(USBHDriver *usbh) { #if USBH_DEBUG_MULTI_HOST usbDbgInit(usbh); #else usbDbgInit(); #endif osalSysLock(); osalDbgAssert((usbh->status == USBH_STATUS_STOPPED) || (usbh->status == USBH_STATUS_STARTED), "invalid state"); usbh_lld_start(usbh); usbh->status = USBH_STATUS_STARTED; osalSysUnlock(); } void usbhStop(USBHDriver *usbh) { //TODO: implement (void)usbh; } void usbhSuspend(USBHDriver *usbh) { //TODO: implement (void)usbh; } void usbhResume(USBHDriver *usbh) { //TODO: implement (void)usbh; } /*===========================================================================*/ /* Endpoint API. */ /*===========================================================================*/ void usbhEPObjectInit(usbh_ep_t *ep, usbh_device_t *dev, const usbh_endpoint_descriptor_t *desc) { osalDbgCheck(ep); _check_dev(dev); osalDbgCheck(desc); memset(ep, 0, sizeof(*ep)); ep->device = dev; ep->wMaxPacketSize = desc->wMaxPacketSize; ep->address = desc->bEndpointAddress & 0x0F; ep->type = (usbh_eptype_t) (desc->bmAttributes & 0x03); if (ep->type != USBH_EPTYPE_CTRL) { ep->in = (desc->bEndpointAddress & 0x80) ? TRUE : FALSE; } ep->bInterval = desc->bInterval; /* low-level part */ usbh_lld_ep_object_init(ep); ep->status = USBH_EPSTATUS_CLOSED; } static void _ep0_object_init(usbh_device_t *dev, uint16_t wMaxPacketSize) { const usbh_endpoint_descriptor_t ep0_descriptor = { 7, //bLength 5, //bDescriptorType 0, //bEndpointAddress 0, //bmAttributes wMaxPacketSize, 0, //bInterval }; usbhEPObjectInit(&dev->ctrl, dev, &ep0_descriptor); usbhEPSetName(&dev->ctrl, "DEV[CTRL]"); } bool usbhEPReset(usbh_ep_t *ep) { osalDbgCheck(ep != NULL); osalDbgAssert((ep->status == USBH_EPSTATUS_OPEN) || (ep->status == USBH_EPSTATUS_HALTED), "invalid state"); osalDbgAssert(ep->type != USBH_EPTYPE_CTRL, "don't need to reset control endpoint"); usbh_urbstatus_t ret = usbhControlRequest(ep->device, USBH_REQTYPE_STANDARDOUT(USBH_REQTYPE_RECIP_ENDPOINT), USBH_REQ_CLEAR_FEATURE, 0, ep->address | (ep->in ? 0x80 : 0x00), 0, 0); /* TODO: GET_STATUS to see if endpoint is still halted */ osalSysLock(); if ((ret == USBH_URBSTATUS_OK) && usbh_lld_ep_reset(ep)) { osalSysUnlock(); return HAL_SUCCESS; } osalSysUnlock(); return HAL_FAILED; } /*===========================================================================*/ /* URB API. */ /*===========================================================================*/ void usbhURBObjectInit(usbh_urb_t *urb, usbh_ep_t *ep, usbh_completion_cb callback, void *user, void *buff, uint32_t len) { osalDbgCheck(urb != 0); _check_ep(ep); /* initialize the common part: */ urb->ep = ep; urb->callback = callback; urb->userData = user; urb->buff = buff; urb->requestedLength = len; urb->actualLength = 0; urb->status = USBH_URBSTATUS_INITIALIZED; urb->waitingThread = 0; urb->abortingThread = 0; /* initialize the ll part: */ usbh_lld_urb_object_init(urb); } void usbhURBObjectResetI(usbh_urb_t *urb) { osalDbgAssert(!usbhURBIsBusy(urb), "invalid status"); osalDbgCheck((urb->waitingThread == 0) && (urb->abortingThread == 0)); urb->actualLength = 0; urb->status = USBH_URBSTATUS_INITIALIZED; /* reset the ll part: */ usbh_lld_urb_object_reset(urb); } /* usbhURBSubmitI may require a reschedule if called from a S-locked state */ void usbhURBSubmitI(usbh_urb_t *urb) { osalDbgCheckClassI(); _check_urb(urb); osalDbgAssert(urb->status == USBH_URBSTATUS_INITIALIZED, "invalid status"); usbh_ep_t *const ep = urb->ep; if (ep->status == USBH_EPSTATUS_HALTED) { _usbh_urb_completeI(urb, USBH_URBSTATUS_STALL); return; } if ((ep->status != USBH_EPSTATUS_OPEN) || !(usbhDeviceGetPort(ep->device)->status & USBH_PORTSTATUS_ENABLE)) { _usbh_urb_completeI(urb, USBH_URBSTATUS_DISCONNECTED); return; } urb->status = USBH_URBSTATUS_PENDING; usbh_lld_urb_submit(urb); } /* _usbh_urb_abortI may require a reschedule if called from a S-locked state */ bool _usbh_urb_abortI(usbh_urb_t *urb, usbh_urbstatus_t status) { osalDbgCheckClassI(); _check_urb(urb); osalDbgCheck(urb->status != USBH_URBSTATUS_UNINITIALIZED); if (urb->status == USBH_URBSTATUS_PENDING) { return usbh_lld_urb_abort(urb, status); } /* already finished or never submitted: * USBH_URBSTATUS_INITIALIZED, USBH_URBSTATUS_ERROR, USBH_URBSTATUS_TIMEOUT, * USBH_URBSTATUS_CANCELLED, USBH_URBSTATUS_STALL, USBH_URBSTATUS_DISCONNECTED * USBH_URBSTATUS_OK */ return TRUE; } void _usbh_urb_abort_and_waitS(usbh_urb_t *urb, usbh_urbstatus_t status) { osalDbgCheckClassS(); _check_urb(urb); if (_usbh_urb_abortI(urb, status) == FALSE) { uurbwarn("URB wasn't aborted immediately, suspend"); osalThreadSuspendS(&urb->abortingThread); osalDbgAssert(urb->abortingThread == 0, "maybe we should uncomment the line below"); //urb->abortingThread = 0; } else { /* This call is necessary because _usbh_urb_abortI may require a reschedule */ osalOsRescheduleS(); } uurbwarn("URB aborted"); } /* usbhURBCancelI may require a reschedule if called from a S-locked state */ bool usbhURBCancelI(usbh_urb_t *urb) { return _usbh_urb_abortI(urb, USBH_URBSTATUS_CANCELLED); } void usbhURBCancelAndWaitS(usbh_urb_t *urb) { _usbh_urb_abort_and_waitS(urb, USBH_URBSTATUS_CANCELLED); } msg_t usbhURBWaitTimeoutS(usbh_urb_t *urb, systime_t timeout) { osalDbgCheckClassS(); _check_urb(urb); if (urb->status == USBH_URBSTATUS_OK) { return MSG_OK; } else if (urb->status != USBH_URBSTATUS_PENDING) { return MSG_RESET; } return osalThreadSuspendTimeoutS(&urb->waitingThread, timeout); } msg_t usbhURBSubmitAndWaitS(usbh_urb_t *urb, systime_t timeout) { msg_t ret; osalDbgCheckClassS(); _check_urb(urb); usbhURBSubmitI(urb); osalOsRescheduleS(); /* This call is necessary because usbhURBSubmitI may require a reschedule */ ret = usbhURBWaitTimeoutS(urb, timeout); if (ret == MSG_TIMEOUT) _usbh_urb_abort_and_waitS(urb, USBH_URBSTATUS_TIMEOUT); return ret; } static inline msg_t _wakeup_message(usbh_urbstatus_t status) { if (status == USBH_URBSTATUS_OK) return MSG_OK; if (status == USBH_URBSTATUS_TIMEOUT) return MSG_TIMEOUT; return MSG_RESET; } /* _usbh_urb_completeI may require a reschedule if called from a S-locked state */ void _usbh_urb_completeI(usbh_urb_t *urb, usbh_urbstatus_t status) { osalDbgCheckClassI(); _check_urb(urb); urb->status = status; osalThreadResumeI(&urb->waitingThread, _wakeup_message(status)); osalThreadResumeI(&urb->abortingThread, MSG_RESET); if (urb->callback) urb->callback(urb); } /*===========================================================================*/ /* Synchronous API. */ /*===========================================================================*/ usbh_urbstatus_t usbhSynchronousTransfer(usbh_ep_t *ep, void *data, uint32_t len, uint32_t *actual_len, systime_t timeout) { osalDbgCheck(ep != NULL); osalDbgCheck((data != NULL) || (len == 0)); usbh_urb_t urb; usbhURBObjectInit(&urb, ep, 0, 0, data, len); osalSysLock(); usbhURBSubmitAndWaitS(&urb, timeout); osalSysUnlock(); if (actual_len != NULL) *actual_len = urb.actualLength; return urb.status; } usbh_urbstatus_t usbhControlRequestExtended(usbh_device_t *dev, const usbh_control_request_t *req, uint8_t *buff, uint32_t *actual_len, systime_t timeout) { if (!dev) return USBH_URBSTATUS_DISCONNECTED; osalDbgCheck(req != NULL); usbh_urb_t urb; usbhURBObjectInit(&urb, &dev->ctrl, 0, 0, buff, req->wLength); urb.setup_buff = req; osalSysLock(); usbhURBSubmitAndWaitS(&urb, timeout); osalSysUnlock(); if (actual_len != NULL) *actual_len = urb.actualLength; return urb.status; } usbh_urbstatus_t usbhControlRequest(usbh_device_t *dev, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint16_t wLength, uint8_t *buff) { USBH_DEFINE_BUFFER(const usbh_control_request_t req) = { bmRequestType, bRequest, wValue, wIndex, wLength }; return usbhControlRequestExtended(dev, &req, buff, NULL, HAL_USBH_CONTROL_REQUEST_DEFAULT_TIMEOUT); } /*===========================================================================*/ /* Standard request helpers. */ /*===========================================================================*/ bool usbhStdReqGetDeviceDescriptor(usbh_device_t *dev, uint16_t wLength, uint8_t *buf) { usbh_device_descriptor_t *desc; usbh_urbstatus_t ret = usbhControlRequest(dev, USBH_REQTYPE_STANDARDIN(USBH_REQTYPE_RECIP_DEVICE), USBH_REQ_GET_DESCRIPTOR, (USBH_DT_DEVICE << 8) | 0, 0, wLength, buf); desc = (usbh_device_descriptor_t *)buf; if ((ret != USBH_URBSTATUS_OK) || (desc->bLength != USBH_DT_DEVICE_SIZE) || (desc->bDescriptorType != USBH_DT_DEVICE)) { return HAL_FAILED; } return HAL_SUCCESS; } bool usbhStdReqGetConfigurationDescriptor(usbh_device_t *dev, uint8_t index, uint16_t wLength, uint8_t *buf) { usbh_urbstatus_t ret = usbhControlRequest(dev, USBH_REQTYPE_STANDARDIN(USBH_REQTYPE_RECIP_DEVICE), USBH_REQ_GET_DESCRIPTOR, (USBH_DT_CONFIG << 8) | index, 0, wLength, buf); usbh_config_descriptor_t *const desc = (usbh_config_descriptor_t *)buf; if ((ret != USBH_URBSTATUS_OK) || (desc->bLength < USBH_DT_CONFIG_SIZE) || (desc->bDescriptorType != USBH_DT_CONFIG)) { return HAL_FAILED; } return HAL_SUCCESS; } bool usbhStdReqGetStringDescriptor(usbh_device_t *dev, uint8_t index, uint16_t langID, uint16_t wLength, uint8_t *buf) { osalDbgAssert(wLength >= USBH_DT_STRING_SIZE, "wrong size"); usbh_string_descriptor_t *desc = (usbh_string_descriptor_t *)buf; usbh_urbstatus_t ret = usbhControlRequest(dev, USBH_REQTYPE_STANDARDIN(USBH_REQTYPE_RECIP_DEVICE), USBH_REQ_GET_DESCRIPTOR, (USBH_DT_STRING << 8) | index, langID, wLength, buf); if ((ret != USBH_URBSTATUS_OK) || (desc->bLength < USBH_DT_STRING_SIZE) || (desc->bDescriptorType != USBH_DT_STRING)) { return HAL_FAILED; } return HAL_SUCCESS; } bool usbhStdReqSetInterface(usbh_device_t *dev, uint8_t bInterfaceNumber, uint8_t bAlternateSetting) { usbh_urbstatus_t ret = usbhControlRequest(dev, USBH_REQTYPE_STANDARDOUT(USBH_REQTYPE_RECIP_INTERFACE), USBH_REQ_SET_INTERFACE, bAlternateSetting, bInterfaceNumber, 0, NULL); if (ret != USBH_URBSTATUS_OK) return HAL_FAILED; return HAL_SUCCESS; } bool usbhStdReqGetInterface(usbh_device_t *dev, uint8_t bInterfaceNumber, uint8_t *bAlternateSetting) { USBH_DEFINE_BUFFER(uint8_t alt); usbh_urbstatus_t ret = usbhControlRequest(dev, USBH_REQTYPE_STANDARDIN(USBH_REQTYPE_RECIP_INTERFACE), USBH_REQ_GET_INTERFACE, 0, bInterfaceNumber, 1, &alt); if (ret != USBH_URBSTATUS_OK) return HAL_FAILED; *bAlternateSetting = alt; return HAL_SUCCESS; } /*===========================================================================*/ /* Device-related functions. */ /*===========================================================================*/ static uint8_t _find_address(USBHDriver *host) { uint8_t addr, i, j; for (i = 0; i < sizeof_array(host->address_bitmap); i++) { addr = host->address_bitmap[i]; for (j = 0; j < 8; j++) { if ((addr & (1 << j)) == 0) { //found: addr = i * 8 + j + 1; host->address_bitmap[i] |= (1 << j); return addr; } } } return 0; } static void _free_address(USBHDriver *host, uint8_t addr) { uinfof("Free address %d", addr); host->address_bitmap[addr / 8] &= ~(1 << ((addr - 1) & 7)); } static void _device_initialize(usbh_device_t *dev, usbh_devspeed_t speed) { dev->address = 0; dev->speed = speed; dev->status = USBH_DEVSTATUS_DEFAULT; dev->langID0 = 0; dev->keepFullCfgDesc = 0; _ep0_object_init(dev, 64); } static bool _device_setaddress(usbh_device_t *dev, uint8_t address) { usbh_urbstatus_t ret = usbhControlRequest(dev, USBH_REQTYPE_STANDARDOUT(USBH_REQTYPE_RECIP_DEVICE), USBH_REQ_SET_ADDRESS, address, 0, 0, 0); if (ret != USBH_URBSTATUS_OK) return HAL_FAILED; dev->address = address; return HAL_SUCCESS; } static inline bool _device_read_basic_cfgdesc(usbh_device_t *dev, uint8_t bConfiguration) { /* get configuration descriptor */ return usbhStdReqGetConfigurationDescriptor(dev, bConfiguration, sizeof(dev->basicConfigDesc), (uint8_t *)&dev->basicConfigDesc); } static void _device_read_full_cfgdesc(usbh_device_t *dev, uint8_t bConfiguration) { _check_dev(dev); uint8_t i; if (dev->fullConfigurationDescriptor != NULL) { chHeapFree(dev->fullConfigurationDescriptor); } dev->fullConfigurationDescriptor = (uint8_t *)chHeapAlloc(0, dev->basicConfigDesc.wTotalLength); if (!dev->fullConfigurationDescriptor) return; for (i = 0; i < 3; i++) { if (usbhStdReqGetConfigurationDescriptor(dev, bConfiguration, dev->basicConfigDesc.wTotalLength, dev->fullConfigurationDescriptor) == HAL_SUCCESS) { return; } osalThreadSleepMilliseconds(200); } /* error */ chHeapFree(dev->fullConfigurationDescriptor); dev->fullConfigurationDescriptor = NULL; } static void _device_free_full_cfgdesc(usbh_device_t *dev) { osalDbgCheck(dev); if (dev->fullConfigurationDescriptor != NULL) { chHeapFree(dev->fullConfigurationDescriptor); dev->fullConfigurationDescriptor = NULL; } } static bool _device_set_configuration(usbh_device_t *dev, uint8_t configuration) { usbh_urbstatus_t ret = usbhControlRequest(dev, USBH_REQTYPE_STANDARDOUT(USBH_REQTYPE_RECIP_DEVICE), USBH_REQ_SET_CONFIGURATION, configuration, 0, 0, 0); if (ret != USBH_URBSTATUS_OK) return HAL_FAILED; return HAL_SUCCESS; } static bool _device_configure(usbh_device_t *dev, uint8_t bConfiguration) { uint8_t i; udevinfof("Reading basic configuration descriptor %d", bConfiguration); for (i = 0; i < 3; i++) { if (!_device_read_basic_cfgdesc(dev, bConfiguration)) break; } if (i == 3) { udeverrf("Could not read basic configuration descriptor %d; " "won't configure device", bConfiguration); return HAL_FAILED; } udevinfof("Selecting configuration %d", bConfiguration); for (i = 0; i < 3; i++) { if (!_device_set_configuration(dev, dev->basicConfigDesc.bConfigurationValue)) { /* TODO: check if correctly configured using GET_CONFIGURATION */ dev->status = USBH_DEVSTATUS_CONFIGURED; dev->bConfiguration = bConfiguration; udevinfo("Device configured."); return HAL_SUCCESS; } } return HAL_FAILED; } static bool _device_enumerate(usbh_device_t *dev) { udevinfo("Enumerate."); udevinfo("Get first 8 bytes of device descriptor"); /* get first 8 bytes of device descriptor */ if (usbhStdReqGetDeviceDescriptor(dev, 8, (uint8_t *)&dev->devDesc)) { udeverr("Error"); return HAL_FAILED; } udevinfof("Configure bMaxPacketSize0 = %d", dev->devDesc.bMaxPacketSize0); /* configure EP0 wMaxPacketSize */ usbhEPClose(&dev->ctrl); _ep0_object_init(dev, dev->devDesc.bMaxPacketSize0); usbhEPOpen(&dev->ctrl); uint8_t addr = _find_address(dev->host); if (addr == 0) { udeverr("No free addresses found"); return HAL_FAILED; } /* set device address */ udevinfof("Set device address: %d", addr); if (_device_setaddress(dev, addr)) { udeverr("Error"); _free_address(dev->host, addr); return HAL_FAILED; } /* update EP because of the address change */ usbhEPClose(&dev->ctrl); _ep0_object_init(dev, dev->devDesc.bMaxPacketSize0); usbhEPOpen(&dev->ctrl); udevinfof("Wait stabilization..."); osalThreadSleepMilliseconds(HAL_USBH_DEVICE_ADDRESS_STABILIZATION); /* address is set */ dev->status = USBH_DEVSTATUS_ADDRESS; udevinfof("Get full device desc"); /* get full device descriptor */ if (usbhStdReqGetDeviceDescriptor(dev, sizeof(dev->devDesc), (uint8_t *)&dev->devDesc)) { udeverr("Error"); _device_setaddress(dev, 0); _free_address(dev->host, addr); return HAL_FAILED; } udevinfof("Enumeration finished."); return HAL_SUCCESS; } #if USBH_DEBUG_ENABLE && USBH_DEBUG_ENABLE_INFO void usbhDevicePrintInfo(usbh_device_t *dev) { USBH_DEFINE_BUFFER(char str[64]); usbh_device_descriptor_t *const desc = &dev->devDesc; udevinfo("----- Device info -----"); udevinfo("Device descriptor:"); udevinfof("\tUSBSpec=%04x, #configurations=%d, langID0=%04x", desc->bcdUSB, desc->bNumConfigurations, dev->langID0); udevinfof("\tClass=%02x, Subclass=%02x, Protocol=%02x", desc->bDeviceClass, desc->bDeviceSubClass, desc->bDeviceProtocol); udevinfof("\tVID=%04x, PID=%04x, Release=%04x", desc->idVendor, desc->idProduct, desc->bcdDevice); if (dev->langID0) { usbhDeviceReadString(dev, str, sizeof(str), desc->iManufacturer, dev->langID0); udevinfof("\tManufacturer: %s", str); usbhDeviceReadString(dev, str, sizeof(str), desc->iProduct, dev->langID0); udevinfof("\tProduct: %s", str); usbhDeviceReadString(dev, str, sizeof(str), desc->iSerialNumber, dev->langID0); udevinfof("\tSerial Number: %s", str); } if (dev->status == USBH_DEVSTATUS_CONFIGURED) { udevinfo("Configuration descriptor (partial):"); usbh_config_descriptor_t *const cfg = &dev->basicConfigDesc; udevinfof("\tbConfigurationValue=%d, Length=%d, #interfaces=%d", cfg->bConfigurationValue, cfg->wTotalLength, cfg->bNumInterfaces); udevinfof("\tCurrent=%dmA", cfg->bMaxPower * 2); udevinfof("\tSelfPowered=%d, RemoteWakeup=%d", cfg->bmAttributes & 0x40 ? 1 : 0, cfg->bmAttributes & 0x20 ? 1 : 0); if (dev->langID0) { usbhDeviceReadString(dev, str, sizeof(str), cfg->iConfiguration, dev->langID0); udevinfof("\tName: %s", str); } } udevinfo("----- End Device info -----"); } void usbhDevicePrintConfiguration(const usbh_device_t *dev, const uint8_t *descriptor, uint16_t rem) { (void)dev; generic_iterator_t iep, icfg, ics; if_iterator_t iif; udevinfo("----- Configuration info -----"); udevinfo("Configuration descriptor:"); cfg_iter_init(&icfg, descriptor, rem); const usbh_config_descriptor_t *const cfgdesc = cfg_get(&icfg); udevinfof("Configuration %d, #IFs=%d", cfgdesc->bConfigurationValue, cfgdesc->bNumInterfaces); for (if_iter_init(&iif, &icfg); iif.valid; if_iter_next(&iif)) { const usbh_interface_descriptor_t *const ifdesc = if_get(&iif); udevinfof(" Interface %d, alt=%d, #EPs=%d, " "Class=%02x, Subclass=%02x, Protocol=%02x", ifdesc->bInterfaceNumber, ifdesc->bAlternateSetting, ifdesc->bNumEndpoints, ifdesc->bInterfaceClass, ifdesc->bInterfaceSubClass, ifdesc->bInterfaceProtocol); for (cs_iter_init(&ics, (generic_iterator_t *)&iif); ics.valid; cs_iter_next(&ics)) { udevinfof(" Class-Specific descriptor, Length=%d, Type=%02x", ics.curr[0], ics.curr[1]); } for (ep_iter_init(&iep, &iif); iep.valid; ep_iter_next(&iep)) { const usbh_endpoint_descriptor_t *const epdesc = ep_get(&iep); udevinfof(" Endpoint descriptor, Address=%02x, Type=%d, MaxPacket=%d, Interval=%d", epdesc->bEndpointAddress, epdesc->bmAttributes & 3, epdesc->wMaxPacketSize, epdesc->bInterval); for (cs_iter_init(&ics, &iep); ics.valid; cs_iter_next(&ics)) { udevinfof(" Class-Specific descriptor, Length=%d, Type=%02x", ics.curr[0], ics.curr[1]); } } } udevinfo("----- End Configuration info -----"); } #endif bool usbhDeviceReadString(usbh_device_t *dev, char *dest, uint8_t size, uint8_t index, uint16_t langID) { usbh_string_descriptor_t *const desc = (usbh_string_descriptor_t *)dest; osalDbgAssert(size >= 2, "wrong size"); *dest = 0; if (index == 0) return HAL_SUCCESS; if (usbhStdReqGetStringDescriptor(dev, index, langID, size, (uint8_t *)dest)) return HAL_FAILED; if (desc->bLength & 1) return HAL_FAILED; if (desc->bLength <= 2) return HAL_SUCCESS; uint8_t nchars = desc->bLength / 2; /* including the trailing 0 */ if (size < nchars) nchars = size; char *src = (char *)&desc->wData[0]; while (--nchars) { *dest++ = *src; src += 2; } *dest = 0; return HAL_SUCCESS; } /*===========================================================================*/ /* Port processing functions. */ /*===========================================================================*/ static void _port_connected(usbh_port_t *port); static void _port_reset(usbh_port_t *port) { usbhhubControlRequest(port->device.host, #if HAL_USBH_USE_HUB port->hub, #endif USBH_REQTYPE_DIR_OUT | USBH_REQTYPE_TYPE_CLASS | USBH_REQTYPE_RECIP_OTHER, USBH_REQ_SET_FEATURE, USBH_PORT_FEAT_RESET, port->number, 0, 0); } static void _port_update_status(usbh_port_t *port) { uint32_t stat; if (usbhhubControlRequest(port->device.host, #if HAL_USBH_USE_HUB port->hub, #endif USBH_REQTYPE_DIR_IN | USBH_REQTYPE_TYPE_CLASS | USBH_REQTYPE_RECIP_OTHER, USBH_REQ_GET_STATUS, 0, port->number, 4, (uint8_t *)&stat) != USBH_URBSTATUS_OK) { return; } port->status = stat & 0xffff; port->c_status |= stat >> 16; } static void _port_process_status_change(usbh_port_t *port) { _port_update_status(port); if (port->c_status & USBH_PORTSTATUS_C_CONNECTION) { port->c_status &= ~USBH_PORTSTATUS_C_CONNECTION; usbhhubClearFeaturePort(port, USBH_PORT_FEAT_C_CONNECTION); if (port->device.status != USBH_DEVSTATUS_DISCONNECTED) { _usbh_port_disconnected(port); } } if (port->device.status == USBH_DEVSTATUS_DISCONNECTED) { if (port->status & USBH_PORTSTATUS_CONNECTION) { _port_connected(port); } } if (port->c_status & USBH_PORTSTATUS_C_RESET) { port->c_status &= ~USBH_PORTSTATUS_C_RESET; usbhhubClearFeaturePort(port, USBH_PORT_FEAT_C_RESET); uportdbgf("Port %d: reset=%d", port->number, port->status & USBH_PORTSTATUS_RESET ? 1 : 0); } if (port->c_status & USBH_PORTSTATUS_C_ENABLE) { port->c_status &= ~USBH_PORTSTATUS_C_ENABLE; usbhhubClearFeaturePort(port, USBH_PORT_FEAT_C_ENABLE); uportdbgf("Port %d: enable=%d", port->number, port->status & USBH_PORTSTATUS_ENABLE ? 1 : 0); } if (port->c_status & USBH_PORTSTATUS_C_OVERCURRENT) { port->c_status &= ~USBH_PORTSTATUS_C_OVERCURRENT; usbhhubClearFeaturePort(port, USBH_PORT_FEAT_C_OVERCURRENT); uportwarnf("Port %d: overcurrent=%d", port->number, port->status & USBH_PORTSTATUS_OVERCURRENT ? 1 : 0); } if (port->c_status & USBH_PORTSTATUS_C_SUSPEND) { port->c_status &= ~USBH_PORTSTATUS_C_SUSPEND; usbhhubClearFeaturePort(port, USBH_PORT_FEAT_C_SUSPEND); uportinfof("Port %d: suspend=%d", port->number, port->status & USBH_PORTSTATUS_SUSPEND ? 1 : 0); } } static void _port_connected(usbh_port_t *port) { /* connected */ systime_t start; uint8_t i; uint8_t retries; usbh_devspeed_t speed; USBH_DEFINE_BUFFER(usbh_string_descriptor_t strdesc); port->device.status = USBH_DEVSTATUS_ATTACHED; uportinfof("Port %d: attached, wait debounce...", port->number); /* wait for attach de-bounce */ osalThreadSleepMilliseconds(HAL_USBH_PORT_DEBOUNCE_TIME); /* check disconnection */ _port_update_status(port); if (port->c_status & USBH_PORTSTATUS_C_CONNECTION) { port->c_status &= ~USBH_PORTSTATUS_C_CONNECTION; usbhhubClearFeaturePort(port, USBH_PORT_FEAT_C_CONNECTION); uportwarnf("Port %d: connection state changed; abort #1", port->number); goto abort; } /* make sure that the device is still connected */ if ((port->status & USBH_PORTSTATUS_CONNECTION) == 0) { uportwarnf("Port %d: device is disconnected", port->number); goto abort; } uportinfof("Port %d: connected", port->number); port->device.status = USBH_DEVSTATUS_CONNECTED; retries = 3; reset: for (i = 0; i < 3; i++) { uportinfof("Port %d: Try reset...", port->number); /* TODO: check that port is actually disabled */ port->c_status &= ~(USBH_PORTSTATUS_C_RESET | USBH_PORTSTATUS_C_ENABLE); _port_reset(port); osalThreadSleepMilliseconds(20); /* give it some time to reset (min. 10ms) */ start = osalOsGetSystemTimeX(); while (TRUE) { _port_update_status(port); /* check for disconnection */ if (port->c_status & USBH_PORTSTATUS_C_CONNECTION) { port->c_status &= ~USBH_PORTSTATUS_C_CONNECTION; usbhhubClearFeaturePort(port, USBH_PORT_FEAT_C_CONNECTION); uportwarnf("Port %d: connection state changed; abort #2", port->number); goto abort; } /* check for reset completion */ if (port->c_status & USBH_PORTSTATUS_C_RESET) { port->c_status &= ~USBH_PORTSTATUS_C_RESET; usbhhubClearFeaturePort(port, USBH_PORT_FEAT_C_RESET); if ((port->status & (USBH_PORTSTATUS_ENABLE | USBH_PORTSTATUS_CONNECTION)) == (USBH_PORTSTATUS_ENABLE | USBH_PORTSTATUS_CONNECTION)) { goto reset_success; } } /* check for timeout */ if (osalOsGetSystemTimeX() - start > HAL_USBH_PORT_RESET_TIMEOUT) { uportwarnf("Port %d: reset timeout", port->number); break; } } } /* reset procedure failed; abort */ goto abort; reset_success: uportinfof("Port %d: Reset OK, recovery...", port->number); /* reset recovery */ osalThreadSleepMilliseconds(100); /* initialize object */ if (port->status & USBH_PORTSTATUS_LOW_SPEED) { speed = USBH_DEVSPEED_LOW; } else if (port->status & USBH_PORTSTATUS_HIGH_SPEED) { speed = USBH_DEVSPEED_HIGH; } else { speed = USBH_DEVSPEED_FULL; } _device_initialize(&port->device, speed); usbhEPOpen(&port->device.ctrl); /* device with default address (0), try enumeration */ if (_device_enumerate(&port->device) != HAL_SUCCESS) { /* enumeration failed */ usbhEPClose(&port->device.ctrl); if (!--retries) { uportwarnf("Port %d: enumeration failed; abort", port->number); goto abort; } /* retry reset & enumeration */ uportwarnf("Port %d: enumeration failed; retry reset & enumeration", port->number); goto reset; } /* load the default language ID */ uportinfof("Port %d: Loading langID0...", port->number); if (!usbhStdReqGetStringDescriptor(&port->device, 0, 0, USBH_DT_STRING_SIZE, (uint8_t *)&strdesc) && (strdesc.bLength >= 4) && !usbhStdReqGetStringDescriptor(&port->device, 0, 0, 4, (uint8_t *)&strdesc)) { port->device.langID0 = strdesc.wData[0]; uportinfof("Port %d: langID0=%04x", port->number, port->device.langID0); } /* check if the device has only one configuration */ if (port->device.devDesc.bNumConfigurations == 1) { uportinfof("Port %d: device has only one configuration", port->number); _device_configure(&port->device, 0); } _classdriver_process_device(&port->device); return; abort: uporterrf("Port %d: abort", port->number); port->device.status = USBH_DEVSTATUS_DISCONNECTED; } void _usbh_port_disconnected(usbh_port_t *port) { if (port->device.status == USBH_DEVSTATUS_DISCONNECTED) return; uportinfof("Port %d: disconnected", port->number); /* unload drivers */ while (port->device.drivers) { usbh_baseclassdriver_t *drv = port->device.drivers; /* unload */ uportinfof("Port %d: unload driver %s", port->number, drv->info->name); drv->info->vmt->unload(drv); /* unlink */ drv->dev = 0; port->device.drivers = drv->next; } /* close control endpoint */ usbhEPClose(&port->device.ctrl); /* free address */ if (port->device.address) _free_address(port->device.host, port->device.address); _device_free_full_cfgdesc(&port->device); port->device.status = USBH_DEVSTATUS_DISCONNECTED; } /*===========================================================================*/ /* Hub processing functions. */ /*===========================================================================*/ #if HAL_USBH_USE_HUB static void _hub_update_status(USBHDriver *host, USBHHubDriver *hub) { uint32_t stat; if (usbhhubControlRequest(host, hub, USBH_REQTYPE_DIR_IN | USBH_REQTYPE_TYPE_CLASS | USBH_REQTYPE_RECIP_DEVICE, USBH_REQ_GET_STATUS, 0, 0, 4, (uint8_t *)&stat) != USBH_URBSTATUS_OK) { return; } if (hub) { hub->status = stat & 0xffff; hub->c_status |= stat >> 16; } } static void _hub_process_status_change(USBHDriver *host, USBHHubDriver *hub) { uinfo("Hub status change. GET_STATUS."); _hub_update_status(host, hub); if (hub->c_status & USBH_HUBSTATUS_C_HUB_LOCAL_POWER) { hub->c_status &= ~USBH_HUBSTATUS_C_HUB_LOCAL_POWER; uinfo("Clear USBH_HUB_FEAT_C_HUB_LOCAL_POWER"); usbhhubClearFeatureHub(host, hub, USBH_HUB_FEAT_C_HUB_LOCAL_POWER); } if (hub->c_status & USBH_HUBSTATUS_C_HUB_OVER_CURRENT) { hub->c_status &= ~USBH_HUBSTATUS_C_HUB_OVER_CURRENT; uinfo("Clear USBH_HUB_FEAT_C_HUB_OVER_CURRENT"); usbhhubClearFeatureHub(host, hub, USBH_HUB_FEAT_C_HUB_OVER_CURRENT); } } static uint32_t _hub_get_status_change_bitmap(USBHDriver *host, USBHHubDriver *hub) { if (hub != NULL) { osalSysLock(); uint32_t ret = hub->statuschange; hub->statuschange = 0; osalSysUnlock(); return ret; } return usbh_lld_roothub_get_statuschange_bitmap(host); } #else //TODO: replace the functions above #endif #if HAL_USBH_USE_HUB static void _hub_process(USBHDriver *host, USBHHubDriver *hub) { uint32_t bitmap = _hub_get_status_change_bitmap(host, hub); if (!bitmap) return; if (bitmap & 1) { _hub_process_status_change(host, hub); bitmap &= ~1; } usbh_port_t *port = (hub == NULL) ? &host->rootport : hub->ports; uint8_t i; for (i = 1; i < 32; i++) { if (!bitmap || !port) break; if (bitmap & (1 << i)) { bitmap &= ~(1 << i); _port_process_status_change(port); } port = port->next; } } #else static void _hub_process(USBHDriver *host) { uint32_t bitmap = usbh_lld_roothub_get_statuschange_bitmap(host); #if 0 //TODO: complete _hub_process_status_change for root hub if (bitmap & 1) { _hub_process_status_change(host, hub); bitmap &= ~1; } #endif if (!bitmap) return; _port_process_status_change(&host->rootport); } #endif /*===========================================================================*/ /* Main processing loop (enumeration, loading/unloading drivers, etc). */ /*===========================================================================*/ void usbhMainLoop(USBHDriver *usbh) { if (usbh->status == USBH_STATUS_STOPPED) return; #if HAL_USBH_USE_HUB /* process root hub */ _hub_process(usbh, NULL); /* process connected hubs */ USBHHubDriver *hub, *temp; list_for_each_entry_safe(hub, USBHHubDriver, temp, &usbh->hubs, node) { _hub_process(usbh, hub); } #else /* process root hub */ _hub_process(usbh); #endif } /*===========================================================================*/ /* Class driver loader. */ /*===========================================================================*/ bool _usbh_match_vid_pid(usbh_device_t *dev, int32_t vid, int32_t pid) { if (((vid < 0) || (dev->devDesc.idVendor == vid)) && ((pid < 0) || (dev->devDesc.idProduct == pid))) return HAL_SUCCESS; return HAL_FAILED; } bool _usbh_match_descriptor(const uint8_t *descriptor, uint16_t rem, int16_t type, int16_t _class, int16_t subclass, int16_t protocol) { int16_t dclass, dsubclass, dprotocol; if ((rem < descriptor[0]) || (rem < 2)) return HAL_FAILED; uint8_t dtype = descriptor[1]; if ((type >= 0) && (type != dtype)) return HAL_FAILED; switch (dtype) { case USBH_DT_DEVICE: { if (rem < USBH_DT_DEVICE_SIZE) return HAL_FAILED; const usbh_device_descriptor_t *const desc = (const usbh_device_descriptor_t *)descriptor; dclass = desc->bDeviceClass; dsubclass = desc->bDeviceSubClass; dprotocol = desc->bDeviceProtocol; } break; case USBH_DT_INTERFACE: { if (rem < USBH_DT_INTERFACE_SIZE) return HAL_FAILED; const usbh_interface_descriptor_t *const desc = (const usbh_interface_descriptor_t *)descriptor; dclass = desc->bInterfaceClass; dsubclass = desc->bInterfaceSubClass; dprotocol = desc->bInterfaceProtocol; } break; case USBH_DT_INTERFACE_ASSOCIATION: { if (rem < USBH_DT_INTERFACE_ASSOCIATION_SIZE) return HAL_FAILED; const usbh_ia_descriptor_t *const desc = (const usbh_ia_descriptor_t *)descriptor; dclass = desc->bFunctionClass; dsubclass = desc->bFunctionSubClass; dprotocol = desc->bFunctionProtocol; } break; default: return HAL_FAILED; } if (((_class < 0) || (_class == dclass)) && ((subclass < 0) || (subclass == dsubclass)) && ((protocol < 0) || (protocol == dprotocol))) return HAL_SUCCESS; return HAL_FAILED; } static const usbh_classdriverinfo_t *usbh_classdrivers_lookup[] = { #if HAL_USBH_USE_ADDITIONAL_CLASS_DRIVERS /* user-defined out of tree class drivers */ HAL_USBH_ADDITIONAL_CLASS_DRIVERS #endif #if HAL_USBH_USE_FTDI &usbhftdiClassDriverInfo, #endif #if HAL_USBH_USE_HUB &usbhhubClassDriverInfo, #endif #if HAL_USBH_USE_UVC &usbhuvcClassDriverInfo, #endif #if HAL_USBH_USE_MSD &usbhmsdClassDriverInfo, #endif #if HAL_USBH_USE_HID &usbhhidClassDriverInfo, #endif #if HAL_USBH_USE_UVC &usbhuvcClassDriverInfo, #endif #if HAL_USBH_USE_AOA &usbhaoaClassDriverInfo, /* Leave always last */ #endif }; static bool _classdriver_load(usbh_device_t *dev, uint8_t *descbuff, uint16_t rem) { uint8_t i; usbh_baseclassdriver_t *drv = NULL; for (i = 0; i < sizeof_array(usbh_classdrivers_lookup); i++) { const usbh_classdriverinfo_t *const info = usbh_classdrivers_lookup[i]; udevinfof("Try load driver %s", info->name); drv = info->vmt->load(dev, descbuff, rem); if (drv != NULL) goto success; } return HAL_FAILED; success: /* Link this driver to the device */ if (!drv->dev) { drv->next = dev->drivers; dev->drivers = drv; drv->dev = dev; } return HAL_SUCCESS; } static void _classdriver_process_device(usbh_device_t *dev) { udevinfo("New device found."); const usbh_device_descriptor_t *const devdesc = &dev->devDesc; usbhDevicePrintInfo(dev); /* TODO: Support multiple configurations * * Windows doesn't support them, so it's unlikely that any commercial USB device * will have multiple configurations. */ if (dev->status != USBH_DEVSTATUS_CONFIGURED) { udevwarn("Multiple configurations not supported, selecting configuration #0"); if (_device_configure(dev, 0) != HAL_SUCCESS) { udeverr("Couldn't configure device; abort."); return; } } _device_read_full_cfgdesc(dev, dev->bConfiguration); if (dev->fullConfigurationDescriptor == NULL) { udeverr("Couldn't read full configuration descriptor; abort."); return; } usbhDevicePrintConfiguration(dev, dev->fullConfigurationDescriptor, dev->basicConfigDesc.wTotalLength); #if HAL_USBH_USE_IAD if (dev->devDesc.bDeviceClass == 0xef && dev->devDesc.bDeviceSubClass == 0x02 && dev->devDesc.bDeviceProtocol == 0x01) { udevinfo("Load a driver for each IF collection."); generic_iterator_t icfg; if_iterator_t iif; const usbh_ia_descriptor_t *last_iad = 0; cfg_iter_init(&icfg, dev->fullConfigurationDescriptor, dev->basicConfigDesc.wTotalLength); if (!icfg.valid) { udeverr("Invalid configuration descriptor."); goto exit; } for (if_iter_init(&iif, &icfg); iif.valid; if_iter_next(&iif)) { if (iif.iad && (iif.iad != last_iad)) { last_iad = iif.iad; if (_classdriver_load(dev, (uint8_t *)iif.iad, (uint8_t *)iif.curr - (uint8_t *)iif.iad + iif.rem) != HAL_SUCCESS) { udevwarnf("No drivers found for IF collection #%d:%d", iif.iad->bFirstInterface, iif.iad->bFirstInterface + iif.iad->bInterfaceCount - 1); } } } } else #endif if (_classdriver_load(dev, (uint8_t *)devdesc, USBH_DT_DEVICE_SIZE) != HAL_SUCCESS) { udevinfo("No drivers found for device."); if (devdesc->bDeviceClass == 0) { /* each interface defines its own device class/subclass/protocol */ udevinfo("Try load a driver for each IF."); generic_iterator_t icfg; if_iterator_t iif; uint8_t last_if = 0xff; cfg_iter_init(&icfg, dev->fullConfigurationDescriptor, dev->basicConfigDesc.wTotalLength); if (!icfg.valid) { udeverr("Invalid configuration descriptor."); goto exit; } for (if_iter_init(&iif, &icfg); iif.valid; if_iter_next(&iif)) { const usbh_interface_descriptor_t *const ifdesc = if_get(&iif); if (ifdesc->bInterfaceNumber != last_if) { last_if = ifdesc->bInterfaceNumber; if (_classdriver_load(dev, (uint8_t *)ifdesc, iif.rem) != HAL_SUCCESS) { udevwarnf("No drivers found for IF #%d", ifdesc->bInterfaceNumber); } } } } else { udevwarn("Unable to load driver."); } } exit: if (dev->keepFullCfgDesc == 0) { _device_free_full_cfgdesc(dev); } } void usbhInit(void) { uint8_t i; for (i = 0; i < sizeof_array(usbh_classdrivers_lookup); i++) { if (usbh_classdrivers_lookup[i]->vmt->init) { usbh_classdrivers_lookup[i]->vmt->init(); } } usbh_lld_init(); } #endif