Don't make led_driver_state_t members volatile. Uncomment the body of LedSlaveDriver_EnableLeds()

Extend the behavior of keys upon layer changes to keymap changes

CHANGELOG.md

@@ -5,6 +5,42 @@ All notable changes to this project will be documented in this file.
 The format is loosely based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to the [UHK Versioning](VERSIONING.md) conventions.
 
+## [8.5.3] - 2018-10-20
+
+Device Protocol: 4.5.0 | Module Protocol: 4.0.0 | User Config: 4.1.0 | Hardware Config: 1.0.0
+
+- Re-enable the I2C watchdog of the left keyboard half which was accidentally disabled starting from firmware 8.4.3. This should fix the freezes of the left keyboard half.
+
+## [8.5.2] - 2018-10-06
+
+Device Protocol: 4.5.0 | Module Protocol: 4.0.0 | User Config: 4.1.0 | Hardware Config: 1.0.0
+
+- Don't suppress keys upon keymap change.
+
+## [8.5.1] - 2018-10-04
+
+Device Protocol: 4.5.0 | Module Protocol: 4.0.0 | User Config: 4.1.0 | Hardware Config: 1.0.0
+
+- Reset UsbReportUpdateSemaphore if it gets stuck for 100ms. This should fix occasional freezes.
+
+## [8.5.0] - 2018-10-04
+
+Device Protocol: 4.**5.0** | Module Protocol: 4.0.0 | User Config: 4.1.0 | Hardware Config: 1.0.0
+
+- Send primary role modifiers consistently.
+- Only allow layer switcher keys to deactivate toggled layers.
+- Deactivate secondary roles when switching keymaps.
+- Use the correct scancode so that commas are outputted for macros.
+- Move the pointer not by 1 but by 5 pixels when testing the USB stack to make the pointer easier to see.
+- Expose UsbReportUpdateSemaphore via UsbCommand_{Get,Set}Variable() `DEVICEPROTOCOL:MINOR`
+- Extract CurrentTime and remove Timer_{Get,Set}CurrentTime()
+
+## [8.4.5] - 2018-08-21
+
+Device Protocol: 4.4.0 | Module Protocol: 4.0.0 | User Config: 4.1.0 | Hardware Config: 1.0.0
+
+- Suppress pressed keys when the layer or keymap changes.
+
 ## [8.4.4] - 2018-08-14
 
 Device Protocol: 4.4.0 | Module Protocol: 4.0.0 | User Config: 4.1.0 | Hardware Config: 1.0.0

ISSUE_TEMPLATE

@@ -0,0 +1,8 @@
+Before submitting a new issue, make sure to do the following:
+
+1. If you're using Karabiner Elements on your Mac, close it!
+2. Install the latest Agent:
+   https://github.com/UltimateHackingKeyboard/agent/releases/latest
+3. Use Agent to update to the latest firmware:
+   https://github.com/UltimateHackingKeyboard/firmware/releases/latest
+4. Try to reproduce the issue, and only report it if it still persists.

README.md

@@ -12,19 +12,15 @@ If you're one of the brave few who wants to hack the firmware then read on.
 
 `git clone --recursive git@github.com:UltimateHackingKeyboard/firmware.git`
 
