Add basic support for writing keymaps in Rust

.gitattributes

@@ -26,6 +26,7 @@
 *.pl     text
 *.py     text
 *.rb     text
+*.rs     text
 *.sass   text
 *.scm    text
 *.scss   text

keyboards/planck/keymaps/prilik/config.h

@@ -0,0 +1,21 @@
+#pragma once
+
+#ifdef AUDIO_ENABLE
+    // #define STARTUP_SONG SONG(PLANCK_SOUND)
+    #define STARTUP_SONG SONG(NO_SOUND)
+    #define GOODBYE_SONG SONG(NO_SOUND)
+#endif
+
+#define MIDI_BASIC
+
+#define ENCODER_RESOLUTION 4
+
+/*
+  Set any config.h overrides for your specific keymap here.
+  See config.h options at https://docs.qmk.fm/#/config_options?id=the-configh-file
+*/
+#define ORYX_CONFIGURATOR
+
+#define PLANCK_EZ_LED_LOWER 1
+#define PLANCK_EZ_LED_RAISE 2
+#define PLANCK_EZ_LED_ADJUST 3

keyboards/planck/keymaps/prilik/keymap.c

@@ -0,0 +1,156 @@
+#include QMK_KEYBOARD_H
+#ifdef AUDIO_ENABLE
+#include "muse.h"
+#endif
+#include "eeprom.h"
+
+enum planck_keycodes {
+  UNUSED = EZ_SAFE_RANGE,
+  UC_SHRG, // shrug - ¯\_(ツ)_/¯
+};
+
+enum planck_layers {
+  _BASE,
+  _LOWER,
+  _RAISE,
+  _ADJUST,
+  _MEMES,
+};
+
+const uint32_t PROGMEM unicode_map[] = {};
+
+#define ___X___ XXXXXXX // KC_NO
+#define LED_LVL LED_LEVEL
+
+#define LOWER MO(_LOWER)
+#define RAISE MO(_RAISE)
+#define MEMES MO(_MEMES)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [_BASE] = LAYOUT_planck_mit(
+    KC_ESC,   KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,   KC_I,    KC_O,    KC_P,    KC_BSPC, \
+    KC_TAB,   KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,   KC_K,    KC_L,    KC_SCLN, KC_QUOT, \
+    KC_LSFT,  KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,   KC_COMM, KC_DOT,  KC_SLSH, KC_ENT,  \
+    KC_LCTL,  KC_LGUI, KC_LALT, ___X___, LOWER,        KC_SPC,      RAISE,  KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT  \
+  ),
+
+  [_LOWER] = LAYOUT_planck_mit(
+    KC_TILD,  KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC, \
+    KC_DEL,   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   ___X___, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, \
+    _______,  KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_MPLY, KC_VOLD, KC_VOLU, KC_PIPE, ___X___, \
+    _______,  _______, _______, MEMES,   _______,      _______,     _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END   \
+  ),
+
+  [_RAISE] = LAYOUT_planck_mit(
+    KC_GRAVE, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC, \
+    KC_CAPS,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   ___X___, KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, \
+    _______,  KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_MPLY, KC_MPRV, KC_MNXT, KC_BSLS, ___X___, \
+    _______,  _______, _______, ___X___, _______,      _______,     _______, ___X___, ___X___, ___X___, ___X___  \
+  ),
+
+  [_ADJUST] = LAYOUT_planck_mit(
+    ___X___, RGB_SPD, RGB_VAI, RGB_SPI, RGB_HUI, RGB_SAI, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, \
+    ___X___, RGB_RMOD,RGB_VAD, RGB_MOD, RGB_HUD, RGB_SAD, ___X___, ___X___, ___X___, ___X___, ___X___, RESET,   \
+    ___X___, RGB_TOG, LED_LVL, MU_TOG,  MU_MOD,  AU_TOG,  ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, \
+    ___X___, ___X___, ___X___, ___X___, ___X___,      ___X___,     ___X___, ___X___, ___X___, ___X___, ___X___  \
+  ),
+
+  [_MEMES] = LAYOUT_planck_mit(
+    ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, \
+    ___X___, ___X___, UC_SHRG, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, \
+    ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, ___X___, \
+    UC_M_OS, UC_M_WC, UC_M_LN, ___X___, ___X___,      ___X___,     ___X___, ___X___, ___X___, ___X___, ___X___  \
+  ),
+
+  /*
+  [X] = LAYOUT_planck_mit(
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
+    _______, _______, _______, _______, _______,      _______,     _______, _______, _______, _______, _______  \
+  ),
+  */
+};
+
+
+bool process_record_user_rs(uint16_t keycode, keyrecord_t* record);
+
+// due to weak linking + LTO + some other gcc specific quirks, a "trampoline" is 
+// required to call process_record_user from Rust.
+bool process_record_user(uint16_t keycode, keyrecord_t* record) {
+  return process_record_user_rs(keycode, record);
+}
+
+#ifdef AUDIO_ENABLE
+bool muse_mode = false;
+uint8_t last_muse_note = 0;
+uint16_t muse_counter = 0;
+uint8_t muse_offset = 70;
+uint16_t muse_tempo = 50;
+
+void encoder_update(bool clockwise) {
+  if (muse_mode) {
+    if (IS_LAYER_ON(_RAISE)) {
+      if (clockwise) {
+        muse_offset++;
+      } else {
+        muse_offset--;
+      }
+    } else {
+      if (clockwise) {
+        muse_tempo += 1;
+      } else {
+        muse_tempo -= 1;
+      }
+    }
+  } else {
+    if (clockwise) {
+#ifdef MOUSEKEY_ENABLE
+      register_code(KC_MS_WH_DOWN);
+      unregister_code(KC_MS_WH_DOWN);
+#else
+      register_code(KC_PGDN);
+      unregister_code(KC_PGDN);
+#endif
+    } else {
+#ifdef MOUSEKEY_ENABLE
+      register_code(KC_MS_WH_UP);
+      unregister_code(KC_MS_WH_UP);
+#else
+      register_code(KC_PGUP);
+      unregister_code(KC_PGUP);
+#endif
+    }
+  }
+}
+
+void matrix_scan_user(void) {
+#ifdef AUDIO_ENABLE
+  if (muse_mode) {
+    if (muse_counter == 0) {
+      uint8_t muse_note = muse_offset + SCALE[muse_clock_pulse()];
+      if (muse_note != last_muse_note) {
+        stop_note(compute_freq_for_midi_note(last_muse_note));
+        play_note(compute_freq_for_midi_note(muse_note), 0xF);
+        last_muse_note = muse_note;
+      }
+    }
+    muse_counter = (muse_counter + 1) % muse_tempo;
+  }
+#endif
+}
+
+bool music_mask_user(uint16_t keycode) {
+  switch (keycode) {
+    case RAISE:
+    case LOWER:
+      return false;
+    default:
+      return true;
+  }
+}
+#endif
+
+uint32_t layer_state_set_user(uint32_t state) {
+  return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
+}

