Merge branch 'arpruss-master'

Author: rogerclarkmelbourne

STM32F1/libraries/USBComposite/Digitizer.cpp

@@ -0,0 +1,51 @@
+#include "USBComposite.h"
+
+//================================================================================
+//================================================================================
+//	Mouse
+
+void HIDDigitizer::begin(void){
+}
+
+void HIDDigitizer::end(void){
+}
+
+void HIDDigitizer::move(uint16 x, uint16 y)
+{
+    report.x = x;
+    report.y = y;
+
+    sendReport();
+}
+
+void HIDDigitizer::buttons(uint8_t b)
+{
+	if (b != report.buttons)
+	{
+        report.buttons = b;
+        sendReport();
+	}
+}
+
+void HIDDigitizer::click(uint8_t b)
+{
+    press(b);
+    release(b);
+}
+
+void HIDDigitizer::press(uint8_t b)
+{
+	buttons(report.buttons | b);
+}
+
+void HIDDigitizer::release(uint8_t b)
+{
+	buttons(report.buttons & ~b);
+}
+
+bool HIDDigitizer::isPressed(uint8_t b)
+{
+	if ((b & report.buttons) == b)
+		return true;
+	return false;
+}

STM32F1/libraries/USBComposite/HIDReports.cpp

@@ -9,6 +9,9 @@ REPORT(KeyboardMouseJoystick, HID_MOUSE_REPORT_DESCRIPTOR(), HID_KEYBOARD_REPORT
 REPORT(KeyboardMouse, HID_MOUSE_REPORT_DESCRIPTOR(), HID_KEYBOARD_REPORT_DESCRIPTOR());
 REPORT(Keyboard, HID_KEYBOARD_REPORT_DESCRIPTOR());
 REPORT(Mouse, HID_MOUSE_REPORT_DESCRIPTOR());
+REPORT(AbsMouse, HID_ABS_MOUSE_REPORT_DESCRIPTOR());
 REPORT(KeyboardJoystick, HID_KEYBOARD_REPORT_DESCRIPTOR(), HID_JOYSTICK_REPORT_DESCRIPTOR());
 REPORT(Joystick, HID_JOYSTICK_REPORT_DESCRIPTOR());
 REPORT(BootKeyboard, HID_BOOT_KEYBOARD_REPORT_DESCRIPTOR());
+REPORT(Consumer, HID_CONSUMER_REPORT_DESCRIPTOR());
+REPORT(Digitizer, HID_DIGITIZER_REPORT_DESCRIPTOR());

STM32F1/libraries/USBComposite/MinSysex.c

@@ -39,7 +39,6 @@
 #define STANDARD_ID_RESPONSE_LENGTH 7
 
 #include "usb_midi_device.h"
-#include <libmaple/nvic.h>
 #include <libmaple/delay.h>
 #include <MinSysex.h>
 //#include <wirish/wirish.h>
@@ -129,12 +128,6 @@ volatile int sysexFinger=0;
 #define EXC_RETURN 0xFFFFFFF9
 #define DEFAULT_CPSR 0x61000000
 #define RESET_DELAY 100000
-#if 0
-static void wait_reset(void) {
-    delay_us(RESET_DELAY);
-    nvic_sys_reset();
-}
-#endif
 
 /* -----------------------------------------------------------------------------dealWithItQuickly()
  * Note: at this point we have established that the sysex belongs to us.
@@ -154,36 +147,6 @@ void dealWithItQuickly(){
             }
         case USYSEX_REAL_TIME:
             break;
-#if 0			
-        case LEAFLABS_MMA_VENDOR_1:
-            if (sysexBuffer[5]==LGL_RESET_CMD) {
-                uintptr_t target = (uintptr_t)wait_reset | 0x1;
-                asm volatile("mov r0, %[stack_top]      \n\t" // Reset stack
-                             "mov sp, r0                \n\t"
-                             "mov r0, #1                \n\t"
-                             "mov r1, %[target_addr]    \n\t"
-                             "mov r2, %[cpsr]           \n\t"
-                             "push {r2}                 \n\t" // Fake xPSR
-                             "push {r1}                 \n\t" // PC target addr
-                             "push {r0}                 \n\t" // Fake LR
-                             "push {r0}                 \n\t" // Fake R12
-                             "push {r0}                 \n\t" // Fake R3
-                             "push {r0}                 \n\t" // Fake R2
-                             "push {r0}                 \n\t" // Fake R1
-                             "push {r0}                 \n\t" // Fake R0
-                             "mov lr, %[exc_return]     \n\t"
-                             "bx lr"
-                             :
-                             : [stack_top] "r" (STACK_TOP),
-                             [target_addr] "r" (target),
-                             [exc_return] "r" (EXC_RETURN),
-                             [cpsr] "r" (DEFAULT_CPSR)
-                             : "r0", "r1", "r2");
-                /* Can't happen. */
-                ASSERT_FAULT(0);
-
-            }
-#endif    
         default:
             break;
     }