-2. Download and install MCUXpresso IDE for [Linux](https://storage.googleapis.com/ugl-static/mcuxpresso-ide/mcuxpressoide-10.1.1_606.x86_64.deb.bin), [Mac](https://storage.googleapis.com/ugl-static/mcuxpresso-ide/MCUXpressoIDE_10.1.1_606.pkg), or [Windows](https://storage.googleapis.com/ugl-static/mcuxpresso-ide/MCUXpressoIDE_10.1.1_606.exe).
+2. Download and install MCUXpresso IDE for [Linux](https://storage.googleapis.com/ugl-static/mcuxpresso-ide/mcuxpressoide-10.2.1_795.x86_64.deb.bin), [Mac](https://storage.googleapis.com/ugl-static/mcuxpresso-ide/MCUXpressoIDE_10.2.1_795.pkg), or [Windows](https://storage.googleapis.com/ugl-static/mcuxpresso-ide/MCUXpressoIDE_10.2.1_795.exe).
 
 3. In the IDE, import the project by invoking *File -> Import -> General -> Existing Projects into Workspace*, select the *left* or *right* directory depending on the desired firmware, then click on the *Finish* button.
 
-## Building and flashing the firmware
+4. In order to be able to flash the firmware via USB from the IDE, you must build [Agent](https://github.com/UltimateHackingKeyboard/agent) which is Git submodule of the this repo and located in the `lib/agent` directory.
 
-For the left keyboard half, make sure to power it via the right keyboard half (which must be powered via USB). Also connect the left keyboard half to your SEGGER J-Link USB debug probe (which must also be connected via USB). Then in KDS, click on *Run -> Run Configurations*, select *GDB SEGGER J-Link Debugging -> uhk60-left_release_jlink*, and click on the *Debug* button.
+5. Finally, in the IDE, click on *Run -> External Tools -> External Tools Configurations*, then select a release firmware to be flashed such as *uhk60-right_release_kboot*, and click on the *Run* button.
 
-For the right keyboard half, flash [the bootloader](https://github.com/UltimateHackingKeyboard/bootloader) first.
-
-At this point, you can flash the right firmware via USB from KDS. To achieve this, you must build [Agent](https://github.com/UltimateHackingKeyboard/agent) that is Git submodule of the this repo and located in the `lib/agent` directory.  Then in KDS, click on *Run -> Run Configurations*, select *C/C++ Application -> uhk60-right_release_kboot*, and click on the *Run* button.
-
-From this point on, you can upgrade the firmwares of both halves via USB by using the uhk60-left_release_kboot and uhk60-right_release_kboot run configurations. Alternatively, you can use your SEGGER J-Link probe.
+Going forward, it's easier to flash the firmware of your choice by using the downwards toolbar icon which is located rightwards of the *green play + toolbox icon*.
 
 ## Contributing
 

left/src/key_scanner.c

@@ -5,9 +5,7 @@
 void KEY_SCANNER_HANDLER(void)
 {
     KeyMatrix_ScanRow(&keyMatrix);
-#ifdef I2C_WATCHDOG
     RunWatchdog();
-#endif
     LPTMR_ClearStatusFlags(KEY_SCANNER_LPTMR_BASEADDR, kLPTMR_TimerCompareFlag);
 }
 

right/src/config_parser/parse_config.c

@@ -146,8 +146,6 @@ parser_error_t ParseConfig(config_buffer_t *buffer)
         AlphanumericSegmentsBrightness = alphanumericSegmentsBrightness;
         KeyBacklightBrightness = keyBacklightBrightness;
 
-        LedSlaveDriver_UpdateLeds();
-
         // Update mouse key speeds
 
         MouseMoveState.initialSpeed = mouseMoveInitialSpeed;

right/src/layer.c

@@ -15,7 +15,7 @@ void updateLayerStates(void)
     for (uint8_t slotId=0; slotId<SLOT_COUNT; slotId++) {
         for (uint8_t keyId=0; keyId<MAX_KEY_COUNT_PER_MODULE; keyId++) {
             key_state_t *keyState = &KeyStates[slotId][keyId];
-            if (keyState->current) {
+            if (keyState->current && !keyState->suppressed) {
                 key_action_t action = CurrentKeymap[LayerId_Base][slotId][keyId];
                 if (action.type == KeyActionType_SwitchLayer) {
                     if (action.switchLayer.mode != SwitchLayerMode_Toggle) {

right/src/led_display.c

@@ -84,6 +84,7 @@ void LedDisplay_SetText(uint8_t length, const char* text)
         }
         allSegmentSets >>= 5;
     }
+    LedSlaveDriver_UpdateLeds(LedDriverId_Left);
 }
 
 void LedDisplay_SetLayer(layer_id_t layerId)
@@ -95,6 +96,7 @@ void LedDisplay_SetLayer(layer_id_t layerId)
     if (layerId >= LayerId_Mod && layerId <= LayerId_Mouse) {
         LedDriverValues[LedDriverId_Left][16 * layerId - 3] = IconsAndLayerTextsBrightness;
     }
+    LedSlaveDriver_UpdateLeds(LedDriverId_Left);
 }
 
 bool LedDisplay_GetIcon(led_display_icon_t icon)
@@ -106,6 +108,7 @@ void LedDisplay_SetIcon(led_display_icon_t icon, bool isEnabled)
 {
     ledIconStates[icon] = isEnabled;
     LedDriverValues[LedDriverId_Left][icon + 8] = isEnabled ? IconsAndLayerTextsBrightness : 0;
+    LedSlaveDriver_UpdateLeds(LedDriverId_Left);
 }
 
 void LedDisplay_UpdateIcons(void)

right/src/macros.c

@@ -70,7 +70,7 @@ uint8_t characterToScancode(char character)
             return HID_KEYBOARD_SC_DOT_AND_GREATER_THAN_SIGN;
         case ',':
         case '<':
-            return HID_KEYBOARD_SC_KEYPAD_LESS_THAN_SIGN;
+            return HID_KEYBOARD_SC_COMMA_AND_LESS_THAN_SIGN;
         case '/':
         case '\?':
             return HID_KEYBOARD_SC_SLASH_AND_QUESTION_MARK;
@@ -286,7 +286,7 @@ bool processDelayAction(void)
             inDelay = false;
         }
     } else {
-        Timer_SetCurrentTime(&delayStart);
+        delayStart = CurrentTime;
         inDelay = true;
     }
     return inDelay;

right/src/peripherals/led_driver.h

@@ -16,8 +16,13 @@
     #define LED_DRIVER_SDB_CLOCK kCLOCK_PortA
     #define LED_DRIVER_SDB_PIN   2
 
-    #define LED_DRIVER_REGISTER_SHUTDOWN 0x0A
-    #define LED_DRIVER_REGISTER_FRAME    0xFD
+    #define LED_DRIVER_REGISTER_SHUTDOWN            0x0A
+    #define LED_DRIVER_REGISTER_FRAME               0xFD
+    #define LED_DRIVER_REGISTER_CONFIGURATION       0x00
+    #define LED_DRIVER_REGISTER_AUTO_PLAY_CONTROL_1 0x02
+    #define LED_DRIVER_REGISTER_AUTO_PLAY_CONTROL_2 0x03
+    #define LED_DRIVER_REGISTER_BREATH_CONTROL_1    0x08
+    #define LED_DRIVER_REGISTER_BREATH_CONTROL_2    0x09
 
     #define LED_DRIVER_FRAME_1 0
     #define LED_DRIVER_FRAME_2 1
@@ -42,6 +47,25 @@
     #define SHUTDOWN_MODE_SHUTDOWN 0
     #define SHUTDOWN_MODE_NORMAL   1
 
+    #define DISPLAY_MODE_AUTO_FRAME_PLAY 0b01
+    #define DISPLAY_MODE_SHIFT 3
+    #define FRAME_START_1 0b000
+    #define FRAME_START_8 0b111
+
+    #define PLAY_LOOP_NUMBER_1 0b001
+    #define PLAY_LOOP_NUMBER_SHIFT 4
+    #define PLAY_FRAME_NUMBER_1 0b001
+
+    #define FRAME_DELAY_TIME 1
+
+    #define FADE_OUT_TIME 5
+    #define FADE_OUT_TIME_SHIFT 4
+    #define FADE_IN_TIME 5
+
+    #define BREATH_ENABLE 1
+    #define BREATH_ENABLE_SHIFT 4
+    #define EXTINGUISH_TIME 0
+
 // Functions:
 
     void InitLedDriver(void);

right/src/slave_drivers/is31fl3731_driver.c

@@ -60,22 +60,48 @@ static led_driver_state_t ledDriverStates[LED_DRIVER_MAX_COUNT] = {
 static uint8_t setFunctionFrameBuffer[] = {LED_DRIVER_REGISTER_FRAME, LED_DRIVER_FRAME_FUNCTION};
 static uint8_t setShutdownModeNormalBuffer[] = {LED_DRIVER_REGISTER_SHUTDOWN, SHUTDOWN_MODE_NORMAL};
 static uint8_t setFrame1Buffer[] = {LED_DRIVER_REGISTER_FRAME, LED_DRIVER_FRAME_1};
+static uint8_t setFrame2Buffer[] = {LED_DRIVER_REGISTER_FRAME, LED_DRIVER_FRAME_2};
+static uint8_t setFrame8Buffer[] = {LED_DRIVER_REGISTER_FRAME, LED_DRIVER_FRAME_8};
+static uint8_t initLedControlRegistersZeroBuffer[19] = { FRAME_REGISTER_LED_CONTROL_FIRST };
+static uint8_t setConfigurationRegisterFadeInBuffer[] = {
+    LED_DRIVER_REGISTER_CONFIGURATION,
+    DISPLAY_MODE_AUTO_FRAME_PLAY << DISPLAY_MODE_SHIFT | FRAME_START_8
+};
+static uint8_t setConfigurationRegisterFadeOutBuffer[] = {
+    LED_DRIVER_REGISTER_CONFIGURATION,
+    DISPLAY_MODE_AUTO_FRAME_PLAY << DISPLAY_MODE_SHIFT | FRAME_START_1
+};
+static uint8_t initAutoPlayControlRegister1Buffer[] = {
+    LED_DRIVER_REGISTER_AUTO_PLAY_CONTROL_1,
+    PLAY_LOOP_NUMBER_1 << PLAY_LOOP_NUMBER_SHIFT | PLAY_FRAME_NUMBER_1
+};
+static uint8_t initAutoPlayControlRegister2Buffer[] = {
+    LED_DRIVER_REGISTER_AUTO_PLAY_CONTROL_2,
+    FRAME_DELAY_TIME
+};
+static uint8_t initBreathControlRegister1Buffer[] = {
+    LED_DRIVER_REGISTER_BREATH_CONTROL_1,
+    FADE_OUT_TIME << FADE_OUT_TIME_SHIFT | FADE_IN_TIME
+};
+static uint8_t initBreathControlRegister2Buffer[] = {
+    LED_DRIVER_REGISTER_BREATH_CONTROL_2,
+    BREATH_ENABLE << BREATH_ENABLE_SHIFT | EXTINGUISH_TIME
+};
 static uint8_t updatePwmRegistersBuffer[PWM_REGISTER_BUFFER_LENGTH];
 
-void LedSlaveDriver_DisableLeds(void)
+void LedSlaveDriver_DisableLeds(uint8_t ledDriverId)
 {
-    for (uint8_t ledDriverId=0; ledDriverId<=LedDriverId_Last; ledDriverId++) {
-        memset(LedDriverValues[ledDriverId], 0, LED_DRIVER_LED_COUNT);
-    }
+    ledDriverStates[ledDriverId].requests[LedDriverRequest_DisableLeds] = true;
 }
 
-void LedSlaveDriver_UpdateLeds(void)
+void LedSlaveDriver_EnableLeds(uint8_t ledDriverId)
 {
-    for (uint8_t ledDriverId=0; ledDriverId<=LedDriverId_Last; ledDriverId++) {
-        memset(LedDriverValues[ledDriverId], KeyBacklightBrightness, LED_DRIVER_LED_COUNT);
-    }
+    ledDriverStates[ledDriverId].requests[LedDriverRequest_EnableLeds] = true;
+}
 
-    LedDisplay_UpdateAll();
+void LedSlaveDriver_UpdateLeds(uint8_t ledDriverId)
+{
+    ledDriverStates[ledDriverId].requests[LedDriverRequest_UpdateLeds] = true;
 }
 
 void LedSlaveDriver_Init(uint8_t ledDriverId)
@@ -85,13 +111,9 @@ void LedSlaveDriver_Init(uint8_t ledDriverId)
     }
 
     led_driver_state_t *currentLedDriverState = ledDriverStates + ledDriverId;
-    currentLedDriverState->phase = LedDriverPhase_SetFunctionFrame;
     currentLedDriverState->ledIndex = 0;
     memset(LedDriverValues[ledDriverId], KeyBacklightBrightness, LED_DRIVER_LED_COUNT);
-
-    if (ledDriverId == LedDriverId_Left) {
-        LedDisplay_UpdateAll();
-    }
+    ledDriverStates[ledDriverId].requests[LedDriverRequest_Init] = true;
 }
 
 status_t LedSlaveDriver_Update(uint8_t ledDriverId)
@@ -99,31 +121,62 @@ status_t LedSlaveDriver_Update(uint8_t ledDriverId)
     status_t status = kStatus_Uhk_IdleSlave;
     uint8_t *ledValues = LedDriverValues[ledDriverId];
     led_driver_state_t *currentLedDriverState = ledDriverStates + ledDriverId;
-    uint8_t *ledDriverPhase = &currentLedDriverState->phase;
     uint8_t ledDriverAddress = currentLedDriverState->i2cAddress;
     uint8_t *ledIndex = &currentLedDriverState->ledIndex;
 
-    switch (*ledDriverPhase) {
-        case LedDriverPhase_SetFunctionFrame:
+    switch (currentLedDriverState->phase) {
+        case LedDriverPhase_SetFunctionFrameInit:
             if (ledDriverId == LedDriverId_Left && !Slaves[SlaveId_LeftKeyboardHalf].isConnected) {
                 break;
             }
             status = I2cAsyncWrite(ledDriverAddress, setFunctionFrameBuffer, sizeof(setFunctionFrameBuffer));
-            *ledDriverPhase = LedDriverPhase_SetShutdownModeNormal;
+            currentLedDriverState->phase = LedDriverPhase_SetShutdownModeNormalInit;
             break;
-        case LedDriverPhase_SetShutdownModeNormal:
+        case LedDriverPhase_SetShutdownModeNormalInit:
             status = I2cAsyncWrite(ledDriverAddress, setShutdownModeNormalBuffer, sizeof(setShutdownModeNormalBuffer));
-            *ledDriverPhase = LedDriverPhase_SetFrame1;
+            currentLedDriverState->phase = LedDriverPhase_InitAutoPlayControlRegister1Init;
             break;
-        case LedDriverPhase_SetFrame1:
+        case LedDriverPhase_InitAutoPlayControlRegister1Init:
+            status = I2cAsyncWrite(ledDriverAddress, initAutoPlayControlRegister1Buffer, sizeof(initAutoPlayControlRegister1Buffer));
+            currentLedDriverState->phase = LedDriverPhase_InitAutoPlayControlRegister2Init;
+            break;
+        case LedDriverPhase_InitAutoPlayControlRegister2Init:
+            status = I2cAsyncWrite(ledDriverAddress, initAutoPlayControlRegister2Buffer, sizeof(initAutoPlayControlRegister2Buffer));
+            currentLedDriverState->phase = LedDriverPhase_InitBreathControlRegister1Init;
+            break;
+        case LedDriverPhase_InitBreathControlRegister1Init:
+            status = I2cAsyncWrite(ledDriverAddress, initBreathControlRegister1Buffer, sizeof(initBreathControlRegister1Buffer));
+            currentLedDriverState->phase = LedDriverPhase_InitBreathControlRegister2Init;
+            break;
+        case LedDriverPhase_InitBreathControlRegister2Init:
+            status = I2cAsyncWrite(ledDriverAddress, initBreathControlRegister2Buffer, sizeof(initBreathControlRegister2Buffer));
+            currentLedDriverState->phase = LedDriverPhase_SetFrame2Init;
+            break;
+        case LedDriverPhase_SetFrame2Init:
+            status = I2cAsyncWrite(ledDriverAddress, setFrame2Buffer, sizeof(setFrame2Buffer));
+            currentLedDriverState->phase = LedDriverPhase_InitLedControlRegistersZero1Init;
+            break;
+        case LedDriverPhase_InitLedControlRegistersZero1Init:
+            status = I2cAsyncWrite(ledDriverAddress, initLedControlRegistersZeroBuffer, sizeof(initLedControlRegistersZeroBuffer));
+            currentLedDriverState->phase = LedDriverPhase_SetFrame8Init;
+            break;
+        case LedDriverPhase_SetFrame8Init:
+            status = I2cAsyncWrite(ledDriverAddress, setFrame8Buffer, sizeof(setFrame8Buffer));
+            currentLedDriverState->phase = LedDriverPhase_InitLedControlRegistersZero2Init;
+            break;
+        case LedDriverPhase_InitLedControlRegistersZero2Init:
+            status = I2cAsyncWrite(ledDriverAddress, initLedControlRegistersZeroBuffer, sizeof(initLedControlRegistersZeroBuffer));
+            currentLedDriverState->phase = LedDriverPhase_SetFrame1Init;
+            break;
+        case LedDriverPhase_SetFrame1Init:
             status = I2cAsyncWrite(ledDriverAddress, setFrame1Buffer, sizeof(setFrame1Buffer));
-            *ledDriverPhase = LedDriverPhase_InitLedControlRegisters;
+            currentLedDriverState->phase = LedDriverPhase_InitLedControlRegistersInit;
             break;
-        case LedDriverPhase_InitLedControlRegisters:
+        case LedDriverPhase_InitLedControlRegistersInit:
             status = I2cAsyncWrite(ledDriverAddress, currentLedDriverState->setupLedControlRegistersCommand, LED_CONTROL_REGISTERS_COMMAND_LENGTH);
-            *ledDriverPhase = LedDriverPhase_InitLedValues;
+            currentLedDriverState->phase = LedDriverPhase_InitLedValuesInit;
             break;
-        case LedDriverPhase_InitLedValues:
+        case LedDriverPhase_InitLedValuesInit:
             updatePwmRegistersBuffer[0] = FRAME_REGISTER_PWM_FIRST + *ledIndex;
             uint8_t chunkSize = MIN(LED_DRIVER_LED_COUNT - *ledIndex, PMW_REGISTER_UPDATE_CHUNK_SIZE);
             memcpy(updatePwmRegistersBuffer+1, ledValues + *ledIndex, chunkSize);
@@ -132,10 +185,35 @@ status_t LedSlaveDriver_Update(uint8_t ledDriverId)
             if (*ledIndex >= LED_DRIVER_LED_COUNT) {
                 *ledIndex = 0;
                 memcpy(currentLedDriverState->targetLedValues, ledValues, LED_DRIVER_LED_COUNT);
-                *ledDriverPhase = LedDriverPhase_UpdateChangedLedValues;
+                currentLedDriverState->phase = LedDriverPhase_Idle;
             }
             break;
-        case LedDriverPhase_UpdateChangedLedValues: {
+        case LedDriverPhase_Idle: {
+            uint8_t i;
+
+            for (i = 0; i <= LedDriverRequest_Last; i++) {
+                if (currentLedDriverState->requests[i]) {
+                    currentLedDriverState->requests[i] = false;
+                    break;
+                }
+            }
+            switch (i) {
+                case LedDriverRequest_Init:
+                    currentLedDriverState->phase = LedDriverPhase_SetFunctionFrameInit;
+                    break;
+                case LedDriverRequest_EnableLeds:
+                    currentLedDriverState->phase = LedDriverPhase_SetFunctionFrameEnableLeds;
+                    break;
+                case LedDriverRequest_DisableLeds:
+                    currentLedDriverState->phase = LedDriverPhase_SetFunctionFrameDisableLeds;
+                    break;
+                case LedDriverRequest_UpdateLeds:
+                    currentLedDriverState->phase = LedDriverPhase_UpdateChangedLedValuesUpdateLeds;
+                    break;
+            }
+            break;
+        }
+        case LedDriverPhase_UpdateChangedLedValuesUpdateLeds: {
             uint8_t *targetLedValues = currentLedDriverState->targetLedValues;
 
             uint8_t lastLedChunkStartIndex = LED_DRIVER_LED_COUNT - PMW_REGISTER_UPDATE_CHUNK_SIZE;
@@ -155,6 +233,7 @@ status_t LedSlaveDriver_Update(uint8_t ledDriverId)
             bool foundStartIndex = count < LED_DRIVER_LED_COUNT;
             if (!foundStartIndex) {
                 *ledIndex = 0;
+                currentLedDriverState->phase = LedDriverPhase_Idle;
                 break;
             }
 
@@ -175,9 +254,34 @@ status_t LedSlaveDriver_Update(uint8_t ledDriverId)
             *ledIndex += length;
             if (*ledIndex >= LED_DRIVER_LED_COUNT) {
                 *ledIndex = 0;
+                currentLedDriverState->phase = LedDriverPhase_Idle;
             }
             break;
         }
+        case LedDriverPhase_SetFunctionFrameDisableLeds:
+            status = I2cAsyncWrite(ledDriverAddress, setFunctionFrameBuffer, sizeof(setFunctionFrameBuffer));
+            currentLedDriverState->phase = LedDriverPhase_SetConfigurationRegisterDisableLeds;
+            break;
+        case LedDriverPhase_SetConfigurationRegisterDisableLeds:
+            status = I2cAsyncWrite(ledDriverAddress, setConfigurationRegisterFadeOutBuffer, sizeof(setConfigurationRegisterFadeOutBuffer));
+            currentLedDriverState->phase = LedDriverPhase_SetFrame1DisableLeds;
+            break;
+        case LedDriverPhase_SetFrame1DisableLeds:
+            status = I2cAsyncWrite(ledDriverAddress, setFrame1Buffer, sizeof(setFrame1Buffer));
+            currentLedDriverState->phase = LedDriverPhase_Idle;
+            break;
+        case LedDriverPhase_SetFunctionFrameEnableLeds:
+            status = I2cAsyncWrite(ledDriverAddress, setFunctionFrameBuffer, sizeof(setFunctionFrameBuffer));
+            currentLedDriverState->phase = LedDriverPhase_SetConfigurationRegisterEnableLeds;
+            break;
+        case LedDriverPhase_SetConfigurationRegisterEnableLeds:
+            status = I2cAsyncWrite(ledDriverAddress, setConfigurationRegisterFadeInBuffer, sizeof(setConfigurationRegisterFadeInBuffer));
+            currentLedDriverState->phase = LedDriverPhase_SetFrame1EnableLeds;
+            break;
+        case LedDriverPhase_SetFrame1EnableLeds:
+            status = I2cAsyncWrite(ledDriverAddress, setFrame1Buffer, sizeof(setFrame1Buffer));
+            currentLedDriverState->phase = LedDriverPhase_Idle;
+            break;
     }
 
     return status;

right/src/slave_drivers/is31fl3731_driver.h

@@ -20,6 +20,14 @@
 
 // Typedefs:
 
+    enum {
+        LedDriverRequest_Init,
+        LedDriverRequest_EnableLeds,
+        LedDriverRequest_DisableLeds,
+        LedDriverRequest_UpdateLeds,
+        LedDriverRequest_Last = LedDriverRequest_UpdateLeds
+    };
+
     typedef enum {
         LedDriverId_Right,
         LedDriverId_Left,
@@ -27,15 +35,31 @@
     } led_driver_id_t;
 
     typedef enum {
-        LedDriverPhase_SetFunctionFrame,
-        LedDriverPhase_SetShutdownModeNormal,
-        LedDriverPhase_SetFrame1,
-        LedDriverPhase_InitLedControlRegisters,
-        LedDriverPhase_InitLedValues,
-        LedDriverPhase_UpdateChangedLedValues,
+        LedDriverPhase_Idle,
+        LedDriverPhase_SetFunctionFrameInit,
+        LedDriverPhase_SetFunctionFrameDisableLeds,
+        LedDriverPhase_SetFunctionFrameEnableLeds,
+        LedDriverPhase_SetShutdownModeNormalInit,
+        LedDriverPhase_SetFrame1Init,
+        LedDriverPhase_SetFrame1EnableLeds,
+        LedDriverPhase_SetFrame1DisableLeds,
+        LedDriverPhase_SetFrame2Init,
+        LedDriverPhase_SetFrame8Init,
+        LedDriverPhase_InitAutoPlayControlRegister1Init,
+        LedDriverPhase_InitAutoPlayControlRegister2Init,
+        LedDriverPhase_InitBreathControlRegister1Init,
+        LedDriverPhase_InitBreathControlRegister2Init,
+        LedDriverPhase_InitLedControlRegistersZero1Init,
+        LedDriverPhase_InitLedControlRegistersZero2Init,
+        LedDriverPhase_InitLedValuesInit,
+        LedDriverPhase_UpdateChangedLedValuesUpdateLeds,
+        LedDriverPhase_SetConfigurationRegisterDisableLeds,
+        LedDriverPhase_SetConfigurationRegisterEnableLeds,
+        LedDriverPhase_InitLedControlRegistersInit
     } led_driver_phase_t;
 
     typedef struct {
+        bool requests[LedDriverRequest_Last + 1];
         led_driver_phase_t phase;
         uint8_t targetLedValues[LED_DRIVER_LED_COUNT];
         uint8_t ledIndex;
@@ -50,8 +74,9 @@
 
 // Functions:
 
-    void LedSlaveDriver_DisableLeds(void);
-    void LedSlaveDriver_UpdateLeds(void);
+    void LedSlaveDriver_DisableLeds(uint8_t ledDriverId);
+    void LedSlaveDriver_EnableLeds(uint8_t ledDriverId);
+    void LedSlaveDriver_UpdateLeds(uint8_t ledDriverId);
     void LedSlaveDriver_Init(uint8_t ledDriverId);
     status_t LedSlaveDriver_Update(uint8_t ledDriverId);
 

right/src/timer.c

@@ -2,12 +2,13 @@
 #include "timer.h"
 #include "peripherals/test_led.h"
 
+volatile uint32_t CurrentTime;
 static uint32_t timerClockFrequency;
-static volatile uint32_t currentTime, delayLength;
+static volatile uint32_t delayLength;
 
 void PIT_TIMER_HANDLER(void)
 {
-    currentTime++;
+    CurrentTime++;
     if (delayLength) {
         --delayLength;
     }
@@ -28,15 +29,11 @@ void Timer_Init(void)
     PIT_StartTimer(PIT, PIT_TIMER_CHANNEL);
 }
 
-uint32_t Timer_GetCurrentTime() {
-    return currentTime;
-}
-
 uint32_t Timer_GetCurrentTimeMicros() {
     uint32_t primask, count, ms;
     primask = DisableGlobalIRQ(); // Make sure the read is atomic
     count = PIT_GetCurrentTimerCount(PIT, PIT_TIMER_CHANNEL); // Read the current timer count
-    ms = currentTime; // Read the overflow counter
+    ms = CurrentTime; // Read the overflow counter
     EnableGlobalIRQ(primask); // Enable interrupts again if they where enabled before - this should make it interrupt safe
 
     // Calculate the counter value in microseconds - note that the PIT timer is counting downward, so we need to subtract the count from the period value
@@ -44,11 +41,6 @@ uint32_t Timer_GetCurrentTimeMicros() {
     return ms * 1000U * TIMER_INTERVAL_MSEC + us;
 }
 
-void Timer_SetCurrentTime(uint32_t *time)
-{
-    *time = Timer_GetCurrentTime();
-}
-
 void Timer_SetCurrentTimeMicros(uint32_t *time)
 {
     *time = Timer_GetCurrentTimeMicros();
@@ -56,20 +48,18 @@ void Timer_SetCurrentTimeMicros(uint32_t *time)
 
 uint32_t Timer_GetElapsedTime(uint32_t *time)
 {
-    uint32_t elapsedTime = Timer_GetCurrentTime() - *time;
-    return elapsedTime;
+    return CurrentTime - *time;
 }
 
 uint32_t Timer_GetElapsedTimeMicros(uint32_t *time)
 {
-    uint32_t elapsedTime = Timer_GetCurrentTimeMicros() - *time;
-    return elapsedTime;
+    return Timer_GetCurrentTimeMicros() - *time;
 }
 
 uint32_t Timer_GetElapsedTimeAndSetCurrent(uint32_t *time)
 {
     uint32_t elapsedTime = Timer_GetElapsedTime(time);
-    *time = Timer_GetCurrentTime();
+    *time = CurrentTime;
     return elapsedTime;
 }
 

right/src/timer.h

@@ -9,12 +9,14 @@
 
     #define TIMER_INTERVAL_MSEC 1
 
+// Variables:
+
+   extern volatile uint32_t CurrentTime;
+
 // Functions:
 
     void Timer_Init(void);
-    uint32_t Timer_GetCurrentTime();
     uint32_t Timer_GetCurrentTimeMicros();
-    void Timer_SetCurrentTime(uint32_t *time);
     void Timer_SetCurrentTimeMicros(uint32_t *time);
     uint32_t Timer_GetElapsedTime(uint32_t *time);
     uint32_t Timer_GetElapsedTimeMicros(uint32_t *time);

right/src/usb_commands/usb_command_get_debug_buffer.c

@@ -22,7 +22,7 @@ void UsbCommand_GetDebugBuffer(void)
     SetDebugBufferUint32(13, I2cWatchdog_RecoveryCounter);
     SetDebugBufferUint32(17, MatrixScanCounter);
     SetDebugBufferUint32(21, UsbReportUpdateCounter);
-    SetDebugBufferUint32(25, Timer_GetCurrentTime());
+    SetDebugBufferUint32(25, CurrentTime);
     SetDebugBufferUint32(29, UsbGenericHidActionCounter);
     SetDebugBufferUint32(33, UsbBasicKeyboardActionCounter);
     SetDebugBufferUint32(37, UsbMediaKeyboardActionCounter);

right/src/usb_commands/usb_command_get_device_property.c

@@ -69,7 +69,7 @@ void UsbCommand_GetDeviceProperty(void)
             SetUsbTxBufferUint32(6, I2cMainBusActualBaudRateBps);
             break;
         case DevicePropertyId_Uptime:
-            SetUsbTxBufferUint32(1, Timer_GetCurrentTime());
+            SetUsbTxBufferUint32(1, CurrentTime);
             break;
         default:
             SetUsbTxBufferUint8(0, UsbStatusCode_GetDeviceProperty_InvalidProperty);

right/src/usb_commands/usb_command_get_variable.c

@@ -21,5 +21,8 @@ void UsbCommand_GetVariable(void)
         case UsbVariable_DebounceTimeRelease:
             SetUsbTxBufferUint8(1, DebounceTimeRelease);
             break;
+        case UsbVariable_UsbReportSemaphore:
+            SetUsbTxBufferUint8(1, UsbReportUpdateSemaphore);
+            break;
     }
 }

right/src/usb_commands/usb_command_set_variable.c

@@ -24,5 +24,8 @@ void UsbCommand_SetVariable(void)
         case UsbVariable_DebounceTimeRelease:
             DebounceTimeRelease = GetUsbRxBufferUint8(2);
             break;
+        case UsbVariable_UsbReportSemaphore:
+            UsbReportUpdateSemaphore = GetUsbRxBufferUint8(2);
+            break;
     }
 }

right/src/usb_composite_device.c

@@ -168,12 +168,16 @@ static volatile bool wakeUpHostAllowed;
 
 static void suspendUhk(void) {
     SleepModeActive = true;
-    LedSlaveDriver_DisableLeds();
+    for (uint8_t i = 0; i <= LedDriverId_Last; i++) {
+        LedSlaveDriver_DisableLeds(i);
+    }
 }
 
 static void wakeUpUhk(void) {
     SleepModeActive = false;
-    LedSlaveDriver_UpdateLeds();
+    for (uint8_t i = 0; i <= LedDriverId_Last; i++) {
+        LedSlaveDriver_EnableLeds(i);
+    }
 }
 
 void WakeUpHost(void) {

right/src/usb_protocol_handler.h

@@ -42,7 +42,8 @@
         UsbVariable_TestSwitches,
         UsbVariable_TestUsbStack,
         UsbVariable_DebounceTimePress,
-        UsbVariable_DebounceTimeRelease
+        UsbVariable_DebounceTimeRelease,
+        UsbVariable_UsbReportSemaphore,
     } usb_variable_id_t;
 
     typedef enum {

right/src/usb_report_updater.c

@@ -25,6 +25,7 @@ static uint16_t DoubleTapSwitchLayerReleaseTimeout = 200;
 
 static bool activeMouseStates[ACTIVE_MOUSE_STATES_COUNT];
 bool TestUsbStack = false;
+static key_action_t actionCache[SLOT_COUNT][MAX_KEY_COUNT_PER_MODULE];
 
 volatile uint8_t UsbReportUpdateSemaphore = 0;
 
@@ -206,15 +207,15 @@ static void handleSwitchLayerAction(key_state_t *keyState, key_action_t *action)
         doubleTapSwitchLayerKey = NULL;
     }
 
+    if (action->type != KeyActionType_SwitchLayer) {
+        return;
+    }
+
     if (!keyState->previous && isLayerDoubleTapToggled && ToggledLayer == action->switchLayer.layer) {
         ToggledLayer = LayerId_Base;
         isLayerDoubleTapToggled = false;
     }
 
-    if (action->type != KeyActionType_SwitchLayer) {
-        return;
-    }
-
     if (keyState->previous && doubleTapSwitchLayerKey == keyState &&
         Timer_GetElapsedTime(&doubleTapSwitchLayerTriggerTime) > DoubleTapSwitchLayerReleaseTimeout)
     {
@@ -225,11 +226,11 @@ static void handleSwitchLayerAction(key_state_t *keyState, key_action_t *action)
         if (doubleTapSwitchLayerKey && Timer_GetElapsedTimeAndSetCurrent(&doubleTapSwitchLayerStartTime) < DoubleTapSwitchLayerTimeout) {
             ToggledLayer = action->switchLayer.layer;
             isLayerDoubleTapToggled = true;
-            doubleTapSwitchLayerTriggerTime = Timer_GetCurrentTime();
+            doubleTapSwitchLayerTriggerTime = CurrentTime;
         } else {
             doubleTapSwitchLayerKey = keyState;
         }
-        doubleTapSwitchLayerStartTime = Timer_GetCurrentTime();
+        doubleTapSwitchLayerStartTime = CurrentTime;
     }
 }
 
@@ -237,6 +238,10 @@ static uint8_t basicScancodeIndex = 0;
 static uint8_t mediaScancodeIndex = 0;
 static uint8_t systemScancodeIndex = 0;
 static uint8_t stickyModifiers;
+static uint8_t secondaryRoleState = SecondaryRoleState_Released;
+static uint8_t secondaryRoleSlotId;
+static uint8_t secondaryRoleKeyId;
+static secondary_role_t secondaryRole;
 
 static void applyKeyAction(key_state_t *keyState, key_action_t *action)
 {
@@ -288,6 +293,7 @@ static void applyKeyAction(key_state_t *keyState, key_action_t *action)
         case KeyActionType_SwitchKeymap:
             if (!keyState->previous) {
                 stickyModifiers = 0;
+                secondaryRoleState = SecondaryRoleState_Released;
                 SwitchKeymapById(action->switchKeymap.keymapId);
             }
             break;
@@ -300,11 +306,6 @@ static void applyKeyAction(key_state_t *keyState, key_action_t *action)
     }
 }
 
-static uint8_t secondaryRoleState = SecondaryRoleState_Released;
-static uint8_t secondaryRoleSlotId;
-static uint8_t secondaryRoleKeyId;
-static secondary_role_t secondaryRole;
-
 static void updateActiveUsbReports(void)
 {
     if (MacroPlaying) {
@@ -333,7 +334,6 @@ static void updateActiveUsbReports(void)
     if (layerChanged) {
         stickyModifiers = 0;
     }
-    bool layerGotReleased = layerChanged && activeLayer == LayerId_Base;
     LedDisplay_SetLayer(activeLayer);
 
     if (TestUsbStack) {
@@ -351,40 +351,43 @@ static void updateActiveUsbReports(void)
                 isEvenMedia = !isEvenMedia;
                 ActiveUsbMediaKeyboardReport->scancodes[mediaScancodeIndex++] = isEvenMedia ? MEDIA_VOLUME_DOWN : MEDIA_VOLUME_UP;
             }
-            MouseMoveState.xOut = isEven ? -1 : 1;
+            MouseMoveState.xOut = isEven ? -5 : 5;
         }
     }
 
     for (uint8_t slotId=0; slotId<SLOT_COUNT; slotId++) {
         for (uint8_t keyId=0; keyId<MAX_KEY_COUNT_PER_MODULE; keyId++) {
             key_state_t *keyState = &KeyStates[slotId][keyId];
-            key_action_t *action = &CurrentKeymap[activeLayer][slotId][keyId];
+            key_action_t *action;
 
             if (keyState->debouncing) {
-                if ((uint8_t)(Timer_GetCurrentTime() - keyState->timestamp) > (keyState->previous ? DebounceTimePress : DebounceTimeRelease)) {
+                if ((uint8_t)(CurrentTime - keyState->timestamp) > (keyState->previous ? DebounceTimePress : DebounceTimeRelease)) {
                     keyState->debouncing = false;
                 } else {
                     keyState->current = keyState->previous;
                 }
             } else if (keyState->previous != keyState->current) {
-                keyState->timestamp = Timer_GetCurrentTime();
+                keyState->timestamp = CurrentTime;
                 keyState->debouncing = true;
             }
 
-            if (keyState->current) {
-                if (SleepModeActive && !keyState->previous) {
+            if (keyState->current && !keyState->previous) {
+                if (SleepModeActive) {
                     WakeUpHost();
                 }
-                key_action_t *baseAction = &CurrentKeymap[LayerId_Base][slotId][keyId];
-                if (layerGotReleased && !(baseAction->type == KeyActionType_Keystroke && baseAction->keystroke.scancode == 0 && baseAction->keystroke.modifiers)) {
-                    keyState->suppressed = true;
-                }
-
-                // Trigger secondary role.
-                if (!keyState->previous && secondaryRoleState == SecondaryRoleState_Pressed) {
+                if (secondaryRoleState == SecondaryRoleState_Pressed) {
+                    // Trigger secondary role.
                     secondaryRoleState = SecondaryRoleState_Triggered;
                     keyState->current = false;
-                } else if (action->type == KeyActionType_Keystroke && action->keystroke.secondaryRole) {
+                } else {
+                    actionCache[slotId][keyId] = CurrentKeymap[activeLayer][slotId][keyId];
+                }
+            }
+
+            action = &actionCache[slotId][keyId];
+
+            if (keyState->current) {
+                if (action->type == KeyActionType_Keystroke && action->keystroke.secondaryRole) {
                     // Press released secondary role key.
                     if (!keyState->previous && secondaryRoleState == SecondaryRoleState_Released) {
                         secondaryRoleState = SecondaryRoleState_Pressed;
@@ -397,14 +400,13 @@ static void updateActiveUsbReports(void)
                     applyKeyAction(keyState, action);
                 }
             } else {
-                if (keyState->suppressed) {
-                    keyState->suppressed = false;
-                }
+                keyState->suppressed = false;
 
                 // Release secondary role key.
                 if (keyState->previous && secondaryRoleSlotId == slotId && secondaryRoleKeyId == keyId) {
                     // Trigger primary role.
                     if (secondaryRoleState == SecondaryRoleState_Pressed) {
+                        keyState->previous = false;
                         applyKeyAction(keyState, action);
                     }
                     secondaryRoleState = SecondaryRoleState_Released;
@@ -433,14 +435,21 @@ uint32_t UsbReportUpdateCounter;
 
 void UpdateUsbReports(void)
 {
+    static uint32_t lastUpdateTime;
+
     for (uint8_t keyId = 0; keyId < RIGHT_KEY_MATRIX_KEY_COUNT; keyId++) {
         KeyStates[SlotId_RightKeyboardHalf][keyId].current = RightKeyMatrix.keyStates[keyId];
     }
 
     if (UsbReportUpdateSemaphore && !SleepModeActive) {
-        return;
+        if (Timer_GetElapsedTime(&lastUpdateTime) < USB_SEMAPHORE_TIMEOUT) {
+            return;
+        } else {
+            UsbReportUpdateSemaphore = 0;
+        }
     }
 
+    lastUpdateTime = CurrentTime;
     UsbReportUpdateCounter++;
 
     ResetActiveUsbBasicKeyboardReport();

right/src/usb_report_updater.h

@@ -14,6 +14,8 @@
     #define SECONDARY_ROLE_MODIFIER_TO_HID_MODIFIER(secondaryRoleModifier) (1 << ((secondaryRoleModifier) - 1))
     #define SECONDARY_ROLE_LAYER_TO_LAYER_ID(secondaryRoleLayer) ((secondaryRoleLayer) - SecondaryRole_RightSuper)
 
+    #define USB_SEMAPHORE_TIMEOUT 100 // ms
+
 // Typedefs:
 
     typedef enum {

scripts/package.json

@@ -15,8 +15,8 @@
     "commander": "^2.11.0",
     "shelljs": "^0.7.8"
   },
-  "firmwareVersion": "8.4.4",
-  "deviceProtocolVersion": "4.4.0",
+  "firmwareVersion": "8.5.3",
+  "deviceProtocolVersion": "4.5.0",
   "moduleProtocolVersion": "4.0.0",
   "userConfigVersion": "4.1.0",
   "hardwareConfigVersion": "1.0.0",

shared/versions.h

@@ -19,11 +19,11 @@
 // Variables:
 
     #define FIRMWARE_MAJOR_VERSION 8
-    #define FIRMWARE_MINOR_VERSION 4
-    #define FIRMWARE_PATCH_VERSION 4
+    #define FIRMWARE_MINOR_VERSION 5
+    #define FIRMWARE_PATCH_VERSION 3
 
     #define DEVICE_PROTOCOL_MAJOR_VERSION 4
-    #define DEVICE_PROTOCOL_MINOR_VERSION 4
+    #define DEVICE_PROTOCOL_MINOR_VERSION 5
     #define DEVICE_PROTOCOL_PATCH_VERSION 0
 
     #define MODULE_PROTOCOL_MAJOR_VERSION 4