Major USB update, fixes most (if not all) known issues

[kiibohd-controller.git] / Output / pjrcUSB / capabilities.kll

diff --git a/Output/pjrcUSB/capabilities.kll b/Output/pjrcUSB/capabilities.kll
index 94a6c206cb041aef99cfa4b74ffcd041deece1c1..ce3504d97bd1d1085d7208f649806b8c477f43de 100644 (file)
--- a/Output/pjrcUSB/capabilities.kll
+++ b/Output/pjrcUSB/capabilities.kll
@@ -4,7 +4,7 @@ Author = "HaaTa (Jacob Alexander) 2014-2016";
 KLL = 0.3d;
 
 # Modified Date
-Date = 2016-03-21;
+Date = 2016-05-31;
 
 
 # Output capabilities
@@ -38,3 +38,64 @@ flashModeEnabled = 0;
 
 flashMode => Output_flashMode_capability();
 
+
+## USB Compatibility Flags ##
+# Some OSs and USB Chipsets have issues with USB features
+# These flags are available to provide ways to debug them
+
+# Enable USB Suspend/Low Power mode
+# After a period of inactivity, the USB host may request that the device go into low power mode
+# This is different than system sleep, though it may occur around the same time
+enableUSBSuspend => enableUSBSuspend_define;
+enableUSBSuspend = 1;
+
+# Enable Low-power Negotiation
+# In order to support low-powered USB hosts, such as an Apple IPad, a low power auto-negotiation scheme has been implemented
+# Unfortunately, badly behaved USB Chipsets and OSs may not work correctly with this support enabled
+# Typical symptoms:
+# * USB constantly re-initializing when first plugging in
+enableUSBLowPowerNegotiation => enableUSBLowPowerNegotiation_define;
+enableUSBLowPowerNegotiation = 0;
+
+# Enable Device Restart on USB Timeout
+# *USE AS LAST RETORT*
+# To work around some USB OS, Chipset and Firwmare bugs, an auto-restart mechanism has been implemented
+# Depending on the situation, this can be rather aggressive.
+# This behaves differently than the Low-power negotiation restart and have very different triggering schemes.
+enableDeviceRestartOnUSBTimeout => enableDeviceRestartOnUSBTimeout_define;
+enableDeviceRestartOnUSBTimeout = 0;
+
+# Enable Host-Resume (wake-from-sleep)
+# On specific actions (such as USB key actions), will trigger the host device to wake if USB is suspended
+enableUSBResume => enableUSBResume_define;
+enableUSBResume = 1;
+
+## USB Endpoint Configuration ##
+# 1 - Enable endpoint
+# 0 - Disable endpoint
+# Any/all endpoints can be disabled
+# But you'll lose functionality for that feature
+# Disabling endpoints will save RAM and Flash on the target MCU
+
+# Joystick Endpoint
+# *Currently Unused*
+enableJoystick => enableJoystick_define;
+enableJoystick = 0;
+
+# Mouse Endpoint
+enableMouse => enableMouse_define;
+enableMouse = 1;
+
+# Keyboard Endpoint
+enableKeyboard => enableKeyboard_define;
+enableKeyboard = 1;
+
+# CDC / Serial Port Endpoint
+enableVirtualSerialPort => enableVirtualSerialPort_define;
+enableVirtualSerialPort = 1;
+
+# Raw I/O Endpoint
+# *Currently Unused*
+enableRawIO => enableRawIO_define;
+enableRawIO = 0;
+