Update changelog, package.json, versions.h and Agent reference.

Use the correct scancode so that commas are outputted

CHANGELOG.md

@@ -5,6 +5,24 @@ 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.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 @@
+If you're using Karabiner Elements on your Mac, then stop here! Make sure to close Karabiner Elements, then try to reproduce the issue again, even if you think that Karabiner Elements shouldn't be the cause. Karabiner Elements is the source of numerous problems, and we don't want to receive any more reports it causes.

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.
+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*.
-
-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.
 
 ## Contributing
 

right/src/keymap.c

@@ -5,6 +5,7 @@
 #include "config_parser/parse_keymap.h"
 #include "config_parser/config_globals.h"
 #include "macros.h"
+#include "usb_report_updater.h"
 
 keymap_reference_t AllKeymaps[MAX_KEYMAP_NUM] = {
     {
@@ -24,6 +25,7 @@ void SwitchKeymapById(uint8_t index)
     ValidatedUserConfigBuffer.offset = AllKeymaps[index].offset;
     ParseKeymap(&ValidatedUserConfigBuffer, index, AllKeymapsCount, AllMacrosCount);
     LedDisplay_UpdateText();
+    KeymapChanged = true;
 }
 
 bool SwitchKeymapByAbbreviation(uint8_t length, char *abbrev)

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/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/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 CurrentTime - *time;
-    return elapsedTime;
 }
 
 uint32_t Timer_GetElapsedTimeMicros(uint32_t *time)
 {
-    uint32_t elapsedTime = Timer_GetCurrentTimeMicros() - *time;
+    return Timer_GetCurrentTimeMicros() - *time;
-    return elapsedTime;
 }
 
 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_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,8 @@ static uint16_t DoubleTapSwitchLayerReleaseTimeout = 200;
 
 static bool activeMouseStates[ACTIVE_MOUSE_STATES_COUNT];
 bool TestUsbStack = false;
+bool KeymapChanged = false;
+static uint8_t layerCache[SLOT_COUNT][MAX_KEY_COUNT_PER_MODULE];
 
 volatile uint8_t UsbReportUpdateSemaphore = 0;
 
@@ -206,15 +208,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 +227,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 +239,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 +294,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 +307,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 +335,8 @@ static void updateActiveUsbReports(void)
     if (layerChanged) {
         stickyModifiers = 0;
     }
-    bool layerGotReleased = layerChanged && activeLayer == LayerId_Base;
+    bool keymapChangedLastCycle = KeymapChanged;
+    KeymapChanged = false;
     LedDisplay_SetLayer(activeLayer);
 
     if (TestUsbStack) {
@@ -351,39 +354,44 @@ 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 (keyState->current && !keyState->previous) {
-                if (SleepModeActive && !keyState->previous) {
+                if (SleepModeActive) {
                     WakeUpHost();
                 }
-                key_action_t *baseAction = &CurrentKeymap[LayerId_Base][slotId][keyId];
+                if (secondaryRoleState == SecondaryRoleState_Pressed) {
-                if (layerGotReleased && !(baseAction->type == KeyActionType_Keystroke && baseAction->keystroke.scancode == 0 && baseAction->keystroke.modifiers)) {
+                    // Trigger secondary role.
-                    keyState->suppressed = true;
-                }
-
-                // Trigger secondary role.
-                if (!keyState->previous && secondaryRoleState == SecondaryRoleState_Pressed) {
                     secondaryRoleState = SecondaryRoleState_Triggered;
                     keyState->current = false;
+                } else {
+                    layerCache[slotId][keyId] = activeLayer;
+                }
+            }
+
+            action = &CurrentKeymap[layerCache[slotId][keyId]][slotId][keyId];
+
+            if (keyState->current) {
+                if ((KeymapChanged || keymapChangedLastCycle) && keyState->previous) {
+                    keyState->suppressed = true;
                 } else if (action->type == KeyActionType_Keystroke && action->keystroke.secondaryRole) {
                     // Press released secondary role key.
                     if (!keyState->previous && secondaryRoleState == SecondaryRoleState_Released) {
@@ -397,14 +405,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;

right/src/usb_report_updater.h

@@ -72,6 +72,7 @@
     extern uint32_t UsbReportUpdateCounter;
     extern volatile uint8_t UsbReportUpdateSemaphore;
     extern bool TestUsbStack;
+    extern bool KeymapChanged;
 
 // Functions:
 

scripts/package.json

@@ -15,8 +15,8 @@
     "commander": "^2.11.0",
     "shelljs": "^0.7.8"
   },
-  "firmwareVersion": "8.4.4",
+  "firmwareVersion": "8.5.0",
-  "deviceProtocolVersion": "4.4.0",
+  "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_MINOR_VERSION 5
-    #define FIRMWARE_PATCH_VERSION 4
+    #define FIRMWARE_PATCH_VERSION 0
 
     #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