Releases: FrameworkComputer/qmk_firmware
v0.3.1
Compatibility
This firmware requires the following minimum BIOS version:
- Framework 16 AMD Ryzen 7040 Series: BIOS 4.01 or later
- Framework 16 AMD Ryzen AI 300: BIOS 3.00 or later (shipping from the factory)
Changes compared to v0.2.9
- Remove useless KC_SYRQ. PRT SCR functions as sysrq.
- Use sleep_l pin to indicate only lid state. Together with updated BIOS this prevents the system from waking by keypress when the lid is closed.
How to update:
On Linux
fwupd version 2.0.16 and later, can update the keyboard firmware on Linux.
To run the update, use KDE Discover, GNOME Firmware or the fwupd commandline: fwupdmgr get-updates && fwupdmgr update
If it fails, please try it again. It is not possible to brick the keyboards.
If your distribution does not offer fwupd 2.0.16 yet and the update does not show up, please see the "On any OS (UF2)" section
See LVFS status:
On Windows
- Please download framework_laptop_16_keyboards_windows_updater_v0.3.1.zip
- Extract it
- Run the .exe files matching your keyboard
Note:
- ANSI looks like this: https://frame.work/tw/en/products/keyboard-module?v=FRAKDW00AA
- ISO looks like this: https://frame.work/tw/en/products/keyboard-module?v=FRAKDW00AB
On any OS (UF2)
- Download the .uf2 file matching your keyboard.
- Slide touchpad down, until the input deck powers off (you can see the backlights turning off)
- Hold left and right ALT keys pressed, while sliding the touchpad back up again
- The keyboard is now in bootloader mode, use the touchpad to drag the .uf2 file onto the RPI-2 drive
- The keyboard will automatically update itself, restart and be functional again after a few seconds
For numpad/macropad hold down keys 1 and 6. Please refer to the layout here: Numpad, Macropad
DO NOT update keyboard and macropad/numpad at the same time. If they are both in bootloader mode, it's impossible to distinguish them. Do not flash the wrong firmware.
Completely erase firmware and all settings
The modules keep persistent settings. Firmware updates do not erase them.
If you want to factory reset your module please use the UF2 method descrcibed above, first with erase_flash.uf2 and then with the matching .uf2 file for your keyboard.
It will take a while because it erases the entire flash, without any optimizations.
Do not do this unnecessarily to avoid wearing out the flash.
v0.3.0
IMPORTANT
This release is not intended for public consumption, it needs to be paired with an unreleased EC firmware change!
We will make a formal announcement once it's ready.
How to update:
On Windows
- Please download framework_flash_keyboards_v0.3.0.zip
- Extract it
- Run the .exe files matching your keyboard
Note:
- ANSI looks like this: https://frame.work/tw/en/products/keyboard-module?v=FRAKDW00AA
- ISO looks like this: https://frame.work/tw/en/products/keyboard-module?v=FRAKDW00AB
On any OS (UF2)
- Download the .uf2 file matching your keyboard.
- Slide touchpad down, until the input deck powers off (you can see the backlights turning off)
- Hold left and right ALT keys pressed, while sliding the touchpad back up again
- The keyboard is now in bootloader mode, use the touchpad to drag the .uf2 file onto the RPI-2 drive
- The keyboard will automatically update itself, restart and be functional again after a few seconds
For numpad/macropad hold down keys 1 and 6. Please refer to the layout here: Numpad, Macropad
DO NOT update keyboard and macropad/numpad at the same time. If they are both in bootloader mode, it's impossible to distinguish them. Do not flash the wrong firmware.
Completely erase firmware and all settings
The modules keep persistent settings. Firmware updates do not erase them.
If you want to factory reset your module please use the UF2 method descrcibed above, first with erase_flash.uf2 and then with the matching .uf2 file for your keyboard.
It will take a while because it erases the entire flash, without any optimizations.
Do not do this unnecessarily to avoid wearing out the flash.
v0.2.9
Changes:
- Turn capslock LED off when SLEEP# is low
- Use https://keyboard.frame.work/ for customizing key mapping and RGB backlight.
How to update:
On Windows
Use the .exe matching your keyboard.
Note:
- ANSI looks like this: https://frame.work/tw/en/products/keyboard-module?v=FRAKDW00AA
- ISO looks like this: https://frame.work/tw/en/products/keyboard-module?v=FRAKDW00AB
On any OS (UF2)
- Download the .uf2 file matching your keyboard.
- Slide touchpad down, until the input deck powers off (you can see the backlights turning off)
- Hold left and right ALT keys pressed, while sliding the touchpad back up again
- The keyboard is now in bootloader mode, use the touchpad to drag the .uf2 file onto the RPI-2 drive
- The keyboard will automatically update itself, restart and be functional again after a few seconds
For numpad/macropad hold down keys 1 and 6. Please refer to the layout here: Numpad, Macropad
DO NOT update keyboard and macropad/numpad at the same time. If they are both in bootloader mode, it's impossible to distinguish them. Do not flash the wrong firmware.
Completely erase firmware and all settings
The modules keep persistent settings. Firmware updates do not erase them.
If you want to factory reset your module please use the UF2 method descrcibed above, first with erase_flash.uf2 and then with the matching .uf2 file for your keyboard.
It will take a while because it erases the entire flash, without any optimizations.
Do not do this unnecessarily to avoid wearing out the flash.
v0.2.8
Changes
- Allow next/prev effect keys to turn RGB back on
- Disable SelectiveSuspend
- Remove keepalive HID reports for 25 seconds after last keypress
- Remove Microsoft OS 2.0 Descriptor
- Enable NKRO only when in OS (needs EC firmware fix to work without hotplug in windows)
- Detect OS vs UEFI to force FN keys instead of media keys in UEFI environment
v0.2.7
Changes in 0.2.7
- Send keepalive HID reports for 25 seconds after last keypress (to avoid the Windows driver from suspending the keyboard too often)
Changes in 0.2.6
- Make sure RGB backlight keeps animating in USB suspend
Changes in 0.2.5
- Selective Suspend (D2)
- Add Microsoft OS Descriptor to set "SelectiveSuspendEnabled" in registry
- Make sure keypress that wakes from D2 is sent to OS, not swallowed
- Don't use USB suspend for backlight control, rely on SLEEP#
Changes in 0.2.4
- Increase PWM frequency on RGB keyboards: 29kHz -> 32.25kHz
- Allow configuration of 10 layers in VIA
- Dynamic keypress voltage threshold (avoid ghost keys, especially with new HW rev)
- Change default macropad layout same as numpad layout
- Default to mediakeys instead of F1-F12
v0.2.6
Changes
- Make sure RGB backlight keeps animating in USB suspend
v0.2.5
Changes
- Selective Suspend (D2)
- Add Microsoft OS Descriptor to set "SelectiveSuspendEnabled" in registry
- Make sure keypress that wakes from D2 is sent to OS, not swallowed
- Don't use USB suspend for backlight control, rely on SLEEP#
ATTENTION: Creates registry entries to force the Windows driver to suspend the device. These are persistent and CANNOT be cleared from firmware.
If you want to downgrade to a previous version of the firmware, you must MANUALLY delete registry entries under:
Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Enum\USB\VID32AC&PID0012(ANSI)Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Enum\USB\VID32AC&PID0018(ISO)Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Enum\USB\VID32AC&PID0019(ISO)Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Enum\USB\VID32AC&PID0013(Macropad)Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Enum\USB\VID32AC&PID0014(Numpad)
v0.2.4
Changes
- Increase PWM frequency on RGB keyboards: 29kHz -> 32.25kHz
- Allow configuration of 10 layers in VIA
- Dynamic keypress voltage threshold (avoid ghost keys, especially with new HW rev)
- Change default macropad layout same as numpad layout
- Default to mediakeys instead of F1-F12
v0.2.3-hotkey-indicator
Same as v0.2.3 but RGB backlight color changes based on BIOS hotkey mode.
Keyboard starts up with RGB color based on previous setting, unrelated to BIOS hotkey mode. Recommended to configure to something that's NOT red or white.
Turns RED when command to enable hotkey mode is received.
Turns WHITE when command to enable hotkey mode is received.
If you're unsure if it updated or not, pressing a key will update the backlight to the correct color.
v0.2.3
Update Instructions
- Slide out touchpad (turns off power to all modules)
- Press left and right ALT keys - while keeping them pressed, slide the touchpad back in
- A folder will pop up (like USB thumb drive) - open it
- Copy the single
.uf2file corresponding to the keyboard type into this folder - Keyboard will reset and automatically flash
Notes
- Different layouts (ISO, JIS ANSI) require different firmware AND different design file for VIA.
- If you change firmware to a different layout (e.g. ANSI to ISO) you MUST run
qmk_hid via --eeprom-reset!!! Otherwise it will keep settings from previous layout. (Applies to all versions, not just 0.2.3) - MUST run
qmk_hid via --eeprom-resetafter update, if upgrading from 0.1.5 or older! - MUST run
qmk_hid via --eeprom-resetafter update, if using numpad or macropad and you want to use the new default layout
v0.2.3
The latest corresponding tool for this firmware release is qmk_hid v0.1.11.
Changes:
- ANSI RGB Keyboard only
- Fix LED to key mapping. Now in RGB patterns that react to keypress, like ripple or heatmap the LEDs will light up under the artwork. There they are more visible
- Update debug messages to show measured voltage (Helps with debugging hardware defects)
- Extend UEFI hotkey mode to all F keys (F1-F12)
Compatibility:
- Compatible with all hardware revisions until at least August 2023