ARM split - Add bootmagic/magic keycodes for setting handedness (#6545)

* Add docs on bootmagic/magic keycodes for setting handedness * Clang format fixes * Maintain backwards compatibility * Maintain backwards compatibility
author: Joel Challis <git@zvecr.com> 2019-09-24 15:24:12 +0100
committer: GitHub <noreply@github.com> 2019-09-24 15:24:12 +0100
commit: ad8dbd5ca5390ad9e441943b705684fce521bc15 (patch)
tree: 5426b36cba3db2fafe4eb4dc59ee05c3b3788b77 /docs
parent: 237147ca236b0e942fc14e73010479a2785bf764 (diff)
download: qmk_firmware-ad8dbd5ca5390ad9e441943b705684fce521bc15.tar.gz
qmk_firmware-ad8dbd5ca5390ad9e441943b705684fce521bc15.zip
2 files changed, 36 insertions, 28 deletions
diff --git a/docs/feature_bootmagic.md b/docs/feature_bootmagic.md
index fc37a3302..ed00d5129 100644
--- a/docs/feature_bootmagic.md
+++ b/docs/feature_bootmagic.md
@@ -34,6 +34,8 @@ Hold down the Bootmagic key (Space by default) and the desired hotkey while plug
 |`X`               |Toggle key matrix debugging                  |
 |`K`               |Toggle keyboard debugging                    |
 |`M`               |Toggle mouse debugging                       |
+|`L`               |Set "Left Hand" for EE_HANDS handedness      |
+|`R`               |Set "Right Hand" for EE_HANDS handedness     |
 |Backspace         |Clear the EEPROM                             |
 |Caps Lock         |Toggle treating Caps Lock as Left Control    |
 |Left Control      |Toggle swapping Caps Lock and Left Control   |
@@ -83,6 +85,8 @@ Hold down the Bootmagic key (Space by default) and the desired hotkey while plug
 |`MAGIC_UNSWAP_LCTL_LGUI`          |         |Unswap Left Control and Left GUI          |
 |`MAGIC_SWAP_RCTL_RGUI`            |         |Swap Right Control and Right GUI          |
 |`MAGIC_UNSWAP_RCTL_RGUI`          |         |Unswap Right Control and Right GUI        |
+|`MAGIC_EE_HANDS_LEFT`             |         |Set "Left Hand" for EE_HANDS handedness   |
+|`MAGIC_EE_HANDS_RIGHT`            |         |Set "Right Hand" for EE_HANDS handedness  |
 ## Configuration
@@ -98,6 +102,8 @@ If you would like to change the hotkey assignments for Bootmagic, `#define` thes
 |`BOOTMAGIC_KEY_DEBUG_MATRIX`            |`KC_X`       |Toggle matrix debugging                            |
 |`BOOTMAGIC_KEY_DEBUG_KEYBOARD`          |`KC_K`       |Toggle keyboard debugging                          |
 |`BOOTMAGIC_KEY_DEBUG_MOUSE`             |`KC_M`       |Toggle mouse debugging                             |
+|`BOOTMAGIC_KEY_EE_HANDS_LEFT`           |`KC_L`       |Set "Left Hand" for EE_HANDS handedness            |
+|`BOOTMAGIC_KEY_EE_HANDS_RIGHT`          |`KC_R`       |Set "Right Hand" for EE_HANDS handedness           |
 |`BOOTMAGIC_KEY_SWAP_CONTROL_CAPSLOCK`   |`KC_LCTRL`   |Swap Left Control and Caps Lock                    |
 |`BOOTMAGIC_KEY_CAPSLOCK_TO_CONTROL`     |`KC_CAPSLOCK`|Toggle treating Caps Lock as Left Control          |
 |`BOOTMAGIC_KEY_SWAP_LALT_LGUI`          |`KC_LALT`    |Toggle swapping Left Alt and Left GUI (for macOS)  |
diff --git a/docs/keycodes.md b/docs/keycodes.md
index e17fef6fd..dfbab148b 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -257,35 +257,37 @@ This is a reference only. Each group of keys links to the page documenting their
 ## [Bootmagic](feature_bootmagic.md)
-|Key                               |Aliases  |Description                         |
+|Key                               |Aliases  |Description                                |
-|----------------------------------|---------|------------------------------------|
+|----------------------------------|---------|-------------------------------------------|
-|`MAGIC_SWAP_CONTROL_CAPSLOCK`     |         |Swap Caps Lock and Left Control     |
+|`MAGIC_SWAP_CONTROL_CAPSLOCK`     |         |Swap Caps Lock and Left Control            |
-|`MAGIC_CAPSLOCK_TO_CONTROL`       |         |Treat Caps Lock as Control          |
+|`MAGIC_CAPSLOCK_TO_CONTROL`       |         |Treat Caps Lock as Control                 |
-|`MAGIC_SWAP_LCTL_LGUI`            |         |Swap Left Control and GUI           |
+|`MAGIC_SWAP_LCTL_LGUI`            |         |Swap Left Control and GUI                  |
-|`MAGIC_SWAP_RCTL_RGUI`            |         |Swap Right Control and GUI          |
+|`MAGIC_SWAP_RCTL_RGUI`            |         |Swap Right Control and GUI                 |
-|`MAGIC_SWAP_LALT_LGUI`            |         |Swap Left Alt and GUI               |
+|`MAGIC_SWAP_LALT_LGUI`            |         |Swap Left Alt and GUI                      |
-|`MAGIC_SWAP_RALT_RGUI`            |         |Swap Right Alt and GUI              |
+|`MAGIC_SWAP_RALT_RGUI`            |         |Swap Right Alt and GUI                     |
-|`MAGIC_NO_GUI`                    |         |Disable the GUI key                 |
+|`MAGIC_NO_GUI`                    |         |Disable the GUI key                        |
-|`MAGIC_SWAP_GRAVE_ESC`            |         |Swap <code>&#96;</code> and Escape  |
+|`MAGIC_SWAP_GRAVE_ESC`            |         |Swap <code>&#96;</code> and Escape         |
-|`MAGIC_SWAP_BACKSLASH_BACKSPACE`  |         |Swap `\` and Backspace              |
+|`MAGIC_SWAP_BACKSLASH_BACKSPACE`  |         |Swap `\` and Backspace                     |
-|`MAGIC_HOST_NKRO`                 |         |Force NKRO on                       |
+|`MAGIC_HOST_NKRO`                 |         |Force NKRO on                              |
-|`MAGIC_SWAP_ALT_GUI`              |`AG_SWAP`|Swap Alt and GUI on both sides      |
+|`MAGIC_SWAP_ALT_GUI`              |`AG_SWAP`|Swap Alt and GUI on both sides             |
 |`MAGIC_SWAP_CTL_GUI`              |`CG_SWAP`|Swap Ctrl and GUI on both sides (for macOS)|
-|`MAGIC_UNSWAP_CONTROL_CAPSLOCK`   |         |Unswap Caps Lock and Left Control   |
+|`MAGIC_UNSWAP_CONTROL_CAPSLOCK`   |         |Unswap Caps Lock and Left Control          |
-|`MAGIC_UNCAPSLOCK_TO_CONTROL`     |         |Stop treating Caps Lock as Control  |
+|`MAGIC_UNCAPSLOCK_TO_CONTROL`     |         |Stop treating Caps Lock as Control         |
-|`MAGIC_UNSWAP_LCTL_LGUI`          |         |Unswap Left Control and GUI         |
+|`MAGIC_UNSWAP_LCTL_LGUI`          |         |Unswap Left Control and GUI                |
-|`MAGIC_UNSWAP_RCTL_RGUI`          |         |Unswap Right Control and GUI        |
+|`MAGIC_UNSWAP_RCTL_RGUI`          |         |Unswap Right Control and GUI               |
-|`MAGIC_UNSWAP_LALT_LGUI`          |         |Unswap Left Alt and GUI             |
+|`MAGIC_UNSWAP_LALT_LGUI`          |         |Unswap Left Alt and GUI                    |
-|`MAGIC_UNSWAP_RALT_RGUI`          |         |Unswap Right Alt and GUI            |
+|`MAGIC_UNSWAP_RALT_RGUI`          |         |Unswap Right Alt and GUI                   |
-|`MAGIC_UNNO_GUI`                  |         |Enable the GUI key                  |
+|`MAGIC_UNNO_GUI`                  |         |Enable the GUI key                         |
-|`MAGIC_UNSWAP_GRAVE_ESC`          |         |Unswap <code>&#96;</code> and Escape|
+|`MAGIC_UNSWAP_GRAVE_ESC`          |         |Unswap <code>&#96;</code> and Escape       |
-|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`|         |Unswap `\` and Backspace            |
+|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`|         |Unswap `\` and Backspace                   |
-|`MAGIC_UNHOST_NKRO`               |         |Force NKRO off                      |
+|`MAGIC_UNHOST_NKRO`               |         |Force NKRO off                             |
-|`MAGIC_UNSWAP_ALT_GUI`            |`AG_NORM`|Unswap Alt and GUI on both sides    |
+|`MAGIC_UNSWAP_ALT_GUI`            |`AG_NORM`|Unswap Alt and GUI on both sides           |
-|`MAGIC_UNSWAP_CTL_GUI`            |`CG_NORM`|Unswap Ctrl and GUI on both sides      |
+|`MAGIC_UNSWAP_CTL_GUI`            |`CG_NORM`|Unswap Ctrl and GUI on both sides          |
-|`MAGIC_TOGGLE_ALT_GUI`            |`AG_TOGG`|Toggle Alt and GUI swap on both sides  |
+|`MAGIC_TOGGLE_ALT_GUI`            |`AG_TOGG`|Toggle Alt and GUI swap on both sides      |
-|`MAGIC_TOGGLE_CTL_GUI`            |`CG_TOGG`|Toggle Ctrl and GUI swap on both sides |
+|`MAGIC_TOGGLE_CTL_GUI`            |`CG_TOGG`|Toggle Ctrl and GUI swap on both sides     |
-|`MAGIC_TOGGLE_NKRO`               |         |Turn NKRO on or off                    |
+|`MAGIC_TOGGLE_NKRO`               |         |Turn NKRO on or off                        |
+|`MAGIC_EE_HANDS_LEFT`             |         |Set "Left Hand" for EE_HANDS handedness    |
+|`MAGIC_EE_HANDS_RIGHT`            |         |Set "Right Hand" for EE_HANDS handedness   |
 ## [Bluetooth](feature_bluetooth.md)
author	Joel Challis <git@zvecr.com>	2019-09-24 15:24:12 +0100
committer	GitHub <noreply@github.com>	2019-09-24 15:24:12 +0100
commit	ad8dbd5ca5390ad9e441943b705684fce521bc15 (patch)
tree	5426b36cba3db2fafe4eb4dc59ee05c3b3788b77 /docs
parent	237147ca236b0e942fc14e73010479a2785bf764 (diff)
download	qmk_firmware-ad8dbd5ca5390ad9e441943b705684fce521bc15.tar.gz qmk_firmware-ad8dbd5ca5390ad9e441943b705684fce521bc15.zip

diff --git a/docs/feature_bootmagic.md b/docs/feature_bootmagic.md index fc37a3302..ed00d5129 100644 --- a/docs/feature_bootmagic.md +++ b/docs/feature_bootmagic.md
@@ -34,6 +34,8 @@ Hold down the Bootmagic key (Space by default) and the desired hotkey while plug
34	\|`X` \|Toggle key matrix debugging \|	34	\|`X` \|Toggle key matrix debugging \|
35	\|`K` \|Toggle keyboard debugging \|	35	\|`K` \|Toggle keyboard debugging \|
36	\|`M` \|Toggle mouse debugging \|	36	\|`M` \|Toggle mouse debugging \|
		37	\|`L` \|Set "Left Hand" for EE_HANDS handedness \|
		38	\|`R` \|Set "Right Hand" for EE_HANDS handedness \|
37	\|Backspace \|Clear the EEPROM \|	39	\|Backspace \|Clear the EEPROM \|
38	\|Caps Lock \|Toggle treating Caps Lock as Left Control \|	40	\|Caps Lock \|Toggle treating Caps Lock as Left Control \|
39	\|Left Control \|Toggle swapping Caps Lock and Left Control \|	41	\|Left Control \|Toggle swapping Caps Lock and Left Control \|
@@ -83,6 +85,8 @@ Hold down the Bootmagic key (Space by default) and the desired hotkey while plug
83	\|`MAGIC_UNSWAP_LCTL_LGUI` \| \|Unswap Left Control and Left GUI \|	85	\|`MAGIC_UNSWAP_LCTL_LGUI` \| \|Unswap Left Control and Left GUI \|
84	\|`MAGIC_SWAP_RCTL_RGUI` \| \|Swap Right Control and Right GUI \|	86	\|`MAGIC_SWAP_RCTL_RGUI` \| \|Swap Right Control and Right GUI \|
85	\|`MAGIC_UNSWAP_RCTL_RGUI` \| \|Unswap Right Control and Right GUI \|	87	\|`MAGIC_UNSWAP_RCTL_RGUI` \| \|Unswap Right Control and Right GUI \|
		88	\|`MAGIC_EE_HANDS_LEFT` \| \|Set "Left Hand" for EE_HANDS handedness \|
		89	\|`MAGIC_EE_HANDS_RIGHT` \| \|Set "Right Hand" for EE_HANDS handedness \|
86		90
87	## Configuration	91	## Configuration
88		92
@@ -98,6 +102,8 @@ If you would like to change the hotkey assignments for Bootmagic, `#define` thes
98	\|`BOOTMAGIC_KEY_DEBUG_MATRIX` \|`KC_X` \|Toggle matrix debugging \|	102	\|`BOOTMAGIC_KEY_DEBUG_MATRIX` \|`KC_X` \|Toggle matrix debugging \|
99	\|`BOOTMAGIC_KEY_DEBUG_KEYBOARD` \|`KC_K` \|Toggle keyboard debugging \|	103	\|`BOOTMAGIC_KEY_DEBUG_KEYBOARD` \|`KC_K` \|Toggle keyboard debugging \|
100	\|`BOOTMAGIC_KEY_DEBUG_MOUSE` \|`KC_M` \|Toggle mouse debugging \|	104	\|`BOOTMAGIC_KEY_DEBUG_MOUSE` \|`KC_M` \|Toggle mouse debugging \|
		105	\|`BOOTMAGIC_KEY_EE_HANDS_LEFT` \|`KC_L` \|Set "Left Hand" for EE_HANDS handedness \|
		106	\|`BOOTMAGIC_KEY_EE_HANDS_RIGHT` \|`KC_R` \|Set "Right Hand" for EE_HANDS handedness \|
101	\|`BOOTMAGIC_KEY_SWAP_CONTROL_CAPSLOCK` \|`KC_LCTRL` \|Swap Left Control and Caps Lock \|	107	\|`BOOTMAGIC_KEY_SWAP_CONTROL_CAPSLOCK` \|`KC_LCTRL` \|Swap Left Control and Caps Lock \|
102	\|`BOOTMAGIC_KEY_CAPSLOCK_TO_CONTROL` \|`KC_CAPSLOCK`\|Toggle treating Caps Lock as Left Control \|	108	\|`BOOTMAGIC_KEY_CAPSLOCK_TO_CONTROL` \|`KC_CAPSLOCK`\|Toggle treating Caps Lock as Left Control \|
103	\|`BOOTMAGIC_KEY_SWAP_LALT_LGUI` \|`KC_LALT` \|Toggle swapping Left Alt and Left GUI (for macOS) \|	109	\|`BOOTMAGIC_KEY_SWAP_LALT_LGUI` \|`KC_LALT` \|Toggle swapping Left Alt and Left GUI (for macOS) \|


diff --git a/docs/keycodes.md b/docs/keycodes.md index e17fef6fd..dfbab148b 100644 --- a/docs/keycodes.md +++ b/docs/keycodes.md
@@ -257,35 +257,37 @@ This is a reference only. Each group of keys links to the page documenting their
257		257
258	## [Bootmagic](feature_bootmagic.md)	258	## [Bootmagic](feature_bootmagic.md)
259		259
260	\|Key \|Aliases \|Description \|	260	\|Key \|Aliases \|Description \|
261	\|----------------------------------\|---------\|------------------------------------\|	261	\|----------------------------------\|---------\|-------------------------------------------\|
262	\|`MAGIC_SWAP_CONTROL_CAPSLOCK` \| \|Swap Caps Lock and Left Control \|	262	\|`MAGIC_SWAP_CONTROL_CAPSLOCK` \| \|Swap Caps Lock and Left Control \|
263	\|`MAGIC_CAPSLOCK_TO_CONTROL` \| \|Treat Caps Lock as Control \|	263	\|`MAGIC_CAPSLOCK_TO_CONTROL` \| \|Treat Caps Lock as Control \|
264	\|`MAGIC_SWAP_LCTL_LGUI` \| \|Swap Left Control and GUI \|	264	\|`MAGIC_SWAP_LCTL_LGUI` \| \|Swap Left Control and GUI \|
265	\|`MAGIC_SWAP_RCTL_RGUI` \| \|Swap Right Control and GUI \|	265	\|`MAGIC_SWAP_RCTL_RGUI` \| \|Swap Right Control and GUI \|
266	\|`MAGIC_SWAP_LALT_LGUI` \| \|Swap Left Alt and GUI \|	266	\|`MAGIC_SWAP_LALT_LGUI` \| \|Swap Left Alt and GUI \|
267	\|`MAGIC_SWAP_RALT_RGUI` \| \|Swap Right Alt and GUI \|	267	\|`MAGIC_SWAP_RALT_RGUI` \| \|Swap Right Alt and GUI \|
268	\|`MAGIC_NO_GUI` \| \|Disable the GUI key \|	268	\|`MAGIC_NO_GUI` \| \|Disable the GUI key \|
269	\|`MAGIC_SWAP_GRAVE_ESC` \| \|Swap <code>`</code> and Escape \|	269	\|`MAGIC_SWAP_GRAVE_ESC` \| \|Swap <code>`</code> and Escape \|
270	\|`MAGIC_SWAP_BACKSLASH_BACKSPACE` \| \|Swap `\` and Backspace \|	270	\|`MAGIC_SWAP_BACKSLASH_BACKSPACE` \| \|Swap `\` and Backspace \|
271	\|`MAGIC_HOST_NKRO` \| \|Force NKRO on \|	271	\|`MAGIC_HOST_NKRO` \| \|Force NKRO on \|
272	\|`MAGIC_SWAP_ALT_GUI` \|`AG_SWAP`\|Swap Alt and GUI on both sides \|	272	\|`MAGIC_SWAP_ALT_GUI` \|`AG_SWAP`\|Swap Alt and GUI on both sides \|
273	\|`MAGIC_SWAP_CTL_GUI` \|`CG_SWAP`\|Swap Ctrl and GUI on both sides (for macOS)\|	273	\|`MAGIC_SWAP_CTL_GUI` \|`CG_SWAP`\|Swap Ctrl and GUI on both sides (for macOS)\|
274	\|`MAGIC_UNSWAP_CONTROL_CAPSLOCK` \| \|Unswap Caps Lock and Left Control \|	274	\|`MAGIC_UNSWAP_CONTROL_CAPSLOCK` \| \|Unswap Caps Lock and Left Control \|
275	\|`MAGIC_UNCAPSLOCK_TO_CONTROL` \| \|Stop treating Caps Lock as Control \|	275	\|`MAGIC_UNCAPSLOCK_TO_CONTROL` \| \|Stop treating Caps Lock as Control \|
276	\|`MAGIC_UNSWAP_LCTL_LGUI` \| \|Unswap Left Control and GUI \|	276	\|`MAGIC_UNSWAP_LCTL_LGUI` \| \|Unswap Left Control and GUI \|
277	\|`MAGIC_UNSWAP_RCTL_RGUI` \| \|Unswap Right Control and GUI \|	277	\|`MAGIC_UNSWAP_RCTL_RGUI` \| \|Unswap Right Control and GUI \|
278	\|`MAGIC_UNSWAP_LALT_LGUI` \| \|Unswap Left Alt and GUI \|	278	\|`MAGIC_UNSWAP_LALT_LGUI` \| \|Unswap Left Alt and GUI \|
279	\|`MAGIC_UNSWAP_RALT_RGUI` \| \|Unswap Right Alt and GUI \|	279	\|`MAGIC_UNSWAP_RALT_RGUI` \| \|Unswap Right Alt and GUI \|
280	\|`MAGIC_UNNO_GUI` \| \|Enable the GUI key \|	280	\|`MAGIC_UNNO_GUI` \| \|Enable the GUI key \|
281	\|`MAGIC_UNSWAP_GRAVE_ESC` \| \|Unswap <code>`</code> and Escape\|	281	\|`MAGIC_UNSWAP_GRAVE_ESC` \| \|Unswap <code>`</code> and Escape \|
282	\|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`\| \|Unswap `\` and Backspace \|	282	\|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`\| \|Unswap `\` and Backspace \|
283	\|`MAGIC_UNHOST_NKRO` \| \|Force NKRO off \|	283	\|`MAGIC_UNHOST_NKRO` \| \|Force NKRO off \|
284	\|`MAGIC_UNSWAP_ALT_GUI` \|`AG_NORM`\|Unswap Alt and GUI on both sides \|	284	\|`MAGIC_UNSWAP_ALT_GUI` \|`AG_NORM`\|Unswap Alt and GUI on both sides \|
285	\|`MAGIC_UNSWAP_CTL_GUI` \|`CG_NORM`\|Unswap Ctrl and GUI on both sides \|	285	\|`MAGIC_UNSWAP_CTL_GUI` \|`CG_NORM`\|Unswap Ctrl and GUI on both sides \|
286	\|`MAGIC_TOGGLE_ALT_GUI` \|`AG_TOGG`\|Toggle Alt and GUI swap on both sides \|	286	\|`MAGIC_TOGGLE_ALT_GUI` \|`AG_TOGG`\|Toggle Alt and GUI swap on both sides \|
287	\|`MAGIC_TOGGLE_CTL_GUI` \|`CG_TOGG`\|Toggle Ctrl and GUI swap on both sides \|	287	\|`MAGIC_TOGGLE_CTL_GUI` \|`CG_TOGG`\|Toggle Ctrl and GUI swap on both sides \|
288	\|`MAGIC_TOGGLE_NKRO` \| \|Turn NKRO on or off \|	288	\|`MAGIC_TOGGLE_NKRO` \| \|Turn NKRO on or off \|
		289	\|`MAGIC_EE_HANDS_LEFT` \| \|Set "Left Hand" for EE_HANDS handedness \|
		290	\|`MAGIC_EE_HANDS_RIGHT` \| \|Set "Right Hand" for EE_HANDS handedness \|
289		291
290	## [Bluetooth](feature_bluetooth.md)	292	## [Bluetooth](feature_bluetooth.md)
291		293