Add sortKB integration

Author: object-Object

.vscode/settings.json

@@ -6,7 +6,11 @@
         "editor.formatOnSave": true,
         "editor.defaultFormatter": "esbenp.prettier-vscode"
     },
-    "rust-analyzer.linkedProjects": ["rust/mlogv32/Cargo.toml", "rust/demo_no_alloc/Cargo.toml"],
+    "rust-analyzer.linkedProjects": [
+        "rust/mlogv32/Cargo.toml",
+        "rust/demo_no_alloc/Cargo.toml",
+        "rust/sortKB/Cargo.toml"
+    ],
     "rust-analyzer.check.allTargets": false,
     "rust-analyzer.cargo.features": "all",
     "[python]": {

Makefile

@@ -27,6 +27,7 @@ build/%-0.mlog: build/%.bin scripts/bin_to_mlog.py
 
 build/rust/%.bin: FORCE | build/rust
 	cd rust/$* && cargo robjcopy ../../build/rust/$*.bin
+	cd rust/$* && cargo objdump --release -- --disassemble > ../../build/rust/$*.dump
 
 build/%.bin: build/%.out
 	riscv32-unknown-elf-objcopy --output-target binary build/$*.out build/$*.bin

README.md

@@ -37,14 +37,15 @@ This non-standard extension adds instructions to control the mlogv32 processor's
 
 The MLOG instructions are encoded with an I-type instruction format using the _custom-0_ opcode. The zero-extended immediate is used as a minor opcode (funct12) for implementation reasons.
 
-The MLOGSYS instruction is used for simple system controls, including halt, `printchar`, `printflush`, and `drawflush`.
+The MLOGSYS instruction is used for simple system controls, including halt, `printchar`, `printflush`, `drawflush`, and sortKB/kbconv integration.
 
-| funct12 | rs1     | name         |
-| ------- | ------- | ------------ |
-| 0       | `00000` | Halt         |
-| 1       | char    | `printchar`  |
-| 2       | `00000` | `printflush` |
-| 3       | `00000` | `drawflush`  |
+| funct12 | rs1     | rd                      | name                       |
+| ------- | ------- | ----------------------- | -------------------------- |
+| 0       | `00000` | `00000`                 | Halt                       |
+| 1       | char    | `00000`                 | `printchar`                |
+| 2       | `00000` | `00000`                 | `printflush`               |
+| 3       | `00000` | `00000`                 | `drawflush`                |
+| 4       | `00000` | char (0 if no new data) | Read next char from sortKB |
 
 The MLOGDRAW instruction is used for drawing graphics using the Mlog `draw` instruction. Arguments are passed to this instruction using registers a0 to a5 as necessary, and any return value is placed in _rd_. If _rd_ is specified as `00000` in the below table, no value will be written to `rd` in any case.
 
@@ -128,3 +129,7 @@ Assumes Powershell on Windows.
   - `uv sync`
   - `.venv\Scripts\activate.ps1`
 - Build all Rust projects in `rust/`: `make rust`
+
+## Attribution
+
+- SortKB: https://github.com/BasedUser/mPC

rust/demo_no_alloc/.cargo/config.toml

@@ -1,7 +1,8 @@
 [build]
-target = "riscv32i-unknown-none-elf"
+target = "riscv32imac-unknown-none-elf"
 rustflags = [
     "-C", "link-arg=-Tlink.x",
+    "-C", "target-feature=-c",
 ]
 
 [unstable]

rust/demo_no_alloc/rust-toolchain.toml

@@ -1,4 +1,4 @@
 [toolchain]
 channel = "nightly-2024-11-16"
 components = ["rust-src"]
-targets = ["riscv32i-unknown-none-elf"]
+targets = ["riscv32imac-unknown-none-elf"]

rust/mlogv32/.cargo/config.toml

@@ -1,7 +1,8 @@
 [build]
-target = "riscv32i-unknown-none-elf"
+target = "riscv32imac-unknown-none-elf"
 rustflags = [
     "-C", "link-arg=-Tlink.x",
+    "-C", "target-feature=-c",
 ]
 
 [unstable]

rust/mlogv32/rust-toolchain.toml

@@ -1,4 +1,4 @@
 [toolchain]
 channel = "nightly-2024-11-16"
 components = ["rust-src"]
-targets = ["riscv32i-unknown-none-elf"]
+targets = ["riscv32imac-unknown-none-elf"]

rust/mlogv32/src/io.rs

@@ -1,4 +1,4 @@
-use core::arch::asm;
+use core::{arch::asm, error::Error, fmt::Display};
 
 #[cfg(feature = "alloc")]
 use alloc::string::ToString;
@@ -47,3 +47,41 @@ pub fn print_flush() {
         );
     }
 }
+
+#[derive(Debug)]
+pub struct ReadCharError {
+    pub value: u32,
+}
+
+impl Display for ReadCharError {
+    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+        #[cfg(feature = "alloc")]
+        {
+            write!(f, "received invalid char from kbconv: {}", self.value)
+        }
+        #[cfg(not(feature = "alloc"))]
+        {
+            write!(f, "received invalid char from kbconv")
+        }
+    }
+}
+
+impl Error for ReadCharError {}
+
+pub fn read_char() -> Option<Result<char, ReadCharError>> {
+    let value: u32;
+
+    unsafe {
+        asm!(
+            ".insn i CUSTOM_0, 0, {}, zero, 4",
+            out(reg) value,
+            options(nomem, preserves_flags, nostack),
+        );
+    };
+
+    if value == 0 {
+        None
+    } else {
+        Some(char::from_u32(value).ok_or(ReadCharError { value }))
+    }
+}

rust/sortKB/.cargo/config.toml

@@ -0,0 +1,31 @@
+[build]
+target = "riscv32imac-unknown-none-elf"
+rustflags = [
+    "-C", "link-arg=-Tlink.x",
+    "-C", "target-feature=-c",
+]
+
+[unstable]
+build-std = ["core", "compiler_builtins"]
+
+[alias]
+rbuild = "build --release"
+rb = "rbuild"
+
+rsize = "size --release"
+
+robjdump = [
+    "objdump",
+    "--release",
+    "--",
+    "--disassemble",
+    "--no-show-raw-insn",
+]
+rod = "robjdump"
+
+robjcopy = [
+    "objcopy",
+    "--release",
+    "--",
+    "--output-target", "binary",
+]