STM32F1/libraries/USBComposite/README.md

@@ -1,15 +1,17 @@
-# USB Composite library for STM32F1
+# USB Composite library for Roger's Melbourne's STM32F1 core: https://github.com/rogerclarkmelbourne/Arduino_STM32/
 
 ## Protocols supported
 
 - standard USB HID, with many built-in profiles, and customizable with more
 
 - MIDI over USB
 
-- XBox360 controller (only controller-to-host is currently supported)
+- XBox360 wired/wireless controllers
 
 - Mass storage
 
+- USB Audio (unidirectional, but both directions are supported)
+
 ## Basic concepts
 
 Start with:
@@ -30,12 +32,16 @@ Plugin classes included in the library:
 ```
 USBHID
 USBMIDI
-USBXBox360
+USBMultiXBox360<n> / USBXBox360 / USBXBox360W<n>
 USBMassStorage
 USBCompositeSerial
+USBMultiSerial<n>
 ```
 
-To use them, you need to create instances of them. Currently, only one instance of each plugin class
+**NOTE:** Only one of USBMultiXBox360<n> / USBXBox360 / USBXBox360W<n> can be registered at a time:
+they cannot be composited together.
+
+To use the plugins, you need to create instances of them. NOTE: Only one instance of each plugin class
 can be created.
 
 If you want to make a simple (non-composite) USB device, you can create an instance of the plugin class
@@ -50,9 +56,15 @@ plugin2.registerComponent();
 USBComposite.begin();
 ```
 
-Of course, you may need to do some further configuring of the plugins or the `USBComposite` device
+Of course, you may need to do some further configuring of the plugins (e.g., if plugin1 is USBHID, then
+you may want to do `USBHID.setReportDescriptor(HID_KEYBOARD)`) or of the `USBComposite` device
 before the `USBComposite.begin()` call.
 
+After starting up USBComposite, it's a good idea to wait for it to become ready before sending any data:
+```
+while(!USBComposite);
+```
+
 Finally, there are a number of classes that implement particular protocols for the `USBHID` class plugin.
 These are:
 ```
@@ -73,6 +85,19 @@ combinations will be supported by all operating systems.
 I recommend calling `USBComposite.setDeviceId(device)` with a different device number for each combination
 of plugins and profiles to prevent problems with cached configurations on the host computer.
 
+## Uploading with STM32duino bootloader
+
+Normally, the STM32duino bootloader upload method in the Roger Melbourne STM32F1 core sends a command 
+to reset the board via the USB serial port, and thereby put it in bootloader mode, just prior to uploading. 
+If you have installed a sketch that includes a USB serial port in the composite device, this should still
+work. But if the sketch you've installed doesn't include a USB serial port, then you need to manually activate 
+the bootloader mode next time you want to upload a sketch.
+
+The bootloader mode is active for a short period after the board powers up or resets. So just initiate
+the upload in the Arduino IDE as usual, but when "Searching for DFU device [1EAF:0003]" is displayed,
+hit the reset button (or if the device is USB-powered, keep it unplugged from USB and plug it in when you 
+get this message).
+
 ## Simple USB device configuration
 
 A simple USB device uses a single plugin. You need to create an instance of the plugin class,
@@ -83,21 +108,37 @@ to inject keyboard data, you should do:
 USBHID HID; // create instance of USBHID plugin
 HIDKeyboard Keyboard(HID); // create a profile
 
-HID.begin(HID_KEYBOARD);
+HID.begin();
 ```
 
 and then call `Keyboard.print("TextToInject")` to inject keyboard data. Some plugin configurations
 may require further initialization code or further code that needs to be called inside the Arduino
 `loop()` function.
 
-See the `BootKeyboard`, `midiout` and `x360` example code for this procedure.
+See the `BootKeyboard`, `midiout` and `x360` example code for variants on this procedure.
 
 (Additionally, the `USBHID` plugin has a convenience `begin()` method that lets you include an
 instance of a `USBCompositeSerial` plugin class, and that creates a composite HID-Serial device.)
 
 However, if you want a USB device using more than one plugin, then you will NOT call the plugin's
 `begin()` method.
 
+Note that a single HID plugin can support a device with multiple report profiles including a keyboard, several joysticks,
+a mouse, etc.:
+```
+USBHID HID; // create instance of USBHID plugin
+HIDKeyboard Keyboard(HID); // create a profile
+HIDJoystick Joystick1(HID); // create a profile
+HIDJoystick Joystick2(HID); // create a profile
+HIDMouse Mouse(HID); // create a profile
+
+HID.begin();
+```
+
+Each of the profiles (e.g., Joystick1) contributes a part of the HID report descriptor to USBHID which automatically stitches
+them together and assigns report IDs. However, you can also make a single overarching custom HID report descriptor and include 
+it in the HID.begin() call. The `softjoystick` example does this.
+
 ## Memory limitations
 
 There are 320 bytes of hardware buffer memory available after endpoint 0 is taken into account. The following 
@@ -132,25 +173,32 @@ MIDI.setTXPacketSize(size);
 ```
 The maximum and default packet size is 64. Smaller packet sizes have not been thoroughly tested and may slow things down. In 
 particular, for HID you should make sure your packet size is sufficient for your largest HID report. The CompositeSerial 