keyboards/planck/keymaps/prilik/rules.mk

@@ -0,0 +1,17 @@
+SRC += muse.c
+
+RUST_CRATE = rust_example
+RUST_TARGET = thumbv7em-none-eabi
+RUST_TOOLCHAIN = nightly # for alloc crate support
+RUST_QMK_FEATURES = malloc
+RUST_QMK_HEADERS = # rgb_matrix.h eeprom.h
+
+# required for malloc
+EXTRALDFLAGS += -specs=nosys.specs
+
+# Set any rules.mk overrides for your specific keymap here.
+# See rules at https://docs.qmk.fm/#/config_options?id=the-rulesmk-file
+LINK_TIME_OPTIMIZATION_ENABLE = yes
+COMMAND_ENABLE = no
+MOUSEKEY_ENABLE = no
+UNICODEMAP_ENABLE = yes

keyboards/planck/keymaps/prilik/rust_example/.gitignore

@@ -0,0 +1,3 @@
+target/
+
+zork1-r88-s840726.z3

keyboards/planck/keymaps/prilik/rust_example/Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "rust_example"
+version = "0.1.0"
+authors = ["Daniel Prilik <danielprilik@gmail.com>"]
+edition = "2018"
+
+[dependencies]
+lazy_static = { version = "1.4", features = ["spin_no_std"] }
+
+[lib]
+crate-type = ["staticlib"]

keyboards/planck/keymaps/prilik/rust_example/src/keymap.rs

@@ -0,0 +1,50 @@
+use alloc::prelude::v1::*;
+
+use lazy_static::lazy_static;
+
+use qmk::bindgen::{keyrecord_t, planck_ez_keycodes, send_unicode_hex_string};
+
+const UC_SHRG: u32 = planck_ez_keycodes::EZ_SAFE_RANGE as u32 + 1;
+
+// example of using a crate from crates.io
+lazy_static! {
+    static ref SHRUG_STRING: String = {
+        let mut s = "¯\\_(ツ)_/¯"
+            .chars()
+            // example of using "alloc" crate functionality
+            .map(|c| format!("{:04X}", c as u32))
+            .collect::<Vec<_>>()
+            .join(" ");
+        s.push('\0');
+        s
+    };
+}
+
+#[no_mangle]
+pub unsafe extern "C" fn process_record_user_rs(keycode: u16, record: *const keyrecord_t) -> bool {
+    process_record_user(keycode, &*record)
+}
+
+fn process_record_user(keycode: u16, record: &keyrecord_t) -> bool {
+    if !shrug(keycode, record) {
+        return false;
+    }
+
+    true
+}
+
+fn shrug(keycode: u16, record: &keyrecord_t) -> bool {
+    match keycode as u32 {
+        UC_SHRG => {
+            if record.event.pressed {
+                unsafe {
+                    send_unicode_hex_string(SHRUG_STRING.as_ptr());
+                }
+            }
+            return false;
+        }
+        _ => {}
+    }
+
+    true
+}

keyboards/planck/keymaps/prilik/rust_example/src/lib.rs

@@ -0,0 +1,10 @@
+#![no_std]
+#![feature(alloc_prelude)]
+
+#[macro_use]
+extern crate alloc;
+
+#[global_allocator]
+static ALLOCATOR: qmk::malloc::MallocFreeAlloc = qmk::malloc::MallocFreeAlloc;
+
+pub mod keymap;

lib/rust/.gitignore

@@ -0,0 +1 @@
+target/