Add --remap-key command

Signed-off-by: Daniel Schaefer <[email protected]>

Author: JohnAZoidberg

EXAMPLES.md

@@ -380,3 +380,39 @@ sudo framework_tool --rgbkbd 2 0xFF0000
 > sudo framework_tool --stylus-battery
 Stylus Battery Strength: 77%
 ```
+
+## Remap keyboard
+
+Note that the keyboard matrix on Framework 12 and Framework 13 are
+different.
+The scancodes are the same.
+
+- Left-Ctrl 0x0014
+- Left-Alt 0x0014
+- Tab 0x0058
+
+### Framework 12
+
+```
+# Remap capslock key as left-ctrl
+> framework_tool --remap-key 6 15 0x0014
+
+# Swap left-ctrl and alt
+> framework_tool --remap-key 1 14 0x0011
+> framework_tool --remap-key 6 13 0x0014
+```
+
+### Framework 13
+
+```
+# Remap capslock key as left-ctrl
+> framework_tool --remap-key 4 4 0x0014
+
+# Swap left-ctrl and alt
+> framework_tool --remap-key 1 12 0x0011
+> framework_tool --remap-key 1 3 0x0014
+```
+
+### Framework 16
+
+It's not controlled by the EC, use https://keyboard.frame.work.

framework_lib/src/commandline/clap_std.rs

@@ -181,6 +181,11 @@ struct ClapCli {
     #[arg(long)]
     kblight: Option<Option<u8>>,
 
+    /// Set keyboard backlight percentage or get, if no value provided
+    #[arg(long, value_parser=maybe_hex::<u16>)]
+    #[clap(num_args = 3)]
+    remap_key: Vec<u16>,
+
     /// Set the color of <key> to <RGB>. Multiple colors for adjacent keys can be set at once.
     /// <key> <RGB> [<RGB> ...]
     /// Example: 0 0xFF000 0x00FF00 0x0000FF
@@ -333,6 +338,14 @@ pub fn parse(args: &[String]) -> Cli {
         1 => Some((args.charge_rate_limit[0], None)),
         _ => None,
     };
+    let remap_key = match args.remap_key.len() {
+        3 => Some((
+            args.remap_key[0] as u8,
+            args.remap_key[1] as u8,
+            args.remap_key[2],
+        )),
+        _ => None,
+    };
 
     Cli {
         verbosity: args.verbosity.log_level_filter(),
@@ -392,6 +405,7 @@ pub fn parse(args: &[String]) -> Cli {
         fp_led_level: args.fp_led_level,
         fp_brightness: args.fp_brightness,
         kblight: args.kblight,
+        remap_key,
         rgbkbd: args.rgbkbd,
         tablet_mode: args.tablet_mode,
         touchscreen_enable: args.touchscreen_enable,

framework_lib/src/commandline/mod.rs

@@ -181,6 +181,7 @@ pub struct Cli {
     pub fp_led_level: Option<Option<FpBrightnessArg>>,
     pub fp_brightness: Option<Option<u8>>,
     pub kblight: Option<Option<u8>>,
+    pub remap_key: Option<(u8, u8, u16)>,
     pub rgbkbd: Vec<u64>,
     pub tablet_mode: Option<TabletModeArg>,
     pub touchscreen_enable: Option<bool>,
@@ -804,6 +805,15 @@ pub fn run_with_args(args: &Cli, _allupdate: bool) -> i32 {
     } else if let Some(Some(kblight)) = args.kblight {
         assert!(kblight <= 100);
         ec.set_keyboard_backlight(kblight);
+    } else if let Some(None) = args.kblight {
+        print!("Keyboard backlight: ");
+        if let Some(percentage) = print_err(ec.get_keyboard_backlight()) {
+            println!("{}%", percentage);
+        } else {
+            println!("Unable to tell");
+        }
+    } else if let Some((row, col, scanset)) = args.remap_key {
+        print_err(ec.remap_key(row, col, scanset));
     } else if !args.rgbkbd.is_empty() {
         if args.rgbkbd.len() < 2 {
             println!(
@@ -819,13 +829,6 @@ pub fn run_with_args(args: &Cli, _allupdate: bool) -> i32 {
             });
             ec.rgbkbd_set_color(start_key, colors.collect()).unwrap();
         }
-    } else if let Some(None) = args.kblight {
-        print!("Keyboard backlight: ");
-        if let Some(percentage) = print_err(ec.get_keyboard_backlight()) {
-            println!("{}%", percentage);
-        } else {
-            println!("Unable to tell");
-        }
     } else if let Some(tablet_arg) = &args.tablet_mode {
         let mode = match tablet_arg {
             TabletModeArg::Auto => TabletModeOverride::Default,