-device also has a control channel whose 16 byte packet size is not adjustable.
+device also has a control channel whose 16 byte packet size is not adjustable. Note that for reasons that I do not currently
+understand, CompositeSerial RX packets must be a power of two in size.
 
-Note that in the above, RX and TX are from the point of view of the MCU, not the host (i.e., RX corresponds to USB Out and TX
+Note also that in the above, RX and TX are from the point of view of the MCU, not the host (i.e., RX corresponds to USB Out and TX
 to USB In).
 
 ## Endpoint limitations
 
-There is one bidirectional endpoint 0 that all endpoints share, and the hardware allows for seven more. Here are 
-how many endpoints besides endpoint 0 are needed for each plugin:
+There is one bidirectional endpoint 0 that all endpoints share, and the hardware allows for seven more in each direction,
+but there are some complications in that the same endpoint number when used in different directions must have some
+of the same parameters. The USBComposite library takes care of these complications when allocating endpoints, but if you
+have too many plugins, you USBComposite.begin() will return `false` to indicate that you've used up too many.
+
+This is pretty complicated, but a rule of thumb for having enough endpoints is to make sure that when you add up the 
+following contributions for the plugins you use, your total is at most seven.
+
+* USB Serial: 2 (= 2 TX, 1 RX)
 
-* USB Serial: 3
+* USB HID: 1 (= 1 TX)
 
-* USB HID: 1
+* USB Mass Storage: 1 (= 1 TX, 1 RX)
 
-* USB Mass Storage: 2
+* USB MIDI: 1 (= 1 TX, 1 RX)
 
-* USB MIDI: 2
+* XBox360 Controller: 1 per controller (= 1 TX, 1 RX)
 
-* XBox360 Controller: 2
+* USB Audio: 1 (= 1 TX or 1 RX depending on mode)
 
-When combining plugins, make sure the count of these endpoints does not exceed 7. For instance, USB Serial + USB Mass Storage + 
-USB MIDI + USB HID adds up to 8, which is too much.
+* USB Multi Serial: 2 per port (= 2 TX, 1 RX)

STM32F1/libraries/USBComposite/UPGRADING-TO-0.90.txt

@@ -1,19 +1,19 @@
-Version 0.90 of the library has changed the API significantly in order to save flash and RAM.
-The main change is that other than USBComposite, all pre-declared object instances have been
-removed.
-
-When upgrading to 0.90 or higher, you will have to make a number of changes to your code.
-
-1. Use a single include file instead of USBHID.h, USBMIDI.h, etc.:
-    #include <USBComposite.h>
-    
-2. Declare all instances other than USBComposite. This includes instances of plugin classes
-   like USBHID as well as of HID profiles like HIDKeyboard (which need an instance of USBHID).
-   
-3. Note that USBHID is now a class (for consistency with other class names) and there is no
-   USBHID instance. You need to declare an instance, e.g.:
-    USBHID HID;
-   and replace calls to USBHID.* with calls to HID.*.
-
-4. Replace USBHID_begin_with_serial(...) with HID.begin(CompositeSerial,...) where HID is your
+Version 0.90 of the library has changed the API significantly in order to save flash and RAM.
+The main change is that other than USBComposite, all pre-declared object instances have been
+removed.
+
+When upgrading to 0.90 or higher, you will have to make a number of changes to your code.
+
+1. Use a single include file instead of USBHID.h, USBMIDI.h, etc.:
+    #include <USBComposite.h>
+    
+2. Declare all instances other than USBComposite. This includes instances of plugin classes
+   like USBHID as well as of HID profiles like HIDKeyboard (which need an instance of USBHID).
+   
+3. Note that USBHID is now a class (for consistency with other class names) and there is no
+   USBHID instance. You need to declare an instance, e.g.:
+    USBHID HID;
+   and replace calls to USBHID.* with calls to HID.*.
+
+4. Replace USBHID_begin_with_serial(...) with HID.begin(CompositeSerial,...) where HID is your
    instance of USBHID.