Mike R
USB device stack, with KL25Z fixes for USB 3.0 hosts and sleep/resume interrupt handling
Dependents: frdm_Slider_Keyboard idd_hw2_figlax_PanType idd_hw2_appachu_finger_chording idd_hw3_AngieWangAntonioDeLimaFernandesDanielLim_BladeSymphony ... more
Fork of
USBDevice
by 
mbed official
This is an overhauled version of the standard mbed USB device-side driver library, with bug fixes for KL25Z devices. It greatly improves reliability and stability of USB on the KL25Z, especially with devices using multiple endpoints concurrently.
I've had some nagging problems with the base mbed implementation for a long time, manifesting as occasional random disconnects that required rebooting the device. Recently (late 2015), I started implementing a USB device on the KL25Z that used multiple endpoints, and suddenly the nagging, occasional problems turned into frequent and predictable crashes. This forced me to delve into the USB stack and figure out what was really going on. Happily, the frequent crashes made it possible to track down and fix the problems. This new version is working very reliably in my testing - the random disconnects seem completely eradicated, even under very stressful conditions for the device.
Summary
- Overall stability improvements
- USB 3.0 host support
- Stalled endpoint fixes
- Sleep/resume notifications
- Smaller memory footprint
- General code cleanup
Update - 2/15/2016
My recent fixes introduced a new problem that made the initial connection fail most of the time on certain hosts. It's not clear if the common thread was a particular type of motherboard or USB chip set, or a specific version of Windows, or what, but several people ran into it. We tracked the problem down to the "stall" fixes in the earlier updates, which we now know weren't quite the right fixes after all. The latest update (2/15/2016) fixes this. It has new and improved "unstall" handling that so far works well with diverse hosts.
Race conditions and overall stability
The base mbed KL25Z implementation has a lot of problems with "race conditions" - timing problems that can happen when hardware interrupts occur at inopportune moments. The library shares a bunch of static variable data between interrupt handler context and regular application context. This isn't automatically a bad thing, but it does require careful coordination to make sure that the interrupt handler doesn't corrupt data that the other code was in the middle of updating when an interrupt occurs. The base mbed code, though, doesn't do any of the necessary coordination. This makes it kind of amazing that the base code worked at all for anyone, but I guess the interrupt rate is low enough in most applications that the glitch rate was below anyone's threshold to seriously investigate.
This overhaul adds the necessary coordination for the interrupt handlers to protect against these data corruptions. I think it's very solid now, and hopefully entirely free of the numerous race conditions in the old code. It's always hard to be certain that you've fixed every possible bug like this because they strike (effectively) at random, but I'm pretty confident: my test application was reliably able to trigger glitches in the base code in a matter of minutes, but the same application (with the overhauled library) now runs for days on end without dropping the connection.
Stalled endpoint fixes
USB has a standard way of handling communications errors called a "stall", which basically puts the connection into an error mode to let both sides know that they need to reset their internal states and sync up again. The original mbed version of the USB device library doesn't seem to have the necessary code to recover from this condition properly. The KL25Z hardware does some of the work, but it also seems to require the software to take some steps to "un-stall" the connection. (I keep saying "seems to" because the hardware reference material is very sketchy about all of this. Most of what I've figured out is from observing the device in action with a Windows host.) This new version adds code to do the necessary re-syncing and get the connection going again, automatically, and transparently to the user.
USB 3.0 Hosts
The original mbed code sometimes didn't work when connecting to hosts with USB 3.0 ports. This didn't affect every host, but it affected many of them. The common element seemed to be the Intel Haswell chip set on the host, but there may be other chip sets affected as well. In any case, the problem affected many PCs from the Windows 7 and 8 generation, as well as many Macs. It was possible to work around the problem by avoiding USB 3.0 ports - you could use a USB 2 port on the host, or plug a USB 2 hub between the host and device. But I wanted to just fix the problem and eliminate the need for such workarounds. This modified version of the library has such a fix, which so far has worked for everyone who's tried.
Sleep/resume notifications
This modified version also contains an innocuous change to the KL25Z USB HAL code to handle sleep and resume interrupts with calls to suspendStateChanged(). The original KL25Z code omitted these calls (and in fact didn't even enable the interrupts), but I think this was an unintentional oversight - the notifier function is part of the generic API, and other supported boards all implement it. I use this feature in my own application so that I can distinguish sleep mode from actual disconnects and handle the two conditions correctly.
Smaller memory footprint
The base mbed version of the code allocates twice as much memory for USB buffers as it really needed to. It looks like the original developers intended to implement the KL25Z USB hardware's built-in double-buffering mechanism, but they ultimately abandoned that effort. But they left in the double memory allocation. This version removes that and allocates only what's actually needed. The USB buffers aren't that big (128 bytes per endpoint), so this doesn't save a ton of memory, but even a little memory is pretty precious on this machine given that it only has 16K.
(I did look into adding the double-buffering support that the original developers abandoned, but after some experimentation I decided they were right to skip it. It just doesn't seem to mesh well with the design of the rest of the mbed USB code. I think it would take a major rewrite to make it work, and it doesn't seem worth the effort given that most applications don't need it - it would only benefit applications that are moving so much data through USB that they're pushing the limits of the CPU. And even for those, I think it would be a lot simpler to build a purely software-based buffer rotation mechanism.)
General code cleanup
The KL25Z HAL code in this version has greatly expanded commentary and a lot of general cleanup. Some of the hardware constants were given the wrong symbolic names (e.g., EVEN and ODD were reversed), and many were just missing (written as hard-coded numbers without explanation). I fixed the misnomers and added symbolic names for formerly anonymous numbers. Hopefully the next person who has to overhaul this code will at least have an easier time understanding what I thought I was doing!
USBHID/USBHID_Types.h@53:c8110529c24b, 2016-06-02 (annotated)
- Committer:
- mjr
- Date:
- Thu Jun 02 18:58:24 2016 +0000
- Revision:
- 53:c8110529c24b
- Parent:
- 37:c5ac4ccf6597
Move SET_INTERFACE handling to callbacks; add some constants for documentation; cosmetic touchup
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| samux | 1:80ab0d068708 | 1 | /* Copyright (c) 2010-2011 mbed.org, MIT License |
| samux | 1:80ab0d068708 | 2 | * |
| samux | 1:80ab0d068708 | 3 | * Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
| samux | 1:80ab0d068708 | 4 | * and associated documentation files (the "Software"), to deal in the Software without |
| samux | 1:80ab0d068708 | 5 | * restriction, including without limitation the rights to use, copy, modify, merge, publish, |
| samux | 1:80ab0d068708 | 6 | * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the |
| samux | 1:80ab0d068708 | 7 | * Software is furnished to do so, subject to the following conditions: |
| samux | 1:80ab0d068708 | 8 | * |
| samux | 1:80ab0d068708 | 9 | * The above copyright notice and this permission notice shall be included in all copies or |
| samux | 1:80ab0d068708 | 10 | * substantial portions of the Software. |
| samux | 1:80ab0d068708 | 11 | * |
| samux | 1:80ab0d068708 | 12 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING |
| samux | 1:80ab0d068708 | 13 | * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
| samux | 1:80ab0d068708 | 14 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, |
| samux | 1:80ab0d068708 | 15 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| samux | 1:80ab0d068708 | 16 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| samux | 1:80ab0d068708 | 17 | */ |
| samux | 1:80ab0d068708 | 18 | |
| samux | 1:80ab0d068708 | 19 | #ifndef USBCLASS_HID_TYPES |
| samux | 1:80ab0d068708 | 20 | #define USBCLASS_HID_TYPES |
| samux | 1:80ab0d068708 | 21 | |
| samux | 1:80ab0d068708 | 22 | #include <stdint.h> |
| samux | 1:80ab0d068708 | 23 | |
| samux | 1:80ab0d068708 | 24 | /* */ |
| samux | 1:80ab0d068708 | 25 | #define HID_VERSION_1_11 (0x0111) |
| samux | 1:80ab0d068708 | 26 | |
| samux | 1:80ab0d068708 | 27 | /* HID Class */ |
| samux | 1:80ab0d068708 | 28 | #define HID_CLASS (3) |
| samux | 1:80ab0d068708 | 29 | #define HID_SUBCLASS_NONE (0) |
| mjr | 53:c8110529c24b | 30 | #define HID_SUBCLASS_BOOT (1) |
| samux | 1:80ab0d068708 | 31 | #define HID_PROTOCOL_NONE (0) |
| mjr | 53:c8110529c24b | 32 | #define HID_PROTOCOL_KB (1) |
| mjr | 53:c8110529c24b | 33 | #define HID_PROTOCOL_MOUSE (2) |
| samux | 1:80ab0d068708 | 34 | |
| samux | 1:80ab0d068708 | 35 | /* Descriptors */ |
| samux | 1:80ab0d068708 | 36 | #define HID_DESCRIPTOR (33) |
| samux | 1:80ab0d068708 | 37 | #define HID_DESCRIPTOR_LENGTH (0x09) |
| samux | 1:80ab0d068708 | 38 | #define REPORT_DESCRIPTOR (34) |
| samux | 1:80ab0d068708 | 39 | |
| samux | 1:80ab0d068708 | 40 | /* Class requests */ |
| mjr | 37:c5ac4ccf6597 | 41 | #define GET_REPORT (0x01) |
| mjr | 37:c5ac4ccf6597 | 42 | #define GET_IDLE (0x02) |
| mjr | 37:c5ac4ccf6597 | 43 | #define GET_PROTOCOL (0x03) |
| mjr | 37:c5ac4ccf6597 | 44 | #define SET_REPORT (0x09) |
| mjr | 37:c5ac4ccf6597 | 45 | #define SET_IDLE (0x0a) |
| mjr | 37:c5ac4ccf6597 | 46 | #define SET_PROTOCOL (0x0b) |
| samux | 1:80ab0d068708 | 47 | |
| samux | 1:80ab0d068708 | 48 | /* HID Class Report Descriptor */ |
| samux | 1:80ab0d068708 | 49 | /* Short items: size is 0, 1, 2 or 3 specifying 0, 1, 2 or 4 (four) bytes */ |
| samux | 1:80ab0d068708 | 50 | /* of data as per HID Class standard */ |
| samux | 1:80ab0d068708 | 51 | |
| samux | 1:80ab0d068708 | 52 | /* Main items */ |
| samux | 1:80ab0d068708 | 53 | #define INPUT(size) (0x80 | size) |
| samux | 1:80ab0d068708 | 54 | #define OUTPUT(size) (0x90 | size) |
| samux | 1:80ab0d068708 | 55 | #define FEATURE(size) (0xb0 | size) |
| samux | 1:80ab0d068708 | 56 | #define COLLECTION(size) (0xa0 | size) |
| samux | 1:80ab0d068708 | 57 | #define END_COLLECTION(size) (0xc0 | size) |
| samux | 1:80ab0d068708 | 58 | |
| samux | 1:80ab0d068708 | 59 | /* Global items */ |
| samux | 1:80ab0d068708 | 60 | #define USAGE_PAGE(size) (0x04 | size) |
| samux | 1:80ab0d068708 | 61 | #define LOGICAL_MINIMUM(size) (0x14 | size) |
| samux | 1:80ab0d068708 | 62 | #define LOGICAL_MAXIMUM(size) (0x24 | size) |
| samux | 1:80ab0d068708 | 63 | #define PHYSICAL_MINIMUM(size) (0x34 | size) |
| samux | 1:80ab0d068708 | 64 | #define PHYSICAL_MAXIMUM(size) (0x44 | size) |
| samux | 1:80ab0d068708 | 65 | #define UNIT_EXPONENT(size) (0x54 | size) |
| samux | 1:80ab0d068708 | 66 | #define UNIT(size) (0x64 | size) |
| samux | 1:80ab0d068708 | 67 | #define REPORT_SIZE(size) (0x74 | size) |
| samux | 1:80ab0d068708 | 68 | #define REPORT_ID(size) (0x84 | size) |
| samux | 1:80ab0d068708 | 69 | #define REPORT_COUNT(size) (0x94 | size) |
| samux | 1:80ab0d068708 | 70 | #define PUSH(size) (0xa4 | size) |
| samux | 1:80ab0d068708 | 71 | #define POP(size) (0xb4 | size) |
| samux | 1:80ab0d068708 | 72 | |
| samux | 1:80ab0d068708 | 73 | /* Local items */ |
| samux | 1:80ab0d068708 | 74 | #define USAGE(size) (0x08 | size) |
| samux | 1:80ab0d068708 | 75 | #define USAGE_MINIMUM(size) (0x18 | size) |
| samux | 1:80ab0d068708 | 76 | #define USAGE_MAXIMUM(size) (0x28 | size) |
| samux | 1:80ab0d068708 | 77 | #define DESIGNATOR_INDEX(size) (0x38 | size) |
| samux | 1:80ab0d068708 | 78 | #define DESIGNATOR_MINIMUM(size) (0x48 | size) |
| samux | 1:80ab0d068708 | 79 | #define DESIGNATOR_MAXIMUM(size) (0x58 | size) |
| samux | 1:80ab0d068708 | 80 | #define STRING_INDEX(size) (0x78 | size) |
| samux | 1:80ab0d068708 | 81 | #define STRING_MINIMUM(size) (0x88 | size) |
| samux | 1:80ab0d068708 | 82 | #define STRING_MAXIMUM(size) (0x98 | size) |
| samux | 1:80ab0d068708 | 83 | #define DELIMITER(size) (0xa8 | size) |
| samux | 1:80ab0d068708 | 84 | |
| samux | 1:80ab0d068708 | 85 | /* HID Report */ |
| samux | 1:80ab0d068708 | 86 | /* Where report IDs are used the first byte of 'data' will be the */ |
| samux | 1:80ab0d068708 | 87 | /* report ID and 'length' will include this report ID byte. */ |
| samux | 1:80ab0d068708 | 88 | |
| samux | 1:80ab0d068708 | 89 | #define MAX_HID_REPORT_SIZE (64) |
| samux | 1:80ab0d068708 | 90 | |
| samux | 1:80ab0d068708 | 91 | typedef struct { |
| samux | 1:80ab0d068708 | 92 | uint32_t length; |
| samux | 1:80ab0d068708 | 93 | uint8_t data[MAX_HID_REPORT_SIZE]; |
| samux | 1:80ab0d068708 | 94 | } HID_REPORT; |
| samux | 1:80ab0d068708 | 95 | |
| samux | 1:80ab0d068708 | 96 | #endif |